@azure/arm-oep 1.0.0-beta.1 → 1.0.0-beta.3

package/review/arm-oep.api.md

@@ -46,13 +46,14 @@ export interface EnergyResourceUpdate {
 }
 
 // @public (undocumented)
-export type EnergyService = Resource & {
+export interface EnergyService extends Resource {
+    location: string;
+    // (undocumented)
     properties?: EnergyServiceProperties;
     tags?: {
         [propertyName: string]: string;
     };
-    location: string;
-};
+}
 
 // @public
 export interface EnergyServiceList {
@@ -162,57 +163,43 @@ export interface ErrorResponse {
     error?: ErrorDetail;
 }
 
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
 // @public
 export enum KnownActionType {
-    // (undocumented)
     Internal = "Internal"
 }
 
 // @public
 export enum KnownCheckNameAvailabilityReason {
-    // (undocumented)
     AlreadyExists = "AlreadyExists",
-    // (undocumented)
     Invalid = "Invalid"
 }
 
 // @public
 export enum KnownCreatedByType {
-    // (undocumented)
     Application = "Application",
-    // (undocumented)
     Key = "Key",
-    // (undocumented)
     ManagedIdentity = "ManagedIdentity",
-    // (undocumented)
     User = "User"
 }
 
 // @public
 export enum KnownOrigin {
-    // (undocumented)
     System = "system",
-    // (undocumented)
     User = "user",
-    // (undocumented)
     UserSystem = "user,system"
 }
 
 // @public
 export enum KnownProvisioningState {
-    // (undocumented)
     Canceled = "Canceled",
-    // (undocumented)
     Creating = "Creating",
-    // (undocumented)
     Deleting = "Deleting",
-    // (undocumented)
     Failed = "Failed",
-    // (undocumented)
     Succeeded = "Succeeded",
-    // (undocumented)
     Unknown = "Unknown",
-    // (undocumented)
     Updating = "Updating"
 }
 

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

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

package/src/models/index.ts

@@ -207,17 +207,19 @@ export interface OperationDisplay {
   readonly description?: string;
 }
 
-export type EnergyService = Resource & {
+export interface EnergyService extends Resource {
   properties?: EnergyServiceProperties;
   /** Resource tags. */
   tags?: { [propertyName: string]: string };
   /** Geo-location where the resource lives. */
   location: string;
-};
+}
 
 /** Known values of {@link CheckNameAvailabilityReason} that the service accepts. */
 export enum KnownCheckNameAvailabilityReason {
+  /** Invalid */
   Invalid = "Invalid",
+  /** AlreadyExists */
   AlreadyExists = "AlreadyExists"
 }
 
@@ -233,12 +235,19 @@ export type CheckNameAvailabilityReason = string;
 
 /** Known values of {@link ProvisioningState} that the service accepts. */
 export enum KnownProvisioningState {
+  /** Unknown */
   Unknown = "Unknown",
+  /** Succeeded */
   Succeeded = "Succeeded",
+  /** Failed */
   Failed = "Failed",
+  /** Canceled */
   Canceled = "Canceled",
+  /** Creating */
   Creating = "Creating",
+  /** Deleting */
   Deleting = "Deleting",
+  /** Updating */
   Updating = "Updating"
 }
 
@@ -259,9 +268,13 @@ export type ProvisioningState = 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"
 }
 
@@ -279,8 +292,11 @@ export type CreatedByType = string;
 
 /** Known values of {@link Origin} that the service accepts. */
 export enum KnownOrigin {
+  /** User */
   User = "user",
+  /** System */
   System = "system",
+  /** UserSystem */
   UserSystem = "user,system"
 }
 
@@ -297,6 +313,7 @@ export type Origin = string;
 
 /** Known values of {@link ActionType} that the service accepts. */
 export enum KnownActionType {
+  /** Internal */
   Internal = "Internal"
 }
 

