@webx-ui/module-catalog-brands 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 webx-ui
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# @webx-ui/module-catalog-brands
+
+Brands for the catalogue of the [WebX UI](https://github.com/webx-ui/webx-ui) admin panel: a logo,
+a description and a page of their own, one per product, a choice of the filter.
+
+The other half is the Composer package `webx-ui/module-catalog-brands`, which owns the brands, their
+addresses and pages, the field of the product form, the column and the facet of the list, and the
+bulk action «Set the brand». The section appears in the panel when both halves are installed,
+beside `@webx-ui/module-catalog`.
+
+## Install
+
+```bash
+npm install @webx-ui/module-catalog-brands
+```
+
+```ts
+import { createAdmin } from '@webx-ui/module-admin'
+import { catalog } from '@webx-ui/module-catalog'
+import { catalogBrands } from '@webx-ui/module-catalog-brands'
+import { media } from '@webx-ui/module-media'
+import '@webx-ui/module-catalog/style.css'
+import '@webx-ui/module-catalog-brands/style.css'
+
+createAdmin({
+  basePath: '/cms',
+  modules: [...catalog(), ...catalogBrands(), media()],
+}).mount()
+```
+
+`catalogBrands()` is one section — the list of brands in the order of the site, and the page of
+one: «Main» (name, address, logo, published, featured), «Description», «SEO» and «History». The
+logo is picked from the library of `@webx-ui/module-media`. The brand field of the product form, the
+column and the filter of the list come through the catalogue's registries and need nothing here.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { catalogBrands, catalogBrandsOptions, type CatalogBrandsOptions } from './module';
+export { catalogBrandsMessages } from './messages';

package/dist/index.js

@@ -0,0 +1,62 @@
+import { dictionarySection as a, dictionaryOptions as s } from "@webx-ui/module-catalog";
+const r = {
+  module: {
+    title: "Brands",
+    brand: "Brand"
+  },
+  brand: {
+    title: "Name",
+    slug: "Address",
+    "slug-help": "The brand's page and its value in the filter's address: /brands/apple/, /laptops/brand_apple/.",
+    description: "Description",
+    "description-help": "The text at the top of the brand's page.",
+    logo_id: "Logo",
+    is_visible: "Published",
+    "visible-help": "Off, the brand's page answers 404, the filter leaves it out and cards do not show it. Its products keep it.",
+    is_featured: "Featured",
+    "featured-help": "Among the «popular brands» a template shows with brands()->featured().",
+    "tab-main": "Main",
+    "tab-description": "Description",
+    "tab-seo": "SEO",
+    "tab-history": "History",
+    new: "New brand",
+    empty: "No brands yet.",
+    "empty-help": "A brand has a page of its own with the products of it, and is a choice of the catalogue filter.",
+    order: "The order here is the order on the site: the filter, the popular brands and the list of brands",
+    hidden: "Not published",
+    count: "Products: :count",
+    "show-items": "Show its products",
+    "delete-blocked": "While products are of this brand it cannot go — take it off them first.",
+    "delete-text": "It goes to the bin, and its page answers that it is gone.",
+    deleted: "The brand is in the bin.",
+    saved: "The brand is saved."
+  },
+  product: {
+    brand: "Brand",
+    "brand-help": "Empty means no brand.",
+    "brand-empty": "No brand"
+  },
+  bulk: {
+    "set-brand": "Set the brand"
+  }
+}, t = {
+  id: "catalog-brands",
+  slug: "brands",
+  screen: "catalog.brand-form",
+  facet: "brand",
+  namespace: "webx-catalog-brands",
+  group: "brand",
+  messages: r
+};
+function d(e = {}) {
+  return s({ ...t, catalog: e.path });
+}
+function o(e = {}) {
+  return [a({ ...t, catalog: e.path })];
+}
+export {
+  o as catalogBrands,
+  r as catalogBrandsMessages,
+  d as catalogBrandsOptions
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/messages.ts","../src/module.ts"],"sourcesContent":["import type { Messages } from '@webx-ui/module-admin'\n\n/**\n * The English this package speaks on its own, before the server's dictionary arrives, or without\n * one. The server ships the same lines under `webx-catalog-brands::` and overrides these;\n * `messages.test.ts` keeps the two sets of keys equal.\n */\nexport const catalogBrandsMessages: Record<string, Messages> = {\n  module: {\n    title: 'Brands',\n    brand: 'Brand',\n  },\n  brand: {\n    title: 'Name',\n    slug: 'Address',\n    'slug-help':\n      \"The brand's page and its value in the filter's address: /brands/apple/, /laptops/brand_apple/.\",\n    description: 'Description',\n    'description-help': \"The text at the top of the brand's page.\",\n    logo_id: 'Logo',\n    is_visible: 'Published',\n    'visible-help':\n      \"Off, the brand's page answers 404, the filter leaves it out and cards do not show it. Its products keep it.\",\n    is_featured: 'Featured',\n    'featured-help': 'Among the «popular brands» a template shows with brands()->featured().',\n    'tab-main': 'Main',\n    'tab-description': 'Description',\n    'tab-seo': 'SEO',\n    'tab-history': 'History',\n    new: 'New brand',\n    empty: 'No brands yet.',\n    'empty-help':\n      'A brand has a page of its own with the products of it, and is a choice of the catalogue filter.',\n    order:\n      'The order here is the order on the site: the filter, the popular brands and the list of brands',\n    hidden: 'Not published',\n    count: 'Products: :count',\n    'show-items': 'Show its products',\n    'delete-blocked': 'While products are of this brand it cannot go — take it off them first.',\n    'delete-text': 'It goes to the bin, and its page answers that it is gone.',\n    deleted: 'The brand is in the bin.',\n    saved: 'The brand is saved.',\n  },\n  product: {\n    brand: 'Brand',\n    'brand-help': 'Empty means no brand.',\n    'brand-empty': 'No brand',\n  },\n  bulk: {\n    'set-brand': 'Set the brand',\n  },\n}\n","import type { AdminModule } from '@webx-ui/module-admin'\nimport {\n  dictionaryOptions,\n  dictionarySection,\n  type DictionaryOptions,\n} from '@webx-ui/module-catalog'\nimport { catalogBrandsMessages } from './messages'\n\nexport interface CatalogBrandsOptions {\n  /** Where the catalogue lives inside the panel — the same as `catalog({ path })`. */\n  path?: string\n}\n\nconst BRANDS: DictionaryOptions = {\n  id: 'catalog-brands',\n  slug: 'brands',\n  screen: 'catalog.brand-form',\n  facet: 'brand',\n  namespace: 'webx-catalog-brands',\n  group: 'brand',\n  messages: catalogBrandsMessages,\n}\n\n/** The brands as the panel's shared category screens see them. */\nexport function catalogBrandsOptions(options: CatalogBrandsOptions = {}) {\n  return dictionaryOptions({ ...BRANDS, catalog: options.path })\n}\n\n/**\n * Brands as a section of the panel (§2.3 of the dictionaries spec): the list in the order of the\n * site — the filter, the popular brands, the page of all of them — each with its address, and the\n * page of one, which is the server's `catalog.brand-form`: «Main» with the logo out of the media\n * library, «Description», «SEO» and «History». In the «Catalog» group after «Products».\n *\n * The brand of a product (`wx-select` over `catalog/brands`), its name in the list, the filter and\n * «Set the brand» come through the catalogue's registries. The logo field is `wx-media` — the\n * media module's, which a panel with brands has.\n */\nexport function catalogBrands(options: CatalogBrandsOptions = {}): AdminModule[] {\n  return [dictionarySection({ ...BRANDS, catalog: options.path })]\n}\n"],"names":["catalogBrandsMessages","BRANDS","catalogBrandsOptions","options","dictionaryOptions","catalogBrands","dictionarySection"],"mappings":";AAOO,MAAMA,IAAkD;AAAA,EAC7D,QAAQ;AAAA,IACN,OAAO;AAAA,IACP,OAAO;AAAA,EAAA;AAAA,EAET,OAAO;AAAA,IACL,OAAO;AAAA,IACP,MAAM;AAAA,IACN,aACE;AAAA,IACF,aAAa;AAAA,IACb,oBAAoB;AAAA,IACpB,SAAS;AAAA,IACT,YAAY;AAAA,IACZ,gBACE;AAAA,IACF,aAAa;AAAA,IACb,iBAAiB;AAAA,IACjB,YAAY;AAAA,IACZ,mBAAmB;AAAA,IACnB,WAAW;AAAA,IACX,eAAe;AAAA,IACf,KAAK;AAAA,IACL,OAAO;AAAA,IACP,cACE;AAAA,IACF,OACE;AAAA,IACF,QAAQ;AAAA,IACR,OAAO;AAAA,IACP,cAAc;AAAA,IACd,kBAAkB;AAAA,IAClB,eAAe;AAAA,IACf,SAAS;AAAA,IACT,OAAO;AAAA,EAAA;AAAA,EAET,SAAS;AAAA,IACP,OAAO;AAAA,IACP,cAAc;AAAA,IACd,eAAe;AAAA,EAAA;AAAA,EAEjB,MAAM;AAAA,IACJ,aAAa;AAAA,EAAA;AAEjB,GCtCMC,IAA4B;AAAA,EAChC,IAAI;AAAA,EACJ,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,OAAO;AAAA,EACP,WAAW;AAAA,EACX,OAAO;AAAA,EACP,UAAUD;AACZ;AAGO,SAASE,EAAqBC,IAAgC,IAAI;AACvE,SAAOC,EAAkB,EAAE,GAAGH,GAAQ,SAASE,EAAQ,MAAM;AAC/D;AAYO,SAASE,EAAcF,IAAgC,IAAmB;AAC/E,SAAO,CAACG,EAAkB,EAAE,GAAGL,GAAQ,SAASE,EAAQ,KAAA,CAAM,CAAC;AACjE;"}

package/dist/messages.d.ts

@@ -0,0 +1,7 @@
+import { Messages } from '@webx-ui/module-admin';
+/**
+ * The English this package speaks on its own, before the server's dictionary arrives, or without
+ * one. The server ships the same lines under `webx-catalog-brands::` and overrides these;
+ * `messages.test.ts` keeps the two sets of keys equal.
+ */
+export declare const catalogBrandsMessages: Record<string, Messages>;

package/dist/module.d.ts

@@ -0,0 +1,18 @@
+import { AdminModule } from '@webx-ui/module-admin';
+export interface CatalogBrandsOptions {
+    /** Where the catalogue lives inside the panel — the same as `catalog({ path })`. */
+    path?: string;
+}
+/** The brands as the panel's shared category screens see them. */
+export declare function catalogBrandsOptions(options?: CatalogBrandsOptions): import('@webx-ui/module-admin').CategoriesOptions;
+/**
+ * Brands as a section of the panel (§2.3 of the dictionaries spec): the list in the order of the
+ * site — the filter, the popular brands, the page of all of them — each with its address, and the
+ * page of one, which is the server's `catalog.brand-form`: «Main» with the logo out of the media
+ * library, «Description», «SEO» and «History». In the «Catalog» group after «Products».
+ *
+ * The brand of a product (`wx-select` over `catalog/brands`), its name in the list, the filter and
+ * «Set the brand» come through the catalogue's registries. The logo field is `wx-media` — the
+ * media module's, which a panel with brands has.
+ */
+export declare function catalogBrands(options?: CatalogBrandsOptions): AdminModule[];

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@webx-ui/module-catalog-brands",
+  "version": "0.1.0",
+  "description": "Brands for the catalogue of the WebX UI admin panel: a reference book with logos, descriptions and pages of their own, a field of the product form, a column and a filter of the list.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": [
+    "*.css"
+  ],
+  "keywords": [
+    "webx-ui",
+    "vue",
+    "admin",
+    "cms",
+    "catalog",
+    "e-commerce",
+    "brands",
+    "manufacturers"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/webx-ui/webx-ui.git",
+    "directory": "packages/module-catalog-brands"
+  },
+  "homepage": "https://github.com/webx-ui/webx-ui/tree/main/packages/module-catalog-brands",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./style.css": "./dist/style.css",
+    "./dist/style.css": "./dist/style.css",
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "vue": "^3.5.0",
+    "vue-router": "^4.5.0"
+  },
+  "dependencies": {
+    "@webx-ui/core": "^0.34.2",
+    "@webx-ui/module-admin": "^0.21.0",
+    "@webx-ui/module-catalog": "^0.4.0",
+    "@webx-ui/schema": "^0.6.4"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "@vitejs/plugin-vue": "^6.0.1",
+    "typescript": "^5.9.3",
+    "vite": "^7.1.14",
+    "vite-plugin-dts": "^4.5.4",
+    "vue": "^3.5.24",
+    "vue-router": "^4.5.1",
+    "vue-tsc": "^3.1.3"
+  },
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "typecheck": "vue-tsc -p tsconfig.json --noEmit"
+  }
+}