arangojs 8.7.0 → 8.8.1

package/collection.d.ts

@@ -17,7 +17,7 @@ import { ArangoApiResponse } from "./connection";
 import { ArrayCursor } from "./cursor";
 import { Database } from "./database";
 import { Document, DocumentData, DocumentMetadata, DocumentSelector, Edge, EdgeData, ObjectWithKey, Patch } from "./documents";
-import { EnsureFulltextIndexOptions, EnsureGeoIndexOptions, EnsureInvertedIndexOptions, EnsurePersistentIndexOptions, EnsureTtlIndexOptions, EnsureZkdIndexOptions, FulltextIndex, GeoIndex, Index, IndexSelector, InvertedIndex, PersistentIndex, TtlIndex, ZkdIndex } from "./indexes";
+import { EnsureFulltextIndexOptions, EnsureGeoIndexOptions, EnsureInvertedIndexOptions, EnsurePersistentIndexOptions, EnsureTtlIndexOptions, EnsureMdiIndexOptions, FulltextIndex, GeoIndex, Index, IndexSelector, InvertedIndex, PersistentIndex, TtlIndex, MdiIndex } from "./indexes";
 import { Blob } from "./lib/blob";
 /**
  * Indicates whether the given value represents an {@link ArangoCollection}.
@@ -71,11 +71,11 @@ export declare enum CollectionStatus {
 /**
  * Type of key generator.
  */
-export declare type KeyGenerator = "traditional" | "autoincrement" | "uuid" | "padded";
+export type KeyGenerator = "traditional" | "autoincrement" | "uuid" | "padded";
 /**
  * Strategy for sharding a collection.
  */
-export declare type ShardingStrategy = "hash" | "enterprise-hash-smart-edge" | "enterprise-hash-smart-vertex" | "community-compat" | "enterprise-compat" | "enterprise-smart-edge-compat";
+export type ShardingStrategy = "hash" | "enterprise-hash-smart-edge" | "enterprise-hash-smart-vertex" | "community-compat" | "enterprise-compat" | "enterprise-smart-edge-compat";
 /**
  * Type of document reference.
  *
@@ -84,7 +84,7 @@ export declare type ShardingStrategy = "hash" | "enterprise-hash-smart-edge" | "
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
  */
-export declare type SimpleQueryListType = "id" | "key" | "path";
+export type SimpleQueryListType = "id" | "key" | "path";
 /**
  * When a validation should be applied.
  *
@@ -94,15 +94,41 @@ export declare type SimpleQueryListType = "id" | "key" | "path";
  *   document was already invalid.
  * * `"strict"`: New and modified documents are always validated.
  */
-export declare type ValidationLevel = "none" | "new" | "moderate" | "strict";
+export type ValidationLevel = "none" | "new" | "moderate" | "strict";
 /**
  * Write operation that can result in a computed value being computed.
  */
-export declare type WriteOperation = "insert" | "update" | "replace";
+export type WriteOperation = "insert" | "update" | "replace";
+/**
+ * Represents a bulk operation failure for an individual document.
+ */
+export type DocumentOperationFailure = {
+    /**
+     * Indicates that the operation failed.
+     */
+    error: true;
+    /**
+     * Human-readable description of the failure.
+     */
+    errorMessage: string;
+    /**
+     * Numeric representation of the failure.
+     */
+    errorNum: number;
+};
+/**
+ * Metadata returned by a document operation.
+ */
+export type DocumentOperationMetadata = DocumentMetadata & {
+    /**
+     * Revision of the document that was updated or replaced by this operation.
+     */
+    _oldRev?: string;
+};
 /**
  * Properties defining a computed value.
  */
