@glance-apps/sync 0.4.0 → 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glance-apps/sync",
-  "version": "0.4.0",
+  "version": "1.0.0",
   "license": "MIT",
   "type": "module",
   "main": "src/index.js",

package/src/autoBackup.js

@@ -1 +1,272 @@
-// Placeholder — auto-backup module is extracted in Step 5.
+import { encryptData, decryptData, isEncryptedEnvelope, hasEncryptionReady } from './crypto.js';
+import { webdavFetch } from './providers.js';
+
+// btoa() throws InvalidCharacterError for codepoints > 255 (CJK, emoji, etc.).
+const toBase64 = (str) => btoa(String.fromCharCode(...new TextEncoder().encode(str)));
+
+/**
+ * Creates an IndexedDB-backed auto-backup store.
+ *
+ * @param {object} config
+ * @param {string} config.autoBackupDBName   - IDB database name (e.g. 'dayglance-auto-backups')
+ * @returns {object} autoBackupDB instance
+ */
+export function createAutoBackupDB(config) {
+  return {
+    _db: null,
+    async open() {
+      if (this._db) return this._db;
+      return new Promise((resolve, reject) => {
+        const req = indexedDB.open(config.autoBackupDBName, 1);
+        req.onupgradeneeded = (e) => {
+          const db = e.target.result;
+          if (!db.objectStoreNames.contains('backups')) {
+            const store = db.createObjectStore('backups', { keyPath: 'id' });
+            store.createIndex('timestamp', 'timestamp', { unique: false });
+            store.createIndex('frequency', 'frequency', { unique: false });
+          }
+        };
+        req.onsuccess = () => { this._db = req.result; resolve(req.result); };
+        req.onerror = () => reject(req.error);
+      });
+    },
+    async saveBackup(frequency, data) {
+      const db = await this.open();
+      const timestamp = new Date().toISOString();
+      const id = `auto-${frequency}-${timestamp}`;
+      const record = { id, timestamp, frequency, data };
+      return new Promise((resolve, reject) => {
+        const tx = db.transaction('backups', 'readwrite');
+        tx.objectStore('backups').put(record);
+        tx.oncomplete = () => resolve(record);
+        tx.onerror = () => reject(tx.error);
+      });
+    },
+    async listBackups(frequency) {
+      const db = await this.open();
+      return new Promise((resolve, reject) => {
+        const tx = db.transaction('backups', 'readonly');
+        const store = tx.objectStore('backups');
+        const req = frequency
+          ? store.index('frequency').getAll(frequency)
+          : store.getAll();
+        req.onsuccess = () => resolve(req.result.sort((a, b) => b.timestamp.localeCompare(a.timestamp)));
+        req.onerror = () => reject(req.error);
+      });
+    },
+    async getBackup(id) {
+      const db = await this.open();
+      return new Promise((resolve, reject) => {
+        const tx = db.transaction('backups', 'readonly');
+        const req = tx.objectStore('backups').get(id);
+        req.onsuccess = () => resolve(req.result);
+        req.onerror = () => reject(req.error);
+      });
+    },
+    async deleteBackup(id) {
+      const db = await this.open();
+      return new Promise((resolve, reject) => {
+        const tx = db.transaction('backups', 'readwrite');
+        tx.objectStore('backups').delete(id);
+        tx.oncomplete = () => resolve();
+        tx.onerror = () => reject(tx.error);
+      });
+    },
+    async pruneBackups(frequency, maxCount) {
+      const all = await this.listBackups(frequency);
+      if (all.length <= maxCount) return;
+      const toDelete = all.slice(maxCount);
+      const db = await this.open();
+      return new Promise((resolve, reject) => {
+        const tx = db.transaction('backups', 'readwrite');
+        const store = tx.objectStore('backups');
+        toDelete.forEach(b => store.delete(b.id));
+        tx.oncomplete = () => resolve(toDelete.length);
+        tx.onerror = () => reject(tx.error);
+      });
+    }
+  };
+}
+
+/**
+ * Creates the auto-backup remote provider objects.
+ * These are separate from cloudSyncProviders (real-time sync); they handle
+ * periodic snapshot uploads.
+ *
+ * @param {object} config
+ * @param {string} config.backupFilenamePrefix - e.g. 'dayglance-backup-'
+ * @param {string} config.appFolderName        - e.g. 'dayglance' (used in Nextcloud path)
+ * @param {Function} config.webdavFetch        - bound webdavFetch(method, url, auth, body, extra)
+ * @returns {object} provider map keyed by provider id
+ */
+export function createAutoBackupProviders(config) {
+  const wdFetch = config.webdavFetch;
+  const prefix = config.backupFilenamePrefix;
+  const appFolder = config.appFolderName;
+
+  return {
+    nextcloud: {
+      name: 'Nextcloud / WebDAV',
+      configFields: [
+        { key: 'nextcloudUrl', label: 'Nextcloud URL', type: 'url', placeholder: 'https://cloud.example.com' },
+        { key: 'username', label: 'Username', type: 'text', placeholder: 'your-username' },
+        { key: 'appPassword', label: 'App Password', type: 'password', placeholder: 'xxxxx-xxxxx-xxxxx-xxxxx-xxxxx' }
+      ],
+      _getBackupDirUrl(providerConfig) {
+        if (!providerConfig.nextcloudUrl) throw new Error('Nextcloud URL is not configured');
+        return `${providerConfig.nextcloudUrl.replace(/\/+$/, '')}/remote.php/dav/files/${encodeURIComponent(providerConfig.username)}/${appFolder}/backups/`;
+      },
+      _getAuthHeaders(providerConfig) {
+        return { 'X-WebDAV-Auth': 'Basic ' + toBase64(providerConfig.username + ':' + providerConfig.appPassword) };
+      },
+      async uploadBackup(providerConfig, data) {
+        const dirUrl = this._getBackupDirUrl(providerConfig);
+        const authHeaders = this._getAuthHeaders(providerConfig);
+        const now = new Date();
+        const timestamp = `${now.getFullYear()}-${String(now.getMonth()+1).padStart(2,'0')}-${String(now.getDate()).padStart(2,'0')}T${String(now.getHours()).padStart(2,'0')}-${String(now.getMinutes()).padStart(2,'0')}-${String(now.getSeconds()).padStart(2,'0')}`;
+        const filename = `${prefix}${timestamp}.json`;
+        const fileUrl = dirUrl + filename;
+        const payload = hasEncryptionReady() ? await encryptData(data) : data;
+        const body = JSON.stringify(payload);
+
+        const doUpload = () =>
+          wdFetch('PUT', fileUrl, authHeaders, body, { 'Content-Type': 'application/json' });
+
+        let res = await doUpload();
+        if (res.status === 404 || res.status === 409) {
+          const parentDir = `${providerConfig.nextcloudUrl.replace(/\/+$/, '')}/remote.php/dav/files/${encodeURIComponent(providerConfig.username)}/${appFolder}/`;
+          await wdFetch('MKCOL', parentDir, authHeaders);
+          await wdFetch('MKCOL', dirUrl, authHeaders);
+          res = await doUpload();
+        }
+        if (!res.ok) throw new Error(`Upload failed: ${res.status} ${res.statusText}`);
+        return filename;
+      },
+      async listBackups(providerConfig) {
+        const dirUrl = this._getBackupDirUrl(providerConfig);
+        const authHeaders = this._getAuthHeaders(providerConfig);
+        const res = await wdFetch('PROPFIND', dirUrl, authHeaders, undefined, { 'Depth': '1' });
+        if (res.status === 404) return [];
+        if (!res.ok) throw new Error(`List failed: ${res.status}`);
+        const xml = await res.text();
+        const parser = new DOMParser();
+        const doc = parser.parseFromString(xml, 'application/xml');
+        const responses = doc.querySelectorAll('response');
+        const files = [];
+        responses.forEach(r => {
+          const href = r.querySelector('href')?.textContent || '';
+          const filename = decodeURIComponent(href.split('/').filter(Boolean).pop());
+          if (filename.startsWith(prefix) && filename.endsWith('.json')) {
+            const lastModified = r.querySelector('getlastmodified')?.textContent;
+            files.push({ filename, lastModified: lastModified ? new Date(lastModified).toISOString() : null });
+          }
+        });
+        return files.sort((a, b) => (b.lastModified || '').localeCompare(a.lastModified || ''));
+      },
+      async downloadBackup(providerConfig, filename) {
+        const fileUrl = this._getBackupDirUrl(providerConfig) + filename;
+        const authHeaders = this._getAuthHeaders(providerConfig);
+        const res = await wdFetch('GET', fileUrl, authHeaders);
+        if (!res.ok) throw new Error(`Download failed: ${res.status}`);
+        const parsed = await res.json();
+        if (isEncryptedEnvelope(parsed)) return decryptData(parsed);
+        return parsed;
+      },
+      async deleteBackup(providerConfig, filename) {
+        const fileUrl = this._getBackupDirUrl(providerConfig) + filename;
+        const authHeaders = this._getAuthHeaders(providerConfig);
+        const res = await wdFetch('DELETE', fileUrl, authHeaders);
+        if (!res.ok && res.status !== 404) throw new Error(`Delete failed: ${res.status}`);
+      },
+      async testConnection(providerConfig) {
+        const dirUrl = this._getBackupDirUrl(providerConfig);
+        const authHeaders = this._getAuthHeaders(providerConfig);
+        const res = await wdFetch('PROPFIND', dirUrl, authHeaders, undefined, { 'Depth': '0' });
+        if (res.status === 200 || res.status === 207 || res.status === 404) return { success: true };
+        if (res.status === 401) return { success: false, error: 'Invalid credentials.' };
+        return { success: false, error: `Unexpected response: ${res.status}` };
+      }
+    },
+    webdav: {
+      name: 'Generic WebDAV',
+      configFields: [
+        { key: 'webdavUrl', label: 'WebDAV URL', type: 'url', placeholder: 'https://app.koofr.net/dav/Koofr/dayGLANCE/' },
+        { key: 'username', label: 'Username', type: 'text', placeholder: 'your-username' },
+        { key: 'appPassword', label: 'Password / App Password', type: 'password', placeholder: 'your-password' }
+      ],
+      _getBackupDirUrl(providerConfig) {
+        return `${providerConfig.webdavUrl.replace(/\/+$/, '')}/`;
+      },
+      _getAuthHeaders(providerConfig) {
+        return { 'X-WebDAV-Auth': 'Basic ' + toBase64(providerConfig.username + ':' + providerConfig.appPassword) };
+      },
+      async uploadBackup(providerConfig, data) {
+        const dirUrl = this._getBackupDirUrl(providerConfig);
+        const authHeaders = this._getAuthHeaders(providerConfig);
+        const now = new Date();
+        const timestamp = `${now.getFullYear()}-${String(now.getMonth()+1).padStart(2,'0')}-${String(now.getDate()).padStart(2,'0')}T${String(now.getHours()).padStart(2,'0')}-${String(now.getMinutes()).padStart(2,'0')}-${String(now.getSeconds()).padStart(2,'0')}`;
+        const filename = `${prefix}${timestamp}.json`;
+        const fileUrl = dirUrl + filename;
+        const payload = hasEncryptionReady() ? await encryptData(data) : data;
+        const body = JSON.stringify(payload);
+        const doUpload = () =>
+          wdFetch('PUT', fileUrl, authHeaders, body, { 'Content-Type': 'application/json' });
+        let res = await doUpload();
+        if (res.status === 404 || res.status === 409) {
+          await wdFetch('MKCOL', dirUrl, authHeaders);
+          res = await doUpload();
+        }
+        if (!res.ok) throw new Error(`Upload failed: ${res.status} ${res.statusText}`);
+        return filename;
+      },
+      async listBackups(providerConfig) {
+        const dirUrl = this._getBackupDirUrl(providerConfig);
+        const authHeaders = this._getAuthHeaders(providerConfig);
+        const res = await wdFetch('PROPFIND', dirUrl, authHeaders, undefined, { 'Depth': '1' });
+        if (res.status === 404) return [];
+        if (!res.ok) throw new Error(`List failed: ${res.status}`);
+        const xml = await res.text();
+        const parser = new DOMParser();
+        const doc = parser.parseFromString(xml, 'application/xml');
+        const responses = doc.querySelectorAll('response');
+        const files = [];
+        responses.forEach(r => {
+          const href = r.querySelector('href')?.textContent || '';
+          const filename = decodeURIComponent(href.split('/').filter(Boolean).pop());
+          if (filename.startsWith(prefix) && filename.endsWith('.json')) {
+            const lastModified = r.querySelector('getlastmodified')?.textContent;
+            files.push({ filename, lastModified: lastModified ? new Date(lastModified).toISOString() : null });
+          }
+        });
+        return files.sort((a, b) => (b.lastModified || '').localeCompare(a.lastModified || ''));
+      },
+      async downloadBackup(providerConfig, filename) {
+        const fileUrl = this._getBackupDirUrl(providerConfig) + filename;
+        const authHeaders = this._getAuthHeaders(providerConfig);
+        const res = await wdFetch('GET', fileUrl, authHeaders);
+        if (!res.ok) throw new Error(`Download failed: ${res.status}`);
+        const parsed = await res.json();
+        if (isEncryptedEnvelope(parsed)) return decryptData(parsed);
+        return parsed;
+      },
+      async deleteBackup(providerConfig, filename) {
+        const fileUrl = this._getBackupDirUrl(providerConfig) + filename;
+        const authHeaders = this._getAuthHeaders(providerConfig);
+        const res = await wdFetch('DELETE', fileUrl, authHeaders);
+        if (!res.ok && res.status !== 404) throw new Error(`Delete failed: ${res.status}`);
+      },
+      async testConnection(providerConfig) {
+        const dirUrl = this._getBackupDirUrl(providerConfig);
+        const authHeaders = this._getAuthHeaders(providerConfig);
+        const res = await wdFetch('PROPFIND', dirUrl, authHeaders, undefined, { 'Depth': '0' });
+        if (res.status === 200 || res.status === 207 || res.status === 404) return { success: true };
+        if (res.status === 401) return { success: false, error: 'Invalid credentials.' };
+        return { success: false, error: `Unexpected response: ${res.status}` };
+      }
+    }
+  };
+}
+
+// Auto-backup retention limits (app-agnostic constants)
+export const AUTO_BACKUP_RETENTION = { hourly: 24, daily: 30, weekly: 12 };
+export const AUTO_BACKUP_INTERVALS = { hourly: 3600, daily: 86400, weekly: 604800 };

