@reactionary/core 0.0.40 → 0.0.42

package/src/providers/cart.provider.d.ts

@@ -2,11 +2,110 @@ import { BaseProvider } from "./base.provider";
 import { Cart } from "../schemas/models/cart.model";
 import { CartQueryById } from "../schemas/queries/cart.query";
 import { Session } from "../schemas/session.schema";
-import { CartMutationItemAdd, CartMutationItemQuantityChange, CartMutationItemRemove } from "../schemas/mutations/cart.mutation";
+import { CartMutationApplyCoupon, CartMutationChangeCurrency, CartMutationCheckout, CartMutationDeleteCart, CartMutationItemAdd, CartMutationItemQuantityChange, CartMutationItemRemove, CartMutationRemoveCoupon, CartMutationSetBillingAddress, CartMutationSetShippingInfo } from "../schemas/mutations/cart.mutation";
+import { CartIdentifier, OrderIdentifier } from "../schemas/models/identifiers.model";
 export declare abstract class CartProvider<T extends Cart = Cart> extends BaseProvider<T> {
+    /**
+     * Get cart by ID.
+     *
+     * Usecase: Unclear, until we support multiple carts per user.
+     * @param payload
+     * @param session
+     */
     abstract getById(payload: CartQueryById, session: Session): Promise<T>;
+    /**
+     * Get the active cart id for the user.
+     *
+     * Usecase: Most common usecase during site load, or after login. You want to get the active cart for the user, so you can display it in the minicart.
+     * @param session
+     */
+    abstract getActiveCartId(session: Session): Promise<CartIdentifier>;
+    /**
+     * Add item to cart. If no cart exists, create a new one. Returns the updated and recalculated cart.
+     * Does not automatically consolidate items, so if you want to have second add of same item to increase quantity,
+     * you need to handle that in your logic or on the server.
+     *
+     * Usecase: Add item to cart, create cart if none exists.
+     * @param payload
+     * @param session
+     */
     abstract add(payload: CartMutationItemAdd, session: Session): Promise<T>;
+    /**
+     * Remove item from cart. If the cart is empty after removal, delete the cart. Returns the updated and recalculated cart.
+     *
+     * Usecase: Remove item from cart, delete cart if empty.
+     * @param payload
+     * @param session
+     */
     abstract remove(payload: CartMutationItemRemove, session: Session): Promise<T>;
+    /**
+     * Change quantity of item in cart. If the cart is empty after change, delete the cart. Returns the updated and recalculated cart.
+     * Changing quantity to 0 is not allowed. Use the remove call instead. This is done to avoid accidental removal of item.
+     * Calls with quantity 0 will just be ignored.
+     *
+     * Usecase: Change quantity of item in cart,  like in a minicart, or in the full cart view.
+     * @param payload
+     * @param session
+     */
     abstract changeQuantity(payload: CartMutationItemQuantityChange, session: Session): Promise<T>;
+    /**
+     * Deletes the entire cart.
+     *
+     * Usecase: User wants to empty the cart or something is wrong with the current cart, and you want to clear it out and start fresh.
+     * @param payload
+     * @param session
+     */
+    abstract deleteCart(payload: CartMutationDeleteCart, session: Session): Promise<T>;
+    /**
+     * Sets shipping method and address on the cart. Returns the updated and recalculated cart.
+     *
+     * Usecase: User selects shipping method during checkout.
+     * @param payload
+     * @param session
+     */
+    abstract setShippingInfo(payload: CartMutationSetShippingInfo, session: Session): Promise<T>;
+    /**
+     * Sets billing address on the cart. Returns the updated and recalculated cart.
+     *
+     * Usecase: User enters billing address during checkout.
+     *
+     * @param payload
+     * @param session
+     */
+    abstract setBillingAddress(payload: CartMutationSetBillingAddress, session: Session): Promise<T>;
+    /**
+     * Applies a coupon code to the cart. Returns the updated and recalculated cart.
+     *
+     * Usecase: User applies a coupon code during checkout.
+     * @param payload
+     * @param session
+     */
+    abstract applyCouponCode(payload: CartMutationApplyCoupon, session: Session): Promise<T>;
+    /**
+     * Removes a coupon code from the cart. Returns the updated and recalculated cart.
+     *
+     * Usecase: User removes a coupon code during checkout.
+     * @param payload
+     * @param session
+     */
+    abstract removeCouponCode(payload: CartMutationRemoveCoupon, session: Session): Promise<T>;
+    /**
+     * Checks out the cart. Returns the order identifier of the newly created order.
+     *
+     * Usecase: User proceeds to checkout.
+     *
+     * @param payload
+     * @param session
+     */
+    abstract checkout(payload: CartMutationCheckout, session: Session): Promise<OrderIdentifier>;
+    /**
+     * Changes the currency of the cart.
+     *
+     * Usecase: User wants to change the currency for his session. This will change the currency of the cart, and recalculate prices.
+     * @param newCurrency
+     * @param session
+     */
+    abstract changeCurrency(payload: CartMutationChangeCurrency, session: Session): Promise<T>;
+    protected createEmptyCart(): T;
     protected getResourceName(): string;
 }

