Interface IIntrospectionAPI

Read-only introspection surface exposed as GeoLeaf.Introspection.

Consumed by studio and form-builder plugins (P4) to enumerate active modules and read their declared schemas without coupling to the registry internals.

Example

const modules = GeoLeaf.Introspection.getActiveModules();
for (const mod of modules) {
    const schema = GeoLeaf.Introspection.getModuleSchema(mod.id);
    if (schema) buildFormFor(schema);
}

interface IIntrospectionAPI {
    getModuleSchema(id: string): IModuleSchema | null;
    getActiveModules(): readonly IModuleInfo[];
    getCapabilitySchema(id: string): ICapabilitySchema | null;
    getAllCapabilities(): readonly ICapabilitySchema[];
    getCapabilityStatus(): readonly ICapabilityStatus[];
}

Index

Methods

getModuleSchema getActiveModules getCapabilitySchema getAllCapabilities getCapabilityStatus

Methods

getModuleSchema

getModuleSchema(id: string): IModuleSchema | null
Returns the schema of a registered module, or null if no module with the given id is registered.
Parameters
- id: string
  Module id (e.g. 'poi', 'route', 'search').
Returns IModuleSchema | null
- Defined in packages/core/src/contracts/introspection.contract.ts:101

getActiveModules

getActiveModules(): readonly IModuleInfo[]
Returns a read-only snapshot of all registered modules.

The order matches the insertion order of ModuleRegistry.register(). After registry.init(), this includes both built-in and lazily registered plugin modules.

Returns readonly IModuleInfo[]
- Defined in packages/core/src/contracts/introspection.contract.ts:110

getCapabilitySchema

getCapabilitySchema(id: string): ICapabilitySchema | null
Returns the introspectable schema of a registered capability, or null if no capability with the given id has been declared.

The returned schema never contains the loader field.
Parameters
- id: string
  Capability id (e.g. 'labels', 'route', 'cluster').
Returns ICapabilitySchema | null
- Defined in packages/core/src/contracts/introspection.contract.ts:120

getAllCapabilities

getAllCapabilities(): readonly ICapabilitySchema[]
Returns introspectable schemas for all registered capabilities.

Order matches the order in which registerCapability() was called. No loader field on any returned item.

Consumed by studio / form-builder plugins to enumerate available features.

Returns readonly ICapabilitySchema[]
- Defined in packages/core/src/contracts/introspection.contract.ts:130

getCapabilityStatus

getCapabilityStatus(): readonly ICapabilityStatus[]
Returns, for every declared capability, what switches it on and why.

One question, one answer — distinct from both neighbours:
- getAllCapabilities() returns what is declared (the schema);
- getActiveModules() returns what is running (initialised modules);
- this one returns the config verdict: embarked? enabled? through which gate?
enabled is re-read on each call against GeoLeaf.Config, hence against the profile-merged config as soon as the profile is loaded. Before boot() no config is loaded and every gate answers its enableWhenAbsent — which is the exact answer to "with what is configured right now", not a fallback value.

Order matches registration order.
Returns readonly ICapabilityStatus[]
- Defined in packages/core/src/contracts/introspection.contract.ts:147

Interface IIntrospectionAPI

Example

Index

Methods

Methods

getModuleSchema

Parameters

Returns IModuleSchema | null

getActiveModules

Returns readonly IModuleInfo[]

getCapabilitySchema

Parameters

Returns ICapabilitySchema | null

getAllCapabilities

Returns readonly ICapabilitySchema[]

getCapabilityStatus

Returns readonly ICapabilityStatus[]

Settings

On This Page