@azure/arm-netapp 23.1.0-beta.1 → 24.1.0

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

@@ -1,7 +1 @@
-{
-  "version": 3,
-  "sources": ["/mnt/vss/_work/1/s/sdk/netapp/arm-netapp/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}${\n      Array.from(urlObj.searchParams.keys()).length > 0 ? \"&\" : \"?\"\n    }api-version=${apiVersion}`;\n  }\n  return url;\n}\n"],
-  "mappings": "AAIA,SAAS,uBAAuB;AAChC,SAAS,iBAAiB;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,UAAM;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,GACX,MAAM,KAAK,OAAO,aAAa,KAAK,CAAC,EAAE,SAAS,IAAI,MAAM,GAC5D,eAAe,UAAU;AAAA,EAC3B;AACA,SAAO;AACT;",
-  "names": []
-}
+{"version":3,"file":"pagingHelpers.js","sourceRoot":"","sources":["../../../src/static-helpers/pagingHelpers.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAiFtD;;GAEG;AACH,MAAM,UAAU,uBAAuB,CAMrC,MAAc,EACd,kBAAgD,EAChD,mBAAgE,EAChE,gBAA0B,EAC1B,UAA0C,EAAE;IAE5C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC;IAC7C,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,UAAU,CAAC;IACxD,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,KAAK,CAAC;IACvD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACtC,MAAM,WAAW,GAAgD;QAC/D,OAAO,EAAE,KAAK,EAAE,QAAiB,EAAE,EAAE;YACnC,IAAI,MAAM,CAAC;YACX,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,MAAM,gBAAgB,GAAG,UAAU,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAC1F,MAAM;oBACJ,cAAc,KAAK,MAAM;wBACvB,CAAC,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,IAAI,EAAE;wBACrD,CAAC,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,GAAG,EAAE,CAAC;YAC3D,CAAC;YACD,kBAAkB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;YAC7C,MAAM,OAAO,GAAG,MAAM,mBAAmB,CAAC,MAAmB,CAAC,CAAC;YAC/D,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;YACpD,MAAM,MAAM,GAAG,WAAW,CAAW,OAAO,EAAE,QAAQ,CAAU,CAAC;YACjE,OAAO;gBACL,IAAI,EAAE,MAAM;gBACZ,YAAY,EAAE,QAAQ;aACvB,CAAC;QACJ,CAAC;QACD,MAAM,EAAE,CAAC,QAAwB,EAAE,EAAE;YACnC,MAAM,EAAE,iBAAiB,EAAE,GAAG,QAAQ,IAAI,EAAE,CAAC;YAC7C,OAAO,oBAAoB,CAAC,WAAW,EAAE;gBACvC,QAAQ,EAAE,iBAAiB;aAC5B,CAAC,CAAC;QACL,CAAC;KACF,CAAC;IACF,OAAO,qBAAqB,CAAC,WAAW,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;GAMG;AAEH,SAAS,qBAAqB,CAK5B,WAAwD;IAExD,MAAM,IAAI,GAAG,oBAAoB,CAAiC,WAAW,CAAC,CAAC;IAC/E,OAAO;QACL,IAAI;YACF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACrB,CAAC;QACD,CAAC,MAAM,CAAC,aAAa,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,EACJ,WAAW,EAAE,MAAM;YACnB,CAAC,CAAC,QAAwB,EAAE,EAAE;gBAC5B,MAAM,EAAE,iBAAiB,EAAE,GAAG,QAAQ,IAAI,EAAE,CAAC;gBAC7C,OAAO,oBAAoB,CAAC,WAAW,EAAE;oBACvC,QAAQ,EAAE,iBAAiB;iBAC5B,CAAC,CAAC;YACL,CAAC,CAAC;KACL,CAAC;AACJ,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,oBAAoB,CAClC,WAAwD;IAExD,MAAM,KAAK,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAChD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC/B,KAAK,CAAC,CAAC,IAA6B,CAAC;IACvC,CAAC;AACH,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,oBAAoB,CAClC,WAAwD,EACxD,UAEI,EAAE;IAEN,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC7B,IAAI,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,QAAQ,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC;IAChF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO;IACT,CAAC;IACD,IAAI,MAAM,GAAG,QAAQ,CAAC,IAAwC,CAAC;IAC/D,MAAM,CAAC,iBAAiB,GAAG,QAAQ,CAAC,YAAY,CAAC;IACjD,MAAM,MAAM,CAAC;IACb,OAAO,QAAQ,CAAC,YAAY,EAAE,CAAC;QAC7B,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC5D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO;QACT,CAAC;QACD,MAAM,GAAG,QAAQ,CAAC,IAAwC,CAAC;QAC3D,MAAM,CAAC,iBAAiB,GAAG,QAAQ,CAAC,YAAY,CAAC;QACjD,MAAM,MAAM,CAAC;IACf,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAC,IAAa,EAAE,YAAqB;IACvD,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAI,IAAgC,CAAC,YAAY,CAAC,CAAC;IAEjE,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACzF,MAAM,IAAI,SAAS,CACjB,iBAAiB,YAAY,oDAAoD,OAAO,QAAQ,EAAE,CACnG,CAAC;IACJ,CAAC;IAED,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAc,IAAa,EAAE,QAAgB;IAC/D,MAAM,KAAK,GAAI,IAAgC,CAAC,QAAQ,CAAQ,CAAC;IACjE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,SAAS,CACjB,kFAAkF,QAAQ,EAAE,CAC7F,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,IAAI,EAAE,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,QAA+B,EAAE,gBAA0B;IACrF,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,MAAM,eAAe,CACnB,gDAAgD,QAAQ,CAAC,MAAM,EAAE,EACjE,QAAQ,CACT,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,GAAW,EAAE,UAAkB;IACzD,6EAA6E;IAC7E,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;QAC5C,uCAAuC;QACvC,OAAO,GAAG,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,eAAe,UAAU,EAAE,CAAC;IACvE,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC","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"]}

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

