@tschk/moonshine-framework 0.3.1

package/README.md

@@ -0,0 +1,30 @@
+# `@tschk/moonshine-framework`
+
+Public framework contracts shared by the router, compiler, server, renderers,
+and deployment adapters.
+
+```ts
+import {
+  defineConfig,
+  defineRoute,
+  MANIFEST_VERSION,
+} from "@tschk/moonshine-framework";
+
+const route = defineRoute({
+  id: "home",
+  path: "/",
+  file: "src/routes/index.tsx",
+});
+
+const config = defineConfig({ runtime: "bun", mode: "auto" });
+```
+
+Exports include:
+
+- `RouteDefinition`, `RenderMode`, `RuntimeTarget`
+- `MoonshineManifest`, `RouteArtifact`, `MANIFEST_VERSION`
+- `Renderer`, `RenderContext`, `DeploymentAdapter`
+- `defineConfig`, `defineRoute`
+
+See [docs/MANIFEST.md](../../docs/MANIFEST.md) and
+[DESIGN.md](../../DESIGN.md).

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@tschk/moonshine-framework",
+  "version": "0.3.1",
+  "license": "ISC",
+  "type": "module",
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "scripts": {
+    "format": "bunx prettier --check .",
+    "lint": "bunx oxlint .",
+    "typecheck": "bunx tsc --noEmit",
+    "test": "bun test"
+  },
+  "dependencies": {
+    "@tschk/moonshine": "^0.3.1"
+  },
+  "devDependencies": {
+    "@types/bun": "1.3.14",
+    "typescript": "7.0.2"
+  }
+}

package/src/adapter.ts

@@ -0,0 +1,13 @@
+import type { MoonshineManifest } from "./manifest";
+import type { RouteDefinition, RuntimeTarget } from "./routes";
+
+export type DeploymentAdapter = {
+  name: string;
+  runtimes: RuntimeTarget[];
+  capabilities: MoonshineManifest["capabilities"];
+  build(manifest: MoonshineManifest, outDir: string): Promise<void>;
+};
+
+export function defineRoute<T extends RouteDefinition>(route: T): T {
+  return route;
+}

package/src/config.ts

@@ -0,0 +1,10 @@
+import type { RenderMode, RuntimeTarget } from "./routes";
+
+export type MoonshineConfig = {
+  mode?: RenderMode;
+  runtime?: RuntimeTarget;
+};
+
+export function defineConfig<T extends MoonshineConfig>(config: T): T {
+  return config;
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from "./adapter";
+export * from "./config";
+export * from "./manifest";
+export * from "./renderer";
+export * from "./routes";

package/src/manifest.ts

@@ -0,0 +1,23 @@
+import type { RenderMode, RouteDefinition, RuntimeTarget } from "./routes";
+
+export const MANIFEST_VERSION = 1 as const;
+
+export type RouteArtifact = RouteDefinition & {
+  mode: Exclude<RenderMode, "auto">;
+  runtime: RuntimeTarget;
+  decision: string;
+  serverEntry?: string;
+  clientEntries: string[];
+  staticOutput?: string;
+  cache?: { control?: string; revalidate?: number };
+  headers?: Record<string, string>;
+};
+
+export type MoonshineManifest = {
+  version: typeof MANIFEST_VERSION;
+  frameworkVersion: string;
+  routes: RouteArtifact[];
+  assets: Array<{ path: string; file: string; integrity?: string }>;
+  entries: { server?: string; client?: string };
+  capabilities: Array<"streaming" | "islands" | "edge" | "revalidation">;
+};

package/src/renderer.ts

@@ -0,0 +1,15 @@
+import type { RouteArtifact } from "./manifest";
+
+export type RenderContext = {
+  request: Request;
+  route: RouteArtifact;
+  params: Record<string, string>;
+  data: unknown;
+  signal: AbortSignal;
+};
+
+export type Renderer = {
+  name: string;
+  render(context: RenderContext): Promise<Response>;
+  prerender(context: RenderContext): Promise<string>;
+};

package/src/routes.ts

@@ -0,0 +1,14 @@
+export type RenderMode = "auto" | "static" | "ssr" | "island" | "spa" | "api";
+export type RuntimeTarget = "bun" | "node" | "cloudflare" | "vercel-edge";
+
+export type RouteDefinition = {
+  id: string;
+  path: string;
+  file: string;
+  mode?: RenderMode;
+  runtime?: RuntimeTarget;
+  layouts?: string[];
+  middleware?: string[];
+  errorBoundary?: string;
+  dataFile?: string;
+};

package/test/contracts.test.ts

@@ -0,0 +1,13 @@
+import { expect, test } from "bun:test";
+import { defineConfig, defineRoute, MANIFEST_VERSION } from "../src";
+
+test("contracts preserve exact input and version one", () => {
+  const route = defineRoute({
+    id: "home",
+    path: "/",
+    file: "src/routes/index.tsx",
+  });
+  expect(route.path).toBe("/");
+  expect(defineConfig({ mode: "auto" }).mode).toBe("auto");
+  expect(MANIFEST_VERSION).toBe(1);
+});

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["src/**/*", "test/**/*"]
+}