@azure-rest/purview-workflow 1.0.0-beta.1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Microsoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,162 @@
+# Azure Purview Workflow Rest-Level client library for JavaScript
+
+Workflows are automated, repeatable business processes that users can create within Microsoft Purview to validate and orchestrate CUD (create, update, delete) operations on their data entities. Enabling these processes allow organizations to track changes, enforce policy compliance, and ensure quality data across their data landscape.
+
+Use the client library for Purview Workflow to:
+
+- Manage workflows
+- Submit user requests and monitor workflow runs
+- View and respond to workflow tasks
+
+**For more details about how to use workflow, please refer to the [service documentation][product_documentation]**
+
+## Getting started
+
+### Currently supported environments
+
+- Node.js version 14.x.x or higher
+
+### Prerequisites
+
+- You must have an [Azure subscription][azure_subscription] and a [Purview resource][purview_resource] to use this package.
+
+### Create and authenticate a `PurviewWorkflowClient`
+
+Since the Workflow service uses an Azure Active Directory (AAD) bearer token for authentication and identification, an email address should be encoded into the token to allow for notification when using Workflow. It is recommended that the [Azure Identity][azure_identity] library be used  with a the [UsernamePasswordCredential][username_password_credential]. Before using the [Azure Identity][azure_identity] library with Workflow, [an application][app_registration] should be registered and used for the clientId passed to the [UsernamePasswordCredential][username_password_credential].
+Set the values of the client ID, tenant ID, username and password as environment variables:
+AZURE_CLIENT_ID, AZURE_TENANT_ID, USERNAME, PASSWORD
+
+```typescript
+import PurviewWorkflow from "@azure-rest/purview-workflow";
+import { UsernamePasswordCredential } from "@azure/identity";
+import * as dotenv from "dotenv";
+
+dotenv.config();
+
+const endpoint = process.env["ENDPOINT"];
+const tenantId = process.env["AZURE_TENANT_ID"];
+const clientId = process.env["AZURE_CLIENT_ID"];
+const username = process.env["USERNAME"];
+const password = process.env["PASSWORD"];
+const client = PurviewWorkflow(
+  endpoint,
+  new UsernamePasswordCredential(
+        tenantId,
+        clientId,
+        username,
+        password
+      )
+  );
+```
+
+## Examples
+
+The following section provides several code snippets covering some of the most common scenarios, including:
+
+- [Submit User Requests](#submit-user-requests)
+- [Approve Workflow Task](#approve-workflow-task)
+
+### Submit user requests
+
+```typescript
+import createPurviewWorkflowClient, {
+  SubmitUserRequestsParameters
+} from "@azure-rest/purview-workflow";
+import { UsernamePasswordCredential } from "@azure/identity";
+import * as dotenv from "dotenv";
+
+dotenv.config();
+
+async function userRequestsSubmit() {
+  const endpoint = process.env["ENDPOINT"];
+  const tenantId = process.env["AZURE_TENANT_ID"];
+  const clientId = process.env["AZURE_CLIENT_ID"];
+  const username = process.env["USERNAME"];
+  const password = process.env["PASSWORD"];
+
+  const credential = new UsernamePasswordCredential(tenantId , clientId, username, password);
+  const client = createPurviewWorkflowClient(endpoint, credential);
+  const options: SubmitUserRequestsParameters = {
+    body: {
+      comment: "Thanks!",
+      operations: [
+        {
+          type: "CreateTerm",
+          payload: {
+            glossaryTerm: {
+              name: "term",
+              anchor: { glossaryGuid: "20031e20-b4df-4a66-a61d-1b0716f3fa48" },
+              nickName: "term",
+              status: "Approved"
+            }
+          }
+        }
+      ]
+    }
+  };
+  const result = await client.path("/userrequests").post(options);
+  if (isUnexpected(result)) {
+    throw result.body.error;
+  }
+  console.log(result);
+}
+
+userRequestsSubmit().catch(console.error);
+```
+
+### Approve workflow task
+
+```typescript
+// This taskId represents an existing workflow task. The id can be obtained by calling GET /workflowtasks API.
+import createPurviewWorkflowClient, {
+  SubmitUserRequestsParameters
+} from "@azure-rest/purview-workflow";
+import { UsernamePasswordCredential } from "@azure/identity";
+import * as dotenv from "dotenv";
+
+dotenv.config();
+async function approvalTaskApprove() {
+  const endpoint = process.env["ENDPOINT"];
+  const tenantId = process.env["AZURE_TENANT_ID"];
+  const clientId = process.env["AZURE_CLIENT_ID"];
+  const username = process.env["USERNAME"];
+  const password = process.env["PASSWORD"];
+  const credential = new UsernamePasswordCredential(tenantId, clientId, username, password);
+  const client = createPurviewWorkflowClient(endpoint, credential);
+  const taskId = "98d98e2c-23fa-4157-a3f8-ff8ce5cc095c";
+  const options: ApproveApprovalTaskParameters = {
+    body: { comment: "Thanks for raising this!" }
+  };
+  const result = await client
+    .path("/workflowtasks/{taskId}/approve-approval", taskId)
+    .post(options);
+  if (isUnexpected(result)) {
+    throw result.body.error;
+  }
+  console.log(result);
+}
+
+approvalTaskApprove().catch(console.error);
+```
+
+## Troubleshooting
+
+### Logging
+
+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
+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).
+
+<!-- LINKS -->
+[product_documentation]: https://learn.microsoft.com/azure/purview/concept-workflow
+[azure_subscription]: https://azure.microsoft.com/free/dotnet/
+[purview_resource]: https://docs.microsoft.com/azure/purview/create-catalog-portal
+[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#readme
+[app_registration]: https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app
+[username_password_credential]: https://learn.microsoft.com/javascript/api/@azure/identity/usernamepasswordcredential?view=azure-node-latest

package/dist/index.js

@@ -0,0 +1,188 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var coreClient = require('@azure-rest/core-client');
+var corePaging = require('@azure/core-paging');
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * Initialize a new instance of `PurviewWorkflowClient`
+ * @param endpoint type: string, The account endpoint of your Purview account. Example: https://{accountName}.purview.azure.com/
+ * @param credentials type: TokenCredential, uniquely identify client credential
+ * @param options type: ClientOptions, the parameter for all optional parameters
+ */
+function createClient(endpoint, credentials, options = {}) {
+    var _a, _b;
+    const baseUrl = (_a = options.baseUrl) !== null && _a !== void 0 ? _a : `${endpoint}/workflow`;
+    options.apiVersion = (_b = options.apiVersion) !== null && _b !== void 0 ? _b : "2022-05-01-preview";
+    options = Object.assign(Object.assign({}, options), { credentials: {
+            scopes: ["https://purview.azure.net/.default"],
+        } });
+    const userAgentInfo = `azsdk-js-purview-workflow-rest/1.0.0-beta.1`;
+    const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+        ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
+        : `${userAgentInfo}`;
+    options = Object.assign(Object.assign({}, options), { userAgentOptions: {
+            userAgentPrefix,
+        } });
+    const client = coreClient.getClient(baseUrl, credentials, options);
+    return client;
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const responseMap = {
+    "GET /workflows": ["200"],
+    "GET /workflows/{workflowId}": ["200"],
+    "PUT /workflows/{workflowId}": ["200"],
+    "DELETE /workflows/{workflowId}": ["204"],
+    "POST /userrequests": ["200"],
+    "GET /workflowruns": ["200"],
+    "GET /workflowruns/{workflowRunId}": ["200"],
+    "POST /workflowruns/{workflowRunId}/cancel": ["200"],
+    "GET /workflowtasks": ["200"],
+    "GET /workflowtasks/{taskId}": ["200"],
+    "POST /workflowtasks/{taskId}/approve-approval": ["200"],
+    "POST /workflowtasks/{taskId}/reject-approval": ["200"],
+    "POST /workflowtasks/{taskId}/reassign": ["200"],
+    "POST /workflowtasks/{taskId}/change-task-status": ["200"],
+};
+function isUnexpected(response) {
+    const lroOriginal = response.headers["x-ms-original-url"];
+    const url = new URL(lroOriginal !== null && lroOriginal !== void 0 ? lroOriginal : response.request.url);
+    const method = response.request.method;
+    let pathDetails = responseMap[`${method} ${url.pathname}`];
+    if (!pathDetails) {
+        pathDetails = getParametrizedPathSuccess(method, url.pathname);
+    }
+    return !pathDetails.includes(response.status);
+}
+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
+        // GET /path/foo
+        if (!key.startsWith(method)) {
+            continue;
+        }
+        const candidatePath = getPathFromMapKey(key);
+        // Get each part of the url path
+        const candidateParts = candidatePath.split("/");
+        // 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;
+            }
+            // 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;
+        }
+    }
+    return matchedValue;
+}
+function getPathFromMapKey(mapKey) {
+    const pathStart = mapKey.indexOf("/");
+    return mapKey.slice(pathStart);
+}
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * 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
+ * @param initialResponse - Initial response containing the nextLink and current page of elements
+ * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
+ * @returns - PagedAsyncIterableIterator to iterate the elements
+ */
+function paginate(client, initialResponse, options = {}) {
+    let firstRun = true;
+    const itemName = "value";
+    const nextLinkName = "nextLink";
+    const { customGetPage } = options;
+    const pagedResult = {
+        firstPageLink: "",
+        getPage: typeof customGetPage === "function"
+            ? customGetPage
+            : async (pageLink) => {
+                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,
+                };
+            },
+    };
+    return corePaging.getPagedAsyncIterator(pagedResult);
+}
+/**
+ * Gets for the value of nextLink in the body
+ */
+function getNextLink(body, nextLinkName) {
+    if (!nextLinkName) {
+        return undefined;
+    }
+    const nextLink = body[nextLinkName];
+    if (typeof nextLink !== "string" && typeof nextLink !== "undefined") {
+        throw new Error(`Body Property ${nextLinkName} should be a string or undefined`);
+    }
+    return nextLink;
+}
+/**
+ * Gets the elements of the current request in the body.
+ */
+function getElements(body, itemName) {
+    const value = body[itemName];
+    // value has to be an array according to the x-ms-pageable extension.
+    // The fact that this must be an array is used above to calculate the
+    // type of elements in the page in PaginateReturn
+    if (!Array.isArray(value)) {
+        throw new Error(`Couldn't paginate response\n Body doesn't contain an array property with name: ${itemName}`);
+    }
+    return value !== null && value !== void 0 ? value : [];
+}
+/**
+ * Checks if a request failed
+ */
+function checkPagingRequest(response) {
+    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.
+
+exports["default"] = createClient;
+exports.isUnexpected = isUnexpected;
+exports.paginate = paginate;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/purviewWorkflow.ts","../src/isUnexpected.ts","../src/paginateHelper.ts","../src/index.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { getClient, ClientOptions } from \"@azure-rest/core-client\";\nimport { TokenCredential } from \"@azure/core-auth\";\nimport { PurviewWorkflowClient } from \"./clientDefinitions\";\n\n/**\n * Initialize a new instance of `PurviewWorkflowClient`\n * @param endpoint type: string, The account endpoint of your Purview account. Example: https://{accountName}.purview.azure.com/\n * @param credentials type: TokenCredential, uniquely identify client credential\n * @param options type: ClientOptions, the parameter for all optional parameters\n */\nexport default function createClient(\n  endpoint: string,\n  credentials: TokenCredential,\n  options: ClientOptions = {}\n): PurviewWorkflowClient {\n  const baseUrl = options.baseUrl ?? `${endpoint}/workflow`;\n  options.apiVersion = options.apiVersion ?? \"2022-05-01-preview\";\n  options = {\n    ...options,\n    credentials: {\n      scopes: [\"https://purview.azure.net/.default\"],\n    },\n  };\n\n  const userAgentInfo = `azsdk-js-purview-workflow-rest/1.0.0-beta.1`;\n  const userAgentPrefix =\n    options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n      ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`\n      : `${userAgentInfo}`;\n  options = {\n    ...options,\n    userAgentOptions: {\n      userAgentPrefix,\n    },\n  };\n\n  const client = getClient(baseUrl, credentials, options) as PurviewWorkflowClient;\n\n  return client;\n}\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n  ListWorkflows200Response,\n  ListWorkflowsDefaultResponse,\n  GetWorkflow200Response,\n  GetWorkflowDefaultResponse,\n  CreateOrReplaceWorkflow200Response,\n  CreateOrReplaceWorkflowDefaultResponse,\n  DeleteWorkflow204Response,\n  DeleteWorkflowDefaultResponse,\n  SubmitUserRequests200Response,\n  SubmitUserRequestsDefaultResponse,\n  ListWorkflowRuns200Response,\n  ListWorkflowRunsDefaultResponse,\n  GetWorkflowRun200Response,\n  GetWorkflowRunDefaultResponse,\n  CancelWorkflowRun200Response,\n  CancelWorkflowRunDefaultResponse,\n  ListWorkflowTasks200Response,\n  ListWorkflowTasksDefaultResponse,\n  GetWorkflowTask200Response,\n  GetWorkflowTaskDefaultResponse,\n  ApproveApprovalTask200Response,\n  ApproveApprovalTaskDefaultResponse,\n  RejectApprovalTask200Response,\n  RejectApprovalTaskDefaultResponse,\n  ReassignWorkflowTask200Response,\n  ReassignWorkflowTaskDefaultResponse,\n  UpdateTaskStatus200Response,\n  UpdateTaskStatusDefaultResponse,\n} from \"./responses\";\n\nconst responseMap: Record<string, string[]> = {\n  \"GET /workflows\": [\"200\"],\n  \"GET /workflows/{workflowId}\": [\"200\"],\n  \"PUT /workflows/{workflowId}\": [\"200\"],\n  \"DELETE /workflows/{workflowId}\": [\"204\"],\n  \"POST /userrequests\": [\"200\"],\n  \"GET /workflowruns\": [\"200\"],\n  \"GET /workflowruns/{workflowRunId}\": [\"200\"],\n  \"POST /workflowruns/{workflowRunId}/cancel\": [\"200\"],\n  \"GET /workflowtasks\": [\"200\"],\n  \"GET /workflowtasks/{taskId}\": [\"200\"],\n  \"POST /workflowtasks/{taskId}/approve-approval\": [\"200\"],\n  \"POST /workflowtasks/{taskId}/reject-approval\": [\"200\"],\n  \"POST /workflowtasks/{taskId}/reassign\": [\"200\"],\n  \"POST /workflowtasks/{taskId}/change-task-status\": [\"200\"],\n};\n\nexport function isUnexpected(\n  response: ListWorkflows200Response | ListWorkflowsDefaultResponse\n): response is ListWorkflowsDefaultResponse;\nexport function isUnexpected(\n  response: GetWorkflow200Response | GetWorkflowDefaultResponse\n): response is GetWorkflowDefaultResponse;\nexport function isUnexpected(\n  response: CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse\n): response is CreateOrReplaceWorkflowDefaultResponse;\nexport function isUnexpected(\n  response: DeleteWorkflow204Response | DeleteWorkflowDefaultResponse\n): response is DeleteWorkflowDefaultResponse;\nexport function isUnexpected(\n  response: SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse\n): response is SubmitUserRequestsDefaultResponse;\nexport function isUnexpected(\n  response: ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse\n): response is ListWorkflowRunsDefaultResponse;\nexport function isUnexpected(\n  response: GetWorkflowRun200Response | GetWorkflowRunDefaultResponse\n): response is GetWorkflowRunDefaultResponse;\nexport function isUnexpected(\n  response: CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse\n): response is CancelWorkflowRunDefaultResponse;\nexport function isUnexpected(\n  response: ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse\n): response is ListWorkflowTasksDefaultResponse;\nexport function isUnexpected(\n  response: GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse\n): response is GetWorkflowTaskDefaultResponse;\nexport function isUnexpected(\n  response: ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse\n): response is ApproveApprovalTaskDefaultResponse;\nexport function isUnexpected(\n  response: RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse\n): response is RejectApprovalTaskDefaultResponse;\nexport function isUnexpected(\n  response: ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse\n): response is ReassignWorkflowTaskDefaultResponse;\nexport function isUnexpected(\n  response: UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse\n): response is UpdateTaskStatusDefaultResponse;\nexport function isUnexpected(\n  response:\n    | ListWorkflows200Response\n    | ListWorkflowsDefaultResponse\n    | GetWorkflow200Response\n    | GetWorkflowDefaultResponse\n    | CreateOrReplaceWorkflow200Response\n    | CreateOrReplaceWorkflowDefaultResponse\n    | DeleteWorkflow204Response\n    | DeleteWorkflowDefaultResponse\n    | SubmitUserRequests200Response\n    | SubmitUserRequestsDefaultResponse\n    | ListWorkflowRuns200Response\n    | ListWorkflowRunsDefaultResponse\n    | GetWorkflowRun200Response\n    | GetWorkflowRunDefaultResponse\n    | CancelWorkflowRun200Response\n    | CancelWorkflowRunDefaultResponse\n    | ListWorkflowTasks200Response\n    | ListWorkflowTasksDefaultResponse\n    | GetWorkflowTask200Response\n    | GetWorkflowTaskDefaultResponse\n    | ApproveApprovalTask200Response\n    | ApproveApprovalTaskDefaultResponse\n    | RejectApprovalTask200Response\n    | RejectApprovalTaskDefaultResponse\n    | ReassignWorkflowTask200Response\n    | ReassignWorkflowTaskDefaultResponse\n    | UpdateTaskStatus200Response\n    | UpdateTaskStatusDefaultResponse\n): response is\n  | ListWorkflowsDefaultResponse\n  | GetWorkflowDefaultResponse\n  | CreateOrReplaceWorkflowDefaultResponse\n  | DeleteWorkflowDefaultResponse\n  | SubmitUserRequestsDefaultResponse\n  | ListWorkflowRunsDefaultResponse\n  | GetWorkflowRunDefaultResponse\n  | CancelWorkflowRunDefaultResponse\n  | ListWorkflowTasksDefaultResponse\n  | GetWorkflowTaskDefaultResponse\n  | ApproveApprovalTaskDefaultResponse\n  | RejectApprovalTaskDefaultResponse\n  | ReassignWorkflowTaskDefaultResponse\n  | UpdateTaskStatusDefaultResponse {\n  const lroOriginal = response.headers[\"x-ms-original-url\"];\n  const url = new URL(lroOriginal ?? response.request.url);\n  const method = response.request.method;\n  let pathDetails = responseMap[`${method} ${url.pathname}`];\n  if (!pathDetails) {\n    pathDetails = getParametrizedPathSuccess(method, url.pathname);\n  }\n  return !pathDetails.includes(response.status);\n}\n\nfunction getParametrizedPathSuccess(method: string, path: string): string[] {\n  const pathParts = path.split(\"/\");\n\n  // Traverse list to match the longest candidate\n  // matchedLen: the length of candidate path\n  // matchedValue: the matched status code array\n  let matchedLen = -1,\n    matchedValue: string[] = [];\n\n  // Iterate the responseMap to find a match\n  for (const [key, value] of Object.entries(responseMap)) {\n    // Extracting the path from the map key which is in format\n    // GET /path/foo\n    if (!key.startsWith(method)) {\n      continue;\n    }\n    const candidatePath = getPathFromMapKey(key);\n    // Get each part of the url path\n    const candidateParts = candidatePath.split(\"/\");\n\n    // track if we have found a match to return the values found.\n    let found = true;\n    for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {\n      if (candidateParts[i]?.startsWith(\"{\") && candidateParts[i]?.indexOf(\"}\") !== -1) {\n        const start = candidateParts[i]!.indexOf(\"}\") + 1,\n          end = candidateParts[i]?.length;\n        // If the current part of the candidate is a \"template\" part\n        // Try to use the suffix of pattern to match the path\n        // {guid} ==> $\n        // {guid}:export ==> :export$\n        const isMatched = new RegExp(`${candidateParts[i]?.slice(start, end)}`).test(\n          pathParts[j] || \"\"\n        );\n\n        if (!isMatched) {\n          found = false;\n          break;\n        }\n        continue;\n      }\n\n      // If the candidate part is not a template and\n      // the parts don't match mark the candidate as not found\n      // to move on with the next candidate path.\n      if (candidateParts[i] !== pathParts[j]) {\n        found = false;\n        break;\n      }\n    }\n\n    // We finished evaluating the current candidate parts\n    // Update the matched value if and only if we found the longer pattern\n    if (found && candidatePath.length > matchedLen) {\n      matchedLen = candidatePath.length;\n      matchedValue = value;\n    }\n  }\n\n  return matchedValue;\n}\n\nfunction getPathFromMapKey(mapKey: string): string {\n  const pathStart = mapKey.indexOf(\"/\");\n  return mapKey.slice(pathStart);\n}\n","// 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","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport PurviewWorkflow from \"./purviewWorkflow\";\n\nexport * from \"./purviewWorkflow\";\nexport * from \"./parameters\";\nexport * from \"./responses\";\nexport * from \"./clientDefinitions\";\nexport * from \"./isUnexpected\";\nexport * from \"./models\";\nexport * from \"./outputModels\";\nexport * from \"./paginateHelper\";\n\nexport default PurviewWorkflow;\n"],"names":["getClient","getPagedAsyncIterator","createRestError"],"mappings":";;;;;;;AAAA;AAOA;;;;;AAKG;AACW,SAAU,YAAY,CAClC,QAAgB,EAChB,WAA4B,EAC5B,OAAA,GAAyB,EAAE,EAAA;;IAE3B,MAAM,OAAO,GAAG,CAAA,EAAA,GAAA,OAAO,CAAC,OAAO,MAAI,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,EAAA,GAAA,CAAA,EAAG,QAAQ,CAAA,SAAA,CAAW,CAAC;IAC1D,OAAO,CAAC,UAAU,GAAG,CAAA,EAAA,GAAA,OAAO,CAAC,UAAU,MAAI,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,EAAA,GAAA,oBAAoB,CAAC;AAChE,IAAA,OAAO,GACF,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,OAAO,CACV,EAAA,EAAA,WAAW,EAAE;YACX,MAAM,EAAE,CAAC,oCAAoC,CAAC;AAC/C,SAAA,EAAA,CACF,CAAC;IAEF,MAAM,aAAa,GAAG,CAAA,2CAAA,CAA6C,CAAC;IACpE,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;UAChE,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,CAAI,CAAA,EAAA,aAAa,CAAE,CAAA;AAChE,UAAE,CAAA,EAAG,aAAa,CAAA,CAAE,CAAC;AACzB,IAAA,OAAO,GACF,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,OAAO,CACV,EAAA,EAAA,gBAAgB,EAAE;YAChB,eAAe;AAChB,SAAA,EAAA,CACF,CAAC;IAEF,MAAM,MAAM,GAAGA,oBAAS,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAA0B,CAAC;AAEjF,IAAA,OAAO,MAAM,CAAC;AAChB;;AC1CA;AACA;AAiCA,MAAM,WAAW,GAA6B;IAC5C,gBAAgB,EAAE,CAAC,KAAK,CAAC;IACzB,6BAA6B,EAAE,CAAC,KAAK,CAAC;IACtC,6BAA6B,EAAE,CAAC,KAAK,CAAC;IACtC,gCAAgC,EAAE,CAAC,KAAK,CAAC;IACzC,oBAAoB,EAAE,CAAC,KAAK,CAAC;IAC7B,mBAAmB,EAAE,CAAC,KAAK,CAAC;IAC5B,mCAAmC,EAAE,CAAC,KAAK,CAAC;IAC5C,2CAA2C,EAAE,CAAC,KAAK,CAAC;IACpD,oBAAoB,EAAE,CAAC,KAAK,CAAC;IAC7B,6BAA6B,EAAE,CAAC,KAAK,CAAC;IACtC,+CAA+C,EAAE,CAAC,KAAK,CAAC;IACxD,8CAA8C,EAAE,CAAC,KAAK,CAAC;IACvD,uCAAuC,EAAE,CAAC,KAAK,CAAC;IAChD,iDAAiD,EAAE,CAAC,KAAK,CAAC;CAC3D,CAAC;AA4CI,SAAU,YAAY,CAC1B,QA4BmC,EAAA;IAgBnC,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAC1D,IAAA,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,WAAW,KAAX,IAAA,IAAA,WAAW,KAAX,KAAA,CAAA,GAAA,WAAW,GAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AACzD,IAAA,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;AACvC,IAAA,IAAI,WAAW,GAAG,WAAW,CAAC,CAAG,EAAA,MAAM,CAAI,CAAA,EAAA,GAAG,CAAC,QAAQ,CAAE,CAAA,CAAC,CAAC;IAC3D,IAAI,CAAC,WAAW,EAAE;QAChB,WAAW,GAAG,0BAA0B,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;AAChE,KAAA;IACD,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,0BAA0B,CAAC,MAAc,EAAE,IAAY,EAAA;;IAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;;;;IAKlC,IAAI,UAAU,GAAG,CAAC,CAAC,EACjB,YAAY,GAAa,EAAE,CAAC;;AAG9B,IAAA,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;;;AAGtD,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YAC3B,SAAS;AACV,SAAA;AACD,QAAA,MAAM,aAAa,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;;QAE7C,MAAM,cAAc,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;;QAGhD,IAAI,KAAK,GAAG,IAAI,CAAC;AACjB,QAAA,KAAK,IAAI,CAAC,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE;YAC5F,IAAI,CAAA,CAAA,EAAA,GAAA,cAAc,CAAC,CAAC,CAAC,MAAA,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAE,UAAU,CAAC,GAAG,CAAC,KAAI,CAAA,MAAA,cAAc,CAAC,CAAC,CAAC,MAAE,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAO,CAAC,GAAG,CAAC,MAAK,CAAC,CAAC,EAAE;gBAChF,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAC/C,GAAG,GAAG,CAAA,EAAA,GAAA,cAAc,CAAC,CAAC,CAAC,MAAE,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,MAAM,CAAC;;;;;AAKlC,gBAAA,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC,CAAA,EAAG,CAAA,EAAA,GAAA,cAAc,CAAC,CAAC,CAAC,MAAA,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAE,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA,CAAE,CAAC,CAAC,IAAI,CAC1E,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CACnB,CAAC;gBAEF,IAAI,CAAC,SAAS,EAAE;oBACd,KAAK,GAAG,KAAK,CAAC;oBACd,MAAM;AACP,iBAAA;gBACD,SAAS;AACV,aAAA;;;;YAKD,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE;gBACtC,KAAK,GAAG,KAAK,CAAC;gBACd,MAAM;AACP,aAAA;AACF,SAAA;;;AAID,QAAA,IAAI,KAAK,IAAI,aAAa,CAAC,MAAM,GAAG,UAAU,EAAE;AAC9C,YAAA,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;YAClC,YAAY,GAAG,KAAK,CAAC;AACtB,SAAA;AACF,KAAA;AAED,IAAA,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAc,EAAA;IACvC,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AACtC,IAAA,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACjC;;ACpNA;AA6CA;;;;;;AAMG;AACG,SAAU,QAAQ,CACtB,MAAc,EACd,eAA0B,EAC1B,UAAoC,EAAE,EAAA;IAItC,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,MAAM,QAAQ,GAAG,OAAO,CAAC;IACzB,MAAM,YAAY,GAAG,UAAU,CAAC;AAChC,IAAA,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;AAClC,IAAA,MAAM,WAAW,GAA4B;AAC3C,QAAA,aAAa,EAAE,EAAE;AACjB,QAAA,OAAO,EACL,OAAO,aAAa,KAAK,UAAU;AACjC,cAAE,aAAa;AACf,cAAE,OAAO,QAAgB,KAAI;gBACzB,MAAM,MAAM,GAAG,QAAQ,GAAG,eAAe,GAAG,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;AACL,oBAAA,IAAI,EAAE,MAAM;AACZ,oBAAA,YAAY,EAAE,QAAQ;iBACvB,CAAC;aACH;KACR,CAAC;AAEF,IAAA,OAAOC,gCAAqB,CAAC,WAAW,CAAC,CAAC;AAC5C,CAAC;AAED;;AAEG;AACH,SAAS,WAAW,CAAC,IAAa,EAAE,YAAqB,EAAA;IACvD,IAAI,CAAC,YAAY,EAAE;AACjB,QAAA,OAAO,SAAS,CAAC;AAClB,KAAA;AAED,IAAA,MAAM,QAAQ,GAAI,IAAgC,CAAC,YAAY,CAAC,CAAC;IAEjE,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE;AACnE,QAAA,MAAM,IAAI,KAAK,CAAC,iBAAiB,YAAY,CAAA,gCAAA,CAAkC,CAAC,CAAC;AAClF,KAAA;AAED,IAAA,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;AAEG;AACH,SAAS,WAAW,CAAc,IAAa,EAAE,QAAgB,EAAA;AAC/D,IAAA,MAAM,KAAK,GAAI,IAAgC,CAAC,QAAQ,CAAQ,CAAC;;;;AAKjE,IAAA,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AACzB,QAAA,MAAM,IAAI,KAAK,CACb,kFAAkF,QAAQ,CAAA,CAAE,CAC7F,CAAC;AACH,KAAA;AAED,IAAA,OAAO,KAAK,KAAL,IAAA,IAAA,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC;AACrB,CAAC;AAED;;AAEG;AACH,SAAS,kBAAkB,CAAC,QAA+B,EAAA;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;QACjD,MAAMC,0BAAe,CACnB,CAAA,6CAAA,EAAgD,QAAQ,CAAC,MAAM,CAAE,CAAA,EACjE,QAAQ,CACT,CAAC;AACH,KAAA;AACH;;AClIA;;;;;;"}

