@harperfast/harper 5.0.0-alpha.10

package/dist/utility/lmdb/commonUtility.js

@@ -0,0 +1,120 @@
+'use strict';
+const LMDB_ERRORS = require('../errors/commonErrors.js').LMDB_ERRORS_ENUM;
+// eslint-disable-next-line no-unused-vars
+const lmdb = require('lmdb');
+const lmdbTerms = require('./terms.js');
+const { OVERFLOW_MARKER, MAX_SEARCH_KEY_LENGTH } = lmdbTerms;
+const PRIMITIVES = ['number', 'string', 'symbol', 'boolean', 'bigint'];
+/**
+ * validates the env argument
+ * @param {lmdb.Transaction|lmdb.RootDatabase} env - environment object used thigh level to interact with all data in an
+ * environment
+ */
+function validateEnv(env) {
+    env = env?.primaryStore || env;
+    if (!env) {
+        throw new Error(LMDB_ERRORS.ENV_REQUIRED);
+    }
+}
+/**
+ * converts raw data to it's string version
+ * @param rawValue
+ * @returns {Number|String|null}
+ */
+function stringifyData(rawValue) {
+    if (rawValue === null || rawValue === undefined) {
+        return null;
+    }
+    let value;
+    try {
+        value = typeof rawValue === 'object' ? JSON.stringify(rawValue) : rawValue.toString();
+    }
+    catch {
+        value = rawValue.toString();
+    }
+    return value;
+}
+/**
+ * takes a raw value and converts it to be written to LMDB. lmdb-store accepts primitives ('number', 'string', 'symbol', 'boolean', 'bigint', buffer) and array of primitives as keys.
+ * if it is anything else we convert to string
+ * @param {*} key - raw value which needs to be converted
+ * @returns {*}
+ */
+function convertKeyValueToWrite(key) {
+    //if this is a primitive return the value
+    if (key instanceof Date) {
+        return key.valueOf();
+    }
+    return key;
+}
+/**
+ * Return all the indexable values from an attribute, ready to be indexed
+ */
+function getIndexedValues(value, indexNulls) {
+    if (value === null)
+        return indexNulls ? [null] : undefined;
+    if (value === undefined)
+        return;
+    if (PRIMITIVES.includes(typeof value)) {
+        if (value.length > MAX_SEARCH_KEY_LENGTH) {
+            return [value.slice(0, MAX_SEARCH_KEY_LENGTH) + OVERFLOW_MARKER];
+        }
+        return [value];
+    }
+    let values;
+    if (Array.isArray(value)) {
+        values = [];
+        for (let i = 0, l = value.length; i < l; i++) {
+            let element = value[i];
+            if (PRIMITIVES.includes(typeof element)) {
+                if (element.length > MAX_SEARCH_KEY_LENGTH)
+                    values.push(element.slice(0, MAX_SEARCH_KEY_LENGTH) + OVERFLOW_MARKER);
+                else
+                    values.push(element);
+            }
+            else if (element === null && indexNulls)
+                return values.push(null);
+            else if (element instanceof Date)
+                return values.push(element.getTime());
+        }
+    }
+    else if (value instanceof Date)
+        return [value.getTime()];
+    return values;
+}
+let lastTime = 0; // reported time used to ensure monotonic time.
+let startTime = 0; // the start time of the (current time relative to performance time counter)
+function adjustStartTime() {
+    // calculate the start time
+    // TODO: We may actually want to implement a gradual time shift if the clock time really changes substantially
+    // and for sub-millisecond updates, may want to average them so we can progressively narrow in on true time
+    startTime = Date.now() - performance.now();
+}
+adjustStartTime();
+// we periodically update our start time because clock time can drift (but we still ensure monotonic time)
+const TIME_ADJUSTMENT_INTERVAL = 60000;
+setInterval(adjustStartTime, TIME_ADJUSTMENT_INTERVAL).unref();
+/**
+ * A monotonic timestamp that is guaranteed to be higher than the last call to this function.
+ * Will use decimal microseconds as necessary to differentiate from previous calls without too much drift.
+ */
+function getNextMonotonicTime() {
+    let now = performance.now() + startTime;
+    if (now > lastTime) {
+        // current time is higher than last time, can safely return it
+        lastTime = now;
+        return now;
+    }
+    // otherwise, we MUST return a higher time than last time, so we increase the time and return it.
+    // increment by as small of count as possible, to minimize how far we are from clock time
+    lastTime += 0.000488;
+    return lastTime;
+}
+module.exports = {
+    validateEnv,
+    stringifyData,
+    convertKeyValueToWrite,
+    getNextMonotonicTime,
+    getIndexedValues,
+};
+//# sourceMappingURL=commonUtility.js.map

