weread-export 0.1.2

package/lib/types/api.d.ts

@@ -0,0 +1,238 @@
+/**
+ * weread-export — WeRead Skills Agent Gateway client.
+ *
+ * Official interface: POST https://i.weread.qq.com/api/agent/gateway with
+ * `Authorization: Bearer <wrk-...>`; the body carries `api_name`,
+ * `skill_version` and business parameters flattened at the top level.
+ * Responses are field-trimmed by the service; `errcode !== 0` means an
+ * error with a Chinese message, and an `upgrade_info` field means the
+ * client's skill_version is stale and must be bumped.
+ *
+ * API key acquisition: open https://weread.qq.com/r/weread-skills, log in
+ * with your WeRead account, click 创建 Key, copy the wrk- key.
+ */
+/** Gateway endpoint. */
+export declare const WEREAD_GATEWAY = "https://i.weread.qq.com/api/agent/gateway";
+/** Skill version reported on every request (mirrors the weread-skills pack). */
+export declare const SKILL_VERSION = "1.0.4";
+/** Error surfaced from the gateway (carries an optional errcode). */
+export declare class WereadApiError extends Error {
+    code?: number;
+    constructor(message: string, code?: number);
+}
+/**
+ * WeRead Skills gateway client. All methods resolve parsed payloads and
+ * throw WereadApiError for API-level failures.
+ */
+export declare class WereadApi {
+    private readonly apiKey;
+    constructor(apiKey: string);
+    /**
+     * Call one gateway endpoint.
+     * @param apiName - interface name, e.g. '/store/search' or '/_list'.
+     * @param params - business parameters, flattened at the top level.
+     */
+    gateway<T = Record<string, unknown>>(apiName: string, params?: Record<string, unknown>): Promise<T>;
+    /** List every available endpoint and its parameter definition. */
+    list(): Promise<Record<string, unknown>>;
+    /** Search the book store. */
+    search(keyword: string, count?: number, scope?: number): Promise<SearchResponse>;
+    /** Book metadata. */
+    bookInfo(bookId: string): Promise<BookInfo>;
+    /** Official chapter catalog (metadata only). */
+    chapterInfo(bookId: string): Promise<ChapterInfoResponse>;
+    /** Reading progress for one book. */
+    getProgress(bookId: string): Promise<ProgressResponse>;
+    /** The current bookshelf (books + audiobook albums + mp). */
+    shelf(): Promise<ShelfResponse>;
+    /** Notebook overview: every book with note/review/bookmark counts. */
+    notebooks(count?: number, lastSort?: number): Promise<NotebooksResponse>;
+    /** Underlines (highlights) for one book. */
+    bookmarklist(bookId: string): Promise<BookmarkListResponse>;
+    /** Personal thoughts/reviews for one book. */
+    reviewListMine(bookid: string, count?: number, synckey?: number): Promise<ReviewListMineResponse>;
+    /** Reading statistics. mode: weekly | monthly | annually | overall. */
+    readdata(mode: string, baseTime?: number): Promise<ReadDataResponse>;
+}
+export interface SearchResponse {
+    sid?: string;
+    /** 1=有更多, 0=无. */
+    hasMore?: number | boolean;
+    results?: SearchResult[];
+}
+export interface SearchResult {
+    title?: string;
+    scope?: number;
+    books?: SearchBookEntry[];
+}
+export interface SearchBookEntry {
+    searchIdx?: number;
+    bookInfo?: BookInfo;
+    newRating?: number;
+    newRatingCount?: number;
+    readingCount?: number;
+    deepLink?: string;
+}
+export interface BookInfo {
+    bookId?: string;
+    title?: string;
+    author?: string;
+    translator?: string;
+    cover?: string;
+    intro?: string;
+    category?: string;
+    publisher?: string;
+    publishTime?: string;
+    isbn?: string;
+    wordCount?: number;
+    newRating?: number;
+    newRatingCount?: number;
+    deepLink?: string;
+}
+export interface ChapterInfoResponse {
+    bookId?: string;
+    synckey?: number;
+    chapterUpdateTime?: number;
+    chapters?: Chapter[];
+}
+export interface Chapter {
+    chapterUid?: number;
+    chapterIdx?: number;
+    title?: string;
+    wordCount?: number;
+    level?: number;
+    updateTime?: number;
+    price?: number;
+    paid?: boolean;
+    isMPChapter?: boolean;
+    anchors?: unknown;
+}
+export interface ProgressResponse {
+    bookId?: string;
+    book?: ProgressBook;
+    timestamp?: number;
+}
+export interface ProgressBook {
+    chapterUid?: number;
+    chapterOffset?: number;
+    /** 0–100 integer (1 means 1%, not complete). */
+    progress?: number;
+    updateTime?: number;
+    recordReadingTime?: number;
+    finishTime?: number;
+    isStartReading?: boolean;
+}
+export interface ShelfResponse {
+    books?: ShelfBook[];
+    albums?: ShelfAlbum[];
+    mp?: unknown;
+    archive?: unknown[];
+    bookCount?: number;
+}
+export interface ShelfBook {
+    bookId?: string;
+    title?: string;
+    author?: string;
+    cover?: string;
+    category?: string;
+    readUpdateTime?: number;
+    /** 1=读完 (the gateway returns 1/0). */
+    finishReading?: boolean | number;
+    secret?: boolean | number;
+    deepLink?: string;
+}
+export interface ShelfAlbum {
+    albumInfo?: {
+        albumId?: string;
+        name?: string;
+        authorName?: string;
+        cover?: string;
+        trackCount?: number;
+    };
+    albumInfoExtra?: {
+        secret?: boolean;
+    };
+}
+export interface NotebooksResponse {
+    totalBookCount?: number;
+    totalNoteCount?: number;
+    /** 1=有更多, 0=无. */
+    hasMore?: number | boolean;
+    books?: NotebookEntry[];
+}
+export interface NotebookEntry {
+    bookId?: string;
+    book?: {
+        title?: string;
+        author?: string;
+        cover?: string;
+    };
+    /** 想法/点评数（划线想法、章节点评、书评等） */
+    reviewCount?: number;
+    /** 划线数（高亮原文条数） */
+    noteCount?: number;
+    /** 书签数（仅统计，不导出内容） */
+    bookmarkCount?: number;
+    readingProgress?: number;
+    markedStatus?: number;
+    sort?: number;
+}
+export interface BookmarkListResponse {
+    updated?: Highlight[];
+    chapters?: Chapter[];
+    book?: unknown;
+}
+export interface Highlight {
+    bookmarkId?: string;
+    bookId?: string;
+    chapterUid?: number;
+    markText?: string;
+    createTime?: number;
+    type?: number;
+    range?: string;
+    colorStyle?: number;
+}
+export interface ReviewListMineResponse {
+    reviews?: MineReviewEntry[];
+    totalCount?: number;
+    /** 1=有更多, 0=无. */
+    hasMore?: number | boolean;
+    synckey?: number;
+}
+export interface MineReviewEntry {
+    review?: {
+        reviewId?: string;
+        content?: string;
+        /** 想法对应的划线原文（划线想法时有值） */
+        abstract?: string;
+        /** 划线原文位置范围，如 "2959-3007" */
+        range?: string;
+        chapterUid?: number;
+        createTime?: number;
+        star?: number;
+        chapterName?: string;
+        isFinish?: boolean;
+    };
+}
+export interface ReadDataResponse {
+    baseTime?: number;
+    readTimes?: unknown;
+    dailyReadTimes?: unknown;
+    readDays?: number;
+    totalReadTime?: number;
+    dayAverageReadTime?: number;
+    compare?: unknown;
+    readLongest?: unknown[];
+    readStat?: unknown[];
+    preferCategory?: unknown[];
+    preferTime?: unknown[];
+    preferTimeWord?: string;
+    preferAuthor?: unknown[];
+    /** 文字阅读占比（%），约 wrReadTime/(wrReadTime+wrListenTime)*100 */
+    readRate?: number;
+    wrReadTime?: number;
+    wrListenTime?: number;
+    /** 好友排行：{ text, scheme } */
+    rank?: unknown;
+    yearReport?: unknown;
+}

