@webx-ui/module-catalog-stock 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,32 @@
+# @webx-ui/module-catalog-stock
+
+Stock statuses for the catalogue of the [WebX UI](https://github.com/webx-ui/webx-ui) admin panel:
+in stock, out of stock, on order — one per product, and the status says whether it can be bought.
+
+The other half is the Composer package `webx-ui/module-catalog-stock`, which owns the statuses, the
+field of the product form, the column and the facet of the list, the bulk action «Set the stock
+status» and the rule of `Purchasability`. The section appears in the panel when both halves are
+installed, beside `@webx-ui/module-catalog`.
+
+## Install
+
+```bash
+npm install @webx-ui/module-catalog-stock
+```
+
+```ts
+import { createAdmin } from '@webx-ui/module-admin'
+import { catalog } from '@webx-ui/module-catalog'
+import { catalogStock } from '@webx-ui/module-catalog-stock'
+import '@webx-ui/module-catalog/style.css'
+import '@webx-ui/module-catalog-stock/style.css'
+
+createAdmin({
+  basePath: '/cms',
+  modules: [...catalog(), ...catalogStock()],
+}).mount()
+```
+
+`catalogStock()` is one section — the list of statuses, ordered by hand, and the page of one. It
+stands in the «Catalog» group under «Dictionaries». The status field of the product form, the tag
+in the list and the filter come through the catalogue's registries and need nothing here.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { catalogStock, catalogStockOptions, type CatalogStockOptions } from './module';
+export { catalogStockMessages } from './messages';

package/dist/index.js

@@ -0,0 +1,66 @@
+import { dictionarySection as s, dictionaryOptions as a } from "@webx-ui/module-catalog";
+const o = {
+  module: {
+    title: "Stock"
+  },
+  status: {
+    title: "Name",
+    code: "Code",
+    "code-help": "Latin letters, digits and hyphens: the status in the filter address (stock_in-stock) and in templates. Made from the name when left empty.",
+    color: "Tone",
+    "color-help": "The site paints the status line in this tone; the panel shows a tag of the same tone.",
+    tones: {
+      neutral: "Neutral",
+      primary: "Primary",
+      success: "Success",
+      warning: "Warning",
+      danger: "Danger",
+      info: "Info"
+    },
+    purchasable: "Can be bought",
+    "purchasable-help": "Off, a product in this status cannot be bought, and its name is what the site says instead of the buy button.",
+    default: "Default",
+    "default-help": "The status of every product nobody set a status for, and of a new product. To change it, make another status the default.",
+    filterable: "In the filter",
+    "filterable-help": "Off, the status is not a choice of the catalogue filter.",
+    new: "New status",
+    empty: "No stock statuses yet.",
+    "empty-help": "A status says whether a product is in stock and whether it can be bought.",
+    order: "The order here is the order of the filter",
+    hidden: "Not in the filter",
+    count: "Products: :count",
+    "show-items": "Show its products",
+    "delete-blocked": "While products are in it, it cannot go — move them to another status first.",
+    "delete-text": "It goes to the bin and leaves the filter.",
+    deleted: "The status is in the bin.",
+    saved: "The status is saved."
+  },
+  product: {
+    status: "Stock status",
+    "status-help": "Empty means the default status, whichever it is at the time.",
+    "status-empty": "Default status"
+  },
+  bulk: {
+    "set-stock": "Set the stock status"
+  }
+}, e = {
+  id: "catalog-stock",
+  slug: "stock",
+  screen: "catalog.stock-status-form",
+  facet: "stock",
+  namespace: "webx-catalog-stock",
+  group: "status",
+  messages: o
+};
+function i(t = {}) {
+  return a({ ...e, catalog: t.path });
+}
+function c(t = {}) {
+  return [s({ ...e, catalog: t.path })];
+}
+export {
+  c as catalogStock,
+  o as catalogStockMessages,
+  i as catalogStockOptions
+};
+//# 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-stock::` and overrides these;\n * `messages.test.ts` keeps the two sets of keys equal.\n */\nexport const catalogStockMessages: Record<string, Messages> = {\n  module: {\n    title: 'Stock',\n  },\n  status: {\n    title: 'Name',\n    code: 'Code',\n    'code-help':\n      'Latin letters, digits and hyphens: the status in the filter address (stock_in-stock) and in templates. Made from the name when left empty.',\n    color: 'Tone',\n    'color-help':\n      'The site paints the status line in this tone; the panel shows a tag of the same tone.',\n    tones: {\n      neutral: 'Neutral',\n      primary: 'Primary',\n      success: 'Success',\n      warning: 'Warning',\n      danger: 'Danger',\n      info: 'Info',\n    },\n    purchasable: 'Can be bought',\n    'purchasable-help':\n      'Off, a product in this status cannot be bought, and its name is what the site says instead of the buy button.',\n    default: 'Default',\n    'default-help':\n      'The status of every product nobody set a status for, and of a new product. To change it, make another status the default.',\n    filterable: 'In the filter',\n    'filterable-help': 'Off, the status is not a choice of the catalogue filter.',\n    new: 'New status',\n    empty: 'No stock statuses yet.',\n    'empty-help': 'A status says whether a product is in stock and whether it can be bought.',\n    order: 'The order here is the order of the filter',\n    hidden: 'Not in the filter',\n    count: 'Products: :count',\n    'show-items': 'Show its products',\n    'delete-blocked': 'While products are in it, it cannot go — move them to another status first.',\n    'delete-text': 'It goes to the bin and leaves the filter.',\n    deleted: 'The status is in the bin.',\n    saved: 'The status is saved.',\n  },\n  product: {\n    status: 'Stock status',\n    'status-help': 'Empty means the default status, whichever it is at the time.',\n    'status-empty': 'Default status',\n  },\n  bulk: {\n    'set-stock': 'Set the stock status',\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 { catalogStockMessages } from './messages'\n\nexport interface CatalogStockOptions {\n  /** Where the catalogue lives inside the panel — the same as `catalog({ path })`. */\n  path?: string\n}\n\nconst STOCK: DictionaryOptions = {\n  id: 'catalog-stock',\n  slug: 'stock',\n  screen: 'catalog.stock-status-form',\n  facet: 'stock',\n  namespace: 'webx-catalog-stock',\n  group: 'status',\n  messages: catalogStockMessages,\n}\n\n/** The stock statuses as the panel's shared category screens see them. */\nexport function catalogStockOptions(options: CatalogStockOptions = {}) {\n  return dictionaryOptions({ ...STOCK, catalog: options.path })\n}\n\n/**\n * Stock statuses as a section of the panel (§2.2 of the dictionaries spec): in stock, out of\n * stock, on order — the list ordered by hand, which is the order of the filter, and the page of\n * one, which is the server's `catalog.stock-status-form`. Under «Dictionaries» of the «Catalog»\n * group, after the labels.\n *\n * The status of a product (`wx-select` over `catalog/stock`), its tag in the list, the filter and\n * «Set the stock status» all come through the catalogue's registries.\n */\nexport function catalogStock(options: CatalogStockOptions = {}): AdminModule[] {\n  return [dictionarySection({ ...STOCK, catalog: options.path })]\n}\n"],"names":["catalogStockMessages","STOCK","catalogStockOptions","options","dictionaryOptions","catalogStock","dictionarySection"],"mappings":";AAOO,MAAMA,IAAiD;AAAA,EAC5D,QAAQ;AAAA,IACN,OAAO;AAAA,EAAA;AAAA,EAET,QAAQ;AAAA,IACN,OAAO;AAAA,IACP,MAAM;AAAA,IACN,aACE;AAAA,IACF,OAAO;AAAA,IACP,cACE;AAAA,IACF,OAAO;AAAA,MACL,SAAS;AAAA,MACT,SAAS;AAAA,MACT,SAAS;AAAA,MACT,SAAS;AAAA,MACT,QAAQ;AAAA,MACR,MAAM;AAAA,IAAA;AAAA,IAER,aAAa;AAAA,IACb,oBACE;AAAA,IACF,SAAS;AAAA,IACT,gBACE;AAAA,IACF,YAAY;AAAA,IACZ,mBAAmB;AAAA,IACnB,KAAK;AAAA,IACL,OAAO;AAAA,IACP,cAAc;AAAA,IACd,OAAO;AAAA,IACP,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,QAAQ;AAAA,IACR,eAAe;AAAA,IACf,gBAAgB;AAAA,EAAA;AAAA,EAElB,MAAM;AAAA,IACJ,aAAa;AAAA,EAAA;AAEjB,GC1CMC,IAA2B;AAAA,EAC/B,IAAI;AAAA,EACJ,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,OAAO;AAAA,EACP,WAAW;AAAA,EACX,OAAO;AAAA,EACP,UAAUD;AACZ;AAGO,SAASE,EAAoBC,IAA+B,IAAI;AACrE,SAAOC,EAAkB,EAAE,GAAGH,GAAO,SAASE,EAAQ,MAAM;AAC9D;AAWO,SAASE,EAAaF,IAA+B,IAAmB;AAC7E,SAAO,CAACG,EAAkB,EAAE,GAAGL,GAAO,SAASE,EAAQ,KAAA,CAAM,CAAC;AAChE;"}

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-stock::` and overrides these;
+ * `messages.test.ts` keeps the two sets of keys equal.
+ */
+export declare const catalogStockMessages: Record<string, Messages>;

package/dist/module.d.ts

@@ -0,0 +1,17 @@
+import { AdminModule } from '@webx-ui/module-admin';
+export interface CatalogStockOptions {
+    /** Where the catalogue lives inside the panel — the same as `catalog({ path })`. */
+    path?: string;
+}
+/** The stock statuses as the panel's shared category screens see them. */
+export declare function catalogStockOptions(options?: CatalogStockOptions): import('@webx-ui/module-admin').CategoriesOptions;
+/**
+ * Stock statuses as a section of the panel (§2.2 of the dictionaries spec): in stock, out of
+ * stock, on order — the list ordered by hand, which is the order of the filter, and the page of
+ * one, which is the server's `catalog.stock-status-form`. Under «Dictionaries» of the «Catalog»
+ * group, after the labels.
+ *
+ * The status of a product (`wx-select` over `catalog/stock`), its tag in the list, the filter and
+ * «Set the stock status» all come through the catalogue's registries.
+ */
+export declare function catalogStock(options?: CatalogStockOptions): AdminModule[];

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@webx-ui/module-catalog-stock",
+  "version": "0.1.0",
+  "description": "Stock statuses for the catalogue of the WebX UI admin panel: in stock, out of stock, on order — a reference book, 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",
+    "stock",
+    "availability"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/webx-ui/webx-ui.git",
+    "directory": "packages/module-catalog-stock"
+  },
+  "homepage": "https://github.com/webx-ui/webx-ui/tree/main/packages/module-catalog-stock",
+  "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"
+  }
+}