@peable.to/contracts 0.4.0 → 1.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@peable.to/contracts",
-  "version": "0.4.0",
-  "description": "Validated Peable contribution-link contracts",
+  "version": "1.1.0",
+  "description": "The Peable wire, declared once: Zod contracts of every public route, the OpenAPI 3.1 generator and the closed value sets (ADR 0014 D5).",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -24,26 +24,53 @@
       },
       "default": "./dist/esm/index.js"
     },
-    "./package.json": "./package.json",
+    "./vocabulary": {
+      "react-native": "./dist/esm/vocabulary/index.js",
+      "import": {
+        "types": "./dist/types/vocabulary/index.d.ts",
+        "default": "./dist/esm/vocabulary/index.js"
+      },
+      "require": {
+        "types": "./dist/types/vocabulary/index.d.ts",
+        "default": "./dist/cjs/vocabulary/index.js"
+      },
+      "default": "./dist/esm/vocabulary/index.js"
+    },
+    "./contributions": {
+      "react-native": "./dist/esm/contributions.js",
+      "import": {
+        "types": "./dist/types/contributions.d.ts",
+        "default": "./dist/esm/contributions.js"
+      },
+      "require": {
+        "types": "./dist/types/contributions.d.ts",
+        "default": "./dist/cjs/contributions.js"
+      },
+      "default": "./dist/esm/contributions.js"
+    },
     "./openapi": {
+      "react-native": "./dist/esm/openapi/index.js",
       "import": {
-        "types": "./dist/types/openapi.d.ts",
-        "default": "./dist/esm/openapi.js"
+        "types": "./dist/types/openapi/index.d.ts",
+        "default": "./dist/esm/openapi/index.js"
       },
       "require": {
-        "types": "./dist/types/openapi.d.ts",
-        "default": "./dist/cjs/openapi.js"
-      }
-    }
+        "types": "./dist/types/openapi/index.d.ts",
+        "default": "./dist/cjs/openapi/index.js"
+      },
+      "default": "./dist/esm/openapi/index.js"
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "dist"
   ],
   "keywords": [
     "peable",
-    "gateway",
     "payments",
-    "types"
+    "openapi",
+    "zod",
+    "contracts"
   ],
   "repository": {
     "type": "git",
@@ -73,5 +100,18 @@
   },
   "dependencies": {
     "zod": "^4.6.7"
+  },
+  "typesVersions": {
+    "*": {
+      "vocabulary": [
+        "./dist/types/vocabulary/index.d.ts"
+      ],
+      "contributions": [
+        "./dist/types/contributions.d.ts"
+      ],
+      "openapi": [
+        "./dist/types/openapi/index.d.ts"
+      ]
+    }
   }
 }

package/dist/cjs/openapi.js

