@harperfast/harper-pro 5.0.25 → 5.1.0-beta.1

package/core/utility/hdbTerms.ts

@@ -177,6 +177,8 @@ export const SYSTEM_TABLE_NAMES = {
 	TABLE_TABLE_NAME: 'hdb_table',
 	USER_TABLE_NAME: 'hdb_user',
 	INFO_TABLE_NAME: 'hdb_info',
+	DEPLOYMENT_TABLE_NAME: 'hdb_deployment',
+	AGENT_SESSION_TABLE_NAME: 'hdb_agent_session',
 } as const;
 
 /** Hash attribute for the system info table */
@@ -297,6 +299,16 @@ export const OPERATIONS_ENUM = {
 	GET_STATUS: 'get_status',
 	SET_STATUS: 'set_status',
 	CLEAR_STATUS: 'clear_status',
+	LIST_DEPLOYMENTS: 'list_deployments',
+	GET_DEPLOYMENT: 'get_deployment',
+	GET_DEPLOYMENT_PAYLOAD: 'get_deployment_payload',
+	DELETE_DEPLOYMENT_PAYLOAD: 'delete_deployment_payload',
+	AGENT_PROMPT: 'agent_prompt',
+	GET_AGENT_SESSION: 'get_agent_session',
+	LIST_AGENT_SESSIONS: 'list_agent_sessions',
+	CANCEL_AGENT_RUN: 'cancel_agent_run',
+	APPROVE_AGENT_ACTION: 'approve_agent_action',
+	SET_AGENT_CONFIG: 'set_agent_config',
 } as const;
 
 /** Defines valid file types that we are able to handle in 'import_from_s3' ops */
@@ -337,9 +349,12 @@ export const SERVICE_ACTIONS_ENUM = {
 	UPGRADE: 'upgrade',
 	HELP: 'help',
 	STATUS: 'status',
+	LOGIN: 'login',
+	LOGOUT: 'logout',
 	OPERATION: 'operation',
 	RENEWCERTS: 'renew-certs',
 	COPYDB: 'copy-db',
+	MCP: 'mcp',
 } as const;
 
 /** describes the Geo Conversion types */
