@peable.to/contracts 0.3.0 → 1.0.0

package/dist/types/common/primitives.d.ts

@@ -0,0 +1,56 @@
+import { z } from 'zod';
+/**
+ * The house style's primitives (ADR 0014 D1), as RESPONSE schemas: what the
+ * gateway emits. Request-side building blocks (coercing query integers,
+ * `expand[]`, metadata patches) are in `params.ts`.
+ */
+/** Every instant on the wire: integer Unix seconds. */
+export declare const unixSeconds: z.ZodNumber;
+/** A base-unit amount: an integer string in the currency's smallest unit (a FAIR amount does not fit a JS number). */
+export declare const amount: z.ZodString;
+/** A signed base-unit amount (a customer balance, a balance transaction's net). */
+export declare const signedAmount: z.ZodString;
+/** An uppercase ISO 4217 code, or `FAIR`. */
+export declare const currency: z.ZodEnum<{
+    FAIR: "FAIR";
+    EUR: "EUR";
+    USD: "USD";
+    GBP: "GBP";
+    CHF: "CHF";
+    SEK: "SEK";
+    NOK: "NOK";
+    DKK: "DKK";
+    PLN: "PLN";
+    CZK: "CZK";
+    CAD: "CAD";
+    AUD: "AUD";
+    JPY: "JPY";
+}>;
+/** A currency the card rail can denominate in. */
+export declare const fiatCurrency: z.ZodEnum<{
+    EUR: "EUR";
+    USD: "USD";
+    GBP: "GBP";
+    CHF: "CHF";
+    SEK: "SEK";
+    NOK: "NOK";
+    DKK: "DKK";
+    PLN: "PLN";
+    CZK: "CZK";
+    CAD: "CAD";
+    AUD: "AUD";
+    JPY: "JPY";
+}>;
+/** The FairCoin network. */
+export declare const network: z.ZodEnum<{
+    mainnet: "mainnet";
+    testnet: "testnet";
+}>;
+/** Whether the object exists in live mode (`false`: test mode). */
+export declare const livemode: z.ZodBoolean;
+/** The merchant's own key/value bag, as returned. */
+export declare const metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+/** A nullable string — the shape of every optional text field on a response. */
+export declare const nullableString: z.ZodNullable<z.ZodString>;
+/** A literal `object` discriminator. */
+export declare const objectName: <T extends string>(name: T) => z.ZodLiteral<T>;

package/dist/types/contributions.d.ts

@@ -0,0 +1 @@
+export { type ContributionCollection, type ContributionCollectionList, type ContributionDetails, type ContributionLink, type ContributionList, type CreateContribution, contributionAmountSchema, contributionCollectionListSchema, contributionCollectionSchema, contributionDetailsSchema, contributionLinkSchema, contributionListSchema, contributionMintSchema, contributionOperationKeySchema, contributionPageQuerySchema, contributionPatchSchema, contributionScopeQuerySchema, createContributionSchema, decimalContributionAmount, formatContributionAmount, } from './resources/checkout/contributions';

package/dist/types/index.d.ts

