@azure/ai-form-recognizer 5.0.0 → 5.1.0

package/dist/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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

package/dist/esm/bin/writeModelCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeModelCode.js","sourceRoot":"","sources":["../../../src/bin/writeModelCode.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,GAAG,EAAE,MAAM,SAAS,CAAC;AAI9B,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEtE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAEjE,iHAAiH;AACjH,kHAAkH;AAElH;;GAEG;AACH,MAAM,YAAY,GAAG;;;;;CAKpB,CAAC;AAEF;;GAEG;AACH,SAAS,cAAc,CAAC,KAA2B,EAAE,IAAa;IAChE,OAAO;;EAEP,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE;kBACT,KAAK,CAAC,OAAO;kBACb,KAAK,CAAC,WAAW;kBACjB,KAAK,CAAC,UAAU;kBAChB,IAAI,IAAI,EAAE,CAAC,YAAY,EAAE;;CAE1C,CAAC;AACF,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,KAA2B,EAAE,IAAa;IAC7E,IAAI,QAAQ,GAAG,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAE3C,IAAI,IAAI,EAAE,CAAC;QACT,QAAQ,IAAI,qCAAqC,GAAG,GAAG,GAAG,GAAG,CAAC;IAChE,CAAC;SAAM,CAAC;QACN,QAAQ,IAAI,kDAAkD,GAAG,GAAG,GAAG,GAAG,CAAC;IAC7E,CAAC;IAED,MAAM,aAAa,GAAG;QACpB,GAAG,KAAK,CAAC,OAAO;aACb,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;YACd,wBAAwB;aACvB,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAc,CAAC;KACrE,CAAC;IAEF,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,GAAG,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;IACzD,MAAM,gBAAgB,GAAG,SAAS,CAAC,CAAC,GAAG,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC;IACnE,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,GAAG,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE3D,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAEzC,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,YAAY,CAAC,CAAC;IAEnE,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;QACtB,QAAQ,IAAI,KAAK,GAAG,GAAG,CAAC;QACxB,QAAQ;YACN,KAAK,CAAC,WAAW;gBACf,gCAAgC;iBAC/B,KAAK,CAAC,OAAO,CAAC;gBACf,4EAA4E;iBAC3E,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC;iBACrB,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;QACrB,QAAQ,IAAI,KAAK,GAAG,GAAG,CAAC;IAC1B,CAAC;IAED,sHAAsH;IACtH,gBAAgB;IAChB,QAAQ,IAAI,gBAAgB,SAAS,gEAAgE,UAAU,KAC7G,GAAG,GAAG,GACR,EAAE,CAAC;IAEH,mCAAmC;IACnC,KAAK,MAAM,IAAI,IAAI,oBAAoB,CAAC,UAAU,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,CAAC;QACrF,QAAQ,IAAI,IAAI,GAAG,GAAG,CAAC;IACzB,CAAC;IAED,QAAQ,IAAI,GAAG,CAAC;IAEhB,2EAA2E;IAC3E,IAAI,YAAY,EAAE,CAAC;QACjB,MAAM,QAAQ,GAAG,oBAAoB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QAE5D,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE3C,MAAM,YAAY,GAChB,YAAY,CAAC,MAAM,GAAG,CAAC;YACrB,CAAC,CAAC,4CAA4C;gBAC5C,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;YACpD,CAAC,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC;gBACzB,CAAC,CAAC,4CAA4C;oBAC5C,IAAI,YAAY,CAAC,CAAC,CAAC,EAAE;gBACvB,CAAC,CAAC,mEAAmE;oBACnE,0FAA0F;oBAC1F,QAAQ,CAAC;QAEjB,yDAAyD;QACzD,QAAQ,IAAI,eAAe,gBAAgB,KAAK,YAAY,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;QAE5E,4CAA4C;QAC5C,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3C,KAAK,MAAM,IAAI,IAAI,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/C,QAAQ,IAAI,IAAI,GAAG,GAAG,CAAC;YACzB,CAAC;YAED,QAAQ,IAAI,GAAG,CAAC;QAClB,CAAC;QAED,wDAAwD;QACxD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3C,KAAK,MAAM,IAAI,IAAI,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/C,QAAQ,IAAI,IAAI,GAAG,GAAG,CAAC;YACzB,CAAC;YAED,QAAQ,IAAI,GAAG,CAAC;QAClB,CAAC;IACH,CAAC;IAED,qEAAqE;IACrE,QAAQ,IAAI,KAAK,GAAG,GAAG,CAAC;IACxB,QAAQ,IAAI,0BAA0B,GAAG,GAAG,CAAC;IAC7C,QAAQ,IAAI,KAAK,GAAG,GAAG,CAAC;IACxB,QAAQ,IAAI,wBAAwB,GAAG,GAAG,CAAC;IAC3C,QAAQ;QACN,YAAY,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;aACvC,KAAK,CAAC,OAAO,CAAC;aACd,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;IACxC,QAAQ,IAAI,GAAG,GAAG,GAAG,CAAC;IAEtB,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,wCAAwC;AACxC,SAAS,oBAAoB,CAC3B,KAA2B,EAC3B,SAAmB;;IAEnB,MAAM,MAAM,GAA4C,EAAE,CAAC;IAE3D,KAAK,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAA,KAAK,CAAC,QAAQ,mCAAI,EAAE,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,WAAW,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,CAAC,WAAW,CAAC,mCACd,IAAI,KACP,IAAI,EAAE,WAAW,EACjB,eAAe,EAAE,OAAO,EACxB,IAAI,GACL,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,2CAA2C;AAC3C,QAAQ,CAAC,CAAC,qBAAqB,CAAC,OAAgB;IAC9C,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,MAAM,KAAK,CAAC;QACZ,KAAK,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAChE,MAAM,KAAK,CAAC;IACd,CAAC;IACD,MAAM,oBAAoB,OAAO,CAAC,IAAI,IAAI,CAAC;IAC3C,KAAK,CAAC,CAAC,MAAM,CACX,UAAU,CAAC;QACT,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,IAAI,OAAO,CAAC,eAAe,GAAG;QACpC,WAAW,EAAE,mBAAmB,OAAO,CAAC,eAAe,IAAI;KAC5D,CAAC,CACH,CAAC;IAEF,KAAK,CAAC,CAAC,MAAM,CACX,UAAU,CAAC;QACT,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,OAAO,CAAC,IAAI,GAAG,QAAQ;QAC7B,WAAW,EAAE,kBAAkB;KAChC,CAAC,CACH,CAAC;IAEF,KAAK,CAAC,CAAC,MAAM,CACX,OAAO,CACL;QACE;YACE,IAAI,EAAE,iBAAiB;YACvB,WAAW,EAAE,yCAAyC;YACtD,IAAI,EAAE,qBAAqB;YAC3B,QAAQ,EAAE,IAAI;SACf;QACD;YACE,IAAI,EAAE,OAAO;YACb,WAAW,EACT,kGAAkG;YACpG,IAAI,EAAE,mBAAmB;SAC1B;QACD;YACE,IAAI,EAAE,YAAY;YAClB,WAAW,EAAE,wEAAwE;YACrF,IAAI,EAAE,QAAQ;SACf;KACF,EACD,UAAU,CACX,CACF,CAAC;IAEF,MAAM,GAAG,CAAC;AACZ,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,UAAU,CAAC,KAAY;IAC/B,MAAM,KAAK,CAAC;IACZ,KAAK,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IACpE,MAAM,KAAK,CAAC;IAEZ,mEAAmE;IACnE,MAAM,WAAW,GAAG,CAAC,4BAA4B,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACnE,MAAM,gBAAgB,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;IAEtE,MAAM,GAAG,gBAAgB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,IAAI,GAAG,CAAC;AAC1E,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,qBAAqB,CAAC,OAAgB;IAC9C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC;IAErC,KAAK,CAAC,CAAC,yBAAyB,CAAC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAEjF,yDAAyD;IACzD,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,uBAAuB,CACvC,MAA2C,EAC3C,aAAqB;;QAErB,KAAK,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACzD,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,IAAI,CAAA,MAAA,MAAM,CAAC,KAAK,0CAAE,IAAI,MAAK,QAAQ,EAAE,CAAC;gBAC/D,uEAAuE;gBAEvE,MAAM,iBAAiB,GAAG,aAAa,GAAG,SAAS,GAAG,SAAS,CAAC;gBAEhE,MAAM,EAAE,CAAC;gBACT,MAAM,EAAE,CAAC;gBACT,KAAK,CAAC,CAAC,yBAAyB,CAC9B,iBAAiB,EACjB,MAAM,CAAC,WAAW,EAClB,MAAA,MAAA,MAAM,CAAC,KAAK,0CAAE,UAAU,mCAAI,EAAE,CAC/B,CAAC;gBAEF,KAAK,CAAC,CAAC,uBAAuB,CAAC,MAAA,MAAA,MAAM,CAAC,KAAK,0CAAE,UAAU,mCAAI,EAAE,EAAE,iBAAiB,CAAC,CAAC;YACpF,CAAC;iBAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACpC,qCAAqC;gBAErC,MAAM,EAAE,CAAC;gBACT,MAAM,EAAE,CAAC;gBACT,KAAK,CAAC,CAAC,yBAAyB,CAC9B,aAAa,GAAG,SAAS,EACzB,MAAM,CAAC,WAAW,EAClB,MAAA,MAAM,CAAC,UAAU,mCAAI,EAAE,CACxB,CAAC;gBAEF,KAAK,CAAC,CAAC,uBAAuB,CAAC,MAAA,MAAM,CAAC,UAAU,mCAAI,EAAE,EAAE,aAAa,GAAG,SAAS,CAAC,CAAC;YACrF,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtC;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,yBAAyB,CACjC,aAAqB,EACrB,WAA+B,EAC/B,MAA2C;QAE3C,MAAM,KAAK,CAAC;QACZ,MAAM,gCAAgC,aAAa,KAAK,CAAC;QACzD,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,KAAK,CAAC;YACZ,KAAK,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAC1D,CAAC;QACD,MAAM,KAAK,CAAC;QACZ,MAAM,MAAM,GAAG,oBAAoB,aAAa,IAAI,CAAC;QACrD,MAAM,MAAM,GAAG,GAAG,CAAC;QAEnB,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAE5C,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,MAAM,GAAG,MAAM,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,CAAC;YACb,KAAK,CAAC,CAAC,MAAM,CACX,OAAO,CACL,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,EAAE;;gBAAC,OAAA,CAAC;oBACzC,wDAAwD;oBACxD,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;oBAChD,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC;oBAChD,WAAW,EAAE,MAAA,MAAM,CAAC,WAAW,mCAAI,KAAK,OAAO,CAAC,IAAI,OAAO,SAAS,SAAS;oBAC7E,QAAQ,EAAE,IAAa;iBACxB,CAAC,CAAA;aAAA,CAAC,EACH,UAAU,CACX,CACF,CAAC;YACF,MAAM,MAAM,CAAC;QACf,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,SAAS,CAAC,MAA2B,EAAE,IAAY,EAAE,IAAc;IAC1E,MAAM,IAAI,GAAG,MAAM,CAAC,IAA6B,CAAC;IAElD,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,OAAO,yBAAyB,SAAS,CAAC,MAAM,CAAC,KAAM,EAAE,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC;IAC1F,CAAC;SAAM,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;QAC5D,OAAO,0BAA0B,cAAc,GAAG,CAAC;IACrD,CAAC;SAAM,CAAC;QACN,OAAO;YACL,OAAO,EAAE,yBAAyB;YAClC,MAAM,EAAE,wBAAwB;YAChC,aAAa,EAAE,+BAA+B;YAC9C,QAAQ,EAAE,0BAA0B;YACpC,IAAI,EAAE,sBAAsB;YAC5B,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,wBAAwB;YAChC,OAAO,EAAE,yBAAyB;YAClC,WAAW,EAAE,6BAA6B;YAC1C,aAAa,EAAE,+BAA+B;YAC9C,SAAS,EAAE,2BAA2B;YACtC,OAAO,EAAE,yBAAyB;SACnC,CAAC,IAAI,CAAC,CAAC;IACV,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,QAAQ,CAAC,CAAC,oBAAoB,CAC5B,IAAY,EACZ,qBAA6B,EAC7B,QAAkB;IAElB,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,YAAY,CAAC,CAAC;IAE9D,MAAM,oBAAoB,IAAI,mCAAmC,CAAC;IAClE,KAAK,CAAC,CAAC,MAAM,CACX,OAAO,CACL,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,YAAY,CAAC,EAC1C,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAC1C,CACF,CAAC;IACF,IAAI,YAAY,EAAE,CAAC;QACjB,KAAK,CAAC,CAAC,MAAM,CACX,UAAU,CAAC;YACT,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,qBAAqB,GAAG,IAAI;YAClC,WAAW,EAAE,sBAAsB;SACpC,CAAC,CACH,CAAC;IACJ,CAAC;IACD,MAAM,GAAG,CAAC;AACZ,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,MAAM,CAAC,QAA0B,EAAE,QAAgB,CAAC;IAC5D,MAAM,iBAAiB,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAE5C,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,iBAAiB,GAAG,IAAI,CAAC;IACjC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,QAAQ,CAAC,CAAC,OAAO,CAAS,EAAgB,EAAE,CAA+B;IACzE,KAAK,MAAM,KAAK,IAAI,EAAE,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QACxB,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,EAAE,CAAC;YAC/E,KAAK,CAAC,CAAC,MAAsB,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,MAAM,MAAY,CAAC;QACrB,CAAC;IACH,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { EOL } from \"node:os\";\nimport type { DocumentTypeDetails, DocumentModelDetails } from \"../index.js\";\nimport type { DocumentFieldSchema } from \"../generated/index.js\";\nimport type { DocumentField } from \"../models/index.js\";\nimport { defaultResultFields, getFeatures } from \"./defaultFields.js\";\nimport type { Field } from \"./utils.js\";\nimport { camelCase, capitalize, uncapitalize } from \"./utils.js\";\n\n// NOTE: currently, this command is set up to generate sample files for the SDK itself. If we want to expose this\n// functionality outside of samples, then we'll need to change the way the headers are generated for external use.\n\n/**\n * The header to append to the top of every file.\n */\nconst sampleHeader = `\n/**\n * @azsdk-util\n * @azsdk-skip-javascript\n */\n`;\n\n/**\n * Generate a header with the model information.\n */\nfunction templateHeader(model: DocumentModelDetails, test: boolean): string {\n  return `// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n${!test ? sampleHeader : \"\"}\n// Model:       ${model.modelId}\n// Description: ${model.description}\n// API Version: ${model.apiVersion}\n// Created:     ${new Date().toDateString()}\n\n`;\n}\n\n/**\n * Generate a TypeScript source file for a given model.\n *\n * @param model - the ModelInfo to generate code for\n * @returns a string of TypeScript source code\n */\nexport async function writeModelCode(model: DocumentModelDetails, test: boolean): Promise<string> {\n  let contents = templateHeader(model, test);\n\n  if (test) {\n    contents += 'import * as fr from \"../../../src\";' + EOL + EOL;\n  } else {\n    contents += 'import * as fr from \"@azure/ai-form-recognizer\";' + EOL + EOL;\n  }\n\n  const modelNameSlug = [\n    ...model.modelId\n      .split(\"-\", 2)\n      // for lack of a flatMap\n      .reduce((acc, cur) => [...acc, ...cur.split(\".\")], [] as string[]),\n  ];\n\n  const modelName = camelCase([...modelNameSlug, \"Model\"]);\n  const documentTypeName = camelCase([...modelNameSlug, \"Document\"]);\n  const resultName = camelCase([...modelNameSlug, \"Result\"]);\n\n  const modelFeatures = getFeatures(model);\n\n  const hasDocuments = modelFeatures.some((f) => f === \"_documents\");\n\n  if (model.description) {\n    contents += \"/**\" + EOL;\n    contents +=\n      model.description\n        // Split the comment into lines.\n        .split(/\\r?\\n/)\n        // Add the asterisk to the beginning of each line to block-align the comment\n        .map((l) => \" * \" + l)\n        .join(EOL) + EOL;\n    contents += \" */\" + EOL;\n  }\n\n  // Create the exported model object. We rely on a function named `modelInfo` to exist in the module scope, and we will\n  // add it later.\n  contents += `export const ${modelName} = fr.createModelFromSchema(modelInfo()) as fr.DocumentModel<${resultName}>;${\n    EOL + EOL\n  }`;\n\n  // Write the main Result interface.\n  for (const line of writeResultInterface(resultName, documentTypeName, modelFeatures)) {\n    contents += line + EOL;\n  }\n\n  contents += EOL;\n\n  // Now add a variant for each document type in the model, if there are any.\n  if (hasDocuments) {\n    const variants = extractModelVariants(model, modelNameSlug);\n\n    const variantNames = Object.keys(variants);\n\n    const documentType =\n      variantNames.length > 1\n        ? // In the case of multiple variants, a union\n          variantNames.map((n) => `${EOL}  | ${n}`).join(\"\")\n        : variantNames.length === 1\n          ? // For a single variant, just emit its name.\n            ` ${variantNames[0]}`\n          : // This should probably be unreachable, since there's no case where\n            // `hasDocuments && variantNames.length === 0`, but we'll still emit \"never\" just in case.\n            \" never\";\n\n    // Finally, add the type alias for the type of a Document\n    contents += `export type ${documentTypeName} =${documentType};${EOL + EOL}`;\n\n    // Write the root interface for the variant.\n    for (const info of Object.values(variants)) {\n      for (const line of writeDocTypeInterface(info)) {\n        contents += line + EOL;\n      }\n\n      contents += EOL;\n    }\n\n    // Write all the fields interfaces that the variant uses\n    for (const info of Object.values(variants)) {\n      for (const line of writeFieldsInterfaces(info)) {\n        contents += line + EOL;\n      }\n\n      contents += EOL;\n    }\n  }\n\n  // Finally, emit the modelInfo function that provides the raw schema.\n  contents += \"/**\" + EOL;\n  contents += \" * The raw model schema.\" + EOL;\n  contents += \" */\" + EOL;\n  contents += \"function modelInfo() {\" + EOL;\n  contents +=\n    `  return ${JSON.stringify(model, null, 2)\n      .split(/\\r?\\n/)\n      .join(EOL + \"  \")} as const;` + EOL;\n  contents += \"}\" + EOL;\n\n  return contents;\n}\n\n// Get the doc type variants of a model.\nfunction extractModelVariants(\n  model: DocumentModelDetails,\n  _rootSlug: string[],\n): Record<string, DocType> {\n  const result: ReturnType<typeof extractModelVariants> = {};\n\n  for (const [docType, info] of Object.entries(model.docTypes ?? {})) {\n    const slug = docType.split(\".\");\n    const docTypeName = camelCase(slug);\n    result[docTypeName] = {\n      ...info,\n      name: docTypeName,\n      originalDocType: docType,\n      slug,\n    };\n  }\n\n  return result;\n}\n\n// Write the interface for a given DocType.\nfunction* writeDocTypeInterface(docType: DocType): Iterable<string> {\n  if (docType.description) {\n    yield \"/**\";\n    yield* docType.description.split(/\\r?\\n/).map((l) => \" * \" + l);\n    yield \" */\";\n  }\n  yield `export interface ${docType.name} {`;\n  yield* indent(\n    writeField({\n      name: \"docType\",\n      type: `\"${docType.originalDocType}\"`,\n      docContents: `Document type: \"${docType.originalDocType}\".`,\n    }),\n  );\n\n  yield* indent(\n    writeField({\n      name: \"fields\",\n      type: docType.name + \"Fields\",\n      docContents: \"Document fields.\",\n    }),\n  );\n\n  yield* indent(\n    flatMap(\n      [\n        {\n          name: \"boundingRegions\",\n          docContents: \"Bounding regions covering the document.\",\n          type: \"fr.BoundingRegion[]\",\n          optional: true,\n        },\n        {\n          name: \"spans\",\n          docContents:\n            \"Locations of the document's elements in the `content` text (reading-order-concatenated content).\",\n          type: \"fr.DocumentSpan[]\",\n        },\n        {\n          name: \"confidence\",\n          docContents: \"The service's confidence that it has correctly extracted the document.\",\n          type: \"number\",\n        },\n      ],\n      writeField,\n    ),\n  );\n\n  yield \"}\";\n}\n\n/**\n * Write a field and its comment to an iterable of strings.\n */\nfunction* writeField(field: Field): Iterable<string> {\n  yield \"/**\";\n  yield* field.docContents.split(/\\r?\\n/).map((line) => ` * ${line}`);\n  yield \" */\";\n\n  // If the field name has an illegal character, we need to quote it.\n  const needsQuotes = !/^[a-zA-Z_$][a-zA-Z_$0-9]*$/.test(field.name);\n  const printedFieldName = needsQuotes ? `\"${field.name}\"` : field.name;\n\n  yield `${printedFieldName}${field.optional ? \"?\" : \"\"}: ${field.type};`;\n}\n\n/**\n * Recursively write the fields interfaces for a given document type.\n */\nfunction* writeFieldsInterfaces(docType: DocType): Iterable<string> {\n  const name = docType.name + \"Fields\";\n\n  yield* writeInterfaceDeclaration(name, docType.description, docType.fieldSchema);\n\n  // Recursively visit all child interfaces and write them.\n  yield* (function* collectNestedInterfaces(\n    fields: Record<string, DocumentFieldSchema>,\n    namingContext: string,\n  ): Iterable<string> {\n    for (const [fieldName, schema] of Object.entries(fields)) {\n      if (schema.type === \"array\" && schema.items?.type === \"object\") {\n        // Generate element interface and recur if the nested type is an object\n\n        const nextNamingContext = namingContext + fieldName + \"Element\";\n\n        yield \"\";\n        yield \"\";\n        yield* writeInterfaceDeclaration(\n          nextNamingContext,\n          schema.description,\n          schema.items?.properties ?? {},\n        );\n\n        yield* collectNestedInterfaces(schema.items?.properties ?? {}, nextNamingContext);\n      } else if (schema.type === \"object\") {\n        // Generate named interface and recur\n\n        yield \"\";\n        yield \"\";\n        yield* writeInterfaceDeclaration(\n          namingContext + fieldName,\n          schema.description,\n          schema.properties ?? {},\n        );\n\n        yield* collectNestedInterfaces(schema.properties ?? {}, namingContext + fieldName);\n      }\n    }\n  })(docType.fieldSchema, docType.name);\n\n  /**\n   * Write a simple interface declaration.\n   *\n   * @param interfaceName - the symbolic name of the interface\n   * @param description - the interface's documentation string.\n   * @param fields - the fields of the interface (a map of names to schemas)\n   */\n  function* writeInterfaceDeclaration(\n    interfaceName: string,\n    description: string | undefined,\n    fields: Record<string, DocumentFieldSchema>,\n  ): Generator<string, void, any> {\n    yield \"/**\";\n    yield ` * Describes the fields of \\`${interfaceName}\\`.`;\n    if (description) {\n      yield \" * \";\n      yield* description.split(/\\r?\\n/).map((l) => \" * \" + l);\n    }\n    yield \" */\";\n    const prefix = `export interface ${interfaceName} {`;\n    const suffix = \"}\";\n\n    const fieldEntries = Object.entries(fields);\n\n    if (fieldEntries.length === 0) {\n      yield prefix + suffix;\n    } else {\n      yield prefix;\n      yield* indent(\n        flatMap(\n          fieldEntries.map(([fieldName, schema]) => ({\n            // Uncapitalize the field name and remove all whitespace\n            name: uncapitalize(fieldName).replace(/\\s/g, \"\"),\n            type: writeType(schema, fieldName, docType.slug),\n            docContents: schema.description ?? `\\`${docType.name}\\` \"${fieldName}\" field`,\n            optional: true as const,\n          })),\n          writeField,\n        ),\n      );\n      yield suffix;\n    }\n  }\n}\n\n/**\n * Generate a type name for a field schema.\n *\n * @param schema - the schema of the type\n * @param name - the name to append to the field type, if necessary (only applies to objects and arrays)\n * @param slug - the current taxonomic naming context of the field name (used to name object types)\n * @returns a string representing the type name for the field\n */\nfunction writeType(schema: DocumentFieldSchema, name: string, slug: string[]): string {\n  const kind = schema.type as DocumentField[\"kind\"];\n\n  if (kind === \"array\") {\n    return `fr.DocumentArrayField<${writeType(schema.items!, \"Element\", [...slug, name])}>`;\n  } else if (kind === \"object\") {\n    const propertiesName = slug.map(capitalize).join(\"\") + name;\n    return `fr.DocumentObjectField<${propertiesName}>`;\n  } else {\n    return {\n      integer: \"fr.DocumentIntegerField\",\n      string: \"fr.DocumentStringField\",\n      countryRegion: \"fr.DocumentCountryRegionField\",\n      currency: \"fr.DocumentCurrencyField\",\n      time: \"fr.DocumentTimeField\",\n      date: \"fr.DocumentDateField\",\n      number: \"fr.DocumentNumberField\",\n      boolean: \"fr.DocumentBooleanField\",\n      phoneNumber: \"fr.DocumentPhoneNumberField\",\n      selectionMark: \"fr.DocumentSelectionMarkField\",\n      signature: \"fr.DocumentSignatureField\",\n      address: \"fr.DocumentAddressField\",\n    }[kind];\n  }\n}\n\n/**\n * Generate an AnalyzeResult-level interface.\n *\n * @param name - the name of the interface.\n * @param documentInterfaceName - the name of the interface's document type.\n * @param features - the features supported by the model\n */\nfunction* writeResultInterface(\n  name: string,\n  documentInterfaceName: string,\n  features: string[],\n): Iterable<string> {\n  const hasDocuments = features.some((f) => f === \"_documents\");\n\n  yield `export interface ${name} extends fr.AnalyzeResultCommon {`;\n  yield* indent(\n    flatMap(\n      features.filter((f) => f !== \"_documents\"),\n      (f) => writeField(defaultResultFields[f]),\n    ),\n  );\n  if (hasDocuments) {\n    yield* indent(\n      writeField({\n        name: \"documents\",\n        type: documentInterfaceName + \"[]\",\n        docContents: \"Extracted documents.\",\n      }),\n    );\n  }\n  yield \"}\";\n}\n\n/**\n * A helper function to indent an iterable.\n */\nfunction* indent(contents: Iterable<string>, level: number = 2): Iterable<string> {\n  const indentationString = \" \".repeat(level);\n\n  for (const line of contents) {\n    yield indentationString + line;\n  }\n}\n\n/**\n * A `flatMap` helper that works with generic iterables, not only arrays. If the result of `f` is iterable, its elements\n * will be produced instead of itself.\n *\n * @param it - the iterable to map over\n * @param f - the function to apply to each item in `it`\n */\nfunction* flatMap<T1, T2>(it: Iterable<T1>, f: (v: T1) => T2 | Iterable<T2>): Iterable<T2> {\n  for (const value of it) {\n    const result = f(value);\n    if (typeof result === \"object\" && result !== null && Symbol.iterator in result) {\n      yield* result as Iterable<T2>;\n    } else {\n      yield result as T2;\n    }\n  }\n}\n\n/**\n * Helper interface for representing a DocType during generation, allowing for renaming and contextual, taxonomic naming.\n */\ninterface DocType extends DocumentTypeDetails {\n  originalDocType: string;\n  name: string;\n  slug: string[];\n}\n"]}

