@payabli/component-contracts 0.4.0 → 0.6.0

package/dist/aliases.d.ts

@@ -1,2 +1,4 @@
 import type { ComponentEventMap } from './registry.js';
 export type PayInEvents = ComponentEventMap<'payin'>;
+export type OnboardingEvents = ComponentEventMap<'onboarding'>;
+export type PayoutEvents = ComponentEventMap<'payout'>;

package/dist/generated.d.ts

@@ -1 +1,3 @@
+export * from './onboarding/definition.js';
 export * from './payin/definition.js';
+export * from './payout/definition.js';

package/dist/index.js

@@ -1669,6 +1669,27 @@ function getComponentDescriptor(type) {
     return descriptors.get(type);
 }
 
+/**
+ * Onboarding's wire contract. The boarding request owns all business data, so
+ * the browser sends no options yet. The SDK sends this in CONFIG_SET.options
+ * and payhub parses with this same object.
+ */
+const onboardingOptionsSchema = object({});
+/** Onboarding's own inbound events, beyond the base set every component shares. */
+const onboardingEvents = {};
+
+/** Wire type → emitter event. Onboarding emits only the base events for now. */
+const onboardingEventSchemas = {};
+const onboardingDescriptor = register({
+    type: 'onboarding',
+    displayName: 'Onboarding',
+    frameLabel: 'Onboarding form',
+    embedPath: '/embed/onboarding',
+    endsOnSuccess: false,
+    optionsSchema: onboardingOptionsSchema,
+    eventSchemas: onboardingEventSchemas,
+});
+
 /**
  * PayIn's wire contract: its event schemas, options schema, and vocabulary.
  * PayIn-specific on purpose — a payout component defines its own methods in
@@ -1771,7 +1792,6 @@ const payinEvents = {
         status: _enum(['verified', 'pending', 'failed', 'warning']),
         message: optional(string()),
     }),
-    VENDOR_CREATED: object({ vendorId: string() }),
 };
 
 /**
@@ -1796,20 +1816,79 @@ const payInEventSchemas = {
         event: 'validationStatus',
         schema: payinEvents.VALIDATION_STATUS,
     },
-    VENDOR_CREATED: {
-        event: 'vendorCreated',
-        schema: payinEvents.VENDOR_CREATED,
-    },
 };
 const payInDescriptor = register({
     type: 'payin',
     displayName: 'PayIn',
+    frameLabel: 'Payment form',
     embedPath: '/embed/payin',
     endsOnSuccess: true,
     optionsSchema: payinOptionsSchema,
     eventSchemas: payInEventSchemas,
 });
 
+/**
+ * Payout's wire contract: its event schemas, options schema, and vocabulary.
+ * Payout has its own methods. They do not share names with PayIn's.
+ */
+const PAYOUT_METHODS = [
+    'ach',
+    'check',
+    'vcard',
+    'wire',
+    'rtp',
+];
+/** Payout text keys. The iframe drops other keys, trims values, and limits text to 120 characters. */
+const PAYOUT_LABEL_KEYS = [
+    'submit',
+    'method-ach',
+    'method-check',
+    'method-vcard',
+    'method-wire',
+    'method-rtp',
+    'label.ach.holderName',
+    'placeholder.ach.holderName',
+    'label.ach.holderType',
+    'label.ach.accountType',
+    'label.ach.routingNumber',
+    'placeholder.ach.routingNumber',
+    'label.ach.accountNumber',
+    'placeholder.ach.accountNumber',
+    'label.vcard.code',
+];
+/**
+ * Client-side UI behavior only. The partner server sets operation, methods,
+ * vendorData, paymentDetails, invoiceData, and saveIfSuccess through
+ * `Session/init`. The SDK sends this in CONFIG_SET.options and payhub parses
+ * with this same object.
+ */
+const payoutOptionsSchema = object({
+    initialMethod: optional(_enum(PAYOUT_METHODS)
+        .check(describe('Select this method first when session-allowed. Otherwise, use the first method in the effective order.'))),
+    methodOrder: optional(array(_enum(PAYOUT_METHODS))
+        .check(describe('Order session-allowed methods only. Ignore disallowed entries and duplicates after the first occurrence. Append unlisted allowed methods in the PAYOUT_METHODS order.'))),
+    showSubmitButton: optional(boolean()
+        .check(describe('Render the submit button inside the component. Set false when the host page owns the button and calls submit().'))),
+});
+/** Payout's own inbound events, beyond the base set every component shares. */
+const payoutEvents = {
+    METHOD_CHANGE: object({ method: _enum(PAYOUT_METHODS) }),
+};
+
+/** Wire type → emitter event, with the shared schema from `./schema.js` as the only validator. */
+const payoutEventSchemas = {
+    METHOD_CHANGE: { event: 'methodChange', schema: payoutEvents.METHOD_CHANGE },
+};
+const payoutDescriptor = register({
+    type: 'payout',
+    displayName: 'Payout',
+    frameLabel: 'Payout form',
+    embedPath: '/embed/payout',
+    endsOnSuccess: false,
+    optionsSchema: payoutOptionsSchema,
+    eventSchemas: payoutEventSchemas,
+});
+
 const ErrorCodes = {
     LOAD_TIMEOUT: 'LOAD_TIMEOUT',
     PROTOCOL_ERROR: 'PROTOCOL_ERROR',
@@ -1851,4 +1930,4 @@ const BASE_COMPONENT_EVENT_NAMES = [
     'resize',
 ];
 
-export { BASE_COMPONENT_EVENT_NAMES, CARD_BRANDS, ErrorCodes, FORM_METHODS, MESSAGE_SOURCE, MESSAGE_VERSION, PAYIN_LABEL_KEYS, PAYMENT_METHODS, appearanceSchema, baseInboundEvents, componentDescriptors, componentErrorSchema, componentTypes, eventEnvelopeSchema, getComponentDescriptor, outboundMessages, parseEnvelope, parseMessage, parsePayload, payInDescriptor, payInEventSchemas, payinEvents, payinOptionsSchema, register };
+export { BASE_COMPONENT_EVENT_NAMES, CARD_BRANDS, ErrorCodes, FORM_METHODS, MESSAGE_SOURCE, MESSAGE_VERSION, PAYIN_LABEL_KEYS, PAYMENT_METHODS, PAYOUT_LABEL_KEYS, PAYOUT_METHODS, appearanceSchema, baseInboundEvents, componentDescriptors, componentErrorSchema, componentTypes, eventEnvelopeSchema, getComponentDescriptor, onboardingDescriptor, onboardingEventSchemas, onboardingEvents, onboardingOptionsSchema, outboundMessages, parseEnvelope, parseMessage, parsePayload, payInDescriptor, payInEventSchemas, payinEvents, payinOptionsSchema, payoutDescriptor, payoutEventSchemas, payoutEvents, payoutOptionsSchema, register };

package/dist/onboarding/definition.d.ts

@@ -0,0 +1,13 @@
+import type { Infer, InferEvents } from '../protocol/envelope.js';
+import { onboardingEvents, onboardingOptionsSchema } from './schema.js';
+export * from './schema.js';
+/** The partner-facing options type is the wire schema's type. */
+export type OnboardingOptions = Infer<typeof onboardingOptionsSchema>;
+declare module '../registry.js' {
+    interface ComponentDefinitions {
+        onboarding: ComponentDefinition<OnboardingOptions, InferEvents<typeof onboardingEvents>>;
+    }
+}
+/** Wire type → emitter event. Onboarding emits only the base events for now. */
+export declare const onboardingEventSchemas: {};
+export declare const onboardingDescriptor: import("../registry.js").ComponentDescriptor<"onboarding">;

package/dist/onboarding/schema.d.ts

@@ -0,0 +1,9 @@
+import * as z from 'zod/v4/mini';
+/**
+ * Onboarding's wire contract. The boarding request owns all business data, so
+ * the browser sends no options yet. The SDK sends this in CONFIG_SET.options
+ * and payhub parses with this same object.
+ */
+export declare const onboardingOptionsSchema: z.ZodMiniObject<{}, z.core.$strip>;
+/** Onboarding's own inbound events, beyond the base set every component shares. */
+export declare const onboardingEvents: {};

package/dist/payin/definition.d.ts

@@ -80,11 +80,5 @@ export declare const payInEventSchemas: {
             message: import("zod/v4/mini").ZodMiniOptional<import("zod/v4/mini").ZodMiniString<string>>;
         }, import("zod/v4/core").$strip>;
     };
