@azure/arm-portal 1.0.0-beta.1 → 1.0.0-beta.4

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/models/index.ts

@@ -233,26 +233,27 @@ export interface MarkdownPartMetadataSettingsContentSettings {
 }
 
 /** Markdown part metadata. */
-export type MarkdownPartMetadata = DashboardPartMetadata & {
+export interface MarkdownPartMetadata extends DashboardPartMetadata {
   /** Polymorphic discriminator, which specifies the different types this object can be */
   type: "Extension/HubsExtension/PartType/MarkdownPart";
   /** Input to dashboard part. */
   inputs?: Record<string, unknown>[];
   /** Markdown part settings. */
   settings?: MarkdownPartMetadataSettings;
-};
+}
 
 /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
-export type ProxyResource = Resource & {};
+export interface ProxyResource extends Resource {}
 
 /** Tenant configuration. */
-export type Configuration = ProxyResource & {
+export interface Configuration extends ProxyResource {
   /** When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. */
   enforcePrivateMarkdownStorage?: boolean;
-};
+}
 
 /** Known values of {@link ConfigurationName} that the service accepts. */
 export enum KnownConfigurationName {
+  /** Default */
   Default = "default"
 }
 

package/src/portal.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 {
   OperationsImpl,
@@ -55,7 +61,7 @@ export class Portal extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-portal/1.0.0-beta.1`;
+    const packageDetails = `azsdk-js-arm-portal/1.0.0-beta.4`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -70,9 +76,33 @@ export class Portal extends coreClient.ServiceClient {
       userAgentOptions: {
         userAgentPrefix
       },
-      baseUri: options.endpoint || "https://management.azure.com"
+      baseUri:
+        options.endpoint ?? options.baseUri ?? "https://management.azure.com"
     };
     super(optionsWithDefaults);
+
+    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
+      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
+      const 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
+            }
+          })
+        );
+      }
+    }
     // Parameter assignments
     this.subscriptionId = subscriptionId;
 
@@ -85,6 +115,35 @@ export class Portal extends coreClient.ServiceClient {
     this.listTenantConfigurationViolations = new ListTenantConfigurationViolationsImpl(
       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);
   }
 
   operations: Operations;

package/tsconfig.json

@@ -9,11 +9,25 @@
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "forceConsistentCasingInFileNames": true,
-    "lib": ["es6", "dom"],
+    "lib": [
+      "es6",
+      "dom"
+    ],
     "declaration": true,
     "outDir": "./dist-esm",
-    "importHelpers": true
+    "importHelpers": true,
+    "paths": {
+      "@azure/arm-portal": [
+        "./src/index"
+      ]
+    }
   },
-  "include": ["./src/**/*.ts", "./test/**/*.ts"],
-  "exclude": ["node_modules"]
-}
+  "include": [
+    "./src/**/*.ts",
+    "./test/**/*.ts",
+    "samples-dev/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/types/arm-portal.d.ts

@@ -3,10 +3,10 @@ import * as coreClient from '@azure/core-client';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 
 /** Tenant configuration. */
-export declare type Configuration = ProxyResource & {
+export declare interface Configuration extends ProxyResource {
     /** When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. */
     enforcePrivateMarkdownStorage?: boolean;
-};
+}
 
 /** List of tenant configurations. */
 export declare interface ConfigurationList {
@@ -235,6 +235,7 @@ export declare interface ErrorResponse {
 
 /** Known values of {@link ConfigurationName} that the service accepts. */
 export declare enum KnownConfigurationName {
+    /** Default */
     Default = "default"
 }
 
@@ -262,14 +263,14 @@ export declare interface ListTenantConfigurationViolationsListOptionalParams ext
 export declare type ListTenantConfigurationViolationsListResponse = ViolationsList;
 
 /** Markdown part metadata. */
-export declare type MarkdownPartMetadata = DashboardPartMetadata & {
+export declare interface MarkdownPartMetadata extends DashboardPartMetadata {
     /** Polymorphic discriminator, which specifies the different types this object can be */
     type: "Extension/HubsExtension/PartType/MarkdownPart";
     /** Input to dashboard part. */
     inputs?: Record<string, unknown>[];
     /** Markdown part settings. */
     settings?: MarkdownPartMetadataSettings;
-};
+}
 
 /** Markdown part settings. */
 export declare interface MarkdownPartMetadataSettings {
@@ -346,6 +347,8 @@ export declare class Portal extends coreClient.ServiceClient {
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: PortalOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     operations: Operations;
     dashboards: Dashboards;
     tenantConfigurations: TenantConfigurations;
@@ -363,7 +366,8 @@ export declare interface PortalOptionalParams extends coreClient.ServiceClientOp
 }
 
 /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
-export declare type ProxyResource = Resource & {};
+export declare interface ProxyResource extends Resource {
+}
 
 /** Common fields that are returned in the response for all Azure Resource Manager resources */
 export declare interface Resource {

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.18.19"
+      "packageVersion": "7.18.11"
     }
   ]
 }