@azure/arm-storage 19.1.0 → 20.0.0

package/dist/commonjs/restorePollerHelpers.d.ts

@@ -0,0 +1,21 @@
+import type { StorageManagementClient } from "./storageManagementClient.js";
+import type { OperationOptions, PathUncheckedResponse } from "@azure-rest/core-client";
+import type { AbortSignalLike } from "@azure/abort-controller";
+import type { PollerLike, OperationState } from "@azure/core-lro";
+export interface RestorePollerOptions<TResult, TResponse extends PathUncheckedResponse = PathUncheckedResponse> extends OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /**
+     * The signal which can be used to abort requests.
+     */
+    abortSignal?: AbortSignalLike;
+    /** Deserialization function for raw response body */
+    processResponseBody?: (result: TResponse) => Promise<TResult>;
+}
+/**
+ * Creates a poller from the serialized state of another poller. This can be
+ * useful when you want to create pollers on a different host or a poller
+ * needs to be constructed after the original one is not in scope.
+ */
+export declare function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: StorageManagementClient, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;
+//# sourceMappingURL=restorePollerHelpers.d.ts.map

package/dist/commonjs/restorePollerHelpers.js

@@ -0,0 +1,148 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var restorePollerHelpers_exports = {};
+__export(restorePollerHelpers_exports, {
+  restorePoller: () => restorePoller
+});
+module.exports = __toCommonJS(restorePollerHelpers_exports);
+var import_operations = require("./api/dataShares/operations.js");
+var import_operations2 = require("./api/connectors/operations.js");
+var import_operations3 = require("./api/storageTaskAssignments/operations.js");
+var import_operations4 = require("./api/networkSecurityPerimeterConfigurations/operations.js");
+var import_operations5 = require("./api/storageAccounts/operations.js");
+var import_operations6 = require("./api/blobContainers/operations.js");
+var import_pollingHelpers = require("./static-helpers/pollingHelpers.js");
+var import_core_lro = require("@azure/core-lro");
+function restorePoller(client, serializedState, sourceOperation, options) {
+  const pollerConfig = (0, import_core_lro.deserializeState)(serializedState).config;
+  const { initialRequestUrl, requestMethod, metadata } = pollerConfig;
+  if (!initialRequestUrl || !requestMethod) {
+    throw new Error(
+      `Invalid serialized state: ${serializedState} for sourceOperation ${sourceOperation?.name}`
+    );
+  }
+  const resourceLocationConfig = metadata?.["resourceLocationConfig"];
+  const { deserializer, expectedStatuses = [] } = getDeserializationHelper(initialRequestUrl, requestMethod) ?? {};
+  const deserializeHelper = options?.processResponseBody ?? deserializer;
+  if (!deserializeHelper) {
+    throw new Error(
+      `Please ensure the operation is in this client! We can't find its deserializeHelper for ${sourceOperation?.name}.`
+    );
+  }
+  const apiVersion = getApiVersionFromUrl(initialRequestUrl);
+  return (0, import_pollingHelpers.getLongRunningPoller)(
+    client["_client"] ?? client,
+    deserializeHelper,
+    expectedStatuses,
+    {
+      updateIntervalInMs: options?.updateIntervalInMs,
+      abortSignal: options?.abortSignal,
+      resourceLocationConfig,
+      restoreFrom: serializedState,
+      initialRequestUrl,
+      apiVersion
+    }
+  );
+}
+const deserializeMap = {
+  "DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares/{dataShareName}": { deserializer: import_operations._$deleteDeserialize, expectedStatuses: ["202", "204", "200"] },
+  "PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares/{dataShareName}": { deserializer: import_operations._updateDeserialize, expectedStatuses: ["200", "202", "201"] },
+  "PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares/{dataShareName}": { deserializer: import_operations._createDeserialize, expectedStatuses: ["200", "201", "202"] },
+  "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}/testExistingConnection": { deserializer: import_operations2._testExistingConnectionDeserialize, expectedStatuses: ["200", "202", "201"] },
+  "DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}": { deserializer: import_operations2._$deleteDeserialize, expectedStatuses: ["202", "204", "200"] },
+  "PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}": { deserializer: import_operations2._updateDeserialize, expectedStatuses: ["200", "202", "201"] },
+  "PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}": { deserializer: import_operations2._createDeserialize, expectedStatuses: ["200", "201", "202"] },
+  "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}/stopAssignment": { deserializer: import_operations3._stopAssignmentDeserialize, expectedStatuses: ["202", "204", "200", "201"] },
+  "DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}": {
+    deserializer: import_operations3._$deleteDeserialize,
+    expectedStatuses: ["202", "204", "200"]
+  },
+  "PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}": {
+    deserializer: import_operations3._updateDeserialize,
+    expectedStatuses: ["200", "202", "201"]
+  },
+  "PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}": {
+    deserializer: import_operations3._createDeserialize,
+    expectedStatuses: ["200", "201", "202"]
+  },
+  "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile": { deserializer: import_operations4._reconcileDeserialize, expectedStatuses: ["202", "200", "201"] },
+  "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/restoreBlobRanges": { deserializer: import_operations5._restoreBlobRangesDeserialize, expectedStatuses: ["200", "202", "201"] },
+  "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/startAccountMigration": {
+    deserializer: import_operations5._customerInitiatedMigrationDeserialize,
+    expectedStatuses: ["202", "200", "201"]
+  },
+  "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/aborthnsonmigration": {
+    deserializer: import_operations5._abortHierarchicalNamespaceMigrationDeserialize,
+    expectedStatuses: ["202", "200", "201"]
+  },
+  "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/hnsonmigration": {
+    deserializer: import_operations5._hierarchicalNamespaceMigrationDeserialize,
+    expectedStatuses: ["202", "200", "201"]
+  },
+  "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/failover": { deserializer: import_operations5._failoverDeserialize, expectedStatuses: ["202", "200", "201"] },
+  "PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": { deserializer: import_operations5._createDeserialize, expectedStatuses: ["200", "202", "201"] },
+  "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/migrate": { deserializer: import_operations6._objectLevelWormDeserialize, expectedStatuses: ["202", "200", "201"] }
+};
+function getDeserializationHelper(urlStr, method) {
+  const path = new URL(urlStr).pathname;
+  const pathParts = path.split("/");
+  let matchedLen = -1, matchedValue;
+  for (const [key, value] of Object.entries(deserializeMap)) {
+    if (!key.startsWith(method)) {
+      continue;
+    }
+    const candidatePath = getPathFromMapKey(key);
+    const candidateParts = candidatePath.split("/");
+    let found = true;
+    for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {
+      if (candidateParts[i]?.startsWith("{") && candidateParts[i]?.indexOf("}") !== -1) {
+        const start = candidateParts[i].indexOf("}") + 1, end = candidateParts[i]?.length;
+        const isMatched = new RegExp(`${candidateParts[i]?.slice(start, end)}`).test(
+          pathParts[j] || ""
+        );
+        if (!isMatched) {
+          found = false;
+          break;
+        }
+        continue;
+      }
+      if (candidateParts[i] !== pathParts[j]) {
+        found = false;
+        break;
+      }
+    }
+    if (found && candidatePath.length > matchedLen) {
+      matchedLen = candidatePath.length;
+      matchedValue = value;
+    }
+  }
+  return matchedValue;
+}
+function getPathFromMapKey(mapKey) {
+  const pathStart = mapKey.indexOf("/");
+  return mapKey.slice(pathStart);
+}
+function getApiVersionFromUrl(urlStr) {
+  const url = new URL(urlStr);
+  return url.searchParams.get("api-version") ?? void 0;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  restorePoller
+});
+//# sourceMappingURL=restorePollerHelpers.js.map

