@azure/ai-form-recognizer 5.0.0 → 5.1.0

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

@@ -1,12 +1,12 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+// Licensed under the MIT License.
 import { isTokenCredential } from "@azure/core-auth";
 import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
-import { createFormRecognizerAzureKeyCredentialPolicy } from "./azureKeyCredentialPolicy";
-import { DEFAULT_COGNITIVE_SCOPE, FORM_RECOGNIZER_API_VERSION } from "./constants";
-import { GeneratedClient } from "./generated";
-import { DEFAULT_GENERATED_CLIENT_OPTIONS } from "./options/FormRecognizerClientOptions";
-import * as Mappers from "./generated/models/mappers";
+import { createFormRecognizerAzureKeyCredentialPolicy } from "./azureKeyCredentialPolicy.js";
+import { DEFAULT_COGNITIVE_SCOPE, FORM_RECOGNIZER_API_VERSION } from "./constants.js";
+import { GeneratedClient } from "./generated/index.js";
+import { DEFAULT_GENERATED_CLIENT_OPTIONS, } from "./options/FormRecognizerClientOptions.js";
+import * as Mappers from "./generated/models/mappers.js";
 import { createSerializer } from "@azure/core-client";
 export { Mappers };
 // This is used for URL request processing.
@@ -38,11 +38,16 @@ export const maybemap = (value, f) => value === undefined ? undefined : f(value)
  * @internal
  */
 export function makeServiceClient(endpoint, credential, options) {
+    var _a;
     const client = new GeneratedClient(endpoint === null || endpoint === void 0 ? void 0 : endpoint.replace(/\/$/, ""), Object.assign(Object.assign(Object.assign({}, DEFAULT_GENERATED_CLIENT_OPTIONS), options), { apiVersion: FORM_RECOGNIZER_API_VERSION }));
     const authPolicy = isTokenCredential(credential)
         ? bearerTokenAuthenticationPolicy({
             credential,
-            scopes: DEFAULT_COGNITIVE_SCOPE,
+            scopes: [(_a = options.audience) !== null && _a !== void 0 ? _a : DEFAULT_COGNITIVE_SCOPE].map((scope) => {
+                if (scope.endsWith("/.default"))
+                    return scope;
+                return `${scope}/.default`;
+            }),
         })
         : createFormRecognizerAzureKeyCredentialPolicy(credential);
     client.pipeline.addPolicy(authPolicy);

package/dist/browser/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/util.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,+BAA+B,EAAE,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,4CAA4C,EAAE,MAAM,+BAA+B,CAAC;AAC7F,OAAO,EAAE,uBAAuB,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC;AAEtF,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EACL,gCAAgC,GAEjC,MAAM,0CAA0C,CAAC;AAElD,OAAO,KAAK,OAAO,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,CAAC;AAEnB,2CAA2C;AAC3C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAA4B,CAAS,EAAmB,EAAE,CACpF,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAoB,CAAC;AAExE;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAA4B,CAAI,EAAiB,EAAE,CAC3E,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAkB,CAAC;AAEtE;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAS,EAAW,EAAE;IAChD,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAS,KAAqB,EAAE,CAAgB,EAAkB,EAAE,CAC1F,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAE7C;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,QAAgB,EAChB,UAA2C,EAC3C,OAAwF;;IAExF,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,gDAC1D,gCAAgC,GAChC,OAAO,KACV,UAAU,EAAE,2BAA2B,IACvC,CAAC;IAEH,MAAM,UAAU,GAAG,iBAAiB,CAAC,UAAU,CAAC;QAC9C,CAAC,CAAC,+BAA+B,CAAC;YAC9B,UAAU;YACV,MAAM,EAAE,CAAC,MAAA,OAAO,CAAC,QAAQ,mCAAI,uBAAuB,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBAClE,IAAI,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC;oBAAE,OAAO,KAAK,CAAC;gBAC9C,OAAO,GAAG,KAAK,WAAW,CAAC;YAC7B,CAAC,CAAC;SACH,CAAC;QACJ,CAAC,CAAC,4CAA4C,CAAC,UAAU,CAAC,CAAC;IAE7D,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAEtC,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { KeyCredential, TokenCredential } from \"@azure/core-auth\";\nimport { isTokenCredential } from \"@azure/core-auth\";\nimport { bearerTokenAuthenticationPolicy } from \"@azure/core-rest-pipeline\";\nimport { createFormRecognizerAzureKeyCredentialPolicy } from \"./azureKeyCredentialPolicy.js\";\nimport { DEFAULT_COGNITIVE_SCOPE, FORM_RECOGNIZER_API_VERSION } from \"./constants.js\";\nimport type { GeneratedClientOptionalParams } from \"./generated/index.js\";\nimport { GeneratedClient } from \"./generated/index.js\";\nimport {\n  DEFAULT_GENERATED_CLIENT_OPTIONS,\n  type DocumentAnalysisClientOptions,\n} from \"./options/FormRecognizerClientOptions.js\";\n\nimport * as Mappers from \"./generated/models/mappers.js\";\nimport { createSerializer } from \"@azure/core-client\";\nexport { Mappers };\n\n// This is used for URL request processing.\nexport const SERIALIZER = createSerializer(Mappers, false);\n\n/**\n * Type-strong uncapitalization.\n * @internal\n */\nexport const uncapitalize = <S extends string = string>(s: string): Uncapitalize<S> =>\n  (s.substring(0, 1).toLowerCase() + s.substring(1)) as Uncapitalize<S>;\n\n/**\n * Type-strong capitalization\n * @internal\n */\nexport const capitalize = <S extends string = string>(s: S): Capitalize<S> =>\n  (s.substring(0, 1).toUpperCase() + s.substring(1)) as Capitalize<S>;\n\n/**\n * Tests if a string looks like it begins with an acronym, i.e. it starts with two capital letters.\n * @internal\n */\nexport const isAcronymic = (s: string): boolean => {\n  return /^[A-Z][A-Z]/.test(s);\n};\n\n/**\n * Map an optional value through a function\n * @internal\n */\nexport const maybemap = <T1, T2>(value: T1 | undefined, f: (v: T1) => T2): T2 | undefined =>\n  value === undefined ? undefined : f(value);\n\n/**\n * Create a GeneratedClient.\n * @internal\n */\nexport function makeServiceClient(\n  endpoint: string,\n  credential: KeyCredential | TokenCredential,\n  options: GeneratedClientOptionalParams & Pick<DocumentAnalysisClientOptions, \"audience\">,\n): GeneratedClient {\n  const client = new GeneratedClient(endpoint?.replace(/\\/$/, \"\"), {\n    ...DEFAULT_GENERATED_CLIENT_OPTIONS,\n    ...options,\n    apiVersion: FORM_RECOGNIZER_API_VERSION,\n  });\n\n  const authPolicy = isTokenCredential(credential)\n    ? bearerTokenAuthenticationPolicy({\n        credential,\n        scopes: [options.audience ?? DEFAULT_COGNITIVE_SCOPE].map((scope) => {\n          if (scope.endsWith(\"/.default\")) return scope;\n          return `${scope}/.default`;\n        }),\n      })\n    : createFormRecognizerAzureKeyCredentialPolicy(credential);\n\n  client.pipeline.addPolicy(authPolicy);\n\n  return client;\n}\n"]}