package/lib/types/cache.d.ts

@@ -0,0 +1,57 @@
+/**
+ * weread-export — local sync snapshot & render helpers.
+ *
+ * weread_sync pulls the bookshelf and the notebook overview into
+ * ~/.dsh/weread-export-cache.json (mode 0600) so the settings panel and
+ * quick actions can render without hammering the gateway. Markdown
+ * builders here are shared by the tools and the panel routes.
+ */
+import type { WereadApi, ShelfBook, NotebookEntry, Highlight, Chapter, MineReviewEntry } from './api.ts';
+/** Persistent snapshot shape. */
+export interface WereadCache {
+    updatedAt: string;
+    shelfBooks: ShelfBook[];
+    albumsCount: number;
+    mpCount: number;
+    notebooks: NotebookEntry[];
+}
+/** Empty snapshot. */
+export declare function emptyCache(): WereadCache;
+/** Read the snapshot (never throws). */
+export declare function readCache(): Promise<WereadCache>;
+/** Persist the snapshot (mode 0600). */
+export declare function writeCache(next: WereadCache): Promise<void>;
+/** Pull shelf + notebooks into the snapshot. */
+export declare function doSync(api: WereadApi): Promise<{
+    ok: boolean;
+    message: string;
+    cache: WereadCache;
+}>;
+/** Unix seconds → 'YYYY-MM-DD' (local); '' for missing values. */
+export declare function formatDate(ts?: number): string;
+/** Local date label 'YYYY-MM-DD（周X）'. */
+export declare function dateLabel(date: Date): string;
+/** Seconds → 'X小时Y分钟' / 'N分钟' / 'N秒'. */
+export declare function formatDuration(seconds?: number): string;
+/** Rating display: the gateway returns a 0-100 score; show as 0-10. */
+export declare function formatRating(n?: number): string;
+/** Book detail deep link, preferring the service-provided one. */
+export declare function deepLink(bookId?: string, provided?: string): string;
+/** ChapterUid → title map for note rendering. */
+export declare function chapterTitleMap(chapters: Chapter[] | undefined): Map<number, string>;
+/** One-line shelf entry. */
+export declare function shelfLine(book: ShelfBook, progressByBookId: Map<string, number>): string;
+/** Notebook overview lines (笔记数 = 划线 + 想法 + 书签). */
+export declare function notebookLines(entries: NotebookEntry[]): string[];
+/** Per-book notes markdown: highlights + thoughts. */
+export declare function buildNotesMarkdown(title: string, author: string, highlights: Highlight[], thoughts: MineReviewEntry[], chapters: Chapter[] | undefined): string;
+/** One flomo memo body for a book's highlights (truncated at `limit`). */
+export declare function buildFlomoMemo(title: string, highlights: Highlight[], chapters: Chapter[] | undefined, total: number, limit: number): string;
+/** Safe per-memo size cap (flomo does not document a hard limit; stay conservative). */
+export declare const FLOMO_MAX_CHARS = 1800;
+/**
+ * Split a book's highlights into one or more flomo memo bodies so that
+ * ALL highlights are exported — long lists are chunked by character count,
+ * never truncated. A single over-long highlight becomes its own memo.
+ */
+export declare function buildFlomoMemos(title: string, highlights: Highlight[], chapters: Chapter[] | undefined, maxChars?: number): string[];

