263 lines
6.8 KiB
JavaScript
263 lines
6.8 KiB
JavaScript
/* eslint-env browser */
|
|
|
|
/**
|
|
* Helpers to work with IndexedDB.
|
|
*
|
|
* @module indexeddb
|
|
*/
|
|
|
|
import * as promise from './promise.js'
|
|
import * as error from './error.js'
|
|
|
|
/* c8 ignore start */
|
|
|
|
/**
|
|
* IDB Request to Promise transformer
|
|
*
|
|
* @param {IDBRequest} request
|
|
* @return {Promise<any>}
|
|
*/
|
|
export const rtop = request => promise.create((resolve, reject) => {
|
|
// @ts-ignore
|
|
request.onerror = event => reject(new Error(event.target.error))
|
|
// @ts-ignore
|
|
request.onsuccess = event => resolve(event.target.result)
|
|
})
|
|
|
|
/**
|
|
* @param {string} name
|
|
* @param {function(IDBDatabase):any} initDB Called when the database is first created
|
|
* @return {Promise<IDBDatabase>}
|
|
*/
|
|
export const openDB = (name, initDB) => promise.create((resolve, reject) => {
|
|
const request = indexedDB.open(name)
|
|
/**
|
|
* @param {any} event
|
|
*/
|
|
request.onupgradeneeded = event => initDB(event.target.result)
|
|
/**
|
|
* @param {any} event
|
|
*/
|
|
request.onerror = event => reject(error.create(event.target.error))
|
|
/**
|
|
* @param {any} event
|
|
*/
|
|
request.onsuccess = event => {
|
|
/**
|
|
* @type {IDBDatabase}
|
|
*/
|
|
const db = event.target.result
|
|
db.onversionchange = () => { db.close() }
|
|
resolve(db)
|
|
}
|
|
})
|
|
|
|
/**
|
|
* @param {string} name
|
|
*/
|
|
export const deleteDB = name => rtop(indexedDB.deleteDatabase(name))
|
|
|
|
/**
|
|
* @param {IDBDatabase} db
|
|
* @param {Array<Array<string>|Array<string|IDBObjectStoreParameters|undefined>>} definitions
|
|
*/
|
|
export const createStores = (db, definitions) => definitions.forEach(d =>
|
|
// @ts-ignore
|
|
db.createObjectStore.apply(db, d)
|
|
)
|
|
|
|
/**
|
|
* @param {IDBDatabase} db
|
|
* @param {Array<string>} stores
|
|
* @param {"readwrite"|"readonly"} [access]
|
|
* @return {Array<IDBObjectStore>}
|
|
*/
|
|
export const transact = (db, stores, access = 'readwrite') => {
|
|
const transaction = db.transaction(stores, access)
|
|
return stores.map(store => getStore(transaction, store))
|
|
}
|
|
|
|
/**
|
|
* @param {IDBObjectStore} store
|
|
* @param {IDBKeyRange} [range]
|
|
* @return {Promise<number>}
|
|
*/
|
|
export const count = (store, range) =>
|
|
rtop(store.count(range))
|
|
|
|
/**
|
|
* @param {IDBObjectStore} store
|
|
* @param {String | number | ArrayBuffer | Date | Array<any> } key
|
|
* @return {Promise<String | number | ArrayBuffer | Date | Array<any>>}
|
|
*/
|
|
export const get = (store, key) =>
|
|
rtop(store.get(key))
|
|
|
|
/**
|
|
* @param {IDBObjectStore} store
|
|
* @param {String | number | ArrayBuffer | Date | IDBKeyRange | Array<any> } key
|
|
*/
|
|
export const del = (store, key) =>
|
|
rtop(store.delete(key))
|
|
|
|
/**
|
|
* @param {IDBObjectStore} store
|
|
* @param {String | number | ArrayBuffer | Date | boolean} item
|
|
* @param {String | number | ArrayBuffer | Date | Array<any>} [key]
|
|
*/
|
|
export const put = (store, item, key) =>
|
|
rtop(store.put(item, key))
|
|
|
|
/**
|
|
* @param {IDBObjectStore} store
|
|
* @param {String | number | ArrayBuffer | Date | boolean} item
|
|
* @param {String | number | ArrayBuffer | Date | Array<any>} key
|
|
* @return {Promise<any>}
|
|
*/
|
|
export const add = (store, item, key) =>
|
|
rtop(store.add(item, key))
|
|
|
|
/**
|
|
* @param {IDBObjectStore} store
|
|
* @param {String | number | ArrayBuffer | Date} item
|
|
* @return {Promise<number>} Returns the generated key
|
|
*/
|
|
export const addAutoKey = (store, item) =>
|
|
rtop(store.add(item))
|
|
|
|
/**
|
|
* @param {IDBObjectStore} store
|
|
* @param {IDBKeyRange} [range]
|
|
* @param {number} [limit]
|
|
* @return {Promise<Array<any>>}
|
|
*/
|
|
export const getAll = (store, range, limit) =>
|
|
rtop(store.getAll(range, limit))
|
|
|
|
/**
|
|
* @param {IDBObjectStore} store
|
|
* @param {IDBKeyRange} [range]
|
|
* @param {number} [limit]
|
|
* @return {Promise<Array<any>>}
|
|
*/
|
|
export const getAllKeys = (store, range, limit) =>
|
|
rtop(store.getAllKeys(range, limit))
|
|
|
|
/**
|
|
* @param {IDBObjectStore} store
|
|
* @param {IDBKeyRange|null} query
|
|
* @param {'next'|'prev'|'nextunique'|'prevunique'} direction
|
|
* @return {Promise<any>}
|
|
*/
|
|
export const queryFirst = (store, query, direction) => {
|
|
/**
|
|
* @type {any}
|
|
*/
|
|
let first = null
|
|
return iterateKeys(store, query, key => {
|
|
first = key
|
|
return false
|
|
}, direction).then(() => first)
|
|
}
|
|
|
|
/**
|
|
* @param {IDBObjectStore} store
|
|
* @param {IDBKeyRange?} [range]
|
|
* @return {Promise<any>}
|
|
*/
|
|
export const getLastKey = (store, range = null) => queryFirst(store, range, 'prev')
|
|
|
|
/**
|
|
* @param {IDBObjectStore} store
|
|
* @param {IDBKeyRange?} [range]
|
|
* @return {Promise<any>}
|
|
*/
|
|
export const getFirstKey = (store, range = null) => queryFirst(store, range, 'next')
|
|
|
|
/**
|
|
* @typedef KeyValuePair
|
|
* @type {Object}
|
|
* @property {any} k key
|
|
* @property {any} v Value
|
|
*/
|
|
|
|
/**
|
|
* @param {IDBObjectStore} store
|
|
* @param {IDBKeyRange} [range]
|
|
* @param {number} [limit]
|
|
* @return {Promise<Array<KeyValuePair>>}
|
|
*/
|
|
export const getAllKeysValues = (store, range, limit) =>
|
|
// @ts-ignore
|
|
promise.all([getAllKeys(store, range, limit), getAll(store, range, limit)]).then(([ks, vs]) => ks.map((k, i) => ({ k, v: vs[i] })))
|
|
|
|
/**
|
|
* @param {any} request
|
|
* @param {function(IDBCursorWithValue):void|boolean|Promise<void|boolean>} f
|
|
* @return {Promise<void>}
|
|
*/
|
|
const iterateOnRequest = (request, f) => promise.create((resolve, reject) => {
|
|
request.onerror = reject
|
|
/**
|
|
* @param {any} event
|
|
*/
|
|
request.onsuccess = async event => {
|
|
const cursor = event.target.result
|
|
if (cursor === null || (await f(cursor)) === false) {
|
|
return resolve()
|
|
}
|
|
cursor.continue()
|
|
}
|
|
})
|
|
|
|
/**
|
|
* Iterate on keys and values
|
|
* @param {IDBObjectStore} store
|
|
* @param {IDBKeyRange|null} keyrange
|
|
* @param {function(any,any):void|boolean|Promise<void|boolean>} f Callback that receives (value, key)
|
|
* @param {'next'|'prev'|'nextunique'|'prevunique'} direction
|
|
*/
|
|
export const iterate = (store, keyrange, f, direction = 'next') =>
|
|
iterateOnRequest(store.openCursor(keyrange, direction), cursor => f(cursor.value, cursor.key))
|
|
|
|
/**
|
|
* Iterate on the keys (no values)
|
|
*
|
|
* @param {IDBObjectStore} store
|
|
* @param {IDBKeyRange|null} keyrange
|
|
* @param {function(any):void|boolean|Promise<void|boolean>} f callback that receives the key
|
|
* @param {'next'|'prev'|'nextunique'|'prevunique'} direction
|
|
*/
|
|
export const iterateKeys = (store, keyrange, f, direction = 'next') =>
|
|
iterateOnRequest(store.openKeyCursor(keyrange, direction), cursor => f(cursor.key))
|
|
|
|
/**
|
|
* Open store from transaction
|
|
* @param {IDBTransaction} t
|
|
* @param {String} store
|
|
* @returns {IDBObjectStore}
|
|
*/
|
|
export const getStore = (t, store) => t.objectStore(store)
|
|
|
|
/**
|
|
* @param {any} lower
|
|
* @param {any} upper
|
|
* @param {boolean} lowerOpen
|
|
* @param {boolean} upperOpen
|
|
*/
|
|
export const createIDBKeyRangeBound = (lower, upper, lowerOpen, upperOpen) => IDBKeyRange.bound(lower, upper, lowerOpen, upperOpen)
|
|
|
|
/**
|
|
* @param {any} upper
|
|
* @param {boolean} upperOpen
|
|
*/
|
|
export const createIDBKeyRangeUpperBound = (upper, upperOpen) => IDBKeyRange.upperBound(upper, upperOpen)
|
|
|
|
/**
|
|
* @param {any} lower
|
|
* @param {boolean} lowerOpen
|
|
*/
|
|
export const createIDBKeyRangeLowerBound = (lower, lowerOpen) => IDBKeyRange.lowerBound(lower, lowerOpen)
|
|
|
|
/* c8 ignore stop */
|