@vtex/order-manager - npm Package Compare versions

Comparing version 0.0.3-5 to 0.0.3-6

dist/index.esm.js

 /*!
- * @vtex/order-manager v0.0.3-5
+ * @vtex/order-manager v0.0.3-6
  * (c) VTEX
@@ -386,2 +386,27 @@ * Released under the MIT License.
 var DEFAULT_ORDER_FORM_ID = 'default-order-form';
+var DEFAULT_ORDER_FORM = {
+    id: DEFAULT_ORDER_FORM_ID,
+    items: [],
+    value: UNSYNC_ORDER_FORM_VALUE,
+    totalizers: [],
+    marketingData: {},
+    canEditData: false,
+    loggedIn: false,
+    paymentData: {
+        isValid: false,
+        installmentOptions: [],
+        paymentSystems: [],
+        payments: [],
+        availableAccounts: [],
+    },
+    messages: {
+        couponMessages: [],
+        generalMessages: [],
+    },
+    shipping: {
+        isValid: false,
+        deliveryOptions: [],
+        pickupOptions: [],
+    },
+};
 
@@ -594,14 +619,6 @@ var TaskQueue = /** @class */ (function () {
 
-var reducer = function (prevOrderForm, updateOrderForm) {
-    if (typeof updateOrderForm === 'function') {
-        return __assign(__assign({}, prevOrderForm), updateOrderForm(__assign(__assign({}, prevOrderForm), { value: prevOrderForm.value === UNSYNC_ORDER_FORM_VALUE
-                ? 0
-                : prevOrderForm.value })));
-    }
-    return __assign(__assign({}, prevOrderForm), updateOrderForm);
-};
 var saveLocalOrderForm = function (orderForm) {
     localStorage.setItem('orderform', JSON.stringify(orderForm));
 };
-var getLocalOrderForm = function () {
+function getLocalOrderForm() {
     var _a;
@@ -611,31 +628,14 @@ return typeof document === 'undefined'
         : JSON.parse((_a = localStorage.getItem('orderform')) !== null && _a !== void 0 ? _a : 'null');
-};
+}
 var noop = function () { };
 function createOrderFormProvider$1(_a) {
-    var useOrderFormMessages = _a.useOrderFormMessages, useGetOrderForm = _a.useGetOrderForm;
-    var defaultOrderForm = {
-        id: DEFAULT_ORDER_FORM_ID,
-        items: [],
-        value: UNSYNC_ORDER_FORM_VALUE,
-        totalizers: [],
-        marketingData: {},
-        canEditData: false,
-        loggedIn: false,
-        paymentData: {
-            isValid: false,
-            installmentOptions: [],
-            paymentSystems: [],
-            payments: [],
-            availableAccounts: [],
-        },
-        messages: {
-            couponMessages: [],
-            generalMessages: [],
-        },
-        shipping: {
-            isValid: false,
-            deliveryOptions: [],
-            pickupOptions: [],
-        },
-    };
+    var useOrderFormMessages = _a.useOrderFormMessages, useGetOrderForm = _a.useGetOrderForm, defaultOrderForm = _a.defaultOrderForm;
+    function reducer(prevOrderForm, updateOrderForm) {
+        if (typeof updateOrderForm === 'function') {
+            return __assign(__assign({}, prevOrderForm), updateOrderForm(__assign(__assign({}, prevOrderForm), { value: prevOrderForm.value === UNSYNC_ORDER_FORM_VALUE
+                    ? 0
+                    : prevOrderForm.value })));
+        }
+        return __assign(__assign({}, prevOrderForm), updateOrderForm);
+    }
     var OrderFormContext = createContext({
@@ -652,3 +652,5 @@ orderForm: defaultOrderForm,
         var shouldUseLocalOrderForm = typeof document !== 'undefined' && !navigator.onLine;
-        var _d = useReducer(reducer, (_b = (shouldUseLocalOrderForm ? getLocalOrderForm() : defaultOrderForm)) !== null && _b !== void 0 ? _b : defaultOrderForm), orderForm = _d[0], setOrderForm = _d[1];
+        var _d = useReducer(reducer, (_b = (shouldUseLocalOrderForm
+            ? getLocalOrderForm()
+            : defaultOrderForm)) !== null && _b !== void 0 ? _b : defaultOrderForm), orderForm = _d[0], setOrderForm = _d[1];
         // use a different variable to store the loading state because if some
@@ -691,8 +693,20 @@ // component uses the `loading` from the Apollo query they won't be perfectly
         useOrderFormMessages(orderForm, setOrderForm);
-        var value = useMemo(function () { return ({
-            error: error,
-            orderForm: __assign(__assign({}, orderForm), { value: orderForm.value === UNSYNC_ORDER_FORM_VALUE ? 0 : orderForm.value, messages: __assign(__assign({}, orderForm.messages), { generalMessages: [] }) }),
-            setOrderForm: setOrderForm,
-            loading: orderFormLoading,
-        }); }, [error, orderForm, orderFormLoading]);
+        var value = useMemo(function () {
+            if (orderForm.id !== DEFAULT_ORDER_FORM_ID) {
+                return {
+                    error: error,
+                    orderForm: __assign(__assign({}, orderForm), { value: orderForm.value === UNSYNC_ORDER_FORM_VALUE ? 0 : orderForm.value, messages: __assign(__assign({}, orderForm.messages), { generalMessages: [] }) }),
+                    initialFetchComplete: true,
+                    setOrderForm: setOrderForm,
+                    loading: orderFormLoading,
+                };
+            }
+            return {
+                error: error,
+                orderForm: __assign(__assign({}, orderForm), { value: orderForm.value === UNSYNC_ORDER_FORM_VALUE ? 0 : orderForm.value, messages: __assign(__assign({}, orderForm.messages), { generalMessages: [] }) }),
+                initialFetchComplete: false,
+                setOrderForm: setOrderForm,
+                loading: orderFormLoading,
+            };
+        }, [error, orderForm, orderFormLoading]);
         return (React.createElement(OrderFormContext.Provider, { value: value }, children));
@@ -711,3 +725,3 @@ };
 function createOrderFormProvider(_a) {
-    var useToast = _a.useToast, clearOrderFormMessages = _a.clearOrderFormMessages, useGetOrderForm = _a.useGetOrderForm;
+    var useToast = _a.useToast, clearOrderFormMessages = _a.clearOrderFormMessages, useGetOrderForm = _a.useGetOrderForm, defaultOrderForm = _a.defaultOrderForm;
     var useOrderFormMessages = createUseMessages({
@@ -717,6 +731,10 @@ useToast: useToast,
     });
-    return createOrderFormProvider$1({ useOrderFormMessages: useOrderFormMessages, useGetOrderForm: useGetOrderForm });
+    return createOrderFormProvider$1({
+        useOrderFormMessages: useOrderFormMessages,
+        useGetOrderForm: useGetOrderForm,
+        defaultOrderForm: defaultOrderForm,
+    });
 }
 
-export { OrderQueue, createOrderFormProvider };
+export { DEFAULT_ORDER_FORM, OrderQueue, createOrderFormProvider };
 //# sourceMappingURL=index.esm.js.map

dist/index.js

 /*!
- * @vtex/order-manager v0.0.3-5
+ * @vtex/order-manager v0.0.3-6
  * (c) VTEX
@@ -394,2 +394,27 @@ * Released under the MIT License.
 var DEFAULT_ORDER_FORM_ID = 'default-order-form';
+var DEFAULT_ORDER_FORM = {
+    id: DEFAULT_ORDER_FORM_ID,
+    items: [],
+    value: UNSYNC_ORDER_FORM_VALUE,
+    totalizers: [],
+    marketingData: {},
+    canEditData: false,
+    loggedIn: false,
+    paymentData: {
+        isValid: false,
+        installmentOptions: [],
+        paymentSystems: [],
+        payments: [],
+        availableAccounts: [],
+    },
+    messages: {
+        couponMessages: [],
+        generalMessages: [],
+    },
+    shipping: {
+        isValid: false,
+        deliveryOptions: [],
+        pickupOptions: [],
+    },
+};
 
@@ -602,14 +627,6 @@ var TaskQueue = /** @class */ (function () {
 
-var reducer = function (prevOrderForm, updateOrderForm) {
-    if (typeof updateOrderForm === 'function') {
-        return __assign(__assign({}, prevOrderForm), updateOrderForm(__assign(__assign({}, prevOrderForm), { value: prevOrderForm.value === UNSYNC_ORDER_FORM_VALUE
-                ? 0
-                : prevOrderForm.value })));
-    }
-    return __assign(__assign({}, prevOrderForm), updateOrderForm);
-};
 var saveLocalOrderForm = function (orderForm) {
     localStorage.setItem('orderform', JSON.stringify(orderForm));
 };
-var getLocalOrderForm = function () {
+function getLocalOrderForm() {
     var _a;
@@ -619,31 +636,14 @@ return typeof document === 'undefined'
         : JSON.parse((_a = localStorage.getItem('orderform')) !== null && _a !== void 0 ? _a : 'null');
-};
+}
 var noop = function () { };
 function createOrderFormProvider$1(_a) {
-    var useOrderFormMessages = _a.useOrderFormMessages, useGetOrderForm = _a.useGetOrderForm;
-    var defaultOrderForm = {
-        id: DEFAULT_ORDER_FORM_ID,
-        items: [],
-        value: UNSYNC_ORDER_FORM_VALUE,
-        totalizers: [],
-        marketingData: {},
-        canEditData: false,
-        loggedIn: false,
-        paymentData: {
-            isValid: false,
-            installmentOptions: [],
-            paymentSystems: [],
-            payments: [],
-            availableAccounts: [],
-        },
-        messages: {
-            couponMessages: [],
-            generalMessages: [],
-        },
-        shipping: {
-            isValid: false,
-            deliveryOptions: [],
-            pickupOptions: [],
-        },
-    };
+    var useOrderFormMessages = _a.useOrderFormMessages, useGetOrderForm = _a.useGetOrderForm, defaultOrderForm = _a.defaultOrderForm;
+    function reducer(prevOrderForm, updateOrderForm) {
+        if (typeof updateOrderForm === 'function') {
+            return __assign(__assign({}, prevOrderForm), updateOrderForm(__assign(__assign({}, prevOrderForm), { value: prevOrderForm.value === UNSYNC_ORDER_FORM_VALUE
+                    ? 0
+                    : prevOrderForm.value })));
+        }
+        return __assign(__assign({}, prevOrderForm), updateOrderForm);
+    }
     var OrderFormContext = React.createContext({
@@ -660,3 +660,5 @@ orderForm: defaultOrderForm,
         var shouldUseLocalOrderForm = typeof document !== 'undefined' && !navigator.onLine;
-        var _d = React.useReducer(reducer, (_b = (shouldUseLocalOrderForm ? getLocalOrderForm() : defaultOrderForm)) !== null && _b !== void 0 ? _b : defaultOrderForm), orderForm = _d[0], setOrderForm = _d[1];
+        var _d = React.useReducer(reducer, (_b = (shouldUseLocalOrderForm
+            ? getLocalOrderForm()
+            : defaultOrderForm)) !== null && _b !== void 0 ? _b : defaultOrderForm), orderForm = _d[0], setOrderForm = _d[1];
         // use a different variable to store the loading state because if some
@@ -699,8 +701,20 @@ // component uses the `loading` from the Apollo query they won't be perfectly
         useOrderFormMessages(orderForm, setOrderForm);
-        var value = React.useMemo(function () { return ({
-            error: error,
-            orderForm: __assign(__assign({}, orderForm), { value: orderForm.value === UNSYNC_ORDER_FORM_VALUE ? 0 : orderForm.value, messages: __assign(__assign({}, orderForm.messages), { generalMessages: [] }) }),
-            setOrderForm: setOrderForm,
-            loading: orderFormLoading,
-        }); }, [error, orderForm, orderFormLoading]);
+        var value = React.useMemo(function () {
+            if (orderForm.id !== DEFAULT_ORDER_FORM_ID) {
+                return {
+                    error: error,
+                    orderForm: __assign(__assign({}, orderForm), { value: orderForm.value === UNSYNC_ORDER_FORM_VALUE ? 0 : orderForm.value, messages: __assign(__assign({}, orderForm.messages), { generalMessages: [] }) }),
+                    initialFetchComplete: true,
+                    setOrderForm: setOrderForm,
+                    loading: orderFormLoading,
+                };
+            }
+            return {
+                error: error,
+                orderForm: __assign(__assign({}, orderForm), { value: orderForm.value === UNSYNC_ORDER_FORM_VALUE ? 0 : orderForm.value, messages: __assign(__assign({}, orderForm.messages), { generalMessages: [] }) }),
+                initialFetchComplete: false,
+                setOrderForm: setOrderForm,
+                loading: orderFormLoading,
+            };
+        }, [error, orderForm, orderFormLoading]);
         return (React__default['default'].createElement(OrderFormContext.Provider, { value: value }, children));
@@ -719,3 +733,3 @@ };
 function createOrderFormProvider(_a) {
-    var useToast = _a.useToast, clearOrderFormMessages = _a.clearOrderFormMessages, useGetOrderForm = _a.useGetOrderForm;
+    var useToast = _a.useToast, clearOrderFormMessages = _a.clearOrderFormMessages, useGetOrderForm = _a.useGetOrderForm, defaultOrderForm = _a.defaultOrderForm;
     var useOrderFormMessages = createUseMessages({
@@ -725,7 +739,12 @@ useToast: useToast,
     });
-    return createOrderFormProvider$1({ useOrderFormMessages: useOrderFormMessages, useGetOrderForm: useGetOrderForm });
+    return createOrderFormProvider$1({
+        useOrderFormMessages: useOrderFormMessages,
+        useGetOrderForm: useGetOrderForm,
+        defaultOrderForm: defaultOrderForm,
+    });
 }
 
+exports.DEFAULT_ORDER_FORM = DEFAULT_ORDER_FORM;
 exports.OrderQueue = OrderQueue;
 exports.createOrderFormProvider = createOrderFormProvider;
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@vtex/order-manager",
-  "version": "0.0.3-5",
+  "version": "0.0.3-6",
   "description": "",
@@ -5,0 +5,0 @@ "cdn": "dist/index.umd.js",

README.md

@@ -8,3 +8,3 @@ # Order Manager (NPM Package)
 
-This package is an abstraction to decouple the Order Manager logic from VTEX IO. Refer to the [repository root's README](../../../docs/README.md) for more information.
+This package is an abstraction to decouple the Order Manager logic from VTEX IO. Refer to the [repository root's README](https://www.github.com/vtex-apps/order-manager) for more information.
 
@@ -46,14 +46,1 @@ ## Installation
 Released under [MIT License](./LICENSE).
-);
-</script>
-
-```
-
-## Documentation
-
-[Documentation generated from source files by Typedoc](./docs/README.md).
-
-## License
-
-Released under [MIT License](./LICENSE).
-```

types/__fixtures__/OrderFormProvider.d.ts

 /// <reference types="react" />
-declare const OrderFormProvider: import("react").FC<{}>, useOrderForm: () => import("../modules/createOrderForm").Context<import("../typings").OrderForm>;
+declare const OrderFormProvider: import("react").FC<{}>, useOrderForm: () => import("../modules/createOrderForm").Context<{
+    id: string;
+    items: never[];
+    value: number;
+    totalizers: never[];
+    marketingData: {};
+    canEditData: boolean;
+    loggedIn: boolean;
+    paymentData: {
+        isValid: boolean;
+        installmentOptions: never[];
+        paymentSystems: never[];
+        payments: never[];
+        availableAccounts: never[];
+    };
+    messages: {
+        couponMessages: never[];
+        generalMessages: never[];
+    };
+    shipping: {
+        isValid: boolean;
+        deliveryOptions: never[];
+        pickupOptions: never[];
+    };
+}>;
 export { OrderFormProvider, useOrderForm };
 //# sourceMappingURL=OrderFormProvider.d.ts.map

types/constants.d.ts

@@ -9,2 +9,27 @@ export declare type QueueStatus = 'Pending' | 'Fulfilled';
 export default _default;
+export declare const DEFAULT_ORDER_FORM: {
+    id: string;
+    items: never[];
+    value: number;
+    totalizers: never[];
+    marketingData: {};
+    canEditData: boolean;
+    loggedIn: boolean;
+    paymentData: {
+        isValid: boolean;
+        installmentOptions: never[];
+        paymentSystems: never[];
+        payments: never[];
+        availableAccounts: never[];
+    };
+    messages: {
+        couponMessages: never[];
+        generalMessages: never[];
+    };
+    shipping: {
+        isValid: boolean;
+        deliveryOptions: never[];
+        pickupOptions: never[];
+    };
+};
 //# sourceMappingURL=constants.d.ts.map

types/createOrderFormProvider.d.ts

@@ -5,5 +5,5 @@ /// <reference types="react" />
 import type { OrderForm } from './typings';
-interface OrderFormProviderSettings<T extends OrderForm> extends CreateUseMessagesParams, Pick<CreateOrderFormProviderParams<T>, 'useGetOrderForm'> {
+interface OrderFormProviderSettings<T extends OrderForm> extends CreateUseMessagesParams, Pick<CreateOrderFormProviderParams<T>, Exclude<keyof CreateOrderFormProviderParams<T>, 'useOrderFormMessages'>> {
 }
-export declare function createOrderFormProvider<T extends OrderForm>({ useToast, clearOrderFormMessages, useGetOrderForm, }: OrderFormProviderSettings<T>): {
+export declare function createOrderFormProvider<T extends OrderForm>({ useToast, clearOrderFormMessages, useGetOrderForm, defaultOrderForm, }: OrderFormProviderSettings<T>): {
     OrderFormProvider: import("react").FC<{}>;
@@ -10,0 +10,0 @@ useOrderForm: () => import("./modules/createOrderForm").Context<T>;

types/index.d.ts

 export { createOrderFormProvider } from './createOrderFormProvider';
 export { default as OrderQueue } from './OrderQueue';
+export { DEFAULT_ORDER_FORM } from './constants';
+export type { OrderForm } from './typings';
 //# sourceMappingURL=index.d.ts.map

types/modules/createOrderForm.d.ts

 import type { FC } from 'react';
 import type { OrderForm, OrderFormUpdate } from '../typings';
 import type { createUseMessages } from './createUseMessages';
-export interface Context<T extends OrderForm = OrderForm> {
+declare type PossibleOrderForms<O> = OrderForm & O;
+export interface Context<O extends OrderForm> {
     loading: boolean;
-    orderForm: T;
-    setOrderForm: (nextValue: OrderFormUpdate) => void;
+    setOrderForm: (nextValue: OrderFormUpdate<PossibleOrderForms<O>>) => void;
     error: any | undefined;
+    orderForm: PossibleOrderForms<O>;
 }
-export interface CreateOrderFormProviderParams<T extends OrderForm> {
+export interface CreateOrderFormProviderParams<O extends OrderForm> {
     useOrderFormMessages: ReturnType<typeof createUseMessages>;
     useGetOrderForm: () => {
         data?: {
-            orderForm: T;
+            orderForm: O;
         };
         loading: boolean;
-        error: any;
+        error?: any;
     };
+    defaultOrderForm: O;
 }
-export declare function createOrderFormProvider<T extends OrderForm>({ useOrderFormMessages, useGetOrderForm, }: CreateOrderFormProviderParams<T>): {
+export declare function createOrderFormProvider<O extends OrderForm>({ useOrderFormMessages, useGetOrderForm, defaultOrderForm, }: CreateOrderFormProviderParams<O>): {
     OrderFormProvider: FC<{}>;
-    useOrderForm: () => Context<T>;
+    useOrderForm: () => Context<O>;
 };
+export {};
 //# sourceMappingURL=createOrderForm.d.ts.map

types/modules/createUseMessages.d.ts

@@ -18,4 +18,4 @@ import type { Dispatch } from 'react';
 }
-export declare const createUseMessages: ({ clearOrderFormMessages, useToast, }: CreateUseMessagesParams) => (orderForm: OrderForm, setOrderForm: Dispatch<OrderFormUpdate>) => void;
+export declare const createUseMessages: ({ clearOrderFormMessages, useToast, }: CreateUseMessagesParams) => (orderForm: OrderForm, setOrderForm: Dispatch<OrderFormUpdate<OrderForm>>) => void;
 export {};
 //# sourceMappingURL=createUseMessages.d.ts.map

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

181293

increased by3.13%

Lines of code

1817

increased by5.27%

Worsened metrics

Number of lines in readme file

45

decreased by-22.41%

No dependency changes