stonyx 0.2.3-beta.9 → 0.2.3-beta.90

package/README.md

@@ -1,23 +1,30 @@
+[![CI](https://github.com/abofs/stonyx/actions/workflows/ci.yml/badge.svg)](https://github.com/abofs/stonyx/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/stonyx.svg)](https://www.npmjs.com/package/stonyx)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
 # 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 async module integration.
 
-- 100% JavaScript (ES Modules)
 - Drop-in module system — no boilerplate
 - Automatic async module loading and initialization
-- Built-in CLI for bootstrapping and testing
+- Built-in CLI for scaffolding, bootstrapping, and testing
 
 ## Quick Start
 
 ```bash
-npm install stonyx
+npm install -g stonyx
+stonyx new my-app
+cd my-app
+stonyx serve
 ```
 
-The CLI handles everything — no manual `new Stonyx()` calls needed:
+The `new` command walks you through module selection and generates a ready-to-run project. From there, the CLI handles bootstrapping:
 
 ```bash
 stonyx serve    # Bootstrap + run app.js
 stonyx test     # Bootstrap + run tests
+stonyx help     # Show all available commands
 ```
 
 Stonyx reads `config/environment.js`, initializes all `@stonyx/*` modules from your `devDependencies`, and runs your application.
@@ -40,8 +47,12 @@ Stonyx reads `config/environment.js`, initializes all `@stonyx/*` modules from y
 | 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/discord](https://github.com/abofs/stonyx-discord) | Discord bot with command and event handler auto-discovery |
+| [@stonyx/events](https://github.com/abofs/stonyx-events) | Pub/sub event system |
+| [@stonyx/oauth](https://github.com/abofs/stonyx-oauth) | OAuth provider integration |
 | [@stonyx/orm](https://github.com/abofs/stonyx-orm) | ORM with models, relationships, and serializers |
+| [@stonyx/rest-server](https://github.com/abofs/stonyx-rest-server) | Dynamic REST server with auto-route registration |
+| [@stonyx/sockets](https://github.com/abofs/stonyx-sockets) | WebSocket server and client |
 
 ## License
 

package/config/{environment.js → environment copy.ts }

@@ -1,12 +1,16 @@
-// project configuration, override-able by listed environment variables
-const {
-  DEBUG,
-  NODE_ENV,
-} = process.env;
-
-const environment = NODE_ENV ?? 'development';
-
-export default {
-  environment,
-  debug: DEBUG ?? environment === 'development',
-}
+import type { StoynxConfig } from 'stonyx';
+
+// project configuration, override-able by listed environment variables
+const {
+  DEBUG,
+  NODE_ENV,
+} = process.env;
+
+const environment = NODE_ENV ?? 'development';
+
+const config: StoynxConfig = {
+  environment,
+  debug: DEBUG ?? environment === 'development',
+};
+
+export default config;

package/dist/cli/help.d.ts

@@ -0,0 +1,8 @@
+import type { CommandDefinition } from './load-commands.js';
+interface HelpOptions {
+    args?: string[];
+    builtInCommands?: Record<string, CommandDefinition>;
+    loadModuleCommands?: () => Promise<Record<string, CommandDefinition>>;
+}
+export default function help({ args, builtInCommands, loadModuleCommands }?: HelpOptions): Promise<void>;
+export {};

package/dist/cli/help.js

@@ -0,0 +1,43 @@
+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/dist/cli/load-commands.d.ts

@@ -0,0 +1,10 @@
+export interface CommandDefinition {
+    description: string;
+    run: (ctx: {
+        args: string[];
+        cwd?: string;
+    }) => Promise<void>;
+    bootstrap?: boolean;
+    module?: string;
+}
+export default function loadModuleCommands(): Promise<Record<string, CommandDefinition>>;

package/dist/cli/load-commands.js

@@ -0,0 +1,49 @@
+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 moduleExports = modulePackage.exports;
+        if (!moduleExports || !moduleExports['./commands'])
+            continue;
+        try {
+            const commandsModule = await import(path.join(cwd, 'node_modules', moduleName, moduleExports['./commands']));
+            if (!commandsModule.default || typeof commandsModule.default !== 'object')
+                continue;
+            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/dist/cli/new.d.ts

@@ -0,0 +1,26 @@
+interface ModuleOption {
+    question: string;
+    package: string;
+    dirs?: string[];
+    files?: Record<string, () => string>;
+}
+export declare function generateDbSchema(): string;
+export declare function generatePackageJson(name: string, selectedModules: ModuleOption[]): string;
+export declare function generateAppTs(): string;
+export declare function generateEnvironmentTs(): string;
+export declare function generateTestEnvironmentTs(): string;
+export declare function generateSetupTs(): string;
+export declare function generateZzExitTestTs(): string;
+export declare function generateEnvironmentExampleTs(): string;
+export declare function generateGitignore(): string;
+export declare function generateTsConfig(): string;
+/**
+ * Write every scaffolded file to disk given a resolved project directory,
+ * app name, and pre-selected module options. Factored out of `newCommand`
+ * so tests can exercise the file-writing path without interactive prompts.
+ */
+export declare function scaffoldProject(projectDir: string, appName: string, selectedModules: ModuleOption[]): Promise<void>;
+export default function newCommand({ args }: {
+    args: string[];
+}): Promise<void>;
+export {};

package/dist/cli/new.js

@@ -0,0 +1,293 @@
+import { confirm, prompt } from '@stonyx/utils/prompt';
+import { createFile, createDirectory, copyFile, fileExists } from '@stonyx/utils/file';
+import { spawn } from 'child_process';
+import path from 'path';
+import { fileURLToPath } from 'url';
+const MODULE_OPTIONS = [
+    {
+        question: 'Will this project need a REST server?',
+        package: '@stonyx/rest-server',
+        dirs: ['requests']
+    },
+    {
+        question: 'Will this project need WebSockets?',
+        package: '@stonyx/sockets',
+        dirs: ['socket-handlers']
+    },
+    {
+        question: 'Will this project need data management?',
+        package: '@stonyx/orm',
+        dirs: ['models', 'serializers', 'access', 'transforms', 'hooks'],
+        files: { 'config/db-schema.ts': generateDbSchema }
+    },
+    {
+        question: 'Will this project need scheduled tasks (cron)?',
+        package: '@stonyx/cron',
+        dirs: ['crons']
+    },
+    {
+        question: 'Will this project need OAuth?',
+        package: '@stonyx/oauth'
+    },
+    {
+        question: 'Will this project need pub/sub events?',
+        package: '@stonyx/events'
+    },
+    {
+        question: 'Will this project need a Discord bot?',
+        package: '@stonyx/discord',
+        dirs: ['discord-commands', 'discord-events']
+    }
+];
+export function generateDbSchema() {
+    return `import { Model, hasMany, type HasMany } from '@stonyx/orm';
+
+export default class DBModel extends Model {
+  // Define your collections here
+  // examples: HasMany = hasMany('example');
+}
+`;
+}
+export function generatePackageJson(name, selectedModules) {
+    const devDependencies = {
+        qunit: '^2.24.1',
+        stonyx: 'latest',
+        tsx: '^4.21.0',
+        typescript: '^5.8.3'
+    };
+    for (const mod of selectedModules) {
+        devDependencies[mod.package] = 'latest';
+    }
+    // Sort dependencies alphabetically
+    const sorted = Object.fromEntries(Object.entries(devDependencies).sort(([a], [b]) => a.localeCompare(b)));
+    return JSON.stringify({
+        name,
+        version: '0.1.0',
+        type: 'module',
+        private: true,
+        scripts: {
+            build: 'tsc',
+            serve: 'stonyx serve',
+            start: 'stonyx serve',
+            test: "NODE_ENV=test node --import tsx/esm --import ./test/setup.ts node_modules/qunit/bin/qunit.js 'test/**/*-test.ts'"
+        },
+        devDependencies: sorted
+    }, null, 2) + '\n';
+}
+export function generateAppTs() {
+    return `import log from 'stonyx/log';
+
+export default class App {
+  static instance: App;
+  ready: Promise<void>;
+
+  constructor() {
+    if (App.instance) return App.instance;
+    App.instance = this;
+
+    this.ready = this.init();
+  }
+
+  async init(): Promise<void> {
+    log.info('Initializing Application');
+
+    // Application setup here
+
+    log.info('Application has been initialized');
+  }
+}
+`;
+}
+export function generateEnvironmentTs() {
+    return `import type { StoynxConfig } from 'stonyx';
+
+const config: StoynxConfig = {
+};
+
+export default config;
+`;
+}
+export function generateTestEnvironmentTs() {
+    return `import type { StoynxConfig } from 'stonyx';
+
+// Test-specific config overrides
+const config: Partial<StoynxConfig> = {
+};
+
+export default config;
+`;
+}
+export function generateSetupTs() {
+    return `// Test setup: bootstrap Stonyx with the consumer config before qunit runs.
+// Sprint 44 pattern — loaded via \`node --import ./test/setup.ts\`.
+import { pathToFileURL } from 'url';
+
+const cwd = process.cwd();
+
+const { default: Stonyx } = await import('stonyx');
+const { default: config } = await import(pathToFileURL(\`\${cwd}/config/environment.ts\`).href);
+
+new Stonyx(config, cwd);
+
+await Stonyx.ready;
+`;
+}
+export function generateZzExitTestTs() {
+    return `// Force-exit hook for qunit runs.
+//
+// Stonyx modules may keep listeners/servers open that would otherwise
+// block the process from exiting after tests complete, causing CI to
+// hit timeouts even though all tests passed.
+//
+// Named \`zz-\` so alphabetical test-file order places it last, after
+// all real test files have registered with QUnit.
+import QUnit from 'qunit';
+
+QUnit.on('runEnd', () => {
+  setImmediate(() => process.exit(process.exitCode ?? 0));
+});
+`;
+}
+export function generateEnvironmentExampleTs() {
+    return `// Copy this file to environment.ts and fill in your values
+// All values should use environment variables with ?? fallback defaults
+
+const {
+  NODE_ENV,
+} = process.env;
+
+const environment: string = NODE_ENV ?? 'development';
+
+export default {
+}
+`;
+}
+export function generateGitignore() {
+    return `node_modules/
+.env
+db.json
+*.log
+
+# Compiled TypeScript output (tsc compiles .ts to .js in-place)
+*.js
+*.d.ts
+*.js.map
+`;
+}
+export function generateTsConfig() {
+    return JSON.stringify({
+        compilerOptions: {
+            strict: true,
+            target: 'ES2022',
+            module: 'NodeNext',
+            moduleResolution: 'NodeNext',
+            outDir: '.',
+            rootDir: '.',
+            esModuleInterop: true,
+            skipLibCheck: true,
+            forceConsistentCasingInFileNames: true
+        },
+        include: ['**/*.ts'],
+        exclude: ['node_modules', 'test']
+    }, null, 2) + '\n';
+}
+function runPnpmInstall(projectDir) {
+    return new Promise((resolve, reject) => {
+        const child = spawn('pnpm', ['install'], {
+            cwd: projectDir,
+            stdio: 'inherit'
+        });
+        child.on('close', code => {
+            if (code === 0)
+                resolve();
+            else
+                reject(new Error(`pnpm install exited with code ${code}`));
+        });
+        child.on('error', reject);
+    });
+}
+/**
+ * Write every scaffolded file to disk given a resolved project directory,
+ * app name, and pre-selected module options. Factored out of `newCommand`
+ * so tests can exercise the file-writing path without interactive prompts.
+ */
+export async function scaffoldProject(projectDir, appName, selectedModules) {
+    // Create project directory
+    await createDirectory(projectDir);
+    // Copy .nvmrc from monorepo root
+    const monorepoRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', '..', '..');
+    const nvmrcSource = path.join(monorepoRoot, '.nvmrc');
+    if (await fileExists(nvmrcSource)) {
+        await copyFile(nvmrcSource, path.join(projectDir, '.nvmrc'));
+    }
+    // Generate core files
+    await createFile(path.join(projectDir, 'package.json'), generatePackageJson(appName, selectedModules));
+    await createFile(path.join(projectDir, 'app.ts'), generateAppTs());
+    await createFile(path.join(projectDir, 'tsconfig.json'), generateTsConfig());
+    await createFile(path.join(projectDir, '.gitignore'), generateGitignore());
+    // Create config directory and files
+    await createFile(path.join(projectDir, 'config', 'environment.ts'), generateEnvironmentTs());
+    await createFile(path.join(projectDir, 'config', 'environment.example.ts'), generateEnvironmentExampleTs());
+    // Create module-specific directories and files
+    for (const mod of selectedModules) {
+        if (mod.dirs) {
+            for (const dir of mod.dirs) {
+                await createDirectory(path.join(projectDir, dir));
+                // Create .gitkeep so empty dirs are tracked
+                await createFile(path.join(projectDir, dir, '.gitkeep'), '');
+            }
+        }
+        if (mod.files) {
+            for (const [filePath, generator] of Object.entries(mod.files)) {
+                await createFile(path.join(projectDir, filePath), generator());
+            }
+        }
+    }
+    // Create test structure
+    await createDirectory(path.join(projectDir, 'test', 'unit'));
+    await createFile(path.join(projectDir, 'test', 'unit', '.gitkeep'), '');
+    await createDirectory(path.join(projectDir, 'test', 'integration'));
+    await createFile(path.join(projectDir, 'test', 'integration', '.gitkeep'), '');
+    await createDirectory(path.join(projectDir, 'test', 'acceptance'));
+    await createFile(path.join(projectDir, 'test', 'acceptance', '.gitkeep'), '');
+    // Create test config (TS)
+    await createFile(path.join(projectDir, 'test', 'config', 'environment.ts'), generateTestEnvironmentTs());
+    // Create Sprint 44 test harness files (setup bootstraps Stonyx, zz-exit-test drains event loop)
+    await createFile(path.join(projectDir, 'test', 'setup.ts'), generateSetupTs());
+    await createFile(path.join(projectDir, 'test', 'zz-exit-test.ts'), generateZzExitTestTs());
+}
+export default async function newCommand({ args }) {
+    let appName = args[0];
+    if (!appName) {
+        appName = await prompt('Project name:');
+    }
+    if (!appName) {
+        console.error('Project name is required.');
+        process.exit(1);
+    }
+    const projectDir = path.resolve(process.cwd(), appName);
+    if (await fileExists(projectDir)) {
+        console.error(`Directory "${appName}" already exists.`);
+        process.exit(1);
+    }
+    console.log(`\nScaffolding new Stonyx project: ${appName}\n`);
+    // Prompt for module selection
+    const selectedModules = [];
+    for (const mod of MODULE_OPTIONS) {
+        if (await confirm(mod.question)) {
+            selectedModules.push(mod);
+        }
+    }
+    console.log('\nCreating project structure...\n');
+    await scaffoldProject(projectDir, appName, selectedModules);
+    console.log('Installing dependencies...\n');
+    try {
+        await runPnpmInstall(projectDir);
+    }
+    catch (error) {
+        console.error('Failed to install dependencies. Run `pnpm install` manually in the project directory.');
+    }
+    console.log(`\n✓ Project "${appName}" created successfully!`);
+    console.log(`\n  cd ${appName}`);
+    console.log(`  stonyx serve\n`);
+}

package/dist/cli/serve.d.ts

@@ -0,0 +1,6 @@
+import { type StoynxModule } from '../lifecycle.js';
+export declare function createShutdownHandler(modules: StoynxModule[]): () => Promise<void>;
+export declare function maybeRegisterAppShutdown(modules: StoynxModule[], appInstance: unknown, originalShutdown: () => Promise<void>): void;
+export default function serve({ args }: {
+    args: string[];
+}): Promise<void>;

package/dist/cli/serve.js

@@ -0,0 +1,49 @@
+import { resolve } from 'path';
+import { pathToFileURL } from 'url';
+import { runStartupHooks, runShutdownHooks } from '../lifecycle.js';
+import { importConfig } from '../util/import-config.js';
+import { resolveEntryPoint } from '../util/resolve-entry-point.js';
+export function createShutdownHandler(modules) {
+    let shuttingDown = false;
+    return async () => {
+        if (shuttingDown)
+            return;
+        shuttingDown = true;
+        await runShutdownHooks(modules);
+        process.exit(0);
+    };
+}
+export function maybeRegisterAppShutdown(modules, appInstance, originalShutdown) {
+    if (appInstance &&
+        typeof appInstance.shutdown === 'function') {
+        const appShutdown = createShutdownHandler([
+            ...modules,
+            appInstance
+        ]);
+        process.removeListener('SIGTERM', originalShutdown);
+        process.removeListener('SIGINT', originalShutdown);
+        process.on('SIGTERM', appShutdown);
+        process.on('SIGINT', appShutdown);
+    }
+}
+export default async function serve({ args }) {
+    const cwd = process.cwd();
+    const entryFlag = args.indexOf('--entry');
+    const entryArg = (entryFlag !== -1 && entryFlag + 1 < args.length) ? args[entryFlag + 1] : null;
+    const entryPoint = entryArg !== null ? resolve(cwd, entryArg) : resolveEntryPoint(`${cwd}/app`);
+    const config = await importConfig(`${cwd}/config/environment`);
+    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(pathToFileURL(entryPoint).href);
+    let appInstance;
+    if (entryModule.default) {
+        appInstance = new entryModule.default();
+    }
+    maybeRegisterAppShutdown(modules, appInstance, shutdown);
+}

package/dist/cli/test-setup.d.ts

@@ -0,0 +1 @@
+export {};

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 {};