craft-hub / CraftHubRuntime

Class: CraftHubRuntime

Defined in: packages/craft-hub/src/runtime.ts:55

Constructors

Constructor

new CraftHubRuntime(options?): CraftHubRuntime

Defined in: packages/craft-hub/src/runtime.ts:95

Parameters

options?

string | CraftHubOptions

Returns

CraftHubRuntime

Properties

accountProvider?

readonly optional accountProvider?: AccountProvider

Defined in: packages/craft-hub/src/runtime.ts:57

---

accountSync

readonly accountSync: AccountSyncService

Defined in: packages/craft-hub/src/runtime.ts:73

---

agentActions

readonly agentActions: AgentActionService

Defined in: packages/craft-hub/src/runtime.ts:78

---

agentTasks

readonly agentTasks: AgentTaskManager

Defined in: packages/craft-hub/src/runtime.ts:77

---

distribution

readonly distribution: DistributionConfig

Defined in: packages/craft-hub/src/runtime.ts:84

---

dotfilesManager

readonly dotfilesManager: DotfilesManager

Defined in: packages/craft-hub/src/runtime.ts:65

---

gitIntegration

readonly gitIntegration: GitIntegration

Defined in: packages/craft-hub/src/runtime.ts:83

---

hostEnvironment

readonly hostEnvironment: HostEnvironment

Defined in: packages/craft-hub/src/runtime.ts:56

---

integrationRegistry

readonly integrationRegistry: IntegrationRegistry

Defined in: packages/craft-hub/src/runtime.ts:80

---

ownerScopes

readonly ownerScopes: OwnerScopeService

Defined in: packages/craft-hub/src/runtime.ts:74

---

personalConfigRepository

readonly personalConfigRepository: PersonalConfigRepository

Defined in: packages/craft-hub/src/runtime.ts:64

---

personalGitSync

readonly personalGitSync: PersonalGitSyncService

Defined in: packages/craft-hub/src/runtime.ts:72

---

pluginManager

readonly pluginManager: PluginManager

Defined in: packages/craft-hub/src/runtime.ts:79

---

projects

readonly projects: ProjectRegistry

Defined in: packages/craft-hub/src/runtime.ts:59

---

releasePlanner

readonly releasePlanner: ReleasePlanner

Defined in: packages/craft-hub/src/runtime.ts:82

---

settings

readonly settings: CraftHubSettingsService

Defined in: packages/craft-hub/src/runtime.ts:62

---

softwareSources

readonly softwareSources: SoftwareSourceService

Defined in: packages/craft-hub/src/runtime.ts:70

---

store

readonly store: CraftHubStore

Defined in: packages/craft-hub/src/runtime.ts:58

---

teamGitSync

readonly teamGitSync: TeamGitSyncService

Defined in: packages/craft-hub/src/runtime.ts:75

---

teams

readonly teams: TeamManager

Defined in: packages/craft-hub/src/runtime.ts:76

---

userConfig

readonly userConfig: UserConfigService

Defined in: packages/craft-hub/src/runtime.ts:63

---

workAssistant

readonly workAssistant: WorkAssistant

Defined in: packages/craft-hub/src/runtime.ts:60

---

workItemProjects

readonly workItemProjects: WorkItemProjectService

Defined in: packages/craft-hub/src/runtime.ts:61

---

workspaceCatalog

readonly workspaceCatalog: WorkspaceCatalogService

Defined in: packages/craft-hub/src/runtime.ts:68

---

workspaceImports

readonly workspaceImports: WorkspaceImportService

Defined in: packages/craft-hub/src/runtime.ts:71

---

workspaces

readonly workspaces: WorkspaceService

Defined in: packages/craft-hub/src/runtime.ts:66

---

workspaceSubscriptions

readonly workspaceSubscriptions: WorkspaceSubscriptionService

Defined in: packages/craft-hub/src/runtime.ts:67

Methods

addProject()

addProject(path): Promise<ProjectRecord>

Defined in: packages/craft-hub/src/runtime.ts:165

Register a local project path without granting trust.

Parameters

path

string

Returns

Promise<ProjectRecord>

---

applyGitIntegration()

applyGitIntegration(projectId, request): Promise<GitIntegrationResult>

Defined in: packages/craft-hub/src/runtime.ts:207

Recheck and apply a reviewed local Git integration Plan.

Parameters

projectId

string

request