package/lib/types/client/WereadSettingsPanel.d.ts

@@ -0,0 +1,2 @@
+/** The WeRead settings panel component. */
+export declare function WereadSettingsPanel(): JSX.Element;

package/lib/types/client/api.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Browser-side API client for the /api/weread-export route family. The only
+ * data access path the settings panel uses — plain fetch, same origin.
+ */
+/** Public config view (mirrors the host contract). */
+export interface WereadConfigView {
+    configured: boolean;
+    apiKeyMasked: string;
+    defaultFlomoTag: string;
+    /** 0 = export ALL highlights; N > 0 = cap at N. */
+    exportLimit: number;
+    exportDest: string;
+    localExportDir: string;
+    notionConfigured: boolean;
+    notionTargetPageId: string;
+    usePrompt: boolean;
+    llmConfigured: boolean;
+    llmBaseUrl: string;
+    llmModel: string;
+    lastSyncAt: string;
+    configPath: string;
+}
+/** Status view with cache + flomo stats. */
+export interface WereadStatusView extends WereadConfigView {
+    flomoConfigured: boolean;
+    cachedShelfBooks: number;
+    cachedNoteBooks: number;
+    cacheUpdatedAt: string;
+}
+/** Sync result. */
+export interface WereadSyncResult {
+    ok: boolean;
+    message: string;
+    shelfBooks: number;
+    notebooks: number;
+}
+/** One cached book for the export picker. */
+export interface WereadBook {
+    bookId: string;
+    title: string;
+    author: string;
+}
+/** Flomo export result. */
+export interface WereadFlomoResult {
+    ok: boolean;
+    message: string;
+    sent: number;
+    memoCount?: number;
+    bookId?: string;
+}
+/** Error carrying the route's JSON error message. */
+export declare class WereadApiError extends Error {
+    constructor(message: string);
+}
+/** The weread panel API. */
+export declare class WereadApi {
+    getConfig(): Promise<WereadConfigView>;
+    setConfig(patch: Record<string, unknown>): Promise<WereadConfigView>;
+    getStatus(): Promise<WereadStatusView>;
+    test(): Promise<{
+        ok: boolean;
+        message: string;
+    }>;
+    sync(): Promise<WereadSyncResult>;
+    books(): Promise<WereadBook[]>;
+    exportFlomo(bookId: string, tag: string, limit?: number): Promise<WereadFlomoResult>;
+    /** Multi-target export: flomo / local / notion with optional prompt. */
+    exportData(body: Record<string, unknown>): Promise<WereadFlomoResult>;
+}

