@evjs/manifest 0.0.0

package/README.md

@@ -0,0 +1,45 @@
+# @evjs/manifest
+
+Shared manifest schema types for the **ev** framework build system.
+
+## Installation
+
+```bash
+npm install @evjs/manifest
+```
+
+## Purpose
+
+Defines the structure of the unified manifest file emitted by `@evjs/webpack-plugin` and consumed by `@evjs/runtime`. A single `dist/manifest.json` contains both server and client build metadata:
+
+## Manifest (v1)
+
+```json
+{
+  "version": 1,
+  "server": {
+    "entry": "main.a1b2c3d4.js",
+    "fns": {
+      "<fnId>": {
+        "moduleId": "f9b6...",
+        "export": "getUsers"
+      }
+    }
+  },
+  "client": {
+    "js": ["main.abc123.js"],
+    "css": ["main.def456.css"]
+  }
+}
+```
+
+## Exported Types
+
+- **`Manifest`** — unified manifest (`dist/manifest.json`) with `server` and `client` sections.
+- **`ServerManifestSection`** — server section (`{ entry, fns, rsc? }`).
+- **`ClientManifestSection`** — client section (`{ js, css, pages? }`).
+- **`ServerFnEntry`** — server function metadata (`{ moduleId, export }`).
+- **`RscEntry`** — React Server Components (reserved for future).
+- **`PageEntry`** — per-page assets for MPA (reserved for future).
+- **`ServerManifest`** — deprecated alias, use `Manifest` instead.
+- **`ClientManifest`** — deprecated alias, use `Manifest` instead.

package/esm/index.d.ts

@@ -0,0 +1,72 @@
+/**
+ * @evjs/manifest
+ *
+ * Shared manifest schemas for the ev framework build system.
+ *
+ * A single unified manifest is emitted to `dist/manifest.json`,
+ * containing both server and client build metadata.
+ */
+/** Base manifest fields shared by all environment manifests. */
+interface ManifestBase {
+    /** Schema version — bump on breaking changes. */
+    version: 1;
+}
+/** A registered server function entry. */
+export interface ServerFnEntry {
+    /** Webpack module identifier (hash-based, no source paths exposed). */
+    moduleId: string;
+    /** Exported function name. */
+    export: string;
+}
+/** A React Server Component entry (future — reserved). */
+export interface RscEntry {
+    /** Webpack module ID. */
+    moduleId: string;
+    /** Exported component name. */
+    export: string;
+}
+/** Server section of the manifest. */
+export interface ServerManifestSection {
+    /** Server bundle entry filename (e.g. "main.js" or "main.a1b2c3d4.js"). */
+    entry: string;
+    /** Registered server functions (fnId → module + export). */
+    fns: Record<string, ServerFnEntry>;
+    /** React Server Components (future — reserved). */
+    rsc?: Record<string, RscEntry>;
+}
+/** Per-page asset entry for MPA support (future — reserved). */
+export interface PageEntry {
+    /** JavaScript bundle paths for this page. */
+    js: string[];
+    /** CSS bundle paths for this page. */
+    css: string[];
+}
+/** Client section of the manifest. */
+export interface ClientManifestSection {
+    /** JavaScript bundle paths for HTML injection. */
+    js: string[];
+    /** CSS bundle paths for HTML injection. */
+    css: string[];
+    /** Per-page assets for MPA support (future — reserved). */
+    pages?: Record<string, PageEntry>;
+}
+/**
+ * Unified manifest — emitted to `dist/manifest.json`.
+ *
+ * Contains both server and client build metadata in a single file.
+ */
+export interface Manifest extends ManifestBase {
+    /** Server build metadata (entry, server functions, RSC). */
+    server: ServerManifestSection;
+    /** Client build metadata (bundles, CSS, pages). Optional until client manifest is implemented. */
+    client?: ClientManifestSection;
+}
+/**
+ * @deprecated Use `Manifest` instead. Kept for backward compatibility.
+ */
+export type ServerManifest = ManifestBase & ServerManifestSection;
+/**
+ * @deprecated Use `Manifest` instead. Kept for backward compatibility.
+ */
+export type ClientManifest = ManifestBase & ClientManifestSection;
+export {};

package/esm/index.js

@@ -0,0 +1,9 @@
+/**
+ * @evjs/manifest
+ *
+ * Shared manifest schemas for the ev framework build system.
+ *
+ * A single unified manifest is emitted to `dist/manifest.json`,
+ * containing both server and client build metadata.
+ */
+export {};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@evjs/manifest",
+  "version": "0.0.0",
+  "description": "Shared manifest types for the ev framework",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./esm/index.js",
+  "exports": {
+    ".": {
+      "types": "./esm/index.d.ts",
+      "import": "./esm/index.js",
+      "require": "./esm/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "check-types": "tsc --noEmit"
+  },
+  "files": [
+    "esm"
+  ],
+  "keywords": [
+    "evjs",
+    "manifest",
+    "server-functions"
+  ],
+  "author": "xusd320",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.7.3"
+  },
+  "homepage": "https://github.com/evaijs/evjs#readme",
+  "bugs": {
+    "url": "https://github.com/evaijs/evjs/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/evaijs/evjs.git"
+  }
+}