@wildo-ai/platform-core-shared 1.0.1 → 1.1.1

package/dist/esm/workbench/workbench-resources.custom.shared.schemas.js

@@ -0,0 +1,120 @@
+import { z } from 'zod';
+import { initZodDecorators } from '@wildo-ai/zod-decorators';
+initZodDecorators(z);
+/**
+ * An application's shared MODULE and the resources it owns — derived, never stored.
+ *
+ * The first resource backed by `PersistenceAdapter.INTROSPECTION`. Rows come from the companion's
+ * `resource-specifications` behavior, whose `moduleOwnership` is exactly this shape
+ * (`{ moduleId, resourceTypes }`), so nothing is reshaped on the way through: the binding names the
+ * behavior and the path, and the schema describes what that behavior already answers.
+ *
+ * ## Why `moduleId` is the primary key
+ *
+ * There is no store to mint a surrogate in. A derived row must be identified by something the SOURCE
+ * already guarantees unique, and a module id is that by construction — two modules with one id would
+ * be a defect in the application, not in this projection.
+ */
+export const Workbench_ApplicationModule_Schema = z.object({
+    moduleId: z.string().min(1).isPrimaryKey().isSummaryField(),
+    /**
+     * The resource types this module registers.
+     *
+     * A plain string array rather than foreign keys: these name resources in the OBSERVED
+     * application's registry, not rows in any store this workbench can reach. Modelling them as
+     * relationships would promise a join that cannot exist.
+     */
+    resourceTypes: z.array(z.string()).isSummaryField(),
+    /**
+     * `domain` or `engine` — or absent, which an application is free to leave unset.
+     *
+     * Carried because it is the ONE field that distinguishes a business-domain module from an engine
+     * contribution, and the projection used to discard it. Without it a module carrying roles,
+     * features, milestones and a product catalog is indistinguishable from a broken empty one.
+     *
+     * A plain nullable string rather than the `ApplicationModuleKind` union: this is a projection of
+     * the OBSERVED application's declaration, which may be built against a different engine revision
+     * than the workbench. Binding the union here would make the workbench refuse to display a kind the
+     * observed app can legitimately declare — refusing to show exactly the drift it exists to reveal.
+     */
+    kind: z.string().min(1).nullable(),
+    /**
+     * What the module contributes, and how much of each.
+     *
+     * DERIVED from the module's own declared keys rather than from a fixed list, so a contribution
+     * kind added to `SharedSaaSModule` appears here without a schema or projection change. Counts
+     * rather than content: an inventory answers whether and how much, and the content belongs to
+     * whichever behavior projects that contribution specifically.
+     */
+    contributions: z.array(z.object({
+        contribution: z.string().min(1),
+        count: z.number().int().nonnegative(),
+    })),
+});
+/**
+ * One relationship edge between two of the observed application's resources.
+ *
+ * ## Where the shape comes from
+ *
+ * MEASURED against a live `resources-registry` derivation rather than transcribed from the engine's
+ * `ResourceRelationship` type: 16 edges, 12 keys present on all of them and `primaryScope` on 8. The
+ * engine type carries more than the behavior emits, and a schema written from the type would refuse
+ * every row for fields the projection never sends.
+ *
+ * ## Why the vocabularies are plain strings here
+ *
+ * `nature`, `cardinality*` and `accessScopeStrategy` ARE closed engine enums, and this is one of the
+ * documented exceptions rather than an oversight: these rows cross a subprocess boundary as JSON
+ * from the OBSERVED application's registry, which may be built against a different engine revision
+ * than the workbench. Binding to the enum would make a row the observed app can legitimately produce
+ * unparseable here — the workbench would refuse to show exactly the drift it exists to reveal. This
+ * is a projection of someone else's runtime, not an authored value the framework controls.
+ *
+ * `resolvedSemantics` is deliberately ABSENT. It is a deep nested object (handling modes, foreign-key
+ * persistence) that no current view reads, and copying it into the schema would freeze a shape whose
+ * consumer does not exist yet.
+ */
+export const Workbench_ResourceRelationship_Schema = z.object({
+    /**
+     * Composed by the introspection source from the binding's `identityFields`, because a relationship
+     * row carries no identifier of its own — see `IntrospectionResourceBinding.identityFields`.
+     *
+     * ## Why this is named for the resource rather than `relationshipId`
+     *
+     * A COMPOSED identity is written to the resource's own `resourceFieldIdentifier`. That is the one
+     * name the source can resolve from the registry without introspecting decorators — the schema's
+     * `.isPrimaryKey()` marker is not readable as a field NAME from the built configuration, and
+     * duplicating the name onto the binding would create a second declaration that can disagree.
+     *
+     * Its sibling `workbenchApplicationModules` names its key `moduleId` instead, and the difference
+     * is real rather than inconsistent: that behavior's rows arrive carrying `moduleId`, so nothing is
+     * composed and the schema is free to keep the source's own name.
+     */
+    /*
+     * `.isSummaryField()` on the IDENTITY field, which is not cosmetic.
+     *
+     * A list renders the SUMMARY projection, and a row click resolves its target by reading the
+     * resource's addressing field off the clicked item. Omit it and the projection carries every
+     * display column and no id, so every row in the list is unclickable — `ResourceLayoutPreset_List`
+     * logs "could not resolve resource id from list item" and does nothing. Measured on this resource:
+     * the summary returned `nature, resourceType1, resourceType2` and no row could be opened.
+     */
+    workbenchResourceRelationshipId: z.string().min(1).isPrimaryKey().isSummaryField(),
+    resourceType1: z.string().min(1).isSummaryField(),
+    resourceType2: z.string().min(1).isSummaryField(),
+    /** `one` / `many`, as the observed application's registry reports them. */
+    cardinality1: z.string().min(1),
+    cardinality2: z.string().min(1),
+    /** `composition`, `aggregation`, `reference`, … — the observed app's vocabulary, not ours. */
+    nature: z.string().min(1).isSummaryField(),
+    /** The field carrying the join. Present on every measured edge. */
+    foreignKeyField: z.string().min(1),
+    accessScopeStrategy: z.string().min(1),
+    parentResourceRequirement: z.string().min(1),
+    isPrimaryScope: z.boolean(),
+    allowCycle: z.boolean(),
+    isDisabled: z.boolean(),
+    /** Present on 8 of 16 measured edges — optional because the projection genuinely omits it. */
+    primaryScope: z.string().min(1).optional(),
+});
+//# sourceMappingURL=workbench-resources.custom.shared.schemas.js.map

