zreader 0.0.0-stage → 0.1.0

package/dist/types-xkdpkPxA.d.ts

@@ -0,0 +1,147 @@
+/** Shared, framework-agnostic data model for zreader. */
+type ISODate = string;
+/** W3C Web Annotation-style anchor. Offsets are measured over the chapter root's text. */
+interface Anchor {
+    /** `data-block-id` of the block containing the start of the selection. */
+    blockId: string;
+    /** Offsets relative to the start block's text (fast path). */
+    blockStart: number;
+    /** TextPositionSelector over the whole chapter text. */
+    start: number;
+    end: number;
+    /** TextQuoteSelector. */
+    exact: string;
+    prefix: string;
+    suffix: string;
+    /** Content hash of the chapter when the anchor was created. */
+    contentHash?: string;
+}
+interface Highlight {
+    id: string;
+    bookId: string;
+    chapterId: string;
+    anchor: Anchor;
+    color: string;
+    note?: string;
+    createdAt: ISODate;
+    updatedAt: ISODate;
+}
+interface Bookmark {
+    id: string;
+    bookId: string;
+    chapterId: string;
+    /** Absent for whole-chapter bookmarks. */
+    blockId?: string;
+    label?: string;
+    excerpt?: string;
+    createdAt: ISODate;
+    updatedAt: ISODate;
+}
+interface ChapterProgress {
+    chapterId: string;
+    blockId?: string;
+    /** 0..1 */
+    percent: number;
+    completed: boolean;
+    updatedAt: ISODate;
+}
+interface BookProgress {
+    bookId: string;
+    chapters: Record<string, ChapterProgress>;
+    last?: {
+        chapterId: string;
+        blockId?: string;
+        updatedAt: ISODate;
+    };
+}
+type PadScope = {
+    kind: "global";
+} | {
+    kind: "book";
+    bookId: string;
+} | {
+    kind: "chapter";
+    bookId: string;
+    chapterId: string;
+};
+type PadScopeKind = PadScope["kind"];
+interface Pad {
+    /** Markdown is the interchange/source format. */
+    markdown: string;
+    /** Lossless editor JSON cache. Cleared whenever `markdown` is changed outside the editor. */
+    json?: unknown;
+    updatedAt: ISODate;
+}
+type ThemeName = "system" | "light" | "sepia" | "dark";
+type Measure = "narrow" | "normal" | "wide";
+type FontFamily = "serif" | "sans" | "mono";
+type TextSize = "sm" | "base" | "lg" | "xl" | "2xl";
+type Leading = "tight" | "normal" | "relaxed";
+declare const THEMES: readonly ["system", "light", "sepia", "dark"];
+declare const TEXT_SIZES: readonly ["sm", "base", "lg", "xl", "2xl"];
+declare const LEADINGS: readonly ["tight", "normal", "relaxed"];
+declare const MEASURES: readonly ["narrow", "normal", "wide"];
+declare const FONT_FAMILIES: readonly ["serif", "sans", "mono"];
+/** The palette the UI ships styles for (`::highlight(zr-<color>)`). */
+declare const HIGHLIGHT_COLORS: readonly ["yellow", "green", "blue", "pink", "purple", "orange"];
+type HighlightColor = (typeof HIGHLIGHT_COLORS)[number];
+interface ReaderSettings {
+    textSize: TextSize;
+    leading: Leading;
+    measure: Measure;
+    fontFamily: FontFamily;
+    /** Tap a sentence to highlight it with the default colour. */
+    highlightMode: boolean;
+    updatedAt: ISODate;
+}
+/** Serializable client options (the `reader` half of reader.config.ts). */
+interface ReaderClientOptions {
+    storagePrefix: string;
+    highlightColors: HighlightColor[];
+    defaultHighlightColor: HighlightColor;
+    scratchpad: {
+        enabled: boolean;
+        scopes: PadScopeKind[];
+    };
+    /** Themes offered in the UI. Applied as a class on <html> via next-themes. */
+    themes: ThemeName[];
+    defaultTheme: ThemeName;
+    defaultSettings: Omit<ReaderSettings, "updatedAt">;
+    progress: {
+        completeAt: number;
+        saveIntervalMs: number;
+    };
+    /** Show a "your notes only live in this browser" reminder. */
+    backupReminder: boolean;
+    /** Base path used to build links back into the reader (e.g. quote-to-pad). */
+    basePath: string;
+}
+interface TocEntry {
+    id: string;
+    depth: number;
+    text: string;
+}
+interface ChapterMeta {
+    id: string;
+    title: string;
+    order: number;
+    description?: string;
+    /** Section the chapter belongs to, e.g. "Part I · For the Builders". Groups the contents list. */
+    part?: string;
+    /** Eyebrow shown above the title, e.g. "Chapter 5" or "Appendix A". */
+    label?: string;
+    /** Short marker for lists, e.g. "5" or "A". */
+    number?: string;
+}
+interface BookMeta {
+    id: string;
+    title: string;
+    subtitle?: string;
+    authors: string[];
+    description?: string;
+    cover?: string;
+    chapters: ChapterMeta[];
+}
+
+export { FONT_FAMILIES as F, LEADINGS as L, MEASURES as M, HIGHLIGHT_COLORS as g, TEXT_SIZES as l, THEMES as m };
+export type { Anchor as A, BookMeta as B, ChapterMeta as C, Highlight as H, ISODate as I, Pad as P, ReaderClientOptions as R, TocEntry as T, ReaderSettings as a, BookProgress as b, Bookmark as c, PadScope as d, ChapterProgress as e, FontFamily as f, HighlightColor as h, Leading as i, Measure as j, PadScopeKind as k, TextSize as n, ThemeName as o };

