@aiqa/sdk 1.0.0 → 1.1.0

package/README.md

@@ -139,9 +139,18 @@ Adds a fact to the active application (Promise-based).
     id: string;
     question: string;
     expected_answer: any;
-    answer_format: {
-      type: "STRING";
-    }
+    answer_format: { type: "STRING" }
+    /**
+     * Optional. Use this to attach your own identifiers to a fact so your UI
+     * can map the server response back to the right field or component.
+     * For example, store a form field ID, a section name, or any internal
+     * reference you need — the server stores it as-is and returns it unchanged
+     * in getFacts().
+     *
+     * Constraints: all keys and values must be strings; each value is limited
+     * to 1024 characters. Payloads that exceed this limit are rejected.
+     */
+    metadata?: Record<string, string>
   }
   ```
 
@@ -151,15 +160,19 @@ const isMatched = await sdk.addFact({
   question: "Do you agree?",
   expected_answer: "Yes",
   answer_format: { type: "STRING" },
+  metadata: { uiFieldId: "policy-agreement", section: "consent" },
 });
 ```
 
 #### `getFacts()`
 
-Retrieves all facts for the application (Promise-based).
+Retrieves all facts for the application (Promise-based). Each fact includes a `metadata` field containing whatever was passed to `addFact()`. Facts added without `metadata` return `{}`.
 
 ```typescript
 const facts = await sdk.getFacts();
+facts.forEach((fact) => {
+  console.log(fact.id, fact.metadata); // e.g. { uiFieldId: "policy-agreement" } or {}
+});
 ```
 
 ### Recording Management
@@ -242,11 +255,14 @@ type Application = {
 
 ### ApplicationFact
 
+Returned by `getFacts()`. Extends `ApplicationFactInput` and adds server-side fields.
+
 ```typescript
 type ApplicationFact = ApplicationFactInput & {
   ai_answer?: any;
   question_status: "searching" | "asked" | "not_asked";
   verification_status: "processing" | "matched" | "unmatched";
+  metadata: Record<string, string>; // always present; {} when not set on addFact
 };
 ```
 
@@ -275,6 +291,21 @@ type ApplicationFactInput = {
   language?: string;
   critical?: boolean;
   is_skipped?: boolean;
+  /**
+   * Optional. Attach your own identifiers to a fact so your UI can map the
+   * server response back to the right field or component — for example a form
+   * field ID, a section name, or any internal reference you need.
+   *
+   * The server stores this value encrypted alongside the fact and returns it
+   * unchanged in getFacts(). It is never inspected, indexed, or used for
+   * verification logic.
+   *
+   * Constraints:
+   * - All keys and values must be strings.
+   * - Each individual value is limited to 1024 characters.
+   * - Payloads that violate either constraint are rejected by the server.
+   */
+  metadata?: Record<string, string>;
 };
 ```
 

package/dist/browser/browser.d.ts

@@ -61,6 +61,7 @@ type ApplicationFactInput = {
     language?: string;
     critical?: boolean;
     is_skipped?: boolean;
+    metadata?: Record<string, string>;
 };
 type QuestionStatus = "searching" | "asked" | "not_asked";
 type VerificationStatus = "processing" | "matched" | "unmatched";

package/dist/browser/browser.js

@@ -3395,7 +3395,7 @@ var compareVersions = (left, right) => {
 // package.json
 var package_default = {
   name: "@aiqa/sdk",
-  version: "1.0.0-develop.5",
+  version: "1.1.0-develop.1",
   main: "dist/node/node.js",
   module: "dist/node/node.js",
   types: "dist/node/node.d.ts",