/** * Store.ts * * Abstraction for a persistent data store, that supports versioning and upgrade. */ import { remote } from "electron" import * as Log from "oni-core-logging" // We need to use the 'main process' version of electron-settings. // See: https://github.com/nathanbuchar/electron-settings/wiki/FAQs const PersistentSettings = remote.require("electron-settings") export interface IPersistentStore { get(): Promise set(value: T): Promise delete(key: string): Promise has(key: string): boolean } export const getPersistentStore = ( storeIdentifier: string, defaultValue: T, currentVersion: number = 0, ): IPersistentStore => { return new PersistentStore(storeIdentifier, defaultValue, currentVersion) } export interface IPersistedValueWithMetadata { schemaVersion: number value: T } export class PersistentStore implements IPersistentStore { private _currentValue: IPersistedValueWithMetadata = null constructor( private _storeKey: string, private _defaultValue: T, private _currentVersion: number, ) { let val = null try { val = JSON.parse(PersistentSettings.get(this._storeKey)) } catch (ex) { Log.warn("Error deserializing from store: " + ex) } this._currentValue = val if (!this._currentValue) { this._currentValue = { value: this._defaultValue, schemaVersion: this._currentVersion, } } // TODO: Check if _currentVersion is ahead of the value, // if so, upgrade } public async get(): Promise { return this._currentValue.value } public async set(val: T): Promise { this._currentValue = { value: val, schemaVersion: this._currentVersion, } PersistentSettings.set(this._storeKey, JSON.stringify(this._currentValue)) } public has(key: string) { return PersistentSettings.has(key) } public async delete(key: string) { return PersistentSettings.delete(`${this._storeKey}.${key}`) } }