package/src/providers/index.d.ts

@@ -0,0 +1,10 @@
+export * from './analytics.provider';
+export * from './base.provider';
+export * from './cart-payment.provider';
+export * from './cart.provider';
+export * from './category.provider';
+export * from './identity.provider';
+export * from './inventory.provider';
+export * from './price.provider';
+export * from './product.provider';
+export * from './search.provider';

package/src/providers/price.provider.d.ts

@@ -31,6 +31,6 @@ export declare abstract class PriceProvider<T extends Price = Price> extends Bas
      * @param currency
      * @returns
      */
-    protected getEmptyPriceResult(sku: string, currency: Currency): T;
+    protected createEmptyPriceResult(sku: string, currency: Currency): T;
     protected getResourceName(): string;
 }

package/src/providers/product.provider.d.ts

@@ -4,6 +4,11 @@ import { Session } from '../schemas/session.schema';
 import { ProductQueryById, ProductQueryBySlug } from '../schemas/queries/product.query';
 export declare abstract class ProductProvider<T extends Product = Product> extends BaseProvider<T> {
     abstract getById(payload: ProductQueryById, session: Session): Promise<T>;
-    abstract getBySlug(payload: ProductQueryBySlug, session: Session): Promise<T>;
+    abstract getBySlug(payload: ProductQueryBySlug, session: Session): Promise<T | null>;
+    protected createEmptyProduct(id: string): T;
+    /**
+     * The resource name, used for caching and logging.
+     * @returns
+     */
     protected getResourceName(): string;
 }

package/src/schemas/capabilities.schema.d.ts

@@ -5,6 +5,7 @@ export declare const CapabilitiesSchema: z.ZodObject<{
     analytics: z.ZodBoolean;
     identity: z.ZodBoolean;
     cart: z.ZodBoolean;
+    cartPayment: z.ZodBoolean;
     inventory: z.ZodBoolean;
     price: z.ZodBoolean;
     category: z.ZodBoolean;

package/src/schemas/models/cart.model.d.ts

@@ -1117,7 +1117,6 @@ export declare const CostBreakDownSchema: z.ZodObject<{
         }>>;
     }, z.core.$loose>>;
 }, z.core.$loose>;
-export type CostBreakDown = z.infer<typeof CostBreakDownSchema>;
 export declare const ItemCostBreakdownSchema: z.ZodObject<{
     unitPrice: z.ZodDefault<z.ZodObject<{
         value: z.ZodDefault<z.ZodNumber>;
@@ -1864,7 +1863,6 @@ export declare const ItemCostBreakdownSchema: z.ZodObject<{
         }>>;
     }, z.core.$loose>>;
 }, z.core.$loose>;
