@onabl/contracts 0.3.1 → 0.4.0

package/dist/invoices.d.ts

@@ -28,4 +28,8 @@ export declare const PaymentSummarySchema: z.ZodObject<{
     note: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
 export type PaymentSummary = z.infer<typeof PaymentSummarySchema>;
+export declare const VoidInvoiceSchema: z.ZodObject<{
+    reason: z.ZodString;
+}, z.core.$strip>;
+export type VoidInvoice = z.infer<typeof VoidInvoiceSchema>;
 //# sourceMappingURL=invoices.d.ts.map

package/dist/invoices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../src/invoices.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAEtB,eAAO,MAAM,eAAe,2CAA4C,CAAC;AACzE,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,eAAO,MAAM,mBAAmB;;;;;;;;;;;iBAO9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAIhE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;iBAO/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}
+{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../src/invoices.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAEtB,eAAO,MAAM,eAAe,2CAA4C,CAAC;AACzE,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,eAAO,MAAM,mBAAmB;;;;;;;;;;;iBAO9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAIhE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;iBAO/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAMlE,eAAO,MAAM,iBAAiB;;iBAE5B,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

package/dist/invoices.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaymentSummarySchema = exports.RecordPaymentSchema = exports.PAYMENT_METHODS = void 0;
+exports.VoidInvoiceSchema = exports.PaymentSummarySchema = exports.RecordPaymentSchema = exports.PAYMENT_METHODS = void 0;
 // packages/contracts/src/invoices.ts
 // E2 — the payment ledger. Request validation for POST /invoices/:uuid/payments
 // (tenant-authenticated, not part of the public-api.ts surface — no external
@@ -25,3 +25,10 @@ exports.PaymentSummarySchema = zod_1.z.object({
     receivedAt: zod_1.z.string(),
     note: zod_1.z.string().nullable(),
 });
+// E4 — request validation for POST /invoices/:uuid/void and
+// POST /invoices/:uuid/reissue (both tenant-authenticated). Same reason
+// requirement either way — reissue voids the old invoice before creating the
+// replacement.
+exports.VoidInvoiceSchema = zod_1.z.object({
+    reason: zod_1.z.string().trim().min(1).max(500),
+});

package/dist/public-api.d.ts

@@ -239,7 +239,16 @@ export declare const InvoiceSchema: z.ZodObject<{
     uuid: z.ZodString;
     invoiceNumber: z.ZodString;
     totalAmount: z.ZodString;
-    dueDate: z.ZodString;
+    finalDueDate: z.ZodString;
+    dueMilestone: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        kind: z.ZodEnum<{
+            DEPOSIT: "DEPOSIT";
+            BALANCE: "BALANCE";
+            FULL: "FULL";
+        }>;
+        dueDate: z.ZodString;
+        overdue: z.ZodBoolean;
+    }, z.core.$strip>>>;
     issueDate: z.ZodString;
     paidAt: z.ZodNullable<z.ZodString>;
     balancePaidAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -259,6 +268,15 @@ export declare const InvoiceSchema: z.ZodObject<{
         balance_uploaded: "balance_uploaded";
     }>>;
     statusChangedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    voidReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    supersedesInvoice: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        invoiceNumber: z.ZodString;
+    }, z.core.$strip>>>;
+    supersededBy: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        invoiceNumber: z.ZodString;
+    }, z.core.$strip>>>;
     outstanding: z.ZodOptional<z.ZodString>;
     depositPercent: z.ZodNullable<z.ZodNumber>;
     depositAmount: z.ZodNullable<z.ZodString>;
