@wix/papyrus 1.0.13 → 1.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/papyrus",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -22,7 +22,7 @@
     "schemas"
   ],
   "dependencies": {
-    "@wix/auto_sdk_papyrus_templates": "1.0.0",
+    "@wix/auto_sdk_papyrus_templates": "1.0.1",
     "@wix/papyrus_documents": "^1.0.0"
   },
   "devDependencies": {
@@ -54,5 +54,5 @@
       "types": "./build/es/schemas.d.mts"
     }
   },
-  "falconPackageHash": "156791a643a0db4629039c8951e04e80544486fb4d1b5bdd09611dcb"
+  "falconPackageHash": "ebc2759f58cd053f3068c41527bd096831923e2c4b3f171db30fd3a0"
 }

package/type-bundles/context.bundle.d.ts

@@ -754,12 +754,19 @@ declare global {
 }
 
 type HTTPMethod = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient, options?: {
+    validateRequestSchema?: boolean;
+}) => T;
 interface HttpClient {
     request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
     fetchWithAuth: typeof fetch;
     wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+    /** Returns the current access token synchronously, if available. */
     getActiveToken?: () => string | undefined;
+    /** Returns auth headers (may trigger token refresh). Prefer this over getActiveToken when making authenticated requests. */
+    getAuthHeaders?: () => Promise<{
+        headers: Record<string, string>;
+    }>;
 }
 type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
 type HttpResponse<T = any> = {

package/type-bundles/index.bundle.d.ts

@@ -956,12 +956,12 @@ type Host<Environment = unknown> = {
     } | undefined;
 };
 
-type HTTPMethod$1 = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-type RESTFunctionDescriptor$1<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient$1, options?: {
+type HTTPMethod = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient, options?: {
     validateRequestSchema?: boolean;
 }) => T;
-interface HttpClient$1 {
-    request<TResponse, TData = any>(req: RequestOptionsFactory$1<TResponse, TData>): Promise<HttpResponse$1<TResponse>>;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
     fetchWithAuth: typeof fetch;
     wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
     /** Returns the current access token synchronously, if available. */
@@ -971,47 +971,47 @@ interface HttpClient$1 {
         headers: Record<string, string>;
     }>;
 }
-type RequestOptionsFactory$1<TResponse = any, TData = any> = (context: any) => RequestOptions$1<TResponse, TData>;
-type HttpResponse$1<T = any> = {
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
     data: T;
     status: number;
     statusText: string;
     headers: any;
     request?: any;
 };
-type ResponseTransformer$1$1 = (data: any) => any;
-type RequestOptions$1<_TResponse = any, Data = any> = {
-    method: HTTPMethod$1;
+type ResponseTransformer$1 = (data: any) => any;
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: HTTPMethod;
     url: string;
     data?: Data;
     params?: URLSearchParams;
-    fallback?: RequestOptions$1<any, any>[];
+    fallback?: RequestOptions<any, any>[];
     /**
      * The array option is for interoperability, defacto only the first function is used
      * if an array is provided
      */
-    transformResponse?: ResponseTransformer$1$1 | ResponseTransformer$1$1[];
-} & APIMetadata$1;
-type APIMetadata$1 = {
+    transformResponse?: ResponseTransformer$1 | ResponseTransformer$1[];
+} & APIMetadata;
+type APIMetadata = {
     methodFqn?: string;
     entityFqdn?: string;
     packageName?: string;
-    migrationOptions?: MigrationOptions$1;
+    migrationOptions?: MigrationOptions;
 };