-export type ItemCostBreakdown = z.infer<typeof ItemCostBreakdownSchema>;
 export declare const CartItemSchema: z.ZodObject<{
     identifier: z.ZodDefault<z.ZodObject<{
         key: z.ZodDefault<z.ZodString>;
@@ -1872,6 +1870,9 @@ export declare const CartItemSchema: z.ZodObject<{
     product: z.ZodDefault<z.ZodObject<{
         key: z.ZodDefault<z.ZodString>;
     }, z.core.$loose>>;
+    sku: z.ZodDefault<z.ZodObject<{
+        key: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+    }, z.core.$loose>>;
     quantity: z.ZodDefault<z.ZodNumber>;
     price: z.ZodDefault<z.ZodObject<{
         unitPrice: z.ZodDefault<z.ZodObject<{
@@ -2631,6 +2632,9 @@ export declare const CartSchema: z.ZodObject<{
     identifier: z.ZodDefault<z.ZodObject<{
         key: z.ZodDefault<z.ZodString>;
     }, z.core.$loose>>;
+    userId: z.ZodDefault<z.ZodObject<{
+        userId: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+    }, z.core.$loose>>;
     items: z.ZodDefault<z.ZodArray<z.ZodObject<{
         identifier: z.ZodDefault<z.ZodObject<{
             key: z.ZodDefault<z.ZodString>;
@@ -2638,6 +2642,9 @@ export declare const CartSchema: z.ZodObject<{
         product: z.ZodDefault<z.ZodObject<{
             key: z.ZodDefault<z.ZodString>;
         }, z.core.$loose>>;
+        sku: z.ZodDefault<z.ZodObject<{
+            key: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+        }, z.core.$loose>>;
         quantity: z.ZodDefault<z.ZodNumber>;
         price: z.ZodDefault<z.ZodObject<{
             unitPrice: z.ZodDefault<z.ZodObject<{
@@ -4506,6 +4513,234 @@ export declare const CartSchema: z.ZodObject<{
     }, z.core.$loose>>;
     name: z.ZodDefault<z.ZodString>;
     description: z.ZodDefault<z.ZodString>;
+    shippingAddress: z.ZodOptional<z.ZodObject<{
+        identifier: z.ZodDefault<z.ZodObject<{
+            nickName: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+        }, z.core.$loose>>;
+        firstName: z.ZodDefault<z.ZodString>;
+        lastName: z.ZodDefault<z.ZodString>;
+        streetAddress: z.ZodDefault<z.ZodString>;
+        streetNumber: z.ZodDefault<z.ZodString>;
+        city: z.ZodDefault<z.ZodString>;
+        region: z.ZodDefault<z.ZodString>;
+        postalCode: z.ZodDefault<z.ZodString>;
+        countryCode: z.ZodDefault<z.ZodString>;
+    }, z.core.$loose>>;
+    billingAddress: z.ZodOptional<z.ZodObject<{
+        identifier: z.ZodDefault<z.ZodObject<{
+            nickName: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+        }, z.core.$loose>>;
+        firstName: z.ZodDefault<z.ZodString>;
+        lastName: z.ZodDefault<z.ZodString>;
+        streetAddress: z.ZodDefault<z.ZodString>;
+        streetNumber: z.ZodDefault<z.ZodString>;
+        city: z.ZodDefault<z.ZodString>;
+        region: z.ZodDefault<z.ZodString>;
+        postalCode: z.ZodDefault<z.ZodString>;
+        countryCode: z.ZodDefault<z.ZodString>;
+    }, z.core.$loose>>;
+    shippingMethod: z.ZodOptional<z.ZodObject<{
+        identifier: z.ZodDefault<z.ZodObject<{
+            key: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+        }, z.core.$loose>>;
+        name: z.ZodDefault<z.ZodString>;
+        description: z.ZodDefault<z.ZodString>;
+        logo: z.ZodOptional<z.ZodObject<{
+            sourceUrl: z.ZodDefault<z.ZodString>;
+            altText: z.ZodDefault<z.ZodString>;
+            width: z.ZodOptional<z.ZodNumber>;
+            height: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$loose>>;
+        price: z.ZodDefault<z.ZodObject<{
+            value: z.ZodDefault<z.ZodNumber>;
+            currency: z.ZodDefault<z.ZodEnum<{
+                AED: "AED";
+                AFN: "AFN";
+                ALL: "ALL";
+                AMD: "AMD";
+                ANG: "ANG";
+                AOA: "AOA";
+                ARS: "ARS";
+                AUD: "AUD";
+                AWG: "AWG";
+                AZN: "AZN";
+                BAM: "BAM";
+                BBD: "BBD";
+                BDT: "BDT";
+                BGN: "BGN";
+                BHD: "BHD";
+                BIF: "BIF";
+                BMD: "BMD";
+                BND: "BND";
+                BOB: "BOB";
+                BOV: "BOV";
+                BRL: "BRL";
+                BSD: "BSD";
+                BTN: "BTN";
+                BWP: "BWP";
+                BYN: "BYN";
+                BZD: "BZD";
+                CAD: "CAD";
+                CDF: "CDF";
+                CHE: "CHE";
+                CHF: "CHF";
+                CHW: "CHW";
+                CLF: "CLF";
+                CLP: "CLP";
+                CNY: "CNY";
+                COP: "COP";
+                COU: "COU";
+                CRC: "CRC";
+                CUC: "CUC";
+                CUP: "CUP";
+                CVE: "CVE";
+                CZK: "CZK";
+                DJF: "DJF";
+                DKK: "DKK";
+                DOP: "DOP";
+                DZD: "DZD";
+                EGP: "EGP";
+                ERN: "ERN";
+                ETB: "ETB";
+                EUR: "EUR";
+                FJD: "FJD";
+                FKP: "FKP";
+                GBP: "GBP";
+                GEL: "GEL";
+                GHS: "GHS";
+                GIP: "GIP";
+                GMD: "GMD";
+                GNF: "GNF";
+                GTQ: "GTQ";
+                GYD: "GYD";
+                HKD: "HKD";
+                HNL: "HNL";
+                HRK: "HRK";
+                HTG: "HTG";
+                HUF: "HUF";
+                IDR: "IDR";
+                ILS: "ILS";
+                INR: "INR";
+                IQD: "IQD";
+                IRR: "IRR";
+                ISK: "ISK";
+                JMD: "JMD";
+                JOD: "JOD";
+                JPY: "JPY";
+                KES: "KES";
+                KGS: "KGS";
+                KHR: "KHR";
+                KMF: "KMF";
+                KPW: "KPW";
+                KRW: "KRW";
+                KWD: "KWD";
+                KYD: "KYD";
+                KZT: "KZT";
+                LAK: "LAK";
+                LBP: "LBP";
+                LKR: "LKR";
+                LRD: "LRD";
+                LSL: "LSL";
+                LYD: "LYD";
+                MAD: "MAD";
+                MDL: "MDL";
+                MGA: "MGA";
+                MKD: "MKD";
+                MMK: "MMK";
+                MNT: "MNT";
+                MOP: "MOP";
+                MRU: "MRU";
+                MUR: "MUR";
+                MVR: "MVR";
+                MWK: "MWK";
+                MXN: "MXN";
+                MXV: "MXV";
+                MYR: "MYR";
+                MZN: "MZN";
+                NAD: "NAD";
+                NGN: "NGN";
+                NIO: "NIO";
+                NOK: "NOK";
+                NPR: "NPR";
+                NZD: "NZD";
+                OMR: "OMR";
+                PAB: "PAB";
+                PEN: "PEN";
+                PGK: "PGK";
+                PHP: "PHP";
+                PKR: "PKR";
+                PLN: "PLN";
+                PYG: "PYG";
+                QAR: "QAR";
+                RON: "RON";
+                RSD: "RSD";
+                RUB: "RUB";
+                RWF: "RWF";
+                SAR: "SAR";
+                SBD: "SBD";
+                SCR: "SCR";
+                SDG: "SDG";
+                SEK: "SEK";
+                SGD: "SGD";
+                SHP: "SHP";
+                SLE: "SLE";
+                SLL: "SLL";
+                SOS: "SOS";
+                SRD: "SRD";
+                SSP: "SSP";
+                STN: "STN";
+                SYP: "SYP";
+                SZL: "SZL";
+                THB: "THB";
+                TJS: "TJS";
+                TMT: "TMT";
+                TND: "TND";
+                TOP: "TOP";
+                TRY: "TRY";
+                TTD: "TTD";
+                TVD: "TVD";
+                TWD: "TWD";
+                TZS: "TZS";
+                UAH: "UAH";
+                UGX: "UGX";
+                USD: "USD";
+                USN: "USN";
+                UYI: "UYI";
+                UYU: "UYU";
+                UYW: "UYW";
+                UZS: "UZS";
+                VED: "VED";
+                VES: "VES";
+                VND: "VND";
+                VUV: "VUV";
+                WST: "WST";
+                XAF: "XAF";
+                XAG: "XAG";
+                XAU: "XAU";
+                XBA: "XBA";
+                XBB: "XBB";
+                XBC: "XBC";
+                XBD: "XBD";
+                XCD: "XCD";
+                XDR: "XDR";
+                XOF: "XOF";
+                XPD: "XPD";
+                XPF: "XPF";
+                XPT: "XPT";
+                XSU: "XSU";
+                XTS: "XTS";
+                XUA: "XUA";
+                XXX: "XXX";
+                YER: "YER";
+                ZAR: "ZAR";
+                ZMW: "ZMW";
+                ZWL: "ZWL";
+            }>>;
+        }, z.core.$loose>>;
+        deliveryTime: z.ZodDefault<z.ZodString>;
+    }, z.core.$loose>>;
 }, z.core.$loose>;
+export type CostBreakDown = z.infer<typeof CostBreakDownSchema>;
+export type ItemCostBreakdown = z.infer<typeof ItemCostBreakdownSchema>;
 export type CartItem = z.infer<typeof CartItemSchema>;
 export type Cart = z.infer<typeof CartSchema>;

package/src/schemas/models/identifiers.model.d.ts

@@ -39,6 +39,12 @@ export declare const PriceIdentifierSchema: z.ZodObject<{
 export declare const CategoryIdentifierSchema: z.ZodObject<{
     key: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
 }, z.core.$loose>;
+export declare const OrderIdentifierSchema: z.ZodObject<{
+    key: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+}, z.core.$loose>;
+export declare const OrderItemIdentifierSchema: z.ZodObject<{
+    key: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+}, z.core.$loose>;
 /**
  * The target store the user is interacting with. Can change over time, and is not necessarily the same as the default store.
  */
@@ -56,6 +62,23 @@ export declare const InventoryIdentifierSchema: z.ZodObject<{
         key: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
     }, z.core.$loose>>;
 }, z.core.$loose>;
+export declare const IdentityIdentifierSchema: z.ZodObject<{
+    userId: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+}, z.core.$loose>;
+export declare const ShippingMethodIdentifier: z.ZodObject<{
+    key: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+}, z.core.$loose>;
+export declare const PaymentMethodIdentifierSchema: z.ZodObject<{
+    method: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+    name: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+    paymentProcessor: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+}, z.core.$loose>;
+export declare const AddressIdentifierSchema: z.ZodObject<{
+    nickName: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+}, z.core.$loose>;
+export declare const PaymentInstructionIdentifierSchema: z.ZodObject<{
+    key: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+}, z.core.$loose>;
 export type ProductIdentifier = z.infer<typeof ProductIdentifierSchema>;
 export type SearchIdentifier = z.infer<typeof SearchIdentifierSchema>;
 export type FacetIdentifier = z.infer<typeof FacetIdentifierSchema>;
@@ -67,4 +90,11 @@ export type CategoryIdentifier = z.infer<typeof CategoryIdentifierSchema>;
 export type WebStoreIdentifier = z.infer<typeof WebStoreIdentifierSchema>;
 export type InventoryIdentifier = z.infer<typeof InventoryIdentifierSchema>;
 export type InventoryChannelIdentifier = z.infer<typeof InventoryChannelIdentifierSchema>;
-export type IdentifierType = ProductIdentifier | SearchIdentifier | FacetIdentifier | FacetValueIdentifier | CartIdentifier | CartItemIdentifier | PriceIdentifier | CategoryIdentifier | WebStoreIdentifier | InventoryIdentifier;
+export type IdentityIdentifier = z.infer<typeof IdentityIdentifierSchema>;
+export type ShippingMethodIdentifier = z.infer<typeof ShippingMethodIdentifier>;
+export type PaymentMethodIdentifier = z.infer<typeof PaymentMethodIdentifierSchema>;
+export type AddressIdentifier = z.infer<typeof AddressIdentifierSchema>;
+export type PaymentInstructionIdentifier = z.infer<typeof PaymentInstructionIdentifierSchema>;
+export type OrderIdentifier = z.infer<typeof OrderIdentifierSchema>;
+export type OrderItemIdentifier = z.infer<typeof OrderItemIdentifierSchema>;
+export type IdentifierType = ProductIdentifier | SearchIdentifier | FacetIdentifier | FacetValueIdentifier | CartIdentifier | CartItemIdentifier | PriceIdentifier | CategoryIdentifier | WebStoreIdentifier | InventoryIdentifier | InventoryChannelIdentifier | IdentityIdentifier | ShippingMethodIdentifier | PaymentMethodIdentifier | AddressIdentifier | PaymentInstructionIdentifier | OrderIdentifier | OrderItemIdentifier;

package/src/schemas/models/identity.model.d.ts

@@ -4,6 +4,12 @@ export declare const IdentityTypeSchema: z.ZodEnum<{
     Guest: "Guest";
     Registered: "Registered";
 }>;
+export declare const ServiceTokenSchema: z.ZodObject<{
+    service: z.ZodDefault<z.ZodString>;
+    token: z.ZodDefault<z.ZodString>;
+    issued: z.ZodDefault<z.ZodCoercedDate<unknown>>;
+    expiry: z.ZodDefault<z.ZodCoercedDate<unknown>>;
+}, z.core.$strip>;
 export declare const IdentitySchema: z.ZodObject<{
     meta: z.ZodDefault<z.ZodObject<{
         cache: z.ZodDefault<z.ZodObject<{
@@ -12,12 +18,24 @@ export declare const IdentitySchema: z.ZodObject<{
         }, z.core.$loose>>;
         placeholder: z.ZodDefault<z.ZodBoolean>;
     }, z.core.$loose>>;
-    id: z.ZodDefault<z.ZodString>;
+    id: z.ZodDefault<z.ZodObject<{
+        userId: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+    }, z.core.$loose>>;
     type: z.ZodDefault<z.ZodEnum<{
         Anonymous: "Anonymous";
         Guest: "Guest";
         Registered: "Registered";
     }>>;
+    logonId: z.ZodDefault<z.ZodString>;
+    createdAt: z.ZodDefault<z.ZodString>;
+    updatedAt: z.ZodDefault<z.ZodString>;
+    keyring: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        service: z.ZodDefault<z.ZodString>;
+        token: z.ZodDefault<z.ZodString>;
+        issued: z.ZodDefault<z.ZodCoercedDate<unknown>>;
+        expiry: z.ZodDefault<z.ZodCoercedDate<unknown>>;
+    }, z.core.$strip>>>;
+    currentService: z.ZodOptional<z.ZodString>;
     token: z.ZodOptional<z.ZodString>;
     issued: z.ZodDefault<z.ZodCoercedDate<unknown>>;
     expiry: z.ZodDefault<z.ZodCoercedDate<unknown>>;

package/src/schemas/models/index.d.ts

@@ -0,0 +1,14 @@
+export * from './analytics.model';
+export * from './base.model';
+export * from './cart.model';
+export * from './category.model';
+export * from './currency.model';
+export * from './identifiers.model';
+export * from './identity.model';
+export * from './inventory.model';
+export * from './payment.model';
+export * from './price.model';
+export * from './product.model';
+export * from './profile.model';
+export * from './search.model';
+export * from './shipping-method.model';