@harperfast/harper 5.0.30 → 5.1.0-beta.2

package/dist/utility/common_utils.d.ts

@@ -1,66 +1,84 @@
+import { PACKAGE_ROOT } from './packageUtils.js';
+export { PACKAGE_ROOT };
+import * as http from 'http';
+export declare const asyncSetTimeout: typeof import("node:timers/promises").setTimeout;
+/**
+ * Converts a message to an error containing the error as a message. Will always return an error if the passed in error is
+ * not a message.
+ * @param message
+ * @returns {*}
+ */
+export declare function errorizeMessage(message: any): Error;
 /**
  * Test if the passed value is null or undefined.  This will not check string length.
  * @param value - the value to test
  * @returns {boolean}
  */
-export function isEmpty(value: any): boolean;
+export declare function isEmpty(value: any): boolean;
+export declare function isNotEmptyAndHasValue(value: any): any;
 /**
  * Test if the passed value is null, undefined, or zero length or size.
  * @param value - the value to test
  * @returns {boolean}
  */
-export function isEmptyOrZeroLength(value: any): boolean;
+export declare function isEmptyOrZeroLength(value: any): boolean;
 /**
  * Test if the passed array contains any null or undefined values.
  * @param valuesList - An array of values
  * @returns {boolean}
  */
-export function arrayHasEmptyValues(valuesList: any): boolean;
+export declare function arrayHasEmptyValues(valuesList: any): boolean;
 /**
  * Test if the passed array contains any null or undefined values.
  * @param valuesList - An array of values
  * @returns {boolean}
  */
-export function arrayHasEmptyOrZeroLengthValues(valuesList: any): boolean;
+export declare function arrayHasEmptyOrZeroLengthValues(valuesList: any): boolean;
 /**
  * takes an array of strings and joins them with the folder separator to return a path
  * @param pathElements
  */
-export function buildFolderPath(...pathElements: any[]): string;
+export declare function buildFolderPath(...pathElements: any[]): string;
 /**
  * takes a value and checks if it is a boolean value (true/false)
  * @param value
  * @returns {boolean}
  */
-export function isBoolean(value: any): boolean;
+export declare function isBoolean(value: any): boolean;
 /**
- * Converts a message to an error containing the error as a message. Will always return an error if the passed in error is
- * not a message.
- * @param message
- * @returns {*}
+ * Takes a value and checks if it is an object.
+ * Note - null is considered an object but we are excluding it here.
+ * @param value
+ * @returns {boolean}
  */
-export function errorizeMessage(message: any): any;
+export declare function isObject(value: any): boolean;
 /**
  * Strip the .hdb file extension from file names.  To keep this efficient, this will not check that the
  * parameter contains the .hdb extension.
  * @param fileName - the filename.
  * @returns {string}
  */
-export function stripFileExtension(fileName: any): string;
+export declare function stripFileExtension(fileName: any): any;
 /**
  * Takes a raw string value and casts it to the correct data type, including Object & Array, but not Dates
  * @param data
  * @returns
  */
-export function autoCast(data: any): any;
-export function autoCastJSON(data: any): any;
-export function autoCastJSONDeep(data: any): any;
+export declare function autoCast(data: any): any;
+export declare function autoCastJSON(data: any): any;
+export declare function autoCastJSONDeep(data: any): any;
+/**
+ * function to check if a string is a number based on the rules used by our autocaster
+ * @param {string} data
+ * @returns {boolean}
+ */
+export declare function autoCasterIsNumberCheck(data: any): boolean;
 /**
  * Removes all files in a given directory path.
  * @param dirPath
  * @returns {Promise<[any]>}
  */
-export function removeDir(dirPath: any): Promise<[any]>;
+export declare function removeDir(dirPath: string): Promise<void>;
 /**
  * Sorting function, Get oldVersion list of version directives to run during an upgrade.
  * Can be used via [<versions>].sort(compareVersions). Can also be used to just compare strictly version
@@ -70,27 +88,27 @@ export function removeDir(dirPath: any): Promise<[any]>;
  * @param newVersion - Newest version As an UpgradeDirective object or just a version number as a string
  * @returns {*}
  */
-export function compareVersions(oldVersion: any, newVersion: any): any;
+export declare function compareVersions(oldVersion: any, newVersion: any): any;
 /**
  * Check to see if the data from one version is compatible with another. Per semver, this is only major version changes
  * @param oldVersion
  * @param newVersion
  * @returns {boolean}
  */