@@ -424,6 +439,8 @@ export const LEGACY_CONFIG_PARAMS = {
  */
 export const CONFIG_PARAMS = {
 	ANALYTICS_AGGREGATEPERIOD: 'analytics_aggregatePeriod',
+	ANALYTICS_AGGREGATERETENTIONMS: 'analytics_aggregateRetentionMs',
+	ANALYTICS_RAWRETENTIONMS: 'analytics_rawRetentionMs',
 	ANALYTICS_REPLICATE: 'analytics_replicate',
 	ANALYTICS_STORAGEINTERVAL: 'analytics_storageInterval',
 	AUTHENTICATION_AUTHORIZELOCAL: 'authentication_authorizeLocal',
@@ -514,6 +531,7 @@ export const CONFIG_PARAMS = {
 	OPERATIONSAPI_NETWORK_SECUREPORT: 'operationsApi_network_securePort',
 	OPERATIONSAPI_NETWORK_HTTP2: 'operationsApi_network_http2',
 	OPERATIONSAPI_NETWORK_MAXREQUESTBODYSIZE: 'operationsApi_network_maxRequestBodySize',
+	OPERATIONSAPI_COMPONENTFILE_MAXSIZE: 'operationsApi_componentFile_maxSize',
 	OPERATIONSAPI_TLS: 'operationsApi_tls',
 	OPERATIONSAPI_TLS_CERTIFICATE: 'operationsApi_tls_certificate',
 	OPERATIONSAPI_TLS_PRIVATEKEY: 'operationsApi_tls_privateKey',
@@ -521,6 +539,34 @@ export const CONFIG_PARAMS = {
 	OPERATIONSAPI_NETWORK_TIMEOUT: 'operationsApi_network_timeout',
 	OPERATIONSAPI_SYSINFO_NETWORK: 'operationsApi_sysInfo_network',
 	OPERATIONSAPI_SYSINFO_DISK: 'operationsApi_sysInfo_disk',
+	MCP_OPERATIONS_MOUNTPATH: 'mcp_operations_mountPath',
+	MCP_OPERATIONS_ALLOW: 'mcp_operations_allow',
+	MCP_OPERATIONS_DENY: 'mcp_operations_deny',
+	MCP_OPERATIONS_MAXTOOLS: 'mcp_operations_maxTools',
+	MCP_OPERATIONS_RATELIMIT_PERTOOLPERSECOND: 'mcp_operations_rateLimit_perToolPerSecond',
+	MCP_OPERATIONS_RATELIMIT_PERTOOLBURST: 'mcp_operations_rateLimit_perToolBurst',
+	MCP_OPERATIONS_RATELIMIT_SESSIONCONCURRENCY: 'mcp_operations_rateLimit_sessionConcurrency',
+	MCP_OPERATIONS_RATELIMIT_SESSIONPERSECOND: 'mcp_operations_rateLimit_sessionPerSecond',
+	MCP_APPLICATION_MOUNTPATH: 'mcp_application_mountPath',
+	MCP_APPLICATION_ALLOW: 'mcp_application_allow',
+	MCP_APPLICATION_DENY: 'mcp_application_deny',
+	MCP_APPLICATION_MAXTOOLS: 'mcp_application_maxTools',
+	MCP_APPLICATION_SEARCHMAXRESULTS: 'mcp_application_searchMaxResults',
+	MCP_APPLICATION_RATELIMIT_PERTOOLPERSECOND: 'mcp_application_rateLimit_perToolPerSecond',
+	MCP_APPLICATION_RATELIMIT_PERTOOLBURST: 'mcp_application_rateLimit_perToolBurst',
+	MCP_APPLICATION_RATELIMIT_SESSIONCONCURRENCY: 'mcp_application_rateLimit_sessionConcurrency',
+	MCP_APPLICATION_RATELIMIT_SESSIONPERSECOND: 'mcp_application_rateLimit_sessionPerSecond',
+	MCP_SESSION_IDLETIMEOUTSECONDS: 'mcp_session_idleTimeoutSeconds',
+	MCP_SESSION_ALLOWCLIENTDELETE: 'mcp_session_allowClientDelete',
+	AGENT_ENABLED: 'agent_enabled',
+	AGENT_PROVIDER: 'agent_provider',
+	AGENT_MODEL: 'agent_model',
+	AGENT_MAXTURNS: 'agent_maxTurns',
+	AGENT_MAXCOSTUSD: 'agent_maxCostUsd',
+	AGENT_AUTOAPPROVE: 'agent_autoApprove',
+	AGENT_ALLOWDESTRUCTIVE: 'agent_allowDestructive',
+	AGENT_USER: 'agent_user',
+	AGENT_COMPONENTSSCOPE: 'agent_componentsScope',
 	REPLICATION: 'replication',
 	REPLICATION_HOSTNAME: 'replication_hostname',
 	REPLICATION_URL: 'replication_url',
@@ -549,6 +595,8 @@ export const CONFIG_PARAMS = {
 	REPLICATION_BLOBCONCURRENCY: 'replication_blobConcurrency',
 	REPLICATION_MAXPAYLOAD: 'replication_maxPayload',
 	REPLICATION_RECORDCONCURRENCY: 'replication_recordConcurrency',
+	REPLICATION_PINGINTERVAL: 'replication_pingInterval',
+	REPLICATION_PINGTIMEOUT: 'replication_pingTimeout',
 	ROOTPATH: 'rootPath',
 	SERIALIZATION_BIGINT: 'serialization_bigInt',
 	STORAGE_WRITEASYNC: 'storage_writeAsync',
@@ -577,6 +625,11 @@ export const CONFIG_PARAMS = {
 	STORAGE_RECLAMATION_INTERVAL: 'storage_reclamation_interval',
 	STORAGE_RECLAMATION_EVICTIONFACTOR: 'storage_reclamation_evictionFactor',
 	STORAGE_ENGINE: 'storage_engine',
+	STORAGE_READONLY: 'storage_readOnly',
+	STORAGE_ROCKS_BLOCKCACHESIZE: 'storage_rocks_blockCacheSize',
+	STORAGE_ROCKS_WRITEBUFFERMANAGERSIZE: 'storage_rocks_writeBufferManagerSize',
+	STORAGE_ROCKS_WRITEBUFFERMANAGERCOSTTOCACHE: 'storage_rocks_writeBufferManagerCostToCache',
+	STORAGE_ROCKS_WRITEBUFFERMANAGERALLOWSTALL: 'storage_rocks_writeBufferManagerAllowStall',
 	DATABASES: 'databases',
 	IGNORE_SCRIPTS: 'ignoreScripts',
 	MQTT_NETWORK_PORT: 'mqtt_network_port',
@@ -592,6 +645,7 @@ export const CONFIG_PARAMS = {
 	TLS_PRIVATEKEY: 'tls_privateKey',
 	TLS_CERTIFICATEAUTHORITY: 'tls_certificateAuthority',
 	TLS_CIPHERS: 'tls_ciphers',
+	TLS_UNIXDOMAINSOCKETS: 'tls_unixDomainSockets',
 	TLS: 'tls',
 	CLONED: 'cloned',
 	NODE_HOSTNAME: 'node_hostname',
@@ -798,6 +852,8 @@ export const ITC_EVENT_TYPES = {
 	START_JOB: 'start_job',
 	COMPONENT_STATUS_REQUEST: 'component_status_request',
 	COMPONENT_STATUS_RESPONSE: 'component_status_response',
+	RESOURCE_OPENAPI_REQUEST: 'resource_openapi_request',
+	RESOURCE_OPENAPI_RESPONSE: 'resource_openapi_response',
 } as const;
 
 /** Supported thread types */

package/core/utility/install/checkJWTTokensExist.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const env = require('../../utility/environment/environmentManager.js');
+const env = require('../../utility/environment/environmentManager.ts');
 env.initSync();
 const fs = require('fs-extra');
 const path = require('path');

package/core/utility/install/{installer.js → installer.ts}

@@ -1,42 +1,42 @@
 'use strict';
 
-const os = require('os');
-const inquirer = require('inquirer');
-const fs = require('fs-extra');
-const PropertiesReader = require('properties-reader');
-const chalk = require('chalk');
-const path = require('path');
+import * as os from 'os';
+import inquirer from 'inquirer';
+import * as fs from 'fs-extra';
+import PropertiesReader from 'properties-reader';
+import chalk from 'chalk';
+import * as path from 'path';
 let ora; // Will be loaded dynamically as it's an ES module
-const YAML = require('yaml');
-
-const hdbLogger = require('../logging/harper_logger.js');
-const envManager = require('../environment/environmentManager.js');
-const hdbUtils = require('../common_utils.js');
-const assignCMDENVVariables = require('../../utility/assignCmdEnvVariables.js');
-const hdbInfoController = require('../../dataLayer/hdbInfoController.js');
-const { packageJson } = require('../packageUtils.js');
-const hdbTerms = require('../hdbTerms.ts');
+import * as YAML from 'yaml';
+
+import * as hdbLogger from '../logging/harper_logger.ts';
+import * as envManager from '../environment/environmentManager.ts';
+import * as hdbUtils from '../common_utils.ts';
+
+import * as hdbInfoController from '../../dataLayer/hdbInfoController.ts';
+import { packageJson } from '../packageUtils.js';
+import * as hdbTerms from '../hdbTerms.ts';
 const { CONFIG_PARAMS } = hdbTerms;
-const installValidator = require('../../validation/installValidator.js');
-const mountHdb = require('../mount_hdb.js');
-const configUtils = require('../../config/configUtils.js');
-const userOps = require('../../security/user.ts');
-const roleOps = require('../../security/role.js');
-const checkJwtTokens = require('./checkJWTTokensExist.js');
-const globalSchema = require('../globalSchema.js');
-const promisify = require('util').promisify;
+import installValidator from '../../validation/installValidator.ts';
+import mountHdb from '../mount_hdb.ts';
+import * as configUtils from '../../config/configUtils.js';
+import * as userOps from '../../security/user.ts';
+import * as roleOps from '../../security/role.ts';
+import checkJwtTokens from './checkJWTTokensExist.js';
+import * as globalSchema from '../globalSchema.ts';
+import { promisify } from 'util';
 const pSchemaToGlobal = promisify(globalSchema.setSchemaDataToGlobal);
-const keys = require('../../security/keys.js');
+import * as keys from '../../security/keys.ts';
 
 // Removes the color formatting that was being applied to the prompt answer.
 const PROMPT_ANSWER_TRANSFORMER = (answer) => answer;
 const HDB_PROMPT_MSG = (msg) => chalk.magenta.bold(msg);
 const LINE_BREAK = os.EOL;
 const PROMPT_PREFIX = '';
-const INSTALL_START_MSG = 'Starting Harper Pro install...';
-const INSTALL_COMPLETE_MSG = 'Harper Pro installation was successful.';
-const UPGRADE_MSG = 'An out of date version of Harper Pro is already installed.';
-const HDB_EXISTS_MSG = 'It appears that Harper Pro is already installed. Exiting install...';
+const INSTALL_START_MSG = 'Starting Harper install...';
+const INSTALL_COMPLETE_MSG = 'Harper installation was successful.';
+const UPGRADE_MSG = 'An out of date version of Harper is already installed.';
+const HDB_EXISTS_MSG = 'It appears that Harper is already installed. Exiting install...';
 const ABORT_MSG = 'Aborting install';
 const PROCESS_HOME = os.homedir();
 const DEFAULT_HDB_ROOT = path.join(PROCESS_HOME, hdbTerms.HDB_ROOT_DIR_NAME);
@@ -61,31 +61,32 @@ const DEV_MODE_CONFIG = {
 
 // Install prompts
 const INSTALL_PROMPTS = {
-	DESTINATION: 'Please enter a destination for Harper Pro:',
+	DESTINATION: 'Please enter a destination for Harper:',
 	HDB_USERNAME: 'Please enter a username for the administrative user:',
 	HDB_PASS: 'Please enter a password for the administrative user:',
-	NODE_HOSTNAME: 'Please enter the hostname for the Harper Pro instance:',
+	NODE_HOSTNAME: 'Please enter the hostname for the Harper instance:',
 	DEFAULTS_MODE: 'Default Config - dev (easy access/debugging) or prod (security/performance): (dev/prod)',
 };
 
+import assignCMDENVVariables from '../assignCmdEnvVariables.ts';
 const cfgEnv = assignCMDENVVariables([hdbTerms.INSTALL_PROMPTS.HDB_CONFIG]);
 let hdbRoot = undefined;
 let conditionalRollback = false;
 let ignoreExisting = false;
 
 /**
- * This module orchestrates the installation of Harper Pro.
+ * This module orchestrates the installation of Harper.
  */
 
-module.exports = { install, updateConfigEnv, setIgnoreExisting };
+export { install, updateConfigEnv, setIgnoreExisting };
 install.createSuperUser = createSuperUser;
 
 /**
- * Calls all the functions that are needed to install Harper Pro.
+ * Calls all the functions that are needed to install Harper.
  * @returns {Promise<void>}
  */
 async function install() {
-	console.log(HDB_PROMPT_MSG(LINE_BREAK + INSTALL_START_MSG + LINE_BREAK));
+	console.error(HDB_PROMPT_MSG(LINE_BREAK + INSTALL_START_MSG + LINE_BREAK));
 	hdbLogger.notify(INSTALL_START_MSG);
 
 	let configFromFile;
@@ -126,7 +127,7 @@ async function install() {
 		throw validationError.message;
 	}
 
-	// Check for an existing installation of Harper Pro.
+	// Check for an existing installation of Harper.
 	await checkForExistingInstall();
 
 	// Prompt the user with params needed for install.
@@ -146,10 +147,8 @@ async function install() {
 	if (
 		!ignoreExisting &&
 		!cfgEnv[hdbTerms.INSTALL_PROMPTS.HDB_CONFIG] &&
-		(await fs.pathExists(
-			path.join(hdbRoot, hdbTerms.HARPER_CONFIG_FILE) ||
-				(await fs.pathExists(path.join(hdbRoot, hdbTerms.HDB_CONFIG_FILE)))
-		))
+		((await fs.pathExists(path.join(hdbRoot, hdbTerms.HARPER_CONFIG_FILE))) ||
+			(await fs.pathExists(path.join(hdbRoot, hdbTerms.HDB_CONFIG_FILE))))
 	) {
 		console.error(HDB_EXISTS_MSG);
 		process.exit();
@@ -171,7 +170,7 @@ async function install() {
 	envManager.setHdbBasePath(hdbRoot);
 	envManager.setProperty(hdbTerms.CONFIG_PARAMS.STORAGE_ENGINE, installParams.STORAGE_ENGINE);
 
-	// Creates the Harper Pro project folder structure and the LMDB environments/dbis.
+	// Creates the Harper project folder structure and the LMDB environments/dbis.
 	await mountHdb(hdbRoot);
 
 	// Creates the boot prop file in user home dir. Boot prop file contains location of hdb config.
@@ -180,7 +179,7 @@ async function install() {
 	// Create the harperdb-config.yaml file
 	await createConfigFile(installParams);
 
-	// At this point there should be config and Harper Pro folders so re-init log settings to update
+	// At this point there should be config and Harper folders so re-init log settings to update
 	hdbLogger.initLogSettings(true);
 
 	// Create the super user.
@@ -190,7 +189,7 @@ async function install() {
 	await keys.updateConfigCert();
 	await keys.generateCertsKeys();
 
-	// Insert current version of Harper Pro into versions table.
+	// Insert current version of Harper into versions table.
 	await insertHdbVersionInfo();
 
 	// Checks that the RSA keys exist for JWT generation, if not we create them.
@@ -198,15 +197,15 @@ async function install() {
 
 	spinner.stop();
 
-	console.log(HDB_PROMPT_MSG(LINE_BREAK + INSTALL_COMPLETE_MSG + LINE_BREAK));
+	console.error(HDB_PROMPT_MSG(LINE_BREAK + INSTALL_COMPLETE_MSG + LINE_BREAK));
 	hdbLogger.notify(INSTALL_COMPLETE_MSG);
 }
 
 function getConfigFromFile() {
 	let doc = YAML.parseDocument(fs.readFileSync(cfgEnv[hdbTerms.INSTALL_PROMPTS.HDB_CONFIG], 'utf8'), {
 		simpleKeys: true,
-	});
-	const flatCfg = configUtils.flattenConfig(doc.toJSON());
+	} as any);
+	const flatCfg: any = configUtils.flattenConfig(doc.toJSON()) ?? {};
 
 	// This ensures that if config file has rootpath, rootpath install prompt uses this value
 	if (flatCfg[hdbTerms.CONFIG_PARAMS.ROOTPATH.toLowerCase()])
@@ -216,7 +215,7 @@ function getConfigFromFile() {
 }
 
 /**
- * Asks the user the questions needed to get Harper Pro installed.
+ * Asks the user the questions needed to get Harper installed.
  * If cmd/env vats are passed to install the prompts will not be asked.
  * @param promptOverride - an object that contains all the params needed to install.
  * @returns {Promise<*>}
@@ -321,10 +320,10 @@ async function installPrompts(promptOverride) {
 function displayCmdEnvVar(value, msg) {
 	if (value !== undefined) {
 		if (msg.includes('password')) {
-			console.log(`${HDB_PROMPT_MSG(msg)} ${chalk.gray('[hidden]')}`);
+			console.error(`${HDB_PROMPT_MSG(msg)} ${chalk.gray('[hidden]')}`);
 			hdbLogger.trace(`${HDB_PROMPT_MSG(msg)} [hidden]`);
 		} else {
-			console.log(`${HDB_PROMPT_MSG(msg)} ${value}`);
+			console.error(`${HDB_PROMPT_MSG(msg)} ${value}`);
 			hdbLogger.trace(`${HDB_PROMPT_MSG(msg)} ${value}`);
 		}
 		return false;
@@ -383,7 +382,7 @@ function checkForPromptOverride() {
 }
 
 /**
- * Checks for an existing install of Harper Pro and prompts user accordingly.
+ * Checks for an existing install of Harper and prompts user accordingly.
  * @returns {Promise<void>}
  */
 async function checkForExistingInstall() {
@@ -411,11 +410,11 @@ async function checkForExistingInstall() {
 		const upgradeObj = await hdbInfoController.getVersionUpdateInfo();
 		if (upgradeObj) {
 			const upgradeToVerMsg = `Please use \`harperdb upgrade\` to update to ${packageJson.version}. Exiting install...`;
-			console.log(LINE_BREAK + chalk.magenta.bold(UPGRADE_MSG));
-			console.log(chalk.magenta.bold(upgradeToVerMsg));
+			console.error(LINE_BREAK + chalk.magenta.bold(UPGRADE_MSG));
+			console.error(chalk.magenta.bold(upgradeToVerMsg));
 			hdbLogger.error(upgradeToVerMsg);
 		} else {
-			console.log(LINE_BREAK + chalk.magenta.bold(HDB_EXISTS_MSG));
+			console.error(LINE_BREAK + chalk.magenta.bold(HDB_EXISTS_MSG));
 			hdbLogger.error(HDB_EXISTS_MSG);
 		}
 		process.exit(0);
@@ -469,13 +468,13 @@ async function createBootPropertiesFile() {
 }
 
 /**
- * Calls the util function that creates the Harper Pro config file.
+ * Calls the util function that creates the Harper config file.
  * If an error occurs during the create install is rolled backed.
  * @param installParams
  * @returns {Promise<void>}
  */
 async function createConfigFile(installParams) {
-	hdbLogger.trace('Creating Harper Pro config file');
+	hdbLogger.trace('Creating Harper config file');
 	const args = assignCMDENVVariables(Object.keys(hdbTerms.CONFIG_PARAM_MAP), true);
 	Object.assign(args, installParams);
 
@@ -516,7 +515,7 @@ async function createConfigFile(installParams) {
 
 	try {
 		if (!cfgEnv[hdbTerms.INSTALL_PROMPTS.HDB_CONFIG]) {
-			// Create the Harper Pro config file.
+			// Create the Harper config file.
 			configUtils.createConfigFile(args);
 		}
 
@@ -531,7 +530,7 @@ async function createConfigFile(installParams) {
  * @param errMsg
  */
 function rollbackInstall(errMsg) {
-	hdbLogger.error(`Error creating Harper Pro config file. Rolling back install - ${errMsg}`);
+	hdbLogger.error(`Error creating Harper config file. Rolling back install - ${errMsg}`);
 	console.error(errMsg);
 	console.error(ABORT_MSG);
 
@@ -547,7 +546,7 @@ function rollbackInstall(errMsg) {
 		if (conditionalRollback) {
 			const dir = fs.readdirSync(hdbRoot, { withFileTypes: true });
 			dir.forEach((d) => {
-				const fullPath = path.join(d.path, d.name);
+				const fullPath = path.join((d as any).parentPath ?? (d as any).path, d.name);
 				if (fullPath !== cfgEnv[hdbTerms.INSTALL_PROMPTS.HDB_CONFIG]) {
 					fs.removeSync(fullPath);
 				}
@@ -561,7 +560,7 @@ function rollbackInstall(errMsg) {
 }
 
 /**
- * Creates a Harper Pro role and then adds a use to that role.
+ * Creates a Harper role and then adds a use to that role.
  * @param role
  * @param adminUser
  * @returns {Promise<void>}
@@ -628,7 +627,7 @@ async function insertHdbVersionInfo() {
 	if (vers) {
 		await hdbInfoController.insertHdbInstallInfo(vers);
 	} else {
-		throw new Error('The version is missing/removed from Harper Pro package.json');
+		throw new Error('The version is missing/removed from Harper package.json');
 	}
 }
 

package/core/utility/installation.ts

@@ -1,7 +1,7 @@
 import type { Logger } from '../components/Logger.ts';
-import * as terms from './hdbTerms.js';
+import * as terms from './hdbTerms.ts';
 import fs from 'node:fs';
-import { noBootFile, getPropsFilePath } from './common_utils.js';
+import { noBootFile, getPropsFilePath } from './common_utils.ts';
 
 interface Env {
 	get(key: string): string;

package/core/utility/lmdb/{DBIDefinition.js → DBIDefinition.ts}

@@ -6,6 +6,9 @@
  * intKey defines if the key entries are integers or not
  */
 class DBIDefinition {
+	dup_sort: boolean;
+	isPrimaryKey: boolean;
+	useVersions: boolean;
 	/**
 	 * @param {Boolean} dupSort - allow duplicate keys, or not
 	 * @param {Boolean} isPrimaryKey - defines if this is the primary key
@@ -17,4 +20,4 @@ class DBIDefinition {
 	}
 }
 
-module.exports = DBIDefinition;
+export default DBIDefinition;

package/core/utility/lmdb/{DeleteRecordsResponseObject.js → DeleteRecordsResponseObject.ts}

@@ -8,6 +8,7 @@
  * @param {Array.<Object>} originalRecords
  */
 class DeleteRecordsResponseObject {
+	[key: string]: any;
 	/**
 	 * @param {Array.<string|number>} deleted
 	 * @param {Array.<string|number>} skipped
@@ -22,4 +23,4 @@ class DeleteRecordsResponseObject {
 	}
 }
 
-module.exports = DeleteRecordsResponseObject;
+export default DeleteRecordsResponseObject;

package/core/utility/lmdb/{InsertRecordsResponseObject.js → InsertRecordsResponseObject.ts}

@@ -7,6 +7,7 @@
  * @param {number} txnTime
  */
 class InsertRecordsResponseObject {
+	[key: string]: any;
 	/**
 	 * @param {Array.<string|number>} written_hashes
 	 * @param {Array.<string|number>} skipped_hashes
@@ -19,4 +20,4 @@ class InsertRecordsResponseObject {
 	}
 }
 
-module.exports = InsertRecordsResponseObject;
+export default InsertRecordsResponseObject;

package/core/utility/lmdb/OpenDBIObject.ts

@@ -0,0 +1,43 @@
+'use strict';
+import * as envMngr from '../environment/environmentManager.ts';
+import * as terms from '../../utility/hdbTerms.ts';
+import { RecordEncoder } from '../../resources/RecordEncoder.ts';
+envMngr.initSync();
+
+const LMDB_CACHING = envMngr.get(terms.CONFIG_PARAMS.STORAGE_CACHING) !== false;
+
+/**
+ * Defines how a DBI will be created/opened
+ */
+export class OpenDBIObject {
+	[key: string]: any;
+	dupSort: boolean;
+	encoding: 'string' | 'json' | 'binary' | 'msgpack' | 'ordered-binary';
+	useVersions: boolean;
+	sharedStructuresKey: symbol;
+	compression: any;
+	cache: any;
+	freezeData: boolean;
+	encoder: any;
+	/**
+	 * @param {Boolean} dupSort - if the dbi allows duplicate keys
+	 * @param {Boolean} [isPrimary] - if the dbi is the primary dbi
+	 */
+	constructor(dupSort, isPrimary = false) {
+		/** @type {boolean} */
+		this.dupSort = dupSort === true;
+		/** @type {"string" | "json" | "binary" | "msgpack" | "ordered-binary"} */
+		this.encoding = dupSort ? 'ordered-binary' : 'msgpack';
+		/** @type {boolean} */
+		this.useVersions = isPrimary;
+		/** @type {Symbol} */
+		this.sharedStructuresKey = Symbol.for('structures');
+		/** @type {any} */
+		this.compression = undefined;
+		this.encoder = { Encoder: RecordEncoder };
+		if (isPrimary) {
+			this.cache = LMDB_CACHING && { validated: true };
+			this.freezeData = true;
+		}
+	}
+}

package/core/utility/lmdb/{OpenEnvironmentObject.js → OpenEnvironmentObject.ts}

@@ -5,11 +5,27 @@ const MAP_SIZE = 1024 * 1024 * 1024;
 //allow up to 1,000 named data bases in an environment
 const MAX_DBS = 10000;
 const MAX_READERS = 2048;
-const envMngr = require('../environment/environmentManager.js');
-const terms = require('../../utility/hdbTerms.ts');
+import * as envMngr from '../environment/environmentManager.ts';
+import * as terms from '../../utility/hdbTerms.ts';
 envMngr.initSync();
 
-class OpenEnvironmentObject {
+export default class OpenEnvironmentObject {
+	[key: string]: any;
+	static MAX_DBS = MAX_DBS;
+	path: string;
+	mapSize: number;
+	maxDbs: number;
+	maxReaders: number;
+	sharedStructuresKey: symbol;
+	readOnly: boolean;
+	trackMetrics: boolean;
+	eventTurnBatching: boolean;
+	noSync: boolean;
+	overlappingSync: any;
+	maxFreeSpaceToLoad: any;
+	maxFreeSpaceToRetain: any;
+	pageSize: any;
+	noReadAhead: any;
 	constructor(path, readOnly = false) {
 		this.path = path;
 		this.mapSize = MAP_SIZE;
@@ -36,6 +52,3 @@ class OpenEnvironmentObject {
 		this.noReadAhead = envMngr.get(terms.CONFIG_PARAMS.STORAGE_NOREADAHEAD);
 	}
 }
-
-module.exports = OpenEnvironmentObject;
-OpenEnvironmentObject.MAX_DBS = MAX_DBS;

package/core/utility/lmdb/{UpdateRecordsResponseObject.js → UpdateRecordsResponseObject.ts}

@@ -8,6 +8,7 @@
  * @param {Array.<Object>} originalRecords
  */
 class UpdateRecordsResponseObject {
+	[key: string]: any;
 	/**
 	 * @param {Array.<string|number>} written_hashes
 	 * @param {Array.<string|number>} skipped_hashes
@@ -22,4 +23,4 @@ class UpdateRecordsResponseObject {
 	}
 }
 
-module.exports = UpdateRecordsResponseObject;
+export default UpdateRecordsResponseObject;

package/core/utility/lmdb/{UpsertRecordsResponseObject.js → UpsertRecordsResponseObject.ts}

@@ -7,6 +7,7 @@
  * @param {Array.<Object>} originalRecords
  */
 class UpsertRecordsResponseObject {
+	[key: string]: any;
 	/**
 	 * @param {Array.<string|number>} written_hashes
 	 * @param {number} txnTime
@@ -19,4 +20,4 @@ class UpsertRecordsResponseObject {
 	}
 }
 
-module.exports = UpsertRecordsResponseObject;
+export default UpsertRecordsResponseObject;

package/core/utility/lmdb/{cleanLMDBMap.js → cleanLMDBMap.ts}

@@ -1,16 +1,16 @@
 'use strict';
 
-const environmentUtility = require('./environmentUtility.js');
-const harperLogger = require('../logging/harper_logger.js');
-const LMDB_ERRORS = require('../errors/commonErrors.js').LMDB_ERRORS_ENUM;
+import * as environmentUtility from './environmentUtility.ts';
+import harperLogger from '../logging/harper_logger.ts';
+import { LMDB_ERRORS_ENUM as LMDB_ERRORS } from '../errors/commonErrors.ts';
 
-module.exports = cleanLMDBMap;
+export default cleanLMDBMap;
 
 /**
  * this function strips away the cached environments from global when a schema item is removed
  * @param msg
  */
-async function cleanLMDBMap(msg) {
+async function cleanLMDBMap(msg: any) {
 	try {
 		if (global.lmdb_map !== undefined && msg.operation !== undefined) {
 			let keys = Object.keys(global.lmdb_map);