Skip to content

adapterSubsystem

FieldValue
PrefixadapterSubsystem
Namespace constantAdapterSubsystemNamespace
Subjects constantAdapterSubsystemSubjects
Kindbus
Schema recordAdapterSubsystemSchemas
Tierframework
Package@makaio/services-core
Defined inpackages/services/core/src/adapter-subsystem/namespace.ts
KeyWireTypeSchema
adapter.registeredadapterSubsystem.adapter.registeredeventschemas.ts
bindadapterSubsystem.bindrpcschemas.ts
binding.createdadapterSubsystem.binding.createdeventschemas.ts
binding.defaultChangedadapterSubsystem.binding.defaultChangedeventschemas.ts
binding.deletedadapterSubsystem.binding.deletedeventschemas.ts
buildProviderContextadapterSubsystem.buildProviderContextrpcschemas.ts
createProviderConfigadapterSubsystem.createProviderConfigrpcschemas.ts
deleteProviderConfigadapterSubsystem.deleteProviderConfigrpcschemas.ts
ensureReadyadapterSubsystem.ensureReadyrpcschemas.ts
findConfigForDefinitionAndAdapteradapterSubsystem.findConfigForDefinitionAndAdapterrpcschemas.ts
getAdapterConfigadapterSubsystem.getAdapterConfigrpcschemas.ts
getDefaultBindingadapterSubsystem.getDefaultBindingrpcschemas.ts
getProviderConfigadapterSubsystem.getProviderConfigrpcschemas.ts
getProviderDefinitionsByAdapteradapterSubsystem.getProviderDefinitionsByAdapterrpcschemas.ts
listAdapterConfigsadapterSubsystem.listAdapterConfigsrpcschemas.ts
listAdaptersadapterSubsystem.listAdaptersrpcschemas.ts
listBindingsadapterSubsystem.listBindingsrpcschemas.ts
listBindingsByConfigadapterSubsystem.listBindingsByConfigrpcschemas.ts
listProviderConfigsadapterSubsystem.listProviderConfigsrpcschemas.ts
listProviderConfigsByDefinitionadapterSubsystem.listProviderConfigsByDefinitionrpcschemas.ts
providerConfig.createdadapterSubsystem.providerConfig.createdeventschemas.ts
providerConfig.defaultChangedadapterSubsystem.providerConfig.defaultChangedeventschemas.ts
providerConfig.deletedadapterSubsystem.providerConfig.deletedeventschemas.ts
providerConfig.updatedadapterSubsystem.providerConfig.updatedeventschemas.ts
readyadapterSubsystem.readyeventschemas.ts
setAdapterConfigadapterSubsystem.setAdapterConfigrpcschemas.ts
setAdapterEnabledadapterSubsystem.setAdapterEnabledrpcschemas.ts
setDefaultBindingadapterSubsystem.setDefaultBindingrpcschemas.ts
setDefaultProviderConfigadapterSubsystem.setDefaultProviderConfigrpcschemas.ts
setModelFilterModeadapterSubsystem.setModelFilterModerpcschemas.ts
setProviderConfigCredentialRefsadapterSubsystem.setProviderConfigCredentialRefsrpcschemas.ts
unbindadapterSubsystem.unbindrpcschemas.ts
updateProviderConfigadapterSubsystem.updateProviderConfigrpcschemas.ts

adapterSubsystem.adapter.registered (event)

Section titled “adapterSubsystem.adapter.registered (event)”

Emitted once per adapter after the adapter-subsystem service processes a newly-active adapter package.

Replaces the retired batch adaptersRegistered event. The model registry and other subscribers react per-adapter and debounce refreshes as needed.

Fire-and-forget; no replay guarantee.

Subject: adapterSubsystem.adapter.registered Type: Event

FieldTypeRequired
adapterNamestringyes
displayNamestringyes
enabledbooleanyes
initializedbooleanyes
packageNamestringyes
providerDefinitionIdsstring[]yes

Bind a provider config to an adapter.

Subject: adapterSubsystem.bind Type: Request (RPC)

Request:

FieldTypeRequired
adapterNamestringyes
providerConfigIdstringyes

Response:

FieldTypeRequired
binding{ adapterName: string; providerConfigId: string; isDefault: boolean; }yes

Binding lifecycle events.

Subject: adapterSubsystem.binding.created Type: Event

FieldTypeRequired
adapterNamestringyes
isDefaultbooleanyes
providerConfigIdstringyes

