@misiki/gocommerce-connector 0.11.0 → 0.12.0

package/dist/{index-90wdO5MM.d.ts → index-Bu4bVBBm.d.ts}

@@ -250,6 +250,51 @@ type CartLine = {
     available: number;
     in_stock: boolean;
     price_changed: boolean;
+    /** The add-on this line was bought as (D133), and the product it is offered with. */
+    add_on_id?: number;
+    add_on_for?: number;
+    compare_at_price?: Money;
+};
+/** A variant offered with a product, optionally at an offer price (D133). */
+type AddOn = {
+    id: number;
+    product_id: number;
+    variant_id: number;
+    position: number;
+    offer_price: Money | null;
+    price: Money;
+    compare_at_price?: Money;
+    item: {
+        product_id: number;
+        slug: string;
+        title: string;
+        variant_label?: string;
+        sku: string;
+        image_url?: string;
+        live: boolean;
+        in_stock: boolean;
+    };
+};
+/** A listed discount code, judged against one basket (D133). */
+type CartOffer = {
+    code: string;
+    title: string;
+    kind: 'percentage' | 'fixed' | 'free_shipping' | string;
+    value_bp?: number;
+    value_minor?: number;
+    min_subtotal_minor?: number;
+    applies: boolean;
+    amount?: Money;
+    free_shipping?: boolean;
+    remaining?: Money;
+    reason?: string;
+};
+/** How far a basket is from free delivery (D133). */
+type FreeShipping = {
+    qualifies: boolean;
+    threshold?: Money;
+    remaining?: Money;
+    subtotal: Money;
 };
 type Cart = {
     id: string;
@@ -886,6 +931,9 @@ declare function toCartLine(l: CartLine, extra?: {
     qty: number;
     price: number;
     mrp: number;
+    /** The add-on this line was bought as (D133), or null on an ordinary line. */
+    addOnId: string | null;
+    addOnFor: string | null;
     subtotal: number;
     total: number;
     inStock: boolean;
@@ -934,6 +982,9 @@ declare function toCart(c: Cart, extras?: CartExtras, lineExtra?: (l: CartLine)
         qty: number;
         price: number;
         mrp: number;
+        /** The add-on this line was bought as (D133), or null on an ordinary line. */
+        addOnId: string | null;
+        addOnFor: string | null;
         subtotal: number;
         total: number;
         inStock: boolean;
@@ -1162,6 +1213,45 @@ declare function toUser(c: Customer): {
     updatedAt: string;
 };
 declare const priceOf: (m: Money | undefined) => number;
+/**
+ * An add-on as the buy box draws it (D133): `price` is what ticking it adds,
+ * the offer where there is one, and `regularPrice` the add-on's own, struck
+ * through beside it. Without an offer the two are the same and nothing is
+ * struck.
+ */
+declare function toAddOn(a: AddOn): {
+    id: string;
+    productId: string;
+    variantId: string;
+    slug: string;
+    title: string;
+    variantTitle: string;
+    thumbnail: string | null;
+    price: number;
+    regularPrice: number;
+    hasOffer: boolean;
+    inStock: boolean;
+};
+/** A listed code for one basket, in major units (D133). */
+declare function toCartOffer(o: CartOffer, currency: string): {
+    code: string;
+    title: string;
+    isPercent: boolean;
+    freeShipping: boolean;
+    /** The percentage for a percentage code, the amount for a fixed one. */
+    value: number;
+    minAmount: number | null;
+    applies: boolean;
+    amount: number | null;
+    remaining: number | null;
+    reason: string;
+};
+declare function toFreeShipping(f: FreeShipping): {
+    qualifies: boolean;
+    threshold: number | null;
+    remaining: number | null;
+    subtotal: number;
+};
 
 type Query = Record<string, string | number | boolean | null | undefined | (string | number)[]>;
 type EngineRequest = {
@@ -1970,6 +2060,142 @@ declare class ProductService extends CatalogService {
         noOfPage: number;
         page: number;
     }>;
+    /**
+     * What the shop offers with a product, ticked in its buy box (D133): each
+     * add-on at the price ticking it adds. Only add-ons that can be bought
+     * arrive; an engine without the route offers none.
+     */
+    listAddOns({ product }: {
+        product: string;
+    }): Promise<{
+        id: string;
+        productId: string;
+        variantId: string;
+        slug: string;
+        title: string;
+        variantTitle: string;
+        thumbnail: string | null;
+        price: number;
+        regularPrice: number;
+        hasOffer: boolean;
+        inStock: boolean;
+    }[]>;
+    /**
+     * "You may also like": the products the shop chose for this one, at their
+     * own prices (D133). Curated only, and empty when none were chosen: the
+     * related products already fill in from the category, and the page should
+     * not draw the same fill twice.
+     */
+    listCrossSells({ product, limit }: {
+        product: string;
+        limit?: number;
+    }): Promise<{
+        id: string;
+        slug: string;
+        title: string;
+        name: string;
+        subtitle: null;
+        description: string;
+        status: string;
+        active: boolean;
+        type: string;
+        currency: string;
+        currencyCode: string;
+        price: number;
+        mrp: number;
+        minPrice: number;
+        maxPrice: number;
+        sku: string;
+        barcode: string | null;
+        weight: number | null;
+        originCountry: string | null;
+        thumbnail: string;
+        image_url: string;
+        images: string;
+        imageList: string[];
+        manageInventory: boolean;
+        allowBackorder: boolean;
+        stock: number;
+        hasStock: boolean;
+        categoryId: string | null;
+        category: {
+            id: string;
+            name: string;
+            slug: string;
+        } | null;
+        categories: {
+            category: {
+                id: string;
+                name: string;
+                slug: string;
+            };
+        }[];
+        categoryHierarchy: {
+            name: string;
+            slug: string;
+        }[];
+        collections: {
+            id: string;
+            name: string;
+            slug: string;
+        }[];
+        vendor: {
+            businessName: string;
+        } | null;
+        productTags: string;
+        keywords: string;
+        metaTitle: string;
+        metaDescription: string | null;
+        link: string;
+        options: {
+            id: string;
+            title: string;
+            name: string;
+            type: string;
+            values: {
+                id: string;
+                value: string;
+            }[];
+        }[];
+        variants: {
+            id: string;
+            productId: string;
+            title: string;
+            sku: string;
+            barcode: string | null;
+            price: number;
+            mrp: number;
+            stock: number;
+            manageInventory: boolean;
+            allowBackorder: boolean;
+            active: boolean;
+            weight: number | null;
+            length: number | null;
+            width: number | null;
+            height: number | null;
+            images: string;
+            img: string;
+            image: string;
+            thumbnail: string;
+            options: {
+                optionId: string;
+                value: string;
+            }[];
+            metadata: Record<string, unknown> | null;
+        }[];
+        ratings: ReturnType<typeof toRating>[];
+        rating: number | null;
+        ratingCount: number;
+        reviewCount: number;
+        attributes: {
+            name: string;
+            value: string;
+            handle: string;
+        }[];
+        metadata: Record<string, unknown> | null;
+        createdAt: string;
+        updatedAt: string;
+    }[]>;
     private relatedTo;
     private shelf;
     /**
@@ -2916,6 +3142,8 @@ declare class CartService extends BaseService {
             qty: number;
             price: number;
             mrp: number;
+            addOnId: string | null;
+            addOnFor: string | null;
             subtotal: number;
             total: number;
             inStock: boolean;
@@ -3000,6 +3228,8 @@ declare class CartService extends BaseService {
             qty: number;
             price: number;
             mrp: number;
+            addOnId: string | null;
+            addOnFor: string | null;
             subtotal: number;
             total: number;
             inStock: boolean;
@@ -3089,6 +3319,8 @@ declare class CartService extends BaseService {
             qty: number;
             price: number;
             mrp: number;
+            addOnId: string | null;
+            addOnFor: string | null;
             subtotal: number;
             total: number;
             inStock: boolean;
@@ -3183,6 +3415,8 @@ declare class CartService extends BaseService {
             qty: number;
             price: number;
             mrp: number;
+            addOnId: string | null;
+            addOnFor: string | null;
             subtotal: number;
             total: number;
             inStock: boolean;
@@ -3248,6 +3482,127 @@ declare class CartService extends BaseService {
         billingAddress: null;
         billingAddressId: null;
     }>;
+    /**
+     * Adds an add-on from a product's "Complete the set" (D133) at its offer
+     * price. The product it is offered with has to be in the bag already, so
+     * this is called after adding it; the engine refuses one too many with the
+     * sentence the shopper is shown.
+     */
+    addAddOn({ cartId, addOnId, qty }: {
+        cartId?: string | null;
+        addOnId: string | number;
+        qty?: number;
+    }): Promise<{
+        id: string;
+        status: "open" | "converted" | "abandoned";
+        email: string | null;
+        phone: string | null;
+        name: string | null;
+        lineItems: {
+            id: string;
+            productId: string;
+            variantId: string;
+            sku: string;
+            title: string;
+            name: string;
+            slug: string;
+            thumbnail: string | null;
+            variantTitle: string;
+            qty: number;
+            price: number;
+            mrp: number;
+            addOnId: string | null;
+            addOnFor: string | null;
+            subtotal: number;
+            total: number;
+            inStock: boolean;
+            priceChanged: boolean;
+            currentPrice: number;
+            isSelectedForCheckout: boolean;
+            variant: {
+                id: string;
+                options: {
+                    option: {
+                        title: string;
+                    };
+                    value: string;
+                }[];
+            };
+            product: {
+                id: string;
+                categories: unknown[];
+            };
+        }[];
+        qty: number;
+        currencyCode: string;
+        currency: string;
+        subtotal: number;
+        discountAmount: number;
+        savingAmount: number;
+        couponCode: string | null;
+        discount: AppliedDiscount | null;
+        shippingCharges: number;
+        shippingRateId: string | null;
+        shippingMethod: string | null;
+        tax: number;
+        taxIncluded: boolean;
+        codCharges: number;
+        total: number;
+        shippingAddress: StorefrontAddress | null;
+        shippingAddressId: string | null;
+        billingAddress: StorefrontAddress | null;
+        billingAddressId: string | null;
+        paymentMethod: null;
+        needAddress: boolean;
+        completedAt: string | null;
+        createdAt: string;
+        updatedAt: string;
+        expiresAt: string;
+    }>;
+    /**
+     * The codes the shop chose to show (D133), each with what it takes off this
+     * bag or how much more the bag needs. None without a bag.
+     */
+    getOffers({ cartId }?: {
+        cartId?: string | null;
+    }): Promise<{
+        code: string;
+        title: string;
+        isPercent: boolean;
+        freeShipping: boolean;
+        value: number;
+        minAmount: number | null;
+        applies: boolean;
+        amount: number | null;
+        remaining: number | null;
+        reason: string;
+    }[]>;
+    /**
+     * How far the bag is from free delivery (D133), read from the store's own
+     * rates for the country (the store's own when none is given). Null when
+     * the engine cannot say: a bar with a made-up figure is worse than none.
+     */
+    getFreeShipping({ cartId, country, state }?: {
+        cartId?: string | null;
+        country?: string;
+        state?: string;
+    }): Promise<{
+        qualifies: boolean;
+        threshold: number | null;
+        remaining: number | null;
+        subtotal: number;
+    } | null>;
+    /**
+     * "You may be interested in" (D133): what the bag's products suggest, less
+     * what it holds; with nothing curated, the first product's related
+     * products, still less what it holds.
+     */
+    listCrossSells({ cartId, limit }?: {
+        cartId?: string | null;
+        limit?: number;
+    }): Promise<{
+        id: string;
+    }[]>;
     /** `qty` is the new total; 0 takes the line out. */
     updateCart({ cartId, lineId, qty, }: {
         cartId?: string;
@@ -3273,6 +3628,8 @@ declare class CartService extends BaseService {
             qty: number;
             price: number;
             mrp: number;
+            addOnId: string | null;
+            addOnFor: string | null;
             subtotal: number;
             total: number;
             inStock: boolean;
@@ -3360,6 +3717,8 @@ declare class CartService extends BaseService {
             qty: number;
             price: number;
             mrp: number;
+            addOnId: string | null;
+            addOnFor: string | null;
             subtotal: number;
             total: number;
             inStock: boolean;
@@ -3456,6 +3815,8 @@ declare class CartService extends BaseService {
             qty: number;
             price: number;
             mrp: number;
+            addOnId: string | null;
+            addOnFor: string | null;
             subtotal: number;
             total: number;
             inStock: boolean;
@@ -3548,6 +3909,8 @@ declare class CartService extends BaseService {
             qty: number;
             price: number;
             mrp: number;
+            addOnId: string | null;
+            addOnFor: string | null;
             subtotal: number;
             total: number;
             inStock: boolean;
@@ -3613,6 +3976,8 @@ declare class CartService extends BaseService {
             qty: number;
             price: number;
             mrp: number;
+            addOnId: string | null;
+            addOnFor: string | null;
             subtotal: number;
             total: number;
             inStock: boolean;
@@ -3701,6 +4066,8 @@ declare class CartService extends BaseService {
             qty: number;
             price: number;
             mrp: number;
+            addOnId: string | null;
+            addOnFor: string | null;
             subtotal: number;
             total: number;
             inStock: boolean;
@@ -3789,6 +4156,8 @@ declare class CartService extends BaseService {
             qty: number;
             price: number;
             mrp: number;
+            addOnId: string | null;
+            addOnFor: string | null;
             subtotal: number;
             total: number;
             inStock: boolean;
@@ -4144,14 +4513,29 @@ declare class PaymentMethodService extends BaseService {
 declare const paymentMethodService: PaymentMethodService;
 
 /**
- * Discount codes are typed, not browsed: the engine has no public list of
- * them, by design — a list would hand every shopper every code. An empty list
- * hides the storefront's coupon drawer, and the code box still works through
+ * Discount codes are typed, not browsed, except the ones the shop chose to
+ * show (D133): the engine lists a code only when the shop ticked "Show in the
+ * basket's offers", judged against the stored bag. Every other code stays
+ * known only to whoever was given it, and still works through
  * `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.
  */
 declare class CouponService extends BaseService {
     listCoupons(_args?: Record<string, unknown>): Promise<{
-        data: never[];
+        data: {
+            id: string;
+            code: string;
+            title: string;
+            isPercent: boolean;
+            amount: number;
+            minAmount: number | null;
+            description: string;
+            applies: boolean;
+            remaining: number | null;
+        }[];
         count: number;
         pageSize: number;
         noOfPage: number;
@@ -6790,6 +7174,8 @@ declare class B2bService extends BaseService {
                 qty: number;
                 price: number;
                 mrp: number;
+                addOnId: string | null;
+                addOnFor: string | null;
                 subtotal: number;
                 total: number;
                 inStock: boolean;
@@ -6859,6 +7245,8 @@ declare class B2bService extends BaseService {
                 qty: number;
                 price: number;
                 mrp: number;
+                addOnId: string | null;
+                addOnFor: string | null;
                 subtotal: number;
                 total: number;
                 inStock: boolean;
@@ -7094,4 +7482,4 @@ declare class B2bService extends BaseService {
 }
 declare const b2bService: B2bService;
 
-export { type Invitation 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 FacetValue as O, type Faq as P, FaqService as Q, FeedbackService as R, type FooterSettings as S, type Fulfillment as T, GalleryService as U, type HeaderSettings as V, type HomeLayout as W, type HomeLayoutSection as X, HomeService as Y, type IdentityAddress as Z, InitService as _, AddressService as a, type Vendor as a$, type LayoutCollection as a0, type LayoutPage as a1, LayoutService as a2, type Lead as a3, type ListMeta as a4, MeilisearchService as a5, type Member as a6, type Menu as a7, type MenuItem as a8, MenuService as a9, type ReviewPage as aA, ReviewService as aB, type SearchDoc as aC, type SearchResult as aD, SearchService as aE, SettingService as aF, type ShippingRate as aG, type SiteChrome as aH, type SiteFooter as aI, type SiteHeader as aJ, type SocialLink as aK, StateService as aL, type StoreProfile as aM, StoreService as aN, type StorefrontCategory as aO, type StorefrontMenu as aP, type StorefrontOrder as aQ, type StorefrontProduct as aR, type ThemeSettings as aS, type ThemeSettingsResult as aT, UploadService as aU, UserService as aV, type Variant as aW, type VariantImage as aX, VariantService as aY, VarniCustomDesignService as aZ, VarniCustomProductService as a_, type MenuSummary as aa, type Money as ab, NewsletterService as ac, type Offer as ad, type Order as ae, type OrderLine as af, OrderService as ag, type PageLayout as ah, PageService as ai, type PaymentIntent as aj, PaymentMethodService as ak, type Plugin as al, PluginService as am, PopularSearchService as an, PopularityService as ao, type Product as ap, type ProductFacets as aq, type ProductOption as ar, ProductService as as, ProfileService as at, type Quote as au, REDIRECT_GATEWAYS as av, ReelsService as aw, RegionService as ax, type RejectedLine as ay, type Review as az, type AppliedDiscount as b, storeService as b$, VendorService as b0, WarrantyService as b1, type Wishlist as b2, type WishlistItem as b3, WishlistService as b4, addressService as b5, authService as b6, autocompleteService as b7, b2bService as b8, bannerService as b9, meilisearchService as bA, menuService as bB, minorToMajor as bC, newsletterService as bD, orderService as bE, ownDomain as bF, pageService as bG, paymentMethodService as bH, pluginService as bI, pluginsService as bJ, popularSearchService as bK, popularityService as bL, priceOf as bM, productImages as bN, productService as bO, profileService as bP, qs as bQ, reelsService as bR, regionService as bS, reviewService as bT, searchService as bU, setRequestHost as bV, settingService as bW, settingsService as bX, stateService as bY, staticStore as bZ, storeForHost as b_, blogService as ba, cartService as bb, categoryService as bc, chatService as bd, checkoutService as be, collectionService as bf, contactService as bg, countryService as bh, couponService as bi, currencyExponent as bj, currencyService as bk, dealService as bl, demoRequestService as bm, emptyCart as bn, emptyPage as bo, enquiryService as bp, faqService as bq, feedbackService as br, fromEngineAddress as bs, fromIdentityAddress as bt, fromSearchDoc as bu, galleryService as bv, homeService as bw, initService as bx, layoutService as by, mediaUrl as bz, type Approval as c, toCart as c0, toCartLine as c1, toCategory as c2, toCmsPage as c3, toCollection as c4, toEngineAddress as c5, toIdentityAddress as c6, toMajor as c7, toMinor as c8, toOrder as c9, toPage as ca, toProduct as cb, toRating as cc, toStorefrontFacets as cd, toUser as ce, toVariant as cf, toVendor as cg, uploadService as ch, userService as ci, variantService as cj, varniCustomDesignService as ck, varniCustomProductService as cl, vendorService as cm, warrantyService as cn, wishlistService as co, 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 { 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, VariantService 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, RegionService as aA, type RejectedLine as aB, type Review as aC, type ReviewPage as aD, ReviewService as aE, type SearchDoc as aF, type SearchResult as aG, SearchService as aH, SettingService as aI, type ShippingRate as aJ, type SiteChrome as aK, type SiteFooter as aL, type SiteHeader as aM, type SocialLink as aN, StateService as aO, type StoreProfile as aP, StoreService as aQ, type StorefrontCategory as aR, type StorefrontMenu as aS, type StorefrontOrder as aT, type StorefrontProduct as aU, type ThemeSettings as aV, type ThemeSettingsResult as aW, UploadService as aX, UserService as aY, type Variant as aZ, type VariantImage 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 Product as as, type ProductFacets as at, type ProductOption as au, ProductService as av, ProfileService as aw, type Quote as ax, REDIRECT_GATEWAYS as ay, ReelsService as az, AddressService as b, stateService as b$, VarniCustomDesignService as b0, VarniCustomProductService as b1, type Vendor as b2, VendorService as b3, WarrantyService as b4, type Wishlist as b5, type WishlistItem as b6, WishlistService as b7, addressService as b8, authService as b9, initService as bA, layoutService as bB, mediaUrl as bC, meilisearchService as bD, menuService as bE, minorToMajor as bF, newsletterService as bG, orderService as bH, ownDomain as bI, pageService as bJ, paymentMethodService as bK, pluginService as bL, pluginsService as bM, popularSearchService as bN, popularityService as bO, priceOf as bP, productImages as bQ, productService as bR, profileService as bS, qs as bT, reelsService as bU, regionService as bV, reviewService as bW, searchService as bX, setRequestHost as bY, settingService as bZ, settingsService as b_, autocompleteService as ba, b2bService as bb, bannerService as bc, blogService as bd, cartService as be, categoryService as bf, chatService as bg, checkoutService as bh, collectionService as bi, contactService as bj, countryService as bk, couponService as bl, currencyExponent as bm, currencyService as bn, dealService as bo, demoRequestService as bp, emptyCart as bq, emptyPage as br, enquiryService as bs, faqService as bt, feedbackService as bu, fromEngineAddress as bv, fromIdentityAddress as bw, fromSearchDoc as bx, galleryService as by, homeService as bz, type AppliedDiscount as c, staticStore as c0, storeForHost as c1, storeService as c2, toAddOn as c3, toCart as c4, toCartLine as c5, toCartOffer as c6, toCategory as c7, toCmsPage as c8, toCollection as c9, toEngineAddress as ca, toFreeShipping as cb, toIdentityAddress as cc, toMajor as cd, toMinor as ce, toOrder as cf, toPage as cg, toProduct as ch, toRating as ci, toStorefrontFacets as cj, toUser as ck, toVariant as cl, toVendor as cm, uploadService as cn, userService as co, variantService as cp, varniCustomDesignService as cq, varniCustomProductService as cr, vendorService as cs, warrantyService as ct, wishlistService as cu, 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 };