@azure/ai-form-recognizer 5.0.0 → 5.1.0

package/dist/browser/azureKeyCredentialPolicy.d.ts

@@ -0,0 +1,8 @@
+import type { KeyCredential } from "@azure/core-auth";
+import type { PipelinePolicy } from "@azure/core-rest-pipeline";
+/**
+ * Create an HTTP pipeline policy to authenticate a request using an `AzureKeyCredential` for Azure Form Recognizer
+ * @internal
+ */
+export declare function createFormRecognizerAzureKeyCredentialPolicy(credential: KeyCredential): PipelinePolicy;
+//# sourceMappingURL=azureKeyCredentialPolicy.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"azureKeyCredentialPolicy.d.ts","sourceRoot":"","sources":["../../src/azureKeyCredentialPolicy.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,cAAc,EAAoB,MAAM,2BAA2B,CAAC;AAIlF;;;GAGG;AACH,wBAAgB,4CAA4C,CAC1D,UAAU,EAAE,aAAa,GACxB,cAAc,CAQhB"}

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

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+// Licensed under the MIT License.
 const APIM_SUBSCRIPTION_KEY_HEADER = "Ocp-Apim-Subscription-Key";
 /**
  * Create an HTTP pipeline policy to authenticate a request using an `AzureKeyCredential` for Azure Form Recognizer

package/dist/browser/azureKeyCredentialPolicy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"azureKeyCredentialPolicy.js","sourceRoot":"","sources":["../../src/azureKeyCredentialPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAKlC,MAAM,4BAA4B,GAAG,2BAA2B,CAAC;AAEjE;;;GAGG;AACH,MAAM,UAAU,4CAA4C,CAC1D,UAAyB;IAEzB,OAAO;QACL,IAAI,EAAE,sDAAsD;QAC5D,WAAW,CAAC,OAAO,EAAE,IAAI;YACvB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;YAClE,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { KeyCredential } from \"@azure/core-auth\";\nimport type { PipelinePolicy, PipelineResponse } from \"@azure/core-rest-pipeline\";\n\nconst APIM_SUBSCRIPTION_KEY_HEADER = \"Ocp-Apim-Subscription-Key\";\n\n/**\n * Create an HTTP pipeline policy to authenticate a request using an `AzureKeyCredential` for Azure Form Recognizer\n * @internal\n */\nexport function createFormRecognizerAzureKeyCredentialPolicy(\n  credential: KeyCredential,\n): PipelinePolicy {\n  return {\n    name: \"cognitiveServicesApimSubscriptionKeyCredentialPolicy\",\n    sendRequest(request, next): Promise<PipelineResponse> {\n      request.headers.set(APIM_SUBSCRIPTION_KEY_HEADER, credential.key);\n      return next(request);\n    },\n  };\n}\n"]}

package/dist/browser/bin/defaultFields.d.ts

@@ -0,0 +1,14 @@
+import type { DocumentModelDetails } from "../index.js";
+import type { Field } from "./utils.js";
+/**
+ * @internal
+ * Field information for the top level fields of `AnalyzeResult`.
+ */
+export declare const defaultResultFields: Record<string, Field>;
+/**
+ * @internal
+ * @param model - the model to get the features of
+ * @returns the list of features supported by the model
+ */
+export declare function getFeatures(model: DocumentModelDetails): string[];
+//# sourceMappingURL=defaultFields.d.ts.map

package/dist/browser/bin/defaultFields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultFields.d.ts","sourceRoot":"","sources":["../../../src/bin/defaultFields.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CA2C5C,CAAC;AAgBX;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,oBAAoB,GAAG,MAAM,EAAE,CAiBjE"}

package/dist/browser/bin/defaultFields.js

