aparavi-client 1.0.5 → 1.0.6

package/README.md

@@ -16,18 +16,23 @@ A comprehensive TypeScript/JavaScript client library for the Aparavi data proces
 ## Installation
 
 ```bash
-npm install aparavi-client-typescript
+npm install aparavi-client
+```
+
+Or install globally for CLI access:
+
+```bash
+npm install -g aparavi-client
 ```
 
 ## Quick Start
 
 ### Using the CLI
 
-```bash
-# Install globally for CLI access
-npm install -g aparavi-client-typescript
+The CLI automatically connects to the Aparavi cloud service at `eaas.aparavi.com:443` by default.
 
-# Start a pipeline
+```bash
+# Start a pipeline (automatically uses eaas.aparavi.com)
 aparavi start --pipeline ./my-pipeline.json --apikey YOUR_API_KEY
 
 # Upload files
@@ -35,16 +40,19 @@ aparavi upload *.pdf --pipeline ./my-pipeline.json --apikey YOUR_API_KEY
 
 # Monitor status
 aparavi status --token TASK_TOKEN --apikey YOUR_API_KEY
+
+# Use a different server
+aparavi start --pipeline ./my-pipeline.json --apikey YOUR_API_KEY --host custom.server.com --port 443
 ```
 
 ### Using the Library
 
 ```javascript
-import { AparaviClient } from 'aparavi-client-typescript';
+import { AparaviClient } from 'aparavi-client';
 
 const client = new AparaviClient({
   auth: 'your-api-key',
-  uri: 'wss://your-server.com'  // optional
+  uri: 'wss://eaas.aparavi.com:443'  // optional, this is the default
 });
 
 await client.connect();
@@ -68,7 +76,7 @@ Create a `.env` file in your project:
 
 ```bash
 APARAVI_APIKEY=your-api-key-here
-APARAVI_URI=wss://your-server.com
+APARAVI_URI=wss://eaas.aparavi.com:443
 APARAVI_PIPELINE=./my-pipeline.json
 APARAVI_TOKEN=existing-task-token
 ```
@@ -78,7 +86,7 @@ APARAVI_TOKEN=existing-task-token
 ```javascript
 const client = new AparaviClient({
   auth: 'your-api-key',                    // Required: API key
-  uri: 'wss://your-server.com',           // Optional: Server URI
+  uri: 'wss://eaas.aparavi.com:443',      // Optional: Server URI (default: eaas.aparavi.com:443)
   persist: true,                          // Optional: Auto-reconnect
   reconnectDelay: 1000,                   // Optional: Reconnect delay (ms)
   onEvent: (event) => console.log(event), // Optional: Event handler
@@ -202,8 +210,8 @@ Options:
   --threads <num>      Number of threads (default: 4)
   --args <args...>     Additional arguments
   --apikey <key>       API key
-  --host <hostname>    Server hostname (default: localhost)
-  --port <port>        Server port (default: 5565)
+  --host <hostname>    Server hostname (default: eaas.aparavi.com)
+  --port <port>        Server port (default: 443)
 ```
 
 #### Upload Files
@@ -220,8 +228,8 @@ Options:
   --max-concurrent <num>  Max concurrent uploads (default: 5)
   --threads <num>      Number of threads (default: 4)
   --apikey <key>       API key
-  --host <hostname>    Server hostname (default: localhost)
-  --port <port>        Server port (default: 5565)
+  --host <hostname>    Server hostname (default: eaas.aparavi.com)
+  --port <port>        Server port (default: 443)
 ```
 
 #### Monitor Status
@@ -232,8 +240,8 @@ aparavi status [options]
 Options:
   --token <token>      Task token to monitor
   --apikey <key>       API key
-  --host <hostname>    Server hostname (default: localhost)
-  --port <port>        Server port (default: 5565)
+  --host <hostname>    Server hostname (default: eaas.aparavi.com)
+  --port <port>        Server port (default: 443)
 ```
 
 #### Stop Pipeline
@@ -244,8 +252,8 @@ aparavi stop [options]
 Options:
   --token <token>      Task token to stop
   --apikey <key>       API key
