@misiki/gocommerce-connector 0.24.0 → 0.26.0

package/README.md

@@ -130,9 +130,9 @@ down stays best-effort: the storefront renders from its static record.
 | collections | `/api/collections`, `/api/collections/{slug}` |
 | featured / trending shelves | the collection with slug `featured` / `trending`; newest products when there is none |
 | product page extras | on the product from `/api/products/slug/{slug}` (D134): `highlights` and `freeGift` from the product's own metadata, `soldAtLeast` when the shop shows sold counts (null otherwise, never zero), and the product's videos after its pictures in `images` (and alone in `videos`), so the gallery plays them |
-| bag | `/api/carts…`, `/api/carts/{token}/discount` |
+| bag | `/api/carts…`, `/api/carts/{token}/discount`. When the engine answers an add with `cart_not_found` or `cart_checked_out`, the line goes to a fresh cart. An older engine without those codes is read by its words |
 | Complete the set (add-ons) | `/api/add-ons?product_id=` — `productService.listAddOns({ product })`, each at the price ticking it adds (`price`) beside its own (`regularPrice`); `cartService.addAddOn({ addOnId })` after the product is in the bag. The engine keeps the offer price only while the product is in the bag, one for each |
-| product customizer (D162) | `/x/customizer/products/{id}` — `customizerService.setup(productId)`: the product's design editor (mockup, overlay, print area and print size, tools, fonts, stickers, smallest sharp photo, consent line), with every picture through the proxy path so a canvas that draws it can still be exported. Null while ext/customizer is off (read from `/api/plugins`, so no request is made per product), for a product that cannot be designed, and on any failure. `/x/customizer/uploads` — `customizerService.upload(file)`: a photo, preview or print file, sent as the multipart field `file`; a refusal (413, 415, 422, 429, 501) is thrown with the engine's message. `/x/customizer/designs` — `customizerService.saveDesign({ productId, variantId, previewUploadId, printUploadId, document })`, with the version 1 document sent as the engine keeps it on the order. `cartService.addToCart({ variantId, designId })` puts the design in the bag on a line of its own; cart and order lines carry `designId` and `designPreview`, both null on a line sold as it is |
+| product customizer (D162) | `/x/customizer/products/{id}` — `customizerService.setup(productId)`: the product's design editor (mockup, overlay, print area and print size, tools, fonts, stickers, smallest sharp photo, consent line), with every picture through the proxy path so a canvas that draws it can still be exported. Null while ext/customizer is off (read from `/api/plugins`, so no request is made per product), for a product that cannot be designed, and on any failure. `/x/customizer/uploads` — `customizerService.upload(file)`: a photo, preview or print file, sent as the multipart field `file`; a refusal (413, 415, 422, 429, 501) is thrown with the engine's message. `/x/customizer/designs` — `customizerService.saveDesign({ productId, variantId, previewUploadId, printUploadId, document })`, with the version 1 document sent as the engine keeps it on the order. `cartService.addToCart({ variantId, designId })` puts the design in the bag on a line of its own; cart and order lines carry `designId` and `designPreview`, both null on a line sold as it is, and an `orderService.buyAgain()` line carries its `designId` and its product's `designable`. Every product, in a listing and a search hit too, carries `designable`: true when it is sold only made to a design (open the editor, offer no quick add), false for a plain product (skip `setup`), and undefined when the engine does not say, from an older engine or a search index built before GoCommerce #215 (ask `setup`). For a plain line of a designable product, `cartService.addToCart` throws a `GoCommerceError` with `code` `design_required` and status 409, and a bag that is still open stays as it was |
 | You may also like | `/api/cross-sells?product_id=` — `productService.listCrossSells({ product })`, curated only; the bag's `/api/carts/{token}/cross-sells` — `cartService.listCrossSells()`, which includes the collection the shop chose for every basket (D134), falling back to the first item's related products |
 | the bag's offers and free delivery | `/api/carts/{token}/offers` — `cartService.getOffers()` and the coupon drawer's `couponService.listCoupons()`: only the codes the shop chose to show; `/api/carts/{token}/free-shipping` — `cartService.getFreeShipping()`, from the store's own rates, null when it cannot say |
 | delivery options | `/api/checkout/rates` |