@@ -0,0 +1,83 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * @internal
+ * Field information for the top level fields of `AnalyzeResult`.
+ */
+export const defaultResultFields = {
+    pages: {
+        name: "pages",
+        docContents: "Extracted pages.",
+        type: "fr.DocumentPage[]",
+        optional: true,
+    },
+    tables: {
+        name: "tables",
+        docContents: "Extracted tables.",
+        type: "fr.DocumentTable[]",
+        optional: true,
+    },
+    keyValuePairs: {
+        name: "keyValuePairs",
+        docContents: "Extracted key-value pairs.",
+        type: "fr.DocumentKeyValuePair[]",
+        optional: true,
+    },
+    languages: {
+        name: "languages",
+        docContents: "Extracted text languages.",
+        type: "fr.DocumentLanguage[]",
+        optional: true,
+    },
+    styles: {
+        name: "styles",
+        docContents: "Extracted font styles.",
+        type: "fr.DocumentStyle[]",
+        optional: true,
+    },
+    unconstrainedDocuments: {
+        name: "documents",
+        docContents: "Extracted documents containing any extracted fields.",
+        type: "fr.AnalyzedDocument[]",
+        optional: true,
+    },
+    paragraphs: {
+        name: "paragraphs",
+        docContents: "Extracted document paragraphs.",
+        type: "fr.DocumentParagraph[]",
+        optional: true,
+    },
+};
+const allFeatures = [
+    "pages",
+    "tables",
+    "keyValuePairs",
+    "languages",
+    "styles",
+    "paragraphs",
+    "_documents",
+];
+const textFeatures = ["pages", "paragraphs", "styles"];
+const layoutFeatures = [...textFeatures, "tables"];
+const documentFeatures = [...layoutFeatures, "keyValuePairs"];
+/**
+ * @internal
+ * @param model - the model to get the features of
+ * @returns the list of features supported by the model
+ */
+export function getFeatures(model) {
+    var _a, _b;
+    return ((_b = (_a = model.features) !== null && _a !== void 0 ? _a : {
+        "prebuilt-read": [...textFeatures, "languages"],
+        "prebuilt-layout": layoutFeatures,
+        "prebuilt-document": [...documentFeatures, "unconstrainedDocuments"],
+        "prebuilt-receipt": [...textFeatures, "keyValuePairs", "_documents"],
+        "prebuilt-invoice": [...layoutFeatures, "keyValuePairs", "_documents"],
+        "prebuilt-idDocument": [...textFeatures, "keyValuePairs", "_documents"],
+        "prebuilt-businessCard": [...textFeatures, "keyValuePairs", "_documents"],
+        "prebuilt-tax.us.w2": [...textFeatures, "keyValuePairs", "_documents"],
+        "prebuilt-vaccinationCard": [...textFeatures, "keyValuePairs", "_documents"],
+        "prebuilt-healthInsuranceCard.us": [...textFeatures, "keyValuePairs", "_documents"],
+    }[model.modelId]) !== null && _b !== void 0 ? _b : (model.modelId.startsWith("prebuilt-") ? allFeatures : [...documentFeatures, "_documents"]));
+}
+//# sourceMappingURL=defaultFields.js.map

