@azure/ai-form-recognizer 5.0.0 → 5.1.0

package/dist/browser/lro/analysis.d.ts

@@ -0,0 +1,210 @@
+import type { PollOperationState, PollerLike } from "@azure/core-lro";
+import type { AnalyzeResult as GeneratedAnalyzeResult, AnalyzeResultOperation, AnalyzeResultOperationStatus as AnalyzeOperationStatus, DocumentLanguage, DocumentSpan, DocumentStyle } from "../generated/index.js";
+import type { DocumentField } from "../models/fields.js";
+import type { PollerOptions } from "../options/index.js";
+import type { AnalyzeDocumentOptions } from "../options/AnalyzeDocumentOptions.js";
+import type { BoundingRegion, DocumentTable, DocumentKeyValuePair, DocumentPage, DocumentLine, DocumentParagraph } from "../models/documentElements.js";
+import type { Document as GeneratedDocument, DocumentPage as GeneratedDocumentPage, DocumentLine as GeneratedDocumentLine } from "../generated/index.js";
+/**
+ * A request input that can be uploaded as binary data to the Form Recognizer service. Form Recognizer treats `string`
+ * inputs as URLs, so to send a string as a _binary_ input, first convert the string to one of the following input
+ * types.
+ */
+export type FormRecognizerRequestBody = NodeJS.ReadableStream | Blob | ArrayBuffer | ArrayBufferView;
+/**
+ * An extracted document object.
+ *
+ * An AnalyzedDocument is an instance of one of the document types within a model. Its fields correspond to the field
+ * schema of the document type.
+ */
+export interface AnalyzedDocument {
+    /**
+     * The type of the document that was extracted. A model can have multiple document types (for example, in a composed
+     * model), so this property indicates which document type the fields of this document correspond to.
+     */
+    docType: string;
+    /**
+     * The extracted fields, which correspond to the document type's field schema.
+     */
+    fields: {
+        [field: string]: DocumentField;
+    };
+    /**
+     * Bounding regions covering the document.
+     */
+    boundingRegions?: BoundingRegion[];
+    /**
+     * Locations of the document's elements in the `content` text (reading-order-concatenated content).
+     */
+    spans: DocumentSpan[];
+    /**
+     * The service's confidence that it has correctly extracted the document.
+     */
+    confidence: number;
+}
+/**
+ * Transform a REST-level Document response object into the more strongly-typed AnalyzedDocument.
+ *
+ * @internal
+ * @param document - a REST-level document response object
+ * @returns an AnalyzedDocument (which has had its fields mapped to stronger DocumentField types)
+ */
+export declare function toAnalyzedDocumentFromGenerated(document: GeneratedDocument): AnalyzedDocument;
+/**
+ * The common fields of all AnalyzeResult-like types, such as LayoutResult, ReadResult, and GeneralDocumentResult.
+ */
+export interface AnalyzeResultCommon {
+    /**
+     * The service API version used to produce this result.
+     */
+    apiVersion: string;
+    /**
+     * The unique ID of the model that was used to produce this result.
+     */
+    modelId: string;
+    /**
+     * A string representation of all textual and visual elements in the input, concatenated by reading order (the order
+     * in which the service "reads" or extracts the textual and visual content from the document).
+     */
+    content: string;
+}
+/**
+ * The result of an analysis operation. The type of the Document may be determined by the model used to perform the
+ * analysis.
+ */
+export interface AnalyzeResult<Document = AnalyzedDocument> extends AnalyzeResultCommon {
+    /**
+     * Extracted pages.
+     */
+    pages?: DocumentPage[];
+    /**
+     * Extracted tables.
+     */
+    tables?: DocumentTable[];
+    /**
+     * Extracted key-value pairs.
+     */
+    keyValuePairs?: DocumentKeyValuePair[];
+    /**
+     * Extracted text languages.
+     */
+    languages?: DocumentLanguage[];
+    /**
+     * Extracted font styles.
+     */
+    styles?: DocumentStyle[];
+    /**
+     * Extracted documents (instances of any of the model's document types and corresponding field schemas).
+     */
+    documents?: Document[];
+    /**
+     * Extracted document paragraphs.
+     */
+    paragraphs?: DocumentParagraph[];
+}
+/**
+ * Tests if one span contains another, by testing that the outer span starts before or at the same character as the
+ * inner span, and that the end position of the outer span is greater than or equal to the end position of the inner
+ * span.
+ *
+ * @internal
+ * @param outer - the outer (potentially containing) span
+ * @param inner - the span to test if `outer` contains
+ * @returns true if `inner` is contained inside of `outer`.
+ */
+export declare function contains(outer: DocumentSpan, inner: DocumentSpan): boolean;
+/**
+ * Produces an iterator of the given items starting from the given index.
+ *
+ * @param items - the items to iterate over
+ * @param idx - the index of the first item to begin iterating from
+ */
+export declare function iterFrom<T>(items: T[], idx: number): Generator<T>;
+export declare function toDocumentLineFromGenerated(generated: GeneratedDocumentLine, page: GeneratedDocumentPage): DocumentLine;
+export declare function toDocumentPageFromGenerated(generated: GeneratedDocumentPage): DocumentPage;
+/**
+ * Binary search through an array of items to find the first item that could possibly be contained by the given span,
+ * then return an iterator beginning from that item.
+ *
+ * This allows a program to quickly find the first relevant item in the array for consideration when testing for span
+ * inclusion.
+ *
+ * @internal
+ * @param span - the span to use when testing each individual item
+ * @param items - an array of items to binary search through
+ * @returns an iterator beginning from the item identified by the search
+ */
+export declare function iteratorFromFirstMatchBinarySearch<Spanned extends {
+    span: DocumentSpan;
+}>(span: DocumentSpan, items: Spanned[]): IterableIterator<Spanned>;
+/**
+ * This fast algorithm tests the elements of `childArray` for inclusion in any of the given `spans`, assuming that both
+ * the spans and child items are sorted.
+ *
+ * INVARIANT: the items in both the `spans` iterator and `childrenArray` MUST BE SORTED INCREASING by span _offset_.
+ *
+ * @internal
+ * @param spans - the spans that contain the child elements
+ * @param childrenArray - an array of child items (items that have spans) to test for inclusion in the spans
+ * @returns - an IterableIterator of child items that are included in any span in the `spans` iterator
+ */
+export declare function fastGetChildren<Spanned extends {
+    span: DocumentSpan;
+}>(spans: Iterator<DocumentSpan>, childrenArray: Spanned[]): Generator<Spanned>;
+/**
+ * The state of an analysis operation, which will eventually produce the result type that corresponds to the model.
+ */
+export interface DocumentAnalysisPollOperationState<Result = AnalyzeResult<AnalyzedDocument>> extends PollOperationState<Result> {
+    /**
+     * The status of the operation. One of:
+     *
+     * - "notStarted"
+     * - "running"
+     * - "succeeded"
+     * - "failed"
+     */
+    status: AnalyzeOperationStatus;
+    /**
+     * The model ID that the analysis operation will use to produce the result.
+     */
+    modelId: string;
+    /**
+     * The URL to the operation.
+     */
+    operationLocation: string;
+    /**
+     * The Date and Time that the operation was created.
+     */
+    createdOn: Date;
+    /**
+     * The date & time that the operation state was last modified.
+     */
+    lastUpdatedOn: Date;
+}
+/**
+ * A long-running operation (poller) that tracks the state of an analysis operation, eventually producing the result
+ * type that corresponds to the model.
+ */
+export type AnalysisPoller<Result = AnalyzeResult<AnalyzedDocument>> = PollerLike<DocumentAnalysisPollOperationState<Result>, Result>;
+/**
+ * Convert a generated AnalyzeResult into a convenience layer AnalyzeResult.
+ * @internal
+ */
+export declare function toAnalyzeResultFromGenerated(result: GeneratedAnalyzeResult): AnalyzeResult;
+/**
+ * Defines an analysis operation by the initial request model ID, poller options, and a transform to apply to the
+ * eventual result,
+ *
+ * @internal
+ */
+export interface AnalysisOperationDefinition<Result = AnalyzeResult> {
+    transformResult: (primitiveResult: GeneratedAnalyzeResult) => Result;
+    initialModelId: string;
+    options: PollerOptions<DocumentAnalysisPollOperationState<Result>> & AnalyzeDocumentOptions<Result>;
+}
+/**
+ * Converts an AnalyzeResultOperation (LRO response) to a DocumentAnalysisPollOperationState
+ * @internal
+ */
+export declare function toDocumentAnalysisPollOperationState<Result>(definition: AnalysisOperationDefinition<Result>, modelId: string, operationLocation: string, response: AnalyzeResultOperation): DocumentAnalysisPollOperationState<Result>;
+//# sourceMappingURL=analysis.d.ts.map

