# All files / src/hooks types.ts

0% Statements 0/100
100% Branches 1/1
100% Functions 1/1
0% Lines 0/100

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615
    616
    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    708
    709
    710
    711
    712
    713
    714
    715
    716
    717
    718
    719
    720
    721
    722
    723
    724
    725
    726
    727
    728
    729
    730
    731
    732
    733
    734
    735
    736
    737
    738
    739
    740
    741
    742
    743
    744
    745
    746
    747
    748
    749
    750
    751
    752
    753
    754
    755
    756
    757
    758
    759
    760
    761
    762
    763
    764
    765
    766
    767
    768
    769
    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    809
    810
    811
    812
    813
    814
    815
    816
    817
    818
    819
    820
    821
    822
    823
    824
    825
    826
    827
    828
    829
    830
    831
    832
    833
    834
    835
    836
    837
    838
    839
    840
    841
    842
    843
    844
    845
    846
    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    884
    885
    886
    887
    888
    889
    890
    891
    892
    893
    894
    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    909
    910
    911
    912
    913
    914
    915
    916
    917
    918
    919
    920
    921
    922
    923
    924
    925
    926
    927
    928
    929
    930
    931
    932
    933
    934
    935
    936
    937
    938
    939
    940
    941
    942
    943
    944
    945
    946
    947
    948
    949
    950
    951
    952
    953
    954
    955
    956
    957
    958
    959
    960
    961
    962
    963
    964
    965
    966
    967
    968
    969
    970
    971
    972
    973
    974

     /**
     * Shared types, type guards, and utility functions for the Grackle WebSocket hooks.
     *
     * @module
     */

    // ─── Domain hook lifecycle ────────────────────────────────────────────────────

    /** Lifecycle contract that every domain hook must implement. */
    export interface DomainHook {
      /** Reload data when the ConnectRPC stream connects or reconnects. */
      onConnect(): Promise<void>;
      /** Reset transient state when the stream disconnects. */
      onDisconnect(): void;
      /** Handle a domain event. Return `true` if the event was consumed. */
      handleEvent(event: GrackleEvent): boolean;
    }

    /** Connection state of the event stream. */
    export type ConnectionStatus = "connected" | "connecting" | "disconnected";

    // ─── Data interfaces ──────────────────────────────────────────────────────────

    /**
     * A provisioned environment with its current status.
     * After normalization, `adapterConfig` is always a JSON string.
     */
    export interface Environment {
      id: string;
      displayName: string;
      adapterType: string;
      adapterConfig: string;
      status: string;
      bootstrapped: boolean;
      /** ID of the GitHub account to use for gh CLI operations, or empty string for default. */
      githubAccountId: string;
    }

    /** An agent session running inside an environment. */
    export interface Session {
      id: string;
      environmentId: string;
      runtime: string;
      status: string;
      prompt: string;
      startedAt: string;
      endedAt?: string;
      error?: string;
      endReason?: string;
      personaId?: string;
      /** ID of the task this session belongs to, if any (root/orchestrated work). */
      taskId?: string;
      /**
       * ID of the parent session that spawned this one, if any. Set for IPC/spawned
       * child sessions and for materialized subagent children (#1075). Empty/absent
       * for top-level sessions. Enables parent/child navigation.
       */
      parentSessionId?: string;
      inputTokens?: number;
      outputTokens?: number;
      costMillicents?: number;
    }

    /** Aggregated usage statistics for a scope (session, task, workspace, environment). */
    export interface UsageStats {
      inputTokens: number;
      outputTokens: number;
      costMillicents: number;
      sessionCount: number;
    }

    /** A single event emitted by an agent session. */
    export interface SessionEvent {
      sessionId: string;
      eventType: string;
      timestamp: string;
      content: string;
      /** Raw JSON payload from the agent runtime (e.g. tool block with is_error flag). Optional. */
      raw?: string;
      /**
       * Stable tool-call id pairing `tool_use` with its `tool_result` (AHP HR3).
       * Preferred over the legacy per-runtime `raw` id parsing. Absent on
       * non-tool events and on events logged before HR3.
       */
      toolCallId?: string;
      /**
       * Turn this event belongs to (AHP HR2). Available for future turn-grouped
       * rendering; absent on out-of-band/liveness events and pre-HR2 logs.
       */
      turnId?: string;
      /**
       * Server-assigned ULID (`recordSessionAction()` return value, AHP HR8d).
       * Used as the canonical dedup + sort key by the UI — independent of
       * `timestamp`, which the AHP wire doesn't preserve and which the consumer
       * synthesizes at receive time. Absent on legacy WS pushes / log replays
       * predating HR8d; consumers should fall back to `${timestamp}|${eventType}`.
       */
      serverSeq?: string;
      /**
       * `true` when a `tool_result` reported a tool failure (#1362). First-class
       * outcome flag, preferred over parsing `is_ok` out of `content` or
       * `is_error` out of the legacy `raw` payload. Absent/false on success and
       * on non-tool events.
       */
      toolError?: boolean;
    }

    /** A workspace that groups tasks. */
    export interface Workspace {
      id: string;
      name: string;
      description: string;
      repoUrl: string;
      /** IDs of all environments linked to this workspace's pool. */
      linkedEnvironmentIds: string[];
      status: string;
      workingDirectory: string;
      useWorktrees: boolean;
      defaultPersonaId: string;
      /** Total token cap across all tasks; 0 = unlimited. */
      tokenBudget: number;
      /** Cost cap in millicents across all tasks; 0 = unlimited. */
      costBudgetMillicents: number;
      createdAt: string;
      updatedAt: string;
    }

    /** A task within a workspace (or workspace-less for the root task). */
    export interface TaskData {
      id: string;
      /** Workspace this task belongs to, or empty/undefined for workspace-less tasks (e.g. root task). */
      workspaceId: string | undefined;
      title: string;
      description: string;
      status: string;
      branch: string;
      latestSessionId: string;
      dependsOn: string[];
      /** @deprecated Removed — notes are now passed via StartTask. */
      reviewNotes?: string;
      sortOrder: number;
      createdAt: string;
      /** @deprecated Removed. */
      assignedAt?: string;
      startedAt?: string;
      completedAt?: string;
      parentTaskId: string;
      depth: number;
      childTaskIds: string[];
      canDecompose: boolean;
      /** Inject knowledge-graph context ("Related prior work" + search guidance) at spawn (#1259). */
      injectKnowledge: boolean;
      defaultPersonaId: string;
      workpad: string;
      /** Total token cap (input + output); 0 = unlimited. */
      tokenBudget: number;
      /** Cost cap in millicents ($0.00001 units); 0 = unlimited. */
      costBudgetMillicents: number;
    }

    /** Metadata about a stored token. */
    export interface TokenInfo {
      name: string;
      tokenType: string;
      envVar: string;
      filePath: string;
      expiresAt: string;
    }

    /** Configuration for which credential providers are enabled. */
    export interface CredentialProviderConfig {
      claude: "off" | "subscription" | "api_key";
      github: "off" | "on";
      copilot: "off" | "on";
      codex: "off" | "on";
      goose: "off" | "on";
    }

    /** A GitHub Codespace returned from `gh codespace list`. */
    export interface Codespace {
      name: string;
      repository: string;
      state: string;
      gitStatus: string;
    }

    /** A running Docker container an environment can attach to (`docker ps`). */
    export interface DockerContainer {
      id: string;
      name: string;
      image: string;
      state: string;
      status: string;
    }

    /** An agent or script persona configuration. */
    export interface PersonaData {
      id: string;
      name: string;
      description: string;
      systemPrompt: string;
      toolConfig: string;
      runtime: string;
      model: string;
      maxTurns: number;
      mcpServers: string;
      createdAt: string;
      updatedAt: string;
      type: string;
      script: string;
      allowedMcpTools: string[];
    }

    /** Provisioning progress state for a single environment. */
    export interface ProvisionStatus {
      stage: string;
      message: string;
      progress: number;
    }

    /** A domain event emitted by the server event bus and forwarded over WebSocket. */
    export interface GrackleEvent {
      /** ULID — chronologically sortable unique identifier. */
      id: string;
      /** Dot-notation event type (e.g. "task.created"). */
      type: string;
      /** ISO 8601 timestamp. */
      timestamp: string;
      /** Domain-specific payload. */
      payload: Record<string, unknown>;
    }

    /** A parsed WebSocket message with a string type and optional payload. */
    export interface WsMessage {
      type: string;
      payload?: Record<string, unknown>;
    }

    /** Function signature for sending a WebSocket message. */
    export type SendFunction = (msg: WsMessage) => void;

    // ─── Domain hook result types ─────────────────────────────────────────────────

    /** Values returned by the environments domain hook. */
    export interface UseEnvironmentsResult {
      /** All known environments. */
      environments: Environment[];
      /** Whether the environment list is currently being loaded. */
      environmentsLoading: boolean;
      /** Per-environment provisioning progress. */
      provisionStatus: Record<string, ProvisionStatus>;
      /** Request the current environment list from the server. */
      loadEnvironments: () => Promise<void>;
      /** Add a new environment. */
      addEnvironment: (
        displayName: string,
        adapterType: string,
        adapterConfig?: Record<string, unknown>,
        githubAccountId?: string,
      ) => Promise<void>;
      /** Update an existing environment's mutable fields. */
      updateEnvironment: (
        environmentId: string,
        fields: {
          displayName?: string;
          adapterConfig?: Record<string, unknown>;
          githubAccountId?: string;
        },
      ) => Promise<void>;
      /** Provision an environment by ID. When force is true, kills active sessions and forces full provision. */
      provisionEnvironment: (environmentId: string, force?: boolean) => Promise<void>;
      /** Stop an environment by ID. */
      stopEnvironment: (environmentId: string) => Promise<void>;
      /** Remove an environment by ID. */
      removeEnvironment: (environmentId: string) => Promise<void>;
      /** The last operation error message, or empty string if none. */
      operationError: string;
      /** Clear the current operation error. */
      clearOperationError: () => void;
      /** Handle a domain event from the event bus. Returns `true` if handled. */
      handleEvent: (event: GrackleEvent) => boolean;
      /** Handle legacy WS messages injected by E2E tests. */
      handleLegacyMessage?: (msg: WsMessage) => boolean;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    /** Values returned by the sessions domain hook. */
    export interface UseSessionsResult {
      /** All known sessions. */
      sessions: Session[];
      /** Whether the session list is currently being loaded. */
      sessionsLoading: boolean;
      /** Session events currently loaded in memory. */
      events: SessionEvent[];
      /** The total number of events dropped due to the MAX_EVENTS cap. */
      eventsDropped: number;
      /** The ID of the most recently spawned session, or `undefined`. */
      lastSpawnedId: string | undefined;
      /** Sessions grouped by task ID. */
      taskSessions: Record<string, Session[]>;
      /** Refresh the session list from the server. */
      loadSessions: () => Promise<void>;
      /** Spawn a new session in an environment. */
      spawn: (
        environmentId: string,
        prompt: string,
        personaId?: string,
        workingDirectory?: string,
        workspaceId?: string,
      ) => Promise<void>;
      /** Send text input to a running session. */
      sendInput: (sessionId: string, text: string) => Promise<void>;
      /** Kill a running session (hard kill / SIGKILL). */
      kill: (sessionId: string) => Promise<void>;
      /** Gracefully stop a running session (SIGTERM). */
      stopGraceful: (sessionId: string) => Promise<void>;
      /** Load stored events for a session from the server. */
      loadSessionEvents: (sessionId: string) => Promise<void>;
      /** Clear all in-memory events and reset the drop counter. */
      clearEvents: () => void;
      /** Load sessions associated with a task. */
      loadTaskSessions: (taskId: string) => Promise<void>;
      /**
       * Handle an incoming WebSocket message. Returns `true` if handled.
       * @deprecated Use handleSessionEvent for ConnectRPC streaming.
       */
      handleMessage: (msg: WsMessage) => boolean;
      /** Handle a session event from the ConnectRPC StreamEvents RPC. */
      handleSessionEvent: (event: SessionEvent) => void;
      /** Handle legacy WS messages injected by E2E tests. */
      handleLegacyMessage?: (msg: WsMessage) => boolean;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    /** Values returned by the workspaces domain hook. */
    export interface UseWorkspacesResult {
      /** All known workspaces. */
      workspaces: Workspace[];
      /** Whether the workspace list is currently being loaded. */
      workspacesLoading: boolean;
      /** Whether a workspace creation is currently in progress. */
      workspaceCreating: boolean;
      /** Request the current workspace list from the server. */
      loadWorkspaces: () => Promise<void>;
      /** Create a new workspace. */
      createWorkspace: (
        name: string,
        description?: string,
        repoUrl?: string,
        environmentId?: string,
        defaultPersonaId?: string,
        useWorktrees?: boolean,
        workingDirectory?: string,
        onSuccess?: (workspace: Workspace) => void,
        onError?: (message: string) => void,
      ) => Promise<void>;
      /** Archive a workspace by ID. */
      archiveWorkspace: (workspaceId: string) => Promise<void>;
      /** Update fields on an existing workspace. */
      updateWorkspace: (
        workspaceId: string,
        fields: {
          name?: string;
          description?: string;
          repoUrl?: string;
          workingDirectory?: string;
          useWorktrees?: boolean;
          defaultPersonaId?: string;
        },
      ) => Promise<void>;
      /** Link an additional environment to a workspace's pool. */
      linkEnvironment: (workspaceId: string, environmentId: string) => Promise<void>;
      /** Remove a linked environment from a workspace's pool. */
      unlinkEnvironment: (workspaceId: string, environmentId: string) => Promise<void>;
      /** The last link/unlink operation error message, or empty string if none. */
      linkOperationError: string;
      /** Clear the current link/unlink operation error. */
      clearLinkOperationError: () => void;
      /** Handle a domain event from the event bus. Returns `true` if handled. */
      handleEvent: (event: GrackleEvent) => boolean;
      /** Reset transient state on disconnect. */
      onDisconnect: () => void;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    /** Values returned by the tasks domain hook. */
    export interface UseTasksResult {
      /** All known tasks (may span multiple workspaces). */
      tasks: TaskData[];
      /** Whether the task list is currently being loaded. */
      tasksLoading: boolean;
      /** The ID of the task currently being started, or `undefined`. */
      taskStartingId: string | undefined;
      /** Load tasks for a given workspace. */
      loadTasks: (workspaceId: string) => Promise<void>;
      /** Load all tasks across all workspaces. */
      loadAllTasks: () => Promise<void>;
      /** Create a new task in a workspace. */
      createTask: (
        workspaceId: string,
        title: string,
        description?: string,
        dependsOn?: string[],
        parentTaskId?: string,
        defaultPersonaId?: string,
        canDecompose?: boolean,
        injectKnowledge?: boolean,
        onSuccess?: () => void,
        onError?: (message: string) => void,
      ) => Promise<void>;
      /** Start a task, optionally specifying runtime parameters. */
      startTask: (
        taskId: string,
        personaId?: string,
        environmentId?: string,
        notes?: string,
      ) => Promise<void>;
      /** Stop a task: kill active sessions + mark complete. */
      stopTask: (taskId: string) => Promise<void>;
      /** Mark a task as completed. */
      completeTask: (taskId: string) => Promise<void>;
      /** Resume a paused/waiting task. */
      resumeTask: (taskId: string) => Promise<void>;
      /** Update a task's title, description, dependencies, and default persona. */
      updateTask: (
        taskId: string,
        title: string,
        description: string,
        dependsOn: string[],
        defaultPersonaId?: string,
      ) => Promise<void>;
      /** Delete a task by ID. */
      deleteTask: (taskId: string) => Promise<void>;
      /** Handle a domain event from the event bus. Returns `true` if handled. */
      handleEvent: (event: GrackleEvent) => boolean;
      /** Reset transient state on disconnect. */
      onDisconnect: () => void;
      /** Handle legacy WS messages injected by E2E tests. */
      handleLegacyMessage?: (msg: WsMessage) => boolean;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    /** Values returned by the tokens domain hook. */
    export interface UseTokensResult {
      /** All known tokens. */
      tokens: TokenInfo[];
      /** Whether the token list is currently being loaded. */
      tokensLoading: boolean;
      /** Request the current token list from the server. */
      loadTokens: () => Promise<void>;
      /** Create or update a token on the server. */
      setToken: (
        name: string,
        value: string,
        tokenType: string,
        envVar: string,
        filePath: string,
      ) => Promise<void>;
      /** Delete a token by name. */
      deleteToken: (name: string) => Promise<void>;
      /** Handle a domain event from the event bus. Returns `true` if handled. */
      handleEvent: (event: GrackleEvent) => boolean;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    /** Values returned by the credentials domain hook. */
    export interface UseCredentialsResult {
      /** Current credential provider configuration. */
      credentialProviders: CredentialProviderConfig;
      /** Whether the credential configuration is currently being loaded. */
      credentialsLoading: boolean;
      /** Request the current credential provider configuration from the server. */
      loadCredentials: () => Promise<void>;
      /** Update the credential provider configuration on the server. */
      updateCredentialProviders: (config: CredentialProviderConfig) => Promise<void>;
      /** Handle a domain event from the event bus. Returns `true` if handled. */
      handleEvent: (event: GrackleEvent) => boolean;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    /** Values returned by the codespaces domain hook. */
    export interface UseCodespacesResult {
      /** All known codespaces. */
      codespaces: Codespace[];
      /** Error message from the most recent create attempt, or empty string. */
      codespaceError: string;
      /** Error message from the most recent list attempt, or empty string. */
      codespaceListError: string;
      /** Whether a codespace creation is currently in progress. */
      codespaceCreating: boolean;
      /** Request the current codespace list from the server, optionally filtered to a GitHub account. */
      listCodespaces: (githubAccountId?: string) => Promise<void>;
      /** Create a new codespace for the given repo. */
      createCodespace: (repo: string, machine?: string) => Promise<void>;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    /** Values returned by the docker-containers domain hook. */
    export interface UseDockerContainersResult {
      /** Running Docker containers available to attach to. */
      dockerContainers: DockerContainer[];
      /** Error message from the most recent list attempt, or empty string. */
      dockerContainersError: string;
      /** Request the current running-container list from the server. */
      listDockerContainers: () => Promise<void>;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    /** Values returned by the personas domain hook. */
    export interface UsePersonasResult {
      /** All known personas. */
      personas: PersonaData[];
      /** Whether the persona list is currently being loaded. */
      personasLoading: boolean;
      /** Request the current persona list from the server. */
      loadPersonas: () => Promise<void>;
      /** Create a new persona. */
      createPersona: (
        name: string,
        description: string,
        systemPrompt: string,
        runtime?: string,
        model?: string,
        maxTurns?: number,
        type?: string,
        script?: string,
        allowedMcpTools?: string[],
      ) => Promise<PersonaData>;
      /** Update an existing persona. */
      updatePersona: (
        personaId: string,
        name?: string,
        description?: string,
        systemPrompt?: string,
        runtime?: string,
        model?: string,
        maxTurns?: number,
        type?: string,
        script?: string,
        allowedMcpTools?: string[],
      ) => Promise<PersonaData>;
      /** Delete a persona by ID. */
      deletePersona: (personaId: string) => Promise<void>;
      /** Handle a domain event from the event bus. Returns `true` if handled. */
      handleEvent: (event: GrackleEvent) => boolean;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    /** A cron schedule entry. */
    export interface ScheduleData {
      id: string;
      title: string;
      description: string;
      scheduleExpression: string;
      personaId: string;
      workspaceId: string;
      parentTaskId: string;
      enabled: boolean;
      lastRunAt: string;
      nextRunAt: string;
      runCount: number;
      createdAt: string;
      updatedAt: string;
    }

    /** Fields that can be updated on an existing schedule. */
    export interface ScheduleUpdate {
      title?: string;
      description?: string;
      scheduleExpression?: string;
      personaId?: string;
      enabled?: boolean;
    }

    /** Values returned by the schedules domain hook. */
    export interface UseSchedulesResult {
      /** All known schedules. */
      schedules: ScheduleData[];
      /** Whether the schedule list is currently being loaded. */
      schedulesLoading: boolean;
      /** Request the current schedule list from the server. */
      loadSchedules: () => Promise<void>;
      /** Create a new schedule. */
      createSchedule: (
        title: string,
        description: string,
        scheduleExpression: string,
        personaId: string,
        workspaceId?: string,
        parentTaskId?: string,
      ) => Promise<ScheduleData>;
      /** Update an existing schedule. */
      updateSchedule: (scheduleId: string, fields: ScheduleUpdate) => Promise<ScheduleData>;
      /** Delete a schedule by ID. */
      deleteSchedule: (scheduleId: string) => Promise<void>;
      /** Handle a domain event from the event bus. Returns `true` if handled. */
      handleEvent: (event: GrackleEvent) => boolean;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    // ─── Streams hook result ─────────────────────────────────────────────────────

    /** A subscriber on an IPC stream. */
    export interface StreamSubscriberData {
      /** Unique subscription identifier. */
      subscriptionId: string;
      /** ID of the session holding this subscription. */
      sessionId: string;
      /** File descriptor number assigned to the subscriber. */
      fd: number;
      /** Access permission: "r", "w", or "rw". */
      permission: string;
      /** Delivery mode: "sync", "async", or "detach". */
      deliveryMode: string;
      /** True if this subscription was created via spawn (not attachStream). */
      createdBySpawn: boolean;
    }

    /** An IPC stream with subscriber details. */
    export interface StreamData {
      /** Opaque stream identifier. */
      id: string;
      /** Human-readable stream name. */
      name: string;
      /** Number of active subscribers. */
      subscriberCount: number;
      /** Number of messages currently buffered. */
      messageBufferDepth: number;
      /** Full subscriber details. */
      subscribers: StreamSubscriberData[];
      /** Whether publishers receive their own messages echoed back (marks a chatroom). */
      selfEcho: boolean;
    }

    /** A single message in an IPC stream room transcript (RFC #1264 Phase 2). */
    export interface StreamMessageData {
      /** The stream (room) this message belongs to. */
      streamId: string;
      /** ULID transcript sequence key (monotonic per stream, ascending = chronological). */
      seq: string;
      /** Session id of the sender. */
      senderId: string;
      /** Message content. */
      content: string;
      /** ISO 8601 timestamp. */
      timestamp: string;
    }

    /** Values returned by the streams domain hook. */
    export interface UseStreamsResult {
      /** All known IPC streams. */
      streams: StreamData[];
      /** Whether the stream list is currently being loaded. */
      streamsLoading: boolean;
      /** True after at least one loadStreams attempt has completed (success or error). */
      streamsLoadedOnce: boolean;
      /** True if the most recent loadStreams call failed (e.g. RPC/network error). */
      streamsLoadError: boolean;
      /**
       * Request the current stream list from the server. Pass `includeInternal`
       * to surface internal IPC plumbing (lifecycle/pipe/stdin); defaults to false.
       */
      loadStreams: (includeInternal?: boolean) => Promise<void>;
      /** Transcript buffer keyed by stream id (scrollback + live, deduped by seq, ascending). */
      liveMessages: Record<string, StreamMessageData[]>;
      /** Fetch a stream's durable transcript (scrollback) and merge it into the buffer. */
      loadTranscript: (streamId: string, beforeSeq?: string) => Promise<void>;
      /** Append a live stream message to the per-stream buffer. */
      handleStreamMessage: (message: StreamMessageData) => void;
      /** Handle a domain event from the event bus. Returns `true` if handled. */
      handleEvent: (event: GrackleEvent) => boolean;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    // ─── Knowledge hook result ────────────────────────────────────────────────────

    /**
     * Reason the knowledge graph failed to load.
     *
     * - `"unavailable"` — the knowledge server (Neo4j) is not running or is
     *   unreachable (the RPC returned gRPC `Unavailable`). Surfaced to the user as
     *   a "knowledge server can't be reached" state.
     * - `"error"` — any other failure (malformed response, unexpected status).
     */
    export type KnowledgeLoadError = "unavailable" | "error";

    /** Result returned by useKnowledge. */
    export interface UseKnowledgeResult {
      graphData: { nodes: GraphNode[]; links: GraphLink[] };
      selectedNode: NodeDetail | undefined;
      /** Currently selected node ID. */
      selectedId: string | undefined;
      loading: boolean;
      /** Set when the most recent graph load failed; `undefined` when it succeeded. */
      loadError: KnowledgeLoadError | undefined;
      searchQuery: string;
      search(query: string): Promise<void>;
      clearSearch(): void;
      selectNode(id: string): Promise<void>;
      clearSelection(): void;
      expandNode(id: string): Promise<void>;
      loadRecent(workspaceId?: string): Promise<void>;
      /** Handle domain events from the event bus. Returns true if handled. */
      handleEvent(event: GrackleEvent): boolean;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    // ─── Runtime type guards ──────────────────────────────────────────────────────

    /** Returns true when `v` is a non-null, non-array object. */
    export function isObject(v: unknown): v is Record<string, unknown> {
      return typeof v === "object" && v !== null && !Array.isArray(v);
    }

    /**
     * Emit a console warning and return `false` when an incoming payload does not
     * match the expected shape.  We warn rather than throw so a single bad message
     * from the server does not crash the entire UI.
     */
    export function warnBadPayload(msgType: string, reason: string): false {
      console.warn(`[ws] Malformed "${msgType}" message: ${reason}`);
      return false;
    }

    /** Type guard for {@link GrackleEvent}. */
    export function isGrackleEvent(v: unknown): v is GrackleEvent {
      return (
        isObject(v) &&
        typeof v.id === "string" &&
        typeof v.type === "string" &&
        typeof v.timestamp === "string" &&
        isObject(v.payload)
      );
    }

    /** Type guard for {@link SessionEvent}. */
    export function isSessionEvent(v: unknown): v is SessionEvent {
      return (
        isObject(v) &&
        typeof v.sessionId === "string" &&
        typeof v.eventType === "string" &&
        typeof v.timestamp === "string" &&
        typeof v.content === "string" &&
        (v.raw === undefined || typeof v.raw === "string") &&
        (v.toolCallId === undefined || typeof v.toolCallId === "string") &&
        (v.turnId === undefined || typeof v.turnId === "string") &&
        (v.serverSeq === undefined || typeof v.serverSeq === "string")
      );
    }

    /** Valid values for the `claude` credential provider mode. */
    const VALID_CLAUDE_MODES: ReadonlySet<string> = new Set(["off", "subscription", "api_key"]);
    /** Valid values for toggle-style credential provider modes. */
    const VALID_TOGGLE_MODES: ReadonlySet<string> = new Set(["off", "on"]);

    /** Type guard for {@link CredentialProviderConfig}. */
    export function isCredentialProviderConfig(v: unknown): v is CredentialProviderConfig {
      return (
        isObject(v) &&
        VALID_CLAUDE_MODES.has(v.claude as string) &&
        VALID_TOGGLE_MODES.has(v.github as string) &&
        VALID_TOGGLE_MODES.has(v.copilot as string) &&
        VALID_TOGGLE_MODES.has(v.codex as string) &&
        VALID_TOGGLE_MODES.has(v.goose as string)
      );
    }

    // ─── Utility functions ────────────────────────────────────────────────────────

    /**
     * Parse a raw WebSocket message string into a {@link WsMessage} or
     * {@link GrackleEvent}.  When both `id` and `timestamp` are present the
     * result is a full `GrackleEvent`; otherwise a plain `WsMessage`.
     * Returns `undefined` and logs a warning if parsing fails or the result is
     * not a valid message object.
     */
    export function parseWsMessage(data: string): WsMessage | GrackleEvent | undefined {
      let parsed: unknown;
      try {
        parsed = JSON.parse(data) as unknown;
      } catch {
        console.warn("[ws] Failed to parse WebSocket message as JSON");
        return undefined;
      }
      if (!isObject(parsed) || typeof parsed.type !== "string") {
        console.warn("[ws] Received WebSocket message without a string 'type' field:", parsed);
        return undefined;
      }
      // When both id and timestamp are present, return a full GrackleEvent
      if (typeof parsed.id === "string" && typeof parsed.timestamp === "string") {
        return {
          id: parsed.id,
          type: parsed.type,
          timestamp: parsed.timestamp,
          payload: isObject(parsed.payload) ? parsed.payload : {},
        };
      }
      return {
        type: parsed.type,
        payload: isObject(parsed.payload) ? parsed.payload : undefined,
      };
    }

    /**
     * Map runtime status event content to normalized session status strings.
     * The PowerLine runtime emits "waiting_input" as event content, but the
     * server stores "idle". Terminal statuses ("completed", "killed", "failed",
     * "interrupted", "terminated") all map to "stopped". The frontend needs to
     * use the same strings as the server for consistency with list_sessions responses.
     */
    export function mapSessionStatus(rawStatus: string): string {
      switch (rawStatus) {
        case "waiting_input":
          return "idle";
        case "completed":
          return "stopped";
        case "killed":
          return "stopped";
        case "failed":
          return "stopped";
        case "interrupted":
          return "stopped";
        case "terminated":
          return "stopped";
        default:
          return rawStatus;
      }
    }

    /**
     * Map a raw PowerLine event content string to an endReason value,
     * or undefined for non-terminal events.
     */
    export function mapEndReason(rawContent: string): string | undefined {
      switch (rawContent) {
        case "completed":
          return "completed";
        case "killed":
          return "killed";
        case "failed":
          return "interrupted";
        case "interrupted":
          return "interrupted";
        case "terminated":
          return "terminated";
        default:
          return undefined;
      }
    }

    // ─── Constants ────────────────────────────────────────────────────────────────

    // ─── Knowledge graph types ───────────────────────────────────────────────────

    /** A node in the force graph. */
    export interface GraphNode {
      id: string;
      label: string;
      kind: string;
      category?: string;
      sourceType?: string;
      sourceId?: string;
      content?: string;
      tags?: string[];
      workspaceId?: string;
      createdAt?: string;
      updatedAt?: string;
      /** Node size (edge count). */
      val: number;
    }

    /** A link in the force graph. */
    export interface GraphLink {
      source: string;
      target: string;
      type: string;
    }

    /** Full detail for a selected node. */
    export interface NodeDetail {
      node: GraphNode;
      edges: Array<{ fromId: string; toId: string; type: string; metadata?: Record<string, unknown> }>;
    }

    // ─── Constants ────────────────────────────────────────────────────────────────

    // ─── Plugins ─────────────────────────────────────────────────────────────────

    /** Metadata for a Grackle plugin. */
    export interface PluginData {
      /** Plugin identifier (e.g. "core", "orchestration"). */
      name: string;
      /** Human-readable description. */
      description: string;
      /** DB-persisted desired enabled state. */
      enabled: boolean;
      /** True for the core plugin — cannot be disabled. */
      required: boolean;
      /** Whether the plugin is currently running in this server instance. */
      loaded: boolean;
    }

    /** Values returned by the plugins domain hook. */
    export interface UsePluginsResult {
      /** All known plugins. */
      plugins: PluginData[];
      /** Whether the plugin list is currently loading. */
      pluginsLoading: boolean;
      /** Request the current plugin list from the server. */
      loadPlugins: () => Promise<void>;
      /** Enable or disable a plugin by name. */
      setPluginEnabled: (name: string, enabled: boolean) => Promise<void>;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    /** A registered GitHub account (token is never returned by the server). */
    export interface GitHubAccountData {
      id: string;
      label: string;
      username: string;
      isDefault: boolean;
      createdAt: string;
    }

    /** Values returned by the GitHub accounts domain hook. */
    export interface UseGitHubAccountsResult {
      /** All registered GitHub accounts. */
      githubAccounts: GitHubAccountData[];
      /** Whether the account list is currently loading. */
      githubAccountsLoading: boolean;
      /** Refresh the account list from the server. */
      loadGitHubAccounts: () => Promise<void>;
      /** Register a new GitHub account. */
      addGitHubAccount: (
        label: string,
        token: string,
        username: string,
        isDefault: boolean,
      ) => Promise<void>;
      /** Update an existing GitHub account. */
      updateGitHubAccount: (
        id: string,
        fields: { label?: string; token?: string; isDefault?: boolean },
      ) => Promise<void>;
      /** Remove a GitHub account by ID. */
      removeGitHubAccount: (id: string) => Promise<void>;
      /** Import accounts from the local gh CLI authentication state. */
      importGitHubAccounts: () => Promise<{ imported: number; usernames: string[] }>;
      /** Lifecycle hook for connect/disconnect/event routing. */
      domainHook: DomainHook;
    }

    /** Delay in milliseconds before attempting a WebSocket reconnect. */
    export const WS_RECONNECT_DELAY_MS: number = 3_000;

    /** Maximum number of events kept in memory per hook instance. Older events are dropped. */
    export const MAX_EVENTS: number = 5_000;

    /** WebSocket close code indicating an unauthorized connection. */
    export const WS_CLOSE_UNAUTHORIZED: number = 4001;