🔊 add error code to v2 exceptions (#399)

Author: ianardee

src/errors/mindeeError.ts

@@ -1,4 +1,4 @@
-import { ErrorDetails, ErrorResponse } from "../parsing/v2";
+import { ErrorDetails, ErrorResponse, ErrorItem } from "../parsing/v2";
 
 /**
  * Main Mindee Error custom class.
@@ -47,13 +47,15 @@ export class MindeeHttpErrorV2 extends MindeeError implements ErrorDetails {
   public detail: string;
   public title: string;
   public code: string;
+  public errors: ErrorItem[];
 
   constructor(error: ErrorResponse) {
-    super(`HTTP ${error.status} :: ${error.title} - ${error.detail}`);
+    super(`HTTP ${error.status} - ${error.title} :: ${error.code} - ${error.detail}`);
     this.status = error.status;
     this.detail = error.detail;
     this.title = error.title;
     this.code = error.code;
+    this.errors = error.errors;
     this.name = "MindeeHttpErrorV2";
   }
 }

src/parsing/v2/errorResponse.ts

@@ -18,6 +18,10 @@ export interface ErrorDetails {
    * A machine-readable code specific to the occurrence of the problem.
    */
   code: string;
+  /**
+   * A machine-readable code specific to the occurrence of the problem.
+   */
+  errors: ErrorItem[];
 }
 
 /**
@@ -28,10 +32,7 @@ export class ErrorResponse implements ErrorDetails {
   detail: string;
   title: string;
   code: string;
-  /**
-   * A machine-readable code specific to the occurrence of the problem.
-   */
-  public errors: ErrorItem[];
+  errors: ErrorItem[];
 
   /**
    * @param serverResponse JSON response from the server.

tests/data

@@ -158,6 +158,7 @@ describe("MindeeV2 – Client Integration Tests", () => {
       expect(errObj.code.startsWith("422-")).to.be.true;
       expect(errObj.title).to.be.a("string");
       expect(errObj.detail).to.be.a("string");
+      expect(errObj.errors).to.be.instanceOf(Array);
     }
   }).timeout(60000);
 
@@ -172,6 +173,7 @@ describe("MindeeV2 – Client Integration Tests", () => {
       expect(errObj.code.startsWith("422-")).to.be.true;
       expect(errObj.title).to.be.a("string");
       expect(errObj.detail).to.be.a("string");
+      expect(errObj.errors).to.be.instanceOf(Array);
     }
   }).timeout(60000);
 

tests/v2/clientV2.integration.ts

@@ -280,14 +280,23 @@ describe("MindeeV2 - Inference Response", async () => {
   });
 
   describe("RAG Metadata", async () => {
-    it("RAG metadata should be exposed", async () => {
+    it("RAG metadata when matched", async () => {
       const response = await loadV2Inference(
         path.join(inferencePath, "rag_matched.json")
       );
       const rag = response.inference.result.rag;
       expect(rag).to.be.instanceOf(RagMetadata);
       expect(rag?.retrievedDocumentId).to.eq("12345abc-1234-1234-1234-123456789abc");
     });
+
+    it("RAG metadata when not matched", async () => {
+      const response = await loadV2Inference(
+        path.join(inferencePath, "rag_not_matched.json")
+      );
+      const rag = response.inference.result.rag;
+      expect(rag).to.be.instanceOf(RagMetadata);
+      expect(rag?.retrievedDocumentId).to.be.undefined;
+    });
   });
 
   describe("RST Display", async () => {