b23-lib 1.6.2 → 1.7.0

package/dist/index.d.mts

@@ -422,4 +422,442 @@ declare const Logger: {
     inspect: (context: any) => string;
 };
 
-export { type AuthMiddlewareConfig, type AuthTokenType, AuthUtility, type AuthUtilityConfig, DefaultAuthMiddlewareConfig, DefaultAuthUtilityConfig, DynamoDBUtility as DynamoDB, type ErrorType, Fetch, Logger, ResponseUtility, Schema, type SuccessType, Utils };
+/**
+ * Represents the countries where the application operates or products are available.
+ */
+declare enum OperationalCountry {
+    /** India */ IN = "IN"
+}
+declare enum OperationalCountryCurrency {
+    /** India */ INR = "INR"
+}
+declare enum OperationalLocale {
+    /** India */ 'en-IN' = "en-IN"
+}
+/**
+ * Defines the supported ISO 4217 currency codes as an enumeration.
+ */
+declare const CountryCurrencyMap: {
+    /** India */ IN: OperationalCountryCurrency;
+};
+declare const CurrencySymbolMap: {
+    INR: string;
+};
+/**
+ * Defines standard gender categories for product targeting.
+ */
+declare enum GenderCategory {
+    MALE = "Male",
+    FEMALE = "Female",
+    UNISEX = "Unisex",
+    KIDS = "Kids",
+    BOY = "Boy",
+    GIRL = "Girl"
+}
+
+/**
+ * Represents a ISO 3166-1 alpha-2 country code (e.g., 'US', 'IN').
+ */
+type CountryCode = keyof typeof OperationalCountry;
+/**
+ * Represents a ISO 4217 currency code (e.g., 'INR', 'USD').
+ */
+type CurrencyCode = keyof typeof OperationalCountryCurrency;
+/**
+ * /**
+ * Represents a string that can be localized into multiple languages.
+ * The 'en' property is mandatory and serves as the default English translation.
+ * Additional properties can be added for other locales using their respective locale codes.
+ */
+type LocalizedString = {
+    en: string;
+} & {
+    [locale in LocaleCode]?: string;
+};
+/**
+ * Represents a BCP 47 language tag (e.g., 'en-US', 'fr-FR').
+ * Used to identify languages and regional variations.
+ */
+type LocaleCode = keyof typeof OperationalLocale;
+/**
+ * Represents a pricing tier based on a minimum purchase quantity.
+ */
+type PriceTier = {
+    /** The minimum quantity required to achieve this unit price. */
+    minQuantity: number;
+    /** The price per unit at this quantity tier. */
+    unitPrice: number;
+    currency: CurrencyCode;
+    country: CountryCode;
+};
+/**
+ * Represents the base price information for a single unit in a specific country.
+ */
+type BasePrice = {
+    /** Enforces that this price is for a single unit. */
+    minQuantity: 1;
+    /** The price per unit. */
+    unitPrice: number;
+    currency: CurrencyCode;
+    country: CountryCode;
+};
+type BasePriceList = BasePrice[];
+type PriceTierList = PriceTier[];
+type Color = {
+    name: string;
+    hex?: string;
+};
+/**
+ * Represents a date and time string formatted according to the ISO 8601 standard.
+ * Example: "2023-10-27T10:30:00Z"
+ */
+type ISODateTime = string;
+type RegionalPrice = {
+    country: CountryCode;
+    currency: CurrencyCode;
+    price: number;
+};
+type RegionalPriceList = RegionalPrice[];
+interface ShippingDetails {
+    shippingMethodId?: string;
+    shippingMethodName?: string | LocalizedString;
+    carrier?: string;
+    estimatedCost?: number;
+    estimatedDeliveryBy?: ISODateTime | null;
+    deliveryInstructions?: string | null;
+}
+
+interface CustomFields {
+    [key: string]: any;
+}
+type BaseAttributes = {
+    customFields?: CustomFields;
+    version?: number;
+    createdAt?: ISODateTime;
+    modifiedAt?: ISODateTime;
+    modifiedBy?: string;
+};
+type BaseData = {
+    customFields: CustomFields;
+    version: number;
+    createdAt: ISODateTime;
+    modifiedAt: ISODateTime;
+    modifiedBy: string;
+};
+
+declare enum AddressType {
+    BILLING = "billing",
+    SHIPPING = "shipping",
+    BILLING_AND_SHIPPING = "billing&shipping",
+    NONE = "none"
+}
+type AddressAttributes = BaseAttributes & {
+    id: string;
+    firstName: string;
+    lastName: string;
+    phone: string;
+    email: string;
+    addressLine1: string;
+    addressLine2?: string;
+    city: string;
+    postalCode: string;
+    state: string;
+    country: string;
+    isBillingAddress: boolean;
+    isShippingAddress: boolean;
+};
+type AddressData = Required<AddressAttributes>;
+
+declare enum ImageResolution {
+    THUMBNAIL = "thumbnail",
+    SMALL = "small",
+    MEDIUM = "medium",
+    LARGE = "large",
+    ORIGINAL = "original"
+}
+type ImageInfoAttribute = {
+    sources: {
+        [key in ImageResolution]?: string;
+    } & {
+        original: string;
+    };
+    alt?: string;
+    order?: number;
+    label?: string;
+};
+type ImageInfoData = ImageInfoAttribute;
+
+type SubItem = {
+    size: string;
+    quantity: number;
+};
+type LineItemAttributes = {
+    id: string;
+    productKey: string;
+    variantId: string;
+    name: LocalizedString;
+    attributes: {
+        color: Color;
+    };
+    primaryImage: ImageInfoData;
+    subItems: SubItem[];
+    basePrice: BasePrice;
+    priceTiers: PriceTier[];
+};
+type LineItemData = LineItemAttributes & {
+    totalQuantity: number;
+    priceTotals: {
+        subtotal: number;
+        mrpTotal: number;
+    };
+};
+
+declare enum CouponType {
+    COUPON = "coupon",
+    AUTOMATIC = "automatic"
+}
+declare enum CouponDiscountMethod {
+    FLAT = "flat",
+    PERCENTAGE = "percentage"
+}
+declare enum CouponCategory {
+    SHIPPING = "SHIPPING",
+    CUSTOMER = "CUSTOMER"
+}
+declare enum ApplicableTo {
+    ALL = "all",
+    FTB = "ftb"
+}
+type CouponAttribute = BaseAttributes & {
+    couponCode: string;
+    name: LocalizedString;
+    description: LocalizedString;
+    type: CouponType;
+    customerId?: string;
+    validFrom: ISODateTime;
+    validTo: ISODateTime;
+    minCartValue: RegionalPriceList;
+    maxCartDiscount: RegionalPriceList;
+    discountMethod: CouponDiscountMethod;
+    percentageValue?: number;
+    applicableTo: ApplicableTo;
+    category: CouponCategory;
+};
+type CouponData = Required<CouponAttribute>;
+
+type BaseShoppingContainerAttributes = BaseAttributes & {
+    id: string;
+    customerId?: string;
+    customerEmail?: string;
+    anonymousId?: string;
+    lineItems: LineItemData[];
+    shippingDetails: ShippingDetails | null;
+    shippingAddress?: AddressData | null;
+    billingAddress?: AddressData | null;
+    coupons?: CouponData[];
+    total?: {
+        shipping?: number;
+        effectiveShipping?: number;
+        subtotal?: number;
+        mrpTotal?: number;
+        couponTotal?: {
+            [key: string]: number;
+        };
+        grandTotal?: number;
+    };
+    country: CountryCode;
+    currency: CurrencyCode;
+    locale: LocaleCode;
+};
+type BaseShoppingContainerData = Omit<BaseShoppingContainerAttributes, 'coupons' | 'total'> & BaseData & {
+    coupons: CouponData[];
+    total: {
+        shipping: number;
+        effectiveShipping: number;
+        subtotal: number;
+        mrpTotal: number;
+        couponTotal: {
+            [key: string]: number;
+        };
+        grandTotal: number;
+    };
+};
+
+declare enum CartState {
+    ACTIVE = "ACTIVE",
+    FROZEN = "FROZEN",
+    MERGED = "MERGED",
+    ORDERED = "ORDERED"
+}
+declare class LineItemNotFoundError extends Error {
+    constructor(lineItemId: string);
+}
+/**
+ * Input attributes for creating or updating a CartModel.
+ */
+type CartAttributes = BaseShoppingContainerAttributes & {
+    state: CartState;
+    expireAt: number;
+};
+type CartData = BaseShoppingContainerData & {
+    state: CartState;
+    expireAt: number;
+};
+type CartConfig = {
+    expiresAtInSeconds: number;
+};
+declare const DEFAULT_CART_CONFIG: CartConfig;
+
+declare enum CustomerStatus {
+    CREATED = "CREATED",
+    REGISTERED_USER = "REGISTERED_USER",
+    ACTIVATED_USER = "ACTIVATED_USER",
+    EMAIL_OTP = "EMAIL_OTP",
+    EMAIL_PASSWORD = "EMAIL_PASSWORD",
+    PHONE_OTP = "PHONE_OTP"
+}
+type CustomerAttributes = BaseAttributes & {
+    id: string;
+    email: string;
+    phone: string;
+    firstName: string;
+    lastName: string;
+    isEmailVerified?: boolean;
+    customerStatus?: Set<CustomerStatus>;
+};
+type CustomerDataWithArrayStatus = Omit<CustomerAttributes, 'customerStatus'> & BaseData & {
+    customerStatus: CustomerStatus[];
+};
+type CustomerData = Required<CustomerDataWithArrayStatus>;
+type CustomerDataWithOutId = Omit<CustomerData, 'id'>;
+
+type CustomerAddressAttributes = BaseAttributes & {
+    id: string;
+    addresses: AddressData[];
+    defaultBillingAddressId: string;
+    defaultShippingAddressId: string;
+};
+type CustomerAddressWithoutDefaultAddress = Omit<CustomerAddressAttributes, 'addresses' | 'defaultBillingAddressId' | 'defaultShippingAddressId'> & {
+    addresses: AddressData[];
+    defaultBillingAddressId: string | null;
+    defaultShippingAddressId: string | null;
+};
+type CustomerAddressDataWithOutId = Required<Omit<CustomerAddressWithoutDefaultAddress, 'id'>>;
+type CustomerAddressData = Required<CustomerAddressWithoutDefaultAddress>;
+
+declare enum PaymentStatus {
+    PENDING = "PENDING",
+    AUTHORIZED = "AUTHORIZED",
+    CAPTURED = "CAPTURED",
+    FAILED = "FAILED",
+    REFUNDED = "REFUNDED",
+    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED"
+}
+declare enum PaymentMode {
+    PAY_LATER = "PAY_LATER",
+    CARD = "CARD",
+    CASH = "CASH",
+    NET_BANKING = "NET_BANKING",
+    WALLET = "WALLET",
+    COD = "COD",
+    UNKNOWN = "UNKNOWN"
+}
+/**
+ * Input attributes for creating or updating a PaymentModel.
+ */
+type PaymentAttributes = BaseAttributes & {
+    txnId: string;
+    externalId?: string;
+    orderNumber: string;
+    customerId: string;
+    status: PaymentStatus;
+    subStatus?: string;
+    amount: number;
+    currency: CurrencyCode;
+    paymentMode: PaymentMode;
+    gatewayResponse?: string;
+    gatewayErrorCode?: string;
+    gatewayErrorMessage?: string;
+    amountRefunded?: number;
+    cardLast4?: string;
+    cardBrand?: string;
+    transactionAt: ISODateTime;
+};
+/**
+ * Output data structure for a PaymentModel.
+ * Excludes potentially large or sensitive fields by default.
+ */
+type PaymentData = Omit<PaymentAttributes, 'gatewayResponse' | 'gatewayErrorMessage'> & BaseData;
+
+declare enum OrderState {
+    PENDING_PAYMENT = "PENDING_PAYMENT",
+    PROCESSING = "PROCESSING",
+    SHIPPED = "SHIPPED",
+    PARTIALLY_SHIPPED = "PARTIALLY_SHIPPED",
+    DELIVERED = "DELIVERED",
+    CANCELLED = "CANCELLED",
+    RETURNED = "RETURNED",
+    REFUNDED = "REFUNDED"
+}
+/**
+ * Input attributes for creating an OrderModel.
+ * Extends CartAttributes but requires/adds order-specific fields.
+ */
+type OrderAttributes = Required<Omit<BaseShoppingContainerAttributes, 'anonymousId'>> & {
+    anonymousId?: string;
+    orderNumber: string;
+    cartId: string;
+    paymentStatus: PaymentStatus;
+    holdReason?: string;
+    state: OrderState;
+};
+/**
+ * Output data structure for an OrderModel.
+ */
+type OrderData = BaseShoppingContainerData & OrderAttributes;
+
+type ProductVariantIdentifier = {
+    key: string;
+    variantId: string;
+};
+type ProductHashKey = {
+    id: string;
+    variantId: string;
+};
+type ProductAttributes = BaseAttributes & {
+    id: string;
+    key: string;
+    variantId: string;
+    name: LocalizedString;
+    description: LocalizedString;
+    slug: LocalizedString;
+    brand: string;
+    basePrices: BasePriceList;
+    priceTiers: PriceTierList;
+    attributes: {
+        color: Color;
+        sizes: string[];
+    };
+    primaryImage: ImageInfoData;
+    additionalImages?: ImageInfoData[];
+    isActive: boolean;
+    targetGender: GenderCategory;
+    categories: string[];
+    specifications: {
+        [locale: string]: {
+            [key: string]: string | string[];
+        };
+    };
+    searchTags?: string[];
+};
+type ProductData = Required<ProductAttributes>;
+type ProductSpecification = {
+    [key: string]: string | string[];
+};
+type LocalizedProductSpecification = {
+    en: ProductSpecification;
+} & {
+    [locale in LocaleCode]?: ProductSpecification;
+};
+
+export { type AddressAttributes, type AddressData, AddressType, ApplicableTo, type AuthMiddlewareConfig, type AuthTokenType, AuthUtility, type AuthUtilityConfig, type BaseAttributes, type BaseData, type BasePrice, type BasePriceList, type BaseShoppingContainerAttributes, type BaseShoppingContainerData, type CartAttributes, type CartConfig, type CartData, CartState, type Color, type CountryCode, CountryCurrencyMap, type CouponAttribute, CouponCategory, type CouponData, CouponDiscountMethod, CouponType, type CurrencyCode, CurrencySymbolMap, type CustomFields, type CustomerAddressAttributes, type CustomerAddressData, type CustomerAddressDataWithOutId, type CustomerAttributes, type CustomerData, type CustomerDataWithOutId, CustomerStatus, DEFAULT_CART_CONFIG, DefaultAuthMiddlewareConfig, DefaultAuthUtilityConfig, DynamoDBUtility as DynamoDB, type ErrorType, Fetch, GenderCategory, type ISODateTime, type ImageInfoAttribute, type ImageInfoData, ImageResolution, type LineItemAttributes, type LineItemData, LineItemNotFoundError, type LocaleCode, type LocalizedProductSpecification, type LocalizedString, Logger, OperationalCountry, OperationalCountryCurrency, OperationalLocale, type OrderAttributes, type OrderData, OrderState, type PaymentAttributes, type PaymentData, PaymentMode, PaymentStatus, type PriceTier, type PriceTierList, type ProductAttributes, type ProductData, type ProductHashKey, type ProductSpecification, type ProductVariantIdentifier, type RegionalPrice, type RegionalPriceList, ResponseUtility, Schema, type ShippingDetails, type SubItem, type SuccessType, Utils };