@misiki/gocommerce-connector 0.15.0 → 0.19.0

package/README.md

@@ -142,6 +142,7 @@ down stays best-effort: the storefront renders from its static record.
 | 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` |
+| Google reviews | `/x/google-reviews/place` — `googleReviewService.place()`: the store's Google rating, rating count and up to five Google reviews with their authors' names, photos and profile links, read live on every call because Google's terms forbid keeping them (call it when the section is in view; each call is billed to the store's Google key). Null while ext/google-reviews or its `show_place` switch is off, when the place has no ratings, when the day's lookups are spent (429) or Google refuses (502). `/x/google-reviews/survey/{number}` — `googleReviewService.survey(number)`: Google Customer Reviews' opt-in fields, built by the engine from an order placed in this browser, read with its access token; null for any other order or while `customer_reviews` is off |
 | 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` |
@@ -152,9 +153,9 @@ down stays best-effort: the storefront renders from its static record.
 | product specs table | the product's category attribute answers |
 | attribute filters (`?attributes.color=Red`) | `/api/products?attr=color:Red` |
 | newsletter box | `/x/newsletter/subscribe` |
-| contact form, product enquiries | `/x/contact/messages` |
+| contact form, product enquiries | `/x/contact/messages`, with the form's hidden `website` honeypot passed on so the engine drops what a bot filled in |
 | 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 |
+| 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; for the contact page (D156), the address once the store shows it (as `address: { street, city, state, pincode, country }`), `mapLocation` and `openingHours` when set, `businessCountry` (the store's ISO country, for the phone's country code), the `whatsapp-chat` plugin's number as `plugins.whatsappChatButton`, and Google Customer Reviews (ext/google-reviews) as `plugins.googleReviewsOptIn` (`active` while the survey is on) and `plugins.googleStoreWidget` (`{ active, position: 'RIGHT_BOTTOM' \| 'LEFT_BOTTOM' }`, off without the survey) |
 | 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

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

@@ -418,6 +418,36 @@ type Plugin = {
     title: string;
     settings: Record<string, unknown>;
 };
