@jetshop/core 5.13.12-0 → 5.14.0-alpha.49df897e

package/components/Notifications/notificationsMachine.js

@@ -1,66 +1,66 @@
-import uniqueId from '@jetshop/core/helpers/uniqueId';
-import { assign, Machine, send, spawn } from 'xstate';
-import { notificationMachine } from './notificationMachine';
-const notificationsMachine = Machine({
-    id: 'notifications',
-    context: {
-        notifications: []
-    },
-    initial: 'idle',
-    on: {
-        'NOTIFICATION.ADD': {
-            actions: assign({
-                notifications: (context, event) => {
-                    var _a;
-                    const { content, id, notificationType } = event;
-                    const newNotification = {
-                        content,
-                        id: id || uniqueId(),
-                        type: notificationType !== null && notificationType !== void 0 ? notificationType : 'default',
-                        autoCloseAfter: (_a = event.autoCloseAfter) !== null && _a !== void 0 ? _a : 1600
-                    };
-                    const ref = spawn(notificationMachine.withContext(newNotification), newNotification.id);
-                    return [
-                        ...context.notifications,
-                        Object.assign(Object.assign({}, newNotification), { ref })
-                    ];
-                }
-            }),
-            target: 'active'
-        }
-    },
-    states: {
-        idle: {},
-        active: {
-            always: [
-                {
-                    target: 'idle',
-                    cond: context => context.notifications.length === 0
-                }
-            ],
-            on: {
-                'NOTIFICATION.REMOVED': {
-                    actions: assign({
-                        notifications: (context, event) => {
-                            return context.notifications.filter(notification => notification.id !== event.id);
-                        }
-                    })
-                },
-                'NOTIFICATION.REMOVE': {
-                    actions: send('REMOVE', {
-                        to: (_, event) => event.id
-                    })
-                },
-                'NOTIFICATIONS.CLEAR': {
-                    actions: context => {
-                        for (const notification of context.notifications) {
-                            notification.ref.send({ type: 'REMOVE' });
-                        }
-                    }
-                }
-            }
-        }
-    }
-});
-export { notificationsMachine };
+import uniqueId from '@jetshop/core/helpers/uniqueId';
+import { assign, Machine, send, spawn } from 'xstate';
+import { notificationMachine } from './notificationMachine';
+const notificationsMachine = Machine({
+    id: 'notifications',
+    context: {
+        notifications: []
+    },
+    initial: 'idle',
+    on: {
+        'NOTIFICATION.ADD': {
+            actions: assign({
+                notifications: (context, event) => {
+                    var _a;
+                    const { content, id, notificationType } = event;
+                    const newNotification = {
+                        content,
+                        id: id || uniqueId(),
+                        type: notificationType !== null && notificationType !== void 0 ? notificationType : 'default',
+                        autoCloseAfter: (_a = event.autoCloseAfter) !== null && _a !== void 0 ? _a : 1600
+                    };
+                    const ref = spawn(notificationMachine.withContext(newNotification), newNotification.id);
+                    return [
+                        ...context.notifications,
+                        Object.assign(Object.assign({}, newNotification), { ref })
+                    ];
+                }
+            }),
+            target: 'active'
+        }
+    },
+    states: {
+        idle: {},
+        active: {
+            always: [
+                {
+                    target: 'idle',
+                    cond: context => context.notifications.length === 0
+                }
+            ],
+            on: {
+                'NOTIFICATION.REMOVED': {
+                    actions: assign({
+                        notifications: (context, event) => {
+                            return context.notifications.filter(notification => notification.id !== event.id);
+                        }
+                    })
+                },
+                'NOTIFICATION.REMOVE': {
+                    actions: send('REMOVE', {
+                        to: (_, event) => event.id
+                    })
+                },
+                'NOTIFICATIONS.CLEAR': {
+                    actions: context => {
+                        for (const notification of context.notifications) {
+                            notification.ref.send({ type: 'REMOVE' });
+                        }
+                    }
+                }
+            }
+        }
+    }
+});
+export { notificationsMachine };
 //# sourceMappingURL=notificationsMachine.js.map

