@copilotz/billing 0.0.0-stage → 1.0.0-rc.35

package/credits/collections/credit.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Credits an org was given or bought, in USD, appended and never changed: the
+ * same `_id` again is the one already kept, so a grant that comes from
+ * something (a period, a code, a payment) can't land twice. A negative amount
+ * takes credits away.
+ */
+import { type Infer } from "copilotz";
+export declare const creditSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly kind: {
+            readonly type: "string";
+            readonly enum: readonly ["trial", "plan", "gift", "referral", "purchase", "waived", "adjustment"];
+        };
+        readonly amount: {
+            readonly type: "number";
+        };
+        readonly at: {
+            readonly type: "string";
+        };
+        /** The first day (UTC, `YYYY-MM-DD`) it no longer counts; none: it doesn't expire. */
+        readonly expires: {
+            readonly type: "string";
+        };
+        /** What to show for it. */
+        readonly note: {
+            readonly type: "string";
+        };
+        /** Why it was given, and who gave it: for staff. */
+        readonly reason: {
+            readonly type: "string";
+        };
+        readonly by: {
+            readonly type: "string";
+        };
+        /** Taken away, what it comes out of first: a refund, of what the money bought. */
+        readonly takes: {
+            readonly type: "string";
+        };
+        /** From a test mode: it stops counting when the app goes live. */
+        readonly sandbox: {
+            readonly type: "boolean";
+        };
+    };
+    readonly required: readonly ["kind", "amount", "at"];
+};
+export type Credit = Infer<typeof creditSchema> & {
+    _id: string;
+};
+export declare const credit: {
+    schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly kind: {
+                readonly type: "string";
+                readonly enum: readonly ["trial", "plan", "gift", "referral", "purchase", "waived", "adjustment"];
+            };
+            readonly amount: {
+                readonly type: "number";
+            };
+            readonly at: {
+                readonly type: "string";
+            };
+            /** The first day (UTC, `YYYY-MM-DD`) it no longer counts; none: it doesn't expire. */
+            readonly expires: {
+                readonly type: "string";
+            };
+            /** What to show for it. */
+            readonly note: {
+                readonly type: "string";
+            };
+            /** Why it was given, and who gave it: for staff. */
+            readonly reason: {
+                readonly type: "string";
+            };
+            readonly by: {
+                readonly type: "string";
+            };
+            /** Taken away, what it comes out of first: a refund, of what the money bought. */
+            readonly takes: {
+                readonly type: "string";
+            };
+            /** From a test mode: it stops counting when the app goes live. */
+            readonly sandbox: {
+                readonly type: "boolean";
+            };
+        };
+        readonly required: readonly ["kind", "amount", "at"];
+    };
+    events?: boolean;
+    records?: boolean;
+    durable?: false;
+    indexes?: string[][];
+    private?: string[];
+    queries?: Record<string, import("copilotz").QueryDef<{
+        [x: string]: unknown;
+        expires?: string | undefined;
+        note?: string | undefined;
+        reason?: string | undefined;
+        by?: string | undefined;
+        takes?: string | undefined;
+        sandbox?: boolean | undefined;
+        kind: "trial" | "plan" | "gift" | "referral" | "purchase" | "waived" | "adjustment";
+        amount: number;
+        at: string;
+    } & {
+        _id: string;
+    }>> | undefined;
+    vectors?: string[];
+};

package/credits/collections/credit.js

@@ -0,0 +1,31 @@
+/**
+ * Credits an org was given or bought, in USD, appended and never changed: the
+ * same `_id` again is the one already kept, so a grant that comes from
+ * something (a period, a code, a payment) can't land twice. A negative amount
+ * takes credits away.
+ */
+import { defineCollection } from "copilotz";
+export const creditSchema = {
+    type: "object",
+    properties: {
+        kind: {
+            type: "string",
+            enum: ["trial", "plan", "gift", "referral", "purchase", "waived", "adjustment"],
+        },
+        amount: { type: "number" },
+        at: { type: "string" },
+        /** The first day (UTC, `YYYY-MM-DD`) it no longer counts; none: it doesn't expire. */
+        expires: { type: "string" },
+        /** What to show for it. */
+        note: { type: "string" },
+        /** Why it was given, and who gave it: for staff. */
+        reason: { type: "string" },
+        by: { type: "string" },
+        /** Taken away, what it comes out of first: a refund, of what the money bought. */
+        takes: { type: "string" },
+        /** From a test mode: it stops counting when the app goes live. */
+        sandbox: { type: "boolean" },
+    },
+    required: ["kind", "amount", "at"],
+};
+export const credit = defineCollection({ records: true, schema: creditSchema });

package/credits/collections/payment.d.ts

