@misiki/gocommerce-connector 0.12.0 → 0.14.0

package/README.md

@@ -45,7 +45,8 @@ gocommerce -identity -wishlist -reviews -cms -faq -menus serve
 
 Each is optional. Without `-identity` there is no sign-in (guest checkout
 always works); without `-reviews` products show no stars; and so on. Add
-`-meilisearch` (with `MEILI_HOST` and keys) for price sorting and price filters,
+`-meilisearch` (with `MEILI_HOST` and keys) for typo-tolerant search once a store
+switches the Meilisearch plugin on,
 `-newsletter` and `-contact` for the signup box and contact form, and `-b2b` for
 business buyers (see "Beyond the storefront's screens").
 
@@ -127,16 +128,18 @@ down stays best-effort: the storefront renders from its static record.
 | category pages and tree | `/api/categories`, `/api/categories/{slug}` — a category sells its descendants |
 | 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` |
 | 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 |
-| You may also like | `/api/cross-sells?product_id=` — `productService.listCrossSells({ product })`, curated only; the bag's `/api/carts/{token}/cross-sells` — `cartService.listCrossSells()`, falling back to the first item's related products |
+| 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` |
 | payment methods | `/api/checkout` — cash on delivery, Razorpay, and the first hosted-page gateway (see below) |
 | place order | `POST /api/checkout/{code}` with an `Idempotency-Key` |
 | order lookup | `/api/orders/{number}?token=` (guest), `/x/identity/me/orders` (account) |
 | sign-in, sign-up, profile, password reset | `/x/identity/*` |
-| address book | `/x/identity/me/addresses` |
+| address book | `/x/identity/me/addresses`, with its `label` (Home, Work, Other) |
+| PIN code autofill | `/api/postcodes/IN/{pin}` — `addressService.lookupPostcode({ country, postcode })`: city and state, or null when the engine has no directory or the PIN is unknown (D134) |
 | wishlist | `/x/wishlist` |
 | reviews | `/x/reviews` |
 | content pages (`/p/…`, legal pages) | `/x/cms/pages` |
@@ -150,7 +153,7 @@ down stays best-effort: the storefront renders from its static record.
 | attribute filters (`?attributes.color=Red`) | `/api/products?attr=color:Red` |
 | newsletter box | `/x/newsletter/subscribe` |
 | contact form, product enquiries | `/x/contact/messages` |
-| price sort and filter, type-ahead | `/x/meilisearch/search`, falling back to the engine's own search |
+| 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 |
 
 Blogs, banners, reels, chat, warranties, deals and uploads have no engine

package/dist/{index-Bu4bVBBm.d.cts → index-C0CR05Q4.d.cts}

