@azure-rest/health-deidentification 1.0.0-alpha.20250619.1 → 1.0.0-alpha.20250702.3

package/README.md

@@ -1,27 +1,45 @@
-# Azure Deidentification REST client library for JavaScript
+# Azure Health Data Services de-identification service REST client library for JavaScript
 
-`@azure-rest/health-deidentification` is a managed service that enables users to tag, redact, or surrogate health data.
+This package contains a client library for the de-identification service in Azure Health Data Services which 
+enables users to tag, redact, or surrogate health data containing Protected Health Information (PHI).
 
-<!-- **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** -->
-<!-- TODO Fix links once they are live use placeholden until then -->
+Use the client library for the de-identification service to:
+- Discover PHI in unstructured text
+- Replace PHI in unstructured text with placeholder values
+- Replace PHI in unstructured text with realistic surrogate values
+- Manage asynchronous jobs to de-identify documents in Azure Storage
+
+**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.**
+
+Use the client library for the de-identification service to:
+- Discover PHI in unstructured text
+- Replace PHI in unstructured text with placeholder values
+- Replace PHI in unstructured text with realistic surrogate values
+- Manage asynchronous jobs to de-identify documents in Azure Storage
 
 Key links:
 
+- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/healthdataaiservices/health-deidentification-rest)
 - [Package (NPM)](https://www.npmjs.com/package/@azure-rest/health-deidentification)
+- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure-rest/health-deidentification)
+- [Product documentation][product_documentation]
 
 ## Getting started
 
 ### Currently supported environments
 
-- LTS versions of Node.js
+- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
+- Latest versions of Safari, Chrome, Edge and Firefox.
 
 ### Prerequisites
 
-- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
+- You need an [Azure subscription][azure_sub] to use this package.
+- [Deploy the de-identification service][deid_quickstart].
+- [Configure Azure role-based access control (RBAC)][deid_rbac] for the operations you will perform.
 
 ### Install the `@azure-rest/health-deidentification` package
 
-Install the Azure Deidentification REST client REST client library for JavaScript with `npm`:
+Install the library with `npm`:
 
 ```bash
 npm install @azure-rest/health-deidentification
@@ -29,26 +47,50 @@ npm install @azure-rest/health-deidentification
 
 ### Create and authenticate a `DeidentificationClient`
 
-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
-[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
+You can authenticate with Microsoft Entra ID using the [Azure Identity library][azure_identity]. To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
 
-To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity)
+```bash
+npm install @azure/identity
+```
 
 After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
-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.
+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`
+`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.
 
-Pull `ServiceUrl` from your created Deidentification Service.
+You will need a **service URL** to instantiate a client object. You can find the service URL for a particular resource in the [Azure portal][azure_portal], or using the [Azure CLI][azure_cli].
+Here's an example of setting an environment variable in Bash using Azure CLI:
 
-![Service Url Location](documentation/images/ServiceUrl_Location.png)
+```bash
+# Get the service URL for the resource
+export DEID_SERVICE_ENDPOINT=$(az deidservice show --name "<resource-name>" --resource-group "<resource-group-name>" --query "properties.serviceUrl")
+```
 
-Basic code snippet to create your Deidentification Client and Deidentify a string.
+Create a client with the endpoint and credential:
+```ts snippet:CreateClient
+import { DefaultAzureCredential } from "@azure/identity";
+import DeidentificationClient from "@azure-rest/health-deidentification";
+
+const credential = new DefaultAzureCredential();
+const serviceEndpoint = process.env.DEID_SERVICE_ENDPOINT || "https://example.api.deid.azure.com";
+const client = DeidentificationClient(serviceEndpoint, credential);
+```
 
-```ts snippet:ReadmeSample_Deidentify
+## Key concepts
+
+### De-identification operations:
+Given an input text, the de-identification service can perform three main operations:
+- `Tag` returns the category and location within the text of detected PHI entities.
+- `Redact` returns output text where detected PHI entities are replaced with placeholder text. For example `John` replaced with `[name]`.
+- `Surrogate` returns output text where detected PHI entities are replaced with realistic replacement values. For example, `My name is John Smith` could become `My name is Tom Jones`.
+
+### Available endpoints
+There are two ways to interact with the de-identification service. You can send text directly, or you can create jobs 
+to de-identify documents in Azure Storage.
+
+You can de-identify text directly using the `DeidentificationClient`:
+```ts snippet:DeidentifyText
 import { DefaultAzureCredential } from "@azure/identity";
 import DeidentificationClient, {
   DeidentificationContent,
@@ -56,7 +98,7 @@ import DeidentificationClient, {
 } from "@azure-rest/health-deidentification";
 
 const credential = new DefaultAzureCredential();
-const serviceEndpoint = "https://example.api.cac001.deid.azure.com";
+const serviceEndpoint = process.env.DEID_SERVICE_ENDPOINT || "https://example.api.deid.azure.com";
 const client = DeidentificationClient(serviceEndpoint, credential);
 
 const content: DeidentificationContent = {
@@ -72,18 +114,85 @@ if (isUnexpected(response)) {
 console.log(response.body.outputText); // Hello, Tom!
 ```
 
-## Key concept
+To de-identify documents in Azure Storage, you'll need a storage account with a container to which the de-identification service has been granted an appropriate role. See [Tutorial: Configure Azure Storage to de-identify documents][deid_configure_storage] for prerequisites and configuration options. You can upload the files in the [test data folder][test_data] as blobs, like: `https://<storageaccount>.blob.core.windows.net/<container>/example_patient_1/doctor_dictation.txt`.
+
+You can create jobs to de-identify documents in the source Azure Storage account and container with an optional input prefix. If there's no input prefix, all blobs in the container will be de-identified. Azure Storage blobs can use `/` in the blob name to emulate a folder or directory layout. For more on blob naming, see [Naming and Referencing Containers, Blobs, and Metadata][blob_names]. The files you've uploaded can be de-identified by providing `example_patient_1` as the input prefix:
+```
+<container>/
+├── example_patient_1/
+       └──doctor_dictation.txt
+       └──row-2-data.txt
+       └──visit-summary.txt
+```
+
+Your target Azure Storage account and container where documents will be written can be the same as the source, or a different account or container. In the examples below, the source and target account and container are the same. You can specify an output prefix to indicate where the job's output documents should be written (defaulting to `_output`). Each document processed by the job will have the same relative blob name with the input prefix replaced by the output prefix:
+```
+<container>/
+├── example_patient_1/
+       └──doctor_dictation.txt
+       └──row-2-data.txt
+       └──visit-summary.txt
+├── _output/
+       └──doctor_dictation.txt
+       └──row-2-data.txt
+       └──visit-summary.txt
+```
+
+Set the following environment variables, updating the storage account and container with real values:
+```bash
+export AZURE_STORAGE_ACCOUNT_LOCATION="https://<storageaccount>.blob.core.windows.net/<container>"
+export INPUT_PREFIX="example_patient_1"
+export OUTPUT_PREFIX="_output"
+```
 
