fastapi-admin-kit 0.1.0__py3-none-any.whl

fastapi_admin_kit/static/js/htmx-config.js

@@ -0,0 +1,42 @@
+/* ═══════════════════════════════════════════════════════════════════════════
+   FastAPI Admin Kit — HTMX Configuration
+   ═══════════════════════════════════════════════════════════════════════════ */
+
+document.addEventListener('DOMContentLoaded', () => {
+
+  /* ── Default swap style ──────────────────────────────────────────────── */
+
+  if (typeof htmx !== 'undefined') {
+    htmx.config.defaultSwapStyle = 'outerHTML';
+  }
+
+  /* ── CSRF / HTMX header injection ────────────────────────────────────── */
+
+  document.body.addEventListener('htmx:configRequest', (event) => {
+    /* Read CSRF token from meta tag if present */
+    const meta = document.querySelector('meta[name="csrf-token"]');
+    if (meta) {
+      event.detail.headers['X-CSRF-Token'] = meta.getAttribute('content');
+    }
+
+    /* Always send the HTMX marker so the server can distinguish HTMX
+       requests from full-page navigations. */
+    event.detail.headers['HX-Request'] = 'true';
+  });
+
+  /* ── Show/hide loading bar on HTMX events ────────────────────────────── */
+
+  const loadingBar = document.getElementById('loading-bar');
+  if (loadingBar) {
+    document.body.addEventListener('htmx:beforeRequest', () => {
+      loadingBar.style.display = 'block';
+    });
+    document.body.addEventListener('htmx:afterRequest', () => {
+      loadingBar.style.display = 'none';
+    });
+    document.body.addEventListener('htmx:responseError', () => {
+      loadingBar.style.display = 'none';
+    });
+  }
+
+});

fastapi_admin_kit/storage/__init__.py

@@ -0,0 +1,6 @@
+"""File storage backends."""
+
+from fastapi_admin_kit.storage.base import StorageBackend
+from fastapi_admin_kit.storage.local import LocalStorageBackend
+
+__all__ = ["StorageBackend", "LocalStorageBackend"]

fastapi_admin_kit/storage/base.py

@@ -0,0 +1,48 @@
+"""Storage backend ABC — defines the interface for file storage implementations."""
+
+from __future__ import annotations
+
+import uuid
+from abc import ABC, abstractmethod
+from pathlib import PurePosixPath
+
+from starlette.datastructures import UploadFile
+
+
+class StorageBackend(ABC):
+    """Abstract base class for file storage backends.
+
+    Implementations must define ``save``, ``delete``, and ``url``.
+    ``sanitize_filename`` is shared across all backends.
+    """
+
+    @abstractmethod
+    async def save(self, file: UploadFile, directory: str = "") -> str:
+        """Save an uploaded file and return its relative path within storage."""
+
+    @abstractmethod
+    async def delete(self, path: str) -> None:
+        """Delete a file at the given relative path."""
+
+    @abstractmethod
+    def url(self, path: str) -> str:
+        """Return the public URL for a stored file (relative path)."""
+
+    def sanitize_filename(self, filename: str) -> str:
+        """Sanitize an uploaded filename.
+
+        Prepends a UUID prefix to prevent collisions and strips path
+        separators to avoid directory traversal.
+        """
+        # Strip any directory components
+        name = PurePosixPath(filename).name
+        if not name:
+            name = "unnamed"
+
+        # Remove null bytes and path separators
+        name = name.replace("\x00", "")
+        name = name.replace("/", "_").replace("\\", "_")
+
+        # Prepend UUID for uniqueness
+        prefix = uuid.uuid4().hex[:12]
+        return f"{prefix}_{name}"

fastapi_admin_kit/storage/local.py

