@clicktap/state 0.16.2 → 0.16.4

package/quote/checkout/actions/updateQuote.d.ts

@@ -0,0 +1,216 @@
+import { CheckoutMachineContext, CheckoutMachineEvents } from '../types';
+export declare function updateQuote({ context, event, }: {
+    context: CheckoutMachineContext;
+    event: CheckoutMachineEvents;
+}): CheckoutMachineContext | {
+    quote: {
+        quote?: Partial<{
+            id: string | null;
+            accessToken: string | null;
+            locale: string | null;
+            checkoutSteps: Array<import('../../..').CheckoutStep>;
+            baseCurrency: string | null;
+            currency: string | null;
+            currencyConversionRate: number | null;
+            dateCreated: Date | null;
+            dateLastUpdated: Date | null;
+            items: Array<Record<string, any>> | null;
+            promotions: Array<Record<string, any>> | null;
+            shippingAddresses: {
+                available: Array<import('../../..').QuoteAddress>;
+                applied: Array<{
+                    availableAddressId?: string;
+                    address: import('../../..').QuoteAddress;
+                    itemIds: Array<Record<string, any>>;
+                }>;
+            };
+            paymentMethods: {
+                available: Array<import('../../..').PaymentMethod>;
+                applied: Array<{
+                    paymentMethod: import('../../..').PaymentMethod;
+                    options: Array<Record<string, any>>;
+                    amount: number;
+                }>;
+            };
+            shipments: Array<{
+                id: string;
+                shippingAddress: {
+                    id: string;
+                    address: import('../../..').QuoteAddress;
+                };
+                items: Array<Record<string, any>>;
+                shippingMethods: {
+                    available: Array<{
+                        shippingMethod: {
+                            id: string;
+                            code: string;
+                            name: string;
+                            carrier: {
+                                id: string;
+                                code: string;
+                                name: string;
+                            };
+                        };
+                        estimatedTotal: number;
+                        earliestShipDate: Date;
+                        latestShipDate: Date;
+                        earliestArrivalDate: Date;
+                        latestArrivalDate: Date;
+                    }>;
+                    applied: {
+                        shippingMethod: {
+                            id: string;
+                            code: string;
+                            name: string;
+                            carrier: {
+                                id: string;
+                                code: string;
+                                name: string;
+                            };
+                        };
+                        estimatedTotal: number;
+                        earliestShipDate: Date;
+                        latestShipDate: Date;
+                        earliestArrivalDate: Date;
+                        latestArrivalDate: Date;
+                    };
+                };
+            }>;
+            totals: {
+                discount: number;
+                taxAmount: number;
+                shippingAmount: number;
+                shippingTaxAmount: number;
+                subtotal: number;
+                grandTotal: number;
+            } | null;
+            appliedPriceRules: Array<Record<string, any>> | null;
+            appliedPromotions: Array<Record<string, any>> | null;
+            shippingMethods: Array<Record<string, any>> | null;
+            storeCredit: Array<Record<string, any>> | null;
+            rewards: Array<Record<string, any>> | null;
+            giftCards: Array<Record<string, any>> | null;
+            user: {
+                id: string | null;
+                email: string | null;
+                firstName: string | null;
+                lastName: string | null;
+            } | null;
+        }> | undefined;
+        errors?: string[] | undefined;
+        endpoints?: {
+            client?: string;
+            server?: string;
+        } | undefined;
+        graphql?: {
+            refresh: {
+                document: import('graphql-request').RequestDocument | import('@graphql-typed-document-node/core').TypedDocumentNode<unknown, object>;
+                requestHeaders?: import('graphql-request/build/esm/types').GraphQLClientRequestHeaders | undefined;
+            };
+            addItems: {
+                document: import('graphql-request').RequestDocument | import('@graphql-typed-document-node/core').TypedDocumentNode<unknown, object>;
+                requestHeaders?: import('graphql-request/build/esm/types').GraphQLClientRequestHeaders | undefined;
+            };
+            removeItems: {
+                document: import('graphql-request').RequestDocument | import('@graphql-typed-document-node/core').TypedDocumentNode<unknown, object>;
+                requestHeaders?: import('graphql-request/build/esm/types').GraphQLClientRequestHeaders | undefined;
+            };
+            updateItems: {
+                document: import('graphql-request').RequestDocument | import('@graphql-typed-document-node/core').TypedDocumentNode<unknown, object>;
+                requestHeaders?: import('graphql-request/build/esm/types').GraphQLClientRequestHeaders | undefined;
+            };
+        } | undefined;
+        id?: string | null | undefined;
+        accessToken?: string | null | undefined;
+        locale?: string | null | undefined;
+        checkoutSteps?: import('../../..').CheckoutStep[] | undefined;
+        baseCurrency?: string | null | undefined;
+        currency?: string | null | undefined;
+        currencyConversionRate?: number | null | undefined;
+        dateCreated?: Date | null | undefined;
+        dateLastUpdated?: Date | null | undefined;
+        items?: Record<string, any>[] | null | undefined;
+        promotions?: Record<string, any>[] | null | undefined;
+        shippingAddresses?: {
+            available: Array<import('../../..').QuoteAddress>;
+            applied: Array<{
+                availableAddressId?: string;
+                address: import('../../..').QuoteAddress;
+                itemIds: Array<Record<string, any>>;
+            }>;
+        } | undefined;
+        paymentMethods?: {
+            available: Array<import('../../..').PaymentMethod>;
+            applied: Array<{
+                paymentMethod: import('../../..').PaymentMethod;
+                options: Array<Record<string, any>>;
+                amount: number;
+            }>;
+        } | undefined;
+        shipments?: {
+            id: string;
+            shippingAddress: {
+                id: string;
+                address: import('../../..').QuoteAddress;
+            };
+            items: Array<Record<string, any>>;
+            shippingMethods: {
+                available: Array<{
+                    shippingMethod: {
+                        id: string;
+                        code: string;
+                        name: string;
+                        carrier: {
+                            id: string;
+                            code: string;
+                            name: string;
+                        };
+                    };
+                    estimatedTotal: number;
+                    earliestShipDate: Date;
+                    latestShipDate: Date;
+                    earliestArrivalDate: Date;
+                    latestArrivalDate: Date;
+                }>;
+                applied: {
+                    shippingMethod: {
+                        id: string;
+                        code: string;
+                        name: string;
+                        carrier: {
+                            id: string;
+                            code: string;
+                            name: string;
+                        };
+                    };
+                    estimatedTotal: number;
+                    earliestShipDate: Date;
+                    latestShipDate: Date;
+                    earliestArrivalDate: Date;
+                    latestArrivalDate: Date;
+                };
+            };
+        }[] | undefined;
+        totals?: {
+            discount: number;
+            taxAmount: number;
+            shippingAmount: number;
+            shippingTaxAmount: number;
+            subtotal: number;
+            grandTotal: number;
+        } | null | undefined;
+        appliedPriceRules?: Record<string, any>[] | null | undefined;
+        appliedPromotions?: Record<string, any>[] | null | undefined;
+        shippingMethods?: Record<string, any>[] | null | undefined;
+        storeCredit?: Record<string, any>[] | null | undefined;
+        rewards?: Record<string, any>[] | null | undefined;
+        giftCards?: Record<string, any>[] | null | undefined;
+        user?: {
+            id: string | null;
+            email: string | null;
+            firstName: string | null;
+            lastName: string | null;
+        } | null | undefined;
+    };
+};
+export default updateQuote;

