@bendyline/docblocks 2.7.3 → 2.7.5

package/dist/workspace/index.d.ts

@@ -1,145 +1,45 @@
-import { d as FileSystemProvider } from '../types-BvDnr3YU.js';
-import { Z as ElectronWorkspaceInfo, aj as HostEnvironment } from '../capabilities-r03EXSAi.js';
-import '../v2-BVnZZyd4.js';
-import '../workspace-path-CWVrcuPL.js';
-import '../filesystem-v2-C8AdSXUN.js';
+export { D as DEFAULT_WORKSPACE_ID, E as ElectronWorkspaceReconciliation, T as TransientOrigin, W as WorkspaceDescriptor, e as ensureDefaultWorkspace, g as getTransientWorkspace, a as getWorkspace, l as listWorkspaces, p as parsePersistedWorkspaceList, r as reconcileElectronWorkspaceDescriptors, b as registerTransientWorkspace, c as removeWorkspace, s as saveWorkspace, t as touchWorkspace, u as unregisterTransientWorkspace } from '../reconcile-electron-Ci2lhAdW.js';
+import { ContentContainer } from '@bendyline/squisq/storage';
+import { o as FileSystemProviderV2 } from '../v2-DwxWjFC0.js';
+import { a as WorkspacePath } from '../workspace-path-CWVrcuPL.js';
+import '../types-DLteNrK0.js';
+import '../capabilities-DHwh4P4D.js';
+import '../filesystem-v2-CXdAPR27.js';
 