adapterSubsystem.binding.defaultChanged (event)

Section titled “adapterSubsystem.binding.defaultChanged (event)”

Subject: adapterSubsystem.binding.defaultChanged Type: Event

FieldTypeRequired
adapterNamestringyes
providerConfigIdstringyes

Subject: adapterSubsystem.binding.deleted Type: Event

FieldTypeRequired
adapterNamestringyes
providerConfigIdstringyes

adapterSubsystem.buildProviderContext (rpc)

Section titled “adapterSubsystem.buildProviderContext (rpc)”

Build a provider context from a provider config.

Subject: adapterSubsystem.buildProviderContext Type: Request (RPC)

Request:

FieldTypeRequired
providerConfigIdstringyes

Response:

FieldTypeRequired
context{ providerConfigId: string; definitionId: string; credentialRefs: Record<string, string & $brand<"CredentialRef">>; endpointOverrides?: { anthropic?: string | undefined; openai?: string | undefined; } | undefined; credentialEnvVars?: Record<string, string> | undefined; ambientCredentialEnvVars?: string[] | undefined; } | nullyes

adapterSubsystem.createProviderConfig (rpc)

Section titled “adapterSubsystem.createProviderConfig (rpc)”

Create a provider config.

Subject: adapterSubsystem.createProviderConfig Type: Request (RPC)

Request:

FieldTypeRequired
credentialRefsRecord<string, string & $brand<"CredentialRef">> | undefinedno
definitionIdstringyes
endpointOverrides{ anthropic?: string | undefined; openai?: string | undefined; } | undefinedno
isSentinelboolean | undefinedno
modelFilterMode"allowlist" | "show-all" | undefinedno
modelVisibilityRecord<string, "enabled" | "disabled" | "visible"> | undefinedno
namestring | undefinedno

Response:

FieldTypeRequired
config{ id: string; definitionId: string; name: string; modelFilterMode: "allowlist" | "show-all"; isDefault: boolean; enabled: boolean; isSentinel: boolean; hasCredentials: boolean; endpointOverrides?: Record<string, string> | undefined; modelVisibility?: Record<string, "enabled" | "disabled" | "visible"> | undefined; sourceRef?: string | undefined; }yes

adapterSubsystem.deleteProviderConfig (rpc)

Section titled “adapterSubsystem.deleteProviderConfig (rpc)”

Delete a provider config.

Subject: adapterSubsystem.deleteProviderConfig Type: Request (RPC)

Request:

FieldTypeRequired
idstringyes

Response:

FieldTypeRequired
deletedbooleanyes

Ensure the subsystem is ready for grain-constrained consumers.

Subject: adapterSubsystem.ensureReady Type: Request (RPC)

Request:

Empty object.

Response:

FieldTypeRequired
readytrueyes

adapterSubsystem.findConfigForDefinitionAndAdapter (rpc)

Section titled “adapterSubsystem.findConfigForDefinitionAndAdapter (rpc)”

Find the provider config bound to a specific adapter for a definition.

Subject: adapterSubsystem.findConfigForDefinitionAndAdapter Type: Request (RPC)

Request:

FieldTypeRequired
adapterNamestringyes
definitionIdstringyes

Response:

FieldTypeRequired
config{ id: string; definitionId: string; name: string; modelFilterMode: "allowlist" | "show-all"; isDefault: boolean; enabled: boolean; isSentinel: boolean; hasCredentials: boolean; endpointOverrides?: Record<string, string> | undefined; modelVisibility?: Record<string, "enabled" | "disabled" | "visible"> | undefined; sourceRef?: string | undefined; } | nullyes

Get one adapter config by adapter name.

Subject: adapterSubsystem.getAdapterConfig Type: Request (RPC)

Request:

FieldTypeRequired
namestringyes

Response:

FieldTypeRequired
config{ name: string; enabled: boolean; bindings: { adapterName: string; providerConfigId: string; isDefault: boolean; }[]; description?: string | undefined; clientId?: string | undefined; displayName?: string | undefined; protocol?: string | undefined; helpLinks?: { label: string; url: string; }[] | undefined; instructions?: string | undefined; providerDefinitionIds?: string[] | undefined; settings?: Record<string, unknown> | undefined; } | nullyes

Get the default binding for an adapter.

Subject: adapterSubsystem.getDefaultBinding Type: Request (RPC)

Request:

FieldTypeRequired
adapterNamestringyes

