stonyx 0.2.2 → 0.2.3-alpha.1

package/.claude/index.md

@@ -0,0 +1,94 @@
+# Stonyx CLI Guide
+
+## Installation
+
+Stonyx is the core framework package. The CLI is provided by the `stonyx` binary defined in `package.json`.
+
+In a project that depends on `stonyx`:
+
+```bash
+pnpm add -D stonyx
+```
+
+The CLI is then available as `npx stonyx` or via pnpm scripts.
+
+## Commands
+
+### `stonyx serve` (alias: `s`)
+
+Bootstrap Stonyx and run the application.
+
+```bash
+stonyx serve              # loads app.js by default
+stonyx serve --entry custom.js  # custom entry point
+```
+
+Behavior:
+1. Loads `.env` file
+2. Imports `config/environment.js`
+3. Initializes Stonyx with all detected `@stonyx/*` modules
+4. Runs startup lifecycle hooks
+5. Imports and instantiates the entry point class
+6. Registers SIGTERM/SIGINT handlers for graceful shutdown
+
+### `stonyx test` (alias: `t`)
+
+Bootstrap Stonyx in test mode and run QUnit tests.
+
+```bash
+stonyx test                          # runs test/**/*-test.js
+stonyx test test/unit/foo-test.js    # specific file
+stonyx test "test/integration/**/*-test.js"  # glob pattern
+```
+
+Sets `NODE_ENV=test` and auto-loads test setup which merges `test/config/environment.js` overrides.
+
+### `stonyx help` (alias: `h`)
+
+Show available commands including built-in and module-provided commands.
+
+```bash
+stonyx help
+stonyx --help
+stonyx -h
+```
+
+### `stonyx new <app-name>`
+
+Scaffold a new Stonyx project with interactive module selection.
+
+```bash
+stonyx new my-backend
+```
+
+Prompts for:
+- Package name
+- Which `@stonyx/*` modules to include (REST server, WebSockets, ORM, cron, OAuth, events)
+
+Creates:
+- `package.json` with selected dependencies
+- `app.js` entry point
+- `config/environment.js` and `config/environment.example.js`
+- Module-specific directories (`models/`, `requests/`, `crons/`, etc.)
+- `test/` structure with `unit/`, `integration/`, `acceptance/`
+- `.gitignore` and `.nvmrc`
+- Runs `pnpm install`
+
+## Module Command System
+
+Stonyx modules can register CLI commands by exporting a `./commands` entry in their `package.json` exports map. The CLI auto-discovers these from installed `@stonyx/*` packages.
+
+Module commands appear under "Module commands" in `stonyx help` output. They can optionally request Stonyx bootstrap before running (via `bootstrap: true`).
+
+## Creating a Stonyx Project Manually
+
+If not using `stonyx new`:
+
+1. Create project directory
+2. Add `.nvmrc` with current LTS Node version
+3. `pnpm init` and set `"type": "module"`
+4. `pnpm add -D stonyx` plus desired `@stonyx/*` modules
+5. Create `config/environment.js` with module config
+6. Create `app.js` entry point class
+7. Create standard directories per selected modules
+8. Add `@abofs/code-conventions` for linting

package/.github/workflows/ci.yml

@@ -2,35 +2,15 @@ name: CI
 
 on:
   pull_request:
