zrb 1.0.0b9__py3-none-any.whl → 1.1.0__py3-none-any.whl

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/gateway/view/static/crud/util.js

@@ -0,0 +1,94 @@
+const CRUD_UTIL = {
+
+    renderPagination(paginationComponent, crudState, total, fetchFunction = "fetchRows") {
+        const totalPages = Math.ceil(total / crudState.pageSize);
+        paginationComponent.innerHTML = "";
+        // Ensure left alignment (if not already handled by PicoCSS or external CSS)
+        paginationComponent.style.textAlign = "left";
+        let paginationHTML = "";
+        // Only show "First" and "Previous" if we're not on page 1
+        if (crudState.currentPage > 1) {
+            paginationHTML += `<button class="secondary" onclick="${fetchFunction}(1)">&laquo;</button>`;
+            paginationHTML += `<button class="secondary" onclick="${fetchFunction}(${crudState.currentPage - 1})">&lt;</button>`;
+        }
+        if (totalPages <= 5) {
+            // If total pages are few, simply list them all
+            for (let i = 1; i <= totalPages; i++) {
+                paginationHTML += `<button class="secondary" onclick="${fetchFunction}(${i})" ${i === crudState.currentPage ? "disabled" : ""}>${i}</button>`;
+            }
+        } else {
+            // Always show first page
+            paginationHTML += `<button class="secondary" onclick="${fetchFunction}(1)" ${crudState.currentPage === 1 ? "disabled" : ""}>1</button>`;
+            // Determine start and end for the page range around current page
+            const start = Math.max(2, crudState.currentPage - 1);
+            const end = Math.min(totalPages - 1, crudState.currentPage + 1);
+            // Add ellipsis if there's a gap between first page and the start of the range
+            if (start > 2) {
+                paginationHTML += `<span style="padding: 0 5px;">...</span>`;
+            }
+            // Render the range around the current page
+            for (let i = start; i <= end; i++) {
+                paginationHTML += `<button class="secondary" onclick="${fetchFunction}(${i})" ${i === crudState.currentPage ? "disabled" : ""}>${i}</button>`;
+            }
+            // Add ellipsis if there's a gap between the end of the range and the last page
+            if (end < totalPages - 1) {
+                paginationHTML += `<span style="padding: 0 5px;">...</span>`;
+            }
+            // Always show last page
+            paginationHTML += `<button class="secondary" onclick="${fetchFunction}(${totalPages})" ${crudState.currentPage === totalPages ? "disabled" : ""}>${totalPages}</button>`;
+        }
+        // Only show "Next" and "Last" if we're not on the last page
+        if (crudState.currentPage < totalPages) {
+            paginationHTML += `<button class="secondary" onclick="${fetchFunction}(${crudState.currentPage + 1})">&gt;</button>`;
+            paginationHTML += `<button class="secondary" onclick="${fetchFunction}(${totalPages})">&raquo;</button>`;
+        }
+        paginationComponent.innerHTML = paginationHTML;
+    },
+
+    splitUnescaped(query, delimiter=",") {
+        const parts = [];
+        let current = "";
+        let escaped = false;
+        for (let i = 0; i < query.length; i++) {
+            const char = query[i];
+            if (escaped) {
+                current += char;
+                escaped = false;
+            } else if (char === "\\") {
+                escaped = true;
+            } else if (char === delimiter) {
+                parts.push(current);
+                current = "";
+            } else {
+                current += char;
+            }
+        }
+        if (current != "") {
+            parts.push(current);
+        }
+        return parts;
+    },
+
+    isValidFilterQuery(query) {
+        const filterPattern = /^([\w]+):(eq|ne|gt|gte|lt|lte|like|in):(.+)$/;
+        const parts = this.splitUnescaped(query);
+        return parts.every(part => filterPattern.test(part));
+    },
+
+    getSearchParam(crudState, defaultSearchColumn, apiMode = false) {
+        return new URLSearchParams({
+            page: crudState.currentPage || 1,
+            page_size: crudState.pageSize || 10,
+            filter: this._getFilterSearchParamValue(crudState, defaultSearchColumn, apiMode),
+        }).toString();
+    },
+
+    _getFilterSearchParamValue(crudState, defaultSearchColumn, apiMode = false) {
+        const filter = crudState.filter || "";
+        if (!apiMode) {
+            return filter;
+        }
+        return this.isValidFilterQuery(filter) ? filter : `${defaultSearchColumn}:like:%${filter}%`;
+    }
+
+}

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/gateway/view/static/default/pico-style.css