Response:

FieldTypeRequired
binding{ adapterName: string; providerConfigId: string; isDefault: boolean; } | nullyes

Get one provider config by ID.

Subject: adapterSubsystem.getProviderConfig Type: Request (RPC)

Request:

FieldTypeRequired
idstringyes

Response:

FieldTypeRequired
config{ id: string; definitionId: string; name: string; modelFilterMode: "allowlist" | "show-all"; isDefault: boolean; enabled: boolean; isSentinel: boolean; hasCredentials: boolean; endpointOverrides?: Record<string, string> | undefined; modelVisibility?: Record<string, "enabled" | "disabled" | "visible"> | undefined; sourceRef?: string | undefined; } | nullyes

adapterSubsystem.getProviderDefinitionsByAdapter (rpc)

Section titled “adapterSubsystem.getProviderDefinitionsByAdapter (rpc)”

Get provider definitions contributed by a specific adapter.

Returns the full provider definition array for the named adapter, including the registry-populated availableModels set at boot time.

Subject: adapterSubsystem.getProviderDefinitionsByAdapter Type: Request (RPC)

Request:

FieldTypeRequired
adapterNamestringyes

Response:

FieldTypeRequired
definitions{ id: string; name: string; availableModels: { name: string; contextWindowSize: number; labId: string; friendlyName?: string | undefined; family?: string | undefined; supportedReasoningLevels?: { none?: string | number | undefined; low?: string | number | undefined; medium?: string | number | undefined; high?: string | number | undefined; 'extra-high'?: string | number | undefined; } | undefined; metadata?: { maxOutputTokens?: number | undefined; capabilities?: { vision?: boolean | undefined; toolCalling?: boolean | undefined; parallelToolCalls?: boolean | undefined; structuredOutput?: boolean | undefined; pdfUpload?: boolean | undefined; speechToText?: { modes: ("batch" | "streaming")[]; vocabularyBiasing?: boolean | undefined; } | undefined; textToSpeech?: { modes: ("streaming" | "buffered")[]; voiceSelection?: boolean | undefined; voiceInstructions?: boolean | undefined; outputFormats?: string[] | undefined; } | undefined; } | undefined; pricing?: { token?: { inputPerMillion: number; outputPerMillion: number; inputCachedPerMillion?: number | undefined; cacheWritePerMillion?: number | undefined; } | undefined; request?: { multiplier: number; } | undefined; } | undefined; includedInSubscription?: boolean | undefined; description?: string | undefined; } | undefined; }[]; description?: string | undefined; endpoints?: { anthropic?: string | undefined; openai?: string | undefined; } | undefined; defaultModel?: string | undefined; fastModel?: string | undefined; defaultModelFilterMode?: "allowlist" | "show-all" | undefined; credentialEnvVars?: Record<string, string> | undefined; }[]yes

List all adapter configs.

Subject: adapterSubsystem.listAdapterConfigs Type: Request (RPC)

Request:

Empty object.

Response:

FieldTypeRequired
configs{ name: string; enabled: boolean; bindings: { adapterName: string; providerConfigId: string; isDefault: boolean; }[]; description?: string | undefined; clientId?: string | undefined; displayName?: string | undefined; protocol?: string | undefined; helpLinks?: { label: string; url: string; }[] | undefined; instructions?: string | undefined; providerDefinitionIds?: string[] | undefined; settings?: Record<string, unknown> | undefined; }[]yes

List effective adapters.

Subject: adapterSubsystem.listAdapters Type: Request (RPC)

Request:

Empty object.

Response:

FieldTypeRequired
adapters{ name: string; displayName: string; enabled: boolean; configCount: number; readiness: "ready" | "needs-setup"; supportsLogImport: boolean; description?: string | undefined; helpLinks?: { label: string; url: string; }[] | undefined; instructions?: string | undefined; clientId?: string | undefined; protocol?: string | undefined; providerDefinitionIds?: string[] | undefined; }[]yes

List bindings for an adapter.

Subject: adapterSubsystem.listBindings Type: Request (RPC)

Request:

FieldTypeRequired
adapterNamestringyes

Response:

FieldTypeRequired
bindings{ adapterName: string; providerConfigId: string; isDefault: boolean; }[]yes

adapterSubsystem.listBindingsByConfig (rpc)

Section titled “adapterSubsystem.listBindingsByConfig (rpc)”

List bindings for a provider config.

