npm - @janit/fu - Versions diffs - 0.0.2 - Mend

@janit/fu 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

package/dist/types.d.ts ADDED Viewed

@@ -0,0 +1,87 @@
+/** One client asset the HTML shell should reference. */
+export interface Asset {
+    href: string;
+}
+/** Client assets for a page, as produced by a driver. */
+export interface Assets {
+    js: Asset[];
+    css: Asset[];
+}
+/**
+ * Document metadata the shell renders into `<head>`.
+ *
+ * Middleware and route handlers both write here; it is deliberately separate
+ * from user `state` so the shell's contract stays explicit and typing an app's
+ * own state does not mean re-declaring these.
+ */
+export interface Head {
+    title?: string;
+    description?: string;
+    canonical?: string;
+    /** `<meta name="robots">` content, e.g. "noindex, nofollow". */
+    robots?: string;
+    /** og:image URL. */
+    image?: string;
+    /** `<html lang>`; defaults to "en". */
+    lang?: string;
+    /** Raw `<link>` descriptors, e.g. hreflang alternates or preloads. */
+    links?: Record<string, string>[];
+    /** Serialized as a JSON-LD script tag when present. */
+    jsonLd?: unknown;
+}
+/** A request that failed, normalised for the error page. */
+export interface RouteError {
+    status: number;
+    /** Safe to render. For a 500 this is generic, never the underlying message. */
+    message: string;
+    /** What was actually thrown. Log it; do not render it. */
+    cause?: unknown;
+}
+/** Request context handed to middleware, handlers and page components. */
+export interface Ctx<S = Record<string, unknown>> {
+    req: Request;
+    url: URL;
+    /** Route params. Empty until routing has run, so middleware sees `{}`. */
+    params: Record<string, string>;
+    /** Whatever the app puts here. Shared across middleware, handler and page. */
+    state: S;
+    /** Document metadata for the shell. */
+    head: Head;
+    /** Value returned by the route's matching handler, if any. */
+    data?: unknown;
+    /** Set only when rendering the error page. */
+    error?: RouteError;
+    /** Run the rest of the chain. Returns the Response for outer middleware. */
+    next(): Promise<Response>;
+}
+/**
+ * A middleware. Return a Response to short-circuit, or `ctx.next()` to
+ * continue — optionally awaiting it first to inspect or mutate the result.
+ * Registration order is outermost first, so the first registered unwinds last.
+ */
+export type Middleware<S = Record<string, unknown>> = (ctx: Ctx<S>) => Response | Promise<Response>;
+/** What a page component receives. */
+export type PageContext<S = Record<string, unknown>> = Ctx<S>;
+/** A route handler: return a Response to short-circuit, or data for the page. */
+export type RouteHandler<S = Record<string, unknown>> = (ctx: Ctx<S>) => unknown | Promise<unknown>;
+/** A user-authored route module. */
+export interface RouteModule<S = Record<string, unknown>> {
+    default?: (ctx: Ctx<S>) => unknown;
+    handlers?: Record<string, RouteHandler<S>>;
+}
+/**
+ * Lazy map of route file path to module loader — the only shape the core needs
+ * from a driver. Keys are root-relative, e.g. "/routes/blog/[slug].tsx".
+ */
+export type RouteManifest<S = Record<string, unknown>> = Record<string, () => Promise<RouteModule<S>>>;
+/** Options shared by the dev and build drivers. */
+export interface FuOptions {
+    /** Project root containing `routes/` and `islands/`. */
+    root: string;
+    /** Dev server port. Defaults to 1337. */
+    port?: number;
+    /** Dev server bind address. Defaults to 0.0.0.0 (all interfaces). */
+    hostname?: string;
+    /** Build output directory. Defaults to `<root>/.output`. */
+    outDir?: string;
+}

package/dist/types.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export {};
2	+ //# sourceMappingURL=types.js.map

package/dist/types.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json ADDED Viewed

@@ -0,0 +1,98 @@
+{
+  "name": "@janit/fu",
+  "version": "0.0.2",
+  "type": "module",
+  "description": "A minimal islands framework on Preact 11, rolldown and Nitro. Runs on Deno, Node and Bun.",
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "types": "./dist/mod.d.ts",
+      "default": "./dist/mod.js"
+    },
+    "./build": {
+      "types": "./dist/build.d.ts",
+      "default": "./dist/build.js"
+    },
+    "./dev": {
+      "types": "./dist/dev.d.ts",
+      "default": "./dist/dev.js"
+    },
+    "./client": {
+      "types": "./dist/client.d.ts",
+      "default": "./dist/client.js"
+    },
+    "./render": {
+      "types": "./dist/render.d.ts",
+      "default": "./dist/render.js"
+    },
+    "./router": {
+      "types": "./dist/router.d.ts",
+      "default": "./dist/router.js"
+    },
+    "./plugins": {
+      "types": "./dist/plugins.d.ts",
+      "default": "./dist/plugins.js"
+    },
+    "./errors": {
+      "types": "./dist/errors.d.ts",
+      "default": "./dist/errors.js"
+    },
+    "./cli": {
+      "types": "./dist/cli.d.ts",
+      "default": "./dist/cli.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "fu": "./src/cli.ts"
+  },
+  "dependencies": {
+    "crossws": "^0.4.12",
+    "lightningcss": "^1.33.0",
+    "nitro": "^3.0.260903-beta",
+    "preact-render-to-string": "^6.7.0",
+    "rolldown": "^1.2.7",
+    "urlpattern-polyfill": "^10.1.0"
+  },
+  "peerDependencies": {
+    "@preact/signals": "^2",
+    "preact": "^11.0.0-rc.1"
+  },
+  "devDependencies": {
+    "@preact/signals": "^2.11.2",
+    "@types/node": "^26.4.1",
+    "preact": "11.0.0-rc.1",
+    "typescript": "^7.0.2"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "types": "./dist/mod.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/janit/fu.git"
+  },
+  "homepage": "https://github.com/janit/fu",
+  "bugs": {
+    "url": "https://github.com/janit/fu/issues"
+  },
+  "keywords": [
+    "islands",
+    "preact",
+    "ssr",
+    "rolldown",
+    "nitro",
+    "deno",
+    "framework"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && cp src/hmr-runtime.js dist/hmr-runtime.js",
+    "prepack": "rm -rf dist && npm run build"
+  },
+  "main": "./dist/mod.js"
+}

package/src/cli.ts ADDED Viewed

@@ -0,0 +1,25 @@
+#!/usr/bin/env -S deno run -A
+import { build } from "./build.ts";
+import { dev } from "./dev.ts";
+export async function main(argv: string[]): Promise<void> {
+  const [cmd = "dev", ...rest] = argv;
+  const portArg = rest.find((a) => a.startsWith("--port="));
+  const hostArg = rest.find((a) => a.startsWith("--host="));
+  const rootArg = rest.find((a) => !a.startsWith("-"));
+  const opts = {
+    root: rootArg ?? Deno?.cwd?.() ?? process.cwd(),
+    port: portArg ? Number(portArg.slice("--port=".length)) : undefined,
+    hostname: hostArg ? hostArg.slice("--host=".length) : undefined,
+  };
+  if (cmd === "build") await build(opts);
+  else if (cmd === "dev") await dev(opts);
+  else {
+    console.error(`fu: unknown command "${cmd}" (expected dev|build)`);
+    throw new Error(`unknown command: ${cmd}`);
+  }
+}
+declare const Deno: { cwd?: () => string } | undefined;
+if (import.meta.main) await main(globalThis.process?.argv.slice(2) ?? []);