@azure-rest/ai-translation-document 1.0.0-alpha.20250227.1 → 1.0.0-alpha.20250228.1

package/dist/browser/clientDefinitions.d.ts

@@ -0,0 +1,191 @@
+import type { DocumentTranslateParameters, StartTranslationParameters, GetTranslationsStatusParameters, GetDocumentStatusParameters, GetTranslationStatusParameters, CancelTranslationParameters, GetDocumentsStatusParameters, GetSupportedFormatsParameters } from "./parameters.js";
+import type { DocumentTranslate200Response, DocumentTranslateDefaultResponse, StartTranslation202Response, StartTranslationDefaultResponse, GetTranslationsStatus200Response, GetTranslationsStatusDefaultResponse, GetDocumentStatus200Response, GetDocumentStatusDefaultResponse, GetTranslationStatus200Response, GetTranslationStatusDefaultResponse, CancelTranslation200Response, CancelTranslationDefaultResponse, GetDocumentsStatus200Response, GetDocumentsStatusDefaultResponse, GetSupportedFormats200Response, GetSupportedFormatsDefaultResponse } from "./responses.js";
+import type { Client, StreamableMethod } from "@azure-rest/core-client";
+export interface DocumentTranslate {
+    /** Use this API to submit a single translation request to the Document Translation Service. */
+    post(options: DocumentTranslateParameters): StreamableMethod<DocumentTranslate200Response | DocumentTranslateDefaultResponse>;
+}
+export interface StartTranslation {
+    /**
+     * Use this API to submit a bulk (batch) translation request to the Document
+     * Translation service.
+     * Each request can contain multiple documents and must
+     * contain a source and destination container for each document.
+     *
+     * The
+     * prefix and suffix filter (if supplied) are used to filter folders. The prefix
+     * is applied to the subpath after the container name.
+     *
+     * Glossaries /
+     * Translation memory can be included in the request and are applied by the
+     * service when the document is translated.
+     *
+     * If the glossary is
+     * invalid or unreachable during translation, an error is indicated in the
+     * document status.
+     * If a file with the same name already exists at the
+     * destination, it will be overwritten. The targetUrl for each target language
+     * must be unique.
+     */
+    post(options: StartTranslationParameters): StreamableMethod<StartTranslation202Response | StartTranslationDefaultResponse>;
+    /**
+     * Returns a list of batch requests submitted and the status for each
+     * request.
+     * This list only contains batch requests submitted by the user (based on
+     * the resource).
+     *
+     * If the number of requests exceeds our paging limit,
+     * server-side paging is used. Paginated responses indicate a partial result and
+     * include a continuation token in the response.
+     * The absence of a continuation
+     * token means that no additional pages are available.
+     *
+     * top, skip
+     * and maxpagesize query parameters can be used to specify a number of results to
+     * return and an offset for the collection.
+     *
+     * top indicates the total
+     * number of records the user wants to be returned across all pages.
+     * skip
+     * indicates the number of records to skip from the list of batches based on the
+     * sorting method specified.  By default, we sort by descending start
+     * time.
+     * maxpagesize is the maximum items returned in a page.  If more items are
+     * requested via top (or top is not specified and there are more items to be
+     * returned), @nextLink will contain the link to the next page.
+     *
+     *
+     * orderby query parameter can be used to sort the returned list (ex
+     * "orderby=createdDateTimeUtc asc" or "orderby=createdDateTimeUtc
+     * desc").
+     * The default sorting is descending by createdDateTimeUtc.
+     * Some query
+     * parameters can be used to filter the returned list (ex:
+     * "status=Succeeded,Cancelled") will only return succeeded and cancelled
+     * operations.
+     * createdDateTimeUtcStart and createdDateTimeUtcEnd can be used
+     * combined or separately to specify a range of datetime to filter the returned
+     * list by.
+     * The supported filtering query parameters are (status, ids,
+     * createdDateTimeUtcStart, createdDateTimeUtcEnd).
+     *
+     * The server honors
+     * the values specified by the client. However, clients must be prepared to handle
+     * responses that contain a different page size or contain a continuation token.
+     *
+     *
+     * When both top and skip are included, the server should first apply
+     * skip and then top on the collection.
+     * Note: If the server can't honor top
+     * and/or skip, the server must return an error to the client informing about it
+     * instead of just ignoring the query options.
+     * This reduces the risk of the client
+     * making assumptions about the data returned.
+     */
+    get(options?: GetTranslationsStatusParameters): StreamableMethod<GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse>;
+}
+export interface GetDocumentStatus {
+    /**
+     * Returns the translation status for a specific document based on the request Id
+     * and document Id.
+     */
+    get(options?: GetDocumentStatusParameters): StreamableMethod<GetDocumentStatus200Response | GetDocumentStatusDefaultResponse>;
+}
+export interface GetTranslationStatus {
+    /**
+     * Returns the status for a document translation request.
+     * The status includes the
+     * overall request status, as well as the status for documents that are being
+     * translated as part of that request.
+     */
+    get(options?: GetTranslationStatusParameters): StreamableMethod<GetTranslationStatus200Response | GetTranslationStatusDefaultResponse>;
+    /**
+     * Cancel a currently processing or queued translation.
+     * A translation will not be
+     * cancelled if it is already completed or failed or cancelling. A bad request
+     * will be returned.
+     * All documents that have completed translation will not be
+     * cancelled and will be charged.
+     * All pending documents will be cancelled if
+     * possible.
+     */
+    delete(options?: CancelTranslationParameters): StreamableMethod<CancelTranslation200Response | CancelTranslationDefaultResponse>;
+}
+export interface GetDocumentsStatus {
+    /**
+     * Returns the status for all documents in a batch document translation request.
+     *
+     *
+     * If the number of documents in the response exceeds our paging limit,
+     * server-side paging is used.
+     * Paginated responses indicate a partial result and
+     * include a continuation token in the response. The absence of a continuation
+     * token means that no additional pages are available.
+     *
+     * top, skip
+     * and maxpagesize query parameters can be used to specify a number of results to
+     * return and an offset for the collection.
+     *
+     * top indicates the total
+     * number of records the user wants to be returned across all pages.
+     * skip
+     * indicates the number of records to skip from the list of document status held
+     * by the server based on the sorting method specified.  By default, we sort by
+     * descending start time.
+     * maxpagesize is the maximum items returned in a page.
+     * If more items are requested via top (or top is not specified and there are
+     * more items to be returned), @nextLink will contain the link to the next page.
+     *
+     *
+     * orderby query parameter can be used to sort the returned list (ex
+     * "orderby=createdDateTimeUtc asc" or "orderby=createdDateTimeUtc
+     * desc").
+     * The default sorting is descending by createdDateTimeUtc.
+     * Some query
+     * parameters can be used to filter the returned list (ex:
+     * "status=Succeeded,Cancelled") will only return succeeded and cancelled
+     * documents.
+     * createdDateTimeUtcStart and createdDateTimeUtcEnd can be used
+     * combined or separately to specify a range of datetime to filter the returned
+     * list by.
+     * The supported filtering query parameters are (status, ids,
+     * createdDateTimeUtcStart, createdDateTimeUtcEnd).
+     *
+     * When both top
+     * and skip are included, the server should first apply skip and then top on
+     * the collection.
+     * Note: If the server can't honor top and/or skip, the server
+     * must return an error to the client informing about it instead of just ignoring
+     * the query options.
+     * This reduces the risk of the client making assumptions about
+     * the data returned.
+     */
+    get(options?: GetDocumentsStatusParameters): StreamableMethod<GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse>;
+}
+export interface GetSupportedFormats {
+    /**
+     * The list of supported formats supported by the Document Translation
+     * service.
+     * The list includes the common file extension, as well as the
+     * content-type if using the upload API.
+     */
+    get(options?: GetSupportedFormatsParameters): StreamableMethod<GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse>;
+}
+export interface Routes {
+    /** Resource for '/document:translate' has methods for the following verbs: post */
+    (path: "/document:translate"): DocumentTranslate;
+    /** Resource for '/document/batches' has methods for the following verbs: post, get */
+    (path: "/document/batches"): StartTranslation;
+    /** Resource for '/document/batches/\{id\}/documents/\{documentId\}' has methods for the following verbs: get */
+    (path: "/document/batches/{id}/documents/{documentId}", id: string, documentId: string): GetDocumentStatus;
+    /** Resource for '/document/batches/\{id\}' has methods for the following verbs: get, delete */
+    (path: "/document/batches/{id}", id: string): GetTranslationStatus;
+    /** Resource for '/document/batches/\{id\}/documents' has methods for the following verbs: get */
+    (path: "/document/batches/{id}/documents", id: string): GetDocumentsStatus;
+    /** Resource for '/document/formats' has methods for the following verbs: get */
+    (path: "/document/formats"): GetSupportedFormats;
+}
+export type DocumentTranslationClient = Client & {
+    path: Routes;
+};
+//# sourceMappingURL=clientDefinitions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"clientDefinitions.d.ts","sourceRoot":"","sources":["../../src/clientDefinitions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,2BAA2B,EAC3B,0BAA0B,EAC1B,+BAA+B,EAC/B,2BAA2B,EAC3B,8BAA8B,EAC9B,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC9B,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EACV,4BAA4B,EAC5B,gCAAgC,EAChC,2BAA2B,EAC3B,+BAA+B,EAC/B,gCAAgC,EAChC,oCAAoC,EACpC,4BAA4B,EAC5B,gCAAgC,EAChC,+BAA+B,EAC/B,mCAAmC,EACnC,4BAA4B,EAC5B,gCAAgC,EAChC,6BAA6B,EAC7B,iCAAiC,EACjC,8BAA8B,EAC9B,kCAAkC,EACnC,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAExE,MAAM,WAAW,iBAAiB;IAChC,+FAA+F;IAC/F,IAAI,CACF,OAAO,EAAE,2BAA2B,GACnC,gBAAgB,CAAC,4BAA4B,GAAG,gCAAgC,CAAC,CAAC;CACtF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACF,OAAO,EAAE,0BAA0B,GAClC,gBAAgB,CAAC,2BAA2B,GAAG,+BAA+B,CAAC,CAAC;IACnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,+BAA+B,GACxC,gBAAgB,CAAC,gCAAgC,GAAG,oCAAoC,CAAC,CAAC;CAC9F;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,2BAA2B,GACpC,gBAAgB,CAAC,4BAA4B,GAAG,gCAAgC,CAAC,CAAC;CACtF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,8BAA8B,GACvC,gBAAgB,CAAC,+BAA+B,GAAG,mCAAmC,CAAC,CAAC;IAC3F;;;;;;;;;OASG;IACH,MAAM,CACJ,OAAO,CAAC,EAAE,2BAA2B,GACpC,gBAAgB,CAAC,4BAA4B,GAAG,gCAAgC,CAAC,CAAC;CACtF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,4BAA4B,GACrC,gBAAgB,CAAC,6BAA6B,GAAG,iCAAiC,CAAC,CAAC;CACxF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB,CAAC,8BAA8B,GAAG,kCAAkC,CAAC,CAAC;CAC1F;AAED,MAAM,WAAW,MAAM;IACrB,mFAAmF;IACnF,CAAC,IAAI,EAAE,qBAAqB,GAAG,iBAAiB,CAAC;IACjD,sFAAsF;IACtF,CAAC,IAAI,EAAE,mBAAmB,GAAG,gBAAgB,CAAC;IAC9C,gHAAgH;IAChH,CACE,IAAI,EAAE,+CAA+C,EACrD,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,MAAM,GACjB,iBAAiB,CAAC;IACrB,+FAA+F;IAC/F,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,oBAAoB,CAAC;IACnE,iGAAiG;IACjG,CAAC,IAAI,EAAE,kCAAkC,EAAE,EAAE,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAC3E,gFAAgF;IAChF,CAAC,IAAI,EAAE,mBAAmB,GAAG,mBAAmB,CAAC;CAClD;AAED,MAAM,MAAM,yBAAyB,GAAG,MAAM,GAAG;IAC/C,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/browser/documentTranslationClient.d.ts

