apcore-cli 0.9.1 → 0.10.0

package/dist/index.d.ts

@@ -195,10 +195,20 @@ declare class ApcliGroup {
  * Protocol spec: CLI command structure & lazy loading
  */
 
-/** CLI-internal Registry shim (see D9-W2 note above). */
+/**
+ * CLI-internal Registry shim. Method names align with apcore-js >= 0.22.0
+ * (Registry.list() / Registry.getDefinition()). Embedders may pass an
+ * apcore-js `Registry` instance directly — no adapter required.
+ *
+ * The required surface is intentionally the apcore-js surface (no batch
+ * `listModules()`); use the {@link listAllDefinitions} helper to iterate
+ * all descriptors.
+ */
 interface Registry {
-    listModules(): ModuleDescriptor[];
-    getModule(moduleId: string): ModuleDescriptor | null;
+    /** Enumerate module IDs. Aligned with apcore-js Registry.list(). */
+    list(): string[];
+    /** Resolve a module descriptor by ID. Aligned with apcore-js Registry.getDefinition(). */
+    getDefinition(moduleId: string): ModuleDescriptor | null;
 }
 /** Strategy info returned by Executor.describePipeline(). */
 interface StrategyInfo {
@@ -214,9 +224,20 @@ interface StrategyStep {
     removable: boolean;
     timeoutMs?: number;
 }
-/** Placeholder for apcore-js Executor. Shape-compatible with apcore-js >= 0.19.0. */
+/**
+ * CLI-internal Executor shim. Method names align with apcore-js >= 0.22.0
+ * (Executor.call as the primary invocation method). Embedders may pass
+ * an apcore-js `Executor` instance directly — no adapter required.
+ */
 interface Executor {
-    execute(moduleId: string, input: Record<string, unknown>): Promise<unknown>;
+    /** Invoke a module. Aligned with apcore-js Executor.call(). */
+    call(moduleId: string, input: Record<string, unknown>): Promise<unknown>;
+    /**
+     * The executor's registry. Aligned with apcore-js `Executor.registry`.
+     * Used for synchronous availability probes (e.g. system-module gating)
+     * since `validate` is async and cannot be awaited during sync registration.
+     */
+    registry?: Registry;
     /** Validate inputs without executing. Returns a PreflightResult. */
     validate?(moduleId: string, input: Record<string, unknown>): Promise<PreflightResult>;
     /** Execute with pipeline trace. Returns [result, PipelineTrace]. */
@@ -225,8 +246,6 @@ interface Executor {
     }): Promise<[unknown, PipelineTrace]>;
     /** Stream execution — async iterator of chunks. */
     stream?(moduleId: string, input: Record<string, unknown>): AsyncIterable<unknown>;
-    /** Call a module (synchronous-style, used by system commands). */
-    call?(moduleId: string, input: Record<string, unknown>): Promise<unknown>;
     /**
      * Describe the executor's currently-set strategy. Returns StrategyInfo
      * (apcore-js >= 0.18.0). Takes no arguments — to introspect a different
@@ -267,10 +286,24 @@ interface PipelineTrace {
     readonly success: boolean;
     readonly steps: readonly PipelineTraceStep[];
 }
-/** Placeholder for apcore-js ModuleDescriptor. */
+/**
+ * CLI-internal ModuleDescriptor shim. Field names align with apcore-js
+ * >= 0.22.0 — embedders may pass apcore-js descriptors directly without
+ * field-level remapping. The interface is intentionally a structural
+ * subset of apcore-js's `ModuleDescriptor`: only fields actually consumed
+ * by the CLI are listed. apcore-js descriptors satisfy this shape
+ * trivially because every CLI-required field is also required there with
+ * the same name and a compatible type.
+ *
+ * Note: CLI JSON output (e.g. `apcli list --format json`) still emits the
+ * field as `id` for backward compatibility with downstream scripts —
+ * see `output.ts` for the moduleId → id mapping at the output boundary.
+ */
 interface ModuleDescriptor {
-    id: string;
-    name: string;
+    /** Module ID (`a.b.c` form). Aligned with apcore-js `ModuleDescriptor.moduleId`. */
+    moduleId: string;
+    /** Human-readable name. `null` when unset (matches apcore-js). */
+    name: string | null;
     description: string;
     tags?: string[];
     inputSchema?: Record<string, unknown>;