package/dist/utility/lmdb/commonUtility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commonUtility.js","sourceRoot":"","sources":["../../../utility/lmdb/commonUtility.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,MAAM,WAAW,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC,gBAAgB,CAAC;AAC1E,0CAA0C;AAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC7B,MAAM,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAExC,MAAM,EAAE,eAAe,EAAE,qBAAqB,EAAE,GAAG,SAAS,CAAC;AAC7D,MAAM,UAAU,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;AACvE;;;;GAIG;AACH,SAAS,WAAW,CAAC,GAAG;IACvB,GAAG,GAAG,GAAG,EAAE,YAAY,IAAI,GAAG,CAAC;IAC/B,IAAI,CAAC,GAAG,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAC3C,CAAC;AACF,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,QAAQ;IAC9B,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACjD,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,KAAK,CAAC;IAEV,IAAI,CAAC;QACJ,KAAK,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IACvF,CAAC;IAAC,MAAM,CAAC;QACR,KAAK,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,SAAS,sBAAsB,CAAC,GAAG;IAClC,yCAAyC;IACzC,IAAI,GAAG,YAAY,IAAI,EAAE,CAAC;QACzB,OAAO,GAAG,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAED;;GAEG;AACH,SAAS,gBAAgB,CAAC,KAAK,EAAE,UAAU;IAC1C,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3D,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO;IAChC,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QACvC,IAAI,KAAK,CAAC,MAAM,GAAG,qBAAqB,EAAE,CAAC;YAC1C,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,qBAAqB,CAAC,GAAG,eAAe,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC;IACD,IAAI,MAAM,CAAC;IACX,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,GAAG,EAAE,CAAC;QACZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC9C,IAAI,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACvB,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,OAAO,CAAC,EAAE,CAAC;gBACzC,IAAI,OAAO,CAAC,MAAM,GAAG,qBAAqB;oBACzC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,qBAAqB,CAAC,GAAG,eAAe,CAAC,CAAC;;oBACnE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3B,CAAC;iBAAM,IAAI,OAAO,KAAK,IAAI,IAAI,UAAU;gBAAE,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBAC/D,IAAI,OAAO,YAAY,IAAI;gBAAE,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;QACzE,CAAC;IACF,CAAC;SAAM,IAAI,KAAK,YAAY,IAAI;QAAE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3D,OAAO,MAAM,CAAC;AACf,CAAC;AAED,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAC,+CAA+C;AACjE,IAAI,SAAS,GAAG,CAAC,CAAC,CAAC,4EAA4E;AAC/F,SAAS,eAAe;IACvB,2BAA2B;IAC3B,8GAA8G;IAC9G,2GAA2G;IAC3G,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;AAC5C,CAAC;AACD,eAAe,EAAE,CAAC;AAClB,0GAA0G;AAC1G,MAAM,wBAAwB,GAAG,KAAK,CAAC;AACvC,WAAW,CAAC,eAAe,EAAE,wBAAwB,CAAC,CAAC,KAAK,EAAE,CAAC;AAC/D;;;GAGG;AACH,SAAS,oBAAoB;IAC5B,IAAI,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;IACxC,IAAI,GAAG,GAAG,QAAQ,EAAE,CAAC;QACpB,8DAA8D;QAC9D,QAAQ,GAAG,GAAG,CAAC;QACf,OAAO,GAAG,CAAC;IACZ,CAAC;IACD,iGAAiG;IACjG,yFAAyF;IACzF,QAAQ,IAAI,QAAQ,CAAC;IACrB,OAAO,QAAQ,CAAC;AACjB,CAAC;AACD,MAAM,CAAC,OAAO,GAAG;IAChB,WAAW;IACX,aAAa;IACb,sBAAsB;IACtB,oBAAoB;IACpB,gBAAgB;CAChB,CAAC"}

package/dist/utility/lmdb/deleteUtility.d.ts

