@voyantjs/finance-react 0.2.0

package/dist/schemas.d.ts

@@ -0,0 +1,276 @@
+import { z } from "zod";
+export declare const paginatedEnvelope: <T extends z.ZodTypeAny>(item: T) => z.ZodObject<{
+    data: z.ZodArray<T>;
+    total: z.ZodNumber;
+    limit: z.ZodNumber;
+    offset: z.ZodNumber;
+}, z.core.$strip>;
+export declare const singleEnvelope: <T extends z.ZodTypeAny>(item: T) => z.ZodObject<{
+    data: T;
+}, z.core.$strip>;
+export declare const arrayEnvelope: <T extends z.ZodTypeAny>(item: T) => z.ZodObject<{
+    data: z.ZodArray<T>;
+}, z.core.$strip>;
+export declare const successEnvelope: z.ZodObject<{
+    success: z.ZodBoolean;
+}, z.core.$strip>;
+export declare const invoiceStatusSchema: z.ZodEnum<{
+    draft: "draft";
+    void: "void";
+    sent: "sent";
+    partially_paid: "partially_paid";
+    paid: "paid";
+    overdue: "overdue";
+}>;
+export declare const paymentStatusSchema: z.ZodEnum<{
+    pending: "pending";
+    completed: "completed";
+    failed: "failed";
+    refunded: "refunded";
+}>;
+export declare const creditNoteStatusSchema: z.ZodEnum<{
+    draft: "draft";
+    issued: "issued";
+    applied: "applied";
+}>;
+export declare const invoiceRecordSchema: z.ZodObject<{
+    id: z.ZodString;
+    invoiceNumber: z.ZodString;
+    bookingId: z.ZodString;
+    personId: z.ZodNullable<z.ZodString>;
+    organizationId: z.ZodNullable<z.ZodString>;
+    status: z.ZodEnum<{
+        draft: "draft";
+        void: "void";
+        sent: "sent";
+        partially_paid: "partially_paid";
+        paid: "paid";
+        overdue: "overdue";
+    }>;
+    currency: z.ZodString;
+    subtotalCents: z.ZodNumber;
+    taxCents: z.ZodNumber;
+    totalCents: z.ZodNumber;
+    paidCents: z.ZodNumber;
+    balanceDueCents: z.ZodNumber;
+    issueDate: z.ZodString;
+    dueDate: z.ZodString;
+    notes: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$strip>;
+export type InvoiceRecord = z.infer<typeof invoiceRecordSchema>;
+export declare const lineItemRecordSchema: z.ZodObject<{
+    id: z.ZodString;
+    invoiceId: z.ZodString;
+    description: z.ZodString;
+    quantity: z.ZodNumber;
+    unitPriceCents: z.ZodNumber;
+    totalCents: z.ZodNumber;
+    taxRate: z.ZodNullable<z.ZodNumber>;
+    sortOrder: z.ZodNumber;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+export type LineItemRecord = z.infer<typeof lineItemRecordSchema>;
+export declare const paymentRecordSchema: z.ZodObject<{
+    id: z.ZodString;
+    invoiceId: z.ZodString;
+    amountCents: z.ZodNumber;
+    currency: z.ZodString;
+    paymentMethod: z.ZodString;
+    status: z.ZodEnum<{
+        pending: "pending";
+        completed: "completed";
+        failed: "failed";
+        refunded: "refunded";
+    }>;
+    referenceNumber: z.ZodNullable<z.ZodString>;
+    paymentDate: z.ZodString;
+    notes: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+export type PaymentRecord = z.infer<typeof paymentRecordSchema>;
+export declare const creditNoteRecordSchema: z.ZodObject<{
+    id: z.ZodString;
+    creditNoteNumber: z.ZodString;
+    invoiceId: z.ZodString;
+    status: z.ZodEnum<{
+        draft: "draft";
+        issued: "issued";
+        applied: "applied";
+    }>;
+    amountCents: z.ZodNumber;
+    currency: z.ZodString;
+    reason: z.ZodString;
+    notes: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+export type CreditNoteRecord = z.infer<typeof creditNoteRecordSchema>;
+export declare const financeNoteRecordSchema: z.ZodObject<{
+    id: z.ZodString;
+    invoiceId: z.ZodString;
+    authorId: z.ZodString;
+    content: z.ZodString;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+export type FinanceNoteRecord = z.infer<typeof financeNoteRecordSchema>;
+export declare const supplierPaymentRecordSchema: z.ZodObject<{
+    id: z.ZodString;
+    bookingId: z.ZodString;
+    supplierId: z.ZodNullable<z.ZodString>;
+    amountCents: z.ZodNumber;
+    currency: z.ZodString;
+    paymentMethod: z.ZodString;
+    status: z.ZodEnum<{
+        pending: "pending";
+        completed: "completed";
+        failed: "failed";
+        refunded: "refunded";
+    }>;
+    referenceNumber: z.ZodNullable<z.ZodString>;
+    paymentDate: z.ZodString;
+    notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+export type SupplierPaymentRecord = z.infer<typeof supplierPaymentRecordSchema>;
+export declare const invoiceListResponse: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        invoiceNumber: z.ZodString;
+        bookingId: z.ZodString;
+        personId: z.ZodNullable<z.ZodString>;
+        organizationId: z.ZodNullable<z.ZodString>;
+        status: z.ZodEnum<{
+            draft: "draft";
+            void: "void";
+            sent: "sent";
+            partially_paid: "partially_paid";
+            paid: "paid";
+            overdue: "overdue";
+        }>;
+        currency: z.ZodString;
+        subtotalCents: z.ZodNumber;
+        taxCents: z.ZodNumber;
+        totalCents: z.ZodNumber;
+        paidCents: z.ZodNumber;
+        balanceDueCents: z.ZodNumber;
+        issueDate: z.ZodString;
+        dueDate: z.ZodString;
+        notes: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+    limit: z.ZodNumber;
+    offset: z.ZodNumber;
+}, z.core.$strip>;
+export declare const supplierPaymentListResponse: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        bookingId: z.ZodString;
+        supplierId: z.ZodNullable<z.ZodString>;
+        amountCents: z.ZodNumber;
+        currency: z.ZodString;
+        paymentMethod: z.ZodString;
+        status: z.ZodEnum<{
+            pending: "pending";
+            completed: "completed";
+            failed: "failed";
+            refunded: "refunded";
+        }>;
+        referenceNumber: z.ZodNullable<z.ZodString>;
+        paymentDate: z.ZodString;
+        notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        createdAt: z.ZodString;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+    limit: z.ZodNumber;
+    offset: z.ZodNumber;
+}, z.core.$strip>;
+export declare const invoiceSingleResponse: z.ZodObject<{
+    data: z.ZodObject<{
+        id: z.ZodString;
+        invoiceNumber: z.ZodString;
+        bookingId: z.ZodString;
+        personId: z.ZodNullable<z.ZodString>;
+        organizationId: z.ZodNullable<z.ZodString>;
+        status: z.ZodEnum<{
+            draft: "draft";
+            void: "void";
+            sent: "sent";
+            partially_paid: "partially_paid";
+            paid: "paid";
+            overdue: "overdue";
+        }>;
+        currency: z.ZodString;
+        subtotalCents: z.ZodNumber;
+        taxCents: z.ZodNumber;
+        totalCents: z.ZodNumber;
+        paidCents: z.ZodNumber;
+        balanceDueCents: z.ZodNumber;
+        issueDate: z.ZodString;
+        dueDate: z.ZodString;
+        notes: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const invoiceLineItemsResponse: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        invoiceId: z.ZodString;
+        description: z.ZodString;
+        quantity: z.ZodNumber;
+        unitPriceCents: z.ZodNumber;
+        totalCents: z.ZodNumber;
+        taxRate: z.ZodNullable<z.ZodNumber>;
+        sortOrder: z.ZodNumber;
+        createdAt: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const invoicePaymentsResponse: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        invoiceId: z.ZodString;
+        amountCents: z.ZodNumber;
+        currency: z.ZodString;
+        paymentMethod: z.ZodString;
+        status: z.ZodEnum<{
+            pending: "pending";
+            completed: "completed";
+            failed: "failed";
+            refunded: "refunded";
+        }>;
+        referenceNumber: z.ZodNullable<z.ZodString>;
+        paymentDate: z.ZodString;
+        notes: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const invoiceCreditNotesResponse: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        creditNoteNumber: z.ZodString;
+        invoiceId: z.ZodString;
+        status: z.ZodEnum<{
+            draft: "draft";
+            issued: "issued";
+            applied: "applied";
+        }>;
+        amountCents: z.ZodNumber;
+        currency: z.ZodString;
+        reason: z.ZodString;
+        notes: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const invoiceNotesResponse: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        invoiceId: z.ZodString;
+        authorId: z.ZodString;
+        content: z.ZodString;
+        createdAt: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+//# sourceMappingURL=schemas.d.ts.map

package/dist/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC;;;;;iBAM7D,CAAA;AAEJ,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC;;iBAA6B,CAAA;AAC3F,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC;;iBAAsC,CAAA;AACnG,eAAO,MAAM,eAAe;;iBAAqC,CAAA;AAEjE,eAAO,MAAM,mBAAmB;;;;;;;EAO9B,CAAA;AAEF,eAAO,MAAM,mBAAmB;;;;;EAAyD,CAAA;AACzF,eAAO,MAAM,sBAAsB;;;;EAAyC,CAAA;AAE5E,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;iBAkB9B,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE/D,eAAO,MAAM,oBAAoB;;;;;;;;;;iBAU/B,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEjE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;iBAW9B,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE/D,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;iBAUjC,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAErE,eAAO,MAAM,uBAAuB;;;;;;iBAMlC,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAEvE,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;iBAYtC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA;AAE/E,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAyC,CAAA;AACzE,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;iBAAiD,CAAA;AACzF,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAsC,CAAA;AACxE,eAAO,MAAM,wBAAwB;;;;;;;;;;;;iBAAsC,CAAA;AAC3E,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;iBAAqC,CAAA;AACzE,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;iBAAwC,CAAA;AAC/E,eAAO,MAAM,oBAAoB;;;;;;;;iBAAyC,CAAA"}

package/dist/schemas.js

@@ -0,0 +1,100 @@
+import { z } from "zod";
+export const paginatedEnvelope = (item) => z.object({
+    data: z.array(item),
+    total: z.number().int(),
+    limit: z.number().int(),
+    offset: z.number().int(),
+});
+export const singleEnvelope = (item) => z.object({ data: item });
+export const arrayEnvelope = (item) => z.object({ data: z.array(item) });
+export const successEnvelope = z.object({ success: z.boolean() });
+export const invoiceStatusSchema = z.enum([
+    "draft",
+    "sent",
+    "partially_paid",
+    "paid",
+    "overdue",
+    "void",
+]);
+export const paymentStatusSchema = z.enum(["pending", "completed", "failed", "refunded"]);
+export const creditNoteStatusSchema = z.enum(["draft", "issued", "applied"]);
+export const invoiceRecordSchema = z.object({
+    id: z.string(),
+    invoiceNumber: z.string(),
+    bookingId: z.string(),
+    personId: z.string().nullable(),
+    organizationId: z.string().nullable(),
+    status: invoiceStatusSchema,
+    currency: z.string(),
+    subtotalCents: z.number().int(),
+    taxCents: z.number().int(),
+    totalCents: z.number().int(),
+    paidCents: z.number().int(),
+    balanceDueCents: z.number().int(),
+    issueDate: z.string(),
+    dueDate: z.string(),
+    notes: z.string().nullable(),
+    createdAt: z.string(),
+    updatedAt: z.string(),
+});
+export const lineItemRecordSchema = z.object({
+    id: z.string(),
+    invoiceId: z.string(),
+    description: z.string(),
+    quantity: z.number().int(),
+    unitPriceCents: z.number().int(),
+    totalCents: z.number().int(),
+    taxRate: z.number().int().nullable(),
+    sortOrder: z.number().int(),
+    createdAt: z.string(),
+});
+export const paymentRecordSchema = z.object({
+    id: z.string(),
+    invoiceId: z.string(),
+    amountCents: z.number().int(),
+    currency: z.string(),
+    paymentMethod: z.string(),
+    status: paymentStatusSchema,
+    referenceNumber: z.string().nullable(),
+    paymentDate: z.string(),
+    notes: z.string().nullable(),
+    createdAt: z.string(),
+});
+export const creditNoteRecordSchema = z.object({
+    id: z.string(),
+    creditNoteNumber: z.string(),
+    invoiceId: z.string(),
+    status: creditNoteStatusSchema,
+    amountCents: z.number().int(),
+    currency: z.string(),
+    reason: z.string(),
+    notes: z.string().nullable(),
+    createdAt: z.string(),
+});
+export const financeNoteRecordSchema = z.object({
+    id: z.string(),
+    invoiceId: z.string(),
+    authorId: z.string(),
+    content: z.string(),
+    createdAt: z.string(),
+});
+export const supplierPaymentRecordSchema = z.object({
+    id: z.string(),
+    bookingId: z.string(),
+    supplierId: z.string().nullable(),
+    amountCents: z.number().int(),
+    currency: z.string(),
+    paymentMethod: z.string(),
+    status: paymentStatusSchema,
+    referenceNumber: z.string().nullable(),
+    paymentDate: z.string(),
+    notes: z.string().nullable().optional(),
+    createdAt: z.string(),
+});
+export const invoiceListResponse = paginatedEnvelope(invoiceRecordSchema);
+export const supplierPaymentListResponse = paginatedEnvelope(supplierPaymentRecordSchema);
+export const invoiceSingleResponse = singleEnvelope(invoiceRecordSchema);
+export const invoiceLineItemsResponse = arrayEnvelope(lineItemRecordSchema);
+export const invoicePaymentsResponse = arrayEnvelope(paymentRecordSchema);
+export const invoiceCreditNotesResponse = arrayEnvelope(creditNoteRecordSchema);
+export const invoiceNotesResponse = arrayEnvelope(financeNoteRecordSchema);

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@voyantjs/finance-react",
+  "version": "0.2.0",
+  "license": "FSL-1.1-Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/voyantjs/voyant.git",
+    "directory": "packages/finance-react"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts",
+    "./provider": "./src/provider.tsx",
+    "./hooks": "./src/hooks/index.ts",
+    "./client": "./src/client.ts",
+    "./query-keys": "./src/query-keys.ts"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "clean": "rm -rf dist",
+    "prepack": "pnpm run build",
+    "typecheck": "tsc --noEmit",
+    "lint": "biome check src/",
+    "test": "vitest run --passWithNoTests"
+  },
+  "peerDependencies": {
+    "@voyantjs/finance": "workspace:*",
+    "@tanstack/react-query": "^5.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "zod": "^4.0.0"
+  },
+  "devDependencies": {
+    "@tanstack/react-query": "^5.96.2",
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
+    "@voyantjs/finance": "workspace:*",
+    "@voyantjs/react": "workspace:*",
+    "@voyantjs/voyant-typescript-config": "workspace:*",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "typescript": "^6.0.2",
+    "vitest": "^4.1.2",
+    "zod": "^4.3.6"
+  },
+  "dependencies": {
+    "@voyantjs/react": "workspace:*"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.ts",
+        "import": "./dist/index.js"
+      },
+      "./provider": {
+        "types": "./dist/provider.d.ts",
+        "import": "./dist/provider.js"
+      },
+      "./hooks": {
+        "types": "./dist/hooks/index.d.ts",
+        "import": "./dist/hooks/index.js"
+      },
+      "./client": {
+        "types": "./dist/client.d.ts",
+        "import": "./dist/client.js"
+      },
+      "./query-keys": {
+        "types": "./dist/query-keys.d.ts",
+        "import": "./dist/query-keys.js"
+      }
+    },
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts"
+  }
+}