@@ -201,6 +201,10 @@ type Product = {
     seo_description: string;
     image_url?: string;
     media_count?: number;
+    /** The gallery, pictures and videos in order: on the public product only (D134). */
+    media?: VariantImage[];
+    /** The sold count rounded down; absent unless the shop shows counts and it passed the threshold (D134). */
+    sold_at_least?: number;
     options: ProductOption[] | null;
     variants: Variant[] | null;
     collections: {
@@ -574,6 +578,8 @@ type SearchResult = {
     total: number;
     limit: number;
     offset: number;
+    /** Meilisearch did not answer: search the product listing instead. */
+    unavailable?: boolean;
 };
 /** One approved vendor's offer on a variant, from `GET /api/variants/{id}/offers`. Cheapest first. */
 type Offer = {
@@ -589,6 +595,14 @@ type MenuSummary = {
     handle: string;
     title: string;
 };
+/** GET /api/postcodes/{country}/{code} (D134). */
+type Postcode = {
+    country: string;
+    postcode: string;
+    city: string;
+    state: string;
+    state_code: string;
+};
 
 /**
  * The state this connector keeps in the shopper's browser, and only there.
@@ -650,11 +664,16 @@ type CartExtras = {
 };
 
 /**
- * Every picture the public API offers for a product: the lead image, then each
- * variant's. The engine keeps the full gallery on admin routes only, so this
- * is the honest union rather than the whole media library.
+ * Every picture the public API offers for a product: the lead image, the
+ * product's gallery (on the single product, D134), then each variant's.
  */
 declare function productImages(p: Product): string[];
+/**
+ * The product's videos, an upload or a YouTube link, in the gallery's order
+ * (D134). They follow the pictures in `images`, where the storefront's gallery
+ * plays them; a card's thumbnail is never one.
+ */
+declare function productVideos(p: Product): string[];
 declare function toVariant(v: Variant, p: Product, optionless: boolean): {
     id: string;
     productId: string;
@@ -711,6 +730,10 @@ declare function toProduct(p: Product, extra?: {
     image_url: string;
     images: string;
     imageList: string[];
+    videos: string[];
+    highlights: string[];
+    freeGift: string | null;
+    soldAtLeast: number | null;
     manageInventory: boolean;
     allowBackorder: boolean;
     stock: number;
@@ -1468,6 +1491,19 @@ type CatalogPage = {
 declare class CatalogService extends BaseService {
     protected readonly facts: StoreFacts;
     protected queryCatalog(q: CatalogQuery): Promise<CatalogPage>;
+    /**
+     * The shelf from the Meilisearch module, or null when the store has it off,
+     * sells through a channel, finds nothing for the words, or it cannot answer (Meilisearch down: the engine says `unavailable`), so
+     * the caller asks the database instead of showing the shopper an error.
+     */
+    protected fromIndex(q: CatalogQuery, o: {
+        page: number;
+        limit: number;
+        search?: string;
+        sortKey?: string;
+        wantsRange: boolean;
+        hierarchy: CatalogPage['categoryHierarchy'];
+    }): Promise<CatalogPage | null>;
 }
 
 /**
@@ -1511,6 +1547,10 @@ declare class ProductService extends CatalogService {
         image_url: string;
         images: string;
         imageList: string[];
+        videos: string[];
+        highlights: string[];
+        freeGift: string | null;
+        soldAtLeast: number | null;
         manageInventory: boolean;
         allowBackorder: boolean;
         stock: number;
@@ -1624,6 +1664,10 @@ declare class ProductService extends CatalogService {
             image_url: string;
             images: string;
             imageList: string[];
+            videos: string[];
+            highlights: string[];
+            freeGift: string | null;
+            soldAtLeast: number | null;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -1772,6 +1816,10 @@ declare class ProductService extends CatalogService {
             image_url: string;
             images: string;
             imageList: string[];
+            videos: string[];
+            highlights: string[];
+            freeGift: string | null;
+            soldAtLeast: number | null;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -1919,6 +1967,10 @@ declare class ProductService extends CatalogService {
             image_url: string;
             images: string;
             imageList: string[];
+            videos: string[];
+            highlights: string[];
+            freeGift: string | null;
+            soldAtLeast: number | null;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -2113,6 +2165,10 @@ declare class ProductService extends CatalogService {
         image_url: string;
         images: string;
         imageList: string[];
+        videos: string[];
+        highlights: string[];
+        freeGift: string | null;
+        soldAtLeast: number | null;
         manageInventory: boolean;
         allowBackorder: boolean;
         stock: number;
@@ -2333,6 +2389,10 @@ declare class SearchService extends CatalogService {
             image_url: string;
             images: string;
             imageList: string[];
+            videos: string[];
+            highlights: string[];
+            freeGift: string | null;
+            soldAtLeast: number | null;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -2518,6 +2578,10 @@ declare class MeilisearchService extends CatalogService {
             image_url: string;
             images: string;
             imageList: string[];
+            videos: string[];
+            highlights: string[];
+            freeGift: string | null;
+            soldAtLeast: number | null;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -2648,39 +2712,6 @@ declare class MeilisearchService extends CatalogService {
         search?: string;
         limit?: number;
     }): Promise<{
-        data: {
-            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;
-        }[];
-    } | {
         data: {
             id: string;
             slug: string;
@@ -2705,6 +2736,10 @@ declare class MeilisearchService extends CatalogService {
             image_url: string;
             images: string;
             imageList: string[];
+            videos: string[];
+            highlights: string[];
+            freeGift: string | null;
+            soldAtLeast: number | null;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -2787,6 +2822,37 @@ declare class MeilisearchService extends CatalogService {
             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;
         }[];
     }>;
 }
@@ -2894,6 +2960,10 @@ declare class CollectionService extends BaseService {
             image_url: string;
             images: string;
             imageList: string[];
+            videos: string[];
+            highlights: string[];
+            freeGift: string | null;
+            soldAtLeast: number | null;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -3002,6 +3072,10 @@ declare class CollectionService extends BaseService {
                 image_url: string;
                 images: string;
                 imageList: string[];
+                videos: string[];
+                highlights: string[];
+                freeGift: string | null;
+                soldAtLeast: number | null;
                 manageInventory: boolean;
                 allowBackorder: boolean;
                 stock: number;
@@ -5779,6 +5853,22 @@ declare class AddressService extends BaseService {
         createdAt: string;
         updatedAt: string;
     }>;
+    /**
+     * The city and state for a postcode (D134), for the address form to fill
+     * in. India's six-digit PIN codes only, from the directory the engine was
+     * given; null for anything it cannot answer, so the form simply leaves the
+     * fields to the shopper.
+     */
+    lookupPostcode({ country, postcode }: {
+        country?: string;
+        postcode: string;
+    }): Promise<{
+        country: string;
+        postcode: string;
+        city: string;
+        state: string;
+        stateCode: string;
+    } | null>;
     deleteAddress(id: string): Promise<{
         id: string;
         deleted: boolean;
@@ -5824,6 +5914,10 @@ declare class WishlistService extends BaseService {
                 image_url: string;
                 images: string;
                 imageList: string[];
+                videos: string[];
+                highlights: string[];
+                freeGift: string | null;
+                soldAtLeast: number | null;
                 manageInventory: boolean;
                 allowBackorder: boolean;
                 stock: number;
@@ -6525,39 +6619,6 @@ declare class AutocompleteService extends MeilisearchService {
         q?: string;
         search?: string;
     }): Promise<{
-        data: {
-            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;
-        }[];
-    } | {
         data: {
             id: string;
             slug: string;
@@ -6582,6 +6643,10 @@ declare class AutocompleteService extends MeilisearchService {
             image_url: string;
             images: string;
             imageList: string[];
+            videos: string[];
+            highlights: string[];
+            freeGift: string | null;
+            soldAtLeast: number | null;
             manageInventory: boolean;
             allowBackorder: boolean;
             stock: number;
@@ -6664,6 +6729,37 @@ declare class AutocompleteService extends MeilisearchService {
             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;
         }[];
     }>;
 }
@@ -7482,4 +7578,4 @@ declare class B2bService extends BaseService {
 }
 declare const b2bService: B2bService;
 
-export { HomeService as $, type AddOn as A, type B2bPlaced as B, type Cart as C, type CompanyOrder as D, ContactService as E, CountryService as F, CouponService as G, type Credentials as H, type Credit as I, CurrencyService as J, type Customer as K, DealService as L, DemoRequestService as M, type EngineRequest as N, EnquiryService as O, type Envelope as P, type FacetValue as Q, type Faq as R, FaqService as S, FeedbackService as T, type FooterSettings as U, type FreeShipping as V, type Fulfillment as W, GalleryService as X, type HeaderSettings as Y, type HomeLayout as Z, type HomeLayoutSection as _, type Address as a, VariantService as a$, type IdentityAddress as a0, InitService as a1, type Invitation as a2, type LayoutCollection as a3, type LayoutPage as a4, LayoutService as a5, type Lead as a6, type ListMeta as a7, MeilisearchService as a8, type Member as a9, RegionService as aA, type RejectedLine as aB, type Review as aC, type ReviewPage as aD, ReviewService as aE, type SearchDoc as aF, type SearchResult as aG, SearchService as aH, SettingService as aI, type ShippingRate as aJ, type SiteChrome as aK, type SiteFooter as aL, type SiteHeader as aM, type SocialLink as aN, StateService as aO, type StoreProfile as aP, StoreService as aQ, type StorefrontCategory as aR, type StorefrontMenu as aS, type StorefrontOrder as aT, type StorefrontProduct as aU, type ThemeSettings as aV, type ThemeSettingsResult as aW, UploadService as aX, UserService as aY, type Variant as aZ, type VariantImage as a_, type Menu as aa, type MenuItem as ab, MenuService as ac, type MenuSummary as ad, type Money as ae, NewsletterService as af, type Offer as ag, type Order as ah, type OrderLine as ai, OrderService as aj, type PageLayout as ak, PageService as al, type PaymentIntent as am, PaymentMethodService as an, type Plugin as ao, PluginService as ap, PopularSearchService as aq, PopularityService as ar, type Product as as, type ProductFacets as at, type ProductOption as au, ProductService as av, ProfileService as aw, type Quote as ax, REDIRECT_GATEWAYS as ay, ReelsService as az, AddressService as b, stateService as b$, VarniCustomDesignService as b0, VarniCustomProductService as b1, type Vendor as b2, VendorService as b3, WarrantyService as b4, type Wishlist as b5, type WishlistItem as b6, WishlistService as b7, addressService as b8, authService as b9, initService as bA, layoutService as bB, mediaUrl as bC, meilisearchService as bD, menuService as bE, minorToMajor as bF, newsletterService as bG, orderService as bH, ownDomain as bI, pageService as bJ, paymentMethodService as bK, pluginService as bL, pluginsService as bM, popularSearchService as bN, popularityService as bO, priceOf as bP, productImages as bQ, productService as bR, profileService as bS, qs as bT, reelsService as bU, regionService as bV, reviewService as bW, searchService as bX, setRequestHost as bY, settingService as bZ, settingsService as b_, autocompleteService as ba, b2bService as bb, bannerService as bc, blogService as bd, cartService as be, categoryService as bf, chatService as bg, checkoutService as bh, collectionService as bi, contactService as bj, countryService as bk, couponService as bl, currencyExponent as bm, currencyService as bn, dealService as bo, demoRequestService as bp, emptyCart as bq, emptyPage as br, enquiryService as bs, faqService as bt, feedbackService as bu, fromEngineAddress as bv, fromIdentityAddress as bw, fromSearchDoc as bx, galleryService as by, homeService as bz, type AppliedDiscount as c, staticStore as c0, storeForHost as c1, storeService as c2, toAddOn as c3, toCart as c4, toCartLine as c5, toCartOffer as c6, toCategory as c7, toCmsPage as c8, toCollection as c9, toEngineAddress as ca, toFreeShipping as cb, toIdentityAddress as cc, toMajor as cd, toMinor as ce, toOrder as cf, toPage as cg, toProduct as ch, toRating as ci, toStorefrontFacets as cj, toUser as ck, toVariant as cl, toVendor as cm, uploadService as cn, userService as co, variantService as cp, varniCustomDesignService as cq, varniCustomProductService as cr, vendorService as cs, warrantyService as ct, wishlistService as cu, type Approval as d, type AuthResponse as e, AuthService as f, AutocompleteService as g, type B2bRole as h, B2bService as i, BannerService as j, BaseService as k, BlogService as l, type CartLine as m, type CartOffer as n, CartService as o, CatalogService as p, type Category as q, CategoryService as r, ChatService as s, type CheckoutOptions as t, type CheckoutResult as u, CheckoutService as v, type CmsPage as w, type Collection as x, CollectionService as y, type Company as z };
+export { HomeService as $, type AddOn as A, type B2bPlaced as B, type Cart as C, type CompanyOrder as D, ContactService as E, CountryService as F, CouponService as G, type Credentials as H, type Credit as I, CurrencyService as J, type Customer as K, DealService as L, DemoRequestService as M, type EngineRequest as N, EnquiryService as O, type Envelope as P, type FacetValue as Q, type Faq as R, FaqService as S, FeedbackService as T, type FooterSettings as U, type FreeShipping as V, type Fulfillment as W, GalleryService as X, type HeaderSettings as Y, type HomeLayout as Z, type HomeLayoutSection as _, type Address as a, type VariantImage as a$, type IdentityAddress as a0, InitService as a1, type Invitation as a2, type LayoutCollection as a3, type LayoutPage as a4, LayoutService as a5, type Lead as a6, type ListMeta as a7, MeilisearchService as a8, type Member as a9, ReelsService as aA, RegionService as aB, type RejectedLine as aC, type Review as aD, type ReviewPage as aE, ReviewService as aF, type SearchDoc as aG, type SearchResult as aH, SearchService as aI, SettingService as aJ, type ShippingRate as aK, type SiteChrome as aL, type SiteFooter as aM, type SiteHeader as aN, type SocialLink as aO, StateService as aP, type StoreProfile as aQ, StoreService as aR, type StorefrontCategory as aS, type StorefrontMenu as aT, type StorefrontOrder as aU, type StorefrontProduct as aV, type ThemeSettings as aW, type ThemeSettingsResult as aX, UploadService as aY, UserService as aZ, type Variant as a_, type Menu as aa, type MenuItem as ab, MenuService as ac, type MenuSummary as ad, type Money as ae, NewsletterService as af, type Offer as ag, type Order as ah, type OrderLine as ai, OrderService as aj, type PageLayout as ak, PageService as al, type PaymentIntent as am, PaymentMethodService as an, type Plugin as ao, PluginService as ap, PopularSearchService as aq, PopularityService as ar, type Postcode as as, type Product as at, type ProductFacets as au, type ProductOption as av, ProductService as aw, ProfileService as ax, type Quote as ay, REDIRECT_GATEWAYS as az, AddressService as b, settingService as b$, VariantService as b0, VarniCustomDesignService as b1, VarniCustomProductService as b2, type Vendor as b3, VendorService as b4, WarrantyService as b5, type Wishlist as b6, type WishlistItem as b7, WishlistService as b8, addressService as b9, homeService as bA, initService as bB, layoutService as bC, mediaUrl as bD, meilisearchService as bE, menuService as bF, minorToMajor as bG, newsletterService as bH, orderService as bI, ownDomain as bJ, pageService as bK, paymentMethodService as bL, pluginService as bM, pluginsService as bN, popularSearchService as bO, popularityService as bP, priceOf as bQ, productImages as bR, productService as bS, productVideos as bT, profileService as bU, qs as bV, reelsService as bW, regionService as bX, reviewService as bY, searchService as bZ, setRequestHost as b_, authService as ba, autocompleteService as bb, b2bService as bc, bannerService as bd, blogService as be, cartService as bf, categoryService as bg, chatService as bh, checkoutService as bi, collectionService as bj, contactService as bk, countryService as bl, couponService as bm, currencyExponent as bn, currencyService as bo, dealService as bp, demoRequestService as bq, emptyCart as br, emptyPage as bs, enquiryService as bt, faqService as bu, feedbackService as bv, fromEngineAddress as bw, fromIdentityAddress as bx, fromSearchDoc as by, galleryService as bz, type AppliedDiscount as c, settingsService as c0, stateService as c1, staticStore as c2, storeForHost as c3, storeService as c4, toAddOn as c5, toCart as c6, toCartLine as c7, toCartOffer as c8, toCategory as c9, toCmsPage as ca, toCollection as cb, toEngineAddress as cc, toFreeShipping as cd, toIdentityAddress as ce, toMajor as cf, toMinor as cg, toOrder as ch, toPage as ci, toProduct as cj, toRating as ck, toStorefrontFacets as cl, toUser as cm, toVariant as cn, toVendor as co, uploadService as cp, userService as cq, variantService as cr, varniCustomDesignService as cs, varniCustomProductService as ct, vendorService as cu, warrantyService as cv, wishlistService as cw, type Approval as d, type AuthResponse as e, AuthService as f, AutocompleteService as g, type B2bRole as h, B2bService as i, BannerService as j, BaseService as k, BlogService as l, type CartLine as m, type CartOffer as n, CartService as o, CatalogService as p, type Category as q, CategoryService as r, ChatService as s, type CheckoutOptions as t, type CheckoutResult as u, CheckoutService as v, type CmsPage as w, type Collection as x, CollectionService as y, type Company as z };