memorio 5.1.2 → 5.1.4

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "memorio",
   "codeName": "memorio",
-  "version": "5.1.2",
+  "version": "5.1.4",
   "description": "Memorio, State + Observer, Store and iDB for an easy life - Cross-platform compatible",
   "main": "./index.cjs",
   "browser": {
@@ -78,6 +78,7 @@
     "SECURITY-HARDENING.md",
     "SUMMARY.md",
     "LICENSE.md",
+    "CHANGELOG.md",
     "index.d.ts",
     "global.d.ts",
     "global.cjs",
@@ -89,7 +90,11 @@
   "publishConfig": {
     "access": "public"
   },
-  "sideEffects": true,
+  "sideEffects": [
+    "./global.js",
+    "./global.cjs",
+    "./core/global.ts"
+  ],
   "support": {
     "name": "Dario Passariello",
     "url": "https://dario.passariello.ca/",

package/types/sqlite.d.ts

@@ -1,35 +1,58 @@
-/*!
-  memorio
-  Copyright (c) 2019 Dario Passariello <dariopassariello@gmail.com>
-  Licensed under MIT License, see
-  dario.passariello.ca
-*/
-
-/**
- * Memorio SQLite module.
- *
- * Backed by the optional `sql.js` package (SQLite compiled to WebAssembly).
- * Lazily loaded in the browser; disabled in non-browser environments.
- */
-interface _sqlite {
-  /** Database connection tools (create, get, delete, list, size, export, import). */
-  db: any
-  /** SQL execution tools (run, select). */
-  query: any
-  /** CRUD shortcut helpers (set, get). */
-  data: any
-  /** Lazy-load / configure the sql.js engine (wasm loader, locateFile, etc.). */
-  config: (opts: any) => any
-  /** Promise that resolves once the sql.js engine has been initialized. */
-  ready: Promise<void> | null
-  /** True when running outside a supported browser environment. */
-  _disabled?: boolean
-  /** Human readable reason the module is disabled, when applicable. */
-  _warning?: string
-  [key: string]: any
-}
-
-declare var sqlite: _sqlite
-type sqlite = _sqlite
-
-declare var sqlbases: any[]
+/*!
+  memorio
+  Copyright (c) 2019 Dario Passariello <dariopassariello@gmail.com>
+  Licensed under MIT License, see
+  dario.passariello.ca
+*/
+
+/**
+ * Memorio SQLite module.
+ *
+ * Backed by the optional `sql.js` package (SQLite compiled to WebAssembly).
+ * Lazily loaded in the browser; disabled in non-browser environments.
+ */
+interface _sqlite {
+  /** Database connection tools (create, get, delete, list, size, export, import). */
+  db: any
+  /** SQL execution tools (run, select). */
+  query: any
+  /** CRUD shortcut helpers (set, get). */
+  data: any
+  /** Lazy-load / configure the sql.js engine (wasm loader, locateFile, etc.). */
+  config: (opts: any) => any
+  /** Promise that resolves once the sql.js engine has been initialized. */
+  ready: Promise<void> | null
+  /** True when running outside a supported browser environment. */
+  _disabled?: boolean
+  /** Human readable reason the module is disabled, when applicable. */
+  _warning?: string
+  [key: string]: any
+}
+
+interface _sqliteJournal {
+  /** Append a SQL write operation to the journal (with HLC timestamp). */
+  append: (name: string, sql: string, params: any[]) => number
+  /** Retrieve all pending journal entries for a db, ordered by HLC. */
+  entries: (name: string) => SqliteJournalEntry[]
+  /** Number of pending journal entries for a db. */
+  count: (name: string) => number
+  /** Clear all journal entries for a db. */
+  clear: (name: string) => void
+  /** Replay all journal entries onto a live db handle. */
+  replay: (name: string, db: any) => Promise<number>
+  /** Force a checkpoint (full snapshot + journal clear). */
+  checkpoint: (name: string) => Promise<boolean>
+}
+
+interface SqliteJournalEntry {
+  hlc: string
+  sql: string
+  params: any[]
+  seq: number
+  ts: number
+}
+
+declare var sqlite: _sqlite
+type sqlite = _sqlite
+
+declare var sqlbases: any[]

package/types/state.d.ts

@@ -54,13 +54,27 @@ interface _state {
   readonly list?: () => object
 
   /**
-  * Generate a message for "memorio"
-  * Note: FOR INTERNAL USE ONLY.
-  * @since memorio 0.0.1
-  */
+   * Generate a message for "memorio"
+   * Note: FOR INTERNAL USE ONLY.
+   * @since memorio 0.0.1
+   */
   readonly mex?: any
 
-}
+  /**
+   * Persist a state path to the store and keep it synced.
+   *
+   * @example
+   * const stop = state.persist('state.user')
+   * // ... mutations to state.user are mirrored to store automatically
+   * stop() // call to stop mirroring
+   *
+   * @param path A `state.`-prefixed path (e.g. `'state.user'`). A bare key
+   *   like `'user'` is normalized.
+   * @return An unsubscribe function; call it to stop mirroring.
+   */
+  readonly persist: (path: string) => (() => void)
+
+}
 
 declare var state: _state
 type state = _state