@wix/sdk-types 1.17.1 → 1.17.3

package/internal/build/browser/index.d.mts

@@ -213,9 +213,15 @@ type EventIdentity = {
     wixUserId: string;
     appId: string;
 };
+type AccountInfo = {
+    accountId: string;
+    parentAccountId?: string;
+    siteId?: string;
+};
 type BaseEventMetadata = {
     instanceId: string;
     identity?: EventIdentity;
+    accountInfo?: AccountInfo;
 };
 type EventDefinition<Payload = unknown, Type extends string = string> = {
     __type: 'event-definition';
@@ -614,7 +620,7 @@ type Filter<Entity, Spec extends WQLSpec> = Simplify<{
 /**
  * Cursor-based paging configuration
  */
-interface CursorPaging {
+interface CursorPaging$1 {
     /** Maximum number of items to return in the results. */
     limit?: number | null;
     /**
@@ -628,7 +634,7 @@ interface CursorPaging {
 /**
  * Offset-based paging configuration
  */
-interface OffsetPaging {
+interface OffsetPaging$1 {
     /** Number of items to load */
     limit?: number | null;
     /** Number of items to skip in the current sort order */
@@ -644,9 +650,9 @@ type PagingType = 'cursor' | 'offset';
 type Paging<Spec extends {
     paging?: PagingType;
 }> = Spec['paging'] extends 'cursor' ? {
-    cursorPaging: CursorPaging;
+    cursorPaging: CursorPaging$1;
 } : Spec['paging'] extends 'offset' ? {
-    paging: OffsetPaging;
+    paging: OffsetPaging$1;
 } : {};
 
 /**
@@ -946,4 +952,173 @@ type Query<Entity, Spec extends QuerySpec> = {
     sort?: Sorting<Spec>[];
 } & Partial<Paging<Spec>>;
 
-export { type APIMetadata, type AmbassadorFactory, type AmbassadorFunctionDescriptor, type AmbassadorRequestOptions, type AuthenticationStrategy, type BaseEventMetadata, type BoundAuthenticationStrategy, type BuildAmbassadorFunction, type BuildDescriptors, type BuildEventDefinition, type BuildRESTFunction, type BuildServicePluginDefinition, type Descriptors, EventDefinition, type EventHandler, type EventIdentity, type ExposeFieldsBasedOnToggle, type Filter, type FilterableFields, type GetNestedType, type HTTPMethod, type Host, type HostModule, type HostModuleAPI, type HttpClient, type HttpResponse, type MaybeContext, type Method, type MigrationOptions, type NonNullablePaths, type PublicMetadata, type Query, type QuerySpec, type RESTFunctionDescriptor, type RequestContext, type RequestOptions, type RequestOptionsFactory, type RestModuleMeta, SERVICE_PLUGIN_ERROR_TYPE, SORT_CAPABILITIES, SORT_DIRECTIONS, type Search, type SearchSpec, type ServicePluginContract, ServicePluginDefinition, type ServicePluginMethodInput, type ServicePluginMethodMetadata, type SortCapability, type SortOrder, type Sorting, type WQL, type WQLSpec };
+interface CursorPaging {
+    limit: number;
+    cursor?: string;
+}
+interface OffsetPaging {
+    limit: number;
+    offset?: number;
+}
+type PagingFor<S extends QuerySpec> = S['paging'] extends 'cursor' ? CursorPaging : OffsetPaging;
+/**
+ * The output type from QueryBuilder.build()
+ * This is a plain object ready to be sent to an API
+ */
+interface QueryRequest<T, S extends QuerySpec> {
+    filter?: Filter<T, S>;
+    sort?: Sorting<S>[];
+    paging?: PagingFor<S>;
+    /** Field projection - return only specified fields */
+    fields?: string[];
+}
+/**
+ * Represents a filter expression that can be combined with other filters
+ */
+interface FilterExpression<T, S extends QuerySpec> {
+    readonly filter: Filter<T, S>;
+}
+/**
+ * Represents a sort expression
+ */
+interface SortExpression<S extends QuerySpec> {
+    readonly sort: Sorting<S>;
+}
+/**
+ * Extract fields that support a specific operator from the spec
+ */
+type FieldsWithOperator<S extends QuerySpec, Op extends string> = S['wql'][number] extends infer Group ? Group extends WQL ? Group['operators'] extends readonly string[] ? Op extends Group['operators'][number] ? Group['fields'][number] : never : Group['fields'][number] : never : never;
+/**
+ * Check if a specific field supports a specific operator
+ */
+type HasOperator<S extends QuerySpec, Field extends string, Op extends string> = Field extends FieldsWithOperator<S, Op> ? true : false;
+/**
+ * Extract sortable fields from the spec
+ */
+type SortableFields<S extends QuerySpec> = S['wql'][number] extends infer Group ? Group extends {
+    fields: readonly string[];
+    sort: 'ASC' | 'DESC' | 'BOTH';
+} ? Group['fields'][number] : never : never;
+/**
+ * Chainable field filter - extends FilterExpression so it can be used directly,
+ * but also allows chaining multiple operators on the same field.
+ * @example
+ * // Single operator - returns ChainableFieldFilter which is also FilterExpression
+ * Filter('price').gt(50)
+ *
+ * // Chained operators - combines into single field filter
+ * Filter('price').gt(50).lt(100)
+ * // Produces: { price: { $gt: 50, $lt: 100 } }
+ */
+type ChainableFieldFilter<T, S extends QuerySpec, Field extends FilterableFields<S>> = FilterExpression<T, S> & (HasOperator<S, Field & string, '$eq'> extends true ? {
+    eq(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$ne'> extends true ? {
+    ne(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$gt'> extends true ? {
+    gt(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$gte'> extends true ? {
+    gte(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$lt'> extends true ? {
+    lt(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$lte'> extends true ? {
+    lte(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$startsWith'> extends true ? {
+    startsWith(value: string): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$endsWith'> extends true ? {
+    endsWith(value: string): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$contains'> extends true ? {
+    contains(value: string): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$in'> extends true ? {
+    in(values: GetNestedType<T, Field & string>[]): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$nin'> extends true ? {
+    nin(values: GetNestedType<T, Field & string>[]): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$hasSome'> extends true ? {
+    hasSome(values: GetNestedType<T, Field & string>[]): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$hasAll'> extends true ? {
+    hasAll(values: GetNestedType<T, Field & string>[]): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$exists'> extends true ? {
+    exists(value?: boolean): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$isEmpty'> extends true ? {
+    isEmpty(value?: boolean): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$ne'> extends true ? {
+    isNotEmpty(): ChainableFieldFilter<T, S, Field>;
+} : {});
+/**
+ * Filter methods for a specific field (alias for ChainableFieldFilter)
+ * Only shows methods for operators that the field supports
+ */
+type FieldFilter<T, S extends QuerySpec, Field extends FilterableFields<S>> = ChainableFieldFilter<T, S, Field>;
+/**
+ * Sort methods for a specific field
+ */
+interface FieldSort<S extends QuerySpec> {
+    asc(): SortExpression<S>;
+    desc(): SortExpression<S>;
+}
+/**
+ * Filter factory interface - creates filter expressions
+ * @example
+ * Filter('price').gt(50)
+ * Filter.and(Filter('title').eq('Product'), Filter('price').gt(50))
+ */
+interface FilterFactory<T, S extends QuerySpec> {
+    /** Create a field-specific filter */
+    <Field extends FilterableFields<S>>(field: Field): FieldFilter<T, S, Field>;
+    /** Combine filters with AND logic */
+    and(...filters: FilterExpression<T, S>[]): FilterExpression<T, S>;
+    /** Combine filters with OR logic */
+    or(...filters: FilterExpression<T, S>[]): FilterExpression<T, S>;
+    /** Negate a filter */
+    not(filter: FilterExpression<T, S>): FilterExpression<T, S>;
+}
+/**
+ * Sort factory - creates sort expressions
+ * @example
+ * Sort('price').desc()
+ */
+type SortFactory<S extends QuerySpec> = <Field extends SortableFields<S>>(field: Field) => FieldSort<S>;
+/**
+ * Query builder interface
+ * @template T - Entity type
+ * @template S - Query spec defining filterable/sortable fields
+ * @template R - Output type from build() (defaults to QueryRequest<T, S>)
+ * @example
+ * QueryBuilder()
+ *   .withFilter(Filter.and(
+ *     Filter('title').eq('Product'),
+ *     Filter('price').gt(50)
+ *   ))
+ *   .withFields('title', 'price')
+ *   .withSorting(Sort('price').desc())
+ *   .withPaging({ limit: 20, offset: 0 })
+ *   .build()
+ */
+interface QueryBuilder<T, S extends QuerySpec, R = QueryRequest<T, S>> {
+    /** Add a filter to the query */
+    withFilter(filter: FilterExpression<T, S>): QueryBuilder<T, S, R>;
+    /** Add field projection - return only specified fields */
+    withFields(...fields: (keyof T & string)[]): QueryBuilder<T, S, R>;
+    /** Add sorting to the query */
+    withSorting(...sorts: SortExpression<S>[]): QueryBuilder<T, S, R>;
+    /** Add paging to the query */
+    withPaging(paging: PagingFor<S>): QueryBuilder<T, S, R>;
+    /** Build the final query request object */
+    build(): R;
+}
+/**
+ * Complete set of query helpers for an entity
+ * This is what gets spread into module namespaces
+ * @template T - Entity type
+ * @template S - Query spec defining filterable/sortable fields
+ * @template R - Output type from QueryBuilder.build() (defaults to QueryRequest<T, S>)
+ */
+interface QueryHelpers<T, S extends QuerySpec, R = QueryRequest<T, S>> {
+    /** QueryBuilder factory */
+    QueryBuilder: () => QueryBuilder<T, S, R>;
+    /** Filter factory - creates filter expressions */
+    Filter: FilterFactory<T, S>;
+    /** Sort factory - creates sort expressions */
+    Sort: SortFactory<S>;
+}
+
+export { type APIMetadata, type AccountInfo, type AmbassadorFactory, type AmbassadorFunctionDescriptor, type AmbassadorRequestOptions, type AuthenticationStrategy, type BaseEventMetadata, type BoundAuthenticationStrategy, type BuildAmbassadorFunction, type BuildDescriptors, type BuildEventDefinition, type BuildRESTFunction, type BuildServicePluginDefinition, type CursorPaging, type Descriptors, EventDefinition, type EventHandler, type EventIdentity, type ExposeFieldsBasedOnToggle, type FieldFilter, type FieldSort, type Filter, type FilterExpression, type FilterFactory, type FilterableFields, type GetNestedType, type HTTPMethod, type Host, type HostModule, type HostModuleAPI, type HttpClient, type HttpResponse, type MaybeContext, type Method, type MigrationOptions, type NonNullablePaths, type OffsetPaging, type PagingFor, type PublicMetadata, type Query, type QueryBuilder, type QueryHelpers, type QueryRequest, type QuerySpec, type RESTFunctionDescriptor, type RequestContext, type RequestOptions, type RequestOptionsFactory, type RestModuleMeta, SERVICE_PLUGIN_ERROR_TYPE, SORT_CAPABILITIES, SORT_DIRECTIONS, type Search, type SearchSpec, type ServicePluginContract, ServicePluginDefinition, type ServicePluginMethodInput, type ServicePluginMethodMetadata, type SortCapability, type SortExpression, type SortFactory, type SortOrder, type Sorting, type WQL, type WQLSpec };

package/internal/build/index.d.mts

@@ -213,9 +213,15 @@ type EventIdentity = {
     wixUserId: string;
     appId: string;
 };
+type AccountInfo = {
+    accountId: string;
+    parentAccountId?: string;
+    siteId?: string;
+};
 type BaseEventMetadata = {
     instanceId: string;
     identity?: EventIdentity;
+    accountInfo?: AccountInfo;
 };
 type EventDefinition<Payload = unknown, Type extends string = string> = {
     __type: 'event-definition';
@@ -614,7 +620,7 @@ type Filter<Entity, Spec extends WQLSpec> = Simplify<{
 /**
  * Cursor-based paging configuration
  */
-interface CursorPaging {
+interface CursorPaging$1 {
     /** Maximum number of items to return in the results. */
     limit?: number | null;
     /**
@@ -628,7 +634,7 @@ interface CursorPaging {
 /**
  * Offset-based paging configuration
  */
-interface OffsetPaging {
+interface OffsetPaging$1 {
     /** Number of items to load */
     limit?: number | null;
     /** Number of items to skip in the current sort order */
@@ -644,9 +650,9 @@ type PagingType = 'cursor' | 'offset';
 type Paging<Spec extends {
     paging?: PagingType;
 }> = Spec['paging'] extends 'cursor' ? {
-    cursorPaging: CursorPaging;
+    cursorPaging: CursorPaging$1;
 } : Spec['paging'] extends 'offset' ? {
-    paging: OffsetPaging;
+    paging: OffsetPaging$1;
 } : {};
 
 /**
@@ -946,4 +952,173 @@ type Query<Entity, Spec extends QuerySpec> = {
     sort?: Sorting<Spec>[];
 } & Partial<Paging<Spec>>;
 
-export { type APIMetadata, type AmbassadorFactory, type AmbassadorFunctionDescriptor, type AmbassadorRequestOptions, type AuthenticationStrategy, type BaseEventMetadata, type BoundAuthenticationStrategy, type BuildAmbassadorFunction, type BuildDescriptors, type BuildEventDefinition, type BuildRESTFunction, type BuildServicePluginDefinition, type Descriptors, EventDefinition, type EventHandler, type EventIdentity, type ExposeFieldsBasedOnToggle, type Filter, type FilterableFields, type GetNestedType, type HTTPMethod, type Host, type HostModule, type HostModuleAPI, type HttpClient, type HttpResponse, type MaybeContext, type Method, type MigrationOptions, type NonNullablePaths, type PublicMetadata, type Query, type QuerySpec, type RESTFunctionDescriptor, type RequestContext, type RequestOptions, type RequestOptionsFactory, type RestModuleMeta, SERVICE_PLUGIN_ERROR_TYPE, SORT_CAPABILITIES, SORT_DIRECTIONS, type Search, type SearchSpec, type ServicePluginContract, ServicePluginDefinition, type ServicePluginMethodInput, type ServicePluginMethodMetadata, type SortCapability, type SortOrder, type Sorting, type WQL, type WQLSpec };
+interface CursorPaging {
+    limit: number;
+    cursor?: string;
+}
+interface OffsetPaging {
+    limit: number;
+    offset?: number;
+}
+type PagingFor<S extends QuerySpec> = S['paging'] extends 'cursor' ? CursorPaging : OffsetPaging;
+/**
+ * The output type from QueryBuilder.build()
+ * This is a plain object ready to be sent to an API
+ */
+interface QueryRequest<T, S extends QuerySpec> {
+    filter?: Filter<T, S>;
+    sort?: Sorting<S>[];
+    paging?: PagingFor<S>;
+    /** Field projection - return only specified fields */
+    fields?: string[];
+}
+/**
+ * Represents a filter expression that can be combined with other filters
+ */
+interface FilterExpression<T, S extends QuerySpec> {
+    readonly filter: Filter<T, S>;
+}
+/**
+ * Represents a sort expression
+ */
+interface SortExpression<S extends QuerySpec> {
+    readonly sort: Sorting<S>;
+}
+/**
+ * Extract fields that support a specific operator from the spec
+ */
+type FieldsWithOperator<S extends QuerySpec, Op extends string> = S['wql'][number] extends infer Group ? Group extends WQL ? Group['operators'] extends readonly string[] ? Op extends Group['operators'][number] ? Group['fields'][number] : never : Group['fields'][number] : never : never;
+/**
+ * Check if a specific field supports a specific operator
+ */
+type HasOperator<S extends QuerySpec, Field extends string, Op extends string> = Field extends FieldsWithOperator<S, Op> ? true : false;
+/**
+ * Extract sortable fields from the spec
+ */
+type SortableFields<S extends QuerySpec> = S['wql'][number] extends infer Group ? Group extends {
+    fields: readonly string[];
+    sort: 'ASC' | 'DESC' | 'BOTH';
+} ? Group['fields'][number] : never : never;
+/**
+ * Chainable field filter - extends FilterExpression so it can be used directly,
+ * but also allows chaining multiple operators on the same field.
+ * @example
+ * // Single operator - returns ChainableFieldFilter which is also FilterExpression
+ * Filter('price').gt(50)
+ *
+ * // Chained operators - combines into single field filter
+ * Filter('price').gt(50).lt(100)
+ * // Produces: { price: { $gt: 50, $lt: 100 } }
+ */
+type ChainableFieldFilter<T, S extends QuerySpec, Field extends FilterableFields<S>> = FilterExpression<T, S> & (HasOperator<S, Field & string, '$eq'> extends true ? {
+    eq(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$ne'> extends true ? {
+    ne(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$gt'> extends true ? {
+    gt(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$gte'> extends true ? {
+    gte(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$lt'> extends true ? {
+    lt(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$lte'> extends true ? {
+    lte(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$startsWith'> extends true ? {
+    startsWith(value: string): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$endsWith'> extends true ? {
+    endsWith(value: string): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$contains'> extends true ? {
+    contains(value: string): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$in'> extends true ? {
+    in(values: GetNestedType<T, Field & string>[]): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$nin'> extends true ? {
+    nin(values: GetNestedType<T, Field & string>[]): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$hasSome'> extends true ? {
+    hasSome(values: GetNestedType<T, Field & string>[]): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$hasAll'> extends true ? {
+    hasAll(values: GetNestedType<T, Field & string>[]): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$exists'> extends true ? {
+    exists(value?: boolean): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$isEmpty'> extends true ? {
+    isEmpty(value?: boolean): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$ne'> extends true ? {
+    isNotEmpty(): ChainableFieldFilter<T, S, Field>;
+} : {});
+/**
+ * Filter methods for a specific field (alias for ChainableFieldFilter)
+ * Only shows methods for operators that the field supports
+ */
+type FieldFilter<T, S extends QuerySpec, Field extends FilterableFields<S>> = ChainableFieldFilter<T, S, Field>;
+/**
+ * Sort methods for a specific field
+ */
+interface FieldSort<S extends QuerySpec> {
+    asc(): SortExpression<S>;
+    desc(): SortExpression<S>;
+}
+/**
+ * Filter factory interface - creates filter expressions
+ * @example
+ * Filter('price').gt(50)
+ * Filter.and(Filter('title').eq('Product'), Filter('price').gt(50))
+ */
+interface FilterFactory<T, S extends QuerySpec> {
+    /** Create a field-specific filter */
+    <Field extends FilterableFields<S>>(field: Field): FieldFilter<T, S, Field>;
+    /** Combine filters with AND logic */
+    and(...filters: FilterExpression<T, S>[]): FilterExpression<T, S>;
+    /** Combine filters with OR logic */
+    or(...filters: FilterExpression<T, S>[]): FilterExpression<T, S>;
+    /** Negate a filter */
+    not(filter: FilterExpression<T, S>): FilterExpression<T, S>;
+}
+/**
+ * Sort factory - creates sort expressions
+ * @example
+ * Sort('price').desc()
+ */
+type SortFactory<S extends QuerySpec> = <Field extends SortableFields<S>>(field: Field) => FieldSort<S>;
+/**
+ * Query builder interface
+ * @template T - Entity type
+ * @template S - Query spec defining filterable/sortable fields
+ * @template R - Output type from build() (defaults to QueryRequest<T, S>)
+ * @example
+ * QueryBuilder()
+ *   .withFilter(Filter.and(
+ *     Filter('title').eq('Product'),
+ *     Filter('price').gt(50)
+ *   ))
+ *   .withFields('title', 'price')
+ *   .withSorting(Sort('price').desc())
+ *   .withPaging({ limit: 20, offset: 0 })
+ *   .build()
+ */
+interface QueryBuilder<T, S extends QuerySpec, R = QueryRequest<T, S>> {
+    /** Add a filter to the query */
+    withFilter(filter: FilterExpression<T, S>): QueryBuilder<T, S, R>;
+    /** Add field projection - return only specified fields */
+    withFields(...fields: (keyof T & string)[]): QueryBuilder<T, S, R>;
+    /** Add sorting to the query */
+    withSorting(...sorts: SortExpression<S>[]): QueryBuilder<T, S, R>;
+    /** Add paging to the query */
+    withPaging(paging: PagingFor<S>): QueryBuilder<T, S, R>;
+    /** Build the final query request object */
+    build(): R;
+}
+/**
+ * Complete set of query helpers for an entity
+ * This is what gets spread into module namespaces
+ * @template T - Entity type
+ * @template S - Query spec defining filterable/sortable fields
+ * @template R - Output type from QueryBuilder.build() (defaults to QueryRequest<T, S>)
+ */
+interface QueryHelpers<T, S extends QuerySpec, R = QueryRequest<T, S>> {
+    /** QueryBuilder factory */
+    QueryBuilder: () => QueryBuilder<T, S, R>;
+    /** Filter factory - creates filter expressions */
+    Filter: FilterFactory<T, S>;
+    /** Sort factory - creates sort expressions */
+    Sort: SortFactory<S>;
+}
+
+export { type APIMetadata, type AccountInfo, type AmbassadorFactory, type AmbassadorFunctionDescriptor, type AmbassadorRequestOptions, type AuthenticationStrategy, type BaseEventMetadata, type BoundAuthenticationStrategy, type BuildAmbassadorFunction, type BuildDescriptors, type BuildEventDefinition, type BuildRESTFunction, type BuildServicePluginDefinition, type CursorPaging, type Descriptors, EventDefinition, type EventHandler, type EventIdentity, type ExposeFieldsBasedOnToggle, type FieldFilter, type FieldSort, type Filter, type FilterExpression, type FilterFactory, type FilterableFields, type GetNestedType, type HTTPMethod, type Host, type HostModule, type HostModuleAPI, type HttpClient, type HttpResponse, type MaybeContext, type Method, type MigrationOptions, type NonNullablePaths, type OffsetPaging, type PagingFor, type PublicMetadata, type Query, type QueryBuilder, type QueryHelpers, type QueryRequest, type QuerySpec, type RESTFunctionDescriptor, type RequestContext, type RequestOptions, type RequestOptionsFactory, type RestModuleMeta, SERVICE_PLUGIN_ERROR_TYPE, SORT_CAPABILITIES, SORT_DIRECTIONS, type Search, type SearchSpec, type ServicePluginContract, ServicePluginDefinition, type ServicePluginMethodInput, type ServicePluginMethodMetadata, type SortCapability, type SortExpression, type SortFactory, type SortOrder, type Sorting, type WQL, type WQLSpec };

package/internal/build/index.d.ts

@@ -213,9 +213,15 @@ type EventIdentity = {
     wixUserId: string;
     appId: string;
 };
+type AccountInfo = {
+    accountId: string;
+    parentAccountId?: string;
+    siteId?: string;
+};
 type BaseEventMetadata = {
     instanceId: string;
     identity?: EventIdentity;
+    accountInfo?: AccountInfo;
 };
 type EventDefinition<Payload = unknown, Type extends string = string> = {
     __type: 'event-definition';
@@ -614,7 +620,7 @@ type Filter<Entity, Spec extends WQLSpec> = Simplify<{
 /**
  * Cursor-based paging configuration
  */
-interface CursorPaging {
+interface CursorPaging$1 {
     /** Maximum number of items to return in the results. */
     limit?: number | null;
     /**
@@ -628,7 +634,7 @@ interface CursorPaging {
 /**
  * Offset-based paging configuration
  */
-interface OffsetPaging {
+interface OffsetPaging$1 {
     /** Number of items to load */
     limit?: number | null;
     /** Number of items to skip in the current sort order */
@@ -644,9 +650,9 @@ type PagingType = 'cursor' | 'offset';
 type Paging<Spec extends {
     paging?: PagingType;
 }> = Spec['paging'] extends 'cursor' ? {
-    cursorPaging: CursorPaging;
+    cursorPaging: CursorPaging$1;
 } : Spec['paging'] extends 'offset' ? {
-    paging: OffsetPaging;
+    paging: OffsetPaging$1;
 } : {};
 
 /**
@@ -946,4 +952,173 @@ type Query<Entity, Spec extends QuerySpec> = {
     sort?: Sorting<Spec>[];
 } & Partial<Paging<Spec>>;
 
-export { type APIMetadata, type AmbassadorFactory, type AmbassadorFunctionDescriptor, type AmbassadorRequestOptions, type AuthenticationStrategy, type BaseEventMetadata, type BoundAuthenticationStrategy, type BuildAmbassadorFunction, type BuildDescriptors, type BuildEventDefinition, type BuildRESTFunction, type BuildServicePluginDefinition, type Descriptors, EventDefinition, type EventHandler, type EventIdentity, type ExposeFieldsBasedOnToggle, type Filter, type FilterableFields, type GetNestedType, type HTTPMethod, type Host, type HostModule, type HostModuleAPI, type HttpClient, type HttpResponse, type MaybeContext, type Method, type MigrationOptions, type NonNullablePaths, type PublicMetadata, type Query, type QuerySpec, type RESTFunctionDescriptor, type RequestContext, type RequestOptions, type RequestOptionsFactory, type RestModuleMeta, SERVICE_PLUGIN_ERROR_TYPE, SORT_CAPABILITIES, SORT_DIRECTIONS, type Search, type SearchSpec, type ServicePluginContract, ServicePluginDefinition, type ServicePluginMethodInput, type ServicePluginMethodMetadata, type SortCapability, type SortOrder, type Sorting, type WQL, type WQLSpec };
+interface CursorPaging {
+    limit: number;
+    cursor?: string;
+}
+interface OffsetPaging {
+    limit: number;
+    offset?: number;
+}
+type PagingFor<S extends QuerySpec> = S['paging'] extends 'cursor' ? CursorPaging : OffsetPaging;
+/**
+ * The output type from QueryBuilder.build()
+ * This is a plain object ready to be sent to an API
+ */
+interface QueryRequest<T, S extends QuerySpec> {
+    filter?: Filter<T, S>;
+    sort?: Sorting<S>[];
+    paging?: PagingFor<S>;
+    /** Field projection - return only specified fields */
+    fields?: string[];
+}
+/**
+ * Represents a filter expression that can be combined with other filters
+ */
+interface FilterExpression<T, S extends QuerySpec> {
+    readonly filter: Filter<T, S>;
+}
+/**
+ * Represents a sort expression
+ */
+interface SortExpression<S extends QuerySpec> {
+    readonly sort: Sorting<S>;
+}
+/**
+ * Extract fields that support a specific operator from the spec
+ */
+type FieldsWithOperator<S extends QuerySpec, Op extends string> = S['wql'][number] extends infer Group ? Group extends WQL ? Group['operators'] extends readonly string[] ? Op extends Group['operators'][number] ? Group['fields'][number] : never : Group['fields'][number] : never : never;
+/**
+ * Check if a specific field supports a specific operator
+ */
+type HasOperator<S extends QuerySpec, Field extends string, Op extends string> = Field extends FieldsWithOperator<S, Op> ? true : false;
+/**
+ * Extract sortable fields from the spec
+ */
+type SortableFields<S extends QuerySpec> = S['wql'][number] extends infer Group ? Group extends {
+    fields: readonly string[];
+    sort: 'ASC' | 'DESC' | 'BOTH';
+} ? Group['fields'][number] : never : never;
+/**
+ * Chainable field filter - extends FilterExpression so it can be used directly,
+ * but also allows chaining multiple operators on the same field.
+ * @example
+ * // Single operator - returns ChainableFieldFilter which is also FilterExpression
+ * Filter('price').gt(50)
+ *
+ * // Chained operators - combines into single field filter
+ * Filter('price').gt(50).lt(100)
+ * // Produces: { price: { $gt: 50, $lt: 100 } }
+ */
+type ChainableFieldFilter<T, S extends QuerySpec, Field extends FilterableFields<S>> = FilterExpression<T, S> & (HasOperator<S, Field & string, '$eq'> extends true ? {
+    eq(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$ne'> extends true ? {
+    ne(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$gt'> extends true ? {
+    gt(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$gte'> extends true ? {
+    gte(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$lt'> extends true ? {
+    lt(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$lte'> extends true ? {
+    lte(value: GetNestedType<T, Field & string>): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$startsWith'> extends true ? {
+    startsWith(value: string): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$endsWith'> extends true ? {
+    endsWith(value: string): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$contains'> extends true ? {
+    contains(value: string): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$in'> extends true ? {
+    in(values: GetNestedType<T, Field & string>[]): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$nin'> extends true ? {
+    nin(values: GetNestedType<T, Field & string>[]): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$hasSome'> extends true ? {
+    hasSome(values: GetNestedType<T, Field & string>[]): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$hasAll'> extends true ? {
+    hasAll(values: GetNestedType<T, Field & string>[]): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$exists'> extends true ? {
+    exists(value?: boolean): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$isEmpty'> extends true ? {
+    isEmpty(value?: boolean): ChainableFieldFilter<T, S, Field>;
+} : {}) & (HasOperator<S, Field & string, '$ne'> extends true ? {
+    isNotEmpty(): ChainableFieldFilter<T, S, Field>;
+} : {});
+/**
+ * Filter methods for a specific field (alias for ChainableFieldFilter)
+ * Only shows methods for operators that the field supports
+ */
+type FieldFilter<T, S extends QuerySpec, Field extends FilterableFields<S>> = ChainableFieldFilter<T, S, Field>;
+/**
+ * Sort methods for a specific field
+ */
+interface FieldSort<S extends QuerySpec> {
+    asc(): SortExpression<S>;
+    desc(): SortExpression<S>;
+}
+/**
+ * Filter factory interface - creates filter expressions
+ * @example
+ * Filter('price').gt(50)
+ * Filter.and(Filter('title').eq('Product'), Filter('price').gt(50))
+ */
+interface FilterFactory<T, S extends QuerySpec> {
+    /** Create a field-specific filter */
+    <Field extends FilterableFields<S>>(field: Field): FieldFilter<T, S, Field>;
+    /** Combine filters with AND logic */
+    and(...filters: FilterExpression<T, S>[]): FilterExpression<T, S>;
+    /** Combine filters with OR logic */
+    or(...filters: FilterExpression<T, S>[]): FilterExpression<T, S>;
+    /** Negate a filter */
+    not(filter: FilterExpression<T, S>): FilterExpression<T, S>;
+}
+/**
+ * Sort factory - creates sort expressions
+ * @example
+ * Sort('price').desc()
+ */
+type SortFactory<S extends QuerySpec> = <Field extends SortableFields<S>>(field: Field) => FieldSort<S>;
+/**
+ * Query builder interface
+ * @template T - Entity type
+ * @template S - Query spec defining filterable/sortable fields
+ * @template R - Output type from build() (defaults to QueryRequest<T, S>)
+ * @example
+ * QueryBuilder()
+ *   .withFilter(Filter.and(
+ *     Filter('title').eq('Product'),
+ *     Filter('price').gt(50)
+ *   ))
+ *   .withFields('title', 'price')
+ *   .withSorting(Sort('price').desc())
+ *   .withPaging({ limit: 20, offset: 0 })
+ *   .build()
+ */
+interface QueryBuilder<T, S extends QuerySpec, R = QueryRequest<T, S>> {
+    /** Add a filter to the query */
+    withFilter(filter: FilterExpression<T, S>): QueryBuilder<T, S, R>;
+    /** Add field projection - return only specified fields */
+    withFields(...fields: (keyof T & string)[]): QueryBuilder<T, S, R>;
+    /** Add sorting to the query */
+    withSorting(...sorts: SortExpression<S>[]): QueryBuilder<T, S, R>;
+    /** Add paging to the query */
+    withPaging(paging: PagingFor<S>): QueryBuilder<T, S, R>;
+    /** Build the final query request object */
+    build(): R;
+}
+/**
+ * Complete set of query helpers for an entity
+ * This is what gets spread into module namespaces
+ * @template T - Entity type
+ * @template S - Query spec defining filterable/sortable fields
+ * @template R - Output type from QueryBuilder.build() (defaults to QueryRequest<T, S>)
+ */
+interface QueryHelpers<T, S extends QuerySpec, R = QueryRequest<T, S>> {
+    /** QueryBuilder factory */
+    QueryBuilder: () => QueryBuilder<T, S, R>;
+    /** Filter factory - creates filter expressions */
+    Filter: FilterFactory<T, S>;
+    /** Sort factory - creates sort expressions */
+    Sort: SortFactory<S>;
+}
+
+export { type APIMetadata, type AccountInfo, type AmbassadorFactory, type AmbassadorFunctionDescriptor, type AmbassadorRequestOptions, type AuthenticationStrategy, type BaseEventMetadata, type BoundAuthenticationStrategy, type BuildAmbassadorFunction, type BuildDescriptors, type BuildEventDefinition, type BuildRESTFunction, type BuildServicePluginDefinition, type CursorPaging, type Descriptors, EventDefinition, type EventHandler, type EventIdentity, type ExposeFieldsBasedOnToggle, type FieldFilter, type FieldSort, type Filter, type FilterExpression, type FilterFactory, type FilterableFields, type GetNestedType, type HTTPMethod, type Host, type HostModule, type HostModuleAPI, type HttpClient, type HttpResponse, type MaybeContext, type Method, type MigrationOptions, type NonNullablePaths, type OffsetPaging, type PagingFor, type PublicMetadata, type Query, type QueryBuilder, type QueryHelpers, type QueryRequest, type QuerySpec, type RESTFunctionDescriptor, type RequestContext, type RequestOptions, type RequestOptionsFactory, type RestModuleMeta, SERVICE_PLUGIN_ERROR_TYPE, SORT_CAPABILITIES, SORT_DIRECTIONS, type Search, type SearchSpec, type ServicePluginContract, ServicePluginDefinition, type ServicePluginMethodInput, type ServicePluginMethodMetadata, type SortCapability, type SortExpression, type SortFactory, type SortOrder, type Sorting, type WQL, type WQLSpec };