package/lib/types/client/index.d.ts

@@ -0,0 +1,8 @@
+import type { ClientContext } from '@deepseek-ai/dsh-client-runtime/client';
+/** Required services. */
+export declare const inject: string[];
+/**
+ * Register the WeRead settings page.
+ * @param ctx - client root context.
+ */
+export declare function apply(ctx: ClientContext): void;

package/lib/types/export.d.ts

@@ -0,0 +1,45 @@
+/**
+ * weread-export — unified export targets.
+ *
+ * One pipeline, three destinations: flomo, local file, Notion page.
+ * Highlights (+ thoughts) are rendered to markdown, optionally processed by
+ * the configured LLM prompt, then delivered to the selected target. The
+ * flomo path reuses the dsh-flomo credentials file; the Notion path uses
+ * this plugin's own token + parent page; the local path writes a .md file
+ * to a user-supplied directory (no default — the caller must provide it).
+ */
+import type { Highlight, MineReviewEntry, Chapter } from './api.ts';
+import type { LlmConfig } from './llm.ts';
+/** Render full export markdown: highlights + thoughts with chapter/time. */
+export declare function buildExportMarkdown(title: string, author: string, highlights: Highlight[], thoughts: MineReviewEntry[], chapters: Chapter[] | undefined): string;
+/** Run export text through the configured LLM prompt. */
+export declare function processWithPrompt(llm: LlmConfig, promptTemplate: string, vars: {
+    title: string;
+    author: string;
+    highlights: string;
+    thoughts: string;
+}): Promise<string>;
+/** Write content to <dir>/<title>.md; creates the directory. */
+export declare function exportToLocal(dir: string, title: string, content: string): Promise<string>;
+/** Notion REST base URL. */
+export declare const NOTION_API = "https://api.notion.com";
+/** API version header (covers every endpoint used here). */
+export declare const NOTION_VERSION = "2022-06-28";
+/** Normalize a Notion page URL / id to the 32-char page id. */
+export declare function normalizeNotionPageId(input: string): string;
+/** Split markdown text into Notion paragraph blocks. */
+export declare function toNotionBlocks(content: string): Array<Record<string, unknown>>;
+/**
+ * Create a child page under the target parent page with the export content,
+ * appending extra blocks in batches if needed.
+ */
+export declare function exportToNotion(token: string, parentId: string, title: string, content: string): Promise<string>;
+/** Send text to flomo, chunking by size (never truncates). */
+export declare function exportToFlomo(flomoUrl: string, title: string, content: string, tag: string): Promise<{
+    sent: number;
+    memoCount: number;
+    failed: number;
+    message: string;
+}>;
+/** Split arbitrary text into size-capped chunks with a small header. */
+export declare function chunkText(text: string, maxChars: number, title: string): string[];

