@powerhousedao/knowledge-note 1.0.0

package/README.md

@@ -0,0 +1,179 @@
+# Document Model Boilerplate
+
+This Document Model Boilerplate provides code generation for scaffolding editors and models. 
+It ensures compatibility with host applications like Connect and the Reactors for seamless document model and editor integration.
+
+## Standard Document Model Workflow with help of the boilerplate.
+This tutorial will guide you through the process of creating a new document model using the Document Model Editor in the Connect app. 
+
+<details>
+<summary>Available NPM commands</summary>
+
+-   `generate`: Updates the generated code according to the JSON spec and GraphQL schema of your document model, made in Connect.
+-   `lint`: Checks for errors with ESLint and TypeScript checking.
+-   `format`: Formats the code using Prettier.
+-   `build`: Builds the library project using Vite.
+-   `storybook`: Starts Storybook in development mode.
+-   `build-storybook`: Builds Storybook.
+-   `test`: Runs Jest for testing.
+
+</details>
+
+### 1. Defining Your Document Model GraphQL Schema
+Start by creating your own 'Powerhouse Project' (Document model + editor).
+
+Step 1: Run the following command to set up your project inside this directory:
+
+```bash
+npm create document-model-lib
+```
+
+Step 2: Use the Document Model Editor in the Connect app
+
+The following command gives you access to all the powerhouse CLI tools available, install it globally if you are a poweruser. 
+
+```bash
+npm install ph-cmd
+```
+Now you are able to launch Connect in Studio Mode (Locally):
+
+```bash
+npm run connect
+```
+
+Open the 'Document Model' creator at the bottom of connect to define your document mode with it's GraphQL Schema Definition.
+This schema will define the structure and fields for your document model using GraphQL. 
+Follow one of our tutorials on Academy to get familiar with the process. 
+
+### 2. Defining Document Model Operations
+Using the Document Model Operations Editor, define the operations for your document model and their GraphQL counterparts. 
+These operations will handle state changes within your document model.
+
+**Best Practices:**
+
+- Clearly define CRUD operations (Create, Read, Update, Delete).
+- Use GraphQL input types to specify the parameters for each operation.
+- Ensure that operations align with user intent to maintain a clean and understandable API.
+
+### 3. Generating Scaffolding Code
+Export your document model as a .zip file from Connect.
+Import the .zip file into your project directory created in Step 1.
+Run the following command to generate the scaffolding code:
+
+```bash
+npm run generate YourModelName.phdm.zip
+```
+
+This will create a new directory under /document-models containing:
+
+JSON file with the document model specification.
+GraphQL file with state and operation schemas.
+A gen/ folder with autogenerated code.
+A src/ folder for your custom code implementation.
+
+### 4. Implementing Reducer Code and Unit Tests
+Navigate to the reducer directory:
+
+```bash
+cd document-models/"YourModelName"/src/reducers
+```
+
+Implement the reducer functions for each document model operation. These functions will handle state transitions.
+
+Add utility functions in:
+
+```bash
+document-models/"YourModelName"/src/utils.ts
+```
+
+Write unit tests to ensure the correctness of your reducers:
+
+Test files should be located in:
+
+```bash
+document-models/"YourModelName"/src/reducers/tests
+```
+
+Run the tests:
+
+```bash
+npm test
+```
+
+Test the editor functionality:
+
+```bash
+npm run connect
+```
+
+### 5. Implementing Document Editors
+Generate the editor template for your document model:
+
+```bash
+npm run generate -- --editor YourModelName --document-types powerhouse/YourModelName
+```
+
+The --editor flag specifies the name of your document model.
+The --document-types flag links the editor to your document model type.
+After generation:
+
+Open the editor template:
+
+```bash
+editors/YourModelName/editor.tsx
+```
+
+Customize the editor interface to suit your document model.
+
+### 6. Testing the Document Editor
+Run the Connect app to test your document editor:
+
+```bash
+npm run connect
+```
+
+Verify that the editor functions as expected.
+Perform end-to-end testing to ensure smooth integration between the document model and its editor.
+
+### 7. Adding a Manifest File
+Create a manifest file to describe your document model and editor. This enables proper integration with the host application.
+
+**Example manifest.json:**
+
+```json
+{
+  "name": "your-model-name",
+  "description": "A brief description of your document model.",
+  "category": "your-category", // e.g., "Finance", "People Ops", "Legal"
+  "publisher": {
+    "name": "your-publisher-name",
+    "url": "your-publisher-url"
+  },
+  "documentModels": [
+    {
+      "id": "your-model-id",
+      "name": "your-model-name"
+    }
+  ],
+  "editors": [
+    {
+      "id": "your-editor-id",
+      "name": "your-editor-name",
+      "documentTypes": ["your-model-id"]
+    }
+  ]
+}
+```
+
+### Steps to finalize:
+
+Place the manifest file at your project root.
+Update your index.js to export your modules and include the new document model and editor.
+
+### Final Thoughts
+You've now successfully created a Document Model and its corresponding Editor using the Connect app!
+
+Next Steps:
+- Expand functionality: Add more operations or complex logic to your document model.
+- Improve UX: Enhance the document editor for a smoother user experience.
+- Integrate with other systems: Use APIs or GraphQL to connect your document model with external services.