package/dist/esm/constants.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Defines the known cloud audiences for Form Recognizer.
+ *
+ * To authenticate with Entra Id (using a `TokenCredential`) in a [Sovereign Cloud](https://learn.microsoft.com/entra/identity-platform/authentication-national-cloud)
+ * environment, provide the appropriate value below as the `audience` option when creating a
+ * `DocumentAnalysisClient` or `DocumentModelAdministrationClient`.
+ *
+ * The default value is suitable for Form Recognizer resources created in the Azure Public Cloud, so this value
+ * is only required to use Form Recognizer in a different cloud environment.
+ */
+export declare enum KnownFormRecognizerAudience {
+    /** Azure China */
+    AzureChina = "https://cognitiveservices.azure.cn",
+    /** Azure Government */
+    AzureGovernment = "https://cognitiveservices.azure.us",
+    /** Azure Public Cloud */
+    AzurePublicCloud = "https://cognitiveservices.azure.com"
+}
+/**
+ * The default Entra Id permissions scope for Cognitive Services.
+ * @internal
+ */
+export declare const DEFAULT_COGNITIVE_SCOPE = "https://cognitiveservices.azure.com/.default";
+/**
+ * @internal
+ */
+export declare const SDK_VERSION = "5.1.0";
+export declare const FORM_RECOGNIZER_API_VERSION = "2023-07-31";
+//# sourceMappingURL=constants.d.ts.map

package/dist/esm/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAGA;;;;;;;;;GASG;AACH,oBAAY,2BAA2B;IACrC,kBAAkB;IAClB,UAAU,uCAAuC;IACjD,uBAAuB;IACvB,eAAe,uCAAuC;IACtD,yBAAyB;IACzB,gBAAgB,wCAAwC;CACzD;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iDAA6D,CAAC;AAElG;;GAEG;AACH,eAAO,MAAM,WAAW,UAAU,CAAC;AAEnC,eAAO,MAAM,2BAA2B,eAAe,CAAC"}

package/dist/esm/constants.js

@@ -0,0 +1,32 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * Defines the known cloud audiences for Form Recognizer.
+ *
+ * To authenticate with Entra Id (using a `TokenCredential`) in a [Sovereign Cloud](https://learn.microsoft.com/entra/identity-platform/authentication-national-cloud)
+ * environment, provide the appropriate value below as the `audience` option when creating a
+ * `DocumentAnalysisClient` or `DocumentModelAdministrationClient`.
+ *
+ * The default value is suitable for Form Recognizer resources created in the Azure Public Cloud, so this value
+ * is only required to use Form Recognizer in a different cloud environment.
+ */
+export var KnownFormRecognizerAudience;
+(function (KnownFormRecognizerAudience) {
+    /** Azure China */
+    KnownFormRecognizerAudience["AzureChina"] = "https://cognitiveservices.azure.cn";
+    /** Azure Government */
+    KnownFormRecognizerAudience["AzureGovernment"] = "https://cognitiveservices.azure.us";
+    /** Azure Public Cloud */
+    KnownFormRecognizerAudience["AzurePublicCloud"] = "https://cognitiveservices.azure.com";
+})(KnownFormRecognizerAudience || (KnownFormRecognizerAudience = {}));
+/**
+ * The default Entra Id permissions scope for Cognitive Services.
+ * @internal
+ */
+export const DEFAULT_COGNITIVE_SCOPE = `${KnownFormRecognizerAudience.AzurePublicCloud}/.default`;
+/**
+ * @internal
+ */
+export const SDK_VERSION = "5.1.0";
+export const FORM_RECOGNIZER_API_VERSION = "2023-07-31";
+//# sourceMappingURL=constants.js.map

package/dist/esm/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;;;GASG;AACH,MAAM,CAAN,IAAY,2BAOX;AAPD,WAAY,2BAA2B;IACrC,kBAAkB;IAClB,gFAAiD,CAAA;IACjD,uBAAuB;IACvB,qFAAsD,CAAA;IACtD,yBAAyB;IACzB,uFAAwD,CAAA;AAC1D,CAAC,EAPW,2BAA2B,KAA3B,2BAA2B,QAOtC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,2BAA2B,CAAC,gBAAgB,WAAW,CAAC;AAElG;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC;AAEnC,MAAM,CAAC,MAAM,2BAA2B,GAAG,YAAY,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Defines the known cloud audiences for Form Recognizer.\n *\n * To authenticate with Entra Id (using a `TokenCredential`) in a [Sovereign Cloud](https://learn.microsoft.com/entra/identity-platform/authentication-national-cloud)\n * environment, provide the appropriate value below as the `audience` option when creating a\n * `DocumentAnalysisClient` or `DocumentModelAdministrationClient`.\n *\n * The default value is suitable for Form Recognizer resources created in the Azure Public Cloud, so this value\n * is only required to use Form Recognizer in a different cloud environment.\n */\nexport enum KnownFormRecognizerAudience {\n  /** Azure China */\n  AzureChina = \"https://cognitiveservices.azure.cn\",\n  /** Azure Government */\n  AzureGovernment = \"https://cognitiveservices.azure.us\",\n  /** Azure Public Cloud */\n  AzurePublicCloud = \"https://cognitiveservices.azure.com\",\n}\n\n/**\n * The default Entra Id permissions scope for Cognitive Services.\n * @internal\n */\nexport const DEFAULT_COGNITIVE_SCOPE = `${KnownFormRecognizerAudience.AzurePublicCloud}/.default`;\n\n/**\n * @internal\n */\nexport const SDK_VERSION = \"5.1.0\";\n\nexport const FORM_RECOGNIZER_API_VERSION = \"2023-07-31\";\n"]}