@contractspec/example.service-business-os 1.56.1 → 1.58.0

package/dist/node/invoice/index.js

@@ -0,0 +1,77 @@
+// src/invoice/invoice.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var InvoiceModel = defineSchemaModel({
+  name: "Invoice",
+  description: "Invoice issued for a job",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jobId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    invoiceNumber: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    amount: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    dueDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    issuedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    paidAt: { type: ScalarTypeEnum.DateTime(), isOptional: true }
+  }
+});
+var IssueInvoiceInputModel = defineSchemaModel({
+  name: "IssueInvoiceInput",
+  description: "Input for issuing an invoice",
+  fields: {
+    jobId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    dueDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    notes: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    lineItems: { type: ScalarTypeEnum.JSON(), isOptional: true }
+  }
+});
+
+// src/invoice/invoice.operations.ts
+import { defineCommand } from "@contractspec/lib.contracts";
+var OWNERS = ["@examples.service-business-os"];
+var IssueInvoiceContract = defineCommand({
+  meta: {
+    key: "service.invoice.issue",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["service-business-os", "invoice", "issue"],
+    description: "Issue an invoice for a job.",
+    goal: "Bill clients.",
+    context: "Billing."
+  },
+  io: {
+    input: IssueInvoiceInputModel,
+    output: InvoiceModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "issue-invoice-happy-path",
+        given: ["Job is complete"],
+        when: ["User issues invoice"],
+        then: ["Invoice is created and sent"]
+      }
+    ],
+    examples: [
+      {
+        key: "issue-standard",
+        input: {
+          jobId: "job-123",
+          dueDate: "2025-02-01",
+          items: [{ description: "Service", amount: 100 }]
+        },
+        output: { id: "inv-456", status: "issued", total: 100 }
+      }
+    ]
+  }
+});
+export {
+  IssueInvoiceInputModel,
+  IssueInvoiceContract,
+  InvoiceModel
+};

package/dist/node/invoice/invoice.operations.js

@@ -0,0 +1,75 @@
+// src/invoice/invoice.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var InvoiceModel = defineSchemaModel({
+  name: "Invoice",
+  description: "Invoice issued for a job",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jobId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    invoiceNumber: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    amount: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    dueDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    issuedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    paidAt: { type: ScalarTypeEnum.DateTime(), isOptional: true }
+  }
+});
+var IssueInvoiceInputModel = defineSchemaModel({
+  name: "IssueInvoiceInput",
+  description: "Input for issuing an invoice",
+  fields: {
+    jobId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    dueDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    notes: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    lineItems: { type: ScalarTypeEnum.JSON(), isOptional: true }
+  }
+});
+
+// src/invoice/invoice.operations.ts
+import { defineCommand } from "@contractspec/lib.contracts";
+var OWNERS = ["@examples.service-business-os"];
+var IssueInvoiceContract = defineCommand({
+  meta: {
+    key: "service.invoice.issue",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["service-business-os", "invoice", "issue"],
+    description: "Issue an invoice for a job.",
+    goal: "Bill clients.",
+    context: "Billing."
+  },
+  io: {
+    input: IssueInvoiceInputModel,
+    output: InvoiceModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "issue-invoice-happy-path",
+        given: ["Job is complete"],
+        when: ["User issues invoice"],
+        then: ["Invoice is created and sent"]
+      }
+    ],
+    examples: [
+      {
+        key: "issue-standard",
+        input: {
+          jobId: "job-123",
+          dueDate: "2025-02-01",
+          items: [{ description: "Service", amount: 100 }]
+        },
+        output: { id: "inv-456", status: "issued", total: 100 }
+      }
+    ]
+  }
+});
+export {
+  IssueInvoiceContract
+};

package/dist/node/invoice/invoice.schema.js

@@ -0,0 +1,34 @@
+// src/invoice/invoice.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var InvoiceModel = defineSchemaModel({
+  name: "Invoice",
+  description: "Invoice issued for a job",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jobId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    invoiceNumber: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    amount: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    dueDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    issuedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    paidAt: { type: ScalarTypeEnum.DateTime(), isOptional: true }
+  }
+});
+var IssueInvoiceInputModel = defineSchemaModel({
+  name: "IssueInvoiceInput",
+  description: "Input for issuing an invoice",
+  fields: {
+    jobId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    dueDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    notes: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    lineItems: { type: ScalarTypeEnum.JSON(), isOptional: true }
+  }
+});
+export {
+  IssueInvoiceInputModel,
+  InvoiceModel
+};

package/dist/node/job/index.js