package/dist/browser/lro/analysis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analysis.d.ts","sourceRoot":"","sources":["../../../src/lro/analysis.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAEtE,OAAO,KAAK,EACV,aAAa,IAAI,sBAAsB,EACvC,sBAAsB,EACtB,4BAA4B,IAAI,sBAAsB,EACtD,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACd,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAOnF,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACb,oBAAoB,EACpB,YAAY,EACZ,YAAY,EACZ,iBAAiB,EAElB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,QAAQ,IAAI,iBAAiB,EAC7B,YAAY,IAAI,qBAAqB,EACrC,YAAY,IAAI,qBAAqB,EACtC,MAAM,uBAAuB,CAAC;AAE/B;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,CAAC,cAAc,GACrB,IAAI,GACJ,WAAW,GACX,eAAe,CAAC;AAEpB;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE,CAAC;IAE3C;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IAEnC;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,QAAQ,EAAE,iBAAiB,GAAG,gBAAgB,CAM7F;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,QAAQ,GAAG,gBAAgB,CAAE,SAAQ,mBAAmB;IACrF;;OAEG;IACH,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAEvC;;OAEG;IACH,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAC;CAClC;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAE1E;AASD;;;;;GAKG;AACH,wBAAiB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAMlE;AAED,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,qBAAqB,EAChC,IAAI,EAAE,qBAAqB,GAC1B,YAAY,CAgBd;AAED,wBAAgB,2BAA2B,CAAC,SAAS,EAAE,qBAAqB,GAAG,YAAY,CAuB1F;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kCAAkC,CAAC,OAAO,SAAS;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,EACvF,IAAI,EAAE,YAAY,EAClB,KAAK,EAAE,OAAO,EAAE,GACf,gBAAgB,CAAC,OAAO,CAAC,CA0B3B;AAED;;;;;;;;;;GAUG;AACH,wBAAiB,eAAe,CAAC,OAAO,SAAS;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,EACrE,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,EAC7B,aAAa,EAAE,OAAO,EAAE,GACvB,SAAS,CAAC,OAAO,CAAC,CAwBpB;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC,CAAC,MAAM,GAAG,aAAa,CAAC,gBAAgB,CAAC,CAC1F,SAAQ,kBAAkB,CAAC,MAAM,CAAC;IAClC;;;;;;;OAOG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAEhB;;OAEG;IACH,aAAa,EAAE,IAAI,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,GAAG,aAAa,CAAC,gBAAgB,CAAC,IAAI,UAAU,CAC/E,kCAAkC,CAAC,MAAM,CAAC,EAC1C,MAAM,CACP,CAAC;AAEF;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,sBAAsB,GAAG,aAAa,CAgB1F;AAED;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B,CAAC,MAAM,GAAG,aAAa;IACjE,eAAe,EAAE,CAAC,eAAe,EAAE,sBAAsB,KAAK,MAAM,CAAC;IACrE,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,aAAa,CAAC,kCAAkC,CAAC,MAAM,CAAC,CAAC,GAChE,sBAAsB,CAAC,MAAM,CAAC,CAAC;CAClC;AAED;;;GAGG;AACH,wBAAgB,oCAAoC,CAAC,MAAM,EACzD,UAAU,EAAE,2BAA2B,CAAC,MAAM,CAAC,EAC/C,OAAO,EAAE,MAAM,EACf,iBAAiB,EAAE,MAAM,EACzB,QAAQ,EAAE,sBAAsB,GAC/B,kCAAkC,CAAC,MAAM,CAAC,CAa5C"}

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

