@payabli/component-contracts 0.4.0 → 0.5.0

package/dist/aliases.d.ts

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

package/dist/generated.d.ts

@@ -1 +1,2 @@
+export * from './onboarding/definition.js';
 export * from './payin/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
@@ -1804,6 +1825,7 @@ const payInEventSchemas = {
 const payInDescriptor = register({
     type: 'payin',
     displayName: 'PayIn',
+    frameLabel: 'Payment form',
     embedPath: '/embed/payin',
     endsOnSuccess: true,
     optionsSchema: payinOptionsSchema,
@@ -1851,4 +1873,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, appearanceSchema, baseInboundEvents, componentDescriptors, componentErrorSchema, componentTypes, eventEnvelopeSchema, getComponentDescriptor, onboardingDescriptor, onboardingEventSchemas, onboardingEvents, onboardingOptionsSchema, outboundMessages, parseEnvelope, parseMessage, parsePayload, payInDescriptor, payInEventSchemas, payinEvents, payinOptionsSchema, 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/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 or Onboarding: the server session owns their data. */
+    prefill?: T extends 'payin' | 'onboarding' ? 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.5.0",
   "description": "Wire schemas, component registry, and partner-facing types shared by the Payabli embedded components SDK and payhub.",
   "private": false,
   "license": "MIT",