package/dist/browser/bin/defaultFields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultFields.js","sourceRoot":"","sources":["../../../src/bin/defaultFields.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAKlC;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAA0B;IACxD,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,kBAAkB;QAC/B,IAAI,EAAE,mBAAmB;QACzB,QAAQ,EAAE,IAAI;KACf;IACD,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,mBAAmB;QAChC,IAAI,EAAE,oBAAoB;QAC1B,QAAQ,EAAE,IAAI;KACf;IACD,aAAa,EAAE;QACb,IAAI,EAAE,eAAe;QACrB,WAAW,EAAE,4BAA4B;QACzC,IAAI,EAAE,2BAA2B;QACjC,QAAQ,EAAE,IAAI;KACf;IACD,SAAS,EAAE;QACT,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,2BAA2B;QACxC,IAAI,EAAE,uBAAuB;QAC7B,QAAQ,EAAE,IAAI;KACf;IACD,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wBAAwB;QACrC,IAAI,EAAE,oBAAoB;QAC1B,QAAQ,EAAE,IAAI;KACf;IACD,sBAAsB,EAAE;QACtB,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,sDAAsD;QACnE,IAAI,EAAE,uBAAuB;QAC7B,QAAQ,EAAE,IAAI;KACf;IACD,UAAU,EAAE;QACV,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE,gCAAgC;QAC7C,IAAI,EAAE,wBAAwB;QAC9B,QAAQ,EAAE,IAAI;KACf;CACO,CAAC;AAEX,MAAM,WAAW,GAAG;IAClB,OAAO;IACP,QAAQ;IACR,eAAe;IACf,WAAW;IACX,QAAQ;IACR,YAAY;IACZ,YAAY;CACb,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;AACvD,MAAM,cAAc,GAAG,CAAC,GAAG,YAAY,EAAE,QAAQ,CAAC,CAAC;AACnD,MAAM,gBAAgB,GAAG,CAAC,GAAG,cAAc,EAAE,eAAe,CAAC,CAAC;AAE9D;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,KAA2B;;IACrD,OAAO,CACL,MAAA,MAAC,KAAa,CAAC,QAAQ,mCACvB;QACE,eAAe,EAAE,CAAC,GAAG,YAAY,EAAE,WAAW,CAAC;QAC/C,iBAAiB,EAAE,cAAc;QACjC,mBAAmB,EAAE,CAAC,GAAG,gBAAgB,EAAE,wBAAwB,CAAC;QACpE,kBAAkB,EAAE,CAAC,GAAG,YAAY,EAAE,eAAe,EAAE,YAAY,CAAC;QACpE,kBAAkB,EAAE,CAAC,GAAG,cAAc,EAAE,eAAe,EAAE,YAAY,CAAC;QACtE,qBAAqB,EAAE,CAAC,GAAG,YAAY,EAAE,eAAe,EAAE,YAAY,CAAC;QACvE,uBAAuB,EAAE,CAAC,GAAG,YAAY,EAAE,eAAe,EAAE,YAAY,CAAC;QACzE,oBAAoB,EAAE,CAAC,GAAG,YAAY,EAAE,eAAe,EAAE,YAAY,CAAC;QACtE,0BAA0B,EAAE,CAAC,GAAG,YAAY,EAAE,eAAe,EAAE,YAAY,CAAC;QAC5E,iCAAiC,EAAE,CAAC,GAAG,YAAY,EAAE,eAAe,EAAE,YAAY,CAAC;KACpF,CAAC,KAAK,CAAC,OAAO,CAAC,mCAChB,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,gBAAgB,EAAE,YAAY,CAAC,CAAC,CAC5F,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { DocumentModelDetails } from \"../index.js\";\nimport type { Field } from \"./utils.js\";\n\n/**\n * @internal\n * Field information for the top level fields of `AnalyzeResult`.\n */\nexport const defaultResultFields: Record<string, Field> = {\n  pages: {\n    name: \"pages\",\n    docContents: \"Extracted pages.\",\n    type: \"fr.DocumentPage[]\",\n    optional: true,\n  },\n  tables: {\n    name: \"tables\",\n    docContents: \"Extracted tables.\",\n    type: \"fr.DocumentTable[]\",\n    optional: true,\n  },\n  keyValuePairs: {\n    name: \"keyValuePairs\",\n    docContents: \"Extracted key-value pairs.\",\n    type: \"fr.DocumentKeyValuePair[]\",\n    optional: true,\n  },\n  languages: {\n    name: \"languages\",\n    docContents: \"Extracted text languages.\",\n    type: \"fr.DocumentLanguage[]\",\n    optional: true,\n  },\n  styles: {\n    name: \"styles\",\n    docContents: \"Extracted font styles.\",\n    type: \"fr.DocumentStyle[]\",\n    optional: true,\n  },\n  unconstrainedDocuments: {\n    name: \"documents\",\n    docContents: \"Extracted documents containing any extracted fields.\",\n    type: \"fr.AnalyzedDocument[]\",\n    optional: true,\n  },\n  paragraphs: {\n    name: \"paragraphs\",\n    docContents: \"Extracted document paragraphs.\",\n    type: \"fr.DocumentParagraph[]\",\n    optional: true,\n  },\n} as const;\n\nconst allFeatures = [\n  \"pages\",\n  \"tables\",\n  \"keyValuePairs\",\n  \"languages\",\n  \"styles\",\n  \"paragraphs\",\n  \"_documents\",\n];\n\nconst textFeatures = [\"pages\", \"paragraphs\", \"styles\"];\nconst layoutFeatures = [...textFeatures, \"tables\"];\nconst documentFeatures = [...layoutFeatures, \"keyValuePairs\"];\n\n/**\n * @internal\n * @param model - the model to get the features of\n * @returns the list of features supported by the model\n */\nexport function getFeatures(model: DocumentModelDetails): string[] {\n  return (\n    (model as any).features ??\n    {\n      \"prebuilt-read\": [...textFeatures, \"languages\"],\n      \"prebuilt-layout\": layoutFeatures,\n      \"prebuilt-document\": [...documentFeatures, \"unconstrainedDocuments\"],\n      \"prebuilt-receipt\": [...textFeatures, \"keyValuePairs\", \"_documents\"],\n      \"prebuilt-invoice\": [...layoutFeatures, \"keyValuePairs\", \"_documents\"],\n      \"prebuilt-idDocument\": [...textFeatures, \"keyValuePairs\", \"_documents\"],\n      \"prebuilt-businessCard\": [...textFeatures, \"keyValuePairs\", \"_documents\"],\n      \"prebuilt-tax.us.w2\": [...textFeatures, \"keyValuePairs\", \"_documents\"],\n      \"prebuilt-vaccinationCard\": [...textFeatures, \"keyValuePairs\", \"_documents\"],\n      \"prebuilt-healthInsuranceCard.us\": [...textFeatures, \"keyValuePairs\", \"_documents\"],\n    }[model.modelId] ??\n    (model.modelId.startsWith(\"prebuilt-\") ? allFeatures : [...documentFeatures, \"_documents\"])\n  );\n}\n"]}

package/dist/browser/bin/gen-model.d.ts

@@ -0,0 +1,3 @@
+#!/bin/env node
+export {};
+//# sourceMappingURL=gen-model.d.ts.map

package/dist/browser/bin/gen-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gen-model.d.ts","sourceRoot":"","sources":["../../../src/bin/gen-model.ts"],"names":[],"mappings":""}

package/dist/browser/bin/gen-model.js