package/lib/types/flomo.d.ts

@@ -0,0 +1,33 @@
+/**
+ * weread-export — flomo export integration.
+ *
+ * weread_flomo sends a book's highlights/thoughts to flomo (浮墨笔记).
+ * It reuses the credentials already configured for the dsh-flomo plugin
+ * (~/.dsh/dsh-flomo.json, mode 0600): webhookUrl wins over apiKey. The
+ * flomo tag is fully customizable — the tool's `tag` parameter, or the
+ * store's defaultFlomoTag (defaults to 微信读书).
+ */
+/** Config file location shared with dsh-flomo (machine-wide, mode 0600). */
+export declare const FLOMO_CONFIG_FILE: string;
+/** Persisted flomo credential shape (read-only from weread's side). */
+export interface FlomoCredentials {
+    apiKey: string;
+    webhookUrl: string;
+}
+/** Whether flomo credentials exist on this machine. */
+export declare function flomoConfigured(): Promise<boolean>;
+/** Load and resolve the flomo send URL (null when not configured). */
+export declare function resolveFlomoUrl(): Promise<string | null>;
+/** One send outcome (never throws for HTTP/parse outcomes). */
+export interface FlomoSendResult {
+    ok: boolean;
+    message: string;
+    code?: number;
+}
+/**
+ * POST one memo to the flomo logging API. Resolves { ok, message, code? } —
+ * rejects only for transport-level failures.
+ */
+export declare function postMemo(url: string, content: string): Promise<FlomoSendResult>;
+/** Append normalized #tags to a memo body. */
+export declare function buildTaggedContent(content: string, tags: string): string;

package/lib/types/index.d.ts

@@ -0,0 +1,44 @@
+/**
+ * weread-export — 微信读书 (WeChat Reading) integration for DeepSeek Harness.
+ * Host half.
+ *
+ * Mounts the weread tools (status / config / search / book / shelf / notes /
+ * readdata / sync / flomo), the /api/weread-export route family the settings
+ * panel talks to, and a system-prompt announcement. Data rides the official
+ * WeRead Skills Agent Gateway (i.weread.qq.com/api/agent/gateway) with a
+ * user-bound wrk- API key created at https://weread.qq.com/r/weread-skills.
+ * The key lives in ~/.dsh/weread-export.json (mode 0600) and the sync snapshot
+ * in ~/.dsh/weread-export-cache.json. Tools and routes build the API client
+ * lazily from the store, so a key configured later takes effect immediately.
+ */
+import type { Context } from '@deepseek-ai/cordis';
+import { defineTool } from '@deepseek-ai/dsh-tools';
+/** Stable cordis plugin name. */
+export declare const name = "weread";
+/** Services required before the weread surfaces can mount. */
+export declare const inject: string[];
+/** Model-facing announcement: plugin presence, capabilities, and limits. */
+export declare const WEREAD_GUIDANCE: string;
+/** Plugin config, read from the composition row. */
+export interface Config {
+    /** When true (default), a system-prompt section announces the plugin. */
+    announceToAgent?: boolean;
+    /** Master switch for the plugin (routes, tools, prompt section). */
+    enabled?: boolean;
+}
+/**
+ * Mount the weread tools, routes, and announcement.
+ * @param ctx - host plugin context carrying tools/systemPrompt/webServer.
+ * @param config - plugin config from the composition row.
+ */
+export declare function apply(ctx: Context, config?: Config): void;
+/** Re-exports for host consumers and smoke tests. */
+export { WereadStore, mask, configPath, cachePath, DEFAULT_EXPORT_PROMPT, type WereadConfigView, type WereadCredentials, type ExportDest } from './store.ts';
+export { WereadApi, WereadApiError, WEREAD_GATEWAY, SKILL_VERSION, type BookInfo, type ShelfBook, type NotebookEntry, type Highlight, type MineReviewEntry } from './api.ts';
+export { wereadStatusTool, wereadConfigTool, wereadSearchTool, wereadBookTool, wereadShelfTool, wereadNotesTool, wereadReaddataTool, wereadSyncTool, wereadExportTool, wereadFlomoTool, runExport, buildTools, type ToolContext, type ExportRequest, type ExportResult } from './tools.ts';
+export { doSync, readCache, writeCache, emptyCache, buildNotesMarkdown, buildFlomoMemo, buildFlomoMemos, FLOMO_MAX_CHARS, formatDate, formatDuration, formatRating, dateLabel, deepLink, shelfLine, notebookLines, type WereadCache } from './cache.ts';
+export { resolveFlomoUrl, flomoConfigured, postMemo, buildTaggedContent, FLOMO_CONFIG_FILE } from './flomo.ts';
+export { chatComplete, renderPrompt, llmConfigured, type LlmConfig } from './llm.ts';
+export { buildExportMarkdown, processWithPrompt, exportToLocal, exportToNotion, exportToFlomo, chunkText, toNotionBlocks, normalizeNotionPageId, NOTION_API, NOTION_VERSION } from './export.ts';
+export { makeRoutes, WEREAD_API } from './routes.ts';
+export { defineTool };