package/dist/commonjs/restorePollerHelpers.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/restorePollerHelpers.ts"],
+  "sourcesContent": ["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { StorageManagementClient } from \"./storageManagementClient.js\";\nimport {\n  _$deleteDeserialize,\n  _updateDeserialize,\n  _createDeserialize,\n} from \"./api/dataShares/operations.js\";\nimport {\n  _testExistingConnectionDeserialize,\n  _$deleteDeserialize as _$deleteDeserializeConnectors,\n  _updateDeserialize as _updateDeserializeConnectors,\n  _createDeserialize as _createDeserializeConnectors,\n} from \"./api/connectors/operations.js\";\nimport {\n  _stopAssignmentDeserialize,\n  _$deleteDeserialize as _$deleteDeserializeStorageTaskAssignments,\n  _updateDeserialize as _updateDeserializeStorageTaskAssignments,\n  _createDeserialize as _createDeserializeStorageTaskAssignments,\n} from \"./api/storageTaskAssignments/operations.js\";\nimport { _reconcileDeserialize } from \"./api/networkSecurityPerimeterConfigurations/operations.js\";\nimport {\n  _restoreBlobRangesDeserialize,\n  _customerInitiatedMigrationDeserialize,\n  _abortHierarchicalNamespaceMigrationDeserialize,\n  _hierarchicalNamespaceMigrationDeserialize,\n  _failoverDeserialize,\n  _createDeserialize as _createDeserializeStorageAccounts,\n} from \"./api/storageAccounts/operations.js\";\nimport { _objectLevelWormDeserialize } from \"./api/blobContainers/operations.js\";\nimport { getLongRunningPoller } from \"./static-helpers/pollingHelpers.js\";\nimport type { OperationOptions, PathUncheckedResponse } from \"@azure-rest/core-client\";\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\nimport type { PollerLike, OperationState, ResourceLocationConfig } from \"@azure/core-lro\";\nimport { deserializeState } from \"@azure/core-lro\";\n\nexport interface RestorePollerOptions<\n  TResult,\n  TResponse extends PathUncheckedResponse = PathUncheckedResponse,\n> extends OperationOptions {\n  /** Delay to wait until next poll, in milliseconds. */\n  updateIntervalInMs?: number;\n  /**\n   * The signal which can be used to abort requests.\n   */\n  abortSignal?: AbortSignalLike;\n  /** Deserialization function for raw response body */\n  processResponseBody?: (result: TResponse) => Promise<TResult>;\n}\n\n/**\n * Creates a poller from the serialized state of another poller. This can be\n * useful when you want to create pollers on a different host or a poller\n * needs to be constructed after the original one is not in scope.\n */\nexport function restorePoller<TResponse extends PathUncheckedResponse, TResult>(\n  client: StorageManagementClient,\n  serializedState: string,\n  sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>,\n  options?: RestorePollerOptions<TResult>,\n): PollerLike<OperationState<TResult>, TResult> {\n  const pollerConfig = deserializeState(serializedState).config;\n  const { initialRequestUrl, requestMethod, metadata } = pollerConfig;\n  if (!initialRequestUrl || !requestMethod) {\n    throw new Error(\n      `Invalid serialized state: ${serializedState} for sourceOperation ${sourceOperation?.name}`,\n    );\n  }\n  const resourceLocationConfig = metadata?.[\"resourceLocationConfig\"] as\n    | ResourceLocationConfig\n    | undefined;\n  const { deserializer, expectedStatuses = [] } =\n    getDeserializationHelper(initialRequestUrl, requestMethod) ?? {};\n  const deserializeHelper = options?.processResponseBody ?? deserializer;\n  if (!deserializeHelper) {\n    throw new Error(\n      `Please ensure the operation is in this client! We can't find its deserializeHelper for ${sourceOperation?.name}.`,\n    );\n  }\n  const apiVersion = getApiVersionFromUrl(initialRequestUrl);\n  return getLongRunningPoller(\n    (client as any)[\"_client\"] ?? client,\n    deserializeHelper as (result: TResponse) => Promise<TResult>,\n    expectedStatuses,\n    {\n      updateIntervalInMs: options?.updateIntervalInMs,\n      abortSignal: options?.abortSignal,\n      resourceLocationConfig,\n      restoreFrom: serializedState,\n      initialRequestUrl,\n      apiVersion,\n    },\n  );\n}\n\ninterface DeserializationHelper {\n  deserializer: (result: PathUncheckedResponse) => Promise<any>;\n  expectedStatuses: string[];\n}\n\nconst deserializeMap: Record<string, DeserializationHelper> = {\n  \"DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares/{dataShareName}\":\n    { deserializer: _$deleteDeserialize, expectedStatuses: [\"202\", \"204\", \"200\"] },\n  \"PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares/{dataShareName}\":\n    { deserializer: _updateDeserialize, expectedStatuses: [\"200\", \"202\", \"201\"] },\n  \"PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares/{dataShareName}\":\n    { deserializer: _createDeserialize, expectedStatuses: [\"200\", \"201\", \"202\"] },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}/testExistingConnection\":\n    { deserializer: _testExistingConnectionDeserialize, expectedStatuses: [\"200\", \"202\", \"201\"] },\n  \"DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}\":\n    { deserializer: _$deleteDeserializeConnectors, expectedStatuses: [\"202\", \"204\", \"200\"] },\n  \"PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}\":\n    { deserializer: _updateDeserializeConnectors, expectedStatuses: [\"200\", \"202\", \"201\"] },\n  \"PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}\":\n    { deserializer: _createDeserializeConnectors, expectedStatuses: [\"200\", \"201\", \"202\"] },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}/stopAssignment\":\n    { deserializer: _stopAssignmentDeserialize, expectedStatuses: [\"202\", \"204\", \"200\", \"201\"] },\n  \"DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}\":\n    {\n      deserializer: _$deleteDeserializeStorageTaskAssignments,\n      expectedStatuses: [\"202\", \"204\", \"200\"],\n    },\n  \"PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}\":\n    {\n      deserializer: _updateDeserializeStorageTaskAssignments,\n      expectedStatuses: [\"200\", \"202\", \"201\"],\n    },\n  \"PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}\":\n    {\n      deserializer: _createDeserializeStorageTaskAssignments,\n      expectedStatuses: [\"200\", \"201\", \"202\"],\n    },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile\":\n    { deserializer: _reconcileDeserialize, expectedStatuses: [\"202\", \"200\", \"201\"] },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/restoreBlobRanges\":\n    { deserializer: _restoreBlobRangesDeserialize, expectedStatuses: [\"200\", \"202\", \"201\"] },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/startAccountMigration\":\n    {\n      deserializer: _customerInitiatedMigrationDeserialize,\n      expectedStatuses: [\"202\", \"200\", \"201\"],\n    },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/aborthnsonmigration\":\n    {\n      deserializer: _abortHierarchicalNamespaceMigrationDeserialize,\n      expectedStatuses: [\"202\", \"200\", \"201\"],\n    },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/hnsonmigration\":\n    {\n      deserializer: _hierarchicalNamespaceMigrationDeserialize,\n      expectedStatuses: [\"202\", \"200\", \"201\"],\n    },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/failover\":\n    { deserializer: _failoverDeserialize, expectedStatuses: [\"202\", \"200\", \"201\"] },\n  \"PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}\":\n    { deserializer: _createDeserializeStorageAccounts, expectedStatuses: [\"200\", \"202\", \"201\"] },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/migrate\":\n    { deserializer: _objectLevelWormDeserialize, expectedStatuses: [\"202\", \"200\", \"201\"] },\n};\n\nfunction getDeserializationHelper(\n  urlStr: string,\n  method: string,\n): DeserializationHelper | undefined {\n  const path = new URL(urlStr).pathname;\n  const pathParts = path.split(\"/\");\n\n  // Traverse list to match the longest candidate\n  // matchedLen: the length of candidate path\n  // matchedValue: the matched status code array\n  let matchedLen = -1,\n    matchedValue: DeserializationHelper | undefined;\n\n  // Iterate the responseMap to find a match\n  for (const [key, value] of Object.entries(deserializeMap)) {\n    // Extracting the path from the map key which is in format\n    // GET /path/foo\n    if (!key.startsWith(method)) {\n      continue;\n    }\n    const candidatePath = getPathFromMapKey(key);\n    // Get each part of the url path\n    const candidateParts = candidatePath.split(\"/\");\n\n    // track if we have found a match to return the values found.\n    let found = true;\n    for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {\n      if (candidateParts[i]?.startsWith(\"{\") && candidateParts[i]?.indexOf(\"}\") !== -1) {\n        const start = candidateParts[i]!.indexOf(\"}\") + 1,\n          end = candidateParts[i]?.length;\n        // If the current part of the candidate is a \"template\" part\n        // Try to use the suffix of pattern to match the path\n        // {guid} ==> $\n        // {guid}:export ==> :export$\n        const isMatched = new RegExp(`${candidateParts[i]?.slice(start, end)}`).test(\n          pathParts[j] || \"\",\n        );\n\n        if (!isMatched) {\n          found = false;\n          break;\n        }\n        continue;\n      }\n\n      // If the candidate part is not a template and\n      // the parts don't match mark the candidate as not found\n      // to move on with the next candidate path.\n      if (candidateParts[i] !== pathParts[j]) {\n        found = false;\n        break;\n      }\n    }\n\n    // We finished evaluating the current candidate parts\n    // Update the matched value if and only if we found the longer pattern\n    if (found && candidatePath.length > matchedLen) {\n      matchedLen = candidatePath.length;\n      matchedValue = value;\n    }\n  }\n\n  return matchedValue;\n}\n\nfunction getPathFromMapKey(mapKey: string): string {\n  const pathStart = mapKey.indexOf(\"/\");\n  return mapKey.slice(pathStart);\n}\n\nfunction getApiVersionFromUrl(urlStr: string): string | undefined {\n  const url = new URL(urlStr);\n  return url.searchParams.get(\"api-version\") ?? undefined;\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIA,wBAIO;AACP,IAAAA,qBAKO;AACP,IAAAA,qBAKO;AACP,IAAAA,qBAAsC;AACtC,IAAAA,qBAOO;AACP,IAAAA,qBAA4C;AAC5C,4BAAqC;AAIrC,sBAAiC;AAqB1B,SAAS,cACd,QACA,iBACA,iBACA,SAC8C;AAC9C,QAAM,mBAAe,kCAAiB,eAAe,EAAE;AACvD,QAAM,EAAE,mBAAmB,eAAe,SAAS,IAAI;AACvD,MAAI,CAAC,qBAAqB,CAAC,eAAe;AACxC,UAAM,IAAI;AAAA,MACR,6BAA6B,eAAe,wBAAwB,iBAAiB,IAAI;AAAA,IAC3F;AAAA,EACF;AACA,QAAM,yBAAyB,WAAW,wBAAwB;AAGlE,QAAM,EAAE,cAAc,mBAAmB,CAAC,EAAE,IAC1C,yBAAyB,mBAAmB,aAAa,KAAK,CAAC;AACjE,QAAM,oBAAoB,SAAS,uBAAuB;AAC1D,MAAI,CAAC,mBAAmB;AACtB,UAAM,IAAI;AAAA,MACR,0FAA0F,iBAAiB,IAAI;AAAA,IACjH;AAAA,EACF;AACA,QAAM,aAAa,qBAAqB,iBAAiB;AACzD,aAAO;AAAA,IACJ,OAAe,SAAS,KAAK;AAAA,IAC9B;AAAA,IACA;AAAA,IACA;AAAA,MACE,oBAAoB,SAAS;AAAA,MAC7B,aAAa,SAAS;AAAA,MACtB;AAAA,MACA,aAAa;AAAA,MACb;AAAA,MACA;AAAA,IACF;AAAA,EACF;AACF;AAOA,MAAM,iBAAwD;AAAA,EAC5D,kKACE,EAAE,cAAc,uCAAqB,kBAAkB,CAAC,OAAO,OAAO,KAAK,EAAE;AAAA,EAC/E,iKACE,EAAE,cAAc,sCAAoB,kBAAkB,CAAC,OAAO,OAAO,KAAK,EAAE;AAAA,EAC9E,+JACE,EAAE,cAAc,sCAAoB,kBAAkB,CAAC,OAAO,OAAO,KAAK,EAAE;AAAA,EAC9E,uLACE,EAAE,cAAc,uDAAoC,kBAAkB,CAAC,OAAO,OAAO,KAAK,EAAE;AAAA,EAC9F,kKACE,EAAE,cAAc,mBAAAC,qBAA+B,kBAAkB,CAAC,OAAO,OAAO,KAAK,EAAE;AAAA,EACzF,iKACE,EAAE,cAAc,mBAAAC,oBAA8B,kBAAkB,CAAC,OAAO,OAAO,KAAK,EAAE;AAAA,EACxF,+JACE,EAAE,cAAc,mBAAAC,oBAA8B,kBAAkB,CAAC,OAAO,OAAO,KAAK,EAAE;AAAA,EACxF,uMACE,EAAE,cAAc,+CAA4B,kBAAkB,CAAC,OAAO,OAAO,OAAO,KAAK,EAAE;AAAA,EAC7F,0LACE;AAAA,IACE,cAAc,mBAAAC;AAAA,IACd,kBAAkB,CAAC,OAAO,OAAO,KAAK;AAAA,EACxC;AAAA,EACF,yLACE;AAAA,IACE,cAAc,mBAAAC;AAAA,IACd,kBAAkB,CAAC,OAAO,OAAO,KAAK;AAAA,EACxC;AAAA,EACF,uLACE;AAAA,IACE,cAAc,mBAAAC;AAAA,IACd,kBAAkB,CAAC,OAAO,OAAO,KAAK;AAAA,EACxC;AAAA,EACF,kOACE,EAAE,cAAc,0CAAuB,kBAAkB,CAAC,OAAO,OAAO,KAAK,EAAE;AAAA,EACjF,uJACE,EAAE,cAAc,kDAA+B,kBAAkB,CAAC,OAAO,OAAO,KAAK,EAAE;AAAA,EACzF,2JACE;AAAA,IACE,cAAc;AAAA,IACd,kBAAkB,CAAC,OAAO,OAAO,KAAK;AAAA,EACxC;AAAA,EACF,yJACE;AAAA,IACE,cAAc;AAAA,IACd,kBAAkB,CAAC,OAAO,OAAO,KAAK;AAAA,EACxC;AAAA,EACF,oJACE;AAAA,IACE,cAAc;AAAA,IACd,kBAAkB,CAAC,OAAO,OAAO,KAAK;AAAA,EACxC;AAAA,EACF,8IACE,EAAE,cAAc,yCAAsB,kBAAkB,CAAC,OAAO,OAAO,KAAK,EAAE;AAAA,EAChF,oIACE,EAAE,cAAc,mBAAAC,oBAAmC,kBAAkB,CAAC,OAAO,OAAO,KAAK,EAAE;AAAA,EAC7F,6LACE,EAAE,cAAc,gDAA6B,kBAAkB,CAAC,OAAO,OAAO,KAAK,EAAE;AACzF;AAEA,SAAS,yBACP,QACA,QACmC;AACnC,QAAM,OAAO,IAAI,IAAI,MAAM,EAAE;AAC7B,QAAM,YAAY,KAAK,MAAM,GAAG;AAKhC,MAAI,aAAa,IACf;AAGF,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,cAAc,GAAG;AAGzD,QAAI,CAAC,IAAI,WAAW,MAAM,GAAG;AAC3B;AAAA,IACF;AACA,UAAM,gBAAgB,kBAAkB,GAAG;AAE3C,UAAM,iBAAiB,cAAc,MAAM,GAAG;AAG9C,QAAI,QAAQ;AACZ,aAAS,IAAI,eAAe,SAAS,GAAG,IAAI,UAAU,SAAS,GAAG,KAAK,KAAK,KAAK,GAAG,KAAK,KAAK;AAC5F,UAAI,eAAe,CAAC,GAAG,WAAW,GAAG,KAAK,eAAe,CAAC,GAAG,QAAQ,GAAG,MAAM,IAAI;AAChF,cAAM,QAAQ,eAAe,CAAC,EAAG,QAAQ,GAAG,IAAI,GAC9C,MAAM,eAAe,CAAC,GAAG;AAK3B,cAAM,YAAY,IAAI,OAAO,GAAG,eAAe,CAAC,GAAG,MAAM,OAAO,GAAG,CAAC,EAAE,EAAE;AAAA,UACtE,UAAU,CAAC,KAAK;AAAA,QAClB;AAEA,YAAI,CAAC,WAAW;AACd,kBAAQ;AACR;AAAA,QACF;AACA;AAAA,MACF;AAKA,UAAI,eAAe,CAAC,MAAM,UAAU,CAAC,GAAG;AACtC,gBAAQ;AACR;AAAA,MACF;AAAA,IACF;AAIA,QAAI,SAAS,cAAc,SAAS,YAAY;AAC9C,mBAAa,cAAc;AAC3B,qBAAe;AAAA,IACjB;AAAA,EACF;AAEA,SAAO;AACT;AAEA,SAAS,kBAAkB,QAAwB;AACjD,QAAM,YAAY,OAAO,QAAQ,GAAG;AACpC,SAAO,OAAO,MAAM,SAAS;AAC/B;AAEA,SAAS,qBAAqB,QAAoC;AAChE,QAAM,MAAM,IAAI,IAAI,MAAM;AAC1B,SAAO,IAAI,aAAa,IAAI,aAAa,KAAK;AAChD;",
+  "names": ["import_operations", "_$deleteDeserializeConnectors", "_updateDeserializeConnectors", "_createDeserializeConnectors", "_$deleteDeserializeStorageTaskAssignments", "_updateDeserializeStorageTaskAssignments", "_createDeserializeStorageTaskAssignments", "_createDeserializeStorageAccounts"]
+}