@@ -0,0 +1,101 @@
+#!/bin/env node
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+// This file is ignored by the linter because it is impossible to move the copyright header above the shebang line.
+import { DefaultAzureCredential } from "@azure/identity";
+import { writeFile } from "node:fs/promises";
+import { DocumentModelAdministrationClient } from "../documentModelAdministrationClient.js";
+import { writeModelCode } from "./writeModelCode.js";
+import { format } from "prettier";
+/**
+ * @internal
+ * Prints a help message for the gen-model command.
+ */
+function printHelp() {
+    console.error(`
+Usage:
+ gen-model [options] <model-id>
+ 
+Create a strongly-typed DocumentModel for the Azure Document Intelligence SDK for JavaScript.
+
+Options:
+ -h, --help  \tshow this help message
+ -o, --output\tdetermines where to output the model
+
+ --endpoint <endpoint>\tthe Form Recognizer resource's endpoint
+
+Default values:
+
+If the \`--endpoint\` option is not provided, then the value
+of the \`FORM_RECOGNIZER_ENDPOINT\` environment
+variable will be used as default.
+
+Authentication:
+
+If the \`@azure/identity\` package is installed, the \`DefaultAzureCredential\`
+from that package will be used.
+`);
+}
+/**
+ * @internal
+ * The main function of the gen-model command.
+ */
+async function main() {
+    const args = process.argv.slice(2);
+    let modelId = undefined;
+    let endpoint = process.env.FORM_RECOGNIZER_ENDPOINT;
+    let output = undefined;
+    let test = false;
+    console.error("gen-model - create strong TypeScript types for models");
+    if (args.some((arg) => arg === "--help" || arg === "-h")) {
+        printHelp();
+        return;
+    }
+    let idx = 0;
+    while (idx < args.length) {
+        switch (args[idx]) {
+            case "--endpoint":
+                endpoint = args[(idx += 1)];
+                break;
+            case "-o":
+            case "--output":
+                output = args[(idx += 1)];
+                break;
+            case "--test":
+                test = true;
+                break;
+            default:
+                modelId = args[idx];
+                break;
+        }
+        idx += 1;
+    }
+    if (idx + 1 <= args.length) {
+        console.error("warning: unused arguments:", args.slice(idx + 1).join(" "));
+    }
+    if (!modelId) {
+        throw new Error("no model ID provided");
+    }
+    if (!endpoint) {
+        throw new Error("no endpoint provided");
+    }
+    const client = new DocumentModelAdministrationClient(endpoint, new DefaultAzureCredential());
+    const modelInfo = await client.getDocumentModel(modelId);
+    console.error("Generating model code for:", modelInfo.modelId);
+    const file = await writeModelCode(modelInfo, test);
+    const data = Buffer.from(await format(file, { parser: "typescript" }), "utf-8");
+    if (output !== undefined) {
+        // output is only refined in this context, so assigning it to "path" preserves that
+        const path = output;
+        await writeFile(path, data);
+    }
+    else {
+        process.stdout.write(data);
+    }
+}
+main().catch((e) => {
+    console.error(e);
+    console.error("see `gen-model --help` for more information");
+    process.exit(1);
+});
+//# sourceMappingURL=gen-model.js.map

