@wix/sdk-types 1.17.4 → 1.17.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  import { MonitoringClient } from '@wix/monitoring-types';
2
2
  import { PlatformShowError } from '@wix/error-handler-types/v2';
3
3
  export { ErrorCodesMap, ErrorHandlerPublicAPI as ErrorHandler, ResolvedError, ShowErrorMapFunction, ShowErrorProps, StatusCodeMap } from '@wix/error-handler-types/v2';
4
- import { ConditionalExcept, EmptyObject, Simplify, Paths, SetRequiredDeep, JsonObject } from 'type-fest';
4
+ import { ConditionalExcept, EmptyObject, Simplify, Paths, SetNonNullableDeep, SetRequiredDeep, JsonObject } from 'type-fest';
5
5
  export { ErrorHandlerInternalAPI as WixClientErrorHandler } from '@wix/error-handler-types';
6
6
 
7
7
  type HostModule<T, H extends Host> = {
@@ -73,7 +73,12 @@ interface HttpClient {
73
73
  request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
74
74
  fetchWithAuth: typeof fetch;
75
75
  wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
76
+ /** Returns the current access token synchronously, if available. */
76
77
  getActiveToken?: () => string | undefined;
78
+ /** Returns auth headers (may trigger token refresh). Prefer this over getActiveToken when making authenticated requests. */
79
+ getAuthHeaders?: () => Promise<{
80
+ headers: Record<string, string>;
81
+ }>;
77
82
  }
78
83
  type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
79
84
  type HttpResponse<T = any> = {
@@ -341,7 +346,7 @@ type NonNullablePaths<T, K extends Paths<T, {
341
346
  maxRecursionDepth: MaxDepth;
342
347
  }>, MaxDepth extends number = 11> = globalThis.SDKTypeMode extends {
343
348
  strict: true;
344
- } ? SetRequiredDeep<T, K> : T;
349
+ } ? SetNonNullableDeep<SetRequiredDeep<T, K>, K & Paths<SetRequiredDeep<T, K>>> : T;
345
350
 
346
351
  /**
347
352
  * Constant used to indicate all applicable operators for a field type
package/build/index.d.mts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { MonitoringClient } from '@wix/monitoring-types';
2
2
  import { PlatformShowError } from '@wix/error-handler-types/v2';
3
3
  export { ErrorCodesMap, ErrorHandlerPublicAPI as ErrorHandler, ResolvedError, ShowErrorMapFunction, ShowErrorProps, StatusCodeMap } from '@wix/error-handler-types/v2';
4
- import { ConditionalExcept, EmptyObject, Simplify, Paths, SetRequiredDeep, JsonObject } from 'type-fest';
4
+ import { ConditionalExcept, EmptyObject, Simplify, Paths, SetNonNullableDeep, SetRequiredDeep, JsonObject } from 'type-fest';
5
5
  export { ErrorHandlerInternalAPI as WixClientErrorHandler } from '@wix/error-handler-types';
6
6
 
7
7
  type HostModule<T, H extends Host> = {
@@ -73,7 +73,12 @@ interface HttpClient {
73
73
  request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
74
74
  fetchWithAuth: typeof fetch;
75
75
  wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
76
+ /** Returns the current access token synchronously, if available. */
76
77
  getActiveToken?: () => string | undefined;
78
+ /** Returns auth headers (may trigger token refresh). Prefer this over getActiveToken when making authenticated requests. */
79
+ getAuthHeaders?: () => Promise<{
80
+ headers: Record<string, string>;
81
+ }>;
77
82
  }
78
83
  type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
79
84
  type HttpResponse<T = any> = {
@@ -341,7 +346,7 @@ type NonNullablePaths<T, K extends Paths<T, {
341
346
  maxRecursionDepth: MaxDepth;
342
347
  }>, MaxDepth extends number = 11> = globalThis.SDKTypeMode extends {
343
348
  strict: true;
344
- } ? SetRequiredDeep<T, K> : T;
349
+ } ? SetNonNullableDeep<SetRequiredDeep<T, K>, K & Paths<SetRequiredDeep<T, K>>> : T;
345
350
 
