@azure/arm-maps 3.1.0-beta.1 → 3.1.0-beta.2

package/package.json

@@ -3,13 +3,13 @@
   "sdk-type": "mgmt",
   "author": "Microsoft Corporation",
   "description": "A generated SDK for AzureMapsManagementClient.",
-  "version": "3.1.0-beta.1",
+  "version": "3.1.0-beta.2",
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "dependencies": {
     "@azure/core-paging": "^1.2.0",
-    "@azure/core-client": "^1.5.0",
+    "@azure/core-client": "^1.6.1",
     "@azure/core-auth": "^1.3.0",
     "@azure/core-rest-pipeline": "^1.8.0",
     "tslib": "^2.2.0"
@@ -26,7 +26,7 @@
   "module": "./dist-esm/src/index.js",
   "types": "./types/arm-maps.d.ts",
   "devDependencies": {
-    "@microsoft/api-extractor": "7.18.11",
+    "@microsoft/api-extractor": "^7.31.1",
     "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-multi-entry": "^4.1.0",
@@ -34,13 +34,18 @@
     "mkdirp": "^1.0.4",
     "rollup": "^2.66.1",
     "rollup-plugin-sourcemaps": "^0.6.3",
-    "typescript": "~4.2.0",
+    "typescript": "~4.8.0",
     "uglify-js": "^3.4.9",
     "rimraf": "^3.0.0",
     "@azure/identity": "^2.0.1",
-    "@azure-tools/test-recorder": "^1.0.0",
+    "@azure-tools/test-recorder": "^2.0.0",
+    "@azure-tools/test-credential": "^1.0.0",
     "mocha": "^7.1.1",
-    "cross-env": "^7.0.2"
+    "@types/chai": "^4.2.8",
+    "chai": "^4.2.0",
+    "cross-env": "^7.0.2",
+    "@types/node": "^14.0.0",
+    "@azure/dev-tool": "^1.0.0"
   },
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/maps/arm-maps",
   "repository": {
@@ -91,9 +96,8 @@
     "unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node",
     "unit-test:browser": "echo skipped",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
-    "integration-test:node": "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts --reporter ../../../common/tools/mocha-multi-reporter.js",
-    "integration-test:browser": "echo skipped",
-    "docs": "echo skipped"
+    "integration-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 'test/*.ts'",
+    "integration-test:browser": "echo skipped"
   },
   "sideEffects": false,
   "//metadata": {
@@ -113,4 +117,4 @@
     "disableDocsMs": true,
     "apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-maps?view=azure-node-preview"
   }
-}
+}

package/review/arm-maps.api.md

