@harperfast/harper 5.0.0-alpha.10 → 5.0.0-beta.1

package/dist/utility/logging/harper_logger.d.ts

@@ -103,14 +103,14 @@ export function errorToString(error: any): string | string;
  * We call this if stdio is not functional
  */
 export function disableStdio(): void;
-declare class HarperLogger {
+declare const HarperLogger_base: {
+    new (stdout: NodeJS.WritableStream, stderr?: NodeJS.WritableStream, ignoreErrors?: boolean): import("node:console").Console;
+    new (options: import("node:console").ConsoleOptions): import("node:console").Console;
+    prototype: import("node:console").Console;
+};
+declare class HarperLogger extends HarperLogger_base {
     constructor(streams: any, level: any);
     level: any;
-    trace(...args: any[]): void;
-    debug(...args: any[]): void;
-    info(...args: any[]): void;
-    warn(...args: any[]): void;
-    error(...args: any[]): void;
     fatal(...args: any[]): void;
     notify(...args: any[]): void;
     withTag(tag: any): {

package/dist/utility/processManagement/processManagement.d.ts

@@ -28,7 +28,7 @@ export function getHdbPid(): number | undefined;
  * @returns {boolean} - True if the process is running, false otherwise
  */
 export function isProcessRunning(pid: number): boolean;
-export function cleanupChildrenProcesses(exit?: boolean): any;
+export function cleanupChildrenProcesses(exit?: boolean): Promise<void>;
 /**
  * Reset the restart counts for all child processes because we are doing an intentional restart
  */

package/dist/utility/processManagement/servicesConfig.d.ts

@@ -3,8 +3,11 @@ export function generateAllServiceConfigs(): {
         name: "Harper";
         script: "dist/bin/harper.js";
         exec_mode: string;
-        env: any;
-        execArgv: any;
+        env: {
+            PROCESS_NAME: "Harper";
+            IS_SCRIPTED_SERVICE: boolean;
+        };
+        execArgv: string[];
         cwd: string;
     }[];
 };
@@ -12,12 +15,15 @@ export function generateMainServerConfig(): {
     name: "Harper";
     script: "dist/bin/harper.js";
     exec_mode: string;
-    env: any;
-    execArgv: any;
+    env: {
+        PROCESS_NAME: "Harper";
+        IS_SCRIPTED_SERVICE: boolean;
+    };
+    execArgv: string[];
     cwd: string;
 };
 export function generateRestart(): {
-    script: any;
+    script: string;
     name: "Restart HDB";
     exec_mode: string;
     env: {
@@ -25,5 +31,5 @@ export function generateRestart(): {
     };
     instances: number;
     autorestart: boolean;
-    cwd: any;
+    cwd: string;
 };

package/dist/validation/common_validators.d.ts

@@ -10,10 +10,11 @@ export namespace commonValidators {
     }
 }
 export const schemaRegex: RegExp;
-export const hdbSchemaTable: any;
+export const hdbSchemaTable: Joi.AlternativesSchema<any>;
 export function validateSchemaExists(value: any, helpers: any): any;
 export function validateTableExists(value: any, helpers: any): any;
 export function validateSchemaName(value: any, helpers: any): any;
 export function checkValidTable(propertyName: any, value: any): string;
-export const hdbDatabase: any;
-export const hdbTable: any;
+export const hdbDatabase: Joi.AlternativesSchema<any>;
+export const hdbTable: Joi.AlternativesSchema<any>;
+import Joi = require("joi");

package/dist/validation/configValidator.d.ts

@@ -1,8 +1,9 @@
-export function configValidator(configJson: any, skipFsValidation?: boolean): any;
+export function configValidator(configJson: any, skipFsValidation?: boolean): Joi.ValidationResult<any>;
 /**
  * Validates just the routes array.
  * @param routesArray
  * @returns {*}
  */
 export function routesValidator(routesArray: any): any;
-export const routeConstraints: any;
+export const routeConstraints: Joi.AlternativesSchema<any>;
+import Joi = require("joi");

package/index.d.ts

@@ -0,0 +1,56 @@
+import { Resource as ResourceImport } from './resources/Resource.ts';
+import { server as serverImport } from './server/Server.ts';
+import { tables as dbTables, databases as dbDatabases } from './resources/databases.ts';
+import { BlobCreationOptions } from './resources/blob.ts';
+import { Logger } from './utility/logging/logger.ts';
+
+export { Resource } from './resources/Resource.ts';
+export type {
+	Query,
+	Context,
+	Session,
+	SourceContext,
+	SubscriptionRequest,
+	RequestTargetOrId,
+} from './resources/ResourceInterface.ts';
+export { ResourceInterface } from './resources/ResourceInterface.ts';
+export type { User } from './security/user.ts';
+export type { RecordObject } from './resources/RecordEncoder.ts';
+export type { IterableEventQueue } from './resources/IterableEventQueue.ts';
+export { RequestTarget } from './resources/RequestTarget.ts';
+export { server } from './server/Server';
+export { tables, databases, type Table } from './resources/databases.ts';
+export type { Attribute } from './resources/Table.ts';
+
+export { Scope } from './components/Scope.ts';
+export type { FilesOption, FilesOptionObject } from './components/deriveGlobOptions.ts';
+export type { FileAndURLPathConfig } from './components/Component.ts';
+export { OptionsWatcher, type Config, type ConfigValue } from './components/OptionsWatcher.ts';
+export {
+	EntryHandler,
+	type BaseEntry,
+	type FileEntry,
+	type EntryEvent,
+	type AddFileEvent,
+	type ChangeFileEvent,
+	type UnlinkFileEvent,
+	type FileEntryEvent,
+	type AddDirectoryEvent,
+	type UnlinkDirectoryEvent,
+	type DirectoryEntryEvent,
+} from './components/EntryHandler.ts';
+
+declare const logger: Logger;
+export { type Logger, logger };
+
+declare global {
+	const tables: typeof dbTables;
+	const logger: Logger;
+	const databases: typeof dbDatabases;
+	const server: typeof serverImport;
+	const Resource: typeof ResourceImport;
+	const createBlob: (
+		source: Uint8Array | NodeJS.ReadableStream | string | Iterable<Uint8Array> | AsyncIterator<Uint8Array>,
+		options?: BlobCreationOptions
+	) => Blob;
+}

package/index.js

@@ -0,0 +1,41 @@
+const workerThreads = require('node:worker_threads');
+if (!workerThreads.isMainThread) {
+	// Prevents server from starting in worker threads if this was directly imported from a non-server user thread
+	if (!workerThreads.workerData) workerThreads.workerData = {};
+	workerThreads.workerData.noServerStart = true;
+}
+const { globals } = require('./server/threads/threadServer.js');
+
+// exported types are needed for parsing as well
+exports.Attribute = undefined;
+exports.Config = undefined;
+exports.ConfigValue = undefined;
+exports.Context = undefined;
+exports.FileAndURLPathConfig = undefined;
+exports.FilesOption = undefined;
+exports.FilesOptionObject = undefined;
+exports.IterableEventQueue = undefined;
+exports.Logger = undefined;
+exports.Query = undefined;
+exports.RecordObject = undefined;
+exports.RequestTarget = undefined;
+exports.RequestTargetOrId = undefined;
+exports.Resource = undefined;
+exports.ResourceInterface = undefined;
+exports.Scope = undefined;
+exports.Session = undefined;
+exports.SourceContext = undefined;
+exports.SubscriptionRequest = undefined;
+exports.Table = undefined;
+exports.User = undefined;
+
+// these are all overwritten by the globals, but need to be here so that Node's static
+// exports parser can analyze them
+exports.tables = {};
+exports.databases = {};
+exports.getUser = undefined;
+exports.server = {};
+exports.contentTypes = null;
+exports.threads = [];
+exports.logger = {};
+Object.assign(exports, globals);

package/json/systemSchema.json

@@ -0,0 +1,373 @@
+{
+	"hdb_user": {
+		"hash_attribute": "username",
+		"name": "hdb_user",
+		"schema": "system",
+		"residence": ["*"],
+		"attributes": [
+			{
+				"attribute": "username"
+			},
+			{
+				"attribute": "password"
+			},
+			{
+				"attribute": "role"
+			},
+			{
+				"attribute": "active"
+			},
+			{
+				"attribute": "hash"
+			},
+			{
+				"attribute": "refresh_token"
+			},
+			{
+				"attribute": "hash_function"
+			},
+			{
+				"attribute": "__createdtime__"
+			},
+			{
+				"attribute": "__updatedtime__"
+			}
+		]
+	},
+	"hdb_role": {
+		"hash_attribute": "id",
+		"name": "hdb_role",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "id"
+			},
+			{
+				"attribute": "role"
+			},
+			{
+				"attribute": "permission"
+			},
+			{
+				"attribute": "__createdtime__"
+			},
+			{
+				"attribute": "__updatedtime__"
+			}
+		],
+		"residence": ["*"]
+	},
+	"hdb_job": {
+		"hash_attribute": "id",
+		"name": "hdb_job",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "id"
+			},
+			{
+				"attribute": "user"
+			},
+			{
+				"attribute": "type"
+			},
+			{
+				"attribute": "status"
+			},
+			{
+				"attribute": "start_datetime"
+			},
+			{
+				"attribute": "end_datetime"
+			},
+			{
+				"attribute": "message"
+			},
+			{
+				"attribute": "created_datetime"
+			},
+			{
+				"attribute": "request"
+			},
+			{
+				"attribute": "__createdtime__"
+			},
+			{
+				"attribute": "__updatedtime__"
+			}
+		]
+	},
+	"hdb_license": {
+		"hash_attribute": "id",
+		"table": "hdb_license",
+		"database": "system",
+		"audit": true,
+		"attributes": [
+			{
+				"attribute": "id"
+			},
+			{
+				"name": "level"
+			},
+			{
+				"name": "region",
+				"indexed": true
+			},
+			{
+				"name": "reads"
+			},
+			{
+				"name": "writes"
+			},
+			{
+				"name": "readBytes"
+			},
+			{
+				"name": "writeBytes"
+			},
+			{
+				"name": "realTimeMessages"
+			},
+			{
+				"name": "realTimeBytes"
+			},
+			{
+				"name": "cpuTime"
+			},
+			{
+				"name": "storage"
+			},
+			{
+				"name": "usedReads"
+			},
+			{
+				"name": "usedWrites"
+			},
+			{
+				"name": "usedReadBytes"
+			},
+			{
+				"name": "usedWriteBytes"
+			},
+			{
+				"name": "usedRealTimeMessages"
+			},
+			{
+				"name": "usedRealTimeBytes"
+			},
+			{
+				"name": "usedCpuTime"
+			},
+			{
+				"name": "usedStorage"
+			},
+			{
+				"name": "expiration"
+			},
+			{
+				"name": "autoRenew"
+			},
+			{
+				"name": "__createdtime__",
+				"indexed": true
+			},
+			{
+				"name": "__updatedtime__",
+				"indexed": true
+			}
+		]
+	},
+	"hdb_info": {
+		"hash_attribute": "info_id",
+		"name": "hdb_info",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "info_id"
+			},
+			{
+				"attribute": "data_version_num"
+			},
+			{
+				"attribute": "hdb_version_num"
+			},
+			{
+				"attribute": "__createdtime__"
+			},
+			{
+				"attribute": "__updatedtime__"
+			}
+		]
+	},
+	"hdb_nodes": {
+		"hash_attribute": "name",
+		"name": "hdb_nodes",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "name"
+			},
+			{
+				"attribute": "subscriptions"
+			},
+			{
+				"attribute": "system_info"
+			},
+			{
+				"attribute": "url"
+			},
+			{
+				"attribute": "routes"
+			},
+			{
+				"attribute": "revoked_certificates"
+			},
+			{
+				"attribute": "shard"
+			}
+		]
+	},
+	"hdb_certificate": {
+		"hash_attribute": "name",
+		"name": "hdb_certificate",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "name"
+			},
+			{
+				"attribute": "uses"
+			},
+			{
+				"attribute": "certificate"
+			},
+			{
+				"attribute": "is_authority"
+			},
+			{
+				"attribute": "private_key_name"
+			},
+			{
+				"attribute": "details"
+			},
+			{
+				"attribute": "is_self_signed"
+			},
+			{
+				"attribute": "__updatedtime__"
+			}
+		]
+	},
+	"hdb_analytics_hostname": {
+		"hash_attribute": "id",
+		"name": "hdb_analytics_hostname",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "id"
+			},
+			{
+				"attribute": "hostname"
+			}
+		]
+	},
+	"hdb_analytics": {
+		"hash_attribute": "id",
+		"name": "hdb_analytics",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "id"
+			},
+			{
+				"name": "metric"
+			},
+			{
+				"name": "path"
+			},
+			{
+				"name": "method"
+			},
+			{
+				"name": "type"
+			}
+		]
+	},
+	"hdb_raw_analytics": {
+		"hash_attribute": "id",
+		"name": "hdb_raw_analytics",
+		"schema": "system",
+		"audit": false,
+		"attributes": [
+			{
+				"attribute": "id"
+			},
+			{
+				"attribute": "time"
+			},
+			{
+				"attribute": "metrics"
+			}
+		]
+	},
+	"hdb_temp": {
+		"hash_attribute": "id",
+		"name": "hdb_temp",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "id"
+			}
+		]
+	},
+	"hdb_durable_session": {
+		"hash_attribute": "id",
+		"name": "hdb_durable_session",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "id"
+			}
+		]
+	},
+	"hdb_session_will": {
+		"hash_attribute": "id",
+		"name": "hdb_session_will",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "id"
+			}
+		]
+	},
+	"hdb_certificate_cache": {
+		"hash_attribute": "certificate_id",
+		"name": "hdb_certificate_cache",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "certificate_id"
+			}
+		]
+	},
+	"hdb_crl_cache": {
+		"hash_attribute": "distribution_point",
+		"name": "hdb_crl_cache",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "distribution_point"
+			}
+		]
+	},
+	"hdb_revoked_certificates": {
+		"hash_attribute": "composite_id",
+		"name": "hdb_revoked_certificates",
+		"schema": "system",
+		"attributes": [
+			{
+				"attribute": "composite_id"
+			}
+		]
+	}
+}

