@kadoa/node-sdk 0.0.2

package/README.md

@@ -0,0 +1,137 @@
+# Kadoa SDK for Node.js
+
+Official Node.js/TypeScript SDK for the Kadoa API, providing easy integration with Kadoa's web data extraction platform.
+
+## Installation
+
+```bash
+npm install @kadoa/sdk
+# or
+yarn add @kadoa/sdk
+# or
+pnpm add @kadoa/sdk
+# or
+bun add @kadoa/sdk
+```
+
+## Quick Start
+
+```typescript
+import { initializeApp, runExtraction } from '@kadoa/sdk';
+
+// Initialize the SDK
+const app = initializeApp({
+  apiKey: 'your-api-key',
+  baseUrl: 'https://api.kadoa.com' // optional, defaults to production
+});
+
+// Run an extraction
+const result = await runExtraction(app, {
+  urls: ['https://example.com'],
+  name: 'My Extraction Workflow'
+});
+
+if (result) {
+  console.log(`Workflow created with ID: ${result.workflowId}`);
+}
+```
+
+## Configuration
+
+The SDK can be configured using environment variables or directly in code:
+
+### Environment Variables
+
+Create a `.env` file:
+```env
+KADOA_API_KEY=your-api-key
+KADOA_API_URL=https://api.kadoa.com
+KADOA_TIMEOUT=30000
+```
+
+Then load them in your code:
+```typescript
+import { initializeApp } from '@kadoa/sdk';
+import { config } from 'dotenv';
+
+config();
+
+const app = initializeApp({
+  apiKey: process.env.KADOA_API_KEY!,
+  baseUrl: process.env.KADOA_API_URL || 'https://api.kadoa.com',
+  timeout: parseInt(process.env.KADOA_TIMEOUT || '30000')
+});
+```
+
+## Development
+
+### Project Structure
+
+```
+sdks/node/
+├── src/
+│   ├── index.ts             # Public API exports
+│   ├── app.ts              # Application initialization
+│   ├── extraction/         # Extraction module
+│   │   ├── index.ts        # Extraction logic
+│   │   └── client.ts       # API client helpers
+│   └── generated/          # Auto-generated API client
+├── test/
+│   └── e2e/
+│       └── runExtraction.test.ts
+├── examples/
+│   └── src/
+│       └── run-extraction.ts
+├── package.json
+└── tsup.config.ts
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+npm test
+
+# Run E2E tests
+npm run test:e2e
+
+# Run with coverage
+npm run test:coverage
+```
+
+### Building
+
+```bash
+# Build the SDK
+npm run build
+
+# Watch mode for development
+npm run dev
+```
+
+### Generating API Client
+
+From the repository root:
+
+```bash
+cd tools/codegen
+bun run generate:node
+```
+
+## Requirements
+
+- Node.js 18+
+- TypeScript 5+ (for TypeScript projects)
+
+## Dependencies
+
+- `axios` - HTTP client
+- Auto-generated API client code
+
+## License
+
+MIT
+
+## Support
+
+For support, please visit [Kadoa Support](https://support.kadoa.com) or contact support@kadoa.com.