stonyx 0.2.2 → 0.2.3-alpha.1

package/docs/developing-modules.md

@@ -0,0 +1,108 @@
+# 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

@@ -0,0 +1,15 @@
+# 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

@@ -0,0 +1,47 @@
+# 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

@@ -0,0 +1,52 @@
+# 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

@@ -0,0 +1,78 @@
+# 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

@@ -0,0 +1,64 @@
+# 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/package.json

@@ -1,19 +1,26 @@
 {
   "name": "stonyx",
-  "version": "0.2.2",
+  "version": "0.2.3-alpha.1",
   "description": "Base stonyx framework module",
   "main": "main.js",
   "type": "module",
+  "bin": {
+    "stonyx": "./src/cli.js"
+  },
   "exports": {
     ".": "./src/main.js",
     "./config": "./src/exports/config.js",
     "./log": "./src/exports/log.js",
-    "./test-helpers": "./src/exports/test-helpers.js"
+    "./test-helpers": "./src/exports/test-helpers.js",
+    "./lifecycle": "./src/lifecycle.js"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/abofs/stonyx.git"
   },
+  "publishConfig": {
+    "provenance": true
+  },
   "author": "Stone Costa",
   "license": "Apache-2.0",
   "contributors": [
@@ -26,7 +33,7 @@
     "node-chronicle": "^0.2.0"
   },
   "devDependencies": {
-    "@stonyx/utils": "^0.2.2",
+    "@stonyx/utils": "0.2.3-beta.5",
     "qunit": "^2.24.1",
     "sinon": "^21.0.0"
   },

package/scripts/postinstall.js

@@ -2,7 +2,6 @@ import { copyFile, createDirectory } from '@stonyx/utils/file';
 
 const projectDir = process.env.INIT_CWD;
 const configDir = `${projectDir}/config`;
-const bootstrapFile = 'stonyx-bootstrap.cjs';
 const envFile = 'environment.js';
 
 createDirectory(configDir);
@@ -10,7 +9,3 @@ createDirectory(configDir);
 copyFile(`./config/environment copy.js`, `${configDir}/${envFile}`).then(result => {
   if (result) console.log(`Stonyx: ${envFile} has been successfully created. Please see README.md for more information.`);
 });
-
-copyFile(`./src/bootstrap.cjs`, `${projectDir}/${bootstrapFile}`).then(result => {
-  if (result) console.log(`Stonyx: ${bootstrapFile} has been successfully created. Please see README.md for more information.`);
-});

package/src/cli/help.js

@@ -0,0 +1,48 @@
+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, n=new, h=help\n');
+
+  console.log('Project conventions:\n');
+  console.log('  Entry point:       app.js');
+  console.log('  Config:            config/environment.js');
+  console.log('  DB schema:         config/db-schema.js');
+  console.log('  Models:            models/');
+  console.log('  Serializers:       serializers/');
+  console.log('  Access control:    access/');
+  console.log('  Transforms:        transforms/');
+  console.log('  Hooks:             hooks/');
+  console.log('  REST requests:     requests/');
+  console.log('  Cron jobs:         crons/');
+  console.log('  Tests:             test/{unit,integration,acceptance}/');
+  console.log('');
+  console.log('  Logging:           import log from \'stonyx/log\' (never console.log)');
+  console.log('  Utilities:         import from \'@stonyx/utils/*\' (never raw fs)');
+  console.log('  Lint config:       import from \'@abofs/code-conventions\'');
+  console.log('  Package manager:   pnpm');
+  console.log('');
+}

package/src/cli/load-commands.js

@@ -0,0 +1,56 @@
+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;
+}