@artisan-commerce/shopping-cart-core 0.12.0-canary.73

package/dist/bundle.d.ts

@@ -0,0 +1,873 @@
+import * as _artisan_commerce_types from '@artisan-commerce/types';
+import { Wallet, Vendor, ShippingCost, ProductDetails, ShoppingCart, CartProduct, Account, Store, PriceCategoryType, Product, Benefit, CartProductAnswer, CartProductQuestion, AdditionalInfo, CartStore, StoreCoupon, StoreCouponDetail, Alert } from '@artisan-commerce/types';
+
+/**
+ * Representation of different user wallets.
+ *
+ * @interface Wallets
+ * @since 0.1.0
+ * @property {WalletInternal} [key: string] Object where its key is a string
+ * and its value is a {@link WalletInternal}
+ */
+interface Wallets {
+    [key: string]: WalletInternal;
+}
+/**
+ * Wallet internal attributes.
+ *
+ * @interface WalletInternal
+ * @since 0.1.0
+ * @extends {{@link Wallet}
+ */
+interface WalletInternal extends Wallet {
+    /**
+     * The callback function that provides real time connection to the
+     * artisn database
+     */
+    onSnapshot: (wallet: Wallet) => void;
+}
+/**
+ * Configuration object for benefits wallet.
+ *
+ * @interface BenefitsWalletConfig
+ * @since 0.1.0
+ */
+interface BenefitsWalletConfig extends ShoppingCartConfig {
+    /** The provided vendor id */
+    vendorId?: Vendor["id"];
+    apiURL: string;
+}
+/**
+ * Apply benefit configuration attributes.
+ *
+ * @interface ApplyBenefitConfig
+ * @since 0.1.0
+ * @extends {{@link BenefitsWalletConfig}
+ */
+interface ApplyBenefitConfig extends BenefitsWalletConfig {
+    /** The id ot fhe benefit to apply */
+    benefitId: number;
+    /** The store shipping cost, used to apply a `ALTER_DELIVERY` benefit */
+    shippingCost: ShippingCost | null;
+    /** Location latitude of the user, used to apply a `ALTER_DELIVERY` benefit */
+    latitude?: number;
+    /** Location longitude of the user, used to apply a `ALTER_DELIVERY` benefit */
+    longitude?: number;
+    /** The product to be applied as benefit, used to apply a `PRODUCT` benefit */
+    product?: ProductDetails;
+    /**
+     * The configuration of the benefit of type product,
+     * used to apply a `PRODUCT` benefit
+     */
+    productConfig?: ProductActionConfig;
+    /** The customer unique identifier used to apply a `DISCOUNT` benefit */
+    customerId?: string;
+    /** The shoppingCart unique identifier used as a request body */
+    shoppingCartId?: ShoppingCart["id"];
+}
+/**
+ * Remove benefit configuration attributes.
+ *
+ * @interface RemoveBenefitConfig
+ * @since 0.1.0
+ * @extends {{@link BenefitsWalletConfig}
+ */
+interface RemoveBenefitConfig extends BenefitsWalletConfig {
+    /** The id ot fhe benefit to remove */
+    benefitId: number;
+    /** The store shipping cost, used to remove a `ALTER_DELIVERY` benefit */
+    shippingCost: ShippingCost | null;
+    /** The product to be applied as benefit, used to remove a `PRODUCT` benefit */
+    product?: CartProduct;
+    /** The configuration of the product, used to remove a `PRODUCT` benefit */
+    productConfig?: ProductRemoveConfig;
+}
+/**
+ * The allowed headers to fetch the users wallet.
+ *
+ * @typedef WalletHeaders
+ * @since 0.1.0
+ */
+declare type WalletHeaders = Headers & {
+    uid: string;
+};
+
+declare class ActionQueue {
+    private queue;
+    constructor();
+    get length(): number;
+    enqueue(newItem: () => Promise<ShoppingCart | null>): void;
+    dequeue(): (() => Promise<ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> | null>) | undefined;
+}
+
+declare class EventLoop {
+    private running;
+    constructor();
+    private run;
+    get isRunning(): boolean;
+    start(): Promise<void>;
+}
+
+/**
+ * Current state of the library.
+ *
+ * @interface GlobalState
+ * @since 0.1.0
+ */
+interface GlobalState {
+    /**  The provided account id of the application */
+    accountId?: ShoppingCartConfig["accountId"];
+    /** The provided customer id of the user */
+    customerId?: ShoppingCartConfig["customerId"];
+    /** The provided store information */
+    store?: ShoppingCartConfig["store"];
+    /** The name of the currently shopping cart in use */
+    activeShoppingCart: string;
+    /**
+     * The maximum number of shopping carts that an application is allowed
+     * to create
+     */
+    maxShoppingCarts: number;
+    /** An array of wallets that a shopping cart can initiate */
+    wallets: Wallets;
+    /**
+     * The attribute that indicates if a cart must be created like
+     * anonymous or not
+     */
+    anonymous?: boolean;
+    /** Indicates whether or not the cart has been initialized */
+    initialized: boolean;
+    /** The queue of actions to be called one after the other has resolved */
+    queue: ActionQueue;
+    /** The event loop of actions to be ran */
+    eventLoop: EventLoop;
+    /** Show debug messages */
+    debug?: boolean;
+}
+/**
+ * Configuration object that can be applied globally or at function level.
+ *
+ * @interface ShoppingCartConfig
+ * @since 0.1.0
+ */
+interface ShoppingCartConfig {
+    /** The provided account id of the application */
+    accountId?: Account["accountId"];
+    /** The provided customer id of the user */
+    customerId?: number | string;
+    /** The provided store information */
+    store?: Store;
+    /** The provided name of the shopping cart */
+    shoppingCartName?: string;
+    /** The max number of shopping carts an application is allowed to create */
+    maxShoppingCarts?: number;
+    /**
+     * The attribute that indicates if a cart must be created as anonymous or not
+     */
+    anonymous?: boolean;
+    /** Show debug messages */
+    debug?: boolean;
+}
+/**
+ * Configuration object to create a shopping cart.
+ *
+ * @interface ProductActionConfig
+ * @since 0.1.0
+ * @extends {{@link ShoppingCartConfig}
+ */
+interface ShoppingCartCreateConfig extends ShoppingCartConfig {
+    /** The id of the sales channel of the shopping cart */
+    channelId?: number;
+}
+/**
+ * Configuration object to make an action on the shopping cart.
+ *
+ * @interface ProductActionConfig
+ * @since 0.1.0
+ * @extends {{@link ShoppingCartConfig}
+ */
+interface ProductActionConfig extends ShoppingCartConfig {
+    /** The amount of products to be added */
+    amount: number;
+    /** The price category associated with the product */
+    priceCategory?: PriceCategoryType;
+    /** The comment associated with the product */
+    comment?: string;
+}
+/**
+ * Configuration object to add a product from the shopping cart.
+ *
+ * @interface ProductAddConfig
+ * @since 0.1.0
+ * @extends {{@link ProductActionConfig}
+ */
+interface ProductAddConfig extends ProductActionConfig {
+    /** If no cart is found it first creates a shopping cart */
+    createCart?: boolean | Partial<ShoppingCart>;
+}
+/**
+ * Configuration object to remove a product from the shopping cart.
+ *
+ * @interface ProductRemoveConfig
+ * @since 0.1.0
+ * @extends {{@link ShoppingCartConfig}
+ */
+interface ProductRemoveConfig extends ShoppingCartConfig {
+}
+/**
+ * Configuration object to set a product on the shopping cart.
+ *
+ * @interface ProductSetConfig
+ * @since 0.1.0
+ * @extends {{@link ProductActionConfig}
+ */
+interface ProductSetConfig extends Omit<ProductActionConfig, "amount"> {
+    /** The amount of products to be set */
+    amount?: number;
+}
+/**
+ * Configuration object to replace a product from the shopping cart.
+ *
+ * @interface ProductReplaceConfig
+ * @since 0.1.0
+ * @extends {{@link ProductActionConfig}
+ */
+interface ProductReplaceConfig extends ProductActionConfig {
+    /** The hash of product to be replaced */
+    hash?: string;
+}
+/**
+ * Representation of a shopping cart totals.
+ *
+ * @interface ShoppingCartTotals
+ * @since 0.1.0
+ */
+interface ShoppingCartTotals$1 {
+    /** Cart subtotal without taxes */
+    subtotal: number;
+    /** Cart discounts total */
+    totalDiscounts: number | null;
+    /** Cart taxes total */
+    totalTaxes: number | null;
+    /** Cart shipping cost total */
+    shippingCost: number | null;
+    /** Cart points total */
+    totalPoints: number | null;
+    /** Cart total with taxes */
+    total: number;
+}
+/**
+ * Configuration object to find a product in a shopping cart. Inherits the
+ * shopping cart configuration omitting `anonymous` and
+ * `maxShoppingCarts` properties
+ *
+ * @interface FindProductConfig
+ * @since 0.1.0
+ * @extends {{@link ShoppingCartConfig}
+ */
+interface FindProductConfig extends Omit<ShoppingCartConfig, "anonymous" | "maxShoppingCarts"> {
+    /** Product unique identifier */
+    productId?: Product["productId"];
+    /** Product hash */
+    hash?: string;
+}
+/**
+ * Configuration object to empty the shopping cart.
+ *
+ * @interface FindProductConfig
+ * @since 0.1.0
+ * @extends {{@link ShoppingCartConfig}
+ */
+interface EmptyShoppingCartConfig extends ShoppingCartConfig {
+    /** The vendor's unique identifier */
+    vendorId?: Vendor["id"];
+}
+interface SettingsHeaders {
+    token: string;
+    platform: string;
+    accountId: string;
+}
+interface DocumentNode {
+    [key: string]: any;
+}
+interface SetDoc {
+    reusedConfig?: ProductAddConfig | ProductRemoveConfig;
+    shoppingCartNode?: ShoppingCartNode;
+    payload: any;
+}
+interface DeleteDoc {
+    reusedConfig?: ProductAddConfig | ProductRemoveConfig;
+    shoppingCartNode?: ShoppingCartNode;
+}
+interface Metadata {
+    hasPendingWrites: boolean;
+    fromCache: boolean;
+    isEqual(other: Metadata): boolean;
+}
+declare type ServerTimestamps = "estimate" | "previous" | "none";
+interface SnapshotOptions {
+    serverTimestamps: ServerTimestamps;
+}
+interface ShoppingCartNode {
+    id: string;
+    metadata: Metadata;
+    data: (options?: Record<string, any>) => Record<string, any>;
+    get: (fieldPath: string, options?: SnapshotOptions) => any;
+    ref: any;
+    exists: any;
+}
+interface ShoppingCartBuilders {
+    getShoppingCartNode: (config: ShoppingCartConfig | undefined) => Promise<ShoppingCartNode | undefined>;
+    setDoc?: (config: SetDoc) => Promise<void>;
+    deleteDoc?: (config: DeleteDoc) => Promise<void>;
+    createShoppingCart?: (reusedConfig: ProductAddConfig | ShoppingCartCreateConfig, overrides: Partial<ShoppingCart> | undefined) => Promise<any>;
+    applyBenefitsToCart?: (config: ApplyBenefitConfig, benefit: Benefit, shippingCost?: ShippingCost) => Promise<void>;
+    getWallet?: (config?: ShoppingCartConfig | undefined) => Promise<Benefit[] | undefined>;
+    removeBenefitsFromCart?: (config: RemoveBenefitConfig, benefit: Benefit, shippingCost?: ShippingCost) => Promise<void>;
+    removeProduct?: (product: Product, config: ProductRemoveConfig | undefined) => Promise<any>;
+}
+interface BenefitsBuilders {
+    getBenefitsCollection?: (collectionName: string, ...path: string[]) => Promise<any>;
+    getBenefitsDocuments?: (collectionReference: any) => Promise<any>;
+}
+
+/**
+ * Initialize shopping cart metadata, stores initial global state
+ * for future needs and establishes connection with artisnDB.
+ *
+ * @since 0.1.0
+ * @param {ShoppingCartConfig} config Global shopping cart state that can
+ * be configure at the function call level
+ */
+declare const initShoppingCart: (config?: ShoppingCartConfig) => void;
+/**
+ * Closes all connections and resets the library to its default state.
+ *
+ * @since 0.1.0
+ */
+declare const closeShoppingCart: () => void;
+
+/**
+ * Fetches a shopping cart of the given customer and account, given by the
+ * specified name. It will first try to look at the function config.
+ * If it cannot find any of the needed parameters, it will look into the global
+ * config provided in initShoppingCart.
+ *
+ * @template T Shopping cart generic type
+ * @since 0.1.0
+ * @param name The name of the wanted shopping cart, if none is given it will
+ * use the default shopping cart name to find one
+ * @param config Function call level shopping cart configuration
+ * @returns The shopping cart of a given customer given by its specified name
+ */
+declare const getShoppingCart: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(builders: ShoppingCartBuilders, config?: ShoppingCartConfig) => Promise<T | null>;
+
+/**
+ * Adds a product amount async to the remote shopping cart.
+ *
+ * @template T Shopping cart generic type
+ * @since 0.1.0
+ * @param {Product} product The product object that will be added to the cart.
+ * It can be a BaseProduct, a DetailedProduct or a CartProduct.
+ * @param {ProductAddConfig} config A configuration that specifies how to
+ * make an action over a product. E.g specify the amount.
+ */
+declare const addProduct: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(builders: ShoppingCartBuilders, product: Product, config: ProductAddConfig) => Promise<T | null>;
+declare const addProductToCartHelper: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(shoppingCart: T, product: Product, config: ProductAddConfig) => T;
+
+/**
+ * Subtracts a product amount async to the remote shopping cart.
+ *
+ * @template T Shopping cart generic type
+ * @since 0.1.0
+ * @param {Product} product The product object that will be subtracted from the
+ * cart. It can be a BaseProduct, a DetailedProduct or a CartProduct
+ * @param {ProductActionConfig} config A configuration that specifies how to
+ * make an action over a product. E.g specify the amount
+ */
+declare const subtractProduct: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(builders: ShoppingCartBuilders, product: Product, config: ProductActionConfig) => Promise<T | null>;
+
+/**
+ * Removes a product async from the remote shopping cart
+ *
+ * @template T Shopping cart generic type
+ * @since 0.1.0
+ * @param {Product} product the product object that will be removed from the
+ * cart. It can be a BaseProduct, a DetailedProduct or a CartProduct
+ * @param {ProductRemoveConfig} config global configuration overrides. E.g
+ * storeId
+ */
+declare const removeProduct: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(builders: ShoppingCartBuilders, product: Product, config?: ProductRemoveConfig) => Promise<T | null>;
+
+/**
+ * Sets a product async in the remote shopping cart
+ *
+ * @template T Shopping cart generic type
+ * @since 0.1.0
+ * @param {Product} product The product object that will be set in the cart. It
+ * can be a BaseProduct, a DetailedProduct or a CartProduct
+ * @param {ProductSetConfig} config A configuration that specifies how to make
+ * an action over a product. E.g specify the amount
+ */
+declare const setProduct: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(builders: ShoppingCartBuilders, product: Product, config?: ProductSetConfig) => Promise<T | null>;
+
+/**
+ * Replaces an existing product async in the remote shopping cart
+ *
+ * @template T Shopping cart generic type
+ * @since 0.1.0
+ * @param {CartProduct} product The product object that will be replaced in the
+ * cart. It can only be a CartProduct
+ * @param {ProductReplaceConfig} config A configuration that specifies how to
+ * make an action over a product. E.g specify the store
+ */
+declare const replaceProduct: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(builders: ShoppingCartBuilders, product: CartProduct, config: ProductReplaceConfig) => Promise<T | null>;
+
+declare const buildInitialShoppingCart: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(overrides?: Partial<T>) => ShoppingCart;
+
+/**
+ * Removes all products in all stores of a given cart. It will attempt to delete
+ * the last active shopping cart otherwise the default.
+ *
+ * If a vendor identifier is specified in the configuration object, it will
+ * remove all stores that have the specified vendor.
+ *
+ * @template T Shopping cart generic type
+ * @since 0.1.0
+ * @param {ShoppingCartConfig} config Empty shopping cart configuration
+ */
+declare const emptyShoppingCart: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(builders: ShoppingCartBuilders, config?: EmptyShoppingCartConfig) => Promise<T | null>;
+
+/**
+ * Deletes a customer shopping cart given by its name. It will attempt to delete
+ * the last active shopping cart otherwise the default.
+ *
+ * @template T Shopping cart generic type
+ * @since 0.1.0
+ * @param {ShoppingCartConfig} config Function call level shopping cart
+ * configuration
+ */
+declare const deleteShoppingCart: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(builders: ShoppingCartBuilders, config?: ShoppingCartConfig) => Promise<T | null>;
+
+interface ShoppingCartTotals {
+    subtotal: number;
+    totalDiscounts: number | null;
+    totalTaxes: number | null;
+    shippingCost: number | null;
+    totalPoints: number | null;
+    total: number;
+}
+interface ShoppingCartTotalsConfig {
+    shippingCost?: ShippingCost;
+}
+
+declare const getProductHash: (product: CartProduct | CartProductAnswer) => string;
+declare const pruneQuestionsAndAnswers: <T extends CartProductQuestion<AdditionalInfo> = CartProductQuestion<AdditionalInfo>>(questions: T[]) => T[];
+/**
+ * Calculate the given shopping cart total values
+ *
+ * @since 0.1.0
+ * @param products the products in the shopping cart
+ * @param config additional info to calculate shopping cart summary
+ * @returns an object with a summary of the shopping cart totals
+ */
+declare const getShoppingCartTotal: (shoppingCart: ShoppingCart, config?: ShoppingCartTotalsConfig) => ShoppingCartTotals;
+declare const getShoppingCartProducts: <T extends AdditionalInfo = AdditionalInfo, U extends AdditionalInfo = AdditionalInfo>(shoppingCart: ShoppingCart<AdditionalInfo, T, U, AdditionalInfo, AdditionalInfo, AdditionalInfo, AdditionalInfo>, storeId?: Store["storeId"]) => CartProduct<T, U>[];
+/**
+ * Returns the specified product based on its id or hash if it exists on the
+ * active shopping cart. If both are provided, the hash takes precedence
+ * over the product id.
+ *
+ * @param {FindProductConfig} config Configuration provided to find the
+ * desired product
+ * @returns {Promise<Product|undefined>} The product if found in the
+ * shopping cart
+ */
+declare const findProduct: <T extends AdditionalInfo = AdditionalInfo, U extends AdditionalInfo = AdditionalInfo>(builders: ShoppingCartBuilders, config: FindProductConfig) => Promise<CartProduct<T, U> | undefined>;
+
+/**
+ * Shopping cart validation options.
+ *
+ * @interface ValidateConfig
+ * @since 0.1.0
+ */
+interface ValidateConfig extends ShoppingCartConfig {
+    /** Location latitude of the user */
+    latitude?: number;
+    /** Location latitude of the user */
+    longitude?: number;
+    /** Artisn project api url */
+    apiURL?: string;
+}
+
+/**
+ * Validate shopping cart integrity.
+ *
+ * @since 0.1.0
+ * @param {ValidateConfig} config Object that defines the properties to check
+ * whether the shopping cart is valid.
+ * @param {Partial<Headers>} headers The shopping cart that will be
+ * validated. If none provided, then it will use default as its name.
+ * @return {Promise<ValidateShoppingCartResult | undefined>} An object which
+ * contains stores and products alerts
+ */
+declare const validateShoppingCart$1: (builders: ShoppingCartBuilders, config: ValidateConfig | undefined, headers: Headers) => Promise<ValidateShoppingCartResult | undefined>;
+
+/**
+ * Close firestore connection.
+ *
+ * @since 0.1.0
+ * @param {string} selectedName The user's shopping cart name
+ * @param {Function} unsubscribe Reference to firestore node.
+ */
+declare const unsubscriber: (shoppingCartName: string, unsubscribe?: () => void) => void;
+
+/**
+ * Apply a benefit with the given configuration on the current shopping cart.
+ *
+ * @since 0.1.0
+ * @param {ApplyBenefitConfig} config Benefits wallet configuration and
+ * @param {Headers} headers Supported headers to pass to the endpoint
+ * parameters to be passed to apply in shopping cart
+ */
+declare const applyBenefit: (builders: ShoppingCartBuilders, config: ApplyBenefitConfig, headers: Headers) => Promise<void>;
+/**
+ * Helper apply a benefit provided to benefits array in shopping cart.
+ *
+ * @since 0.1.0
+ * @param {ShoppingCart} shoppingCart User's shopping cart
+ * @param {Benefit} benefit Benefit object to be applied
+ * @param {ShippingCost} shippingCost ShippingCost object to be added
+ * in shopping cart
+ * @returns {ShoppingCart} A shopping cart with the benefits applied
+ */
+declare const applyBenefitsHelper: (shoppingCart: ShoppingCart, benefit: Benefit, shippingCost?: ShippingCost) => ShoppingCart;
+
+/**
+ * Remove a benefit with the given config on the current shopping cart.
+ *
+ * @since 0.1.0
+ * @param {RemoveBenefitConfig} config Benefits wallet configuration and
+ * parameters to be passed to remove in shopping cart
+ */
+declare const removeBenefit: (builders: ShoppingCartBuilders, config: RemoveBenefitConfig) => Promise<void>;
+/**
+ * Helper to find and remove a benefit provided from benefits array
+ * in the shopping cart.
+ *
+ * @since 0.1.0
+ * @param {ShoppingCart} shoppingCart User's shopping cart
+ * @param {Benefit} benefit Benefit object to be removed
+ * @param {ShippingCost} shippingCost ShippingCost object to be restored
+ * in shopping cart
+ * @returns {ShoppingCart} Returns an updated shopping cart
+ */
+declare const removeBenefitsHelper: (shoppingCart: ShoppingCart, benefit: Benefit, shippingCost?: ShippingCost) => ShoppingCart;
+
+/**
+ * Redeems a coupon based on the code given.
+ *
+ * @since 0.1.0
+ * @param {BenefitsWalletConfig} config Benefits wallet configuration parameters
+ * to be passed to call the endpoint.
+ * @param {string} code The code that the user inputs on the app.
+ * @param {Partial<WalletHeaders>} headers Headers to be passed to call the
+ * endpoint, as a default header, the uid is fetched internally
+ */
+declare const redeemCoupon: (builders: ShoppingCartBuilders, config: BenefitsWalletConfig, code: string, headers: Headers) => Promise<void>;
+
+/**
+ * Merge a shopping cart to the current shopping cart or to the one specified
+ * through the configuration.
+ *
+ * @template T Shopping cart generic type
+ * @since 0.1.0
+ * @param {ShoppingCart} shoppingCart Shopping cart to be merged
+ * @param {ShoppingCartConfig} config Configuration to get the current shopping
+ * cart
+ */
+declare const mergeShoppingCart: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(builders: ShoppingCartBuilders, shoppingCart: T, config?: ShoppingCartConfig) => Promise<T | null>;
+
+/**
+ * Function to obtain a cart store based on the store provided and the stores
+ * already in the cart.
+ *
+ * @template T Store additional info
+ * @template U Product additional info
+ * @template V Categories additional info
+ * @template W Vendor additional info
+ * @template X Catalogues additional info
+ * @since 0.1.0
+ * @param {number|Store} storeData Store data
+ * @param {CartStore} stores Shopping cart store data
+ * @returns {CartStore} The complete CartStore object
+ */
+declare const getStore: (storeData: ShoppingCartConfig["store"], stores: ShoppingCart["stores"]) => CartStore;
+/**
+ * Checks if the shopping cart package has been initialized.
+ *
+ * @since 0.1.0
+ * @returns {boolean} The attribute that indicates whether or not the cart has
+ * been initialized
+ */
+declare const checkInit: () => boolean;
+/**
+ * Checks if the product to be modified is inside shopping cart benefits.
+ * If true, the benefits and benefits hash of the cart are deleted.
+ *
+ * @template T Shopping cart generic type
+ * @since 0.1.0
+ * @param {ShoppingCart} shoppingCart Provided shopping cart to be modified
+ * @param {Product} product Provided product to be modified, if none provided,
+ * assume the shopping cart is being emptied
+ * @returns {ShoppingCart} A shopping cart with the benefit and benefitsHash
+ * deleted
+ */
+declare const cleanShoppingCart: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(shoppingCart: T, product?: Product) => T;
+
+/**
+ * Configuration to fetch store coupons.
+ *
+ * @interface StoreCouponsConfig
+ * @since 0.1.0
+ */
+interface StoreCouponsConfig {
+    /** Provided vendor id */
+    vendorId: Vendor["id"];
+    /** Provided api URL */
+    apiURL: string;
+}
+/**
+ * Configuration to fetch a store coupon detail, extends
+ * {@link StoreCouponsConfig} omitting the vendor id
+ *
+ * @interface StoreCouponDetailConfig
+ * @since 0.1.0
+ * @extends {{@link StoreCouponsConfig}
+ */
+interface StoreCouponDetailConfig extends Omit<StoreCouponsConfig, "vendorId"> {
+    /** Provided coupon id */
+    couponId: number;
+    /** Provided country id */
+    countryId: number;
+    /** Provided api URL */
+    apiURL: string;
+}
+
+/**
+ * The endpoint to fetch a wallet of a user.
+ *
+ * @since 0.1.0
+ * @param {BenefitsWalletConfig} config Benefits wallet configuration
+ * @param {Headers} headers Supported headers to pass to the endpoint
+ */
+declare const fetchWalletByUser: (config: BenefitsWalletConfig, headers: Headers) => Promise<void>;
+/**
+ * The endpoint to redeem a coupon.
+ *
+ * @since 0.1.0
+ * @param {BenefitsWalletConfig} config Benefits wallet configuration
+ * @param {string} code The code to redeem a coupon
+ * @param {Headers} headers Supported headers to pass to the endpoint
+ * @returns {Promise<boolean>} True if the coupon was redeemed correctly, false
+ * if otherwise.
+ */
+declare const redeemCouponService: (config: BenefitsWalletConfig, code: string, headers: Headers) => Promise<boolean>;
+/**
+ * The endpoint to fetch a store coupons.
+ *
+ * @since 0.1.0
+ * @param {StoreCouponsConfig} config Store coupons configuration
+ * @param {Headers} headers Supported headers to pass to the endpoint
+ * @returns {Promise<StoreCoupon[]>} An array of store coupons
+ */
+declare const fetchStoreCoupons: (config: StoreCouponsConfig, headers: Headers) => Promise<StoreCoupon[]>;
+/**
+ * The endpoint to fetch a store coupon detail.
+ *
+ * @since 0.1.0
+ * @param {StoreCouponDetailConfig} config Store coupon detail configuration
+ * @param {Headers} headers Supported headers to pass to the endpoint
+ * @returns {Promise<StoreCouponDetail>} A store coupon detail object
+ */
+declare const fetchStoreCouponDetail: (config: StoreCouponDetailConfig, headers: Headers) => Promise<StoreCouponDetail>;
+
+/**
+ * Sets properties in the shopping cart remotely.
+ *
+ * @template T Shopping cart generic type
+ * @since 0.1.0
+ * @param {Function} shoppingCart The cart that will be set remotely
+ * @param {ShoppingCartConfig} config Shopping cart configuration
+ */
+declare const updateShoppingCart: <T extends ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> = ShoppingCart<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo>>(builders: ShoppingCartBuilders, setShoppingCart: (previousShoppingCart: T) => T, config?: ShoppingCartConfig) => Promise<T | null>;
+
+declare const initialState: GlobalState;
+declare const setState: (overrides: Partial<GlobalState>) => void;
+declare const getState: () => {
+    accountId?: number | undefined;
+    customerId?: string | number | undefined;
+    store?: _artisan_commerce_types.Store<_artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo, _artisan_commerce_types.AdditionalInfo> | undefined;
+    activeShoppingCart: string;
+    maxShoppingCarts: number;
+    wallets: Wallets;
+    anonymous?: boolean | undefined;
+    initialized: boolean;
+    queue: ActionQueue;
+    eventLoop: EventLoop;
+    debug?: boolean | undefined;
+};
+
+/**
+ * Gets the initial state of an empty benefits wallet.
+ *
+ * @since 0.1.0
+ * @returns An empty benefits wallet
+ */
+declare const getInitialBenefitsWallet: (overrides?: Partial<Wallet>) => Wallet;
+/**
+ * Transforms the benefits node to an array of benefits.
+ *
+ * @since 0.1.0
+ * @param {DocumentNode} benefitsNode Benefits by user node
+ * @param {string} hash Realtime db node id
+ * @returns {Benefit[]} An array of benefits with the hash inside them
+ */
+declare const mapCollectionToBenefits: (benefitsNode: DocumentNode, hash: string) => Benefit[];
+/**
+ * Updates the current benefits wallets with a new wallet.
+ *
+ * @since 0.1.0
+ * @param {string} walletName The name of the target wallet
+ * @param {WalletInternal} newWallet The new wallet to be set in the state
+ */
+declare const updateBenefitsWallets: (walletName: string, newWallet: WalletInternal) => void;
+/**
+ * Fetches all Artisn benefits of the given customer and account. It will first
+ * try to look at the function config. If it cannot find any of the needed
+ * parameters, it will look into the global config provided in initShoppingCart.
+ *
+ * @since 0.1.0
+ * @param {ShoppingCartConfig} config Shopping cart configuration
+ * @returns {Promise<ShoppingCartNodes | undefined>} A collection of benefits
+ * of the given customer in the form of firestore document nodes
+ */
+declare const getBenefitsNode: (builders: BenefitsBuilders, config?: ShoppingCartConfig) => Promise<any | undefined>;
+/**
+ * Fetches the wallet node of the given customer and account. It will first try
+ * to look at the function config. If it cannot find any of the needed
+ * parameters, it will look into the global config provided in initShoppingCart.
+ *
+ * @since 0.1.0
+ * @param {ShoppingCartConfig} config Shopping cart configuration
+ * @returns {Promise<any | undefined>} The benefits of a given
+ * customer in the form of firestore document nodes
+ */
+declare const getWalletNode: (builders: BenefitsBuilders, config?: ShoppingCartConfig) => Promise<any | undefined>;
+/**
+ * Fetches an array of benefits of the given customer and account. It will first
+ * try to look at the function config. If it cannot find any of the needed
+ * parameters, it will look into the global config provided in initShoppingCart.
+ *
+ * @since 0.1.0
+ * @param {ShoppingCartConfig} config Shopping cart configuration
+ * @returns {Promise<Benefit[] | undefined>} An array of benefits of the given
+ * customer, each benefit has the firestore hash inside them.
+ */
+declare const getWallet: (builders: BenefitsBuilders, config?: ShoppingCartConfig | undefined) => Promise<Benefit[] | undefined>;
+
+declare const defaultSort: (a: number | string, b: number | string) => 1 | -1 | 0;
+declare const sortByField: (field: string, a: any, b: any) => 1 | -1 | 0;
+declare const sortByProductId: (a: CartProductAnswer, b: CartProductAnswer) => 1 | -1 | 0;
+declare const sortByQuestionId: (a: CartProductQuestion, b: CartProductQuestion) => 1 | -1 | 0;
+/**
+ * Functions that throws an error when running on development environment
+ * and logs the error if running on production environment
+ * @since 0.1.0
+ * @param message: the message to be displayed
+ */
+declare const logError: (message: string) => void;
+/**
+ * Functions that logs a warning only if on debug mode
+ * @since 0.1.0
+ * @param message: the message to be displayed
+ */
+declare const logDebug: (message: string) => void;
+/**
+ * Utility function to reuse global configuration.
+ *
+ * @since 0.1.0
+ * @param {ShoppingCartConfig} config Custom configuration
+ * @returns {ShoppingCartConfig} Configuration prioritizing custom over global
+ * values
+ */
+declare const reuseGlobalConfig: <T extends ShoppingCartConfig>(config?: T | undefined) => T;
+
+declare const buildServiceHeaders: (settings: SettingsHeaders, headers: Headers) => Promise<Headers>;
+
+declare const checkInitialized: () => void;
+declare const checkMinimumConfigProvided: (config?: ShoppingCartConfig) => void;
+/**
+ * Check minimum fetch wallet configuration provided.
+ *
+ * @since 0.1.0
+ * @param {BenefitsWalletConfig} config Benefits wallet configuration parameters to pass to call the endpoint.
+ */
+declare const checkMinimumFetchWalletConfigProvided: (config?: BenefitsWalletConfig) => void;
+
+declare const verifyHeaders: (headers: Headers) => void;
+
+/**
+ * Configuration object to validate a shopping cart.
+ *
+ * @interface ValidateShoppingCartConfig
+ * @since 0.1.0
+ */
+interface ValidateShoppingCartConfig {
+    /** Shopping cart node id */
+    id: string;
+    /** Location latitude of the user */
+    latitude?: number;
+    /** Location latitude of the user */
+    longitude?: number;
+    /** Provide api URL */
+    apiURL: string;
+}
+/**
+ * The validation result of a shopping cart.
+ *
+ * @interface ValidateShoppingCartResult
+ * @since 0.1.0
+ */
+interface ValidateShoppingCartResult {
+    /**
+     * An array of shopping cart alerts associated with the stores,
+     * see {@link Alert}
+     */
+    stores: Alert[];
+    /**
+     * An array of shopping cart alerts associated with the products,
+     * see {@link Alert}
+     */
+    products: Alert[];
+}
+
+/**
+ * The endpoint to validate a shopping cart.
+ *
+ * @since 0.1.0
+ * @param {ValidateShoppingCartConfig} config Validate shopping cart
+ * configuration
+ * @param {ValidateHeaders} headers Headers to validate the shopping cart
+ * @returns {Promise<ValidateShoppingCartResult>} An object which contains stores and
+ * products alerts.
+ */
+declare const validateShoppingCart: (config: ValidateShoppingCartConfig, headers: Headers) => Promise<ValidateShoppingCartResult>;
+
+declare const CONSTANTS: {
+    PRODUCT_DATE_FORMAT: string;
+    DEFAULT_SHOPPING_CART_NAME: string;
+    DEFAULT_MAX_SHOPPING_CARTS: number;
+};
+
+export { ActionQueue, ApplyBenefitConfig, BenefitsWalletConfig, CONSTANTS, EmptyShoppingCartConfig, EventLoop, FindProductConfig, GlobalState, ProductActionConfig, ProductAddConfig, ProductRemoveConfig, ProductReplaceConfig, ProductSetConfig, RemoveBenefitConfig, ShoppingCartConfig, ShoppingCartCreateConfig, ShoppingCartTotals$1 as ShoppingCartTotals, ValidateShoppingCartResult, WalletHeaders, WalletInternal, Wallets, addProduct, addProductToCartHelper, applyBenefit, applyBenefitsHelper, buildInitialShoppingCart, buildServiceHeaders, checkInit, checkInitialized, checkMinimumConfigProvided, checkMinimumFetchWalletConfigProvided, cleanShoppingCart, closeShoppingCart, defaultSort, deleteShoppingCart, emptyShoppingCart, fetchStoreCouponDetail, fetchStoreCoupons, fetchWalletByUser, findProduct, getBenefitsNode, getInitialBenefitsWallet, getProductHash, getShoppingCart, getShoppingCartProducts, getShoppingCartTotal, getState, getStore, getWallet, getWalletNode, initShoppingCart, initialState, logDebug, logError, mapCollectionToBenefits, mergeShoppingCart, pruneQuestionsAndAnswers, redeemCoupon, redeemCouponService, removeBenefit, removeBenefitsHelper, removeProduct, replaceProduct, reuseGlobalConfig, setProduct, setState, sortByField, sortByProductId, sortByQuestionId, subtractProduct, unsubscriber, updateBenefitsWallets, updateShoppingCart, validateShoppingCart$1 as validateShoppingCart, validateShoppingCart as validateShoppingCartService, verifyHeaders };