@azure/ai-form-recognizer 5.0.0-alpha.20250507.1 → 5.1.0-alpha.20250512.2

package/README.md

@@ -140,6 +140,26 @@ const client = new DocumentAnalysisClient(
 );
 ```
 
+#### Sovereign Clouds
+
+Connect to alternative Azure cloud environments (such as Azure China or Azure Government) by specifying the `audience` option when creating your client. Use the `KnownFormRecognizerAudience` enum to select the correct value for your environment.
+
+```ts
+import { DefaultAzureCredential } from "@azure/identity";
+import { DocumentAnalysisClient, KnownFormRecognizerAudience } from "@azure/ai-form-recognizer";
+
+const credential = new DefaultAzureCredential();
+const client = new DocumentAnalysisClient(
+  "https://<resource name>.cognitiveservices.azure.com", // endpoint
+  credential,
+  {
+    audience: KnownFormRecognizerAudience.AzureGovernment,
+  }
+);
+```
+
+If you do not specify the `audience` option, the default is suitable for the Azure Public Cloud (`https://cognitiveservices.azure.com`).
+
 ## Key concepts
 
 ### `DocumentAnalysisClient`

package/dist/browser/constants.d.ts

@@ -1,11 +1,29 @@
 /**
- * The default AAD permissions scope for Cognitive Services.
+ * 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.0.0";
+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/browser/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iDAAiD,CAAC;AAEtF;;GAEG;AACH,eAAO,MAAM,WAAW,UAAU,CAAC;AAEnC,eAAO,MAAM,2BAA2B,eAAe,CAAC"}
+{"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/browser/constants.js

@@ -1,13 +1,32 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 /**
- * The default AAD permissions scope for Cognitive Services.
+ * 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 = "https://cognitiveservices.azure.com/.default";
+export const DEFAULT_COGNITIVE_SCOPE = `${KnownFormRecognizerAudience.AzurePublicCloud}/.default`;
 /**
  * @internal
  */
-export const SDK_VERSION = "5.0.0";
+export const SDK_VERSION = "5.1.0";
 export const FORM_RECOGNIZER_API_VERSION = "2023-07-31";
 //# sourceMappingURL=constants.js.map

package/dist/browser/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,8CAA8C,CAAC;AAEtF;;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 * The default AAD permissions scope for Cognitive Services.\n * @internal\n */\nexport const DEFAULT_COGNITIVE_SCOPE = \"https://cognitiveservices.azure.com/.default\";\n\n/**\n * @internal\n */\nexport const SDK_VERSION = \"5.0.0\";\n\nexport const FORM_RECOGNIZER_API_VERSION = \"2023-07-31\";\n"]}
+{"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"]}

package/dist/browser/generated/generatedClient.js

