@bendyline/docblocks 2.0.0 → 2.1.0

package/dist/workspace/types.d.ts

@@ -1,69 +0,0 @@
-/**
- * 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.
- */
-export 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).
- */
-export 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)
-     * - 'electron-native' — Electron main-process native filesystem
-     * - 'transient' — session-only, in-memory (a loose file or `.dbk` opened
-     *   from the OS). Never persisted; its provider lives in an in-memory
-     *   registry (see workspace-manager) and it saves back to `origin`.
-     */
-    type: 'indexeddb' | 'native' | 'electron-native' | 'transient';
-    /** ISO timestamp of last access. */
-    lastOpened: string;
-    /** Absolute filesystem path for 'electron-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';
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/workspace/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/workspace/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,eAAe,GACvB;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GAC1C;IACE,IAAI,EAAE,KAAK,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,mEAAmE;IACnE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,GACD;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,oBAAoB,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAChE;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,oBAAoB,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,CAAC;AAEN;;;GAGG;AAEH,MAAM,WAAW,mBAAmB;IAClC,yDAAyD;IACzD,EAAE,EAAE,MAAM,CAAC;IACX,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;;;OAQG;IACH,IAAI,EAAE,WAAW,GAAG,QAAQ,GAAG,iBAAiB,GAAG,WAAW,CAAC;IAC/D,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+EAA+E;IAC/E,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,SAAS,GAAG,IAAI,GAAG,KAAK,CAAC;CAC/C"}

package/dist/workspace/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/dist/workspace/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/workspace/types.ts"],"names":[],"mappings":""}

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

@@ -1,47 +0,0 @@
-/**
- * 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).
- */
-import { type FileSystemProvider } from '../filesystem/types.js';
-import type { WorkspaceDescriptor } from './types.js';
-/** Register a transient workspace and its (already-built) provider. */
-export declare function registerTransientWorkspace(descriptor: WorkspaceDescriptor, provider: FileSystemProvider): void;
-/** Look up a transient workspace (descriptor + provider) by id, if any. */
-export declare function getTransientWorkspace(id: string): {
-    descriptor: WorkspaceDescriptor;
-    provider: FileSystemProvider;
-} | null;
-/** Forget a transient workspace (e.g. when it is closed). */
-export 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).
- */
-export declare function listWorkspaces(): Promise<WorkspaceDescriptor[]>;
-/**
- * Get a specific workspace descriptor by id (transient or persisted).
- */
-export 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.
- */
-export declare function saveWorkspace(workspace: WorkspaceDescriptor): Promise<void>;
-/**
- * Remove a workspace descriptor by id (transient or persisted).
- */
-export 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).
- */
-export declare function touchWorkspace(id: string): Promise<void>;
-/**
- * Ensure a default IndexedDB workspace exists. Called on app startup.
- * Returns the descriptor.
- */
-export declare function ensureDefaultWorkspace(): Promise<WorkspaceDescriptor>;
-//# sourceMappingURL=workspace-manager.d.ts.map

package/dist/workspace/workspace-manager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"workspace-manager.d.ts","sourceRoot":"","sources":["../../src/workspace/workspace-manager.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAA2B,KAAK,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC1F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAwBtD,uEAAuE;AACvE,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,mBAAmB,EAC/B,QAAQ,EAAE,kBAAkB,GAC3B,IAAI,CAMN;AAED,2EAA2E;AAC3E,wBAAgB,qBAAqB,CACnC,EAAE,EAAE,MAAM,GACT;IAAE,UAAU,EAAE,mBAAmB,CAAC;IAAC,QAAQ,EAAE,kBAAkB,CAAA;CAAE,GAAG,IAAI,CAE1E;AAED,6DAA6D;AAC7D,wBAAsB,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAK5E;AAQD;;;GAGG;AACH,wBAAsB,cAAc,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAIrE;AAED;;GAEG;AACH,wBAAsB,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAKlF;AAED;;;GAGG;AACH,wBAAsB,aAAa,CAAC,SAAS,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAUjF;AAED;;GAEG;AACH,wBAAsB,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAQ/D;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAY9D;AAED;;;GAGG;AACH,wBAAsB,sBAAsB,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAY3E"}

