@onabl/contracts 0.1.1 → 0.2.0

package/README.md

@@ -1 +1,21 @@
-# `contracts`
+# `@onabl/contracts`
+
+Zod schemas for onabl's public API — the request/response contract used by
+`@onabl/js`. You won't normally install this directly; it comes in as a
+dependency of `@onabl/js`, `@onabl/react`, or `@onabl/next`.
+
+Install it directly only if you're validating onabl API payloads outside
+the SDK (e.g. in your own backend, without going through `@onabl/js`):
+
+```bash
+npm install @onabl/contracts
+```
+
+```ts
+import {PublicFormSchema, QuoteSchema} from "@onabl/contracts/public-api";
+
+const form = PublicFormSchema.parse(rawResponseBody);
+```
+
+Schemas are grouped by resource under `@onabl/contracts/public-api` (forms,
+submissions, quotes, invoices, discount codes).

package/dist/common.d.ts

@@ -8,6 +8,17 @@ export declare const SearchPaginationQuerySchema: z.ZodObject<{
     offset: z.ZodDefault<z.ZodOptional<z.ZodCoercedNumber<unknown>>>;
     search: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+export declare const WebhookDeliveryQuerySchema: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodOptional<z.ZodCoercedNumber<unknown>>>;
+    offset: z.ZodDefault<z.ZodOptional<z.ZodCoercedNumber<unknown>>>;
+    event: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodEnum<{
+        delivered: "delivered";
+        pending: "pending";
+        failed: "failed";
+    }>>;
+}, z.core.$strip>;
 export type PaginationQuery = z.infer<typeof PaginationQuerySchema>;
 export type SearchPaginationQuery = z.infer<typeof SearchPaginationQuerySchema>;
+export type WebhookDeliveryQuery = z.infer<typeof WebhookDeliveryQuerySchema>;
 //# sourceMappingURL=common.d.ts.map

package/dist/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAEtB,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;iBAEtC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAEtB,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;iBAEtC,CAAC;AAKH,eAAO,MAAM,0BAA0B;;;;;;;;;iBAGrC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAChF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC"}