package/dist/esm/workbench/workbench-resources.custom.shared.schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workbench-resources.custom.shared.schemas.js","sourceRoot":"","sources":["../../../../src/workbench/workbench-resources.custom.shared.schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAErB;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CAAC;IACzD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC,cAAc,EAAE;IAC3D;;;;;;OAMG;IACH,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,cAAc,EAAE;IACnD;;;;;;;;;;;OAWG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAClC;;;;;;;OAOG;IACH,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;QAC9B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;KACtC,CAAC,CAAC;CACJ,CAAC,CAAC;AAIH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5D;;;;;;;;;;;;;;OAcG;IACH;;;;;;;;OAQG;IACH,+BAA+B,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC,cAAc,EAAE;IAClF,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE;IACjD,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE;IACjD,2EAA2E;IAC3E,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/B,8FAA8F;IAC9F,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE;IAC1C,mEAAmE;IACnE,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,yBAAyB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,8FAA8F;IAC9F,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC","sourcesContent":["import { z } from 'zod';\nimport { initZodDecorators } from '@wildo-ai/zod-decorators';\n\ninitZodDecorators(z);\n\n/**\n * An application's shared MODULE and the resources it owns — derived, never stored.\n *\n * The first resource backed by `PersistenceAdapter.INTROSPECTION`. Rows come from the companion's\n * `resource-specifications` behavior, whose `moduleOwnership` is exactly this shape\n * (`{ moduleId, resourceTypes }`), so nothing is reshaped on the way through: the binding names the\n * behavior and the path, and the schema describes what that behavior already answers.\n *\n * ## Why `moduleId` is the primary key\n *\n * There is no store to mint a surrogate in. A derived row must be identified by something the SOURCE\n * already guarantees unique, and a module id is that by construction — two modules with one id would\n * be a defect in the application, not in this projection.\n */\nexport const Workbench_ApplicationModule_Schema = z.object({\n  moduleId: z.string().min(1).isPrimaryKey().isSummaryField(),\n  /**\n   * The resource types this module registers.\n   *\n   * A plain string array rather than foreign keys: these name resources in the OBSERVED\n   * application's registry, not rows in any store this workbench can reach. Modelling them as\n   * relationships would promise a join that cannot exist.\n   */\n  resourceTypes: z.array(z.string()).isSummaryField(),\n  /**\n   * `domain` or `engine` — or absent, which an application is free to leave unset.\n   *\n   * Carried because it is the ONE field that distinguishes a business-domain module from an engine\n   * contribution, and the projection used to discard it. Without it a module carrying roles,\n   * features, milestones and a product catalog is indistinguishable from a broken empty one.\n   *\n   * A plain nullable string rather than the `ApplicationModuleKind` union: this is a projection of\n   * the OBSERVED application's declaration, which may be built against a different engine revision\n   * than the workbench. Binding the union here would make the workbench refuse to display a kind the\n   * observed app can legitimately declare — refusing to show exactly the drift it exists to reveal.\n   */\n  kind: z.string().min(1).nullable(),\n  /**\n   * What the module contributes, and how much of each.\n   *\n   * DERIVED from the module's own declared keys rather than from a fixed list, so a contribution\n   * kind added to `SharedSaaSModule` appears here without a schema or projection change. Counts\n   * rather than content: an inventory answers whether and how much, and the content belongs to\n   * whichever behavior projects that contribution specifically.\n   */\n  contributions: z.array(z.object({\n    contribution: z.string().min(1),\n    count: z.number().int().nonnegative(),\n  })),\n});\n\nexport type Workbench_ApplicationModule = z.infer<typeof Workbench_ApplicationModule_Schema>;\n\n/**\n * One relationship edge between two of the observed application's resources.\n *\n * ## Where the shape comes from\n *\n * MEASURED against a live `resources-registry` derivation rather than transcribed from the engine's\n * `ResourceRelationship` type: 16 edges, 12 keys present on all of them and `primaryScope` on 8. The\n * engine type carries more than the behavior emits, and a schema written from the type would refuse\n * every row for fields the projection never sends.\n *\n * ## Why the vocabularies are plain strings here\n *\n * `nature`, `cardinality*` and `accessScopeStrategy` ARE closed engine enums, and this is one of the\n * documented exceptions rather than an oversight: these rows cross a subprocess boundary as JSON\n * from the OBSERVED application's registry, which may be built against a different engine revision\n * than the workbench. Binding to the enum would make a row the observed app can legitimately produce\n * unparseable here — the workbench would refuse to show exactly the drift it exists to reveal. This\n * is a projection of someone else's runtime, not an authored value the framework controls.\n *\n * `resolvedSemantics` is deliberately ABSENT. It is a deep nested object (handling modes, foreign-key\n * persistence) that no current view reads, and copying it into the schema would freeze a shape whose\n * consumer does not exist yet.\n */\nexport const Workbench_ResourceRelationship_Schema = z.object({\n  /**\n   * Composed by the introspection source from the binding's `identityFields`, because a relationship\n   * row carries no identifier of its own — see `IntrospectionResourceBinding.identityFields`.\n   *\n   * ## Why this is named for the resource rather than `relationshipId`\n   *\n   * A COMPOSED identity is written to the resource's own `resourceFieldIdentifier`. That is the one\n   * name the source can resolve from the registry without introspecting decorators — the schema's\n   * `.isPrimaryKey()` marker is not readable as a field NAME from the built configuration, and\n   * duplicating the name onto the binding would create a second declaration that can disagree.\n   *\n   * Its sibling `workbenchApplicationModules` names its key `moduleId` instead, and the difference\n   * is real rather than inconsistent: that behavior's rows arrive carrying `moduleId`, so nothing is\n   * composed and the schema is free to keep the source's own name.\n   */\n  /*\n   * `.isSummaryField()` on the IDENTITY field, which is not cosmetic.\n   *\n   * A list renders the SUMMARY projection, and a row click resolves its target by reading the\n   * resource's addressing field off the clicked item. Omit it and the projection carries every\n   * display column and no id, so every row in the list is unclickable — `ResourceLayoutPreset_List`\n   * logs \"could not resolve resource id from list item\" and does nothing. Measured on this resource:\n   * the summary returned `nature, resourceType1, resourceType2` and no row could be opened.\n   */\n  workbenchResourceRelationshipId: z.string().min(1).isPrimaryKey().isSummaryField(),\n  resourceType1: z.string().min(1).isSummaryField(),\n  resourceType2: z.string().min(1).isSummaryField(),\n  /** `one` / `many`, as the observed application's registry reports them. */\n  cardinality1: z.string().min(1),\n  cardinality2: z.string().min(1),\n  /** `composition`, `aggregation`, `reference`, … — the observed app's vocabulary, not ours. */\n  nature: z.string().min(1).isSummaryField(),\n  /** The field carrying the join. Present on every measured edge. */\n  foreignKeyField: z.string().min(1),\n  accessScopeStrategy: z.string().min(1),\n  parentResourceRequirement: z.string().min(1),\n  isPrimaryScope: z.boolean(),\n  allowCycle: z.boolean(),\n  isDisabled: z.boolean(),\n  /** Present on 8 of 16 measured edges — optional because the projection genuinely omits it. */\n  primaryScope: z.string().min(1).optional(),\n});\n\nexport type Workbench_ResourceRelationship = z.infer<typeof Workbench_ResourceRelationship_Schema>;\n\n"]}