@wix/sdk 1.9.2 → 1.9.4

package/build/service-plugin-modules.d.ts

@@ -0,0 +1,15 @@
+import { ServicePluginContract, ServicePluginDefinition } from '@wix/sdk-types';
+export declare const isServicePluginModule: (val: any) => val is ServicePluginDefinition<ServicePluginContract>;
+export declare function buildServicePluginDefinition<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T, decodeJWT?: (token: string, verifyCallerClaims?: boolean) => Promise<{
+    decoded: {
+        data: string;
+    };
+    valid: boolean;
+}>): {
+    provide(implementation: T['__contract']): void;
+    processRequest(request: Request): Promise<Response>;
+    process: (request: {
+        url: string;
+        body: string;
+    }) => Promise<any>;
+};

package/build/service-plugin-modules.js

@@ -0,0 +1,36 @@
+import { isObject } from './helpers.js';
+export const isServicePluginModule = (val) => isObject(val) && val.__type === 'service-plugin-definition';
+export function buildServicePluginDefinition(servicePluginDefinition, decodeJWT) {
+    let impl;
+    async function process(request) {
+        if (!decodeJWT) {
+            throw new Error('decodeJWT is not supported by the authentication strategy');
+        }
+        const { decoded, valid } = await decodeJWT(request.body, true);
+        if (!valid) {
+            throw new Error('JWT is not valid');
+        }
+        const method = servicePluginDefinition.methods.find((m) => request.url.endsWith(m.primaryHttpMappingPath));
+        if (!method) {
+            throw new Error('Unexpect request: request url did not match any method: ' +
+                request.url);
+        }
+        const implMethod = impl[method.name];
+        if (!implMethod) {
+            throw new Error(`Got request for service plugin method ${method.name} but no implementation was provided. Available methods: ${Object.keys(impl).join(', ')}`);
+        }
+        return implMethod(method.transformations.fromREST(decoded.data));
+    }
+    return {
+        provide(implementation) {
+            impl = implementation;
+        },
+        async processRequest(request) {
+            const url = request.url;
+            const body = await request.text();
+            const implMethodResult = await process({ url, body });
+            return Response.json(implMethodResult);
+        },
+        process,
+    };
+}

package/build/wixClient.d.ts

@@ -1,4 +1,4 @@
-import { AuthenticationStrategy, BoundAuthenticationStrategy, BuildEventDefinition, BuildRESTFunction, EventDefinition, EventIdentity, Host, HostModule, HostModuleAPI, RESTFunctionDescriptor, SPIDefinition } from '@wix/sdk-types';
+import { AuthenticationStrategy, BoundAuthenticationStrategy, BuildEventDefinition, BuildRESTFunction, EventDefinition, EventIdentity, Host, HostModule, HostModuleAPI, RESTFunctionDescriptor, ServicePluginDefinition, BuildServicePluginDefinition } 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';
@@ -11,19 +11,12 @@ 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> & 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>;
-type BuildAmbassadorDescriptors<T extends Descriptors> = T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : ConditionalExcept<{
-    [Key in keyof T]: T[Key] extends Descriptors ? BuildAmbassadorDescriptors<T[Key]> : never;
-}, EmptyObject>;
-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>;
+export type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
+    done: T;
+    recurse: T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
+        [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [-1, 0, 1, 2, 3, 4, 5][Depth]> : never;
+    }, EmptyObject>;
+}[Depth extends -1 ? 'done' : 'recurse'];
 /**
  * Descriptors are objects that describe the API of a module, and the module
  * can either be a REST module or a host module.
@@ -55,7 +48,7 @@ type TypedQueryInput<Result = {
      */
     __ensureTypesOfVariablesAndResultMatching?: (variables: Variables) => Result;
 };