@@ -0,0 +1,73 @@
+"""Local filesystem storage backend — saves files to a local directory."""
+
+from __future__ import annotations
+
+import os
+from pathlib import Path
+
+from starlette.datastructures import UploadFile
+
+from fastapi_admin_kit.storage.base import StorageBackend
+
+
+class LocalStorageBackend(StorageBackend):
+    """Saves uploaded files to a local directory and serves via StaticFiles.
+
+    Parameters
+    ----------
+    upload_dir:
+        Absolute or relative path where files are stored.
+    base_url:
+        The URL prefix that maps to ``upload_dir`` (e.g. ``"/uploads"``).
+    max_size_mb:
+        Maximum allowed file size in megabytes. ``None`` means no limit.
+    """
+
+    def __init__(
+        self,
+        upload_dir: str | Path = "uploads",
+        base_url: str = "/uploads",
+        max_size_mb: float | None = None,
+    ) -> None:
+        self.upload_dir = Path(upload_dir)
+        self.base_url = base_url.rstrip("/")
+        self.max_size_mb = max_size_mb
+
+    async def save(self, file: UploadFile, directory: str = "") -> str:
+        """Save an uploaded file. Returns the relative path within storage."""
+        filename = self.sanitize_filename(file.filename or "unnamed")
+        target_dir = self.upload_dir / directory
+        target_dir.mkdir(parents=True, exist_ok=True)
+
+        target_path = target_dir / filename
+        content = await file.read()
+
+        if self.max_size_mb is not None:
+            max_bytes = int(self.max_size_mb * 1024 * 1024)
+            if len(content) > max_bytes:
+                raise ValueError(
+                    f"File size ({len(content)} bytes) exceeds maximum "
+                    f"allowed size ({self.max_size_mb} MB)."
+                )
+
+        with open(target_path, "wb") as f:
+            f.write(content)
+
+        # Return path relative to upload_dir, using forward slashes
+        if directory:
+            return f"{directory}/{filename}"
+        return filename
+
+    async def delete(self, path: str) -> None:
+        """Delete a file at the given relative path."""
+        target = self.upload_dir / path
+        if target.is_file():
+            os.remove(target)
+
+    def url(self, path: str) -> str:
+        """Return the public URL for a stored file."""
+        return f"{self.base_url}/{path}"
+
+    def ensure_dir(self) -> None:
+        """Create the upload directory if it doesn't exist."""
+        self.upload_dir.mkdir(parents=True, exist_ok=True)

fastapi_admin_kit/templates/base.html

