@contentrail/vite 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ContentRail contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,66 @@
-# Temporary Holding Version
+# `@contentrail/vite`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Vite plugin that loads and validates ContentRail local JSON at build/dev time.
+
+- **Node.js ≥ 22**
+- Peer: `vite@^6.0.0 || ^7.0.0 || ^8.0.0` (verified with Vite **8.3.5**)
+- Depends on `@contentrail/core` and `@contentrail/reader`
+
+## Install
+
+> **Not on the public npm registry yet.** See `docs/PUBLISHING.md`.
+
+### Monorepo (current)
+
+```sh
+pnpm install
+pnpm --filter @contentrail/vite build
+```
+
+### Intended after first public `0.1.0` release
+
+```sh
+pnpm add @contentrail/core @contentrail/reader @contentrail/vite zod
+pnpm add -D vite@^8
+```
+
+## Usage
+
+```ts
+// vite.config.ts
+import { defineConfig } from "vite";
+import { contentrail } from "@contentrail/vite";
+import { articles } from "./content/config";
+
+export default defineConfig({
+  plugins: [
+    contentrail({
+      rootDir: "content",
+      collections: { articles },
+    }),
+  ],
+});
+```
+
+```ts
+// browser / app code
+import { entries } from "virtual:contentrail/articles";
+// entries: { id: string; data: Article }[]
+// sourcePath and filesystem details are not included
+```
+
+Add a TypeScript declaration:
+
+```ts
+declare module "virtual:contentrail/articles" {
+  import type { InferEntry } from "@contentrail/core";
+  import type { articles } from "../content/config";
+  export const entries: Array<{
+    id: string;
+    data: InferEntry<typeof articles>;
+  }>;
+  export default entries;
+}
+```
+
+Invalid JSON or schema failures throw during `vite build` / `vite dev` transform.

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import type { ContentCollection } from "@contentrail/core";
+import { ContentReadError, type LoadCollectionOptions } from "@contentrail/reader";
+import type { Plugin } from "vite";
+export interface ContentrailViteOptions {
+    /** Path to the content root (resolved against Vite `root`). */
+    readonly rootDir: string;
+    /** Map of virtual module name → collection definition. */
+    readonly collections: Readonly<Record<string, ContentCollection>>;
+    readonly loadOptions?: LoadCollectionOptions;
+}
+export interface PublicContentEntry<TData> {
+    readonly id: string;
+    readonly data: TData;
+}
+/**
+ * Returns the virtual module id for a configured collection name.
+ * Example: `contentrailVirtual("articles")` → `virtual:contentrail/articles`
+ */
+export declare function contentrailVirtual(collectionKey: string): string;
+/**
+ * Vite plugin that validates local JSON at build/dev time and exposes
+ * browser-safe `{ id, data }[]` modules (no filesystem paths).
+ */
+export declare function contentrail(options: ContentrailViteOptions): Plugin;
+export { ContentReadError };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAc,MAAM,mBAAmB,CAAC;AACvE,OAAO,EACL,gBAAgB,EAGhB,KAAK,qBAAqB,EAC3B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAKnC,MAAM,WAAW,sBAAsB;IACrC,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAClE,QAAQ,CAAC,WAAW,CAAC,EAAE,qBAAqB,CAAC;CAC9C;AAED,MAAM,WAAW,kBAAkB,CAAC,KAAK;IACvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;CACtB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CAEhE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,sBAAsB,GAAG,MAAM,CA+CnE;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/index.js