@@ -27,7 +27,7 @@ export class GeneratedClient extends coreClient.ServiceClient {
         const defaults = {
             requestContentType: "application/json; charset=utf-8"
         };
-        const packageDetails = `azsdk-js-ai-form-recognizer/5.0.0`;
+        const packageDetails = `azsdk-js-ai-form-recognizer/5.1.0`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;

package/dist/browser/generated/generatedClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"generatedClient.js","sourceRoot":"","sources":["../../../src/generated/generatedClient.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,gBAAgB,MAAM,2BAA2B,CAAC;AAM9D,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,uBAAuB,CAAC;AAQ/B,MAAM,OAAO,eAAgB,SAAQ,UAAU,CAAC,aAAa;IAK3D;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,OAAuC;;QACnE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;QAED,0CAA0C;QAC1C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QACD,MAAM,QAAQ,GAAkC;YAC9C,kBAAkB,EAAE,iCAAiC;SACtD,CAAC;QAEF,MAAM,cAAc,GAAG,mCAAmC,CAAC;QAC3D,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;YAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,cAAc,EAAE;YACjE,CAAC,CAAC,GAAG,cAAc,EAAE,CAAC;QAE1B,MAAM,mBAAmB,iDACpB,QAAQ,GACR,OAAO,KACV,gBAAgB,EAAE;gBAChB,eAAe;aAChB,EACD,OAAO,EACL,MAAA,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,OAAO,mCAAI,2BAA2B,GACrE,CAAC;QACF,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAE3B,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,KAAI,OAAO,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1E,MAAM,gBAAgB,GAAsC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;YAClG,MAAM,oCAAoC,GAAG,gBAAgB,CAAC,IAAI,CAChE,CAAC,cAAc,EAAE,EAAE,CACjB,cAAc,CAAC,IAAI;gBACnB,gBAAgB,CAAC,mCAAmC,CACvD,CAAC;YACF,IAAI,CAAC,oCAAoC,EAAE,CAAC;gBAC1C,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;oBACzB,IAAI,EAAE,gBAAgB,CAAC,mCAAmC;iBAC3D,CAAC,CAAC;gBACH,IAAI,CAAC,QAAQ,CAAC,SAAS,CACrB,gBAAgB,CAAC,+BAA+B,CAAC;oBAC/C,MAAM,EAAE,GAAG,mBAAmB,CAAC,OAAO,WAAW;oBACjD,kBAAkB,EAAE;wBAClB,2BAA2B,EACzB,UAAU,CAAC,gCAAgC;qBAC9C;iBACF,CAAC,CACH,CAAC;YACJ,CAAC;QACH,CAAC;QACD,wBAAwB;QACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,0CAA0C;QAC1C,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,YAAY,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,aAAa,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC;IAED,8GAA8G;IACtG,yBAAyB,CAAC,UAAmB;QACnD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,MAAM,gBAAgB,GAAG;YACvB,IAAI,EAAE,wBAAwB;YAC9B,KAAK,CAAC,WAAW,CACf,OAAwB,EACxB,IAAiB;gBAEjB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACrC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACrB,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;wBACjD,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;4BACrC,OAAO,cAAc,GAAG,UAAU,CAAC;wBACrC,CAAC;6BAAM,CAAC;4BACN,OAAO,IAAI,CAAC;wBACd,CAAC;oBACH,CAAC,CAAC,CAAC;oBACH,OAAO,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACrD,CAAC;gBACD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;SACF,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC5C,CAAC;CAKF","sourcesContent":["/*\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * Code generated by Microsoft (R) AutoRest Code Generator.\n * Changes may cause incorrect behavior and will be lost if the code is regenerated.\n */\n\nimport * as coreClient from \"@azure/core-client\";\nimport * as coreRestPipeline from \"@azure/core-rest-pipeline\";\nimport {\n  PipelineRequest,\n  PipelineResponse,\n  SendRequest\n} from \"@azure/core-rest-pipeline\";\nimport {\n  DocumentModelsImpl,\n  MiscellaneousImpl,\n  DocumentClassifiersImpl\n} from \"./operations/index.js\";\nimport {\n  DocumentModels,\n  Miscellaneous,\n  DocumentClassifiers\n} from \"./operationsInterfaces/index.js\";\nimport { StringIndexType, GeneratedClientOptionalParams } from \"./models/index.js\";\n\nexport class GeneratedClient extends coreClient.ServiceClient {\n  endpoint: string;\n  stringIndexType?: StringIndexType;\n  apiVersion: string;\n\n  /**\n   * Initializes a new instance of the GeneratedClient class.\n   * @param endpoint Supported Cognitive Services endpoints (protocol and hostname, for\n   *                 example: https://westus2.api.cognitive.microsoft.com).\n   * @param options The parameter options\n   */\n  constructor(endpoint: string, options?: GeneratedClientOptionalParams) {\n    if (endpoint === undefined) {\n      throw new Error(\"'endpoint' cannot be null\");\n    }\n\n    // Initializing default values for options\n    if (!options) {\n      options = {};\n    }\n    const defaults: GeneratedClientOptionalParams = {\n      requestContentType: \"application/json; charset=utf-8\"\n    };\n\n    const packageDetails = `azsdk-js-ai-form-recognizer/5.0.0`;\n    const userAgentPrefix =\n      options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`\n        : `${packageDetails}`;\n\n    const optionsWithDefaults = {\n      ...defaults,\n      ...options,\n      userAgentOptions: {\n        userAgentPrefix\n      },\n      baseUri:\n        options.endpoint ?? options.baseUri ?? \"{endpoint}/formrecognizer\"\n    };\n    super(optionsWithDefaults);\n\n    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {\n      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();\n      const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(\n        (pipelinePolicy) =>\n          pipelinePolicy.name ===\n          coreRestPipeline.bearerTokenAuthenticationPolicyName\n      );\n      if (!bearerTokenAuthenticationPolicyFound) {\n        this.pipeline.removePolicy({\n          name: coreRestPipeline.bearerTokenAuthenticationPolicyName\n        });\n        this.pipeline.addPolicy(\n          coreRestPipeline.bearerTokenAuthenticationPolicy({\n            scopes: `${optionsWithDefaults.baseUri}/.default`,\n            challengeCallbacks: {\n              authorizeRequestOnChallenge:\n                coreClient.authorizeRequestOnClaimChallenge\n            }\n          })\n        );\n      }\n    }\n    // Parameter assignments\n    this.endpoint = endpoint;\n\n    // Assigning values to Constant parameters\n    this.apiVersion = options.apiVersion || \"2023-07-31\";\n    this.documentModels = new DocumentModelsImpl(this);\n    this.miscellaneous = new MiscellaneousImpl(this);\n    this.documentClassifiers = new DocumentClassifiersImpl(this);\n    this.addCustomApiVersionPolicy(options.apiVersion);\n  }\n\n  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */\n  private addCustomApiVersionPolicy(apiVersion?: string) {\n    if (!apiVersion) {\n      return;\n    }\n    const apiVersionPolicy = {\n      name: \"CustomApiVersionPolicy\",\n      async sendRequest(\n        request: PipelineRequest,\n        next: SendRequest\n      ): Promise<PipelineResponse> {\n        const param = request.url.split(\"?\");\n        if (param.length > 1) {\n          const newParams = param[1].split(\"&\").map((item) => {\n            if (item.indexOf(\"api-version\") > -1) {\n              return \"api-version=\" + apiVersion;\n            } else {\n              return item;\n            }\n          });\n          request.url = param[0] + \"?\" + newParams.join(\"&\");\n        }\n        return next(request);\n      }\n    };\n    this.pipeline.addPolicy(apiVersionPolicy);\n  }\n\n  documentModels: DocumentModels;\n  miscellaneous: Miscellaneous;\n  documentClassifiers: DocumentClassifiers;\n}\n"]}
+{"version":3,"file":"generatedClient.js","sourceRoot":"","sources":["../../../src/generated/generatedClient.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,gBAAgB,MAAM,2BAA2B,CAAC;AAM9D,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,uBAAuB,CAAC;AAQ/B,MAAM,OAAO,eAAgB,SAAQ,UAAU,CAAC,aAAa;IAK3D;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,OAAuC;;QACnE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;QAED,0CAA0C;QAC1C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QACD,MAAM,QAAQ,GAAkC;YAC9C,kBAAkB,EAAE,iCAAiC;SACtD,CAAC;QAEF,MAAM,cAAc,GAAG,mCAAmC,CAAC;QAC3D,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;YAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,cAAc,EAAE;YACjE,CAAC,CAAC,GAAG,cAAc,EAAE,CAAC;QAE1B,MAAM,mBAAmB,iDACpB,QAAQ,GACR,OAAO,KACV,gBAAgB,EAAE;gBAChB,eAAe;aAChB,EACD,OAAO,EACL,MAAA,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,OAAO,mCAAI,2BAA2B,GACrE,CAAC;QACF,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAE3B,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,KAAI,OAAO,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1E,MAAM,gBAAgB,GAAsC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;YAClG,MAAM,oCAAoC,GAAG,gBAAgB,CAAC,IAAI,CAChE,CAAC,cAAc,EAAE,EAAE,CACjB,cAAc,CAAC,IAAI;gBACnB,gBAAgB,CAAC,mCAAmC,CACvD,CAAC;YACF,IAAI,CAAC,oCAAoC,EAAE,CAAC;gBAC1C,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;oBACzB,IAAI,EAAE,gBAAgB,CAAC,mCAAmC;iBAC3D,CAAC,CAAC;gBACH,IAAI,CAAC,QAAQ,CAAC,SAAS,CACrB,gBAAgB,CAAC,+BAA+B,CAAC;oBAC/C,MAAM,EAAE,GAAG,mBAAmB,CAAC,OAAO,WAAW;oBACjD,kBAAkB,EAAE;wBAClB,2BAA2B,EACzB,UAAU,CAAC,gCAAgC;qBAC9C;iBACF,CAAC,CACH,CAAC;YACJ,CAAC;QACH,CAAC;QACD,wBAAwB;QACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,0CAA0C;QAC1C,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,YAAY,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,aAAa,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC;IAED,8GAA8G;IACtG,yBAAyB,CAAC,UAAmB;QACnD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,MAAM,gBAAgB,GAAG;YACvB,IAAI,EAAE,wBAAwB;YAC9B,KAAK,CAAC,WAAW,CACf,OAAwB,EACxB,IAAiB;gBAEjB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACrC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACrB,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;wBACjD,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;4BACrC,OAAO,cAAc,GAAG,UAAU,CAAC;wBACrC,CAAC;6BAAM,CAAC;4BACN,OAAO,IAAI,CAAC;wBACd,CAAC;oBACH,CAAC,CAAC,CAAC;oBACH,OAAO,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACrD,CAAC;gBACD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;SACF,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC5C,CAAC;CAKF","sourcesContent":["/*\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * Code generated by Microsoft (R) AutoRest Code Generator.\n * Changes may cause incorrect behavior and will be lost if the code is regenerated.\n */\n\nimport * as coreClient from \"@azure/core-client\";\nimport * as coreRestPipeline from \"@azure/core-rest-pipeline\";\nimport {\n  PipelineRequest,\n  PipelineResponse,\n  SendRequest\n} from \"@azure/core-rest-pipeline\";\nimport {\n  DocumentModelsImpl,\n  MiscellaneousImpl,\n  DocumentClassifiersImpl\n} from \"./operations/index.js\";\nimport {\n  DocumentModels,\n  Miscellaneous,\n  DocumentClassifiers\n} from \"./operationsInterfaces/index.js\";\nimport { StringIndexType, GeneratedClientOptionalParams } from \"./models/index.js\";\n\nexport class GeneratedClient extends coreClient.ServiceClient {\n  endpoint: string;\n  stringIndexType?: StringIndexType;\n  apiVersion: string;\n\n  /**\n   * Initializes a new instance of the GeneratedClient class.\n   * @param endpoint Supported Cognitive Services endpoints (protocol and hostname, for\n   *                 example: https://westus2.api.cognitive.microsoft.com).\n   * @param options The parameter options\n   */\n  constructor(endpoint: string, options?: GeneratedClientOptionalParams) {\n    if (endpoint === undefined) {\n      throw new Error(\"'endpoint' cannot be null\");\n    }\n\n    // Initializing default values for options\n    if (!options) {\n      options = {};\n    }\n    const defaults: GeneratedClientOptionalParams = {\n      requestContentType: \"application/json; charset=utf-8\"\n    };\n\n    const packageDetails = `azsdk-js-ai-form-recognizer/5.1.0`;\n    const userAgentPrefix =\n      options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`\n        : `${packageDetails}`;\n\n    const optionsWithDefaults = {\n      ...defaults,\n      ...options,\n      userAgentOptions: {\n        userAgentPrefix\n      },\n      baseUri:\n        options.endpoint ?? options.baseUri ?? \"{endpoint}/formrecognizer\"\n    };\n    super(optionsWithDefaults);\n\n    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {\n      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();\n      const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(\n        (pipelinePolicy) =>\n          pipelinePolicy.name ===\n          coreRestPipeline.bearerTokenAuthenticationPolicyName\n      );\n      if (!bearerTokenAuthenticationPolicyFound) {\n        this.pipeline.removePolicy({\n          name: coreRestPipeline.bearerTokenAuthenticationPolicyName\n        });\n        this.pipeline.addPolicy(\n          coreRestPipeline.bearerTokenAuthenticationPolicy({\n            scopes: `${optionsWithDefaults.baseUri}/.default`,\n            challengeCallbacks: {\n              authorizeRequestOnChallenge:\n                coreClient.authorizeRequestOnClaimChallenge\n            }\n          })\n        );\n      }\n    }\n    // Parameter assignments\n    this.endpoint = endpoint;\n\n    // Assigning values to Constant parameters\n    this.apiVersion = options.apiVersion || \"2023-07-31\";\n    this.documentModels = new DocumentModelsImpl(this);\n    this.miscellaneous = new MiscellaneousImpl(this);\n    this.documentClassifiers = new DocumentClassifiersImpl(this);\n    this.addCustomApiVersionPolicy(options.apiVersion);\n  }\n\n  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */\n  private addCustomApiVersionPolicy(apiVersion?: string) {\n    if (!apiVersion) {\n      return;\n    }\n    const apiVersionPolicy = {\n      name: \"CustomApiVersionPolicy\",\n      async sendRequest(\n        request: PipelineRequest,\n        next: SendRequest\n      ): Promise<PipelineResponse> {\n        const param = request.url.split(\"?\");\n        if (param.length > 1) {\n          const newParams = param[1].split(\"&\").map((item) => {\n            if (item.indexOf(\"api-version\") > -1) {\n              return \"api-version=\" + apiVersion;\n            } else {\n              return item;\n            }\n          });\n          request.url = param[0] + \"?\" + newParams.join(\"&\");\n        }\n        return next(request);\n      }\n    };\n    this.pipeline.addPolicy(apiVersionPolicy);\n  }\n\n  documentModels: DocumentModels;\n  miscellaneous: Miscellaneous;\n  documentClassifiers: DocumentClassifiers;\n}\n"]}

package/dist/browser/index.d.ts

@@ -14,4 +14,5 @@ export * from "./models/index.js";
 export * from "./options/index.js";
 export * from "./documentModel.js";
 export { Point2D } from "./transforms/polygon.js";
+export { KnownFormRecognizerAudience } from "./constants.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAC3F,OAAO,EAEL,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACrB,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,UAAU,EACV,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,eAAe,EACf,2BAA2B,EAC3B,4BAA4B,EAC5B,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,kCAAkC,EAClC,oCAAoC,EACpC,mCAAmC,EACnC,uCAAuC,EACvC,yBAAyB,EACzB,6BAA6B,EAC7B,mBAAmB,EACnB,mBAAmB,EACnB,YAAY,EAEZ,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,cAAc,EACd,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,kCAAkC,EAClC,gBAAgB,EAChB,yBAAyB,GAC1B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACxB,2BAA2B,EAC3B,gCAAgC,EAChC,uCAAuC,GACxC,MAAM,yBAAyB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAC3F,OAAO,EAEL,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACrB,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,UAAU,EACV,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,eAAe,EACf,2BAA2B,EAC3B,4BAA4B,EAC5B,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,kCAAkC,EAClC,oCAAoC,EACpC,mCAAmC,EACnC,uCAAuC,EACvC,yBAAyB,EACzB,6BAA6B,EAC7B,mBAAmB,EACnB,mBAAmB,EACnB,YAAY,EAEZ,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,cAAc,EACd,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,kCAAkC,EAClC,gBAAgB,EAChB,yBAAyB,GAC1B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACxB,2BAA2B,EAC3B,gCAAgC,EAChC,uCAAuC,GACxC,MAAM,yBAAyB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/browser/index.js

@@ -15,4 +15,5 @@ KnownDocumentBuildMode, KnownDocumentFieldType, KnownDocumentBarcodeKind, KnownD
 export * from "./models/index.js";
 export * from "./options/index.js";
 export * from "./documentModel.js";
+export { KnownFormRecognizerAudience } from "./constants.js";
 //# sourceMappingURL=index.js.map

package/dist/browser/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;GAKG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAC3F,OAAO;AAwCL,iBAAiB;AACjB,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,cAAc,EACd,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,sBAAsB,CAAC;AAgB9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Azure Cognitive Services [Form Recognizer](https://azure.microsoft.com/services/cognitive-services/form-recognizer/)\n * uses cloud-based machine learning to extract structured data from form documents.\n *\n * @packageDocumentation\n */\n\nexport { AzureKeyCredential } from \"@azure/core-auth\";\nexport { DocumentAnalysisClient } from \"./documentAnalysisClient.js\";\nexport { DocumentModelAdministrationClient } from \"./documentModelAdministrationClient.js\";\nexport {\n  // Generated types used verbatim\n  AddressValue,\n  CopyAuthorization,\n  CurrencyValue,\n  DocumentTypeDetails,\n  DocumentBuildMode,\n  DocumentFieldSchema,\n  DocumentFieldType,\n  DocumentSignatureType,\n  DocumentSpan,\n  DocumentLanguage,\n  DocumentStyle,\n  FontStyle,\n  FontWeight,\n  DocumentTableCellKind,\n  LengthUnit,\n  DocumentModelDetails,\n  DocumentModelSummary,\n  OperationSummary,\n  OperationKind,\n  OperationStatus,\n  ResourceDetails,\n  CustomDocumentModelsDetails,\n  AnalyzeResultOperationStatus,\n  SelectionMarkState,\n  ParagraphRole,\n  OperationDetails,\n  ErrorModel,\n  InnerError,\n  OperationDetailsUnion,\n  DocumentModelBuildOperationDetails,\n  DocumentModelComposeOperationDetails,\n  DocumentModelCopyToOperationDetails,\n  DocumentClassifierBuildOperationDetails,\n  DocumentClassifierDetails,\n  ClassifierDocumentTypeDetails,\n  DocumentBarcodeKind,\n  DocumentFormulaKind,\n  QuotaDetails,\n  // KnownXYZ enums\n  KnownDocumentBuildMode,\n  KnownDocumentFieldType,\n  KnownDocumentBarcodeKind,\n  KnownDocumentFormulaKind,\n  KnownDocumentSignatureType,\n  KnownDocumentTableCellKind,\n  KnownFontStyle,\n  KnownFontWeight,\n  KnownLengthUnit,\n  KnownOperationKind,\n  KnownParagraphRole,\n  KnownSelectionMarkState,\n} from \"./generated/index.js\";\nexport {\n  AnalysisPoller,\n  AnalyzeResult,\n  AnalyzeResultCommon,\n  DocumentAnalysisPollOperationState,\n  AnalyzedDocument,\n  FormRecognizerRequestBody,\n} from \"./lro/analysis.js\";\nexport {\n  DocumentModelPoller,\n  DocumentClassifierPoller,\n  DocumentModelOperationState,\n  DocumentClassifierOperationState,\n  ModelAdministrationOperationStateCommon,\n} from \"./lro/administration.js\";\nexport * from \"./models/index.js\";\nexport * from \"./options/index.js\";\nexport * from \"./documentModel.js\";\nexport { Point2D } from \"./transforms/polygon.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;GAKG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAC3F,OAAO;AAwCL,iBAAiB;AACjB,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,cAAc,EACd,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,sBAAsB,CAAC;AAgB9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Azure Cognitive Services [Form Recognizer](https://azure.microsoft.com/services/cognitive-services/form-recognizer/)\n * uses cloud-based machine learning to extract structured data from form documents.\n *\n * @packageDocumentation\n */\n\nexport { AzureKeyCredential } from \"@azure/core-auth\";\nexport { DocumentAnalysisClient } from \"./documentAnalysisClient.js\";\nexport { DocumentModelAdministrationClient } from \"./documentModelAdministrationClient.js\";\nexport {\n  // Generated types used verbatim\n  AddressValue,\n  CopyAuthorization,\n  CurrencyValue,\n  DocumentTypeDetails,\n  DocumentBuildMode,\n  DocumentFieldSchema,\n  DocumentFieldType,\n  DocumentSignatureType,\n  DocumentSpan,\n  DocumentLanguage,\n  DocumentStyle,\n  FontStyle,\n  FontWeight,\n  DocumentTableCellKind,\n  LengthUnit,\n  DocumentModelDetails,\n  DocumentModelSummary,\n  OperationSummary,\n  OperationKind,\n  OperationStatus,\n  ResourceDetails,\n  CustomDocumentModelsDetails,\n  AnalyzeResultOperationStatus,\n  SelectionMarkState,\n  ParagraphRole,\n  OperationDetails,\n  ErrorModel,\n  InnerError,\n  OperationDetailsUnion,\n  DocumentModelBuildOperationDetails,\n  DocumentModelComposeOperationDetails,\n  DocumentModelCopyToOperationDetails,\n  DocumentClassifierBuildOperationDetails,\n  DocumentClassifierDetails,\n  ClassifierDocumentTypeDetails,\n  DocumentBarcodeKind,\n  DocumentFormulaKind,\n  QuotaDetails,\n  // KnownXYZ enums\n  KnownDocumentBuildMode,\n  KnownDocumentFieldType,\n  KnownDocumentBarcodeKind,\n  KnownDocumentFormulaKind,\n  KnownDocumentSignatureType,\n  KnownDocumentTableCellKind,\n  KnownFontStyle,\n  KnownFontWeight,\n  KnownLengthUnit,\n  KnownOperationKind,\n  KnownParagraphRole,\n  KnownSelectionMarkState,\n} from \"./generated/index.js\";\nexport {\n  AnalysisPoller,\n  AnalyzeResult,\n  AnalyzeResultCommon,\n  DocumentAnalysisPollOperationState,\n  AnalyzedDocument,\n  FormRecognizerRequestBody,\n} from \"./lro/analysis.js\";\nexport {\n  DocumentModelPoller,\n  DocumentClassifierPoller,\n  DocumentModelOperationState,\n  DocumentClassifierOperationState,\n  ModelAdministrationOperationStateCommon,\n} from \"./lro/administration.js\";\nexport * from \"./models/index.js\";\nexport * from \"./options/index.js\";\nexport * from \"./documentModel.js\";\nexport { Point2D } from \"./transforms/polygon.js\";\nexport { KnownFormRecognizerAudience } from \"./constants.js\";\n"]}

package/dist/browser/options/FormRecognizerClientOptions.d.ts

@@ -37,10 +37,34 @@ export interface DocumentAnalysisClientOptions extends CommonClientOptions {
      * Default: "utf16CodeUnit"
      */
     stringIndexType?: StringIndexType;
+    /**
+     * The audience (scope) to use for authentication with Azure Active Directory.
+     *
+     * Setting this option is only necessary
+     * - if you are using Entra Id
+     *   (and)
+     * - if you are using a cloud other than the `AzurePublicCloud` ("https://cognitiveservices.azure.com")
+     *
+     * The authentication scope will be set from this audience.
+     * See {@link KnownFormRecognizerAudience} for known audience values.
+     */
+    audience?: string;
 }
 /**
  * Configurable options for DocumentModelAdministrationClient.
  */
 export interface DocumentModelAdministrationClientOptions extends CommonClientOptions {
+    /**
+     * The audience (scope) to use for authentication with Azure Active Directory.
+     *
+     * Setting this option is only necessary
+     * - if you are using Entra Id
+     *   (and)
+     * - if you are using a cloud other than the `AzurePublicCloud` ("https://cognitiveservices.azure.com")
+     *
+     * The authentication scope will be set from this audience.
+     * See {@link KnownFormRecognizerAudience} for known audience values.
+     */
+    audience?: string;
 }
 //# sourceMappingURL=FormRecognizerClientOptions.d.ts.map

package/dist/browser/options/FormRecognizerClientOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FormRecognizerClientOptions.d.ts","sourceRoot":"","sources":["../../../src/options/FormRecognizerClientOptions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAErF;;GAEG;AAEH,eAAO,MAAM,eAAe;IAC1B;;OAEG;;IAEH;;OAEG;;CAEK,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,gCAAgC;;CAEnC,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACxE;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,wCAAyC,SAAQ,mBAAmB;CAAG"}
+{"version":3,"file":"FormRecognizerClientOptions.d.ts","sourceRoot":"","sources":["../../../src/options/FormRecognizerClientOptions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAErF;;GAEG;AAEH,eAAO,MAAM,eAAe;IAC1B;;OAEG;;IAEH;;OAEG;;CAEK,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,gCAAgC;;CAEnC,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACxE;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,wCAAyC,SAAQ,mBAAmB;IACnF;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/browser/options/FormRecognizerClientOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"FormRecognizerClientOptions.js","sourceRoot":"","sources":["../../../src/options/FormRecognizerClientOptions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AASlC;;GAEG;AACH,2DAA2D;AAC3D,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B;;OAEG;IACH,aAAa,EAAE,eAAe;IAC9B;;OAEG;IACH,gBAAgB,EAAE,kBAAkB;CAC5B,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG;IAC9C,eAAe,EAAE,eAAe,CAAC,aAAa;CACtC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { CommonClientOptions } from \"@azure/core-client\";\n\n/**\n * Valid string index types supported by the Form Recognizer service and SDK clients.\n */\nexport type StringIndexType = (typeof StringIndexType)[keyof typeof StringIndexType];\n\n/**\n * Supported values of StringIndexType.\n */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const StringIndexType = {\n  /**\n   * UTF-16 code units\n   */\n  Utf16CodeUnit: \"utf16CodeUnit\",\n  /**\n   * Unicode code points\n   */\n  UnicodeCodePoint: \"unicodeCodePoint\",\n} as const;\n\n/**\n * Default settings for Form Recognizer clients.\n *\n * @internal\n */\nexport const DEFAULT_GENERATED_CLIENT_OPTIONS = {\n  stringIndexType: StringIndexType.Utf16CodeUnit,\n} as const;\n\n/**\n * Configurable options for DocumentAnalysisClient.\n */\nexport interface DocumentAnalysisClientOptions extends CommonClientOptions {\n  /**\n   * The unit of string offset/length values that the service returns.\n   *\n   * In JavaScript, strings are indexed by UTF-16 code units. Do _NOT_ set this value unless you are certain you need\n   * Unicode code-point units instead.\n   *\n   * Default: \"utf16CodeUnit\"\n   */\n  stringIndexType?: StringIndexType;\n}\n\n/**\n * Configurable options for DocumentModelAdministrationClient.\n */\nexport interface DocumentModelAdministrationClientOptions extends CommonClientOptions {}\n"]}
+{"version":3,"file":"FormRecognizerClientOptions.js","sourceRoot":"","sources":["../../../src/options/FormRecognizerClientOptions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AASlC;;GAEG;AACH,2DAA2D;AAC3D,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B;;OAEG;IACH,aAAa,EAAE,eAAe;IAC9B;;OAEG;IACH,gBAAgB,EAAE,kBAAkB;CAC5B,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG;IAC9C,eAAe,EAAE,eAAe,CAAC,aAAa;CACtC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { CommonClientOptions } from \"@azure/core-client\";\n\n/**\n * Valid string index types supported by the Form Recognizer service and SDK clients.\n */\nexport type StringIndexType = (typeof StringIndexType)[keyof typeof StringIndexType];\n\n/**\n * Supported values of StringIndexType.\n */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const StringIndexType = {\n  /**\n   * UTF-16 code units\n   */\n  Utf16CodeUnit: \"utf16CodeUnit\",\n  /**\n   * Unicode code points\n   */\n  UnicodeCodePoint: \"unicodeCodePoint\",\n} as const;\n\n/**\n * Default settings for Form Recognizer clients.\n *\n * @internal\n */\nexport const DEFAULT_GENERATED_CLIENT_OPTIONS = {\n  stringIndexType: StringIndexType.Utf16CodeUnit,\n} as const;\n\n/**\n * Configurable options for DocumentAnalysisClient.\n */\nexport interface DocumentAnalysisClientOptions extends CommonClientOptions {\n  /**\n   * The unit of string offset/length values that the service returns.\n   *\n   * In JavaScript, strings are indexed by UTF-16 code units. Do _NOT_ set this value unless you are certain you need\n   * Unicode code-point units instead.\n   *\n   * Default: \"utf16CodeUnit\"\n   */\n  stringIndexType?: StringIndexType;\n  /**\n   * The audience (scope) to use for authentication with Azure Active Directory.\n   *\n   * Setting this option is only necessary\n   * - if you are using Entra Id\n   *   (and)\n   * - if you are using a cloud other than the `AzurePublicCloud` (\"https://cognitiveservices.azure.com\")\n   *\n   * The authentication scope will be set from this audience.\n   * See {@link KnownFormRecognizerAudience} for known audience values.\n   */\n  audience?: string;\n}\n\n/**\n * Configurable options for DocumentModelAdministrationClient.\n */\nexport interface DocumentModelAdministrationClientOptions extends CommonClientOptions {\n  /**\n   * The audience (scope) to use for authentication with Azure Active Directory.\n   *\n   * Setting this option is only necessary\n   * - if you are using Entra Id\n   *   (and)\n   * - if you are using a cloud other than the `AzurePublicCloud` (\"https://cognitiveservices.azure.com\")\n   *\n   * The authentication scope will be set from this audience.\n   * See {@link KnownFormRecognizerAudience} for known audience values.\n   */\n  audience?: string;\n}\n"]}

package/dist/browser/util.d.ts

@@ -1,6 +1,7 @@
 import type { KeyCredential, TokenCredential } from "@azure/core-auth";
 import type { GeneratedClientOptionalParams } from "./generated/index.js";
 import { GeneratedClient } from "./generated/index.js";
+import { type DocumentAnalysisClientOptions } from "./options/FormRecognizerClientOptions.js";
 import * as Mappers from "./generated/models/mappers.js";
 export { Mappers };
 export declare const SERIALIZER: import("@azure/core-client").Serializer;
@@ -28,5 +29,5 @@ export declare const maybemap: <T1, T2>(value: T1 | undefined, f: (v: T1) => T2)
  * Create a GeneratedClient.
  * @internal
  */
-export declare function makeServiceClient(endpoint: string, credential: KeyCredential | TokenCredential, options: GeneratedClientOptionalParams): GeneratedClient;
+export declare function makeServiceClient(endpoint: string, credential: KeyCredential | TokenCredential, options: GeneratedClientOptionalParams & Pick<DocumentAnalysisClientOptions, "audience">): GeneratedClient;
 //# sourceMappingURL=util.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/util.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAKvE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD,OAAO,KAAK,OAAO,MAAM,+BAA+B,CAAC;AAEzD,OAAO,EAAE,OAAO,EAAE,CAAC;AAGnB,eAAO,MAAM,UAAU,yCAAmC,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,KAAG,YAAY,CAAC,CAAC,CACX,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,KAAG,UAAU,CAAC,CAAC,CACJ,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,GAAG,MAAM,KAAG,OAEvC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,SAAS,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,KAAG,EAAE,GAAG,SACpC,CAAC;AAE7C;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,aAAa,GAAG,eAAe,EAC3C,OAAO,EAAE,6BAA6B,GACrC,eAAe,CAiBjB"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/util.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAKvE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAEL,KAAK,6BAA6B,EACnC,MAAM,0CAA0C,CAAC;AAElD,OAAO,KAAK,OAAO,MAAM,+BAA+B,CAAC;AAEzD,OAAO,EAAE,OAAO,EAAE,CAAC;AAGnB,eAAO,MAAM,UAAU,yCAAmC,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,KAAG,YAAY,CAAC,CAAC,CACX,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,KAAG,UAAU,CAAC,CAAC,CACJ,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,GAAG,MAAM,KAAG,OAEvC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,SAAS,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,KAAG,EAAE,GAAG,SACpC,CAAC;AAE7C;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,aAAa,GAAG,eAAe,EAC3C,OAAO,EAAE,6BAA6B,GAAG,IAAI,CAAC,6BAA6B,EAAE,UAAU,CAAC,GACvF,eAAe,CAoBjB"}

package/dist/browser/util.js

@@ -5,7 +5,7 @@ import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
 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 { DEFAULT_GENERATED_CLIENT_OPTIONS, } from "./options/FormRecognizerClientOptions.js";
 import * as Mappers from "./generated/models/mappers.js";
 import { createSerializer } from "@azure/core-client";
 export { Mappers };
@@ -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

@@ -1 +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,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAE5F,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,OAAsC;IAEtC,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,uBAAuB;SAChC,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 { DEFAULT_GENERATED_CLIENT_OPTIONS } 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,\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: DEFAULT_COGNITIVE_SCOPE,\n      })\n    : createFormRecognizerAzureKeyCredentialPolicy(credential);\n\n  client.pipeline.addPolicy(authPolicy);\n\n  return client;\n}\n"]}
+{"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/constants.d.ts

@@ -1,11 +1,29 @@
 /**
- * The default AAD permissions scope for Cognitive Services.
+ * 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.0.0";
+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/commonjs/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iDAAiD,CAAC;AAEtF;;GAEG;AACH,eAAO,MAAM,WAAW,UAAU,CAAC;AAEnC,eAAO,MAAM,2BAA2B,eAAe,CAAC"}
+{"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/commonjs/constants.js

@@ -2,15 +2,34 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FORM_RECOGNIZER_API_VERSION = exports.SDK_VERSION = exports.DEFAULT_COGNITIVE_SCOPE = void 0;
+exports.FORM_RECOGNIZER_API_VERSION = exports.SDK_VERSION = exports.DEFAULT_COGNITIVE_SCOPE = exports.KnownFormRecognizerAudience = void 0;
 /**
- * The default AAD permissions scope for Cognitive Services.
+ * 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.
+ */
+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 || (exports.KnownFormRecognizerAudience = KnownFormRecognizerAudience = {}));
+/**
+ * The default Entra Id permissions scope for Cognitive Services.
  * @internal
  */
