stonyx 0.2.3-alpha.5 → 0.2.3-alpha.50

package/dist/cli/test-setup.js

@@ -0,0 +1,30 @@
+import { createRequire } from 'module';
+import { importConfig } from '../util/import-config.js';
+const cwd = process.cwd();
+const { default: Stonyx } = await import('stonyx');
+const config = await importConfig(`${cwd}/config/environment`);
+new Stonyx(config, cwd);
+// Drain the event loop once qunit finishes. Modules loaded by Stonyx
+// (e.g. @stonyx/rest-server) may keep listeners/servers open that would
+// otherwise block the process from exiting, causing CI to hit timeouts
+// even though all tests passed.
+//
+// qunit's CLI bin does `delete require.cache[qunitPath]` and re-requires
+// qunit before running, so any qunit instance we grab synchronously from
+// this --import setup is a DIFFERENT object than the one qunit's CLI
+// actually uses. We defer the hook registration with setImmediate so it
+// runs AFTER the qunit bin has populated require.cache with its own
+// instance; grabbing qunit via CJS require at that point returns the
+// instance the tests are running on.
+//
+// See: https://github.com/abofs/stonyx/issues/55
+const require = createRequire(import.meta.url);
+setImmediate(() => {
+    const qunitPath = require.resolve('qunit', {
+        paths: [`${cwd}/node_modules`, cwd]
+    });
+    const QUnit = require(qunitPath);
+    QUnit.on('runEnd', () => {
+        setImmediate(() => process.exit(process.exitCode ?? 0));
+    });
+});

package/dist/cli/test.d.ts

@@ -0,0 +1,4 @@
+export declare const DEFAULT_TEST_GLOB = "test/**/*-test.{js,ts}";
+export default function test({ args }: {
+    args: string[];
+}): Promise<void>;

package/dist/cli/test.js

@@ -0,0 +1,23 @@
+import { spawn } from 'child_process';
+import { fileURLToPath, pathToFileURL } from 'url';
+import path from 'path';
+export const DEFAULT_TEST_GLOB = 'test/**/*-test.{js,ts}';
+export default async function test({ args }) {
+    const cwd = process.cwd();
+    const setupFile = path.resolve(path.dirname(fileURLToPath(import.meta.url)), 'test-setup.js');
+    const setupFileUrl = pathToFileURL(setupFile).href;
+    const qunitBin = path.resolve(cwd, 'node_modules/qunit/bin/qunit.js');
+    const testArgs = args.length > 0 ? args : [DEFAULT_TEST_GLOB];
+    const child = spawn(process.execPath, [
+        '--import', setupFileUrl,
+        qunitBin,
+        ...testArgs
+    ], {
+        cwd,
+        stdio: 'inherit',
+        env: { ...process.env, NODE_ENV: 'test' }
+    });
+    child.on('close', (code) => {
+        process.exit(code ?? 1);
+    });
+}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,53 @@
+#!/usr/bin/env node
+import serve from './cli/serve.js';
+import test from './cli/test.js';
+import help from './cli/help.js';
+import newCommand from './cli/new.js';
+import loadModuleCommands from './cli/load-commands.js';
+import { importConfig } from './util/import-config.js';
+try {
+    process.loadEnvFile();
+}
+catch { /* no .env file */ }
+const aliases = { s: 'serve', t: 'test', h: 'help', n: 'new' };
+const builtInCommands = {
+    serve: { description: 'Bootstrap Stonyx and run the app', run: serve },
+    test: { description: 'Bootstrap Stonyx in test mode and run tests', run: test },
+    new: { description: 'Scaffold a new Stonyx project', run: newCommand },
+    help: { description: 'Show available commands', run: help }
+};
+const args = process.argv.slice(2);
+const commandName = aliases[args[0]] || args[0];
+const commandArgs = args.slice(1);
+async function main() {
+    if (!commandName || commandName === 'help') {
+        await help({ args: commandArgs, builtInCommands, loadModuleCommands });
+        return;
+    }
+    const builtIn = builtInCommands[commandName];
+    if (builtIn) {
+        await builtIn.run({ args: commandArgs });
+        return;
+    }
+    // Search module commands
+    const moduleCommands = await loadModuleCommands();
+    const moduleCommand = moduleCommands[commandName];
+    if (moduleCommand) {
+        const cwd = process.cwd();
+        if (moduleCommand.bootstrap) {
+            const config = await importConfig(`${cwd}/config/environment`);
+            const { default: Stonyx } = await import('./main.js');
+            new Stonyx(config, cwd);
+            await Stonyx.ready;
+        }
+        await moduleCommand.run({ args: commandArgs, cwd });
+        return;
+    }
+    console.error(`Unknown command: ${args[0]}\n`);
+    await help({ args: [], builtInCommands, loadModuleCommands });
+    process.exit(1);
+}
+main().catch(error => {
+    console.error(error);
+    process.exit(1);
+});