-  --host <hostname>    Server hostname (default: localhost)
-  --port <port>        Server port (default: 5565)
+  --host <hostname>    Server hostname (default: eaas.aparavi.com)
+  --port <port>        Server port (default: 443)
 ```
 
 ## Pipeline Configuration
@@ -346,7 +354,7 @@ Options:
 ### Document Processing Workflow
 
 ```javascript
-import { AparaviClient } from 'aparavi-client-typescript';
+import { AparaviClient } from 'aparavi-client';
 
 async function processDocuments() {
   const client = new AparaviClient({
@@ -400,7 +408,7 @@ processDocuments();
 ### AI Chat Integration
 
 ```javascript
-import { AparaviClient, Question } from 'aparavi-client-typescript';
+import { AparaviClient, Question } from 'aparavi-client';
 
 async function chatWithAI() {
   const client = new AparaviClient({
@@ -452,7 +460,7 @@ try {
 The package includes full TypeScript definitions:
 
 ```typescript
-import { AparaviClient, PipelineConfig, TASK_STATUS } from 'aparavi-client-typescript';
+import { AparaviClient, PipelineConfig, TASK_STATUS } from 'aparavi-client';
 
 const client: AparaviClient = new AparaviClient({
   auth: 'your-api-key'
@@ -467,11 +475,11 @@ The client works in both Node.js and browser environments:
 
 ```javascript
 // Browser usage
-import { AparaviClient } from 'aparavi-client-typescript';
+import { AparaviClient } from 'aparavi-client';
 
 const client = new AparaviClient({
   auth: 'your-api-key',
-  uri: 'wss://your-server.com'
+  uri: 'wss://eaas.aparavi.com:443'
 });
 
 // File upload in browser
@@ -483,12 +491,40 @@ const results = await client.sendFiles(files, token);
 
 ## Troubleshooting
 
+### Connection Defaults
+
+The client automatically connects to the Aparavi cloud service:
+- **Default Host**: `eaas.aparavi.com`
+- **Default Port**: `443`
+- **Protocol**: `wss://` (secure WebSocket)
+
+You don't need to specify these unless connecting to a custom server.
+
 ### Common Issues
 
-1. **Connection Failed**: Check your API key and server URI
-2. **Pipeline Not Found**: Verify the pipeline file path and JSON format
-3. **Upload Errors**: Ensure files are accessible and not too large
-4. **Authentication Errors**: Verify your API key is correct
+1. **Connection Failed (ws:// instead of wss://)**: 
+   - Ensure you're using the latest version: `npm install -g aparavi-client@latest`
+   - Or install from local build: `npm install -g ./dist/aparavi-client-1.0.4.tgz`
+
+2. **403 Forbidden Error**: 
+   - Your API key is invalid, expired, or lacks permissions
+   - Get a new API key from your Aparavi account settings
+
+3. **301 Redirect Error**: 
+   - You're using an old version of the package
+   - Update to the latest version
+
+4. **Pipeline Not Found**: 
+   - Verify the pipeline file path and JSON format
+   - Use absolute paths if relative paths don't work
+
+5. **Upload Errors**: 
+   - Ensure files are accessible and not too large
+   - Check file permissions
+
+6. **Authentication Errors**: 
+   - Verify your API key is correct
+   - Ensure the key has the necessary permissions
 
 ### Debug Mode
 
@@ -513,6 +549,19 @@ For support and documentation, visit:
 
 ## Changelog
 
+### v1.0.4
+- Changed default server to `eaas.aparavi.com:443`
+- Fixed WebSocket protocol handling (wss:// for secure connections)
+- Improved URI construction and port handling
+- Updated package name to `aparavi-client`
+
+### v1.0.3
+- Port parsing improvements
+- Protocol detection fixes
+
+### v1.0.2
+- Initial public release with cloud defaults
+
 ### v1.0.1
 - Initial release
 - Full TypeScript support

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aparavi-client",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "author": "Aparavi Corporation",
   "license": "MIT",
   "description": "TypeScript client for Aparavi data processing and AI services",