@mirrowel/opencode-openshare 0.3.0-dev.4 → 0.3.0-dev.6

package/README.md

@@ -1,8 +1,28 @@
 # Open(code)Share plugin (`@mirrowel/opencode-openshare`)
 
-The opencode side of [Open(code)Share](../README.md) — session sharing for
+The opencode side of [Open(code)Share](../README.md) - session sharing for
 OpenCode v1 and v2, self-hosted on your own worker.
 
+**This package is only the plugin.** It captures and uploads sessions, but a
+share needs a backend to upload to. OpenShare ships as four parts that
+version and release together:
+
+| Part | What it does | Where to get it |
+|---|---|---|
+| **This plugin** | hooks into opencode, syncs sessions | this npm package |
+| **Worker** | the Cloudflare backend - stores shares, serves the viewer | deploy from the repo: `share-worker/` (3-command setup, see the repo README) |
+| **Server** | self-hosted alternative to the worker - one Bun process, SQLite, Docker image | repo `share-server/` |
+| **Viewer** | the share page - ships inside the worker/server assets; nothing to install separately | repo `share-viewer/` (embedded automatically) |
+
+The repo also builds **offline snapshots** - a single self-contained HTML
+file of any share, generated by the viewer's download button or the
+`osh-snapshot` CLI - so a shared link keeps working even with no backend at
+all.
+
+Everything lives in one repository: **https://github.com/Mirrowel/openshare**
+(clone it, or browse the [README](https://github.com/Mirrowel/openshare#readme)
+for the full picture - deployment, configuration, and the viewer tour).
+
 Every plugin config key, its file chain, and the cross-package config surface are inventoried in [../CONFIGURATION.md](../CONFIGURATION.md).
 
 ## Artifacts
@@ -37,7 +57,9 @@ itself):
 opencode plugin add @mirrowel/opencode-openshare
 ```
 
-Restart opencode; `/share` and `/openshare` appear in the TUI.
+Restart opencode; `/share` and `/openshare` appear in the TUI. The
+settings dialog's title carries the running plugin's version (read from
+its own package manifest at runtime).
 
 Then configure. For an npm install the durable config file is the
 **settings home** (`~/.config/opencode/openshare.config.json` — also

package/dist/config.d.ts

@@ -62,6 +62,9 @@ export declare const DEFAULTS: ShareConfig;
 /** Directory of this module file (bundled standalone: the single file's
  * directory; package: dist/). */
 export declare function moduleDir(): string;
+/** Version of the running plugin, from the package it was loaded from.
+ *  "?" outside a package (single-file CI bundle with no sibling manifest). */
+export declare function pluginVersion(): string;
 /** Nearest ancestor (starting at `start`) containing package.json. */
 export declare function packageRoot(start: string): string;
 /** Config file search paths for a plugin living at `pluginDir`.

package/dist/config.js

@@ -51,6 +51,17 @@ const LOCAL_NAME = "openshare.local.json";
 export function moduleDir() {
     return dirname(fileURLToPath(import.meta.pathname ?? import.meta.url));
 }
+/** Version of the running plugin, from the package it was loaded from.
+ *  "?" outside a package (single-file CI bundle with no sibling manifest). */
+export function pluginVersion() {
+    try {
+        const pkg = JSON.parse(readFileSync(join(packageRoot(moduleDir()), "package.json"), "utf8"));
+        return pkg.version ?? "?";
+    }
+    catch {
+        return "?";
+    }
+}
 /** Nearest ancestor (starting at `start`) containing package.json. */
 export function packageRoot(start) {
     let current = start;

package/dist/settings.js

@@ -4,7 +4,7 @@
 // run on the v1 TUI and the v2 dialog bridge.
 //
 // Sections: Connection, Sharing, Read auth, Advanced, This session.
-import { configSourceMap, moduleDir, writeCandidates } from "./config.js";
+import { configSourceMap, moduleDir, pluginVersion, writeCandidates } from "./config.js";
 import { adminClient, adminTokenFor, currentConfig, deleteServerEntry, disconnectAtServer, enrollAtServer, fmtHours, parseTtlHours, hostOf, isConfigured, normServerUrl, probeAuthMode, probeWorker, patchSessionBinding, patchShareOpts, readBinding, readBindings, resolveRoot, rotateAtServer, runUnshareFlow, saveConfig, saveServerEntry, meClient, serverEntries, setShareOpts, shareWithConsent, workerDeleteShare, } from "./share-flow.js";
 import { DIALOG_WIDTH_COLUMNS, kvHeightPercentOf, kvWidthOf, nextDialogWidth, UI_HEIGHT_PERCENT_KV, UI_WIDTH_KV, clampHeightPercent } from "./ui-prefs.js";
 /** description suffix: `[from <source>]` when a key is overridden by a
@@ -1452,7 +1452,7 @@ export async function settingsDialog(host, startAtSession, startGroup) {
             help: group.help,
         }));
         options.push({ title: dirty ? "Save & exit" : "Exit", value: "action:exit", description: dirty ? `Write ${writeTarget.path}` : "No changes" });
-        const choice = await showSelect(host.ui, { title: "OpenShare settings", options });
+        const choice = await showSelect(host.ui, { title: `OpenShare v${pluginVersion()} · settings`, options });
         if (choice === undefined || choice === "action:exit") {
             if (dirty) {
                 const saved = saveConfig(cfg, writeTarget.path);

package/dist/tui.js

@@ -36,6 +36,14 @@ var LOCAL_NAME = "openshare.local.json";
 function moduleDir() {
   return dirname(fileURLToPath(import.meta.pathname ?? import.meta.url));
 }
+function pluginVersion() {
+  try {
+    const pkg = JSON.parse(readFileSync(join(packageRoot(moduleDir()), "package.json"), "utf8"));
+    return pkg.version ?? "?";
+  } catch {
+    return "?";
+  }
+}
 function packageRoot(start) {
   let current = start;
   for (let guard = 0;guard < 16; guard++) {
@@ -2540,7 +2548,7 @@ Stored in the host's preference store \u2014 per machine, not the config file.`
       help: group.help
     }));
     options.push({ title: dirty ? "Save & exit" : "Exit", value: "action:exit", description: dirty ? `Write ${writeTarget.path}` : "No changes" });