package/src/engine.js

@@ -1 +1,529 @@
-// Placeholder — sync engine is implemented in Step 6.
+// Sync engine for @glance-apps/sync.
+//
+// Orchestrates the download → validate → merge → apply → upload cycle that
+// previously lived inline in dayGLANCE's App.jsx. The engine is app-agnostic
+// — every data-shape decision is delegated to four required callbacks:
+// buildPayload, buildBackupPayload, applyPayload, mergePayloads.
+//
+// Behavior preservation contract (vs. dayGLANCE pre-extraction):
+//   - 5-second debounce stays in the caller (the engine does not debounce).
+//   - 60-second poll stays in the caller; it calls engine.download().
+//   - Visibility/focus listeners stay in the caller.
+//   - Status sequence: emits 'uploading' | 'downloading' | 'success' | 'error' | 'idle'.
+//     Auto-reverts 'success' → 'idle' after 3 s and 'error' → 'idle' after 5 s
+//     unconditionally; the caller's onStatusChange handler is responsible for
+//     guarding against overwriting a newer status (the dayGLANCE adapter does
+//     this with a functional setState).
+//   - Two-second minimum status hold on success (matches the original UX).
+//   - Hard-stop error codes (APP_ID_MISMATCH, SCHEMA_FORWARD_INCOMPATIBLE) freeze
+//     the engine — auto-retry paths are inert until clearHardStop() is called.
+//   - Backwards compat: envelopes missing `schemaVersion` are treated as v1,
+//     envelopes missing `appId` skip the identity check (legacy dayGLANCE files
+//     written before Step 6 don't include either field).
+
+import { createProviders, webdavFetch } from './providers.js';
+import {
+  hasEncryptionReady,
+} from './crypto.js';
+import {
+  createAutoBackupDB,
+  createAutoBackupProviders,
+  AUTO_BACKUP_RETENTION,
+  AUTO_BACKUP_INTERVALS,
+} from './autoBackup.js';
+
+// Package-level schema version written into every envelope. Bump alongside
+// any breaking change to the envelope shape; consumers older than this will
+// hard-stop with SCHEMA_FORWARD_INCOMPATIBLE.
+export const SCHEMA_VERSION = 1;
+export const SUPPORTED_MAX_SCHEMA_VERSION = 1;
+
+// Envelope's `version` field. Currently a constant (matches dayGLANCE pre-
+// extraction); reserved as a monotonic counter for a future major version.
+const ENVELOPE_DATA_VERSION = 2;
+
+const MAX_UPLOAD_BACKOFF_S   = 15 * 60; // 15 minutes
+const MAX_DOWNLOAD_BACKOFF_S = 5 * 60;  // 5 minutes
+const AUTH_FAILURE_BACKOFF_MS = 60 * 60 * 1000; // 1 hour
+const LOCK_BACKOFF_MS = 30_000; // 30 s for 423 Locked
+const SUCCESS_HOLD_MS = 3000;
+const ERROR_HOLD_MS = 5000;
+const MIN_SYNC_DURATION_MS = 2000;
+
+/**
+ * Creates a sync engine bound to the given app/transport/data config.
+ * See SYNC_PACKAGE_SPEC.md (`createSyncEngine(config)` section) for the full
+ * config schema and behavioral contract.
+ */
+export const createSyncEngine = (config) => {
+  const {
+    storageKeyPrefix,
+    appId,
+    appName,
+    buildPayload,
+    buildBackupPayload,
+    applyPayload,
+    mergePayloads,
+    validateUploadPayload,
+    validateApplyPayload,
+    onStatusChange,
+    onError,
+    onLastSyncedChange,
+    onConflict,
+    onPassphraseRequired,
+    onFirstSyncReload,
+  } = config;
+
+  if (!storageKeyPrefix) throw new Error('createSyncEngine: storageKeyPrefix is required');
+  if (!appId) throw new Error('createSyncEngine: appId is required');
+  if (typeof buildPayload   !== 'function') throw new Error('createSyncEngine: buildPayload is required');
+  if (typeof applyPayload   !== 'function') throw new Error('createSyncEngine: applyPayload is required');
+  if (typeof mergePayloads  !== 'function') throw new Error('createSyncEngine: mergePayloads is required');
+
+  // Resolve sub-modules with the shared config so they share crypto/proxy wiring.
+  const providers = createProviders(config);
+  const wf = webdavFetch(config);
+  const autoBackupDB = createAutoBackupDB({ autoBackupDBName: config.autoBackupDBName });
+  const autoBackupProviders = createAutoBackupProviders({
+    backupFilenamePrefix: config.backupFilenamePrefix,
+    appFolderName: config.appFolderName,
+    webdavFetch: wf,
+  });
+
+  // localStorage keys owned by this engine.
+  const KEY_CONFIG      = `${storageKeyPrefix}-cloud-sync-config`;
+  const KEY_LAST_SYNCED = `${storageKeyPrefix}-cloud-sync-last-synced`;
+  const KEY_LOCAL_MOD   = `${storageKeyPrefix}-cloud-sync-local-modified`;
+
+  // ── In-memory state ─────────────────────────────────────────────────────
+  let syncing              = false;
+  let pendingFollowup      = false;
+  let hardStopped          = false;
+  let uploadErrorCount     = 0;
+  let uploadBackoffUntil   = 0;
+  let downloadErrorCount   = 0;
+  let downloadBackoffUntil = 0;
+
+  // ── Helpers ─────────────────────────────────────────────────────────────
+  const getConfig = () => {
+    const saved = localStorage.getItem(KEY_CONFIG);
+    return saved ? JSON.parse(saved) : null;
+  };
+
+  const setConfig = (cfg) => {
+    if (cfg) localStorage.setItem(KEY_CONFIG, JSON.stringify(cfg));
+    else     localStorage.removeItem(KEY_CONFIG);
+  };
+
+  const getLastSynced = () => localStorage.getItem(KEY_LAST_SYNCED) || null;
+
+  // Wraps a `{ data, lastModified? }` object with the envelope metadata required
+  // by the package contract. Accepts either a bare data object or a pre-wrapped
+  // envelope-like object (in which case existing lastModified is preserved).
+  const wrapEnvelope = (built) => {
+    const isWrapped = built && typeof built === 'object' && 'data' in built;
+    const data = isWrapped ? built.data : built;
+    const lastModified = (isWrapped && built.lastModified) || new Date().toISOString();
+    return {
+      schemaVersion: SCHEMA_VERSION,
+      appId,
+      version: (isWrapped && typeof built.version === 'number') ? built.version : ENVELOPE_DATA_VERSION,
+      lastModified,
+      data,
+    };
+  };
+
+  // Validates a downloaded envelope. Returns the validated envelope or throws
+  // a hard-stop Error. Backwards-compat: missing schemaVersion/appId are
+  // accepted (legacy files written before Step 6).
+  const validateEnvelope = (envelope) => {
+    if (!envelope || typeof envelope !== 'object' || !envelope.data) {
+      const err = new Error('Downloaded sync file is malformed (missing data field).');
+      err.code = 'NETWORK_ERROR';
+      throw err;
+    }
+    if (envelope.schemaVersion !== undefined && envelope.schemaVersion > SUPPORTED_MAX_SCHEMA_VERSION) {
+      const err = new Error(
+        `Remote sync file uses schema version ${envelope.schemaVersion}, ` +
+        `which is newer than this version of ${appName || appId} supports. Please update the app.`
+      );
+      err.code = 'SCHEMA_FORWARD_INCOMPATIBLE';
+      err.isHardStop = true;
+      throw err;
+    }
+    if (envelope.appId !== undefined && envelope.appId !== appId) {
+      const err = new Error(
+        `Remote sync file belongs to "${envelope.appId}", not ${appName || appId}. ` +
+        `Refusing to merge to prevent data loss.`
+      );
+      err.code = 'APP_ID_MISMATCH';
+      err.isHardStop = true;
+      throw err;
+    }
+    return envelope;
+  };
+
+  // Categorises a raw error into { code, isHardStop, message }.
+  const classifyError = (err) => {
+    if (err?.code === 'PASSPHRASE_REQUIRED') {
+      return { code: 'PASSPHRASE_REQUIRED', isHardStop: false, message: err.message };
+    }
+    if (err?.code === 'APP_ID_MISMATCH' || err?.code === 'SCHEMA_FORWARD_INCOMPATIBLE') {
+      return { code: err.code, isHardStop: true, message: err.message };
+    }
+    const msg = err?.message || String(err);
+    if (msg === 'PRECONDITION_FAILED')    return { code: 'PRECONDITION_FAILED', isHardStop: false, message: msg };
+    if (msg === 'FORBIDDEN')               return { code: 'FORBIDDEN',           isHardStop: true,  message: msg };
+    if (msg.includes('401'))               return { code: 'AUTH_FAILURE',        isHardStop: false, message: msg };
+    if (msg.includes('423'))               return { code: 'LOCKED',              isHardStop: false, message: msg };
+    return { code: 'NETWORK_ERROR', isHardStop: false, message: msg };
+  };
+
+  // Renders a user-facing error string preserving the exact wording used by
+  // dayGLANCE pre-extraction so the UX is unchanged.
+  const formatErrorMessage = (cls) => {
+    if (cls.code === 'AUTH_FAILURE') {
+      return 'Authentication failed (401) — check your username and password in sync settings.';
+    }
+    if (cls.code === 'FORBIDDEN') {
+      // Upload and download had slightly different wording pre-extraction. We
+      // unify on the upload variant (it's the one users see most often).
+      return "Sync blocked (403) — your server may be blocking Vercel's IP addresses.";
+    }
+    return cls.message;
+  };
+
+  const scheduleAutoRevert = (status, ms) => {
+    setTimeout(() => onStatusChange?.('idle', { from: status }), ms);
+  };
+
+  // ── upload ──────────────────────────────────────────────────────────────
+  /**
+   * Uploads the current local state to the configured provider.
+   * @param {object} [opts]
+   * @param {object} [opts.prebuiltPayload] - Skip buildPayload(), use this instead.
+   * @param {string} [opts.etag]            - If-Match etag for optimistic concurrency.
+   * @param {boolean} [opts.skipLockCheck]  - Bypass the in-progress guard (used
+   *   when called from within download()'s merge cycle to avoid self-deadlock).
+   */
+  const upload = async ({ prebuiltPayload, etag = null, skipLockCheck = false } = {}) => {
+    if (hardStopped) return;
+    const cfg = getConfig();
+    if (!cfg?.enabled) return;
+    if (!skipLockCheck && syncing) {
+      pendingFollowup = true;
+      return;
+    }
+    const provider = providers[cfg.provider];
+    if (!provider) return;
+
+    if (!skipLockCheck) syncing = true;
+    const t0 = Date.now();
+    onStatusChange?.('uploading');
+    onError?.(null, null, false); // clear previous error
+    try {
+      const built = prebuiltPayload || await buildPayload();
+      const envelope = wrapEnvelope(built);
+
+      if (validateUploadPayload) {
+        const check = await validateUploadPayload(envelope);
+        if (!check?.valid) {
+          // eslint-disable-next-line no-console
+          console.error(`[${appId}] cloud sync upload aborted:`, check?.reason || 'validation failed');
+          onStatusChange?.('idle');
+          return;
+        }
+      }
+
+      await provider.upload(cfg, envelope, etag);
+
+      const elapsed = Date.now() - t0;
+      if (elapsed < MIN_SYNC_DURATION_MS) {
+        await new Promise(r => setTimeout(r, MIN_SYNC_DURATION_MS - elapsed));
+      }
+
+      uploadErrorCount = 0;
+      uploadBackoffUntil = 0;
+      const now = new Date().toISOString();
+      localStorage.setItem(KEY_LAST_SYNCED, now);
+      localStorage.setItem(KEY_LOCAL_MOD, envelope.lastModified);
+      onLastSyncedChange?.(now);
+      onStatusChange?.('success');
+      scheduleAutoRevert('success', SUCCESS_HOLD_MS);
+    } catch (err) {
+      // eslint-disable-next-line no-console
+      console.error(`[${appId}] cloud sync upload error:`, err);
+      const cls = classifyError(err);
+
+      if (cls.code === 'PRECONDITION_FAILED') {
+        // When download() is the caller, it handles the 412 retry itself. Bubble.
+        if (skipLockCheck) throw err;
+        onStatusChange?.('idle');
+        return;
+      }
+
+      if (cls.code === 'AUTH_FAILURE') {
+        uploadBackoffUntil = Date.now() + AUTH_FAILURE_BACKOFF_MS;
+      } else {
+        uploadErrorCount += 1;
+        const ms = Math.min(30 * Math.pow(2, uploadErrorCount - 1), MAX_UPLOAD_BACKOFF_S) * 1000;
+        uploadBackoffUntil = Date.now() + ms;
+      }
+
+      if (cls.isHardStop) hardStopped = true;
+      onError?.(formatErrorMessage(cls), cls.code, cls.isHardStop);
+      onStatusChange?.('error');
+      scheduleAutoRevert('error', ERROR_HOLD_MS);
+    } finally {
+      if (!skipLockCheck) syncing = false;
+    }
+  };
+
+  // ── download ────────────────────────────────────────────────────────────
+  /**
+   * Runs a full sync cycle: download → validate → merge → apply → upload-if-changed.
+   * Idempotent — if another sync is in progress, sets a follow-up flag so the
+   * current cycle reruns at completion to pick up the queued local change.
+   */
+  const download = async () => {
+    if (hardStopped) return;
+    const cfg = getConfig();
+    if (!cfg?.enabled) return;
+    const provider = providers[cfg.provider];
+    if (!provider) return;
+
+    if (syncing) {
+      pendingFollowup = true;
+      return;
+    }
+    syncing = true;
+    const t0 = Date.now();
+    onStatusChange?.('downloading');
+    onError?.(null, null, false);
+
+    let conflictShown = false;
+    let passphraseRequired = false;
+
+    // Inner helper: download, merge, apply, upload (if anything changed).
+    // Returns true if a reload was triggered (caller should bail).
+    const doCycle = async (overrideEtag) => {
+      const downloaded = await provider.download(cfg);
+      if (!downloaded) {
+        // Empty remote — seed it with local state.
+        await upload({ skipLockCheck: true });
+        return false;
+      }
+      const { payload: remoteRaw, etag } = downloaded;
+
+      // Validate envelope; hard-stop errors halt the sync without uploading.
+      let remote;
+      try {
+        remote = validateEnvelope(remoteRaw);
+      } catch (err) {
+        if (err.isHardStop) {
+          hardStopped = true;
+          onError?.(err.message, err.code, true);
+          onStatusChange?.('error');
+          return false;
+        }
+        throw err;
+      }
+
+      const hasNeverSynced = !localStorage.getItem(KEY_LAST_SYNCED);
+      if (hasNeverSynced && remote.lastModified) {
+        // First-sync conflict: don't auto-merge; let the user decide via UI.
+        conflictShown = true;
+        onConflict?.(remote.data, remote.lastModified, etag || null);
+        onStatusChange?.('idle');
+        return false;
+      }
+
+      const localBuilt = await buildPayload();
+      const localData = (localBuilt && typeof localBuilt === 'object' && 'data' in localBuilt)
+        ? localBuilt.data
+        : localBuilt;
+
+      const mergeResult = mergePayloads(localData, remote.data);
+      const { data: mergedData, localChanged, remoteChanged } = mergeResult;
+
+      if (localChanged) {
+        let mayApply = true;
+        if (validateApplyPayload) {
+          const check = await validateApplyPayload({ ...remote, data: mergedData });
+          if (!check?.valid) {
+            // eslint-disable-next-line no-console
+            console.error(`[${appId}] applyRemoteData aborted:`, check?.reason || 'validation failed');
+            mayApply = false;
+          }
+        }
+        if (mayApply) {
+          await applyPayload(mergedData, { allowEmpty: !!remote.lastModified });
+          localStorage.setItem(KEY_LOCAL_MOD, new Date().toISOString());
+        }
+      }
+
+      if (remoteChanged || localChanged) {
+        const mergedPayload = {
+          version: ENVELOPE_DATA_VERSION,
+          lastModified: new Date().toISOString(),
+          data: mergedData,
+        };
+        await upload({
+          prebuiltPayload: mergedPayload,
+          skipLockCheck: true,
+          etag: etag || overrideEtag || null,
+        });
+
+        if (hasNeverSynced && localChanged) {
+          onFirstSyncReload?.();
+          return true;
+        }
+      }
+      return false;
+    };
+
+    try {
+      const reloaded = await doCycle(null);
+      if (reloaded || conflictShown) return;
+
+      downloadErrorCount = 0;
+      downloadBackoffUntil = 0;
+      const elapsed = Date.now() - t0;
+      if (elapsed < MIN_SYNC_DURATION_MS) {
+        await new Promise(r => setTimeout(r, MIN_SYNC_DURATION_MS - elapsed));
+      }
+      const now = new Date().toISOString();
+      localStorage.setItem(KEY_LAST_SYNCED, now);
+      onLastSyncedChange?.(now);
+      onStatusChange?.('success');
+      scheduleAutoRevert('success', SUCCESS_HOLD_MS);
+    } catch (err) {
+      // eslint-disable-next-line no-console
+      console.error(`[${appId}] cloud sync download error:`, err);
+      const cls = classifyError(err);
+
+      if (cls.code === 'PASSPHRASE_REQUIRED') {
+        passphraseRequired = true;
+        onPassphraseRequired?.();
+        onError?.(cls.message, 'PASSPHRASE_REQUIRED', false);
+        onStatusChange?.('idle');
+        return;
+      }
+
+      if (cls.code === 'PRECONDITION_FAILED') {
+        // Another device wrote between our download and upload — retry once.
+        try {
+          await doCycle(null);
+          downloadErrorCount = 0;
+          downloadBackoffUntil = 0;
+        } catch (retryErr) {
+          // eslint-disable-next-line no-console
+          console.error(`[${appId}] cloud sync retry after 412 failed:`, retryErr);
+        }
+        return;
+      }
+
+      if (cls.code === 'AUTH_FAILURE') {
+        downloadBackoffUntil = Date.now() + AUTH_FAILURE_BACKOFF_MS;
+      } else if (cls.code === 'LOCKED') {
+        downloadBackoffUntil = Date.now() + LOCK_BACKOFF_MS;
+      } else {
+        downloadErrorCount += 1;
+        const ms = Math.min(30 * Math.pow(2, downloadErrorCount - 1), MAX_DOWNLOAD_BACKOFF_S) * 1000;
+        downloadBackoffUntil = Date.now() + ms;
+      }
+
+      if (cls.isHardStop) hardStopped = true;
+      // Use the download variant of the 403 message for compatibility.
+      const msg = cls.code === 'FORBIDDEN'
+        ? 'Sync blocked (403) — your server may be blocking requests.'
+        : formatErrorMessage(cls);
+      onError?.(msg, cls.code, cls.isHardStop);
+      onStatusChange?.('error');
+      scheduleAutoRevert('error', ERROR_HOLD_MS);
+    } finally {
+      // Conflict path: leave lock held — the UI dialog handlers release it via
+      // resolveConflict*(). Passphrase path: release lock but don't mark sync
+      // initialised. Otherwise: release lock and drain the follow-up queue.
+      if (!conflictShown) {
+        syncing = false;
+        if (!passphraseRequired && pendingFollowup) {
+          pendingFollowup = false;
+          setTimeout(() => download(), 250);
+        }
+      }
+    }
+  };
+
+  // ── Backup ──────────────────────────────────────────────────────────────
+  /**
+   * Runs one auto-backup cycle: builds the backup payload, saves to local IDB,
+   * uploads to the remote backup directory, and prunes old copies. Independent
+   * of sync — uses buildBackupPayload (NOT buildPayload) since it may be called
+   * from a timer without React context.
+   */
+  const runBackup = async (frequency) => {
+    if (!buildBackupPayload) {
+      throw new Error('createSyncEngine: buildBackupPayload is required to call runBackup()');
+    }
+    const cfg = getConfig();
+    if (!cfg?.enabled) return;
+    const backupProvider = autoBackupProviders[cfg.provider] || autoBackupProviders.webdav;
+    if (!backupProvider) return;
+
+    const data = await buildBackupPayload();
+    await autoBackupDB.saveBackup(frequency, data);
+    const max = AUTO_BACKUP_RETENTION[frequency];
+    if (max) await autoBackupDB.pruneBackups(frequency, max);
+    try {
+      await backupProvider.uploadBackup(cfg, data);
+    } catch (err) {
+      // eslint-disable-next-line no-console
+      console.error(`[${appId}] auto-backup upload error:`, err);
+      onError?.(err.message, classifyError(err).code, false);
+    }
+  };
+
+  // ── Connection test ─────────────────────────────────────────────────────
+  const testConnection = async (testCfg) => {
+    const provider = providers[testCfg.provider];
+    if (!provider) return { success: false, error: 'Unknown provider' };
+    try { return await provider.test(testCfg); }
+    catch (err) { return { success: false, error: err.message }; }
+  };
+
+  // ── Public API ──────────────────────────────────────────────────────────
+  return {
+    // Lifecycle
+    sync: download,
+    upload,
+    download,
+    runBackup,
+    test: testConnection,
+
+    // Config
+    getConfig,
+    setConfig,
+    getLastSynced,
+
+    // State queries
+    isSyncing:               () => syncing,
+    isHardStopped:           () => hardStopped,
+    clearHardStop:           () => { hardStopped = false; },
+    hasEncryptionReady,
+    getUploadBackoffUntil:   () => uploadBackoffUntil,
+    getDownloadBackoffUntil: () => downloadBackoffUntil,
+
+    // Sub-modules (exposed for app-level features the engine doesn't own —
+    // e.g. dayGLANCE's conflict-resolution dialog and its iCloud sync code).
+    providers,
+    autoBackupDB,
+    autoBackupProviders,
+    webdavFetch: wf,
+  };
+};
+
+export {
+  AUTO_BACKUP_RETENTION,
+  AUTO_BACKUP_INTERVALS,
+};

