@misiki/gocommerce-connector 0.3.0 → 0.4.0

package/README.md

@@ -26,6 +26,7 @@ PUBLIC_GOCOMMERCE_API_URL=https://api.shop.example    # the engine
 PUBLIC_GOCOMMERCE_PROXY_PATH=/gocommerce              # see "The browser and CORS"
 # PUBLIC_GOCOMMERCE_CHANNEL=web                       # a sales channel, if the store has several
 # PUBLIC_GOCOMMERCE_STORE=acme                        # under `gocommerce platform`, on a shared API host
+# PUBLIC_GOCOMMERCE_BASE_DOMAIN=shopnx.in             # or every store: acme.shopnx.in is store `acme`
 # PUBLIC_GOCOMMERCE_LANGUAGE=fr                       # ask for this language (?lang=) on every read
 ```
 
@@ -77,6 +78,33 @@ location /            { proxy_pass http://storefront:3000; }
 Serving the storefront and the engine from one origin works too; then leave the
 proxy path unset and point the API URL at that origin.
 
+### One storefront for every store
+
+Under `gocommerce platform` a storefront can sell for one store, named in
+`PUBLIC_GOCOMMERCE_STORE`, or for all of them. Set `PUBLIC_GOCOMMERCE_BASE_DOMAIN`
+to the domain the engine hands out subdomains of and point every
+`<slug>.<base domain>` at the one deployment: a request for `acme.shopnx.in` is
+sent to the engine with `X-Store: acme`, by the same rule the engine applies to
+its own host (one label, case-insensitive, a port ignored). A host outside the
+base domain falls back to `PUBLIC_GOCOMMERCE_STORE`, or to no store at all.
+
+The browser knows its own host. The server does not, so tell the connector where
+to read it, once, from `src/hooks.server.ts`:
+
+```ts
+import { getRequestEvent } from '$app/server'
+import { setRequestHost } from '@misiki/gocommerce-connector'
+
+setRequestHost(() => getRequestEvent().url.hostname)
+```
+
+Store-level facts (plugins, currency, menus) are cached per store, so two stores
+on one process never see each other's. A host under the base domain that names
+a store the engine does not have makes `getStoreByIdOrDomain` throw a
+`GoCommerceError` with status 404 and "store not found" in its message, which
+Svelte Commerce renders as its own "Store not found" page. An engine that is
+down stays best-effort: the storefront renders from its static record.
+
 ## What maps to what
 
 | Storefront | Engine |

package/dist/{index-BfbB3jQb.d.cts → index-iPG0fxzc.d.cts}

@@ -31,6 +31,16 @@ interface Credentials {
      * shared API host. Leave unset when the store has a host of its own.
      */
     store?: string;
+    /**
+     * `PUBLIC_GOCOMMERCE_BASE_DOMAIN` — under `gocommerce platform`, the domain
+     * every store gets a subdomain of, `shopnx.in`. One storefront deployment
+     * then serves them all: a request for `acme.shopnx.in` is sent with
+     * `X-Store: acme`, the same rule the engine applies to its own host. A host
+     * outside the base domain falls back to `store`. Server-side the connector
+     * learns the request's host through `setRequestHost`; in the browser it is
+     * `window.location.hostname`.
+     */
+    baseDomain?: string;
     /**
      * `PUBLIC_GOCOMMERCE_CHANNEL` — the sales channel new carts and the product
      * listing belong to, when the store sells through more than one.
@@ -1128,6 +1138,16 @@ type EngineRequest = {
     /** Send the signed-in shopper's bearer token. Only ext/identity reads it. */
     auth?: boolean;
 };
+/**
+ * A media URL the shopper's browser can load. The engine answers its own
+ * uploads root-relative (`/media/ab12.png`), which a browser resolves against
+ * the storefront's origin, where no such file is. Through the proxy path when
+ * one is set — a root-relative path that reads the same in SSR and in the
+ * browser, so hydration agrees — and otherwise from the engine's origin.
+ * Absolute URLs, such as pictures the media library links rather than holds,
+ * pass through untouched.
+ */
+declare function mediaUrl(url: string | null | undefined): string | null;
 /**
  * BaseService — the one place this connector talks to the engine.
  *
@@ -1153,6 +1173,13 @@ declare class BaseService {
     static setCredentials(creds: Partial<Credentials>): void;
     static getCredentials(): Credentials;
     protected get creds(): Credentials;
+    /**
+     * The store this call is for: the request host's subdomain under
+     * `baseDomain`, else the static `store`. Read per call, never stored on the
+     * instance, because the server shares one process (and one credentials
+     * object) across every concurrent request and each may be for a different host.
+     */
+    protected get store(): string | undefined;
     /**
      * The engine's base URL from wherever this code runs. In the browser a
      * configured proxy path wins, because the engine answers no CORS preflight.
@@ -1190,6 +1217,19 @@ declare class BaseService {
     delete<T = any>(path: string): Promise<T>;
     private raw;
 }
+/**
+ * Where the server learns the current request's host, for `baseDomain`. A
+ * SvelteKit storefront registers `() => getRequestEvent().url.hostname` once
+ * at boot; the browser needs nothing, it reads `window.location`.
+ */
+declare function setRequestHost(fn: () => string | undefined): void;
+/**
+ * `acme.shopnx.in` under `shopnx.in` is store `acme`; anything else is nobody's.
+ * The engine's own rule (`Stores.ByHost`): case-insensitive, a port and a
+ * trailing dot ignored, and exactly one label, so `a.b.shopnx.in` and
+ * `shopnx.in` itself name no store.
+ */
+declare function storeForHost(host: string | undefined, baseDomain: string | undefined): string | undefined;
 /** `?a=1&b=2`, dropping what was not asked for. Arrays repeat the key. */
 declare function qs(query?: Query): string;
 /** The family's list shape, from the engine's `{data, meta}`. Totals are the engine's, never invented. */
@@ -6449,4 +6489,4 @@ declare class B2bService extends BaseService {
 }
 declare const b2bService: B2bService;
 
-export { type Menu 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, HomeService as T, type IdentityAddress as U, InitService as V, type Invitation as W, type Lead as X, type ListMeta as Y, MeilisearchService as Z, type Member as _, AddressService as a, contactService as a$, type MenuItem as a0, MenuService as a1, type MenuSummary as a2, type Money as a3, NewsletterService as a4, type Offer as a5, type Order as a6, type OrderLine as a7, OrderService as a8, PageService as a9, type StorefrontMenu as aA, type StorefrontOrder as aB, type StorefrontProduct as aC, UploadService as aD, UserService as aE, type Variant as aF, type VariantImage as aG, VariantService as aH, VarniCustomDesignService as aI, VarniCustomProductService as aJ, type Vendor as aK, VendorService as aL, WarrantyService as aM, type Wishlist as aN, type WishlistItem as aO, WishlistService as aP, addressService as aQ, authService as aR, autocompleteService as aS, b2bService as aT, bannerService as aU, blogService as aV, cartService as aW, categoryService as aX, chatService as aY, checkoutService as aZ, collectionService as a_, type PaymentIntent as aa, PaymentMethodService as ab, type Plugin as ac, PluginService as ad, PopularSearchService as ae, PopularityService as af, type Product as ag, type ProductOption as ah, ProductService as ai, ProfileService as aj, type Quote as ak, REDIRECT_GATEWAYS as al, ReelsService as am, RegionService as an, type RejectedLine as ao, type Review as ap, type ReviewPage as aq, ReviewService as ar, type SearchDoc as as, type SearchResult as at, SearchService as au, SettingService as av, type ShippingRate as aw, StateService as ax, StoreService as ay, type StorefrontCategory as az, type AppliedDiscount as b, vendorService as b$, countryService as b0, couponService as b1, currencyExponent as b2, currencyService as b3, dealService as b4, demoRequestService as b5, emptyCart as b6, emptyPage as b7, enquiryService as b8, faqService as b9, searchService as bA, settingService as bB, settingsService as bC, stateService as bD, staticStore as bE, storeService as bF, toCart as bG, toCartLine as bH, toCategory as bI, toCmsPage as bJ, toCollection as bK, toEngineAddress as bL, toIdentityAddress as bM, toMajor as bN, toMinor as bO, toOrder as bP, toPage as bQ, toProduct as bR, toRating as bS, toUser as bT, toVariant as bU, toVendor as bV, uploadService as bW, userService as bX, variantService as bY, varniCustomDesignService as bZ, varniCustomProductService as b_, feedbackService as ba, fromEngineAddress as bb, fromIdentityAddress as bc, fromSearchDoc as bd, galleryService as be, homeService as bf, initService as bg, meilisearchService as bh, menuService as bi, minorToMajor as bj, newsletterService as bk, orderService as bl, pageService as bm, paymentMethodService as bn, pluginService as bo, pluginsService as bp, popularSearchService as bq, popularityService as br, priceOf as bs, productImages as bt, productService as bu, profileService as bv, qs as bw, reelsService as bx, regionService as by, reviewService as bz, type Approval as c, warrantyService as c0, wishlistService as c1, 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 Menu 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, HomeService as T, type IdentityAddress as U, InitService as V, type Invitation as W, type Lead as X, type ListMeta as Y, MeilisearchService as Z, type Member as _, AddressService as a, contactService as a$, type MenuItem as a0, MenuService as a1, type MenuSummary as a2, type Money as a3, NewsletterService as a4, type Offer as a5, type Order as a6, type OrderLine as a7, OrderService as a8, PageService as a9, type StorefrontMenu as aA, type StorefrontOrder as aB, type StorefrontProduct as aC, UploadService as aD, UserService as aE, type Variant as aF, type VariantImage as aG, VariantService as aH, VarniCustomDesignService as aI, VarniCustomProductService as aJ, type Vendor as aK, VendorService as aL, WarrantyService as aM, type Wishlist as aN, type WishlistItem as aO, WishlistService as aP, addressService as aQ, authService as aR, autocompleteService as aS, b2bService as aT, bannerService as aU, blogService as aV, cartService as aW, categoryService as aX, chatService as aY, checkoutService as aZ, collectionService as a_, type PaymentIntent as aa, PaymentMethodService as ab, type Plugin as ac, PluginService as ad, PopularSearchService as ae, PopularityService as af, type Product as ag, type ProductOption as ah, ProductService as ai, ProfileService as aj, type Quote as ak, REDIRECT_GATEWAYS as al, ReelsService as am, RegionService as an, type RejectedLine as ao, type Review as ap, type ReviewPage as aq, ReviewService as ar, type SearchDoc as as, type SearchResult as at, SearchService as au, SettingService as av, type ShippingRate as aw, StateService as ax, StoreService as ay, type StorefrontCategory as az, type AppliedDiscount as b, variantService as b$, countryService as b0, couponService as b1, currencyExponent as b2, currencyService as b3, dealService as b4, demoRequestService as b5, emptyCart as b6, emptyPage as b7, enquiryService as b8, faqService as b9, reviewService as bA, searchService as bB, setRequestHost as bC, settingService as bD, settingsService as bE, stateService as bF, staticStore as bG, storeForHost as bH, storeService as bI, toCart as bJ, toCartLine as bK, toCategory as bL, toCmsPage as bM, toCollection as bN, toEngineAddress as bO, toIdentityAddress as bP, toMajor as bQ, toMinor as bR, toOrder as bS, toPage as bT, toProduct as bU, toRating as bV, toUser as bW, toVariant as bX, toVendor as bY, uploadService as bZ, userService as b_, feedbackService as ba, fromEngineAddress as bb, fromIdentityAddress as bc, fromSearchDoc as bd, galleryService as be, homeService as bf, initService as bg, mediaUrl as bh, meilisearchService as bi, menuService as bj, minorToMajor as bk, newsletterService as bl, orderService as bm, pageService as bn, paymentMethodService as bo, pluginService as bp, pluginsService as bq, popularSearchService as br, popularityService as bs, priceOf as bt, productImages as bu, productService as bv, profileService as bw, qs as bx, reelsService as by, regionService as bz, type Approval as c, varniCustomDesignService as c0, varniCustomProductService as c1, vendorService as c2, warrantyService as c3, wishlistService as c4, 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 };

package/dist/{index-BfbB3jQb.d.ts → index-iPG0fxzc.d.ts}

@@ -31,6 +31,16 @@ interface Credentials {
      * shared API host. Leave unset when the store has a host of its own.
      */
     store?: string;
+    /**
+     * `PUBLIC_GOCOMMERCE_BASE_DOMAIN` — under `gocommerce platform`, the domain
+     * every store gets a subdomain of, `shopnx.in`. One storefront deployment
+     * then serves them all: a request for `acme.shopnx.in` is sent with
+     * `X-Store: acme`, the same rule the engine applies to its own host. A host
+     * outside the base domain falls back to `store`. Server-side the connector
+     * learns the request's host through `setRequestHost`; in the browser it is
+     * `window.location.hostname`.
+     */
+    baseDomain?: string;
     /**
      * `PUBLIC_GOCOMMERCE_CHANNEL` — the sales channel new carts and the product
      * listing belong to, when the store sells through more than one.
@@ -1128,6 +1138,16 @@ type EngineRequest = {
     /** Send the signed-in shopper's bearer token. Only ext/identity reads it. */
     auth?: boolean;
 };
+/**
+ * A media URL the shopper's browser can load. The engine answers its own
+ * uploads root-relative (`/media/ab12.png`), which a browser resolves against
+ * the storefront's origin, where no such file is. Through the proxy path when
+ * one is set — a root-relative path that reads the same in SSR and in the
+ * browser, so hydration agrees — and otherwise from the engine's origin.
+ * Absolute URLs, such as pictures the media library links rather than holds,
+ * pass through untouched.
+ */
+declare function mediaUrl(url: string | null | undefined): string | null;
 /**
  * BaseService — the one place this connector talks to the engine.
  *
@@ -1153,6 +1173,13 @@ declare class BaseService {
     static setCredentials(creds: Partial<Credentials>): void;
     static getCredentials(): Credentials;
     protected get creds(): Credentials;
+    /**
+     * The store this call is for: the request host's subdomain under
+     * `baseDomain`, else the static `store`. Read per call, never stored on the
+     * instance, because the server shares one process (and one credentials
+     * object) across every concurrent request and each may be for a different host.
+     */
+    protected get store(): string | undefined;
     /**
      * The engine's base URL from wherever this code runs. In the browser a
      * configured proxy path wins, because the engine answers no CORS preflight.
@@ -1190,6 +1217,19 @@ declare class BaseService {
     delete<T = any>(path: string): Promise<T>;
     private raw;
 }
+/**
+ * Where the server learns the current request's host, for `baseDomain`. A
+ * SvelteKit storefront registers `() => getRequestEvent().url.hostname` once
+ * at boot; the browser needs nothing, it reads `window.location`.
+ */
+declare function setRequestHost(fn: () => string | undefined): void;
+/**
+ * `acme.shopnx.in` under `shopnx.in` is store `acme`; anything else is nobody's.
+ * The engine's own rule (`Stores.ByHost`): case-insensitive, a port and a
+ * trailing dot ignored, and exactly one label, so `a.b.shopnx.in` and
+ * `shopnx.in` itself name no store.
+ */
+declare function storeForHost(host: string | undefined, baseDomain: string | undefined): string | undefined;
 /** `?a=1&b=2`, dropping what was not asked for. Arrays repeat the key. */
 declare function qs(query?: Query): string;
 /** The family's list shape, from the engine's `{data, meta}`. Totals are the engine's, never invented. */
@@ -6449,4 +6489,4 @@ declare class B2bService extends BaseService {
 }
 declare const b2bService: B2bService;
 
-export { type Menu 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, HomeService as T, type IdentityAddress as U, InitService as V, type Invitation as W, type Lead as X, type ListMeta as Y, MeilisearchService as Z, type Member as _, AddressService as a, contactService as a$, type MenuItem as a0, MenuService as a1, type MenuSummary as a2, type Money as a3, NewsletterService as a4, type Offer as a5, type Order as a6, type OrderLine as a7, OrderService as a8, PageService as a9, type StorefrontMenu as aA, type StorefrontOrder as aB, type StorefrontProduct as aC, UploadService as aD, UserService as aE, type Variant as aF, type VariantImage as aG, VariantService as aH, VarniCustomDesignService as aI, VarniCustomProductService as aJ, type Vendor as aK, VendorService as aL, WarrantyService as aM, type Wishlist as aN, type WishlistItem as aO, WishlistService as aP, addressService as aQ, authService as aR, autocompleteService as aS, b2bService as aT, bannerService as aU, blogService as aV, cartService as aW, categoryService as aX, chatService as aY, checkoutService as aZ, collectionService as a_, type PaymentIntent as aa, PaymentMethodService as ab, type Plugin as ac, PluginService as ad, PopularSearchService as ae, PopularityService as af, type Product as ag, type ProductOption as ah, ProductService as ai, ProfileService as aj, type Quote as ak, REDIRECT_GATEWAYS as al, ReelsService as am, RegionService as an, type RejectedLine as ao, type Review as ap, type ReviewPage as aq, ReviewService as ar, type SearchDoc as as, type SearchResult as at, SearchService as au, SettingService as av, type ShippingRate as aw, StateService as ax, StoreService as ay, type StorefrontCategory as az, type AppliedDiscount as b, vendorService as b$, countryService as b0, couponService as b1, currencyExponent as b2, currencyService as b3, dealService as b4, demoRequestService as b5, emptyCart as b6, emptyPage as b7, enquiryService as b8, faqService as b9, searchService as bA, settingService as bB, settingsService as bC, stateService as bD, staticStore as bE, storeService as bF, toCart as bG, toCartLine as bH, toCategory as bI, toCmsPage as bJ, toCollection as bK, toEngineAddress as bL, toIdentityAddress as bM, toMajor as bN, toMinor as bO, toOrder as bP, toPage as bQ, toProduct as bR, toRating as bS, toUser as bT, toVariant as bU, toVendor as bV, uploadService as bW, userService as bX, variantService as bY, varniCustomDesignService as bZ, varniCustomProductService as b_, feedbackService as ba, fromEngineAddress as bb, fromIdentityAddress as bc, fromSearchDoc as bd, galleryService as be, homeService as bf, initService as bg, meilisearchService as bh, menuService as bi, minorToMajor as bj, newsletterService as bk, orderService as bl, pageService as bm, paymentMethodService as bn, pluginService as bo, pluginsService as bp, popularSearchService as bq, popularityService as br, priceOf as bs, productImages as bt, productService as bu, profileService as bv, qs as bw, reelsService as bx, regionService as by, reviewService as bz, type Approval as c, warrantyService as c0, wishlistService as c1, 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 Menu 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, HomeService as T, type IdentityAddress as U, InitService as V, type Invitation as W, type Lead as X, type ListMeta as Y, MeilisearchService as Z, type Member as _, AddressService as a, contactService as a$, type MenuItem as a0, MenuService as a1, type MenuSummary as a2, type Money as a3, NewsletterService as a4, type Offer as a5, type Order as a6, type OrderLine as a7, OrderService as a8, PageService as a9, type StorefrontMenu as aA, type StorefrontOrder as aB, type StorefrontProduct as aC, UploadService as aD, UserService as aE, type Variant as aF, type VariantImage as aG, VariantService as aH, VarniCustomDesignService as aI, VarniCustomProductService as aJ, type Vendor as aK, VendorService as aL, WarrantyService as aM, type Wishlist as aN, type WishlistItem as aO, WishlistService as aP, addressService as aQ, authService as aR, autocompleteService as aS, b2bService as aT, bannerService as aU, blogService as aV, cartService as aW, categoryService as aX, chatService as aY, checkoutService as aZ, collectionService as a_, type PaymentIntent as aa, PaymentMethodService as ab, type Plugin as ac, PluginService as ad, PopularSearchService as ae, PopularityService as af, type Product as ag, type ProductOption as ah, ProductService as ai, ProfileService as aj, type Quote as ak, REDIRECT_GATEWAYS as al, ReelsService as am, RegionService as an, type RejectedLine as ao, type Review as ap, type ReviewPage as aq, ReviewService as ar, type SearchDoc as as, type SearchResult as at, SearchService as au, SettingService as av, type ShippingRate as aw, StateService as ax, StoreService as ay, type StorefrontCategory as az, type AppliedDiscount as b, variantService as b$, countryService as b0, couponService as b1, currencyExponent as b2, currencyService as b3, dealService as b4, demoRequestService as b5, emptyCart as b6, emptyPage as b7, enquiryService as b8, faqService as b9, reviewService as bA, searchService as bB, setRequestHost as bC, settingService as bD, settingsService as bE, stateService as bF, staticStore as bG, storeForHost as bH, storeService as bI, toCart as bJ, toCartLine as bK, toCategory as bL, toCmsPage as bM, toCollection as bN, toEngineAddress as bO, toIdentityAddress as bP, toMajor as bQ, toMinor as bR, toOrder as bS, toPage as bT, toProduct as bU, toRating as bV, toUser as bW, toVariant as bX, toVendor as bY, uploadService as bZ, userService as b_, feedbackService as ba, fromEngineAddress as bb, fromIdentityAddress as bc, fromSearchDoc as bd, galleryService as be, homeService as bf, initService as bg, mediaUrl as bh, meilisearchService as bi, menuService as bj, minorToMajor as bk, newsletterService as bl, orderService as bm, pageService as bn, paymentMethodService as bo, pluginService as bp, pluginsService as bq, popularSearchService as br, popularityService as bs, priceOf as bt, productImages as bu, productService as bv, profileService as bw, qs as bx, reelsService as by, regionService as bz, type Approval as c, varniCustomDesignService as c0, varniCustomProductService as c1, vendorService as c2, warrantyService as c3, wishlistService as c4, 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 };