Skip to content

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

ExportKindNotes
MatrixActorclassHeadless actor base. The most-imported symbol in the tree.
WorkstreamActorclassWorkstream-specific actor base.
RootActorclassRuntime-as-actor at mount "".
MockRuntimeclassMinimal IMatrixRuntime for unit tests.
HeadlessComponentRegistryclassComponent registry for headless mode.
SupervisorclassOTP-style supervisor implementation.
DEFAULT_SUPERVISION_POLICYconstDefault { maxRestarts, windowMs }.
CheatDetectorclassCatches 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

ExportKindNotes
MatrixActorHtmlElementclassBrowser actor base — extends HTMLElement.
isTerminalPhasefunctionActivity-frame helper.
ActivityFrametypeStreaming protocol record.
ActivityPhasetypePhase enum.
buildCodeReffunctionPage manifest helper.
createEmptyManifest, addManifestEntry, removeManifestEntryfunctionsPage manifest helpers.
PageManifest, PageManifestEntrytypes
ACTIVITY_SINK_KEY, CompoundActivitySinkconst, classActivity-sink protocol.
IActivitySinktype
RECORD_STORE_KEY, RECORD_STORE_PROVIDER_KEYconstService-key sentinels.
IRecordStore, IRecordStoreProvidertypesPer-package observation store.
RecordFilter, RetentionPolicy, InteractionRecord, RecordKind, RecordPhase, RecordChanneltypes
ShellEffectBackendclassShell delegate for membrane execution.
ShellDelegatetype
MxContract, MxInterface, MxProxy, MxService, MxMiddlewares, defineComponents, MxTopicTagfunctions/componentsShell primitive elements.

@open-matrix/core — engine

ExportKindNotes
IMatrixContext, IMatrixRuntime, IComponentRegistryLiketypesInterfaces.
MatrixContext, MatrixContextOptionsclass, typeThe context implementation.
Lifecycleenum
Ports, parentToChild, childPorts, sendToutilitiesInter-actor port wiring.
TopicRouterclassComputes wire subjects from semantic topics.
SubscriptionBag, Unsubclass, type
MxEnvelopetypeThe wire envelope.
IInterfaceDescriptor, IMethodSpec, IParamSpec, IReturnSpec, ScalartypesReflection.
MatrixContractDescriptortype
GraphBuilderclassReflection helper.
RequestReply, requestReplyclass, functionRequest/reply helpers.
IRrRequestOptionstype
RequestReplyBinder, bindRRclass, function
RemoteProxy, proxyMountclass, function
ITransportAdapter, TransportAdaptertype, alias
TransportRegistry, getDefaultTransportRegistry, resetDefaultTransportRegistry, ITransportRegistryclass, functions, type
wrapTransport, ITransportMiddlewarefunction, type
NameUtils, toHandlerCaseobject, functionOp-name → handler conversion.

@open-matrix/core — runtime

ExportKindNotes
MatrixRuntimeclassThe runtime.
ShellElementRegistryclassCustom-element registry.
HeadlessHostclassDOM stub for headless mode.
ConsoleLogger, NullLoggerclass
IRuntimeHost, IRuntimeConfig, IRuntimeStats, IRuntimeEvent, RuntimeEventType, RuntimeEventListener, IRuntimeLogger, IRuntimeComponent, IComponentRegistration, IHostDocument, IHostElement, IHostShadowRoot, IHostCustomElementRegistrytypes
deepMergeConfig, resolveConfiguredPackageConfigfunctionsConfig resolution.
DeepPartial, IPackageConfigContract, IPackageConfigProviderDeclaration, IPackageConfigResolutionOptions, IResolveConfiguredPackageConfigParamstypes
createFromSchema, ICreateResult, ICreateOptionsfunction, typesComponent-from-schema factory.
SchemaEvaluator, ISchemaEvalResult, ISchemaEvalOptionsclass, types
BrowserDomStrategyclassDOM strategy for browser mode.
MatrixDSLHostclassBrowser bootstrap host element.
BootstrapOptionstype

@open-matrix/core — services

ExportKindNotes
ServiceRegistryclassPer-context service map.
IServiceMetatype

@open-matrix/core — transports

ExportKindNotes
InMemoryBrokerclassIn-process pub/sub broker.
InMemoryTransport, InMemoryTransportOptionsclass, type
NatsTransport, INatsTransportOptionsclass, type
createTransport, ICreateTransportConfigfunction, type
TransportProxyclass
WireCodecTransportclassCodec-wrapping transport.
FederationTransportAdapter, wrapFederationTransportclass, functionFederation bridge.

@open-matrix/core — middleware