-type MigrationOptions$1 = {
+type MigrationOptions = {
     optInTransformResponse?: boolean;
 };
-type BuildRESTFunction$1<T extends RESTFunctionDescriptor$1> = T extends RESTFunctionDescriptor$1<infer U> ? U : never;
-type EventDefinition$1<Payload = unknown, Type extends string = string> = {
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
     __type: 'event-definition';
     type: Type;
     isDomainEvent?: boolean;
     transformations?: (envelope: unknown) => Payload;
     __payload: Payload;
 };
-declare function EventDefinition$1<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$1<Payload, Type>;
-type EventHandler$1<T extends EventDefinition$1> = (payload: T['__payload']) => void | Promise<void>;
-type BuildEventDefinition$1<T extends EventDefinition$1<any, string>> = (handler: EventHandler$1<T>) => void;
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
 
 type ServicePluginMethodInput = {
     request: any;
@@ -1067,7 +1067,7 @@ type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends
  * can either be a REST module or a host module.
  * This type is recursive, so it can describe nested modules.
  */
-type Descriptors = RESTFunctionDescriptor$1 | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition$1<any> | ServicePluginDefinition<any> | {
+type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
     [key: string]: Descriptors | PublicMetadata | any;
 };
 /**
@@ -1080,7 +1080,7 @@ type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, De
     done: T;
     recurse: T extends {
         __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
-    } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor$1 ? BuildRESTFunction$1<T> : T extends EventDefinition$1<any> ? BuildEventDefinition$1<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
+    } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? 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,
@@ -1101,12 +1101,24 @@ declare global {
     }
 }
 /**
- * A type used to create concerete types from SDK descriptors in
- * case a contextual client is available.
+ * Creates concrete types from SDK descriptors when a contextual client is
+ * available.
+ *
+ * For a REST descriptor the built (bound) API is intersected with the original
+ * descriptor, matching what `contextualizeRESTModuleV2` returns at runtime — a
+ * value callable as the bound API and still usable as a descriptor. Keeping the
+ * descriptor half lets contextual modules be passed to descriptor-constrained
+ * helpers such as `elevate` from `@wix/sdk/context` (FEDINF-14092).
+ *
+ * The `& T` is scoped to REST descriptors — the only shape codegen wraps in
+ * `MaybeContext` — so `BuildDescriptors` (used by `createClient().use`) is left
+ * unchanged and stays bound-only. The fix lives here rather than in `elevate`,
+ * which is kept strict on purpose (see #941) so it still rejects bound-only
+ * functions that are unsafe through `createRESTModule`.
  */
 type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
     host: Host;
-} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
+} ? T extends RESTFunctionDescriptor ? BuildDescriptors<T, globalThis.ContextualClient['host']> & T : BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
 declare global {
     /**
      * A global interface to set the exposure toggle for the SDK.
@@ -1205,6 +1217,14 @@ declare const SORT_CAPABILITIES: {
     readonly ASC: "ASC";
     readonly DESC: "DESC";
 };
+/**
+ * Origin point for geo-distance sorting on a GEO field.
+ * Results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
+ */
+type SortingOrigin = {
+    latitude?: number | null;
+    longitude?: number | null;
+};
 /**
  * Helper type to get the fields from a WQL group
  * @template WQLGroup The WQL group type
@@ -1222,6 +1242,7 @@ type Sorting$2<Spec extends WQLSpec> = Spec['wql'] extends {
     fieldName?: string;
     order?: SortOrder$2;
     selectItemsBy?: Record<string, any>[] | null;
+    origin?: SortingOrigin | null;
 } : {
     [WQLGroupIndex in keyof Spec['wql']]: Spec['wql'][WQLGroupIndex] extends {
         fields: readonly string[];
@@ -1230,18 +1251,22 @@ type Sorting$2<Spec extends WQLSpec> = Spec['wql'] extends {
         fieldName: WQLFields<Spec['wql'][WQLGroupIndex]>;
         order: typeof SORT_DIRECTIONS.ASC;
         selectItemsBy?: Record<string, any>[] | null;
+        origin?: SortingOrigin | null;
     } : GroupSortCapability extends typeof SORT_DIRECTIONS.DESC ? {
         fieldName: WQLFields<Spec['wql'][WQLGroupIndex]>;
         order: typeof SORT_DIRECTIONS.DESC;
         selectItemsBy?: Record<string, any>[] | null;
+        origin?: SortingOrigin | null;
     } : GroupSortCapability extends typeof SORT_CAPABILITIES.BOTH ? {
         fieldName: WQLFields<Spec['wql'][WQLGroupIndex]>;
         order: SortOrder$2;
         selectItemsBy?: Record<string, any>[] | null;
+        origin?: SortingOrigin | null;
     } : GroupSortCapability extends typeof SORT_CAPABILITIES.NONE ? {
         fieldName?: never;
         order?: never;
         selectItemsBy?: Record<string, any>[] | null;
+        origin?: SortingOrigin | null;
     } : never : never;
 }[keyof Spec['wql']];
 
@@ -2334,7 +2359,7 @@ interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
     /** If present, indicates the action that triggered the event. */
     originatedFrom?: string | null;
     /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
      * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
      */
     entityEventSequence?: string | null;
@@ -2511,7 +2536,7 @@ interface EventMetadata$1 extends BaseEventMetadata$1 {
     /** If present, indicates the action that triggered the event. */
     originatedFrom?: string | null;
     /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
      * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
      */
     entityEventSequence?: string | null;
@@ -2653,7 +2678,7 @@ interface ResolveTemplateSettingsOptions {
     templateId?: string | null;
 }
 
-declare function upsertTemplateSettings$1(httpClient: HttpClient$1): UpsertTemplateSettingsSignature;
+declare function upsertTemplateSettings$1(httpClient: HttpClient): UpsertTemplateSettingsSignature;
 interface UpsertTemplateSettingsSignature {
     /**
      * Upsert Template Settings.
@@ -2662,7 +2687,7 @@ interface UpsertTemplateSettingsSignature {
         __applicationErrorsType?: UpsertTemplateSettingsApplicationErrors;
     }>;
 }
-declare function resolveTemplateSettings$1(httpClient: HttpClient$1): ResolveTemplateSettingsSignature;
+declare function resolveTemplateSettings$1(httpClient: HttpClient): ResolveTemplateSettingsSignature;
 interface ResolveTemplateSettingsSignature {
     /**
      * Resolve Template Settings. Returns default Template Settings if it does not exist.
@@ -2671,20 +2696,20 @@ interface ResolveTemplateSettingsSignature {
         __applicationErrorsType?: ResolveTemplateSettingsApplicationErrors;
     }>;
 }
-declare const onTemplateSettingsCreated$1: EventDefinition$1<TemplateSettingsCreatedEnvelope, "wix.papyrus.v1.template_settings_created">;
-declare const onTemplateSettingsUpdated$1: EventDefinition$1<TemplateSettingsUpdatedEnvelope, "wix.papyrus.v1.template_settings_updated">;
+declare const onTemplateSettingsCreated$1: EventDefinition<TemplateSettingsCreatedEnvelope, "wix.papyrus.v1.template_settings_created">;
+declare const onTemplateSettingsUpdated$1: EventDefinition<TemplateSettingsUpdatedEnvelope, "wix.papyrus.v1.template_settings_updated">;
 
-declare function customQueryTemplateSettings(httpClient: HttpClient$1): {
+declare function customQueryTemplateSettings(httpClient: HttpClient): {
     (): SettingsQueryBuilder;
     (query: TemplateSettingsQuery): ReturnType<typeof typedQueryTemplateSettings>;
 };
-declare const upsertTemplateSettings: MaybeContext<BuildRESTFunction$1<typeof upsertTemplateSettings$1> & typeof upsertTemplateSettings$1>;
-declare const resolveTemplateSettings: MaybeContext<BuildRESTFunction$1<typeof resolveTemplateSettings$1> & typeof resolveTemplateSettings$1>;
-declare const queryTemplateSettings: MaybeContext<BuildRESTFunction$1<typeof customQueryTemplateSettings> & typeof customQueryTemplateSettings>;
+declare const upsertTemplateSettings: MaybeContext<BuildRESTFunction<typeof upsertTemplateSettings$1> & typeof upsertTemplateSettings$1>;
+declare const resolveTemplateSettings: MaybeContext<BuildRESTFunction<typeof resolveTemplateSettings$1> & typeof resolveTemplateSettings$1>;
+declare const queryTemplateSettings: MaybeContext<BuildRESTFunction<typeof customQueryTemplateSettings> & typeof customQueryTemplateSettings>;
 /** */
-declare const onTemplateSettingsCreated: BuildEventDefinition$1<typeof onTemplateSettingsCreated$1> & typeof onTemplateSettingsCreated$1;
+declare const onTemplateSettingsCreated: BuildEventDefinition<typeof onTemplateSettingsCreated$1> & typeof onTemplateSettingsCreated$1;
 /** */
-declare const onTemplateSettingsUpdated: BuildEventDefinition$1<typeof onTemplateSettingsUpdated$1> & typeof onTemplateSettingsUpdated$1;
+declare const onTemplateSettingsUpdated: BuildEventDefinition<typeof onTemplateSettingsUpdated$1> & typeof onTemplateSettingsUpdated$1;
 
 type index_d$1_AccountInfo = AccountInfo;
 type index_d$1_AccountInfoMetadata = AccountInfoMetadata;
@@ -3499,90 +3524,6 @@ interface GetDownloadUrlOptions extends GetDownloadUrlRequestDocumentOneOf {
     urlExpirationInSeconds?: number | null;
 }
 
-type HTTPMethod = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-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> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type ResponseTransformer$1 = (data: any) => any;
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: HTTPMethod;
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-    fallback?: RequestOptions<any, any>[];
-    /**
-     * The array option is for interoperability, defacto only the first function is used
-     * if an array is provided
-     */
-    transformResponse?: ResponseTransformer$1 | ResponseTransformer$1[];
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-    migrationOptions?: MigrationOptions;
-};
-type MigrationOptions = {
-    optInTransformResponse?: boolean;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-type EventDefinition<Payload = unknown, Type extends string = string> = {
-    __type: 'event-definition';
-    type: Type;
-    isDomainEvent?: boolean;
-    transformations?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
-type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
-type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
-
-declare global {
-    interface ContextualClient {
-    }
-}
-declare global {
-    /**
-     * A global interface to set the exposure toggle for the SDK.
-     * @example
-     * ```ts
-     * declare global {
-     *  interface SDKExposureToggle {
-     *    alpha: true;
-     *  }
-     * }
-     */
-    interface SDKExposureToggle {
-    }
-}
-
-declare global {
-    /**
-     * A global interface to set the type mode for the SDK.
-     * @example
-     * ```ts
-     * declare global {
-     *  interface SDKTypeMode {
-     *    strict: true;
-     *  }
-     * }
-     */
-    interface SDKTypeMode {
-    }
-}
-
 declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
 declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;

package/type-bundles/meta.bundle.d.ts

@@ -1512,7 +1512,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
     /** If present, indicates the action that triggered the event. */
     originatedFrom?: string | null;
     /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
      * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
      */
     entityEventSequence?: string | null;