package/dist/document-models/derivation/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./v1/index.js";
+export * from "./upgrades/index.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/document-models/derivation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../document-models/derivation/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC"}

package/dist/document-models/derivation/index.js

@@ -0,0 +1,2 @@
+export * from "./v1/index.js";
+export * from "./upgrades/index.js";

package/dist/document-models/derivation/upgrades/index.d.ts

@@ -0,0 +1,3 @@
+export { derivationUpgradeManifest } from "./upgrade-manifest.js";
+export { supportedVersions, latestVersion } from "./versions.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/document-models/derivation/upgrades/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../document-models/derivation/upgrades/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC"}

package/dist/document-models/derivation/upgrades/index.js

@@ -0,0 +1,2 @@
+export { derivationUpgradeManifest } from "./upgrade-manifest.js";
+export { supportedVersions, latestVersion } from "./versions.js";

package/dist/document-models/derivation/upgrades/upgrade-manifest.d.ts

@@ -0,0 +1,4 @@
+import type { UpgradeManifest } from "document-model";
+import { supportedVersions } from "./versions.js";
+export declare const derivationUpgradeManifest: UpgradeManifest<typeof supportedVersions>;
+//# sourceMappingURL=upgrade-manifest.d.ts.map

package/dist/document-models/derivation/upgrades/upgrade-manifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade-manifest.d.ts","sourceRoot":"","sources":["../../../../document-models/derivation/upgrades/upgrade-manifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAiB,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAEjE,eAAO,MAAM,yBAAyB,EAAE,eAAe,CACrD,OAAO,iBAAiB,CAMzB,CAAC"}

package/dist/document-models/derivation/upgrades/upgrade-manifest.js

@@ -0,0 +1,7 @@
+import { latestVersion, supportedVersions } from "./versions.js";
+export const derivationUpgradeManifest = {
+    documentType: "bai/derivation",
+    latestVersion,
+    supportedVersions,
+    upgrades: {},
+};

package/dist/document-models/derivation/upgrades/versions.d.ts

@@ -0,0 +1,3 @@
+export declare const supportedVersions: readonly [1];
+export declare const latestVersion: 1;
+//# sourceMappingURL=versions.d.ts.map

package/dist/document-models/derivation/upgrades/versions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.d.ts","sourceRoot":"","sources":["../../../../document-models/derivation/upgrades/versions.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,cAAe,CAAC;AAE9C,eAAO,MAAM,aAAa,GAAuB,CAAC"}

package/dist/document-models/derivation/upgrades/versions.js

@@ -0,0 +1,2 @@
+export const supportedVersions = [1];
+export const latestVersion = supportedVersions[0];

package/dist/document-models/derivation/v1/actions.d.ts

@@ -0,0 +1,18 @@
+/** Actions for the Derivation document model */
+export declare const actions: {
+    initializeDerivation: (input: import("./index.js").InitializeDerivationInput) => import("./index.js").InitializeDerivationAction;
+    addSignal: (input: import("./index.js").AddSignalInput) => import("./index.js").AddSignalAction;
+    addReseedEntry: (input: import("./index.js").AddReseedEntryInput) => import("./index.js").AddReseedEntryAction;
+    updateDimensionRationale: (input: import("./index.js").UpdateDimensionRationaleInput) => import("./index.js").UpdateDimensionRationaleAction;
+    setName: (name: string | {
+        name: string;
+    }) => import("document-model").SetNameAction;
+    undo: (count?: number, scope?: string) => import("document-model").UndoAction;
+    redo: (count?: number, scope?: string) => import("document-model").RedoAction;
+    prune: (start?: number, end?: number, scope?: string) => import("document-model").SchemaPruneAction;
+    loadState: <TState extends import("document-model").PHBaseState = import("document-model").PHBaseState>(state: TState & {
+        name: string;
+    }, operations: number) => import("document-model").LoadStateAction;
+    noop: (scope?: string) => import("document-model").NOOPAction;
+};
+//# sourceMappingURL=actions.d.ts.map

