@azure-rest/health-deidentification 1.0.0-beta.1 → 1.0.0

package/dist/commonjs/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/commonjs/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/commonjs/models.js

@@ -1,5 +1,5 @@
 "use strict";
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+// Licensed under the MIT License.
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=models.js.map

package/dist/commonjs/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"]}

package/dist/commonjs/outputModels.d.ts

@@ -1,33 +1,26 @@
-import { Paged } from "@azure/core-paging";
-import { ErrorModel } from "@azure-rest/core-client";
+import type { ErrorModel } from "@azure-rest/core-client";
 /** A job containing a batch of documents to de-identify. */
 export interface DeidentificationJobOutput {
     /** The name of a job. */
     readonly name: string;
-    /** Storage location to perform the operation on. */
-    sourceLocation: SourceStorageLocationOutput;
-    /** Target location to store output of operation. */
-    targetLocation: TargetStorageLocationOutput;
     /**
      * Operation to perform on the input documents.
      *
      * Possible values: "Redact", "Surrogate", "Tag"
      */
-    operation?: OperationTypeOutput;
-    /**
-     * Data type of the input documents.
-     *
-     * Possible values: "Plaintext"
-     */
-    dataType?: DocumentDataTypeOutput;
-    /** Format of the redacted output. Only valid when Operation is Redact. */
-    redactionFormat?: string;
+    operation?: DeidentificationOperationTypeOutput;
+    /** Storage location to perform the operation on. */
+    sourceLocation: SourceStorageLocationOutput;
+    /** Target location to store output of operation. */
+    targetLocation: TargetStorageLocationOutput;
+    /** Customization parameters to override default service behaviors. */
+    customizations?: DeidentificationJobCustomizationOptionsOutput;
     /**
      * Current status of a job.
      *
-     * Possible values: "NotStarted", "Running", "Succeeded", "PartialFailed", "Failed", "Canceled"
+     * Possible values: "NotStarted", "Running", "Succeeded", "Failed", "Canceled"
      */
-    readonly status: JobStatusOutput;
+    readonly status: OperationStateOutput;
     /** Error when job fails in it's entirety. */
     readonly error?: ErrorModel;
     /**
@@ -43,7 +36,7 @@ export interface DeidentificationJobOutput {
     /** Date and time when the job was started. */
     readonly startedAt?: string;
     /** Summary of a job. Exists only when the job is completed. */
-    readonly summary?: JobSummaryOutput;
+    readonly summary?: DeidentificationJobSummaryOutput;
 }
 /** Storage location. */
 export interface SourceStorageLocationOutput {
@@ -58,11 +51,32 @@ export interface SourceStorageLocationOutput {
 export interface TargetStorageLocationOutput {
     /** 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 DeidentificationJobCustomizationOptionsOutput {
+    /**
+     * 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 JobSummaryOutput {
+export interface DeidentificationJobSummaryOutput {
     /** Number of documents that have completed. */
     successful: number;
     /** Number of documents that have failed. */
@@ -74,14 +88,28 @@ export interface JobSummaryOutput {
     /** Number of bytes processed. */
     bytesProcessed: number;
 }
+/** Paged collection of DeidentificationJob items */
+export interface PagedDeidentificationJobOutput {
+    /** The DeidentificationJob items on this page */
+    value: Array<DeidentificationJobOutput>;
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+/** Paged collection of DeidentificationDocumentDetails items */
+export interface PagedDeidentificationDocumentDetailsOutput {
+    /** The DeidentificationDocumentDetails items on this page */
+    value: Array<DeidentificationDocumentDetailsOutput>;
+    /** The link to the next page of items */
+    nextLink?: string;
+}
 /** Details of a single document in a job. */
-export interface DocumentDetailsOutput {
+export interface DeidentificationDocumentDetailsOutput {
     /** Id of the document details. */
     readonly id: string;
     /** Location for the input. */
-    input: DocumentLocationOutput;
+    input: DeidentificationDocumentLocationOutput;
     /** Location for the output. */
-    output?: DocumentLocationOutput;
+    output?: DeidentificationDocumentLocationOutput;
     /**
      * Status of the document.
      *
@@ -92,9 +120,9 @@ export interface DocumentDetailsOutput {
     error?: ErrorModel;
 }
 /** Location of a document. */
-export interface DocumentLocationOutput {
-    /** Path of document in storage. */
-    path: string;
+export interface DeidentificationDocumentLocationOutput {
+    /** Location of document in storage. */
+    location: string;
     /** The entity tag for this resource. */
     readonly etag: string;
 }
@@ -109,10 +137,6 @@ export interface DeidentificationResultOutput {
 export interface PhiTaggerResultOutput {
     /** List of entities detected in the input. */
     entities: Array<PhiEntityOutput>;
-    /** Path to the document in storage. */
-    path?: string;
-    /** The entity tag for this resource. */
-    etag?: string;
 }
 /** PHI Entity tag in the input. */
 export interface PhiEntityOutput {
@@ -148,16 +172,8 @@ export interface StringIndexOutput {
      */
     codePoint: number;
 }
-/** Alias for OperationTypeOutput */
-export type OperationTypeOutput = string;
-/** Alias for DocumentDataTypeOutput */
-export type DocumentDataTypeOutput = string;
-/** Alias for JobStatusOutput */
-export type JobStatusOutput = string;
-/** Paged collection of DeidentificationJob items */
-export type PagedDeidentificationJobOutput = Paged<DeidentificationJobOutput>;
-/** Paged collection of DocumentDetails items */
-export type PagedDocumentDetailsOutput = Paged<DocumentDetailsOutput>;
+/** Alias for DeidentificationOperationTypeOutput */
+export type DeidentificationOperationTypeOutput = string;
 /** Alias for OperationStateOutput */
 export type OperationStateOutput = string;
 /** Alias for PhiCategoryOutput */

package/dist/commonjs/outputModels.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,4DAA4D;AAC5D,MAAM,WAAW,yBAAyB;IACxC,yBAAyB;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,oDAAoD;IACpD,cAAc,EAAE,2BAA2B,CAAC;IAC5C,oDAAoD;IACpD,cAAc,EAAE,2BAA2B,CAAC;IAC5C;;;;OAIG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC,0EAA0E;IAC1E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC,6CAA6C;IAC7C,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;IAC5B;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED,wBAAwB;AACxB,MAAM,WAAW,2BAA2B;IAC1C,+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,2BAA2B;IAC1C,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,gCAAgC;AAChC,MAAM,WAAW,gBAAgB;IAC/B,+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,6CAA6C;AAC7C,MAAM,WAAW,qBAAqB;IACpC,kCAAkC;IAClC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,8BAA8B;IAC9B,KAAK,EAAE,sBAAsB,CAAC;IAC9B,+BAA+B;IAC/B,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAChC;;;;OAIG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAC7B,iCAAiC;IACjC,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AAED,8BAA8B;AAC9B,MAAM,WAAW,sBAAsB;IACrC,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,qDAAqD;AACrD,MAAM,WAAW,4BAA4B;IAC3C,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yEAAyE;IACzE,YAAY,CAAC,EAAE,qBAAqB,CAAC;CACtC;AAED,qCAAqC;AACrC,MAAM,WAAW,qBAAqB;IACpC,8CAA8C;IAC9C,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IACjC,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,mCAAmC;AACnC,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,iEAAiE;IACjE,MAAM,EAAE,iBAAiB,CAAC;IAC1B,gCAAgC;IAChC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,0BAA0B;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8CAA8C;IAC9C,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,mCAAmC;AACnC,MAAM,WAAW,iBAAiB;IAChC,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,oCAAoC;AACpC,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AACzC,uCAAuC;AACvC,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAC5C,gCAAgC;AAChC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AACrC,oDAAoD;AACpD,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAAC,yBAAyB,CAAC,CAAC;AAC9E,gDAAgD;AAChD,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAAC,qBAAqB,CAAC,CAAC;AACtE,qCAAqC;AACrC,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAC1C,kCAAkC;AAClC,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC"}
+{"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,4DAA4D;AAC5D,MAAM,WAAW,yBAAyB;IACxC,yBAAyB;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,mCAAmC,CAAC;IAChD,oDAAoD;IACpD,cAAc,EAAE,2BAA2B,CAAC;IAC5C,oDAAoD;IACpD,cAAc,EAAE,2BAA2B,CAAC;IAC5C,sEAAsE;IACtE,cAAc,CAAC,EAAE,6CAA6C,CAAC;IAC/D;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IACtC,6CAA6C;IAC7C,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;IAC5B;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,CAAC,EAAE,gCAAgC,CAAC;CACrD;AAED,wBAAwB;AACxB,MAAM,WAAW,2BAA2B;IAC1C,+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,2BAA2B;IAC1C,+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,6CAA6C;IAC5D;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,gCAAgC;AAChC,MAAM,WAAW,gCAAgC;IAC/C,+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,8BAA8B;IAC7C,iDAAiD;IACjD,KAAK,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACxC,yCAAyC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,gEAAgE;AAChE,MAAM,WAAW,0CAA0C;IACzD,6DAA6D;IAC7D,KAAK,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACpD,yCAAyC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,6CAA6C;AAC7C,MAAM,WAAW,qCAAqC;IACpD,kCAAkC;IAClC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,8BAA8B;IAC9B,KAAK,EAAE,sCAAsC,CAAC;IAC9C,+BAA+B;IAC/B,MAAM,CAAC,EAAE,sCAAsC,CAAC;IAChD;;;;OAIG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAC7B,iCAAiC;IACjC,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AAED,8BAA8B;AAC9B,MAAM,WAAW,sCAAsC;IACrD,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,qDAAqD;AACrD,MAAM,WAAW,4BAA4B;IAC3C,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yEAAyE;IACzE,YAAY,CAAC,EAAE,qBAAqB,CAAC;CACtC;AAED,qCAAqC;AACrC,MAAM,WAAW,qBAAqB;IACpC,8CAA8C;IAC9C,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAClC;AAED,mCAAmC;AACnC,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,iEAAiE;IACjE,MAAM,EAAE,iBAAiB,CAAC;IAC1B,gCAAgC;IAChC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,0BAA0B;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8CAA8C;IAC9C,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,mCAAmC;AACnC,MAAM,WAAW,iBAAiB;IAChC,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,oDAAoD;AACpD,MAAM,MAAM,mCAAmC,GAAG,MAAM,CAAC;AACzD,qCAAqC;AACrC,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAC1C,kCAAkC;AAClC,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC"}

package/dist/commonjs/outputModels.js

@@ -1,5 +1,5 @@
 "use strict";
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+// Licensed under the MIT License.
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=outputModels.js.map

package/dist/commonjs/outputModels.js.map

@@ -1 +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\nimport { Paged } from \"@azure/core-paging\";\nimport { ErrorModel } from \"@azure-rest/core-client\";\n\n/** A job containing a batch of documents to de-identify. */\nexport interface DeidentificationJobOutput {\n  /** The name of a job. */\n  readonly name: string;\n  /** Storage location to perform the operation on. */\n  sourceLocation: SourceStorageLocationOutput;\n  /** Target location to store output of operation. */\n  targetLocation: TargetStorageLocationOutput;\n  /**\n   * Operation to perform on the input documents.\n   *\n   * Possible values: \"Redact\", \"Surrogate\", \"Tag\"\n   */\n  operation?: OperationTypeOutput;\n  /**\n   * Data type of the input documents.\n   *\n   * Possible values: \"Plaintext\"\n   */\n  dataType?: DocumentDataTypeOutput;\n  /** Format of the redacted output. Only valid when Operation is Redact. */\n  redactionFormat?: string;\n  /**\n   * Current status of a job.\n   *\n   * Possible values: \"NotStarted\", \"Running\", \"Succeeded\", \"PartialFailed\", \"Failed\", \"Canceled\"\n   */\n  readonly status: JobStatusOutput;\n  /** Error when job fails in it's entirety. */\n  readonly error?: ErrorModel;\n  /**\n   * Date and time when the job was completed.\n   *\n   * If the job is canceled, this is the time when the job was canceled.\n   *\n   * If the job failed, this is the time when the job failed.\n   */\n  readonly lastUpdatedAt: string;\n  /** Date and time when the job was created. */\n  readonly createdAt: string;\n  /** Date and time when the job was started. */\n  readonly startedAt?: string;\n  /** Summary of a job. Exists only when the job is completed. */\n  readonly summary?: JobSummaryOutput;\n}\n\n/** Storage location. */\nexport interface SourceStorageLocationOutput {\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 TargetStorageLocationOutput {\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 JobSummaryOutput {\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/** Details of a single document in a job. */\nexport interface DocumentDetailsOutput {\n  /** Id of the document details. */\n  readonly id: string;\n  /** Location for the input. */\n  input: DocumentLocationOutput;\n  /** Location for the output. */\n  output?: DocumentLocationOutput;\n  /**\n   * Status of the document.\n   *\n   * Possible values: \"NotStarted\", \"Running\", \"Succeeded\", \"Failed\", \"Canceled\"\n   */\n  status: OperationStateOutput;\n  /** Error when document fails. */\n  error?: ErrorModel;\n}\n\n/** Location of a document. */\nexport interface DocumentLocationOutput {\n  /** Path of document in storage. */\n  path: string;\n  /** The entity tag for this resource. */\n  readonly etag: string;\n}\n\n/** Response body for de-identification operation. */\nexport interface DeidentificationResultOutput {\n  /** Output text after de-identification. Not available for \"Tag\" operation. */\n  outputText?: string;\n  /** Result of the \"Tag\" operation. Only available for \"Tag\" Operation. */\n  taggerResult?: PhiTaggerResultOutput;\n}\n\n/** Result of the \"Tag\" operation. */\nexport interface PhiTaggerResultOutput {\n  /** List of entities detected in the input. */\n  entities: Array<PhiEntityOutput>;\n  /** Path to the document in storage. */\n  path?: string;\n  /** The entity tag for this resource. */\n  etag?: string;\n}\n\n/** PHI Entity tag in the input. */\nexport interface PhiEntityOutput {\n  /**\n   * PHI Category of the entity.\n   *\n   * Possible values: \"Unknown\", \"Account\", \"Age\", \"BioID\", \"City\", \"CountryOrRegion\", \"Date\", \"Device\", \"Doctor\", \"Email\", \"Fax\", \"HealthPlan\", \"Hospital\", \"IDNum\", \"IPAddress\", \"License\", \"LocationOther\", \"MedicalRecord\", \"Organization\", \"Patient\", \"Phone\", \"Profession\", \"SocialSecurity\", \"State\", \"Street\", \"Url\", \"Username\", \"Vehicle\", \"Zip\"\n   */\n  category: PhiCategoryOutput;\n  /** Starting index of the location from within the input text. */\n  offset: StringIndexOutput;\n  /** Length of the input text. */\n  length: StringIndexOutput;\n  /** Text of the entity. */\n  text?: string;\n  /** Confidence score of the category match. */\n  confidenceScore?: number;\n}\n\n/** String index encoding model. */\nexport interface StringIndexOutput {\n  /** The offset or length of the substring in UTF-8 encoding */\n  utf8: number;\n  /**\n   * The offset or length of the substring in UTF-16 encoding.\n   *\n   * Primary encoding used by .NET, Java, and JavaScript.\n   */\n  utf16: number;\n  /**\n   * The offset or length of the substring in CodePoint encoding.\n   *\n   * Primary encoding used by Python.\n   */\n  codePoint: number;\n}\n\n/** Alias for OperationTypeOutput */\nexport type OperationTypeOutput = string;\n/** Alias for DocumentDataTypeOutput */\nexport type DocumentDataTypeOutput = string;\n/** Alias for JobStatusOutput */\nexport type JobStatusOutput = string;\n/** Paged collection of DeidentificationJob items */\nexport type PagedDeidentificationJobOutput = Paged<DeidentificationJobOutput>;\n/** Paged collection of DocumentDetails items */\nexport type PagedDocumentDetailsOutput = Paged<DocumentDetailsOutput>;\n/** Alias for OperationStateOutput */\nexport type OperationStateOutput = string;\n/** Alias for PhiCategoryOutput */\nexport type PhiCategoryOutput = string;\n"]}
+{"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\nimport type { ErrorModel } from \"@azure-rest/core-client\";\n\n/** A job containing a batch of documents to de-identify. */\nexport interface DeidentificationJobOutput {\n  /** The name of a job. */\n  readonly name: string;\n  /**\n   * Operation to perform on the input documents.\n   *\n   * Possible values: \"Redact\", \"Surrogate\", \"Tag\"\n   */\n  operation?: DeidentificationOperationTypeOutput;\n  /** Storage location to perform the operation on. */\n  sourceLocation: SourceStorageLocationOutput;\n  /** Target location to store output of operation. */\n  targetLocation: TargetStorageLocationOutput;\n  /** Customization parameters to override default service behaviors. */\n  customizations?: DeidentificationJobCustomizationOptionsOutput;\n  /**\n   * Current status of a job.\n   *\n   * Possible values: \"NotStarted\", \"Running\", \"Succeeded\", \"Failed\", \"Canceled\"\n   */\n  readonly status: OperationStateOutput;\n  /** Error when job fails in it's entirety. */\n  readonly error?: ErrorModel;\n  /**\n   * Date and time when the job was completed.\n   *\n   * If the job is canceled, this is the time when the job was canceled.\n   *\n   * If the job failed, this is the time when the job failed.\n   */\n  readonly lastUpdatedAt: string;\n  /** Date and time when the job was created. */\n  readonly createdAt: string;\n  /** Date and time when the job was started. */\n  readonly startedAt?: string;\n  /** Summary of a job. Exists only when the job is completed. */\n  readonly summary?: DeidentificationJobSummaryOutput;\n}\n\n/** Storage location. */\nexport interface SourceStorageLocationOutput {\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 TargetStorageLocationOutput {\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 DeidentificationJobCustomizationOptionsOutput {\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 DeidentificationJobSummaryOutput {\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/** Paged collection of DeidentificationJob items */\nexport interface PagedDeidentificationJobOutput {\n  /** The DeidentificationJob items on this page */\n  value: Array<DeidentificationJobOutput>;\n  /** The link to the next page of items */\n  nextLink?: string;\n}\n\n/** Paged collection of DeidentificationDocumentDetails items */\nexport interface PagedDeidentificationDocumentDetailsOutput {\n  /** The DeidentificationDocumentDetails items on this page */\n  value: Array<DeidentificationDocumentDetailsOutput>;\n  /** The link to the next page of items */\n  nextLink?: string;\n}\n\n/** Details of a single document in a job. */\nexport interface DeidentificationDocumentDetailsOutput {\n  /** Id of the document details. */\n  readonly id: string;\n  /** Location for the input. */\n  input: DeidentificationDocumentLocationOutput;\n  /** Location for the output. */\n  output?: DeidentificationDocumentLocationOutput;\n  /**\n   * Status of the document.\n   *\n   * Possible values: \"NotStarted\", \"Running\", \"Succeeded\", \"Failed\", \"Canceled\"\n   */\n  status: OperationStateOutput;\n  /** Error when document fails. */\n  error?: ErrorModel;\n}\n\n/** Location of a document. */\nexport interface DeidentificationDocumentLocationOutput {\n  /** Location of document in storage. */\n  location: string;\n  /** The entity tag for this resource. */\n  readonly etag: string;\n}\n\n/** Response body for de-identification operation. */\nexport interface DeidentificationResultOutput {\n  /** Output text after de-identification. Not available for \"Tag\" operation. */\n  outputText?: string;\n  /** Result of the \"Tag\" operation. Only available for \"Tag\" Operation. */\n  taggerResult?: PhiTaggerResultOutput;\n}\n\n/** Result of the \"Tag\" operation. */\nexport interface PhiTaggerResultOutput {\n  /** List of entities detected in the input. */\n  entities: Array<PhiEntityOutput>;\n}\n\n/** PHI Entity tag in the input. */\nexport interface PhiEntityOutput {\n  /**\n   * PHI Category of the entity.\n   *\n   * Possible values: \"Unknown\", \"Account\", \"Age\", \"BioID\", \"City\", \"CountryOrRegion\", \"Date\", \"Device\", \"Doctor\", \"Email\", \"Fax\", \"HealthPlan\", \"Hospital\", \"IDNum\", \"IPAddress\", \"License\", \"LocationOther\", \"MedicalRecord\", \"Organization\", \"Patient\", \"Phone\", \"Profession\", \"SocialSecurity\", \"State\", \"Street\", \"Url\", \"Username\", \"Vehicle\", \"Zip\"\n   */\n  category: PhiCategoryOutput;\n  /** Starting index of the location from within the input text. */\n  offset: StringIndexOutput;\n  /** Length of the input text. */\n  length: StringIndexOutput;\n  /** Text of the entity. */\n  text?: string;\n  /** Confidence score of the category match. */\n  confidenceScore?: number;\n}\n\n/** String index encoding model. */\nexport interface StringIndexOutput {\n  /** The offset or length of the substring in UTF-8 encoding */\n  utf8: number;\n  /**\n   * The offset or length of the substring in UTF-16 encoding.\n   *\n   * Primary encoding used by .NET, Java, and JavaScript.\n   */\n  utf16: number;\n  /**\n   * The offset or length of the substring in CodePoint encoding.\n   *\n   * Primary encoding used by Python.\n   */\n  codePoint: number;\n}\n\n/** Alias for DeidentificationOperationTypeOutput */\nexport type DeidentificationOperationTypeOutput = string;\n/** Alias for OperationStateOutput */\nexport type OperationStateOutput = string;\n/** Alias for PhiCategoryOutput */\nexport type PhiCategoryOutput = string;\n"]}

package/dist/commonjs/paginateHelper.d.ts

@@ -1,5 +1,30 @@
-import { PagedAsyncIterableIterator } from "@azure/core-paging";
-import { Client, PathUncheckedResponse } from "@azure-rest/core-client";
+import type { Client, PathUncheckedResponse } from "@azure-rest/core-client";
+/**
+ * An interface that tracks the settings for paged iteration
+ */
+export interface PageSettings {
+    /**
+     * The token that keeps track of where to continue the iterator
+     */
+    continuationToken?: string;
+}
+/**
+ * An interface that allows async iterable iteration both to completion and by page.
+ */
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings = PageSettings> {
+    /**
+     * The next method, part of the iteration protocol
+     */
+    next(): Promise<IteratorResult<TElement>>;
+    /**
+     * The connection to the async iterator, part of the iteration protocol
+     */
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    /**
+     * Return an AsyncIterableIterator that works a page at a time
+     */
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;
+}
 /**
  * Helper type to extract the type of an array
  */
@@ -7,7 +32,7 @@ export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
 /**
  * The type of a custom function that defines how to get a page and a link to the next one if any.
  */
-export type GetPage<TPage> = (pageLink: string, maxPageSize?: number) => Promise<{
+export type GetPage<TPage> = (pageLink: string) => Promise<{
     page: TPage;
     nextPageLink?: string;
 }>;

package/dist/commonjs/paginateHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paginateHelper.d.ts","sourceRoot":"","sources":["../../src/paginateHelper.ts"],"names":[],"mappings":"AAGA,OAAO,EAAyB,0BAA0B,EAAe,MAAM,oBAAoB,CAAC;AACpG,OAAO,EAAE,MAAM,EAAmB,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEzF;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,IAAI,CAC3B,QAAQ,EAAE,MAAM,EAChB,WAAW,CAAC,EAAE,MAAM,KACjB,OAAO,CAAC;IACX,IAAI,EAAE,KAAK,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,SAAS;IACtC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;CACtD;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,CAAC,OAAO,IAAI,OAAO,SAAS;IACpD,IAAI,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAA;KAAE,CAAC;CAC/B,GACG,YAAY,CAAC,KAAK,CAAC,GACnB,KAAK,CAAC,OAAO,CAAC,CAAC;AAEnB;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,SAAS,SAAS,qBAAqB,EAC9D,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,SAAS,EAC1B,OAAO,GAAE,aAAa,CAAC,SAAS,CAAM,GACrC,0BAA0B,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CA0BvD"}
+{"version":3,"file":"paginateHelper.d.ts","sourceRoot":"","sources":["../../src/paginateHelper.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAuF7E;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B,CACzC,QAAQ,EACR,KAAK,GAAG,QAAQ,EAAE,EAClB,aAAa,GAAG,YAAY;IAE5B;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1C;;OAEG;IACH,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,0BAA0B,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;IACrF;;OAEG;IACH,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,aAAa,KAAK,qBAAqB,CAAC,KAAK,CAAC,CAAC;CACpE;AAyBD;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC;IACzD,IAAI,EAAE,KAAK,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,SAAS;IACtC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;CACtD;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,CAAC,OAAO,IAAI,OAAO,SAAS;IACpD,IAAI,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAA;KAAE,CAAC;CAC/B,GACG,YAAY,CAAC,KAAK,CAAC,GACnB,KAAK,CAAC,OAAO,CAAC,CAAC;AAEnB;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,SAAS,SAAS,qBAAqB,EAC9D,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,SAAS,EAC1B,OAAO,GAAE,aAAa,CAAC,SAAS,CAAM,GACrC,0BAA0B,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CA0BvD"}

package/dist/commonjs/paginateHelper.js

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

package/dist/commonjs/paginateHelper.js.map

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