@pdfvector/util 0.4.0 → 0.5.0

package/.tsc/lib/billing-hold-error-codes.d.ts

@@ -0,0 +1,14 @@
+export declare const billingHoldErrorCodes: readonly ["BILLING_UNPAID_INVOICE", "BILLING_DISPUTE", "BILLING_PAYMENT_METHOD_REQUIRED", "BILLING_LINKED_UNPAID_BALANCE", "BILLING_ACCOUNT_HOLD"];
+export type BillingHoldErrorCode = (typeof billingHoldErrorCodes)[number];
+export declare const creditsExhaustedErrorCode = "CREDITS_EXHAUSTED";
+export type BillingHoldErrorData = {
+    code: BillingHoldErrorCode;
+    reason: string;
+    invoiceCount: number;
+    amountDue: number;
+    currency: string;
+    billingUrl: string;
+    payUrl: string | null;
+};
+export declare function isBillingHoldErrorCode(value: unknown): value is BillingHoldErrorCode;
+//# sourceMappingURL=billing-hold-error-codes.d.ts.map

package/.tsc/lib/billing-hold-error-codes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-hold-error-codes.d.ts","sourceRoot":"","sources":["../../lib/billing-hold-error-codes.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,YACjC,wBAAwB,EACxB,iBAAiB,EACjB,iCAAiC,EACjC,+BAA+B,EAC/B,sBAAsB,CACb,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E,eAAO,MAAM,yBAAyB,sBAAsB,CAAC;AAE7D,MAAM,MAAM,oBAAoB,GAAG;IAClC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB,CAAC;AAEF,wBAAgB,sBAAsB,CACrC,KAAK,EAAE,OAAO,GACZ,KAAK,IAAI,oBAAoB,CAE/B"}

package/.tsc/lib/billing-hold-error-codes.js

@@ -0,0 +1,11 @@
+export const billingHoldErrorCodes = [
+    "BILLING_UNPAID_INVOICE",
+    "BILLING_DISPUTE",
+    "BILLING_PAYMENT_METHOD_REQUIRED",
+    "BILLING_LINKED_UNPAID_BALANCE",
+    "BILLING_ACCOUNT_HOLD",
+];
+export const creditsExhaustedErrorCode = "CREDITS_EXHAUSTED";
+export function isBillingHoldErrorCode(value) {
+    return billingHoldErrorCodes.some((code) => code === value);
+}

package/.tsc/lib/contract/gateway/router/admin/billing-holds.d.ts

