parze 0.1.0 → 0.2.0

package/README.md

@@ -1,29 +1,84 @@
 # Parze JavaScript SDK
 
-TypeScript/JavaScript client for the Parze API.
+Official TypeScript/JavaScript client for the Parze document parsing API.
 
 ## Installation
 
 ```bash
-npm install parze-sdk
+npm install parze
 # or
-yarn add parze-sdk
+yarn add parze
 ```
 
-## Usage
+## Quick Start
 
-```ts
-import { ParzeClient } from "parze-sdk";
+```typescript
+import { ParzeClient } from 'parze';
 
-const client = new ParzeClient({ apiKey: "YOUR_API_KEY" });
+// Initialize client with your API key
+const client = new ParzeClient({ apiKey: 'pk_live_your_key_here' });
 
-const extraction = await client.extract("document contents", {
-  fields: [{ name: "total", type: "number" }],
+// Parse a document
+const result = await client.parse('invoice.pdf');
+console.log(result.text);
+
+// Extract structured data
+const extraction = await client.extract(result.text, {
+  invoice_number: { type: 'string', description: 'Invoice number' },
+  total_amount: { type: 'string', description: 'Total amount' },
+  date: { type: 'string', description: 'Invoice date' }
 });
+console.log(extraction.extraction);
 
-const parsed = await client.parse("document contents");
+// Get AI-suggested schema
+const suggested = await client.suggestSchema(result.text);
+console.log(suggested);
 ```
 
+## API Reference
+
+### `parse(filePath, options?)`
+Parse a document into structured text.
+
+**Parameters:**
+- `filePath` (string): Path to document file
+- `options` (object, optional):
+  - `outputFormat`: "structured" | "markdown" | "json"
+  - `preserveTables`: boolean
+  - `preserveLayout`: boolean
+  - `extractionMode`: "auto" | "ocr_only" | "llm_only" | "identity_doc"
+
+**Returns:** Promise with parsed text and metadata
+
+### `extract(text, extractionSchema)`
+Extract structured data from text using a schema.
+
+**Parameters:**
+- `text` (string): Document text (from parse)
+- `extractionSchema` (object): Schema defining fields to extract
+
+**Returns:** Promise with extracted data and confidence scores
+
+### `suggestSchema(text)`
+Get AI-suggested extraction schema based on document text.
+
+**Parameters:**
+- `text` (string): Document text
+
+**Returns:** Promise with suggested schema
+
+### `textToSchema(description)`
+Convert natural language description to extraction schema.
+
+**Parameters:**
+- `description` (string): Natural language description of fields
+
+**Returns:** Promise with generated schema
+
+## Get API Key
+
+Get your API key from [platform.parze.ai](https://platform.parze.ai)
+
 ## Development
 
 ```bash

package/dist/index.d.ts

@@ -2,11 +2,19 @@ export interface ParzeClientOptions {
     apiKey: string;
     baseUrl?: string;
 }
+export interface ParseOptions {
+    outputFormat?: 'structured' | 'markdown' | 'json';
+    preserveTables?: boolean;
+    preserveLayout?: boolean;
+    extractionMode?: 'auto' | 'ocr_only' | 'llm_only' | 'identity_doc';
+}
 export declare class ParzeClient {
     private apiKey;
     private baseUrl;
     private http;
     constructor(options: ParzeClientOptions);
-    extract(document: string, schema: object): Promise<any>;
-    parse(document: string): Promise<any>;
+    parse(filePath: string, options?: ParseOptions): Promise<any>;
+    extract(text: string, extractionSchema: object): Promise<any>;
+    suggestSchema(text: string): Promise<any>;
+    textToSchema(description: string): Promise<any>;
 }

package/dist/index.js

@@ -1,34 +1,86 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ParzeClient = void 0;
 const axios_1 = __importDefault(require("axios"));
+const form_data_1 = __importDefault(require("form-data"));
+const fs = __importStar(require("fs"));
 class ParzeClient {
     constructor(options) {
         this.apiKey = options.apiKey;
-        this.baseUrl = options.baseUrl || 'https://api.parze.com';
+        this.baseUrl = options.baseUrl || 'https://parze-561514618654.europe-west1.run.app';
         this.http = axios_1.default.create({
             baseURL: this.baseUrl + '/api',
             headers: {
                 'Authorization': `Bearer ${this.apiKey}`,
-                'Content-Type': 'application/json',
             },
         });
     }
-    async extract(document, schema) {
-        const response = await this.http.post('/extract', {
-            document,
-            schema,
+    async parse(filePath, options) {
+        const form = new form_data_1.default();
+        form.append('file', fs.createReadStream(filePath));
+        if (options === null || options === void 0 ? void 0 : options.outputFormat)
+            form.append('output_format', options.outputFormat);
+        if ((options === null || options === void 0 ? void 0 : options.preserveTables) !== undefined)
+            form.append('preserve_tables', String(options.preserveTables));
+        if ((options === null || options === void 0 ? void 0 : options.preserveLayout) !== undefined)
+            form.append('preserve_layout', String(options.preserveLayout));
+        if (options === null || options === void 0 ? void 0 : options.extractionMode)
+            form.append('extraction_mode', options.extractionMode);
+        const response = await this.http.post('/parse', form, {
+            headers: form.getHeaders(),
         });
         return response.data;
     }
-    async parse(document) {
-        const response = await this.http.post('/parse', {
-            document,
+    async extract(text, extractionSchema) {
+        const response = await this.http.post('/extract', {
+            text,
+            extraction_schema: extractionSchema,
         });
         return response.data;
     }
+    async suggestSchema(text) {
+        const response = await this.http.post('/suggest-schema', { text });
+        return response.data;
+    }
+    async textToSchema(description) {
+        const response = await this.http.post('/text-to-schema', { text: description });
+        return response.data;
+    }
 }
 exports.ParzeClient = ParzeClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "parze",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "TypeScript SDK for the Parze API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,15 +15,7 @@
   },
   "author": "gideononyewuenyi",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/parze/parze.git",
-    "directory": "sdk/js"
-  },
-  "bugs": {
-    "url": "https://github.com/parze/parze/issues"
-  },
-  "homepage": "https://parze.com",
+  "homepage": "https://platform.parze.ai",
   "keywords": [
     "parze",
     "sdk",
@@ -31,9 +23,11 @@
     "api-client"
   ],
   "dependencies": {
-    "axios": "^1.6.0"
+    "axios": "^1.6.0",
+    "form-data": "^4.0.0"
   },
   "devDependencies": {
+    "@types/node": "^20.0.0",
     "typescript": "^5.0.0"
   }
 }