-    branches:
-      - dev
-      - main
+    branches: [dev, main]
 
 concurrency:
   group: ci-${{ github.head_ref || github.ref }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+
 jobs:
   test:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: 9
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: 22.18.0
-          cache: 'pnpm'
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-
-      - name: Run tests
-        run: pnpm test
+    uses: abofs/stonyx-workflows/.github/workflows/ci.yml@main

package/.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+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/README.md

@@ -1,179 +1,48 @@
 # Stonyx
 
-**Stonyx** is a lightweight, modular framework for building modern Node.js applications. It provides a **plug-and-play architecture**, centralized color-coded logging, and seamless integration of asynchronous modules, making development faster, cleaner, and more maintainable.
+**Stonyx** is a lightweight, modular framework for building modern Node.js applications. It provides a plug-and-play architecture, centralized color-coded logging, and seamless async module integration.
 
-### Highlights
-
-* ✅ 100% JavaScript
-* ✅ Drop-in file system for most modules
-* ✅ Don’t even hit the ground — just fly
-* ✅ High performance
-
-Stonyx acts as a **base application host**, allowing you to add official modules (`@stonyx/*`) or your own custom modules without boilerplate initialization.
-
----
+- 100% JavaScript (ES Modules)
+- Drop-in module system — no boilerplate
+- Automatic async module loading and initialization
+- Built-in CLI for bootstrapping and testing
 
 ## Quick Start
 
-### ESM Usage (Application Startup)
-
-For standard applications, the **bootstrap file** ensures that the Stonyx framework and all submodules are fully loaded before your application code runs:
-
-```js
-// index.js - your project's entry point
-import Stonyx from './stonyx-bootstrap.cjs';
-await Stonyx.ready; // wait until all modules are initialized
-
-const { default: App } = await import('./app.js'); // your application
-new App();
-```
-
-### CommonJS Bootstrap Helper
-Auto-generated and added to your project post installation
-
-```js
-// stonyx-bootstrap.cjs
-const Stonyx = require('stonyx').default;
-const config = require('./config/environment.js').default;
-
-new Stonyx(config, __dirname);
-```
-
----
-
-## Core Features
-
-### 1. **Modular Architecture**
-
-* Automatically detects modules in `devDependencies` prefixed with `@stonyx/`.
-* Supports async initialization with `stonyx-async` modules.
-* Safe module sequencing for submodule development with `waitForModule()`.
-
-### 2. **Color-Coded Logging**
-
-* Centralized logging via [Chronicle](https://github.com/abofs/chronicle).
-* Module-specific logs configurable in `environment.js`:
-
-```js
-restServer: { logColor: 'yellow', logMethod: 'api', logTimestamp: true }
-```
-
-* Create custom logs for any class with minimal configuration.
-
-### 3. **Singleton Design**
-
-* Only one instance of Stonyx exists per project.
-* Ensures consistent access to modules, logs, and configuration.
-
-### 4. **Plug-and-Play Module Loading**
-
-* Modules with `stonyx-module` keyword in `package.json` are auto-initialized.
-* Modules with `stonyx-async` keyword are awaited automatically before usage.
-
----
-
-## Official Modules
-
-### **[@stonyx/cron](https://github.com/abofs/stonyx-cron)**
-
-Lightweight asynchronous job scheduling utility.
-
-```js
-import Cron from '@stonyx/cron';
-
-const cron = new Cron();
-cron.register('exampleJob', async () => console.log('Job executed!'), 5, true);
-```
-
-* Efficient scheduling using a min-heap.
-* Optional logging via `config.cron`.
-
----
-
-### **[@stonyx/rest-server](https://github.com/abofs/stonyx-rest-server)**
-
-Dynamic REST server module with auto-route registration.
-
-```js
-import Stonyx from 'stonyx';
-import config from './config/environment.js';
-
-new Stonyx(config);
-```
-
-* Zero configuration for routes: drop request classes into the `requests` directory.
-* Automatic path generation, JSON parsing, and CORS handling.
-* Supports per-route authentication hooks.
-
----
-
-### **[@stonyx/orm](https://github.com/abofs/stonyx-orm)**
-
-Lightweight ORM with model definitions, relationships, serializers, and optional REST integration.
-
-```js
-import Stonyx from 'stonyx';
-import config from './config/environment.js';
-
-new Stonyx(config);
-
-// Define models
-import { Model, attr, hasMany, belongsTo } from '@stonyx/orm';
-
-class Owner extends Model {
-  id = attr('string');
-  pets = hasMany('animal');
-}
-```
-
-* Auto-loads models, serializers, transforms, and access classes.
-* Optional JSON file persistence with auto-save intervals.
-* Integrates with `@stonyx/rest-server` for automatic route setup.
-
----
-
-## Configuration
-
-All modules are configurable via `config/environment.js`:
-
-```js
-export default {
-  restServer: { logColor: 'yellow', port: 3000 },
-  orm: { logColor: 'white', db: { file: './db.json', autosave: true } },
-  cron: { log: true }
-};
+```bash
+npm install stonyx
 ```
 
----
-
-## Running the Application
+The CLI handles everything — no manual `new Stonyx()` calls needed:
 
 ```bash
-node .        # Start the main app
-npm start     # Run using npm script
+stonyx serve    # Bootstrap + run app.js
+stonyx test     # Bootstrap + run tests
 ```
 
----
-
-## Developing Submodules
-
-For developers building new Stonyx modules or experimenting with async modules:
+Stonyx reads `config/environment.js`, initializes all `@stonyx/*` modules from your `devDependencies`, and runs your application.
 
-```js
-import Stonyx, { waitForModule } from 'stonyx';
-import config from './config/environment.js';
+## Documentation
 
-const app = new Stonyx(config, __dirname);
+| Section | Description |
+|---------|-------------|
+| [CLI](docs/cli.md) | Commands, aliases, and module commands |
+| [Configuration](docs/configuration.md) | Environment config, module config, test overrides |
+| [Modules](docs/modules.md) | Module architecture, async loading, official modules |
+| [Logging](docs/logging.md) | Chronicle integration and custom log types |
+| [Lifecycle](docs/lifecycle.md) | Startup and shutdown hooks |
+| [Testing](docs/testing.md) | Test runner, helpers, and conventions |
+| [Developing Modules](docs/developing-modules.md) | Guide for building custom Stonyx modules |
+| [API Reference](docs/api.md) | Public exports and class documentation |
 
-// Wait for specific async module readiness
-await waitForModule('restServer');
-```
-
-* Use `waitForModule()` **only for submodule development**, testing, or when you need to ensure a specific module is fully initialized before continuing.
-* Official modules automatically initialize during normal application startup, so end-users do **not** need to call `waitForModule()`.
+## Official Modules
 
----
+| Module | Description |
+|--------|-------------|
+| [@stonyx/cron](https://github.com/abofs/stonyx-cron) | Lightweight async job scheduling |
+| [@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, and serializers |
 
 ## License
 
-Apache 2.0 — do what you want, just keep attribution.
+Apache 2.0

package/config/environment copy.js

@@ -4,8 +4,7 @@ const {
   NODE_ENV,
 } = process.env;
 
-const isTest = typeof QUnit !== 'undefined';
-const environment = isTest ? 'test' : (NODE_ENV ?? 'development');
+const environment = NODE_ENV ?? 'development';
 
 export default {
   environment,

package/config/environment.js

@@ -4,8 +4,7 @@ const {
   NODE_ENV,
 } = process.env;
 
-const isTest = typeof QUnit !== 'undefined';
-const environment = isTest ? 'test' : (NODE_ENV ?? 'development');
+const environment = NODE_ENV ?? 'development';
 
 export default {
   environment,

package/docs/api.md

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

package/docs/cli.md

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

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