elegance-js 2.1.37 → 3.0.1

package/README.md

@@ -1,4 +1,90 @@
-# Elegance.JS 
-A fully-typescript, non-bloated, fast, and feature-rich web-framework.  
-  
-[Website](https://elegance.js.org/)
+# Elegance
+
+Elegance is a TypeScript framework for web applications. It provides file‑system routing, reactive state, server‑side rendering, and client‑side interactivity in a single codebase.
+
+## Features
+
+- Ridiculous speed: Up to ~24x faster build times compared to Next.JS, and up to ~1400x raw RPS on API Routes.
+- Optimized: 4KB client runtime
+- File‑system routing: pages and API endpoints are defined by the directory structure.
+- TSX support: use TSX with no runtime overhead.
+- Server & Client hybrid: You can write server & client-code in 1 file with no issues.
+- Reactive: atoms and components with automatic dependency tracking.
+- Dynamic rendering: opt into per‑request rendering or statically enumerate paths.
+- Server Actions: Inline API routes into your page files for faster development times.
+- Middleware: scoped request processing with the ability to pass data to downstream handlers.
+- Built‑in bundling: code splitting and advanced dead‑code elimination (DCE).
+- API routes: define `GET`, `POST`, `PUT`, `DELETE`, and `OPTIONS` handlers.
+
+## Quick Start
+
+```bash
+npx create-elegance-app my-app
+cd my-app
+npx elegance
+```
+
+Visit `http://localhost:3000` to see the default page.
+
+## Example
+
+A simple counter:
+
+```tsx
+const counter = state(0);
+
+export default function CounterPage() {
+    return div(
+        button({
+            onClick: () => counter.value++,
+        }, 
+            `Counter: ${counter.value}`
+        )
+    );
+}
+```
+
+A reusable component version:
+
+```tsx
+const Counter = component({
+    atoms: {
+        counter: 0,
+    },
+    view(_, { counter }) {
+        return button({
+            onClick: () => counter.value++,
+        }, 
+            `Counter: ${counter.value}`
+        );
+    }
+});
+
+export default function Page() {
+    return Counter();
+}
+```
+
+## Project Structure
+
+```
+my-app/
+├── pages/
+│   ├── page.tsx          # / (home)
+│   ├── about/
+│   │   └── page.tsx      # /about
+│   ├── api/
+│   │   └── route.ts      # /api/*
+│   ├── [slug]/
+│   │   └── page.tsx      # dynamic routes
+│   └── middleware.ts     # global middleware
+└── ...
+```
+
+## Documentation
+
+Full documentation is available via [Our Website](https://elegance.js.org/)
+
+## License
+
+MIT

package/bin/bootstrap.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+
+import { execSync } from "child_process";
+import { cpSync, existsSync } from "fs";
+import { join } from "path";
+const __dirname = import.meta.dirname;
+
+function bootstrap() {
+    if (existsSync("elegance.config.ts") || existsSync("pages")) {
+        console.error("The current directory already contains an Elegance project.");
+        return;
+    }
+
+    cpSync(join(__dirname, "./template_project"), process.cwd(), { recursive: true, })
+    execSync("npm install esbuild ts-arc")
+}
+
+bootstrap();

package/bin/run.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/run.js';

package/dist/build/common.d.ts

@@ -0,0 +1,147 @@
+import esbuild from "esbuild";
+import type { RouteInfo } from "../page-tools";
+import { AsyncLocalStorage } from "node:async_hooks";
+export type PublishEntry = {
+    input: string;
+    target: string;
+};
+type ImportContext = {
+    preBuildHooks: Array<() => Promise<void>>;
+    postBuildHooks: Array<() => Promise<void>>;
+    buildCallbacks: Array<() => Promise<void>>;
+    publishFiles: Array<PublishEntry>;
+    atomSeeds: Array<{
+        id: string;
+        initial: any;
+    }>;
+};
+export declare const importContext: AsyncLocalStorage<ImportContext>;
+type ImportedModule = {
+    module: any;
+    preBuildHooks: Array<() => Promise<void>>;
+    postBuildHooks: Array<() => Promise<void>>;
+    buildCallbacks: Array<() => Promise<void>>;
+    publishFiles: Array<PublishEntry>;
+    atomSeeds: Array<{
+        id: string;
+        initial: any;
+    }>;
+};
+export declare function importModule(path: string): Promise<ImportedModule>;
+export interface CompiledRoute {
+    default: Function;
+    metadata: (...params: unknown[]) => Promise<VirtualNode[]>;
+    getEnumeratedRoutes?: () => Promise<string[]>;
+    pathname: string;
+    preBuildHooks: Array<() => Promise<void>>;
+    postBuildHooks: Array<() => Promise<void>>;
+    buildCallbacks: Array<() => Promise<void>>;
+    publishFiles: Array<PublishEntry>;
+    atomSeeds: Array<{
+        id: string;
+        initial: any;
+    }>;
+}
+export interface CompiledLayout extends CompiledRoute {
+}
+export interface TranspiledRoute {
+    pathname: string;
+    pageFile: string;
+    layouts: string[];
+    serverCode: string;
+    preClientCode: string;
+    sharedChunkPaths: string[];
+}
+export type CacheKey = string & {
+    readonly __brand: unique symbol;
+};
+export declare function pageCacheKey(pathname: string): CacheKey;
+export declare function layoutFileCacheKey(layoutPath: string): CacheKey;
+export declare function statusCodeCacheKey(filePath: string): CacheKey;
+export declare function serverMjsPath(key: CacheKey): string;
+export declare function preClientMjsPath(key: CacheKey): string;
+export declare function clientMjsPath(key: CacheKey): string;
+export declare function chunkClientPath(key: CacheKey): string;
+export interface ApiRouteEntry {
+    pathname: string;
+    file: string;
+}
+export interface MiddlewareEntry {
+    file: string;
+}
+export interface StatusCodePageEntry {
+    pageFile: string;
+    layouts: string[];
+    layoutCacheKeys: CacheKey[];
+    cacheKey: CacheKey;
+}
+interface RouteEntryBase {
+    pageFile: string;
+    layouts: string[];
+    layoutCacheKeys: CacheKey[];
+    cacheKey: CacheKey;
+    sharedChunkPaths: string[];
+}
+export interface StaticRouteEntry extends RouteEntryBase {
+    kind: "static";
+    pathname: string;
+}
+export interface EnumeratedRouteEntry extends RouteEntryBase {
+    kind: "enumerated";
+    pathname: string;
+    patternPathname: string;
+}
+export interface DynamicRouteEntry extends RouteEntryBase {
+    kind: "dynamic";
+    pathname: string;
+}
+export type RouteEntry = StaticRouteEntry | EnumeratedRouteEntry | DynamicRouteEntry;
+export interface Manifest {
+    buildTime: number;
+    routes: RouteEntry[];
+    statusCodePages: StatusCodePageEntry[];
+    apiRoutes: ApiRouteEntry[];
+    middlewares: MiddlewareEntry[];
+}
+export declare function runBuildHooks(compiled: CompiledRoute, stage: "pre" | "post"): Promise<void>;
+export declare function minifyHtml(html: string): string;
+export declare function minifyCode(code: string): Promise<string>;
+export declare function getSlugParamName(pattern: string): string;
+export declare function fileHasExports(filePath: string): Promise<boolean>;
+export declare function computeFileHash(filePath: string): Promise<string>;
+export interface IncrementalState {
+    fileHashes: Record<string, string>;
+    clientCodeHashes: Record<string, string>;
+}
+export declare function loadIncrementalState(): Promise<IncrementalState>;
+export declare function saveIncrementalState(state: IncrementalState): Promise<void>;
+export declare function copyPublicDir(publicDir: string): Promise<void>;
+export declare function copyPublicDirIncremental(publicDir: string): Promise<void>;
+export declare function buildClientRuntime(minify: boolean): Promise<void>;
+export declare const ROUTE_ESBUILD_BASE: {
+    bundle: boolean;
+    write: boolean;
+    format: "esm";
+    target: string;
+    legalComments: "inline";
+    packages: "external";
+    external: string[];
+    loader: Record<string, "ts">;
+    plugins: esbuild.Plugin[];
+    minify: boolean;
+    treeShaking: boolean;
+};
+export declare function discoverApiRoutes(pagesDir: string): Promise<ApiRouteEntry[]>;
+export declare function discoverMiddlewares(pagesDir: string): Promise<MiddlewareEntry[]>;
+export declare function findAndCacheStatusCodePages(): Promise<StatusCodePageEntry[]>;
+export declare function transpileAllRoutes(routes: RouteInfo[], minify: boolean, skipServerKeys?: ReadonlySet<CacheKey>): Promise<Map<string, TranspiledRoute>>;
+export declare function loadLayoutFromCache(pathname: string, cacheKey: CacheKey): Promise<CompiledLayout>;
+export declare function loadRouteFromCache(entry: {
+    pageFile: string;
+    layouts: string[];
+    layoutCacheKeys: CacheKey[];
+    cacheKey: CacheKey;
+    pathname: string;
+}): Promise<CompiledRoute>;
+export {};
+//# sourceMappingURL=common.d.ts.map

package/dist/build/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/build/common.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAa9B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAqB/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAMrD,MAAM,MAAM,YAAY,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAI7D,KAAK,aAAa,GAAG;IACjB,aAAa,EAAG,KAAK,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,cAAc,EAAE,KAAK,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,cAAc,EAAE,KAAK,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,YAAY,EAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IACpC,SAAS,EAAO,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,GAAG,CAAA;KAAE,CAAC,CAAC;CACvD,CAAC;AAEF,eAAO,MAAM,aAAa,kCAAyC,CAAC;AAEpE,KAAK,cAAc,GAAG;IAClB,MAAM,EAAU,GAAG,CAAC;IACpB,aAAa,EAAG,KAAK,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,cAAc,EAAE,KAAK,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,cAAc,EAAE,KAAK,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,YAAY,EAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IACpC,SAAS,EAAO,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,GAAG,CAAA;KAAE,CAAC,CAAC;CACvD,CAAC;AAEF,wBAAsB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAYxE;AAgCD,MAAM,WAAW,aAAa;IAC1B,OAAO,EAAe,QAAQ,CAAC;IAC/B,QAAQ,EAAkB,CAAC,GAAG,MAAM,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAC3E,mBAAmB,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9C,QAAQ,EAAc,MAAM,CAAC;IAC7B,aAAa,EAAS,KAAK,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,cAAc,EAAQ,KAAK,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,cAAc,EAAQ,KAAK,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,YAAY,EAAU,KAAK,CAAC,YAAY,CAAC,CAAC;IAC1C,SAAS,EAAa,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,GAAG,CAAA;KAAE,CAAC,CAAC;CAC7D;AAED,MAAM,WAAW,cAAe,SAAQ,aAAa;CAAG;AAExD,MAAM,WAAW,eAAe;IAC5B,QAAQ,EAAU,MAAM,CAAC;IACzB,QAAQ,EAAU,MAAM,CAAC;IACzB,OAAO,EAAW,MAAM,EAAE,CAAC;IAC3B,UAAU,EAAQ,MAAM,CAAC;IACzB,aAAa,EAAK,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,MAAM,CAAA;CAAE,CAAC;AAEpE,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAEvD;AAED,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,QAAQ,CAI/D;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAE7D;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,QAAQ,GAAO,MAAM,CAAiD;AACzG,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,QAAQ,GAAI,MAAM,CAAqD;AAC7G,wBAAgB,aAAa,CAAC,GAAG,EAAE,QAAQ,GAAO,MAAM,CAAiD;AACzG,wBAAgB,eAAe,CAAC,GAAG,EAAE,QAAQ,GAAK,MAAM,CAA0D;AAElH,MAAM,WAAW,aAAa;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAM,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAChC,QAAQ,EAAS,MAAM,CAAC;IACxB,OAAO,EAAU,MAAM,EAAE,CAAC;IAC1B,eAAe,EAAE,QAAQ,EAAE,CAAC;IAC5B,QAAQ,EAAS,QAAQ,CAAC;CAC7B;AAED,UAAU,cAAc;IACpB,QAAQ,EAAU,MAAM,CAAC;IACzB,OAAO,EAAW,MAAM,EAAE,CAAC;IAC3B,eAAe,EAAG,QAAQ,EAAE,CAAC;IAC7B,QAAQ,EAAU,QAAQ,CAAC;IAC3B,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACpD,IAAI,EAAc,QAAQ,CAAC;IAC3B,QAAQ,EAAU,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IACxD,IAAI,EAAc,YAAY,CAAC;IAC/B,QAAQ,EAAU,MAAM,CAAC;IACzB,eAAe,EAAG,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACrD,IAAI,EAAc,SAAS,CAAC;IAC5B,QAAQ,EAAU,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,oBAAoB,GAAG,iBAAiB,CAAC;AAErF,MAAM,WAAW,QAAQ;IACrB,SAAS,EAAS,MAAM,CAAC;IACzB,MAAM,EAAY,UAAU,EAAE,CAAC;IAC/B,eAAe,EAAG,mBAAmB,EAAE,CAAC;IACxC,SAAS,EAAS,aAAa,EAAE,CAAC;IAClC,WAAW,EAAO,eAAe,EAAE,CAAC;CACvC;AAED,wBAAsB,aAAa,CAAC,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA+CjG;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED,wBAAsB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAG9D;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAIxD;AAED,wBAAsB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAiBvE;AAED,wBAAsB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAGvE;AAED,MAAM,WAAW,gBAAgB;IAC7B,UAAU,EAAQ,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC5C;AAED,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAOtE;AAED,wBAAsB,oBAAoB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAIjF;AAED,wBAAsB,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGpE;AAED,wBAAsB,wBAAwB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAgC/E;AAED,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAavE;AAED,eAAO,MAAM,kBAAkB;;;;;;;;YAQqB,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC;;;;CAIvE,CAAC;AAeF,wBAAsB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAUlF;AAED,wBAAsB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAOtF;AAoCD,wBAAsB,2BAA2B,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC,CA+FlF;AAED,wBAAsB,kBAAkB,CACpC,MAAM,EAAE,SAAS,EAAE,EACnB,MAAM,EAAE,OAAO,EACf,cAAc,GAAE,WAAW,CAAC,QAAQ,CAAa,GAClD,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAiJvC;AAED,wBAAsB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,CA2CvG;AAED,wBAAsB,kBAAkB,CAAC,KAAK,EAAE;IAC5C,QAAQ,EAAS,MAAM,CAAC;IACxB,OAAO,EAAU,MAAM,EAAE,CAAC;IAC1B,eAAe,EAAE,QAAQ,EAAE,CAAC;IAC5B,QAAQ,EAAS,QAAQ,CAAC;IAC1B,QAAQ,EAAS,MAAM,CAAC;CAC3B,GAAG,OAAO,CAAC,aAAa,CAAC,CAsCzB"}