@clicktap/state 0.8.0 → 0.9.0

package/index.esm.js

@@ -488,9 +488,15 @@ var useUser = function useUser() {
  */
 var getAuth = function getAuth() {
   var refreshToken = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
-  var options
-  // eslint-disable-next-line @typescript-eslint/require-await
-  = arguments.length > 1 ? arguments[1] : undefined;
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
+    inspect: undefined,
+    endpoints: {
+      login: '',
+      logout: '',
+      refresh: '',
+      ssrRefresh: ''
+    }
+  };
   return __awaiter(void 0, void 0, void 0, /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clicktap/state",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "private": false,
   "author": "Clicktap",
   "description": "A state management library for Clicktap reference frontend.",

package/src/auth/AuthProvider.d.ts

@@ -290,7 +290,7 @@ type AuthOptions = {
  * @todo should probably update signature to pass Partial<AuthContext> and
  * Options, endpoints should probably be moved into context
  */
-export declare const getAuth: (refreshToken: string | undefined, options: AuthOptions) => Promise<Actor<import("xstate").StateMachine<import("./auth").AuthMachineContext, import("./auth").RefreshTokenEvent | import("./auth").LoginEvent | import("./auth").LogoutEvent | import("./auth").ClearErrorsEvent | import("xstate").DoneActorEvent<import("./auth").AuthenticateSuccessEvent> | import("xstate").DoneActorEvent<import("./auth").RefreshTokenSuccessEvent>, {
+export declare const getAuth: (refreshToken?: string, options?: AuthOptions) => Promise<Actor<import("xstate").StateMachine<import("./auth").AuthMachineContext, import("./auth").RefreshTokenEvent | import("./auth").LoginEvent | import("./auth").LogoutEvent | import("./auth").ClearErrorsEvent | import("xstate").DoneActorEvent<import("./auth").AuthenticateSuccessEvent> | import("xstate").DoneActorEvent<import("./auth").RefreshTokenSuccessEvent>, {
     [x: string]: import("xstate").ActorRef<import("xstate").PromiseSnapshot<{
         type: string;
         accessToken: string;

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

@@ -0,0 +1,8 @@
+import { QuoteMachineContext, QuoteMachineEvents } from '../types';
+export declare function addItems({ context, event, }: {
+    context: QuoteMachineContext;
+    event: QuoteMachineEvents;
+}): QuoteMachineContext | {
+    items: Record<string, any>[];
+};
+export default addItems;

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

@@ -0,0 +1,2 @@
+export * from './addItems';
+export * from './removeItems';

package/src/quote/actions/removeItems.d.ts

@@ -0,0 +1,8 @@
+import { QuoteMachineContext, QuoteMachineEvents } from '../types';
+export declare function removeItems({ context, event, }: {
+    context: QuoteMachineContext;
+    event: QuoteMachineEvents;
+}): QuoteMachineContext | {
+    items: Record<string, any>[];
+};
+export default removeItems;

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

@@ -0,0 +1,7 @@
+import { AddItemsEvent, AddItemsSuccessEvent, QuoteMachineContext } from '../types';
+export declare const addItems: import("xstate").PromiseActorLogic<AddItemsSuccessEvent, {
+    endpoint: QuoteMachineContext['endpoints']['addItems'];
+    items: AddItemsEvent['items'];
+    quoteId: QuoteMachineContext['quoteId'];
+}>;
+export default addItems;

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

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

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

@@ -0,0 +1,6 @@
+import { RefreshSuccessEvent, QuoteMachineContext } from '../types';
+export declare const refresh: import("xstate").PromiseActorLogic<RefreshSuccessEvent, {
+    endpoint: QuoteMachineContext['endpoints']['refresh'];
+    quoteId: QuoteMachineContext['quoteId'];
+}>;
+export default refresh;

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

@@ -0,0 +1,7 @@
+import { RemoveItemsEvent, RemoveItemsSuccessEvent, QuoteMachineContext } from '../types';
+export declare const removeItems: import("xstate").PromiseActorLogic<RemoveItemsSuccessEvent, {
+    endpoint: QuoteMachineContext['endpoints']['removeItems'];
+    items: RemoveItemsEvent['items'];
+    quoteId: QuoteMachineContext['quoteId'];
+}>;
+export default removeItems;

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

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

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

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

package/src/quote/quote.d.ts

@@ -0,0 +1,113 @@
+import type { QuoteMachineContext } from './types';
+export declare const quoteMachine: import("xstate").StateMachine<QuoteMachineContext, import("./types").SetEmptyEvent | import("./types").SetActiveEvent | import("./types").AddItemsEvent | import("./types").RemoveItemsEvent | import("./types").ClearItemsEvent | import("./types").RefreshEvent | import("./types").ApplyPromotionEvent | import("./types").RemovePromotionEvent | import("./types").AddAddressEvent | import("./types").RemoveAddressEvent | import("./types").ApplyPaymentMethodEvent | import("./types").AddRewardEvent | import("./types").RemoveRewardEvent | import("./types").AddStoreCreditEvent | import("./types").RemoveStoreCreditEvent | import("./types").AddGiftCardEvent | import("./types").RemoveGiftCardEvent | import("xstate").DoneActorEvent<import("./types").AddItemsSuccessEvent> | import("xstate").DoneActorEvent<import("./types").RemoveItemsSuccessEvent> | import("xstate").DoneActorEvent<import("./types").ClearItemsSuccessEvent> | import("xstate").DoneActorEvent<import("./types").RefreshSuccessEvent>, {
+    [x: string]: import("xstate").ActorRef<import("xstate").PromiseSnapshot<import("./types").AddItemsSuccessEvent, {
+        endpoint: "";
+        items: {
+            id: string;
+            quantity: number;
+            options: Record<string, any>;
+        }[];
+        quoteId: string;
+    }>, {
+        [k: string]: unknown;
+        type: string;
+    }> | import("xstate").ActorRef<import("xstate").PromiseSnapshot<import("./types").RemoveItemsSuccessEvent, {
+        endpoint: "";
+        items: {
+            id: string;
+            quantity: number;
+        }[];
+        quoteId: string;
+    }>, {
+        [k: string]: unknown;
+        type: string;
+    }> | import("xstate").ActorRef<import("xstate").PromiseSnapshot<import("./types").RefreshSuccessEvent, {
+        endpoint: "";
+        quoteId: string;
+    }>, {
+        [k: string]: unknown;
+        type: string;
+    }> | undefined;
+}, {
+    src: "addItems";
+    logic: import("xstate").PromiseActorLogic<import("./types").AddItemsSuccessEvent, {
+        endpoint: "";
+        items: {
+            id: string;
+            quantity: number;
+            options: Record<string, any>;
+        }[];
+        quoteId: string;
+    }>;
+    id: string | undefined;
+} | {
+    src: "removeItems";
+    logic: import("xstate").PromiseActorLogic<import("./types").RemoveItemsSuccessEvent, {
+        endpoint: "";
+        items: {
+            id: string;
+            quantity: number;
+        }[];
+        quoteId: string;
+    }>;
+    id: string | undefined;
+} | {
+    src: "refresh";
+    logic: import("xstate").PromiseActorLogic<import("./types").RefreshSuccessEvent, {
+        endpoint: "";
+        quoteId: string;
+    }>;
+    id: string | undefined;
+}, {
+    type: "addItems";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "removeItems";
+    params: import("xstate").NonReducibleUnknown;
+}, {
+    type: "hasItems";
+    params: unknown;
+}, string, {}, string, {
+    initialContext: Partial<QuoteMachineContext>;
+    initialState?: string | undefined;
+}, import("xstate").NonReducibleUnknown, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, import("./types").SetEmptyEvent | import("./types").SetActiveEvent | import("./types").AddItemsEvent | import("./types").RemoveItemsEvent | import("./types").ClearItemsEvent | import("./types").RefreshEvent | import("./types").ApplyPromotionEvent | import("./types").RemovePromotionEvent | import("./types").AddAddressEvent | import("./types").RemoveAddressEvent | import("./types").ApplyPaymentMethodEvent | import("./types").AddRewardEvent | import("./types").RemoveRewardEvent | import("./types").AddStoreCreditEvent | import("./types").RemoveStoreCreditEvent | import("./types").AddGiftCardEvent | import("./types").RemoveGiftCardEvent | import("xstate").DoneActorEvent<import("./types").AddItemsSuccessEvent> | import("xstate").DoneActorEvent<import("./types").RemoveItemsSuccessEvent> | import("xstate").DoneActorEvent<import("./types").ClearItemsSuccessEvent> | import("xstate").DoneActorEvent<import("./types").RefreshSuccessEvent>, {
+    src: "addItems";
+    logic: import("xstate").PromiseActorLogic<import("./types").AddItemsSuccessEvent, {
+        endpoint: "";
+        items: {
+            id: string;
+            quantity: number;
+            options: Record<string, any>;
+        }[];
+        quoteId: string;
+    }>;
+    id: string | undefined;
+} | {
+    src: "removeItems";
+    logic: import("xstate").PromiseActorLogic<import("./types").RemoveItemsSuccessEvent, {
+        endpoint: "";
+        items: {
+            id: string;
+            quantity: number;
+        }[];
+        quoteId: string;
+    }>;
+    id: string | undefined;
+} | {
+    src: "refresh";
+    logic: import("xstate").PromiseActorLogic<import("./types").RefreshSuccessEvent, {
+        endpoint: "";
+        quoteId: string;
+    }>;
+    id: string | undefined;
+}, {
+    type: "addItems";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "removeItems";
+    params: import("xstate").NonReducibleUnknown;
+}, {
+    type: "hasItems";
+    params: unknown;
+}, string, string>>;
+export default quoteMachine;

package/src/quote/types.d.ts

@@ -0,0 +1,135 @@
+import { DoneActorEvent } from 'xstate';
+/** @todo how do we want to handle quote items? */
+export interface QuoteMachineContext {
+    quoteId: string;
+    currency: string;
+    items: Array<Record<string, any>>;
+    promotions: Array<Record<string, any>>;
+    addresses: {
+        billing: {
+            available: Array<Record<string, any>>;
+        };
+        shipping: {
+            available: Array<Record<string, any>>;
+            selected: string | null;
+        };
+    };
+    totals: {
+        discount: number;
+        tax: number;
+        shipping: number;
+        shippingTax: number;
+        subtotal: number;
+        grandTotal: number;
+    };
+    payments: Array<Record<string, any>>;
+    storeCredit: Array<Record<string, any>>;
+    rewards: Array<Record<string, any>>;
+    giftCards: Array<Record<string, any>>;
+    settings: Array<Record<string, any>>;
+    endpoints: {
+        addItems: '';
+        removeItems: '';
+        clearItems: '';
+        refresh: '';
+        applyPromotion: '';
+        removePromotion: '';
+        addAddress: '';
+        removeAddress: '';
+        applyPaymentMethod: '';
+        addReward: '';
+        removeReward: '';
+        addStoreCredit: '';
+        removeStoreCredit: '';
+        addGiftCard: '';
+        removeGiftCard: '';
+    };
+    errors: Array<string>;
+}
+export interface SetEmptyEvent {
+    type: 'SET_EMPTY';
+}
+export interface SetActiveEvent {
+    type: 'SET_ACTIVE';
+}
+export interface AddItemsEvent {
+    type: 'ADD_ITEMS';
+    items: Array<{
+        id: string;
+        quantity: number;
+        options: Record<string, any>;
+    }>;
+}
+export interface RemoveItemsEvent {
+    type: 'REMOVE_ITEMS';
+    items: Array<{
+        id: string;
+        quantity: number;
+    }>;
+}
+export interface ClearItemsEvent {
+    type: 'CLEAR_ITEMS';
+}
+export interface RefreshEvent {
+    type: 'REFRESH';
+}
+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';
+    items: Array<Record<string, any>>;
+}
+export interface RemoveItemsSuccessEvent {
+    type: 'REMOVE_ITEMS_SUCCESS';
+    items: Array<Record<string, any>>;
+}
+export interface ClearItemsSuccessEvent {
+    type: 'CLEAR_ITEMS_SUCCESS';
+}
+export interface RefreshSuccessEvent {
+    type: 'REFRESH_SUCCESS';
+}
+export type QuoteMachineEvents = SetEmptyEvent | SetActiveEvent | AddItemsEvent | RemoveItemsEvent | ClearItemsEvent | RefreshEvent | ApplyPromotionEvent | RemovePromotionEvent | AddAddressEvent | RemoveAddressEvent | ApplyPaymentMethodEvent | AddRewardEvent | RemoveRewardEvent | AddStoreCreditEvent | RemoveStoreCreditEvent | AddGiftCardEvent | RemoveGiftCardEvent | DoneActorEvent<AddItemsSuccessEvent> | DoneActorEvent<RemoveItemsSuccessEvent> | DoneActorEvent<ClearItemsSuccessEvent> | DoneActorEvent<RefreshSuccessEvent>;
+export type AddItemsResponse = {
+    message?: string;
+    success: boolean;
+};
+export type RemoveItemsResponse = {
+    message?: string;
+    success: boolean;
+};
+export type RefreshResponse = {
+    message?: string;
+    success: boolean;
+};

package/src/cart/cart.d.ts

@@ -1,38 +0,0 @@
-import { DoneActorEvent } from 'xstate';
-import type { CartMachineContext, AddItemSuccessEvent } from './types';
-export declare const cartMachine: import("xstate").StateMachine<CartMachineContext, import("./types").AddItemEvent | import("./types").RemoveItemEvent | import("./types").ResetItemsEvent | import("./types").SetEmptyEvent | import("./types").SetActiveEvent | DoneActorEvent<AddItemSuccessEvent> | DoneActorEvent<import("./types").RemoveItemSuccessEvent> | DoneActorEvent<import("./types").ResetItemsSuccessEvent>, {
-    [x: string]: import("xstate").ActorRef<import("xstate").PromiseSnapshot<AddItemSuccessEvent, {
-        cartToken: CartMachineContext['cartToken'];
-    }>, {
-        [k: string]: unknown;
-        type: string;
-    }> | undefined;
-}, {
-    src: "addItem";
-    logic: import("xstate").PromiseActorLogic<AddItemSuccessEvent, {
-        cartToken: CartMachineContext['cartToken'];
-    }>;
-    id: string | undefined;
-}, {
-    type: "addItem";
-    params: import("xstate").NonReducibleUnknown;
-}, {
-    type: string;
-    params: import("xstate").NonReducibleUnknown;
-}, string, {}, string, {
-    initialContext: Partial<CartMachineContext>;
-    initialState?: string | undefined;
-}, import("xstate").NonReducibleUnknown, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, import("./types").AddItemEvent | import("./types").RemoveItemEvent | import("./types").ResetItemsEvent | import("./types").SetEmptyEvent | import("./types").SetActiveEvent | DoneActorEvent<AddItemSuccessEvent> | DoneActorEvent<import("./types").RemoveItemSuccessEvent> | DoneActorEvent<import("./types").ResetItemsSuccessEvent>, {
-    src: "addItem";
-    logic: import("xstate").PromiseActorLogic<AddItemSuccessEvent, {
-        cartToken: CartMachineContext['cartToken'];
-    }>;
-    id: string | undefined;
-}, {
-    type: "addItem";
-    params: import("xstate").NonReducibleUnknown;
-}, {
-    type: string;
-    params: import("xstate").NonReducibleUnknown;
-}, string, string>>;
-export default cartMachine;

package/src/cart/types.d.ts

@@ -1,51 +0,0 @@
-import { DoneActorEvent } from 'xstate';
-export type CartItem = {
-    id: number | string;
-    image: string | null;
-    name: string;
-    price: {
-        base: number;
-        adjusted?: number;
-    };
-    quantity: number;
-};
-export interface CartMachineContext {
-    cartToken: string;
-    currency: string;
-    items: Array<CartItem>;
-    user: object | null;
-}
-export interface AddItemEvent {
-    type: 'ADD_ITEM';
-    id: string;
-    quantity: number;
-}
-export interface RemoveItemEvent {
-    type: 'REMOVE_ITEM';
-    id: string;
-    quantity: number;
-}
-export interface ResetItemsEvent {
-    type: 'RESET_ITEMS';
-}
-export interface SetEmptyEvent {
-    type: 'SET_EMPTY';
-}
-export interface SetActiveEvent {
-    type: 'SET_ACTIVE';
-}
-export interface AddItemSuccessEvent {
-    type: 'ADD_ITEM_SUCCESS';
-    [k: string]: any;
-}
-export interface RemoveItemSuccessEvent {
-    type: 'ADD_ITEM_SUCCESS';
-}
-export interface ResetItemsSuccessEvent {
-    type: 'RESET_ITEMS_SUCCESS';
-}
-export type CartMachineEvents = AddItemEvent | RemoveItemEvent | ResetItemsEvent | SetEmptyEvent | SetActiveEvent | DoneActorEvent<AddItemSuccessEvent> | DoneActorEvent<RemoveItemSuccessEvent> | DoneActorEvent<ResetItemsSuccessEvent>;
-export type AddItemResponse = {
-    message?: string;
-    success: boolean;
-};