@@ -0,0 +1,42 @@
+import * as z from "zod";
+export declare const listBillingHolds: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+    includeResolved: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodObject<{
+    mode: z.ZodEnum<{
+        enforce: "enforce";
+        off: "off";
+        shadow: "shadow";
+    }>;
+    holds: z.ZodArray<z.ZodObject<{
+        workspaceId: z.ZodNumber;
+        workspaceName: z.ZodString;
+        reason: z.ZodString;
+        code: z.ZodString;
+        invoiceCount: z.ZodNumber;
+        amountDue: z.ZodNumber;
+        currency: z.ZodString;
+        linkedWorkspaceId: z.ZodNullable<z.ZodNumber>;
+        matchedBy: z.ZodNullable<z.ZodString>;
+        manual: z.ZodBoolean;
+        since: z.ZodDate;
+        resolvedAt: z.ZodNullable<z.ZodDate>;
+        exemptUntil: z.ZodNullable<z.ZodDate>;
+        emailsSent: z.ZodNumber;
+    }, z.core.$strip>>;
+    registry: z.ZodArray<z.ZodObject<{
+        kind: z.ZodString;
+        count: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>, Record<never, never>, Record<never, never>>;
+export declare const overrideBillingHold: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+    workspaceId: z.ZodNumber;
+    action: z.ZodEnum<{
+        clear: "clear";
+        hold: "hold";
+        unexempt: "unexempt";
+    }>;
+    days: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>, z.ZodObject<{
+    success: z.ZodBoolean;
+}, z.core.$strip>, Record<never, never>, Record<never, never>>;
+//# sourceMappingURL=billing-holds.d.ts.map

package/.tsc/lib/contract/gateway/router/admin/billing-holds.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-holds.d.ts","sourceRoot":"","sources":["../../../../../../lib/contract/gateway/router/admin/billing-holds.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;8DAyB3B,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;;8DAQY,CAAC"}

package/.tsc/lib/contract/gateway/router/admin/billing-holds.js

@@ -0,0 +1,31 @@
+import { oc } from "@orpc/contract";
+import * as z from "zod";
+export const listBillingHolds = oc
+    .input(z.object({ includeResolved: z.boolean().default(false) }))
+    .output(z.object({
+    mode: z.enum(["off", "shadow", "enforce"]),
+    holds: z.array(z.object({
+        workspaceId: z.number(),
+        workspaceName: z.string(),
+        reason: z.string(),
+        code: z.string(),
+        invoiceCount: z.number(),
+        amountDue: z.number(),
+        currency: z.string(),
+        linkedWorkspaceId: z.number().nullable(),
+        matchedBy: z.string().nullable(),
+        manual: z.boolean(),
+        since: z.date(),
+        resolvedAt: z.date().nullable(),
+        exemptUntil: z.date().nullable(),
+        emailsSent: z.number(),
+    })),
+    registry: z.array(z.object({ kind: z.string(), count: z.number() })),
+}));
+export const overrideBillingHold = oc
+    .input(z.object({
+    workspaceId: z.number().int().positive(),
+    action: z.enum(["hold", "clear", "unexempt"]),
+    days: z.number().int().min(1).max(3650).default(30),
+}))
+    .output(z.object({ success: z.boolean() }));

package/.tsc/lib/contract/gateway/router/admin.d.ts

@@ -1,4 +1,5 @@
 export * from "./admin/billing.js";
+export * from "./admin/billing-holds.js";
 export * from "./admin/blog.js";
 export * from "./admin/feedback.js";
 export * from "./admin/instances.js";

package/.tsc/lib/contract/gateway/router/admin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"admin.d.ts","sourceRoot":"","sources":["../../../../../lib/contract/gateway/router/admin.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC"}
+{"version":3,"file":"admin.d.ts","sourceRoot":"","sources":["../../../../../lib/contract/gateway/router/admin.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC"}

package/.tsc/lib/contract/gateway/router/admin.js

@@ -1,4 +1,5 @@
 export * from "./admin/billing.js";
+export * from "./admin/billing-holds.js";
 export * from "./admin/blog.js";
 export * from "./admin/feedback.js";
 export * from "./admin/instances.js";

package/.tsc/lib/contract/gateway/router/billing.d.ts

@@ -15,4 +15,58 @@ export declare const update: import("@orpc/contract").ContractProcedureBuilderWi
     succeedURL: z.ZodString;
     returnURL: z.ZodString;
 }, z.core.$strip>, z.ZodOptional<z.ZodString>, Record<never, never>, Record<never, never>>;
+/** The workspace's billing hold (unpaid invoices or a payment dispute), if any. */
+export declare const hold: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
+    mode: z.ZodEnum<{
+        enforce: "enforce";
+        off: "off";
+        shadow: "shadow";
+    }>;
+    hold: z.ZodNullable<z.ZodObject<{
+        reason: z.ZodEnum<{
+            canceled_unpaid: "canceled_unpaid";
+            dispute: "dispute";
+            dispute_lost: "dispute_lost";
+            linked_unpaid: "linked_unpaid";
+            manual: "manual";
+            overdue_invoice: "overdue_invoice";
+            payment_failed: "payment_failed";
+            uncollectible: "uncollectible";
+            unpaid_invoice: "unpaid_invoice";
+        }>;
+        code: z.ZodEnum<{
+            BILLING_ACCOUNT_HOLD: "BILLING_ACCOUNT_HOLD";
+            BILLING_DISPUTE: "BILLING_DISPUTE";
+            BILLING_LINKED_UNPAID_BALANCE: "BILLING_LINKED_UNPAID_BALANCE";
+            BILLING_PAYMENT_METHOD_REQUIRED: "BILLING_PAYMENT_METHOD_REQUIRED";
+            BILLING_UNPAID_INVOICE: "BILLING_UNPAID_INVOICE";
+        }>;
+        message: z.ZodString;
+        linked: z.ZodBoolean;
+        paymentMethodRequired: z.ZodBoolean;
+        since: z.ZodDate;
+        blocking: z.ZodBoolean;
+        invoices: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            number: z.ZodNullable<z.ZodString>;
+            status: z.ZodString;
+            amountRemaining: z.ZodNumber;
+            currency: z.ZodString;
+            created: z.ZodNumber;
+            dueDate: z.ZodNullable<z.ZodNumber>;
+            attemptCount: z.ZodNumber;
+            nextPaymentAttempt: z.ZodNullable<z.ZodNumber>;
+            hostedInvoiceUrl: z.ZodNullable<z.ZodString>;
+            collectionMethod: z.ZodString;
+        }, z.core.$strip>>;
+        dispute: z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+            status: z.ZodString;
+            amount: z.ZodNumber;
+            currency: z.ZodString;
+            reason: z.ZodString;
+            created: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, Record<never, never>, Record<never, never>>;
 //# sourceMappingURL=billing.d.ts.map

package/.tsc/lib/contract/gateway/router/billing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"billing.d.ts","sourceRoot":"","sources":["../../../../../lib/contract/gateway/router/billing.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,eAAO,MAAM,MAAM;;2EAEC,CAAC;AAErB,eAAO,MAAM,MAAM;;;;;;;;;;;;0FAgBY,CAAC"}
+{"version":3,"file":"billing.d.ts","sourceRoot":"","sources":["../../../../../lib/contract/gateway/router/billing.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,eAAO,MAAM,MAAM;;2EAEC,CAAC;AAErB,eAAO,MAAM,MAAM;;;;;;;;;;;;0FAgBY,CAAC;AAgBhC,mFAAmF;AACnF,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8DAoChB,CAAC"}

package/.tsc/lib/contract/gateway/router/billing.js

@@ -1,5 +1,6 @@
 import { oc } from "@orpc/contract";
 import * as z from "zod";
+import { billingHoldErrorCodes } from "../../../billing-hold-error-codes.js";
 export const manage = oc
     .input(z.object({ returnURL: z.string() }))
     .output(z.string());
@@ -18,3 +19,52 @@ export const update = oc
     path: ["plan", "annual"],
 }))
     .output(z.string().optional());