@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-import { FormRecognizerError } from "../error";
-import { toAnalyzedDocumentFieldsFromGenerated } from "../models/fields";
-import { toBoundingPolygon, toBoundingRegions, toDocumentTableFromGenerated, toKeyValuePairFromGenerated, } from "../transforms/polygon";
+// Licensed under the MIT License.
+import { FormRecognizerError } from "../error.js";
+import { toAnalyzedDocumentFieldsFromGenerated } from "../models/fields.js";
+import { toBoundingPolygon, toBoundingRegions, toDocumentTableFromGenerated, toKeyValuePairFromGenerated, } from "../transforms/polygon.js";
 /**
  * Transform a REST-level Document response object into the more strongly-typed AnalyzedDocument.
  *
@@ -167,7 +167,7 @@ export function toDocumentAnalysisPollOperationState(definition, modelId, operat
         operationLocation,
         result: response.analyzeResult && definition.transformResult(response.analyzeResult),
         error: response.error && new FormRecognizerError(response.error),
-        isCancelled: false,
+        isCancelled: false, // Not supported
         isStarted: response.status !== "notStarted",
         isCompleted: response.status === "succeeded",
     };

package/dist/browser/lro/analysis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analysis.js","sourceRoot":"","sources":["../../../src/lro/analysis.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAUlD,OAAO,EAAE,qCAAqC,EAAE,MAAM,qBAAqB,CAAC;AAG5E,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,4BAA4B,EAC5B,2BAA2B,GAC5B,MAAM,0BAA0B,CAAC;AA6DlC;;;;;;GAMG;AACH,MAAM,UAAU,+BAA+B,CAAC,QAA2B;;IACzE,uCACK,QAAQ,KACX,eAAe,EAAE,iBAAiB,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC5D,MAAM,EAAE,qCAAqC,CAAC,MAAA,QAAQ,CAAC,MAAM,mCAAI,EAAE,CAAC,IACpE;AACJ,CAAC;AAgED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAmB,EAAE,KAAmB;IAC/D,OAAO,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;AACpG,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,KAAK;IACb,yBAAyB;AAC3B,CAAC;AAED;;;;;GAKG;AACH,MAAM,SAAS,CAAC,CAAC,QAAQ,CAAI,KAAU,EAAE,GAAW;IAClD,IAAI,CAAC,GAAG,GAAG,CAAC;IAEZ,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACxB,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,SAAgC,EAChC,IAA2B;IAE1B,SAA0B,CAAC,KAAK,GAAG,GAAG,EAAE;;QACvC,OAAA,eAAe,CACb,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,EAC5B,MAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACvB,uCAAY,IAAI,KAAE,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAG;QAC/D,CAAC,CAAC,mCAAI,EAAE,CACT,CAAA;KAAA,CAAC;IAEH,SAA0B,CAAC,OAAO,GAAG,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAE3E,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,EAAE;QACxC,UAAU,EAAE,KAAK;KAClB,CAAC,CAAC;IAEH,OAAO,SAAyB,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,SAAgC;;IAC1E,uCACK,SAAS,KACZ,KAAK,EAAE,MAAA,SAAS,CAAC,KAAK,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,2BAA2B,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,EACnF,cAAc,EAAE,MAAA,SAAS,CAAC,cAAc,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iCACnD,IAAI,KACP,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IACxC,CAAC,EACH,KAAK,EAAE,MAAA,SAAS,CAAC,KAAK,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iCACjC,IAAI,KACP,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IACxC,CAAC,EACH,QAAQ,EAAE,MAAA,SAAS,CAAC,QAAQ,0CAAE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,iCAC1C,OAAO,KACV,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,IAC3C,CAAC,EACH,QAAQ,EAAE,MAAA,SAAS,CAAC,QAAQ,0CAAE,GAAG,CAC/B,CAAC,OAAO,EAAmB,EAAE,CAAC,iCACzB,OAAO,KACV,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,IAC3C,CACH,IACD;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,kCAAkC,CAChD,IAAkB,EAClB,KAAgB;IAEhB,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvC,IAAI,OAAO,GAAG,GAAG,CAAC;IAClB,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,IAAI,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC;IAEvB,MAAM,KAAK,GAAG,GAAY,EAAE;IAC1B,oHAAoH;IACpH,mEAAmE;IACnE,OAAA,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,MAAA,MAAA,MAAA,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,0CAAE,IAAI,0CAAE,MAAM,mCAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAA,EAAA,CAAC;IAE9F,gEAAgE;IAChE,GAAG,CAAC;QACF,IAAI,KAAK,EAAE,EAAE,CAAC;YACZ,OAAO,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC9B,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAChD,GAAG,GAAG,OAAO,GAAG,GAAG,CAAC;YACpB,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,OAAO,GAAG,GAAG,CAAC;YACpB,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC,QAAQ,GAAG,KAAK,OAAO,EAAE;IAE1B,wFAAwF;IACxF,OAAO,KAAK,EAAE,CAAC;AACjB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,SAAS,CAAC,CAAC,eAAe,CAC9B,KAA6B,EAC7B,aAAwB;IAExB,IAAI,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAE3B,4CAA4C;IAC5C,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,kCAAkC,CAAC,OAAO,CAAC,KAAqB,EAAE,aAAa,CAAC,CAAC;IAClG,IAAI,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;IAE/B,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,IAAI,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACjD,oEAAoE;YACpE,MAAM,QAAQ,CAAC,KAAK,CAAC;YACrB,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC7B,CAAC;aAAM,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACpF,oFAAoF;YACpF,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,yFAAyF;YACzF,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC7B,CAAC;IACH,CAAC;AACH,CAAC;AA+CD;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAAC,MAA8B;;IACzE,OAAO;QACL,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QACpE,MAAM,EAAE,MAAA,MAAM,CAAC,MAAM,0CAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;QAC1E,aAAa,EAAE,MAAA,MAAM,CAAC,aAAa,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QACrF,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iCACxC,IAAI,KACP,eAAe,EAAE,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC,IACxD,CAAC;QACH,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,0CAAE,GAAG,CAAC,+BAA+B,CAAC;KAClE,CAAC;AACJ,CAAC;AAeD;;;GAGG;AACH,MAAM,UAAU,oCAAoC,CAClD,UAA+C,EAC/C,OAAe,EACf,iBAAyB,EACzB,QAAgC;IAEhC,OAAO;QACL,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,OAAO,EAAE,OAAO;QAChB,aAAa,EAAE,QAAQ,CAAC,aAAa;QACrC,SAAS,EAAE,QAAQ,CAAC,SAAS;QAC7B,iBAAiB;QACjB,MAAM,EAAE,QAAQ,CAAC,aAAa,IAAI,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,aAAa,CAAC;QACpF,KAAK,EAAE,QAAQ,CAAC,KAAK,IAAI,IAAI,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChE,WAAW,EAAE,KAAK,EAAE,gBAAgB;QACpC,SAAS,EAAE,QAAQ,CAAC,MAAM,KAAK,YAAY;QAC3C,WAAW,EAAE,QAAQ,CAAC,MAAM,KAAK,WAAW;KAC7C,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PollOperationState, PollerLike } from \"@azure/core-lro\";\nimport { FormRecognizerError } from \"../error.js\";\nimport type {\n  AnalyzeResult as GeneratedAnalyzeResult,\n  AnalyzeResultOperation,\n  AnalyzeResultOperationStatus as AnalyzeOperationStatus,\n  DocumentLanguage,\n  DocumentSpan,\n  DocumentStyle,\n} from \"../generated/index.js\";\nimport type { DocumentField } from \"../models/fields.js\";\nimport { toAnalyzedDocumentFieldsFromGenerated } from \"../models/fields.js\";\nimport type { PollerOptions } from \"../options/index.js\";\nimport type { AnalyzeDocumentOptions } from \"../options/AnalyzeDocumentOptions.js\";\nimport {\n  toBoundingPolygon,\n  toBoundingRegions,\n  toDocumentTableFromGenerated,\n  toKeyValuePairFromGenerated,\n} from \"../transforms/polygon.js\";\nimport type {\n  BoundingRegion,\n  DocumentTable,\n  DocumentKeyValuePair,\n  DocumentPage,\n  DocumentLine,\n  DocumentParagraph,\n  DocumentFormula,\n} from \"../models/documentElements.js\";\nimport type {\n  Document as GeneratedDocument,\n  DocumentPage as GeneratedDocumentPage,\n  DocumentLine as GeneratedDocumentLine,\n} from \"../generated/index.js\";\n\n/**\n * A request input that can be uploaded as binary data to the Form Recognizer service. Form Recognizer treats `string`\n * inputs as URLs, so to send a string as a _binary_ input, first convert the string to one of the following input\n * types.\n */\nexport type FormRecognizerRequestBody =\n  | NodeJS.ReadableStream\n  | Blob\n  | ArrayBuffer\n  | ArrayBufferView;\n\n/**\n * An extracted document object.\n *\n * An AnalyzedDocument is an instance of one of the document types within a model. Its fields correspond to the field\n * schema of the document type.\n */\nexport interface AnalyzedDocument {\n  /**\n   * The type of the document that was extracted. A model can have multiple document types (for example, in a composed\n   * model), so this property indicates which document type the fields of this document correspond to.\n   */\n  docType: string;\n\n  /**\n   * The extracted fields, which correspond to the document type's field schema.\n   */\n  fields: { [field: string]: DocumentField };\n\n  /**\n   * Bounding regions covering the document.\n   */\n  boundingRegions?: BoundingRegion[];\n\n  /**\n   * Locations of the document's elements in the `content` text (reading-order-concatenated content).\n   */\n  spans: DocumentSpan[];\n\n  /**\n   * The service's confidence that it has correctly extracted the document.\n   */\n  confidence: number;\n}\n\n/**\n * Transform a REST-level Document response object into the more strongly-typed AnalyzedDocument.\n *\n * @internal\n * @param document - a REST-level document response object\n * @returns an AnalyzedDocument (which has had its fields mapped to stronger DocumentField types)\n */\nexport function toAnalyzedDocumentFromGenerated(document: GeneratedDocument): AnalyzedDocument {\n  return {\n    ...document,\n    boundingRegions: toBoundingRegions(document.boundingRegions),\n    fields: toAnalyzedDocumentFieldsFromGenerated(document.fields ?? {}),\n  };\n}\n\n/**\n * The common fields of all AnalyzeResult-like types, such as LayoutResult, ReadResult, and GeneralDocumentResult.\n */\nexport interface AnalyzeResultCommon {\n  /**\n   * The service API version used to produce this result.\n   */\n  apiVersion: string;\n\n  /**\n   * The unique ID of the model that was used to produce this result.\n   */\n  modelId: string;\n\n  /**\n   * A string representation of all textual and visual elements in the input, concatenated by reading order (the order\n   * in which the service \"reads\" or extracts the textual and visual content from the document).\n   */\n  content: string;\n}\n\n/**\n * The result of an analysis operation. The type of the Document may be determined by the model used to perform the\n * analysis.\n */\nexport interface AnalyzeResult<Document = AnalyzedDocument> extends AnalyzeResultCommon {\n  /**\n   * Extracted pages.\n   */\n  pages?: DocumentPage[];\n\n  /**\n   * Extracted tables.\n   */\n  tables?: DocumentTable[];\n\n  /**\n   * Extracted key-value pairs.\n   */\n  keyValuePairs?: DocumentKeyValuePair[];\n\n  /**\n   * Extracted text languages.\n   */\n  languages?: DocumentLanguage[];\n\n  /**\n   * Extracted font styles.\n   */\n  styles?: DocumentStyle[];\n\n  /**\n   * Extracted documents (instances of any of the model's document types and corresponding field schemas).\n   */\n  documents?: Document[];\n\n  /**\n   * Extracted document paragraphs.\n   */\n  paragraphs?: DocumentParagraph[];\n}\n\n/**\n * Tests if one span contains another, by testing that the outer span starts before or at the same character as the\n * inner span, and that the end position of the outer span is greater than or equal to the end position of the inner\n * span.\n *\n * @internal\n * @param outer - the outer (potentially containing) span\n * @param inner - the span to test if `outer` contains\n * @returns true if `inner` is contained inside of `outer`.\n */\nexport function contains(outer: DocumentSpan, inner: DocumentSpan): boolean {\n  return outer.offset <= inner.offset && outer.offset + outer.length >= inner.offset + inner.length;\n}\n\n/**\n * Make an empty generator. This might seem silly, but it's useful for satisfying invariants.\n */\nfunction* empty(): Generator<never> {\n  /* intentionally empty */\n}\n\n/**\n * Produces an iterator of the given items starting from the given index.\n *\n * @param items - the items to iterate over\n * @param idx - the index of the first item to begin iterating from\n */\nexport function* iterFrom<T>(items: T[], idx: number): Generator<T> {\n  let i = idx;\n\n  while (i < items.length) {\n    yield items[i++];\n  }\n}\n\nexport function toDocumentLineFromGenerated(\n  generated: GeneratedDocumentLine,\n  page: GeneratedDocumentPage,\n): DocumentLine {\n  (generated as DocumentLine).words = () =>\n    fastGetChildren(\n      iterFrom(generated.spans, 0),\n      page.words?.map((word) => {\n        return { ...word, polygon: toBoundingPolygon(word.polygon) };\n      }) ?? [],\n    );\n\n  (generated as DocumentLine).polygon = toBoundingPolygon(generated.polygon);\n\n  Object.defineProperty(generated, \"words\", {\n    enumerable: false,\n  });\n\n  return generated as DocumentLine;\n}\n\nexport function toDocumentPageFromGenerated(generated: GeneratedDocumentPage): DocumentPage {\n  return {\n    ...generated,\n    lines: generated.lines?.map((line) => toDocumentLineFromGenerated(line, generated)),\n    selectionMarks: generated.selectionMarks?.map((mark) => ({\n      ...mark,\n      polygon: toBoundingPolygon(mark.polygon),\n    })),\n    words: generated.words?.map((word) => ({\n      ...word,\n      polygon: toBoundingPolygon(word.polygon),\n    })),\n    barcodes: generated.barcodes?.map((barcode) => ({\n      ...barcode,\n      polygon: toBoundingPolygon(barcode.polygon),\n    })),\n    formulas: generated.formulas?.map(\n      (formula): DocumentFormula => ({\n        ...formula,\n        polygon: toBoundingPolygon(formula.polygon),\n      }),\n    ),\n  };\n}\n\n/**\n * Binary search through an array of items to find the first item that could possibly be contained by the given span,\n * then return an iterator beginning from that item.\n *\n * This allows a program to quickly find the first relevant item in the array for consideration when testing for span\n * inclusion.\n *\n * @internal\n * @param span - the span to use when testing each individual item\n * @param items - an array of items to binary search through\n * @returns an iterator beginning from the item identified by the search\n */\nexport function iteratorFromFirstMatchBinarySearch<Spanned extends { span: DocumentSpan }>(\n  span: DocumentSpan,\n  items: Spanned[],\n): IterableIterator<Spanned> {\n  let idx = Math.floor(items.length / 2);\n  let prevIdx = idx;\n  let min = 0;\n  let max = items.length;\n\n  const found = (): boolean =>\n    // The item is found if it starts after the current span and the item before it does not. That means it is the first\n    // item in the array that could be a child if the spans are sorted.\n    items[idx].span.offset >= span.offset && (items[idx - 1]?.span?.offset ?? -1) < span.offset;\n\n  // Binary search to find the first element that could be a child\n  do {\n    if (found()) {\n      return iterFrom(items, idx);\n    } else if (span.offset > items[idx].span.offset) {\n      min = prevIdx = idx;\n      idx = Math.floor(idx + (max - idx) / 2);\n    } else {\n      max = prevIdx = idx;\n      idx = Math.floor(idx - (idx - min) / 2);\n    }\n  } while (idx !== prevIdx);\n\n  // This might seem weird, but it's a simple way to make the types a little more elegant.\n  return empty();\n}\n\n/**\n * This fast algorithm tests the elements of `childArray` for inclusion in any of the given `spans`, assuming that both\n * the spans and child items are sorted.\n *\n * INVARIANT: the items in both the `spans` iterator and `childrenArray` MUST BE SORTED INCREASING by span _offset_.\n *\n * @internal\n * @param spans - the spans that contain the child elements\n * @param childrenArray - an array of child items (items that have spans) to test for inclusion in the spans\n * @returns - an IterableIterator of child items that are included in any span in the `spans` iterator\n */\nexport function* fastGetChildren<Spanned extends { span: DocumentSpan }>(\n  spans: Iterator<DocumentSpan>,\n  childrenArray: Spanned[],\n): Generator<Spanned> {\n  let curSpan = spans.next();\n\n  // Need to exit early if there are no spans.\n  if (curSpan.done) {\n    return;\n  }\n\n  const children = iteratorFromFirstMatchBinarySearch(curSpan.value as DocumentSpan, childrenArray);\n  let curChild = children.next();\n\n  while (!(curChild.done || curSpan.done)) {\n    if (contains(curSpan.value, curChild.value.span)) {\n      // The span is contained, so yield the current child and advance it.\n      yield curChild.value;\n      curChild = children.next();\n    } else if (curSpan.value.offset + curSpan.value.length < curChild.value.span.offset) {\n      // The current span ends before the next potential child starts, so advance the span\n      curSpan = spans.next();\n    } else {\n      // The current child was not contained in the current span, so advance to the next child.\n      curChild = children.next();\n    }\n  }\n}\n\n/**\n * The state of an analysis operation, which will eventually produce the result type that corresponds to the model.\n */\nexport interface DocumentAnalysisPollOperationState<Result = AnalyzeResult<AnalyzedDocument>>\n  extends PollOperationState<Result> {\n  /**\n   * The status of the operation. One of:\n   *\n   * - \"notStarted\"\n   * - \"running\"\n   * - \"succeeded\"\n   * - \"failed\"\n   */\n  status: AnalyzeOperationStatus;\n\n  /**\n   * The model ID that the analysis operation will use to produce the result.\n   */\n  modelId: string;\n\n  /**\n   * The URL to the operation.\n   */\n  operationLocation: string;\n\n  /**\n   * The Date and Time that the operation was created.\n   */\n  createdOn: Date;\n\n  /**\n   * The date & time that the operation state was last modified.\n   */\n  lastUpdatedOn: Date;\n}\n\n/**\n * A long-running operation (poller) that tracks the state of an analysis operation, eventually producing the result\n * type that corresponds to the model.\n */\nexport type AnalysisPoller<Result = AnalyzeResult<AnalyzedDocument>> = PollerLike<\n  DocumentAnalysisPollOperationState<Result>,\n  Result\n>;\n\n/**\n * Convert a generated AnalyzeResult into a convenience layer AnalyzeResult.\n * @internal\n */\nexport function toAnalyzeResultFromGenerated(result: GeneratedAnalyzeResult): AnalyzeResult {\n  return {\n    apiVersion: result.apiVersion,\n    modelId: result.modelId,\n    content: result.content,\n    pages: result.pages.map((page) => toDocumentPageFromGenerated(page)),\n    tables: result.tables?.map((table) => toDocumentTableFromGenerated(table)),\n    keyValuePairs: result.keyValuePairs?.map((pair) => toKeyValuePairFromGenerated(pair)),\n    languages: result.languages,\n    styles: result.styles,\n    paragraphs: result.paragraphs?.map((para) => ({\n      ...para,\n      boundingRegions: toBoundingRegions(para.boundingRegions),\n    })),\n    documents: result.documents?.map(toAnalyzedDocumentFromGenerated),\n  };\n}\n\n/**\n * Defines an analysis operation by the initial request model ID, poller options, and a transform to apply to the\n * eventual result,\n *\n * @internal\n */\nexport interface AnalysisOperationDefinition<Result = AnalyzeResult> {\n  transformResult: (primitiveResult: GeneratedAnalyzeResult) => Result;\n  initialModelId: string;\n  options: PollerOptions<DocumentAnalysisPollOperationState<Result>> &\n    AnalyzeDocumentOptions<Result>;\n}\n\n/**\n * Converts an AnalyzeResultOperation (LRO response) to a DocumentAnalysisPollOperationState\n * @internal\n */\nexport function toDocumentAnalysisPollOperationState<Result>(\n  definition: AnalysisOperationDefinition<Result>,\n  modelId: string,\n  operationLocation: string,\n  response: AnalyzeResultOperation,\n): DocumentAnalysisPollOperationState<Result> {\n  return {\n    status: response.status,\n    modelId: modelId,\n    lastUpdatedOn: response.lastUpdatedOn,\n    createdOn: response.createdOn,\n    operationLocation,\n    result: response.analyzeResult && definition.transformResult(response.analyzeResult),\n    error: response.error && new FormRecognizerError(response.error),\n    isCancelled: false, // Not supported\n    isStarted: response.status !== \"notStarted\",\n    isCompleted: response.status === \"succeeded\",\n  };\n}\n"]}

