Interface: SourceTypeDto

@kortexya/reasoninglayer / SourceTypeDto

Interface: SourceTypeDto

Defined in: src/types/sources.ts:408

One registrable source TYPE and its capabilities (#71).

Remarks

The pre-registration half of the mode-discovery surface: a client rendering a “new source” picker asks SourcesClient.listSourceTypes which types this build can register and which write-path modes each would serve — BEFORE any source exists. The per-source half (SourceDetailResponse) answers the same mode question for a source that does.

Properties

aliases

aliases: string[]

Defined in: src/types/sources.ts:416

Alternate spellings registration also accepts (e.g. "postgresql" for "postgres"). A picker that lets the user type a type name should accept these as equivalent.

available

available: boolean

Defined in: src/types/sources.ts:422

Whether this build can register the type. false means the adapter is behind a cargo feature that is not compiled in: registration would be refused, so a picker should not offer it (or should show it disabled).

configFields

configFields: ConfigFieldDto[]

Defined in: src/types/sources.ts:442

The connection-config fields registration parses for this source type, in the order a wizard should render them.

Remarks

This is the single source of a connector form’s shape. Build the form from it rather than shipping a hand-maintained table of connection fields per source type — the table goes stale the moment a factory adds a key, and this list cannot, because the factory publishes it.

Empty for a type whose config is opaque or that is not factory-registrable.

sourceType

sourceType: string

Defined in: src/types/sources.ts:410

Canonical type string accepted by POST /api/v1/sources (e.g. "mysql").

supportedModes

supportedModes: string[]

Defined in: src/types/sources.ts:428

The write-path modes this type’s adapter can serve: always 'ingest', plus 'transpile' when the adapter executes transpiled SQL. The same set the per-source endpoints report after registration.