package/dist/exports/config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("stonyx").StoynxConfig;
+export default _default;

package/dist/exports/config.js

@@ -0,0 +1,2 @@
+import Stonyx from 'stonyx';
+export default Stonyx.config;

package/dist/exports/log.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@stonyx/logs").default;
+export default _default;

package/{src → dist}/exports/log.js

@@ -1,3 +1,2 @@
 import Stonyx from 'stonyx';
-
-export default Stonyx.log;
+export default Stonyx.log;

package/dist/exports/test-helpers.d.ts

@@ -0,0 +1,5 @@
+interface TestHooks {
+    before(fn: () => Promise<void>): void;
+}
+export declare function setupIntegrationTests(hooks: TestHooks): void;
+export {};

package/dist/exports/test-helpers.js

@@ -0,0 +1,7 @@
+import Stonyx from 'stonyx';
+export function setupIntegrationTests(hooks) {
+    hooks.before(async function () {
+        await Stonyx.ready;
+        console.log('Stonyx ready');
+    });
+}

package/dist/lifecycle.d.ts

@@ -0,0 +1,7 @@
+export interface StoynxModule {
+    init?(): Promise<void>;
+    startup?(): Promise<void>;
+    shutdown?(): Promise<void>;
+}
+export declare function runStartupHooks(modules: StoynxModule[]): Promise<void>;
+export declare function runShutdownHooks(modules: StoynxModule[]): Promise<void>;

package/dist/lifecycle.js

@@ -0,0 +1,18 @@
+export async function runStartupHooks(modules) {
+    for (const module of modules) {
+        if (typeof module.startup === 'function')
+            await module.startup();
+    }
+}
+export async function runShutdownHooks(modules) {
+    for (const module of [...modules].reverse()) {
+        if (typeof module.shutdown === 'function') {
+            try {
+                await module.shutdown();
+            }
+            catch (error) {
+                console.error('Error during module shutdown:', error);
+            }
+        }
+    }
+}

package/dist/main.d.ts

@@ -0,0 +1,22 @@
+import Chronicle from '@stonyx/logs';
+import type { StoynxModule } from './lifecycle.js';
+import type { StoynxConfig } from './modules.js';
+export default class Stonyx {
+    static initialized: boolean;
+    static modulePromises: Record<string, unknown>;
+    static instance: Stonyx;
+    static ready: Promise<void>;
+    config: StoynxConfig;
+    chronicle: Chronicle;
+    modules: StoynxModule[];
+    constructor(config: StoynxConfig, rootPath: string);
+    start(config: StoynxConfig, rootPath: string): Promise<void>;
+    /**
+     * Allows users to define their own log for any extra class via environment config
+     */
+    configureUserLogs(): void;
+    static get log(): Chronicle;
+    static get config(): StoynxConfig;
+}
+export { waitForModule } from './modules.js';
+export type { StoynxConfig } from './modules.js';

package/dist/main.js

