@retab/node 1.0.64 → 1.0.67

package/dist/api/client.d.ts

@@ -3,11 +3,13 @@ import APIModels from "./models/client";
 import APIDocuments from "./documents/client";
 import APISchemas from "./schemas/client";
 import APIProjects from "./projects/client";
+import APIExtractions from "./extractions/client";
 export default class APIV1 extends CompositionClient {
     constructor(client: AbstractClient);
     models: APIModels;
     documents: APIDocuments;
     schemas: APISchemas;
     projects: APIProjects;
+    extractions: APIExtractions;
 }
 //# 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;AAE5C,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,iBAAiB;gBACpC,MAAM,EAAE,cAAc;IAGlC,MAAM,YAAuB;IAC7B,SAAS,eAA0B;IACnC,OAAO,aAAwB;IAC/B,QAAQ,cAAyB;CACpC"}
+{"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;AAElD,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;CAC1C"}

package/dist/api/client.js

@@ -3,6 +3,7 @@ import APIModels from "./models/client";
 import APIDocuments from "./documents/client";
 import APISchemas from "./schemas/client";
 import APIProjects from "./projects/client";
+import APIExtractions from "./extractions/client";
 export default class APIV1 extends CompositionClient {
     constructor(client) {
         super(client);
@@ -10,5 +11,6 @@ export default class APIV1 extends CompositionClient {
         this.documents = new APIDocuments(this);
         this.schemas = new APISchemas(this);
         this.projects = new APIProjects(this);
+        this.extractions = new APIExtractions(this);
     }
 }

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

@@ -0,0 +1,124 @@
+import { CompositionClient, RequestOptions } from "../../client.js";
+import { PaginatedList } from "../../types.js";
+import * as z from "zod";
+declare const ZExtractionCountResponse: z.ZodObject<{
+    count: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    count: number;
+}, {
+    count: number;
+}>;
+type ExtractionCountResponse = z.infer<typeof ZExtractionCountResponse>;
+declare const ZDownloadResponse: z.ZodObject<{
+    download_url: z.ZodString;
+    filename: z.ZodString;
+    expires_at: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    filename: string;
+    expires_at: string;
+    download_url: string;
+}, {
+    filename: string;
+    expires_at: string;
+    download_url: string;
+}>;
+type DownloadResponse = z.infer<typeof ZDownloadResponse>;
+declare const ZExportToCsvResponse: z.ZodObject<{
+    csv_data: z.ZodString;
+    rows: z.ZodNumber;
+    columns: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    rows: number;
+    csv_data: string;
+    columns: number;
+}, {
+    rows: number;
+    csv_data: string;
+    columns: number;
+}>;
+type ExportToCsvResponse = z.infer<typeof ZExportToCsvResponse>;
+declare const ZDistinctFieldValues: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>;
+type DistinctFieldValues = z.infer<typeof ZDistinctFieldValues>;
+declare const ZExtraction: z.ZodRecord<z.ZodString, z.ZodAny>;
+type Extraction = z.infer<typeof ZExtraction>;
+export default class APIExtractions extends CompositionClient {
+    constructor(client: CompositionClient);
+    /**
+     * List extractions with pagination and filtering.
+     */
+    list({ before, after, limit, order, origin_dot_type, origin_dot_id, from_date, to_date, human_review_status, metadata, filename, }?: {
+        before?: string;
+        after?: string;
+        limit?: number;
+        order?: "asc" | "desc";
+        origin_dot_type?: string;
+        origin_dot_id?: string;
+        from_date?: string;
+        to_date?: string;
+        human_review_status?: string;
+        metadata?: Record<string, string>;
+        filename?: string;
+    }, options?: RequestOptions): Promise<PaginatedList>;
+    /**
+     * Count extractions matching filters.
+     */
+    count({ origin_dot_type, origin_dot_id, human_review_status, metadata, }?: {
+        origin_dot_type?: string;
+        origin_dot_id?: string;
+        human_review_status?: string;
+        metadata?: Record<string, string>;
+    }, options?: RequestOptions): Promise<ExtractionCountResponse>;
+    /**
+     * Download extractions in various formats. Returns download_url, filename, and expires_at.
+     */
+    download({ order, origin_dot_id, from_date, to_date, human_review_status, metadata, filename, format, }?: {
+        order?: "asc" | "desc";
+        origin_dot_id?: string;
+        from_date?: string;
+        to_date?: string;
+        human_review_status?: string;
+        metadata?: Record<string, string>;
+        filename?: string;
+        format?: "jsonl" | "csv" | "xlsx";
+    }, options?: RequestOptions): Promise<DownloadResponse>;
+    /**
+     * Export extractions as CSV. Returns csv_data, rows, and columns.
+     */
+    getPayloadForExport({ project_id, extraction_ids, json_schema, delimiter, line_delimiter, quote, }: {
+        project_id: string;
+        extraction_ids: string[];
+        json_schema: Record<string, any>;
+        delimiter?: string;
+        line_delimiter?: string;
+        quote?: string;
+    }, options?: RequestOptions): Promise<ExportToCsvResponse>;
+    /**
+     * Update an extraction.
+     */
+    update(extraction_id: string, { predictions, predictions_draft, human_review_status, json_schema, inference_settings, metadata, }: {
+        predictions?: Record<string, any>;
+        predictions_draft?: Record<string, any>;
+        human_review_status?: string;
+        json_schema?: Record<string, any>;
+        inference_settings?: Record<string, any>;
+        metadata?: Record<string, string>;
+    }, options?: RequestOptions): Promise<Extraction>;
+    /**
+     * Get an extraction by ID.
+     */
+    get(extraction_id: string, options?: RequestOptions): Promise<Extraction>;
+    /**
+     * Delete an extraction by ID.
+     */
+    delete(extraction_id: string, options?: RequestOptions): Promise<void>;
+    /**
+     * Get distinct values for filterable fields.
+     */
+    getDistinctFieldValues(options?: RequestOptions): Promise<DistinctFieldValues>;
+    /**
+     * Download the sample document for an extraction.
+     */
+    downloadSampleDocument(extraction_id: string, options?: RequestOptions): Promise<ArrayBuffer>;
+}
+export {};
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/extractions/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAkB,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,QAAA,MAAM,wBAAwB;;;;;;EAE5B,CAAC;AACH,KAAK,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAExE,QAAA,MAAM,iBAAiB;;;;;;;;;;;;EAIrB,CAAC;AACH,KAAK,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D,QAAA,MAAM,oBAAoB;;;;;;;;;;;;EAIxB,CAAC;AACH,KAAK,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEhE,QAAA,MAAM,oBAAoB,2DAAgC,CAAC;AAC3D,KAAK,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAGhE,QAAA,MAAM,WAAW,oCAAoB,CAAC;AACtC,KAAK,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAE9C,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,iBAAiB;gBAC7C,MAAM,EAAE,iBAAiB;IAIrC;;OAEG;IACG,IAAI,CAAC,EACP,MAAM,EACN,KAAK,EACL,KAAU,EACV,KAAc,EACd,eAAe,EACf,aAAa,EACb,SAAS,EACT,OAAO,EACP,mBAAmB,EACnB,QAAQ,EACR,QAAQ,GACX,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,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;KAChB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IA6BzD;;OAEG;IACG,KAAK,CAAC,EACR,eAAe,EACf,aAAa,EACb,mBAAuC,EACvC,QAAQ,GACX,GAAE;QACC,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAChC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAsBnE;;OAEG;IACG,QAAQ,CAAC,EACX,KAAc,EACd,aAAa,EACb,SAAS,EACT,OAAO,EACP,mBAAmB,EACnB,QAAQ,EACR,QAAQ,EACR,MAAgB,GACnB,GAAE;QACC,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;QACvB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;KAChC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA0B5D;;OAEG;IACG,mBAAmB,CAAC,EACtB,UAAU,EACV,cAAc,EACd,WAAW,EACX,SAAe,EACf,cAAqB,EACrB,KAAW,GACd,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,MAAM,EAAE,CAAC;QACzB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,KAAK,CAAC,EAAE,MAAM,CAAC;KAClB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAoB1D;;OAEG;IACG,MAAM,CACR,aAAa,EAAE,MAAM,EACrB,EACI,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,WAAW,EACX,kBAAkB,EAClB,QAAQ,GACX,EAAE;QACC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAClC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACxC,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAClC,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACrC,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,UAAU,CAAC;IAkBtB;;OAEG;IACG,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IAS/E;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAS5E;;OAEG;IACG,sBAAsB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC;IASpF;;OAEG;IACG,sBAAsB,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;CAStG"}

package/dist/api/extractions/client.js

@@ -0,0 +1,188 @@
+import { CompositionClient } from "../../client.js";
+import { ZPaginatedList } from "../../types.js";
+import * as z from "zod";
+// Response types for extractions API
+const ZExtractionCountResponse = z.object({
+    count: z.number(),
+});
+const ZDownloadResponse = z.object({
+    download_url: z.string(),
+    filename: z.string(),
+    expires_at: z.string(),
+});
+const ZExportToCsvResponse = z.object({
+    csv_data: z.string(),
+    rows: z.number(),
+    columns: z.number(),
+});
+const ZDistinctFieldValues = z.record(z.array(z.string()));
+// Generic extraction object (flexible since schema varies)
+const ZExtraction = z.record(z.any());
+export default class APIExtractions extends CompositionClient {
+    constructor(client) {
+        super(client);
+    }
+    /**
+     * List extractions with pagination and filtering.
+     */
+    async list({ before, after, limit = 10, order = "desc", origin_dot_type, origin_dot_id, from_date, to_date, human_review_status, metadata, filename, } = {}, options) {
+        const params = {
+            before,
+            after,
+            limit,
+            order,
+            origin_dot_type,
+            origin_dot_id,
+            from_date,
+            to_date,
+            human_review_status,
+            filename,
+            // Note: metadata must be JSON-serialized as the backend expects a JSON string
+            metadata: metadata ? JSON.stringify(metadata) : undefined,
+        };
+        // Remove undefined values
+        const cleanParams = Object.fromEntries(Object.entries(params).filter(([_, v]) => v !== undefined));
+        return this._fetchJson(ZPaginatedList, {
+            url: "/v1/extractions",
+            method: "GET",
+            params: { ...cleanParams, ...(options?.params || {}) },
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Count extractions matching filters.
+     */
+    async count({ origin_dot_type, origin_dot_id, human_review_status = "review_required", metadata, } = {}, options) {
+        const params = {
+            origin_dot_type,
+            origin_dot_id,
+            human_review_status,
+            // Note: metadata must be JSON-serialized as the backend expects a JSON string
+            metadata: metadata ? JSON.stringify(metadata) : undefined,
+        };
+        // Remove undefined values
+        const cleanParams = Object.fromEntries(Object.entries(params).filter(([_, v]) => v !== undefined));
+        return this._fetchJson(ZExtractionCountResponse, {
+            url: "/v1/extractions/count",
+            method: "GET",
+            params: { ...cleanParams, ...(options?.params || {}) },
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Download extractions in various formats. Returns download_url, filename, and expires_at.
+     */
+    async download({ order = "desc", origin_dot_id, from_date, to_date, human_review_status, metadata, filename, format = "jsonl", } = {}, options) {
+        const params = {
+            order,
+            origin_dot_id,
+            from_date,
+            to_date,
+            human_review_status,
+            filename,
+            format,
+            // Note: metadata must be JSON-serialized as the backend expects a JSON string
+            metadata: metadata ? JSON.stringify(metadata) : undefined,
+        };
+        // Remove undefined values
+        const cleanParams = Object.fromEntries(Object.entries(params).filter(([_, v]) => v !== undefined));
+        return this._fetchJson(ZDownloadResponse, {
+            url: "/v1/extractions/download",
+            method: "GET",
+            params: { ...cleanParams, ...(options?.params || {}) },
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Export extractions as CSV. Returns csv_data, rows, and columns.
+     */
+    async getPayloadForExport({ project_id, extraction_ids, json_schema, delimiter = ";", line_delimiter = "\n", quote = '"', }, options) {
+        return this._fetchJson(ZExportToCsvResponse, {
+            url: "/v1/extractions/get_payload_for_export",
+            method: "POST",
+            body: {
+                project_id,
+                extraction_ids,
+                json_schema,
+                ...(options?.body || {}),
+            },
+            params: {
+                delimiter,
+                line_delimiter,
+                quote,
+                ...(options?.params || {}),
+            },
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Update an extraction.
+     */
+    async update(extraction_id, { predictions, predictions_draft, human_review_status, json_schema, inference_settings, metadata, }, options) {
+        const body = {};
+        if (predictions !== undefined)
+            body.predictions = predictions;
+        if (predictions_draft !== undefined)
+            body.predictions_draft = predictions_draft;
+        if (human_review_status !== undefined)
+            body.human_review_status = human_review_status;
+        if (json_schema !== undefined)
+            body.json_schema = json_schema;
+        if (inference_settings !== undefined)
+            body.inference_settings = inference_settings;
+        if (metadata !== undefined)
+            body.metadata = metadata;
+        return this._fetchJson(ZExtraction, {
+            url: `/v1/extractions/${extraction_id}`,
+            method: "PATCH",
+            body: { ...body, ...(options?.body || {}) },
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Get an extraction by ID.
+     */
+    async get(extraction_id, options) {
+        return this._fetchJson(ZExtraction, {
+            url: `/v1/extractions/${extraction_id}`,
+            method: "GET",
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Delete an extraction by ID.
+     */
+    async delete(extraction_id, options) {
+        return this._fetchJson({
+            url: `/v1/extractions/${extraction_id}`,
+            method: "DELETE",
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Get distinct values for filterable fields.
+     */
+    async getDistinctFieldValues(options) {
+        return this._fetchJson(ZDistinctFieldValues, {
+            url: "/v1/extractions/fields",
+            method: "GET",
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Download the sample document for an extraction.
+     */
+    async downloadSampleDocument(extraction_id, options) {
+        const response = await this._fetch({
+            url: `/v1/extractions/${extraction_id}/sample-document`,
+            method: "GET",
+            params: options?.params,
+            headers: options?.headers,
+        });
+        return response.arrayBuffer();
+    }
+}

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

@@ -1,27 +1,24 @@
 import { CompositionClient, RequestOptions } from "../../client.js";
-import { BaseProjectInput, Project, CreateProjectRequest, MIMEDataInput, RetabParsedChatCompletion } from "../../types.js";
-import APIProjectsDocuments from "./documents/client";
-import APIProjectsIterations from "./iterations/client";
+import { Project, CreateProjectRequest, MIMEDataInput, RetabParsedChatCompletion } from "../../types.js";
 export default class APIProjects extends CompositionClient {
     constructor(client: CompositionClient);
-    documents: APIProjectsDocuments;
-    iterations: APIProjectsIterations;
     create(body: CreateProjectRequest, options?: RequestOptions): Promise<Project>;
-    update(projectId: string, body: Partial<BaseProjectInput>, options?: RequestOptions): Promise<Project>;
     list(options?: RequestOptions): Promise<Project[]>;
     get(projectId: string, options?: RequestOptions): Promise<Project>;
     delete(projectId: string, options?: RequestOptions): Promise<void>;
-    extract({ project_id, iteration_id, document, documents, model, image_resolution_dpi, n_consensus, temperature, seed, store }: {
+    publish(projectId: string, body?: Record<string, unknown>, options?: RequestOptions): Promise<Project>;
+    extract({ project_id, iteration_id, document, model, image_resolution_dpi, n_consensus, temperature, seed, store, metadata, extraction_id }: {
         project_id: string;
         iteration_id?: string;
-        document?: MIMEDataInput;
-        documents?: MIMEDataInput[];
+        document: MIMEDataInput;
         model?: string;
         image_resolution_dpi?: number;
         n_consensus?: number;
         temperature?: number;
         seed?: number;
         store?: boolean;
+        metadata?: Record<string, string>;
+        extraction_id?: string;
     }, options?: RequestOptions): Promise<RetabParsedChatCompletion>;
 }
 //# sourceMappingURL=client.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/projects/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEpE,OAAO,EAAE,gBAAgB,EAAa,OAAO,EAAkE,oBAAoB,EAAE,aAAa,EAAa,yBAAyB,EAA8B,MAAM,gBAAgB,CAAC;AAC7O,OAAO,oBAAoB,MAAM,oBAAoB,CAAC;AACtD,OAAO,qBAAqB,MAAM,qBAAqB,CAAC;AAExD,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,iBAAiB;gBAC1C,MAAM,EAAE,iBAAiB;IAIrC,SAAS,uBAAkC;IAC3C,UAAU,wBAAmC;IAEvC,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAU9E,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAUtG,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IASlD,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IASlE,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IASlE,OAAO,CAAC,EACV,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,KAAK,EACL,oBAAoB,EACpB,WAAW,EACX,WAAW,EACX,IAAI,EACJ,KAAK,EACR,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,aAAa,CAAC;QACzB,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;QAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,OAAO,CAAC;KACnB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;CA2BnE"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/projects/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEpE,OAAO,EAAa,OAAO,EAAmC,oBAAoB,EAAE,aAAa,EAAa,yBAAyB,EAA8B,MAAM,gBAAgB,CAAC;AAE5L,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,iBAAiB;gBAC1C,MAAM,EAAE,iBAAiB;IAI/B,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAU9E,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IASlD,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IASlE,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IASlE,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAYtG,OAAO,CAAC,EACV,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,KAAK,EACL,oBAAoB,EACpB,WAAW,EACX,WAAW,EACX,IAAI,EACJ,KAAK,EACL,QAAQ,EACR,aAAa,EAChB,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,EAAE,aAAa,CAAC;QACxB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClC,aAAa,CAAC,EAAE,MAAM,CAAC;KAC1B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;CA8BnE"}

package/dist/api/projects/client.js

@@ -1,13 +1,9 @@
 import { CompositionClient } from "../../client.js";
 import { mimeToBlob } from "../../mime.js";
-import { dataArray, ZBaseProject, ZProjectLoose as ZProject, ZCreateProjectRequest, ZMIMEData, ZRetabParsedChatCompletion } from "../../types.js";
-import APIProjectsDocuments from "./documents/client";
-import APIProjectsIterations from "./iterations/client";
+import { dataArray, ZProject, ZCreateProjectRequest, ZMIMEData, ZRetabParsedChatCompletion } from "../../types.js";
 export default class APIProjects extends CompositionClient {
     constructor(client) {
         super(client);
-        this.documents = new APIProjectsDocuments(this);
-        this.iterations = new APIProjectsIterations(this);
     }
     async create(body, options) {
         return this._fetchJson(ZProject, {
@@ -18,15 +14,6 @@ export default class APIProjects extends CompositionClient {
             headers: options?.headers,
         });
     }
-    async update(projectId, body, options) {
-        return this._fetchJson(ZProject, {
-            url: `/v1/projects/${projectId}`,
-            method: "PATCH",
-            body: { ...(await ZBaseProject.partial().parseAsync(body)), ...(options?.body || {}) },
-            params: options?.params,
-            headers: options?.headers,
-        });
-    }
     async list(options) {
         return this._fetchJson(dataArray(ZProject), {
             url: "/v1/projects",
@@ -51,14 +38,23 @@ export default class APIProjects extends CompositionClient {
             headers: options?.headers,
         });
     }
-    async extract({ project_id, iteration_id, document, documents, model, image_resolution_dpi, n_consensus, temperature, seed, store }, options) {
-        if (!document && (!documents || documents.length === 0)) {
-            throw new Error("Either 'document' or 'documents' must be provided.");
-        }
+    async publish(projectId, body, options) {
+        const mergedBody = body || options?.body ? { ...(body || {}), ...(options?.body || {}) } : undefined;
+        return this._fetchJson(ZProject, {
+            url: `/v1/projects/${projectId}/publish`,
+            method: "POST",
+            body: mergedBody,
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    async extract({ project_id, iteration_id, document, model, image_resolution_dpi, n_consensus, temperature, seed, store, metadata, extraction_id }, options) {
         const url = iteration_id ? `/v1/projects/extract/${project_id}/${iteration_id}` : `/v1/projects/extract/${project_id}`;
+        // Parse and convert document to blob for multipart form upload
+        const parsedDocument = await ZMIMEData.parseAsync(document);
         // Only include optional parameters if they are provided
         const bodyParams = {
-            documents: (await ZMIMEData.array().parseAsync([...document ? [document] : [], ...(documents || [])])).map(mimeToBlob)
+            document: mimeToBlob(parsedDocument)
         };
         if (model !== undefined)
             bodyParams.model = model;
@@ -72,6 +68,11 @@ export default class APIProjects extends CompositionClient {
             bodyParams.seed = seed;
         if (store !== undefined)
             bodyParams.store = store;
+        // Note: metadata must be JSON-serialized since multipart forms only accept primitive types
+        if (metadata !== undefined)
+            bodyParams.metadata = JSON.stringify(metadata);
+        if (extraction_id !== undefined)
+            bodyParams.extraction_id = extraction_id;
         return this._fetchJson(ZRetabParsedChatCompletion, {
             url,
             method: "POST",

package/dist/client.d.ts

@@ -24,12 +24,16 @@ export declare class APIError extends Error {
     info: string;
     constructor(status: number, info: string);
 }
+export declare class SignatureVerificationError extends Error {
+    constructor(message: string);
+}
 export declare const DateOrISO: z.ZodUnion<[z.ZodDate, z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, Date, string>]>;
 type AuthTypes = {
     apiKey: string;
 } | {};
 export type ClientOptions = {
     baseUrl?: string;
+    timeout?: number;
 } & AuthTypes;
 export type RequestOptions = {
     params?: Record<string, any>;
@@ -38,6 +42,7 @@ export type RequestOptions = {
 };
 export declare class FetcherClient extends AbstractClient {
     options: ClientOptions;
+    timeout: number;
     constructor(options?: ClientOptions);
     _fetch(params: {
         url: string;
@@ -47,6 +52,33 @@ export declare class FetcherClient extends AbstractClient {
         bodyMime?: "application/json" | "multipart/form-data";
         body?: Record<string, any>;
     }): Promise<Response>;
+    /**
+     * Verify the signature of a webhook event.
+     *
+     * @param eventBody - The raw request body as a string or Buffer
+     * @param eventSignature - The signature from the request header (x-retab-signature)
+     * @param secret - The webhook secret key used for signing
+     * @returns The parsed event payload (JSON)
+     * @throws {SignatureVerificationError} If the signature verification fails
+     *
+     * @example
+     * ```typescript
+     * import { FetcherClient } from './client';
+     *
+     * // In your webhook handler
+     * const secret = "your_webhook_secret";
+     * const body = req.body; // Raw string or Buffer
+     * const signature = req.headers['x-retab-signature'];
+     *
+     * try {
+     *   const event = FetcherClient.verifyEvent(body, signature, secret);
+     *   console.log(`Verified event: ${event}`);
+     * } catch (error) {
+     *   console.log("Invalid signature!");
+     * }
+     * ```
+     */
+    static verifyEvent(eventBody: string | Buffer, eventSignature: string, secret: string): any;
 }
 export {};
 //# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,KAAK,WAAW,GAAG;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,QAAQ,CAAC,EAAE,kBAAkB,GAAG,qBAAqB,CAAC;IACtD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AAyCF,qBAAa,cAAc;IACzB,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;cAGnC,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;cAC9C,UAAU,CAAC,SAAS,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;cAc9H,YAAY,CAAC,SAAS,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;CAQ/J;AAED,qBAAa,iBAAkB,SAAQ,cAAc;IACnD,SAAS,CAAC,OAAO,EAAE,cAAc,CAAC;gBACtB,MAAM,EAAE,cAAc;IAIlC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;CAGzD;AAED,qBAAa,QAAS,SAAQ,KAAK;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;gBACD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAKzC;AAED,eAAO,MAAM,SAAS,gGAKpB,CAAC;AAEH,KAAK,SAAS,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,EAAE,CAAC;AACzC,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,SAAS,CAAC;AAEd,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF,qBAAa,aAAc,SAAQ,cAAc;IAC/C,OAAO,EAAE,aAAa,CAAC;gBACX,OAAO,CAAC,EAAE,aAAa;IAe7B,MAAM,CAAC,MAAM,EAAE;QACnB,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC9B,QAAQ,CAAC,EAAE,kBAAkB,GAAG,qBAAqB,CAAC;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC5B,GAAG,OAAO,CAAC,QAAQ,CAAC;CA2CtB"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,KAAK,WAAW,GAAG;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,QAAQ,CAAC,EAAE,kBAAkB,GAAG,qBAAqB,CAAC;IACtD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AAyCF,qBAAa,cAAc;IACzB,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;cAGnC,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;cAC9C,UAAU,CAAC,SAAS,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;cAc9H,YAAY,CAAC,SAAS,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;CAQ/J;AAED,qBAAa,iBAAkB,SAAQ,cAAc;IACnD,SAAS,CAAC,OAAO,EAAE,cAAc,CAAC;gBACtB,MAAM,EAAE,cAAc;IAIlC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;CAGzD;AAED,qBAAa,QAAS,SAAQ,KAAK;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;gBACD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAKzC;AAED,qBAAa,0BAA2B,SAAQ,KAAK;gBACvC,OAAO,EAAE,MAAM;CAI5B;AAED,eAAO,MAAM,SAAS,gGAKpB,CAAC;AAEH,KAAK,SAAS,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,EAAE,CAAC;AACzC,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,SAAS,CAAC;AAEd,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF,qBAAa,aAAc,SAAQ,cAAc;IAC/C,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;gBACJ,OAAO,CAAC,EAAE,aAAa;IAgB7B,MAAM,CAAC,MAAM,EAAE;QACnB,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC9B,QAAQ,CAAC,EAAE,kBAAkB,GAAG,qBAAqB,CAAC;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC5B,GAAG,OAAO,CAAC,QAAQ,CAAC;IA6CrB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,GAAG;CAc5F"}

package/dist/client.js

@@ -1,4 +1,5 @@
 import * as z from "zod";
+import * as crypto from "crypto";
 async function* streamResponse(schema, response) {
     let body = "";
     let depth = 0;
@@ -86,6 +87,12 @@ export class APIError extends Error {
         this.info = info;
     }
 }
+export class SignatureVerificationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "SignatureVerificationError";
+    }
+}
 export const DateOrISO = z.union([
     z.date(),
     z.string().refine(val => !isNaN(Date.parse(val)), {
@@ -96,6 +103,7 @@ export class FetcherClient extends AbstractClient {
     constructor(options) {
         super();
         this.options = options || {};
+        this.timeout = this.options.timeout ?? 1800000; // Default 1800 seconds (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) {
@@ -137,10 +145,49 @@ export class FetcherClient extends AbstractClient {
         const apiKey = "apiKey" in this.options ? this.options.apiKey : process.env["RETAB_API_KEY"];
         headers["Api-Key"] = apiKey;
         init.headers = headers;
+        init.signal = AbortSignal.timeout(this.timeout);
         let res = await fetch(url, init);
         if (!res.ok) {
             throw new APIError(res.status, await res.text());
         }
         return res;
     }
+    /**
+     * Verify the signature of a webhook event.
+     *
+     * @param eventBody - The raw request body as a string or Buffer
+     * @param eventSignature - The signature from the request header (x-retab-signature)
+     * @param secret - The webhook secret key used for signing
+     * @returns The parsed event payload (JSON)
+     * @throws {SignatureVerificationError} If the signature verification fails
+     *
+     * @example
+     * ```typescript
+     * import { FetcherClient } from './client';
+     *
+     * // In your webhook handler
+     * const secret = "your_webhook_secret";
+     * const body = req.body; // Raw string or Buffer
+     * const signature = req.headers['x-retab-signature'];
+     *
+     * try {
+     *   const event = FetcherClient.verifyEvent(body, signature, secret);
+     *   console.log(`Verified event: ${event}`);
+     * } catch (error) {
+     *   console.log("Invalid signature!");
+     * }
+     * ```
+     */
+    static verifyEvent(eventBody, eventSignature, secret) {
+        const bodyBuffer = typeof eventBody === 'string' ? Buffer.from(eventBody, 'utf-8') : eventBody;
+        const expectedSignature = crypto
+            .createHmac('sha256', secret)
+            .update(bodyBuffer)
+            .digest('hex');
+        // Use constant-time comparison to prevent timing attacks
+        if (!crypto.timingSafeEqual(Buffer.from(eventSignature), Buffer.from(expectedSignature))) {
+            throw new SignatureVerificationError("Invalid signature");
+        }
+        return JSON.parse(bodyBuffer.toString('utf-8'));
+    }
 }