@liquidcommerce/cloud-sdk 1.0.1

package/dist/types/enums.d.ts

@@ -0,0 +1,265 @@
+export declare enum LIQUID_COMMERCE_ENV {
+    DEV = "dev",
+    STAGE = "stage"
+}
+export declare enum ENUM_MODALITIES {
+    ON_DEMAND = "onDemand",
+    SHIPPING = "shipping"
+}
+export declare enum DAYS_OF_WEEK {
+    MONDAY = "monday",
+    TUESDAY = "tuesday",
+    WEDNESDAY = "wednesday",
+    THURSDAY = "thursday",
+    FRIDAY = "friday",
+    SATURDAY = "saturday",
+    SUNDAY = "sunday"
+}
+export declare enum STATES_CODE {
+    AL = "AL",
+    AK = "AK",
+    AR = "AR",
+    CA = "CA",
+    CO = "CO",
+    CT = "CT",
+    DE = "DE",
+    DC = "DC",
+    FL = "FL",
+    GA = "GA",
+    HI = "HI",
+    ID = "ID",
+    IL = "IL",
+    IN = "IN",
+    IA = "IA",
+    KS = "KS",
+    KY = "KY",
+    LA = "LA",
+    ME = "ME",
+    MD = "MD",
+    MA = "MA",
+    MI = "MI",
+    MN = "MN",
+    MS = "MS",
+    MO = "MO",
+    MT = "MT",
+    NE = "NE",
+    NV = "NV",
+    NH = "NH",
+    NJ = "NJ",
+    NM = "NM",
+    NY = "NY",
+    NC = "NC",
+    ND = "ND",
+    OH = "OH",
+    OK = "OK",
+    OR = "OR",
+    PA = "PA",
+    RI = "RI",
+    SC = "SC",
+    SD = "SD",
+    TN = "TN",
+    TX = "TX",
+    UT = "UT",
+    VT = "VT",
+    VA = "VA",
+    WA = "WA",
+    WV = "WV",
+    WI = "WI",
+    WY = "WY"
+}
+export declare enum STATES_NAME {
+    ALABAMA = "AL",
+    ALASKA = "AK",
+    ARKANSAS = "AR",
+    CALIFORNIA = "CA",
+    COLORADO = "CO",
+    CONNECTICUT = "CT",
+    DELAWARE = "DE",
+    DISTRICT_OF_COLUMBIA = "DC",
+    FLORIDA = "FL",
+    GEORGIA = "GA",
+    HAWAII = "HI",
+    IDAHO = "ID",
+    ILLINOIS = "IL",
+    INDIANA = "IN",
+    IOWA = "IA",
+    KANSAS = "KS",
+    KENTUCKY = "KY",
+    LOUISIANA = "LA",
+    MAINE = "ME",
+    MARYLAND = "MD",
+    MASSACHUSETTS = "MA",
+    MICHIGAN = "MI",
+    MINNESOTA = "MN",
+    MISSISSIPPI = "MS",
+    MISSOURI = "MO",
+    MONTANA = "MT",
+    NEBRASKA = "NE",
+    NEVADA = "NV",
+    NEW_HAMPSHIRE = "NH",
+    NEW_JERSEY = "NJ",
+    NEW_MEXICO = "NM",
+    NEW_YORK = "NY",
+    NORTH_CAROLINA = "NC",
+    NORTH_DAKOTA = "ND",
+    OHIO = "OH",
+    OKLAHOMA = "OK",
+    OREGON = "OR",
+    PENNSYLVANIA = "PA",
+    RHODE_ISLAND = "RI",
+    SOUTH_CAROLINA = "SC",
+    SOUTH_DAKOTA = "SD",
+    TENNESSEE = "TN",
+    TEXAS = "TX",
+    UTAH = "UT",
+    VERMONT = "VT",
+    VIRGINIA = "VA",
+    WASHINGTON = "WA",
+    WEST_VIRGINIA = "WV",
+    WISCONSIN = "WI",
+    WYOMING = "WY"
+}
+export declare enum ENUM_BEER {
+    ALE = "BEER > ALE",
+    LAGER = "BEER > LAGER",
+    MAIN = "BEER",
+    NON_ALCOHOLIC = "BEER > NON-ALCOHOLIC",
+    OTHER_BEER = "BEER > OTHER BEER"
+}
+export declare enum ENUM_FOOD {
+    BASE = "FOOD",
+    PANTRY_OTHER = "FOOD > PANTRY > OTHER"
+}
+export declare enum ENUM_MERCHANDISE {
+    BASE = "MERCHANDISE",
+    GLASSWARE = "MERCHANDISE > GLASSWARE",
+    HUMIDOR = "MERCHANDISE > HUMIDOR"
+}
+export declare enum ENUM_MISCELLANEOUS {
+    BASE = "MISCELLANEOUS",
+    GIFT_CARD = "MISCELLANEOUS > GIFT CARDS",
+    PROMOTIONAL = "MISCELLANEOUS > PROMOTIONAL",
+    MEMBERSHIP = "MISCELLANEOUS > MEMBERSHIP"
+}
+export declare enum ENUM_NON_ALCOHOLIC {
+    BASE = "NON ALCOHOLIC",
+    BITTERS = "NON ALCOHOLIC > BITTERS",
+    COCKTAIL_MIX = "NON ALCOHOLIC > COCKTAIL MIX",
+    COFFEE = "NON ALCOHOLIC > COFFEE",
+    ENERGY_DRINKS = "NON ALCOHOLIC > ENERGY DRINKS",
+    JUICE = "NON ALCOHOLIC > JUICE",
+    SODA = "NON ALCOHOLIC > SODA",
+    SPECIALTY_ITEM = "NON ALCOHOLIC > SPECIALTY ITEM",
+    SPIRITS = "NON ALCOHOLIC > SPIRITS",
+    TEA = "NON ALCOHOLIC > TEA",
+    WATER = "NON ALCOHOLIC > WATER",
+    WINE = "NON ALCOHOLIC > WINE"
+}
+export declare enum ENUM_READY_TO_DRINK {
+    BASE = "READY TO DRINK",
+    HARD_CIDER = "READY TO DRINK > HARD CIDER",
+    HARD_CIDER_PERRY_PEAR_CIDER = "READY TO DRINK > HARD CIDER > PERRY (PEAR CIDER)",
+    HARD_TEA = "READY TO DRINK > HARD TEA",
+    MALT_BASED = "READY TO DRINK > MALT BASED",
+    SPIRITS_BASED_RTDS = "READY TO DRINK > SPIRITS-BASED RTDS",
+    SPIRITS_BASED_RTDS_RUM_COCKTAILS = "READY TO DRINK > SPIRITS-BASED RTDS > RUM COCKTAILS",
+    SPIRITS_BASED_RTDS_TEQUILA_COCKTAILS = "READY TO DRINK > SPIRITS-BASED RTDS > TEQUILA COCKTAILS",
+    SPIRITS_BASED_RTDS_VODKA_COCKTAILS = "READY TO DRINK > SPIRITS-BASED RTDS > VODKA COCKTAILS",
+    SPIRITS_BASED_RTDS_WHISKEY_COCKTAILS = "READY TO DRINK > SPIRITS-BASED RTDS > WHISKEY COCKTAILS",
+    WINE_COCKTAILS = "READY TO DRINK > WINE COCKTAILS"
+}
+export declare enum ENUM_SPIRITS {
+    BASE = "SPIRITS",
+    BAIJIU = "SPIRITS > BAIJIU",
+    BITTERS = "SPIRITS > BITTERS",
+    BRANDY = "SPIRITS > BRANDY",
+    CACHACA = "SPIRITS > CACHACA",
+    GIN = "SPIRITS > GIN",
+    LAGER = "SPIRITS > LAGER",
+    LIQUEUR = "SPIRITS > LIQUEUR",
+    MEZCAL = "SPIRITS > MEZCAL",
+    OTHER_SPIRITS = "SPIRITS > OTHER SPIRITS",
+    RUM = "SPIRITS > RUM",
+    RUM_AGED_RUM = "SPIRITS > RUM > AGED RUM",
+    RUM_DARK_RUM = "SPIRITS > RUM > DARK RUM",
+    RUM_FLAVORED_RUM = "SPIRITS > RUM > FLAVORED RUM",
+    RUM_GOLD_RUM = "SPIRITS > RUM > GOLD RUM",
+    RUM_OTHER = "SPIRITS > RUM > OTHER",
+    RUM_SPICED = "SPIRITS > RUM > SPICED",
+    RUM_WHITE_RUM = "SPIRITS > RUM > WHITE RUM",
+    SOJU = "SPIRITS > SOJU",
+    TEQUILA = "SPIRITS > TEQUILA",
+    VODKA = "SPIRITS > VODKA",
+    VODKA_FLAVORED_VODKA = "SPIRITS > VODKA > FLAVORED VODKA",
+    WHISKEY = "SPIRITS > WHISKEY",
+    WHISKEY_AMERICAN_WHISKEY = "SPIRITS > WHISKEY > AMERICAN WHISKEY",
+    WHISKEY_BOURBON = "SPIRITS > WHISKEY > BOURBON",
+    WHISKEY_CANADIAN_WHISKEY = "SPIRITS > WHISKEY > CANADIAN WHISKEY",
+    WHISKEY_IRISH_WHISKEY = "SPIRITS > WHISKEY > IRISH WHISKEY",
+    WHISKEY_SCOTCH = "SPIRITS > WHISKEY > SCOTCH"
+}
+export declare enum ENUM_WINE {
+    BASE = "WINE",
+    CHAMPAGNE_SPARKLING = "WINE > CHAMPAGNE & SPARKLING",
+    CHAMPAGNE_SPARKLING_SPARKLING_WINE = "WINE > CHAMPAGNE & SPARKLING > SPARKLING WINE",
+    COOKING = "WINE > COOKING",
+    DESSERT_FORTIFIED_WINE = "WINE > DESSERT & FORTIFIED WINE",
+    DESSERT_FORTIFIED_WINE_SHERRY = "WINE > DESSERT & FORTIFIED WINE > SHERRY",
+    RED_WINE = "WINE > RED WINE",
+    ROSE_WINE = "WINE > ROSE WINE",
+    SAKE = "WINE > SAKE",
+    WHITE_WINE = "WINE > WHITE WINE"
+}
+export declare enum ENUM_FILTER_KEYS {
+    BRANDS = "brands",
+    FLAVOR = "flavor",
+    REGION = "region",
+    VARIETY = "variety",
+    PRICE = "price",
+    AVAILABILITY = "availability",
+    CATEGORIES = "categories",
+    SIZES = "sizes",
+    COLORS = "colors",
+    APPELLATION = "appellation",
+    COUNTRY = "country",
+    VINTAGE = "vintage",
+    MATERIALS = "materials"
+}
+export declare enum ENUM_NAVIGATION_ORDER_DIRECTION_TYPE {
+    ASC = "asc",
+    DESC = "desc"
+}
+export declare enum ENUM_ORDER_BY {
+    PRICE = "price"
+}
+export declare enum ENUM_AVAILABILITY_VALUE {
+    UNSPECIFIED = "AVAILABILITY_UNSPECIFIED",
+    IN_STOCK = "IN_STOCK",
+    OUT_OF_STOCK = "OUT_OF_STOCK",
+    PREORDER = "PREORDER",
+    BACKORDER = "BACKORDER"
+}
+export declare enum CART_PARAM_ERROR_ENUM {
+    INVALID_ITEMS_TYPE = "Items must be a non-empty array",
+    INVALID_ITEMS_MAX = "You can only send up to 25 items at a time!",
+    INVALID_PART_NUMBER = "The partnerNumber provided is invalid",
+    INVALID_FULFILLMENT_ID = "The fulfillmentId provided is invalid"
+}
+export declare enum CART_EVENT_ENUM {
+    OOS = "OutOfStock",
+    ITEMS_NOT_ADDED = "ItemsNotAdded",
+    ITEM_NOT_ENGRAVED = "ItemEngravingError",
+    ADDRESS_CHANGE = "AddressChange",
+    RETAILER_MIN = "RetailerMinNotMet",
+    NO_ITEMS_IN_CART = "NoItemsInCart",
+    INVALID_ID = "InvalidId",
+    NO_ID = "NoId",
+    CART_CHECKOUT_PROCESSED = "CartCheckoutProcessed",
+    NEW_CART = "NewCart",
+    DEFAULT = "CartError",
+    ITEM_QTY_CHANGE = "ItemQuantityChange"
+}
+export declare enum ENUM_ADDRESS_TYPE {
+    SHIPPING = "shipping",
+    BILLING = "billing"
+}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export { LIQUID_COMMERCE_ENV, LiquidCommerce } from './liquid-commerce-client';

