@azure/search-documents 11.3.1 → 12.0.0-alpha.20230320.1

package/dist-esm/src/searchIndexClient.js

@@ -1,17 +1,16 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-import { __asyncDelegator, __asyncGenerator, __asyncValues, __await } from "tslib";
+import { __asyncDelegator, __asyncGenerator, __asyncValues, __await, __rest } from "tslib";
 /// <reference lib="esnext.asynciterable" />
 import { isTokenCredential } from "@azure/core-auth";
-import { createPipelineFromOptions, operationOptionsToRequestOptionsBase, bearerTokenAuthenticationPolicy } from "@azure/core-http";
-import { SpanStatusCode } from "@azure/core-tracing";
+import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
 import { SDK_VERSION } from "./constants";
 import { SearchServiceClient as GeneratedClient } from "./generated/service/searchServiceClient";
 import { logger } from "./logger";
 import { createSearchApiKeyCredentialPolicy } from "./searchApiKeyCredentialPolicy";
 import * as utils from "./serviceUtils";
 import { createSpan } from "./tracing";
-import { odataMetadataPolicy } from "./odataMetadataPolicy";
+import { createOdataMetadataPolicy } from "./odataMetadataPolicy";
 import { SearchClient } from "./searchClient";
 import { KnownSearchAudience } from "./searchAudience";
 /**
@@ -40,7 +39,12 @@ export class SearchIndexClient {
         /**
          * The API version to use when communicating with the service.
          */
-        this.apiVersion = "2020-06-30";
+        this.serviceVersion = utils.defaultServiceVersion;
+        /**
+         * The API version to use when communicating with the service.
+         * @deprecated use {@Link serviceVersion} instead
+         */
+        this.apiVersion = utils.defaultServiceVersion;
         this.endpoint = endpoint;
         this.credential = credential;
         this.options = options;