-    VENDOR_CREATED: {
-        event: "vendorCreated";
-        schema: import("zod/v4/mini").ZodMiniObject<{
-            vendorId: import("zod/v4/mini").ZodMiniString<string>;
-        }, import("zod/v4/core").$strip>;
-    };
 };
 export declare const payInDescriptor: import("../registry.js").ComponentDescriptor<"payin">;

package/dist/payin/schema.d.ts

@@ -88,9 +88,6 @@ export declare const payinEvents: {
         }>;
         message: z.ZodMiniOptional<z.ZodMiniString<string>>;
     }, z.core.$strip>;
-    readonly VENDOR_CREATED: z.ZodMiniObject<{
-        vendorId: z.ZodMiniString<string>;
-    }, z.core.$strip>;
 };
 /** The session operation the payload reports on. */
 export type PayInOperation = 'pay' | 'auth' | 'tokenize';

package/dist/payout/definition.d.ts

@@ -0,0 +1,29 @@
+import type { Infer, InferEvents } from '../protocol/envelope.js';
+import { payoutEvents, payoutOptionsSchema } from './schema.js';
+import type { PayoutSuccessPayload } from './schema.js';
+export * from './schema.js';
+/** The partner-facing options type is the wire schema's type. */
+export type PayoutOptions = Infer<typeof payoutOptionsSchema>;
+declare module '../registry.js' {
+    interface ComponentDefinitions {
+        payout: ComponentDefinition<PayoutOptions, InferEvents<typeof payoutEvents> & {
+            success: PayoutSuccessPayload;
+        }>;
+    }
+}
+/** Wire type → emitter event, with the shared schema from `./schema.js` as the only validator. */
+export declare const payoutEventSchemas: {
+    METHOD_CHANGE: {
+        event: "methodChange";
+        schema: import("zod/v4/mini").ZodMiniObject<{
+            method: import("zod/v4/mini").ZodMiniEnum<{
+                ach: "ach";
+                check: "check";
+                vcard: "vcard";
+                wire: "wire";
+                rtp: "rtp";
+            }>;
+        }, import("zod/v4/core").$strip>;
+    };
+};
+export declare const payoutDescriptor: import("../registry.js").ComponentDescriptor<"payout">;

