@wix/wix-data-items-common 1.0.318 → 1.0.320

package/dist/esm/api/WixDataBulkInsertOptionsBuilder.js

@@ -27,12 +27,12 @@ class WixDataBulkInsertOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData bulk insert options builder.
+ * Creates a new bulk insert options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a bulk insert options builder"
  * import { items, BulkInsertOptionsBuilder } from '@wix/data'
  *
  * const options = BulkInsertOptionsBuilder()

package/dist/esm/api/WixDataBulkPatchOptionsBuilder.js

@@ -24,12 +24,12 @@ class WixDataBulkPatchOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData bulk patch options builder.
+ * Creates a new bulk patch options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a bulk patch options builder"
  * import { items, BulkPatchOptionsBuilder, Filter } from '@wix/data'
  *
  * const options = BulkPatchOptionsBuilder()

package/dist/esm/api/WixDataBulkRemoveOptionsBuilder.js

@@ -24,12 +24,12 @@ class WixDataBulkRemoveOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData bulk remove options builder.
+ * Creates a new bulk remove options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a bulk remove options builder"
  * import { items, BulkRemoveOptionsBuilder, Filter } from '@wix/data'
  *
  * const options = BulkRemoveOptionsBuilder()

package/dist/esm/api/WixDataBulkSaveOptionsBuilder.js

@@ -24,12 +24,12 @@ class WixDataBulkSaveOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData bulk save options builder.
+ * Creates a new bulk save options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a bulk save options builder"
  * import { items, BulkSaveOptionsBuilder } from '@wix/data'
  *
  * const options = BulkSaveOptionsBuilder()

package/dist/esm/api/WixDataBulkUpdateOptionsBuilder.js

@@ -27,12 +27,12 @@ class WixDataBulkUpdateOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData bulk update options builder.
+ * Creates a new bulk update options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a bulk update options builder"
  * import { items, BulkUpdateOptionsBuilder, Filter } from '@wix/data'
  *
  * const options = BulkUpdateOptionsBuilder()

package/dist/esm/api/WixDataCountOptionsBuilder.js

@@ -36,12 +36,12 @@ class WixDataCountOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData count options builder.
+ * Creates a new count options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a count options builder"
  * import { items, CountOptionsBuilder } from '@wix/data'
  *
  * const options = CountOptionsBuilder()

package/dist/esm/api/WixDataDistinctOptionsBuilder.js

@@ -52,12 +52,12 @@ class WixDataDistinctOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData distinct options builder.
+ * Creates a new distinct options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a distinct options builder"
  * import { items, DistinctOptionsBuilder } from '@wix/data'
  *
  * const options = DistinctOptionsBuilder()

package/dist/esm/api/WixDataFieldModificationsBuilder.js

