@gyoll/adapter-solid-router 0.2.0

package/README.md

@@ -0,0 +1,167 @@
+# @gyoll/adapter-solid-router
+
+Solid Router adapter for Gyoll file-based routing.
+
+## Installation
+
+```bash
+pnpm add @gyoll/adapter-solid-router @gyoll/runtime
+pnpm add solid-js @solidjs/router  # peer dependencies
+```
+
+## Usage
+
+```javascript
+import { render } from "solid-js/web";
+import { initFileRoutes } from "@gyoll/runtime";
+import { solidRouterAdapter } from "@gyoll/adapter-solid-router";
+import { routes } from "./gyoll-manifest.js";
+
+const RouterComponent = await initFileRoutes({
+  routes,
+  adapter: solidRouterAdapter,
+});
+
+render(() => <RouterComponent />, document.getElementById("root"));
+```
+
+## File-Based Routing Conventions
+
+### Supported Files
+
+- **`page.jsx`** - Route component (lazy-loaded automatically)
+- **`layout.jsx`** - Wraps child routes
+- **Route groups** - `(group)` directories don't affect URLs
+- **Dynamic segments** - `[id]` becomes `:id`
+- **Catch-all routes** - `[...slug]` becomes `*`
+
+### Example Structure
+
+```
+src/routes/
+├── page.jsx              → /
+├── about/
+│   └── page.jsx          → /about
+├── blog/
+│   ├── layout.jsx        → wraps all /blog/* routes
+│   ├── page.jsx          → /blog
+│   └── [slug]/
+│       └── page.jsx      → /blog/:slug
+└── (auth)/
+    ├── login/
+    │   └── page.jsx      → /login (group doesn't affect URL)
+    └── register/
+        └── page.jsx      → /register
+```
+
+## Framework-Specific Behavior
+
+### Error Handling
+
+Solid Router does **not** support error boundaries at the route configuration level. Use Solid's `<ErrorBoundary>` component in your layouts or pages:
+
+```jsx
+// layout.jsx
+import { ErrorBoundary } from "solid-js";
+
+export default function Layout(props) {
+  return (
+    <ErrorBoundary fallback={(err) => <div>Error: {err.message}</div>}>
+      {props.children}
+    </ErrorBoundary>
+  );
+}
+```
+
+### Loading States
+
+Solid Router automatically integrates with `<Suspense>` boundaries. All components are lazy-loaded, so wrap your layout with Suspense:
+
+```jsx
+// layout.jsx
+import { Suspense } from "solid-js";
+
+export default function Layout(props) {
+  return (
+    <Suspense fallback={<div>Loading...</div>}>
+      {props.children}
+    </Suspense>
+  );
+}
+```
+
+### Data Loading
+
+Export a `routeData` or `loader` function from your page components:
+
+```jsx
+// page.jsx
+export async function routeData() {
+  const response = await fetch("/api/data");
+  return response.json();
+}
+
+export default function Page(props) {
+  const data = props.data; // Access loaded data
+  return <div>{data.title}</div>;
+}
+```
+
+## Unsupported Features
+
+Due to Solid Router's design, the following Gyoll conventions are **not supported**:
+
+- ❌ `error.jsx` - Use `<ErrorBoundary>` components instead
+- ❌ `loading.jsx` - Use `<Suspense>` components instead
+
+These are handled at the component level in Solid, not the route configuration level.
+
+## API
+
+### `solidRouterAdapter`
+
+```javascript
+{
+  createRouter(routes, options),  // Returns Router component
+  transformRoutes(routes)         // Transforms manifest to Solid format
+}
+```
+
+### Router Options
+
+Pass options to Solid Router's `<Router>`:
+
+```javascript
+const RouterComponent = await initFileRoutes({
+  routes,
+  adapter: solidRouterAdapter,
+  routerOptions: {
+    root: App,              // Root component
+    base: "/app",          // Base path
+    // ... other Router props
+  },
+});
+```
+
+## Layout Wrapping
+
+Layouts automatically wrap their child routes:
+
+```jsx
+// routes/dashboard/layout.jsx
+export default function DashboardLayout(props) {
+  return (
+    <div class="dashboard">
+      <nav>Dashboard Nav</nav>
+      {props.children}
+    </div>
+  );
+}
+
+// routes/dashboard/page.jsx
+export default function Dashboard() {
+  return <h1>Dashboard Home</h1>;
+}
+
+// Result: Dashboard page wrapped in DashboardLayout
+```

package/build-output/index.cjs