package/launchServiceScripts/launchHarperDB.js

@@ -0,0 +1,3 @@
+'use strict';
+
+require('../server/operationsServer.ts').hdbServer();

package/launchServiceScripts/utility/checkNodeVersion.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const semverMajor = require('semver/functions/major');
+const { packageJson } = require('../../utility/packageUtils.js');
+const INSTALLED_NODE_VERSION = process.versions && process.versions.node ? process.versions.node : undefined;
+
+module.exports = checkNodeVersion;
+
+function checkNodeVersion() {
+	const minimumHdbNodeVersion = packageJson.engines['minimum-node'];
+	if (INSTALLED_NODE_VERSION && semverMajor(INSTALLED_NODE_VERSION) < semverMajor(minimumHdbNodeVersion)) {
+		const versionError = `The minimum version of Node.js Harper supports is: ${minimumHdbNodeVersion}, the currently installed Node.js version is: ${INSTALLED_NODE_VERSION}. Please install a version of Node.js that is withing the defined range.`;
+		return { error: versionError };
+	}
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@harperfast/harper",
 	"description": "Harper is an open-source Node.js performance platform that unifies database, cache, application, and messaging layers into one in-memory process.",
-	"version": "5.0.0-alpha.10",
+	"version": "5.0.0-beta.1",
 	"license": "Apache-2.0",
 	"homepage": "https://harper.fast",
 	"bugs": {
@@ -23,7 +23,25 @@
 	},
 	"files": [
 		"dist",
+		"bin",
+		"components",
+		"config",
+		"dataLayer",
+		"json",
+		"launchServiceScripts",
+		"resources",
+		"security",
+		"server",
+		"sqlTranslator",
+		"upgrade",
+		"utility",
+		"validation",
+		"studio",
 		"static",
+		"index.*",
+		"v1.*",
+		"v2.*",
+		"README.md",
 		"SECURITY.md",
 		"SUPPORT.md",
 		"CODE_OF_CONDUCT.md"
@@ -31,7 +49,7 @@
 	"scripts": {
 		"build": "tsc --project tsconfig.build.json",
 		"build:watch": "npm run build -- --watch --incremental",
-		"package": "npm run build; npm shrinkwrap && npm pack",
+		"package": "./build-tools/build.sh",
 		"lint": "oxlint --deny-warnings .",
 		"lint:required": "oxlint --quiet .",
 		"lint:fix": "npm run lint -- --fix",
@@ -174,7 +192,7 @@
 		"json2csv": "5.0.7",
 		"jsonata": "1.8.7",
 		"jsonwebtoken": "9.0.3",
-		"lmdb": "3.5.1",
+		"lmdb": "3.5.2",
 		"lodash": "4.17.21",
 		"mathjs": "11.12.0",
 		"micromatch": "^4.0.8",