-Operation Modes:
+You can create and view job status using the client:
+```ts snippet:DeidentifyDocuments
+import { DefaultAzureCredential } from "@azure/identity";
+import DeidentificationClient, {
+  DeidentificationJob,
+  DeidentifyDocumentsDefaultResponse,
+  isUnexpected,
+  getLongRunningPoller,
+} from "@azure-rest/health-deidentification";
 
-- Tag: Will return a structure of offset and length with the PHI category of the related text spans.
-- Redact: Will return output text with placeholder stubbed text. ex. `[name]`
-- Surrogate: Will return output text with synthetic replacements.
-  - `My name is John Smith`
-  - `My name is Tom Jones`
+const credential = new DefaultAzureCredential();
+const serviceEndpoint =
+  process.env["DEID_SERVICE_ENDPOINT"] || "https://example.api.deid.azure.com";
+const storageLocation = `https://${process.env["STORAGE_ACCOUNT_NAME"]}.blob.core.windows.net/${process.env["STORAGE_CONTAINER_NAME"]}`;
+const inputPrefix = "example_patient_1";
+const outputPrefix = process.env["OUTPUT_PREFIX"] || "_output";
+
+const client = DeidentificationClient(serviceEndpoint, credential);
+const jobName = "sample-job-" + new Date().getTime().toString().slice(-8);
+
+const job: DeidentificationJob = {
+  operation: "Surrogate",
+  sourceLocation: { location: storageLocation, prefix: inputPrefix },
+  targetLocation: { location: storageLocation, prefix: outputPrefix },
+};
+const response = (await client
+  .path("/jobs/{name}", jobName)
+  .put({ body: job })) as DeidentifyDocumentsDefaultResponse;
+
+if (isUnexpected(response)) {
+  throw response.body.error;
+}
+
+const poller = await getLongRunningPoller(client, response);
+const finalOutput = await poller.pollUntilDone();
+console.log(finalOutput.body);
+```
+
+## Next steps
+
+Find a bug, or have feedback? Raise an issue with the [Health Deidentification][github_issue_label] label.
 
 ## Troubleshooting
 
+- **Unable to Access Source or Target Storage**
+  - Ensure you create your deid service with a system assigned managed identity
+  - Ensure your storage account has given permissions to that managed identity
+
 ### 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`:
@@ -95,3 +204,14 @@ 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 -->
+[azure_sub]: https://azure.microsoft.com/free/
+[deid_quickstart]: https://learn.microsoft.com/azure/healthcare-apis/deidentification/quickstart
+[deid_redact]: https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format
+[deid_rbac]: https://learn.microsoft.com/azure/healthcare-apis/deidentification/manage-access-rbac
+[deid_managed_identity]: https://learn.microsoft.com/azure/healthcare-apis/deidentification/managed-identities
+[deid_configure_storage]: https://learn.microsoft.com/azure/healthcare-apis/deidentification/configure-storage
+[azure_cli]: https://learn.microsoft.com/cli/azure/healthcareapis/deidservice?view=azure-cli-latest
+[azure_portal]: https://ms.portal.azure.com
+[github_issue_label]: https://github.com/Azure/azure-sdk-for-js/labels/Health%20Deidentification

package/dist/browser/clientDefinitions.d.ts

@@ -1,11 +1,11 @@
-import type { GetJobParameters, CreateJobParameters, DeleteJobParameters, ListJobsParameters, ListJobDocumentsParameters, CancelJobParameters, DeidentifyParameters } from "./parameters.js";
-import type { GetJob200Response, GetJobDefaultResponse, CreateJob200Response, CreateJob201Response, CreateJobDefaultResponse, DeleteJob204Response, DeleteJobDefaultResponse, ListJobs200Response, ListJobsDefaultResponse, ListJobDocuments200Response, ListJobDocumentsDefaultResponse, CancelJob200Response, CancelJobDefaultResponse, Deidentify200Response, DeidentifyDefaultResponse } from "./responses.js";
+import type { GetJobParameters, DeidentifyDocumentsParameters, DeleteJobParameters, ListJobsParameters, ListJobDocumentsParameters, CancelJobParameters, DeidentifyTextParameters } from "./parameters.js";
+import type { GetJob200Response, GetJobDefaultResponse, DeidentifyDocuments200Response, DeidentifyDocuments201Response, DeidentifyDocumentsDefaultResponse, DeleteJob204Response, DeleteJobDefaultResponse, ListJobs200Response, ListJobsDefaultResponse, ListJobDocuments200Response, ListJobDocumentsDefaultResponse, CancelJob200Response, CancelJobDefaultResponse, DeidentifyText200Response, DeidentifyTextDefaultResponse } from "./responses.js";
 import type { Client, StreamableMethod } from "@azure-rest/core-client";
 export interface GetJob {
     /** Resource read operation template. */
     get(options?: GetJobParameters): StreamableMethod<GetJob200Response | GetJobDefaultResponse>;
     /** Long-running resource create or replace operation template. */
-    put(options: CreateJobParameters): StreamableMethod<CreateJob200Response | CreateJob201Response | CreateJobDefaultResponse>;
+    put(options: DeidentifyDocumentsParameters): StreamableMethod<DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse>;
     /** Removes the record of the job from the service. Does not delete any documents. */
     delete(options?: DeleteJobParameters): StreamableMethod<DeleteJob204Response | DeleteJobDefaultResponse>;
 }
@@ -27,9 +27,9 @@ export interface CancelJob {
      */
     post(options?: CancelJobParameters): StreamableMethod<CancelJob200Response | CancelJobDefaultResponse>;
 }