Subject: adapterSubsystem.listBindingsByConfig Type: Request (RPC)

Request:

FieldTypeRequired
providerConfigIdstringyes

Response:

FieldTypeRequired
bindings{ adapterName: string; providerConfigId: string; isDefault: boolean; }[]yes

adapterSubsystem.listProviderConfigs (rpc)

Section titled “adapterSubsystem.listProviderConfigs (rpc)”

List provider configs, optionally filtering by enabled state.

Subject: adapterSubsystem.listProviderConfigs Type: Request (RPC)

Request:

FieldTypeRequired
enabledboolean | undefinedno

Response:

FieldTypeRequired
configs{ id: string; definitionId: string; name: string; modelFilterMode: "allowlist" | "show-all"; isDefault: boolean; enabled: boolean; isSentinel: boolean; hasCredentials: boolean; endpointOverrides?: Record<string, string> | undefined; modelVisibility?: Record<string, "enabled" | "disabled" | "visible"> | undefined; sourceRef?: string | undefined; }[]yes

adapterSubsystem.listProviderConfigsByDefinition (rpc)

Section titled “adapterSubsystem.listProviderConfigsByDefinition (rpc)”

List provider configs for a given provider definition.

Subject: adapterSubsystem.listProviderConfigsByDefinition Type: Request (RPC)

Request:

FieldTypeRequired
definitionIdstringyes

Response:

FieldTypeRequired
configs{ id: string; definitionId: string; name: string; modelFilterMode: "allowlist" | "show-all"; isDefault: boolean; enabled: boolean; isSentinel: boolean; hasCredentials: boolean; endpointOverrides?: Record<string, string> | undefined; modelVisibility?: Record<string, "enabled" | "disabled" | "visible"> | undefined; sourceRef?: string | undefined; }[]yes

adapterSubsystem.providerConfig.created (event)

Section titled “adapterSubsystem.providerConfig.created (event)”

Provider config lifecycle events.

Subject: adapterSubsystem.providerConfig.created Type: Event

FieldTypeRequired
definitionIdstringyes
enabledbooleanyes
endpointOverridesRecord<string, string> | undefinedno
hasCredentialsbooleanyes
idstringyes
isDefaultbooleanyes
isSentinelbooleanyes
modelFilterMode"allowlist" | "show-all"yes
modelVisibilityRecord<string, "enabled" | "disabled" | "visible"> | undefinedno
namestringyes
sourceRefstring | undefinedno

adapterSubsystem.providerConfig.defaultChanged (event)

Section titled “adapterSubsystem.providerConfig.defaultChanged (event)”

Subject: adapterSubsystem.providerConfig.defaultChanged Type: Event

FieldTypeRequired
configIdstring | nullyes
definitionIdstringyes

adapterSubsystem.providerConfig.deleted (event)

Section titled “adapterSubsystem.providerConfig.deleted (event)”

Subject: adapterSubsystem.providerConfig.deleted Type: Event

FieldTypeRequired
idstringyes

adapterSubsystem.providerConfig.updated (event)

Section titled “adapterSubsystem.providerConfig.updated (event)”

Bus-safe provider config read model.

Generic reads intentionally exclude credential refs. Runtime assembly goes through buildProviderContext instead.

Subject: adapterSubsystem.providerConfig.updated Type: Event

FieldTypeRequired
definitionIdstringyes
enabledbooleanyes
endpointOverridesRecord<string, string> | undefinedno
hasCredentialsbooleanyes
idstringyes
isDefaultbooleanyes
isSentinelbooleanyes
modelFilterMode"allowlist" | "show-all"yes
modelVisibilityRecord<string, "enabled" | "disabled" | "visible"> | undefinedno
namestringyes
sourceRefstring | undefinedno

Readiness observability event (fire-and-forget, no replay guarantee).

Listeners registered after the subsystem emits this event will miss it. Use ensureReady (request/response) for reliable coordination.

Subject: adapterSubsystem.ready Type: Event

Empty object.

Set adapter config fields.

Subject: adapterSubsystem.setAdapterConfig Type: Request (RPC)

Request:

FieldTypeRequired
namestringyes
patch{ displayName?: string | undefined; description?: string | undefined; helpLinks?: { label: string; url: string; }[] | undefined; instructions?: string | undefined; clientId?: string | undefined; protocol?: string | undefined; providerDefinitionIds?: string[] | undefined; settings?: Record<string, unknown> | undefined; enabled?: boolean | undefined; }yes

