@powerhousedao/service-offering 0.0.1

package/dist/document-models/subscription-instance/gen/document-model.js

@@ -0,0 +1,461 @@
+export const documentModel = {
+    author: {
+        name: "Powerhouse",
+        website: "",
+    },
+    description: "Tracks subscription instances for customers including services, usage metrics, and billing projections",
+    extension: "phsi",
+    id: "powerhouse/subscription-instance",
+    name: "Subscription Instance",
+    specifications: [
+        {
+            changeLog: [],
+            modules: [
+                {
+                    description: "Core subscription lifecycle management",
+                    id: "subscription",
+                    name: "Subscription",
+                    operations: [
+                        {
+                            description: "Initialize a new subscription with customer and offering details",
+                            errors: [],
+                            examples: [],
+                            id: "INITIALIZE_SUBSCRIPTION",
+                            name: "INITIALIZE_SUBSCRIPTION",
+                            reducer: "",
+                            schema: "input InitializeSubscriptionInput {\n    customerId: PHID\n    customerName: String\n    customerEmail: EmailAddress\n    serviceOfferingId: PHID\n    tierName: String\n    tierPricingOptionId: OID\n    resourceId: PHID\n    resourceLabel: String\n    resourceThumbnailUrl: URL\n    autoRenew: Boolean\n    createdAt: DateTime!\n}",
+                            scope: "global",
+                            template: "Initialize a new subscription with customer and offering details",
+                        },
+                        {
+                            description: "Set or update the resource document reference",
+                            errors: [],
+                            examples: [],
+                            id: "SET_RESOURCE_DOCUMENT",
+                            name: "SET_RESOURCE_DOCUMENT",
+                            reducer: "",
+                            schema: "input SetResourceDocumentInput {\n    resourceId: PHID!\n    resourceLabel: String\n    resourceThumbnailUrl: URL\n}",
+                            scope: "global",
+                            template: "Set or update the resource document reference",
+                        },
+                        {
+                            description: "Update the subscription status directly",
+                            errors: [],
+                            examples: [],
+                            id: "UPDATE_SUBSCRIPTION_STATUS",
+                            name: "UPDATE_SUBSCRIPTION_STATUS",
+                            reducer: "",
+                            schema: "input UpdateSubscriptionStatusInput {\n    status: SubscriptionStatus!\n}",
+                            scope: "global",
+                            template: "Update the subscription status directly",
+                        },
+                        {
+                            description: "Activate a pending subscription",
+                            errors: [],
+                            examples: [],
+                            id: "ACTIVATE_SUBSCRIPTION",
+                            name: "ACTIVATE_SUBSCRIPTION",
+                            reducer: "",
+                            schema: "input ActivateSubscriptionInput {\n    activatedSince: DateTime!\n}",
+                            scope: "global",
+                            template: "Activate a pending subscription",
+                        },
+                        {
+                            description: "Pause an active subscription",
+                            errors: [],
+                            examples: [],
+                            id: "PAUSE_SUBSCRIPTION",
+                            name: "PAUSE_SUBSCRIPTION",
+                            reducer: "",
+                            schema: "input PauseSubscriptionInput {\n    pausedSince: DateTime!\n}",
+                            scope: "global",
+                            template: "Pause an active subscription",
+                        },
+                        {
+                            description: "Mark subscription as expiring",
+                            errors: [],
+                            examples: [],
+                            id: "SET_EXPIRING",
+                            name: "SET_EXPIRING",
+                            reducer: "",
+                            schema: "input SetExpiringInput {\n    expiringSince: DateTime!\n}",
+                            scope: "global",
+                            template: "Mark subscription as expiring",
+                        },
+                        {
+                            description: "Cancel a subscription",
+                            errors: [],
+                            examples: [],
+                            id: "CANCEL_SUBSCRIPTION",
+                            name: "CANCEL_SUBSCRIPTION",
+                            reducer: "",
+                            schema: "input CancelSubscriptionInput {\n    cancelledSince: DateTime!\n    cancellationReason: String\n}",
+                            scope: "global",
+                            template: "Cancel a subscription",
+                        },
+                        {
+                            description: "Resume a paused subscription",
+                            errors: [],
+                            examples: [],
+                            id: "RESUME_SUBSCRIPTION",
+                            name: "RESUME_SUBSCRIPTION",
+                            reducer: "",
+                            schema: "input ResumeSubscriptionInput {\n    timestamp: DateTime!\n}",
+                            scope: "global",
+                            template: "Resume a paused subscription",
+                        },
+                        {
+                            description: "Renew an expiring subscription",
+                            errors: [],
+                            examples: [],
+                            id: "RENEW_EXPIRING_SUBSCRIPTION",
+                            name: "RENEW_EXPIRING_SUBSCRIPTION",
+                            reducer: "",
+                            schema: "input RenewExpiringSubscriptionInput {\n    timestamp: DateTime!\n    newRenewalDate: DateTime\n}",
+                            scope: "global",
+                            template: "Renew an expiring subscription",
+                        },
+                        {
+                            description: "Set the budget category for the subscription",
+                            errors: [],
+                            examples: [],
+                            id: "SET_BUDGET_CATEGORY",
+                            name: "SET_BUDGET_CATEGORY",
+                            reducer: "",
+                            schema: "input SetBudgetCategoryInput {\n    budgetId: OID!\n    budgetLabel: String!\n}",
+                            scope: "global",
+                            template: "Set the budget category for the subscription",
+                        },
+                        {
+                            description: "Remove the budget category from the subscription",
+                            errors: [],
+                            examples: [],
+                            id: "REMOVE_BUDGET_CATEGORY",
+                            name: "REMOVE_BUDGET_CATEGORY",
+                            reducer: "",
+                            schema: "input RemoveBudgetCategoryInput {\n    budgetId: OID!\n}",
+                            scope: "global",
+                            template: "Remove the budget category from the subscription",
+                        },
+                        {
+                            description: "Update customer information",
+                            errors: [],
+                            examples: [],
+                            id: "UPDATE_CUSTOMER_INFO",
+                            name: "UPDATE_CUSTOMER_INFO",
+                            reducer: "",
+                            schema: "input UpdateCustomerInfoInput {\n    customerId: PHID\n    customerName: String\n    customerEmail: EmailAddress\n}",
+                            scope: "global",
+                            template: "Update customer information",
+                        },
+                        {
+                            description: "Update tier information",
+                            errors: [],
+                            examples: [],
+                            id: "UPDATE_TIER_INFO",
+                            name: "UPDATE_TIER_INFO",
+                            reducer: "",
+                            schema: "input UpdateTierInfoInput {\n    tierName: String\n    tierPricingOptionId: OID\n}",
+                            scope: "global",
+                            template: "Update tier information",
+                        },
+                        {
+                            description: "Set operator notes for the subscription",
+                            errors: [],
+                            examples: [],
+                            id: "SET_OPERATOR_NOTES",
+                            name: "SET_OPERATOR_NOTES",
+                            reducer: "",
+                            schema: "input SetOperatorNotesInput {\n    operatorNotes: String\n}",
+                            scope: "global",
+                            template: "Set operator notes for the subscription",
+                        },
+                        {
+                            description: "Set auto-renew preference",
+                            errors: [],
+                            examples: [],
+                            id: "SET_AUTO_RENEW",
+                            name: "SET_AUTO_RENEW",
+                            reducer: "",
+                            schema: "input SetAutoRenewInput {\n    autoRenew: Boolean!\n}",
+                            scope: "global",
+                            template: "Set auto-renew preference",
+                        },
+                        {
+                            description: "Set the renewal date",
+                            errors: [],
+                            examples: [],
+                            id: "SET_RENEWAL_DATE",
+                            name: "SET_RENEWAL_DATE",
+                            reducer: "",
+                            schema: "input SetRenewalDateInput {\n    renewalDate: DateTime!\n}",
+                            scope: "global",
+                            template: "Set the renewal date",
+                        },
+                        {
+                            description: "Update billing projection fields (next billing date, projected amount)",
+                            errors: [],
+                            examples: [],
+                            id: "UPDATE_BILLING_PROJECTION",
+                            name: "UPDATE_BILLING_PROJECTION",
+                            reducer: "",
+                            schema: "input UpdateBillingProjectionInput {\n    nextBillingDate: DateTime\n    projectedBillAmount: Amount_Money\n    projectedBillCurrency: Currency\n}",
+                            scope: "global",
+                            template: "Update billing projection fields",
+                        },
+                    ],
+                },
+                {
+                    description: "Service management within subscriptions",
+                    id: "service",
+                    name: "Service",
+                    operations: [
+                        {
+                            description: "Add a new service to the subscription",
+                            errors: [],
+                            examples: [],
+                            id: "ADD_SERVICE",
+                            name: "ADD_SERVICE",
+                            reducer: "",
+                            schema: "input AddServiceInput {\n    serviceId: OID!\n    name: String\n    description: String\n    setupAmount: Amount_Money\n    setupCurrency: Currency\n    setupBillingDate: DateTime\n    setupPaymentDate: DateTime\n    recurringAmount: Amount_Money\n    recurringCurrency: Currency\n    recurringBillingCycle: BillingCycle\n    recurringNextBillingDate: DateTime\n    recurringLastPaymentDate: DateTime\n}",
+                            scope: "global",
+                            template: "Add a new service to the subscription",
+                        },
+                        {
+                            description: "Remove a service from the subscription",
+                            errors: [],
+                            examples: [],
+                            id: "REMOVE_SERVICE",
+                            name: "REMOVE_SERVICE",
+                            reducer: "",
+                            schema: "input RemoveServiceInput {\n    serviceId: OID!\n}",
+                            scope: "global",
+                            template: "Remove a service from the subscription",
+                        },
+                        {
+                            description: "Update the setup cost of a service",
+                            errors: [],
+                            examples: [],
+                            id: "UPDATE_SERVICE_SETUP_COST",
+                            name: "UPDATE_SERVICE_SETUP_COST",
+                            reducer: "",
+                            schema: "input UpdateServiceSetupCostInput {\n    serviceId: OID!\n    amount: Amount_Money\n    currency: Currency\n    billingDate: DateTime\n    paymentDate: DateTime\n}",
+                            scope: "global",
+                            template: "Update the setup cost of a service",
+                        },
+                        {
+                            description: "Update the recurring cost of a service",
+                            errors: [],
+                            examples: [],
+                            id: "UPDATE_SERVICE_RECURRING_COST",
+                            name: "UPDATE_SERVICE_RECURRING_COST",
+                            reducer: "",
+                            schema: "input UpdateServiceRecurringCostInput {\n    serviceId: OID!\n    amount: Amount_Money\n    currency: Currency\n    billingCycle: BillingCycle\n    nextBillingDate: DateTime\n    lastPaymentDate: DateTime\n}",
+                            scope: "global",
+                            template: "Update the recurring cost of a service",
+                        },
+                        {
+                            description: "Report a setup payment for a service",
+                            errors: [],
+                            examples: [],
+                            id: "REPORT_SETUP_PAYMENT",
+                            name: "REPORT_SETUP_PAYMENT",
+                            reducer: "",
+                            schema: "input ReportSetupPaymentInput {\n    serviceId: OID!\n    paymentDate: DateTime!\n}",
+                            scope: "global",
+                            template: "Report a setup payment for a service",
+                        },
+                        {
+                            description: "Report a recurring payment for a service",
+                            errors: [],
+                            examples: [],
+                            id: "REPORT_RECURRING_PAYMENT",
+                            name: "REPORT_RECURRING_PAYMENT",
+                            reducer: "",
+                            schema: "input ReportRecurringPaymentInput {\n    serviceId: OID!\n    paymentDate: DateTime!\n}",
+                            scope: "global",
+                            template: "Report a recurring payment for a service",
+                        },
+                        {
+                            description: "Update service name and description",
+                            errors: [],
+                            examples: [],
+                            id: "UPDATE_SERVICE_INFO",
+                            name: "UPDATE_SERVICE_INFO",
+                            reducer: "",
+                            schema: "input UpdateServiceInfoInput {\n    serviceId: OID!\n    name: String\n    description: String\n}",
+                            scope: "global",
+                            template: "Update service name and description",
+                        },
+                    ],
+                },
+                {
+                    description: "Service group management",
+                    id: "service-group",
+                    name: "Service Group",
+                    operations: [
+                        {
+                            description: "Add a new service group",
+                            errors: [],
+                            examples: [],
+                            id: "ADD_SERVICE_GROUP",
+                            name: "ADD_SERVICE_GROUP",
+                            reducer: "",
+                            schema: "input AddServiceGroupInput {\n    groupId: OID!\n    name: String!\n    optional: Boolean!\n}",
+                            scope: "global",
+                            template: "Add a new service group",
+                        },
+                        {
+                            description: "Remove a service group",
+                            errors: [],
+                            examples: [],
+                            id: "REMOVE_SERVICE_GROUP",
+                            name: "REMOVE_SERVICE_GROUP",
+                            reducer: "",
+                            schema: "input RemoveServiceGroupInput {\n    groupId: OID!\n}",
+                            scope: "global",
+                            template: "Remove a service group",
+                        },
+                        {
+                            description: "Add a service to a group",
+                            errors: [],
+                            examples: [],
+                            id: "ADD_SERVICE_TO_GROUP",
+                            name: "ADD_SERVICE_TO_GROUP",
+                            reducer: "",
+                            schema: "input AddServiceToGroupInput {\n    groupId: OID!\n    serviceId: OID!\n    name: String\n    description: String\n    setupAmount: Amount_Money\n    setupCurrency: Currency\n    setupBillingDate: DateTime\n    setupPaymentDate: DateTime\n    recurringAmount: Amount_Money\n    recurringCurrency: Currency\n    recurringBillingCycle: BillingCycle\n    recurringNextBillingDate: DateTime\n    recurringLastPaymentDate: DateTime\n}",
+                            scope: "global",
+                            template: "Add a service to a group",
+                        },
+                        {
+                            description: "Remove a service from a group",
+                            errors: [],
+                            examples: [],
+                            id: "REMOVE_SERVICE_FROM_GROUP",
+                            name: "REMOVE_SERVICE_FROM_GROUP",
+                            reducer: "",
+                            schema: "input RemoveServiceFromGroupInput {\n    groupId: OID!\n    serviceId: OID!\n}",
+                            scope: "global",
+                            template: "Remove a service from a group",
+                        },
+                    ],
+                },
+                {
+                    description: "Service metrics tracking",
+                    id: "metrics",
+                    name: "Metrics",
+                    operations: [
+                        {
+                            description: "Add a metric to a service",
+                            errors: [],
+                            examples: [],
+                            id: "ADD_SERVICE_METRIC",
+                            name: "ADD_SERVICE_METRIC",
+                            reducer: "",
+                            schema: "input AddServiceMetricInput {\n    serviceId: OID!\n    metricId: OID!\n    name: String!\n    unitName: String!\n    limit: Int\n    currentUsage: Int!\n    usageResetPeriod: ResetPeriod\n    nextUsageReset: DateTime\n    unitCostAmount: Amount_Money\n    unitCostCurrency: Currency\n    unitCostBillingCycle: BillingCycle\n    unitCostNextBillingDate: DateTime\n    unitCostLastPaymentDate: DateTime\n}",
+                            scope: "global",
+                            template: "Add a metric to a service",
+                        },
+                        {
+                            description: "Update metric properties",
+                            errors: [],
+                            examples: [],
+                            id: "UPDATE_METRIC",
+                            name: "UPDATE_METRIC",
+                            reducer: "",
+                            schema: "input UpdateMetricInput {\n    serviceId: OID!\n    metricId: OID!\n    name: String\n    unitName: String\n    limit: Int\n    usageResetPeriod: ResetPeriod\n    nextUsageReset: DateTime\n}",
+                            scope: "global",
+                            template: "Update metric properties",
+                        },
+                        {
+                            description: "Update current usage for a metric",
+                            errors: [],
+                            examples: [],
+                            id: "UPDATE_METRIC_USAGE",
+                            name: "UPDATE_METRIC_USAGE",
+                            reducer: "",
+                            schema: "input UpdateMetricUsageInput {\n    serviceId: OID!\n    metricId: OID!\n    currentTime: DateTime!\n    currentUsage: Int!\n}",
+                            scope: "global",
+                            template: "Update current usage for a metric",
+                        },
+                        {
+                            description: "Remove a metric from a service",
+                            errors: [],
+                            examples: [],
+                            id: "REMOVE_SERVICE_METRIC",
+                            name: "REMOVE_SERVICE_METRIC",
+                            reducer: "",
+                            schema: "input RemoveServiceMetricInput {\n    serviceId: OID!\n    metricId: OID!\n}",
+                            scope: "global",
+                            template: "Remove a metric from a service",
+                        },
+                        {
+                            description: "Increment metric usage by a specified amount",
+                            errors: [],
+                            examples: [],
+                            id: "INCREMENT_METRIC_USAGE",
+                            name: "INCREMENT_METRIC_USAGE",
+                            reducer: "",
+                            schema: "input IncrementMetricUsageInput {\n    serviceId: OID!\n    metricId: OID!\n    currentTime: DateTime!\n    incrementBy: Int!\n}",
+                            scope: "global",
+                            template: "Increment metric usage by a specified amount",
+                        },
+                        {
+                            description: "Decrement metric usage by a specified amount",
+                            errors: [],
+                            examples: [],
+                            id: "DECREMENT_METRIC_USAGE",
+                            name: "DECREMENT_METRIC_USAGE",
+                            reducer: "",
+                            schema: "input DecrementMetricUsageInput {\n    serviceId: OID!\n    metricId: OID!\n    currentTime: DateTime!\n    decrementBy: Int!\n}",
+                            scope: "global",
+                            template: "Decrement metric usage by a specified amount",
+                        },
+                    ],
+                },
+                {
+                    description: "Customer profile management",
+                    id: "customer",
+                    name: "Customer",
+                    operations: [
+                        {
+                            description: "Set customer type (individual or team)",
+                            errors: [],
+                            examples: [],
+                            id: "SET_CUSTOMER_TYPE",
+                            name: "SET_CUSTOMER_TYPE",
+                            reducer: "",
+                            schema: "input SetCustomerTypeInput {\n    customerType: CustomerType!\n    teamMemberCount: Int\n}",
+                            scope: "global",
+                            template: "Set customer type (individual or team)",
+                        },
+                        {
+                            description: "Update team member count",
+                            errors: [],
+                            examples: [],
+                            id: "UPDATE_TEAM_MEMBER_COUNT",
+                            name: "UPDATE_TEAM_MEMBER_COUNT",
+                            reducer: "",
+                            schema: "input UpdateTeamMemberCountInput {\n    teamMemberCount: Int!\n}",
+                            scope: "global",
+                            template: "Update team member count",
+                        },
+                    ],
+                },
+            ],
+            state: {
+                global: {
+                    examples: [],
+                    initialValue: '{"customerId":null,"customerName":null,"customerEmail":null,"customerType":null,"teamMemberCount":null,"operatorId":null,"serviceOfferingId":null,"tierName":null,"tierPricingOptionId":null,"resource":null,"status":"PENDING","createdAt":null,"activatedSince":null,"pausedSince":null,"expiringSince":null,"renewalDate":null,"cancelledSince":null,"cancellationReason":null,"autoRenew":false,"operatorNotes":null,"budget":null,"nextBillingDate":null,"projectedBillAmount":null,"projectedBillCurrency":null,"services":[],"serviceGroups":[]}',
+                    schema: "type SubscriptionInstanceState {\n    customerId: PHID\n    customerName: String\n    customerEmail: EmailAddress\n    customerType: CustomerType\n    teamMemberCount: Int\n    operatorId: PHID\n    serviceOfferingId: PHID\n    tierName: String\n    tierPricingOptionId: OID\n    resource: ResourceDocument\n    status: SubscriptionStatus!\n    createdAt: DateTime\n    activatedSince: DateTime\n    pausedSince: DateTime\n    expiringSince: DateTime\n    renewalDate: DateTime\n    cancelledSince: DateTime\n    cancellationReason: String\n    autoRenew: Boolean!\n    operatorNotes: String\n    budget: BudgetCategory\n    nextBillingDate: DateTime\n    projectedBillAmount: Amount_Money\n    projectedBillCurrency: Currency\n    services: [Service!]!\n    serviceGroups: [ServiceGroup!]!\n}\n\nenum CustomerType {\n    INDIVIDUAL\n    TEAM\n}\n\ntype ServiceGroup {\n    id: OID!\n    optional: Boolean!\n    name: String!\n    services: [Service!]!\n}\n\ntype ResourceDocument {\n    id: PHID!\n    label: String\n    thumbnailUrl: URL\n}\n\nenum SubscriptionStatus {\n    PENDING\n    ACTIVE\n    PAUSED\n    EXPIRING\n    CANCELLED\n}\n\ntype RecurringCost {\n    amount: Amount_Money!\n    currency: Currency!\n    billingCycle: BillingCycle!\n    nextBillingDate: DateTime\n    lastPaymentDate: DateTime\n}\n\ntype SetupCost {\n    amount: Amount_Money!\n    currency: Currency!\n    billingDate: DateTime\n    paymentDate: DateTime\n}\n\nenum BillingCycle {\n    MONTHLY\n    QUARTERLY\n    SEMI_ANNUAL\n    ANNUAL\n    ONE_TIME\n}\n\ntype BudgetCategory {\n    id: OID!\n    label: String!\n}\n\ntype Service {\n    id: OID!\n    name: String\n    description: String\n    setupCost: SetupCost\n    recurringCost: RecurringCost\n    metrics: [ServiceMetric!]!\n}\n\ntype ServiceMetric {\n    id: OID!\n    name: String!\n    unitName: String!\n    limit: Int\n    unitCost: RecurringCost\n    currentUsage: Int!\n    usageResetPeriod: ResetPeriod\n    nextUsageReset: DateTime\n}\n\nenum ResetPeriod {\n    HOURLY\n    DAILY\n    WEEKLY\n    MONTHLY\n    QUARTERLY\n    SEMI_ANNUAL\n    ANNUAL\n}",
+                },
+                local: {
+                    examples: [],
+                    initialValue: "",
+                    schema: "",
+                },
+            },
+            version: 1,
+        },
+    ],
+};