-exports.DEFAULT_COGNITIVE_SCOPE = "https://cognitiveservices.azure.com/.default";
+exports.DEFAULT_COGNITIVE_SCOPE = `${KnownFormRecognizerAudience.AzurePublicCloud}/.default`;
 /**
  * @internal
  */
-exports.SDK_VERSION = "5.0.0";
+exports.SDK_VERSION = "5.1.0";
 exports.FORM_RECOGNIZER_API_VERSION = "2023-07-31";
 //# sourceMappingURL=constants.js.map

package/dist/commonjs/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC;;;GAGG;AACU,QAAA,uBAAuB,GAAG,8CAA8C,CAAC;AAEtF;;GAEG;AACU,QAAA,WAAW,GAAG,OAAO,CAAC;AAEtB,QAAA,2BAA2B,GAAG,YAAY,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * The default AAD permissions scope for Cognitive Services.\n * @internal\n */\nexport const DEFAULT_COGNITIVE_SCOPE = \"https://cognitiveservices.azure.com/.default\";\n\n/**\n * @internal\n */\nexport const SDK_VERSION = \"5.0.0\";\n\nexport const FORM_RECOGNIZER_API_VERSION = \"2023-07-31\";\n"]}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC;;;;;;;;;GASG;AACH,IAAY,2BAOX;AAPD,WAAY,2BAA2B;IACrC,kBAAkB;IAClB,gFAAiD,CAAA;IACjD,uBAAuB;IACvB,qFAAsD,CAAA;IACtD,yBAAyB;IACzB,uFAAwD,CAAA;AAC1D,CAAC,EAPW,2BAA2B,2CAA3B,2BAA2B,QAOtC;AAED;;;GAGG;AACU,QAAA,uBAAuB,GAAG,GAAG,2BAA2B,CAAC,gBAAgB,WAAW,CAAC;AAElG;;GAEG;AACU,QAAA,WAAW,GAAG,OAAO,CAAC;AAEtB,QAAA,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"]}