@@ -0,0 +1,139 @@
+/**
+ * Money that came in, however it came: appended, one for each thing a channel
+ * collected (`_id`: `<channel>:<ref>`). What commissions and accounts read,
+ * so they never need to know who collected it.
+ */
+import { type Infer } from "copilotz";
+export declare const paymentSchema: {
+    readonly type: "object";
+    readonly properties: {
+        /** `manual`, `stripe`… and which account of it (a seller). */
+        readonly channel: {
+            readonly type: "string";
+        };
+        readonly seller: {
+            readonly type: "string";
+        };
+        readonly ref: {
+            readonly type: "string";
+        };
+        /** What was collected, in its currency's main unit, before tax. */
+        readonly amount: {
+            readonly type: "number";
+        };
+        readonly currency: {
+            readonly type: "string";
+        };
+        /** USD per unit of its currency, when it isn't USD. */
+        readonly rate: {
+            readonly type: "number";
+        };
+        /** What the channel kept. */
+        readonly fee: {
+            readonly type: "number";
+        };
+        /** What it was for, and the credits it bought (USD). */
+        readonly purpose: {
+            readonly type: "string";
+            readonly enum: readonly ["seats", "credits", "contract", "refund"];
+        };
+        readonly credits: {
+            readonly type: "number";
+        };
+        readonly note: {
+            readonly type: "string";
+        };
+        readonly by: {
+            readonly type: "string";
+        };
+        /** From a test mode: no real money. */
+        readonly sandbox: {
+            readonly type: "boolean";
+        };
+        readonly at: {
+            readonly type: "string";
+        };
+    };
+    readonly required: readonly ["channel", "ref", "amount", "currency", "purpose", "at"];
+};
+export type Payment = Infer<typeof paymentSchema> & {
+    _id: string;
+};
+export declare const payment: {
+    schema: {
+        readonly type: "object";
+        readonly properties: {
+            /** `manual`, `stripe`… and which account of it (a seller). */
+            readonly channel: {
+                readonly type: "string";
+            };
+            readonly seller: {
+                readonly type: "string";
+            };
+            readonly ref: {
+                readonly type: "string";
+            };
+            /** What was collected, in its currency's main unit, before tax. */
+            readonly amount: {
+                readonly type: "number";
+            };
+            readonly currency: {
+                readonly type: "string";
+            };
+            /** USD per unit of its currency, when it isn't USD. */
+            readonly rate: {
+                readonly type: "number";
+            };
+            /** What the channel kept. */
+            readonly fee: {
+                readonly type: "number";
+            };
+            /** What it was for, and the credits it bought (USD). */
+            readonly purpose: {
+                readonly type: "string";
+                readonly enum: readonly ["seats", "credits", "contract", "refund"];
+            };
+            readonly credits: {
+                readonly type: "number";
+            };
+            readonly note: {
+                readonly type: "string";
+            };
+            readonly by: {
+                readonly type: "string";
+            };
+            /** From a test mode: no real money. */
+            readonly sandbox: {
+                readonly type: "boolean";
+            };
+            readonly at: {
+                readonly type: "string";
+            };
+        };
+        readonly required: readonly ["channel", "ref", "amount", "currency", "purpose", "at"];
+    };
+    events?: boolean;
+    records?: boolean;
+    durable?: false;
+    indexes?: string[][];
+    private?: string[];
+    queries?: Record<string, import("copilotz").QueryDef<{
+        [x: string]: unknown;
+        credits?: number | undefined;
+        note?: string | undefined;
+        by?: string | undefined;
+        sandbox?: boolean | undefined;
+        seller?: string | undefined;
+        rate?: number | undefined;
+        fee?: number | undefined;
+        amount: number;
+        at: string;
+        currency: string;
+        channel: string;
+        purpose: "credits" | "seats" | "contract" | "refund";
+        ref: string;
+    } & {
+        _id: string;
+    }>> | undefined;
+    vectors?: string[];
+};

package/credits/collections/payment.js

@@ -0,0 +1,32 @@
+/**
+ * Money that came in, however it came: appended, one for each thing a channel
+ * collected (`_id`: `<channel>:<ref>`). What commissions and accounts read,
+ * so they never need to know who collected it.
+ */
+import { defineCollection } from "copilotz";
+export const paymentSchema = {
+    type: "object",
+    properties: {
+        /** `manual`, `stripe`… and which account of it (a seller). */
+        channel: { type: "string" },
+        seller: { type: "string" },
+        ref: { type: "string" },
+        /** What was collected, in its currency's main unit, before tax. */
+        amount: { type: "number" },
+        currency: { type: "string" },
+        /** USD per unit of its currency, when it isn't USD. */
+        rate: { type: "number" },
+        /** What the channel kept. */
+        fee: { type: "number" },
+        /** What it was for, and the credits it bought (USD). */
+        purpose: { type: "string", enum: ["seats", "credits", "contract", "refund"] },
+        credits: { type: "number" },
+        note: { type: "string" },
+        by: { type: "string" },
+        /** From a test mode: no real money. */
+        sandbox: { type: "boolean" },
+        at: { type: "string" },
+    },
+    required: ["channel", "ref", "amount", "currency", "purpose", "at"],
+};
+export const payment = defineCollection({ records: true, schema: paymentSchema });