-export type WixClient<H extends Host<any> | undefined = undefined, Z extends AuthenticationStrategy<H> = AuthenticationStrategy<H>, T extends Descriptors = Descriptors> = {
+export type WixClient<H extends Host<any> | undefined = undefined, Z extends AuthenticationStrategy<H> = AuthenticationStrategy<H>, T extends Descriptors = {}> = {
     setHeaders(headers: Headers): void;
     auth: Omit<Z, 'getAuthHeaders'> & BoundAuthenticationStrategy;
     withAuth: Z['withAuth'] extends undefined ? never : (...args: Parameters<NonNullable<Z['withAuth']>>) => WixClient<H, Z, T>;
@@ -67,6 +60,7 @@ export type WixClient<H extends Host<any> | undefined = undefined, Z extends Aut
         errors?: GraphQLFormattedError[];
     }>;
     webhooks: {
+        getRegisteredEvents(): string[];
         process<ExpectedEvents extends EventDefinition<any>[] = []>(jwt: string, opts?: {
             expectedEvents: ExpectedEvents;
         }): Promise<ProcessedEvent<ExpectedEvents>>;
@@ -83,11 +77,6 @@ export type WixClient<H extends Host<any> | undefined = undefined, Z extends Aut
             }, 'AppRemoved'>;
         };
     };
-    spi: <S extends SPIDefinition<any, any>>() => {
-        process(jwt: string): Promise<S['__input']>;
-        processRequest(request: Request): Promise<S['__input']>;
-        result(result: S['__result']): S['__result'];
-    };
 } & BuildDescriptors<T, H>;
 type ResolvePossibleEvents<T extends EventDefinition<any>[]> = {
     [K in keyof T]: T[K] extends EventDefinition<any> ? {

package/build/wixClient.js

@@ -6,6 +6,7 @@ import { getDefaultContentHeader, isObject } from './helpers.js';
 import { buildHostModule, isHostModule } from './host-modules.js';
 import { buildRESTDescriptor } from './rest-modules.js';
 import { buildEventDefinition, isEventHandlerModule, runHandler, } from './event-handlers-modules.js';
+import { buildServicePluginDefinition, isServicePluginModule, } from './service-plugin-modules.js';
 export function createClient(config) {
     const _headers = config.headers || { Authorization: '' };
     const eventHandlers = new Map();
@@ -39,6 +40,9 @@ export function createClient(config) {
                 eventHandlers.set(eventDefinition.type, handlers);
             });
         }
+        else if (isServicePluginModule(modules)) {
+            return buildServicePluginDefinition(modules, authStrategy.decodeJWT);
+        }
         else if (isHostModule(modules) && config.host) {
             return buildHostModule(modules, config.host);
         }
@@ -119,6 +123,7 @@ export function createClient(config) {
             return { data: data ?? {}, errors };
         },
         webhooks: {
+            getRegisteredEvents: () => Array.from(eventHandlers.keys()),
             process: async (jwt, opts = {
                 expectedEvents: [],
             }) => {
@@ -167,26 +172,5 @@ export function createClient(config) {
                 AppRemoved: EventDefinition('AppRemoved')(),
             },
         },
-        spi() {
-            return {
-                async process(jwt) {
-                    if (!authStrategy.decodeJWT) {
-                        throw new Error('decodeJWT is not supported by the authentication strategy');
-                    }
-                    const { decoded, valid } = await authStrategy.decodeJWT(jwt, true);
-                    if (!valid) {
-                        throw new Error('JWT is not valid');
-                    }
-                    return decoded.data;
-                },
-                async processRequest(request) {
-                    const body = await request.text();
-                    return this.process(body);
-                },
-                result(result) {
-                    return result;
-                },
-            };
-        },
     };
 }

package/cjs/build/service-plugin-modules.d.ts

@@ -0,0 +1,15 @@
+import { ServicePluginContract, ServicePluginDefinition } from '@wix/sdk-types';
+export declare const isServicePluginModule: (val: any) => val is ServicePluginDefinition<ServicePluginContract>;
+export declare function buildServicePluginDefinition<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T, decodeJWT?: (token: string, verifyCallerClaims?: boolean) => Promise<{
+    decoded: {
+        data: string;
+    };
+    valid: boolean;
+}>): {
+    provide(implementation: T['__contract']): void;
+    processRequest(request: Request): Promise<Response>;
+    process: (request: {
+        url: string;
+        body: string;
+    }) => Promise<any>;
+};

