@waffo/pancake-ts 0.16.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +2 -1
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +11 -5
  5. package/dist/index.d.ts +11 -5
  6. package/dist/index.js.map +1 -1
  7. package/docs/api-reference.md +29 -29
  8. package/package.json +1 -1
package/docs/api-reference.md CHANGED
@@ -666,21 +666,21 @@ const subResult = await client.checkout.authenticated.create({
666
666
 
667
667
  **Parameters `AuthenticatedCheckoutParams`**:
668
668
 
669
- | Field | Type | Required | Description |
670
- | ------------------------- | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
671
- | `productId` | `string` | Yes | Product ID (product type is auto-detected server-side) |
672
- | `currency` | `string` | Yes | Currency code (ISO 4217) |
673
- | `buyerIdentity` | `string` | Yes | Customer identity (email or merchant-defined identifier) |
674
- | `buyerEmail` | `string` | No | Pre-fill checkout page email field (independent from `buyerIdentity`) |
675
- | `billingDetail` | `BillingDetail` | No | Pre-filled billing details (country, tax ID, etc.) |
676
- | `priceSnapshot` | `PriceInfo` | No | Price snapshot override (reads from DB if omitted) |
677
- | `withTrial` | `boolean` | No | Enable trial period (subscription only) |
678
- | `successUrl` | `string` | No | Redirect URL after successful payment |
679
- | `expiresInSeconds` | `number` | No | Session expiry in seconds (default: 45 minutes) |
680
- | `darkMode` | `boolean` | No | Dark mode override (true=dark, false=light, omit=store default) |
681
- | `metadata` | `Record<string, string>` | No | Custom metadata |
682
- | `orderMerchantExternalId` | `string` | No | Your business-side order identifier (max 128 chars). Surfaces under the same name on `Order` / `Payment` / `Refund` GraphQL types and in webhook payload (`data.orderMerchantExternalId`). |
683
- | `language` | `string` | No | Default checkout cashier language (IETF BCP 47), e.g. `pt-BR`, `zh-Hant-TW`. Must be one of the supported cashier languages; the customer can switch on the page. |
669
+ | Field | Type | Required | Description |
670
+ | ------------------------- | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
671
+ | `productId` | `string` | Yes | Product ID (product type is auto-detected server-side) |
672
+ | `currency` | `string` | Yes | Currency code (ISO 4217) |
673
+ | `buyerIdentity` | `string` | Yes | Customer identity (email or merchant-defined identifier) |
674
+ | `buyerEmail` | `string` | No | Pre-fill checkout page email field (independent from `buyerIdentity`) |
675
+ | `billingDetail` | `BillingDetail` | No | Pre-filled billing details. Passing this couples the cashier to the order's billing country: it then offers only that country's payment market and the customer cannot switch. The country that applies is the one on the finished order, not the one you sent; a country outside the payment markets we cover applies no restriction. Omit to leave the cashier unrestricted. |
676
+ | `priceSnapshot` | `PriceInfo` | No | Price snapshot override (reads from DB if omitted) |
677
+ | `withTrial` | `boolean` | No | Enable trial period (subscription only) |
678
+ | `successUrl` | `string` | No | Redirect URL after successful payment |
679
+ | `expiresInSeconds` | `number` | No | Session expiry in seconds (default: 45 minutes) |
680
+ | `darkMode` | `boolean` | No | Dark mode override (true=dark, false=light, omit=store default) |
681
+ | `metadata` | `Record<string, string>` | No | Custom metadata |
682
+ | `orderMerchantExternalId` | `string` | No | Your business-side order identifier (max 128 chars). Surfaces under the same name on `Order` / `Payment` / `Refund` GraphQL types and in webhook payload (`data.orderMerchantExternalId`). |
683
+ | `language` | `string` | No | Default checkout cashier language (IETF BCP 47), e.g. `pt-BR`, `zh-Hant-TW`. Must be one of the supported cashier languages; the customer can switch on the page. |
684
684
 
685
685
  **Returns `AuthenticatedCheckoutResult`**:
686
686
 
@@ -750,20 +750,20 @@ const session = await client.checkout.createSession({
750
750
 
751
751
  **Parameters `CreateCheckoutSessionParams`**:
752
752
 
753
- | Field | Type | Required | Description |
754
- | ------------------------- | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
755
- | `productId` | `string` | Yes | Product ID (product type is auto-detected server-side) |
756
- | `currency` | `string` | Yes | Currency code (ISO 4217) |
757
- | `priceSnapshot` | `PriceInfo` | No | Price snapshot override (reads from DB if omitted) |
758
- | `withTrial` | `boolean` | No | Enable trial period (subscription only) |
759
- | `buyerEmail` | `string` | No | Pre-filled customer email |
760
- | `billingDetail` | `BillingDetail` | No | Pre-filled billing details (country, tax ID, etc.) |
761
- | `successUrl` | `string` | No | Redirect URL after successful payment |
762
- | `expiresInSeconds` | `number` | No | Session expiry in seconds (default: 45 minutes) |
763
- | `darkMode` | `boolean` | No | Dark mode override |
764
- | `metadata` | `Record<string, string>` | No | Custom metadata |
765
- | `orderMerchantExternalId` | `string` | No | Your business-side order identifier (max 128 chars). Honored on the API Key (merchant) path; visitor / store-slug flows silently drop it. Same field name in webhook payload and GraphQL. |
766
- | `language` | `string` | No | Default checkout cashier language (IETF BCP 47), e.g. `pt-BR`, `zh-Hant-TW`. Must be one of the supported cashier languages; the customer can switch on the page. |
753
+ | Field | Type | Required | Description |
754
+ | ------------------------- | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
755
+ | `productId` | `string` | Yes | Product ID (product type is auto-detected server-side) |
756
+ | `currency` | `string` | Yes | Currency code (ISO 4217) |
757
+ | `priceSnapshot` | `PriceInfo` | No | Price snapshot override (reads from DB if omitted) |
758
+ | `withTrial` | `boolean` | No | Enable trial period (subscription only) |
759
+ | `buyerEmail` | `string` | No | Pre-filled customer email |
760
+ | `billingDetail` | `BillingDetail` | No | Pre-filled billing details. Passing this couples the cashier to the order's billing country: it then offers only that country's payment market and the customer cannot switch. The country that applies is the one on the finished order, not the one you sent; a country outside the payment markets we cover applies no restriction. Omit to leave the cashier unrestricted. |
761
+ | `successUrl` | `string` | No | Redirect URL after successful payment |
762
+ | `expiresInSeconds` | `number` | No | Session expiry in seconds (default: 45 minutes) |
763
+ | `darkMode` | `boolean` | No | Dark mode override |
764
+ | `metadata` | `Record<string, string>` | No | Custom metadata |
765
+ | `orderMerchantExternalId` | `string` | No | Your business-side order identifier (max 128 chars). Honored on the API Key (merchant) path; visitor / store-slug flows silently drop it. Same field name in webhook payload and GraphQL. |
766
+ | `language` | `string` | No | Default checkout cashier language (IETF BCP 47), e.g. `pt-BR`, `zh-Hant-TW`. Must be one of the supported cashier languages; the customer can switch on the page. |
767
767
 
768
768
  **`BillingDetail` fields**:
769
769
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@waffo/pancake-ts",
3
- "version": "0.16.0",
3
+ "version": "0.17.0",
4
4
  "description": "TypeScript SDK for Waffo Pancake MoR platform — RSA-SHA256 signing, zero runtime dependencies",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",