dsh-git-ui 0.0.1

package/src/host/types.ts

@@ -0,0 +1,74 @@
+/**
+ * dsh-git-ui host data model. This file is the authoritative type source;
+ * the client half mirrors it with zod schemas (see src/client/remote.ts) and
+ * `tests/remote.spec.ts` keeps the two in sync.
+ */
+
+/** Wire request: the browser never sends paths — only the session identity. */
+export interface GitSnapshotRequest {
+  readonly sessionId: string
+}
+
+/** Discriminated outcome of one snapshot attempt. */
+export type GitSnapshotResult =
+  | { readonly ok: true; readonly value: GitSnapshot }
+  | { readonly ok: false; readonly error: GitSnapshotFailure }
+
+export type GitSnapshotFailure =
+  | { readonly code: 'session-not-found'; readonly sessionId: string }
+  | { readonly code: 'cwd-unavailable'; readonly sessionId: string }
+  | { readonly code: 'path-not-found'; readonly path: string }
+  | { readonly code: 'git-unavailable'; readonly detail: string }
+  | { readonly code: 'timeout' }
+  | { readonly code: 'not-a-git-repo' }
+
+/** Immutable frozen snapshot of one repository's status at `checkedAt`. */
+export interface GitSnapshot {
+  /** Realpath of the repository root (work tree top). */
+  readonly root: string
+  /** Current branch name; null when detached. */
+  readonly branch: string | null
+  /** Short HEAD hash; null when the repository has no commits (unborn). */
+  readonly head: string | null
+  /** True when the repository has no commits yet. */
+  readonly unborn: boolean
+  /** staged + modified + untracked > 0. */
+  readonly dirty: boolean
+  readonly staged: number
+  readonly modified: number
+  readonly untracked: number
+  readonly ahead: number
+  readonly behind: number
+  readonly lastCommit: GitCommit | null
+  readonly recentCommits: readonly GitCommit[]
+  readonly changes: readonly GitChange[]
+  /** True when `changes` was capped at maxChanges or status output overflowed. */
+  readonly truncated: boolean
+  /** Polling interval the client should use after this snapshot (0 = off). */
+  readonly refreshIntervalMs: number
+  /** Epoch millis of the snapshot. */
+  readonly checkedAt: number
+}
+
+export interface GitCommit {
+  readonly hash: string
+  readonly shortHash: string
+  readonly subject: string
+  readonly author: string
+  readonly dateIso: string
+}
+
+export interface GitChange {
+  readonly path: string
+  readonly status: GitChangeStatus
+  readonly staged: boolean
+}
+
+export type GitChangeStatus =
+  | 'added'
+  | 'modified'
+  | 'deleted'
+  | 'renamed'
+  | 'untracked'
+  | 'conflicted'
+  | 'typechange'