stonyx 0.2.3-beta.6 → 0.2.3-beta.60

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,94 @@
+/*
+ * 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 { kebabCaseToCamelCase } from '@stonyx/utils/string';
+import { mergeObject } from '@stonyx/utils/object';
+import { importConfig } from './util/import-config.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
+        if (rootPath.includes('stonyx-')) {
+            const dirName = rootPath.split('/').pop() ?? '';
+            const moduleName = kebabCaseToCamelCase(dirName.replace('stonyx-', ''));
+            config = { [moduleName]: config, ...(config.modules || {}) };
+            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) {
+                // Missing test override is non-fatal; re-throw import errors that aren't "not found"
+                if (!(err instanceof Error) || !err.message.startsWith('Config not found:'))
+                    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.{ts,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 @@
+export declare function importConfig<T = unknown>(basePath: string): Promise<T>;

package/dist/util/import-config.js

@@ -0,0 +1,15 @@
+import { existsSync } from 'fs';
+import { pathToFileURL } from 'url';
+const EXTENSIONS = ['ts', 'js'];
+export async function importConfig(basePath) {
+    const matches = EXTENSIONS.filter(ext => existsSync(`${basePath}.${ext}`));
+    if (matches.length === 0) {
+        throw new Error(`Config not found: ${basePath}.{ts,js}`);
+    }
+    if (matches.length > 1) {
+        console.warn(`Warning: both ${basePath}.ts and ${basePath}.js exist. Using .ts — delete the .js to silence this warning (it is likely a stale compiled artifact or postinstall stub).`);
+    }
+    const ext = matches[0];
+    const mod = await import(pathToFileURL(`${basePath}.${ext}`).href);
+    return mod.default;
+}

package/package.json

@@ -1,23 +1,45 @@
 {
   "name": "stonyx",
-  "version": "0.2.3-beta.6",
+  "version": "0.2.3-beta.60",
   "description": "Base stonyx framework module",
-  "main": "main.js",
+  "main": "dist/main.js",
+  "types": "dist/main.d.ts",
   "type": "module",
   "bin": {
-    "stonyx": "./src/cli.js"
+    "stonyx": "./dist/cli.js"
   },
   "exports": {
-    ".": "./src/main.js",
-    "./config": "./src/exports/config.js",
-    "./log": "./src/exports/log.js",
-    "./test-helpers": "./src/exports/test-helpers.js",
-    "./lifecycle": "./src/lifecycle.js"
+    ".": {
+      "types": "./dist/main.d.ts",
+      "default": "./dist/main.js"
+    },
+    "./config": {
+      "types": "./dist/exports/config.d.ts",
+      "default": "./dist/exports/config.js"
+    },
+    "./log": {
+      "types": "./dist/exports/log.d.ts",
+      "default": "./dist/exports/log.js"
+    },
+    "./test-helpers": {
+      "types": "./dist/exports/test-helpers.d.ts",
+      "default": "./dist/exports/test-helpers.js"
+    },
+    "./lifecycle": {
+      "types": "./dist/lifecycle.d.ts",
+      "default": "./dist/lifecycle.js"
+    }
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/abofs/stonyx.git"
   },
+  "files": [
+    "dist",
+    "config",
+    "scripts",
+    "README.md"
+  ],
   "publishConfig": {
     "provenance": true
   },
@@ -30,16 +52,23 @@
     "url": "https://github.com/abofs/stonyx/issues"
   },
   "dependencies": {
-    "node-chronicle": "^0.2.0"
+    "@stonyx/utils": "0.2.3-beta.23",
+    "@stonyx/logs": "1.0.1-beta.16"
   },
   "devDependencies": {
-    "@stonyx/utils": "0.2.3-beta.5",
+    "@types/node": "^25.5.2",
+    "@types/qunit": "^2.19.13",
+    "@types/sinon": "^21.0.1",
     "qunit": "^2.24.1",
-    "sinon": "^21.0.0"
+    "sinon": "^21.0.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.8.3"
   },
   "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit && tsc --noEmit -p tsconfig.test.json",
     "start": "node .",
-    "test": "qunit",
+    "test": "pnpm build && node --import tsx node_modules/qunit/bin/qunit.js 'test/**/*-test.ts'",
     "error": "echo \"Error: no error handling\" && exit 1",
     "postinstall": "node scripts/postinstall.js"
   }

package/scripts/postinstall.js

@@ -1,11 +1,37 @@
-import { copyFile, createDirectory } from '@stonyx/utils/file';
+// Skip postinstall for global installations
+const isGlobal = !process.env.INIT_CWD || process.env.npm_config_global === 'true';
+if (isGlobal) process.exit(0);
+
+const { existsSync } = await import('node:fs');
+const { copyFile, createDirectory } = await import('@stonyx/utils/file');
 
 const projectDir = process.env.INIT_CWD;
 const configDir = `${projectDir}/config`;
-const envFile = 'environment.js';
+
+// Detect consumer project type: presence of `tsconfig.json` in the consumer
+// root signals a TypeScript project (see abofs/stonyx#62). TS consumers can't
+// use the `.js` stub, so we ship both templates and copy the matching one.
+const isTypeScriptConsumer = existsSync(`${projectDir}/tsconfig.json`);
+const extension = isTypeScriptConsumer ? 'ts' : 'js';
+const envFile = `environment.${extension}`;
+const templateFile = `environment copy.${extension}`;
+
+// Skip if the consumer ships its own `config/environment copy.{ts,js}` template —
+// they manage their own bootstrap (see abofs/stonyx#54, extended in abofs/stonyx#62
+// to honor either extension).
+if (
+  existsSync(`${configDir}/environment copy.ts`) ||
+  existsSync(`${configDir}/environment copy.js`)
+) process.exit(0);
+
+// Don't overwrite an existing consumer config (either extension).
+if (
+  existsSync(`${configDir}/environment.ts`) ||
+  existsSync(`${configDir}/environment.js`)
+) process.exit(0);
 
 createDirectory(configDir);
 