package/dist-esm/src/clientDefinitions.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+export {};
+//# sourceMappingURL=clientDefinitions.js.map

package/dist-esm/src/clientDefinitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientDefinitions.js","sourceRoot":"","sources":["../../src/clientDefinitions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n  ListWorkflowsParameters,\n  GetWorkflowParameters,\n  CreateOrReplaceWorkflowParameters,\n  DeleteWorkflowParameters,\n  SubmitUserRequestsParameters,\n  ListWorkflowRunsParameters,\n  GetWorkflowRunParameters,\n  CancelWorkflowRunParameters,\n  ListWorkflowTasksParameters,\n  GetWorkflowTaskParameters,\n  ApproveApprovalTaskParameters,\n  RejectApprovalTaskParameters,\n  ReassignWorkflowTaskParameters,\n  UpdateTaskStatusParameters,\n} from \"./parameters\";\nimport {\n  ListWorkflows200Response,\n  ListWorkflowsDefaultResponse,\n  GetWorkflow200Response,\n  GetWorkflowDefaultResponse,\n  CreateOrReplaceWorkflow200Response,\n  CreateOrReplaceWorkflowDefaultResponse,\n  DeleteWorkflow204Response,\n  DeleteWorkflowDefaultResponse,\n  SubmitUserRequests200Response,\n  SubmitUserRequestsDefaultResponse,\n  ListWorkflowRuns200Response,\n  ListWorkflowRunsDefaultResponse,\n  GetWorkflowRun200Response,\n  GetWorkflowRunDefaultResponse,\n  CancelWorkflowRun200Response,\n  CancelWorkflowRunDefaultResponse,\n  ListWorkflowTasks200Response,\n  ListWorkflowTasksDefaultResponse,\n  GetWorkflowTask200Response,\n  GetWorkflowTaskDefaultResponse,\n  ApproveApprovalTask200Response,\n  ApproveApprovalTaskDefaultResponse,\n  RejectApprovalTask200Response,\n  RejectApprovalTaskDefaultResponse,\n  ReassignWorkflowTask200Response,\n  ReassignWorkflowTaskDefaultResponse,\n  UpdateTaskStatus200Response,\n  UpdateTaskStatusDefaultResponse,\n} from \"./responses\";\nimport { Client, StreamableMethod } from \"@azure-rest/core-client\";\n\nexport interface ListWorkflows {\n  /** List all workflows. */\n  get(\n    options?: ListWorkflowsParameters\n  ): StreamableMethod<ListWorkflows200Response | ListWorkflowsDefaultResponse>;\n}\n\nexport interface GetWorkflow {\n  /** Get a specific workflow. */\n  get(\n    options?: GetWorkflowParameters\n  ): StreamableMethod<GetWorkflow200Response | GetWorkflowDefaultResponse>;\n  /** Create or replace a workflow. */\n  put(\n    options: CreateOrReplaceWorkflowParameters\n  ): StreamableMethod<CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse>;\n  /** Delete a workflow. */\n  delete(\n    options?: DeleteWorkflowParameters\n  ): StreamableMethod<DeleteWorkflow204Response | DeleteWorkflowDefaultResponse>;\n}\n\nexport interface SubmitUserRequests {\n  /** Submit a user request for requestor, a user  request describes user ask to do operation(s) on Purview. If any workflow's trigger matches with an operation in request, a run of the workflow is created. */\n  post(\n    options: SubmitUserRequestsParameters\n  ): StreamableMethod<SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse>;\n}\n\nexport interface ListWorkflowRuns {\n  /** List workflow runs. */\n  get(\n    options?: ListWorkflowRunsParameters\n  ): StreamableMethod<ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse>;\n}\n\nexport interface GetWorkflowRun {\n  /** Get a workflow run. */\n  get(\n    options?: GetWorkflowRunParameters\n  ): StreamableMethod<GetWorkflowRun200Response | GetWorkflowRunDefaultResponse>;\n}\n\nexport interface CancelWorkflowRun {\n  /** Cancel a workflow run. */\n  post(\n    options: CancelWorkflowRunParameters\n  ): StreamableMethod<CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse>;\n}\n\nexport interface ListWorkflowTasks {\n  /** Get all workflow tasks. */\n  get(\n    options?: ListWorkflowTasksParameters\n  ): StreamableMethod<ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse>;\n}\n\nexport interface GetWorkflowTask {\n  /** Get a workflow task. */\n  get(\n    options?: GetWorkflowTaskParameters\n  ): StreamableMethod<GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse>;\n}\n\nexport interface ApproveApprovalTask {\n  /** Approve an approval task. */\n  post(\n    options: ApproveApprovalTaskParameters\n  ): StreamableMethod<ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse>;\n}\n\nexport interface RejectApprovalTask {\n  /** Reject an approval task. */\n  post(\n    options: RejectApprovalTaskParameters\n  ): StreamableMethod<RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse>;\n}\n\nexport interface ReassignWorkflowTask {\n  /** Reassign a workflow task. */\n  post(\n    options: ReassignWorkflowTaskParameters\n  ): StreamableMethod<ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse>;\n}\n\nexport interface UpdateTaskStatus {\n  /** Update the status of a workflow task request. */\n  post(\n    options: UpdateTaskStatusParameters\n  ): StreamableMethod<UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse>;\n}\n\nexport interface Routes {\n  /** Resource for '/workflows' has methods for the following verbs: get */\n  (path: \"/workflows\"): ListWorkflows;\n  /** Resource for '/workflows/\\{workflowId\\}' has methods for the following verbs: get, put, delete */\n  (path: \"/workflows/{workflowId}\", workflowId: string): GetWorkflow;\n  /** Resource for '/userrequests' has methods for the following verbs: post */\n  (path: \"/userrequests\"): SubmitUserRequests;\n  /** Resource for '/workflowruns' has methods for the following verbs: get */\n  (path: \"/workflowruns\"): ListWorkflowRuns;\n  /** Resource for '/workflowruns/\\{workflowRunId\\}' has methods for the following verbs: get */\n  (path: \"/workflowruns/{workflowRunId}\", workflowRunId: string): GetWorkflowRun;\n  /** Resource for '/workflowruns/\\{workflowRunId\\}/cancel' has methods for the following verbs: post */\n  (path: \"/workflowruns/{workflowRunId}/cancel\", workflowRunId: string): CancelWorkflowRun;\n  /** Resource for '/workflowtasks' has methods for the following verbs: get */\n  (path: \"/workflowtasks\"): ListWorkflowTasks;\n  /** Resource for '/workflowtasks/\\{taskId\\}' has methods for the following verbs: get */\n  (path: \"/workflowtasks/{taskId}\", taskId: string): GetWorkflowTask;\n  /** Resource for '/workflowtasks/\\{taskId\\}/approve-approval' has methods for the following verbs: post */\n  (path: \"/workflowtasks/{taskId}/approve-approval\", taskId: string): ApproveApprovalTask;\n  /** Resource for '/workflowtasks/\\{taskId\\}/reject-approval' has methods for the following verbs: post */\n  (path: \"/workflowtasks/{taskId}/reject-approval\", taskId: string): RejectApprovalTask;\n  /** Resource for '/workflowtasks/\\{taskId\\}/reassign' has methods for the following verbs: post */\n  (path: \"/workflowtasks/{taskId}/reassign\", taskId: string): ReassignWorkflowTask;\n  /** Resource for '/workflowtasks/\\{taskId\\}/change-task-status' has methods for the following verbs: post */\n  (path: \"/workflowtasks/{taskId}/change-task-status\", taskId: string): UpdateTaskStatus;\n}\n\nexport type PurviewWorkflowClient = Client & {\n  path: Routes;\n};\n"]}

