@openmnemo/sync 0.2.2 → 0.3.0

package/README.md

@@ -0,0 +1,79 @@
+# @openmnemo/sync
+
+Heartbeat daemon, config management, and background sync for OpenMnemo.
+
+Runs periodically to discover new AI transcripts, import them into `Memory/`, commit changes to git, and optionally generate HTML reports.
+
+## Install
+
+```bash
+npm install @openmnemo/sync
+```
+
+This package is primarily consumed by `@openmnemo/cli` via the `openmnemo daemon` commands. Direct usage is for programmatic control.
+
+## Config
+
+Config is stored in `~/.memorytree/config.toml`.
+
+```typescript
+import { loadConfig, saveConfig, memorytreeRoot } from '@openmnemo/sync'
+
+const config = loadConfig()
+// {
+//   heartbeat_interval: '5m',
+//   auto_push: true,
+//   generate_report: false,
+//   locale: 'en',
+//   ai_summary_model: 'claude-haiku-4-5-20251001',
+//   ...
+// }
+```
+
+### Config fields
+
+| Field | Default | Description |
+|-------|---------|-------------|
+| `heartbeat_interval` | `'5m'` | Heartbeat interval (e.g. `'5m'`, `'1h'`) |
+| `auto_push` | `true` | Git push after each import |
+| `generate_report` | `false` | Build HTML report on each heartbeat |
+| `locale` | `'en'` | Report locale (`'en'` or `'zh-CN'`) |
+| `ai_summary_model` | `'claude-haiku-4-5-20251001'` | Model for AI session summaries |
+| `gh_pages_branch` | `''` | Deploy report to this branch (empty = skip) |
+| `cname` | `''` | Custom domain for GitHub Pages |
+| `webhook_url` | `''` | Notify Feishu/Slack/Discord/Telegram on publish |
+| `report_base_url` | `''` | Base URL for report RSS/OG links |
+
+## Programmatic heartbeat
+
+```typescript
+import { runHeartbeat } from '@openmnemo/sync'
+
+await runHeartbeat()
+```
+
+## Lock management
+
+```typescript
+import { acquireLock, releaseLock, readLockPid } from '@openmnemo/sync'
+
+const acquired = acquireLock()
+if (acquired) {
+  // run heartbeat
+  releaseLock()
+}
+```
+
+## Alerts
+
+```typescript
+import { readAlerts, writeAlert, clearAlerts } from '@openmnemo/sync'
+
+const alerts = readAlerts()
+writeAlert({ type: 'sensitive-content', message: 'API key detected', project: 'my-project' })
+clearAlerts()
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -1,5 +1,3 @@
-import { ParsedTranscript } from '@openmnemo/types';
-
 /**
  * Load, validate, and manage ~/.memorytree/config.toml.
  * Port of scripts/_config_utils.py
@@ -36,10 +34,6 @@ declare function registerProject(cfg: Config, repoPath: string): Config;
 
 declare function main(): Promise<number>;
 declare function runHeartbeat(config: Config): Promise<number>;
-declare function processProject(config: Config, projectPath: string, projectName: string): Promise<void>;
-declare function scanSensitive(parsed: ParsedTranscript, projectPath: string): void;
-declare function gitCommitAndPush(config: Config, projectPath: string, projectName: string, count: number): void;
-declare function tryPush(projectPath: string, projectName: string): boolean;
 
 /**
  * PID-based lock file for heartbeat single-instance enforcement.
@@ -112,4 +106,4 @@ declare function setupLogging(logLevel?: LogLevel): Logger;
  */
 declare function getLogger(): Logger;
 
-export { ALERT_TYPES, type Alert, FAILURE_THRESHOLD, type LogLevel, type Logger, MAX_ALERTS, acquireLock, alertsPath, clearAlerts, configPath, formatAlertsForDisplay, getLogger, gitCommitAndPush, main as heartbeatMain, intervalToSeconds, isProcessAlive, loadConfig, lockPath, memorytreeRoot, processProject, readAlerts, readLockPid, registerProject, releaseLock, resetFailureCount, runHeartbeat, saveConfig, scanSensitive, setupLogging, tryPush, writeAlert, writeAlertWithThreshold };
+export { ALERT_TYPES, type Alert, FAILURE_THRESHOLD, type LogLevel, type Logger, MAX_ALERTS, acquireLock, alertsPath, clearAlerts, configPath, formatAlertsForDisplay, getLogger, main as heartbeatMain, intervalToSeconds, isProcessAlive, loadConfig, lockPath, memorytreeRoot, readAlerts, readLockPid, registerProject, releaseLock, resetFailureCount, runHeartbeat, saveConfig, setupLogging, writeAlert, writeAlertWithThreshold };

package/dist/index.js

@@ -703,14 +703,12 @@ export {
   configPath,
   formatAlertsForDisplay,
   getLogger,
-  gitCommitAndPush,
   main as heartbeatMain,
   intervalToSeconds,
   isProcessAlive,
   loadConfig,
   lockPath,
   memorytreeRoot,
-  processProject,
   readAlerts,
   readLockPid,
   registerProject,
@@ -718,9 +716,7 @@ export {
   resetFailureCount,
   runHeartbeat,
   saveConfig,
-  scanSensitive,
   setupLogging,
-  tryPush,
   writeAlert,
   writeAlertWithThreshold
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmnemo/sync",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "type": "module",
   "description": "Heartbeat daemon, config management, and background sync for OpenMnemo",
   "main": "./dist/index.js",
@@ -22,9 +22,9 @@
   ],
   "dependencies": {
     "smol-toml": "^1.3.1",
-    "@openmnemo/core": "0.2.2",
-    "@openmnemo/types": "0.2.2",
-    "@openmnemo/report": "0.2.2"
+    "@openmnemo/core": "0.3.0",
+    "@openmnemo/types": "0.3.0",
+    "@openmnemo/report": "0.3.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",