@azure-rest/iot-device-update 1.0.1-alpha.20241219.1 → 1.1.0-alpha.20241223.1

package/dist/esm/paginateHelper.js

@@ -1,7 +1,104 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import { getPagedAsyncIterator } from "@azure/core-paging";
+import { __asyncDelegator, __asyncGenerator, __asyncValues, __await } from "tslib";
 import { createRestError } from "@azure-rest/core-client";
+/**
+ * returns an async iterator that iterates over results. It also has a `byPage`
+ * method that returns pages of items at once.
+ *
+ * @param pagedResult - an object that specifies how to get pages.
+ * @returns a paged async iterator that iterates over results.
+ */
+function getPagedAsyncIterator(pagedResult) {
+    var _a;
+    const iter = getItemAsyncIterator(pagedResult);
+    return {
+        next() {
+            return iter.next();
+        },
+        [Symbol.asyncIterator]() {
+            return this;
+        },
+        byPage: (_a = pagedResult === null || pagedResult === void 0 ? void 0 : pagedResult.byPage) !== null && _a !== void 0 ? _a : ((settings) => {
+            const { continuationToken } = settings !== null && settings !== void 0 ? settings : {};
+            return getPageAsyncIterator(pagedResult, {
+                pageLink: continuationToken,
+            });
+        }),
+    };
+}
+function getItemAsyncIterator(pagedResult) {
+    return __asyncGenerator(this, arguments, function* getItemAsyncIterator_1() {
+        var _a, e_1, _b, _c, _d, e_2, _e, _f;
+        const pages = getPageAsyncIterator(pagedResult);
+        const firstVal = yield __await(pages.next());
+        // if the result does not have an array shape, i.e. TPage = TElement, then we return it as is
+        if (!Array.isArray(firstVal.value)) {
+            // can extract elements from this page
+            const { toElements } = pagedResult;
+            if (toElements) {
+                yield __await(yield* __asyncDelegator(__asyncValues(toElements(firstVal.value))));
+                try {
+                    for (var _g = true, pages_1 = __asyncValues(pages), pages_1_1; pages_1_1 = yield __await(pages_1.next()), _a = pages_1_1.done, !_a; _g = true) {
+                        _c = pages_1_1.value;
+                        _g = false;
+                        const page = _c;
+                        yield __await(yield* __asyncDelegator(__asyncValues(toElements(page))));
+                    }
+                }
+                catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                finally {
+                    try {
+                        if (!_g && !_a && (_b = pages_1.return)) yield __await(_b.call(pages_1));
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                }
+            }
+            else {
+                yield yield __await(firstVal.value);
+                // `pages` is of type `AsyncIterableIterator<TPage>` but TPage = TElement in this case
+                yield __await(yield* __asyncDelegator(__asyncValues(pages)));
+            }
+        }
+        else {
+            yield __await(yield* __asyncDelegator(__asyncValues(firstVal.value)));
+            try {
+                for (var _h = true, pages_2 = __asyncValues(pages), pages_2_1; pages_2_1 = yield __await(pages_2.next()), _d = pages_2_1.done, !_d; _h = true) {
+                    _f = pages_2_1.value;
+                    _h = false;
+                    const page = _f;
+                    // pages is of type `AsyncIterableIterator<TPage>` so `page` is of type `TPage`. In this branch,
+                    // it must be the case that `TPage = TElement[]`
+                    yield __await(yield* __asyncDelegator(__asyncValues(page)));
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (!_h && !_d && (_e = pages_2.return)) yield __await(_e.call(pages_2));
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+        }
+    });
+}
+function getPageAsyncIterator(pagedResult_1) {
+    return __asyncGenerator(this, arguments, function* getPageAsyncIterator_1(pagedResult, options = {}) {
+        const { pageLink } = options;
+        let response = yield __await(pagedResult.getPage(pageLink !== null && pageLink !== void 0 ? pageLink : pagedResult.firstPageLink));
+        if (!response) {
+            return yield __await(void 0);
+        }
+        yield yield __await(response.page);
+        while (response.nextPageLink) {
+            response = yield __await(pagedResult.getPage(response.nextPageLink));
+            if (!response) {
+                return yield __await(void 0);
+            }
+            yield yield __await(response.page);
+        }
+    });
+}
 /**
  * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
  * @param client - Client to use for sending the next page requests

package/dist/esm/paginateHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"paginateHelper.js","sourceRoot":"","sources":["../../src/paginateHelper.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAyC1D;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAc,EACd,eAA0B,EAC1B,UAAoC,EAAE;IAItC,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,MAAM,QAAQ,GAAG,OAAO,CAAC;IACzB,MAAM,YAAY,GAAG,UAAU,CAAC;IAChC,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAClC,MAAM,WAAW,GAA4B;QAC3C,aAAa,EAAE,EAAE;QACjB,OAAO,EACL,OAAO,aAAa,KAAK,UAAU;YACjC,CAAC,CAAC,aAAa;YACf,CAAC,CAAC,KAAK,EAAE,QAAgB,EAAE,EAAE;gBACzB,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC;gBACvF,QAAQ,GAAG,KAAK,CAAC;gBACjB,kBAAkB,CAAC,MAAM,CAAC,CAAC;gBAC3B,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;gBACxD,MAAM,MAAM,GAAG,WAAW,CAAW,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBAC5D,OAAO;oBACL,IAAI,EAAE,MAAM;oBACZ,YAAY,EAAE,QAAQ;iBACvB,CAAC;YACJ,CAAC;KACR,CAAC;IAEF,OAAO,qBAAqB,CAAC,WAAW,CAAC,CAAC;AAC5C,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,EAAE,CAAC;QACpE,MAAM,IAAI,KAAK,CAAC,iBAAiB,YAAY,kCAAkC,CAAC,CAAC;IACnF,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;IAEjE,qEAAqE;IACrE,qEAAqE;IACrE,iDAAiD;IACjD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,kFAAkF,QAAQ,EAAE,CAC7F,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,QAA+B;IACzD,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAClG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,MAAM,eAAe,CACnB,gDAAgD,QAAQ,CAAC,MAAM,EAAE,EACjE,QAAQ,CACT,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PagedAsyncIterableIterator, PagedResult } from \"@azure/core-paging\";\nimport { getPagedAsyncIterator } from \"@azure/core-paging\";\nimport type { Client, PathUncheckedResponse } from \"@azure-rest/core-client\";\nimport { createRestError } from \"@azure-rest/core-client\";\n\n/**\n * Helper type to extract the type of an array\n */\nexport type GetArrayType<T> = T extends Array<infer TData> ? TData : never;\n\n/**\n * The type of a custom function that defines how to get a page and a link to the next one if any.\n */\nexport type GetPage<TPage> = (\n  pageLink: string,\n  maxPageSize?: number,\n) => Promise<{\n  page: TPage;\n  nextPageLink?: string;\n}>;\n\n/**\n * Options for the paging helper\n */\nexport interface PagingOptions<TResponse> {\n  /**\n   * Custom function to extract pagination details for crating the PagedAsyncIterableIterator\n   */\n  customGetPage?: GetPage<PaginateReturn<TResponse>[]>;\n}\n\n/**\n * Helper type to infer the Type of the paged elements from the response type\n * This type is generated based on the swagger information for x-ms-pageable\n * specifically on the itemName property which indicates the property of the response\n * where the page items are found. The default value is `value`.\n * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter\n */\nexport type PaginateReturn<TResult> = TResult extends {\n  body: { value?: infer TPage };\n}\n  ? GetArrayType<TPage>\n  : Array<unknown>;\n\n/**\n * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension\n * @param client - Client to use for sending the next page requests\n * @param initialResponse - Initial response containing the nextLink and current page of elements\n * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results\n * @returns - PagedAsyncIterableIterator to iterate the elements\n */\nexport function paginate<TResponse extends PathUncheckedResponse>(\n  client: Client,\n  initialResponse: TResponse,\n  options: PagingOptions<TResponse> = {},\n): PagedAsyncIterableIterator<PaginateReturn<TResponse>> {\n  // Extract element type from initial response\n  type TElement = PaginateReturn<TResponse>;\n  let firstRun = true;\n  const itemName = \"value\";\n  const nextLinkName = \"nextLink\";\n  const { customGetPage } = options;\n  const pagedResult: PagedResult<TElement[]> = {\n    firstPageLink: \"\",\n    getPage:\n      typeof customGetPage === \"function\"\n        ? customGetPage\n        : async (pageLink: string) => {\n            const result = firstRun ? initialResponse : await client.pathUnchecked(pageLink).get();\n            firstRun = false;\n            checkPagingRequest(result);\n            const nextLink = getNextLink(result.body, nextLinkName);\n            const values = getElements<TElement>(result.body, itemName);\n            return {\n              page: values,\n              nextPageLink: nextLink,\n            };\n          },\n  };\n\n  return getPagedAsyncIterator(pagedResult);\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\") {\n    throw new Error(`Body Property ${nextLinkName} should be a string or 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\n  // value has to be an array according to the x-ms-pageable extension.\n  // The fact that this must be an array is used above to calculate the\n  // type of elements in the page in PaginateReturn\n  if (!Array.isArray(value)) {\n    throw new Error(\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): void {\n  const Http2xxStatusCodes = [\"200\", \"201\", \"202\", \"203\", \"204\", \"205\", \"206\", \"207\", \"208\", \"226\"];\n  if (!Http2xxStatusCodes.includes(response.status)) {\n    throw createRestError(\n      `Pagination failed with unexpected statusCode ${response.status}`,\n      response,\n    );\n  }\n}\n"]}
+{"version":3,"file":"paginateHelper.js","sourceRoot":"","sources":["../../src/paginateHelper.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAGlC,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;;;;;GAMG;AACH,SAAS,qBAAqB,CAM5B,WAAqD;;IAErD,MAAM,IAAI,GAAG,oBAAoB,CAAwC,WAAW,CAAC,CAAC;IACtF,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,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,mCAClB,CAAC,CAAC,QAAuB,EAAE,EAAE;YAC5B,MAAM,EAAE,iBAAiB,EAAE,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC;YAC7C,OAAO,oBAAoB,CAAC,WAAW,EAAE;gBACvC,QAAQ,EAAE,iBAAiD;aAC5D,CAAC,CAAC;QACL,CAAC,CAA2E;KAC/E,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAClC,WAAqD;;;QAErD,MAAM,KAAK,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAG,cAAM,KAAK,CAAC,IAAI,EAAE,CAAA,CAAC;QACpC,6FAA6F;QAC7F,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,sCAAsC;YACtC,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC;YACnC,IAAI,UAAU,EAAE,CAAC;gBACf,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAe,CAAA,CAAA,CAAA,CAAC;;oBAChD,KAAyB,eAAA,UAAA,cAAA,KAAK,CAAA,WAAA,kFAAE,CAAC;wBAAR,qBAAK;wBAAL,WAAK;wBAAnB,MAAM,IAAI,KAAA,CAAA;wBACnB,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,UAAU,CAAC,IAAI,CAAe,CAAA,CAAA,CAAA,CAAC;oBACxC,CAAC;;;;;;;;;YACH,CAAC;iBAAM,CAAC;gBACN,oBAAM,QAAQ,CAAC,KAAK,CAAA,CAAC;gBACrB,sFAAsF;gBACtF,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,KAAmD,CAAA,CAAA,CAAA,CAAC;YAC7D,CAAC;QACH,CAAC;aAAM,CAAC;YACN,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,QAAQ,CAAC,KAAK,CAAA,CAAA,CAAA,CAAC;;gBACtB,KAAyB,eAAA,UAAA,cAAA,KAAK,CAAA,WAAA,kFAAE,CAAC;oBAAR,qBAAK;oBAAL,WAAK;oBAAnB,MAAM,IAAI,KAAA,CAAA;oBACnB,gGAAgG;oBAChG,gDAAgD;oBAChD,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,IAA6B,CAAA,CAAA,CAAA,CAAC;gBACvC,CAAC;;;;;;;;;QACH,CAAC;IACH,CAAC;CAAA;AAED,SAAgB,oBAAoB;8EAClC,WAAqD,EACrD,UAEI,EAAE;QAEN,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAC7B,IAAI,QAAQ,GAAG,cAAM,WAAW,CAAC,OAAO,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,WAAW,CAAC,aAAa,CAAC,CAAA,CAAC;QAChF,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,6BAAO;QACT,CAAC;QACD,oBAAM,QAAQ,CAAC,IAAI,CAAA,CAAC;QACpB,OAAO,QAAQ,CAAC,YAAY,EAAE,CAAC;YAC7B,QAAQ,GAAG,cAAM,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA,CAAC;YAC5D,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,6BAAO;YACT,CAAC;YACD,oBAAM,QAAQ,CAAC,IAAI,CAAA,CAAC;QACtB,CAAC;IACH,CAAC;CAAA;AA6FD;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAc,EACd,eAA0B,EAC1B,UAAoC,EAAE;IAItC,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,MAAM,QAAQ,GAAG,OAAO,CAAC;IACzB,MAAM,YAAY,GAAG,UAAU,CAAC;IAChC,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAClC,MAAM,WAAW,GAA4B;QAC3C,aAAa,EAAE,EAAE;QACjB,OAAO,EACL,OAAO,aAAa,KAAK,UAAU;YACjC,CAAC,CAAC,aAAa;YACf,CAAC,CAAC,KAAK,EAAE,QAAgB,EAAE,EAAE;gBACzB,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC;gBACvF,QAAQ,GAAG,KAAK,CAAC;gBACjB,kBAAkB,CAAC,MAAM,CAAC,CAAC;gBAC3B,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;gBACxD,MAAM,MAAM,GAAG,WAAW,CAAW,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBAC5D,OAAO;oBACL,IAAI,EAAE,MAAM;oBACZ,YAAY,EAAE,QAAQ;iBACvB,CAAC;YACJ,CAAC;KACR,CAAC;IAEF,OAAO,qBAAqB,CAAC,WAAW,CAAC,CAAC;AAC5C,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,EAAE,CAAC;QACpE,MAAM,IAAI,KAAK,CAAC,iBAAiB,YAAY,kCAAkC,CAAC,CAAC;IACnF,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;IAEjE,qEAAqE;IACrE,qEAAqE;IACrE,iDAAiD;IACjD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,kFAAkF,QAAQ,EAAE,CAC7F,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,QAA+B;IACzD,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAClG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,MAAM,eAAe,CACnB,gDAAgD,QAAQ,CAAC,MAAM,EAAE,EACjE,QAAQ,CACT,CAAC;IACJ,CAAC;AACH,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\";\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 */\nfunction getPagedAsyncIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings = PageSettings,\n  TLink = string,\n>(\n  pagedResult: PagedResult<TPage, TPageSettings, TLink>,\n): PagedAsyncIterableIterator<TElement, TPage, TPageSettings> {\n  const iter = getItemAsyncIterator<TElement, TPage, TLink, 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?: PageSettings) => {\n        const { continuationToken } = settings ?? {};\n        return getPageAsyncIterator(pagedResult, {\n          pageLink: continuationToken as unknown as TLink | undefined,\n        });\n      }) as unknown as (settings?: TPageSettings) => AsyncIterableIterator<TPage>),\n  };\n}\n\nasync function* getItemAsyncIterator<TElement, TPage, TLink, TPageSettings>(\n  pagedResult: PagedResult<TPage, TPageSettings, TLink>,\n): AsyncIterableIterator<TElement> {\n  const pages = getPageAsyncIterator(pagedResult);\n  const firstVal = await pages.next();\n  // if the result does not have an array shape, i.e. TPage = TElement, then we return it as is\n  if (!Array.isArray(firstVal.value)) {\n    // can extract elements from this page\n    const { toElements } = pagedResult;\n    if (toElements) {\n      yield* toElements(firstVal.value) as TElement[];\n      for await (const page of pages) {\n        yield* toElements(page) as TElement[];\n      }\n    } else {\n      yield firstVal.value;\n      // `pages` is of type `AsyncIterableIterator<TPage>` but TPage = TElement in this case\n      yield* pages as unknown as AsyncIterableIterator<TElement>;\n    }\n  } else {\n    yield* firstVal.value;\n    for await (const page of pages) {\n      // pages is of type `AsyncIterableIterator<TPage>` so `page` is of type `TPage`. In this branch,\n      // it must be the case that `TPage = TElement[]`\n      yield* page as unknown as TElement[];\n    }\n  }\n}\n\nasync function* getPageAsyncIterator<TPage, TLink, TPageSettings>(\n  pagedResult: PagedResult<TPage, TPageSettings, TLink>,\n  options: {\n    pageLink?: TLink;\n  } = {},\n): AsyncIterableIterator<TPage> {\n  const { pageLink } = options;\n  let response = await pagedResult.getPage(pageLink ?? pagedResult.firstPageLink);\n  if (!response) {\n    return;\n  }\n  yield response.page;\n  while (response.nextPageLink) {\n    response = await pagedResult.getPage(response.nextPageLink);\n    if (!response) {\n      return;\n    }\n    yield response.page;\n  }\n}\n\n/**\n * An interface that tracks the settings for paged iteration\n */\nexport interface PageSettings {\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 = 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<TPage>;\n}\n\n/**\n * An interface that describes how to communicate with the service.\n */\ninterface PagedResult<TPage, TPageSettings = PageSettings, TLink = string> {\n  /**\n   * Link to the first page of results.\n   */\n  firstPageLink: TLink;\n  /**\n   * A method that returns a page of results.\n   */\n  getPage: (pageLink: TLink) => Promise<{ page: TPage; nextPageLink?: TLink } | undefined>;\n  /**\n   * a function to implement the `byPage` method on the paged async iterator.\n   */\n  byPage?: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;\n\n  /**\n   * A function to extract elements from a page.\n   */\n  toElements?: (page: TPage) => unknown[];\n}\n\n/**\n * Helper type to extract the type of an array\n */\nexport type GetArrayType<T> = T extends Array<infer TData> ? TData : never;\n\n/**\n * The type of a custom function that defines how to get a page and a link to the next one if any.\n */\nexport type GetPage<TPage> = (pageLink: string) => Promise<{\n  page: TPage;\n  nextPageLink?: string;\n}>;\n\n/**\n * Options for the paging helper\n */\nexport interface PagingOptions<TResponse> {\n  /**\n   * Custom function to extract pagination details for crating the PagedAsyncIterableIterator\n   */\n  customGetPage?: GetPage<PaginateReturn<TResponse>[]>;\n}\n\n/**\n * Helper type to infer the Type of the paged elements from the response type\n * This type is generated based on the swagger information for x-ms-pageable\n * specifically on the itemName property which indicates the property of the response\n * where the page items are found. The default value is `value`.\n * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter\n */\nexport type PaginateReturn<TResult> = TResult extends {\n  body: { value?: infer TPage };\n}\n  ? GetArrayType<TPage>\n  : Array<unknown>;\n\n/**\n * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension\n * @param client - Client to use for sending the next page requests\n * @param initialResponse - Initial response containing the nextLink and current page of elements\n * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results\n * @returns - PagedAsyncIterableIterator to iterate the elements\n */\nexport function paginate<TResponse extends PathUncheckedResponse>(\n  client: Client,\n  initialResponse: TResponse,\n  options: PagingOptions<TResponse> = {},\n): PagedAsyncIterableIterator<PaginateReturn<TResponse>> {\n  // Extract element type from initial response\n  type TElement = PaginateReturn<TResponse>;\n  let firstRun = true;\n  const itemName = \"value\";\n  const nextLinkName = \"nextLink\";\n  const { customGetPage } = options;\n  const pagedResult: PagedResult<TElement[]> = {\n    firstPageLink: \"\",\n    getPage:\n      typeof customGetPage === \"function\"\n        ? customGetPage\n        : async (pageLink: string) => {\n            const result = firstRun ? initialResponse : await client.pathUnchecked(pageLink).get();\n            firstRun = false;\n            checkPagingRequest(result);\n            const nextLink = getNextLink(result.body, nextLinkName);\n            const values = getElements<TElement>(result.body, itemName);\n            return {\n              page: values,\n              nextPageLink: nextLink,\n            };\n          },\n  };\n\n  return getPagedAsyncIterator(pagedResult);\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\") {\n    throw new Error(`Body Property ${nextLinkName} should be a string or 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\n  // value has to be an array according to the x-ms-pageable extension.\n  // The fact that this must be an array is used above to calculate the\n  // type of elements in the page in PaginateReturn\n  if (!Array.isArray(value)) {\n    throw new Error(\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): void {\n  const Http2xxStatusCodes = [\"200\", \"201\", \"202\", \"203\", \"204\", \"205\", \"206\", \"207\", \"208\", \"226\"];\n  if (!Http2xxStatusCodes.includes(response.status)) {\n    throw createRestError(\n      `Pagination failed with unexpected statusCode ${response.status}`,\n      response,\n    );\n  }\n}\n"]}

package/dist/esm/parameters.d.ts

@@ -25,7 +25,7 @@ export interface DeviceUpdateGetUpdateHeaders {
     "If-None-Match"?: string;
 }
 export interface DeviceUpdateGetUpdateHeaderParam {
-    headers: RawHttpHeadersInput & DeviceUpdateGetUpdateHeaders;
+    headers?: RawHttpHeadersInput & DeviceUpdateGetUpdateHeaders;
 }
 export type DeviceUpdateGetUpdateParameters = DeviceUpdateGetUpdateHeaderParam & RequestParameters;
 export type DeviceUpdateDeleteUpdateParameters = RequestParameters;
@@ -45,7 +45,7 @@ export interface DeviceUpdateGetFileHeaders {
     "If-None-Match"?: string;
 }
 export interface DeviceUpdateGetFileHeaderParam {
-    headers: RawHttpHeadersInput & DeviceUpdateGetFileHeaders;
+    headers?: RawHttpHeadersInput & DeviceUpdateGetFileHeaders;
 }
 export type DeviceUpdateGetFileParameters = DeviceUpdateGetFileHeaderParam & RequestParameters;
 export interface DeviceUpdateListOperationStatusesQueryParamProperties {
@@ -63,7 +63,7 @@ export interface DeviceUpdateGetOperationStatusHeaders {
     "If-None-Match"?: string;
 }
 export interface DeviceUpdateGetOperationStatusHeaderParam {
-    headers: RawHttpHeadersInput & DeviceUpdateGetOperationStatusHeaders;
+    headers?: RawHttpHeadersInput & DeviceUpdateGetOperationStatusHeaders;
 }
 export type DeviceUpdateGetOperationStatusParameters = DeviceUpdateGetOperationStatusHeaderParam & RequestParameters;
 export interface DeviceManagementListDeviceClassesQueryParamProperties {
@@ -75,9 +75,11 @@ export interface DeviceManagementListDeviceClassesQueryParam {
 }
 export type DeviceManagementListDeviceClassesParameters = DeviceManagementListDeviceClassesQueryParam & RequestParameters;
 export type DeviceManagementGetDeviceClassParameters = RequestParameters;
+/** The device class json merge patch body. Currently only supports patching friendlyName. */
+export type PatchBodyResourceMergeAndPatch = Partial<PatchBody>;
 export interface DeviceManagementUpdateDeviceClassBodyParam {
     /** The device class json merge patch body. Currently only supports patching friendlyName. */
-    body: PatchBody;
+    body: PatchBodyResourceMergeAndPatch;
 }
 export interface DeviceManagementUpdateDeviceClassMediaTypesParam {
     /** Request content type */
@@ -176,7 +178,7 @@ export interface DeviceManagementGetOperationStatusHeaders {
     "If-None-Match"?: string;
 }
 export interface DeviceManagementGetOperationStatusHeaderParam {
-    headers: RawHttpHeadersInput & DeviceManagementGetOperationStatusHeaders;
+    headers?: RawHttpHeadersInput & DeviceManagementGetOperationStatusHeaders;
 }
 export type DeviceManagementGetOperationStatusParameters = DeviceManagementGetOperationStatusHeaderParam & RequestParameters;
 export interface DeviceManagementListOperationStatusesQueryParamProperties {

package/dist/esm/parameters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,KAAK,EAAE,qBAAqB,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE/F,MAAM,WAAW,2CAA2C;IAC1D,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iCAAiC;IAChD,eAAe,CAAC,EAAE,2CAA2C,CAAC;CAC/D;AAED,MAAM,MAAM,iCAAiC,GAAG,iCAAiC,GAC/E,iBAAiB,CAAC;AAEpB,MAAM,WAAW,iCAAiC;IAChD,mIAAmI;IACnI,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,uCAAuC;IACtD,2BAA2B;IAC3B,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,MAAM,kCAAkC,GAAG,uCAAuC,GACtF,iCAAiC,GACjC,iBAAiB,CAAC;AAEpB,MAAM,WAAW,4BAA4B;IAC3C,qIAAqI;IACrI,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,mBAAmB,GAAG,4BAA4B,CAAC;CAC7D;AAED,MAAM,MAAM,+BAA+B,GAAG,gCAAgC,GAAG,iBAAiB,CAAC;AACnG,MAAM,MAAM,kCAAkC,GAAG,iBAAiB,CAAC;AACnE,MAAM,MAAM,mCAAmC,GAAG,iBAAiB,CAAC;AACpE,MAAM,MAAM,+BAA+B,GAAG,iBAAiB,CAAC;AAEhE,MAAM,WAAW,4CAA4C;IAC3D,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kCAAkC;IACjD,eAAe,CAAC,EAAE,4CAA4C,CAAC;CAChE;AAED,MAAM,MAAM,kCAAkC,GAAG,kCAAkC,GACjF,iBAAiB,CAAC;AACpB,MAAM,MAAM,+BAA+B,GAAG,iBAAiB,CAAC;AAEhE,MAAM,WAAW,0BAA0B;IACzC,qIAAqI;IACrI,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,mBAAmB,GAAG,0BAA0B,CAAC;CAC3D;AAED,MAAM,MAAM,6BAA6B,GAAG,8BAA8B,GAAG,iBAAiB,CAAC;AAE/F,MAAM,WAAW,qDAAqD;IACpE,+IAA+I;IAC/I,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yMAAyM;IACzM,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,2CAA2C;IAC1D,eAAe,CAAC,EAAE,qDAAqD,CAAC;CACzE;AAED,MAAM,MAAM,2CAA2C,GACrD,2CAA2C,GAAG,iBAAiB,CAAC;AAElE,MAAM,WAAW,qCAAqC;IACpD,qIAAqI;IACrI,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,yCAAyC;IACxD,OAAO,EAAE,mBAAmB,GAAG,qCAAqC,CAAC;CACtE;AAED,MAAM,MAAM,wCAAwC,GAAG,yCAAyC,GAC9F,iBAAiB,CAAC;AAEpB,MAAM,WAAW,qDAAqD;IACpE,qFAAqF;IACrF,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2CAA2C;IAC1D,eAAe,CAAC,EAAE,qDAAqD,CAAC;CACzE;AAED,MAAM,MAAM,2CAA2C,GACrD,2CAA2C,GAAG,iBAAiB,CAAC;AAClE,MAAM,MAAM,wCAAwC,GAAG,iBAAiB,CAAC;AAEzE,MAAM,WAAW,0CAA0C;IACzD,6FAA6F;IAC7F,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,gDAAgD;IAC/D,2BAA2B;IAC3B,WAAW,CAAC,EAAE,8BAA8B,CAAC;CAC9C;AAED,MAAM,MAAM,2CAA2C,GACrD,gDAAgD,GAC9C,0CAA0C,GAC1C,iBAAiB,CAAC;AACtB,MAAM,MAAM,2CAA2C,GAAG,iBAAiB,CAAC;AAC5E,MAAM,MAAM,8DAA8D,GAAG,iBAAiB,CAAC;AAE/F,MAAM,WAAW,+CAA+C;IAC9D,wOAAwO;IACxO,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qCAAqC;IACpD,eAAe,CAAC,EAAE,+CAA+C,CAAC;CACnE;AAED,MAAM,MAAM,qCAAqC,GAAG,qCAAqC,GACvF,iBAAiB,CAAC;AAEpB,MAAM,WAAW,sCAAsC;IACrD,sCAAsC;IACtC,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,KAAK,CAAC;CACrC;AAED,MAAM,WAAW,4CAA4C;IAC3D,2BAA2B;IAC3B,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,MAAM,uCAAuC,GAAG,4CAA4C,GAChG,sCAAsC,GACtC,iBAAiB,CAAC;AACpB,MAAM,MAAM,mCAAmC,GAAG,iBAAiB,CAAC;AACpE,MAAM,MAAM,yCAAyC,GAAG,iBAAiB,CAAC;AAC1E,MAAM,MAAM,6CAA6C,GAAG,iBAAiB,CAAC;AAE9E,MAAM,WAAW,8CAA8C;IAC7D,0MAA0M;IAC1M,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oCAAoC;IACnD,eAAe,CAAC,EAAE,8CAA8C,CAAC;CAClE;AAED,MAAM,MAAM,oCAAoC,GAAG,oCAAoC,GACrF,iBAAiB,CAAC;AACpB,MAAM,MAAM,kCAAkC,GAAG,iBAAiB,CAAC;AACnE,MAAM,MAAM,qCAAqC,GAAG,iBAAiB,CAAC;AACtE,MAAM,MAAM,qDAAqD,GAAG,iBAAiB,CAAC;AACtF,MAAM,MAAM,iDAAiD,GAAG,iBAAiB,CAAC;AAElF,MAAM,WAAW,2DAA2D;IAC1E,2EAA2E;IAC3E,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iDAAiD;IAChE,eAAe,CAAC,EAAE,2DAA2D,CAAC;CAC/E;AAED,MAAM,MAAM,iDAAiD,GAC3D,iDAAiD,GAAG,iBAAiB,CAAC;AACxE,MAAM,MAAM,uCAAuC,GAAG,iBAAiB,CAAC;AAExE,MAAM,WAAW,iDAAiD;IAChE,iCAAiC;IACjC,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,uDAAuD;IACtE,2BAA2B;IAC3B,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,MAAM,kDAAkD,GAC5D,uDAAuD,GACrD,iDAAiD,GACjD,iBAAiB,CAAC;AACtB,MAAM,MAAM,0CAA0C,GAAG,iBAAiB,CAAC;AAC3E,MAAM,MAAM,6CAA6C,GAAG,iBAAiB,CAAC;AAE9E,MAAM,WAAW,oEAAoE;IACnF,2NAA2N;IAC3N,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0DAA0D;IACzE,eAAe,CAAC,EAAE,oEAAoE,CAAC;CACxF;AAED,MAAM,MAAM,0DAA0D,GACpE,0DAA0D,GAAG,iBAAiB,CAAC;AACjF,MAAM,MAAM,gDAAgD,GAAG,iBAAiB,CAAC;AACjF,MAAM,MAAM,mDAAmD,GAAG,iBAAiB,CAAC;AACpF,MAAM,MAAM,gEAAgE,GAAG,iBAAiB,CAAC;AACjG,MAAM,MAAM,8DAA8D,GAAG,iBAAiB,CAAC;AAE/F,MAAM,WAAW,yEAAyE;IACxF,2EAA2E;IAC3E,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,+DAA+D;IAC9E,eAAe,CAAC,EAAE,yEAAyE,CAAC;CAC7F;AAED,MAAM,MAAM,+DAA+D,GACzE,+DAA+D,GAAG,iBAAiB,CAAC;AACtF,MAAM,MAAM,6DAA6D,GAAG,iBAAiB,CAAC;AAC9F,MAAM,MAAM,gEAAgE,GAAG,iBAAiB,CAAC;AACjG,MAAM,MAAM,wCAAwC,GAAG,iBAAiB,CAAC;AACzE,MAAM,MAAM,yCAAyC,GAAG,iBAAiB,CAAC;AAC1E,MAAM,MAAM,gEAAgE,GAAG,iBAAiB,CAAC;AAEjG,MAAM,WAAW,oFAAoF;IACnG,0HAA0H;IAC1H,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0EAA0E;IACzF,eAAe,CAAC,EAAE,oFAAoF,CAAC;CACxG;AAED,MAAM,MAAM,0EAA0E,GACpF,0EAA0E,GAAG,iBAAiB,CAAC;AAEjG,MAAM,WAAW,yCAAyC;IACxD,qIAAqI;IACrI,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,6CAA6C;IAC5D,OAAO,EAAE,mBAAmB,GAAG,yCAAyC,CAAC;CAC1E;AAED,MAAM,MAAM,4CAA4C,GACtD,6CAA6C,GAAG,iBAAiB,CAAC;AAEpE,MAAM,WAAW,yDAAyD;IACxE,uIAAuI;IACvI,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yMAAyM;IACzM,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,+CAA+C;IAC9D,eAAe,CAAC,EAAE,yDAAyD,CAAC;CAC7E;AAED,MAAM,MAAM,+CAA+C,GACzD,+CAA+C,GAAG,iBAAiB,CAAC;AAEtE,MAAM,WAAW,2CAA2C;IAC1D,qCAAqC;IACrC,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,iDAAiD;IAChE,2BAA2B;IAC3B,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,MAAM,4CAA4C,GACtD,iDAAiD,GAC/C,2CAA2C,GAC3C,iBAAiB,CAAC;AACtB,MAAM,MAAM,0CAA0C,GAAG,iBAAiB,CAAC;AAC3E,MAAM,MAAM,4CAA4C,GAAG,iBAAiB,CAAC;AAC7E,MAAM,MAAM,wDAAwD,GAAG,iBAAiB,CAAC;AAEzF,MAAM,WAAW,uDAAuD;IACtE,2HAA2H;IAC3H,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6CAA6C;IAC5D,eAAe,EAAE,uDAAuD,CAAC;CAC1E;AAED,MAAM,MAAM,6CAA6C,GACvD,6CAA6C,GAAG,iBAAiB,CAAC"}
+{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,KAAK,EAAE,qBAAqB,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE/F,MAAM,WAAW,2CAA2C;IAC1D,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iCAAiC;IAChD,eAAe,CAAC,EAAE,2CAA2C,CAAC;CAC/D;AAED,MAAM,MAAM,iCAAiC,GAAG,iCAAiC,GAC/E,iBAAiB,CAAC;AAEpB,MAAM,WAAW,iCAAiC;IAChD,mIAAmI;IACnI,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,uCAAuC;IACtD,2BAA2B;IAC3B,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,MAAM,kCAAkC,GAAG,uCAAuC,GACtF,iCAAiC,GACjC,iBAAiB,CAAC;AAEpB,MAAM,WAAW,4BAA4B;IAC3C,qIAAqI;IACrI,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,gCAAgC;IAC/C,OAAO,CAAC,EAAE,mBAAmB,GAAG,4BAA4B,CAAC;CAC9D;AAED,MAAM,MAAM,+BAA+B,GAAG,gCAAgC,GAAG,iBAAiB,CAAC;AACnG,MAAM,MAAM,kCAAkC,GAAG,iBAAiB,CAAC;AACnE,MAAM,MAAM,mCAAmC,GAAG,iBAAiB,CAAC;AACpE,MAAM,MAAM,+BAA+B,GAAG,iBAAiB,CAAC;AAEhE,MAAM,WAAW,4CAA4C;IAC3D,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kCAAkC;IACjD,eAAe,CAAC,EAAE,4CAA4C,CAAC;CAChE;AAED,MAAM,MAAM,kCAAkC,GAAG,kCAAkC,GACjF,iBAAiB,CAAC;AACpB,MAAM,MAAM,+BAA+B,GAAG,iBAAiB,CAAC;AAEhE,MAAM,WAAW,0BAA0B;IACzC,qIAAqI;IACrI,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,CAAC,EAAE,mBAAmB,GAAG,0BAA0B,CAAC;CAC5D;AAED,MAAM,MAAM,6BAA6B,GAAG,8BAA8B,GAAG,iBAAiB,CAAC;AAE/F,MAAM,WAAW,qDAAqD;IACpE,+IAA+I;IAC/I,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yMAAyM;IACzM,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,2CAA2C;IAC1D,eAAe,CAAC,EAAE,qDAAqD,CAAC;CACzE;AAED,MAAM,MAAM,2CAA2C,GACrD,2CAA2C,GAAG,iBAAiB,CAAC;AAElE,MAAM,WAAW,qCAAqC;IACpD,qIAAqI;IACrI,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,yCAAyC;IACxD,OAAO,CAAC,EAAE,mBAAmB,GAAG,qCAAqC,CAAC;CACvE;AAED,MAAM,MAAM,wCAAwC,GAAG,yCAAyC,GAC9F,iBAAiB,CAAC;AAEpB,MAAM,WAAW,qDAAqD;IACpE,qFAAqF;IACrF,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2CAA2C;IAC1D,eAAe,CAAC,EAAE,qDAAqD,CAAC;CACzE;AAED,MAAM,MAAM,2CAA2C,GACrD,2CAA2C,GAAG,iBAAiB,CAAC;AAClE,MAAM,MAAM,wCAAwC,GAAG,iBAAiB,CAAC;AACzE,6FAA6F;AAC7F,MAAM,MAAM,8BAA8B,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AAEhE,MAAM,WAAW,0CAA0C;IACzD,6FAA6F;IAC7F,IAAI,EAAE,8BAA8B,CAAC;CACtC;AAED,MAAM,WAAW,gDAAgD;IAC/D,2BAA2B;IAC3B,WAAW,CAAC,EAAE,8BAA8B,CAAC;CAC9C;AAED,MAAM,MAAM,2CAA2C,GACrD,gDAAgD,GAC9C,0CAA0C,GAC1C,iBAAiB,CAAC;AACtB,MAAM,MAAM,2CAA2C,GAAG,iBAAiB,CAAC;AAC5E,MAAM,MAAM,8DAA8D,GAAG,iBAAiB,CAAC;AAE/F,MAAM,WAAW,+CAA+C;IAC9D,wOAAwO;IACxO,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qCAAqC;IACpD,eAAe,CAAC,EAAE,+CAA+C,CAAC;CACnE;AAED,MAAM,MAAM,qCAAqC,GAAG,qCAAqC,GACvF,iBAAiB,CAAC;AAEpB,MAAM,WAAW,sCAAsC;IACrD,sCAAsC;IACtC,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,KAAK,CAAC;CACrC;AAED,MAAM,WAAW,4CAA4C;IAC3D,2BAA2B;IAC3B,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,MAAM,uCAAuC,GAAG,4CAA4C,GAChG,sCAAsC,GACtC,iBAAiB,CAAC;AACpB,MAAM,MAAM,mCAAmC,GAAG,iBAAiB,CAAC;AACpE,MAAM,MAAM,yCAAyC,GAAG,iBAAiB,CAAC;AAC1E,MAAM,MAAM,6CAA6C,GAAG,iBAAiB,CAAC;AAE9E,MAAM,WAAW,8CAA8C;IAC7D,0MAA0M;IAC1M,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oCAAoC;IACnD,eAAe,CAAC,EAAE,8CAA8C,CAAC;CAClE;AAED,MAAM,MAAM,oCAAoC,GAAG,oCAAoC,GACrF,iBAAiB,CAAC;AACpB,MAAM,MAAM,kCAAkC,GAAG,iBAAiB,CAAC;AACnE,MAAM,MAAM,qCAAqC,GAAG,iBAAiB,CAAC;AACtE,MAAM,MAAM,qDAAqD,GAAG,iBAAiB,CAAC;AACtF,MAAM,MAAM,iDAAiD,GAAG,iBAAiB,CAAC;AAElF,MAAM,WAAW,2DAA2D;IAC1E,2EAA2E;IAC3E,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iDAAiD;IAChE,eAAe,CAAC,EAAE,2DAA2D,CAAC;CAC/E;AAED,MAAM,MAAM,iDAAiD,GAC3D,iDAAiD,GAAG,iBAAiB,CAAC;AACxE,MAAM,MAAM,uCAAuC,GAAG,iBAAiB,CAAC;AAExE,MAAM,WAAW,iDAAiD;IAChE,iCAAiC;IACjC,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,uDAAuD;IACtE,2BAA2B;IAC3B,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,MAAM,kDAAkD,GAC5D,uDAAuD,GACrD,iDAAiD,GACjD,iBAAiB,CAAC;AACtB,MAAM,MAAM,0CAA0C,GAAG,iBAAiB,CAAC;AAC3E,MAAM,MAAM,6CAA6C,GAAG,iBAAiB,CAAC;AAE9E,MAAM,WAAW,oEAAoE;IACnF,2NAA2N;IAC3N,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0DAA0D;IACzE,eAAe,CAAC,EAAE,oEAAoE,CAAC;CACxF;AAED,MAAM,MAAM,0DAA0D,GACpE,0DAA0D,GAAG,iBAAiB,CAAC;AACjF,MAAM,MAAM,gDAAgD,GAAG,iBAAiB,CAAC;AACjF,MAAM,MAAM,mDAAmD,GAAG,iBAAiB,CAAC;AACpF,MAAM,MAAM,gEAAgE,GAAG,iBAAiB,CAAC;AACjG,MAAM,MAAM,8DAA8D,GAAG,iBAAiB,CAAC;AAE/F,MAAM,WAAW,yEAAyE;IACxF,2EAA2E;IAC3E,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,+DAA+D;IAC9E,eAAe,CAAC,EAAE,yEAAyE,CAAC;CAC7F;AAED,MAAM,MAAM,+DAA+D,GACzE,+DAA+D,GAAG,iBAAiB,CAAC;AACtF,MAAM,MAAM,6DAA6D,GAAG,iBAAiB,CAAC;AAC9F,MAAM,MAAM,gEAAgE,GAAG,iBAAiB,CAAC;AACjG,MAAM,MAAM,wCAAwC,GAAG,iBAAiB,CAAC;AACzE,MAAM,MAAM,yCAAyC,GAAG,iBAAiB,CAAC;AAC1E,MAAM,MAAM,gEAAgE,GAAG,iBAAiB,CAAC;AAEjG,MAAM,WAAW,oFAAoF;IACnG,0HAA0H;IAC1H,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0EAA0E;IACzF,eAAe,CAAC,EAAE,oFAAoF,CAAC;CACxG;AAED,MAAM,MAAM,0EAA0E,GACpF,0EAA0E,GAAG,iBAAiB,CAAC;AAEjG,MAAM,WAAW,yCAAyC;IACxD,qIAAqI;IACrI,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,6CAA6C;IAC5D,OAAO,CAAC,EAAE,mBAAmB,GAAG,yCAAyC,CAAC;CAC3E;AAED,MAAM,MAAM,4CAA4C,GACtD,6CAA6C,GAAG,iBAAiB,CAAC;AAEpE,MAAM,WAAW,yDAAyD;IACxE,uIAAuI;IACvI,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yMAAyM;IACzM,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,+CAA+C;IAC9D,eAAe,CAAC,EAAE,yDAAyD,CAAC;CAC7E;AAED,MAAM,MAAM,+CAA+C,GACzD,+CAA+C,GAAG,iBAAiB,CAAC;AAEtE,MAAM,WAAW,2CAA2C;IAC1D,qCAAqC;IACrC,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,iDAAiD;IAChE,2BAA2B;IAC3B,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,MAAM,4CAA4C,GACtD,iDAAiD,GAC/C,2CAA2C,GAC3C,iBAAiB,CAAC;AACtB,MAAM,MAAM,0CAA0C,GAAG,iBAAiB,CAAC;AAC3E,MAAM,MAAM,4CAA4C,GAAG,iBAAiB,CAAC;AAC7E,MAAM,MAAM,wDAAwD,GAAG,iBAAiB,CAAC;AAEzF,MAAM,WAAW,uDAAuD;IACtE,2HAA2H;IAC3H,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6CAA6C;IAC5D,eAAe,EAAE,uDAAuD,CAAC;CAC1E;AAED,MAAM,MAAM,6CAA6C,GACvD,6CAA6C,GAAG,iBAAiB,CAAC"}

package/dist/esm/parameters.js.map

@@ -1 +1 @@
-{"version":3,"file":"parameters.js","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { RawHttpHeadersInput } from \"@azure/core-rest-pipeline\";\nimport type { RequestParameters } from \"@azure-rest/core-client\";\nimport type { ImportUpdateInputItem, PatchBody, Deployment, LogCollection } from \"./models.js\";\n\nexport interface DeviceUpdateListUpdatesQueryParamProperties {\n  /** Request updates matching a free-text search expression. */\n  search?: string;\n  /** Optional to filter updates by isDeployable property. */\n  filter?: string;\n}\n\nexport interface DeviceUpdateListUpdatesQueryParam {\n  queryParameters?: DeviceUpdateListUpdatesQueryParamProperties;\n}\n\nexport type DeviceUpdateListUpdatesParameters = DeviceUpdateListUpdatesQueryParam &\n  RequestParameters;\n\nexport interface DeviceUpdateImportUpdateBodyParam {\n  /** The update to be imported (see schema https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json for details). */\n  body: Array<ImportUpdateInputItem>;\n}\n\nexport interface DeviceUpdateImportUpdateMediaTypesParam {\n  /** Request content type */\n  contentType?: \"application/json\";\n}\n\nexport type DeviceUpdateImportUpdateParameters = DeviceUpdateImportUpdateMediaTypesParam &\n  DeviceUpdateImportUpdateBodyParam &\n  RequestParameters;\n\nexport interface DeviceUpdateGetUpdateHeaders {\n  /** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */\n  \"If-None-Match\"?: string;\n}\n\nexport interface DeviceUpdateGetUpdateHeaderParam {\n  headers: RawHttpHeadersInput & DeviceUpdateGetUpdateHeaders;\n}\n\nexport type DeviceUpdateGetUpdateParameters = DeviceUpdateGetUpdateHeaderParam & RequestParameters;\nexport type DeviceUpdateDeleteUpdateParameters = RequestParameters;\nexport type DeviceUpdateListProvidersParameters = RequestParameters;\nexport type DeviceUpdateListNamesParameters = RequestParameters;\n\nexport interface DeviceUpdateListVersionsQueryParamProperties {\n  /** Optional to filter updates by isDeployable property. */\n  filter?: string;\n}\n\nexport interface DeviceUpdateListVersionsQueryParam {\n  queryParameters?: DeviceUpdateListVersionsQueryParamProperties;\n}\n\nexport type DeviceUpdateListVersionsParameters = DeviceUpdateListVersionsQueryParam &\n  RequestParameters;\nexport type DeviceUpdateListFilesParameters = RequestParameters;\n\nexport interface DeviceUpdateGetFileHeaders {\n  /** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */\n  \"If-None-Match\"?: string;\n}\n\nexport interface DeviceUpdateGetFileHeaderParam {\n  headers: RawHttpHeadersInput & DeviceUpdateGetFileHeaders;\n}\n\nexport type DeviceUpdateGetFileParameters = DeviceUpdateGetFileHeaderParam & RequestParameters;\n\nexport interface DeviceUpdateListOperationStatusesQueryParamProperties {\n  /** Optional to filter operations by status property. Only one specific filter is supported: \"status eq 'NotStarted' or status eq 'Running'\" */\n  filter?: string;\n  /** Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. */\n  top?: number;\n}\n\nexport interface DeviceUpdateListOperationStatusesQueryParam {\n  queryParameters?: DeviceUpdateListOperationStatusesQueryParamProperties;\n}\n\nexport type DeviceUpdateListOperationStatusesParameters =\n  DeviceUpdateListOperationStatusesQueryParam & RequestParameters;\n\nexport interface DeviceUpdateGetOperationStatusHeaders {\n  /** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */\n  \"If-None-Match\"?: string;\n}\n\nexport interface DeviceUpdateGetOperationStatusHeaderParam {\n  headers: RawHttpHeadersInput & DeviceUpdateGetOperationStatusHeaders;\n}\n\nexport type DeviceUpdateGetOperationStatusParameters = DeviceUpdateGetOperationStatusHeaderParam &\n  RequestParameters;\n\nexport interface DeviceManagementListDeviceClassesQueryParamProperties {\n  /** Restricts the set of device classes returned. You can filter on friendly name. */\n  filter?: string;\n}\n\nexport interface DeviceManagementListDeviceClassesQueryParam {\n  queryParameters?: DeviceManagementListDeviceClassesQueryParamProperties;\n}\n\nexport type DeviceManagementListDeviceClassesParameters =\n  DeviceManagementListDeviceClassesQueryParam & RequestParameters;\nexport type DeviceManagementGetDeviceClassParameters = RequestParameters;\n\nexport interface DeviceManagementUpdateDeviceClassBodyParam {\n  /** The device class json merge patch body. Currently only supports patching friendlyName. */\n  body: PatchBody;\n}\n\nexport interface DeviceManagementUpdateDeviceClassMediaTypesParam {\n  /** Request content type */\n  contentType?: \"application/merge-patch+json\";\n}\n\nexport type DeviceManagementUpdateDeviceClassParameters =\n  DeviceManagementUpdateDeviceClassMediaTypesParam &\n    DeviceManagementUpdateDeviceClassBodyParam &\n    RequestParameters;\nexport type DeviceManagementDeleteDeviceClassParameters = RequestParameters;\nexport type DeviceManagementListInstallableUpdatesForDeviceClassParameters = RequestParameters;\n\nexport interface DeviceManagementListDevicesQueryParamProperties {\n  /** Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. Use DeploymentStatus eq null to query for devices with no deployment status (that have never been deployed to). */\n  filter?: string;\n}\n\nexport interface DeviceManagementListDevicesQueryParam {\n  queryParameters?: DeviceManagementListDevicesQueryParamProperties;\n}\n\nexport type DeviceManagementListDevicesParameters = DeviceManagementListDevicesQueryParam &\n  RequestParameters;\n\nexport interface DeviceManagementImportDevicesBodyParam {\n  /** The types of devices to import. */\n  body: \"Devices\" | \"Modules\" | \"All\";\n}\n\nexport interface DeviceManagementImportDevicesMediaTypesParam {\n  /** Request content type */\n  contentType?: \"application/json\";\n}\n\nexport type DeviceManagementImportDevicesParameters = DeviceManagementImportDevicesMediaTypesParam &\n  DeviceManagementImportDevicesBodyParam &\n  RequestParameters;\nexport type DeviceManagementGetDeviceParameters = RequestParameters;\nexport type DeviceManagementGetDeviceModuleParameters = RequestParameters;\nexport type DeviceManagementGetUpdateComplianceParameters = RequestParameters;\n\nexport interface DeviceManagementListGroupsQueryParamProperties {\n  /** Orders the set of groups returned. You can order by groupId, deviceCount, createdDate, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. */\n  orderby?: string;\n}\n\nexport interface DeviceManagementListGroupsQueryParam {\n  queryParameters?: DeviceManagementListGroupsQueryParamProperties;\n}\n\nexport type DeviceManagementListGroupsParameters = DeviceManagementListGroupsQueryParam &\n  RequestParameters;\nexport type DeviceManagementGetGroupParameters = RequestParameters;\nexport type DeviceManagementDeleteGroupParameters = RequestParameters;\nexport type DeviceManagementGetUpdateComplianceForGroupParameters = RequestParameters;\nexport type DeviceManagementListBestUpdatesForGroupParameters = RequestParameters;\n\nexport interface DeviceManagementListDeploymentsForGroupQueryParamProperties {\n  /** Orders the set of deployments returned. You can order by start date. */\n  orderby?: string;\n}\n\nexport interface DeviceManagementListDeploymentsForGroupQueryParam {\n  queryParameters?: DeviceManagementListDeploymentsForGroupQueryParamProperties;\n}\n\nexport type DeviceManagementListDeploymentsForGroupParameters =\n  DeviceManagementListDeploymentsForGroupQueryParam & RequestParameters;\nexport type DeviceManagementGetDeploymentParameters = RequestParameters;\n\nexport interface DeviceManagementCreateOrUpdateDeploymentBodyParam {\n  /** The deployment properties. */\n  body: Deployment;\n}\n\nexport interface DeviceManagementCreateOrUpdateDeploymentMediaTypesParam {\n  /** Request content type */\n  contentType?: \"application/json\";\n}\n\nexport type DeviceManagementCreateOrUpdateDeploymentParameters =\n  DeviceManagementCreateOrUpdateDeploymentMediaTypesParam &\n    DeviceManagementCreateOrUpdateDeploymentBodyParam &\n    RequestParameters;\nexport type DeviceManagementDeleteDeploymentParameters = RequestParameters;\nexport type DeviceManagementGetDeploymentStatusParameters = RequestParameters;\n\nexport interface DeviceManagementListDeviceClassSubgroupsForGroupQueryParamProperties {\n  /** Restricts the set of device class subgroups returned. You can filter on compat properties by name and value. (i.e. filter=compatProperties/propertyName1 eq 'value1' and compatProperties/propertyName2 eq 'value2') */\n  filter?: string;\n}\n\nexport interface DeviceManagementListDeviceClassSubgroupsForGroupQueryParam {\n  queryParameters?: DeviceManagementListDeviceClassSubgroupsForGroupQueryParamProperties;\n}\n\nexport type DeviceManagementListDeviceClassSubgroupsForGroupParameters =\n  DeviceManagementListDeviceClassSubgroupsForGroupQueryParam & RequestParameters;\nexport type DeviceManagementGetDeviceClassSubgroupParameters = RequestParameters;\nexport type DeviceManagementDeleteDeviceClassSubgroupParameters = RequestParameters;\nexport type DeviceManagementGetDeviceClassSubgroupUpdateComplianceParameters = RequestParameters;\nexport type DeviceManagementGetBestUpdatesForDeviceClassSubgroupParameters = RequestParameters;\n\nexport interface DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParamProperties {\n  /** Orders the set of deployments returned. You can order by start date. */\n  orderby?: string;\n}\n\nexport interface DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParam {\n  queryParameters?: DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParamProperties;\n}\n\nexport type DeviceManagementListDeploymentsForDeviceClassSubgroupParameters =\n  DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParam & RequestParameters;\nexport type DeviceManagementGetDeploymentForDeviceClassSubgroupParameters = RequestParameters;\nexport type DeviceManagementDeleteDeploymentForDeviceClassSubgroupParameters = RequestParameters;\nexport type DeviceManagementStopDeploymentParameters = RequestParameters;\nexport type DeviceManagementRetryDeploymentParameters = RequestParameters;\nexport type DeviceManagementGetDeviceClassSubgroupDeploymentStatusParameters = RequestParameters;\n\nexport interface DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParamProperties {\n  /** Restricts the set of deployment device states returned. You can filter on deviceId and moduleId and/or deviceState. */\n  filter?: string;\n}\n\nexport interface DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParam {\n  queryParameters?: DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParamProperties;\n}\n\nexport type DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentParameters =\n  DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParam & RequestParameters;\n\nexport interface DeviceManagementGetOperationStatusHeaders {\n  /** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */\n  \"If-None-Match\"?: string;\n}\n\nexport interface DeviceManagementGetOperationStatusHeaderParam {\n  headers: RawHttpHeadersInput & DeviceManagementGetOperationStatusHeaders;\n}\n\nexport type DeviceManagementGetOperationStatusParameters =\n  DeviceManagementGetOperationStatusHeaderParam & RequestParameters;\n\nexport interface DeviceManagementListOperationStatusesQueryParamProperties {\n  /** Restricts the set of operations returned. Only one specific filter is supported: \"status eq 'NotStarted' or status eq 'Running'\" */\n  filter?: string;\n  /** Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. */\n  top?: number;\n}\n\nexport interface DeviceManagementListOperationStatusesQueryParam {\n  queryParameters?: DeviceManagementListOperationStatusesQueryParamProperties;\n}\n\nexport type DeviceManagementListOperationStatusesParameters =\n  DeviceManagementListOperationStatusesQueryParam & RequestParameters;\n\nexport interface DeviceManagementStartLogCollectionBodyParam {\n  /** The log collection properties. */\n  body: LogCollection;\n}\n\nexport interface DeviceManagementStartLogCollectionMediaTypesParam {\n  /** Request content type */\n  contentType?: \"application/json\";\n}\n\nexport type DeviceManagementStartLogCollectionParameters =\n  DeviceManagementStartLogCollectionMediaTypesParam &\n    DeviceManagementStartLogCollectionBodyParam &\n    RequestParameters;\nexport type DeviceManagementGetLogCollectionParameters = RequestParameters;\nexport type DeviceManagementListLogCollectionsParameters = RequestParameters;\nexport type DeviceManagementGetLogCollectionDetailedStatusParameters = RequestParameters;\n\nexport interface DeviceManagementListHealthOfDevicesQueryParamProperties {\n  /** Restricts the set of devices for which device health is returned. You can filter on status, device id and module id. */\n  filter: string;\n}\n\nexport interface DeviceManagementListHealthOfDevicesQueryParam {\n  queryParameters: DeviceManagementListHealthOfDevicesQueryParamProperties;\n}\n\nexport type DeviceManagementListHealthOfDevicesParameters =\n  DeviceManagementListHealthOfDevicesQueryParam & RequestParameters;\n"]}
+{"version":3,"file":"parameters.js","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { RawHttpHeadersInput } from \"@azure/core-rest-pipeline\";\nimport type { RequestParameters } from \"@azure-rest/core-client\";\nimport type { ImportUpdateInputItem, PatchBody, Deployment, LogCollection } from \"./models.js\";\n\nexport interface DeviceUpdateListUpdatesQueryParamProperties {\n  /** Request updates matching a free-text search expression. */\n  search?: string;\n  /** Optional to filter updates by isDeployable property. */\n  filter?: string;\n}\n\nexport interface DeviceUpdateListUpdatesQueryParam {\n  queryParameters?: DeviceUpdateListUpdatesQueryParamProperties;\n}\n\nexport type DeviceUpdateListUpdatesParameters = DeviceUpdateListUpdatesQueryParam &\n  RequestParameters;\n\nexport interface DeviceUpdateImportUpdateBodyParam {\n  /** The update to be imported (see schema https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json for details). */\n  body: Array<ImportUpdateInputItem>;\n}\n\nexport interface DeviceUpdateImportUpdateMediaTypesParam {\n  /** Request content type */\n  contentType?: \"application/json\";\n}\n\nexport type DeviceUpdateImportUpdateParameters = DeviceUpdateImportUpdateMediaTypesParam &\n  DeviceUpdateImportUpdateBodyParam &\n  RequestParameters;\n\nexport interface DeviceUpdateGetUpdateHeaders {\n  /** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */\n  \"If-None-Match\"?: string;\n}\n\nexport interface DeviceUpdateGetUpdateHeaderParam {\n  headers?: RawHttpHeadersInput & DeviceUpdateGetUpdateHeaders;\n}\n\nexport type DeviceUpdateGetUpdateParameters = DeviceUpdateGetUpdateHeaderParam & RequestParameters;\nexport type DeviceUpdateDeleteUpdateParameters = RequestParameters;\nexport type DeviceUpdateListProvidersParameters = RequestParameters;\nexport type DeviceUpdateListNamesParameters = RequestParameters;\n\nexport interface DeviceUpdateListVersionsQueryParamProperties {\n  /** Optional to filter updates by isDeployable property. */\n  filter?: string;\n}\n\nexport interface DeviceUpdateListVersionsQueryParam {\n  queryParameters?: DeviceUpdateListVersionsQueryParamProperties;\n}\n\nexport type DeviceUpdateListVersionsParameters = DeviceUpdateListVersionsQueryParam &\n  RequestParameters;\nexport type DeviceUpdateListFilesParameters = RequestParameters;\n\nexport interface DeviceUpdateGetFileHeaders {\n  /** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */\n  \"If-None-Match\"?: string;\n}\n\nexport interface DeviceUpdateGetFileHeaderParam {\n  headers?: RawHttpHeadersInput & DeviceUpdateGetFileHeaders;\n}\n\nexport type DeviceUpdateGetFileParameters = DeviceUpdateGetFileHeaderParam & RequestParameters;\n\nexport interface DeviceUpdateListOperationStatusesQueryParamProperties {\n  /** Optional to filter operations by status property. Only one specific filter is supported: \"status eq 'NotStarted' or status eq 'Running'\" */\n  filter?: string;\n  /** Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. */\n  top?: number;\n}\n\nexport interface DeviceUpdateListOperationStatusesQueryParam {\n  queryParameters?: DeviceUpdateListOperationStatusesQueryParamProperties;\n}\n\nexport type DeviceUpdateListOperationStatusesParameters =\n  DeviceUpdateListOperationStatusesQueryParam & RequestParameters;\n\nexport interface DeviceUpdateGetOperationStatusHeaders {\n  /** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */\n  \"If-None-Match\"?: string;\n}\n\nexport interface DeviceUpdateGetOperationStatusHeaderParam {\n  headers?: RawHttpHeadersInput & DeviceUpdateGetOperationStatusHeaders;\n}\n\nexport type DeviceUpdateGetOperationStatusParameters = DeviceUpdateGetOperationStatusHeaderParam &\n  RequestParameters;\n\nexport interface DeviceManagementListDeviceClassesQueryParamProperties {\n  /** Restricts the set of device classes returned. You can filter on friendly name. */\n  filter?: string;\n}\n\nexport interface DeviceManagementListDeviceClassesQueryParam {\n  queryParameters?: DeviceManagementListDeviceClassesQueryParamProperties;\n}\n\nexport type DeviceManagementListDeviceClassesParameters =\n  DeviceManagementListDeviceClassesQueryParam & RequestParameters;\nexport type DeviceManagementGetDeviceClassParameters = RequestParameters;\n/** The device class json merge patch body. Currently only supports patching friendlyName. */\nexport type PatchBodyResourceMergeAndPatch = Partial<PatchBody>;\n\nexport interface DeviceManagementUpdateDeviceClassBodyParam {\n  /** The device class json merge patch body. Currently only supports patching friendlyName. */\n  body: PatchBodyResourceMergeAndPatch;\n}\n\nexport interface DeviceManagementUpdateDeviceClassMediaTypesParam {\n  /** Request content type */\n  contentType?: \"application/merge-patch+json\";\n}\n\nexport type DeviceManagementUpdateDeviceClassParameters =\n  DeviceManagementUpdateDeviceClassMediaTypesParam &\n    DeviceManagementUpdateDeviceClassBodyParam &\n    RequestParameters;\nexport type DeviceManagementDeleteDeviceClassParameters = RequestParameters;\nexport type DeviceManagementListInstallableUpdatesForDeviceClassParameters = RequestParameters;\n\nexport interface DeviceManagementListDevicesQueryParamProperties {\n  /** Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. Use DeploymentStatus eq null to query for devices with no deployment status (that have never been deployed to). */\n  filter?: string;\n}\n\nexport interface DeviceManagementListDevicesQueryParam {\n  queryParameters?: DeviceManagementListDevicesQueryParamProperties;\n}\n\nexport type DeviceManagementListDevicesParameters = DeviceManagementListDevicesQueryParam &\n  RequestParameters;\n\nexport interface DeviceManagementImportDevicesBodyParam {\n  /** The types of devices to import. */\n  body: \"Devices\" | \"Modules\" | \"All\";\n}\n\nexport interface DeviceManagementImportDevicesMediaTypesParam {\n  /** Request content type */\n  contentType?: \"application/json\";\n}\n\nexport type DeviceManagementImportDevicesParameters = DeviceManagementImportDevicesMediaTypesParam &\n  DeviceManagementImportDevicesBodyParam &\n  RequestParameters;\nexport type DeviceManagementGetDeviceParameters = RequestParameters;\nexport type DeviceManagementGetDeviceModuleParameters = RequestParameters;\nexport type DeviceManagementGetUpdateComplianceParameters = RequestParameters;\n\nexport interface DeviceManagementListGroupsQueryParamProperties {\n  /** Orders the set of groups returned. You can order by groupId, deviceCount, createdDate, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. */\n  orderby?: string;\n}\n\nexport interface DeviceManagementListGroupsQueryParam {\n  queryParameters?: DeviceManagementListGroupsQueryParamProperties;\n}\n\nexport type DeviceManagementListGroupsParameters = DeviceManagementListGroupsQueryParam &\n  RequestParameters;\nexport type DeviceManagementGetGroupParameters = RequestParameters;\nexport type DeviceManagementDeleteGroupParameters = RequestParameters;\nexport type DeviceManagementGetUpdateComplianceForGroupParameters = RequestParameters;\nexport type DeviceManagementListBestUpdatesForGroupParameters = RequestParameters;\n\nexport interface DeviceManagementListDeploymentsForGroupQueryParamProperties {\n  /** Orders the set of deployments returned. You can order by start date. */\n  orderby?: string;\n}\n\nexport interface DeviceManagementListDeploymentsForGroupQueryParam {\n  queryParameters?: DeviceManagementListDeploymentsForGroupQueryParamProperties;\n}\n\nexport type DeviceManagementListDeploymentsForGroupParameters =\n  DeviceManagementListDeploymentsForGroupQueryParam & RequestParameters;\nexport type DeviceManagementGetDeploymentParameters = RequestParameters;\n\nexport interface DeviceManagementCreateOrUpdateDeploymentBodyParam {\n  /** The deployment properties. */\n  body: Deployment;\n}\n\nexport interface DeviceManagementCreateOrUpdateDeploymentMediaTypesParam {\n  /** Request content type */\n  contentType?: \"application/json\";\n}\n\nexport type DeviceManagementCreateOrUpdateDeploymentParameters =\n  DeviceManagementCreateOrUpdateDeploymentMediaTypesParam &\n    DeviceManagementCreateOrUpdateDeploymentBodyParam &\n    RequestParameters;\nexport type DeviceManagementDeleteDeploymentParameters = RequestParameters;\nexport type DeviceManagementGetDeploymentStatusParameters = RequestParameters;\n\nexport interface DeviceManagementListDeviceClassSubgroupsForGroupQueryParamProperties {\n  /** Restricts the set of device class subgroups returned. You can filter on compat properties by name and value. (i.e. filter=compatProperties/propertyName1 eq 'value1' and compatProperties/propertyName2 eq 'value2') */\n  filter?: string;\n}\n\nexport interface DeviceManagementListDeviceClassSubgroupsForGroupQueryParam {\n  queryParameters?: DeviceManagementListDeviceClassSubgroupsForGroupQueryParamProperties;\n}\n\nexport type DeviceManagementListDeviceClassSubgroupsForGroupParameters =\n  DeviceManagementListDeviceClassSubgroupsForGroupQueryParam & RequestParameters;\nexport type DeviceManagementGetDeviceClassSubgroupParameters = RequestParameters;\nexport type DeviceManagementDeleteDeviceClassSubgroupParameters = RequestParameters;\nexport type DeviceManagementGetDeviceClassSubgroupUpdateComplianceParameters = RequestParameters;\nexport type DeviceManagementGetBestUpdatesForDeviceClassSubgroupParameters = RequestParameters;\n\nexport interface DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParamProperties {\n  /** Orders the set of deployments returned. You can order by start date. */\n  orderby?: string;\n}\n\nexport interface DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParam {\n  queryParameters?: DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParamProperties;\n}\n\nexport type DeviceManagementListDeploymentsForDeviceClassSubgroupParameters =\n  DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParam & RequestParameters;\nexport type DeviceManagementGetDeploymentForDeviceClassSubgroupParameters = RequestParameters;\nexport type DeviceManagementDeleteDeploymentForDeviceClassSubgroupParameters = RequestParameters;\nexport type DeviceManagementStopDeploymentParameters = RequestParameters;\nexport type DeviceManagementRetryDeploymentParameters = RequestParameters;\nexport type DeviceManagementGetDeviceClassSubgroupDeploymentStatusParameters = RequestParameters;\n\nexport interface DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParamProperties {\n  /** Restricts the set of deployment device states returned. You can filter on deviceId and moduleId and/or deviceState. */\n  filter?: string;\n}\n\nexport interface DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParam {\n  queryParameters?: DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParamProperties;\n}\n\nexport type DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentParameters =\n  DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParam & RequestParameters;\n\nexport interface DeviceManagementGetOperationStatusHeaders {\n  /** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */\n  \"If-None-Match\"?: string;\n}\n\nexport interface DeviceManagementGetOperationStatusHeaderParam {\n  headers?: RawHttpHeadersInput & DeviceManagementGetOperationStatusHeaders;\n}\n\nexport type DeviceManagementGetOperationStatusParameters =\n  DeviceManagementGetOperationStatusHeaderParam & RequestParameters;\n\nexport interface DeviceManagementListOperationStatusesQueryParamProperties {\n  /** Restricts the set of operations returned. Only one specific filter is supported: \"status eq 'NotStarted' or status eq 'Running'\" */\n  filter?: string;\n  /** Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. */\n  top?: number;\n}\n\nexport interface DeviceManagementListOperationStatusesQueryParam {\n  queryParameters?: DeviceManagementListOperationStatusesQueryParamProperties;\n}\n\nexport type DeviceManagementListOperationStatusesParameters =\n  DeviceManagementListOperationStatusesQueryParam & RequestParameters;\n\nexport interface DeviceManagementStartLogCollectionBodyParam {\n  /** The log collection properties. */\n  body: LogCollection;\n}\n\nexport interface DeviceManagementStartLogCollectionMediaTypesParam {\n  /** Request content type */\n  contentType?: \"application/json\";\n}\n\nexport type DeviceManagementStartLogCollectionParameters =\n  DeviceManagementStartLogCollectionMediaTypesParam &\n    DeviceManagementStartLogCollectionBodyParam &\n    RequestParameters;\nexport type DeviceManagementGetLogCollectionParameters = RequestParameters;\nexport type DeviceManagementListLogCollectionsParameters = RequestParameters;\nexport type DeviceManagementGetLogCollectionDetailedStatusParameters = RequestParameters;\n\nexport interface DeviceManagementListHealthOfDevicesQueryParamProperties {\n  /** Restricts the set of devices for which device health is returned. You can filter on status, device id and module id. */\n  filter: string;\n}\n\nexport interface DeviceManagementListHealthOfDevicesQueryParam {\n  queryParameters: DeviceManagementListHealthOfDevicesQueryParamProperties;\n}\n\nexport type DeviceManagementListHealthOfDevicesParameters =\n  DeviceManagementListHealthOfDevicesQueryParam & RequestParameters;\n"]}

package/dist/esm/pollingHelper.d.ts

@@ -1,5 +1,70 @@
 import type { Client, HttpResponse } from "@azure-rest/core-client";
-import type { LroEngineOptions, PollerLike, PollOperationState } from "@azure/core-lro";
+import type { AbortSignalLike } from "@azure/abort-controller";
+import type { CancelOnProgress, CreateHttpPollerOptions, OperationState } from "@azure/core-lro";
+/**
+ * A simple poller that can be used to poll a long running operation.
+ */
+export interface SimplePollerLike<TState extends OperationState<TResult>, TResult> {
+    /**
+     * Returns true if the poller has finished polling.
+     */
+    isDone(): boolean;
+    /**
+     * Returns the state of the operation.
+     */
+    getOperationState(): TState;
+    /**
+     * Returns the result value of the operation,
+     * regardless of the state of the poller.
+     * It can return undefined or an incomplete form of the final TResult value
+     * depending on the implementation.
+     */
+    getResult(): TResult | undefined;
+    /**
+     * Returns a promise that will resolve once a single polling request finishes.
+     * It does this by calling the update method of the Poller's operation.
+     */
+    poll(options?: {
+        abortSignal?: AbortSignalLike;
+    }): Promise<TState>;
+    /**
+     * Returns a promise that will resolve once the underlying operation is completed.
+     */
+    pollUntilDone(pollOptions?: {
+        abortSignal?: AbortSignalLike;
+    }): Promise<TResult>;
+    /**
+     * Invokes the provided callback after each polling is completed,
+     * sending the current state of the poller's operation.
+     *
+     * It returns a method that can be used to stop receiving updates on the given callback function.
+     */
+    onProgress(callback: (state: TState) => void): CancelOnProgress;
+    /**
+     * Returns a promise that could be used for serialized version of the poller's operation
+     * by invoking the operation's serialize method.
+     */
+    serialize(): Promise<string>;
+    /**
+     * Wait the poller to be submitted.
+     */
+    submitted(): Promise<void>;
+    /**
+     * Returns a string representation of the poller's operation. Similar to serialize but returns a string.
+     * @deprecated Use serialize() instead.
+     */
+    toString(): string;
+    /**
+     * Stops the poller from continuing to poll. Please note this will only stop the client-side polling
+     * @deprecated Use abortSignal to stop polling instead.
+     */
+    stopPolling(): void;
+    /**
+     * Returns true if the poller is stopped.
+     * @deprecated Use abortSignal status to track this instead.
+     */
+    isStopped(): boolean;
+}
 /**
  * Helper function that builds a Poller object to help polling a long running operation.
  * @param client - Client to use for sending the request to get additional pages.
@@ -7,5 +72,5 @@ import type { LroEngineOptions, PollerLike, PollOperationState } from "@azure/co
  * @param options - Options to set a resume state or custom polling interval.
  * @returns - A poller object to poll for operation state updates and eventually get the final response.
  */
-export declare function getLongRunningPoller<TResult extends HttpResponse>(client: Client, initialResponse: TResult, options?: LroEngineOptions<TResult, PollOperationState<TResult>>): PollerLike<PollOperationState<TResult>, TResult>;
+export declare function getLongRunningPoller<TResult extends HttpResponse>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
 //# sourceMappingURL=pollingHelper.d.ts.map

package/dist/esm/pollingHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pollingHelper.d.ts","sourceRoot":"","sources":["../../src/pollingHelper.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,KAAK,EAEV,gBAAgB,EAEhB,UAAU,EACV,kBAAkB,EACnB,MAAM,iBAAiB,CAAC;AAGzB;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,SAAS,YAAY,EAC/D,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,OAAO,EACxB,OAAO,GAAE,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAM,GACnE,UAAU,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAuBlD"}
+{"version":3,"file":"pollingHelper.d.ts","sourceRoot":"","sources":["../../src/pollingHelper.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EACV,gBAAgB,EAChB,uBAAuB,EAGvB,cAAc,EACf,MAAM,iBAAiB,CAAC;AAGzB;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,MAAM,SAAS,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO;IAC/E;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC;IAClB;;OAEG;IACH,iBAAiB,IAAI,MAAM,CAAC;IAC5B;;;;;OAKG;IACH,SAAS,IAAI,OAAO,GAAG,SAAS,CAAC;IACjC;;;OAGG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,eAAe,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACnE;;OAEG;IACH,aAAa,CAAC,WAAW,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,eAAe,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACjF;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,gBAAgB,CAAC;IAEhE;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B;;;OAGG;IACH,QAAQ,IAAI,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC;CACtB;AAED;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CAAC,OAAO,SAAS,YAAY,EACrE,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,OAAO,EACxB,OAAO,GAAE,uBAAuB,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,CAAM,GACtE,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAgF7D"}

package/dist/esm/pollingHelper.js

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import { LroEngine } from "@azure/core-lro";
+import { createHttpPoller } from "@azure/core-lro";
 /**
  * Helper function that builds a Poller object to help polling a long running operation.
  * @param client - Client to use for sending the request to get additional pages.
@@ -8,33 +8,89 @@ import { LroEngine } from "@azure/core-lro";
  * @param options - Options to set a resume state or custom polling interval.
  * @returns - A poller object to poll for operation state updates and eventually get the final response.
  */
-export function getLongRunningPoller(client, initialResponse, options = {}) {
+export async function getLongRunningPoller(client, initialResponse, options = {}) {
+    var _a;
+    const abortController = new AbortController();
     const poller = {
-        requestMethod: initialResponse.request.method,
-        requestPath: initialResponse.request.url,
         sendInitialRequest: async () => {
             // In the case of Rest Clients we are building the LRO poller object from a response that's the reason
             // we are not triggering the initial request here, just extracting the information from the
             // response we were provided.
             return getLroResponse(initialResponse);
         },
-        sendPollRequest: async (path) => {
+        sendPollRequest: async (path, pollOptions) => {
             // This is the callback that is going to be called to poll the service
             // to get the latest status. We use the client provided and the polling path
             // which is an opaque URL provided by caller, the service sends this in one of the following headers: operation-location, azure-asyncoperation or location
             // depending on the lro pattern that the service implements. If non is provided we default to the initial path.
-            const response = await client.pathUnchecked(path !== null && path !== void 0 ? path : initialResponse.request.url).get();
+            function abortListener() {
+                abortController.abort();
+            }
+            const inputAbortSignal = pollOptions === null || pollOptions === void 0 ? void 0 : pollOptions.abortSignal;
+            const abortSignal = abortController.signal;
+            if (inputAbortSignal === null || inputAbortSignal === void 0 ? void 0 : inputAbortSignal.aborted) {
+                abortController.abort();
+            }
+            else if (!abortSignal.aborted) {
+                inputAbortSignal === null || inputAbortSignal === void 0 ? void 0 : inputAbortSignal.addEventListener("abort", abortListener, {
+                    once: true,
+                });
+            }
+            let response;
+            try {
+                response = await client
+                    .pathUnchecked(path !== null && path !== void 0 ? path : initialResponse.request.url)
+                    .get({ abortSignal });
+            }
+            finally {
+                inputAbortSignal === null || inputAbortSignal === void 0 ? void 0 : inputAbortSignal.removeEventListener("abort", abortListener);
+            }
             const lroResponse = getLroResponse(response);
             lroResponse.rawResponse.headers["x-ms-original-url"] = initialResponse.request.url;
             return lroResponse;
         },
     };
-    return new LroEngine(poller, options);
+    options.resolveOnUnsuccessful = (_a = options.resolveOnUnsuccessful) !== null && _a !== void 0 ? _a : true;
+    const httpPoller = createHttpPoller(poller, options);
+    const simplePoller = {
+        isDone() {
+            return httpPoller.isDone;
+        },
+        isStopped() {
+            return abortController.signal.aborted;
+        },
+        getOperationState() {
+            if (!httpPoller.operationState) {
+                throw new Error("Operation state is not available. The poller may not have been started and you could await submitted() before calling getOperationState().");
+            }
+            return httpPoller.operationState;
+        },
+        getResult() {
+            return httpPoller.result;
+        },
+        toString() {
+            if (!httpPoller.operationState) {
+                throw new Error("Operation state is not available. The poller may not have been started and you could await submitted() before calling getOperationState().");
+            }
+            return JSON.stringify({
+                state: httpPoller.operationState,
+            });
+        },
+        stopPolling() {
+            abortController.abort();
+        },
+        onProgress: httpPoller.onProgress,
+        poll: httpPoller.poll,
+        pollUntilDone: httpPoller.pollUntilDone,
+        serialize: httpPoller.serialize,
+        submitted: httpPoller.submitted,
+    };
+    return simplePoller;
 }
 /**
- * Converts a Rest Client response to a response that the LRO engine knows about
+ * Converts a Rest Client response to a response that the LRO implementation understands
  * @param response - a rest client http response
- * @returns - An LRO response that the LRO engine can work with
+ * @returns - An LRO response that the LRO implementation understands
  */
 function getLroResponse(response) {
     if (Number.isNaN(response.status)) {

package/dist/esm/pollingHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"pollingHelper.js","sourceRoot":"","sources":["../../src/pollingHelper.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAUlC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAc,EACd,eAAwB,EACxB,UAAkE,EAAE;IAEpE,MAAM,MAAM,GAAkC;QAC5C,aAAa,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM;QAC7C,WAAW,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG;QACxC,kBAAkB,EAAE,KAAK,IAAI,EAAE;YAC7B,sGAAsG;YACtG,2FAA2F;YAC3F,6BAA6B;YAC7B,OAAO,cAAc,CAAC,eAAe,CAAC,CAAC;QACzC,CAAC;QACD,eAAe,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC9B,sEAAsE;YACtE,4EAA4E;YAC5E,0JAA0J;YAC1J,+GAA+G;YAC/G,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;YACvF,MAAM,WAAW,GAAG,cAAc,CAAC,QAAmB,CAAC,CAAC;YACxD,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC;YACnF,OAAO,WAAW,CAAC;QACrB,CAAC;KACF,CAAC;IAEF,OAAO,IAAI,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAA+B,QAAiB;IACrE,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,SAAS,CAAC,uDAAuD,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAChG,CAAC;IAED,OAAO;QACL,YAAY,EAAE,QAAQ;QACtB,WAAW,kCACN,QAAQ,KACX,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAC5C,IAAI,EAAE,QAAQ,CAAC,IAAI,GACpB;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { Client, HttpResponse } from \"@azure-rest/core-client\";\nimport type {\n  LongRunningOperation,\n  LroEngineOptions,\n  LroResponse,\n  PollerLike,\n  PollOperationState,\n} from \"@azure/core-lro\";\nimport { LroEngine } from \"@azure/core-lro\";\n\n/**\n * Helper function that builds a Poller object to help polling a long running operation.\n * @param client - Client to use for sending the request to get additional pages.\n * @param initialResponse - The initial response.\n * @param options - Options to set a resume state or custom polling interval.\n * @returns - A poller object to poll for operation state updates and eventually get the final response.\n */\nexport function getLongRunningPoller<TResult extends HttpResponse>(\n  client: Client,\n  initialResponse: TResult,\n  options: LroEngineOptions<TResult, PollOperationState<TResult>> = {},\n): PollerLike<PollOperationState<TResult>, TResult> {\n  const poller: LongRunningOperation<TResult> = {\n    requestMethod: initialResponse.request.method,\n    requestPath: initialResponse.request.url,\n    sendInitialRequest: async () => {\n      // In the case of Rest Clients we are building the LRO poller object from a response that's the reason\n      // we are not triggering the initial request here, just extracting the information from the\n      // response we were provided.\n      return getLroResponse(initialResponse);\n    },\n    sendPollRequest: async (path) => {\n      // This is the callback that is going to be called to poll the service\n      // to get the latest status. We use the client provided and the polling path\n      // which is an opaque URL provided by caller, the service sends this in one of the following headers: operation-location, azure-asyncoperation or location\n      // depending on the lro pattern that the service implements. If non is provided we default to the initial path.\n      const response = await client.pathUnchecked(path ?? initialResponse.request.url).get();\n      const lroResponse = getLroResponse(response as TResult);\n      lroResponse.rawResponse.headers[\"x-ms-original-url\"] = initialResponse.request.url;\n      return lroResponse;\n    },\n  };\n\n  return new LroEngine(poller, options);\n}\n\n/**\n * Converts a Rest Client response to a response that the LRO engine knows about\n * @param response - a rest client http response\n * @returns - An LRO response that the LRO engine can work with\n */\nfunction getLroResponse<TResult extends HttpResponse>(response: TResult): LroResponse<TResult> {\n  if (Number.isNaN(response.status)) {\n    throw new TypeError(`Status code of the response is not a number. Value: ${response.status}`);\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"]}
+{"version":3,"file":"pollingHelper.js","sourceRoot":"","sources":["../../src/pollingHelper.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAWlC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAoEnD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,MAAc,EACd,eAAwB,EACxB,UAAqE,EAAE;;IAEvE,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IAC9C,MAAM,MAAM,GAA8B;QACxC,kBAAkB,EAAE,KAAK,IAAI,EAAE;YAC7B,sGAAsG;YACtG,2FAA2F;YAC3F,6BAA6B;YAC7B,OAAO,cAAc,CAAC,eAAe,CAAC,CAAC;QACzC,CAAC;QACD,eAAe,EAAE,KAAK,EAAE,IAAY,EAAE,WAA+C,EAAE,EAAE;YACvF,sEAAsE;YACtE,4EAA4E;YAC5E,0JAA0J;YAC1J,+GAA+G;YAC/G,SAAS,aAAa;gBACpB,eAAe,CAAC,KAAK,EAAE,CAAC;YAC1B,CAAC;YACD,MAAM,gBAAgB,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,WAAW,CAAC;YAClD,MAAM,WAAW,GAAG,eAAe,CAAC,MAAM,CAAC;YAC3C,IAAI,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,EAAE,CAAC;gBAC9B,eAAe,CAAC,KAAK,EAAE,CAAC;YAC1B,CAAC;iBAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;gBAChC,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,gBAAgB,CAAC,OAAO,EAAE,aAAa,EAAE;oBACzD,IAAI,EAAE,IAAI;iBACX,CAAC,CAAC;YACL,CAAC;YACD,IAAI,QAAQ,CAAC;YACb,IAAI,CAAC;gBACH,QAAQ,GAAG,MAAM,MAAM;qBACpB,aAAa,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC;qBAClD,GAAG,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;YAC1B,CAAC;oBAAS,CAAC;gBACT,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,mBAAmB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;YAChE,CAAC;YACD,MAAM,WAAW,GAAG,cAAc,CAAC,QAAmB,CAAC,CAAC;YACxD,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC;YACnF,OAAO,WAAW,CAAC;QACrB,CAAC;KACF,CAAC;IAEF,OAAO,CAAC,qBAAqB,GAAG,MAAA,OAAO,CAAC,qBAAqB,mCAAI,IAAI,CAAC;IACtE,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrD,MAAM,YAAY,GAAuD;QACvE,MAAM;YACJ,OAAO,UAAU,CAAC,MAAM,CAAC;QAC3B,CAAC;QACD,SAAS;YACP,OAAO,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC;QACxC,CAAC;QACD,iBAAiB;YACf,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CACb,4IAA4I,CAC7I,CAAC;YACJ,CAAC;YACD,OAAO,UAAU,CAAC,cAAc,CAAC;QACnC,CAAC;QACD,SAAS;YACP,OAAO,UAAU,CAAC,MAAM,CAAC;QAC3B,CAAC;QACD,QAAQ;YACN,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CACb,4IAA4I,CAC7I,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC,SAAS,CAAC;gBACpB,KAAK,EAAE,UAAU,CAAC,cAAc;aACjC,CAAC,CAAC;QACL,CAAC;QACD,WAAW;YACT,eAAe,CAAC,KAAK,EAAE,CAAC;QAC1B,CAAC;QACD,UAAU,EAAE,UAAU,CAAC,UAAU;QACjC,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,aAAa,EAAE,UAAU,CAAC,aAAa;QACvC,SAAS,EAAE,UAAU,CAAC,SAAS;QAC/B,SAAS,EAAE,UAAU,CAAC,SAAS;KAChC,CAAC;IACF,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CACrB,QAAiB;IAEjB,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,SAAS,CAAC,uDAAuD,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAChG,CAAC;IAED,OAAO;QACL,YAAY,EAAE,QAAQ;QACtB,WAAW,kCACN,QAAQ,KACX,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAC5C,IAAI,EAAE,QAAQ,CAAC,IAAI,GACpB;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { Client, HttpResponse } from \"@azure-rest/core-client\";\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\nimport type {\n  CancelOnProgress,\n  CreateHttpPollerOptions,\n  RunningOperation,\n  OperationResponse,\n  OperationState,\n} from \"@azure/core-lro\";\nimport { createHttpPoller } from \"@azure/core-lro\";\n\n/**\n * A simple poller that can be used to poll a long running operation.\n */\nexport interface SimplePollerLike<TState extends OperationState<TResult>, TResult> {\n  /**\n   * Returns true if the poller has finished polling.\n   */\n  isDone(): boolean;\n  /**\n   * Returns the state of the operation.\n   */\n  getOperationState(): TState;\n  /**\n   * Returns the result value of the operation,\n   * regardless of the state of the poller.\n   * It can return undefined or an incomplete form of the final TResult value\n   * depending on the implementation.\n   */\n  getResult(): TResult | undefined;\n  /**\n   * Returns a promise that will resolve once a single polling request finishes.\n   * It does this by calling the update method of the Poller's operation.\n   */\n  poll(options?: { abortSignal?: AbortSignalLike }): Promise<TState>;\n  /**\n   * Returns a promise that will resolve once the underlying operation is completed.\n   */\n  pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>;\n  /**\n   * Invokes the provided callback after each polling is completed,\n   * sending the current state of the poller's operation.\n   *\n   * It returns a method that can be used to stop receiving updates on the given callback function.\n   */\n  onProgress(callback: (state: TState) => void): CancelOnProgress;\n\n  /**\n   * Returns a promise that could be used for serialized version of the poller's operation\n   * by invoking the operation's serialize method.\n   */\n  serialize(): Promise<string>;\n\n  /**\n   * Wait the poller to be submitted.\n   */\n  submitted(): Promise<void>;\n\n  /**\n   * Returns a string representation of the poller's operation. Similar to serialize but returns a string.\n   * @deprecated Use serialize() instead.\n   */\n  toString(): string;\n\n  /**\n   * Stops the poller from continuing to poll. Please note this will only stop the client-side polling\n   * @deprecated Use abortSignal to stop polling instead.\n   */\n  stopPolling(): void;\n\n  /**\n   * Returns true if the poller is stopped.\n   * @deprecated Use abortSignal status to track this instead.\n   */\n  isStopped(): boolean;\n}\n\n/**\n * Helper function that builds a Poller object to help polling a long running operation.\n * @param client - Client to use for sending the request to get additional pages.\n * @param initialResponse - The initial response.\n * @param options - Options to set a resume state or custom polling interval.\n * @returns - A poller object to poll for operation state updates and eventually get the final response.\n */\nexport async function getLongRunningPoller<TResult extends HttpResponse>(\n  client: Client,\n  initialResponse: TResult,\n  options: CreateHttpPollerOptions<TResult, OperationState<TResult>> = {},\n): Promise<SimplePollerLike<OperationState<TResult>, TResult>> {\n  const abortController = new AbortController();\n  const poller: RunningOperation<TResult> = {\n    sendInitialRequest: async () => {\n      // In the case of Rest Clients we are building the LRO poller object from a response that's the reason\n      // we are not triggering the initial request here, just extracting the information from the\n      // response we were provided.\n      return getLroResponse(initialResponse);\n    },\n    sendPollRequest: async (path: string, pollOptions?: { abortSignal?: AbortSignalLike }) => {\n      // This is the callback that is going to be called to poll the service\n      // to get the latest status. We use the client provided and the polling path\n      // which is an opaque URL provided by caller, the service sends this in one of the following headers: operation-location, azure-asyncoperation or location\n      // depending on the lro pattern that the service implements. If non is provided we default to the initial path.\n      function abortListener(): void {\n        abortController.abort();\n      }\n      const inputAbortSignal = pollOptions?.abortSignal;\n      const abortSignal = abortController.signal;\n      if (inputAbortSignal?.aborted) {\n        abortController.abort();\n      } else if (!abortSignal.aborted) {\n        inputAbortSignal?.addEventListener(\"abort\", abortListener, {\n          once: true,\n        });\n      }\n      let response;\n      try {\n        response = await client\n          .pathUnchecked(path ?? initialResponse.request.url)\n          .get({ abortSignal });\n      } finally {\n        inputAbortSignal?.removeEventListener(\"abort\", abortListener);\n      }\n      const lroResponse = getLroResponse(response as TResult);\n      lroResponse.rawResponse.headers[\"x-ms-original-url\"] = initialResponse.request.url;\n      return lroResponse;\n    },\n  };\n\n  options.resolveOnUnsuccessful = options.resolveOnUnsuccessful ?? true;\n  const httpPoller = createHttpPoller(poller, options);\n  const simplePoller: SimplePollerLike<OperationState<TResult>, TResult> = {\n    isDone() {\n      return httpPoller.isDone;\n    },\n    isStopped() {\n      return abortController.signal.aborted;\n    },\n    getOperationState() {\n      if (!httpPoller.operationState) {\n        throw new Error(\n          \"Operation state is not available. The poller may not have been started and you could await submitted() before calling getOperationState().\",\n        );\n      }\n      return httpPoller.operationState;\n    },\n    getResult() {\n      return httpPoller.result;\n    },\n    toString() {\n      if (!httpPoller.operationState) {\n        throw new Error(\n          \"Operation state is not available. The poller may not have been started and you could await submitted() before calling getOperationState().\",\n        );\n      }\n      return JSON.stringify({\n        state: httpPoller.operationState,\n      });\n    },\n    stopPolling() {\n      abortController.abort();\n    },\n    onProgress: httpPoller.onProgress,\n    poll: httpPoller.poll,\n    pollUntilDone: httpPoller.pollUntilDone,\n    serialize: httpPoller.serialize,\n    submitted: httpPoller.submitted,\n  };\n  return simplePoller;\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 * @returns - An LRO response that the LRO implementation understands\n */\nfunction getLroResponse<TResult extends HttpResponse>(\n  response: TResult,\n): OperationResponse<TResult> {\n  if (Number.isNaN(response.status)) {\n    throw new TypeError(`Status code of the response is not a number. Value: ${response.status}`);\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"]}