+/** `GET /x/google-reviews/place` (ext/google-reviews): Google's answer just now, never stored. */
+type GooglePlace = {
+    rating: number;
+    user_rating_count: number;
+    google_maps_uri: string;
+    reviews: {
+        author: {
+            name: string;
+            uri?: string;
+            photo_uri?: string;
+        };
+        rating: number;
+        text?: string;
+        language?: string;
+        relative_time?: string;
+        publish_time?: string;
+        visit_date?: string;
+        google_maps_uri?: string;
+        flag_uri?: string;
+    }[];
+};
+/** `GET /x/google-reviews/survey/{number}`: Google Customer Reviews' opt-in fields, from the order. */
+type GoogleSurvey = {
+    merchant_id: number;
+    order_id: string;
+    email: string;
+    delivery_country: string;
+    estimated_delivery_date: string;
+    opt_in_style?: string;
+};
 /** `GET /api/store`: what anyone may read about the shop. */
 type StoreProfile = {
     name: string;
@@ -431,6 +461,29 @@ type StoreProfile = {
     logo_url?: string;
     logo_dark_url?: string;
     icon_url?: string;
+    /**
+     * For a contact page (D156); absent on an engine before it. The address is
+     * null unless the store chose to show it; the map location is a Google Maps
+     * link or "lat,long"; the hours are one range per open day, Monday first.
+     * The country (ISO alpha-2) is public on its own, for the phone's country code.
+     */
+    country?: string;
+    address?: {
+        line1: string;
+        line2: string;
+        city: string;
+        state: string;
+        postal_code: string;
+        country: string;
+    } | null;
+    map_location?: string;
+    opening_hours?: OpeningHours[];
+};
+/** When the shop is open on one day: `day` is mon…sun, the times 24-hour HH:MM. */
+type OpeningHours = {
+    day: string;
+    opens: string;
+    closes: string;
 };
 type Vendor = {
     id: number;
@@ -6127,6 +6180,60 @@ declare class ReviewService extends BaseService {
 }
 declare const reviewService: ReviewService;
 
+/** A Google review with what Google's attribution policy asks a storefront to show. */
+type GoogleReview = {
+    author: string;
+    /** The author's Google profile and photo; https or empty. */
+    authorUrl: string;
+    authorPhoto: string;
+    rating: number;
+    /** The reviewer's own words, in their language. Empty for a rating with no words. */
+    text: string;
+    language: string;
+    /** Google's own words for when, such as "a month ago". */
+    when: string;
+    /** YYYY-MM, when Google has one. */
+    visited: string;
+    /** The review on Google Maps, and where to report it to Google. */
+    url: string;
+    reportUrl: string;
+};
+type GoogleReviews = {
+    /** Google's own rating and count, never worked out from `reviews`. */
+    rating: number;
+    count: number;
+    /** Every review, on Google Maps: `reviews` are at most five of them. */
+    mapsUrl: string;
+    reviews: GoogleReview[];
+};
+/**
+ * The store's Google reviews and Google Customer Reviews (ext/google-reviews).
+ *
+ * Both calls answer null when there is nothing to show — the plugin or its
+ * switch off, Google refusing, the day's lookups spent — because each is an
+ * extra on a page that must render without it.
+ */
+declare class GoogleReviewService extends BaseService {
+    private readonly facts;
+    /**
+     * Google's rating and its most relevant reviews, read live. Google's terms
+     * forbid keeping them, so nothing here caches them either, and every call
+     * is one the store pays Google for: call it when the section is in view.
+     */
+    place(): Promise<GoogleReviews | null>;
+    /**
+     * What Google Customer Reviews' opt-in is rendered with, for an order placed
+     * in this browser: its access token is kept here, and nowhere else can ask.
+     * Every field is the order's own; the keys are Google's, to pass unchanged
+     * to `gapi.surveyoptin.render`.
+     */
+    survey(orderNumber: string): Promise<GoogleSurvey | null>;
+    private switchOn;
+    /** Off, used up for the day, or refused by Google: nothing to show. Anything else still throws. */
+    private orNull;
+}
+declare const googleReviewService: GoogleReviewService;
+
 type StorefrontMenu = {
     menuId: string;
     name: string;
@@ -6507,12 +6614,14 @@ declare const vendorService: VendorService;
 
 /** The storefront's contact form and product enquiries, through ext/contact's inbox. */
 declare class ContactService extends BaseService {
-    submitContactUsForm({ name, email, phone, message, subject, }: {
+    submitContactUsForm({ name, email, phone, message, subject, website, }: {
         name: string;
         email: string;
         phone?: string;
         message: string;
         subject?: string;
+        /** The form's hidden honeypot, passed on so the engine drops what a bot filled in. */
+        website?: string;
     }): Promise<{
         status: string;
     }>;
@@ -7584,4 +7693,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, 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 };
+export { type GoogleReviews 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 GooglePlace as Y, type GoogleReview as Z, GoogleReviewService as _, type Address as a, type StorefrontProduct as a$, type GoogleSurvey as a0, type HeaderSettings as a1, type HomeLayout as a2, type HomeLayoutSection as a3, HomeService as a4, type IdentityAddress as a5, InitService as a6, type Invitation as a7, type LayoutCollection as a8, type LayoutPage as a9, type ProductFacets as aA, type ProductOption as aB, ProductService as aC, ProfileService as aD, type Quote as aE, REDIRECT_GATEWAYS as aF, ReelsService as aG, RegionService as aH, type RejectedLine as aI, type Review as aJ, type ReviewPage as aK, ReviewService as aL, type SearchDoc as aM, type SearchResult as aN, SearchService as aO, SettingService as aP, type ShippingRate as aQ, type SiteChrome as aR, type SiteFooter as aS, type SiteHeader as aT, type SocialLink as aU, StateService as aV, type StoreProfile as aW, StoreService as aX, type StorefrontCategory as aY, type StorefrontMenu as aZ, type StorefrontOrder as a_, LayoutService as aa, type Lead as ab, type ListMeta as ac, MeilisearchService as ad, type Member as ae, type Menu as af, type MenuItem as ag, MenuService as ah, type MenuSummary as ai, type Money as aj, NewsletterService as ak, type Offer as al, type OpeningHours as am, type Order as an, type OrderLine as ao, OrderService as ap, type PageLayout as aq, PageService as ar, type PaymentIntent as as, PaymentMethodService as at, type Plugin as au, PluginService as av, PopularSearchService as aw, PopularityService as ax, type Postcode as ay, type Product as az, AddressService as b, profileService as b$, type ThemeSettings as b0, type ThemeSettingsResult as b1, UploadService as b2, UserService as b3, type Variant as b4, type VariantImage as b5, VariantService as b6, VarniCustomDesignService as b7, VarniCustomProductService as b8, type Vendor as b9, faqService as bA, feedbackService as bB, fromEngineAddress as bC, fromIdentityAddress as bD, fromSearchDoc as bE, galleryService as bF, googleReviewService as bG, homeService as bH, initService as bI, layoutService as bJ, mediaUrl as bK, meilisearchService as bL, menuService as bM, minorToMajor as bN, newsletterService as bO, orderService as bP, ownDomain as bQ, pageService as bR, paymentMethodService as bS, pluginService as bT, pluginsService as bU, popularSearchService as bV, popularityService as bW, priceOf as bX, productImages as bY, productService as bZ, productVideos as b_, VendorService as ba, WarrantyService as bb, type Wishlist as bc, type WishlistItem as bd, WishlistService as be, addressService as bf, authService as bg, autocompleteService as bh, b2bService as bi, bannerService as bj, blogService as bk, cartService as bl, categoryService as bm, chatService as bn, checkoutService as bo, collectionService as bp, contactService as bq, countryService as br, couponService as bs, currencyExponent as bt, currencyService as bu, dealService as bv, demoRequestService as bw, emptyCart as bx, emptyPage as by, enquiryService as bz, type AppliedDiscount as c, qs as c0, reelsService as c1, regionService as c2, reviewService as c3, searchService as c4, setRequestHost as c5, settingService as c6, settingsService as c7, stateService as c8, staticStore as c9, varniCustomProductService as cA, vendorService as cB, warrantyService as cC, wishlistService as cD, storeForHost as ca, storeService as cb, toAddOn as cc, toCart as cd, toCartLine as ce, toCartOffer as cf, toCategory as cg, toCmsPage as ch, toCollection as ci, toEngineAddress as cj, toFreeShipping as ck, toIdentityAddress as cl, toMajor as cm, toMinor as cn, toOrder as co, toPage as cp, toProduct as cq, toRating as cr, toStorefrontFacets as cs, toUser as ct, toVariant as cu, toVendor as cv, uploadService as cw, userService as cx, variantService as cy, varniCustomDesignService as cz, 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 };

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

@@ -418,6 +418,36 @@ type Plugin = {
     title: string;
     settings: Record<string, unknown>;
 };
+/** `GET /x/google-reviews/place` (ext/google-reviews): Google's answer just now, never stored. */
+type GooglePlace = {
+    rating: number;
+    user_rating_count: number;
+    google_maps_uri: string;
+    reviews: {
+        author: {
+            name: string;
+            uri?: string;
+            photo_uri?: string;
+        };
+        rating: number;
+        text?: string;
+        language?: string;
+        relative_time?: string;
+        publish_time?: string;
+        visit_date?: string;
+        google_maps_uri?: string;
+        flag_uri?: string;
+    }[];
+};
+/** `GET /x/google-reviews/survey/{number}`: Google Customer Reviews' opt-in fields, from the order. */
+type GoogleSurvey = {
+    merchant_id: number;
+    order_id: string;
+    email: string;
+    delivery_country: string;
+    estimated_delivery_date: string;
+    opt_in_style?: string;
+};
 /** `GET /api/store`: what anyone may read about the shop. */
 type StoreProfile = {
     name: string;
@@ -431,6 +461,29 @@ type StoreProfile = {
     logo_url?: string;
     logo_dark_url?: string;
     icon_url?: string;
+    /**
+     * For a contact page (D156); absent on an engine before it. The address is
+     * null unless the store chose to show it; the map location is a Google Maps
+     * link or "lat,long"; the hours are one range per open day, Monday first.
+     * The country (ISO alpha-2) is public on its own, for the phone's country code.
+     */
+    country?: string;
+    address?: {
+        line1: string;
+        line2: string;
+        city: string;
+        state: string;
+        postal_code: string;
+        country: string;
+    } | null;
+    map_location?: string;
+    opening_hours?: OpeningHours[];
+};
+/** When the shop is open on one day: `day` is mon…sun, the times 24-hour HH:MM. */
+type OpeningHours = {
+    day: string;
+    opens: string;
+    closes: string;
 };
 type Vendor = {
     id: number;
@@ -6127,6 +6180,60 @@ declare class ReviewService extends BaseService {
 }
 declare const reviewService: ReviewService;
 
+/** A Google review with what Google's attribution policy asks a storefront to show. */
+type GoogleReview = {
+    author: string;
+    /** The author's Google profile and photo; https or empty. */
+    authorUrl: string;
+    authorPhoto: string;
+    rating: number;
+    /** The reviewer's own words, in their language. Empty for a rating with no words. */
+    text: string;
+    language: string;
+    /** Google's own words for when, such as "a month ago". */
+    when: string;
+    /** YYYY-MM, when Google has one. */
+    visited: string;
+    /** The review on Google Maps, and where to report it to Google. */
+    url: string;
+    reportUrl: string;
+};
+type GoogleReviews = {
+    /** Google's own rating and count, never worked out from `reviews`. */
+    rating: number;
+    count: number;
+    /** Every review, on Google Maps: `reviews` are at most five of them. */
+    mapsUrl: string;
+    reviews: GoogleReview[];
+};
+/**
+ * The store's Google reviews and Google Customer Reviews (ext/google-reviews).
+ *
+ * Both calls answer null when there is nothing to show — the plugin or its
+ * switch off, Google refusing, the day's lookups spent — because each is an
+ * extra on a page that must render without it.
+ */
+declare class GoogleReviewService extends BaseService {
+    private readonly facts;
+    /**
+     * Google's rating and its most relevant reviews, read live. Google's terms
+     * forbid keeping them, so nothing here caches them either, and every call
+     * is one the store pays Google for: call it when the section is in view.
+     */
+    place(): Promise<GoogleReviews | null>;
+    /**
+     * What Google Customer Reviews' opt-in is rendered with, for an order placed
+     * in this browser: its access token is kept here, and nowhere else can ask.
+     * Every field is the order's own; the keys are Google's, to pass unchanged
+     * to `gapi.surveyoptin.render`.
+     */
+    survey(orderNumber: string): Promise<GoogleSurvey | null>;
+    private switchOn;
+    /** Off, used up for the day, or refused by Google: nothing to show. Anything else still throws. */
+    private orNull;
+}
+declare const googleReviewService: GoogleReviewService;
+
 type StorefrontMenu = {
     menuId: string;
     name: string;
@@ -6507,12 +6614,14 @@ declare const vendorService: VendorService;
 
 /** The storefront's contact form and product enquiries, through ext/contact's inbox. */
 declare class ContactService extends BaseService {
-    submitContactUsForm({ name, email, phone, message, subject, }: {
+    submitContactUsForm({ name, email, phone, message, subject, website, }: {
         name: string;
         email: string;
         phone?: string;
         message: string;
         subject?: string;
+        /** The form's hidden honeypot, passed on so the engine drops what a bot filled in. */
+        website?: string;
     }): Promise<{
         status: string;
     }>;
@@ -7584,4 +7693,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, 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 };
+export { type GoogleReviews 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 GooglePlace as Y, type GoogleReview as Z, GoogleReviewService as _, type Address as a, type StorefrontProduct as a$, type GoogleSurvey as a0, type HeaderSettings as a1, type HomeLayout as a2, type HomeLayoutSection as a3, HomeService as a4, type IdentityAddress as a5, InitService as a6, type Invitation as a7, type LayoutCollection as a8, type LayoutPage as a9, type ProductFacets as aA, type ProductOption as aB, ProductService as aC, ProfileService as aD, type Quote as aE, REDIRECT_GATEWAYS as aF, ReelsService as aG, RegionService as aH, type RejectedLine as aI, type Review as aJ, type ReviewPage as aK, ReviewService as aL, type SearchDoc as aM, type SearchResult as aN, SearchService as aO, SettingService as aP, type ShippingRate as aQ, type SiteChrome as aR, type SiteFooter as aS, type SiteHeader as aT, type SocialLink as aU, StateService as aV, type StoreProfile as aW, StoreService as aX, type StorefrontCategory as aY, type StorefrontMenu as aZ, type StorefrontOrder as a_, LayoutService as aa, type Lead as ab, type ListMeta as ac, MeilisearchService as ad, type Member as ae, type Menu as af, type MenuItem as ag, MenuService as ah, type MenuSummary as ai, type Money as aj, NewsletterService as ak, type Offer as al, type OpeningHours as am, type Order as an, type OrderLine as ao, OrderService as ap, type PageLayout as aq, PageService as ar, type PaymentIntent as as, PaymentMethodService as at, type Plugin as au, PluginService as av, PopularSearchService as aw, PopularityService as ax, type Postcode as ay, type Product as az, AddressService as b, profileService as b$, type ThemeSettings as b0, type ThemeSettingsResult as b1, UploadService as b2, UserService as b3, type Variant as b4, type VariantImage as b5, VariantService as b6, VarniCustomDesignService as b7, VarniCustomProductService as b8, type Vendor as b9, faqService as bA, feedbackService as bB, fromEngineAddress as bC, fromIdentityAddress as bD, fromSearchDoc as bE, galleryService as bF, googleReviewService as bG, homeService as bH, initService as bI, layoutService as bJ, mediaUrl as bK, meilisearchService as bL, menuService as bM, minorToMajor as bN, newsletterService as bO, orderService as bP, ownDomain as bQ, pageService as bR, paymentMethodService as bS, pluginService as bT, pluginsService as bU, popularSearchService as bV, popularityService as bW, priceOf as bX, productImages as bY, productService as bZ, productVideos as b_, VendorService as ba, WarrantyService as bb, type Wishlist as bc, type WishlistItem as bd, WishlistService as be, addressService as bf, authService as bg, autocompleteService as bh, b2bService as bi, bannerService as bj, blogService as bk, cartService as bl, categoryService as bm, chatService as bn, checkoutService as bo, collectionService as bp, contactService as bq, countryService as br, couponService as bs, currencyExponent as bt, currencyService as bu, dealService as bv, demoRequestService as bw, emptyCart as bx, emptyPage as by, enquiryService as bz, type AppliedDiscount as c, qs as c0, reelsService as c1, regionService as c2, reviewService as c3, searchService as c4, setRequestHost as c5, settingService as c6, settingsService as c7, stateService as c8, staticStore as c9, varniCustomProductService as cA, vendorService as cB, warrantyService as cC, wishlistService as cD, storeForHost as ca, storeService as cb, toAddOn as cc, toCart as cd, toCartLine as ce, toCartOffer as cf, toCategory as cg, toCmsPage as ch, toCollection as ci, toEngineAddress as cj, toFreeShipping as ck, toIdentityAddress as cl, toMajor as cm, toMinor as cn, toOrder as co, toPage as cp, toProduct as cq, toRating as cr, toStorefrontFacets as cs, toUser as ct, toVariant as cu, toVendor as cv, uploadService as cw, userService as cx, variantService as cy, varniCustomDesignService as cz, 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 };

package/dist/index.cjs

@@ -2873,6 +2873,71 @@ var ReviewService = class extends BaseService {
 };
 var reviewService = new ReviewService();
 
+// src/services/google-review-service.ts
+var PLUGIN = "google-reviews";
+var GoogleReviewService = class extends BaseService {
+  facts = new StoreFacts(this._fetch);
+  /**
+   * Google's rating and its most relevant reviews, read live. Google's terms
+   * forbid keeping them, so nothing here caches them either, and every call
+   * is one the store pays Google for: call it when the section is in view.
+   */
+  async place() {
+    if (!await this.switchOn("show_place")) return null;
+    const p = await this.orNull(() => this.data("/x/google-reviews/place"));
+    if (!p?.user_rating_count) return null;
+    return {
+      rating: p.rating,
+      count: p.user_rating_count,
+      mapsUrl: p.google_maps_uri ?? "",
+      reviews: (p.reviews ?? []).map((r) => ({
+        author: r.author?.name ?? "",
+        authorUrl: r.author?.uri ?? "",
+        authorPhoto: r.author?.photo_uri ?? "",
+        rating: r.rating,
+        text: r.text ?? "",
+        language: r.language ?? "",
+        when: r.relative_time ?? "",
+        visited: r.visit_date ?? "",
+        url: r.google_maps_uri ?? "",
+        reportUrl: r.flag_uri ?? ""
+      }))
+    };
+  }
+  /**
+   * What Google Customer Reviews' opt-in is rendered with, for an order placed
+   * in this browser: its access token is kept here, and nowhere else can ask.
+   * Every field is the order's own; the keys are Google's, to pass unchanged
+   * to `gapi.surveyoptin.render`.
+   */
+  async survey(orderNumber) {
+    const kept = orderNumber ? placedOrder(orderNumber) : void 0;
+    if (!kept || !await this.switchOn("customer_reviews")) return null;
+    return this.orNull(
+      () => this.data(`/x/google-reviews/survey/${encodeURIComponent(orderNumber)}`, {
+        query: { token: kept.token }
+      })
+    );
+  }
+  async switchOn(setting) {
+    try {
+      return (await this.facts.plugins()).get(PLUGIN)?.settings?.[setting] === true;
+    } catch {
+      return false;
+    }
+  }
+  /** Off, used up for the day, or refused by Google: nothing to show. Anything else still throws. */
+  async orNull(call) {
+    try {
+      return await call();
+    } catch (err) {
+      if (err instanceof GoCommerceError && [404, 429, 502].includes(err.status)) return null;
+      throw err;
+    }
+  }
+};
+var googleReviewService = new GoogleReviewService();
+
 // src/services/menu-service.ts
 function linkFor(item) {
   const t = item.target ?? "";
@@ -3049,6 +3114,21 @@ var StoreService = class extends BaseService {
       ...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) } : {},
+      // What the contact page shows (D156), only what the store published. The address
+      // in the shape the storefront's contact page and home-page JSON-LD already read. The
+      // country beside it, not over `country`: that is the address form's default country.
+      ...profile?.country ? { businessCountry: profile.country } : {},
+      ...profile?.address ? {
+        address: {
+          street: [profile.address.line1, profile.address.line2].filter(Boolean).join(", "),
+          city: profile.address.city,
+          state: profile.address.state,
+          pincode: profile.address.postal_code,
+          country: profile.address.country
+        }
+      } : {},
+      ...profile?.map_location ? { mapLocation: profile.map_location } : {},
+      ...profile?.opening_hours?.length ? { openingHours: profile.opening_hours } : {},
       currencyCode: code,
       currencySymbol: sameCurrency ? base.currencySymbol ?? symbolFor(code) : symbolFor(code),
       currency: {
@@ -3062,10 +3142,28 @@ var StoreService = class extends BaseService {
         // Features this connector serves from a module: on exactly when the
         // module is installed and switched on, whatever the static record says.
         isWishlist: { ...basePlugins.isWishlist, ...flag(plugins.has("wishlist")) },
+        // The corner button and the contact page's WhatsApp card read the number from
+        // here; the engine's plugin holds it, in international digits.
+        whatsappChatButton: {
+          ...basePlugins.whatsappChatButton,
+          ...flag(plugins.has("whatsapp-chat")),
+          ...plugins.has("whatsapp-chat") ? {
+            phone: String(plugins.get("whatsapp-chat")?.settings?.phone ?? ""),
+            message: String(plugins.get("whatsapp-chat")?.settings?.message ?? "")
+          } : {}
+        },
         isProductReviewsAndRatings: {
           ...basePlugins.isProductReviewsAndRatings,
           ...flag(plugins.has("product-reviews"))
         },
+        // Google Customer Reviews (ext/google-reviews): the confirmation page's survey offer,
+        // whose fields the engine builds from the order, and Google's store widget, which
+        // belongs to the same programme and so needs the survey on.
+        googleReviewsOptIn: {
+          ...basePlugins.googleReviewsOptIn,
+          ...flag(googleSetting(plugins, "customer_reviews") === true)
+        },
+        googleStoreWidget: storeWidget(plugins),
         // The footer's sign-up box posts to ext/newsletter, and the theme editor's footer
         // switch (D131) can only show it while that is on.
         newsletter: { ...basePlugins.newsletter, ...flag(plugins.has("newsletter")) },
@@ -3108,6 +3206,12 @@ function regionName(code) {
     return code;
   }
 }
+var googleSetting = (plugins, key) => plugins.get("google-reviews")?.settings?.[key];
+function storeWidget(plugins) {
+  const where = googleSetting(plugins, "store_widget");
+  if (googleSetting(plugins, "customer_reviews") !== true || !where) return { active: false };
+  return { active: true, position: where === "Bottom left" ? "LEFT_BOTTOM" : "RIGHT_BOTTOM" };
+}
 var LOGIN_TYPES = { phone_otp: "PHONE", email_or_phone: "BOTH", email_password: "EMAIL" };
 
 // src/services/page-service.ts
@@ -3288,7 +3392,8 @@ var ContactService = class extends BaseService {
     email,
     phone,
     message,
-    subject
+    subject,
+    website
   }) {
     return this.data("/x/contact/messages", {
       method: "POST",
@@ -3297,7 +3402,8 @@ var ContactService = class extends BaseService {
         email: String(email ?? ""),
         ...phone ? { phone: String(phone) } : {},
         ...subject ? { subject: String(subject) } : {},
-        body: String(message ?? "")
+        body: String(message ?? ""),
+        ...website ? { website: String(website) } : {}
       }
     });
   }
@@ -3812,6 +3918,7 @@ exports.FaqService = FaqService;
 exports.FeedbackService = FeedbackService;
 exports.GalleryService = GalleryService;
 exports.GoCommerceError = GoCommerceError;
+exports.GoogleReviewService = GoogleReviewService;
 exports.HomeService = HomeService;
 exports.InitService = InitService;
 exports.LayoutService = LayoutService;
@@ -3874,6 +3981,7 @@ exports.fromEngineAddress = fromEngineAddress;
 exports.fromIdentityAddress = fromIdentityAddress;
 exports.fromSearchDoc = fromSearchDoc;
 exports.galleryService = galleryService;
+exports.googleReviewService = googleReviewService;
 exports.hasStaticStore = hasStaticStore;
 exports.homeService = homeService;
 exports.initService = initService;