@wix/sdk 1.9.1 → 1.9.3

package/build/auth/{AppOAuthStrategy.d.ts → AppStrategy.d.ts}

@@ -1,11 +1,11 @@
 import { AuthenticationStrategy } from '@wix/sdk-types';
-export type AppOAuthStrategy = AuthenticationStrategy<undefined, (opts: {
+export type AppStrategy = AuthenticationStrategy<undefined, (opts: {
     instanceId: string;
 } | {
     refreshToken: string;
 } | {
     fromRequest: Request;
-}) => AppOAuthStrategy> & {
+}) => AppStrategy> & {
     getInstallUrl(opts: {
         redirectUrl: string;
         state?: string;
@@ -31,11 +31,11 @@ export type AppOAuthStrategy = AuthenticationStrategy<undefined, (opts: {
  * @returns An authentication strategy that can be used with WixClient
  * @example
  * ```ts
- * import { AppOAuthStrategy, createClient } from '@wix/sdk';
+ * import { AppStrategy, createClient } from '@wix/sdk';
  * import { products } from '@wix/stores';
  *
  * const client = createClient({
- *  auth: AppOAuthStrategy({
+ *  auth: AppStrategy({
  *   appId: 'appId',
  *   appSecret: 'appSecret',
  *  }),
@@ -57,7 +57,7 @@ export type AppOAuthStrategy = AuthenticationStrategy<undefined, (opts: {
  *
  * ```
  */
-export declare function AppOAuthStrategy(opts: {
+export declare function AppStrategy(opts: {
     appId: string;
     appSecret?: string;
     publicKey?: string;
@@ -67,4 +67,4 @@ export declare function AppOAuthStrategy(opts: {
     instanceId?: string;
 } | {
     accessToken?: string;
-})): AppOAuthStrategy;
+})): AppStrategy;

package/build/auth/{AppOAuthStrategy.js → AppStrategy.js}

@@ -11,11 +11,11 @@ import { parsePublicKeyIfEncoded } from '../helpers.js';
  * @returns An authentication strategy that can be used with WixClient
  * @example
  * ```ts
- * import { AppOAuthStrategy, createClient } from '@wix/sdk';
+ * import { AppStrategy, createClient } from '@wix/sdk';
  * import { products } from '@wix/stores';
  *
  * const client = createClient({
- *  auth: AppOAuthStrategy({
+ *  auth: AppStrategy({
  *   appId: 'appId',
  *   appSecret: 'appSecret',
  *  }),
@@ -38,7 +38,7 @@ import { parsePublicKeyIfEncoded } from '../helpers.js';
  * ```
  */
 // eslint-disable-next-line @typescript-eslint/no-redeclare
-export function AppOAuthStrategy(opts) {
+export function AppStrategy(opts) {
     let refreshToken = 'refreshToken' in opts ? opts.refreshToken : undefined;
     return {
         getInstallUrl({ redirectUrl, token, state }) {
@@ -55,7 +55,7 @@ export function AppOAuthStrategy(opts) {
         },
         withAuth(params) {
             if ('instanceId' in params) {
-                return AppOAuthStrategy({
+                return AppStrategy({
                     appId: opts.appId,
                     appSecret: opts.appSecret,
                     publicKey: opts.publicKey,
@@ -63,7 +63,7 @@ export function AppOAuthStrategy(opts) {
                 });
             }
             else if ('refreshToken' in params) {
-                return AppOAuthStrategy({
+                return AppStrategy({
                     appId: opts.appId,
                     appSecret: opts.appSecret,
                     publicKey: opts.publicKey,
@@ -75,7 +75,7 @@ export function AppOAuthStrategy(opts) {
                 if (!authFromRequest) {
                     throw new Error('Missing Authorization header in the request');
                 }
-                return AppOAuthStrategy({
+                return AppStrategy({
                     appId: opts.appId,
                     appSecret: opts.appSecret,
                     publicKey: opts.publicKey,
@@ -88,7 +88,7 @@ export function AppOAuthStrategy(opts) {
         },
         async handleOAuthCallback(url, oauthOpts) {
             if (!opts.appSecret) {
-                throw new Error('App secret is required for handling OAuth callback. Make sure to pass it to the AppOAuthStrategy');
+                throw new Error('App secret is required for handling OAuth callback. Make sure to pass it to the AppStrategy');
             }
             const params = new URLSearchParams(new URL(url).search);
             const state = params.get('state');
@@ -125,7 +125,7 @@ export function AppOAuthStrategy(opts) {
         },
         async getAuthHeaders() {
             if (!opts.appSecret) {
-                throw new Error('App secret is required for retrieveing app-level access tokens. Make sure to pass it to the AppOAuthStrategy');
+                throw new Error('App secret is required for retrieveing app-level access tokens. Make sure to pass it to the AppStrategy');
             }
             if ('refreshToken' in opts || refreshToken) {
                 const tokensRes = await fetch('https://www.wixapis.com/oauth/access', {
@@ -182,12 +182,12 @@ export function AppOAuthStrategy(opts) {
                 };
             }
             else {
-                throw new Error('Missing refresh token or instance ID. Either one is needed to get app level access tokens. Make sure to pass one of them to the AppOAuthStrategy');
+                throw new Error('Missing refresh token or instance ID. Either one is needed to get app level access tokens. Make sure to pass one of them to the AppStrategy');
             }
         },
         async decodeJWT(token, verifyCallerClaims = false) {
             if (!opts.publicKey) {
-                throw new Error('Missing public key. Make sure to pass it to the AppOAuthStrategy');
+                throw new Error('Missing public key. Make sure to pass it to the AppStrategy');
             }
             const { jwtVerify, importSPKI } = await import('jose');
             const publicKey = await importSPKI(parsePublicKeyIfEncoded(opts.publicKey), 'RS256');

package/build/index.d.ts

@@ -3,7 +3,7 @@ export * from './wixMedia.js';
 export * from './auth/oauth2/OAuthStrategy.js';
 export * from './auth/oauth2/types.js';
 export * from './auth/ApiKeyAuthStrategy.js';
-export * from './auth/AppOAuthStrategy.js';
+export * from './auth/AppStrategy.js';
 export * from '@wix/sdk-types';
 export { getDefaultDomain } from './rest-modules.js';
 export { API_URL } from './common.js';

package/build/index.js

@@ -3,7 +3,7 @@ export * from './wixMedia.js';
 export * from './auth/oauth2/OAuthStrategy.js';
 export * from './auth/oauth2/types.js';
 export * from './auth/ApiKeyAuthStrategy.js';
-export * from './auth/AppOAuthStrategy.js';
+export * from './auth/AppStrategy.js';
 export * from '@wix/sdk-types';
 export { getDefaultDomain } from './rest-modules.js';
 export { API_URL } from './common.js';

package/build/wixClient.d.ts

@@ -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 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.

package/cjs/build/auth/{AppOAuthStrategy.d.ts → AppStrategy.d.ts}

@@ -1,11 +1,11 @@
 import { AuthenticationStrategy } from '@wix/sdk-types';
-export type AppOAuthStrategy = AuthenticationStrategy<undefined, (opts: {
+export type AppStrategy = AuthenticationStrategy<undefined, (opts: {
     instanceId: string;
 } | {
     refreshToken: string;
 } | {
     fromRequest: Request;
-}) => AppOAuthStrategy> & {
+}) => AppStrategy> & {
     getInstallUrl(opts: {
         redirectUrl: string;
         state?: string;
@@ -31,11 +31,11 @@ export type AppOAuthStrategy = AuthenticationStrategy<undefined, (opts: {
  * @returns An authentication strategy that can be used with WixClient
  * @example
  * ```ts
- * import { AppOAuthStrategy, createClient } from '@wix/sdk';
+ * import { AppStrategy, createClient } from '@wix/sdk';
  * import { products } from '@wix/stores';
  *
  * const client = createClient({
- *  auth: AppOAuthStrategy({
+ *  auth: AppStrategy({
  *   appId: 'appId',
  *   appSecret: 'appSecret',
  *  }),
@@ -57,7 +57,7 @@ export type AppOAuthStrategy = AuthenticationStrategy<undefined, (opts: {
  *
  * ```
  */
-export declare function AppOAuthStrategy(opts: {
+export declare function AppStrategy(opts: {
     appId: string;
     appSecret?: string;
     publicKey?: string;
@@ -67,4 +67,4 @@ export declare function AppOAuthStrategy(opts: {
     instanceId?: string;
 } | {
     accessToken?: string;
-})): AppOAuthStrategy;
+})): AppStrategy;

package/cjs/build/auth/{AppOAuthStrategy.js → AppStrategy.js}

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AppOAuthStrategy = void 0;
+exports.AppStrategy = void 0;
 const helpers_js_1 = require("../helpers.js");
 /**
  * Creates an authentication strategy for Wix Apps OAuth installation process.
@@ -37,11 +37,11 @@ const helpers_js_1 = require("../helpers.js");
  * @returns An authentication strategy that can be used with WixClient
  * @example
  * ```ts
- * import { AppOAuthStrategy, createClient } from '@wix/sdk';
+ * import { AppStrategy, createClient } from '@wix/sdk';
  * import { products } from '@wix/stores';
  *
  * const client = createClient({
- *  auth: AppOAuthStrategy({
+ *  auth: AppStrategy({
  *   appId: 'appId',
  *   appSecret: 'appSecret',
  *  }),
@@ -64,7 +64,7 @@ const helpers_js_1 = require("../helpers.js");
  * ```
  */
 // eslint-disable-next-line @typescript-eslint/no-redeclare
-function AppOAuthStrategy(opts) {
+function AppStrategy(opts) {
     let refreshToken = 'refreshToken' in opts ? opts.refreshToken : undefined;
     return {
         getInstallUrl({ redirectUrl, token, state }) {
@@ -81,7 +81,7 @@ function AppOAuthStrategy(opts) {
         },
         withAuth(params) {
             if ('instanceId' in params) {
-                return AppOAuthStrategy({
+                return AppStrategy({
                     appId: opts.appId,
                     appSecret: opts.appSecret,
                     publicKey: opts.publicKey,
@@ -89,7 +89,7 @@ function AppOAuthStrategy(opts) {
                 });
             }
             else if ('refreshToken' in params) {
-                return AppOAuthStrategy({
+                return AppStrategy({
                     appId: opts.appId,
                     appSecret: opts.appSecret,
                     publicKey: opts.publicKey,
@@ -101,7 +101,7 @@ function AppOAuthStrategy(opts) {
                 if (!authFromRequest) {
                     throw new Error('Missing Authorization header in the request');
                 }
-                return AppOAuthStrategy({
+                return AppStrategy({
                     appId: opts.appId,
                     appSecret: opts.appSecret,
                     publicKey: opts.publicKey,
@@ -114,7 +114,7 @@ function AppOAuthStrategy(opts) {
         },
         async handleOAuthCallback(url, oauthOpts) {
             if (!opts.appSecret) {
-                throw new Error('App secret is required for handling OAuth callback. Make sure to pass it to the AppOAuthStrategy');
+                throw new Error('App secret is required for handling OAuth callback. Make sure to pass it to the AppStrategy');
             }
             const params = new URLSearchParams(new URL(url).search);
             const state = params.get('state');
@@ -151,7 +151,7 @@ function AppOAuthStrategy(opts) {
         },
         async getAuthHeaders() {
             if (!opts.appSecret) {
-                throw new Error('App secret is required for retrieveing app-level access tokens. Make sure to pass it to the AppOAuthStrategy');
+                throw new Error('App secret is required for retrieveing app-level access tokens. Make sure to pass it to the AppStrategy');
             }
             if ('refreshToken' in opts || refreshToken) {
                 const tokensRes = await fetch('https://www.wixapis.com/oauth/access', {
@@ -208,12 +208,12 @@ function AppOAuthStrategy(opts) {
                 };
             }
             else {
-                throw new Error('Missing refresh token or instance ID. Either one is needed to get app level access tokens. Make sure to pass one of them to the AppOAuthStrategy');
+                throw new Error('Missing refresh token or instance ID. Either one is needed to get app level access tokens. Make sure to pass one of them to the AppStrategy');
             }
         },
         async decodeJWT(token, verifyCallerClaims = false) {
             if (!opts.publicKey) {
-                throw new Error('Missing public key. Make sure to pass it to the AppOAuthStrategy');
+                throw new Error('Missing public key. Make sure to pass it to the AppStrategy');
             }
             const { jwtVerify, importSPKI } = await Promise.resolve().then(() => __importStar(require('jose')));
             const publicKey = await importSPKI((0, helpers_js_1.parsePublicKeyIfEncoded)(opts.publicKey), 'RS256');
@@ -232,4 +232,4 @@ function AppOAuthStrategy(opts) {
         },
     };
 }
-exports.AppOAuthStrategy = AppOAuthStrategy;
+exports.AppStrategy = AppStrategy;

package/cjs/build/index.d.ts

@@ -3,7 +3,7 @@ export * from './wixMedia.js';
 export * from './auth/oauth2/OAuthStrategy.js';
 export * from './auth/oauth2/types.js';
 export * from './auth/ApiKeyAuthStrategy.js';
-export * from './auth/AppOAuthStrategy.js';
+export * from './auth/AppStrategy.js';
 export * from '@wix/sdk-types';
 export { getDefaultDomain } from './rest-modules.js';
 export { API_URL } from './common.js';

package/cjs/build/index.js

@@ -20,7 +20,7 @@ __exportStar(require("./wixMedia.js"), exports);
 __exportStar(require("./auth/oauth2/OAuthStrategy.js"), exports);
 __exportStar(require("./auth/oauth2/types.js"), exports);
 __exportStar(require("./auth/ApiKeyAuthStrategy.js"), exports);
-__exportStar(require("./auth/AppOAuthStrategy.js"), exports);
+__exportStar(require("./auth/AppStrategy.js"), exports);
 __exportStar(require("@wix/sdk-types"), exports);
 var rest_modules_js_1 = require("./rest-modules.js");
 Object.defineProperty(exports, "getDefaultDomain", { enumerable: true, get: function () { return rest_modules_js_1.getDefaultDomain; } });

package/cjs/build/wixClient.d.ts

@@ -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 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/sdk",
-  "version": "1.9.1",
+  "version": "1.9.3",
   "license": "UNLICENSED",
   "author": {
     "name": "Ronny Ringel",
@@ -32,8 +32,8 @@
       "require": "./cjs/build/auth/ApiKeyAuthStrategy.js"
     },
     "./auth/wix-app-oauth": {
-      "import": "./build/auth/WixAppOAuthStrategy.js",
-      "require": "./cjs/build/auth/WixAppOAuthStrategy.js"
+      "import": "./build/auth/AppStrategy.js",
+      "require": "./cjs/build/auth/AppStrategy.js"
     },
     "./auth/velo": {
       "import": "./build/auth/VeloAuthStrategy.js",
@@ -65,7 +65,7 @@
   "dependencies": {
     "@babel/runtime": "^7.23.2",
     "@wix/identity": "^1.0.78",
-    "@wix/image-kit": "^1.64.0",
+    "@wix/image-kit": "^1.67.0",
     "@wix/redirects": "^1.0.41",
     "@wix/sdk-types": "^1.6.3",
     "crypto-js": "^4.2.0",
@@ -120,5 +120,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "219609c03177070f1295b18ec0ca671a82f02205060dbcd7b9f45e2a"
+  "falconPackageHash": "b793f7d8e56d121118c1a7a6f27eb8df6d14f23cdc6399d6352dd96f"
 }