dsh-mishu 0.7.2 → 0.7.3

package/lib/types/core/ask.d.ts

@@ -29,6 +29,11 @@ export type AskRequest = {
     kind: 'mail-setup';
     preset: string;
     error?: string;
+} | {
+    kind: 'watch-error';
+    watchId: number;
+} | {
+    kind: 'watch-setup';
 };
 export interface AskOptions {
     now: number;

package/lib/types/core/board.d.ts

@@ -17,7 +17,7 @@ export interface BoardCard {
     /** Matter id, or series id for a series card. */
     id: number;
     target: 'matter' | 'series';
-    source: 'github' | 'mail' | 'manual';
+    source: 'github' | 'mail' | 'manual' | 'watch';
     title: string;
     /** One short line: when it is due, or why it is here. */
     meta: string;
@@ -58,6 +58,12 @@ export interface BoardData {
             state: 'never' | 'ok' | 'error';
             text: string;
         }>;
+        watch: Array<{
+            id: number;
+            label: string;
+            state: 'never' | 'ok' | 'error';
+            text: string;
+        }>;
     };
     markRead: MarkReadMode;
     columns: {
@@ -83,6 +89,11 @@ export interface BoardOptions {
         id: number;
         label: string;
     }>;
+    /** Things you watch yourself, for their status line. */
+    watches?: Array<{
+        id: number;
+        label: string;
+    }>;
 }
 export declare function buildBoard(store: MishuStore, options: BoardOptions): BoardData;
 export interface MatterDetail {

package/lib/types/core/brief.d.ts

@@ -27,6 +27,11 @@ export interface BriefOptions {
         id: number;
         label: string;
     }>;
+    /** Things you watch yourself, for their status lines. */
+    watches?: Array<{
+        id: number;
+        label: string;
+    }>;
 }
 export declare function renderBrief(store: MishuStore, options: BriefOptions): string;
 /** Recently closed matters with reasons, so a wrong closure can be reopened. */

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

@@ -28,6 +28,9 @@ export { DEFAULT_NOTIFY, deliver, inQuiet, localClock, notifySettings, notifyTic
 export { restartPlan, scheduleRestart, type RestartPlan, type RestartStarted } from './restart.ts';
 export { FileSecrets, KeychainOrFile, MemorySecrets, secretEnvName, secretFromEnv, systemSecrets, type SecretStatus, type SecretStore } from './secrets.ts';
 export { deleteMailAccount, effectiveSettings, mailAccounts, saveMailAccount, saveSettings, type Defaults, type UserSettings } from './settings.ts';
+export { deleteWatch, dueWatches, entryKey, parseKeywords, resolveWatch, saveWatch, watchById, watchReportKey, watchSources, WATCH_SOURCE, type WatchInput, type WatchReport, type WatchSource, } from './watch/source.ts';
+export { describeWatchError, httpFetch, parseFeed, parseJson, parsePage, plainText, readWatchBody, type WatchFetch, type WatchItem } from './watch/fetch.ts';
+export { describeKeywords, describeWatch, diffItems, judgeWatch, syncWatch } from './watch/sync.ts';
 export declare const DEFAULT_HOME = "~/.mishu";
 /** `~` and `~/…` expand to the home directory on every platform. */
 export declare function expandHome(path: string): string;

package/lib/types/core/watch/fetch.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Reading a watched address: a feed, a JSON list, or just a page.
+ *
+ * Whatever comes back is turned into a handful of items — a title, a bit of
+ * text and a stable key — so the rest of the code never has to care whether
+ * it was RSS, Atom, JSON or plain HTML. No parser library: the shapes that
+ * matter here are small, and a wrong guess costs nothing (the page is read
+ * as text and still works).
+ */
+import { type Bi } from '../i18n.ts';
+import { type WatchSource } from './source.ts';
+export interface WatchItem {
+    /** Stable across checks: the same entry twice is the same item. */
+    key: string;
+    title: string;
+    /** The text to look for keywords in, and to quote back. */
+    text: string;
+    url: string | null;
+    /** When the source says it happened; the fetch time when it does not. */
+    at: number;
+}
+export interface WatchFetch {
+    (url: string): Promise<{
+        status: number;
+        body: string;
+        contentType: string;
+    }>;
+}
+/** The real fetch: a plain GET with a short timeout and no cookies. */
+export declare const httpFetch: WatchFetch;
+/** Markup out, whitespace collapsed. */
+export declare function plainText(markup: string): string;
+/** RSS `<item>` and Atom `<entry>` blocks, whichever the document has. */
+export declare function parseFeed(body: string, now: number, base: string): WatchItem[] | undefined;
+/**
+ * A JSON body: an array of objects, or an object with one array inside. Each
+ * element's title-like and text-like fields become an item.
+ */
+export declare function parseJson(body: string, now: number, base: string): WatchItem[] | undefined;
+/** A page with no feed: its title and text, as one item keyed by a hash of the text. */
+export declare function parsePage(body: string, now: number, base: string): WatchItem[];
+/** Whatever the address returned, as items. */
+export declare function readWatchBody(options: {
+    body: string;
+    contentType: string;
+    url: string;
+    now: number;
+}): WatchItem[];
+/** The sentence shown when a watch cannot be read. */
+export declare function describeWatchError(error: unknown, source: WatchSource): Bi;

package/lib/types/core/watch/source.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Things you watch yourself: a page, a feed or an API you care about.
+ *
+ * GitHub and mail are sources the secretary knows how to read. Everything
+ * else a person cares about — a game's patch notes, a job posting, a price,
+ * a status page — is a URL. You add it here with the words that matter to
+ * you, and the secretary looks at it now and then: when it changes, or when
+ * one of your words shows up, it becomes a card like anything else.
+ *
+ * Only where and what to look for is kept here. What was seen last lives in
+ * the notebook's key-value table, so an entry never grows without bound.
+ */
+import { type Bi } from '../i18n.ts';
+import type { MishuStore } from '../store.ts';
+export declare const WATCH_SOURCE = "watch";
+export interface WatchSource {
+    id: number;
+    /** What you call it: "补丁公告", "机票价格". */
+    label: string;
+    url: string;
+    /**
+     * Words to watch for, lower-cased. Empty: any change is worth a card.
+     * A feed is read per entry; a page is read as one text.
+     */
+    keywords: string[];
+    enabled: boolean;
+    /** Minutes between checks. */
+    intervalMinutes: number;
+}
+export interface WatchInput {
+    id?: number;
+    label?: string;
+    url?: string;
+    keywords?: string | string[];
+    enabled?: boolean;
+    intervalMinutes?: number;
+}
+export interface WatchReport {
+    at: number;
+    id: number;
+    /** Entries or text pieces the fetch turned up. */
+    items: number;
+    opened: number;
+    closed: number;
+    error?: Bi;
+}
+export declare function watchSources(store: MishuStore): WatchSource[];
+export declare function watchById(store: MishuStore, id: number): WatchSource | undefined;
+export declare function watchReportKey(id: number): string;
+/** Where one watch keeps what it has already seen. */
+export declare function watchStateKey(id: number): string;
+export declare function watchSeenKey(id: number): string;
+/** A stable id for a feed entry: its guid, else its link, else its title. */
+export declare function entryKey(entry: {
+    id?: string;
+    link?: string;
+    title?: string;
+}): string;
+/** Split what you typed into words: commas, 、, spaces or new lines all work. */
+export declare function parseKeywords(value: string | string[] | undefined): string[];
+/** Check and complete what the settings page sent; throws a sentence a person can act on. */
+export declare function resolveWatch(input: WatchInput, id: number): WatchSource;
+/** Add (no id) or update one watch. */
+export declare function saveWatch(store: MishuStore, input: WatchInput, now: number): WatchSource;
+/** Remove one watch and close whatever it still has open. */
+export declare function deleteWatch(store: MishuStore, id: number, now: number): boolean;
+/** The watches whose next check is due. */
+export declare function dueWatches(store: MishuStore, now: number): WatchSource[];

package/lib/types/core/watch/sync.d.ts

@@ -0,0 +1,51 @@
+/**
+ * One watch, one check: read the address, compare with what was seen last
+ * time, and turn anything new into a card.
+ *
+ * A card per watch, not per entry: "补丁公告 · 3 条新内容" is what you want to
+ * see, not three cards that say the same thing. Marking it done closes it;
+ * the next change opens it again with what changed.
+ *
+ * The first check only writes down what is there now — otherwise adding a
+ * feed would hand you every entry it ever published. Words you asked to watch
+ * for are the exception: those are shown right away, because you asked.
+ */
+import type { MishuStore } from '../store.ts';
+import type { Verdict } from '../github/rules.ts';
+import { type WatchFetch, type WatchItem } from './fetch.ts';
+import { type WatchReport, type WatchSource } from './source.ts';
+interface WatchState {
+    /** Keys of entries already reported, newest last. */
+    seen: string[];
+    /** Fingerprint of the whole page, for addresses that are not feeds. */
+    digest?: string;
+    /** First check done. */
+    primed: boolean;
+}
+/** Which items are new since last time, and whether the whole page changed. */
+export declare function diffItems(items: WatchItem[], state: WatchState): {
+    fresh: WatchItem[];
+    changed: boolean;
+    digest: string;
+};
+export declare function judgeWatch(options: {
+    source: WatchSource;
+    items: WatchItem[];
+    fresh: WatchItem[];
+    changed: boolean;
+    first: boolean;
+    now: number;
+}): Verdict | undefined;
+export declare function syncWatch(options: {
+    store: MishuStore;
+    source: WatchSource;
+    fetcher: WatchFetch;
+    now: number;
+}): Promise<WatchReport>;
+/** Everything about one watch the settings page shows. */
+export declare function describeWatch(store: MishuStore, source: WatchSource, lang: 'zh' | 'en'): string;
+/** The words, for showing back to you. */
+export declare function describeKeywords(source: WatchSource, lang: 'zh' | 'en'): string;
+/** Guard for the settings page: an address that cannot be a watch at all. */
+export declare function assertWatchable(source: WatchSource): void;
+export {};

package/lib/types/dsh/runtime.d.ts

@@ -4,7 +4,7 @@
  * what you set on the settings page on top), the keychain, and one sync of
  * every source at a time.
  */
-import { GithubDeviceLogin, type Defaults, type Lang, type MailAccount, type MailFetcher, type MailSyncReport, type MishuStore, type Channel, type ChannelId, type NotifyReport, type RestartPlan, type RestartStarted, type SecretStore, type TokenResult } from '../core/index.ts';
+import { GithubDeviceLogin, type Defaults, type Lang, type MailAccount, type MailFetcher, type MailSyncReport, type MishuStore, type Channel, type ChannelId, type NotifyReport, type RestartPlan, type RestartStarted, type SecretStore, type TokenResult, type WatchFetch, type WatchReport, type WatchSource } from '../core/index.ts';
 import type { MishuConfig } from './config.ts';
 interface Logger {
     info(message: string): void;
@@ -15,6 +15,8 @@ export declare class Runtime {
     readonly config: MishuConfig;
     readonly secrets: SecretStore;
     readonly fetcher: MailFetcher;
+    /** How watched addresses are read; tests swap it for a fake. */
+    watchFetch: WatchFetch;
     private readonly logger;
     private syncing;
     /** Where reminders can go; tests swap them for recorders. */
@@ -36,6 +38,7 @@ export declare class Runtime {
     fixedLang(): Lang | undefined;
     lang(): Lang;
     accounts(): MailAccount[];
+    watches(): WatchSource[];
     brief(lang?: Lang): string;
     /** The password for an account: keychain first, then the documented environment variable. */
     mailPassword(id: number): Promise<string | undefined>;
@@ -44,6 +47,8 @@ export declare class Runtime {
     private syncGithubNow;
     /** One account; the result is also kept as its last report. */
     syncMailAccount(account: MailAccount): Promise<MailSyncReport | undefined>;
+    /** One watch; the result is also kept as its last report. */
+    syncWatchSource(source: WatchSource): Promise<WatchReport | undefined>;
     /** The channels that are turned on and work on this computer. */
     activeChannels(): Promise<Channel[]>;
     /** The board as the brief describes it. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-mishu",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "DSH secretary (小秘书) for DeepSeek Harness (dsh): watches GitHub notifications and the dated things you tell it (bills, renewals, documents, birthdays), closes what is already resolved, and keeps a short list of what actually needs you. Bilingual (中文 / English), macOS / Windows / Linux. · DSH 小秘书：提醒、通知、待办、消息、收件箱、秘书。GitHub 通知按当前状态分诊，交代一句就记下到期和周期事项。",
   "type": "module",
   "main": "lib/index.js",