package/dist/commonjs/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/commonjs/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/commonjs/azureKeyCredentialPolicy.js

@@ -0,0 +1,20 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFormRecognizerAzureKeyCredentialPolicy = createFormRecognizerAzureKeyCredentialPolicy;
+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
+ * @internal
+ */
+function createFormRecognizerAzureKeyCredentialPolicy(credential) {
+    return {
+        name: "cognitiveServicesApimSubscriptionKeyCredentialPolicy",
+        sendRequest(request, next) {
+            request.headers.set(APIM_SUBSCRIPTION_KEY_HEADER, credential.key);
+            return next(request);
+        },
+    };
+}
+//# sourceMappingURL=azureKeyCredentialPolicy.js.map

package/dist/commonjs/azureKeyCredentialPolicy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"azureKeyCredentialPolicy.js","sourceRoot":"","sources":["../../src/azureKeyCredentialPolicy.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAWlC,oGAUC;AAhBD,MAAM,4BAA4B,GAAG,2BAA2B,CAAC;AAEjE;;;GAGG;AACH,SAAgB,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/commonjs/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/commonjs/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/commonjs/bin/defaultFields.js

@@ -0,0 +1,87 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultResultFields = void 0;
+exports.getFeatures = getFeatures;
+/**
+ * @internal
+ * Field information for the top level fields of `AnalyzeResult`.
+ */
+exports.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
+ */
+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/commonjs/bin/defaultFields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultFields.js","sourceRoot":"","sources":["../../../src/bin/defaultFields.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAyElC,kCAiBC;AArFD;;;GAGG;AACU,QAAA,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,SAAgB,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/commonjs/bin/gen-model.d.ts

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

package/dist/commonjs/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/commonjs/bin/gen-model.js

@@ -0,0 +1,103 @@
+#!/bin/env node
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+// This file is ignored by the linter because it is impossible to move the copyright header above the shebang line.
+const identity_1 = require("@azure/identity");
+const promises_1 = require("node:fs/promises");
+const documentModelAdministrationClient_js_1 = require("../documentModelAdministrationClient.js");
+const writeModelCode_js_1 = require("./writeModelCode.js");
+const prettier_1 = require("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_js_1.DocumentModelAdministrationClient(endpoint, new identity_1.DefaultAzureCredential());
+    const modelInfo = await client.getDocumentModel(modelId);
+    console.error("Generating model code for:", modelInfo.modelId);
+    const file = await (0, writeModelCode_js_1.writeModelCode)(modelInfo, test);
+    const data = Buffer.from(await (0, prettier_1.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 (0, promises_1.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/commonjs/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,8CAAyD;AACzD,+CAA6C;AAC7C,kGAA4F;AAC5F,2DAAqD;AACrD,uCAAkC;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,wEAAiC,CAAC,QAAQ,EAAE,IAAI,iCAAsB,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,IAAA,kCAAc,EAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAEnD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,IAAA,iBAAM,EAAC,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,IAAA,oBAAS,EAAC,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/commonjs/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/commonjs/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/commonjs/bin/utils.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/bin/utils.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAKlC,8BAEC;AAKD,gCAEC;AAKD,oCAEC;AAnBD;;GAEG;AACH,SAAgB,SAAS,CAAC,IAAc;IACtC,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACvC,CAAC;AAED;;GAEG;AACH,SAAgB,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,SAAgB,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/commonjs/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/commonjs/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"}