@nizza/core 0.5.0-beta.14 → 0.5.0-beta.16

package/dist/lib/add-to-cart/hooks.d.ts

@@ -0,0 +1,19 @@
+import { AddToCartActionFactory, HooksInitConfig, HookState } from '../types';
+export declare const addToCartMessages: {
+    errorAddingToCart: string;
+    errorOpeningVariationSelector: string;
+    errorOpeningNewTab: string;
+    successAddingToCart: string;
+};
+/**
+ * Executes the add to cart hooks.
+ * @async
+ * @param {HooksInitConfig} config - The initial configuration for the add to cart operation.
+ */
+export declare function runAddToCartHooks<ContextData extends Record<string, any>>(config: HooksInitConfig<ContextData>): Promise<void>;
+/**
+ * Creates an action factory based on the current state.
+ * @param {HookState} state - The current state of the add to cart operation.
+ * @returns {AddToCartActionFactory} The created action factory.
+ */
+export declare function createActionFactory(state: HookState): AddToCartActionFactory;

package/dist/lib/add-to-cart/index.d.ts

@@ -0,0 +1 @@
+export * from './hooks';

package/dist/lib/constants/eventBus.d.ts

@@ -10,6 +10,7 @@
 export declare const EventBusWildcards: {
     readonly ALL: "*";
     readonly CORE: "core:**";
+    readonly ADD_TO_CART_HOOKS: "core:addToCartHooks:**";
     readonly LIVE_STREAMING_EVENT: "event:**";
     readonly EVENT_CHAT: "event:chat:**";
     readonly EVENT_PRODUCTS: "event:products:**";
@@ -31,4 +32,6 @@ export declare const EventBusWildcards: {
  */
 export declare const EventNames: {
     readonly EVENT_STATUS_CHANGED: "event:statusChanged";
+    /** AddToCartHook events */
+    readonly ATCH_ACTION_EXECUTED: "core:addToCartHooks:actionExecuted";
 };

package/dist/lib/constants/products.d.ts

@@ -1,5 +1,6 @@
 export declare enum NizzaVariationTypes {
-    COMBO = "Combo"
+    COMBO = "Combo",
+    BADGE = "Badged"
 }
 export declare enum NizzaProductRequestOriginTypes {
     VTEX = "VTEX",

package/dist/lib/index.d.ts

@@ -1,4 +1,5 @@
 export * from './accounts';
+export * from './add-to-cart';
 export * from './constants';
 export * from './domain';
 export * from './errors';

package/dist/lib/types/add-to-cart-hooks.d.ts

@@ -0,0 +1,122 @@
+import { NizzaProduct } from './nizza';
+export type HookName = 'transform' | 'validate' | 'end';
+/**
+ * ============ Action types ============
+ */
+export declare enum AddToCartActionTypes {
+    OPEN_TAB = "openTab",
+    OPEN_VARIATION_SELECTOR = "openVariationSelector",
+    ADD_TO_CART = "addToCart"
+}
+export type AddToCartCreateAction<T> = (data: T) => AddToCartAction;
+export type AddToCartCreateActionExec<T> = (data: T) => any;
+export type AddToCartAction = {
+    type: AddToCartActionTypes;
+    exec: () => any;
+};
+/**
+ * ============ Factory types ============
+ */
+/**
+ * The keys must be coincide with "AddToCartHookActionTypes" enum values
+ */
+export type AddToCartActionFactory = {
+    openTab: AddToCartCreateAction<string>;
+    openVariationSelector: AddToCartCreateAction<boolean>;
+    addToCart: AddToCartCreateAction<{
+        product: NizzaProduct;
+        quantity?: number;
+    }>;
+};
+export type AddToCartActionFactoryMap = {
+    openTab: AddToCartCreateActionExec<string>;
+    openVariationSelector: AddToCartCreateActionExec<boolean>;
+    addToCart: AddToCartCreateActionExec<{
+        product: NizzaProduct;
+        quantity?: number;
+    }>;
+};
+type AddToCartCreateNotify = (message: string) => void;
+export type AddToCartNotifyFactory = {
+    error: AddToCartCreateNotify;
+    success: AddToCartCreateNotify;
+};
+/**
+ * ============ Context types ============
+ */
+type TransformHookContext<T = Record<string, any>> = {
+    product: NizzaProduct;
+    data: T;
+};
+type ValidateHookContext<T = Record<string, any>> = {
+    product: NizzaProduct;
+    defaultAction: AddToCartAction;
+    action: AddToCartActionFactory;
+    data: T;
+};
+type EndHookContext<T = Record<string, any>> = {
+    error: Error | string | null | unknown;
+    notify: AddToCartNotifyFactory;
+    actionExecuted: AddToCartAction;
+    data: T;
+};
+/**
+ * ============ Execution types ============
+ */
+/**
+ * Context for the add to cart operation.
+ */
+export type HookContext<T = Record<string, any>> = {
+    /** Indicates if the variation selector is open. */
+    isVariationSelectorOpen: boolean;
+    /** The quantity of the product to add to cart. */
+    quantity?: number;
+    data?: T;
+};
+/**
+ * Represents the combined state of the add to cart operation.
+ */
+export type HookState<ContextData = Record<string, any>> = HooksInitConfig<ContextData> & {
+    action: AddToCartAction;
+};
+export type AddToCartHookStrategy<ContextData = Record<string, any>> = {
+    validate: (state: HookState<ContextData>) => AddToCartAction;
+};
+/**
+ * Initial configuration for the add to cart operation.
+ */
+export type HooksInitConfig<ContextData = Record<string, any>> = {
+    /** The product to be added to the cart. */
+    product: NizzaProduct;
+    hookStrategy: AddToCartHookStrategy<ContextData>;
+    /** A map of action factories for different add to cart actions. */
+    actionFactory: AddToCartActionFactoryMap;
+    /** Factory for creating notification actions. */
+    notifyFactory: AddToCartNotifyFactory;
+    /** Context for the add to cart operation. */
+    context: HookContext<ContextData>;
+    /** User-defined configuration for add to cart behavior. */
+    userAddToCartConfig?: AddToCartConfig;
+};
+/**
+ * ============ Event types ============
+ */
+export type ActionExecutedPayload = {
+    actionType: AddToCartActionTypes;
+    product: NizzaProduct;
+    success: boolean;
+    error: Error | string | null | unknown;
+};
+/**
+ * ============ Main types ============
+ */
+interface AddToCartHooks<ContextData = Record<string, any>> {
+    transform: (context: TransformHookContext<ContextData>) => NizzaProduct | Promise<NizzaProduct>;
+    validate: (context: ValidateHookContext<ContextData>) => AddToCartAction | Promise<AddToCartAction>;
+    end: (context: EndHookContext<ContextData>) => void | boolean | Promise<void | boolean>;
+}
+export interface AddToCartConfig {
+    hooks?: Partial<AddToCartHooks>;
+    actionFactory?: Partial<AddToCartActionFactoryMap>;
+}
+export {};

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

@@ -1,4 +1,5 @@
 import * as ApiGraphqlTypes from './api-graphql-types';
+export * from './add-to-cart-hooks';
 export * from './api';
 export * from './appModule';
 export * from './i18n';

package/dist/lib/types/nizza/main.d.ts

@@ -1,7 +1,7 @@
 import { NizzaProduct } from './product';
 export type NizzaAddToCartHandlerParams = {
     product: NizzaProduct;
-    quantity: number;
+    quantity?: number;
 };
 export type NizzaAddToCartHandler = (params: NizzaAddToCartHandlerParams) => Promise<void>;
 export type NizzaSetUTMHandler = (utm: string) => Promise<void>;

package/dist/locales/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nizza/core",
-  "version": "0.5.0-beta.14",
+  "version": "0.5.0-beta.16",
   "type": "module",
   "source": "src/index.ts",
   "main": "dist/index.cjs",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nizza/core",
-  "version": "0.5.0-beta.14",
+  "version": "0.5.0-beta.16",
   "type": "module",
   "source": "src/index.ts",
   "main": "dist/index.cjs",