@misiki/gocommerce-connector 0.13.0 → 0.15.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").
 
@@ -152,8 +153,9 @@ 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 |
-| store record | the storefront's own config, with the engine's currency, menus and module switches over it |
+| 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 |
+| 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
 equivalent. Their lists answer empty and anything that would write or open one

package/dist/{index-DHKyh3CU.d.cts → index-GdjWgh5b.d.cts}

@@ -425,6 +425,12 @@ type StoreProfile = {
     phone: string;
     support_url: string;
     language: string;
+    /** 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. */
+    logo_url?: string;
+    logo_dark_url?: string;
+    icon_url?: string;
 };
 type Vendor = {
     id: number;
@@ -578,6 +584,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 = {
@@ -1489,6 +1497,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>;
 }
 
 /**
@@ -2697,39 +2718,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;
@@ -2840,6 +2828,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;
         }[];
     }>;
 }
@@ -6145,12 +6164,12 @@ declare const menuService: MenuService;
 /**
  * The store record every page renders from.
  *
- * Logo, theme and the rest are the storefront's own (its static store,
- * registered through `setStaticStore`); the engine has no opinion on them.
- * Where the engine does have one, it wins:
- * - the store's name and contact, as its owner set them in the panel. One
- *   storefront serves every store under `baseDomain`, so a name in the static
- *   record would be every store's name;
+ * Theme and the rest are the storefront's own (its static store, registered
+ * through `setStaticStore`); the engine has no opinion on them. Where the
+ * engine does have one, it wins:
+ * - the store's name, contact, logo and icon, as its owner set them in the
+ *   panel. One storefront serves every store under `baseDomain`, so a name or
+ *   a logo in the static record would be every store's;
  * - the settlement currency. Every price on the site is formatted with it, and
  *   a store record saying USD over an engine charging INR would print the
  *   wrong symbol on every price;
@@ -6606,39 +6625,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;
@@ -6749,6 +6735,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;
         }[];
     }>;
 }

package/dist/{index-DHKyh3CU.d.ts → index-GdjWgh5b.d.ts}

@@ -425,6 +425,12 @@ type StoreProfile = {
     phone: string;
     support_url: string;
     language: string;
+    /** 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. */
+    logo_url?: string;
+    logo_dark_url?: string;
+    icon_url?: string;
 };
 type Vendor = {
     id: number;
@@ -578,6 +584,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 = {
@@ -1489,6 +1497,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>;
 }
 
 /**
@@ -2697,39 +2718,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;
@@ -2840,6 +2828,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;
         }[];
     }>;
 }
@@ -6145,12 +6164,12 @@ declare const menuService: MenuService;
 /**
  * The store record every page renders from.
  *
- * Logo, theme and the rest are the storefront's own (its static store,
- * registered through `setStaticStore`); the engine has no opinion on them.
- * Where the engine does have one, it wins:
- * - the store's name and contact, as its owner set them in the panel. One
- *   storefront serves every store under `baseDomain`, so a name in the static
- *   record would be every store's name;
+ * Theme and the rest are the storefront's own (its static store, registered
+ * through `setStaticStore`); the engine has no opinion on them. Where the
+ * engine does have one, it wins:
+ * - the store's name, contact, logo and icon, as its owner set them in the
+ *   panel. One storefront serves every store under `baseDomain`, so a name or
+ *   a logo in the static record would be every store's;
  * - the settlement currency. Every price on the site is formatted with it, and
  *   a store record saying USD over an engine charging INR would print the
  *   wrong symbol on every price;
@@ -6606,39 +6625,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;
@@ -6749,6 +6735,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;
         }[];
     }>;
 }

package/dist/index.cjs

@@ -1216,14 +1216,17 @@ var CatalogService = class extends BaseService {
     const attr = Object.entries(q.attributes ?? {}).flatMap(
       ([handle, values]) => values.filter(Boolean).map((v) => `${handle}:${v}`)
     );
-    if (q.facets && !legacyListing.has(this.engineBase())) {
+    const refined = attr.length > 0 || !!(q.tags?.length || q.vendors?.length || q.productTypes?.length);
+    const triedIndex = !!search && !refined;
+    const counted = q.facets && !legacyListing.has(this.engineBase());
+    const facetListing = async (page2, limit2) => {
       const { currency } = await this.facts.ready();
       const minor = (n) => Number.isFinite(n) ? Math.max(0, toMinor(n, currency)) : void 0;
-      const env2 = await this.engine("/api/products", {
+      return this.engine("/api/products", {
         query: {
           q: search,
-          page,
-          limit,
+          page: page2,
+          limit: limit2,
           channel: this.creds.channel,
           category: q.category,
           tag: q.tags,
@@ -1236,6 +1239,16 @@ var CatalogService = class extends BaseService {
           facets: 1
         }
       });
+    };
+    if (triedIndex && await this.facts.pluginOn("meilisearch")) {
+      const [found, rail] = await Promise.all([
+        this.fromIndex(q, { page, limit, search, sortKey, wantsRange, hierarchy }),
+        counted ? facetListing(1, 1).catch(() => null) : null
+      ]);
+      if (found) return rail?.meta?.facets ? { ...found, facets: rail.meta.facets } : found;
+    }
+    if (counted) {
+      const env2 = await facetListing(page, limit);
       if (env2.meta?.facets) {
         return {
           ...toPage(env2, (p) => toProduct(p)),
@@ -1246,39 +1259,9 @@ var CatalogService = class extends BaseService {
       }
       legacyListing.add(this.engineBase());
     }
-    if ((sortKey || wantsRange) && await this.facts.pluginOn("meilisearch")) {
-      const filters = [];
-      if (q.category) {
-        const names = (await this.facts.subtree(q.category).catch(() => [])).map(
-          (c) => quote(c.full_name)
-        );
-        if (!names.length) return { ...emptyCatalog(limit), categoryHierarchy: hierarchy, sorted: true };
-        filters.push(`category IN [${names.join(", ")}]`);
-      }
-      if (wantsRange) {
-        const { currency } = await this.facts.ready();
-        if (Number.isFinite(q.priceFrom)) filters.push(`price_minor >= ${toMinor(q.priceFrom, currency)}`);
-        if (Number.isFinite(q.priceTo)) filters.push(`price_minor <= ${toMinor(q.priceTo, currency)}`);
-      }
-      const res = await this.data("/x/meilisearch/search", {
-        query: {
-          q: search ?? "",
-          limit,
-          offset: (page - 1) * limit,
-          filter: filters.join(" AND ") || void 0,
-          sort: sortKey
-        }
-      });
-      const total = res.total ?? 0;
-      return {
-        data: (res.hits ?? []).map(fromSearchDoc),
-        count: total,
-        pageSize: limit,
-        noOfPage: Math.max(1, Math.ceil(total / limit)),
-        page,
-        categoryHierarchy: hierarchy,
-        sorted: true
-      };
+    if (!triedIndex && (sortKey || wantsRange)) {
+      const found = await this.fromIndex(q, { page, limit, search, sortKey, wantsRange, hierarchy });
+      if (found) return found;
     }
     const sorted = !sortKey && !wantsRange;
     if (q.category && !search) {
@@ -1298,6 +1281,45 @@ var CatalogService = class extends BaseService {
     });
     return { ...toPage(env, (p) => toProduct(p)), categoryHierarchy: hierarchy, sorted };
   }
+  /**
+   * 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.
+   */
+  async fromIndex(q, o) {
+    if (this.creds.channel || !await this.facts.pluginOn("meilisearch")) return null;
+    const filters = [];
+    if (q.category) {
+      const names = (await this.facts.subtree(q.category).catch(() => [])).map((c) => quote(c.full_name));
+      if (!names.length) return { ...emptyCatalog(o.limit), categoryHierarchy: o.hierarchy, sorted: true };
+      filters.push(`category IN [${names.join(", ")}]`);
+    }
+    if (o.wantsRange) {
+      const { currency } = await this.facts.ready();
+      if (Number.isFinite(q.priceFrom)) filters.push(`price_minor >= ${toMinor(q.priceFrom, currency)}`);
+      if (Number.isFinite(q.priceTo)) filters.push(`price_minor <= ${toMinor(q.priceTo, currency)}`);
+    }
+    const res = await this.data("/x/meilisearch/search", {
+      query: {
+        q: o.search ?? "",
+        limit: o.limit,
+        offset: (o.page - 1) * o.limit,
+        filter: filters.join(" AND ") || void 0,
+        sort: o.sortKey
+      }
+    }).catch(() => null);
+    if (!res || res.unavailable || o.search && !res.hits?.length) return null;
+    const total = res.total ?? 0;
+    return {
+      data: (res.hits ?? []).map(fromSearchDoc),
+      count: total,
+      pageSize: o.limit,
+      noOfPage: Math.max(1, Math.ceil(total / o.limit)),
+      page: o.page,
+      categoryHierarchy: o.hierarchy,
+      sorted: true
+    };
+  }
 };
 function emptyCatalog(limit = PAGE_SIZE) {
   return { data: [], count: 0, pageSize: limit, noOfPage: 0, page: 1 };
@@ -1595,10 +1617,8 @@ var MeilisearchService = class extends CatalogService {
   async searchAutoComplete({ query, search, limit = 8 } = {}) {
     const q = (query ?? search ?? "").trim();
     if (!q) return { data: [] };
-    if (await this.facts.pluginOn("meilisearch")) {
-      const res = await this.data("/x/meilisearch/search", { query: { q, limit } });
-      return { data: (res.hits ?? []).map(fromSearchDoc) };
-    }
+    const found = await this.fromIndex({}, { page: 1, limit, search: q, wantsRange: false, hierarchy: [] });
+    if (found) return { data: found.data };
     const rows = await this.data("/api/products", { query: { q, limit, channel: this.creds.channel } }) ?? [];
     return { data: rows.map((p) => toProduct(p)) };
   }
@@ -3023,6 +3043,12 @@ var StoreService = class extends BaseService {
       ...profile?.name ? { name: profile.name } : {},
       ...profile?.email ? { businessEmail: profile.email } : {},
       ...profile?.phone ? { businessPhone: profile.phone } : {},
+      // The store's pictures (D148), the same: one it has not chosen keeps the static one.
+      // Its own logo also replaces the static dark logo, which would be the deployment's
+      // mark beside this store's; without a dark one of its own, its logo is the fallback.
+      ...profile?.logo_url ? { logo: mediaUrl(profile.logo_url), logoDark: void 0 } : {},
+      ...profile?.logo_dark_url ? { logoDark: mediaUrl(profile.logo_dark_url) } : {},
+      ...profile?.icon_url ? { favicon: mediaUrl(profile.icon_url) } : {},
       currencyCode: code,
       currencySymbol: sameCurrency ? base.currencySymbol ?? symbolFor(code) : symbolFor(code),
       currency: {
@@ -3045,7 +3071,18 @@ var StoreService = class extends BaseService {
         newsletter: { ...basePlugins.newsletter, ...flag(plugins.has("newsletter")) },
         // Discount codes are core: every GoCommerce store takes them, so
         // the code box is shown whatever the static record says.
-        isDiscountCoupons: { ...basePlugins.isDiscountCoupons, active: true }
+        isDiscountCoupons: { ...basePlugins.isDiscountCoupons, active: true },
+        // The engine resizes the store's own pictures in Cloudflare's URL shape
+        // (D139), so the storefront's srcset asks it for each width. Its public
+        // origin, not the proxy path: an <img> needs no CORS, and the proxy would
+        // put every picture through the storefront's server.
+        ...profile?.images_path && this.creds.apiUrl ? {
+          imageCdn: {
+            provider: "cloudflare",
+            url: this.creds.apiUrl.trim().replace(/\/+$/, "") + profile.images_path,
+            active: true
+          }
+        } : {}
       },
       ...menus?.length ? { menu: menus } : {},
       ...deliverable(base, ships),