@absolutejs/absolute 0.8.14 → 0.9.0

package/README.md

@@ -1,34 +1,161 @@
-# AbsoluteJS
+# Absolute JS
 
-## Introduction
+Full‑stack, **type‑safe** batteries‑included platform that lets you **server‑side render _any_ modern front‑end**—React, Svelte, plain HTML, HTMX (Vue & Angular coming)—with a single Bun‑powered build step.
 
-AbsoluteJS is a revolutionary JavaScript framework designed to unify all past, present, and future JavaScript frameworks into one powerful environment. It's powered by Bun and Elysia, providing a seamless and efficient development experience.
+[![bun-required](https://img.shields.io/badge/runtime-bun%401.x-yellowgreen?logo=bun)](https://bun.sh)
+[![elysia-required](https://img.shields.io/badge/server-elysia%40latest-blue?logo=elysia)](https://elysiajs.com)
+![license](https://img.shields.io/badge/license-CC%20BY--NC%204.0-lightgrey)
 
-## Features
+---
 
-- **Unified Environment**: AbsoluteJS brings together all JavaScript frameworks, allowing developers to use any framework within one environment.
-- **Powered by Bun and Elysia**: Leveraging the power of Bun and Elysia, AbsoluteJS provides a robust and efficient development experience.
-- **Future-Proof**: AbsoluteJS is designed to accommodate future JavaScript frameworks, making it a sustainable choice for JavaScript development.
+## Why Absolute JS?
 
-## Getting Started
+- **Universal SSR.** Bring your favourite UI layer; Absolute JS handles bundling, hydration, and HTML streaming.
+- **One build, one manifest.** Call `build()` once—get a manifest mapping every page’s client and server assets, ready to wire into routes.
+- **End‑to‑end type safety.** A unified source of truth for your types—from the database, through the server, and all the way to the client—so you can be certain of the data shape at every step.
+- **Zero‑config philosophy.** Point the build at your folders; sane defaults light up everything else.
+- **Plugin power.** Extend with standard Elysia plugins—ship auth, logging, i18n, and more. First‑party: `absolute-auth`, `networkingPlugin`.
 
-1. **Installation**: Provide instructions on how to install AbsoluteJS.
-2. **Basic Usage**: Give a simple example of how to use AbsoluteJS.
+---
 
-## Documentation
+## Requirements
 
-Link to your detailed documentation here.
+| Tool       | Version | Purpose                                     |
+| ---------- | ------- | ------------------------------------------- |
+| **Bun**    | ≥ 1.2   | Runtime, bundler, and TypeScript transpiler |
+| **Elysia** | latest  | Web server & middleware platform            |
 
-## Contributing
+---
 
-Provide guidelines on how contributors can help improve AbsoluteJS.
+## Installation
 
-## License
+```bash
+bun add @absolutejs/absolute
+```
+
+---
+
+## Quick Start
+
+```ts
+// example/server.ts
+import { staticPlugin } from '@elysiajs/static';
+import { Elysia } from 'elysia';
+import { file } from 'bun';
+import { build } from 'absolutejs/core/build';
+import {
+	handleHTMLPageRequest,
+	handleReactPageRequest,
+	handleSveltePageRequest
+} from 'absolutejs/core/pageHandlers';
+
+import { ReactExample } from './react/pages/ReactExample';
+import SvelteExample from './svelte/pages/SvelteExample.svelte';
+import { networkingPlugin } from 'absolutejs';
+
+const manifest = await build({
+	assetsDirectory: 'example/assets',
+	buildDirectory: 'example/build',
+	htmlDirectory: 'example/html',
+	htmxDirectory: 'example/htmx',
+	reactDirectory: 'example/react',
+	svelteDirectory: 'example/svelte',
+	options: { preserveIntermediateFiles: true }
+});
+
+if (!manifest) throw new Error('Manifest generation failed');
+
+let counter = 0;
+
+export const server = new Elysia()
+	.use(staticPlugin({ assets: './example/build', prefix: '' }))
+
+	// HTML
+	.get('/', () =>
+		handleHTMLPageRequest('./example/build/html/pages/HtmlExample.html')
+	)
+
+	// React
+	.get('/react', () =>
+		handleReactPageRequest(ReactExample, manifest['ReactExampleIndex'], {
+			test: 123
+		})
+	)
+
+	// Svelte
+	.get('/svelte', () =>
+		handleSveltePageRequest(SvelteExample, manifest, { test: 456 })
+	)
+
+	// HTMX demo
+	.get('/htmx', () => file('./example/build/htmx/HtmxHome.html'))
+	.get('/htmx/increment', () => new Response(String(++counter)))
+
+	.use(networkingPlugin)
+	.on('error', (error) => {
+		const { request } = error;
+		console.error(
+			`Server error on ${request.method} ${request.url}: ${error.message}`
+		);
+	});
+```
+
+### How it works
+
+1. **`build()`** scans your project, bundles each framework, and returns a **manifest** that has the server, and client assets required to serve each route.
+2. Route handlers (`handleReactPageRequest`, `handleSveltePageRequest`, …) stream HTML and inject scripts/assets based on that manifest.
+3. The static plugin serves all compiled files from `/build`.
 
-Include information about your license here.
+---
 
-## Contact
+## Plugin System
 
-Provide contact information or links to your social media profiles here.
+Absolute JS piggybacks on the [Elysia plugin API](https://elysiajs.com/plugins). Any Elysia plugin works out of the box; Absolute adds helpers for:
+
+| Plugin                 | Description                                                                                                                     |
+| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| **`absolute-auth`**    | Full OAuth2 flow configured with 66 providers and allows full customizability with event handlers                               |
+| **`networkingPlugin`** | Starts your Elysia server with HOST/PORT defaults and adds a --host flag to toggle listening on localhost or your LAN interface |
+
+---
+
+## Configuration Philosophy
+
+Everything funnels through a single `build()` call:
+
+```ts
+await build({
+	reactDirectory: 'src/react',
+	svelteDirectory: 'src/svelte',
+	htmlDirectory: 'src/html',
+	htmxDirectory: 'src/htmx',
+	assetsDirectory: 'public/assets',
+	options: { preserveIntermediateFiles: false }
+});
+```
+
+No separate config files or environment variables—just explicit arguments with sensible defaults.
+
+---
+
+## Roadmap
+
+- **Vue** and **Angular** handlers
+- Hot‑reload development server
+- First‑class Docker images & hosting recipes
+
+---
+
+## Contributing
+
+Pull requests and issues are welcome! Whether it’s a new plugin, framework handler, or docs improvement:
+
+1. Fork & branch.
+2. `bun install && bun test`.
+3. Submit a PR with a clear description.
+
+---
+
+## License
 
-We hope you enjoy using AbsoluteJS as much as we enjoyed building it!
+Creative Commons **CC BY‑NC 4.0** – see [`LICENSE`](./LICENSE) for details.

package/dist/build/compileVue.d.ts

@@ -0,0 +1,5 @@
+export declare const compileVue: (entryPoints: string[], outputDirectory: string) => Promise<{
+    vueClientPaths: string[];
+    vueCssPaths: Record<string, string[]>;
+    vueServerPaths: string[];
+}>;

package/dist/{src/build → build}/generateManifest.d.ts

@@ -1,2 +1,2 @@
 import { BuildArtifact } from 'bun';
-export declare const generateManifest: (outputs: BuildArtifact[], buildDirectoryAbsolute: string, svelteDirName?: string) => Record<string, string>;
+export declare const generateManifest: (outputs: BuildArtifact[], buildDirectoryAbsolute: string) => Record<string, string>;

package/dist/core/build.d.ts

@@ -0,0 +1,4 @@
+import { BuildConfig } from '../types';
+export declare const build: ({ buildDirectory, assetsDirectory, reactDirectory, htmlDirectory, htmxDirectory, svelteDirectory, vueDirectory, tailwind, options }: BuildConfig) => Promise<{
+    [x: string]: string | string[];
+} | null>;

package/dist/{src/core → core}/index.d.ts

@@ -1,2 +1,3 @@
 export * from './build';
 export * from './pageHandlers';
+export * from './lookup';

package/dist/core/lookup.d.ts

@@ -0,0 +1,2 @@
+export declare const asset: (manifest: Record<string, string | string[]>, name: string) => string;
+export declare const assets: (manifest: Record<string, string | string[]>, name: string) => string[];

package/dist/core/pageHandlers.d.ts

@@ -0,0 +1,14 @@
+import { ComponentType as ReactComponent } from 'react';
+import { Component as SvelteComponent } from 'svelte';
+import { Component as VueComponent } from 'vue';
+import { PropsArgs } from '../types';
+export declare const handleReactPageRequest: <Props extends Record<string, unknown> = Record<never, never>>(pageComponent: ReactComponent<Props>, index: string, ...props: keyof Props extends never ? [] : [props: Props]) => Promise<Response>;
+type HandleSveltePageRequest = {
+    (PageComponent: SvelteComponent<Record<string, never>>, pagePath: string, indexPath: string): Promise<Response>;
+    <P extends Record<string, unknown>>(PageComponent: SvelteComponent<P>, pagePath: string, indexPath: string, props: P): Promise<Response>;
+};
+export declare const handleSveltePageRequest: HandleSveltePageRequest;
+export declare const handleVuePageRequest: <Props extends Record<string, unknown> = Record<never, never>>(_PageComponent: VueComponent<Props>, pagePath: string, indexPath: string, ...props: keyof Props extends never ? [] : [props: Props]) => Promise<Response>;
+export declare const handleHTMLPageRequest: (html: string) => Bun.BunFile;
+export declare const handlePageRequest: <Component>(PageComponent: Component, ...props: PropsArgs<Component>) => void;
+export {};

package/dist/{src/index.d.ts → index.d.ts}

@@ -1,4 +1,4 @@
 export * from './constants';
-export * from './core/index';
+export * from './core';
 export * from './plugins/index';
 export * from './utils/index';