@misiki/gocommerce-connector 0.8.0 → 0.9.0

package/README.md

@@ -139,6 +139,7 @@ down stays best-effort: the storefront renders from its static record.
 | content pages (`/p/…`, legal pages) | `/x/cms/pages` |
 | FAQ | `/x/faq` |
 | composed home page | `/x/layouts/home` (`?preview=` for a draft) — `layoutService.getHomeLayout()`, null when the store has none; carries `themeSettings` and each collection list's `collections` |
+| product and collection templates | `/x/layouts/product`, `/x/layouts/collection` (`?preview=` for a draft) — `layoutService.getProductLayout()` and `getCollectionLayout()`, the sections the shop arranged around the page's core (`main-product`, `main-collection`); null when none is published, and the page draws as before |
 | theme settings | `/x/layouts/theme` (`?preview=` for a draft) — `layoutService.getThemeSettings()`, the store's colours, fonts and rounding for every page; null when there are none |
 | menus | `/x/navigation/menus/{header,footer}`, laid over `store.menu`; any menu by handle |
 | product specs table | the product's category attribute answers |

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

@@ -5861,6 +5861,14 @@ type HomeLayoutSection = {
     products?: StorefrontProduct[];
     collections?: LayoutCollection[];
 };
+/**
+ * A page the shop arranges: the home page, or the template every product or
+ * every collection is drawn in (ext/layouts, D128). A template holds its
+ * core once — `main-product` (the catalogue's pictures, price and buy box)
+ * or `main-collection` (the collection's grid) — at the place the shop put
+ * it, and the storefront draws its own core there.
+ */
+type LayoutPage = 'home' | 'product' | 'collection';
 type HomeLayout = {
     page: string;
     theme: string;
@@ -5872,6 +5880,8 @@ type HomeLayout = {
     themeSettings: ThemeSettings | null;
     sections: HomeLayoutSection[];
 };
+/** A composed page of any kind; a template's `themeSettings` is always null. */
+type PageLayout = HomeLayout;
 /** The design tokens alone, for every page the storefront draws. */
 type ThemeSettingsResult = {
     revision?: number;
@@ -5888,6 +5898,22 @@ declare class LayoutService extends BaseService {
     getHomeLayout({ preview }?: {
         preview?: string | null;
     }): Promise<HomeLayout | null>;
+    /**
+     * The template every product page is drawn in: the sections around the
+     * product's core (`main-product`). Null when none is published, so the
+     * product page draws exactly as it did before templates existed.
+     */
+    getProductLayout({ preview }?: {
+        preview?: string | null;
+    }): Promise<PageLayout | null>;
+    /** The template every collection page is drawn in, around its grid (`main-collection`). */
+    getCollectionLayout({ preview }?: {
+        preview?: string | null;
+    }): Promise<PageLayout | null>;
+    /** Any arranged page by its key; null for none, as the three above. */
+    getPageLayout(page: LayoutPage, { preview }?: {
+        preview?: string | null;
+    }): Promise<PageLayout | null>;
     /**
      * The store's design tokens, for a page other than the home page: the
      * published ones, or a preview key's draft. Null when there are none to
@@ -7041,4 +7067,4 @@ declare class B2bService extends BaseService {
 }
 declare const b2bService: B2bService;
 
-export { type Lead 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, LayoutService as _, AddressService as a, bannerService as a$, type ListMeta as a0, MeilisearchService as a1, type Member as a2, type Menu as a3, type MenuItem as a4, MenuService as a5, type MenuSummary as a6, type Money as a7, NewsletterService as a8, type Offer as a9, type ShippingRate as aA, StateService as aB, type StoreProfile as aC, StoreService as aD, type StorefrontCategory as aE, type StorefrontMenu as aF, type StorefrontOrder as aG, type StorefrontProduct as aH, type ThemeSettings as aI, type ThemeSettingsResult as aJ, UploadService as aK, UserService as aL, type Variant as aM, type VariantImage as aN, VariantService as aO, VarniCustomDesignService as aP, VarniCustomProductService as aQ, type Vendor as aR, VendorService as aS, WarrantyService as aT, type Wishlist as aU, type WishlistItem as aV, WishlistService as aW, addressService as aX, authService as aY, autocompleteService as aZ, b2bService as a_, type Order as aa, type OrderLine as ab, OrderService as ac, PageService as ad, type PaymentIntent as ae, PaymentMethodService as af, type Plugin as ag, PluginService as ah, PopularSearchService as ai, PopularityService as aj, type Product as ak, type ProductOption as al, ProductService as am, ProfileService as an, type Quote as ao, REDIRECT_GATEWAYS as ap, ReelsService as aq, RegionService as ar, type RejectedLine as as, type Review as at, type ReviewPage as au, ReviewService as av, type SearchDoc as aw, type SearchResult as ax, SearchService as ay, SettingService as az, type AppliedDiscount as b, toOrder as b$, blogService as b0, cartService as b1, categoryService as b2, chatService as b3, checkoutService as b4, collectionService as b5, contactService as b6, countryService as b7, couponService as b8, currencyExponent as b9, popularSearchService as bA, popularityService as bB, priceOf as bC, productImages as bD, productService as bE, profileService as bF, qs as bG, reelsService as bH, regionService as bI, reviewService as bJ, searchService as bK, setRequestHost as bL, settingService as bM, settingsService as bN, stateService as bO, staticStore as bP, storeForHost as bQ, storeService as bR, toCart as bS, toCartLine as bT, toCategory as bU, toCmsPage as bV, toCollection as bW, toEngineAddress as bX, toIdentityAddress as bY, toMajor as bZ, toMinor as b_, currencyService as ba, dealService as bb, demoRequestService as bc, emptyCart as bd, emptyPage as be, enquiryService as bf, faqService as bg, feedbackService as bh, fromEngineAddress as bi, fromIdentityAddress as bj, fromSearchDoc as bk, galleryService as bl, homeService as bm, initService as bn, layoutService as bo, mediaUrl as bp, meilisearchService as bq, menuService as br, minorToMajor as bs, newsletterService as bt, orderService as bu, ownDomain as bv, pageService as bw, paymentMethodService as bx, pluginService as by, pluginsService as bz, type Approval as c, toPage as c0, toProduct as c1, toRating as c2, toUser as c3, toVariant as c4, toVendor as c5, uploadService as c6, userService as c7, variantService as c8, varniCustomDesignService as c9, varniCustomProductService as ca, vendorService as cb, warrantyService as cc, wishlistService as cd, 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 { 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 };

package/dist/{index-inrM-B0Z.d.ts → index-72kQMxjZ.d.ts}

@@ -5861,6 +5861,14 @@ type HomeLayoutSection = {
     products?: StorefrontProduct[];
     collections?: LayoutCollection[];
 };
+/**
+ * A page the shop arranges: the home page, or the template every product or
+ * every collection is drawn in (ext/layouts, D128). A template holds its
+ * core once — `main-product` (the catalogue's pictures, price and buy box)
+ * or `main-collection` (the collection's grid) — at the place the shop put
+ * it, and the storefront draws its own core there.
+ */
+type LayoutPage = 'home' | 'product' | 'collection';
 type HomeLayout = {
     page: string;
     theme: string;
@@ -5872,6 +5880,8 @@ type HomeLayout = {
     themeSettings: ThemeSettings | null;
     sections: HomeLayoutSection[];
 };
+/** A composed page of any kind; a template's `themeSettings` is always null. */
+type PageLayout = HomeLayout;
 /** The design tokens alone, for every page the storefront draws. */
 type ThemeSettingsResult = {
     revision?: number;
@@ -5888,6 +5898,22 @@ declare class LayoutService extends BaseService {
     getHomeLayout({ preview }?: {
         preview?: string | null;
     }): Promise<HomeLayout | null>;
+    /**
+     * The template every product page is drawn in: the sections around the
+     * product's core (`main-product`). Null when none is published, so the
+     * product page draws exactly as it did before templates existed.
+     */
+    getProductLayout({ preview }?: {
+        preview?: string | null;
+    }): Promise<PageLayout | null>;
+    /** The template every collection page is drawn in, around its grid (`main-collection`). */
+    getCollectionLayout({ preview }?: {
+        preview?: string | null;
+    }): Promise<PageLayout | null>;
+    /** Any arranged page by its key; null for none, as the three above. */
+    getPageLayout(page: LayoutPage, { preview }?: {
+        preview?: string | null;
+    }): Promise<PageLayout | null>;
     /**
      * The store's design tokens, for a page other than the home page: the
      * published ones, or a preview key's draft. Null when there are none to
@@ -7041,4 +7067,4 @@ declare class B2bService extends BaseService {
 }
 declare const b2bService: B2bService;
 
-export { type Lead 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, LayoutService as _, AddressService as a, bannerService as a$, type ListMeta as a0, MeilisearchService as a1, type Member as a2, type Menu as a3, type MenuItem as a4, MenuService as a5, type MenuSummary as a6, type Money as a7, NewsletterService as a8, type Offer as a9, type ShippingRate as aA, StateService as aB, type StoreProfile as aC, StoreService as aD, type StorefrontCategory as aE, type StorefrontMenu as aF, type StorefrontOrder as aG, type StorefrontProduct as aH, type ThemeSettings as aI, type ThemeSettingsResult as aJ, UploadService as aK, UserService as aL, type Variant as aM, type VariantImage as aN, VariantService as aO, VarniCustomDesignService as aP, VarniCustomProductService as aQ, type Vendor as aR, VendorService as aS, WarrantyService as aT, type Wishlist as aU, type WishlistItem as aV, WishlistService as aW, addressService as aX, authService as aY, autocompleteService as aZ, b2bService as a_, type Order as aa, type OrderLine as ab, OrderService as ac, PageService as ad, type PaymentIntent as ae, PaymentMethodService as af, type Plugin as ag, PluginService as ah, PopularSearchService as ai, PopularityService as aj, type Product as ak, type ProductOption as al, ProductService as am, ProfileService as an, type Quote as ao, REDIRECT_GATEWAYS as ap, ReelsService as aq, RegionService as ar, type RejectedLine as as, type Review as at, type ReviewPage as au, ReviewService as av, type SearchDoc as aw, type SearchResult as ax, SearchService as ay, SettingService as az, type AppliedDiscount as b, toOrder as b$, blogService as b0, cartService as b1, categoryService as b2, chatService as b3, checkoutService as b4, collectionService as b5, contactService as b6, countryService as b7, couponService as b8, currencyExponent as b9, popularSearchService as bA, popularityService as bB, priceOf as bC, productImages as bD, productService as bE, profileService as bF, qs as bG, reelsService as bH, regionService as bI, reviewService as bJ, searchService as bK, setRequestHost as bL, settingService as bM, settingsService as bN, stateService as bO, staticStore as bP, storeForHost as bQ, storeService as bR, toCart as bS, toCartLine as bT, toCategory as bU, toCmsPage as bV, toCollection as bW, toEngineAddress as bX, toIdentityAddress as bY, toMajor as bZ, toMinor as b_, currencyService as ba, dealService as bb, demoRequestService as bc, emptyCart as bd, emptyPage as be, enquiryService as bf, faqService as bg, feedbackService as bh, fromEngineAddress as bi, fromIdentityAddress as bj, fromSearchDoc as bk, galleryService as bl, homeService as bm, initService as bn, layoutService as bo, mediaUrl as bp, meilisearchService as bq, menuService as br, minorToMajor as bs, newsletterService as bt, orderService as bu, ownDomain as bv, pageService as bw, paymentMethodService as bx, pluginService as by, pluginsService as bz, type Approval as c, toPage as c0, toProduct as c1, toRating as c2, toUser as c3, toVariant as c4, toVendor as c5, uploadService as c6, userService as c7, variantService as c8, varniCustomDesignService as c9, varniCustomProductService as ca, vendorService as cb, warrantyService as cc, wishlistService as cd, 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 { 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 };

package/dist/index.cjs

@@ -2761,9 +2761,25 @@ var faqService = new FaqService();
 var MEDIA_KEYS = /* @__PURE__ */ new Set(["image", "mobile_image", "poster", "video_file"]);
 var LayoutService = class extends BaseService {
   async getHomeLayout({ preview } = {}) {
+    return this.getPageLayout("home", { preview });
+  }
+  /**
+   * The template every product page is drawn in: the sections around the
+   * product's core (`main-product`). Null when none is published, so the
+   * product page draws exactly as it did before templates existed.
+   */
+  async getProductLayout({ preview } = {}) {
+    return this.getPageLayout("product", { preview });
+  }
+  /** The template every collection page is drawn in, around its grid (`main-collection`). */
+  async getCollectionLayout({ preview } = {}) {
+    return this.getPageLayout("collection", { preview });
+  }
+  /** Any arranged page by its key; null for none, as the three above. */
+  async getPageLayout(page, { preview } = {}) {
     let layout;
     try {
-      layout = await this.data("/x/layouts/home", {
+      layout = await this.data(`/x/layouts/${encodeURIComponent(page)}`, {
         query: { preview: preview?.trim() || void 0 }
       });
     } catch (err) {