datax-sdk 1.0.0

package/README.md

@@ -0,0 +1,61 @@
+# datax-sdk
+
+Official Node.js/TypeScript SDK for the [DataX API](https://github.com/rohitbborude-eaton/convertor-apis) — transform CSV, JSON, XLSX, and PDF with a single function call.
+
+## Install
+
+```bash
+npm install datax-sdk
+```
+
+## Quick Start
+
+```typescript
+import { DataX } from 'datax-sdk';
+
+const client = new DataX('dk_live_YOUR_API_KEY', 'https://your-api-url.com');
+
+// CSV → JSON
+const result = await client.csvToJson('name,age\nRohit,28\nPriya,25');
+console.log(result.data);
+// [{ name: "Rohit", age: 28 }, { name: "Priya", age: 25 }]
+
+// JSON → CSV
+const csv = await client.jsonToCsv([
+  { name: 'Rohit', age: 28 },
+  { name: 'Priya', age: 25 },
+]);
+console.log(csv.data);
+// "name,age\nRohit,28\nPriya,25"
+```
+
+## All Methods
+
+| Method | Input | Output | Plan |
+|--------|-------|--------|------|
+| `csvToJson(csv, opts?)` | CSV string | JSON array | Free |
+| `jsonToCsv(data)` | JSON array | CSV string | Free |
+| `xlsxToJson(base64, opts?)` | Base64 XLSX | JSON array | Free |
+| `jsonToXlsx(data, sheet?)` | JSON array | Base64 XLSX | Starter+ |
+| `csvToXlsx(csv, sheet?)` | CSV string | Base64 XLSX | Starter+ |
+| `jsonToPdf(data, title?)` | JSON array | Base64 PDF | Pro+ |
+| `csvToPdf(csv, title?)` | CSV string | Base64 PDF | Pro+ |
+
+### File Uploads
+
+```typescript
+const file = new Blob([csvContent], { type: 'text/csv' });
+const result = await client.uploadCsvToJson(file);
+```
+
+### Async Jobs
+
+```typescript
+const job = await client.createJob('csv-to-json');
+// Poll for completion
+const status = await client.getJob(job.jobId);
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+export type CsvToJsonOptions = {
+    header?: boolean;
+    delimiter?: 'auto' | ',' | ';' | 'tab';
+    inferTypes?: boolean;
+};
+export type JsonToCsvOptions = Record<string, never>;
+export type XlsxToJsonOptions = {
+    sheet?: string;
+    header?: boolean;
+    inferTypes?: boolean;
+};
+export type TransformResult<T = any> = {
+    data: T;
+    meta: Record<string, any>;
+};
+export type PaginatedResult<T = any> = {
+    data: T[];
+    meta: {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+    };
+};
+export type JobStatus = {
+    id: string;
+    type: string;
+    status: 'queued' | 'processing' | 'completed' | 'failed';
+    outputBlobUrl?: string;
+    downloadUrl?: string;
+    error?: string;
+    createdAt: string;
+    updatedAt: string;
+};
+export type WebhookEndpoint = {
+    id: string;
+    url: string;
+    events: string[];
+    secret?: string;
+    active: boolean;
+    createdAt: string;
+};
+export declare class DataX {
+    private apiKey;
+    private baseUrl;
+    constructor(apiKey: string, baseUrl?: string);
+    private request;
+    csvToJson(csv: string, opts?: CsvToJsonOptions): Promise<TransformResult<Record<string, any>[]>>;
+    jsonToCsv(data: Record<string, any>[]): Promise<TransformResult<string>>;
+    xlsxToJson(base64: string, opts?: XlsxToJsonOptions): Promise<TransformResult<Record<string, any>[]>>;
+    jsonToXlsx(data: Record<string, any>[], sheetName?: string): Promise<TransformResult<string>>;
+    csvToXlsx(csv: string, sheetName?: string): Promise<TransformResult<string>>;
+    jsonToPdf(data: Record<string, any>[], title?: string): Promise<TransformResult<string>>;
+    csvToPdf(csv: string, title?: string): Promise<TransformResult<string>>;
+    uploadCsvToJson(file: Blob): Promise<TransformResult<Record<string, any>[]>>;
+    uploadXlsxToJson(file: Blob): Promise<TransformResult<Record<string, any>[]>>;
+    private uploadFile;
+    createJob(type: string, options?: any): Promise<{
+        jobId: string;
+        status: string;
+        uploadUrl?: string;
+    }>;
+    getJob(jobId: string): Promise<JobStatus>;
+    listJobs(page?: number, limit?: number): Promise<PaginatedResult<JobStatus>>;
+}

package/dist/index.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataX = void 0;
+class DataX {
+    constructor(apiKey, baseUrl = 'https://api.yourdomain.com') {
+        this.apiKey = apiKey;
+        this.baseUrl = baseUrl;
+    }
+    async request(path, body, method = 'POST') {
+        const res = await fetch(`${this.baseUrl}${path}`, {
+            method,
+            headers: {
+                'Content-Type': 'application/json',
+                'x-api-key': this.apiKey,
+            },
+            body: method !== 'GET' ? JSON.stringify(body) : undefined,
+        });
+        if (!res.ok) {
+            throw new Error(`DataX API ${res.status}: ${await res.text()}`);
+        }
+        return res.json();
+    }
+    // --- Transforms ---
+    async csvToJson(csv, opts = {}) {
+        return this.request('/v1/transform/csv-to-json', {
+            data: csv,
+            delimiter: opts.delimiter,
+            header: opts.header !== undefined ? String(opts.header) : undefined,
+            inferTypes: opts.inferTypes !== undefined ? String(opts.inferTypes) : undefined,
+        });
+    }
+    async jsonToCsv(data) {
+        return this.request('/v1/transform/json-to-csv', { data });
+    }
+    async xlsxToJson(base64, opts = {}) {
+        return this.request('/v1/transform/xlsx-to-json', {
+            data: base64,
+            sheet: opts.sheet,
+            header: opts.header !== undefined ? String(opts.header) : undefined,
+            inferTypes: opts.inferTypes !== undefined ? String(opts.inferTypes) : undefined,
+        });
+    }
+    async jsonToXlsx(data, sheetName) {
+        return this.request('/v1/transform/json-to-xlsx', { data, sheetName });
+    }
+    async csvToXlsx(csv, sheetName) {
+        return this.request('/v1/transform/csv-to-xlsx', { data: csv, sheetName });
+    }
+    async jsonToPdf(data, title) {
+        return this.request('/v1/transform/json-to-pdf', { data, title });
+    }
+    async csvToPdf(csv, title) {
+        return this.request('/v1/transform/csv-to-pdf', { data: csv, title });
+    }
+    // --- File upload transforms ---
+    async uploadCsvToJson(file) {
+        return this.uploadFile('/v1/upload/csv-to-json', file);
+    }
+    async uploadXlsxToJson(file) {
+        return this.uploadFile('/v1/upload/xlsx-to-json', file);
+    }
+    async uploadFile(path, file) {
+        const form = new FormData();
+        form.append('file', file);
+        const res = await fetch(`${this.baseUrl}${path}`, {
+            method: 'POST',
+            headers: { 'x-api-key': this.apiKey },
+            body: form,
+        });
+        if (!res.ok) {
+            throw new Error(`DataX API ${res.status}: ${await res.text()}`);
+        }
+        return res.json();
+    }
+    // --- Jobs ---
+    async createJob(type, options) {
+        return this.request('/v1/jobs', { type, options });
+    }
+    async getJob(jobId) {
+        const res = await fetch(`${this.baseUrl}/v1/jobs/${jobId}`, {
+            headers: { 'x-api-key': this.apiKey },
+        });
+        if (!res.ok) {
+            throw new Error(`DataX API ${res.status}: ${await res.text()}`);
+        }
+        return res.json();
+    }
+    async listJobs(page = 1, limit = 20) {
+        const res = await fetch(`${this.baseUrl}/v1/jobs?page=${page}&limit=${limit}`, { headers: { 'x-api-key': this.apiKey } });
+        if (!res.ok) {
+            throw new Error(`DataX API ${res.status}: ${await res.text()}`);
+        }
+        return res.json();
+    }
+}
+exports.DataX = DataX;

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "datax-sdk",
+  "version": "1.0.0",
+  "description": "Official SDK for the DataX API — CSV/JSON/XLSX/PDF transforms via REST",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "csv", "json", "xlsx", "pdf", "transform", "convert",
+    "csv-to-json", "json-to-csv", "xlsx-to-json", "api", "datax"
+  ],
+  "author": "DataX",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rohitbborude-eaton/convertor-apis"
+  },
+  "homepage": "https://github.com/rohitbborude-eaton/convertor-apis#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}