package/dist/browser/bin/gen-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gen-model.js","sourceRoot":"","sources":["../../../src/bin/gen-model.ts"],"names":[],"mappings":";AAEA,uCAAuC;AACvC,kCAAkC;AAElC,mHAAmH;AAEnH,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,iCAAiC,EAAE,MAAM,yCAAyC,CAAC;AAC5F,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;GAGG;AACH,SAAS,SAAS;IAChB,OAAO,CAAC,KAAK,CAAC;;;;;;;;;;;;;;;;;;;;;;CAsBf,CAAC,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEnC,IAAI,OAAO,GAAuB,SAAS,CAAC;IAC5C,IAAI,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC;IACpD,IAAI,MAAM,GAAuB,SAAS,CAAC;IAC3C,IAAI,IAAI,GAAY,KAAK,CAAC;IAE1B,OAAO,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAEvE,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,CAAC,EAAE,CAAC;QACzD,SAAS,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IAED,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,OAAO,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACzB,QAAQ,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,YAAY;gBACf,QAAQ,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC5B,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,UAAU;gBACb,MAAM,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC1B,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,GAAG,IAAI,CAAC;gBACZ,MAAM;YACR;gBACE,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpB,MAAM;QACV,CAAC;QACD,GAAG,IAAI,CAAC,CAAC;IACX,CAAC;IAED,IAAI,GAAG,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,iCAAiC,CAAC,QAAQ,EAAE,IAAI,sBAAsB,EAAE,CAAC,CAAC;IAE7F,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAEzD,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAE/D,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAEnD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAEhF,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,mFAAmF;QACnF,MAAM,IAAI,GAAG,MAAM,CAAC;QAEpB,MAAM,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9B,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACjB,OAAO,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;IAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC","sourcesContent":["#!/bin/env node\n\n// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n// This file is ignored by the linter because it is impossible to move the copyright header above the shebang line.\n\nimport { DefaultAzureCredential } from \"@azure/identity\";\nimport { writeFile } from \"node:fs/promises\";\nimport { DocumentModelAdministrationClient } from \"../documentModelAdministrationClient.js\";\nimport { writeModelCode } from \"./writeModelCode.js\";\nimport { format } from \"prettier\";\n\n/**\n * @internal\n * Prints a help message for the gen-model command.\n */\nfunction printHelp(): void {\n  console.error(`\nUsage:\n gen-model [options] <model-id>\n \nCreate a strongly-typed DocumentModel for the Azure Document Intelligence SDK for JavaScript.\n\nOptions:\n -h, --help  \\tshow this help message\n -o, --output\\tdetermines where to output the model\n\n --endpoint <endpoint>\\tthe Form Recognizer resource's endpoint\n\nDefault values:\n\nIf the \\`--endpoint\\` option is not provided, then the value\nof the \\`FORM_RECOGNIZER_ENDPOINT\\` environment\nvariable will be used as default.\n\nAuthentication:\n\nIf the \\`@azure/identity\\` package is installed, the \\`DefaultAzureCredential\\`\nfrom that package will be used.\n`);\n}\n\n/**\n * @internal\n * The main function of the gen-model command.\n */\nasync function main(): Promise<void> {\n  const args = process.argv.slice(2);\n\n  let modelId: string | undefined = undefined;\n  let endpoint = process.env.FORM_RECOGNIZER_ENDPOINT;\n  let output: string | undefined = undefined;\n  let test: boolean = false;\n\n  console.error(\"gen-model - create strong TypeScript types for models\");\n\n  if (args.some((arg) => arg === \"--help\" || arg === \"-h\")) {\n    printHelp();\n    return;\n  }\n\n  let idx = 0;\n  while (idx < args.length) {\n    switch (args[idx]) {\n      case \"--endpoint\":\n        endpoint = args[(idx += 1)];\n        break;\n      case \"-o\":\n      case \"--output\":\n        output = args[(idx += 1)];\n        break;\n      case \"--test\":\n        test = true;\n        break;\n      default:\n        modelId = args[idx];\n        break;\n    }\n    idx += 1;\n  }\n\n  if (idx + 1 <= args.length) {\n    console.error(\"warning: unused arguments:\", args.slice(idx + 1).join(\" \"));\n  }\n\n  if (!modelId) {\n    throw new Error(\"no model ID provided\");\n  }\n\n  if (!endpoint) {\n    throw new Error(\"no endpoint provided\");\n  }\n\n  const client = new DocumentModelAdministrationClient(endpoint, new DefaultAzureCredential());\n\n  const modelInfo = await client.getDocumentModel(modelId);\n\n  console.error(\"Generating model code for:\", modelInfo.modelId);\n\n  const file = await writeModelCode(modelInfo, test);\n\n  const data = Buffer.from(await format(file, { parser: \"typescript\" }), \"utf-8\");\n\n  if (output !== undefined) {\n    // output is only refined in this context, so assigning it to \"path\" preserves that\n    const path = output;\n\n    await writeFile(path, data);\n  } else {\n    process.stdout.write(data);\n  }\n}\n\nmain().catch((e) => {\n  console.error(e);\n  console.error(\"see `gen-model --help` for more information\");\n  process.exit(1);\n});\n"]}

package/dist/browser/bin/utils.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Convert a list of strings into a camelCase joined representation.
+ */
+export declare function camelCase(slug: string[]): string;
+/**
+ * Capitalize a string.
+ */
+export declare function capitalize(s: string): string;
+/**
+ * Uncapitalize a string.
+ */
+export declare function uncapitalize(s: string): string;
+/**
+ * A simple representation of a field in an interface.
+ */
+export interface Field {
+    name: string;
+    docContents: string;
+    type: string;
+    optional?: true;
+}
+//# sourceMappingURL=utils.d.ts.map

package/dist/browser/bin/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/bin/utils.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAEhD;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAE9C;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,IAAI,CAAC;CACjB"}

package/dist/browser/bin/utils.js

@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * Convert a list of strings into a camelCase joined representation.
+ */
+export function camelCase(slug) {
+    return slug.map(capitalize).join("");
+}
+/**
+ * Capitalize a string.
+ */
+export function capitalize(s) {
+    return s.slice(0, 1).toUpperCase() + s.slice(1);
+}
+/**
+ * Uncapitalize a string.
+ */
+export function uncapitalize(s) {
+    return s.slice(0, 1).toLowerCase() + s.slice(1);
+}
+//# sourceMappingURL=utils.js.map