@@ -0,0 +1,16 @@
+import type { ClientOptions } from "@azure-rest/core-client";
+import type { TokenCredential, KeyCredential } from "@azure/core-auth";
+import type { DocumentTranslationClient } from "./clientDefinitions.js";
+/** The optional parameters for the client */
+export interface DocumentTranslationClientOptions extends ClientOptions {
+    /** The api version option of the client */
+    apiVersion?: string;
+}
+/**
+ * Initialize a new instance of `DocumentTranslationClient`
+ * @param endpointParam - Supported document Translation endpoint, protocol and hostname, for example: https://{TranslatorResourceName}.cognitiveservices.azure.com/translator.
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
+ */
+export default function createClient(endpointParam: string, credentials: TokenCredential | KeyCredential, { apiVersion, ...options }?: DocumentTranslationClientOptions): DocumentTranslationClient;
+//# sourceMappingURL=documentTranslationClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"documentTranslationClient.d.ts","sourceRoot":"","sources":["../../src/documentTranslationClient.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAExE,6CAA6C;AAC7C,MAAM,WAAW,gCAAiC,SAAQ,aAAa;IACrE,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,eAAe,GAAG,aAAa,EAC5C,EAAE,UAAyB,EAAE,GAAG,OAAO,EAAE,GAAE,gCAAqC,GAC/E,yBAAyB,CAwC3B"}

