litestar-vite 0.1.1__py3-none-any.whl → 0.15.0rc2__py3-none-any.whl

litestar_vite/scaffolding/templates.py

@@ -0,0 +1,437 @@
+"""Framework template definitions for scaffolding.
+
+This module defines the available framework templates and their configurations.
+"""
+
+from collections.abc import Callable
+from dataclasses import dataclass, field
+from enum import Enum
+
+
+def _str_list_factory() -> list[str]:
+    return []
+
+
+class FrameworkType(str, Enum):
+    """Supported frontend framework types."""
+
+    REACT = "react"
+    REACT_ROUTER = "react-router"
+    REACT_TANSTACK = "react-tanstack"
+    REACT_INERTIA = "react-inertia"
+    VUE = "vue"
+    VUE_INERTIA = "vue-inertia"
+    SVELTE = "svelte"
+    SVELTE_INERTIA = "svelte-inertia"
+    SVELTEKIT = "sveltekit"
+    NUXT = "nuxt"
+    ASTRO = "astro"
+    HTMX = "htmx"
+    ANGULAR = "angular"
+    ANGULAR_CLI = "angular-cli"
+
+
+_ListStrFactory: Callable[[], list[str]] = _str_list_factory
+
+
+@dataclass
+class FrameworkTemplate:
+    """Configuration for a frontend framework template.
+
+    Attributes:
+        name: Display name for the template
+        type: Framework type enum
+        description: Brief description shown in selection UI
+        vite_plugin: Name of the Vite plugin import (if any)
+        dependencies: NPM dependencies to install
+        dev_dependencies: NPM dev dependencies to install
+        files: List of template files to generate
+        uses_typescript: Whether TypeScript is used by default
+        has_ssr: Whether SSR is supported
+        inertia_compatible: Whether it works with Inertia.js
+        uses_vite: Whether the template is Vite-based (skip base files when False)
+        resource_dir: Preferred source directory name for the framework
+    """
+
+    name: str
+    type: FrameworkType
+    description: str
+    vite_plugin: "str | None" = None
+    dependencies: list[str] = field(default_factory=_ListStrFactory)
+    dev_dependencies: list[str] = field(default_factory=_ListStrFactory)
+    files: list[str] = field(default_factory=_ListStrFactory)
+    uses_typescript: bool = True
+    has_ssr: bool = False
+    inertia_compatible: bool = False
+    uses_vite: bool = True
+    resource_dir: str = "resources"
+
+
+FRAMEWORK_TEMPLATES: dict[FrameworkType, FrameworkTemplate] = {
+    FrameworkType.REACT: FrameworkTemplate(
+        name="React",
+        type=FrameworkType.REACT,
+        description="React 18+ with TypeScript and Vite",
+        vite_plugin="@vitejs/plugin-react",
+        dependencies=["react", "react-dom"],
+        dev_dependencies=["@vitejs/plugin-react", "@types/react", "@types/react-dom", "typescript"],
+        files=[
+            "vite.config.ts",
+            "tsconfig.json",
+            "package.json",
+            "index.html",
+            "src/main.tsx",
+            "src/App.tsx",
+            "src/App.css",
+        ],
+        uses_typescript=True,
+        has_ssr=False,
+        inertia_compatible=True,
+        resource_dir="src",
+    ),
+    FrameworkType.REACT_ROUTER: FrameworkTemplate(
+        name="React + React Router",
+        type=FrameworkType.REACT_ROUTER,
+        description="React 18+ with React Router for SPA routing",
+        vite_plugin="@vitejs/plugin-react",
+        dependencies=["react", "react-dom", "react-router-dom"],
+        dev_dependencies=["@vitejs/plugin-react", "@types/react", "@types/react-dom", "typescript"],
+        files=[
+            "vite.config.ts",
+            "tsconfig.json",
+            "package.json",
+            "index.html",
+            "src/main.tsx",
+            "src/App.tsx",
+            "src/App.css",
+        ],
+        uses_typescript=True,
+        has_ssr=False,
+        inertia_compatible=False,
+        resource_dir="src",
+    ),
+    FrameworkType.REACT_TANSTACK: FrameworkTemplate(
+        name="React + TanStack Router",
+        type=FrameworkType.REACT_TANSTACK,
+        description="React 18+ with TanStack Router (file-based), Zod, and API client",
+        vite_plugin="@vitejs/plugin-react",
+        dependencies=["react", "react-dom", "@tanstack/react-router", "zod"],
+        dev_dependencies=[
+            "@vitejs/plugin-react",
+            "@tanstack/router-plugin",
+            "@hey-api/openapi-ts",
+            "@types/react",
+            "@types/react-dom",
+            "typescript",
+        ],
+        files=[
+            "vite.config.ts",
+            "tsconfig.json",
+            "package.json",
+            "index.html",
+            "src/main.tsx",
+            "src/routes/__root.tsx",
+            "src/routes/index.tsx",
+            "src/routes/books.tsx",
+            "src/routeTree.gen.ts",
+            "src/App.css",
+            "openapi-ts.config.ts",
+        ],
+        uses_typescript=True,
+        has_ssr=False,
+        inertia_compatible=False,
+        resource_dir="src",
+    ),
+    FrameworkType.REACT_INERTIA: FrameworkTemplate(
+        name="React + Inertia.js",
+        type=FrameworkType.REACT_INERTIA,
+        description="React 18+ with Inertia.js for server-side routing",
+        vite_plugin="@vitejs/plugin-react",
+        dependencies=["react", "react-dom", "@inertiajs/react"],
+        dev_dependencies=["@vitejs/plugin-react", "@types/react", "@types/react-dom", "typescript", "vite"],
+        files=[
+            "vite.config.ts",
+            "tsconfig.json",
+            "package.json",
+            "index.html",
+            "resources/main.tsx",
+            "resources/ssr.tsx",
+            "resources/pages/Home.tsx",
+            "resources/App.css",
+        ],
+        uses_typescript=True,
+        has_ssr=True,
+        inertia_compatible=True,
+        resource_dir="resources",
+    ),
+    FrameworkType.VUE: FrameworkTemplate(
+        name="Vue 3",
+        type=FrameworkType.VUE,
+        description="Vue 3 with Composition API and TypeScript",
+        vite_plugin="@vitejs/plugin-vue",
+        dependencies=["vue"],
+        dev_dependencies=["@vitejs/plugin-vue", "vue-tsc", "typescript"],
+        files=[
+            "vite.config.ts",
+            "tsconfig.json",
+            "package.json",
+            "index.html",
+            "env.d.ts",
+            "src/main.ts",
+            "src/App.vue",
+            "src/style.css",
+        ],
+        uses_typescript=True,
+        has_ssr=False,
+        inertia_compatible=True,
+        resource_dir="src",
+    ),
+    FrameworkType.VUE_INERTIA: FrameworkTemplate(
+        name="Vue + Inertia.js",
+        type=FrameworkType.VUE_INERTIA,
+        description="Vue 3 with Inertia.js for server-side routing",
+        vite_plugin="@vitejs/plugin-vue",
+        dependencies=["vue", "@inertiajs/vue3"],
+        dev_dependencies=["@vitejs/plugin-vue", "vue-tsc", "typescript"],
+        files=[
+            "vite.config.ts",
+            "tsconfig.json",
+            "package.json",
+            "index.html",
+            "env.d.ts",
+            "resources/main.ts",
+            "resources/ssr.ts",
+            "resources/pages/Home.vue",
+            "resources/style.css",
+        ],
+        uses_typescript=True,
+        has_ssr=True,
+        inertia_compatible=True,
+        resource_dir="resources",
+    ),
+    FrameworkType.SVELTE: FrameworkTemplate(
+        name="Svelte 5",
+        type=FrameworkType.SVELTE,
+        description="Svelte 5 with runes and TypeScript",
+        vite_plugin="@sveltejs/vite-plugin-svelte",
+        dependencies=["svelte"],
+        dev_dependencies=["@sveltejs/vite-plugin-svelte", "svelte-check", "typescript", "tslib"],
+        files=[
+            "vite.config.ts",
+            "svelte.config.js",
+            "tsconfig.json",
+            "package.json",
+            "index.html",
+            "src/main.ts",
+            "src/App.svelte",
+            "src/app.css",
+        ],
+        uses_typescript=True,
+        has_ssr=False,
+        inertia_compatible=True,
+        resource_dir="src",
+    ),
+    FrameworkType.SVELTE_INERTIA: FrameworkTemplate(
+        name="Svelte + Inertia.js",
+        type=FrameworkType.SVELTE_INERTIA,
+        description="Svelte 5 with Inertia.js for server-side routing",
+        vite_plugin="@sveltejs/vite-plugin-svelte",
+        dependencies=["svelte", "@inertiajs/svelte"],
+        dev_dependencies=["@sveltejs/vite-plugin-svelte", "svelte-check", "typescript", "tslib"],
+        files=[
+            "vite.config.ts",
+            "svelte.config.js",
+            "tsconfig.json",
+            "package.json",
+            "index.html",
+            "resources/main.ts",
+            "resources/pages/Home.svelte",
+            "resources/app.css",
+        ],
+        uses_typescript=True,
+        has_ssr=False,
+        inertia_compatible=True,
+        resource_dir="resources",
+    ),
+    FrameworkType.SVELTEKIT: FrameworkTemplate(
+        name="SvelteKit",
+        type=FrameworkType.SVELTEKIT,
+        description="SvelteKit with Litestar API backend",
+        vite_plugin="litestar-vite-plugin/sveltekit",
+        dependencies=["svelte", "@sveltejs/kit"],
+        dev_dependencies=[
+            "@sveltejs/vite-plugin-svelte",
+            "@sveltejs/adapter-auto",
+            "svelte-check",
+            "typescript",
+            "tslib",
+            "litestar-vite-plugin",
+        ],
+        files=[
+            "vite.config.ts",
+            "svelte.config.js",
+            "tsconfig.json",
+            "src/app.html",
+            "src/app.css",
+            "src/hooks.server.ts",
+            "src/routes/+page.svelte",
+            "src/routes/+layout.svelte",
+        ],
+        uses_typescript=True,
+        has_ssr=True,
+        inertia_compatible=False,
+    ),
+    FrameworkType.NUXT: FrameworkTemplate(
+        name="Nuxt 3",
+        type=FrameworkType.NUXT,
+        description="Nuxt 3 with Litestar API backend",
+        vite_plugin=None,
+        dependencies=["nuxt", "vue"],
+        dev_dependencies=["typescript", "vue-tsc", "litestar-vite-plugin"],
+        files=["nuxt.config.ts", "app.vue", "pages/index.vue", "composables/useApi.ts"],
+        uses_typescript=True,
+        has_ssr=True,
+        inertia_compatible=False,
+    ),
+    FrameworkType.ASTRO: FrameworkTemplate(
+        name="Astro",
+        type=FrameworkType.ASTRO,
+        description="Astro with Litestar API backend",
+        vite_plugin="litestar-vite-plugin/astro",
+        dependencies=["astro"],
+        dev_dependencies=["typescript", "litestar-vite-plugin"],
+        files=["astro.config.mjs", "src/pages/index.astro", "src/layouts/Layout.astro", "src/styles/global.css"],
+        uses_typescript=True,
+        has_ssr=True,
+        inertia_compatible=False,
+    ),
+    FrameworkType.HTMX: FrameworkTemplate(
+        name="HTMX",
+        type=FrameworkType.HTMX,
+        description="Server-rendered HTML with HTMX",
+        vite_plugin=None,
+        dependencies=["htmx.org"],
+        dev_dependencies=["typescript"],
+        files=["vite.config.ts", "resources/main.js", "templates/base.html.j2", "templates/index.html.j2"],
+        uses_typescript=False,
+        has_ssr=False,
+        inertia_compatible=False,
+        resource_dir="resources",
+    ),
+    FrameworkType.ANGULAR: FrameworkTemplate(
+        name="Angular (Vite)",
+        type=FrameworkType.ANGULAR,
+        description="Angular 21+ with Vite (zoneless signals)",
+        vite_plugin="@analogjs/vite-plugin-angular",
+        dependencies=[
+            "@angular/animations",
+            "@angular/common",
+            "@angular/compiler",
+            "@angular/core",
+            "@angular/forms",
+            "@angular/platform-browser",
+            "rxjs",
+        ],
+        dev_dependencies=[
+            "@analogjs/vite-plugin-angular",
+            "@angular/build",
+            "@angular/compiler-cli",
+            "@angular/platform-browser-dynamic",
+            "typescript",
+            "@types/node",
+        ],
+        files=[
+            "vite.config.ts",
+            "tsconfig.json",
+            "tsconfig.app.json",
+            "package.json",
+            "index.html",
+            "src/main.ts",
+            "src/styles.css",
+            "src/app/app.component.ts",
+            "src/app/app.component.html",
+            "src/app/app.component.css",
+            "src/app/app.config.ts",
+        ],
+        uses_typescript=True,
+        has_ssr=False,
+        inertia_compatible=False,
+        uses_vite=True,
+        resource_dir="src",
+    ),
+    FrameworkType.ANGULAR_CLI: FrameworkTemplate(
+        name="Angular CLI",
+        type=FrameworkType.ANGULAR_CLI,
+        description="Angular 21+ with zoneless signals and TailwindCSS (Angular CLI)",
+        vite_plugin=None,
+        dependencies=[
+            "@angular/animations",
+            "@angular/common",
+            "@angular/compiler",
+            "@angular/core",
+            "@angular/forms",
+            "@angular/platform-browser",
+            "@angular/platform-browser-dynamic",
+            "rxjs",
+            "@tailwindcss/postcss",
+            "tailwindcss",
+        ],
+        dev_dependencies=[
+            "@angular-devkit/build-angular",
+            "@angular/cli",
+            "@angular/compiler-cli",
+            "@types/node",
+            "typescript",
+            "postcss",
+            "autoprefixer",
+        ],
+        files=[
+            "angular.json",
+            "tsconfig.json",
+            "tsconfig.app.json",
+            "tsconfig.spec.json",
+            "package.json",
+            "proxy.conf.json",
+            ".postcssrc.json",
+            "tailwind.config.js",
+            "src/index.html",
+            "src/main.ts",
+            "src/styles.css",
+            "src/app/app.component.ts",
+            "src/app/app.component.html",
+            "src/app/app.component.css",
+            "src/app/app.config.ts",
+        ],
+        uses_typescript=True,
+        has_ssr=False,
+        inertia_compatible=False,
+        uses_vite=False,
+        resource_dir="src",
+    ),
+}
+
+
+def get_available_templates() -> list[FrameworkTemplate]:
+    """Get all available framework templates.
+
+    Returns:
+        List of available FrameworkTemplate instances.
+    """
+    return list(FRAMEWORK_TEMPLATES.values())
+
+
+def get_template(framework_type: "FrameworkType | str") -> "FrameworkTemplate | None":
+    """Get a specific framework template.
+
+    Args:
+        framework_type: The framework type (enum or string).
+
+    Returns:
+        The FrameworkTemplate if found, None otherwise.
+    """
+    if isinstance(framework_type, FrameworkType):
+        return FRAMEWORK_TEMPLATES.get(framework_type)
+    try:
+        return FRAMEWORK_TEMPLATES.get(FrameworkType(framework_type))
+    except ValueError:
+        return None

