diff --git a/apps/docs/pages/_meta.json b/apps/docs/pages/_meta.json index 706d18a..ea9462f 100644 --- a/apps/docs/pages/_meta.json +++ b/apps/docs/pages/_meta.json @@ -1,6 +1,7 @@ { "index": "Introduction", "quickstart": "Quickstart", + "theming": "Theming & i18n", "api-reference": "API Reference", "playground": { "title": "Playground", diff --git a/apps/docs/pages/api-reference/core.mdx b/apps/docs/pages/api-reference/core.mdx index 77f8217..124129c 100644 --- a/apps/docs/pages/api-reference/core.mdx +++ b/apps/docs/pages/api-reference/core.mdx @@ -20,7 +20,7 @@ npm install @pacto-connect/core # Class: CheckoutFlowController -Defined in: [packages/connect-core/src/checkout-flow.ts:57](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L57) +Defined in: [packages/connect-core/src/checkout-flow.ts:60](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L60) ## Constructors @@ -30,7 +30,7 @@ Defined in: [packages/connect-core/src/checkout-flow.ts:57](https://github.com/K new CheckoutFlowController(options): CheckoutFlowController; ``` -Defined in: [packages/connect-core/src/checkout-flow.ts:66](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L66) +Defined in: [packages/connect-core/src/checkout-flow.ts:69](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L69) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/connect-core/src/checkout-flow.ts:66](https://github.com/K confirmDeposit(): Promise; ``` -Defined in: [packages/connect-core/src/checkout-flow.ts:95](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L95) +Defined in: [packages/connect-core/src/checkout-flow.ts:98](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L98) #### Returns @@ -64,7 +64,7 @@ Defined in: [packages/connect-core/src/checkout-flow.ts:95](https://github.com/K destroy(): void; ``` -Defined in: [packages/connect-core/src/checkout-flow.ts:76](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L76) +Defined in: [packages/connect-core/src/checkout-flow.ts:79](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L79) #### Returns @@ -72,13 +72,61 @@ Defined in: [packages/connect-core/src/checkout-flow.ts:76](https://github.com/K *** +### forceTestDispute() + +```ts +forceTestDispute(reason?): Promise; +``` + +Defined in: [packages/connect-core/src/checkout-flow.ts:165](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L165) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reason?` | `string` | + +#### Returns + +`Promise`\<`void`\> + +*** + +### forceTestRelease() + +```ts +forceTestRelease(): Promise; +``` + +Defined in: [packages/connect-core/src/checkout-flow.ts:147](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L147) + +#### Returns + +`Promise`\<`void`\> + +*** + +### forceTestTimeout() + +```ts +forceTestTimeout(): Promise; +``` + +Defined in: [packages/connect-core/src/checkout-flow.ts:183](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L183) + +#### Returns + +`Promise`\<`void`\> + +*** + ### getState() ```ts getState(): CheckoutFlowState; ``` -Defined in: [packages/connect-core/src/checkout-flow.ts:68](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L68) +Defined in: [packages/connect-core/src/checkout-flow.ts:71](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L71) #### Returns @@ -92,7 +140,7 @@ Defined in: [packages/connect-core/src/checkout-flow.ts:68](https://github.com/K retry(): void; ``` -Defined in: [packages/connect-core/src/checkout-flow.ts:140](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L140) +Defined in: [packages/connect-core/src/checkout-flow.ts:143](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L143) #### Returns @@ -106,7 +154,7 @@ Defined in: [packages/connect-core/src/checkout-flow.ts:140](https://github.com/ selectListing(listing): Promise; ``` -Defined in: [packages/connect-core/src/checkout-flow.ts:86](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L86) +Defined in: [packages/connect-core/src/checkout-flow.ts:89](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L89) #### Parameters @@ -126,7 +174,7 @@ Defined in: [packages/connect-core/src/checkout-flow.ts:86](https://github.com/K start(): Promise; ``` -Defined in: [packages/connect-core/src/checkout-flow.ts:72](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L72) +Defined in: [packages/connect-core/src/checkout-flow.ts:75](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L75) #### Returns @@ -143,7 +191,7 @@ submitReceipt( receipt?): Promise; ``` -Defined in: [packages/connect-core/src/checkout-flow.ts:114](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L114) +Defined in: [packages/connect-core/src/checkout-flow.ts:117](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L117) #### Parameters @@ -162,7 +210,7 @@ Defined in: [packages/connect-core/src/checkout-flow.ts:114](https://github.com/ # Class: PactoApiError -Defined in: [packages/connect-core/src/errors.ts:56](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L56) +Defined in: [packages/connect-core/src/errors.ts:56](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L56) ## Extends @@ -176,7 +224,7 @@ Defined in: [packages/connect-core/src/errors.ts:56](https://github.com/KevinLat new PactoApiError(code, message): PactoApiError; ``` -Defined in: [packages/connect-core/src/errors.ts:57](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L57) +Defined in: [packages/connect-core/src/errors.ts:57](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L57) #### Parameters @@ -198,11 +246,11 @@ Defined in: [packages/connect-core/src/errors.ts:57](https://github.com/KevinLat | Property | Modifier | Type | Description | Inherited from | Defined in | | ------ | ------ | ------ | ------ | ------ | ------ | | `cause?` | `public` | `unknown` | - | [`PactoError`](#class.pactoerror).[`cause`](#cause) | node\_modules/typescript/lib/lib.es2022.error.d.ts:26 | -| `code` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`code`](#code) | [packages/connect-core/src/errors.ts:17](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L17) | +| `code` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`code`](#code) | [packages/connect-core/src/errors.ts:17](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L17) | | `message` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`message`](#message) | node\_modules/typescript/lib/lib.es5.d.ts:1077 | | `name` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`name`](#name) | node\_modules/typescript/lib/lib.es5.d.ts:1076 | | `stack?` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`stack`](#stack) | node\_modules/typescript/lib/lib.es5.d.ts:1078 | -| `type` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`type`](#type) | [packages/connect-core/src/errors.ts:16](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L16) | +| `type` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`type`](#type) | [packages/connect-core/src/errors.ts:16](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L16) | | `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PactoError`](#class.pactoerror).[`stackTraceLimit`](#stacktracelimit) | node\_modules/@types/node/globals.d.ts:68 | ## Methods @@ -308,7 +356,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces # Class: PactoAuthError -Defined in: [packages/connect-core/src/errors.ts:32](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L32) +Defined in: [packages/connect-core/src/errors.ts:32](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L32) ## Extends @@ -322,7 +370,7 @@ Defined in: [packages/connect-core/src/errors.ts:32](https://github.com/KevinLat new PactoAuthError(code, message): PactoAuthError; ``` -Defined in: [packages/connect-core/src/errors.ts:33](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L33) +Defined in: [packages/connect-core/src/errors.ts:33](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L33) #### Parameters @@ -344,11 +392,11 @@ Defined in: [packages/connect-core/src/errors.ts:33](https://github.com/KevinLat | Property | Modifier | Type | Description | Inherited from | Defined in | | ------ | ------ | ------ | ------ | ------ | ------ | | `cause?` | `public` | `unknown` | - | [`PactoError`](#class.pactoerror).[`cause`](#cause) | node\_modules/typescript/lib/lib.es2022.error.d.ts:26 | -| `code` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`code`](#code) | [packages/connect-core/src/errors.ts:17](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L17) | +| `code` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`code`](#code) | [packages/connect-core/src/errors.ts:17](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L17) | | `message` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`message`](#message) | node\_modules/typescript/lib/lib.es5.d.ts:1077 | | `name` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`name`](#name) | node\_modules/typescript/lib/lib.es5.d.ts:1076 | | `stack?` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`stack`](#stack) | node\_modules/typescript/lib/lib.es5.d.ts:1078 | -| `type` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`type`](#type) | [packages/connect-core/src/errors.ts:16](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L16) | +| `type` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`type`](#type) | [packages/connect-core/src/errors.ts:16](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L16) | | `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PactoError`](#class.pactoerror).[`stackTraceLimit`](#stacktracelimit) | node\_modules/@types/node/globals.d.ts:68 | ## Methods @@ -454,7 +502,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces # Class: PactoError -Defined in: [packages/connect-core/src/errors.ts:14](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L14) +Defined in: [packages/connect-core/src/errors.ts:14](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L14) ## Extends @@ -479,7 +527,7 @@ new PactoError( message): PactoError; ``` -Defined in: [packages/connect-core/src/errors.ts:15](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L15) +Defined in: [packages/connect-core/src/errors.ts:15](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L15) #### Parameters @@ -504,11 +552,11 @@ Error.constructor | Property | Modifier | Type | Description | Inherited from | Defined in | | ------ | ------ | ------ | ------ | ------ | ------ | | `cause?` | `public` | `unknown` | - | `Error.cause` | node\_modules/typescript/lib/lib.es2022.error.d.ts:26 | -| `code` | `readonly` | `string` | - | - | [packages/connect-core/src/errors.ts:17](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L17) | +| `code` | `readonly` | `string` | - | - | [packages/connect-core/src/errors.ts:17](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L17) | | `message` | `public` | `string` | - | `Error.message` | node\_modules/typescript/lib/lib.es5.d.ts:1077 | | `name` | `public` | `string` | - | `Error.name` | node\_modules/typescript/lib/lib.es5.d.ts:1076 | | `stack?` | `public` | `string` | - | `Error.stack` | node\_modules/typescript/lib/lib.es5.d.ts:1078 | -| `type` | `readonly` | `string` | - | - | [packages/connect-core/src/errors.ts:16](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L16) | +| `type` | `readonly` | `string` | - | - | [packages/connect-core/src/errors.ts:16](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L16) | | `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | node\_modules/@types/node/globals.d.ts:68 | ## Methods @@ -618,7 +666,7 @@ Error.prepareStackTrace # Class: PactoEscrowError -Defined in: [packages/connect-core/src/errors.ts:49](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L49) +Defined in: [packages/connect-core/src/errors.ts:49](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L49) ## Extends @@ -632,7 +680,7 @@ Defined in: [packages/connect-core/src/errors.ts:49](https://github.com/KevinLat new PactoEscrowError(code, message): PactoEscrowError; ``` -Defined in: [packages/connect-core/src/errors.ts:50](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L50) +Defined in: [packages/connect-core/src/errors.ts:50](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L50) #### Parameters @@ -654,11 +702,11 @@ Defined in: [packages/connect-core/src/errors.ts:50](https://github.com/KevinLat | Property | Modifier | Type | Description | Inherited from | Defined in | | ------ | ------ | ------ | ------ | ------ | ------ | | `cause?` | `public` | `unknown` | - | [`PactoError`](#class.pactoerror).[`cause`](#cause) | node\_modules/typescript/lib/lib.es2022.error.d.ts:26 | -| `code` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`code`](#code) | [packages/connect-core/src/errors.ts:17](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L17) | +| `code` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`code`](#code) | [packages/connect-core/src/errors.ts:17](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L17) | | `message` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`message`](#message) | node\_modules/typescript/lib/lib.es5.d.ts:1077 | | `name` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`name`](#name) | node\_modules/typescript/lib/lib.es5.d.ts:1076 | | `stack?` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`stack`](#stack) | node\_modules/typescript/lib/lib.es5.d.ts:1078 | -| `type` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`type`](#type) | [packages/connect-core/src/errors.ts:16](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L16) | +| `type` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`type`](#type) | [packages/connect-core/src/errors.ts:16](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L16) | | `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PactoError`](#class.pactoerror).[`stackTraceLimit`](#stacktracelimit) | node\_modules/@types/node/globals.d.ts:68 | ## Methods @@ -764,7 +812,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces # Class: PactoRateLimitError -Defined in: [packages/connect-core/src/errors.ts:39](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L39) +Defined in: [packages/connect-core/src/errors.ts:39](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L39) ## Extends @@ -781,7 +829,7 @@ new PactoRateLimitError( retryAfter?): PactoRateLimitError; ``` -Defined in: [packages/connect-core/src/errors.ts:42](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L42) +Defined in: [packages/connect-core/src/errors.ts:42](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L42) #### Parameters @@ -804,12 +852,12 @@ Defined in: [packages/connect-core/src/errors.ts:42](https://github.com/KevinLat | Property | Modifier | Type | Description | Inherited from | Defined in | | ------ | ------ | ------ | ------ | ------ | ------ | | `cause?` | `public` | `unknown` | - | [`PactoError`](#class.pactoerror).[`cause`](#cause) | node\_modules/typescript/lib/lib.es2022.error.d.ts:26 | -| `code` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`code`](#code) | [packages/connect-core/src/errors.ts:17](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L17) | +| `code` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`code`](#code) | [packages/connect-core/src/errors.ts:17](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L17) | | `message` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`message`](#message) | node\_modules/typescript/lib/lib.es5.d.ts:1077 | | `name` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`name`](#name) | node\_modules/typescript/lib/lib.es5.d.ts:1076 | -| `retryAfter?` | `readonly` | `number` | - | - | [packages/connect-core/src/errors.ts:40](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L40) | +| `retryAfter?` | `readonly` | `number` | - | - | [packages/connect-core/src/errors.ts:40](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L40) | | `stack?` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`stack`](#stack) | node\_modules/typescript/lib/lib.es5.d.ts:1078 | -| `type` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`type`](#type) | [packages/connect-core/src/errors.ts:16](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L16) | +| `type` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`type`](#type) | [packages/connect-core/src/errors.ts:16](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L16) | | `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PactoError`](#class.pactoerror).[`stackTraceLimit`](#stacktracelimit) | node\_modules/@types/node/globals.d.ts:68 | ## Methods @@ -915,7 +963,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces # Class: PactoSession -Defined in: [packages/connect-core/src/client.ts:73](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L73) +Defined in: [packages/connect-core/src/client.ts:73](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L73) ## Constructors @@ -925,7 +973,7 @@ Defined in: [packages/connect-core/src/client.ts:73](https://github.com/KevinLat new PactoSession(client, data): PactoSession; ``` -Defined in: [packages/connect-core/src/client.ts:81](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L81) +Defined in: [packages/connect-core/src/client.ts:81](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L81) #### Parameters @@ -942,10 +990,10 @@ Defined in: [packages/connect-core/src/client.ts:81](https://github.com/KevinLat | Property | Modifier | Type | Defined in | | ------ | ------ | ------ | ------ | -| `clientSecret` | `readonly` | `string` | [packages/connect-core/src/client.ts:75](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L75) | -| `expiresAt` | `readonly` | `Date` | [packages/connect-core/src/client.ts:76](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L76) | -| `mode` | `readonly` | [`CheckoutMode`](#typealias.checkoutmode) | [packages/connect-core/src/client.ts:77](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L77) | -| `sessionId` | `readonly` | `string` | [packages/connect-core/src/client.ts:74](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L74) | +| `clientSecret` | `readonly` | `string` | [packages/connect-core/src/client.ts:75](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L75) | +| `expiresAt` | `readonly` | `Date` | [packages/connect-core/src/client.ts:76](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L76) | +| `mode` | `readonly` | [`CheckoutMode`](#typealias.checkoutmode) | [packages/connect-core/src/client.ts:77](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L77) | +| `sessionId` | `readonly` | `string` | [packages/connect-core/src/client.ts:74](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L74) | ## Methods @@ -955,7 +1003,7 @@ Defined in: [packages/connect-core/src/client.ts:81](https://github.com/KevinLat closeEvents(): void; ``` -Defined in: [packages/connect-core/src/client.ts:119](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L119) +Defined in: [packages/connect-core/src/client.ts:119](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L119) #### Returns @@ -969,7 +1017,7 @@ Defined in: [packages/connect-core/src/client.ts:119](https://github.com/KevinLa isExpired(): boolean; ``` -Defined in: [packages/connect-core/src/client.ts:91](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L91) +Defined in: [packages/connect-core/src/client.ts:91](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L91) #### Returns @@ -983,7 +1031,7 @@ Defined in: [packages/connect-core/src/client.ts:91](https://github.com/KevinLat off(event, handler): void; ``` -Defined in: [packages/connect-core/src/client.ts:115](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L115) +Defined in: [packages/connect-core/src/client.ts:115](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L115) #### Parameters @@ -1007,7 +1055,7 @@ on( options?): void; ``` -Defined in: [packages/connect-core/src/client.ts:100](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L100) +Defined in: [packages/connect-core/src/client.ts:100](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L100) #### Parameters @@ -1029,7 +1077,7 @@ Defined in: [packages/connect-core/src/client.ts:100](https://github.com/KevinLa refresh(): Promise; ``` -Defined in: [packages/connect-core/src/client.ts:95](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L95) +Defined in: [packages/connect-core/src/client.ts:95](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L95) #### Returns @@ -1040,7 +1088,7 @@ Defined in: [packages/connect-core/src/client.ts:95](https://github.com/KevinLat # Class: PactoSessionError -Defined in: [packages/connect-core/src/errors.ts:25](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L25) +Defined in: [packages/connect-core/src/errors.ts:25](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L25) ## Extends @@ -1054,7 +1102,7 @@ Defined in: [packages/connect-core/src/errors.ts:25](https://github.com/KevinLat new PactoSessionError(code, message): PactoSessionError; ``` -Defined in: [packages/connect-core/src/errors.ts:26](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L26) +Defined in: [packages/connect-core/src/errors.ts:26](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L26) #### Parameters @@ -1076,11 +1124,11 @@ Defined in: [packages/connect-core/src/errors.ts:26](https://github.com/KevinLat | Property | Modifier | Type | Description | Inherited from | Defined in | | ------ | ------ | ------ | ------ | ------ | ------ | | `cause?` | `public` | `unknown` | - | [`PactoError`](#class.pactoerror).[`cause`](#cause) | node\_modules/typescript/lib/lib.es2022.error.d.ts:26 | -| `code` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`code`](#code) | [packages/connect-core/src/errors.ts:17](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L17) | +| `code` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`code`](#code) | [packages/connect-core/src/errors.ts:17](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L17) | | `message` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`message`](#message) | node\_modules/typescript/lib/lib.es5.d.ts:1077 | | `name` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`name`](#name) | node\_modules/typescript/lib/lib.es5.d.ts:1076 | | `stack?` | `public` | `string` | - | [`PactoError`](#class.pactoerror).[`stack`](#stack) | node\_modules/typescript/lib/lib.es5.d.ts:1078 | -| `type` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`type`](#type) | [packages/connect-core/src/errors.ts:16](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/errors.ts#L16) | +| `type` | `readonly` | `string` | - | [`PactoError`](#class.pactoerror).[`type`](#type) | [packages/connect-core/src/errors.ts:16](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/errors.ts#L16) | | `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PactoError`](#class.pactoerror).[`stackTraceLimit`](#stacktracelimit) | node\_modules/@types/node/globals.d.ts:68 | ## Methods @@ -1182,6 +1230,25 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces [`PactoError`](#class.pactoerror).[`prepareStackTrace`](#preparestacktrace) +--- + +# Function: buildCheckoutStylesheet() + +```ts +function buildCheckoutStylesheet(): string; +``` + +Defined in: [packages/connect-core/src/theme.ts:116](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L116) + +The default checkout stylesheet, tokenized. Every themeable value is written +as `var(--pacto-*, )` where the default comes from DEFAULT_THEME, so +there is exactly one source for each default literal. + +## Returns + +`string` + + --- # Function: createBridgeClient() @@ -1190,7 +1257,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces function createBridgeClient(options): BridgeClient; ``` -Defined in: [packages/connect-core/src/bridge.ts:134](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L134) +Defined in: [packages/connect-core/src/bridge.ts:134](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L134) @pacto-connect/core @@ -1215,7 +1282,7 @@ Framework-agnostic SDK core for Pacto Connect. function createBridgeHost(options): BridgeHost; ``` -Defined in: [packages/connect-core/src/bridge.ts:176](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L176) +Defined in: [packages/connect-core/src/bridge.ts:176](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L176) @pacto-connect/core @@ -1232,6 +1299,30 @@ Framework-agnostic SDK core for Pacto Connect. [`BridgeHost`](#interface.bridgehost) +--- + +# Function: formatMessage() + +```ts +function formatMessage(template, params): string; +``` + +Defined in: [packages/connect-core/src/i18n.ts:175](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L175) + +Replace `{name}` placeholders in `template` with values from `params`. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `template` | `string` | +| `params` | `Record`\<`string`, `string`\> | + +## Returns + +`string` + + --- # Function: init() @@ -1240,7 +1331,7 @@ Framework-agnostic SDK core for Pacto Connect. function init(options): PactoClient; ``` -Defined in: [packages/connect-core/src/client.ts:221](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L221) +Defined in: [packages/connect-core/src/client.ts:221](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L221) Entry point for the Pacto Connect SDK. @@ -1263,7 +1354,7 @@ Entry point for the Pacto Connect SDK. function isOriginAllowed(origin, allowedOrigins): boolean; ``` -Defined in: [packages/connect-core/src/bridge.ts:101](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L101) +Defined in: [packages/connect-core/src/bridge.ts:101](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L101) @pacto-connect/core @@ -1289,7 +1380,7 @@ Framework-agnostic SDK core for Pacto Connect. function isPactoBridgeEnvelope(value): value is PactoBridgeEnvelope; ``` -Defined in: [packages/connect-core/src/bridge.ts:92](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L92) +Defined in: [packages/connect-core/src/bridge.ts:92](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L92) @pacto-connect/core @@ -1306,11 +1397,104 @@ Framework-agnostic SDK core for Pacto Connect. `value is PactoBridgeEnvelope` +--- + +# Function: isTestMode() + +```ts +function isTestMode(publishableKey): boolean; +``` + +Defined in: [packages/connect-core/src/keys.ts:1](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/keys.ts#L1) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `publishableKey` | `string` | + +## Returns + +`boolean` + + +--- + +# Function: keyMode() + +```ts +function keyMode(publishableKey): "test" | "live" | "unknown"; +``` + +Defined in: [packages/connect-core/src/keys.ts:5](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/keys.ts#L5) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `publishableKey` | `string` | + +## Returns + +`"test"` \| `"live"` \| `"unknown"` + + +--- + +# Function: resolveMessages() + +```ts +function resolveMessages(locale?, overrides?): PactoMessages; +``` + +Defined in: [packages/connect-core/src/i18n.ts:163](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L163) + +Resolve a locale to its message set, deep-merged with optional overrides. +Unknown locales fall back to English. Pass a full `PactoMessages` shape via +`overrides` to register a language that is not built in. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `locale?` | `string` | +| `overrides?` | [`DeepPartial`](#typealias.deeppartial)\<[`PactoMessages`](#interface.pactomessages)\> | + +## Returns + +[`PactoMessages`](#interface.pactomessages) + + +--- + +# Function: themeToCssVars() + +```ts +function themeToCssVars(theme?): Record; +``` + +Defined in: [packages/connect-core/src/theme.ts:79](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L79) + +Convert a (partial) theme into a sparse map of CSS custom properties. Only +tokens that are explicitly provided are emitted; everything else falls +through to the stylesheet's built-in fallbacks. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `theme?` | [`DeepPartial`](#typealias.deeppartial)\<[`PactoTheme`](#interface.pactotheme)\> | + +## Returns + +`Record`\<`string`, `string`\> + + --- # Interface: BridgeClient -Defined in: [packages/connect-core/src/bridge.ts:116](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L116) +Defined in: [packages/connect-core/src/bridge.ts:116](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L116) @pacto-connect/core @@ -1324,7 +1508,7 @@ Framework-agnostic SDK core for Pacto Connect. close(): void; ``` -Defined in: [packages/connect-core/src/bridge.ts:119](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L119) +Defined in: [packages/connect-core/src/bridge.ts:119](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L119) #### Returns @@ -1338,7 +1522,7 @@ Defined in: [packages/connect-core/src/bridge.ts:119](https://github.com/KevinLa listen(handler): () => void; ``` -Defined in: [packages/connect-core/src/bridge.ts:118](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L118) +Defined in: [packages/connect-core/src/bridge.ts:118](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L118) #### Parameters @@ -1358,7 +1542,7 @@ Defined in: [packages/connect-core/src/bridge.ts:118](https://github.com/KevinLa post(message): void; ``` -Defined in: [packages/connect-core/src/bridge.ts:117](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L117) +Defined in: [packages/connect-core/src/bridge.ts:117](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L117) #### Parameters @@ -1375,7 +1559,7 @@ Defined in: [packages/connect-core/src/bridge.ts:117](https://github.com/KevinLa # Interface: BridgeClientOptions -Defined in: [packages/connect-core/src/bridge.ts:105](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L105) +Defined in: [packages/connect-core/src/bridge.ts:105](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L105) @pacto-connect/core @@ -1385,16 +1569,16 @@ Framework-agnostic SDK core for Pacto Connect. | Property | Type | Defined in | | ------ | ------ | ------ | -| `allowedOrigins` | `string`[] | [packages/connect-core/src/bridge.ts:108](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L108) | -| `targetOrigin` | `string` | [packages/connect-core/src/bridge.ts:107](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L107) | -| `targetWindow?` | `Window` | [packages/connect-core/src/bridge.ts:106](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L106) | +| `allowedOrigins` | `string`[] | [packages/connect-core/src/bridge.ts:108](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L108) | +| `targetOrigin` | `string` | [packages/connect-core/src/bridge.ts:107](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L107) | +| `targetWindow?` | `Window` | [packages/connect-core/src/bridge.ts:106](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L106) | --- # Interface: BridgeHost -Defined in: [packages/connect-core/src/bridge.ts:122](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L122) +Defined in: [packages/connect-core/src/bridge.ts:122](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L122) @pacto-connect/core @@ -1408,7 +1592,7 @@ Framework-agnostic SDK core for Pacto Connect. close(): void; ``` -Defined in: [packages/connect-core/src/bridge.ts:123](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L123) +Defined in: [packages/connect-core/src/bridge.ts:123](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L123) #### Returns @@ -1419,7 +1603,7 @@ Defined in: [packages/connect-core/src/bridge.ts:123](https://github.com/KevinLa # Interface: BridgeHostOptions -Defined in: [packages/connect-core/src/bridge.ts:111](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L111) +Defined in: [packages/connect-core/src/bridge.ts:111](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L111) @pacto-connect/core @@ -1429,213 +1613,215 @@ Framework-agnostic SDK core for Pacto Connect. | Property | Type | Defined in | | ------ | ------ | ------ | -| `allowedOrigins` | `string`[] | [packages/connect-core/src/bridge.ts:112](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L112) | -| `onMessage` | (`message`, `event`) => `void` | [packages/connect-core/src/bridge.ts:113](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L113) | +| `allowedOrigins` | `string`[] | [packages/connect-core/src/bridge.ts:112](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L112) | +| `onMessage` | (`message`, `event`) => `void` | [packages/connect-core/src/bridge.ts:113](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L113) | --- # Interface: CheckoutFlowOptions -Defined in: [packages/connect-core/src/checkout-flow.ts:32](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L32) +Defined in: [packages/connect-core/src/checkout-flow.ts:34](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L34) ## Properties | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| `gatewayUrl?` | `string` | - | [packages/connect-core/src/checkout-flow.ts:34](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L34) | -| `listingId?` | `string` | - | [packages/connect-core/src/checkout-flow.ts:35](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L35) | -| `mode?` | [`CheckoutMode`](#typealias.checkoutmode) | - | [packages/connect-core/src/checkout-flow.ts:36](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L36) | -| `onChange?` | (`state`) => `void` | - | [packages/connect-core/src/checkout-flow.ts:40](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L40) | -| `onComplete?` | (`escrow`) => `void` | - | [packages/connect-core/src/checkout-flow.ts:41](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L41) | -| `onDispute?` | (`escrow`) => `void` | - | [packages/connect-core/src/checkout-flow.ts:42](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L42) | -| `onError?` | (`error`) => `void` | - | [packages/connect-core/src/checkout-flow.ts:43](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L43) | -| `publishableKey` | `string` | - | [packages/connect-core/src/checkout-flow.ts:33](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L33) | -| `session?` | [`PactoSessionData`](#interface.pactosessiondata) | Pre-created session; skips POST /v1/session when provided. | [packages/connect-core/src/checkout-flow.ts:39](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L39) | -| `testMode?` | `boolean` | - | [packages/connect-core/src/checkout-flow.ts:37](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L37) | +| `gatewayUrl?` | `string` | - | [packages/connect-core/src/checkout-flow.ts:36](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L36) | +| `listingId?` | `string` | - | [packages/connect-core/src/checkout-flow.ts:37](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L37) | +| `mode?` | [`CheckoutMode`](#typealias.checkoutmode) | - | [packages/connect-core/src/checkout-flow.ts:38](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L38) | +| `onChange?` | (`state`) => `void` | - | [packages/connect-core/src/checkout-flow.ts:42](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L42) | +| `onComplete?` | (`escrow`) => `void` | - | [packages/connect-core/src/checkout-flow.ts:43](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L43) | +| `onDispute?` | (`escrow`) => `void` | - | [packages/connect-core/src/checkout-flow.ts:44](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L44) | +| `onError?` | (`error`) => `void` | - | [packages/connect-core/src/checkout-flow.ts:45](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L45) | +| `publishableKey` | `string` | - | [packages/connect-core/src/checkout-flow.ts:35](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L35) | +| `session?` | [`PactoSessionData`](#interface.pactosessiondata) | Pre-created session; skips POST /v1/session when provided. | [packages/connect-core/src/checkout-flow.ts:41](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L41) | +| `testMode?` | `boolean` | - | [packages/connect-core/src/checkout-flow.ts:39](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L39) | --- # Interface: CheckoutFlowState -Defined in: [packages/connect-core/src/checkout-flow.ts:21](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L21) +Defined in: [packages/connect-core/src/checkout-flow.ts:22](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L22) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `error` | `Error` \| `null` | [packages/connect-core/src/checkout-flow.ts:28](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L28) | -| `escrow` | [`Escrow`](#interface.escrow) \| `null` | [packages/connect-core/src/checkout-flow.ts:26](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L26) | -| `listings` | [`Listing`](#interface.listing)[] | [packages/connect-core/src/checkout-flow.ts:24](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L24) | -| `milestones` | [`EscrowEvent`](#interface.escrowevent)[] | [packages/connect-core/src/checkout-flow.ts:29](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L29) | -| `quote` | [`Quote`](#interface.quote) \| `null` | [packages/connect-core/src/checkout-flow.ts:27](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L27) | -| `selectedListing` | [`Listing`](#interface.listing) \| `null` | [packages/connect-core/src/checkout-flow.ts:25](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L25) | -| `sessionId` | `string` \| `null` | [packages/connect-core/src/checkout-flow.ts:23](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L23) | -| `step` | [`CheckoutStep`](#typealias.checkoutstep) | [packages/connect-core/src/checkout-flow.ts:22](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L22) | +| `error` | `Error` \| `null` | [packages/connect-core/src/checkout-flow.ts:29](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L29) | +| `escrow` | [`Escrow`](#interface.escrow) \| `null` | [packages/connect-core/src/checkout-flow.ts:27](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L27) | +| `listings` | [`Listing`](#interface.listing)[] | [packages/connect-core/src/checkout-flow.ts:25](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L25) | +| `milestones` | [`EscrowEvent`](#interface.escrowevent)[] | [packages/connect-core/src/checkout-flow.ts:30](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L30) | +| `quote` | [`Quote`](#interface.quote) \| `null` | [packages/connect-core/src/checkout-flow.ts:28](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L28) | +| `selectedListing` | [`Listing`](#interface.listing) \| `null` | [packages/connect-core/src/checkout-flow.ts:26](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L26) | +| `sessionId` | `string` \| `null` | [packages/connect-core/src/checkout-flow.ts:24](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L24) | +| `step` | [`CheckoutStep`](#typealias.checkoutstep) | [packages/connect-core/src/checkout-flow.ts:23](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L23) | +| `testMode` | `boolean` | [packages/connect-core/src/checkout-flow.ts:31](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L31) | --- # Interface: CreateEscrowParams -Defined in: [packages/connect-core/src/resources.ts:50](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L50) +Defined in: [packages/connect-core/src/resources.ts:50](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L50) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `quoteId` | `string` | [packages/connect-core/src/resources.ts:51](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L51) | +| `quoteId` | `string` | [packages/connect-core/src/resources.ts:51](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L51) | --- # Interface: CreateQuoteParams -Defined in: [packages/connect-core/src/resources.ts:26](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L26) +Defined in: [packages/connect-core/src/resources.ts:26](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L26) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `amount` | `string` | [packages/connect-core/src/resources.ts:29](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L29) | -| `asset` | `string` | [packages/connect-core/src/resources.ts:28](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L28) | -| `listingId?` | `string` | [packages/connect-core/src/resources.ts:27](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L27) | -| `price` | `string` | [packages/connect-core/src/resources.ts:30](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L30) | -| `side` | `"buy"` \| `"sell"` | [packages/connect-core/src/resources.ts:31](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L31) | +| `amount` | `string` | [packages/connect-core/src/resources.ts:29](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L29) | +| `asset` | `string` | [packages/connect-core/src/resources.ts:28](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L28) | +| `listingId?` | `string` | [packages/connect-core/src/resources.ts:27](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L27) | +| `price` | `string` | [packages/connect-core/src/resources.ts:30](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L30) | +| `side` | `"buy"` \| `"sell"` | [packages/connect-core/src/resources.ts:31](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L31) | --- # Interface: DepositParams -Defined in: [packages/connect-core/src/resources.ts:54](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L54) +Defined in: [packages/connect-core/src/resources.ts:54](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L54) ## Properties | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| `testMode?` | `boolean` | When true, simulates on-chain deposit in Gateway test mode. | [packages/connect-core/src/resources.ts:56](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L56) | +| `testMode?` | `boolean` | When true, simulates on-chain deposit in Gateway test mode. | [packages/connect-core/src/resources.ts:56](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L56) | --- # Interface: Escrow -Defined in: [packages/connect-core/src/resources.ts:34](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L34) +Defined in: [packages/connect-core/src/resources.ts:34](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L34) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `amount` | `string` | [packages/connect-core/src/resources.ts:38](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L38) | -| `asset` | `string` | [packages/connect-core/src/resources.ts:39](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L39) | -| `createdAt` | `string` | [packages/connect-core/src/resources.ts:40](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L40) | -| `id` | `string` | [packages/connect-core/src/resources.ts:35](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L35) | -| `quoteId` | `string` | [packages/connect-core/src/resources.ts:36](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L36) | -| `status` | [`EscrowStatus`](#typealias.escrowstatus) | [packages/connect-core/src/resources.ts:37](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L37) | -| `updatedAt` | `string` | [packages/connect-core/src/resources.ts:41](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L41) | +| `amount` | `string` | [packages/connect-core/src/resources.ts:38](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L38) | +| `asset` | `string` | [packages/connect-core/src/resources.ts:39](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L39) | +| `createdAt` | `string` | [packages/connect-core/src/resources.ts:40](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L40) | +| `id` | `string` | [packages/connect-core/src/resources.ts:35](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L35) | +| `quoteId` | `string` | [packages/connect-core/src/resources.ts:36](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L36) | +| `status` | [`EscrowStatus`](#typealias.escrowstatus) | [packages/connect-core/src/resources.ts:37](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L37) | +| `updatedAt` | `string` | [packages/connect-core/src/resources.ts:41](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L41) | --- # Interface: EscrowEvent -Defined in: [packages/connect-core/src/escrow-events.ts:16](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/escrow-events.ts#L16) +Defined in: [packages/connect-core/src/escrow-events.ts:16](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/escrow-events.ts#L16) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `cursor` | `string` | [packages/connect-core/src/escrow-events.ts:17](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/escrow-events.ts#L17) | -| `escrowId` | `string` | [packages/connect-core/src/escrow-events.ts:19](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/escrow-events.ts#L19) | -| `milestone` | [`EscrowMilestone`](#typealias.escrowmilestone) | [packages/connect-core/src/escrow-events.ts:20](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/escrow-events.ts#L20) | -| `occurredAt` | `string` | [packages/connect-core/src/escrow-events.ts:21](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/escrow-events.ts#L21) | -| `type` | `"escrow.funded"` \| `"fiat.reported"` \| `"released"` \| `"disputed"` | [packages/connect-core/src/escrow-events.ts:18](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/escrow-events.ts#L18) | +| `cursor` | `string` | [packages/connect-core/src/escrow-events.ts:17](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/escrow-events.ts#L17) | +| `escrowId` | `string` | [packages/connect-core/src/escrow-events.ts:19](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/escrow-events.ts#L19) | +| `milestone` | [`EscrowMilestone`](#typealias.escrowmilestone) | [packages/connect-core/src/escrow-events.ts:20](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/escrow-events.ts#L20) | +| `occurredAt` | `string` | [packages/connect-core/src/escrow-events.ts:21](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/escrow-events.ts#L21) | +| `type` | `"escrow.funded"` \| `"fiat.reported"` \| `"released"` \| `"disputed"` | [packages/connect-core/src/escrow-events.ts:18](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/escrow-events.ts#L18) | --- # Interface: EscrowStatusResponse -Defined in: [packages/connect-core/src/resources.ts:44](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L44) +Defined in: [packages/connect-core/src/resources.ts:44](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L44) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `id` | `string` | [packages/connect-core/src/resources.ts:45](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L45) | -| `status` | [`EscrowStatus`](#typealias.escrowstatus) | [packages/connect-core/src/resources.ts:46](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L46) | -| `updatedAt` | `string` | [packages/connect-core/src/resources.ts:47](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L47) | +| `id` | `string` | [packages/connect-core/src/resources.ts:45](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L45) | +| `status` | [`EscrowStatus`](#typealias.escrowstatus) | [packages/connect-core/src/resources.ts:46](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L46) | +| `updatedAt` | `string` | [packages/connect-core/src/resources.ts:47](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L47) | --- # Interface: EscrowSubscribeOptions -Defined in: [packages/connect-core/src/escrow-events.ts:26](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/escrow-events.ts#L26) +Defined in: [packages/connect-core/src/escrow-events.ts:26](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/escrow-events.ts#L26) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `escrowId?` | `string` | [packages/connect-core/src/escrow-events.ts:27](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/escrow-events.ts#L27) | +| `escrowId?` | `string` | [packages/connect-core/src/escrow-events.ts:27](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/escrow-events.ts#L27) | --- # Interface: FiatReceiptParams -Defined in: [packages/connect-core/src/resources.ts:61](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L61) +Defined in: [packages/connect-core/src/resources.ts:61](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L61) ## Properties | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| `method` | [`FiatPaymentMethod`](#typealias.fiatpaymentmethod) | - | [packages/connect-core/src/resources.ts:62](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L62) | -| `receipt?` | `string` | Base64-encoded receipt image or document. | [packages/connect-core/src/resources.ts:65](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L65) | -| `reference` | `string` | - | [packages/connect-core/src/resources.ts:63](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L63) | +| `method` | [`FiatPaymentMethod`](#typealias.fiatpaymentmethod) | - | [packages/connect-core/src/resources.ts:62](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L62) | +| `receipt?` | `string` | Base64-encoded receipt image or document. | [packages/connect-core/src/resources.ts:65](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L65) | +| `reference` | `string` | - | [packages/connect-core/src/resources.ts:63](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L63) | --- # Interface: Listing -Defined in: [packages/connect-core/src/resources.ts:5](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L5) +Defined in: [packages/connect-core/src/resources.ts:5](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L5) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `amount` | `string` | [packages/connect-core/src/resources.ts:8](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L8) | -| `asset` | `string` | [packages/connect-core/src/resources.ts:7](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L7) | -| `createdAt` | `string` | [packages/connect-core/src/resources.ts:12](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L12) | -| `id` | `string` | [packages/connect-core/src/resources.ts:6](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L6) | -| `price` | `string` | [packages/connect-core/src/resources.ts:9](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L9) | -| `side` | `"buy"` \| `"sell"` | [packages/connect-core/src/resources.ts:10](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L10) | -| `status` | `string` | [packages/connect-core/src/resources.ts:11](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L11) | +| `amount` | `string` | [packages/connect-core/src/resources.ts:8](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L8) | +| `asset` | `string` | [packages/connect-core/src/resources.ts:7](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L7) | +| `createdAt` | `string` | [packages/connect-core/src/resources.ts:12](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L12) | +| `id` | `string` | [packages/connect-core/src/resources.ts:6](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L6) | +| `price` | `string` | [packages/connect-core/src/resources.ts:9](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L9) | +| `side` | `"buy"` \| `"sell"` | [packages/connect-core/src/resources.ts:10](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L10) | +| `status` | `string` | [packages/connect-core/src/resources.ts:11](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L11) | --- # Interface: PactoApiClient -Defined in: [packages/connect-core/src/resources.ts:86](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L86) +Defined in: [packages/connect-core/src/resources.ts:92](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L92) ## Properties | Property | Modifier | Type | Defined in | | ------ | ------ | ------ | ------ | -| `escrows` | `readonly` | `EscrowsResource` | [packages/connect-core/src/resources.ts:89](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L89) | -| `listings` | `readonly` | `ListingsResource` | [packages/connect-core/src/resources.ts:87](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L87) | -| `quotes` | `readonly` | `QuotesResource` | [packages/connect-core/src/resources.ts:88](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L88) | +| `escrows` | `readonly` | `EscrowsResource` | [packages/connect-core/src/resources.ts:95](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L95) | +| `listings` | `readonly` | `ListingsResource` | [packages/connect-core/src/resources.ts:93](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L93) | +| `quotes` | `readonly` | `QuotesResource` | [packages/connect-core/src/resources.ts:94](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L94) | +| `test` | `readonly` | `TestModeResource` | [packages/connect-core/src/resources.ts:96](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L96) | --- # Interface: PactoBridgeEnvelope -Defined in: [packages/connect-core/src/bridge.ts:28](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L28) +Defined in: [packages/connect-core/src/bridge.ts:28](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L28) @pacto-connect/core @@ -1645,16 +1831,16 @@ Framework-agnostic SDK core for Pacto Connect. | Property | Type | Defined in | | ------ | ------ | ------ | -| `message` | [`PactoBridgeMessage`](#typealias.pactobridgemessage) | [packages/connect-core/src/bridge.ts:31](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L31) | -| `source` | `"pacto-connect"` | [packages/connect-core/src/bridge.ts:30](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L30) | -| `v` | `1` | [packages/connect-core/src/bridge.ts:29](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L29) | +| `message` | [`PactoBridgeMessage`](#typealias.pactobridgemessage) | [packages/connect-core/src/bridge.ts:31](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L31) | +| `source` | `"pacto-connect"` | [packages/connect-core/src/bridge.ts:30](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L30) | +| `v` | `1` | [packages/connect-core/src/bridge.ts:29](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L29) | --- # Interface: PactoBridgePayloadMap -Defined in: [packages/connect-core/src/bridge.ts:15](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L15) +Defined in: [packages/connect-core/src/bridge.ts:15](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L15) @pacto-connect/core @@ -1664,31 +1850,31 @@ Framework-agnostic SDK core for Pacto Connect. | Property | Type | Defined in | | ------ | ------ | ------ | -| `checkout:close` | `Record`\<`string`, `never`\> | [packages/connect-core/src/bridge.ts:17](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L17) | -| `checkout:complete` | \{ `escrow`: [`Escrow`](#interface.escrow); \} | [packages/connect-core/src/bridge.ts:18](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L18) | -| `checkout:complete.escrow` | [`Escrow`](#interface.escrow) | [packages/connect-core/src/bridge.ts:18](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L18) | -| `checkout:dispute` | \{ `escrow`: [`Escrow`](#interface.escrow); \} | [packages/connect-core/src/bridge.ts:19](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L19) | -| `checkout:dispute.escrow` | [`Escrow`](#interface.escrow) | [packages/connect-core/src/bridge.ts:19](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L19) | -| `checkout:error` | \{ `message`: `string`; \} | [packages/connect-core/src/bridge.ts:20](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L20) | -| `checkout:error.message` | `string` | [packages/connect-core/src/bridge.ts:20](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L20) | -| `checkout:ready` | \{ `sessionId`: `string`; \} | [packages/connect-core/src/bridge.ts:16](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L16) | -| `checkout:ready.sessionId` | `string` | [packages/connect-core/src/bridge.ts:16](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L16) | -| `checkout:step` | \{ `step`: [`CheckoutStep`](#typealias.checkoutstep); \} | [packages/connect-core/src/bridge.ts:21](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L21) | -| `checkout:step.step` | [`CheckoutStep`](#typealias.checkoutstep) | [packages/connect-core/src/bridge.ts:21](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L21) | +| `checkout:close` | `Record`\<`string`, `never`\> | [packages/connect-core/src/bridge.ts:17](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L17) | +| `checkout:complete` | \{ `escrow`: [`Escrow`](#interface.escrow); \} | [packages/connect-core/src/bridge.ts:18](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L18) | +| `checkout:complete.escrow` | [`Escrow`](#interface.escrow) | [packages/connect-core/src/bridge.ts:18](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L18) | +| `checkout:dispute` | \{ `escrow`: [`Escrow`](#interface.escrow); \} | [packages/connect-core/src/bridge.ts:19](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L19) | +| `checkout:dispute.escrow` | [`Escrow`](#interface.escrow) | [packages/connect-core/src/bridge.ts:19](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L19) | +| `checkout:error` | \{ `message`: `string`; \} | [packages/connect-core/src/bridge.ts:20](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L20) | +| `checkout:error.message` | `string` | [packages/connect-core/src/bridge.ts:20](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L20) | +| `checkout:ready` | \{ `sessionId`: `string`; \} | [packages/connect-core/src/bridge.ts:16](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L16) | +| `checkout:ready.sessionId` | `string` | [packages/connect-core/src/bridge.ts:16](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L16) | +| `checkout:step` | \{ `step`: [`CheckoutStep`](#typealias.checkoutstep); \} | [packages/connect-core/src/bridge.ts:21](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L21) | +| `checkout:step.step` | [`CheckoutStep`](#typealias.checkoutstep) | [packages/connect-core/src/bridge.ts:21](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L21) | --- # Interface: PactoClient -Defined in: [packages/connect-core/src/client.ts:43](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L43) +Defined in: [packages/connect-core/src/client.ts:43](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L43) ## Properties | Property | Modifier | Type | Defined in | | ------ | ------ | ------ | ------ | -| `gatewayUrl` | `readonly` | `string` | [packages/connect-core/src/client.ts:45](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L45) | -| `publishableKey` | `readonly` | `string` | [packages/connect-core/src/client.ts:44](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L44) | +| `gatewayUrl` | `readonly` | `string` | [packages/connect-core/src/client.ts:45](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L45) | +| `publishableKey` | `readonly` | `string` | [packages/connect-core/src/client.ts:44](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L44) | ## Methods @@ -1698,7 +1884,7 @@ Defined in: [packages/connect-core/src/client.ts:43](https://github.com/KevinLat api(session): PactoApiClient; ``` -Defined in: [packages/connect-core/src/client.ts:48](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L48) +Defined in: [packages/connect-core/src/client.ts:48](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L48) #### Parameters @@ -1718,7 +1904,7 @@ Defined in: [packages/connect-core/src/client.ts:48](https://github.com/KevinLat createCheckoutSession(params): Promise; ``` -Defined in: [packages/connect-core/src/client.ts:46](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L46) +Defined in: [packages/connect-core/src/client.ts:46](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L46) #### Parameters @@ -1738,7 +1924,7 @@ Defined in: [packages/connect-core/src/client.ts:46](https://github.com/KevinLat resumeCheckoutSession(data): PactoSession; ``` -Defined in: [packages/connect-core/src/client.ts:47](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L47) +Defined in: [packages/connect-core/src/client.ts:47](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L47) #### Parameters @@ -1755,54 +1941,126 @@ Defined in: [packages/connect-core/src/client.ts:47](https://github.com/KevinLat # Interface: PactoInitOptions -Defined in: [packages/connect-core/src/client.ts:17](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L17) +Defined in: [packages/connect-core/src/client.ts:17](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L17) + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `baseDelayMs?` | `number` | Base delay in milliseconds for exponential backoff. | [packages/connect-core/src/client.ts:27](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L27) | +| `gatewayUrl?` | `string` | Gateway base URL. Defaults to the hosted Pacto Connect gateway. | [packages/connect-core/src/client.ts:21](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L21) | +| `maxReconnectAttempts?` | `number` | Maximum reconnect attempts for escrow event streams. | [packages/connect-core/src/client.ts:29](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L29) | +| `maxRetries?` | `number` | Maximum retry attempts for transient failures. | [packages/connect-core/src/client.ts:25](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L25) | +| `origin?` | `string` | Origin header for non-browser environments. | [packages/connect-core/src/client.ts:23](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L23) | +| `publishableKey` | `string` | Publishable key issued by the Connect Gateway (pk_live_* / pk_test_*). | [packages/connect-core/src/client.ts:19](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L19) | + + +--- + +# Interface: PactoMessages + +Defined in: [packages/connect-core/src/i18n.ts:14](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L14) ## Properties | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| `baseDelayMs?` | `number` | Base delay in milliseconds for exponential backoff. | [packages/connect-core/src/client.ts:27](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L27) | -| `gatewayUrl?` | `string` | Gateway base URL. Defaults to the hosted Pacto Connect gateway. | [packages/connect-core/src/client.ts:21](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L21) | -| `maxReconnectAttempts?` | `number` | Maximum reconnect attempts for escrow event streams. | [packages/connect-core/src/client.ts:29](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L29) | -| `maxRetries?` | `number` | Maximum retry attempts for transient failures. | [packages/connect-core/src/client.ts:25](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L25) | -| `origin?` | `string` | Origin header for non-browser environments. | [packages/connect-core/src/client.ts:23](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L23) | -| `publishableKey` | `string` | Publishable key issued by the Connect Gateway (pk_live_* / pk_test_*). | [packages/connect-core/src/client.ts:19](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L19) | +| `actions` | \{ `close`: `string`; `closeAria`: `string`; `confirmDeposit`: `string`; `forceDispute`: `string`; `forceRelease`: `string`; `forceTimeout`: `string`; `retry`: `string`; `submitReceipt`: `string`; \} | - | [packages/connect-core/src/i18n.ts:17](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L17) | +| `actions.close` | `string` | - | [packages/connect-core/src/i18n.ts:18](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L18) | +| `actions.closeAria` | `string` | - | [packages/connect-core/src/i18n.ts:19](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L19) | +| `actions.confirmDeposit` | `string` | - | [packages/connect-core/src/i18n.ts:21](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L21) | +| `actions.forceDispute` | `string` | - | [packages/connect-core/src/i18n.ts:24](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L24) | +| `actions.forceRelease` | `string` | - | [packages/connect-core/src/i18n.ts:23](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L23) | +| `actions.forceTimeout` | `string` | - | [packages/connect-core/src/i18n.ts:25](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L25) | +| `actions.retry` | `string` | - | [packages/connect-core/src/i18n.ts:20](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L20) | +| `actions.submitReceipt` | `string` | - | [packages/connect-core/src/i18n.ts:22](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L22) | +| `labels` | \{ `availableListings`: `string`; `depositInstruction`: `string`; `disputed`: `string`; `escrowMilestones`: `string`; `genericError`: `string`; `loading`: `string`; `paymentMethod`: `string`; `reference`: `string`; `referenceAria`: `string`; `simulatorControls`: `string`; `success`: `string`; `testBanner`: `string`; `waiting`: `string`; \} | - | [packages/connect-core/src/i18n.ts:27](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L27) | +| `labels.availableListings` | `string` | - | [packages/connect-core/src/i18n.ts:31](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L31) | +| `labels.depositInstruction` | `string` | Placeholders: {amount} {asset} | [packages/connect-core/src/i18n.ts:39](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L39) | +| `labels.disputed` | `string` | Placeholder: {escrowId} | [packages/connect-core/src/i18n.ts:43](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L43) | +| `labels.escrowMilestones` | `string` | - | [packages/connect-core/src/i18n.ts:32](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L32) | +| `labels.genericError` | `string` | - | [packages/connect-core/src/i18n.ts:37](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L37) | +| `labels.loading` | `string` | - | [packages/connect-core/src/i18n.ts:34](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L34) | +| `labels.paymentMethod` | `string` | - | [packages/connect-core/src/i18n.ts:28](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L28) | +| `labels.reference` | `string` | - | [packages/connect-core/src/i18n.ts:29](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L29) | +| `labels.referenceAria` | `string` | - | [packages/connect-core/src/i18n.ts:30](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L30) | +| `labels.simulatorControls` | `string` | - | [packages/connect-core/src/i18n.ts:33](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L33) | +| `labels.success` | `string` | Placeholder: {escrowId} | [packages/connect-core/src/i18n.ts:41](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L41) | +| `labels.testBanner` | `string` | - | [packages/connect-core/src/i18n.ts:36](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L36) | +| `labels.waiting` | `string` | - | [packages/connect-core/src/i18n.ts:35](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L35) | +| `milestones` | `Record`\<[`EscrowEventName`](#typealias.escroweventname), `string`\> | - | [packages/connect-core/src/i18n.ts:16](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L16) | +| `steps` | `Record`\<[`CheckoutStep`](#typealias.checkoutstep), `string`\> | - | [packages/connect-core/src/i18n.ts:15](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L15) | --- # Interface: PactoSessionData -Defined in: [packages/connect-core/src/client.ts:36](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L36) +Defined in: [packages/connect-core/src/client.ts:36](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L36) + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `clientSecret` | `string` | [packages/connect-core/src/client.ts:38](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L38) | +| `expiresAt` | `Date` | [packages/connect-core/src/client.ts:39](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L39) | +| `mode` | [`CheckoutMode`](#typealias.checkoutmode) | [packages/connect-core/src/client.ts:40](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L40) | +| `sessionId` | `string` | [packages/connect-core/src/client.ts:37](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L37) | + + +--- + +# Interface: PactoTheme + +Defined in: [packages/connect-core/src/theme.ts:11](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L11) + +White-label theming for the checkout widget. + +Design tokens are exposed as CSS custom properties under the `--pacto-*` +namespace. `DEFAULT_THEME` is the single source of truth for default values; +the stylesheet references each token with the default baked in as the var() +fallback, so merchants can override any subset via `themeToCssVars` (inline +vars) or by setting the CSS variables directly in their own stylesheet. ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `clientSecret` | `string` | [packages/connect-core/src/client.ts:38](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L38) | -| `expiresAt` | `Date` | [packages/connect-core/src/client.ts:39](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L39) | -| `mode` | [`CheckoutMode`](#typealias.checkoutmode) | [packages/connect-core/src/client.ts:40](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L40) | -| `sessionId` | `string` | [packages/connect-core/src/client.ts:37](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L37) | +| `colors` | \{ `border`: `string`; `danger`: `string`; `mutedText`: `string`; `overlay`: `string`; `primary`: `string`; `primaryText`: `string`; `surface`: `string`; `text`: `string`; \} | [packages/connect-core/src/theme.ts:12](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L12) | +| `colors.border` | `string` | [packages/connect-core/src/theme.ts:18](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L18) | +| `colors.danger` | `string` | [packages/connect-core/src/theme.ts:20](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L20) | +| `colors.mutedText` | `string` | [packages/connect-core/src/theme.ts:17](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L17) | +| `colors.overlay` | `string` | [packages/connect-core/src/theme.ts:19](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L19) | +| `colors.primary` | `string` | [packages/connect-core/src/theme.ts:13](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L13) | +| `colors.primaryText` | `string` | [packages/connect-core/src/theme.ts:14](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L14) | +| `colors.surface` | `string` | [packages/connect-core/src/theme.ts:15](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L15) | +| `colors.text` | `string` | [packages/connect-core/src/theme.ts:16](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L16) | +| `radius` | `string` | [packages/connect-core/src/theme.ts:27](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L27) | +| `spacing` | `string` | [packages/connect-core/src/theme.ts:28](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L28) | +| `typography` | \{ `fontFamily`: `string`; `fontSize`: `string`; `headingSize`: `string`; \} | [packages/connect-core/src/theme.ts:22](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L22) | +| `typography.fontFamily` | `string` | [packages/connect-core/src/theme.ts:23](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L23) | +| `typography.fontSize` | `string` | [packages/connect-core/src/theme.ts:24](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L24) | +| `typography.headingSize` | `string` | [packages/connect-core/src/theme.ts:25](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L25) | --- # Interface: Quote -Defined in: [packages/connect-core/src/resources.ts:15](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L15) +Defined in: [packages/connect-core/src/resources.ts:15](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L15) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `amount` | `string` | [packages/connect-core/src/resources.ts:19](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L19) | -| `asset` | `string` | [packages/connect-core/src/resources.ts:18](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L18) | -| `createdAt` | `string` | [packages/connect-core/src/resources.ts:23](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L23) | -| `expiresAt` | `string` | [packages/connect-core/src/resources.ts:22](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L22) | -| `id` | `string` | [packages/connect-core/src/resources.ts:16](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L16) | -| `listingId?` | `string` | [packages/connect-core/src/resources.ts:17](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L17) | -| `price` | `string` | [packages/connect-core/src/resources.ts:20](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L20) | -| `side` | `"buy"` \| `"sell"` | [packages/connect-core/src/resources.ts:21](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L21) | +| `amount` | `string` | [packages/connect-core/src/resources.ts:19](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L19) | +| `asset` | `string` | [packages/connect-core/src/resources.ts:18](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L18) | +| `createdAt` | `string` | [packages/connect-core/src/resources.ts:23](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L23) | +| `expiresAt` | `string` | [packages/connect-core/src/resources.ts:22](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L22) | +| `id` | `string` | [packages/connect-core/src/resources.ts:16](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L16) | +| `listingId?` | `string` | [packages/connect-core/src/resources.ts:17](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L17) | +| `price` | `string` | [packages/connect-core/src/resources.ts:20](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L20) | +| `side` | `"buy"` \| `"sell"` | [packages/connect-core/src/resources.ts:21](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L21) | --- @@ -1813,7 +2071,7 @@ Defined in: [packages/connect-core/src/resources.ts:15](https://github.com/Kevin type CheckoutMode = "buy" | "sell"; ``` -Defined in: [packages/connect-core/src/client.ts:15](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L15) +Defined in: [packages/connect-core/src/client.ts:15](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L15) --- @@ -1832,7 +2090,7 @@ type CheckoutStep = | "error"; ``` -Defined in: [packages/connect-core/src/checkout-flow.ts:11](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/checkout-flow.ts#L11) +Defined in: [packages/connect-core/src/checkout-flow.ts:12](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/checkout-flow.ts#L12) --- @@ -1851,7 +2109,24 @@ type CreateCheckoutSessionParams = }; ``` -Defined in: [packages/connect-core/src/client.ts:32](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L32) +Defined in: [packages/connect-core/src/client.ts:32](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L32) + + +--- + +# Type Alias: DeepPartial\ + +```ts +type DeepPartial = { [K in keyof T]?: T[K] extends object ? DeepPartial : T[K] }; +``` + +Defined in: [packages/connect-core/src/theme.ts:31](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L31) + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | --- @@ -1862,7 +2137,7 @@ Defined in: [packages/connect-core/src/client.ts:32](https://github.com/KevinLat type EscrowEventHandler = (event) => void; ``` -Defined in: [packages/connect-core/src/escrow-events.ts:24](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/escrow-events.ts#L24) +Defined in: [packages/connect-core/src/escrow-events.ts:24](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/escrow-events.ts#L24) ## Parameters @@ -1883,7 +2158,7 @@ Defined in: [packages/connect-core/src/escrow-events.ts:24](https://github.com/K type EscrowEventName = typeof ESCROW_EVENT_NAMES[number]; ``` -Defined in: [packages/connect-core/src/escrow-events.ts:11](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/escrow-events.ts#L11) +Defined in: [packages/connect-core/src/escrow-events.ts:11](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/escrow-events.ts#L11) --- @@ -1894,7 +2169,7 @@ Defined in: [packages/connect-core/src/escrow-events.ts:11](https://github.com/K type EscrowMilestone = "funded" | "fiat_reported" | "released" | "disputed"; ``` -Defined in: [packages/connect-core/src/escrow-events.ts:14](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/escrow-events.ts#L14) +Defined in: [packages/connect-core/src/escrow-events.ts:14](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/escrow-events.ts#L14) Maps to Pacto P2P `escrow_milestones` lifecycle states. @@ -1907,7 +2182,7 @@ Maps to Pacto P2P `escrow_milestones` lifecycle states. type EscrowStatus = "pending" | "active" | "funded" | "released" | "cancelled" | "disputed"; ``` -Defined in: [packages/connect-core/src/resources.ts:3](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L3) +Defined in: [packages/connect-core/src/resources.ts:3](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L3) --- @@ -1918,7 +2193,7 @@ Defined in: [packages/connect-core/src/resources.ts:3](https://github.com/KevinL type FiatPaymentMethod = "SINPE" | "SPEI"; ``` -Defined in: [packages/connect-core/src/resources.ts:59](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/resources.ts#L59) +Defined in: [packages/connect-core/src/resources.ts:59](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/resources.ts#L59) --- @@ -1935,7 +2210,7 @@ type PactoBridgeEventType = | "checkout:step"; ``` -Defined in: [packages/connect-core/src/bridge.ts:7](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L7) +Defined in: [packages/connect-core/src/bridge.ts:7](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L7) @pacto-connect/core @@ -1950,7 +2225,7 @@ Framework-agnostic SDK core for Pacto Connect. type PactoBridgeMessage = { [K in PactoBridgeEventType]: { payload: PactoBridgePayloadMap[K]; type: K } }[T]; ``` -Defined in: [packages/connect-core/src/bridge.ts:24](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L24) +Defined in: [packages/connect-core/src/bridge.ts:24](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L24) @pacto-connect/core @@ -1963,6 +2238,17 @@ Framework-agnostic SDK core for Pacto Connect. | `T` *extends* [`PactoBridgeEventType`](#typealias.pactobridgeeventtype) | [`PactoBridgeEventType`](#typealias.pactobridgeeventtype) | +--- + +# Type Alias: PactoLocale + +```ts +type PactoLocale = "en" | "es"; +``` + +Defined in: [packages/connect-core/src/i18n.ts:12](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L12) + + --- # Variable: DEFAULT\_GATEWAY\_URL @@ -1971,7 +2257,18 @@ Framework-agnostic SDK core for Pacto Connect. const DEFAULT_GATEWAY_URL: "https://connect.pacto.example" = 'https://connect.pacto.example'; ``` -Defined in: [packages/connect-core/src/client.ts:67](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L67) +Defined in: [packages/connect-core/src/client.ts:67](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L67) + + +--- + +# Variable: DEFAULT\_THEME + +```ts +const DEFAULT_THEME: PactoTheme; +``` + +Defined in: [packages/connect-core/src/theme.ts:37](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L37) --- @@ -1982,7 +2279,7 @@ Defined in: [packages/connect-core/src/client.ts:67](https://github.com/KevinLat const ESCROW_EVENT_NAMES: readonly ["escrow.funded", "fiat.reported", "released", "disputed"]; ``` -Defined in: [packages/connect-core/src/escrow-events.ts:4](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/escrow-events.ts#L4) +Defined in: [packages/connect-core/src/escrow-events.ts:4](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/escrow-events.ts#L4) --- @@ -1993,7 +2290,7 @@ Defined in: [packages/connect-core/src/escrow-events.ts:4](https://github.com/Ke const PACTO_BRIDGE_SOURCE: "pacto-connect"; ``` -Defined in: [packages/connect-core/src/bridge.ts:4](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L4) +Defined in: [packages/connect-core/src/bridge.ts:4](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L4) @pacto-connect/core @@ -2008,7 +2305,7 @@ Framework-agnostic SDK core for Pacto Connect. const PACTO_BRIDGE_VERSION: 1; ``` -Defined in: [packages/connect-core/src/bridge.ts:5](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/bridge.ts#L5) +Defined in: [packages/connect-core/src/bridge.ts:5](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/bridge.ts#L5) @pacto-connect/core @@ -2025,13 +2322,24 @@ const Pacto: { }; ``` -Defined in: [packages/connect-core/src/client.ts:229](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L229) +Defined in: [packages/connect-core/src/client.ts:229](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L229) ## Type Declaration | Name | Type | Defined in | | ------ | ------ | ------ | -| `init()` | (`options`) => [`PactoClient`](#interface.pactoclient) | [packages/connect-core/src/client.ts:229](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/client.ts#L229) | +| `init()` | (`options`) => [`PactoClient`](#interface.pactoclient) | [packages/connect-core/src/client.ts:229](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/client.ts#L229) | + + +--- + +# Variable: STYLE\_ELEMENT\_ID + +```ts +const STYLE_ELEMENT_ID: "pacto-checkout-styles" = 'pacto-checkout-styles'; +``` + +Defined in: [packages/connect-core/src/theme.ts:35](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/theme.ts#L35) --- @@ -2042,4 +2350,26 @@ Defined in: [packages/connect-core/src/client.ts:229](https://github.com/KevinLa const VERSION: "0.0.0" = '0.0.0'; ``` -Defined in: [packages/connect-core/src/index.ts:70](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-core/src/index.ts#L70) +Defined in: [packages/connect-core/src/index.ts:87](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/index.ts#L87) + + +--- + +# Variable: enMessages + +```ts +const enMessages: PactoMessages; +``` + +Defined in: [packages/connect-core/src/i18n.ts:47](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L47) + + +--- + +# Variable: esMessages + +```ts +const esMessages: PactoMessages; +``` + +Defined in: [packages/connect-core/src/i18n.ts:91](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-core/src/i18n.ts#L91) diff --git a/apps/docs/pages/api-reference/elements.mdx b/apps/docs/pages/api-reference/elements.mdx index ce6d2bd..03ccf5d 100644 --- a/apps/docs/pages/api-reference/elements.mdx +++ b/apps/docs/pages/api-reference/elements.mdx @@ -20,7 +20,7 @@ npm install @pacto-connect/elements # Class: CheckoutView -Defined in: [packages/connect-elements/src/ui.ts:47](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/ui.ts#L47) +Defined in: [packages/connect-elements/src/ui.ts:32](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/ui.ts#L32) ## Constructors @@ -33,7 +33,7 @@ new CheckoutView( options): CheckoutView; ``` -Defined in: [packages/connect-elements/src/ui.ts:52](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/ui.ts#L52) +Defined in: [packages/connect-elements/src/ui.ts:37](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/ui.ts#L37) #### Parameters @@ -55,7 +55,7 @@ Defined in: [packages/connect-elements/src/ui.ts:52](https://github.com/KevinLat destroy(): void; ``` -Defined in: [packages/connect-elements/src/ui.ts:131](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/ui.ts#L131) +Defined in: [packages/connect-elements/src/ui.ts:141](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/ui.ts#L141) #### Returns @@ -69,7 +69,7 @@ Defined in: [packages/connect-elements/src/ui.ts:131](https://github.com/KevinLa render(): void; ``` -Defined in: [packages/connect-elements/src/ui.ts:58](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/ui.ts#L58) +Defined in: [packages/connect-elements/src/ui.ts:43](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/ui.ts#L43) #### Returns @@ -80,7 +80,7 @@ Defined in: [packages/connect-elements/src/ui.ts:58](https://github.com/KevinLat # Class: PactoCheckoutElement -Defined in: [packages/connect-elements/src/element.ts:82](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/element.ts#L82) +Defined in: [packages/connect-elements/src/element.ts:96](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/element.ts#L96) ## Extends @@ -111,8 +111,8 @@ HTMLElement.constructor | Property | Modifier | Type | Description | Inherited from | Defined in | | ------ | ------ | ------ | ------ | ------ | ------ | | `[InitialValue]?` | `public` | `string` | - | `HTMLElement.[InitialValue]` | node\_modules/@testing-library/user-event/dist/types/document/UI.d.ts:7 | -| `[PointerEventsCheck]?` | `public` | \{ `1?`: `object`; `2?`: `object`; \} & \{ `result`: \| \{ `pointerEvents`: `string`; `tree`: `Element`[]; \} \| `undefined`; \} | - | `HTMLElement.[PointerEventsCheck]` | node\_modules/@testing-library/user-event/dist/types/utils/pointer/cssPointerEvents.d.ts:11 | -| `[TrackChanges]?` | `public` | \{ `nextValue?`: `string`; `previousValue?`: `string`; `tracked?`: `string`[]; \} | - | `HTMLElement.[TrackChanges]` | node\_modules/@testing-library/user-event/dist/types/document/trackValue.d.ts:7 | +| `[PointerEventsCheck]?` | `public` | \{ `1?`: `object`; `2?`: `object`; \} & \{ `result`: \| \{ `pointerEvents`: `string`; `tree`: `Element`[]; \} \| `undefined`; \} | - | `HTMLElement.[PointerEventsCheck]` | node\_modules/@testing-library/user-event/dist/types/utils/pointer/cssPointerEvents.d.ts:11 | +| `[TrackChanges]?` | `public` | \{ `nextValue?`: `string`; `previousValue?`: `string`; `tracked?`: `string`[]; \} | - | `HTMLElement.[TrackChanges]` | node\_modules/@testing-library/user-event/dist/types/document/trackValue.d.ts:7 | | `[TrackChanges].nextValue?` | `public` | `string` | - | - | node\_modules/@testing-library/user-event/dist/types/document/trackValue.d.ts:10 | | `[TrackChanges].previousValue?` | `public` | `string` | - | - | node\_modules/@testing-library/user-event/dist/types/document/trackValue.d.ts:8 | | `[TrackChanges].tracked?` | `public` | `string`[] | - | - | node\_modules/@testing-library/user-event/dist/types/document/trackValue.d.ts:9 | @@ -547,7 +547,7 @@ HTMLElement.textContent get static observedAttributes(): string[]; ``` -Defined in: [packages/connect-elements/src/element.ts:90](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/element.ts#L90) +Defined in: [packages/connect-elements/src/element.ts:104](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/element.ts#L104) ##### Returns @@ -758,7 +758,7 @@ HTMLElement.appendChild applyOptions(options): void; ``` -Defined in: [packages/connect-elements/src/element.ts:152](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/element.ts#L152) +Defined in: [packages/connect-elements/src/element.ts:169](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/element.ts#L169) #### Parameters @@ -835,7 +835,7 @@ attributeChangedCallback( newValue): void; ``` -Defined in: [packages/connect-elements/src/element.ts:116](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/element.ts#L116) +Defined in: [packages/connect-elements/src/element.ts:133](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/element.ts#L133) #### Parameters @@ -995,7 +995,7 @@ HTMLElement.cloneNode close(): void; ``` -Defined in: [packages/connect-elements/src/element.ts:140](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/element.ts#L140) +Defined in: [packages/connect-elements/src/element.ts:157](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/element.ts#L157) #### Returns @@ -1191,7 +1191,7 @@ HTMLElement.computedStyleMap connectedCallback(): void; ``` -Defined in: [packages/connect-elements/src/element.ts:106](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/element.ts#L106) +Defined in: [packages/connect-elements/src/element.ts:123](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/element.ts#L123) #### Returns @@ -1235,7 +1235,7 @@ HTMLElement.contains disconnectedCallback(): void; ``` -Defined in: [packages/connect-elements/src/element.ts:112](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/element.ts#L112) +Defined in: [packages/connect-elements/src/element.ts:129](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/element.ts#L129) #### Returns @@ -2378,7 +2378,7 @@ HTMLElement.normalize open(): void; ``` -Defined in: [packages/connect-elements/src/element.ts:130](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/element.ts#L130) +Defined in: [packages/connect-elements/src/element.ts:147](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/element.ts#L147) #### Returns @@ -2744,7 +2744,7 @@ HTMLElement.querySelectorAll readOptionsFromAttributes(): PactoCheckoutOptions; ``` -Defined in: [packages/connect-elements/src/element.ts:160](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/element.ts#L160) +Defined in: [packages/connect-elements/src/element.ts:177](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/element.ts#L177) #### Returns @@ -3673,7 +3673,7 @@ HTMLElement.webkitMatchesSelector function applyCheckoutOptions(element, options): void; ``` -Defined in: [packages/connect-elements/src/element.ts:263](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/element.ts#L263) +Defined in: [packages/connect-elements/src/element.ts:287](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/element.ts#L287) ## Parameters @@ -3695,7 +3695,7 @@ Defined in: [packages/connect-elements/src/element.ts:263](https://github.com/Ke function bootstrapCheckoutFrame(options?): FramePageHandle; ``` -Defined in: [packages/connect-elements/src/frame-page.ts:49](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/frame-page.ts#L49) +Defined in: [packages/connect-elements/src/frame-page.ts:49](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/frame-page.ts#L49) ## Parameters @@ -3716,7 +3716,7 @@ Defined in: [packages/connect-elements/src/frame-page.ts:49](https://github.com/ function createFocusTrap(container, onEscape?): FocusTrap; ``` -Defined in: [packages/connect-elements/src/focus-trap.ts:30](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/focus-trap.ts#L30) +Defined in: [packages/connect-elements/src/focus-trap.ts:30](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/focus-trap.ts#L30) Activates a focus trap on `container`. The container is re-queried on every keydown so the trap keeps working across re-renders that swap its children. @@ -3741,7 +3741,7 @@ keydown so the trap keeps working across re-renders that swap its children. function injectCheckoutStyles(doc?): HTMLStyleElement | null; ``` -Defined in: [packages/connect-elements/src/styles.ts:109](https://github.com/KevinLatino/pacto-connect/blob/31f80df988950d6a4d6d919aaebcf39d4d3c5b75/packages/connect-elements/src/styles.ts#L109) +Defined in: [packages/connect-elements/src/styles.ts:22](https://github.com/PACTO-LAT/pacto-connect/blob/main/packages/connect-elements/src/styles.ts#L22) Injects the default checkout stylesheet into `document.head` once. Returns the ` +``` + + + + + +Both integrations accept the **exact same `theme` shape** — `{ colors, typography, radius, spacing }`, all optional and all deep-mergeable. + +### Restyling without a `theme` prop + +Plain-HTML embeds (or hosts that just want a global brand stylesheet) can set +the variables directly in CSS, no JS config required: + +```css +:root { + --pacto-color-primary: #e11d48; + --pacto-radius: 4px; +} +``` + + + Set variables on `:root` or on an ancestor of the widget (for the web + component, the `pacto-checkout` element itself works). `--pacto-color-overlay` + in particular styles the backdrop, which is a **parent** of the dialog — so + scoping variables to `.pacto-checkout-dialog` alone won't reach it. + + +## Brand logo + +Pass `logoUrl` (React prop / mount option) or the `logo-url` attribute (web +component) to render an `` next to the step +title in the header. Pair it with `logoAlt` / `logo-alt` for accessible alt +text. Size the logo with your own CSS: + +```css +.pacto-checkout-logo { + max-height: 2rem; +} +``` + + + Both integrations inject one default stylesheet (`