package/dist/document-models/derivation/v1/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../../document-models/derivation/v1/actions.ts"],"names":[],"mappings":"AAGA,gDAAgD;AAEhD,eAAO,MAAM,OAAO;2BACuR,qDAAgC;gBAAkM,0CAAqB;qBAAsK,+CAA0B;+BAAgM,yDAAuC;;;;gBAAkgM,CAAC,eAAe,CAAC;gBAAkE,CAAC,eAAe,CAAC;iBAAmE,CAAC,aAAa,CAAC,eAAe,CAAC;;;;gBAAqS,CAAC;CAD92O,CAAC"}

package/dist/document-models/derivation/v1/actions.js

@@ -0,0 +1,4 @@
+import { baseActions } from "document-model";
+import { derivationManagementActions } from "./gen/creators.js";
+/** Actions for the Derivation document model */
+export const actions = { ...baseActions, ...derivationManagementActions };

package/dist/document-models/derivation/v1/gen/actions.d.ts

@@ -0,0 +1,4 @@
+import type { DerivationDerivationManagementAction } from "./derivation-management/actions.js";
+export * from "./derivation-management/actions.js";
+export type DerivationAction = DerivationDerivationManagementAction;
+//# sourceMappingURL=actions.d.ts.map

package/dist/document-models/derivation/v1/gen/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../../../document-models/derivation/v1/gen/actions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oCAAoC,EAAE,MAAM,oCAAoC,CAAC;AAE/F,cAAc,oCAAoC,CAAC;AAEnD,MAAM,MAAM,gBAAgB,GAAG,oCAAoC,CAAC"}

package/dist/document-models/derivation/v1/gen/actions.js

@@ -0,0 +1 @@
+export * from "./derivation-management/actions.js";

package/dist/document-models/derivation/v1/gen/controller.d.ts

@@ -0,0 +1,4 @@
+import { PHDocumentController } from "document-model/core";
+import type { DerivationPHState } from "./types.js";
+export declare const DerivationController: new (initialDocument?: import("document-model").PHDocument<DerivationPHState> | undefined) => PHDocumentController<DerivationPHState> & import("document-model/core").ActionMap<import("./actions.js").DerivationDerivationManagementAction, PHDocumentController<DerivationPHState>>;
+//# sourceMappingURL=controller.d.ts.map

package/dist/document-models/derivation/v1/gen/controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../../../../document-models/derivation/v1/gen/controller.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAE3D,OAAO,KAAK,EAAoB,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEtE,eAAO,MAAM,oBAAoB,uRAGpB,CAAC"}

package/dist/document-models/derivation/v1/gen/controller.js

@@ -0,0 +1,3 @@
+import { PHDocumentController } from "document-model/core";
+import { Derivation } from "../module.js";
+export const DerivationController = PHDocumentController.forDocumentModel(Derivation);

package/dist/document-models/derivation/v1/gen/creators.d.ts

@@ -0,0 +1,3 @@
+export * from "./derivation-management/creators.js";
+export * as derivationManagementActions from "./derivation-management/creators.js";
+//# sourceMappingURL=creators.d.ts.map

package/dist/document-models/derivation/v1/gen/creators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"creators.d.ts","sourceRoot":"","sources":["../../../../../document-models/derivation/v1/gen/creators.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAC;AACpD,OAAO,KAAK,2BAA2B,MAAM,qCAAqC,CAAC"}

package/dist/document-models/derivation/v1/gen/creators.js

@@ -0,0 +1,2 @@
+export * from "./derivation-management/creators.js";
+export * as derivationManagementActions from "./derivation-management/creators.js";

package/dist/document-models/derivation/v1/gen/derivation-management/actions.d.ts

@@ -0,0 +1,20 @@
+import type { Action } from "document-model";
+import type { InitializeDerivationInput, AddSignalInput, AddReseedEntryInput, UpdateDimensionRationaleInput } from "../types.js";
+export type InitializeDerivationAction = Action & {
+    type: "INITIALIZE_DERIVATION";
+    input: InitializeDerivationInput;
+};
+export type AddSignalAction = Action & {
+    type: "ADD_SIGNAL";
+    input: AddSignalInput;
+};
+export type AddReseedEntryAction = Action & {
+    type: "ADD_RESEED_ENTRY";
+    input: AddReseedEntryInput;
+};
+export type UpdateDimensionRationaleAction = Action & {
+    type: "UPDATE_DIMENSION_RATIONALE";
+    input: UpdateDimensionRationaleInput;
+};
+export type DerivationDerivationManagementAction = InitializeDerivationAction | AddSignalAction | AddReseedEntryAction | UpdateDimensionRationaleAction;
+//# sourceMappingURL=actions.d.ts.map