package/dist/commonjs/static-helpers/cloudSettingHelpers.d.ts

@@ -0,0 +1,22 @@
+/**
+ * An enum to describe Azure Cloud environments.
+ * @enum {string}
+ */
+export declare enum AzureClouds {
+    /** Azure public cloud, which is the default cloud for Azure SDKs. */
+    AZURE_PUBLIC_CLOUD = "AZURE_PUBLIC_CLOUD",
+    /** Azure China cloud */
+    AZURE_CHINA_CLOUD = "AZURE_CHINA_CLOUD",
+    /** Azure US government cloud */
+    AZURE_US_GOVERNMENT = "AZURE_US_GOVERNMENT"
+}
+/** The supported values for cloud setting as a string literal type */
+export type AzureSupportedClouds = `${AzureClouds}`;
+/**
+ * Gets the Azure Resource Manager endpoint URL for the specified cloud setting.
+ * @param cloudSetting - The Azure cloud environment setting. Use one of the AzureClouds enum values.
+ * @returns The ARM endpoint URL for the specified cloud, or undefined if cloudSetting is undefined.
+ * @throws {Error} Throws an error if an unknown cloud setting is provided.
+ */
+export declare function getArmEndpoint(cloudSetting?: AzureSupportedClouds): string | undefined;
+//# sourceMappingURL=cloudSettingHelpers.d.ts.map

