@azure-rest/ai-document-translator 1.0.0-beta.1 → 1.0.0-beta.2

package/dist/commonjs/logger.d.ts

@@ -0,0 +1,2 @@
+export declare const logger: import("@azure/logger").AzureLogger;
+//# sourceMappingURL=logger.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,MAAM,qCAA+C,CAAC"}

package/dist/commonjs/logger.js

@@ -0,0 +1,8 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const logger_1 = require("@azure/logger");
+exports.logger = (0, logger_1.createClientLogger)("ai-document-translator");
+//# sourceMappingURL=logger.js.map

package/dist/commonjs/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,0CAAmD;AACtC,QAAA,MAAM,GAAG,IAAA,2BAAkB,EAAC,wBAAwB,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { createClientLogger } from \"@azure/logger\";\nexport const logger = createClientLogger(\"ai-document-translator\");\n"]}

package/dist/commonjs/models.d.ts

@@ -0,0 +1,69 @@
+/** Translation job submission batch request */
+export interface StartTranslationDetails {
+    /** The input list of documents or folders containing documents */
+    inputs: Array<BatchRequest>;
+}
+/** Definition for the input batch translation request */
+export interface BatchRequest {
+    /** Source of the input documents */
+    source: SourceInput;
+    /** Location of the destination for the output */
+    targets: Array<TargetInput>;
+    /** Storage type of the input documents source string */
+    storageType?: "Folder" | "File";
+}
+/** Source of the input documents */
+export interface SourceInput {
+    /** Location of the folder / container or single file with your documents */
+    sourceUrl: string;
+    filter?: DocumentFilter;
+    /**
+     * Language code
+     * If none is specified, we will perform auto detect on the document
+     */
+    language?: string;
+    /** Storage Source */
+    storageSource?: "AzureBlob";
+}
+export interface DocumentFilter {
+    /**
+     * A case-sensitive prefix string to filter documents in the source path for translation.
+     * For example, when using a Azure storage blob Uri, use the prefix to restrict sub folders for translation.
+     */
+    prefix?: string;
+    /**
+     * A case-sensitive suffix string to filter documents in the source path for translation.
+     * This is most often use for file extensions
+     */
+    suffix?: string;
+}
+/** Destination for the finished translated documents */
+export interface TargetInput {
+    /** Location of the folder / container with your documents */
+    targetUrl: string;
+    /** Category / custom system for translation request */
+    category?: string;
+    /** Target Language */
+    language: string;
+    /** List of Glossary */
+    glossaries?: Array<Glossary>;
+    /** Storage Source */
+    storageSource?: "AzureBlob";
+}
+/** Glossary / translation memory for the request */
+export interface Glossary {
+    /**
+     * Location of the glossary.
+     * We will use the file extension to extract the formatting if the format parameter is not supplied.
+     *
+     * If the translation language pair is not present in the glossary, it will not be applied
+     */
+    glossaryUrl: string;
+    /** Format */
+    format: string;
+    /** Optional Version.  If not specified, default is used. */
+    version?: string;
+    /** Storage Source */
+    storageSource?: "AzureBlob";
+}
+//# sourceMappingURL=models.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAGA,+CAA+C;AAC/C,MAAM,WAAW,uBAAuB;IACtC,kEAAkE;IAClE,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;CAC7B;AAED,yDAAyD;AACzD,MAAM,WAAW,YAAY;IAC3B,oCAAoC;IACpC,MAAM,EAAE,WAAW,CAAC;IACpB,iDAAiD;IACjD,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC5B,wDAAwD;IACxD,WAAW,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CACjC;AAED,oCAAoC;AACpC,MAAM,WAAW,WAAW;IAC1B,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qBAAqB;IACrB,aAAa,CAAC,EAAE,WAAW,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,wDAAwD;AACxD,MAAM,WAAW,WAAW;IAC1B,6DAA6D;IAC7D,SAAS,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sBAAsB;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,uBAAuB;IACvB,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC7B,qBAAqB;IACrB,aAAa,CAAC,EAAE,WAAW,CAAC;CAC7B;AAED,oDAAoD;AACpD,MAAM,WAAW,QAAQ;IACvB;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qBAAqB;IACrB,aAAa,CAAC,EAAE,WAAW,CAAC;CAC7B"}

package/dist/commonjs/models.js

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