package/dist/document-models/derivation/v1/gen/derivation-management/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../../../../document-models/derivation/v1/gen/derivation-management/actions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EACV,yBAAyB,EACzB,cAAc,EACd,mBAAmB,EACnB,6BAA6B,EAC9B,MAAM,aAAa,CAAC;AAErB,MAAM,MAAM,0BAA0B,GAAG,MAAM,GAAG;IAChD,IAAI,EAAE,uBAAuB,CAAC;IAC9B,KAAK,EAAE,yBAAyB,CAAC;CAClC,CAAC;AACF,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG;IACrC,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,cAAc,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG;IAC1C,IAAI,EAAE,kBAAkB,CAAC;IACzB,KAAK,EAAE,mBAAmB,CAAC;CAC5B,CAAC;AACF,MAAM,MAAM,8BAA8B,GAAG,MAAM,GAAG;IACpD,IAAI,EAAE,4BAA4B,CAAC;IACnC,KAAK,EAAE,6BAA6B,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAC5C,0BAA0B,GAC1B,eAAe,GACf,oBAAoB,GACpB,8BAA8B,CAAC"}

package/dist/document-models/derivation/v1/gen/derivation-management/actions.js

@@ -0,0 +1 @@
+export {};

package/dist/document-models/derivation/v1/gen/derivation-management/creators.d.ts

@@ -0,0 +1,7 @@
+import type { InitializeDerivationInput, AddSignalInput, AddReseedEntryInput, UpdateDimensionRationaleInput } from "../types.js";
+import type { InitializeDerivationAction, AddSignalAction, AddReseedEntryAction, UpdateDimensionRationaleAction } from "./actions.js";
+export declare const initializeDerivation: (input: InitializeDerivationInput) => InitializeDerivationAction;
+export declare const addSignal: (input: AddSignalInput) => AddSignalAction;
+export declare const addReseedEntry: (input: AddReseedEntryInput) => AddReseedEntryAction;
+export declare const updateDimensionRationale: (input: UpdateDimensionRationaleInput) => UpdateDimensionRationaleAction;
+//# sourceMappingURL=creators.d.ts.map

package/dist/document-models/derivation/v1/gen/derivation-management/creators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"creators.d.ts","sourceRoot":"","sources":["../../../../../../document-models/derivation/v1/gen/derivation-management/creators.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,yBAAyB,EACzB,cAAc,EACd,mBAAmB,EACnB,6BAA6B,EAC9B,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EACV,0BAA0B,EAC1B,eAAe,EACf,oBAAoB,EACpB,8BAA8B,EAC/B,MAAM,cAAc,CAAC;AAEtB,eAAO,MAAM,oBAAoB,GAAI,OAAO,yBAAyB,+BAOlE,CAAC;AAEJ,eAAO,MAAM,SAAS,GAAI,OAAO,cAAc,oBAO5C,CAAC;AAEJ,eAAO,MAAM,cAAc,GAAI,OAAO,mBAAmB,yBAOtD,CAAC;AAEJ,eAAO,MAAM,wBAAwB,GACnC,OAAO,6BAA6B,mCAQnC,CAAC"}

package/dist/document-models/derivation/v1/gen/derivation-management/creators.js

@@ -0,0 +1,6 @@
+import { createAction } from "document-model/core";
+import { InitializeDerivationInputSchema, AddSignalInputSchema, AddReseedEntryInputSchema, UpdateDimensionRationaleInputSchema, } from "../schema/zod.js";
+export const initializeDerivation = (input) => createAction("INITIALIZE_DERIVATION", { ...input }, undefined, InitializeDerivationInputSchema, "global");
+export const addSignal = (input) => createAction("ADD_SIGNAL", { ...input }, undefined, AddSignalInputSchema, "global");
+export const addReseedEntry = (input) => createAction("ADD_RESEED_ENTRY", { ...input }, undefined, AddReseedEntryInputSchema, "global");
+export const updateDimensionRationale = (input) => createAction("UPDATE_DIMENSION_RATIONALE", { ...input }, undefined, UpdateDimensionRationaleInputSchema, "global");

