@wix/sdk-types 1.11.0 → 1.12.1

package/build/index.d.mts

@@ -21,8 +21,18 @@ type Host<Environment = unknown> = {
      * like internationalization, billing, etc.
      */
     essentials?: {
+        /**
+         * The language of the currently viewed session
+         */
         language?: string;
+        /**
+         * The locale of the currently viewed session
+         */
         locale?: string;
+        /**
+         * Any headers that should be passed through to the API requests
+         */
+        passThroughHeaders?: Record<string, string>;
     };
 };
 
@@ -31,6 +41,7 @@ interface HttpClient {
     request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
     fetchWithAuth: typeof fetch;
     wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+    getActiveToken?: () => string | undefined;
 }
 type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
 type HttpResponse<T = any> = {
@@ -65,6 +76,13 @@ type AuthenticationStrategy<Host = unknown> = {
         };
         valid: boolean;
     }>;
+    /**
+     * This function is used to get the token that is currently active in the context of the strategy.
+     * This is useful when direct access to the access token is needed
+     * (such as getTokenInfo that requires the token in the body of the request).
+     * @returns the token that is currently active in the context of the strategy
+     */
+    getActiveToken?: () => string | undefined;
 };
 type BoundAuthenticationStrategy = {
     getAuthHeaders: () => Promise<{

package/build/index.d.ts

@@ -21,8 +21,18 @@ type Host<Environment = unknown> = {
      * like internationalization, billing, etc.
      */
     essentials?: {
+        /**
+         * The language of the currently viewed session
+         */
         language?: string;
+        /**
+         * The locale of the currently viewed session
+         */
         locale?: string;
+        /**
+         * Any headers that should be passed through to the API requests
+         */
+        passThroughHeaders?: Record<string, string>;
     };
 };
 
@@ -31,6 +41,7 @@ interface HttpClient {
     request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
     fetchWithAuth: typeof fetch;
     wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+    getActiveToken?: () => string | undefined;
 }
 type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
 type HttpResponse<T = any> = {
@@ -65,6 +76,13 @@ type AuthenticationStrategy<Host = unknown> = {
         };
         valid: boolean;
     }>;
+    /**
+     * This function is used to get the token that is currently active in the context of the strategy.
+     * This is useful when direct access to the access token is needed
+     * (such as getTokenInfo that requires the token in the body of the request).
+     * @returns the token that is currently active in the context of the strategy
+     */
+    getActiveToken?: () => string | undefined;
 };
 type BoundAuthenticationStrategy = {
     getAuthHeaders: () => Promise<{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/sdk-types",
-  "version": "1.11.0",
+  "version": "1.12.1",
   "license": "UNLICENSED",
   "author": {
     "name": "Ronny Ringel",
@@ -58,5 +58,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "c854d83417d78c1ce56a466e2240fc2d9ea167e2a4541b4b79e57173"
+  "falconPackageHash": "3ade7900865a4781de88ae3fd23b77db1eff4d458880ae16e81a6b4e"
 }