litestar_vite/templates/addons/tailwindcss/tailwind.css.j2

@@ -0,0 +1 @@
+@import "tailwindcss";

litestar_vite/templates/angular/index.html.j2

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>{{ project_name }}</title>
+  </head>
+  <body>
+    <app-root></app-root>
+    <script type="module" src="/{{ resource_dir }}/main.ts"></script>
+  </body>
+</html>

litestar_vite/templates/angular/openapi-ts.config.ts.j2

@@ -0,0 +1,18 @@
+import { defineConfig } from "@hey-api/openapi-ts";
+
+export default defineConfig({
+  input: "./{{ resource_dir }}/generated/openapi.json",
+  output: "./{{ resource_dir }}/generated/api",
+  plugins: [
+    "@hey-api/typescript",
+    "@hey-api/schemas",
+    {
+      name: "@hey-api/sdk",
+      asClass: true,
+    },
+    "@hey-api/client-angular",
+{%- if generate_zod %}
+    "zod",
+{%- endif %}
+  ],
+});

litestar_vite/templates/angular/package.json.j2

@@ -0,0 +1,35 @@
+{
+  "name": "{{ project_name }}",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "serve": "vite preview",
+    "watch": "npm run serve"{% if generate_client %},
+    "generate-types": "openapi-ts"{% endif %}
+  },
+  "dependencies": {
+{%- for dep in dependencies %}
+    "{{ dep }}": "latest"{% if not loop.last or generate_zod %},{% endif %}
+{%- endfor %}
+{%- if generate_zod %}
+    "zod": "^4.1.13"
+{%- endif %}
+  },
+  "devDependencies": {
+{%- for dep in dev_dependencies %}
+    "{{ dep }}": "latest",
+{%- endfor %}
+{%- if use_tailwind %}
+    "@tailwindcss/vite": "^4.1.17",
+    "tailwindcss": "^4.1.17",
+{%- endif %}
+{%- if generate_client %}
+    "@hey-api/openapi-ts": "^0.88.0",
+{%- endif %}
+    "litestar-vite-plugin": "latest",
+    "vite": "^7.2.6"
+  }
+}