package/quote/checkout/actions/updateSuccessId.d.ts

@@ -0,0 +1,8 @@
+import { CheckoutMachineContext, CheckoutMachineEvents } from '../types';
+export declare function updateSuccessId({ context, event, }: {
+    context: CheckoutMachineContext;
+    event: CheckoutMachineEvents;
+}): CheckoutMachineContext | {
+    successId: string;
+};
+export default updateSuccessId;

package/quote/checkout/actors/index.d.ts

@@ -0,0 +1,2 @@
+export * from './placeOrder';
+export * from './submitStepData';

package/quote/checkout/actors/placeOrder.d.ts

@@ -0,0 +1,20 @@
+import { CheckoutMachineContext, PlaceOrderSuccessEvent } from '../types';
+export type PlaceOrderDataInput = {
+    endpoint: CheckoutMachineContext['endpoints']['client'];
+    document: CheckoutMachineContext['graphql']['placeOrder']['document'];
+    requestHeaders?: CheckoutMachineContext['graphql']['placeOrder']['requestHeaders'];
+};
+export type PlaceOrderDataOutput = Partial<{
+    placeOrder: {
+        checkoutSuccess: {
+            id: string;
+        };
+        userErrors: Array<{
+            code: string;
+            field: string;
+            message: string;
+        }>;
+    };
+}>;
+export declare const placeOrder: import('xstate').PromiseActorLogic<PlaceOrderSuccessEvent, PlaceOrderDataInput, import('xstate').EventObject>;
+export default placeOrder;

package/quote/checkout/actors/submitStepData.d.ts

@@ -0,0 +1,19 @@
+import { CheckoutMachineContext, SubmitStepDataEvent, SubmitStepDataSuccessEvent } from '../types';
+export type SubmitStepDataInput = {
+    endpoint: CheckoutMachineContext['endpoints']['client'];
+    data: SubmitStepDataEvent['data'];
+    document: CheckoutMachineContext['graphql']['submitStepData']['document'];
+    requestHeaders?: CheckoutMachineContext['graphql']['submitStepData']['requestHeaders'];
+};
+export type SubmitStepDataOutput = Partial<{
+    checkoutStep: {
+        quote: object;
+        userErrors: Array<{
+            code: string;
+            field: string;
+            message: string;
+        }>;
+    };
+}>;
+export declare const submitStepData: import('xstate').PromiseActorLogic<SubmitStepDataSuccessEvent, SubmitStepDataInput, import('xstate').EventObject>;
+export default submitStepData;

package/quote/checkout/guards/index.d.ts

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

package/quote/checkout/guards/quoteExists.d.ts

@@ -0,0 +1,10 @@
+import { CheckoutMachineContext } from '../types';
+/**
+ * Used for initializing quote.
+ * Checks whether the quote is an empty object since an initialized quote
+ * will never be empty
+ */
+export declare const quoteExists: ({ context }: {
+    context: CheckoutMachineContext;
+}) => boolean;
+export default quoteExists;

package/quote/checkout/types.d.ts

@@ -0,0 +1,55 @@
+import { RequestDocument } from 'graphql-request';
+import { TypedDocumentNode } from '@graphql-typed-document-node/core';
+import { GraphQLClientRequestHeaders } from 'graphql-request/build/esm/types';
+import { DoneActorEvent } from 'xstate';
+import { QuoteMachineContext, CheckoutStep } from '../quote/types';
+export interface CheckoutMachineContext {
+    currentStep: string;
+    /** @todo DeepPartial should play nicer with props like steps */
+    steps?: Array<CheckoutStep>;
+    isLoggedIn: boolean;
+    quote: QuoteMachineContext['quote'];
+    endpoints: {
+        client?: string;
+        server?: string;
+    };
+    successId: string;
+    graphql: {
+        placeOrder: {
+            document: RequestDocument | TypedDocumentNode<unknown, object>;
+            requestHeaders?: GraphQLClientRequestHeaders;
+        };
+        submitStepData: {
+            document: RequestDocument | TypedDocumentNode<unknown, object>;
+            requestHeaders?: GraphQLClientRequestHeaders;
+        };
+    };
+}
+export interface ChangeStepEvent {
+    type: 'CHANGE_STEP';
+    step: string;
+}
+export interface PlaceOrderEvent {
+    type: 'PLACE_ORDER';
+}
+export interface ResetCheckoutEvent {
+    type: 'RESET_CHECKOUT';
+    data: {
+        currentStep: string;
+        steps: Array<CheckoutStep>;
+        quote: QuoteMachineContext['quote'];
+    };
+}
+export interface SubmitStepDataEvent {
+    type: 'SUBMIT_STEP_DATA';
+    data: Record<string, any>;
+}
+export interface SubmitStepDataSuccessEvent {
+    type: 'SUBMIT_STEP_DATA_SUCCESS';
+    quote: Partial<QuoteMachineContext>;
+}
+export interface PlaceOrderSuccessEvent {
+    type: 'PLACE_ORDER_SUCCESS';
+    successId: string;
+}
+export type CheckoutMachineEvents = ChangeStepEvent | PlaceOrderEvent | ResetCheckoutEvent | SubmitStepDataEvent | DoneActorEvent<PlaceOrderSuccessEvent> | DoneActorEvent<SubmitStepDataSuccessEvent>;