@@ -0,0 +1,10 @@
+/**
+ *  deletes rows and their entries in all indices
+ * @param {lmdb.RootDatabase} env - environment object used high level to interact with all data in an environment
+ * @param {String} hash_attribute - name of the hash_attribute for this environment
+ * @param {Array.<String>} ids - list of ids to delete
+ * @param {number} whenDeleted - The timestamp of the deletion
+ * @returns {Promise<DeleteRecordsResponseObject>}
+ */
+export function deleteRecords(env: lmdb.RootDatabase, hash_attribute: string, ids: Array<string>, whenDeleted: number): Promise<DeleteRecordsResponseObject>;
+import DeleteRecordsResponseObject = require("./DeleteRecordsResponseObject.js");

package/dist/utility/lmdb/deleteUtility.js

@@ -0,0 +1,115 @@
+'use strict';
+const environmentUtil = require('./environmentUtility.js');
+const common = require('./commonUtility.js');
+const LMDB_ERRORS = require('../errors/commonErrors.js').LMDB_ERRORS_ENUM;
+const log = require('../logging/harper_logger.js');
+// eslint-disable-next-line no-unused-vars
+const lmdb = require('lmdb');
+const DeleteRecordsResponseObject = require('./DeleteRecordsResponseObject.js');
+const hdbTerms = require("../hdbTerms.js");
+const UPDATED_TIME_ATTRIBUTE_NAME = hdbTerms.TIME_STAMP_NAMES_ENUM.UPDATED_TIME;
+/**
+ *  deletes rows and their entries in all indices
+ * @param {lmdb.RootDatabase} env - environment object used high level to interact with all data in an environment
+ * @param {String} hash_attribute - name of the hash_attribute for this environment
+ * @param {Array.<String>} ids - list of ids to delete
+ * @param {number} whenDeleted - The timestamp of the deletion
+ * @returns {Promise<DeleteRecordsResponseObject>}
+ */
+async function deleteRecords(env, hash_attribute, ids, whenDeleted) {
+    //validate
+    common.validateEnv(env);
+    if (hash_attribute === undefined) {
+        throw new Error(LMDB_ERRORS.HASH_ATTRIBUTE_REQUIRED);
+    }
+    if (!Array.isArray(ids)) {
+        if (ids === undefined) {
+            throw new Error(LMDB_ERRORS.IDS_REQUIRED);
+        }
+        throw new Error(LMDB_ERRORS.IDS_MUST_BE_ITERABLE);
+    }
+    try {
+        //open all dbis for this env
+        let allDbis = environmentUtil.listDBIs(env);
+        environmentUtil.initializeDBIs(env, hash_attribute, allDbis);
+        let deleted = new DeleteRecordsResponseObject();
+        //iterate records and process deletes
+        let hashValue;
+        let puts = [];
+        let keys = [];
+        for (let x = 0, length = ids.length; x < length; x++) {
+            try {
+                hashValue = ids[x];
+                //attempt to fetch the hash attribute value, this is the row.
+                let record = env.dbis[hash_attribute].get(hashValue);
+                //if it doesn't exist we skip & move to the next id
+                if (!record ||
+                    // of if the deletion timestamp is older than the current record, last-write wins
+                    (whenDeleted && record[UPDATED_TIME_ATTRIBUTE_NAME] > whenDeleted)) {
+                    deleted.skipped.push(hashValue);
+                    continue;
+                }
+                let promise = env.dbis[hash_attribute].ifVersion(hashValue, lmdb.IF_EXISTS, () => {
+                    //always just delete the hash_attribute entry upfront
+                    env.dbis[hash_attribute].remove(hashValue);
+                    //iterate & delete the non-hash attribute entries
+                    for (let y = 0; y < allDbis.length; y++) {
+                        let attribute = allDbis[y];
+                        if (!record.hasOwnProperty(attribute) || attribute === hash_attribute) {
+                            continue;
+                        }
+                        let dbi = env.dbis[attribute];
+                        let value = record[attribute];
+                        if (value !== null && value !== undefined) {
+                            try {
+                                let values = common.getIndexedValues(value);
+                                if (values) {
+                                    for (let i = 0, l = values.length; i < l; i++) {
+                                        dbi.remove(values[i], hashValue);
+                                    }
+                                }
+                            }
+                            catch {
+                                log.warn(`cannot delete from attribute: ${attribute}, ${value}:${hashValue}`);
+                            }
+                        }
+                    }
+                });
+                puts.push(promise);
+                keys.push(hashValue);
+                deleted.original_records.push(record);
+            }
+            catch (e) {
+                log.warn(e);
+                deleted.skipped.push(hashValue);
+            }
+        }
+        let removeIndices = [];
+        let putResults = await Promise.all(puts);
+        for (let x = 0, length = putResults.length; x < length; x++) {
+            if (putResults[x] === true) {
+                deleted.deleted.push(keys[x]);
+            }
+            else {
+                deleted.skipped.push(keys[x]);
+                removeIndices.push(x);
+            }
+        }
+        let offset = 0;
+        for (let x = 0; x < removeIndices.length; x++) {
+            let index = removeIndices[x];
+            deleted.original_records.splice(index - offset, 1);
+            //the offset needs to increase for every index we remove
+            offset++;
+        }
+        deleted.txn_time = common.getNextMonotonicTime();
+        return deleted;
+    }
+    catch (e) {
+        throw e;
+    }
+}
+module.exports = {
+    deleteRecords,
+};
+//# sourceMappingURL=deleteUtility.js.map