package/{dist-esm/src → dist/browser}/documentTranslationClient.js

@@ -1,6 +1,6 @@
 import { __rest } from "tslib";
 import { getClient } from "@azure-rest/core-client";
-import { logger } from "./logger";
+import { logger } from "./logger.js";
 /**
  * Initialize a new instance of `DocumentTranslationClient`
  * @param endpointParam - Supported document Translation endpoint, protocol and hostname, for example: https://{TranslatorResourceName}.cognitiveservices.azure.com/translator.

package/dist/browser/documentTranslationClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentTranslationClient.js","sourceRoot":"","sources":["../../src/documentTranslationClient.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAUrC;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAqB,EACrB,WAA4C,EAC5C,KAA8E,EAAE;;QAAhF,EAAE,UAAU,GAAG,YAAY,OAAqD,EAAhD,OAAO,cAAvC,cAAyC,CAAF;IAEvC,MAAM,WAAW,GAAG,MAAA,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,OAAO,mCAAI,GAAG,aAAa,aAAa,CAAC;IACzF,MAAM,aAAa,GAAG,oDAAoD,CAAC;IAC3E,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;QAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,aAAa,EAAE;QAChE,CAAC,CAAC,GAAG,aAAa,EAAE,CAAC;IACzB,OAAO,mCACF,OAAO,KACV,gBAAgB,EAAE;YAChB,eAAe;SAChB,EACD,cAAc,EAAE;YACd,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,MAAM,mCAAI,MAAM,CAAC,IAAI;SACtD,EACD,WAAW,EAAE;YACX,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,WAAW,0CAAE,MAAM,mCAAI,CAAC,8CAA8C,CAAC;YACvF,gBAAgB,EAAE,MAAA,MAAA,OAAO,CAAC,WAAW,0CAAE,gBAAgB,mCAAI,2BAA2B;SACvF,GACF,CAAC;IACF,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAA8B,CAAC;IAEzF,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC3D,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxB,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACzB,qDAAqD;YACrD,yEAAyE;YACzE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,UAAU,EAAE,CAAC;gBACvD,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GACzD,eAAe,UAAU,EAAE,CAAC;YAC9B,CAAC;YAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nimport type { ClientOptions } from \"@azure-rest/core-client\";\nimport { getClient } from \"@azure-rest/core-client\";\nimport { logger } from \"./logger.js\";\nimport type { TokenCredential, KeyCredential } from \"@azure/core-auth\";\nimport type { DocumentTranslationClient } from \"./clientDefinitions.js\";\n\n/** The optional parameters for the client */\nexport interface DocumentTranslationClientOptions extends ClientOptions {\n  /** The api version option of the client */\n  apiVersion?: string;\n}\n\n/**\n * Initialize a new instance of `DocumentTranslationClient`\n * @param endpointParam - Supported document Translation endpoint, protocol and hostname, for example: https://{TranslatorResourceName}.cognitiveservices.azure.com/translator.\n * @param credentials - uniquely identify client credential\n * @param options - the parameter for all optional parameters\n */\nexport default function createClient(\n  endpointParam: string,\n  credentials: TokenCredential | KeyCredential,\n  { apiVersion = \"2024-05-01\", ...options }: DocumentTranslationClientOptions = {},\n): DocumentTranslationClient {\n  const endpointUrl = options.endpoint ?? options.baseUrl ?? `${endpointParam}/translator`;\n  const userAgentInfo = `azsdk-js-ai-translation-document-rest/1.0.0-beta.1`;\n  const userAgentPrefix =\n    options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n      ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`\n      : `${userAgentInfo}`;\n  options = {\n    ...options,\n    userAgentOptions: {\n      userAgentPrefix,\n    },\n    loggingOptions: {\n      logger: options.loggingOptions?.logger ?? logger.info,\n    },\n    credentials: {\n      scopes: options.credentials?.scopes ?? [\"https://cognitiveservices.azure.com/.default\"],\n      apiKeyHeaderName: options.credentials?.apiKeyHeaderName ?? \"Ocp-Apim-Subscription-Key\",\n    },\n  };\n  const client = getClient(endpointUrl, credentials, options) as DocumentTranslationClient;\n\n  client.pipeline.removePolicy({ name: \"ApiVersionPolicy\" });\n  client.pipeline.addPolicy({\n    name: \"ClientApiVersionPolicy\",\n    sendRequest: (req, next) => {\n      // Use the apiVersion defined in request url directly\n      // Append one if there is no apiVersion and we have one at client options\n      const url = new URL(req.url);\n      if (!url.searchParams.get(\"api-version\") && apiVersion) {\n        req.url = `${req.url}${\n          Array.from(url.searchParams.keys()).length > 0 ? \"&\" : \"?\"\n        }api-version=${apiVersion}`;\n      }\n\n      return next(req);\n    },\n  });\n\n  return client;\n}\n"]}

