document-model 4.1.0-dev.1 → 4.1.0-dev.100

package/dist/src/document-model/{gen/document-model.js → constants.js}

@@ -1,4 +1,36 @@
-export const documentModelState = {
+export const documentModelFileExtension = "phdm";
+export const documentModelDocumentType = "powerhouse/document-model";
+export const documentModelInitialLocalState = {};
+export const documentModelInitialGlobalState = {
+    id: "",
+    name: "",
+    extension: "",
+    description: "",
+    author: {
+        name: "",
+        website: "",
+    },
+    specifications: [
+        {
+            version: 1,
+            changeLog: [],
+            state: {
+                global: {
+                    schema: "",
+                    initialValue: "",
+                    examples: [],
+                },
+                local: {
+                    schema: "",
+                    initialValue: "",
+                    examples: [],
+                },
+            },
+            modules: [],
+        },
+    ],
+};
+export const documentModelGlobalState = {
     id: "powerhouse/document-model",
     name: "DocumentModel",
     extension: "phdm",
@@ -11,15 +43,27 @@ export const documentModelState = {
         {
             version: 1,
             changeLog: [],
+            state: {
+                global: {
+                    schema: "type CodeExample {\n    id: ID!\n    value: String!\n}\n\ntype OperationError {\n    id: ID!\n    code: String\n    name: String\n    description: String\n    template: String\n}\n\ntype Operation {\n    id: ID!\n    name: String\n    schema: String\n    description: String\n    template: String\n    errors: [OperationError!]!\n    examples: [CodeExample!]!\n    reducer: String\n    scope: String\n}\n\ntype Module {\n    id: ID!\n    name: String!\n    description: String\n    operations: [Operation!]!\n}\n\ntype State {\n    schema: String!\n    initialValue: String!\n    examples: [CodeExample!]!\n}\n\ntype ScopeState {\n    global: State!\n    local: State!\n}\n\ntype Author {\n    name: String!\n    website: String\n}\n\ntype DocumentSpecification {\n    version: Int!\n    state: ScopeState!\n    modules: [Module!]!\n    changeLog: [String!]!\n}\n\ntype DocumentModelGlobalState {\n    name: String!\n    id: String!\n    extension: String!\n    description: String!\n    author: Author!\n    specifications: [DocumentSpecification!]!\n}",
+                    initialValue: '{\n    "id": "",\n    "name": "",\n    "extension": "",\n    "description": "",\n    "author": {\n        "name": "",\n        "website": ""\n    },\n    "specifications": [\n        {\n            "version": 1,\n            "changeLog": [],\n            "state": {\n                "schema": "",\n                "initialValue": "",\n                "examples": []\n            },\n            "modules": []\n        }\n    ]\n}',
+                    examples: [],
+                },
+                local: {
+                    schema: "",
+                    initialValue: "",
+                    examples: [],
+                },
+            },
             modules: [
                 {
                     name: "header",
                     operations: [
                         {
-                            name: "SetModelName",
+                            name: "SET_MODEL_NAME",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the name of the document model",
+                            schema: "input SetModelNameInput {\n    name: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -27,10 +71,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetModelId",
+                            name: "SET_MODEL_ID",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the unique identifier for the document model",
+                            schema: "input SetModelIdInput {\n    id: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -38,10 +82,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetModelExtension",
+                            name: "SET_MODEL_EXTENSION",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the file extension associated with this document model",
+                            schema: "input SetModelExtensionInput {\n    extension: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -49,10 +93,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetModelDescription",
+                            name: "SET_MODEL_DESCRIPTION",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the description text for the document model",
+                            schema: "input SetModelDescriptionInput {\n    description: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -60,10 +104,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetAuthorName",
+                            name: "SET_AUTHOR_NAME",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the name of the document model author",
+                            schema: "input SetAuthorNameInput {\n    authorName: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -71,10 +115,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetAuthorWebsite",
+                            name: "SET_AUTHOR_WEBSITE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the website URL of the document model author",
+                            schema: "input SetAuthorWebsiteInput {\n    authorWebsite: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -89,10 +133,10 @@ export const documentModelState = {
                     name: "versioning",
                     operations: [
                         {
-                            name: "AddChangeLogItem",
+                            name: "ADD_CHANGE_LOG_ITEM",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Adds a new item to the document model changelog",
+                            schema: "input AddChangeLogItemInput {\n    id: ID!\n    insertBefore: ID\n    content: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -100,10 +144,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "UpdateChangeLogItem",
+                            name: "UPDATE_CHANGE_LOG_ITEM",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Updates an existing changelog item",
+                            schema: "input UpdateChangeLogItemInput {\n    id: ID!\n    newContent: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -111,10 +155,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "DeleteChangeLogItem",
+                            name: "DELETE_CHANGE_LOG_ITEM",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Removes an item from the document model changelog",
+                            schema: "input DeleteChangeLogItemInput {\n    id: ID!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -122,10 +166,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "ReorderChangeLogItems",
+                            name: "REORDER_CHANGE_LOG_ITEMS",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Changes the order of changelog items",
+                            schema: "input ReorderChangeLogItemsInput {\n    order: [ID!]!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -133,10 +177,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "ReleaseNewVersion",
+                            name: "RELEASE_NEW_VERSION",
                             schema: null,
                             id: "",
-                            description: "",
+                            description: "Creates a new version of the document model specification",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -151,10 +195,10 @@ export const documentModelState = {
                     name: "module",
                     operations: [
                         {
-                            name: "AddModule",
+                            name: "ADD_MODULE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Adds a new module to the document model specification",
+                            schema: "input AddModuleInput {\n    id: ID!\n    name: String!\n    description: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -162,10 +206,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetModuleName",
+                            name: "SET_MODULE_NAME",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the name of an existing module",
+                            schema: "input SetModuleNameInput {\n    id: ID!\n    name: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -173,10 +217,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetModuleDescription",
+                            name: "SET_MODULE_DESCRIPTION",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the description of an existing module",
+                            schema: "input SetModuleDescriptionInput {\n    id: ID!\n    description: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -184,10 +228,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "DeleteModule",
+                            name: "DELETE_MODULE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Removes a module from the document model specification",
+                            schema: "input DeleteModuleInput {\n    id: ID!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -195,10 +239,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "ReorderModules",
+                            name: "REORDER_MODULES",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Changes the order of modules in the document model specification",
+                            schema: "input ReorderModulesInput {\n    order: [ID!]!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -213,10 +257,10 @@ export const documentModelState = {
                     name: "operation-error",
                     operations: [
                         {
-                            name: "AddOperationError",
+                            name: "ADD_OPERATION_ERROR",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Adds a new error definition to an operation",
+                            schema: "input AddOperationErrorInput {\n    operationId: ID!\n    id: ID!\n    errorCode: String\n    errorName: String\n    errorDescription: String\n    errorTemplate: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -224,10 +268,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetOperationErrorCode",
+                            name: "SET_OPERATION_ERROR_CODE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the error code for an operation error",
+                            schema: "input SetOperationErrorCodeInput {\n    id: ID!\n    errorCode: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -235,10 +279,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetOperationErrorName",
+                            name: "SET_OPERATION_ERROR_NAME",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the name of an operation error",
+                            schema: "input SetOperationErrorNameInput {\n    id: ID!\n    errorName: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -246,10 +290,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetOperationErrorDescription",
+                            name: "SET_OPERATION_ERROR_DESCRIPTION",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the description of an operation error",
+                            schema: "input SetOperationErrorDescriptionInput {\n    id: ID!\n    errorDescription: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -257,10 +301,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetOperationErrorTemplate",
+                            name: "SET_OPERATION_ERROR_TEMPLATE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the template for an operation error",
+                            schema: "input SetOperationErrorTemplateInput {\n    id: ID!\n    errorTemplate: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -268,10 +312,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "DeleteOperationError",
+                            name: "DELETE_OPERATION_ERROR",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Removes an error definition from an operation",
+                            schema: "input DeleteOperationErrorInput {\n    id: ID!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -279,10 +323,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "ReorderOperationErrors",
+                            name: "REORDER_OPERATION_ERRORS",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Changes the order of error definitions for an operation",
+                            schema: "input ReorderOperationErrorsInput {\n    operationId: ID!\n    order: [ID!]!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -297,10 +341,10 @@ export const documentModelState = {
                     name: "operation-example",
                     operations: [
                         {
-                            name: "AddOperationExample",
+                            name: "ADD_OPERATION_EXAMPLE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Adds a new code example to an operation",
+                            schema: "input AddOperationExampleInput {\n    operationId: ID!\n    id: ID!\n    example: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -308,10 +352,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "UpdateOperationExample",
+                            name: "UPDATE_OPERATION_EXAMPLE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Updates an existing code example for an operation",
+                            schema: "input UpdateOperationExampleInput {\n    id: ID!\n    example: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -319,10 +363,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "DeleteOperationExample",
+                            name: "DELETE_OPERATION_EXAMPLE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Removes a code example from an operation",
+                            schema: "input DeleteOperationExampleInput {\n    id: ID!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -330,10 +374,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "ReorderOperationExamples",
+                            name: "REORDER_OPERATION_EXAMPLES",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Changes the order of code examples for an operation",
+                            schema: "input ReorderOperationExamplesInput {\n    operationId: ID!\n    order: [ID!]!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -348,10 +392,10 @@ export const documentModelState = {
                     name: "operation",
                     operations: [
                         {
-                            name: "AddOperation",
+                            name: "ADD_OPERATION",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Adds a new operation to a module",
+                            schema: "input AddOperationInput {\n    moduleId: ID!\n    id: ID!\n    name: String!\n    schema: String\n    description: String\n    template: String\n    reducer: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -359,10 +403,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetOperationName",
+                            name: "SET_OPERATION_NAME",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the name of an operation",
+                            schema: "input SetOperationNameInput {\n    id: ID!\n    name: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -370,10 +414,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetOperationSchema",
+                            name: "SET_OPERATION_SCHEMA",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the GraphQL schema definition for an operation's input",
+                            schema: "input SetOperationSchemaInput {\n    id: ID!\n    schema: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -381,10 +425,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetOperationDescription",
+                            name: "SET_OPERATION_DESCRIPTION",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the description of an operation",
+                            schema: "input SetOperationDescriptionInput {\n    id: ID!\n    description: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -392,10 +436,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetOperationTemplate",
+                            name: "SET_OPERATION_TEMPLATE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the template code for an operation",
+                            schema: "input SetOperationTemplateInput {\n    id: ID!\n    template: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -403,10 +447,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetOperationReducer",
+                            name: "SET_OPERATION_REDUCER",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the reducer function code for an operation",
+                            schema: "input SetOperationReducerInput {\n    id: ID!\n    reducer: String\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -414,10 +458,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "MoveOperation",
+                            name: "MOVE_OPERATION",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Moves an operation from one module to another",
+                            schema: "input MoveOperationInput {\n    operationId: ID!\n    newModuleId: ID!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -425,10 +469,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "DeleteOperation",
+                            name: "DELETE_OPERATION",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Removes an operation from a module",
+                            schema: "input DeleteOperationInput {\n    id: ID!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -436,10 +480,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "ReorderModuleOperations",
+                            name: "REORDER_MODULE_OPERATIONS",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Changes the order of operations within a module",
+                            schema: "input ReorderModuleOperationsInput {\n    moduleId: ID!\n    order: [ID!]!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -454,10 +498,10 @@ export const documentModelState = {
                     name: "state",
                     operations: [
                         {
-                            name: "SetStateSchema",
+                            name: "SET_STATE_SCHEMA",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the GraphQL schema definition for document state",
+                            schema: "input SetStateSchemaInput {\n    scope: String!\n    schema: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -465,10 +509,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "SetInitialState",
+                            name: "SET_INITIAL_STATE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Sets the initial state value for a document scope",
+                            schema: "input SetInitialStateInput {\n    scope: String!\n    initialValue: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -476,10 +520,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "AddStateExample",
+                            name: "ADD_STATE_EXAMPLE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Adds a new state example to a document scope",
+                            schema: "input AddStateExampleInput {\n    scope: String!\n    id: ID!\n    insertBefore: ID\n    example: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -487,10 +531,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "UpdateStateExample",
+                            name: "UPDATE_STATE_EXAMPLE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Updates an existing state example for a document scope",
+                            schema: "input UpdateStateExampleInput {\n    scope: String!\n    id: ID!\n    newExample: String!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -498,10 +542,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "DeleteStateExample",
+                            name: "DELETE_STATE_EXAMPLE",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Removes a state example from a document scope",
+                            schema: "input DeleteStateExampleInput {\n    scope: String!\n    id: ID!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -509,10 +553,10 @@ export const documentModelState = {
                             scope: "global",
                         },
                         {
-                            name: "ReorderStateExamples",
+                            name: "REORDER_STATE_EXAMPLES",
                             id: "",
-                            description: "",
-                            schema: "",
+                            description: "Changes the order of state examples for a document scope",
+                            schema: "input ReorderStateExamplesInput {\n    scope: String!\n    order: [ID!]!\n}",
                             template: "",
                             reducer: "",
                             examples: [],
@@ -524,19 +568,7 @@ export const documentModelState = {
                     description: "",
                 },
             ],
-            state: {
-                global: {
-                    schema: "",
-                    initialValue: '{\n    "id": "",\n    "name": "",\n    "extension": "",\n    "description": "",\n    "author": {\n        "name": "",\n        "website": ""\n    },\n    "specifications": [\n        {\n            "version": 1,\n            "changeLog": [],\n            "state": {\n                "schema": "",\n                "initialValue": "",\n                "examples": []\n            },\n            "modules": []\n        }\n    ]\n}',
-                    examples: [],
-                },
-                local: {
-                    schema: "",
-                    initialValue: `{}`,
-                    examples: [],
-                },
-            },
         },
     ],
 };
-//# sourceMappingURL=document-model.js.map
+//# sourceMappingURL=constants.js.map