@lithia-js/core 1.0.0-canary.18 → 1.0.0-canary.20

package/README.md

@@ -2,10 +2,10 @@
   <a href="https://github.com/lithia-framework/lithia">
     <img alt="Lithia logo" src="https://raw.githubusercontent.com/lithia-framework/lithia/canary/.github/assets/logo.svg" height="128">
   </a>
-  <h1>Lithia</h1>
-  <p><strong>The high-performance Node.js framework powered by Rust.</strong></p>
+  <h1>@lithia-js/core</h1>
+  <p><strong>The main Lithia runtime package.</strong></p>
 
-  <p>Build APIs with magic, speed, and Type Safety by default.</p>
+  <p>Routes, events, async tasks, startup bootstrap, config, and the public runtime APIs.</p>
 
 <a href="https://www.npmjs.com/package/@lithia-js/core"><img alt="NPM version" src="https://img.shields.io/npm/v/@lithia-js/core.svg?style=for-the-badge&labelColor=000000"></a>
 <a href="https://github.com/lithia-framework/lithia/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/npm/l/@lithia-js/core.svg?style=for-the-badge&labelColor=000000"></a>
@@ -13,65 +13,31 @@
 
 </div>
 
-## 🚀 Quick Start
+## Overview
 
-Build your first Lithia app in seconds:
+`@lithia-js/core` provides the main framework primitives:
 
-```bash
-npx create-lithia@latest my-app
-cd my-app
-npm run dev
-```
-
-## 🪄 Magic in Action
+- `defineConfig()` for `lithia.config.ts`
+- file-based HTTP routes and Socket.IO events
+- request/response primitives and route/event hooks
+- dependency injection with `provide()` and `useDependency()`
+- native async tasks with `executeTask()` and `dispatchTask()`
+- optional `src/app/server.ts` startup bootstrap
+- route metadata types for OpenAPI generation
 
-Lithia uses a clean, file-based routing convention. No boilerplate, just focus on your logic.
+## Example
 
-```typescript
-// routes/hello/route.get.ts
+```ts
 import type { RouteHandler } from "@lithia-js/core";
 
-const Hello: RouteHandler = async (req, res) => {
-  const name = req.query.name || "World";
-  return res.json({ message: `Hello, ${name}!` });
-}
+const hello: RouteHandler = async (_req, res) => {
+	res.json({ message: "Hello, world!" });
+};
 