346
351
  /**
347
352
  * Constant used to indicate all applicable operators for a field type
package/build/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { MonitoringClient } from '@wix/monitoring-types';
2
2
  import { PlatformShowError } from '@wix/error-handler-types/v2';
3
3
  export { ErrorCodesMap, ErrorHandlerPublicAPI as ErrorHandler, ResolvedError, ShowErrorMapFunction, ShowErrorProps, StatusCodeMap } from '@wix/error-handler-types/v2';
4
- import { ConditionalExcept, EmptyObject, Simplify, Paths, SetRequiredDeep, JsonObject } from 'type-fest';
4
+ import { ConditionalExcept, EmptyObject, Simplify, Paths, SetNonNullableDeep, SetRequiredDeep, JsonObject } from 'type-fest';
5
5
  export { ErrorHandlerInternalAPI as WixClientErrorHandler } from '@wix/error-handler-types';
6
6
 
7
7
  type HostModule<T, H extends Host> = {
@@ -73,7 +73,12 @@ interface HttpClient {
73
73
  request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
74
74
  fetchWithAuth: typeof fetch;
75
75
  wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
76
+ /** Returns the current access token synchronously, if available. */
76
77
  getActiveToken?: () => string | undefined;
78
+ /** Returns auth headers (may trigger token refresh). Prefer this over getActiveToken when making authenticated requests. */
79
+ getAuthHeaders?: () => Promise<{
80
+ headers: Record<string, string>;
81
+ }>;
77
82
  }
78
83
  type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
79
84
  type HttpResponse<T = any> = {
@@ -341,7 +346,7 @@ type NonNullablePaths<T, K extends Paths<T, {
341
346
  maxRecursionDepth: MaxDepth;
342
347
  }>, MaxDepth extends number = 11> = globalThis.SDKTypeMode extends {
343
348
  strict: true;
344
- } ? SetRequiredDeep<T, K> : T;
349
+ } ? SetNonNullableDeep<SetRequiredDeep<T, K>, K & Paths<SetRequiredDeep<T, K>>> : T;
345
350
 
346
351
  /**
347
352
  * Constant used to indicate all applicable operators for a field type
@@ -1,7 +1,7 @@
1
1
  import { MonitoringClient } from '@wix/monitoring-types';
2
2
  import { ErrorHandlerAPI, PlatformShowError } from '@wix/error-handler-types/v2';
3
3
  export { ErrorCodesMap, ErrorHandlerPublicAPI as ErrorHandler, ResolvedError, ShowErrorMapFunction, ShowErrorProps, StatusCodeMap } from '@wix/error-handler-types/v2';
4
- import { ConditionalExcept, EmptyObject, Simplify, Paths, SetRequiredDeep, JsonObject } from 'type-fest';
4
+ import { ConditionalExcept, EmptyObject, Simplify, Paths, SetNonNullableDeep, SetRequiredDeep, JsonObject } from 'type-fest';
5
5
  export { ErrorHandlerInternalAPI as WixClientErrorHandler } from '@wix/error-handler-types';
6
6
 
7
7
  interface BiLogger {
@@ -131,7 +131,12 @@ interface HttpClient {
131
131
  request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
132
132
  fetchWithAuth: typeof fetch;
133
133
  wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
134
+ /** Returns the current access token synchronously, if available. */
134
135
  getActiveToken?: () => string | undefined;
136
+ /** Returns auth headers (may trigger token refresh). Prefer this over getActiveToken when making authenticated requests. */
137
+ getAuthHeaders?: () => Promise<{
138
+ headers: Record<string, string>;
139
+ }>;
135
140
  }
136
141
  type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
137
142
  type HttpResponse<T = any> = {
@@ -399,7 +404,7 @@ type NonNullablePaths<T, K extends Paths<T, {
399
404
  maxRecursionDepth: MaxDepth;
400
405
  }>, MaxDepth extends number = 11> = globalThis.SDKTypeMode extends {
401
406
  strict: true;
402
- } ? SetRequiredDeep<T, K> : T;
407
+ } ? SetNonNullableDeep<SetRequiredDeep<T, K>, K & Paths<SetRequiredDeep<T, K>>> : T;
403
408
 
