@happyvertical/smrt-planner 0.0.0-stage → 0.0.2

package/dist/recipes/overlay.json

@@ -0,0 +1,409 @@
+{
+  "order": [
+    "commerce.customers",
+    "commerce.purchases",
+    "commerce.sales",
+    "commerce.vendors",
+    "inventory.stock",
+    "products.simple",
+    "products.clothing",
+    "products.ingredients",
+    "commerce.estimates",
+    "commerce.wholesale",
+    "commerce.invoicing",
+    "commerce.fulfillment",
+    "commerce.agreements",
+    "commerce.leases",
+    "commerce.licenses",
+    "ledgers.bookkeeping",
+    "projects.tracker",
+    "events.calendar",
+    "sales.pipeline"
+  ],
+  "recipes": {
+    "commerce.customers": {
+      "forms": [
+        {
+          "id": "customer.default",
+          "kind": "field-map",
+          "label": "Customer",
+          "kindLabel": "Customer",
+          "model": "@happyvertical/smrt-commerce:Customer",
+          "records": [
+            {
+              "as": "profileType",
+              "model": "@happyvertical/smrt-profiles:ProfileType",
+              "match": {
+                "name": "Customer"
+              }
+            },
+            {
+              "as": "profile",
+              "model": "@happyvertical/smrt-profiles:Profile",
+              "match": {
+                "id": {
+                  "ref": "customer",
+                  "field": "profileId"
+                }
+              },
+              "values": {
+                "typeId": {
+                  "ref": "profileType"
+                }
+              }
+            },
+            {
+              "as": "customer",
+              "model": "@happyvertical/smrt-commerce:Customer",
+              "values": {
+                "profileId": {
+                  "ref": "profile"
+                }
+              }
+            }
+          ],
+          "fields": [
+            {
+              "id": "name",
+              "label": "Name",
+              "to": "profile.name",
+              "required": true
+            },
+            {
+              "id": "email",
+              "label": "Email",
+              "to": "profile.email"
+            },
+            {
+              "id": "status",
+              "label": "Status",
+              "to": "customer.status",
+              "default": "active"
+            },
+            {
+              "id": "customerType",
+              "label": "Customer type",
+              "to": "customer.customerType",
+              "default": "dtc"
+            },
+            {
+              "id": "paymentTerms",
+              "label": "Payment terms",
+              "to": "customer.paymentTerms"
+            },
+            {
+              "id": "creditLimit",
+              "label": "Credit limit",
+              "to": "customer.creditLimit"
+            },
+            {
+              "id": "taxExempt",
+              "label": "Tax exempt",
+              "to": "customer.taxExempt"
+            },
+            {
+              "id": "taxId",
+              "label": "Tax ID",
+              "to": "customer.taxId"
+            },
+            {
+              "id": "shippingAddress",
+              "label": "Shipping address",
+              "to": "customer.defaultShippingAddress"
+            },
+            {
+              "id": "billingAddress",
+              "label": "Billing address",
+              "to": "customer.defaultBillingAddress"
+            },
+            {
+              "id": "notes",
+              "label": "Notes",
+              "to": "customer.notes"
+            }
+          ]
+        }
+      ]
+    },
+    "commerce.vendors": {
+      "forms": [
+        {
+          "id": "vendor.default",
+          "kind": "field-map",
+          "label": "Vendor",
+          "kindLabel": "Vendor",
+          "model": "@happyvertical/smrt-commerce:Vendor",
+          "records": [
+            {
+              "as": "profileType",
+              "model": "@happyvertical/smrt-profiles:ProfileType",
+              "match": {
+                "name": "Vendor"
+              }
+            },
+            {
+              "as": "profile",
+              "model": "@happyvertical/smrt-profiles:Profile",
+              "match": {
+                "id": {
+                  "ref": "vendor",
+                  "field": "profileId"
+                }
+              },
+              "values": {
+                "typeId": {
+                  "ref": "profileType"
+                }
+              }
+            },
+            {
+              "as": "vendor",
+              "model": "@happyvertical/smrt-commerce:Vendor",
+              "values": {
+                "profileId": {
+                  "ref": "profile"
+                }
+              }
+            }
+          ],
+          "fields": [
+            {
+              "id": "name",
+              "label": "Name",
+              "to": "profile.name",
+              "required": true
+            },
+            {
+              "id": "email",
+              "label": "Email",
+              "to": "profile.email"
+            },
+            {
+              "id": "status",
+              "label": "Status",
+              "to": "vendor.status",
+              "default": "active"
+            },
+            {
+              "id": "currency",
+              "label": "Currency",
+              "to": "vendor.currency",
+              "default": "USD"
+            },
+            {
+              "id": "paymentTerms",
+              "label": "Payment terms",
+              "to": "vendor.paymentTerms"
+            },
+            {
+              "id": "leadTimeDays",
+              "label": "Lead time (days)",
+              "to": "vendor.leadTimeDays"
+            },
+            {
+              "id": "minimumOrderAmount",
+              "label": "Minimum order",
+              "to": "vendor.minimumOrderAmount"
+            },
+            {
+              "id": "contactEmail",
+              "label": "Contact email",
+              "to": "vendor.defaultContactEmail"
+            },
+            {
+              "id": "contactPhone",
+              "label": "Contact phone",
+              "to": "vendor.defaultContactPhone"
+            },
+            {
+              "id": "notes",
+              "label": "Notes",
+              "to": "vendor.notes"
+            },
+            {
+              "id": "payoutAddresses",
+              "label": "Payout addresses",
+              "to": "vendor.payoutAddresses"
+            }
+          ]
+        }
+      ]
+    },
+    "inventory.stock": {
+      "extends": [
+        {
+          "form": "product.simple",
+          "records": [
+            {
+              "as": "sku",
+              "model": "@happyvertical/smrt-products:Sku",
+              "match": {
+                "productId": {
+                  "ref": "product"
+                }
+              },
+              "values": {
+                "code": "{product.name|slug}",
+                "name": "{product.name}",
+                "attributes": "{}",
+                "active": true
+              }
+            },
+            {
+              "as": "location",
+              "model": "@happyvertical/smrt-inventory:InventoryLocation",
+              "match": {
+                "code": "MAIN"
+              },
+              "values": {
+                "name": "Main warehouse",
+                "kind": "warehouse"
+              }
+            },
+            {
+              "as": "stock",
+              "model": "@happyvertical/smrt-inventory:StockLevel",
+              "match": {
+                "skuId": {
+                  "ref": "sku"
+                },
+                "locationId": {
+                  "ref": "location"
+                },
+                "state": "available"
+              }
+            }
+          ],
+          "fields": [
+            {
+              "id": "quantity",
+              "label": "Quantity",
+              "to": "stock.qty",
+              "default": 0
+            }
+          ]
+        },
+        {
+          "form": "product.clothing",
+          "records": [
+            {
+              "as": "location",
+              "model": "@happyvertical/smrt-inventory:InventoryLocation",
+              "match": {
+                "code": "MAIN"
+              },
+              "values": {
+                "name": "Main warehouse",
+                "kind": "warehouse"
+              }
+            },
+            {
+              "as": "stock",
+              "model": "@happyvertical/smrt-inventory:StockLevel",
+              "match": {
+                "skuId": {
+                  "ref": "sku"
+                },
+                "locationId": {
+                  "ref": "location"
+                },
+                "state": "available"
+              }
+            }
+          ],
+          "fields": [
+            {
+              "id": "quantity",
+              "label": "Quantity",
+              "to": "stock.qty",
+              "default": 0
+            }
+          ]
+        }
+      ]
+    },
+    "products.simple": {
+      "forms": [
+        {
+          "id": "product.simple",
+          "kind": "field-map",
+          "label": "Simple product",
+          "kindLabel": "Simple",
+          "model": "@happyvertical/smrt-products:Product",
+          "records": [
+            {
+              "as": "product",
+              "model": "@happyvertical/smrt-products:Product"
+            }
+          ],
+          "fields": [
+            {
+              "id": "name",
+              "label": "Name",
+              "to": "product.name",
+              "required": true
+            },
+            {
+              "id": "price",
+              "label": "Price",
+              "to": "product.price"
+            },
+            {
+              "id": "description",
+              "label": "Description",
+              "to": "product.description"
+            }
+          ]
+        }
+      ]
+    },
+    "products.clothing": {
+      "forms": [
+        {
+          "id": "product.clothing",
+          "kind": "variant-grid",
+          "label": "Clothing item",
+          "kindLabel": "Clothing",
+          "model": "@happyvertical/smrt-products:Product",
+          "product": {
+            "as": "product",
+            "model": "@happyvertical/smrt-products:Product"
+          },
+          "fields": [
+            {
+              "id": "name",
+              "label": "Name",
+              "to": "product.name",
+              "required": true
+            },
+            {
+              "id": "price",
+              "label": "Price",
+              "to": "product.price"
+            }
+          ],
+          "axes": [
+            {
+              "name": "size",
+              "label": "Sizes",
+              "values": [
+                "XS",
+                "S",
+                "M",
+                "L",
+                "XL"
+              ]
+            },
+            {
+              "name": "color",
+              "label": "Colors",
+              "values": []
+            }
+          ],
+          "variants": "@happyvertical/smrt-products:ProductVariant",
+          "skus": "@happyvertical/smrt-products:Sku"
+        }
+      ]
+    }
+  }
+}