package/dist/user-config/index.d.ts

@@ -0,0 +1,17 @@
+import { R as ReaderUserConfig } from '../index-Bp5oIiZd.js';
+import 'zod/v4';
+import '../types-xkdpkPxA.js';
+
+/**
+ * Fallback for `zreader/user-config`.
+ *
+ * In Next.js, `withReader()` aliases this specifier straight to the project's
+ * reader.config.ts (or to `zreader/empty-config`), so this file is
+ * only used in plain Node: scripts, tests, other frameworks. It discovers
+ * reader.config.* from `process.cwd()` and loads it with jiti.
+ */
+
+declare const config: ReaderUserConfig;
+declare const configFile: string | null;
+
+export { ReaderUserConfig, configFile, config as default };

package/dist/user-config/index.js

@@ -0,0 +1,35 @@
+import { CONFIG_FILE_NAMES } from '../chunk-RNSAFDZ5.js';
+import '../chunk-DYQNGV46.js';
+import { existsSync } from 'fs';
+import { resolve, join, dirname } from 'path';
+
+function findConfigFile(from = process.cwd()) {
+  let dir = resolve(from);
+  for (; ; ) {
+    for (const name of CONFIG_FILE_NAMES) {
+      const p = join(dir, name);
+      if (existsSync(p)) return p;
+    }
+    if (existsSync(join(dir, "package.json")) || existsSync(join(dir, ".git"))) return null;
+    const parent = dirname(dir);
+    if (parent === dir) return null;
+    dir = parent;
+  }
+}
+async function loadConfigFile(file2) {
+  const { createJiti } = await import('jiti');
+  const jiti = createJiti(file2, { interopDefault: true, moduleCache: false });
+  const mod = await jiti.import(file2);
+  const cfg = mod && typeof mod === "object" && "default" in mod ? mod.default : mod;
+  return cfg ?? {};
+}
+
+// src/user-config/index.ts
+var file = findConfigFile(process.cwd());
+var config = file ? await loadConfigFile(file) : {};
+var configFile = file;
+var user_config_default = config;
+
+export { configFile, user_config_default as default };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/user-config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/config/load.ts","../../src/user-config/index.ts"],"names":["file"],"mappings":";;;;;AAMO,SAAS,cAAA,CAAe,IAAA,GAAe,OAAA,CAAQ,GAAA,EAAI,EAAkB;AAC1E,EAAA,IAAI,GAAA,GAAM,QAAQ,IAAI,CAAA;AACtB,EAAA,WAAS;AACP,IAAA,KAAA,MAAW,QAAQ,iBAAA,EAAmB;AACpC,MAAA,MAAM,CAAA,GAAI,IAAA,CAAK,GAAA,EAAK,IAAI,CAAA;AACxB,MAAA,IAAI,UAAA,CAAW,CAAC,CAAA,EAAG,OAAO,CAAA;AAAA,IAC5B;AACA,IAAA,IAAI,UAAA,CAAW,IAAA,CAAK,GAAA,EAAK,cAAc,CAAC,CAAA,IAAK,UAAA,CAAW,IAAA,CAAK,GAAA,EAAK,MAAM,CAAC,CAAA,EAAG,OAAO,IAAA;AACnF,IAAA,MAAM,MAAA,GAAS,QAAQ,GAAG,CAAA;AAC1B,IAAA,IAAI,MAAA,KAAW,KAAK,OAAO,IAAA;AAC3B,IAAA,GAAA,GAAM,MAAA;AAAA,EACR;AACF;AAEA,eAAsB,eAAeA,KAAAA,EAAyC;AAC5E,EAAA,MAAM,EAAE,UAAA,EAAW,GAAI,MAAM,OAAO,MAAM,CAAA;AAC1C,EAAA,MAAM,IAAA,GAAO,WAAWA,KAAAA,EAAM,EAAE,gBAAgB,IAAA,EAAM,WAAA,EAAa,OAAO,CAAA;AAC1E,EAAA,MAAM,GAAA,GAAO,MAAM,IAAA,CAAK,MAAA,CAAOA,KAAI,CAAA;AACnC,EAAA,MAAM,GAAA,GAAO,OAAO,OAAO,GAAA,KAAQ,YAAY,SAAA,IAAa,GAAA,GAAM,IAAI,OAAA,GAAU,GAAA;AAChF,EAAA,OAAO,OAAO,EAAC;AACjB;;;ACfA,IAAM,IAAA,GAAO,cAAA,CAAe,OAAA,CAAQ,GAAA,EAAK,CAAA;AACzC,IAAM,SAA2B,IAAA,GAAO,MAAM,cAAA,CAAe,IAAI,IAAI,EAAC;AAE/D,IAAM,UAAA,GAA4B;AACzC,IAAO,mBAAA,GAAQ","file":"index.js","sourcesContent":["/** Node-only helpers for locating and loading reader.config.* (via jiti). */\nimport { existsSync } from \"node:fs\";\nimport { dirname, join, resolve } from \"node:path\";\nimport { CONFIG_FILE_NAMES, type ReaderUserConfig } from \"./index\";\n\n/** Search `from` and its parents (up to the filesystem root or a `.git` dir) for reader.config.*. */\nexport function findConfigFile(from: string = process.cwd()): string | null {\n  let dir = resolve(from);\n  for (;;) {\n    for (const name of CONFIG_FILE_NAMES) {\n      const p = join(dir, name);\n      if (existsSync(p)) return p;\n    }\n    if (existsSync(join(dir, \"package.json\")) || existsSync(join(dir, \".git\"))) return null;\n    const parent = dirname(dir);\n    if (parent === dir) return null;\n    dir = parent;\n  }\n}\n\nexport async function loadConfigFile(file: string): Promise<ReaderUserConfig> {\n  const { createJiti } = await import(\"jiti\");\n  const jiti = createJiti(file, { interopDefault: true, moduleCache: false });\n  const mod = (await jiti.import(file)) as { default?: ReaderUserConfig } | ReaderUserConfig;\n  const cfg = (mod && typeof mod === \"object\" && \"default\" in mod ? mod.default : mod) as ReaderUserConfig | undefined;\n  return cfg ?? {};\n}\n","/**\n * Fallback for `zreader/user-config`.\n *\n * In Next.js, `withReader()` aliases this specifier straight to the project's\n * reader.config.ts (or to `zreader/empty-config`), so this file is\n * only used in plain Node: scripts, tests, other frameworks. It discovers\n * reader.config.* from `process.cwd()` and loads it with jiti.\n */\nimport type { ReaderUserConfig } from \"../config/index\";\nimport { findConfigFile, loadConfigFile } from \"../config/load\";\n\nconst file = findConfigFile(process.cwd());\nconst config: ReaderUserConfig = file ? await loadConfigFile(file) : {};\n\nexport const configFile: string | null = file;\nexport default config;\nexport type { ReaderUserConfig };\n"]}