package/dist/utility/lmdb/deleteUtility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteUtility.js","sourceRoot":"","sources":["../../../utility/lmdb/deleteUtility.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,MAAM,eAAe,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;AAC3D,MAAM,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAC7C,MAAM,WAAW,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC,gBAAgB,CAAC;AAC1E,MAAM,GAAG,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;AACnD,0CAA0C;AAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC7B,MAAM,2BAA2B,GAAG,OAAO,CAAC,kCAAkC,CAAC,CAAC;AAChF,MAAM,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAC3C,MAAM,2BAA2B,GAAG,QAAQ,CAAC,qBAAqB,CAAC,YAAY,CAAC;AAEhF;;;;;;;GAOG;AACH,KAAK,UAAU,aAAa,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,WAAW;IACjE,UAAU;IACV,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAExB,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,CAAC;QACJ,4BAA4B;QAC5B,IAAI,OAAO,GAAG,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC5C,eAAe,CAAC,cAAc,CAAC,GAAG,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;QAC7D,IAAI,OAAO,GAAG,IAAI,2BAA2B,EAAE,CAAC;QAEhD,qCAAqC;QACrC,IAAI,SAAS,CAAC;QACd,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC;gBACJ,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;gBAEnB,6DAA6D;gBAC7D,IAAI,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACrD,mDAAmD;gBACnD,IACC,CAAC,MAAM;oBACP,iFAAiF;oBACjF,CAAC,WAAW,IAAI,MAAM,CAAC,2BAA2B,CAAC,GAAG,WAAW,CAAC,EACjE,CAAC;oBACF,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAChC,SAAS;gBACV,CAAC;gBAED,IAAI,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;oBAChF,qDAAqD;oBACrD,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;oBAE3C,iDAAiD;oBACjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;wBACzC,IAAI,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;wBAC3B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,SAAS,KAAK,cAAc,EAAE,CAAC;4BACvE,SAAS;wBACV,CAAC;wBAED,IAAI,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;wBAC9B,IAAI,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;wBAC9B,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;4BAC3C,IAAI,CAAC;gCACJ,IAAI,MAAM,GAAG,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;gCAC5C,IAAI,MAAM,EAAE,CAAC;oCACZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wCAC/C,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;oCAClC,CAAC;gCACF,CAAC;4BACF,CAAC;4BAAC,MAAM,CAAC;gCACR,GAAG,CAAC,IAAI,CAAC,iCAAiC,SAAS,KAAK,KAAK,IAAI,SAAS,EAAE,CAAC,CAAC;4BAC/E,CAAC;wBACF,CAAC;oBACF,CAAC;gBACF,CAAC,CAAC,CAAC;gBACH,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACnB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACrB,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACvC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACZ,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACZ,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACjC,CAAC;QACF,CAAC;QAED,IAAI,aAAa,GAAG,EAAE,CAAC;QACvB,IAAI,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7D,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;gBAC5B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACP,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9B,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACvB,CAAC;QACF,CAAC;QAED,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/C,IAAI,KAAK,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;YAC7B,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC;YACnD,wDAAwD;YACxD,MAAM,EAAE,CAAC;QACV,CAAC;QAED,OAAO,CAAC,QAAQ,GAAG,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAEjD,OAAO,OAAO,CAAC;IAChB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACZ,MAAM,CAAC,CAAC;IACT,CAAC;AACF,CAAC;AAED,MAAM,CAAC,OAAO,GAAG;IAChB,aAAa;CACb,CAAC"}