package/dist/document-models/derivation/v1/gen/derivation-management/error.d.ts

@@ -0,0 +1,2 @@
+export declare const errors: {};
+//# sourceMappingURL=error.d.ts.map

package/dist/document-models/derivation/v1/gen/derivation-management/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../../../../document-models/derivation/v1/gen/derivation-management/error.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM,IAAK,CAAC"}

package/dist/document-models/derivation/v1/gen/derivation-management/error.js

@@ -0,0 +1 @@
+export const errors = {};

package/dist/document-models/derivation/v1/gen/derivation-management/operations.d.ts

@@ -0,0 +1,10 @@
+import { type SignalDispatch } from "document-model";
+import type { InitializeDerivationAction, AddSignalAction, AddReseedEntryAction, UpdateDimensionRationaleAction } from "./actions.js";
+import type { DerivationState } from "../types.js";
+export interface DerivationDerivationManagementOperations {
+    initializeDerivationOperation: (state: DerivationState, action: InitializeDerivationAction, dispatch?: SignalDispatch) => void;
+    addSignalOperation: (state: DerivationState, action: AddSignalAction, dispatch?: SignalDispatch) => void;
+    addReseedEntryOperation: (state: DerivationState, action: AddReseedEntryAction, dispatch?: SignalDispatch) => void;
+    updateDimensionRationaleOperation: (state: DerivationState, action: UpdateDimensionRationaleAction, dispatch?: SignalDispatch) => void;
+}
+//# sourceMappingURL=operations.d.ts.map

package/dist/document-models/derivation/v1/gen/derivation-management/operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../../../../../../document-models/derivation/v1/gen/derivation-management/operations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EACV,0BAA0B,EAC1B,eAAe,EACf,oBAAoB,EACpB,8BAA8B,EAC/B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD,MAAM,WAAW,wCAAwC;IACvD,6BAA6B,EAAE,CAC7B,KAAK,EAAE,eAAe,EACtB,MAAM,EAAE,0BAA0B,EAClC,QAAQ,CAAC,EAAE,cAAc,KACtB,IAAI,CAAC;IACV,kBAAkB,EAAE,CAClB,KAAK,EAAE,eAAe,EACtB,MAAM,EAAE,eAAe,EACvB,QAAQ,CAAC,EAAE,cAAc,KACtB,IAAI,CAAC;IACV,uBAAuB,EAAE,CACvB,KAAK,EAAE,eAAe,EACtB,MAAM,EAAE,oBAAoB,EAC5B,QAAQ,CAAC,EAAE,cAAc,KACtB,IAAI,CAAC;IACV,iCAAiC,EAAE,CACjC,KAAK,EAAE,eAAe,EACtB,MAAM,EAAE,8BAA8B,EACtC,QAAQ,CAAC,EAAE,cAAc,KACtB,IAAI,CAAC;CACX"}

package/dist/document-models/derivation/v1/gen/derivation-management/operations.js

@@ -0,0 +1 @@
+import {} from "document-model";

package/dist/document-models/derivation/v1/gen/document-model.d.ts

@@ -0,0 +1,3 @@
+import type { DocumentModelGlobalState } from "document-model";
+export declare const documentModel: DocumentModelGlobalState;
+//# sourceMappingURL=document-model.d.ts.map

package/dist/document-models/derivation/v1/gen/document-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-model.d.ts","sourceRoot":"","sources":["../../../../../document-models/derivation/v1/gen/document-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAE/D,eAAO,MAAM,aAAa,EAAE,wBA2F3B,CAAC"}

package/dist/document-models/derivation/v1/gen/document-model.js

