@wix/sdk 1.12.6 → 1.12.7

package/build/auth/AppStrategy.d.ts

@@ -12,7 +12,23 @@ export type AppStrategy = AuthenticationStrategy<undefined> & {
         accessToken: string;
         refreshToken: string;
     }>;
+    /**
+     * Return a new instance of the AppStrategy which uses an elevated access token
+     */
     elevated(): Promise<AppStrategy>;
+    /**
+     * Returns infromation about the active token
+     */
+    getTokenInfo(): Promise<{
+        active: boolean;
+        subjectType: 'APP' | 'USER' | 'MEMBER' | 'VISITOR' | 'UNKNOWN';
+        subjectId: string;
+        exp: number;
+        iat: number;
+        clientId?: string;
+        siteId: string;
+        instanceId?: string;
+    }>;
 };
 /**
  * Creates an authentication strategy for Wix Apps OAuth installation process.
@@ -22,6 +38,7 @@ export type AppStrategy = AuthenticationStrategy<undefined> & {
  * @param opts.appSecret The Wix App Secret
  * @param opts.refreshToken An optional refresh token previously retrieved from Wix OAuth API
  * @param opts.instanceId An optional instance ID of the Wix App instance the client is making requests on behalf of
+ * @param opts.accessToken An optional access token previously retrieved from a client Wix Extension
  * @param opts.publicKey An optional public key for validating webhook requests (supports both PEM and base64 encoded keys)
  * @returns An authentication strategy that can be used with WixClient
  * @example

package/build/auth/AppStrategy.js

@@ -7,6 +7,7 @@ import { parsePublicKeyIfEncoded } from '../helpers.js';
  * @param opts.appSecret The Wix App Secret
  * @param opts.refreshToken An optional refresh token previously retrieved from Wix OAuth API
  * @param opts.instanceId An optional instance ID of the Wix App instance the client is making requests on behalf of
+ * @param opts.accessToken An optional access token previously retrieved from a client Wix Extension
  * @param opts.publicKey An optional public key for validating webhook requests (supports both PEM and base64 encoded keys)
  * @returns An authentication strategy that can be used with WixClient
  * @example
@@ -91,10 +92,10 @@ export function AppStrategy(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 AppStrategy');
-            }
             if ('refreshToken' in opts || refreshToken) {
+                if (!opts.appSecret) {
+                    throw new Error('App secret is required for retrieveing app-level access tokens. Make sure to pass it to the AppStrategy');
+                }
                 const tokensRes = await fetch('https://www.wixapis.com/oauth/access', {
                     method: 'POST',
                     headers: {
@@ -119,6 +120,9 @@ export function AppStrategy(opts) {
                 };
             }
             else if ('instanceId' in opts) {
+                if (!opts.appSecret) {
+                    throw new Error('App secret is required for retrieveing app-level access tokens. Make sure to pass it to the AppStrategy');
+                }
                 const tokensRes = await fetch('https://www.wixapis.com/oauth2/token', {
                     method: 'POST',
                     headers: {
@@ -154,20 +158,8 @@ export function AppStrategy(opts) {
         },
         async elevated() {
             if ('accessToken' in opts && opts.accessToken) {
-                const tokenInfoRes = await fetch('https://www.wixapis.com/oauth2/token-info', {
-                    method: 'POST',
-                    headers: {
-                        'Content-Type': 'application/json',
-                    },
-                    body: JSON.stringify({
-                        token: opts.accessToken,
-                    }),
-                });
-                if (tokenInfoRes.status !== 200) {
-                    throw new Error(`Failed to get token info. Unexpected status code from Wix OAuth API: ${tokenInfoRes.status}`);
-                }
-                const tokenInfo = await tokenInfoRes.json();
-                if (tokenInfo.app_id !== opts.appId) {
+                const tokenInfo = await getTokenInfo(opts.accessToken);
+                if (tokenInfo.clientId !== opts.appId) {
                     throw new Error(`Invalid access token. The token is not issued for the app with ID "${opts.appId}"`);
                 }
                 if (!tokenInfo.instanceId) {
@@ -203,5 +195,27 @@ export function AppStrategy(opts) {
                 valid: true,
             };
         },
+        async getTokenInfo() {
+            const tokenToCheck = refreshToken ?? ('accessToken' in opts ? opts.accessToken : undefined);
+            if (!tokenToCheck) {
+                throw new Error('Missing token to get info for. Either pass the token as an argument or provide it when initializing the AppStrategy');
+            }
+            return getTokenInfo(tokenToCheck);
+        },
     };
 }
+async function getTokenInfo(token) {
+    const tokenInfoRes = await fetch('https://www.wixapis.com/oauth2/token-info', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({
+            token,
+        }),
+    });
+    if (tokenInfoRes.status !== 200) {
+        throw new Error(`Failed to get token info. Unexpected status code from Wix OAuth API: ${tokenInfoRes.status}`);
+    }
+    return (await tokenInfoRes.json());
+}

package/build/graphql.d.ts

@@ -1,4 +1,5 @@
 import { DocumentNode, GraphQLFormattedError } from 'graphql';
+import { RESTFunctionDescriptor } from '@wix/sdk-types';
 export type TypedQueryInput<Result = {
     [key: string]: any;
 }, Variables = {
@@ -15,14 +16,14 @@ export type TypedQueryInput<Result = {
      */
     __ensureTypesOfVariablesAndResultMatching?: (variables: Variables) => Result;
 };
