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

package/src/operations/maps.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 { Maps } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,9 +17,9 @@ import {
   OperationDetail,
   MapsListOperationsNextOptionalParams,
   MapsListOperationsOptionalParams,
+  MapsListOperationsResponse,
   MapsListSubscriptionOperationsNextOptionalParams,
   MapsListSubscriptionOperationsOptionalParams,
-  MapsListOperationsResponse,
   MapsListSubscriptionOperationsResponse,
   MapsListOperationsNextResponse,
   MapsListSubscriptionOperationsNextResponse
@@ -52,22 +53,34 @@ export class MapsImpl implements Maps {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listOperationsPagingPage(options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listOperationsPagingPage(options, settings);
       }
     };
   }
 
   private async *listOperationsPagingPage(
-    options?: MapsListOperationsOptionalParams
+    options?: MapsListOperationsOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<OperationDetail[]> {
-    let result = await this._listOperations(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: MapsListOperationsResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listOperations(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listOperationsNext(continuationToken, options);
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -94,25 +107,37 @@ export class MapsImpl implements Maps {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listSubscriptionOperationsPagingPage(options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listSubscriptionOperationsPagingPage(options, settings);
       }
     };
   }
 
   private async *listSubscriptionOperationsPagingPage(
-    options?: MapsListSubscriptionOperationsOptionalParams
+    options?: MapsListSubscriptionOperationsOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<OperationDetail[]> {
-    let result = await this._listSubscriptionOperations(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: MapsListSubscriptionOperationsResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listSubscriptionOperations(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listSubscriptionOperationsNext(
         continuationToken,
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

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/types/arm-maps.d.ts

@@ -183,6 +183,8 @@ export declare class AzureMapsManagementClient extends coreClient.ServiceClient
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureMapsManagementClientOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     accounts: Accounts;
     maps: Maps;
     creators: Creators;
@@ -236,7 +238,7 @@ export declare interface CorsRules {
 export declare type CreatedByType = string;
 
 /** An Azure resource which represents Maps Creator product and provides ability to manage private location data. */
-export declare type Creator = TrackedResource & {
+export declare interface Creator extends TrackedResource {
     /** The Creator resource properties. */
     properties: CreatorProperties;
     /**
@@ -244,7 +246,7 @@ export declare type Creator = TrackedResource & {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly systemData?: SystemData;
-};
+}
 
 /** A list of Creator resources. */
 export declare interface CreatorList {
@@ -437,6 +439,15 @@ 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;
+
 /**
  * Defines values for KeyType. \
  * {@link KnownKeyType} can be used interchangeably with KeyType,
@@ -460,34 +471,47 @@ export declare type Kind = string;
 
 /** 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 KeyType} that the service accepts. */
 export declare enum KnownKeyType {
+    /** Primary */
     Primary = "primary",
+    /** Secondary */
     Secondary = "secondary"
 }
 
 /** Known values of {@link Kind} that the service accepts. */
 export declare enum KnownKind {
+    /** Gen1 */
     Gen1 = "Gen1",
+    /** Gen2 */
     Gen2 = "Gen2"
 }
 
 /** Known values of {@link Name} that the service accepts. */
 export declare enum KnownName {
+    /** S0 */
     S0 = "S0",
+    /** S1 */
     S1 = "S1",
+    /** G2 */
     G2 = "G2"
 }
 
 /** Known values of {@link SigningKey} that the service accepts. */
 export declare enum KnownSigningKey {
+    /** PrimaryKey */
     PrimaryKey = "primaryKey",
+    /** SecondaryKey */
     SecondaryKey = "secondaryKey"
 }
 
@@ -534,7 +558,7 @@ export declare interface Maps {
 }
 
 /** An Azure resource which represents access to a suite of Maps REST APIs. */
-export declare type MapsAccount = TrackedResource & {
+export declare interface MapsAccount extends TrackedResource {
     /** The SKU of this account. */
     sku: Sku;
     /** Get or Set Kind property. */
@@ -548,7 +572,7 @@ export declare type MapsAccount = TrackedResource & {
     identity?: ManagedServiceIdentity;
     /** The map account properties. */
     properties?: MapsAccountProperties;
-};
+}
 
 /** The set of keys which can be used to access the Maps REST APIs. Two keys are provided for key rotation without interruption. */
 export declare interface MapsAccountKeys {
@@ -824,13 +848,13 @@ export declare interface SystemData {
 }
 
 /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
-export declare type TrackedResource = Resource & {
+export declare interface TrackedResource extends Resource {
     /** Resource tags. */
     tags?: {
         [propertyName: string]: string;
     };
     /** The geo-location where the resource lives */
     location: string;
-};
+}
 
 export { }

package/types/tsdoc-metadata.json

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