vorzelajs 0.0.1

package/README.md

@@ -0,0 +1,188 @@
+# VorzelaJs
+
+Batteries-included SolidJS framework with file-based routing, streamed SSR, server-only boundaries, and zero config.
+
+## Create a New App
+
+```bash
+npm create vorzelajs@latest my-app
+cd my-app
+npm install
+npm run dev
+```
+
+You'll be prompted for:
+
+- **Template** — `modern` (multi-page with nav) or `bare` (single landing page)
+- **Styling** — `tailwindcss`, `css-modules`, or `css`
+
+## Manual Setup
+
+```bash
+mkdir my-app && cd my-app
+npm init -y
+npm install vorzelajs solid-js
+```
+
+Add scripts to `package.json`:
+
+```json
+{
+  "scripts": {
+    "dev": "vorzelajs dev",
+    "build": "vorzelajs build",
+    "serve": "NODE_ENV=production vorzelajs serve"
+  }
+}
+```
+
+Create your first route:
+
+```tsx
+// src/routes/__root.tsx
+import { createRootRoute, Outlet } from 'vorzelajs'
+
+export const Route = createRootRoute({
+  component: () => <Outlet />,
+})
+```
+
+```tsx
+// src/routes/index.tsx
+import { createFileRoute } from 'vorzelajs'
+
+export const Route = createFileRoute('/')({
+  component: () => <h1>Hello VorzelaJs</h1>,
+  head: () => ({ title: 'Home' }),
+})
+```
+
+Add a stylesheet at `src/styles.css` and run `npm run dev`.
+
+## Project Structure
+
+```
+src/
+├── routes/         # File-based routes (pages and layouts)
+├── components/     # Reusable UI components
+├── lib/            # Helpers, API clients, utilities
+├── styles.css      # Global styles
+```
+
+You own `src/`. The framework handles Vite config, server, SSR entry, and document shell.
+
+## Features
+
+- **File-based routing** — Drop a file in `src/routes/` and it becomes a route with automatic code splitting
+- **Streamed SSR** — Server-rendered HTML streams to the browser with selective hydration per route branch
+- **Server-only boundaries** — `.server.ts` files and route `loader`/`beforeLoad` are stripped from the client bundle
+- **Payload navigation** — Client navigations fetch JSON payloads instead of full page reloads
+- **Head management** — Per-route `<title>`, `<meta>`, `<link>`, canonical URLs, and JSON-LD
+- **Cookie & session helpers** — `createCookie()`, `createCookieSessionStorage()` via `vorzelajs/server`
+- **Analytics** — First-party analytics with `defineAnalytics()` and `createAnalyticsClient()`
+- **SEO** — Robots.txt, sitemap.xml, and structured data built in
+- **Security headers** — CSP with nonces, HSTS, X-Frame-Options, and more out of the box
+- **Zero config** — No `vite.config.ts` or `server.ts` to maintain
+
+## Routes
+
+### Basic Route
+
+```tsx
+import { createFileRoute } from 'vorzelajs'
+
+export const Route = createFileRoute('/about')({
+  component: AboutPage,
+  head: () => ({
+    title: 'About',
+    meta: [{ name: 'description', content: 'About us' }],
+  }),
+})
+
+function AboutPage() {
+  return <h1>About</h1>
+}
+```
+
+### Route with Server Loader
+
+```tsx
+import { createFileRoute } from 'vorzelajs'
+import { db } from '~/lib/db.server'
+
+export const Route = createFileRoute('/posts')({
+  loader: async () => {
+    const posts = await db.posts.findMany()
+    return { posts }
+  },
+  component: PostsPage,
+})
+
+function PostsPage() {
+  const { posts } = Route.useLoaderData()
+  return <ul>{posts.map((p) => <li>{p.title}</li>)}</ul>
+}
+```
+
+### Dynamic Routes
+
+```
+src/routes/posts/$postId.tsx  → /posts/:postId
+src/routes/users/$userId.tsx  → /users/:userId
+```
+
+Access params with `Route.useParams()`.
+
+### Pathless Layouts
+
+Prefix with `_` to create layout wrappers without adding a URL segment:
+
+```
+src/routes/_auth.tsx          → layout (no URL segment)
+src/routes/_auth/login.tsx    → /login
+src/routes/_auth/register.tsx → /register
+```
+
+## Server Exports
+
+Import server helpers from `vorzelajs/server`:
+
+```tsx
+import { createCookie, defineAnalytics, defineRobotsConfig } from 'vorzelajs/server'
+```
+
+## Styling
+
+The framework detects your styling choice automatically:
+
+- **Tailwind CSS** — Install `tailwindcss` + `@tailwindcss/vite` and add `@import "tailwindcss"` to `styles.css`
+- **CSS Modules** — Create `*.module.css` files (Vite handles them natively)
+- **Plain CSS** — Write global CSS in `styles.css`
+
+Bring your own fonts. The default font stack is system fonts.
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `vorzelajs dev` | Start dev server with HMR |
+| `vorzelajs build` | Build client and server for production |
+| `vorzelajs serve` | Serve the production build |
+
+## Vite Escape Hatch
+
+For advanced use cases, import the plugin directly:
+
+```ts
+// vite.config.ts
+import { vorzelaPlugin } from 'vorzelajs/vite'
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  plugins: [vorzelaPlugin()],
+})
+```
+
+## License
+
+MIT

