@bendyline/docblocks-react 2.0.0 → 2.1.1

package/src/editor.ts

@@ -1,72 +0,0 @@
-/**
- * Placeholder prompts shown by DocBlocks when a Markdown document is empty.
- * Hosts pick one prompt for each mounted document generation and pass it to
- * Squisq, so the copy remains stable while that document is open.
- */
-export const EMPTY_DOCUMENT_PROMPTS = [
-  'Start typing your content, or drop images on top of me...',
-  'Write anything -- paste markdown, drag in images, or just start typing...',
-  'Type away. Markdown syntax works too...',
-  'Chapter 1 begins here...',
-  'Once upon a time...',
-  "A blank page. Exciting, isn't it?",
-  'The first word is always the hardest...',
-  'Plot twist: this is where it all starts...',
-  'Write something the future you will thank you for...',
-  'Begin at the beginning...',
-  "Let's begin.",
-  'We can be heroes...',
-  'Here comes the sun...',
-  'And so it begins...',
-  'Let it be, let it be...',
-  "Don't stop believing...",
-  'Started from the bottom...',
-  'This is the start of something new...',
-  'Ground control to Major Tom...',
-  'Come as you are...',
-  'Every new beginning...',
-  "Hello, is it me you're looking for?",
-  'Imagine all the people...',
-  'Anything you want, you got it...',
-  'Rise above...',
-  'Do you have the time...',
-  'Here we are now, entertain us...',
-  'All the small things...',
-  'Should I stay or should I go?',
-  'I am a patient boy -- I wait, I wait, I wait...',
-  'Destination unknown...',
-  'Easy like Sunday morning...',
-  'Dance, dance, dance to the radio...',
-  'New day rising...',
-  'Visit the world...',
-  'Positive mental attitude...',
-  'Better I sing than I cry...',
-  'Disconnect for a minute...',
-  'We need new noise...',
-  'Shoot the moon...',
-  "I'll surprise you sometime -- I'll come around...",
-  'Coming out of my cage, and doing just fine...',
-  "Throw me to the wolves -- I'll come back, leading the pack...",
-  'There comes a time -- no excuses...',
-  "It's up to me now, turn on the bright lights...",
-  'Do what you want...',
-  'Fingers crossed...',
-  'This is the start of how it all ends...',
-  'It has to start somewhere, it has to start sometime -- what better place than here? what better time than now?',
-  "I know myself, and I'll begin again...",
-  'Dig me out, dig me in...',
-  "Everybody's full of sugar, honey, ice and tea...",
-  "Take time with a wounded hand, 'cause it likes to heal...",
-  'Grab a brush and put on a little makeup...',
-  'Amber is the color of your energy...',
-  "Wait -- they don't love it like I love it...",
-  "A world's been buried, where love is the law; a you-topia...",
-] as const;
-
-export type EmptyDocumentPrompt = (typeof EMPTY_DOCUMENT_PROMPTS)[number];
-
-/** Pick a prompt using the supplied random source, or `Math.random`. */
-export function pickEmptyDocumentPrompt(random: () => number = Math.random): EmptyDocumentPrompt {
-  const index = Math.floor(random() * EMPTY_DOCUMENT_PROMPTS.length);
-  return EMPTY_DOCUMENT_PROMPTS[index] ?? EMPTY_DOCUMENT_PROMPTS[0];
-}

package/src/hooks/index.ts

@@ -1,2 +0,0 @@
-export { useDocumentSession } from './useDocumentSession.js';
-export type { UseDocumentSessionResult } from './useDocumentSession.js';

package/src/hooks/useDocumentSession.ts

