@unbrained/pm-cli 2026.7.6 → 2026.7.8

package/dist/sdk/runtime.d.ts

@@ -2,9 +2,15 @@ import { type ExtensionRegistrationRegistry } from "../core/extensions/index.js"
 import type { GlobalOptions } from "../core/shared/command-types.js";
 import type { PmToolAction } from "./cli-contracts/enum-contracts.js";
 export { clearWorkspaceContractsCache } from "./workspace-contracts-cache.js";
+import { type AggregateOptions, type AggregateResult, type ExtensionCommandOptions, type ExtensionCommandResult, type UpgradeCommandOptions, type UpgradeResult } from "../cli/commands/index.js";
+import type { ContextOptions, ContextResult } from "../cli/commands/context.js";
+import type { GetOptions, GetResult } from "../cli/commands/get.js";
 import type { CloseManyCommandOptions } from "../cli/commands/close-many.js";
 import { type ContractsCommandOptions, type ContractsResult } from "../cli/commands/contracts.js";
-import type { ListOptions } from "../cli/commands/list.js";
+import type { ListOptions, ListResult } from "../cli/commands/list.js";
+import type { NextOptions, NextResult } from "../cli/commands/next.js";
+import type { SearchOptions, SearchResult } from "../cli/commands/search.js";
+import type { StatsCommandOptions, StatsResult } from "../cli/commands/stats.js";
 import type { UpdateManyCommandOptions } from "../cli/commands/update-many.js";
 export { getActiveExtensionRegistrations, runActiveOnReadHooks, runActiveOnWriteHooks, } from "../core/extensions/index.js";
 export { pathExists, readFileIfExists, removeFileIfExists, writeFileAtomic } from "../core/fs/fs-utils.js";
@@ -26,6 +32,13 @@ export { isTimestampLiteral, nowIso } from "../core/shared/time.js";
 export { listAllFrontMatter, locateItem, readLocatedItem } from "../core/store/item-store.js";
 export { getHistoryPath, getItemPath, getSettingsPath, resolvePmRoot } from "../core/store/paths.js";
 export { readSettings } from "../core/store/settings.js";
+export { runAggregate, type AggregateOptions, type AggregateResult, type AggregateRow, } from "../cli/commands/aggregate.js";
+export { CONTEXT_OUTPUT_VALUES, runContext, type BlockerEntry, type ContextFocusItem, type ContextOptions, type ContextOutputFormat, type ContextResult, type HierarchyChild, type HierarchyNode, type HotFile, type ProgressEntry, type RecentContextItem, type StaleEntry, type TestHealthSummary, type WorkloadEntry, } from "../cli/commands/context.js";
+export { runGet, type GetOptions, type GetResult, } from "../cli/commands/get.js";
+export { runList, type ListCompactResult, type ListedItem, type ListOptions, type ListResult, type ListSortField, type ListSortOrder, type ListVerboseResult, } from "../cli/commands/list.js";
+export { NEXT_OUTPUT_VALUES, runNext, type NextActionableItem, type NextBlockerRef, type NextOptions, type NextOutputFormat, type NextRecommendation, type NextResult, } from "../cli/commands/next.js";
+export { runSearch, type SearchCompactResult, type SearchHit, type SearchHitHighlight, type SearchMatchMode, type SearchOptions, type SearchResult, type SearchResultItem, type SearchVerboseResult, } from "../cli/commands/search.js";
+export { runStats, type StatsCommandOptions, type StatsResult, } from "../cli/commands/stats.js";
 export { renderCalendarMarkdown, renderCalendarToon, resolveCalendarOutputFormat, runCalendar, type CalendarOptions, type CalendarResult, } from "../cli/commands/calendar.js";
 export { renderGuideMarkdown, resolveGuideOutputFormat, runGuide, type GuideDepth, type GuideOptions, type GuideOutputFormat, type GuideResult, } from "../cli/commands/guide.js";
 export { runCompletion, type CompletionResult, type CompletionShell } from "../cli/commands/completion.js";