package/bin/vorzelajs.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import('../dist/cli/index.js')

package/dist/analytics.d.ts

@@ -0,0 +1,132 @@
+import type { CookieOptions } from './cookie';
+type MaybePromise<T> = T | Promise<T>;
+export declare const DEFAULT_ANALYTICS_ENDPOINT = "/__vorzela/analytics";
+export type AnalyticsEventType = 'event' | 'pageview';
+export type AnalyticsTrafficChannel = 'direct' | 'email' | 'internal' | 'organic-search' | 'organic-social' | 'paid-search' | 'paid-social' | 'referral' | 'unknown';
+export interface AnalyticsTouchPoint {
+    campaign: string | null;
+    capturedAt: string;
+    channel: AnalyticsTrafficChannel;
+    clickIds: Record<string, string>;
+    content: string | null;
+    entryUrl: string;
+    isPaid: boolean;
+    medium: string | null;
+    platform: string | null;
+    referrer: string | null;
+    referrerHost: string | null;
+    source: string | null;
+    term: string | null;
+}
+export interface AnalyticsClientContext {
+    language?: string | null;
+    screen?: {
+        height: number;
+        width: number;
+    } | null;
+    sessionId?: string | null;
+    timezone?: string | null;
+    visitorId?: string | null;
+}
+export interface AnalyticsClientPayload {
+    context?: AnalyticsClientContext;
+    firstTouch?: AnalyticsTouchPoint | null;
+    lastTouch?: AnalyticsTouchPoint | null;
+    name?: string;
+    pathname?: string;
+    properties?: Record<string, unknown>;
+    referrer?: string | null;
+    search?: string;
+    timestamp?: string;
+    title?: string | null;
+    type?: AnalyticsEventType;
+    url?: string;
+}
+export interface AnalyticsUserAgentSummary {
+    browser: string | null;
+    browserVersion: string | null;
+    deviceType: 'bot' | 'desktop' | 'mobile' | 'tablet' | 'unknown';
+    isBot: boolean;
+    os: string | null;
+    platformHint: string | null;
+    raw: string | null;
+}
+export interface AnalyticsGeoSummary {
+    city: string | null;
+    country: string | null;
+    region: string | null;
+}
+export interface AnalyticsEvent {
+    attribution: AnalyticsTouchPoint;
+    client: {
+        language: string | null;
+        screen: AnalyticsClientContext['screen'];
+        timezone: string | null;
+    };
+    firstTouch: AnalyticsTouchPoint | null;
+    id: string;
+    lastTouch: AnalyticsTouchPoint | null;
+    name: string;
+    occurredAt: string;
+    page: {
+        pathname: string | null;
+        referrer: string | null;
+        search: string;
+        title: string | null;
+        url: string | null;
+    };
+    properties: Record<string, unknown>;
+    receivedAt: string;
+    request: {
+        host: string | null;
+        origin: string | null;
+        referer: string | null;
+        secFetchSite: string | null;
+    };
+    sessionId: string | null;
+    type: AnalyticsEventType;
+    userAgent: AnalyticsUserAgentSummary;
+    visitorId: string;
+    geo: AnalyticsGeoSummary | null;
+}
+export interface AnalyticsDefinition {
+    allowedOrigins?: string[] | ((origin: string | null, request: Request) => boolean);
+    onEvent?: (event: AnalyticsEvent, context: {
+        payload: AnalyticsClientPayload;
+        request: Request;
+    }) => MaybePromise<void>;
+    visitorCookie?: false | {
+        name?: string;
+        options?: CookieOptions;
+    };
+}
+export interface AnalyticsClientOptions {
+    credentials?: RequestCredentials;
+    endpoint?: string;
+    firstTouchKey?: string;
+    includeLanguage?: boolean;
+    includeScreen?: boolean;
+    includeTimezone?: boolean;
+    lastTouchKey?: string;
+    sessionKey?: string;
+    storageKey?: string;
+    transport?: 'auto' | 'beacon' | 'fetch';
+}
+export interface AnalyticsClient {
+    event: (name: string, properties?: Record<string, unknown>, payload?: Omit<AnalyticsClientPayload, 'name' | 'properties' | 'type'>) => Promise<boolean>;
+    pageview: (payload?: Omit<AnalyticsClientPayload, 'name' | 'type'>) => Promise<boolean>;
+    startAutoPageviews: (options?: {
+        trackInitialPageview?: boolean;
+    }) => () => void;
+    track: (payload: AnalyticsClientPayload) => Promise<boolean>;
+}
+export declare function classifyAnalyticsTraffic(input: {
+    landingUrl?: string | URL | null;
+    referrer?: string | null;
+}): AnalyticsTouchPoint;
+export declare function extractAnalyticsTouchPoint(landingUrl: string | URL, referrer?: string | null): AnalyticsTouchPoint;
+export declare function defineAnalytics(options: AnalyticsDefinition): AnalyticsDefinition;
+export declare function handleAnalyticsRequest(request: Request, analytics: AnalyticsDefinition): Promise<Response>;
+export declare function createAnalyticsClient(options?: AnalyticsClientOptions): AnalyticsClient;
+export {};
+//# sourceMappingURL=analytics.d.ts.map

