opencode-summary 0.0.0-stage → 0.1.1

package/package.json

@@ -1,6 +1,62 @@
 {
   "name": "opencode-summary",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "opencode TUI plugin: generate and view a summary of the current session",
+  "license": "MIT",
+  "type": "module",
+  "author": "frostehhh",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/frostehhh/opencode-summary.git"
+  },
+  "bugs": {
+    "url": "https://github.com/frostehhh/opencode-summary/issues"
+  },
+  "homepage": "https://github.com/frostehhh/opencode-summary#readme",
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "tui",
+    "summary"
+  ],
+  "exports": {
+    "./tui": "./dist/tui.js"
+  },
+  "files": [
+    "dist",
+    "src",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "bun scripts/build.ts",
+    "test": "bun test",
+    "prepublishOnly": "bun run build && bun test",
+    "prepare": "husky"
+  },
+  "peerDependencies": {
+    "@opentui/core": "",
+    "@opentui/solid": "",
+    "solid-js": ""
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^21.2.4",
+    "@commitlint/config-conventional": "^21.2.4",
+    "@opencode/plugin": "^2.2.6",
+    "@opentui/core": "^0.8.3",
+    "@opentui/solid": "^0.8.3",
+    "husky": "^9.1.7",
+    "solid-js": "^1.9.18"
+  },
+  "peerDependenciesMeta": {
+    "@opentui/core": {
+      "optional": true
+    },
+    "@opentui/solid": {
+      "optional": true
+    },
+    "solid-js": {
+      "optional": true
+    }
+  }
+}

package/src/lib.ts

