@clicktap/state 0.16.0 → 0.16.2

package/quote/quote/actions/updateItems.d.ts

@@ -1,217 +0,0 @@
-import { QuoteMachineContext, QuoteMachineEvents } from '../types';
-export declare function updateItems({ context, event, }: {
-    context: QuoteMachineContext;
-    event: QuoteMachineEvents;
-}): QuoteMachineContext | {
-    quote: {
-        quote?: Partial<{
-            id: string | null;
-            accessToken: string | null;
-            locale: string | null;
-            checkoutSteps: import("../types").CheckoutStep[];
-            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: {
-                    availableAddressId?: string | undefined;
-                    address: import("../types").QuoteAddress;
-                    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;
-                taxAmount: number;
-                shippingAmount: number;
-                shippingTaxAmount: 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;
-        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: import("../types").QuoteAddress[];
-            applied: {
-                availableAddressId?: string | undefined;
-                address: import("../types").QuoteAddress;
-                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;
-            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;
-    };
-    itemsUpdated: Record<string, any>[] | null | undefined;
-};
-export default updateItems;

package/quote/quote/actors/addItems.d.ts

@@ -1,24 +0,0 @@
-import { AddItemsEvent, AddItemsSuccessEvent, QuoteMachineContext } from '../types';
-export type AddItemsInput = {
-    accessToken: QuoteMachineContext['quote']['accessToken'];
-    endpoint: QuoteMachineContext['endpoints']['client'];
-    items: AddItemsEvent['items'];
-    document: QuoteMachineContext['graphql']['addItems']['document'];
-    requestHeaders?: QuoteMachineContext['graphql']['addItems']['requestHeaders'];
-};
-export type AddItemsOutput = Partial<{
-    quoteAddItem: {
-        quote: object;
-        itemsAdded: Array<{
-            item: Array<Record<string, any>>;
-            previousQuantity: number;
-        }>;
-        userErrors: Array<{
-            code: string;
-            field: string;
-            message: string;
-        }>;
-    };
-}>;
-export declare const addItems: import("xstate").PromiseActorLogic<AddItemsSuccessEvent, AddItemsInput>;
-export default addItems;

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

@@ -1,4 +0,0 @@
-export * from './addItems';
-export * from './removeItems';
-export * from './refresh';
-export * from './updateItems';

package/quote/quote/actors/refresh.d.ts

@@ -1,22 +0,0 @@
-import { RefreshSuccessEvent, QuoteMachineContext } from '../types';
-export type RefreshInput = {
-    accessToken: QuoteMachineContext['quote']['accessToken'];
-    endpoint: QuoteMachineContext['endpoints']['client'];
-    endpointSsr: QuoteMachineContext['endpoints']['server'];
-    quoteId: QuoteMachineContext['quote']['id'];
-    locale: QuoteMachineContext['quote']['locale'];
-    document: QuoteMachineContext['graphql']['refresh']['document'];
-    requestHeaders?: QuoteMachineContext['graphql']['refresh']['requestHeaders'];
-};
-export type RefreshOutput = Partial<{
-    refreshQuote: {
-        quote: object;
-        userErrors: Array<{
-            code: string;
-            field: string;
-            message: string;
-        }>;
-    };
-}>;
-export declare const refresh: import("xstate").PromiseActorLogic<RefreshSuccessEvent, RefreshInput>;
-export default refresh;

package/quote/quote/actors/removeItems.d.ts

@@ -1,24 +0,0 @@
-import { RemoveItemsEvent, RemoveItemsSuccessEvent, QuoteMachineContext } from '../types';
-export type RemoveItemsInput = {
-    accessToken: QuoteMachineContext['quote']['accessToken'];
-    endpoint: QuoteMachineContext['endpoints']['client'];
-    items: RemoveItemsEvent['items'];
-    document: QuoteMachineContext['graphql']['removeItems']['document'];
-    requestHeaders?: QuoteMachineContext['graphql']['removeItems']['requestHeaders'];
-};
-export type RemoveItemsOutput = Partial<{
-    quoteRemoveItem: {
-        quote: object;
-        itemsRemoved: Array<{
-            item: Array<Record<string, any>>;
-            previousQuantity: number;
-        }>;
-        userErrors: Array<{
-            code: string;
-            field: string;
-            message: string;
-        }>;
-    };
-}>;
-export declare const removeItems: import("xstate").PromiseActorLogic<RemoveItemsSuccessEvent, RemoveItemsInput>;
-export default removeItems;

package/quote/quote/actors/updateItems.d.ts

@@ -1,24 +0,0 @@
-import { UpdateItemsEvent, UpdateItemsSuccessEvent, QuoteMachineContext } from '../types';
-export type UpdateItemsInput = {
-    accessToken: QuoteMachineContext['quote']['accessToken'];
-    endpoint: QuoteMachineContext['endpoints']['client'];
-    items: UpdateItemsEvent['items'];
-    document: QuoteMachineContext['graphql']['updateItems']['document'];
-    requestHeaders?: QuoteMachineContext['graphql']['updateItems']['requestHeaders'];
-};
-export type UpdateItemsOutput = Partial<{
-    quoteUpdateItem: {
-        quote: object;
-        itemsUpdated: Array<{
-            item: Array<Record<string, any>>;
-            previousQuantity: number;
-        }>;
-        userErrors: Array<{
-            code: string;
-            field: string;
-            message: string;
-        }>;
-    };
-}>;
-export declare const updateItems: import("xstate").PromiseActorLogic<UpdateItemsSuccessEvent, UpdateItemsInput>;
-export default updateItems;

package/quote/quote/guards/canRefresh.d.ts

@@ -1,10 +0,0 @@
-import { QuoteMachineContext } from '../types';
-/**
- * Used for initializing quote.
- * Allow quote to be refreshed if on server side and quote cookie present OR
- * if on client side regardless of quote cookie
- */
-export declare const canRefresh: ({ context }: {
-    context: QuoteMachineContext;
-}) => boolean;
-export default canRefresh;

package/quote/quote/guards/hasItems.d.ts

@@ -1,5 +0,0 @@
-import { QuoteMachineContext } from '../types';
-export declare const hasItems: ({ context }: {
-    context: QuoteMachineContext;
-}) => boolean;
-export default hasItems;

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

@@ -1,2 +0,0 @@
-export * from './canRefresh';
-export * from './hasItems';

package/quote/quote/types.d.ts

@@ -1,291 +0,0 @@
-import { TypedDocumentNode } from '@graphql-typed-document-node/core';
-import { RequestDocument } from 'graphql-request';
-import { GraphQLClientRequestHeaders } from 'graphql-request/build/esm/types';
-import { DoneActorEvent } from 'xstate';
-/** @todo how do we want to handle quote items? */
-export type QuoteAddress = {
-    id?: string;
-    country: {
-        code: string;
-        name: string;
-    };
-    firstName: string;
-    lastName: string;
-    company?: string;
-    addressLine1: string;
-    addressLine2?: string;
-    city: string;
-    region: {
-        code: string;
-        shortCode: string;
-        name: string;
-    };
-    postalCode: string;
-    phone?: string;
-    availableAddress?: {
-        id?: string;
-        isDefault?: boolean;
-    };
-};
-export type PaymentMethod = {
-    id: string;
-    code: string;
-    name: string;
-    sortOrder: number;
-};
-export type CheckoutStep = {
-    code: string;
-    name: string;
-    isAvailable: boolean;
-    isComplete: boolean;
-    prev?: string;
-    next?: string;
-};
-export interface QuoteMachineContext {
-    quote: Partial<{
-        id: string | null;
-        accessToken: string | null;
-        locale: string | null;
-        checkoutSteps: Array<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<QuoteAddress>;
-            applied: Array<{
-                availableAddressId?: string;
-                address: QuoteAddress;
-                itemIds: Array<Record<string, any>>;
-            }>;
-        };
-        paymentMethods: {
-            available: Array<PaymentMethod>;
-            applied: Array<{
-                paymentMethod: PaymentMethod;
-                options: Array<Record<string, any>>;
-                amount: number;
-            }>;
-        };
-        shipments: Array<{
-            id: string;
-            shippingAddress: {
-                id: string;
-                address: 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;
-    }>;
-    errors: Array<string>;
-    endpoints: {
-        client?: string;
-        server?: string;
-    };
-    graphql: {
-        refresh: {
-            document: RequestDocument | TypedDocumentNode<unknown, {}>;
-            requestHeaders?: GraphQLClientRequestHeaders | undefined;
-        };
-        addItems: {
-            document: RequestDocument | TypedDocumentNode<unknown, {}>;
-            requestHeaders?: GraphQLClientRequestHeaders | undefined;
-        };
-        removeItems: {
-            document: RequestDocument | TypedDocumentNode<unknown, {}>;
-            requestHeaders?: GraphQLClientRequestHeaders | undefined;
-        };
-        updateItems: {
-            document: RequestDocument | TypedDocumentNode<unknown, {}>;
-            requestHeaders?: GraphQLClientRequestHeaders | undefined;
-        };
-    };
-}
-export interface SetQuoteEmptyEvent {
-    type: 'SET_EMPTY';
-}
-export interface SetQuoteActiveEvent {
-    type: 'SET_ACTIVE';
-}
-export interface AddItemsEvent {
-    type: 'ADD_ITEMS';
-    items: Array<{
-        product: {
-            sku: string;
-        };
-        quantity: number;
-    }>;
-}
-export interface RemoveItemsEvent {
-    type: 'REMOVE_ITEMS';
-    items: Array<{
-        product: {
-            sku: string;
-        };
-        quantity: number;
-    }>;
-}
-export interface UpdateItemsEvent {
-    type: 'UPDATE_ITEMS';
-    items: Array<{
-        item: {
-            id: string;
-        };
-        quantity: number;
-    }>;
-}
-export interface ClearItemsEvent {
-    type: 'CLEAR_ITEMS';
-}
-export interface RefreshEvent {
-    type: 'REFRESH';
-}
-export interface ResetEvent {
-    type: 'RESET';
-    data: {
-        locale: string;
-    };
-}
-export interface ApplyPromotionEvent {
-    type: 'APPLY_PROMOTION';
-}
-export interface RemovePromotionEvent {
-    type: 'REMOVE_PROMOTION';
-}
-export interface AddAddressEvent {
-    type: 'ADD_ADDRESS';
-}
-export interface RemoveAddressEvent {
-    type: 'REMOVE_ADDRESS';
-}
-export interface ApplyPaymentMethodEvent {
-    type: 'APPLY_PAYMENT_METHOD';
-}
-export interface AddRewardEvent {
-    type: 'ADD_REWARD';
-}
-export interface RemoveRewardEvent {
-    type: 'REMOVE_REWARD';
-}
-export interface AddStoreCreditEvent {
-    type: 'ADD_STORE_CREDIT';
-}
-export interface RemoveStoreCreditEvent {
-    type: 'REMOVE_STORE_CREDIT';
-}
-export interface AddGiftCardEvent {
-    type: 'ADD_GIFT_CARD';
-}
-export interface RemoveGiftCardEvent {
-    type: 'REMOVE_GIFT_CARD';
-}
-export interface AddItemsSuccessEvent {
-    type: 'ADD_ITEMS_SUCCESS';
-    quote: Partial<QuoteMachineContext>;
-    itemsAdded: QuoteMachineContext['quote']['items'];
-}
-export interface RemoveItemsSuccessEvent {
-    type: 'REMOVE_ITEMS_SUCCESS';
-    quote: Partial<QuoteMachineContext>;
-    itemsRemoved: QuoteMachineContext['quote']['items'];
-}
-export interface UpdateItemsSuccessEvent {
-    type: 'UPDATE_ITEMS_SUCCESS';
-    quote: Partial<QuoteMachineContext>;
-    itemsUpdated: QuoteMachineContext['quote']['items'];
-}
-export interface ClearItemsSuccessEvent {
-    type: 'CLEAR_ITEMS_SUCCESS';
-}
-export interface RefreshSuccessEvent {
-    type: 'REFRESH_SUCCESS';
-    quote: Partial<QuoteMachineContext>;
-}
-export interface SyncAccessTokenEvent {
-    type: 'SYNC_ACCESS_TOKEN';
-    accessToken: string;
-}
-export type QuoteMachineEvents = SetQuoteEmptyEvent | SetQuoteActiveEvent | AddItemsEvent | RemoveItemsEvent | UpdateItemsEvent | ClearItemsEvent | RefreshEvent | ResetEvent | ApplyPromotionEvent | RemovePromotionEvent | AddAddressEvent | RemoveAddressEvent | ApplyPaymentMethodEvent | AddRewardEvent | RemoveRewardEvent | AddStoreCreditEvent | RemoveStoreCreditEvent | AddGiftCardEvent | RemoveGiftCardEvent | SyncAccessTokenEvent | DoneActorEvent<AddItemsSuccessEvent> | DoneActorEvent<RemoveItemsSuccessEvent> | DoneActorEvent<UpdateItemsSuccessEvent> | DoneActorEvent<ClearItemsSuccessEvent> | DoneActorEvent<RefreshSuccessEvent>;
-export interface AddItemsEmittedEvent {
-    type: 'EMIT_ADD_ITEMS';
-    itemsAdded: QuoteMachineContext['quote']['items'];
-}
-export interface RemoveItemsEmittedEvent {
-    type: 'EMIT_REMOVE_ITEMS';
-    itemsRemoved: QuoteMachineContext['quote']['items'];
-}
-export interface UpdateItemsEmittedEvent {
-    type: 'EMIT_UPDATE_ITEMS';
-    itemsUpdated: QuoteMachineContext['quote']['items'];
-}
-export type QuoteMachineEmittedEvents = AddItemsEmittedEvent | RemoveItemsEmittedEvent | UpdateItemsEmittedEvent;
-export type AddItemsResponse = {
-    message?: string;
-    success: boolean;
-};
-export type RemoveItemsResponse = {
-    message?: string;
-    success: boolean;
-};
-export type RefreshResponse = {
-    message?: string;
-    success: boolean;
-};