package/dist/workspace/workspace-manager.js

@@ -1,126 +0,0 @@
-/**
- * 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).
- */
-import { LocalForageAdapter } from '@bendyline/squisq/storage';
-import { getFileSystemProviderV2 } from '../filesystem/types.js';
-const DB_NAME = 'docblocks-workspaces';
-const STORE_NAME = 'workspaces';
-const LIST_KEY = 'workspace-list';
-const DEFAULT_WORKSPACE_ID = 'default';
-const store = new LocalForageAdapter({
-    name: DB_NAME,
-    storeName: STORE_NAME,
-});
-const transientWorkspaces = new Map();
-/** Register a transient workspace and its (already-built) provider. */
-export function registerTransientWorkspace(descriptor, provider) {
-    const previous = transientWorkspaces.get(descriptor.id);
-    if (previous && previous.provider !== provider) {
-        void getFileSystemProviderV2(previous.provider)?.dispose();
-    }
-    transientWorkspaces.set(descriptor.id, { descriptor, provider });
-}
-/** Look up a transient workspace (descriptor + provider) by id, if any. */
-export function getTransientWorkspace(id) {
-    return transientWorkspaces.get(id) ?? null;
-}
-/** Forget a transient workspace (e.g. when it is closed). */
-export async function unregisterTransientWorkspace(id) {
-    const entry = transientWorkspaces.get(id);
-    if (!entry)
-        return;
-    transientWorkspaces.delete(id);
-    await getFileSystemProviderV2(entry.provider)?.dispose();
-}
-/** The persisted (on-disk) workspace list only — excludes transient ones. */
-async function listPersisted() {
-    const list = await store.get(LIST_KEY);
-    return list ?? [];
-}
-/**
- * Get all known workspace descriptors — persisted plus any session-only
- * transient ones (so they show in the picker and resolve for the session).
- */
-export async function listWorkspaces() {
-    const persisted = await listPersisted();
-    const transient = [...transientWorkspaces.values()].map((t) => t.descriptor);
-    return [...persisted, ...transient];
-}
-/**
- * Get a specific workspace descriptor by id (transient or persisted).
- */
-export async function getWorkspace(id) {
-    const transient = transientWorkspaces.get(id);
-    if (transient)
-        return transient.descriptor;
-    const list = await listPersisted();
-    return list.find((w) => w.id === id) ?? null;
-}
-/**
- * Add or update a workspace descriptor. If a workspace with the same id
- * already exists, it is replaced. Transient workspaces are never persisted.
- */
-export async function saveWorkspace(workspace) {
-    if (workspace.type === 'transient')
-        return;
-    const list = await listPersisted();
-    const idx = list.findIndex((w) => w.id === workspace.id);
-    if (idx >= 0) {
-        list[idx] = workspace;
-    }
-    else {
-        list.push(workspace);
-    }
-    await store.set(LIST_KEY, list);
-}
-/**
- * Remove a workspace descriptor by id (transient or persisted).
- */
-export async function removeWorkspace(id) {
-    if (transientWorkspaces.has(id)) {
-        await unregisterTransientWorkspace(id);
-        return;
-    }
-    const list = await listPersisted();
-    const filtered = list.filter((w) => w.id !== id);
-    await store.set(LIST_KEY, filtered);
-}
-/**
- * Touch the lastOpened timestamp on a workspace. For transient workspaces this
- * updates the in-memory descriptor only (nothing is persisted).
- */
-export async function touchWorkspace(id) {
-    const transient = transientWorkspaces.get(id);
-    if (transient) {
-        transient.descriptor.lastOpened = new Date().toISOString();
-        return;
-    }
-    const list = await listPersisted();
-    const workspace = list.find((w) => w.id === id);
-    if (workspace) {
-        workspace.lastOpened = new Date().toISOString();
-        await store.set(LIST_KEY, list);
-    }
-}
-/**
- * Ensure a default IndexedDB workspace exists. Called on app startup.
- * Returns the descriptor.
- */
-export async function ensureDefaultWorkspace() {
-    const existing = await getWorkspace(DEFAULT_WORKSPACE_ID);
-    if (existing)
-        return existing;
-    const descriptor = {
-        id: DEFAULT_WORKSPACE_ID,
-        name: 'My Documents',
-        type: 'indexeddb',
-        lastOpened: new Date().toISOString(),
-    };
-    await saveWorkspace(descriptor);
-    return descriptor;
-}
-//# sourceMappingURL=workspace-manager.js.map

