API Reference PhoenixKitCatalogue v#0.1.14

Copy Markdown View Source

Modules

Catalogue module for PhoenixKit.

Folder-scoped file attachments + featured image for catalogue resources (items and catalogues share the exact same pattern).

Context module for managing catalogues, manufacturers, suppliers, categories, and items.

Catalogue-level item and category counts. Includes both per-uuid helpers and single-query batch versions to avoid N+1 lookups when rendering catalogue lists with associated item / category counts.

Manufacturer ↔ Supplier many-to-many links.

Manufacturers — company directory used as the source of items.

Real-time fan-out for catalogue mutations.

Smart-catalogue rules — one row per (item, referenced_catalogue) pair.

Item search — global, per-catalogue, and per-category, with optional scope composition (catalogue_uuids AND category_uuids).

Suppliers — delivery companies linked to manufacturers via the many-to-many phoenix_kit_cat_manufacturer_suppliers table.

Multilang data JSONB helpers — read merged language data from a record and write language-specific overrides through the entity's own update function.

Central mapping from error atoms (returned by PhoenixKitCatalogue.Catalogue and the import pipeline) to translated, user-facing strings.

Executes an import plan by creating categories and items.

Maps file columns to catalogue fields and transforms row data into validated item attribute maps ready for insertion.

Parses XLSX and CSV files into structured row data.

Global, code-defined list of metadata fields that catalogue resources (items and catalogues) can opt into.

Centralized path helpers for the Catalogue module.

Schema for catalogues — top-level groupings (e.g., Kitchen Furniture, Plumbing).

Smart-catalogue rule: one row per (item, referenced_catalogue) pair.

Schema for categories within a catalogue.

Schema for catalogue items — individual products/materials with SKU and pricing.

Schema for manufacturers.

Join table linking manufacturers to suppliers (many-to-many).

Schema for suppliers.

Detail view for a single catalogue, with infinite-scroll paging over its categories and items.

Create/edit form for catalogues with multilang support.

Landing page for the Catalogue module.

Create/edit form for categories within a catalogue.

Reusable UI components for the Catalogue module.

Combobox LiveComponent for picking a single item from the catalogue via server-side search.

LiveView for the catalogue activity events subtab.

Tiny utilities shared by every catalogue LiveView. Imported into LVs via the standard import PhoenixKitCatalogue.Web.Helpers line.

Multi-step import wizard for catalogue items.

Create/edit form for catalogue items with multilang support.

Create/edit form for manufacturers with supplier linking.

Create/edit form for suppliers with manufacturer linking.