ApplyGitIntegrationRequest

Returns

Promise<GitIntegrationResult>

---

cancelAllRuns()

cancelAllRuns(): Promise<void>

Defined in: packages/craft-hub/src/runtime.ts:630

Stop every active run during application shutdown.

Returns

Promise<void>

---

cancelRun()

cancelRun(runId): Promise<RunRecord>

Defined in: packages/craft-hub/src/runtime.ts:623

Stop an active run and wait for its final record.

Parameters

runId

string

Returns

Promise<RunRecord>

---

cancelSoftwareInstallation()

cancelSoftwareInstallation(sourceId, runId): Promise<{ createdAt: string; id: string; items: object[]; planId: string; retryOf?: string; sourceId: string; state: "waiting" | "cancelled" | "running" | "completed" | "failed" | "queued" | "cancelling" | "interrupted"; updatedAt: string; version: 1; }>

Defined in: packages/craft-hub/src/runtime.ts:279

Stop active and pending work through the software worker owner.

Parameters

sourceId

string

runId

string

Returns

Promise<{ createdAt: string; id: string; items: object[]; planId: string; retryOf?: string; sourceId: string; state: "waiting" | "cancelled" | "running" | "completed" | "failed" | "queued" | "cancelling" | "interrupted"; updatedAt: string; version: 1; }>

---

capabilities()

capabilities(projectId): Promise<Capability[]>

Defined in: packages/craft-hub/src/runtime.ts:212

Discover the current capabilities for one registered project.

Parameters

projectId

string

Returns

Promise<Capability[]>

---

capabilityDiscovery()

capabilityDiscovery(projectId, requestedLocale?): Promise<CapabilityDiscoveryResult>

Defined in: packages/craft-hub/src/runtime.ts:355

Discover capabilities and non-fatal diagnostics for one registered project.

Parameters

projectId

string

requestedLocale?

"en" | "zh-CN"

Returns

Promise<CapabilityDiscoveryResult>

---

capabilityPins()

capabilityPins(projectId): Promise<CapabilityPins>

Defined in: packages/craft-hub/src/runtime.ts:496

Return the current capability ids represented by this project's machine-local pin order.

Parameters

projectId

string

Returns

Promise<CapabilityPins>

---

cleanupRuns()

cleanupRuns(options): Promise<RunCleanupResult>

Defined in: packages/craft-hub/src/runtime.ts:600

Delete unpinned persisted runs matching the requested retention policy.

Parameters

options

RunCleanupOptions

Returns

Promise<RunCleanupResult>

---

close()

close(): Promise<void>

Defined in: packages/craft-hub/src/runtime.ts:638

Cancel active agent tasks and commands during host shutdown.

Returns

Promise<void>

---

completeIntegrationConnection()

completeIntegrationConnection(integrationId, input): Promise<void>

Defined in: packages/craft-hub/src/runtime.ts:333

Finish only an OAuth session previously started through an enabled integration.

Parameters

integrationId

string

input

Record<string, unknown>

Returns

Promise<void>

---

diagnosticSnapshot()

diagnosticSnapshot(): Promise<WorkbenchDiagnosticSnapshot>

Defined in: packages/craft-hub/src/runtime.ts:222

Collect current host, extension, and configuration failures for client presentation.

Returns

Promise<WorkbenchDiagnosticSnapshot>

---

getPluginDiagnostics()

getPluginDiagnostics(): readonly PluginDiagnostic[]

Defined in: packages/craft-hub/src/runtime.ts:526

Diagnostics from the most recent plugin discovery pass.

Returns

readonly PluginDiagnostic[]

---

initializeProjectConfig()

initializeProjectConfig(projectId, mode, expectedRevision?): Promise<ProjectConfigInitializationResult>

Defined in: packages/craft-hub/src/runtime.ts:175

Preview or create one registered project's optional repository-owned configuration.

Parameters

projectId

string

mode

ProjectConfigInitializationMode

expectedRevision?

string

Returns

Promise<ProjectConfigInitializationResult>

---

installSoftware()

installSoftware(sourceId, planId, confirmed): Promise<{ createdAt: string; id: string; items: object[]; planId: string; retryOf?: string; sourceId: string; state: "waiting" | "cancelled" | "running" | "completed" | "failed" | "queued" | "cancelling" | "interrupted"; updatedAt: string; version: 1; }>

Defined in: packages/craft-hub/src/runtime.ts:267