@@ -0,0 +1,81 @@
+export const documentModel = {
+    id: "bai/derivation",
+    name: "Derivation",
+    author: {
+        name: "BAI",
+        website: "https://bai.dev",
+    },
+    extension: "der.phd",
+    description: "Derivation record \u2014 audit trail of vault configuration decisions backed by research claims, dimension rationale, and coherence checks.",
+    specifications: [
+        {
+            state: {
+                local: {
+                    schema: "",
+                    examples: [],
+                    initialValue: "",
+                },
+                global: {
+                    schema: "type DerivationSignal {\n    id: OID!\n    utterance: String!\n    influencedDimensions: [String!]!\n    interpretation: String!\n}\n\ntype DimensionRationale {\n    dimension: String!\n    position: Int!\n    confidence: Float!\n    rationale: String!\n    supportingClaims: [String!]!\n    failureModes: [String!]!\n}\n\ntype ClaimReference {\n    id: OID!\n    claimRef: String!\n    supportsDecision: String!\n    strength: String!\n}\n\ntype FeatureDecision {\n    feature: String!\n    enabled: Boolean!\n    rationale: String!\n    supportingClaims: [String!]!\n}\n\ntype CoherenceCheck {\n    dimensionPair: [String!]!\n    coherent: Boolean!\n    explanation: String!\n}\n\ntype ReseedEntry {\n    id: OID!\n    reseededAt: DateTime!\n    reason: String!\n    changes: [String!]!\n}\n\ntype DerivationState {\n    engineVersion: String\n    derivedAt: DateTime\n    signals: [DerivationSignal!]!\n    dimensionRationale: [DimensionRationale!]!\n    claimReferences: [ClaimReference!]!\n    featureDecisions: [FeatureDecision!]!\n    coherenceResults: [CoherenceCheck!]!\n    reseedHistory: [ReseedEntry!]!\n}",
+                    examples: [],
+                    initialValue: '{\n    "engineVersion": null,\n    "derivedAt": null,\n    "signals": [],\n    "dimensionRationale": [],\n    "claimReferences": [],\n    "featureDecisions": [],\n    "coherenceResults": [],\n    "reseedHistory": []\n}',
+                },
+            },
+            modules: [
+                {
+                    id: "derivation-management",
+                    name: "derivation-management",
+                    description: "Derivation audit trail",
+                    operations: [
+                        {
+                            id: "initialize-derivation",
+                            name: "INITIALIZE_DERIVATION",
+                            description: "Initialize derivation record",
+                            schema: "input InitializeDerivationInput {\n    engineVersion: String!\n    derivedAt: DateTime!\n}",
+                            template: "Initialize derivation record",
+                            reducer: "state.engineVersion = action.input.engineVersion;\nstate.derivedAt = action.input.derivedAt;",
+                            errors: [],
+                            examples: [],
+                            scope: "global",
+                        },
+                        {
+                            id: "add-signal",
+                            name: "ADD_SIGNAL",
+                            description: "Record a user signal that influenced derivation",
+                            schema: "input AddSignalInput {\n    id: OID!\n    utterance: String!\n    influencedDimensions: [String!]!\n    interpretation: String!\n}",
+                            template: "Record a user signal that influenced derivation",
+                            reducer: "state.signals.push({\n    id: action.input.id,\n    utterance: action.input.utterance,\n    influencedDimensions: action.input.influencedDimensions,\n    interpretation: action.input.interpretation,\n});",
+                            errors: [],
+                            examples: [],
+                            scope: "global",
+                        },
+                        {
+                            id: "add-reseed-entry",
+                            name: "ADD_RESEED_ENTRY",
+                            description: "Record a re-derivation event",
+                            schema: "input AddReseedEntryInput {\n    id: OID!\n    reseededAt: DateTime!\n    reason: String!\n    changes: [String!]!\n}",
+                            template: "Record a re-derivation event",
+                            reducer: "state.reseedHistory.push({\n    id: action.input.id,\n    reseededAt: action.input.reseededAt,\n    reason: action.input.reason,\n    changes: action.input.changes,\n});",
+                            errors: [],
+                            examples: [],
+                            scope: "global",
+                        },
+                        {
+                            id: "update-dimension-rationale",
+                            name: "UPDATE_DIMENSION_RATIONALE",
+                            description: "Update rationale for a dimension position",
+                            schema: "input UpdateDimensionRationaleInput {\n    dimension: String!\n    position: Int!\n    confidence: Float!\n    rationale: String!\n    supportingClaims: [String!]!\n    failureModes: [String!]!\n}",
+                            template: "Update rationale for a dimension position",
+                            reducer: "const existing = state.dimensionRationale.findIndex(d => d.dimension === action.input.dimension);\nconst entry = {\n    dimension: action.input.dimension,\n    position: action.input.position,\n    confidence: action.input.confidence,\n    rationale: action.input.rationale,\n    supportingClaims: action.input.supportingClaims,\n    failureModes: action.input.failureModes,\n};\nif (existing >= 0) {\n    state.dimensionRationale[existing] = entry;\n} else {\n    state.dimensionRationale.push(entry);\n}",
+                            errors: [],
+                            examples: [],
+                            scope: "global",
+                        },
+                    ],
+                },
+            ],
+            version: 1,
+            changeLog: [],
+        },
+    ],
+};

package/dist/document-models/derivation/v1/gen/document-schema.d.ts

