@wix/auto_sdk_data_collections 1.0.111 → 1.0.113

package/build/cjs/meta.d.ts

@@ -97,6 +97,11 @@ interface DataCollection {
      * @readonly
      */
     updatedDate?: Date | null;
+    /**
+     * Actual data operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`
+     * @readonly
+     */
+    allowedDataPermissions?: AllowedDataPermissions;
     /**
      * Deprecation metadata for this collection. App collections set this metadata to direct users to a replacement collection.
      * @readonly
@@ -378,6 +383,11 @@ declare enum Type {
      * @documentationMaturity preview
      */
     EMAIL = "EMAIL",
+    /**
+     * Secured media object with digital file metadata.
+     * @documentationMaturity preview
+     */
+    SECURED_MEDIA = "SECURED_MEDIA",
     /**
      * Media image object.
      * @documentationMaturity preview
@@ -390,7 +400,7 @@ declare enum Type {
     MEDIA_VECTOR_ART = "MEDIA_VECTOR_ART"
 }
 /** @enumType */
-type TypeWithLiterals = Type | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO' | 'SLUG' | 'EMAIL' | 'MEDIA_IMAGE' | 'MEDIA_VECTOR_ART';
+type TypeWithLiterals = Type | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO' | 'SLUG' | 'EMAIL' | 'SECURED_MEDIA' | 'MEDIA_IMAGE' | 'MEDIA_VECTOR_ART';
 interface TypeMetadata extends TypeMetadataMetadataOneOf {
     /** Metadata for a reference field. */
     reference?: Reference;
@@ -402,6 +412,48 @@ interface TypeMetadata extends TypeMetadataMetadataOneOf {
     array?: _Array;
     /** Metadata for a page link field. */
     pageLink?: PageLink;
+    /** Metadata for a slug field. */
+    slug?: Slug;
+    /** Metadata for TEXT. */
+    text?: Text;
+    /** Metadata for NUMBER. */
+    number?: _Number;
+    /** Metadata for DATE. */
+    date?: _Date;
+    /** Metadata for DATETIME. */
+    datetime?: Datetime;
+    /** Metadata for IMAGE. */
+    image?: Image;
+    /** Metadata for BOOLEAN. */
+    boolean?: _Boolean;
+    /** Metadata for DOCUMENT. */
+    document?: Document;
+    /** Metadata for URL. */
+    url?: Url;
+    /** Metadata for RICH_TEXT. */
+    richText?: RichText;
+    /** Metadata for VIDEO. */
+    video?: Video;
+    /** Metadata for ARRAY_STRING. */
+    arrayString?: ArrayString;
+    /** Metadata for ARRAY_DOCUMENT. */
+    arrayDocument?: ArrayDocument;
+    /** Metadata for AUDIO. */
+    audio?: Audio;
+    /** Metadata for TIME. */
+    time?: Time;
+    /** Metadata for RICH_CONTENT. */
+    richContent?: RichContent;
+    /** Metadata for MEDIA_GALLERY. */
+    mediaGallery?: MediaGallery;
+    /** Metadata for ADDRESS. */
+    address?: Address;
+    /** Metadata for EMAIL. */
+    email?: Email;
+    /** Metadata for LEGACY_COLOR. */
+    legacyColor?: LegacyColor;
+    /** Metadata for MEDIA_IMAGE. */
+    mediaImage?: MediaImage;
 }
 /** @oneof */
 interface TypeMetadataMetadataOneOf {
@@ -415,6 +467,48 @@ interface TypeMetadataMetadataOneOf {
     array?: _Array;
     /** Metadata for a page link field. */
     pageLink?: PageLink;
+    /** Metadata for a slug field. */
+    slug?: Slug;
+    /** Metadata for TEXT. */
+    text?: Text;
+    /** Metadata for NUMBER. */
+    number?: _Number;
+    /** Metadata for DATE. */
+    date?: _Date;
+    /** Metadata for DATETIME. */
+    datetime?: Datetime;
+    /** Metadata for IMAGE. */
+    image?: Image;
+    /** Metadata for BOOLEAN. */
+    boolean?: _Boolean;
+    /** Metadata for DOCUMENT. */
+    document?: Document;
+    /** Metadata for URL. */
+    url?: Url;
+    /** Metadata for RICH_TEXT. */
+    richText?: RichText;
+    /** Metadata for VIDEO. */
+    video?: Video;
+    /** Metadata for ARRAY_STRING. */
+    arrayString?: ArrayString;
+    /** Metadata for ARRAY_DOCUMENT. */
+    arrayDocument?: ArrayDocument;
+    /** Metadata for AUDIO. */
+    audio?: Audio;
+    /** Metadata for TIME. */
+    time?: Time;
+    /** Metadata for RICH_CONTENT. */
+    richContent?: RichContent;
+    /** Metadata for MEDIA_GALLERY. */
+    mediaGallery?: MediaGallery;
+    /** Metadata for ADDRESS. */
+    address?: Address;
+    /** Metadata for EMAIL. */
+    email?: Email;
+    /** Metadata for LEGACY_COLOR. */
+    legacyColor?: LegacyColor;
+    /** Metadata for MEDIA_IMAGE. */
+    mediaImage?: MediaImage;
 }
 interface FieldCapabilities {
     /**
@@ -549,12 +643,19 @@ interface _Object {
      * @maxSize 1000
      */
     fields?: ObjectField[];
+    /** Value assigned when a data item omits this field. */
+    defaultValue?: Record<string, any> | null;
 }
 interface _Array {
     /** Element's data type. */
     elementType?: TypeWithLiterals;
     /** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
     typeMetadata?: TypeMetadata;
+    /** Minimum permitted number of items in an array field. */
+    minSize?: number | null;
+    /** Maximum permitted number of items in an array field. */
+    maxSize?: number | null;
+    defaultValue?: any[];
 }
 interface PageLink {
     /** Calculation pattern used to generate the page link. Required for page link fields. */
@@ -564,6 +665,8 @@ interface PageLink {
      * @maxLength 1000
      */
     linkedRouterPage?: string | null;
+    /** Defines the type of the page link. */
+    pageLinkType?: PageLinkTypeWithLiterals;
 }
 interface Slug {
     /**
@@ -572,6 +675,11 @@ interface Slug {
      * @maxLength 1000
      */
     pattern?: string;
+    /** Minimum permitted length for a string field. */
+    minLength?: number | null;
+    /** Maximum permitted length for a string field. */
+    maxLength?: number | null;
+    defaultValue?: string | null;
 }
 interface Text extends TextValidationOneOf {
     /** Length and pattern constraints for the text value. */
@@ -821,10 +929,16 @@ declare enum FieldPluginType {
     /** Unknown plugin type. */
     UNKNOWN = "UNKNOWN",
     /** CMS-related field attributes. */
-    CMS = "CMS"
+    CMS = "CMS",
+    /** Marks a multi-reference field as a category field linking to a Category Group. */
+    CATEGORY_FIELD = "CATEGORY_FIELD",
+    /** Marks a back-reference field on Category Groups indicating a consumer relationship. */
+    CATEGORY_CONSUMER = "CATEGORY_CONSUMER",
+    /** Marks the auto-managed primary category single-reference field on a consumer collection. */
+    PRIMARY_CATEGORY_FIELD = "PRIMARY_CATEGORY_FIELD"
 }
 /** @enumType */
-type FieldPluginTypeWithLiterals = FieldPluginType | 'UNKNOWN' | 'CMS';
+type FieldPluginTypeWithLiterals = FieldPluginType | 'UNKNOWN' | 'CMS' | 'CATEGORY_FIELD' | 'CATEGORY_CONSUMER' | 'PRIMARY_CATEGORY_FIELD';
 /** Options for the CMS plugin. */
 interface CmsOptions {
     /**
@@ -918,6 +1032,10 @@ interface Plugin extends PluginOptionsOneOf {
     editablePageLinkOptions?: PageLinkPluginOptions;
     /** Options for the CMS plugin. */
     cmsOptions?: PluginCmsOptions;
+    /** Options for the Catalog plugin. */
+    catalogOptions?: CatalogOptions;
+    /** Options for the Draft Items plugin. */
+    draftItemsOptions?: DraftItemsPluginOptions;
     /** Plugin type. */
     type?: PluginTypeWithLiterals;
 }
@@ -938,6 +1056,10 @@ interface PluginOptionsOneOf {
     editablePageLinkOptions?: PageLinkPluginOptions;
     /** Options for the CMS plugin. */
     cmsOptions?: PluginCmsOptions;
+    /** Options for the Catalog plugin. */
+    catalogOptions?: CatalogOptions;
+    /** Options for the Draft Items plugin. */
+    draftItemsOptions?: DraftItemsPluginOptions;
 }
 declare enum Status {
     /** Items are published by default. */
@@ -988,6 +1110,23 @@ declare enum AccessLevel {
 /** @enumType */
 type AccessLevelWithLiterals = AccessLevel | 'ANYONE' | 'SITE_MEMBER' | 'SITE_MEMBER_AUTHOR' | 'CMS_EDITOR' | 'PRIVILEGED';
 interface DraftPermissions {
+    /**
+     * Access level required to view/edit/remove items from the drafts collection.
+     * Can be set to one of CMS_EDITOR, PRIVILEGED
+     * Default: `CMS_EDITOR`
+     */
+    manageDrafts?: AccessLevelWithLiterals;
+    /**
+     * Access level required to publish draft items and unpublish published items.
+     * Can be set to one of CMS_EDITOR, PRIVILEGED
+     * Default: `CMS_EDITOR`
+     */
+    managePublishStatus?: AccessLevelWithLiterals;
+    /**
+     * Access level required to view draft items. Managing drafts also grants viewing.
+     * If omitted, inherits manage_drafts for compatibility.
+     */
+    viewDrafts?: AccessLevelWithLiterals;
 }
 interface AllowedDraftPermissions {
     /** If manage_drafts is permitted for the caller. */
@@ -1013,10 +1152,16 @@ declare enum PluginType {
     /** Indicates that page link fields are persisted and can be updated. */
     EDITABLE_PAGE_LINK = "EDITABLE_PAGE_LINK",
     /** CMS-specific collection properties. */
-    CMS = "CMS"
+    CMS = "CMS",
+    /** Indicates that the collection is used as a [Wix Catalog](https://dev.wix.com/docs/rest/business-solutions/e-commerce/catalogs/catalog-service-plugin/introduction) app. This plugin is used to manage product data and is required for collections that are part of a catalog. */
+    CATALOG = "CATALOG",
+    /** Marks the collection as a Category Group for categorization features. */
+    CATEGORIES = "CATEGORIES",
+    /** Enables the draft items collection: safe draft editing with explicit publish step. */
+    DRAFT_ITEMS = "DRAFT_ITEMS"
 }
 /** @enumType */
-type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
+type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS' | 'CATALOG' | 'CATEGORIES' | 'DRAFT_ITEMS';
 interface PublishPluginOptions {
     /**
      * Publication status assigned to items that don't specify one.
@@ -1235,6 +1380,19 @@ interface DraftItemsPluginOptions extends DraftItemsPluginOptionsPairedCollectio
      * @readonly
      */
     publishedCollectionId?: string;
+    /** Access levels required to view and manage drafts and change publication status. */
+    draftPermissions?: DraftPermissions;
+    /**
+     * Actual draft management operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`.
+     * @readonly
+     */
+    allowedPermissions?: AllowedDraftPermissions;
+    /**
+     * Whether writes to the published collection are allowed while the Draft Items plugin is enabled.
+     * Defaults to `false` for newly created collections and newly added plugins.
+     * Existing schemas that predate this field return `true` for backwards compatibility.
+     */
+    allowWritesToPublishedCollection?: boolean;
 }
 /** @oneof */
 interface DraftItemsPluginOptionsPairedCollectionOneOf {
@@ -1407,6 +1565,8 @@ interface GetDataCollectionRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /** If set allowed for caller data permissions would be included in the response */
+    includeAllowedDataPermissions?: boolean;
     /**
      * Top-level collection properties to return, using camelCase names, such as `displayName`.
      * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
@@ -1450,6 +1610,8 @@ interface ListDataCollectionsRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /** If set allowed for caller data permissions would be included in the response */
+    includeAllowedDataPermissions?: boolean;
     /**
      * Top-level collection properties to return, using camelCase names, such as `displayName`.
      * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
@@ -1532,6 +1694,8 @@ interface BulkGetDataCollectionsRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /** If set allowed for caller data permissions would be included in the response */
+    includeAllowedDataPermissions?: boolean;
     /**
      * Top-level collection properties to return, using camelCase names, such as `displayName`.
      * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.

package/build/cjs/meta.js

@@ -286,13 +286,13 @@ function resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl
         srcPath: "/_api/cloud-data/v1/schemas",
         destPath: "/v1/schemas"
       },
-      {
-        srcPath: "/_api/cloud-data/v2/collections",
-        destPath: "/v2/collections"
-      },
       {
         srcPath: "/_api/cloud-data/v2/bulk/collections",
         destPath: "/v2/bulk/collections"
+      },
+      {
+        srcPath: "/_api/cloud-data/v2/collections",
+        destPath: "/v2/collections"
       }
     ],
     "wixbo.ai": [
@@ -300,13 +300,13 @@ function resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl
         srcPath: "/_api/cloud-data/v1/schemas",
         destPath: "/v1/schemas"
       },
-      {
-        srcPath: "/_api/cloud-data/v2/collections",
-        destPath: "/v2/collections"
-      },
       {
         srcPath: "/_api/cloud-data/v2/bulk/collections",
         destPath: "/v2/bulk/collections"
+      },
+      {
+        srcPath: "/_api/cloud-data/v2/collections",
+        destPath: "/v2/collections"
       }
     ],
     "wix-bo.com": [
@@ -314,13 +314,13 @@ function resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl
         srcPath: "/_api/cloud-data/v1/schemas",
         destPath: "/v1/schemas"
       },
-      {
-        srcPath: "/_api/cloud-data/v2/collections",
-        destPath: "/v2/collections"
-      },
       {
         srcPath: "/_api/cloud-data/v2/bulk/collections",
         destPath: "/v2/bulk/collections"
+      },
+      {
+        srcPath: "/_api/cloud-data/v2/collections",
+        destPath: "/v2/collections"
       }
     ],
     "cloud-data.wix-code.com": [
@@ -370,13 +370,13 @@ function resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl
         srcPath: "/_api/cloud-data/v1/schemas",
         destPath: "/v1/schemas"
       },
-      {
-        srcPath: "/_api/cloud-data/v2/collections",
-        destPath: "/v2/collections"
-      },
       {
         srcPath: "/_api/cloud-data/v2/bulk/collections",
         destPath: "/v2/bulk/collections"
+      },
+      {
+        srcPath: "/_api/cloud-data/v2/collections",
+        destPath: "/v2/collections"
       }
     ],
     "*.dev.wix-code.com": [