@arkstack/common 0.15.0 → 0.15.1

package/dist/index.d.ts

@@ -789,4 +789,28 @@ declare class ConfigLoader {
  */
 declare const configLoader: ConfigLoader;
 //#endregion
-export { AbstractModelConstructor, AppConfig, AppException, ArkstackErrorPayload, ArkstackErrorShape, CONFIG_KEY, ConfigLoader, ConfigRegistry, ConfigShape, DotPath, DotPathValue, Encryption, EnvKey, EnvLoader, EnvLookup, EnvRegistry, EnvReturn, ErrorHandler, Exception, FileImporter, GlobalConfig, GlobalEnv, Hash, Hook, HookArgs, HookFor, HookName, HookPos, HookPositions, HookRegistry, IHook, Logger, LoggerChalk, LoggerLog, LoggerParseSignature, MergedConfig, ModelConstructor, ModelRegistry, Primitive, PublishEntry, PublishFilter, PublishGroup, Publisher, RequestException, UnionToIntersection, abort, abortIf, appKey, appUrl, assertFound, bindGracefulShutdown, bootWithDetectedPort, config, configLoader, createErrorPayload, discoverCommands, env, envLoader, getErrorLogger, getModel, getPrimaryError, getValidationErrors, importFile, initializeGlobalContext, interopDefault, isClass, isModelNotFoundError, isValidationError, loadPrototypes, logUnhandledError, nodeEnv, normalizeStatusCode, outputDir, perPage, rebuildOutput, renderError, resolveRuntimeDir, resolveRuntimeModule, serializeError, shouldHideStack, shouldLogError, toErrorShape, toOutputPath };
+//#region src/tls.d.ts
+interface TlsCredentials {
+  /** PEM-encoded private key. */
+  key: string;
+  /** PEM-encoded certificate. */
+  cert: string;
+}
+/**
+ * Generate (and cache) an in-memory self-signed TLS certificate for local HTTPS
+ * development. `selfsigned` is imported lazily so it's only loaded when secure
+ * dev mode is actually used.
+ *
+ * The certificate is not trusted by browsers (expect the usual self-signed
+ * warning); it exists only so the dev server can speak HTTPS.
+ *
+ * @param host  The common name for the certificate (defaults to `localhost`).
+ */
+declare const devTlsCredentials: (host?: string) => Promise<TlsCredentials>;
+/**
+ * The machine's first non-internal IPv4 address — its address on the local
+ * network — or `undefined` when only loopback interfaces are available.
+ */
+declare const localNetworkAddress: () => string | undefined;
+//#endregion
+export { AbstractModelConstructor, AppConfig, AppException, ArkstackErrorPayload, ArkstackErrorShape, CONFIG_KEY, ConfigLoader, ConfigRegistry, ConfigShape, DotPath, DotPathValue, Encryption, EnvKey, EnvLoader, EnvLookup, EnvRegistry, EnvReturn, ErrorHandler, Exception, FileImporter, GlobalConfig, GlobalEnv, Hash, Hook, HookArgs, HookFor, HookName, HookPos, HookPositions, HookRegistry, IHook, Logger, LoggerChalk, LoggerLog, LoggerParseSignature, MergedConfig, ModelConstructor, ModelRegistry, Primitive, PublishEntry, PublishFilter, PublishGroup, Publisher, RequestException, TlsCredentials, UnionToIntersection, abort, abortIf, appKey, appUrl, assertFound, bindGracefulShutdown, bootWithDetectedPort, config, configLoader, createErrorPayload, devTlsCredentials, discoverCommands, env, envLoader, getErrorLogger, getModel, getPrimaryError, getValidationErrors, importFile, initializeGlobalContext, interopDefault, isClass, isModelNotFoundError, isValidationError, loadPrototypes, localNetworkAddress, logUnhandledError, nodeEnv, normalizeStatusCode, outputDir, perPage, rebuildOutput, renderError, resolveRuntimeDir, resolveRuntimeModule, serializeError, shouldHideStack, shouldLogError, toErrorShape, toOutputPath };

package/dist/index.js

@@ -8,6 +8,7 @@ import { ModelNotFoundException } from "arkormx";
 import { detect } from "detect-port";
 import pino from "pino";
 import chalk from "chalk";
+import { networkInterfaces } from "node:os";
 //#region src/lifecycle.ts
 const bindGracefulShutdown = (shutdown, defer) => {
 	if (defer) return;
@@ -531,4 +532,41 @@ var Hook = class {
 	};
 };
 //#endregion
-export { AppException, CONFIG_KEY, ConfigLoader, Encryption, EnvLoader, ErrorHandler, Exception, Hash, Hook, Logger, Publisher, RequestException, abort, abortIf, appKey, appUrl, assertFound, bindGracefulShutdown, bootWithDetectedPort, config, configLoader, createErrorPayload, discoverCommands, env, envLoader, getErrorLogger, getModel, getPrimaryError, getValidationErrors, importFile, initializeGlobalContext, interopDefault, isClass, isModelNotFoundError, isValidationError, loadPrototypes, logUnhandledError, nodeEnv, normalizeStatusCode, outputDir, perPage, rebuildOutput, renderError, resolveRuntimeDir, resolveRuntimeModule, serializeError, shouldHideStack, shouldLogError, toErrorShape, toOutputPath };
+//#region src/tls.ts
+let devCertCache;
+/**
+* Generate (and cache) an in-memory self-signed TLS certificate for local HTTPS
+* development. `selfsigned` is imported lazily so it's only loaded when secure
+* dev mode is actually used.
+*
+* The certificate is not trusted by browsers (expect the usual self-signed
+* warning); it exists only so the dev server can speak HTTPS.
+*
+* @param host  The common name for the certificate (defaults to `localhost`).
+*/
+const devTlsCredentials = async (host = "localhost") => {
+	if (devCertCache) return devCertCache;
+	const mod = await import("selfsigned");
+	const pems = (mod.default ?? mod).generate([{
+		name: "commonName",
+		value: host
+	}], {
+		days: 365,
+		keySize: 2048,
+		algorithm: "sha256"
+	});
+	devCertCache = {
+		key: pems.private,
+		cert: pems.cert
+	};
+	return devCertCache;
+};
+/**
+* The machine's first non-internal IPv4 address — its address on the local
+* network — or `undefined` when only loopback interfaces are available.
+*/
+const localNetworkAddress = () => {
+	for (const list of Object.values(networkInterfaces())) for (const net of list ?? []) if (net.family === "IPv4" && !net.internal) return net.address;
+};
+//#endregion
+export { AppException, CONFIG_KEY, ConfigLoader, Encryption, EnvLoader, ErrorHandler, Exception, Hash, Hook, Logger, Publisher, RequestException, abort, abortIf, appKey, appUrl, assertFound, bindGracefulShutdown, bootWithDetectedPort, config, configLoader, createErrorPayload, devTlsCredentials, discoverCommands, env, envLoader, getErrorLogger, getModel, getPrimaryError, getValidationErrors, importFile, initializeGlobalContext, interopDefault, isClass, isModelNotFoundError, isValidationError, loadPrototypes, localNetworkAddress, logUnhandledError, nodeEnv, normalizeStatusCode, outputDir, perPage, rebuildOutput, renderError, resolveRuntimeDir, resolveRuntimeModule, serializeError, shouldHideStack, shouldLogError, toErrorShape, toOutputPath };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/common",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "type": "module",
   "description": "Core utilities, primitives, and shared infrastructure for the Arkstack ecosystem.",
   "homepage": "https://arkstack.toneflix.net",
@@ -40,13 +40,14 @@
     "dotenv": "^17.4.2",
     "jiti": "^2.7.0",
     "otpauth": "^9.5.1",
-    "pino": "^10.3.1"
+    "pino": "^10.3.1",
+    "selfsigned": "^2.4.1"
   },
   "peerDependencies": {
     "@h3ravel/support": "^2.2.0",
     "arkormx": "^2.10.1",
-    "@arkstack/contract": "^0.15.0",
-    "@arkstack/foundry": "^0.15.0"
+    "@arkstack/foundry": "^0.15.1",
+    "@arkstack/contract": "^0.15.1"
   },
   "optionalDependencies": {
     "@faker-js/faker": "^10.4.0"