@azure/arm-relay 3.1.0 → 3.1.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History
     
+## 3.1.1 (2023-02-01)
+
+**Features**
+
+  - Exposes `getContinuationToken` helper function to extract continuation token
+
+**Bugs Fixed**
+
+  - A series of small bug fixs relevant to authentication and apiVersion policy
+
 ## 3.1.0 (2022-07-08)
     
 **Features**

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Microsoft
+Copyright (c) 2023 Microsoft
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -13,7 +13,7 @@ Use these API to manage Azure Relay resources through Azure Resource Manager.
 
 ### Currently supported environments
 
-- [LTS versions of Node.js](https://nodejs.org/about/releases/)
+- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
 - Latest versions of Safari, Chrome, Edge and Firefox.
 
 See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.

package/dist/index.js

@@ -28,6 +28,38 @@ function _interopNamespace(e) {
 var coreClient__namespace = /*#__PURE__*/_interopNamespace(coreClient);
 var coreRestPipeline__namespace = /*#__PURE__*/_interopNamespace(coreRestPipeline);
 
+/*
+ * 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.
+ */
+const pageMap = new WeakMap();
+/**
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
+ * that point later.
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
+ */
+function getContinuationToken(page) {
+    var _a;
+    if (typeof page !== "object" || page === null) {
+        return undefined;
+    }
+    return (_a = pageMap.get(page)) === null || _a === void 0 ? void 0 : _a.continuationToken;
+}
+function setContinuationToken(page, continuationToken) {
+    var _a;
+    if (typeof page !== "object" || page === null || !continuationToken) {
+        return;
+    }
+    const pageInfo = (_a = pageMap.get(page)) !== null && _a !== void 0 ? _a : {};
+    pageInfo.continuationToken = continuationToken;
+    pageMap.set(page, pageInfo);
+}
+
 /*
  * Copyright (c) Microsoft Corporation.
  * Licensed under the MIT License.
@@ -876,20 +908,31 @@ class OperationsImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listPagingPage(options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listPagingPage(options, settings);
             }
         };
     }
-    listPagingPage(options) {
+    listPagingPage(options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listPagingPage_1() {
-            let result = yield tslib.__await(this._list(options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._list(options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listNext(continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -956,7 +999,6 @@ const listNextOperationSpec$1 = {
             bodyMapper: ErrorResponse
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [$host, nextLink],
     headerParameters: [accept],
     serializer: serializer$3
@@ -1020,20 +1062,31 @@ class NamespacesImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listPagingPage(options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listPagingPage(options, settings);
             }
         };
     }
-    listPagingPage(options) {
+    listPagingPage(options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listPagingPage_1() {
-            let result = yield tslib.__await(this._list(options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._list(options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listNext(continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -1069,20 +1122,31 @@ class NamespacesImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listByResourceGroupPagingPage(resourceGroupName, options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listByResourceGroupPagingPage(resourceGroupName, options, settings);
             }
         };
     }
-    listByResourceGroupPagingPage(resourceGroupName, options) {
+    listByResourceGroupPagingPage(resourceGroupName, options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listByResourceGroupPagingPage_1() {
-            let result = yield tslib.__await(this._listByResourceGroup(resourceGroupName, options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._listByResourceGroup(resourceGroupName, options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listByResourceGroupNext(resourceGroupName, continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -1119,20 +1183,31 @@ class NamespacesImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listAuthorizationRulesPagingPage(resourceGroupName, namespaceName, options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listAuthorizationRulesPagingPage(resourceGroupName, namespaceName, options, settings);
             }
         };
     }
-    listAuthorizationRulesPagingPage(resourceGroupName, namespaceName, options) {
+    listAuthorizationRulesPagingPage(resourceGroupName, namespaceName, options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listAuthorizationRulesPagingPage_1() {
-            let result = yield tslib.__await(this._listAuthorizationRules(resourceGroupName, namespaceName, options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._listAuthorizationRules(resourceGroupName, namespaceName, options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listAuthorizationRulesNext(resourceGroupName, namespaceName, continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -1706,7 +1781,6 @@ const listNextOperationSpec = {
             bodyMapper: ErrorResponse
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [
         $host,
         nextLink,
@@ -1726,7 +1800,6 @@ const listByResourceGroupNextOperationSpec = {
             bodyMapper: ErrorResponse
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [
         $host,
         nextLink,
@@ -1747,7 +1820,6 @@ const listAuthorizationRulesNextOperationSpec$2 = {
             bodyMapper: ErrorResponse
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [
         $host,
         nextLink,
@@ -1791,20 +1863,31 @@ class HybridConnectionsImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listByNamespacePagingPage(resourceGroupName, namespaceName, options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listByNamespacePagingPage(resourceGroupName, namespaceName, options, settings);
             }
         };
     }
-    listByNamespacePagingPage(resourceGroupName, namespaceName, options) {
+    listByNamespacePagingPage(resourceGroupName, namespaceName, options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listByNamespacePagingPage_1() {
-            let result = yield tslib.__await(this._listByNamespace(resourceGroupName, namespaceName, options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._listByNamespace(resourceGroupName, namespaceName, options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listByNamespaceNext(resourceGroupName, namespaceName, continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -1842,20 +1925,31 @@ class HybridConnectionsImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listAuthorizationRulesPagingPage(resourceGroupName, namespaceName, hybridConnectionName, options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listAuthorizationRulesPagingPage(resourceGroupName, namespaceName, hybridConnectionName, options, settings);
             }
         };
     }
-    listAuthorizationRulesPagingPage(resourceGroupName, namespaceName, hybridConnectionName, options) {
+    listAuthorizationRulesPagingPage(resourceGroupName, namespaceName, hybridConnectionName, options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listAuthorizationRulesPagingPage_1() {
-            let result = yield tslib.__await(this._listAuthorizationRules(resourceGroupName, namespaceName, hybridConnectionName, options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._listAuthorizationRules(resourceGroupName, namespaceName, hybridConnectionName, options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listAuthorizationRulesNext(resourceGroupName, namespaceName, hybridConnectionName, continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -2291,7 +2385,6 @@ const listByNamespaceNextOperationSpec$1 = {
             bodyMapper: ErrorResponse
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [
         $host,
         nextLink,
@@ -2313,7 +2406,6 @@ const listAuthorizationRulesNextOperationSpec$1 = {
             bodyMapper: ErrorResponse
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [
         $host,
         nextLink,
@@ -2358,20 +2450,31 @@ class WCFRelaysImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listByNamespacePagingPage(resourceGroupName, namespaceName, options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listByNamespacePagingPage(resourceGroupName, namespaceName, options, settings);
             }
         };
     }
-    listByNamespacePagingPage(resourceGroupName, namespaceName, options) {
+    listByNamespacePagingPage(resourceGroupName, namespaceName, options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listByNamespacePagingPage_1() {
-            let result = yield tslib.__await(this._listByNamespace(resourceGroupName, namespaceName, options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._listByNamespace(resourceGroupName, namespaceName, options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listByNamespaceNext(resourceGroupName, namespaceName, continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -2409,20 +2512,31 @@ class WCFRelaysImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listAuthorizationRulesPagingPage(resourceGroupName, namespaceName, relayName, options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listAuthorizationRulesPagingPage(resourceGroupName, namespaceName, relayName, options, settings);
             }
         };
     }
-    listAuthorizationRulesPagingPage(resourceGroupName, namespaceName, relayName, options) {
+    listAuthorizationRulesPagingPage(resourceGroupName, namespaceName, relayName, options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listAuthorizationRulesPagingPage_1() {
-            let result = yield tslib.__await(this._listAuthorizationRules(resourceGroupName, namespaceName, relayName, options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._listAuthorizationRules(resourceGroupName, namespaceName, relayName, options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listAuthorizationRulesNext(resourceGroupName, namespaceName, relayName, continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -2844,7 +2958,6 @@ const listByNamespaceNextOperationSpec = {
             bodyMapper: ErrorResponse
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [
         $host,
         nextLink,
@@ -2863,7 +2976,6 @@ const listAuthorizationRulesNextOperationSpec = {
             bodyMapper: AuthorizationRuleListResult
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [
         $host,
         nextLink,
@@ -2892,7 +3004,7 @@ class RelayAPI extends coreClient__namespace.ServiceClient {
      * @param options The parameter options
      */
     constructor(credentials, subscriptionId, options) {
-        var _a, _b;
+        var _a, _b, _c;
         if (credentials === undefined) {
             throw new Error("'credentials' cannot be null");
         }
@@ -2907,32 +3019,34 @@ class RelayAPI extends coreClient__namespace.ServiceClient {
             requestContentType: "application/json; charset=utf-8",
             credential: credentials
         };
-        const packageDetails = `azsdk-js-arm-relay/3.1.0`;
+        const packageDetails = `azsdk-js-arm-relay/3.1.1`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
-        if (!options.credentialScopes) {
-            options.credentialScopes = ["https://management.azure.com/.default"];
-        }
         const optionsWithDefaults = Object.assign(Object.assign(Object.assign({}, defaults), options), { userAgentOptions: {
                 userAgentPrefix
-            }, baseUri: (_b = (_a = options.endpoint) !== null && _a !== void 0 ? _a : options.baseUri) !== null && _b !== void 0 ? _b : "https://management.azure.com" });
+            }, endpoint: (_b = (_a = options.endpoint) !== null && _a !== void 0 ? _a : options.baseUri) !== null && _b !== void 0 ? _b : "https://management.azure.com" });
         super(optionsWithDefaults);
