@azure/arm-devspaces 1.2.1 → 2.0.1-alpha.20220201.1

package/review/arm-devspaces.api.md

@@ -0,0 +1,300 @@
+## API Report File for "@azure/arm-devspaces"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+// @public
+export interface ContainerHostMapping {
+    containerHostResourceId?: string;
+    readonly mappedControllerResourceId?: string;
+}
+
+// @public
+export interface ContainerHostMappings {
+    getContainerHostMapping(resourceGroupName: string, location: string, containerHostMapping: ContainerHostMapping, options?: ContainerHostMappingsGetContainerHostMappingOptionalParams): Promise<ContainerHostMappingsGetContainerHostMappingResponse>;
+}
+
+// @public
+export interface ContainerHostMappingsGetContainerHostMappingOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ContainerHostMappingsGetContainerHostMappingResponse = ContainerHostMapping;
+
+// @public (undocumented)
+export type Controller = TrackedResource & {
+    sku: Sku;
+    readonly provisioningState?: ProvisioningState;
+    readonly hostSuffix?: string;
+    readonly dataPlaneFqdn?: string;
+    readonly targetContainerHostApiServerFqdn?: string;
+    targetContainerHostResourceId: string;
+    targetContainerHostCredentialsBase64: string;
+};
+
+// @public (undocumented)
+export interface ControllerConnectionDetails {
+    orchestratorSpecificConnectionDetails?: OrchestratorSpecificConnectionDetailsUnion;
+}
+
+// @public (undocumented)
+export interface ControllerConnectionDetailsList {
+    connectionDetailsList?: ControllerConnectionDetails[];
+}
+
+// @public (undocumented)
+export interface ControllerList {
+    readonly nextLink?: string;
+    value?: Controller[];
+}
+
+// @public
+export interface Controllers {
+    beginCreate(resourceGroupName: string, name: string, controller: Controller, options?: ControllersCreateOptionalParams): Promise<PollerLike<PollOperationState<ControllersCreateResponse>, ControllersCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, name: string, controller: Controller, options?: ControllersCreateOptionalParams): Promise<ControllersCreateResponse>;
+    beginDelete(resourceGroupName: string, name: string, options?: ControllersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, name: string, options?: ControllersDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, name: string, options?: ControllersGetOptionalParams): Promise<ControllersGetResponse>;
+    list(options?: ControllersListOptionalParams): PagedAsyncIterableIterator<Controller>;
+    listByResourceGroup(resourceGroupName: string, options?: ControllersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Controller>;
+    listConnectionDetails(resourceGroupName: string, name: string, listConnectionDetailsParameters: ListConnectionDetailsParameters, options?: ControllersListConnectionDetailsOptionalParams): Promise<ControllersListConnectionDetailsResponse>;
+    update(resourceGroupName: string, name: string, controllerUpdateParameters: ControllerUpdateParameters, options?: ControllersUpdateOptionalParams): Promise<ControllersUpdateResponse>;
+}
+
+// @public
+export interface ControllersCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type ControllersCreateResponse = Controller;
+
+// @public
+export interface ControllersDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface ControllersGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ControllersGetResponse = Controller;
+
+// @public
+export interface ControllersListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ControllersListByResourceGroupNextResponse = ControllerList;
+
+// @public
+export interface ControllersListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ControllersListByResourceGroupResponse = ControllerList;
+
+// @public
+export interface ControllersListConnectionDetailsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ControllersListConnectionDetailsResponse = ControllerConnectionDetailsList;
+
+// @public
+export interface ControllersListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ControllersListNextResponse = ControllerList;
+
+// @public
+export interface ControllersListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ControllersListResponse = ControllerList;
+
+// @public
+export interface ControllersUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ControllersUpdateResponse = Controller;
+
+// @public
+export interface ControllerUpdateParameters {
+    tags?: {
+        [propertyName: string]: string;
+    };
+    targetContainerHostCredentialsBase64?: string;
+}
+
+// @public
+export interface DevSpacesErrorResponse {
+    error?: ErrorDetails;
+}
+
+// @public (undocumented)
+export class DevSpacesManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: DevSpacesManagementClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    containerHostMappings: ContainerHostMappings;
+    // (undocumented)
+    controllers: Controllers;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface DevSpacesManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public (undocumented)
+export interface ErrorDetails {
+    readonly code?: string;
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @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 & {
+    instanceType: "Kubernetes";
+    kubeConfig?: string;
+};
+
+// @public
+export interface ListConnectionDetailsParameters {
+    targetContainerHostResourceId: string;
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<ResourceProviderOperationDefinition>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = ResourceProviderOperationList;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = ResourceProviderOperationList;
+
+// @public
+export interface OrchestratorSpecificConnectionDetails {
+    instanceType: "Kubernetes";
+}
+
+// @public (undocumented)
+export type OrchestratorSpecificConnectionDetailsUnion = OrchestratorSpecificConnectionDetails | KubernetesConnectionDetails;
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public (undocumented)
+export interface ResourceProviderOperationDefinition {
+    // (undocumented)
+    display?: ResourceProviderOperationDisplay;
+    name?: string;
+}
+
+// @public (undocumented)
+export interface ResourceProviderOperationDisplay {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public (undocumented)
+export interface ResourceProviderOperationList {
+    readonly nextLink?: string;
+    value?: ResourceProviderOperationDefinition[];
+}
+
+// @public
+export interface Sku {
+    name: SkuName;
+    tier?: SkuTier;
+}
+
+// @public
+export type SkuName = string;
+
+// @public
+export type SkuTier = string;
+
+// @public
+export type TrackedResource = Resource & {
+    tags?: {
+        [propertyName: string]: string;
+    };
+    location?: string;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -1,31 +1,188 @@
-import nodeResolve from "rollup-plugin-node-resolve";
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import nodeResolve from "@rollup/plugin-node-resolve";
+import cjs from "@rollup/plugin-commonjs";
+import sourcemaps from "rollup-plugin-sourcemaps";
+import multiEntry from "@rollup/plugin-multi-entry";
+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
+ * the function returns `true`, then the warning will not be displayed.
+ */
+
+function ignoreNiseSinonEvalWarnings(warning) {
+  return (
+    warning.code === "EVAL" &&
+    warning.id &&
+      (warning.id.includes("node_modules/nise") ||
+        warning.id.includes("node_modules/sinon")) === true
+  );
+}
+
+function ignoreChaiCircularDependencyWarnings(warning) {
+  return (
+    warning.code === "CIRCULAR_DEPENDENCY" &&
+    warning.importer && warning.importer.includes("node_modules/chai") === true
+  );
+}
+
+const warningInhibitors = [
+  ignoreChaiCircularDependencyWarnings,
+  ignoreNiseSinonEvalWarnings
+];
+
 /**
- * @type {import('rollup').RollupFileOptions}
+ * Construct a warning handler for the shared rollup configuration
+ * that ignores certain warnings that are not relevant to testing.
  */
-const config = {
-  input: './esm/devSpacesManagementClient.js',
-  external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"],
-  output: {
-    file: "./dist/arm-devspaces.js",
-    format: "umd",
-    name: "Azure.ArmDevspaces",
-    sourcemap: true,
-    globals: {
-      "@azure/ms-rest-js": "msRest",
-      "@azure/ms-rest-azure-js": "msRestAzure"
+function makeOnWarnForTesting() {
+  return (warning, warn) => {
+    // If every inhibitor returns false (i.e. no inhibitors), then show the warning
+    if (warningInhibitors.every((inhib) => !inhib(warning))) {
+      warn(warning);
+    }
+  };
+}
+
+// #endregion
+
+function makeBrowserTestConfig() {
+  const config = {
+    input: {
+      include: ["dist-esm/test/**/*.spec.js"],
+      exclude: ["dist-esm/test/**/node/**"]
     },
-    banner: `/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for
- * license information.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is
- * regenerated.
- */`
-  },
-  plugins: [
-    nodeResolve({ module: true })
-  ]
+    output: {
+      file: `dist-test/index.browser.js`,
+      format: "umd",
+      sourcemap: true
+    },
+    preserveSymlinks: false,
+    plugins: [
+      multiEntry({ exports: false }),
+      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()
+        }
+      }),
+      json(),
+      sourcemaps()
+      //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
+    ],
+    onwarn: makeOnWarnForTesting(),
+    // Disable tree-shaking of test code.  In rollup-plugin-node-resolve@5.0.0,
+    // rollup started respecting the "sideEffects" field in package.json.  Since
+    // our package.json sets "sideEffects=false", this also applies to test
+    // code, which causes all tests to be removed by tree-shaking.
+    treeshake: false
+  };
+
+  return config;
+}
+
+const defaultConfigurationOptions = {
+  disableBrowserBundle: false
 };
-export default config;
+
+export function makeConfig(pkg, options) {
+  options = {
+    ...defaultConfigurationOptions,
+    ...(options || {})
+  };
+
+  const baseConfig = {
+    // Use the package's module field if it has one
+    input: pkg["module"] || "dist-esm/src/index.js",
+    external: [
+      ...nodeBuiltins,
+      ...Object.keys(pkg.dependencies),
+      ...Object.keys(pkg.devDependencies)
+    ],
+    output: { file: "dist/index.js", format: "cjs", sourcemap: true },
+    preserveSymlinks: false,
+    plugins: [sourcemaps(), nodeResolve(), cjs()]
+  };
+
+  const config = [baseConfig];
+
+  if (!options.disableBrowserBundle) {
+    config.push(makeBrowserTestConfig());
+  }
+
+  return config;
+}
+
+export default makeConfig(require("./package.json"));

package/src/devSpacesManagementClient.ts

@@ -1,52 +1,87 @@
 /*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for
- * license information.
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
  *
  * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is
- * regenerated.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import * as msRest from "@azure/ms-rest-js";
-import { TokenCredential } from "@azure/core-auth";
-import * as Models from "./models";
-import * as Mappers from "./models/mappers";
-import * as operations from "./operations";
-import { DevSpacesManagementClientContext } from "./devSpacesManagementClientContext";
+import * as coreClient from "@azure/core-client";
+import * as coreAuth from "@azure/core-auth";
+import {
+  ContainerHostMappingsImpl,
+  OperationsImpl,
+  ControllersImpl
+} from "./operations";
+import {
+  ContainerHostMappings,
+  Operations,
+  Controllers
+} from "./operationsInterfaces";
+import { DevSpacesManagementClientOptionalParams } from "./models";
 
-
-class DevSpacesManagementClient extends DevSpacesManagementClientContext {
-  // Operation groups
-  containerHostMappings: operations.ContainerHostMappings;
-  controllers: operations.Controllers;
-  operations: operations.Operations;
+export class DevSpacesManagementClient extends coreClient.ServiceClient {
+  $host: string;
+  apiVersion: string;
+  subscriptionId: string;
 
   /**
    * Initializes a new instance of the DevSpacesManagementClient class.
-   * @param credentials Credentials needed for the client to connect to Azure. Credentials
-   * implementing the TokenCredential interface from the @azure/identity package are recommended. For
-   * more information about these credentials, see
-   * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
-   * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
-   * @azure/ms-rest-browserauth are also supported.
+   * @param credentials Subscription credentials which uniquely identify client subscription.
    * @param subscriptionId Azure subscription ID.
-   * @param [options] The parameter options
+   * @param options The parameter options
    */
-  constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.DevSpacesManagementClientOptions) {
-    super(credentials, subscriptionId, options);
-    this.containerHostMappings = new operations.ContainerHostMappings(this);
-    this.controllers = new operations.Controllers(this);
-    this.operations = new operations.Operations(this);
-  }
-}
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    subscriptionId: string,
+    options?: DevSpacesManagementClientOptionalParams
+  ) {
+    if (credentials === undefined) {
+      throw new Error("'credentials' cannot be null");
+    }
+    if (subscriptionId === undefined) {
+      throw new Error("'subscriptionId' cannot be null");
+    }
+
+    // Initializing default values for options
+    if (!options) {
+      options = {};
+    }
+    const defaults: DevSpacesManagementClientOptionalParams = {
+      requestContentType: "application/json; charset=utf-8",
+      credential: credentials
+    };
 
-// Operation Specifications
+    const packageDetails = `azsdk-js-arm-devspaces/2.0.0`;
+    const userAgentPrefix =
+      options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
+        : `${packageDetails}`;
 
-export {
-  DevSpacesManagementClient,
-  DevSpacesManagementClientContext,
-  Models as DevSpacesManagementModels,
-  Mappers as DevSpacesManagementMappers
-};
-export * from "./operations";
+    if (!options.credentialScopes) {
+      options.credentialScopes = ["https://management.azure.com/.default"];
+    }
+    const optionsWithDefaults = {
+      ...defaults,
+      ...options,
+      userAgentOptions: {
+        userAgentPrefix
+      },
+      baseUri: options.endpoint || "https://management.azure.com"
+    };
+    super(optionsWithDefaults);
+    // Parameter assignments
+    this.subscriptionId = subscriptionId;
+
+    // Assigning values to Constant parameters
+    this.$host = options.$host || "https://management.azure.com";
+    this.apiVersion = options.apiVersion || "2019-04-01";
+    this.containerHostMappings = new ContainerHostMappingsImpl(this);
+    this.operations = new OperationsImpl(this);
+    this.controllers = new ControllersImpl(this);
+  }
+
+  containerHostMappings: ContainerHostMappings;
+  operations: Operations;
+  controllers: Controllers;
+}

package/src/index.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+/// <reference lib="esnext.asynciterable" />
+export * from "./models";
+export { DevSpacesManagementClient } from "./devSpacesManagementClient";
+export * from "./operationsInterfaces";

package/src/lroImpl.ts

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { LongRunningOperation, LroResponse } from "@azure/core-lro";
+
+export class LroImpl<T> implements LongRunningOperation<T> {
+  constructor(
+    private sendOperationFn: (args: any, spec: any) => Promise<LroResponse<T>>,
+    private args: Record<string, unknown>,
+    private spec: {
+      readonly requestBody?: unknown;
+      readonly path?: string;
+      readonly httpMethod: string;
+    } & Record<string, any>,
+    public requestPath: string = spec.path!,
+    public requestMethod: string = spec.httpMethod
+  ) {}
+  public async sendInitialRequest(): Promise<LroResponse<T>> {
+    return this.sendOperationFn(this.args, this.spec);
+  }
+  public async sendPollRequest(path: string): Promise<LroResponse<T>> {
+    const { requestBody, ...restSpec } = this.spec;
+    return this.sendOperationFn(this.args, {
+      ...restSpec,
+      path,
+      httpMethod: "GET"
+    });
+  }
+}