@clicktap/state 0.13.18 → 0.14.0

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>;
+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,36 @@
+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 } from '../quote/types';
+export interface CheckoutStep {
+    name: string;
+    prev: string | null;
+    next: string | null;
+}
+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;
+    };
+    graphql: {
+        submitStepData: {
+            document: RequestDocument | TypedDocumentNode<unknown, {}>;
+            requestHeaders?: GraphQLClientRequestHeaders;
+        };
+    };
+}
+export interface SubmitStepDataEvent {
+    type: 'SUBMIT_STEP_DATA';
+    data: Record<string, any>;
+}
+export interface SubmitStepDataSuccessEvent {
+    type: 'SUBMIT_STEP_DATA_SUCCESS';
+    quote: Partial<QuoteMachineContext>;
+}
+export type CheckoutMachineEvents = SubmitStepDataEvent | DoneActorEvent<SubmitStepDataSuccessEvent>;

package/quote/checkout.d.ts

@@ -0,0 +1,32 @@
+import { CheckoutMachineContext } from './checkout/types';
+import { DeepPartial } from './types';
+export declare const checkoutMachine: import("xstate").StateMachine<CheckoutMachineContext, import("./checkout/types").SubmitStepDataEvent | import("xstate").DoneActorEvent<import("./checkout/types").SubmitStepDataSuccessEvent>, {
+    [x: string]: import("xstate").ActorRef<import("xstate").PromiseSnapshot<import("./checkout/types").SubmitStepDataSuccessEvent, import("./checkout/actors").SubmitStepDataInput>, {
+        [k: string]: unknown;
+        type: string;
+    }, import("xstate").EventObject> | undefined;
+}, {
+    src: "submitStepData";
+    logic: import("xstate").PromiseActorLogic<import("./checkout/types").SubmitStepDataSuccessEvent, import("./checkout/actors").SubmitStepDataInput>;
+    id: string | undefined;
+}, {
+    type: "nextStep";
+    params: import("xstate").NonReducibleUnknown;
+}, {
+    type: "quoteExists";
+    params: unknown;
+}, never, "uninitialized" | "initializing" | "showStep" | "submittingStepData" | "changingStep", string, {
+    initialContext: DeepPartial<CheckoutMachineContext>;
+    initialState?: string | undefined;
+}, import("xstate").NonReducibleUnknown, import("xstate").EventObject, import("xstate").MetaObject, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, import("./checkout/types").SubmitStepDataEvent | import("xstate").DoneActorEvent<import("./checkout/types").SubmitStepDataSuccessEvent>, {
+    src: "submitStepData";
+    logic: import("xstate").PromiseActorLogic<import("./checkout/types").SubmitStepDataSuccessEvent, import("./checkout/actors").SubmitStepDataInput>;
+    id: string | undefined;
+}, {
+    type: "nextStep";
+    params: import("xstate").NonReducibleUnknown;
+}, {
+    type: "quoteExists";
+    params: unknown;
+}, never, string, import("xstate").EventObject>>;
+export default checkoutMachine;

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