@@ -1,134 +1,16 @@
-import { z } from 'zod';
-export declare const contributionAmountSchema: z.ZodString;
-export declare const contributionDetailsSchema: z.ZodObject<{
-    organization_id: z.ZodString;
-    purpose: z.ZodString;
-    amount_mode: z.ZodEnum<{
-        fixed: "fixed";
-        free: "free";
-    }>;
-    expires_at: z.ZodNullable<z.ZodNumber>;
-}, z.core.$strict>;
-export type ContributionDetails = z.infer<typeof contributionDetailsSchema>;
-export declare const createContributionSchema: z.ZodObject<{
-    purpose: z.ZodString;
-    amount_mode: z.ZodEnum<{
-        fixed: "fixed";
-        free: "free";
-    }>;
-    amount: z.ZodOptional<z.ZodString>;
-    currency: z.ZodLiteral<"FAIR">;
-    expires_at: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-}, z.core.$strict>;
-export type CreateContribution = z.infer<typeof createContributionSchema>;
-export declare const contributionLinkSchema: z.ZodObject<{
-    id: z.ZodString;
-    object: z.ZodLiteral<"payment_link">;
-    amount: z.ZodString;
-    currency: z.ZodLiteral<"FAIR">;
-    network: z.ZodEnum<{
-        mainnet: "mainnet";
-        testnet: "testnet";
-    }>;
-    active: z.ZodBoolean;
-    url: z.ZodURL;
-    contribution: z.ZodObject<{
-        organization_id: z.ZodString;
-        purpose: z.ZodString;
-        amount_mode: z.ZodEnum<{
-            fixed: "fixed";
-            free: "free";
-        }>;
-        expires_at: z.ZodNullable<z.ZodNumber>;
-    }, z.core.$strict>;
-    created: z.ZodNumber;
-}, z.core.$strict>;
-export type ContributionLink = z.infer<typeof contributionLinkSchema>;
-export declare const contributionListSchema: z.ZodObject<{
-    object: z.ZodLiteral<"list">;
-    data: z.ZodArray<z.ZodObject<{
-        id: z.ZodString;
-        object: z.ZodLiteral<"payment_link">;
-        amount: z.ZodString;
-        currency: z.ZodLiteral<"FAIR">;
-        network: z.ZodEnum<{
-            mainnet: "mainnet";
-            testnet: "testnet";
-        }>;
-        active: z.ZodBoolean;
-        url: z.ZodURL;
-        contribution: z.ZodObject<{
-            organization_id: z.ZodString;
-            purpose: z.ZodString;
-            amount_mode: z.ZodEnum<{
-                fixed: "fixed";
-                free: "free";
-            }>;
-            expires_at: z.ZodNullable<z.ZodNumber>;
-        }, z.core.$strict>;
-        created: z.ZodNumber;
-    }, z.core.$strict>>;
-    has_more: z.ZodBoolean;
-}, z.core.$strict>;
-export type ContributionList = z.infer<typeof contributionListSchema>;
-export declare const contributionCollectionSchema: z.ZodObject<{
-    id: z.ZodString;
-    object: z.ZodLiteral<"payment_intent">;
-    amount: z.ZodString;
-    currency: z.ZodLiteral<"FAIR">;
-    status: z.ZodString;
-    created: z.ZodNumber;
-    refund_capability: z.ZodLiteral<"unsupported_non_custodial">;
-    refunds: z.ZodArray<z.ZodObject<{
-        id: z.ZodString;
-        object: z.ZodLiteral<"refund">;
-        amount: z.ZodString;
-        status: z.ZodString;
-        created: z.ZodNumber;
-    }, z.core.$strict>>;
-}, z.core.$strict>;
-export type ContributionCollection = z.infer<typeof contributionCollectionSchema>;
-export declare const contributionCollectionListSchema: z.ZodObject<{
-    object: z.ZodLiteral<"list">;
-    data: z.ZodArray<z.ZodObject<{
-        id: z.ZodString;
-        object: z.ZodLiteral<"payment_intent">;
-        amount: z.ZodString;
-        currency: z.ZodLiteral<"FAIR">;
-        status: z.ZodString;
-        created: z.ZodNumber;
-        refund_capability: z.ZodLiteral<"unsupported_non_custodial">;
-        refunds: z.ZodArray<z.ZodObject<{
-            id: z.ZodString;
-            object: z.ZodLiteral<"refund">;
-            amount: z.ZodString;
-            status: z.ZodString;
-            created: z.ZodNumber;
-        }, z.core.$strict>>;
-    }, z.core.$strict>>;
-    has_more: z.ZodBoolean;
-}, z.core.$strict>;
-/**
- * Paging: `starting_after` is the public id of the last object of the previous
- * page (`link_…` for links, `pi_…` for collections), resolved by the gateway
- * inside the caller's organization, application and environment.
- */
-export declare const contributionPageQuerySchema: z.ZodObject<{
-    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
-    starting_after: z.ZodOptional<z.ZodString>;
-    environment: z.ZodEnum<{
-        development: "development";
-        staging: "staging";
-        production: "production";
-    }>;
-}, z.core.$strict>;
-export declare const contributionMintSchema: z.ZodObject<{
-    amount: z.ZodOptional<z.ZodString>;
-}, z.core.$strict>;
-export declare const contributionOperationKeySchema: z.ZodString;
-export declare const contributionPatchSchema: z.ZodObject<{
-    active: z.ZodBoolean;
-}, z.core.$strict>;
-export declare function decimalContributionAmount(value: string): string;
-export declare function formatContributionAmount(value: string): string;
-export type ContributionCollectionList = z.infer<typeof contributionCollectionListSchema>;
+export * from './common/address';
+export * from './common/envelopes';
+export * from './common/objects';
+export * from './common/params';
+export * from './common/primitives';
+export * from './route';
+export * from './routes';
+export * from './vocabulary';
+export * from './resources/core';
+export * from './resources/payments';
+export * from './resources/checkout';
+export * from './resources/catalog';
+export * from './resources/billingEngine';
+export * from './resources/connect';
+export * from './resources/tax';
+export * from './resources/events';

package/dist/types/openapi/document.d.ts

@@ -0,0 +1,16 @@
+export interface OpenApiDocument {
+    openapi: '3.1.0';
+    info: Record<string, unknown>;
+    servers: {
+        url: string;
+        description: string;
+    }[];
+    tags: {
+        name: string;
+    }[];
+    paths: Record<string, Record<string, unknown>>;
+    webhooks: Record<string, unknown>;
+    components: Record<string, unknown>;
+}
+/** Generate the whole document. Pure: the same contracts give the same bytes. */
+export declare function buildOpenApiDocument(): OpenApiDocument;

package/dist/types/openapi/index.d.ts

@@ -0,0 +1,2 @@
+export { buildOpenApiDocument, type OpenApiDocument } from './document';
+export { webhookEvents, type WebhookEventContract } from './webhooks';

package/dist/types/openapi/webhooks.d.ts

@@ -0,0 +1,15 @@
+import type { z } from 'zod';
+/** One webhook event type as the OpenAPI `webhooks` section documents it. */
+export interface WebhookEventContract {
+    /** `payment_intent.succeeded`. */
+    readonly type: string;
+    readonly description?: string;
+    /** The whole envelope (`Event`) with `data.object` narrowed to this type's object. */
+    readonly schema: z.ZodType;
+}
+/**
+ * Every event type the gateway emits, with its payload: one entry per member
+ * of `WEBHOOK_EVENT_TYPES`, its body the `Event` envelope with `type` fixed and
+ * `data.object` the object `WEBHOOK_EVENT_OBJECTS` names.
+ */
+export declare function webhookEvents(): readonly WebhookEventContract[];