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

package/dist/cjs/api/WixDataFieldModificationsBuilder.js.map

@@ -1 +1 @@
-{"version":3,"names":["_BaseFieldModificationsBuilder","require","WixDataFieldModificationsBuilderImpl","BaseFieldModificationsBuilder","constructor","origin","copy","params","invalidArguments","ownInvalidArguments","fieldModifications","addFieldModification","build","FieldModificationsBuilder","exports"],"sources":["../../../src/api/WixDataFieldModificationsBuilder.ts"],"sourcesContent":["import type { FieldModification } from './FieldModification'\nimport { BaseFieldModificationsBuilder } from './impl/BaseFieldModificationsBuilder'\n\n/**\n * WixData FieldModificationsBuilder type.\n * @internal\n */\nexport interface FieldModificationsBuilder<Self> {\n  /**\n   * Refines a patch operation to increment the specified field value by the specified parameter.\n   * @public\n   * @documentationMaturity preview\n   * @param field - Field whose value is incremented. Nested fields can be specified using dot notation. For example: `address.street`.\n   * @requiredField field\n   * @param by - Value by which to increment the specified field. To decrement, specify a negative value.\n   * @requiredField by\n   * @returns Updated patch object.\n   */\n  incrementField(field: string, by: number): Self\n\n  /**\n   * Refines a patch operation to set the specified field to the specified value.\n   * @public\n   * @documentationMaturity preview\n   * @param field - Field whose value is set. Nested fields can be specified using dot notation. For example: `address.street`.\n   * @requiredField field\n   * @param value - Value to set for the specified field.\n   * @requiredField value\n   * @returns Updated patch object.\n   */\n  setField(field: string, value: any): Self\n\n  /**\n   * Refines a patch operation to append the specified value to the specified array or multi-reference field.\n   * @public\n   * @documentationMaturity preview\n   * @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`.\n   * @requiredField field\n   * @param value - Value to append to the specified array or multi-reference field.\n   * @requiredField value\n   * @returns Updated patch object.\n   */\n  appendToArray(field: string, value: any): Self\n\n  /**\n   * Refines a patch operation to remove the first instance of the specified value from the specified array or multi-reference field.\n   * @public\n   * @documentationMaturity preview\n   * @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`.\n   * @requiredField field\n   * @param value - Value whose first instance is removed from the specified array or multi-reference field.\n   * @requiredField value\n   * @returns Updated patch object.\n   */\n  removeFromArray(field: string, value: any): Self\n\n  /**\n   * Refines a patch operation to clear the specified field.\n   * @public\n   * @documentationMaturity preview\n   * @param field - Field whose value is cleared. Nested fields can be specified using dot notation. For example: `address.street`.\n   * @requiredField field\n   * @returns Updated patch object.\n   */\n  removeField(field: string): Self\n}\n\n/**\n * WixData field modifications builder.\n * @internal\n */\nexport interface WixDataFieldModificationsBuilder\n  extends FieldModificationsBuilder<WixDataFieldModificationsBuilder> {\n  /** Build the final array of field modifications */\n  build(): FieldModification[]\n}\n\nclass WixDataFieldModificationsBuilderImpl\n  extends BaseFieldModificationsBuilder<WixDataFieldModificationsBuilderImpl>\n  implements WixDataFieldModificationsBuilder\n{\n  constructor(origin?: {\n    invalidArguments?: string[]\n    fieldModifications?: FieldModification[]\n  }) {\n    super(origin ?? {})\n  }\n\n  protected copy(params: {\n    invalidArguments?: string[]\n    addFieldModification: FieldModification\n  }): WixDataFieldModificationsBuilderImpl {\n    return new WixDataFieldModificationsBuilderImpl({\n      invalidArguments: params.invalidArguments ?? this.ownInvalidArguments,\n      fieldModifications: [\n        ...this.fieldModifications,\n        params.addFieldModification,\n      ],\n    })\n  }\n\n  build(): FieldModification[] {\n    return [...this.fieldModifications]\n  }\n}\n\n/**\n * Creates a new WixData field modifications builder.\n * @internal\n *\n * @example\n * ```ts\n * import { FieldModificationsBuilder } from '@wix/wix-data-items-common'\n *\n * const fieldModifications = FieldModificationsBuilder()\n *   .setField('title', 'Updated title')\n *   .incrementField('viewCount', 1)\n *   .appendToArray('tags', 'featured')\n *   .removeField('legacyField')\n *   .build()\n *\n * const item = await wixData.patch('myCollection', 'itemId', fieldModifications)\n * ```\n */\nexport const FieldModificationsBuilder: () => WixDataFieldModificationsBuilder =\n  () => new WixDataFieldModificationsBuilderImpl()\n"],"mappings":";;;;AACA,IAAAA,8BAAA,GAAAC,OAAA;AAEA;AACA;AACA;AACA;;AA6DA;AACA;AACA;AACA;;AAOA,MAAMC,oCAAoC,SAChCC,4DAA6B,CAEvC;EACEC,WAAWA,CAACC,MAGX,EAAE;IACD,KAAK,CAACA,MAAM,IAAI,CAAC,CAAC,CAAC;EACrB;EAEUC,IAAIA,CAACC,MAGd,EAAwC;IACvC,OAAO,IAAIL,oCAAoC,CAAC;MAC9CM,gBAAgB,EAAED,MAAM,CAACC,gBAAgB,IAAI,IAAI,CAACC,mBAAmB;MACrEC,kBAAkB,EAAE,CAClB,GAAG,IAAI,CAACA,kBAAkB,EAC1BH,MAAM,CAACI,oBAAoB;IAE/B,CAAC,CAAC;EACJ;EAEAC,KAAKA,CAAA,EAAwB;IAC3B,OAAO,CAAC,GAAG,IAAI,CAACF,kBAAkB,CAAC;EACrC;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMG,yBAAiE,GAC5EA,CAAA,KAAM,IAAIX,oCAAoC,CAAC,CAAC;AAAAY,OAAA,CAAAD,yBAAA,GAAAA,yBAAA","ignoreList":[]}
+{"version":3,"names":["_BaseFieldModificationsBuilder","require","WixDataFieldModificationsBuilderImpl","BaseFieldModificationsBuilder","constructor","origin","copy","params","invalidArguments","ownInvalidArguments","fieldModifications","addFieldModification","build","FieldModificationsBuilder","exports"],"sources":["../../../src/api/WixDataFieldModificationsBuilder.ts"],"sourcesContent":["import type { FieldModification } from './FieldModification'\nimport { BaseFieldModificationsBuilder } from './impl/BaseFieldModificationsBuilder'\n\n/**\n * WixData FieldModificationsBuilder type.\n * @internal\n */\nexport interface FieldModificationsBuilder<Self> {\n  /**\n   * Refines a patch operation to increment the specified field value by the specified parameter.\n   * @public\n   * @documentationMaturity preview\n   * @param field - Field whose value is incremented. Nested fields can be specified using dot notation. For example: `address.street`.\n   * @requiredField field\n   * @param by - Value by which to increment the specified field. To decrement, specify a negative value.\n   * @requiredField by\n   * @returns Updated patch object.\n   */\n  incrementField(field: string, by: number): Self\n\n  /**\n   * Refines a patch operation to set the specified field to the specified value.\n   * @public\n   * @documentationMaturity preview\n   * @param field - Field whose value is set. Nested fields can be specified using dot notation. For example: `address.street`.\n   * @requiredField field\n   * @param value - Value to set for the specified field.\n   * @requiredField value\n   * @returns Updated patch object.\n   */\n  setField(field: string, value: any): Self\n\n  /**\n   * Refines a patch operation to append the specified value to the specified array or multi-reference field.\n   * @public\n   * @documentationMaturity preview\n   * @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`.\n   * @requiredField field\n   * @param value - Value to append to the specified array or multi-reference field.\n   * @requiredField value\n   * @returns Updated patch object.\n   */\n  appendToArray(field: string, value: any): Self\n\n  /**\n   * Refines a patch operation to remove the first instance of the specified value from the specified array or multi-reference field.\n   * @public\n   * @documentationMaturity preview\n   * @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`.\n   * @requiredField field\n   * @param value - Value whose first instance is removed from the specified array or multi-reference field.\n   * @requiredField value\n   * @returns Updated patch object.\n   */\n  removeFromArray(field: string, value: any): Self\n\n  /**\n   * Refines a patch operation to clear the specified field.\n   * @public\n   * @documentationMaturity preview\n   * @param field - Field whose value is cleared. Nested fields can be specified using dot notation. For example: `address.street`.\n   * @requiredField field\n   * @returns Updated patch object.\n   */\n  removeField(field: string): Self\n}\n\n/**\n * WixData field modifications builder.\n * @internal\n */\nexport interface WixDataFieldModificationsBuilder\n  extends FieldModificationsBuilder<WixDataFieldModificationsBuilder> {\n  /** Build the final array of field modifications */\n  build(): FieldModification[]\n}\n\nclass WixDataFieldModificationsBuilderImpl\n  extends BaseFieldModificationsBuilder<WixDataFieldModificationsBuilderImpl>\n  implements WixDataFieldModificationsBuilder\n{\n  constructor(origin?: {\n    invalidArguments?: string[]\n    fieldModifications?: FieldModification[]\n  }) {\n    super(origin ?? {})\n  }\n\n  protected copy(params: {\n    invalidArguments?: string[]\n    addFieldModification: FieldModification\n  }): WixDataFieldModificationsBuilderImpl {\n    return new WixDataFieldModificationsBuilderImpl({\n      invalidArguments: params.invalidArguments ?? this.ownInvalidArguments,\n      fieldModifications: [\n        ...this.fieldModifications,\n        params.addFieldModification,\n      ],\n    })\n  }\n\n  build(): FieldModification[] {\n    return [...this.fieldModifications]\n  }\n}\n\n/**\n * Creates a new WixData field modifications builder.\n * @internal\n *\n * @example\n * ```ts\n * import { FieldModificationsBuilder } from '@wix/data'\n *\n * const fieldModifications = FieldModificationsBuilder()\n *   .setField('title', 'Updated title')\n *   .incrementField('viewCount', 1)\n *   .appendToArray('tags', 'featured')\n *   .removeField('legacyField')\n *   .build()\n *\n * const item = await wixData.patch('myCollection', 'itemId', fieldModifications)\n * ```\n */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const FieldModificationsBuilder: () => WixDataFieldModificationsBuilder =\n  () => new WixDataFieldModificationsBuilderImpl()\n"],"mappings":";;;;AACA,IAAAA,8BAAA,GAAAC,OAAA;AAEA;AACA;AACA;AACA;;AA6DA;AACA;AACA;AACA;;AAOA,MAAMC,oCAAoC,SAChCC,4DAA6B,CAEvC;EACEC,WAAWA,CAACC,MAGX,EAAE;IACD,KAAK,CAACA,MAAM,IAAI,CAAC,CAAC,CAAC;EACrB;EAEUC,IAAIA,CAACC,MAGd,EAAwC;IACvC,OAAO,IAAIL,oCAAoC,CAAC;MAC9CM,gBAAgB,EAAED,MAAM,CAACC,gBAAgB,IAAI,IAAI,CAACC,mBAAmB;MACrEC,kBAAkB,EAAE,CAClB,GAAG,IAAI,CAACA,kBAAkB,EAC1BH,MAAM,CAACI,oBAAoB;IAE/B,CAAC,CAAC;EACJ;EAEAC,KAAKA,CAAA,EAAwB;IAC3B,OAAO,CAAC,GAAG,IAAI,CAACF,kBAAkB,CAAC;EACrC;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMG,yBAAiE,GAC5EA,CAAA,KAAM,IAAIX,oCAAoC,CAAC,CAAC;AAAAY,OAAA,CAAAD,yBAAA,GAAAA,yBAAA","ignoreList":[]}

package/dist/cjs/api/WixDataGetOptionsBuilder.js

