@powerhousedao/contributor-billing 0.1.40 → 0.1.42

package/dist/document-models/resource-template/gen/document-model.js

@@ -0,0 +1,410 @@
+export const documentModel = {
+    author: {
+        name: "Powerhouse",
+        website: "https://www.powerhouse.inc/",
+    },
+    description: "Document model for defining resource templates - the product-level configuration for service offerings. Contains core product information, target audiences, facet configurations, and service definitions that can be commercialized via Service Offerings.",
+    extension: "",
+    id: "powerhouse/resource-template",
+    name: "ResourceTemplate",
+    specifications: [
+        {
+            changeLog: [],
+            modules: [
+                {
+                    description: "Operations for managing resource template metadata",
+                    id: "template-management",
+                    name: "Template Management",
+                    operations: [
+                        {
+                            description: "Updates template title, summary, description and links",
+                            errors: [],
+                            examples: [],
+                            id: "update-template-info",
+                            name: "UPDATE_TEMPLATE_INFO",
+                            reducer: "if (action.input.title) {\n    state.title = action.input.title;\n}\nif (action.input.summary) {\n    state.summary = action.input.summary;\n}\nif (action.input.description !== undefined) {\n    state.description = action.input.description || null;\n}\nif (action.input.thumbnailUrl !== undefined) {\n    state.thumbnailUrl = action.input.thumbnailUrl || null;\n}\nif (action.input.infoLink !== undefined) {\n    state.infoLink = action.input.infoLink || null;\n}\nstate.lastModified = action.input.lastModified;",
+                            schema: "input UpdateTemplateInfoInput {\n    title: String\n    summary: String\n    description: String\n    thumbnailUrl: URL\n    infoLink: URL\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Updates template info",
+                        },
+                        {
+                            description: "Updates the template status",
+                            errors: [],
+                            examples: [],
+                            id: "update-template-status",
+                            name: "UPDATE_TEMPLATE_STATUS",
+                            reducer: "state.status = action.input.status;\nstate.lastModified = action.input.lastModified;",
+                            schema: "input UpdateTemplateStatusInput {\n    status: TemplateStatus!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Updates the template status",
+                        },
+                        {
+                            description: "Sets the operator for this template",
+                            errors: [],
+                            examples: [],
+                            id: "set-operator",
+                            name: "SET_OPERATOR",
+                            reducer: "state.operatorId = action.input.operatorId;\nstate.lastModified = action.input.lastModified;",
+                            schema: "input SetOperatorInput {\n    operatorId: PHID!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Sets the operator for this template",
+                        },
+                        {
+                            description: "Sets the template identifier",
+                            errors: [],
+                            examples: [],
+                            id: "set-template-id",
+                            name: "SET_TEMPLATE_ID",
+                            reducer: "state.id = action.input.id;\nstate.lastModified = action.input.lastModified;",
+                            schema: "input SetTemplateIdInput {\n    id: PHID!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Sets the template ID",
+                        },
+                    ],
+                },
+                {
+                    description: "Operations for managing target audiences",
+                    id: "audience-management",
+                    name: "Audience Management",
+                    operations: [
+                        {
+                            description: "Adds a target audience",
+                            errors: [
+                                {
+                                    code: "DUPLICATE_AUDIENCE_ID",
+                                    description: "An audience with this ID already exists",
+                                    id: "duplicate-audience-id",
+                                    name: "DuplicateAudienceIdError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "add-target-audience",
+                            name: "ADD_TARGET_AUDIENCE",
+                            reducer: "state.targetAudiences.push({\n    id: action.input.id,\n    label: action.input.label,\n    color: action.input.color || null\n});\nstate.lastModified = action.input.lastModified;",
+                            schema: "input AddTargetAudienceInput {\n    id: OID!\n    label: String!\n    color: String\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Adds a target audience",
+                        },
+                        {
+                            description: "Removes a target audience",
+                            errors: [
+                                {
+                                    code: "AUDIENCE_NOT_FOUND",
+                                    description: "Audience with the specified ID does not exist",
+                                    id: "audience-not-found",
+                                    name: "AudienceNotFoundError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "remove-target-audience",
+                            name: "REMOVE_TARGET_AUDIENCE",
+                            reducer: "const audienceIndex = state.targetAudiences.findIndex(a => a.id === action.input.id);\nif (audienceIndex !== -1) {\n    state.targetAudiences.splice(audienceIndex, 1);\n}\nstate.lastModified = action.input.lastModified;",
+                            schema: "input RemoveTargetAudienceInput {\n    id: OID!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Removes a target audience",
+                        },
+                    ],
+                },
+                {
+                    description: "Operations for managing facet targeting",
+                    id: "facet-targeting",
+                    name: "Facet Targeting",
+                    operations: [
+                        {
+                            description: "Sets or updates a facet target configuration",
+                            errors: [],
+                            examples: [],
+                            id: "set-facet-target",
+                            name: "SET_FACET_TARGET",
+                            reducer: "const existingIndex = state.facetTargets.findIndex(ft => ft.categoryKey === action.input.categoryKey);\nif (existingIndex !== -1) {\n    state.facetTargets[existingIndex] = {\n        id: action.input.id,\n        categoryKey: action.input.categoryKey,\n        categoryLabel: action.input.categoryLabel,\n        selectedOptions: action.input.selectedOptions\n    };\n} else {\n    state.facetTargets.push({\n        id: action.input.id,\n        categoryKey: action.input.categoryKey,\n        categoryLabel: action.input.categoryLabel,\n        selectedOptions: action.input.selectedOptions\n    });\n}\nstate.lastModified = action.input.lastModified;",
+                            schema: "input SetFacetTargetInput {\n    id: OID!\n    categoryKey: String!\n    categoryLabel: String!\n    selectedOptions: [String!]!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Sets a facet target",
+                        },
+                        {
+                            description: "Removes a facet target configuration",
+                            errors: [
+                                {
+                                    code: "FACET_TARGET_NOT_FOUND",
+                                    description: "Facet target with the specified category key does not exist",
+                                    id: "facet-target-not-found",
+                                    name: "FacetTargetNotFoundError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "remove-facet-target",
+                            name: "REMOVE_FACET_TARGET",
+                            reducer: "const facetIndex = state.facetTargets.findIndex(ft => ft.categoryKey === action.input.categoryKey);\nif (facetIndex !== -1) {\n    state.facetTargets.splice(facetIndex, 1);\n}\nstate.lastModified = action.input.lastModified;",
+                            schema: "input RemoveFacetTargetInput {\n    categoryKey: String!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Removes a facet target",
+                        },
+                        {
+                            description: "Adds an option to a facet target",
+                            errors: [
+                                {
+                                    code: "ADD_FACET_OPTION_TARGET_NOT_FOUND",
+                                    description: "Facet target with the specified category key does not exist",
+                                    id: "facet-target-not-found-add",
+                                    name: "AddFacetOptionTargetNotFoundError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "add-facet-option",
+                            name: "ADD_FACET_OPTION",
+                            reducer: "const facetTarget = state.facetTargets.find(ft => ft.categoryKey === action.input.categoryKey);\nif (facetTarget && !facetTarget.selectedOptions.includes(action.input.optionId)) {\n    facetTarget.selectedOptions.push(action.input.optionId);\n}\nstate.lastModified = action.input.lastModified;",
+                            schema: "input AddFacetOptionInput {\n    categoryKey: String!\n    optionId: String!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Adds an option to a facet target",
+                        },
+                        {
+                            description: "Removes an option from a facet target",
+                            errors: [
+                                {
+                                    code: "REMOVE_FACET_OPTION_TARGET_NOT_FOUND",
+                                    description: "Facet target with the specified category key does not exist",
+                                    id: "facet-target-not-found-remove",
+                                    name: "RemoveFacetOptionTargetNotFoundError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "remove-facet-option",
+                            name: "REMOVE_FACET_OPTION",
+                            reducer: "const facetTarget = state.facetTargets.find(ft => ft.categoryKey === action.input.categoryKey);\nif (facetTarget) {\n    const optionIndex = facetTarget.selectedOptions.indexOf(action.input.optionId);\n    if (optionIndex !== -1) {\n        facetTarget.selectedOptions.splice(optionIndex, 1);\n    }\n}\nstate.lastModified = action.input.lastModified;",
+                            schema: "input RemoveFacetOptionInput {\n    categoryKey: String!\n    optionId: String!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Removes an option from a facet target",
+                        },
+                    ],
+                },
+                {
+                    description: "Operations for managing service categories",
+                    id: "service-category-management",
+                    name: "Service Category Management",
+                    operations: [
+                        {
+                            description: "Sets the setup service category labels",
+                            errors: [],
+                            examples: [],
+                            id: "set-setup-services",
+                            name: "SET_SETUP_SERVICES",
+                            reducer: "state.setupServices = action.input.services;\nstate.lastModified = action.input.lastModified;",
+                            schema: "input SetSetupServicesInput {\n    services: [String!]!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Sets the setup services",
+                        },
+                        {
+                            description: "Sets the recurring service category labels",
+                            errors: [],
+                            examples: [],
+                            id: "set-recurring-services",
+                            name: "SET_RECURRING_SERVICES",
+                            reducer: "state.recurringServices = action.input.services;\nstate.lastModified = action.input.lastModified;",
+                            schema: "input SetRecurringServicesInput {\n    services: [String!]!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Sets the recurring services",
+                        },
+                    ],
+                },
+                {
+                    description: "Operations for managing services in the template",
+                    id: "service-management",
+                    name: "Service Management",
+                    operations: [
+                        {
+                            description: "Adds a new service to the template",
+                            errors: [
+                                {
+                                    code: "DUPLICATE_SERVICE_ID",
+                                    description: "A service with this ID already exists",
+                                    id: "duplicate-service-id",
+                                    name: "DuplicateServiceIdError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "add-service",
+                            name: "ADD_SERVICE",
+                            reducer: "state.services.push({\n    id: action.input.id,\n    title: action.input.title,\n    description: action.input.description || null,\n    parentServiceId: action.input.parentServiceId || null,\n    displayOrder: action.input.displayOrder || null,\n    isSetupFormation: action.input.isSetupFormation || false,\n    optionGroupId: action.input.optionGroupId || null,\n    facetBindings: []\n});\nstate.lastModified = action.input.lastModified;",
+                            schema: "input AddServiceInput {\n    id: OID!\n    title: String!\n    description: String\n    parentServiceId: OID\n    displayOrder: Int\n    isSetupFormation: Boolean\n    optionGroupId: OID\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Adds a new service to the template",
+                        },
+                        {
+                            description: "Updates an existing service",
+                            errors: [
+                                {
+                                    code: "UPDATE_SERVICE_NOT_FOUND",
+                                    description: "Service with the specified ID does not exist",
+                                    id: "service-not-found",
+                                    name: "UpdateServiceNotFoundError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "update-service",
+                            name: "UPDATE_SERVICE",
+                            reducer: "const service = state.services.find(s => s.id === action.input.id);\nif (service) {\n    if (action.input.title) {\n        service.title = action.input.title;\n    }\n    if (action.input.description !== undefined && action.input.description !== null) {\n        service.description = action.input.description;\n    }\n    if (action.input.parentServiceId !== undefined) {\n        service.parentServiceId = action.input.parentServiceId || null;\n    }\n    if (action.input.displayOrder !== undefined && action.input.displayOrder !== null) {\n        service.displayOrder = action.input.displayOrder;\n    }\n    if (action.input.isSetupFormation !== undefined && action.input.isSetupFormation !== null) {\n        service.isSetupFormation = action.input.isSetupFormation;\n    }\n    if (action.input.optionGroupId !== undefined) {\n        service.optionGroupId = action.input.optionGroupId || null;\n    }\n}\nstate.lastModified = action.input.lastModified;",
+                            schema: "input UpdateServiceInput {\n    id: OID!\n    title: String\n    description: String\n    parentServiceId: OID\n    displayOrder: Int\n    isSetupFormation: Boolean\n    optionGroupId: OID\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Updates an existing service",
+                        },
+                        {
+                            description: "Removes a service from the template",
+                            errors: [
+                                {
+                                    code: "DELETE_SERVICE_NOT_FOUND",
+                                    description: "Service with the specified ID does not exist",
+                                    id: "service-not-found-delete",
+                                    name: "DeleteServiceNotFoundError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "delete-service",
+                            name: "DELETE_SERVICE",
+                            reducer: "const serviceIndex = state.services.findIndex(s => s.id === action.input.id);\nif (serviceIndex !== -1) {\n    state.services.splice(serviceIndex, 1);\n}\nstate.lastModified = action.input.lastModified;",
+                            schema: "input DeleteServiceInput {\n    id: OID!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Removes a service from the template",
+                        },
+                        {
+                            description: "Adds a facet binding to a service",
+                            errors: [
+                                {
+                                    code: "ADD_FACET_SERVICE_NOT_FOUND",
+                                    description: "Service with the specified ID does not exist",
+                                    id: "service-not-found-facet",
+                                    name: "AddFacetServiceNotFoundError",
+                                    template: "",
+                                },
+                                {
+                                    code: "DUPLICATE_BINDING_ID",
+                                    description: "A facet binding with this ID already exists",
+                                    id: "duplicate-binding-id",
+                                    name: "DuplicateBindingIdError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "add-facet-binding",
+                            name: "ADD_FACET_BINDING",
+                            reducer: "const service = state.services.find(s => s.id === action.input.serviceId);\nif (service) {\n    service.facetBindings.push({\n        id: action.input.bindingId,\n        facetName: action.input.facetName,\n        facetType: action.input.facetType,\n        supportedOptions: action.input.supportedOptions\n    });\n}\nstate.lastModified = action.input.lastModified;",
+                            schema: "input AddFacetBindingInput {\n    serviceId: OID!\n    bindingId: OID!\n    facetName: String!\n    facetType: PHID!\n    supportedOptions: [OID!]!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Adds a facet binding to a service",
+                        },
+                        {
+                            description: "Removes a facet binding from a service",
+                            errors: [
+                                {
+                                    id: "service-not-found-remove-binding",
+                                    name: "RemoveFacetServiceNotFoundError",
+                                    code: "REMOVE_FACET_SERVICE_NOT_FOUND",
+                                    description: "Service with the specified ID does not exist",
+                                    template: "",
+                                },
+                                {
+                                    id: "binding-not-found",
+                                    name: "BindingNotFoundError",
+                                    code: "BINDING_NOT_FOUND",
+                                    description: "Facet binding with the specified ID does not exist",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "remove-facet-binding",
+                            name: "REMOVE_FACET_BINDING",
+                            reducer: "const service = state.services.find(s => s.id === action.input.serviceId);\nif (service) {\n    const bindingIndex = service.facetBindings.findIndex(fb => fb.id === action.input.bindingId);\n    if (bindingIndex !== -1) {\n        service.facetBindings.splice(bindingIndex, 1);\n    }\n}\nstate.lastModified = action.input.lastModified;",
+                            schema: "input RemoveFacetBindingInput {\n    serviceId: OID!\n    bindingId: OID!\n    lastModified: DateTime!\n}",
+                            scope: "global",
+                            template: "Removes a facet binding from a service",
+                        },
+                    ],
+                },
+                {
+                    description: "Operations for managing option groups",
+                    id: "option-group-management",
+                    name: "Option Group Management",
+                    operations: [
+                        {
+                            id: "add-option-group",
+                            name: "ADD_OPTION_GROUP",
+                            description: "Adds a new option group",
+                            schema: "input AddOptionGroupInput {\n    id: OID!\n    name: String!\n    description: String\n    isAddOn: Boolean!\n    defaultSelected: Boolean!\n    lastModified: DateTime!\n}",
+                            template: "Adds a new option group",
+                            reducer: "state.optionGroups.push({\n    id: action.input.id,\n    name: action.input.name,\n    description: action.input.description || null,\n    isAddOn: action.input.isAddOn,\n    defaultSelected: action.input.defaultSelected\n});\nstate.lastModified = action.input.lastModified;",
+                            errors: [
+                                {
+                                    id: "duplicate-option-group-id",
+                                    name: "DuplicateOptionGroupIdError",
+                                    code: "DUPLICATE_OPTION_GROUP_ID",
+                                    description: "An option group with this ID already exists",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            scope: "global",
+                        },
+                        {
+                            id: "update-option-group",
+                            name: "UPDATE_OPTION_GROUP",
+                            description: "Updates an existing option group",
+                            schema: "input UpdateOptionGroupInput {\n    id: OID!\n    name: String\n    description: String\n    isAddOn: Boolean\n    defaultSelected: Boolean\n    lastModified: DateTime!\n}",
+                            template: "Updates an existing option group",
+                            reducer: "const optionGroup = state.optionGroups.find(og => og.id === action.input.id);\nif (optionGroup) {\n    if (action.input.name) {\n        optionGroup.name = action.input.name;\n    }\n    if (action.input.description !== undefined) {\n        optionGroup.description = action.input.description || null;\n    }\n    if (action.input.isAddOn !== undefined && action.input.isAddOn !== null) {\n        optionGroup.isAddOn = action.input.isAddOn;\n    }\n    if (action.input.defaultSelected !== undefined && action.input.defaultSelected !== null) {\n        optionGroup.defaultSelected = action.input.defaultSelected;\n    }\n}\nstate.lastModified = action.input.lastModified;",
+                            errors: [
+                                {
+                                    id: "option-group-not-found",
+                                    name: "UpdateOptionGroupNotFoundError",
+                                    code: "UPDATE_OPTION_GROUP_NOT_FOUND",
+                                    description: "Option group with the specified ID does not exist",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            scope: "global",
+                        },
+                        {
+                            id: "delete-option-group",
+                            name: "DELETE_OPTION_GROUP",
+                            description: "Removes an option group from the template",
+                            schema: "input DeleteOptionGroupInput {\n    id: OID!\n    lastModified: DateTime!\n}",
+                            template: "Removes an option group from the template",
+                            reducer: "const optionGroupIndex = state.optionGroups.findIndex(og => og.id === action.input.id);\nif (optionGroupIndex !== -1) {\n    state.services.forEach(service => {\n        if (service.optionGroupId === action.input.id) {\n            service.optionGroupId = null;\n        }\n    });\n    state.optionGroups.splice(optionGroupIndex, 1);\n}\nstate.lastModified = action.input.lastModified;",
+                            errors: [
+                                {
+                                    id: "option-group-not-found-delete",
+                                    name: "DeleteOptionGroupNotFoundError",
+                                    code: "DELETE_OPTION_GROUP_NOT_FOUND",
+                                    description: "Option group with the specified ID does not exist",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            scope: "global",
+                        },
+                    ],
+                },
+            ],
+            state: {
+                global: {
+                    examples: [],
+                    initialValue: '"{\\n    \\"id\\": \\"\\",\\n    \\"operatorId\\": \\"\\",\\n    \\"title\\": \\"\\",\\n    \\"summary\\": \\"\\",\\n    \\"description\\": null,\\n    \\"thumbnailUrl\\": null,\\n    \\"infoLink\\": null,\\n    \\"status\\": \\"DRAFT\\",\\n    \\"lastModified\\": \\"1970-01-01T00:00:00.000Z\\",\\n    \\"targetAudiences\\": [],\\n    \\"setupServices\\": [],\\n    \\"recurringServices\\": [],\\n    \\"facetTargets\\": [],\\n    \\"services\\": [],\\n    \\"optionGroups\\": []\\n}"',
+                    schema: "type ResourceTemplateState {\n    id: PHID!\n    operatorId: PHID!\n    title: String!\n    summary: String!\n    description: String\n    thumbnailUrl: URL\n    infoLink: URL\n    status: TemplateStatus!\n    lastModified: DateTime!\n    targetAudiences: [TargetAudience!]!\n    setupServices: [String!]!\n    recurringServices: [String!]!\n    facetTargets: [FacetTarget!]!\n    services: [Service!]!\n    optionGroups: [OptionGroup!]!\n}\n\nenum TemplateStatus {\n    DRAFT\n    COMING_SOON\n    ACTIVE\n    DEPRECATED\n}\n\ntype TargetAudience {\n    id: OID!\n    label: String!\n    color: String\n}\n\ntype FacetTarget {\n    id: OID!\n    categoryKey: String!\n    categoryLabel: String!\n    selectedOptions: [String!]!\n}\n\ntype Service {\n    id: OID!\n    title: String!\n    description: String\n    displayOrder: Int\n    parentServiceId: OID\n    isSetupFormation: Boolean!\n    optionGroupId: OID\n    facetBindings: [ResourceFacetBinding!]!\n}\n\ntype ResourceFacetBinding {\n    id: OID!\n    facetName: String!\n    facetType: PHID!\n    supportedOptions: [OID!]!\n}\n\ntype OptionGroup {\n    id: OID!\n    name: String!\n    description: String\n    isAddOn: Boolean!\n    defaultSelected: Boolean!\n}",
+                },
+                local: {
+                    examples: [],
+                    initialValue: '""',
+                    schema: "",
+                },
+            },
+            version: 1,
+        },
+    ],
+};