placementt-core 1.400.1085 → 1.400.1086

package/lib/callables/billing.d.ts

@@ -0,0 +1,259 @@
+import { z } from "zod";
+export declare const invoiceDraftSchema: z.ZodObject<{
+    lines: z.ZodArray<z.ZodObject<{
+        key: z.ZodOptional<z.ZodEnum<["base", "wexY10", "wexY12", "events", "destinations", "hubBase", "hubSchools", "adjustment"]>>;
+        description: z.ZodString;
+        quantity: z.ZodNumber;
+        unitAmount: z.ZodNumber;
+        discount: z.ZodOptional<z.ZodObject<{
+            type: z.ZodEnum<["percent", "amount"]>;
+            value: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            type: "percent" | "amount";
+            value: number;
+        }, {
+            type: "percent" | "amount";
+            value: number;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        description: string;
+        quantity: number;
+        unitAmount: number;
+        key?: "base" | "events" | "destinations" | "wexY10" | "wexY12" | "hubBase" | "hubSchools" | "adjustment" | undefined;
+        discount?: {
+            type: "percent" | "amount";
+            value: number;
+        } | undefined;
+    }, {
+        description: string;
+        quantity: number;
+        unitAmount: number;
+        key?: "base" | "events" | "destinations" | "wexY10" | "wexY12" | "hubBase" | "hubSchools" | "adjustment" | undefined;
+        discount?: {
+            type: "percent" | "amount";
+            value: number;
+        } | undefined;
+    }>, "many">;
+    discount: z.ZodOptional<z.ZodObject<{
+        type: z.ZodEnum<["percent", "amount"]>;
+        value: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        type: "percent" | "amount";
+        value: number;
+    }, {
+        type: "percent" | "amount";
+        value: number;
+    }>>;
+    reference: z.ZodOptional<z.ZodString>;
+    date: z.ZodOptional<z.ZodString>;
+    dueDate: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    lines: {
+        description: string;
+        quantity: number;
+        unitAmount: number;
+        key?: "base" | "events" | "destinations" | "wexY10" | "wexY12" | "hubBase" | "hubSchools" | "adjustment" | undefined;
+        discount?: {
+            type: "percent" | "amount";
+            value: number;
+        } | undefined;
+    }[];
+    date?: string | undefined;
+    discount?: {
+        type: "percent" | "amount";
+        value: number;
+    } | undefined;
+    dueDate?: string | undefined;
+    reference?: string | undefined;
+}, {
+    lines: {
+        description: string;
+        quantity: number;
+        unitAmount: number;
+        key?: "base" | "events" | "destinations" | "wexY10" | "wexY12" | "hubBase" | "hubSchools" | "adjustment" | undefined;
+        discount?: {
+            type: "percent" | "amount";
+            value: number;
+        } | undefined;
+    }[];
+    date?: string | undefined;
+    discount?: {
+        type: "percent" | "amount";
+        value: number;
+    } | undefined;
+    dueDate?: string | undefined;
+    reference?: string | undefined;
+}>;
+export declare const billingCallables: {
+    /** Create a DRAFT invoice in Xero for an institute and record it in `invoices`. */
+    "billing-createXeroInvoice": {
+        request: z.ZodObject<{
+            oId: z.ZodString;
+            draft: z.ZodObject<{
+                lines: z.ZodArray<z.ZodObject<{
+                    key: z.ZodOptional<z.ZodEnum<["base", "wexY10", "wexY12", "events", "destinations", "hubBase", "hubSchools", "adjustment"]>>;
+                    description: z.ZodString;
+                    quantity: z.ZodNumber;
+                    unitAmount: z.ZodNumber;
+                    discount: z.ZodOptional<z.ZodObject<{
+                        type: z.ZodEnum<["percent", "amount"]>;
+                        value: z.ZodNumber;
+                    }, "strip", z.ZodTypeAny, {
+                        type: "percent" | "amount";
+                        value: number;
+                    }, {
+                        type: "percent" | "amount";
+                        value: number;
+                    }>>;
+                }, "strip", z.ZodTypeAny, {
+                    description: string;
+                    quantity: number;
+                    unitAmount: number;
+                    key?: "base" | "events" | "destinations" | "wexY10" | "wexY12" | "hubBase" | "hubSchools" | "adjustment" | undefined;
+                    discount?: {
+                        type: "percent" | "amount";
+                        value: number;
+                    } | undefined;
+                }, {
+                    description: string;
+                    quantity: number;
+                    unitAmount: number;
+                    key?: "base" | "events" | "destinations" | "wexY10" | "wexY12" | "hubBase" | "hubSchools" | "adjustment" | undefined;
+                    discount?: {
+                        type: "percent" | "amount";
+                        value: number;
+                    } | undefined;
+                }>, "many">;
+                discount: z.ZodOptional<z.ZodObject<{
+                    type: z.ZodEnum<["percent", "amount"]>;
+                    value: z.ZodNumber;
+                }, "strip", z.ZodTypeAny, {
+                    type: "percent" | "amount";
+                    value: number;
+                }, {
+                    type: "percent" | "amount";
+                    value: number;
+                }>>;
+                reference: z.ZodOptional<z.ZodString>;
+                date: z.ZodOptional<z.ZodString>;
+                dueDate: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                lines: {
+                    description: string;
+                    quantity: number;
+                    unitAmount: number;
+                    key?: "base" | "events" | "destinations" | "wexY10" | "wexY12" | "hubBase" | "hubSchools" | "adjustment" | undefined;
+                    discount?: {
+                        type: "percent" | "amount";
+                        value: number;
+                    } | undefined;
+                }[];
+                date?: string | undefined;
+                discount?: {
+                    type: "percent" | "amount";
+                    value: number;
+                } | undefined;
+                dueDate?: string | undefined;
+                reference?: string | undefined;
+            }, {
+                lines: {
+                    description: string;
+                    quantity: number;
+                    unitAmount: number;
+                    key?: "base" | "events" | "destinations" | "wexY10" | "wexY12" | "hubBase" | "hubSchools" | "adjustment" | undefined;
+                    discount?: {
+                        type: "percent" | "amount";
+                        value: number;
+                    } | undefined;
+                }[];
+                date?: string | undefined;
+                discount?: {
+                    type: "percent" | "amount";
+                    value: number;
+                } | undefined;
+                dueDate?: string | undefined;
+                reference?: string | undefined;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            oId: string;
+            draft: {
+                lines: {
+                    description: string;
+                    quantity: number;
+                    unitAmount: number;
+                    key?: "base" | "events" | "destinations" | "wexY10" | "wexY12" | "hubBase" | "hubSchools" | "adjustment" | undefined;
+                    discount?: {
+                        type: "percent" | "amount";
+                        value: number;
+                    } | undefined;
+                }[];
+                date?: string | undefined;
+                discount?: {
+                    type: "percent" | "amount";
+                    value: number;
+                } | undefined;
+                dueDate?: string | undefined;
+                reference?: string | undefined;
+            };
+        }, {
+            oId: string;
+            draft: {
+                lines: {
+                    description: string;
+                    quantity: number;
+                    unitAmount: number;
+                    key?: "base" | "events" | "destinations" | "wexY10" | "wexY12" | "hubBase" | "hubSchools" | "adjustment" | undefined;
+                    discount?: {
+                        type: "percent" | "amount";
+                        value: number;
+                    } | undefined;
+                }[];
+                date?: string | undefined;
+                discount?: {
+                    type: "percent" | "amount";
+                    value: number;
+                } | undefined;
+                dueDate?: string | undefined;
+                reference?: string | undefined;
+            };
+        }>;
+        response: z.ZodObject<{
+            /** The Xero InvoiceID, which is also the `invoices` doc id. */
+            invoiceId: z.ZodString;
+            /** Absent until Xero approves the draft. */
+            invoiceNumber: z.ZodOptional<z.ZodString>;
+            /** Deep link to the draft in Xero. */
+            url: z.ZodString;
+            /** Inc VAT, as Xero calculated it. */
+            total: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            total: number;
+            url: string;
+            invoiceId: string;
+            invoiceNumber?: string | undefined;
+        }, {
+            total: number;
+            url: string;
+            invoiceId: string;
+            invoiceNumber?: string | undefined;
+        }>;
+    };
+    /** Pull invoice statuses from Xero into `invoices`. One institute, or every
+     * invoice changed since the last sync when no oId is given. */
+    "billing-syncXeroInvoices": {
+        request: z.ZodObject<{
+            oId: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            oId?: string | undefined;
+        }, {
+            oId?: string | undefined;
+        }>;
+        response: z.ZodObject<{
+            synced: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            synced: number;
+        }, {
+            synced: number;
+        }>;
+    };
+};

package/lib/callables/billing.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.billingCallables = exports.invoiceDraftSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Contracts for invoicing (`Placementt-Backend/functions/src/billing.ts`).
+ *
+ * Both are admin-only. The draft is validated here rather than trusted, since
+ * it is what becomes a real invoice in Xero — a row with a NaN quantity would
+ * be rejected by Xero with an error that says nothing about which row.
+ */
+const invoiceDiscountSchema = zod_1.z.object({
+    type: zod_1.z.enum(["percent", "amount"]),
+    value: zod_1.z.number().min(0),
+});
+/** Mirrors `PricingLineKey | "adjustment"` in ../invoicing. */
+const invoiceLineKeySchema = zod_1.z.enum(["base", "wexY10", "wexY12", "events", "destinations", "hubBase", "hubSchools", "adjustment"]);
+const invoiceLineSchema = zod_1.z.object({
+    key: invoiceLineKeySchema.optional(),
+    description: zod_1.z.string().min(1),
+    quantity: zod_1.z.number(),
+    unitAmount: zod_1.z.number(),
+    discount: invoiceDiscountSchema.optional(),
+});
+exports.invoiceDraftSchema = zod_1.z.object({
+    lines: zod_1.z.array(invoiceLineSchema).min(1),
+    discount: invoiceDiscountSchema.optional(),
+    reference: zod_1.z.string().optional(),
+    date: zod_1.z.string().regex(/^\d{4}-\d{2}-\d{2}$/).optional(),
+    dueDate: zod_1.z.string().regex(/^\d{4}-\d{2}-\d{2}$/).optional(),
+});
+exports.billingCallables = {
+    /** Create a DRAFT invoice in Xero for an institute and record it in `invoices`. */
+    "billing-createXeroInvoice": {
+        request: zod_1.z.object({
+            oId: zod_1.z.string(),
+            draft: exports.invoiceDraftSchema,
+        }),
+        response: zod_1.z.object({
+            /** The Xero InvoiceID, which is also the `invoices` doc id. */
+            invoiceId: zod_1.z.string(),
+            /** Absent until Xero approves the draft. */
+            invoiceNumber: zod_1.z.string().optional(),
+            /** Deep link to the draft in Xero. */
+            url: zod_1.z.string(),
+            /** Inc VAT, as Xero calculated it. */
+            total: zod_1.z.number(),
+        }),
+    },
+    /** Pull invoice statuses from Xero into `invoices`. One institute, or every
+     * invoice changed since the last sync when no oId is given. */
+    "billing-syncXeroInvoices": {
+        request: zod_1.z.object({
+            oId: zod_1.z.string().optional(),
+        }),
+        response: zod_1.z.object({
+            synced: zod_1.z.number(),
+        }),
+    },
+};
+//# sourceMappingURL=billing.js.map

package/lib/callables/billing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing.js","sourceRoot":"","sources":["../../src/callables/billing.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;;;;GAMG;AAEH,MAAM,qBAAqB,GAAG,OAAC,CAAC,MAAM,CAAC;IACnC,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACnC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CAC3B,CAAC,CAAC;AAEH,+DAA+D;AAC/D,MAAM,oBAAoB,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC;AAEnI,MAAM,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC/B,GAAG,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IACpC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;IACtB,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC;AAEU,QAAA,kBAAkB,GAAG,OAAC,CAAC,MAAM,CAAC;IACvC,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACxC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,EAAE;IAC1C,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,QAAQ,EAAE;IACxD,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,QAAQ,EAAE;CAC9D,CAAC,CAAC;AAEU,QAAA,gBAAgB,GAAG;IAC5B,mFAAmF;IACnF,2BAA2B,EAAE;QACzB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;YACf,KAAK,EAAE,0BAAkB;SAC5B,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,+DAA+D;YAC/D,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;YACrB,4CAA4C;YAC5C,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACpC,sCAAsC;YACtC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;YACf,sCAAsC;YACtC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;SACpB,CAAC;KACL;IACD;mEAC+D;IAC/D,0BAA0B,EAAE;QACxB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAC7B,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;SACrB,CAAC;KACL;CACoB,CAAC"}

package/lib/callables/index.d.ts

@@ -7,3 +7,4 @@ export * from "./jobRoles";
 export * from "./apprenticeships";
 export * from "./he";
 export * from "./activityLogging";
+export * from "./billing";

package/lib/callables/index.js

@@ -23,4 +23,5 @@ __exportStar(require("./jobRoles"), exports);
 __exportStar(require("./apprenticeships"), exports);
 __exportStar(require("./he"), exports);
 __exportStar(require("./activityLogging"), exports);
+__exportStar(require("./billing"), exports);
 //# sourceMappingURL=index.js.map

package/lib/callables/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/callables/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,6CAA2B;AAC3B,uDAAqC;AACrC,8CAA4B;AAC5B,2CAAyB;AACzB,6CAA2B;AAC3B,oDAAkC;AAClC,uCAAqB;AACrB,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/callables/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,6CAA2B;AAC3B,uDAAqC;AACrC,8CAA4B;AAC5B,2CAAyB;AACzB,6CAA2B;AAC3B,oDAAkC;AAClC,uCAAqB;AACrB,oDAAkC;AAClC,4CAA0B"}