package/dist/commonjs/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** Translation job submission batch request */\nexport interface StartTranslationDetails {\n  /** The input list of documents or folders containing documents */\n  inputs: Array<BatchRequest>;\n}\n\n/** Definition for the input batch translation request */\nexport interface BatchRequest {\n  /** Source of the input documents */\n  source: SourceInput;\n  /** Location of the destination for the output */\n  targets: Array<TargetInput>;\n  /** Storage type of the input documents source string */\n  storageType?: \"Folder\" | \"File\";\n}\n\n/** Source of the input documents */\nexport interface SourceInput {\n  /** Location of the folder / container or single file with your documents */\n  sourceUrl: string;\n  filter?: DocumentFilter;\n  /**\n   * Language code\n   * If none is specified, we will perform auto detect on the document\n   */\n  language?: string;\n  /** Storage Source */\n  storageSource?: \"AzureBlob\";\n}\n\nexport interface DocumentFilter {\n  /**\n   * A case-sensitive prefix string to filter documents in the source path for translation.\n   * For example, when using a Azure storage blob Uri, use the prefix to restrict sub folders for translation.\n   */\n  prefix?: string;\n  /**\n   * A case-sensitive suffix string to filter documents in the source path for translation.\n   * This is most often use for file extensions\n   */\n  suffix?: string;\n}\n\n/** Destination for the finished translated documents */\nexport interface TargetInput {\n  /** Location of the folder / container with your documents */\n  targetUrl: string;\n  /** Category / custom system for translation request */\n  category?: string;\n  /** Target Language */\n  language: string;\n  /** List of Glossary */\n  glossaries?: Array<Glossary>;\n  /** Storage Source */\n  storageSource?: \"AzureBlob\";\n}\n\n/** Glossary / translation memory for the request */\nexport interface Glossary {\n  /**\n   * Location of the glossary.\n   * We will use the file extension to extract the formatting if the format parameter is not supplied.\n   *\n   * If the translation language pair is not present in the glossary, it will not be applied\n   */\n  glossaryUrl: string;\n  /** Format */\n  format: string;\n  /** Optional Version.  If not specified, default is used. */\n  version?: string;\n  /** Storage Source */\n  storageSource?: \"AzureBlob\";\n}\n"]}

package/dist/commonjs/outputModels.d.ts

