@unbrained/pm-cli 2026.6.22 → 2026.6.23

package/dist/sdk/compose.d.ts

@@ -0,0 +1,297 @@
+/**
+ * @module sdk/compose
+ *
+ * Declarative extension authoring — the capstone of the SDK authoring tripod
+ * (`author → register → test`).
+ *
+ * The {@link ./define.js | `define*`} builders type each registration where it
+ * is written, and the `assert*`/`run*` testing helpers verify and invoke it. But
+ * the author still has to hand-wire every definition into an imperative
+ * `activate(api)` body — calling the right `api.register*` method, in the right
+ * order, without forgetting one — and then hand-sync `manifest.capabilities` to
+ * match. Those are the two most common package-authoring footguns.
+ *
+ * {@link composeExtension} closes the loop: an author (or an agent) describes
+ * *what* to register as a plain {@link ExtensionBlueprint} object, and the SDK
+ * generates the `activate` that wires every surface for them.
+ * {@link deriveExtensionCapabilities} computes the exact least-privilege
+ * capability set that blueprint exercises, so `manifest.json` can be authored
+ * with zero declared-but-unused / used-but-undeclared drift (the author-time
+ * inverse of the runtime `reconcileExtensionCapabilityUsage` reconciliation).
+ *
+ * This module also owns {@link ExtensionModule} and {@link defineExtension} —
+ * the in-module export shape every extension entry file produces and its
+ * zero-cost identity helper — so both the imperative (`defineExtension`) and
+ * declarative (`composeExtension`) authoring styles live together. Both are
+ * re-exported from the SDK barrel, so the public API is unchanged.
+ */
+import type { AfterCommandHook, BeforeCommandHook, CommandDefinition, CommandOverride, ExtensionApi, ExtensionCapability, ExtensionManifest, ExtensionServiceName, Exporter, FlagDefinition, ImportExportRegistrationOptions, Importer, OnIndexHook, OnReadHook, OnWriteHook, OutputRendererFormat, ParserOverride, PreflightOverride, RendererOverride, SchemaFieldDefinition, SchemaItemTypeDefinition, SchemaMigrationDefinition, SearchProviderDefinition, ServiceOverride, VectorStoreAdapterDefinition } from "../core/extensions/loader.js";
+import type { ExtensionActivationSummary } from "../core/extensions/activation-summary.js";
+/**
+ * Documents the extension module payload exchanged by command, SDK, and package integrations.
+ *
+ * This is the shape an extension entry file exports (as its default export and,
+ * conventionally, as named `manifest`/`activate` exports). Produce it directly,
+ * via {@link defineExtension} for the imperative style, or via
+ * {@link composeExtension} for the declarative style.
+ */
+export interface ExtensionModule {
+    /**
+     * Optional in-module metadata mirror.
+     *
+     * The authoritative manifest remains on-disk `manifest.json`; this field is
+     * useful when authors want colocated metadata for tooling/tests. Type it with
+     * {@link defineExtensionManifest} for full contract checking in plain
+     * JavaScript packages.
+     */
+    manifest?: ExtensionManifest;
+    activate(api: ExtensionApi): void | Promise<void>;
+    /**
+     * Optional teardown lifecycle hook (VS Code-style `deactivate`). Invoked by
+     * the host on shutdown/reload to release resources opened during `activate`.
+     */
+    deactivate?(): void | Promise<void>;
+}
+/**
+ * Typed identity helper for extension module exports.
+ *
+ * Use as:
+ * `export default defineExtension({ activate(api) { ... } })`
+ *
+ * Reach for {@link composeExtension} instead when you would rather declare the
+ * registrations as data than wire them imperatively in `activate`.
+ */
+export declare function defineExtension<TModule extends ExtensionModule>(module: TModule): TModule;
+/**
+ * A single importer registration entry for an {@link ExtensionBlueprint}, mirroring
+ * the positional arguments of `api.registerImporter(name, importer, options?)`.
+ */
+export interface ExtensionBlueprintImporter {
+    /** Registered importer name; the `<name> import` command path is derived from it. */
+    name: string;
+    /** The importer handler that bridges an external system into the pm context graph. */
+    importer: Importer;
+    /** Optional command metadata (description/flags/intent/examples) for the derived command. */
+    options?: ImportExportRegistrationOptions;
+}
+/**
+ * A single exporter registration entry for an {@link ExtensionBlueprint}, mirroring
+ * the positional arguments of `api.registerExporter(name, exporter, options?)`.
+ */
+export interface ExtensionBlueprintExporter {
+    /** Registered exporter name; the `<name> export` command path is derived from it. */
+    name: string;
+    /** The exporter handler that bridges the pm context graph out to an external system. */
+    exporter: Exporter;
+    /** Optional command metadata (description/flags/intent/examples) for the derived command. */
+    options?: ImportExportRegistrationOptions;
+}
+/**
+ * The lifecycle hooks an {@link ExtensionBlueprint} can register, one array per
+ * kind. Each entry is registered through the matching `api.hooks.*` method in
+ * the canonical order `before_command → after_command → on_write → on_read →
+ * on_index`.
+ */
+export interface ExtensionBlueprintHooks {
+    /** Hooks fired before a command runs (`api.hooks.beforeCommand`). */
+    beforeCommand?: BeforeCommandHook[];
+    /** Hooks fired after a command runs (`api.hooks.afterCommand`). */
+    afterCommand?: AfterCommandHook[];
+    /** Hooks fired when an item is persisted (`api.hooks.onWrite`). */
+    onWrite?: OnWriteHook[];
+    /** Hooks fired when an item is read (`api.hooks.onRead`). */
+    onRead?: OnReadHook[];
+    /** Hooks fired during index/search refresh (`api.hooks.onIndex`). */
+    onIndex?: OnIndexHook[];
+}
+/**
+ * A declarative description of everything an extension registers at activation.
+ *
+ * Every field is optional: populate the surfaces your extension uses (ideally
+ * with {@link ./define.js | `define*`}-authored definitions) and leave the rest
+ * out. {@link composeExtension} turns the blueprint into an
+ * {@link ExtensionModule} whose generated `activate` calls the matching
+ * `api.register*` method for each surface, and {@link deriveExtensionCapabilities}
+ * computes the capability set the blueprint requires.
+ *
+ * Record-keyed fields map a routing key (command name, output format, or service
+ * name) to its handler, mirroring the two-argument `api.register*` overloads.
+ */
+export interface ExtensionBlueprint {
+    /** Optional in-module manifest mirror, copied onto the produced module verbatim. */
+    manifest?: ExtensionManifest;
+    /** Full command definitions registered via `api.registerCommand(definition)`. */
+    commands?: CommandDefinition[];
+    /** Command overrides keyed by command name, registered via `api.registerCommand(command, override)`. */
+    commandOverrides?: Record<string, CommandOverride>;
+    /** Additional flags keyed by target command name, registered via `api.registerFlags(command, flags)`. */
+    flags?: Record<string, FlagDefinition[]>;
+    /** Parser overrides keyed by command name, registered via `api.registerParser(command, override)`. */
+    parsers?: Record<string, ParserOverride>;
+    /** Output renderer overrides keyed by format, registered via `api.registerRenderer(format, renderer)`. */
+    renderers?: Partial<Record<OutputRendererFormat, RendererOverride>>;
+    /** Service overrides keyed by service name, registered via `api.registerService(service, override)`. */
+    services?: Partial<Record<ExtensionServiceName, ServiceOverride>>;
+    /** Preflight overrides registered via `api.registerPreflight(override)`. */
+    preflights?: PreflightOverride[];
+    /** Custom item types registered in a single `api.registerItemTypes(types)` call. */
+    itemTypes?: SchemaItemTypeDefinition[];
+    /** Custom front-matter fields registered in a single `api.registerItemFields(fields)` call. */
+    itemFields?: SchemaFieldDefinition[];
+    /** Schema migrations registered one at a time via `api.registerMigration(definition)`. */
+    migrations?: SchemaMigrationDefinition[];
+    /** Search providers registered via `api.registerSearchProvider(provider)`. */
+    searchProviders?: SearchProviderDefinition[];
+    /** Vector store adapters registered via `api.registerVectorStoreAdapter(adapter)`. */
+    vectorStoreAdapters?: VectorStoreAdapterDefinition[];
+    /** Importers registered via `api.registerImporter(name, importer, options?)`. */
+    importers?: ExtensionBlueprintImporter[];
+    /** Exporters registered via `api.registerExporter(name, exporter, options?)`. */
+    exporters?: ExtensionBlueprintExporter[];
+    /** Lifecycle hooks registered through `api.hooks.*`. */
+    hooks?: ExtensionBlueprintHooks;
+    /**
+     * Optional imperative escape hatch run *after* every declarative registration,
+     * for the rare wiring the blueprint cannot express. Receives the same `api`.
+     */
+    activate?: (api: ExtensionApi) => void | Promise<void>;
+    /** Optional teardown hook copied onto the produced module verbatim. */
+    deactivate?: () => void | Promise<void>;
+}
+/**
+ * Assemble an {@link ExtensionModule} from a declarative {@link ExtensionBlueprint}.
+ *
+ * The returned module's `activate` registers every populated surface through the
+ * matching `api.register*` method in a deterministic order (commands → overrides
+ * → flags → parsers → renderers → services → preflights → item types → item
+ * fields → migrations → search providers → vector store adapters → importers →
+ * exporters → hooks), then awaits the blueprint's optional imperative `activate`
+ * so it can layer on anything the declarative form cannot express. `manifest`
+ * and `deactivate` are copied onto the module verbatim.
+ *
+ * This is a pure assembler: it does not validate the definitions. Per-surface
+ * contract enforcement stays in `api.register*` (and the loader), exactly as it
+ * does for hand-written `activate` bodies, so a malformed definition surfaces
+ * the same activation diagnostic either way.
+ */
+export declare function composeExtension(blueprint: ExtensionBlueprint): ExtensionModule;
+/**
+ * Compute the minimal least-privilege capability set a {@link ExtensionBlueprint}
+ * exercises, sorted and de-duplicated.
+ *
+ * Use it to author `manifest.json` `capabilities` exactly — declaring nothing the
+ * extension does not use and nothing it does. It is the author-time inverse of
+ * the runtime `reconcileExtensionCapabilityUsage` reconciliation: derive the set
+ * here before activation rather than detecting drift after it. A blueprint with
+ * no registration surfaces returns an empty array.
+ */
+export declare function deriveExtensionCapabilities(blueprint: ExtensionBlueprint): ExtensionCapability[];
+/**
+ * Compute, without activating, the exact {@link ExtensionActivationSummary} that
+ * {@link composeExtension}'s generated `activate` would produce for a blueprint.
+ *
+ * This is the author-time inverse of the runtime
+ * {@link ../core/extensions/activation-summary.js#describeExtensionActivation}:
+ * the runtime verb walks an *activated* registry, while this one reads the
+ * declarative {@link ExtensionBlueprint} data directly, so an author or agent can
+ * preview the full named surface map (commands, overrides, handlers, hooks, item
+ * types/fields, importers/exporters, search/vector adapters, parser/service/
+ * renderer overrides, flag-target commands, and the preflight count) with no
+ * loading, activation, or side effects. It is to the named surfaces what
+ * {@link deriveExtensionCapabilities} is to the capability set.
+ *
+ * Fidelity is by construction: command paths are normalized with the same
+ * `normalizeCommandName` the loader applies, and importer/exporter handler paths
+ * are synthesized as `normalizeCommandName("<name> import|export")`, exactly as
+ * `registerImporter`/`registerExporter` do. A parity test pins this output equal
+ * to `describeExtensionActivation` over the same composed-and-activated blueprint.
+ *
+ * The one surface it cannot reflect is the blueprint's optional imperative
+ * `activate` escape hatch — arbitrary code a static reader cannot inspect. A
+ * blueprint that registers everything through that hatch summarizes as empty.
+ */
+export declare function describeExtensionBlueprint(blueprint: ExtensionBlueprint): ExtensionActivationSummary;
+/** Severity of an {@link ExtensionBlueprintLintFinding}: a hard `error` (activation will fail) or an advisory `warning`. */
+export type ExtensionBlueprintLintSeverity = "error" | "warning";
+/**
+ * Machine-readable kind of an {@link ExtensionBlueprintLintFinding}.
+ *
+ * - `capability_undeclared` (error): a surface exercises a capability the declared
+ *   set omits; the loader throws `extension_capability_missing` at activation.
+ * - `capability_unused` (warning): a declared capability no surface exercises; the
+ *   runtime equivalent is the `pm package doctor` `extension_capability_unused` note.
+ * - `duplicate_command` (warning): the same normalized command path is declared
+ *   more than once in `commands`; the later registration shadows the earlier.
+ * - `command_override_conflict` (warning): a path is declared as both a fresh
+ *   command definition and a command override.
+ * - `empty_surface` (warning): a registration field is present but contributes
+ *   nothing — a dead declaration.
+ * - `manifest_capabilities_absent` (warning): the blueprint exercises capabilities
+ *   but offers no declared set to reconcile against.
+ */
+export type ExtensionBlueprintLintCode = "capability_undeclared" | "capability_unused" | "duplicate_command" | "command_override_conflict" | "empty_surface" | "manifest_capabilities_absent";
+/**
+ * A single author-time issue {@link lintExtensionBlueprint} found in a blueprint.
+ */
+export interface ExtensionBlueprintLintFinding {
+    /** The machine-readable {@link ExtensionBlueprintLintCode} for programmatic handling. */
+    code: ExtensionBlueprintLintCode;
+    /** Whether the finding blocks activation (`error`) or is advisory (`warning`). */
+    severity: ExtensionBlueprintLintSeverity;
+    /** Human-readable explanation, including the suggested fix. */
+    message: string;
+    /** The capability involved, for capability-drift findings. */
+    capability?: ExtensionCapability;
+    /** The normalized command path involved, for command findings. */
+    command?: string;
+    /** The blueprint field involved, for `empty_surface` findings. */
+    field?: string;
+}
+/**
+ * Options for {@link lintExtensionBlueprint} and {@link ../sdk/testing.js#assertExtensionBlueprint}.
+ */
+export interface LintExtensionBlueprintOptions {
+    /**
+     * The capabilities the package's `manifest.json` declares (or will), used to
+     * reconcile against the surfaces the blueprint exercises. Overrides
+     * `blueprint.manifest.capabilities` when both are present. Omit both to lint
+     * without a capability reconciliation (only the structural checks run).
+     */
+    declaredCapabilities?: readonly string[];
+}
+/**
+ * The structured result of {@link lintExtensionBlueprint}.
+ */
+export interface ExtensionBlueprintLintResult {
+    /** `true` when no `error`-severity finding is present (warnings still allow activation). */
+    ok: boolean;
+    /** Every finding, in detection order (capability drift, duplicates, conflicts, empty surfaces). */
+    findings: ExtensionBlueprintLintFinding[];
+    /** The least-privilege capability set the blueprint exercises (from {@link deriveExtensionCapabilities}). */
+    used: ExtensionCapability[];
+    /** The normalized declared capability set reconciled against, or `null` when none was provided. */
+    declared: ExtensionCapability[] | null;
+}
+/**
+ * Preflight a declarative {@link ExtensionBlueprint} at author time, returning the
+ * structured issues that would otherwise only surface at activation.
+ *
+ * It is the author-time inverse of the runtime extension guardrails — pure data
+ * analysis with no loading, activation, or side effects:
+ *
+ * - capability drift in both directions: a capability a surface exercises but the
+ *   declared set omits is an `error` (the loader throws `extension_capability_missing`
+ *   at activation); a declared capability no surface exercises is a `warning` (the
+ *   author-time form of the `pm package doctor` `extension_capability_unused` note,
+ *   making this the static inverse of `reconcileExtensionCapabilityUsage`).
+ * - structural footguns: a command path declared twice (`duplicate_command`), a
+ *   path declared as both a command and an override (`command_override_conflict`),
+ *   and a registration field present but empty (`empty_surface`).
+ *
+ * The declared set is taken from `options.declaredCapabilities` or, failing that,
+ * `blueprint.manifest.capabilities`; with neither, capability reconciliation is
+ * skipped and a single `manifest_capabilities_absent` warning suggests adopting
+ * {@link deriveExtensionCapabilities}. Like {@link describeExtensionBlueprint},
+ * the imperative `activate` escape hatch is invisible to this static check.
+ */
+export declare function lintExtensionBlueprint(blueprint: ExtensionBlueprint, options?: LintExtensionBlueprintOptions): ExtensionBlueprintLintResult;