package/dist/commonjs/static-helpers/cloudSettingHelpers.js

@@ -0,0 +1,52 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var cloudSettingHelpers_exports = {};
+__export(cloudSettingHelpers_exports, {
+  AzureClouds: () => AzureClouds,
+  getArmEndpoint: () => getArmEndpoint
+});
+module.exports = __toCommonJS(cloudSettingHelpers_exports);
+var AzureClouds = /* @__PURE__ */ ((AzureClouds2) => {
+  AzureClouds2["AZURE_PUBLIC_CLOUD"] = "AZURE_PUBLIC_CLOUD";
+  AzureClouds2["AZURE_CHINA_CLOUD"] = "AZURE_CHINA_CLOUD";
+  AzureClouds2["AZURE_US_GOVERNMENT"] = "AZURE_US_GOVERNMENT";
+  return AzureClouds2;
+})(AzureClouds || {});
+function getArmEndpoint(cloudSetting) {
+  if (cloudSetting === void 0) {
+    return void 0;
+  }
+  const cloudEndpoints = {
+    AZURE_CHINA_CLOUD: "https://management.chinacloudapi.cn/",
+    AZURE_US_GOVERNMENT: "https://management.usgovcloudapi.net/",
+    AZURE_PUBLIC_CLOUD: "https://management.azure.com/"
+  };
+  if (cloudSetting in cloudEndpoints) {
+    return cloudEndpoints[cloudSetting];
+  } else {
+    throw new Error(
+      `Unknown cloud setting: ${cloudSetting}. Please refer to the enum AzureClouds for possible values.`
+    );
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AzureClouds,
+  getArmEndpoint
+});
+//# sourceMappingURL=cloudSettingHelpers.js.map

