Appearance
Public API ledger
This page is the human-readable index of named exports from @open-matrix/core's root barrel and @matrix/test-utils. For finer-grained reference (every subpath, every type), see Core subpath exports. For deprecation status of specific symbols, see Deprecated APIs.
The source of truth is projects/matrix-3/packages/core/src/index.ts and projects/matrix-3/packages/test-utils/src/index.ts. When in doubt, read those files; this ledger is a navigable index over them.
@open-matrix/core — actor surface
| Export | Kind | Notes |
|---|---|---|
MatrixActor | class | Headless actor base. The most-imported symbol in the tree. |
WorkstreamActor | class | Workstream-specific actor base. |
RootActor | class | Runtime-as-actor at mount "". |
MockRuntime | class | Minimal IMatrixRuntime for unit tests. |
HeadlessComponentRegistry | class | Component registry for headless mode. |
Supervisor | class | OTP-style supervisor implementation. |
DEFAULT_SUPERVISION_POLICY | const | Default { maxRestarts, windowMs }. |
CheatDetector | class | Catches actor-implementation cheats during tests. |
Types: Position, IAddChildOptions, IDynamicComponentDefinition, IComponentDescriptor, IChildDescriptor, IComponentRegistry, HeadlessComponentConstructor, ComponentLoader, ISupervisionError, SupervisionAction, BuiltinStrategy, SupervisionFn, SupervisionStrategy, IRestartLimits, ISupervisionPolicy, IComponentRuntimeMetadata, ComponentRegistrationSource, ComponentSourceKind, ComponentVersionSource, TargetArtifactKind, TargetRef.
@open-matrix/core — framework surface
| Export | Kind | Notes |
|---|---|---|
MatrixActorHtmlElement | class | Browser actor base — extends HTMLElement. |
isTerminalPhase | function | Activity-frame helper. |
ActivityFrame | type | Streaming protocol record. |
ActivityPhase | type | Phase enum. |
buildCodeRef | function | Page manifest helper. |
createEmptyManifest, addManifestEntry, removeManifestEntry | functions | Page manifest helpers. |
PageManifest, PageManifestEntry | types | |
ACTIVITY_SINK_KEY, CompoundActivitySink | const, class | Activity-sink protocol. |
IActivitySink | type | |
RECORD_STORE_KEY, RECORD_STORE_PROVIDER_KEY | const | Service-key sentinels. |
IRecordStore, IRecordStoreProvider | types | Per-package observation store. |
RecordFilter, RetentionPolicy, InteractionRecord, RecordKind, RecordPhase, RecordChannel | types | |
ShellEffectBackend | class | Shell delegate for membrane execution. |
ShellDelegate | type | |
MxContract, MxInterface, MxProxy, MxService, MxMiddlewares, defineComponents, MxTopicTag | functions/components | Shell primitive elements. |
@open-matrix/core — engine
| Export | Kind | Notes |
|---|---|---|
IMatrixContext, IMatrixRuntime, IComponentRegistryLike | types | Interfaces. |
MatrixContext, MatrixContextOptions | class, type | The context implementation. |
Lifecycle | enum | |
Ports, parentToChild, childPorts, sendTo | utilities | Inter-actor port wiring. |
TopicRouter | class | Computes wire subjects from semantic topics. |
SubscriptionBag, Unsub | class, type | |
MxEnvelope | type | The wire envelope. |
IInterfaceDescriptor, IMethodSpec, IParamSpec, IReturnSpec, Scalar | types | Reflection. |
MatrixContractDescriptor | type | |
GraphBuilder | class | Reflection helper. |
RequestReply, requestReply | class, function | Request/reply helpers. |
IRrRequestOptions | type | |
RequestReplyBinder, bindRR | class, function | |
RemoteProxy, proxyMount | class, function | |
ITransportAdapter, TransportAdapter | type, alias | |
TransportRegistry, getDefaultTransportRegistry, resetDefaultTransportRegistry, ITransportRegistry | class, functions, type | |
wrapTransport, ITransportMiddleware | function, type | |
NameUtils, toHandlerCase | object, function | Op-name → handler conversion. |
@open-matrix/core — runtime
| Export | Kind | Notes |
|---|---|---|
MatrixRuntime | class | The runtime. |
ShellElementRegistry | class | Custom-element registry. |
HeadlessHost | class | DOM stub for headless mode. |
ConsoleLogger, NullLogger | class | |
IRuntimeHost, IRuntimeConfig, IRuntimeStats, IRuntimeEvent, RuntimeEventType, RuntimeEventListener, IRuntimeLogger, IRuntimeComponent, IComponentRegistration, IHostDocument, IHostElement, IHostShadowRoot, IHostCustomElementRegistry | types | |
deepMergeConfig, resolveConfiguredPackageConfig | functions | Config resolution. |
DeepPartial, IPackageConfigContract, IPackageConfigProviderDeclaration, IPackageConfigResolutionOptions, IResolveConfiguredPackageConfigParams | types | |
createFromSchema, ICreateResult, ICreateOptions | function, types | Component-from-schema factory. |
SchemaEvaluator, ISchemaEvalResult, ISchemaEvalOptions | class, types | |
BrowserDomStrategy | class | DOM strategy for browser mode. |
MatrixDSLHost | class | Browser bootstrap host element. |
BootstrapOptions | type |
@open-matrix/core — services
| Export | Kind | Notes |
|---|---|---|
ServiceRegistry | class | Per-context service map. |
IServiceMeta | type |
@open-matrix/core — transports
| Export | Kind | Notes |
|---|---|---|
InMemoryBroker | class | In-process pub/sub broker. |
InMemoryTransport, InMemoryTransportOptions | class, type | |
NatsTransport, INatsTransportOptions | class, type | |
createTransport, ICreateTransportConfig | function, type | |
TransportProxy | class | |
WireCodecTransport | class | Codec-wrapping transport. |
FederationTransportAdapter, wrapFederationTransport | class, function | Federation bridge. |
@open-matrix/core — middleware
| Export | Kind | Notes |
|---|---|---|
withRetry, createRetryingRR, IRetryOptions | functions, type | Retry middleware. |
withCircuitBreaker, createCircuitBreaker, CircuitBreaker, CircuitOpenError, ICircuitBreakerOptions, CircuitState, ICircuitStats | functions, classes, types | Circuit breaker. |
@open-matrix/core — flow
| Export | Kind | Notes |
|---|---|---|
FlowBuilder, FlowEngine | classes | Flow orchestration. |
createFlowContext, FlowContext, IFlowContextData | function, class, type | |
IFlowPlan, cloneFlowPlan | type, function | |
FlowStage, ILocalMapStage, ILocalFilterStage, IRemoteRRStage, IRemoteSinkStage | types |
@open-matrix/core — topology
| Export | Kind | Notes |
|---|---|---|
IRuntimeRef, ITopologyComponentSpec, ITopologyPlan | types | Topology shapes. |
TopologyBuilder, TopologyDeployer | classes | |
IRuntimeControl, ISpawnComponentOptions, ISpawnResult | types | |
LocalRuntimeControl, RemoteRuntimeControl | classes |
@open-matrix/core — LISP / VLM (experimental)
| Export | Kind | Notes |
|---|---|---|
Interpreter, EvalContext, parseSExpr, parseSExprSingle, parseForEval, toSExpr, prettySExpr | classes/functions | |
SCHEME_EXAMPLES, METACIRCULAR_EVAL, getMetacircularEval | const/function | |
PARALLELIZABLE_OPS, canAtomize, allArgsAreAtoms | const/functions | |
allPrimitives, primitiveMap, buildPrimitiveMap, isPrimitive, getPrimitive, primitivesByCategory, wrapInDo, parseSchemeExample | const/functions | |
LispEval, SchemeEval, BootstrapNode | classes | LISP components. |
VLMRouter, VLMJoinCoordinator, VLMAtomizer, VLMBootstrapNode, VLMEntryPoint, getVLMNamespace | classes/function | VLM components. |
SExpr, ILambdaClosure, IMacroDef, IStream, IStreamOperator, ITravelingMessage, IVLMTrace, IJoinInfo, IVLMTravelingMessage, IAtomizedMessage, IRemoteCallHandler, IInterpreterOptions, IPrimitiveDefinition, PrimitiveHandler, INodeInfo, IJoinState, VLMEventType, IVLMEvent | types |
@open-matrix/core — serialization
| Export | Kind | Notes |
|---|---|---|
serialize, parse, toHtml, fromHtml, toFluent, componentToSExpr, componentFromSExpr, toTopics, toJson, toJsonSchema, getTopicsArray, getSubscriptionMap, getPublicationMap | functions | |
Serializable | decorator | |
SerializationFormat, ISerializable, IComponentSchema, IMethodSchema, IEventSchema, IParamSchema, ISerializationOptions, IParseResult | types |
@open-matrix/core — security
| Export | Kind | Notes |
|---|---|---|
SecurityRealm | class | |
DEFAULT_SECURITY_POLICY | const | |
TopicClaimRegistry | class | |
ITopicClaim, IClaimResult, IClaimQuery | types | |
MessageDirection, ISecurityRealm | types | |
ICapabilityToken, CapabilityRight | types |
@open-matrix/core — flow viewers
| Export | Kind | Notes |
|---|---|---|
ViewTypeRegistry, ActorViewProfile, ViewTypeRegistration, ViewMatchRule | class, types | |
DataViewer, DataViewerShell, TreeViewer, TreeViewerShell, TableViewer, TableViewerShell, ErrorViewer, ErrorViewerShell, CommandResultViewer, CommandResultViewerShell | classes |
@open-matrix/core — remoting
| Export | Kind | Notes |
|---|---|---|
ComponentProxy, createProxy | class, function |
@open-matrix/core — QueryPad
| Export | Kind | Notes |
|---|---|---|
QueryPad | class |
@matrix/test-utils
The full export list is short enough to reproduce verbatim from projects/matrix-3/packages/test-utils/src/index.ts:
| Export | Kind | Notes |
|---|---|---|
getAvailablePort, getAvailablePorts | functions | Port allocation. |
uniqueRealm, uniqueCorrelationId, uniqueTestDir | functions | Per-test identifiers. |
createTestProject | function | Scaffold a project tree. |
waitFor, retry | functions | Async polling helpers. |
InMemoryBus | class | Lightweight pub/sub for tests. |
Unsub, BusMeta, Handler, IEventBus | types | |
wrapBus, BusMiddleware, BusMiddlewareFn, BusMiddlewareObj | function, types | Bus middleware. |
createDaemonHarness, DaemonHarness | function, type | Real-Host harness. |
createNatsHarness, NatsHarness | function, type | Real-NATS harness. |
isNatsServerAvailable | function | Skip-condition helper. |
startNatsServer, resolveNatsBinary, IRunningNatsServer | function, type | Direct NATS startup. |
findFilesContainingPattern, countPatternInFile, escapeRegExp, ScanOptions | functions, type | Repo grep. |
assertActorMounted, assertMessagePublished, assertMessageNotPublished, assertHttpResponse, assertWithinBudget, guardNotNull | functions | Assertions. |
See also
- Core subpath exports — every subpath, in detail.
- Deprecated APIs — what's
@deprecated. - Migration guides — version-by-version steps.
Source:
projects/matrix-3/packages/core/src/index.ts:1-345(root barrel — primary list),projects/matrix-3/packages/test-utils/src/index.ts:1-58(test-utils exports).