litestar_vite/templates/angular/src/app/app.component.css.j2

@@ -0,0 +1,3 @@
+:host {
+  display: block;
+}

litestar_vite/templates/angular/src/app/app.component.html.j2

@@ -0,0 +1 @@
+<main></main>

litestar_vite/templates/angular/src/app/app.component.ts.j2

@@ -0,0 +1,9 @@
+import { Component } from "@angular/core";
+
+@Component({
+  selector: "app-root",
+  standalone: true,
+  templateUrl: "./app.component.html",
+  styleUrl: "./app.component.css",
+})
+export class AppComponent {}

litestar_vite/templates/angular/src/app/app.config.ts.j2

@@ -0,0 +1,5 @@
+import type { ApplicationConfig } from "@angular/core";
+
+export const appConfig: ApplicationConfig = {
+  providers: [],
+};

litestar_vite/templates/angular/src/main.ts.j2

@@ -0,0 +1,9 @@
+import { bootstrapApplication } from "@angular/platform-browser";
+
+import { AppComponent } from "./app/app.component";
+import { appConfig } from "./app/app.config";
+{% if use_tailwind %}import "./styles.css";{% endif %}
+
+bootstrapApplication(AppComponent, appConfig).catch((err) =>
+  console.error("Bootstrap failed:", err)
+);

litestar_vite/templates/angular/src/styles.css.j2

@@ -0,0 +1,9 @@
+{% if use_tailwind %}@import "tailwindcss";
+
+{% endif %}:root {
+  font-family: "Inter", system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif;
+  line-height: 1.5;
+  color: #0f172a;
+  background: #f8fafc;
+  min-height: 100vh;
+}

litestar_vite/templates/angular/tsconfig.app.json.j2

@@ -0,0 +1,34 @@
+{
+  "extends": "./tsconfig.json",
+  "compileOnSave": false,
+  "compilerOptions": {
+    "baseUrl": "./",
+    "outDir": "./dist/out-tsc",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "sourceMap": true,
+    "declaration": false,
+    "downlevelIteration": true,
+    "experimentalDecorators": true,
+    "moduleResolution": "bundler",
+    "importHelpers": true,
+    "noEmit": false,
+    "target": "ES2022",
+    "module": "ESNext",
+    "lib": ["ES2022", "dom"],
+    "skipLibCheck": true
+  },
+  "angularCompilerOptions": {
+    "enableI18nLegacyMessageIdFormat": false,
+    "strictInjectionParameters": true,
+    "strictInputAccessModifiers": true,
+    "strictTemplates": true
+  },
+  "files": ["{{ resource_dir }}/main.ts"],
+  "include": ["{{ resource_dir }}/**/*.ts"],
+  "exclude": ["{{ resource_dir }}/generated/**"]
+}