-copyFile(`./config/environment copy.js`, `${configDir}/${envFile}`).then(result => {
+copyFile(`./config/${templateFile}`, `${configDir}/${envFile}`).then(result => {
   if (result) console.log(`Stonyx: ${envFile} has been successfully created. Please see README.md for more information.`);
 });

package/.github/workflows/ci.yml

@@ -1,16 +0,0 @@
-name: CI
-
-on:
-  pull_request:
-    branches: [dev, main]
-
-concurrency:
-  group: ci-${{ github.head_ref || github.ref }}
-  cancel-in-progress: true
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-    uses: abofs/stonyx-workflows/.github/workflows/ci.yml@main

package/.github/workflows/publish.yml

@@ -1,51 +0,0 @@
-name: Publish to NPM
-
-on:
-  repository_dispatch:
-    types: [cascade-publish]
-  workflow_dispatch:
-    inputs:
-      version-type:
-        description: 'Version type'
-        required: true
-        type: choice
-        options:
-          - patch
-          - minor
-          - major
-      custom-version:
-        description: 'Custom version (optional, overrides version-type)'
-        required: false
-        type: string
-  pull_request:
-    types: [opened, synchronize, reopened]
-    branches: [main]
-  push:
-    branches: [main]
-
-concurrency:
-  group: ${{ github.event_name == 'repository_dispatch' && 'cascade-update' || format('publish-{0}', github.ref) }}
-  cancel-in-progress: false
-
-permissions:
-  contents: write
-  id-token: write
-  pull-requests: write
-
-jobs:
-  publish:
-    if: "!contains(github.event.head_commit.message, '[skip ci]')"
-    uses: abofs/stonyx-workflows/.github/workflows/npm-publish.yml@main
-    with:
-      version-type: ${{ github.event.inputs.version-type }}
-      custom-version: ${{ github.event.inputs.custom-version }}
-      cascade-source: ${{ github.event.client_payload.source_package || '' }}
-    secrets: inherit
-
-  cascade:
-    needs: publish
-    uses: abofs/stonyx-workflows/.github/workflows/cascade.yml@main
-    with:
-      package-name: ${{ needs.publish.outputs.package-name }}
-      published-version: ${{ needs.publish.outputs.published-version }}
-    secrets: inherit

package/docs/api.md

@@ -1,89 +0,0 @@
-# API Reference
-
-Public exports available from the `stonyx` package.
-
-## Exports Map
-
-| Import Path | Export | Description |
-|-------------|--------|-------------|
-| `stonyx` | `default` (Stonyx class) | Main framework class (singleton) |
-| `stonyx` | `waitForModule(name)` | Wait for an async module to be ready |
-| `stonyx/config` | `default` (config object) | Live reference to Stonyx configuration |
-| `stonyx/log` | `default` (Chronicle instance) | Live reference to Chronicle logger |
-| `stonyx/lifecycle` | `runStartupHooks(modules)` | Run startup hooks on a module array |
-| `stonyx/lifecycle` | `runShutdownHooks(modules)` | Run shutdown hooks in reverse order |
-| `stonyx/test-helpers` | `setupIntegrationTests(hooks)` | QUnit hook for integration test setup |
-
-## Stonyx Class
-
-```js
-import Stonyx from 'stonyx';
-```
-
-### Constructor
-
-```js
-new Stonyx(config, rootPath)
-```
-
-- **config** — Full environment configuration object
-- **rootPath** — Absolute path to the project root
-
-Returns the existing instance if one already exists (singleton pattern).
-
-### Static Properties
-
-| Property | Type | Description |
-|----------|------|-------------|
-| `Stonyx.instance` | `Stonyx` | The singleton instance |
-| `Stonyx.ready` | `Promise` | Resolves when all modules are initialized |
-| `Stonyx.initialized` | `boolean` | Whether Stonyx has started initialization |
-
-### Static Getters
-
-| Getter | Returns | Throws |
-|--------|---------|--------|
-| `Stonyx.config` | Config object | If not initialized |
-| `Stonyx.log` | Chronicle instance | If not initialized |
-
-### Instance Properties
-
-| Property | Type | Description |
-|----------|------|-------------|
-| `instance.config` | `object` | Merged environment configuration |
-| `instance.chronicle` | `Chronicle` | Logger instance |
-| `instance.modules` | `Array` | Loaded module instances |
-
-## waitForModule
-
-```js
-import { waitForModule } from 'stonyx';
-
-await waitForModule('rest-server');
-```
-
-Waits for a specific `@stonyx/*` module to complete initialization. Pass the module name **without** the `@stonyx/` prefix.
-
-Throws if the module is not registered in project dependencies.
-
-## Lifecycle Functions
-
-```js
-import { runStartupHooks, runShutdownHooks } from 'stonyx/lifecycle';
-```
-
-### runStartupHooks(modules)
-
-Calls `startup()` on each module in array order. Skips modules without a `startup` method.
-
-### runShutdownHooks(modules)
-
-Calls `shutdown()` on each module in **reverse** array order. Errors are caught and logged — one failing hook does not prevent others from running.
-
-## setupIntegrationTests
-
-```js
-import { setupIntegrationTests } from 'stonyx/test-helpers';
-```
-
-Registers a QUnit `before` hook that waits for `Stonyx.ready`. Use within a `module()` block to ensure Stonyx is fully initialized before tests run.