404
409
  /**
405
410
  * Constant used to indicate all applicable operators for a field type
@@ -1,7 +1,7 @@
1
1
  import { MonitoringClient } from '@wix/monitoring-types';
2
2
  import { ErrorHandlerAPI, PlatformShowError } from '@wix/error-handler-types/v2';
3
3
  export { ErrorCodesMap, ErrorHandlerPublicAPI as ErrorHandler, ResolvedError, ShowErrorMapFunction, ShowErrorProps, StatusCodeMap } from '@wix/error-handler-types/v2';
4
- import { ConditionalExcept, EmptyObject, Simplify, Paths, SetRequiredDeep, JsonObject } from 'type-fest';
4
+ import { ConditionalExcept, EmptyObject, Simplify, Paths, SetNonNullableDeep, SetRequiredDeep, JsonObject } from 'type-fest';
5
5
  export { ErrorHandlerInternalAPI as WixClientErrorHandler } from '@wix/error-handler-types';
6
6
 
7
7
  interface BiLogger {
@@ -131,7 +131,12 @@ interface HttpClient {
131
131
  request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
132
132
  fetchWithAuth: typeof fetch;
133
133
  wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
134
+ /** Returns the current access token synchronously, if available. */
134
135
  getActiveToken?: () => string | undefined;
136
+ /** Returns auth headers (may trigger token refresh). Prefer this over getActiveToken when making authenticated requests. */
137
+ getAuthHeaders?: () => Promise<{
138
+ headers: Record<string, string>;
139
+ }>;
135
140
  }
136
141
  type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
137
142
  type HttpResponse<T = any> = {
@@ -399,7 +404,7 @@ type NonNullablePaths<T, K extends Paths<T, {
399
404
  maxRecursionDepth: MaxDepth;
400
405
  }>, MaxDepth extends number = 11> = globalThis.SDKTypeMode extends {
401
406
  strict: true;
402
- } ? SetRequiredDeep<T, K> : T;
407
+ } ? SetNonNullableDeep<SetRequiredDeep<T, K>, K & Paths<SetRequiredDeep<T, K>>> : T;
403
408
 
404
409
  /**
405
410
  * Constant used to indicate all applicable operators for a field type
@@ -1,7 +1,7 @@
1
1
  import { MonitoringClient } from '@wix/monitoring-types';
2
2
  import { ErrorHandlerAPI, PlatformShowError } from '@wix/error-handler-types/v2';
3
3
  export { ErrorCodesMap, ErrorHandlerPublicAPI as ErrorHandler, ResolvedError, ShowErrorMapFunction, ShowErrorProps, StatusCodeMap } from '@wix/error-handler-types/v2';
4
- import { ConditionalExcept, EmptyObject, Simplify, Paths, SetRequiredDeep, JsonObject } from 'type-fest';
4
+ import { ConditionalExcept, EmptyObject, Simplify, Paths, SetNonNullableDeep, SetRequiredDeep, JsonObject } from 'type-fest';
5
5
  export { ErrorHandlerInternalAPI as WixClientErrorHandler } from '@wix/error-handler-types';
6
6
 
7
7
  interface BiLogger {
@@ -131,7 +131,12 @@ interface HttpClient {
131
131
  request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
132
132
  fetchWithAuth: typeof fetch;
133
133
  wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
134
+ /** Returns the current access token synchronously, if available. */
134
135
  getActiveToken?: () => string | undefined;
136
+ /** Returns auth headers (may trigger token refresh). Prefer this over getActiveToken when making authenticated requests. */
137
+ getAuthHeaders?: () => Promise<{
138
+ headers: Record<string, string>;
139
+ }>;
135
140
  }
136
141
  type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
137
142
  type HttpResponse<T = any> = {
@@ -399,7 +404,7 @@ type NonNullablePaths<T, K extends Paths<T, {
399
404
  maxRecursionDepth: MaxDepth;
400
405
  }>, MaxDepth extends number = 11> = globalThis.SDKTypeMode extends {
401
406
  strict: true;
402
- } ? SetRequiredDeep<T, K> : T;
407
+ } ? SetNonNullableDeep<SetRequiredDeep<T, K>, K & Paths<SetRequiredDeep<T, K>>> : T;
403
408
 
404
409
  /**
405
410
  * Constant used to indicate all applicable operators for a field type
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/sdk-types",
3
- "version": "1.17.4",
3
+ "version": "1.17.6",
4
4
  "author": {
5
5
  "name": "Ronny Ringel",
6
6
  "email": "ronnyr@wix.com"
@@ -62,5 +62,5 @@
62
62
  ]
63
63
  }
64
64
  },
65
- "falconPackageHash": "1d9bf5bab7590b3128ea9479165bc5243e09e387acd60b54b5fa1863"
65
+ "falconPackageHash": "5576669101b6b4d52fa492f1299f63fc7c65b45dd1fda16b68fe1ebf"
66
66
  }