package/dist/recipes/plan-data.d.ts

@@ -0,0 +1,41 @@
+import type { Cookbook } from '../cookbook/types.ts';
+import type { FieldPolicyRow } from './policy.ts';
+import type { ExposureSurface, RecipeModelHints } from './types.ts';
+/**
+ * The recipe-owned part of a plan as plain data, and the rules that change
+ * it, as pure functions (`data -> data`, never mutating). The browser's
+ * `recipeState` (runes) and the headless planner both hold a `PlanData` and
+ * call these, so a rule exists once.
+ */
+export interface PlanData {
+    ids: string[];
+    rows: FieldPolicyRow[];
+    narrowed: Record<string, ExposureSurface[]>;
+    /** Added feature models (qualified names): models no recipe covers. */
+    features: string[];
+    /**
+     * Recipe and feature ids a loaded cookbook named that this version does not
+     * know. Kept so the next save and export carry them; never applied.
+     */
+    unavailableRecipes: string[];
+    unavailableFeatures: string[];
+}
+export declare const emptyPlanData: () => PlanData;
+/** Drop options for models no added recipe covers any more. */
+export declare function prunePlan(data: PlanData): PlanData;
+/** Add recipes, pulling in everything they `require`. */
+export declare const withRecipesAdded: (data: PlanData, ids: readonly string[]) => PlanData;
+/** Remove recipes; ones other added recipes need are kept. */
+export declare function withRecipesRemoved(data: PlanData, ids: readonly string[]): PlanData;
+export declare const withFeatureAdded: (data: PlanData, id: string) => PlanData;
+export declare const withFeatureRemoved: (data: PlanData, id: string) => PlanData;
+/** Added recipes that need `id`; non-empty means it cannot be removed. */
+export declare const recipesRequiringId: (data: PlanData, id: string) => string[];
+/** The hints of the first added recipe that includes this model. */
+export declare function hintsForModel(data: Pick<PlanData, 'ids'>, modelId: string): RecipeModelHints | undefined;
+/** Replace the saved options for one model. */
+export declare function withModelOptions(data: PlanData, modelId: string, rows: readonly FieldPolicyRow[], narrowed: readonly ExposureSurface[]): PlanData;
+/** The recipes and options as cookbook fields, in a stable order. */
+export declare function planFields(data: PlanData): Pick<Cookbook, 'recipes' | 'features' | 'policies' | 'exposure'>;
+/** The plan a validated cookbook describes. */
+export declare function planFromCookbook(cookbook: Pick<Cookbook, 'recipes' | 'features' | 'policies' | 'exposure'>): PlanData;