package/cjs/build/service-plugin-modules.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildServicePluginDefinition = exports.isServicePluginModule = void 0;
+const helpers_js_1 = require("./helpers.js");
+const isServicePluginModule = (val) => (0, helpers_js_1.isObject)(val) && val.__type === 'service-plugin-definition';
+exports.isServicePluginModule = isServicePluginModule;
+function buildServicePluginDefinition(servicePluginDefinition, decodeJWT) {
+    let impl;
+    async function process(request) {
+        if (!decodeJWT) {
+            throw new Error('decodeJWT is not supported by the authentication strategy');
+        }
+        const { decoded, valid } = await decodeJWT(request.body, true);
+        if (!valid) {
+            throw new Error('JWT is not valid');
+        }
+        const method = servicePluginDefinition.methods.find((m) => request.url.endsWith(m.primaryHttpMappingPath));
+        if (!method) {
+            throw new Error('Unexpect request: request url did not match any method: ' +
+                request.url);
+        }
+        const implMethod = impl[method.name];
+        if (!implMethod) {
+            throw new Error(`Got request for service plugin method ${method.name} but no implementation was provided. Available methods: ${Object.keys(impl).join(', ')}`);
+        }
+        return implMethod(method.transformations.fromREST(decoded.data));
+    }
+    return {
+        provide(implementation) {
+            impl = implementation;
+        },
+        async processRequest(request) {
+            const url = request.url;
+            const body = await request.text();
+            const implMethodResult = await process({ url, body });
+            return Response.json(implMethodResult);
+        },
+        process,
+    };
+}
+exports.buildServicePluginDefinition = buildServicePluginDefinition;

package/cjs/build/wixClient.d.ts

@@ -1,4 +1,4 @@
-import { AuthenticationStrategy, BoundAuthenticationStrategy, BuildEventDefinition, BuildRESTFunction, EventDefinition, EventIdentity, Host, HostModule, HostModuleAPI, RESTFunctionDescriptor, SPIDefinition } from '@wix/sdk-types';
+import { AuthenticationStrategy, BoundAuthenticationStrategy, BuildEventDefinition, BuildRESTFunction, EventDefinition, EventIdentity, Host, HostModule, HostModuleAPI, RESTFunctionDescriptor, ServicePluginDefinition, BuildServicePluginDefinition } 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';
@@ -11,19 +11,12 @@ 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> & 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>;
-type BuildAmbassadorDescriptors<T extends Descriptors> = T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : ConditionalExcept<{
-    [Key in keyof T]: T[Key] extends Descriptors ? BuildAmbassadorDescriptors<T[Key]> : never;
-}, EmptyObject>;
-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>;
+export type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
+    done: T;
+    recurse: T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
+        [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [-1, 0, 1, 2, 3, 4, 5][Depth]> : never;
+    }, EmptyObject>;
+}[Depth extends -1 ? 'done' : 'recurse'];
 /**
  * Descriptors are objects that describe the API of a module, and the module
  * can either be a REST module or a host module.
@@ -55,7 +48,7 @@ type TypedQueryInput<Result = {
      */
     __ensureTypesOfVariablesAndResultMatching?: (variables: Variables) => Result;
 };