@@ -0,0 +1,23 @@
+h1 {
+    color: var(--pico-primary)
+}
+
+h2 {
+    color: var(--pico-primary)
+}
+
+h3 {
+    color: var(--pico-primary)
+}
+
+h4 {
+    color: var(--pico-primary)
+}
+
+h5 {
+    color: var(--pico-primary)
+}
+
+h6 {
+    color: var(--pico-primary)
+}

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/gateway/view/static/default/script.js

@@ -0,0 +1,44 @@
+// Hamburger menu functionality
+const hamburgerMenu = document.querySelector('.hamburger-menu');
+const layoutContainer = document.querySelector('.layout-container');
+
+hamburgerMenu.addEventListener('click', function() {
+    layoutContainer.classList.toggle('menu-active');
+});
+
+// Close menu when clicking outside
+document.addEventListener('click', function(event) {
+    if (!layoutContainer.contains(event.target) && !hamburgerMenu.contains(event.target)) {
+        layoutContainer.classList.remove('menu-active');
+    }
+});
+
+// Theme switcher functionality
+const themeSelect = document.getElementById('theme-select');
+
+function setTheme(theme) {
+    document.documentElement.setAttribute('data-theme', theme);
+    localStorage.setItem('theme', theme);
+}
+
+function getSavedTheme() {
+    return localStorage.getItem('theme') || 'auto';
+}
+
+const savedTheme = getSavedTheme();
+setTheme(savedTheme);
+themeSelect.value = savedTheme;
+
+themeSelect.addEventListener('change', (e) => {
+    setTheme(e.target.value);
+});
+
+function updateAutoTheme() {
+    if (getSavedTheme() === 'auto') {
+        const isDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
+        document.documentElement.setAttribute('data-theme', isDark ? 'dark' : 'light');
+    }
+}
+
+updateAutoTheme();
+window.matchMedia('(prefers-color-scheme: dark)').addListener(updateAutoTheme);

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/gateway/view/static/default/style.css

@@ -0,0 +1,102 @@
+body {
+    overflow-x: hidden;
+    margin: 0;
+    padding: 0;
+    min-height: 100vh;
+}
+.layout-container {
+    display: flex;
+    min-height: 100vh;
+}
+aside {
+    position: fixed;
+    top: 0;
+    left: 0;
+    bottom: 0;
+    width: 300px;
+    padding: 1rem;
+    border-right: 1px solid var(--muted-border-color);
+    height: 100vh;
+    background: var(--background-color);
+    display: flex;
+    flex-direction: column;
+}
+aside nav {
+    flex-grow: 1; /* Pushes theme-switcher to the bottom */
+    overflow-y: auto;
+    overflow-x: hidden;
+}
+aside ul {
+    padding: 0;
+    list-style: none;
+}
+aside li {
+    margin-bottom: 0.5rem;
+}
+aside li > ul {
+    padding-left: 1rem;
+}
+.content-wrapper {
+    flex: 1;
+    overflow-x: hidden;
+}
+.content {
+    padding: 1rem;
+}
+.hamburger-menu {
+    display: none;
+    background: var(--pico-primary);
+    border: none;
+    font-size: 1.5rem;
+    cursor: pointer;
+    position: fixed;
+    top: 1rem;
+    left: 1rem;
+    z-index: 1001;
+    color: var(--contrast);
+}
+.theme-switcher {
+    display: flex;
+    align-items: center;
+    gap: 0.5rem;
+    margin-top: auto;
+}
+.active-link {
+    font-weight: bold;
+    color: var(--primary);
+}
+
+@media (max-width: 768px) {
+    .layout-container {
+        position: relative;
+        left: 0;
+        transition: left 0.3s ease;
+    }
+    .hamburger-menu {
+        display: block;
+    }
+    aside {
+        left: -300px;
+        top: 0;
+        bottom: 0;
+        z-index: 1000;
+        transition: left 0.3s ease;
+        padding-top: 4rem;
+    }
+    .layout-container.menu-active {
+        margin-left: 300px;
+        /*left: 300px;*/
+    }
+    .layout-container.menu-active aside {
+        left: 0;
+    }
+    .content {
+        padding-top: 4rem;
+    }
+}
+
+@media (min-width: 769px) {
+  .content-wrapper {
+    margin-left: 300px;
+  }
+}

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/gateway/view/template/default.html

@@ -4,31 +4,86 @@
         <meta charset="utf-8">
         <meta name="viewport" content="width=device-width, initial-scale=1">
         <meta name="color-scheme" content="light dark">