package/src/index.js

@@ -23,3 +23,16 @@ export {
 // webdavFetch and createProviders are internal to the engine (Step 6) but
 // exported here so shims can wire them before the engine exists.
 export { webdavFetch, createProviders } from './providers.js';
+
+export {
+  createAutoBackupDB,
+  createAutoBackupProviders,
+  AUTO_BACKUP_RETENTION,
+  AUTO_BACKUP_INTERVALS,
+} from './autoBackup.js';
+
+export {
+  createSyncEngine,
+  SCHEMA_VERSION,
+  SUPPORTED_MAX_SCHEMA_VERSION,
+} from './engine.js';

package/types/index.d.ts

@@ -1,5 +1,330 @@
 // Type declarations for @glance-apps/sync
-// Stub — filled in during Step 6 (see docs/sync-package/SYNC_PACKAGE_SPEC.md
-// and EXTRACTION_PLAN.md in the dayGLANCE repo).
+//
+// Covers the full public API exported from src/index.js. The JSDoc on the
+// source files is the source of truth for behavior; these declarations only
+// express the shape of values crossing the package boundary.
 
-export {};
+// ---------------------------------------------------------------------------
+// Error codes
+// ---------------------------------------------------------------------------
+
+export type SyncErrorCode =
+  | 'APP_ID_MISMATCH'
+  | 'SCHEMA_FORWARD_INCOMPATIBLE'
+  | 'PASSPHRASE_REQUIRED'
+  | 'PRECONDITION_FAILED'
+  | 'FORBIDDEN'
+  | 'AUTH_FAILURE'
+  | 'LOCKED'
+  | 'NETWORK_ERROR';
+
+export type SyncStatus = 'idle' | 'uploading' | 'downloading' | 'success' | 'error';
+
+// ---------------------------------------------------------------------------
+// Envelope shape
+// ---------------------------------------------------------------------------
+
+export interface SyncEnvelope<TData = unknown> {
+  schemaVersion: number;
+  appId: string;
+  version: number;
+  lastModified: string; // ISO 8601
+  data: TData;
+}
+
+export interface EncryptedEnvelope {
+  v: 1;
+  enc: 'AES-GCM-256';
+  data: string; // base64
+}
+
+// ---------------------------------------------------------------------------
+// Transport bridges (all optional; engine selects the first non-null tier)
+// ---------------------------------------------------------------------------
+
+export interface NativeHttpResponse {
+  status: number;
+  ok: boolean;
+  body: string;
+  headers?: { etag?: string };
+  error?: string;
+}
+
+export type NativeHttpRequest = (
+  method: string,
+  url: string,
+  headers: Record<string, string>,
+  body: string | null,
+) => NativeHttpResponse | null;
+
+export type ElectronProxyFetch = (
+  method: string,
+  url: string,
+  headers: Record<string, string>,
+  body: string | null,
+) => Promise<{
+  status: number;
+  ok: boolean;
+  statusText: string;
+  body: string;
+  headers?: { etag?: string };
+}>;
+
+// ---------------------------------------------------------------------------
+// Merge engine
+// ---------------------------------------------------------------------------
+
+export interface MergeResult<T> {
+  merged: T[];
+  localChanged: boolean;
+  remoteChanged: boolean;
+}
+
+export interface MergeArrayOptions {
+  idField?: string;
+  timestampField?: string;
+}
+
+export function mergeArrayById<T extends Record<string, unknown>>(
+  localItems: T[],
+  remoteItems: T[],
+  deletedIds: Record<string, string>,
+  syncHorizon?: Date | null,
+  options?: MergeArrayOptions,
+): MergeResult<T>;
+
+export function mergeDailyNotes<T>(
+  local: Record<string, T>,
+  remote: Record<string, T>,
+): { merged: Record<string, T>; localChanged: boolean; remoteChanged: boolean };
+
+export function mergeHabits<T extends Record<string, unknown>>(
+  localHabits: T[],
+  remoteHabits: T[],
+  localDeletedIds?: Record<string, string>,
+  remoteDeletedIds?: Record<string, string>,
+): {
+  merged: T[];
+  mergedDeletedIds: Record<string, string>;
+  localChanged: boolean;
+  remoteChanged: boolean;
+};
+
+export function mergeHabitLogs<T = number>(
+  localLogs: Record<string, Record<string, T>>,
+  remoteLogs: Record<string, Record<string, T>>,
+  localTs?: Record<string, string>,
+  remoteTs?: Record<string, string>,
+): {
+  merged: Record<string, Record<string, T>>;
+  mergedTimestamps: Record<string, string>;
+  localChanged: boolean;
+  remoteChanged: boolean;
+};
+
+export function mergeRoutineDefinitions<T extends { id: string | number }>(
+  localDefs: Record<string, T[]>,
+  remoteDefs: Record<string, T[]>,
+  deletedChipIds?: Record<string, string>,
+): { merged: Record<string, T[]>; localChanged: boolean; remoteChanged: boolean };
+
+export function mergeSyncData<TLocal extends Record<string, unknown>, TRemote extends Record<string, unknown>>(
+  localData: TLocal,
+  remoteData: TRemote,
+  retentionDays?: number,
+): { data: Record<string, unknown>; localChanged: boolean; remoteChanged: boolean };
+
+export function pruneTombstones(
+  tombstones: Record<string, string>,
+  cutoff: Date | null,
+): Record<string, string>;
+
+// ---------------------------------------------------------------------------
+// Crypto
+// ---------------------------------------------------------------------------
+
+export interface CryptoConfig {
+  cryptoDBName: string;
+  nativeGetSyncKey?: (() => string | null | Promise<string | null>) | null;
+  nativeStoreSyncKey?: ((value: string | null) => void) | null;
+}
+
+export function initSessionKey(config: CryptoConfig): Promise<boolean>;
+export function setupEncryptionKey(passphrase: string, config: CryptoConfig): Promise<void>;
+export function clearEncryptionKey(config: CryptoConfig): Promise<void>;
+export function setSyncPassphrase(passphrase: string | null): void;
+export function getSyncPassphrase(): string | null;
+export function hasEncryptionReady(): boolean;
+export function encryptData<T>(data: T, config?: CryptoConfig): Promise<EncryptedEnvelope>;
+export function decryptData<T = unknown>(envelope: EncryptedEnvelope, config?: CryptoConfig): Promise<T>;
+export function isEncryptedEnvelope(value: unknown): value is EncryptedEnvelope;
+
+// ---------------------------------------------------------------------------
+// Auto-backup
+// ---------------------------------------------------------------------------
+
+export type BackupFrequency = 'hourly' | 'daily' | 'weekly';
+
+export interface BackupRecord<TData = unknown> {
+  id: string;
+  timestamp: string;
+  frequency: BackupFrequency;
+  data: TData;
+}
+
+export interface AutoBackupDB {
+  open(): Promise<IDBDatabase>;
+  saveBackup<TData>(frequency: BackupFrequency, data: TData): Promise<BackupRecord<TData>>;
+  listBackups<TData>(frequency?: BackupFrequency): Promise<BackupRecord<TData>[]>;
+  getBackup<TData>(id: string): Promise<BackupRecord<TData> | undefined>;
+  deleteBackup(id: string): Promise<void>;
+  pruneBackups(frequency: BackupFrequency, maxCount: number): Promise<number | undefined>;
+}
+
+export interface AutoBackupProvider {
+  name: string;
+  uploadBackup(providerConfig: Record<string, unknown>, data: unknown): Promise<string>;
+  listBackups(providerConfig: Record<string, unknown>): Promise<Array<{ filename: string; lastModified: string | null }>>;
+  downloadBackup(providerConfig: Record<string, unknown>, filename: string): Promise<unknown>;
+  deleteBackup(providerConfig: Record<string, unknown>, filename: string): Promise<void>;
+  testConnection(providerConfig: Record<string, unknown>): Promise<{ success: boolean; error?: string }>;
+}
+
+export interface AutoBackupRetention {
+  hourly: number;
+  daily: number;
+  weekly: number;
+}
+
+export interface AutoBackupIntervals {
+  hourly: number;
+  daily: number;
+  weekly: number;
+}
+
+export const AUTO_BACKUP_RETENTION: AutoBackupRetention;
+export const AUTO_BACKUP_INTERVALS: AutoBackupIntervals;
+
+export function createAutoBackupDB(config: { autoBackupDBName: string }): AutoBackupDB;
+export function createAutoBackupProviders(config: {
+  backupFilenamePrefix: string;
+  appFolderName: string;
+  webdavFetch: WebdavFetch;
+}): Record<string, AutoBackupProvider>;
+
+// ---------------------------------------------------------------------------
+// Providers / transport
+// ---------------------------------------------------------------------------
+
+export type WebdavFetch = (
+  method: string,
+  url: string,
+  authHeaders: Record<string, string>,
+  body?: string | null,
+  extraHeaders?: Record<string, string>,
+) => Promise<{
+  status: number;
+  ok: boolean;
+  statusText?: string;
+  headers: { get(name: string): string | null };
+  json(): Promise<unknown>;
+  text(): Promise<string>;
+}>;
+
+export interface CloudSyncProvider {
+  name: string;
+  configFields: Array<{ key: string; label: string; type: string; placeholder?: string }>;
+  helpText?: string;
+  upload(config: Record<string, unknown>, envelope: SyncEnvelope, etag?: string | null): Promise<boolean>;
+  download(config: Record<string, unknown>): Promise<{ payload: unknown; etag: string | null } | null>;
+  test(config: Record<string, unknown>): Promise<{ success: boolean; error?: string }>;
+}
+
+export function webdavFetch(config: SyncEngineConfig): WebdavFetch;
+export function createProviders(config: SyncEngineConfig): Record<string, CloudSyncProvider>;
+
+// ---------------------------------------------------------------------------
+// Sync engine
+// ---------------------------------------------------------------------------
+
+export interface ValidationResult {
+  valid: boolean;
+  reason?: string;
+}
+
+export interface SyncEngineConfig {
+  // Identity
+  storageKeyPrefix: string;
+  cryptoDBName: string;
+  autoBackupDBName: string;
+  syncFilename: string;
+  appFolderName: string;
+  backupFilenamePrefix: string;
+  appId: string;
+  appName: string;
+
+  // Transport bridges (optional, listed in priority order)
+  nativeHttpRequest?: NativeHttpRequest | null;
+  electronProxyFetch?: ElectronProxyFetch | null;
+  proxyUrl?: string;
+
+  // Crypto bridges (forwarded to crypto.js)
+  nativeGetSyncKey?: (() => string | null | Promise<string | null>) | null;
+  nativeStoreSyncKey?: ((value: string | null) => void) | null;
+
+  // Data lifecycle callbacks
+  buildPayload: () => unknown | Promise<unknown>;
+  buildBackupPayload?: () => unknown | Promise<unknown>;
+  applyPayload: (data: unknown, opts: { allowEmpty: boolean }) => void | Promise<void>;
+  mergePayloads: (local: unknown, remote: unknown) => {
+    data: unknown;
+    localChanged: boolean;
+    remoteChanged: boolean;
+  };
+  validateUploadPayload?: (payload: SyncEnvelope) => ValidationResult | Promise<ValidationResult>;
+  validateApplyPayload?: (payload: SyncEnvelope) => ValidationResult | Promise<ValidationResult>;
+
+  // Event callbacks
+  onStatusChange?: (status: SyncStatus, hints?: { from?: SyncStatus }) => void;
+  onError?: (message: string | null, code: SyncErrorCode | null, isHardStop: boolean) => void;
+  onLastSyncedChange?: (isoString: string) => void;
+  onConflict?: (remoteData: unknown, remoteModified: string, etag: string | null) => void;
+  onPassphraseRequired?: () => void;
+  onFirstSyncReload?: () => void;
+
+  // Retention
+  retentionDays?: number;
+}
+
+export interface SyncEngine {
+  sync(): Promise<void>;
+  upload(opts?: {
+    prebuiltPayload?: unknown;
+    etag?: string | null;
+    skipLockCheck?: boolean;
+  }): Promise<void>;
+  download(): Promise<void>;
+  runBackup(frequency: BackupFrequency): Promise<void>;
+  test(config: Record<string, unknown>): Promise<{ success: boolean; error?: string }>;
+
+  getConfig(): Record<string, unknown> | null;
+  setConfig(config: Record<string, unknown> | null): void;
+  getLastSynced(): string | null;
+
+  isSyncing(): boolean;
+  isHardStopped(): boolean;
+  clearHardStop(): void;
+  hasEncryptionReady(): boolean;
+  getUploadBackoffUntil(): number;
+  getDownloadBackoffUntil(): number;
+
+  providers: Record<string, CloudSyncProvider>;
+  autoBackupDB: AutoBackupDB;
+  autoBackupProviders: Record<string, AutoBackupProvider>;
+  webdavFetch: WebdavFetch;
+}
+
+export function createSyncEngine(config: SyncEngineConfig): SyncEngine;
+
+export const SCHEMA_VERSION: number;
+export const SUPPORTED_MAX_SCHEMA_VERSION: number;