package/dist/commonjs/static-helpers/cloudSettingHelpers.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/static-helpers/cloudSettingHelpers.ts"],
+  "sourcesContent": ["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * An enum to describe Azure Cloud environments.\n * @enum {string}\n */\nexport enum AzureClouds {\n  /** Azure public cloud, which is the default cloud for Azure SDKs. */\n  AZURE_PUBLIC_CLOUD = \"AZURE_PUBLIC_CLOUD\",\n  /** Azure China cloud */\n  AZURE_CHINA_CLOUD = \"AZURE_CHINA_CLOUD\",\n  /** Azure US government cloud */\n  AZURE_US_GOVERNMENT = \"AZURE_US_GOVERNMENT\",\n}\n\n/** The supported values for cloud setting as a string literal type */\nexport type AzureSupportedClouds = `${AzureClouds}`;\n\n/**\n * Gets the Azure Resource Manager endpoint URL for the specified cloud setting.\n * @param cloudSetting - The Azure cloud environment setting. Use one of the AzureClouds enum values.\n * @returns The ARM endpoint URL for the specified cloud, or undefined if cloudSetting is undefined.\n * @throws {Error} Throws an error if an unknown cloud setting is provided.\n */\nexport function getArmEndpoint(cloudSetting?: AzureSupportedClouds): string | undefined {\n  if (cloudSetting === undefined) {\n    return undefined;\n  }\n  const cloudEndpoints: Record<keyof typeof AzureClouds, string> = {\n    AZURE_CHINA_CLOUD: \"https://management.chinacloudapi.cn/\",\n    AZURE_US_GOVERNMENT: \"https://management.usgovcloudapi.net/\",\n    AZURE_PUBLIC_CLOUD: \"https://management.azure.com/\",\n  };\n  if (cloudSetting in cloudEndpoints) {\n    return cloudEndpoints[cloudSetting];\n  } else {\n    throw new Error(\n      `Unknown cloud setting: ${cloudSetting}. Please refer to the enum AzureClouds for possible values.`,\n    );\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAOO,IAAK,cAAL,kBAAKA,iBAAL;AAEL,EAAAA,aAAA,wBAAqB;AAErB,EAAAA,aAAA,uBAAoB;AAEpB,EAAAA,aAAA,yBAAsB;AANZ,SAAAA;AAAA,GAAA;AAkBL,SAAS,eAAe,cAAyD;AACtF,MAAI,iBAAiB,QAAW;AAC9B,WAAO;AAAA,EACT;AACA,QAAM,iBAA2D;AAAA,IAC/D,mBAAmB;AAAA,IACnB,qBAAqB;AAAA,IACrB,oBAAoB;AAAA,EACtB;AACA,MAAI,gBAAgB,gBAAgB;AAClC,WAAO,eAAe,YAAY;AAAA,EACpC,OAAO;AACL,UAAM,IAAI;AAAA,MACR,0BAA0B,YAAY;AAAA,IACxC;AAAA,EACF;AACF;",
+  "names": ["AzureClouds"]
+}

package/dist/commonjs/static-helpers/pagingHelpers.d.ts

@@ -0,0 +1,74 @@
+import type { Client, PathUncheckedResponse } from "@azure-rest/core-client";
+/**
+ * Options for the byPage method
+ */
+export interface PageSettings {
+    /**
+     * A reference to a specific page to start iterating from.
+     */
+    continuationToken?: string;
+}
+/**
+ * An interface that describes a page of results.
+ */
+export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    /**
+     * The token that keeps track of where to continue the iterator
+     */
+    continuationToken?: string;
+};
+/**
+ * An interface that allows async iterable iteration both to completion and by page.
+ */
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
+    /**
+     * The next method, part of the iteration protocol
+     */
+    next(): Promise<IteratorResult<TElement>>;
+    /**
+     * The connection to the async iterator, part of the iteration protocol
+     */
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    /**
+     * Return an AsyncIterableIterator that works a page at a time
+     */
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
+}
+/**
+ * An interface that describes how to communicate with the service.
+ */
+export interface PagedResult<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
+    /**
+     * Link to the first page of results.
+     */
+    firstPageLink?: string;
+    /**
+     * A method that returns a page of results.
+     */
+    getPage: (pageLink?: string) => Promise<{
+        page: TPage;
+        nextPageLink?: string;
+    } | undefined>;
+    /**
+     * a function to implement the `byPage` method on the paged async iterator.
+     */
+    byPage?: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
+    /**
+     * A function to extract elements from a page.
+     */
+    toElements?: (page: TPage) => TElement[];
+}
+/**
+ * Options for the paging helper
+ */
+export interface BuildPagedAsyncIteratorOptions {
+    itemName?: string;
+    nextLinkName?: string;
+    nextLinkMethod?: "GET" | "POST";
+    apiVersion?: string;
+}
+/**
+ * Helper to paginate results in a generic way and return a PagedAsyncIterableIterator
+ */
+export declare function buildPagedAsyncIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings, TResponse extends PathUncheckedResponse = PathUncheckedResponse>(client: Client, getInitialResponse: () => PromiseLike<TResponse>, processResponseBody: (result: TResponse) => PromiseLike<unknown>, expectedStatuses: string[], options?: BuildPagedAsyncIteratorOptions): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+//# sourceMappingURL=pagingHelpers.d.ts.map