-        {% for css_path in partials.css_path_list -%}
+        <link rel="stylesheet" href="{{pico_css_path}}">
+        <link rel="stylesheet" href="/static/default/pico-style.css">
+        <link rel="stylesheet" href="/static/default/style.css">
+        {% for css_path in css_path_list -%}
         <link rel="stylesheet" href="{{css_path}}">
         {% endfor %}
-        <link rel="icon" href="{{partials.favicon_path}}" sizes="32x32" type="image/png">
-        <title>{{partials.title}}</title>
+        <link rel="icon" href="{{favicon_path}}" sizes="32x32" type="image/png">
+        <title>{{title}}</title>
     </head>
     <body>
-        <header class="container">
-            <hgroup>
-                <h1>{{partials.title}}</h1>
-                <p>{{partials.subtitle}}</p>
+        <button class="hamburger-menu" aria-label="Menu">☰</button>
+        <div class="layout-container">
+            <aside>
                 <nav>
                     <ul>
-                        <li><a href="/">🏠 Home</a></li>
-                        <li><a href="/docs">💻 API Documentation</a></li>
-                    </ul>
-                    <ul>
-                        <li>Hi</li>
+                        {% for navigation in navigations %}
+                            {% if navigation|attr("pages") %}
+                            <li>
+                                <details {% if navigation.active %}open{% endif %}>
+                                    <summary>{{navigation.caption}}</summary>
+                                    <ul>
+                                        {% for page in navigation.pages %}
+                                        <li><a href="{{page.url}}" class="{{ 'active-link' if page.active else '' }}">{{page.caption}}</a></li>
+                                        {% endfor %}
+                                    </ul>
+                                </details>
+                            </li>
+                            {% else %}
+                                <li><a href="{{navigation.url}}" class="{{ 'active-link' if navigation.active else '' }}">{{navigation.caption}}</a></li>
+                            {% endif %}
+                        {% endfor %}
                     </ul>
                 </nav>
-            </hgroup>
-        </header>
-        {{content}}
+                <div class="theme-switcher">
+                    <label for="theme-select">Theme:</label>
+                    <select id="theme-select">
+                        <option value="auto">🌗 Auto</option>
+                        <option value="light">☀️ Light</option>
+                        <option value="dark">🌙 Dark</option>
+                    </select>
+                </div>
+            </aside>
+            <div class="content-wrapper">
+                <main class="content">
+                    <header>
+                        <hgroup>
+                            <h1>{{title}}</h1>
+                            <p>{{subtitle}}</p>
+                        </hgroup>
+                        {% if show_user_info %}
+                        <nav>
+                            <ul></ul>
+                            <ul>
+                                <li>
+                                    {% if current_user is none %}
+                                        <p>Hi Visitor <a href="/login">🔓</a></p>
+                                    {% elif current_user.is_guest %}
+                                        <p>Hi {{current_user.username}} <a href="/login">🔓</a></p>
+                                    {% else %}
+                                        <p>Hi {{current_user.username}} <a href="/logout">🔒</a></p>
+                                    {% endif %}
+                                </li>
+                            </ul>
+                        </nav>
+                        {% endif %}
+                    </header>
+                    <script src="/static/common/util.js"></script>
+                    {{content}}
+                    <footer>{{footer}}</footer>
+                </main>
+            </div>
+        </div>
+        {% for js_path in js_path_list -%}
+        <script src="{{js_path}}"></script>
+        {% endfor %}
+        <script src="/static/default/script.js"></script>
+        <script>
+            {% if should_refresh_session %}
+            UTIL.refreshAccessTokenPeriodically({{refresh_session_interval_seconds}});
+            {% endif %}
+        </script>
     </body>
-    {% for js_path in partials.js_path_list -%}
-    <script src="{{js_path}}"></script>
-    {% endfor %}
 </html>

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/requirements.txt

@@ -4,4 +4,9 @@ sqlmodel~=0.0.22
 ulid-py~=1.1.0
 passlib~=1.7.4
 Jinja2~=3.1.5
-python-jose~=3.3.0
+python-jose~=3.4.0
+passlib~=1.7.4
+
+pytest~=8.3.4
+pytest-asyncio~=0.24.0
+pytest-cov~=6.0.0

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/schema/permission.py

@@ -34,6 +34,7 @@ class PermissionUpdateWithAudit(PermissionUpdate):
 
 class PermissionResponse(PermissionBase):
     id: str
+    description: str
 
 
 class MultiplePermissionResponse(BaseModel):

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/schema/user.py

