handle various file types

Author: ianardee

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "mindee-ocr",
-  "version": "4.0.999",
+  "version": "4.0.0",
   "description": "Parse your document using the Mindee API.",
   "scripts": {
     "clean": "rimraf ./dist ./build",
@@ -18,7 +18,7 @@
     "zapier-platform-core": "17.8.0"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^8.46.0",
+    "@typescript-eslint/eslint-plugin": "~8.46",
     "vitest": "~2.1.9",
     "mocha": "~11.7.4",
     "ts-node": "~10.9.2",

package.json

@@ -26,7 +26,7 @@ export default {
       label: "Connection Name",
       required: true,
       type: "string",
-      helpText: "Name of the connection, should be in the format: `MindeeV2-` + your API key's name",
+      helpText: "Name of the connection. Suggested format: `MindeeV2 - ` + your API key's name",
     },
     {
       computed: false,
@@ -35,7 +35,7 @@ export default {
       required: true,
       type: "password",
       helpText:
-        "Mindee V2 API Key. Refer to: https://docs.mindee.com/integrations/api-keys for more information.",
+        "Your Mindee V2 API Key. [More Information](https://docs.mindee.com/integrations/api-keys).",
     },
   ]
 } satisfies Authentication;

src/authentication.ts

@@ -40,7 +40,8 @@ export const inferenceCreateFields = defineInputFields([
     choices: optionChoices,
     default: optionDefault,
     helpText:
-      "Enable automated workflows by enhancing model accuracy and measuring field confidence.",
+      "Enable automated workflows by enhancing model accuracy and measuring field confidence." +
+      "\nNot available on all plans.",
   },
   {
     key: "polygon",
@@ -49,7 +50,8 @@ export const inferenceCreateFields = defineInputFields([
     choices: optionChoices,
     default: optionDefault,
     helpText:
-      "Add the polygon coordinates of each extracted field to the API response.",
+      "Add the polygon coordinates of each extracted field to the API response." +
+      "\nNot available on all plans.",
   },
   {
     key: "rag",
@@ -58,7 +60,8 @@ export const inferenceCreateFields = defineInputFields([
     choices: optionChoices,
     default: optionDefault,
     helpText:
-      "Enhance extraction accuracy with Retrieval-Augmented Generation using your own documents.",
+      "Enhance extraction accuracy with Retrieval-Augmented Generation using your own documents." +
+      "\nRequires at least one training document configured for the model.",
   },
   {
     key: "rawText",

src/v2/api/inputFields.ts

@@ -79,8 +79,24 @@ export function setupEnqueueForm(bundle: Bundle): FormData {
   const form = new FormData();
 
   form.append("model_id", bundle.inputData.modelId);
-  // Zapier sends the file as a base64 string, so we cannot use the 'file' field.
-  form.append("file_base64", bundle.inputData.file);
+
+  const fileData: any = bundle.inputData.file;
+
+  // zapier can send the data in various ways
+  if (!fileData) {
+    throw new Error("No file provided");
+  }
+  if (typeof fileData === "object" && fileData.url) {
+    form.append("url", fileData.url);
+  } else if (typeof fileData === "string") {
+    if (fileData.startsWith("http")) {
+      form.append("url", fileData);
+    } else {
+      form.append("file_base64", fileData);
+    }
+  } else {
+    form.append("file", fileData);
+  }
 
   if (bundle.inputData.alias) {
     form.append("alias", bundle.inputData.alias);

src/v2/api/requests.ts

@@ -32,9 +32,9 @@ export default defineCreate({
   key: "v2_enqueue",
   noun: "Enqueue",
   display: {
-    label: "Enqueue a File",
-    description: "Send a file and return the job. " +
-      "You'll need to poll for the inference using the job ID.",
+    label: "Send a File to Queue",
+    description: "Add a file to the processing queue, and return the Job." +
+      " You'll need to poll for the inference result using the Job ID.",
     hidden: false,
   },
   operation: {

src/v2/creates/enqueue.ts

@@ -34,14 +34,12 @@ export default defineCreate({
   // see here for a full list of available properties:
   // https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#createschema
   key: "v2_enqueue_and_get_inference",
-  noun: "Send File and Get Inference",
-
+  noun: "Send and Process",
   display: {
-    label: "Send File and Get Inference",
-    description: "Send a file and return the inference result when it's ready.",
+    label: "Process a File",
+    description: "Send a file, process it, and return the inference result.",
     hidden: false,
   },
-
   operation: {
     perform: perform,
     inputFields: inputFields,

src/v2/creates/enqueue_and_get_inference.ts

@@ -37,8 +37,9 @@ export default defineSearch({
   key: "v2_inference",
   noun: "Inference",
   display: {
-    label: "Get Inference",
-    description: "Get an inference by its ID.",
+    label: "Get Inference Result",
+    description: "Get a processing result by its inference ID." +
+      " The file must have already been processed.",
     hidden: false,
   },
   operation: {

src/v2/searches/inference.ts

@@ -41,8 +41,9 @@ export default defineSearch({
   key: "v2_inference_by_polling",
   noun: "Inference by polling",
   display: {
-    label: "Poll for Inference",
-    description: "Poll for an inference using a job ID.",
+    label: "Poll for Result",
+    description: "Poll for an inference result using a job ID." +
+      " The file must already have been sent to the queue.",
     hidden: false,
   },
   operation: {

src/v2/searches/inference_by_polling.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import zapier from "zapier-platform-core";
+import zapier, { Bundle } from "zapier-platform-core";
 
 import App from "../../../index.js";
 import { blankPdfPath } from "../index.js";
@@ -9,29 +9,59 @@ const appTester = zapier.createAppTester(App);
 zapier.tools.env.inject();
 
 const modelId = process.env["MINDEE_V2_FINDOC_MODEL_ID"];
-const bundle: any = {
-  authData: {
-    apiKey: process.env["MINDEE_V2_API_KEY"],
-  },
-  inputData: {
-    file: fs.readFileSync(blankPdfPath).toString("base64"),
-    modelId: modelId,
-    alias: "zapier-test-enqueue",
-  }
-};
+
+async function assertJobResponse(bundle: Bundle) {
+  // @ts-expect-error TBD
+  const response: any = await appTester(App.creates["v2_enqueue"].operation.perform, bundle);
+
+  expect(response).toBeInstanceOf(Object);
+  expect(response.job).toBeInstanceOf(Object);
+  expect(response.job.status).toEqual("Processing");
+  expect(response.job.model_id).toEqual(modelId);
+  expect(response.job.alias).toEqual("zapier-test-enqueue");
+  expect(response.job.error).toBeNull;
+}
 
 describe("creates.enqueue", () => {
-  it("should run with default options", async () => {
-    delete bundle.inputData["polygon"];
-    delete bundle.inputData["confidence"];
-
-    // @ts-expect-error TBD
-    const response: any = await appTester(App.creates["v2_enqueue"].operation.perform, bundle);
-    expect(response).toBeInstanceOf(Object);
-    expect(response.job).toBeInstanceOf(Object);
-    expect(response.job.status).toEqual("Processing");
-    expect(response.job.model_id).toEqual(modelId);
-    expect(response.job.alias).toEqual("zapier-test-enqueue");
-    expect(response.job.error).toBeNull;
+  it("should send a base64 file", async () => {
+    const bundle: any = {
+      authData: {
+        apiKey: process.env["MINDEE_V2_API_KEY"],
+      },
+      inputData: {
+        file: fs.readFileSync(blankPdfPath).toString("base64"),
+        modelId: modelId,
+        alias: "zapier-test-enqueue-base64",
+      }
+    };
+    assertJobResponse(bundle);
+  }, 6000);
+
+  it("should send a file stream", async () => {
+    const bundle: any = {
+      authData: {
+        apiKey: process.env["MINDEE_V2_API_KEY"],
+      },
+      inputData: {
+        file: fs.createReadStream(blankPdfPath),
+        modelId: modelId,
+        alias: "zapier-test-enqueue-stream",
+      }
+    };
+    assertJobResponse(bundle);
+  }, 6000);
+
+  it("should send a URL", async () => {
+    const bundle: any = {
+      authData: {
+        apiKey: process.env["MINDEE_V2_API_KEY"],
+      },
+      inputData: {
+        file: "https://raw.githubusercontent.com/mindee/client-lib-test-data/refs/heads/main/file_types/receipt.jpg",
+        modelId: modelId,
+        alias: "zapier-test-enqueue-url",
+      }
+    };
+    assertJobResponse(bundle);
   }, 6000);
 });