@@ -1,37 +0,0 @@
-import { useState, useSyncExternalStore } from 'react';
-import {
-  DocumentRecoveryJournal,
-  DocumentSession,
-  getDefaultDocumentRecoveryStorage,
-  type DocumentSessionSnapshot,
-} from '@bendyline/docblocks/document';
-
-export interface UseDocumentSessionResult {
-  /** Stable controller for the lifetime of the mounted shell/panel. */
-  session: DocumentSession;
-  /** React snapshot of dirty/saving/saved/error/conflict state. */
-  snapshot: DocumentSessionSnapshot;
-}
-
-/**
- * React binding for the framework-neutral DocumentSession engine.
- *
- * The hook deliberately does not infer target transitions from props.
- * Callers must use transitionTo(), retarget(), or delete() before changing
- * their view state so persistence ordering remains explicit.
- */
-export function useDocumentSession(autoSaveDelayMs = 500): UseDocumentSessionResult {
-  const [session] = useState(
-    () =>
-      new DocumentSession({
-        autoSaveDelayMs,
-        recoveryJournal: new DocumentRecoveryJournal(getDefaultDocumentRecoveryStorage()),
-      }),
-  );
-  const snapshot = useSyncExternalStore(
-    session.subscribe,
-    session.getSnapshot,
-    session.getSnapshot,
-  );
-  return { session, snapshot };
-}

package/src/icons.tsx

@@ -1,48 +0,0 @@
-/**
- * DocBlocks shell icons use the Font Awesome Free webfont bundled by
- * `@bendyline/squisq-editor-react/styles`. Controls provide the accessible
- * name, so the glyphs themselves stay decorative.
- */
-
-function FontAwesomeIcon({ icon }: { icon: string }) {
-  return <i className={icon} aria-hidden="true" />;
-}
-
-export function NewFileIcon() {
-  return <FontAwesomeIcon icon="fa-solid fa-file-circle-plus" />;
-}
-
-export function NewFolderIcon() {
-  return <FontAwesomeIcon icon="fa-solid fa-folder-plus" />;
-}
-
-export function FolderIcon() {
-  return <FontAwesomeIcon icon="fa-solid fa-folder" />;
-}
-
-export function MoreIcon() {
-  return <FontAwesomeIcon icon="fa-solid fa-ellipsis" />;
-}
-
-export function WorkspaceIcon() {
-  return <FontAwesomeIcon icon="fa-solid fa-gear" />;
-}
-
-export function SplitViewIcon() {
-  return (
-    <svg
-      width="16"
-      height="16"
-      viewBox="0 0 16 16"
-      fill="none"
-      stroke="currentColor"
-      strokeWidth="1.5"
-      strokeLinecap="round"
-      strokeLinejoin="round"
-      aria-hidden="true"
-    >
-      <rect x="1.5" y="2.5" width="13" height="11" rx="1" />
-      <line x1="6" y1="2.5" x2="6" y2="13.5" />
-    </svg>
-  );
-}

package/src/index.ts

@@ -1,61 +0,0 @@
-/**
- * @bendyline/docblocks-react — React components for DocBlocks
- */
-
-// FileExplorer
-export { FileExplorer } from './FileExplorer/index.js';
-export type {
-  FileExplorerProps,
-  FileTreeChange,
-  FileTreeMutationHandler,
-} from './FileExplorer/index.js';
-export { FileTreeNode } from './FileExplorer/index.js';
-export type { FileTreeNodeProps } from './FileExplorer/index.js';
-export { useFileTree } from './FileExplorer/index.js';
-
-// WorkspacePicker
-export { WorkspacePicker } from './WorkspacePicker/index.js';
-export type { WorkspacePickerProps } from './WorkspacePicker/index.js';
-
-// DocBlocksShell
-export { DocBlocksShell } from './DocBlocksShell/index.js';
-export type { DocBlocksShellProps } from './DocBlocksShell/index.js';
-
-// AppMenu
-export { AppMenu } from './AppMenu/index.js';
-export type { AccentColor, AppMenuProps, ThemePreference } from './AppMenu/index.js';
-
-// Settings
-export { AccentColorSettings, SettingsDialog, ThemeSettings } from './Settings/public-api.js';
-export type {
-  AccentColorSettingsProps,
-  SettingsDialogProps,
-  ThemeSettingsProps,
-} from './Settings/public-api.js';
-
-// Export
-export {
-  buildExportFilename,
-  DEFAULT_OPTIONS,
-  loadLastExportOptions,
-  runExport,
-  updateExportTargetExtension,
-  ExportToolbarControls,
-} from './Export/index.js';
-export type {
-  ExportDestinationControl,
-  ExportDestinationAdapter,
-  ExportDestinationTarget,
-  ExportToolbarControlsProps,
-  ExportFormat,
-  HtmlBundle,
-  HtmlStyle,
-  ExportOptions,
-  ExportBlobSaver,
-} from './Export/index.js';
-export { ExportDialog } from './Export/index.js';
-export type { ExportDialogProps } from './Export/index.js';
-
-// Hooks
-export { useDocumentSession } from './hooks/index.js';
-export type { UseDocumentSessionResult } from './hooks/index.js';