package/quote/checkout.d.ts

@@ -0,0 +1,46 @@
+import { CheckoutMachineContext } from './checkout/types';
+import { DeepPartial } from './types';
+export declare const checkoutMachine: import('xstate').StateMachine<CheckoutMachineContext, import('./checkout/types').ChangeStepEvent | import('./checkout/types').PlaceOrderEvent | import('./checkout/types').ResetCheckoutEvent | import('./checkout/types').SubmitStepDataEvent | import('xstate').DoneActorEvent<import('./checkout/types').PlaceOrderSuccessEvent, string> | import('xstate').DoneActorEvent<import('./checkout/types').SubmitStepDataSuccessEvent, string>, {
+    [x: string]: import('xstate').ActorRefFromLogic<import('xstate').PromiseActorLogic<import('./checkout/types').PlaceOrderSuccessEvent, import('./checkout/actors').PlaceOrderDataInput, import('xstate').EventObject>> | import('xstate').ActorRefFromLogic<import('xstate').PromiseActorLogic<import('./checkout/types').SubmitStepDataSuccessEvent, import('./checkout/actors').SubmitStepDataInput, import('xstate').EventObject>> | undefined;
+}, {
+    src: "placeOrder";
+    logic: import('xstate').PromiseActorLogic<import('./checkout/types').PlaceOrderSuccessEvent, import('./checkout/actors').PlaceOrderDataInput, import('xstate').EventObject>;
+    id: string | undefined;
+} | {
+    src: "submitStepData";
+    logic: import('xstate').PromiseActorLogic<import('./checkout/types').SubmitStepDataSuccessEvent, import('./checkout/actors').SubmitStepDataInput, import('xstate').EventObject>;
+    id: string | undefined;
+}, {
+    type: "changeStep";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "nextStep";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "resetCheckout";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "updateQuote";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "updateSuccessId";
+    params: import('xstate').NonReducibleUnknown;
+}, {
+    type: "quoteExists";
+    params: unknown;
+}, never, "uninitialized" | "initializing" | "showStep" | "submittingStepData" | "changingStep" | "placingOrder" | "success", string, {
+    initialContext: DeepPartial<CheckoutMachineContext>;
+    initialState?: string;
+}, import('xstate').NonReducibleUnknown, import('xstate').EventObject, import('xstate').MetaObject, {
+    id: "checkout";
+    states: {
+        readonly uninitialized: {};
+        readonly initializing: {};
+        readonly showStep: {};
+        readonly submittingStepData: {};
+        readonly changingStep: {};
+        readonly placingOrder: {};
+        readonly success: {};
+    };
+}>;
+export default checkoutMachine;

package/quote/quote/actions/addItems.d.ts