package/dist/virtual-config/index.d.ts

@@ -0,0 +1,6 @@
+import { ResolvedReaderConfig } from 'zreader/config';
+export { ResolvedReaderConfig } from 'zreader/config';
+
+declare const config: ResolvedReaderConfig;
+
+export { config as default };

package/dist/virtual-config/index.js

@@ -0,0 +1,10 @@
+import userConfig from 'zreader/user-config';
+import { resolveConfig } from 'zreader/config';
+
+// src/virtual-config/index.ts
+var config = resolveConfig(userConfig, null, { source: "reader.config" });
+var virtual_config_default = config;
+
+export { virtual_config_default as default };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/virtual-config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/virtual-config/index.ts"],"names":[],"mappings":";;;;AASA,IAAM,SAA+B,aAAA,CAAc,UAAA,EAAY,MAAM,EAAE,MAAA,EAAQ,iBAAiB,CAAA;AAEhG,IAAO,sBAAA,GAAQ","file":"index.js","sourcesContent":["/**\n * `zreader/virtual-config` — the fully resolved, validated config.\n *\n * `zreader/user-config` is resolved by the *app's* bundler, which\n * `withReader()` points at the project's reader.config.ts. Server-only.\n */\nimport userConfig from \"zreader/user-config\";\nimport { resolveConfig, type ResolvedReaderConfig } from \"zreader/config\";\n\nconst config: ResolvedReaderConfig = resolveConfig(userConfig, null, { source: \"reader.config\" });\n\nexport default config;\nexport type { ResolvedReaderConfig };\n"]}