package/dist/types/index.umd.d.ts

@@ -0,0 +1,2 @@
+import { LIQUID_COMMERCE_ENV, LiquidCommerce } from './index';
+export { LIQUID_COMMERCE_ENV, LiquidCommerce };

package/dist/types/interfaces/address.interface.d.ts

@@ -0,0 +1,21 @@
+import type { ICoreParams } from '../types';
+export interface IAddress {
+    id?: string;
+    one: string;
+    two: string;
+    city: string;
+    state: string;
+    zip: string;
+    country?: string;
+}
+export interface ICoords {
+    lat: number;
+    long: number;
+}
+export interface ILoc {
+    address?: IAddress;
+    coords?: ICoords;
+}
+export interface ILocBase extends ICoreParams {
+    loc: ILoc;
+}

package/dist/types/interfaces/cart.interface.d.ts

@@ -0,0 +1,188 @@
+import type { CART_EVENT_ENUM } from '../enums';
+import type { ILoc, ILocBase } from './address.interface';
+import type { IProduct } from './catalog.interface';
+import type { IRetailer } from './retailer.interface';
+/**
+ * Represents the engraving information for a cart item.
+ *
+ * @interface ICartItemEngraving
+ * @property {boolean} isEngravable - Indicates whether the item is engravable or not.
+ * @property {boolean} hasEngraving - Indicates whether the item has engraving or not.
+ * @property {number} fee - The fee associated with engraving the item.
+ * @property {number} maxCharsPerLine - The maximum number of characters allowed per line for the engraving.
+ * @property {number} maxLines - The maximum number of lines allowed for the engraving.
+ * @property {string} location - The location or area where the engraving should be placed on the item.
+ * @property {string[]} lines - The content of each line of the engraving.
+ */
+export interface ICartItemEngraving {
+    isEngravable: boolean;
+    hasEngraving: boolean;
+    fee: number;
+    maxCharsPerLine: number;
+    maxLines: number;
+    location: string;
+    lines: string[];
+}
+/**
+ * Represents an item in a gift cart.
+ *
+ * @interface ICartItemGiftCart
+ * @property {string} sender - The sender of the gift.
+ * @property {string} message - The message attached to the gift.
+ * @property {string[]} recipients - The list of recipients of the gift.
+ * @property {string} sendDate - The date when the gift should be sent.
+ */
+export interface ICartItemGiftCart {
+    sender: string;
+    message: string;
+    recipients: string[];
+    sendDate: string;
+}
+/**
+ * Represents the attributes of a cart item.
+ * @interface
+ */
+export interface ICartItemAttributes {
+    engraving: ICartItemEngraving;
+    giftCard: ICartItemGiftCart;
+}
+/**
+ * Interface representing a cart item.
+ * @interface
+ */
+export interface ICartItem extends Partial<IProduct> {
+    id: string;
+    variantId: string;
+    liquidId: string;
+    retailerId: string;
+    partNumber: string;
+    fulfillmentId: string;
+    quantity: number;
+    customerPlacement: string;
+    maxQuantity: number;
+    unitPrice: number;
+    availableAt: string;
+    attributes: ICartItemAttributes;
+}
+/**
+ * Represents the attributes of a promo code in a cart.
+ * @interface
+ */
+export interface ICartAttributesPromoCode {
+    value: string;
+    freeDelivery: boolean;
+    freeServiceFee: boolean;
+    freeShipping: boolean;
+}
+/**
+ * Represents the attributes of a gift card in a cart.
+ *
+ * @interface ICartAttributesGiftCard
+ * @memberof module:cart
+ * @property {string} code - The code of the gift card.
+ * @property {number} value - The value of the gift card in the cart.
+ */
+export interface ICartAttributesGiftCard {
+    code: string;
+    value: number;
+}
+/**
+ * Represents the attributes, amounts, and fees associated with a cart.
+ */
+export interface ICartAttributesAmountsFees {
+    shipping: number;
+    onDemand: number;
+}
+/**
+ * Interface representing the attributes, amounts, and discounts for a cart.
+ * @interface
+ */
+export interface ICartAttributesAmountsDiscounts {
+    shipping: number;
+    onDemand: number;
+    engraving: number;
+    service: number;
+    products: number;
+}
+/**
+ * Represents the attribute amounts of a cart.
+ */
+export interface ICartAttributesAmounts {
+    fees: ICartAttributesAmountsFees;
+    discounts: ICartAttributesAmountsDiscounts;
+}
+/**
+ * Represents the attributes of a cart.
+ * @interface
+ */
+export interface ICartAttributes {
+    promoCode: ICartAttributesPromoCode;
+    giftCards: ICartAttributesGiftCard[];
+    amounts: ICartAttributesAmounts;
+}
+/**
+ * Represents a retailer with additional properties related to a cart.
+ *
+ * @interface ICartRetailer
+ * @extends IRetailer
+ */
+export interface ICartRetailer extends IRetailer {
+    platformFee: number;
+    engravingFee: number;
+    deliveryFee: number;
+    shippingFee: number;
+    subtotal: number;
+    total: number;
+}
+/**
+ * Represents an event related to a shopping cart.
+ */
+export interface ICartEvent {
+    type: CART_EVENT_ENUM;
+    message: string;
+    items?: Array<Partial<ICartItem>>;
+}
+/**
+ * Interface representing a shopping cart.
+ */
+export interface ICart {
+    id: string;
+    quantity: number;
+    platformFee: number;
+    deliveryFee: number;
+    shippingFee: number;
+    engravingFee: number;
+    discounts: number;
+    giftCardTotal: number;
+    subtotal: number;
+    total: number;
+    createdAt: string;
+    updatedAt: string;
+    items: ICartItem[];
+    loc: ILoc;
+    retailers: ICartRetailer[];
+    attributes: ICartAttributes;
+    events: ICartEvent[];
+}
+/**
+ * Represents an item to be updated in a shopping cart.
+ */
+export interface ICartUpdateItem {
+    id?: string;
+    partNumber: string;
+    sku?: string;
+    quantity: number;
+    fulfillmentId: string;
+    engravingLines?: string[];
+    scheduledFor?: string | Date;
+}
+/**
+ * Represents the parameters for updating a cart.
+ * @interface
+ */
+export interface ICartUpdateParams extends ILocBase {
+    id: string;
+    items: ICartUpdateItem[];
+    promoCode?: string;
+    giftCards?: string[];
+}