package/components/Notifications/useNotification.d.ts

@@ -1,9 +1,9 @@
-import React from 'react';
-declare type NotificationContent = string | React.ReactNode;
-interface NotificationOptions {
-    id?: string;
-    type?: string;
-    autoCloseAfter?: number;
-}
-export declare function useNotification(): readonly [(content: NotificationContent, { id, type, autoCloseAfter }?: NotificationOptions) => void, (id?: string) => void];
-export {};
+import React from 'react';
+declare type NotificationContent = string | React.ReactNode;
+interface NotificationOptions {
+    id?: string;
+    type?: string;
+    autoCloseAfter?: number;
+}
+export declare function useNotification(): readonly [(content: NotificationContent, { id, type, autoCloseAfter }?: NotificationOptions) => void, (id?: string) => void];
+export {};

package/components/Notifications/useNotification.js

@@ -1,27 +1,27 @@
-import { useCallback, useContext } from 'react';
-import { NotificationsContext } from './Notifications';
-export function useNotification() {
-    const [, send] = useContext(NotificationsContext);
-    const trigger = useCallback((content, { id, type, autoCloseAfter } = {}) => {
-        send({
-            type: 'NOTIFICATION.ADD',
-            content,
-            id,
-            notificationType: type,
-            autoCloseAfter
-        });
-    }, [send]);
-    const dismiss = useCallback((id) => {
-        if (typeof id === 'string') {
-            send({ type: 'NOTIFICATION.REMOVE', id });
-        }
-        else {
-            console.log('clearing');
-            send({ type: 'NOTIFICATIONS.CLEAR' });
-        }
-    }, [send]);
-    return [trigger, dismiss];
-}
-// trigger - content and an optional ID
-// dismiss - optional ID. no id given = dismiss all
+import { useCallback, useContext } from 'react';
+import { NotificationsContext } from './Notifications';
+export function useNotification() {
+    const [, send] = useContext(NotificationsContext);
+    const trigger = useCallback((content, { id, type, autoCloseAfter } = {}) => {
+        send({
+            type: 'NOTIFICATION.ADD',
+            content,
+            id,
+            notificationType: type,
+            autoCloseAfter
+        });
+    }, [send]);
+    const dismiss = useCallback((id) => {
+        if (typeof id === 'string') {
+            send({ type: 'NOTIFICATION.REMOVE', id });
+        }
+        else {
+            console.log('clearing');
+            send({ type: 'NOTIFICATIONS.CLEAR' });
+        }
+    }, [send]);
+    return [trigger, dismiss];
+}
+// trigger - content and an optional ID
+// dismiss - optional ID. no id given = dismiss all
 //# sourceMappingURL=useNotification.js.map

package/components/OpenGraph/OpenGraph.test.js