package/dist/recipes/plan-data.js

@@ -0,0 +1,97 @@
+import { getModelByQualifiedName } from "../catalog/index.js";
+import { isSettingRow } from "../settings/app-settings.js";
+import { recipesById } from "./index.js";
+import { recipesRequiring, withRequirements } from "./resolve.js";
+export const emptyPlanData = () => ({
+    ids: [],
+    rows: [],
+    narrowed: {},
+    features: [],
+    unavailableRecipes: [],
+    unavailableFeatures: [],
+});
+/** Drop options for models no added recipe covers any more. */
+export function prunePlan(data) {
+    // A feature model is covered too: a cookbook can set its options.
+    const covered = new Set([
+        ...data.ids.flatMap((id) => recipesById.get(id)?.models ?? []),
+        ...data.features,
+    ]);
+    return {
+        ...data,
+        // App settings rows stay on models not covered yet (see isSettingRow).
+        rows: data.rows.filter((r) => covered.has(r.objectRef) || isSettingRow(r)),
+        narrowed: Object.fromEntries(Object.entries(data.narrowed).filter(([ref]) => covered.has(ref))),
+    };
+}
+/** Add recipes, pulling in everything they `require`. */
+export const withRecipesAdded = (data, ids) => ({
+    ...data,
+    ids: withRequirements([...data.ids, ...ids], recipesById),
+});
+/** Remove recipes; ones other added recipes need are kept. */
+export function withRecipesRemoved(data, ids) {
+    const removing = new Set(ids);
+    const remaining = data.ids.filter((id) => !removing.has(id));
+    return prunePlan({ ...data, ids: withRequirements(remaining, recipesById) });
+}
+export const withFeatureAdded = (data, id) => data.features.includes(id)
+    ? data
+    : { ...data, features: [...data.features, id].sort() };
+export const withFeatureRemoved = (data, id) => prunePlan({ ...data, features: data.features.filter((f) => f !== id) });
+/** Added recipes that need `id`; non-empty means it cannot be removed. */
+export const recipesRequiringId = (data, id) => recipesRequiring(id, data.ids, recipesById);
+/** The hints of the first added recipe that includes this model. */
+export function hintsForModel(data, modelId) {
+    for (const id of data.ids) {
+        const hints = recipesById.get(id)?.options?.[modelId];
+        if (hints)
+            return hints;
+    }
+    return undefined;
+}
+/** Replace the saved options for one model. */
+export function withModelOptions(data, modelId, rows, narrowed) {
+    const next = { ...data.narrowed };
+    if (narrowed.length)
+        next[modelId] = [...narrowed];
+    else
+        delete next[modelId];
+    return {
+        ...data,
+        rows: [...data.rows.filter((r) => r.objectRef !== modelId), ...rows],
+        narrowed: next,
+    };
+}
+/** The recipes and options as cookbook fields, in a stable order. */
+export function planFields(data) {
+    const policies = [...data.rows].sort((a, b) => a.objectRef.localeCompare(b.objectRef) ||
+        a.fieldName.localeCompare(b.fieldName));
+    const exposure = Object.fromEntries(Object.keys(data.narrowed)
+        .sort()
+        .filter((ref) => data.narrowed[ref].length)
+        .map((ref) => [ref, [...data.narrowed[ref]].sort()]));
+    const out = {
+        recipes: [...data.ids, ...data.unavailableRecipes].sort(),
+        features: [...data.features, ...data.unavailableFeatures].sort(),
+        policies: policies.map((row) => ({ ...row })),
+    };
+    if (Object.keys(exposure).length)
+        out.exposure = exposure;
+    return out;
+}
+/** The plan a validated cookbook describes. */
+export function planFromCookbook(cookbook) {
+    const features = [...new Set(cookbook.features)];
+    const known = (name) => Boolean(getModelByQualifiedName(name)?.model.exposed);
+    return prunePlan({
+        ids: withRequirements(cookbook.recipes, recipesById),
+        rows: cookbook.policies.map((row) => ({ ...row })),
+        narrowed: Object.fromEntries(Object.entries(cookbook.exposure ?? {}).map(([ref, s]) => [ref, [...s]])),
+        features: features.filter(known).sort(),
+        unavailableRecipes: [
+            ...new Set(cookbook.recipes.filter((id) => !recipesById.has(id))),
+        ].sort(),
+        unavailableFeatures: features.filter((f) => !known(f)).sort(),
+    });
+}

