@arkstack/common 0.1.30 → 0.2.0

package/dist/index.d.ts

@@ -1,9 +1,11 @@
 /// <reference path="./app.d.ts" />
+import { DotPath } from "@h3ravel/support";
+
 //#region src/lifecycle.d.ts
 declare const bindGracefulShutdown: (shutdown: () => Promise<void> | void) => void;
 //#endregion
 //#region src/network.d.ts
-declare const bootWithDetectedPort: (boot: (port: number) => Promise<void>, preferredPort?: number) => Promise<void>;
+declare const bootWithDetectedPort: (boot: (port: number) => Promise<void>, preferredPort?: number, app?: any) => Promise<void>;
 declare const buildHtmlErrorResponse: ({
   message,
   stack,
@@ -19,5 +21,10 @@ declare const buildHtmlErrorResponse: ({
 //#region src/prototypes.d.ts
 declare const loadPrototypes: () => void;
 //#endregion
-export { bindGracefulShutdown, bootWithDetectedPort, buildHtmlErrorResponse, loadPrototypes };
+//#region src/system.d.ts
+declare const env: <X = string, Y = undefined>(env: string, defaultValue?: Y) => Y extends undefined ? X : Y;
+declare const appUrl: (link?: string) => string;
+declare const config: <X extends Record<string, any>, P extends DotPath<X> | undefined = undefined>(key?: P, defaultValue?: any) => P extends string ? any : X;
+//#endregion
+export { appUrl, bindGracefulShutdown, bootWithDetectedPort, buildHtmlErrorResponse, config, env, loadPrototypes };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,4 +1,8 @@
 import { detect } from "detect-port";
+import { Obj } from "@h3ravel/support";
+import { createRequire } from "module";
+import path from "node:path";
+import { readdirSync } from "fs";
 
 //#region src/lifecycle.ts
 const bindGracefulShutdown = (shutdown) => {
@@ -15,7 +19,9 @@ const bindGracefulShutdown = (shutdown) => {
 
 //#endregion
 //#region src/network.ts
-const bootWithDetectedPort = async (boot, preferredPort = 3e3) => {
+const bootWithDetectedPort = async (boot, preferredPort = 3e3, app) => {
+	if (app && globalThis.app) globalThis.app = () => app;
+	globalThis.arkctx = { runtime: "HTTP" };
 	await boot(await detect(preferredPort));
 };
 const buildHtmlErrorResponse = ({ message = "An unexpected error occurred.", stack, title, code = 500 }) => {
@@ -96,5 +102,75 @@ const loadPrototypes = () => {
 };
 
 //#endregion
-export { bindGracefulShutdown, bootWithDetectedPort, buildHtmlErrorResponse, loadPrototypes };
+//#region src/system.ts
+/**
+* Read the .env file
+*
+* @param env
+* @param def
+* @returns
+*/
+const env = (env, defaultValue) => {
+	let val = process.env[env] ?? "";
+	if ([
+		true,
+		"true",
+		"on",
+		false,
+		"false",
+		"off"
+	].includes(val)) val = [
+		true,
+		"true",
+		"on"
+	].includes(val);
+	if (!isNaN(Number(val)) && typeof val !== "boolean" && typeof val !== "undefined" && val !== "") val = Number(val);
+	if (val === "") val = void 0;
+	if (val === "null") val = null;
+	val ??= defaultValue;
+	return val;
+};
+/**
+* Build the app url
+*
+* @param link
+* @returns
+*/
+const appUrl = (link) => {
+	const port = env("PORT") || "3000";
+	const defaultUrl = `http://localhost:${port}`;
+	const appUrl = env("APP_URL") ?? defaultUrl;
+	try {
+		const url = new URL(appUrl);
+		if (url.port || url.hostname === "localhost") url.port = port;
+		const baseUrl = url.toString().replace(/\/$/, "");
+		if (link) return `${baseUrl}${`/${link.replace(/^\/+/, "")}`}`;
+		return baseUrl;
+	} catch {
+		return link ? `${defaultUrl}/${link.replace(/^\/+/, "")}` : defaultUrl;
+	}
+};
+/**
+* Gets the application configuration.
+* 
+* @param key             The configuration key to retrieve.
+* @param defaultValue    The default value to return if the key is not found.
+* @returns               The configuration value.
+*/
+const config = (key, defaultValue) => {
+	const require = createRequire(import.meta.url);
+	const config = readdirSync(path.join(process.cwd(), "dist/config"), { withFileTypes: true }).filter((file) => {
+		if (file.name.includes("middleware") && globalThis.arkctx.runtime === "CLI") return false;
+		return file.isFile() && (file.name.endsWith(".js") || file.name.endsWith(".ts"));
+	}).reduce((configs, file) => {
+		const configName = path.basename(file.name, path.extname(file.name));
+		configs[configName] = require(path.join(file.parentPath, file.name)).default(globalThis.app());
+		return configs;
+	}, {});
+	if (key) return Obj.get(config, key, defaultValue);
+	return config;
+};
+
+//#endregion
+export { appUrl, bindGracefulShutdown, bootWithDetectedPort, buildHtmlErrorResponse, config, env, loadPrototypes };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/lifecycle.ts","../src/network.ts","../src/prototypes.ts"],"sourcesContent":["export const bindGracefulShutdown = (shutdown: () => Promise<void> | void) => {\n  ['SIGINT', 'SIGTERM', 'SIGQUIT'].forEach((signal) => {\n    process.on(signal, async () => {\n      await shutdown()\n    })\n  })\n}\n","import { detect } from 'detect-port'\n\nexport const bootWithDetectedPort = async (\n  boot: (port: number) => Promise<void>,\n  preferredPort: number = 3000,\n) => {\n  const port = await detect(preferredPort)\n  await boot(port)\n}\n\n\nexport const buildHtmlErrorResponse = ({\n  message = 'An unexpected error occurred.',\n  stack,\n  title,\n  code = 500,\n}: {\n  message?: string;\n  stack?: string;\n  code?: number;\n  title?: string;\n}) => {\n  const titleMap: Record<number, string> = {\n    400: 'Bad Request',\n    401: 'Unauthorized',\n    403: 'Forbidden',\n    404: 'Not Found',\n    500: 'Internal Server Error',\n    502: 'Bad Gateway',\n    503: 'Service Unavailable',\n    504: 'Gateway Timeout',\n  }\n\n  title = titleMap[code] || title || 'Error'\n\n  return `\n    <html>\n      <head>\n        <title>${code} | ${title}</title>\n        <style>\n          body {\n            font-family: Arial, sans-serif;\n            background-color: #f8f8f8;\n            color: #333;\n            padding: 20px;\n          }\n          h1 {\n            color: #e74c3c;\n          }\n          h3 {\n            color: #3498db;\n          }\n          p {\n            color: #555;\n          }\n          pre {\n            background-color: #eee;\n            padding: 10px;\n            border-radius: 5px;\n            overflow-x: auto;\n          }\n        </style>\n      </head>\n      <body>\n        <h1>${code}</h1>\n        <h3>${title}</h3>\n        <p>${message}</p>\n        ${stack ? `<h2>Stack Trace:</h2><pre>${stack}</pre>` : ''}\n      </body>\n    </html>\n  `\n}","export const loadPrototypes = () => {\n    String.prototype.titleCase = function () {\n        return this.toLowerCase()\n            .replace(/_/g, ' ')\n            .replace(/-/g, ' ')\n            .replace(/(?:^|\\s)\\w/g, function (match) {\n                return match.toUpperCase()\n            })\n    }\n\n    String.prototype.camelCase = function () {\n        return this.replace(/(?:^\\w|[A-Z]|\\b\\w|\\s+)/g, function (match, index) {\n            if (+match === 0) return '' // or if (/\\s+/.test(match)) for white spaces\n\n            return index === 0 ? match.toLowerCase() : match.toUpperCase()\n        })\n    }\n\n    String.prototype.pascalCase = function () {\n        return this.replace(/(?:^\\w|[A-Z]|\\b\\w|\\s+)/g, function (match) {\n            return match.toUpperCase()\n        })\n    }\n\n    String.prototype.truncate = function (len: number = 20, suffix: string = '...') {\n        if (this.length <= len) {\n            return this.toString()\n        }\n\n        const truncated = this.substring(0, len)\n        const lastSpaceIndex = truncated.lastIndexOf(' ')\n        if (lastSpaceIndex > 0) {\n            return truncated.substring(0, lastSpaceIndex) + suffix\n        }\n\n        return truncated + suffix\n    }\n} \n"],"mappings":";;;AAAA,MAAa,wBAAwB,aAAyC;AAC5E;EAAC;EAAU;EAAW;EAAU,CAAC,SAAS,WAAW;AACnD,UAAQ,GAAG,QAAQ,YAAY;AAC7B,SAAM,UAAU;IAChB;GACF;;;;;ACHJ,MAAa,uBAAuB,OAClC,MACA,gBAAwB,QACrB;AAEH,OAAM,KADO,MAAM,OAAO,cAAc,CACxB;;AAIlB,MAAa,0BAA0B,EACrC,UAAU,iCACV,OACA,OACA,OAAO,UAMH;AAYJ,SAXyC;EACvC,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACN,CAEgB,SAAS,SAAS;AAEnC,QAAO;;;iBAGQ,KAAK,KAAK,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;cA0BnB,KAAK;cACL,MAAM;aACP,QAAQ;UACX,QAAQ,6BAA6B,MAAM,UAAU,GAAG;;;;;;;;ACnElE,MAAa,uBAAuB;AAChC,QAAO,UAAU,YAAY,WAAY;AACrC,SAAO,KAAK,aAAa,CACpB,QAAQ,MAAM,IAAI,CAClB,QAAQ,MAAM,IAAI,CAClB,QAAQ,eAAe,SAAU,OAAO;AACrC,UAAO,MAAM,aAAa;IAC5B;;AAGV,QAAO,UAAU,YAAY,WAAY;AACrC,SAAO,KAAK,QAAQ,2BAA2B,SAAU,OAAO,OAAO;AACnE,OAAI,CAAC,UAAU,EAAG,QAAO;AAEzB,UAAO,UAAU,IAAI,MAAM,aAAa,GAAG,MAAM,aAAa;IAChE;;AAGN,QAAO,UAAU,aAAa,WAAY;AACtC,SAAO,KAAK,QAAQ,2BAA2B,SAAU,OAAO;AAC5D,UAAO,MAAM,aAAa;IAC5B;;AAGN,QAAO,UAAU,WAAW,SAAU,MAAc,IAAI,SAAiB,OAAO;AAC5E,MAAI,KAAK,UAAU,IACf,QAAO,KAAK,UAAU;EAG1B,MAAM,YAAY,KAAK,UAAU,GAAG,IAAI;EACxC,MAAM,iBAAiB,UAAU,YAAY,IAAI;AACjD,MAAI,iBAAiB,EACjB,QAAO,UAAU,UAAU,GAAG,eAAe,GAAG;AAGpD,SAAO,YAAY"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/lifecycle.ts","../src/network.ts","../src/prototypes.ts","../src/system.ts"],"sourcesContent":["export const bindGracefulShutdown = (shutdown: () => Promise<void> | void) => {\n  ['SIGINT', 'SIGTERM', 'SIGQUIT'].forEach((signal) => {\n    process.on(signal, async () => {\n      await shutdown()\n    })\n  })\n}\n","import { detect } from 'detect-port'\n\nexport const bootWithDetectedPort = async (\n  boot: (port: number) => Promise<void>,\n  preferredPort: number = 3000,\n  app?: any\n) => {\n  if (app && globalThis.app)\n    globalThis.app = () => app\n  globalThis.arkctx = {\n    runtime: 'HTTP',\n  }\n  const port = await detect(preferredPort)\n  await boot(port)\n}\n\n\nexport const buildHtmlErrorResponse = ({\n  message = 'An unexpected error occurred.',\n  stack,\n  title,\n  code = 500,\n}: {\n  message?: string;\n  stack?: string;\n  code?: number;\n  title?: string;\n}) => {\n  const titleMap: Record<number, string> = {\n    400: 'Bad Request',\n    401: 'Unauthorized',\n    403: 'Forbidden',\n    404: 'Not Found',\n    500: 'Internal Server Error',\n    502: 'Bad Gateway',\n    503: 'Service Unavailable',\n    504: 'Gateway Timeout',\n  }\n\n  title = titleMap[code] || title || 'Error'\n\n  return `\n    <html>\n      <head>\n        <title>${code} | ${title}</title>\n        <style>\n          body {\n            font-family: Arial, sans-serif;\n            background-color: #f8f8f8;\n            color: #333;\n            padding: 20px;\n          }\n          h1 {\n            color: #e74c3c;\n          }\n          h3 {\n            color: #3498db;\n          }\n          p {\n            color: #555;\n          }\n          pre {\n            background-color: #eee;\n            padding: 10px;\n            border-radius: 5px;\n            overflow-x: auto;\n          }\n        </style>\n      </head>\n      <body>\n        <h1>${code}</h1>\n        <h3>${title}</h3>\n        <p>${message}</p>\n        ${stack ? `<h2>Stack Trace:</h2><pre>${stack}</pre>` : ''}\n      </body>\n    </html>\n  `\n}","export const loadPrototypes = () => {\n    String.prototype.titleCase = function () {\n        return this.toLowerCase()\n            .replace(/_/g, ' ')\n            .replace(/-/g, ' ')\n            .replace(/(?:^|\\s)\\w/g, function (match) {\n                return match.toUpperCase()\n            })\n    }\n\n    String.prototype.camelCase = function () {\n        return this.replace(/(?:^\\w|[A-Z]|\\b\\w|\\s+)/g, function (match, index) {\n            if (+match === 0) return '' // or if (/\\s+/.test(match)) for white spaces\n\n            return index === 0 ? match.toLowerCase() : match.toUpperCase()\n        })\n    }\n\n    String.prototype.pascalCase = function () {\n        return this.replace(/(?:^\\w|[A-Z]|\\b\\w|\\s+)/g, function (match) {\n            return match.toUpperCase()\n        })\n    }\n\n    String.prototype.truncate = function (len: number = 20, suffix: string = '...') {\n        if (this.length <= len) {\n            return this.toString()\n        }\n\n        const truncated = this.substring(0, len)\n        const lastSpaceIndex = truncated.lastIndexOf(' ')\n        if (lastSpaceIndex > 0) {\n            return truncated.substring(0, lastSpaceIndex) + suffix\n        }\n\n        return truncated + suffix\n    }\n} \n","import { DotPath, Obj } from '@h3ravel/support'\n\nimport { createRequire } from 'module'\nimport path from 'node:path'\nimport { readdirSync } from 'fs'\n\n/**\n * Read the .env file\n *\n * @param env\n * @param def\n * @returns\n */\nexport const env = <X = string, Y = undefined> (\n    env: string,\n    defaultValue?: Y,\n): Y extends undefined ? X : Y => {\n    let val: string | number | boolean | undefined | null = process.env[env] ?? ''\n\n    if ([true, 'true', 'on', false, 'false', 'off'].includes(val)) {\n        val = [true, 'true', 'on'].includes(val)\n    }\n\n    if (!isNaN(Number(val)) && typeof val !== 'boolean' && typeof val !== 'undefined' && val !== '') {\n        val = Number(val)\n    }\n\n    if (val === '') {\n        val = undefined\n    }\n\n    if (val === 'null') {\n        val = null\n    }\n\n    val ??= defaultValue as typeof val\n\n    return val as Y extends undefined ? X : Y\n}\n\n/**\n * Build the app url\n *\n * @param link\n * @returns\n */\nexport const appUrl = (link?: string): string => {\n    const port = env('PORT') || '3000'\n    const defaultUrl = `http://localhost:${port}`\n    const appUrl = env('APP_URL') ?? defaultUrl\n\n    try {\n        const url = new URL(appUrl)\n        // Append port only if APP_URL has a port or is localhost\n        if (url.port || url.hostname === 'localhost') {\n            url.port = port\n        }\n        // Remove trailing slash from base URL\n        const baseUrl = url.toString().replace(/\\/$/, '')\n        // Append link with proper path separator\n        if (link) {\n            // Ensure link starts with '/' and remove duplicate slashes\n            const normalizedLink = `/${link.replace(/^\\/+/, '')}`\n\n            return `${baseUrl}${normalizedLink}`\n        }\n\n        return baseUrl\n    } catch {\n        // Return default URL with link if provided\n        return link ? `${defaultUrl}/${link.replace(/^\\/+/, '')}` : defaultUrl\n    }\n}\n\n/**\n * Gets the application configuration.\n * \n * @param key             The configuration key to retrieve.\n * @param defaultValue    The default value to return if the key is not found.\n * @returns               The configuration value.\n */\nexport const config = <X extends Record<string, any>, P extends DotPath<X> | undefined = undefined> (\n    key?: P,\n    defaultValue?: any\n): P extends string ? any : X => {\n    const require = createRequire(import.meta.url)\n\n    const files = readdirSync(path.join(process.cwd(), 'dist/config'), { withFileTypes: true })\n        .filter(file => {\n            if (file.name.includes('middleware') && globalThis.arkctx.runtime === 'CLI') return false\n\n            return file.isFile() && (file.name.endsWith('.js') || file.name.endsWith('.ts'))\n        })\n\n    const config = files.reduce((configs, file) => {\n        const configName = path.basename(file.name, path.extname(file.name))\n\n        configs[configName] = require(path.join(file.parentPath, file.name))\n            .default((globalThis as any).app())\n\n        return configs\n    }, {} as Record<string, any>) as X\n\n\n    if (key) {\n        return Obj.get(config, key, defaultValue)\n    }\n\n    return config\n}"],"mappings":";;;;;;;AAAA,MAAa,wBAAwB,aAAyC;AAC5E;EAAC;EAAU;EAAW;EAAU,CAAC,SAAS,WAAW;AACnD,UAAQ,GAAG,QAAQ,YAAY;AAC7B,SAAM,UAAU;IAChB;GACF;;;;;ACHJ,MAAa,uBAAuB,OAClC,MACA,gBAAwB,KACxB,QACG;AACH,KAAI,OAAO,WAAW,IACpB,YAAW,YAAY;AACzB,YAAW,SAAS,EAClB,SAAS,QACV;AAED,OAAM,KADO,MAAM,OAAO,cAAc,CACxB;;AAIlB,MAAa,0BAA0B,EACrC,UAAU,iCACV,OACA,OACA,OAAO,UAMH;AAYJ,SAXyC;EACvC,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACN,CAEgB,SAAS,SAAS;AAEnC,QAAO;;;iBAGQ,KAAK,KAAK,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;cA0BnB,KAAK;cACL,MAAM;aACP,QAAQ;UACX,QAAQ,6BAA6B,MAAM,UAAU,GAAG;;;;;;;;ACzElE,MAAa,uBAAuB;AAChC,QAAO,UAAU,YAAY,WAAY;AACrC,SAAO,KAAK,aAAa,CACpB,QAAQ,MAAM,IAAI,CAClB,QAAQ,MAAM,IAAI,CAClB,QAAQ,eAAe,SAAU,OAAO;AACrC,UAAO,MAAM,aAAa;IAC5B;;AAGV,QAAO,UAAU,YAAY,WAAY;AACrC,SAAO,KAAK,QAAQ,2BAA2B,SAAU,OAAO,OAAO;AACnE,OAAI,CAAC,UAAU,EAAG,QAAO;AAEzB,UAAO,UAAU,IAAI,MAAM,aAAa,GAAG,MAAM,aAAa;IAChE;;AAGN,QAAO,UAAU,aAAa,WAAY;AACtC,SAAO,KAAK,QAAQ,2BAA2B,SAAU,OAAO;AAC5D,UAAO,MAAM,aAAa;IAC5B;;AAGN,QAAO,UAAU,WAAW,SAAU,MAAc,IAAI,SAAiB,OAAO;AAC5E,MAAI,KAAK,UAAU,IACf,QAAO,KAAK,UAAU;EAG1B,MAAM,YAAY,KAAK,UAAU,GAAG,IAAI;EACxC,MAAM,iBAAiB,UAAU,YAAY,IAAI;AACjD,MAAI,iBAAiB,EACjB,QAAO,UAAU,UAAU,GAAG,eAAe,GAAG;AAGpD,SAAO,YAAY;;;;;;;;;;;;;ACtB3B,MAAa,OACT,KACA,iBAC8B;CAC9B,IAAI,MAAoD,QAAQ,IAAI,QAAQ;AAE5E,KAAI;EAAC;EAAM;EAAQ;EAAM;EAAO;EAAS;EAAM,CAAC,SAAS,IAAI,CACzD,OAAM;EAAC;EAAM;EAAQ;EAAK,CAAC,SAAS,IAAI;AAG5C,KAAI,CAAC,MAAM,OAAO,IAAI,CAAC,IAAI,OAAO,QAAQ,aAAa,OAAO,QAAQ,eAAe,QAAQ,GACzF,OAAM,OAAO,IAAI;AAGrB,KAAI,QAAQ,GACR,OAAM;AAGV,KAAI,QAAQ,OACR,OAAM;AAGV,SAAQ;AAER,QAAO;;;;;;;;AASX,MAAa,UAAU,SAA0B;CAC7C,MAAM,OAAO,IAAI,OAAO,IAAI;CAC5B,MAAM,aAAa,oBAAoB;CACvC,MAAM,SAAS,IAAI,UAAU,IAAI;AAEjC,KAAI;EACA,MAAM,MAAM,IAAI,IAAI,OAAO;AAE3B,MAAI,IAAI,QAAQ,IAAI,aAAa,YAC7B,KAAI,OAAO;EAGf,MAAM,UAAU,IAAI,UAAU,CAAC,QAAQ,OAAO,GAAG;AAEjD,MAAI,KAIA,QAAO,GAAG,UAFa,IAAI,KAAK,QAAQ,QAAQ,GAAG;AAKvD,SAAO;SACH;AAEJ,SAAO,OAAO,GAAG,WAAW,GAAG,KAAK,QAAQ,QAAQ,GAAG,KAAK;;;;;;;;;;AAWpE,MAAa,UACT,KACA,iBAC6B;CAC7B,MAAM,UAAU,cAAc,OAAO,KAAK,IAAI;CAS9C,MAAM,SAPQ,YAAY,KAAK,KAAK,QAAQ,KAAK,EAAE,cAAc,EAAE,EAAE,eAAe,MAAM,CAAC,CACtF,QAAO,SAAQ;AACZ,MAAI,KAAK,KAAK,SAAS,aAAa,IAAI,WAAW,OAAO,YAAY,MAAO,QAAO;AAEpF,SAAO,KAAK,QAAQ,KAAK,KAAK,KAAK,SAAS,MAAM,IAAI,KAAK,KAAK,SAAS,MAAM;GACjF,CAEe,QAAQ,SAAS,SAAS;EAC3C,MAAM,aAAa,KAAK,SAAS,KAAK,MAAM,KAAK,QAAQ,KAAK,KAAK,CAAC;AAEpE,UAAQ,cAAc,QAAQ,KAAK,KAAK,KAAK,YAAY,KAAK,KAAK,CAAC,CAC/D,QAAS,WAAmB,KAAK,CAAC;AAEvC,SAAO;IACR,EAAE,CAAwB;AAG7B,KAAI,IACA,QAAO,IAAI,IAAI,QAAQ,KAAK,aAAa;AAG7C,QAAO"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/common",
-  "version": "0.1.30",
+  "version": "0.2.0",
   "type": "module",
   "description": "Common package for Arkstack providing common implementations of core Arkstack features such as routing, middleware, and database integration.",
   "homepage": "https://arkstack.toneflix.net",
@@ -32,6 +32,9 @@
   "dependencies": {
     "detect-port": "^2.1.0"
   },
+  "peerDependencies": {
+    "@h3ravel/support": "^0.15.11"
+  },
   "scripts": {
     "build": "tsdown --config-loader unconfig",
     "version:patch": "pnpm version patch"