-export function isCompatibleDataVersion(oldVersion: any, newVersion: any, checkMinor?: boolean): boolean;
+export declare function isCompatibleDataVersion(oldVersion: any, newVersion: any, checkMinor?: boolean): boolean;
 /**
  * takes a raw value and replaces any forward slashes with the unicode equivalent.  if the value directly matches "." or ".." then it replaces with their unicode equivalent
  * the reason for this is to because linux does not allow forward slashes in folder names and "." & ".." are already taken
  * @param value
  * @returns {string}
  */
-export function escapeRawValue(value: any): string;
+export declare function escapeRawValue(value: any): any;
 /**
  * takes the value and unesacapes the unicode for any occurrance of "U+002F" and exact values of  "U+002E", "U+002EU+002E"
  * @param value
  * @returns {string}
  */
-export function unescapeValue(value: any): string;
+export declare function unescapeValue(value: any): any;
 /**
  * Takes a PropertiesReader object and converts it to a string so it can be printed to a file.
  * @param propReaderObject - An object of type properties-reader containing properties stored in settings.js
@@ -98,111 +116,97 @@ export function unescapeValue(value: any): string;
  * The key is the variable name (PROJECT_DIR) and the value will be the string comment.
  * @returns {string}
  */
-export function stringifyProps(propReaderObject: any, comments: any): string;
+export declare function stringifyProps(propReaderObject: any, comments?: any): string;
+export declare function getHomeDir(): any;
+/**
+ * This function will attempt to find the hdbBootProperties.file path.  IT IS SYNCHRONOUS, SO SHOULD ONLY BE
+ * CALLED IN CERTAIN SITUATIONS (startup, upgrade, etc).
+ */
+export declare function getPropsFilePath(): string;
 /**
  * Creates a promisified timeout that exposes a cancel() function in case the timeout needs to be cancelled.
  * @param ms
  * @param msg - The message to resolve the promise with should it timeout
  * @returns {{promise: (Promise|Promise<any>), cancel: cancel}}
  */