package/dist/recipes/plumbing.d.ts

@@ -0,0 +1,70 @@
+import type { Catalog, CatalogModel } from '../catalog/types.ts';
+/**
+ * Plumbing vs feature. The Features tab lists models a visitor can add to the
+ * menu; most of the ~220 uncovered models are rows that only make sense inside
+ * another model (a line item, a link table, a lookup list), so they are hidden
+ * unless "Show all" is on. The rules are data-driven where the catalog allows:
+ *
+ * 1. Extends a junction/association base (`SmrtJunction`, `SmrtJunctionBase`,
+ *    `SmrtPolymorphicAssociation`). The catalog keeps `extends` only for
+ *    same-package STI parents, so this fires once the generator carries bases.
+ * 2. Looks like a link table: two or more foreign keys and at most one other
+ *    own field (`GroupMember`, `RolePermission`, `ProfileMetadata`).
+ * 3. Child/extension record, by name suffix: `Metafield`, `Metadata`,
+ *    `Association`, `LineItem`, `Allocation`, `Revision`, `Attachment`,
+ *    `Snapshot`, `Completion`, `Override`, `Alias`. Each appears in the catalog
+ *    only as a dependent of a parent model (`InvoiceLineItem`,
+ *    `ContentContributionRevision`, `CampaignMetricSnapshot`).
+ * 4. Tiny lookup list: a name ending `Status` or `Type` with at most three
+ *    non-system fields (`AssetStatus`, `PlaceType`, `ProfileType`). Richer
+ *    types such as `ContentContributionType` stay features.
+ */
+export declare const JUNCTION_BASES: readonly string[];
+export declare const CHILD_SUFFIXES: readonly string[];
+export declare const LOOKUP_SUFFIXES: readonly string[];
+export declare const LOOKUP_MAX_FIELDS = 3;
+export declare const LINK_MIN_REFS = 2;
+export declare const LINK_MAX_OTHER_FIELDS = 1;
+type ModelShape = Pick<CatalogModel, 'name' | 'fields' | 'extends'>;
+/** The reason a model is plumbing, or null when it is a feature. */
+export declare function plumbingReason(model: ModelShape): string | null;
+export declare function isPlumbing(model: ModelShape): boolean;
+/**
+ * Child records of a model, found from the catalog: models with a foreign key
+ * to the model (or to a model it extends) that are line items, allocations,
+ * link tables and the like (`plumbingReason` of junction, link or child, never
+ * a plain lookup list). They ride along with the model and have no menu entry.
+ */
+export declare function childModels(catalog: Catalog, modelId: string): CatalogModel[];
+/** The slice of a recipe the child lookup reads. */
+export interface RecipeScope {
+    models: readonly string[];
+    nav: readonly {
+        model: string;
+    }[];
+}
+/** A child model and the foreign key that points it at its parent. */
+export interface ChildLink {
+    model: CatalogModel;
+    /** The child's field holding the parent record's id. */
+    fk: string;
+}
+/**
+ * The records that live inside a model's own record view. When the model is in
+ * a recipe, a child is a model the recipe lists but gives no menu entry (so it
+ * has no page of its own) whose foreign key targets the model or a class it
+ * extends: `ContractLineItem` under every Contract subtype, `InvoiceLineItem`
+ * and `PaymentAllocation` under Invoice, `JournalEntry` under Journal. A model
+ * in no recipe (a Feature) falls back to {@link childModels}.
+ */
+export declare function childLinks(catalog: Catalog, recipes: readonly RecipeScope[], modelId: string): ChildLink[];
+/** Does any recipe give the model a menu entry of its own? */
+export declare function hasNavPage(recipes: readonly RecipeScope[], modelId: string): boolean;
+/**
+ * Title of a child table: the child's name without the parent's prefix,
+ * pluralised ("ContractLineItem" under Agreement/Contract is "Line items").
+ */
+export declare function childTitle(childName: string, parentNames: readonly string[]): string;
+/** Names of the model and its STI ancestors, for {@link childTitle}. */
+export declare function lineageNames(catalog: Catalog, modelId: string): string[];
+export {};