nervoscan-js-sdk 1.0.0 → 1.0.2-0

package/.github/workflows/deploy-doc.yaml

@@ -0,0 +1,12 @@
+name: Deploy Documentation
+
+
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18

package/README.md

@@ -0,0 +1,135 @@
+![nervotec.png](nervotec.png)
+
+[![npm version](https://img.shields.io/npm/v/nervoscan-js-sdk)](https://www.npmjs.com/package/nervoscan-js-sdk)
+
+## Overview
+
+The **NervoScan JS SDK** is a lightweight JavaScript library that enables seamless integration with the NervoScan backend services. This SDK handles authentication, video scan submission, and structured error handling — allowing developers to build React or other web-based clients effortlessly on top of NervoScan's contactless health analysis platform.
+
+It provides a singleton `Client` interface and a full suite of custom error classes for advanced control and debugging.
+
+---
+
+## Features
+
+- Authenticated communication with the NervoScan backend
+- Video scan submission and result retrieval
+- Fully type-safe implementation (written in TypeScript)
+- Structured custom error classes for robust error handling
+- Easy integration into any React, Vite, or JS-based frontend
+- Singleton pattern for consistent client state management
+
+---
+
+## Installation
+
+```bash
+npm install nervoscan-js-sdk
+```
+
+---
+
+## Usage
+
+```ts
+import { Client, Errors } from 'nervoscan-js-sdk';
+
+// Get the singleton instance
+const client = Client.getInstance();
+
+async function submitScan(videoBlob: Blob) {
+  try {
+    // Initialize with credentials
+    await client.initialize('username', 'password');
+    
+    // Upload video and get job ID
+    const jobID = await client.uploadVideo(videoBlob);
+    console.log('Scan submitted. Job ID:', jobID);
+    
+    // Check results
+    const results = await client.getResults(jobID);
+    console.log('Scan results:', results);
+  } catch (error) {
+    if (error instanceof Errors.InvalidPasswordError) {
+      console.error('Password incorrect.');
+    } else {
+      console.error('Unexpected error:', error);
+    }
+  }
+}
+```
+
+---
+
+## API Reference
+
+### `Client` Class
+
+#### Singleton Access
+```ts
+Client.getInstance(): Client
+```
+Returns the singleton instance of the Client class.
+
+#### Methods
+
+- `initialize(username: string, password: string): void`  
+  Initializes the client with user credentials.
+
+- `uploadVideo(videoBlob: Blob): Promise<string>`  
+  Uploads a video scan and returns the job ID.
+
+- `checkResults(jobID: string): Promise<string>`  
+  Checks if results are available for the given job ID.
+
+- `getResults(jobID: string): Promise<any>`  
+  Fetches scan results for the given job ID.
+
+---
+
+## Error Handling
+
+The SDK provides custom error classes for granular error control:
+
+```ts
+import { Errors } from 'nervoscan-js-sdk';
+
+try {
+  await client.initialize('username', 'password');
+} catch (err) {
+  if (err instanceof Errors.NotInitializedError) {
+    console.error('Client not initialized.');
+  }
+}
+```
+
+### Available Errors
+
+- `NotInitializedError` - Client not properly initialized
+- `EmptyVideoError` - Video blob is empty
+- `VideoTypeError` - Invalid video type, not a blob
+- `InvalidUsernameError` - Invalid username provided
+- `InvalidPasswordError` - Invalid password provided
+- `InvalidAccessTokenError` - Invalid or expired access token
+- `NoScansAvailableError` - No scans available in current plan
+- `NoScanDataError` - No scan data available for the job ID
+
+---
+
+## Requirements
+
+- Node.js v14 or higher
+- Modern browser (Chrome/Safari) for webcam support
+- NervoScan backend access (credentials required)
+
+---
+
+## License
+
+MIT License
+
+---
+
+## Maintainers
+
+Built and maintained by the NervoScan development team.