package/dist/browser/bin/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/bin/utils.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;GAEG;AACH,MAAM,UAAU,SAAS,CAAC,IAAc;IACtC,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACvC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,CAAS;IAClC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAClD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,CAAS;IACpC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAClD,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Convert a list of strings into a camelCase joined representation.\n */\nexport function camelCase(slug: string[]): string {\n  return slug.map(capitalize).join(\"\");\n}\n\n/**\n * Capitalize a string.\n */\nexport function capitalize(s: string): string {\n  return s.slice(0, 1).toUpperCase() + s.slice(1);\n}\n\n/**\n * Uncapitalize a string.\n */\nexport function uncapitalize(s: string): string {\n  return s.slice(0, 1).toLowerCase() + s.slice(1);\n}\n\n/**\n * A simple representation of a field in an interface.\n */\nexport interface Field {\n  name: string;\n  docContents: string;\n  type: string;\n  optional?: true;\n}\n"]}

package/dist/browser/bin/writeModelCode.d.ts

@@ -0,0 +1,9 @@
+import type { DocumentModelDetails } from "../index.js";
+/**
+ * Generate a TypeScript source file for a given model.
+ *
+ * @param model - the ModelInfo to generate code for
+ * @returns a string of TypeScript source code
+ */
+export declare function writeModelCode(model: DocumentModelDetails, test: boolean): Promise<string>;
+//# sourceMappingURL=writeModelCode.d.ts.map

package/dist/browser/bin/writeModelCode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeModelCode.d.ts","sourceRoot":"","sources":["../../../src/bin/writeModelCode.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAuB,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAmC7E;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,oBAAoB,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAoGhG"}

package/dist/browser/bin/writeModelCode.js