-/**
- * Origin of a transient workspace — records where its contents came from and
- * how to save them back. Set only on `type: 'transient'` workspaces.
- * - 'loose-file' — a single markdown file opened from the OS (Electron);
- *   edits write back through an owner-scoped `resourceId` grant.
- * - 'dbk' — a `.dbk`/zip bundle unpacked into memory (Electron); edits are
- *   re-zipped and written back through an owner-scoped resource grant.
- * - 'web-file' — a single markdown file launched into the installed web app
- *   (File Handling API); edits write back through `handle`.
- * - 'web-dbk' — a `.dbk`/zip bundle launched into the installed web app;
- *   edits are re-zipped and written back through `handle`.
- *
- * The web variants hold a live `FileSystemFileHandle`. That is safe because
- * transient descriptors are never persisted — they live only in the
- * in-memory registry (see workspace-manager) for the current page session.
- */
-type TransientOrigin = {
-    kind: 'loose-file';
-    resourceId: string;
-} | {
-    kind: 'dbk';
-    resourceId: string;
-    /** SHA-256 of the last bundle version acknowledged by the host. */
-    version: string | null;
-} | {
-    kind: 'web-file';
-    handle: FileSystemFileHandle;
-    name: string;
-} | {
-    kind: 'web-dbk';
-    handle: FileSystemFileHandle;
-    name: string;
-    /** SHA-256 of the last bundle version observed on disk. */
-    version: string | null;
-};
-/**
- * Workspace — a named binding to a FileSystemProvider, representing
- * the user's current working context (a folder of markdown files).
- */
-interface WorkspaceDescriptor {
-    /** Unique stable identifier (persisted in IndexedDB). */
-    id: string;
-    /** User-visible label. */
-    name: string;
-    /**
-     * Provider kind:
-     * - 'indexeddb' — browser-local storage (web only)
-     * - 'native' — File System Access API (web Chrome/Edge only)
-     * - 'host-native' — Electron main-process native filesystem
-     * - 'transient' — session-only, in-memory (a loose file/`.dbk` opened from
-     *   the OS, or a document copied from a shared URL). Never persisted; its
-     *   provider lives in an in-memory registry (see workspace-manager). An
-     *   `origin` is present only when changes can be saved back externally.
-     */
-    type: 'indexeddb' | 'native' | 'host-native' | 'transient';
-    /** ISO timestamp of last access. */
-    lastOpened: string;
-    /** Absolute filesystem path for 'host-native' workspaces. */
-    rootPath?: string;
-    /** For 'transient' workspaces: where the contents came from / save back to. */
-    origin?: TransientOrigin;
-    /**
-     * Per-workspace override for the global versioning preference. When
-     * `'inherit'` (or absent), the global preference applies. `'on'` /
-     * `'off'` force the corresponding behavior regardless of the global
-     * setting. See `resolveVersioningEnabled` in the preferences module.
-     */
-    versioningOverride?: 'inherit' | 'on' | 'off';
+declare const WORKSPACE_BACKUP_MANIFEST = "docblocks-backup.json";
+declare const WORKSPACE_BACKUP_LIMITS: Readonly<{
+    maxEntries: 10000;
+    maxUncompressedBytes: number;
+    maxEntryUncompressedBytes: number;
+    maxCompressionRatio: 1000;
+}>;
+interface BackupWorkspace {
+    readonly name: string;
+    readonly prefix: string;
+    readonly directories: readonly WorkspacePath[];
 }
-
-/** Parse the complete persisted workspace list before it reaches startup code. */
-declare function parsePersistedWorkspaceList(value: unknown): WorkspaceDescriptor[];
-
-/**
- * WorkspaceManager — manages the list of known workspaces in IndexedDB
- * and provides helpers for creating / switching / removing them.
- *
- * The actual FileSystemProvider instances are created by the caller
- * (since native providers need a DirectoryHandle from user interaction).
- */
-
-/** Id of the browser-local workspace `ensureDefaultWorkspace` creates. */
-declare const DEFAULT_WORKSPACE_ID = "default";
-/** Register a transient workspace and its (already-built) provider. */
-declare function registerTransientWorkspace(descriptor: WorkspaceDescriptor, provider: FileSystemProvider): void;
-/** Look up a transient workspace (descriptor + provider) by id, if any. */
-declare function getTransientWorkspace(id: string): {
-    descriptor: WorkspaceDescriptor;
-    provider: FileSystemProvider;
-} | null;
-/** Forget a transient workspace (e.g. when it is closed). */
-declare function unregisterTransientWorkspace(id: string): Promise<void>;
-/**
- * Get all known workspace descriptors — persisted plus any session-only
- * transient ones (so they show in the picker and resolve for the session).
- */
-declare function listWorkspaces(): Promise<WorkspaceDescriptor[]>;
-/**
- * Get a specific workspace descriptor by id (transient or persisted).
- */
-declare function getWorkspace(id: string): Promise<WorkspaceDescriptor | null>;
-/**
- * Add or update a workspace descriptor. If a workspace with the same id
- * already exists, it is replaced. Transient workspaces are never persisted.
- */
-declare function saveWorkspace(workspace: WorkspaceDescriptor): Promise<void>;
-/**
- * Remove a workspace descriptor by id (transient or persisted).
- */
-declare function removeWorkspace(id: string): Promise<void>;
-/**
- * Touch the lastOpened timestamp on a workspace. For transient workspaces this
- * updates the in-memory descriptor only (nothing is persisted).
- */
-declare function touchWorkspace(id: string): Promise<void>;
-/**
- * Ensure a default IndexedDB workspace exists. Called on app startup.
- * Returns the descriptor.
- */
-declare function ensureDefaultWorkspace(): Promise<WorkspaceDescriptor>;
-
-interface ElectronWorkspaceReconciliation {
-    /** Obsolete renderer descriptors to remove before attempting restoration. */
-    readonly removeIds: readonly string[];
-    /** Canonical main-authorized descriptors to insert or replace. */
-    readonly upsert: readonly WorkspaceDescriptor[];
-    /** Safe navigation migration for a local descriptor matched by root. */
-    readonly idRemap: Readonly<Record<string, string>>;
+interface WorkspaceBackupManifest {
+    readonly format: 'docblocks-workspace-backup';
+    readonly version: 1;
+    readonly workspaces: readonly BackupWorkspace[];
 }
-/**
- * Reconcile renderer IndexedDB metadata with the main process authority list.
- * `hostWorkspaces` is authoritative: local Electron descriptors absent from
- * it cannot be opened safely and are removed. Root-path matching carries user
- * metadata across an id migration without treating that display path as
- * authority.
- */
-declare function reconcileElectronWorkspaceDescriptors(local: readonly WorkspaceDescriptor[], hostWorkspaces: readonly ElectronWorkspaceInfo[], platform: HostEnvironment['platform'], now: string): ElectronWorkspaceReconciliation;
+interface RestorableWorkspace {
+    readonly name: string;
+    readonly directories: readonly WorkspacePath[];
+    readonly files: readonly {
+        path: WorkspacePath;
+        data: ArrayBuffer;
+    }[];
+}
+declare function parseWorkspaceBackupManifest(value: unknown): WorkspaceBackupManifest;
+/** Capture bytes and empty directories without modifying the source workspace. */
+declare function appendWorkspaceBackup(container: ContentContainer, provider: FileSystemProviderV2, previous: readonly BackupWorkspace[]): Promise<BackupWorkspace[]>;
+declare function finishWorkspaceBackup(container: ContentContainer, workspaces: readonly BackupWorkspace[]): Promise<void>;
+/** Validate the complete archive before creating any destination workspace.
+ * Legacy plain ZIP backups restore as one workspace, retaining their full tree.
+ */
+declare function readWorkspaceBackup(container: ContentContainer, legacyName: string): Promise<RestorableWorkspace[]>;
+/** Only an empty, newly allocated destination may receive a restored tree. */
+declare function restoreWorkspaceBackup(workspace: RestorableWorkspace, provider: FileSystemProviderV2): Promise<void>;
 
-export { DEFAULT_WORKSPACE_ID, type ElectronWorkspaceReconciliation, type TransientOrigin, type WorkspaceDescriptor, ensureDefaultWorkspace, getTransientWorkspace, getWorkspace, listWorkspaces, parsePersistedWorkspaceList, reconcileElectronWorkspaceDescriptors, registerTransientWorkspace, removeWorkspace, saveWorkspace, touchWorkspace, unregisterTransientWorkspace };
+export { type BackupWorkspace, type RestorableWorkspace, WORKSPACE_BACKUP_LIMITS, WORKSPACE_BACKUP_MANIFEST, type WorkspaceBackupManifest, appendWorkspaceBackup, finishWorkspaceBackup, parseWorkspaceBackupManifest, readWorkspaceBackup, restoreWorkspaceBackup };

package/dist/workspace/index.js

@@ -1,29 +1,44 @@
 import {
   DEFAULT_WORKSPACE_ID,
+  WORKSPACE_BACKUP_LIMITS,
+  WORKSPACE_BACKUP_MANIFEST,
+  appendWorkspaceBackup,
   ensureDefaultWorkspace,
+  finishWorkspaceBackup,
   getTransientWorkspace,
   getWorkspace,
   listWorkspaces,
   parsePersistedWorkspaceList,
+  parseWorkspaceBackupManifest,
+  readWorkspaceBackup,
   reconcileElectronWorkspaceDescriptors,
   registerTransientWorkspace,
   removeWorkspace,
+  restoreWorkspaceBackup,
   saveWorkspace,
   touchWorkspace,
   unregisterTransientWorkspace
-} from "../chunk-QS5WTLUZ.js";
+} from "../chunk-XI2LYBRR.js";
 import "../chunk-DAPFSEKY.js";
 import "../chunk-XAMILHQP.js";
+import "../chunk-UTH3HYCZ.js";
 export {
   DEFAULT_WORKSPACE_ID,
+  WORKSPACE_BACKUP_LIMITS,
+  WORKSPACE_BACKUP_MANIFEST,
+  appendWorkspaceBackup,
   ensureDefaultWorkspace,
+  finishWorkspaceBackup,
   getTransientWorkspace,
   getWorkspace,
   listWorkspaces,
   parsePersistedWorkspaceList,
+  parseWorkspaceBackupManifest,
+  readWorkspaceBackup,
   reconcileElectronWorkspaceDescriptors,
   registerTransientWorkspace,
   removeWorkspace,
+  restoreWorkspaceBackup,
   saveWorkspace,
   touchWorkspace,
   unregisterTransientWorkspace

package/dist/workspace-index/index.d.ts

@@ -1,4 +1,4 @@
-import { n as FileSystemProviderV2, m as FileSystemProviderCapabilities } from '../v2-BVnZZyd4.js';
+import { o as FileSystemProviderV2, n as FileSystemProviderCapabilities } from '../v2-DwxWjFC0.js';
 import { a as WorkspacePath } from '../workspace-path-CWVrcuPL.js';
 import { d as CatalogDocumentFormat, f as CatalogOutlineEntry } from '../catalog-BQK05tne.js';
 import '@bendyline/squisq/markdown';
@@ -151,6 +151,8 @@ interface WorkspaceIndex {
     start(): void;
     /** Every discoverable file, sorted by path; the same array within a generation. */
     getFiles(): readonly WorkspaceIndexFile[];
+    /** Discoverable folders, including empty folders; sorted within a generation. */
+    getDirectories(): readonly WorkspacePath[];
     /** Every document (Markdown and outside-in), sorted by path. */
     getDocuments(): readonly IndexedDocument[];
     getDocument(path: string): IndexedDocument | null;

package/dist/workspace-index/index.js

@@ -11,14 +11,14 @@ import {
 } from "../chunk-YHSFRPBS.js";
 import {
   decodeUtf8Text
-} from "../chunk-M5ZNQGR5.js";
+} from "../chunk-IYKGM3PV.js";
 import {
   FsError,
   WORKSPACE_ROOT,
   parseWorkspacePath,
   tryParseWorkspacePath,
   workspacePathContains
-} from "../chunk-AYWKIZLD.js";
+} from "../chunk-UTH3HYCZ.js";
 
 // src/workspace-index/search-text.ts
 var LineBuilder = class {
@@ -533,6 +533,7 @@ var WorkspaceIndexImpl = class {
     this.generation = 0;
     this.lastPublish = 0;
     this.filesCache = null;
+    this.directoriesCache = null;
     this.documentsCache = null;
     this.statusCache = null;
     this.workspaceId = options.workspaceId;
@@ -592,6 +593,20 @@ var WorkspaceIndexImpl = class {
     }
     return this.documentsCache;
   }
+  getDirectories() {
+    if (!this.directoriesCache) {
+      const directories = new Set(this.tree.directories);
+      for (const path of [...this.tree.directories, ...this.tree.files.keys()]) {
+        let slash = path.lastIndexOf("/");
+        while (slash >= 0) {
+          directories.add(parseWorkspacePath(path.slice(0, slash)));
+          slash = path.lastIndexOf("/", slash - 1);
+        }
+      }
+      this.directoriesCache = Object.freeze([...directories].sort(compareCodeUnits2));
+    }
+    return this.directoriesCache;
+  }
   getDocument(path) {
     const canonical = tryParseWorkspacePath(path);
     const state = canonical === null ? void 0 : this.tree.documents.get(canonical);
@@ -1167,6 +1182,7 @@ var WorkspaceIndexImpl = class {
     this.generation += 1;
     this.lastPublish = this.now();
     this.filesCache = null;
+    this.directoriesCache = null;
     this.documentsCache = null;
     this.statusCache = null;
     for (const listener of [...this.listeners]) {

package/dist/workspace-settings/index.d.ts

@@ -3,7 +3,7 @@ export { b as CATALOG_JSON_CONTENT_MODES, c as CATALOG_SORT_ORDERS, d as Catalog
 import { C as CatalogEntry, W as WorkspaceCatalog } from '../catalog-BQK05tne.js';
 export { a as CATALOG_FORMAT_VERSION, b as CATALOG_GENERATOR, c as CATALOG_LIMITS, d as CatalogDocumentFormat, e as CatalogEntryHints, f as CatalogOutlineEntry, g as CatalogSource, O as OUTSIDE_IN_FORMAT_IDS, h as OutsideInFormatId, i as OutsideInLayout, j as buildCatalogMarkdownDocument, k as catalogEntryForUnreadable, l as catalogEntryFromDocument, m as catalogEntryFromMarkdown, n as chooseOutsideInMarkdownPath, o as createWorkspaceCatalog, p as isGeneratedCatalogHtml, q as isGeneratedCatalogJson, r as readCatalogHtmlDigest, s as relativeCatalogLink, t as relocateOutsideInLayout, u as resolveOutsideInLayout, v as serializeCatalogJson, w as sortCatalogEntries, x as stampCatalogHtml } from '../catalog-BQK05tne.js';
 import { MarkdownDocument } from '@bendyline/squisq/markdown';
-import { u as FileSystemVersion, n as FileSystemProviderV2 } from '../v2-BVnZZyd4.js';
+import { v as FileSystemVersion, o as FileSystemProviderV2 } from '../v2-DwxWjFC0.js';
 import { a as WorkspacePath } from '../workspace-path-CWVrcuPL.js';
 
 /**

package/dist/workspace-settings/index.js

@@ -48,7 +48,7 @@ import {
   serializeWorkspaceSettings,
   tryApplyWorkspaceSettingsPatch,
   validateCatalogOutputPath
-} from "../chunk-UK7R3RC7.js";
+} from "../chunk-BC42VRYW.js";
 import {
   SQUISQ_RUNTIME_DIRECTORY_NAME,
   isDiscoverableWorkspaceEntry,
@@ -57,12 +57,12 @@ import {
 } from "../chunk-YHSFRPBS.js";
 import {
   decodeUtf8Text
-} from "../chunk-M5ZNQGR5.js";
+} from "../chunk-IYKGM3PV.js";
 import {
   FsError,
   WORKSPACE_ROOT,
   parseWorkspacePath
-} from "../chunk-AYWKIZLD.js";
+} from "../chunk-UTH3HYCZ.js";
 
 // src/workspace-settings/schema.ts
 var themeId = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bendyline/docblocks",
-  "version": "2.7.3",
+  "version": "2.7.5",
   "description": "Core data structures and filesystem abstractions for DocBlocks",
   "license": "MIT",
   "author": "Bendyline",
@@ -126,7 +126,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@bendyline/squisq": "2.12.3",
+    "@bendyline/squisq": "2.13.0",
     "zod": "3.25.76"
   }
 }