@borgee/session
v0.1.2
Published
Borgee Session state, admitted controls, persistence and optional React presentation.
Downloads
64
Keywords
Readme
Borgee Session
@borgee/session provides Session state, recovery, admitted operations and optional React presentation. This README describes the source workspace; it does not establish that a matching npm release is available.
| Entry point | Responsibility |
| --- | --- |
| @borgee/session | Framework-neutral Borgee Session consumer, journal contracts, target resolution, observation coordination, operation admission and pure view-state helpers. |
| @borgee/session/indexeddb | Browser journal persistence, including transactional timeline replacement. |
| @borgee/session/react | AgentSessionView, presentation types, headers, interaction cards and message rendering. |
| @borgee/session/headless | Standalone Remote client, transport contracts, replica state and pure view helpers. This is not the Borgee BPP consumer. |
| @borgee/session/standalone | The same standalone API as /headless, under an explicit name. |
| @borgee/session/markdown | Browser Markdown rendering with source-specific profiles. |
| @borgee/session/styles.css | Shared component styles and KaTeX styles, with packaged font assets. |
The root and headless entry points do not require React or DOM globals. IndexedDB persistence is a separate entry point and requires IndexedDB when accessing its journal. React and React DOM are optional peers; a React host supplies compatible versions and TypeScript declarations. React presentation and Markdown rendering require a browser DOM.
Subpaths separate runtime imports, not package installation dependencies. Installing the package also installs its declared Markdown and other UI dependencies, even when only the core is used. Protocol and Plugin SDK remain independent dependencies; the provider contract is available through @borgee/plugin-sdk/provider; third-party JavaScript is not bundled into this package.
The host owns human authentication, Borgee transport, current access facts, attachment lifetime and durable drafts. The View consumes a resolved SessionPresentation; it does not authenticate, connect or grant permissions. Import the shared stylesheet and provide a bounded layout when mounting the View. A host can use the presentation components without connecting Borgee transport.
See the Remote Session View integration guide for host ports, operation receipts, persistent drafts, React wiring and acceptance checks.
The repository's manual publish workflow selects this package with session, verifies its exact foundation dependencies on Verdaccio and npm, and reuses the same tarball for both registries. Public publishing uses the NPM_PUBLISH_SESSION environment and npm OIDC trusted publishing. The package owner must bootstrap a missing npm package and configure its trusted publisher separately; this repository does not establish that registration or permission is complete. See the package publishing runbook for artifact checks, environment setup and release ordering.
