@azure/arm-devspaces 2.0.1-alpha.20221101.1 → 2.1.0

package/package.json

@@ -3,7 +3,7 @@
   "sdk-type": "mgmt",
   "author": "Microsoft Corporation",
   "description": "A generated SDK for DevSpacesManagementClient.",
-  "version": "2.0.1-alpha.20221101.1",
+  "version": "2.1.0",
   "engines": {
     "node": ">=14.0.0"
   },
@@ -11,9 +11,9 @@
     "@azure/core-lro": "^2.2.0",
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-paging": "^1.2.0",
-    "@azure/core-client": "^1.0.0",
+    "@azure/core-client": "^1.6.1",
     "@azure/core-auth": "^1.3.0",
-    "@azure/core-rest-pipeline": "^1.1.0",
+    "@azure/core-rest-pipeline": "^1.8.0",
     "tslib": "^2.2.0"
   },
   "keywords": [
@@ -29,20 +29,25 @@
   "types": "./types/arm-devspaces.d.ts",
   "devDependencies": {
     "@microsoft/api-extractor": "^7.31.1",
-    "@rollup/plugin-commonjs": "11.0.2",
-    "@rollup/plugin-json": "^4.0.0",
-    "@rollup/plugin-multi-entry": "^3.0.0",
-    "@rollup/plugin-node-resolve": "^8.0.0",
+    "@rollup/plugin-commonjs": "^21.0.1",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-multi-entry": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.1.3",
     "mkdirp": "^1.0.4",
-    "rollup": "^1.16.3",
-    "rollup-plugin-sourcemaps": "^0.4.2",
-    "typescript": "~4.2.0",
+    "rollup": "^2.66.1",
+    "rollup-plugin-sourcemaps": "^0.6.3",
+    "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/devspaces/arm-devspaces",
   "repository": {
@@ -93,10 +98,25 @@
     "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,
-  "autoPublish": true
-}
+  "//metadata": {
+    "constantPaths": [
+      {
+        "path": "src/devSpacesManagementClient.ts",
+        "prefix": "packageDetails"
+      }
+    ]
+  },
+  "autoPublish": true,
+  "//sampleConfiguration": {
+    "productName": "",
+    "productSlugs": [
+      "azure"
+    ],
+    "disableDocsMs": true,
+    "apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-devspaces?view=azure-node-preview"
+  }
+}

package/review/arm-devspaces.api.md

@@ -29,15 +29,15 @@ export interface ContainerHostMappingsGetContainerHostMappingOptionalParams exte
 export type ContainerHostMappingsGetContainerHostMappingResponse = ContainerHostMapping;
 
 // @public (undocumented)
-export type Controller = TrackedResource & {
-    sku: Sku;
-    readonly provisioningState?: ProvisioningState;
-    readonly hostSuffix?: string;
+export interface Controller extends TrackedResource {
     readonly dataPlaneFqdn?: string;
+    readonly hostSuffix?: string;
+    readonly provisioningState?: ProvisioningState;
+    sku: Sku;
     readonly targetContainerHostApiServerFqdn?: string;
-    targetContainerHostResourceId: string;
     targetContainerHostCredentialsBase64: string;
-};
+    targetContainerHostResourceId: string;
+}
 
 // @public (undocumented)
 export interface ControllerConnectionDetails {
@@ -176,41 +176,35 @@ export interface ErrorDetails {
     readonly target?: string;
 }
 
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
 // @public
 export enum KnownProvisioningState {
-    // (undocumented)
     Canceled = "Canceled",
-    // (undocumented)
     Creating = "Creating",
-    // (undocumented)
     Deleted = "Deleted",
-    // (undocumented)
     Deleting = "Deleting",
-    // (undocumented)
     Failed = "Failed",
-    // (undocumented)
     Succeeded = "Succeeded",
-    // (undocumented)
     Updating = "Updating"
 }
 
 // @public
 export enum KnownSkuName {
-    // (undocumented)
     S1 = "S1"
 }
 
 // @public
 export enum KnownSkuTier {
-    // (undocumented)
     Standard = "Standard"
 }
 
 // @public
-export type KubernetesConnectionDetails = OrchestratorSpecificConnectionDetails & {
+export interface KubernetesConnectionDetails extends OrchestratorSpecificConnectionDetails {
     instanceType: "Kubernetes";
     kubeConfig?: string;
-};
+}
 
 // @public
 export interface ListConnectionDetailsParameters {
@@ -288,12 +282,12 @@ export type SkuName = string;
 export type SkuTier = string;
 
 // @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/rollup.config.js

@@ -14,62 +14,14 @@ import json from "@rollup/plugin-json";
 
 import nodeBuiltins from "builtin-modules";
 
-/**
- * Gets the proper configuration needed for rollup's commonJS plugin for @opentelemetry/api.
- *
- * NOTE: this manual configuration is only needed because OpenTelemetry uses an
- * __exportStar downleveled helper function to declare its exports which confuses
- * rollup's automatic discovery mechanism.
- *
- * @returns an object reference that can be `...`'d into your cjs() configuration.
- */
-export function openTelemetryCommonJs() {
-  const namedExports = {};
-
-  for (const key of [
-    "@opentelemetry/api",
-    "@azure/core-tracing/node_modules/@opentelemetry/api"
-  ]) {
-    namedExports[key] = [
-      "SpanKind",
-      "TraceFlags",
-      "getSpan",
-      "setSpan",
-      "SpanStatusCode",
-      "getSpanContext",
-      "setSpanContext"
-    ];
-  }
-
-  const releasedOpenTelemetryVersions = ["0.10.2", "1.0.0-rc.0"];
-
-  for (const version of releasedOpenTelemetryVersions) {
-    namedExports[
-      // working around a limitation in the rollup common.js plugin - it's not able to resolve these modules so the named exports listed above will not get applied. We have to drill down to the actual path.
-      `../../../common/temp/node_modules/.pnpm/@opentelemetry/api@${version}/node_modules/@opentelemetry/api/build/src/index.js`
-    ] = [
-      "SpanKind",
-      "TraceFlags",
-      "getSpan",
-      "setSpan",
-      "StatusCode",
-      "CanonicalCode",
-      "getSpanContext",
-      "setSpanContext"
-    ];
-  }
-
-  return namedExports;
-}
-
 // #region Warning Handler
 
 /**
- * A function that can determine whether a rollupwarning should be ignored. If
+ * A function that can determine whether a rollup warning should be ignored. If
  * the function returns `true`, then the warning will not be displayed.
  */
 
-function ignoreNiseSinonEvalWarnings(warning) {
+function ignoreNiseSinonEval(warning) {
   return (
     warning.code === "EVAL" &&
     warning.id &&
@@ -78,17 +30,14 @@ function ignoreNiseSinonEvalWarnings(warning) {
   );
 }
 
-function ignoreChaiCircularDependencyWarnings(warning) {
+function ignoreChaiCircularDependency(warning) {
   return (
     warning.code === "CIRCULAR_DEPENDENCY" &&
     warning.importer && warning.importer.includes("node_modules/chai") === true
   );
 }
 
-const warningInhibitors = [
-  ignoreChaiCircularDependencyWarnings,
-  ignoreNiseSinonEvalWarnings
-];
+const warningInhibitors = [ignoreChaiCircularDependency, ignoreNiseSinonEval];
 
 /**
  * Construct a warning handler for the shared rollup configuration
@@ -122,22 +71,7 @@ function makeBrowserTestConfig() {
       nodeResolve({
         mainFields: ["module", "browser"]
       }),
-      cjs({
-        namedExports: {
-          // Chai's strange internal architecture makes it impossible to statically
-          // analyze its exports.
-          chai: [
-            "version",
-            "use",
-            "util",
-            "config",
-            "expect",
-            "should",
-            "assert"
-          ],
-          ...openTelemetryCommonJs()
-        }
-      }),
+      cjs(),
       json(),
       sourcemaps()
       //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
@@ -173,7 +107,7 @@ export function makeConfig(pkg, options) {
     ],
     output: { file: "dist/index.js", format: "cjs", sourcemap: true },
     preserveSymlinks: false,
-    plugins: [sourcemaps(), nodeResolve(), cjs()]
+    plugins: [sourcemaps(), nodeResolve()]
   };
 
   const config = [baseConfig];

package/src/devSpacesManagementClient.ts

@@ -7,6 +7,12 @@
  */
 
 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 {
   ContainerHostMappingsImpl,
@@ -52,24 +58,54 @@ export class DevSpacesManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-devspaces/2.0.0`;
+    const packageDetails = `azsdk-js-arm-devspaces/2.1.0`;
     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: options.endpoint || "https://management.azure.com"
+      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();
+      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+        (pipelinePolicy) =>
+          pipelinePolicy.name ===
+          coreRestPipeline.bearerTokenAuthenticationPolicyName
+      );
+    }
+    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;
 
@@ -79,6 +115,35 @@ export class DevSpacesManagementClient extends coreClient.ServiceClient {
     this.containerHostMappings = new ContainerHostMappingsImpl(this);
     this.operations = new OperationsImpl(this);
     this.controllers = new ControllersImpl(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);
   }
 
   containerHostMappings: ContainerHostMappings;

package/src/index.ts

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

package/src/models/index.ts

@@ -142,22 +142,23 @@ export interface OrchestratorSpecificConnectionDetails {
 }
 
 /** The resource model definition for a ARM tracked top level resource. */
-export type TrackedResource = Resource & {
+export interface TrackedResource extends Resource {
   /** Tags for the Azure resource. */
   tags?: { [propertyName: string]: string };
   /** Region where the Azure resource is located. */
   location?: string;
-};
+}
 
 /** Contains information used to connect to a Kubernetes cluster */
-export type KubernetesConnectionDetails = OrchestratorSpecificConnectionDetails & {
+export interface KubernetesConnectionDetails
+  extends OrchestratorSpecificConnectionDetails {
   /** Polymorphic discriminator, which specifies the different types this object can be */
   instanceType: "Kubernetes";
   /** Gets the kubeconfig for the cluster. */
   kubeConfig?: string;
-};
+}
 
-export type Controller = TrackedResource & {
+export interface Controller extends TrackedResource {
   /** Model representing SKU for Azure Dev Spaces Controller. */
   sku: Sku;
   /**
@@ -184,16 +185,23 @@ export type Controller = TrackedResource & {
   targetContainerHostResourceId: string;
   /** Credentials of the target container host (base64). */
   targetContainerHostCredentialsBase64: string;
-};
+}
 
 /** Known values of {@link ProvisioningState} that the service accepts. */
 export enum KnownProvisioningState {
+  /** Succeeded */
   Succeeded = "Succeeded",
+  /** Failed */
   Failed = "Failed",
+  /** Canceled */
   Canceled = "Canceled",
+  /** Updating */
   Updating = "Updating",
+  /** Creating */
   Creating = "Creating",
+  /** Deleting */
   Deleting = "Deleting",
+  /** Deleted */
   Deleted = "Deleted"
 }
 
@@ -214,6 +222,7 @@ export type ProvisioningState = string;
 
 /** Known values of {@link SkuName} that the service accepts. */
 export enum KnownSkuName {
+  /** S1 */
   S1 = "S1"
 }
 
@@ -228,6 +237,7 @@ export type SkuName = string;
 
 /** Known values of {@link SkuTier} that the service accepts. */
 export enum KnownSkuTier {
+  /** Standard */
   Standard = "Standard"
 }
 

package/src/models/mappers.ts

@@ -326,6 +326,7 @@ export const OrchestratorSpecificConnectionDetails: coreClient.CompositeMapper =
     modelProperties: {
       instanceType: {
         serializedName: "instanceType",
+        required: true,
         readOnly: true,
         type: {
           name: "String"

package/src/operations/controllers.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 { Controllers } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -18,8 +19,10 @@ import {
   Controller,
   ControllersListByResourceGroupNextOptionalParams,
   ControllersListByResourceGroupOptionalParams,
+  ControllersListByResourceGroupResponse,
   ControllersListNextOptionalParams,
   ControllersListOptionalParams,
+  ControllersListResponse,
   ControllersGetOptionalParams,
   ControllersGetResponse,
   ControllersCreateOptionalParams,
@@ -28,8 +31,6 @@ import {
   ControllerUpdateParameters,
   ControllersUpdateOptionalParams,
   ControllersUpdateResponse,
-  ControllersListByResourceGroupResponse,
-  ControllersListResponse,
   ListConnectionDetailsParameters,
   ControllersListConnectionDetailsOptionalParams,
   ControllersListConnectionDetailsResponse,
@@ -68,19 +69,33 @@ export class ControllersImpl implements Controllers {
       [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?: ControllersListByResourceGroupOptionalParams
+    options?: ControllersListByResourceGroupOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Controller[]> {
-    let result = await this._listByResourceGroup(resourceGroupName, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ControllersListByResourceGroupResponse;
+    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,
@@ -88,7 +103,9 @@ export class ControllersImpl implements Controllers {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -119,22 +136,34 @@ export class ControllersImpl implements Controllers {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listPagingPage(options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listPagingPage(options, settings);
       }
     };
   }
 
   private async *listPagingPage(
-    options?: ControllersListOptionalParams
+    options?: ControllersListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Controller[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ControllersListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(continuationToken, options);
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -225,10 +254,12 @@ export class ControllersImpl implements Controllers {
       { resourceGroupName, name, controller, options },
       createOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -308,10 +339,12 @@ export class ControllersImpl implements Controllers {
       { resourceGroupName, name, options },
       deleteOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
+    await poller.poll();
+    return poller;
   }
 
   /**

package/src/operations/operations.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 { Operations } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -49,22 +50,34 @@ export class OperationsImpl implements Operations {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listPagingPage(options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listPagingPage(options, settings);
       }
     };
   }
 
   private async *listPagingPage(
-    options?: OperationsListOptionalParams
+    options?: OperationsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<ResourceProviderOperationDefinition[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: OperationsListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(continuationToken, options);
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }