@venizia/ignis 0.2.2 → 0.3.0

package/dist/vulcan-preset/files/.configs/eslint.config.mjs

@@ -0,0 +1,4 @@
+import { houseConfigs } from '@venizia/dev-configs/linters';
+
+// oxlint (oxlint.config.mts) runs every other rule; ESLint runs the naming convention and the house rules.
+export default houseConfigs;

package/dist/vulcan-preset/files/.configs/oxfmt.config.mts

@@ -0,0 +1,4 @@
+import { defineConfig } from 'oxfmt';
+import { oxfmtConfigs } from '@venizia/dev-configs/formatters';
+
+export default defineConfig(oxfmtConfigs);

package/dist/vulcan-preset/files/.configs/oxlint.config.mts

@@ -0,0 +1,4 @@
+import { defineConfig } from 'oxlint';
+import { oxlintConfigs } from '@venizia/dev-configs/linters';
+
+export default defineConfig(oxlintConfigs);

package/dist/vulcan-preset/files/README.md

@@ -0,0 +1,5 @@
+# {{app}}
+
+The {{app}} backend of {{project}}, built on IGNIS.
+
+`bun run dev` serves `http://localhost:{{devPort}}/api/hello`.

package/dist/vulcan-preset/files/_env.example

@@ -0,0 +1 @@
+PORT={{devPort}}

package/dist/vulcan-preset/files/src/application.ts

@@ -0,0 +1,33 @@
+import { ApiReferenceComponent, BaseApplication, type IApplicationInfo } from '@venizia/ignis';
+import AutoArtifacts from '@venizia/ignis-boot/auto';
+import packageJson from '../package.json';
+
+export class Application extends BaseApplication {
+  getAppInfo(): IApplicationInfo {
+    return {
+      name: packageJson.name,
+      version: packageJson.version,
+      description: 'The {{app}} backend of {{project}}',
+    };
+  }
+
+  staticConfigure() {}
+
+  preConfigure() {
+    this.component(ApiReferenceComponent);
+  }
+
+  postConfigure() {}
+
+  setupMiddlewares() {}
+}
+
+export const application = new Application({
+  scope: 'Application',
+  config: {
+    host: '0.0.0.0',
+    port: Number(process.env.PORT ?? '{{devPort}}'),
+    path: { base: '/api', isStrict: false },
+    artifacts: AutoArtifacts,
+  },
+});

package/dist/vulcan-preset/files/src/controllers/hello.controller.ts

@@ -0,0 +1,34 @@
+import { z } from '@hono/zod-openapi';
+import {
+  BaseRestController,
+  controller,
+  get,
+  jsonContent,
+  type TRouteContext,
+} from '@venizia/ignis';
+import { HTTP } from '@venizia/ignis-helpers';
+
+@controller({ path: '/hello' })
+export class HelloController extends BaseRestController {
+  constructor() {
+    super({ scope: HelloController.name });
+  }
+
+  // binding() is abstract - leave it empty when every route uses @get/@post decorators.
+  override binding() {}
+
+  @get({
+    configs: {
+      path: '/',
+      responses: {
+        [HTTP.ResultCodes.RS_2.Ok]: jsonContent({
+          description: 'Says hello',
+          schema: z.object({ message: z.string() }),
+        }),
+      },
+    },
+  })
+  sayHello(context: TRouteContext) {
+    return context.json({ message: 'Hello from IGNIS!' }, HTTP.ResultCodes.RS_2.Ok);
+  }
+}

package/dist/vulcan-preset/files/src/index.ts

@@ -0,0 +1,11 @@
+import { application } from './application';
+
+const main = async () => {
+  application.init();
+  await application.start();
+};
+
+main().catch((error: unknown) => {
+  console.error('[main] Application start failed | Error:', error);
+  process.exit(1);
+});

package/dist/vulcan-preset/files/src/smoke.test.ts

@@ -0,0 +1,81 @@
+// Smoke test: runs src/index.ts exactly as the quickstart page tells the reader to, on a free port,
+// and calls its two endpoints over HTTP.
+import { afterAll, beforeAll, describe, expect, test } from 'bun:test';
+import { getError } from '@venizia/ignis-helpers';
+import path from 'node:path';
+
+const HOST = '127.0.0.1';
+const START_TIMEOUT_MS = 10_000;
+const POLL_INTERVAL_MS = 100;
+
+const findFreePort = async () => {
+  const probe = Bun.serve({ hostname: HOST, port: 0, fetch: () => new Response() });
+  const port = probe.port;
+  await probe.stop(true);
+  return port;
+};
+
+const waitForServer = async (opts: { url: string; process: Bun.Subprocess }) => {
+  const deadline = Date.now() + START_TIMEOUT_MS;
+
+  while (Date.now() < deadline) {
+    if (opts.process.exitCode !== null) {
+      throw getError({
+        message: `[smoke] src/index.ts exited early | Code: ${opts.process.exitCode}`,
+      });
+    }
+
+    const isUp = await fetch(opts.url).then(
+      response => response.ok,
+      () => false,
+    );
+
+    if (isUp) {
+      return;
+    }
+
+    await Bun.sleep(POLL_INTERVAL_MS);
+  }
+
+  throw getError({
+    message: `[smoke] server did not answer within ${START_TIMEOUT_MS} ms | Url: ${opts.url}`,
+  });
+};
+
+describe('{{app}}', () => {
+  let server: Bun.Subprocess;
+  let baseUrl = '';
+
+  beforeAll(async () => {
+    const port = await findFreePort();
+    baseUrl = `http://${HOST}:${port}/api`;
+
+    server = Bun.spawn(['bun', 'run', 'src/index.ts'], {
+      cwd: path.resolve(__dirname, '..'),
+      env: { ...process.env, PORT: String(port) },
+      stdout: 'ignore',
+      stderr: 'inherit',
+    });
+
+    await waitForServer({ url: `${baseUrl}/hello`, process: server });
+  });
+
+  afterAll(async () => {
+    server?.kill();
+    await server?.exited;
+  });
+
+  test('GET /hello says hello', async () => {
+    const response = await fetch(`${baseUrl}/hello`);
+
+    expect(response.status).toBe(200);
+    expect(await response.json()).toEqual({ message: 'Hello from IGNIS!' });
+  });
+
+  test('GET /doc/explorer serves the API reference', async () => {
+    const response = await fetch(`${baseUrl}/doc/explorer`);
+
+    expect(response.status).toBe(200);
+    expect(response.headers.get('content-type')).toContain('text/html');
+  });
+});