@@ -34,11 +47,12 @@ export { runDedupeAudit, type DedupeAuditCandidate, type DedupeAuditCluster, typ
 export { runDedupeMerge, type DedupeMergeChildReparent, type DedupeMergeCloseAction, type DedupeMergeDuplicateOutcome, type DedupeMergeOptions, type DedupeMergeResult, } from "../cli/commands/dedupe-merge.js";
 export { runNormalize, type NormalizeCommandOptions, type NormalizeResult } from "../cli/commands/normalize.js";
 export { runReindex, type ReindexOptions, type ReindexResult } from "../cli/commands/reindex.js";
-export { runSearch, type SearchOptions, type SearchResult } from "../cli/commands/search.js";
 export { loadCreateTemplateOptions, runTemplatesList, runTemplatesSave, runTemplatesShow, type CreateTemplateOptions, type TemplatesListResult, type TemplatesSaveResult, type TemplatesShowResult, } from "../cli/commands/templates.js";
 export { runTestRunsList, runTestRunsLogs, runTestRunsResume, runTestRunsStatus, runTestRunsStop, type TestRunsListCommandOptions, type TestRunsLogsCommandOptions, type TestRunsResumeCommandOptions, type TestRunsStopCommandOptions, } from "../cli/commands/test-runs.js";
 export { CONFIDENCE_TEXT_VALUES, DEPENDENCY_KIND_VALUES, BUILTIN_ITEM_TYPE_VALUES, ISSUE_SEVERITY_VALUES, ITEM_TYPE_VALUES, RISK_VALUES, STATUS_VALUES, } from "../types/index.js";
 export type { GlobalOptions } from "../core/shared/command-types.js";
+export type PackageCommandOptions = ExtensionCommandOptions;
+export type PackageCommandResult = ExtensionCommandResult;
 export type { Dependency, ItemDocument, ItemMetadata, ItemStatus, ItemType, LinkedDoc, LinkedFile, LinkedTest, LogNote, PmSettings, } from "../types/index.js";
 /**
  * Documents the get contracts options payload exchanged by command, SDK, and package integrations.
@@ -146,35 +160,294 @@ export declare class PmClient {
      * Run any native or extension-contributed action through the SDK dispatcher.
      */
     run(action: PmActionName, args?: PmClientRunArgs): Promise<unknown>;
+    private runTyped;
     /**
      * Return the same context snapshot produced by `pm context`.
      */
-    context(options?: PmActionOptions): Promise<unknown>;
+    context(options?: ContextOptions): Promise<ContextResult>;
     /**
      * List items with the MCP/agent compact defaults.
      */
-    list(options?: PmActionOptions): Promise<unknown>;
+    list(options?: ListOptions): Promise<ListResult>;
     /**
      * Search items with the MCP/agent compact defaults.
      */
-    search(query: string, options?: PmActionOptions): Promise<unknown>;
+    search(query: string, options?: SearchOptions): Promise<SearchResult>;
     /**
      * Read one item by id.
      */
-    get(id: string, options?: PmActionOptions): Promise<unknown>;
+    get(id: string, options?: GetOptions): Promise<GetResult>;
+    /**
+     * Return the ranked next-work recommendation produced by `pm next`.
+     */
+    next(options?: NextOptions): Promise<NextResult>;
+    /**
+     * Group matching items with the same semantics as `pm aggregate`.
+     */
+    aggregate(options?: AggregateOptions): Promise<AggregateResult>;
+    /**
+     * Return project tracker statistics with the same sections as `pm stats`.
+     */
+    stats(options?: StatsCommandOptions): Promise<StatsResult>;
     /**
      * Create an item using the same mutation path as `pm create`.
      */
-    create(options: PmClientMutationOptions): Promise<unknown>;
+    create(options?: PmClientMutationOptions): Promise<unknown>;
     /**
      * Update an item using the same mutation path as `pm update`.
      */
-    update(id: string, options: PmClientMutationOptions): Promise<unknown>;
+    update(id: string, options?: PmClientMutationOptions): Promise<unknown>;
     /**
      * Close an item using the same mutation path as `pm close`.
      */
     close(id: string, reason: string, options?: PmClientMutationOptions): Promise<unknown>;
+    /**
+     * Claim an item using the same mutation path as `pm claim`.
+     */
+    claim(id: string, options?: PmClientMutationOptions): Promise<unknown>;
+    /**
+     * Release an item's active claim using the same mutation path as `pm release`.
+     */
+    release(id: string, options?: PmClientMutationOptions): Promise<unknown>;
+    /**
+     * Copy an item using the same mutation path as `pm copy`.
+     */
+    copy(id: string, options?: PmClientMutationOptions): Promise<unknown>;
+    /**
+     * Delete an item using the same mutation path as `pm delete`.
+     */
+    delete(id: string, options?: PmClientMutationOptions): Promise<unknown>;
+    /**
+     * Restore an item to a history version or timestamp using `pm restore`.
+     */
+    restore(id: string, target: string, options?: PmClientMutationOptions): Promise<unknown>;
+    /**
+     * Set, clear, or read workspace focus using the same path as `pm focus`.
+     */
+    focus(id?: string, options?: PmClientMutationOptions): Promise<unknown>;
+    /**
+     * Claim an item and transition it to the workspace in-progress status.
+     */
+    startTask(id: string, options?: PmClientMutationOptions): Promise<unknown>;
+    /**
+     * Move an item back to the workspace open status and release the claim.
+     */
+    pauseTask(id: string, options?: PmClientMutationOptions): Promise<unknown>;
+    /**
+     * Close an item and release its active assignment.
+     */
+    closeTask(id: string, reason: string, options?: PmClientMutationOptions): Promise<unknown>;
+    /**
+     * Run the extension lifecycle surface with the same result shape as `pm extension`.
+     */
+    extension(target?: string, options?: ExtensionCommandOptions): Promise<ExtensionCommandResult>;
+    /**
+     * List project or global extensions without constructing command-line argv.
+     */
+    extensionList(options?: ExtensionCommandOptions): Promise<ExtensionCommandResult>;
+    /**
+     * Enable an installed extension using the same action as `pm extension activate`.
+     */
+    extensionActivate(target: string, options?: ExtensionCommandOptions): Promise<ExtensionCommandResult>;
+    /**
+     * Disable an installed extension using the same action as `pm extension deactivate`.
+     */
+    extensionDeactivate(target: string, options?: ExtensionCommandOptions): Promise<ExtensionCommandResult>;
+    /**
+     * Run the package lifecycle surface with package vocabulary preserved.
+     */
+    package(target?: string, options?: PackageCommandOptions): Promise<PackageCommandResult>;
+    /**
+     * List project or global packages through the package lifecycle primitive.
+     */
+    packageList(options?: PackageCommandOptions): Promise<PackageCommandResult>;
+    /**
+     * Install a package or extension source using the same action as `pm package install`.
+     */
+    packageInstall(target: string, options?: PackageCommandOptions): Promise<PackageCommandResult>;
+    /**
+     * Uninstall a package or extension using the same action as `pm package uninstall`.
+     */
+    packageUninstall(target: string, options?: PackageCommandOptions): Promise<PackageCommandResult>;
+    /**
+     * Read package lifecycle diagnostics using the same action as `pm package doctor`.
+     */
+    packageDoctor(options?: PackageCommandOptions): Promise<PackageCommandResult>;
+    /**
+     * Inspect managed package state using the same action as `pm package manage`.
+     */
+    packageManage(target?: string, options?: PackageCommandOptions): Promise<PackageCommandResult>;
+    /**
+     * Describe installed package surfaces using the same action as `pm package describe`.
+     */
+    packageDescribe(target?: string, options?: PackageCommandOptions): Promise<PackageCommandResult>;
+    /**
+     * Reload installed package extensions using the same action as `pm package reload`.
+     */
+    packageReload(options?: PackageCommandOptions): Promise<PackageCommandResult>;
+    /**
+     * Read bundled package catalog metadata using the same action as `pm package catalog`.
+     */
+    packageCatalog(options?: PackageCommandOptions): Promise<PackageCommandResult>;
+    /**
+     * Enable an installed package using the same action as `pm package activate`.
+     */
+    packageActivate(target: string, options?: PackageCommandOptions): Promise<PackageCommandResult>;
+    /**
+     * Disable an installed package using the same action as `pm package deactivate`.
+     */
+    packageDeactivate(target: string, options?: PackageCommandOptions): Promise<PackageCommandResult>;
+    /**
+     * Upgrade the pm CLI and/or managed packages through the public SDK dispatcher.
+     */
+    upgrade(target?: string, options?: UpgradeCommandOptions): Promise<UpgradeResult>;
 }
