@azure-rest/developer-devcenter 1.0.0-beta.2 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -10
- package/dist/browser/azureDeveloperDevCenter.d.ts +11 -0
- package/dist/browser/azureDeveloperDevCenter.d.ts.map +1 -0
- package/dist/browser/azureDeveloperDevCenter.js +29 -0
- package/dist/browser/azureDeveloperDevCenter.js.map +1 -0
- package/dist/browser/clientDefinitions.d.ts +191 -0
- package/dist/browser/clientDefinitions.d.ts.map +1 -0
- package/dist/browser/clientDefinitions.js.map +1 -0
- package/dist/browser/index.d.ts +12 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +14 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/isUnexpected.d.ts +35 -0
- package/dist/browser/isUnexpected.d.ts.map +1 -0
- package/dist/browser/isUnexpected.js +111 -0
- package/dist/browser/isUnexpected.js.map +1 -0
- package/dist/browser/logger.d.ts +2 -0
- package/dist/browser/logger.d.ts.map +1 -0
- package/dist/browser/logger.js +5 -0
- package/dist/browser/logger.js.map +1 -0
- package/dist/browser/models.d.ts +47 -0
- package/dist/browser/models.d.ts.map +1 -0
- package/dist/browser/models.js.map +1 -0
- package/dist/browser/outputModels.d.ts +338 -0
- package/dist/browser/outputModels.d.ts.map +1 -0
- package/dist/browser/outputModels.js.map +1 -0
- package/dist/browser/package.json +3 -0
- package/dist/browser/paginateHelper.d.ts +43 -0
- package/dist/browser/paginateHelper.d.ts.map +1 -0
- package/{dist-esm/src/generated → dist/browser}/paginateHelper.js +4 -17
- package/dist/browser/paginateHelper.js.map +1 -0
- package/dist/browser/parameters.d.ts +65 -0
- package/dist/browser/parameters.d.ts.map +1 -0
- package/dist/browser/parameters.js.map +1 -0
- package/dist/browser/pollingHelper.d.ts +83 -0
- package/dist/browser/pollingHelper.d.ts.map +1 -0
- package/dist/browser/pollingHelper.js +97 -0
- package/dist/browser/pollingHelper.js.map +1 -0
- package/dist/browser/responses.d.ts +547 -0
- package/dist/browser/responses.d.ts.map +1 -0
- package/dist/browser/responses.js.map +1 -0
- package/dist/commonjs/azureDeveloperDevCenter.d.ts +11 -0
- package/dist/commonjs/azureDeveloperDevCenter.d.ts.map +1 -0
- package/dist/commonjs/azureDeveloperDevCenter.js +32 -0
- package/dist/commonjs/azureDeveloperDevCenter.js.map +1 -0
- package/dist/commonjs/clientDefinitions.d.ts +191 -0
- package/dist/commonjs/clientDefinitions.d.ts.map +1 -0
- package/dist/commonjs/clientDefinitions.js +5 -0
- package/dist/commonjs/clientDefinitions.js.map +1 -0
- package/dist/commonjs/index.d.ts +12 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +17 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/isUnexpected.d.ts +35 -0
- package/dist/commonjs/isUnexpected.d.ts.map +1 -0
- package/dist/commonjs/isUnexpected.js +114 -0
- package/dist/commonjs/isUnexpected.js.map +1 -0
- package/dist/commonjs/logger.d.ts +2 -0
- package/dist/commonjs/logger.d.ts.map +1 -0
- package/dist/commonjs/logger.js +8 -0
- package/dist/commonjs/logger.js.map +1 -0
- package/dist/commonjs/models.d.ts +47 -0
- package/dist/commonjs/models.d.ts.map +1 -0
- package/dist/commonjs/models.js +5 -0
- package/dist/commonjs/models.js.map +1 -0
- package/dist/commonjs/outputModels.d.ts +338 -0
- package/dist/commonjs/outputModels.d.ts.map +1 -0
- package/dist/commonjs/outputModels.js +5 -0
- package/dist/commonjs/outputModels.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/paginateHelper.d.ts +43 -0
- package/dist/commonjs/paginateHelper.d.ts.map +1 -0
- package/dist/commonjs/paginateHelper.js +73 -0
- package/dist/commonjs/paginateHelper.js.map +1 -0
- package/dist/commonjs/parameters.d.ts +65 -0
- package/dist/commonjs/parameters.d.ts.map +1 -0
- package/dist/commonjs/parameters.js +5 -0
- package/dist/commonjs/parameters.js.map +1 -0
- package/dist/commonjs/pollingHelper.d.ts +83 -0
- package/dist/commonjs/pollingHelper.d.ts.map +1 -0
- package/dist/commonjs/pollingHelper.js +100 -0
- package/dist/commonjs/pollingHelper.js.map +1 -0
- package/dist/commonjs/responses.d.ts +547 -0
- package/dist/commonjs/responses.d.ts.map +1 -0
- package/dist/commonjs/responses.js +5 -0
- package/dist/commonjs/responses.js.map +1 -0
- package/dist/commonjs/tsdoc-metadata.json +11 -0
- package/dist/esm/azureDeveloperDevCenter.d.ts +11 -0
- package/dist/esm/azureDeveloperDevCenter.d.ts.map +1 -0
- package/dist/esm/azureDeveloperDevCenter.js +29 -0
- package/dist/esm/azureDeveloperDevCenter.js.map +1 -0
- package/dist/esm/clientDefinitions.d.ts +191 -0
- package/dist/esm/clientDefinitions.d.ts.map +1 -0
- package/dist/esm/clientDefinitions.js +4 -0
- package/dist/esm/clientDefinitions.js.map +1 -0
- package/dist/esm/index.d.ts +12 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +14 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/isUnexpected.d.ts +35 -0
- package/dist/esm/isUnexpected.d.ts.map +1 -0
- package/dist/esm/isUnexpected.js +111 -0
- package/dist/esm/isUnexpected.js.map +1 -0
- package/dist/esm/logger.d.ts +2 -0
- package/dist/esm/logger.d.ts.map +1 -0
- package/dist/esm/logger.js +5 -0
- package/dist/esm/logger.js.map +1 -0
- package/dist/esm/models.d.ts +47 -0
- package/dist/esm/models.d.ts.map +1 -0
- package/dist/esm/models.js +4 -0
- package/dist/esm/models.js.map +1 -0
- package/dist/esm/outputModels.d.ts +338 -0
- package/dist/esm/outputModels.d.ts.map +1 -0
- package/dist/esm/outputModels.js +4 -0
- package/dist/esm/outputModels.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/paginateHelper.d.ts +43 -0
- package/dist/esm/paginateHelper.d.ts.map +1 -0
- package/dist/esm/paginateHelper.js +70 -0
- package/dist/esm/paginateHelper.js.map +1 -0
- package/dist/esm/parameters.d.ts +65 -0
- package/dist/esm/parameters.d.ts.map +1 -0
- package/dist/esm/parameters.js +4 -0
- package/dist/esm/parameters.js.map +1 -0
- package/dist/esm/pollingHelper.d.ts +83 -0
- package/dist/esm/pollingHelper.d.ts.map +1 -0
- package/dist/esm/pollingHelper.js +97 -0
- package/dist/esm/pollingHelper.js.map +1 -0
- package/dist/esm/responses.d.ts +547 -0
- package/dist/esm/responses.d.ts.map +1 -0
- package/dist/esm/responses.js +4 -0
- package/dist/esm/responses.js.map +1 -0
- package/dist/react-native/azureDeveloperDevCenter.d.ts +11 -0
- package/dist/react-native/azureDeveloperDevCenter.d.ts.map +1 -0
- package/dist/react-native/azureDeveloperDevCenter.js +29 -0
- package/dist/react-native/azureDeveloperDevCenter.js.map +1 -0
- package/dist/react-native/clientDefinitions.d.ts +191 -0
- package/dist/react-native/clientDefinitions.d.ts.map +1 -0
- package/dist/react-native/clientDefinitions.js +4 -0
- package/dist/react-native/clientDefinitions.js.map +1 -0
- package/dist/react-native/index.d.ts +12 -0
- package/dist/react-native/index.d.ts.map +1 -0
- package/dist/react-native/index.js +14 -0
- package/dist/react-native/index.js.map +1 -0
- package/dist/react-native/isUnexpected.d.ts +35 -0
- package/dist/react-native/isUnexpected.d.ts.map +1 -0
- package/dist/react-native/isUnexpected.js +111 -0
- package/dist/react-native/isUnexpected.js.map +1 -0
- package/dist/react-native/logger.d.ts +2 -0
- package/dist/react-native/logger.d.ts.map +1 -0
- package/dist/react-native/logger.js +5 -0
- package/dist/react-native/logger.js.map +1 -0
- package/dist/react-native/models.d.ts +47 -0
- package/dist/react-native/models.d.ts.map +1 -0
- package/dist/react-native/models.js +4 -0
- package/dist/react-native/models.js.map +1 -0
- package/dist/react-native/outputModels.d.ts +338 -0
- package/dist/react-native/outputModels.d.ts.map +1 -0
- package/dist/react-native/outputModels.js +4 -0
- package/dist/react-native/outputModels.js.map +1 -0
- package/dist/react-native/package.json +3 -0
- package/dist/react-native/paginateHelper.d.ts +43 -0
- package/dist/react-native/paginateHelper.d.ts.map +1 -0
- package/dist/react-native/paginateHelper.js +70 -0
- package/dist/react-native/paginateHelper.js.map +1 -0
- package/dist/react-native/parameters.d.ts +65 -0
- package/dist/react-native/parameters.d.ts.map +1 -0
- package/dist/react-native/parameters.js +4 -0
- package/dist/react-native/parameters.js.map +1 -0
- package/dist/react-native/pollingHelper.d.ts +83 -0
- package/dist/react-native/pollingHelper.d.ts.map +1 -0
- package/dist/react-native/pollingHelper.js +97 -0
- package/dist/react-native/pollingHelper.js.map +1 -0
- package/dist/react-native/responses.d.ts +547 -0
- package/dist/react-native/responses.d.ts.map +1 -0
- package/dist/react-native/responses.js +4 -0
- package/dist/react-native/responses.js.map +1 -0
- package/package.json +115 -94
- package/review/developer-devcenter.api.md +910 -967
- package/dist/index.js +0 -323
- package/dist/index.js.map +0 -1
- package/dist-esm/src/generated/azureDevCenter.js +0 -26
- package/dist-esm/src/generated/azureDevCenter.js.map +0 -1
- package/dist-esm/src/generated/clientDefinitions.js.map +0 -1
- package/dist-esm/src/generated/index.js +0 -14
- package/dist-esm/src/generated/index.js.map +0 -1
- package/dist-esm/src/generated/isUnexpected.js +0 -155
- package/dist-esm/src/generated/isUnexpected.js.map +0 -1
- package/dist-esm/src/generated/models.js.map +0 -1
- package/dist-esm/src/generated/outputModels.js.map +0 -1
- package/dist-esm/src/generated/paginateHelper.js.map +0 -1
- package/dist-esm/src/generated/parameters.js.map +0 -1
- package/dist-esm/src/generated/pollingHelper.js +0 -51
- package/dist-esm/src/generated/pollingHelper.js.map +0 -1
- package/dist-esm/src/generated/responses.js.map +0 -1
- package/dist-esm/src/index.js +0 -14
- package/dist-esm/src/index.js.map +0 -1
- package/types/developer-devcenter.d.ts +0 -1735
- /package/{dist-esm/src/generated → dist/browser}/clientDefinitions.js +0 -0
- /package/{dist-esm/src/generated → dist/browser}/models.js +0 -0
- /package/{dist-esm/src/generated → dist/browser}/outputModels.js +0 -0
- /package/{dist-esm/src/generated → dist/browser}/parameters.js +0 -0
- /package/{dist-esm/src/generated → dist/browser}/responses.js +0 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"paginateHelper.js","sourceRoot":"","sources":["../../src/paginateHelper.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,qBAAqB,EAA2C,MAAM,oBAAoB,CAAC;AACpG,OAAO,EAAU,eAAe,EAAyB,MAAM,yBAAyB,CAAC;AAyCzF;;;;;;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 { getPagedAsyncIterator, PagedAsyncIterableIterator, PagedResult } from \"@azure/core-paging\";\nimport { Client, createRestError, PathUncheckedResponse } 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"]}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { RequestParameters } from "@azure-rest/core-client";
|
|
2
|
+
import { DevBox, Environment } from "./models.js";
|
|
3
|
+
export type ListProjectsParameters = RequestParameters;
|
|
4
|
+
export type GetProjectParameters = RequestParameters;
|
|
5
|
+
export type GetParameters = RequestParameters;
|
|
6
|
+
export type ListPoolsParameters = RequestParameters;
|
|
7
|
+
export type GetPoolParameters = RequestParameters;
|
|
8
|
+
export type ListAllDevBoxesParameters = RequestParameters;
|
|
9
|
+
export type ListAllDevBoxesByUserParameters = RequestParameters;
|
|
10
|
+
export type ListSchedulesByPoolParameters = RequestParameters;
|
|
11
|
+
export type GetScheduleByPoolParameters = RequestParameters;
|
|
12
|
+
export type ListDevBoxesByUserParameters = RequestParameters;
|
|
13
|
+
export type GetDevBoxByUserParameters = RequestParameters;
|
|
14
|
+
export interface CreateDevBoxBodyParam {
|
|
15
|
+
/** Represents the body request of a Dev Box creation. Dev Box Pool name is required. Optionally set the owner of the Dev Box as local administrator */
|
|
16
|
+
body: DevBox;
|
|
17
|
+
}
|
|
18
|
+
export type CreateDevBoxParameters = CreateDevBoxBodyParam & RequestParameters;
|
|
19
|
+
export type DeleteDevBoxParameters = RequestParameters;
|
|
20
|
+
export type StartDevBoxParameters = RequestParameters;
|
|
21
|
+
export interface StopDevBoxQueryParamProperties {
|
|
22
|
+
/** Optional parameter to hibernate the dev box. */
|
|
23
|
+
hibernate?: boolean;
|
|
24
|
+
}
|
|
25
|
+
export interface StopDevBoxQueryParam {
|
|
26
|
+
queryParameters?: StopDevBoxQueryParamProperties;
|
|
27
|
+
}
|
|
28
|
+
export type StopDevBoxParameters = StopDevBoxQueryParam & RequestParameters;
|
|
29
|
+
export type RestartDevBoxParameters = RequestParameters;
|
|
30
|
+
export type GetRemoteConnectionParameters = RequestParameters;
|
|
31
|
+
export type ListActionsParameters = RequestParameters;
|
|
32
|
+
export type GetActionParameters = RequestParameters;
|
|
33
|
+
export type SkipActionParameters = RequestParameters;
|
|
34
|
+
export interface DelayActionQueryParamProperties {
|
|
35
|
+
/** The time to delay the Dev Box action or actions until. */
|
|
36
|
+
until: Date | string;
|
|
37
|
+
}
|
|
38
|
+
export interface DelayActionQueryParam {
|
|
39
|
+
queryParameters: DelayActionQueryParamProperties;
|
|
40
|
+
}
|
|
41
|
+
export type DelayActionParameters = DelayActionQueryParam & RequestParameters;
|
|
42
|
+
export interface DelayActionsQueryParamProperties {
|
|
43
|
+
/** The time to delay the Dev Box action or actions until. */
|
|
44
|
+
until: Date | string;
|
|
45
|
+
}
|
|
46
|
+
export interface DelayActionsQueryParam {
|
|
47
|
+
queryParameters: DelayActionsQueryParamProperties;
|
|
48
|
+
}
|
|
49
|
+
export type DelayActionsParameters = DelayActionsQueryParam & RequestParameters;
|
|
50
|
+
export type ListEnvironmentsParameters = RequestParameters;
|
|
51
|
+
export type ListEnvironmentsByUserParameters = RequestParameters;
|
|
52
|
+
export type GetEnvironmentByUserParameters = RequestParameters;
|
|
53
|
+
export interface CreateOrReplaceEnvironmentBodyParam {
|
|
54
|
+
/** Represents an environment. */
|
|
55
|
+
body: Environment;
|
|
56
|
+
}
|
|
57
|
+
export type CreateOrReplaceEnvironmentParameters = CreateOrReplaceEnvironmentBodyParam & RequestParameters;
|
|
58
|
+
export type DeleteEnvironmentParameters = RequestParameters;
|
|
59
|
+
export type ListCatalogsByProjectParameters = RequestParameters;
|
|
60
|
+
export type GetCatalogParameters = RequestParameters;
|
|
61
|
+
export type ListEnvironmentDefinitionsByProjectParameters = RequestParameters;
|
|
62
|
+
export type ListEnvironmentDefinitionsByCatalogParameters = RequestParameters;
|
|
63
|
+
export type GetEnvironmentDefinitionParameters = RequestParameters;
|
|
64
|
+
export type ListEnvironmentTypesParameters = RequestParameters;
|
|
65
|
+
//# sourceMappingURL=parameters.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAElD,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;AACvD,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;AACrD,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAC;AAC9C,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;AACpD,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,CAAC;AAClD,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;AAC1D,MAAM,MAAM,+BAA+B,GAAG,iBAAiB,CAAC;AAChE,MAAM,MAAM,6BAA6B,GAAG,iBAAiB,CAAC;AAC9D,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC;AAC5D,MAAM,MAAM,4BAA4B,GAAG,iBAAiB,CAAC;AAC7D,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;AAE1D,MAAM,WAAW,qBAAqB;IACpC,uJAAuJ;IACvJ,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,sBAAsB,GAAG,qBAAqB,GAAG,iBAAiB,CAAC;AAC/E,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;AACvD,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;AAEtD,MAAM,WAAW,8BAA8B;IAC7C,mDAAmD;IACnD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,CAAC,EAAE,8BAA8B,CAAC;CAClD;AAED,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG,iBAAiB,CAAC;AAC5E,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;AACxD,MAAM,MAAM,6BAA6B,GAAG,iBAAiB,CAAC;AAC9D,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;AACtD,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;AACpD,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;AAErD,MAAM,WAAW,+BAA+B;IAC9C,6DAA6D;IAC7D,KAAK,EAAE,IAAI,GAAG,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,eAAe,EAAE,+BAA+B,CAAC;CAClD;AAED,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,GAAG,iBAAiB,CAAC;AAE9E,MAAM,WAAW,gCAAgC;IAC/C,6DAA6D;IAC7D,KAAK,EAAE,IAAI,GAAG,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,eAAe,EAAE,gCAAgC,CAAC;CACnD;AAED,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,GAAG,iBAAiB,CAAC;AAChF,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC;AAC3D,MAAM,MAAM,gCAAgC,GAAG,iBAAiB,CAAC;AACjE,MAAM,MAAM,8BAA8B,GAAG,iBAAiB,CAAC;AAE/D,MAAM,WAAW,mCAAmC;IAClD,iCAAiC;IACjC,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,MAAM,MAAM,oCAAoC,GAAG,mCAAmC,GACpF,iBAAiB,CAAC;AACpB,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC;AAC5D,MAAM,MAAM,+BAA+B,GAAG,iBAAiB,CAAC;AAChE,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;AACrD,MAAM,MAAM,6CAA6C,GAAG,iBAAiB,CAAC;AAC9E,MAAM,MAAM,6CAA6C,GAAG,iBAAiB,CAAC;AAC9E,MAAM,MAAM,kCAAkC,GAAG,iBAAiB,CAAC;AACnE,MAAM,MAAM,8BAA8B,GAAG,iBAAiB,CAAC"}
|
|
@@ -0,0 +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 { RequestParameters } from \"@azure-rest/core-client\";\nimport { DevBox, Environment } from \"./models.js\";\n\nexport type ListProjectsParameters = RequestParameters;\nexport type GetProjectParameters = RequestParameters;\nexport type GetParameters = RequestParameters;\nexport type ListPoolsParameters = RequestParameters;\nexport type GetPoolParameters = RequestParameters;\nexport type ListAllDevBoxesParameters = RequestParameters;\nexport type ListAllDevBoxesByUserParameters = RequestParameters;\nexport type ListSchedulesByPoolParameters = RequestParameters;\nexport type GetScheduleByPoolParameters = RequestParameters;\nexport type ListDevBoxesByUserParameters = RequestParameters;\nexport type GetDevBoxByUserParameters = RequestParameters;\n\nexport interface CreateDevBoxBodyParam {\n /** Represents the body request of a Dev Box creation. Dev Box Pool name is required. Optionally set the owner of the Dev Box as local administrator */\n body: DevBox;\n}\n\nexport type CreateDevBoxParameters = CreateDevBoxBodyParam & RequestParameters;\nexport type DeleteDevBoxParameters = RequestParameters;\nexport type StartDevBoxParameters = RequestParameters;\n\nexport interface StopDevBoxQueryParamProperties {\n /** Optional parameter to hibernate the dev box. */\n hibernate?: boolean;\n}\n\nexport interface StopDevBoxQueryParam {\n queryParameters?: StopDevBoxQueryParamProperties;\n}\n\nexport type StopDevBoxParameters = StopDevBoxQueryParam & RequestParameters;\nexport type RestartDevBoxParameters = RequestParameters;\nexport type GetRemoteConnectionParameters = RequestParameters;\nexport type ListActionsParameters = RequestParameters;\nexport type GetActionParameters = RequestParameters;\nexport type SkipActionParameters = RequestParameters;\n\nexport interface DelayActionQueryParamProperties {\n /** The time to delay the Dev Box action or actions until. */\n until: Date | string;\n}\n\nexport interface DelayActionQueryParam {\n queryParameters: DelayActionQueryParamProperties;\n}\n\nexport type DelayActionParameters = DelayActionQueryParam & RequestParameters;\n\nexport interface DelayActionsQueryParamProperties {\n /** The time to delay the Dev Box action or actions until. */\n until: Date | string;\n}\n\nexport interface DelayActionsQueryParam {\n queryParameters: DelayActionsQueryParamProperties;\n}\n\nexport type DelayActionsParameters = DelayActionsQueryParam & RequestParameters;\nexport type ListEnvironmentsParameters = RequestParameters;\nexport type ListEnvironmentsByUserParameters = RequestParameters;\nexport type GetEnvironmentByUserParameters = RequestParameters;\n\nexport interface CreateOrReplaceEnvironmentBodyParam {\n /** Represents an environment. */\n body: Environment;\n}\n\nexport type CreateOrReplaceEnvironmentParameters = CreateOrReplaceEnvironmentBodyParam &\n RequestParameters;\nexport type DeleteEnvironmentParameters = RequestParameters;\nexport type ListCatalogsByProjectParameters = RequestParameters;\nexport type GetCatalogParameters = RequestParameters;\nexport type ListEnvironmentDefinitionsByProjectParameters = RequestParameters;\nexport type ListEnvironmentDefinitionsByCatalogParameters = RequestParameters;\nexport type GetEnvironmentDefinitionParameters = RequestParameters;\nexport type ListEnvironmentTypesParameters = RequestParameters;\n"]}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { Client } from "@azure-rest/core-client";
|
|
2
|
+
import { AbortSignalLike } from "@azure/abort-controller";
|
|
3
|
+
import { CancelOnProgress, CreateHttpPollerOptions, OperationState } from "@azure/core-lro";
|
|
4
|
+
import { CreateDevBox200Response, CreateDevBox201Response, CreateDevBoxDefaultResponse, CreateDevBoxLogicalResponse, DeleteDevBox202Response, DeleteDevBox204Response, DeleteDevBoxDefaultResponse, DeleteDevBoxLogicalResponse, StartDevBox202Response, StartDevBoxDefaultResponse, StartDevBoxLogicalResponse, StopDevBox202Response, StopDevBoxDefaultResponse, StopDevBoxLogicalResponse, RestartDevBox202Response, RestartDevBoxDefaultResponse, RestartDevBoxLogicalResponse, CreateOrReplaceEnvironment201Response, CreateOrReplaceEnvironmentDefaultResponse, CreateOrReplaceEnvironmentLogicalResponse, DeleteEnvironment202Response, DeleteEnvironment204Response, DeleteEnvironmentDefaultResponse, DeleteEnvironmentLogicalResponse } from "./responses.js";
|
|
5
|
+
/**
|
|
6
|
+
* A simple poller that can be used to poll a long running operation.
|
|
7
|
+
*/
|
|
8
|
+
export interface SimplePollerLike<TState extends OperationState<TResult>, TResult> {
|
|
9
|
+
/**
|
|
10
|
+
* Returns true if the poller has finished polling.
|
|
11
|
+
*/
|
|
12
|
+
isDone(): boolean;
|
|
13
|
+
/**
|
|
14
|
+
* Returns the state of the operation.
|
|
15
|
+
*/
|
|
16
|
+
getOperationState(): TState;
|
|
17
|
+
/**
|
|
18
|
+
* Returns the result value of the operation,
|
|
19
|
+
* regardless of the state of the poller.
|
|
20
|
+
* It can return undefined or an incomplete form of the final TResult value
|
|
21
|
+
* depending on the implementation.
|
|
22
|
+
*/
|
|
23
|
+
getResult(): TResult | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* Returns a promise that will resolve once a single polling request finishes.
|
|
26
|
+
* It does this by calling the update method of the Poller's operation.
|
|
27
|
+
*/
|
|
28
|
+
poll(options?: {
|
|
29
|
+
abortSignal?: AbortSignalLike;
|
|
30
|
+
}): Promise<TState>;
|
|
31
|
+
/**
|
|
32
|
+
* Returns a promise that will resolve once the underlying operation is completed.
|
|
33
|
+
*/
|
|
34
|
+
pollUntilDone(pollOptions?: {
|
|
35
|
+
abortSignal?: AbortSignalLike;
|
|
36
|
+
}): Promise<TResult>;
|
|
37
|
+
/**
|
|
38
|
+
* Invokes the provided callback after each polling is completed,
|
|
39
|
+
* sending the current state of the poller's operation.
|
|
40
|
+
*
|
|
41
|
+
* It returns a method that can be used to stop receiving updates on the given callback function.
|
|
42
|
+
*/
|
|
43
|
+
onProgress(callback: (state: TState) => void): CancelOnProgress;
|
|
44
|
+
/**
|
|
45
|
+
* Returns a promise that could be used for serialized version of the poller's operation
|
|
46
|
+
* by invoking the operation's serialize method.
|
|
47
|
+
*/
|
|
48
|
+
serialize(): Promise<string>;
|
|
49
|
+
/**
|
|
50
|
+
* Wait the poller to be submitted.
|
|
51
|
+
*/
|
|
52
|
+
submitted(): Promise<void>;
|
|
53
|
+
/**
|
|
54
|
+
* Returns a string representation of the poller's operation. Similar to serialize but returns a string.
|
|
55
|
+
* @deprecated Use serialize() instead.
|
|
56
|
+
*/
|
|
57
|
+
toString(): string;
|
|
58
|
+
/**
|
|
59
|
+
* Stops the poller from continuing to poll. Please note this will only stop the client-side polling
|
|
60
|
+
* @deprecated Use abortSignal to stop polling instead.
|
|
61
|
+
*/
|
|
62
|
+
stopPolling(): void;
|
|
63
|
+
/**
|
|
64
|
+
* Returns true if the poller is stopped.
|
|
65
|
+
* @deprecated Use abortSignal status to track this instead.
|
|
66
|
+
*/
|
|
67
|
+
isStopped(): boolean;
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Helper function that builds a Poller object to help polling a long running operation.
|
|
71
|
+
* @param client - Client to use for sending the request to get additional pages.
|
|
72
|
+
* @param initialResponse - The initial response.
|
|
73
|
+
* @param options - Options to set a resume state or custom polling interval.
|
|
74
|
+
* @returns - A poller object to poll for operation state updates and eventually get the final response.
|
|
75
|
+
*/
|
|
76
|
+
export declare function getLongRunningPoller<TResult extends CreateDevBoxLogicalResponse | CreateDevBoxDefaultResponse>(client: Client, initialResponse: CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
77
|
+
export declare function getLongRunningPoller<TResult extends DeleteDevBoxLogicalResponse | DeleteDevBoxDefaultResponse>(client: Client, initialResponse: DeleteDevBox202Response | DeleteDevBox204Response | DeleteDevBoxDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
78
|
+
export declare function getLongRunningPoller<TResult extends StartDevBoxLogicalResponse | StartDevBoxDefaultResponse>(client: Client, initialResponse: StartDevBox202Response | StartDevBoxDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
79
|
+
export declare function getLongRunningPoller<TResult extends StopDevBoxLogicalResponse | StopDevBoxDefaultResponse>(client: Client, initialResponse: StopDevBox202Response | StopDevBoxDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
80
|
+
export declare function getLongRunningPoller<TResult extends RestartDevBoxLogicalResponse | RestartDevBoxDefaultResponse>(client: Client, initialResponse: RestartDevBox202Response | RestartDevBoxDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
81
|
+
export declare function getLongRunningPoller<TResult extends CreateOrReplaceEnvironmentLogicalResponse | CreateOrReplaceEnvironmentDefaultResponse>(client: Client, initialResponse: CreateOrReplaceEnvironment201Response | CreateOrReplaceEnvironmentDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
82
|
+
export declare function getLongRunningPoller<TResult extends DeleteEnvironmentLogicalResponse | DeleteEnvironmentDefaultResponse>(client: Client, initialResponse: DeleteEnvironment202Response | DeleteEnvironment204Response | DeleteEnvironmentDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
83
|
+
//# sourceMappingURL=pollingHelper.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pollingHelper.d.ts","sourceRoot":"","sources":["../../src/pollingHelper.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAgB,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EAGvB,cAAc,EAEf,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAC3B,uBAAuB,EACvB,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAC3B,sBAAsB,EACtB,0BAA0B,EAC1B,0BAA0B,EAC1B,qBAAqB,EACrB,yBAAyB,EACzB,yBAAyB,EACzB,wBAAwB,EACxB,4BAA4B,EAC5B,4BAA4B,EAC5B,qCAAqC,EACrC,yCAAyC,EACzC,yCAAyC,EACzC,4BAA4B,EAC5B,4BAA4B,EAC5B,gCAAgC,EAChC,gCAAgC,EACjC,MAAM,gBAAgB,CAAC;AAExB;;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,CACxC,OAAO,SAAS,2BAA2B,GAAG,2BAA2B,EAEzE,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,uBAAuB,GAAG,uBAAuB,GAAG,2BAA2B,EAChG,OAAO,CAAC,EAAE,uBAAuB,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,GAClE,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/D,wBAAsB,oBAAoB,CACxC,OAAO,SAAS,2BAA2B,GAAG,2BAA2B,EAEzE,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,uBAAuB,GAAG,uBAAuB,GAAG,2BAA2B,EAChG,OAAO,CAAC,EAAE,uBAAuB,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,GAClE,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/D,wBAAsB,oBAAoB,CACxC,OAAO,SAAS,0BAA0B,GAAG,0BAA0B,EAEvE,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,sBAAsB,GAAG,0BAA0B,EACpE,OAAO,CAAC,EAAE,uBAAuB,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,GAClE,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/D,wBAAsB,oBAAoB,CACxC,OAAO,SAAS,yBAAyB,GAAG,yBAAyB,EAErE,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,qBAAqB,GAAG,yBAAyB,EAClE,OAAO,CAAC,EAAE,uBAAuB,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,GAClE,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/D,wBAAsB,oBAAoB,CACxC,OAAO,SAAS,4BAA4B,GAAG,4BAA4B,EAE3E,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,wBAAwB,GAAG,4BAA4B,EACxE,OAAO,CAAC,EAAE,uBAAuB,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,GAClE,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/D,wBAAsB,oBAAoB,CACxC,OAAO,SACH,yCAAyC,GACzC,yCAAyC,EAE7C,MAAM,EAAE,MAAM,EACd,eAAe,EACX,qCAAqC,GACrC,yCAAyC,EAC7C,OAAO,CAAC,EAAE,uBAAuB,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,GAClE,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/D,wBAAsB,oBAAoB,CACxC,OAAO,SAAS,gCAAgC,GAAG,gCAAgC,EAEnF,MAAM,EAAE,MAAM,EACd,eAAe,EACX,4BAA4B,GAC5B,4BAA4B,GAC5B,gCAAgC,EACpC,OAAO,CAAC,EAAE,uBAAuB,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,GAClE,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
import { createHttpPoller, } from "@azure/core-lro";
|
|
4
|
+
export async function getLongRunningPoller(client, initialResponse, options = {}) {
|
|
5
|
+
var _a;
|
|
6
|
+
const abortController = new AbortController();
|
|
7
|
+
const poller = {
|
|
8
|
+
sendInitialRequest: async () => {
|
|
9
|
+
// In the case of Rest Clients we are building the LRO poller object from a response that's the reason
|
|
10
|
+
// we are not triggering the initial request here, just extracting the information from the
|
|
11
|
+
// response we were provided.
|
|
12
|
+
return getLroResponse(initialResponse);
|
|
13
|
+
},
|
|
14
|
+
sendPollRequest: async (path, pollOptions) => {
|
|
15
|
+
// This is the callback that is going to be called to poll the service
|
|
16
|
+
// to get the latest status. We use the client provided and the polling path
|
|
17
|
+
// which is an opaque URL provided by caller, the service sends this in one of the following headers: operation-location, azure-asyncoperation or location
|
|
18
|
+
// depending on the lro pattern that the service implements. If non is provided we default to the initial path.
|
|
19
|
+
function abortListener() {
|
|
20
|
+
abortController.abort();
|
|
21
|
+
}
|
|
22
|
+
const inputAbortSignal = pollOptions === null || pollOptions === void 0 ? void 0 : pollOptions.abortSignal;
|
|
23
|
+
const abortSignal = abortController.signal;
|
|
24
|
+
if (inputAbortSignal === null || inputAbortSignal === void 0 ? void 0 : inputAbortSignal.aborted) {
|
|
25
|
+
abortController.abort();
|
|
26
|
+
}
|
|
27
|
+
else if (!abortSignal.aborted) {
|
|
28
|
+
inputAbortSignal === null || inputAbortSignal === void 0 ? void 0 : inputAbortSignal.addEventListener("abort", abortListener, {
|
|
29
|
+
once: true,
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
let response;
|
|
33
|
+
try {
|
|
34
|
+
response = await client
|
|
35
|
+
.pathUnchecked(path !== null && path !== void 0 ? path : initialResponse.request.url)
|
|
36
|
+
.get({ abortSignal });
|
|
37
|
+
}
|
|
38
|
+
finally {
|
|
39
|
+
inputAbortSignal === null || inputAbortSignal === void 0 ? void 0 : inputAbortSignal.removeEventListener("abort", abortListener);
|
|
40
|
+
}
|
|
41
|
+
const lroResponse = getLroResponse(response);
|
|
42
|
+
lroResponse.rawResponse.headers["x-ms-original-url"] = initialResponse.request.url;
|
|
43
|
+
return lroResponse;
|
|
44
|
+
},
|
|
45
|
+
};
|
|
46
|
+
options.resolveOnUnsuccessful = (_a = options.resolveOnUnsuccessful) !== null && _a !== void 0 ? _a : true;
|
|
47
|
+
const httpPoller = createHttpPoller(poller, options);
|
|
48
|
+
const simplePoller = {
|
|
49
|
+
isDone() {
|
|
50
|
+
return httpPoller.isDone;
|
|
51
|
+
},
|
|
52
|
+
isStopped() {
|
|
53
|
+
return abortController.signal.aborted;
|
|
54
|
+
},
|
|
55
|
+
getOperationState() {
|
|
56
|
+
if (!httpPoller.operationState) {
|
|
57
|
+
throw new Error("Operation state is not available. The poller may not have been started and you could await submitted() before calling getOperationState().");
|
|
58
|
+
}
|
|
59
|
+
return httpPoller.operationState;
|
|
60
|
+
},
|
|
61
|
+
getResult() {
|
|
62
|
+
return httpPoller.result;
|
|
63
|
+
},
|
|
64
|
+
toString() {
|
|
65
|
+
if (!httpPoller.operationState) {
|
|
66
|
+
throw new Error("Operation state is not available. The poller may not have been started and you could await submitted() before calling getOperationState().");
|
|
67
|
+
}
|
|
68
|
+
return JSON.stringify({
|
|
69
|
+
state: httpPoller.operationState,
|
|
70
|
+
});
|
|
71
|
+
},
|
|
72
|
+
stopPolling() {
|
|
73
|
+
abortController.abort();
|
|
74
|
+
},
|
|
75
|
+
onProgress: httpPoller.onProgress,
|
|
76
|
+
poll: httpPoller.poll,
|
|
77
|
+
pollUntilDone: httpPoller.pollUntilDone,
|
|
78
|
+
serialize: httpPoller.serialize,
|
|
79
|
+
submitted: httpPoller.submitted,
|
|
80
|
+
};
|
|
81
|
+
return simplePoller;
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* Converts a Rest Client response to a response that the LRO implementation understands
|
|
85
|
+
* @param response - a rest client http response
|
|
86
|
+
* @returns - An LRO response that the LRO implementation understands
|
|
87
|
+
*/
|
|
88
|
+
function getLroResponse(response) {
|
|
89
|
+
if (Number.isNaN(response.status)) {
|
|
90
|
+
throw new TypeError(`Status code of the response is not a number. Value: ${response.status}`);
|
|
91
|
+
}
|
|
92
|
+
return {
|
|
93
|
+
flatResponse: response,
|
|
94
|
+
rawResponse: Object.assign(Object.assign({}, response), { statusCode: Number.parseInt(response.status), body: response.body }),
|
|
95
|
+
};
|
|
96
|
+
}
|
|
97
|
+
//# sourceMappingURL=pollingHelper.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pollingHelper.js","sourceRoot":"","sources":["../../src/pollingHelper.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAML,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AA6JzB,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 { Client, HttpResponse } from \"@azure-rest/core-client\";\nimport { AbortSignalLike } from \"@azure/abort-controller\";\nimport {\n CancelOnProgress,\n CreateHttpPollerOptions,\n RunningOperation,\n OperationResponse,\n OperationState,\n createHttpPoller,\n} from \"@azure/core-lro\";\nimport {\n CreateDevBox200Response,\n CreateDevBox201Response,\n CreateDevBoxDefaultResponse,\n CreateDevBoxLogicalResponse,\n DeleteDevBox202Response,\n DeleteDevBox204Response,\n DeleteDevBoxDefaultResponse,\n DeleteDevBoxLogicalResponse,\n StartDevBox202Response,\n StartDevBoxDefaultResponse,\n StartDevBoxLogicalResponse,\n StopDevBox202Response,\n StopDevBoxDefaultResponse,\n StopDevBoxLogicalResponse,\n RestartDevBox202Response,\n RestartDevBoxDefaultResponse,\n RestartDevBoxLogicalResponse,\n CreateOrReplaceEnvironment201Response,\n CreateOrReplaceEnvironmentDefaultResponse,\n CreateOrReplaceEnvironmentLogicalResponse,\n DeleteEnvironment202Response,\n DeleteEnvironment204Response,\n DeleteEnvironmentDefaultResponse,\n DeleteEnvironmentLogicalResponse,\n} from \"./responses.js\";\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<\n TResult extends CreateDevBoxLogicalResponse | CreateDevBoxDefaultResponse,\n>(\n client: Client,\n initialResponse: CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse,\n options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>,\n): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;\nexport async function getLongRunningPoller<\n TResult extends DeleteDevBoxLogicalResponse | DeleteDevBoxDefaultResponse,\n>(\n client: Client,\n initialResponse: DeleteDevBox202Response | DeleteDevBox204Response | DeleteDevBoxDefaultResponse,\n options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>,\n): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;\nexport async function getLongRunningPoller<\n TResult extends StartDevBoxLogicalResponse | StartDevBoxDefaultResponse,\n>(\n client: Client,\n initialResponse: StartDevBox202Response | StartDevBoxDefaultResponse,\n options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>,\n): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;\nexport async function getLongRunningPoller<\n TResult extends StopDevBoxLogicalResponse | StopDevBoxDefaultResponse,\n>(\n client: Client,\n initialResponse: StopDevBox202Response | StopDevBoxDefaultResponse,\n options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>,\n): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;\nexport async function getLongRunningPoller<\n TResult extends RestartDevBoxLogicalResponse | RestartDevBoxDefaultResponse,\n>(\n client: Client,\n initialResponse: RestartDevBox202Response | RestartDevBoxDefaultResponse,\n options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>,\n): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;\nexport async function getLongRunningPoller<\n TResult extends\n | CreateOrReplaceEnvironmentLogicalResponse\n | CreateOrReplaceEnvironmentDefaultResponse,\n>(\n client: Client,\n initialResponse:\n | CreateOrReplaceEnvironment201Response\n | CreateOrReplaceEnvironmentDefaultResponse,\n options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>,\n): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;\nexport async function getLongRunningPoller<\n TResult extends DeleteEnvironmentLogicalResponse | DeleteEnvironmentDefaultResponse,\n>(\n client: Client,\n initialResponse:\n | DeleteEnvironment202Response\n | DeleteEnvironment204Response\n | DeleteEnvironmentDefaultResponse,\n options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>,\n): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;\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"]}
|