-export default Hello;
-// Available at: GET /hello
+export default hello;
 ```
 
-## ✨ Features
-
-* **Intuitive Routing**: Method-based file naming (`.get.ts`, `.post.ts`) for automatic route registration.
-* **Native Performance**: Core engine written in Rust for lightning-fast request handling.
-* **Full-stack Ready**: Native support for WebSockets, Auth, and Drizzle ORM.
-* **Modern Stack**: Ships with Biome and TypeScript pre-configured for the best DX.
-
-## 📖 Documentation
-
-Everything you need to know is at [lithiajs.com/docs](https://lithiajs.com/docs).
-
----
-
-## 🤝 Community & Support
+## Internal layout
 
-* **Discussions**: [GitHub Discussions](https://github.com/lithia-framework/lithia/discussions)
-* **Contribution**: We love PRs! See [CONTRIBUTING.md](https://www.google.com/search?q=CONTRIBUTING.md)
-* **Sponsor**: Support the magic on [OpenCollective](https://opencollective.com/lithiajs)
-
----
-
-## License
-
-Lithia is [MIT licensed](https://www.google.com/search?q=LICENSE). Built with ❤️ by Lucas Arch and the community.
-
----
-
-<div align="center">
-<p>
-<a href="https://github.com/lithia-framework/lithia">GitHub</a> •
-<a href="https://lithiajs.com">Documentation</a> •
-<a href="https://opencollective.com/lithiajs">OpenCollective</a> •
-<a href="https://github.com/lithia-framework/lithia/discussions">Discussions</a>
-</p>
-</div>
+The internal package layout is documented in
+[src/README.md](./src/README.md).

package/dist/_index.d.ts

@@ -0,0 +1,128 @@
+import { L as LithiaError, a as LithiaOptions, R as Route, E as Event } from './protocol-Ddx-dP-_.js';
+export { C as CFG_GLOBAL_KEY, b as RouteNotFoundError } from './protocol-Ddx-dP-_.js';
+import { T as TaskCore } from './tasks-qNCrAmuM.js';
+import '@lithia-js/utils';
+import 'c12';
+
+type Environment = "test" | "build" | "production" | "development";
+
+/**
+ * Thrown when a Lithia hook is used outside a managed Lithia execution
+ * context.
+ */
+declare class NotInLithiaContextError extends LithiaError {
+    constructor();
+}
+
+/**
+ * Minimal runtime options required to bootstrap the Lithia host.
+ */
+interface LithiaOpts {
+    environment: Environment;
+}
+/**
+ * Main-process orchestrator for the Lithia runtime.
+ *
+ * The host is responsible for loading configuration and manifests, building the
+ * app, spawning the app worker, and coordinating async task execution.
+ */
+declare class HostSupervisor {
+    private readonly opts;
+    private _config;
+    private _env;
+    private readonly _builder;
+    private readonly _manifestStore;
+    private readonly _appSupervisor;
+    private readonly _taskRunner;
+    private _appCount;
+    private _lastPortUsed;
+    constructor(opts: LithiaOpts);
+    get config(): LithiaOptions;
+    get environment(): Environment;
+    get isAppReady(): boolean;
+    get routes(): Route[];
+    get events(): Event[];
+    get tasks(): TaskCore[];
+    /**
+     * Loads the user configuration file into the host runtime.
+     */
+    loadConfig(): Promise<void>;
+    /**
+     * Loads and merges configured environment files into the host snapshot.
+     */
+    loadEnv(): Promise<Record<string, string>>;
+    /**
+     * Loads the routes manifest from the current build output.
+     */
+    loadRoutes(): Promise<void>;
+    /**
+     * Loads the events manifest from the current build output.
+     */
+    loadEvents(): Promise<void>;
+    /**
+     * Loads the async tasks manifest from the current build output.
+     */
+    loadTasks(): Promise<void>;
+    /**
+     * Returns a copy of the currently loaded environment snapshot.
+     */
+    getEnvSnapshot(): Record<string, string>;
+    /**
+     * Replaces the in-memory resolved config snapshot.
+     */
+    replaceConfig(config: LithiaOptions): void;
+    /**
+     * Replaces the in-memory environment snapshot.
+     */
+    replaceEnv(env: Record<string, string>): void;
+    /**
+     * Builds the application output and manifests.
+     *
+     * Returns `true` when the build succeeds. In non-build environments, failures
+     * are reported and surfaced as `false` so the caller can decide how to
+     * recover.
+     */
+    build(): Promise<boolean>;
+    /**
+     * Loads config/env and prints the CLI header for the current run.
+     */
+    setup(): Promise<void>;
+    /**
+     * Starts the app worker using the latest manifests and runtime state.
+     */
+    start(): Promise<void>;
+    /**
+     * Reloads manifests, resets task workers, and swaps the app worker.
+     */
+    reload(): Promise<void>;
+    /**
+     * Stops task execution and tears down the app worker.
+     */
+    stop(): Promise<void>;
+    /**
+     * Replaces the current app worker with a fresh instance.
+     */
+    swapApp(): Promise<void>;
+    /**
+     * Prints the Lithia CLI header and the env files currently in use.
+     */
+    printHeader(): Promise<void>;
+    /**
+     * Prints the loaded routes in a CLI-friendly tree format.
+     */
+    printRouteTree(): void;
+    /**
+     * Prints the loaded events in a CLI-friendly tree format.
+     */
+    printEventTree(): void;
+    /**
+     * Prints the loaded async tasks in a CLI-friendly tree format.
+     */
+    printTaskTree(): void;
+    private handleAppMessage;
+    private printTree;
+    private getAvailableEnvFiles;
+    private ensureConfigLoaded;
+}
+
+export { HostSupervisor, NotInLithiaContextError };