@@ -0,0 +1,323 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { EOL } from "node:os";
+import { defaultResultFields, getFeatures } from "./defaultFields.js";
+import { camelCase, capitalize, uncapitalize } from "./utils.js";
+// NOTE: currently, this command is set up to generate sample files for the SDK itself. If we want to expose this
+// functionality outside of samples, then we'll need to change the way the headers are generated for external use.
+/**
+ * The header to append to the top of every file.
+ */
+const sampleHeader = `
+/**
+ * @azsdk-util
+ * @azsdk-skip-javascript
+ */
+`;
+/**
+ * Generate a header with the model information.
+ */
+function templateHeader(model, test) {
+    return `// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+${!test ? sampleHeader : ""}
+// Model:       ${model.modelId}
+// Description: ${model.description}
+// API Version: ${model.apiVersion}
+// Created:     ${new Date().toDateString()}
+
+`;
+}
+/**
+ * Generate a TypeScript source file for a given model.
+ *
+ * @param model - the ModelInfo to generate code for
+ * @returns a string of TypeScript source code
+ */
+export async function writeModelCode(model, test) {
+    let contents = templateHeader(model, test);
+    if (test) {
+        contents += 'import * as fr from "../../../src";' + EOL + EOL;
+    }
+    else {
+        contents += 'import * as fr from "@azure/ai-form-recognizer";' + EOL + EOL;
+    }
+    const modelNameSlug = [
+        ...model.modelId
+            .split("-", 2)
+            // for lack of a flatMap
+            .reduce((acc, cur) => [...acc, ...cur.split(".")], []),
+    ];
+    const modelName = camelCase([...modelNameSlug, "Model"]);
+    const documentTypeName = camelCase([...modelNameSlug, "Document"]);
+    const resultName = camelCase([...modelNameSlug, "Result"]);
+    const modelFeatures = getFeatures(model);
+    const hasDocuments = modelFeatures.some((f) => f === "_documents");
+    if (model.description) {
+        contents += "/**" + EOL;
+        contents +=
+            model.description
+                // Split the comment into lines.
+                .split(/\r?\n/)
+                // Add the asterisk to the beginning of each line to block-align the comment
+                .map((l) => " * " + l)
+                .join(EOL) + EOL;
+        contents += " */" + EOL;
+    }
+    // Create the exported model object. We rely on a function named `modelInfo` to exist in the module scope, and we will
+    // add it later.
+    contents += `export const ${modelName} = fr.createModelFromSchema(modelInfo()) as fr.DocumentModel<${resultName}>;${EOL + EOL}`;
+    // Write the main Result interface.
+    for (const line of writeResultInterface(resultName, documentTypeName, modelFeatures)) {
+        contents += line + EOL;
+    }
+    contents += EOL;
+    // Now add a variant for each document type in the model, if there are any.
+    if (hasDocuments) {
+        const variants = extractModelVariants(model, modelNameSlug);
+        const variantNames = Object.keys(variants);
+        const documentType = variantNames.length > 1
+            ? // In the case of multiple variants, a union
+                variantNames.map((n) => `${EOL}  | ${n}`).join("")
+            : variantNames.length === 1
+                ? // For a single variant, just emit its name.
+                    ` ${variantNames[0]}`
+                : // This should probably be unreachable, since there's no case where
+                    // `hasDocuments && variantNames.length === 0`, but we'll still emit "never" just in case.
+                    " never";
+        // Finally, add the type alias for the type of a Document
+        contents += `export type ${documentTypeName} =${documentType};${EOL + EOL}`;
+        // Write the root interface for the variant.
+        for (const info of Object.values(variants)) {
+            for (const line of writeDocTypeInterface(info)) {
+                contents += line + EOL;
+            }
+            contents += EOL;
+        }
+        // Write all the fields interfaces that the variant uses
+        for (const info of Object.values(variants)) {
+            for (const line of writeFieldsInterfaces(info)) {
+                contents += line + EOL;
+            }
+            contents += EOL;
+        }
+    }
+    // Finally, emit the modelInfo function that provides the raw schema.
+    contents += "/**" + EOL;
+    contents += " * The raw model schema." + EOL;
+    contents += " */" + EOL;
+    contents += "function modelInfo() {" + EOL;
+    contents +=
+        `  return ${JSON.stringify(model, null, 2)
+            .split(/\r?\n/)
+            .join(EOL + "  ")} as const;` + EOL;
+    contents += "}" + EOL;
+    return contents;
+}
+// Get the doc type variants of a model.
+function extractModelVariants(model, _rootSlug) {
+    var _a;
+    const result = {};
+    for (const [docType, info] of Object.entries((_a = model.docTypes) !== null && _a !== void 0 ? _a : {})) {
+        const slug = docType.split(".");
+        const docTypeName = camelCase(slug);
+        result[docTypeName] = Object.assign(Object.assign({}, info), { name: docTypeName, originalDocType: docType, slug });
+    }
+    return result;
+}
+// Write the interface for a given DocType.
+function* writeDocTypeInterface(docType) {
+    if (docType.description) {
+        yield "/**";
+        yield* docType.description.split(/\r?\n/).map((l) => " * " + l);
+        yield " */";
+    }
+    yield `export interface ${docType.name} {`;
+    yield* indent(writeField({
+        name: "docType",
+        type: `"${docType.originalDocType}"`,
+        docContents: `Document type: "${docType.originalDocType}".`,
+    }));
+    yield* indent(writeField({
+        name: "fields",
+        type: docType.name + "Fields",
+        docContents: "Document fields.",
+    }));
+    yield* indent(flatMap([
+        {
+            name: "boundingRegions",
+            docContents: "Bounding regions covering the document.",
+            type: "fr.BoundingRegion[]",
+            optional: true,
+        },
+        {
+            name: "spans",
+            docContents: "Locations of the document's elements in the `content` text (reading-order-concatenated content).",
+            type: "fr.DocumentSpan[]",
+        },
+        {
+            name: "confidence",
+            docContents: "The service's confidence that it has correctly extracted the document.",
+            type: "number",
+        },
+    ], writeField));
+    yield "}";
+}
+/**
+ * Write a field and its comment to an iterable of strings.
+ */
+function* writeField(field) {
+    yield "/**";
+    yield* field.docContents.split(/\r?\n/).map((line) => ` * ${line}`);
+    yield " */";
+    // If the field name has an illegal character, we need to quote it.
+    const needsQuotes = !/^[a-zA-Z_$][a-zA-Z_$0-9]*$/.test(field.name);
+    const printedFieldName = needsQuotes ? `"${field.name}"` : field.name;
+    yield `${printedFieldName}${field.optional ? "?" : ""}: ${field.type};`;
+}
+/**
+ * Recursively write the fields interfaces for a given document type.
+ */
+function* writeFieldsInterfaces(docType) {
+    const name = docType.name + "Fields";
+    yield* writeInterfaceDeclaration(name, docType.description, docType.fieldSchema);
+    // Recursively visit all child interfaces and write them.
+    yield* (function* collectNestedInterfaces(fields, namingContext) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        for (const [fieldName, schema] of Object.entries(fields)) {
+            if (schema.type === "array" && ((_a = schema.items) === null || _a === void 0 ? void 0 : _a.type) === "object") {
+                // Generate element interface and recur if the nested type is an object
+                const nextNamingContext = namingContext + fieldName + "Element";
+                yield "";
+                yield "";
+                yield* writeInterfaceDeclaration(nextNamingContext, schema.description, (_c = (_b = schema.items) === null || _b === void 0 ? void 0 : _b.properties) !== null && _c !== void 0 ? _c : {});
+                yield* collectNestedInterfaces((_e = (_d = schema.items) === null || _d === void 0 ? void 0 : _d.properties) !== null && _e !== void 0 ? _e : {}, nextNamingContext);
+            }
+            else if (schema.type === "object") {
+                // Generate named interface and recur
+                yield "";
+                yield "";
+                yield* writeInterfaceDeclaration(namingContext + fieldName, schema.description, (_f = schema.properties) !== null && _f !== void 0 ? _f : {});
+                yield* collectNestedInterfaces((_g = schema.properties) !== null && _g !== void 0 ? _g : {}, namingContext + fieldName);
+            }
+        }
+    })(docType.fieldSchema, docType.name);
+    /**
+     * Write a simple interface declaration.
+     *
+     * @param interfaceName - the symbolic name of the interface
+     * @param description - the interface's documentation string.
+     * @param fields - the fields of the interface (a map of names to schemas)
+     */
+    function* writeInterfaceDeclaration(interfaceName, description, fields) {
+        yield "/**";
+        yield ` * Describes the fields of \`${interfaceName}\`.`;
+        if (description) {
+            yield " * ";
+            yield* description.split(/\r?\n/).map((l) => " * " + l);
+        }
+        yield " */";
+        const prefix = `export interface ${interfaceName} {`;
+        const suffix = "}";
+        const fieldEntries = Object.entries(fields);
+        if (fieldEntries.length === 0) {
+            yield prefix + suffix;
+        }
+        else {
+            yield prefix;
+            yield* indent(flatMap(fieldEntries.map(([fieldName, schema]) => {
+                var _a;
+                return ({
+                    // Uncapitalize the field name and remove all whitespace
+                    name: uncapitalize(fieldName).replace(/\s/g, ""),
+                    type: writeType(schema, fieldName, docType.slug),
+                    docContents: (_a = schema.description) !== null && _a !== void 0 ? _a : `\`${docType.name}\` "${fieldName}" field`,
+                    optional: true,
+                });
+            }), writeField));
+            yield suffix;
+        }
+    }
+}
+/**
+ * Generate a type name for a field schema.
+ *
+ * @param schema - the schema of the type
+ * @param name - the name to append to the field type, if necessary (only applies to objects and arrays)
+ * @param slug - the current taxonomic naming context of the field name (used to name object types)
+ * @returns a string representing the type name for the field
+ */
+function writeType(schema, name, slug) {
+    const kind = schema.type;
+    if (kind === "array") {
+        return `fr.DocumentArrayField<${writeType(schema.items, "Element", [...slug, name])}>`;
+    }
+    else if (kind === "object") {
+        const propertiesName = slug.map(capitalize).join("") + name;
+        return `fr.DocumentObjectField<${propertiesName}>`;
+    }
+    else {
+        return {
+            integer: "fr.DocumentIntegerField",
+            string: "fr.DocumentStringField",
+            countryRegion: "fr.DocumentCountryRegionField",
+            currency: "fr.DocumentCurrencyField",
+            time: "fr.DocumentTimeField",
+            date: "fr.DocumentDateField",
+            number: "fr.DocumentNumberField",
+            boolean: "fr.DocumentBooleanField",
+            phoneNumber: "fr.DocumentPhoneNumberField",
+            selectionMark: "fr.DocumentSelectionMarkField",
+            signature: "fr.DocumentSignatureField",
+            address: "fr.DocumentAddressField",
+        }[kind];
+    }
+}
+/**
+ * Generate an AnalyzeResult-level interface.
+ *
+ * @param name - the name of the interface.
+ * @param documentInterfaceName - the name of the interface's document type.
+ * @param features - the features supported by the model
+ */
+function* writeResultInterface(name, documentInterfaceName, features) {
+    const hasDocuments = features.some((f) => f === "_documents");
+    yield `export interface ${name} extends fr.AnalyzeResultCommon {`;
+    yield* indent(flatMap(features.filter((f) => f !== "_documents"), (f) => writeField(defaultResultFields[f])));
+    if (hasDocuments) {
+        yield* indent(writeField({
+            name: "documents",
+            type: documentInterfaceName + "[]",
+            docContents: "Extracted documents.",
+        }));
+    }
+    yield "}";
+}
+/**
+ * A helper function to indent an iterable.
+ */
+function* indent(contents, level = 2) {
+    const indentationString = " ".repeat(level);
+    for (const line of contents) {
+        yield indentationString + line;
+    }
+}
+/**
+ * A `flatMap` helper that works with generic iterables, not only arrays. If the result of `f` is iterable, its elements
+ * will be produced instead of itself.
+ *
+ * @param it - the iterable to map over
+ * @param f - the function to apply to each item in `it`
+ */
+function* flatMap(it, f) {
+    for (const value of it) {
+        const result = f(value);
+        if (typeof result === "object" && result !== null && Symbol.iterator in result) {
+            yield* result;
+        }
+        else {
+            yield result;
+        }
+    }
+}
+//# sourceMappingURL=writeModelCode.js.map