@powerhousedao/contributor-billing 0.1.29 → 0.1.30

package/dist/document-models/billing-statement/src/tests/document-model.test.js

@@ -2,16 +2,103 @@
  * This is a scaffold file meant for customization:
  * - change it by adding new tests or modifying the existing ones
  */
-import { initialGlobalState, initialLocalState, createDocument, } from "../../gen/utils.js";
-describe("Billing Statement Document Model", () => {
-    it("should create a new Billing Statement document", () => {
-        const document = createDocument();
+/**
+ * This is a scaffold file meant for customization:
+ * - change it by adding new tests or modifying the existing ones
+ */
+import { describe, it, expect } from "vitest";
+import { utils, initialGlobalState, initialLocalState, billingStatementDocumentType, isBillingStatementDocument, assertIsBillingStatementDocument, isBillingStatementState, assertIsBillingStatementState, } from "@powerhousedao/contributor-billing/document-models/billing-statement";
+import { ZodError } from "zod";
+describe("BillingStatement Document Model", () => {
+    it("should create a new BillingStatement document", () => {
+        const document = utils.createDocument();
         expect(document).toBeDefined();
-        expect(document.header.documentType).toBe("powerhouse/billing-statement");
+        expect(document.header.documentType).toBe(billingStatementDocumentType);
     });
-    it("should create a new Billing Statement document with a valid initial state", () => {
-        const document = createDocument();
+    it("should create a new BillingStatement document with a valid initial state", () => {
+        const document = utils.createDocument();
         expect(document.state.global).toStrictEqual(initialGlobalState);
         expect(document.state.local).toStrictEqual(initialLocalState);
+        expect(isBillingStatementDocument(document)).toBe(true);
+        expect(isBillingStatementState(document.state)).toBe(true);
+    });
+    it("should reject a document that is not a BillingStatement document", () => {
+        const wrongDocumentType = utils.createDocument();
+        wrongDocumentType.header.documentType = "the-wrong-thing-1234";
+        try {
+            expect(assertIsBillingStatementDocument(wrongDocumentType)).toThrow();
+            expect(isBillingStatementDocument(wrongDocumentType)).toBe(false);
+        }
+        catch (error) {
+            expect(error).toBeInstanceOf(ZodError);
+        }
     });
+    const wrongState = utils.createDocument();
+    // @ts-expect-error - we are testing the error case
+    wrongState.state.global = {
+        ...{ notWhat: "you want" },
+    };
+    try {
+        expect(isBillingStatementState(wrongState.state)).toBe(false);
+        expect(assertIsBillingStatementState(wrongState.state)).toThrow();
+        expect(isBillingStatementDocument(wrongState)).toBe(false);
+        expect(assertIsBillingStatementDocument(wrongState)).toThrow();
+    }
+    catch (error) {
+        expect(error).toBeInstanceOf(ZodError);
+    }
+    const wrongInitialState = utils.createDocument();
+    // @ts-expect-error - we are testing the error case
+    wrongInitialState.initialState.global = {
+        ...{ notWhat: "you want" },
+    };
+    try {
+        expect(isBillingStatementState(wrongInitialState.state)).toBe(false);
+        expect(assertIsBillingStatementState(wrongInitialState.state)).toThrow();
+        expect(isBillingStatementDocument(wrongInitialState)).toBe(false);
+        expect(assertIsBillingStatementDocument(wrongInitialState)).toThrow();
+    }
+    catch (error) {
+        expect(error).toBeInstanceOf(ZodError);
+    }
+    const missingIdInHeader = utils.createDocument();
+    // @ts-expect-error - we are testing the error case
+    delete missingIdInHeader.header.id;
+    try {
+        expect(isBillingStatementDocument(missingIdInHeader)).toBe(false);
+        expect(assertIsBillingStatementDocument(missingIdInHeader)).toThrow();
+    }
+    catch (error) {
+        expect(error).toBeInstanceOf(ZodError);
+    }
+    const missingNameInHeader = utils.createDocument();
+    // @ts-expect-error - we are testing the error case
+    delete missingNameInHeader.header.name;
+    try {
+        expect(isBillingStatementDocument(missingNameInHeader)).toBe(false);
+        expect(assertIsBillingStatementDocument(missingNameInHeader)).toThrow();
+    }
+    catch (error) {
+        expect(error).toBeInstanceOf(ZodError);
+    }
+    const missingCreatedAtUtcIsoInHeader = utils.createDocument();
+    // @ts-expect-error - we are testing the error case
+    delete missingCreatedAtUtcIsoInHeader.header.createdAtUtcIso;
+    try {
+        expect(isBillingStatementDocument(missingCreatedAtUtcIsoInHeader)).toBe(false);
+        expect(assertIsBillingStatementDocument(missingCreatedAtUtcIsoInHeader)).toThrow();
+    }
+    catch (error) {
+        expect(error).toBeInstanceOf(ZodError);
+    }
+    const missingLastModifiedAtUtcIsoInHeader = utils.createDocument();
+    // @ts-expect-error - we are testing the error case
+    delete missingLastModifiedAtUtcIsoInHeader.header.lastModifiedAtUtcIso;
+    try {
+        expect(isBillingStatementDocument(missingLastModifiedAtUtcIsoInHeader)).toBe(false);
+        expect(assertIsBillingStatementDocument(missingLastModifiedAtUtcIsoInHeader)).toThrow();
+    }
+    catch (error) {
+        expect(error).toBeInstanceOf(ZodError);
+    }
 });

package/dist/document-models/billing-statement/src/tests/general.test.d.ts

@@ -1,5 +1,6 @@
 /**
- * Tests for Billing Statement operations
+ * This is a scaffold file meant for customization:
+ * - change it by adding new tests or modifying the existing ones
  */
 export {};
 //# sourceMappingURL=general.test.d.ts.map

package/dist/document-models/billing-statement/src/tests/general.test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"general.test.d.ts","sourceRoot":"","sources":["../../../../../document-models/billing-statement/src/tests/general.test.ts"],"names":[],"mappings":"AAAA;;GAEG"}
+{"version":3,"file":"general.test.d.ts","sourceRoot":"","sources":["../../../../../document-models/billing-statement/src/tests/general.test.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/document-models/billing-statement/src/tests/general.test.js

@@ -1,94 +1,39 @@
 /**
- * Tests for Billing Statement operations
+ * This is a scaffold file meant for customization:
+ * - change it by adding new tests or modifying the existing ones
  */
-import { createDocument } from "../../gen/utils.js";
-import {} from "../../gen/schema/index.js";
-import { reducer } from "../../gen/reducer.js";
-import * as creators from "../../gen/general/creators.js";
-describe("Billing Statement Operations", () => {
-    let document;
-    beforeEach(() => {
-        document = createDocument();
+import { describe, it, expect } from "vitest";
+import { generateMock } from "@powerhousedao/codegen";
+import { reducer, utils, isBillingStatementDocument, editBillingStatement, EditBillingStatementInputSchema, editContributor, EditContributorInputSchema, editStatus, EditStatusInputSchema, } from "@powerhousedao/contributor-billing/document-models/billing-statement";
+describe("General Operations", () => {
+    it("should handle editBillingStatement operation", () => {
+        const document = utils.createDocument();
+        const input = generateMock(EditBillingStatementInputSchema());
+        const updatedDocument = reducer(document, editBillingStatement(input));
+        expect(isBillingStatementDocument(updatedDocument)).toBe(true);
+        expect(updatedDocument.operations.global).toHaveLength(1);
+        expect(updatedDocument.operations.global[0].action.type).toBe("EDIT_BILLING_STATEMENT");
+        expect(updatedDocument.operations.global[0].action.input).toStrictEqual(input);
+        expect(updatedDocument.operations.global[0].index).toEqual(0);
     });
-    describe("editBillingStatement", () => {
-        it("should update billing statement with all fields", () => {
-            const input = {
-                dateIssued: "2024-03-20T10:00:00Z",
-                dateDue: "2024-04-20T10:00:00Z",
-                currency: "USD",
-                notes: "Test billing statement notes"
-            };
-            const updatedDocument = reducer(document, creators.editBillingStatement(input));
-            // Verify operation was recorded
-            expect(updatedDocument.operations.global).toHaveLength(1);
-            expect(updatedDocument.operations.global[0].type).toBe("EDIT_BILLING_STATEMENT");
-            expect(updatedDocument.operations.global[0].input).toStrictEqual(input);
-            expect(updatedDocument.operations.global[0].index).toEqual(0);
-            // Verify state was updated
-            expect(updatedDocument.state.global.dateIssued).toBe(input.dateIssued);
-            expect(updatedDocument.state.global.dateDue).toBe(input.dateDue);
-            expect(updatedDocument.state.global.currency).toBe(input.currency);
-            expect(updatedDocument.state.global.notes).toBe(input.notes);
-        });
-        it("should update billing statement with partial fields", () => {
-            const input = {
-                dateIssued: "2024-03-20T10:00:00Z",
-                currency: "EUR"
-            };
-            const updatedDocument = reducer(document, creators.editBillingStatement(input));
-            // Verify operation was recorded
-            expect(updatedDocument.operations.global).toHaveLength(1);
-            expect(updatedDocument.operations.global[0].type).toBe("EDIT_BILLING_STATEMENT");
-            expect(updatedDocument.operations.global[0].input).toStrictEqual(input);
-            // Verify only specified fields were updated
-            expect(updatedDocument.state.global.dateIssued).toBe(input.dateIssued);
-            expect(updatedDocument.state.global.currency).toBe(input.currency);
-            // Other fields should remain unchanged
-            expect(updatedDocument.state.global.dateDue).toBe(document.state.global.dateDue);
-            expect(updatedDocument.state.global.notes).toBe(document.state.global.notes);
-        });
+    it("should handle editContributor operation", () => {
+        const document = utils.createDocument();
+        const input = generateMock(EditContributorInputSchema());
+        const updatedDocument = reducer(document, editContributor(input));
+        expect(isBillingStatementDocument(updatedDocument)).toBe(true);
+        expect(updatedDocument.operations.global).toHaveLength(1);
+        expect(updatedDocument.operations.global[0].action.type).toBe("EDIT_CONTRIBUTOR");
+        expect(updatedDocument.operations.global[0].action.input).toStrictEqual(input);
+        expect(updatedDocument.operations.global[0].index).toEqual(0);
     });
-    describe("editContributor", () => {
-        it("should update contributor ID", () => {
-            const input = {
-                contributor: "PHID-USER-123456789"
-            };
-            const updatedDocument = reducer(document, creators.editContributor(input));
-            // Verify operation was recorded
-            expect(updatedDocument.operations.global).toHaveLength(1);
-            expect(updatedDocument.operations.global[0].type).toBe("EDIT_CONTRIBUTOR");
-            expect(updatedDocument.operations.global[0].input).toStrictEqual(input);
-            // Verify state was updated
-            expect(updatedDocument.state.global.contributor).toBe(input.contributor);
-        });
-    });
-    describe("editStatus", () => {
-        it("should update billing statement status", () => {
-            const input = {
-                status: "ISSUED"
-            };
-            const updatedDocument = reducer(document, creators.editStatus(input));
-            // Verify operation was recorded
-            expect(updatedDocument.operations.global).toHaveLength(1);
-            expect(updatedDocument.operations.global[0].type).toBe("EDIT_STATUS");
-            expect(updatedDocument.operations.global[0].input).toStrictEqual(input);
-            // Verify state was updated
-            expect(updatedDocument.state.global.status).toBe(input.status);
-        });
-        it("should handle all possible status transitions", () => {
-            const statuses = [
-                "DRAFT",
-                "ISSUED",
-                "ACCEPTED",
-                "REJECTED",
-                "PAID"
-            ];
-            let currentDocument = document;
-            for (const status of statuses) {
-                const input = { status };
-                currentDocument = reducer(currentDocument, creators.editStatus(input));
-                expect(currentDocument.state.global.status).toBe(status);
-            }
-        });
+    it("should handle editStatus operation", () => {
+        const document = utils.createDocument();
+        const input = generateMock(EditStatusInputSchema());
+        const updatedDocument = reducer(document, editStatus(input));
+        expect(isBillingStatementDocument(updatedDocument)).toBe(true);
+        expect(updatedDocument.operations.global).toHaveLength(1);
+        expect(updatedDocument.operations.global[0].action.type).toBe("EDIT_STATUS");
+        expect(updatedDocument.operations.global[0].action.input).toStrictEqual(input);
+        expect(updatedDocument.operations.global[0].index).toEqual(0);
     });
 });

package/dist/document-models/billing-statement/src/tests/line-items.test.js

@@ -2,131 +2,28 @@
  * This is a scaffold file meant for customization:
  * - change it by adding new tests or modifying the existing ones
  */
-import * as utils from "../../gen/utils.js";
-import {} from "../../gen/schema/index.js";
-import { reducer } from "../../gen/reducer.js";
-import * as creators from "../../gen/line-items/creators.js";
-import { generateId } from "document-model";
-describe("Billing Statement Line Items Operations", () => {
-    let document;
-    beforeEach(() => {
-        document = utils.createDocument();
+import { describe, it, expect } from "vitest";
+import { generateMock } from "@powerhousedao/codegen";
+import { reducer, utils, isBillingStatementDocument, addLineItem, AddLineItemInputSchema, editLineItem, EditLineItemInputSchema, } from "@powerhousedao/contributor-billing/document-models/billing-statement";
+describe("LineItems Operations", () => {
+    it("should handle addLineItem operation", () => {
+        const document = utils.createDocument();
+        const input = generateMock(AddLineItemInputSchema());
+        const updatedDocument = reducer(document, addLineItem(input));
+        expect(isBillingStatementDocument(updatedDocument)).toBe(true);
+        expect(updatedDocument.operations.global).toHaveLength(1);
+        expect(updatedDocument.operations.global[0].action.type).toBe("ADD_LINE_ITEM");
+        expect(updatedDocument.operations.global[0].action.input).toStrictEqual(input);
+        expect(updatedDocument.operations.global[0].index).toEqual(0);
     });
-    describe("addLineItem", () => {
-        it("should add a new line item and update totals", () => {
-            const input = {
-                id: generateId(),
-                description: "Test Line Item",
-                quantity: 2,
-                unit: "HOUR",
-                unitPricePwt: 10,
-                unitPriceCash: 20,
-                totalPricePwt: 20,
-                totalPriceCash: 40,
-            };
-            const updatedDocument = reducer(document, creators.addLineItem(input));
-            // Verify operation was recorded
-            expect(updatedDocument.operations.global).toHaveLength(1);
-            expect(updatedDocument.operations.global[0].type).toBe("ADD_LINE_ITEM");
-            expect(updatedDocument.operations.global[0].input).toStrictEqual(input);
-            // Verify state was updated
-            expect(updatedDocument.state.global.lineItems).toHaveLength(1);
-            const addedItem = updatedDocument.state.global.lineItems[0];
-            expect(addedItem.description).toBe(input.description);
-            expect(addedItem.quantity).toBe(input.quantity);
-            expect(addedItem.unitPricePwt).toBe(input.unitPricePwt);
-            expect(addedItem.unitPriceCash).toBe(input.unitPriceCash);
-            expect(addedItem.totalPricePwt).toBe(input.totalPricePwt);
-            expect(addedItem.totalPriceCash).toBe(input.totalPriceCash);
-            expect(addedItem.lineItemTag).toEqual([]);
-            // Verify totals were updated
-            expect(updatedDocument.state.global.totalCash).toBe(input.totalPriceCash);
-            expect(updatedDocument.state.global.totalPowt).toBe(input.totalPricePwt);
-        });
-    });
-    describe("editLineItem", () => {
-        it("should edit an existing line item and update totals", () => {
-            // First, add a line item
-            const addInput = {
-                id: generateId(),
-                description: "Original Line Item",
-                quantity: 1,
-                unit: "HOUR",
-                unitPricePwt: 10,
-                unitPriceCash: 20,
-                totalPricePwt: 10,
-                totalPriceCash: 20,
-            };
-            let updatedDocument = reducer(document, creators.addLineItem(addInput));
-            const lineItemId = updatedDocument.state.global.lineItems[0].id;
-            // Now edit the line item
-            const editInput = {
-                id: lineItemId,
-                description: "Updated Line Item",
-                quantity: 3,
-                unit: "HOUR",
-                unitPricePwt: 15,
-                unitPriceCash: 25,
-                totalPricePwt: 45,
-                totalPriceCash: 75,
-            };
-            updatedDocument = reducer(updatedDocument, creators.editLineItem(editInput));
-            // Verify operation was recorded
-            expect(updatedDocument.operations.global).toHaveLength(2);
-            expect(updatedDocument.operations.global[1].type).toBe("EDIT_LINE_ITEM");
-            expect(updatedDocument.operations.global[1].input).toStrictEqual(editInput);
-            // Verify state was updated
-            expect(updatedDocument.state.global.lineItems).toHaveLength(1);
-            const editedItem = updatedDocument.state.global.lineItems[0];
-            expect(editedItem.description).toBe(editInput.description);
-            expect(editedItem.quantity).toBe(editInput.quantity);
-            expect(editedItem.unitPricePwt).toBe(editInput.unitPricePwt);
-            expect(editedItem.unitPriceCash).toBe(editInput.unitPriceCash);
-            expect(editedItem.totalPricePwt).toBe(editInput.totalPricePwt);
-            expect(editedItem.totalPriceCash).toBe(editInput.totalPriceCash);
-            // Verify totals were updated
-            expect(updatedDocument.state.global.totalCash).toBe(editInput.totalPriceCash);
-            expect(updatedDocument.state.global.totalPowt).toBe(editInput.totalPricePwt);
-        });
-        it("should handle partial updates to a line item", () => {
-            // First, add a line item
-            const addInput = {
-                id: generateId(),
-                description: "Original Line Item",
-                quantity: 1,
-                unit: "HOUR",
-                unitPricePwt: 10,
-                unitPriceCash: 20,
-                totalPricePwt: 10,
-                totalPriceCash: 20,
-            };
-            let updatedDocument = reducer(document, creators.addLineItem(addInput));
-            const lineItemId = updatedDocument.state.global.lineItems[0].id;
-            // Now edit the line item with partial fields
-            const editInput = {
-                id: lineItemId,
-                description: "Updated Description",
-                quantity: 2,
-                unit: "UNIT",
-            };
-            updatedDocument = reducer(updatedDocument, creators.editLineItem(editInput));
-            // Verify operation was recorded
-            expect(updatedDocument.operations.global).toHaveLength(2);
-            expect(updatedDocument.operations.global[1].type).toBe("EDIT_LINE_ITEM");
-            expect(updatedDocument.operations.global[1].input).toStrictEqual(editInput);
-            // Verify state was updated
-            expect(updatedDocument.state.global.lineItems).toHaveLength(1);
-            const editedItem = updatedDocument.state.global.lineItems[0];
-            expect(editedItem.description).toBe(editInput.description);
-            expect(editedItem.quantity).toBe(editInput.quantity);
-            // Other fields should remain unchanged
-            expect(editedItem.unitPricePwt).toBe(addInput.unitPricePwt);
-            expect(editedItem.unitPriceCash).toBe(addInput.unitPriceCash);
-            // Verify totals were updated based on new quantity
-            expect(editInput.quantity).not.toBeNull();
-            expect(editInput.quantity).not.toBeUndefined();
-            expect(updatedDocument.state.global.totalCash).toBe(editInput.quantity * addInput.unitPriceCash);
-            expect(updatedDocument.state.global.totalPowt).toBe(editInput.quantity * addInput.unitPricePwt);
-        });
+    it("should handle editLineItem operation", () => {
+        const document = utils.createDocument();
+        const input = generateMock(EditLineItemInputSchema());
+        const updatedDocument = reducer(document, editLineItem(input));
+        expect(isBillingStatementDocument(updatedDocument)).toBe(true);
+        expect(updatedDocument.operations.global).toHaveLength(1);
+        expect(updatedDocument.operations.global[0].action.type).toBe("EDIT_LINE_ITEM");
+        expect(updatedDocument.operations.global[0].action.input).toStrictEqual(input);
+        expect(updatedDocument.operations.global[0].index).toEqual(0);
     });
 });

package/dist/document-models/billing-statement/src/tests/tags.test.js

@@ -2,52 +2,18 @@
  * This is a scaffold file meant for customization:
  * - change it by adding new tests or modifying the existing ones
  */
-import * as utils from "../../gen/utils.js";
-import {} from "../../gen/schema/index.js";
-import { reducer } from "../../gen/reducer.js";
-import * as creators from "../../gen/tags/creators.js";
-import * as lineItemCreators from "../../gen/line-items/creators.js";
-import { generateId } from "document-model";
-describe("Billing Statement Tags Operations", () => {
-    let document;
-    beforeEach(() => {
-        document = utils.createDocument();
-    });
-    describe("editLineItemTag", () => {
-        it("should edit a line item tag", () => {
-            // First, add a line item
-            const addInput = {
-                id: generateId(),
-                description: "Test Line Item",
-                quantity: 1,
-                unit: "HOUR",
-                unitPricePwt: 10,
-                unitPriceCash: 20,
-                totalPricePwt: 10,
-                totalPriceCash: 20,
-            };
-            let updatedDocument = reducer(document, lineItemCreators.addLineItem(addInput));
-            const lineItemId = updatedDocument.state.global.lineItems[0].id;
-            // Now edit the line item tag
-            const input = {
-                lineItemId: lineItemId,
-                dimension: "category",
-                value: "expense",
-                label: "Office Supplies",
-            };
-            updatedDocument = reducer(updatedDocument, creators.editLineItemTag(input));
-            // Verify operation was recorded
-            expect(updatedDocument.operations.global).toHaveLength(2);
-            expect(updatedDocument.operations.global[1].type).toBe("EDIT_LINE_ITEM_TAG");
-            expect(updatedDocument.operations.global[1].input).toStrictEqual(input);
-            // Verify state was updated
-            const lineItem = updatedDocument.state.global.lineItems.find(item => item.id === input.lineItemId);
-            expect(lineItem).toBeDefined();
-            expect(lineItem?.lineItemTag).toContainEqual({
-                dimension: input.dimension,
-                value: input.value,
-                label: input.label,
-            });
-        });
+import { describe, it, expect } from "vitest";
+import { generateMock } from "@powerhousedao/codegen";
+import { reducer, utils, isBillingStatementDocument, editLineItemTag, EditLineItemTagInputSchema, } from "@powerhousedao/contributor-billing/document-models/billing-statement";
+describe("Tags Operations", () => {
+    it("should handle editLineItemTag operation", () => {
+        const document = utils.createDocument();
+        const input = generateMock(EditLineItemTagInputSchema());
+        const updatedDocument = reducer(document, editLineItemTag(input));
+        expect(isBillingStatementDocument(updatedDocument)).toBe(true);
+        expect(updatedDocument.operations.global).toHaveLength(1);
+        expect(updatedDocument.operations.global[0].action.type).toBe("EDIT_LINE_ITEM_TAG");
+        expect(updatedDocument.operations.global[0].action.input).toStrictEqual(input);
+        expect(updatedDocument.operations.global[0].index).toEqual(0);
     });
 });

package/dist/document-models/document-models.js

@@ -1,7 +1,7 @@
+import { Invoice } from "./invoice/module.js";
 import { BillingStatement } from "./billing-statement/module.js";
-import { ExpenseReport } from "./expense-report/module.js";
 import { Integrations } from "./integrations/module.js";
-import { Invoice } from "./invoice/module.js";
+import { ExpenseReport } from "./expense-report/module.js";
 export const documentModels = [
     BillingStatement,
     ExpenseReport,

package/dist/document-models/expense-report/gen/document-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"document-model.d.ts","sourceRoot":"","sources":["../../../../document-models/expense-report/gen/document-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAE/D,eAAO,MAAM,aAAa,EAAE,wBAkO3B,CAAC"}
+{"version":3,"file":"document-model.d.ts","sourceRoot":"","sources":["../../../../document-models/expense-report/gen/document-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAE/D,eAAO,MAAM,aAAa,EAAE,wBAyN3B,CAAC"}