@misiki/gocommerce-connector 0.10.0 → 0.12.0

package/dist/index.cjs

@@ -765,7 +765,12 @@ function toCartLine(l, extra = {}) {
     variantTitle: l.variant_label ?? "",
     qty: l.quantity,
     price: toMajor(l.unit_price),
-    mrp: toMajor(l.unit_price),
+    // The variant's compare-at price, where the shop set one above what the
+    // line costs: what the basket's "you save" is measured from.
+    mrp: l.compare_at_price && l.compare_at_price.amount_minor > l.unit_price.amount_minor ? toMajor(l.compare_at_price) : toMajor(l.unit_price),
+    /** The add-on this line was bought as (D133), or null on an ordinary line. */
+    addOnId: l.add_on_id ? str(l.add_on_id) : null,
+    addOnFor: l.add_on_for ? str(l.add_on_for) : null,
     subtotal: toMajor(l.total),
     total: toMajor(l.total),
     inStock: l.in_stock,
@@ -999,6 +1004,45 @@ function toUser(c) {
   };
 }
 var priceOf = (m) => m ? toMajor(m) : 0;
+function toAddOn(a) {
+  return {
+    id: str(a.id),
+    productId: str(a.item.product_id),
+    variantId: str(a.variant_id),
+    slug: a.item.slug,
+    title: a.item.title,
+    variantTitle: a.item.variant_label ?? "",
+    thumbnail: mediaUrl(a.item.image_url ?? null),
+    price: toMajor(a.offer_price ?? a.price),
+    regularPrice: toMajor(a.price),
+    hasOffer: !!a.offer_price && a.offer_price.amount_minor < a.price.amount_minor,
+    inStock: a.item.in_stock
+  };
+}
+function toCartOffer(o, currency) {
+  const isPercent = o.kind === "percentage";
+  return {
+    code: o.code,
+    title: o.title,
+    isPercent,
+    freeShipping: o.kind === "free_shipping",
+    /** The percentage for a percentage code, the amount for a fixed one. */
+    value: isPercent ? (o.value_bp ?? 0) / 100 : minorToMajor(o.value_minor ?? 0, currency),
+    minAmount: o.min_subtotal_minor ? minorToMajor(o.min_subtotal_minor, currency) : null,
+    applies: o.applies,
+    amount: o.amount ? toMajor(o.amount) : null,
+    remaining: o.remaining ? toMajor(o.remaining) : null,
+    reason: o.reason ?? ""
+  };
+}
+function toFreeShipping(f) {
+  return {
+    qualifies: f.qualifies,
+    threshold: f.threshold ? toMajor(f.threshold) : null,
+    remaining: f.remaining ? toMajor(f.remaining) : null,
+    subtotal: toMajor(f.subtotal)
+  };
+}
 
 // src/services/facts.ts
 var StoreFacts = class extends BaseService {
@@ -1309,6 +1353,36 @@ var ProductService = class extends CatalogService {
     if (!category) return this.list({ page, limit });
     return this.list({ page, limit, categories: category.slug });
   }
+  /**
+   * What the shop offers with a product, ticked in its buy box (D133): each
+   * add-on at the price ticking it adds. Only add-ons that can be bought
+   * arrive; an engine without the route offers none.
+   */
+  async listAddOns({ product }) {
+    const p = await this.findProduct(String(product));
+    try {
+      return (await this.data("/api/add-ons", { query: { product_id: p.id } }) ?? []).map(toAddOn);
+    } catch (err) {
+      if (err instanceof GoCommerceError && err.status === 404) return [];
+      throw err;
+    }
+  }
+  /**
+   * "You may also like": the products the shop chose for this one, at their
+   * own prices (D133). Curated only, and empty when none were chosen: the
+   * related products already fill in from the category, and the page should
+   * not draw the same fill twice.
+   */
+  async listCrossSells({ product, limit }) {
+    const p = await this.findProduct(String(product));
+    try {
+      const rows = await this.data("/api/cross-sells", { query: { product_id: p.id, limit } }) ?? [];
+      return rows.map((r) => toProduct(r));
+    } catch (err) {
+      if (err instanceof GoCommerceError && err.status === 404) return [];
+      throw err;
+    }
+  }
   async relatedTo(slug, limit) {
     const size = Math.min(100, Math.max(1, Number(limit) || PAGE_SIZE));
     const p = await this.findProduct(slug);
@@ -1648,6 +1722,88 @@ var CartService = class extends BaseService {
       throw err;
     }
   }
+  /**
+   * Adds an add-on from a product's "Complete the set" (D133) at its offer
+   * price. The product it is offered with has to be in the bag already, so
+   * this is called after adding it; the engine refuses one too many with the
+   * sentence the shopper is shown.
+   */
+  async addAddOn({ cartId, addOnId, qty = 1 }) {
+    const id2 = clean(cartId) ?? storedCartId();
+    if (!id2) throw new GoCommerceError("Add the product to your bag first.", 409);
+    return this.present(
+      await this.data(`/api/carts/${encodeURIComponent(id2)}/line-items`, {
+        method: "POST",
+        body: { add_on_id: Number(addOnId), quantity: Number(qty) }
+      })
+    );
+  }
+  /**
+   * The codes the shop chose to show (D133), each with what it takes off this
+   * bag or how much more the bag needs. None without a bag.
+   */
+  async getOffers({ cartId } = {}) {
+    const id2 = clean(cartId) ?? storedCartId();
+    if (!id2) return [];
+    try {
+      const rows = await this.data(`/api/carts/${encodeURIComponent(id2)}/offers`) ?? [];
+      const currency = await this.currency();
+      return rows.map((o) => toCartOffer(o, o.amount?.currency ?? o.remaining?.currency ?? currency));
+    } catch (err) {
+      if (err instanceof GoCommerceError && err.status === 404) return [];
+      throw err;
+    }
+  }
+  /**
+   * How far the bag is from free delivery (D133), read from the store's own
+   * rates for the country (the store's own when none is given). Null when
+   * the engine cannot say: a bar with a made-up figure is worse than none.
+   */
+  async getFreeShipping({ cartId, country, state } = {}) {
+    const id2 = clean(cartId) ?? storedCartId();
+    if (!id2) return null;
+    const where = country ?? cartExtras(id2).shippingAddress?.country ?? void 0;
+    try {
+      return toFreeShipping(
+        await this.data(`/api/carts/${encodeURIComponent(id2)}/free-shipping`, {
+          query: { country: where || void 0, state: state || void 0 }
+        })
+      );
+    } catch (err) {
+      if (err instanceof GoCommerceError && err.status === 404) return null;
+      throw err;
+    }
+  }
+  /**
+   * "You may be interested in" (D133): what the bag's products suggest, less
+   * what it holds; with nothing curated, the first product's related
+   * products, still less what it holds.
+   */
+  async listCrossSells({ cartId, limit = 12 } = {}) {
+    const id2 = clean(cartId) ?? storedCartId();
+    if (!id2) return [];
+    let curated = [];
+    try {
+      curated = await this.data(`/api/carts/${encodeURIComponent(id2)}/cross-sells`, { query: { limit } }) ?? [];
+    } catch (err) {
+      if (!(err instanceof GoCommerceError) || err.status !== 404) throw err;
+    }
+    if (curated.length) return curated.map((p) => toProduct(p));
+    let cart;
+    try {
+      cart = await this.data(`/api/carts/${encodeURIComponent(id2)}`);
+    } catch {
+      return [];
+    }
+    const held = new Set((cart.line_items ?? []).map((l) => String(l.product_id)));
+    const first = cart.line_items?.[0];
+    if (!first) return [];
+    const related = await new ProductService(this._fetch).listRelatedProducts({
+      product: String(first.product_id),
+      limit: limit + held.size
+    });
+    return related.data.filter((p) => !held.has(String(p.id))).slice(0, limit);
+  }
   /** `qty` is the new total; 0 takes the line out. */
   async updateCart({
     cartId,
@@ -2081,7 +2237,20 @@ var paymentMethodService = new PaymentMethodService();
 // src/services/coupon-service.ts
 var CouponService = class extends BaseService {
   async listCoupons(_args = {}) {
-    return emptyPage();
+    const offers = await new CartService(this._fetch).getOffers().catch(() => []);
+    if (!offers.length) return emptyPage();
+    const data = offers.map((o) => ({
+      id: o.code,
+      code: o.code,
+      title: o.title,
+      isPercent: o.isPercent,
+      amount: o.value,
+      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
+    }));
+    return { data, count: data.length, pageSize: data.length, noOfPage: 1, page: 1 };
   }
 };
 var couponService = new CouponService();
@@ -2679,21 +2848,38 @@ var MenuService = class extends BaseService {
     const m = await this.data(`/x/navigation/menus/${encodeURIComponent(handle)}`);
     return { menuId: m.handle, name: m.title, items: (m.items ?? []).map(toItem) };
   }
-  /** The header and footer menus, or `null` when the module is not there. Cached: a menu is store-level. */
+  /**
+   * The header and footer menus, or `null` when the module is not there. Cached: a menu is
+   * store-level. Each is the menu the shop chose for it in the theme editor's header or footer
+   * (GoCommerce D131), still under the `header` / `footer` id every storefront looks for, so the
+   * choice reaches every place that draws one; the menus named so are the default.
+   */
   async engineMenus() {
     if (!await this.facts.pluginOn("navigation")) return null;
     return remember(`${this.engineBase()}|${this.store ?? ""}|menus`, async () => {
       const out = [];
-      for (const handle of ["header", "footer"]) {
+      for (const part of ["header", "footer"]) {
         try {
-          const m = await this.data(`/x/navigation/menus/${handle}`);
-          out.push({ menuId: handle, name: m.title, items: (m.items ?? []).map(toItem) });
+          const handle = await this.chosenMenu(part);
+          const m = await this.data(`/x/navigation/menus/${encodeURIComponent(handle)}`);
+          out.push({ menuId: part, name: m.title, items: (m.items ?? []).map(toItem) });
         } catch {
         }
       }
       return out;
     }).catch(() => null);
   }
+  /** The handle of the menu the published header or footer names, else the part's own name. */
+  async chosenMenu(part) {
+    if (!await this.facts.pluginOn("layouts")) return part;
+    try {
+      const layout = await this.data(`/x/layouts/${part}`);
+      const menu = layout?.sections?.find((s) => s.type === part)?.settings?.menu;
+      return typeof menu === "string" && menu ? menu : part;
+    } catch {
+      return part;
+    }
+  }
 };
 var menuService = new MenuService();
 
@@ -2808,7 +2994,13 @@ var StoreService = class extends BaseService {
         isProductReviewsAndRatings: {
           ...basePlugins.isProductReviewsAndRatings,
           ...flag(plugins.has("product-reviews"))
-        }
+        },
+        // The footer's sign-up box posts to ext/newsletter, and the theme editor's footer
+        // switch (D131) can only show it while that is on.
+        newsletter: { ...basePlugins.newsletter, ...flag(plugins.has("newsletter")) },
+        // Discount codes are core: every GoCommerce store takes them, so
+        // the code box is shown whatever the static record says.
+        isDiscountCoupons: { ...basePlugins.isDiscountCoupons, active: true }
       },
       ...menus?.length ? { menu: menus } : {},
       ...deliverable(base, ships),
@@ -2923,6 +3115,35 @@ var LayoutService = class extends BaseService {
       return null;
     }
   }
+  /**
+   * The header the shop set in the theme editor (D131), drawn on every
+   * page: the published one, or a preview key's draft. Null — the
+   * storefront's own header — when none is published, the editor is off, the
+   * engine is older, or anything fails: a header is never worth an error page.
+   */
+  async getHeader({ preview } = {}) {
+    return this.chrome("header", preview);
+  }
+  /** The footer the shop set in the theme editor (D131); null for the storefront's own, as getHeader. */
+  async getFooter({ preview } = {}) {
+    return this.chrome("footer", preview);
+  }
+  async chrome(page, preview) {
+    let layout;
+    try {
+      layout = await this.getPageLayout(page, { preview });
+    } catch {
+      return null;
+    }
+    const section = layout?.sections.find((s) => s.type === page);
+    if (!layout || !section) return null;
+    const settings = { ...section.settings };
+    let menu = null;
+    if (typeof settings.menu === "string" && settings.menu) {
+      menu = await new MenuService(this._fetch).getMenu(settings.menu).catch(() => null);
+    }
+    return { revision: layout.revision, preview: layout.preview, settings, menu };
+  }
 };
 function tokens(v) {
   return v && typeof v === "object" && !Array.isArray(v) && Object.keys(v).length ? { ...v } : null;
@@ -3607,12 +3828,15 @@ exports.stateService = stateService;
 exports.staticStore = staticStore;
 exports.storeForHost = storeForHost;
 exports.storeService = storeService;
+exports.toAddOn = toAddOn;
 exports.toCart = toCart;
 exports.toCartLine = toCartLine;
+exports.toCartOffer = toCartOffer;
 exports.toCategory = toCategory;
 exports.toCmsPage = toCmsPage;
 exports.toCollection = toCollection;
 exports.toEngineAddress = toEngineAddress;
+exports.toFreeShipping = toFreeShipping;
 exports.toIdentityAddress = toIdentityAddress;
 exports.toMajor = toMajor;
 exports.toMinor = toMinor;