@@ -90,6 +90,12 @@ class AuthUserResponse(UserResponse):
     is_super_user: bool
     is_guest: bool
 
+    def has_permission(self, permission_name: str):
+        return self.is_super_user or permission_name in self.permission_names
+
+    def has_role(self, role_name: str):
+        return self.is_super_user or role_name in self.role_names
+
 
 class MultipleUserResponse(BaseModel):
     data: list[UserResponse]
@@ -111,6 +117,9 @@ class UserTokenData(SQLModel):
 class UserSessionResponse(SQLModel):
     id: str
     user_id: str
+    access_token: str
+    refresh_token: str
+    token_type: str
     access_token_expired_at: datetime.datetime
     refresh_token_expired_at: datetime.datetime
 

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/test/_util/access_token.py

@@ -0,0 +1,19 @@
+import time
+
+from fastapi.testclient import TestClient
+from my_app_name.config import APP_AUTH_SUPER_USER, APP_AUTH_SUPER_USER_PASSWORD
+from my_app_name.main import app
+
+
+def get_admin_access_token():
+    client = TestClient(app, base_url="http://localhost")
+    # Create new admin user session and check the response
+    session_response = client.post(
+        "/api/v1/user-sessions",
+        data={
+            "username": APP_AUTH_SUPER_USER,
+            "password": APP_AUTH_SUPER_USER_PASSWORD,
+        },
+    )
+    session_data = session_response.json()
+    return session_data.get("access_token")

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/test/auth/permission/test_create_permission.py

@@ -0,0 +1,59 @@
+from fastapi.testclient import TestClient
+from my_app_name.main import app
+from my_app_name.test._util.access_token import get_admin_access_token
+
+
+def test_create_permission():
+    client = TestClient(app, base_url="http://localhost")
+    access_token = get_admin_access_token()
+    new_permission_data = {
+        "name": "new-permission",
+        "description": "new-permission-description",
+    }
+    response = client.post(
+        "/api/v1/permissions",
+        json=new_permission_data,
+        headers={"Authorization": f"Bearer {access_token}"},
+    )
+    assert response.status_code == 200
+    response_data = response.json()
+    assert response_data.get("id") is not None
+    assert response_data.get("id") != ""
+    assert response_data.get("name") == "new-permission"
+    assert response_data.get("description") == "new-permission-description"
+
+
+def test_create_permission_bulk():
+    client = TestClient(app, base_url="http://localhost")
+    access_token = get_admin_access_token()
+    new_first_permission_data = {
+        "name": "new-permission-bulk-1",
+        "description": "new-permission-bulk-description-1",
+    }
+    new_second_permission_data = {
+        "name": "new-permission-bulk-2",
+        "description": "new-permission-bulk-description-2",
+    }
+    new_permission_data = [new_first_permission_data, new_second_permission_data]
+    response = client.post(
+        "/api/v1/permissions/bulk",
+        json=new_permission_data,
+        headers={"Authorization": f"Bearer {access_token}"},
+    )
+    assert response.status_code == 200
+    response_data = response.json()
+    assert len(response_data) == 2
+    # Id should not be empty
+    assert response_data[0] is not None
+    assert response_data[0] != ""
+    assert response_data[1] is not None
+    assert response_data[1] != ""
+    # Data should match
+    assert new_first_permission_data["name"] in [row["name"] for row in response_data]
+    assert new_second_permission_data["name"] in [row["name"] for row in response_data]
+    assert new_first_permission_data["description"] in [
+        row["description"] for row in response_data
+    ]
+    assert new_second_permission_data["description"] in [
+        row["description"] for row in response_data
+    ]

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/test/auth/permission/test_delete_permission.py

