@wix/auto_sdk_data_collections 1.0.60 → 1.0.62

package/build/cjs/index.typings.d.ts

@@ -722,12 +722,16 @@ interface ArraySizeRange {
 interface FieldPlugin extends FieldPluginOptionsOneOf {
     /** Options for the CMS plugin. */
     cmsOptions?: CmsOptions;
+    /** Options for the CATEGORY_FIELD plugin. */
+    categoryFieldOptions?: CategoryFieldOptions;
     type?: FieldPluginTypeWithLiterals;
 }
 /** @oneof */
 interface FieldPluginOptionsOneOf {
     /** Options for the CMS plugin. */
     cmsOptions?: CmsOptions;
+    /** Options for the CATEGORY_FIELD plugin. */
+    categoryFieldOptions?: CategoryFieldOptions;
 }
 declare enum FieldPluginType {
     /** Uknown plugin type. */
@@ -746,6 +750,17 @@ interface CmsOptions {
      */
     internal?: boolean;
 }
+/** Options for the CATEGORY_FIELD plugin. */
+interface CategoryFieldOptions {
+    /**
+     * Transient input-only flag. When set to `true` during create/update, designates
+     * this category field's group as the target for `_primaryCategory`. The flag is
+     * not persisted; `_primaryCategory` remains the source of truth.
+     *
+     * Default: `false`
+     */
+    isPrimary?: boolean;
+}
 interface FieldCondition {
     /** @maxLength 100 */
     groupName?: string | null;
@@ -2087,7 +2102,6 @@ interface PatchDataCollection {
  * Adds a new field to the structure of a data collection.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
- * @documentationMaturity preview
  * @requiredField dataCollectionId
  * @requiredField options
  * @requiredField options.field
@@ -2115,7 +2129,6 @@ interface CreateDataCollectionFieldOptions {
  * </blockquote>
  * @param dataCollectionId - ID of the data collection to update.
  * @public
- * @documentationMaturity preview
  * @requiredField dataCollectionId
  * @requiredField options
  * @requiredField options.field
@@ -2137,7 +2150,6 @@ interface UpdateDataCollectionFieldOptions {
  * from all items in the collection.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
- * @documentationMaturity preview
  * @requiredField dataCollectionId
  * @requiredField options
  * @requiredField options.fieldKey
@@ -2214,4 +2226,4 @@ interface DeleteDataCollectionPluginOptions {
  */
 declare function patchDataCollectionField(dataCollectionId: string, field: Field): Promise<NonNullablePaths<PatchDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
 
-export { AccessLevel, type AccessLevelWithLiterals, type AccountInfo, type ActionEvent, type AddDataCollectionPluginOptions, type AddDataCollectionPluginRequest, type AddDataCollectionPluginResponse, type Address, type AllowedDataPermissions, type AppOptions, type ApplicationError, type ArrayDocument, type ArraySizeRange, type ArrayString, type Audio, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CatalogOptions, type CmsOptions, type CollectionCapabilities, type CollectionDefinition, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateAppCollectionsSnapshotRequest, type CreateAppCollectionsSnapshotResponse, type CreateDataCollectionFieldOptions, type CreateDataCollectionFieldRequest, type CreateDataCollectionFieldResponse, type CreateDataCollectionRequest, type CreateDataCollectionResponse, type CreateDataCollectionsSnapshotRequest, type CreateDataCollectionsSnapshotResponse, type CreateMigratedCollectionsSnapshotRequest, type CreateMigratedCollectionsSnapshotResponse, type DataCollection, type DataCollectionChangedEvent, type DataCollectionClonedEvent, type DataCollectionEvictedEvent, DataOperation, type DataOperationWithLiterals, type DataPermissions, type Datetime, type DatetimeDefaultValueOneOf, type DatetimeMaxDateOneOf, type DatetimeMinDateOneOf, type DeleteDataCollectionFieldOptions, type DeleteDataCollectionFieldRequest, type DeleteDataCollectionFieldResponse, type DeleteDataCollectionPluginOptions, type DeleteDataCollectionPluginRequest, type DeleteDataCollectionPluginResponse, type DeleteDataCollectionRequest, type DeleteDataCollectionResponse, type DeleteDataCollectionsSnapshotRequest, type DeleteDataCollectionsSnapshotResponse, type Destination, Direction, type DirectionWithLiterals, type Document, type DomainEvent, type DomainEventBodyOneOf, type Email, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EnumValues, type FailedCollection, type Failure, type Field, type FieldCapabilities, type FieldCondition, type FieldPlugin, type FieldPluginOptionsOneOf, FieldPluginType, type FieldPluginTypeWithLiterals, type FieldRangeValidationsOneOf, type FieldUpdate, type FieldsPattern, Format, type FormatWithLiterals, type GetDataCollectionOptions, type GetDataCollectionRequest, type GetDataCollectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type Image, type Index, type IndexField, type IndexLimits, type IndexQuotaLimits, IndexSource, type IndexSourceWithLiterals, IndexStatus, type IndexStatusWithLiterals, type LegacyColor, type ListDataCollectionsOptions, type ListDataCollectionsRequest, type ListDataCollectionsResponse, type MediaGallery, type MessageEnvelope, type MultiReference, type MultilingualOptions, type NumberRange, type ObjectField, Order, type OrderWithLiterals, type PageLink, type PageLinkPluginOptions, PageLinkType, type PageLinkTypeWithLiterals, type Paging, type PagingMetadataV2, PagingMode, type PagingModeWithLiterals, type PatchDataCollection, type PatchDataCollectionFieldRequest, type PatchDataCollectionFieldResponse, type PatchDataCollectionRequest, type PatchDataCollectionResponse, Permission, type PermissionWithLiterals, type Permissions, type Plugin, type PluginCmsOptions, type PluginOptionsOneOf, PluginType, type PluginTypeWithLiterals, type PluginUpdate, type PublishPluginOptions, QueryOperator, type QueryOperatorWithLiterals, type Reference, type RestorationCollection, type RestoreDataCollectionRequest, type RestoreDataCollectionResponse, type RestoreDataCollectionsFromSnapshotRequest, type RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo, type RichContent, type RichText, Role, type RoleWithLiterals, Segment, type SegmentWithLiterals, type SingleItemPluginOptions, type SiteSort, type Slug, type SnapshotCollection, type Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type StringLengthRange, TenantMode, type TenantModeWithLiterals, type Text, type TextValidation, type TextValidationOneOf, type Time, Type, type TypeMetadata, type TypeMetadataMetadataOneOf, type TypeWithLiterals, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type Url, type UrlizedOnlyPattern, type UrlizedPluginOptions, type Video, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, type _Boolean, type _Date, type _DateDefaultValueOneOf, type _DateMaxDateOneOf, type _DateMinDateOneOf, type _Number, type _Object, addDataCollectionPlugin, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, deleteDataCollectionPlugin, getDataCollection, listDataCollections, patchDataCollection, patchDataCollectionField, updateDataCollection, updateDataCollectionField };
+export { AccessLevel, type AccessLevelWithLiterals, type AccountInfo, type ActionEvent, type AddDataCollectionPluginOptions, type AddDataCollectionPluginRequest, type AddDataCollectionPluginResponse, type Address, type AllowedDataPermissions, type AppOptions, type ApplicationError, type ArrayDocument, type ArraySizeRange, type ArrayString, type Audio, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CatalogOptions, type CategoryFieldOptions, type CmsOptions, type CollectionCapabilities, type CollectionDefinition, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateAppCollectionsSnapshotRequest, type CreateAppCollectionsSnapshotResponse, type CreateDataCollectionFieldOptions, type CreateDataCollectionFieldRequest, type CreateDataCollectionFieldResponse, type CreateDataCollectionRequest, type CreateDataCollectionResponse, type CreateDataCollectionsSnapshotRequest, type CreateDataCollectionsSnapshotResponse, type CreateMigratedCollectionsSnapshotRequest, type CreateMigratedCollectionsSnapshotResponse, type DataCollection, type DataCollectionChangedEvent, type DataCollectionClonedEvent, type DataCollectionEvictedEvent, DataOperation, type DataOperationWithLiterals, type DataPermissions, type Datetime, type DatetimeDefaultValueOneOf, type DatetimeMaxDateOneOf, type DatetimeMinDateOneOf, type DeleteDataCollectionFieldOptions, type DeleteDataCollectionFieldRequest, type DeleteDataCollectionFieldResponse, type DeleteDataCollectionPluginOptions, type DeleteDataCollectionPluginRequest, type DeleteDataCollectionPluginResponse, type DeleteDataCollectionRequest, type DeleteDataCollectionResponse, type DeleteDataCollectionsSnapshotRequest, type DeleteDataCollectionsSnapshotResponse, type Destination, Direction, type DirectionWithLiterals, type Document, type DomainEvent, type DomainEventBodyOneOf, type Email, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EnumValues, type FailedCollection, type Failure, type Field, type FieldCapabilities, type FieldCondition, type FieldPlugin, type FieldPluginOptionsOneOf, FieldPluginType, type FieldPluginTypeWithLiterals, type FieldRangeValidationsOneOf, type FieldUpdate, type FieldsPattern, Format, type FormatWithLiterals, type GetDataCollectionOptions, type GetDataCollectionRequest, type GetDataCollectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type Image, type Index, type IndexField, type IndexLimits, type IndexQuotaLimits, IndexSource, type IndexSourceWithLiterals, IndexStatus, type IndexStatusWithLiterals, type LegacyColor, type ListDataCollectionsOptions, type ListDataCollectionsRequest, type ListDataCollectionsResponse, type MediaGallery, type MessageEnvelope, type MultiReference, type MultilingualOptions, type NumberRange, type ObjectField, Order, type OrderWithLiterals, type PageLink, type PageLinkPluginOptions, PageLinkType, type PageLinkTypeWithLiterals, type Paging, type PagingMetadataV2, PagingMode, type PagingModeWithLiterals, type PatchDataCollection, type PatchDataCollectionFieldRequest, type PatchDataCollectionFieldResponse, type PatchDataCollectionRequest, type PatchDataCollectionResponse, Permission, type PermissionWithLiterals, type Permissions, type Plugin, type PluginCmsOptions, type PluginOptionsOneOf, PluginType, type PluginTypeWithLiterals, type PluginUpdate, type PublishPluginOptions, QueryOperator, type QueryOperatorWithLiterals, type Reference, type RestorationCollection, type RestoreDataCollectionRequest, type RestoreDataCollectionResponse, type RestoreDataCollectionsFromSnapshotRequest, type RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo, type RichContent, type RichText, Role, type RoleWithLiterals, Segment, type SegmentWithLiterals, type SingleItemPluginOptions, type SiteSort, type Slug, type SnapshotCollection, type Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type StringLengthRange, TenantMode, type TenantModeWithLiterals, type Text, type TextValidation, type TextValidationOneOf, type Time, Type, type TypeMetadata, type TypeMetadataMetadataOneOf, type TypeWithLiterals, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type Url, type UrlizedOnlyPattern, type UrlizedPluginOptions, type Video, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, type _Boolean, type _Date, type _DateDefaultValueOneOf, type _DateMaxDateOneOf, type _DateMinDateOneOf, type _Number, type _Object, addDataCollectionPlugin, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, deleteDataCollectionPlugin, getDataCollection, listDataCollections, patchDataCollection, patchDataCollectionField, updateDataCollection, updateDataCollectionField };