@wix/sdk 1.7.13 → 1.8.0

package/build/event-handlers-modules.d.ts

@@ -0,0 +1,3 @@
+import { EventDefinition, EventHandler } from '@wix/sdk-types';
+export declare const isEventHandlerModule: (val: any) => val is EventDefinition<unknown, string>;
+export declare function buildEventDefinition<T extends EventDefinition<any, string>>(eventDefinition: T, registerHandler: (eventType: string, handler: EventHandler<T>) => void): (handler: EventHandler<T>) => void;

package/build/event-handlers-modules.js

@@ -0,0 +1,7 @@
+import { isObject } from './helpers.js';
+export const isEventHandlerModule = (val) => isObject(val) && val.__type === 'event-definition';
+export function buildEventDefinition(eventDefinition, registerHandler) {
+    return (handler) => {
+        registerHandler(eventDefinition.type, handler);
+    };
+}

package/build/wix-context.d.ts

@@ -1,52 +1,5 @@
-/// <reference types="node" resolution-mode="require"/>
-import { AsyncLocalStorage } from 'node:async_hooks';
-import { BuildDescriptors, BuildRESTFunction, Descriptors, Host, RESTFunctionDescriptor } from './index.js';
-export type MaybeWithWixContext<T extends RESTFunctionDescriptor> = typeof globalThis extends {
-    __wix_context__: {
-        initWixModules: unknown;
-    };
-} ? BuildRESTFunction<T> : T;
-declare namespace globalThis {
-    let __wix_context__: {
-        asyncLocalStorage?: import('node:async_hooks').AsyncLocalStorage<{
-            authStrategy: {
-                getAuthHeaders: () => Promise<{
-                    headers: {
-                        Authorization: string;
-                    };
-                }>;
-            };
-        }>;
-        initWixModules: unknown;
-    };
-}
-export declare function setGlobalWixModulesInit(initWixModules: <T extends Descriptors, H extends Host>(wixModules: T) => BuildDescriptors<T, H>): void;
-export declare const AsyncLocalStorageContext: {
-    asyncLocalStorage: AsyncLocalStorage<{
-        authStrategy: {
-            getAuthHeaders: () => Promise<{
-                headers: {
-                    Authorization: string;
-                };
-            }>;
-        };
-    }> | undefined;
-    init(AsyncLocalStorageConstructor: typeof AsyncLocalStorage): void;
-    run(authStrategy: {
-        getAuthHeaders: () => Promise<{
-            headers: {
-                Authorization: string;
-            };
-        }>;
-    }, fn: () => unknown): unknown;
+import { BuildDescriptors, Descriptors, Host } from './index.js';
+export type WixContext = {
+    initWixModules: <T extends Descriptors, H extends Host>(wixModules: T, elevated?: boolean) => BuildDescriptors<T, H>;
 };
-export declare const GlobalSingletonContext: {
-    init(authStrategy: {
-        getAuthHeaders: () => Promise<{
-            headers: {
-                Authorization: string;
-            };
-        }>;
-    }): void;
-};
-export {};
+export declare function setGlobalWixContext(wixContext: WixContext): void;

package/build/wix-context.js

@@ -1,52 +1,3 @@
-import { createClient, } from './index.js';
-export function setGlobalWixModulesInit(initWixModules) {
-    globalThis.__wix_context__ = {
-        initWixModules,
-    };
+export function setGlobalWixContext(wixContext) {
+    globalThis.__wix_context__ = wixContext;
 }
-export const AsyncLocalStorageContext = {
-    asyncLocalStorage: undefined,
-    init(AsyncLocalStorageConstructor) {
-        const asyncLocalStorage = new AsyncLocalStorageConstructor();
-        this.asyncLocalStorage = asyncLocalStorage;
-        setGlobalWixModulesInit((wixModules) => {
-            const client = createClient({
-                auth: {
-                    async getAuthHeaders() {
-                        const store = asyncLocalStorage.getStore();
-                        if (!store) {
-                            throw new Error('No wix context found, make sure to init and use wix context');
-                        }
-                        return store.authStrategy.getAuthHeaders();
-                    },
-                },
-            });
-            return client.use(wixModules);
-        });
-    },
-    run(authStrategy, fn) {
-        if (!globalThis.__wix_context__) {
-            throw new Error('Wix context not initialized');
-        }
-        if (this.asyncLocalStorage) {
-            return this.asyncLocalStorage.run({ authStrategy }, fn);
-        }
-        else {
-            throw new Error('AsyncLocalStorageContext: `run` has been called before `init` method. Make sure to call `init` method before using `run` method.');
-        }
-    },
-};
-export const GlobalSingletonContext = {
-    init(authStrategy) {
-        setGlobalWixModulesInit((wixModules) => {
-            const client = createClient({
-                auth: {
-                    async getAuthHeaders() {
-                        return authStrategy.getAuthHeaders();
-                    },
-                },
-            });
-            return client.use(wixModules);
-        });
-    },
-};

package/build/wixClient.d.ts

@@ -1,6 +1,6 @@
-import { AuthenticationStrategy, BoundAuthenticationStrategy, BuildRESTFunction, Host, HostModule, HostModuleAPI, RESTFunctionDescriptor, SPIDefinition, EventDefinition } from '@wix/sdk-types';
-import { EmptyObject } from 'type-fest/source/empty-object.js';
+import { AuthenticationStrategy, BoundAuthenticationStrategy, BuildEventDefinition, BuildRESTFunction, EventDefinition, Host, HostModule, HostModuleAPI, RESTFunctionDescriptor, SPIDefinition } from '@wix/sdk-types';
 import { ConditionalExcept } from 'type-fest/source/conditional-except.js';
+import { EmptyObject } from 'type-fest/source/empty-object.js';
 import { AmbassadorFunctionDescriptor, BuildAmbassadorFunction } from './ambassador-modules.js';
 import { PublicMetadata } from './common.js';
 import type { GraphQLFormattedError } from 'graphql';
@@ -11,7 +11,7 @@ type Headers = Record<string, string>;
  * Any non-descriptor properties are removed from the returned object, including descriptors that
  * do not match the given host (as they will not work with the given host).
  */
-export type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined> = BuildRESTDescriptors<T> & BuildAmbassadorDescriptors<T> & (H extends Host<any> ? BuildHostDescriptors<T> : {});
+export type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined> = BuildRESTDescriptors<T> & BuildAmbassadorDescriptors<T> & BuildEventDefinitions<T> & (H extends Host<any> ? BuildHostDescriptors<T> : {});
 type BuildRESTDescriptors<T extends Descriptors> = T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : ConditionalExcept<{
     [Key in keyof T]: T[Key] extends Descriptors ? BuildRESTDescriptors<T[Key]> : never;
 }, EmptyObject>;
@@ -21,6 +21,9 @@ type BuildAmbassadorDescriptors<T extends Descriptors> = T extends AmbassadorFun
 type BuildHostDescriptors<T extends Descriptors> = T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
     [Key in keyof T]: T[Key] extends Descriptors ? BuildHostDescriptors<T[Key]> : never;
 }, EmptyObject>;
+type BuildEventDefinitions<T extends Descriptors> = T extends EventDefinition ? BuildEventDefinition<T> : ConditionalExcept<{
+    [Key in keyof T]: T[Key] extends Descriptors ? BuildEventDefinitions<T[Key]> : never;
+}, EmptyObject>;
 /**
  * Descriptors are objects that describe the API of a module, and the module
  * can either be a REST module or a host module.

package/build/wixClient.js

@@ -1,12 +1,14 @@
 import { EventDefinition, } from '@wix/sdk-types';
-import { toHTTPModule, isAmbassadorModule, ambassadorModuleOptions, } from './ambassador-modules.js';
+import { ambassadorModuleOptions, isAmbassadorModule, toHTTPModule, } from './ambassador-modules.js';
 import { API_URL, PUBLIC_METADATA_KEY } from './common.js';
+import { FetchErrorResponse } from './fetch-error.js';
 import { getDefaultContentHeader, isObject } from './helpers.js';
 import { buildHostModule, isHostModule } from './host-modules.js';
 import { buildRESTDescriptor } from './rest-modules.js';
-import { FetchErrorResponse } from './fetch-error.js';
+import { buildEventDefinition, isEventHandlerModule, } from './event-handlers-modules.js';
 export function createClient(config) {
     const _headers = config.headers || { Authorization: '' };
+    const eventHandlers = new Map();
     const authStrategy = config.auth ||
         {
             getAuthHeaders: (_) => Promise.resolve({ headers: {} }),
@@ -30,7 +32,14 @@ export function createClient(config) {
     // on the WixClient, typescript starts failing with `Type instantiation is
     // excessively deep and possibly infinite.`
     const use = (modules, metadata) => {
-        if (isHostModule(modules) && config.host) {
+        if (isEventHandlerModule(modules)) {
+            return buildEventDefinition(modules, (eventType, handler) => {
+                const handlers = eventHandlers.get(eventType) ?? [];
+                handlers.push(handler);
+                eventHandlers.set(eventType, handlers);
+            });
+        }
+        else if (isHostModule(modules) && config.host) {
             return buildHostModule(modules, config.host);
         }
         else if (typeof modules === 'function') {
@@ -124,12 +133,20 @@ export function createClient(config) {
                 const eventType = parsedDecoded.eventType;
                 const instanceId = parsedDecoded.instanceId;
                 const payload = JSON.parse(parsedDecoded.data);
-                if (opts.expectedEvents.length > 0 &&
-                    !opts.expectedEvents.some(({ type }) => type === eventType)) {
-                    throw new Error(`Unexpected event type: ${eventType}. Expected one of: ${opts.expectedEvents
+                const allExpectedEvents = [
+                    ...opts.expectedEvents,
+                    ...Array.from(eventHandlers.keys()).map((type) => ({ type })),
+                ];
+                if (allExpectedEvents.length > 0 &&
+                    !allExpectedEvents.some(({ type }) => type === eventType)) {
+                    throw new Error(`Unexpected event type: ${eventType}. Expected one of: ${allExpectedEvents
                         .map((x) => x.type)
                         .join(', ')}`);
                 }
+                const handlers = eventHandlers.get(eventType) ?? [];
+                await Promise.all(handlers.map((handler) => handler(payload, {
+                    instanceId,
+                })));
                 return {
                     instanceId,
                     eventType,

package/cjs/build/event-handlers-modules.d.ts

@@ -0,0 +1,3 @@
+import { EventDefinition, EventHandler } from '@wix/sdk-types';
+export declare const isEventHandlerModule: (val: any) => val is EventDefinition<unknown, string>;
+export declare function buildEventDefinition<T extends EventDefinition<any, string>>(eventDefinition: T, registerHandler: (eventType: string, handler: EventHandler<T>) => void): (handler: EventHandler<T>) => void;

package/cjs/build/event-handlers-modules.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildEventDefinition = exports.isEventHandlerModule = void 0;
+const helpers_js_1 = require("./helpers.js");
+const isEventHandlerModule = (val) => (0, helpers_js_1.isObject)(val) && val.__type === 'event-definition';
+exports.isEventHandlerModule = isEventHandlerModule;
+function buildEventDefinition(eventDefinition, registerHandler) {
+    return (handler) => {
+        registerHandler(eventDefinition.type, handler);
+    };
+}
+exports.buildEventDefinition = buildEventDefinition;

package/cjs/build/wix-context.d.ts

@@ -1,52 +1,5 @@
-/// <reference types="node" />
-import { AsyncLocalStorage } from 'node:async_hooks';
-import { BuildDescriptors, BuildRESTFunction, Descriptors, Host, RESTFunctionDescriptor } from './index.js';
-export type MaybeWithWixContext<T extends RESTFunctionDescriptor> = typeof globalThis extends {
-    __wix_context__: {
-        initWixModules: unknown;
-    };
-} ? BuildRESTFunction<T> : T;
-declare namespace globalThis {
-    let __wix_context__: {
-        asyncLocalStorage?: import('node:async_hooks').AsyncLocalStorage<{
-            authStrategy: {
-                getAuthHeaders: () => Promise<{
-                    headers: {
-                        Authorization: string;
-                    };
-                }>;
-            };
-        }>;
-        initWixModules: unknown;
-    };
-}
-export declare function setGlobalWixModulesInit(initWixModules: <T extends Descriptors, H extends Host>(wixModules: T) => BuildDescriptors<T, H>): void;
-export declare const AsyncLocalStorageContext: {
-    asyncLocalStorage: AsyncLocalStorage<{
-        authStrategy: {
-            getAuthHeaders: () => Promise<{
-                headers: {
-                    Authorization: string;
-                };
-            }>;
-        };
-    }> | undefined;
-    init(AsyncLocalStorageConstructor: typeof AsyncLocalStorage): void;
-    run(authStrategy: {
-        getAuthHeaders: () => Promise<{
-            headers: {
-                Authorization: string;
-            };
-        }>;
-    }, fn: () => unknown): unknown;
+import { BuildDescriptors, Descriptors, Host } from './index.js';
+export type WixContext = {
+    initWixModules: <T extends Descriptors, H extends Host>(wixModules: T, elevated?: boolean) => BuildDescriptors<T, H>;
 };
-export declare const GlobalSingletonContext: {
-    init(authStrategy: {
-        getAuthHeaders: () => Promise<{
-            headers: {
-                Authorization: string;
-            };
-        }>;
-    }): void;
-};
-export {};
+export declare function setGlobalWixContext(wixContext: WixContext): void;

package/cjs/build/wix-context.js

@@ -1,56 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GlobalSingletonContext = exports.AsyncLocalStorageContext = exports.setGlobalWixModulesInit = void 0;
-const index_js_1 = require("./index.js");
-function setGlobalWixModulesInit(initWixModules) {
-    globalThis.__wix_context__ = {
-        initWixModules,
-    };
+exports.setGlobalWixContext = void 0;
+function setGlobalWixContext(wixContext) {
+    globalThis.__wix_context__ = wixContext;
 }
-exports.setGlobalWixModulesInit = setGlobalWixModulesInit;
-exports.AsyncLocalStorageContext = {
-    asyncLocalStorage: undefined,
-    init(AsyncLocalStorageConstructor) {
-        const asyncLocalStorage = new AsyncLocalStorageConstructor();
-        this.asyncLocalStorage = asyncLocalStorage;
-        setGlobalWixModulesInit((wixModules) => {
-            const client = (0, index_js_1.createClient)({
-                auth: {
-                    async getAuthHeaders() {
-                        const store = asyncLocalStorage.getStore();
-                        if (!store) {
-                            throw new Error('No wix context found, make sure to init and use wix context');
-                        }
-                        return store.authStrategy.getAuthHeaders();
-                    },
-                },
-            });
-            return client.use(wixModules);
-        });
-    },
-    run(authStrategy, fn) {
-        if (!globalThis.__wix_context__) {
-            throw new Error('Wix context not initialized');
-        }
-        if (this.asyncLocalStorage) {
-            return this.asyncLocalStorage.run({ authStrategy }, fn);
-        }
-        else {
-            throw new Error('AsyncLocalStorageContext: `run` has been called before `init` method. Make sure to call `init` method before using `run` method.');
-        }
-    },
-};
-exports.GlobalSingletonContext = {
-    init(authStrategy) {
-        setGlobalWixModulesInit((wixModules) => {
-            const client = (0, index_js_1.createClient)({
-                auth: {
-                    async getAuthHeaders() {
-                        return authStrategy.getAuthHeaders();
-                    },
-                },
-            });
-            return client.use(wixModules);
-        });
-    },
-};
+exports.setGlobalWixContext = setGlobalWixContext;

package/cjs/build/wixClient.d.ts

@@ -1,6 +1,6 @@
-import { AuthenticationStrategy, BoundAuthenticationStrategy, BuildRESTFunction, Host, HostModule, HostModuleAPI, RESTFunctionDescriptor, SPIDefinition, EventDefinition } from '@wix/sdk-types';
-import { EmptyObject } from 'type-fest/source/empty-object.js';
+import { AuthenticationStrategy, BoundAuthenticationStrategy, BuildEventDefinition, BuildRESTFunction, EventDefinition, Host, HostModule, HostModuleAPI, RESTFunctionDescriptor, SPIDefinition } from '@wix/sdk-types';
 import { ConditionalExcept } from 'type-fest/source/conditional-except.js';
+import { EmptyObject } from 'type-fest/source/empty-object.js';
 import { AmbassadorFunctionDescriptor, BuildAmbassadorFunction } from './ambassador-modules.js';
 import { PublicMetadata } from './common.js';
 import type { GraphQLFormattedError } from 'graphql';
@@ -11,7 +11,7 @@ type Headers = Record<string, string>;
  * Any non-descriptor properties are removed from the returned object, including descriptors that
  * do not match the given host (as they will not work with the given host).
  */
-export type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined> = BuildRESTDescriptors<T> & BuildAmbassadorDescriptors<T> & (H extends Host<any> ? BuildHostDescriptors<T> : {});
+export type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined> = BuildRESTDescriptors<T> & BuildAmbassadorDescriptors<T> & BuildEventDefinitions<T> & (H extends Host<any> ? BuildHostDescriptors<T> : {});
 type BuildRESTDescriptors<T extends Descriptors> = T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : ConditionalExcept<{
     [Key in keyof T]: T[Key] extends Descriptors ? BuildRESTDescriptors<T[Key]> : never;
 }, EmptyObject>;
@@ -21,6 +21,9 @@ type BuildAmbassadorDescriptors<T extends Descriptors> = T extends AmbassadorFun
 type BuildHostDescriptors<T extends Descriptors> = T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
     [Key in keyof T]: T[Key] extends Descriptors ? BuildHostDescriptors<T[Key]> : never;
 }, EmptyObject>;