package/lib/types/llm.d.ts

@@ -0,0 +1,31 @@
+/**
+ * weread-export — LLM prompt processing.
+ *
+ * A minimal OpenAI-compatible chat-completions client (DeepSeek-style). The
+ * base URL, API key, and model are configured in the settings panel (the AI
+ * section of this plugin) — no dependency on the host model registry. Used
+ * to run highlights through a user-editable prompt before export.
+ */
+/** LLM endpoint configuration. */
+export interface LlmConfig {
+    baseUrl: string;
+    apiKey: string;
+    model: string;
+}
+/** Is the LLM configured (key + base url + model present)? */
+export declare function llmConfigured(config: LlmConfig): boolean;
+/**
+ * One chat completion. Resolves the assistant text; rejects with a readable
+ * error on transport or API failures.
+ */
+export declare function chatComplete(config: LlmConfig, system: string, user: string): Promise<string>;
+/**
+ * Fill {title} / {author} / {highlights} / {thoughts} placeholders in a
+ * prompt template.
+ */
+export declare function renderPrompt(template: string, vars: {
+    title: string;
+    author: string;
+    highlights: string;
+    thoughts: string;
+}): string;

package/lib/types/routes.d.ts

@@ -0,0 +1,57 @@
+/**
+ * weread-export — loopback HTTP routes for the web settings panel.
+ *
+ * Route family: /api/weread-export/*. All routes are loopback-only
+ * (127.0.0.1/localhost, same-origin) — the settings panel is the only
+ * consumer.
+ */
+import type { IncomingMessage, ServerResponse } from 'node:http';
+import type { WereadStore } from './store.ts';
+/** Route paths. */
+export declare const WEREAD_API: {
+    readonly config: "/api/weread-export/config";
+    readonly status: "/api/weread-export/status";
+    readonly test: "/api/weread-export/test";
+    readonly sync: "/api/weread-export/sync";
+    readonly export: "/api/weread-export/export";
+    readonly flomo: "/api/weread-export/flomo";
+    readonly books: "/api/weread-export/books";
+};
+/** Route handler context. */
+export interface RouteContext {
+    store: WereadStore;
+}
+/**
+ * Build every /api/weread-export route (exact paths).
+ * @param deps - store (the API client is built lazily per request).
+ * @returns the route list.
+ */
+export declare function makeRoutes(deps: RouteContext): ({
+    kind: "exact";
+    path: "/api/weread-export/config";
+    handler: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+} | {
+    kind: "exact";
+    path: "/api/weread-export/status";
+    handler: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+} | {
+    kind: "exact";
+    path: "/api/weread-export/test";
+    handler: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+} | {
+    kind: "exact";
+    path: "/api/weread-export/sync";
+    handler: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+} | {
+    kind: "exact";
+    path: "/api/weread-export/books";
+    handler: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+} | {
+    kind: "exact";
+    path: "/api/weread-export/export";
+    handler: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+} | {
+    kind: "exact";
+    path: "/api/weread-export/flomo";
+    handler: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+})[];