@@ -269,6 +287,7 @@ export declare const InvoiceSchema: z.ZodObject<{
     balanceDueDate: z.ZodNullable<z.ZodString>;
     popUploadedAt: z.ZodNullable<z.ZodString>;
     lineItems: z.ZodArray<z.ZodObject<{}, z.core.$loose>>;
+    lineItemsVersion: z.ZodOptional<z.ZodNumber>;
     codeDiscountLabel: z.ZodNullable<z.ZodString>;
     codeDiscountType: z.ZodNullable<z.ZodEnum<{
         PERCENT: "PERCENT";

package/dist/public-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"public-api.d.ts","sourceRoot":"","sources":["../src/public-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AACtB,OAAO,KAAK,EAAC,SAAS,EAAY,MAAM,qBAAqB,CAAC;AAkC9D,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiBlB,CAAC;AAEjB,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2BnB,CAAC;AAEjB,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuBb,CAAC;AAIjB,eAAO,MAAM,0BAA0B;;;;;;mBAA2H,CAAC;AAInK,eAAO,MAAM,8BAA8B;;;;iBAIzC,CAAC;AAIH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+CR,CAAC;AAEjB,eAAO,MAAM,yBAAyB;;iBAAwC,CAAC;AAC/E,eAAO,MAAM,0BAA0B;;iBAAwC,CAAC;AAIhF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,uFAAwF,CAAC;AACtH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE9D,qKAAqK;AACrK,eAAO,MAAM,kCAAkC,6CAA8C,CAAC;AAE9F,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6DV,CAAC;AAEjB,eAAO,MAAM,0BAA0B;;iBAAqC,CAAC;AAI7E,eAAO,MAAM,qBAAqB;;;;;iBAKhC,CAAC;AAIH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AACtF,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAChD,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;AACjE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"public-api.d.ts","sourceRoot":"","sources":["../src/public-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AACtB,OAAO,KAAK,EAAC,SAAS,EAAY,MAAM,qBAAqB,CAAC;AAkC9D,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiBlB,CAAC;AAEjB,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2BnB,CAAC;AAEjB,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuBb,CAAC;AAIjB,eAAO,MAAM,0BAA0B;;;;;;mBAA2H,CAAC;AAInK,eAAO,MAAM,8BAA8B;;;;iBAIzC,CAAC;AAIH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+CR,CAAC;AAEjB,eAAO,MAAM,yBAAyB;;iBAAwC,CAAC;AAC/E,eAAO,MAAM,0BAA0B;;iBAAwC,CAAC;AAIhF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,uFAAwF,CAAC;AACtH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE9D,qKAAqK;AACrK,eAAO,MAAM,kCAAkC,6CAA8C,CAAC;AAE9F,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+EV,CAAC;AAEjB,eAAO,MAAM,0BAA0B;;iBAAqC,CAAC;AAI7E,eAAO,MAAM,qBAAqB;;;;;iBAKhC,CAAC;AAIH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AACtF,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAChD,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;AACjE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC"}

package/dist/public-api.js

@@ -173,7 +173,17 @@ exports.InvoiceSchema = zod_1.z
     uuid: zod_1.z.string(),
     invoiceNumber: zod_1.z.string(),
     totalAmount: zod_1.z.string(),
-    dueDate: zod_1.z.string(),
+    // INV-9 (baseline 2026-09-06, was `dueDate`): the single / final payment
+    // due date — the balance due date on a deposit invoice. NOT "what is due
+    // next" — use `dueMilestone` for that.
+    finalDueDate: zod_1.z.string(),
+    // The milestone currently outstanding + whether it is late. null once the
+    // invoice is paid / void / written off. Every "overdue" answer in the app
+    // derives from this one value.
+    dueMilestone: zod_1.z
+        .object({ kind: zod_1.z.enum(["DEPOSIT", "BALANCE", "FULL"]), dueDate: zod_1.z.string(), overdue: zod_1.z.boolean() })
+        .nullable()
+        .optional(),
     issueDate: zod_1.z.string(),
     paidAt: zod_1.z.string().nullable(),
     // Deposit invoices only: the balance milestone was confirmed. null on
@@ -188,6 +198,11 @@ exports.InvoiceSchema = zod_1.z
     // confirmation, and against which milestone. Orthogonal to `status`.
     popStatus: zod_1.z.enum(["none", "deposit_uploaded", "balance_uploaded"]).optional(),
     statusChangedAt: zod_1.z.string().nullable().optional(),
+    // E4 — void/re-issue history. Additive; absent on responses from before
+    // this field existed.
+    voidReason: zod_1.z.string().nullable().optional(),
+    supersedesInvoice: zod_1.z.object({ id: zod_1.z.string(), invoiceNumber: zod_1.z.string() }).nullable().optional(),
+    supersededBy: zod_1.z.object({ id: zod_1.z.string(), invoiceNumber: zod_1.z.string() }).nullable().optional(),
     // E2 — total minus every recorded payment. Additive; absent on responses
     // from before the payment ledger existed.
     outstanding: zod_1.z.string().optional(),
@@ -200,6 +215,9 @@ exports.InvoiceSchema = zod_1.z
     balanceDueDate: zod_1.z.string().nullable(),
     popUploadedAt: zod_1.z.string().nullable(),
     lineItems: zod_1.z.array(LineItemSchema),
+    // E5 — which shape of LineItem this snapshot was frozen under. Additive;
+    // absent on responses from before this field existed (treat as version 1).
+    lineItemsVersion: zod_1.z.number().optional(),
     codeDiscountLabel: zod_1.z.string().nullable(),
     codeDiscountType: zod_1.z.enum(["PERCENT", "FIXED"]).nullable(),
     codeDiscountValue: zod_1.z.string().nullable(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onabl/contracts",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Zod request/response validation schemas for onabl's public API — the SDK's typed contract with the API.",
   "license": "MIT",
   "repository": {
@@ -23,11 +23,11 @@
   },
   "devDependencies": {
     "eslint": "latest",
-    "@onabl/eslint-config": "0.0.1",
-    "@onabl/typescript-config": "0.0.1"
+    "@onabl/typescript-config": "0.0.1",
+    "@onabl/eslint-config": "0.0.1"
   },
   "dependencies": {
-    "@onabl/types": "0.4.0"
+    "@onabl/types": "0.5.0"
   },
   "peerDependencies": {
     "zod": "^4"