/* * notion-enhancer core: api * (c) 2021 dragonwocky (https://dragonwocky.me/) * (https://notion-enhancer.github.io/) under the MIT license */ 'use strict'; /** * environment-specific data persistence * @module notion-enhancer/api/storage */ /** * get persisted data * @param {array} path - the path of keys to the value being fetched * @param {*} [fallback] - a default value if the path is not matched * @returns {Promise} value ?? fallback */ export const get = (path, fallback = undefined) => { return window.__enhancerElectronApi.db.get(path, fallback); }; /** * persist data * @param {array} path - the path of keys to the value being set * @param {*} value - the data to save * @returns {Promise} resolves when data has been saved */ export const set = (path, value) => { return window.__enhancerElectronApi.db.set(path, value); }; /** * create a wrapper for accessing a partition of the storage * @param {array} namespace - the path of keys to prefix all storage requests with * @param {function} [get] - the storage get function to be wrapped * @param {function} [set] - the storage set function to be wrapped * @returns {object} an object with the wrapped get/set functions */ export const db = (namespace, getFunc = get, setFunc = set) => { if (typeof namespace === 'string') namespace = [namespace]; return { get: (path = [], fallback = undefined) => getFunc([...namespace, ...path], fallback), set: (path, value) => setFunc([...namespace, ...path], value), }; }; /** * add an event listener for changes in storage * @param {onStorageChangeCallback} callback - called whenever a change in * storage is initiated from the current process */ export const addChangeListener = (callback) => { return window.__enhancerElectronApi.db.addChangeListener(callback); }; /** * remove a listener added with storage.addChangeListener * @param {onStorageChangeCallback} callback */ export const removeChangeListener = (callback) => { return window.__enhancerElectronApi.db.removeChangeListener(callback); }; /** * @callback onStorageChangeCallback * @param {object} event * @param {string} event.type - 'set' or 'reset' * @param {string} event.namespace- the name of the store, e.g. a mod id * @param {string} [event.key] - the key associated with the changed value * @param {string} [event.new] - the new value being persisted to the store * @param {string} [event.old] - the previous value associated with the key */