@@ -1,165 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.contributionRoutes = void 0;
-exports.contributionOpenApi = contributionOpenApi;
-const zod_1 = require("zod");
-const index_1 = require("./index");
-const requestIdHeader = {
-    'Request-Id': {
-        description: 'Identifies this request to Peable support.',
-        schema: { type: 'string' },
-    },
-};
-const path = '/v1/organizations/{organizationId}/applications/{applicationId}/contributions';
-exports.contributionRoutes = [
-    {
-        method: 'post',
-        path,
-        operationId: 'createContribution',
-        idempotencyKey: true,
-        body: index_1.createContributionSchema,
-        response: index_1.contributionLinkSchema,
-        status: 201,
-    },
-    {
-        method: 'get',
-        path,
-        operationId: 'listContributions',
-        response: index_1.contributionListSchema,
-        status: 200,
-    },
-    {
-        method: 'post',
-        path: `${path}/{id}`,
-        operationId: 'setContributionActive',
-        body: index_1.contributionPatchSchema,
-        response: index_1.contributionLinkSchema,
-        status: 200,
-    },
-    {
-        method: 'get',
-        path: `${path}/{id}/collections`,
-        operationId: 'listContributionCollections',
-        response: index_1.contributionCollectionListSchema,
-        status: 200,
-    },
-];
-function contributionOpenApi() {
-    var _a;
-    const paths = {};
-    for (const route of exports.contributionRoutes) {
-        paths[_a = route.path] ?? (paths[_a] = {});
-        const parameters = [...route.path.matchAll(/\{([^}]+)\}/g)].map((match) => ({
-            in: 'path',
-            name: match[1],
-            required: true,
-            schema: { type: 'string' },
-        }));
-        parameters.push({
-            in: 'query',
-            name: 'environment',
-            required: true,
-            schema: { type: 'string', enum: ['development', 'staging', 'production'] },
-        });
-        if (route.method === 'get')
-            parameters.push({
-                in: 'query',
-                name: 'limit',
-                schema: { type: 'integer', minimum: 1, maximum: 100, default: 10 },
-            }, {
-                in: 'query',
-                name: 'starting_after',
-                description: 'The id of the last object on the previous page.',
-                schema: { type: 'string' },
-            }, {
-                in: 'query',
-                name: 'ending_before',
-                description: 'The id of the first object on the current page; pages backwards, newest first.',
-                schema: { type: 'string' },
-            }, {
-                in: 'query',
-                name: 'created',
-                description: 'Unix seconds: one second, or `created[gt|gte|lt|lte]`.',
-                style: 'deepObject',
-                explode: true,
-                schema: {
-                    oneOf: [
-                        { type: 'integer', minimum: 0 },
-                        {
-                            type: 'object',
-                            additionalProperties: false,
-                            properties: {
-                                gt: { type: 'integer', minimum: 0 },
-                                gte: { type: 'integer', minimum: 0 },
-                                lt: { type: 'integer', minimum: 0 },
-                                lte: { type: 'integer', minimum: 0 },
-                            },
-                        },
-                    ],
-                },
-            });
-        if ('idempotencyKey' in route)
-            parameters.push({
-                in: 'header',
-                name: 'Idempotency-Key',
-                required: true,
-                schema: { type: 'string', format: 'uuid' },
-            });
-        paths[route.path][route.method] = {
-            operationId: route.operationId,
-            security: [{ oxySession: [] }],
-            parameters,
-            ...('body' in route
-                ? {
-                    requestBody: {
-                        required: true,
-                        content: { 'application/json': { schema: zod_1.z.toJSONSchema(route.body) } },
-                    },
-                }
-                : {}),
-            responses: {
-                [route.status]: {
-                    description: 'Success',
-                    headers: requestIdHeader,
-                    content: { 'application/json': { schema: zod_1.z.toJSONSchema(route.response) } },
-                },
-                default: {
-                    description: 'Peable error envelope; HTTP status identifies failure',
-                    headers: requestIdHeader,
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'object',
-                                required: ['error'],
-                                properties: {
-                                    error: {
-                                        type: 'object',
-                                        required: ['type', 'message', 'request_id'],
-                                        properties: {
-                                            type: { type: 'string' },
-                                            code: { type: 'string' },
-                                            param: { type: 'string' },
-                                            message: { type: 'string' },
-                                            request_id: { type: ['string', 'null'] },
-                                        },
-                                    },
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-        };
-    }
-    return {
-        openapi: '3.1.0',
-        info: {
-            title: 'Peable organization contributions',
-            version: '0.2.0',
-            description: 'One-off links. Human Oxy session for management; existing /v1/payment_links/{id}/public and /payment_intent remain anonymous. Fixed/free amounts use FAIR base units (8 decimals); the registered merchant determines the network. Refunds cannot be created by the watch-only gateway. No recurring billing.',
-        },
-        servers: [{ url: 'https://api.peable.to' }],
-        components: { securitySchemes: { oxySession: { type: 'http', scheme: 'bearer' } } },
-        paths,
-    };
-}

package/dist/esm/openapi.js

@@ -1,161 +0,0 @@
-import { z } from 'zod';
-import { createContributionSchema, contributionLinkSchema, contributionListSchema, contributionCollectionListSchema, contributionPatchSchema, } from './index.js';
-const requestIdHeader = {
-    'Request-Id': {
-        description: 'Identifies this request to Peable support.',
-        schema: { type: 'string' },
-    },
-};
-const path = '/v1/organizations/{organizationId}/applications/{applicationId}/contributions';
-export const contributionRoutes = [
-    {
-        method: 'post',
-        path,
-        operationId: 'createContribution',
-        idempotencyKey: true,
-        body: createContributionSchema,
-        response: contributionLinkSchema,
-        status: 201,
-    },
-    {
-        method: 'get',
-        path,
-        operationId: 'listContributions',
-        response: contributionListSchema,
-        status: 200,
-    },
-    {
-        method: 'post',
-        path: `${path}/{id}`,
-        operationId: 'setContributionActive',
-        body: contributionPatchSchema,
-        response: contributionLinkSchema,
-        status: 200,
-    },
-    {
-        method: 'get',
-        path: `${path}/{id}/collections`,
-        operationId: 'listContributionCollections',
-        response: contributionCollectionListSchema,
-        status: 200,
-    },
-];
-export function contributionOpenApi() {
-    var _a;
-    const paths = {};
-    for (const route of contributionRoutes) {
-        paths[_a = route.path] ?? (paths[_a] = {});
-        const parameters = [...route.path.matchAll(/\{([^}]+)\}/g)].map((match) => ({
-            in: 'path',
-            name: match[1],
-            required: true,
-            schema: { type: 'string' },
-        }));
-        parameters.push({
-            in: 'query',
-            name: 'environment',
-            required: true,
-            schema: { type: 'string', enum: ['development', 'staging', 'production'] },
-        });
-        if (route.method === 'get')
-            parameters.push({
-                in: 'query',
-                name: 'limit',
-                schema: { type: 'integer', minimum: 1, maximum: 100, default: 10 },
-            }, {
-                in: 'query',
-                name: 'starting_after',
-                description: 'The id of the last object on the previous page.',
-                schema: { type: 'string' },
-            }, {
-                in: 'query',
-                name: 'ending_before',
-                description: 'The id of the first object on the current page; pages backwards, newest first.',
-                schema: { type: 'string' },
-            }, {
-                in: 'query',
-                name: 'created',
-                description: 'Unix seconds: one second, or `created[gt|gte|lt|lte]`.',
-                style: 'deepObject',
-                explode: true,
-                schema: {
-                    oneOf: [
-                        { type: 'integer', minimum: 0 },
-                        {
-                            type: 'object',
-                            additionalProperties: false,
-                            properties: {
-                                gt: { type: 'integer', minimum: 0 },
-                                gte: { type: 'integer', minimum: 0 },
-                                lt: { type: 'integer', minimum: 0 },
-                                lte: { type: 'integer', minimum: 0 },
-                            },
-                        },
-                    ],
-                },
-            });
-        if ('idempotencyKey' in route)
-            parameters.push({
-                in: 'header',
-                name: 'Idempotency-Key',
-                required: true,
-                schema: { type: 'string', format: 'uuid' },
-            });
-        paths[route.path][route.method] = {
-            operationId: route.operationId,
-            security: [{ oxySession: [] }],
-            parameters,
-            ...('body' in route
-                ? {
-                    requestBody: {
-                        required: true,
-                        content: { 'application/json': { schema: z.toJSONSchema(route.body) } },
-                    },
-                }
-                : {}),
-            responses: {
-                [route.status]: {
-                    description: 'Success',
-                    headers: requestIdHeader,
-                    content: { 'application/json': { schema: z.toJSONSchema(route.response) } },
-                },
-                default: {
-                    description: 'Peable error envelope; HTTP status identifies failure',
-                    headers: requestIdHeader,
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'object',
-                                required: ['error'],
-                                properties: {
-                                    error: {
-                                        type: 'object',
-                                        required: ['type', 'message', 'request_id'],
-                                        properties: {
-                                            type: { type: 'string' },
-                                            code: { type: 'string' },
-                                            param: { type: 'string' },
-                                            message: { type: 'string' },
-                                            request_id: { type: ['string', 'null'] },
-                                        },
-                                    },
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-        };
-    }
-    return {
-        openapi: '3.1.0',
-        info: {
-            title: 'Peable organization contributions',
-            version: '0.2.0',
-            description: 'One-off links. Human Oxy session for management; existing /v1/payment_links/{id}/public and /payment_intent remain anonymous. Fixed/free amounts use FAIR base units (8 decimals); the registered merchant determines the network. Refunds cannot be created by the watch-only gateway. No recurring billing.',
-        },
-        servers: [{ url: 'https://api.peable.to' }],
-        components: { securitySchemes: { oxySession: { type: 'http', scheme: 'bearer' } } },
-        paths,
-    };
-}

package/dist/types/openapi.d.ts

@@ -1,148 +0,0 @@
-import { z } from 'zod';
-export declare const contributionRoutes: readonly [{
-    readonly method: "post";
-    readonly path: "/v1/organizations/{organizationId}/applications/{applicationId}/contributions";
-    readonly operationId: "createContribution";
-    readonly idempotencyKey: true;
-    readonly body: 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>;
-    readonly response: 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>;
-    readonly status: 201;
-}, {
-    readonly method: "get";
-    readonly path: "/v1/organizations/{organizationId}/applications/{applicationId}/contributions";
-    readonly operationId: "listContributions";
-    readonly response: 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;
-        url: z.ZodString;
-    }, z.core.$strict>;
-    readonly status: 200;
-}, {
-    readonly method: "post";
-    readonly path: "/v1/organizations/{organizationId}/applications/{applicationId}/contributions/{id}";
-    readonly operationId: "setContributionActive";
-    readonly body: z.ZodObject<{
-        active: z.ZodBoolean;
-    }, z.core.$strict>;
-    readonly response: 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>;
-    readonly status: 200;
-}, {
-    readonly method: "get";
-    readonly path: "/v1/organizations/{organizationId}/applications/{applicationId}/contributions/{id}/collections";
-    readonly operationId: "listContributionCollections";
-    readonly response: 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;
-        url: z.ZodString;
-    }, z.core.$strict>;
-    readonly status: 200;
-}];
-export declare function contributionOpenApi(): {
-    openapi: string;
-    info: {
-        title: string;
-        version: string;
-        description: string;
-    };
-    servers: {
-        url: string;
-    }[];
-    components: {
-        securitySchemes: {
-            oxySession: {
-                type: string;
-                scheme: string;
-            };
-        };
-    };
-    paths: Record<string, Record<string, unknown>>;
-};