+        let bearerTokenAuthenticationPolicyFound = false;
         if ((options === null || options === void 0 ? void 0 : options.pipeline) && options.pipeline.getOrderedPolicies().length > 0) {
             const pipelinePolicies = options.pipeline.getOrderedPolicies();
-            const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some((pipelinePolicy) => pipelinePolicy.name ===
+            bearerTokenAuthenticationPolicyFound = pipelinePolicies.some((pipelinePolicy) => pipelinePolicy.name ===
                 coreRestPipeline__namespace.bearerTokenAuthenticationPolicyName);
-            if (!bearerTokenAuthenticationPolicyFound) {
-                this.pipeline.removePolicy({
-                    name: coreRestPipeline__namespace.bearerTokenAuthenticationPolicyName
-                });
-                this.pipeline.addPolicy(coreRestPipeline__namespace.bearerTokenAuthenticationPolicy({
-                    scopes: `${optionsWithDefaults.baseUri}/.default`,
-                    challengeCallbacks: {
-                        authorizeRequestOnChallenge: coreClient__namespace.authorizeRequestOnClaimChallenge
-                    }
-                }));
-            }
+        }
+        if (!options ||
+            !options.pipeline ||
+            options.pipeline.getOrderedPolicies().length == 0 ||
+            !bearerTokenAuthenticationPolicyFound) {
+            this.pipeline.removePolicy({
+                name: coreRestPipeline__namespace.bearerTokenAuthenticationPolicyName
+            });
+            this.pipeline.addPolicy(coreRestPipeline__namespace.bearerTokenAuthenticationPolicy({
+                credential: credentials,
+                scopes: (_c = optionsWithDefaults.credentialScopes) !== null && _c !== void 0 ? _c : `${optionsWithDefaults.endpoint}/.default`,
+                challengeCallbacks: {
+                    authorizeRequestOnChallenge: coreClient__namespace.authorizeRequestOnClaimChallenge
+                }
+            }));
         }
         // Parameter assignments
         this.subscriptionId = subscriptionId;
@@ -2975,4 +3089,5 @@ class RelayAPI extends coreClient__namespace.ServiceClient {
 }
 
 exports.RelayAPI = RelayAPI;
+exports.getContinuationToken = getContinuationToken;
 //# sourceMappingURL=index.js.map