@waffo/pancake-ts 0.9.0 → 0.11.0

package/CHANGELOG.md

@@ -4,6 +4,64 @@ All notable changes to `@waffo/pancake-ts` will be documented in this file.
 
 Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.0] - 2026-06-05
+
+Aligns Create/Update Product params with backend product-service v2026.6.4: `description` and `successUrl` accept `null` for explicit field clearing (previously only `undefined` / omitted). Backend also tightens `name` to ≤ 64 characters to match the PSP `goodsName` cap — passing a longer name now returns 400.
+
+### Changed
+
+- **`CreateOnetimeProductParams.description` / `successUrl`** — typed `string | null` (was `string`).
+- **`UpdateOnetimeProductParams.description` / `successUrl`** — typed `string | null`.
+- **`CreateSubscriptionProductParams.description` / `successUrl`** — typed `string | null`.
+- **`UpdateSubscriptionProductParams.description` / `successUrl`** — typed `string | null`.
+
+### Migration
+
+If you currently omit `description` / `successUrl` (or pass `undefined`), no change needed — the backend keeps the existing value. To explicitly clear a previously-set value:
+
+```diff
+-await client.onetimeProducts.update({ id, description: undefined });   // keeps existing value
++await client.onetimeProducts.update({ id, description: null });        // clears the field
+```
+
+Backend also accepts `""` for the same effect; SDK uses `null` as the canonical "clear" sentinel.
+
+Note `name.length` must now be ≤ 64. The backend enforced no limit previously; existing names > 64 chars are rare (production scan found 1 internal test outlier, no real merchant data). New attempts > 64 chars return `400 { errors: [{ message: "name must not exceed 64 characters", layer: "product" }] }`.
+
+## [0.10.0] - 2026-06-01
+
+Expands `NotificationSettings` to the full 19-field schema (8 consumer-email + 11 merchant-notify toggles) and narrows `UpdateStoreParams.notificationSettings` to the merchant-writable subset.
+
+### Added
+
+- **`NotificationSettings`** gains 11 fields aligning with the platform schema:
+  - Consumer email (platform-managed): `emailTrialStarted`, `emailTrialEnding`
+  - Merchant notify (merchant-writable): `notifySubscriptionCanceled`, `notifySubscriptionEnded`, `notifySubscriptionPastDue`, `notifySubscriptionRenewed`, `notifySubscriptionUncanceled`, `notifySubscriptionUpdated`, `notifyChargeback`, `notifyPayoutCompleted`, `notifyPayoutFailed`
+- **`MerchantWritableNotificationSettings`** — new type exposing only the 11 `notify*` toggles. Use this for any merchant-side `update-store` call. `email*` toggles are managed by the PANCAKE platform (admin via DB) and silently dropped if passed to the merchant API.
+
+### Changed
+
+- **`UpdateStoreParams.notificationSettings` narrowed** from `Partial<NotificationSettings>` to `Partial<MerchantWritableNotificationSettings>`. Passing `email*` keys now fails TypeScript compilation rather than being silently dropped at the server.
+- README "Update store" example pruned to only show writable `notify*` fields with an explicit comment on the platform-managed `email*` subset.
+
+### Migration
+
+If your `client.stores.update` calls passed any `emailOrderConfirmation` / `emailSubscription*` / `emailTrial*` keys in `notificationSettings`, remove them — these were already being dropped server-side as of v2026.5 (returned as a `warnings[].aiHint`). Only `notify*` keys are merchant-writable.
+
+```diff
+ await client.stores.update({
+   id: storeId,
+   notificationSettings: {
+-    emailOrderConfirmation: true,
+-    emailSubscriptionCycled: true,
+     notifyNewOrders: true,
+     notifyNewSubscriptions: false,
++    notifyChargeback: true,
++    notifyPayoutFailed: true,
+   },
+ });
+```
+
 ## [0.9.0] - 2026-05-21
 
 Adds flat dual-key external-id fields across write inputs, response entities, and webhook payload. The same field name now appears at every layer (REST request body / REST response / webhook payload / GraphQL).

package/README.md

@@ -369,18 +369,16 @@ const { store } = await client.stores.create({ name: "My Store" });
 
 // Update settings (notification, checkout theme).
 // NOTE: webhook configuration moved to client.webhooks (see Webhooks section below).
+// NOTE: only merchant-facing `notify*` toggles (notifyNewOrders / notifyNewSubscriptions /
+//       notifySubscription* / notifyChargeback / notifyPayout*) are writable here;
+//       consumer email toggles (emailOrderConfirmation, emailSubscription*, emailTrial*) are
+//       managed by the PANCAKE platform and silently dropped if passed.
 const { store: updated } = await client.stores.update({
   id: store.id,
   supportEmail: "help@example.com",
   notificationSettings: {
-    emailOrderConfirmation: true,
-    emailSubscriptionConfirmation: true,
-    emailSubscriptionCycled: true,
-    emailSubscriptionCanceled: true,
-    emailSubscriptionRevoked: true,
-    emailSubscriptionPastDue: true,
     notifyNewOrders: true,
-    notifyNewSubscriptions: true,
+    notifyNewSubscriptions: false,
   },
 });