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

package/docs/cli.md

@@ -1,78 +0,0 @@
-# CLI
-
-Stonyx includes a CLI that handles bootstrapping, module initialization, and application execution.
-
-## Usage
-
-```bash
-stonyx <command> [...args]
-```
-
-## Built-in Commands
-
-| Command | Alias | Description |
-|---------|-------|-------------|
-| `serve` | `s` | Bootstrap Stonyx and run the app |
-| `test` | `t` | Bootstrap Stonyx in test mode and run tests |
-| `help` | `h` | Show available commands |
-
-### serve
-
-Bootstraps Stonyx (loads config, initializes modules, runs lifecycle hooks), then imports your application entry point.
-
-```bash
-stonyx serve                    # Runs app.js by default
-stonyx serve --entry custom.js  # Runs a custom entry file
-```
-
-The serve command also registers `SIGTERM` and `SIGINT` handlers that run [shutdown hooks](lifecycle.md) before exiting.
-
-### test
-
-Runs your test suite using [QUnit](https://qunitjs.com/) with automatic Stonyx bootstrapping. Sets `NODE_ENV=test` and applies any [test config overrides](configuration.md#test-environment-overrides).
-
-```bash
-stonyx test                     # Runs test/**/*-test.js by default
-stonyx test "test/unit/**/*.js" # Custom test glob
-```
-
-### help
-
-Displays all available commands, including any [module commands](#module-commands).
-
-```bash
-stonyx help
-```
-
-## Module Commands
-
-Stonyx modules can register custom CLI commands by exporting a `./commands` entry in their `package.json`. These are automatically discovered and available through the CLI.
-
-```json
-{
-  "exports": {
-    "./commands": "./src/commands.js"
-  }
-}
-```
-
-The commands file should export an object mapping command names to definitions:
-
-```js
-export default {
-  'db:migrate': {
-    description: 'Run database migrations',
-    bootstrap: true,
-    run: async ({ args, cwd }) => { /* ... */ }
-  }
-};
-```
-
-- **`bootstrap: true`** — Stonyx will be fully initialized before the command runs
-- **`bootstrap: false`** — The command runs without Stonyx initialization
-
-Module commands appear under "Module commands" in `stonyx help` output. If two modules register the same command name, the first one loaded wins and a warning is printed.
-
-## Environment Variables
-
-The CLI automatically loads `.env` files via `process.loadEnvFile()` before executing any command.

package/docs/configuration.md

@@ -1,72 +0,0 @@
-# Configuration
-
-Stonyx uses a centralized configuration file that all modules read from at startup.
-
-## Environment Config
-
-Your project's configuration lives at `config/environment.js`:
-
-```js
-const { DEBUG, NODE_ENV } = process.env;
-
-const environment = NODE_ENV ?? 'development';
-
-export default {
-  environment,
-  debug: DEBUG ?? environment === 'development',
-
-  // Module-specific configuration
-  restServer: { logColor: 'yellow', port: 3000 },
-  cron: { log: true },
-};
-```
-
-This file is auto-generated on `npm install` via the postinstall script if it doesn't already exist.
-
-> **Note:** `config/environment.js` is gitignored by default so each environment can have its own settings.
-
-## Module Configuration
-
-Each Stonyx module reads its configuration from a top-level key matching its camelCase name. For example, `@stonyx/rest-server` reads from `config.restServer`.
-
-Async modules ship with their own default config at `config/environment.js` inside the module package. Your project config is merged on top of these defaults — you only need to specify overrides.
-
-## Logging Configuration
-
-Any config key with a `logColor` property automatically creates a [Chronicle](logging.md) log type:
-
-```js
-export default {
-  myService: {
-    logColor: 'purple',      // Required — enables log creation
-    logMethod: 'highlight',  // Optional — custom method name (defaults to key name)
-    logTimestamp: true,       // Optional — include timestamps
-  },
-};
-```
-
-This works for both module configs and custom service configs. See [Logging](logging.md) for details.
-
-## Test Environment Overrides
-
-When `NODE_ENV=test`, Stonyx automatically looks for `test/config/environment.js` in your project root:
-
-```js
-// test/config/environment.js
-export default {
-  debug: false,
-  restServer: { port: 0 },
-};
-```
-
-These overrides are deep-merged into the main config using in-place mutation, so any existing references (like `stonyx/config` exports) stay valid.
-
-## Accessing Config at Runtime
-
-```js
-import config from 'stonyx/config';
-
-console.log(config.environment); // 'development', 'test', etc.
-```
-
-The `stonyx/config` export is a live reference to the Stonyx instance config. It will throw if accessed before Stonyx is initialized.

package/docs/developing-modules.md

@@ -1,108 +0,0 @@
-# Developing Modules
-
-Guide for building custom Stonyx modules.
-
-## Package Setup
-
-Your module's `package.json` must include:
-
-```json
-{
-  "name": "@stonyx/my-module",
-  "keywords": ["stonyx-module"],
-  "main": "src/index.js"
-}
-```
-
-Add `stonyx-async` to keywords if your module requires asynchronous initialization.
-
-## Module Class
-
-Export a default class. Optionally define `init()`, `startup()`, and `shutdown()` methods:
-
-```js
-export default class MyModule {
-  // Called during module loading (async modules only)
-  async init() {
-    // Connect to services, load resources, etc.
-  }
-
-  // Called after ALL modules are initialized, before app entry runs
-  async startup() {
-    // Register routes, start listeners, etc.
-  }
-
-  // Called on SIGTERM/SIGINT, in reverse load order
-  async shutdown() {
-    // Close connections, flush data, etc.
-  }
-}
-```
-
-## Default Configuration
-
-Async modules must include `config/environment.js` with sensible defaults:
-
-```js
-export default {
-  logColor: 'cyan',
-  logMethod: 'myModule',
-  logTimestamp: true,
-  // Module-specific defaults...
-};
-```
-
-User project config is merged on top of these defaults.
-
-## Waiting for Other Modules
-
-If your module depends on another async module being ready:
-
-```js
-import { waitForModule } from 'stonyx';
-
-export default class MyModule {
-  async init() {
-    await waitForModule('rest-server');
-    // @stonyx/rest-server is now fully initialized
-  }
-}
-```
-
-Pass the module name without the `@stonyx/` prefix.
-
-## Standalone Development
-
-When running a module standalone (project path contains `stonyx-`), Stonyx auto-transforms the config structure. Your module's config is wrapped under its camelCase name:
-
-```js
-// If your module is @stonyx/rest-server and config is { port: 3000 }
-// Stonyx transforms it to: { restServer: { port: 3000 } }
-```
-
-## Custom CLI Commands
-
-Modules can register CLI commands by adding a `./commands` export:
-
-```json
-{
-  "exports": {
-    "./commands": "./src/commands.js"
-  }
-}
-```
-
-```js
-// src/commands.js
-export default {
-  'my-module:setup': {
-    description: 'Initialize module resources',
-    bootstrap: true,
-    run: async ({ args, cwd }) => {
-      // Command implementation
-    }
-  }
-};
-```
-
-Use namespaced command names (e.g., `my-module:setup`) to avoid conflicts with other modules. See [CLI](cli.md#module-commands) for details.

package/docs/index.md

@@ -1,15 +0,0 @@
-# Stonyx Documentation
-
-## Guides
-
-- [CLI](cli.md) — Commands, usage, and module-contributed commands
-- [Configuration](configuration.md) — Environment config, module config, and test overrides
-- [Modules](modules.md) — Module discovery, sync vs async, and official modules
-- [Lifecycle](lifecycle.md) — Startup/shutdown hooks and signal handling
-- [Logging](logging.md) — Color-coded logging via Chronicle
-- [Testing](testing.md) — Running tests, config overrides, and integration helpers
-- [Developing Modules](developing-modules.md) — Guide for building custom Stonyx modules
-
-## Reference
-
-- [API Reference](api.md) — Public exports and class documentation

package/docs/lifecycle.md

@@ -1,47 +0,0 @@
-# Lifecycle Hooks
-
-Stonyx modules can define `startup()` and `shutdown()` methods that run at specific points in the application lifecycle.
-
-## Startup Hooks
-
-Called sequentially (in module load order) after all modules have been initialized, right before your application entry point runs.
-
-```js
-export default class MyModule {
-  async startup() {
-    // Called after all modules are init'd, before app.js runs
-  }
-}
-```
-
-## Shutdown Hooks
-
-Called sequentially in **reverse** module load order when the process receives `SIGTERM` or `SIGINT`. Errors in one hook do not prevent other hooks from running.
-
-```js
-export default class MyModule {
-  async shutdown() {
-    // Clean up connections, flush buffers, etc.
-  }
-}
-```
-
-## Signal Handling
-
-The `stonyx serve` command registers signal handlers automatically:
-
-- **SIGTERM** — triggers shutdown hooks, then `process.exit(0)`
-- **SIGINT** — triggers shutdown hooks, then `process.exit(0)`
-
-Shutdown is idempotent — calling the handler multiple times only runs hooks once.
-
-## Using Lifecycle Hooks Directly
-
-For advanced use cases, the lifecycle functions are available as a public export:
-
-```js
-import { runStartupHooks, runShutdownHooks } from 'stonyx/lifecycle';
-
-await runStartupHooks(modules);   // Calls startup() on each module in order
-await runShutdownHooks(modules);  // Calls shutdown() on each module in reverse order
-```

package/docs/logging.md

@@ -1,52 +0,0 @@
-# Logging
-
-Stonyx provides centralized, color-coded logging via [Chronicle](https://github.com/abofs/chronicle).
-
-## Overview
-
-Every Stonyx instance creates a Chronicle logger with a default `title` log type (green). Modules and user services can register additional log types with custom colors.
-
-## Module Logs
-
-Modules that specify `logColor` in their configuration automatically get a Chronicle log type:
-
-```js
-// config/environment.js
-export default {
-  restServer: {
-    logColor: 'yellow',
-    logMethod: 'api',        // Optional — defaults to the config key name
-    logTimestamp: true,       // Optional — adds timestamps to log output
-  },
-};
-```
-
-This creates a `chronicle.api()` method that outputs in yellow with timestamps.
-
-## Custom Logs
-
-You can define logs for any class or service in your project — not just Stonyx modules:
-
-```js
-export default {
-  myWorker: {
-    logColor: 'cyan',
-    logMethod: 'worker',
-    logTimestamp: true,
-  },
-};
-```
-
-Any top-level config key with a `logColor` property will have a log type created automatically.
-
-## Accessing the Logger
-
-```js
-import log from 'stonyx/log';
-
-log.title('Application started');
-log.api('Request received');       // If restServer config defines logMethod: 'api'
-log.worker('Processing job');      // If myWorker config defines logMethod: 'worker'
-```
-
-The `stonyx/log` export is a live reference to the Chronicle instance. It will throw if accessed before Stonyx is initialized.

package/docs/modules.md

@@ -1,78 +0,0 @@
-# Module System
-
-Stonyx uses a plug-and-play module architecture. Modules are automatically detected, loaded, and initialized at startup.
-
-## How Modules Are Discovered
-
-Stonyx scans your project's `devDependencies` for packages prefixed with `@stonyx/`. Each matching package must include the `stonyx-module` keyword in its `package.json` to be loaded.
-
-```json
-{
-  "name": "@stonyx/my-module",
-  "keywords": ["stonyx-module"],
-  "main": "src/index.js"
-}
-```
-
-## Sync vs Async Modules
-
-### Sync Modules
-
-Modules with only the `stonyx-module` keyword are treated as synchronous. They are instantiated but their promise resolves immediately — no init phase is awaited.
-
-### Async Modules
-
-Modules that also include the `stonyx-async` keyword require initialization before they're ready:
-
-```json
-{
-  "keywords": ["stonyx-module", "stonyx-async"]
-}
-```
-
-Async modules **must** include a `config/environment.js` with default configuration. This is merged with the user's project config before initialization.
-
-Async modules can define an `init()` method that Stonyx awaits:
-
-```js
-export default class MyModule {
-  async init() {
-    // Connect to database, start server, etc.
-  }
-}
-```
-
-All module `init()` calls run concurrently via `Promise.all`.
-
-## Module Lifecycle
-
-1. **Discovery** — scan `devDependencies` for `@stonyx/*` packages
-2. **Validation** — verify `stonyx-module` keyword exists
-3. **Config merge** — async module defaults merged with user config
-4. **Log setup** — module-specific Chronicle log created if `logColor` is set
-5. **Instantiation** — module class is `new`'d
-6. **Initialization** — `init()` called (async modules only)
-7. **Startup hooks** — `startup()` called after all modules init (see [Lifecycle](lifecycle.md))
-8. **Shutdown hooks** — `shutdown()` called on process exit (see [Lifecycle](lifecycle.md))
-
-## waitForModule
-
-For submodule developers who need to ensure another async module is ready:
-
-```js
-import { waitForModule } from 'stonyx';
-
-await waitForModule('rest-server'); // Waits for @stonyx/rest-server
-```
-
-> **Note:** `waitForModule` is only needed during submodule development or testing. End-user applications don't need it — the CLI ensures all modules are initialized before running your app.
-
-## Official Modules
-
-| Module | Description |
-|--------|-------------|
-| [@stonyx/cron](https://github.com/abofs/stonyx-cron) | Lightweight async job scheduling with min-heap |
-| [@stonyx/rest-server](https://github.com/abofs/stonyx-rest-server) | Dynamic REST server with auto-route registration |
-| [@stonyx/orm](https://github.com/abofs/stonyx-orm) | ORM with models, relationships, serializers, and optional REST integration |
-
-See each module's repository for its specific documentation.

package/docs/testing.md

@@ -1,64 +0,0 @@
-# Testing
-
-Stonyx includes built-in test infrastructure using [QUnit](https://qunitjs.com/).
-
-## Running Tests
-
-```bash
-stonyx test                     # Runs test/**/*-test.js by default
-stonyx test "test/unit/**/*.js" # Custom glob pattern
-```
-
-The test command:
-1. Sets `NODE_ENV=test`
-2. Bootstraps Stonyx via a `--require` setup file
-3. Applies [test config overrides](configuration.md#test-environment-overrides)
-4. Runs QUnit with the specified glob
-
-## Test Config Overrides
-
-Create `test/config/environment.js` to override configuration during tests:
-
-```js
-export default {
-  debug: false,
-  restServer: { port: 0 },
-};
-```
-
-These are deep-merged into the main config. See [Configuration](configuration.md#test-environment-overrides).
-
-## Integration Test Helper
-
-For tests that need Stonyx fully initialized (e.g., testing modules with database connections):
-
-```js
-import { setupIntegrationTests } from 'stonyx/test-helpers';
-
-const { module, test } = QUnit;
-
-module('My Integration Test', function(hooks) {
-  setupIntegrationTests(hooks);
-
-  test('can access modules', function(assert) {
-    // Stonyx is fully initialized here
-    assert.ok(true);
-  });
-});
-```
-
-`setupIntegrationTests` adds a `before` hook that waits for `Stonyx.ready` to resolve.
-
-## Test File Convention
-
-Place tests under `test/` with the `-test.js` suffix:
-
-```
-test/
-  unit/
-    my-feature-test.js
-    cli/
-      serve-test.js
-  integration/
-    api-test.js
-```

package/src/cli/help.js

@@ -1,29 +0,0 @@
-export default async function help({ args, builtInCommands, loadModuleCommands } = {}) {
-  console.log('\nUsage: stonyx <command> [...args]\n');
-  console.log('Commands:\n');
-
-  if (builtInCommands) {
-    for (const [name, { description }] of Object.entries(builtInCommands)) {
-      console.log(`  ${name.padEnd(20)} ${description}`);
-    }
-  }
-
-  if (loadModuleCommands) {
-    try {
-      const moduleCommands = await loadModuleCommands();
-      const entries = Object.entries(moduleCommands);
-
-      if (entries.length) {
-        console.log('\nModule commands:\n');
-
-        for (const [name, { description }] of entries) {
-          console.log(`  ${name.padEnd(20)} ${description}`);
-        }
-      }
-    } catch {
-      // Module commands not available (e.g., no project context)
-    }
-  }
-
-  console.log('\nAliases: s=serve, t=test, h=help\n');
-}

package/src/cli/load-commands.js

@@ -1,56 +0,0 @@
-import { readFile } from 'fs/promises';
-import path from 'path';
-
-export default async function loadModuleCommands() {
-  const cwd = process.cwd();
-  const commands = {};
-
-  let projectPackage;
-
-  try {
-    const raw = await readFile(path.join(cwd, 'package.json'), 'utf8');
-    projectPackage = JSON.parse(raw);
-  } catch {
-    return commands;
-  }
-
-  const allDeps = {
-    ...projectPackage.dependencies,
-    ...projectPackage.devDependencies
-  };
-
-  const stonyxModules = Object.keys(allDeps).filter(name => name.startsWith('@stonyx/'));
-
-  for (const moduleName of stonyxModules) {
-    let modulePackage;
-
-    try {
-      const raw = await readFile(path.join(cwd, 'node_modules', moduleName, 'package.json'), 'utf8');
-      modulePackage = JSON.parse(raw);
-    } catch {
-      continue;
-    }
-
-    const { exports: moduleExports } = modulePackage;
-
-    if (!moduleExports || !moduleExports['./commands']) continue;
-
-    try {
-      const commandsModule = await import(path.join(cwd, 'node_modules', moduleName, moduleExports['./commands']));
-      const moduleCommands = commandsModule.default;
-
-      for (const [name, command] of Object.entries(moduleCommands)) {
-        if (commands[name]) {
-          console.warn(`Warning: Command "${name}" from ${moduleName} conflicts with existing command. Skipping.`);
-          continue;
-        }
-
-        commands[name] = { ...command, module: moduleName };
-      }
-    } catch {
-      continue;
-    }
-  }
-
-  return commands;
-}

package/src/cli/serve.js

@@ -1,38 +0,0 @@
-import { runStartupHooks, runShutdownHooks } from '../lifecycle.js';
-
-export function createShutdownHandler(modules) {
-  let shuttingDown = false;
-  return async () => {
-    if (shuttingDown) return;
-    shuttingDown = true;
-
-    await runShutdownHooks(modules);
-    process.exit(0);
-  };
-}
-
-export default async function serve({ args }) {
-  const cwd = process.cwd();
-  const entryFlag = args.indexOf('--entry');
-  const entryPoint = entryFlag !== -1 ? args[entryFlag + 1] : 'app.js';
-
-  const { default: config } = await import(`${cwd}/config/environment.js`);
-  const { default: Stonyx } = await import('../main.js');
-
-  new Stonyx(config, cwd);
-  await Stonyx.ready;
-
-  const { modules } = Stonyx.instance;
-  await runStartupHooks(modules);
-
-  const shutdown = createShutdownHandler(modules);
-
-  process.on('SIGTERM', shutdown);
-  process.on('SIGINT', shutdown);
-
-  const entryModule = await import(`${cwd}/${entryPoint}`);
-
-  if (entryModule.default) {
-    new entryModule.default();
-  }
-}

package/src/cli/test-setup.js

@@ -1,8 +0,0 @@
-import { pathToFileURL } from 'url';
-
-const cwd = process.cwd();
-
-const { default: Stonyx } = await import('stonyx');
-const { default: config } = await import(pathToFileURL(`${cwd}/config/environment.js`));
-
-new Stonyx(config, cwd);

package/src/cli/test.js

@@ -1,27 +0,0 @@
-import { spawn } from 'child_process';
-import { fileURLToPath, pathToFileURL } from 'url';
-import path from 'path';
-
-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');
-
-  // Default to conventional test glob if no args provided
-  const testArgs = args.length > 0 ? args : ['test/**/*-test.js'];
-
-  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);
-  });
-}