@@ -0,0 +1,175 @@
+// src/job/job.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var JobModel = defineSchemaModel({
+  name: "Job",
+  description: "Scheduled job",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    quoteId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    clientId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    scheduledAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    assignedTo: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var ScheduleJobInputModel = defineSchemaModel({
+  name: "ScheduleJobInput",
+  description: "Input for scheduling a job",
+  fields: {
+    quoteId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    scheduledAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    assignedTo: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    location: { type: ScalarTypeEnum.JSON(), isOptional: true },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var CompleteJobInputModel = defineSchemaModel({
+  name: "CompleteJobInput",
+  description: "Input for completing a job",
+  fields: {
+    jobId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    notes: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+
+// src/job/job.operations.ts
+import { defineCommand, defineQuery } from "@contractspec/lib.contracts";
+import { defineSchemaModel as defineSchemaModel2, ScalarTypeEnum as ScalarTypeEnum2 } from "@contractspec/lib.schema";
+var OWNERS = ["@examples.service-business-os"];
+var ListJobsInputModel = defineSchemaModel2({
+  name: "ListJobsInput",
+  description: "Input for listing jobs",
+  fields: {
+    status: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true },
+    clientId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true },
+    limit: { type: ScalarTypeEnum2.Int_unsecure(), isOptional: true },
+    offset: { type: ScalarTypeEnum2.Int_unsecure(), isOptional: true }
+  }
+});
+var ListJobsOutputModel = defineSchemaModel2({
+  name: "ListJobsOutput",
+  description: "Output for listing jobs",
+  fields: {
+    jobs: { type: JobModel, isOptional: false, isList: true },
+    total: { type: ScalarTypeEnum2.Int_unsecure(), isOptional: false }
+  }
+});
+var ListJobsOperation = defineQuery({
+  meta: {
+    key: "service.job.list",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["service-business-os", "job", "list", "query"],
+    description: "List all jobs with filtering",
+    goal: "Retrieve list of jobs",
+    context: "Job management"
+  },
+  io: {
+    input: ListJobsInputModel,
+    output: ListJobsOutputModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "list-jobs-happy-path",
+        given: ["Jobs exist"],
+        when: ["User lists jobs"],
+        then: ["List of jobs is returned"]
+      }
+    ],
+    examples: [
+      {
+        key: "list-active",
+        input: { status: "scheduled", limit: 10 },
+        output: { jobs: [], total: 5 }
+      }
+    ]
+  }
+});
+var ScheduleJobContract = defineCommand({
+  meta: {
+    key: "service.job.schedule",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["service-business-os", "job", "schedule"],
+    description: "Schedule a job.",
+    goal: "Schedule work.",
+    context: "Job scheduling."
+  },
+  io: {
+    input: ScheduleJobInputModel,
+    output: JobModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "schedule-job-happy-path",
+        given: ["Client exists"],
+        when: ["User schedules job"],
+        then: ["Job is created with status SCHEDULED"]
+      }
+    ],
+    examples: [
+      {
+        key: "schedule-repair",
+        input: {
+          clientId: "client-123",
+          date: "2025-01-20T10:00:00Z",
+          type: "repair"
+        },
+        output: { id: "job-456", status: "scheduled" }
+      }
+    ]
+  }
+});
+var CompleteJobContract = defineCommand({
+  meta: {
+    key: "service.job.complete",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["service-business-os", "job", "complete"],
+    description: "Mark a job as complete.",
+    goal: "Record job completion.",
+    context: "Job management."
+  },
+  io: {
+    input: CompleteJobInputModel,
+    output: JobModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "complete-job-happy-path",
+        given: ["Job is scheduled"],
+        when: ["User completes job"],
+        then: ["Job status becomes COMPLETED"]
+      }
+    ],
+    examples: [
+      {
+        key: "mark-complete",
+        input: { jobId: "job-456", notes: "Done successfully" },
+        output: { id: "job-456", status: "completed" }
+      }
+    ]
+  }
+});
+export {
+  ScheduleJobInputModel,
+  ScheduleJobContract,
+  ListJobsOutputModel,
+  ListJobsOperation,
+  ListJobsInputModel,
+  JobModel,
+  CompleteJobInputModel,
+  CompleteJobContract
+};

package/dist/node/job/job.operations.js