+/**
+ * Return the same context snapshot produced by `pm context` without constructing
+ * a reusable client.
+ */
+export declare function context(options?: ContextOptions, clientOptions?: PmClientOptions): Promise<ContextResult>;
+/**
+ * List items with the MCP/agent compact defaults without constructing a
+ * reusable client.
+ */
+export declare function list(options?: ListOptions, clientOptions?: PmClientOptions): Promise<ListResult>;
+/**
+ * Search items with the MCP/agent compact defaults without constructing a
+ * reusable client.
+ */
+export declare function search(query: string, options?: SearchOptions, clientOptions?: PmClientOptions): Promise<SearchResult>;
+/**
+ * Read one item by id without constructing a reusable client.
+ */
+export declare function get(id: string, options?: GetOptions, clientOptions?: PmClientOptions): Promise<GetResult>;
+/**
+ * Return the ranked next-work recommendation produced by `pm next` without
+ * constructing a reusable client.
+ */
+export declare function next(options?: NextOptions, clientOptions?: PmClientOptions): Promise<NextResult>;
+/**
+ * Group matching items with the same semantics as `pm aggregate` without
+ * constructing a reusable client.
+ */
+export declare function aggregate(options?: AggregateOptions, clientOptions?: PmClientOptions): Promise<AggregateResult>;
+/**
+ * Return project tracker statistics with the same sections as `pm stats`
+ * without constructing a reusable client.
+ */
+export declare function stats(options?: StatsCommandOptions, clientOptions?: PmClientOptions): Promise<StatsResult>;
+/**
+ * Create an item without constructing a reusable client.
+ */
+export declare function create(options?: PmClientMutationOptions, clientOptions?: PmClientOptions): Promise<unknown>;
+/**
+ * Update an item without constructing a reusable client.
+ */
+export declare function update(id: string, options?: PmClientMutationOptions, clientOptions?: PmClientOptions): Promise<unknown>;
+/**
+ * Close an item without constructing a reusable client.
+ */
+export declare function close(id: string, reason: string, options?: PmClientMutationOptions, clientOptions?: PmClientOptions): Promise<unknown>;
+/**
+ * Claim an item without constructing a reusable client.
+ */
+export declare function claim(id: string, options?: PmClientMutationOptions, clientOptions?: PmClientOptions): Promise<unknown>;
+/**
+ * Release an item's active claim without constructing a reusable client.
+ */
+export declare function release(id: string, options?: PmClientMutationOptions, clientOptions?: PmClientOptions): Promise<unknown>;
+/**
+ * Copy an item without constructing a reusable client.
+ */
+export declare function copy(id: string, options?: PmClientMutationOptions, clientOptions?: PmClientOptions): Promise<unknown>;
+/**
+ * Delete an item without constructing a reusable client.
+ */
+export declare function deleteItem(id: string, options?: PmClientMutationOptions, clientOptions?: PmClientOptions): Promise<unknown>;
+/**
+ * Restore an item without constructing a reusable client.
+ */
+export declare function restore(id: string, target: string, options?: PmClientMutationOptions, clientOptions?: PmClientOptions): Promise<unknown>;
+/**
+ * Set, clear, or read workspace focus without constructing a reusable client.
+ */
+export declare function focus(id?: string, options?: PmClientMutationOptions, clientOptions?: PmClientOptions): Promise<unknown>;
+/**
+ * Claim an item and transition it to in-progress without constructing a client.
+ */
+export declare function startTask(id: string, options?: PmClientMutationOptions, clientOptions?: PmClientOptions): Promise<unknown>;
+/**
+ * Move an item to open and release it without constructing a client.
+ */
+export declare function pauseTask(id: string, options?: PmClientMutationOptions, clientOptions?: PmClientOptions): Promise<unknown>;
+/**
+ * Close an item and release its active assignment without constructing a client.
+ */
+export declare function closeTask(id: string, reason: string, options?: PmClientMutationOptions, clientOptions?: PmClientOptions): Promise<unknown>;
+/**
+ * Run the extension lifecycle surface without constructing a reusable client.
+ */
+export declare function extension(target?: string, options?: ExtensionCommandOptions, clientOptions?: PmClientOptions): Promise<ExtensionCommandResult>;
+/**
+ * List extensions without constructing a reusable client.
+ */
+export declare function extensionList(options?: ExtensionCommandOptions, clientOptions?: PmClientOptions): Promise<ExtensionCommandResult>;
+/**
+ * Enable an extension without constructing a reusable client.
+ */
+export declare function extensionActivate(target: string, options?: ExtensionCommandOptions, clientOptions?: PmClientOptions): Promise<ExtensionCommandResult>;
+/**
+ * Disable an extension without constructing a reusable client.
+ */
+export declare function extensionDeactivate(target: string, options?: ExtensionCommandOptions, clientOptions?: PmClientOptions): Promise<ExtensionCommandResult>;
+/**
+ * Run the package lifecycle surface without constructing a reusable client.
+ */
+export declare function packageLifecycle(target?: string, options?: PackageCommandOptions, clientOptions?: PmClientOptions): Promise<PackageCommandResult>;
+/**
+ * List packages without constructing a reusable client.
+ */
+export declare function packageList(options?: PackageCommandOptions, clientOptions?: PmClientOptions): Promise<PackageCommandResult>;
+/**
+ * Install a package or extension source without constructing a reusable client.
+ */
+export declare function packageInstall(target: string, options?: PackageCommandOptions, clientOptions?: PmClientOptions): Promise<PackageCommandResult>;
+/**
+ * Uninstall a package or extension without constructing a reusable client.
+ */
+export declare function packageUninstall(target: string, options?: PackageCommandOptions, clientOptions?: PmClientOptions): Promise<PackageCommandResult>;
+/**
+ * Read package lifecycle diagnostics without constructing a reusable client.
+ */
+export declare function packageDoctor(options?: PackageCommandOptions, clientOptions?: PmClientOptions): Promise<PackageCommandResult>;
+/**
+ * Inspect managed package state without constructing a reusable client.
+ */
+export declare function packageManage(target?: string, options?: PackageCommandOptions, clientOptions?: PmClientOptions): Promise<PackageCommandResult>;
+/**
+ * Describe package surfaces without constructing a reusable client.
+ */
+export declare function packageDescribe(target?: string, options?: PackageCommandOptions, clientOptions?: PmClientOptions): Promise<PackageCommandResult>;
+/**
+ * Reload package extensions without constructing a reusable client.
+ */
+export declare function packageReload(options?: PackageCommandOptions, clientOptions?: PmClientOptions): Promise<PackageCommandResult>;
+/**
+ * Read bundled package catalog metadata without constructing a reusable client.
+ */
+export declare function packageCatalog(options?: PackageCommandOptions, clientOptions?: PmClientOptions): Promise<PackageCommandResult>;
+/**
+ * Enable a package without constructing a reusable client.
+ */
+export declare function packageActivate(target: string, options?: PackageCommandOptions, clientOptions?: PmClientOptions): Promise<PackageCommandResult>;
+/**
+ * Disable a package without constructing a reusable client.
+ */
+export declare function packageDeactivate(target: string, options?: PackageCommandOptions, clientOptions?: PmClientOptions): Promise<PackageCommandResult>;
+/**
+ * Upgrade the pm CLI and/or managed packages without constructing a reusable client.
+ */
+export declare function upgrade(target?: string, options?: UpgradeCommandOptions, clientOptions?: PmClientOptions): Promise<UpgradeResult>;
 /**
  * Implements get workspace contracts for the public runtime surface of this module.
  */
@@ -241,3 +514,4 @@ declare global {
     var __pmCliActionRunnerTestHooks: typeof actionRunnerTestHooks | undefined;
 }
 export type { ContractsCommandOptions, ContractsResult };
+export type { ExtensionCommandOptions, ExtensionCommandResult, UpgradeCommandOptions, UpgradeResult };