package/src/openEnergyPlatformManagementServiceAPIs.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 {
   LocationsImpl,
@@ -48,24 +54,54 @@ export class OpenEnergyPlatformManagementServiceAPIs extends coreClient.ServiceC
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-oep/1.0.0-beta.1`;
+    const packageDetails = `azsdk-js-arm-oep/1.0.0-beta.3`;
     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;
 
@@ -75,6 +111,35 @@ export class OpenEnergyPlatformManagementServiceAPIs extends coreClient.ServiceC
     this.locations = new LocationsImpl(this);
     this.energyServices = new EnergyServicesImpl(this);
     this.operations = new OperationsImpl(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);
   }
 
   locations: Locations;

package/src/operations/energyServices.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 { EnergyServices } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -18,9 +19,9 @@ import {
   EnergyService,
   EnergyServicesListByResourceGroupNextOptionalParams,
   EnergyServicesListByResourceGroupOptionalParams,
+  EnergyServicesListByResourceGroupResponse,
   EnergyServicesListBySubscriptionNextOptionalParams,
   EnergyServicesListBySubscriptionOptionalParams,
-  EnergyServicesListByResourceGroupResponse,
   EnergyServicesListBySubscriptionResponse,
   EnergyServicesGetOptionalParams,
   EnergyServicesGetResponse,
@@ -63,19 +64,33 @@ export class EnergyServicesImpl implements EnergyServices {
       [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?: EnergyServicesListByResourceGroupOptionalParams
+    options?: EnergyServicesListByResourceGroupOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<EnergyService[]> {
-    let result = await this._listByResourceGroup(resourceGroupName, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: EnergyServicesListByResourceGroupResponse;
+    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,
@@ -83,7 +98,9 @@ export class EnergyServicesImpl implements EnergyServices {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -114,22 +131,34 @@ export class EnergyServicesImpl implements EnergyServices {
       [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?: EnergyServicesListBySubscriptionOptionalParams
+    options?: EnergyServicesListBySubscriptionOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<EnergyService[]> {
-    let result = await this._listBySubscription(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: EnergyServicesListBySubscriptionResponse;
+    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;
     }
   }
 
@@ -246,11 +275,13 @@ export class EnergyServicesImpl implements EnergyServices {
       { resourceGroupName, resourceName, options },
       createOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs,
       lroResourceLocationConfig: "azure-async-operation"
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -343,10 +374,12 @@ export class EnergyServicesImpl implements EnergyServices {
       { resourceGroupName, resourceName, options },
       deleteOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
+    await poller.poll();
+    return poller;
   }
 
   /**

package/src/pagingHelper.ts

@@ -0,0 +1,39 @@
+/*
+ * 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.
+ */
+
+export interface PageInfo {
+  continuationToken?: string;
+}
+
+const pageMap = new WeakMap<object, PageInfo>();
+
+/**
+ * Given a result page from a pageable operation, returns a
+ * continuation token that can be used to begin paging from
+ * that point later.
+ * @param page A result object from calling .byPage() on a paged operation.
+ * @returns The continuation token that can be passed into byPage().
+ */
+export function getContinuationToken(page: unknown): string | undefined {
+  if (typeof page !== "object" || page === null) {
+    return undefined;
+  }
+  return pageMap.get(page)?.continuationToken;
+}
+
+export function setContinuationToken(
+  page: unknown,
+  continuationToken: string | undefined
+): void {
+  if (typeof page !== "object" || page === null || !continuationToken) {
+    return;
+  }
+  const pageInfo = pageMap.get(page) ?? {};
+  pageInfo.continuationToken = continuationToken;
+  pageMap.set(page, pageInfo);
+}

package/tsconfig.json

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

package/types/arm-oep.d.ts

@@ -66,7 +66,7 @@ export declare interface EnergyResourceUpdate {
     };
 }
 
-export declare type EnergyService = Resource & {
+export declare interface EnergyService extends Resource {
     properties?: EnergyServiceProperties;
     /** Resource tags. */
     tags?: {
@@ -74,7 +74,7 @@ export declare type EnergyService = Resource & {
     };
     /** Geo-location where the resource lives. */
     location: string;
-};
+}
 
 /** The list of oep resources. */
 export declare interface EnergyServiceList {
@@ -263,40 +263,66 @@ export declare interface ErrorResponse {
     error?: ErrorDetail;
 }
 
+/**
+ * Given a result page from a pageable operation, returns a
+ * continuation token that can be used to begin paging from
+ * that point later.
+ * @param page A result object from calling .byPage() on a paged operation.
+ * @returns The continuation token that can be passed into byPage().
+ */
+export declare function getContinuationToken(page: unknown): string | undefined;
+
 /** Known values of {@link ActionType} that the service accepts. */
 export declare enum KnownActionType {
+    /** Internal */
     Internal = "Internal"
 }
 
 /** Known values of {@link CheckNameAvailabilityReason} that the service accepts. */
 export declare enum KnownCheckNameAvailabilityReason {
+    /** Invalid */
     Invalid = "Invalid",
+    /** AlreadyExists */
     AlreadyExists = "AlreadyExists"
 }
 
 /** Known values of {@link CreatedByType} that the service accepts. */
 export declare enum KnownCreatedByType {
+    /** User */
     User = "User",
+    /** Application */
     Application = "Application",
+    /** ManagedIdentity */
     ManagedIdentity = "ManagedIdentity",
+    /** Key */
     Key = "Key"
 }
 
 /** Known values of {@link Origin} that the service accepts. */
 export declare enum KnownOrigin {
+    /** User */
     User = "user",
+    /** System */
     System = "system",
+    /** UserSystem */
     UserSystem = "user,system"
 }
 
 /** Known values of {@link ProvisioningState} that the service accepts. */
 export declare enum KnownProvisioningState {
+    /** Unknown */
     Unknown = "Unknown",
+    /** Succeeded */
     Succeeded = "Succeeded",
+    /** Failed */
     Failed = "Failed",
+    /** Canceled */
     Canceled = "Canceled",
+    /** Creating */
     Creating = "Creating",
+    /** Deleting */
     Deleting = "Deleting",
+    /** Updating */
     Updating = "Updating"
 }
 
@@ -328,6 +354,8 @@ export declare class OpenEnergyPlatformManagementServiceAPIs extends coreClient.
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: OpenEnergyPlatformManagementServiceAPIsOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     locations: Locations;
     energyServices: EnergyServices;
     operations: Operations;