package/dist/vulcan-preset/files/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": "@venizia/dev-configs/tsconfig.common.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "paths": {
+      "@/*": [
+        "./src/*"
+      ]
+    },
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "useDefineForClassFields": false
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}

package/dist/vulcan-preset/preset.json

@@ -0,0 +1,50 @@
+{
+  "presetVersion": 1,
+  "side": "backend",
+  "summary": "An IGNIS API on Bun: one controller, AutoArtifacts, the API reference at /api/doc/explorer.",
+  "devPort": 3000,
+  "dependencies": {
+    "@hono/zod-openapi": "^1.6.3",
+    "@scalar/hono-api-reference": "^0.11.16",
+    "@venizia/ignis": "0.3.0",
+    "@venizia/ignis-boot": "0.3.0",
+    "@venizia/ignis-helpers": "0.3.0",
+    "hono": "^4.13.7",
+    "winston": "^3.19.0",
+    "winston-daily-rotate-file": "^5.0.0",
+    "winston-transport": "^4.9.0"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.4.1",
+    "@venizia/dev-configs": "0.3.1",
+    "eslint": "^10.10.0",
+    "oxfmt": "0.73.0",
+    "oxlint": "1.88.0",
+    "oxlint-tsgolint": "7.0.2004",
+    "tsc-alias": "^1.9.4",
+    "typescript": "^6.0.3"
+  },
+  "peers": {},
+  "scripts": {
+    "dev": "NODE_ENV=development bun run src/index.ts",
+    "start": "NODE_ENV=production bun run dist/index.js",
+    "build": "tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "lint": "oxlint -c .configs/oxlint.config.mts --deny-warnings && eslint -c .configs/eslint.config.mjs . && oxfmt -c .configs/oxfmt.config.mts --check \"**/*.{ts,tsx,mts,js,mjs}\"",
+    "lint:fix": "oxlint -c .configs/oxlint.config.mts --fix && eslint -c .configs/eslint.config.mjs . --fix && oxfmt -c .configs/oxfmt.config.mts \"**/*.{ts,tsx,mts,js,mjs}\"",
+    "test": "bun test"
+  },
+  "checks": [
+    "typecheck",
+    "lint",
+    "test"
+  ],
+  "files": "./files",
+  "atlas": [
+    {
+      "name": "ignis",
+      "repo": "VENIZIA-AI/ignis",
+      "ref": "develop"
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@venizia/ignis",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "High-performance TypeScript server infrastructure combining LoopBack 4 enterprise architecture (decorator-based DI, repository pattern, component system) with Hono speed (~140k req/s). Features auto-generated OpenAPI docs, Drizzle ORM type-safe SQL, JWT/Basic authentication, Casbin authorization, convention-based bootstrapping, and pluggable components for health checks, Swagger UI, mail, Socket.IO, and static assets. Built for Bun and Node.js.",
   "keywords": [
     "access-control",
@@ -190,16 +190,19 @@
     "access": "public"
   },
   "sideEffects": false,
+  "vulcan": {
+    "preset": "./dist/vulcan-preset/preset.json"
+  },
   "scripts": {
     "force-update": "sh ./scripts/force-update.sh",
     "prepublishOnly": "make rebuild"
   },
   "dependencies": {
-    "@venizia/ignis-connectors": "0.2.2",
-    "@venizia/ignis-filter": "0.2.2",
-    "@venizia/ignis-helpers": "0.2.2",
-    "@venizia/ignis-inversion": "0.2.2",
-    "@venizia/ignis-kernel": "0.2.2",
+    "@venizia/ignis-connectors": "0.3.0",
+    "@venizia/ignis-filter": "0.3.0",
+    "@venizia/ignis-helpers": "0.3.0",
+    "@venizia/ignis-inversion": "0.3.0",
+    "@venizia/ignis-kernel": "0.3.0",
     "reflect-metadata": "^0.2.2"
   },
   "peerDependencies": {
@@ -304,7 +307,7 @@
     "@types/nodemailer": "^8.0.1",
     "@types/pg": "^8.23.1",
     "@venizia/dev-configs": "0.3.1",
-    "@venizia/ignis-boot": "0.2.1",
+    "@venizia/ignis-boot": "0.3.0",
     "casbin": "^5.51.1",
     "eslint": "^10.10.0",
     "meilisearch": "^0.60.0",