Skip to main content

@realitycollective/service-framework-client

A pre-wired React and three.js client for the Reality Collective TypeScript Service Framework. The React bindings and the three.js render bridge are already connected. Your app starts from a working runtime instead of assembling the scheduler and bridge by hand.

npm install @realitycollective/service-framework-client

It depends on the core, the React bindings and the three.js bridge, and re-exports all three. Installing this one package is enough.

What it composes

AreaDetail
RuntimeOwns the service manager, the scheduler and the render loop, and starts them in the right order
ProfileA starting list of services you add your own to
ServicesThe services most client apps need anyway, already registered
ReactThe React provider, already pointed at that runtime
TokensThe lookup keys for those built-in services

When to use it

  • Use this when you are building a React + three.js client and want the standard wiring.
  • Use the core plus a single binding when you need a different host, or want to own the composition yourself.

Peer dependency

react ^19.2.0.

Live examples

Documentation

The Weather Client Walkthrough builds a deployable app on this package step by step. Runnable apps live in the repository's runtime-examples/ folder, and a focused example ships in this package's Examples/ folder.

License

MIT - see LICENSE.

Classes

ClassDescription
BackendAdapterService-
BaseBackendAdapterModule-
BaseFrameworkClientRuntime-
CapabilityService-
ContentContextService-
ConversationService-
ExperienceStateService-
MockBackendAdapterModule-
RenderStateService-
RestBackendAdapterModule-
SessionService-

Interfaces

InterfaceDescription
AnimationLoopHostLike-
BackendAdapterServiceConfig-
BackendAdapterStateSnapshot-
BackendConversationRequest-
BackendConversationResponse-
BaseFrameworkClientEnvironmentOptions-
BaseFrameworkClientProfileOptions-
BaseFrameworkClientProviderProps-
BaseFrameworkClientRuntimeLike-
BaseFrameworkClientRuntimeOptions-
CapabilitySnapshot-
ChangeAwareService-
ContentContextSnapshot-
ConversationMessage-
ConversationServiceConfig-
ConversationSnapshot-
ExperienceStateConfig-
ExperienceStateSnapshot-
GeolocationSnapshot-
MockBackendAdapterConfig-
RenderStateSnapshot-
ResponseLike-
RestBackendAdapterConfig-
SessionServiceConfig-
SessionSnapshot-

Type Aliases

Type AliasDescription
BackendAdapterKind-
ClientMode-
ConnectionState-
ConversationRole-
FetchLike-
WidgetState-

Variables

VariableDescription
BACKEND_ADAPTER_SERVICE_TOKEN-
CAPABILITY_SERVICE_TOKEN-
CONTENT_CONTEXT_SERVICE_TOKEN-
CONVERSATION_SERVICE_TOKEN-
EXPERIENCE_STATE_SERVICE_TOKEN-
MOCK_BACKEND_ADAPTER_MODULE_TOKEN-
RENDER_STATE_SERVICE_TOKEN-
REST_BACKEND_ADAPTER_MODULE_TOKEN-
SESSION_SERVICE_TOKEN-

Functions

FunctionDescription
BaseFrameworkClientProvider-
createBaseFrameworkClientEnvironment-
createBaseFrameworkClientProfile-
useBackendAdapterService-
useBackendAdapterState-
useCapabilityService-
useCapabilityState-
useContentContext-
useContentContextService-
useConversationService-
useConversationState-
useExperienceState-
useExperienceStateService-
useRenderState-
useRenderStateService-
useSessionService-
useSessionState-