package/dist/workspace/workspace-manager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"workspace-manager.js","sourceRoot":"","sources":["../../src/workspace/workspace-manager.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAA2B,MAAM,wBAAwB,CAAC;AAG1F,MAAM,OAAO,GAAG,sBAAsB,CAAC;AACvC,MAAM,UAAU,GAAG,YAAY,CAAC;AAChC,MAAM,QAAQ,GAAG,gBAAgB,CAAC;AAClC,MAAM,oBAAoB,GAAG,SAAS,CAAC;AAEvC,MAAM,KAAK,GAAG,IAAI,kBAAkB,CAAC;IACnC,IAAI,EAAE,OAAO;IACb,SAAS,EAAE,UAAU;CACtB,CAAC,CAAC;AAYH,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAA0B,CAAC;AAE9D,uEAAuE;AACvE,MAAM,UAAU,0BAA0B,CACxC,UAA+B,EAC/B,QAA4B;IAE5B,MAAM,QAAQ,GAAG,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IACxD,IAAI,QAAQ,IAAI,QAAQ,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC/C,KAAK,uBAAuB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IAC7D,CAAC;IACD,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;AACnE,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,qBAAqB,CACnC,EAAU;IAEV,OAAO,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC;AAC7C,CAAC;AAED,6DAA6D;AAC7D,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAAC,EAAU;IAC3D,MAAM,KAAK,GAAG,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC1C,IAAI,CAAC,KAAK;QAAE,OAAO;IACnB,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC/B,MAAM,uBAAuB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;AAC3D,CAAC;AAED,6EAA6E;AAC7E,KAAK,UAAU,aAAa;IAC1B,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,GAAG,CAAwB,QAAQ,CAAC,CAAC;IAC9D,OAAO,IAAI,IAAI,EAAE,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,MAAM,SAAS,GAAG,MAAM,aAAa,EAAE,CAAC;IACxC,MAAM,SAAS,GAAG,CAAC,GAAG,mBAAmB,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAC7E,OAAO,CAAC,GAAG,SAAS,EAAE,GAAG,SAAS,CAAC,CAAC;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,EAAU;IAC3C,MAAM,SAAS,GAAG,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC9C,IAAI,SAAS;QAAE,OAAO,SAAS,CAAC,UAAU,CAAC;IAC3C,MAAM,IAAI,GAAG,MAAM,aAAa,EAAE,CAAC;IACnC,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,IAAI,IAAI,CAAC;AAC/C,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,SAA8B;IAChE,IAAI,SAAS,CAAC,IAAI,KAAK,WAAW;QAAE,OAAO;IAC3C,MAAM,IAAI,GAAG,MAAM,aAAa,EAAE,CAAC;IACnC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,CAAC;IACzD,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;QACb,IAAI,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IACxB,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,EAAU;IAC9C,IAAI,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;QAChC,MAAM,4BAA4B,CAAC,EAAE,CAAC,CAAC;QACvC,OAAO;IACT,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,aAAa,EAAE,CAAC;IACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACjD,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AACtC,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EAAU;IAC7C,MAAM,SAAS,GAAG,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC9C,IAAI,SAAS,EAAE,CAAC;QACd,SAAS,CAAC,UAAU,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC3D,OAAO;IACT,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,aAAa,EAAE,CAAC;IACnC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAChD,IAAI,SAAS,EAAE,CAAC;QACd,SAAS,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAChD,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB;IAC1C,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,oBAAoB,CAAC,CAAC;IAC1D,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAE9B,MAAM,UAAU,GAAwB;QACtC,EAAE,EAAE,oBAAoB;QACxB,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,WAAW;QACjB,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACrC,CAAC;IACF,MAAM,aAAa,CAAC,UAAU,CAAC,CAAC;IAChC,OAAO,UAAU,CAAC;AACpB,CAAC"}