@@ -0,0 +1,217 @@
+import { QuoteMachineContext, QuoteMachineEvents } from '../types';
+export declare function addItems({ context, event, }: {
+    context: QuoteMachineContext;
+    event: QuoteMachineEvents;
+}): QuoteMachineContext | {
+    quote: {
+        quote?: Partial<{
+            id: string | null;
+            accessToken: string | null;
+            locale: string | null;
+            checkoutSteps: Array<import('../types').CheckoutStep>;
+            baseCurrency: string | null;
+            currency: string | null;
+            currencyConversionRate: number | null;
+            dateCreated: Date | null;
+            dateLastUpdated: Date | null;
+            items: Array<Record<string, any>> | null;
+            promotions: Array<Record<string, any>> | null;
+            shippingAddresses: {
+                available: Array<import('../types').QuoteAddress>;
+                applied: Array<{
+                    availableAddressId?: string;
+                    address: import('../types').QuoteAddress;
+                    itemIds: Array<Record<string, any>>;
+                }>;
+            };
+            paymentMethods: {
+                available: Array<import('../types').PaymentMethod>;
+                applied: Array<{
+                    paymentMethod: import('../types').PaymentMethod;
+                    options: Array<Record<string, any>>;
+                    amount: number;
+                }>;
+            };
+            shipments: Array<{
+                id: string;
+                shippingAddress: {
+                    id: string;
+                    address: import('../types').QuoteAddress;
+                };
+                items: Array<Record<string, any>>;
+                shippingMethods: {
+                    available: Array<{
+                        shippingMethod: {
+                            id: string;
+                            code: string;
+                            name: string;
+                            carrier: {
+                                id: string;
+                                code: string;
+                                name: string;
+                            };
+                        };
+                        estimatedTotal: number;
+                        earliestShipDate: Date;
+                        latestShipDate: Date;
+                        earliestArrivalDate: Date;
+                        latestArrivalDate: Date;
+                    }>;
+                    applied: {
+                        shippingMethod: {
+                            id: string;
+                            code: string;
+                            name: string;
+                            carrier: {
+                                id: string;
+                                code: string;
+                                name: string;
+                            };
+                        };
+                        estimatedTotal: number;
+                        earliestShipDate: Date;
+                        latestShipDate: Date;
+                        earliestArrivalDate: Date;
+                        latestArrivalDate: Date;
+                    };
+                };
+            }>;
+            totals: {
+                discount: number;
+                taxAmount: number;
+                shippingAmount: number;
+                shippingTaxAmount: number;
+                subtotal: number;
+                grandTotal: number;
+            } | null;
+            appliedPriceRules: Array<Record<string, any>> | null;
+            appliedPromotions: Array<Record<string, any>> | null;
+            shippingMethods: Array<Record<string, any>> | null;
+            storeCredit: Array<Record<string, any>> | null;
+            rewards: Array<Record<string, any>> | null;
+            giftCards: Array<Record<string, any>> | null;
+            user: {
+                id: string | null;
+                email: string | null;
+                firstName: string | null;
+                lastName: string | null;
+            } | null;
+        }> | undefined;
+        errors?: string[] | undefined;
+        endpoints?: {
+            client?: string;
+            server?: string;
+        } | undefined;
+        graphql?: {
+            refresh: {
+                document: import('graphql-request').RequestDocument | import('@graphql-typed-document-node/core').TypedDocumentNode<unknown, object>;
+                requestHeaders?: import('graphql-request/build/esm/types').GraphQLClientRequestHeaders | undefined;
+            };
+            addItems: {
+                document: import('graphql-request').RequestDocument | import('@graphql-typed-document-node/core').TypedDocumentNode<unknown, object>;
+                requestHeaders?: import('graphql-request/build/esm/types').GraphQLClientRequestHeaders | undefined;
+            };
+            removeItems: {
+                document: import('graphql-request').RequestDocument | import('@graphql-typed-document-node/core').TypedDocumentNode<unknown, object>;
+                requestHeaders?: import('graphql-request/build/esm/types').GraphQLClientRequestHeaders | undefined;
+            };
+            updateItems: {
+                document: import('graphql-request').RequestDocument | import('@graphql-typed-document-node/core').TypedDocumentNode<unknown, object>;
+                requestHeaders?: import('graphql-request/build/esm/types').GraphQLClientRequestHeaders | undefined;
+            };
+        } | undefined;
+        id?: string | null | undefined;
+        accessToken?: string | null | undefined;
+        locale?: string | null | undefined;
+        checkoutSteps?: import('../types').CheckoutStep[] | undefined;
+        baseCurrency?: string | null | undefined;
+        currency?: string | null | undefined;
+        currencyConversionRate?: number | null | undefined;
+        dateCreated?: Date | null | undefined;
+        dateLastUpdated?: Date | null | undefined;
+        items?: Record<string, any>[] | null | undefined;
+        promotions?: Record<string, any>[] | null | undefined;
+        shippingAddresses?: {
+            available: Array<import('../types').QuoteAddress>;
+            applied: Array<{
+                availableAddressId?: string;
+                address: import('../types').QuoteAddress;
+                itemIds: Array<Record<string, any>>;
+            }>;
+        } | undefined;
+        paymentMethods?: {
+            available: Array<import('../types').PaymentMethod>;
+            applied: Array<{
+                paymentMethod: import('../types').PaymentMethod;
+                options: Array<Record<string, any>>;
+                amount: number;
+            }>;
+        } | undefined;
+        shipments?: {
+            id: string;
+            shippingAddress: {
+                id: string;
+                address: import('../types').QuoteAddress;
+            };
+            items: Array<Record<string, any>>;
+            shippingMethods: {
+                available: Array<{
+                    shippingMethod: {
+                        id: string;
+                        code: string;
+                        name: string;
+                        carrier: {
+                            id: string;
+                            code: string;
+                            name: string;
+                        };
+                    };
+                    estimatedTotal: number;
+                    earliestShipDate: Date;
+                    latestShipDate: Date;
+                    earliestArrivalDate: Date;
+                    latestArrivalDate: Date;
+                }>;
+                applied: {
+                    shippingMethod: {
+                        id: string;
+                        code: string;
+                        name: string;
+                        carrier: {
+                            id: string;
+                            code: string;
+                            name: string;
+                        };
+                    };
+                    estimatedTotal: number;
+                    earliestShipDate: Date;
+                    latestShipDate: Date;
+                    earliestArrivalDate: Date;
+                    latestArrivalDate: Date;
+                };
+            };
+        }[] | undefined;
+        totals?: {
+            discount: number;
+            taxAmount: number;
+            shippingAmount: number;
+            shippingTaxAmount: number;
+            subtotal: number;
+            grandTotal: number;
+        } | null | undefined;
+        appliedPriceRules?: Record<string, any>[] | null | undefined;
+        appliedPromotions?: Record<string, any>[] | null | undefined;
+        shippingMethods?: Record<string, any>[] | null | undefined;
+        storeCredit?: Record<string, any>[] | null | undefined;
+        rewards?: Record<string, any>[] | null | undefined;
+        giftCards?: Record<string, any>[] | null | undefined;
+        user?: {
+            id: string | null;
+            email: string | null;
+            firstName: string | null;
+            lastName: string | null;
+        } | null | undefined;
+    };
+    itemsAdded: Record<string, any>[] | null | undefined;
+};
+export default addItems;