package/src/preferences/theme.ts

@@ -1,67 +0,0 @@
-/** Appearance preferences shared by the shell and settings UI. */
-
-export type ThemePreference = 'auto' | 'light' | 'dark';
-
-export const ACCENT_COLORS = [
-  'brown',
-  'green',
-  'blue',
-  'purple',
-  'maroon',
-  'orange',
-  'gray',
-] as const;
-
-export type AccentColor = (typeof ACCENT_COLORS)[number];
-
-/**
- * Chrome (titlebar) background per resolved theme. Keep in sync with
- * `--db-bg-subtle` for the default accent in styles/docblocks.css and with
- * the static `<meta name="theme-color">` values in the site's index.html.
- * The shell writes these into the theme-color metas so the installed web
- * app's titlebar (Window Controls Overlay caption area, Android status bar)
- * follows the resolved theme.
- */
-export const DB_CHROME_COLORS: Record<'light' | 'dark', string> = {
-  light: '#f3eede',
-  dark: '#262219',
-};
-
-const THEME_STORAGE_KEY = 'docblocks:themePreference';
-const ACCENT_STORAGE_KEY = 'docblocks:accentColor';
-
-export function loadThemePreference(): ThemePreference {
-  try {
-    const raw = localStorage.getItem(THEME_STORAGE_KEY);
-    if (raw === 'light' || raw === 'dark' || raw === 'auto') return raw;
-  } catch {
-    // ignore unavailable storage
-  }
-  return 'auto';
-}
-
-export function saveThemePreference(value: ThemePreference): void {
-  try {
-    localStorage.setItem(THEME_STORAGE_KEY, value);
-  } catch {
-    // ignore quota errors
-  }
-}
-
-export function loadAccentColor(): AccentColor {
-  try {
-    const raw = localStorage.getItem(ACCENT_STORAGE_KEY);
-    if (ACCENT_COLORS.some((color) => color === raw)) return raw as AccentColor;
-  } catch {
-    // ignore unavailable storage
-  }
-  return 'brown';
-}
-
-export function saveAccentColor(value: AccentColor): void {
-  try {
-    localStorage.setItem(ACCENT_STORAGE_KEY, value);
-  } catch {
-    // ignore quota errors
-  }
-}

package/src/preferences/versioning.ts

@@ -1,69 +0,0 @@
-/**
- * Versioning preferences — global default + per-workspace resolution.
- *
- * The global preference controls whether DocBlocks writes version
- * snapshots (under `<basename>_files/.versions/`) when editing. The
- * default is `'browser-only'` so local-folder workspaces stay clean by
- * default and only IndexedDB workspaces accumulate version history.
- *
- * Each workspace can override the global default with its own setting
- * stored on the WorkspaceDescriptor. `'inherit'` (or absent) defers to
- * the global preference; `'on'` / `'off'` force the behavior regardless.
- */
-
-import type { WorkspaceDescriptor } from '@bendyline/docblocks/workspace';
-
-export type VersioningPreference = 'on' | 'browser-only' | 'off';
-
-const STORAGE_KEY = 'docblocks:versioningPreference';
-const DEFAULT_PREFERENCE: VersioningPreference = 'browser-only';
-
-export function loadVersioningPreference(): VersioningPreference {
-  try {
-    const raw = localStorage.getItem(STORAGE_KEY);
-    if (raw === 'on' || raw === 'browser-only' || raw === 'off') return raw;
-  } catch {
-    // ignore
-  }
-  return DEFAULT_PREFERENCE;
-}
-
-export function saveVersioningPreference(value: VersioningPreference): void {
-  try {
-    localStorage.setItem(STORAGE_KEY, value);
-  } catch {
-    // ignore quota errors
-  }
-}
-
-/** Whether a workspace type is "local" (writes to a real folder on disk). */
-export function isLocalWorkspaceType(type: WorkspaceDescriptor['type']): boolean {
-  return type === 'native' || type === 'electron-native';
-}
-
-/**
- * Compute the effective versioning state for a workspace, honoring the
- * per-workspace override first and falling back to the global preference.
- *
- * Returns `false` whenever no workspace is provided so callers can use
- * this directly during initial render before a workspace loads.
- */
-export function resolveVersioningEnabled(
-  workspace: WorkspaceDescriptor | null,
-  globalPref: VersioningPreference,
-): boolean {
-  if (!workspace) return false;
-
-  const override = workspace.versioningOverride;
-  if (override === 'on') return true;
-  if (override === 'off') return false;
-
-  switch (globalPref) {
-    case 'on':
-      return true;
-    case 'off':
-      return false;
-    case 'browser-only':
-      return !isLocalWorkspaceType(workspace.type);
-  }
-}