@@ -0,0 +1,142 @@
+<!DOCTYPE html>
+<html lang="en" data-theme="{{ 'dark' if admin_config.dark_mode_default else 'light' }}"
+      data-preset="{{ theme_preset | default('editorial') }}">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>{% block title %}{{ title | default("Admin") }}{% endblock %}</title>
+  <meta name="csrf-token" content="{{ get_csrf_token(request) }}">
+
+  {% if admin_config.favicon_url %}
+  <link rel="icon" href="{{ admin_config.favicon_url }}">
+  {% endif %}
+
+  <link rel="preconnect" href="https://fonts.googleapis.com">
+  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+  {% if theme_font_import_url | default('') %}
+  <link href="{{ theme_font_import_url }}" rel="stylesheet">
+  {% else %}
+  <link href="https://fonts.googleapis.com/css2?family=Poppins:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
+  {% endif %}
+  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined&display=block" rel="stylesheet">
+
+  <link rel="stylesheet" href="/static/css/tokens.css?v={{ static_version }}">
+  <link rel="stylesheet" href="/static/css/presets.css?v={{ static_version }}">
+  <link rel="stylesheet" href="/static/css/admin.css?v={{ static_version }}">
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/flatpickr/dist/flatpickr.min.css">
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/flatpickr/dist/themes/dark.css">
+
+  <script src="https://unpkg.com/htmx.org@2.0.4"></script>
+  <script defer src="https://cdn.jsdelivr.net/npm/@alpinejs/collapse@3.x.x/dist/cdn.min.js"></script>
+  <script defer src="https://cdn.jsdelivr.net/npm/alpinejs@3.x.x/dist/cdn.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/flatpickr"></script>
+
+  {% if theme_css | default('') %}
+  <style>{{ theme_css }}</style>
+  {% endif %}
+
+  <style>
+    :root {
+      --primary-500: {{ admin_config.primary_color | default('#10B981') }};
+      --primary-600: {{ admin_config.primary_color_dark | default('#059669') }};
+    }
+  </style>
+
+  {% set _ui = ui_config | default({}) %}
+  {% if _ui.custom_css_url | default('') %}
+  <link rel="stylesheet" href="{{ _ui.custom_css_url }}">
+  {% endif %}
+  {% if _ui.custom_css | default('') %}
+  <style>{{ _ui.custom_css }}</style>
+  {% endif %}
+
+  {% block head_extra %}{% endblock %}
+
+  {% for css_url in extra_css | default([]) %}
+  <link rel="stylesheet" href="{{ css_url }}">
+  {% endfor %}
+  {% for js_url in extra_js | default([]) %}
+  <script src="{{ js_url }}"></script>
+  {% endfor %}
+  {% if extra_css_inline | default('') %}
+  <style>{{ extra_css_inline }}</style>
+  {% endif %}
+  {% if extra_js_inline | default('') %}
+  <script>{{ extra_js_inline }}</script>
+  {% endif %}
+</head>
+<body x-data="{
+        sidebarOpen: false,
+        sidebarCollapsed: localStorage.getItem('sidebarCollapsed') === 'true',
+        init() {
+          if (window.innerWidth < 1024) { this.sidebarCollapsed = true; }
+          window.addEventListener('resize', () => {
+            if (window.innerWidth < 1024) { this.sidebarCollapsed = true; this.sidebarOpen = false; }
+          });
+          this.$watch('sidebarCollapsed', val => { localStorage.setItem('sidebarCollapsed', val); });
+        },
+        toggleMobileSidebar() { this.sidebarOpen = !this.sidebarOpen; }
+      }"
+      class="font-sans antialiased"
+      style="color: var(--text-primary); background-color: var(--surface-base);">
+
+  <div id="loading-bar" class="htmx-indicator-loading"></div>
+
+  <div class="admin-shell">
+    {% include "partials/topbar.html" %}
+
+    <div class="admin-body">
+      {% include "partials/sidebar.html" %}
+
+      <div class="admin-content {% set _cw = (ui_config | default({})).content_width | default('default') %}{% if _cw != 'default' %}content--{{ _cw }}{% endif %}"
+           id="admin-content">
+        {% include "partials/flash_messages.html" %}
+
+        <div class="admin-content__inner">
+          {% block content %}{% endblock %}
+        </div>
+      </div>
+    </div>
+  </div>
+
+  {# Confirm dialog modal #}
+  <template x-if="true">
+    <div id="confirm-dialog"
+         x-data="{ open: false, title: '', message: '', onConfirm: null }"
+         x-show="open" x-cloak>
+      <div class="modal-backdrop" @click="open = false"></div>
+      <div class="modal modal--sm" @click.stop>
+        <div class="modal__header">
+          <h3 class="modal__title" x-text="title"></h3>
+          <button type="button" class="modal__close" @click="open = false">
+            {{ icon("x-mark") }}
+          </button>
+        </div>
+        <div class="modal__body">
+          <div class="flex items-start gap-3">
+            {{ icon("exclamation-triangle", class="flex-shrink-0 mt-0.5", size="24px") }}
+            <p x-text="message" style="color: var(--text-secondary);"></p>
+          </div>
+        </div>
+        <div class="modal__footer">
+          <button @click="open = false" class="btn btn-secondary btn-sm">Cancel</button>
+          <button @click="onConfirm(); open = false" class="btn btn-danger btn-sm">Delete</button>
+        </div>
+      </div>
+    </div>
+  </template>
+
+  {% include "partials/command_palette.html" %}
+
+  {% set _ui2 = ui_config | default({}) %}
+  {% if _ui2.custom_js_url | default('') %}
+  <script src="{{ _ui2.custom_js_url }}"></script>
+  {% endif %}
+  {% if _ui2.custom_js | default('') %}
+  <script>{{ _ui2.custom_js }}</script>
+  {% endif %}
+
+  <script src="/static/js/htmx-config.js"></script>
+  <script src="/static/js/admin.js?v={{ static_version }}"></script>
+</body>
+</html>