@misiki/gocommerce-connector 0.28.0 → 0.30.0

package/dist/index.cjs

@@ -134,8 +134,17 @@ function remember(key, load, ttl = TTL_MS) {
   });
   return value;
 }
+var known = /* @__PURE__ */ new Map();
+function keep(key, value) {
+  known.set(key, value);
+  return value;
+}
+function recall(key) {
+  return known.get(key);
+}
 function forgetAll() {
   entries.clear();
+  known.clear();
 }
 
 // src/browser.ts
@@ -1120,7 +1129,22 @@ function toCartOffer(o, currency) {
     applies: o.applies,
     amount: o.amount ? toMajor(o.amount) : null,
     remaining: o.remaining ? toMajor(o.remaining) : null,
-    reason: o.reason ?? ""
+    reason: o.reason ?? "",
+    autoApply: !!o.auto_apply
+  };
+}
+function toCheckoutQuote(q) {
+  const d = q.discount;
+  return {
+    subtotal: toMajor(q.subtotal),
+    shippingCharges: toMajor(q.shipping),
+    shippingMethod: q.shipping_method ?? null,
+    discount: toMajor(d?.amount),
+    coupon: d ? { code: d.code, title: d.title, autoApplied: d.auto_applied, freeShipping: !!d.free_shipping } : null,
+    tax: toMajor(q.tax),
+    taxIncluded: q.tax_inclusive,
+    codCharges: toMajor(q.payment_fee),
+    total: toMajor(q.total)
   };
 }
 function toFreeShipping(f) {
@@ -1593,7 +1617,23 @@ function attributesFrom(p) {
   return Object.keys(out).length ? out : void 0;
 }
 var counts = (values) => Object.fromEntries((values ?? []).map((v) => [v.value, v.count]));
-function toStorefrontFacets(f) {
+function categoryFacets(counted, tree) {
+  const byId = new Map(tree.map((c) => [c.id, c]));
+  const totals = /* @__PURE__ */ new Map();
+  for (const { id: id2, count } of counted) {
+    for (let c = byId.get(id2); c; c = c.parent_id === null ? void 0 : byId.get(c.parent_id)) {
+      totals.set(c.id, (totals.get(c.id) ?? 0) + count);
+    }
+  }
+  const kept = tree.filter((c) => totals.has(c.id)).sort((a, b) => a.position - b.position || a.id - b.id);
+  const parentOf = (c) => c.parent_id !== null && byId.has(c.parent_id) ? c.parent_id : null;
+  const under = (parent) => kept.filter((c) => parentOf(c) === parent).flatMap((c) => [{ name: c.title, slug: c.slug, count: totals.get(c.id), depth: c.depth }, ...under(c.id)]);
+  return [
+    ...under(null),
+    ...counted.filter((c) => !byId.has(c.id)).map((c) => ({ name: c.title, slug: c.slug, count: c.count, depth: 0 }))
+  ];
+}
+function toStorefrontFacets(f, tree = []) {
   if (!f) return { priceStat: {}, categories: [], tags: [], allFilters: {} };
   const allFilters = {};
   const group = (key, values) => {
@@ -1604,7 +1644,7 @@ function toStorefrontFacets(f) {
   for (const [handle, values] of Object.entries(f.attributes ?? {})) group(`attributes.${handle}`, values);
   return {
     priceStat: f.price ? { min: toMajor(f.price.min), max: toMajor(f.price.max) } : {},
-    categories: (f.categories ?? []).map((c) => ({ name: c.title, slug: c.slug, count: c.count })),
+    categories: categoryFacets(f.categories ?? [], tree),
     tags: (f.tags ?? []).map((t) => ({ name: t.value, count: t.count })),
     allFilters
   };
@@ -1637,13 +1677,14 @@ var SearchService = class extends CatalogService {
         productTypes: listParam(p, "product_type"),
         facets: true
       });
+      const tree = res.facets?.categories?.length ? await this.facts.categories().catch(() => []) : [];
       return {
         data: res.data,
         count: res.count,
         totalPages: res.noOfPage,
         page: res.page,
         categoryHierarchy: res.categoryHierarchy,
-        facets: toStorefrontFacets(res.facets)
+        facets: toStorefrontFacets(res.facets, tree)
       };
     } catch (err) {
       if (err?.status === 404) return this.emptyResult();
@@ -2111,6 +2152,7 @@ var customizerService = new CustomizerService();
 
 // src/services/checkout-service.ts
 var CheckoutService = class extends BaseService {
+  expected = /* @__PURE__ */ new Map();
   /** Delivery options for the address on the cart: `{ data: [{ id, name, base_rate }] }`. */
   async getShippingRates({ cartId } = {}) {
     const id2 = cartId || storedCartId();
@@ -2282,6 +2324,64 @@ var CheckoutService = class extends BaseService {
     );
     return { methods: options.methods ?? [], currency: options.currency };
   }
+  /**
+   * What checkout would charge for the cart now, by the storefront's method
+   * code (`COD`, `RAZORPAY`, `PAYPAL`) or none yet (D185). Null until the
+   * address step has stored an address, and null from an engine before D185.
+   *
+   * A refusal is checkout's own: the same GoCommerceError, with the same
+   * message, that placing the order would raise now.
+   */
+  async getQuote({ cartId, method = "" } = {}) {
+    const id2 = cartId || storedCartId();
+    if (!id2 || !cartExtras(id2).shippingAddress) return null;
+    const { extras, email, address } = await this.storedCheckout(id2);
+    const code = method.toLowerCase() === "paypal" ? await this.redirectGateway() : method.toLowerCase();
+    try {
+      const quote2 = await this.data("/api/checkout/quote", {
+        query: {
+          cart: id2,
+          country: address.country,
+          state: address.state,
+          shipping_rate_id: extras.shippingRateId || void 0,
+          method: code || void 0,
+          email: email || void 0
+        }
+      });
+      return toCheckoutQuote(quote2);
+    } catch (err) {
+      if (err instanceof GoCommerceError && (err.status === 405 || err.status === 404 && err.message.startsWith("no route for "))) {
+        return null;
+      }
+      throw err;
+    }
+  }
+  /**
+   * The total on screen as the shopper confirms, from getQuote, or null when nothing was quoted
+   * (D185). Every order placed for the cart then carries it, and checkout refuses one whose own
+   * total differs instead of charging it: `onChange` gets checkout's figures now and the sentence
+   * the placing call fails with.
+   */
+  expectTotal({
+    cartId,
+    total,
+    onChange
+  }) {
+    const id2 = cartId || storedCartId();
+    if (!id2) return;
+    if (typeof total === "number") this.expected.set(id2, { total, onChange });
+    else this.expected.delete(id2);
+  }
+  async storedCheckout(cartId) {
+    const id2 = cartId || storedCartId();
+    if (!id2) throw new GoCommerceError("Your bag is empty.", 400);
+    const extras = cartExtras(id2);
+    const ship = extras.shippingAddress;
+    if (!ship) throw new GoCommerceError("Add a delivery address first.", 400);
+    const cart = await this.data(`/api/carts/${encodeURIComponent(id2)}`);
+    const email = cart.email || (ship.email ? String(ship.email) : "");
+    return { id: id2, extras, email, address: toEngineAddress(ship), currency: cart.currency };
+  }
   async redirectGateway() {
     const { methods } = await this.listMethods();
     return methods.find((m) => REDIRECT_GATEWAYS.has(m.code))?.code;
@@ -2297,15 +2397,8 @@ var CheckoutService = class extends BaseService {
    * the engine refuses a key replayed with a different body.
    */
   async place(code, cartId, extra = {}) {
-    const id2 = cartId || storedCartId();
-    if (!id2) throw new GoCommerceError("Your bag is empty.", 400);
-    const extras = cartExtras(id2);
-    const ship = extras.shippingAddress;
-    if (!ship) throw new GoCommerceError("Add a delivery address first.", 400);
-    const cart = await this.data(`/api/carts/${encodeURIComponent(id2)}`);
-    const email = cart.email || (ship.email ? String(ship.email) : "");
+    const { id: id2, extras, email, address, currency } = await this.storedCheckout(cartId);
     if (!email) throw new GoCommerceError("Add an email address so we can send your receipt.", 400);
-    const address = toEngineAddress(ship);
     const body = {
       cart_id: id2,
       email,
@@ -2328,10 +2421,23 @@ var CheckoutService = class extends BaseService {
       ...meta ? { meta_capi: meta } : {},
       ...attribution ? { attribution } : {}
     };
+    const expected = this.expected.get(id2);
     const result = await this.data(`/api/checkout/${encodeURIComponent(code)}`, {
       method: "POST",
-      body: Object.keys(metadata).length ? { ...body, metadata } : body,
+      body: {
+        ...Object.keys(metadata).length ? { ...body, metadata } : body,
+        ...expected ? { quoted_total_minor: toMinor(expected.total, currency) } : {}
+      },
       headers: { "Idempotency-Key": key }
+    }).catch((err) => {
+      if (keyAlreadyUsed(err)) {
+        throw new GoCommerceError("This order was already placed in another tab. Check that tab for its confirmation.", 400, err.code);
+      }
+      const now = movedTotal(err);
+      if (!expected || !now) throw err;
+      const message = `Your total changed to ${shopperAmount(now.total, currency)}. Check the new total and confirm again.`;
+      expected.onChange?.(now, message);
+      throw new GoCommerceError(message, 409, "total_changed", now);
     });
     if (result.order.access_token) {
       rememberOrder({
@@ -2354,6 +2460,21 @@ var CheckoutService = class extends BaseService {
 };
 var REDIRECT_GATEWAYS = /* @__PURE__ */ new Set(["adyen", "paddle", "lemonsqueezy", "creem", "hyperswitch", "revenuecat"]);
 var unsupported = (method, why) => new NotSupportedError("CheckoutService", method, why);
+function keyAlreadyUsed(err) {
+  return err instanceof GoCommerceError && err.status === 400 && err.message.includes("Idempotency-Key was already used");
+}
+function movedTotal(err) {
+  if (!(err instanceof GoCommerceError) || err.code !== "total_changed") return null;
+  const now = err.details;
+  return now?.total ? toCheckoutQuote(now) : null;
+}
+function shopperAmount(amount, currency) {
+  return new Intl.NumberFormat(currency === "INR" ? "en-IN" : "en", {
+    style: "currency",
+    currency,
+    ...Number.isInteger(amount) ? { minimumFractionDigits: 0 } : {}
+  }).format(amount);
+}
 function newKey() {
   const c = globalThis.crypto;
   if (c?.randomUUID) return c.randomUUID();
@@ -2415,7 +2536,8 @@ var CouponService = class extends BaseService {
       minAmount: o.minAmount,
       description: o.applies ? o.title : o.remaining !== null ? `${o.title}. Add ${o.remaining} more to use this.` : o.reason || o.title,
       applies: o.applies,
-      remaining: o.remaining
+      remaining: o.remaining,
+      autoApply: o.autoApply
     }));
     return { data, count: data.length, pageSize: data.length, noOfPage: 1, page: 1 };
   }
@@ -3168,15 +3290,18 @@ var StoreService = class extends BaseService {
   async getStoreByIdOrDomain(_args = {}) {
     const base = await readStaticStore();
     const store = this.store;
-    if (store) {
-      await this.facts.plugins().catch((err) => {
-        if (isStoreMissing(err)) {
+    const [plugins, live] = await Promise.all([
+      this.facts.plugins().catch((err) => {
+        if (store && isStoreMissing(err)) {
           throw new GoCommerceError(`store not found: no store "${store}" on this engine`, 404, "store_not_found");
         }
-      });
-    }
-    const live = await this.live().catch(() => ({}));
-    return { ...base, ...live, id: base.id || "gocommerce" };
+        return void 0;
+      }),
+      this.live().catch(() => ({}))
+    ]);
+    const known2 = `${this.creds.apiUrl ?? ""}|${store ?? ""}|closed`;
+    const closed = plugins ? keep(known2, closedOf(plugins)) : recall(known2);
+    return { ...base, ...live, closed, id: base.id || "gocommerce" };
   }
   async getStore(storeId) {
     return this.getStoreByIdOrDomain({ storeId });
@@ -3211,6 +3336,46 @@ var StoreService = class extends BaseService {
     }
     return super.post(path, data);
   }
+  /**
+   * A closed store's password (D170), traded for a pass. Never throws. The
+   * engine allows 20 tries an hour per client, and sees this server as the
+   * client unless `clientAddress`, the shopper's, travels as `X-Forwarded-For`.
+   */
+  async unlockStore(password, { clientAddress } = {}) {
+    const typed = password.trim();
+    if (!typed) return { outcome: "wrong" };
+    try {
+      return { outcome: "unlocked", pass: await this.storePass({ password: typed }, clientAddress) };
+    } catch (err) {
+      return { outcome: err instanceof GoCommerceError && UNLOCK_REFUSED[err.status] || "unavailable" };
+    }
+  }
+  /**
+   * A pass checked without spending a try: the pass, or null when it is wrong,
+   * expired, ended by a new password, or the store takes none now. Throws when
+   * the engine cannot say.
+   */
+  async checkStorePass(token) {
+    if (!token) return null;
+    try {
+      return await this.storePass({ token });
+    } catch (err) {
+      if (err instanceof GoCommerceError && (err.status === 422 || err.status === 404)) return null;
+      throw err;
+    }
+  }
+  async storePass(body, clientAddress) {
+    const answer = await this.data("/api/store/password", {
+      method: "POST",
+      body,
+      headers: clientAddress && ONE_IP_ADDRESS.test(clientAddress) ? { "X-Forwarded-For": clientAddress } : void 0
+    });
+    const expiresAt = new Date(answer?.expires_at ?? NaN);
+    if (!answer?.token || Number.isNaN(expiresAt.getTime())) {
+      throw new GoCommerceError("The commerce engine answered a store pass without its token or expiry.", 502);
+    }
+    return { token: answer.token, expiresAt };
+  }
   async live() {
     const [ready, plugins, menus, base, profile, ships] = await Promise.all([
       this.facts.ready(),
@@ -3328,6 +3493,17 @@ var StoreService = class extends BaseService {
   }
 };
 var storeService = new StoreService();
+var ONE_IP_ADDRESS = /^[\da-f.:]{2,45}$/i;
+var UNLOCK_REFUSED = {
+  422: "wrong",
+  429: "throttled",
+  404: "open"
+};
+function closedOf(plugins) {
+  const plugin = plugins?.get("store-close");
+  if (!plugin) return void 0;
+  return { message: String(plugin.settings?.message ?? ""), password: plugin.settings?.password === true };
+}
 var AD_TAGS = [
   ["meta-pixel", "pixel_id", "facebookPixel"],
   ["microsoft-clarity", "project_id", "microsoftClarity"],
@@ -3356,10 +3532,10 @@ function googleTags(plugins) {
 }
 function deliverable(base, ships) {
   if (ships.everywhere || !ships.countries.length) return {};
-  const known = new Map((base.countries ?? []).map((c) => [String(c.code).toUpperCase(), c]));
-  const countries = ships.countries.map((code) => known.get(code) ?? { code, name: regionName(code) });
-  const keep = base.country && ships.countries.includes(String(base.country.code).toUpperCase());
-  return { countries, ...keep ? {} : { country: countries[0] } };
+  const known2 = new Map((base.countries ?? []).map((c) => [String(c.code).toUpperCase(), c]));
+  const countries = ships.countries.map((code) => known2.get(code) ?? { code, name: regionName(code) });
+  const keep2 = base.country && ships.countries.includes(String(base.country.code).toUpperCase());
+  return { countries, ...keep2 ? {} : { country: countries[0] } };
 }
 function regionName(code) {
   try {
@@ -3514,7 +3690,8 @@ function toSection(s) {
       title: c.title,
       slug: c.slug,
       link: `/collections/${c.slug}`,
-      image: mediaUrl(c.image) ?? null
+      image: mediaUrl(c.image) ?? null,
+      description: c.description || null
     }));
   }
   return out;
@@ -4233,6 +4410,7 @@ exports.toCart = toCart;
 exports.toCartLine = toCartLine;
 exports.toCartOffer = toCartOffer;
 exports.toCategory = toCategory;
+exports.toCheckoutQuote = toCheckoutQuote;
 exports.toCmsPage = toCmsPage;
 exports.toCollection = toCollection;
 exports.toEngineAddress = toEngineAddress;