@dutchiesdk/ecommerce-extensions-sdk 0.9.0 → 0.10.1

package/README.md

@@ -187,6 +187,10 @@ const currentLocations = await dataLoaders.locations(); // Current context locat
 
 **Note:** All data loaders return empty arrays (`[]`) when no data is available.
 
+## Events
+
+You can register callback functions that will be triggered by certain events in the Dutchie platform in your extension's `RemoteModuleRegistry` object.
+
 ## Best Practices
 
 ### Data Loading

package/dist/context/ecommerce-data-bridge.cjs

@@ -30,7 +30,7 @@ __webpack_require__.d(__webpack_exports__, {
     useDataBridge: ()=>useDataBridge
 });
 const external_react_namespaceObject = require("react");
-const DataBridgeVersion = '0.9.0';
+const DataBridgeVersion = '0.10.1';
 const DataBridgeContext = (0, external_react_namespaceObject.createContext)(void 0);
 const useDataBridge = ()=>{
     const context = (0, external_react_namespaceObject.useContext)(DataBridgeContext);

package/dist/esm/context/ecommerce-data-bridge.js

@@ -1,5 +1,5 @@
 import { createContext, useContext, useEffect, useState } from "react";
-const DataBridgeVersion = '0.9.0';
+const DataBridgeVersion = '0.10.1';
 const DataBridgeContext = createContext(void 0);
 const useDataBridge = ()=>{
     const context = useContext(DataBridgeContext);

package/dist/esm/index.d.ts

@@ -3,4 +3,5 @@ export * from './context/ecommerce-data-bridge';
 export * from './types/actions';
 export * from './types/data';
 export * from './types/ecommerce-extension';
+export * from './types/events';
 export * from './types/interface';

package/dist/esm/index.js

@@ -3,4 +3,5 @@ export * from "./context/ecommerce-data-bridge.js";
 export * from "./types/actions.js";
 export * from "./types/data.js";
 export * from "./types/ecommerce-extension.js";
+export * from "./types/events.js";
 export * from "./types/interface.js";

package/dist/esm/types/actions.d.ts

@@ -10,8 +10,8 @@ type AuthenticationActions = {
     goToRegister: () => void;
 };
 type GoToIdOrCnameParameters = {
-    id?: string;
     cname?: string;
+    id?: string;
 };
 type CartActions = {
     /**
@@ -90,14 +90,21 @@ type ListPageActions = {
     goToBrandList: () => void;
     /**
      * Navigate to product list
-     * @param categoryId - The category ID
-     * @param categoryCname - The category CNAME
-     * @param brandId - The brand ID
      * @param brandCname - The brand CNAME
-     * @param collectionId - The collection ID
+     * @param brandId - The brand ID
+     * @param categoryCname - The category CNAME
+     * @param categoryId - The category ID
      * @param collectionCname - The collection CNAME
+     * @param collectionId - The collection ID
      */
-    goToProductList: (categoryId?: string, categoryCname?: string, brandId?: string, brandCname?: string, collectionId?: string, collectionCname?: string) => void;
+    goToProductList: ({ brandCname, brandId, categoryCname, categoryId, collectionCname, collectionId, }: {
+        brandCname?: string;
+        brandId?: string;
+        categoryCname?: string;
+        categoryId?: string;
+        collectionCname?: string;
+        collectionId?: string;
+    }) => void;
 };
 type NavigationActions = {
     /**
@@ -106,10 +113,13 @@ type NavigationActions = {
     goToInfoPage: () => void;
     /**
      * Navigate to specific store
-     * @param storeId - The store ID
-     * @param storeCname - The store CNAME
+     * @param cname - The store CNAME
+     * @param id - The store ID
      */
-    goToStore: (storeId?: string, storeCname?: string) => void;
+    goToStore: ({ cname, id }: {
+        cname?: string;
+        id?: string;
+    }) => void;
     /**
      * Navigate to store front
      */

package/dist/esm/types/ecommerce-extension.d.ts

@@ -1,4 +1,5 @@
 import type React from 'react';
+import type { Events } from './events';
 export type RemoteBoundaryComponent<P = {}> = React.FC<P> & {
     DataBridgeVersion: string;
 };
@@ -11,6 +12,8 @@ export type RemoteModuleRegistry = {
     StoreFrontHeader?: RemoteBoundaryComponent;
     StoreFrontNavigation?: RemoteBoundaryComponent;
     StoreFrontFooter?: RemoteBoundaryComponent;
+    StoreFrontCarouselInterstitials?: RemoteBoundaryComponent[];
     StoreFrontHero?: RemoteBoundaryComponent;
     ProductDetailsPrimary?: RemoteBoundaryComponent;
+    events?: Events;
 };

package/dist/esm/types/events.d.ts

@@ -0,0 +1,6 @@
+export type OnAfterCheckoutData = {
+    orderNumber: string;
+};
+export type Events = {
+    onAfterCheckout?: (data: OnAfterCheckoutData) => void;
+};

package/dist/index.cjs

@@ -15,6 +15,9 @@ var __webpack_modules__ = {
     "./types/ecommerce-extension": function(module) {
         module.exports = require("./types/ecommerce-extension.cjs");
     },
+    "./types/events": function(module) {
+        module.exports = require("./types/events.cjs");
+    },
     "./types/interface": function(module) {
         module.exports = require("./types/interface.cjs");
     }
@@ -92,10 +95,16 @@ var __webpack_exports__ = {};
         return _types_ecommerce_extension__WEBPACK_IMPORTED_MODULE_4__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _types_interface__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__("./types/interface");
+    var _types_events__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__("./types/events");
+    var __WEBPACK_REEXPORT_OBJECT__ = {};
+    for(var __WEBPACK_IMPORT_KEY__ in _types_events__WEBPACK_IMPORTED_MODULE_5__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _types_events__WEBPACK_IMPORTED_MODULE_5__[key];
+    }).bind(0, __WEBPACK_IMPORT_KEY__);
+    __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
+    var _types_interface__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__("./types/interface");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _types_interface__WEBPACK_IMPORTED_MODULE_5__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _types_interface__WEBPACK_IMPORTED_MODULE_5__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _types_interface__WEBPACK_IMPORTED_MODULE_6__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _types_interface__WEBPACK_IMPORTED_MODULE_6__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
 })();

package/dist/index.d.ts

@@ -3,4 +3,5 @@ export * from './context/ecommerce-data-bridge';
 export * from './types/actions';
 export * from './types/data';
 export * from './types/ecommerce-extension';
+export * from './types/events';
 export * from './types/interface';

package/dist/types/actions.d.ts

@@ -10,8 +10,8 @@ type AuthenticationActions = {
     goToRegister: () => void;
 };
 type GoToIdOrCnameParameters = {
-    id?: string;
     cname?: string;
+    id?: string;
 };
 type CartActions = {
     /**
@@ -90,14 +90,21 @@ type ListPageActions = {
     goToBrandList: () => void;
     /**
      * Navigate to product list
-     * @param categoryId - The category ID
-     * @param categoryCname - The category CNAME
-     * @param brandId - The brand ID
      * @param brandCname - The brand CNAME
-     * @param collectionId - The collection ID
+     * @param brandId - The brand ID
+     * @param categoryCname - The category CNAME
+     * @param categoryId - The category ID
      * @param collectionCname - The collection CNAME
+     * @param collectionId - The collection ID
      */
-    goToProductList: (categoryId?: string, categoryCname?: string, brandId?: string, brandCname?: string, collectionId?: string, collectionCname?: string) => void;
+    goToProductList: ({ brandCname, brandId, categoryCname, categoryId, collectionCname, collectionId, }: {
+        brandCname?: string;
+        brandId?: string;
+        categoryCname?: string;
+        categoryId?: string;
+        collectionCname?: string;
+        collectionId?: string;
+    }) => void;
 };
 type NavigationActions = {
     /**
@@ -106,10 +113,13 @@ type NavigationActions = {
     goToInfoPage: () => void;
     /**
      * Navigate to specific store
-     * @param storeId - The store ID
-     * @param storeCname - The store CNAME
+     * @param cname - The store CNAME
+     * @param id - The store ID
      */
-    goToStore: (storeId?: string, storeCname?: string) => void;
+    goToStore: ({ cname, id }: {
+        cname?: string;
+        id?: string;
+    }) => void;
     /**
      * Navigate to store front
      */

package/dist/types/ecommerce-extension.d.ts

@@ -1,4 +1,5 @@
 import type React from 'react';
+import type { Events } from './events';
 export type RemoteBoundaryComponent<P = {}> = React.FC<P> & {
     DataBridgeVersion: string;
 };
@@ -11,6 +12,8 @@ export type RemoteModuleRegistry = {
     StoreFrontHeader?: RemoteBoundaryComponent;
     StoreFrontNavigation?: RemoteBoundaryComponent;
     StoreFrontFooter?: RemoteBoundaryComponent;
+    StoreFrontCarouselInterstitials?: RemoteBoundaryComponent[];
     StoreFrontHero?: RemoteBoundaryComponent;
     ProductDetailsPrimary?: RemoteBoundaryComponent;
+    events?: Events;
 };

package/dist/types/events.cjs

@@ -0,0 +1,18 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+for(var __webpack_i__ in __webpack_exports__)exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/types/events.d.ts

@@ -0,0 +1,6 @@
+export type OnAfterCheckoutData = {
+    orderNumber: string;
+};
+export type Events = {
+    onAfterCheckout?: (data: OnAfterCheckoutData) => void;
+};

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.9.0",
+  "version": "0.10.1",
   "license": "MIT",
   "type": "module",
   "module": "./dist/esm/index.js",