@@ -158,7 +158,7 @@ down stays best-effort: the storefront renders from its static record.
 | WhatsApp order updates at checkout | `/x/notify-whatsapp/consent` — `whatsappService.consentOffer()`: `{ enabled, marketing }`, whether to show the order-updates box and the offers-and-reminders box; both false when ext/notify-whatsapp is not in the engine or does not answer, so checkout never waits on it. `whatsappService.setConsent({ cartId, phone, orderUpdates, marketing })` (PUT) records both answers for the phone, an unticked box as `false`; with `marketing` the engine keeps the phone on the bag for basket reminders. It throws the engine's 400 (`validation_failed`) when the phone is not a WhatsApp number for the store's country |
 | contact form, product enquiries | `/x/contact/messages`, with the form's hidden `website` honeypot passed on so the engine drops what a bot filled in |
 | search words, type-ahead (plugin on) | `/x/meilisearch/search`, falling back to the engine's own search when it is off or down |
-| store record | the storefront's own config, with the engine's currency, menus and module switches over it; the store's own logo, dark logo and icon (`logo_url`, `logo_dark_url`, `icon_url` from `/api/store`, D148) replace `logo`, `logoDark` and `favicon` when it has them; for the contact page (D156), the address once the store shows it (as `address: { street, city, state, pincode, country }`), `mapLocation` and `openingHours` when set, `businessCountry` (the store's ISO country, for the phone's country code), the `whatsapp-chat` plugin's number as `plugins.whatsappChatButton`, and Google Customer Reviews (ext/google-reviews) as `plugins.googleReviewsOptIn` (`active` while the survey is on) and `plugins.googleStoreWidget` (`{ active, position: 'RIGHT_BOTTOM' \| 'LEFT_BOTTOM' }`, off without the survey) |
+| store record | the storefront's own config, with the engine's currency, menus and module switches over it; the store's own logo, dark logo and icon (`logo_url`, `logo_dark_url`, `icon_url` from `/api/store`, D148) replace `logo`, `logoDark` and `favicon` when it has them; for the contact page (D156), the address once the store shows it (as `address: { street, city, state, pincode, country }`), `mapLocation` and `openingHours` when set, `businessCountry` (the store's ISO country, for the phone's country code), the `whatsapp-chat` plugin's number as `plugins.whatsappChatButton`, and Google Customer Reviews (ext/google-reviews) as `plugins.googleReviewsOptIn` (`active` while the survey is on), `plugins.googleStoreWidget` (`{ active, position: 'RIGHT_BOTTOM' \| 'LEFT_BOTTOM' }`, off without the survey), and the `criteo` plugin's account as `plugins.criteo: { active, accountId }` (the engine decides, never the static record) |
 | resized product pictures | `/images/{store}/cdn-cgi/image/width=…/…` — the store record's `plugins.imageCdn` is turned on with provider `cloudflare` and the engine's `images_path` (from `/api/store`, D139) after `PUBLIC_GOCOMMERCE_API_URL`, so the storefront's srcset asks the engine for each width; an engine without it leaves the static record's setting |
 
 Blogs, banners, reels, chat, warranties, deals and uploads have no engine

package/dist/{index-BWg1KptA.d.cts → index-BWwh1d1q.d.cts}