package/lib/types/store.d.ts

@@ -0,0 +1,87 @@
+/**
+ * weread-export — credential/cache store.
+ *
+ * Persists the WeRead Skills API key (wrk-...) to ~/.dsh/weread-export.json
+ * (mode 0600) and the latest sync snapshot (bookshelf + notebook overview)
+ * to ~/.dsh/weread-export-cache.json. The config file holds the API key plus
+ * the default flomo tag used by weread_flomo. Reads are lazy and cached;
+ * the public view() never exposes secrets. Config paths can be overridden
+ * with DSH_WEREAD_CONFIG / DSH_WEREAD_CACHE (used by tests).
+ */
+/** Default machine-wide config location (mode 0600). */
+export declare const DEFAULT_CONFIG_FILE: string;
+/** Default sync cache location (mode 0600). */
+export declare const DEFAULT_CACHE_FILE: string;
+/** Test override for the config location. */
+export declare function configPath(): string;
+/** Test override for the cache location. */
+export declare function cachePath(): string;
+/** Persisted credential shape. Secrets never leave this module. */
+export interface WereadCredentials {
+    /** WeRead Skills API key (wrk-...), user-bound. */
+    apiKey: string;
+    /** Default flomo tag for weread_flomo exports (without leading #). */
+    defaultFlomoTag: string;
+    /** Highlights per export: 0 = export ALL, N > 0 = cap at N. */
+    exportLimit: number;
+    /** Default export destination: flomo | local | notion. */
+    exportDest: ExportDest;
+    /** Local export directory (required when dest=local; no default). */
+    localExportDir: string;
+    /** Notion integration token (plugin-owned, independent of dsh-notion). */
+    notionToken: string;
+    /** Notion target parent page: id or URL (page must share with the token). */
+    notionTargetPageId: string;
+    /** Whether to run highlights through the LLM prompt before export. */
+    usePrompt: boolean;
+    /** LLM prompt template ({title}/{author}/{highlights}/{thoughts} placeholders). */
+    exportPrompt: string;
+    /** OpenAI-compatible chat completions base URL. */
+    llmBaseUrl: string;
+    /** LLM API key (custom, panel-configured). */
+    llmApiKey: string;
+    /** LLM model name. */
+    llmModel: string;
+    /** ISO timestamp of the last successful sync. */
+    lastSyncAt: string;
+}
+/** Export destination. */
+export type ExportDest = 'flomo' | 'local' | 'notion';
+/** Public, secret-free status view. */
+export interface WereadConfigView {
+    configured: boolean;
+    apiKeyMasked: string;
+    defaultFlomoTag: string;
+    exportLimit: number;
+    exportDest: ExportDest;
+    localExportDir: string;
+    notionConfigured: boolean;
+    notionTargetPageId: string;
+    usePrompt: boolean;
+    llmConfigured: boolean;
+    llmBaseUrl: string;
+    llmModel: string;
+    lastSyncAt: string;
+    configPath: string;
+}
+/** Mask a credential for display, keeping only the head and tail. */
+export declare function mask(value: string): string;
+/** Default export prompt template. */
+export declare const DEFAULT_EXPORT_PROMPT: string;
+/**
+ * Small credential store backed by ~/.dsh/weread-export.json.
+ * Reads are lazy and cached; writes use mode 0600 so the API key never
+ * leaks to other local users.
+ */
+export declare class WereadStore {
+    config: WereadCredentials | null;
+    load(): Promise<WereadCredentials>;
+    save(next: WereadCredentials): Promise<void>;
+    /** Public, secret-free view. */
+    view(): Promise<WereadConfigView>;
+    /**
+     * Apply a config patch: any supported field replaces, reset clears.
+     * Returns the public view.
+     */
+    patch(args: Record<string, unknown> | undefined): Promise<WereadConfigView>;
+}