✨ add webhook error response

src/v2/parsing/inference/failedInferenceResponse.ts

@@ -0,0 +1,49 @@
+import { parseDate, StringDict } from "@/parsing/index.js";
+import { ErrorResponse } from "@/v2/index.js";
+import { BaseResponse } from "@/v2/parsing/baseResponse.js";
+
+/**
+ * Webhook payload returned when an inference fails before producing a result.
+ */
+export class FailedInferenceResponse extends BaseResponse {
+  /**
+   * UUID of the failed inference.
+   */
+  public inferenceId: string;
+
+  /**
+   * UUID of the model used.
+   */
+  public modelId: string;
+
+  /**
+   * Name of the input file.
+   */
+  public fileName: string;
+
+  /**
+   * Alias sent for the file, if any.
+   */
+  public fileAlias?: string;
+
+  /**
+   * Problem details for the failure, if available.
+   */
+  public error: ErrorResponse;
+
+  /**
+   * Date and time when the inference was started.
+   */
+  public createdAt: Date | null;
+
+
+  constructor(serverResponse: StringDict) {
+    super(serverResponse);
+    this.inferenceId = serverResponse["inference_id"];
+    this.modelId = serverResponse["model_id"];
+    this.fileName = serverResponse["file_name"];
+    this.fileAlias = serverResponse["file_alias"];
+    this.error = new ErrorResponse(serverResponse["error"]);
+    this.createdAt = parseDate(serverResponse["created_at"]);
+  }
+}

src/v2/parsing/job/jobResponse.ts

@@ -2,6 +2,9 @@ import { BaseResponse } from "@/v2/parsing/baseResponse.js";
 import { StringDict } from "@/parsing/stringDict.js";
 import { Job } from "./job.js";
 
+/**
+ * Job response class.
+ */
 export class JobResponse extends BaseResponse {
   /**
    * Job for the polling.

tests/v2/parsing/failedInferenceResponse.spec.ts

@@ -0,0 +1,26 @@
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+import path from "path";
+import { ErrorResponse, LocalResponse } from "../../../src/v2/index.js";
+import { FailedInferenceResponse } from "../../../src/v2/parsing/inference/failedInferenceResponse.js";
+import { V2_RESOURCE_PATH } from "../../index.js";
+
+describe("MindeeV2 - Failed Inference Response", async () => {
+
+  it("should load", async () => {
+
+    const localResponse = new LocalResponse(path.join(V2_RESOURCE_PATH, "errors", "webhook_error_500_failed.json"));
+    await localResponse.init();
+    const response = await localResponse.deserializeResponse(FailedInferenceResponse);
+
+    assert.ok(response);
+    assert.equal(response.inferenceId, "12345678-1234-1234-1234-123456789ABC");
+    assert.equal(response.fileName, "default_sample.jpg");
+    assert.equal(response.fileAlias, "dummy-alias.jpg");
+    assert.ok(response.createdAt);
+    assert.ok(response.createdAt instanceof Date);
+    assert.ok(response.error instanceof ErrorResponse);
+    assert.equal(response.error.status, 500);
+    assert.equal(response.error.code, "500-012");
+  });
+});