Skip to main content

Interface: ActiveExtensionDescriptor<TPayload>

Defined in: packages/agentos/src/extensions/types.ts:147

Active descriptor paired with resolved priority and original stack index.

Extends​

Type Parameters​

TPayload​

TPayload = unknown

Properties​

enableByDefault?​

optional enableByDefault: boolean

Defined in: packages/agentos/src/extensions/types.ts:114

Flag indicating whether the descriptor should be enabled by default when discovered. Manifests or overrides can still disable it explicitly.

Inherited from​

ExtensionDescriptor.enableByDefault

id​

id: string

Defined in: packages/agentos/src/extensions/types.ts:100

Unique identifier for the descriptor within its kind. Subsequent descriptors with the same id stack on top of previous entries.

Inherited from​

ExtensionDescriptor.id

kind​

kind: string

Defined in: packages/agentos/src/extensions/types.ts:104

High-level category of the descriptor (tool, guardrail, etc.).

Inherited from​

ExtensionDescriptor.kind

metadata?​

optional metadata: Record<string, unknown>

Defined in: packages/agentos/src/extensions/types.ts:118

Arbitrary metadata for tooling or pack-specific usage.

Inherited from​

ExtensionDescriptor.metadata

onActivate()?​

optional onActivate: (context) => void | Promise<void>

Defined in: packages/agentos/src/extensions/types.ts:131

Optional lifecycle hook invoked when the descriptor becomes the active entry for its id.

Parameters​

context​

ExtensionLifecycleContext

Returns​

void | Promise<void>

Inherited from​

ExtensionDescriptor.onActivate

onDeactivate()?​

optional onDeactivate: (context) => void | Promise<void>

Defined in: packages/agentos/src/extensions/types.ts:136

Optional lifecycle hook invoked when the descriptor is superseded or removed.

Parameters​

context​

ExtensionLifecycleContext

Returns​

void | Promise<void>

Inherited from​

ExtensionDescriptor.onDeactivate

payload​

payload: TPayload

Defined in: packages/agentos/src/extensions/types.ts:122

The payload consumed by the runtime (e.g., tool factory function).

Inherited from​

ExtensionDescriptor.payload

priority?​

optional priority: number

Defined in: packages/agentos/src/extensions/types.ts:109

Optional priority used during manifest loading. Higher numbers load later, allowing them to supersede earlier descriptors with the same id.

Inherited from​

ExtensionDescriptor.priority

requiredSecrets?​

optional requiredSecrets: ExtensionSecretRequirement[]

Defined in: packages/agentos/src/extensions/types.ts:141

Declares the secrets (API keys, credentials) the descriptor needs in order to function.

Inherited from​

ExtensionDescriptor.requiredSecrets

resolvedPriority​

resolvedPriority: number

Defined in: packages/agentos/src/extensions/types.ts:152

Resolved numeric priority used to order descriptors inside a stack.

source?​

optional source: ExtensionSourceMetadata

Defined in: packages/agentos/src/extensions/types.ts:126

Provenance information for the descriptor.

Inherited from​

ExtensionDescriptor.source

stackIndex​

stackIndex: number

Defined in: packages/agentos/src/extensions/types.ts:156

0-based insertion position within the stack (lower is older).