package/dist/browser/lro/util/delayMs.d.ts

@@ -0,0 +1,32 @@
+import type { AbortSignalLike } from "@azure/abort-controller";
+/**
+ * A PromiseLike object that supports cancellation.
+ * @internal
+ */
+export interface CancelablePromiseLike<T> extends PromiseLike<T> {
+    /**
+     * Cancel the promise (cause it to reject).
+     */
+    cancel(): void;
+}
+/**
+ * A promise that delays resolution until a certain amount of time (in milliseconds) has passed, with facilities for
+ * robust cancellation.
+ *
+ * ### Example:
+ *
+ * ```ts snippet:ignore
+ * let toCancel;
+ *
+ * // Wait 20 seconds, and optionally allow the function to be cancelled.
+ * await delayMs(20000, (cancel) => { toCancel = cancel });
+ *
+ * // ... if `toCancel` is called before the 20 second timer expires, then the delayMs promise will reject.
+ * ```
+ *
+ * @internal
+ * @param ms - the number of milliseconds to wait before resolving
+ * @param cb - a callback that can provide the caller with a cancellation function
+ */
+export declare function delayMs(ms: number, abortSignal: AbortSignalLike | undefined): CancelablePromiseLike<void>;
+//# sourceMappingURL=delayMs.d.ts.map

