@misiki/gocommerce-connector 0.28.0 → 0.30.0

package/dist/{index-BaFtBtaA.d.ts → index-BdXhbm20.d.ts}

@@ -297,6 +297,8 @@ type CartOffer = {
     free_shipping?: boolean;
     remaining?: Money;
     reason?: string;
+    /** Checkout applies it by itself when no code is typed (D179); absent on an engine before it. */
+    auto_apply?: boolean;
 };
 /** How far a basket is from free delivery (D133). */
 type FreeShipping = {
@@ -423,6 +425,24 @@ type CheckoutOptions = {
     }[];
     currency: string;
 };
+/** What checkout would charge for a cart now, placing nothing (D185). */
+type CheckoutQuote = {
+    subtotal: Money;
+    shipping: Money;
+    shipping_method?: string;
+    /** The code checkout took off; `auto_applied` when the shopper typed none and checkout chose it (D179). */
+    discount: {
+        code: string;
+        title: string;
+        auto_applied: boolean;
+        amount: Money;
+        free_shipping?: boolean;
+    } | null;
+    tax: Money;
+    tax_inclusive: boolean;
+    payment_fee: Money;
+    total: Money;
+};
 type ShippingRate = {
     rate_id: number;
     name: string;
@@ -594,6 +614,11 @@ type OpeningHours = {
     opens: string;
     closes: string;
 };
+/** `POST /api/store/password` (D170): a closed store's pass, from its password or a pass still good. */
+type StorePassAnswer = {
+    token: string;
+    expires_at: string;
+};
 type Vendor = {
     id: number;
     slug: string;
@@ -1453,6 +1478,27 @@ declare function toCartOffer(o: CartOffer, currency: string): {
     amount: number | null;
     remaining: number | null;
     reason: string;
+    autoApply: boolean;
+};
+/**
+ * A checkout quote under the names `toOrder` gives the order it becomes, so a
+ * page shows the two the same way.
+ */
+declare function toCheckoutQuote(q: CheckoutQuote): {
+    subtotal: number;
+    shippingCharges: number;
+    shippingMethod: string | null;
+    discount: number;
+    coupon: {
+        code: string;
+        title: string;
+        autoApplied: boolean;
+        freeShipping: boolean;
+    } | null;
+    tax: number;
+    taxIncluded: boolean;
+    codCharges: number;
+    total: number;
 };
 declare function toFreeShipping(f: FreeShipping): {
     qualifies: boolean;
@@ -2469,13 +2515,19 @@ declare class ProductService extends CatalogService {
 }
 declare const productService: ProductService;
 
+type RailCategory = {
+    name: string;
+    slug: string;
+    count: number;
+    depth: number;
+};
 /**
  * The engine's counts in the shape the storefront's filter rail reads. Each
  * `allFilters` key is also the URL parameter the rail writes when a value is
  * ticked, and `searchWithUrl` reads it back: `vendor`, `product_type` and
  * `attributes.<handle>`. Tags go to the rail's own tag group, written as `tags`.
  */
-declare function toStorefrontFacets(f?: ProductFacets | null): {
+declare function toStorefrontFacets(f?: ProductFacets | null, tree?: Category[]): {
     priceStat: {
         min: number;
         max: number;
@@ -2483,11 +2535,7 @@ declare function toStorefrontFacets(f?: ProductFacets | null): {
         min?: undefined;
         max?: undefined;
     };
-    categories: {
-        name: string;
-        slug: string;
-        count: number;
-    }[];
+    categories: RailCategory[];
     tags: {
         name: string;
         count: number;
@@ -2520,11 +2568,7 @@ declare class SearchService extends CatalogService {
                 min?: undefined;
                 max?: undefined;
             };
-            categories: {
-                name: string;
-                slug: string;
-                count: number;
-            }[];
+            categories: RailCategory[];
             tags: {
                 name: string;
                 count: number;
@@ -2548,11 +2592,7 @@ declare class SearchService extends CatalogService {
                 min?: undefined;
                 max?: undefined;
             };
-            categories: {
-                name: string;
-                slug: string;
-                count: number;
-            }[];
+            categories: RailCategory[];
             tags: {
                 name: string;
                 count: number;
@@ -2719,11 +2759,7 @@ declare class SearchService extends CatalogService {
                 min?: undefined;
                 max?: undefined;
             };
-            categories: {
-                name: string;
-                slug: string;
-                count: number;
-            }[];
+            categories: RailCategory[];
             tags: {
                 name: string;
                 count: number;
@@ -3866,6 +3902,7 @@ declare class CartService extends BaseService {
         amount: number | null;
         remaining: number | null;
         reason: string;
+        autoApply: boolean;
     }[]>;
     /**
      * How far the bag is from free delivery (D133), read from the store's own
@@ -4628,6 +4665,7 @@ declare const customizerService: CustomizerService;
  * the order page shows `payment_status` once the webhook has landed.
  */
 declare class CheckoutService extends BaseService {
+    private expected;
     /** Delivery options for the address on the cart: `{ data: [{ id, name, base_rate }] }`. */
     getShippingRates({ cartId }?: {
         cartId?: string;
@@ -4854,6 +4892,45 @@ declare class CheckoutService extends BaseService {
         }[];
         currency: string;
     }>;
+    /**
+     * What checkout would charge for the cart now, by the storefront's method
+     * code (`COD`, `RAZORPAY`, `PAYPAL`) or none yet (D185). Null until the
+     * address step has stored an address, and null from an engine before D185.
+     *
+     * A refusal is checkout's own: the same GoCommerceError, with the same
+     * message, that placing the order would raise now.
+     */
+    getQuote({ cartId, method }?: {
+        cartId?: string;
+        method?: string;
+    }): Promise<{
+        subtotal: number;
+        shippingCharges: number;
+        shippingMethod: string | null;
+        discount: number;
+        coupon: {
+            code: string;
+            title: string;
+            autoApplied: boolean;
+            freeShipping: boolean;
+        } | null;
+        tax: number;
+        taxIncluded: boolean;
+        codCharges: number;
+        total: number;
+    } | null>;
+    /**
+     * The total on screen as the shopper confirms, from getQuote, or null when nothing was quoted
+     * (D185). Every order placed for the cart then carries it, and checkout refuses one whose own
+     * total differs instead of charging it: `onChange` gets checkout's figures now and the sentence
+     * the placing call fails with.
+     */
+    expectTotal({ cartId, total, onChange, }: {
+        cartId?: string;
+        total?: number | null;
+        onChange?: Expected['onChange'];
+    }): void;
+    private storedCheckout;
     private redirectGateway;
     /**
      * One checkout attempt.
@@ -4869,6 +4946,10 @@ declare class CheckoutService extends BaseService {
 }
 /** The engine's gateways that take payment on their own hosted page. */
 declare const REDIRECT_GATEWAYS: Set<string>;
+type Expected = {
+    total: number;
+    onChange?: (quote: ReturnType<typeof toCheckoutQuote>, message: string) => void;
+};
 declare const checkoutService: CheckoutService;
 
 declare class PaymentMethodService extends BaseService {
@@ -4903,8 +4984,9 @@ declare const paymentMethodService: PaymentMethodService;
  * `cartService.applyCoupon`.
  *
  * The drawer's shape: `amount` is the percentage or the amount,
- * `minAmount` the bag it needs, and `description` says what is
- * still missing.
+ * `minAmount` the bag it needs, `description` says what is
+ * still missing, and `autoApply` marks a code checkout applies by
+ * itself (D179).
  */
 declare class CouponService extends BaseService {
     listCoupons(_args?: Record<string, unknown>): Promise<{
@@ -4918,6 +5000,7 @@ declare class CouponService extends BaseService {
             description: string;
             applies: boolean;
             remaining: number | null;
+            autoApply: boolean;
         }[];
         count: number;
         pageSize: number;
@@ -6559,9 +6642,11 @@ declare class StoreService extends BaseService {
         storeId?: string;
         domain?: string;
     }): Promise<{
+        closed: StoreClosed | undefined;
         id: any;
     }>;
     getStore(storeId?: string): Promise<{
+        closed: StoreClosed | undefined;
         id: any;
     }>;
     /**
@@ -6578,9 +6663,39 @@ declare class StoreService extends BaseService {
      * that list lives here.
      */
     post<T = any>(path: string, data?: unknown): Promise<T>;
+    /**
+     * A closed store's password (D170), traded for a pass. Never throws. The
+     * engine allows 20 tries an hour per client, and sees this server as the
+     * client unless `clientAddress`, the shopper's, travels as `X-Forwarded-For`.
+     */
+    unlockStore(password: string, { clientAddress }?: {
+        clientAddress?: string;
+    }): Promise<StoreUnlock>;
+    /**
+     * A pass checked without spending a try: the pass, or null when it is wrong,
+     * expired, ended by a new password, or the store takes none now. Throws when
+     * the engine cannot say.
+     */
+    checkStorePass(token: string): Promise<StorePass | null>;
+    private storePass;
     private live;
 }
 declare const storeService: StoreService;
+/** A store its owner closed (D170): the message to show, and whether a password lets a visitor in. */
+type StoreClosed = {
+    message: string;
+    password: boolean;
+};
+type StorePass = {
+    token: string;
+    expiresAt: Date;
+};
+type StoreUnlock = {
+    outcome: 'unlocked';
+    pass: StorePass;
+} | {
+    outcome: 'wrong' | 'throttled' | 'open' | 'unavailable';
+};
 
 /**
  * Content pages from ext/cms, in the shopper's language with the store's
@@ -6673,6 +6788,7 @@ type LayoutCollection = {
     slug: string;
     link: string;
     image: string | null;
+    description: string | null;
 };
 /**
  * One section of a composed page. `settings` is the merchant's, as validated
@@ -6918,21 +7034,26 @@ declare class PluginService extends BaseService {
 /** The store record again, for the callers that ask for it as "settings" or "init". */
 declare class SettingService extends BaseService {
     fetchSettings(_args?: Record<string, unknown>): Promise<{
+        closed: StoreClosed | undefined;
         id: any;
     }>;
     list(args?: Record<string, unknown>): Promise<{
+        closed: StoreClosed | undefined;
         id: any;
     }>;
 }
 declare class InitService extends SettingService {
     fetchInit(_args?: Record<string, unknown>): Promise<{
         storeOne: {
+            closed: StoreClosed | undefined;
             id: any;
         };
         store: {
+            closed: StoreClosed | undefined;
             id: any;
         };
         settings: {
+            closed: StoreClosed | undefined;
             id: any;
         };
     }>;
@@ -8009,4 +8130,4 @@ declare class B2bService extends BaseService {
 }
 declare const b2bService: B2bService;
 
-export { FaqService 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, type CustomizerDesign as L, type CustomizerDocument as M, type CustomizerEditor as N, type CustomizerFile as O, type CustomizerLayer as P, type CustomizerSavedDesign as Q, CustomizerService as R, type CustomizerSetup as S, type CustomizerUpload as T, DealService as U, DemoRequestService as V, type EngineRequest as W, EnquiryService as X, type Envelope as Y, type FacetValue as Z, type Faq as _, type Address as a, type SiteFooter as a$, FeedbackService as a0, type FooterSettings as a1, type FreeShipping as a2, type Fulfillment as a3, GalleryService as a4, type GooglePlace as a5, type GoogleReview as a6, GoogleReviewService as a7, type GoogleReviews as a8, type GoogleSurvey as a9, PageService as aA, type PaymentIntent as aB, PaymentMethodService as aC, type Plugin as aD, PluginService as aE, PopularSearchService as aF, PopularityService as aG, type Postcode as aH, type Product as aI, type ProductFacets as aJ, type ProductOption as aK, ProductService as aL, ProfileService as aM, type Quote as aN, REDIRECT_GATEWAYS as aO, ReelsService as aP, RegionService as aQ, type RejectedLine as aR, type Review as aS, type ReviewPage as aT, ReviewService as aU, type SearchDoc as aV, type SearchResult as aW, SearchService as aX, SettingService as aY, type ShippingRate as aZ, type SiteChrome as a_, type HeaderSettings as aa, type HomeLayout as ab, type HomeLayoutSection as ac, HomeService as ad, type IdentityAddress as ae, InitService as af, type Invitation as ag, type LayoutCollection as ah, type LayoutPage as ai, LayoutService as aj, type Lead as ak, type ListMeta as al, MeilisearchService as am, type Member as an, type Menu as ao, type MenuItem as ap, MenuService as aq, type MenuSummary as ar, type Money as as, NewsletterService as at, type Offer as au, type OpeningHours as av, type Order as aw, type OrderLine as ax, OrderService as ay, type PageLayout as az, AddressService as b, newsletterService as b$, type SiteHeader as b0, type SocialLink as b1, StateService as b2, type StoreProfile as b3, StoreService as b4, type StorefrontCategory as b5, type StorefrontMenu as b6, type StorefrontOrder as b7, type StorefrontProduct as b8, type ThemeSettings as b9, checkoutService as bA, collectionService as bB, contactService as bC, countryService as bD, couponService as bE, currencyExponent as bF, currencyService as bG, customizerService as bH, dealService as bI, demoRequestService as bJ, emptyCart as bK, emptyPage as bL, enquiryService as bM, faqService as bN, feedbackService as bO, fromEngineAddress as bP, fromIdentityAddress as bQ, fromSearchDoc as bR, galleryService as bS, googleReviewService as bT, homeService as bU, initService as bV, layoutService as bW, mediaUrl as bX, meilisearchService as bY, menuService as bZ, minorToMajor as b_, type ThemeSettingsResult as ba, UploadService as bb, UserService as bc, type Variant as bd, type VariantImage as be, VariantService as bf, VarniCustomDesignService as bg, VarniCustomProductService as bh, type Vendor as bi, VendorService as bj, WarrantyService as bk, type WhatsappConsent as bl, type WhatsappConsentOffer as bm, WhatsappService as bn, type Wishlist as bo, type WishlistItem as bp, WishlistService as bq, addressService as br, authService as bs, autocompleteService as bt, b2bService as bu, bannerService as bv, blogService as bw, cartService as bx, categoryService as by, chatService as bz, type AppliedDiscount as c, orderService as c0, ownDomain as c1, pageService as c2, paymentMethodService as c3, pluginService as c4, pluginsService as c5, popularSearchService as c6, popularityService as c7, priceOf as c8, productImages as c9, toMinor as cA, toOrder as cB, toPage as cC, toProduct as cD, toRating as cE, toStorefrontFacets as cF, toUser as cG, toVariant as cH, toVendor as cI, uploadService as cJ, userService as cK, variantService as cL, varniCustomDesignService as cM, varniCustomProductService as cN, vendorService as cO, warrantyService as cP, whatsappService as cQ, wishlistService as cR, productService as ca, productVideos as cb, profileService as cc, qs as cd, reelsService as ce, regionService as cf, reviewService as cg, searchService as ch, setRequestHost as ci, settingService as cj, settingsService as ck, stateService as cl, staticStore as cm, storeForHost as cn, storeService as co, toAddOn as cp, toCart as cq, toCartLine as cr, toCartOffer as cs, toCategory as ct, toCmsPage as cu, toCollection as cv, toEngineAddress as cw, toFreeShipping as cx, toIdentityAddress as cy, toMajor 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 };
+export { type Faq as $, type AddOn as A, type B2bPlaced as B, type Cart as C, type Company as D, type CompanyOrder as E, ContactService as F, CountryService as G, CouponService as H, type Credentials as I, type Credit as J, CurrencyService as K, type Customer as L, type CustomizerDesign as M, type CustomizerDocument as N, type CustomizerEditor as O, type CustomizerFile as P, type CustomizerLayer as Q, type CustomizerSavedDesign as R, CustomizerService as S, type CustomizerSetup as T, type CustomizerUpload as U, DealService as V, DemoRequestService as W, type EngineRequest as X, EnquiryService as Y, type Envelope as Z, type FacetValue as _, type Address as a, type SiteChrome as a$, FaqService as a0, FeedbackService as a1, type FooterSettings as a2, type FreeShipping as a3, type Fulfillment as a4, GalleryService as a5, type GooglePlace as a6, type GoogleReview as a7, GoogleReviewService as a8, type GoogleReviews as a9, type PageLayout as aA, PageService as aB, type PaymentIntent as aC, PaymentMethodService as aD, type Plugin as aE, PluginService as aF, PopularSearchService as aG, PopularityService as aH, type Postcode as aI, type Product as aJ, type ProductFacets 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 ShippingRate as a_, type GoogleSurvey as aa, type HeaderSettings as ab, type HomeLayout as ac, type HomeLayoutSection as ad, HomeService as ae, type IdentityAddress as af, InitService as ag, type Invitation as ah, type LayoutCollection as ai, type LayoutPage as aj, LayoutService as ak, type Lead as al, type ListMeta as am, MeilisearchService as an, type Member as ao, type Menu as ap, type MenuItem as aq, MenuService as ar, type MenuSummary as as, type Money as at, NewsletterService as au, type Offer as av, type OpeningHours as aw, type Order as ax, type OrderLine as ay, OrderService as az, AddressService as b, layoutService as b$, type SiteFooter as b0, type SiteHeader as b1, type SocialLink as b2, StateService as b3, type StoreClosed as b4, type StorePass as b5, type StorePassAnswer as b6, type StoreProfile as b7, StoreService as b8, type StoreUnlock as b9, bannerService as bA, blogService as bB, cartService as bC, categoryService as bD, chatService as bE, checkoutService as bF, collectionService as bG, contactService as bH, countryService as bI, couponService as bJ, currencyExponent as bK, currencyService as bL, customizerService as bM, dealService as bN, demoRequestService as bO, emptyCart as bP, emptyPage as bQ, enquiryService as bR, faqService as bS, feedbackService as bT, fromEngineAddress as bU, fromIdentityAddress as bV, fromSearchDoc as bW, galleryService as bX, googleReviewService as bY, homeService as bZ, initService as b_, type StorefrontCategory as ba, type StorefrontMenu as bb, type StorefrontOrder as bc, type StorefrontProduct as bd, type ThemeSettings as be, type ThemeSettingsResult as bf, UploadService as bg, UserService as bh, type Variant as bi, type VariantImage as bj, VariantService as bk, VarniCustomDesignService as bl, VarniCustomProductService as bm, type Vendor as bn, VendorService as bo, WarrantyService as bp, type WhatsappConsent as bq, type WhatsappConsentOffer as br, WhatsappService as bs, type Wishlist as bt, type WishlistItem as bu, WishlistService as bv, addressService as bw, authService as bx, autocompleteService as by, b2bService as bz, type AppliedDiscount as c, mediaUrl as c0, meilisearchService as c1, menuService as c2, minorToMajor as c3, newsletterService as c4, orderService as c5, ownDomain as c6, pageService as c7, paymentMethodService as c8, pluginService 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, whatsappService as cW, wishlistService as cX, pluginsService as ca, popularSearchService as cb, popularityService as cc, priceOf as cd, productImages as ce, productService as cf, productVideos as cg, profileService as ch, qs as ci, reelsService as cj, regionService as ck, reviewService as cl, searchService as cm, setRequestHost as cn, settingService as co, settingsService as cp, stateService as cq, staticStore as cr, storeForHost as cs, storeService as ct, toAddOn as cu, toCart as cv, toCartLine as cw, toCartOffer as cx, toCategory as cy, toCheckoutQuote 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 CheckoutQuote as u, type CheckoutResult as v, CheckoutService as w, type CmsPage as x, type Collection as y, CollectionService as z };