bible-note 0.4.4 → 0.5.0

package/types/storageManager.d.ts

@@ -1,12 +1,32 @@
+/**
+ * Where the editor keeps its own state — settings, comments, read-only mode,
+ * zoom, panel state — as string values under the keys in
+ * `BIBLE_NOTE_STORAGE_MANAGER_KEYS`. The note itself goes through
+ * `loadData` / `saveData` instead. Every key is read once, before the editor
+ * first renders; writes are fire-and-forget.
+ */
 export type BibleNoteStorageManager = {
+    /** Stores `value` (a string, or a value to `JSON.stringify`) under `key`. */
     setSetting(key: string, value: unknown): Promise<void>;
+    /** The value stored under `key`, or `null` when there is none. */
     getSetting<T = unknown>(key: string): Promise<T | null>;
+    /** Removes `key`. */
     deleteSetting(key: string): Promise<void>;
 };
 type BibleNoteStorage = Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>;
+/**
+ * Every key the editor reads from its storage manager before it renders. A
+ * host-side store that needs to know its keys up front (to prefetch or migrate
+ * them) can use this list.
+ */
 export declare const BIBLE_NOTE_STORAGE_MANAGER_KEYS: readonly ["lexical-playground-settings", "lexical-playground-editor-state", "lexical-playground-comments", "lexical-playground-comments-panel-open", "lexical-playground-block-text-links", "lexical-playground-read-only-mode", "lexical-playground-insert-character-picker", "lexical-playground-editor-zoom-percent"];
 export declare function configureBibleNoteStorageManager(storageManager?: BibleNoteStorageManager): void;
 export declare function hydrateBibleNoteStorageManager(keys: ReadonlyArray<string>): Promise<void>;
 export declare function getBibleNoteStorage(): BibleNoteStorage | null;
+/**
+ * A `BibleNoteStorageManager` backed by `window.localStorage`. Non-string
+ * values are stored as JSON; when `localStorage` is unavailable every call is
+ * a no-op.
+ */
 export declare function createBrowserStorageManager(): BibleNoteStorageManager;
 export {};

package/types/utils/filePathResolver.d.ts

@@ -1,8 +1,15 @@
+/** How a media file reached the editor: dropped/pasted, or picked in the media dialog. */
 export type FilePathSource = 'drop' | 'file-input';
+/** Context passed to a `FilePathResolver`. */
 export type FilePathResolverContext = Readonly<{
     source: FilePathSource;
 }>;
+/**
+ * Maps a media file to the path or URL the note should reference. Return
+ * `null` (or throw) to let the editor embed the file as a data URL instead.
+ */
 export type FilePathResolver = (file: File, context: FilePathResolverContext) => Promise<string | null> | string | null;
+/** Shows a local media file to the user, e.g. in the system file manager. */
 export type FileRevealer = (filePath: string) => Promise<void> | void;
 export declare function getFallbackFilePath(file: File): string;
 export declare function resolveMediaFilePath(resolver: FilePathResolver | undefined, file: File, source: FilePathSource): Promise<string | null>;

package/types/utils/fontFamilyOptions.d.ts

@@ -5,11 +5,17 @@
  * LICENSE file in the root directory of this source tree.
  *
  */
+/** A font in the toolbar's font menu: `[fontFamily, label, languageCode]`. */
 export type FontFamilyOption = readonly [
     fontFamily: string,
     label: string,
     language: string
 ];
+/**
+ * A host font added to the editor: `[fontFamily, languageCode]`, e.g.
+ * `['Battambang', 'km']`. The language code is what `getLangCode` returns
+ * for text that should use this font.
+ */
 export type ExtraFontFamilyOption = readonly [
     fontFamily: string,
     language: string