@@ -3,8 +3,14 @@
 exports.__esModule = true;
 exports.GetOptionsBuilder = void 0;
 /**
- * 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
  */
 
 class WixDataGetOptionsBuilderImpl {
@@ -86,7 +92,25 @@ class WixDataGetOptionsBuilderImpl {
 
 /**
  * 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)
+ * ```
  */
 const GetOptionsBuilder = () => new WixDataGetOptionsBuilderImpl();
 exports.GetOptionsBuilder = GetOptionsBuilder;

package/dist/cjs/api/WixDataGetOptionsBuilder.js.map

@@ -1 +1 @@
-{"version":3,"names":["WixDataGetOptionsBuilderImpl","constructor","options","withSuppressHooks","value","copy","suppressHooks","withShowDrafts","showDrafts","withAppOptions","appOptions","withLanguage","language","withConsistentRead","consistentRead","withFields","fields","withIncludeReferences","includeReferences","map","includeReference","withIncludeFieldGroups","includeFieldGroups","build","GetOptionsBuilder","exports"],"sources":["../../../src/api/WixDataGetOptionsBuilder.ts"],"sourcesContent":["import type { WixDataGetOptions } from './types'\n\n/**\n * WixData get options builder.\n * @internal\n */\nexport interface WixDataGetOptionsBuilder {\n  withSuppressHooks(value: boolean): WixDataGetOptionsBuilder\n  withShowDrafts(value: boolean): WixDataGetOptionsBuilder\n  withAppOptions(value: Record<string, any>): WixDataGetOptionsBuilder\n  withLanguage(value: string): WixDataGetOptionsBuilder\n  withConsistentRead(value: boolean): WixDataGetOptionsBuilder\n  withFields(...value: string[]): WixDataGetOptionsBuilder\n  withIncludeReferences(\n    value: { field: string; limit?: number }[]\n  ): WixDataGetOptionsBuilder\n  withIncludeFieldGroups(...value: string[]): WixDataGetOptionsBuilder\n  build(): WixDataGetOptions\n}\n\nclass WixDataGetOptionsBuilderImpl implements WixDataGetOptionsBuilder {\n  constructor(private readonly options: WixDataGetOptions = {}) {}\n\n  withSuppressHooks(value: boolean): WixDataGetOptionsBuilder {\n    return this.copy({ suppressHooks: value })\n  }\n\n  withShowDrafts(value: boolean): WixDataGetOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withAppOptions(value: Record<string, any>): WixDataGetOptionsBuilder {\n    return this.copy({ appOptions: { ...value } })\n  }\n\n  withLanguage(value: string): WixDataGetOptionsBuilder {\n    return this.copy({ language: value })\n  }\n\n  withConsistentRead(value: boolean): WixDataGetOptionsBuilder {\n    return this.copy({ consistentRead: value })\n  }\n\n  withFields(...value: string[]): WixDataGetOptionsBuilder {\n    return this.copy({ fields: [...value] })\n  }\n\n  withIncludeReferences(\n    value: { field: string; limit?: number }[]\n  ): WixDataGetOptionsBuilder {\n    return this.copy({\n      includeReferences: value.map((includeReference) => ({\n        ...includeReference,\n      })),\n    })\n  }\n\n  withIncludeFieldGroups(...value: string[]): WixDataGetOptionsBuilder {\n    return this.copy({ includeFieldGroups: [...value] })\n  }\n\n  build(): WixDataGetOptions {\n    return {\n      ...this.options,\n      ...(this.options.appOptions\n        ? { appOptions: { ...this.options.appOptions } }\n        : {}),\n      ...(this.options.fields ? { fields: [...this.options.fields] } : {}),\n      ...(this.options.includeReferences\n        ? {\n            includeReferences: this.options.includeReferences.map(\n              (includeReference) => ({ ...includeReference })\n            ),\n          }\n        : {}),\n      ...(this.options.includeFieldGroups\n        ? { includeFieldGroups: [...this.options.includeFieldGroups] }\n        : {}),\n    }\n  }\n\n  private copy(options: WixDataGetOptions): WixDataGetOptionsBuilder {\n    return new WixDataGetOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData get options builder.\n * @internal\n */\nexport const GetOptionsBuilder: () => WixDataGetOptionsBuilder = () =>\n  new WixDataGetOptionsBuilderImpl()\n"],"mappings":";;;;AAEA;AACA;AACA;AACA;;AAeA,MAAMA,4BAA4B,CAAqC;EACrEC,WAAWA,CAAkBC,OAA0B,GAAG,CAAC,CAAC,EAAE;IAAA,KAAjCA,OAA0B,GAA1BA,OAA0B;EAAQ;EAE/DC,iBAAiBA,CAACC,KAAc,EAA4B;IAC1D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,aAAa,EAAEF;IAAM,CAAC,CAAC;EAC5C;EAEAG,cAAcA,CAACH,KAAc,EAA4B;IACvD,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAEJ;IAAM,CAAC,CAAC;EACzC;EAEAK,cAAcA,CAACL,KAA0B,EAA4B;IACnE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,UAAU,EAAE;QAAE,GAAGN;MAAM;IAAE,CAAC,CAAC;EAChD;EAEAO,YAAYA,CAACP,KAAa,EAA4B;IACpD,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEO,QAAQ,EAAER;IAAM,CAAC,CAAC;EACvC;EAEAS,kBAAkBA,CAACT,KAAc,EAA4B;IAC3D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAES,cAAc,EAAEV;IAAM,CAAC,CAAC;EAC7C;EAEAW,UAAUA,CAAC,GAAGX,KAAe,EAA4B;IACvD,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEW,MAAM,EAAE,CAAC,GAAGZ,KAAK;IAAE,CAAC,CAAC;EAC1C;EAEAa,qBAAqBA,CACnBb,KAA0C,EAChB;IAC1B,OAAO,IAAI,CAACC,IAAI,CAAC;MACfa,iBAAiB,EAAEd,KAAK,CAACe,GAAG,CAAEC,gBAAgB,KAAM;QAClD,GAAGA;MACL,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ;EAEAC,sBAAsBA,CAAC,GAAGjB,KAAe,EAA4B;IACnE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEiB,kBAAkB,EAAE,CAAC,GAAGlB,KAAK;IAAE,CAAC,CAAC;EACtD;EAEAmB,KAAKA,CAAA,EAAsB;IACzB,OAAO;MACL,GAAG,IAAI,CAACrB,OAAO;MACf,IAAI,IAAI,CAACA,OAAO,CAACQ,UAAU,GACvB;QAAEA,UAAU,EAAE;UAAE,GAAG,IAAI,CAACR,OAAO,CAACQ;QAAW;MAAE,CAAC,GAC9C,CAAC,CAAC,CAAC;MACP,IAAI,IAAI,CAACR,OAAO,CAACc,MAAM,GAAG;QAAEA,MAAM,EAAE,CAAC,GAAG,IAAI,CAACd,OAAO,CAACc,MAAM;MAAE,CAAC,GAAG,CAAC,CAAC,CAAC;MACpE,IAAI,IAAI,CAACd,OAAO,CAACgB,iBAAiB,GAC9B;QACEA,iBAAiB,EAAE,IAAI,CAAChB,OAAO,CAACgB,iBAAiB,CAACC,GAAG,CAClDC,gBAAgB,KAAM;UAAE,GAAGA;QAAiB,CAAC,CAChD;MACF,CAAC,GACD,CAAC,CAAC,CAAC;MACP,IAAI,IAAI,CAAClB,OAAO,CAACoB,kBAAkB,GAC/B;QAAEA,kBAAkB,EAAE,CAAC,GAAG,IAAI,CAACpB,OAAO,CAACoB,kBAAkB;MAAE,CAAC,GAC5D,CAAC,CAAC;IACR,CAAC;EACH;EAEQjB,IAAIA,CAACH,OAA0B,EAA4B;IACjE,OAAO,IAAIF,4BAA4B,CAAC;MACtC,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACO,MAAMsB,iBAAiD,GAAGA,CAAA,KAC/D,IAAIxB,4BAA4B,CAAC,CAAC;AAAAyB,OAAA,CAAAD,iBAAA,GAAAA,iBAAA","ignoreList":[]}
+{"version":3,"names":["WixDataGetOptionsBuilderImpl","constructor","options","withSuppressHooks","value","copy","suppressHooks","withShowDrafts","showDrafts","withAppOptions","appOptions","withLanguage","language","withConsistentRead","consistentRead","withFields","fields","withIncludeReferences","includeReferences","map","includeReference","withIncludeFieldGroups","includeFieldGroups","build","GetOptionsBuilder","exports"],"sources":["../../../src/api/WixDataGetOptionsBuilder.ts"],"sourcesContent":["import type { WixDataGetOptions } from './types'\n\n/**\n * Builder for get options used by Wix Data get operations.\n *\n * Use this builder to configure get behavior such as hooks suppression,\n * app-specific options, language, consistency, selected\n * fields, references, and field groups.\n * @public\n * @builder\n * @documentationMaturity preview\n */\nexport interface WixDataGetOptionsBuilder {\n  /**\n   * Sets whether get hooks are suppressed.\n   *\n   * When `true`, the get operation runs without triggering hooks.\n   */\n  withSuppressHooks(value: boolean): WixDataGetOptionsBuilder\n  /**\n   * Sets whether draft items are included when retrieving an item.\n   * @internal\n   */\n  withShowDrafts(value: boolean): WixDataGetOptionsBuilder\n  /**\n   * Sets app-specific options for the get operation.\n   */\n  withAppOptions(value: Record<string, any>): WixDataGetOptionsBuilder\n  /**\n   * Sets the language used for the get operation.\n   */\n  withLanguage(value: string): WixDataGetOptionsBuilder\n  /**\n   * Sets whether the get operation uses a consistent read.\n   */\n  withConsistentRead(value: boolean): WixDataGetOptionsBuilder\n  /**\n   * Sets the fields to include in the returned item.\n   */\n  withFields(...value: string[]): WixDataGetOptionsBuilder\n  /**\n   * Sets referenced fields to include in the returned item.\n   */\n  withIncludeReferences(\n    value: { field: string; limit?: number }[]\n  ): WixDataGetOptionsBuilder\n  /**\n   * Sets the field groups to include in the returned item.\n   */\n  withIncludeFieldGroups(...value: string[]): WixDataGetOptionsBuilder\n  /**\n   * Builds the get options object.\n   */\n  build(): WixDataGetOptions\n}\n\nclass WixDataGetOptionsBuilderImpl implements WixDataGetOptionsBuilder {\n  constructor(private readonly options: WixDataGetOptions = {}) {}\n\n  withSuppressHooks(value: boolean): WixDataGetOptionsBuilder {\n    return this.copy({ suppressHooks: value })\n  }\n\n  withShowDrafts(value: boolean): WixDataGetOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withAppOptions(value: Record<string, any>): WixDataGetOptionsBuilder {\n    return this.copy({ appOptions: { ...value } })\n  }\n\n  withLanguage(value: string): WixDataGetOptionsBuilder {\n    return this.copy({ language: value })\n  }\n\n  withConsistentRead(value: boolean): WixDataGetOptionsBuilder {\n    return this.copy({ consistentRead: value })\n  }\n\n  withFields(...value: string[]): WixDataGetOptionsBuilder {\n    return this.copy({ fields: [...value] })\n  }\n\n  withIncludeReferences(\n    value: { field: string; limit?: number }[]\n  ): WixDataGetOptionsBuilder {\n    return this.copy({\n      includeReferences: value.map((includeReference) => ({\n        ...includeReference,\n      })),\n    })\n  }\n\n  withIncludeFieldGroups(...value: string[]): WixDataGetOptionsBuilder {\n    return this.copy({ includeFieldGroups: [...value] })\n  }\n\n  build(): WixDataGetOptions {\n    return {\n      ...this.options,\n      ...(this.options.appOptions\n        ? { appOptions: { ...this.options.appOptions } }\n        : {}),\n      ...(this.options.fields ? { fields: [...this.options.fields] } : {}),\n      ...(this.options.includeReferences\n        ? {\n            includeReferences: this.options.includeReferences.map(\n              (includeReference) => ({ ...includeReference })\n            ),\n          }\n        : {}),\n      ...(this.options.includeFieldGroups\n        ? { includeFieldGroups: [...this.options.includeFieldGroups] }\n        : {}),\n    }\n  }\n\n  private copy(options: WixDataGetOptions): WixDataGetOptionsBuilder {\n    return new WixDataGetOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData get options builder.\n * @public\n * @documentationMaturity preview\n *\n * @example\n * ```ts\n * import { items, GetOptionsBuilder } from '@wix/data'\n *\n * const options = GetOptionsBuilder()\n *   .withSuppressHooks(true)\n *   .withAppOptions({ key: 'value' })\n *   .withLanguage('es')\n *   .withConsistentRead(true)\n *   .withFields('_id', 'foo')\n *   .withIncludeReferences([{ field: 'author', limit: 1 }])\n *   .withIncludeFieldGroups('group-a')\n *   .build()\n *\n * const item = await items.get('myCollection', 'someId', options)\n * ```\n */\nexport const GetOptionsBuilder: () => WixDataGetOptionsBuilder = () =>\n  new WixDataGetOptionsBuilderImpl()\n"],"mappings":";;;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA6CA,MAAMA,4BAA4B,CAAqC;EACrEC,WAAWA,CAAkBC,OAA0B,GAAG,CAAC,CAAC,EAAE;IAAA,KAAjCA,OAA0B,GAA1BA,OAA0B;EAAQ;EAE/DC,iBAAiBA,CAACC,KAAc,EAA4B;IAC1D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,aAAa,EAAEF;IAAM,CAAC,CAAC;EAC5C;EAEAG,cAAcA,CAACH,KAAc,EAA4B;IACvD,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAEJ;IAAM,CAAC,CAAC;EACzC;EAEAK,cAAcA,CAACL,KAA0B,EAA4B;IACnE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,UAAU,EAAE;QAAE,GAAGN;MAAM;IAAE,CAAC,CAAC;EAChD;EAEAO,YAAYA,CAACP,KAAa,EAA4B;IACpD,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEO,QAAQ,EAAER;IAAM,CAAC,CAAC;EACvC;EAEAS,kBAAkBA,CAACT,KAAc,EAA4B;IAC3D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAES,cAAc,EAAEV;IAAM,CAAC,CAAC;EAC7C;EAEAW,UAAUA,CAAC,GAAGX,KAAe,EAA4B;IACvD,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEW,MAAM,EAAE,CAAC,GAAGZ,KAAK;IAAE,CAAC,CAAC;EAC1C;EAEAa,qBAAqBA,CACnBb,KAA0C,EAChB;IAC1B,OAAO,IAAI,CAACC,IAAI,CAAC;MACfa,iBAAiB,EAAEd,KAAK,CAACe,GAAG,CAAEC,gBAAgB,KAAM;QAClD,GAAGA;MACL,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ;EAEAC,sBAAsBA,CAAC,GAAGjB,KAAe,EAA4B;IACnE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEiB,kBAAkB,EAAE,CAAC,GAAGlB,KAAK;IAAE,CAAC,CAAC;EACtD;EAEAmB,KAAKA,CAAA,EAAsB;IACzB,OAAO;MACL,GAAG,IAAI,CAACrB,OAAO;MACf,IAAI,IAAI,CAACA,OAAO,CAACQ,UAAU,GACvB;QAAEA,UAAU,EAAE;UAAE,GAAG,IAAI,CAACR,OAAO,CAACQ;QAAW;MAAE,CAAC,GAC9C,CAAC,CAAC,CAAC;MACP,IAAI,IAAI,CAACR,OAAO,CAACc,MAAM,GAAG;QAAEA,MAAM,EAAE,CAAC,GAAG,IAAI,CAACd,OAAO,CAACc,MAAM;MAAE,CAAC,GAAG,CAAC,CAAC,CAAC;MACpE,IAAI,IAAI,CAACd,OAAO,CAACgB,iBAAiB,GAC9B;QACEA,iBAAiB,EAAE,IAAI,CAAChB,OAAO,CAACgB,iBAAiB,CAACC,GAAG,CAClDC,gBAAgB,KAAM;UAAE,GAAGA;QAAiB,CAAC,CAChD;MACF,CAAC,GACD,CAAC,CAAC,CAAC;MACP,IAAI,IAAI,CAAClB,OAAO,CAACoB,kBAAkB,GAC/B;QAAEA,kBAAkB,EAAE,CAAC,GAAG,IAAI,CAACpB,OAAO,CAACoB,kBAAkB;MAAE,CAAC,GAC5D,CAAC,CAAC;IACR,CAAC;EACH;EAEQjB,IAAIA,CAACH,OAA0B,EAA4B;IACjE,OAAO,IAAIF,4BAA4B,CAAC;MACtC,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMsB,iBAAiD,GAAGA,CAAA,KAC/D,IAAIxB,4BAA4B,CAAC,CAAC;AAAAyB,OAAA,CAAAD,iBAAA,GAAAA,iBAAA","ignoreList":[]}

package/dist/cjs/api/WixDataInsertOptionsBuilder.js

@@ -3,8 +3,13 @@
 exports.__esModule = true;
 exports.InsertOptionsBuilder = void 0;
 /**
- * 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
  */
 
 class WixDataInsertOptionsBuilderImpl {
@@ -46,7 +51,19 @@ class WixDataInsertOptionsBuilderImpl {
 
 /**
  * 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)
+ * ```
  */
 const InsertOptionsBuilder = () => new WixDataInsertOptionsBuilderImpl();
 exports.InsertOptionsBuilder = InsertOptionsBuilder;

package/dist/cjs/api/WixDataInsertOptionsBuilder.js.map

@@ -1 +1 @@
-{"version":3,"names":["WixDataInsertOptionsBuilderImpl","constructor","options","withSuppressHooks","value","copy","suppressHooks","withShowDrafts","showDrafts","withIncludeReferences","includeReferences","withSaveReferences","saveReferences","build","InsertOptionsBuilder","exports"],"sources":["../../../src/api/WixDataInsertOptionsBuilder.ts"],"sourcesContent":["import type { WixDataInsertOptions } from './types'\n\n/**\n * WixData insert options builder.\n * @internal\n */\nexport interface WixDataInsertOptionsBuilder {\n  withSuppressHooks(value: boolean): WixDataInsertOptionsBuilder\n  withShowDrafts(value: boolean): WixDataInsertOptionsBuilder\n  withIncludeReferences(value: boolean): WixDataInsertOptionsBuilder\n  withSaveReferences(value: boolean): WixDataInsertOptionsBuilder\n  build(): WixDataInsertOptions\n}\n\nclass WixDataInsertOptionsBuilderImpl implements WixDataInsertOptionsBuilder {\n  constructor(private readonly options: WixDataInsertOptions = {}) {}\n\n  withSuppressHooks(value: boolean): WixDataInsertOptionsBuilder {\n    return this.copy({ suppressHooks: value })\n  }\n\n  withShowDrafts(value: boolean): WixDataInsertOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withIncludeReferences(value: boolean): WixDataInsertOptionsBuilder {\n    return this.copy({ includeReferences: value })\n  }\n\n  withSaveReferences(value: boolean): WixDataInsertOptionsBuilder {\n    return this.copy({ saveReferences: value })\n  }\n\n  build(): WixDataInsertOptions {\n    return { ...this.options }\n  }\n\n  private copy(options: WixDataInsertOptions): WixDataInsertOptionsBuilder {\n    return new WixDataInsertOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData insert options builder.\n * @internal\n */\nexport const InsertOptionsBuilder: () => WixDataInsertOptionsBuilder = () =>\n  new WixDataInsertOptionsBuilderImpl()\n"],"mappings":";;;;AAEA;AACA;AACA;AACA;;AASA,MAAMA,+BAA+B,CAAwC;EAC3EC,WAAWA,CAAkBC,OAA6B,GAAG,CAAC,CAAC,EAAE;IAAA,KAApCA,OAA6B,GAA7BA,OAA6B;EAAQ;EAElEC,iBAAiBA,CAACC,KAAc,EAA+B;IAC7D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,aAAa,EAAEF;IAAM,CAAC,CAAC;EAC5C;EAEAG,cAAcA,CAACH,KAAc,EAA+B;IAC1D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAEJ;IAAM,CAAC,CAAC;EACzC;EAEAK,qBAAqBA,CAACL,KAAc,EAA+B;IACjE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,iBAAiB,EAAEN;IAAM,CAAC,CAAC;EAChD;EAEAO,kBAAkBA,CAACP,KAAc,EAA+B;IAC9D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEO,cAAc,EAAER;IAAM,CAAC,CAAC;EAC7C;EAEAS,KAAKA,CAAA,EAAyB;IAC5B,OAAO;MAAE,GAAG,IAAI,CAACX;IAAQ,CAAC;EAC5B;EAEQG,IAAIA,CAACH,OAA6B,EAA+B;IACvE,OAAO,IAAIF,+BAA+B,CAAC;MACzC,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACO,MAAMY,oBAAuD,GAAGA,CAAA,KACrE,IAAId,+BAA+B,CAAC,CAAC;AAAAe,OAAA,CAAAD,oBAAA,GAAAA,oBAAA","ignoreList":[]}
+{"version":3,"names":["WixDataInsertOptionsBuilderImpl","constructor","options","withSuppressHooks","value","copy","suppressHooks","withShowDrafts","showDrafts","withIncludeReferences","includeReferences","withSaveReferences","saveReferences","build","InsertOptionsBuilder","exports"],"sources":["../../../src/api/WixDataInsertOptionsBuilder.ts"],"sourcesContent":["import type { WixDataInsertOptions } from './types'\n\n/**\n * Builder for insert options used by Wix Data insert operations.\n *\n * Use this builder to configure insert behavior such as hooks suppression,\n * and reference handling.\n * @public\n * @builder\n * @documentationMaturity preview\n */\nexport interface WixDataInsertOptionsBuilder {\n  /**\n   * Sets whether insert hooks are suppressed.\n   *\n   * When `true`, the insert runs without triggering hooks.\n   */\n  withSuppressHooks(value: boolean): WixDataInsertOptionsBuilder\n  /**\n   * Sets whether draft items are included when inserting an item.\n   * @internal\n   */\n  withShowDrafts(value: boolean): WixDataInsertOptionsBuilder\n  /**\n   * Sets whether references are included when inserting an item.\n   * @internal\n   */\n  withIncludeReferences(value: boolean): WixDataInsertOptionsBuilder\n  /**\n   * Sets whether referenced items are saved when inserting an item.\n   */\n  withSaveReferences(value: boolean): WixDataInsertOptionsBuilder\n  /**\n   * Builds the insert options object.\n   */\n  build(): WixDataInsertOptions\n}\n\nclass WixDataInsertOptionsBuilderImpl implements WixDataInsertOptionsBuilder {\n  constructor(private readonly options: WixDataInsertOptions = {}) {}\n\n  withSuppressHooks(value: boolean): WixDataInsertOptionsBuilder {\n    return this.copy({ suppressHooks: value })\n  }\n\n  withShowDrafts(value: boolean): WixDataInsertOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withIncludeReferences(value: boolean): WixDataInsertOptionsBuilder {\n    return this.copy({ includeReferences: value })\n  }\n\n  withSaveReferences(value: boolean): WixDataInsertOptionsBuilder {\n    return this.copy({ saveReferences: value })\n  }\n\n  build(): WixDataInsertOptions {\n    return { ...this.options }\n  }\n\n  private copy(options: WixDataInsertOptions): WixDataInsertOptionsBuilder {\n    return new WixDataInsertOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData insert options builder.\n * @public\n * @documentationMaturity preview\n *\n * @example\n * ```ts\n * import { items, InsertOptionsBuilder } from '@wix/data'\n *\n * const options = InsertOptionsBuilder()\n *   .withSuppressHooks(true)\n *   .build()\n *\n * const item = await items.insert('myCollection', { foo: 'bar' }, options)\n * ```\n */\nexport const InsertOptionsBuilder: () => WixDataInsertOptionsBuilder = () =>\n  new WixDataInsertOptionsBuilderImpl()\n"],"mappings":";;;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA4BA,MAAMA,+BAA+B,CAAwC;EAC3EC,WAAWA,CAAkBC,OAA6B,GAAG,CAAC,CAAC,EAAE;IAAA,KAApCA,OAA6B,GAA7BA,OAA6B;EAAQ;EAElEC,iBAAiBA,CAACC,KAAc,EAA+B;IAC7D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,aAAa,EAAEF;IAAM,CAAC,CAAC;EAC5C;EAEAG,cAAcA,CAACH,KAAc,EAA+B;IAC1D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAEJ;IAAM,CAAC,CAAC;EACzC;EAEAK,qBAAqBA,CAACL,KAAc,EAA+B;IACjE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,iBAAiB,EAAEN;IAAM,CAAC,CAAC;EAChD;EAEAO,kBAAkBA,CAACP,KAAc,EAA+B;IAC9D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEO,cAAc,EAAER;IAAM,CAAC,CAAC;EAC7C;EAEAS,KAAKA,CAAA,EAAyB;IAC5B,OAAO;MAAE,GAAG,IAAI,CAACX;IAAQ,CAAC;EAC5B;EAEQG,IAAIA,CAACH,OAA6B,EAA+B;IACvE,OAAO,IAAIF,+BAA+B,CAAC;MACzC,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMY,oBAAuD,GAAGA,CAAA,KACrE,IAAId,+BAA+B,CAAC,CAAC;AAAAe,OAAA,CAAAD,oBAAA,GAAAA,oBAAA","ignoreList":[]}

package/dist/cjs/api/WixDataIsReferencedOptionsBuilder.js

@@ -3,8 +3,12 @@
 exports.__esModule = true;
 exports.IsReferencedOptionsBuilder = void 0;
 /**
- * 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
  */
 
 class WixDataIsReferencedOptionsBuilderImpl {
@@ -31,7 +35,25 @@ class WixDataIsReferencedOptionsBuilderImpl {
 
 /**
  * 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
+ * )
+ * ```
  */
 const IsReferencedOptionsBuilder = () => new WixDataIsReferencedOptionsBuilderImpl();
 exports.IsReferencedOptionsBuilder = IsReferencedOptionsBuilder;

package/dist/cjs/api/WixDataIsReferencedOptionsBuilder.js.map

@@ -1 +1 @@
-{"version":3,"names":["WixDataIsReferencedOptionsBuilderImpl","constructor","options","withConsistentRead","value","copy","consistentRead","build","IsReferencedOptionsBuilder","exports"],"sources":["../../../src/api/WixDataIsReferencedOptionsBuilder.ts"],"sourcesContent":["import type { WixDataIsReferencedOptions } from './types'\n\n/**\n * WixData isReferenced options builder.\n * @internal\n */\nexport interface WixDataIsReferencedOptionsBuilder {\n  withConsistentRead(value: boolean): WixDataIsReferencedOptionsBuilder\n  build(): WixDataIsReferencedOptions\n}\n\nclass WixDataIsReferencedOptionsBuilderImpl\n  implements WixDataIsReferencedOptionsBuilder\n{\n  constructor(private readonly options: WixDataIsReferencedOptions = {}) {}\n\n  withConsistentRead(value: boolean): WixDataIsReferencedOptionsBuilder {\n    return this.copy({ consistentRead: value })\n  }\n\n  build(): WixDataIsReferencedOptions {\n    return {\n      ...this.options,\n    }\n  }\n\n  private copy(\n    options: WixDataIsReferencedOptions\n  ): WixDataIsReferencedOptionsBuilder {\n    return new WixDataIsReferencedOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData isReferenced options builder.\n * @internal\n */\nexport const IsReferencedOptionsBuilder: () => WixDataIsReferencedOptionsBuilder =\n  () => new WixDataIsReferencedOptionsBuilderImpl()\n"],"mappings":";;;;AAEA;AACA;AACA;AACA;;AAMA,MAAMA,qCAAqC,CAE3C;EACEC,WAAWA,CAAkBC,OAAmC,GAAG,CAAC,CAAC,EAAE;IAAA,KAA1CA,OAAmC,GAAnCA,OAAmC;EAAQ;EAExEC,kBAAkBA,CAACC,KAAc,EAAqC;IACpE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,cAAc,EAAEF;IAAM,CAAC,CAAC;EAC7C;EAEAG,KAAKA,CAAA,EAA+B;IAClC,OAAO;MACL,GAAG,IAAI,CAACL;IACV,CAAC;EACH;EAEQG,IAAIA,CACVH,OAAmC,EACA;IACnC,OAAO,IAAIF,qCAAqC,CAAC;MAC/C,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACO,MAAMM,0BAAmE,GAC9EA,CAAA,KAAM,IAAIR,qCAAqC,CAAC,CAAC;AAAAS,OAAA,CAAAD,0BAAA,GAAAA,0BAAA","ignoreList":[]}
+{"version":3,"names":["WixDataIsReferencedOptionsBuilderImpl","constructor","options","withConsistentRead","value","copy","consistentRead","build","IsReferencedOptionsBuilder","exports"],"sources":["../../../src/api/WixDataIsReferencedOptionsBuilder.ts"],"sourcesContent":["import type { WixDataIsReferencedOptions } from './types'\n\n/**\n * Builder for isReferenced options used by Wix Data isReferenced operations.\n *\n * Use this builder to configure whether the reference check uses a consistent read.\n * @public\n * @builder\n * @documentationMaturity preview\n */\nexport interface WixDataIsReferencedOptionsBuilder {\n  /**\n   * Sets whether the reference check uses a consistent read.\n   */\n  withConsistentRead(value: boolean): WixDataIsReferencedOptionsBuilder\n  /**\n   * Builds the isReferenced options object.\n   */\n  build(): WixDataIsReferencedOptions\n}\n\nclass WixDataIsReferencedOptionsBuilderImpl\n  implements WixDataIsReferencedOptionsBuilder\n{\n  constructor(private readonly options: WixDataIsReferencedOptions = {}) {}\n\n  withConsistentRead(value: boolean): WixDataIsReferencedOptionsBuilder {\n    return this.copy({ consistentRead: value })\n  }\n\n  build(): WixDataIsReferencedOptions {\n    return {\n      ...this.options,\n    }\n  }\n\n  private copy(\n    options: WixDataIsReferencedOptions\n  ): WixDataIsReferencedOptionsBuilder {\n    return new WixDataIsReferencedOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData isReferenced options builder.\n * @public\n * @documentationMaturity preview\n *\n * @example\n * ```ts\n * import { items, IsReferencedOptionsBuilder } from '@wix/data'\n *\n * const options = IsReferencedOptionsBuilder()\n *   .withConsistentRead(true)\n *   .build()\n *\n * const isReferenced = await items.isReferenced(\n *   'myCollection',\n *   'someField',\n *   'referringItemId',\n *   'referencedItemId',\n *   options\n * )\n * ```\n */\nexport const IsReferencedOptionsBuilder: () => WixDataIsReferencedOptionsBuilder =\n  () => new WixDataIsReferencedOptionsBuilderImpl()\n"],"mappings":";;;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA,MAAMA,qCAAqC,CAE3C;EACEC,WAAWA,CAAkBC,OAAmC,GAAG,CAAC,CAAC,EAAE;IAAA,KAA1CA,OAAmC,GAAnCA,OAAmC;EAAQ;EAExEC,kBAAkBA,CAACC,KAAc,EAAqC;IACpE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,cAAc,EAAEF;IAAM,CAAC,CAAC;EAC7C;EAEAG,KAAKA,CAAA,EAA+B;IAClC,OAAO;MACL,GAAG,IAAI,CAACL;IACV,CAAC;EACH;EAEQG,IAAIA,CACVH,OAAmC,EACA;IACnC,OAAO,IAAIF,qCAAqC,CAAC;MAC/C,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMM,0BAAmE,GAC9EA,CAAA,KAAM,IAAIR,qCAAqC,CAAC,CAAC;AAAAS,OAAA,CAAAD,0BAAA,GAAAA,0BAAA","ignoreList":[]}

package/dist/cjs/api/WixDataPatchOptionsBuilder.js

@@ -3,8 +3,13 @@
 exports.__esModule = true;
 exports.PatchOptionsBuilder = void 0;
 /**
- * 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
  */
 
 class WixDataPatchOptionsBuilderImpl {
@@ -41,7 +46,20 @@ class WixDataPatchOptionsBuilderImpl {
 
 /**
  * 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)
+ * ```
  */
 const PatchOptionsBuilder = () => new WixDataPatchOptionsBuilderImpl();
 exports.PatchOptionsBuilder = PatchOptionsBuilder;

package/dist/cjs/api/WixDataPatchOptionsBuilder.js.map

@@ -1 +1 @@
-{"version":3,"names":["WixDataPatchOptionsBuilderImpl","constructor","options","withSuppressHooks","value","copy","suppressHooks","withShowDrafts","showDrafts","withCondition","condition","filter","build","PatchOptionsBuilder","exports"],"sources":["../../../src/api/WixDataPatchOptionsBuilder.ts"],"sourcesContent":["import type { FilterExpression } from '@wix/sdk-types'\nimport type { WixDataItem, WixDataQuerySpec } from './types'\nimport type { WixDataPatchOptions } from './WixDataPatch'\n\n/**\n * WixData patch options builder.\n * @internal\n */\nexport interface WixDataPatchOptionsBuilder {\n  withSuppressHooks(value: boolean): WixDataPatchOptionsBuilder\n  withShowDrafts(value: boolean): WixDataPatchOptionsBuilder\n  withCondition(\n    value: FilterExpression<WixDataItem, WixDataQuerySpec>\n  ): WixDataPatchOptionsBuilder\n  build(): WixDataPatchOptions\n}\n\nclass WixDataPatchOptionsBuilderImpl implements WixDataPatchOptionsBuilder {\n  constructor(private readonly options: WixDataPatchOptions = {}) {}\n\n  withSuppressHooks(value: boolean): WixDataPatchOptionsBuilder {\n    return this.copy({ suppressHooks: value })\n  }\n\n  withShowDrafts(value: boolean): WixDataPatchOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withCondition(\n    value: FilterExpression<WixDataItem, WixDataQuerySpec>\n  ): WixDataPatchOptionsBuilder {\n    return this.copy({ condition: value.filter })\n  }\n\n  build(): WixDataPatchOptions {\n    return {\n      ...this.options,\n    }\n  }\n\n  private copy(options: WixDataPatchOptions): WixDataPatchOptionsBuilder {\n    return new WixDataPatchOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData patch options builder.\n * @internal\n */\nexport const PatchOptionsBuilder: () => WixDataPatchOptionsBuilder = () =>\n  new WixDataPatchOptionsBuilderImpl()\n"],"mappings":";;;;AAIA;AACA;AACA;AACA;;AAUA,MAAMA,8BAA8B,CAAuC;EACzEC,WAAWA,CAAkBC,OAA4B,GAAG,CAAC,CAAC,EAAE;IAAA,KAAnCA,OAA4B,GAA5BA,OAA4B;EAAQ;EAEjEC,iBAAiBA,CAACC,KAAc,EAA8B;IAC5D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,aAAa,EAAEF;IAAM,CAAC,CAAC;EAC5C;EAEAG,cAAcA,CAACH,KAAc,EAA8B;IACzD,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAEJ;IAAM,CAAC,CAAC;EACzC;EAEAK,aAAaA,CACXL,KAAsD,EAC1B;IAC5B,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,SAAS,EAAEN,KAAK,CAACO;IAAO,CAAC,CAAC;EAC/C;EAEAC,KAAKA,CAAA,EAAwB;IAC3B,OAAO;MACL,GAAG,IAAI,CAACV;IACV,CAAC;EACH;EAEQG,IAAIA,CAACH,OAA4B,EAA8B;IACrE,OAAO,IAAIF,8BAA8B,CAAC;MACxC,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACO,MAAMW,mBAAqD,GAAGA,CAAA,KACnE,IAAIb,8BAA8B,CAAC,CAAC;AAAAc,OAAA,CAAAD,mBAAA,GAAAA,mBAAA","ignoreList":[]}
+{"version":3,"names":["WixDataPatchOptionsBuilderImpl","constructor","options","withSuppressHooks","value","copy","suppressHooks","withShowDrafts","showDrafts","withCondition","condition","filter","build","PatchOptionsBuilder","exports"],"sources":["../../../src/api/WixDataPatchOptionsBuilder.ts"],"sourcesContent":["import type { FilterExpression } from '@wix/sdk-types'\nimport type { WixDataItem, WixDataQuerySpec } from './types'\nimport type { WixDataPatchOptions } from './WixDataPatch'\n\n/**\n * Builder for patch options used by Wix Data patch operations.\n *\n * Use this builder to configure patch behavior such as hooks suppression,\n * and conditional patching.\n * @public\n * @builder\n * @documentationMaturity preview\n */\nexport interface WixDataPatchOptionsBuilder {\n  /**\n   * Sets whether patch hooks are suppressed.\n   *\n   * When `true`, the patch runs without triggering hooks.\n   */\n  withSuppressHooks(value: boolean): WixDataPatchOptionsBuilder\n  /**\n   * Sets whether draft items are included when patching an item.\n   * @internal\n   */\n  withShowDrafts(value: boolean): WixDataPatchOptionsBuilder\n  /**\n   * Sets the condition that determines whether the item is patched.\n   */\n  withCondition(\n    value: FilterExpression<WixDataItem, WixDataQuerySpec>\n  ): WixDataPatchOptionsBuilder\n  /**\n   * Builds the patch options object.\n   */\n  build(): WixDataPatchOptions\n}\n\nclass WixDataPatchOptionsBuilderImpl implements WixDataPatchOptionsBuilder {\n  constructor(private readonly options: WixDataPatchOptions = {}) {}\n\n  withSuppressHooks(value: boolean): WixDataPatchOptionsBuilder {\n    return this.copy({ suppressHooks: value })\n  }\n\n  withShowDrafts(value: boolean): WixDataPatchOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withCondition(\n    value: FilterExpression<WixDataItem, WixDataQuerySpec>\n  ): WixDataPatchOptionsBuilder {\n    return this.copy({ condition: value.filter })\n  }\n\n  build(): WixDataPatchOptions {\n    return {\n      ...this.options,\n    }\n  }\n\n  private copy(options: WixDataPatchOptions): WixDataPatchOptionsBuilder {\n    return new WixDataPatchOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData patch options builder.\n * @public\n * @documentationMaturity preview\n *\n * @example\n * ```ts\n * import { items, PatchOptionsBuilder, Filter } from '@wix/data'\n *\n * const options = PatchOptionsBuilder()\n *   .withSuppressHooks(true)\n *   .withCondition(Filter('status').eq('active'))\n *   .build()\n *\n * const item = await items.patch('myCollection', 'someId', option)\n * ```\n */\nexport const PatchOptionsBuilder: () => WixDataPatchOptionsBuilder = () =>\n  new WixDataPatchOptionsBuilderImpl()\n"],"mappings":";;;;AAIA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAyBA,MAAMA,8BAA8B,CAAuC;EACzEC,WAAWA,CAAkBC,OAA4B,GAAG,CAAC,CAAC,EAAE;IAAA,KAAnCA,OAA4B,GAA5BA,OAA4B;EAAQ;EAEjEC,iBAAiBA,CAACC,KAAc,EAA8B;IAC5D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,aAAa,EAAEF;IAAM,CAAC,CAAC;EAC5C;EAEAG,cAAcA,CAACH,KAAc,EAA8B;IACzD,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAEJ;IAAM,CAAC,CAAC;EACzC;EAEAK,aAAaA,CACXL,KAAsD,EAC1B;IAC5B,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,SAAS,EAAEN,KAAK,CAACO;IAAO,CAAC,CAAC;EAC/C;EAEAC,KAAKA,CAAA,EAAwB;IAC3B,OAAO;MACL,GAAG,IAAI,CAACV;IACV,CAAC;EACH;EAEQG,IAAIA,CAACH,OAA4B,EAA8B;IACrE,OAAO,IAAIF,8BAA8B,CAAC;MACxC,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMW,mBAAqD,GAAGA,CAAA,KACnE,IAAIb,8BAA8B,CAAC,CAAC;AAAAc,OAAA,CAAAD,mBAAA,GAAAA,mBAAA","ignoreList":[]}

package/dist/cjs/api/WixDataQueryBuilder.js

@@ -13,11 +13,12 @@ const baseQueryUtils = (0, _queryBuilderUtils.createQueryUtils)();
 
 /**
  * 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(
@@ -30,18 +31,20 @@ const baseQueryUtils = (0, _queryBuilderUtils.createQueryUtils)();
  *   .withPaging({ limit: 10, offset: 0 })
  *   .build()
  *
- * const result = await wixData.query<MyItem>('myCollection', request)
+ * const result = await items.query<MyItem>('myCollection', request)
  * ```
  */
 const QueryBuilder = exports.QueryBuilder = baseQueryUtils.QueryBuilder;
 
 /**
  * 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')
  *
@@ -65,11 +68,13 @@ const Filter = exports.Filter = baseQueryUtils.Filter;
 
 /**
  * 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/cjs/api/WixDataQueryBuilder.js.map

@@ -1 +1 @@
-{"version":3,"names":["_queryBuilderUtils","require","baseQueryUtils","createQueryUtils","QueryBuilder","exports","Filter","Sort"],"sources":["../../../src/api/WixDataQueryBuilder.ts"],"sourcesContent":["import { createQueryUtils } from '@wix/sdk-runtime/query-builder-utils'\nimport type {\n  QueryBuilder as SDKQueryBuilder,\n  FilterFactory,\n  SortFactory,\n} from '@wix/sdk-types'\nimport { WixDataQueryRequest, WixDataQuerySpec, WixDataItem } from './types'\n\n// Create the base query utilities from SDK runtime\nconst baseQueryUtils = createQueryUtils<\n  WixDataItem,\n  WixDataQuerySpec,\n  WixDataQueryRequest\n>()\n\n/**\n * WixData QueryBuilder type.\n * @internal\n */\nexport type WixDataQueryBuilder = SDKQueryBuilder<\n  WixDataItem,\n  WixDataQuerySpec,\n  WixDataQueryRequest\n>\n\n/**\n * Creates a new WixData query builder.\n * @internal\n *\n * @example\n * ```ts\n * import { QueryBuilder, Filter, Sort } from '@wix/wix-data-items-common'\n *\n * const request = QueryBuilder()\n *   .withFilter(\n *     Filter.and(\n *       Filter('status').eq('active'),\n *       Filter('age').gt(25)\n *     )\n *   )\n *   .withSorting(Sort('lastName').asc())\n *   .withPaging({ limit: 10, offset: 0 })\n *   .build()\n *\n * const result = await wixData.query<MyItem>('myCollection', request)\n * ```\n */\nexport const QueryBuilder: () => WixDataQueryBuilder =\n  baseQueryUtils.QueryBuilder\n\n/**\n * Filter factory for creating filter expressions.\n * Uses the SDK's Filter with WixData types.\n * @internal\n *\n * @example\n * ```ts\n * // Simple field filter\n * Filter('status').eq('active')\n *\n * // Combining filters with AND\n * Filter.and(\n *   Filter('orderId').eq('123'),\n *   Filter('amount').gt(100)\n * )\n *\n * // Combining filters with OR\n * Filter.or(\n *   Filter('status').eq('pending'),\n *   Filter('status').eq('active')\n * )\n *\n * // Negating a filter\n * Filter.not(Filter('status').eq('deleted'))\n * ```\n */\nexport const Filter: FilterFactory<WixDataItem, WixDataQuerySpec> =\n  baseQueryUtils.Filter\n\n/**\n * Sort factory for creating sort expressions.\n * Uses the SDK's Sort with WixData types.\n * @internal\n *\n * @example\n * ```ts\n * // Descending sort\n * Sort('amount').desc()\n *\n * // Ascending sort\n * Sort('name').asc()\n *\n * // Use with QueryBuilder\n * QueryBuilder()\n *   .withSorting(Sort('amount').desc(), Sort('name').asc())\n *   .build()\n * ```\n */\nexport const Sort: SortFactory<WixDataQuerySpec> = baseQueryUtils.Sort\n\n// Re-export types for convenience\nexport type {\n  FilterExpression,\n  SortExpression,\n  PagingFor,\n} from '@wix/sdk-types'\n"],"mappings":";;;;AAAA,IAAAA,kBAAA,GAAAC,OAAA;AAQA;AACA,MAAMC,cAAc,GAAG,IAAAC,mCAAgB,EAIrC,CAAC;;AAEH;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,YAAuC,GAAAC,OAAA,CAAAD,YAAA,GAClDF,cAAc,CAACE,YAAY;;AAE7B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAME,MAAoD,GAAAD,OAAA,CAAAC,MAAA,GAC/DJ,cAAc,CAACI,MAAM;;AAEvB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,IAAmC,GAAAF,OAAA,CAAAE,IAAA,GAAGL,cAAc,CAACK,IAAI;;AAEtE","ignoreList":[]}
+{"version":3,"names":["_queryBuilderUtils","require","baseQueryUtils","createQueryUtils","QueryBuilder","exports","Filter","Sort"],"sources":["../../../src/api/WixDataQueryBuilder.ts"],"sourcesContent":["import { createQueryUtils } from '@wix/sdk-runtime/query-builder-utils'\nimport type {\n  QueryBuilder as SDKQueryBuilder,\n  FilterFactory,\n  SortFactory,\n} from '@wix/sdk-types'\nimport { WixDataQueryRequest, WixDataQuerySpec, WixDataItem } from './types'\n\n// Create the base query utilities from SDK runtime\nconst baseQueryUtils = createQueryUtils<\n  WixDataItem,\n  WixDataQuerySpec,\n  WixDataQueryRequest\n>()\n\n/**\n * WixData QueryBuilder type.\n * @internal\n */\nexport type WixDataQueryBuilder = SDKQueryBuilder<\n  WixDataItem,\n  WixDataQuerySpec,\n  WixDataQueryRequest\n>\n\n/**\n * Creates a new WixData query builder.\n * @public\n * @documentationMaturity preview\n *\n * @example\n * ```ts\n * import { items, QueryBuilder, Filter, Sort } from '@wix/data'\n *\n * const request = QueryBuilder()\n *   .withFilter(\n *     Filter.and(\n *       Filter('status').eq('active'),\n *       Filter('age').gt(25)\n *     )\n *   )\n *   .withSorting(Sort('lastName').asc())\n *   .withPaging({ limit: 10, offset: 0 })\n *   .build()\n *\n * const result = await items.query<MyItem>('myCollection', request)\n * ```\n */\nexport const QueryBuilder: () => WixDataQueryBuilder =\n  baseQueryUtils.QueryBuilder\n\n/**\n * Filter factory for creating filter expressions.\n * @public\n * @documentationMaturity preview\n *\n * @example\n * ```ts\n * import { Filter } from '@wix/data'\n *\n * // Simple field filter\n * Filter('status').eq('active')\n *\n * // Combining filters with AND\n * Filter.and(\n *   Filter('orderId').eq('123'),\n *   Filter('amount').gt(100)\n * )\n *\n * // Combining filters with OR\n * Filter.or(\n *   Filter('status').eq('pending'),\n *   Filter('status').eq('active')\n * )\n *\n * // Negating a filter\n * Filter.not(Filter('status').eq('deleted'))\n * ```\n */\nexport const Filter: FilterFactory<WixDataItem, WixDataQuerySpec> =\n  baseQueryUtils.Filter\n\n/**\n * Sort factory for creating sort expressions.\n * @public\n * @documentationMaturity preview\n *\n * @example\n * ```ts\n * import { Sort, QueryBuilder } from '@wix/data'\n *\n * // Descending sort\n * Sort('amount').desc()\n *\n * // Ascending sort\n * Sort('name').asc()\n *\n * // Use with QueryBuilder\n * QueryBuilder()\n *   .withSorting(Sort('amount').desc(), Sort('name').asc())\n *   .build()\n * ```\n */\nexport const Sort: SortFactory<WixDataQuerySpec> = baseQueryUtils.Sort\n\n// Re-export types for convenience\nexport type {\n  FilterExpression,\n  SortExpression,\n  PagingFor,\n} from '@wix/sdk-types'\n"],"mappings":";;;;AAAA,IAAAA,kBAAA,GAAAC,OAAA;AAQA;AACA,MAAMC,cAAc,GAAG,IAAAC,mCAAgB,EAIrC,CAAC;;AAEH;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,YAAuC,GAAAC,OAAA,CAAAD,YAAA,GAClDF,cAAc,CAACE,YAAY;;AAE7B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAME,MAAoD,GAAAD,OAAA,CAAAC,MAAA,GAC/DJ,cAAc,CAACI,MAAM;;AAEvB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,IAAmC,GAAAF,OAAA,CAAAE,IAAA,GAAGL,cAAc,CAACK,IAAI;;AAEtE","ignoreList":[]}

package/dist/cjs/api/WixDataQueryOptionsBuilder.js

@@ -3,8 +3,13 @@
 exports.__esModule = true;
 exports.QueryOptionsBuilder = void 0;
 /**
- * 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
  */
 
 class WixDataQueryOptionsBuilderImpl {
@@ -83,7 +88,29 @@ class WixDataQueryOptionsBuilderImpl {
 
 /**
  * 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
+ * )
+ * ```
  */
 const QueryOptionsBuilder = () => new WixDataQueryOptionsBuilderImpl();
 exports.QueryOptionsBuilder = QueryOptionsBuilder;

package/dist/cjs/api/WixDataQueryOptionsBuilder.js.map

@@ -1 +1 @@
-{"version":3,"names":["WixDataQueryOptionsBuilderImpl","constructor","options","withSuppressHooks","value","copy","suppressHooks","withShowDrafts","showDrafts","withAppOptions","appOptions","withLanguage","language","withConsistentRead","consistentRead","withIncludeReferences","includeReferences","map","includeReference","withReturnTotalCount","returnTotalCount","withIncludeFieldGroups","includeFieldGroups","build","QueryOptionsBuilder","exports"],"sources":["../../../src/api/WixDataQueryOptionsBuilder.ts"],"sourcesContent":["import type { WixDataQueryOptions } from './types'\n\n/**\n * WixData query options builder.\n * @internal\n */\nexport interface WixDataQueryOptionsBuilder {\n  withSuppressHooks(value: boolean): WixDataQueryOptionsBuilder\n  withShowDrafts(value: boolean): WixDataQueryOptionsBuilder\n  withAppOptions(value: Record<string, any>): WixDataQueryOptionsBuilder\n  withLanguage(value: string): WixDataQueryOptionsBuilder\n  withConsistentRead(value: boolean): WixDataQueryOptionsBuilder\n  withIncludeReferences(\n    value: { field: string; limit?: number }[]\n  ): WixDataQueryOptionsBuilder\n  withReturnTotalCount(value: boolean): WixDataQueryOptionsBuilder\n  withIncludeFieldGroups(...value: string[]): WixDataQueryOptionsBuilder\n  build(): WixDataQueryOptions\n}\n\nclass WixDataQueryOptionsBuilderImpl implements WixDataQueryOptionsBuilder {\n  constructor(private readonly options: WixDataQueryOptions = {}) {}\n\n  withSuppressHooks(value: boolean): WixDataQueryOptionsBuilder {\n    return this.copy({ suppressHooks: value })\n  }\n\n  withShowDrafts(value: boolean): WixDataQueryOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withAppOptions(value: Record<string, any>): WixDataQueryOptionsBuilder {\n    return this.copy({ appOptions: { ...value } })\n  }\n\n  withLanguage(value: string): WixDataQueryOptionsBuilder {\n    return this.copy({ language: value })\n  }\n\n  withConsistentRead(value: boolean): WixDataQueryOptionsBuilder {\n    return this.copy({ consistentRead: value })\n  }\n\n  withIncludeReferences(\n    value: { field: string; limit?: number }[]\n  ): WixDataQueryOptionsBuilder {\n    return this.copy({\n      includeReferences: value.map((includeReference) => ({\n        ...includeReference,\n      })),\n    })\n  }\n\n  withReturnTotalCount(value: boolean): WixDataQueryOptionsBuilder {\n    return this.copy({ returnTotalCount: value })\n  }\n\n  withIncludeFieldGroups(...value: string[]): WixDataQueryOptionsBuilder {\n    return this.copy({ includeFieldGroups: [...value] })\n  }\n\n  build(): WixDataQueryOptions {\n    return {\n      ...this.options,\n      ...(this.options.appOptions\n        ? { appOptions: { ...this.options.appOptions } }\n        : {}),\n      ...(this.options.includeReferences\n        ? {\n            includeReferences: this.options.includeReferences.map(\n              (includeReference) => ({ ...includeReference })\n            ),\n          }\n        : {}),\n      ...(this.options.includeFieldGroups\n        ? { includeFieldGroups: [...this.options.includeFieldGroups] }\n        : {}),\n    }\n  }\n\n  private copy(options: WixDataQueryOptions): WixDataQueryOptionsBuilder {\n    return new WixDataQueryOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData query options builder.\n * @internal\n */\nexport const QueryOptionsBuilder: () => WixDataQueryOptionsBuilder = () =>\n  new WixDataQueryOptionsBuilderImpl()\n"],"mappings":";;;;AAEA;AACA;AACA;AACA;;AAeA,MAAMA,8BAA8B,CAAuC;EACzEC,WAAWA,CAAkBC,OAA4B,GAAG,CAAC,CAAC,EAAE;IAAA,KAAnCA,OAA4B,GAA5BA,OAA4B;EAAQ;EAEjEC,iBAAiBA,CAACC,KAAc,EAA8B;IAC5D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,aAAa,EAAEF;IAAM,CAAC,CAAC;EAC5C;EAEAG,cAAcA,CAACH,KAAc,EAA8B;IACzD,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAEJ;IAAM,CAAC,CAAC;EACzC;EAEAK,cAAcA,CAACL,KAA0B,EAA8B;IACrE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,UAAU,EAAE;QAAE,GAAGN;MAAM;IAAE,CAAC,CAAC;EAChD;EAEAO,YAAYA,CAACP,KAAa,EAA8B;IACtD,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEO,QAAQ,EAAER;IAAM,CAAC,CAAC;EACvC;EAEAS,kBAAkBA,CAACT,KAAc,EAA8B;IAC7D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAES,cAAc,EAAEV;IAAM,CAAC,CAAC;EAC7C;EAEAW,qBAAqBA,CACnBX,KAA0C,EACd;IAC5B,OAAO,IAAI,CAACC,IAAI,CAAC;MACfW,iBAAiB,EAAEZ,KAAK,CAACa,GAAG,CAAEC,gBAAgB,KAAM;QAClD,GAAGA;MACL,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ;EAEAC,oBAAoBA,CAACf,KAAc,EAA8B;IAC/D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEe,gBAAgB,EAAEhB;IAAM,CAAC,CAAC;EAC/C;EAEAiB,sBAAsBA,CAAC,GAAGjB,KAAe,EAA8B;IACrE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEiB,kBAAkB,EAAE,CAAC,GAAGlB,KAAK;IAAE,CAAC,CAAC;EACtD;EAEAmB,KAAKA,CAAA,EAAwB;IAC3B,OAAO;MACL,GAAG,IAAI,CAACrB,OAAO;MACf,IAAI,IAAI,CAACA,OAAO,CAACQ,UAAU,GACvB;QAAEA,UAAU,EAAE;UAAE,GAAG,IAAI,CAACR,OAAO,CAACQ;QAAW;MAAE,CAAC,GAC9C,CAAC,CAAC,CAAC;MACP,IAAI,IAAI,CAACR,OAAO,CAACc,iBAAiB,GAC9B;QACEA,iBAAiB,EAAE,IAAI,CAACd,OAAO,CAACc,iBAAiB,CAACC,GAAG,CAClDC,gBAAgB,KAAM;UAAE,GAAGA;QAAiB,CAAC,CAChD;MACF,CAAC,GACD,CAAC,CAAC,CAAC;MACP,IAAI,IAAI,CAAChB,OAAO,CAACoB,kBAAkB,GAC/B;QAAEA,kBAAkB,EAAE,CAAC,GAAG,IAAI,CAACpB,OAAO,CAACoB,kBAAkB;MAAE,CAAC,GAC5D,CAAC,CAAC;IACR,CAAC;EACH;EAEQjB,IAAIA,CAACH,OAA4B,EAA8B;IACrE,OAAO,IAAIF,8BAA8B,CAAC;MACxC,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACO,MAAMsB,mBAAqD,GAAGA,CAAA,KACnE,IAAIxB,8BAA8B,CAAC,CAAC;AAAAyB,OAAA,CAAAD,mBAAA,GAAAA,mBAAA","ignoreList":[]}
+{"version":3,"names":["WixDataQueryOptionsBuilderImpl","constructor","options","withSuppressHooks","value","copy","suppressHooks","withShowDrafts","showDrafts","withAppOptions","appOptions","withLanguage","language","withConsistentRead","consistentRead","withIncludeReferences","includeReferences","map","includeReference","withReturnTotalCount","returnTotalCount","withIncludeFieldGroups","includeFieldGroups","build","QueryOptionsBuilder","exports"],"sources":["../../../src/api/WixDataQueryOptionsBuilder.ts"],"sourcesContent":["import type { WixDataQueryOptions } from './types'\n\n/**\n * Builder for query options used by Wix Data query operations.\n *\n * Use this builder to configure query behavior such as hooks suppression,\n * language, reference inclusion, and field groups.\n * @public\n * @builder\n * @documentationMaturity preview\n */\nexport interface WixDataQueryOptionsBuilder {\n  /**\n   * Sets whether query hooks are suppressed.\n   *\n   * When `true`, the query runs without triggering hooks.\n   */\n  withSuppressHooks(value: boolean): WixDataQueryOptionsBuilder\n  /**\n   * Sets whether draft items are included in query results.\n   * @internal\n   */\n  withShowDrafts(value: boolean): WixDataQueryOptionsBuilder\n  /**\n   * Sets app-specific query options.\n   */\n  withAppOptions(value: Record<string, any>): WixDataQueryOptionsBuilder\n  /**\n   * Sets the language used for the query.\n   */\n  withLanguage(value: string): WixDataQueryOptionsBuilder\n  /**\n   * Sets whether the query uses consistent read mode.\n   */\n  withConsistentRead(value: boolean): WixDataQueryOptionsBuilder\n  /**\n   * Includes referenced items for the specified reference fields.\n   *\n   * Use `limit` to cap how many referenced items are returned per field.\n   */\n  withIncludeReferences(\n    value: { field: string; limit?: number }[]\n  ): WixDataQueryOptionsBuilder\n  /**\n   * Sets whether the total result count is returned with the query response.\n   */\n  withReturnTotalCount(value: boolean): WixDataQueryOptionsBuilder\n  /**\n   * Includes the specified field groups in the query results.\n   */\n  withIncludeFieldGroups(...value: string[]): WixDataQueryOptionsBuilder\n  /**\n   * Builds the query options object.\n   */\n  build(): WixDataQueryOptions\n}\n\nclass WixDataQueryOptionsBuilderImpl implements WixDataQueryOptionsBuilder {\n  constructor(private readonly options: WixDataQueryOptions = {}) {}\n\n  withSuppressHooks(value: boolean): WixDataQueryOptionsBuilder {\n    return this.copy({ suppressHooks: value })\n  }\n\n  withShowDrafts(value: boolean): WixDataQueryOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withAppOptions(value: Record<string, any>): WixDataQueryOptionsBuilder {\n    return this.copy({ appOptions: { ...value } })\n  }\n\n  withLanguage(value: string): WixDataQueryOptionsBuilder {\n    return this.copy({ language: value })\n  }\n\n  withConsistentRead(value: boolean): WixDataQueryOptionsBuilder {\n    return this.copy({ consistentRead: value })\n  }\n\n  withIncludeReferences(\n    value: { field: string; limit?: number }[]\n  ): WixDataQueryOptionsBuilder {\n    return this.copy({\n      includeReferences: value.map((includeReference) => ({\n        ...includeReference,\n      })),\n    })\n  }\n\n  withReturnTotalCount(value: boolean): WixDataQueryOptionsBuilder {\n    return this.copy({ returnTotalCount: value })\n  }\n\n  withIncludeFieldGroups(...value: string[]): WixDataQueryOptionsBuilder {\n    return this.copy({ includeFieldGroups: [...value] })\n  }\n\n  build(): WixDataQueryOptions {\n    return {\n      ...this.options,\n      ...(this.options.appOptions\n        ? { appOptions: { ...this.options.appOptions } }\n        : {}),\n      ...(this.options.includeReferences\n        ? {\n            includeReferences: this.options.includeReferences.map(\n              (includeReference) => ({ ...includeReference })\n            ),\n          }\n        : {}),\n      ...(this.options.includeFieldGroups\n        ? { includeFieldGroups: [...this.options.includeFieldGroups] }\n        : {}),\n    }\n  }\n\n  private copy(options: WixDataQueryOptions): WixDataQueryOptionsBuilder {\n    return new WixDataQueryOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData query options builder.\n * @public\n * @documentationMaturity preview\n *\n * @example\n * ```ts\n * import { items, QueryOptionsBuilder } from '@wix/data'\n *\n * const options = QueryOptionsBuilder()\n *   .withSuppressHooks(true)\n *   .withAppOptions({ key: 'value' })\n *   .withLanguage('en')\n *   .withConsistentRead(true)\n *   .withIncludeReferences([{ field: 'author', limit: 3 }])\n *   .withReturnTotalCount(true)\n *   .withIncludeFieldGroups('seo', 'details')\n *   .build()\n *\n * const result = await items.query<MyItem>(\n *   'myCollection',\n *   {},\n *   options\n * )\n * ```\n */\nexport const QueryOptionsBuilder: () => WixDataQueryOptionsBuilder = () =>\n  new WixDataQueryOptionsBuilderImpl()\n"],"mappings":";;;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA+CA,MAAMA,8BAA8B,CAAuC;EACzEC,WAAWA,CAAkBC,OAA4B,GAAG,CAAC,CAAC,EAAE;IAAA,KAAnCA,OAA4B,GAA5BA,OAA4B;EAAQ;EAEjEC,iBAAiBA,CAACC,KAAc,EAA8B;IAC5D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,aAAa,EAAEF;IAAM,CAAC,CAAC;EAC5C;EAEAG,cAAcA,CAACH,KAAc,EAA8B;IACzD,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAEJ;IAAM,CAAC,CAAC;EACzC;EAEAK,cAAcA,CAACL,KAA0B,EAA8B;IACrE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,UAAU,EAAE;QAAE,GAAGN;MAAM;IAAE,CAAC,CAAC;EAChD;EAEAO,YAAYA,CAACP,KAAa,EAA8B;IACtD,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEO,QAAQ,EAAER;IAAM,CAAC,CAAC;EACvC;EAEAS,kBAAkBA,CAACT,KAAc,EAA8B;IAC7D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAES,cAAc,EAAEV;IAAM,CAAC,CAAC;EAC7C;EAEAW,qBAAqBA,CACnBX,KAA0C,EACd;IAC5B,OAAO,IAAI,CAACC,IAAI,CAAC;MACfW,iBAAiB,EAAEZ,KAAK,CAACa,GAAG,CAAEC,gBAAgB,KAAM;QAClD,GAAGA;MACL,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ;EAEAC,oBAAoBA,CAACf,KAAc,EAA8B;IAC/D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEe,gBAAgB,EAAEhB;IAAM,CAAC,CAAC;EAC/C;EAEAiB,sBAAsBA,CAAC,GAAGjB,KAAe,EAA8B;IACrE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEiB,kBAAkB,EAAE,CAAC,GAAGlB,KAAK;IAAE,CAAC,CAAC;EACtD;EAEAmB,KAAKA,CAAA,EAAwB;IAC3B,OAAO;MACL,GAAG,IAAI,CAACrB,OAAO;MACf,IAAI,IAAI,CAACA,OAAO,CAACQ,UAAU,GACvB;QAAEA,UAAU,EAAE;UAAE,GAAG,IAAI,CAACR,OAAO,CAACQ;QAAW;MAAE,CAAC,GAC9C,CAAC,CAAC,CAAC;MACP,IAAI,IAAI,CAACR,OAAO,CAACc,iBAAiB,GAC9B;QACEA,iBAAiB,EAAE,IAAI,CAACd,OAAO,CAACc,iBAAiB,CAACC,GAAG,CAClDC,gBAAgB,KAAM;UAAE,GAAGA;QAAiB,CAAC,CAChD;MACF,CAAC,GACD,CAAC,CAAC,CAAC;MACP,IAAI,IAAI,CAAChB,OAAO,CAACoB,kBAAkB,GAC/B;QAAEA,kBAAkB,EAAE,CAAC,GAAG,IAAI,CAACpB,OAAO,CAACoB,kBAAkB;MAAE,CAAC,GAC5D,CAAC,CAAC;IACR,CAAC;EACH;EAEQjB,IAAIA,CAACH,OAA4B,EAA8B;IACrE,OAAO,IAAIF,8BAA8B,CAAC;MACxC,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMsB,mBAAqD,GAAGA,CAAA,KACnE,IAAIxB,8BAA8B,CAAC,CAAC;AAAAyB,OAAA,CAAAD,mBAAA,GAAAA,mBAAA","ignoreList":[]}

package/dist/cjs/api/WixDataQueryReferencedItemsOptionsBuilder.js

@@ -3,8 +3,13 @@
 exports.__esModule = true;
 exports.QueryReferencedItemsOptionsBuilder = void 0;
 /**
- * WixData query referenced items options builder.
- * @internal
+ * Builder for query referenced items options used by Wix Data query referenced items operations.
+ *
+ * Use this builder to configure referenced item query behavior such as language,
+ * selected fields, sort order and paging.
+ * @public
+ * @builder
+ * @documentationMaturity preview
  */
 
 class WixDataQueryReferencedItemsOptionsBuilderImpl {
@@ -95,7 +100,31 @@ class WixDataQueryReferencedItemsOptionsBuilderImpl {
 
 /**
  * Creates a new WixData query referenced items options builder.
- * @internal
+ * @public
+ * @documentationMaturity preview
+ *
+ * @example
+ * ```ts
+ * import { items, QueryReferencedItemsOptionsBuilder } from '@wix/data'
+ *
+ * const options = QueryReferencedItemsOptionsBuilder()
+ *   .withAppOptions({ key: 'value' })
+ *   .withLanguage('en')
+ *   .withConsistentRead(true)
+ *   .withReturnTotalCount(true)
+ *   .withFields('_id', 'title')
+ *   .withOrder('ASC')
+ *   .withPaging({ limit: 10, offset: 0 })
+ *   .withCursorPaging({ cursor: 'eyJpZCI6IjEyMyJ9', limit: 10 })
+ *   .build()
+ *
+ * const result = await items.queryReferencedItems<MyItem>(
+ *   'myCollection',
+ *   'myItemId',
+ *   'relatedItems',
+ *   options
+ * )
+ * ```
  */
 const QueryReferencedItemsOptionsBuilder = () => new WixDataQueryReferencedItemsOptionsBuilderImpl();
 exports.QueryReferencedItemsOptionsBuilder = QueryReferencedItemsOptionsBuilder;

package/dist/cjs/api/WixDataQueryReferencedItemsOptionsBuilder.js.map

@@ -1 +1 @@
-{"version":3,"names":["WixDataQueryReferencedItemsOptionsBuilderImpl","constructor","options","withShowDrafts","value","copy","showDrafts","withAppOptions","appOptions","withLanguage","language","withConsistentRead","consistentRead","withReturnTotalCount","returnTotalCount","withFields","fields","withOrder","order","withPaging","paging","withCursorPaging","cursorPaging","build","QueryReferencedItemsOptionsBuilder","exports"],"sources":["../../../src/api/WixDataQueryReferencedItemsOptionsBuilder.ts"],"sourcesContent":["import type { SortOrder } from '../types/data-item-types'\nimport type { WixDataQueryReferencedItemsOptions } from './types'\n\n/**\n * WixData query referenced items options builder.\n * @internal\n */\nexport interface WixDataQueryReferencedItemsOptionsBuilder {\n  withShowDrafts(value: boolean): WixDataQueryReferencedItemsOptionsBuilder\n  withAppOptions(\n    value: Record<string, any>\n  ): WixDataQueryReferencedItemsOptionsBuilder\n  withLanguage(value: string): WixDataQueryReferencedItemsOptionsBuilder\n  withConsistentRead(value: boolean): WixDataQueryReferencedItemsOptionsBuilder\n  withReturnTotalCount(\n    value: boolean\n  ): WixDataQueryReferencedItemsOptionsBuilder\n  withFields(...value: string[]): WixDataQueryReferencedItemsOptionsBuilder\n  withOrder(value: SortOrder): WixDataQueryReferencedItemsOptionsBuilder\n  withPaging(value: {\n    limit?: number\n    offset?: number\n  }): WixDataQueryReferencedItemsOptionsBuilder\n  withCursorPaging(value: {\n    cursor?: string\n    limit?: number\n  }): WixDataQueryReferencedItemsOptionsBuilder\n  build(): WixDataQueryReferencedItemsOptions\n}\n\nclass WixDataQueryReferencedItemsOptionsBuilderImpl\n  implements WixDataQueryReferencedItemsOptionsBuilder\n{\n  constructor(\n    private readonly options: WixDataQueryReferencedItemsOptions = {}\n  ) {}\n\n  withShowDrafts(value: boolean): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withAppOptions(\n    value: Record<string, any>\n  ): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ appOptions: { ...value } })\n  }\n\n  withLanguage(value: string): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ language: value })\n  }\n\n  withConsistentRead(\n    value: boolean\n  ): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ consistentRead: value })\n  }\n\n  withReturnTotalCount(\n    value: boolean\n  ): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ returnTotalCount: value })\n  }\n\n  withFields(...value: string[]): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ fields: [...value] })\n  }\n\n  withOrder(value: SortOrder): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ order: value })\n  }\n\n  withPaging(value: {\n    limit?: number\n    offset?: number\n  }): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ paging: { ...value } })\n  }\n\n  withCursorPaging(value: {\n    cursor?: string\n    limit?: number\n  }): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ cursorPaging: { ...value } })\n  }\n\n  build(): WixDataQueryReferencedItemsOptions {\n    return {\n      ...this.options,\n      ...(this.options.appOptions\n        ? { appOptions: { ...this.options.appOptions } }\n        : {}),\n      ...(this.options.fields ? { fields: [...this.options.fields] } : {}),\n      ...(this.options.paging ? { paging: { ...this.options.paging } } : {}),\n      ...(this.options.cursorPaging\n        ? { cursorPaging: { ...this.options.cursorPaging } }\n        : {}),\n    }\n  }\n\n  private copy(\n    options: WixDataQueryReferencedItemsOptions\n  ): WixDataQueryReferencedItemsOptionsBuilder {\n    return new WixDataQueryReferencedItemsOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData query referenced items options builder.\n * @internal\n */\nexport const QueryReferencedItemsOptionsBuilder: () => WixDataQueryReferencedItemsOptionsBuilder =\n  () => new WixDataQueryReferencedItemsOptionsBuilderImpl()\n"],"mappings":";;;;AAGA;AACA;AACA;AACA;;AAwBA,MAAMA,6CAA6C,CAEnD;EACEC,WAAWA,CACQC,OAA2C,GAAG,CAAC,CAAC,EACjE;IAAA,KADiBA,OAA2C,GAA3CA,OAA2C;EAC3D;EAEHC,cAAcA,CAACC,KAAc,EAA6C;IACxE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,UAAU,EAAEF;IAAM,CAAC,CAAC;EACzC;EAEAG,cAAcA,CACZH,KAA0B,EACiB;IAC3C,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAE;QAAE,GAAGJ;MAAM;IAAE,CAAC,CAAC;EAChD;EAEAK,YAAYA,CAACL,KAAa,EAA6C;IACrE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,QAAQ,EAAEN;IAAM,CAAC,CAAC;EACvC;EAEAO,kBAAkBA,CAChBP,KAAc,EAC6B;IAC3C,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEO,cAAc,EAAER;IAAM,CAAC,CAAC;EAC7C;EAEAS,oBAAoBA,CAClBT,KAAc,EAC6B;IAC3C,OAAO,IAAI,CAACC,IAAI,CAAC;MAAES,gBAAgB,EAAEV;IAAM,CAAC,CAAC;EAC/C;EAEAW,UAAUA,CAAC,GAAGX,KAAe,EAA6C;IACxE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEW,MAAM,EAAE,CAAC,GAAGZ,KAAK;IAAE,CAAC,CAAC;EAC1C;EAEAa,SAASA,CAACb,KAAgB,EAA6C;IACrE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEa,KAAK,EAAEd;IAAM,CAAC,CAAC;EACpC;EAEAe,UAAUA,CAACf,KAGV,EAA6C;IAC5C,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEe,MAAM,EAAE;QAAE,GAAGhB;MAAM;IAAE,CAAC,CAAC;EAC5C;EAEAiB,gBAAgBA,CAACjB,KAGhB,EAA6C;IAC5C,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEiB,YAAY,EAAE;QAAE,GAAGlB;MAAM;IAAE,CAAC,CAAC;EAClD;EAEAmB,KAAKA,CAAA,EAAuC;IAC1C,OAAO;MACL,GAAG,IAAI,CAACrB,OAAO;MACf,IAAI,IAAI,CAACA,OAAO,CAACM,UAAU,GACvB;QAAEA,UAAU,EAAE;UAAE,GAAG,IAAI,CAACN,OAAO,CAACM;QAAW;MAAE,CAAC,GAC9C,CAAC,CAAC,CAAC;MACP,IAAI,IAAI,CAACN,OAAO,CAACc,MAAM,GAAG;QAAEA,MAAM,EAAE,CAAC,GAAG,IAAI,CAACd,OAAO,CAACc,MAAM;MAAE,CAAC,GAAG,CAAC,CAAC,CAAC;MACpE,IAAI,IAAI,CAACd,OAAO,CAACkB,MAAM,GAAG;QAAEA,MAAM,EAAE;UAAE,GAAG,IAAI,CAAClB,OAAO,CAACkB;QAAO;MAAE,CAAC,GAAG,CAAC,CAAC,CAAC;MACtE,IAAI,IAAI,CAAClB,OAAO,CAACoB,YAAY,GACzB;QAAEA,YAAY,EAAE;UAAE,GAAG,IAAI,CAACpB,OAAO,CAACoB;QAAa;MAAE,CAAC,GAClD,CAAC,CAAC;IACR,CAAC;EACH;EAEQjB,IAAIA,CACVH,OAA2C,EACA;IAC3C,OAAO,IAAIF,6CAA6C,CAAC;MACvD,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACO,MAAMsB,kCAAmF,GAC9FA,CAAA,KAAM,IAAIxB,6CAA6C,CAAC,CAAC;AAAAyB,OAAA,CAAAD,kCAAA,GAAAA,kCAAA","ignoreList":[]}
+{"version":3,"names":["WixDataQueryReferencedItemsOptionsBuilderImpl","constructor","options","withShowDrafts","value","copy","showDrafts","withAppOptions","appOptions","withLanguage","language","withConsistentRead","consistentRead","withReturnTotalCount","returnTotalCount","withFields","fields","withOrder","order","withPaging","paging","withCursorPaging","cursorPaging","build","QueryReferencedItemsOptionsBuilder","exports"],"sources":["../../../src/api/WixDataQueryReferencedItemsOptionsBuilder.ts"],"sourcesContent":["import type { SortOrder } from '../types/data-item-types'\nimport type { WixDataQueryReferencedItemsOptions } from './types'\n\n/**\n * Builder for query referenced items options used by Wix Data query referenced items operations.\n *\n * Use this builder to configure referenced item query behavior such as language,\n * selected fields, sort order and paging.\n * @public\n * @builder\n * @documentationMaturity preview\n */\nexport interface WixDataQueryReferencedItemsOptionsBuilder {\n  /**\n   * Sets whether draft items are included in query results.\n   * @internal\n   */\n  withShowDrafts(value: boolean): WixDataQueryReferencedItemsOptionsBuilder\n  /**\n   * Sets app-specific query options.\n   */\n  withAppOptions(\n    value: Record<string, any>\n  ): WixDataQueryReferencedItemsOptionsBuilder\n  /**\n   * Sets the language used for the query.\n   */\n  withLanguage(value: string): WixDataQueryReferencedItemsOptionsBuilder\n  /**\n   * Sets whether the query uses consistent read mode.\n   */\n  withConsistentRead(value: boolean): WixDataQueryReferencedItemsOptionsBuilder\n  /**\n   * Sets whether the total result count is returned with the query response.\n   */\n  withReturnTotalCount(\n    value: boolean\n  ): WixDataQueryReferencedItemsOptionsBuilder\n  /**\n   * Sets the fields returned for each referenced item.\n   */\n  withFields(...value: string[]): WixDataQueryReferencedItemsOptionsBuilder\n  /**\n   * Sets the sort order of the query results.\n   */\n  withOrder(value: SortOrder): WixDataQueryReferencedItemsOptionsBuilder\n  /**\n   * Sets offset-based paging options.\n   */\n  withPaging(value: {\n    limit?: number\n    offset?: number\n  }): WixDataQueryReferencedItemsOptionsBuilder\n  /**\n   * Sets cursor-based paging options.\n   */\n  withCursorPaging(value: {\n    cursor?: string\n    limit?: number\n  }): WixDataQueryReferencedItemsOptionsBuilder\n  /**\n   * Builds the query referenced items options object.\n   */\n  build(): WixDataQueryReferencedItemsOptions\n}\n\nclass WixDataQueryReferencedItemsOptionsBuilderImpl\n  implements WixDataQueryReferencedItemsOptionsBuilder\n{\n  constructor(\n    private readonly options: WixDataQueryReferencedItemsOptions = {}\n  ) {}\n\n  withShowDrafts(value: boolean): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withAppOptions(\n    value: Record<string, any>\n  ): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ appOptions: { ...value } })\n  }\n\n  withLanguage(value: string): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ language: value })\n  }\n\n  withConsistentRead(\n    value: boolean\n  ): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ consistentRead: value })\n  }\n\n  withReturnTotalCount(\n    value: boolean\n  ): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ returnTotalCount: value })\n  }\n\n  withFields(...value: string[]): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ fields: [...value] })\n  }\n\n  withOrder(value: SortOrder): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ order: value })\n  }\n\n  withPaging(value: {\n    limit?: number\n    offset?: number\n  }): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ paging: { ...value } })\n  }\n\n  withCursorPaging(value: {\n    cursor?: string\n    limit?: number\n  }): WixDataQueryReferencedItemsOptionsBuilder {\n    return this.copy({ cursorPaging: { ...value } })\n  }\n\n  build(): WixDataQueryReferencedItemsOptions {\n    return {\n      ...this.options,\n      ...(this.options.appOptions\n        ? { appOptions: { ...this.options.appOptions } }\n        : {}),\n      ...(this.options.fields ? { fields: [...this.options.fields] } : {}),\n      ...(this.options.paging ? { paging: { ...this.options.paging } } : {}),\n      ...(this.options.cursorPaging\n        ? { cursorPaging: { ...this.options.cursorPaging } }\n        : {}),\n    }\n  }\n\n  private copy(\n    options: WixDataQueryReferencedItemsOptions\n  ): WixDataQueryReferencedItemsOptionsBuilder {\n    return new WixDataQueryReferencedItemsOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData query referenced items options builder.\n * @public\n * @documentationMaturity preview\n *\n * @example\n * ```ts\n * import { items, QueryReferencedItemsOptionsBuilder } from '@wix/data'\n *\n * const options = QueryReferencedItemsOptionsBuilder()\n *   .withAppOptions({ key: 'value' })\n *   .withLanguage('en')\n *   .withConsistentRead(true)\n *   .withReturnTotalCount(true)\n *   .withFields('_id', 'title')\n *   .withOrder('ASC')\n *   .withPaging({ limit: 10, offset: 0 })\n *   .withCursorPaging({ cursor: 'eyJpZCI6IjEyMyJ9', limit: 10 })\n *   .build()\n *\n * const result = await items.queryReferencedItems<MyItem>(\n *   'myCollection',\n *   'myItemId',\n *   'relatedItems',\n *   options\n * )\n * ```\n */\nexport const QueryReferencedItemsOptionsBuilder: () => WixDataQueryReferencedItemsOptionsBuilder =\n  () => new WixDataQueryReferencedItemsOptionsBuilderImpl()\n"],"mappings":";;;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAuDA,MAAMA,6CAA6C,CAEnD;EACEC,WAAWA,CACQC,OAA2C,GAAG,CAAC,CAAC,EACjE;IAAA,KADiBA,OAA2C,GAA3CA,OAA2C;EAC3D;EAEHC,cAAcA,CAACC,KAAc,EAA6C;IACxE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,UAAU,EAAEF;IAAM,CAAC,CAAC;EACzC;EAEAG,cAAcA,CACZH,KAA0B,EACiB;IAC3C,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAE;QAAE,GAAGJ;MAAM;IAAE,CAAC,CAAC;EAChD;EAEAK,YAAYA,CAACL,KAAa,EAA6C;IACrE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,QAAQ,EAAEN;IAAM,CAAC,CAAC;EACvC;EAEAO,kBAAkBA,CAChBP,KAAc,EAC6B;IAC3C,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEO,cAAc,EAAER;IAAM,CAAC,CAAC;EAC7C;EAEAS,oBAAoBA,CAClBT,KAAc,EAC6B;IAC3C,OAAO,IAAI,CAACC,IAAI,CAAC;MAAES,gBAAgB,EAAEV;IAAM,CAAC,CAAC;EAC/C;EAEAW,UAAUA,CAAC,GAAGX,KAAe,EAA6C;IACxE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEW,MAAM,EAAE,CAAC,GAAGZ,KAAK;IAAE,CAAC,CAAC;EAC1C;EAEAa,SAASA,CAACb,KAAgB,EAA6C;IACrE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEa,KAAK,EAAEd;IAAM,CAAC,CAAC;EACpC;EAEAe,UAAUA,CAACf,KAGV,EAA6C;IAC5C,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEe,MAAM,EAAE;QAAE,GAAGhB;MAAM;IAAE,CAAC,CAAC;EAC5C;EAEAiB,gBAAgBA,CAACjB,KAGhB,EAA6C;IAC5C,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEiB,YAAY,EAAE;QAAE,GAAGlB;MAAM;IAAE,CAAC,CAAC;EAClD;EAEAmB,KAAKA,CAAA,EAAuC;IAC1C,OAAO;MACL,GAAG,IAAI,CAACrB,OAAO;MACf,IAAI,IAAI,CAACA,OAAO,CAACM,UAAU,GACvB;QAAEA,UAAU,EAAE;UAAE,GAAG,IAAI,CAACN,OAAO,CAACM;QAAW;MAAE,CAAC,GAC9C,CAAC,CAAC,CAAC;MACP,IAAI,IAAI,CAACN,OAAO,CAACc,MAAM,GAAG;QAAEA,MAAM,EAAE,CAAC,GAAG,IAAI,CAACd,OAAO,CAACc,MAAM;MAAE,CAAC,GAAG,CAAC,CAAC,CAAC;MACpE,IAAI,IAAI,CAACd,OAAO,CAACkB,MAAM,GAAG;QAAEA,MAAM,EAAE;UAAE,GAAG,IAAI,CAAClB,OAAO,CAACkB;QAAO;MAAE,CAAC,GAAG,CAAC,CAAC,CAAC;MACtE,IAAI,IAAI,CAAClB,OAAO,CAACoB,YAAY,GACzB;QAAEA,YAAY,EAAE;UAAE,GAAG,IAAI,CAACpB,OAAO,CAACoB;QAAa;MAAE,CAAC,GAClD,CAAC,CAAC;IACR,CAAC;EACH;EAEQjB,IAAIA,CACVH,OAA2C,EACA;IAC3C,OAAO,IAAIF,6CAA6C,CAAC;MACvD,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMsB,kCAAmF,GAC9FA,CAAA,KAAM,IAAIxB,6CAA6C,CAAC,CAAC;AAAAyB,OAAA,CAAAD,kCAAA,GAAAA,kCAAA","ignoreList":[]}

package/dist/cjs/api/WixDataRemoveOptionsBuilder.js

@@ -3,8 +3,13 @@
 exports.__esModule = true;
 exports.RemoveOptionsBuilder = void 0;
 /**
- * WixData remove options builder.
- * @internal
+ * Builder for remove options used by Wix Data remove operations.
+ *
+ * Use this builder to configure remove behavior such as hooks suppression,
+ * and conditional removal.
+ * @public
+ * @builder
+ * @documentationMaturity preview
  */
 
 class WixDataRemoveOptionsBuilderImpl {
@@ -41,7 +46,24 @@ class WixDataRemoveOptionsBuilderImpl {
 
 /**
  * Creates a new WixData remove options builder.
- * @internal
+ * @public
+ * @documentationMaturity preview
+ *
+ * @example
+ * ```ts
+ * import { items, Filter, RemoveOptionsBuilder } from '@wix/data'
+ *
+ * const options = RemoveOptionsBuilder()
+ *   .withSuppressHooks(true)
+ *   .withCondition(Filter('status').eq('active'))
+ *   .build()
+ *
+ * const removedItem = await items.remove<MyItem>(
+ *   'myCollection',
+ *   'myItemId',
+ *   options
+ * )
+ * ```
  */
 const RemoveOptionsBuilder = () => new WixDataRemoveOptionsBuilderImpl();
 exports.RemoveOptionsBuilder = RemoveOptionsBuilder;

package/dist/cjs/api/WixDataRemoveOptionsBuilder.js.map

@@ -1 +1 @@
-{"version":3,"names":["WixDataRemoveOptionsBuilderImpl","constructor","options","withSuppressHooks","value","copy","suppressHooks","withShowDrafts","showDrafts","withCondition","condition","filter","build","RemoveOptionsBuilder","exports"],"sources":["../../../src/api/WixDataRemoveOptionsBuilder.ts"],"sourcesContent":["import type { FilterExpression } from '@wix/sdk-types'\nimport type {\n  WixDataItem,\n  WixDataQuerySpec,\n  WixDataRemoveOptions,\n} from './types'\n\n/**\n * WixData remove options builder.\n * @internal\n */\nexport interface WixDataRemoveOptionsBuilder {\n  withSuppressHooks(value: boolean): WixDataRemoveOptionsBuilder\n  withShowDrafts(value: boolean): WixDataRemoveOptionsBuilder\n  withCondition(\n    value: FilterExpression<WixDataItem, WixDataQuerySpec>\n  ): WixDataRemoveOptionsBuilder\n  build(): WixDataRemoveOptions\n}\n\nclass WixDataRemoveOptionsBuilderImpl implements WixDataRemoveOptionsBuilder {\n  constructor(private readonly options: WixDataRemoveOptions = {}) {}\n\n  withSuppressHooks(value: boolean): WixDataRemoveOptionsBuilder {\n    return this.copy({ suppressHooks: value })\n  }\n\n  withShowDrafts(value: boolean): WixDataRemoveOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withCondition(\n    value: FilterExpression<WixDataItem, WixDataQuerySpec>\n  ): WixDataRemoveOptionsBuilder {\n    return this.copy({ condition: value.filter })\n  }\n\n  build(): WixDataRemoveOptions {\n    return { ...this.options }\n  }\n\n  private copy(options: WixDataRemoveOptions): WixDataRemoveOptionsBuilder {\n    return new WixDataRemoveOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData remove options builder.\n * @internal\n */\nexport const RemoveOptionsBuilder: () => WixDataRemoveOptionsBuilder = () =>\n  new WixDataRemoveOptionsBuilderImpl()\n"],"mappings":";;;;AAOA;AACA;AACA;AACA;;AAUA,MAAMA,+BAA+B,CAAwC;EAC3EC,WAAWA,CAAkBC,OAA6B,GAAG,CAAC,CAAC,EAAE;IAAA,KAApCA,OAA6B,GAA7BA,OAA6B;EAAQ;EAElEC,iBAAiBA,CAACC,KAAc,EAA+B;IAC7D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,aAAa,EAAEF;IAAM,CAAC,CAAC;EAC5C;EAEAG,cAAcA,CAACH,KAAc,EAA+B;IAC1D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAEJ;IAAM,CAAC,CAAC;EACzC;EAEAK,aAAaA,CACXL,KAAsD,EACzB;IAC7B,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,SAAS,EAAEN,KAAK,CAACO;IAAO,CAAC,CAAC;EAC/C;EAEAC,KAAKA,CAAA,EAAyB;IAC5B,OAAO;MAAE,GAAG,IAAI,CAACV;IAAQ,CAAC;EAC5B;EAEQG,IAAIA,CAACH,OAA6B,EAA+B;IACvE,OAAO,IAAIF,+BAA+B,CAAC;MACzC,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACO,MAAMW,oBAAuD,GAAGA,CAAA,KACrE,IAAIb,+BAA+B,CAAC,CAAC;AAAAc,OAAA,CAAAD,oBAAA,GAAAA,oBAAA","ignoreList":[]}
+{"version":3,"names":["WixDataRemoveOptionsBuilderImpl","constructor","options","withSuppressHooks","value","copy","suppressHooks","withShowDrafts","showDrafts","withCondition","condition","filter","build","RemoveOptionsBuilder","exports"],"sources":["../../../src/api/WixDataRemoveOptionsBuilder.ts"],"sourcesContent":["import type { FilterExpression } from '@wix/sdk-types'\nimport type {\n  WixDataItem,\n  WixDataQuerySpec,\n  WixDataRemoveOptions,\n} from './types'\n\n/**\n * Builder for remove options used by Wix Data remove operations.\n *\n * Use this builder to configure remove behavior such as hooks suppression,\n * and conditional removal.\n * @public\n * @builder\n * @documentationMaturity preview\n */\nexport interface WixDataRemoveOptionsBuilder {\n  /**\n   * Sets whether remove hooks are suppressed.\n   *\n   * When `true`, the remove operation runs without triggering hooks.\n   */\n  withSuppressHooks(value: boolean): WixDataRemoveOptionsBuilder\n  /**\n   * Sets whether draft items are included when removing items.\n   * @internal\n   */\n  withShowDrafts(value: boolean): WixDataRemoveOptionsBuilder\n  /**\n   * Removes the item only when the specified condition is met.\n   */\n  withCondition(\n    value: FilterExpression<WixDataItem, WixDataQuerySpec>\n  ): WixDataRemoveOptionsBuilder\n  /**\n   * Builds the remove options object.\n   */\n  build(): WixDataRemoveOptions\n}\n\nclass WixDataRemoveOptionsBuilderImpl implements WixDataRemoveOptionsBuilder {\n  constructor(private readonly options: WixDataRemoveOptions = {}) {}\n\n  withSuppressHooks(value: boolean): WixDataRemoveOptionsBuilder {\n    return this.copy({ suppressHooks: value })\n  }\n\n  withShowDrafts(value: boolean): WixDataRemoveOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withCondition(\n    value: FilterExpression<WixDataItem, WixDataQuerySpec>\n  ): WixDataRemoveOptionsBuilder {\n    return this.copy({ condition: value.filter })\n  }\n\n  build(): WixDataRemoveOptions {\n    return { ...this.options }\n  }\n\n  private copy(options: WixDataRemoveOptions): WixDataRemoveOptionsBuilder {\n    return new WixDataRemoveOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData remove options builder.\n * @public\n * @documentationMaturity preview\n *\n * @example\n * ```ts\n * import { items, Filter, RemoveOptionsBuilder } from '@wix/data'\n *\n * const options = RemoveOptionsBuilder()\n *   .withSuppressHooks(true)\n *   .withCondition(Filter('status').eq('active'))\n *   .build()\n *\n * const removedItem = await items.remove<MyItem>(\n *   'myCollection',\n *   'myItemId',\n *   options\n * )\n * ```\n */\nexport const RemoveOptionsBuilder: () => WixDataRemoveOptionsBuilder = () =>\n  new WixDataRemoveOptionsBuilderImpl()\n"],"mappings":";;;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAyBA,MAAMA,+BAA+B,CAAwC;EAC3EC,WAAWA,CAAkBC,OAA6B,GAAG,CAAC,CAAC,EAAE;IAAA,KAApCA,OAA6B,GAA7BA,OAA6B;EAAQ;EAElEC,iBAAiBA,CAACC,KAAc,EAA+B;IAC7D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,aAAa,EAAEF;IAAM,CAAC,CAAC;EAC5C;EAEAG,cAAcA,CAACH,KAAc,EAA+B;IAC1D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAEJ;IAAM,CAAC,CAAC;EACzC;EAEAK,aAAaA,CACXL,KAAsD,EACzB;IAC7B,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,SAAS,EAAEN,KAAK,CAACO;IAAO,CAAC,CAAC;EAC/C;EAEAC,KAAKA,CAAA,EAAyB;IAC5B,OAAO;MAAE,GAAG,IAAI,CAACV;IAAQ,CAAC;EAC5B;EAEQG,IAAIA,CAACH,OAA6B,EAA+B;IACvE,OAAO,IAAIF,+BAA+B,CAAC;MACzC,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMW,oBAAuD,GAAGA,CAAA,KACrE,IAAIb,+BAA+B,CAAC,CAAC;AAAAc,OAAA,CAAAD,oBAAA,GAAAA,oBAAA","ignoreList":[]}

package/dist/cjs/api/WixDataSaveOptionsBuilder.js

@@ -3,8 +3,13 @@
 exports.__esModule = true;
 exports.SaveOptionsBuilder = void 0;
 /**
- * WixData save options builder.
- * @internal
+ * Builder for save options used by Wix Data save operations.
+ *
+ * Use this builder to configure save behavior such as hooks suppression,
+ * and saving reference values.
+ * @public
+ * @builder
+ * @documentationMaturity preview
  */
 
 class WixDataSaveOptionsBuilderImpl {
@@ -46,7 +51,23 @@ class WixDataSaveOptionsBuilderImpl {
 
 /**
  * Creates a new WixData save options builder.
- * @internal
+ * @public
+ * @documentationMaturity preview
+ *
+ * @example
+ * ```ts
+ * import { items, SaveOptionsBuilder } from '@wix/data'
+ *
+ * const options = SaveOptionsBuilder()
+ *   .withSuppressHooks(true)
+ *   .build()
+ *
+ * const savedItem = await items.save<MyItem>(
+ *   'myCollection',
+ *   { _id: 'myItemId', title: 'Updated title' },
+ *   options
+ * )
+ * ```
  */
 const SaveOptionsBuilder = () => new WixDataSaveOptionsBuilderImpl();
 exports.SaveOptionsBuilder = SaveOptionsBuilder;