@azure/search-documents 12.2.0-beta.1 → 12.2.0-beta.3

package/dist/commonjs/indexDocumentsBatch.js

@@ -0,0 +1,84 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IndexDocumentsBatch = void 0;
+/**
+ * Class used to perform batch operations
+ * with multiple documents to the index.
+ */
+class IndexDocumentsBatch {
+    /**
+     * The set of actions taken in this batch.
+     */
+    actions;
+    constructor(actions = []) {
+        this.actions = actions;
+    }
+    /**
+     * Upload an array of documents to the index.
+     * @param documents - The documents to upload.
+     */
+    upload(documents) {
+        const batch = documents.map((doc) => {
+            return {
+                ...doc,
+                __actionType: "upload",
+            };
+        });
+        this.actions.push(...batch);
+    }
+    /**
+     * Update a set of documents in the index. For more details about how merging works, see
+     * https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
+     * @param documents - The updated documents.
+     */
+    merge(documents) {
+        const batch = documents.map((doc) => {
+            return {
+                ...doc,
+                __actionType: "merge",
+            };
+        });
+        this.actions.push(...batch);
+    }
+    /**
+     * Update a set of documents in the index or uploads them if they don't exist. For more details
+     * about how merging works, see
+     * https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
+     * @param documents - The new/updated documents.
+     */
+    mergeOrUpload(documents) {
+        const batch = documents.map((doc) => {
+            return {
+                ...doc,
+                __actionType: "mergeOrUpload",
+            };
+        });
+        this.actions.push(...batch);
+    }
+    delete(keyNameOrDocuments, keyValues) {
+        if (keyValues) {
+            const keyName = keyNameOrDocuments;
+            const batch = keyValues.map((keyValue) => {
+                return {
+                    __actionType: "delete",
+                    [keyName]: keyValue,
+                };
+            });
+            this.actions.push(...batch);
+        }
+        else {
+            const documents = keyNameOrDocuments;
+            const batch = documents.map((document) => {
+                return {
+                    __actionType: "delete",
+                    ...document,
+                };
+            });
+            this.actions.push(...batch);
+        }
+    }
+}
+exports.IndexDocumentsBatch = IndexDocumentsBatch;
+//# sourceMappingURL=indexDocumentsBatch.js.map

package/dist/commonjs/indexDocumentsBatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexDocumentsBatch.js","sourceRoot":"","sources":["../../src/indexDocumentsBatch.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAIlC;;;GAGG;AACH,MAAa,mBAAmB;IAC9B;;OAEG;IACa,OAAO,CAAiC;IAExD,YAAY,UAA0C,EAAE;QACtD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,SAAmB;QAC/B,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAA+B,CAAC,GAAG,EAAE,EAAE;YAChE,OAAO;gBACL,GAAG,GAAG;gBACN,YAAY,EAAE,QAAQ;aACvB,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAmB;QAC9B,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAA+B,CAAC,GAAG,EAAE,EAAE;YAChE,OAAO;gBACL,GAAG,GAAG;gBACN,YAAY,EAAE,OAAO;aACtB,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,SAAmB;QACtC,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAA+B,CAAC,GAAG,EAAE,EAAE;YAChE,OAAO;gBACL,GAAG,GAAG;gBACN,YAAY,EAAE,eAAe;aAC9B,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;IAC9B,CAAC;IAeM,MAAM,CAAC,kBAA2C,EAAE,SAAoB;QAC7E,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,OAAO,GAAG,kBAAkC,CAAC;YAEnD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAA+B,CAAC,QAAQ,EAAE,EAAE;gBACrE,OAAO;oBACL,YAAY,EAAE,QAAQ;oBACtB,CAAC,OAAO,CAAC,EAAE,QAAQ;iBACY,CAAC;YACpC,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAC9B,CAAC;aAAM,CAAC;YACN,MAAM,SAAS,GAAG,kBAA8B,CAAC;YAEjD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAA+B,CAAC,QAAQ,EAAE,EAAE;gBACrE,OAAO;oBACL,YAAY,EAAE,QAAQ;oBACtB,GAAG,QAAQ;iBACoB,CAAC;YACpC,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;CACF;AAhGD,kDAgGC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { IndexDocumentsAction } from \"./indexModels.js\";\n\n/**\n * Class used to perform batch operations\n * with multiple documents to the index.\n */\nexport class IndexDocumentsBatch<TModel> {\n  /**\n   * The set of actions taken in this batch.\n   */\n  public readonly actions: IndexDocumentsAction<TModel>[];\n\n  constructor(actions: IndexDocumentsAction<TModel>[] = []) {\n    this.actions = actions;\n  }\n\n  /**\n   * Upload an array of documents to the index.\n   * @param documents - The documents to upload.\n   */\n  public upload(documents: TModel[]): void {\n    const batch = documents.map<IndexDocumentsAction<TModel>>((doc) => {\n      return {\n        ...doc,\n        __actionType: \"upload\",\n      };\n    });\n\n    this.actions.push(...batch);\n  }\n\n  /**\n   * Update a set of documents in the index. For more details about how merging works, see\n   * https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents\n   * @param documents - The updated documents.\n   */\n  public merge(documents: TModel[]): void {\n    const batch = documents.map<IndexDocumentsAction<TModel>>((doc) => {\n      return {\n        ...doc,\n        __actionType: \"merge\",\n      };\n    });\n\n    this.actions.push(...batch);\n  }\n\n  /**\n   * Update a set of documents in the index or uploads them if they don't exist. For more details\n   * about how merging works, see\n   * https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents\n   * @param documents - The new/updated documents.\n   */\n  public mergeOrUpload(documents: TModel[]): void {\n    const batch = documents.map<IndexDocumentsAction<TModel>>((doc) => {\n      return {\n        ...doc,\n        __actionType: \"mergeOrUpload\",\n      };\n    });\n\n    this.actions.push(...batch);\n  }\n\n  /**\n   * Delete a set of documents.\n   * @param keyName - The name of their primary key in the index.\n   * @param keyValues - The primary key values of documents to delete.\n   */\n  public delete(keyName: keyof TModel, keyValues: string[]): void;\n\n  /**\n   * Delete a set of documents.\n   * @param documents - Documents to be deleted.\n   */\n  public delete(documents: TModel[]): void;\n\n  public delete(keyNameOrDocuments: keyof TModel | TModel[], keyValues?: string[]): void {\n    if (keyValues) {\n      const keyName = keyNameOrDocuments as keyof TModel;\n\n      const batch = keyValues.map<IndexDocumentsAction<TModel>>((keyValue) => {\n        return {\n          __actionType: \"delete\",\n          [keyName]: keyValue,\n        } as IndexDocumentsAction<TModel>;\n      });\n\n      this.actions.push(...batch);\n    } else {\n      const documents = keyNameOrDocuments as TModel[];\n\n      const batch = documents.map<IndexDocumentsAction<TModel>>((document) => {\n        return {\n          __actionType: \"delete\",\n          ...document,\n        } as IndexDocumentsAction<TModel>;\n      });\n\n      this.actions.push(...batch);\n    }\n  }\n}\n"]}