@@ -0,0 +1,211 @@
+import { QuoteMachineContext, QuoteMachineEvents } from '../types';
+export declare function addItems({ context, event, }: {
+    context: QuoteMachineContext;
+    event: QuoteMachineEvents;
+}): QuoteMachineContext | {
+    quote: {
+        quote?: Partial<{
+            id: string | null;
+            locale: string | null;
+            baseCurrency: string | null;
+            currency: string | null;
+            currencyConversionRate: number | null;
+            dateCreated: Date | null;
+            dateLastUpdated: Date | null;
+            items: Record<string, any>[] | null;
+            promotions: Record<string, any>[] | null;
+            shippingAddresses: {
+                available: import("../types").QuoteAddress[];
+                applied: (import("../types").QuoteAddress & {
+                    availableAddressId?: string | undefined;
+                    itemIds: Record<string, any>[];
+                })[];
+            };
+            paymentMethods: {
+                available: import("../types").PaymentMethod[];
+                applied: {
+                    paymentMethod: import("../types").PaymentMethod;
+                    options: Record<string, any>[];
+                    amount: number;
+                }[];
+            };
+            shipments: {
+                id: string;
+                shippingAddress: {
+                    id: string;
+                    address: import("../types").QuoteAddress;
+                };
+                items: Record<string, any>[];
+                shippingMethods: {
+                    available: {
+                        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;
+                tax: number;
+                shipping: number;
+                shippingTax: number;
+                subtotal: number;
+                grandTotal: number;
+            } | null;
+            appliedPriceRules: Record<string, any>[] | null;
+            appliedPromotions: Record<string, any>[] | null;
+            shippingMethods: Record<string, any>[] | null;
+            storeCredit: Record<string, any>[] | null;
+            rewards: Record<string, any>[] | null;
+            giftCards: 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 | undefined;
+            server?: string | undefined;
+        } | undefined;
+        graphql?: {
+            refresh: {
+                document: import("graphql-request").RequestDocument | import("@graphql-typed-document-node/core").TypedDocumentNode<unknown, {}>;
+                requestHeaders?: import("graphql-request/build/esm/types").GraphQLClientRequestHeaders | undefined;
+            };
+            addItems: {
+                document: import("graphql-request").RequestDocument | import("@graphql-typed-document-node/core").TypedDocumentNode<unknown, {}>;
+                requestHeaders?: import("graphql-request/build/esm/types").GraphQLClientRequestHeaders | undefined;
+            };
+            removeItems: {
+                document: import("graphql-request").RequestDocument | import("@graphql-typed-document-node/core").TypedDocumentNode<unknown, {}>;
+                requestHeaders?: import("graphql-request/build/esm/types").GraphQLClientRequestHeaders | undefined;
+            };
+            updateItems: {
+                document: import("graphql-request").RequestDocument | import("@graphql-typed-document-node/core").TypedDocumentNode<unknown, {}>;
+                requestHeaders?: import("graphql-request/build/esm/types").GraphQLClientRequestHeaders | undefined;
+            };
+        } | undefined;
+        id?: string | null | undefined;
+        locale?: string | null | 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: import("../types").QuoteAddress[];
+            applied: (import("../types").QuoteAddress & {
+                availableAddressId?: string | undefined;
+                itemIds: Record<string, any>[];
+            })[];
+        } | undefined;
+        paymentMethods?: {
+            available: import("../types").PaymentMethod[];
+            applied: {
+                paymentMethod: import("../types").PaymentMethod;
+                options: Record<string, any>[];
+                amount: number;
+            }[];
+        } | undefined;
+        shipments?: {
+            id: string;
+            shippingAddress: {
+                id: string;
+                address: import("../types").QuoteAddress;
+            };
+            items: Record<string, any>[];
+            shippingMethods: {
+                available: {
+                    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;
+            tax: number;
+            shipping: number;
+            shippingTax: 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/refresh.d.ts

@@ -0,0 +1,210 @@
+import { QuoteMachineContext, QuoteMachineEvents } from '../types';
+export declare function refresh({ context, event, }: {
+    context: QuoteMachineContext;
+    event: QuoteMachineEvents;
+}): QuoteMachineContext | {
+    quote: {
+        quote?: Partial<{
+            id: string | null;
+            locale: string | null;
+            baseCurrency: string | null;
+            currency: string | null;
+            currencyConversionRate: number | null;
+            dateCreated: Date | null;
+            dateLastUpdated: Date | null;
+            items: Record<string, any>[] | null;
+            promotions: Record<string, any>[] | null;
+            shippingAddresses: {
+                available: import("../types").QuoteAddress[];
+                applied: (import("../types").QuoteAddress & {
+                    availableAddressId?: string | undefined;
+                    itemIds: Record<string, any>[];
+                })[];
+            };
+            paymentMethods: {
+                available: import("../types").PaymentMethod[];
+                applied: {
+                    paymentMethod: import("../types").PaymentMethod;
+                    options: Record<string, any>[];
+                    amount: number;
+                }[];
+            };
+            shipments: {
+                id: string;
+                shippingAddress: {
+                    id: string;
+                    address: import("../types").QuoteAddress;
+                };
+                items: Record<string, any>[];
+                shippingMethods: {
+                    available: {
+                        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;
+                tax: number;
+                shipping: number;
+                shippingTax: number;
+                subtotal: number;
+                grandTotal: number;
+            } | null;
+            appliedPriceRules: Record<string, any>[] | null;
+            appliedPromotions: Record<string, any>[] | null;
+            shippingMethods: Record<string, any>[] | null;
+            storeCredit: Record<string, any>[] | null;
+            rewards: Record<string, any>[] | null;
+            giftCards: 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 | undefined;
+            server?: string | undefined;
+        } | undefined;
+        graphql?: {
+            refresh: {
+                document: import("graphql-request").RequestDocument | import("@graphql-typed-document-node/core").TypedDocumentNode<unknown, {}>;
+                requestHeaders?: import("graphql-request/build/esm/types").GraphQLClientRequestHeaders | undefined;
+            };
+            addItems: {
+                document: import("graphql-request").RequestDocument | import("@graphql-typed-document-node/core").TypedDocumentNode<unknown, {}>;
+                requestHeaders?: import("graphql-request/build/esm/types").GraphQLClientRequestHeaders | undefined;
+            };
+            removeItems: {
+                document: import("graphql-request").RequestDocument | import("@graphql-typed-document-node/core").TypedDocumentNode<unknown, {}>;
+                requestHeaders?: import("graphql-request/build/esm/types").GraphQLClientRequestHeaders | undefined;
+            };
+            updateItems: {
+                document: import("graphql-request").RequestDocument | import("@graphql-typed-document-node/core").TypedDocumentNode<unknown, {}>;
+                requestHeaders?: import("graphql-request/build/esm/types").GraphQLClientRequestHeaders | undefined;
+            };
+        } | undefined;
+        id?: string | null | undefined;
+        locale?: string | null | 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: import("../types").QuoteAddress[];
+            applied: (import("../types").QuoteAddress & {
+                availableAddressId?: string | undefined;
+                itemIds: Record<string, any>[];
+            })[];
+        } | undefined;
+        paymentMethods?: {
+            available: import("../types").PaymentMethod[];
+            applied: {
+                paymentMethod: import("../types").PaymentMethod;
+                options: Record<string, any>[];
+                amount: number;
+            }[];
+        } | undefined;
+        shipments?: {
+            id: string;
+            shippingAddress: {
+                id: string;
+                address: import("../types").QuoteAddress;
+            };
+            items: Record<string, any>[];
+            shippingMethods: {
+                available: {
+                    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;
+            tax: number;
+            shipping: number;
+            shippingTax: 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 refresh;