@@ -0,0 +1,102 @@
+/*
+ * Copyright 2025 Stone Costa
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import Chronicle from '@stonyx/logs';
+import loadModules from './modules.js';
+import { mergeObject } from '@stonyx/utils/object';
+import { importConfig, CONFIG_NOT_FOUND_PREFIX } from './util/import-config.js';
+import { resolveModuleName } from './util/resolve-module-name.js';
+export default class Stonyx {
+    static initialized = false;
+    static modulePromises = {};
+    static instance;
+    static ready;
+    config;
+    chronicle;
+    modules;
+    constructor(config, rootPath) {
+        if (Stonyx.instance)
+            return Stonyx.instance;
+        Stonyx.instance = this;
+        Stonyx.ready = this.start(config, rootPath);
+    }
+    async start(config, rootPath) {
+        if (!config)
+            throw new Error('Stonyx requires full environment configuration on startup');
+        if (!rootPath)
+            throw new Error('Stonyx requires root project\'s path on startup');
+        // Transform config from stonyx-modules running as a standalone.
+        // Signal is the consumer's `package.json#name` (see resolveModuleName);
+        // this replaces the brittle `rootPath.includes('stonyx-')` heuristic so
+        // non-canonical rootPaths (worktrees, forks, renames) still work.
+        const moduleName = resolveModuleName(rootPath);
+        if (moduleName) {
+            const flatConfig = config;
+            const siblingModules = flatConfig.modules || {};
+            config = { [moduleName]: config, ...siblingModules };
+            delete config.modules;
+        }
+        this.config = config;
+        this.chronicle = new Chronicle({ additionalLogs: { title: 'green' } });
+        Stonyx.initialized = true;
+        // Auto-merge test environment overrides (after initialized flag, before modules load)
+        // Uses in-place mutation to preserve existing references (e.g. stonyx/config export cache)
+        if (process.env.NODE_ENV === 'test') {
+            try {
+                const testOverrides = await importConfig(`${rootPath}/test/config/environment`);
+                const merged = mergeObject(config, testOverrides);
+                Object.assign(config, merged);
+            }
+            catch (err) {
+                // A test override that is genuinely ABSENT is non-fatal. Everything else
+                // re-throws — including `CONFIG_NOT_LOADABLE_PREFIX`, which is the whole
+                // point of that prefix existing (abofs/stonyx#105, invariant I2). A
+                // config the consumer wrote and this loader declined must never reach
+                // the caller as "you have no test overrides".
+                if (!(err instanceof Error) || !err.message.startsWith(CONFIG_NOT_FOUND_PREFIX))
+                    throw err;
+            }
+        }
+        this.modules = await loadModules(config, rootPath, this.chronicle);
+        this.configureUserLogs();
+    }
+    /**
+     * Allows users to define their own log for any extra class via environment config
+     */
+    configureUserLogs() {
+        const { chronicle } = this;
+        for (const [className, config] of Object.entries(this.config)) {
+            if (!config || typeof config !== 'object')
+                continue;
+            if (className in chronicle)
+                continue;
+            const { logColor, logMethod, logTimestamp } = config;
+            if (!logColor)
+                continue;
+            chronicle.defineType(logMethod || className, logColor, { logTimestamp: !!logTimestamp });
+        }
+    }
+    static get log() {
+        if (!Stonyx.initialized)
+            throw new Error('Stonyx has not been initialized yet');
+        return Stonyx.instance.chronicle;
+    }
+    static get config() {
+        if (!Stonyx.initialized)
+            throw new Error('Stonyx has not been initialized yet');
+        return Stonyx.instance.config;
+    }
+}
+export { waitForModule } from './modules.js';

package/dist/modules.d.ts

@@ -0,0 +1,5 @@
+import type { StoynxModule } from './lifecycle.js';
+import type Chronicle from '@stonyx/logs';
+export type StoynxConfig = Record<string, Record<string, unknown> | unknown>;
+export default function loadModules(config: StoynxConfig, rootPath: string, chronicle: Chronicle): Promise<StoynxModule[]>;
+export declare function waitForModule(moduleName: string): Promise<void>;

