@misiki/gocommerce-connector 0.25.0 → 0.27.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` |

package/dist/{index-BWg1KptA.d.cts → index-BY0qUnNO.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: {
@@ -384,6 +386,8 @@ type Order = {
     shipping: Money;
     shipping_method?: string;
     discount: Money;
+    /** What the payment method added (D165): cash on delivery's extra charge. Absent on an engine before it. */
+    payment_fee?: Money;
     tax: Money;
     tax_inclusive: boolean;
     total: Money;
@@ -411,9 +415,11 @@ type CheckoutResult = {
 };
 type CheckoutOptions = {
     payment_methods: string[];
+    /** `fee` is what choosing the method adds to the order (D165); absent, it adds nothing. */
     methods: {
         code: string;
         name: string;
+        fee?: Money;
     }[];
     currency: string;
 };
@@ -556,6 +562,8 @@ type StoreProfile = {
     phone: string;
     support_url: string;
     language: string;
+    /** Whether the store's prices include tax (D177); absent on an engine before it. */
+    prices_include_tax?: boolean;
     /** Where the engine serves this store's pictures resized (D139); absent on an engine before it. */
     images_path?: string;
     /** The store's logo, logo for dark backgrounds and square icon (D148); empty or absent when it has none. */
@@ -730,6 +738,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 +909,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 +1012,7 @@ declare function fromSearchDoc(d: SearchDoc): {
     hasStock: boolean;
     manageInventory: boolean;
     allowBackorder: boolean;
+    designable: boolean | undefined;
     productTags: string;
     category: {
         name: string;
@@ -1724,6 +1736,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 +1854,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 +1955,7 @@ declare class ProductService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -1993,6 +2008,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 +2109,7 @@ declare class ProductService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2144,6 +2161,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 +2262,7 @@ declare class ProductService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2342,6 +2361,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 +2586,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 +2687,7 @@ declare class SearchService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2755,6 +2777,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 +2878,7 @@ declare class MeilisearchService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2913,6 +2937,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 +3038,7 @@ declare class MeilisearchService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -3137,6 +3163,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 +3276,7 @@ declare class CollectionService extends BaseService {
                 highlights: string[];
                 freeGift: string | null;
                 soldAtLeast: number | null;
+                designable: boolean | undefined;
                 manageInventory: boolean;
                 allowBackorder: boolean;
                 stock: number;
@@ -4852,6 +4880,7 @@ declare class PaymentMethodService extends BaseService {
             title: string;
             description: string;
             img: string | null;
+            fee: number;
             rank: number;
             active: boolean;
             isActive: boolean;
@@ -5233,10 +5262,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 +6241,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 +7027,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 +7128,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-BY0qUnNO.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: {
@@ -384,6 +386,8 @@ type Order = {
     shipping: Money;
     shipping_method?: string;
     discount: Money;
+    /** What the payment method added (D165): cash on delivery's extra charge. Absent on an engine before it. */
+    payment_fee?: Money;
     tax: Money;
     tax_inclusive: boolean;
     total: Money;
@@ -411,9 +415,11 @@ type CheckoutResult = {
 };
 type CheckoutOptions = {
     payment_methods: string[];
+    /** `fee` is what choosing the method adds to the order (D165); absent, it adds nothing. */
     methods: {
         code: string;
         name: string;
+        fee?: Money;
     }[];
     currency: string;
 };
@@ -556,6 +562,8 @@ type StoreProfile = {
     phone: string;
     support_url: string;
     language: string;
+    /** Whether the store's prices include tax (D177); absent on an engine before it. */
+    prices_include_tax?: boolean;
     /** Where the engine serves this store's pictures resized (D139); absent on an engine before it. */
     images_path?: string;
     /** The store's logo, logo for dark backgrounds and square icon (D148); empty or absent when it has none. */
@@ -730,6 +738,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 +909,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 +1012,7 @@ declare function fromSearchDoc(d: SearchDoc): {
     hasStock: boolean;
     manageInventory: boolean;
     allowBackorder: boolean;
+    designable: boolean | undefined;
     productTags: string;
     category: {
         name: string;
@@ -1724,6 +1736,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 +1854,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 +1955,7 @@ declare class ProductService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -1993,6 +2008,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 +2109,7 @@ declare class ProductService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2144,6 +2161,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 +2262,7 @@ declare class ProductService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2342,6 +2361,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 +2586,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 +2687,7 @@ declare class SearchService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2755,6 +2777,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 +2878,7 @@ declare class MeilisearchService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -2913,6 +2937,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 +3038,7 @@ declare class MeilisearchService extends CatalogService {
             hasStock: boolean;
             manageInventory: boolean;
             allowBackorder: boolean;
+            designable: boolean | undefined;
             productTags: string;
             category: {
                 name: string;
@@ -3137,6 +3163,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 +3276,7 @@ declare class CollectionService extends BaseService {
                 highlights: string[];
                 freeGift: string | null;
                 soldAtLeast: number | null;
+                designable: boolean | undefined;
                 manageInventory: boolean;
                 allowBackorder: boolean;
                 stock: number;
@@ -4852,6 +4880,7 @@ declare class PaymentMethodService extends BaseService {
             title: string;
             description: string;
             img: string | null;
+            fee: number;
             rank: number;
             active: boolean;
             isActive: boolean;
@@ -5233,10 +5262,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 +6241,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 +7027,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 +7128,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,
@@ -991,7 +993,7 @@ function toOrder(o) {
     taxIncluded: o.tax_inclusive,
     total: toMajor(o.total),
     refunded: toMajor(o.refunded),
-    codCharges: 0,
+    codCharges: toMajor(o.payment_fee),
     coupon: code ? { code } : null,
     userEmail: o.email,
     email: o.email,
@@ -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
@@ -2380,6 +2384,7 @@ var PaymentMethodService = class extends BaseService {
       title: m.name,
       description: "",
       img: drive(m.code).img ?? null,
+      fee: toMajor(m.fee),
       rank: i,
       active: true,
       isActive: true
@@ -2469,7 +2474,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 +2485,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. */
@@ -3242,7 +3249,8 @@ var StoreService = class extends BaseService {
       currency: {
         ...base.currency ?? {},
         code,
-        symbol: sameCurrency ? base.currency?.symbol ?? symbolFor(code) : symbolFor(code)
+        symbol: sameCurrency ? base.currency?.symbol ?? symbolFor(code) : symbolFor(code),
+        includesTax: profile?.prices_include_tax
       },
       language: ready.language,
       plugins: {