@@ -0,0 +1,65 @@
+import { z } from "zod";
+import type { DerivationDocument, DerivationPHState } from "./types.js";
+/** Schema for validating the header object of a Derivation document */
+export declare const DerivationDocumentHeaderSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    createdAtUtcIso: z.ZodString;
+    lastModifiedAtUtcIso: z.ZodString;
+    documentType: z.ZodLiteral<"bai/derivation">;
+}, z.core.$strip>;
+/** Schema for validating the state object of a Derivation document */
+export declare const DerivationPHStateSchema: z.ZodObject<{
+    global: z.ZodObject<Required<{
+        claimReferences: z.ZodType<import("./types.js").ClaimReference[], unknown, z.core.$ZodTypeInternals<import("./types.js").ClaimReference[], unknown>>;
+        coherenceResults: z.ZodType<import("./types.js").CoherenceCheck[], unknown, z.core.$ZodTypeInternals<import("./types.js").CoherenceCheck[], unknown>>;
+        derivedAt: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        dimensionRationale: z.ZodType<import("./types.js").DimensionRationale[], unknown, z.core.$ZodTypeInternals<import("./types.js").DimensionRationale[], unknown>>;
+        engineVersion: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        featureDecisions: z.ZodType<import("./types.js").FeatureDecision[], unknown, z.core.$ZodTypeInternals<import("./types.js").FeatureDecision[], unknown>>;
+        reseedHistory: z.ZodType<import("./types.js").ReseedEntry[], unknown, z.core.$ZodTypeInternals<import("./types.js").ReseedEntry[], unknown>>;
+        signals: z.ZodType<import("./types.js").DerivationSignal[], unknown, z.core.$ZodTypeInternals<import("./types.js").DerivationSignal[], unknown>>;
+    }>, z.core.$strip>;
+}, z.core.$strip>;
+export declare const DerivationDocumentSchema: z.ZodObject<{
+    header: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        createdAtUtcIso: z.ZodString;
+        lastModifiedAtUtcIso: z.ZodString;
+        documentType: z.ZodLiteral<"bai/derivation">;
+    }, z.core.$strip>;
+    state: z.ZodObject<{
+        global: z.ZodObject<Required<{
+            claimReferences: z.ZodType<import("./types.js").ClaimReference[], unknown, z.core.$ZodTypeInternals<import("./types.js").ClaimReference[], unknown>>;
+            coherenceResults: z.ZodType<import("./types.js").CoherenceCheck[], unknown, z.core.$ZodTypeInternals<import("./types.js").CoherenceCheck[], unknown>>;
+            derivedAt: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            dimensionRationale: z.ZodType<import("./types.js").DimensionRationale[], unknown, z.core.$ZodTypeInternals<import("./types.js").DimensionRationale[], unknown>>;
+            engineVersion: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            featureDecisions: z.ZodType<import("./types.js").FeatureDecision[], unknown, z.core.$ZodTypeInternals<import("./types.js").FeatureDecision[], unknown>>;
+            reseedHistory: z.ZodType<import("./types.js").ReseedEntry[], unknown, z.core.$ZodTypeInternals<import("./types.js").ReseedEntry[], unknown>>;
+            signals: z.ZodType<import("./types.js").DerivationSignal[], unknown, z.core.$ZodTypeInternals<import("./types.js").DerivationSignal[], unknown>>;
+        }>, z.core.$strip>;
+    }, z.core.$strip>;
+    initialState: z.ZodObject<{
+        global: z.ZodObject<Required<{
+            claimReferences: z.ZodType<import("./types.js").ClaimReference[], unknown, z.core.$ZodTypeInternals<import("./types.js").ClaimReference[], unknown>>;
+            coherenceResults: z.ZodType<import("./types.js").CoherenceCheck[], unknown, z.core.$ZodTypeInternals<import("./types.js").CoherenceCheck[], unknown>>;
+            derivedAt: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            dimensionRationale: z.ZodType<import("./types.js").DimensionRationale[], unknown, z.core.$ZodTypeInternals<import("./types.js").DimensionRationale[], unknown>>;
+            engineVersion: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            featureDecisions: z.ZodType<import("./types.js").FeatureDecision[], unknown, z.core.$ZodTypeInternals<import("./types.js").FeatureDecision[], unknown>>;
+            reseedHistory: z.ZodType<import("./types.js").ReseedEntry[], unknown, z.core.$ZodTypeInternals<import("./types.js").ReseedEntry[], unknown>>;
+            signals: z.ZodType<import("./types.js").DerivationSignal[], unknown, z.core.$ZodTypeInternals<import("./types.js").DerivationSignal[], unknown>>;
+        }>, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/** Simple helper function to check if a state object is a Derivation document state object */
+export declare function isDerivationState(state: unknown): state is DerivationPHState;
+/** Simple helper function to assert that a document state object is a Derivation document state object */
+export declare function assertIsDerivationState(state: unknown): asserts state is DerivationPHState;
+/** Simple helper function to check if a document is a Derivation document */
+export declare function isDerivationDocument(document: unknown): document is DerivationDocument;
+/** Simple helper function to assert that a document is a Derivation document */
+export declare function assertIsDerivationDocument(document: unknown): asserts document is DerivationDocument;
+//# sourceMappingURL=document-schema.d.ts.map

package/dist/document-models/derivation/v1/gen/document-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-schema.d.ts","sourceRoot":"","sources":["../../../../../document-models/derivation/v1/gen/document-schema.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAExE,uEAAuE;AACvE,eAAO,MAAM,8BAA8B;;;;;;iBAEzC,CAAC;AAEH,sEAAsE;AACtE,eAAO,MAAM,uBAAuB;;;;;;;;;;;iBAElC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAInC,CAAC;AAEH,8FAA8F;AAC9F,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,iBAAiB,CAE5E;AAED,0GAA0G;AAC1G,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,iBAAiB,CAEpC;AAED,6EAA6E;AAC7E,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,kBAAkB,CAEhC;AAED,gFAAgF;AAChF,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,OAAO,GAChB,OAAO,CAAC,QAAQ,IAAI,kBAAkB,CAExC"}

package/dist/document-models/derivation/v1/gen/document-schema.js

@@ -0,0 +1,33 @@
+import { BaseDocumentHeaderSchema, BaseDocumentStateSchema, } from "document-model";
+import { z } from "zod";
+import { derivationDocumentType } from "./document-type.js";
+import { DerivationStateSchema } from "./schema/zod.js";
+/** Schema for validating the header object of a Derivation document */
+export const DerivationDocumentHeaderSchema = BaseDocumentHeaderSchema.extend({
+    documentType: z.literal(derivationDocumentType),
+});
+/** Schema for validating the state object of a Derivation document */
+export const DerivationPHStateSchema = BaseDocumentStateSchema.extend({
+    global: DerivationStateSchema(),
+});
+export const DerivationDocumentSchema = z.object({
+    header: DerivationDocumentHeaderSchema,
+    state: DerivationPHStateSchema,
+    initialState: DerivationPHStateSchema,
+});
+/** Simple helper function to check if a state object is a Derivation document state object */
+export function isDerivationState(state) {
+    return DerivationPHStateSchema.safeParse(state).success;
+}
+/** Simple helper function to assert that a document state object is a Derivation document state object */
+export function assertIsDerivationState(state) {
+    DerivationPHStateSchema.parse(state);
+}
+/** Simple helper function to check if a document is a Derivation document */
+export function isDerivationDocument(document) {
+    return DerivationDocumentSchema.safeParse(document).success;
+}
+/** Simple helper function to assert that a document is a Derivation document */
+export function assertIsDerivationDocument(document) {
+    DerivationDocumentSchema.parse(document);
+}

package/dist/document-models/derivation/v1/gen/document-type.d.ts

@@ -0,0 +1,2 @@
+export declare const derivationDocumentType = "bai/derivation";
+//# sourceMappingURL=document-type.d.ts.map

package/dist/document-models/derivation/v1/gen/document-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-type.d.ts","sourceRoot":"","sources":["../../../../../document-models/derivation/v1/gen/document-type.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB,mBAAmB,CAAC"}

package/dist/document-models/derivation/v1/gen/document-type.js

@@ -0,0 +1 @@
+export const derivationDocumentType = "bai/derivation";

package/dist/document-models/derivation/v1/gen/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./actions.js";
+export * from "./document-model.js";
+export * from "./types.js";
+export * from "./creators.js";
+export { createDerivationDocument, createState, defaultPHState, defaultGlobalState, defaultLocalState, } from "./ph-factories.js";
+export * from "./utils.js";
+export * from "./reducer.js";
+export * from "./controller.js";
+export * from "./schema/index.js";
+export * from "./document-type.js";
+export * from "./document-schema.js";
+export * from "./derivation-management/operations.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/document-models/derivation/v1/gen/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../document-models/derivation/v1/gen/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,OAAO,EACL,wBAAwB,EACxB,WAAW,EACX,cAAc,EACd,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,mBAAmB,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uCAAuC,CAAC"}