@waffo/pancake-ts 0.2.2 → 0.3.1

package/CHANGELOG.md

@@ -4,6 +4,32 @@ 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.3.1] - 2026-04-09
+
+### Changed
+
+- **Product update simplified** — `update()` only modifies provided fields; omitted fields are preserved. `name`, `prices`, and `billingPeriod` (subscription) are now optional.
+
+### Documentation
+
+- **GraphQL type difference warning** — Added warnings in `graphql-guide.md`, `api-reference.md`, and external docs (EN/ZH/JA) clarifying that SDK TypeScript types reflect the REST API shape and differ from GraphQL schema types. Users should always use introspection for GraphQL queries.
+
+## [0.3.0] - 2026-04-09
+
+### Breaking Changes
+
+- **Checkout params simplified** — `storeId` and `productType` removed from `CreateCheckoutSessionParams`, `AnonymousCheckoutParams`, and `AuthenticatedCheckoutParams`. The server now derives both from `productId` automatically. Only `productId` + `currency` are required.
+- **`CheckoutSessionProductType` enum removed** — No longer exported. Product type is determined server-side.
+- **`IssueSessionTokenParams.storeId` now optional** — Provide either `storeId` or `productId` (at least one required). When `productId` is given, the server derives the store from the product.
+
+### Added
+
+- **`IssueSessionTokenParams.productId`** — New optional field. When provided without `storeId`, the server derives the store from the product.
+
+### Changed
+
+- **`checkout.authenticated.create()`** — Now sends `productId` (instead of `storeId`) to `issue-session-token` endpoint for parallel session token + checkout session creation.
+
 ## [0.2.2] - 2026-04-03
 
 ### Fixed

package/README.md