package/dist/types/interfaces/catalog.interface.d.ts

@@ -0,0 +1,69 @@
+import type { ENUM_MODALITIES } from '../enums';
+export interface IProductFulfillmentTypes {
+    shipping: string;
+    onDemand: string;
+}
+export interface IProductVariant {
+    partNumber: string;
+    retailerId: string;
+    price: number;
+    modalities?: ENUM_MODALITIES;
+    salePrice: number;
+    isEngravable: boolean;
+    stock: number;
+    fulfillments: string[];
+    fulfillmentTypes: IProductFulfillmentTypes;
+}
+export interface IProductSizeEngraving {
+    status: boolean;
+    validated?: boolean;
+    maxLines: number;
+    maxCharsPerLine: number;
+    fee: number;
+    location: string;
+}
+export interface IProductSizeAttributes {
+    engraving?: IProductSizeEngraving;
+}
+export interface IProductSize {
+    upc: string;
+    size: string;
+    image: string;
+    pack: boolean;
+    packDesc: string;
+    container: string;
+    containerType: string;
+    attributes: IProductSizeAttributes;
+    modalities?: ENUM_MODALITIES;
+    variants: IProductVariant[];
+}
+export interface IProduct {
+    name: string;
+    brand: string;
+    catPath: string;
+    category: string;
+    classification: string;
+    type: string;
+    size?: string;
+    modalities?: ENUM_MODALITIES;
+    subType: string;
+    region: string;
+    country: string;
+    material: string;
+    abv: string;
+    age: string;
+    pack?: boolean;
+    packDesc?: string;
+    container?: string;
+    containerType?: string;
+    color: string;
+    flavor: string;
+    variety: string;
+    appellation: string;
+    vintage: string;
+    description: string;
+    htmlDescription: string;
+    tastingNotes: string;
+    images: string[];
+    sizes: IProductSize[];
+}