-export function timeoutPromise(ms: any, msg: any): {
-    promise: (Promise<any> | Promise<any>);
-    cancel: cancel;
+export declare function timeoutPromise(ms: number, msg?: any): {
+    promise: any;
+    cancel: () => void;
 };
+/**
+ * Checks to see if a port is taken or not.
+ * @param port
+ * @returns {Promise<unknown>}
+ */
+export declare function isPortTaken(port: number): Promise<unknown>;
 /**
  * Checks the global databases for a schema and table
  * @param schemaName
  * @param tableName
  * @returns string returns a thrown message if schema and or table does not exist
  */
-export function checkGlobalSchemaTable(schemaName: any, tableName: any): string;
-export function getHomeDir(): string;
-/**
- * This function will attempt to find the hdbBootProperties.file path.  IT IS SYNCHRONOUS, SO SHOULD ONLY BE
- * CALLED IN CERTAIN SITUATIONS (startup, upgrade, etc).
- */
-export function getPropsFilePath(): string;
+export declare function checkGlobalSchemaTable(schemaName: string, tableName: string): string;
 /**
  * Promisify csv parser papaparse. Once function is promisified it can be called with:
  * papaParse.parsePromise(<reject-promise-obj>, <read-stream>, <chunking-function>)
  * In the case of an error, reject promise object must be called from chunking-function, it will bubble up
  * through bind to this function.
  */
-export function promisifyPapaParse(): void;
+export declare function parsePromise(stream: any, chunkFunc: any, typingFunction: any): Promise<any>;
 /**
  * Removes the byte order mark from a string
  * @returns a string minus any byte order marks
  * @param dataString
  */
-export function removeBOM(dataString: any): string;
-export function createEventPromise(eventName: any, eventEmitterObject: any, timeout_promise: any): Promise<any>;
+export declare function removeBOM(dataString: any): string;
+export declare function createEventPromise(eventName: string, eventEmitterObject: any, timeout_promise?: any): Promise<unknown>;
 /**
  * Checks the global schema to see if a Schema or Table exist.
  * @param schema
  * @param table
  */
-export function checkSchemaTableExist(schema: any, table: any): string;
+export declare function checkSchemaTableExist(schema: string, table: string): string;
 /**
  * Checks the global schema to see if a schema exist.
  * @param schema
  * @returns {string}
  */
-export function checkSchemaExists(schema: any): string;
+export declare function checkSchemaExists(schema: string): string;
 /**
  * Checks the global schema to see if a table exist.
  * @param schema
  * @param table
  * @returns {string}
  */
-export function checkTableExists(schema: any, table: any): string;
+export declare function checkTableExists(schema: string, table: string): string;
 /**
  * Returns the first second of the next day in seconds.
  * @returns {number}
  */
-export function getStartOfTomorrowInSeconds(): number;
+export declare function getStartOfTomorrowInSeconds(): number;
 /**
  * Returns the key used by limits for this cycle.
  * @returns {string}
  */
-export function getLimitKey(): string;
-/**
- * Takes a value and checks if it is an object.
- * Note - null is considered an object but we are excluding it here.
- * @param value
- * @returns {boolean}
- */
-export function isObject(value: any): boolean;
-export function isNotEmptyAndHasValue(value: any): any;
-/**
- * function to check if a string is a number based on the rules used by our autocaster
- * @param {string} data
- * @returns {boolean}
- */
-export function autoCasterIsNumberCheck(data: string): boolean;
+export declare function getLimitKey(): string;
 /**
  * Automatically adds backticks "`" to all schema elements found in an AST - the reason for this is in SQL you can surround
  * a reserved word with backticks as an escape to allow a schema element which is named the same as a reserved word to be used.
  * The issue is once alasql parses the sql the backticks are removed and we need them when we execute the final SQL.
  */
-export function backtickASTSchemaItems(statement: any): void;
-/**
- * Checks to see if a port is taken or not.
- * @param port
- * @returns {Promise<unknown>}
- */
-export function isPortTaken(port: any): Promise<unknown>;
+export declare function backtickASTSchemaItems(statement: any): void;
 /**
  * Create arguments for childProcess fork
  * @param modulePath
  * @returns {*[]}
  */
-export function createForkArgs(modulePath: any): any[];
+export declare function createForkArgs(modulePath: string): string[];
 /**
  * Takes a boolean string/value and casts it to a boolean
  * @param boolean
  * @returns {boolean}
  */
-export function autoCastBoolean(boolean: any): boolean;
+export declare function autoCastBoolean(boolean: any): boolean;
 /**
  * Takes a boolean string/value and casts it to a boolean iff it is a case-insensitive
  * string matching 'true' or 'false'. Returns the argument unmodified otherwise.
@@ -210,55 +214,54 @@ export function autoCastBoolean(boolean: any): boolean;
  * @returns any
  *
  */
-export function autoCastBooleanStrict(value: any): any;
-export const asyncSetTimeout: typeof import("node:timers/promises").setTimeout;
+export declare function autoCastBooleanStrict(value: any): any;
 /**
  * Gets a tables hash attribute from the global schema
  */
-export function getTableHashAttribute(schema: any, table: any): any;
+export declare function getTableHashAttribute(schema: string, table: string): any;
 /**
  * Checks the global schema to see if schema exists
  * @param schema
  * @returns {boolean} - returns true if schema exists
  */
-export function doesSchemaExist(schema: any): boolean;
+export declare function doesSchemaExist(schema: string): boolean;
 /**
  * Checks the global schema to see if schema exists
  * @param schema
  * @param table
  * @returns {boolean} - returns true if table exists
  */
-export function doesTableExist(schema: any, table: any): boolean;
+export declare function doesTableExist(schema: string, table: string): boolean;
 /**
  * Tries to stringify an object, if it cant just return that value unchanged.
  * @param value
  * @returns {any}
  */
-export function stringifyObj(value: any): any;
+export declare function stringifyObj(value: any): any;
 /**
  * Converts milliseconds to a readable time, e.g. 2d 3h 12m 1s
  * @param ms
  * @returns {*}
  */
-export function ms_to_time(ms: any): any;
+export declare function ms_to_time(ms: number): string;
 /**
  * Change the extension of a file.
  * @param file
  * @param extension
  * @returns {string}
  */
-export function changeExtension(file: any, extension: any): string;
+export declare function changeExtension(file: string, extension: string): string;
 /**
  * Checks ENV and CLI for ROOTPATH arg
  */
-export function getEnvCliRootPath(): any;
-export function noBootFile(): any;
-export function httpRequest(options: any, data: any): Promise<any>;
+export declare function getEnvCliRootPath(): any;
+export declare function noBootFile(): any;
+export declare function httpRequest(options: any, data: any): Promise<http.IncomingMessage & {
+    body?: string;
+}>;
 /**
  * Will set default schema/database or set database to schema
  * @param req
  */
-export function transformReq(req: any): void;
-export function convertToMS(interval: any): number;
-import { PACKAGE_ROOT } from "./packageUtils.js";
-export { PACKAGE_ROOT };
+export declare function transformReq(req: any): void;
+export declare function convertToMS(interval: any): number;