-export interface Deidentify {
+export interface DeidentifyText {
     /** A remote procedure call (RPC) operation. */
-    post(options: DeidentifyParameters): StreamableMethod<Deidentify200Response | DeidentifyDefaultResponse>;
+    post(options: DeidentifyTextParameters): StreamableMethod<DeidentifyText200Response | DeidentifyTextDefaultResponse>;
 }
 export interface Routes {
     /** Resource for '/jobs/\{name\}' has methods for the following verbs: get, put, delete */
@@ -41,7 +41,7 @@ export interface Routes {
     /** Resource for '/jobs/\{name\}:cancel' has methods for the following verbs: post */
     (path: "/jobs/{name}:cancel", name: string): CancelJob;
     /** Resource for '/deid' has methods for the following verbs: post */
-    (path: "/deid"): Deidentify;
+    (path: "/deid"): DeidentifyText;
 }
 export type DeidentificationClient = Client & {
     path: Routes;

package/dist/browser/clientDefinitions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clientDefinitions.d.ts","sourceRoot":"","sources":["../../src/clientDefinitions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EAClB,0BAA0B,EAC1B,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EACV,iBAAiB,EACjB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,oBAAoB,EACpB,wBAAwB,EACxB,mBAAmB,EACnB,uBAAuB,EACvB,2BAA2B,EAC3B,+BAA+B,EAC/B,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,yBAAyB,EAC1B,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAExE,MAAM,WAAW,MAAM;IACrB,wCAAwC;IACxC,GAAG,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,CAAC,iBAAiB,GAAG,qBAAqB,CAAC,CAAC;IAC7F,kEAAkE;IAClE,GAAG,CACD,OAAO,EAAE,mBAAmB,GAC3B,gBAAgB,CAAC,oBAAoB,GAAG,oBAAoB,GAAG,wBAAwB,CAAC,CAAC;IAC5F,qFAAqF;IACrF,MAAM,CACJ,OAAO,CAAC,EAAE,mBAAmB,GAC5B,gBAAgB,CAAC,oBAAoB,GAAG,wBAAwB,CAAC,CAAC;CACtE;AAED,MAAM,WAAW,QAAQ;IACvB,wCAAwC;IACxC,GAAG,CACD,OAAO,CAAC,EAAE,kBAAkB,GAC3B,gBAAgB,CAAC,mBAAmB,GAAG,uBAAuB,CAAC,CAAC;CACpE;AAED,MAAM,WAAW,gBAAgB;IAC/B,wCAAwC;IACxC,GAAG,CACD,OAAO,CAAC,EAAE,0BAA0B,GACnC,gBAAgB,CAAC,2BAA2B,GAAG,+BAA+B,CAAC,CAAC;CACpF;AAED,MAAM,WAAW,SAAS;IACxB;;;;;;OAMG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,mBAAmB,GAC5B,gBAAgB,CAAC,oBAAoB,GAAG,wBAAwB,CAAC,CAAC;CACtE;AAED,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,IAAI,CACF,OAAO,EAAE,oBAAoB,GAC5B,gBAAgB,CAAC,qBAAqB,GAAG,yBAAyB,CAAC,CAAC;CACxE;AAED,MAAM,WAAW,MAAM;IACrB,0FAA0F;IAC1F,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7C,oEAAoE;IACpE,CAAC,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC1B,uFAAuF;IACvF,CAAC,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC;IACjE,qFAAqF;IACrF,CAAC,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACvD,qEAAqE;IACrE,CAAC,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;CAC7B;AAED,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
+{"version":3,"file":"clientDefinitions.d.ts","sourceRoot":"","sources":["../../src/clientDefinitions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,gBAAgB,EAChB,6BAA6B,EAC7B,mBAAmB,EACnB,kBAAkB,EAClB,0BAA0B,EAC1B,mBAAmB,EACnB,wBAAwB,EACzB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EACV,iBAAiB,EACjB,qBAAqB,EACrB,8BAA8B,EAC9B,8BAA8B,EAC9B,kCAAkC,EAClC,oBAAoB,EACpB,wBAAwB,EACxB,mBAAmB,EACnB,uBAAuB,EACvB,2BAA2B,EAC3B,+BAA+B,EAC/B,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,6BAA6B,EAC9B,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAExE,MAAM,WAAW,MAAM;IACrB,wCAAwC;IACxC,GAAG,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,CAAC,iBAAiB,GAAG,qBAAqB,CAAC,CAAC;IAC7F,kEAAkE;IAClE,GAAG,CACD,OAAO,EAAE,6BAA6B,GACrC,gBAAgB,CACf,8BAA8B,GAC9B,8BAA8B,GAC9B,kCAAkC,CACrC,CAAC;IACF,qFAAqF;IACrF,MAAM,CACJ,OAAO,CAAC,EAAE,mBAAmB,GAC5B,gBAAgB,CAAC,oBAAoB,GAAG,wBAAwB,CAAC,CAAC;CACtE;AAED,MAAM,WAAW,QAAQ;IACvB,wCAAwC;IACxC,GAAG,CACD,OAAO,CAAC,EAAE,kBAAkB,GAC3B,gBAAgB,CAAC,mBAAmB,GAAG,uBAAuB,CAAC,CAAC;CACpE;AAED,MAAM,WAAW,gBAAgB;IAC/B,wCAAwC;IACxC,GAAG,CACD,OAAO,CAAC,EAAE,0BAA0B,GACnC,gBAAgB,CAAC,2BAA2B,GAAG,+BAA+B,CAAC,CAAC;CACpF;AAED,MAAM,WAAW,SAAS;IACxB;;;;;;OAMG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,mBAAmB,GAC5B,gBAAgB,CAAC,oBAAoB,GAAG,wBAAwB,CAAC,CAAC;CACtE;AAED,MAAM,WAAW,cAAc;IAC7B,+CAA+C;IAC/C,IAAI,CACF,OAAO,EAAE,wBAAwB,GAChC,gBAAgB,CAAC,yBAAyB,GAAG,6BAA6B,CAAC,CAAC;CAChF;AAED,MAAM,WAAW,MAAM;IACrB,0FAA0F;IAC1F,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7C,oEAAoE;IACpE,CAAC,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC1B,uFAAuF;IACvF,CAAC,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC;IACjE,qFAAqF;IACrF,CAAC,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACvD,qEAAqE;IACrE,CAAC,IAAI,EAAE,OAAO,GAAG,cAAc,CAAC;CACjC;AAED,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/browser/clientDefinitions.js.map

@@ -1 +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 type {\n  GetJobParameters,\n  CreateJobParameters,\n  DeleteJobParameters,\n  ListJobsParameters,\n  ListJobDocumentsParameters,\n  CancelJobParameters,\n  DeidentifyParameters,\n} from \"./parameters.js\";\nimport type {\n  GetJob200Response,\n  GetJobDefaultResponse,\n  CreateJob200Response,\n  CreateJob201Response,\n  CreateJobDefaultResponse,\n  DeleteJob204Response,\n  DeleteJobDefaultResponse,\n  ListJobs200Response,\n  ListJobsDefaultResponse,\n  ListJobDocuments200Response,\n  ListJobDocumentsDefaultResponse,\n  CancelJob200Response,\n  CancelJobDefaultResponse,\n  Deidentify200Response,\n  DeidentifyDefaultResponse,\n} from \"./responses.js\";\nimport type { Client, StreamableMethod } from \"@azure-rest/core-client\";\n\nexport interface GetJob {\n  /** Resource read operation template. */\n  get(options?: GetJobParameters): StreamableMethod<GetJob200Response | GetJobDefaultResponse>;\n  /** Long-running resource create or replace operation template. */\n  put(\n    options: CreateJobParameters,\n  ): StreamableMethod<CreateJob200Response | CreateJob201Response | CreateJobDefaultResponse>;\n  /** Removes the record of the job from the service. Does not delete any documents. */\n  delete(\n    options?: DeleteJobParameters,\n  ): StreamableMethod<DeleteJob204Response | DeleteJobDefaultResponse>;\n}\n\nexport interface ListJobs {\n  /** Resource list operation template. */\n  get(\n    options?: ListJobsParameters,\n  ): StreamableMethod<ListJobs200Response | ListJobsDefaultResponse>;\n}\n\nexport interface ListJobDocuments {\n  /** Resource list operation template. */\n  get(\n    options?: ListJobDocumentsParameters,\n  ): StreamableMethod<ListJobDocuments200Response | ListJobDocumentsDefaultResponse>;\n}\n\nexport interface CancelJob {\n  /**\n   * Cancels a job that is in progress.\n   *\n   * The job will be marked as canceled and the service will stop processing the job. The service will not delete any documents that have already been processed.\n   *\n   * If the job is already complete, this will have no effect.\n   */\n  post(\n    options?: CancelJobParameters,\n  ): StreamableMethod<CancelJob200Response | CancelJobDefaultResponse>;\n}\n\nexport interface Deidentify {\n  /** A remote procedure call (RPC) operation. */\n  post(\n    options: DeidentifyParameters,\n  ): StreamableMethod<Deidentify200Response | DeidentifyDefaultResponse>;\n}\n\nexport interface Routes {\n  /** Resource for '/jobs/\\{name\\}' has methods for the following verbs: get, put, delete */\n  (path: \"/jobs/{name}\", name: string): GetJob;\n  /** Resource for '/jobs' has methods for the following verbs: get */\n  (path: \"/jobs\"): ListJobs;\n  /** Resource for '/jobs/\\{name\\}/documents' has methods for the following verbs: get */\n  (path: \"/jobs/{name}/documents\", name: string): ListJobDocuments;\n  /** Resource for '/jobs/\\{name\\}:cancel' has methods for the following verbs: post */\n  (path: \"/jobs/{name}:cancel\", name: string): CancelJob;\n  /** Resource for '/deid' has methods for the following verbs: post */\n  (path: \"/deid\"): Deidentify;\n}\n\nexport type DeidentificationClient = Client & {\n  path: Routes;\n};\n"]}
+{"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 type {\n  GetJobParameters,\n  DeidentifyDocumentsParameters,\n  DeleteJobParameters,\n  ListJobsParameters,\n  ListJobDocumentsParameters,\n  CancelJobParameters,\n  DeidentifyTextParameters,\n} from \"./parameters.js\";\nimport type {\n  GetJob200Response,\n  GetJobDefaultResponse,\n  DeidentifyDocuments200Response,\n  DeidentifyDocuments201Response,\n  DeidentifyDocumentsDefaultResponse,\n  DeleteJob204Response,\n  DeleteJobDefaultResponse,\n  ListJobs200Response,\n  ListJobsDefaultResponse,\n  ListJobDocuments200Response,\n  ListJobDocumentsDefaultResponse,\n  CancelJob200Response,\n  CancelJobDefaultResponse,\n  DeidentifyText200Response,\n  DeidentifyTextDefaultResponse,\n} from \"./responses.js\";\nimport type { Client, StreamableMethod } from \"@azure-rest/core-client\";\n\nexport interface GetJob {\n  /** Resource read operation template. */\n  get(options?: GetJobParameters): StreamableMethod<GetJob200Response | GetJobDefaultResponse>;\n  /** Long-running resource create or replace operation template. */\n  put(\n    options: DeidentifyDocumentsParameters,\n  ): StreamableMethod<\n    | DeidentifyDocuments200Response\n    | DeidentifyDocuments201Response\n    | DeidentifyDocumentsDefaultResponse\n  >;\n  /** Removes the record of the job from the service. Does not delete any documents. */\n  delete(\n    options?: DeleteJobParameters,\n  ): StreamableMethod<DeleteJob204Response | DeleteJobDefaultResponse>;\n}\n\nexport interface ListJobs {\n  /** Resource list operation template. */\n  get(\n    options?: ListJobsParameters,\n  ): StreamableMethod<ListJobs200Response | ListJobsDefaultResponse>;\n}\n\nexport interface ListJobDocuments {\n  /** Resource list operation template. */\n  get(\n    options?: ListJobDocumentsParameters,\n  ): StreamableMethod<ListJobDocuments200Response | ListJobDocumentsDefaultResponse>;\n}\n\nexport interface CancelJob {\n  /**\n   * Cancels a job that is in progress.\n   *\n   * The job will be marked as canceled and the service will stop processing the job. The service will not delete any documents that have already been processed.\n   *\n   * If the job is already complete, this will have no effect.\n   */\n  post(\n    options?: CancelJobParameters,\n  ): StreamableMethod<CancelJob200Response | CancelJobDefaultResponse>;\n}\n\nexport interface DeidentifyText {\n  /** A remote procedure call (RPC) operation. */\n  post(\n    options: DeidentifyTextParameters,\n  ): StreamableMethod<DeidentifyText200Response | DeidentifyTextDefaultResponse>;\n}\n\nexport interface Routes {\n  /** Resource for '/jobs/\\{name\\}' has methods for the following verbs: get, put, delete */\n  (path: \"/jobs/{name}\", name: string): GetJob;\n  /** Resource for '/jobs' has methods for the following verbs: get */\n  (path: \"/jobs\"): ListJobs;\n  /** Resource for '/jobs/\\{name\\}/documents' has methods for the following verbs: get */\n  (path: \"/jobs/{name}/documents\", name: string): ListJobDocuments;\n  /** Resource for '/jobs/\\{name\\}:cancel' has methods for the following verbs: post */\n  (path: \"/jobs/{name}:cancel\", name: string): CancelJob;\n  /** Resource for '/deid' has methods for the following verbs: post */\n  (path: \"/deid\"): DeidentifyText;\n}\n\nexport type DeidentificationClient = Client & {\n  path: Routes;\n};\n"]}

package/dist/browser/deidentificationClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deidentificationClient.d.ts","sourceRoot":"","sources":["../../src/deidentificationClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAErE,6CAA6C;AAC7C,MAAM,WAAW,6BAA8B,SAAQ,aAAa;IAClE,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,eAAe,EAC5B,EAAE,UAAiC,EAAE,GAAG,OAAO,EAAE,GAAE,6BAAkC,GACpF,sBAAsB,CAsCxB"}
+{"version":3,"file":"deidentificationClient.d.ts","sourceRoot":"","sources":["../../src/deidentificationClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAErE,6CAA6C;AAC7C,MAAM,WAAW,6BAA8B,SAAQ,aAAa;IAClE,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,eAAe,EAC5B,EAAE,UAAyB,EAAE,GAAG,OAAO,EAAE,GAAE,6BAAkC,GAC5E,sBAAsB,CAuCxB"}

package/dist/browser/deidentificationClient.js

@@ -11,8 +11,8 @@ import { logger } from "./logger.js";
  */
 export default function createClient(endpointParam, credentials, _a = {}) {
     var _b, _c, _d, _e, _f, _g;
-    var { apiVersion = "2024-07-12-preview" } = _a, options = __rest(_a, ["apiVersion"]);
-    const endpointUrl = (_c = (_b = options.endpoint) !== null && _b !== void 0 ? _b : options.baseUrl) !== null && _c !== void 0 ? _c : `https://${endpointParam}`;
+    var { apiVersion = "2024-11-15" } = _a, options = __rest(_a, ["apiVersion"]);
+    const endpointUrl = (_c = (_b = options.endpoint) !== null && _b !== void 0 ? _b : options.baseUrl) !== null && _c !== void 0 ? _c : `${endpointParam}`;
     const userAgentInfo = `azsdk-js-health-deidentification-rest/1.0.0-beta.1`;
     const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`

package/dist/browser/deidentificationClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"deidentificationClient.js","sourceRoot":"","sources":["../../src/deidentificationClient.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAGlC,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAUrC;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAqB,EACrB,WAA4B,EAC5B,KAAmF,EAAE;;QAArF,EAAE,UAAU,GAAG,oBAAoB,OAAkD,EAA7C,OAAO,cAA/C,cAAiD,CAAF;IAE/C,MAAM,WAAW,GAAG,MAAA,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,OAAO,mCAAI,WAAW,aAAa,EAAE,CAAC;IACtF,MAAM,aAAa,GAAG,oDAAoD,CAAC;IAC3E,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;QAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,aAAa,EAAE;QAChE,CAAC,CAAC,GAAG,aAAa,EAAE,CAAC;IACzB,OAAO,mCACF,OAAO,KACV,gBAAgB,EAAE;YAChB,eAAe;SAChB,EACD,cAAc,EAAE;YACd,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,MAAM,mCAAI,MAAM,CAAC,IAAI;SACtD,EACD,WAAW,EAAE;YACX,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,WAAW,0CAAE,MAAM,mCAAI,CAAC,iCAAiC,CAAC;SAC3E,GACF,CAAC;IACF,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAA2B,CAAC;IAEtF,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC3D,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxB,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACzB,qDAAqD;YACrD,yEAAyE;YACzE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,UAAU,EAAE,CAAC;gBACvD,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GACzD,eAAe,UAAU,EAAE,CAAC;YAC9B,CAAC;YAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;KACF,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ClientOptions } from \"@azure-rest/core-client\";\nimport { getClient } from \"@azure-rest/core-client\";\nimport { logger } from \"./logger.js\";\nimport type { TokenCredential } from \"@azure/core-auth\";\nimport type { DeidentificationClient } from \"./clientDefinitions.js\";\n\n/** The optional parameters for the client */\nexport interface DeidentificationClientOptions extends ClientOptions {\n  /** The api version option of the client */\n  apiVersion?: string;\n}\n\n/**\n * Initialize a new instance of `DeidentificationClient`\n * @param endpointParam - Url of your De-identification Service.\n * @param credentials - uniquely identify client credential\n * @param options - the parameter for all optional parameters\n */\nexport default function createClient(\n  endpointParam: string,\n  credentials: TokenCredential,\n  { apiVersion = \"2024-07-12-preview\", ...options }: DeidentificationClientOptions = {},\n): DeidentificationClient {\n  const endpointUrl = options.endpoint ?? options.baseUrl ?? `https://${endpointParam}`;\n  const userAgentInfo = `azsdk-js-health-deidentification-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    loggingOptions: {\n      logger: options.loggingOptions?.logger ?? logger.info,\n    },\n    credentials: {\n      scopes: options.credentials?.scopes ?? [\"https://deid.azure.com/.default\"],\n    },\n  };\n  const client = getClient(endpointUrl, credentials, options) as DeidentificationClient;\n\n  client.pipeline.removePolicy({ name: \"ApiVersionPolicy\" });\n  client.pipeline.addPolicy({\n    name: \"ClientApiVersionPolicy\",\n    sendRequest: (req, next) => {\n      // Use the apiVersion defined in request url directly\n      // Append one if there is no apiVersion and we have one at client options\n      const url = new URL(req.url);\n      if (!url.searchParams.get(\"api-version\") && apiVersion) {\n        req.url = `${req.url}${\n          Array.from(url.searchParams.keys()).length > 0 ? \"&\" : \"?\"\n        }api-version=${apiVersion}`;\n      }\n\n      return next(req);\n    },\n  });\n  return client;\n}\n"]}
+{"version":3,"file":"deidentificationClient.js","sourceRoot":"","sources":["../../src/deidentificationClient.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAGlC,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAUrC;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAqB,EACrB,WAA4B,EAC5B,KAA2E,EAAE;;QAA7E,EAAE,UAAU,GAAG,YAAY,OAAkD,EAA7C,OAAO,cAAvC,cAAyC,CAAF;IAEvC,MAAM,WAAW,GAAG,MAAA,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,OAAO,mCAAI,GAAG,aAAa,EAAE,CAAC;IAC9E,MAAM,aAAa,GAAG,oDAAoD,CAAC;IAC3E,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;QAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,aAAa,EAAE;QAChE,CAAC,CAAC,GAAG,aAAa,EAAE,CAAC;IACzB,OAAO,mCACF,OAAO,KACV,gBAAgB,EAAE;YAChB,eAAe;SAChB,EACD,cAAc,EAAE;YACd,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,MAAM,mCAAI,MAAM,CAAC,IAAI;SACtD,EACD,WAAW,EAAE;YACX,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,WAAW,0CAAE,MAAM,mCAAI,CAAC,iCAAiC,CAAC;SAC3E,GACF,CAAC;IACF,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAA2B,CAAC;IAEtF,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC3D,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxB,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACzB,qDAAqD;YACrD,yEAAyE;YACzE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,UAAU,EAAE,CAAC;gBACvD,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GACzD,eAAe,UAAU,EAAE,CAAC;YAC9B,CAAC;YAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ClientOptions } from \"@azure-rest/core-client\";\nimport { getClient } from \"@azure-rest/core-client\";\nimport { logger } from \"./logger.js\";\nimport type { TokenCredential } from \"@azure/core-auth\";\nimport type { DeidentificationClient } from \"./clientDefinitions.js\";\n\n/** The optional parameters for the client */\nexport interface DeidentificationClientOptions extends ClientOptions {\n  /** The api version option of the client */\n  apiVersion?: string;\n}\n\n/**\n * Initialize a new instance of `DeidentificationClient`\n * @param endpointParam - Url of your De-identification Service.\n * @param credentials - uniquely identify client credential\n * @param options - the parameter for all optional parameters\n */\nexport default function createClient(\n  endpointParam: string,\n  credentials: TokenCredential,\n  { apiVersion = \"2024-11-15\", ...options }: DeidentificationClientOptions = {},\n): DeidentificationClient {\n  const endpointUrl = options.endpoint ?? options.baseUrl ?? `${endpointParam}`;\n  const userAgentInfo = `azsdk-js-health-deidentification-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    loggingOptions: {\n      logger: options.loggingOptions?.logger ?? logger.info,\n    },\n    credentials: {\n      scopes: options.credentials?.scopes ?? [\"https://deid.azure.com/.default\"],\n    },\n  };\n  const client = getClient(endpointUrl, credentials, options) as DeidentificationClient;\n\n  client.pipeline.removePolicy({ name: \"ApiVersionPolicy\" });\n  client.pipeline.addPolicy({\n    name: \"ClientApiVersionPolicy\",\n    sendRequest: (req, next) => {\n      // Use the apiVersion defined in request url directly\n      // Append one if there is no apiVersion and we have one at client options\n      const url = new URL(req.url);\n      if (!url.searchParams.get(\"api-version\") && apiVersion) {\n        req.url = `${req.url}${\n          Array.from(url.searchParams.keys()).length > 0 ? \"&\" : \"?\"\n        }api-version=${apiVersion}`;\n      }\n\n      return next(req);\n    },\n  });\n\n  return client;\n}\n"]}

package/dist/browser/isUnexpected.d.ts

@@ -1,9 +1,9 @@
-import type { GetJob200Response, GetJobDefaultResponse, CreateJob200Response, CreateJob201Response, CreateJobLogicalResponse, CreateJobDefaultResponse, DeleteJob204Response, DeleteJobDefaultResponse, ListJobs200Response, ListJobsDefaultResponse, ListJobDocuments200Response, ListJobDocumentsDefaultResponse, CancelJob200Response, CancelJobDefaultResponse, Deidentify200Response, DeidentifyDefaultResponse } from "./responses.js";
+import type { GetJob200Response, GetJobDefaultResponse, DeidentifyDocuments200Response, DeidentifyDocuments201Response, DeidentifyDocumentsLogicalResponse, DeidentifyDocumentsDefaultResponse, DeleteJob204Response, DeleteJobDefaultResponse, ListJobs200Response, ListJobsDefaultResponse, ListJobDocuments200Response, ListJobDocumentsDefaultResponse, CancelJob200Response, CancelJobDefaultResponse, DeidentifyText200Response, DeidentifyTextDefaultResponse } from "./responses.js";
 export declare function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response is GetJobDefaultResponse;
-export declare function isUnexpected(response: CreateJob200Response | CreateJob201Response | CreateJobLogicalResponse | CreateJobDefaultResponse): response is CreateJobDefaultResponse;
+export declare function isUnexpected(response: DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsLogicalResponse | DeidentifyDocumentsDefaultResponse): response is DeidentifyDocumentsDefaultResponse;
 export declare function isUnexpected(response: DeleteJob204Response | DeleteJobDefaultResponse): response is DeleteJobDefaultResponse;
 export declare function isUnexpected(response: ListJobs200Response | ListJobsDefaultResponse): response is ListJobsDefaultResponse;
 export declare function isUnexpected(response: ListJobDocuments200Response | ListJobDocumentsDefaultResponse): response is ListJobDocumentsDefaultResponse;
 export declare function isUnexpected(response: CancelJob200Response | CancelJobDefaultResponse): response is CancelJobDefaultResponse;
-export declare function isUnexpected(response: Deidentify200Response | DeidentifyDefaultResponse): response is DeidentifyDefaultResponse;
+export declare function isUnexpected(response: DeidentifyText200Response | DeidentifyTextDefaultResponse): response is DeidentifyTextDefaultResponse;
 //# sourceMappingURL=isUnexpected.d.ts.map

package/dist/browser/isUnexpected.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isUnexpected.d.ts","sourceRoot":"","sources":["../../src/isUnexpected.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,iBAAiB,EACjB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,wBAAwB,EACxB,oBAAoB,EACpB,wBAAwB,EACxB,mBAAmB,EACnB,uBAAuB,EACvB,2BAA2B,EAC3B,+BAA+B,EAC/B,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,yBAAyB,EAC1B,MAAM,gBAAgB,CAAC;AAYxB,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,iBAAiB,GAAG,qBAAqB,GAClD,QAAQ,IAAI,qBAAqB,CAAC;AACrC,wBAAgB,YAAY,CAC1B,QAAQ,EACJ,oBAAoB,GACpB,oBAAoB,GACpB,wBAAwB,GACxB,wBAAwB,GAC3B,QAAQ,IAAI,wBAAwB,CAAC;AACxC,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,oBAAoB,GAAG,wBAAwB,GACxD,QAAQ,IAAI,wBAAwB,CAAC;AACxC,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,mBAAmB,GAAG,uBAAuB,GACtD,QAAQ,IAAI,uBAAuB,CAAC;AACvC,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,2BAA2B,GAAG,+BAA+B,GACtE,QAAQ,IAAI,+BAA+B,CAAC;AAC/C,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,oBAAoB,GAAG,wBAAwB,GACxD,QAAQ,IAAI,wBAAwB,CAAC;AACxC,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,qBAAqB,GAAG,yBAAyB,GAC1D,QAAQ,IAAI,yBAAyB,CAAC"}
+{"version":3,"file":"isUnexpected.d.ts","sourceRoot":"","sources":["../../src/isUnexpected.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,iBAAiB,EACjB,qBAAqB,EACrB,8BAA8B,EAC9B,8BAA8B,EAC9B,kCAAkC,EAClC,kCAAkC,EAClC,oBAAoB,EACpB,wBAAwB,EACxB,mBAAmB,EACnB,uBAAuB,EACvB,2BAA2B,EAC3B,+BAA+B,EAC/B,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,6BAA6B,EAC9B,MAAM,gBAAgB,CAAC;AAYxB,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,iBAAiB,GAAG,qBAAqB,GAClD,QAAQ,IAAI,qBAAqB,CAAC;AACrC,wBAAgB,YAAY,CAC1B,QAAQ,EACJ,8BAA8B,GAC9B,8BAA8B,GAC9B,kCAAkC,GAClC,kCAAkC,GACrC,QAAQ,IAAI,kCAAkC,CAAC;AAClD,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,oBAAoB,GAAG,wBAAwB,GACxD,QAAQ,IAAI,wBAAwB,CAAC;AACxC,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,mBAAmB,GAAG,uBAAuB,GACtD,QAAQ,IAAI,uBAAuB,CAAC;AACvC,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,2BAA2B,GAAG,+BAA+B,GACtE,QAAQ,IAAI,+BAA+B,CAAC;AAC/C,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,oBAAoB,GAAG,wBAAwB,GACxD,QAAQ,IAAI,wBAAwB,CAAC;AACxC,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,yBAAyB,GAAG,6BAA6B,GAClE,QAAQ,IAAI,6BAA6B,CAAC"}

package/dist/browser/isUnexpected.js.map

@@ -1 +1 @@
-{"version":3,"file":"isUnexpected.js","sourceRoot":"","sources":["../../src/isUnexpected.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAqBlC,MAAM,WAAW,GAA6B;IAC5C,kBAAkB,EAAE,CAAC,KAAK,CAAC;IAC3B,kBAAkB,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;IAClC,qBAAqB,EAAE,CAAC,KAAK,CAAC;IAC9B,WAAW,EAAE,CAAC,KAAK,CAAC;IACpB,4BAA4B,EAAE,CAAC,KAAK,CAAC;IACrC,0BAA0B,EAAE,CAAC,KAAK,CAAC;IACnC,YAAY,EAAE,CAAC,KAAK,CAAC;CACtB,CAAC;AA2BF,MAAM,UAAU,YAAY,CAC1B,QAgB6B;IAS7B,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,CAAC;QACjB,WAAW,GAAG,0BAA0B,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;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,CAAC;QACvD,0DAA0D;QAC1D,gBAAgB;QAChB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;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,CAAC;YAC7F,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,CAAC;gBACjF,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,CAAC;oBACf,KAAK,GAAG,KAAK,CAAC;oBACd,MAAM;gBACR,CAAC;gBACD,SAAS;YACX,CAAC;YAED,8CAA8C;YAC9C,wDAAwD;YACxD,2CAA2C;YAC3C,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvC,KAAK,GAAG,KAAK,CAAC;gBACd,MAAM;YACR,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,sEAAsE;QACtE,IAAI,KAAK,IAAI,aAAa,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YAC/C,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;YAClC,YAAY,GAAG,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;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 type {\n  GetJob200Response,\n  GetJobDefaultResponse,\n  CreateJob200Response,\n  CreateJob201Response,\n  CreateJobLogicalResponse,\n  CreateJobDefaultResponse,\n  DeleteJob204Response,\n  DeleteJobDefaultResponse,\n  ListJobs200Response,\n  ListJobsDefaultResponse,\n  ListJobDocuments200Response,\n  ListJobDocumentsDefaultResponse,\n  CancelJob200Response,\n  CancelJobDefaultResponse,\n  Deidentify200Response,\n  DeidentifyDefaultResponse,\n} from \"./responses.js\";\n\nconst responseMap: Record<string, string[]> = {\n  \"GET /jobs/{name}\": [\"200\"],\n  \"PUT /jobs/{name}\": [\"200\", \"201\"],\n  \"DELETE /jobs/{name}\": [\"204\"],\n  \"GET /jobs\": [\"200\"],\n  \"GET /jobs/{name}/documents\": [\"200\"],\n  \"POST /jobs/{name}:cancel\": [\"200\"],\n  \"POST /deid\": [\"200\"],\n};\n\nexport function isUnexpected(\n  response: GetJob200Response | GetJobDefaultResponse,\n): response is GetJobDefaultResponse;\nexport function isUnexpected(\n  response:\n    | CreateJob200Response\n    | CreateJob201Response\n    | CreateJobLogicalResponse\n    | CreateJobDefaultResponse,\n): response is CreateJobDefaultResponse;\nexport function isUnexpected(\n  response: DeleteJob204Response | DeleteJobDefaultResponse,\n): response is DeleteJobDefaultResponse;\nexport function isUnexpected(\n  response: ListJobs200Response | ListJobsDefaultResponse,\n): response is ListJobsDefaultResponse;\nexport function isUnexpected(\n  response: ListJobDocuments200Response | ListJobDocumentsDefaultResponse,\n): response is ListJobDocumentsDefaultResponse;\nexport function isUnexpected(\n  response: CancelJob200Response | CancelJobDefaultResponse,\n): response is CancelJobDefaultResponse;\nexport function isUnexpected(\n  response: Deidentify200Response | DeidentifyDefaultResponse,\n): response is DeidentifyDefaultResponse;\nexport function isUnexpected(\n  response:\n    | GetJob200Response\n    | GetJobDefaultResponse\n    | CreateJob200Response\n    | CreateJob201Response\n    | CreateJobLogicalResponse\n    | CreateJobDefaultResponse\n    | DeleteJob204Response\n    | DeleteJobDefaultResponse\n    | ListJobs200Response\n    | ListJobsDefaultResponse\n    | ListJobDocuments200Response\n    | ListJobDocumentsDefaultResponse\n    | CancelJob200Response\n    | CancelJobDefaultResponse\n    | Deidentify200Response\n    | DeidentifyDefaultResponse,\n): response is\n  | GetJobDefaultResponse\n  | CreateJobDefaultResponse\n  | DeleteJobDefaultResponse\n  | ListJobsDefaultResponse\n  | ListJobDocumentsDefaultResponse\n  | CancelJobDefaultResponse\n  | DeidentifyDefaultResponse {\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"]}
+{"version":3,"file":"isUnexpected.js","sourceRoot":"","sources":["../../src/isUnexpected.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAqBlC,MAAM,WAAW,GAA6B;IAC5C,kBAAkB,EAAE,CAAC,KAAK,CAAC;IAC3B,kBAAkB,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;IAClC,qBAAqB,EAAE,CAAC,KAAK,CAAC;IAC9B,WAAW,EAAE,CAAC,KAAK,CAAC;IACpB,4BAA4B,EAAE,CAAC,KAAK,CAAC;IACrC,0BAA0B,EAAE,CAAC,KAAK,CAAC;IACnC,YAAY,EAAE,CAAC,KAAK,CAAC;CACtB,CAAC;AA2BF,MAAM,UAAU,YAAY,CAC1B,QAgBiC;IASjC,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,CAAC;QACjB,WAAW,GAAG,0BAA0B,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;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,CAAC;QACvD,0DAA0D;QAC1D,gBAAgB;QAChB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;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,CAAC;YAC7F,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,CAAC;gBACjF,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,CAAC;oBACf,KAAK,GAAG,KAAK,CAAC;oBACd,MAAM;gBACR,CAAC;gBACD,SAAS;YACX,CAAC;YAED,8CAA8C;YAC9C,wDAAwD;YACxD,2CAA2C;YAC3C,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvC,KAAK,GAAG,KAAK,CAAC;gBACd,MAAM;YACR,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,sEAAsE;QACtE,IAAI,KAAK,IAAI,aAAa,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YAC/C,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;YAClC,YAAY,GAAG,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;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 type {\n  GetJob200Response,\n  GetJobDefaultResponse,\n  DeidentifyDocuments200Response,\n  DeidentifyDocuments201Response,\n  DeidentifyDocumentsLogicalResponse,\n  DeidentifyDocumentsDefaultResponse,\n  DeleteJob204Response,\n  DeleteJobDefaultResponse,\n  ListJobs200Response,\n  ListJobsDefaultResponse,\n  ListJobDocuments200Response,\n  ListJobDocumentsDefaultResponse,\n  CancelJob200Response,\n  CancelJobDefaultResponse,\n  DeidentifyText200Response,\n  DeidentifyTextDefaultResponse,\n} from \"./responses.js\";\n\nconst responseMap: Record<string, string[]> = {\n  \"GET /jobs/{name}\": [\"200\"],\n  \"PUT /jobs/{name}\": [\"200\", \"201\"],\n  \"DELETE /jobs/{name}\": [\"204\"],\n  \"GET /jobs\": [\"200\"],\n  \"GET /jobs/{name}/documents\": [\"200\"],\n  \"POST /jobs/{name}:cancel\": [\"200\"],\n  \"POST /deid\": [\"200\"],\n};\n\nexport function isUnexpected(\n  response: GetJob200Response | GetJobDefaultResponse,\n): response is GetJobDefaultResponse;\nexport function isUnexpected(\n  response:\n    | DeidentifyDocuments200Response\n    | DeidentifyDocuments201Response\n    | DeidentifyDocumentsLogicalResponse\n    | DeidentifyDocumentsDefaultResponse,\n): response is DeidentifyDocumentsDefaultResponse;\nexport function isUnexpected(\n  response: DeleteJob204Response | DeleteJobDefaultResponse,\n): response is DeleteJobDefaultResponse;\nexport function isUnexpected(\n  response: ListJobs200Response | ListJobsDefaultResponse,\n): response is ListJobsDefaultResponse;\nexport function isUnexpected(\n  response: ListJobDocuments200Response | ListJobDocumentsDefaultResponse,\n): response is ListJobDocumentsDefaultResponse;\nexport function isUnexpected(\n  response: CancelJob200Response | CancelJobDefaultResponse,\n): response is CancelJobDefaultResponse;\nexport function isUnexpected(\n  response: DeidentifyText200Response | DeidentifyTextDefaultResponse,\n): response is DeidentifyTextDefaultResponse;\nexport function isUnexpected(\n  response:\n    | GetJob200Response\n    | GetJobDefaultResponse\n    | DeidentifyDocuments200Response\n    | DeidentifyDocuments201Response\n    | DeidentifyDocumentsLogicalResponse\n    | DeidentifyDocumentsDefaultResponse\n    | DeleteJob204Response\n    | DeleteJobDefaultResponse\n    | ListJobs200Response\n    | ListJobsDefaultResponse\n    | ListJobDocuments200Response\n    | ListJobDocumentsDefaultResponse\n    | CancelJob200Response\n    | CancelJobDefaultResponse\n    | DeidentifyText200Response\n    | DeidentifyTextDefaultResponse,\n): response is\n  | GetJobDefaultResponse\n  | DeidentifyDocumentsDefaultResponse\n  | DeleteJobDefaultResponse\n  | ListJobsDefaultResponse\n  | ListJobDocumentsDefaultResponse\n  | CancelJobDefaultResponse\n  | DeidentifyTextDefaultResponse {\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/browser/models.d.ts

@@ -1,23 +1,17 @@
 /** A job containing a batch of documents to de-identify. */
 export interface DeidentificationJob {
-    /** Storage location to perform the operation on. */
-    sourceLocation: SourceStorageLocation;
-    /** Target location to store output of operation. */
-    targetLocation: TargetStorageLocation;
     /**
      * Operation to perform on the input documents.
      *
      * Possible values: "Redact", "Surrogate", "Tag"
      */
-    operation?: OperationType;
-    /**
-     * Data type of the input documents.
-     *
-     * Possible values: "Plaintext"
-     */
-    dataType?: DocumentDataType;
-    /** Format of the redacted output. Only valid when Operation is Redact. */
-    redactionFormat?: string;
+    operation?: DeidentificationOperationType;
+    /** Storage location to perform the operation on. */
+    sourceLocation: SourceStorageLocation;
+    /** Target location to store output of operation. */
+    targetLocation: TargetStorageLocation;
+    /** Customization parameters to override default service behaviors. */
+    customizations?: DeidentificationJobCustomizationOptions;
 }
 /** Storage location. */
 export interface SourceStorageLocation {
@@ -32,11 +26,32 @@ export interface SourceStorageLocation {
 export interface TargetStorageLocation {
     /** URL to storage location. */
     location: string;
-    /** Prefix to filter path by. */
+    /**
+     * Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure.
+     *
+     * Example:
+     * File full path: documents/user/note.txt
+     * Input Prefix: "documents/user/"
+     * Output Prefix: "output_docs/"
+     *
+     * Output file: "output_docs/note.txt"
+     */
     prefix: string;
+    /** When set to true during a job, the service will overwrite the output location if it already exists. */
+    overwrite?: boolean;
+}
+/** Customizations options to override default service behaviors for job usage. */
+export interface DeidentificationJobCustomizationOptions {
+    /**
+     * Format of the redacted output. Only valid when Operation is Redact.
+     * Please refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details.
+     */
+    redactionFormat?: string;
+    /** Locale in which the output surrogates are written. */
+    surrogateLocale?: string;
 }
 /** Summary metrics of a job. */
-export interface JobSummary {
+export interface DeidentificationJobSummary {
     /** Number of documents that have completed. */
     successful: number;
     /** Number of documents that have failed. */
@@ -53,24 +68,26 @@ export interface DeidentificationContent {
     /** Input text to de-identify. */
     inputText: string;
     /**
-     * Operation to perform on the input.
+     * Operation to perform on the input documents.
      *
      * Possible values: "Redact", "Surrogate", "Tag"
      */
-    operation?: OperationType;
+    operation?: DeidentificationOperationType;
+    /** Customization parameters to override default service behaviors. */
+    customizations?: DeidentificationCustomizationOptions;
+}
+/** Customizations options to override default service behaviors for synchronous usage. */
+export interface DeidentificationCustomizationOptions {
     /**
-     * Data type of the input.
-     *
-     * Possible values: "Plaintext"
+     * Format of the redacted output. Only valid when Operation is Redact.
+     * Please refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details.
      */
-    dataType?: DocumentDataType;
-    /** Format of the redacted output. Only valid when OperationType is "Redact". */
     redactionFormat?: string;
+    /** Locale in which the output surrogates are written. */
+    surrogateLocale?: string;
 }
-/** Alias for OperationType */
-export type OperationType = string;
-/** Alias for DocumentDataType */
-export type DocumentDataType = string;
-/** Alias for JobStatus */
-export type JobStatus = string;
+/** Alias for DeidentificationOperationType */
+export type DeidentificationOperationType = string;
+/** Alias for OperationState */
+export type OperationState = string;
 //# sourceMappingURL=models.d.ts.map

package/dist/browser/models.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAGA,4DAA4D;AAC5D,MAAM,WAAW,mBAAmB;IAClC,oDAAoD;IACpD,cAAc,EAAE,qBAAqB,CAAC;IACtC,oDAAoD;IACpD,cAAc,EAAE,qBAAqB,CAAC;IACtC;;;;OAIG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,0EAA0E;IAC1E,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,wBAAwB;AACxB,MAAM,WAAW,qBAAqB;IACpC,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,wBAAwB;AACxB,MAAM,WAAW,qBAAqB;IACpC,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,gCAAgC;AAChC,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;IACnB,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,oDAAoD;AACpD,MAAM,WAAW,uBAAuB;IACtC,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,gFAAgF;IAChF,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,8BAA8B;AAC9B,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,iCAAiC;AACjC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AACtC,0BAA0B;AAC1B,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC"}
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAGA,4DAA4D;AAC5D,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,SAAS,CAAC,EAAE,6BAA6B,CAAC;IAC1C,oDAAoD;IACpD,cAAc,EAAE,qBAAqB,CAAC;IACtC,oDAAoD;IACpD,cAAc,EAAE,qBAAqB,CAAC;IACtC,sEAAsE;IACtE,cAAc,CAAC,EAAE,uCAAuC,CAAC;CAC1D;AAED,wBAAwB;AACxB,MAAM,WAAW,qBAAqB;IACpC,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,wBAAwB;AACxB,MAAM,WAAW,qBAAqB;IACpC,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;;;;;OASG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,0GAA0G;IAC1G,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,kFAAkF;AAClF,MAAM,WAAW,uCAAuC;IACtD;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,gCAAgC;AAChC,MAAM,WAAW,0BAA0B;IACzC,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;IACnB,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,oDAAoD;AACpD,MAAM,WAAW,uBAAuB;IACtC,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,CAAC,EAAE,6BAA6B,CAAC;IAC1C,sEAAsE;IACtE,cAAc,CAAC,EAAE,oCAAoC,CAAC;CACvD;AAED,0FAA0F;AAC1F,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,8CAA8C;AAC9C,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC;AACnD,+BAA+B;AAC/B,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC"}

package/dist/browser/models.js.map

@@ -1 +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/** A job containing a batch of documents to de-identify. */\nexport interface DeidentificationJob {\n  /** Storage location to perform the operation on. */\n  sourceLocation: SourceStorageLocation;\n  /** Target location to store output of operation. */\n  targetLocation: TargetStorageLocation;\n  /**\n   * Operation to perform on the input documents.\n   *\n   * Possible values: \"Redact\", \"Surrogate\", \"Tag\"\n   */\n  operation?: OperationType;\n  /**\n   * Data type of the input documents.\n   *\n   * Possible values: \"Plaintext\"\n   */\n  dataType?: DocumentDataType;\n  /** Format of the redacted output. Only valid when Operation is Redact. */\n  redactionFormat?: string;\n}\n\n/** Storage location. */\nexport interface SourceStorageLocation {\n  /** URL to storage location. */\n  location: string;\n  /** Prefix to filter path by. */\n  prefix: string;\n  /** List of extensions to filter path by. */\n  extensions?: string[];\n}\n\n/** Storage location. */\nexport interface TargetStorageLocation {\n  /** URL to storage location. */\n  location: string;\n  /** Prefix to filter path by. */\n  prefix: string;\n}\n\n/** Summary metrics of a job. */\nexport interface JobSummary {\n  /** Number of documents that have completed. */\n  successful: number;\n  /** Number of documents that have failed. */\n  failed: number;\n  /** Number of documents that have been canceled. */\n  canceled: number;\n  /** Number of documents total. */\n  total: number;\n  /** Number of bytes processed. */\n  bytesProcessed: number;\n}\n\n/** Request body for de-identification operation. */\nexport interface DeidentificationContent {\n  /** Input text to de-identify. */\n  inputText: string;\n  /**\n   * Operation to perform on the input.\n   *\n   * Possible values: \"Redact\", \"Surrogate\", \"Tag\"\n   */\n  operation?: OperationType;\n  /**\n   * Data type of the input.\n   *\n   * Possible values: \"Plaintext\"\n   */\n  dataType?: DocumentDataType;\n  /** Format of the redacted output. Only valid when OperationType is \"Redact\". */\n  redactionFormat?: string;\n}\n\n/** Alias for OperationType */\nexport type OperationType = string;\n/** Alias for DocumentDataType */\nexport type DocumentDataType = string;\n/** Alias for JobStatus */\nexport type JobStatus = string;\n"]}
+{"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/** A job containing a batch of documents to de-identify. */\nexport interface DeidentificationJob {\n  /**\n   * Operation to perform on the input documents.\n   *\n   * Possible values: \"Redact\", \"Surrogate\", \"Tag\"\n   */\n  operation?: DeidentificationOperationType;\n  /** Storage location to perform the operation on. */\n  sourceLocation: SourceStorageLocation;\n  /** Target location to store output of operation. */\n  targetLocation: TargetStorageLocation;\n  /** Customization parameters to override default service behaviors. */\n  customizations?: DeidentificationJobCustomizationOptions;\n}\n\n/** Storage location. */\nexport interface SourceStorageLocation {\n  /** URL to storage location. */\n  location: string;\n  /** Prefix to filter path by. */\n  prefix: string;\n  /** List of extensions to filter path by. */\n  extensions?: string[];\n}\n\n/** Storage location. */\nexport interface TargetStorageLocation {\n  /** URL to storage location. */\n  location: string;\n  /**\n   * Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure.\n   *\n   * Example:\n   * File full path: documents/user/note.txt\n   * Input Prefix: \"documents/user/\"\n   * Output Prefix: \"output_docs/\"\n   *\n   * Output file: \"output_docs/note.txt\"\n   */\n  prefix: string;\n  /** When set to true during a job, the service will overwrite the output location if it already exists. */\n  overwrite?: boolean;\n}\n\n/** Customizations options to override default service behaviors for job usage. */\nexport interface DeidentificationJobCustomizationOptions {\n  /**\n   * Format of the redacted output. Only valid when Operation is Redact.\n   * Please refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details.\n   */\n  redactionFormat?: string;\n  /** Locale in which the output surrogates are written. */\n  surrogateLocale?: string;\n}\n\n/** Summary metrics of a job. */\nexport interface DeidentificationJobSummary {\n  /** Number of documents that have completed. */\n  successful: number;\n  /** Number of documents that have failed. */\n  failed: number;\n  /** Number of documents that have been canceled. */\n  canceled: number;\n  /** Number of documents total. */\n  total: number;\n  /** Number of bytes processed. */\n  bytesProcessed: number;\n}\n\n/** Request body for de-identification operation. */\nexport interface DeidentificationContent {\n  /** Input text to de-identify. */\n  inputText: string;\n  /**\n   * Operation to perform on the input documents.\n   *\n   * Possible values: \"Redact\", \"Surrogate\", \"Tag\"\n   */\n  operation?: DeidentificationOperationType;\n  /** Customization parameters to override default service behaviors. */\n  customizations?: DeidentificationCustomizationOptions;\n}\n\n/** Customizations options to override default service behaviors for synchronous usage. */\nexport interface DeidentificationCustomizationOptions {\n  /**\n   * Format of the redacted output. Only valid when Operation is Redact.\n   * Please refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details.\n   */\n  redactionFormat?: string;\n  /** Locale in which the output surrogates are written. */\n  surrogateLocale?: string;\n}\n\n/** Alias for DeidentificationOperationType */\nexport type DeidentificationOperationType = string;\n/** Alias for OperationState */\nexport type OperationState = string;\n"]}