@powerhousedao/network-admin 0.0.64 → 1.0.0-dev.2

package/dist/document-models/payment-terms/gen/document-model.js

@@ -4,207 +4,298 @@ export const documentModel = {
         website: "https://www.powerhouse.inc/",
     },
     description: "Document model for managing payment terms, milestones, and contract clauses",
-    extension: "",
+    extension: "pterms",
     id: "payment-terms",
-    name: "PaymentTerms",
+    name: "Payment Terms",
     specifications: [
         {
             changeLog: [],
             modules: [
                 {
-                    description: "",
-                    id: "fb44dffb-4070-4942-961b-e53bc5b7bc26",
+                    description: "Core payment terms operations",
+                    id: "terms-module",
                     name: "terms",
                     operations: [
                         {
-                            description: "",
+                            description: "Set the basic payment terms information",
                             errors: [],
                             examples: [],
-                            id: "4cc5dda2-76d1-42c7-85ac-9bbe9a3fc76b",
+                            id: "set-basic-terms-op",
                             name: "SET_BASIC_TERMS",
-                            reducer: "",
+                            reducer: "state.proposer = action.input.proposer;\nstate.payer = action.input.payer;\nstate.currency = action.input.currency;\nstate.paymentModel = action.input.paymentModel;\nstate.totalAmount = action.input.totalAmount || null;",
                             schema: "input SetBasicTermsInput {\n  proposer: String!\n  payer: String!\n  currency: PaymentCurrency!\n  paymentModel: PaymentModel!\n  totalAmount: Amount\n}",
                             scope: "global",
-                            template: "",
+                            template: "Set the basic payment terms information",
                         },
                         {
-                            description: "",
+                            description: "Update the payment terms status",
                             errors: [],
                             examples: [],
-                            id: "586040d3-8134-49c3-8e76-f72643ae2039",
+                            id: "update-status-op",
                             name: "UPDATE_STATUS",
-                            reducer: "",
+                            reducer: "state.status = action.input.status;",
                             schema: "input UpdateStatusInput {\n  status: PaymentTermsStatus!\n}",
                             scope: "global",
-                            template: "",
+                            template: "Update the payment terms status",
                         },
                         {
-                            description: "",
+                            description: "Configure cost and materials payment terms",
                             errors: [],
                             examples: [],
-                            id: "8ff785c1-9c56-4c77-9061-39fa8dc2e195",
-                            name: "SET_TIME_AND_MATERIALS",
-                            reducer: "",
-                            schema: "input SetTimeAndMaterialsInput {\n  retainerAmount: Amount\n  hourlyRate: Amount\n  variableCap: Amount\n  billingFrequency: BillingFrequency!\n  timesheetRequired: Boolean!\n}",
+                            id: "set-time-materials-op",
+                            name: "SET_COST_AND_MATERIALS",
+                            reducer: "state.costAndMaterials = {\n  hourlyRate: action.input.hourlyRate || null,\n  variableCap: action.input.variableCap || null,\n  billingFrequency: action.input.billingFrequency,\n  timesheetRequired: action.input.timesheetRequired\n};",
+                            schema: "input SetCostAndMaterialsInput {\n  hourlyRate: Amount\n  variableCap: Amount\n  billingFrequency: BillingFrequency!\n  timesheetRequired: Boolean!\n}",
                             scope: "global",
-                            template: "",
+                            template: "Configure time and materials payment terms",
                         },
                         {
-                            description: "",
+                            description: "Configure escrow payment details",
                             errors: [],
                             examples: [],
-                            id: "5e0d4393-c915-4118-b7de-01031c0e0162",
+                            id: "set-escrow-op",
                             name: "SET_ESCROW_DETAILS",
-                            reducer: "",
+                            reducer: "state.escrowDetails = {\n  amountHeld: action.input.amountHeld,\n  proofOfFundsDocumentId: action.input.proofOfFundsDocumentId || null,\n  releaseConditions: action.input.releaseConditions,\n  escrowProvider: action.input.escrowProvider || null\n};",
                             schema: "input SetEscrowDetailsInput {\n  amountHeld: Amount!\n  proofOfFundsDocumentId: String\n  releaseConditions: String!\n  escrowProvider: String\n}",
                             scope: "global",
-                            template: "",
+                            template: "Configure escrow payment details",
                         },
                         {
-                            description: "",
+                            description: "Set evaluation terms for the payment",
                             errors: [],
                             examples: [],
-                            id: "f0fa82ec-403f-4826-b1ac-4112d2a5bbb5",
+                            id: "set-evaluation-op",
                             name: "SET_EVALUATION_TERMS",
-                            reducer: "",
+                            reducer: "state.evaluation = {\n  evaluationFrequency: action.input.evaluationFrequency,\n  evaluatorTeam: action.input.evaluatorTeam,\n  criteria: action.input.criteria,\n  impactsPayout: action.input.impactsPayout,\n  impactsReputation: action.input.impactsReputation,\n  commentsVisibleToClient: action.input.commentsVisibleToClient\n};",
                             schema: "input SetEvaluationTermsInput {\n  evaluationFrequency: EvaluationFrequency!\n  evaluatorTeam: String!\n  criteria: [String!]!\n  impactsPayout: Boolean!\n  impactsReputation: Boolean!\n  commentsVisibleToClient: Boolean!\n}",
                             scope: "global",
-                            template: "",
+                            template: "Set evaluation terms for the payment",
+                        },
+                        {
+                            description: "Configure retainer payment terms",
+                            errors: [],
+                            examples: [],
+                            id: "set-retainer-op",
+                            name: "SET_RETAINER_DETAILS",
+                            reducer: "state.retainerDetails = {\n  retainerAmount: action.input.retainerAmount,\n  billingFrequency: action.input.billingFrequency,\n  startDate: action.input.startDate,\n  endDate: action.input.endDate || null,\n  autoRenew: action.input.autoRenew,\n  servicesIncluded: action.input.servicesIncluded\n};",
+                            schema: "input SetRetainerDetailsInput {\n  retainerAmount: Amount!\n  billingFrequency: BillingFrequency!\n  startDate: Date!\n  endDate: Date\n  autoRenew: Boolean!\n  servicesIncluded: String!\n}",
+                            scope: "global",
+                            template: "Configure retainer payment terms",
                         },
                     ],
                 },
                 {
-                    description: "",
-                    id: "ca5173fd-fbd1-4bad-8239-3462a0372919",
+                    description: "Milestone management operations",
+                    id: "milestones-module",
                     name: "milestones",
                     operations: [
                         {
-                            description: "",
-                            errors: [],
+                            description: "Add a new milestone to the payment schedule",
+                            errors: [
+                                {
+                                    code: "DUPLICATE_MILESTONE_ID",
+                                    description: "A milestone with this ID already exists",
+                                    id: "duplicate-milestone-id",
+                                    name: "DuplicateMilestoneIdError",
+                                    template: "",
+                                },
+                            ],
                             examples: [],
-                            id: "b13b2f0e-c280-4e6a-8688-30773e03d6ef",
+                            id: "add-milestone-op",
                             name: "ADD_MILESTONE",
-                            reducer: "",
+                            reducer: 'const existingIndex = state.milestoneSchedule.findIndex(m => m.id === action.input.id);\nif (existingIndex !== -1) {\n  throw new DuplicateMilestoneIdError(`Milestone with ID ${action.input.id} already exists`);\n}\n\nconst newMilestone = {\n  id: action.input.id,\n  name: action.input.name,\n  amount: action.input.amount,\n  expectedCompletionDate: action.input.expectedCompletionDate || null,\n  requiresApproval: action.input.requiresApproval,\n  payoutStatus: "PENDING" as "PENDING"\n};\n\nstate.milestoneSchedule.push(newMilestone);',
                             schema: "input AddMilestoneInput {\n  id: OID!\n  name: String!\n  amount: Amount!\n  expectedCompletionDate: Date\n  requiresApproval: Boolean!\n}",
                             scope: "global",
-                            template: "",
+                            template: "Add a new milestone to the payment schedule",
                         },
                         {
-                            description: "",
-                            errors: [],
+                            description: "Update milestone details",
+                            errors: [
+                                {
+                                    code: "MILESTONE_NOT_FOUND",
+                                    description: "Milestone with the specified ID was not found",
+                                    id: "milestone-not-found-update",
+                                    name: "MilestoneNotFoundError",
+                                    template: "",
+                                },
+                            ],
                             examples: [],
-                            id: "5117e76d-3e7d-416c-a4e1-0d68756102d1",
+                            id: "update-milestone-op",
                             name: "UPDATE_MILESTONE",
-                            reducer: "",
+                            reducer: "const milestoneIndex = state.milestoneSchedule.findIndex(m => m.id === action.input.id);\nif (milestoneIndex === -1) {\n  throw new MilestoneNotFoundError(`Milestone with ID ${action.input.id} not found`);\n}\n\nconst milestone = state.milestoneSchedule[milestoneIndex];\nif (action.input.name) milestone.name = action.input.name;\nif (action.input.amount) milestone.amount = action.input.amount;\nif (action.input.expectedCompletionDate !== undefined) milestone.expectedCompletionDate = action.input.expectedCompletionDate || null;\nif (action.input.requiresApproval !== undefined && action.input.requiresApproval !== null) milestone.requiresApproval = action.input.requiresApproval;",
                             schema: "input UpdateMilestoneInput {\n  id: OID!\n  name: String\n  amount: Amount\n  expectedCompletionDate: Date\n  requiresApproval: Boolean\n}",
                             scope: "global",
-                            template: "",
+                            template: "Update milestone details",
                         },
                         {
-                            description: "",
-                            errors: [],
+                            description: "Update milestone payout status",
+                            errors: [
+                                {
+                                    code: "MILESTONE_NOT_FOUND",
+                                    description: "Milestone with the specified ID was not found",
+                                    id: "milestone-not-found-status",
+                                    name: "MilestoneNotFoundError",
+                                    template: "",
+                                },
+                            ],
                             examples: [],
-                            id: "332e3d52-4346-45dc-b483-952fe80a0743",
+                            id: "update-milestone-status-op",
                             name: "UPDATE_MILESTONE_STATUS",
-                            reducer: "",
+                            reducer: "const milestoneIndex = state.milestoneSchedule.findIndex(m => m.id === action.input.id);\nif (milestoneIndex === -1) {\n  throw new MilestoneNotFoundError(`Milestone with ID ${action.input.id} not found`);\n}\n\nstate.milestoneSchedule[milestoneIndex].payoutStatus = action.input.payoutStatus;",
                             schema: "input UpdateMilestoneStatusInput {\n  id: OID!\n  payoutStatus: MilestonePayoutStatus!\n}",
                             scope: "global",
-                            template: "",
+                            template: "Update milestone payout status",
                         },
                         {
-                            description: "",
-                            errors: [],
+                            description: "Remove a milestone from the schedule",
+                            errors: [
+                                {
+                                    code: "MILESTONE_NOT_FOUND",
+                                    description: "Milestone with the specified ID was not found",
+                                    id: "milestone-not-found-delete",
+                                    name: "MilestoneNotFoundError",
+                                    template: "",
+                                },
+                            ],
                             examples: [],
-                            id: "9e2d2d2d-4bee-4d1c-8342-1145f7e14151",
+                            id: "delete-milestone-op",
                             name: "DELETE_MILESTONE",
-                            reducer: "",
+                            reducer: "const milestoneIndex = state.milestoneSchedule.findIndex(m => m.id === action.input.id);\nif (milestoneIndex === -1) {\n  throw new MilestoneNotFoundError(`Milestone with ID ${action.input.id} not found`);\n}\n\nstate.milestoneSchedule.splice(milestoneIndex, 1);",
                             schema: "input DeleteMilestoneInput {\n  id: OID!\n}",
                             scope: "global",
-                            template: "",
+                            template: "Remove a milestone from the schedule",
                         },
                         {
-                            description: "",
+                            description: "Reorder milestones in the schedule",
                             errors: [],
                             examples: [],
-                            id: "ebc7354f-8161-45f7-9fe2-0618f1def099",
+                            id: "reorder-milestones-op",
                             name: "REORDER_MILESTONES",
-                            reducer: "",
+                            reducer: "const reorderedMilestones = [];\nfor (const id of action.input.order) {\n  const milestone = state.milestoneSchedule.find(m => m.id === id);\n  if (milestone) {\n    reorderedMilestones.push(milestone);\n  }\n}\nstate.milestoneSchedule = reorderedMilestones;",
                             schema: "input ReorderMilestonesInput {\n  order: [OID!]!\n}",
                             scope: "global",
-                            template: "",
+                            template: "Reorder milestones in the schedule",
                         },
                     ],
                 },
                 {
-                    description: "",
-                    id: "ea920162-b245-42a3-92d6-f5bd6e0cad0b",
+                    description: "Bonus and penalty clause operations",
+                    id: "clauses-module",
                     name: "clauses",
                     operations: [
                         {
-                            description: "",
-                            errors: [],
+                            description: "Add a new bonus clause",
+                            errors: [
+                                {
+                                    code: "DUPLICATE_BONUS_CLAUSE_ID",
+                                    description: "A bonus clause with this ID already exists",
+                                    id: "duplicate-bonus-clause-id",
+                                    name: "DuplicateBonusClauseIdError",
+                                    template: "",
+                                },
+                            ],
                             examples: [],
-                            id: "c56eecc6-018f-4ca2-8813-9ec368295c0f",
+                            id: "add-bonus-clause-op",
                             name: "ADD_BONUS_CLAUSE",
-                            reducer: "",
+                            reducer: "const existingIndex = state.bonusClauses.findIndex(c => c.id === action.input.id);\nif (existingIndex !== -1) {\n  throw new DuplicateBonusClauseIdError(`Bonus clause with ID ${action.input.id} already exists`);\n}\n\nconst newClause = {\n  id: action.input.id,\n  condition: action.input.condition,\n  bonusAmount: action.input.bonusAmount,\n  comment: action.input.comment || null\n};\n\nstate.bonusClauses.push(newClause);",
                             schema: "input AddBonusClauseInput {\n  id: OID!\n  condition: String!\n  bonusAmount: Amount!\n  comment: String\n}",
                             scope: "global",
-                            template: "",
+                            template: "Add a new bonus clause",
                         },
                         {
-                            description: "",
-                            errors: [],
+                            description: "Update bonus clause details",
+                            errors: [
+                                {
+                                    code: "BONUS_CLAUSE_NOT_FOUND",
+                                    description: "Bonus clause with the specified ID was not found",
+                                    id: "bonus-clause-not-found",
+                                    name: "BonusClauseNotFoundError",
+                                    template: "",
+                                },
+                            ],
                             examples: [],
-                            id: "1c1ebfd9-3da5-45ed-9f8a-10ec5c297730",
+                            id: "update-bonus-clause-op",
                             name: "UPDATE_BONUS_CLAUSE",
-                            reducer: "",
+                            reducer: "const clauseIndex = state.bonusClauses.findIndex(c => c.id === action.input.id);\nif (clauseIndex === -1) {\n  throw new BonusClauseNotFoundError(`Bonus clause with ID ${action.input.id} not found`);\n}\n\nconst clause = state.bonusClauses[clauseIndex];\nif (action.input.condition) clause.condition = action.input.condition;\nif (action.input.bonusAmount) clause.bonusAmount = action.input.bonusAmount;\nif (action.input.comment !== undefined) clause.comment = action.input.comment || null;",
                             schema: "input UpdateBonusClauseInput {\n  id: OID!\n  condition: String\n  bonusAmount: Amount\n  comment: String\n}",
                             scope: "global",
-                            template: "",
+                            template: "Update bonus clause details",
                         },
                         {
-                            description: "",
-                            errors: [],
+                            description: "Remove a bonus clause",
+                            errors: [
+                                {
+                                    code: "BONUS_CLAUSE_NOT_FOUND",
+                                    description: "Bonus clause with the specified ID was not found",
+                                    id: "bonus-clause-not-found-delete",
+                                    name: "BonusClauseNotFoundError",
+                                    template: "",
+                                },
+                            ],
                             examples: [],
-                            id: "b9d8c798-902d-49e8-a15b-f3e1f554b7a5",
+                            id: "delete-bonus-clause-op",
                             name: "DELETE_BONUS_CLAUSE",
-                            reducer: "",
+                            reducer: "const clauseIndex = state.bonusClauses.findIndex(c => c.id === action.input.id);\nif (clauseIndex === -1) {\n  throw new BonusClauseNotFoundError(`Bonus clause with ID ${action.input.id} not found`);\n}\n\nstate.bonusClauses.splice(clauseIndex, 1);",
                             schema: "input DeleteBonusClauseInput {\n  id: OID!\n}",
                             scope: "global",
-                            template: "",
+                            template: "Remove a bonus clause",
                         },
                         {
-                            description: "",
-                            errors: [],
+                            description: "Add a new penalty clause",
+                            errors: [
+                                {
+                                    code: "DUPLICATE_PENALTY_CLAUSE_ID",
+                                    description: "A penalty clause with this ID already exists",
+                                    id: "duplicate-penalty-clause-id",
+                                    name: "DuplicatePenaltyClauseIdError",
+                                    template: "",
+                                },
+                            ],
                             examples: [],
-                            id: "19987691-0257-4f3a-b7f3-0a328a449159",
+                            id: "add-penalty-clause-op",
                             name: "ADD_PENALTY_CLAUSE",
-                            reducer: "",
+                            reducer: "const existingIndex = state.penaltyClauses.findIndex(c => c.id === action.input.id);\nif (existingIndex !== -1) {\n  throw new DuplicatePenaltyClauseIdError(`Penalty clause with ID ${action.input.id} already exists`);\n}\n\nconst newClause = {\n  id: action.input.id,\n  condition: action.input.condition,\n  deductionAmount: action.input.deductionAmount,\n  comment: action.input.comment || null\n};\n\nstate.penaltyClauses.push(newClause);",
                             schema: "input AddPenaltyClauseInput {\n  id: OID!\n  condition: String!\n  deductionAmount: Amount!\n  comment: String\n}",
                             scope: "global",
-                            template: "",
+                            template: "Add a new penalty clause",
                         },
                         {
-                            id: "5d913b40-c532-4299-a8de-510e3042f20b",
+                            description: "Update penalty clause details",
+                            errors: [
+                                {
+                                    code: "PENALTY_CLAUSE_NOT_FOUND",
+                                    description: "Penalty clause with the specified ID was not found",
+                                    id: "penalty-clause-not-found",
+                                    name: "PenaltyClauseNotFoundError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "update-penalty-clause-op",
                             name: "UPDATE_PENALTY_CLAUSE",
-                            description: "",
+                            reducer: "const clauseIndex = state.penaltyClauses.findIndex(c => c.id === action.input.id);\nif (clauseIndex === -1) {\n  throw new PenaltyClauseNotFoundError(`Penalty clause with ID ${action.input.id} not found`);\n}\n\nconst clause = state.penaltyClauses[clauseIndex];\nif (action.input.condition) clause.condition = action.input.condition;\nif (action.input.deductionAmount) clause.deductionAmount = action.input.deductionAmount;\nif (action.input.comment !== undefined) clause.comment = action.input.comment || null;",
                             schema: "input UpdatePenaltyClauseInput {\n  id: OID!\n  condition: String\n  deductionAmount: Amount\n  comment: String\n}",
-                            template: "",
-                            reducer: "",
-                            errors: [],
-                            examples: [],
                             scope: "global",
+                            template: "Update penalty clause details",
                         },
                         {
-                            id: "878a78ab-1b00-479a-ba56-6de431a102d1",
+                            description: "Remove a penalty clause",
+                            errors: [
+                                {
+                                    code: "PENALTY_CLAUSE_NOT_FOUND",
+                                    description: "Penalty clause with the specified ID was not found",
+                                    id: "penalty-clause-not-found-delete",
+                                    name: "PenaltyClauseNotFoundError",
+                                    template: "",
+                                },
+                            ],
+                            examples: [],
+                            id: "delete-penalty-clause-op",
                             name: "DELETE_PENALTY_CLAUSE",
-                            description: "",
+                            reducer: "const clauseIndex = state.penaltyClauses.findIndex(c => c.id === action.input.id);\nif (clauseIndex === -1) {\n  throw new PenaltyClauseNotFoundError(`Penalty clause with ID ${action.input.id} not found`);\n}\n\nstate.penaltyClauses.splice(clauseIndex, 1);",
                             schema: "input DeletePenaltyClauseInput {\n  id: OID!\n}",
-                            template: "",
-                            reducer: "",
-                            errors: [],
-                            examples: [],
                             scope: "global",
+                            template: "Remove a penalty clause",
                         },
                     ],
                 },
@@ -212,12 +303,12 @@ export const documentModel = {
             state: {
                 global: {
                     examples: [],
-                    initialValue: '{\n  "status": "DRAFT",\n  "proposer": "",\n  "payer": "",\n  "currency": "USD",\n  "paymentModel": "MILESTONE",\n  "totalAmount": null,\n  "milestoneSchedule": [],\n  "timeAndMaterials": null,\n  "escrowDetails": null,\n  "evaluation": null,\n  "bonusClauses": [],\n  "penaltyClauses": []\n}',
-                    schema: "type PaymentTermsState {\n  status: PaymentTermsStatus!\n  proposer: String!\n  payer: String!\n  currency: PaymentCurrency!\n  paymentModel: PaymentModel!\n  totalAmount: Amount\n  milestoneSchedule: [Milestone!]!\n  timeAndMaterials: TimeAndMaterials\n  escrowDetails: Escrow\n  evaluation: EvaluationTerms\n  bonusClauses: [BonusClause!]!\n  penaltyClauses: [PenaltyClause!]!\n}\n\nenum PaymentTermsStatus {\n  DRAFT\n  SUBMITTED\n  ACCEPTED\n  CANCELLED\n}\n\nenum PaymentCurrency {\n  USD\n  EUR\n  GBP\n}\n\nenum PaymentModel {\n  MILESTONE\n  TIME_AND_MATERIALS\n}\n\nenum MilestonePayoutStatus {\n  PENDING\n  READY_FOR_REVIEW\n  APPROVED\n  PAID\n  REJECTED\n}\n\nenum BillingFrequency {\n  WEEKLY\n  BIWEEKLY\n  MONTHLY\n}\n\nenum EvaluationFrequency {\n  WEEKLY\n  MONTHLY\n  PER_MILESTONE\n}\n\ntype Milestone {\n  id: OID!\n  name: String!\n  amount: Amount!\n  expectedCompletionDate: Date\n  requiresApproval: Boolean!\n  payoutStatus: MilestonePayoutStatus!\n}\n\ntype TimeAndMaterials {\n  retainerAmount: Amount\n  hourlyRate: Amount\n  variableCap: Amount\n  billingFrequency: BillingFrequency!\n  timesheetRequired: Boolean!\n}\n\ntype Escrow {\n  amountHeld: Amount!\n  proofOfFundsDocumentId: String\n  releaseConditions: String!\n  escrowProvider: String\n}\n\ntype EvaluationTerms {\n  evaluationFrequency: EvaluationFrequency!\n  evaluatorTeam: String!\n  criteria: [String!]!\n  impactsPayout: Boolean!\n  impactsReputation: Boolean!\n  commentsVisibleToClient: Boolean!\n}\n\ntype BonusClause {\n  id: OID!\n  condition: String!\n  bonusAmount: Amount!\n  comment: String\n}\n\ntype PenaltyClause {\n  id: OID!\n  condition: String!\n  deductionAmount: Amount!\n  comment: String\n}",
+                    initialValue: '{\n  "status": "DRAFT",\n  "proposer": "",\n  "payer": "",\n  "currency": "USD",\n  "paymentModel": "MILESTONE",\n  "totalAmount": null,\n  "milestoneSchedule": [],\n  "costAndMaterials": null,\n  "retainerDetails": null,\n  "escrowDetails": null,\n  "evaluation": null,\n  "bonusClauses": [],\n  "penaltyClauses": []\n}',
+                    schema: "enum PaymentTermsStatus {\n  DRAFT\n  SUBMITTED\n  ACCEPTED\n  CANCELLED\n}\n\nenum PaymentCurrency {\n  USD\n  EUR\n  GBP\n}\n\nenum PaymentModel {\n  MILESTONE\n  COST_AND_MATERIALS\n  RETAINER\n}\n\nenum MilestonePayoutStatus {\n  PENDING\n  READY_FOR_REVIEW\n  APPROVED\n  PAID\n  REJECTED\n}\n\nenum BillingFrequency {\n  WEEKLY\n  BIWEEKLY\n  MONTHLY\n}\n\nenum EvaluationFrequency {\n  WEEKLY\n  MONTHLY\n  PER_MILESTONE\n}\n\ntype Milestone {\n  id: OID!\n  name: String!\n  amount: Amount!\n  expectedCompletionDate: Date\n  requiresApproval: Boolean!\n  payoutStatus: MilestonePayoutStatus!\n}\n\ntype CostAndMaterials {\n  hourlyRate: Amount\n  variableCap: Amount\n  billingFrequency: BillingFrequency!\n  timesheetRequired: Boolean!\n}\n\ntype Retainer {\n  retainerAmount: Amount!\n  billingFrequency: BillingFrequency!\n  startDate: Date!\n  endDate: Date\n  autoRenew: Boolean!\n  servicesIncluded: String!\n}\n\ntype Escrow {\n  amountHeld: Amount!\n  proofOfFundsDocumentId: String\n  releaseConditions: String!\n  escrowProvider: String\n}\n\ntype EvaluationTerms {\n  evaluationFrequency: EvaluationFrequency!\n  evaluatorTeam: String!\n  criteria: [String!]!\n  impactsPayout: Boolean!\n  impactsReputation: Boolean!\n  commentsVisibleToClient: Boolean!\n}\n\ntype BonusClause {\n  id: OID!\n  condition: String!\n  bonusAmount: Amount!\n  comment: String\n}\n\ntype PenaltyClause {\n  id: OID!\n  condition: String!\n  deductionAmount: Amount!\n  comment: String\n}\n\ntype PaymentTermsState {\n  status: PaymentTermsStatus!\n  proposer: String!\n  payer: String!\n  currency: PaymentCurrency!\n  paymentModel: PaymentModel!\n  totalAmount: Amount\n  milestoneSchedule: [Milestone!]!\n  costAndMaterials: CostAndMaterials\n  retainerDetails: Retainer\n  escrowDetails: Escrow\n  evaluation: EvaluationTerms\n  bonusClauses: [BonusClause!]!\n  penaltyClauses: [PenaltyClause!]!\n}",
                 },
                 local: {
                     examples: [],
-                    initialValue: "",
+                    initialValue: "{}",
                     schema: "",
                 },
             },

package/dist/document-models/payment-terms/gen/milestones/error.d.ts

@@ -1,2 +1,27 @@
-export declare const errors: {};
+export type ErrorCode = "DuplicateMilestoneIdError" | "MilestoneNotFoundError";
+export interface ReducerError {
+    errorCode: ErrorCode;
+}
+export declare class DuplicateMilestoneIdError extends Error implements ReducerError {
+    errorCode: ErrorCode;
+    constructor(message?: string);
+}
+export declare class MilestoneNotFoundError extends Error implements ReducerError {
+    errorCode: ErrorCode;
+    constructor(message?: string);
+}
+export declare const errors: {
+    AddMilestone: {
+        DuplicateMilestoneIdError: typeof DuplicateMilestoneIdError;
+    };
+    UpdateMilestone: {
+        MilestoneNotFoundError: typeof MilestoneNotFoundError;
+    };
+    UpdateMilestoneStatus: {
+        MilestoneNotFoundError: typeof MilestoneNotFoundError;
+    };
+    DeleteMilestone: {
+        MilestoneNotFoundError: typeof MilestoneNotFoundError;
+    };
+};
 //# sourceMappingURL=error.d.ts.map

package/dist/document-models/payment-terms/gen/milestones/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../../../document-models/payment-terms/gen/milestones/error.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM,IAAK,CAAC"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../../../document-models/payment-terms/gen/milestones/error.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,2BAA2B,GAAG,wBAAwB,CAAC;AAE/E,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,qBAAa,yBAA0B,SAAQ,KAAM,YAAW,YAAY;IAC1E,SAAS,EAAkC,SAAS,CAAC;gBACzC,OAAO,SAA8B;CAGlD;AAED,qBAAa,sBAAuB,SAAQ,KAAM,YAAW,YAAY;IACvE,SAAS,EAA+B,SAAS,CAAC;gBACtC,OAAO,SAA2B;CAG/C;AAED,eAAO,MAAM,MAAM;;;;;;;;;;;;;CAKlB,CAAC"}

package/dist/document-models/payment-terms/gen/milestones/error.js

@@ -1 +1,18 @@
-export const errors = {};
+export class DuplicateMilestoneIdError extends Error {
+    errorCode = "DuplicateMilestoneIdError";
+    constructor(message = "DuplicateMilestoneIdError") {
+        super(message);
+    }
+}
+export class MilestoneNotFoundError extends Error {
+    errorCode = "MilestoneNotFoundError";
+    constructor(message = "MilestoneNotFoundError") {
+        super(message);
+    }
+}
+export const errors = {
+    AddMilestone: { DuplicateMilestoneIdError },
+    UpdateMilestone: { MilestoneNotFoundError },
+    UpdateMilestoneStatus: { MilestoneNotFoundError },
+    DeleteMilestone: { MilestoneNotFoundError },
+};

package/dist/document-models/payment-terms/gen/ph-factories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ph-factories.d.ts","sourceRoot":"","sources":["../../../../document-models/payment-terms/gen/ph-factories.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAEhF,OAAO,KAAK,EACV,oBAAoB,EACpB,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACpB,MAAM,YAAY,CAAC;AAGpB,wBAAgB,kBAAkB,IAAI,uBAAuB,CAe5D;AAED,wBAAgB,iBAAiB,IAAI,sBAAsB,CAE1D;AAED,wBAAgB,cAAc,IAAI,mBAAmB,CAMpD;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,GACvC,uBAAuB,CAKzB;AAED,wBAAgB,gBAAgB,CAC9B,KAAK,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GACtC,sBAAsB,CAKxB;AAED,wBAAgB,WAAW,CACzB,SAAS,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,EAChC,WAAW,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,EAC9C,UAAU,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAC3C,mBAAmB,CAMrB;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,CAAC,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IACpC,MAAM,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAC1C,KAAK,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;CACzC,CAAC,GACD,oBAAoB,CAYtB"}
+{"version":3,"file":"ph-factories.d.ts","sourceRoot":"","sources":["../../../../document-models/payment-terms/gen/ph-factories.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAEhF,OAAO,KAAK,EACV,oBAAoB,EACpB,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACpB,MAAM,YAAY,CAAC;AAGpB,wBAAgB,kBAAkB,IAAI,uBAAuB,CAgB5D;AAED,wBAAgB,iBAAiB,IAAI,sBAAsB,CAE1D;AAED,wBAAgB,cAAc,IAAI,mBAAmB,CAMpD;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,GACvC,uBAAuB,CAKzB;AAED,wBAAgB,gBAAgB,CAC9B,KAAK,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GACtC,sBAAsB,CAKxB;AAED,wBAAgB,WAAW,CACzB,SAAS,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,EAChC,WAAW,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,EAC9C,UAAU,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAC3C,mBAAmB,CAMrB;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,CAAC,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IACpC,MAAM,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAC1C,KAAK,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;CACzC,CAAC,GACD,oBAAoB,CAYtB"}

package/dist/document-models/payment-terms/gen/ph-factories.js

@@ -9,7 +9,8 @@ export function defaultGlobalState() {
         paymentModel: "MILESTONE",
         totalAmount: null,
         milestoneSchedule: [],
-        timeAndMaterials: null,
+        costAndMaterials: null,
+        retainerDetails: null,
         escrowDetails: null,
         evaluation: null,
         bonusClauses: [],

package/dist/document-models/payment-terms/gen/reducer.d.ts

@@ -1,3 +1,2 @@
-import type { PaymentTermsPHState } from "@powerhousedao/network-admin/document-models/payment-terms";
 export declare const reducer: import("document-model").Reducer<PaymentTermsPHState>;
 //# sourceMappingURL=reducer.d.ts.map

package/dist/document-models/payment-terms/gen/reducer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reducer.d.ts","sourceRoot":"","sources":["../../../../document-models/payment-terms/gen/reducer.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4DAA4D,CAAC;AAuOtG,eAAO,MAAM,OAAO,uDAAmD,CAAC"}
+{"version":3,"file":"reducer.d.ts","sourceRoot":"","sources":["../../../../document-models/payment-terms/gen/reducer.ts"],"names":[],"mappings":"AAyPA,eAAO,MAAM,OAAO,uDAAmD,CAAC"}

package/dist/document-models/payment-terms/gen/reducer.js

@@ -2,7 +2,7 @@ import { isDocumentAction, createReducer } from "document-model/core";
 import { paymentTermsTermsOperations } from "../src/reducers/terms.js";
 import { paymentTermsMilestonesOperations } from "../src/reducers/milestones.js";
 import { paymentTermsClausesOperations } from "../src/reducers/clauses.js";
-import { SetBasicTermsInputSchema, UpdateStatusInputSchema, SetTimeAndMaterialsInputSchema, SetEscrowDetailsInputSchema, SetEvaluationTermsInputSchema, AddMilestoneInputSchema, UpdateMilestoneInputSchema, UpdateMilestoneStatusInputSchema, DeleteMilestoneInputSchema, ReorderMilestonesInputSchema, AddBonusClauseInputSchema, UpdateBonusClauseInputSchema, DeleteBonusClauseInputSchema, AddPenaltyClauseInputSchema, UpdatePenaltyClauseInputSchema, DeletePenaltyClauseInputSchema, } from "./schema/zod.js";
+import { SetBasicTermsInputSchema, UpdateStatusInputSchema, SetCostAndMaterialsInputSchema, SetEscrowDetailsInputSchema, SetEvaluationTermsInputSchema, SetRetainerDetailsInputSchema, AddMilestoneInputSchema, UpdateMilestoneInputSchema, UpdateMilestoneStatusInputSchema, DeleteMilestoneInputSchema, ReorderMilestonesInputSchema, AddBonusClauseInputSchema, UpdateBonusClauseInputSchema, DeleteBonusClauseInputSchema, AddPenaltyClauseInputSchema, UpdatePenaltyClauseInputSchema, DeletePenaltyClauseInputSchema, } from "./schema/zod.js";
 const stateReducer = (state, action, dispatch) => {
     if (isDocumentAction(action)) {
         return state;
@@ -18,9 +18,9 @@ const stateReducer = (state, action, dispatch) => {
             paymentTermsTermsOperations.updateStatusOperation(state[action.scope], action, dispatch);
             break;
         }
-        case "SET_TIME_AND_MATERIALS": {
-            SetTimeAndMaterialsInputSchema().parse(action.input);
-            paymentTermsTermsOperations.setTimeAndMaterialsOperation(state[action.scope], action, dispatch);
+        case "SET_COST_AND_MATERIALS": {
+            SetCostAndMaterialsInputSchema().parse(action.input);
+            paymentTermsTermsOperations.setCostAndMaterialsOperation(state[action.scope], action, dispatch);
             break;
         }
         case "SET_ESCROW_DETAILS": {
@@ -33,6 +33,11 @@ const stateReducer = (state, action, dispatch) => {
             paymentTermsTermsOperations.setEvaluationTermsOperation(state[action.scope], action, dispatch);
             break;
         }
+        case "SET_RETAINER_DETAILS": {
+            SetRetainerDetailsInputSchema().parse(action.input);
+            paymentTermsTermsOperations.setRetainerDetailsOperation(state[action.scope], action, dispatch);
+            break;
+        }
         case "ADD_MILESTONE": {
             AddMilestoneInputSchema().parse(action.input);
             paymentTermsMilestonesOperations.addMilestoneOperation(state[action.scope], action, dispatch);

package/dist/document-models/payment-terms/gen/schema/types.d.ts

@@ -172,6 +172,12 @@ export type BonusClause = {
     condition: Scalars["String"]["output"];
     id: Scalars["OID"]["output"];
 };
+export type CostAndMaterials = {
+    billingFrequency: BillingFrequency;
+    hourlyRate: Maybe<Scalars["Amount"]["output"]>;
+    timesheetRequired: Scalars["Boolean"]["output"];
+    variableCap: Maybe<Scalars["Amount"]["output"]>;
+};
 export type DeleteBonusClauseInput = {
     id: Scalars["OID"]["input"];
 };
@@ -206,9 +212,10 @@ export type Milestone = {
 };
 export type MilestonePayoutStatus = "APPROVED" | "PAID" | "PENDING" | "READY_FOR_REVIEW" | "REJECTED";
 export type PaymentCurrency = "EUR" | "GBP" | "USD";
-export type PaymentModel = "MILESTONE" | "TIME_AND_MATERIALS";
+export type PaymentModel = "COST_AND_MATERIALS" | "MILESTONE" | "RETAINER";
 export type PaymentTermsState = {
     bonusClauses: Array<BonusClause>;
+    costAndMaterials: Maybe<CostAndMaterials>;
     currency: PaymentCurrency;
     escrowDetails: Maybe<Escrow>;
     evaluation: Maybe<EvaluationTerms>;
@@ -217,8 +224,8 @@ export type PaymentTermsState = {
     paymentModel: PaymentModel;
     penaltyClauses: Array<PenaltyClause>;
     proposer: Scalars["String"]["output"];
+    retainerDetails: Maybe<Retainer>;
     status: PaymentTermsStatus;
-    timeAndMaterials: Maybe<TimeAndMaterials>;
     totalAmount: Maybe<Scalars["Amount"]["output"]>;
 };
 export type PaymentTermsStatus = "ACCEPTED" | "CANCELLED" | "DRAFT" | "SUBMITTED";
@@ -231,6 +238,14 @@ export type PenaltyClause = {
 export type ReorderMilestonesInput = {
     order: Array<Scalars["OID"]["input"]>;
 };
+export type Retainer = {
+    autoRenew: Scalars["Boolean"]["output"];
+    billingFrequency: BillingFrequency;
+    endDate: Maybe<Scalars["Date"]["output"]>;
+    retainerAmount: Scalars["Amount"]["output"];
+    servicesIncluded: Scalars["String"]["output"];
+    startDate: Scalars["Date"]["output"];
+};
 export type SetBasicTermsInput = {
     currency: PaymentCurrency;
     payer: Scalars["String"]["input"];
@@ -238,6 +253,12 @@ export type SetBasicTermsInput = {
     proposer: Scalars["String"]["input"];
     totalAmount?: InputMaybe<Scalars["Amount"]["input"]>;
 };
+export type SetCostAndMaterialsInput = {
+    billingFrequency: BillingFrequency;
+    hourlyRate?: InputMaybe<Scalars["Amount"]["input"]>;
+    timesheetRequired: Scalars["Boolean"]["input"];
+    variableCap?: InputMaybe<Scalars["Amount"]["input"]>;
+};
 export type SetEscrowDetailsInput = {
     amountHeld: Scalars["Amount"]["input"];
     escrowProvider?: InputMaybe<Scalars["String"]["input"]>;
@@ -252,19 +273,13 @@ export type SetEvaluationTermsInput = {
     impactsPayout: Scalars["Boolean"]["input"];
     impactsReputation: Scalars["Boolean"]["input"];
 };
-export type SetTimeAndMaterialsInput = {
-    billingFrequency: BillingFrequency;
-    hourlyRate?: InputMaybe<Scalars["Amount"]["input"]>;
-    retainerAmount?: InputMaybe<Scalars["Amount"]["input"]>;
-    timesheetRequired: Scalars["Boolean"]["input"];
-    variableCap?: InputMaybe<Scalars["Amount"]["input"]>;
-};
-export type TimeAndMaterials = {
+export type SetRetainerDetailsInput = {
+    autoRenew: Scalars["Boolean"]["input"];
     billingFrequency: BillingFrequency;
-    hourlyRate: Maybe<Scalars["Amount"]["output"]>;
-    retainerAmount: Maybe<Scalars["Amount"]["output"]>;
-    timesheetRequired: Scalars["Boolean"]["output"];
-    variableCap: Maybe<Scalars["Amount"]["output"]>;
+    endDate?: InputMaybe<Scalars["Date"]["input"]>;
+    retainerAmount: Scalars["Amount"]["input"];
+    servicesIncluded: Scalars["String"]["input"];
+    startDate: Scalars["Date"]["input"];
 };
 export type UpdateBonusClauseInput = {
     bonusAmount?: InputMaybe<Scalars["Amount"]["input"]>;