package/dist/analytics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../src/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAG7C,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;AAwErC,eAAO,MAAM,0BAA0B,yBAAyB,CAAA;AAEhE,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,UAAU,CAAA;AACrD,MAAM,MAAM,uBAAuB,GAC/B,QAAQ,GACR,OAAO,GACP,UAAU,GACV,gBAAgB,GAChB,gBAAgB,GAChB,aAAa,GACb,aAAa,GACb,UAAU,GACV,SAAS,CAAA;AAEb,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,uBAAuB,CAAA;IAChC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE;QACP,MAAM,EAAE,MAAM,CAAA;QACd,KAAK,EAAE,MAAM,CAAA;KACd,GAAG,IAAI,CAAA;IACR,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,CAAC,EAAE,sBAAsB,CAAA;IAChC,UAAU,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;IACvC,SAAS,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;IACtC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,IAAI,CAAC,EAAE,kBAAkB,CAAA;IACzB,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,UAAU,EAAE,KAAK,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAA;IAC/D,KAAK,EAAE,OAAO,CAAA;IACd,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IACjB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,mBAAmB,CAAA;IAChC,MAAM,EAAE;QACN,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB,MAAM,EAAE,sBAAsB,CAAC,QAAQ,CAAC,CAAA;QACxC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;KACxB,CAAA;IACD,UAAU,EAAE,mBAAmB,GAAG,IAAI,CAAA;IACtC,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,mBAAmB,GAAG,IAAI,CAAA;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB,MAAM,EAAE,MAAM,CAAA;QACd,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;QACpB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;KACnB,CAAA;IACD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;QACnB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;QACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;QACtB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;KAC5B,CAAA;IACD,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,IAAI,EAAE,kBAAkB,CAAA;IACxB,SAAS,EAAE,yBAAyB,CAAA;IACpC,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,mBAAmB,GAAG,IAAI,CAAA;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,CAAA;IAClF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE;QAAE,OAAO,EAAE,sBAAsB,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,YAAY,CAAC,IAAI,CAAC,CAAA;IACvH,aAAa,CAAC,EAAE,KAAK,GAAG;QACtB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,OAAO,CAAC,EAAE,aAAa,CAAA;KACxB,CAAA;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,kBAAkB,CAAA;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAA;CACxC;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,sBAAsB,EAAE,MAAM,GAAG,YAAY,GAAG,MAAM,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IACvJ,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,sBAAsB,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IACvF,kBAAkB,EAAE,CAAC,OAAO,CAAC,EAAE;QAAE,oBAAoB,CAAC,EAAE,OAAO,CAAA;KAAE,KAAK,MAAM,IAAI,CAAA;IAChF,KAAK,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CAC7D;AA2ID,wBAAgB,wBAAwB,CAAC,KAAK,EAAE;IAC9C,UAAU,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,IAAI,CAAA;IAChC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,GAAG,mBAAmB,CAyCtB;AAED,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,uBAK5F;AAoVD,wBAAgB,eAAe,CAAC,OAAO,EAAE,mBAAmB,GAAG,mBAAmB,CAEjF;AAED,wBAAsB,sBAAsB,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAyDhH;AAiFD,wBAAgB,qBAAqB,CAAC,OAAO,GAAE,sBAA2B,GAAG,eAAe,CA2F3F"}