-export type WixClient<H extends Host<any> | undefined = undefined, Z extends AuthenticationStrategy<H> = AuthenticationStrategy<H>, T extends Descriptors = Descriptors> = {
+export type WixClient<H extends Host<any> | undefined = undefined, Z extends AuthenticationStrategy<H> = AuthenticationStrategy<H>, T extends Descriptors = {}> = {
     setHeaders(headers: Headers): void;
     auth: Omit<Z, 'getAuthHeaders'> & BoundAuthenticationStrategy;
     withAuth: Z['withAuth'] extends undefined ? never : (...args: Parameters<NonNullable<Z['withAuth']>>) => WixClient<H, Z, T>;
@@ -67,6 +60,7 @@ export type WixClient<H extends Host<any> | undefined = undefined, Z extends Aut
         errors?: GraphQLFormattedError[];
     }>;
     webhooks: {
+        getRegisteredEvents(): string[];
         process<ExpectedEvents extends EventDefinition<any>[] = []>(jwt: string, opts?: {
             expectedEvents: ExpectedEvents;
         }): Promise<ProcessedEvent<ExpectedEvents>>;
@@ -83,11 +77,6 @@ export type WixClient<H extends Host<any> | undefined = undefined, Z extends Aut
             }, 'AppRemoved'>;
         };
     };
-    spi: <S extends SPIDefinition<any, any>>() => {
-        process(jwt: string): Promise<S['__input']>;
-        processRequest(request: Request): Promise<S['__input']>;
-        result(result: S['__result']): S['__result'];
-    };
 } & BuildDescriptors<T, H>;
 type ResolvePossibleEvents<T extends EventDefinition<any>[]> = {
     [K in keyof T]: T[K] extends EventDefinition<any> ? {

package/cjs/build/wixClient.js

@@ -9,6 +9,7 @@ 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 event_handlers_modules_js_1 = require("./event-handlers-modules.js");
+const service_plugin_modules_js_1 = require("./service-plugin-modules.js");
 function createClient(config) {
     const _headers = config.headers || { Authorization: '' };
     const eventHandlers = new Map();
@@ -42,6 +43,9 @@ function createClient(config) {
                 eventHandlers.set(eventDefinition.type, handlers);
             });
         }
+        else if ((0, service_plugin_modules_js_1.isServicePluginModule)(modules)) {
+            return (0, service_plugin_modules_js_1.buildServicePluginDefinition)(modules, authStrategy.decodeJWT);
+        }
         else if ((0, host_modules_js_1.isHostModule)(modules) && config.host) {
             return (0, host_modules_js_1.buildHostModule)(modules, config.host);
         }
@@ -122,6 +126,7 @@ function createClient(config) {
             return { data: data ?? {}, errors };
         },
         webhooks: {
+            getRegisteredEvents: () => Array.from(eventHandlers.keys()),
             process: async (jwt, opts = {
                 expectedEvents: [],
             }) => {
@@ -170,27 +175,6 @@ function createClient(config) {
                 AppRemoved: (0, sdk_types_1.EventDefinition)('AppRemoved')(),
             },
         },
-        spi() {
-            return {
-                async process(jwt) {
-                    if (!authStrategy.decodeJWT) {
-                        throw new Error('decodeJWT is not supported by the authentication strategy');
-                    }
-                    const { decoded, valid } = await authStrategy.decodeJWT(jwt, true);
-                    if (!valid) {
-                        throw new Error('JWT is not valid');
-                    }
-                    return decoded.data;
-                },
-                async processRequest(request) {
-                    const body = await request.text();
-                    return this.process(body);
-                },
-                result(result) {
-                    return result;
-                },
-            };
-        },
     };
 }
 exports.createClient = createClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/sdk",
-  "version": "1.9.2",
+  "version": "1.9.4",
   "license": "UNLICENSED",
   "author": {
     "name": "Ronny Ringel",
@@ -67,7 +67,7 @@
     "@wix/identity": "^1.0.78",
     "@wix/image-kit": "^1.67.0",
     "@wix/redirects": "^1.0.41",
-    "@wix/sdk-types": "^1.6.3",
+    "@wix/sdk-types": "^1.7.0",
     "crypto-js": "^4.2.0",
     "jose": "^5.2.1",
     "pkce-challenge": "^3.1.0",
@@ -120,5 +120,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "71774a6a839caae0eb644c899a798b3b14296d9c6321d8fae8dfeca5"
+  "falconPackageHash": "4b5ab480b70debacfd197e4f868613a615cd3854cb5b8b0aff383862"
 }