package/dist/browser/index.d.ts

@@ -0,0 +1,12 @@
+import DocumentTranslationClient from "./documentTranslationClient.js";
+export * from "./documentTranslationClient.js";
+export * from "./parameters.js";
+export * from "./responses.js";
+export * from "./clientDefinitions.js";
+export * from "./isUnexpected.js";
+export * from "./models.js";
+export * from "./outputModels.js";
+export * from "./paginateHelper.js";
+export * from "./pollingHelper.js";
+export default DocumentTranslationClient;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,yBAAyB,MAAM,gCAAgC,CAAC;AAEvE,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AAEnC,eAAe,yBAAyB,CAAC"}

package/dist/browser/index.js

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

package/dist/browser/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,OAAO,yBAAyB,MAAM,gCAAgC,CAAC;AAEvE,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AAEnC,eAAe,yBAAyB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nimport DocumentTranslationClient from \"./documentTranslationClient.js\";\n\nexport * from \"./documentTranslationClient.js\";\nexport * from \"./parameters.js\";\nexport * from \"./responses.js\";\nexport * from \"./clientDefinitions.js\";\nexport * from \"./isUnexpected.js\";\nexport * from \"./models.js\";\nexport * from \"./outputModels.js\";\nexport * from \"./paginateHelper.js\";\nexport * from \"./pollingHelper.js\";\n\nexport default DocumentTranslationClient;\n"]}