Install an explicitly reviewed adapter plan on this local machine.

Parameters

sourceId

string

planId

string

confirmed

boolean

Returns

Promise<{ createdAt: string; id: string; items: object[]; planId: string; retryOf?: string; sourceId: string; state: "waiting" | "cancelled" | "running" | "completed" | "failed" | "queued" | "cancelling" | "interrupted"; updatedAt: string; version: 1; }>

---

integrationContributions()

integrationContributions(): Promise<{ diagnostics: IntegrationDiagnostic[]; integrations: ResolvedIntegrationContribution[]; }>

Defined in: packages/craft-hub/src/runtime.ts:217

Resolve installed marketplace integration declarations against trusted host providers.

Returns

Promise<{ diagnostics: IntegrationDiagnostic[]; integrations: ResolvedIntegrationContribution[]; }>

---

integrationSourcePath()

integrationSourcePath(integrationId, actionId, entityId, detailIndex, projectId?): Promise<string>

Defined in: packages/craft-hub/src/runtime.ts:342

Resolve a source from a fresh provider result, never a renderer-supplied path.

Parameters

integrationId

string

actionId

string

entityId

string

detailIndex

number

projectId?

string

Returns

Promise<string>

---

invokeIntegrationAction()

invokeIntegrationAction(options): Promise<IntegrationActionResult>

Defined in: packages/craft-hub/src/runtime.ts:296

Invoke one enabled declarative integration through a trusted host adapter.

Parameters

options

actionId

string

callbackUrl?

string

confirmed?

boolean

input?

Record<string, unknown>

integrationId

string

projectId?

string

Returns

Promise<IntegrationActionResult>

---

localEnvironmentSnapshot()

localEnvironmentSnapshot(): Promise<LocalEnvironmentSnapshot>

Defined in: packages/craft-hub/src/runtime.ts:246

Inspect fixed tools on a local API host, sharing only concurrent requests.

Returns

Promise<LocalEnvironmentSnapshot>

---

onRunsChanged()

onRunsChanged(listener): () => void

Defined in: packages/craft-hub/src/runtime.ts:605

Subscribe to execution summary changes.

Parameters

listener

(summary) => void

Returns

() => void

---

openSoftwareApplication()

openSoftwareApplication(sourceId, softwareId): Promise<{ destination: "application"; softwareId: string; version: 1; }>

Defined in: packages/craft-hub/src/runtime.ts:285

Request a detected application launch through its trusted catalog identifier.

Parameters

sourceId

string

softwareId

string

Returns

Promise<{ destination: "application"; softwareId: string; version: 1; }>

---

pinRun()

pinRun(runId, pinned): Promise<RunRecord>

Defined in: packages/craft-hub/src/runtime.ts:595

Set whether a persisted run is exempt from automatic retention.

Parameters

runId

string

pinned

boolean

Returns

Promise<RunRecord>

---

planGitIntegration()

planGitIntegration(projectId, request?): Promise<GitIntegrationPlan>

Defined in: packages/craft-hub/src/runtime.ts:202

Compute a fresh, side-effect-free Plan for integrating the current local Git branch.

Parameters

projectId

string

request?

GitIntegrationRequest = {}

Returns

Promise<GitIntegrationPlan>

---

previewCommand()

previewCommand(projectId, capabilityId, inputs?): Promise<CommandInvocation>

Defined in: packages/craft-hub/src/runtime.ts:531

Resolve and validate one command invocation without executing it.

Parameters

projectId

string

capabilityId

string

inputs?

CommandInputValues = {}

Returns

Promise<CommandInvocation>

---

projectOverview()

projectOverview(projectId, packagePath?, requestedLocale?): Promise<ProjectOverview>

Defined in: packages/craft-hub/src/runtime.ts:474

Resolve one contextual project or package overview and its bounded README.

Parameters

projectId

string

packagePath?

string = '.'

requestedLocale?

"en" | "zh-CN"

Returns

Promise<ProjectOverview>

---

projectOverviewAsset()

projectOverviewAsset(projectId, projectRelativePath): Promise<{ content: Buffer; contentType: string; } | undefined>

Defined in: packages/craft-hub/src/runtime.ts:490

Read one bounded raster asset contained by a registered project.

Parameters

projectId

string

projectRelativePath

string

Returns

Promise<{ content: Buffer; contentType: string; } | undefined>