@@ -149,10 +149,10 @@ export interface CorsRules {
 export type CreatedByType = string;
 
 // @public
-export type Creator = TrackedResource & {
+export interface Creator extends TrackedResource {
     properties: CreatorProperties;
     readonly systemData?: SystemData;
-};
+}
 
 // @public
 export interface CreatorList {
@@ -253,6 +253,9 @@ export interface ErrorResponse {
     error?: ErrorDetail;
 }
 
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
 // @public
 type KeyType_2 = string;
 export { KeyType_2 as KeyType }
@@ -262,47 +265,34 @@ export type Kind = string;
 
 // @public
 export enum KnownCreatedByType {
-    // (undocumented)
     Application = "Application",
-    // (undocumented)
     Key = "Key",
-    // (undocumented)
     ManagedIdentity = "ManagedIdentity",
-    // (undocumented)
     User = "User"
 }
 
 // @public
 export enum KnownKeyType {
-    // (undocumented)
     Primary = "primary",
-    // (undocumented)
     Secondary = "secondary"
 }
 
 // @public
 export enum KnownKind {
-    // (undocumented)
     Gen1 = "Gen1",
-    // (undocumented)
     Gen2 = "Gen2"
 }
 
 // @public
 export enum KnownName {
-    // (undocumented)
     G2 = "G2",
-    // (undocumented)
     S0 = "S0",
-    // (undocumented)
     S1 = "S1"
 }
 
 // @public
 export enum KnownSigningKey {
-    // (undocumented)
     PrimaryKey = "primaryKey",
-    // (undocumented)
     SecondaryKey = "secondaryKey"
 }
 
@@ -329,13 +319,13 @@ export interface Maps {
 }
 
 // @public
-export type MapsAccount = TrackedResource & {
-    sku: Sku;
-    kind?: Kind;
-    readonly systemData?: SystemData;
+export interface MapsAccount extends TrackedResource {
     identity?: ManagedServiceIdentity;
+    kind?: Kind;
     properties?: MapsAccountProperties;
-};
+    sku: Sku;
+    readonly systemData?: SystemData;
+}
 
 // @public
 export interface MapsAccountKeys {
@@ -489,12 +479,12 @@ export interface SystemData {
 }
 
 // @public
-export type TrackedResource = Resource & {
+export interface TrackedResource extends Resource {
+    location: string;
     tags?: {
         [propertyName: string]: string;
     };
-    location: string;
-};
+}
 
 // (No @packageDocumentation comment for this package)
 

package/src/azureMapsManagementClient.ts

@@ -8,6 +8,11 @@
 
 import * as coreClient from "@azure/core-client";
 import * as coreRestPipeline from "@azure/core-rest-pipeline";
+import {
+  PipelineRequest,
+  PipelineResponse,
+  SendRequest
+} from "@azure/core-rest-pipeline";
 import * as coreAuth from "@azure/core-auth";
 import { AccountsImpl, MapsImpl, CreatorsImpl } from "./operations";
 import { Accounts, Maps, Creators } from "./operationsInterfaces";
@@ -45,47 +50,53 @@ export class AzureMapsManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-maps/3.1.0-beta.1`;
+    const packageDetails = `azsdk-js-arm-maps/3.1.0-beta.2`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
         : `${packageDetails}`;
 
-    if (!options.credentialScopes) {
-      options.credentialScopes = ["https://management.azure.com/.default"];
-    }
     const optionsWithDefaults = {
       ...defaults,
       ...options,
       userAgentOptions: {
         userAgentPrefix
       },
-      baseUri:
+      endpoint:
         options.endpoint ?? options.baseUri ?? "https://management.azure.com"
     };
     super(optionsWithDefaults);
 
+    let bearerTokenAuthenticationPolicyFound: boolean = false;
     if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
       const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
-      const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
         (pipelinePolicy) =>
           pipelinePolicy.name ===
           coreRestPipeline.bearerTokenAuthenticationPolicyName
       );
-      if (!bearerTokenAuthenticationPolicyFound) {
-        this.pipeline.removePolicy({
-          name: coreRestPipeline.bearerTokenAuthenticationPolicyName
-        });
-        this.pipeline.addPolicy(
-          coreRestPipeline.bearerTokenAuthenticationPolicy({
-            scopes: `${optionsWithDefaults.baseUri}/.default`,
-            challengeCallbacks: {
-              authorizeRequestOnChallenge:
-                coreClient.authorizeRequestOnClaimChallenge
-            }
-          })
-        );
-      }
+    }
+    if (
+      !options ||
+      !options.pipeline ||
+      options.pipeline.getOrderedPolicies().length == 0 ||
+      !bearerTokenAuthenticationPolicyFound
+    ) {
+      this.pipeline.removePolicy({
+        name: coreRestPipeline.bearerTokenAuthenticationPolicyName
+      });
+      this.pipeline.addPolicy(
+        coreRestPipeline.bearerTokenAuthenticationPolicy({
+          credential: credentials,
+          scopes:
+            optionsWithDefaults.credentialScopes ??
+            `${optionsWithDefaults.endpoint}/.default`,
+          challengeCallbacks: {
+            authorizeRequestOnChallenge:
+              coreClient.authorizeRequestOnClaimChallenge
+          }
+        })
+      );
     }
     // Parameter assignments
     this.subscriptionId = subscriptionId;
@@ -96,6 +107,35 @@ export class AzureMapsManagementClient extends coreClient.ServiceClient {
     this.accounts = new AccountsImpl(this);
     this.maps = new MapsImpl(this);
     this.creators = new CreatorsImpl(this);
+    this.addCustomApiVersionPolicy(options.apiVersion);
+  }
+
+  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+  private addCustomApiVersionPolicy(apiVersion?: string) {
+    if (!apiVersion) {
+      return;
+    }
+    const apiVersionPolicy = {
+      name: "CustomApiVersionPolicy",
+      async sendRequest(
+        request: PipelineRequest,
+        next: SendRequest
+      ): Promise<PipelineResponse> {
+        const param = request.url.split("?");
+        if (param.length > 1) {
+          const newParams = param[1].split("&").map((item) => {
+            if (item.indexOf("api-version") > -1) {
+              return "api-version=" + apiVersion;
+            } else {
+              return item;
+            }
+          });
+          request.url = param[0] + "?" + newParams.join("&");
+        }
+        return next(request);
+      }
+    };
+    this.pipeline.addPolicy(apiVersionPolicy);
   }
 
   accounts: Accounts;

package/src/index.ts

@@ -7,6 +7,7 @@
  */
 
 /// <reference lib="esnext.asynciterable" />
+export { getContinuationToken } from "./pagingHelper";
 export * from "./models";
 export { AzureMapsManagementClient } from "./azureMapsManagementClient";
 export * from "./operationsInterfaces";

package/src/models/index.ts

@@ -400,15 +400,15 @@ export interface CreatorUpdateParameters {
 }
 
 /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
-export type TrackedResource = Resource & {
+export interface TrackedResource extends Resource {
   /** Resource tags. */
   tags?: { [propertyName: string]: string };
   /** The geo-location where the resource lives */
   location: string;
-};
+}
 
 /** An Azure resource which represents access to a suite of Maps REST APIs. */
-export type MapsAccount = TrackedResource & {
+export interface MapsAccount extends TrackedResource {
   /** The SKU of this account. */
   sku: Sku;
   /** Get or Set Kind property. */
@@ -422,10 +422,10 @@ export type MapsAccount = TrackedResource & {
   identity?: ManagedServiceIdentity;
   /** The map account properties. */
   properties?: MapsAccountProperties;
-};
+}
 
 /** An Azure resource which represents Maps Creator product and provides ability to manage private location data. */
-export type Creator = TrackedResource & {
+export interface Creator extends TrackedResource {
   /** The Creator resource properties. */
   properties: CreatorProperties;
   /**
@@ -433,12 +433,15 @@ export type Creator = TrackedResource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly systemData?: SystemData;
-};
+}
 
 /** Known values of {@link Name} that the service accepts. */
 export enum KnownName {
+  /** S0 */
   S0 = "S0",
+  /** S1 */
   S1 = "S1",
+  /** G2 */
   G2 = "G2"
 }
 
@@ -455,7 +458,9 @@ export type Name = string;
 
 /** Known values of {@link Kind} that the service accepts. */
 export enum KnownKind {
+  /** Gen1 */
   Gen1 = "Gen1",
+  /** Gen2 */
   Gen2 = "Gen2"
 }
 
@@ -471,9 +476,13 @@ export type Kind = string;
 
 /** Known values of {@link CreatedByType} that the service accepts. */
 export enum KnownCreatedByType {
+  /** User */
   User = "User",
+  /** Application */
   Application = "Application",
+  /** ManagedIdentity */
   ManagedIdentity = "ManagedIdentity",
+  /** Key */
   Key = "Key"
 }
 
@@ -491,7 +500,9 @@ export type CreatedByType = string;
 
 /** Known values of {@link SigningKey} that the service accepts. */
 export enum KnownSigningKey {
+  /** PrimaryKey */
   PrimaryKey = "primaryKey",
+  /** SecondaryKey */
   SecondaryKey = "secondaryKey"
 }
 
@@ -507,7 +518,9 @@ export type SigningKey = string;
 
 /** Known values of {@link KeyType} that the service accepts. */
 export enum KnownKeyType {
+  /** Primary */
   Primary = "primary",
+  /** Secondary */
   Secondary = "secondary"
 }
 

package/src/operations/accounts.ts

@@ -6,7 +6,8 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "../pagingHelper";
 import { Accounts } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,8 +17,10 @@ import {
   MapsAccount,
   AccountsListByResourceGroupNextOptionalParams,
   AccountsListByResourceGroupOptionalParams,
+  AccountsListByResourceGroupResponse,
   AccountsListBySubscriptionNextOptionalParams,
   AccountsListBySubscriptionOptionalParams,
+  AccountsListBySubscriptionResponse,
   AccountsCreateOrUpdateOptionalParams,
   AccountsCreateOrUpdateResponse,
   MapsAccountUpdateParameters,
@@ -26,8 +29,6 @@ import {
   AccountsDeleteOptionalParams,
   AccountsGetOptionalParams,
   AccountsGetResponse,
-  AccountsListByResourceGroupResponse,
-  AccountsListBySubscriptionResponse,
   AccountSasParameters,
   AccountsListSasOptionalParams,
   AccountsListSasResponse,
@@ -70,19 +71,33 @@ export class AccountsImpl implements Accounts {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listByResourceGroupPagingPage(resourceGroupName, options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listByResourceGroupPagingPage(
+          resourceGroupName,
+          options,
+          settings
+        );
       }
     };
   }
 
   private async *listByResourceGroupPagingPage(
     resourceGroupName: string,
-    options?: AccountsListByResourceGroupOptionalParams
+    options?: AccountsListByResourceGroupOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<MapsAccount[]> {
-    let result = await this._listByResourceGroup(resourceGroupName, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: AccountsListByResourceGroupResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listByResourceGroup(resourceGroupName, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listByResourceGroupNext(
         resourceGroupName,
@@ -90,7 +105,9 @@ export class AccountsImpl implements Accounts {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -121,22 +138,34 @@ export class AccountsImpl implements Accounts {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listBySubscriptionPagingPage(options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listBySubscriptionPagingPage(options, settings);
       }
     };
   }
 
   private async *listBySubscriptionPagingPage(
-    options?: AccountsListBySubscriptionOptionalParams
+    options?: AccountsListBySubscriptionOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<MapsAccount[]> {
-    let result = await this._listBySubscription(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: AccountsListBySubscriptionResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listBySubscription(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listBySubscriptionNext(continuationToken, options);
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/operations/creators.ts

@@ -6,7 +6,8 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "../pagingHelper";
 import { Creators } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -64,11 +65,15 @@ export class CreatorsImpl implements Creators {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listByAccountPagingPage(
           resourceGroupName,
           accountName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -77,15 +82,22 @@ export class CreatorsImpl implements Creators {
   private async *listByAccountPagingPage(
     resourceGroupName: string,
     accountName: string,
-    options?: CreatorsListByAccountOptionalParams
+    options?: CreatorsListByAccountOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Creator[]> {
-    let result = await this._listByAccount(
-      resourceGroupName,
-      accountName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: CreatorsListByAccountResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listByAccount(
+        resourceGroupName,
+        accountName,
+        options
+      );
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listByAccountNext(
         resourceGroupName,
@@ -94,7 +106,9 @@ export class CreatorsImpl implements Creators {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }