fastapi-rtk 2.20.0__tar.gz → 2.20.1__tar.gz

{fastapi_rtk-2.20.0 → fastapi_rtk-2.20.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: fastapi-rtk
-Version: 2.20.0
+Version: 2.20.1
 Summary: A package that provides a set of tools to build a FastAPI application with a Class-Based CRUD API.
 Project-URL: Homepage, https://codeberg.org/datatactics/fastapi-rtk
 Project-URL: Issues, https://codeberg.org/datatactics/fastapi-rtk/issues
@@ -119,7 +119,7 @@ project/
 1. Install FastAPI React Toolkit:
 
    ```bash
-   pip install fastapi-rtk
+   pip install fastapi-rtk aiosqlite  # aiosqlite: async driver for the sqlite URI below (asyncpg for Postgres)
    mkdir -p app
    touch run.py app/__init__.py app/app.py app/config.py app/models.py app/apis.py
    ```
@@ -231,6 +231,7 @@ project/
    - `GET /api/v1/items/_image/{filename}` - Serve image files (If image column is present)
    - `GET /api/v1/items/_file/{filename}` - Serve file downloads (If file column is present)
    - `GET /api/v1/items/_info` - Get metadata about the model, including which columns can be added, edited, filtered, etc.
+   - `GET /api/v1/items/_lookup/{column}` - Search a column's values, or resolve ids to labels, for form and filter inputs (If the column is enabled in `lookup_columns`)
    - `POST /api/v1/items/bulk/{handler}` - Bulk operations, if set on the API class
    - `GET /api/v1/items/download` - Download items as CSV
    - `GET /api/v1/items/` - List items
@@ -249,6 +250,14 @@ project/
 
 2. Project files:
 
+   **webapp/.env**
+
+   The path the app is served under, with a trailing slash; `index.html` reads it as `%VITE_BASE_PATH%`.
+
+   ```bash
+   VITE_BASE_PATH=/
+   ```
+
    **webapp/index.html**
 
    ```html
@@ -295,7 +304,7 @@ project/
 
    createRoot(document.getElementById("root")).render(
      <StrictMode>
-       <MantineProvider>
+       <MantineProvider getStyleNonce={() => window.nonce}>
          <Provider baseUrl={BASE_PATH + "api/v1"}>
            <BrowserRouter basename={BASE_PATH}>
              <App />
@@ -326,8 +335,9 @@ import { createReactNativeAdapters } from "fastapi-rtk/react-native-adapters";
 const rnAdapters = createReactNativeAdapters({
   asyncStorage,
   fileSystem,
-  sharing,
+  sharing, // optional
   webBrowser,
+  oauthRedirectUrl: "myapp://oauth", // required for OAuth sign-in; one URL or a map per provider
 });
 
 <Provider baseUrl="https://api.example.com/api/v1" adapters={rnAdapters}>

{fastapi_rtk-2.20.0 → fastapi_rtk-2.20.1}/README.md

@@ -60,7 +60,7 @@ project/
 1. Install FastAPI React Toolkit:
 
    ```bash
-   pip install fastapi-rtk
+   pip install fastapi-rtk aiosqlite  # aiosqlite: async driver for the sqlite URI below (asyncpg for Postgres)
    mkdir -p app
    touch run.py app/__init__.py app/app.py app/config.py app/models.py app/apis.py
    ```
@@ -172,6 +172,7 @@ project/
    - `GET /api/v1/items/_image/{filename}` - Serve image files (If image column is present)
    - `GET /api/v1/items/_file/{filename}` - Serve file downloads (If file column is present)
    - `GET /api/v1/items/_info` - Get metadata about the model, including which columns can be added, edited, filtered, etc.
+   - `GET /api/v1/items/_lookup/{column}` - Search a column's values, or resolve ids to labels, for form and filter inputs (If the column is enabled in `lookup_columns`)
    - `POST /api/v1/items/bulk/{handler}` - Bulk operations, if set on the API class
    - `GET /api/v1/items/download` - Download items as CSV
    - `GET /api/v1/items/` - List items
@@ -190,6 +191,14 @@ project/
 
 2. Project files:
 
+   **webapp/.env**
+
+   The path the app is served under, with a trailing slash; `index.html` reads it as `%VITE_BASE_PATH%`.
+
+   ```bash
+   VITE_BASE_PATH=/
+   ```
+
    **webapp/index.html**
 
    ```html
@@ -236,7 +245,7 @@ project/
 
    createRoot(document.getElementById("root")).render(
      <StrictMode>
-       <MantineProvider>
+       <MantineProvider getStyleNonce={() => window.nonce}>
          <Provider baseUrl={BASE_PATH + "api/v1"}>
            <BrowserRouter basename={BASE_PATH}>
              <App />
@@ -267,8 +276,9 @@ import { createReactNativeAdapters } from "fastapi-rtk/react-native-adapters";
 const rnAdapters = createReactNativeAdapters({
   asyncStorage,
   fileSystem,
-  sharing,
+  sharing, // optional
   webBrowser,
+  oauthRedirectUrl: "myapp://oauth", // required for OAuth sign-in; one URL or a map per provider
 });
 
 <Provider baseUrl="https://api.example.com/api/v1" adapters={rnAdapters}>

fastapi_rtk-2.20.1/fastapi_rtk/_version.py

@@ -0,0 +1 @@
+__version__ = "2.20.1"

{fastapi_rtk-2.20.0 → fastapi_rtk-2.20.1}/fastapi_rtk/agent_docs/guide/frontend.md

@@ -10,7 +10,7 @@ The toolkit expects Mantine as the UI kit. Use `Stack`, `Group`, `Grid`, `Simple
 pnpm add fastapi-rtk @mantine/core @mantine/dates @mantine/form @mantine/hooks dayjs react-router
 ```
 
-Peer deps: the four `@mantine/*` packages (`^9.0.0`), `react` / `react-dom` (`^19.2.3`), `dayjs` (`^1.11.0`) and `react-router` (`^7.5.3 || ^8.0.0`). Everything else (mantine-react-table, TanStack Query, zustand, i18next, JsonForms) is bundled inside `fastapi-rtk`. Mantine >= 9.4.1 requires fastapi-rtk >= 2.8.0; older releases loop forever in the grid's `useColumns` ("Maximum update depth exceeded").
+Peer deps: the four `@mantine/*` packages (`^9.0.0`), `react` / `react-dom` (`^19.2.3`), `dayjs` (`^1.11.0`) and `react-router` (`^7.5.3 || ^8.0.0`), plus the optional `@jsonforms/core` / `@jsonforms/react` (`^3.6.0`), needed only when importing from `fastapi-rtk/jsonforms` (every other subpath, its types included, works without them). `fastapi-rtk` has no other dependencies: TanStack Query, zustand, i18next, react-i18next, yup, lodash, clsx, dompurify, mantine-form-yup-resolver, mantine-react-table (patched) and the JsonForms copy behind the built-in forms are bundled inside it. An app's own install of any of these is a separate copy that never sees the toolkit's: `Provider` always creates its own `QueryClient`, and only `rq` / `i18nr` / `useTranslation` imported from `fastapi-rtk` reach the Provider's client and i18next instance. Mantine >= 9.4.1 requires fastapi-rtk >= 2.8.0; older releases loop forever in the grid's `useColumns` ("Maximum update depth exceeded").
 
 **Provider order is load-bearing.** Mantine must wrap the fastapi-rtk `Provider`, and the stylesheet order matters: Mantine CSS first, fastapi-rtk CSS last (RTK overrides).
 
@@ -147,7 +147,7 @@ await addEntry({ name: "x" }); // POST /{resource}
 await updateEntry(id, { name: "y" }); // PUT  /{resource}/{id}
 ```
 
-**Option B, use the TanStack Query namespace `rq`.** `fastapi-rtk` re-exports `@tanstack/react-query` as `rq` (`export * as rq from '@tanstack/react-query'` in `api/src/index.ts:38`, surfaced by `core/src/index.ts:94`; the sibling `mrt` namespace re-exports `mantine-react-table` from `core/src/index.ts:95`, with long-form aliases `reactQuery` / `mantineReactTable`). Wrap a `useApi` action (or any toolkit-provided async function) in `rq.useQuery` / `rq.useMutation` so the result participates in the shared query cache (invalidation, refetch-on-focus, devtools). Never call raw `fetch` from the `queryFn` / `mutationFn`, since that re-introduces the exact problems `useCustomFetch` has.
+**Option B, use the TanStack Query namespace `rq`.** `fastapi-rtk` re-exports its bundled `@tanstack/react-query` as `rq` (`export * as rq from './rq'` in `externals/src/index.ts`, surfaced by `core/src/index.ts:94`; import it from there rather than from `@tanstack/react-query`, whose separate copy cannot see the Provider's `QueryClient`; the sibling `mrt` namespace re-exports the bundled `mantine-react-table` the same way, with long-form aliases `reactQuery` / `mantineReactTable` at `core/src/index.ts:96`). The same namespaces, plus `ld` (lodash), `zs` (zustand), `yup` and `i18nr` (react-i18next), are importable from `fastapi-rtk` or `fastapi-rtk/externals`; importing them from `fastapi-rtk/api`, `/utils`, `/zustand` or `/contexts` is deprecated. Wrap a `useApi` action (or any toolkit-provided async function) in `rq.useQuery` / `rq.useMutation` so the result participates in the shared query cache (invalidation, refetch-on-focus, devtools). Never call raw `fetch` from the `queryFn` / `mutationFn`, since that re-introduces the exact problems `useCustomFetch` has.
 
 ```jsx
 import { useApi, rq } from "fastapi-rtk";
@@ -403,7 +403,7 @@ const { t } = useTranslation(); // or: translation.t
 <LanguageSelector />;
 ```
 
-`useLang` reads/writes the selected language to localStorage. The translation function `t(key)` comes from react-i18next via `useTranslation()` (also re-exported from `fastapi-rtk`) or via the `translation` field on `useLang()`. Source strings double as the English keys; a German dictionary ships built-in. Extend or override through the `Provider`'s `langProps` prop: `langProps.getI18nProps.translations` takes `{locale: {key: value}}`, `langProps.i18n` accepts a full i18next instance, and `langProps.MRTLocalization` overrides the grid's Mantine React Table strings.
+`useLang` reads/writes the selected language to localStorage. The translation function `t(key)` comes from the `useTranslation()` exported by `fastapi-rtk` (the bundled react-i18next's, which the Provider wires to its i18next instance, as it does `i18nr.Trans`; the one imported from `react-i18next` itself is a separate copy that never sees it) or via the `translation` field on `useLang()`. Source strings double as the English keys; a German dictionary ships built-in. Extend or override through the `Provider`'s `langProps` prop: `langProps.getI18nProps.translations` takes `{locale: {key: value}}`, `langProps.i18n` accepts a full i18next instance, and `langProps.MRTLocalization` overrides the grid's Mantine React Table strings.
 
 ## 13. Standard routes: `UserMenu`
 

fastapi_rtk-2.20.0/fastapi_rtk/_version.py

@@ -1 +0,0 @@
-__version__ = "2.20.0"