ExportKindNotes
withRetry, createRetryingRR, IRetryOptionsfunctions, typeRetry middleware.
withCircuitBreaker, createCircuitBreaker, CircuitBreaker, CircuitOpenError, ICircuitBreakerOptions, CircuitState, ICircuitStatsfunctions, classes, typesCircuit breaker.

@open-matrix/core — flow

ExportKindNotes
FlowBuilder, FlowEngineclassesFlow orchestration.
createFlowContext, FlowContext, IFlowContextDatafunction, class, type
IFlowPlan, cloneFlowPlantype, function
FlowStage, ILocalMapStage, ILocalFilterStage, IRemoteRRStage, IRemoteSinkStagetypes

@open-matrix/core — topology

ExportKindNotes
IRuntimeRef, ITopologyComponentSpec, ITopologyPlantypesTopology shapes.
TopologyBuilder, TopologyDeployerclasses
IRuntimeControl, ISpawnComponentOptions, ISpawnResulttypes
LocalRuntimeControl, RemoteRuntimeControlclasses

@open-matrix/core — LISP / VLM (experimental)

ExportKindNotes
Interpreter, EvalContext, parseSExpr, parseSExprSingle, parseForEval, toSExpr, prettySExprclasses/functions
SCHEME_EXAMPLES, METACIRCULAR_EVAL, getMetacircularEvalconst/function
PARALLELIZABLE_OPS, canAtomize, allArgsAreAtomsconst/functions
allPrimitives, primitiveMap, buildPrimitiveMap, isPrimitive, getPrimitive, primitivesByCategory, wrapInDo, parseSchemeExampleconst/functions
LispEval, SchemeEval, BootstrapNodeclassesLISP components.
VLMRouter, VLMJoinCoordinator, VLMAtomizer, VLMBootstrapNode, VLMEntryPoint, getVLMNamespaceclasses/functionVLM components.
SExpr, ILambdaClosure, IMacroDef, IStream, IStreamOperator, ITravelingMessage, IVLMTrace, IJoinInfo, IVLMTravelingMessage, IAtomizedMessage, IRemoteCallHandler, IInterpreterOptions, IPrimitiveDefinition, PrimitiveHandler, INodeInfo, IJoinState, VLMEventType, IVLMEventtypes

@open-matrix/core — serialization

ExportKindNotes
serialize, parse, toHtml, fromHtml, toFluent, componentToSExpr, componentFromSExpr, toTopics, toJson, toJsonSchema, getTopicsArray, getSubscriptionMap, getPublicationMapfunctions
Serializabledecorator
SerializationFormat, ISerializable, IComponentSchema, IMethodSchema, IEventSchema, IParamSchema, ISerializationOptions, IParseResulttypes

@open-matrix/core — security

ExportKindNotes
SecurityRealmclass
DEFAULT_SECURITY_POLICYconst
TopicClaimRegistryclass
ITopicClaim, IClaimResult, IClaimQuerytypes
MessageDirection, ISecurityRealmtypes
ICapabilityToken, CapabilityRighttypes

@open-matrix/core — flow viewers

ExportKindNotes
ViewTypeRegistry, ActorViewProfile, ViewTypeRegistration, ViewMatchRuleclass, types
DataViewer, DataViewerShell, TreeViewer, TreeViewerShell, TableViewer, TableViewerShell, ErrorViewer, ErrorViewerShell, CommandResultViewer, CommandResultViewerShellclasses

@open-matrix/core — remoting

ExportKindNotes
ComponentProxy, createProxyclass, function

@open-matrix/core — QueryPad

ExportKindNotes
QueryPadclass

@matrix/test-utils

The full export list is short enough to reproduce verbatim from projects/matrix-3/packages/test-utils/src/index.ts:

ExportKindNotes
getAvailablePort, getAvailablePortsfunctionsPort allocation.
uniqueRealm, uniqueCorrelationId, uniqueTestDirfunctionsPer-test identifiers.
createTestProjectfunctionScaffold a project tree.
waitFor, retryfunctionsAsync polling helpers.
InMemoryBusclassLightweight pub/sub for tests.
Unsub, BusMeta, Handler, IEventBustypes
wrapBus, BusMiddleware, BusMiddlewareFn, BusMiddlewareObjfunction, typesBus middleware.
createDaemonHarness, DaemonHarnessfunction, typeReal-Host harness.
createNatsHarness, NatsHarnessfunction, typeReal-NATS harness.
isNatsServerAvailablefunctionSkip-condition helper.
startNatsServer, resolveNatsBinary, IRunningNatsServerfunction, typeDirect NATS startup.
findFilesContainingPattern, countPatternInFile, escapeRegExp, ScanOptionsfunctions, typeRepo grep.
assertActorMounted, assertMessagePublished, assertMessageNotPublished, assertHttpResponse, assertWithinBudget, guardNotNullfunctionsAssertions.

See also

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).