package/dist/browser/lro/util/delayMs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"delayMs.d.ts","sourceRoot":"","sources":["../../../../src/lro/util/delayMs.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAM/D;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,CAAE,SAAQ,WAAW,CAAC,CAAC,CAAC;IAC9D;;OAEG;IACH,MAAM,IAAI,IAAI,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,OAAO,CACrB,EAAE,EAAE,MAAM,EACV,WAAW,EAAE,eAAe,GAAG,SAAS,GACvC,qBAAqB,CAAC,IAAI,CAAC,CAgC7B"}

package/{dist-esm/src → dist/browser}/lro/util/delayMs.js

@@ -1,14 +1,14 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+// Licensed under the MIT License.
 import { AbortError } from "@azure/abort-controller";
-import { maybemap } from "../../util";
+import { maybemap } from "../../util.js";
 /**
  * A promise that delays resolution until a certain amount of time (in milliseconds) has passed, with facilities for
  * robust cancellation.
  *
  * ### Example:
  *
- * ```javascript
+ * ```ts snippet:ignore
  * let toCancel;
  *
  * // Wait 20 seconds, and optionally allow the function to be cancelled.

package/dist/browser/lro/util/delayMs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delayMs.js","sourceRoot":"","sources":["../../../../src/lro/util/delayMs.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAezC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,OAAO,CACrB,EAAU,EACV,WAAwC;IAExC,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,QAA0C,CAAC;IAE/C,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;QAC1C,OAAO,GAAG,IAAI,CAAC;QACf,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,MAAM,CAClB,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACpC,IAAI,KAAoC,CAAC;QACzC,QAAQ,GAAG,CAAC,CAAC,EAAE,EAAE;YACf,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YAC9B,MAAM,CAAC,CAAC,CAAC,CAAC;QACZ,CAAC,CAAC;QAEF,6GAA6G;QAC7G,+FAA+F;QAC/F,IAAI,OAAO,EAAE,CAAC;YACZ,QAAQ,CAAC,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC,CAAC;QAClE,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAClC,CAAC;IACH,CAAC,CAAC,EACF;QACE,MAAM,EAAE,GAAG,EAAE;YACX,OAAO,GAAG,IAAI,CAAC;YACf,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC;QACxD,CAAC;KACF,CACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\nimport { AbortError } from \"@azure/abort-controller\";\nimport { maybemap } from \"../../util.js\";\n\ntype CancellationToken = Parameters<typeof clearTimeout>[0];\n\n/**\n * A PromiseLike object that supports cancellation.\n * @internal\n */\nexport interface CancelablePromiseLike<T> extends PromiseLike<T> {\n  /**\n   * Cancel the promise (cause it to reject).\n   */\n  cancel(): void;\n}\n\n/**\n * A promise that delays resolution until a certain amount of time (in milliseconds) has passed, with facilities for\n * robust cancellation.\n *\n * ### Example:\n *\n * ```ts snippet:ignore\n * let toCancel;\n *\n * // Wait 20 seconds, and optionally allow the function to be cancelled.\n * await delayMs(20000, (cancel) => { toCancel = cancel });\n *\n * // ... if `toCancel` is called before the 20 second timer expires, then the delayMs promise will reject.\n * ```\n *\n * @internal\n * @param ms - the number of milliseconds to wait before resolving\n * @param cb - a callback that can provide the caller with a cancellation function\n */\nexport function delayMs(\n  ms: number,\n  abortSignal: AbortSignalLike | undefined,\n): CancelablePromiseLike<void> {\n  let aborted = false;\n  let toReject: ((e: Error) => void) | undefined;\n\n  abortSignal?.addEventListener(\"abort\", () => {\n    aborted = true;\n    toReject?.(new AbortError(\"The operation was aborted.\"));\n  });\n\n  return Object.assign(\n    new Promise<void>((resolve, reject) => {\n      let token: CancellationToken | undefined;\n      toReject = (e) => {\n        maybemap(token, clearTimeout);\n        reject(e);\n      };\n\n      // In the rare case that the operation is _already_ aborted, we will reject instantly. This could happen, for\n      // example, if the user calls the cancellation function immediately without yielding execution.\n      if (aborted) {\n        toReject(new Error(\"The operation was cancelled prematurely.\"));\n      } else {\n        token = setTimeout(resolve, ms);\n      }\n    }),\n    {\n      cancel: () => {\n        aborted = true;\n        toReject?.(new Error(\"The operation was cancelled.\"));\n      },\n    },\n  );\n}\n"]}