package/dist/modules.js

@@ -0,0 +1,93 @@
+/**
+ * Validates and initializes stonyx modules
+ * TODO: Refactor into a ModuleLoader class (good coding exercise)
+ */
+import { readFile } from '@stonyx/utils/file';
+import { kebabCaseToCamelCase } from '@stonyx/utils/string';
+import { mergeObject } from '@stonyx/utils/object';
+import { importConfig } from './util/import-config.js';
+const modulePromises = {};
+// Configure module-specific logging
+function configureLog(chronicle, module, config) {
+    const { logColor, logMethod, logTimestamp } = config;
+    if (!logColor)
+        return;
+    chronicle.defineType(logMethod || module, logColor, { logTimestamp: !!logTimestamp });
+}
+function initializeModule(moduleName, moduleClass, modules, initPromises) {
+    const moduleInstance = new moduleClass();
+    modules.push(moduleInstance);
+    if (!moduleInstance.init)
+        return;
+    initPromises.push((async () => {
+        await moduleInstance.init();
+        modulePromises[moduleName]?.resolve();
+    })());
+}
+export default async function loadModules(config, rootPath, chronicle) {
+    const modules = [];
+    const initPromises = [];
+    const rootPackage = await readFile(`${rootPath}/package.json`, { json: true });
+    const dependencies = (rootPackage.devDependencies || {});
+    const projectName = typeof rootPackage.name === 'string' ? rootPackage.name : '';
+    // Expose rootPath to public configuration
+    config.rootPath = rootPath;
+    const moduleDependencies = Object.keys(dependencies).filter((moduleName) => moduleName.startsWith('@stonyx/'));
+    // Setup module promises prior to initialization
+    for (const moduleName of moduleDependencies) {
+        const promise = {};
+        modulePromises[moduleName] = promise;
+        promise.ready = new Promise(resolve => promise.resolve = resolve);
+    }
+    // Standalone module configuration
+    if (Array.isArray(rootPackage.keywords) && rootPackage.keywords.includes('stonyx-module')) {
+        configureLog(chronicle, projectName, config);
+        const entryPoint = typeof rootPackage.main === 'string' ? rootPackage.main : '';
+        const { default: moduleClass } = await import(`${rootPath}/${entryPoint}`);
+        initializeModule(projectName, moduleClass, modules, initPromises);
+    }
+    for (const moduleName of moduleDependencies) {
+        const modulePackage = await readFile(`${rootPath}/node_modules/${moduleName}/package.json`, { json: true, missingFileCallback: (_filePath) => {
+                console.warn(`Warning: Could not locate stonyx module: "${moduleName}". Module was not loaded`);
+                return '';
+            } });
+        if (!modulePackage)
+            continue;
+        const keywords = Array.isArray(modulePackage.keywords) ? modulePackage.keywords : [];
+        if (!keywords.includes('stonyx-module')) {
+            console.warn(`Warning: Stonyx modules must contain the "stonyx-module" keyword. Module was not loaded`);
+            continue;
+        }
+        if (!keywords.includes('stonyx-async')) {
+            modulePromises[moduleName].resolve();
+            continue;
+        }
+        try {
+            // Load & Configure Async Modules
+            const moduleConfig = await importConfig(`${rootPath}/node_modules/${moduleName}/config/environment`);
+            const module = kebabCaseToCamelCase(moduleName.split('/').pop() ?? moduleName);
+            const userConfig = config[module] || {};
+            const finalConfig = mergeObject(moduleConfig, userConfig);
+            config[module] = finalConfig;
+            // Configure module-specific logging
+            configureLog(chronicle, module, finalConfig);
+            const entryPoint = modulePackage.main;
+            const { default: moduleClass } = await import(`${rootPath}/node_modules/${moduleName}/${entryPoint}`);
+            initializeModule(moduleName, moduleClass, modules, initPromises);
+        }
+        catch (error) {
+            console.error(error);
+            throw new Error(`Stonyx modules with async loading must have a config/environment.js file with default configurations. Module "${moduleName}" failed to load.`);
+        }
+    }
+    // Wait until all modules are initialized
+    await Promise.all(initPromises);
+    return modules;
+}
+export async function waitForModule(moduleName) {
+    const fullName = `@stonyx/${moduleName}`;
+    const modulePromise = modulePromises[fullName];
+    if (!modulePromise)
+        throw new Error(`Could wait for module: ${fullName}. Module was not registered in project dependencies`);
+    await modulePromises[fullName].ready;
+}