package/dist/browser/isUnexpected.d.ts

@@ -0,0 +1,10 @@
+import type { DocumentTranslate200Response, DocumentTranslateDefaultResponse, StartTranslation202Response, StartTranslationLogicalResponse, StartTranslationDefaultResponse, GetTranslationsStatus200Response, GetTranslationsStatusDefaultResponse, GetDocumentStatus200Response, GetDocumentStatusDefaultResponse, GetTranslationStatus200Response, GetTranslationStatusDefaultResponse, CancelTranslation200Response, CancelTranslationDefaultResponse, GetDocumentsStatus200Response, GetDocumentsStatusDefaultResponse, GetSupportedFormats200Response, GetSupportedFormatsDefaultResponse } from "./responses.js";
+export declare function isUnexpected(response: DocumentTranslate200Response | DocumentTranslateDefaultResponse): response is DocumentTranslateDefaultResponse;
+export declare function isUnexpected(response: StartTranslation202Response | StartTranslationLogicalResponse | StartTranslationDefaultResponse): response is StartTranslationDefaultResponse;
+export declare function isUnexpected(response: GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse): response is GetTranslationsStatusDefaultResponse;
+export declare function isUnexpected(response: GetDocumentStatus200Response | GetDocumentStatusDefaultResponse): response is GetDocumentStatusDefaultResponse;
+export declare function isUnexpected(response: GetTranslationStatus200Response | GetTranslationStatusDefaultResponse): response is GetTranslationStatusDefaultResponse;
+export declare function isUnexpected(response: CancelTranslation200Response | CancelTranslationDefaultResponse): response is CancelTranslationDefaultResponse;
+export declare function isUnexpected(response: GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse): response is GetDocumentsStatusDefaultResponse;
+export declare function isUnexpected(response: GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse): response is GetSupportedFormatsDefaultResponse;
+//# sourceMappingURL=isUnexpected.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isUnexpected.d.ts","sourceRoot":"","sources":["../../src/isUnexpected.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,4BAA4B,EAC5B,gCAAgC,EAChC,2BAA2B,EAC3B,+BAA+B,EAC/B,+BAA+B,EAC/B,gCAAgC,EAChC,oCAAoC,EACpC,4BAA4B,EAC5B,gCAAgC,EAChC,+BAA+B,EAC/B,mCAAmC,EACnC,4BAA4B,EAC5B,gCAAgC,EAChC,6BAA6B,EAC7B,iCAAiC,EACjC,8BAA8B,EAC9B,kCAAkC,EACnC,MAAM,gBAAgB,CAAC;AAaxB,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,4BAA4B,GAAG,gCAAgC,GACxE,QAAQ,IAAI,gCAAgC,CAAC;AAChD,wBAAgB,YAAY,CAC1B,QAAQ,EACJ,2BAA2B,GAC3B,+BAA+B,GAC/B,+BAA+B,GAClC,QAAQ,IAAI,+BAA+B,CAAC;AAC/C,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,gCAAgC,GAAG,oCAAoC,GAChF,QAAQ,IAAI,oCAAoC,CAAC;AACpD,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,4BAA4B,GAAG,gCAAgC,GACxE,QAAQ,IAAI,gCAAgC,CAAC;AAChD,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,+BAA+B,GAAG,mCAAmC,GAC9E,QAAQ,IAAI,mCAAmC,CAAC;AACnD,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,4BAA4B,GAAG,gCAAgC,GACxE,QAAQ,IAAI,gCAAgC,CAAC;AAChD,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,6BAA6B,GAAG,iCAAiC,GAC1E,QAAQ,IAAI,iCAAiC,CAAC;AACjD,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,8BAA8B,GAAG,kCAAkC,GAC5E,QAAQ,IAAI,kCAAkC,CAAC"}