package/quote/quote/actions/index.d.ts

@@ -0,0 +1,9 @@
+export * from './addItems';
+export * from './notifyAddItems';
+export * from './notifyRemoveItems';
+export * from './notifyUpdateItems';
+export * from './removeItems';
+export * from './refresh';
+export * from './reset';
+export * from './syncAccessToken';
+export * from './updateItems';

package/quote/quote/actions/notifyAddItems.d.ts

@@ -0,0 +1,6 @@
+import { AddItemsEmittedEvent, QuoteMachineContext, QuoteMachineEvents } from '../types';
+export declare function notifyAddItems({ event, }: {
+    context: QuoteMachineContext;
+    event: QuoteMachineEvents;
+}): AddItemsEmittedEvent;
+export default notifyAddItems;

package/quote/quote/actions/notifyRemoveItems.d.ts

@@ -0,0 +1,6 @@
+import { RemoveItemsEmittedEvent, QuoteMachineContext, QuoteMachineEvents } from '../types';
+export declare function notifyRemoveItems({ event, }: {
+    context: QuoteMachineContext;
+    event: QuoteMachineEvents;
+}): RemoveItemsEmittedEvent;
+export default notifyRemoveItems;

package/quote/quote/actions/notifyUpdateItems.d.ts

@@ -0,0 +1,6 @@
+import { UpdateItemsEmittedEvent, QuoteMachineContext, QuoteMachineEvents } from '../types';
+export declare function notifyUpdateItems({ event, }: {
+    context: QuoteMachineContext;
+    event: QuoteMachineEvents;
+}): UpdateItemsEmittedEvent;
+export default notifyUpdateItems;