@misiki/gocommerce-connector 0.9.0 → 0.10.0

package/README.md

@@ -225,13 +225,13 @@ Each of these is a real gap, listed so nobody has to find it in production.
   `checkoutService.checkout(code)` for a storefront that drives its own payment
   UI. Payment is confirmed by the gateway's webhook to the engine; the order
   shows `paymentStatus` once it lands.
-- **Attribute filters inside a category.** The engine filters by attribute on
-  the whole-shop listing only; on a category page they are not applied.
+- **Filters on an older engine.** Listing filters and their counts (tags,
+  vendor, product type, category attributes, price) need an engine that counts
+  them (`GET /api/products?facets=1`, D130). Against an older one the filter
+  rail is empty and a category page's attribute filters are not applied.
 - **Tax in the bag.** The engine's cart carries no tax or total; tax is computed
   when the order is placed. The bag shows subtotal − discount + delivery, and the
   order shows the real figures.
-- **Facets.** The engine's search returns hits and a total, not distributions, so
-  category and tag facets and the price slider are not shown.
 - **Phone sign-in by code, account deletion, guest order lookup by email and
   code** are not engine features and throw.
 

package/dist/{index-72kQMxjZ.d.cts → index-mqcHZ96i.d.cts}

@@ -109,6 +109,29 @@ type ListMeta = {
     offset: number;
     page: number;
     total_pages: number;
+    /** Only on `GET /api/products?facets=1`, from an engine that counts them (D130). */
+    facets?: ProductFacets;
+};
+type FacetValue = {
+    value: string;
+    count: number;
+};
+/** core/catalog_facets.go: counted over the whole listing, each group without its own selection. */
+type ProductFacets = {
+    price: {
+        min: Money;
+        max: Money;
+    } | null;
+    tags: FacetValue[] | null;
+    vendors: FacetValue[] | null;
+    product_types: FacetValue[] | null;
+    categories: {
+        id: number;
+        slug: string;
+        title: string;
+        count: number;
+    }[] | null;
+    attributes: Record<string, FacetValue[]> | null;
 };
 type Envelope<T> = {
     data: T;
@@ -1327,6 +1350,16 @@ type CatalogQuery = {
      * are not applied.
      */
     attributes?: Record<string, string[]>;
+    tags?: string[];
+    vendors?: string[];
+    productTypes?: string[];
+    /**
+     * Ask the engine to count the filter values too. Such a query goes to
+     * `GET /api/products`, which then also answers the category, the price
+     * range, the sort and every filter above (D130); an engine too old to count
+     * them is asked the way it always was, and the page has no facets.
+     */
+    facets?: boolean;
 };
 type CatalogPage = {
     data: ReturnType<typeof toProduct>[] | ReturnType<typeof fromSearchDoc>[];
@@ -1340,17 +1373,8 @@ type CatalogPage = {
     }[];
     /** Whether the answer honoured `sort` and the price range, or had to drop them. */
     sorted: boolean;
+    facets?: ProductFacets;
 };
-/**
- * One shelf of products, from whichever engine route can answer the question.
- *
- * - A category, no reordering: `GET /api/categories/{slug}`, which sells the
- *   category and its descendants.
- * - A search or the whole shop, no reordering: `GET /api/products?q=`.
- * - Any sort but newest, or a price range: the Meilisearch module, when it is
- *   installed and configured. Without it the shelf comes back in the engine's
- *   order with `sorted: false`, rather than failing or pretending.
- */
 declare class CatalogService extends BaseService {
     protected readonly facts: StoreFacts;
     protected queryCatalog(q: CatalogQuery): Promise<CatalogPage>;
@@ -1924,155 +1948,29 @@ declare class ProductService extends CatalogService {
         noOfPage: number;
         page: number;
     }>;
-    /** More from this product's category. */
-    listRelatedProducts({ page, categoryId, limit, }?: {
+    /**
+     * More like this product. Given `product` (a slug or id), it is the
+     * product's category first, then its collections, then the newest — never
+     * the product itself. Many shops never fill in categories, and an empty
+     * rail under every product page reads as a broken shop.
+     *
+     * Without `product`, it is the old answer: more from `categoryId`.
+     */
+    listRelatedProducts({ page, categoryId, product, limit, }?: {
         page?: number;
         categoryId?: string;
+        product?: string;
         limit?: number;
     }): Promise<{
         data: {
             id: string;
-            slug: string;
-            title: string;
-            name: string;
-            subtitle: null;
-            description: string;
-            status: string;
-            active: boolean;
-            type: string;
-            currency: string;
-            currencyCode: string;
-            price: number;
-            mrp: number;
-            minPrice: number;
-            maxPrice: number;
-            sku: string;
-            barcode: string | null;
-            weight: number | null;
-            originCountry: string | null;
-            thumbnail: string;
-            image_url: string;
-            images: string;
-            imageList: string[];
-            manageInventory: boolean;
-            allowBackorder: boolean;
-            stock: number;
-            hasStock: boolean;
-            categoryId: string | null;
-            category: {
-                id: string;
-                name: string;
-                slug: string;
-            } | null;
-            categories: {
-                category: {
-                    id: string;
-                    name: string;
-                    slug: string;
-                };
-            }[];
-            categoryHierarchy: {
-                name: string;
-                slug: string;
-            }[];
-            collections: {
-                id: string;
-                name: string;
-                slug: string;
-            }[];
-            vendor: {
-                businessName: string;
-            } | null;
-            productTags: string;
-            keywords: string;
-            metaTitle: string;
-            metaDescription: string | null;
-            link: string;
-            options: {
-                id: string;
-                title: string;
-                name: string;
-                type: string;
-                values: {
-                    id: string;
-                    value: string;
-                }[];
-            }[];
-            variants: {
-                id: string;
-                productId: string;
-                title: string;
-                sku: string;
-                barcode: string | null;
-                price: number;
-                mrp: number;
-                stock: number;
-                manageInventory: boolean;
-                allowBackorder: boolean;
-                active: boolean;
-                weight: number | null;
-                length: number | null;
-                width: number | null;
-                height: number | null;
-                images: string;
-                img: string;
-                image: string;
-                thumbnail: string;
-                options: {
-                    optionId: string;
-                    value: string;
-                }[];
-                metadata: Record<string, unknown> | null;
-            }[];
-            ratings: ReturnType<typeof toRating>[];
-            rating: number | null;
-            ratingCount: number;
-            reviewCount: number;
-            attributes: {
-                name: string;
-                value: string;
-                handle: string;
-            }[];
-            metadata: Record<string, unknown> | null;
-            createdAt: string;
-            updatedAt: string;
-        }[] | {
-            id: string;
-            slug: string;
-            title: string;
-            name: string;
-            description: string;
-            currency: string;
-            price: number;
-            mrp: number;
-            minPrice: number;
-            maxPrice: number;
-            thumbnail: string | null;
-            image_url: string | null;
-            images: string;
-            stock: number;
-            hasStock: boolean;
-            manageInventory: boolean;
-            allowBackorder: boolean;
-            productTags: string;
-            category: {
-                name: string;
-                slug: string;
-            } | null;
-            vendor: {
-                businessName: string;
-            } | null;
-            variants: ReturnType<typeof toVariant>[];
-            options: never[];
-            ratings: never[];
-            link: string;
-            updatedAt: string;
         }[];
         count: number;
         pageSize: number;
         noOfPage: number;
         page: number;
     }>;
+    private relatedTo;
     private shelf;
     /**
      * A review, through ext/reviews. The engine asks for a name and an email
@@ -2094,14 +1992,39 @@ declare class ProductService extends CatalogService {
 }
 declare const productService: ProductService;
 
+/**
+ * The engine's counts in the shape the storefront's filter rail reads. Each
+ * `allFilters` key is also the URL parameter the rail writes when a value is
+ * ticked, and `searchWithUrl` reads it back: `vendor`, `product_type` and
+ * `attributes.<handle>`. Tags go to the rail's own tag group, written as `tags`.
+ */
+declare function toStorefrontFacets(f?: ProductFacets | null): {
+    priceStat: {
+        min: number;
+        max: number;
+    } | {
+        min?: undefined;
+        max?: undefined;
+    };
+    categories: {
+        name: string;
+        slug: string;
+        count: number;
+    }[];
+    tags: {
+        name: string;
+        count: number;
+    }[];
+    allFilters: Record<string, Record<string, number>>;
+};
 /**
  * The listing pages' search: `/products?search=&sort=&page=` and the category
  * catch-all `/{slug}`.
  *
- * Facets are empty. The engine's search route returns hits and a total, not
- * distributions, and a facet list made from one page of hits would count that
- * page, not the shop. An empty `priceStat` hides the price slider rather than
- * drawing one with a made-up range.
+ * Facets come from the engine, counted over the whole listing rather than the
+ * page (D130). An engine too old to count them leaves them empty, and an empty
+ * `priceStat` hides the price slider rather than drawing one with a made-up
+ * range.
  */
 declare class SearchService extends CatalogService {
     emptyResult(): {
@@ -2113,10 +2036,23 @@ declare class SearchService extends CatalogService {
             slug: string;
         }[];
         facets: {
-            priceStat: {};
-            categories: never[];
-            tags: never[];
-            allFilters: {};
+            priceStat: {
+                min: number;
+                max: number;
+            } | {
+                min?: undefined;
+                max?: undefined;
+            };
+            categories: {
+                name: string;
+                slug: string;
+                count: number;
+            }[];
+            tags: {
+                name: string;
+                count: number;
+            }[];
+            allFilters: Record<string, Record<string, number>>;
         };
     };
     searchWithUrl(url: URL | string, slug?: string): Promise<{
@@ -2128,10 +2064,23 @@ declare class SearchService extends CatalogService {
             slug: string;
         }[];
         facets: {
-            priceStat: {};
-            categories: never[];
-            tags: never[];
-            allFilters: {};
+            priceStat: {
+                min: number;
+                max: number;
+            } | {
+                min?: undefined;
+                max?: undefined;
+            };
+            categories: {
+                name: string;
+                slug: string;
+                count: number;
+            }[];
+            tags: {
+                name: string;
+                count: number;
+            }[];
+            allFilters: Record<string, Record<string, number>>;
         };
     } | {
         data: {
@@ -2280,10 +2229,23 @@ declare class SearchService extends CatalogService {
             slug: string;
         }[];
         facets: {
-            priceStat: {};
-            categories: never[];
-            tags: never[];
-            allFilters: {};
+            priceStat: {
+                min: number;
+                max: number;
+            } | {
+                min?: undefined;
+                max?: undefined;
+            };
+            categories: {
+                name: string;
+                slug: string;
+                count: number;
+            }[];
+            tags: {
+                name: string;
+                count: number;
+            }[];
+            allFilters: Record<string, Record<string, number>>;
         };
     }>;
 }
@@ -7067,4 +7029,4 @@ declare class B2bService extends BaseService {
 }
 declare const b2bService: B2bService;
 
-export { LayoutService as $, type Address as A, type B2bPlaced as B, type Cart as C, CountryService as D, CouponService as E, type Credentials as F, type Credit as G, CurrencyService as H, type Customer as I, DealService as J, DemoRequestService as K, type EngineRequest as L, EnquiryService as M, type Envelope as N, type Faq as O, FaqService as P, FeedbackService as Q, type Fulfillment as R, GalleryService as S, type HomeLayout as T, type HomeLayoutSection as U, HomeService as V, type IdentityAddress as W, InitService as X, type Invitation as Y, type LayoutCollection as Z, type LayoutPage as _, AddressService as a, autocompleteService as a$, type Lead as a0, type ListMeta as a1, MeilisearchService as a2, type Member as a3, type Menu as a4, type MenuItem as a5, MenuService as a6, type MenuSummary as a7, type Money as a8, NewsletterService as a9, SearchService as aA, SettingService as aB, type ShippingRate as aC, StateService as aD, type StoreProfile as aE, StoreService as aF, type StorefrontCategory as aG, type StorefrontMenu as aH, type StorefrontOrder as aI, type StorefrontProduct as aJ, type ThemeSettings as aK, type ThemeSettingsResult as aL, UploadService as aM, UserService as aN, type Variant as aO, type VariantImage as aP, VariantService as aQ, VarniCustomDesignService as aR, VarniCustomProductService as aS, type Vendor as aT, VendorService as aU, WarrantyService as aV, type Wishlist as aW, type WishlistItem as aX, WishlistService as aY, addressService as aZ, authService as a_, type Offer as aa, type Order as ab, type OrderLine as ac, OrderService as ad, type PageLayout as ae, PageService as af, type PaymentIntent as ag, PaymentMethodService as ah, type Plugin as ai, PluginService as aj, PopularSearchService as ak, PopularityService as al, type Product as am, type ProductOption as an, ProductService as ao, ProfileService as ap, type Quote as aq, REDIRECT_GATEWAYS as ar, ReelsService as as, RegionService as at, type RejectedLine as au, type Review as av, type ReviewPage as aw, ReviewService as ax, type SearchDoc as ay, type SearchResult as az, type AppliedDiscount as b, toMajor as b$, b2bService as b0, bannerService as b1, blogService as b2, cartService as b3, categoryService as b4, chatService as b5, checkoutService as b6, collectionService as b7, contactService as b8, countryService as b9, pluginService as bA, pluginsService as bB, popularSearchService as bC, popularityService as bD, priceOf as bE, productImages as bF, productService as bG, profileService as bH, qs as bI, reelsService as bJ, regionService as bK, reviewService as bL, searchService as bM, setRequestHost as bN, settingService as bO, settingsService as bP, stateService as bQ, staticStore as bR, storeForHost as bS, storeService as bT, toCart as bU, toCartLine as bV, toCategory as bW, toCmsPage as bX, toCollection as bY, toEngineAddress as bZ, toIdentityAddress as b_, couponService as ba, currencyExponent as bb, currencyService as bc, dealService as bd, demoRequestService as be, emptyCart as bf, emptyPage as bg, enquiryService as bh, faqService as bi, feedbackService as bj, fromEngineAddress as bk, fromIdentityAddress as bl, fromSearchDoc as bm, galleryService as bn, homeService as bo, initService as bp, layoutService as bq, mediaUrl as br, meilisearchService as bs, menuService as bt, minorToMajor as bu, newsletterService as bv, orderService as bw, ownDomain as bx, pageService as by, paymentMethodService as bz, type Approval as c, toMinor as c0, toOrder as c1, toPage as c2, toProduct as c3, toRating as c4, toUser as c5, toVariant as c6, toVendor as c7, uploadService as c8, userService as c9, variantService as ca, varniCustomDesignService as cb, varniCustomProductService as cc, vendorService as cd, warrantyService as ce, wishlistService as cf, type AuthResponse as d, AuthService as e, AutocompleteService as f, type B2bRole as g, B2bService as h, BannerService as i, BaseService as j, BlogService as k, type CartLine as l, CartService as m, CatalogService as n, type Category as o, CategoryService as p, ChatService as q, type CheckoutOptions as r, type CheckoutResult as s, CheckoutService as t, type CmsPage as u, type Collection as v, CollectionService as w, type Company as x, type CompanyOrder as y, ContactService as z };
+export { type LayoutPage as $, type Address as A, type B2bPlaced as B, type Cart as C, CountryService as D, CouponService as E, type Credentials as F, type Credit as G, CurrencyService as H, type Customer as I, DealService as J, DemoRequestService as K, type EngineRequest as L, EnquiryService as M, type Envelope as N, type FacetValue as O, type Faq as P, FaqService as Q, FeedbackService as R, type Fulfillment as S, GalleryService as T, type HomeLayout as U, type HomeLayoutSection as V, HomeService as W, type IdentityAddress as X, InitService as Y, type Invitation as Z, type LayoutCollection as _, AddressService as a, addressService as a$, LayoutService as a0, type Lead as a1, type ListMeta as a2, MeilisearchService as a3, type Member as a4, type Menu as a5, type MenuItem as a6, MenuService as a7, type MenuSummary as a8, type Money as a9, type SearchDoc as aA, type SearchResult as aB, SearchService as aC, SettingService as aD, type ShippingRate as aE, StateService as aF, type StoreProfile as aG, StoreService as aH, type StorefrontCategory as aI, type StorefrontMenu as aJ, type StorefrontOrder as aK, type StorefrontProduct as aL, type ThemeSettings as aM, type ThemeSettingsResult as aN, UploadService as aO, UserService as aP, type Variant as aQ, type VariantImage as aR, VariantService as aS, VarniCustomDesignService as aT, VarniCustomProductService as aU, type Vendor as aV, VendorService as aW, WarrantyService as aX, type Wishlist as aY, type WishlistItem as aZ, WishlistService as a_, NewsletterService as aa, type Offer as ab, type Order as ac, type OrderLine as ad, OrderService as ae, type PageLayout as af, PageService as ag, type PaymentIntent as ah, PaymentMethodService as ai, type Plugin as aj, PluginService as ak, PopularSearchService as al, PopularityService as am, type Product as an, type ProductFacets as ao, type ProductOption as ap, ProductService as aq, ProfileService as ar, type Quote as as, REDIRECT_GATEWAYS as at, ReelsService as au, RegionService as av, type RejectedLine as aw, type Review as ax, type ReviewPage as ay, ReviewService as az, type AppliedDiscount as b, toEngineAddress as b$, authService as b0, autocompleteService as b1, b2bService as b2, bannerService as b3, blogService as b4, cartService as b5, categoryService as b6, chatService as b7, checkoutService as b8, collectionService as b9, pageService as bA, paymentMethodService as bB, pluginService as bC, pluginsService as bD, popularSearchService as bE, popularityService as bF, priceOf as bG, productImages as bH, productService as bI, profileService as bJ, qs as bK, reelsService as bL, regionService as bM, reviewService as bN, searchService as bO, setRequestHost as bP, settingService as bQ, settingsService as bR, stateService as bS, staticStore as bT, storeForHost as bU, storeService as bV, toCart as bW, toCartLine as bX, toCategory as bY, toCmsPage as bZ, toCollection as b_, contactService as ba, countryService as bb, couponService as bc, currencyExponent as bd, currencyService as be, dealService as bf, demoRequestService as bg, emptyCart as bh, emptyPage as bi, enquiryService as bj, faqService as bk, feedbackService as bl, fromEngineAddress as bm, fromIdentityAddress as bn, fromSearchDoc as bo, galleryService as bp, homeService as bq, initService as br, layoutService as bs, mediaUrl as bt, meilisearchService as bu, menuService as bv, minorToMajor as bw, newsletterService as bx, orderService as by, ownDomain as bz, type Approval as c, toIdentityAddress as c0, toMajor as c1, toMinor as c2, toOrder as c3, toPage as c4, toProduct as c5, toRating as c6, toStorefrontFacets as c7, toUser as c8, toVariant as c9, toVendor as ca, uploadService as cb, userService as cc, variantService as cd, varniCustomDesignService as ce, varniCustomProductService as cf, vendorService as cg, warrantyService as ch, wishlistService as ci, type AuthResponse as d, AuthService as e, AutocompleteService as f, type B2bRole as g, B2bService as h, BannerService as i, BaseService as j, BlogService as k, type CartLine as l, CartService as m, CatalogService as n, type Category as o, CategoryService as p, ChatService as q, type CheckoutOptions as r, type CheckoutResult as s, CheckoutService as t, type CmsPage as u, type Collection as v, CollectionService as w, type Company as x, type CompanyOrder as y, ContactService as z };