+const billingHoldInvoice = z.object({
+    id: z.string(),
+    number: z.string().nullable(),
+    status: z.string(),
+    amountRemaining: z.number(),
+    currency: z.string(),
+    created: z.number(),
+    dueDate: z.number().nullable(),
+    attemptCount: z.number(),
+    nextPaymentAttempt: z.number().nullable(),
+    hostedInvoiceUrl: z.string().nullable(),
+    collectionMethod: z.string(),
+});
+/** The workspace's billing hold (unpaid invoices or a payment dispute), if any. */
+export const hold = oc.output(z.object({
+    mode: z.enum(["off", "shadow", "enforce"]),
+    hold: z
+        .object({
+        reason: z.enum([
+            "dispute",
+            "dispute_lost",
+            "uncollectible",
+            "payment_failed",
+            "unpaid_invoice",
+            "overdue_invoice",
+            "canceled_unpaid",
+            "linked_unpaid",
+            "manual",
+        ]),
+        code: z.enum(billingHoldErrorCodes),
+        message: z.string(),
+        linked: z.boolean(),
+        paymentMethodRequired: z.boolean(),
+        since: z.date(),
+        blocking: z.boolean(),
+        invoices: z.array(billingHoldInvoice),
+        dispute: z
+            .object({
+            id: z.string(),
+            status: z.string(),
+            amount: z.number(),
+            currency: z.string(),
+            reason: z.string(),
+            created: z.number(),
+        })
+            .nullable(),
+    })
+        .nullable(),
+}));

package/.tsc/lib/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./api-source.js";
+export * from "./billing-hold-error-codes.js";
 export * from "./date.js";
 export * from "./dedicated-instance-monthly-credits.js";
 export * from "./environment.js";

package/.tsc/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,sCAAsC,CAAC;AACrD,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,QAAQ,CAAC;AACvB,cAAc,sCAAsC,CAAC;AACrD,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC"}

package/.tsc/lib/index.js

@@ -1,4 +1,5 @@
 export * from "./api-source.js";
+export * from "./billing-hold-error-codes.js";
 export * from "./date.js";
 export * from "./dedicated-instance-monthly-credits.js";
 export * from "./environment.js";

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @pdfvector/util
 
+## 0.5.0
+
+### Minor Changes
+
+- [#507](https://github.com/phuctm97/pdfvector/pull/507) [`fbe51ca`](https://github.com/phuctm97/pdfvector/commit/fbe51ca228221c31d36565b14c284c1259ddcef1) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Billing holds: workspaces with unpaid invoices, payment disputes or a card/sign-in linked to another account's unpaid balance are blocked with HTTP 402 and a stable code (`BILLING_UNPAID_INVOICE`, `BILLING_DISPUTE`, `BILLING_PAYMENT_METHOD_REQUIRED`, `BILLING_LINKED_UNPAID_BALANCE`, `BILLING_ACCOUNT_HOLD`), cannot resubscribe until paid, and see their invoices with Pay buttons in billing. Out-of-credit errors now carry `CREDITS_EXHAUSTED`. Holds come from webhooks plus an hourly sweep, never from Stripe calls on the request path.
+
 ## 0.4.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfvector/util",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "type": "module",
   "main": "./.tsc/lib/index.js",
   "exports": {