@wix/auto_sdk_data_collections 1.0.38 → 1.0.39

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

@@ -1184,7 +1184,7 @@ interface SnapshotCollection {
 /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
 interface Index {
     /**
-     * Id of the index.
+     * ID of the index.
      * @readonly
      * @format GUID
      */
@@ -1214,8 +1214,8 @@ interface Index {
      */
     failure?: Failure;
     /**
-     * Whether the index enforces uniqueness of values in the field for which it is defined.
-     * If `true`, the index can have only one field.
+     * Whether the index enforces uniqueness of values in the field for which it's defined.
+     * If `true`, the index can have only 1 field.
      *
      * Default: `false`
      */
@@ -1226,7 +1226,11 @@ interface Index {
      * Default: `false`
      */
     caseInsensitive?: boolean;
-    /** Specifies the origin of the index definition. */
+    /**
+     * Source of the index. See index sources in [Index Types](https://dev.wix.com/docs/api-reference/business-solutions/cms/indexes/index-types#index-sources).
+     *
+     * Default: `USER`
+     */
     source?: IndexSourceWithLiterals;
 }
 /**
@@ -1295,11 +1299,22 @@ interface Failure {
 declare enum IndexSource {
     /** Place holder. Never returned by the service. */
     UNKNOWN_INDEX_SOURCE = "UNKNOWN_INDEX_SOURCE",
-    /** Index is created by the system, present for all collections. */
+    /**
+     * Automatically created by Wix for all collections.
+     *
+     * System indexes are created for essential attributes, such as ID and creation date.
+     * You can't delete them and they don't count towards the index limit.
+     */
     SYSTEM = "SYSTEM",
-    /** Index was created by a user via API or UI. */
+    /** Created by a Wix user via the API or in the dashboard. */
     USER = "USER",
-    /** Index is created automatically by the system based on user queries. */
+    /**
+     * Created automatically by Wix based on a Wix user's queries.
+     *
+     * For large collections, Wix identifies slow-running queries and creates indexes automatically to improve performance.
+     * These indexes don't count towards the index limit. They're created dynamically, and may be deleted if they no longer fit
+     * the system's parameters. To keep an automatic index permanently, manually create an identical `USER` index.
+     */
     AUTO = "AUTO"
 }
 /** @enumType */