@apicircle/core 1.0.8 → 1.1.0

package/README.md

@@ -152,6 +152,7 @@ import { loadFromFile, saveToFile, withWorkspace } from '@apicircle/core/workspa
 
 // Multi-workspace registry (registry.json + per-id subdirectories)
 import {
+  defaultApicircleRoot,
   loadRegistry,
   saveRegistry,
   loadWorkspaceById,
@@ -160,7 +161,6 @@ import {
   setActiveWorkspace,
   deleteWorkspaceById,
   findWorkspaceEntry,
-  migrateLegacyWorkspace,
   workspaceDirFor,
   type WorkspaceRegistry,
 } from '@apicircle/core/workspace/registry';
@@ -169,9 +169,9 @@ import {
 - **`/workspace/file-backed`** — one workspace, one folder. `proper-lockfile`
   advisory locking, so concurrent CLI runs don't corrupt each other.
 - **`/workspace/registry`** — many workspaces, one root. `registry.json` at
-  the top, per-id subdirectories underneath. The desktop app, CLI, and MCP
-  server all read this same shape, so an edit in one is visible to the others
-  on the next read.
+  the top, `workspaces/<id>/` subdirectories underneath. All surfaces
+  (desktop, CLI, MCP, VS Code) default to `~/.apicircle/` via
+  `defaultApicircleRoot()`.
 
 ## Use cases
 

package/dist/{chunk-L5DQT7V6.js → chunk-T6A4ICRL.js}

@@ -3,10 +3,10 @@ import { promises as fs } from "fs";
 import * as path from "path";
 import { FONT_SIZE_PERCENT_DEFAULT } from "@apicircle/shared";
 import lockfile from "proper-lockfile";
-var SYNCED_FILE = "workspace.synced.json";
+var SYNCED_FILE = "workspace.json";
 var LOCAL_FILE = "workspace.local.json";
 async function loadFromFile(dir, options = {}) {
-  const syncedPath = path.join(dir, SYNCED_FILE);
+  const syncedPath = path.join(dir, options.syncedFilename ?? SYNCED_FILE);
   const localPath = path.join(dir, LOCAL_FILE);
   let syncedRaw;
   try {
@@ -28,7 +28,7 @@ async function loadFromFile(dir, options = {}) {
 }
 async function saveToFile(dir, state, options = {}) {
   await fs.mkdir(dir, { recursive: true });
-  const syncedPath = path.join(dir, SYNCED_FILE);
+  const syncedPath = path.join(dir, options.syncedFilename ?? SYNCED_FILE);
   const localPath = path.join(dir, LOCAL_FILE);
   await ensureFile(syncedPath);
   const release = await lockfile.lock(syncedPath, {
@@ -44,7 +44,7 @@ async function saveToFile(dir, state, options = {}) {
 }
 async function withWorkspace(dir, fn, options = {}) {
   await fs.mkdir(dir, { recursive: true });
-  const syncedPath = path.join(dir, SYNCED_FILE);
+  const syncedPath = path.join(dir, options.syncedFilename ?? SYNCED_FILE);
   const localPath = path.join(dir, LOCAL_FILE);
   await ensureFile(syncedPath);
   const release = await lockfile.lock(syncedPath, {
@@ -129,4 +129,4 @@ export {
   saveToFile,
   withWorkspace
 };
-//# sourceMappingURL=chunk-L5DQT7V6.js.map
+//# sourceMappingURL=chunk-T6A4ICRL.js.map

package/dist/chunk-T6A4ICRL.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/workspace/fileBackedWorkspace.ts"],"sourcesContent":["import { promises as fs } from 'node:fs';\nimport * as path from 'node:path';\nimport { FONT_SIZE_PERCENT_DEFAULT } from '@apicircle/shared';\nimport type { WorkspaceLocal, WorkspaceSynced } from '@apicircle/shared';\nimport lockfile from 'proper-lockfile';\nimport type { WorkspaceState } from './patches';\n\n// =============================================================================\n// fileBackedWorkspace — load/save a `{ synced, local }` pair as two JSON\n// files on disk, with a `proper-lockfile` advisory lock so concurrent CLI /\n// MCP writers can't corrupt the document.\n//\n// Layout (relative to the directory passed in):\n//   workspace.json          ← matches WorkspaceSynced exactly\n//   workspace.local.json    ← WorkspaceLocal, host-private (CLI/MCP doesn't push)\n//\n// The lock is held on `workspace.json` because that's the file the\n// editor races against. Stale locks are released after 30s.\n// =============================================================================\n\nconst SYNCED_FILE = 'workspace.json';\nconst LOCAL_FILE = 'workspace.local.json';\n\nexport interface LoadFromFileOptions {\n  /** When true, return `null` instead of throwing if the synced file is missing. */\n  allowMissing?: boolean;\n  /** Override the synced filename. Defaults to `workspace.json`. */\n  syncedFilename?: string;\n}\n\nexport interface SaveToFileOptions {\n  /** Lock timeout (ms). Defaults to 30000. */\n  lockTimeoutMs?: number;\n  /** Override the synced filename. Defaults to `workspace.json`. */\n  syncedFilename?: string;\n}\n\n/**\n * Load both workspace documents from `dir`. The synced file is required;\n * the local file is optional and falls back to a minimal empty shape so a\n * CLI on a fresh machine can still operate (it just won't have history /\n * overrides until the desktop app runs once).\n */\nexport async function loadFromFile(\n  dir: string,\n  options: LoadFromFileOptions = {},\n): Promise<WorkspaceState | null> {\n  const syncedPath = path.join(dir, options.syncedFilename ?? SYNCED_FILE);\n  const localPath = path.join(dir, LOCAL_FILE);\n\n  let syncedRaw: string;\n  try {\n    syncedRaw = await fs.readFile(syncedPath, 'utf-8');\n  } catch (err) {\n    if (options.allowMissing && isENOENT(err)) return null;\n    throw err;\n  }\n  const synced = JSON.parse(syncedRaw) as WorkspaceSynced;\n\n  let local: WorkspaceLocal;\n  try {\n    local = JSON.parse(await fs.readFile(localPath, 'utf-8')) as WorkspaceLocal;\n    local = { ...local, attachmentCache: local.attachmentCache ?? {} };\n  } catch (err) {\n    if (!isENOENT(err)) throw err;\n    local = createEmptyLocalForSynced(synced);\n  }\n\n  return { synced, local };\n}\n\n/**\n * Atomically write both documents back to disk. Acquires an advisory lock\n * on the synced file for the duration of the write so a parallel CLI /\n * MCP / desktop save can't interleave.\n *\n * Both files are written via `<file>.tmp` + rename so a crash mid-write\n * never leaves a partial JSON document on disk.\n */\nexport async function saveToFile(\n  dir: string,\n  state: WorkspaceState,\n  options: SaveToFileOptions = {},\n): Promise<void> {\n  await fs.mkdir(dir, { recursive: true });\n  const syncedPath = path.join(dir, options.syncedFilename ?? SYNCED_FILE);\n  const localPath = path.join(dir, LOCAL_FILE);\n\n  // proper-lockfile requires the target file to exist. Touch it on first save.\n  await ensureFile(syncedPath);\n\n  const release = await lockfile.lock(syncedPath, {\n    retries: { retries: 5, minTimeout: 50, maxTimeout: 500 },\n    stale: options.lockTimeoutMs ?? 30000,\n  });\n  try {\n    await writeJsonAtomic(syncedPath, state.synced);\n    await writeJsonAtomic(localPath, state.local);\n  } finally {\n    await release();\n  }\n}\n\n/**\n * Run a load → mutate → save cycle under one lock so a single mutation\n * can't be clobbered by a racing reader-then-writer.\n */\nexport async function withWorkspace<T>(\n  dir: string,\n  fn: (state: WorkspaceState) => Promise<{ next: WorkspaceState; result?: T }>,\n  options: SaveToFileOptions = {},\n): Promise<T | undefined> {\n  await fs.mkdir(dir, { recursive: true });\n  const syncedPath = path.join(dir, options.syncedFilename ?? SYNCED_FILE);\n  const localPath = path.join(dir, LOCAL_FILE);\n  await ensureFile(syncedPath);\n\n  const release = await lockfile.lock(syncedPath, {\n    retries: { retries: 5, minTimeout: 50, maxTimeout: 500 },\n    stale: options.lockTimeoutMs ?? 30000,\n  });\n  try {\n    const syncedRaw = await fs.readFile(syncedPath, 'utf-8');\n    const synced = JSON.parse(syncedRaw) as WorkspaceSynced;\n    let local: WorkspaceLocal;\n    try {\n      local = JSON.parse(await fs.readFile(localPath, 'utf-8')) as WorkspaceLocal;\n      local = { ...local, attachmentCache: local.attachmentCache ?? {} };\n    } catch (err) {\n      if (!isENOENT(err)) throw err;\n      local = createEmptyLocalForSynced(synced);\n    }\n    const out = await fn({ synced, local });\n    await writeJsonAtomic(syncedPath, out.next.synced);\n    await writeJsonAtomic(localPath, out.next.local);\n    return out.result;\n  } finally {\n    await release();\n  }\n}\n\n// ---------------------------------------------------------------------------\n// internals\n// ---------------------------------------------------------------------------\n\n// File mode for workspace JSON: owner read/write only. Default `fs.writeFile`\n// uses 0o666 minus umask (typically 0o644 — world-readable). The workspace\n// docs carry the synced state (which after redaction is mostly safe to read\n// but still includes per-workspace metadata) and the local state (which\n// holds the encrypted Secret Vault payload table, session metadata, and the\n// vault entries themselves). On multi-user POSIX hosts (CI runners,\n// classroom VMs, shared dev servers) the default would leak both. 0o600\n// keeps the file owner-only. Windows ignores POSIX modes — the inherited\n// per-user ACL under %USERPROFILE% is what protects it there.\nconst WORKSPACE_FILE_MODE = 0o600;\n\nasync function ensureFile(filePath: string): Promise<void> {\n  try {\n    await fs.access(filePath);\n  } catch (err) {\n    if (!isENOENT(err)) throw err;\n    await fs.writeFile(filePath, '{}', { encoding: 'utf-8', mode: WORKSPACE_FILE_MODE });\n  }\n}\n\nasync function writeJsonAtomic(filePath: string, value: unknown): Promise<void> {\n  const tmp = `${filePath}.tmp`;\n  await fs.writeFile(tmp, JSON.stringify(value, null, 2) + '\\n', {\n    encoding: 'utf-8',\n    mode: WORKSPACE_FILE_MODE,\n  });\n  await fs.rename(tmp, filePath);\n}\n\nfunction isENOENT(err: unknown): boolean {\n  return typeof err === 'object' && err !== null && 'code' in err && err.code === 'ENOENT';\n}\n\nfunction createEmptyLocalForSynced(synced: WorkspaceSynced): WorkspaceLocal {\n  return {\n    schemaVersion: 1,\n    workspaceId: synced.workspaceId,\n    executionPlans: {},\n    history: { requestRuns: [], planRuns: [] },\n    secretIndex: { entries: {} },\n    sessions: { github: { workspace: null, links: {} } },\n    connectedRepo: null,\n    workingBranch: null,\n    seededWorkspaceSha: null,\n    retiredBranch: null,\n    sync: {\n      lastPulledSnapshot: null,\n      lastPulledSha: null,\n      lastPulledAt: null,\n      dirtyKeys: [],\n    },\n    linkedCollections: {},\n    attachmentCache: {},\n    globalContext: {},\n    mockRuntime: { active: {} },\n    ui: {\n      activeRequestId: null,\n      sidebarExpandedSections: [],\n      themeId: 'one-dark-pro',\n      fontId: 'system-sans',\n      fontSizePercent: FONT_SIZE_PERCENT_DEFAULT,\n    },\n    settings: { validateOnSend: true, monacoConsumesWheel: false },\n    snapshots: { entries: [], maxBytes: 50 * 1024 * 1024 },\n  };\n}\n"],"mappings":";AAAA,SAAS,YAAY,UAAU;AAC/B,YAAY,UAAU;AACtB,SAAS,iCAAiC;AAE1C,OAAO,cAAc;AAgBrB,IAAM,cAAc;AACpB,IAAM,aAAa;AAsBnB,eAAsB,aACpB,KACA,UAA+B,CAAC,GACA;AAChC,QAAM,aAAkB,UAAK,KAAK,QAAQ,kBAAkB,WAAW;AACvE,QAAM,YAAiB,UAAK,KAAK,UAAU;AAE3C,MAAI;AACJ,MAAI;AACF,gBAAY,MAAM,GAAG,SAAS,YAAY,OAAO;AAAA,EACnD,SAAS,KAAK;AACZ,QAAI,QAAQ,gBAAgB,SAAS,GAAG,EAAG,QAAO;AAClD,UAAM;AAAA,EACR;AACA,QAAM,SAAS,KAAK,MAAM,SAAS;AAEnC,MAAI;AACJ,MAAI;AACF,YAAQ,KAAK,MAAM,MAAM,GAAG,SAAS,WAAW,OAAO,CAAC;AACxD,YAAQ,EAAE,GAAG,OAAO,iBAAiB,MAAM,mBAAmB,CAAC,EAAE;AAAA,EACnE,SAAS,KAAK;AACZ,QAAI,CAAC,SAAS,GAAG,EAAG,OAAM;AAC1B,YAAQ,0BAA0B,MAAM;AAAA,EAC1C;AAEA,SAAO,EAAE,QAAQ,MAAM;AACzB;AAUA,eAAsB,WACpB,KACA,OACA,UAA6B,CAAC,GACf;AACf,QAAM,GAAG,MAAM,KAAK,EAAE,WAAW,KAAK,CAAC;AACvC,QAAM,aAAkB,UAAK,KAAK,QAAQ,kBAAkB,WAAW;AACvE,QAAM,YAAiB,UAAK,KAAK,UAAU;AAG3C,QAAM,WAAW,UAAU;AAE3B,QAAM,UAAU,MAAM,SAAS,KAAK,YAAY;AAAA,IAC9C,SAAS,EAAE,SAAS,GAAG,YAAY,IAAI,YAAY,IAAI;AAAA,IACvD,OAAO,QAAQ,iBAAiB;AAAA,EAClC,CAAC;AACD,MAAI;AACF,UAAM,gBAAgB,YAAY,MAAM,MAAM;AAC9C,UAAM,gBAAgB,WAAW,MAAM,KAAK;AAAA,EAC9C,UAAE;AACA,UAAM,QAAQ;AAAA,EAChB;AACF;AAMA,eAAsB,cACpB,KACA,IACA,UAA6B,CAAC,GACN;AACxB,QAAM,GAAG,MAAM,KAAK,EAAE,WAAW,KAAK,CAAC;AACvC,QAAM,aAAkB,UAAK,KAAK,QAAQ,kBAAkB,WAAW;AACvE,QAAM,YAAiB,UAAK,KAAK,UAAU;AAC3C,QAAM,WAAW,UAAU;AAE3B,QAAM,UAAU,MAAM,SAAS,KAAK,YAAY;AAAA,IAC9C,SAAS,EAAE,SAAS,GAAG,YAAY,IAAI,YAAY,IAAI;AAAA,IACvD,OAAO,QAAQ,iBAAiB;AAAA,EAClC,CAAC;AACD,MAAI;AACF,UAAM,YAAY,MAAM,GAAG,SAAS,YAAY,OAAO;AACvD,UAAM,SAAS,KAAK,MAAM,SAAS;AACnC,QAAI;AACJ,QAAI;AACF,cAAQ,KAAK,MAAM,MAAM,GAAG,SAAS,WAAW,OAAO,CAAC;AACxD,cAAQ,EAAE,GAAG,OAAO,iBAAiB,MAAM,mBAAmB,CAAC,EAAE;AAAA,IACnE,SAAS,KAAK;AACZ,UAAI,CAAC,SAAS,GAAG,EAAG,OAAM;AAC1B,cAAQ,0BAA0B,MAAM;AAAA,IAC1C;AACA,UAAM,MAAM,MAAM,GAAG,EAAE,QAAQ,MAAM,CAAC;AACtC,UAAM,gBAAgB,YAAY,IAAI,KAAK,MAAM;AACjD,UAAM,gBAAgB,WAAW,IAAI,KAAK,KAAK;AAC/C,WAAO,IAAI;AAAA,EACb,UAAE;AACA,UAAM,QAAQ;AAAA,EAChB;AACF;AAeA,IAAM,sBAAsB;AAE5B,eAAe,WAAW,UAAiC;AACzD,MAAI;AACF,UAAM,GAAG,OAAO,QAAQ;AAAA,EAC1B,SAAS,KAAK;AACZ,QAAI,CAAC,SAAS,GAAG,EAAG,OAAM;AAC1B,UAAM,GAAG,UAAU,UAAU,MAAM,EAAE,UAAU,SAAS,MAAM,oBAAoB,CAAC;AAAA,EACrF;AACF;AAEA,eAAe,gBAAgB,UAAkB,OAA+B;AAC9E,QAAM,MAAM,GAAG,QAAQ;AACvB,QAAM,GAAG,UAAU,KAAK,KAAK,UAAU,OAAO,MAAM,CAAC,IAAI,MAAM;AAAA,IAC7D,UAAU;AAAA,IACV,MAAM;AAAA,EACR,CAAC;AACD,QAAM,GAAG,OAAO,KAAK,QAAQ;AAC/B;AAEA,SAAS,SAAS,KAAuB;AACvC,SAAO,OAAO,QAAQ,YAAY,QAAQ,QAAQ,UAAU,OAAO,IAAI,SAAS;AAClF;AAEA,SAAS,0BAA0B,QAAyC;AAC1E,SAAO;AAAA,IACL,eAAe;AAAA,IACf,aAAa,OAAO;AAAA,IACpB,gBAAgB,CAAC;AAAA,IACjB,SAAS,EAAE,aAAa,CAAC,GAAG,UAAU,CAAC,EAAE;AAAA,IACzC,aAAa,EAAE,SAAS,CAAC,EAAE;AAAA,IAC3B,UAAU,EAAE,QAAQ,EAAE,WAAW,MAAM,OAAO,CAAC,EAAE,EAAE;AAAA,IACnD,eAAe;AAAA,IACf,eAAe;AAAA,IACf,oBAAoB;AAAA,IACpB,eAAe;AAAA,IACf,MAAM;AAAA,MACJ,oBAAoB;AAAA,MACpB,eAAe;AAAA,MACf,cAAc;AAAA,MACd,WAAW,CAAC;AAAA,IACd;AAAA,IACA,mBAAmB,CAAC;AAAA,IACpB,iBAAiB,CAAC;AAAA,IAClB,eAAe,CAAC;AAAA,IAChB,aAAa,EAAE,QAAQ,CAAC,EAAE;AAAA,IAC1B,IAAI;AAAA,MACF,iBAAiB;AAAA,MACjB,yBAAyB,CAAC;AAAA,MAC1B,SAAS;AAAA,MACT,QAAQ;AAAA,MACR,iBAAiB;AAAA,IACnB;AAAA,IACA,UAAU,EAAE,gBAAgB,MAAM,qBAAqB,MAAM;AAAA,IAC7D,WAAW,EAAE,SAAS,CAAC,GAAG,UAAU,KAAK,OAAO,KAAK;AAAA,EACvD;AACF;","names":[]}