package/src/provider-lease.ts

@@ -1,52 +0,0 @@
-import type { FileSystemProviderV2 } from '@bendyline/docblocks/filesystem';
-
-interface ProviderLeaseRecord {
-  holders: number;
-  generation: number;
-  disposePromise: Promise<void> | null;
-}
-
-const leases = new WeakMap<FileSystemProviderV2, ProviderLeaseRecord>();
-
-/**
- * Retain one UI ownership lease for a provider.
- *
- * Final release is deferred by one microtask. React Strict Mode intentionally
- * performs setup → cleanup → setup, so an immediate cleanup disposer would
- * permanently close the provider that the second setup still owns.
- */
-export function retainFileSystemProvider(provider: FileSystemProviderV2): () => void {
-  let record = leases.get(provider);
-  if (!record) {
-    record = { holders: 0, generation: 0, disposePromise: null };
-    leases.set(provider, record);
-  }
-  if (record.disposePromise) {
-    throw new Error('Cannot retain a filesystem provider after disposal has started.');
-  }
-
-  record.holders += 1;
-  record.generation += 1;
-  let released = false;
-  return () => {
-    if (released) return;
-    released = true;
-    record!.holders -= 1;
-    record!.generation += 1;
-    const releaseGeneration = record!.generation;
-    queueMicrotask(() => {
-      if (
-        record!.holders !== 0 ||
-        record!.generation !== releaseGeneration ||
-        record!.disposePromise
-      ) {
-        return;
-      }
-      record!.disposePromise = provider.dispose();
-      // React cleanup cannot await or render a disposal failure. Joiners still
-      // receive the original promise from the provider; this observer prevents
-      // an unhandled rejection during unmount.
-      void record!.disposePromise.catch(() => undefined);
-    });
-  };
-}

package/src/types/pwa-dom.d.ts

@@ -1,31 +0,0 @@
-/**
- * Ambient declarations for PWA browser APIs that TypeScript's lib.dom does
- * not ship yet: the Chromium install-prompt event and the launchQueue
- * file-handling API. Both are Chromium-only — always feature-detect before
- * use; on other engines the events simply never fire and `launchQueue` is
- * undefined.
- */
-
-interface BeforeInstallPromptEvent extends Event {
-  /** Shows the browser install prompt. Callable at most once per event. */
-  prompt(): Promise<void>;
-  readonly userChoice: Promise<{ outcome: 'accepted' | 'dismissed'; platform: string }>;
-}
-
-interface LaunchParams {
-  readonly files: ReadonlyArray<FileSystemFileHandle>;
-  readonly targetURL?: string;
-}
-
-interface LaunchQueue {
-  setConsumer(consumer: (params: LaunchParams) => void): void;
-}
-
-interface Window {
-  launchQueue?: LaunchQueue;
-}
-
-interface WindowEventMap {
-  beforeinstallprompt: BeforeInstallPromptEvent;
-  appinstalled: Event;
-}