litestar_vite/templates/angular/tsconfig.json.j2

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "useDefineForClassFields": false,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "types": ["vite/client"],
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./{{ resource_dir }}/*"]
+    }
+  },
+  "include": ["{{ resource_dir }}/**/*.ts"]
+}

litestar_vite/templates/angular/vite.config.ts.j2

@@ -0,0 +1,21 @@
+import angular from "@analogjs/vite-plugin-angular";
+{% if use_tailwind %}import tailwindcss from "@tailwindcss/vite";
+{% endif %}import litestar from "litestar-vite-plugin";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  resolve: {
+    mainFields: ["module"],
+    alias: {
+      "@": "/{{ resource_dir }}",
+    },
+  },
+  plugins: [
+    // Angular plugin must be first
+    angular(),
+{% if use_tailwind %}    tailwindcss(),
+{% endif %}    litestar({
+      input: ["{{ resource_dir }}/main.ts"{% if use_tailwind %}, "{{ resource_dir }}/styles.css"{% endif %}],
+    }),
+  ],
+});

litestar_vite/templates/angular-cli/.postcssrc.json.j2

@@ -0,0 +1,5 @@
+{
+  "plugins": {
+    "@tailwindcss/postcss": {}
+  }
+}

litestar_vite/templates/angular-cli/angular.json.j2

@@ -0,0 +1,36 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "projects": {
+    "{{ project_name }}": {
+      "projectType": "application",
+      "root": "",
+      "sourceRoot": "src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:application",
+          "options": {
+            "outputPath": "dist",
+            "index": "src/index.html",
+            "browser": "src/main.ts",
+            "tsConfig": "tsconfig.app.json",
+            "assets": [
+              { "glob": "**/*", "input": "src/assets", "output": "/assets" },
+              { "glob": "**/*", "input": "{{ resource_dir }}/generated", "output": "/{{ resource_dir }}/generated" }
+            ],
+            "styles": ["src/styles.css"],
+            "scripts": []
+          }
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "options": {
+            "buildTarget": "{{ project_name }}:build",
+            "proxyConfig": "proxy.conf.json"
+          }
+        }
+      }
+    }
+  }
+}