@@ -1,180 +1,180 @@
-import React from 'react';
-import { render, wait } from '@testing-library/react';
-import { selectedChannel, channels } from '@jetshop/core/test-utils/variables';
-import { HelmetProvider } from 'react-helmet-async';
-
-import { OpenGraphProductData, OpenGraphGeneralPageData } from './';
-import { ChannelProvider } from '../ChannelContext';
-import { ChannelHandler } from '../../ChannelHandler/ChannelHandler';
-import { ConfigProvider } from '../ConfigProvider';
-import mockShopConfig from '../../test-utils/mockShopConfig';
-
-function getMetaProperty(propertyName) {
-  const metas = document.getElementsByTagName('meta');
-  for (let meta of metas) {
-    if (meta.getAttribute('property') === propertyName) {
-      return meta.getAttribute('content');
-    }
-  }
-  return null;
-}
-
-function Providers({ children }) {
-  // TODO There is no currency.format.code in the test data, a bug?
-  selectedChannel.currency.format.code = 'TMP';
-
-  const channelHandler = new ChannelHandler({
-    selectedChannel,
-    channels
-  });
-  const context = {};
-  return (
-    <ConfigProvider config={mockShopConfig}>
-      <HelmetProvider context={context}>
-        <ChannelProvider channelHandler={channelHandler}>
-          {children}
-        </ChannelProvider>
-      </HelmetProvider>
-    </ConfigProvider>
-  );
-}
-
-describe('<OpenGraphGeneralPageData>', () => {
-  const pageData = {
-    data: {
-      head: {
-        title: 'This is the title',
-        metaTags: [
-          {
-            name: 'description',
-            content: 'This is the description'
-          }
-        ]
-      },
-      images: [{ url: 'https://example.com/image.png' }]
-    },
-    route: {
-      canonicalPath: '/path/to/page'
-    }
-  };
-
-  it('Should provide sensible default values based on page data', async () => {
-    render(
-      <Providers>
-        <OpenGraphGeneralPageData {...pageData} />
-      </Providers>
-    );
-    await wait(() => {
-      expect(getMetaProperty('og:title')).toEqual('This is the title');
-      expect(getMetaProperty('og:description')).toEqual(
-        'This is the description'
-      );
-      expect(getMetaProperty('og:url')).toEqual(
-        `${selectedChannel.url}${pageData.route.canonicalPath}`
-      );
-      expect(getMetaProperty('og:image')).toEqual(
-        'https://example.com/image.png'
-      );
-    });
-  });
-
-  it('Default fields can be overridden and new can be added', async () => {
-    render(
-      <Providers>
-        <OpenGraphGeneralPageData
-          {...pageData}
-          optionalFields={[
-            { property: 'og:title', content: 'Overridden title' },
-            { property: 'og:site_name', content: 'My Awesome Site' }
-          ]}
-        />
-      </Providers>
-    );
-    await wait(() => {
-      expect(getMetaProperty('og:title')).toEqual('Overridden title');
-      expect(getMetaProperty('og:site_name')).toEqual('My Awesome Site');
-    });
-  });
-});
-
-describe('<OpenGraphProductData>', () => {
-  const sampleProduct = {
-    price: {
-      incVat: 499
-    },
-    previousPrice: {
-      incVat: 999
-    },
-    stockStatus: {
-      buyable: true
-    },
-    customFields: [
-      {
-        key: 'brand',
-        stringValue: 'HyperBrand'
-      }
-    ],
-    canonicalCategory: {
-      name: 'HyperFlight'
-    }
-  };
-
-  it('Should provide sensible default values based on product', async () => {
-    render(
-      <Providers>
-        <OpenGraphProductData product={sampleProduct} />
-      </Providers>
-    );
-
-    await wait(() => {
-      expect(getMetaProperty('product:price:amount')).toEqual('499');
-      expect(getMetaProperty('product:original_price:amount')).toEqual('999');
-      expect(getMetaProperty('product:brand')).toEqual('HyperBrand');
-      expect(getMetaProperty('og:price:currency')).toEqual('TMP');
-      expect(getMetaProperty('product:availability')).toEqual('true');
-      expect(getMetaProperty('product:category')).toEqual('HyperFlight');
-    });
-  });
-
-  it('Default fields can be overridden and new can be added', async () => {
-    render(
-      <Providers>
-        <OpenGraphProductData
-          product={sampleProduct}
-          optionalFields={[
-            { property: 'product:category', content: 'mycategory' },
-            { property: 'custom-property', content: 'custom-value' }
-          ]}
-        />
-      </Providers>
-    );
-
-    await wait(() => {
-      expect(getMetaProperty('product:category')).toEqual('mycategory');
-      expect(getMetaProperty('custom-property')).toEqual('custom-value');
-    });
-  });
-
-  it('Overriding brandCustomField in shop config should work', async () => {
-    const product = {
-      ...sampleProduct,
-      customFields: [
-        {
-          key: 'customBrandField',
-          stringValue: 'HyperBrand'
-        }
-      ]
-    };
-    render(
-      <Providers>
-        <ConfigProvider config={{ brandCustomField: 'customBrandField' }}>
-          <OpenGraphProductData product={product} />
-        </ConfigProvider>
-      </Providers>
-    );
-
-    await wait(() => {
-      expect(getMetaProperty('product:brand')).toEqual('HyperBrand');
-    });
-  });
-});
+import React from 'react';
+import { render, wait } from '@testing-library/react';
+import { selectedChannel, channels } from '@jetshop/core/test-utils/variables';
+import { HelmetProvider } from 'react-helmet-async';
+
+import { OpenGraphProductData, OpenGraphGeneralPageData } from './';
+import { ChannelProvider } from '@jetshop/core/components/ChannelContext';
+import { ChannelHandler } from '../../ChannelHandler/ChannelHandler';
+import { ConfigProvider } from '@jetshop/core/components/ConfigProvider';
+import mockShopConfig from '../../test-utils/mockShopConfig';
+
+function getMetaProperty(propertyName) {
+  const metas = document.getElementsByTagName('meta');
+  for (let meta of metas) {
+    if (meta.getAttribute('property') === propertyName) {
+      return meta.getAttribute('content');
+    }
+  }
+  return null;
+}
+
+function Providers({ children }) {
+  // TODO There is no currency.format.code in the test data, a bug?
+  selectedChannel.currency.format.code = 'TMP';
+
+  const channelHandler = new ChannelHandler({
+    selectedChannel,
+    channels
+  });
+  const context = {};
+  return (
+    <ConfigProvider config={mockShopConfig}>
+      <HelmetProvider context={context}>
+        <ChannelProvider channelHandler={channelHandler}>
+          {children}
+        </ChannelProvider>
+      </HelmetProvider>
+    </ConfigProvider>
+  );
+}
+
+describe('<OpenGraphGeneralPageData>', () => {
+  const pageData = {
+    data: {
+      head: {
+        title: 'This is the title',
+        metaTags: [
+          {
+            name: 'description',
+            content: 'This is the description'
+          }
+        ]
+      },
+      images: [{ url: 'https://example.com/image.png' }]
+    },
+    route: {
+      canonicalPath: '/path/to/page'
+    }
+  };
+
+  it('Should provide sensible default values based on page data', async () => {
+    render(
+      <Providers>
+        <OpenGraphGeneralPageData {...pageData} />
+      </Providers>
+    );
+    await wait(() => {
+      expect(getMetaProperty('og:title')).toEqual('This is the title');
+      expect(getMetaProperty('og:description')).toEqual(
+        'This is the description'
+      );
+      expect(getMetaProperty('og:url')).toEqual(
+        `${selectedChannel.url}${pageData.route.canonicalPath}`
+      );
+      expect(getMetaProperty('og:image')).toEqual(
+        'https://example.com/image.png'
+      );
+    });
+  });
+
+  it('Default fields can be overridden and new can be added', async () => {
+    render(
+      <Providers>
+        <OpenGraphGeneralPageData
+          {...pageData}
+          optionalFields={[
+            { property: 'og:title', content: 'Overridden title' },
+            { property: 'og:site_name', content: 'My Awesome Site' }
+          ]}
+        />
+      </Providers>
+    );
+    await wait(() => {
+      expect(getMetaProperty('og:title')).toEqual('Overridden title');
+      expect(getMetaProperty('og:site_name')).toEqual('My Awesome Site');
+    });
+  });
+});
+
+describe('<OpenGraphProductData>', () => {
+  const sampleProduct = {
+    price: {
+      incVat: 499
+    },
+    previousPrice: {
+      incVat: 999
+    },
+    stockStatus: {
+      buyable: true
+    },
+    customFields: [
+      {
+        key: 'brand',
+        stringValue: 'HyperBrand'
+      }
+    ],
+    canonicalCategory: {
+      name: 'HyperFlight'
+    }
+  };
+
+  it('Should provide sensible default values based on product', async () => {
+    render(
+      <Providers>
+        <OpenGraphProductData product={sampleProduct} />
+      </Providers>
+    );
+
+    await wait(() => {
+      expect(getMetaProperty('product:price:amount')).toEqual('499');
+      expect(getMetaProperty('product:original_price:amount')).toEqual('999');
+      expect(getMetaProperty('product:brand')).toEqual('HyperBrand');
+      expect(getMetaProperty('og:price:currency')).toEqual('TMP');
+      expect(getMetaProperty('product:availability')).toEqual('true');
+      expect(getMetaProperty('product:category')).toEqual('HyperFlight');
+    });
+  });
+
+  it('Default fields can be overridden and new can be added', async () => {
+    render(
+      <Providers>
+        <OpenGraphProductData
+          product={sampleProduct}
+          optionalFields={[
+            { property: 'product:category', content: 'mycategory' },
+            { property: 'custom-property', content: 'custom-value' }
+          ]}
+        />
+      </Providers>
+    );
+
+    await wait(() => {
+      expect(getMetaProperty('product:category')).toEqual('mycategory');
+      expect(getMetaProperty('custom-property')).toEqual('custom-value');
+    });
+  });
+
+  it('Overriding brandCustomField in shop config should work', async () => {
+    const product = {
+      ...sampleProduct,
+      customFields: [
+        {
+          key: 'customBrandField',
+          stringValue: 'HyperBrand'
+        }
+      ]
+    };
+    render(
+      <Providers>
+        <ConfigProvider config={{ brandCustomField: 'customBrandField' }}>
+          <OpenGraphProductData product={product} />
+        </ConfigProvider>
+      </Providers>
+    );
+
+    await wait(() => {
+      expect(getMetaProperty('product:brand')).toEqual('HyperBrand');
+    });
+  });
+});