package/dist/common.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchPaginationQuerySchema = exports.PaginationQuerySchema = void 0;
+exports.WebhookDeliveryQuerySchema = exports.SearchPaginationQuerySchema = exports.PaginationQuerySchema = void 0;
 const zod_1 = require("zod");
 exports.PaginationQuerySchema = zod_1.z.object({
     limit: zod_1.z.coerce.number().int().min(1).max(100).optional().default(50),
@@ -9,3 +9,10 @@ exports.PaginationQuerySchema = zod_1.z.object({
 exports.SearchPaginationQuerySchema = exports.PaginationQuerySchema.extend({
     search: zod_1.z.string().optional(),
 });
+// §14.3 — dashboard delivery log filters. "status" mirrors the tri-state the
+// UI actually shows (delivered / pending-retry / permanently failed), not the
+// raw column names on WebhookDelivery.
+exports.WebhookDeliveryQuerySchema = exports.PaginationQuerySchema.extend({
+    event: zod_1.z.string().optional(),
+    status: zod_1.z.enum(["delivered", "pending", "failed"]).optional(),
+});

package/dist/forms.d.ts

@@ -23,7 +23,7 @@ export declare const FormConfigSchema: z.ZodObject<{
     steps: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         label: z.ZodString;
-        title: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
     fields: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
@@ -69,6 +69,7 @@ export declare const UpdateFormConfigSchema: z.ZodObject<{
     depositDueDays: z.ZodOptional<z.ZodNumber>;
     balanceDueDays: z.ZodOptional<z.ZodNumber>;
     websiteBaseUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    invoiceBaseUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 export type CreateForm = z.infer<typeof CreateFormSchema>;
 export type UpdateFormConfig = z.infer<typeof UpdateFormConfigSchema>;

package/dist/forms.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"forms.d.ts","sourceRoot":"","sources":["../src/forms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AACtB,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,qBAAqB,CAAC;AA4BpD,eAAO,MAAM,oBAAoB;;;;;;;;iBAUjB,CAAC;AAEjB,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkBb,CAAC;AAEjB,eAAO,MAAM,gBAAgB;;;iBAG3B,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;iBAWjC,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC"}
+{"version":3,"file":"forms.d.ts","sourceRoot":"","sources":["../src/forms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AACtB,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,qBAAqB,CAAC;AA4BpD,eAAO,MAAM,oBAAoB;;;;;;;;iBAUjB,CAAC;AAEjB,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkBb,CAAC;AAEjB,eAAO,MAAM,gBAAgB;;;iBAG3B,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;iBAcjC,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC"}

package/dist/forms.js

@@ -40,7 +40,7 @@ exports.FormConfigSchema = zod_1.z
     .object({
     version: zod_1.z.literal("1.0"),
     meta: exports.FormConfigMetaSchema,
-    steps: zod_1.z.array(zod_1.z.object({ id: zod_1.z.string(), label: zod_1.z.string(), title: zod_1.z.string().optional() })),
+    steps: zod_1.z.array(zod_1.z.object({ id: zod_1.z.string(), label: zod_1.z.string(), description: zod_1.z.string().optional() })),
     fields: zod_1.z.array(FormFieldSchema),
     rules: zod_1.z.object({
         phase1: zod_1.z.array(PricingRuleSchema),
@@ -66,8 +66,11 @@ exports.UpdateFormConfigSchema = zod_1.z.object({
     depositPercent: zod_1.z.number().int().min(1).max(99).nullable().optional(),
     depositDueDays: zod_1.z.number().int().min(1).max(365).optional(),
     balanceDueDays: zod_1.z.number().int().min(1).max(365).optional(),
-    // When set, customer quote/invoice emails link to this domain (client.com/quote/:uuid,
-    // client.com/invoice/:uuid) instead of Onabl's hosted pages. Pass null to clear back to
+    // The tenant's own quote-view page (e.g. https://client.com/get-a-quote) — when set,
+    // customer quote emails and dashboard links point at `${websiteBaseUrl}/:uuid` instead of
+    // Onabl's hosted /q/:handle/:slug/quote/:uuid page. Pass null to clear back to
     // Onabl-hosted, matching the depositPercent nullable-clear pattern above.
     websiteBaseUrl: zod_1.z.string().url().nullable().optional(),
+    // Same idea, for the invoice-view page — separate field since it's rarely the same path.
+    invoiceBaseUrl: zod_1.z.string().url().nullable().optional(),
 });

package/dist/public-api.d.ts

@@ -49,7 +49,7 @@ export declare const PublicFormConfigSchema: z.ZodObject<{
     steps: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         label: z.ZodString;
-        title: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
     }, z.core.$loose>>;
     fields: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
@@ -120,7 +120,7 @@ export declare const PublicFormSchema: z.ZodObject<{
         steps: z.ZodArray<z.ZodObject<{
             id: z.ZodString;
             label: z.ZodString;
-            title: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
         }, z.core.$loose>>;
         fields: z.ZodArray<z.ZodObject<{
             id: z.ZodString;

package/dist/public-api.js

@@ -69,7 +69,7 @@ exports.PublicFormConfigSchema = zod_1.z
             .optional(),
     })
         .passthrough(),
-    steps: zod_1.z.array(zod_1.z.object({ id: zod_1.z.string(), label: zod_1.z.string(), title: zod_1.z.string().optional() }).passthrough()),
+    steps: zod_1.z.array(zod_1.z.object({ id: zod_1.z.string(), label: zod_1.z.string(), description: zod_1.z.string().optional() }).passthrough()),
     fields: zod_1.z.array(exports.PublicFormFieldSchema),
 })
     .passthrough();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onabl/contracts",
-  "version": "0.1.1",
+  "version": "0.2.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.1.0"
+    "@onabl/types": "0.2.0"
   },
   "peerDependencies": {
     "zod": "^4"