package/dist/browser/lro/util/poller.d.ts

@@ -0,0 +1,41 @@
+import type { PollOperationState, PollerLike } from "@azure/core-lro";
+import type { AbortSignalLike } from "@azure/abort-controller";
+/**
+ * Information about the Long-Running Operation (LRO) that is being performed.
+ */
+export interface OperationContext {
+    /**
+     * An AbortSignal that can be used to cancel the operation.
+     */
+    abortSignal?: AbortSignalLike;
+    /**
+     * Sets the server's preferred polling interval in milliseconds. To clear the server's preferred polling interval,
+     * pass `undefined`.
+     */
+    updateDelay: (interval: number | undefined) => void;
+}
+/**
+ * A specification for a long-running operation, which defines the poller flow.
+ * @internal
+ */
+export interface OperationSpec<TState extends PollOperationState<unknown>> {
+    /**
+     * A function that produces the first operation state for this LRO.
+     */
+    init: (ctx: OperationContext) => Promise<TState>;
+    /**
+     * A function that consumes the existing state of the poller and produces the next state.
+     */
+    poll: (ctx: OperationContext, state: TState) => Promise<TState>;
+    /**
+     * A function that serializes the state into a string.
+     */
+    serialize: (state: TState) => string;
+}
+/**
+ * Uniform poller implementation, creates a poller based on a PollerSpec.
+ *
+ * @internal
+ */
+export declare function lro<TResult, TState extends PollOperationState<TResult>>(spec: OperationSpec<TState>, pollingInterval: number | undefined, initAbortSignal: AbortSignalLike | undefined): Promise<PollerLike<TState, TResult>>;
+//# sourceMappingURL=poller.d.ts.map