package/dist/commonjs/static-helpers/pagingHelpers.js

@@ -0,0 +1,143 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var pagingHelpers_exports = {};
+__export(pagingHelpers_exports, {
+  buildPagedAsyncIterator: () => buildPagedAsyncIterator
+});
+module.exports = __toCommonJS(pagingHelpers_exports);
+var import_core_client = require("@azure-rest/core-client");
+var import_core_rest_pipeline = require("@azure/core-rest-pipeline");
+function buildPagedAsyncIterator(client, getInitialResponse, processResponseBody, expectedStatuses, options = {}) {
+  const itemName = options.itemName ?? "value";
+  const nextLinkName = options.nextLinkName ?? "nextLink";
+  const nextLinkMethod = options.nextLinkMethod ?? "GET";
+  const apiVersion = options.apiVersion;
+  const pagedResult = {
+    getPage: async (pageLink) => {
+      let result;
+      if (pageLink === void 0) {
+        result = await getInitialResponse();
+      } else {
+        const resolvedPageLink = apiVersion ? addApiVersionToUrl(pageLink, apiVersion) : pageLink;
+        result = nextLinkMethod === "POST" ? await client.pathUnchecked(resolvedPageLink).post() : await client.pathUnchecked(resolvedPageLink).get();
+      }
+      checkPagingRequest(result, expectedStatuses);
+      const results = await processResponseBody(result);
+      const nextLink = getNextLink(results, nextLinkName);
+      const values = getElements(results, itemName);
+      return {
+        page: values,
+        nextPageLink: nextLink
+      };
+    },
+    byPage: (settings) => {
+      const { continuationToken } = settings ?? {};
+      return getPageAsyncIterator(pagedResult, {
+        pageLink: continuationToken
+      });
+    }
+  };
+  return getPagedAsyncIterator(pagedResult);
+}
+function getPagedAsyncIterator(pagedResult) {
+  const iter = getItemAsyncIterator(pagedResult);
+  return {
+    next() {
+      return iter.next();
+    },
+    [Symbol.asyncIterator]() {
+      return this;
+    },
+    byPage: pagedResult?.byPage ?? ((settings) => {
+      const { continuationToken } = settings ?? {};
+      return getPageAsyncIterator(pagedResult, {
+        pageLink: continuationToken
+      });
+    })
+  };
+}
+async function* getItemAsyncIterator(pagedResult) {
+  const pages = getPageAsyncIterator(pagedResult);
+  for await (const page of pages) {
+    yield* page;
+  }
+}
+async function* getPageAsyncIterator(pagedResult, options = {}) {
+  const { pageLink } = options;
+  let response = await pagedResult.getPage(pageLink ?? pagedResult.firstPageLink);
+  if (!response) {
+    return;
+  }
+  let result = response.page;
+  result.continuationToken = response.nextPageLink;
+  yield result;
+  while (response.nextPageLink) {
+    response = await pagedResult.getPage(response.nextPageLink);
+    if (!response) {
+      return;
+    }
+    result = response.page;
+    result.continuationToken = response.nextPageLink;
+    yield result;
+  }
+}
+function getNextLink(body, nextLinkName) {
+  if (!nextLinkName) {
+    return void 0;
+  }
+  const nextLink = body[nextLinkName];
+  if (typeof nextLink !== "string" && typeof nextLink !== "undefined" && nextLink !== null) {
+    throw new import_core_rest_pipeline.RestError(
+      `Body Property ${nextLinkName} should be a string or undefined or null but got ${typeof nextLink}`
+    );
+  }
+  if (nextLink === null) {
+    return void 0;
+  }
+  return nextLink;
+}
+function getElements(body, itemName) {
+  const value = body[itemName];
+  if (!Array.isArray(value)) {
+    throw new import_core_rest_pipeline.RestError(
+      `Couldn't paginate response
+ Body doesn't contain an array property with name: ${itemName}`
+    );
+  }
+  return value ?? [];
+}
+function checkPagingRequest(response, expectedStatuses) {
+  if (!expectedStatuses.includes(response.status)) {
+    throw (0, import_core_client.createRestError)(
+      `Pagination failed with unexpected statusCode ${response.status}`,
+      response
+    );
+  }
+}
+function addApiVersionToUrl(url, apiVersion) {
+  const urlObj = new URL(url, "https://microsoft.com");
+  if (!urlObj.searchParams.get("api-version")) {
+    return `${url}${urlObj.search ? "&" : "?"}api-version=${apiVersion}`;
+  }
+  return url;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buildPagedAsyncIterator
+});
+//# sourceMappingURL=pagingHelpers.js.map

