@maximem/synap-js-sdk 0.2.3 → 0.2.4
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 +5 -11
- package/package.json +1 -1
- package/types/index.d.ts +0 -1
package/README.md
CHANGED
|
@@ -37,14 +37,13 @@ Windows:
|
|
|
37
37
|
$env:USERPROFILE\.synap-js-sdk\.venv\Scripts\python.exe -c "import maximem_synap; print(maximem_synap.__version__)"
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
## Required Environment
|
|
40
|
+
## Required Environment Variable
|
|
41
41
|
|
|
42
42
|
- `SYNAP_API_KEY` (from the Synap dashboard — Instances → Generate API Key)
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
- `SYNAP_GRPC_TLS`
|
|
43
|
+
|
|
44
|
+
The SDK uses the default Synap cloud endpoints automatically. `SYNAP_BASE_URL`,
|
|
45
|
+
`SYNAP_GRPC_HOST`, `SYNAP_GRPC_PORT`, and `SYNAP_GRPC_TLS` are only needed for
|
|
46
|
+
advanced overrides such as local development or custom environments.
|
|
48
47
|
|
|
49
48
|
## Quick Start (JavaScript)
|
|
50
49
|
|
|
@@ -52,12 +51,7 @@ $env:USERPROFILE\.synap-js-sdk\.venv\Scripts\python.exe -c "import maximem_synap
|
|
|
52
51
|
const { createClient } = require('@maximem/synap-js-sdk');
|
|
53
52
|
|
|
54
53
|
const synap = createClient({
|
|
55
|
-
instanceId: process.env.SYNAP_INSTANCE_ID,
|
|
56
54
|
apiKey: process.env.SYNAP_API_KEY,
|
|
57
|
-
baseUrl: process.env.SYNAP_BASE_URL,
|
|
58
|
-
grpcHost: process.env.SYNAP_GRPC_HOST,
|
|
59
|
-
grpcPort: Number(process.env.SYNAP_GRPC_PORT || 50051),
|
|
60
|
-
grpcUseTls: process.env.SYNAP_GRPC_TLS === 'true',
|
|
61
55
|
});
|
|
62
56
|
|
|
63
57
|
async function run() {
|
package/package.json
CHANGED