package/dist/commonjs/generated/generatedClient.js

@@ -31,7 +31,7 @@ class GeneratedClient extends coreClient.ServiceClient {
         const defaults = {
             requestContentType: "application/json; charset=utf-8"
         };
-        const packageDetails = `azsdk-js-ai-form-recognizer/5.0.0`;
+        const packageDetails = `azsdk-js-ai-form-recognizer/5.1.0`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;

package/dist/commonjs/generated/generatedClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"generatedClient.js","sourceRoot":"","sources":["../../../src/generated/generatedClient.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;;AAEH,uEAAiD;AACjD,oFAA8D;AAM9D,oDAI+B;AAQ/B,MAAa,eAAgB,SAAQ,UAAU,CAAC,aAAa;IAK3D;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,OAAuC;;QACnE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;QAED,0CAA0C;QAC1C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QACD,MAAM,QAAQ,GAAkC;YAC9C,kBAAkB,EAAE,iCAAiC;SACtD,CAAC;QAEF,MAAM,cAAc,GAAG,mCAAmC,CAAC;QAC3D,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;YAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,cAAc,EAAE;YACjE,CAAC,CAAC,GAAG,cAAc,EAAE,CAAC;QAE1B,MAAM,mBAAmB,iDACpB,QAAQ,GACR,OAAO,KACV,gBAAgB,EAAE;gBAChB,eAAe;aAChB,EACD,OAAO,EACL,MAAA,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,OAAO,mCAAI,2BAA2B,GACrE,CAAC;QACF,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAE3B,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,KAAI,OAAO,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1E,MAAM,gBAAgB,GAAsC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;YAClG,MAAM,oCAAoC,GAAG,gBAAgB,CAAC,IAAI,CAChE,CAAC,cAAc,EAAE,EAAE,CACjB,cAAc,CAAC,IAAI;gBACnB,gBAAgB,CAAC,mCAAmC,CACvD,CAAC;YACF,IAAI,CAAC,oCAAoC,EAAE,CAAC;gBAC1C,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;oBACzB,IAAI,EAAE,gBAAgB,CAAC,mCAAmC;iBAC3D,CAAC,CAAC;gBACH,IAAI,CAAC,QAAQ,CAAC,SAAS,CACrB,gBAAgB,CAAC,+BAA+B,CAAC;oBAC/C,MAAM,EAAE,GAAG,mBAAmB,CAAC,OAAO,WAAW;oBACjD,kBAAkB,EAAE;wBAClB,2BAA2B,EACzB,UAAU,CAAC,gCAAgC;qBAC9C;iBACF,CAAC,CACH,CAAC;YACJ,CAAC;QACH,CAAC;QACD,wBAAwB;QACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,0CAA0C;QAC1C,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,YAAY,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,IAAI,6BAAkB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,aAAa,GAAG,IAAI,4BAAiB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,kCAAuB,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC;IAED,8GAA8G;IACtG,yBAAyB,CAAC,UAAmB;QACnD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,MAAM,gBAAgB,GAAG;YACvB,IAAI,EAAE,wBAAwB;YAC9B,KAAK,CAAC,WAAW,CACf,OAAwB,EACxB,IAAiB;gBAEjB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACrC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACrB,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;wBACjD,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;4BACrC,OAAO,cAAc,GAAG,UAAU,CAAC;wBACrC,CAAC;6BAAM,CAAC;4BACN,OAAO,IAAI,CAAC;wBACd,CAAC;oBACH,CAAC,CAAC,CAAC;oBACH,OAAO,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACrD,CAAC;gBACD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;SACF,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC5C,CAAC;CAKF;AAzGD,0CAyGC","sourcesContent":["/*\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * Code generated by Microsoft (R) AutoRest Code Generator.\n * Changes may cause incorrect behavior and will be lost if the code is regenerated.\n */\n\nimport * as coreClient from \"@azure/core-client\";\nimport * as coreRestPipeline from \"@azure/core-rest-pipeline\";\nimport {\n  PipelineRequest,\n  PipelineResponse,\n  SendRequest\n} from \"@azure/core-rest-pipeline\";\nimport {\n  DocumentModelsImpl,\n  MiscellaneousImpl,\n  DocumentClassifiersImpl\n} from \"./operations/index.js\";\nimport {\n  DocumentModels,\n  Miscellaneous,\n  DocumentClassifiers\n} from \"./operationsInterfaces/index.js\";\nimport { StringIndexType, GeneratedClientOptionalParams } from \"./models/index.js\";\n\nexport class GeneratedClient extends coreClient.ServiceClient {\n  endpoint: string;\n  stringIndexType?: StringIndexType;\n  apiVersion: string;\n\n  /**\n   * Initializes a new instance of the GeneratedClient class.\n   * @param endpoint Supported Cognitive Services endpoints (protocol and hostname, for\n   *                 example: https://westus2.api.cognitive.microsoft.com).\n   * @param options The parameter options\n   */\n  constructor(endpoint: string, options?: GeneratedClientOptionalParams) {\n    if (endpoint === undefined) {\n      throw new Error(\"'endpoint' cannot be null\");\n    }\n\n    // Initializing default values for options\n    if (!options) {\n      options = {};\n    }\n    const defaults: GeneratedClientOptionalParams = {\n      requestContentType: \"application/json; charset=utf-8\"\n    };\n\n    const packageDetails = `azsdk-js-ai-form-recognizer/5.0.0`;\n    const userAgentPrefix =\n      options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`\n        : `${packageDetails}`;\n\n    const optionsWithDefaults = {\n      ...defaults,\n      ...options,\n      userAgentOptions: {\n        userAgentPrefix\n      },\n      baseUri:\n        options.endpoint ?? options.baseUri ?? \"{endpoint}/formrecognizer\"\n    };\n    super(optionsWithDefaults);\n\n    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {\n      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();\n      const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(\n        (pipelinePolicy) =>\n          pipelinePolicy.name ===\n          coreRestPipeline.bearerTokenAuthenticationPolicyName\n      );\n      if (!bearerTokenAuthenticationPolicyFound) {\n        this.pipeline.removePolicy({\n          name: coreRestPipeline.bearerTokenAuthenticationPolicyName\n        });\n        this.pipeline.addPolicy(\n          coreRestPipeline.bearerTokenAuthenticationPolicy({\n            scopes: `${optionsWithDefaults.baseUri}/.default`,\n            challengeCallbacks: {\n              authorizeRequestOnChallenge:\n                coreClient.authorizeRequestOnClaimChallenge\n            }\n          })\n        );\n      }\n    }\n    // Parameter assignments\n    this.endpoint = endpoint;\n\n    // Assigning values to Constant parameters\n    this.apiVersion = options.apiVersion || \"2023-07-31\";\n    this.documentModels = new DocumentModelsImpl(this);\n    this.miscellaneous = new MiscellaneousImpl(this);\n    this.documentClassifiers = new DocumentClassifiersImpl(this);\n    this.addCustomApiVersionPolicy(options.apiVersion);\n  }\n\n  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */\n  private addCustomApiVersionPolicy(apiVersion?: string) {\n    if (!apiVersion) {\n      return;\n    }\n    const apiVersionPolicy = {\n      name: \"CustomApiVersionPolicy\",\n      async sendRequest(\n        request: PipelineRequest,\n        next: SendRequest\n      ): Promise<PipelineResponse> {\n        const param = request.url.split(\"?\");\n        if (param.length > 1) {\n          const newParams = param[1].split(\"&\").map((item) => {\n            if (item.indexOf(\"api-version\") > -1) {\n              return \"api-version=\" + apiVersion;\n            } else {\n              return item;\n            }\n          });\n          request.url = param[0] + \"?\" + newParams.join(\"&\");\n        }\n        return next(request);\n      }\n    };\n    this.pipeline.addPolicy(apiVersionPolicy);\n  }\n\n  documentModels: DocumentModels;\n  miscellaneous: Miscellaneous;\n  documentClassifiers: DocumentClassifiers;\n}\n"]}
+{"version":3,"file":"generatedClient.js","sourceRoot":"","sources":["../../../src/generated/generatedClient.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;;AAEH,uEAAiD;AACjD,oFAA8D;AAM9D,oDAI+B;AAQ/B,MAAa,eAAgB,SAAQ,UAAU,CAAC,aAAa;IAK3D;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,OAAuC;;QACnE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;QAED,0CAA0C;QAC1C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QACD,MAAM,QAAQ,GAAkC;YAC9C,kBAAkB,EAAE,iCAAiC;SACtD,CAAC;QAEF,MAAM,cAAc,GAAG,mCAAmC,CAAC;QAC3D,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;YAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,cAAc,EAAE;YACjE,CAAC,CAAC,GAAG,cAAc,EAAE,CAAC;QAE1B,MAAM,mBAAmB,iDACpB,QAAQ,GACR,OAAO,KACV,gBAAgB,EAAE;gBAChB,eAAe;aAChB,EACD,OAAO,EACL,MAAA,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,OAAO,mCAAI,2BAA2B,GACrE,CAAC;QACF,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAE3B,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,KAAI,OAAO,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1E,MAAM,gBAAgB,GAAsC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;YAClG,MAAM,oCAAoC,GAAG,gBAAgB,CAAC,IAAI,CAChE,CAAC,cAAc,EAAE,EAAE,CACjB,cAAc,CAAC,IAAI;gBACnB,gBAAgB,CAAC,mCAAmC,CACvD,CAAC;YACF,IAAI,CAAC,oCAAoC,EAAE,CAAC;gBAC1C,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;oBACzB,IAAI,EAAE,gBAAgB,CAAC,mCAAmC;iBAC3D,CAAC,CAAC;gBACH,IAAI,CAAC,QAAQ,CAAC,SAAS,CACrB,gBAAgB,CAAC,+BAA+B,CAAC;oBAC/C,MAAM,EAAE,GAAG,mBAAmB,CAAC,OAAO,WAAW;oBACjD,kBAAkB,EAAE;wBAClB,2BAA2B,EACzB,UAAU,CAAC,gCAAgC;qBAC9C;iBACF,CAAC,CACH,CAAC;YACJ,CAAC;QACH,CAAC;QACD,wBAAwB;QACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,0CAA0C;QAC1C,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,YAAY,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,IAAI,6BAAkB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,aAAa,GAAG,IAAI,4BAAiB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,kCAAuB,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC;IAED,8GAA8G;IACtG,yBAAyB,CAAC,UAAmB;QACnD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,MAAM,gBAAgB,GAAG;YACvB,IAAI,EAAE,wBAAwB;YAC9B,KAAK,CAAC,WAAW,CACf,OAAwB,EACxB,IAAiB;gBAEjB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACrC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACrB,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;wBACjD,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;4BACrC,OAAO,cAAc,GAAG,UAAU,CAAC;wBACrC,CAAC;6BAAM,CAAC;4BACN,OAAO,IAAI,CAAC;wBACd,CAAC;oBACH,CAAC,CAAC,CAAC;oBACH,OAAO,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACrD,CAAC;gBACD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;SACF,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC5C,CAAC;CAKF;AAzGD,0CAyGC","sourcesContent":["/*\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * Code generated by Microsoft (R) AutoRest Code Generator.\n * Changes may cause incorrect behavior and will be lost if the code is regenerated.\n */\n\nimport * as coreClient from \"@azure/core-client\";\nimport * as coreRestPipeline from \"@azure/core-rest-pipeline\";\nimport {\n  PipelineRequest,\n  PipelineResponse,\n  SendRequest\n} from \"@azure/core-rest-pipeline\";\nimport {\n  DocumentModelsImpl,\n  MiscellaneousImpl,\n  DocumentClassifiersImpl\n} from \"./operations/index.js\";\nimport {\n  DocumentModels,\n  Miscellaneous,\n  DocumentClassifiers\n} from \"./operationsInterfaces/index.js\";\nimport { StringIndexType, GeneratedClientOptionalParams } from \"./models/index.js\";\n\nexport class GeneratedClient extends coreClient.ServiceClient {\n  endpoint: string;\n  stringIndexType?: StringIndexType;\n  apiVersion: string;\n\n  /**\n   * Initializes a new instance of the GeneratedClient class.\n   * @param endpoint Supported Cognitive Services endpoints (protocol and hostname, for\n   *                 example: https://westus2.api.cognitive.microsoft.com).\n   * @param options The parameter options\n   */\n  constructor(endpoint: string, options?: GeneratedClientOptionalParams) {\n    if (endpoint === undefined) {\n      throw new Error(\"'endpoint' cannot be null\");\n    }\n\n    // Initializing default values for options\n    if (!options) {\n      options = {};\n    }\n    const defaults: GeneratedClientOptionalParams = {\n      requestContentType: \"application/json; charset=utf-8\"\n    };\n\n    const packageDetails = `azsdk-js-ai-form-recognizer/5.1.0`;\n    const userAgentPrefix =\n      options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`\n        : `${packageDetails}`;\n\n    const optionsWithDefaults = {\n      ...defaults,\n      ...options,\n      userAgentOptions: {\n        userAgentPrefix\n      },\n      baseUri:\n        options.endpoint ?? options.baseUri ?? \"{endpoint}/formrecognizer\"\n    };\n    super(optionsWithDefaults);\n\n    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {\n      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();\n      const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(\n        (pipelinePolicy) =>\n          pipelinePolicy.name ===\n          coreRestPipeline.bearerTokenAuthenticationPolicyName\n      );\n      if (!bearerTokenAuthenticationPolicyFound) {\n        this.pipeline.removePolicy({\n          name: coreRestPipeline.bearerTokenAuthenticationPolicyName\n        });\n        this.pipeline.addPolicy(\n          coreRestPipeline.bearerTokenAuthenticationPolicy({\n            scopes: `${optionsWithDefaults.baseUri}/.default`,\n            challengeCallbacks: {\n              authorizeRequestOnChallenge:\n                coreClient.authorizeRequestOnClaimChallenge\n            }\n          })\n        );\n      }\n    }\n    // Parameter assignments\n    this.endpoint = endpoint;\n\n    // Assigning values to Constant parameters\n    this.apiVersion = options.apiVersion || \"2023-07-31\";\n    this.documentModels = new DocumentModelsImpl(this);\n    this.miscellaneous = new MiscellaneousImpl(this);\n    this.documentClassifiers = new DocumentClassifiersImpl(this);\n    this.addCustomApiVersionPolicy(options.apiVersion);\n  }\n\n  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */\n  private addCustomApiVersionPolicy(apiVersion?: string) {\n    if (!apiVersion) {\n      return;\n    }\n    const apiVersionPolicy = {\n      name: \"CustomApiVersionPolicy\",\n      async sendRequest(\n        request: PipelineRequest,\n        next: SendRequest\n      ): Promise<PipelineResponse> {\n        const param = request.url.split(\"?\");\n        if (param.length > 1) {\n          const newParams = param[1].split(\"&\").map((item) => {\n            if (item.indexOf(\"api-version\") > -1) {\n              return \"api-version=\" + apiVersion;\n            } else {\n              return item;\n            }\n          });\n          request.url = param[0] + \"?\" + newParams.join(\"&\");\n        }\n        return next(request);\n      }\n    };\n    this.pipeline.addPolicy(apiVersionPolicy);\n  }\n\n  documentModels: DocumentModels;\n  miscellaneous: Miscellaneous;\n  documentClassifiers: DocumentClassifiers;\n}\n"]}

package/dist/commonjs/index.d.ts

@@ -14,4 +14,5 @@ export * from "./models/index.js";
 export * from "./options/index.js";
 export * from "./documentModel.js";
 export { Point2D } from "./transforms/polygon.js";
+export { KnownFormRecognizerAudience } from "./constants.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAC3F,OAAO,EAEL,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACrB,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,UAAU,EACV,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,eAAe,EACf,2BAA2B,EAC3B,4BAA4B,EAC5B,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,kCAAkC,EAClC,oCAAoC,EACpC,mCAAmC,EACnC,uCAAuC,EACvC,yBAAyB,EACzB,6BAA6B,EAC7B,mBAAmB,EACnB,mBAAmB,EACnB,YAAY,EAEZ,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,cAAc,EACd,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,kCAAkC,EAClC,gBAAgB,EAChB,yBAAyB,GAC1B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACxB,2BAA2B,EAC3B,gCAAgC,EAChC,uCAAuC,GACxC,MAAM,yBAAyB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAC3F,OAAO,EAEL,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACrB,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,UAAU,EACV,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,eAAe,EACf,2BAA2B,EAC3B,4BAA4B,EAC5B,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,kCAAkC,EAClC,oCAAoC,EACpC,mCAAmC,EACnC,uCAAuC,EACvC,yBAAyB,EACzB,6BAA6B,EAC7B,mBAAmB,EACnB,mBAAmB,EACnB,YAAY,EAEZ,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,cAAc,EACd,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,kCAAkC,EAClC,gBAAgB,EAChB,yBAAyB,GAC1B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACxB,2BAA2B,EAC3B,gCAAgC,EAChC,uCAAuC,GACxC,MAAM,yBAAyB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/commonjs/index.js

@@ -2,7 +2,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KnownSelectionMarkState = exports.KnownParagraphRole = exports.KnownOperationKind = exports.KnownLengthUnit = exports.KnownFontWeight = exports.KnownFontStyle = exports.KnownDocumentTableCellKind = exports.KnownDocumentSignatureType = exports.KnownDocumentFormulaKind = exports.KnownDocumentBarcodeKind = exports.KnownDocumentFieldType = exports.KnownDocumentBuildMode = exports.DocumentModelAdministrationClient = exports.DocumentAnalysisClient = exports.AzureKeyCredential = void 0;
+exports.KnownFormRecognizerAudience = exports.KnownSelectionMarkState = exports.KnownParagraphRole = exports.KnownOperationKind = exports.KnownLengthUnit = exports.KnownFontWeight = exports.KnownFontStyle = exports.KnownDocumentTableCellKind = exports.KnownDocumentSignatureType = exports.KnownDocumentFormulaKind = exports.KnownDocumentBarcodeKind = exports.KnownDocumentFieldType = exports.KnownDocumentBuildMode = exports.DocumentModelAdministrationClient = exports.DocumentAnalysisClient = exports.AzureKeyCredential = void 0;
 const tslib_1 = require("tslib");
 /**
  * Azure Cognitive Services [Form Recognizer](https://azure.microsoft.com/services/cognitive-services/form-recognizer/)
@@ -33,4 +33,6 @@ Object.defineProperty(exports, "KnownSelectionMarkState", { enumerable: true, ge
 tslib_1.__exportStar(require("./models/index.js"), exports);
 tslib_1.__exportStar(require("./options/index.js"), exports);
 tslib_1.__exportStar(require("./documentModel.js"), exports);
+var constants_js_1 = require("./constants.js");
+Object.defineProperty(exports, "KnownFormRecognizerAudience", { enumerable: true, get: function () { return constants_js_1.KnownFormRecognizerAudience; } });
 //# sourceMappingURL=index.js.map

package/dist/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAElC;;;;;GAKG;AAEH,8CAAsD;AAA7C,+GAAA,kBAAkB,OAAA;AAC3B,yEAAqE;AAA5D,mIAAA,sBAAsB,OAAA;AAC/B,+FAA2F;AAAlF,yJAAA,iCAAiC,OAAA;AAC1C,iDAqD8B;AAb5B,iBAAiB;AACjB,kHAAA,sBAAsB,OAAA;AACtB,kHAAA,sBAAsB,OAAA;AACtB,oHAAA,wBAAwB,OAAA;AACxB,oHAAA,wBAAwB,OAAA;AACxB,sHAAA,0BAA0B,OAAA;AAC1B,sHAAA,0BAA0B,OAAA;AAC1B,0GAAA,cAAc,OAAA;AACd,2GAAA,eAAe,OAAA;AACf,2GAAA,eAAe,OAAA;AACf,8GAAA,kBAAkB,OAAA;AAClB,8GAAA,kBAAkB,OAAA;AAClB,mHAAA,uBAAuB,OAAA;AAiBzB,4DAAkC;AAClC,6DAAmC;AACnC,6DAAmC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Azure Cognitive Services [Form Recognizer](https://azure.microsoft.com/services/cognitive-services/form-recognizer/)\n * uses cloud-based machine learning to extract structured data from form documents.\n *\n * @packageDocumentation\n */\n\nexport { AzureKeyCredential } from \"@azure/core-auth\";\nexport { DocumentAnalysisClient } from \"./documentAnalysisClient.js\";\nexport { DocumentModelAdministrationClient } from \"./documentModelAdministrationClient.js\";\nexport {\n  // Generated types used verbatim\n  AddressValue,\n  CopyAuthorization,\n  CurrencyValue,\n  DocumentTypeDetails,\n  DocumentBuildMode,\n  DocumentFieldSchema,\n  DocumentFieldType,\n  DocumentSignatureType,\n  DocumentSpan,\n  DocumentLanguage,\n  DocumentStyle,\n  FontStyle,\n  FontWeight,\n  DocumentTableCellKind,\n  LengthUnit,\n  DocumentModelDetails,\n  DocumentModelSummary,\n  OperationSummary,\n  OperationKind,\n  OperationStatus,\n  ResourceDetails,\n  CustomDocumentModelsDetails,\n  AnalyzeResultOperationStatus,\n  SelectionMarkState,\n  ParagraphRole,\n  OperationDetails,\n  ErrorModel,\n  InnerError,\n  OperationDetailsUnion,\n  DocumentModelBuildOperationDetails,\n  DocumentModelComposeOperationDetails,\n  DocumentModelCopyToOperationDetails,\n  DocumentClassifierBuildOperationDetails,\n  DocumentClassifierDetails,\n  ClassifierDocumentTypeDetails,\n  DocumentBarcodeKind,\n  DocumentFormulaKind,\n  QuotaDetails,\n  // KnownXYZ enums\n  KnownDocumentBuildMode,\n  KnownDocumentFieldType,\n  KnownDocumentBarcodeKind,\n  KnownDocumentFormulaKind,\n  KnownDocumentSignatureType,\n  KnownDocumentTableCellKind,\n  KnownFontStyle,\n  KnownFontWeight,\n  KnownLengthUnit,\n  KnownOperationKind,\n  KnownParagraphRole,\n  KnownSelectionMarkState,\n} from \"./generated/index.js\";\nexport {\n  AnalysisPoller,\n  AnalyzeResult,\n  AnalyzeResultCommon,\n  DocumentAnalysisPollOperationState,\n  AnalyzedDocument,\n  FormRecognizerRequestBody,\n} from \"./lro/analysis.js\";\nexport {\n  DocumentModelPoller,\n  DocumentClassifierPoller,\n  DocumentModelOperationState,\n  DocumentClassifierOperationState,\n  ModelAdministrationOperationStateCommon,\n} from \"./lro/administration.js\";\nexport * from \"./models/index.js\";\nexport * from \"./options/index.js\";\nexport * from \"./documentModel.js\";\nexport { Point2D } from \"./transforms/polygon.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAElC;;;;;GAKG;AAEH,8CAAsD;AAA7C,+GAAA,kBAAkB,OAAA;AAC3B,yEAAqE;AAA5D,mIAAA,sBAAsB,OAAA;AAC/B,+FAA2F;AAAlF,yJAAA,iCAAiC,OAAA;AAC1C,iDAqD8B;AAb5B,iBAAiB;AACjB,kHAAA,sBAAsB,OAAA;AACtB,kHAAA,sBAAsB,OAAA;AACtB,oHAAA,wBAAwB,OAAA;AACxB,oHAAA,wBAAwB,OAAA;AACxB,sHAAA,0BAA0B,OAAA;AAC1B,sHAAA,0BAA0B,OAAA;AAC1B,0GAAA,cAAc,OAAA;AACd,2GAAA,eAAe,OAAA;AACf,2GAAA,eAAe,OAAA;AACf,8GAAA,kBAAkB,OAAA;AAClB,8GAAA,kBAAkB,OAAA;AAClB,mHAAA,uBAAuB,OAAA;AAiBzB,4DAAkC;AAClC,6DAAmC;AACnC,6DAAmC;AAEnC,+CAA6D;AAApD,2HAAA,2BAA2B,OAAA","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Azure Cognitive Services [Form Recognizer](https://azure.microsoft.com/services/cognitive-services/form-recognizer/)\n * uses cloud-based machine learning to extract structured data from form documents.\n *\n * @packageDocumentation\n */\n\nexport { AzureKeyCredential } from \"@azure/core-auth\";\nexport { DocumentAnalysisClient } from \"./documentAnalysisClient.js\";\nexport { DocumentModelAdministrationClient } from \"./documentModelAdministrationClient.js\";\nexport {\n  // Generated types used verbatim\n  AddressValue,\n  CopyAuthorization,\n  CurrencyValue,\n  DocumentTypeDetails,\n  DocumentBuildMode,\n  DocumentFieldSchema,\n  DocumentFieldType,\n  DocumentSignatureType,\n  DocumentSpan,\n  DocumentLanguage,\n  DocumentStyle,\n  FontStyle,\n  FontWeight,\n  DocumentTableCellKind,\n  LengthUnit,\n  DocumentModelDetails,\n  DocumentModelSummary,\n  OperationSummary,\n  OperationKind,\n  OperationStatus,\n  ResourceDetails,\n  CustomDocumentModelsDetails,\n  AnalyzeResultOperationStatus,\n  SelectionMarkState,\n  ParagraphRole,\n  OperationDetails,\n  ErrorModel,\n  InnerError,\n  OperationDetailsUnion,\n  DocumentModelBuildOperationDetails,\n  DocumentModelComposeOperationDetails,\n  DocumentModelCopyToOperationDetails,\n  DocumentClassifierBuildOperationDetails,\n  DocumentClassifierDetails,\n  ClassifierDocumentTypeDetails,\n  DocumentBarcodeKind,\n  DocumentFormulaKind,\n  QuotaDetails,\n  // KnownXYZ enums\n  KnownDocumentBuildMode,\n  KnownDocumentFieldType,\n  KnownDocumentBarcodeKind,\n  KnownDocumentFormulaKind,\n  KnownDocumentSignatureType,\n  KnownDocumentTableCellKind,\n  KnownFontStyle,\n  KnownFontWeight,\n  KnownLengthUnit,\n  KnownOperationKind,\n  KnownParagraphRole,\n  KnownSelectionMarkState,\n} from \"./generated/index.js\";\nexport {\n  AnalysisPoller,\n  AnalyzeResult,\n  AnalyzeResultCommon,\n  DocumentAnalysisPollOperationState,\n  AnalyzedDocument,\n  FormRecognizerRequestBody,\n} from \"./lro/analysis.js\";\nexport {\n  DocumentModelPoller,\n  DocumentClassifierPoller,\n  DocumentModelOperationState,\n  DocumentClassifierOperationState,\n  ModelAdministrationOperationStateCommon,\n} from \"./lro/administration.js\";\nexport * from \"./models/index.js\";\nexport * from \"./options/index.js\";\nexport * from \"./documentModel.js\";\nexport { Point2D } from \"./transforms/polygon.js\";\nexport { KnownFormRecognizerAudience } from \"./constants.js\";\n"]}

