@brightbeamai/chap-coordinator 0.2.8

package/dist/methods.d.ts

@@ -0,0 +1,455 @@
+import { WorkspaceId, Workspace, ParticipantUri, TaskId, JsonPatchOp, ArtefactId } from './types.js';
+
+/**
+ * Typed method definitions.
+ *
+ * Every CHAP method that ships in either reference implementation
+ * gets a typed `Params` and `Result` shape here. The Coordinator's
+ * typed facade (`coord.workspace.create`, `coord.task.complete`, …)
+ * uses these types so callers get autocomplete and compile-time
+ * checking without having to remember field names.
+ *
+ * These types are hand-maintained against the canonical JSON Schemas
+ * under `schemas/`. A future revision will generate this file from
+ * the schemas automatically; for now the source of truth remains
+ * the running tests under `tests/`.
+ *
+ * Scope: 39 method handlers shipped by both v0.2 reference
+ * implementations (Core + every shipped profile). Spec-only methods
+ * are excluded - they would mislead callers into thinking the local
+ * Coordinator can dispatch them.
+ */
+
+interface WorkspaceParam {
+    workspace: WorkspaceId;
+}
+interface ActorParam {
+    from: ParticipantUri;
+}
+interface TaskParam {
+    task_id: TaskId;
+}
+interface OkResult {
+    ok: true;
+}
+interface WorkspaceCreateParams extends Partial<WorkspaceParam> {
+    profiles?: string[];
+    routing_policy_uri?: string;
+    mode?: "shadow" | "trial" | "production";
+    mode_ceiling?: "shadow" | "trial" | "production";
+}
+interface WorkspaceCreateResult {
+    workspace: WorkspaceId;
+}
+interface WorkspaceDescribeParams extends WorkspaceParam {
+}
+interface WorkspaceDescribeResult {
+    workspace: Workspace;
+}
+interface WorkspaceSetProfilesParams extends WorkspaceParam, ActorParam {
+    profiles: string[];
+}
+type WorkspaceSetProfilesResult = OkResult;
+interface ParticipantJoinParams extends WorkspaceParam, ActorParam {
+    type: "human" | "agent" | "service" | "group" | "workspace";
+    role?: string;
+    scopes?: string[];
+    capabilities?: Record<string, unknown>;
+    oidc_token?: unknown;
+    vc?: unknown;
+    pubkey?: unknown;
+}
+type ParticipantJoinResult = OkResult;
+interface ParticipantLeaveParams extends WorkspaceParam, ActorParam {
+    reason?: string;
+}
+type ParticipantLeaveResult = OkResult;
+interface ParticipantRotateKeyParams extends WorkspaceParam, ActorParam {
+    pubkey: unknown;
+    reason?: string;
+}
+type ParticipantRotateKeyResult = OkResult;
+interface ParticipantRevokeKeyParams extends WorkspaceParam, ActorParam {
+    kid: string;
+    reason?: string;
+}
+type ParticipantRevokeKeyResult = OkResult;
+interface TaskCreateParams extends WorkspaceParam, ActorParam {
+    kind: string;
+    input: unknown;
+    assignee?: ParticipantUri;
+    to?: ParticipantUri;
+    routing_hints?: Record<string, unknown>;
+    deadline?: string;
+}
+interface TaskCreateResult {
+    task_id: TaskId;
+}
+interface TaskUpdateParams extends WorkspaceParam, ActorParam, TaskParam {
+    state?: string;
+    output?: unknown;
+    progress?: Record<string, unknown>;
+}
+type TaskUpdateResult = OkResult;
+interface TaskCompleteParams extends WorkspaceParam, ActorParam, TaskParam {
+    output?: unknown;
+    confidence?: number | string;
+}
+type TaskCompleteResult = OkResult;
+interface ReviewRequestParams extends WorkspaceParam, ActorParam, TaskParam {
+    artefact: unknown;
+    to: ParticipantUri | ParticipantUri[];
+    rule?: string;
+    deadline?: string;
+}
+interface ReviewRequestResult {
+    state: string;
+    review_id: TaskId;
+}
+interface DecideApproveParams extends WorkspaceParam, ActorParam, TaskParam {
+    rationale?: string;
+}
+type DecideApproveResult = OkResult;
+interface DecideRejectParams extends WorkspaceParam, ActorParam, TaskParam {
+    rationale: string;
+    category?: string;
+}
+type DecideRejectResult = OkResult;
+interface DecideOverrideParams extends WorkspaceParam, ActorParam, TaskParam {
+    diff: JsonPatchOp[];
+    rationale: string;
+    tags?: string[];
+    policy_refs?: string[];
+    logical_id?: string;
+    instance_id?: string;
+    intent_preserved?: boolean;
+    based_on_artefact?: unknown;
+}
+interface DecideOverrideResult {
+    state: "completed";
+    override_artefact_id: ArtefactId;
+    applied: unknown;
+}
+interface AbstainDeclareParams extends WorkspaceParam, ActorParam, TaskParam {
+    category: string;
+    rationale?: string;
+}
+type AbstainDeclareResult = OkResult;
+interface EscalateRaiseParams extends WorkspaceParam, ActorParam, TaskParam {
+    to?: ParticipantUri;
+    rationale?: string;
+}
+interface EscalateRaiseResult {
+    ok: true;
+    to?: ParticipantUri;
+}
+interface WhisperAskParams extends WorkspaceParam, ActorParam, TaskParam {
+    to: ParticipantUri;
+    question: string;
+    options?: string[];
+    default_on_lapse?: string;
+    lapse_ms?: number;
+}
+interface WhisperAskResult {
+    whisper_id: string;
+}
+interface WhisperAnswerParams extends WorkspaceParam, ActorParam {
+    whisper_id: string;
+    answer: string;
+}
+type WhisperAnswerResult = OkResult;
+interface DeliberateOpenParams extends WorkspaceParam, ActorParam, TaskParam {
+    rule: Record<string, unknown>;
+    proposition: unknown;
+    voters: ParticipantUri[];
+}
+interface DeliberateOpenResult {
+    deliberation_id: string;
+}
+interface DeliberateCommentParams extends WorkspaceParam, ActorParam {
+    deliberation_id: string;
+    text: string;
+}
+type DeliberateCommentResult = OkResult;
+interface DeliberateVoteParams extends WorkspaceParam, ActorParam {
+    deliberation_id: string;
+    vote: "yea" | "nay" | "abstain";
+    weight?: number;
+    rationale?: string;
+}
+type DeliberateVoteResult = OkResult;
+interface DeliberateCloseParams extends WorkspaceParam, ActorParam {
+    deliberation_id: string;
+}
+interface DeliberateCloseResult {
+    outcome: "approved" | "rejected" | "no_quorum";
+}
+interface HandoffProposeParams extends WorkspaceParam, ActorParam {
+    to: ParticipantUri;
+    task_ids: TaskId[];
+    summary: string;
+    active_constraints?: Record<string, unknown>;
+}
+interface HandoffProposeResult {
+    handoff_id: string;
+}
+interface HandoffAcceptParams extends WorkspaceParam, ActorParam {
+    handoff_id: string;
+}
+type HandoffAcceptResult = OkResult;
+interface HandoffDeclineParams extends WorkspaceParam, ActorParam {
+    handoff_id: string;
+    reason?: string;
+}
+type HandoffDeclineResult = OkResult;
+interface ControlPauseParams extends WorkspaceParam, ActorParam {
+    reason?: string;
+}
+type ControlPauseResult = OkResult;
+interface ControlResumeParams extends WorkspaceParam, ActorParam {
+    reason?: string;
+}
+type ControlResumeResult = OkResult;
+interface ControlCancelParams extends WorkspaceParam, ActorParam, TaskParam {
+    reason?: string;
+}
+type ControlCancelResult = OkResult;
+interface ControlSupersedeParams extends WorkspaceParam, ActorParam, TaskParam {
+    replacement: unknown;
+    logical_id?: string;
+    intent_preserved?: boolean;
+    reason?: string;
+}
+interface ControlSupersedeResult {
+    artefact_id: ArtefactId;
+}
+interface ControlSnapshotParams extends WorkspaceParam, ActorParam {
+    label?: string;
+}
+interface ControlSnapshotResult {
+    snapshot_id: string;
+}
+interface ControlRollbackParams extends WorkspaceParam, ActorParam {
+    snapshot_id: string;
+    reason?: string;
+}
+type ControlRollbackResult = OkResult;
+interface ControlSetModeCeilingParams extends WorkspaceParam, ActorParam {
+    ceiling: "shadow" | "trial" | "production";
+}
+type ControlSetModeCeilingResult = OkResult;
+interface TaskRouteParams extends WorkspaceParam, ActorParam, TaskParam {
+    candidates: ParticipantUri[];
+}
+interface TaskRouteResult {
+    selected: ParticipantUri;
+    rationale: Record<string, unknown>;
+}
+interface ReviewDepthParams extends WorkspaceParam, ActorParam, TaskParam {
+    artefact?: unknown;
+    hints?: Record<string, unknown>;
+}
+interface ReviewDepthResult {
+    depth: "skip" | "spot_check" | "full" | "escalated";
+    sampling_probability?: number;
+    rationale: Record<string, unknown>;
+}
+interface EscalateAutoParams extends WorkspaceParam, ActorParam, TaskParam {
+    hints?: Record<string, unknown>;
+}
+interface EscalateAutoResult {
+    escalated: boolean;
+    to?: ParticipantUri;
+    triggered_rule?: Record<string, unknown>;
+}
+interface AuditReadParams extends WorkspaceParam {
+    from_seq?: number;
+    limit?: number;
+}
+interface AuditReadResult {
+    entries: unknown[];
+}
+interface AuditSubmitToScittParams extends WorkspaceParam, ActorParam {
+    seq: number;
+    statement?: Record<string, unknown>;
+}
+interface AuditSubmitToScittResult {
+    receipt: Record<string, unknown>;
+}
+interface AuditVerifyReceiptParams extends WorkspaceParam {
+    receipt: Record<string, unknown>;
+}
+interface AuditVerifyReceiptResult {
+    valid: boolean;
+}
+interface AuditVerifyChainParams extends WorkspaceParam {
+    from_seq?: number;
+    to_seq?: number;
+}
+interface AuditVerifyChainResult {
+    valid: boolean;
+    breaks?: number[];
+}
+interface MethodTable {
+    "workspace.create": {
+        params: WorkspaceCreateParams;
+        result: WorkspaceCreateResult;
+    };
+    "workspace.describe": {
+        params: WorkspaceDescribeParams;
+        result: WorkspaceDescribeResult;
+    };
+    "workspace.set_profiles": {
+        params: WorkspaceSetProfilesParams;
+        result: WorkspaceSetProfilesResult;
+    };
+    "participant.join": {
+        params: ParticipantJoinParams;
+        result: ParticipantJoinResult;
+    };
+    "participant.leave": {
+        params: ParticipantLeaveParams;
+        result: ParticipantLeaveResult;
+    };
+    "participant.rotate_key": {
+        params: ParticipantRotateKeyParams;
+        result: ParticipantRotateKeyResult;
+    };
+    "participant.revoke_key": {
+        params: ParticipantRevokeKeyParams;
+        result: ParticipantRevokeKeyResult;
+    };
+    "task.create": {
+        params: TaskCreateParams;
+        result: TaskCreateResult;
+    };
+    "task.update": {
+        params: TaskUpdateParams;
+        result: TaskUpdateResult;
+    };
+    "task.complete": {
+        params: TaskCompleteParams;
+        result: TaskCompleteResult;
+    };
+    "review.request": {
+        params: ReviewRequestParams;
+        result: ReviewRequestResult;
+    };
+    "decide.approve": {
+        params: DecideApproveParams;
+        result: DecideApproveResult;
+    };
+    "decide.reject": {
+        params: DecideRejectParams;
+        result: DecideRejectResult;
+    };
+    "decide.override": {
+        params: DecideOverrideParams;
+        result: DecideOverrideResult;
+    };
+    "abstain.declare": {
+        params: AbstainDeclareParams;
+        result: AbstainDeclareResult;
+    };
+    "escalate.raise": {
+        params: EscalateRaiseParams;
+        result: EscalateRaiseResult;
+    };
+    "whisper.ask": {
+        params: WhisperAskParams;
+        result: WhisperAskResult;
+    };
+    "whisper.answer": {
+        params: WhisperAnswerParams;
+        result: WhisperAnswerResult;
+    };
+    "deliberate.open": {
+        params: DeliberateOpenParams;
+        result: DeliberateOpenResult;
+    };
+    "deliberate.comment": {
+        params: DeliberateCommentParams;
+        result: DeliberateCommentResult;
+    };
+    "deliberate.vote": {
+        params: DeliberateVoteParams;
+        result: DeliberateVoteResult;
+    };
+    "deliberate.close": {
+        params: DeliberateCloseParams;
+        result: DeliberateCloseResult;
+    };
+    "handoff.propose": {
+        params: HandoffProposeParams;
+        result: HandoffProposeResult;
+    };
+    "handoff.accept": {
+        params: HandoffAcceptParams;
+        result: HandoffAcceptResult;
+    };
+    "handoff.decline": {
+        params: HandoffDeclineParams;
+        result: HandoffDeclineResult;
+    };
+    "control.pause": {
+        params: ControlPauseParams;
+        result: ControlPauseResult;
+    };
+    "control.resume": {
+        params: ControlResumeParams;
+        result: ControlResumeResult;
+    };
+    "control.cancel": {
+        params: ControlCancelParams;
+        result: ControlCancelResult;
+    };
+    "control.supersede": {
+        params: ControlSupersedeParams;
+        result: ControlSupersedeResult;
+    };
+    "control.snapshot": {
+        params: ControlSnapshotParams;
+        result: ControlSnapshotResult;
+    };
+    "control.rollback": {
+        params: ControlRollbackParams;
+        result: ControlRollbackResult;
+    };
+    "control.set_mode_ceiling": {
+        params: ControlSetModeCeilingParams;
+        result: ControlSetModeCeilingResult;
+    };
+    "task.route": {
+        params: TaskRouteParams;
+        result: TaskRouteResult;
+    };
+    "review.depth": {
+        params: ReviewDepthParams;
+        result: ReviewDepthResult;
+    };
+    "escalate.auto": {
+        params: EscalateAutoParams;
+        result: EscalateAutoResult;
+    };
+    "audit.read": {
+        params: AuditReadParams;
+        result: AuditReadResult;
+    };
+    "audit.submit_to_scitt": {
+        params: AuditSubmitToScittParams;
+        result: AuditSubmitToScittResult;
+    };
+    "audit.verify_receipt": {
+        params: AuditVerifyReceiptParams;
+        result: AuditVerifyReceiptResult;
+    };
+    "audit.verify_chain": {
+        params: AuditVerifyChainParams;
+        result: AuditVerifyChainResult;
+    };
+}
+type MethodName = keyof MethodTable;
+type MethodParams<M extends MethodName> = MethodTable[M]["params"];
+type MethodResult<M extends MethodName> = MethodTable[M]["result"];
+
+export type { AbstainDeclareParams, AbstainDeclareResult, ActorParam, AuditReadParams, AuditReadResult, AuditSubmitToScittParams, AuditSubmitToScittResult, AuditVerifyChainParams, AuditVerifyChainResult, AuditVerifyReceiptParams, AuditVerifyReceiptResult, ControlCancelParams, ControlCancelResult, ControlPauseParams, ControlPauseResult, ControlResumeParams, ControlResumeResult, ControlRollbackParams, ControlRollbackResult, ControlSetModeCeilingParams, ControlSetModeCeilingResult, ControlSnapshotParams, ControlSnapshotResult, ControlSupersedeParams, ControlSupersedeResult, DecideApproveParams, DecideApproveResult, DecideOverrideParams, DecideOverrideResult, DecideRejectParams, DecideRejectResult, DeliberateCloseParams, DeliberateCloseResult, DeliberateCommentParams, DeliberateCommentResult, DeliberateOpenParams, DeliberateOpenResult, DeliberateVoteParams, DeliberateVoteResult, EscalateAutoParams, EscalateAutoResult, EscalateRaiseParams, EscalateRaiseResult, HandoffAcceptParams, HandoffAcceptResult, HandoffDeclineParams, HandoffDeclineResult, HandoffProposeParams, HandoffProposeResult, MethodName, MethodParams, MethodResult, MethodTable, OkResult, ParticipantJoinParams, ParticipantJoinResult, ParticipantLeaveParams, ParticipantLeaveResult, ParticipantRevokeKeyParams, ParticipantRevokeKeyResult, ParticipantRotateKeyParams, ParticipantRotateKeyResult, ReviewDepthParams, ReviewDepthResult, ReviewRequestParams, ReviewRequestResult, TaskCompleteParams, TaskCompleteResult, TaskCreateParams, TaskCreateResult, TaskParam, TaskRouteParams, TaskRouteResult, TaskUpdateParams, TaskUpdateResult, WhisperAnswerParams, WhisperAnswerResult, WhisperAskParams, WhisperAskResult, WorkspaceCreateParams, WorkspaceCreateResult, WorkspaceDescribeParams, WorkspaceDescribeResult, WorkspaceParam, WorkspaceSetProfilesParams, WorkspaceSetProfilesResult };

package/dist/methods.js

@@ -0,0 +1 @@
+//# sourceMappingURL=methods.js.map

package/dist/methods.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}