package/dist/browser/logger.d.ts

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

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

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

package/dist/browser/models.d.ts

@@ -0,0 +1,112 @@
+export interface DocumentTranslateContentDocumentPartDescriptor {
+    name: "document";
+    body: string | Uint8Array | ReadableStream<Uint8Array> | NodeJS.ReadableStream | File;
+    filename?: string;
+    contentType?: string;
+}
+export interface DocumentTranslateContentGlossaryPartDescriptor {
+    name: "glossary";
+    body: string | Uint8Array | ReadableStream<Uint8Array> | NodeJS.ReadableStream | File;
+    filename?: string;
+    contentType?: string;
+}
+/** 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
+     *
+     * Possible values: "Folder", "File"
+     */
+    storageType?: StorageInputType;
+}
+/** Source of the input documents */
+export interface SourceInput {
+    /** Location of the folder / container or single file with your documents */
+    sourceUrl: string;
+    /** Document filter */
+    filter?: DocumentFilter;
+    /**
+     * Language code
+     * If none is specified, we will perform auto detect on the document
+     */
+    language?: string;
+    /**
+     * Storage Source
+     *
+     * Possible values: "AzureBlob"
+     */
+    storageSource?: StorageSource;
+}
+/** Document filter */
+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
+     *
+     * Possible values: "AzureBlob"
+     */
+    storageSource?: StorageSource;
+}
+/** 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
+     *
+     * Possible values: "AzureBlob"
+     */
+    storageSource?: StorageSource;
+}
+/** Document Translate Request Content */
+export type DocumentTranslateContent = FormData | Array<DocumentTranslateContentDocumentPartDescriptor | DocumentTranslateContentGlossaryPartDescriptor>;
+/** Alias for StorageSource */
+export type StorageSource = string;
+/** Alias for StorageInputType */
+export type StorageInputType = string;
+/** Alias for FileFormatType */
+export type FileFormatType = string;
+//# sourceMappingURL=models.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,8CAA8C;IAC7D,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IACtF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,8CAA8C;IAC7D,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IACtF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,+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;;;;OAIG;IACH,WAAW,CAAC,EAAE,gBAAgB,CAAC;CAChC;AAED,oCAAoC;AACpC,MAAM,WAAW,WAAW;IAC1B,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;IAClB,sBAAsB;IACtB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,sBAAsB;AACtB,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;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;;;;OAIG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,oDAAoD;AACpD,MAAM,WAAW,QAAQ;IACvB;;;;;;;OAOG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,yCAAyC;AACzC,MAAM,MAAM,wBAAwB,GAChC,QAAQ,GACR,KAAK,CACD,8CAA8C,GAC9C,8CAA8C,CACjD,CAAC;AACN,8BAA8B;AAC9B,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,iCAAiC;AACjC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AACtC,+BAA+B;AAC/B,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC"}