package/dist-esm/src/index.js

@@ -0,0 +1,13 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import PurviewWorkflow from "./purviewWorkflow";
+export * from "./purviewWorkflow";
+export * from "./parameters";
+export * from "./responses";
+export * from "./clientDefinitions";
+export * from "./isUnexpected";
+export * from "./models";
+export * from "./outputModels";
+export * from "./paginateHelper";
+export default PurviewWorkflow;
+//# sourceMappingURL=index.js.map

package/dist-esm/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAEhD,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AAEjC,eAAe,eAAe,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport PurviewWorkflow from \"./purviewWorkflow\";\n\nexport * from \"./purviewWorkflow\";\nexport * from \"./parameters\";\nexport * from \"./responses\";\nexport * from \"./clientDefinitions\";\nexport * from \"./isUnexpected\";\nexport * from \"./models\";\nexport * from \"./outputModels\";\nexport * from \"./paginateHelper\";\n\nexport default PurviewWorkflow;\n"]}

package/dist-esm/src/isUnexpected.js

@@ -0,0 +1,83 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const responseMap = {
+    "GET /workflows": ["200"],
+    "GET /workflows/{workflowId}": ["200"],
+    "PUT /workflows/{workflowId}": ["200"],
+    "DELETE /workflows/{workflowId}": ["204"],
+    "POST /userrequests": ["200"],
+    "GET /workflowruns": ["200"],
+    "GET /workflowruns/{workflowRunId}": ["200"],
+    "POST /workflowruns/{workflowRunId}/cancel": ["200"],
+    "GET /workflowtasks": ["200"],
+    "GET /workflowtasks/{taskId}": ["200"],
+    "POST /workflowtasks/{taskId}/approve-approval": ["200"],
+    "POST /workflowtasks/{taskId}/reject-approval": ["200"],
+    "POST /workflowtasks/{taskId}/reassign": ["200"],
+    "POST /workflowtasks/{taskId}/change-task-status": ["200"],
+};
+export function isUnexpected(response) {
+    const lroOriginal = response.headers["x-ms-original-url"];
+    const url = new URL(lroOriginal !== null && lroOriginal !== void 0 ? lroOriginal : response.request.url);
+    const method = response.request.method;
+    let pathDetails = responseMap[`${method} ${url.pathname}`];
+    if (!pathDetails) {
+        pathDetails = getParametrizedPathSuccess(method, url.pathname);
+    }
+    return !pathDetails.includes(response.status);
+}
+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
+        // GET /path/foo
+        if (!key.startsWith(method)) {
+            continue;
+        }
+        const candidatePath = getPathFromMapKey(key);
+        // Get each part of the url path
+        const candidateParts = candidatePath.split("/");
+        // 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;
+            }
+            // 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;
+        }
+    }
+    return matchedValue;
+}
+function getPathFromMapKey(mapKey) {
+    const pathStart = mapKey.indexOf("/");
+    return mapKey.slice(pathStart);
+}
+//# sourceMappingURL=isUnexpected.js.map