+type BuildEventDefinitions<T extends Descriptors> = T extends EventDefinition ? BuildEventDefinition<T> : ConditionalExcept<{
+    [Key in keyof T]: T[Key] extends Descriptors ? BuildEventDefinitions<T[Key]> : never;
+}, EmptyObject>;
 /**
  * Descriptors are objects that describe the API of a module, and the module
  * can either be a REST module or a host module.

package/cjs/build/wixClient.js

@@ -4,12 +4,14 @@ exports.createClient = void 0;
 const sdk_types_1 = require("@wix/sdk-types");
 const ambassador_modules_js_1 = require("./ambassador-modules.js");
 const common_js_1 = require("./common.js");
+const fetch_error_js_1 = require("./fetch-error.js");
 const helpers_js_1 = require("./helpers.js");
 const host_modules_js_1 = require("./host-modules.js");
 const rest_modules_js_1 = require("./rest-modules.js");
-const fetch_error_js_1 = require("./fetch-error.js");
+const event_handlers_modules_js_1 = require("./event-handlers-modules.js");
 function createClient(config) {
     const _headers = config.headers || { Authorization: '' };
+    const eventHandlers = new Map();
     const authStrategy = config.auth ||
         {
             getAuthHeaders: (_) => Promise.resolve({ headers: {} }),
@@ -33,7 +35,14 @@ function createClient(config) {
     // on the WixClient, typescript starts failing with `Type instantiation is
     // excessively deep and possibly infinite.`
     const use = (modules, metadata) => {
-        if ((0, host_modules_js_1.isHostModule)(modules) && config.host) {
+        if ((0, event_handlers_modules_js_1.isEventHandlerModule)(modules)) {
+            return (0, event_handlers_modules_js_1.buildEventDefinition)(modules, (eventType, handler) => {
+                const handlers = eventHandlers.get(eventType) ?? [];
+                handlers.push(handler);
+                eventHandlers.set(eventType, handlers);
+            });
+        }
+        else if ((0, host_modules_js_1.isHostModule)(modules) && config.host) {
             return (0, host_modules_js_1.buildHostModule)(modules, config.host);
         }
         else if (typeof modules === 'function') {
@@ -127,12 +136,20 @@ function createClient(config) {
                 const eventType = parsedDecoded.eventType;
                 const instanceId = parsedDecoded.instanceId;
                 const payload = JSON.parse(parsedDecoded.data);
-                if (opts.expectedEvents.length > 0 &&
-                    !opts.expectedEvents.some(({ type }) => type === eventType)) {
-                    throw new Error(`Unexpected event type: ${eventType}. Expected one of: ${opts.expectedEvents
+                const allExpectedEvents = [
+                    ...opts.expectedEvents,
+                    ...Array.from(eventHandlers.keys()).map((type) => ({ type })),
+                ];
+                if (allExpectedEvents.length > 0 &&
+                    !allExpectedEvents.some(({ type }) => type === eventType)) {
+                    throw new Error(`Unexpected event type: ${eventType}. Expected one of: ${allExpectedEvents
                         .map((x) => x.type)
                         .join(', ')}`);
                 }
+                const handlers = eventHandlers.get(eventType) ?? [];
+                await Promise.all(handlers.map((handler) => handler(payload, {
+                    instanceId,
+                })));
                 return {
                     instanceId,
                     eventType,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/sdk",
-  "version": "1.7.13",
+  "version": "1.8.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Ronny Ringel",
@@ -64,10 +64,10 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.23.2",
-    "@wix/identity": "^1.0.74",
-    "@wix/image-kit": "^1.62.0",
-    "@wix/redirects": "^1.0.36",
-    "@wix/sdk-types": "^1.5.11",
+    "@wix/identity": "^1.0.78",
+    "@wix/image-kit": "^1.64.0",
+    "@wix/redirects": "^1.0.41",
+    "@wix/sdk-types": "^1.6.0",
     "crypto-js": "^4.2.0",
     "jose": "^5.2.1",
     "pkce-challenge": "^3.1.0",
@@ -81,12 +81,12 @@
     "@types/crypto-js": "^4.2.1",
     "@types/is-ci": "^3.0.4",
     "@types/node": "^20.10.6",
-    "@vitest/ui": "^1.1.3",
-    "@wix/ecom": "^1.0.515",
-    "@wix/events": "^1.0.166",
+    "@vitest/ui": "^1.5.0",
+    "@wix/ecom": "^1.0.531",
+    "@wix/events": "^1.0.179",
     "@wix/metro": "^1.0.73",
-    "@wix/metro-runtime": "^1.1669.0",
-    "@wix/sdk-runtime": "0.2.8",
+    "@wix/metro-runtime": "^1.1677.0",
+    "@wix/sdk-runtime": "0.2.11",
     "eslint": "^8.56.0",
     "eslint-config-sdk": "0.0.0",
     "graphql": "^16.8.0",
@@ -94,8 +94,8 @@
     "jsdom": "^22.1.0",
     "msw": "^2.0.12",
     "typescript": "^5.3.3",
-    "vitest": "^1.1.3",
-    "vitest-teamcity-reporter": "^0.2.2"
+    "vitest": "^1.5.0",
+    "vitest-teamcity-reporter": "^0.3.0"
   },
   "yoshiFlowLibrary": {
     "buildEsmWithBabel": true
@@ -120,5 +120,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "1955a1aa963ce3cfdf50a41a96d5e647c2886dfd828e7e78d74353b3"
+  "falconPackageHash": "869d627fd63d9aa37f08f30fc48dba3f34415f3d3ec6fa776a9ab4eb"
 }