---

projectRunSummaries()

projectRunSummaries(): ProjectRunSummary[]

Defined in: packages/craft-hub/src/runtime.ts:581

Current per-project execution summaries for UI and API consumers.

Returns

ProjectRunSummary[]

---

projectSkills()

projectSkills(projectId): Promise<ProjectSkillsState>

Defined in: packages/craft-hub/src/runtime.ts:447

Return effective repository and machine-local Skill activation state.

Parameters

projectId

string

Returns

Promise<ProjectSkillsState>

---

releasePlan()

releasePlan(projectId, capabilityId, inputs?): Promise<ReleasePlan>

Defined in: packages/craft-hub/src/runtime.ts:543

Compute a fresh release preflight without mutating the repository.

Parameters

projectId

string

capabilityId

string

inputs?

CommandInputValues = {}

Returns

Promise<ReleasePlan>

---

resizeRun()

resizeRun(runId, columns, rows): void

Defined in: packages/craft-hub/src/runtime.ts:616

Resize the pseudo-terminal attached to an active run.

Parameters

runId

string

columns

number

rows

number

Returns

void

---

run()

run(projectId, capabilityId, onOutput?, inputs?): Promise<RunHandle>

Defined in: packages/craft-hub/src/runtime.ts:552

Execute a discovered command capability after rechecking project trust and resolving inputs.

Parameters

projectId

string

capabilityId

string

onOutput?

(event) => void

inputs?

CommandInputValues = {}

Returns

Promise<RunHandle>

---

runs()

runs(): Promise<RunRecord[]>

Defined in: packages/craft-hub/src/runtime.ts:590

List persisted run records.

Returns

Promise<RunRecord[]>

---

softwareCatalogSnapshot()

softwareCatalogSnapshot(__namedParameters?): Promise<SoftwareCatalogSnapshot>

Defined in: packages/craft-hub/src/runtime.ts:256

Browse cached metadata; optionally overlay read-only plugin discovery on local hosts.

Parameters

__namedParameters?

localDiscovery?

boolean = true

Returns

Promise<SoftwareCatalogSnapshot>

---

softwareInstallationPlan()

softwareInstallationPlan(sourceId, softwareIds): Promise<{ createdAt: string; id: string; items: object[]; prerequisites: string[]; sourceId: string; version: 1; }>

Defined in: packages/craft-hub/src/runtime.ts:261

Review selected host software without changing project trust or installing packages.

Parameters

sourceId

string

softwareIds

string[]

Returns

Promise<{ createdAt: string; id: string; items: object[]; prerequisites: string[]; sourceId: string; version: 1; }>

---

softwareInstallationRuns()

softwareInstallationRuns(sourceId): Promise<{ runs: object[]; version: 1; }>

Defined in: packages/craft-hub/src/runtime.ts:273

Recover recent adapter-owned software progress after a client refresh.

Parameters

sourceId

string

Returns

Promise<{ runs: object[]; version: 1; }>

---

unregisterProject()

unregisterProject(projectId): Promise<ProjectRecord>

Defined in: packages/craft-hub/src/runtime.ts:170

Remove a project registration without deleting its directory.

Parameters

projectId

string

Returns

Promise<ProjectRecord>

---

updateCapabilityPins()

updateCapabilityPins(projectId, capabilityIds): Promise<CapabilityPins>

Defined in: packages/craft-hub/src/runtime.ts:511

Replace one project's machine-local pin order after validating every capability id.

Parameters

projectId

string

capabilityIds

string[]

Returns

Promise<CapabilityPins>

---

updateProjectSkills()

updateProjectSkills(projectId, input): Promise<ProjectSkillsState>

Defined in: packages/craft-hub/src/runtime.ts:466

Replace machine-local Skill preferences after validating their bounded shape.

Parameters

projectId

string

input

LocalSkillActivationSettings

Returns

Promise<ProjectSkillsState>

---

withConfiguration()

withConfiguration<T>(action): Promise<T>

Defined in: packages/craft-hub/src/runtime.ts:158

Serialize account synchronization with configuration API mutations in this runtime.

Type Parameters

T

T

Parameters

action

() => Promise<T>

Returns

Promise<T>

---

writeRun()

writeRun(runId, data): void

Defined in: packages/craft-hub/src/runtime.ts:611

Send terminal input to an active run.

Parameters

runId

string

data

string

Returns

void