@@ -0,0 +1,135 @@
+import path from "node:path"
+import { DEFAULT_PROMPT, GUARD } from "./prompt"
+
+export const METADATA_KEY = "opencode-summary"
+export type Metadata = Record<string, unknown>
+export type SummaryRecord = { text: string; generatedAt: number; promptId: string; lastMessageID: string }
+
+export const buildRequest = (prompt: string) => `${GUARD}\n\n${prompt}`
+
+/** FNV-1a 32-bit, hex. Stable id for "generated with a different prompt". */
+export function promptId(text: string): string {
+  let hash = 0x811c9dc5
+  for (let i = 0; i < text.length; i++) hash = Math.imul(hash ^ text.charCodeAt(i), 0x01000193) >>> 0
+  return hash.toString(16).padStart(8, "0")
+}
+
+export function readSummary(metadata: unknown): SummaryRecord | undefined {
+  if (!metadata || typeof metadata !== "object") return undefined
+  const value = (metadata as Metadata)[METADATA_KEY]
+  if (!value || typeof value !== "object") return undefined
+  const { text, generatedAt, promptId, lastMessageID } = value as Record<string, unknown>
+  if (typeof text !== "string" || typeof generatedAt !== "number") return undefined
+  if (typeof promptId !== "string" || typeof lastMessageID !== "string") return undefined
+  return { text, generatedAt, promptId, lastMessageID }
+}
+
+export const withSummary = (metadata: Metadata | undefined, record: SummaryRecord): Metadata => ({
+  ...metadata,
+  [METADATA_KEY]: record,
+})
+
+export function withoutSummary(metadata: Metadata | undefined): Metadata {
+  const { [METADATA_KEY]: _removed, ...rest } = metadata ?? {}
+  return rest
+}
+
+export const isBlank = (text: string | undefined) => !text || text.trim() === ""
+
+/** Copy of tui/src/component/dialog-stash.tsx getRelativeTime; undefined at 7+ days. */
+export function relativeTime(ts: number, now: number): string | undefined {
+  const s = Math.floor((now - ts) / 1000)
+  const m = Math.floor(s / 60)
+  const h = Math.floor(m / 60)
+  const d = Math.floor(h / 24)
+  if (s < 60) return "just now"
+  if (m < 60) return `${m}m ago`
+  if (h < 24) return `${h}h ago`
+  if (d < 7) return `${d}d ago`
+  return undefined
+}
+
+/** Copy of tui/src/util/locale.ts datetime: "<time> · <date>". */
+export function datetime(ts: number): string {
+  const date = new Date(ts)
+  return `${date.toLocaleTimeString(undefined, { timeStyle: "short" })} · ${date.toLocaleDateString()}`
+}
+
+export const TURN_LIMIT = 200
+export const GENERATE_TIMEOUT_MS = 180_000
+export type Turns = { count: number; capped: boolean }
+
+/** `userMessageIDs` = one page of user messages (newest first, at most `limit`). IDs sort as strings. */
+export function turnsSince(userMessageIDs: readonly string[], lastMessageID: string, limit = TURN_LIMIT): Turns {
+  const count = userMessageIDs.filter((id) => id > lastMessageID).length
+  return { count, capped: userMessageIDs.length >= limit && count >= limit }
+}
+
+export function turnsText({ count, capped }: Turns): string {
+  if (capped) return `${TURN_LIMIT}+ turns ago`
+  if (count === 0) return "up to date"
+  return count === 1 ? "1 turn ago" : `${count} turns ago`
+}
+
+export const turnLabel = (turns: Turns) => `summary ${turnsText(turns)}`
+
+export function generatedLine(record: SummaryRecord, now: number, turns?: Turns): string {
+  const relative = relativeTime(record.generatedAt, now)
+  const parts = ["Generated", ...(relative ? [`${relative} ·`] : []), datetime(record.generatedAt)]
+  return turns ? `${parts.join(" ")} · ${turnsText(turns)}` : parts.join(" ")
+}
+
+export function errorMessage(cause: unknown): string {
+  if (cause instanceof Error && cause.message) return cause.message
+  return typeof cause === "string" && cause ? cause : "Unknown error"
+}
+
+export type BlockReason = "running" | "in-flight"
+
+export function blockReason(input: { status: "idle" | "running"; inFlight: boolean }): BlockReason | undefined {
+  if (input.inFlight) return "in-flight"
+  if (input.status === "running") return "running"
+  return undefined
+}
+
+/** Newest visible message id. `idsDesc` is newest first; a staged revert hides ids >= `revertBoundary`. */
+export function lastVisibleID(idsDesc: readonly string[], revertBoundary?: string): string | undefined {
+  return revertBoundary === undefined ? idsDesc[0] : idsDesc.find((id) => id < revertBoundary)
+}
+
+export function blockMessage(reason: BlockReason): string {
+  switch (reason) {
+    case "in-flight":
+      return "Already generating"
+    case "running":
+      return "Agent is running - wait for it to finish"
+  }
+}
+
+export function isMessageNotFound(error: unknown): boolean {
+  if (!error || typeof error !== "object") return false
+  const { _tag, name } = error as { _tag?: unknown; name?: unknown }
+  return _tag === "MessageNotFoundError" || name === "MessageNotFoundError"
+}
+
+export type ValidityCheck = { found: true } | { found: false; notFound: boolean }
+export const validityAction = (check: ValidityCheck): "keep" | "delete" =>
+  !check.found && check.notFound ? "delete" : "keep"
+
+export type PromptSource = "default" | "override"
+export type ResolvedPrompt = { text: string; source: PromptSource }
+
+export const resolvePrompt = (override: string | undefined): ResolvedPrompt =>
+  isBlank(override) ? { text: DEFAULT_PROMPT, source: "default" } : { text: override!.trim(), source: "override" }
+
+export function saveAction(edited: string): "noop" | "delete" | "write" {
+  if (isBlank(edited)) return "noop"
+  return edited.trim() === DEFAULT_PROMPT.trim() ? "delete" : "write"
+}
+
+/** User-level prompt override location: `<config home>/opencode/opencode-summary/summary.md`. */
+export function promptPaths(env: { XDG_CONFIG_HOME?: string }, home: string): { dir: string; override: string } {
+  const base = env.XDG_CONFIG_HOME?.trim() || path.join(home, ".config")
+  const dir = path.join(base, "opencode", "opencode-summary")
+  return { dir, override: path.join(dir, "summary.md") }
+}

package/src/prompt.ts

@@ -0,0 +1,12 @@
+export const GUARD = "Do not call any tools and do not take any actions."
+
+export const DEFAULT_PROMPT = `Summarize the conversation so far for the user.
+Output markdown only, no preamble, about 300 words or less. Use exactly these sections, bullets only below TL;DR; omit a section if empty:
+
+## TL;DR
+2-3 sentences.
+## Goal
+## Decisions
+## Progress / current state
+## Open questions / next steps
+## Key files and references`