package/dist/commonjs/options/FormRecognizerClientOptions.d.ts

@@ -37,10 +37,34 @@ export interface DocumentAnalysisClientOptions extends CommonClientOptions {
      * Default: "utf16CodeUnit"
      */
     stringIndexType?: StringIndexType;
+    /**
+     * The audience (scope) to use for authentication with Azure Active Directory.
+     *
+     * Setting this option is only necessary
+     * - if you are using Entra Id
+     *   (and)
+     * - if you are using a cloud other than the `AzurePublicCloud` ("https://cognitiveservices.azure.com")
+     *
+     * The authentication scope will be set from this audience.
+     * See {@link KnownFormRecognizerAudience} for known audience values.
+     */
+    audience?: string;
 }
 /**
  * Configurable options for DocumentModelAdministrationClient.
  */
 export interface DocumentModelAdministrationClientOptions extends CommonClientOptions {
+    /**
+     * The audience (scope) to use for authentication with Azure Active Directory.
+     *
+     * Setting this option is only necessary
+     * - if you are using Entra Id
+     *   (and)
+     * - if you are using a cloud other than the `AzurePublicCloud` ("https://cognitiveservices.azure.com")
+     *
+     * The authentication scope will be set from this audience.
+     * See {@link KnownFormRecognizerAudience} for known audience values.
+     */
+    audience?: string;
 }
 //# sourceMappingURL=FormRecognizerClientOptions.d.ts.map