@@ -0,0 +1,172 @@
+// src/job/job.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var JobModel = defineSchemaModel({
+  name: "Job",
+  description: "Scheduled job",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    quoteId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    clientId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    scheduledAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    assignedTo: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var ScheduleJobInputModel = defineSchemaModel({
+  name: "ScheduleJobInput",
+  description: "Input for scheduling a job",
+  fields: {
+    quoteId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    scheduledAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    assignedTo: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    location: { type: ScalarTypeEnum.JSON(), isOptional: true },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var CompleteJobInputModel = defineSchemaModel({
+  name: "CompleteJobInput",
+  description: "Input for completing a job",
+  fields: {
+    jobId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    notes: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+
+// src/job/job.operations.ts
+import { defineCommand, defineQuery } from "@contractspec/lib.contracts";
+import { defineSchemaModel as defineSchemaModel2, ScalarTypeEnum as ScalarTypeEnum2 } from "@contractspec/lib.schema";
+var OWNERS = ["@examples.service-business-os"];
+var ListJobsInputModel = defineSchemaModel2({
+  name: "ListJobsInput",
+  description: "Input for listing jobs",
+  fields: {
+    status: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true },
+    clientId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true },
+    limit: { type: ScalarTypeEnum2.Int_unsecure(), isOptional: true },
+    offset: { type: ScalarTypeEnum2.Int_unsecure(), isOptional: true }
+  }
+});
+var ListJobsOutputModel = defineSchemaModel2({
+  name: "ListJobsOutput",
+  description: "Output for listing jobs",
+  fields: {
+    jobs: { type: JobModel, isOptional: false, isList: true },
+    total: { type: ScalarTypeEnum2.Int_unsecure(), isOptional: false }
+  }
+});
+var ListJobsOperation = defineQuery({
+  meta: {
+    key: "service.job.list",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["service-business-os", "job", "list", "query"],
+    description: "List all jobs with filtering",
+    goal: "Retrieve list of jobs",
+    context: "Job management"
+  },
+  io: {
+    input: ListJobsInputModel,
+    output: ListJobsOutputModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "list-jobs-happy-path",
+        given: ["Jobs exist"],
+        when: ["User lists jobs"],
+        then: ["List of jobs is returned"]
+      }
+    ],
+    examples: [
+      {
+        key: "list-active",
+        input: { status: "scheduled", limit: 10 },
+        output: { jobs: [], total: 5 }
+      }
+    ]
+  }
+});
+var ScheduleJobContract = defineCommand({
+  meta: {
+    key: "service.job.schedule",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["service-business-os", "job", "schedule"],
+    description: "Schedule a job.",
+    goal: "Schedule work.",
+    context: "Job scheduling."
+  },
+  io: {
+    input: ScheduleJobInputModel,
+    output: JobModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "schedule-job-happy-path",
+        given: ["Client exists"],
+        when: ["User schedules job"],
+        then: ["Job is created with status SCHEDULED"]
+      }
+    ],
+    examples: [
+      {
+        key: "schedule-repair",
+        input: {
+          clientId: "client-123",
+          date: "2025-01-20T10:00:00Z",
+          type: "repair"
+        },
+        output: { id: "job-456", status: "scheduled" }
+      }
+    ]
+  }
+});
+var CompleteJobContract = defineCommand({
+  meta: {
+    key: "service.job.complete",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["service-business-os", "job", "complete"],
+    description: "Mark a job as complete.",
+    goal: "Record job completion.",
+    context: "Job management."
+  },
+  io: {
+    input: CompleteJobInputModel,
+    output: JobModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "complete-job-happy-path",
+        given: ["Job is scheduled"],
+        when: ["User completes job"],
+        then: ["Job status becomes COMPLETED"]
+      }
+    ],
+    examples: [
+      {
+        key: "mark-complete",
+        input: { jobId: "job-456", notes: "Done successfully" },
+        output: { id: "job-456", status: "completed" }
+      }
+    ]
+  }
+});
+export {
+  ScheduleJobContract,
+  ListJobsOutputModel,
+  ListJobsOperation,
+  ListJobsInputModel,
+  CompleteJobContract
+};

package/dist/node/job/job.schema.js

@@ -0,0 +1,41 @@
+// src/job/job.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var JobModel = defineSchemaModel({
+  name: "Job",
+  description: "Scheduled job",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    quoteId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    clientId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    scheduledAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    assignedTo: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var ScheduleJobInputModel = defineSchemaModel({
+  name: "ScheduleJobInput",
+  description: "Input for scheduling a job",
+  fields: {
+    quoteId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    scheduledAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    assignedTo: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    location: { type: ScalarTypeEnum.JSON(), isOptional: true },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var CompleteJobInputModel = defineSchemaModel({
+  name: "CompleteJobInput",
+  description: "Input for completing a job",
+  fields: {
+    jobId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    notes: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+export {
+  ScheduleJobInputModel,
+  JobModel,
+  CompleteJobInputModel
+};