@@ -1,4 +1,4 @@
-import type { PollerLike, OperationState, ResourceLocationConfig } from "@azure/core-lro";
+import type { OperationState, PollerLike, 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> {

package/dist/esm/static-helpers/pollingHelpers.js

@@ -1,77 +1,95 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
 import { createHttpPoller } from "@azure/core-lro";
 import { createRestError } from "@azure-rest/core-client";
-function getLongRunningPoller(client, processResponseBody, expectedStatuses, options) {
-  const { restoreFrom, getInitialResponse, apiVersion } = options;
-  if (!restoreFrom && !getInitialResponse) {
-    throw new Error("Either restoreFrom or getInitialResponse must be specified");
-  }
-  let initialResponse = void 0;
-  const pollAbortController = new AbortController();
-  const poller = {
-    sendInitialRequest: async () => {
-      if (!getInitialResponse) {
-        throw new Error("getInitialResponse is required when initializing a new poller");
-      }
-      initialResponse = await getInitialResponse();
-      return getLroResponse(initialResponse, expectedStatuses);
-    },
-    sendPollRequest: async (path, pollOptions) => {
-      function abortListener() {
-        pollAbortController.abort();
-      }
-      const abortSignal = pollAbortController.signal;
-      if (options.abortSignal?.aborted) {
-        pollAbortController.abort();
-      } else if (pollOptions?.abortSignal?.aborted) {
-        pollAbortController.abort();
-      } else if (!abortSignal.aborted) {
-        options.abortSignal?.addEventListener("abort", abortListener, {
-          once: true
-        });
-        pollOptions?.abortSignal?.addEventListener("abort", abortListener, {
-          once: true
-        });
-      }
-      let response;
-      try {
-        const pollingPath = apiVersion ? addApiVersionToUrl(path, apiVersion) : path;
-        response = await client.pathUnchecked(pollingPath).get({ abortSignal });
-      } finally {
-        options.abortSignal?.removeEventListener("abort", abortListener);
-        pollOptions?.abortSignal?.removeEventListener("abort", abortListener);
-      }
-      return getLroResponse(response, expectedStatuses);
+export function getLongRunningPoller(client, processResponseBody, expectedStatuses, options) {
+    const { restoreFrom, getInitialResponse, apiVersion } = options;
+    if (!restoreFrom && !getInitialResponse) {
+        throw new Error("Either restoreFrom or getInitialResponse must be specified");
     }
-  };
-  return createHttpPoller(poller, {
-    intervalInMs: options?.updateIntervalInMs,
-    resourceLocationConfig: options?.resourceLocationConfig,
-    restoreFrom: options?.restoreFrom,
-    processResult: (result) => {
-      return processResponseBody(result);
-    }
-  });
+    let initialResponse = undefined;
+    const pollAbortController = new AbortController();
+    const poller = {
+        sendInitialRequest: async () => {
+            if (!getInitialResponse) {
+                throw new Error("getInitialResponse is required when initializing a new poller");
+            }
+            initialResponse = await getInitialResponse();
+            return getLroResponse(initialResponse, expectedStatuses);
+        },
+        sendPollRequest: async (path, pollOptions) => {
+            // The poll request would both listen to the user provided abort signal and the poller's own abort signal
+            function abortListener() {
+                pollAbortController.abort();
+            }
+            const abortSignal = pollAbortController.signal;
+            if (options.abortSignal?.aborted) {
+                pollAbortController.abort();
+            }
+            else if (pollOptions?.abortSignal?.aborted) {
+                pollAbortController.abort();
+            }
+            else if (!abortSignal.aborted) {
+                options.abortSignal?.addEventListener("abort", abortListener, {
+                    once: true,
+                });
+                pollOptions?.abortSignal?.addEventListener("abort", abortListener, {
+                    once: true,
+                });
+            }
+            let response;
+            try {
+                const pollingPath = apiVersion ? addApiVersionToUrl(path, apiVersion) : path;
+                response = await client.pathUnchecked(pollingPath).get({ abortSignal });
+            }
+            finally {
+                options.abortSignal?.removeEventListener("abort", abortListener);
+                pollOptions?.abortSignal?.removeEventListener("abort", abortListener);
+            }
+            return getLroResponse(response, expectedStatuses);
+        },
+    };
+    return createHttpPoller(poller, {
+        intervalInMs: options?.updateIntervalInMs,
+        resourceLocationConfig: options?.resourceLocationConfig,
+        restoreFrom: options?.restoreFrom,
+        processResult: (result) => {
+            return processResponseBody(result);
+        },
+    });
 }
+/**
+ * Converts a Rest Client response to a response that the LRO implementation understands
+ * @param response - a rest client http response
+ * @param deserializeFn - deserialize function to convert Rest response to modular output
+ * @returns - An LRO response that the LRO implementation understands
+ */
 function getLroResponse(response, expectedStatuses) {
-  if (!expectedStatuses.includes(response.status)) {
-    throw createRestError(response);
-  }
-  return {
-    flatResponse: response,
-    rawResponse: {
-      ...response,
-      statusCode: Number.parseInt(response.status),
-      body: response.body
+    if (!expectedStatuses.includes(response.status)) {
+        throw createRestError(response);
     }
-  };
+    return {
+        flatResponse: response,
+        rawResponse: {
+            ...response,
+            statusCode: Number.parseInt(response.status),
+            body: response.body,
+        },
+    };
 }
+/**
+ * Adds the api-version query parameter on a URL if it's not present.
+ * @param url - the URL to modify
+ * @param apiVersion - the API version to set
+ * @returns - the URL with the api-version query parameter set
+ */
 function addApiVersionToUrl(url, apiVersion) {
-  const urlObj = new URL(url, "https://microsoft.com");
-  if (!urlObj.searchParams.get("api-version")) {
-    return `${url}${Array.from(urlObj.searchParams.keys()).length > 0 ? "&" : "?"}api-version=${apiVersion}`;
-  }
-  return url;
+    // The base URL is only used for parsing and won't appear in the returned URL
+    const urlObj = new URL(url, "https://microsoft.com");
+    if (!urlObj.searchParams.get("api-version")) {
+        // Append one if there is no apiVersion
+        return `${url}${urlObj.search ? "&" : "?"}api-version=${apiVersion}`;
+    }
+    return url;
 }
-export {
-  getLongRunningPoller
-};
+//# sourceMappingURL=pollingHelpers.js.map

package/dist/esm/static-helpers/pollingHelpers.js.map

@@ -1,7 +1 @@
-{
-  "version": 3,
-  "sources": ["/mnt/vss/_work/1/s/sdk/netapp/arm-netapp/src/static-helpers/pollingHelpers.ts"],
-  "sourcesContent": ["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type {\n  PollerLike,\n  OperationState,\n  ResourceLocationConfig,\n  RunningOperation,\n  OperationResponse,\n} from \"@azure/core-lro\";\nimport { createHttpPoller } from \"@azure/core-lro\";\n\nimport type { Client, PathUncheckedResponse } from \"@azure-rest/core-client\";\nimport { createRestError } from \"@azure-rest/core-client\";\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\n\nexport interface GetLongRunningPollerOptions<TResponse> {\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  /**\n   * The potential location of the result of the LRO if specified by the LRO extension in the swagger.\n   */\n  resourceLocationConfig?: ResourceLocationConfig;\n  /**\n   * The original url of the LRO\n   * Should not be null when restoreFrom is set\n   */\n  initialRequestUrl?: string;\n  /**\n   * A serialized poller which can be used to resume an existing paused Long-Running-Operation.\n   */\n  restoreFrom?: string;\n  /**\n   * The function to get the initial response\n   */\n  getInitialResponse?: () => PromiseLike<TResponse>;\n  /**\n   * The api-version of the LRO\n   */\n  apiVersion?: string;\n}\nexport function getLongRunningPoller<TResponse extends PathUncheckedResponse, TResult = void>(\n  client: Client,\n  processResponseBody: (result: TResponse) => Promise<TResult>,\n  expectedStatuses: string[],\n  options: GetLongRunningPollerOptions<TResponse>,\n): PollerLike<OperationState<TResult>, TResult> {\n  const { restoreFrom, getInitialResponse, apiVersion } = options;\n  if (!restoreFrom && !getInitialResponse) {\n    throw new Error(\"Either restoreFrom or getInitialResponse must be specified\");\n  }\n  let initialResponse: TResponse | undefined = undefined;\n  const pollAbortController = new AbortController();\n  const poller: RunningOperation<TResponse> = {\n    sendInitialRequest: async () => {\n      if (!getInitialResponse) {\n        throw new Error(\"getInitialResponse is required when initializing a new poller\");\n      }\n      initialResponse = await getInitialResponse();\n      return getLroResponse(initialResponse, expectedStatuses);\n    },\n    sendPollRequest: async (\n      path: string,\n      pollOptions?: {\n        abortSignal?: AbortSignalLike;\n      },\n    ) => {\n      // The poll request would both listen to the user provided abort signal and the poller's own abort signal\n      function abortListener(): void {\n        pollAbortController.abort();\n      }\n      const abortSignal = pollAbortController.signal;\n      if (options.abortSignal?.aborted) {\n        pollAbortController.abort();\n      } else if (pollOptions?.abortSignal?.aborted) {\n        pollAbortController.abort();\n      } else if (!abortSignal.aborted) {\n        options.abortSignal?.addEventListener(\"abort\", abortListener, {\n          once: true,\n        });\n        pollOptions?.abortSignal?.addEventListener(\"abort\", abortListener, {\n          once: true,\n        });\n      }\n      let response;\n      try {\n        const pollingPath = apiVersion ? addApiVersionToUrl(path, apiVersion) : path;\n        response = await client.pathUnchecked(pollingPath).get({ abortSignal });\n      } finally {\n        options.abortSignal?.removeEventListener(\"abort\", abortListener);\n        pollOptions?.abortSignal?.removeEventListener(\"abort\", abortListener);\n      }\n\n      return getLroResponse(response as TResponse, expectedStatuses);\n    },\n  };\n  return createHttpPoller(poller, {\n    intervalInMs: options?.updateIntervalInMs,\n    resourceLocationConfig: options?.resourceLocationConfig,\n    restoreFrom: options?.restoreFrom,\n    processResult: (result: unknown) => {\n      return processResponseBody(result as TResponse);\n    },\n  });\n}\n/**\n * Converts a Rest Client response to a response that the LRO implementation understands\n * @param response - a rest client http response\n * @param deserializeFn - deserialize function to convert Rest response to modular output\n * @returns - An LRO response that the LRO implementation understands\n */\nfunction getLroResponse<TResponse extends PathUncheckedResponse>(\n  response: TResponse,\n  expectedStatuses: string[],\n): OperationResponse<TResponse> {\n  if (!expectedStatuses.includes(response.status)) {\n    throw createRestError(response);\n  }\n\n  return {\n    flatResponse: response,\n    rawResponse: {\n      ...response,\n      statusCode: Number.parseInt(response.status),\n      body: response.body,\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}${\n      Array.from(urlObj.searchParams.keys()).length > 0 ? \"&\" : \"?\"\n    }api-version=${apiVersion}`;\n  }\n  return url;\n}\n"],
-  "mappings": "AAUA,SAAS,wBAAwB;AAGjC,SAAS,uBAAuB;AAgCzB,SAAS,qBACd,QACA,qBACA,kBACA,SAC8C;AAC9C,QAAM,EAAE,aAAa,oBAAoB,WAAW,IAAI;AACxD,MAAI,CAAC,eAAe,CAAC,oBAAoB;AACvC,UAAM,IAAI,MAAM,4DAA4D;AAAA,EAC9E;AACA,MAAI,kBAAyC;AAC7C,QAAM,sBAAsB,IAAI,gBAAgB;AAChD,QAAM,SAAsC;AAAA,IAC1C,oBAAoB,YAAY;AAC9B,UAAI,CAAC,oBAAoB;AACvB,cAAM,IAAI,MAAM,+DAA+D;AAAA,MACjF;AACA,wBAAkB,MAAM,mBAAmB;AAC3C,aAAO,eAAe,iBAAiB,gBAAgB;AAAA,IACzD;AAAA,IACA,iBAAiB,OACf,MACA,gBAGG;AAEH,eAAS,gBAAsB;AAC7B,4BAAoB,MAAM;AAAA,MAC5B;AACA,YAAM,cAAc,oBAAoB;AACxC,UAAI,QAAQ,aAAa,SAAS;AAChC,4BAAoB,MAAM;AAAA,MAC5B,WAAW,aAAa,aAAa,SAAS;AAC5C,4BAAoB,MAAM;AAAA,MAC5B,WAAW,CAAC,YAAY,SAAS;AAC/B,gBAAQ,aAAa,iBAAiB,SAAS,eAAe;AAAA,UAC5D,MAAM;AAAA,QACR,CAAC;AACD,qBAAa,aAAa,iBAAiB,SAAS,eAAe;AAAA,UACjE,MAAM;AAAA,QACR,CAAC;AAAA,MACH;AACA,UAAI;AACJ,UAAI;AACF,cAAM,cAAc,aAAa,mBAAmB,MAAM,UAAU,IAAI;AACxE,mBAAW,MAAM,OAAO,cAAc,WAAW,EAAE,IAAI,EAAE,YAAY,CAAC;AAAA,MACxE,UAAE;AACA,gBAAQ,aAAa,oBAAoB,SAAS,aAAa;AAC/D,qBAAa,aAAa,oBAAoB,SAAS,aAAa;AAAA,MACtE;AAEA,aAAO,eAAe,UAAuB,gBAAgB;AAAA,IAC/D;AAAA,EACF;AACA,SAAO,iBAAiB,QAAQ;AAAA,IAC9B,cAAc,SAAS;AAAA,IACvB,wBAAwB,SAAS;AAAA,IACjC,aAAa,SAAS;AAAA,IACtB,eAAe,CAAC,WAAoB;AAClC,aAAO,oBAAoB,MAAmB;AAAA,IAChD;AAAA,EACF,CAAC;AACH;AAOA,SAAS,eACP,UACA,kBAC8B;AAC9B,MAAI,CAAC,iBAAiB,SAAS,SAAS,MAAM,GAAG;AAC/C,UAAM,gBAAgB,QAAQ;AAAA,EAChC;AAEA,SAAO;AAAA,IACL,cAAc;AAAA,IACd,aAAa;AAAA,MACX,GAAG;AAAA,MACH,YAAY,OAAO,SAAS,SAAS,MAAM;AAAA,MAC3C,MAAM,SAAS;AAAA,IACjB;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,GACX,MAAM,KAAK,OAAO,aAAa,KAAK,CAAC,EAAE,SAAS,IAAI,MAAM,GAC5D,eAAe,UAAU;AAAA,EAC3B;AACA,SAAO;AACT;",
-  "names": []
-}
+{"version":3,"file":"pollingHelpers.js","sourceRoot":"","sources":["../../../src/static-helpers/pollingHelpers.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AASlC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGnD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAgC1D,MAAM,UAAU,oBAAoB,CAClC,MAAc,EACd,mBAA4D,EAC5D,gBAA0B,EAC1B,OAA+C;IAE/C,MAAM,EAAE,WAAW,EAAE,kBAAkB,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAChE,IAAI,CAAC,WAAW,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IAChF,CAAC;IACD,IAAI,eAAe,GAA0B,SAAS,CAAC;IACvD,MAAM,mBAAmB,GAAG,IAAI,eAAe,EAAE,CAAC;IAClD,MAAM,MAAM,GAAgC;QAC1C,kBAAkB,EAAE,KAAK,IAAI,EAAE;YAC7B,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;YACnF,CAAC;YACD,eAAe,GAAG,MAAM,kBAAkB,EAAE,CAAC;YAC7C,OAAO,cAAc,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;QAC3D,CAAC;QACD,eAAe,EAAE,KAAK,EACpB,IAAY,EACZ,WAEC,EACD,EAAE;YACF,yGAAyG;YACzG,SAAS,aAAa;gBACpB,mBAAmB,CAAC,KAAK,EAAE,CAAC;YAC9B,CAAC;YACD,MAAM,WAAW,GAAG,mBAAmB,CAAC,MAAM,CAAC;YAC/C,IAAI,OAAO,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC;gBACjC,mBAAmB,CAAC,KAAK,EAAE,CAAC;YAC9B,CAAC;iBAAM,IAAI,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;gBAC7C,mBAAmB,CAAC,KAAK,EAAE,CAAC;YAC9B,CAAC;iBAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;gBAChC,OAAO,CAAC,WAAW,EAAE,gBAAgB,CAAC,OAAO,EAAE,aAAa,EAAE;oBAC5D,IAAI,EAAE,IAAI;iBACX,CAAC,CAAC;gBACH,WAAW,EAAE,WAAW,EAAE,gBAAgB,CAAC,OAAO,EAAE,aAAa,EAAE;oBACjE,IAAI,EAAE,IAAI;iBACX,CAAC,CAAC;YACL,CAAC;YACD,IAAI,QAAQ,CAAC;YACb,IAAI,CAAC;gBACH,MAAM,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC7E,QAAQ,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;YAC1E,CAAC;oBAAS,CAAC;gBACT,OAAO,CAAC,WAAW,EAAE,mBAAmB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;gBACjE,WAAW,EAAE,WAAW,EAAE,mBAAmB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;YACxE,CAAC;YAED,OAAO,cAAc,CAAC,QAAqB,EAAE,gBAAgB,CAAC,CAAC;QACjE,CAAC;KACF,CAAC;IACF,OAAO,gBAAgB,CAAC,MAAM,EAAE;QAC9B,YAAY,EAAE,OAAO,EAAE,kBAAkB;QACzC,sBAAsB,EAAE,OAAO,EAAE,sBAAsB;QACvD,WAAW,EAAE,OAAO,EAAE,WAAW;QACjC,aAAa,EAAE,CAAC,MAAe,EAAE,EAAE;YACjC,OAAO,mBAAmB,CAAC,MAAmB,CAAC,CAAC;QAClD,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AACD;;;;;GAKG;AACH,SAAS,cAAc,CACrB,QAAmB,EACnB,gBAA0B;IAE1B,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED,OAAO;QACL,YAAY,EAAE,QAAQ;QACtB,WAAW,EAAE;YACX,GAAG,QAAQ;YACX,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC5C,IAAI,EAAE,QAAQ,CAAC,IAAI;SACpB;KACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,GAAW,EAAE,UAAkB;IACzD,6EAA6E;IAC7E,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;QAC5C,uCAAuC;QACvC,OAAO,GAAG,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,eAAe,UAAU,EAAE,CAAC;IACvE,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type {\n  OperationResponse,\n  OperationState,\n  PollerLike,\n  ResourceLocationConfig,\n  RunningOperation,\n} from \"@azure/core-lro\";\nimport { createHttpPoller } from \"@azure/core-lro\";\n\nimport type { Client, PathUncheckedResponse } from \"@azure-rest/core-client\";\nimport { createRestError } from \"@azure-rest/core-client\";\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\n\nexport interface GetLongRunningPollerOptions<TResponse> {\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  /**\n   * The potential location of the result of the LRO if specified by the LRO extension in the swagger.\n   */\n  resourceLocationConfig?: ResourceLocationConfig;\n  /**\n   * The original url of the LRO\n   * Should not be null when restoreFrom is set\n   */\n  initialRequestUrl?: string;\n  /**\n   * A serialized poller which can be used to resume an existing paused Long-Running-Operation.\n   */\n  restoreFrom?: string;\n  /**\n   * The function to get the initial response\n   */\n  getInitialResponse?: () => PromiseLike<TResponse>;\n  /**\n   * The api-version of the LRO\n   */\n  apiVersion?: string;\n}\nexport function getLongRunningPoller<TResponse extends PathUncheckedResponse, TResult = void>(\n  client: Client,\n  processResponseBody: (result: TResponse) => Promise<TResult>,\n  expectedStatuses: string[],\n  options: GetLongRunningPollerOptions<TResponse>,\n): PollerLike<OperationState<TResult>, TResult> {\n  const { restoreFrom, getInitialResponse, apiVersion } = options;\n  if (!restoreFrom && !getInitialResponse) {\n    throw new Error(\"Either restoreFrom or getInitialResponse must be specified\");\n  }\n  let initialResponse: TResponse | undefined = undefined;\n  const pollAbortController = new AbortController();\n  const poller: RunningOperation<TResponse> = {\n    sendInitialRequest: async () => {\n      if (!getInitialResponse) {\n        throw new Error(\"getInitialResponse is required when initializing a new poller\");\n      }\n      initialResponse = await getInitialResponse();\n      return getLroResponse(initialResponse, expectedStatuses);\n    },\n    sendPollRequest: async (\n      path: string,\n      pollOptions?: {\n        abortSignal?: AbortSignalLike;\n      },\n    ) => {\n      // The poll request would both listen to the user provided abort signal and the poller's own abort signal\n      function abortListener(): void {\n        pollAbortController.abort();\n      }\n      const abortSignal = pollAbortController.signal;\n      if (options.abortSignal?.aborted) {\n        pollAbortController.abort();\n      } else if (pollOptions?.abortSignal?.aborted) {\n        pollAbortController.abort();\n      } else if (!abortSignal.aborted) {\n        options.abortSignal?.addEventListener(\"abort\", abortListener, {\n          once: true,\n        });\n        pollOptions?.abortSignal?.addEventListener(\"abort\", abortListener, {\n          once: true,\n        });\n      }\n      let response;\n      try {\n        const pollingPath = apiVersion ? addApiVersionToUrl(path, apiVersion) : path;\n        response = await client.pathUnchecked(pollingPath).get({ abortSignal });\n      } finally {\n        options.abortSignal?.removeEventListener(\"abort\", abortListener);\n        pollOptions?.abortSignal?.removeEventListener(\"abort\", abortListener);\n      }\n\n      return getLroResponse(response as TResponse, expectedStatuses);\n    },\n  };\n  return createHttpPoller(poller, {\n    intervalInMs: options?.updateIntervalInMs,\n    resourceLocationConfig: options?.resourceLocationConfig,\n    restoreFrom: options?.restoreFrom,\n    processResult: (result: unknown) => {\n      return processResponseBody(result as TResponse);\n    },\n  });\n}\n/**\n * Converts a Rest Client response to a response that the LRO implementation understands\n * @param response - a rest client http response\n * @param deserializeFn - deserialize function to convert Rest response to modular output\n * @returns - An LRO response that the LRO implementation understands\n */\nfunction getLroResponse<TResponse extends PathUncheckedResponse>(\n  response: TResponse,\n  expectedStatuses: string[],\n): OperationResponse<TResponse> {\n  if (!expectedStatuses.includes(response.status)) {\n    throw createRestError(response);\n  }\n\n  return {\n    flatResponse: response,\n    rawResponse: {\n      ...response,\n      statusCode: Number.parseInt(response.status),\n      body: response.body,\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"]}

package/dist/esm/static-helpers/urlTemplate.js

@@ -1,173 +1,200 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+// ---------------------
+// helpers
+// ---------------------
 function encodeComponent(val, reserved, op) {
-  return (reserved ?? op === "+") || op === "#" ? encodeReservedComponent(val) : encodeRFC3986URIComponent(val);
+    return (reserved ?? op === "+") || op === "#"
+        ? encodeReservedComponent(val)
+        : encodeRFC3986URIComponent(val);
 }
 function encodeReservedComponent(str) {
-  return str.split(/(%[0-9A-Fa-f]{2})/g).map((part) => !/%[0-9A-Fa-f]/.test(part) ? encodeURI(part) : part).join("");
+    return str
+        .split(/(%[0-9A-Fa-f]{2})/g)
+        .map((part) => (!/%[0-9A-Fa-f]/.test(part) ? encodeURI(part) : part))
+        .join("");
 }
 function encodeRFC3986URIComponent(str) {
-  return encodeURIComponent(str).replace(
-    /[!'()*]/g,
-    (c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`
-  );
+    return encodeURIComponent(str).replace(/[!'()*]/g, (c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`);
 }
 function isDefined(val) {
-  return val !== void 0 && val !== null;
+    return val !== undefined && val !== null;
 }
 function getNamedAndIfEmpty(op) {
-  return [!!op && [";", "?", "&"].includes(op), !!op && ["?", "&"].includes(op) ? "=" : ""];
+    return [!!op && [";", "?", "&"].includes(op), !!op && ["?", "&"].includes(op) ? "=" : ""];
 }
 function getFirstOrSep(op, isFirst = false) {
-  if (isFirst) {
-    return !op || op === "+" ? "" : op;
-  } else if (!op || op === "+" || op === "#") {
-    return ",";
-  } else if (op === "?") {
-    return "&";
-  } else {
-    return op;
-  }
+    if (isFirst) {
+        return !op || op === "+" ? "" : op;
+    }
+    else if (!op || op === "+" || op === "#") {
+        return ",";
+    }
+    else if (op === "?") {
+        return "&";
+    }
+    else {
+        return op;
+    }
 }
 function getExpandedValue(option) {
-  let isFirst = option.isFirst;
-  const { op, varName, varValue: value, reserved } = option;
-  const vals = [];
-  const [named, ifEmpty] = getNamedAndIfEmpty(op);
-  if (Array.isArray(value)) {
-    for (const val of value.filter(isDefined)) {
-      vals.push(`${getFirstOrSep(op, isFirst)}`);
-      if (named && varName) {
-        vals.push(`${encodeURIComponent(varName)}`);
-        if (val === "") {
-          vals.push(ifEmpty);
-        } else {
-          vals.push("=");
+    let isFirst = option.isFirst;
+    const { op, varName, varValue: value, reserved } = option;
+    const vals = [];
+    const [named, ifEmpty] = getNamedAndIfEmpty(op);
+    if (Array.isArray(value)) {
+        for (const val of value.filter(isDefined)) {
+            // prepare the following parts: separator, varName, value
+            vals.push(`${getFirstOrSep(op, isFirst)}`);
+            if (named && varName) {
+                vals.push(`${encodeURIComponent(varName)}`);
+                if (val === "") {
+                    vals.push(ifEmpty);
+                }
+                else {
+                    vals.push("=");
+                }
+            }
+            vals.push(encodeComponent(val, reserved, op));
+            isFirst = false;
         }
-      }
-      vals.push(encodeComponent(val, reserved, op));
-      isFirst = false;
     }
-  } else if (typeof value === "object") {
-    for (const key of Object.keys(value)) {
-      const val = value[key];
-      if (!isDefined(val)) {
-        continue;
-      }
-      vals.push(`${getFirstOrSep(op, isFirst)}`);
-      if (key) {
-        vals.push(`${encodeURIComponent(key)}`);
-        if (named && val === "") {
-          vals.push(ifEmpty);
-        } else {
-          vals.push("=");
+    else if (typeof value === "object") {
+        for (const key of Object.keys(value)) {
+            const val = value[key];
+            if (!isDefined(val)) {
+                continue;
+            }
+            // prepare the following parts: separator, key, value
+            vals.push(`${getFirstOrSep(op, isFirst)}`);
+            if (key) {
+                vals.push(`${encodeURIComponent(key)}`);
+                if (named && val === "") {
+                    vals.push(ifEmpty);
+                }
+                else {
+                    vals.push("=");
+                }
+            }
+            vals.push(encodeComponent(val, reserved, op));
+            isFirst = false;
         }
-      }
-      vals.push(encodeComponent(val, reserved, op));
-      isFirst = false;
     }
-  }
-  return vals.join("");
+    return vals.join("");
 }
 function getNonExpandedValue(option) {
-  const { op, varName, varValue: value, isFirst, reserved } = option;
-  const vals = [];
-  const first = getFirstOrSep(op, isFirst);
-  const [named, ifEmpty] = getNamedAndIfEmpty(op);
-  if (named && varName) {
-    vals.push(encodeComponent(varName, reserved, op));
-    if (value === "") {
-      if (!ifEmpty) {
-        vals.push(ifEmpty);
-      }
-      return !vals.join("") ? void 0 : `${first}${vals.join("")}`;
-    }
-    vals.push("=");
-  }
-  const items = [];
-  if (Array.isArray(value)) {
-    for (const val of value.filter(isDefined)) {
-      items.push(encodeComponent(val, reserved, op));
-    }
-  } else if (typeof value === "object") {
-    for (const key of Object.keys(value)) {
-      if (!isDefined(value[key])) {
-        continue;
-      }
-      items.push(encodeRFC3986URIComponent(key));
-      items.push(encodeComponent(value[key], reserved, op));
-    }
-  }
-  vals.push(items.join(","));
-  return !vals.join(",") ? void 0 : `${first}${vals.join("")}`;
-}
-function getVarValue(option) {
-  const { op, varName, modifier, isFirst, reserved, varValue: value } = option;
-  if (!isDefined(value)) {
-    return void 0;
-  } else if (["string", "number", "boolean"].includes(typeof value)) {
-    let val = value.toString();
+    const { op, varName, varValue: value, isFirst, reserved } = option;
+    const vals = [];
+    const first = getFirstOrSep(op, isFirst);
     const [named, ifEmpty] = getNamedAndIfEmpty(op);
-    const vals = [getFirstOrSep(op, isFirst)];
     if (named && varName) {
-      vals.push(varName);
-      if (val === "") {
-        vals.push(ifEmpty);
-      } else {
+        vals.push(encodeComponent(varName, reserved, op));
+        if (value === "") {
+            if (!ifEmpty) {
+                vals.push(ifEmpty);
+            }
+            return !vals.join("") ? undefined : `${first}${vals.join("")}`;
+        }
         vals.push("=");
-      }
     }
-    if (modifier && modifier !== "*") {
-      val = val.substring(0, parseInt(modifier, 10));
+    const items = [];
+    if (Array.isArray(value)) {
+        for (const val of value.filter(isDefined)) {
+            items.push(encodeComponent(val, reserved, op));
+        }
+    }
+    else if (typeof value === "object") {
+        for (const key of Object.keys(value)) {
+            if (!isDefined(value[key])) {
+                continue;
+            }
+            items.push(encodeRFC3986URIComponent(key));
+            items.push(encodeComponent(value[key], reserved, op));
+        }
     }
-    vals.push(encodeComponent(val, reserved, op));
-    return vals.join("");
-  } else if (modifier === "*") {
-    return getExpandedValue(option);
-  } else {
-    return getNonExpandedValue(option);
-  }
+    vals.push(items.join(","));
+    return !vals.join(",") ? undefined : `${first}${vals.join("")}`;
 }
-function expandUrlTemplate(template, context, option) {
-  const result = template.replace(/\{([^{}]+)\}|([^{}]+)/g, (_, expr, text) => {
-    if (!expr) {
-      return encodeReservedComponent(text);
+function getVarValue(option) {
+    const { op, varName, modifier, isFirst, reserved, varValue: value } = option;
+    if (!isDefined(value)) {
+        return undefined;
+    }
+    else if (["string", "number", "boolean"].includes(typeof value)) {
+        let val = value.toString();
+        const [named, ifEmpty] = getNamedAndIfEmpty(op);
+        const vals = [getFirstOrSep(op, isFirst)];
+        if (named && varName) {
+            // No need to encode varName considering it is already encoded
+            vals.push(varName);
+            if (val === "") {
+                vals.push(ifEmpty);
+            }
+            else {
+                vals.push("=");
+            }
+        }
+        if (modifier && modifier !== "*") {
+            val = val.substring(0, parseInt(modifier, 10));
+        }
+        vals.push(encodeComponent(val, reserved, op));
+        return vals.join("");
     }
-    let op;
-    if (["+", "#", ".", "/", ";", "?", "&"].includes(expr[0])) {
-      op = expr[0];
-      expr = expr.slice(1);
+    else if (modifier === "*") {
+        return getExpandedValue(option);
     }
-    const varList = expr.split(/,/g);
-    const innerResult = [];
-    for (const varSpec of varList) {
-      const varMatch = /([^:*]*)(?::(\d+)|(\*))?/.exec(varSpec);
-      if (!varMatch || !varMatch[1]) {
-        continue;
-      }
-      const varValue = getVarValue({
-        isFirst: innerResult.length === 0,
-        op,
-        varValue: context[varMatch[1]],
-        varName: varMatch[1],
-        modifier: varMatch[2] || varMatch[3],
-        reserved: option?.allowReserved
-      });
-      if (varValue) {
-        innerResult.push(varValue);
-      }
+    else {
+        return getNonExpandedValue(option);
     }
-    return innerResult.join("");
-  });
-  return normalizeUnreserved(result);
 }
+// ---------------------------------------------------------------------------------------------------
+// This is an implementation of RFC 6570 URI Template: https://datatracker.ietf.org/doc/html/rfc6570.
+// ---------------------------------------------------------------------------------------------------
+export function expandUrlTemplate(template, context, option) {
+    const result = template.replace(/\{([^{}]+)\}|([^{}]+)/g, (_, expr, text) => {
+        if (!expr) {
+            return encodeReservedComponent(text);
+        }
+        let op;
+        if (["+", "#", ".", "/", ";", "?", "&"].includes(expr[0])) {
+            op = expr[0];
+            expr = expr.slice(1);
+        }
+        const varList = expr.split(/,/g);
+        const innerResult = [];
+        for (const varSpec of varList) {
+            const varMatch = /([^:*]*)(?::(\d+)|(\*))?/.exec(varSpec);
+            if (!varMatch || !varMatch[1]) {
+                continue;
+            }
+            const varValue = getVarValue({
+                isFirst: innerResult.length === 0,
+                op,
+                varValue: context[varMatch[1]],
+                varName: varMatch[1],
+                modifier: varMatch[2] || varMatch[3],
+                reserved: option?.allowReserved,
+            });
+            if (varValue) {
+                innerResult.push(varValue);
+            }
+        }
+        return innerResult.join("");
+    });
+    return normalizeUnreserved(result);
+}
+/**
+ * Normalize an expanded URI by decoding percent-encoded unreserved characters.
+ * RFC 3986 unreserved: "-" / "." / "~"
+ */
 function normalizeUnreserved(uri) {
-  return uri.replace(/%([0-9A-Fa-f]{2})/g, (match, hex) => {
-    const char = String.fromCharCode(parseInt(hex, 16));
-    if (/[.~-]/.test(char)) {
-      return char;
-    }
-    return match;
-  });
+    return uri.replace(/%([0-9A-Fa-f]{2})/g, (match, hex) => {
+        const char = String.fromCharCode(parseInt(hex, 16));
+        // Decode only if it's unreserved
+        if (/[.~-]/.test(char)) {
+            return char;
+        }
+        return match; // leave other encodings intact
+    });
 }
-export {
-  expandUrlTemplate
-};
+//# sourceMappingURL=urlTemplate.js.map