package/dist/browser/outputModels.d.ts

@@ -0,0 +1,166 @@
+/** 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. */
+    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
+     *
+     * Possible values: "NotStarted", "Running", "Succeeded", "Failed", "Cancelled", "Cancelling", "ValidationFailed"
+     */
+    status: StatusOutput;
+    /**
+     * This contains an outer error with error code, message, details, target and an
+     * inner error with more descriptive details.
+     */
+    error?: TranslationErrorOutput;
+    /** Status Summary */
+    summary: StatusSummaryOutput;
+}
+/**
+ * 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.
+     *
+     * Possible values: "InvalidRequest", "InvalidArgument", "InternalServerError", "ServiceUnavailable", "ResourceNotFound", "Unauthorized", "RequestRateTooHigh"
+     */
+    code: TranslationErrorCodeOutput;
+    /** 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;
+}
+/** Status Summary */
+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
+     *
+     * Possible values: "NotStarted", "Running", "Succeeded", "Failed", "Cancelled", "Cancelling", "ValidationFailed"
+     */
+    status: StatusOutput;
+    /** 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 */
+    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;
+}
+/** List of supported file formats */
+export interface SupportedFileFormatsOutput {
+    /** list of objects */
+    value: Array<FileFormatOutput>;
+}
+/** File Format */
+export interface FileFormatOutput {
+    /** Name of the format */
+    format: string;
+    /** Supported file extension for this format */
+    fileExtensions: string[];
+    /** Supported Content-Types for this format */
+    contentTypes: string[];
+    /** Default version if none is specified */
+    defaultVersion?: string;
+    /** Supported Version */
+    versions?: string[];
+    /** Supported Type for this format */
+    type?: string;
+}
+/** Alias for StatusOutput */
+export type StatusOutput = string;
+/** Alias for TranslationErrorCodeOutput */
+export type TranslationErrorCodeOutput = string;
+//# sourceMappingURL=outputModels.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAGA,sCAAsC;AACtC,MAAM,WAAW,wBAAwB;IACvC,iDAAiD;IACjD,KAAK,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;IACtC,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,sCAAsC;AACtC,MAAM,WAAW,uBAAuB;IACtC,2BAA2B;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,kCAAkC;IAClC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iEAAiE;IACjE,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;;OAGG;IACH,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,qBAAqB;IACrB,OAAO,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,IAAI,EAAE,0BAA0B,CAAC;IACjC,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,2BAA2B,CAAC;CAC1C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IAC1C,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,2BAA2B,CAAC;CAC1C;AAED,qBAAqB;AACrB,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;;;;OAIG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB;IAClB,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,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qCAAqC;AACrC,MAAM,WAAW,0BAA0B;IACzC,sBAAsB;IACtB,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED,kBAAkB;AAClB,MAAM,WAAW,gBAAgB;IAC/B,yBAAyB;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,8CAA8C;IAC9C,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,2CAA2C;IAC3C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,wBAAwB;IACxB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,6BAA6B;AAC7B,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC,2CAA2C;AAC3C,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC"}

package/dist/browser/package.json

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

package/dist/browser/paginateHelper.d.ts

@@ -0,0 +1,43 @@
+import type { PagedAsyncIterableIterator } from "@azure/core-paging";
+import type { Client, PathUncheckedResponse } from "@azure-rest/core-client";
+/**
+ * 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, maxPageSize?: number) => 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/browser/paginateHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginateHelper.d.ts","sourceRoot":"","sources":["../../src/paginateHelper.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0BAA0B,EAAe,MAAM,oBAAoB,CAAC;AAElF,OAAO,KAAK,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAG7E;;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"}