@powerhousedao/service-offering 0.0.1

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/document-models.d.ts

@@ -0,0 +1,3 @@
+import type { DocumentModelModule } from "document-model";
+export declare const documentModels: DocumentModelModule<any>[];
+//# sourceMappingURL=document-models.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"document-models.d.ts","sourceRoot":"","sources":["../../document-models/document-models.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAQ1D,eAAO,MAAM,cAAc,EAAE,mBAAmB,CAAC,GAAG,CAAC,EAOpD,CAAC"}

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

@@ -0,0 +1,14 @@
+import { Facet } from "./facet/module.js";
+import { ResourceInstance } from "./resource-instance/module.js";
+import { ResourceTemplate } from "./resource-template/module.js";
+import { ServiceOffering } from "./service-offering/module.js";
+import { ServiceSubscription } from "./service-subscription/module.js";
+import { SubscriptionInstance } from "./subscription-instance/module.js";
+export const documentModels = [
+    Facet,
+    ResourceInstance,
+    ResourceTemplate,
+    ServiceOffering,
+    ServiceSubscription,
+    SubscriptionInstance,
+];

package/dist/document-models/facet/actions.d.ts

@@ -0,0 +1,18 @@
+/** Actions for the Facet document model */
+export declare const actions: {
+    addOption: (input: import("./index.js").AddOptionInput) => import("./index.js").AddOptionAction;
+    updateOption: (input: import("./index.js").UpdateOptionInput) => import("./index.js").UpdateOptionAction;
+    removeOption: (input: import("./index.js").RemoveOptionInput) => import("./index.js").RemoveOptionAction;
+    reorderOptions: (input: import("./index.js").ReorderOptionsInput) => import("./index.js").ReorderOptionsAction;
+    setFacetName: (input: import("./index.js").SetFacetNameInput) => import("./index.js").SetFacetNameAction;
+    setFacetDescription: (input: import("./index.js").SetFacetDescriptionInput) => import("./index.js").SetFacetDescriptionAction;
+    setName: (name: string) => import("document-model").SetNameAction;
+    undo: (skip?: 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/facet/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../document-models/facet/actions.ts"],"names":[],"mappings":"AAMA,2CAA2C;AAE3C,eAAO,MAAM,OAAO;gBAK8J,0CAAqB;mBAAoK,6CAAwB;mBAA6K,6CAAwB;qBAA+K,+CAA0B;mBAArtB,6CAAwB;0BAAqL,oDAA+B;;eAAwjN,CAAC,eAAe,CAAC;gBAAkE,CAAC,eAAe,CAAC;iBAAmE,CAAC,aAAa,CAAC,eAAe,CAAC;;;;gBAAqS,CAAC;CAD30O,CAAC"}

package/dist/document-models/facet/actions.js

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

package/dist/document-models/facet/gen/actions.d.ts

@@ -0,0 +1,6 @@
+import type { FacetFacetManagementAction } from "./facet-management/actions.js";
+import type { FacetOptionManagementAction } from "./option-management/actions.js";
+export * from "./facet-management/actions.js";
+export * from "./option-management/actions.js";
+export type FacetAction = FacetFacetManagementAction | FacetOptionManagementAction;
+//# sourceMappingURL=actions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../../document-models/facet/gen/actions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAChF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAC;AAElF,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAE/C,MAAM,MAAM,WAAW,GACnB,0BAA0B,GAC1B,2BAA2B,CAAC"}

package/dist/document-models/facet/gen/actions.js

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

package/dist/document-models/facet/gen/creators.d.ts

@@ -0,0 +1,5 @@
+export * from "./facet-management/creators.js";
+export * as facetManagementActions from "./facet-management/creators.js";
+export * from "./option-management/creators.js";
+export * as optionManagementActions from "./option-management/creators.js";
+//# sourceMappingURL=creators.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"creators.d.ts","sourceRoot":"","sources":["../../../../document-models/facet/gen/creators.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAC;AAC/C,OAAO,KAAK,sBAAsB,MAAM,gCAAgC,CAAC;AACzE,cAAc,iCAAiC,CAAC;AAChD,OAAO,KAAK,uBAAuB,MAAM,iCAAiC,CAAC"}

package/dist/document-models/facet/gen/creators.js

@@ -0,0 +1,4 @@
+export * from "./facet-management/creators.js";
+export * as facetManagementActions from "./facet-management/creators.js";
+export * from "./option-management/creators.js";
+export * as optionManagementActions from "./option-management/creators.js";

package/dist/document-models/facet/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/facet/gen/document-model.d.ts.map

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

package/dist/document-models/facet/gen/document-model.js

@@ -0,0 +1,134 @@
+export const documentModel = {
+    author: {
+        name: "Powerhouse",
+        website: "https://www.powerhouse.inc/",
+    },
+    description: "Document model for defining categorical options (facets) used to customize service offerings. Examples include SNO Function, Legal Entity Type, Team configurations, and Anonymity settings.",
+    extension: "",
+    id: "powerhouse/facet",
+    name: "Facet",
+    specifications: [
+        {
+            changeLog: [],
+            modules: [
+                {
+                    description: "Operations for managing facet metadata",
+                    id: "facet-management",
+                    name: "Facet Management",
+                    operations: [
+                        {
+                            description: "Sets the facet name",
+                            errors: [],
+                            examples: [],
+                            id: "set-facet-name",
+                            name: "SET_FACET_NAME",
+                            reducer: "state.name = action.input.name;\nstate.lastModified = action.input.lastModified;",
+                            schema: "input SetFacetNameInput {\n    name: String!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Sets the facet name",
+                        },
+                        {
+                            description: "Sets the facet description",
+                            errors: [],
+                            examples: [],
+                            id: "set-facet-description",
+                            name: "SET_FACET_DESCRIPTION",
+                            reducer: "state.description = action.input.description || null;\nstate.lastModified = action.input.lastModified;",
+                            schema: "input SetFacetDescriptionInput {\n    description: String\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Sets the facet description",
+                        },
+                    ],
+                },
+                {
+                    description: "Operations for managing facet options",
+                    id: "option-management",
+                    name: "Option Management",
+                    operations: [
+                        {
+                            description: "Adds a new option to the facet",
+                            errors: [
+                                {
+                                    code: "DUPLICATE_OPTION_ID",
+                                    description: "An option with this ID already exists",
+                                    id: "duplicate-option-id",
+                                    name: "DuplicateOptionIdError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "add-option",
+                            name: "ADD_OPTION",
+                            reducer: "state.options.push({\n    id: action.input.id,\n    label: action.input.label,\n    description: action.input.description || null,\n    displayOrder: action.input.displayOrder || null,\n    isDefault: action.input.isDefault || false\n});\nstate.lastModified = action.input.lastModified;",
+                            schema: "input AddOptionInput {\n    id: OID!\n    label: String!\n    description: String\n    displayOrder: Int\n    isDefault: Boolean\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Adds a new option to the facet",
+                        },
+                        {
+                            description: "Updates an existing option",
+                            errors: [
+                                {
+                                    code: "OPTION_NOT_FOUND",
+                                    description: "Option with the specified ID does not exist",
+                                    id: "option-not-found",
+                                    name: "OptionNotFoundError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "update-option",
+                            name: "UPDATE_OPTION",
+                            reducer: "const option = state.options.find(o => o.id === action.input.id);\nif (option) {\n    if (action.input.label) {\n        option.label = action.input.label;\n    }\n    if (action.input.description !== undefined) {\n        option.description = action.input.description || null;\n    }\n    if (action.input.displayOrder !== undefined && action.input.displayOrder !== null) {\n        option.displayOrder = action.input.displayOrder;\n    }\n    if (action.input.isDefault !== undefined && action.input.isDefault !== null) {\n        option.isDefault = action.input.isDefault;\n    }\n}\nstate.lastModified = action.input.lastModified;",
+                            schema: "input UpdateOptionInput {\n    id: OID!\n    label: String\n    description: String\n    displayOrder: Int\n    isDefault: Boolean\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Updates an existing option",
+                        },
+                        {
+                            description: "Removes an option from the facet",
+                            errors: [
+                                {
+                                    code: "REMOVE_OPTION_NOT_FOUND",
+                                    description: "Option with the specified ID does not exist",
+                                    id: "remove-option-not-found",
+                                    name: "RemoveOptionNotFoundError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "remove-option",
+                            name: "REMOVE_OPTION",
+                            reducer: "const optionIndex = state.options.findIndex(o => o.id === action.input.id);\nif (optionIndex !== -1) {\n    state.options.splice(optionIndex, 1);\n}\nstate.lastModified = action.input.lastModified;",
+                            schema: "input RemoveOptionInput {\n    id: OID!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Removes an option from the facet",
+                        },
+                        {
+                            description: "Reorders options in the facet",
+                            errors: [],
+                            examples: [],
+                            id: "reorder-options",
+                            name: "REORDER_OPTIONS",
+                            reducer: "const orderedOptions: typeof state.options = [];\naction.input.optionIds.forEach((id, index) => {\n    const option = state.options.find(o => o.id === id);\n    if (option) {\n        option.displayOrder = index;\n        orderedOptions.push(option);\n    }\n});\nstate.options.forEach(option => {\n    if (!action.input.optionIds.includes(option.id)) {\n        orderedOptions.push(option);\n    }\n});\nstate.options = orderedOptions;\nstate.lastModified = action.input.lastModified;",
+                            schema: "input ReorderOptionsInput {\n    optionIds: [OID!]!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Reorders options in the facet",
+                        },
+                    ],
+                },
+            ],
+            state: {
+                global: {
+                    examples: [],
+                    initialValue: '{\n    "id": "",\n    "name": "",\n    "description": null,\n    "lastModified": "1970-01-01T00:00:00.000Z",\n    "options": []\n}',
+                    schema: "type FacetState {\n    id: PHID!\n    name: String!\n    description: String\n    lastModified: DateTime!\n    options: [FacetOption!]!\n}\n\ntype FacetOption {\n    id: OID!\n    label: String!\n    description: String\n    displayOrder: Int\n    isDefault: Boolean!\n}",
+                },
+                local: {
+                    examples: [],
+                    initialValue: "",
+                    schema: "",
+                },
+            },
+            version: 1,
+        },
+    ],
+};

package/dist/document-models/facet/gen/document-schema.d.ts

@@ -0,0 +1,56 @@
+import { z } from "zod";
+import type { FacetDocument, FacetPHState } from "./types.js";
+/** Schema for validating the header object of a Facet document */
+export declare const FacetDocumentHeaderSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    createdAtUtcIso: z.ZodString;
+    lastModifiedAtUtcIso: z.ZodString;
+    documentType: z.ZodLiteral<"powerhouse/facet">;
+}, z.core.$strip>;
+/** Schema for validating the state object of a Facet document */
+export declare const FacetPHStateSchema: z.ZodObject<{
+    global: z.ZodObject<Required<{
+        description: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        id: z.ZodType<string, unknown, z.core.$ZodTypeInternals<string, unknown>>;
+        lastModified: z.ZodType<string, unknown, z.core.$ZodTypeInternals<string, unknown>>;
+        name: z.ZodType<string, unknown, z.core.$ZodTypeInternals<string, unknown>>;
+        options: z.ZodType<import("./types.js").FacetOption[], unknown, z.core.$ZodTypeInternals<import("./types.js").FacetOption[], unknown>>;
+    }>, z.core.$strip>;
+}, z.core.$strip>;
+export declare const FacetDocumentSchema: z.ZodObject<{
+    header: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        createdAtUtcIso: z.ZodString;
+        lastModifiedAtUtcIso: z.ZodString;
+        documentType: z.ZodLiteral<"powerhouse/facet">;
+    }, z.core.$strip>;
+    state: z.ZodObject<{
+        global: z.ZodObject<Required<{
+            description: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            id: z.ZodType<string, unknown, z.core.$ZodTypeInternals<string, unknown>>;
+            lastModified: z.ZodType<string, unknown, z.core.$ZodTypeInternals<string, unknown>>;
+            name: z.ZodType<string, unknown, z.core.$ZodTypeInternals<string, unknown>>;
+            options: z.ZodType<import("./types.js").FacetOption[], unknown, z.core.$ZodTypeInternals<import("./types.js").FacetOption[], unknown>>;
+        }>, z.core.$strip>;
+    }, z.core.$strip>;
+    initialState: z.ZodObject<{
+        global: z.ZodObject<Required<{
+            description: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            id: z.ZodType<string, unknown, z.core.$ZodTypeInternals<string, unknown>>;
+            lastModified: z.ZodType<string, unknown, z.core.$ZodTypeInternals<string, unknown>>;
+            name: z.ZodType<string, unknown, z.core.$ZodTypeInternals<string, unknown>>;
+            options: z.ZodType<import("./types.js").FacetOption[], unknown, z.core.$ZodTypeInternals<import("./types.js").FacetOption[], unknown>>;
+        }>, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/** Simple helper function to check if a state object is a Facet document state object */
+export declare function isFacetState(state: unknown): state is FacetPHState;
+/** Simple helper function to assert that a document state object is a Facet document state object */
+export declare function assertIsFacetState(state: unknown): asserts state is FacetPHState;
+/** Simple helper function to check if a document is a Facet document */
+export declare function isFacetDocument(document: unknown): document is FacetDocument;
+/** Simple helper function to assert that a document is a Facet document */
+export declare function assertIsFacetDocument(document: unknown): asserts document is FacetDocument;
+//# sourceMappingURL=document-schema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"document-schema.d.ts","sourceRoot":"","sources":["../../../../document-models/facet/gen/document-schema.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE9D,kEAAkE;AAClE,eAAO,MAAM,yBAAyB;;;;;;iBAEpC,CAAC;AAEH,iEAAiE;AACjE,eAAO,MAAM,kBAAkB;;;;;;;;iBAE7B,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI9B,CAAC;AAEH,yFAAyF;AACzF,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY,CAElE;AAED,qGAAqG;AACrG,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,YAAY,CAE/B;AAED,wEAAwE;AACxE,wBAAgB,eAAe,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,aAAa,CAE5E;AAED,2EAA2E;AAC3E,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,OAAO,GAChB,OAAO,CAAC,QAAQ,IAAI,aAAa,CAEnC"}

package/dist/document-models/facet/gen/document-schema.js

@@ -0,0 +1,33 @@
+import { BaseDocumentHeaderSchema, BaseDocumentStateSchema, } from "document-model";
+import { z } from "zod";
+import { facetDocumentType } from "./document-type.js";
+import { FacetStateSchema } from "./schema/zod.js";
+/** Schema for validating the header object of a Facet document */
+export const FacetDocumentHeaderSchema = BaseDocumentHeaderSchema.extend({
+    documentType: z.literal(facetDocumentType),
+});
+/** Schema for validating the state object of a Facet document */
+export const FacetPHStateSchema = BaseDocumentStateSchema.extend({
+    global: FacetStateSchema(),
+});
+export const FacetDocumentSchema = z.object({
+    header: FacetDocumentHeaderSchema,
+    state: FacetPHStateSchema,
+    initialState: FacetPHStateSchema,
+});
+/** Simple helper function to check if a state object is a Facet document state object */
+export function isFacetState(state) {
+    return FacetPHStateSchema.safeParse(state).success;
+}
+/** Simple helper function to assert that a document state object is a Facet document state object */
+export function assertIsFacetState(state) {
+    FacetPHStateSchema.parse(state);
+}
+/** Simple helper function to check if a document is a Facet document */
+export function isFacetDocument(document) {
+    return FacetDocumentSchema.safeParse(document).success;
+}
+/** Simple helper function to assert that a document is a Facet document */
+export function assertIsFacetDocument(document) {
+    FacetDocumentSchema.parse(document);
+}

package/dist/document-models/facet/gen/document-type.d.ts

@@ -0,0 +1,2 @@
+export declare const facetDocumentType = "powerhouse/facet";
+//# sourceMappingURL=document-type.d.ts.map

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

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

package/dist/document-models/facet/gen/document-type.js

@@ -0,0 +1 @@
+export const facetDocumentType = "powerhouse/facet";

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

@@ -0,0 +1,12 @@
+import type { Action } from "document-model";
+import type { SetFacetNameInput, SetFacetDescriptionInput } from "../types.js";
+export type SetFacetNameAction = Action & {
+    type: "SET_FACET_NAME";
+    input: SetFacetNameInput;
+};
+export type SetFacetDescriptionAction = Action & {
+    type: "SET_FACET_DESCRIPTION";
+    input: SetFacetDescriptionInput;
+};
+export type FacetFacetManagementAction = SetFacetNameAction | SetFacetDescriptionAction;
+//# sourceMappingURL=actions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../../../document-models/facet/gen/facet-management/actions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAE/E,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG;IACxC,IAAI,EAAE,gBAAgB,CAAC;IACvB,KAAK,EAAE,iBAAiB,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,yBAAyB,GAAG,MAAM,GAAG;IAC/C,IAAI,EAAE,uBAAuB,CAAC;IAC9B,KAAK,EAAE,wBAAwB,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAClC,kBAAkB,GAClB,yBAAyB,CAAC"}

package/dist/document-models/facet/gen/facet-management/actions.js

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

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

@@ -0,0 +1,5 @@
+import type { SetFacetNameInput, SetFacetDescriptionInput } from "../types.js";
+import type { SetFacetNameAction, SetFacetDescriptionAction } from "./actions.js";
+export declare const setFacetName: (input: SetFacetNameInput) => SetFacetNameAction;
+export declare const setFacetDescription: (input: SetFacetDescriptionInput) => SetFacetDescriptionAction;
+//# sourceMappingURL=creators.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"creators.d.ts","sourceRoot":"","sources":["../../../../../document-models/facet/gen/facet-management/creators.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAC/E,OAAO,KAAK,EACV,kBAAkB,EAClB,yBAAyB,EAC1B,MAAM,cAAc,CAAC;AAEtB,eAAO,MAAM,YAAY,GAAI,OAAO,iBAAiB,uBAOlD,CAAC;AAEJ,eAAO,MAAM,mBAAmB,GAAI,OAAO,wBAAwB,8BAOhE,CAAC"}

package/dist/document-models/facet/gen/facet-management/creators.js

@@ -0,0 +1,4 @@
+import { createAction } from "document-model/core";
+import { SetFacetNameInputSchema, SetFacetDescriptionInputSchema, } from "../schema/zod.js";
+export const setFacetName = (input) => createAction("SET_FACET_NAME", { ...input }, undefined, SetFacetNameInputSchema, "global");
+export const setFacetDescription = (input) => createAction("SET_FACET_DESCRIPTION", { ...input }, undefined, SetFacetDescriptionInputSchema, "global");

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

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

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

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

package/dist/document-models/facet/gen/facet-management/error.js

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

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

@@ -0,0 +1,8 @@
+import { type SignalDispatch } from "document-model";
+import type { SetFacetNameAction, SetFacetDescriptionAction } from "./actions.js";
+import type { FacetState } from "../types.js";
+export interface FacetFacetManagementOperations {
+    setFacetNameOperation: (state: FacetState, action: SetFacetNameAction, dispatch?: SignalDispatch) => void;
+    setFacetDescriptionOperation: (state: FacetState, action: SetFacetDescriptionAction, dispatch?: SignalDispatch) => void;
+}
+//# sourceMappingURL=operations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../../../../../document-models/facet/gen/facet-management/operations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EACV,kBAAkB,EAClB,yBAAyB,EAC1B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,MAAM,WAAW,8BAA8B;IAC7C,qBAAqB,EAAE,CACrB,KAAK,EAAE,UAAU,EACjB,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,CAAC,EAAE,cAAc,KACtB,IAAI,CAAC;IACV,4BAA4B,EAAE,CAC5B,KAAK,EAAE,UAAU,EACjB,MAAM,EAAE,yBAAyB,EACjC,QAAQ,CAAC,EAAE,cAAc,KACtB,IAAI,CAAC;CACX"}

package/dist/document-models/facet/gen/facet-management/operations.js

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

package/dist/document-models/facet/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 { createFacetDocument, createState, defaultPHState, defaultGlobalState, defaultLocalState, } from "./ph-factories.js";
+export * from "./utils.js";
+export * from "./reducer.js";
+export * from "./schema/index.js";
+export * from "./document-type.js";
+export * from "./document-schema.js";
+export * from "./facet-management/operations.js";
+export * from "./option-management/operations.js";
+//# sourceMappingURL=index.d.ts.map

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

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

package/dist/document-models/facet/gen/index.js

@@ -0,0 +1,12 @@
+export * from "./actions.js";
+export * from "./document-model.js";
+export * from "./types.js";
+export * from "./creators.js";
+export { createFacetDocument, createState, defaultPHState, defaultGlobalState, defaultLocalState, } from "./ph-factories.js";
+export * from "./utils.js";
+export * from "./reducer.js";
+export * from "./schema/index.js";
+export * from "./document-type.js";
+export * from "./document-schema.js";
+export * from "./facet-management/operations.js";
+export * from "./option-management/operations.js";