-export declare type ComputedValueProperties = {
+export type ComputedValueProperties = {
     /**
      * Name of the target attribute of the computed value.
      */
@@ -135,7 +161,7 @@ export declare type ComputedValueProperties = {
 /**
  * General information about a collection.
  */
-export declare type CollectionMetadata = {
+export type CollectionMetadata = {
     /**
      * Collection name.
      */
@@ -162,7 +188,7 @@ export declare type CollectionMetadata = {
 /**
  * An object defining the collection's key generation.
  */
-export declare type CollectionKeyProperties = {
+export type CollectionKeyProperties = {
     /**
      * Type of key generator to use.
      */
@@ -187,7 +213,7 @@ export declare type CollectionKeyProperties = {
 /**
  * Properties for validating documents in a collection.
  */
-export declare type SchemaProperties = {
+export type SchemaProperties = {
     /**
      * Type of document validation.
      */
@@ -208,7 +234,7 @@ export declare type SchemaProperties = {
 /**
  * An object defining the properties of a collection.
  */
-export declare type CollectionProperties = {
+export type CollectionProperties = {
     /**
      * A human-readable representation of the collection loading status.
      */
@@ -287,7 +313,7 @@ export declare type CollectionProperties = {
 /**
  * Options for creating a computed value.
  */
-export declare type ComputedValueOptions = {
+export type ComputedValueOptions = {
     /**
      * Name of the target attribute of the computed value.
      */
@@ -330,7 +356,7 @@ export declare type ComputedValueOptions = {
 /**
  * Options for validating collection documents.
  */
-export declare type SchemaOptions = {
+export type SchemaOptions = {
     /**
      * JSON Schema description of the validation schema for documents.
      */
@@ -351,7 +377,7 @@ export declare type SchemaOptions = {
  *
  * See {@link DocumentCollection#properties} and {@link EdgeCollection#properties}.
  */
-export declare type CollectionPropertiesOptions = {
+export type CollectionPropertiesOptions = {
     /**
      * Whether data should be synchronized to disk before returning from
      * a document create, update, replace or removal operation.
@@ -386,7 +412,7 @@ export declare type CollectionPropertiesOptions = {
 /**
  * Options for retrieving a collection checksum.
  */
-export declare type CollectionChecksumOptions = {
+export type CollectionChecksumOptions = {
     /**
      * If set to `true`, revision IDs will be included in the calculation
      * of the checksum.
@@ -405,7 +431,7 @@ export declare type CollectionChecksumOptions = {
 /**
  * Options for dropping collections.
  */
-export declare type CollectionDropOptions = {
+export type CollectionDropOptions = {
     /**
      * Whether the collection is a system collection. If the collection is a
      * system collection, this option must be set to `true` or ArangoDB will
@@ -418,7 +444,7 @@ export declare type CollectionDropOptions = {
 /**
  * An object defining the collection's key generation.
  */
-export declare type CollectionKeyOptions = {
+export type CollectionKeyOptions = {
     /**
      * Type of key generator to use.
      */
@@ -445,7 +471,7 @@ export declare type CollectionKeyOptions = {
  * See {@link database.Database#createCollection}, {@link database.Database#createEdgeCollection}
  * and {@link DocumentCollection#create} or {@link EdgeCollection#create}.
  */
-export declare type CreateCollectionOptions = {
+export type CreateCollectionOptions = {
     /**
      * If set to `true`, data will be synchronized to disk before returning from
      * a document create, update, replace or removal operation.
@@ -538,7 +564,7 @@ export declare type CreateCollectionOptions = {
 /**
  * Options for checking whether a document exists in a collection.
  */
-export declare type DocumentExistsOptions = {
+export type DocumentExistsOptions = {
     /**
      * If set to a document revision, the document will only match if its `_rev`
      * matches the given revision.
@@ -553,7 +579,7 @@ export declare type DocumentExistsOptions = {
 /**
  * Options for retrieving a document from a collection.
  */
-export declare type CollectionReadOptions = {
+export type CollectionReadOptions = {
     /**
      * If set to `true`, `null` is returned instead of an exception being thrown
      * if the document does not exist.
@@ -580,7 +606,7 @@ export declare type CollectionReadOptions = {
 /**
  * Options for retrieving multiple documents from a collection.
  */
-export declare type CollectionBatchReadOptions = {
+export type CollectionBatchReadOptions = {
     /**
      * If set to `true`, the request will explicitly permit ArangoDB to return a
      * potentially dirty or stale result and arangojs will load balance the
@@ -591,7 +617,7 @@ export declare type CollectionBatchReadOptions = {
 /**
  * Options for inserting a new document into a collection.
  */
-export declare type CollectionInsertOptions = {
+export type CollectionInsertOptions = {
     /**
      * If set to `true`, data will be synchronized to disk before returning.
      *
@@ -644,11 +670,18 @@ export declare type CollectionInsertOptions = {
      * Default: `false`
      */
     refillIndexCaches?: boolean;
+    /**
+     * If set, the attribute with the name specified by the option is looked up
+     * in the stored document and the attribute value is compared numerically to
+     * the value of the versioning attribute in the supplied document that is
+     * supposed to update/replace it.
+     */
+    versionAttribute?: string;
 };
 /**
  * Options for replacing an existing document in a collection.
  */
-export declare type CollectionReplaceOptions = {
+export type CollectionReplaceOptions = {
     /**
      * If set to `true`, data will be synchronized to disk before returning.
      *
@@ -696,11 +729,18 @@ export declare type CollectionReplaceOptions = {
      * Default: `false`
      */
     refillIndexCaches?: boolean;
+    /**
+     * If set, the attribute with the name specified by the option is looked up
+     * in the stored document and the attribute value is compared numerically to
+     * the value of the versioning attribute in the supplied document that is
+     * supposed to update/replace it.
+     */
+    versionAttribute?: string;
 };
 /**
  * Options for updating a document in a collection.
  */
-export declare type CollectionUpdateOptions = {
+export type CollectionUpdateOptions = {
     /**
      * If set to `true`, data will be synchronized to disk before returning.
      *
@@ -763,11 +803,18 @@ export declare type CollectionUpdateOptions = {
      * Default: `false`
      */
     refillIndexCaches?: boolean;
+    /**
+     * If set, the attribute with the name specified by the option is looked up
+     * in the stored document and the attribute value is compared numerically to
+     * the value of the versioning attribute in the supplied document that is
+     * supposed to update/replace it.
+     */
+    versionAttribute?: string;
 };
 /**
  * Options for removing a document from a collection.
  */
-export declare type CollectionRemoveOptions = {
+export type CollectionRemoveOptions = {
     /**
      * If set to `true`, changes will be synchronized to disk before returning.
      *
@@ -805,7 +852,7 @@ export declare type CollectionRemoveOptions = {
 /**
  * Options for bulk importing documents into a collection.
  */
-export declare type CollectionImportOptions = {
+export type CollectionImportOptions = {
     /**
      * (Edge collections only.) Prefix to prepend to `_from` attribute values.
      */
@@ -849,7 +896,7 @@ export declare type CollectionImportOptions = {
 /**
  * Options for retrieving a document's edges from a collection.
  */
-export declare type CollectionEdgesOptions = {
+export type CollectionEdgesOptions = {
     /**
      * If set to `true`, the request will explicitly permit ArangoDB to return a
      * potentially dirty or stale result and arangojs will load balance the
@@ -863,7 +910,7 @@ export declare type CollectionEdgesOptions = {
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
  */
-export declare type SimpleQueryByExampleOptions = {
+export type SimpleQueryByExampleOptions = {
     /**
      * Number of documents to skip in the query.
      */
@@ -895,7 +942,7 @@ export declare type SimpleQueryByExampleOptions = {
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
  */
-export declare type SimpleQueryAllOptions = {
+export type SimpleQueryAllOptions = {
     /**
      * Number of documents to skip in the query.
      */
@@ -933,7 +980,7 @@ export declare type SimpleQueryAllOptions = {
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
  */
-export declare type SimpleQueryUpdateByExampleOptions = {
+export type SimpleQueryUpdateByExampleOptions = {
     /**
      * If set to `false`, properties with a value of `null` will be removed from
      * the new document.
@@ -967,7 +1014,7 @@ export declare type SimpleQueryUpdateByExampleOptions = {
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
  */
-export declare type SimpleQueryRemoveByExampleOptions = {
+export type SimpleQueryRemoveByExampleOptions = {
     /**
      * If set to `true`, the request will wait until all modifications have been
      * synchronized to disk before returning successfully.
@@ -986,14 +1033,14 @@ export declare type SimpleQueryRemoveByExampleOptions = {
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
  */
-export declare type SimpleQueryReplaceByExampleOptions = SimpleQueryRemoveByExampleOptions;
+export type SimpleQueryReplaceByExampleOptions = SimpleQueryRemoveByExampleOptions;
 /**
  * Options for removing documents by keys.
  *
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
  */
-export declare type SimpleQueryRemoveByKeysOptions = {
+export type SimpleQueryRemoveByKeysOptions = {
     /**
      * If set to `true`, the complete old document will be returned as the `old`
      * property on the result object. Has no effect if `silent` is set to `true`.
@@ -1022,7 +1069,7 @@ export declare type SimpleQueryRemoveByKeysOptions = {
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
  */
-export declare type SimpleQueryFulltextOptions = {
+export type SimpleQueryFulltextOptions = {
     /**
      * Unique identifier of the fulltext index to use to perform the query.
      */
@@ -1042,7 +1089,7 @@ export declare type SimpleQueryFulltextOptions = {
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and are
  * no longer supported in ArangoDB 3.12. They can be replaced with AQL queries.
  */
-export declare type TraversalOptions = {
+export type TraversalOptions = {
     /**
      * A string evaluating to the body of a JavaScript function to be executed
      * on the server to initialize the traversal result object.
@@ -1183,7 +1230,7 @@ export declare type TraversalOptions = {
 /**
  * Result of a collection bulk import.
  */
-export declare type CollectionImportResult = {
+export type CollectionImportResult = {
     /**
      * Whether the import failed.
      */
@@ -1216,7 +1263,7 @@ export declare type CollectionImportResult = {
 /**
  * Result of retrieving edges in a collection.
  */
-export declare type CollectionEdgesResult<T extends Record<string, any> = any> = {
+export type CollectionEdgesResult<T extends Record<string, any> = any> = {
     edges: Edge<T>[];
     stats: {
         scannedIndex: number;
@@ -1231,7 +1278,7 @@ export declare type CollectionEdgesResult<T extends Record<string, any> = any> =
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
  */
-export declare type SimpleQueryRemoveByExampleResult = {
+export type SimpleQueryRemoveByExampleResult = {
     /**
      * Number of documents removed.
      */
@@ -1245,7 +1292,7 @@ export declare type SimpleQueryRemoveByExampleResult = {
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
  */
-export declare type SimpleQueryReplaceByExampleResult = {
+export type SimpleQueryReplaceByExampleResult = {
     /**
      * Number of documents replaced.
      */
@@ -1259,7 +1306,7 @@ export declare type SimpleQueryReplaceByExampleResult = {
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
  */
-export declare type SimpleQueryUpdateByExampleResult = {
+export type SimpleQueryUpdateByExampleResult = {
     /**
      * Number of documents updated.
      */
@@ -1273,7 +1320,7 @@ export declare type SimpleQueryUpdateByExampleResult = {
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
  */
-export declare type SimpleQueryRemoveByKeysResult<T extends Record<string, any> = any> = {
+export type SimpleQueryRemoveByKeysResult<T extends Record<string, any> = any> = {
     /**
      * Number of documents removed.
      */
@@ -1724,8 +1771,9 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * console.log(result.new.color, result.new.count); // "blue" 1
      * ```
      */
-    save(data: DocumentData<T>, options?: CollectionInsertOptions): Promise<DocumentMetadata & {
+    save(data: DocumentData<T>, options?: CollectionInsertOptions): Promise<DocumentOperationMetadata & {
         new?: Document<T>;
+        old?: Document<T>;
     }>;
     /**
      * Inserts new documents with the given `data` into the collection.
@@ -1748,9 +1796,10 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * console.log(result[1].new.color, result[1].new.count); // "red" 2
      * ```
      */
-    saveAll(data: Array<DocumentData<T>>, options?: CollectionInsertOptions): Promise<Array<DocumentMetadata & {
+    saveAll(data: Array<DocumentData<T>>, options?: CollectionInsertOptions): Promise<Array<(DocumentOperationMetadata & {
         new?: Document<T>;
-    }>>;
+        old?: Document<T>;
+    }) | DocumentOperationFailure>>;
     /**
      * Replaces an existing document in the collection.
      *
@@ -1775,7 +1824,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * console.log(result.new.color, result.new.count); // "red" undefined
      * ```
      */
-    replace(selector: DocumentSelector, newData: DocumentData<T>, options?: CollectionReplaceOptions): Promise<DocumentMetadata & {
+    replace(selector: DocumentSelector, newData: DocumentData<T>, options?: CollectionReplaceOptions): Promise<DocumentOperationMetadata & {
         new?: Document<T>;
         old?: Document<T>;
     }>;
@@ -1807,10 +1856,10 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
         _key: string;
     } | {
         _id: string;
-    })>, options?: Omit<CollectionReplaceOptions, "ifMatch">): Promise<Array<DocumentMetadata & {
+    })>, options?: Omit<CollectionReplaceOptions, "ifMatch">): Promise<Array<(DocumentOperationMetadata & {
         new?: Document<T>;
         old?: Document<T>;
-    }>>;
+    }) | DocumentOperationFailure>>;
     /**
      * Updates an existing document in the collection.
      *
@@ -1835,7 +1884,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * console.log(result.new.color, result.new.count); // "blue" 2
      * ```
      */
-    update(selector: DocumentSelector, newData: Patch<DocumentData<T>>, options?: CollectionUpdateOptions): Promise<DocumentMetadata & {
+    update(selector: DocumentSelector, newData: Patch<DocumentData<T>>, options?: CollectionUpdateOptions): Promise<DocumentOperationMetadata & {
         new?: Document<T>;
         old?: Document<T>;
     }>;
@@ -1867,10 +1916,10 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
         _key: string;
     } | {
         _id: string;
-    })>, options?: Omit<CollectionUpdateOptions, "ifMatch">): Promise<Array<DocumentMetadata & {
+    })>, options?: Omit<CollectionUpdateOptions, "ifMatch">): Promise<Array<(DocumentOperationMetadata & {
         new?: Document<T>;
         old?: Document<T>;
-    }>>;
+    }) | DocumentOperationFailure>>;
     /**
      * Removes an existing document from the collection.
      *
@@ -1919,9 +1968,9 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // document with keys "abc123" and "def456" deleted
      * ```
      */
-    removeAll(selectors: (string | ObjectWithKey)[], options?: Omit<CollectionRemoveOptions, "ifMatch">): Promise<Array<DocumentMetadata & {
+    removeAll(selectors: (string | ObjectWithKey)[], options?: Omit<CollectionRemoveOptions, "ifMatch">): Promise<Array<(DocumentMetadata & {
         old?: Document<T>;
-    }>>;
+    }) | DocumentOperationFailure>>;
     /**
      * Bulk imports the given `data` into the collection.
      *
@@ -2402,14 +2451,14 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * const collection = db.collection("some-points");
      * // Create a multi-dimensional index for the attributes x, y and z
      * await collection.ensureIndex({
-     *   type: "zkd",
+     *   type: "mdi",
      *   fields: ["x", "y", "z"],
      *   fieldValueTypes: "double"
      * });
      * ```
      * ```
      */
-    ensureIndex(details: EnsureZkdIndexOptions): Promise<ArangoApiResponse<ZkdIndex & {
+    ensureIndex(details: EnsureMdiIndexOptions): Promise<ArangoApiResponse<MdiIndex & {
         isNewlyCreated: boolean;
     }>>;
     /**
@@ -2638,8 +2687,9 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      * );
      * ```
      */
-    save(data: EdgeData<T>, options?: CollectionInsertOptions): Promise<DocumentMetadata & {
+    save(data: EdgeData<T>, options?: CollectionInsertOptions): Promise<DocumentOperationMetadata & {
         new?: Edge<T>;
+        old?: Edge<T>;
     }>;
     /**
      * Inserts new documents with the given `data` into the collection.
@@ -2660,9 +2710,10 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      * );
      * ```
      */
-    saveAll(data: Array<EdgeData<T>>, options?: CollectionInsertOptions): Promise<Array<DocumentMetadata & {
+    saveAll(data: Array<EdgeData<T>>, options?: CollectionInsertOptions): Promise<Array<(DocumentOperationMetadata & {
         new?: Edge<T>;
-    }>>;
+        old?: Edge<T>;
+    }) | DocumentOperationFailure>>;
     /**
      * Replaces an existing document in the collection.
      *
@@ -2695,7 +2746,7 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      * console.log(result.new.active, result.new.best); // false undefined
      * ```
      */
-    replace(selector: DocumentSelector, newData: DocumentData<T>, options?: CollectionReplaceOptions): Promise<DocumentMetadata & {
+    replace(selector: DocumentSelector, newData: DocumentData<T>, options?: CollectionReplaceOptions): Promise<DocumentOperationMetadata & {
         new?: Edge<T>;
         old?: Edge<T>;
     }>;
@@ -2743,10 +2794,10 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
         _key: string;
     } | {
         _id: string;
-    })>, options?: CollectionReplaceOptions): Promise<Array<DocumentMetadata & {
+    })>, options?: CollectionReplaceOptions): Promise<Array<(DocumentOperationMetadata & {
         new?: Edge<T>;
         old?: Edge<T>;
-    }>>;
+    }) | DocumentOperationFailure>>;
     /**
      * Updates an existing document in the collection.
      *
@@ -2779,7 +2830,7 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      * console.log(result.new.active, result.new.best); // false true
      * ```
      */
-    update(selector: DocumentSelector, newData: Patch<DocumentData<T>>, options?: CollectionUpdateOptions): Promise<DocumentMetadata & {
+    update(selector: DocumentSelector, newData: Patch<DocumentData<T>>, options?: CollectionUpdateOptions): Promise<DocumentOperationMetadata & {
         new?: Edge<T>;
         old?: Edge<T>;
     }>;
@@ -2825,10 +2876,10 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
         _key: string;
     } | {
         _id: string;
-    })>, options?: CollectionUpdateOptions): Promise<Array<DocumentMetadata & {
+    })>, options?: CollectionUpdateOptions): Promise<Array<(DocumentOperationMetadata & {
         new?: Edge<T>;
         old?: Edge<T>;
-    }>>;
+    }) | DocumentOperationFailure>>;
     /**
      * Removes an existing document from the collection.
      *
@@ -2869,9 +2920,9 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      * // document with keys "musadir" and "salman" deleted
      * ```
      */
-    removeAll(selectors: DocumentSelector[], options?: CollectionRemoveOptions): Promise<Array<DocumentMetadata & {
+    removeAll(selectors: DocumentSelector[], options?: CollectionRemoveOptions): Promise<Array<(DocumentMetadata & {
         old?: Edge<T>;
-    }>>;
+    }) | DocumentOperationFailure>>;
     /**
      * Bulk imports the given `data` into the collection.
      *
@@ -3293,7 +3344,7 @@ export declare class Collection<T extends Record<string, any> = any> implements
     removeByKeys(keys: string[], options?: SimpleQueryRemoveByKeysOptions): Promise<any>;
     indexes(): Promise<any>;
     index(selector: IndexSelector): Promise<any>;
-    ensureIndex(options: EnsurePersistentIndexOptions | EnsureGeoIndexOptions | EnsureFulltextIndexOptions | EnsureTtlIndexOptions | EnsureZkdIndexOptions | EnsureInvertedIndexOptions): Promise<any>;
+    ensureIndex(options: EnsurePersistentIndexOptions | EnsureGeoIndexOptions | EnsureFulltextIndexOptions | EnsureTtlIndexOptions | EnsureMdiIndexOptions | EnsureInvertedIndexOptions): Promise<any>;
     dropIndex(selector: IndexSelector): Promise<any>;
     fulltext(attribute: string, query: string, { index, ...options }?: SimpleQueryFulltextOptions): Promise<ArrayCursor<any>>;
     compact(): Promise<any>;