package/dist/util/import-config.d.ts

@@ -0,0 +1,52 @@
+/**
+ * "There is no config here." Callers are allowed to treat this as benign —
+ * `src/main.ts` does, for the optional `test/config/environment.*` override.
+ *
+ * `main.ts` matches on this exact string, so it is exported rather than
+ * duplicated: the swallow and the thrower must not be able to drift apart.
+ */
+export declare const CONFIG_NOT_FOUND_PREFIX = "Config not found:";
+/**
+ * "There is a config here and I declined to load it." Deliberately NOT prefixed
+ * with `CONFIG_NOT_FOUND_PREFIX`, because `main.ts`'s `NODE_ENV=test` catch
+ * swallows that prefix and must not swallow this.
+ *
+ * This is invariant I2 of the Sprint 93 install-and-boot cluster — "no silent
+ * decline". Before #105 the two states were literally indistinguishable:
+ * measured against `stonyx@0.2.3-beta.95`, a consumer with `config/environment.ts`
+ * and the same consumer after `mv config/environment.js config/environment.xyz`
+ * both produced the byte-identical `Config not found: .../config/environment.js`.
+ */
+export declare const CONFIG_NOT_LOADABLE_PREFIX = "Config present but not loadable:";
+/**
+ * Did this runtime refuse OUR config file, or something our config imported?
+ *
+ * `FILE_TYPE_REFUSAL_CODES.has(code)` alone cannot tell. A config that loaded
+ * and ran perfectly well, but whose own nested `import()` hit a `.ts` under
+ * `node_modules`, throws the SAME code — and was reported as "this Node runtime
+ * refused to load your config", naming a file that is fine. That misdirection
+ * points the consumer at the one file that is not the problem, and the likeliest
+ * instance of it is the exact `.ts`-under-node_modules case this loader's own
+ * docs tell people to look for.
+ *
+ * FAIL DIRECTION — this is the property, not an implementation detail.
+ * `true` means "re-frame this as a refusal of the config", which is exactly the
+ * F-3 misdirection above. So when no path can be extracted this returns
+ * `false`, and the caller rethrows Node's own error untouched, `cause` and all.
+ * The consumer then reads what actually happened instead of a friendly sentence
+ * about the wrong file. This is what makes every future gap in the two patterns
+ * harmless: an unparseable message costs the I2 re-framing, not correctness.
+ *
+ * It previously returned `true` here, on the reasoning that keeping the loud
+ * re-frame mattered more than getting the filename right. Measured, that is
+ * backwards: the raw error is loud too — `main.ts`'s `NODE_ENV=test` swallow
+ * only absorbs `CONFIG_NOT_FOUND_PREFIX`, which a Node refusal never starts
+ * with — so failing this way loses nothing and stops naming the wrong file.
+ *
+ * Exported ONLY so its branches can be reached directly. Driving it through
+ * `importConfig` reaches the two path-comparison outcomes and nothing else.
+ * A predicate inside the guard that makes failures loud does not get to have
+ * branches no test can reach.
+ */
+export declare function refusalIsAboutTheConfig(message: string, configPath: string): boolean;
+export declare function importConfig<T = unknown>(basePath: string): Promise<T>;