package/dist/payout/schema.d.ts

@@ -0,0 +1,79 @@
+import * as z from 'zod/v4/mini';
+/**
+ * Payout's wire contract: its event schemas, options schema, and vocabulary.
+ * Payout has its own methods. They do not share names with PayIn's.
+ */
+export declare const PAYOUT_METHODS: readonly ["ach", "check", "vcard", "wire", "rtp"];
+export type PayoutMethodName = (typeof PAYOUT_METHODS)[number];
+/** Payout text keys. The iframe drops other keys, trims values, and limits text to 120 characters. */
+export declare const PAYOUT_LABEL_KEYS: readonly ["submit", "method-ach", "method-check", "method-vcard", "method-wire", "method-rtp", "label.ach.holderName", "placeholder.ach.holderName", "label.ach.holderType", "label.ach.accountType", "label.ach.routingNumber", "placeholder.ach.routingNumber", "label.ach.accountNumber", "placeholder.ach.accountNumber", "label.vcard.code"];
+export type PayoutLabelKey = (typeof PAYOUT_LABEL_KEYS)[number];
+/**
+ * Client-side UI behavior only. The partner server sets operation, methods,
+ * vendorData, paymentDetails, invoiceData, and saveIfSuccess through
+ * `Session/init`. The SDK sends this in CONFIG_SET.options and payhub parses
+ * with this same object.
+ */
+export declare const payoutOptionsSchema: z.ZodMiniObject<{
+    initialMethod: z.ZodMiniOptional<z.ZodMiniEnum<{
+        ach: "ach";
+        check: "check";
+        vcard: "vcard";
+        wire: "wire";
+        rtp: "rtp";
+    }>>;
+    methodOrder: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniEnum<{
+        ach: "ach";
+        check: "check";
+        vcard: "vcard";
+        wire: "wire";
+        rtp: "rtp";
+    }>>>;
+    showSubmitButton: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+}, z.core.$strip>;
+/** Payout's own inbound events, beyond the base set every component shares. */
+export declare const payoutEvents: {
+    readonly METHOD_CHANGE: z.ZodMiniObject<{
+        method: z.ZodMiniEnum<{
+            ach: "ach";
+            check: "check";
+            vcard: "vcard";
+            wire: "wire";
+            rtp: "rtp";
+        }>;
+    }, z.core.$strip>;
+};
+/** The session operation the payload reports on. Same names as PayIn. */
+export type PayoutOperation = 'pay' | 'auth' | 'tokenize';
+/**
+ * SUBMIT_RESULT.data for Payout: the `success` event payload and the
+ * `submit()` result. One closed shape for every operation, like PayIn. payhub
+ * builds it from the API result. Card data, account numbers, and addresses
+ * never go in it.
+ */
+export type PayoutSuccessPayload = {
+    operation: PayoutOperation;
+    /** The method the vendor used. */
+    method: PayoutMethodName;
+    /** The vendor from the session config. */
+    vendorId: number;
+    /** The MoneyOut transaction id. Present for `pay` and `auth`. */
+    transactionId?: string;
+    /**
+     * The saved vendor payment method id. Present for `tokenize`, and for `pay`
+     * or `auth` when the session saved the method.
+     */
+    storedMethodId?: string;
+    paymentMethod?: {
+        /** The account with every digit but the last four hidden. */
+        maskedAccount?: string;
+        accountType?: 'checking' | 'savings';
+        holderName?: string;
+    };
+    /** The paid or authorized amount. Present for `pay` and `auth`. */
+    amount?: {
+        total: number;
+        serviceFee?: number;
+        currency?: string;
+    };
+};

package/dist/registry.d.ts

@@ -26,6 +26,8 @@ export type EventSchemaDescriptor<EventName extends string = string> = {
 export type ComponentDescriptor<T extends ComponentType = ComponentType> = {
     type: T;
     displayName: string;
+    /** Accessible name of the component frame, such as "Payment form". */
+    frameLabel: string;
     embedPath: `/embed/${string}`;
     /** A successful submit ends this component, so the SDK destroys it after `success`. */
     endsOnSuccess: boolean;

package/dist/sdk.d.ts

@@ -41,7 +41,8 @@ export interface CreateOptions<T extends ComponentType = ComponentType> {
     key?: string;
     appearance?: AppearanceOptions;
     options?: ComponentOptions<T>;
-    prefill?: T extends 'payin' ? never : Record<string, string>;
+    /** Not supported by PayIn, Onboarding, or Payout: the server session owns their data. */
+    prefill?: T extends 'payin' | 'onboarding' | 'payout' ? never : Record<string, string>;
     locale?: string;
     timeout?: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payabli/component-contracts",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Wire schemas, component registry, and partner-facing types shared by the Payabli embedded components SDK and payhub.",
   "private": false,
   "license": "MIT",