@@ -17,11 +17,11 @@ class WixDataFieldModificationsBuilderImpl extends BaseFieldModificationsBuilder
     }
 }
 /**
- * Creates a new WixData field modifications builder.
+ * Creates a new field modifications builder.
  * @internal
  *
  * @example
- * ```ts
+ * ```ts title="Create field modifications"
  * import { FieldModificationsBuilder } from '@wix/data'
  *
  * const fieldModifications = FieldModificationsBuilder()

package/dist/esm/api/WixDataGetOptionsBuilder.js

@@ -55,12 +55,12 @@ class WixDataGetOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData get options builder.
+ * Creates a new get options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a get options builder"
  * import { items, GetOptionsBuilder } from '@wix/data'
  *
  * const options = GetOptionsBuilder()

package/dist/esm/api/WixDataInsertOptionsBuilder.js

@@ -25,12 +25,12 @@ class WixDataInsertOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData insert options builder.
+ * Creates a new insert options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create an insert options builder"
  * import { items, InsertOptionsBuilder } from '@wix/data'
  *
  * const options = InsertOptionsBuilder()

package/dist/esm/api/WixDataIsReferencedOptionsBuilder.js

@@ -18,12 +18,12 @@ class WixDataIsReferencedOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData isReferenced options builder.
+ * Creates a new isReferenced options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create an isReferenced options builder"
  * import { items, IsReferencedOptionsBuilder } from '@wix/data'
  *
  * const options = IsReferencedOptionsBuilder()

package/dist/esm/api/WixDataPatchOptionsBuilder.js

@@ -24,12 +24,12 @@ class WixDataPatchOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData patch options builder.
+ * Creates a new patch options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a patch options builder"
  * import { items, PatchOptionsBuilder, Filter } from '@wix/data'
  *
  * const options = PatchOptionsBuilder()

package/dist/esm/api/WixDataQueryBuilder.js

@@ -2,12 +2,12 @@ import { createQueryUtils } from '@wix/sdk-runtime/query-builder-utils';
 // Create the base query utilities from SDK runtime
 const baseQueryUtils = createQueryUtils();
 /**
- * Creates a new WixData query builder.
+ * Creates a new query builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Build a query"
  * import { items, QueryBuilder, Filter, Sort } from '@wix/data'
  *
  * const request = QueryBuilder()
@@ -31,7 +31,7 @@ export const QueryBuilder = baseQueryUtils.QueryBuilder;
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create filter expressions"
  * import { Filter } from '@wix/data'
  *
  * // Simple field filter
@@ -60,7 +60,7 @@ export const Filter = baseQueryUtils.Filter;
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create sort expressions"
  * import { Sort, QueryBuilder } from '@wix/data'
  *
  * // Descending sort

package/dist/esm/api/WixDataQueryOptionsBuilder.js

@@ -54,12 +54,12 @@ class WixDataQueryOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData query options builder.
+ * Creates a new query options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a query options builder"
  * import { items, QueryOptionsBuilder } from '@wix/data'
  *
  * const options = QueryOptionsBuilder()

package/dist/esm/api/WixDataQueryReferencedItemsOptionsBuilder.js

@@ -50,12 +50,12 @@ class WixDataQueryReferencedItemsOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData query referenced items options builder.
+ * Creates a new query referenced items options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a query referenced items options builder"
  * import { items, QueryReferencedItemsOptionsBuilder } from '@wix/data'
  *
  * const options = QueryReferencedItemsOptionsBuilder()

package/dist/esm/api/WixDataRemoveOptionsBuilder.js

@@ -22,12 +22,12 @@ class WixDataRemoveOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData remove options builder.
+ * Creates a new remove options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a remove options builder"
  * import { items, Filter, RemoveOptionsBuilder } from '@wix/data'
  *
  * const options = RemoveOptionsBuilder()

package/dist/esm/api/WixDataSaveOptionsBuilder.js

@@ -25,12 +25,12 @@ class WixDataSaveOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData save options builder.
+ * Creates a new save options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a save options builder"
  * import { items, SaveOptionsBuilder } from '@wix/data'
  *
  * const options = SaveOptionsBuilder()

package/dist/esm/api/WixDataSearchBuilder.js

@@ -1,11 +1,11 @@
 import { createSearchUtils } from '@wix/sdk-runtime/search-builder-utils';
 const searchUtils = createSearchUtils();
 /**
- * Creates a new WixData search builder.
+ * Creates a new search builder.
  * @public
  *
  * @example
- * ```ts
+ * ```ts title="Build a search"
  * import { items, SearchBuilder, SearchParams, Filter } from '@wix/data'
  *
  * const request = SearchBuilder()
@@ -23,7 +23,7 @@ export const SearchBuilder = searchUtils.SearchBuilder;
  * @public
  *
  * @example
- * ```ts
+ * ```ts title="Create search parameters"
  * import { SearchParams } from '@wix/data'
  * // Simple expression
  * SearchParams.expression('search text')

package/dist/esm/api/WixDataSearchOptionsBuilder.js

@@ -30,12 +30,12 @@ class WixDataSearchOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData search options builder.
+ * Creates a new search options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a search options builder"
  * import { items, SearchBuilder, SearchOptionsBuilder, SearchParams } from '@wix/data'
  *
  * const searchRequest = SearchBuilder()

package/dist/esm/api/WixDataUpdateOptionsBuilder.js

@@ -28,12 +28,12 @@ class WixDataUpdateOptionsBuilderImpl {
     }
 }
 /**
- * Creates a new WixData update options builder.
+ * Creates a new update options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create an update options builder"
  * import { items, Filter, UpdateOptionsBuilder } from '@wix/data'
  *
  * const options = UpdateOptionsBuilder()

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

@@ -1,6 +1,6 @@
 import type { WixDataAggregateOptions } from './types';
 /**
- * Builder for aggregate options used by Wix Data aggregate operations.
+ * Options builder for aggregate operations.
  *
  * Use this builder to configure aggregation behavior such as language, consistent reads,
  * and total counts.
@@ -10,7 +10,7 @@ import type { WixDataAggregateOptions } from './types';
  */
 export interface WixDataAggregateOptionsBuilder {
     /**
-     * Sets whether draft items are included in aggregation results.
+     * Sets whether to include draft items in aggregation results.
      * @internal
      */
     withShowDrafts(value: boolean): WixDataAggregateOptionsBuilder;
@@ -23,7 +23,7 @@ export interface WixDataAggregateOptionsBuilder {
      */
     withConsistentRead(value: boolean): WixDataAggregateOptionsBuilder;
     /**
-     * Sets whether the total result count is returned with the aggregation response.
+     * Sets whether to return the total result count with the aggregation response.
      */
     withReturnTotalCount(value: boolean): WixDataAggregateOptionsBuilder;
     /**
@@ -32,12 +32,12 @@ export interface WixDataAggregateOptionsBuilder {
     build(): WixDataAggregateOptions;
 }
 /**
- * Creates a new WixData aggregate options builder.
+ * Creates a new aggregate options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create an aggregate options builder"
  * import { items, AggregateOptionsBuilder } from '@wix/data'
  *
  *

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

@@ -1,6 +1,6 @@
 import type { WixDataAsyncPatchByFilterOptions } from './types';
 /**
- * Builder for async patch by filter options used by Wix Data async patch-by-filter operations.
+ * Options builder for async patch-by-filter operations.
  *
  * Use this builder to configure async patch behavior such as hooks suppression.
  * @public
@@ -9,13 +9,13 @@ import type { WixDataAsyncPatchByFilterOptions } from './types';
  */
 export interface WixDataAsyncPatchByFilterOptionsBuilder {
     /**
-     * Sets whether async patch hooks are suppressed.
+     * Sets whether to suppress async patch hooks.
      *
      * When `true`, the async patch runs without triggering hooks.
      */
     withSuppressHooks(value: boolean): WixDataAsyncPatchByFilterOptionsBuilder;
     /**
-     * Sets whether draft items are included when patching items asynchronously.
+     * Sets whether to include draft items when patching items asynchronously.
      * @internal
      */
     withShowDrafts(value: boolean): WixDataAsyncPatchByFilterOptionsBuilder;
@@ -25,12 +25,12 @@ export interface WixDataAsyncPatchByFilterOptionsBuilder {
     build(): WixDataAsyncPatchByFilterOptions;
 }
 /**
- * Creates a new WixData async patch by filter options builder.
+ * Creates a new async patch-by-filter options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create an async patch-by-filter options builder"
  * import { items, AsyncPatchByFilterOptionsBuilder } from '@wix/data'
  *
  * const options = AsyncPatchByFilterOptionsBuilder()

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

@@ -1,6 +1,6 @@
 import type { WixDataAsyncRemoveByFilterOptions } from './types';
 /**
- * Builder for async remove by filter options used by Wix Data async remove-by-filter operations.
+ * Options builder for async remove-by-filter operations.
  *
  * Use this builder to configure async remove behavior such as hooks suppression.
  * @public
@@ -9,13 +9,13 @@ import type { WixDataAsyncRemoveByFilterOptions } from './types';
  */
 export interface WixDataAsyncRemoveByFilterOptionsBuilder {
     /**
-     * Sets whether async remove hooks are suppressed.
+     * Sets whether to suppress async remove hooks.
      *
      * When `true`, the async remove runs without triggering hooks.
      */
     withSuppressHooks(value: boolean): WixDataAsyncRemoveByFilterOptionsBuilder;
     /**
-     * Sets whether draft items are included when removing items asynchronously.
+     * Sets whether to include draft items when removing items asynchronously.
      * @internal
      */
     withShowDrafts(value: boolean): WixDataAsyncRemoveByFilterOptionsBuilder;
@@ -25,12 +25,12 @@ export interface WixDataAsyncRemoveByFilterOptionsBuilder {
     build(): WixDataAsyncRemoveByFilterOptions;
 }
 /**
- * Creates a new WixData async remove by filter options builder.
+ * Creates a new async remove-by-filter options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create an async remove-by-filter options builder"
  * import { items, AsyncRemoveByFilterOptionsBuilder } from '@wix/data'
  *
  * const options = AsyncRemoveByFilterOptionsBuilder()

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

@@ -1,6 +1,6 @@
 import type { WixDataBulkInsertOptions } from './types';
 /**
- * Builder for bulk insert options used by Wix Data bulk insert operations.
+ * Options builder for bulk insert operations.
  *
  * Use this builder to configure bulk insert behavior such as hooks suppression.
  * @public
@@ -9,18 +9,18 @@ import type { WixDataBulkInsertOptions } from './types';
  */
 export interface WixDataBulkInsertOptionsBuilder {
     /**
-     * Sets whether bulk insert hooks are suppressed.
+     * Sets whether to suppress bulk insert hooks.
      *
      * When `true`, the bulk insert runs without triggering hooks.
      */
     withSuppressHooks(value: boolean): WixDataBulkInsertOptionsBuilder;
     /**
-     * Sets whether draft items are included when inserting items in bulk.
+     * Sets whether to include draft items when inserting items in bulk.
      * @internal
      */
     withShowDrafts(value: boolean): WixDataBulkInsertOptionsBuilder;
     /**
-     * Sets whether referenced items are saved when inserting items in bulk.
+     * Sets whether to save referenced items when inserting items in bulk.
      */
     withSaveReferences(value: boolean): WixDataBulkInsertOptionsBuilder;
     /**
@@ -34,12 +34,12 @@ export interface WixDataBulkInsertOptionsBuilder {
     build(): WixDataBulkInsertOptions;
 }
 /**
- * Creates a new WixData bulk insert options builder.
+ * Creates a new bulk insert options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a bulk insert options builder"
  * import { items, BulkInsertOptionsBuilder } from '@wix/data'
  *
  * const options = BulkInsertOptionsBuilder()

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

@@ -2,7 +2,7 @@ import type { FilterExpression } from '@wix/sdk-types';
 import type { WixDataItem, WixDataQuerySpec } from './types';
 import type { WixDataBulkPatchOptions } from './WixDataPatch';
 /**
- * Builder for bulk patch options used by Wix Data bulk patch operations.
+ * Options builder for bulk patch operations.
  *
  * Use this builder to configure bulk patch behavior such as hooks suppression,
  * and conditional patching.
@@ -12,18 +12,18 @@ import type { WixDataBulkPatchOptions } from './WixDataPatch';
  */
 export interface WixDataBulkPatchOptionsBuilder {
     /**
-     * Sets whether bulk patch hooks are suppressed.
+     * Sets whether to suppress bulk patch hooks.
      *
      * When `true`, the bulk patch runs without triggering hooks.
      */
     withSuppressHooks(value: boolean): WixDataBulkPatchOptionsBuilder;
     /**
-     * Sets whether draft items are included when patching items in bulk.
+     * Sets whether to include draft items when patching items in bulk.
      * @internal
      */
     withShowDrafts(value: boolean): WixDataBulkPatchOptionsBuilder;
     /**
-     * Sets the condition that determines which items are patched.
+     * Sets the condition that determines which items to patch.
      */
     withCondition(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataBulkPatchOptionsBuilder;
     /**
@@ -32,12 +32,12 @@ export interface WixDataBulkPatchOptionsBuilder {
     build(): WixDataBulkPatchOptions;
 }
 /**
- * Creates a new WixData bulk patch options builder.
+ * Creates a new bulk patch options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a bulk patch options builder"
  * import { items, BulkPatchOptionsBuilder, Filter } from '@wix/data'
  *
  * const options = BulkPatchOptionsBuilder()

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

@@ -1,7 +1,7 @@
 import type { FilterExpression } from '@wix/sdk-types';
 import type { WixDataBulkRemoveOptions, WixDataItem, WixDataQuerySpec } from './types';
 /**
- * Builder for bulk remove options used by Wix Data bulk remove operations.
+ * Options builder for bulk remove operations.
  *
  * Use this builder to configure bulk remove behavior such as hooks suppression,
  * and conditional removal.
@@ -11,18 +11,18 @@ import type { WixDataBulkRemoveOptions, WixDataItem, WixDataQuerySpec } from './
  */
 export interface WixDataBulkRemoveOptionsBuilder {
     /**
-     * Sets whether bulk remove hooks are suppressed.
+     * Sets whether to suppress bulk remove hooks.
      *
      * When `true`, the bulk remove runs without triggering hooks.
      */
     withSuppressHooks(value: boolean): WixDataBulkRemoveOptionsBuilder;
     /**
-     * Sets whether draft items are included when removing items in bulk.
+     * Sets whether to include draft items when removing items in bulk.
      * @internal
      */
     withShowDrafts(value: boolean): WixDataBulkRemoveOptionsBuilder;
     /**
-     * Sets the condition that determines which items are removed.
+     * Sets the condition that determines which items to remove.
      */
     withCondition(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataBulkRemoveOptionsBuilder;
     /**
@@ -31,12 +31,12 @@ export interface WixDataBulkRemoveOptionsBuilder {
     build(): WixDataBulkRemoveOptions;
 }
 /**
- * Creates a new WixData bulk remove options builder.
+ * Creates a new bulk remove options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a bulk remove options builder"
  * import { items, BulkRemoveOptionsBuilder, Filter } from '@wix/data'
  *
  * const options = BulkRemoveOptionsBuilder()

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

@@ -1,6 +1,6 @@
 import type { WixDataBulkSaveOptions } from './types';
 /**
- * Builder for bulk save options used by Wix Data bulk save operations.
+ * Options builder for bulk save operations.
  *
  * Use this builder to configure bulk save behavior such as hooks suppression and reference saving.
  * @public
@@ -9,18 +9,18 @@ import type { WixDataBulkSaveOptions } from './types';
  */
 export interface WixDataBulkSaveOptionsBuilder {
     /**
-     * Sets whether hooks are suppressed.
+     * Sets whether to suppress hooks.
      *
      * When `true`, the bulk save runs without triggering hooks.
      */
     withSuppressHooks(value: boolean): WixDataBulkSaveOptionsBuilder;
     /**
-     * Sets whether draft items are included when saving items in bulk.
+     * Sets whether to include draft items when saving items in bulk.
      * @internal
      */
     withShowDrafts(value: boolean): WixDataBulkSaveOptionsBuilder;
     /**
-     * Sets whether referenced items are saved when saving items in bulk.
+     * Sets whether to save referenced items when saving items in bulk.
      */
     withSaveReferences(value: boolean): WixDataBulkSaveOptionsBuilder;
     /**
@@ -29,12 +29,12 @@ export interface WixDataBulkSaveOptionsBuilder {
     build(): WixDataBulkSaveOptions;
 }
 /**
- * Creates a new WixData bulk save options builder.
+ * Creates a new bulk save options builder.
  * @public
  * @documentationMaturity preview
  *
  * @example
- * ```ts
+ * ```ts title="Create a bulk save options builder"
  * import { items, BulkSaveOptionsBuilder } from '@wix/data'
  *
  * const options = BulkSaveOptionsBuilder()