@azure-rest/developer-devcenter 1.0.0-beta.2 → 1.0.0-beta.3

package/README.md

@@ -1,4 +1,5 @@
-# AzureDevCenter client library for JavaScript
+# Azure DevCenter REST client library for JavaScript
+
 
 The Azure DevCenter library provides access to manage resources for Microsoft Dev Box and Azure Deployment Environments. This package enables managing developer machines and environments in Azure.
 
@@ -6,6 +7,7 @@ Use the package for Azure DevCenter to:
 > Create, access, manage, and delete Dev Box resources
 > Create, deploy, manage, and delete Environment resources
 
+DevCenter service
 
 **Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
 
@@ -13,30 +15,30 @@ Key links:
 
 - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/devcenter/developer-devcenter-rest)
 - [Package (NPM)](https://www.npmjs.com/package/@azure-rest/developer-devcenter)
-- [API reference documentation](https://learn.microsoft.com/azure/dev-box)
+- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/developer-devcenter?view=azure-node-preview)
 - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/devcenter/developer-devcenter-rest/samples)
 
 ## Getting started
 
 ### Currently supported environments
 
-- Node.js version 14.x.x or higher
+- LTS versions of Node.js
 
 ### Prerequisites
 
 - You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
 - You must have [configured](https://learn.microsoft.com/azure/dev-box/quickstart-configure-dev-box-service) a DevCenter, Project, Network Connection, Dev Box Definition, and Pool before you can create Dev Boxes 
 - You must have [configured](https://learn.microsoft.com/azure/deployment-environments/) a DevCenter, Project, Catalog, and Environment Type before you can create Environments
-
+ 
 ### Install the `@azure-rest/developer-devcenter` package
 
-Install the AzureDevCenter client REST client library for JavaScript with `npm`:
+Install the Azure DevCenter REST client REST client library for JavaScript with `npm`:
 
 ```bash
 npm install @azure-rest/developer-devcenter
 ```
 
-### Create and authenticate to the Azure DevCenter service
+### Create and authenticate a `AzureDeveloperDevCenterClient`
 
 To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
 provide an instance of the desired credential type obtained from the
@@ -48,8 +50,8 @@ After setup, you can choose which type of [credential](https://github.com/Azure/
 As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
 can be used to authenticate the client.
 
-Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
-AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
+Set the value of dev center endpoint as environment variable:
+DEVCENTER_ENDPOINT
 
 ## Key Concepts
 
@@ -69,10 +71,9 @@ Environments refer to templated developer environments, which combine a template
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
 ```javascript
-import { setLogLevel } from "@azure/logger";
+const { setLogLevel } = require("@azure/logger");
 
 setLogLevel("info");
 ```
 
 For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
-

package/dist/index.js

@@ -3,28 +3,36 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var coreClient = require('@azure-rest/core-client');
+var logger$1 = require('@azure/logger');
 var corePaging = require('@azure/core-paging');
 var coreLro = require('@azure/core-lro');
 
 // Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const logger = logger$1.createClientLogger("developer-devcenter");
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
 /**
- * Initialize a new instance of the class AzureDevCenterClient class.
- * @param endpoint type: string The DevCenter-specific URI to operate on.
- * @param credentials type: TokenCredential
+ * Initialize a new instance of `AzureDeveloperDevCenterClient`
+ * @param endpoint - The DevCenter-specific URI to operate on.
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
  */
 function createClient(endpoint, credentials, options = {}) {
-    var _a, _b;
+    var _a, _b, _c, _d, _e, _f;
     const baseUrl = (_a = options.baseUrl) !== null && _a !== void 0 ? _a : `${endpoint}`;
-    options.apiVersion = (_b = options.apiVersion) !== null && _b !== void 0 ? _b : "2022-11-11-preview";
-    options = Object.assign(Object.assign({}, options), { credentials: {
-            scopes: ["https://devcenter.azure.com/.default"]
-        } });
+    options.apiVersion = (_b = options.apiVersion) !== null && _b !== void 0 ? _b : "2023-04-01";
     const userAgentInfo = `azsdk-js-developer-devcenter-rest/1.0.0-beta.3`;
     const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
         : `${userAgentInfo}`;
     options = Object.assign(Object.assign({}, options), { userAgentOptions: {
-            userAgentPrefix
+            userAgentPrefix,
+        }, loggingOptions: {
+            logger: (_d = (_c = options.loggingOptions) === null || _c === void 0 ? void 0 : _c.logger) !== null && _d !== void 0 ? _d : logger.info,
+        }, credentials: {
+            scopes: (_f = (_e = options.credentials) === null || _e === void 0 ? void 0 : _e.scopes) !== null && _f !== void 0 ? _f : ["https://devcenter.azure.com/.default"],
         } });
     const client = coreClient.getClient(baseUrl, credentials, options);
     return client;
@@ -35,91 +43,46 @@ function createClient(endpoint, credentials, options = {}) {
 const responseMap = {
     "GET /projects": ["200"],
     "GET /projects/{projectName}": ["200"],
-    "GET /devboxes": ["200"],
-    "GET /users/{userId}/devboxes": ["200"],
+    "GET /projects/{projectName}/operationstatuses/{operationId}": ["200"],
     "GET /projects/{projectName}/pools": ["200"],
     "GET /projects/{projectName}/pools/{poolName}": ["200"],
     "GET /projects/{projectName}/pools/{poolName}/schedules": ["200"],
-    "GET /projects/{projectName}/pools/{poolName}/schedules/{scheduleName}": [
-        "200"
-    ],
+    "GET /projects/{projectName}/pools/{poolName}/schedules/{scheduleName}": ["200"],
     "GET /projects/{projectName}/users/{userId}/devboxes": ["200"],
     "GET /projects/{projectName}/users/{userId}/devboxes/{devBoxName}": ["200"],
-    "PUT /projects/{projectName}/users/{userId}/devboxes/{devBoxName}": [
-        "200",
-        "201"
-    ],
-    "DELETE /projects/{projectName}/users/{userId}/devboxes/{devBoxName}": [
-        "202",
-        "204"
-    ],
-    "POST /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:start": [
-        "202"
-    ],
-    "GET /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:start": [
-        "202"
-    ],
-    "POST /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:stop": [
-        "202"
-    ],
-    "GET /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:stop": [
-        "202"
-    ],
-    "GET /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/remoteConnection": [
-        "200"
-    ],
-    "GET /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions": [
-        "200"
-    ],
-    "GET /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions/{upcomingActionId}": [
-        "200"
-    ],
-    "POST /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions/{upcomingActionId}:skip": [
-        "204"
+    "PUT /projects/{projectName}/users/{userId}/devboxes/{devBoxName}": ["200", "201"],
+    "DELETE /projects/{projectName}/users/{userId}/devboxes/{devBoxName}": ["202", "204"],
+    "POST /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:start": ["202"],
+    "GET /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:start": ["200", "202"],
+    "POST /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:stop": ["202"],
+    "GET /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:stop": ["200", "202"],
+    "POST /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restart": ["202"],
+    "GET /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restart": ["200", "202"],
+    "GET /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/remoteConnection": ["200"],
+    "GET /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions": ["200"],
+    "GET /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}": ["200"],
+    "POST /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:skip": [
+        "204",
     ],
-    "POST /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions/{upcomingActionId}:delay": [
-        "200"
+    "POST /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:delay": [
+        "200",
     ],
+    "POST /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions:delay": ["200"],
+    "GET /devboxes": ["200"],
+    "GET /users/{userId}/devboxes": ["200"],
     "GET /projects/{projectName}/environments": ["200"],
     "GET /projects/{projectName}/users/{userId}/environments": ["200"],
-    "GET /projects/{projectName}/users/{userId}/environments/{environmentName}": [
-        "200"
-    ],
-    "PUT /projects/{projectName}/users/{userId}/environments/{environmentName}": [
-        "200",
-        "201"
-    ],
-    "PATCH /projects/{projectName}/users/{userId}/environments/{environmentName}": [
-        "200"
-    ],
-    "DELETE /projects/{projectName}/users/{userId}/environments/{environmentName}": [
-        "200",
-        "202",
-        "204"
-    ],
-    "POST /projects/{projectName}/users/{userId}/environments/{environmentName}:deploy": [
-        "200",
-        "202"
-    ],
-    "GET /projects/{projectName}/users/{userId}/environments/{environmentName}:deploy": [
+    "GET /projects/{projectName}/users/{userId}/environments/{environmentName}": ["200"],
+    "PUT /projects/{projectName}/users/{userId}/environments/{environmentName}": ["201"],
+    "DELETE /projects/{projectName}/users/{userId}/environments/{environmentName}": ["202", "204"],
+    "GET /projects/{projectName}/catalogs": ["200"],
+    "GET /projects/{projectName}/catalogs/{catalogName}": ["200"],
+    "GET /projects/{projectName}/environmentDefinitions": ["200"],
+    "GET /projects/{projectName}/catalogs/{catalogName}/environmentDefinitions": ["200"],
+    "GET /projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{definitionName}": [
         "200",
-        "202"
     ],
-    "POST /projects/{projectName}/users/{userId}/environments/{environmentName}:custom": [
-        "200",
-        "202"
-    ],
-    "GET /projects/{projectName}/users/{userId}/environments/{environmentName}:custom": [
-        "200",
-        "202"
-    ],
-    "GET /projects/{projectName}/catalogItems": ["200"],
-    "GET /projects/{projectName}/catalogItems/{catalogItemId}": ["200"],
-    "GET /projects/{projectName}/catalogItems/{catalogItemId}/versions": ["200"],
-    "GET /projects/{projectName}/catalogItems/{catalogItemId}/versions/{version}": [
-        "200"
-    ],
-    "GET /projects/{projectName}/environmentTypes": ["200"]
+    "GET /projects/{projectName}/environmentTypes": ["200"],
 };
 function isUnexpected(response) {
     const lroOriginal = response.headers["x-ms-original-url"];
@@ -127,13 +90,17 @@ function isUnexpected(response) {
     const method = response.request.method;
     let pathDetails = responseMap[`${method} ${url.pathname}`];
     if (!pathDetails) {
-        pathDetails = geParametrizedPathSuccess(method, url.pathname);
+        pathDetails = getParametrizedPathSuccess(method, url.pathname);
     }
     return !pathDetails.includes(response.status);
 }
-function geParametrizedPathSuccess(method, path) {
-    var _a, _b;
+function getParametrizedPathSuccess(method, path) {
+    var _a, _b, _c, _d;
     const pathParts = path.split("/");
+    // Traverse list to match the longest candidate
+    // matchedLen: the length of candidate path
+    // matchedValue: the matched status code array
+    let matchedLen = -1, matchedValue = [];
     // Iterate the responseMap to find a match
     for (const [key, value] of Object.entries(responseMap)) {
         // Extracting the path from the map key which is in format
@@ -144,41 +111,38 @@ function geParametrizedPathSuccess(method, path) {
         const candidatePath = getPathFromMapKey(key);
         // Get each part of the url path
         const candidateParts = candidatePath.split("/");
-        // If the candidate and actual paths don't match in size
-        // we move on to the next candidate path
-        if (candidateParts.length === pathParts.length &&
-            hasParametrizedPath(key)) {
-            // track if we have found a match to return the values found.
-            let found = true;
-            for (let i = 0; i < candidateParts.length; i++) {
-                if (((_a = candidateParts[i]) === null || _a === void 0 ? void 0 : _a.startsWith("{")) &&
-                    ((_b = candidateParts[i]) === null || _b === void 0 ? void 0 : _b.endsWith("}"))) {
-                    // If the current part of the candidate is a "template" part
-                    // it is a match with the actual path part on hand
-                    // skip as the parameterized part can match anything
-                    continue;
-                }
-                // If the candidate part is not a template and
-                // the parts don't match mark the candidate as not found
-                // to move on with the next candidate path.
-                if (candidateParts[i] !== pathParts[i]) {
+        // track if we have found a match to return the values found.
+        let found = true;
+        for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {
+            if (((_a = candidateParts[i]) === null || _a === void 0 ? void 0 : _a.startsWith("{")) && ((_b = candidateParts[i]) === null || _b === void 0 ? void 0 : _b.indexOf("}")) !== -1) {
+                const start = candidateParts[i].indexOf("}") + 1, end = (_c = candidateParts[i]) === null || _c === void 0 ? void 0 : _c.length;
+                // If the current part of the candidate is a "template" part
+                // Try to use the suffix of pattern to match the path
+                // {guid} ==> $
+                // {guid}:export ==> :export$
+                const isMatched = new RegExp(`${(_d = candidateParts[i]) === null || _d === void 0 ? void 0 : _d.slice(start, end)}`).test(pathParts[j] || "");
+                if (!isMatched) {
                     found = false;
                     break;
                 }
+                continue;
             }
-            // We finished evaluating the current candidate parts
-            // if all parts matched we return the success values form
-            // the path mapping.
-            if (found) {
-                return value;
+            // If the candidate part is not a template and
+            // the parts don't match mark the candidate as not found
+            // to move on with the next candidate path.
+            if (candidateParts[i] !== pathParts[j]) {
+                found = false;
+                break;
             }
         }
+        // We finished evaluating the current candidate parts
+        // Update the matched value if and only if we found the longer pattern
+        if (found && candidatePath.length > matchedLen) {
+            matchedLen = candidatePath.length;
+            matchedValue = value;
+        }
     }
-    // No match was found, return an empty array.
-    return [];
-}
-function hasParametrizedPath(path) {
-    return path.includes("/{");
+    return matchedValue;
 }
 function getPathFromMapKey(mapKey) {
     const pathStart = mapKey.indexOf("/");
@@ -186,6 +150,7 @@ function getPathFromMapKey(mapKey) {
 }
 
 // Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
 /**
  * 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
@@ -203,18 +168,16 @@ function paginate(client, initialResponse, options = {}) {
         getPage: typeof customGetPage === "function"
             ? customGetPage
             : async (pageLink) => {
-                const result = firstRun
-                    ? initialResponse
-                    : await client.pathUnchecked(pageLink).get();
+                const result = firstRun ? initialResponse : await client.pathUnchecked(pageLink).get();
                 firstRun = false;
                 checkPagingRequest(result);
                 const nextLink = getNextLink(result.body, nextLinkName);
                 const values = getElements(result.body, itemName);
                 return {
                     page: values,
-                    nextPageLink: nextLink
+                    nextPageLink: nextLink,
                 };
-            }
+            },
     };
     return corePaging.getPagedAsyncIterator(pagedResult);
 }
@@ -248,32 +211,16 @@ function getElements(body, itemName) {
  * Checks if a request failed
  */
 function checkPagingRequest(response) {
-    const Http2xxStatusCodes = [
-        "200",
-        "201",
-        "202",
-        "203",
-        "204",
-        "205",
-        "206",
-        "207",
-        "208",
-        "226"
-    ];
+    const Http2xxStatusCodes = ["200", "201", "202", "203", "204", "205", "206", "207", "208", "226"];
     if (!Http2xxStatusCodes.includes(response.status)) {
         throw coreClient.createRestError(`Pagination failed with unexpected statusCode ${response.status}`, response);
     }
 }
 
 // Copyright (c) Microsoft Corporation.
-/**
- * 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.
- * @param initialResponse - The initial response.
- * @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.
- */
-function getLongRunningPoller(client, initialResponse, options = {}) {
+// Licensed under the MIT license.
+async function getLongRunningPoller(client, initialResponse, options = {}) {
+    var _a;
     const poller = {
         requestMethod: initialResponse.request.method,
         requestPath: initialResponse.request.url,
@@ -288,21 +235,19 @@ function getLongRunningPoller(client, initialResponse, options = {}) {
             // 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();
+            const response = await client.pathUnchecked(path !== null && path !== void 0 ? path : initialResponse.request.url).get();
             const lroResponse = getLroResponse(response);
-            lroResponse.rawResponse.headers["x-ms-original-url"] =
-                initialResponse.request.url;
+            lroResponse.rawResponse.headers["x-ms-original-url"] = initialResponse.request.url;
             return lroResponse;
-        }
+        },
     };
-    return new coreLro.LroEngine(poller, options);
+    options.resolveOnUnsuccessful = (_a = options.resolveOnUnsuccessful) !== null && _a !== void 0 ? _a : true;
+    return coreLro.createHttpPoller(poller, options);
 }
 /**
- * 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)) {
@@ -310,13 +255,14 @@ function getLroResponse(response) {
     }
     return {
         flatResponse: response,
-        rawResponse: Object.assign(Object.assign({}, response), { statusCode: Number.parseInt(response.status), body: response.body })
+        rawResponse: Object.assign(Object.assign({}, response), { statusCode: Number.parseInt(response.status), body: response.body }),
     };
 }
 
 // Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
 
-exports["default"] = createClient;
+exports.default = createClient;
 exports.getLongRunningPoller = getLongRunningPoller;
 exports.isUnexpected = isUnexpected;
 exports.paginate = paginate;