@asiyst/sdk 0.1.29 → 0.1.31

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 CHANGED
@@ -35,7 +35,7 @@ Asiyst.open();
35
35
 
36
36
  Do not pass a secret API key as `publicKey` or omit `projectId`.
37
37
 
38
- `avatarId` selects the avatar that the dashboard configured for this project. It is a public identifier, not an authorization credential. The SDK sends it as a selection hint while the Asiyst API still authenticates and authorizes the project with the public project key.
38
+ `avatarId` is a public identifier, not an authorization credential. The server remains authoritative for project and installation authorization.
39
39
 
40
40
  Knowledge sources, including optional GitHub repositories, are configured in Asiyst Web. The SDK does not receive GitHub credentials and does not copy Knowledge Base content into the website. It initializes the verified project/avatar and retrieves authorized knowledge through the Asiyst backend.
41
41
 
@@ -60,11 +60,14 @@ Mark important controls so the assistant can find them across layouts:
60
60
 
61
61
  The production API base is `https://nqhxpgsjofzqudyqkqib.supabase.co/functions/v1/api`. It is used by default and can only be overridden explicitly through `apiBaseUrl` for a controlled non-production deployment.
62
62
 
63
- If Cloud is unreachable, the SDK keeps a fallback avatar configuration and exposes `getConnectionStatus()` as `offline`. Conversation replies and task plans are not invented locally; those requests fail until Cloud responds.
63
+ If runtime config is unavailable, the SDK retains its local or eligible cached fallback config. `getConnectionStatus()` reports runtime verification separately. Visitor chat requires a verified installation and runtime token. Cloud task planning, workflows, telemetry, and website-map upload are not part of the current approved contract and are not sent.
64
64
 
65
65
  ## Documentation
66
66
 
67
67
  - Architecture: `docs/ARCHITECTURE.md`
68
68
  - API and events: `docs/API.md`
69
69
  - Security: `docs/SECURITY.md`
70
+ - Runtime contract: `docs/sdk-cli-contract.md`
71
+ - Runtime details: `docs/sdk-runtime.md`
72
+ - Installation: `docs/sdk-installation.md`
70
73
  - Troubleshooting: `docs/TROUBLESHOOTING.md`