@@ -0,0 +1,144 @@
+/**
+ * Contains unified error information used for HTTP responses across any Cognitive Service. Instances
+ * can be created either through Microsoft.CloudAI.Containers.HttpStatusExceptionV2 or by returning it directly from
+ * a controller.
+ */
+export interface TranslationErrorResponseOutput {
+    /** This contains an outer error with error code, message, details, target and an inner error with more descriptive details. */
+    error?: TranslationErrorOutput;
+}
+/** This contains an outer error with error code, message, details, target and an inner error with more descriptive details. */
+export interface TranslationErrorOutput {
+    /** Enums containing high level error codes. */
+    code: "InvalidRequest" | "InvalidArgument" | "InternalServerError" | "ServiceUnavailable" | "ResourceNotFound" | "Unauthorized" | "RequestRateTooHigh";
+    /** Gets high level error message. */
+    message: string;
+    /**
+     * Gets the source of the error.
+     * For example it would be "documents" or "document id" in case of invalid document.
+     */
+    readonly target?: string;
+    /**
+     * New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.
+     * This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
+     */
+    innerError?: InnerTranslationErrorOutput;
+}
+/**
+ * New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.
+ * This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
+ */
+export interface InnerTranslationErrorOutput {
+    /** Gets code error string. */
+    code: string;
+    /** Gets high level error message. */
+    message: string;
+    /**
+     * Gets the source of the error.
+     * For example it would be "documents" or "document id" in case of invalid document.
+     */
+    readonly target?: string;
+    /**
+     * New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.
+     * This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
+     */
+    innerError?: InnerTranslationErrorOutput;
+}
+/** Translation job Status Response */
+export interface TranslationsStatusOutput {
+    /** The summary status of individual operation */
+    value: Array<TranslationStatusOutput>;
+    /** Url for the next page.  Null if no more pages available */
+    "@nextLink"?: string;
+}
+/** Translation job status response */
+export interface TranslationStatusOutput {
+    /**
+     * Id of the operation.
+     *
+     * Value may contain a UUID
+     */
+    id: string;
+    /** Operation created date time */
+    createdDateTimeUtc: string;
+    /** Date time in which the operation's status has been updated */
+    lastActionDateTimeUtc: string;
+    /** List of possible statuses for job or document */
+    status: "NotStarted" | "Running" | "Succeeded" | "Failed" | "Cancelled" | "Cancelling" | "ValidationFailed";
+    /** This contains an outer error with error code, message, details, target and an inner error with more descriptive details. */
+    error?: TranslationErrorOutput;
+    summary: StatusSummaryOutput;
+}
+export interface StatusSummaryOutput {
+    /** Total count */
+    total: number;
+    /** Failed count */
+    failed: number;
+    /** Number of Success */
+    success: number;
+    /** Number of in progress */
+    inProgress: number;
+    /** Count of not yet started */
+    notYetStarted: number;
+    /** Number of cancelled */
+    cancelled: number;
+    /** Total characters charged by the API */
+    totalCharacterCharged: number;
+}
+/** Document Status Response */
+export interface DocumentStatusOutput {
+    /** Location of the document or folder */
+    path?: string;
+    /** Location of the source document */
+    sourcePath: string;
+    /** Operation created date time */
+    createdDateTimeUtc: string;
+    /** Date time in which the operation's status has been updated */
+    lastActionDateTimeUtc: string;
+    /** List of possible statuses for job or document */
+    status: "NotStarted" | "Running" | "Succeeded" | "Failed" | "Cancelled" | "Cancelling" | "ValidationFailed";
+    /** To language */
+    to: string;
+    /** This contains an outer error with error code, message, details, target and an inner error with more descriptive details. */
+    error?: TranslationErrorOutput;
+    /** Progress of the translation if available */
+    progress: number;
+    /**
+     * Document Id
+     *
+     * Value may contain a UUID
+     */
+    id: string;
+    /** Character charged by the API */
+    characterCharged?: number;
+}
+/** Documents Status Response */
+export interface DocumentsStatusOutput {
+    /** The detail status of individual documents */
+    value: Array<DocumentStatusOutput>;
+    /** Url for the next page.  Null if no more pages available */
+    "@nextLink"?: string;
+}
+/** Base type for List return in our api */
+export interface SupportedFileFormatsOutput {
+    /** list of objects */
+    value: Array<FileFormatOutput>;
+}
+export interface FileFormatOutput {
+    /** Name of the format */
+    format: string;
+    /** Supported file extension for this format */
+    fileExtensions: Array<string>;
+    /** Supported Content-Types for this format */
+    contentTypes: Array<string>;
+    /** Default version if none is specified */
+    defaultVersion?: string;
+    /** Supported Version */
+    versions?: Array<string>;
+}
+/** Base type for List return in our api */
+export interface SupportedStorageSourcesOutput {
+    /** list of objects */
+    value: Array<"AzureBlob">;
+}
+//# sourceMappingURL=outputModels.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,+HAA+H;IAC/H,KAAK,CAAC,EAAE,sBAAsB,CAAC;CAChC;AAED,+HAA+H;AAC/H,MAAM,WAAW,sBAAsB;IACrC,+CAA+C;IAC/C,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,qBAAqB,GACrB,oBAAoB,GACpB,kBAAkB,GAClB,cAAc,GACd,oBAAoB,CAAC;IACzB,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,UAAU,CAAC,EAAE,2BAA2B,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,UAAU,CAAC,EAAE,2BAA2B,CAAC;CAC1C;AAED,sCAAsC;AACtC,MAAM,WAAW,wBAAwB;IACvC,iDAAiD;IACjD,KAAK,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;IACtC,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,sCAAsC;AACtC,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,kCAAkC;IAClC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iEAAiE;IACjE,qBAAqB,EAAE,MAAM,CAAC;IAC9B,oDAAoD;IACpD,MAAM,EACF,YAAY,GACZ,SAAS,GACT,WAAW,GACX,QAAQ,GACR,WAAW,GACX,YAAY,GACZ,kBAAkB,CAAC;IACvB,+HAA+H;IAC/H,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,OAAO,EAAE,mBAAmB,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAClC,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,+BAA+B;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAED,+BAA+B;AAC/B,MAAM,WAAW,oBAAoB;IACnC,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iEAAiE;IACjE,qBAAqB,EAAE,MAAM,CAAC;IAC9B,oDAAoD;IACpD,MAAM,EACF,YAAY,GACZ,SAAS,GACT,WAAW,GACX,QAAQ,GACR,WAAW,GACX,YAAY,GACZ,kBAAkB,CAAC;IACvB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,+HAA+H;IAC/H,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,mCAAmC;IACnC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,gCAAgC;AAChC,MAAM,WAAW,qBAAqB;IACpC,gDAAgD;IAChD,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACnC,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,2CAA2C;AAC3C,MAAM,WAAW,0BAA0B;IACzC,sBAAsB;IACtB,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B,yBAAyB;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC9B,8CAA8C;IAC9C,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B,2CAA2C;IAC3C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,wBAAwB;IACxB,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED,2CAA2C;AAC3C,MAAM,WAAW,6BAA6B;IAC5C,sBAAsB;IACtB,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC3B"}

