@happyvertical/smrt-products 0.55.6 → 0.55.8

package/dist/lib/manifest.json

@@ -2,7 +2,7 @@
   "version": "1.0.0",
   "timestamp": 0,
   "packageName": "@happyvertical/smrt-products",
-  "packageVersion": "0.55.6",
+  "packageVersion": "0.55.8",
   "objects": {
     "@happyvertical/smrt-products:CategoryCollection": {
       "name": "categorycollection",
@@ -1264,6 +1264,7 @@
       "className": "Category",
       "qualifiedName": "@happyvertical/smrt-products:Category",
       "collection": "categories",
+      "description": "Product knowledge base category for organizing product information.",
       "filePath": "/home/runner/work/smrt/smrt/packages/products/src/lib/models/Category.ts",
       "packageName": "@happyvertical/smrt-products",
       "fields": {
@@ -1529,11 +1530,19 @@
         },
         "name": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The product name, as customers see it.",
+          "_meta": {
+            "description": "The product name, as customers see it."
+          }
         },
         "description": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "A few words on what the product is and who it is for.",
+          "_meta": {
+            "description": "A few words on what the product is and who it is for."
+          }
         },
         "category": {
           "type": "text",
@@ -1550,7 +1559,11 @@
         "price": {
           "type": "integer",
           "required": true,
-          "default": 0
+          "default": 0,
+          "description": "The price in minor units (cents), for example 1999 for 19.99.",
+          "_meta": {
+            "description": "The price in minor units (cents), for example 1999 for 19.99."
+          }
         },
         "inStock": {
           "type": "boolean",
@@ -1847,6 +1860,7 @@
       "className": "Product",
       "qualifiedName": "@happyvertical/smrt-products:Product",
       "collection": "products",
+      "description": "Product information for knowledge base queries.",
       "filePath": "/home/runner/work/smrt/smrt/packages/products/src/lib/models/Product.ts",
       "packageName": "@happyvertical/smrt-products",
       "fields": {
@@ -1887,11 +1901,19 @@
         },
         "name": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The product name, as customers see it.",
+          "_meta": {
+            "description": "The product name, as customers see it."
+          }
         },
         "description": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "A few words on what the product is and who it is for.",
+          "_meta": {
+            "description": "A few words on what the product is and who it is for."
+          }
         },
         "category": {
           "type": "text",
@@ -1908,7 +1930,11 @@
         "price": {
           "type": "integer",
           "required": true,
-          "default": 0
+          "default": 0,
+          "description": "The price in minor units (cents), for example 1999 for 19.99.",
+          "_meta": {
+            "description": "The price in minor units (cents), for example 1999 for 19.99."
+          }
         },
         "inStock": {
           "type": "boolean",
@@ -2406,16 +2432,20 @@
           "type": "text",
           "required": true,
           "default": "",
+          "description": "The product this choice belongs to.",
           "_meta": {
-            "required": true
+            "required": true,
+            "description": "The product this choice belongs to."
           }
         },
         "axisName": {
           "type": "text",
           "required": true,
           "default": "",
+          "description": "What the product varies by, for example size or color.",
           "_meta": {
-            "required": true
+            "required": true,
+            "description": "What the product varies by, for example size or color."
           }
         },
         "label": {
@@ -2426,7 +2456,11 @@
         "allowedValues": {
           "type": "text",
           "required": false,
-          "default": "[]"
+          "default": "[]",
+          "description": "The values on offer, for example S, M and L, stored as a JSON list.",
+          "_meta": {
+            "description": "The values on offer, for example S, M and L, stored as a JSON list."
+          }
         },
         "sortOrder": {
           "type": "integer",
@@ -2636,16 +2670,20 @@
           "type": "text",
           "required": true,
           "default": "",
+          "description": "The product this item is a version of.",
           "_meta": {
-            "required": true
+            "required": true,
+            "description": "The product this item is a version of."
           }
         },
         "code": {
           "type": "text",
           "required": true,
           "default": "",
+          "description": "The short code that identifies this exact item, such as a UPC or part number.",
           "_meta": {
-            "required": true
+            "required": true,
+            "description": "The short code that identifies this exact item, such as a UPC or part number."
           }
         },
         "barcode": {
@@ -2661,7 +2699,11 @@
         "attributes": {
           "type": "text",
           "required": false,
-          "default": "{}"
+          "default": "{}",
+          "description": "Which attribute values, such as size and color, this item has, stored as JSON.",
+          "_meta": {
+            "description": "Which attribute values, such as size and color, this item has, stored as JSON."
+          }
         },
         "weightGrams": {
           "type": "decimal",
@@ -2868,10 +2910,292 @@
     }
   },
   "moduleType": "smrt",
+  "recipes": [
+    {
+      "id": "products.clothing",
+      "className": "ClothingProductsRecipe",
+      "label": "Clothing",
+      "summary": "Products that come in sizes and colors, with a stock-keeping unit for each combination.",
+      "synonyms": [
+        "apparel",
+        "garments",
+        "sizes",
+        "variants"
+      ],
+      "models": [
+        "@happyvertical/smrt-products:Product",
+        "@happyvertical/smrt-products:ProductVariant",
+        "@happyvertical/smrt-products:Sku"
+      ],
+      "nav": [
+        {
+          "label": "Products",
+          "model": "@happyvertical/smrt-products:Product",
+          "icon": "package",
+          "description": "What you sell, with prices and details."
+        }
+      ],
+      "requires": [],
+      "group": {
+        "id": "products",
+        "label": "Products",
+        "summary": "Sell goods: simple items, or clothing that comes in sizes and colors."
+      },
+      "section": {
+        "id": "catalog",
+        "label": "Catalog",
+        "icon": "package",
+        "description": "Products, ingredients and the stock you hold."
+      },
+      "options": {
+        "@happyvertical/smrt-products:Product": {
+          "fields": {
+            "productType": {
+              "visibility": "hidden"
+            },
+            "category": {
+              "visibility": "hidden"
+            },
+            "manufacturer": {
+              "visibility": "hidden"
+            },
+            "model": {
+              "visibility": "hidden"
+            },
+            "inStock": {
+              "visibility": "hidden"
+            },
+            "specifications": {
+              "visibility": "hidden"
+            },
+            "tags": {
+              "visibility": "hidden"
+            },
+            "description": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-products:ProductVariant": {
+          "fields": {
+            "label": {
+              "visibility": "hidden"
+            },
+            "sortOrder": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-products:Sku": {
+          "fields": {
+            "barcode": {
+              "visibility": "hidden"
+            },
+            "name": {
+              "visibility": "hidden"
+            },
+            "weightGrams": {
+              "visibility": "hidden"
+            },
+            "parentSkuId": {
+              "visibility": "hidden"
+            },
+            "active": {
+              "visibility": "hidden"
+            }
+          }
+        }
+      },
+      "help": {
+        "markdown": "## Overview\n\nClothing is for products that come in sizes and colors. You describe the product\nonce, say which sizes and colors you offer, and each combination becomes its own\nitem you can sell and count separately: a shirt in three sizes and two colors is\nsix items.\n\n## Tasks\n\n### Add a clothing item\n\n1. Create a product with a **{field:name}** and a **{field:price}**.\n2. Add a variant axis for sizes and list the values you offer, for example XS to\n   XL. Leave out the ones you do not make.\n3. Add a variant axis for colors the same way.\n4. Create an item (SKU) for each size and color combination, with its own code\n   and its size and color attributes.\n\n### Add a size or a color later\n\n1. Add the new value to the size or color axis of the product.\n2. Create items for the new combinations. Items you already had keep their\n   codes.\n\n### Stop selling a size\n\n1. Remove the size from the product's size axis.\n2. Remove the items for that size.\n",
+        "fieldRefs": [
+          "name",
+          "price"
+        ]
+      },
+      "demo": {
+        "mode": "server",
+        "reasons": [
+          "Needs a server because its package does not build for a browser: server bootstrap (startRestServer, express/cors), core generators/mcp; and its package depends on @happyvertical/smrt-tenancy, which do not build for a browser (#3616, #3624, #3626)."
+        ]
+      }
+    },
+    {
+      "id": "products.ingredients",
+      "className": "IngredientsRecipe",
+      "label": "Ingredients",
+      "summary": "Things you buy in to make what you sell, kept as products of the material kind with their own list.",
+      "synonyms": [
+        "materials",
+        "raw materials",
+        "supplies",
+        "stock items"
+      ],
+      "models": [
+        "@happyvertical/smrt-products:Product"
+      ],
+      "nav": [
+        {
+          "label": "Ingredients",
+          "model": "@happyvertical/smrt-products:Product",
+          "icon": "package",
+          "description": "What you buy to make what you sell, with what each costs.",
+          "key": "ingredients",
+          "noun": "ingredient",
+          "filter": {
+            "field": "productType",
+            "value": "material"
+          }
+        }
+      ],
+      "requires": [
+        "products.simple"
+      ],
+      "group": {
+        "id": "products",
+        "label": "Products",
+        "summary": "Sell goods: simple items, or clothing that comes in sizes and colors."
+      },
+      "section": {
+        "id": "catalog",
+        "label": "Catalog",
+        "icon": "package",
+        "description": "Products, ingredients and the stock you hold."
+      },
+      "options": {
+        "@happyvertical/smrt-products:Product": {
+          "fields": {
+            "productType": {
+              "visibility": "hidden"
+            },
+            "category": {
+              "visibility": "hidden"
+            },
+            "manufacturer": {
+              "visibility": "hidden"
+            },
+            "model": {
+              "visibility": "hidden"
+            },
+            "inStock": {
+              "visibility": "hidden"
+            },
+            "specifications": {
+              "visibility": "hidden"
+            },
+            "tags": {
+              "visibility": "hidden"
+            }
+          }
+        }
+      },
+      "help": {
+        "markdown": "## Overview\n\nIngredients are the things you buy in to make what you sell: flour, butter,\nsteel, fabric. They are products of the material kind, so they have the same\nname, price and description as anything you sell, and they are listed apart from\nthe products you sell. Count them with inventory like any other item.\n\n## Tasks\n\n### Add an ingredient\n\n1. Create a new ingredient.\n2. Give it a **{field:name}** that includes the pack size, for example \"Bread flour, 25 kg\".\n3. Enter what you pay in the **{field:price}**, in minor units (cents).\n4. Add a **{field:description}** such as the brand or grade.\n5. Save. It appears in the ingredients list, not in the products you sell.\n\n### Update what you pay\n\n1. Find the ingredient.\n2. Change the **{field:price}** and save.\n",
+        "fieldRefs": [
+          "description",
+          "name",
+          "price"
+        ]
+      },
+      "demo": {
+        "mode": "server",
+        "reasons": [
+          "Needs a server because its package does not build for a browser: server bootstrap (startRestServer, express/cors), core generators/mcp; and its package depends on @happyvertical/smrt-tenancy, which do not build for a browser (#3616, #3624, #3626)."
+        ]
+      }
+    },
+    {
+      "id": "products.simple",
+      "className": "SimpleProductsRecipe",
+      "label": "Simple products",
+      "summary": "Items with a name, a price and a description.",
+      "synonyms": [
+        "items",
+        "goods",
+        "catalog"
+      ],
+      "models": [
+        "@happyvertical/smrt-products:Product"
+      ],
+      "nav": [
+        {
+          "label": "Products",
+          "model": "@happyvertical/smrt-products:Product",
+          "icon": "package",
+          "description": "What you sell, with prices and details."
+        }
+      ],
+      "requires": [],
+      "group": {
+        "id": "products",
+        "label": "Products",
+        "summary": "Sell goods: simple items, or clothing that comes in sizes and colors."
+      },
+      "section": {
+        "id": "catalog",
+        "label": "Catalog",
+        "icon": "package",
+        "description": "Products, ingredients and the stock you hold."
+      },
+      "options": {
+        "@happyvertical/smrt-products:Product": {
+          "fields": {
+            "productType": {
+              "visibility": "hidden"
+            },
+            "category": {
+              "visibility": "hidden"
+            },
+            "manufacturer": {
+              "visibility": "hidden"
+            },
+            "model": {
+              "visibility": "hidden"
+            },
+            "inStock": {
+              "visibility": "hidden"
+            },
+            "specifications": {
+              "visibility": "hidden"
+            },
+            "tags": {
+              "visibility": "hidden"
+            }
+          }
+        }
+      },
+      "help": {
+        "markdown": "## Overview\n\nSimple products are things you sell that come in one form: one name, one price,\none description. Keep a record for each so you can see everything you offer in\none list, with the price next to it, and change it whenever it moves.\n\n## Tasks\n\n### Add a simple product\n\n1. Create a new product.\n2. Give it a **{field:name}**, for example \"Ceramic mug\".\n3. Enter the **{field:price}** in minor units (cents).\n4. Add a **{field:description}** so anyone reading the list knows what it is.\n5. Save. The product is now on your list.\n\n### Change a price\n\n1. Find the product.\n2. Change the **{field:price}** and save.\n",
+        "fieldRefs": [
+          "description",
+          "name",
+          "price"
+        ]
+      },
+      "demo": {
+        "mode": "server",
+        "reasons": [
+          "Needs a server because its package does not build for a browser: server bootstrap (startRestServer, express/cors), core generators/mcp; and its package depends on @happyvertical/smrt-tenancy, which do not build for a browser (#3616, #3624, #3626)."
+        ]
+      }
+    }
+  ],
   "smrtDependencies": [
     "@happyvertical/smrt-assets",
     "@happyvertical/smrt-core",
     "@happyvertical/smrt-tenancy"
   ],
+  "browser": {
+    "status": "server-only",
+    "issues": [
+      "#3616",
+      "#3624",
+      "#3626"
+    ],
+    "reason": "server bootstrap (startRestServer, express/cors), core generators/mcp",
+    "via": [
+      "@happyvertical/smrt-tenancy"
+    ]
+  },
   "stampsConstructors": true
 }

package/dist/lib/models.js

@@ -1,3 +1,3 @@
-import { a as Product, i as Material, n as ProductVariant, o as ProductType, r as ProductAsset, s as Category, t as Sku } from "./chunks/Sku-BN7ydk5h.js";
-import "./chunks/models-Dx8Zm4UB.js";
+import { a as Product, i as Material, n as ProductVariant, o as ProductType, r as ProductAsset, s as Category, t as Sku } from "./chunks/Sku-CdhhTtjd.js";
+import "./chunks/models-B3mKXkTB.js";
 export { Category, Material, Product, ProductAsset, ProductType, ProductVariant, Sku };