@@ -0,0 +1,68 @@
+from fastapi.testclient import TestClient
+from my_app_name.main import app
+from my_app_name.test._util.access_token import get_admin_access_token
+
+
+def test_delete_permission():
+    client = TestClient(app, base_url="http://localhost")
+    access_token = get_admin_access_token()
+    new_permission_data = {
+        "name": "to-be-deleted-permission",
+        "description": "to-be-deleted-permission-description",
+    }
+    insert_response = client.post(
+        "/api/v1/permissions",
+        json=new_permission_data,
+        headers={"Authorization": f"Bearer {access_token}"},
+    )
+    assert insert_response.status_code == 200
+    id = insert_response.json().get("id")
+    # deleting
+    response = client.delete(
+        f"/api/v1/permissions/{id}", headers={"Authorization": f"Bearer {access_token}"}
+    )
+    assert response.status_code == 200
+    response_data = response.json()
+    assert response_data.get("id") == id
+    assert response_data.get("name") == "to-be-deleted-permission"
+    assert response_data.get("description") == "to-be-deleted-permission-description"
+
+
+def test_delete_permission_bulk():
+    client = TestClient(app, base_url="http://localhost")
+    access_token = get_admin_access_token()
+    new_first_permission_data = {
+        "name": "to-be-deleted-permission-bulk-1",
+        "description": "to-be-deleted-permission-bulk-description-1",
+    }
+    new_second_permission_data = {
+        "name": "to-be-deleted-permission-bulk-2",
+        "description": "to-be-deleted-permission-bulk-description-2",
+    }
+    new_permission_data = [new_first_permission_data, new_second_permission_data]
+    insert_response = client.post(
+        "/api/v1/permissions/bulk",
+        json=new_permission_data,
+        headers={"Authorization": f"Bearer {access_token}"},
+    )
+    assert insert_response.status_code == 200
+    ids = [row["id"] for row in insert_response.json()]
+    # deleting (use client.request since client.delete doesn't support json param)
+    response = client.request(
+        "DELETE",
+        f"/api/v1/permissions/bulk",
+        json=ids,
+        headers={"Authorization": f"Bearer {access_token}"},
+    )
+    assert response.status_code == 200
+    response_data = response.json()
+    # Data should match
+    assert len([row["id"] for row in response_data if row["id"] in ids]) == 2
+    assert new_first_permission_data["name"] in [row["name"] for row in response_data]
+    assert new_second_permission_data["name"] in [row["name"] for row in response_data]
+    assert new_first_permission_data["description"] in [
+        row["description"] for row in response_data
+    ]
+    assert new_second_permission_data["description"] in [
+        row["description"] for row in response_data
+    ]

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/test/auth/permission/test_read_permission.py

@@ -0,0 +1,71 @@
+from fastapi.testclient import TestClient
+from my_app_name.main import app
+from my_app_name.test._util.access_token import get_admin_access_token
+
+
+def test_read_permission_by_id():
+    client = TestClient(app, base_url="http://localhost")
+    access_token = get_admin_access_token()
+    new_permission_data = {
+        "name": "to-be-read-permission",
+        "description": "to-be-read-permission-description",
+    }
+    insert_response = client.post(
+        "/api/v1/permissions",
+        json=new_permission_data,
+        headers={"Authorization": f"Bearer {access_token}"},
+    )
+    assert insert_response.status_code == 200
+    id = insert_response.json().get("id")
+    # fetching
+    response = client.get(
+        f"/api/v1/permissions/{id}", headers={"Authorization": f"Bearer {access_token}"}
+    )
+    assert response.status_code == 200
+    response_data = response.json()
+    assert response_data.get("id") == id
+    assert response_data.get("name") == "to-be-read-permission"
+    assert response_data.get("description") == "to-be-read-permission-description"
+
+
+def test_read_permission_bulk():
+    client = TestClient(app, base_url="http://localhost")
+    access_token = get_admin_access_token()
+    new_first_permission_data = {
+        "name": "to-be-read-permission-bulk-1",
+        "description": "to-be-read-permission-bulk-description-1",
+    }
+    new_second_permission_data = {
+        "name": "to-be-read-permission-bulk-2",
+        "description": "to-be-read-permission-bulk-description-2",
+    }
+    new_permission_data = [new_first_permission_data, new_second_permission_data]
+    insert_response = client.post(
+        "/api/v1/permissions/bulk",
+        json=new_permission_data,
+        headers={"Authorization": f"Bearer {access_token}"},
+    )
+    assert insert_response.status_code == 200
+    ids = [row["id"] for row in insert_response.json()]
+    # fetching
+    response = client.get(
+        f"/api/v1/permissions",
+        params={
+            "filter": "name:like:to-be-read-permission-bulk-%",
+        },
+        headers={"Authorization": f"Bearer {access_token}"},
+    )
+    assert response.status_code == 200
+    response_data_count = response.json()["count"]
+    assert response_data_count == 2
+    response_data = response.json()["data"]
+    # Data should match
+    assert len([row["id"] for row in response_data if row["id"] in ids]) == 2
+    assert new_first_permission_data["name"] in [row["name"] for row in response_data]
+    assert new_second_permission_data["name"] in [row["name"] for row in response_data]
+    assert new_first_permission_data["description"] in [
+        row["description"] for row in response_data
+    ]
+    assert new_second_permission_data["description"] in [
+        row["description"] for row in response_data
+    ]