package/dist-esm/src/isUnexpected.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isUnexpected.js","sourceRoot":"","sources":["../../src/isUnexpected.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAiClC,MAAM,WAAW,GAA6B;IAC5C,gBAAgB,EAAE,CAAC,KAAK,CAAC;IACzB,6BAA6B,EAAE,CAAC,KAAK,CAAC;IACtC,6BAA6B,EAAE,CAAC,KAAK,CAAC;IACtC,gCAAgC,EAAE,CAAC,KAAK,CAAC;IACzC,oBAAoB,EAAE,CAAC,KAAK,CAAC;IAC7B,mBAAmB,EAAE,CAAC,KAAK,CAAC;IAC5B,mCAAmC,EAAE,CAAC,KAAK,CAAC;IAC5C,2CAA2C,EAAE,CAAC,KAAK,CAAC;IACpD,oBAAoB,EAAE,CAAC,KAAK,CAAC;IAC7B,6BAA6B,EAAE,CAAC,KAAK,CAAC;IACtC,+CAA+C,EAAE,CAAC,KAAK,CAAC;IACxD,8CAA8C,EAAE,CAAC,KAAK,CAAC;IACvD,uCAAuC,EAAE,CAAC,KAAK,CAAC;IAChD,iDAAiD,EAAE,CAAC,KAAK,CAAC;CAC3D,CAAC;AA4CF,MAAM,UAAU,YAAY,CAC1B,QA4BmC;IAgBnC,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC1D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;IACvC,IAAI,WAAW,GAAG,WAAW,CAAC,GAAG,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3D,IAAI,CAAC,WAAW,EAAE;QAChB,WAAW,GAAG,0BAA0B,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;KAChE;IACD,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,0BAA0B,CAAC,MAAc,EAAE,IAAY;;IAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAElC,+CAA+C;IAC/C,2CAA2C;IAC3C,8CAA8C;IAC9C,IAAI,UAAU,GAAG,CAAC,CAAC,EACjB,YAAY,GAAa,EAAE,CAAC;IAE9B,0CAA0C;IAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QACtD,0DAA0D;QAC1D,gBAAgB;QAChB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YAC3B,SAAS;SACV;QACD,MAAM,aAAa,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC7C,gCAAgC;QAChC,MAAM,cAAc,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEhD,6DAA6D;QAC7D,IAAI,KAAK,GAAG,IAAI,CAAC;QACjB,KAAK,IAAI,CAAC,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE;YAC5F,IAAI,CAAA,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,UAAU,CAAC,GAAG,CAAC,KAAI,CAAA,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,OAAO,CAAC,GAAG,CAAC,MAAK,CAAC,CAAC,EAAE;gBAChF,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAC/C,GAAG,GAAG,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,MAAM,CAAC;gBAClC,4DAA4D;gBAC5D,qDAAqD;gBACrD,eAAe;gBACf,6BAA6B;gBAC7B,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC,GAAG,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAC1E,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CACnB,CAAC;gBAEF,IAAI,CAAC,SAAS,EAAE;oBACd,KAAK,GAAG,KAAK,CAAC;oBACd,MAAM;iBACP;gBACD,SAAS;aACV;YAED,8CAA8C;YAC9C,wDAAwD;YACxD,2CAA2C;YAC3C,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE;gBACtC,KAAK,GAAG,KAAK,CAAC;gBACd,MAAM;aACP;SACF;QAED,qDAAqD;QACrD,sEAAsE;QACtE,IAAI,KAAK,IAAI,aAAa,CAAC,MAAM,GAAG,UAAU,EAAE;YAC9C,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;YAClC,YAAY,GAAG,KAAK,CAAC;SACtB;KACF;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAc;IACvC,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n  ListWorkflows200Response,\n  ListWorkflowsDefaultResponse,\n  GetWorkflow200Response,\n  GetWorkflowDefaultResponse,\n  CreateOrReplaceWorkflow200Response,\n  CreateOrReplaceWorkflowDefaultResponse,\n  DeleteWorkflow204Response,\n  DeleteWorkflowDefaultResponse,\n  SubmitUserRequests200Response,\n  SubmitUserRequestsDefaultResponse,\n  ListWorkflowRuns200Response,\n  ListWorkflowRunsDefaultResponse,\n  GetWorkflowRun200Response,\n  GetWorkflowRunDefaultResponse,\n  CancelWorkflowRun200Response,\n  CancelWorkflowRunDefaultResponse,\n  ListWorkflowTasks200Response,\n  ListWorkflowTasksDefaultResponse,\n  GetWorkflowTask200Response,\n  GetWorkflowTaskDefaultResponse,\n  ApproveApprovalTask200Response,\n  ApproveApprovalTaskDefaultResponse,\n  RejectApprovalTask200Response,\n  RejectApprovalTaskDefaultResponse,\n  ReassignWorkflowTask200Response,\n  ReassignWorkflowTaskDefaultResponse,\n  UpdateTaskStatus200Response,\n  UpdateTaskStatusDefaultResponse,\n} from \"./responses\";\n\nconst responseMap: Record<string, string[]> = {\n  \"GET /workflows\": [\"200\"],\n  \"GET /workflows/{workflowId}\": [\"200\"],\n  \"PUT /workflows/{workflowId}\": [\"200\"],\n  \"DELETE /workflows/{workflowId}\": [\"204\"],\n  \"POST /userrequests\": [\"200\"],\n  \"GET /workflowruns\": [\"200\"],\n  \"GET /workflowruns/{workflowRunId}\": [\"200\"],\n  \"POST /workflowruns/{workflowRunId}/cancel\": [\"200\"],\n  \"GET /workflowtasks\": [\"200\"],\n  \"GET /workflowtasks/{taskId}\": [\"200\"],\n  \"POST /workflowtasks/{taskId}/approve-approval\": [\"200\"],\n  \"POST /workflowtasks/{taskId}/reject-approval\": [\"200\"],\n  \"POST /workflowtasks/{taskId}/reassign\": [\"200\"],\n  \"POST /workflowtasks/{taskId}/change-task-status\": [\"200\"],\n};\n\nexport function isUnexpected(\n  response: ListWorkflows200Response | ListWorkflowsDefaultResponse\n): response is ListWorkflowsDefaultResponse;\nexport function isUnexpected(\n  response: GetWorkflow200Response | GetWorkflowDefaultResponse\n): response is GetWorkflowDefaultResponse;\nexport function isUnexpected(\n  response: CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse\n): response is CreateOrReplaceWorkflowDefaultResponse;\nexport function isUnexpected(\n  response: DeleteWorkflow204Response | DeleteWorkflowDefaultResponse\n): response is DeleteWorkflowDefaultResponse;\nexport function isUnexpected(\n  response: SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse\n): response is SubmitUserRequestsDefaultResponse;\nexport function isUnexpected(\n  response: ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse\n): response is ListWorkflowRunsDefaultResponse;\nexport function isUnexpected(\n  response: GetWorkflowRun200Response | GetWorkflowRunDefaultResponse\n): response is GetWorkflowRunDefaultResponse;\nexport function isUnexpected(\n  response: CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse\n): response is CancelWorkflowRunDefaultResponse;\nexport function isUnexpected(\n  response: ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse\n): response is ListWorkflowTasksDefaultResponse;\nexport function isUnexpected(\n  response: GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse\n): response is GetWorkflowTaskDefaultResponse;\nexport function isUnexpected(\n  response: ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse\n): response is ApproveApprovalTaskDefaultResponse;\nexport function isUnexpected(\n  response: RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse\n): response is RejectApprovalTaskDefaultResponse;\nexport function isUnexpected(\n  response: ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse\n): response is ReassignWorkflowTaskDefaultResponse;\nexport function isUnexpected(\n  response: UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse\n): response is UpdateTaskStatusDefaultResponse;\nexport function isUnexpected(\n  response:\n    | ListWorkflows200Response\n    | ListWorkflowsDefaultResponse\n    | GetWorkflow200Response\n    | GetWorkflowDefaultResponse\n    | CreateOrReplaceWorkflow200Response\n    | CreateOrReplaceWorkflowDefaultResponse\n    | DeleteWorkflow204Response\n    | DeleteWorkflowDefaultResponse\n    | SubmitUserRequests200Response\n    | SubmitUserRequestsDefaultResponse\n    | ListWorkflowRuns200Response\n    | ListWorkflowRunsDefaultResponse\n    | GetWorkflowRun200Response\n    | GetWorkflowRunDefaultResponse\n    | CancelWorkflowRun200Response\n    | CancelWorkflowRunDefaultResponse\n    | ListWorkflowTasks200Response\n    | ListWorkflowTasksDefaultResponse\n    | GetWorkflowTask200Response\n    | GetWorkflowTaskDefaultResponse\n    | ApproveApprovalTask200Response\n    | ApproveApprovalTaskDefaultResponse\n    | RejectApprovalTask200Response\n    | RejectApprovalTaskDefaultResponse\n    | ReassignWorkflowTask200Response\n    | ReassignWorkflowTaskDefaultResponse\n    | UpdateTaskStatus200Response\n    | UpdateTaskStatusDefaultResponse\n): response is\n  | ListWorkflowsDefaultResponse\n  | GetWorkflowDefaultResponse\n  | CreateOrReplaceWorkflowDefaultResponse\n  | DeleteWorkflowDefaultResponse\n  | SubmitUserRequestsDefaultResponse\n  | ListWorkflowRunsDefaultResponse\n  | GetWorkflowRunDefaultResponse\n  | CancelWorkflowRunDefaultResponse\n  | ListWorkflowTasksDefaultResponse\n  | GetWorkflowTaskDefaultResponse\n  | ApproveApprovalTaskDefaultResponse\n  | RejectApprovalTaskDefaultResponse\n  | ReassignWorkflowTaskDefaultResponse\n  | UpdateTaskStatusDefaultResponse {\n  const lroOriginal = response.headers[\"x-ms-original-url\"];\n  const url = new URL(lroOriginal ?? response.request.url);\n  const method = response.request.method;\n  let pathDetails = responseMap[`${method} ${url.pathname}`];\n  if (!pathDetails) {\n    pathDetails = getParametrizedPathSuccess(method, url.pathname);\n  }\n  return !pathDetails.includes(response.status);\n}\n\nfunction getParametrizedPathSuccess(method: string, path: string): string[] {\n  const pathParts = path.split(\"/\");\n\n  // Traverse list to match the longest candidate\n  // matchedLen: the length of candidate path\n  // matchedValue: the matched status code array\n  let matchedLen = -1,\n    matchedValue: string[] = [];\n\n  // Iterate the responseMap to find a match\n  for (const [key, value] of Object.entries(responseMap)) {\n    // Extracting the path from the map key which is in format\n    // GET /path/foo\n    if (!key.startsWith(method)) {\n      continue;\n    }\n    const candidatePath = getPathFromMapKey(key);\n    // Get each part of the url path\n    const candidateParts = candidatePath.split(\"/\");\n\n    // track if we have found a match to return the values found.\n    let found = true;\n    for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {\n      if (candidateParts[i]?.startsWith(\"{\") && candidateParts[i]?.indexOf(\"}\") !== -1) {\n        const start = candidateParts[i]!.indexOf(\"}\") + 1,\n          end = candidateParts[i]?.length;\n        // If the current part of the candidate is a \"template\" part\n        // Try to use the suffix of pattern to match the path\n        // {guid} ==> $\n        // {guid}:export ==> :export$\n        const isMatched = new RegExp(`${candidateParts[i]?.slice(start, end)}`).test(\n          pathParts[j] || \"\"\n        );\n\n        if (!isMatched) {\n          found = false;\n          break;\n        }\n        continue;\n      }\n\n      // If the candidate part is not a template and\n      // the parts don't match mark the candidate as not found\n      // to move on with the next candidate path.\n      if (candidateParts[i] !== pathParts[j]) {\n        found = false;\n        break;\n      }\n    }\n\n    // We finished evaluating the current candidate parts\n    // Update the matched value if and only if we found the longer pattern\n    if (found && candidatePath.length > matchedLen) {\n      matchedLen = candidatePath.length;\n      matchedValue = value;\n    }\n  }\n\n  return matchedValue;\n}\n\nfunction getPathFromMapKey(mapKey: string): string {\n  const pathStart = mapKey.indexOf(\"/\");\n  return mapKey.slice(pathStart);\n}\n"]}

