@moveris/shared 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ import { LivenessClient, generateSessionId } from '@moveris/shared';
|
|
|
20
20
|
// Create the client
|
|
21
21
|
const client = new LivenessClient({
|
|
22
22
|
apiKey: 'mv_your_api_key',
|
|
23
|
-
baseUrl: 'https://api.moveris.
|
|
23
|
+
baseUrl: 'https://api.moveris.com', // optional, uses default
|
|
24
24
|
});
|
|
25
25
|
|
|
26
26
|
// Perform a fast liveness check
|
|
@@ -46,13 +46,13 @@ The main client for interacting with the Moveris Liveness API.
|
|
|
46
46
|
const client = new LivenessClient(config: LivenessClientConfig);
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
| Option | Type | Default
|
|
50
|
-
| ------------- | -------------- |
|
|
51
|
-
| `apiKey` | `string` | **required**
|
|
52
|
-
| `baseUrl` | `string` | `'https://api.moveris.
|
|
53
|
-
| `timeout` | `number` | `30000`
|
|
54
|
-
| `enableRetry` | `boolean` | `true`
|
|
55
|
-
| `customFetch` | `typeof fetch` | `fetch`
|
|
49
|
+
| Option | Type | Default | Description |
|
|
50
|
+
| ------------- | -------------- | --------------------------- | ----------------------------------------------- |
|
|
51
|
+
| `apiKey` | `string` | **required** | Your Moveris API key |
|
|
52
|
+
| `baseUrl` | `string` | `'https://api.moveris.com'` | API base URL |
|
|
53
|
+
| `timeout` | `number` | `30000` | Request timeout in milliseconds |
|
|
54
|
+
| `enableRetry` | `boolean` | `true` | Enable automatic retry with exponential backoff |
|
|
55
|
+
| `customFetch` | `typeof fetch` | `fetch` | Custom fetch implementation (for React Native) |
|
|
56
56
|
|
|
57
57
|
#### Methods
|
|
58
58
|
|
|
@@ -435,7 +435,7 @@ const cropRegion = calculateFaceCropRegion(faceBbox, frameWidth, frameHeight);
|
|
|
435
435
|
```typescript
|
|
436
436
|
import { DEFAULT_ENDPOINT, AUTH_CONFIG, RETRY_CONFIG, FRAME_CONFIG } from '@moveris/shared';
|
|
437
437
|
|
|
438
|
-
console.log(DEFAULT_ENDPOINT); // 'https://api.moveris.
|
|
438
|
+
console.log(DEFAULT_ENDPOINT); // 'https://api.moveris.com'
|
|
439
439
|
console.log(AUTH_CONFIG.apiKeyHeader); // 'X-API-Key'
|
|
440
440
|
console.log(RETRY_CONFIG.maxAttempts); // 3
|
|
441
441
|
console.log(FRAME_CONFIG.maxBufferSize); // 10
|