@@ -0,0 +1 @@
+var c=Object.defineProperty;var u=Object.getOwnPropertyDescriptor;var d=Object.getOwnPropertyNames;var f=Object.prototype.hasOwnProperty;var y=(n,o)=>{for(var t in o)c(n,t,{get:o[t],enumerable:!0})},h=(n,o,t,e)=>{if(o&&typeof o=="object"||typeof o=="function")for(let r of d(o))!f.call(n,r)&&r!==t&&c(n,r,{get:()=>o[r],enumerable:!(e=u(o,r))||e.enumerable});return n};var R=n=>h(c({},"__esModule",{value:!0}),n);var g={};y(g,{solidRouterAdapter:()=>w});module.exports=R(g);var a=require("solid-js"),p=require("@solidjs/router");function i(n){return n.map(o=>{let t={path:o.path};if(o.component&&(t.component=(0,a.lazy)(o.component)),o.layout){let e=(0,a.lazy)(o.layout);t.component?t.component=(0,a.lazy)(async()=>{let[s,m]=await Promise.all([o.layout(),o.component()]);return{default:l=>React.createElement(s.default,null,React.createElement(m.default,{...l}))}}):t.component=e}return o.component&&(t.load=async()=>{let e=await o.component();return e.loader||e.routeData}),o.children&&o.children.length>0&&(t.children=i(o.children)),t})}var w={createRouter(n,o={}){return t=>React.createElement(p.Router,{...o},n)},transformRoutes:i,registerRoutes(n,o){throw new Error("Solid Router does not support runtime route registration. Use createRouter() instead.")}};

package/build-output/index.d.ts

@@ -0,0 +1,23 @@
+export namespace solidRouterAdapter {
+    /**
+     * Creates a Solid Router instance (returns component)
+     * @param {Array} routes - Transformed routes
+     * @param {object} options - Router options
+     * @returns {Function} Router component
+     */
+    export function createRouter(routes: any[], options?: object): Function;
+    export { transformRoutes };
+    /**
+     * Register routes with existing router (if needed)
+     * @param {object} router - Existing router instance
+     * @param {Array} routes - Transformed routes
+     */
+    export function registerRoutes(router: object, routes: any[]): never;
+}
+/**
+ * Transforms file-routes format to Solid Router format
+ * @param {Array} routes - Routes from manifest
+ * @returns {Array} Solid Router route objects
+ */
+declare function transformRoutes(routes: any[]): any[];
+export {};

package/build-output/index.js

@@ -0,0 +1 @@
+import{lazy as r}from"solid-js";import{Router as s}from"@solidjs/router";function a(n){return n.map(o=>{let t={path:o.path};if(o.component&&(t.component=r(o.component)),o.layout){let e=r(o.layout);t.component?t.component=r(async()=>{let[c,p]=await Promise.all([o.layout(),o.component()]);return{default:i=>React.createElement(c.default,null,React.createElement(p.default,{...i}))}}):t.component=e}return o.component&&(t.load=async()=>{let e=await o.component();return e.loader||e.routeData}),o.children&&o.children.length>0&&(t.children=a(o.children)),t})}var d={createRouter(n,o={}){return t=>React.createElement(s,{...o},n)},transformRoutes:a,registerRoutes(n,o){throw new Error("Solid Router does not support runtime route registration. Use createRouter() instead.")}};export{d as solidRouterAdapter};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@gyoll/adapter-solid-router",
+  "version": "0.2.0",
+  "type": "module",
+  "description": "Solid Router adapter for Gyoll file-based routing",
+  "main": "./build-output/index.cjs",
+  "module": "./build-output/index.js",
+  "types": "./build-output/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./build-output/index.d.ts",
+      "import": "./build-output/index.js",
+      "require": "./build-output/index.cjs"
+    }
+  },
+  "files": [
+    "build-output/",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "routing",
+    "@solidjs/router",
+    "solid-js",
+    "solid",
+    "adapter",
+    "gyoll"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/scottlindeman/public.git",
+    "directory": "01_projects/gyoll/adapters-react-router-dom"
+  },
+  "peerDependencies": {
+    "@gyoll/runtime": "^0.1.0",
+    "solid-js": "^1.9.10",
+    "@solidjs/router": "latest"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "scripts": {
+    "build": "node build.js",
+    "types": "tsc --declaration --emitDeclarationOnly --outDir build-output",
+    "test:unit": "vitest run --dir tests/unit",
+    "test:integration": "vitest run --dir tests/integration"
+  }
+}