package/dist-esm/src/models.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+export {};
+//# sourceMappingURL=models.js.map

package/dist-esm/src/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/** Describes under what condition a workflow will run. */\nexport interface Trigger {\n  type:\n    | \"when_term_creation_is_requested\"\n    | \"when_term_deletion_is_requested\"\n    | \"when_term_update_is_requested\"\n    | \"when_terms_import_is_requested\"\n    | \"when_data_access_grant_is_requested\"\n    | \"when_asset_update_is_requested\";\n  /** Glossary term hierarchy path. */\n  underGlossaryHierarchy?: string;\n  /** The collection name. */\n  underCollection?: string;\n  /** The glossary guid. */\n  underGlossary?: string;\n}\n\n/** Create or update workflow payload. */\nexport interface WorkflowCreateOrUpdateCommand {\n  /** It describes under what condition a workflow will run.  */\n  triggers: Array<Trigger>;\n  /** The workflow name. */\n  name: string;\n  /** Whether the workflow enabled or not. */\n  isEnabled: boolean;\n  /** Description of a workflow. */\n  description: string;\n  /** The action DAG(Directed Acyclic Graph), it defines actual flow. */\n  actionDag?: Record<string, unknown>;\n}\n\nexport interface UserRequestPayload {\n  /** The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly. */\n  operations: Array<Operation>;\n  /** The comment when submit a user request. */\n  comment?: string;\n}\n\n/** The operation user wants to perform. */\nexport interface Operation {\n  /** The operation type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The payload of each operation which user want to submit. */\n  payload: Record<string, unknown>;\n}\n\nexport interface WorkflowRunCancelRequest {\n  /** The comment of canceling a workflow run. */\n  comment?: string;\n}\n\nexport interface ApprovalResponseComment {\n  /** The comment of approving or rejecting an approval request. */\n  comment?: string;\n}\n\n/** The request payload of reassigning a workflow task. */\nexport interface ReassignCommand {\n  /** The request body of reassigning a workflow task. */\n  reassignments?: Array<ReassignCommandReassignmentsItem>;\n}\n\nexport interface ReassignCommandReassignmentsItem {\n  /**\n   * Reassign a workflow task from a user or a group.\n   *\n   * Value may contain a UUID\n   */\n  reassignFrom: string;\n  /**\n   * Reassign a workflow task to a user or a group.\n   *\n   * Value may contain a UUID\n   */\n  reassignTo: string;\n}\n\nexport interface TaskUpdateCommand {\n  /** The new status will be used to update the task. */\n  newStatus: \"NotStarted\" | \"InProgress\" | \"Completed\" | \"Canceled\";\n  /** The comment when update a task. */\n  comment?: string;\n}\n"]}

