@wix/wix-data-items-common 1.0.311 → 1.0.313

package/dist/types/api/WixDataDistinctOptionsBuilder.d.ts

@@ -2,36 +2,90 @@ import type { FilterExpression } from '@wix/sdk-types';
 import type { WixDataDistinctOptions, WixDataItem, WixDataQuerySpec } from './types';
 import type { SortOrder } from '../types/data-item-types';
 /**
- * WixData distinct options builder.
- * @internal
+ * Builder for distinct options used by Wix Data distinct operations.
+ *
+ * Use this builder to configure distinct behavior such as language, consistency,
+ * filters, ordering, and paging.
+ * @public
+ * @builder
+ * @documentationMaturity preview
  */
 export interface WixDataDistinctOptionsBuilder {
+    /**
+     * Sets whether distinct hooks are suppressed.
+     *
+     * When `true`, the distinct operation runs without triggering hooks.
+     */
     withSuppressHooks(value: boolean): WixDataDistinctOptionsBuilder;
+    /**
+     * Sets whether draft items are included when retrieving distinct values.
+     * @internal
+     */
     withShowDrafts(value: boolean): WixDataDistinctOptionsBuilder;
+    /**
+     * Sets app-specific options for the distinct operation.
+     * @internal
+     */
     withAppOptions(value: Record<string, any>): WixDataDistinctOptionsBuilder;
+    /**
+     * Sets the language used for the distinct operation.
+     */
     withLanguage(value: string): WixDataDistinctOptionsBuilder;
+    /**
+     * Sets whether the distinct operation uses a consistent read.
+     */
     withConsistentRead(value: boolean): WixDataDistinctOptionsBuilder;
-    withIncludeReferences(value: {
-        field: string;
-        limit?: number;
-    }[]): WixDataDistinctOptionsBuilder;
+    /**
+     * Sets whether the total count is returned with the distinct results.
+     */
     withReturnTotalCount(value: boolean): WixDataDistinctOptionsBuilder;
-    withIncludeFieldGroups(...value: string[]): WixDataDistinctOptionsBuilder;
+    /**
+     * Sets the filter used to retrieve distinct values.
+     */
     withFilter(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataDistinctOptionsBuilder;
+    /**
+     * Sets the sort order for the distinct results.
+     */
     withOrder(value: SortOrder): WixDataDistinctOptionsBuilder;
+    /**
+     * Sets offset-based paging for the distinct results.
+     */
     withPaging(value: {
         limit?: number;
         offset?: number;
     }): WixDataDistinctOptionsBuilder;
+    /**
+     * Sets cursor-based paging for the distinct results.
+     */
     withCursorPaging(value: {
         cursor?: string;
         limit?: number;
     }): WixDataDistinctOptionsBuilder;
+    /**
+     * Builds the distinct options object.
+     */
     build(): WixDataDistinctOptions;
 }
 /**
  * Creates a new WixData distinct options builder.
- * @internal
+ * @public
+ * @documentationMaturity preview
+ *
+ * @example
+ * ```ts
+ * import { items, DistinctOptionsBuilder } from '@wix/data'
+ *
+ * const options = DistinctOptionsBuilder()
+ *   .withLanguage('en')
+ *   .withConsistentRead(true)
+ *   .withReturnTotalCount(true)
+ *   .withFilter(Filter('status').eq('active'))
+ *   .withOrder([{ fieldName: 'status', order: 'asc' }])
+ *   .withPaging({ limit: 10, offset: 5 })
+ *   .build()
+ *
+ * const result = await items.distinct('myCollection', 'status', options)
+ * ```
  */
 export declare const DistinctOptionsBuilder: () => WixDataDistinctOptionsBuilder;
 //# sourceMappingURL=WixDataDistinctOptionsBuilder.d.ts.map

package/dist/types/api/WixDataDistinctOptionsBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WixDataDistinctOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataDistinctOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EACV,sBAAsB,EACtB,WAAW,EACX,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEzD;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IAChE,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IAC7D,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,6BAA6B,CAAA;IACzE,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,6BAA6B,CAAA;IAC1D,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IACjE,qBAAqB,CACnB,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GACzC,6BAA6B,CAAA;IAChC,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IACnE,sBAAsB,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,6BAA6B,CAAA;IACzE,UAAU,CACR,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,6BAA6B,CAAA;IAChC,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,6BAA6B,CAAA;IAC1D,UAAU,CAAC,KAAK,EAAE;QAChB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,GAAG,6BAA6B,CAAA;IACjC,gBAAgB,CAAC,KAAK,EAAE;QACtB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,GAAG,6BAA6B,CAAA;IACjC,KAAK,IAAI,sBAAsB,CAAA;CAChC;AAoGD;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,6BACF,CAAA"}
+{"version":3,"file":"WixDataDistinctOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataDistinctOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EACV,sBAAsB,EACtB,WAAW,EACX,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEzD;;;;;;;;GAQG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IAChE;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IAC7D;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,6BAA6B,CAAA;IACzE;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,6BAA6B,CAAA;IAC1D;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IACjE;;OAEG;IACH,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IACnE;;OAEG;IACH,UAAU,CACR,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,6BAA6B,CAAA;IAChC;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,6BAA6B,CAAA;IAC1D;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE;QAChB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,GAAG,6BAA6B,CAAA;IACjC;;OAEG;IACH,gBAAgB,CAAC,KAAK,EAAE;QACtB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,GAAG,6BAA6B,CAAA;IACjC;;OAEG;IACH,KAAK,IAAI,sBAAsB,CAAA;CAChC;AA4ED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,6BACF,CAAA"}

package/dist/types/api/WixDataFieldModificationsBuilder.d.ts

@@ -27,23 +27,23 @@ export interface FieldModificationsBuilder<Self> {
      */
     setField(field: string, value: any): Self;
     /**
-     * Refines a patch operation to append the specified value to the specified array field.
+     * Refines a patch operation to append the specified value to the specified array or multi-reference field.
      * @public
      * @documentationMaturity preview
-     * @param field - Array field to append the specified value to. Nested fields can be specified using dot notation. For example: `address.street`.
+     * @param field - Array or multi-reference field to append the specified value to. Nested fields can be specified using dot notation. For example: `address.street`.
      * @requiredField field
-     * @param value - Value to append to the specified array field.
+     * @param value - Value to append to the specified array or multi-reference field.
      * @requiredField value
      * @returns Updated patch object.
      */
     appendToArray(field: string, value: any): Self;
     /**
-     * Refines a patch operation to remove the first instance of the specified value from the specified array field.
+     * Refines a patch operation to remove the first instance of the specified value from the specified array or multi-reference field.
      * @public
      * @documentationMaturity preview
-     * @param field - Array field to remove the specified value from. Nested fields can be specified using dot notation. For example: `address.street`.
+     * @param field - Array or multi-reference field to remove the specified value from. Nested fields can be specified using dot notation. For example: `address.street`.
      * @requiredField field
-     * @param value - Value whose first instance is removed from the specified array field.
+     * @param value - Value whose first instance is removed from the specified array or multi-reference field.
      * @requiredField value
      * @returns Updated patch object.
      */
@@ -72,7 +72,7 @@ export interface WixDataFieldModificationsBuilder extends FieldModificationsBuil
  *
  * @example
  * ```ts
- * import { FieldModificationsBuilder } from '@wix/wix-data-items-common'
+ * import { FieldModificationsBuilder } from '@wix/data'
  *
  * const fieldModifications = FieldModificationsBuilder()
  *   .setField('title', 'Updated title')

package/dist/types/api/WixDataFieldModificationsBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WixDataFieldModificationsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataFieldModificationsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAG5D;;;GAGG;AACH,MAAM,WAAW,yBAAyB,CAAC,IAAI;IAC7C;;;;;;;;;OASG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IAE/C;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEzC;;;;;;;;;OASG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAE9C;;;;;;;;;OASG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEhD;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,gCACf,SAAQ,yBAAyB,CAAC,gCAAgC,CAAC;IACnE,mDAAmD;IACnD,KAAK,IAAI,iBAAiB,EAAE,CAAA;CAC7B;AA+BD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,yBAAyB,EAAE,MAAM,gCACI,CAAA"}
+{"version":3,"file":"WixDataFieldModificationsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataFieldModificationsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAG5D;;;GAGG;AACH,MAAM,WAAW,yBAAyB,CAAC,IAAI;IAC7C;;;;;;;;;OASG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IAE/C;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEzC;;;;;;;;;OASG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAE9C;;;;;;;;;OASG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEhD;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,gCACf,SAAQ,yBAAyB,CAAC,gCAAgC,CAAC;IACnE,mDAAmD;IACnD,KAAK,IAAI,iBAAiB,EAAE,CAAA;CAC7B;AA+BD;;;;;;;;;;;;;;;;;GAiBG;AAEH,eAAO,MAAM,yBAAyB,EAAE,MAAM,gCACI,CAAA"}

package/dist/types/api/WixDataGetOptionsBuilder.d.ts

@@ -1,25 +1,79 @@
 import type { WixDataGetOptions } from './types';
 /**
- * WixData get options builder.
- * @internal
+ * Builder for get options used by Wix Data get operations.
+ *
+ * Use this builder to configure get behavior such as hooks suppression,
+ * app-specific options, language, consistency, selected
+ * fields, references, and field groups.
+ * @public
+ * @builder
+ * @documentationMaturity preview
  */
 export interface WixDataGetOptionsBuilder {
+    /**
+     * Sets whether get hooks are suppressed.
+     *
+     * When `true`, the get operation runs without triggering hooks.
+     */
     withSuppressHooks(value: boolean): WixDataGetOptionsBuilder;
+    /**
+     * Sets whether draft items are included when retrieving an item.
+     * @internal
+     */
     withShowDrafts(value: boolean): WixDataGetOptionsBuilder;
+    /**
+     * Sets app-specific options for the get operation.
+     */
     withAppOptions(value: Record<string, any>): WixDataGetOptionsBuilder;
+    /**
+     * Sets the language used for the get operation.
+     */
     withLanguage(value: string): WixDataGetOptionsBuilder;
+    /**
+     * Sets whether the get operation uses a consistent read.
+     */
     withConsistentRead(value: boolean): WixDataGetOptionsBuilder;
+    /**
+     * Sets the fields to include in the returned item.
+     */
     withFields(...value: string[]): WixDataGetOptionsBuilder;
+    /**
+     * Sets referenced fields to include in the returned item.
+     */
     withIncludeReferences(value: {
         field: string;
         limit?: number;
     }[]): WixDataGetOptionsBuilder;
+    /**
+     * Sets the field groups to include in the returned item.
+     */
     withIncludeFieldGroups(...value: string[]): WixDataGetOptionsBuilder;
+    /**
+     * Builds the get options object.
+     */
     build(): WixDataGetOptions;
 }
 /**
  * Creates a new WixData get options builder.
- * @internal
+ * @public
+ * @documentationMaturity preview
+ *
+ * @example
+ * ```ts
+ * import { items, GetOptionsBuilder } from '@wix/data'
+ *
+ * const options = GetOptionsBuilder()
+ *   .withSuppressHooks(true)
+ *   .withAppOptions({ key: 'value' })
+ *   .withLanguage('es')
+ *   .withConsistentRead(true)
+ *   .withFields('_id', 'foo')
+ *   .withIncludeReferences([{ field: 'author', limit: 1 }])
+ *   .withIncludeFieldGroups('group-a')
+ *   .build()
+ *
+ * const item = await items.get('myCollection', 'someId', options)
+ * ```
  */
 export declare const GetOptionsBuilder: () => WixDataGetOptionsBuilder;
 //# sourceMappingURL=WixDataGetOptionsBuilder.d.ts.map

package/dist/types/api/WixDataGetOptionsBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WixDataGetOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataGetOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEhD;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAA;IAC3D,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAA;IACxD,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,wBAAwB,CAAA;IACpE,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,wBAAwB,CAAA;IACrD,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAA;IAC5D,UAAU,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,wBAAwB,CAAA;IACxD,qBAAqB,CACnB,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GACzC,wBAAwB,CAAA;IAC3B,sBAAsB,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,wBAAwB,CAAA;IACpE,KAAK,IAAI,iBAAiB,CAAA;CAC3B;AAuED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,wBACF,CAAA"}
+{"version":3,"file":"WixDataGetOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataGetOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEhD;;;;;;;;;GASG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAA;IAC3D;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAA;IACxD;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,wBAAwB,CAAA;IACpE;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,wBAAwB,CAAA;IACrD;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAA;IAC5D;;OAEG;IACH,UAAU,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,wBAAwB,CAAA;IACxD;;OAEG;IACH,qBAAqB,CACnB,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GACzC,wBAAwB,CAAA;IAC3B;;OAEG;IACH,sBAAsB,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,wBAAwB,CAAA;IACpE;;OAEG;IACH,KAAK,IAAI,iBAAiB,CAAA;CAC3B;AAuED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,wBACF,CAAA"}

package/dist/types/api/WixDataInsertOptionsBuilder.d.ts

@@ -1,18 +1,54 @@
 import type { WixDataInsertOptions } from './types';
 /**
- * WixData insert options builder.
- * @internal
+ * Builder for insert options used by Wix Data insert operations.
+ *
+ * Use this builder to configure insert behavior such as hooks suppression,
+ * and reference handling.
+ * @public
+ * @builder
+ * @documentationMaturity preview
  */
 export interface WixDataInsertOptionsBuilder {
+    /**
+     * Sets whether insert hooks are suppressed.
+     *
+     * When `true`, the insert runs without triggering hooks.
+     */
     withSuppressHooks(value: boolean): WixDataInsertOptionsBuilder;
+    /**
+     * Sets whether draft items are included when inserting an item.
+     * @internal
+     */
     withShowDrafts(value: boolean): WixDataInsertOptionsBuilder;
+    /**
+     * Sets whether references are included when inserting an item.
+     * @internal
+     */
     withIncludeReferences(value: boolean): WixDataInsertOptionsBuilder;
+    /**
+     * Sets whether referenced items are saved when inserting an item.
+     */
     withSaveReferences(value: boolean): WixDataInsertOptionsBuilder;
+    /**
+     * Builds the insert options object.
+     */
     build(): WixDataInsertOptions;
 }
 /**
  * Creates a new WixData insert options builder.
- * @internal
+ * @public
+ * @documentationMaturity preview
+ *
+ * @example
+ * ```ts
+ * import { items, InsertOptionsBuilder } from '@wix/data'
+ *
+ * const options = InsertOptionsBuilder()
+ *   .withSuppressHooks(true)
+ *   .build()
+ *
+ * const item = await items.insert('myCollection', { foo: 'bar' }, options)
+ * ```
  */
 export declare const InsertOptionsBuilder: () => WixDataInsertOptionsBuilder;
 //# sourceMappingURL=WixDataInsertOptionsBuilder.d.ts.map

package/dist/types/api/WixDataInsertOptionsBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WixDataInsertOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataInsertOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAEnD;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAC9D,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAC3D,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAClE,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAC/D,KAAK,IAAI,oBAAoB,CAAA;CAC9B;AAiCD;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,2BACF,CAAA"}
+{"version":3,"file":"WixDataInsertOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataInsertOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAEnD;;;;;;;;GAQG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAC9D;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAC3D;;;OAGG;IACH,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAClE;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAC/D;;OAEG;IACH,KAAK,IAAI,oBAAoB,CAAA;CAC9B;AAiCD;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,2BACF,CAAA"}

package/dist/types/api/WixDataIsReferencedOptionsBuilder.d.ts

@@ -1,15 +1,43 @@
 import type { WixDataIsReferencedOptions } from './types';
 /**
- * WixData isReferenced options builder.
- * @internal
+ * Builder for isReferenced options used by Wix Data isReferenced operations.
+ *
+ * Use this builder to configure whether the reference check uses a consistent read.
+ * @public
+ * @builder
+ * @documentationMaturity preview
  */
 export interface WixDataIsReferencedOptionsBuilder {
+    /**
+     * Sets whether the reference check uses a consistent read.
+     */
     withConsistentRead(value: boolean): WixDataIsReferencedOptionsBuilder;
+    /**
+     * Builds the isReferenced options object.
+     */
     build(): WixDataIsReferencedOptions;
 }
 /**
  * Creates a new WixData isReferenced options builder.
- * @internal
+ * @public
+ * @documentationMaturity preview
+ *
+ * @example
+ * ```ts
+ * import { items, IsReferencedOptionsBuilder } from '@wix/data'
+ *
+ * const options = IsReferencedOptionsBuilder()
+ *   .withConsistentRead(true)
+ *   .build()
+ *
+ * const isReferenced = await items.isReferenced(
+ *   'myCollection',
+ *   'someField',
+ *   'referringItemId',
+ *   'referencedItemId',
+ *   options
+ * )
+ * ```
  */
 export declare const IsReferencedOptionsBuilder: () => WixDataIsReferencedOptionsBuilder;
 //# sourceMappingURL=WixDataIsReferencedOptionsBuilder.d.ts.map

package/dist/types/api/WixDataIsReferencedOptionsBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WixDataIsReferencedOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataIsReferencedOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAA;AAEzD;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,iCAAiC,CAAA;IACrE,KAAK,IAAI,0BAA0B,CAAA;CACpC;AA2BD;;;GAGG;AACH,eAAO,MAAM,0BAA0B,EAAE,MAAM,iCACI,CAAA"}
+{"version":3,"file":"WixDataIsReferencedOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataIsReferencedOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAA;AAEzD;;;;;;;GAOG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,iCAAiC,CAAA;IACrE;;OAEG;IACH,KAAK,IAAI,0BAA0B,CAAA;CACpC;AA2BD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,0BAA0B,EAAE,MAAM,iCACI,CAAA"}

package/dist/types/api/WixDataPatchOptionsBuilder.d.ts

@@ -2,18 +2,51 @@ import type { FilterExpression } from '@wix/sdk-types';
 import type { WixDataItem, WixDataQuerySpec } from './types';
 import type { WixDataPatchOptions } from './WixDataPatch';
 /**
- * WixData patch options builder.
- * @internal
+ * Builder for patch options used by Wix Data patch operations.
+ *
+ * Use this builder to configure patch behavior such as hooks suppression,
+ * and conditional patching.
+ * @public
+ * @builder
+ * @documentationMaturity preview
  */
 export interface WixDataPatchOptionsBuilder {
+    /**
+     * Sets whether patch hooks are suppressed.
+     *
+     * When `true`, the patch runs without triggering hooks.
+     */
     withSuppressHooks(value: boolean): WixDataPatchOptionsBuilder;
+    /**
+     * Sets whether draft items are included when patching an item.
+     * @internal
+     */
     withShowDrafts(value: boolean): WixDataPatchOptionsBuilder;
+    /**
+     * Sets the condition that determines whether the item is patched.
+     */
     withCondition(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataPatchOptionsBuilder;
+    /**
+     * Builds the patch options object.
+     */
     build(): WixDataPatchOptions;
 }
 /**
  * Creates a new WixData patch options builder.
- * @internal
+ * @public
+ * @documentationMaturity preview
+ *
+ * @example
+ * ```ts
+ * import { items, PatchOptionsBuilder, Filter } from '@wix/data'
+ *
+ * const options = PatchOptionsBuilder()
+ *   .withSuppressHooks(true)
+ *   .withCondition(Filter('status').eq('active'))
+ *   .build()
+ *
+ * const item = await items.patch('myCollection', 'someId', option)
+ * ```
  */
 export declare const PatchOptionsBuilder: () => WixDataPatchOptionsBuilder;
 //# sourceMappingURL=WixDataPatchOptionsBuilder.d.ts.map

package/dist/types/api/WixDataPatchOptionsBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WixDataPatchOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataPatchOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAC5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEzD;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC7D,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC1D,aAAa,CACX,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,0BAA0B,CAAA;IAC7B,KAAK,IAAI,mBAAmB,CAAA;CAC7B;AAiCD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BACF,CAAA"}
+{"version":3,"file":"WixDataPatchOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataPatchOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAC5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEzD;;;;;;;;GAQG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC7D;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC1D;;OAEG;IACH,aAAa,CACX,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,0BAA0B,CAAA;IAC7B;;OAEG;IACH,KAAK,IAAI,mBAAmB,CAAA;CAC7B;AAiCD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BACF,CAAA"}

package/dist/types/api/WixDataQueryBuilder.d.ts

@@ -7,11 +7,12 @@ import { WixDataQueryRequest, WixDataQuerySpec, WixDataItem } from './types';
 export type WixDataQueryBuilder = SDKQueryBuilder<WixDataItem, WixDataQuerySpec, WixDataQueryRequest>;
 /**
  * Creates a new WixData query builder.
- * @internal
+ * @public
+ * @documentationMaturity preview
  *
  * @example
  * ```ts
- * import { QueryBuilder, Filter, Sort } from '@wix/wix-data-items-common'
+ * import { items, QueryBuilder, Filter, Sort } from '@wix/data'
  *
  * const request = QueryBuilder()
  *   .withFilter(
@@ -24,17 +25,19 @@ export type WixDataQueryBuilder = SDKQueryBuilder<WixDataItem, WixDataQuerySpec,
  *   .withPaging({ limit: 10, offset: 0 })
  *   .build()
  *
- * const result = await wixData.query<MyItem>('myCollection', request)
+ * const result = await items.query<MyItem>('myCollection', request)
  * ```
  */
 export declare const QueryBuilder: () => WixDataQueryBuilder;
 /**
  * Filter factory for creating filter expressions.
- * Uses the SDK's Filter with WixData types.
- * @internal
+ * @public
+ * @documentationMaturity preview
  *
  * @example
  * ```ts
+ * import { Filter } from '@wix/data'
+ *
  * // Simple field filter
  * Filter('status').eq('active')
  *
@@ -57,11 +60,13 @@ export declare const QueryBuilder: () => WixDataQueryBuilder;
 export declare const Filter: FilterFactory<WixDataItem, WixDataQuerySpec>;
 /**
  * Sort factory for creating sort expressions.
- * Uses the SDK's Sort with WixData types.
- * @internal
+ * @public
+ * @documentationMaturity preview
  *
  * @example
  * ```ts
+ * import { Sort, QueryBuilder } from '@wix/data'
+ *
  * // Descending sort
  * Sort('amount').desc()
  *

package/dist/types/api/WixDataQueryBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WixDataQueryBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataQueryBuilder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,YAAY,IAAI,eAAe,EAC/B,aAAa,EACb,WAAW,EACZ,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAS5E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,CAC/C,WAAW,EACX,gBAAgB,EAChB,mBAAmB,CACpB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,mBACJ,CAAA;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,MAAM,EAAE,aAAa,CAAC,WAAW,EAAE,gBAAgB,CACzC,CAAA;AAEvB;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAuB,CAAA;AAGtE,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,SAAS,GACV,MAAM,gBAAgB,CAAA"}
+{"version":3,"file":"WixDataQueryBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataQueryBuilder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,YAAY,IAAI,eAAe,EAC/B,aAAa,EACb,WAAW,EACZ,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAS5E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,CAC/C,WAAW,EACX,gBAAgB,EAChB,mBAAmB,CACpB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,mBACJ,CAAA;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,MAAM,EAAE,aAAa,CAAC,WAAW,EAAE,gBAAgB,CACzC,CAAA;AAEvB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAuB,CAAA;AAGtE,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,SAAS,GACV,MAAM,gBAAgB,CAAA"}

package/dist/types/api/WixDataQueryOptionsBuilder.d.ts

@@ -1,25 +1,84 @@
 import type { WixDataQueryOptions } from './types';
 /**
- * WixData query options builder.
- * @internal
+ * Builder for query options used by Wix Data query operations.
+ *
+ * Use this builder to configure query behavior such as hooks suppression,
+ * language, reference inclusion, and field groups.
+ * @public
+ * @builder
+ * @documentationMaturity preview
  */
 export interface WixDataQueryOptionsBuilder {
+    /**
+     * Sets whether query hooks are suppressed.
+     *
+     * When `true`, the query runs without triggering hooks.
+     */
     withSuppressHooks(value: boolean): WixDataQueryOptionsBuilder;
+    /**
+     * Sets whether draft items are included in query results.
+     * @internal
+     */
     withShowDrafts(value: boolean): WixDataQueryOptionsBuilder;
+    /**
+     * Sets app-specific query options.
+     */
     withAppOptions(value: Record<string, any>): WixDataQueryOptionsBuilder;
+    /**
+     * Sets the language used for the query.
+     */
     withLanguage(value: string): WixDataQueryOptionsBuilder;
+    /**
+     * Sets whether the query uses consistent read mode.
+     */
     withConsistentRead(value: boolean): WixDataQueryOptionsBuilder;
+    /**
+     * Includes referenced items for the specified reference fields.
+     *
+     * Use `limit` to cap how many referenced items are returned per field.
+     */
     withIncludeReferences(value: {
         field: string;
         limit?: number;
     }[]): WixDataQueryOptionsBuilder;
+    /**
+     * Sets whether the total result count is returned with the query response.
+     */
     withReturnTotalCount(value: boolean): WixDataQueryOptionsBuilder;
+    /**
+     * Includes the specified field groups in the query results.
+     */
     withIncludeFieldGroups(...value: string[]): WixDataQueryOptionsBuilder;
+    /**
+     * Builds the query options object.
+     */
     build(): WixDataQueryOptions;
 }
 /**
  * Creates a new WixData query options builder.
- * @internal
+ * @public
+ * @documentationMaturity preview
+ *
+ * @example
+ * ```ts
+ * import { items, QueryOptionsBuilder } from '@wix/data'
+ *
+ * const options = QueryOptionsBuilder()
+ *   .withSuppressHooks(true)
+ *   .withAppOptions({ key: 'value' })
+ *   .withLanguage('en')
+ *   .withConsistentRead(true)
+ *   .withIncludeReferences([{ field: 'author', limit: 3 }])
+ *   .withReturnTotalCount(true)
+ *   .withIncludeFieldGroups('seo', 'details')
+ *   .build()
+ *
+ * const result = await items.query<MyItem>(
+ *   'myCollection',
+ *   {},
+ *   options
+ * )
+ * ```
  */
 export declare const QueryOptionsBuilder: () => WixDataQueryOptionsBuilder;
 //# sourceMappingURL=WixDataQueryOptionsBuilder.d.ts.map

package/dist/types/api/WixDataQueryOptionsBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WixDataQueryOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataQueryOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAElD;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC7D,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC1D,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,0BAA0B,CAAA;IACtE,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,0BAA0B,CAAA;IACvD,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC9D,qBAAqB,CACnB,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GACzC,0BAA0B,CAAA;IAC7B,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAChE,sBAAsB,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,0BAA0B,CAAA;IACtE,KAAK,IAAI,mBAAmB,CAAA;CAC7B;AAsED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BACF,CAAA"}
+{"version":3,"file":"WixDataQueryOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataQueryOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAElD;;;;;;;;GAQG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC7D;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC1D;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,0BAA0B,CAAA;IACtE;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,0BAA0B,CAAA;IACvD;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC9D;;;;OAIG;IACH,qBAAqB,CACnB,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GACzC,0BAA0B,CAAA;IAC7B;;OAEG;IACH,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAChE;;OAEG;IACH,sBAAsB,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,0BAA0B,CAAA;IACtE;;OAEG;IACH,KAAK,IAAI,mBAAmB,CAAA;CAC7B;AAsED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BACF,CAAA"}