@@ -205,6 +205,8 @@ type Product = {
     media?: VariantImage[];
     /** The sold count rounded down; absent unless the shop shows counts and it passed the threshold (D134). */
     sold_at_least?: number;
+    /** Sold only made to a shopper's design (D174); absent from an engine that predates the flag. */
+    designable?: boolean;
     options: ProductOption[] | null;
     variants: Variant[] | null;
     collections: {
@@ -730,6 +732,8 @@ type SearchDoc = {
     price_max_minor: number;
     in_stock: boolean;
     skus: string[] | null;
+    /** As on the product (D174), as of its last change or reindex; absent from an index built before the flag. */
+    designable?: boolean;
     updated_at: number;
 };
 type SearchResult = {
@@ -899,6 +903,7 @@ declare function toProduct(p: Product, extra?: {
     highlights: string[];
     freeGift: string | null;
     soldAtLeast: number | null;
+    designable: boolean | undefined;
     manageInventory: boolean;
     allowBackorder: boolean;
     stock: number;
@@ -1001,6 +1006,7 @@ declare function fromSearchDoc(d: SearchDoc): {
     hasStock: boolean;
     manageInventory: boolean;
     allowBackorder: boolean;
+    designable: boolean | undefined;
     productTags: string;
     category: {
         name: string;
@@ -1724,6 +1730,7 @@ declare class ProductService extends CatalogService {
         highlights: string[];
         freeGift: string | null;
         soldAtLeast: number | null;
+        designable: boolean | undefined;
         manageInventory: boolean;
         allowBackorder: boolean;
         stock: number;
@@ -1841,6 +1848,7 @@ declare class ProductService extends CatalogService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -1941,6 +1949,7 @@ declare class ProductService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -1993,6 +2002,7 @@ declare class ProductService extends CatalogService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -2093,6 +2103,7 @@ declare class ProductService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2144,6 +2155,7 @@ declare class ProductService extends CatalogService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -2244,6 +2256,7 @@ declare class ProductService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2342,6 +2355,7 @@ declare class ProductService extends CatalogService {
         highlights: string[];
         freeGift: string | null;
         soldAtLeast: number | null;
+        designable: boolean | undefined;
         manageInventory: boolean;
         allowBackorder: boolean;
         stock: number;
@@ -2566,6 +2580,7 @@ declare class SearchService extends CatalogService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -2666,6 +2681,7 @@ declare class SearchService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2755,6 +2771,7 @@ declare class MeilisearchService extends CatalogService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -2855,6 +2872,7 @@ declare class MeilisearchService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2913,6 +2931,7 @@ declare class MeilisearchService extends CatalogService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -3013,6 +3032,7 @@ declare class MeilisearchService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -3137,6 +3157,7 @@ declare class CollectionService extends BaseService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -3249,6 +3270,7 @@ declare class CollectionService extends BaseService {
                 highlights: string[];
                 freeGift: string | null;
                 soldAtLeast: number | null;
+                designable: boolean | undefined;
                 manageInventory: boolean;
                 allowBackorder: boolean;
                 stock: number;
@@ -5233,10 +5255,12 @@ declare class OrderService extends BaseService {
         productId: string;
         variantId: string;
         slug: string;
+        designable: boolean | undefined;
         title: string;
         img: string | null;
         price: number;
         qty: number;
+        designId: string | null;
     }[]>;
     /** The "someone just bought" popup would publish other shoppers' purchases; the engine offers none. */
     listPublic(_args?: Record<string, unknown>): Promise<{
@@ -6210,6 +6234,7 @@ declare class WishlistService extends BaseService {
                 highlights: string[];
                 freeGift: string | null;
                 soldAtLeast: number | null;
+                designable: boolean | undefined;
                 manageInventory: boolean;
                 allowBackorder: boolean;
                 stock: number;
@@ -6995,6 +7020,7 @@ declare class AutocompleteService extends MeilisearchService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -7095,6 +7121,7 @@ declare class AutocompleteService extends MeilisearchService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;

package/dist/{index-BWg1KptA.d.ts → index-BWwh1d1q.d.ts}

@@ -205,6 +205,8 @@ type Product = {
     media?: VariantImage[];
     /** The sold count rounded down; absent unless the shop shows counts and it passed the threshold (D134). */
     sold_at_least?: number;
+    /** Sold only made to a shopper's design (D174); absent from an engine that predates the flag. */
+    designable?: boolean;
     options: ProductOption[] | null;
     variants: Variant[] | null;
     collections: {
@@ -730,6 +732,8 @@ type SearchDoc = {
     price_max_minor: number;
     in_stock: boolean;
     skus: string[] | null;
+    /** As on the product (D174), as of its last change or reindex; absent from an index built before the flag. */
+    designable?: boolean;
     updated_at: number;
 };
 type SearchResult = {
@@ -899,6 +903,7 @@ declare function toProduct(p: Product, extra?: {
     highlights: string[];
     freeGift: string | null;
     soldAtLeast: number | null;
+    designable: boolean | undefined;
     manageInventory: boolean;
     allowBackorder: boolean;
     stock: number;
@@ -1001,6 +1006,7 @@ declare function fromSearchDoc(d: SearchDoc): {
     hasStock: boolean;
     manageInventory: boolean;
     allowBackorder: boolean;
+    designable: boolean | undefined;
     productTags: string;
     category: {
         name: string;
@@ -1724,6 +1730,7 @@ declare class ProductService extends CatalogService {
         highlights: string[];
         freeGift: string | null;
         soldAtLeast: number | null;
+        designable: boolean | undefined;
         manageInventory: boolean;
         allowBackorder: boolean;
         stock: number;
@@ -1841,6 +1848,7 @@ declare class ProductService extends CatalogService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -1941,6 +1949,7 @@ declare class ProductService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -1993,6 +2002,7 @@ declare class ProductService extends CatalogService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -2093,6 +2103,7 @@ declare class ProductService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2144,6 +2155,7 @@ declare class ProductService extends CatalogService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -2244,6 +2256,7 @@ declare class ProductService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2342,6 +2355,7 @@ declare class ProductService extends CatalogService {
         highlights: string[];
         freeGift: string | null;
         soldAtLeast: number | null;
+        designable: boolean | undefined;
         manageInventory: boolean;
         allowBackorder: boolean;
         stock: number;
@@ -2566,6 +2580,7 @@ declare class SearchService extends CatalogService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -2666,6 +2681,7 @@ declare class SearchService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2755,6 +2771,7 @@ declare class MeilisearchService extends CatalogService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -2855,6 +2872,7 @@ declare class MeilisearchService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2913,6 +2931,7 @@ declare class MeilisearchService extends CatalogService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -3013,6 +3032,7 @@ declare class MeilisearchService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -3137,6 +3157,7 @@ declare class CollectionService extends BaseService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -3249,6 +3270,7 @@ declare class CollectionService extends BaseService {
                 highlights: string[];
                 freeGift: string | null;
                 soldAtLeast: number | null;
+                designable: boolean | undefined;
                 manageInventory: boolean;
                 allowBackorder: boolean;
                 stock: number;
@@ -5233,10 +5255,12 @@ declare class OrderService extends BaseService {
         productId: string;
         variantId: string;
         slug: string;
+        designable: boolean | undefined;
         title: string;
         img: string | null;
         price: number;
         qty: number;
+        designId: string | null;
     }[]>;
     /** The "someone just bought" popup would publish other shoppers' purchases; the engine offers none. */
     listPublic(_args?: Record<string, unknown>): Promise<{
@@ -6210,6 +6234,7 @@ declare class WishlistService extends BaseService {
                 highlights: string[];
                 freeGift: string | null;
                 soldAtLeast: number | null;
+                designable: boolean | undefined;
                 manageInventory: boolean;
                 allowBackorder: boolean;
                 stock: number;
@@ -6995,6 +7020,7 @@ declare class AutocompleteService extends MeilisearchService {
             highlights: string[];
             freeGift: string | null;
             soldAtLeast: number | null;
+            designable: boolean | undefined;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -7095,6 +7121,7 @@ declare class AutocompleteService extends MeilisearchService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;

package/dist/index.cjs

@@ -648,6 +648,7 @@ function toProduct(p, extra = {}) {
     freeGift: freeGiftOf(p),
     // Counted by the engine, rounded down, and absent rather than zero.
     soldAtLeast: typeof p.sold_at_least === "number" && p.sold_at_least > 0 ? p.sold_at_least : null,
+    designable: typeof p.designable === "boolean" ? p.designable : void 0,
     // Product-level stock is what a card shows before a variant is picked:
     // buyable when any live variant is, counted only where counting means
     // something.
@@ -708,6 +709,7 @@ function fromSearchDoc(d) {
     // built from it must not claim to count.
     manageInventory: false,
     allowBackorder: false,
+    designable: typeof d.designable === "boolean" ? d.designable : void 0,
     productTags: arr(d.tags).join(","),
     category: d.category ? { name: d.category.split(" / ").pop() ?? d.category, slug: "" } : null,
     vendor: d.vendor ? { businessName: d.vendor } : null,
@@ -1810,7 +1812,7 @@ var CartService = class extends BaseService {
         await this.data(`/api/carts/${encodeURIComponent(id2)}/line-items`, { method: "POST", body })
       );
     } catch (err) {
-      if (err instanceof GoCommerceError && /cart not found|checked out/.test(err.message)) {
+      if (cartGone(err)) {
         const fresh = await this.open();
         return this.present(
           await this.data(`/api/carts/${encodeURIComponent(fresh)}/line-items`, { method: "POST", body })
@@ -2048,6 +2050,8 @@ var CartService = class extends BaseService {
   }
 };
 var clean = (id2) => id2 && id2 !== "undefined" && id2 !== "null" ? id2 : null;
+var cartGone = (err) => err instanceof GoCommerceError && (err.code === "cart_not_found" || err.code === "cart_checked_out" || cartGoneOnOlderEngine(err));
+var cartGoneOnOlderEngine = (err) => err.code === "not_found" && err.message === "cart not found" || err.code === "conflict" && err.message === "this cart has already been checked out";
 var cartService = new CartService();
 
 // src/services/customizer-service.ts
@@ -2469,7 +2473,8 @@ var OrderService = class extends BaseService {
           title: l.title,
           img: mediaUrl(l.image_url),
           price: toMajor(l.unit_price),
-          qty: l.quantity
+          qty: l.quantity,
+          designId: l.metadata?.design?.id ?? null
         });
       }
     }
@@ -2479,7 +2484,8 @@ var OrderService = class extends BaseService {
     return lines.flatMap((l, i) => {
       const p = live[i];
       if (!p) return [];
-      return [{ ...l, productId: String(l.productId), variantId: String(l.variantId), slug: p.slug }];
+      const designable = typeof p.designable === "boolean" ? p.designable : void 0;
+      return [{ ...l, productId: String(l.productId), variantId: String(l.variantId), slug: p.slug, designable }];
     });
   }
   /** The "someone just bought" popup would publish other shoppers' purchases; the engine offers none. */
@@ -3260,6 +3266,14 @@ var StoreService = class extends BaseService {
             message: String(plugins.get("whatsapp-chat")?.settings?.message ?? "")
           } : {}
         },
+        // Criteo's OneTag, for this store's own account. The engine decides: on a shared
+        // deployment the static record is every store's, and one store's account must
+        // never load on another's pages.
+        criteo: {
+          ...basePlugins.criteo,
+          ...flag(plugins.has("criteo")),
+          ...plugins.has("criteo") ? { accountId: String(plugins.get("criteo")?.settings?.account_id ?? "") } : {}
+        },
         isProductReviewsAndRatings: {
           ...basePlugins.isProductReviewsAndRatings,
           ...flag(plugins.has("product-reviews"))