Skip to content

craft-hub / DeliveryCoordinator

Class: DeliveryCoordinator ​

Defined in: packages/craft-hub/src/delivery/coordinator.ts:14

Shared task ledger. Authorization and platform effects remain trusted host adapters.

Constructors ​

Constructor ​

new DeliveryCoordinator(store, authorize, operations?, now?, validateWorkItem?): DeliveryCoordinator

Defined in: packages/craft-hub/src/delivery/coordinator.ts:15

Parameters ​

store ​

DeliveryStore<DeliveryState>

authorize ​

(actor, projectId, permission, channelId?) => Promise<boolean>

operations? ​

DeliveryOperationProvider

now? ​

() => number

validateWorkItem? ​

(actor, link) => Promise<void>

Returns ​

DeliveryCoordinator

Properties ​

store ​

readonly store: DeliveryStore<DeliveryState>

Defined in: packages/craft-hub/src/delivery/coordinator.ts:16

Methods ​

accept() ​

accept(actor, id, accepted?): Promise<DeliveryRequest>

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

Parameters ​

actor ​

DeliveryActor

id ​

string

accepted? ​

boolean = true

Returns ​

Promise<DeliveryRequest>


approvePairing() ​

approvePairing(actor, id, projectIds): Promise<void>

Defined in: packages/craft-hub/src/delivery/coordinator.ts:122

Parameters ​

actor ​

DeliveryActor

id ​

string

projectIds ​

string[]

Returns ​

Promise<void>


beginPairing() ​

beginPairing(name, verifierHash): object

Defined in: packages/craft-hub/src/delivery/coordinator.ts:109

Parameters ​

name ​

string

verifierHash ​

string

Returns ​

object

expiresAt ​

expiresAt: number

id ​

id: string


bind() ​

bind(actor, projectId, primary): Promise<DeliveryLink>

Defined in: packages/craft-hub/src/delivery/coordinator.ts:45

Parameters ​

actor ​

DeliveryActor

projectId ​

string

primary ​
containerId ​

string = deliveryId

fetchedAt ​

number = ...

itemId ​

string = deliveryId

kind ​

string = deliveryId

provider ​

string = deliveryId

status ​

string = ...

title ​

string = ...

url ​

string = ...

Returns ​

Promise<DeliveryLink>


cancel() ​

cancel(actor, id): Promise<DeliveryRequest>

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

Parameters ​

actor ​

DeliveryActor

id ​

string

Returns ​

Promise<DeliveryRequest>


confirmOperation() ​

confirmOperation(actor, id): Promise<DeliveryOperation>

Defined in: packages/craft-hub/src/delivery/coordinator.ts:323

Parameters ​

actor ​

DeliveryActor

id ​

string

Returns ​

Promise<DeliveryOperation>


createRequest() ​

createRequest(actor, input): Promise<DeliveryRequest>

Defined in: packages/craft-hub/src/delivery/coordinator.ts:186

Parameters ​

actor ​

DeliveryActor

input ​
continuation? ​

boolean = ...

deliveryId ​

string

deviceId ​

string = deliveryId

executorId ​

string = deliveryId

idempotencyKey ​

string = deliveryId

mode? ​

"worktree" | "checkout" = ...

parentId? ​

string = ...

prompt ​

string = ...

Returns ​

Promise<DeliveryRequest>


devices() ​

devices(actor): Omit<DeliveryDevice, "tokenHash"> & object[]

Defined in: packages/craft-hub/src/delivery/coordinator.ts:157

Parameters ​

actor ​

DeliveryActor

Returns ​

Omit<DeliveryDevice, "tokenHash"> & object[]


get() ​

get(actor, id): Promise<DeliveryLink>

Defined in: packages/craft-hub/src/delivery/coordinator.ts:29

Parameters ​

actor ​

DeliveryActor

id ​

string

Returns ​

Promise<DeliveryLink>


list() ​

list(actor, channelId?): Promise<object[]>

Defined in: packages/craft-hub/src/delivery/coordinator.ts:89

Parameters ​

actor ​

DeliveryActor

channelId? ​

string

Returns ​

Promise<object[]>


planOperation() ​

planOperation(actor, id, kind, input): Promise<DeliveryOperation>

Defined in: packages/craft-hub/src/delivery/coordinator.ts:300

Parameters ​

actor ​

DeliveryActor

id ​

string

kind ​

string

input ​

Record<string, string>

Returns ​

Promise<DeliveryOperation>


poll() ​

poll(id, token, capabilities): DeliveryRequest[]

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

Parameters ​

id ​

string

token ​

string

capabilities ​
followup ​

boolean

worktree ​

boolean

Returns ​

DeliveryRequest[]


pruneContent() ​

pruneContent(retentionMs?): number

Defined in: packages/craft-hub/src/delivery/coordinator.ts:381

Retain identity and outcomes while removing expired cloud prompt bodies and summaries.

Parameters ​

retentionMs? ​

number = ...

Returns ​

number


reconcileOperation() ​

reconcileOperation(actor, id): Promise<DeliveryOperation>

Defined in: packages/craft-hub/src/delivery/coordinator.ts:357

Parameters ​

actor ​

DeliveryActor

id ​

string

Returns ​

Promise<DeliveryOperation>


redeemPairing() ​

redeemPairing(id, verifier): object

Defined in: packages/craft-hub/src/delivery/coordinator.ts:135

Parameters ​

id ​

string

verifier ​

string

Returns ​

object

id ​

id: string

token ​

token: string


relate() ​

relate(actor, id, related): Promise<DeliveryLink>

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

Parameters ​

actor ​

DeliveryActor

id ​

string

containerId ​

string = deliveryId

fetchedAt ​

number = ...

itemId ​

string = deliveryId

kind ​

string = deliveryId

provider ​

string = deliveryId

status ​

string = ...

title ​

string = ...

url ​

string = ...

Returns ​

Promise<DeliveryLink>


report() ​

report(deviceId, token, input): DeliveryRequest

Defined in: packages/craft-hub/src/delivery/coordinator.ts:259

Parameters ​

deviceId ​

string

token ​

string

input ​
id ​

string

localTaskId? ​

string

sequence ​

number

status ​

DeliveryRequestStatus

summary? ​

string

Returns ​

DeliveryRequest


reportAuthorized() ​

reportAuthorized(deviceId, token, input): Promise<DeliveryRequest>

Defined in: packages/craft-hub/src/delivery/coordinator.ts:287

Check current execution authorization before a receiver claims a request.

Parameters ​

deviceId ​

string

token ​

string

input ​
id ​

string

localTaskId? ​

string

sequence ​

number

status ​

DeliveryRequestStatus

summary? ​

string

Returns ​

Promise<DeliveryRequest>


revokeDevice() ​

revokeDevice(actor, id): void

Defined in: packages/craft-hub/src/delivery/coordinator.ts:161

Parameters ​

actor ​

DeliveryActor

id ​

string

Returns ​

void


share() ​

share(actor, id, channelId, enabled): Promise<void>

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

Parameters ​

actor ​

DeliveryActor

id ​

string

channelId ​

string

enabled ​

boolean

Returns ​

Promise<void>

Released under the MIT License.