-    const choice = await showSelect(host.ui, { title: "OpenShare settings", options });
+    const choice = await showSelect(host.ui, { title: `OpenShare v${pluginVersion()} \xB7 settings`, options });
     if (choice === undefined || choice === "action:exit") {
       if (dirty) {
         const saved = saveConfig(cfg, writeTarget.path);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mirrowel/opencode-openshare",
-  "version": "0.3.0-dev.4",
+  "version": "0.3.0-dev.6",
   "type": "module",
   "description": "Open(code)Share — re:share: self-hosted session sharing for opencode. Server plugin (single file or package), optional TUI for interactive opt-in sharing.",
   "license": "MIT",
@@ -64,10 +64,9 @@
     "build:tui": "bun scripts/build-tui.mjs",
     "build:standalone": "bun scripts/build-standalone.mjs",
     "typecheck": "tsc --noEmit",
-    "ci": "npm run release:intent:check && npm run ci:package",
+    "ci": "npm run ci:package",
     "ci:package": "npm run typecheck && npm run build && npm run pack:dry-run",
-    "release:intent": "node scripts/set-release-intent.mjs",
-    "release:intent:check": "node scripts/check-release-intent.mjs",
+    "prepare": "node ../.github/scripts/install-hooks.mjs",
     "pack:dry-run": "node scripts/pack-dry-run.mjs",
     "test:regression": "node scripts/regression-tests.mjs",
     "prepublishOnly": "npm run typecheck && npm run build",

package/src/config.ts

@@ -115,9 +115,19 @@ export function moduleDir(): string {
   return dirname(fileURLToPath((import.meta as { pathname?: string }).pathname ?? import.meta.url))
 }
 
+/** Version of the running plugin, from the package it was loaded from.
+ *  "?" outside a package (single-file CI bundle with no sibling manifest). */
+export function pluginVersion(): string {
+  try {
+    const pkg = JSON.parse(readFileSync(join(packageRoot(moduleDir()), "package.json"), "utf8")) as { version?: string }
+    return pkg.version ?? "?"
+  } catch {
+    return "?"
+  }
+}
+
 /** Nearest ancestor (starting at `start`) containing package.json. */
-export function packageRoot(start: string): string {
-  let current = start
+export function packageRoot(start: string): string {  let current = start
   for (let guard = 0; guard < 16; guard++) {
     if (existsSync(join(current, "package.json"))) return current
     const parent = dirname(current)

package/src/settings.ts

@@ -5,7 +5,7 @@
 //
 // Sections: Connection, Sharing, Read auth, Advanced, This session.
 
-import { configSourceMap, moduleDir, writeCandidates, type ShareConfig, type WriteCandidate } from "./config.js"
+import { configSourceMap, moduleDir, pluginVersion, writeCandidates, type ShareConfig, type WriteCandidate } from "./config.js"
 import {
   adminClient,
   adminTokenFor,
@@ -1462,7 +1462,7 @@ export async function settingsDialog(host: ShareHostApi, startAtSession?: string
     }))
     options.push({ title: dirty ? "Save & exit" : "Exit", value: "action:exit", description: dirty ? `Write ${writeTarget.path}` : "No changes" })
 
-    const choice = await showSelect(host.ui, { title: "OpenShare settings", options })
+    const choice = await showSelect(host.ui, { title: `OpenShare v${pluginVersion()} · settings`, options })
     if (choice === undefined || choice === "action:exit") {
       if (dirty) {
         const saved = saveConfig(cfg, writeTarget.path)