package/dist/commonjs/static-helpers/pagingHelpers.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/static-helpers/pagingHelpers.ts"],
+  "sourcesContent": ["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { Client, PathUncheckedResponse } from \"@azure-rest/core-client\";\nimport { createRestError } from \"@azure-rest/core-client\";\nimport { RestError } from \"@azure/core-rest-pipeline\";\n\n/**\n * Options for the byPage method\n */\nexport interface PageSettings {\n  /**\n   * A reference to a specific page to start iterating from.\n   */\n  continuationToken?: string;\n}\n\n/**\n * An interface that describes a page of results.\n */\nexport type ContinuablePage<TElement, TPage = TElement[]> = TPage & {\n  /**\n   * The token that keeps track of where to continue the iterator\n   */\n  continuationToken?: string;\n};\n\n/**\n * An interface that allows async iterable iteration both to completion and by page.\n */\nexport interface PagedAsyncIterableIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings extends PageSettings = PageSettings,\n> {\n  /**\n   * The next method, part of the iteration protocol\n   */\n  next(): Promise<IteratorResult<TElement>>;\n  /**\n   * The connection to the async iterator, part of the iteration protocol\n   */\n  [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;\n  /**\n   * Return an AsyncIterableIterator that works a page at a time\n   */\n  byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;\n}\n\n/**\n * An interface that describes how to communicate with the service.\n */\nexport interface PagedResult<\n  TElement,\n  TPage = TElement[],\n  TPageSettings extends PageSettings = PageSettings,\n> {\n  /**\n   * Link to the first page of results.\n   */\n  firstPageLink?: string;\n  /**\n   * A method that returns a page of results.\n   */\n  getPage: (pageLink?: string) => Promise<{ page: TPage; nextPageLink?: string } | undefined>;\n  /**\n   * a function to implement the `byPage` method on the paged async iterator.\n   */\n  byPage?: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;\n\n  /**\n   * A function to extract elements from a page.\n   */\n  toElements?: (page: TPage) => TElement[];\n}\n\n/**\n * Options for the paging helper\n */\nexport interface BuildPagedAsyncIteratorOptions {\n  itemName?: string;\n  nextLinkName?: string;\n  nextLinkMethod?: \"GET\" | \"POST\";\n  apiVersion?: string;\n}\n\n/**\n * Helper to paginate results in a generic way and return a PagedAsyncIterableIterator\n */\nexport function buildPagedAsyncIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings extends PageSettings = PageSettings,\n  TResponse extends PathUncheckedResponse = PathUncheckedResponse,\n>(\n  client: Client,\n  getInitialResponse: () => PromiseLike<TResponse>,\n  processResponseBody: (result: TResponse) => PromiseLike<unknown>,\n  expectedStatuses: string[],\n  options: BuildPagedAsyncIteratorOptions = {},\n): PagedAsyncIterableIterator<TElement, TPage, TPageSettings> {\n  const itemName = options.itemName ?? \"value\";\n  const nextLinkName = options.nextLinkName ?? \"nextLink\";\n  const nextLinkMethod = options.nextLinkMethod ?? \"GET\";\n  const apiVersion = options.apiVersion;\n  const pagedResult: PagedResult<TElement, TPage, TPageSettings> = {\n    getPage: async (pageLink?: string) => {\n      let result;\n      if (pageLink === undefined) {\n        result = await getInitialResponse();\n      } else {\n        const resolvedPageLink = apiVersion ? addApiVersionToUrl(pageLink, apiVersion) : pageLink;\n        result =\n          nextLinkMethod === \"POST\"\n            ? await client.pathUnchecked(resolvedPageLink).post()\n            : await client.pathUnchecked(resolvedPageLink).get();\n      }\n      checkPagingRequest(result, expectedStatuses);\n      const results = await processResponseBody(result as TResponse);\n      const nextLink = getNextLink(results, nextLinkName);\n      const values = getElements<TElement>(results, itemName) as TPage;\n      return {\n        page: values,\n        nextPageLink: nextLink,\n      };\n    },\n    byPage: (settings?: TPageSettings) => {\n      const { continuationToken } = settings ?? {};\n      return getPageAsyncIterator(pagedResult, {\n        pageLink: continuationToken,\n      });\n    },\n  };\n  return getPagedAsyncIterator(pagedResult);\n}\n\n/**\n * returns an async iterator that iterates over results. It also has a `byPage`\n * method that returns pages of items at once.\n *\n * @param pagedResult - an object that specifies how to get pages.\n * @returns a paged async iterator that iterates over results.\n */\n\nfunction getPagedAsyncIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings extends PageSettings = PageSettings,\n>(\n  pagedResult: PagedResult<TElement, TPage, TPageSettings>,\n): PagedAsyncIterableIterator<TElement, TPage, TPageSettings> {\n  const iter = getItemAsyncIterator<TElement, TPage, TPageSettings>(pagedResult);\n  return {\n    next() {\n      return iter.next();\n    },\n    [Symbol.asyncIterator]() {\n      return this;\n    },\n    byPage:\n      pagedResult?.byPage ??\n      ((settings?: TPageSettings) => {\n        const { continuationToken } = settings ?? {};\n        return getPageAsyncIterator(pagedResult, {\n          pageLink: continuationToken,\n        });\n      }),\n  };\n}\n\nasync function* getItemAsyncIterator<TElement, TPage, TPageSettings extends PageSettings>(\n  pagedResult: PagedResult<TElement, TPage, TPageSettings>,\n): AsyncIterableIterator<TElement> {\n  const pages = getPageAsyncIterator(pagedResult);\n  for await (const page of pages) {\n    yield* page as unknown as TElement[];\n  }\n}\n\nasync function* getPageAsyncIterator<TElement, TPage, TPageSettings extends PageSettings>(\n  pagedResult: PagedResult<TElement, TPage, TPageSettings>,\n  options: {\n    pageLink?: string;\n  } = {},\n): AsyncIterableIterator<ContinuablePage<TElement, TPage>> {\n  const { pageLink } = options;\n  let response = await pagedResult.getPage(pageLink ?? pagedResult.firstPageLink);\n  if (!response) {\n    return;\n  }\n  let result = response.page as ContinuablePage<TElement, TPage>;\n  result.continuationToken = response.nextPageLink;\n  yield result;\n  while (response.nextPageLink) {\n    response = await pagedResult.getPage(response.nextPageLink);\n    if (!response) {\n      return;\n    }\n    result = response.page as ContinuablePage<TElement, TPage>;\n    result.continuationToken = response.nextPageLink;\n    yield result;\n  }\n}\n\n/**\n * Gets for the value of nextLink in the body\n */\nfunction getNextLink(body: unknown, nextLinkName?: string): string | undefined {\n  if (!nextLinkName) {\n    return undefined;\n  }\n\n  const nextLink = (body as Record<string, unknown>)[nextLinkName];\n\n  if (typeof nextLink !== \"string\" && typeof nextLink !== \"undefined\" && nextLink !== null) {\n    throw new RestError(\n      `Body Property ${nextLinkName} should be a string or undefined or null but got ${typeof nextLink}`,\n    );\n  }\n\n  if (nextLink === null) {\n    return undefined;\n  }\n\n  return nextLink;\n}\n\n/**\n * Gets the elements of the current request in the body.\n */\nfunction getElements<T = unknown>(body: unknown, itemName: string): T[] {\n  const value = (body as Record<string, unknown>)[itemName] as T[];\n  if (!Array.isArray(value)) {\n    throw new RestError(\n      `Couldn't paginate response\\n Body doesn't contain an array property with name: ${itemName}`,\n    );\n  }\n\n  return value ?? [];\n}\n\n/**\n * Checks if a request failed\n */\nfunction checkPagingRequest(response: PathUncheckedResponse, expectedStatuses: string[]): void {\n  if (!expectedStatuses.includes(response.status)) {\n    throw createRestError(\n      `Pagination failed with unexpected statusCode ${response.status}`,\n      response,\n    );\n  }\n}\n\n/**\n * Adds the api-version query parameter on a URL if it's not present.\n * @param url - the URL to modify\n * @param apiVersion - the API version to set\n * @returns - the URL with the api-version query parameter set\n */\nfunction addApiVersionToUrl(url: string, apiVersion: string): string {\n  // The base URL is only used for parsing and won't appear in the returned URL\n  const urlObj = new URL(url, \"https://microsoft.com\");\n  if (!urlObj.searchParams.get(\"api-version\")) {\n    // Append one if there is no apiVersion\n    return `${url}${urlObj.search ? \"&\" : \"?\"}api-version=${apiVersion}`;\n  }\n  return url;\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIA,yBAAgC;AAChC,gCAA0B;AAoFnB,SAAS,wBAMd,QACA,oBACA,qBACA,kBACA,UAA0C,CAAC,GACiB;AAC5D,QAAM,WAAW,QAAQ,YAAY;AACrC,QAAM,eAAe,QAAQ,gBAAgB;AAC7C,QAAM,iBAAiB,QAAQ,kBAAkB;AACjD,QAAM,aAAa,QAAQ;AAC3B,QAAM,cAA2D;AAAA,IAC/D,SAAS,OAAO,aAAsB;AACpC,UAAI;AACJ,UAAI,aAAa,QAAW;AAC1B,iBAAS,MAAM,mBAAmB;AAAA,MACpC,OAAO;AACL,cAAM,mBAAmB,aAAa,mBAAmB,UAAU,UAAU,IAAI;AACjF,iBACE,mBAAmB,SACf,MAAM,OAAO,cAAc,gBAAgB,EAAE,KAAK,IAClD,MAAM,OAAO,cAAc,gBAAgB,EAAE,IAAI;AAAA,MACzD;AACA,yBAAmB,QAAQ,gBAAgB;AAC3C,YAAM,UAAU,MAAM,oBAAoB,MAAmB;AAC7D,YAAM,WAAW,YAAY,SAAS,YAAY;AAClD,YAAM,SAAS,YAAsB,SAAS,QAAQ;AACtD,aAAO;AAAA,QACL,MAAM;AAAA,QACN,cAAc;AAAA,MAChB;AAAA,IACF;AAAA,IACA,QAAQ,CAAC,aAA6B;AACpC,YAAM,EAAE,kBAAkB,IAAI,YAAY,CAAC;AAC3C,aAAO,qBAAqB,aAAa;AAAA,QACvC,UAAU;AAAA,MACZ,CAAC;AAAA,IACH;AAAA,EACF;AACA,SAAO,sBAAsB,WAAW;AAC1C;AAUA,SAAS,sBAKP,aAC4D;AAC5D,QAAM,OAAO,qBAAqD,WAAW;AAC7E,SAAO;AAAA,IACL,OAAO;AACL,aAAO,KAAK,KAAK;AAAA,IACnB;AAAA,IACA,CAAC,OAAO,aAAa,IAAI;AACvB,aAAO;AAAA,IACT;AAAA,IACA,QACE,aAAa,WACZ,CAAC,aAA6B;AAC7B,YAAM,EAAE,kBAAkB,IAAI,YAAY,CAAC;AAC3C,aAAO,qBAAqB,aAAa;AAAA,QACvC,UAAU;AAAA,MACZ,CAAC;AAAA,IACH;AAAA,EACJ;AACF;AAEA,gBAAgB,qBACd,aACiC;AACjC,QAAM,QAAQ,qBAAqB,WAAW;AAC9C,mBAAiB,QAAQ,OAAO;AAC9B,WAAO;AAAA,EACT;AACF;AAEA,gBAAgB,qBACd,aACA,UAEI,CAAC,GACoD;AACzD,QAAM,EAAE,SAAS,IAAI;AACrB,MAAI,WAAW,MAAM,YAAY,QAAQ,YAAY,YAAY,aAAa;AAC9E,MAAI,CAAC,UAAU;AACb;AAAA,EACF;AACA,MAAI,SAAS,SAAS;AACtB,SAAO,oBAAoB,SAAS;AACpC,QAAM;AACN,SAAO,SAAS,cAAc;AAC5B,eAAW,MAAM,YAAY,QAAQ,SAAS,YAAY;AAC1D,QAAI,CAAC,UAAU;AACb;AAAA,IACF;AACA,aAAS,SAAS;AAClB,WAAO,oBAAoB,SAAS;AACpC,UAAM;AAAA,EACR;AACF;AAKA,SAAS,YAAY,MAAe,cAA2C;AAC7E,MAAI,CAAC,cAAc;AACjB,WAAO;AAAA,EACT;AAEA,QAAM,WAAY,KAAiC,YAAY;AAE/D,MAAI,OAAO,aAAa,YAAY,OAAO,aAAa,eAAe,aAAa,MAAM;AACxF,UAAM,IAAI;AAAA,MACR,iBAAiB,YAAY,oDAAoD,OAAO,QAAQ;AAAA,IAClG;AAAA,EACF;AAEA,MAAI,aAAa,MAAM;AACrB,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAKA,SAAS,YAAyB,MAAe,UAAuB;AACtE,QAAM,QAAS,KAAiC,QAAQ;AACxD,MAAI,CAAC,MAAM,QAAQ,KAAK,GAAG;AACzB,UAAM,IAAI;AAAA,MACR;AAAA,qDAAkF,QAAQ;AAAA,IAC5F;AAAA,EACF;AAEA,SAAO,SAAS,CAAC;AACnB;AAKA,SAAS,mBAAmB,UAAiC,kBAAkC;AAC7F,MAAI,CAAC,iBAAiB,SAAS,SAAS,MAAM,GAAG;AAC/C,cAAM;AAAA,MACJ,gDAAgD,SAAS,MAAM;AAAA,MAC/D;AAAA,IACF;AAAA,EACF;AACF;AAQA,SAAS,mBAAmB,KAAa,YAA4B;AAEnE,QAAM,SAAS,IAAI,IAAI,KAAK,uBAAuB;AACnD,MAAI,CAAC,OAAO,aAAa,IAAI,aAAa,GAAG;AAE3C,WAAO,GAAG,GAAG,GAAG,OAAO,SAAS,MAAM,GAAG,eAAe,UAAU;AAAA,EACpE;AACA,SAAO;AACT;",
+  "names": []
+}