package/dist/commonjs/options/FormRecognizerClientOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FormRecognizerClientOptions.d.ts","sourceRoot":"","sources":["../../../src/options/FormRecognizerClientOptions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAErF;;GAEG;AAEH,eAAO,MAAM,eAAe;IAC1B;;OAEG;;IAEH;;OAEG;;CAEK,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,gCAAgC;;CAEnC,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACxE;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,wCAAyC,SAAQ,mBAAmB;CAAG"}
+{"version":3,"file":"FormRecognizerClientOptions.d.ts","sourceRoot":"","sources":["../../../src/options/FormRecognizerClientOptions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAErF;;GAEG;AAEH,eAAO,MAAM,eAAe;IAC1B;;OAEG;;IAEH;;OAEG;;CAEK,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,gCAAgC;;CAEnC,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACxE;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,wCAAyC,SAAQ,mBAAmB;IACnF;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/commonjs/options/FormRecognizerClientOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"FormRecognizerClientOptions.js","sourceRoot":"","sources":["../../../src/options/FormRecognizerClientOptions.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AASlC;;GAEG;AACH,2DAA2D;AAC9C,QAAA,eAAe,GAAG;IAC7B;;OAEG;IACH,aAAa,EAAE,eAAe;IAC9B;;OAEG;IACH,gBAAgB,EAAE,kBAAkB;CAC5B,CAAC;AAEX;;;;GAIG;AACU,QAAA,gCAAgC,GAAG;IAC9C,eAAe,EAAE,uBAAe,CAAC,aAAa;CACtC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { CommonClientOptions } from \"@azure/core-client\";\n\n/**\n * Valid string index types supported by the Form Recognizer service and SDK clients.\n */\nexport type StringIndexType = (typeof StringIndexType)[keyof typeof StringIndexType];\n\n/**\n * Supported values of StringIndexType.\n */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const StringIndexType = {\n  /**\n   * UTF-16 code units\n   */\n  Utf16CodeUnit: \"utf16CodeUnit\",\n  /**\n   * Unicode code points\n   */\n  UnicodeCodePoint: \"unicodeCodePoint\",\n} as const;\n\n/**\n * Default settings for Form Recognizer clients.\n *\n * @internal\n */\nexport const DEFAULT_GENERATED_CLIENT_OPTIONS = {\n  stringIndexType: StringIndexType.Utf16CodeUnit,\n} as const;\n\n/**\n * Configurable options for DocumentAnalysisClient.\n */\nexport interface DocumentAnalysisClientOptions extends CommonClientOptions {\n  /**\n   * The unit of string offset/length values that the service returns.\n   *\n   * In JavaScript, strings are indexed by UTF-16 code units. Do _NOT_ set this value unless you are certain you need\n   * Unicode code-point units instead.\n   *\n   * Default: \"utf16CodeUnit\"\n   */\n  stringIndexType?: StringIndexType;\n}\n\n/**\n * Configurable options for DocumentModelAdministrationClient.\n */\nexport interface DocumentModelAdministrationClientOptions extends CommonClientOptions {}\n"]}
+{"version":3,"file":"FormRecognizerClientOptions.js","sourceRoot":"","sources":["../../../src/options/FormRecognizerClientOptions.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AASlC;;GAEG;AACH,2DAA2D;AAC9C,QAAA,eAAe,GAAG;IAC7B;;OAEG;IACH,aAAa,EAAE,eAAe;IAC9B;;OAEG;IACH,gBAAgB,EAAE,kBAAkB;CAC5B,CAAC;AAEX;;;;GAIG;AACU,QAAA,gCAAgC,GAAG;IAC9C,eAAe,EAAE,uBAAe,CAAC,aAAa;CACtC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { CommonClientOptions } from \"@azure/core-client\";\n\n/**\n * Valid string index types supported by the Form Recognizer service and SDK clients.\n */\nexport type StringIndexType = (typeof StringIndexType)[keyof typeof StringIndexType];\n\n/**\n * Supported values of StringIndexType.\n */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const StringIndexType = {\n  /**\n   * UTF-16 code units\n   */\n  Utf16CodeUnit: \"utf16CodeUnit\",\n  /**\n   * Unicode code points\n   */\n  UnicodeCodePoint: \"unicodeCodePoint\",\n} as const;\n\n/**\n * Default settings for Form Recognizer clients.\n *\n * @internal\n */\nexport const DEFAULT_GENERATED_CLIENT_OPTIONS = {\n  stringIndexType: StringIndexType.Utf16CodeUnit,\n} as const;\n\n/**\n * Configurable options for DocumentAnalysisClient.\n */\nexport interface DocumentAnalysisClientOptions extends CommonClientOptions {\n  /**\n   * The unit of string offset/length values that the service returns.\n   *\n   * In JavaScript, strings are indexed by UTF-16 code units. Do _NOT_ set this value unless you are certain you need\n   * Unicode code-point units instead.\n   *\n   * Default: \"utf16CodeUnit\"\n   */\n  stringIndexType?: StringIndexType;\n  /**\n   * The audience (scope) to use for authentication with Azure Active Directory.\n   *\n   * Setting this option is only necessary\n   * - if you are using Entra Id\n   *   (and)\n   * - if you are using a cloud other than the `AzurePublicCloud` (\"https://cognitiveservices.azure.com\")\n   *\n   * The authentication scope will be set from this audience.\n   * See {@link KnownFormRecognizerAudience} for known audience values.\n   */\n  audience?: string;\n}\n\n/**\n * Configurable options for DocumentModelAdministrationClient.\n */\nexport interface DocumentModelAdministrationClientOptions extends CommonClientOptions {\n  /**\n   * The audience (scope) to use for authentication with Azure Active Directory.\n   *\n   * Setting this option is only necessary\n   * - if you are using Entra Id\n   *   (and)\n   * - if you are using a cloud other than the `AzurePublicCloud` (\"https://cognitiveservices.azure.com\")\n   *\n   * The authentication scope will be set from this audience.\n   * See {@link KnownFormRecognizerAudience} for known audience values.\n   */\n  audience?: string;\n}\n"]}