package/components/OpenGraph/OpenGraphGeneralPageData.d.ts

@@ -1,25 +1,25 @@
-import { Category, Product, Page, StartPage, Route } from '@jetshop/core/types';
-import React from 'react';
-import { HtmlHead } from '@jetshop/core/types';
-export interface OpenGraphGeneralPageDataProps {
-    /** The page object */
-    data: StartPage | Category | Product | Page | {
-        head: HtmlHead;
-        __typename: 'Error';
-    };
-    route: Route;
-    /**
-     * Optional fields can be suppilied via a list of objects.
-     * Will override default values if provided.
-     * [{ property: 'og:title', content: 'Example title' }].
-     *
-     * Full list of fields available at
-     * @url https://ogp.me/
-     */
-    optionalFields?: OpenGraphDataTag[];
-}
-export declare type OpenGraphDataTag = {
-    property: string;
-    content: string;
-};
-export declare const OpenGraphGeneralPageData: React.FC<OpenGraphGeneralPageDataProps>;
+import { Category, Product, Page, StartPage, Route } from '@jetshop/core/types';
+import React from 'react';
+import { HtmlHead } from '@jetshop/core/types';
+export interface OpenGraphGeneralPageDataProps {
+    /** The page object */
+    data: StartPage | Category | Product | Page | {
+        head: HtmlHead;
+        __typename: 'Error';
+    };
+    route: Route;
+    /**
+     * Optional fields can be suppilied via a list of objects.
+     * Will override default values if provided.
+     * [{ property: 'og:title', content: 'Example title' }].
+     *
+     * Full list of fields available at
+     * @url https://ogp.me/
+     */
+    optionalFields?: OpenGraphDataTag[];
+}
+export declare type OpenGraphDataTag = {
+    property: string;
+    content: string;
+};
+export declare const OpenGraphGeneralPageData: React.FC<OpenGraphGeneralPageDataProps>;