Skip to content

Frontend Sdk

Frontend Sdk package for Crystal Lattice.

Testing

Run fast/default package tests from the repository root:

npm --workspace @crystal-lattice/frontend-sdk test

Or from this package directory:

npm test

The default Vitest config excludes src/integration/**, so this command is the safe everyday check for SDK logic, transports, reducers, plugin helpers, and other unit-style tests.

Development documentation starts at docs/development/index.md.

Integration and e2e suites live under src/integration/__tests__ and are selected by explicit package scripts. Start with the detailed integration guide:

Common categories:

  • Local backend integration: npm run integration:backend
  • Hosted provider integration: npm run integration:backend:openai, npm run integration:backend:openrouter, npm run integration:backend:openrouter-images, npm run integration:backend:openrouter:mcp
  • Bridge e2e: npm run integration:bridge
  • Cloud orchestrator e2e: npm run integration:cloud, npm run integration:cloud:profiles
  • AWS-backed e2e and maintenance commands: run only when intentionally working on those deployments

Bridge transport modes

createBridgeConnectionTransport() supports WebSocket, HTTP, and hybrid operation. HTTP is the product default; explicit WebSocket and hybrid modes remain available for development diagnostics and never provide automatic fallback.

See Bridge transports for pairing, mode routing, binary behavior, persistence, lifecycle, and rollback.

Session request status

The optional backend and saved-connection status query contracts are described in Session request status.

Agent descriptors

Stable agent IDs and optional ordered title/description metadata are described in Agent descriptors.

Session and message projection

The REST backend can retrieve plugin-filtered session summaries and projected canonical message ranges without changing the complete list methods. See Session and message data queries.

License

Copyright 2026 Dynamic Programming Solutions Kft.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.