package/dist/browser/lro/util/poller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"poller.d.ts","sourceRoot":"","sources":["../../../../src/lro/util/poller.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAEtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAK/D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;IAE9B;;;OAGG;IACH,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,SAAS,kBAAkB,CAAC,OAAO,CAAC;IACvE;;OAEG;IACH,IAAI,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IACjD;;OAEG;IACH,IAAI,EAAE,CAAC,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAChE;;OAEG;IACH,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CACtC;AAED;;;;GAIG;AACH,wBAAsB,GAAG,CAAC,OAAO,EAAE,MAAM,SAAS,kBAAkB,CAAC,OAAO,CAAC,EAC3E,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,EAC3B,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,eAAe,EAAE,eAAe,GAAG,SAAS,GAC3C,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CA2FtC"}

package/{dist-esm/src → dist/browser}/lro/util/poller.js

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-import { delayMs } from "./delayMs";
+// Licensed under the MIT License.
+import { delayMs } from "./delayMs.js";
 import { AbortError } from "@azure/abort-controller";
 const DEFAULT_POLLING_INTERVAL = 5000;
 /**

package/dist/browser/lro/util/poller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"poller.js","sourceRoot":"","sources":["../../../../src/lro/util/poller.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,MAAM,wBAAwB,GAAG,IAAI,CAAC;AAqCtC;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,GAAG,CACvB,IAA2B,EAC3B,eAAmC,EACnC,eAA4C;IAE5C,IAAI,iBAAqC,CAAC;IAE1C,MAAM,WAAW,GAAqB;QACpC,WAAW,EAAE,eAAe;QAC5B,WAAW,EAAE,CAAC,QAAQ,EAAE,EAAE;YACxB,iBAAiB,GAAG,QAAQ,CAAC;QAC/B,CAAC;KACF,CAAC;IAEF,IAAI,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,EAAE,CAAC;QAC7B,MAAM,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAIzC,kGAAkG;IAClG,wEAAwE;IACxE,IAAI,GAAiC,CAAC;IACtC,IAAI,SAAmC,CAAC;IAIxC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAmB,CAAC;IAC5C,MAAM,oBAAoB,GAAG,KAAK,IAAmB,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAE1F,MAAM,IAAI,GAAe;QACvB,UAAU,EAAE,CAAC,QAAiC,EAAE,EAAE;YAChD,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;YACnB,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YAC1B,OAAO,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC;QACD,WAAW,EAAE,GAAG,EAAE,CAAC,SAAS,aAAT,SAAS,uBAAT,SAAS,EAAI;QAChC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACtB,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CACrB;gBACE,WAAW,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW;gBACjC,WAAW,EAAE,CAAC,QAAQ,EAAE,EAAE;oBACxB,iBAAiB,GAAG,QAAQ,CAAC;gBAC/B,CAAC;aACF,EACD,KAAK,CACN,CAAC;YACF,oBAAoB,EAAE,CAAC;QACzB,CAAC;QACD,aAAa,EAAE,CAAC,OAAO,EAAE,EAAE,CACzB,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,IAAH,GAAG,GAAK,CAAC,KAAK,IAAI,EAAE;YACnB,+DAA+D;YAC/D,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;gBACnB,gGAAgG;gBAChG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACzB,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;oBACtB,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,CACnC,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,CAAC,EACtB,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,wBAAwB,CAC5C,CAAC;oBACF,MAAM,KAAK,GAAG,OAAO,CAAC,oBAAoB,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,CAAC,CAAC;oBAClE,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC;oBACzB,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAEhC,+GAA+G;YAC/G,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,MAAM,CAAC;iBACnC,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;gBAAE,MAAM,KAAK,CAAC,KAAK,CAAC;YACtD,cAAc;iBACT,CAAC;gBACJ,MAAM,IAAI,KAAK,CACb,8EAA8E,KAAK,EAAE,CACtF,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;YAChB,GAAG,GAAG,SAAS,CAAC;QAClB,CAAC,CAAC,EAAC;QACL,mDAAmD;QACnD,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG;QACtB,oEAAoE;QACpE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK;QAC7C,0CAA0C;QAC1C,eAAe;YACb,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAChG,CAAC;QACD,iBAAiB,EAAE,GAAG,EAAE,CAAC,KAAK;QAC9B,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM;QAC7B,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;KACtC,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PollOperationState, PollerLike } from \"@azure/core-lro\";\nimport { delayMs } from \"./delayMs.js\";\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\nimport { AbortError } from \"@azure/abort-controller\";\n\nconst DEFAULT_POLLING_INTERVAL = 5000;\n\n/**\n * Information about the Long-Running Operation (LRO) that is being performed.\n */\nexport interface OperationContext {\n  /**\n   * An AbortSignal that can be used to cancel the operation.\n   */\n  abortSignal?: AbortSignalLike;\n\n  /**\n   * Sets the server's preferred polling interval in milliseconds. To clear the server's preferred polling interval,\n   * pass `undefined`.\n   */\n  updateDelay: (interval: number | undefined) => void;\n}\n\n/**\n * A specification for a long-running operation, which defines the poller flow.\n * @internal\n */\nexport interface OperationSpec<TState extends PollOperationState<unknown>> {\n  /**\n   * A function that produces the first operation state for this LRO.\n   */\n  init: (ctx: OperationContext) => Promise<TState>;\n  /**\n   * A function that consumes the existing state of the poller and produces the next state.\n   */\n  poll: (ctx: OperationContext, state: TState) => Promise<TState>;\n  /**\n   * A function that serializes the state into a string.\n   */\n  serialize: (state: TState) => string;\n}\n\n/**\n * Uniform poller implementation, creates a poller based on a PollerSpec.\n *\n * @internal\n */\nexport async function lro<TResult, TState extends PollOperationState<TResult>>(\n  spec: OperationSpec<TState>,\n  pollingInterval: number | undefined,\n  initAbortSignal: AbortSignalLike | undefined,\n): Promise<PollerLike<TState, TResult>> {\n  let serverDrivenDelay: number | undefined;\n\n  const initContext: OperationContext = {\n    abortSignal: initAbortSignal,\n    updateDelay: (interval) => {\n      serverDrivenDelay = interval;\n    },\n  };\n\n  if (initAbortSignal?.aborted) {\n    throw new AbortError(\"The operation was aborted.\");\n  }\n\n  let state = await spec.init(initContext);\n\n  type ThisPoller = PollerLike<TState, TResult>;\n\n  // Job handling. If `job` is defined, then there is an active `pollUntilDone` call on this poller.\n  // Call `cancelJob` to interrupt the polling loop (awaiters will throw).\n  let job: Promise<TResult> | undefined;\n  let cancelJob: (() => void) | undefined;\n\n  // Progress handlers\n  type Handler = (state: TState) => void;\n  const handlers = new Map<symbol, Handler>();\n  const handleProgressEvents = async (): Promise<void> => handlers.forEach((h) => h(state));\n\n  const self: ThisPoller = {\n    onProgress: (callback: (state: TState) => void) => {\n      const s = Symbol();\n      handlers.set(s, callback);\n      return () => handlers.delete(s);\n    },\n    stopPolling: () => cancelJob?.(),\n    poll: async (options) => {\n      state = await spec.poll(\n        {\n          abortSignal: options?.abortSignal,\n          updateDelay: (interval) => {\n            serverDrivenDelay = interval;\n          },\n        },\n        state,\n      );\n      handleProgressEvents();\n    },\n    pollUntilDone: (options) =>\n      (job ??= (async () => {\n        // Technically, the poller could complete during initialization\n        if (!self.isDone()) {\n          // Poll once to get the ball rolling, this avoids a delay if the operation completes immediately\n          await self.poll(options);\n          while (!self.isDone()) {\n            const finalPollingInterval = Math.max(\n              serverDrivenDelay ?? 0,\n              pollingInterval ?? DEFAULT_POLLING_INTERVAL,\n            );\n            const delay = delayMs(finalPollingInterval, options?.abortSignal);\n            cancelJob = delay.cancel;\n            await delay.then(() => self.poll());\n          }\n        }\n        const result = self.getResult();\n\n        // The state says it's done, so we know we are in either a success case, an error case, or an _internal_ error.\n        if (result !== undefined) return result;\n        else if (state.error !== undefined) throw state.error;\n        // Unreachable\n        else {\n          throw new Error(\n            `Internal Client Error: analysis poller completed without success or error: ${state}`,\n          );\n        }\n      })().finally(() => {\n        job = undefined;\n      })),\n    // The poller is stopped if there is no job running\n    isStopped: () => !!job,\n    // The operation is complete if either a result or error is produced\n    isDone: () => !!state.result || !!state.error,\n    // In FR, all operations run to completion\n    cancelOperation() {\n      throw new Error(\"The Azure Form Recognizer service does not support operation cancellation.\");\n    },\n    getOperationState: () => state,\n    getResult: () => state.result,\n    toString: () => spec.serialize(state),\n  };\n\n  return self;\n}\n"]}

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

@@ -0,0 +1,56 @@
+import { AzureBlobContentSource as AzureBlobSourceDetails, AzureBlobFileListContentSource as AzureBlobFileListSourceDetails } from "../generated/index.js";
+export { AzureBlobSourceDetails, AzureBlobFileListSourceDetails };
+/**
+ * A training data source defined by an Azure Blob Container.
+ */
+export interface AzureBlobSource {
+    /**
+     * The underlying details of the Azure Blob Source.
+     */
+    azureBlobSource: AzureBlobSourceDetails;
+    /**
+     * Must be undefined for a Blob Source.
+     */
+    azureBlobFileListSource?: undefined;
+}
+/**
+ * A training data source defined by an Azure Blob Container and a JSONL file list within the container.
+ */
+export interface AzureBlobFileListSource {
+    /**
+     * The underlying details of the Azure Blob File List Source.
+     */
+    azureBlobFileListSource: AzureBlobFileListSourceDetails;
+    /**
+     * Must be undefined for a Blob File List Source.
+     */
+    azureBlobSource?: undefined;
+}
+/**
+ * A content source that may be used to build a document model.
+ *
+ * One of:
+ * - BlobSource
+ * - BlobFileListSource
+ */
+export type DocumentModelSource = AzureBlobSource | AzureBlobFileListSource;
+/**
+ * A content source that may be used to build a document classifier.
+ *
+ * One of:
+ * - BlobSource
+ * - BlobFileListSource
+ */
+export type DocumentClassifierSource = AzureBlobSource | AzureBlobFileListSource;
+/**
+ * A set of sources used to create a document classifier. This is a map of
+ * document type names to sources that will be used to train the model to
+ * classify documents of the corresponding source type.
+ */
+export interface DocumentClassifierDocumentTypeSources {
+    /**
+     * The training data source of a given document type name.
+     */
+    [docType: string]: DocumentClassifierSource;
+}
+//# sourceMappingURL=contentSource.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"contentSource.d.ts","sourceRoot":"","sources":["../../../src/models/contentSource.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,sBAAsB,IAAI,sBAAsB,EAChD,8BAA8B,IAAI,8BAA8B,EACjE,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,sBAAsB,EAAE,8BAA8B,EAAE,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,EAAE,sBAAsB,CAAC;IAExC;;OAEG;IACH,uBAAuB,CAAC,EAAE,SAAS,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,uBAAuB,EAAE,8BAA8B,CAAC;IAExD;;OAEG;IACH,eAAe,CAAC,EAAE,SAAS,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,uBAAuB,CAAC;AAE5E;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG,uBAAuB,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,CAAC,OAAO,EAAE,MAAM,GAAG,wBAAwB,CAAC;CAC7C"}

package/dist/browser/models/contentSource.js

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

package/dist/browser/models/contentSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentSource.js","sourceRoot":"","sources":["../../../src/models/contentSource.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n  AzureBlobContentSource as AzureBlobSourceDetails,\n  AzureBlobFileListContentSource as AzureBlobFileListSourceDetails,\n} from \"../generated/index.js\";\n\nexport { AzureBlobSourceDetails, AzureBlobFileListSourceDetails };\n\n/**\n * A training data source defined by an Azure Blob Container.\n */\nexport interface AzureBlobSource {\n  /**\n   * The underlying details of the Azure Blob Source.\n   */\n  azureBlobSource: AzureBlobSourceDetails;\n\n  /**\n   * Must be undefined for a Blob Source.\n   */\n  azureBlobFileListSource?: undefined;\n}\n\n/**\n * A training data source defined by an Azure Blob Container and a JSONL file list within the container.\n */\nexport interface AzureBlobFileListSource {\n  /**\n   * The underlying details of the Azure Blob File List Source.\n   */\n  azureBlobFileListSource: AzureBlobFileListSourceDetails;\n\n  /**\n   * Must be undefined for a Blob File List Source.\n   */\n  azureBlobSource?: undefined;\n}\n\n/**\n * A content source that may be used to build a document model.\n *\n * One of:\n * - BlobSource\n * - BlobFileListSource\n */\nexport type DocumentModelSource = AzureBlobSource | AzureBlobFileListSource;\n\n/**\n * A content source that may be used to build a document classifier.\n *\n * One of:\n * - BlobSource\n * - BlobFileListSource\n */\nexport type DocumentClassifierSource = AzureBlobSource | AzureBlobFileListSource;\n\n/**\n * A set of sources used to create a document classifier. This is a map of\n * document type names to sources that will be used to train the model to\n * classify documents of the corresponding source type.\n */\nexport interface DocumentClassifierDocumentTypeSources {\n  /**\n   * The training data source of a given document type name.\n   */\n  [docType: string]: DocumentClassifierSource;\n}\n"]}