dsh-mishu 0.6.2 → 0.7.2

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

@@ -0,0 +1,97 @@
+/**
+ * Reaching you without you opening the board: a daily brief, urgent items
+ * as they come, and quiet hours.
+ *
+ * Urgent means someone is waiting on you or it is due today:
+ *   - things you told it: due today or overdue
+ *   - GitHub: a review requested, a mention, an assignment
+ *   - mail: a meeting invitation
+ * Everything else waits for the daily brief. Each urgent item is sent once
+ * (again only when it changes reason or due day); turning reminders on does
+ * not send what was already on the board. During quiet hours nothing is
+ * sent; what came up is sent when they end.
+ *
+ * Times are read in the time zone your browser reported, so a server
+ * running on UTC still sends the brief at your morning.
+ */
+import type { BoardData } from './board.ts';
+import { type Bi, type Lang } from './i18n.ts';
+import type { Matter, MishuStore } from './store.ts';
+export interface NotifySettings {
+    brief: {
+        enabled: boolean;
+        time: string;
+    };
+    urgent: boolean;
+    quiet: {
+        enabled: boolean;
+        from: string;
+        to: string;
+    };
+    /** IANA zone from your browser; empty: this computer's own. */
+    timeZone: string;
+    channels: {
+        desktop: boolean;
+        feishu: boolean;
+    };
+}
+export declare const DEFAULT_NOTIFY: NotifySettings;
+export declare const URGENT_REASONS: string[];
+export type ChannelId = keyof NotifySettings['channels'];
+export interface Message {
+    kind: 'brief' | 'urgent' | 'test';
+    title: string;
+    /** One or two lines, for a system notification. */
+    body: string;
+    /** The whole message, for a chat. */
+    text: string;
+}
+export interface Channel {
+    id: ChannelId;
+    status(): Promise<{
+        available: true;
+    } | {
+        available: false;
+        why: Bi;
+    }>;
+    send(message: Message): Promise<void>;
+}
+export interface NotifyReport {
+    at: number;
+    kind: Message['kind'];
+    count: number;
+    results: Array<{
+        channel: ChannelId;
+        ok: boolean;
+        error?: string;
+    }>;
+}
+export declare const NOTIFY_REPORT_KEY = "notify.last";
+export declare function notifySettings(store: MishuStore): NotifySettings;
+/** Check what the page sent and keep it; throws a sentence a person can act on. */
+export declare function saveNotifySettings(store: MishuStore, input: Partial<NotifySettings>, now: number): NotifySettings;
+/** The day and minute of the day in a time zone ('' = this computer's). */
+export declare function localClock(now: number, timeZone: string): {
+    day: string;
+    minutes: number;
+};
+/** Whether a minute of the day is inside quiet hours, which may run past midnight. */
+export declare function inQuiet(minutes: number, quiet: NotifySettings['quiet']): boolean;
+/** Open items someone is waiting on, or due today. */
+export declare function urgentMatters(store: MishuStore, today: string): Matter[];
+/** The brief, from what the board shows; `undefined` when there is nothing to tell. */
+export declare function briefMessage(board: BoardData, lang: Lang): Message | undefined;
+export declare function testMessage(lang: Lang): Message;
+/** Send to every enabled channel; one failing does not stop the others. */
+export declare function deliver(store: MishuStore, channels: Channel[], message: Message, count: number, now: number): Promise<NotifyReport>;
+/**
+ * One look at the clock: send what is due. Called every minute and after
+ * each sync. `channels` are the enabled ones; `board` builds the brief.
+ */
+export declare function notifyTick(options: {
+    store: MishuStore;
+    now: number;
+    lang: Lang;
+    channels: Channel[];
+    board: () => BoardData;
+}): Promise<NotifyReport[]>;

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 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 } from '../core/index.ts';
 import type { MishuConfig } from './config.ts';
 interface Logger {
     info(message: string): void;
@@ -17,6 +17,9 @@ export declare class Runtime {
     readonly fetcher: MailFetcher;
     private readonly logger;
     private syncing;
+    /** Where reminders can go; tests swap them for recorders. */
+    channels: Record<ChannelId, Channel>;
+    private notifying;
     /** "Sign in with GitHub" in progress, if any; tests swap it to replay GitHub. */
     githubLogin: GithubDeviceLogin;
     /** How DSH restarts; tests swap it so they never restart anything. */
@@ -41,6 +44,12 @@ export declare class Runtime {
     private syncGithubNow;
     /** One account; the result is also kept as its last report. */
     syncMailAccount(account: MailAccount): Promise<MailSyncReport | undefined>;
+    /** The channels that are turned on and work on this computer. */
+    activeChannels(): Promise<Channel[]>;
+    /** The board as the brief describes it. */
+    board(now: number, lang?: Lang): import("../core/board.ts").BoardData;
+    /** Send what is due now: urgent items, the daily brief. One at a time. */
+    notify(now?: number): Promise<NotifyReport[]>;
     /** Every source once; concurrent callers share the sync in flight. */
     syncAll(): Promise<void>;
     /** Resolves when the sync in flight (if any) is done. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-mishu",
-  "version": "0.6.2",
+  "version": "0.7.2",
   "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",