@@ -28,9 +28,7 @@ const client = new WaffoPancake({
 
 // Create a checkout session — one call handles token + session + URL
 const result = await client.checkout.authenticated.create({
-  storeId: "STO_xxx",      // from Dashboard > Stores
   productId: "PROD_xxx",   // from Dashboard > Products
-  productType: "onetime",
   currency: "USD",
   buyerIdentity: req.user.email,  // your user's identity
 });
@@ -85,18 +83,14 @@ The merchant provides buyer identity — the SDK issues a session token, creates
 ```typescript
 // Basic — buyer identity only
 const result = await client.checkout.authenticated.create({
-  storeId: "STO_xxx",
   productId: "PROD_xxx",
-  productType: "onetime",
   currency: "USD",
   buyerIdentity: "customer@example.com",
 });
 
 // With dynamic pricing — override stored price (e.g., coupon, volume discount)
 const result = await client.checkout.authenticated.create({
-  storeId: "STO_xxx",
   productId: "PROD_xxx",
-  productType: "onetime",
   currency: "USD",
   buyerIdentity: "customer@example.com",
   priceSnapshot: { amount: "19.99", taxCategory: "digital_goods" },
@@ -104,9 +98,7 @@ const result = await client.checkout.authenticated.create({
 
 // Subscription with trial control + billing detail pre-fill
 const result = await client.checkout.authenticated.create({
-  storeId: "STO_xxx",
   productId: "PROD_xxx",
-  productType: "subscription",
   currency: "USD",
   buyerIdentity: "customer@example.com",
   withTrial: true,  // force enable trial (false = skip, omit = default rules)
@@ -125,17 +117,13 @@ No buyer identity required — the buyer fills in billing details manually on th
 
 ```typescript
 const result = await client.checkout.anonymous.create({
-  storeId: "STO_xxx",
   productId: "PROD_xxx",
-  productType: "onetime",
   currency: "USD",
 });
 
 // Also supports priceSnapshot and withTrial
 const result = await client.checkout.anonymous.create({
-  storeId: "STO_xxx",
   productId: "PROD_xxx",
-  productType: "subscription",
   currency: "USD",
   priceSnapshot: { amount: "4.99", taxCategory: "saas" },
   withTrial: false,  // skip trial for this session

package/dist/index.cjs

@@ -21,7 +21,6 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   BillingPeriod: () => BillingPeriod,
-  CheckoutSessionProductType: () => CheckoutSessionProductType,
   EntityStatus: () => EntityStatus,
   Environment: () => Environment,
   ErrorLayer: () => ErrorLayer,
@@ -344,9 +343,7 @@ function validateBillingDetail(detail) {
   }
 }
 function validateCheckoutCommon(params) {
-  validateShortId("storeId", params.storeId, "STO");
   validateShortId("productId", params.productId, "PROD");
-  validateEnum("productType", params.productType, ["onetime", "subscription"]);
   validateCurrencyCode("currency", params.currency);
   if (params.priceSnapshot) {
     validateAmountString("priceSnapshot.amount", params.priceSnapshot.amount);
@@ -372,13 +369,31 @@ var AuthResource = class {
    * @returns Issued session token with expiration
    *
    * @example
+   * // By store ID
    * const { token, expiresAt } = await client.auth.issueSessionToken({
    *   storeId: "STO_xxx",
    *   buyerIdentity: "customer@example.com",
    * });
+   *
+   * @example
+   * // By product ID (store derived automatically)
+   * const { token, expiresAt } = await client.auth.issueSessionToken({
+   *   productId: "PROD_xxx",
+   *   buyerIdentity: "customer@example.com",
+   * });
    */
   async issueSessionToken(params) {
-    validateShortId("storeId", params.storeId, "STO");
+    if (!params.storeId && !params.productId) {
+      throw new WaffoPancakeError(400, [
+        { message: "Missing required field: provide storeId or productId", layer: "sdk" }
+      ]);
+    }
+    if (params.storeId) {
+      validateShortId("storeId", params.storeId, "STO");
+    }
+    if (params.productId) {
+      validateShortId("productId", params.productId, "PROD");
+    }
     validateRequired("buyerIdentity", params.buyerIdentity);
     return this.http.post("/v1/actions/auth/issue-session-token", params);
   }
@@ -525,9 +540,7 @@ var CheckoutAnonymousResource = class {
    *
    * @example
    * const result = await client.checkout.anonymous.create({
-   *   storeId: "STO_xxx",
    *   productId: "PROD_xxx",
-   *   productType: "onetime",
    *   currency: "USD",
    * });
    * // Redirect to result.checkoutUrl
@@ -561,9 +574,7 @@ var CheckoutAuthenticatedResource = class {
    *
    * @example
    * const result = await client.checkout.authenticated.create({
-   *   storeId: "STO_xxx",
    *   productId: "PROD_xxx",
-   *   productType: "onetime",
    *   currency: "USD",
    *   buyerIdentity: "customer@example.com",
    * });
@@ -575,7 +586,7 @@ var CheckoutAuthenticatedResource = class {
     const { buyerIdentity, buyerEmail, ...sessionFields } = params;
     const [tokenResult, sessionResult] = await Promise.all([
       this.http.post("/v1/actions/auth/issue-session-token", {
-        storeId: params.storeId,
+        productId: params.productId,
         buyerIdentity
       }, { idempotencyWindow: 60 }),
       this.http.post("/v1/actions/checkout/create-session", {
@@ -615,9 +626,7 @@ var CheckoutResource = class {
    *
    * @example
    * const session = await client.checkout.createSession({
-   *   storeId: "STO_xxx",
    *   productId: "PROD_xxx",
-   *   productType: "onetime",
    *   currency: "USD",
    *   buyerEmail: "customer@example.com",
    * });
@@ -684,20 +693,27 @@ var OnetimeProductsResource = class {
   /**
    * Update a one-time product. Creates a new version; skips if unchanged.
    *
-   * @param params - Product update parameters (all content fields required)
+   * @param params - Product update parameters (only `id` is required)
    * @returns Updated product detail
    *
    * @example
+   * // Update only the name
    * const { product } = await client.onetimeProducts.update({
    *   id: "PROD_xxx",
    *   name: "E-Book v2",
+   * });
+   *
+   * @example
+   * // Update prices while preserving other fields
+   * const { product } = await client.onetimeProducts.update({
+   *   id: "PROD_xxx",
    *   prices: { USD: { amount: "39.00", taxCategory: "digital_goods" } },
    * });
    */
   async update(params) {
     validateShortId("id", params.id, "PROD");
-    validateRequired("name", params.name);
-    validatePrices("prices", params.prices);
+    if (params.name !== void 0) validateRequired("name", params.name);
+    if (params.prices) validatePrices("prices", params.prices);
     return this.http.post("/v1/actions/onetime-product/update-product", params);
   }
   /**
@@ -966,22 +982,29 @@ var SubscriptionProductsResource = class {
   /**
    * Update a subscription product. Creates a new version; skips if unchanged.
    *
-   * @param params - Product update parameters (all content fields required)
+   * @param params - Product update parameters (only `id` is required)
    * @returns Updated product detail
    *
    * @example
+   * // Update only the name
    * const { product } = await client.subscriptionProducts.update({
    *   id: "PROD_xxx",
    *   name: "Pro Plan v2",
-   *   billingPeriod: "monthly",
-   *   prices: { USD: { amount: "14.99", taxCategory: "saas" } },
+   * });
+   *
+   * @example
+   * // Update prices and billing period
+   * const { product } = await client.subscriptionProducts.update({
+   *   id: "PROD_xxx",
+   *   billingPeriod: "yearly",
+   *   prices: { USD: { amount: "99.00", taxCategory: "saas" } },
    * });
    */
   async update(params) {
     validateShortId("id", params.id, "PROD");
-    validateRequired("name", params.name);
-    validateEnum("billingPeriod", params.billingPeriod, ["weekly", "monthly", "quarterly", "yearly"]);
-    validatePrices("prices", params.prices);
+    if (params.name !== void 0) validateRequired("name", params.name);
+    if (params.billingPeriod !== void 0) validateEnum("billingPeriod", params.billingPeriod, ["weekly", "monthly", "quarterly", "yearly"]);
+    if (params.prices) validatePrices("prices", params.prices);
     return this.http.post("/v1/actions/subscription-product/update-product", params);
   }
   /**
@@ -1300,11 +1323,6 @@ var MediaType = /* @__PURE__ */ ((MediaType2) => {
   MediaType2["Video"] = "video";
   return MediaType2;
 })(MediaType || {});
-var CheckoutSessionProductType = /* @__PURE__ */ ((CheckoutSessionProductType2) => {
-  CheckoutSessionProductType2["Onetime"] = "onetime";
-  CheckoutSessionProductType2["Subscription"] = "subscription";
-  return CheckoutSessionProductType2;
-})(CheckoutSessionProductType || {});
 var ErrorLayer = /* @__PURE__ */ ((ErrorLayer2) => {
   ErrorLayer2["Gateway"] = "gateway";
   ErrorLayer2["User"] = "user";
@@ -1334,7 +1352,6 @@ var WebhookEventType = /* @__PURE__ */ ((WebhookEventType2) => {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BillingPeriod,
-  CheckoutSessionProductType,
   EntityStatus,
   Environment,
   ErrorLayer,