package/package.json

@@ -1,6 +1,227 @@
 {
   "name": "zreader",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "A localStorage-first, mobile-first book reader: chapters, bookmarks, sentence highlights, notes, reading progress and a WYSIWYG markdown scratchpad.",
+  "license": "MIT",
+  "author": "Alchemyst AI",
+  "homepage": "https://github.com/alchemyst-ai/zreader#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alchemyst-ai/zreader.git"
+  },
+  "bugs": {
+    "url": "https://github.com/alchemyst-ai/zreader/issues"
+  },
+  "type": "module",
+  "sideEffects": [
+    "*.css"
+  ],
+  "keywords": [
+    "reader",
+    "ebook",
+    "lms",
+    "highlights",
+    "bookmarks",
+    "localStorage",
+    "markdown",
+    "mdx",
+    "tiptap",
+    "nextjs",
+    "book-reader",
+    "react",
+    "react-19",
+    "shadcn"
+  ],
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/core/index.d.ts",
+      "default": "./dist/core/index.js"
+    },
+    "./config": {
+      "import": {
+        "types": "./dist/config/index.d.ts",
+        "default": "./dist/config/index.js"
+      },
+      "require": {
+        "types": "./dist/config/index.d.cts",
+        "default": "./dist/config/index.cjs"
+      }
+    },
+    "./next": {
+      "import": {
+        "types": "./dist/next/index.d.ts",
+        "default": "./dist/next/index.js"
+      },
+      "require": {
+        "types": "./dist/next/index.d.cts",
+        "default": "./dist/next/index.cjs"
+      }
+    },
+    "./next/client": {
+      "types": "./dist/next/client/index.d.ts",
+      "default": "./dist/next/client/index.js"
+    },
+    "./next/server": {
+      "types": "./dist/next/server/index.d.ts",
+      "browser": "./dist/stubs/server-only.js",
+      "default": "./dist/next/server/index.js"
+    },
+    "./content": {
+      "types": "./dist/content/index.d.ts",
+      "browser": "./dist/stubs/server-only.js",
+      "default": "./dist/content/index.js"
+    },
+    "./rehype": {
+      "types": "./dist/rehype/index.d.ts",
+      "default": "./dist/rehype/index.js"
+    },
+    "./virtual-config": {
+      "types": "./dist/virtual-config/index.d.ts",
+      "browser": "./dist/stubs/server-only.js",
+      "default": "./dist/virtual-config/index.js"
+    },
+    "./user-config": {
+      "types": "./dist/user-config/index.d.ts",
+      "browser": "./dist/stubs/server-only.js",
+      "default": "./dist/user-config/index.js"
+    },
+    "./empty-config": {
+      "types": "./dist/stubs/empty-config.d.ts",
+      "default": "./dist/stubs/empty-config.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "default": "./dist/react/index.js"
+    },
+    "./editor": {
+      "types": "./dist/editor/index.d.ts",
+      "default": "./dist/editor/index.js"
+    },
+    "./styles.css": "./dist/styles.css",
+    "./tailwind.css": "./dist/tailwind.css",
+    "./reader.css": "./dist/reader.css",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "node scripts/clean.mjs && tsup && node scripts/use-client.mjs && node scripts/check-bundles.mjs && npm run build:css",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint:pkg": "publint && node scripts/attw.mjs",
+    "prepublishOnly": "npm run typecheck && npm run test && npm run build && npm run lint:pkg",
+    "build:css": "tailwindcss -i src/styles.css -o dist/styles.css --minify && node scripts/unlayer-css.mjs && node scripts/copy-css.mjs"
+  },
+  "engines": {
+    "node": ">=20.9.0"
+  },
+  "dependencies": {
+    "@mdx-js/mdx": "^3.1.1",
+    "@tailwindcss/typography": "^0.5.20",
+    "@types/hast": "^3.0.4",
+    "approx-string-match": "^2.0.1",
+    "class-variance-authority": "^0.7.1",
+    "cn": "^0.5.1",
+    "github-slugger": "^2.0.0",
+    "gray-matter": "^4.0.3",
+    "hast-util-to-string": "^3.0.1",
+    "isomorphic-dompurify": "^4.6.0",
+    "jiti": "^2.7.0",
+    "lucide-react": "^1.66.0",
+    "next-themes": "^0.4.6",
+    "radix-ui": "^1.8.1",
+    "react-resizable-panels": "^4.16.1",
+    "rehype-parse": "^9.0.1",
+    "rehype-raw": "^7.0.0",
+    "rehype-stringify": "^10.0.1",
+    "remark-gfm": "^4.0.1",
+    "remark-parse": "^11.0.0",
+    "remark-rehype": "^11.1.2",
+    "sonner": "^2.0.8",
+    "tinyglobby": "^0.2.17",
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.2.0",
+    "vaul": "^1.1.2",
+    "vfile": "^6.0.3",
+    "zod": "^3.25.0 || ^4.0.0"
+  },
+  "peerDependencies": {
+    "@tiptap/core": "^3.0.0",
+    "@tiptap/extension-list": "^3.0.0",
+    "@tiptap/extensions": "^3.0.0",
+    "@tiptap/markdown": "^3.0.0",
+    "@tiptap/pm": "^3.0.0",
+    "@tiptap/react": "^3.0.0",
+    "@tiptap/starter-kit": "^3.0.0",
+    "next": ">=15.3.0",
+    "react": ">=19.0.0",
+    "react-dom": ">=19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@tiptap/core": {
+      "optional": true
+    },
+    "@tiptap/extension-list": {
+      "optional": true
+    },
+    "@tiptap/extensions": {
+      "optional": true
+    },
+    "@tiptap/markdown": {
+      "optional": true
+    },
+    "@tiptap/pm": {
+      "optional": true
+    },
+    "@tiptap/react": {
+      "optional": true
+    },
+    "@tiptap/starter-kit": {
+      "optional": true
+    },
+    "next": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@tailwindcss/cli": "^4.3.3",
+    "@tiptap/core": "^3.32.2",
+    "@tiptap/extension-list": "^3.32.2",
+    "@tiptap/extensions": "^3.32.2",
+    "@tiptap/markdown": "^3.32.2",
+    "@tiptap/pm": "^3.32.2",
+    "@tiptap/react": "^3.32.2",
+    "@tiptap/starter-kit": "^3.32.2",
+    "@types/node": "^22.19.0",
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "happy-dom": "^21.0.4",
+    "next": "16.3.5",
+    "postcss": "^8.5.32",
+    "publint": "^0.3.25",
+    "react": "19.3.0",
+    "react-dom": "19.3.0",
+    "tailwindcss": "^4.3.3",
+    "tsup": "^9.0.0",
+    "tw-animate-css": "^1.4.0",
+    "typescript": "^5.9.3",
+    "vitest": "^5.0.5",
+    "zod": "^3.25.76"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}