Skip to content

Add utility support #418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ianardee wants to merge 5 commits into
base: release/5.0.0-alpha1
Choose a base branch
from
Draft

Add utility support #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ff782b7
:boom: :recycle: base for v5 (#413)
ianardee Jan 9, 2026
676fb7d
:boom: complete rework of directory structure (#415)
ianardee Jan 13, 2026
0b43af6
:bug: fix examples (#416)
ianardee Jan 13, 2026
770cd08
:recycle: rework v2 client parameters (#417)
ianardee Jan 14, 2026
23657a9
initial idea for utilities in client
ianardee Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/_static-analysis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 18
node-version: 22
cache: "npm"

- name: Install Node.js dependencies
Expand Down
2 changes: 1 addition & 1 deletion .mocharc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://json.schemastore.org/mocharc",
"extension": ["ts"],
"require": "ts-node/register",
"node-option": ["import=tsx"],
"spec": ["tests"]
}
5 changes: 0 additions & 5 deletions bin/mindee.ts
View file
Open in desktop

This file was deleted.

5 changes: 5 additions & 0 deletions bin/mindeeV1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/usr/bin/env node

import { cli } from "@/v1/cli.js";

cli();
5 changes: 5 additions & 0 deletions bin/mindeeV2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/usr/bin/env node

import { cli } from "@/v2/cli.js";

cli();
6 changes: 4 additions & 2 deletions docs/code_samples/bank_account_details_v1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ const mindee = require("mindee");
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
const mindeeClient = new mindee.v1.Client(
{ apiKey: "my-api-key" }
);

// Load a file from disk
const inputSource = new mindee.PathInput(
Expand All @@ -12,7 +14,7 @@ const inputSource = new mindee.PathInput(

// Parse the file
const apiResponse = mindeeClient.parse(
mindee.product.fr.BankAccountDetailsV1,
mindee.v1.product.fr.BankAccountDetailsV1,
inputSource
);

Expand Down
6 changes: 4 additions & 2 deletions docs/code_samples/bank_account_details_v2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ const mindee = require("mindee");
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
const mindeeClient = new mindee.v1.Client(
{ apiKey: "my-api-key" }
);

// Load a file from disk
const inputSource = new mindee.PathInput(
Expand All @@ -12,7 +14,7 @@ const inputSource = new mindee.PathInput(

// Parse the file
const apiResponse = mindeeClient.parse(
mindee.product.fr.BankAccountDetailsV2,
mindee.v1.product.fr.BankAccountDetailsV2,
inputSource
);

Expand Down
6 changes: 4 additions & 2 deletions docs/code_samples/bank_check_v1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ const mindee = require("mindee");
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
const mindeeClient = new mindee.v1.Client(
{ apiKey: "my-api-key" }
);

// Load a file from disk
const inputSource = new mindee.PathInput(
Expand All @@ -12,7 +14,7 @@ const inputSource = new mindee.PathInput(

// Parse the file
const apiResponse = mindeeClient.parse(
mindee.product.us.BankCheckV1,
mindee.v1.product.us.BankCheckV1,
inputSource
);

Expand Down
6 changes: 4 additions & 2 deletions docs/code_samples/barcode_reader_v1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ const mindee = require("mindee");
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
const mindeeClient = new mindee.v1.Client(
{ apiKey: "my-api-key" }
);

// Load a file from disk
const inputSource = new mindee.PathInput(
Expand All @@ -12,7 +14,7 @@ const inputSource = new mindee.PathInput(

// Parse the file
const apiResponse = mindeeClient.parse(
mindee.product.BarcodeReaderV1,
mindee.v1.product.BarcodeReaderV1,
inputSource
);

Expand Down
23 changes: 0 additions & 23 deletions docs/code_samples/bill_of_lading_v1_async.txt
View file
Open in desktop

This file was deleted.

23 changes: 0 additions & 23 deletions docs/code_samples/business_card_v1_async.txt
View file
Open in desktop

This file was deleted.

6 changes: 4 additions & 2 deletions docs/code_samples/carte_grise_v1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ const mindee = require("mindee");
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
const mindeeClient = new mindee.v1.Client(
{ apiKey: "my-api-key" }
);

// Load a file from disk
const inputSource = new mindee.PathInput(
Expand All @@ -12,7 +14,7 @@ const inputSource = new mindee.PathInput(

// Parse the file
const apiResponse = mindeeClient.parse(
mindee.product.fr.CarteGriseV1,
mindee.v1.product.fr.CarteGriseV1,
inputSource
);

Expand Down
6 changes: 4 additions & 2 deletions docs/code_samples/cropper_v1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ const mindee = require("mindee");
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
const mindeeClient = new mindee.v1.Client(
{ apiKey: "my-api-key" }
);

// Load a file from disk
const inputSource = new mindee.PathInput(
Expand All @@ -12,7 +14,7 @@ const inputSource = new mindee.PathInput(

// Parse the file
const apiResponse = mindeeClient.parse(
mindee.product.CropperV1,
mindee.v1.product.CropperV1,
inputSource
);

Expand Down
32 changes: 0 additions & 32 deletions docs/code_samples/custom_v1.txt
View file
Open in desktop

This file was deleted.

6 changes: 4 additions & 2 deletions docs/code_samples/default.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ const mindee = require("mindee");
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
const mindeeClient = new mindee.v1.Client(
{ apiKey: "my-api-key" }
);

// Load a file from disk
const inputSource = new mindee.PathInput(
Expand All @@ -20,7 +22,7 @@ const customEndpoint = mindeeClient.createEndpoint(
// Parse the file.
const apiResponse = mindeeClient
.parse(
mindee.product.GeneratedV1,
mindee.v1.product.GeneratedV1,
inputSource,
{ endpoint: customEndpoint }
);
Expand Down
6 changes: 4 additions & 2 deletions docs/code_samples/default_async.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ const mindee = require("mindee");
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
const mindeeClient = new mindee.v1.Client(
{ apiKey: "my-api-key" }
);

// Load a file from disk
const inputSource = new mindee.PathInput(
Expand All @@ -19,7 +21,7 @@ const customEndpoint = mindeeClient.createEndpoint(

// Parse the file asynchronously.
const asyncApiResponse = mindeeClient.enqueueAndParse(
mindee.product.GeneratedV1,
mindee.v1.product.GeneratedV1,
inputSource,
{ endpoint: customEndpoint }
);
Expand Down
6 changes: 4 additions & 2 deletions docs/code_samples/default_v2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ const filePath = "/path/to/the/file.ext";
const modelId = "MY_MODEL_ID";

// Init a new client
const mindeeClient = new mindee.ClientV2({ apiKey: apiKey });
const mindeeClient = new mindee.Client(
{ apiKey: apiKey }
);

// Set inference parameters
const inferenceParams = {
Expand All @@ -30,7 +32,7 @@ const inferenceParams = {
const inputSource = new mindee.PathInput({ inputPath: filePath });

// Send for processing
const response = mindeeClient.enqueueAndGetInference(
const response = mindeeClient.enqueueAndGetExtraction(
inputSource,
inferenceParams
);
Expand Down
23 changes: 0 additions & 23 deletions docs/code_samples/delivery_notes_v1_async.txt
View file
Open in desktop

This file was deleted.

6 changes: 4 additions & 2 deletions docs/code_samples/driver_license_v1_async.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ const mindee = require("mindee");
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
const mindeeClient = new mindee.v1.Client(
{ apiKey: "my-api-key" }
);

// Load a file from disk
const inputSource = new mindee.PathInput(
Expand All @@ -12,7 +14,7 @@ const inputSource = new mindee.PathInput(

// Parse the file
const apiResponse = mindeeClient.enqueueAndParse(
mindee.product.DriverLicenseV1,
mindee.v1.product.DriverLicenseV1,
inputSource
);

Expand Down
6 changes: 4 additions & 2 deletions docs/code_samples/energy_bill_fra_v1_async.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ const mindee = require("mindee");
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
const mindeeClient = new mindee.v1.Client(
{ apiKey: "my-api-key" }
);

// Load a file from disk
const inputSource = new mindee.PathInput(
Expand All @@ -12,7 +14,7 @@ const inputSource = new mindee.PathInput(

// Parse the file
const apiResponse = mindeeClient.enqueueAndParse(
mindee.product.fr.EnergyBillV1,
mindee.v1.product.fr.EnergyBillV1,
inputSource
);

Expand Down
6 changes: 4 additions & 2 deletions docs/code_samples/expense_receipts_v5.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ const mindee = require("mindee");
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
const mindeeClient = new mindee.v1.Client(
{ apiKey: "my-api-key" }
);

// Load a file from disk
const inputSource = new mindee.PathInput(
Expand All @@ -12,7 +14,7 @@ const inputSource = new mindee.PathInput(

// Parse the file
const apiResponse = mindeeClient.parse(
mindee.product.ReceiptV5,
mindee.v1.product.ReceiptV5,
inputSource
);

Expand Down
6 changes: 4 additions & 2 deletions docs/code_samples/expense_receipts_v5_async.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ const mindee = require("mindee");
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
const mindeeClient = new mindee.v1.Client(
{ apiKey: "my-api-key" }
);

// Load a file from disk
const inputSource = new mindee.PathInput(
Expand All @@ -12,7 +14,7 @@ const inputSource = new mindee.PathInput(

// Parse the file
const apiResponse = mindeeClient.enqueueAndParse(
mindee.product.ReceiptV5,
mindee.v1.product.ReceiptV5,
inputSource
);

Expand Down
Loading