package/dist/document-models/subscription-instance/gen/document-schema.d.ts

@@ -0,0 +1,119 @@
+import { z } from "zod";
+import type { SubscriptionInstanceDocument, SubscriptionInstancePHState } from "./types.js";
+/** Schema for validating the header object of a SubscriptionInstance document */
+export declare const SubscriptionInstanceDocumentHeaderSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    createdAtUtcIso: z.ZodString;
+    lastModifiedAtUtcIso: z.ZodString;
+    documentType: z.ZodLiteral<"powerhouse/subscription-instance">;
+}, z.core.$strip>;
+/** Schema for validating the state object of a SubscriptionInstance document */
+export declare const SubscriptionInstancePHStateSchema: z.ZodObject<{
+    global: z.ZodObject<Required<{
+        activatedSince: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        autoRenew: z.ZodType<boolean, unknown, z.core.$ZodTypeInternals<boolean, unknown>>;
+        budget: z.ZodType<import("./types.js").Maybe<import("./types.js").BudgetCategory>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<import("./types.js").BudgetCategory>, unknown>>;
+        cancellationReason: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        cancelledSince: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        createdAt: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        customerEmail: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        customerId: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        customerName: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        customerType: z.ZodType<import("./types.js").Maybe<import("./types.js").CustomerType>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<import("./types.js").CustomerType>, unknown>>;
+        expiringSince: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        nextBillingDate: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        operatorId: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        operatorNotes: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        pausedSince: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        projectedBillAmount: z.ZodType<import("./types.js").Maybe<number>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<number>, unknown>>;
+        projectedBillCurrency: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        renewalDate: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        resource: z.ZodType<import("./types.js").Maybe<import("./types.js").ResourceDocument>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<import("./types.js").ResourceDocument>, unknown>>;
+        serviceGroups: z.ZodType<import("./types.js").ServiceGroup[], unknown, z.core.$ZodTypeInternals<import("./types.js").ServiceGroup[], unknown>>;
+        serviceOfferingId: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        services: z.ZodType<import("./types.js").Service[], unknown, z.core.$ZodTypeInternals<import("./types.js").Service[], unknown>>;
+        status: z.ZodType<import("./types.js").SubscriptionStatus, unknown, z.core.$ZodTypeInternals<import("./types.js").SubscriptionStatus, unknown>>;
+        teamMemberCount: z.ZodType<import("./types.js").Maybe<number>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<number>, unknown>>;
+        tierName: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        tierPricingOptionId: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+    }>, z.core.$strip>;
+}, z.core.$strip>;
+export declare const SubscriptionInstanceDocumentSchema: z.ZodObject<{
+    header: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        createdAtUtcIso: z.ZodString;
+        lastModifiedAtUtcIso: z.ZodString;
+        documentType: z.ZodLiteral<"powerhouse/subscription-instance">;
+    }, z.core.$strip>;
+    state: z.ZodObject<{
+        global: z.ZodObject<Required<{
+            activatedSince: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            autoRenew: z.ZodType<boolean, unknown, z.core.$ZodTypeInternals<boolean, unknown>>;
+            budget: z.ZodType<import("./types.js").Maybe<import("./types.js").BudgetCategory>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<import("./types.js").BudgetCategory>, unknown>>;
+            cancellationReason: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            cancelledSince: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            createdAt: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            customerEmail: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            customerId: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            customerName: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            customerType: z.ZodType<import("./types.js").Maybe<import("./types.js").CustomerType>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<import("./types.js").CustomerType>, unknown>>;
+            expiringSince: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            nextBillingDate: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            operatorId: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            operatorNotes: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            pausedSince: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            projectedBillAmount: z.ZodType<import("./types.js").Maybe<number>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<number>, unknown>>;
+            projectedBillCurrency: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            renewalDate: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            resource: z.ZodType<import("./types.js").Maybe<import("./types.js").ResourceDocument>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<import("./types.js").ResourceDocument>, unknown>>;
+            serviceGroups: z.ZodType<import("./types.js").ServiceGroup[], unknown, z.core.$ZodTypeInternals<import("./types.js").ServiceGroup[], unknown>>;
+            serviceOfferingId: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            services: z.ZodType<import("./types.js").Service[], unknown, z.core.$ZodTypeInternals<import("./types.js").Service[], unknown>>;
+            status: z.ZodType<import("./types.js").SubscriptionStatus, unknown, z.core.$ZodTypeInternals<import("./types.js").SubscriptionStatus, unknown>>;
+            teamMemberCount: z.ZodType<import("./types.js").Maybe<number>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<number>, unknown>>;
+            tierName: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            tierPricingOptionId: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        }>, z.core.$strip>;
+    }, z.core.$strip>;
+    initialState: z.ZodObject<{
+        global: z.ZodObject<Required<{
+            activatedSince: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            autoRenew: z.ZodType<boolean, unknown, z.core.$ZodTypeInternals<boolean, unknown>>;
+            budget: z.ZodType<import("./types.js").Maybe<import("./types.js").BudgetCategory>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<import("./types.js").BudgetCategory>, unknown>>;
+            cancellationReason: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            cancelledSince: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            createdAt: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            customerEmail: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            customerId: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            customerName: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            customerType: z.ZodType<import("./types.js").Maybe<import("./types.js").CustomerType>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<import("./types.js").CustomerType>, unknown>>;
+            expiringSince: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            nextBillingDate: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            operatorId: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            operatorNotes: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            pausedSince: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            projectedBillAmount: z.ZodType<import("./types.js").Maybe<number>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<number>, unknown>>;
+            projectedBillCurrency: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            renewalDate: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            resource: z.ZodType<import("./types.js").Maybe<import("./types.js").ResourceDocument>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<import("./types.js").ResourceDocument>, unknown>>;
+            serviceGroups: z.ZodType<import("./types.js").ServiceGroup[], unknown, z.core.$ZodTypeInternals<import("./types.js").ServiceGroup[], unknown>>;
+            serviceOfferingId: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            services: z.ZodType<import("./types.js").Service[], unknown, z.core.$ZodTypeInternals<import("./types.js").Service[], unknown>>;
+            status: z.ZodType<import("./types.js").SubscriptionStatus, unknown, z.core.$ZodTypeInternals<import("./types.js").SubscriptionStatus, unknown>>;
+            teamMemberCount: z.ZodType<import("./types.js").Maybe<number>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<number>, unknown>>;
+            tierName: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+            tierPricingOptionId: z.ZodType<import("./types.js").Maybe<string>, unknown, z.core.$ZodTypeInternals<import("./types.js").Maybe<string>, unknown>>;
+        }>, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/** Simple helper function to check if a state object is a SubscriptionInstance document state object */
+export declare function isSubscriptionInstanceState(state: unknown): state is SubscriptionInstancePHState;
+/** Simple helper function to assert that a document state object is a SubscriptionInstance document state object */
+export declare function assertIsSubscriptionInstanceState(state: unknown): asserts state is SubscriptionInstancePHState;
+/** Simple helper function to check if a document is a SubscriptionInstance document */
+export declare function isSubscriptionInstanceDocument(document: unknown): document is SubscriptionInstanceDocument;
+/** Simple helper function to assert that a document is a SubscriptionInstance document */
+export declare function assertIsSubscriptionInstanceDocument(document: unknown): asserts document is SubscriptionInstanceDocument;
+//# sourceMappingURL=document-schema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"document-schema.d.ts","sourceRoot":"","sources":["../../../../document-models/subscription-instance/gen/document-schema.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EACV,4BAA4B,EAC5B,2BAA2B,EAC5B,MAAM,YAAY,CAAC;AAEpB,iFAAiF;AACjF,eAAO,MAAM,wCAAwC;;;;;;iBAGjD,CAAC;AAEL,gFAAgF;AAChF,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI7C,CAAC;AAEF,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI7C,CAAC;AAEH,wGAAwG;AACxG,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,2BAA2B,CAEtC;AAED,oHAAoH;AACpH,wBAAgB,iCAAiC,CAC/C,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,2BAA2B,CAE9C;AAED,uFAAuF;AACvF,wBAAgB,8BAA8B,CAC5C,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,4BAA4B,CAE1C;AAED,0FAA0F;AAC1F,wBAAgB,oCAAoC,CAClD,QAAQ,EAAE,OAAO,GAChB,OAAO,CAAC,QAAQ,IAAI,4BAA4B,CAElD"}

package/dist/document-models/subscription-instance/gen/document-schema.js

@@ -0,0 +1,33 @@
+import { BaseDocumentHeaderSchema, BaseDocumentStateSchema, } from "document-model";
+import { z } from "zod";
+import { subscriptionInstanceDocumentType } from "./document-type.js";
+import { SubscriptionInstanceStateSchema } from "./schema/zod.js";
+/** Schema for validating the header object of a SubscriptionInstance document */
+export const SubscriptionInstanceDocumentHeaderSchema = BaseDocumentHeaderSchema.extend({
+    documentType: z.literal(subscriptionInstanceDocumentType),
+});
+/** Schema for validating the state object of a SubscriptionInstance document */
+export const SubscriptionInstancePHStateSchema = BaseDocumentStateSchema.extend({
+    global: SubscriptionInstanceStateSchema(),
+});
+export const SubscriptionInstanceDocumentSchema = z.object({
+    header: SubscriptionInstanceDocumentHeaderSchema,
+    state: SubscriptionInstancePHStateSchema,
+    initialState: SubscriptionInstancePHStateSchema,
+});
+/** Simple helper function to check if a state object is a SubscriptionInstance document state object */
+export function isSubscriptionInstanceState(state) {
+    return SubscriptionInstancePHStateSchema.safeParse(state).success;
+}
+/** Simple helper function to assert that a document state object is a SubscriptionInstance document state object */
+export function assertIsSubscriptionInstanceState(state) {
+    SubscriptionInstancePHStateSchema.parse(state);
+}
+/** Simple helper function to check if a document is a SubscriptionInstance document */
+export function isSubscriptionInstanceDocument(document) {
+    return SubscriptionInstanceDocumentSchema.safeParse(document).success;
+}
+/** Simple helper function to assert that a document is a SubscriptionInstance document */
+export function assertIsSubscriptionInstanceDocument(document) {
+    SubscriptionInstanceDocumentSchema.parse(document);
+}

package/dist/document-models/subscription-instance/gen/document-type.d.ts

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