package/dist/commonjs/outputModels.js

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

package/dist/commonjs/outputModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Contains unified error information used for HTTP responses across any Cognitive Service. Instances\n * can be created either through Microsoft.CloudAI.Containers.HttpStatusExceptionV2 or by returning it directly from\n * a controller.\n */\nexport interface TranslationErrorResponseOutput {\n  /** This contains an outer error with error code, message, details, target and an inner error with more descriptive details. */\n  error?: TranslationErrorOutput;\n}\n\n/** This contains an outer error with error code, message, details, target and an inner error with more descriptive details. */\nexport interface TranslationErrorOutput {\n  /** Enums containing high level error codes. */\n  code:\n    | \"InvalidRequest\"\n    | \"InvalidArgument\"\n    | \"InternalServerError\"\n    | \"ServiceUnavailable\"\n    | \"ResourceNotFound\"\n    | \"Unauthorized\"\n    | \"RequestRateTooHigh\";\n  /** Gets high level error message. */\n  message: string;\n  /**\n   * Gets the source of the error.\n   * For example it would be \"documents\" or \"document id\" in case of invalid document.\n   */\n  readonly target?: string;\n  /**\n   * New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\n   * This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).\n   */\n  innerError?: InnerTranslationErrorOutput;\n}\n\n/**\n * New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\n * This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).\n */\nexport interface InnerTranslationErrorOutput {\n  /** Gets code error string. */\n  code: string;\n  /** Gets high level error message. */\n  message: string;\n  /**\n   * Gets the source of the error.\n   * For example it would be \"documents\" or \"document id\" in case of invalid document.\n   */\n  readonly target?: string;\n  /**\n   * New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\n   * This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).\n   */\n  innerError?: InnerTranslationErrorOutput;\n}\n\n/** Translation job Status Response */\nexport interface TranslationsStatusOutput {\n  /** The summary status of individual operation */\n  value: Array<TranslationStatusOutput>;\n  /** Url for the next page.  Null if no more pages available */\n  \"@nextLink\"?: string;\n}\n\n/** Translation job status response */\nexport interface TranslationStatusOutput {\n  /**\n   * Id of the operation.\n   *\n   * Value may contain a UUID\n   */\n  id: string;\n  /** Operation created date time */\n  createdDateTimeUtc: string;\n  /** Date time in which the operation's status has been updated */\n  lastActionDateTimeUtc: string;\n  /** List of possible statuses for job or document */\n  status:\n    | \"NotStarted\"\n    | \"Running\"\n    | \"Succeeded\"\n    | \"Failed\"\n    | \"Cancelled\"\n    | \"Cancelling\"\n    | \"ValidationFailed\";\n  /** This contains an outer error with error code, message, details, target and an inner error with more descriptive details. */\n  error?: TranslationErrorOutput;\n  summary: StatusSummaryOutput;\n}\n\nexport interface StatusSummaryOutput {\n  /** Total count */\n  total: number;\n  /** Failed count */\n  failed: number;\n  /** Number of Success */\n  success: number;\n  /** Number of in progress */\n  inProgress: number;\n  /** Count of not yet started */\n  notYetStarted: number;\n  /** Number of cancelled */\n  cancelled: number;\n  /** Total characters charged by the API */\n  totalCharacterCharged: number;\n}\n\n/** Document Status Response */\nexport interface DocumentStatusOutput {\n  /** Location of the document or folder */\n  path?: string;\n  /** Location of the source document */\n  sourcePath: string;\n  /** Operation created date time */\n  createdDateTimeUtc: string;\n  /** Date time in which the operation's status has been updated */\n  lastActionDateTimeUtc: string;\n  /** List of possible statuses for job or document */\n  status:\n    | \"NotStarted\"\n    | \"Running\"\n    | \"Succeeded\"\n    | \"Failed\"\n    | \"Cancelled\"\n    | \"Cancelling\"\n    | \"ValidationFailed\";\n  /** To language */\n  to: string;\n  /** This contains an outer error with error code, message, details, target and an inner error with more descriptive details. */\n  error?: TranslationErrorOutput;\n  /** Progress of the translation if available */\n  progress: number;\n  /**\n   * Document Id\n   *\n   * Value may contain a UUID\n   */\n  id: string;\n  /** Character charged by the API */\n  characterCharged?: number;\n}\n\n/** Documents Status Response */\nexport interface DocumentsStatusOutput {\n  /** The detail status of individual documents */\n  value: Array<DocumentStatusOutput>;\n  /** Url for the next page.  Null if no more pages available */\n  \"@nextLink\"?: string;\n}\n\n/** Base type for List return in our api */\nexport interface SupportedFileFormatsOutput {\n  /** list of objects */\n  value: Array<FileFormatOutput>;\n}\n\nexport interface FileFormatOutput {\n  /** Name of the format */\n  format: string;\n  /** Supported file extension for this format */\n  fileExtensions: Array<string>;\n  /** Supported Content-Types for this format */\n  contentTypes: Array<string>;\n  /** Default version if none is specified */\n  defaultVersion?: string;\n  /** Supported Version */\n  versions?: Array<string>;\n}\n\n/** Base type for List return in our api */\nexport interface SupportedStorageSourcesOutput {\n  /** list of objects */\n  value: Array<\"AzureBlob\">;\n}\n"]}

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/commonjs/paginateHelper.d.ts