-export declare const graphql: ((query: string | String | DocumentNode | TypedQueryInput<unknown, any>, variables?: any, opts?: {
+export declare const graphql: (<Result, Variables>(query: string | String | DocumentNode | TypedQueryInput<Result, Variables>, variables?: Variables | undefined, opts?: {
     apiVersion: string;
 }) => Promise<{
-    data: unknown;
+    data: Result;
     errors?: GraphQLFormattedError[] | undefined;
-}>) & ((restModuleOpts: import("@wix/sdk-types").HttpClient) => (query: string | String | DocumentNode | TypedQueryInput<unknown, any>, variables?: any, opts?: {
+}>) & RESTFunctionDescriptor<(<Result, Variables>(query: string | String | DocumentNode | TypedQueryInput<Result, Variables>, variables?: Variables | undefined, opts?: {
     apiVersion: string;
 }) => Promise<{
-    data: unknown;
+    data: Result;
     errors?: GraphQLFormattedError[] | undefined;
-}>);
+}>)>;

package/build/graphql.js

@@ -1,6 +1,6 @@
 import { createRESTModule } from '@wix/sdk-runtime/rest-modules';
 import { FetchErrorResponse } from './fetch-error.js';
-export const graphql = createRESTModule((restModuleOpts) => {
+export const graphql = createRESTModule(((restModuleOpts) => {
     // eslint-disable-next-line @typescript-eslint/no-shadow
     return async function graphql(query, variables, opts = {
         apiVersion: 'alpha',
@@ -18,4 +18,4 @@ export const graphql = createRESTModule((restModuleOpts) => {
         const { data, errors } = await res.json();
         return { data: data ?? {}, errors };
     };
-});
+}));

package/cjs/build/auth/AppStrategy.d.ts

@@ -12,7 +12,23 @@ export type AppStrategy = AuthenticationStrategy<undefined> & {
         accessToken: string;
         refreshToken: string;
     }>;
+    /**
+     * Return a new instance of the AppStrategy which uses an elevated access token
+     */
     elevated(): Promise<AppStrategy>;
+    /**
+     * Returns infromation about the active token
+     */
+    getTokenInfo(): Promise<{
+        active: boolean;
+        subjectType: 'APP' | 'USER' | 'MEMBER' | 'VISITOR' | 'UNKNOWN';
+        subjectId: string;
+        exp: number;
+        iat: number;
+        clientId?: string;
+        siteId: string;
+        instanceId?: string;
+    }>;
 };
 /**
  * Creates an authentication strategy for Wix Apps OAuth installation process.
@@ -22,6 +38,7 @@ export type AppStrategy = AuthenticationStrategy<undefined> & {
  * @param opts.appSecret The Wix App Secret
  * @param opts.refreshToken An optional refresh token previously retrieved from Wix OAuth API
  * @param opts.instanceId An optional instance ID of the Wix App instance the client is making requests on behalf of
+ * @param opts.accessToken An optional access token previously retrieved from a client Wix Extension
  * @param opts.publicKey An optional public key for validating webhook requests (supports both PEM and base64 encoded keys)
  * @returns An authentication strategy that can be used with WixClient
  * @example

package/cjs/build/auth/AppStrategy.js

@@ -33,6 +33,7 @@ const helpers_js_1 = require("../helpers.js");
  * @param opts.appSecret The Wix App Secret
  * @param opts.refreshToken An optional refresh token previously retrieved from Wix OAuth API
  * @param opts.instanceId An optional instance ID of the Wix App instance the client is making requests on behalf of
+ * @param opts.accessToken An optional access token previously retrieved from a client Wix Extension
  * @param opts.publicKey An optional public key for validating webhook requests (supports both PEM and base64 encoded keys)
  * @returns An authentication strategy that can be used with WixClient
  * @example
@@ -117,10 +118,10 @@ function AppStrategy(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 AppStrategy');
-            }
             if ('refreshToken' in opts || refreshToken) {
+                if (!opts.appSecret) {
+                    throw new Error('App secret is required for retrieveing app-level access tokens. Make sure to pass it to the AppStrategy');
+                }
                 const tokensRes = await fetch('https://www.wixapis.com/oauth/access', {
                     method: 'POST',
                     headers: {
@@ -145,6 +146,9 @@ function AppStrategy(opts) {
                 };
             }
             else if ('instanceId' in opts) {
+                if (!opts.appSecret) {
+                    throw new Error('App secret is required for retrieveing app-level access tokens. Make sure to pass it to the AppStrategy');
+                }
                 const tokensRes = await fetch('https://www.wixapis.com/oauth2/token', {
                     method: 'POST',
                     headers: {
@@ -180,20 +184,8 @@ function AppStrategy(opts) {
         },
         async elevated() {
             if ('accessToken' in opts && opts.accessToken) {
-                const tokenInfoRes = await fetch('https://www.wixapis.com/oauth2/token-info', {
-                    method: 'POST',
-                    headers: {
-                        'Content-Type': 'application/json',
-                    },
-                    body: JSON.stringify({
-                        token: opts.accessToken,
-                    }),
-                });
-                if (tokenInfoRes.status !== 200) {
-                    throw new Error(`Failed to get token info. Unexpected status code from Wix OAuth API: ${tokenInfoRes.status}`);
-                }
-                const tokenInfo = await tokenInfoRes.json();
-                if (tokenInfo.app_id !== opts.appId) {
+                const tokenInfo = await getTokenInfo(opts.accessToken);
+                if (tokenInfo.clientId !== opts.appId) {
                     throw new Error(`Invalid access token. The token is not issued for the app with ID "${opts.appId}"`);
                 }
                 if (!tokenInfo.instanceId) {
@@ -229,6 +221,28 @@ function AppStrategy(opts) {
                 valid: true,
             };
         },
+        async getTokenInfo() {
+            const tokenToCheck = refreshToken ?? ('accessToken' in opts ? opts.accessToken : undefined);
+            if (!tokenToCheck) {
+                throw new Error('Missing token to get info for. Either pass the token as an argument or provide it when initializing the AppStrategy');
+            }
+            return getTokenInfo(tokenToCheck);
+        },
     };
 }
 exports.AppStrategy = AppStrategy;
+async function getTokenInfo(token) {
+    const tokenInfoRes = await fetch('https://www.wixapis.com/oauth2/token-info', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({
+            token,
+        }),
+    });
+    if (tokenInfoRes.status !== 200) {
+        throw new Error(`Failed to get token info. Unexpected status code from Wix OAuth API: ${tokenInfoRes.status}`);
+    }
+    return (await tokenInfoRes.json());
+}

package/cjs/build/graphql.d.ts

@@ -1,4 +1,5 @@
 import { DocumentNode, GraphQLFormattedError } from 'graphql';
+import { RESTFunctionDescriptor } from '@wix/sdk-types';
 export type TypedQueryInput<Result = {
     [key: string]: any;
 }, Variables = {
@@ -15,14 +16,14 @@ export type TypedQueryInput<Result = {
      */
     __ensureTypesOfVariablesAndResultMatching?: (variables: Variables) => Result;
 };
-export declare const graphql: ((query: string | String | DocumentNode | TypedQueryInput<unknown, any>, variables?: any, opts?: {
+export declare const graphql: (<Result, Variables>(query: string | String | DocumentNode | TypedQueryInput<Result, Variables>, variables?: Variables | undefined, opts?: {
     apiVersion: string;
 }) => Promise<{
-    data: unknown;
+    data: Result;
     errors?: GraphQLFormattedError[] | undefined;
-}>) & ((restModuleOpts: import("@wix/sdk-types").HttpClient) => (query: string | String | DocumentNode | TypedQueryInput<unknown, any>, variables?: any, opts?: {
+}>) & RESTFunctionDescriptor<(<Result, Variables>(query: string | String | DocumentNode | TypedQueryInput<Result, Variables>, variables?: Variables | undefined, opts?: {
     apiVersion: string;
 }) => Promise<{
-    data: unknown;
+    data: Result;
     errors?: GraphQLFormattedError[] | undefined;
-}>);
+}>)>;

package/cjs/build/graphql.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.graphql = void 0;
 const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
 const fetch_error_js_1 = require("./fetch-error.js");
-exports.graphql = (0, rest_modules_1.createRESTModule)((restModuleOpts) => {
+exports.graphql = (0, rest_modules_1.createRESTModule)(((restModuleOpts) => {
     // eslint-disable-next-line @typescript-eslint/no-shadow
     return async function graphql(query, variables, opts = {
         apiVersion: 'alpha',
@@ -21,4 +21,4 @@ exports.graphql = (0, rest_modules_1.createRESTModule)((restModuleOpts) => {
         const { data, errors } = await res.json();
         return { data: data ?? {}, errors };
     };
-});
+}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/sdk",
-  "version": "1.12.6",
+  "version": "1.12.7",
   "license": "UNLICENSED",
   "author": {
     "name": "Ronny Ringel",
@@ -122,5 +122,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "434acd803ec3fa432e257e25fb88fe03020ccc7a9f729faeebd656b4"
+  "falconPackageHash": "225bbf7de21c21bb40a3f13f6b1b7013827df311a9c450869d201177"
 }