@@ -54,50 +58,57 @@ export class SearchIndexClient {
         else {
             options.userAgentOptions.userAgentPrefix = libInfo;
         }
-        const internalPipelineOptions = Object.assign(Object.assign({}, options), {
+        const internalClientPipelineOptions = Object.assign(Object.assign({}, options), {
             loggingOptions: {
                 logger: logger.info,
-                allowedHeaderNames: [
+                additionalAllowedHeaderNames: [
                     "elapsed-time",
                     "Location",
                     "OData-MaxVersion",
                     "OData-Version",
                     "Prefer",
-                    "throttle-reason"
-                ]
-            }
+                    "throttle-reason",
+                ],
+            },
         });
-        const scope = options.audience
-            ? `${options.audience}/.default`
-            : `${KnownSearchAudience.AzurePublicCloud}/.default`;
-        const requestPolicyFactory = isTokenCredential(credential)
-            ? bearerTokenAuthenticationPolicy(credential, scope)
-            : createSearchApiKeyCredentialPolicy(credential);
-        const pipeline = createPipelineFromOptions(internalPipelineOptions, requestPolicyFactory);
-        if (Array.isArray(pipeline.requestPolicyFactories)) {
-            pipeline.requestPolicyFactories.unshift(odataMetadataPolicy("minimal"));
-        }
-        let apiVersion = this.apiVersion;
         if (options.apiVersion) {
-            if (!["2020-06-30-Preview", "2020-06-30"].includes(options.apiVersion)) {
+            if (!utils.serviceVersions.includes(options.apiVersion)) {
                 throw new Error(`Invalid Api Version: ${options.apiVersion}`);
             }
-            apiVersion = options.apiVersion;
+            this.serviceVersion = options.apiVersion;
+            this.apiVersion = options.apiVersion;
+        }
+        if (options.serviceVersion) {
+            if (!utils.serviceVersions.includes(options.serviceVersion)) {
+                throw new Error(`Invalid Service Version: ${options.serviceVersion}`);
+            }
+            this.serviceVersion = options.serviceVersion;
+            this.apiVersion = options.serviceVersion;
         }
-        this.client = new GeneratedClient(this.endpoint, apiVersion, pipeline);
+        this.client = new GeneratedClient(this.endpoint, this.serviceVersion, internalClientPipelineOptions);
+        if (isTokenCredential(credential)) {
+            const scope = options.audience
+                ? `${options.audience}/.default`
+                : `${KnownSearchAudience.AzurePublicCloud}/.default`;
+            this.client.pipeline.addPolicy(bearerTokenAuthenticationPolicy({ credential, scopes: scope }));
+        }
+        else {
+            this.client.pipeline.addPolicy(createSearchApiKeyCredentialPolicy(credential));
+        }
+        this.client.pipeline.addPolicy(createOdataMetadataPolicy("minimal"));
     }
     listIndexesPage(options = {}) {
         return __asyncGenerator(this, arguments, function* listIndexesPage_1() {
             const { span, updatedOptions } = createSpan("SearchIndexClient-listIndexesPage", options);
             try {
-                const result = yield __await(this.client.indexes.list(operationOptionsToRequestOptionsBase(updatedOptions)));
+                const result = yield __await(this.client.indexes.list(updatedOptions));
                 const mapped = result.indexes.map(utils.generatedIndexToPublicIndex);
                 yield yield __await(mapped);
             }
             catch (e) {
                 span.setStatus({
-                    code: SpanStatusCode.ERROR,
-                    message: e.message
+                    status: "error",
+                    error: e.message,
                 });
                 throw e;
             }
@@ -139,21 +150,76 @@ export class SearchIndexClient {
             },
             byPage: () => {
                 return this.listIndexesPage(options);
+            },
+        };
+    }
+    listAliasesPage(options = {}) {
+        return __asyncGenerator(this, arguments, function* listAliasesPage_1() {
+            const { span, updatedOptions } = createSpan("SearchIndexerClient-listAliases", options);
+            try {
+                const result = yield __await(this.client.aliases.list(updatedOptions));
+                yield yield __await(result.aliases);
+            }
+            catch (e) {
+                span.setStatus({
+                    status: "error",
+                    error: e.message,
+                });
+                throw e;
+            }
+            finally {
+                span.end();
+            }
+        });
+    }
+    listAliasesAll(options = {}) {
+        return __asyncGenerator(this, arguments, function* listAliasesAll_1() {
+            var e_2, _a;
+            try {
+                for (var _b = __asyncValues(this.listAliasesPage(options)), _c; _c = yield __await(_b.next()), !_c.done;) {
+                    const page = _c.value;
+                    yield __await(yield* __asyncDelegator(__asyncValues(page)));
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (_c && !_c.done && (_a = _b.return)) yield __await(_a.call(_b));
+                }
+                finally { if (e_2) throw e_2.error; }
             }
+        });
+    }
+    /**
+     * Lists all aliases available for a search service.
+     * @param options - The options parameters.
+     */
+    listAliases(options = {}) {
+        const iter = this.listAliasesAll(options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: () => {
+                return this.listAliasesPage(options);
+            },
         };
     }
     listIndexesNamesPage(options = {}) {
         return __asyncGenerator(this, arguments, function* listIndexesNamesPage_1() {
             const { span, updatedOptions } = createSpan("SearchIndexClient-listIndexesNamesPage", options);
             try {
-                const result = yield __await(this.client.indexes.list(Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { select: "name" })));
+                const result = yield __await(this.client.indexes.list(Object.assign(Object.assign({}, updatedOptions), { select: "name" })));
                 const mapped = result.indexes.map((idx) => idx.name);
                 yield yield __await(mapped);
             }
             catch (e) {
                 span.setStatus({
-                    code: SpanStatusCode.ERROR,
-                    message: e.message
+                    status: "error",
+                    error: e.message,
                 });
                 throw e;
             }
@@ -164,19 +230,19 @@ export class SearchIndexClient {
     }
     listIndexesNamesAll(options = {}) {
         return __asyncGenerator(this, arguments, function* listIndexesNamesAll_1() {
-            var e_2, _a;
+            var e_3, _a;
             try {
                 for (var _b = __asyncValues(this.listIndexesNamesPage(options)), _c; _c = yield __await(_b.next()), !_c.done;) {
                     const page = _c.value;
                     yield __await(yield* __asyncDelegator(__asyncValues(page)));
                 }
             }
-            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            catch (e_3_1) { e_3 = { error: e_3_1 }; }
             finally {
                 try {
                     if (_c && !_c.done && (_a = _b.return)) yield __await(_a.call(_b));
                 }
-                finally { if (e_2) throw e_2.error; }
+                finally { if (e_3) throw e_3.error; }
             }
         });
     }
@@ -195,7 +261,7 @@ export class SearchIndexClient {
             },
             byPage: () => {
                 return this.listIndexesNamesPage(options);
-            }
+            },
         };
     }
     /**
@@ -205,13 +271,13 @@ export class SearchIndexClient {
     async listSynonymMaps(options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-listSynonymMaps", options);
         try {
-            const result = await this.client.synonymMaps.list(operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.synonymMaps.list(updatedOptions);
             return result.synonymMaps.map(utils.generatedSynonymMapToPublicSynonymMap);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -226,13 +292,13 @@ export class SearchIndexClient {
     async listSynonymMapsNames(options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-listSynonymMapsNames", options);
         try {
-            const result = await this.client.synonymMaps.list(Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { select: "name" }));
+            const result = await this.client.synonymMaps.list(Object.assign(Object.assign({}, updatedOptions), { select: "name" }));
             return result.synonymMaps.map((sm) => sm.name);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -248,13 +314,13 @@ export class SearchIndexClient {
     async getIndex(indexName, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-getIndex", options);
         try {
-            const result = await this.client.indexes.get(indexName, operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.indexes.get(indexName, updatedOptions);
             return utils.generatedIndexToPublicIndex(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -270,13 +336,13 @@ export class SearchIndexClient {
     async getSynonymMap(synonymMapName, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-getSynonymMaps", options);
         try {
-            const result = await this.client.synonymMaps.get(synonymMapName, operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.synonymMaps.get(synonymMapName, updatedOptions);
             return utils.generatedSynonymMapToPublicSynonymMap(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -292,13 +358,13 @@ export class SearchIndexClient {
     async createIndex(index, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-createIndex", options);
         try {
-            const result = await this.client.indexes.create(utils.publicIndexToGeneratedIndex(index), operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.indexes.create(utils.publicIndexToGeneratedIndex(index), updatedOptions);
             return utils.generatedIndexToPublicIndex(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -314,13 +380,13 @@ export class SearchIndexClient {
     async createSynonymMap(synonymMap, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-createSynonymMaps", options);
         try {
-            const result = await this.client.synonymMaps.create(utils.publicSynonymMapToGeneratedSynonymMap(synonymMap), operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.synonymMaps.create(utils.publicSynonymMapToGeneratedSynonymMap(synonymMap), updatedOptions);
             return utils.generatedSynonymMapToPublicSynonymMap(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -337,13 +403,13 @@ export class SearchIndexClient {
         const { span, updatedOptions } = createSpan("SearchIndexClient-createOrUpdateIndex", options);
         try {
             const etag = options.onlyIfUnchanged ? index.etag : undefined;
-            const result = await this.client.indexes.createOrUpdate(index.name, utils.publicIndexToGeneratedIndex(index), Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { ifMatch: etag }));
+            const result = await this.client.indexes.createOrUpdate(index.name, utils.publicIndexToGeneratedIndex(index), Object.assign(Object.assign({}, updatedOptions), { ifMatch: etag }));
             return utils.generatedIndexToPublicIndex(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -360,13 +426,13 @@ export class SearchIndexClient {
         const { span, updatedOptions } = createSpan("SearchIndexClient-createOrUpdateSynonymMap", options);
         try {
             const etag = options.onlyIfUnchanged ? synonymMap.etag : undefined;
-            const result = await this.client.synonymMaps.createOrUpdate(synonymMap.name, utils.publicSynonymMapToGeneratedSynonymMap(synonymMap), Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { ifMatch: etag }));
+            const result = await this.client.synonymMaps.createOrUpdate(synonymMap.name, utils.publicSynonymMapToGeneratedSynonymMap(synonymMap), Object.assign(Object.assign({}, updatedOptions), { ifMatch: etag }));
             return utils.generatedSynonymMapToPublicSynonymMap(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -384,12 +450,12 @@ export class SearchIndexClient {
         try {
             const indexName = typeof index === "string" ? index : index.name;
             const etag = typeof index === "string" ? undefined : options.onlyIfUnchanged ? index.etag : undefined;
-            await this.client.indexes.delete(indexName, Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { ifMatch: etag }));
+            await this.client.indexes.delete(indexName, Object.assign(Object.assign({}, updatedOptions), { ifMatch: etag }));
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -411,12 +477,103 @@ export class SearchIndexClient {
                 : options.onlyIfUnchanged
                     ? synonymMap.etag
                     : undefined;
-            await this.client.synonymMaps.delete(synonymMapName, Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { ifMatch: etag }));
+            await this.client.synonymMaps.delete(synonymMapName, Object.assign(Object.assign({}, updatedOptions), { ifMatch: etag }));
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Creates a new search alias or updates an alias if it already exists.
+     * @param alias - The definition of the alias to create or update.
+     * @param options - The options parameters.
+     */
+    async createOrUpdateAlias(alias, options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexerClient-createOrUpdateAlias", options);
+        try {
+            const etag = options.onlyIfUnchanged ? alias.etag : undefined;
+            const result = await this.client.aliases.createOrUpdate(alias.name, alias, Object.assign(Object.assign({}, updatedOptions), { ifMatch: etag }));
+            return result;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Creates a new search alias.
+     * @param alias - The definition of the alias to create.
+     * @param options - The options parameters.
+     */
+    async createAlias(alias, options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexerClient-createAlias", options);
+        try {
+            const result = await this.client.aliases.create(alias, updatedOptions);
+            return result;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Deletes a search alias and its associated mapping to an index. This operation is permanent, with no
+     * recovery option. The mapped index is untouched by this operation.
+     * @param alias - Alias/Name name of the alias to delete.
+     * @param options - The options parameters.
+     */
+    async deleteAlias(alias, options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexerClient-deleteAlias", options);
+        try {
+            const aliasName = typeof alias === "string" ? alias : alias.name;
+            const etag = typeof alias === "string" ? undefined : options.onlyIfUnchanged ? alias.etag : undefined;
+            await this.client.aliases.delete(aliasName, Object.assign(Object.assign({}, updatedOptions), { ifMatch: etag }));
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Retrieves an alias definition.
+     * @param aliasName - The name of the alias to retrieve.
+     * @param options - The options parameters.
+     */
+    async getAlias(aliasName, options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexerClient-getAlias", options);
+        try {
+            const result = await this.client.aliases.get(aliasName, updatedOptions);
+            return result;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -433,13 +590,13 @@ export class SearchIndexClient {
     async getIndexStatistics(indexName, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-getIndexStatistics", options);
         try {
-            const result = await this.client.indexes.getStatistics(indexName, operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.indexes.getStatistics(indexName, updatedOptions);
             return result;
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -454,16 +611,21 @@ export class SearchIndexClient {
      * @param options - Additional arguments
      */
     async analyzeText(indexName, options) {
-        const { operationOptions, restOptions } = utils.extractOperationOptions(options);
+        const { abortSignal, requestOptions, tracingOptions } = options, restOptions = __rest(options, ["abortSignal", "requestOptions", "tracingOptions"]);
+        const operationOptions = {
+            abortSignal,
+            requestOptions,
+            tracingOptions,
+        };
         const { span, updatedOptions } = createSpan("SearchIndexClient-analyzeText", operationOptions);
         try {
-            const result = await this.client.indexes.analyze(indexName, Object.assign(Object.assign({}, restOptions), { analyzer: restOptions.analyzerName, tokenizer: restOptions.tokenizerName }), operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.indexes.analyze(indexName, Object.assign(Object.assign({}, restOptions), { analyzer: restOptions.analyzerName, tokenizer: restOptions.tokenizerName, normalizer: restOptions.normalizerName }), updatedOptions);
             return result;
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -478,13 +640,13 @@ export class SearchIndexClient {
     async getServiceStatistics(options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-getServiceStatistics", options);
         try {
-            const result = await this.client.getServiceStatistics(operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.getServiceStatistics(updatedOptions);
             return result;
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -496,6 +658,10 @@ export class SearchIndexClient {
      * Retrieves the SearchClient corresponding to this SearchIndexClient
      * @param indexName - Name of the index
      * @param options - SearchClient Options
+     * @typeParam Model - An optional type that represents the documents stored in
+     * the search index. For the best typing experience, all non-key fields should
+     * be marked optional and nullable, and the key property should have the
+     * non-nullable type `string`.
      */
     getSearchClient(indexName, options) {
         return new SearchClient(this.endpoint, indexName, this.credential, options || this.options);