Response:

FieldTypeRequired
config{ name: string; enabled: boolean; bindings: { adapterName: string; providerConfigId: string; isDefault: boolean; }[]; description?: string | undefined; clientId?: string | undefined; displayName?: string | undefined; protocol?: string | undefined; helpLinks?: { label: string; url: string; }[] | undefined; instructions?: string | undefined; providerDefinitionIds?: string[] | undefined; settings?: Record<string, unknown> | undefined; }yes

Enable or disable an adapter config.

Subject: adapterSubsystem.setAdapterEnabled Type: Request (RPC)

Request:

FieldTypeRequired
enabledbooleanyes
namestringyes

Response:

FieldTypeRequired
successbooleanyes

Set the default binding for an adapter.

Subject: adapterSubsystem.setDefaultBinding Type: Request (RPC)

Request:

FieldTypeRequired
adapterNamestringyes
providerConfigIdstringyes

Response:

Empty object.

adapterSubsystem.setDefaultProviderConfig (rpc)

Section titled “adapterSubsystem.setDefaultProviderConfig (rpc)”

Set the default provider config for its definition.

Subject: adapterSubsystem.setDefaultProviderConfig Type: Request (RPC)

Request:

FieldTypeRequired
idstringyes

Response:

FieldTypeRequired
config{ id: string; definitionId: string; name: string; modelFilterMode: "allowlist" | "show-all"; isDefault: boolean; enabled: boolean; isSentinel: boolean; hasCredentials: boolean; endpointOverrides?: Record<string, string> | undefined; modelVisibility?: Record<string, "enabled" | "disabled" | "visible"> | undefined; sourceRef?: string | undefined; }yes

Set the model filter mode for a provider config.

Subject: adapterSubsystem.setModelFilterMode Type: Request (RPC)

Request:

FieldTypeRequired
idstringyes
modelFilterMode"allowlist" | "show-all"yes
preferredModelstring | undefinedno

Response:

FieldTypeRequired
config{ id: string; definitionId: string; name: string; modelFilterMode: "allowlist" | "show-all"; isDefault: boolean; enabled: boolean; isSentinel: boolean; hasCredentials: boolean; endpointOverrides?: Record<string, string> | undefined; modelVisibility?: Record<string, "enabled" | "disabled" | "visible"> | undefined; sourceRef?: string | undefined; }yes

adapterSubsystem.setProviderConfigCredentialRefs (rpc)

Section titled “adapterSubsystem.setProviderConfigCredentialRefs (rpc)”

Replace the canonical credential refs for one provider config.

Subject: adapterSubsystem.setProviderConfigCredentialRefs Type: Request (RPC)

Request:

FieldTypeRequired
credentialRefsRecord<string, string & $brand<"CredentialRef">>yes
idstringyes

Response:

FieldTypeRequired
config{ id: string; definitionId: string; name: string; modelFilterMode: "allowlist" | "show-all"; isDefault: boolean; enabled: boolean; isSentinel: boolean; hasCredentials: boolean; endpointOverrides?: Record<string, string> | undefined; modelVisibility?: Record<string, "enabled" | "disabled" | "visible"> | undefined; sourceRef?: string | undefined; }yes

Unbind a provider config from an adapter.

Subject: adapterSubsystem.unbind Type: Request (RPC)

Request:

FieldTypeRequired
adapterNamestringyes
providerConfigIdstringyes

Response:

Empty object.

adapterSubsystem.updateProviderConfig (rpc)

Section titled “adapterSubsystem.updateProviderConfig (rpc)”

Update a provider config.

Subject: adapterSubsystem.updateProviderConfig Type: Request (RPC)

Request:

FieldTypeRequired
idstringyes
patch{ name?: string | undefined; endpointOverrides?: { anthropic?: string | undefined; openai?: string | undefined; } | null | undefined; modelVisibility?: Record<string, "enabled" | "disabled" | "visible"> | undefined; enabled?: boolean | undefined; }yes

Response:

FieldTypeRequired
config{ id: string; definitionId: string; name: string; modelFilterMode: "allowlist" | "show-all"; isDefault: boolean; enabled: boolean; isSentinel: boolean; hasCredentials: boolean; endpointOverrides?: Record<string, string> | undefined; modelVisibility?: Record<string, "enabled" | "disabled" | "visible"> | undefined; sourceRef?: string | undefined; }yes

Auto-generated by yarn docs:bus. Do not edit manually.