package/dist/commonjs/static-helpers/pollingHelpers.d.ts

@@ -0,0 +1,34 @@
+import type { PollerLike, OperationState, ResourceLocationConfig } from "@azure/core-lro";
+import type { Client, PathUncheckedResponse } from "@azure-rest/core-client";
+import type { AbortSignalLike } from "@azure/abort-controller";
+export interface GetLongRunningPollerOptions<TResponse> {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /**
+     * The signal which can be used to abort requests.
+     */
+    abortSignal?: AbortSignalLike;
+    /**
+     * The potential location of the result of the LRO if specified by the LRO extension in the swagger.
+     */
+    resourceLocationConfig?: ResourceLocationConfig;
+    /**
+     * The original url of the LRO
+     * Should not be null when restoreFrom is set
+     */
+    initialRequestUrl?: string;
+    /**
+     * A serialized poller which can be used to resume an existing paused Long-Running-Operation.
+     */
+    restoreFrom?: string;
+    /**
+     * The function to get the initial response
+     */
+    getInitialResponse?: () => PromiseLike<TResponse>;
+    /**
+     * The api-version of the LRO
+     */
+    apiVersion?: string;
+}
+export declare function getLongRunningPoller<TResponse extends PathUncheckedResponse, TResult = void>(client: Client, processResponseBody: (result: TResponse) => Promise<TResult>, expectedStatuses: string[], options: GetLongRunningPollerOptions<TResponse>): PollerLike<OperationState<TResult>, TResult>;
+//# sourceMappingURL=pollingHelpers.d.ts.map