package/dist/utility/lmdb/environmentUtility.d.ts

@@ -0,0 +1,81 @@
+/**
+ * opens an existing named database from an environment
+ * @param {lmdb.RootDatabase} env - environment object used thigh level to interact with all data in an environment
+ * @param {String} dbiName - name of the dbi (KV store)
+ * @returns {lmdb.Database} - returns reference to the dbi
+ */
+export function openDBI(env: lmdb.RootDatabase, dbiName: string): lmdb.Database;
+/**
+ * opens an environment
+ * @returns {lmdb.RootDatabase} - lmdb environment object
+ * @param {String} basePath - the base pase under which the envrinment resides
+ * @param {String} envName -  the name of the environment
+ * @param {Boolean} isTxn - defines if is a transactions environemnt
+ */
+export function openEnvironment(basePath: string, envName: string, isTxn?: boolean): lmdb.RootDatabase;
+/***  ENVIRONMENT FUNCTIONS ***/
+/**
+ * creates a new environment
+ * @param basePath - base path the environment will reside in
+ * @param envName - name of the environment
+ * @param {Boolean} isTxn - defines if is a transactions environment
+ * @returns {Promise<lmdb.RootDatabase>} - LMDB environment object
+ */
+export function createEnvironment(basePath: any, envName: any, isTxn?: boolean, isV3?: boolean): Promise<lmdb.RootDatabase>;
+/**
+ * lists all dbis in an environment
+ * @param {lmdb.RootDatabase} env - environment object used high level to interact with all data in an environment
+ * @returns {[String]}
+ */
+export function listDBIs(env: lmdb.RootDatabase): [string];
+/***  DBI FUNCTIONS ***/
+/**
+ * lists dbis in a map with their defintition as the value
+ * @param {lmdb.RootDatabase} env - environment object used high level to interact with all data in an environment
+ * @returns {{String, DBIDefinition}}
+ */
+export function listDBIDefinitions(env: lmdb.RootDatabase): {
+    String: any;
+    DBIDefinition: any;
+};
+/**
+ * creates a new named database in an environment
+ * @param {lmdb.RootDatabase} env - environment object used high level to interact with all data in an environment
+ * @param {String} dbiName - name of the dbi (KV store)
+ * @param {Boolean} [dupSort] - optional, determines if the dbi allows duplicate keys or not
+ * @param {Boolean} isHashAttribute - defines if the dbi being created is the hash_attribute fro the environment / table
+ * @returns {*} - reference to the dbi
+ */
+export function createDBI(env: lmdb.RootDatabase, dbiName: string, dupSort?: boolean, isHashAttribute?: boolean): any;
+/**
+ * removes a named database from an environment
+ * @param {lmdb.RootDatabase} env - environment object used thigh level to interact with all data in an environment
+ * @param {String} dbiName - name of the dbi (KV store)
+ */
+export function dropDBI(env: lmdb.RootDatabase, dbiName: string): void;
+/**
+ * gets the statistics for a named database from the environment
+ * @param {lmdb.RootDatabase} env - environment object used thigh level to interact with all data in an environment
+ * @param {String} dbiName - name of the dbi (KV store)
+ * @returns {void | Promise<Stats> | *} - object holding stats for the dbi
+ */
+export function statDBI(env: lmdb.RootDatabase, dbiName: string): void | Promise<Stats> | any;
+/**
+ * deletes the environment from the file system & removes the reference from global
+ * @param {String} basePath - top level path the environment folder and the .mdb file live under
+ * @param {String} envName - name of environment
+ * @param {Boolean} isTxn - defines if is a transactions environemnt
+ */
+export function deleteEnvironment(basePath: string, envName: string, isTxn?: boolean): Promise<void>;
+/**
+ * opens/ creates all specified attributes
+ * @param {lmdb.RootDatabase} env - lmdb environment object
+ * @param {String} hash_attribute - name of the table's hash attribute
+ * @param {Array.<String>} writeAttributes - list of all attributes to write to the database
+ */
+export function initializeDBIs(env: lmdb.RootDatabase, hash_attribute: string, writeAttributes: Array<string>): void;
+/**
+ * takes an environment and closes it
+ * @param {lmdb.RootDatabase} env
+ */
+export function closeEnvironment(env: lmdb.RootDatabase): Promise<void>;