package/dist/types/interfaces/catalog.service.interface.d.ts

@@ -0,0 +1,65 @@
+import type { ENUM_AVAILABILITY_VALUE, ENUM_FILTER_KEYS, ENUM_NAVIGATION_ORDER_DIRECTION_TYPE, ENUM_ORDER_BY } from '../enums';
+import type { LiquidTaxonomy } from '../types';
+import type { ILocBase } from './address.interface';
+import type { IProduct } from './catalog.interface';
+import type { IRetailer } from './retailer.interface';
+interface ICategoryFilter {
+    key: ENUM_FILTER_KEYS.CATEGORIES | 'categories';
+    values: LiquidTaxonomy[];
+}
+interface IPriceFilter {
+    key: ENUM_FILTER_KEYS.PRICE | 'price';
+    values: {
+        min?: number | string;
+        max?: number | string;
+    };
+}
+interface IAvailabilityFilter {
+    key: ENUM_FILTER_KEYS.AVAILABILITY | 'availability';
+    values: ENUM_AVAILABILITY_VALUE | keyof typeof ENUM_AVAILABILITY_VALUE;
+}
+interface IFilter {
+    key: Omit<ENUM_FILTER_KEYS, ENUM_FILTER_KEYS.CATEGORIES | ENUM_FILTER_KEYS.PRICE | ENUM_FILTER_KEYS.AVAILABILITY>;
+    values: string | string[] | number | number[];
+}
+export interface ICatalogParams extends ILocBase {
+    search?: string;
+    pageToken?: string;
+    entity?: string;
+    page?: number;
+    perPage?: number;
+    visitorId?: string;
+    orderBy?: ENUM_ORDER_BY;
+    orderDirection?: ENUM_NAVIGATION_ORDER_DIRECTION_TYPE;
+    filters?: Array<ICategoryFilter | IPriceFilter | IAvailabilityFilter | IFilter>;
+}
+export interface ICatalog {
+    retailers?: IRetailer[] | Array<Record<string, any>>;
+    products?: IProduct[] | Array<Record<string, any>>;
+    navigation?: INavigationSchema;
+}
+interface IFilterValue {
+    value: LiquidTaxonomy | ENUM_AVAILABILITY_VALUE | string;
+    count: number;
+}
+interface IFilterSchema {
+    bucket: ENUM_FILTER_KEYS;
+    values: IFilterValue[];
+}
+interface ICursorSchema {
+    nextPageToken: string;
+    previousPageToken: string;
+}
+interface INavigationSchema {
+    id: string;
+    correctedQuery: string;
+    attributionToken: string;
+    currentPage: number;
+    totalPages: number;
+    totalCount: number;
+    availableOrderBy: ENUM_ORDER_BY[];
+    availableOrderDirection: ENUM_NAVIGATION_ORDER_DIRECTION_TYPE[];
+    cursor: ICursorSchema;
+    filters: IFilterSchema[];
+}
+export {};