package/dist-esm/src/outputModels.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+export {};
+//# sourceMappingURL=outputModels.js.map

package/dist-esm/src/outputModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/** The workflow list. */\nexport interface WorkflowMetadataListOutput {\n  /** The value of workflow list. */\n  value: Array<WorkflowMetadataOutput>;\n  /** The URL to get the next set of results. */\n  nextLink?: string;\n}\n\n/** The workflow metadata, action DAGs are not included. */\nexport interface WorkflowMetadataOutput {\n  /**\n   * The id of workflow.\n   *\n   * Value may contain a UUID\n   */\n  id: string;\n  /** It describes under what condition a workflow will run.  */\n  triggers: Array<TriggerOutput>;\n  /** The created time of workflow. */\n  createdTime?: string;\n  /** The person who created the workflow. */\n  createdBy?: string;\n  /** The last update time. */\n  lastUpdateTime?: string;\n  /** The person who updated the workflow. */\n  updatedBy?: string;\n  /** The name of a workflow. */\n  name: string;\n  /** Whether the workflow is enabled or not. */\n  isEnabled: boolean;\n  /** Description of a workflow. */\n  description: string;\n}\n\n/** Describes under what condition a workflow will run. */\nexport interface TriggerOutput {\n  type:\n    | \"when_term_creation_is_requested\"\n    | \"when_term_deletion_is_requested\"\n    | \"when_term_update_is_requested\"\n    | \"when_terms_import_is_requested\"\n    | \"when_data_access_grant_is_requested\"\n    | \"when_asset_update_is_requested\";\n  /** Glossary term hierarchy path. */\n  underGlossaryHierarchy?: string;\n  /** The collection name. */\n  underCollection?: string;\n  /** The glossary guid. */\n  underGlossary?: string;\n}\n\n/** Default error response model */\nexport interface ErrorResponseOutput {\n  /** Default error model */\n  error: ErrorModelOutput;\n}\n\n/** Default error model */\nexport interface ErrorModelOutput {\n  /** Gets or sets the code. */\n  code: string;\n  /** Gets or sets the details. */\n  details?: Array<ErrorModelOutput>;\n  /** Gets or sets the messages. */\n  message: string;\n  /** Gets or sets the target. */\n  target?: string;\n}\n\n/** The workflow properties. It includes the triggers, actual flow and other properties of a workflow. */\nexport interface WorkflowOutput extends WorkflowMetadataOutput {\n  /** The action DAG(Directed Acyclic Graph), it defines steps to be executed in a workflow run and their order. */\n  actionDag: Record<string, unknown>;\n}\n\n/** Describes user ask to do operation(s) on Purview. */\nexport interface UserRequestResponseOutput {\n  /**\n   * The user request id.\n   *\n   * Value may contain a UUID\n   */\n  requestId: string;\n  /**\n   * The person who submitted the user request.\n   *\n   * Value may contain a UUID\n   */\n  requestor: string;\n  /** The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly. */\n  operations: Array<UserRequestResponseOperationsItemOutput>;\n  /** The comment when submit a user request. */\n  comment?: string;\n  /** The status. */\n  status:\n    | \"NotStarted\"\n    | \"InProgress\"\n    | \"Failed\"\n    | \"Completed\"\n    | \"Canceling\"\n    | \"CancellationFailed\"\n    | \"Canceled\";\n}\n\n/** The operation user wants to perform. */\nexport interface UserRequestResponseOperationsItemOutput {\n  /** The operation type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The payload of each operation which user want to submit. */\n  payload: Record<string, unknown>;\n  workflowRunIds?: Array<string>;\n}\n\nexport interface WorkflowRunListOutput {\n  /** The value of workflow run list. */\n  value: Array<WorkflowRunMetadataOutput>;\n  /** The URL to get the next set of results. */\n  nextLink?: string;\n}\n\n/** The execution of a workflow. It includes status of the entire run and other properties of a run. */\nexport interface WorkflowRunMetadataOutput {\n  /**\n   * The workflow run id.\n   *\n   * Value may contain a UUID\n   */\n  id: string;\n  /**\n   * The workflow id.\n   *\n   * Value may contain a UUID\n   */\n  workflowId: string;\n  /** Workflow run start time. */\n  startTime: string;\n  /**\n   * The person who submitted the user request.\n   *\n   * Value may contain a UUID\n   */\n  requestor: string;\n  /**\n   * The user request id.\n   *\n   * Value may contain a UUID\n   */\n  userRequestId?: string;\n  /** The input of a workflow run. Align with operation in user request. */\n  runPayload: WorkflowRunPayloadOutput;\n  /** The status. */\n  status:\n    | \"NotStarted\"\n    | \"InProgress\"\n    | \"Failed\"\n    | \"Completed\"\n    | \"Canceling\"\n    | \"CancellationFailed\"\n    | \"Canceled\";\n  /** The time of workflow run completed. */\n  endTime?: string;\n  /** The time of workflow run be canceled. */\n  cancelTime?: string;\n  /** The comment when cancel a workflow run. */\n  cancelComment?: string;\n}\n\n/** The input of a workflow run. Align with operation in user request. */\nexport interface WorkflowRunPayloadOutput {\n  /** The workflow run payload type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The target value which need involve workflow to update. */\n  targetValue: string;\n}\n\n/** The execution of a workflow. It includes workflow action DAG at run time (action DAG snapshot), run payload, status of the entire run and other properties of a run. */\nexport interface WorkflowRunOutput {\n  /**\n   * The workflow run id.\n   *\n   * Value may contain a UUID\n   */\n  id?: string;\n  /**\n   * The workflow id.\n   *\n   * Value may contain a UUID\n   */\n  workflowId?: string;\n  /** Workflow run start time. */\n  startTime?: string;\n  /**\n   * The person who submitted the user request.\n   *\n   * Value may contain a UUID\n   */\n  requestor?: string;\n  /**\n   * The user request id.\n   *\n   * Value may contain a UUID\n   */\n  userRequestId?: string;\n  /** The input of a workflow run. Align with operation in user request. */\n  runPayload?: WorkflowRunRunPayloadOutput;\n  /** The status. */\n  status?:\n    | \"NotStarted\"\n    | \"InProgress\"\n    | \"Failed\"\n    | \"Completed\"\n    | \"Canceling\"\n    | \"CancellationFailed\"\n    | \"Canceled\";\n  /** The time of workflow run completed. */\n  endTime?: string;\n  /** The time of workflow run be canceled. */\n  cancelTime?: string;\n  /** The comment when cancel a workflow run. */\n  cancelComment?: string;\n  /** The action DAG(Directed Acyclic Graph), it defines actual flow. */\n  actionDag: Record<string, unknown>;\n  /** It refers to the \"detail\" property of a workflow run object, which contains run context and runtime information of actions. */\n  detail: WorkflowRunDetailOutput;\n}\n\n/** The input of a workflow run. Align with operation in user request. */\nexport interface WorkflowRunRunPayloadOutput {\n  /** The workflow run payload type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The target value which need involve workflow to update. */\n  targetValue: string;\n  /** The payload of each operation which user want to submit. */\n  payload: Record<string, unknown>;\n}\n\n/** It refers to the \"detail\" property of a workflow run object, which contains run context and runtime information of actions. */\nexport interface WorkflowRunDetailOutput {\n  /** Built-in variables starts with @runInput. Its properties are determined by trigger type at workflow run time. */\n  runInput: Record<string, unknown>;\n  /** Any object */\n  actions: Record<string, unknown>;\n}\n\nexport interface TasksListOutput {\n  /** The value of workflow tasks list. */\n  value: Array<WorkflowTaskOutput>;\n  /** The URL to get the next set of results. */\n  nextLink?: string;\n}\n\n/** An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task. */\nexport interface WorkflowTaskOutputParent {\n  /**\n   * The workflow task id.\n   *\n   * Value may contain a UUID\n   */\n  id: string;\n  /** The workflow task title. */\n  title?: string;\n  /**\n   * The workflow run id.\n   *\n   * Value may contain a UUID\n   */\n  workflowRunId: string;\n  /**\n   * The workflow id.\n   *\n   * Value may contain a UUID\n   */\n  workflowId: string;\n  /**\n   * The person who submitted the user request.\n   *\n   * Value may contain a UUID\n   */\n  requestor: string;\n  /** The created time. */\n  createdTime: string;\n  /** The last update time. */\n  lastUpdateTime: string;\n  /** Info and material that helps assignees to take action. */\n  payload: TaskPayloadOutput;\n  /** Info of task reminder. */\n  reminderInfo?: WorkflowTaskReminderInfoOutput;\n  /** Info of task expiry. */\n  expiryInfo?: WorkflowTaskExpiryInfoOutput;\n  type: \"WorkflowTask\" | \"Approval\" | \"SimpleTask\";\n}\n\n/** Info and material that helps assignees to take action. */\nexport interface TaskPayloadOutput {\n  /** The task payload type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The target value of entity which user want to involve workflow to update. */\n  targetValue: string;\n  /** The payload of the task. */\n  payload?: Record<string, unknown>;\n}\n\n/** Info of task reminder. */\nexport interface WorkflowTaskReminderInfoOutput {\n  /** The last update time. */\n  lastRemindTime?: string;\n  /** The next remind time. */\n  nextRemindTime: string;\n  /** The reminder settings. */\n  reminderSettings: Record<string, unknown>;\n}\n\n/** Info of task expiry. */\nexport interface WorkflowTaskExpiryInfoOutput {\n  /** The last expiry notification time. */\n  lastExpiryNotificationTime?: string;\n  /** The next expiry notification time. */\n  nextExpiryNotificationTime: string;\n  /** The expiry time. */\n  expiryTime: string;\n  expirySettings: WorkflowTaskExpiryInfoExpirySettingsOutput;\n}\n\nexport interface WorkflowTaskExpiryInfoExpirySettingsOutput {\n  /** The time of expiry. */\n  expireAfter: Record<string, unknown>;\n  notifyOnExpiration?: Array<string>;\n}\n\n/** The workflow approval task properties. */\nexport interface ApprovalOutput extends WorkflowTaskOutputParent {\n  /** The approval task details */\n  approvalDetail?: ApprovalDetailOutput;\n  type: \"Approval\";\n}\n\n/** The approval task details */\nexport interface ApprovalDetailOutput {\n  /** The approval type of an approval task. */\n  approvalType: \"PendingOnAny\" | \"PendingOnAll\";\n  /** The status of an approval task. */\n  status: \"Pending\" | \"Approved\" | \"Rejected\" | \"Canceled\";\n  /** The list of approvers with reply. */\n  approvers: Record<string, ApproverResponseOutput>;\n}\n\n/** The response of approvers for a workflow task. */\nexport interface ApproverResponseOutput {\n  /** The response for an approval task. */\n  reply: \"Approved\" | \"Rejected\" | \"Pending\";\n  /** The comment of approving or rejecting an approval request. */\n  comment?: string;\n  /** The reply time of approver to a workflow task. */\n  responseTime?: string;\n}\n\n/** The workflow simple task properties. */\nexport interface SimpleTaskOutput extends WorkflowTaskOutputParent {\n  /** Workflow simple task details. */\n  taskDetail?: SimpleTaskDetailOutput;\n  type: \"SimpleTask\";\n}\n\n/** Workflow simple task details. */\nexport interface SimpleTaskDetailOutput {\n  /** The simple task body. */\n  taskBody: string;\n  /** The users or groups were assigned the simple task. */\n  assignedTo: Array<string>;\n  /** Simple task status. */\n  status: \"NotStarted\" | \"InProgress\" | \"Completed\" | \"Canceled\";\n  changeHistory: Array<Record<string, unknown>>;\n}\n\n/** An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task. */\nexport type WorkflowTaskOutput = ApprovalOutput | SimpleTaskOutput;\n"]}