@@ -0,0 +1,50 @@
+import path from "node:path";
+import { ContentReadError, createLocalJsonSource, loadCollection, } from "@contentrail/reader";
+const VIRTUAL_PREFIX = "virtual:contentrail/";
+const RESOLVED_PREFIX = `\0${VIRTUAL_PREFIX}`;
+/**
+ * Returns the virtual module id for a configured collection name.
+ * Example: `contentrailVirtual("articles")` → `virtual:contentrail/articles`
+ */
+export function contentrailVirtual(collectionKey) {
+    return `${VIRTUAL_PREFIX}${collectionKey}`;
+}
+/**
+ * Vite plugin that validates local JSON at build/dev time and exposes
+ * browser-safe `{ id, data }[]` modules (no filesystem paths).
+ */
+export function contentrail(options) {
+    let viteRoot = process.cwd();
+    return {
+        name: "contentrail",
+        configResolved(config) {
+            viteRoot = config.root;
+        },
+        resolveId(id) {
+            if (id.startsWith(VIRTUAL_PREFIX)) {
+                return `\0${id}`;
+            }
+            return undefined;
+        },
+        async load(id) {
+            if (!id.startsWith(RESOLVED_PREFIX)) {
+                return undefined;
+            }
+            const collectionKey = id.slice(RESOLVED_PREFIX.length);
+            const collection = options.collections[collectionKey];
+            if (collection === undefined) {
+                throw new ContentReadError("MISSING_COLLECTION", `No ContentRail collection configured for virtual module "${collectionKey}".`, { collection: collectionKey });
+            }
+            const absoluteRoot = path.resolve(viteRoot, options.rootDir);
+            const source = await createLocalJsonSource({ rootDir: absoluteRoot });
+            const entries = await loadCollection(source, collection, options.loadOptions);
+            const publicEntries = entries.map((entry) => ({
+                id: entry.id,
+                data: entry.data,
+            }));
+            return `export const entries = ${JSON.stringify(publicEntries)};\nexport default entries;\n`;
+        },
+    };
+}
+export { ContentReadError };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,cAAc,GAEf,MAAM,qBAAqB,CAAC;AAG7B,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAC9C,MAAM,eAAe,GAAG,KAAK,cAAc,EAAE,CAAC;AAe9C;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,aAAqB;IACtD,OAAO,GAAG,cAAc,GAAG,aAAa,EAAE,CAAC;AAC7C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,OAA+B;IACzD,IAAI,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAE7B,OAAO;QACL,IAAI,EAAE,aAAa;QACnB,cAAc,CAAC,MAAM;YACnB,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;QACzB,CAAC;QACD,SAAS,CAAC,EAAE;YACV,IAAI,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;gBAClC,OAAO,KAAK,EAAE,EAAE,CAAC;YACnB,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE;YACX,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;gBACpC,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,MAAM,aAAa,GAAG,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YACvD,MAAM,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;YACtD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,IAAI,gBAAgB,CACxB,oBAAoB,EACpB,4DAA4D,aAAa,IAAI,EAC7E,EAAE,UAAU,EAAE,aAAa,EAAE,CAC9B,CAAC;YACJ,CAAC;YAED,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YAC7D,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;YACtE,MAAM,OAAO,GAAG,MAAM,cAAc,CAClC,MAAM,EACN,UAAU,EACV,OAAO,CAAC,WAAW,CACpB,CAAC;YAEF,MAAM,aAAa,GAEf,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAC1B,EAAE,EAAE,KAAK,CAAC,EAAE;gBACZ,IAAI,EAAE,KAAK,CAAC,IAAI;aACjB,CAAC,CAAC,CAAC;YAEJ,OAAO,0BAA0B,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,8BAA8B,CAAC;QAC/F,CAAC;KACF,CAAC;AACJ,CAAC;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,55 @@
 {
   "name": "@contentrail/vite",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "private": false,
+  "type": "module",
+  "description": "Vite plugin that loads ContentRail local JSON at build time.",
+  "license": "MIT",
+  "engines": {
+    "node": ">=22"
+  },
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "node": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@contentrail/reader": "0.1.0",
+    "@contentrail/core": "0.1.0"
+  },
+  "peerDependencies": {
+    "vite": "^6.0.0 || ^7.0.0 || ^8.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.20.5",
+    "typescript": "5.9.3",
+    "vite": "8.3.5",
+    "zod": "3.25.76"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Hridhin-k/contentrail.git",
+    "directory": "packages/vite"
+  },
+  "bugs": {
+    "url": "https://github.com/Hridhin-k/contentrail/issues"
+  },
+  "homepage": "https://github.com/Hridhin-k/contentrail#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "pnpm run build && tsc -p tsconfig.test.json && node --test test-dist/**/*.test.js"
+  }
 }