@payabli/component-contracts 0.1.0

package/README.md

@@ -0,0 +1,30 @@
+# @payabli/component-contracts
+
+Wire schemas, the component registry, and the partner-facing types that the
+Payabli embedded components SDK (`@payabli/components-web`) and the payhub
+iframe share. One folder per component under `src/<component>/`.
+
+## Install
+
+```sh
+pnpm add @payabli/component-contracts
+```
+
+## What is inside
+
+- `protocol/`: the postMessage envelope, `parseEnvelope` / `parseMessage` /
+  `parsePayload`, the base events every component emits, and the messages the
+  SDK sends to the iframe (`CONFIG_SET`, `SESSION_UPDATE`, `SUBMIT`, ...).
+- `payin/`: the PayIn component. Its options schema, event schemas, and the
+  `PAYMENT_METHODS` / `CARD_BRANDS` vocabulary.
+- `registry`: `register()`, `getComponentDescriptor()`, and the
+  `ComponentDefinitions` declaration-merge point.
+- `ErrorCodes`: the error vocabulary shared by the SDK, payhub, and the API.
+
+Schemas are zod v4 mini and the runtime is bundled. Consumers on zod 3.25 or
+later resolve the types through `zod/v4/mini`.
+
+## Versioning
+
+Pre-1.0. A breaking wire change is a minor bump. `MESSAGE_VERSION` changes
+only when old and new sides can no longer talk.

package/dist/aliases.d.ts

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

package/dist/errors.d.ts

@@ -0,0 +1,27 @@
+export declare const ErrorCodes: {
+    readonly LOAD_TIMEOUT: "LOAD_TIMEOUT";
+    readonly PROTOCOL_ERROR: "PROTOCOL_ERROR";
+    readonly INVALID_STATE: "INVALID_STATE";
+    readonly SESSION_EXPIRED: "SESSION_EXPIRED";
+    readonly SESSION_REFRESH_FAILED: "SESSION_REFRESH_FAILED";
+    /** Reported by an iframe whose call was rejected for an expired JWT. Triggers a refresh. */
+    readonly TOKEN_EXPIRED: "TOKEN_EXPIRED";
+    /**
+     * Reported by an iframe whose render token no longer renders. The SDK recreates the frame
+     * with the latest render token.
+     */
+    readonly RENDER_TOKEN_EXPIRED: "RENDER_TOKEN_EXPIRED";
+    /** The render token failed signature, audience, or format checks. Needs a new session. */
+    readonly RENDER_TOKEN_INVALID: "RENDER_TOKEN_INVALID";
+    /** Refresh rejected: the page origin is not on the session's allowlist. Terminal. */
+    readonly ORIGIN_NOT_ALLOWED: "ORIGIN_NOT_ALLOWED";
+    /** Refresh rejected: the session was revoked (token reuse included). Terminal. */
+    readonly SESSION_REVOKED: "SESSION_REVOKED";
+    /** Refresh rejected: the session reached its expiration ceiling. Terminal. */
+    readonly SESSION_LIMIT_REACHED: "SESSION_LIMIT_REACHED";
+    /** Refresh rejected: unknown session, or one that names a component this API build lacks. Terminal. */
+    readonly SESSION_INVALID: "SESSION_INVALID";
+    /** Refresh could not mint a render token: server misconfiguration. Terminal regardless of status. */
+    readonly RENDER_TOKEN_FAILED: "RENDER_TOKEN_FAILED";
+};
+export type ErrorCode = (typeof ErrorCodes)[keyof typeof ErrorCodes];

package/dist/generated.d.ts

@@ -0,0 +1 @@
+export * from './payin/definition.js';

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export * from './protocol/constants.js';
+export * from './protocol/envelope.js';
+export * from './protocol/base.js';
+export * from './generated.js';
+export * from './aliases.js';
+export * from './errors.js';
+export * from './registry.js';
+export * from './sdk.js';
+export * from './shared.js';