borgmcp-server 0.1.1

package/dist/store.d.ts

@@ -0,0 +1,327 @@
+import { type Principal } from "./principal.js";
+export type CubeAccess = "read" | "write" | "manage";
+export interface CubeRecord {
+    readonly id: string;
+    readonly ownerId: string;
+    readonly name: string;
+    readonly directive: string;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}
+export interface ActivityRecord {
+    readonly id: string;
+    readonly cubeId: string;
+    readonly droneId: string | null;
+    readonly actorKind: Principal["kind"];
+    readonly actorId: string;
+    readonly message: string;
+    readonly createdAt: string;
+}
+export interface LogCursor {
+    readonly id: string;
+    readonly created_at: string;
+}
+export interface EnrichedActivityRecord {
+    readonly id: string;
+    readonly cube_id: string;
+    readonly drone_id: string | null;
+    readonly message: string;
+    readonly visibility: "broadcast" | "direct";
+    readonly created_at: string;
+    readonly drone_label: string | null;
+    readonly role_name: string | null;
+    readonly recipient_drone_ids: string[];
+}
+export interface ClaimRecord {
+    readonly log_entry_id: string;
+    readonly claimant_drone_id: string;
+    readonly claimant_label: string | null;
+    readonly claimant_role: string | null;
+    readonly claimed_at: string;
+    readonly stale: false;
+}
+export interface ActivityPage {
+    readonly entries: EnrichedActivityRecord[];
+    readonly cursor: LogCursor | null;
+    readonly behind_by: number;
+    readonly has_more: boolean;
+    readonly claims: ClaimRecord[];
+}
+export interface DecisionRecord {
+    readonly id: string;
+    readonly cube_id: string;
+    readonly topic: string;
+    readonly decision: string;
+    readonly rationale: string | null;
+    readonly ratified_by: string | null;
+    readonly status: "active" | "superseded" | "removed";
+    readonly supersedes: string | null;
+    readonly created_at: string;
+}
+export interface RoleRecord {
+    readonly id: string;
+    readonly cube_id: string;
+    readonly name: string;
+    readonly short_description: string;
+    readonly is_default: boolean;
+    readonly is_human_seat: boolean;
+    readonly role_class: "queen" | "worker";
+    readonly created_at: string;
+}
+export interface DroneRecord {
+    readonly id: string;
+    readonly cube_id: string;
+    readonly role_id: string;
+    readonly label: string;
+    readonly last_seen: string;
+    readonly hostname: string | null;
+    readonly created_at: string;
+}
+export interface StoreDiagnostics {
+    readonly journalMode: string;
+    readonly foreignKeys: boolean;
+    readonly schemaVersions: number[];
+}
+export interface OpenStoreOptions {
+    readonly path: string;
+    readonly clock?: () => Date;
+    readonly storageLimits?: StorageLimits;
+    readonly capacityProbe?: () => StorageCapacity;
+    readonly cubeLimits?: CubeLimits;
+    readonly mutationHook?: (phase: string) => void;
+}
+export interface CubeLimits {
+    readonly maxCubesPerClient: number;
+    readonly maxCubesTotal: number;
+}
+export declare const DEFAULT_CUBE_LIMITS: CubeLimits;
+export interface StorageLimits {
+    readonly maxActivityEntriesPerCube: number;
+    readonly maxDatabaseBytes: number;
+    readonly minFreeDiskBytes: number;
+}
+export interface StorageCapacity {
+    readonly databaseBytes: number;
+    readonly freeDiskBytes: number;
+}
+export declare const DEFAULT_STORAGE_LIMITS: StorageLimits;
+export interface StoreRuntime {
+    readonly forPrincipal: (principal: Principal) => ScopedStore;
+    readonly maintenance: MaintenanceStore;
+    readonly credentials: CredentialStore;
+    readonly diagnostics: () => StoreDiagnostics;
+    readonly close: () => void;
+}
+export interface DigestPair {
+    readonly lookup: Buffer;
+    readonly verifier: Buffer;
+}
+export interface StoredSecretDigest extends DigestPair {
+    readonly id: string;
+    readonly expiresAt?: string;
+    readonly consumedAt?: string | null;
+    readonly clientId?: string;
+    readonly revokedAt?: string | null;
+}
+export interface StoredInvitationDigest extends StoredSecretDigest {
+    readonly purpose: "owner" | "client";
+    readonly ownerEpoch: number | null;
+}
+export interface EnrollmentClaimResult {
+    readonly purpose: "owner" | "client";
+    readonly clientId: string;
+    readonly serverCapabilities: readonly [] | readonly ["create_cube"];
+}
+export interface StoredDroneSessionDigest extends StoredSecretDigest {
+    readonly sessionId: string;
+    readonly clientId: string;
+    readonly cubeId: string;
+    readonly droneId: string;
+    readonly expiresAt: string;
+}
+export interface CredentialStore {
+    readonly createRecoveryCredential: (id: string, digest: DigestPair) => void;
+    readonly findRecoveryCredential: (lookup: Buffer) => StoredSecretDigest | null;
+    readonly createInvitation: (input: {
+        readonly id: string;
+        readonly digest: DigestPair;
+        readonly expiresAt: string;
+        readonly purpose: "owner" | "client";
+    }) => void;
+    readonly findInvitation: (lookup: Buffer) => StoredInvitationDigest | null;
+    readonly claimInvitation: (input: {
+        readonly invitationId: string;
+        readonly clientId: string;
+        readonly requestedClientName: string | null;
+        readonly retryKey: string;
+        readonly credentialId: string;
+        readonly credentialDigest: DigestPair;
+    }) => EnrollmentClaimResult | null;
+    readonly findClientCredential: (lookup: Buffer) => StoredSecretDigest | null;
+    readonly clientExists: (clientId: string) => boolean;
+    readonly clientIsActive: (clientId: string) => boolean;
+    readonly findDroneSessionCredential: (lookup: Buffer) => StoredDroneSessionDigest | null;
+    readonly rotateClientCredential: (input: {
+        readonly clientId: string;
+        readonly credentialId: string;
+        readonly credentialDigest: DigestPair;
+    }) => boolean;
+    readonly revokeClientCredentials: (clientId: string) => void;
+}
+export interface ScopedStore {
+    readonly createCube: (input: CreateCubeInput) => CreateCubeRecord;
+    readonly listCubes: () => CubeRecord[];
+    readonly getCube: (cubeId: string) => CubeRecord | null;
+    readonly updateDirective: (cubeId: string, directive: string) => void;
+    readonly appendActivity: (cubeId: string, message: string) => ActivityRecord;
+    readonly readActivity: (cubeId: string, limit: number) => ActivityRecord[];
+    readonly listRoles: (cubeId: string) => RoleRecord[];
+    readonly listDrones: (cubeId: string) => DroneRecord[];
+    readonly appendLog: (cubeId: string, input: {
+        readonly message: string;
+        readonly visibility?: "broadcast" | "direct";
+        readonly recipientDroneIds?: readonly string[];
+    }) => EnrichedActivityRecord;
+    readonly readLog: (cubeId: string, cursor: LogCursor | null, limit: number) => ActivityPage;
+    readonly acknowledge: (cubeId: string, entryId: string, kind: "ack" | "claim") => void;
+    readonly recordDecision: (cubeId: string, input: {
+        readonly topic: string;
+        readonly decision: string;
+        readonly rationale?: string;
+    }) => DecisionRecord;
+    readonly listDecisions: (cubeId: string) => DecisionRecord[];
+    readonly subscribeActivity: (cubeId: string, listener: (entry: EnrichedActivityRecord) => void) => (() => void);
+    readonly attachSeat: (input: SeatAttachInput) => SeatAttachRecord;
+}
+export interface CreateCubeInput {
+    readonly retryKey: string;
+    readonly name: string;
+    readonly template: "default";
+}
+export interface CreateCubeRecord {
+    readonly cubeId: string;
+    readonly humanSeatRoleId: string;
+    readonly defaultWorkerRoleId: string;
+    readonly access: "manage";
+}
+export interface SeatAttachInput {
+    readonly cubeId: string;
+    readonly roleId: string;
+    readonly retryKey: string;
+    readonly priorDroneId?: string;
+    readonly droneId: string;
+    readonly sessionId: string;
+    readonly credentialId: string;
+    readonly credentialDigest: DigestPair;
+    readonly expiresAt: string;
+}
+export interface SeatAttachRecord {
+    readonly cube: {
+        readonly id: string;
+        readonly name: string;
+    };
+    readonly role: {
+        readonly id: string;
+        readonly name: string;
+        readonly role_class: "queen" | "worker";
+        readonly is_human_seat: boolean;
+    };
+    readonly drone: {
+        readonly id: string;
+        readonly label: string;
+    };
+    readonly sessionId: string;
+    readonly expiresAt: string;
+    readonly generation: number;
+    readonly reattached: boolean;
+    readonly revokedSessionIds: readonly string[];
+}
+export interface MaintenanceStore {
+    readonly createClient: (input: {
+        readonly id: string;
+        readonly name: string;
+    }) => void;
+    readonly createCube: (input: {
+        readonly id: string;
+        readonly ownerId?: string;
+        readonly name: string;
+        readonly directive: string;
+    }) => void;
+    readonly grantClientCube: (input: {
+        readonly clientId: string;
+        readonly cubeId: string;
+        readonly access: CubeAccess;
+    }) => void;
+    readonly removeClientCubeGrant: (clientId: string, cubeId: string) => boolean;
+    readonly grantCreateCubeCapability: (clientId: string) => void;
+    readonly resetAuthorityState: () => void;
+    readonly observeAuthorityState: () => {
+        readonly enrolled_clients: number;
+        readonly enrollment_claims: number;
+        readonly cubes: number;
+        readonly roles: number;
+        readonly grants: number;
+        readonly server_capabilities: number;
+        readonly cube_create_bindings: number;
+    };
+    readonly inspectCreatedCube: (clientId: string, record: CreateCubeRecord) => {
+        readonly cube_exists: boolean;
+        readonly creator_has_grant: boolean;
+        readonly grant_count: number;
+        readonly role_count: number;
+        readonly human_seat_role_matches: boolean;
+        readonly default_worker_role_matches: boolean;
+    };
+    readonly inspectEnrollmentPrincipal: (clientId: string) => {
+        readonly active_credential_bindings: number;
+    };
+    readonly createRole: (input: {
+        readonly id: string;
+        readonly cubeId: string;
+        readonly name: string;
+        readonly roleClass?: "queen" | "worker";
+        readonly isHumanSeat?: boolean;
+    }) => void;
+    readonly createDrone: (input: {
+        readonly id: string;
+        readonly cubeId: string;
+        readonly roleId: string;
+        readonly clientId: string;
+        readonly label: string;
+    }) => void;
+    readonly createDroneSession: (input: {
+        readonly id: string;
+        readonly clientId: string;
+        readonly cubeId: string;
+        readonly droneId: string;
+        readonly expiresAt: string;
+    }) => void;
+    readonly revokeClient: (clientId: string) => void;
+    readonly revokeDroneSession: (sessionId: string) => void;
+    readonly expireActivityCursor: (cubeId: string, cursor: LogCursor) => void;
+}
+export declare class ScopedStoreError extends Error {
+    readonly code = "NOT_FOUND";
+    constructor();
+}
+export declare class CursorExpiredError extends Error {
+    readonly code = "CURSOR_EXPIRED";
+    constructor();
+}
+export declare class AttachConflictError extends Error {
+    readonly code = "ATTACH_CONFLICT";
+    constructor();
+}
+export declare class StorageCapacityError extends Error {
+    readonly code = "CAPACITY_EXCEEDED";
+    constructor();
+}
+export declare class AccessDeniedError extends Error {
+    readonly code = "ACCESS_DENIED";
+    constructor();
+}
+export declare class CreateCubeConflictError extends Error {
+    readonly code = "INVALID_INPUT";
+    constructor();
+}
+export declare function openStore(options: OpenStoreOptions): Promise<StoreRuntime>;