@harperfast/harper 5.0.25 → 5.1.0-beta.1

package/sqlTranslator/{SelectValidator.js → SelectValidator.ts}

@@ -1,33 +1,25 @@
 'use strict';
 
-const RecursiveIterator = require('recursive-iterator');
-const alasql = require('alasql');
-const clone = require('clone');
-const commonUtils = require('../utility/common_utils.js');
-const { handleHDBError, hdbErrors } = require('../utility/errors/hdbError.js');
+import RecursiveIterator from 'recursive-iterator';
+import * as alasql from 'alasql';
+import clone from 'clone';
+import * as commonUtils from '../utility/common_utils.ts';
+import { handleHDBError, hdbErrors } from '../utility/errors/hdbError.ts';
 const { HDB_ERROR_MSGS, HTTP_STATUS_CODES } = hdbErrors;
-const { getDatabases } = require('../resources/databases.ts');
+import { getDatabases } from '../resources/databases.ts';
 
 //exclusion list for validation on group bys
 const customAggregators = ['DISTINCT_ARRAY'];
 
-const validateTables = Symbol('validateTables'),
-	validateTable = Symbol('validateTable'),
-	validateAllColumns = Symbol('validateAllColumns'),
-	findColumn = Symbol('findColumn'),
-	validateOrderBy = Symbol('validateOrderBy'),
-	validateSegment = Symbol('validateSegment'),
-	validateColumn = Symbol('validateColumn'),
-	setColumnsForTable = Symbol('setColumnsForTable'),
-	checkColumnsForAsterisk = Symbol('checkColumnsForAsterisk'),
-	validateGroupBy = Symbol('validateGroupBy'),
-	hasColumns = Symbol('hasColumns');
-
 /**
  * Validates the tables and attributes against the actual schema
  * Validates general SQL rules
  */
 class SelectValidator {
+	statement: any;
+	sqlBucket: any;
+	attributes: any;
+	[key: string | symbol]: any;
 	constructor(statement) {
 		this.statement = statement;
 		this.attributes = [];
@@ -42,29 +34,29 @@ class SelectValidator {
 			throw new Error('invalid sql statement');
 		}
 
-		this[validateTables]();
-		this[checkColumnsForAsterisk]();
-		this[validateAllColumns]();
+		this.validateTables();
+		this.checkColumnsForAsterisk();
+		this.validateAllColumns();
 	}
 
 	/**
 	 * if the statement has columns in it:
 	 * loops thru the from and join arrays of the AST and passes individual entries into validateTable
 	 */
-	[validateTables]() {
-		if (this[hasColumns]()) {
+	validateTables() {
+		if (this.hasColumns()) {
 			if (!this.statement.from || this.statement.from.length === 0) {
 				throw `no from clause`;
 			}
 
 			this.statement.from.forEach((table) => {
-				this[validateTable](table);
+				this.validateTable(table);
 			});
 
 			if (this.statement.joins) {
 				this.statement.joins.forEach((join) => {
 					join.table.as = join.as;
-					this[validateTable](join.table);
+					this.validateTable(join.table);
 				});
 			}
 		}
@@ -74,7 +66,7 @@ class SelectValidator {
 	 * check to see if there are columns in any part of the select
 	 * @returns {boolean}
 	 */
-	[hasColumns]() {
+	hasColumns() {
 		let hasColumns = false;
 		let iterator = new RecursiveIterator(this.statement);
 		for (let { node } of iterator) {
@@ -90,7 +82,7 @@ class SelectValidator {
 	 * Checks that the table exists in the schema, adds all of it's attributes to the class level collection this.attributes
 	 * @param table
 	 */
-	[validateTable](table) {
+	validateTable(table) {
 		if (!table.databaseid) {
 			throw `schema not defined for table ${table.tableid}`;
 		}
@@ -123,7 +115,7 @@ class SelectValidator {
 	 * @param column
 	 * @returns {*[]}
 	 */
-	[findColumn](column) {
+	findColumn(column) {
 		//look to see if this attribute exists on one of the tables we are selecting from
 		return this.attributes.filter((attribute) => {
 			if (column.tableid) {
@@ -140,13 +132,13 @@ class SelectValidator {
 	/**
 	 * detects * in the select, if found adds all columns to the select
 	 */
-	[checkColumnsForAsterisk]() {
+	checkColumnsForAsterisk() {
 		let iterator = new RecursiveIterator(this.statement.columns);
 
 		for (let { node, path } of iterator) {
 			//we check the path to make sure the '*' is not wrapped in some form of expression like count(*)
 			if (node && node.columnid === '*' && path.indexOf('expression') < 0) {
-				this[setColumnsForTable](node.tableid);
+				this.setColumnsForTable(node.tableid);
 			}
 		}
 	}
@@ -155,14 +147,14 @@ class SelectValidator {
 	 * takes a table and adds all of it's columns to the select. if no table it adds every column from every table in the select
 	 * @param tableName
 	 */
-	[setColumnsForTable](tableName) {
+	setColumnsForTable(tableName) {
 		this.attributes.forEach((attribute) => {
 			if (
 				(!tableName || (tableName && (attribute.table.tableid === tableName || attribute.table.as === tableName))) &&
 				!attribute.relation
 			) {
 				this.statement.columns.push(
-					new alasql.yy.Column({
+					new (alasql as any).yy.Column({
 						columnid: attribute.attribute,
 						tableid: attribute.table.as ? attribute.table.as : attribute.table.tableid,
 					})
@@ -174,12 +166,12 @@ class SelectValidator {
 	/**
 	 * passes segments to ValidateSegment for validation
 	 */
-	[validateAllColumns]() {
-		this[validateSegment](this.statement.columns, false);
-		this[validateSegment](this.statement.joins, false);
-		this[validateSegment](this.statement.where, false);
-		this[validateGroupBy](this.statement.group, false);
-		this[validateSegment](this.statement.order, true);
+	validateAllColumns() {
+		this.validateSegment(this.statement.columns, false);
+		this.validateSegment(this.statement.joins, false);
+		this.validateSegment(this.statement.where, false);
+		this.validateGroupBy(this.statement.group);
+		this.validateSegment(this.statement.order, true);
 	}
 
 	/**
@@ -188,7 +180,7 @@ class SelectValidator {
 	 * @param isOrderBy
 	 * @returns {*}
 	 */
-	[validateSegment](segment, isOrderBy) {
+	validateSegment(segment, isOrderBy) {
 		if (!segment) {
 			return;
 		}
@@ -198,9 +190,9 @@ class SelectValidator {
 		for (let { node } of iterator) {
 			if (!commonUtils.isEmpty(node) && !commonUtils.isEmpty(node.columnid) && node.columnid !== '*') {
 				if (isOrderBy) {
-					this[validateOrderBy](node);
+					this.validateOrderBy(node);
 				} else {
-					attributes.push(this[validateColumn](node));
+					attributes.push(this.validateColumn(node));
 				}
 			}
 		}
@@ -213,7 +205,7 @@ class SelectValidator {
 	 * makes sure that the non-aggregate functions and columns from the select are represented in the group by and the columns match the schema
 	 * @param segment
 	 */
-	[validateGroupBy](segment) {
+	validateGroupBy(segment) {
 		if (!segment) {
 			return;
 		}
@@ -233,7 +225,7 @@ class SelectValidator {
 				delete columnClone.as;
 				selectColumns.push(columnClone);
 			} else if (column.columnid) {
-				let found = this[findColumn](column)[0];
+				let found = this.findColumn(column)[0];
 				if (found) {
 					selectColumns.push(found);
 				}
@@ -254,7 +246,7 @@ class SelectValidator {
 					}
 				});
 			} else {
-				let foundGroupColumn = this[findColumn](groupColumn);
+				let foundGroupColumn = this.findColumn(groupColumn);
 
 				if (!foundGroupColumn || foundGroupColumn.length === 0) {
 					throw `unknown column '${groupColumn.toString()}' in group by`;
@@ -294,14 +286,14 @@ class SelectValidator {
 	 *
 	 * @param column
 	 */
-	[validateOrderBy](column) {
+	validateOrderBy(column) {
 		let foundColumns = this.statement.columns.filter((col) => col.as === column.columnid);
 
 		if (foundColumns.length > 1) {
 			let columnName = (column.tableid ? column.tableid + '.' : '') + column.columnid;
 			throw `ambiguous column reference ${columnName} in order by`;
 		} else if (foundColumns.length === 0) {
-			this[validateColumn](column);
+			this.validateColumn(column);
 		}
 	}
 
@@ -310,8 +302,8 @@ class SelectValidator {
 	 * @param column
 	 * @returns {*}
 	 */
-	[validateColumn](column) {
-		let foundColumns = this[findColumn](column);
+	validateColumn(column) {
+		let foundColumns = this.findColumn(column);
 
 		let columnName = (column.tableid ? column.tableid + '.' : '') + column.columnid;
 
@@ -327,4 +319,4 @@ class SelectValidator {
 	}
 }
 
-module.exports = SelectValidator;
+export default SelectValidator;

package/sqlTranslator/{alasqlFunctionImporter.js → alasqlFunctionImporter.ts}

@@ -4,12 +4,12 @@
  * PUrpose of this is to set up a central module to define and import custom functions into alasql
  */
 
-const alasqlExtension = require('../utility/functions/sql/alaSQLExtension.js'),
-	dateFunctions = require('../utility/functions/date/dateFunctions.js'),
-	geo = require('../utility/functions/geo.js');
+import * as alasqlExtension from '../utility/functions/sql/alaSQLExtension.js';
+import * as dateFunctions from '../utility/functions/date/dateFunctions.js';
+import * as geo from '../utility/functions/geo.js';
 
 //import the custom function, need to define an upper and lower case version of the function so it is parsed properly in alasql
-module.exports = (alasql) => {
+export default function (alasql: any) {
 	/*
     AGGREGATE FUNCTIONS
      */
@@ -59,4 +59,4 @@ module.exports = (alasql) => {
 	alasql.fn.geoequal = alasql.fn.GEOEQUAL = alasql.fn.geoEqual = geo.geoEqual;
 	alasql.fn.geolength = alasql.fn.GEOLENGTH = alasql.fn.geoLength = geo.geoLength;
 	alasql.fn.geonear = alasql.fn.GEONEAR = alasql.fn.geoNear = geo.geoNear;
-};
+}

package/sqlTranslator/{deleteTranslator.js → deleteTranslator.ts}

@@ -1,30 +1,25 @@
-const alasql = require('alasql');
-const search = require('../dataLayer/search.js');
-const log = require('../utility/logging/harper_logger.js');
-const harperBridge = require('../dataLayer/harperBridge/harperBridge.js');
-const util = require('util');
-const hdbUtils = require('../utility/common_utils.js');
-const terms = require('../utility/hdbTerms.ts');
-const globalSchema = require('../utility/globalSchema.js');
+import * as alasql from 'alasql';
+import * as search from '../dataLayer/search.ts';
+import log from '../utility/logging/harper_logger.ts';
+import harperBridge from '../dataLayer/harperBridge/harperBridge.ts';
+import * as util from 'util';
+import * as hdbUtils from '../utility/common_utils.ts';
+import * as terms from '../utility/hdbTerms.ts';
+import * as globalSchema from '../utility/globalSchema.ts';
 
 const RECORD = 'record';
 const SUCCESS = 'successfully deleted';
 
-const cbConvertDelete = util.callbackify(convertDelete);
 const pSearchSearch = util.promisify(search.search);
 const pGetTableSchema = util.promisify(globalSchema.getTableSchema);
 
-module.exports = {
-	convertDelete: cbConvertDelete,
-};
-
-function generateReturnMessage(deleteResultsObject) {
+function generateReturnMessage(deleteResultsObject: any) {
 	return `${deleteResultsObject.deleted_hashes.length} ${RECORD}${
 		deleteResultsObject.deleted_hashes.length === 1 ? `` : `s`
 	} ${SUCCESS}`;
 }
 
-async function convertDelete({ statement, hdb_user }) {
+export async function convertDelete({ statement, hdb_user }) {
 	//convert this update statement to a search capable statement
 	let tableInfo = await pGetTableSchema(statement.table.databaseid, statement.table.tableid);
 
@@ -33,10 +28,10 @@ async function convertDelete({ statement, hdb_user }) {
 	let { table: from, where } = statement;
 
 	let whereString = hdbUtils.isEmpty(where) ? '' : ` WHERE  ${where.toString()}`;
-	let selectString = `SELECT ${tableInfo.hash_attribute} FROM ${from.toString()} ${whereString}`;
-	let searchStatement = alasql.parse(selectString).statements[0];
+	let selectString = `SELECT ${(tableInfo as any).hash_attribute} FROM ${from.toString()} ${whereString}`;
+	let searchStatement = (alasql as any).parse(selectString).statements[0];
 
-	let deleteObj = {
+	let deleteObj: any = {
 		operation: terms.OPERATIONS_ENUM.DELETE,
 		schema: from.databaseid_orig,
 		table: from.tableid_orig,

package/sqlTranslator/{index.js → index.ts}

@@ -1,27 +1,21 @@
 'use strict';
 
-module.exports = {
-	evaluateSQL,
-	processAST,
-	convertSQLToAST,
-	checkASTPermissions,
-};
-
-const insert = require('../dataLayer/insert.js');
-const util = require('util');
+import * as insert from '../dataLayer/insert.ts';
+import * as util from 'util';
 const cbInsertInsert = util.callbackify(insert.insert);
-const search = require('../dataLayer/search.js').search;
-const update = require('../dataLayer/update.js').update;
+import { search } from '../dataLayer/search.ts';
+import { update } from '../dataLayer/update.ts';
 const cbUpdateUpdate = util.callbackify(update);
-const deleteTranslator = require('./deleteTranslator.js').convertDelete;
-const alasql = require('alasql');
-const opAuth = require('../utility/operation_authorization.js');
-const logger = require('../utility/logging/harper_logger.js');
-const alasqlFunctionImporter = require('./alasqlFunctionImporter.js');
-const hdbUtils = require('../utility/common_utils.js');
-const terms = require('../utility/hdbTerms.ts');
-const { hdbErrors, handleHDBError } = require('../utility/errors/hdbError.js');
-const { HTTP_STATUS_CODES } = hdbErrors;
+import { convertDelete as deleteTranslator } from './deleteTranslator.ts';
+const cbDeleteTranslator = util.callbackify(deleteTranslator);
+import * as alasql from 'alasql';
+import * as opAuth from '../utility/operation_authorization.ts';
+import logger from '../utility/logging/harper_logger.ts';
+import alasqlFunctionImporter from './alasqlFunctionImporter.ts';
+import * as hdbUtils from '../utility/common_utils.ts';
+import * as terms from '../utility/hdbTerms.ts';
+import { handleHDBError } from '../utility/errors/hdbError.ts';
+import { HTTP_STATUS_CODES } from '../utility/errors/commonErrors.ts';
 
 //here we call to define and import custom functions to alasql
 alasqlFunctionImporter(alasql);
@@ -30,6 +24,9 @@ let UNAUTHORIZED_RESPONSE = 403;
 const SQL_INSERT_ERROR_MSG = 'There was a problem performing this insert. Please check the logs and try again.';
 
 class ParsedSQLObject {
+	ast: any;
+	variant: any;
+	permissions_checked: boolean;
 	constructor() {
 		this.ast = undefined;
 		this.variant = undefined;
@@ -37,25 +34,25 @@ class ParsedSQLObject {
 	}
 }
 
-function evaluateSQL(jsonMessage, callback) {
+export function evaluateSQL(jsonMessage: any, callback: any) {
 	let parsedSql = jsonMessage.parsed_sql_object;
 	if (!parsedSql) {
 		parsedSql = convertSQLToAST(jsonMessage.sql);
 		//TODO; This is a temporary check and should be removed once validation is integrated.
 		let schema = undefined;
 		let statement = parsedSql.ast.statements[0];
-		if (statement instanceof alasql.yy.Insert) {
+		if (statement instanceof (alasql as any).yy.Insert) {
 			schema = statement.into.databaseid;
-		} else if (statement instanceof alasql.yy.Select) {
+		} else if (statement instanceof (alasql as any).yy.Select) {
 			schema = statement.from ? statement.from[0].databaseid : null;
-		} else if (statement instanceof alasql.yy.Update) {
+		} else if (statement instanceof (alasql as any).yy.Update) {
 			schema = statement.table.databaseid;
-		} else if (statement instanceof alasql.yy.Delete) {
+		} else if (statement instanceof (alasql as any).yy.Delete) {
 			schema = statement.table.databaseid;
 		} else {
 			logger.error(`AST in evaluateSQL is not a valid SQL type.`);
 		}
-		if (!(statement instanceof alasql.yy.Select) && hdbUtils.isEmptyOrZeroLength(schema)) {
+		if (!(statement instanceof (alasql as any).yy.Select) && hdbUtils.isEmptyOrZeroLength(schema)) {
 			return callback('No schema specified', null);
 		}
 	}
@@ -74,10 +71,10 @@ function evaluateSQL(jsonMessage, callback) {
  * @param parsedSqlObject - The Parsed SQL statement specified in the inbound json message, of type ParsedSQLObject.
  * @returns {Array} - False if permissions check denys the statement.
  */
-function checkASTPermissions(jsonMessage, parsedSqlObject) {
+export function checkASTPermissions(jsonMessage: any, parsedSqlObject: any) {
 	let verifyResult = undefined;
 	try {
-		verifyResult = opAuth.verifyPermsAst(
+		verifyResult = opAuth.verifyPermsAST(
 			parsedSqlObject.ast.statements[0],
 			jsonMessage.hdb_user,
 			parsedSqlObject.variant
@@ -92,7 +89,7 @@ function checkASTPermissions(jsonMessage, parsedSqlObject) {
 	return null;
 }
 
-function convertSQLToAST(sql) {
+export function convertSQLToAST(sql: string) {
 	let astResponse = new ParsedSQLObject();
 	if (!sql) {
 		throw handleHDBError(
@@ -127,7 +124,7 @@ function convertSQLToAST(sql) {
 	return astResponse;
 }
 
-function processAST(jsonMessage, parsedSqlObject, callback) {
+export function processAST(jsonMessage: any, parsedSqlObject: any, callback: any) {
 	try {
 		let sqlFunction = nullFunction;
 
@@ -156,7 +153,7 @@ function processAST(jsonMessage, parsedSqlObject, callback) {
 				sqlFunction = cbUpdateUpdate;
 				break;
 			case terms.VALID_SQL_OPS_ENUM.DELETE:
-				sqlFunction = deleteTranslator;
+				sqlFunction = cbDeleteTranslator;
 				break;
 			default:
 				throw new Error(`unsupported SQL type ${parsedSqlObject.variant} in SQL: ${jsonMessage}`);
@@ -180,7 +177,7 @@ function nullFunction(sql, callback) {
 
 function convertInsert({ statement, hdb_user }, callback) {
 	let schemaTable = statement.into;
-	let insertObject = {
+	let insertObject: any = {
 		schema: schemaTable.databaseid,
 		table: schemaTable.tableid,
 		operation: 'insert',
@@ -229,7 +226,7 @@ function createDataObjects(columns, values) {
 				if ('value' in value) {
 					record[columns[x]] = value.value;
 				} else {
-					record[columns[x]] = alasql.compile(`SELECT ${value.toString()} AS [${terms.FUNC_VAL}] FROM ?`);
+					record[columns[x]] = (alasql as any).compile(`SELECT ${value.toString()} AS [${terms.FUNC_VAL}] FROM ?`);
 				}
 			});
 

package/sqlTranslator/{sql_statement_bucket.js → sql_statement_bucket.ts}

@@ -4,13 +4,18 @@
  * AST SQL values such as attributes, tables, etc.
  **/
 
-const alasql = require('alasql');
-const RecursiveIterator = require('recursive-iterator');
-const harperLogger = require('../utility/logging/harper_logger.js');
-const hdbUtils = require('../utility/common_utils.js');
-const terms = require('../utility/hdbTerms.ts');
+import * as alasql from 'alasql';
+import RecursiveIterator from 'recursive-iterator';
+const harperLogger = require('../utility/logging/harper_logger').default || require('../utility/logging/harper_logger');
+import * as hdbUtils from '../utility/common_utils.ts';
+import * as terms from '../utility/hdbTerms.ts';
 
 class sqlStatementBucket {
+	ast: any;
+	affected_attributes: any;
+	table_lookup: any;
+	schema_lookup: any;
+	table_to_schema_lookup: any;
 	constructor(ast) {
 		this.ast = ast;
 		// affectedAttributes stores a table and it's attributes as a Map [schema, Map[table, [attributesArray]]].
@@ -142,7 +147,7 @@ class sqlStatementBucket {
 					.get(colTable)
 					.filter((attr) => !terms.SEARCH_WILDCARDS.includes(attr));
 				finalTableAttrs.forEach(({ attribute_name }) => {
-					let newColumn = new alasql.yy.Column({ columnid: attribute_name });
+					let newColumn = new (alasql as any).yy.Column({ columnid: attribute_name });
 					if (val.tableid) {
 						newColumn.tableid = val.tableid;
 					}
@@ -166,11 +171,17 @@ class sqlStatementBucket {
  * @returns [] - array of attribute permissions objects w/ READ perms === TRUE
  */
 
-function filterReadRestrictedAttrs(attrPerms) {
+function filterReadRestrictedAttrs(attrPerms: any[]) {
 	return attrPerms.filter((perm) => perm[terms.PERMS_CRUD_ENUM.READ]);
 }
 
-function interpretAST(ast, affectedAttributes, tableLookup, schemaLookup, tableToSchemaLookup) {
+function interpretAST(
+	ast: any,
+	affectedAttributes: any,
+	tableLookup: any,
+	schemaLookup: any,
+	tableToSchemaLookup: any
+) {
 	getRecordAttributesAST(ast, affectedAttributes, tableLookup, schemaLookup, tableToSchemaLookup);
 }
 
@@ -182,7 +193,13 @@ function interpretAST(ast, affectedAttributes, tableLookup, schemaLookup, tableT
  * @param {Map} affectedAttributes - A map of attributes affected in the call.  Defined as [schema, Map[table, [attributesArray]]].
  * @param {Map} tableLookup - A map that will be filled in.  This map contains alias to table definitions as [alias, tableName].
  */
-function addSchemaTableToMap(record, affectedAttributes, tableLookup, schemaLookup, tableToSchemaLookup) {
+function addSchemaTableToMap(
+	record: any,
+	affectedAttributes: any,
+	tableLookup: any,
+	schemaLookup?: any,
+	tableToSchemaLookup?: any
+) {
 	if (!record || !record.databaseid) {
 		return;
 	}
@@ -218,20 +235,26 @@ function addSchemaTableToMap(record, affectedAttributes, tableLookup, schemaLook
  * @param {Map} affectedAttributes - A map containing attributes affected by the statement. Defined as [schema, Map[table, [attributesArray]]].
  * @param {Map} tableLookup - A map that will be filled in.  This map contains alias to table definitions as [alias, tableName].
  */
-function getRecordAttributesAST(ast, affectedAttributes, tableLookup, schemaLookup, tableToSchemaLookup) {
+function getRecordAttributesAST(
+	ast: any,
+	affectedAttributes: any,
+	tableLookup: any,
+	schemaLookup: any,
+	tableToSchemaLookup: any
+) {
 	if (!ast) {
 		harperLogger.info(`getRecordAttributesAST: invalid SQL syntax tree`);
 		return;
 	}
 	// We can reference any schema/table attributes, so we need to check each possibility
 	// affected attributes is a Map of Maps like so [schema, Map[table, [attributesArray]]];
-	if (ast instanceof alasql.yy.Insert) {
+	if (ast instanceof (alasql as any).yy.Insert) {
 		getInsertAttributes(ast, affectedAttributes, tableLookup);
-	} else if (ast instanceof alasql.yy.Select) {
+	} else if (ast instanceof (alasql as any).yy.Select) {
 		getSelectAttributes(ast, affectedAttributes, tableLookup, schemaLookup, tableToSchemaLookup);
-	} else if (ast instanceof alasql.yy.Update) {
+	} else if (ast instanceof (alasql as any).yy.Update) {
 		getUpdateAttributes(ast, affectedAttributes, tableLookup);
-	} else if (ast instanceof alasql.yy.Delete) {
+	} else if (ast instanceof (alasql as any).yy.Delete) {
 		getDeleteAttributes(ast, affectedAttributes, tableLookup);
 	} else {
 		harperLogger.error(`AST in getRecordAttributesAST() is not a valid SQL type.`);
@@ -245,7 +268,13 @@ function getRecordAttributesAST(ast, affectedAttributes, tableLookup, schemaLook
  * @param affectedAttributes - A map containing attributes affected by the statement. Defined as [schema, Map[table, [attributesArray]]].
  * @param tableLookup - A map that will be filled in.  This map contains alias to table definitions as [alias, tableName].
  */
-function getSelectAttributes(ast, affectedAttributes, tableLookup, schemaLookup, tableToSchemaLookup) {
+function getSelectAttributes(
+	ast: any,
+	affectedAttributes: any,
+	tableLookup: any,
+	schemaLookup: any,
+	tableToSchemaLookup: any
+) {
 	if (!ast) {
 		harperLogger.info(`getSelectAttributes: invalid SQL syntax tree`);
 		return;
@@ -387,7 +416,7 @@ function getSelectAttributes(ast, affectedAttributes, tableLookup, schemaLookup,
  * @param affectedAttributes - - A map containing attributes affected by the statement. Defined as [schema, Map[table, [attributesArray]]].
  * @param tableLookup - A map that will be filled in.  This map contains alias to table definitions as [alias, tableName].
  */
-function getUpdateAttributes(ast, affectedAttributes, tableLookup) {
+function getUpdateAttributes(ast: any, affectedAttributes: any, tableLookup: any) {
 	if (!ast) {
 		harperLogger.info(`getUpdateAttributes: invalid SQL syntax tree`);
 		return;
@@ -410,7 +439,7 @@ function getUpdateAttributes(ast, affectedAttributes, tableLookup) {
  * @param affectedAttributes - - A map containing attributes affected by the statement. Defined as [schema, Map[table, [attributesArray]]].
  * @param tableLookup - A map that will be filled in.  This map contains alias to table definitions as [alias, tableName].
  */
-function getDeleteAttributes(ast, affectedAttributes, tableLookup) {
+function getDeleteAttributes(ast: any, affectedAttributes: any, tableLookup: any) {
 	if (!ast) {
 		harperLogger.info(`getDeleteAttributes: invalid SQL syntax tree`);
 		return;
@@ -433,7 +462,7 @@ function getDeleteAttributes(ast, affectedAttributes, tableLookup) {
  * @param affectedAttributes - A map containing attributes affected by the statement. Defined as [schema, Map[table, [attributesArray]]].
  * @param tableLookup - A map that will be filled in.  This map contains alias to table definitions as [alias, tableName].
  */
-function getInsertAttributes(ast, affectedAttributes, tableLookup) {
+function getInsertAttributes(ast: any, affectedAttributes: any, tableLookup: any) {
 	if (!ast) {
 		harperLogger.info(`getInsertAttributes: invalid SQL syntax tree`);
 		return;
@@ -458,7 +487,7 @@ function getInsertAttributes(ast, affectedAttributes, tableLookup) {
  * @param affectedAttributes - A map containing attributes affected by the statement. Defined as [schema, Map[table, [attributesArray]]].
  * @param tableLookup - A map that will be filled in.  This map contains alias to table definitions as [alias, tableName].
  */
-function pushAttribute(table, schema, columnid, affectedAttributes, tableLookup) {
+function pushAttribute(table: any, schema: any, columnid: any, affectedAttributes: any, tableLookup: any) {
 	if (!affectedAttributes.get(schema)) {
 		return;
 	}
@@ -469,4 +498,4 @@ function pushAttribute(table, schema, columnid, affectedAttributes, tableLookup)
 	affectedAttributes.get(schema).get(tableId).push(columnid);
 }
 
-module.exports = sqlStatementBucket;
+export default sqlStatementBucket;

package/static/README.md

@@ -1,13 +1,14 @@
 # Harper
 
-Harper is an open-source Node.js performance platform that unifies database, cache, application, and messaging layers into one in-memory process.
+This directory contains the files used by a local Harper installation.
 
-## Harper Filesystem Structure
+## Directory Guide
 
-- `harper` - This is the root folder for Harper. It contains all the files and folders that Harper uses.
-- `harper/harper-config.yaml` - This is the configuration file, It contains all the settings for Harper. This file is read by Harper when it starts up. It is also written to when you change settings through the API.
-- `harper/database` - This folder is the default location for all your database files (that contain the actual data in your databases).
-- `harper/keys` - This folder contains the private keys (and can also have certificates) for your PKI/TLS.
-- `harper/components` - This folder contains editable components that are stored in Harper. This folder is intended for components that are edited and canonically stored on this server. The standard approach for components is that they are deployed from npm or GitHub and installed to the `hdb/components` directory, then symlinked to the `node_modules/` folder for dependency resolution purposes.
-- `harper/log` - This folder contains the log file for Harper
-- `harper/backup` - This folder contains backup copies for files when they are modified. When harper-config.yaml is modified through the API, previous versions are stored here.
+- `harper-config.yaml` - Local configuration read by Harper at startup and updated when settings change through the API.
+- `backup/` - Backup copies of files Harper updates, such as previous `harper-config.yaml` versions.
+- `components/` - Editable local components stored on this server.
+- `database/` - Default location for database storage files.
+- `keys/` - Private keys and certificates used for PKI/TLS.
+- `log/` - Harper log output.
+
+For installation, configuration, and API documentation, see https://docs.harperdb.io/.