@retab/node 1.0.76 → 1.0.78

package/dist/api/client.d.ts

@@ -5,6 +5,7 @@ import APISchemas from "./schemas/client";
 import APIProjects from "./projects/client";
 import APIExtractions from "./extractions/client";
 import APIWorkflows from "./workflows/client";
+import APIEdit from "./edit/client";
 export default class APIV1 extends CompositionClient {
     constructor(client: AbstractClient);
     models: APIModels;
@@ -13,5 +14,6 @@ export default class APIV1 extends CompositionClient {
     projects: APIProjects;
     extractions: APIExtractions;
     workflows: APIWorkflows;
+    edit: APIEdit;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/api/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,iBAAiB;gBACpC,MAAM,EAAE,cAAc;IAGlC,MAAM,YAAuB;IAC7B,SAAS,eAA0B;IACnC,OAAO,aAAwB;IAC/B,QAAQ,cAAyB;IACjC,WAAW,iBAA4B;IACvC,SAAS,eAA0B;CACtC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,iBAAiB;gBACpC,MAAM,EAAE,cAAc;IAGlC,MAAM,YAAuB;IAC7B,SAAS,eAA0B;IACnC,OAAO,aAAwB;IAC/B,QAAQ,cAAyB;IACjC,WAAW,iBAA4B;IACvC,SAAS,eAA0B;IACnC,IAAI,UAAqB;CAC5B"}

package/dist/api/client.js

@@ -5,6 +5,7 @@ import APISchemas from "./schemas/client";
 import APIProjects from "./projects/client";
 import APIExtractions from "./extractions/client";
 import APIWorkflows from "./workflows/client";
+import APIEdit from "./edit/client";
 export default class APIV1 extends CompositionClient {
     constructor(client) {
         super(client);
@@ -14,5 +15,6 @@ export default class APIV1 extends CompositionClient {
         this.projects = new APIProjects(this);
         this.extractions = new APIExtractions(this);
         this.workflows = new APIWorkflows(this);
+        this.edit = new APIEdit(this);
     }
 }

package/dist/api/documents/client.d.ts

@@ -1,6 +1,6 @@
 import { CompositionClient, RequestOptions } from "../../client.js";
-import { DocumentExtractRequest, RetabParsedChatCompletion, ParseRequest, ParseResult, DocumentCreateMessageRequest, DocumentMessage, DocumentCreateInputRequest, RetabParsedChatCompletionChunk, EditRequest, EditResponse, SplitRequest } from "../../types.js";
-import type { SplitResponse } from "../../generated_types.js";
+import { DocumentExtractRequest, RetabParsedChatCompletion, ParseRequest, ParseResult, DocumentCreateMessageRequest, DocumentMessage, DocumentCreateInputRequest, RetabParsedChatCompletionChunk, EditRequest, EditResponse, SplitRequest, ClassifyRequest } from "../../types.js";
+import type { SplitResponse, ClassifyResponse } from "../../generated_types.js";
 export default class APIDocuments extends CompositionClient {
     constructor(client: CompositionClient);
     extract(params: DocumentExtractRequest, options?: RequestOptions): Promise<RetabParsedChatCompletion>;
@@ -58,5 +58,35 @@ export default class APIDocuments extends CompositionClient {
      * ```
      */
     split(params: SplitRequest, options?: RequestOptions): Promise<SplitResponse>;
+    /**
+     * Classify a document into one of the provided categories.
+     *
+     * This method analyzes a document and classifies it into exactly one
+     * of the user-defined categories, returning the classification with
+     * chain-of-thought reasoning explaining the decision.
+     *
+     * @param params - ClassifyRequest containing:
+     *   - document: MIMEData object, file path, Buffer, or Readable stream
+     *   - categories: Array of categories with 'name' and 'description'
+     *   - model: LLM model for inference (e.g., "retab-small")
+     * @param options - Optional request options
+     * @returns ClassifyResponse containing result with reasoning and classification
+     *
+     * @example
+     * ```typescript
+     * const response = await retab.documents.classify({
+     *     document: "invoice.pdf",
+     *     model: "retab-small",
+     *     categories: [
+     *         { name: "invoice", description: "Invoice documents with billing information" },
+     *         { name: "receipt", description: "Receipt documents for payments" },
+     *         { name: "contract", description: "Legal contract documents" },
+     *     ]
+     * });
+     * console.log(`Classification: ${response.result.classification}`);
+     * console.log(`Reasoning: ${response.result.reasoning}`);
+     * ```
+     */
+    classify(params: ClassifyRequest, options?: RequestOptions): Promise<ClassifyResponse>;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/api/documents/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/documents/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAA2B,sBAAsB,EAAE,yBAAyB,EAA8B,YAAY,EAAE,WAAW,EAA+B,4BAA4B,EAAE,eAAe,EAAmD,0BAA0B,EAA+B,8BAA8B,EAAmC,WAAW,EAAE,YAAY,EAA+B,YAAY,EAAiC,MAAM,gBAAgB,CAAC;AAC/f,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAG9D,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,iBAAiB;gBAC3C,MAAM,EAAE,iBAAiB;IAG/B,OAAO,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAUrG,cAAc,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;IAUjI,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAS3E,eAAe,CAAC,MAAM,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IASzG,aAAa,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAS3G;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAShF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;CAStF"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/documents/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAA2B,sBAAsB,EAAE,yBAAyB,EAA8B,YAAY,EAAE,WAAW,EAA+B,4BAA4B,EAAE,eAAe,EAAmD,0BAA0B,EAA+B,8BAA8B,EAAmC,WAAW,EAAE,YAAY,EAA+B,YAAY,EAAiC,eAAe,EAAuC,MAAM,gBAAgB,CAAC;AACrjB,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAGhF,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,iBAAiB;gBAC3C,MAAM,EAAE,iBAAiB;IAG/B,OAAO,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAUrG,cAAc,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;IAUjI,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAS3E,eAAe,CAAC,MAAM,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IASzG,aAAa,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAS3G;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAShF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IASnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAS/F"}

package/dist/api/documents/client.js

@@ -1,5 +1,5 @@
 import { CompositionClient } from "../../client.js";
-import { ZDocumentExtractRequest, ZRetabParsedChatCompletion, ZParseResult, ZParseRequest, ZDocumentMessage, ZDocumentCreateMessageRequest, ZDocumentCreateInputRequest, ZRetabParsedChatCompletionChunk, ZEditRequest, ZEditResponse, ZSplitRequest, ZSplitResponse } from "../../types.js";
+import { ZDocumentExtractRequest, ZRetabParsedChatCompletion, ZParseResult, ZParseRequest, ZDocumentMessage, ZDocumentCreateMessageRequest, ZDocumentCreateInputRequest, ZRetabParsedChatCompletionChunk, ZEditRequest, ZEditResponse, ZSplitRequest, ZSplitResponse, ZClassifyRequest, ZClassifyResponse } from "../../types.js";
 export default class APIDocuments extends CompositionClient {
     constructor(client) {
         super(client);
@@ -117,4 +117,42 @@ export default class APIDocuments extends CompositionClient {
             headers: options?.headers,
         });
     }
+    /**
+     * Classify a document into one of the provided categories.
+     *
+     * This method analyzes a document and classifies it into exactly one
+     * of the user-defined categories, returning the classification with
+     * chain-of-thought reasoning explaining the decision.
+     *
+     * @param params - ClassifyRequest containing:
+     *   - document: MIMEData object, file path, Buffer, or Readable stream
+     *   - categories: Array of categories with 'name' and 'description'
+     *   - model: LLM model for inference (e.g., "retab-small")
+     * @param options - Optional request options
+     * @returns ClassifyResponse containing result with reasoning and classification
+     *
+     * @example
+     * ```typescript
+     * const response = await retab.documents.classify({
+     *     document: "invoice.pdf",
+     *     model: "retab-small",
+     *     categories: [
+     *         { name: "invoice", description: "Invoice documents with billing information" },
+     *         { name: "receipt", description: "Receipt documents for payments" },
+     *         { name: "contract", description: "Legal contract documents" },
+     *     ]
+     * });
+     * console.log(`Classification: ${response.result.classification}`);
+     * console.log(`Reasoning: ${response.result.reasoning}`);
+     * ```
+     */
+    async classify(params, options) {
+        return this._fetchJson(ZClassifyResponse, {
+            url: "/v1/documents/classify",
+            method: "POST",
+            body: { ...(await ZClassifyRequest.parseAsync(params)), ...(options?.body || {}) },
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
 }

package/dist/api/edit/client.d.ts

@@ -0,0 +1,34 @@
+import { CompositionClient, RequestOptions } from "../../client.js";
+import { EditRequest, EditResponse } from "../../types.js";
+import APIEditTemplates from "./templates/client.js";
+export default class APIEdit extends CompositionClient {
+    templates: APIEditTemplates;
+    constructor(client: CompositionClient);
+    /**
+     * Edit a document by detecting and filling form fields with provided instructions.
+     *
+     * This method performs:
+     * 1. Detection to identify form field bounding boxes
+     * 2. LLM inference to name and describe detected fields
+     * 3. LLM-based form filling using the provided instructions
+     * 4. Returns the filled document with form field values populated
+     *
+     * Either `document` OR `template_id` must be provided, but not both.
+     *
+     * Supported document formats:
+     * - PDF: Native form field detection and filling
+     * - DOCX/DOC: Native editing to preserve styles and formatting
+     * - PPTX/PPT: Native editing for presentations
+     * - XLSX/XLS: Native editing for spreadsheets
+     *
+     * @param params - EditRequest containing:
+     *   - filling_instructions: Natural language instructions for filling (required)
+     *   - document: MIMEData object, file path, Buffer, or Readable stream (optional, mutually exclusive with template_id)
+     *   - model: LLM model for inference (default: "retab-small")
+     *   - template_id: Template ID to use for filling with pre-defined form fields (optional, mutually exclusive with document)
+     * @param options - Optional request options
+     * @returns EditResponse containing form_data (filled fields) and filled_document (MIMEData)
+     */
+    fill_document(params: EditRequest, options?: RequestOptions): Promise<EditResponse>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/api/edit/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/edit/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EACH,WAAW,EACX,YAAY,EAGf,MAAM,gBAAgB,CAAC;AACxB,OAAO,gBAAgB,MAAM,uBAAuB,CAAC;AAErD,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,iBAAiB;IAC3C,SAAS,EAAE,gBAAgB,CAAC;gBAEvB,MAAM,EAAE,iBAAiB;IAKrC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;CAS5F"}

package/dist/api/edit/client.js

@@ -0,0 +1,43 @@
+import { CompositionClient } from "../../client.js";
+import { ZEditRequest, ZEditResponse, } from "../../types.js";
+import APIEditTemplates from "./templates/client.js";
+export default class APIEdit extends CompositionClient {
+    constructor(client) {
+        super(client);
+        this.templates = new APIEditTemplates(this);
+    }
+    /**
+     * Edit a document by detecting and filling form fields with provided instructions.
+     *
+     * This method performs:
+     * 1. Detection to identify form field bounding boxes
+     * 2. LLM inference to name and describe detected fields
+     * 3. LLM-based form filling using the provided instructions
+     * 4. Returns the filled document with form field values populated
+     *
+     * Either `document` OR `template_id` must be provided, but not both.
+     *
+     * Supported document formats:
+     * - PDF: Native form field detection and filling
+     * - DOCX/DOC: Native editing to preserve styles and formatting
+     * - PPTX/PPT: Native editing for presentations
+     * - XLSX/XLS: Native editing for spreadsheets
+     *
+     * @param params - EditRequest containing:
+     *   - filling_instructions: Natural language instructions for filling (required)
+     *   - document: MIMEData object, file path, Buffer, or Readable stream (optional, mutually exclusive with template_id)
+     *   - model: LLM model for inference (default: "retab-small")
+     *   - template_id: Template ID to use for filling with pre-defined form fields (optional, mutually exclusive with document)
+     * @param options - Optional request options
+     * @returns EditResponse containing form_data (filled fields) and filled_document (MIMEData)
+     */
+    async fill_document(params, options) {
+        return this._fetchJson(ZEditResponse, {
+            url: "/v1/edit/fill-document",
+            method: "POST",
+            body: { ...(await ZEditRequest.parseAsync(params)), ...(options?.body || {}) },
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+}

package/dist/api/edit/templates/client.d.ts

@@ -0,0 +1,125 @@
+import { CompositionClient, RequestOptions } from "../../../client.js";
+import { PaginatedList, InferFormSchemaRequest, InferFormSchemaResponse, MIMEDataInput, EditResponse } from "../../../types.js";
+import { EditTemplate, FormField } from "../../../generated_types.js";
+export default class APIEditTemplates extends CompositionClient {
+    constructor(client: CompositionClient);
+    /**
+     * List edit templates with pagination and optional filtering.
+     *
+     * @param params - Pagination and filter parameters
+     * @param options - Optional request options
+     * @returns PaginatedList of EditTemplate objects
+     */
+    list({ before, after, limit, order, filename, mime_type, include_embeddings, sort_by, }?: {
+        before?: string;
+        after?: string;
+        limit?: number;
+        order?: "asc" | "desc";
+        filename?: string;
+        mime_type?: string;
+        include_embeddings?: boolean;
+        sort_by?: string;
+    }, options?: RequestOptions): Promise<PaginatedList>;
+    /**
+     * Get an edit template by ID.
+     *
+     * @param template_id - The ID of the template to retrieve
+     * @param options - Optional request options
+     * @returns EditTemplate object
+     */
+    get(template_id: string, options?: RequestOptions): Promise<EditTemplate>;
+    /**
+     * Create a new edit template.
+     *
+     * @param params - CreateEditTemplateRequest containing:
+     *   - name: Name of the template
+     *   - document: The document to use as a template (MIMEData, file path, Buffer, or Readable)
+     *   - form_fields: Array of form field definitions
+     * @param options - Optional request options
+     * @returns EditTemplate object
+     */
+    create({ name, document, form_fields, }: {
+        name: string;
+        document: MIMEDataInput;
+        form_fields: FormField[];
+    }, options?: RequestOptions): Promise<EditTemplate>;
+    /**
+     * Update an existing edit template.
+     *
+     * @param template_id - The ID of the template to update
+     * @param params - UpdateEditTemplateRequest containing optional fields to update:
+     *   - name: New name for the template
+     *   - form_fields: Updated array of form field definitions
+     * @param options - Optional request options
+     * @returns EditTemplate object
+     */
+    update(template_id: string, { name, form_fields, }?: {
+        name?: string;
+        form_fields?: FormField[];
+    }, options?: RequestOptions): Promise<EditTemplate>;
+    /**
+     * Delete an edit template by ID.
+     *
+     * @param template_id - The ID of the template to delete
+     * @param options - Optional request options
+     */
+    delete(template_id: string, options?: RequestOptions): Promise<void>;
+    /**
+     * Duplicate an existing edit template.
+     *
+     * @param template_id - The ID of the template to duplicate
+     * @param params - DuplicateEditTemplateRequest containing optional:
+     *   - name: Name for the duplicated template (defaults to "{original_name} (copy)")
+     * @param options - Optional request options
+     * @returns EditTemplate object (the new duplicated template)
+     */
+    duplicate(template_id: string, { name }?: {
+        name?: string;
+    }, options?: RequestOptions): Promise<EditTemplate>;
+    /**
+     * Generate (infer) form schema from a PDF document.
+     *
+     * This method combines computer vision for precise bounding box detection
+     * with LLM for semantic field naming (key, description) and type classification.
+     *
+     * Supported document formats:
+     * - PDF: Direct processing (only PDF is supported)
+     *
+     * @param params - InferFormSchemaRequest containing:
+     *   - document: MIMEData object, file path, Buffer, or Readable stream
+     *   - model: LLM model for field naming (default: "retab-small")
+     *   - instructions: Optional instructions to guide form field detection
+     * @param options - Optional request options
+     * @returns InferFormSchemaResponse containing:
+     *   - form_schema: The detected form schema with field keys, descriptions, types, and bounding boxes
+     *   - annotated_pdf: PDF with bounding boxes drawn around detected fields for visual verification
+     *   - field_count: Number of fields detected
+     */
+    generate(params: InferFormSchemaRequest, options?: RequestOptions): Promise<InferFormSchemaResponse>;
+    /**
+     * Fill a PDF form using a pre-defined template.
+     *
+     * This method uses a template's pre-defined form fields to fill a PDF form,
+     * skipping the field detection step for faster processing.
+     *
+     * Use cases:
+     * - Batch processing of the same form with different data
+     * - Faster form filling when field detection is already done
+     * - Consistent field mapping across multiple fills
+     *
+     * @param params - Fill request containing:
+     *   - template_id: The template ID to use for filling
+     *   - filling_instructions: Instructions describing how to fill the form fields
+     *   - model: LLM model for inference (default: "retab-small")
+     * @param options - Optional request options
+     * @returns EditResponse containing:
+     *   - form_data: List of form fields with filled values
+     *   - filled_document: The filled PDF document as MIMEData
+     */
+    fill({ template_id, filling_instructions, model, }: {
+        template_id: string;
+        filling_instructions: string;
+        model?: string;
+    }, options?: RequestOptions): Promise<EditResponse>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/api/edit/templates/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/api/edit/templates/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EAEH,aAAa,EACb,sBAAsB,EACtB,uBAAuB,EAGvB,aAAa,EAEb,YAAY,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACH,YAAY,EAEZ,SAAS,EACZ,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,iBAAiB;gBAC/C,MAAM,EAAE,iBAAiB;IAIrC;;;;;;OAMG;IACG,IAAI,CACN,EACI,MAAM,EACN,KAAK,EACL,KAAU,EACV,KAAc,EACd,QAAQ,EACR,SAAS,EACT,kBAA0B,EAC1B,OAAsB,GACzB,GAAE;QACC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;KACf,EACN,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,aAAa,CAAC;IAyBzB;;;;;;OAMG;IACG,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAS/E;;;;;;;;;OASG;IACG,MAAM,CACR,EACI,IAAI,EACJ,QAAQ,EACR,WAAW,GACd,EAAE;QACC,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,aAAa,CAAC;QACxB,WAAW,EAAE,SAAS,EAAE,CAAC;KAC5B,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;IAiBxB;;;;;;;;;OASG;IACG,MAAM,CACR,WAAW,EAAE,MAAM,EACnB,EACI,IAAI,EACJ,WAAW,GACd,GAAE;QACC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,SAAS,EAAE,CAAC;KACxB,EACN,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;IAcxB;;;;;OAKG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAS1E;;;;;;;;OAQG;IACG,SAAS,CACX,WAAW,EAAE,MAAM,EACnB,EAAE,IAAI,EAAE,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO,EAChC,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;IAaxB;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CACV,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,uBAAuB,CAAC;IAUnC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,IAAI,CACN,EACI,WAAW,EACX,oBAAoB,EACpB,KAAqB,GACxB,EAAE;QACC,WAAW,EAAE,MAAM,CAAC;QACpB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;KAClB,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;CAc3B"}

package/dist/api/edit/templates/client.js

@@ -0,0 +1,196 @@
+import { CompositionClient } from "../../../client.js";
+import { ZPaginatedList, ZInferFormSchemaRequest, ZInferFormSchemaResponse, ZMIMEData, ZEditResponse, } from "../../../types.js";
+import { ZEditTemplate, } from "../../../generated_types.js";
+export default class APIEditTemplates extends CompositionClient {
+    constructor(client) {
+        super(client);
+    }
+    /**
+     * List edit templates with pagination and optional filtering.
+     *
+     * @param params - Pagination and filter parameters
+     * @param options - Optional request options
+     * @returns PaginatedList of EditTemplate objects
+     */
+    async list({ before, after, limit = 10, order = "desc", filename, mime_type, include_embeddings = false, sort_by = "created_at", } = {}, options) {
+        const params = {
+            before,
+            after,
+            limit,
+            order,
+            filename,
+            mime_type,
+            include_embeddings,
+            sort_by,
+        };
+        // Remove undefined values
+        const cleanParams = Object.fromEntries(Object.entries(params).filter(([_, v]) => v !== undefined));
+        return this._fetchJson(ZPaginatedList, {
+            url: "/v1/edit/templates",
+            method: "GET",
+            params: { ...cleanParams, ...(options?.params || {}) },
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Get an edit template by ID.
+     *
+     * @param template_id - The ID of the template to retrieve
+     * @param options - Optional request options
+     * @returns EditTemplate object
+     */
+    async get(template_id, options) {
+        return this._fetchJson(ZEditTemplate, {
+            url: `/v1/edit/templates/${template_id}`,
+            method: "GET",
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Create a new edit template.
+     *
+     * @param params - CreateEditTemplateRequest containing:
+     *   - name: Name of the template
+     *   - document: The document to use as a template (MIMEData, file path, Buffer, or Readable)
+     *   - form_fields: Array of form field definitions
+     * @param options - Optional request options
+     * @returns EditTemplate object
+     */
+    async create({ name, document, form_fields, }, options) {
+        const parsedDocument = await ZMIMEData.parseAsync(document);
+        return this._fetchJson(ZEditTemplate, {
+            url: "/v1/edit/templates",
+            method: "POST",
+            body: {
+                name,
+                document: parsedDocument,
+                form_fields,
+                ...(options?.body || {}),
+            },
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Update an existing edit template.
+     *
+     * @param template_id - The ID of the template to update
+     * @param params - UpdateEditTemplateRequest containing optional fields to update:
+     *   - name: New name for the template
+     *   - form_fields: Updated array of form field definitions
+     * @param options - Optional request options
+     * @returns EditTemplate object
+     */
+    async update(template_id, { name, form_fields, } = {}, options) {
+        const body = {};
+        if (name !== undefined)
+            body.name = name;
+        if (form_fields !== undefined)
+            body.form_fields = form_fields;
+        return this._fetchJson(ZEditTemplate, {
+            url: `/v1/edit/templates/${template_id}`,
+            method: "PATCH",
+            body: { ...body, ...(options?.body || {}) },
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Delete an edit template by ID.
+     *
+     * @param template_id - The ID of the template to delete
+     * @param options - Optional request options
+     */
+    async delete(template_id, options) {
+        return this._fetchJson({
+            url: `/v1/edit/templates/${template_id}`,
+            method: "DELETE",
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Duplicate an existing edit template.
+     *
+     * @param template_id - The ID of the template to duplicate
+     * @param params - DuplicateEditTemplateRequest containing optional:
+     *   - name: Name for the duplicated template (defaults to "{original_name} (copy)")
+     * @param options - Optional request options
+     * @returns EditTemplate object (the new duplicated template)
+     */
+    async duplicate(template_id, { name } = {}, options) {
+        const body = {};
+        if (name !== undefined)
+            body.name = name;
+        return this._fetchJson(ZEditTemplate, {
+            url: `/v1/edit/templates/${template_id}/duplicate`,
+            method: "POST",
+            body: { ...body, ...(options?.body || {}) },
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Generate (infer) form schema from a PDF document.
+     *
+     * This method combines computer vision for precise bounding box detection
+     * with LLM for semantic field naming (key, description) and type classification.
+     *
+     * Supported document formats:
+     * - PDF: Direct processing (only PDF is supported)
+     *
+     * @param params - InferFormSchemaRequest containing:
+     *   - document: MIMEData object, file path, Buffer, or Readable stream
+     *   - model: LLM model for field naming (default: "retab-small")
+     *   - instructions: Optional instructions to guide form field detection
+     * @param options - Optional request options
+     * @returns InferFormSchemaResponse containing:
+     *   - form_schema: The detected form schema with field keys, descriptions, types, and bounding boxes
+     *   - annotated_pdf: PDF with bounding boxes drawn around detected fields for visual verification
+     *   - field_count: Number of fields detected
+     */
+    async generate(params, options) {
+        return this._fetchJson(ZInferFormSchemaResponse, {
+            url: "/v1/edit/templates/generate",
+            method: "POST",
+            body: { ...(await ZInferFormSchemaRequest.parseAsync(params)), ...(options?.body || {}) },
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Fill a PDF form using a pre-defined template.
+     *
+     * This method uses a template's pre-defined form fields to fill a PDF form,
+     * skipping the field detection step for faster processing.
+     *
+     * Use cases:
+     * - Batch processing of the same form with different data
+     * - Faster form filling when field detection is already done
+     * - Consistent field mapping across multiple fills
+     *
+     * @param params - Fill request containing:
+     *   - template_id: The template ID to use for filling
+     *   - filling_instructions: Instructions describing how to fill the form fields
+     *   - model: LLM model for inference (default: "retab-small")
+     * @param options - Optional request options
+     * @returns EditResponse containing:
+     *   - form_data: List of form fields with filled values
+     *   - filled_document: The filled PDF document as MIMEData
+     */
+    async fill({ template_id, filling_instructions, model = "retab-small", }, options) {
+        return this._fetchJson(ZEditResponse, {
+            url: "/v1/edit/templates/fill",
+            method: "POST",
+            body: {
+                template_id,
+                filling_instructions,
+                model,
+                ...(options?.body || {}),
+            },
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+}

package/dist/client.js

@@ -103,7 +103,7 @@ export class FetcherClient extends AbstractClient {
     constructor(options) {
         super();
         this.options = options || {};
-        this.timeout = this.options.timeout ?? 1800000; // Default 1800 seconds (in milliseconds)
+        this.timeout = this.options.timeout ?? 1800000; // Default 1800 seconds (30 minutes) (in milliseconds)
         // Validate that at least one authentication method is provided
         const apiKey = "apiKey" in this.options ? this.options.apiKey : process.env["RETAB_API_KEY"];
         if (!apiKey) {