@@ -0,0 +1,68 @@
+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
+ */
+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) => Promise<{
+    page: TPage;
+    nextPageLink?: string;
+}>;
+/**
+ * Options for the paging helper
+ */
+export interface PagingOptions<TResponse> {
+    /**
+     * Custom function to extract pagination details for crating the PagedAsyncIterableIterator
+     */
+    customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
+}
+/**
+ * Helper type to infer the Type of the paged elements from the response type
+ * This type is generated based on the swagger information for x-ms-pageable
+ * specifically on the itemName property which indicates the property of the response
+ * where the page items are found. The default value is `value`.
+ * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
+ */
+export type PaginateReturn<TResult> = TResult extends {
+    body: {
+        value?: infer TPage;
+    };
+} ? GetArrayType<TPage> : Array<unknown>;
+/**
+ * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
+ * @param client - Client to use for sending the next page requests
+ * @param initialResponse - Initial response containing the nextLink and current page of elements
+ * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
+ * @returns - PagedAsyncIterableIterator to iterate the elements
+ */
+export declare function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
+//# sourceMappingURL=paginateHelper.d.ts.map

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,170 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paginate = paginate;
+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
+ * @param initialResponse - Initial response containing the nextLink and current page of elements
+ * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
+ * @returns - PagedAsyncIterableIterator to iterate the elements
+ */
+function paginate(client, initialResponse, options = {}) {
+    let firstRun = true;
+    const itemName = "value";
+    const nextLinkName = "nextLink";
+    const { customGetPage } = options;
+    const pagedResult = {
+        firstPageLink: "",
+        getPage: typeof customGetPage === "function"
+            ? customGetPage
+            : async (pageLink) => {
+                const result = firstRun ? initialResponse : await client.pathUnchecked(pageLink).get();
+                firstRun = false;
+                checkPagingRequest(result);
+                const nextLink = getNextLink(result.body, nextLinkName);
+                const values = getElements(result.body, itemName);
+                return {
+                    page: values,
+                    nextPageLink: nextLink,
+                };
+            },
+    };
+    return getPagedAsyncIterator(pagedResult);
+}
+/**
+ * Gets for the value of nextLink in the body
+ */
+function getNextLink(body, nextLinkName) {
+    if (!nextLinkName) {
+        return undefined;
+    }
+    const nextLink = body[nextLinkName];
+    if (typeof nextLink !== "string" && typeof nextLink !== "undefined") {
+        throw new Error(`Body Property ${nextLinkName} should be a string or undefined`);
+    }
+    return nextLink;
+}
+/**
+ * Gets the elements of the current request in the body.
+ */
+function getElements(body, itemName) {
+    const value = body[itemName];
+    // value has to be an array according to the x-ms-pageable extension.
+    // The fact that this must be an array is used above to calculate the
+    // type of elements in the page in PaginateReturn
+    if (!Array.isArray(value)) {
+        throw new Error(`Couldn't paginate response\n Body doesn't contain an array property with name: ${itemName}`);
+    }
+    return value !== null && value !== void 0 ? value : [];
+}
+/**
+ * Checks if a request failed
+ */
+function checkPagingRequest(response) {
+    const Http2xxStatusCodes = ["200", "201", "202", "203", "204", "205", "206", "207", "208", "226"];
+    if (!Http2xxStatusCodes.includes(response.status)) {
+        throw (0, core_client_1.createRestError)(`Pagination failed with unexpected statusCode ${response.status}`, response);
+    }
+}
+//# sourceMappingURL=paginateHelper.js.map

package/dist/commonjs/paginateHelper.js.map

@@ -0,0 +1 @@
+{"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"]}