codex-fastapi-cabinet 0.1.0__py3-none-any.whl

codex_fastapi_cabinet-0.1.0.dist-info/METADATA

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: codex-fastapi-cabinet
+Version: 0.1.0
+Summary: Composable administration interfaces for FastAPI sites and APIs
+Project-URL: Homepage, https://github.com/CodexDLC/codex-fastapi-cabinet
+Project-URL: Documentation, https://codexdlc.github.io/codex-fastapi-cabinet/
+Project-URL: Repository, https://github.com/CodexDLC/codex-fastapi-cabinet
+Project-URL: Issues, https://github.com/CodexDLC/codex-fastapi-cabinet/issues
+Author: CodexDLC
+License: Apache-2.0
+License-File: LICENSE
+Keywords: admin,dashboard,fastapi,jinja2,management
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.12
+Requires-Dist: fastapi<1.0,>=0.115
+Requires-Dist: jinja2<4.0,>=3.1
+Requires-Dist: pydantic<3.0,>=2.10
+Provides-Extra: dev
+Requires-Dist: httpx>=0.28; extra == 'dev'
+Requires-Dist: mypy>=1.15; extra == 'dev'
+Requires-Dist: pip-audit>=2.7; extra == 'dev'
+Requires-Dist: pre-commit>=4.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0; extra == 'dev'
+Requires-Dist: pytest>=9.0; extra == 'dev'
+Requires-Dist: ruff>=0.11; extra == 'dev'
+Requires-Dist: twine>=6.1; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mike>=2.1; extra == 'docs'
+Requires-Dist: mkdocs-include-markdown-plugin>=7.1; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.6; extra == 'docs'
+Requires-Dist: mkdocs<2.0,>=1.6; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.29; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# codex-fastapi-cabinet
+
+Composable, server-rendered administration interfaces for FastAPI sites and APIs.
+
+The library provides the management shell, routing, navigation, generic pages, dashboard widgets,
+permissions port, Jinja templates, and static assets. Your FastAPI application keeps ownership of
+authentication, authorization rules, database access, transactions, and business operations.
+
+> Status: alpha. The public API is usable, but may evolve before `1.0`.
+
+## What it provides
+
+- application-scoped admin registry;
+- independent mount path, such as `/cabinet` or `/management`;
+- generic list, detail, form, and operation pages;
+- metric, table, list, and chart dashboard widgets;
+- async application-owned data providers;
+- permission checks for modules, pages, widgets, navigation, and actions;
+- overridable Jinja templates and packaged responsive CSS;
+- explicit module discovery without import-time registration side effects.
+
+## Installation
+
+```bash
+pip install codex-fastapi-cabinet
+```
+
+For local development:
+
+```bash
+uv sync --extra dev --extra docs
+```
+
+## Quick start
+
+```python
+from typing import ClassVar
+
+from fastapi import FastAPI, Request
+
+from fastapi_cabinet import (
+    CabinetAdmin,
+    CabinetProvider,
+    CabinetSite,
+    ListPage,
+    ListPageMap,
+    MetricWidget,
+    MetricWidgetMap,
+    SidebarItem,
+    TableColumnMap,
+    include_cabinet,
+)
+
+
+async def user_count(request: Request) -> MetricWidgetMap:
+    return MetricWidgetMap(
+        key="users-total",
+        title="Users",
+        value="42",
+        subtitle="Registered accounts",
+    )
+
+
+async def user_list(request: Request) -> ListPageMap:
+    return ListPageMap(
+        title="Users",
+        columns=[
+            TableColumnMap(key="email", label="Email"),
+            TableColumnMap(key="status", label="Status"),
+        ],
+        rows=[
+            {
+                "email": "admin@example.test",
+                "status": "active",
+                "href": "/management/users/1",
+            }
+        ],
+        row_href_key="href",
+    )
+
+
+class UsersAdmin(CabinetAdmin):
+    key = "users"
+    label = "Users"
+    sidebar = (SidebarItem(key="all", label="All users", path="all"),)
+    dashboard_widgets = (
+        MetricWidget(key="users-total", title="Users", provider="users.count"),
+    )
+    pages = (
+        ListPage(key="all", label="All users", path="all", provider="users.list"),
+    )
+    providers: ClassVar[dict[str, CabinetProvider]] = {
+        "users.count": user_count,
+        "users.list": user_list,
+    }
+
+
+app = FastAPI()
+site = CabinetSite(brand_name="My service")
+site.register(UsersAdmin)
+include_cabinet(app, site=site, mount_path="/management")
+```
+
+Run the complete example:
+
+```bash
+uvicorn examples.basic_app:app --reload
+```
+
+Then open `http://127.0.0.1:8000/management`.
+
+## Boundaries
+
+`codex-fastapi-cabinet` is a composition toolkit, not an ORM-aware CRUD generator. Providers return
+validated view models, so the same cabinet can sit over SQLAlchemy, another database layer, an HTTP
+API, or an in-memory service without coupling the library to any of them.
+
+The host application must secure the cabinet mount and provide real permission checks. The default
+permission provider allows every declared permission and is intended only when access control is
+enforced outside the library.
+
+## Documentation
+
+- [English documentation](docs/index.md)
+- [Русская документация](docs/ru/index.md)
+- [Architecture and extension boundaries](docs/architecture.md)
+- [Template customization](docs/customization.md)
+
+## Development
+
+```bash
+ruff check src tests examples
+mypy src tests examples
+pytest
+python -m build
+```
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).

codex_fastapi_cabinet-0.1.0.dist-info/RECORD

@@ -0,0 +1,39 @@
+fastapi_cabinet/__init__.py,sha256=BVUirtQCnqEr7866hxcLfKY8GsaTqJYGpGibtmu7UlE,1882
+fastapi_cabinet/exceptions.py,sha256=NYIg9INF68v4hZ3Pp_oq9cRtxnqtluQUZsCWkAhd4u8,575
+fastapi_cabinet/fastapi.py,sha256=JM8Dg2Qxbb81B7-MI_XqlhyHHsTUA-1uBuFjWdJkY3k,1188
+fastapi_cabinet/loader.py,sha256=IWMMl0eA46wmKLQBoY4ppe016xF0U5czMV39FD3rIF0,2762
+fastapi_cabinet/registry.py,sha256=xQ9sJ40l37kb9oF1l_Lxgzzqk8k_KQDdU5cVGiDMPHA,1258
+fastapi_cabinet/runtime.py,sha256=OwXdS0zkFregvFiQxbgJQpaVwdkyvZ7qNu08Risxx8I,2161
+fastapi_cabinet/site.py,sha256=QpnK23z8kXY9pA2Bp_M_aBlDXrlI_KLDgzSAYun1qjI,10472
+fastapi_cabinet/contracts/__init__.py,sha256=T-sqw8sfvb9zUJ4KF3oNb60I9dKBg3xsMbcBO5GMWDM,1982
+fastapi_cabinet/contracts/admin.py,sha256=f8U0zvyqEagNzGr4ba2RJezj6kEC5fS04trWJzwGO7k,1633
+fastapi_cabinet/contracts/layout.py,sha256=xKInyyN2QmQ7rVd3BTacC53VCb9j_zeN_CtxWg1ufDA,604
+fastapi_cabinet/contracts/navigation.py,sha256=vUvOiJkbya631vinPpXvOTrZgwN-H5g1VMH-6p-BZlM,590
+fastapi_cabinet/contracts/pages.py,sha256=zHFy9Zjw_kVikohkY4A4E5AVLB5_ak6_h0LseKdVofc,3976
+fastapi_cabinet/contracts/permissions.py,sha256=Veb4BBI2ssq5NPkpp_9Wgee8-qDs-WgjgWedLigKu2g,419
+fastapi_cabinet/contracts/providers.py,sha256=fsZtrK1hwl2CZDCxDGG8kEHgWZIPbHigOGbIraZA9p0,299
+fastapi_cabinet/contracts/widgets.py,sha256=IOtdFUjZB2nBYoVdy0_MlATFzQQc2RomCqA7dFlBCxI,2412
+fastapi_cabinet/rendering/__init__.py,sha256=gVIYY-4GtgjA1k4P4_2jV9Srqt0it0CsaB-cGrvfuh4,301
+fastapi_cabinet/rendering/layout_mapper.py,sha256=2Ksj-LBf6L4PE24egl2sWFEsULBm7K65An07hzmuj3w,2874
+fastapi_cabinet/rendering/page_mapper.py,sha256=G2g0gWAnFc4RyJgh1NY2XBm9VHIGK7A-_TP8mlsU7VU,1430
+fastapi_cabinet/rendering/widget_mapper.py,sha256=gfWRD1guA-_H3zmQ1mfeGEZPhbO8s335crqdnzoYNzk,1837
+fastapi_cabinet/static/css/cabinet.css,sha256=h27_D_TARLjwzP5Ja19BTaV4ZvTXTUqHeQGI_ycfuEw,6612
+fastapi_cabinet/static/js/cabinet.js,sha256=aIVKk5a7iuh_Tuac4U6GFPoQ-Y1DxxHQU8jjHXmRT4A,210
+fastapi_cabinet/templates/cabinet/base.html,sha256=uQg4lrayIx3JQhdKyjZUebmI9VvoTn-1PAvu-JGBUDw,779
+fastapi_cabinet/templates/cabinet/dashboard.html,sha256=yamV63rNjUo_vAmKMrEv45Igk36-AL1vc3letWeESrY,382
+fastapi_cabinet/templates/cabinet/module.html,sha256=sgwVCTtFqY4ugYTqpy0CYnOfUIMRJYgSkrWVK9vFOWs,487
+fastapi_cabinet/templates/cabinet/includes/sidebar.html,sha256=qalnrrkediQ3mLdP6RGiRAJxdWK1dOFH_i1UqaYnhOo,759
+fastapi_cabinet/templates/cabinet/includes/topbar.html,sha256=Z_rneTxKHJTzlJTr5Hf5KleRQ9MFgHF3IsKQmZiC9lg,926
+fastapi_cabinet/templates/cabinet/includes/widget_frame.html,sha256=AJKe7aUlU6Y2nsu0_Rxep11nr5pEhkhrEdP47wEIj_g,165
+fastapi_cabinet/templates/cabinet/pages/detail.html,sha256=g0vopwdR-W_BwY-fWf5SIoawHSYubj-YIIUi-l6zPpA,1193
+fastapi_cabinet/templates/cabinet/pages/form.html,sha256=YNuBJQQ6z6kmsaI35odfWkv9RlNmB62Y2fHIhssbkws,2712
+fastapi_cabinet/templates/cabinet/pages/list.html,sha256=LIcBP_9g13OPXj-M-E5CL0iqEFpeNEAXuJySBhNd63k,3636
+fastapi_cabinet/templates/cabinet/pages/operation.html,sha256=hZsaXlqnTFcg74N6Qv18E3_-L-2i5BJIeGrntl84eds,1205
+fastapi_cabinet/templates/cabinet/widgets/chart.html,sha256=4bYI_7mM0K25px8WmvdnkApzJPj2Im73mXabNqsdZVc,886
+fastapi_cabinet/templates/cabinet/widgets/list.html,sha256=KFeazujxtyy8re3FZIrbMbagflFy7LT-4cgFrjBbXkY,255
+fastapi_cabinet/templates/cabinet/widgets/metric.html,sha256=ubc1wQv-hFx_omqFLMwswhbvnZsLHl5lYQJ8Po8m6Tw,430
+fastapi_cabinet/templates/cabinet/widgets/table.html,sha256=SzJR6Ac8s-nThHwTnOUGvLB4gKIx1ydWzfifE-WqK_A,1893
+codex_fastapi_cabinet-0.1.0.dist-info/METADATA,sha256=89aFb1IULGjeuXThh_-wFqQWfFY1fCRBmlBW_9mHMBg,5593
+codex_fastapi_cabinet-0.1.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+codex_fastapi_cabinet-0.1.0.dist-info/licenses/LICENSE,sha256=lFK1Ey3JEwpxQ6F3RyLar3dUcCmBhtOVREJSpjPdAPk,10753
+codex_fastapi_cabinet-0.1.0.dist-info/RECORD,,

codex_fastapi_cabinet-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

codex_fastapi_cabinet-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 CodexDLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fastapi_cabinet/__init__.py

@@ -0,0 +1,90 @@
+from fastapi_cabinet.contracts import (
+    ActionRoute,
+    AllowAllPermissionProvider,
+    CabinetAdmin,
+    CabinetLayoutMap,
+    CabinetPage,
+    CabinetProvider,
+    ChartDatasetMap,
+    ChartWidget,
+    ChartWidgetMap,
+    DashboardWidget,
+    DetailFieldMap,
+    DetailPage,
+    DetailPageMap,
+    DetailSectionMap,
+    FilterChoiceMap,
+    FilterFieldMap,
+    FormChoiceMap,
+    FormFieldMap,
+    FormPage,
+    FormPageMap,
+    HeaderGroup,
+    HeaderItem,
+    ListPage,
+    ListPageMap,
+    ListWidget,
+    ListWidgetMap,
+    MetricWidget,
+    MetricWidgetMap,
+    OperationActionMap,
+    OperationPage,
+    OperationPageMap,
+    PageLinkMap,
+    PaginationMap,
+    PermissionProvider,
+    SidebarItem,
+    TableActionMap,
+    TableColumnMap,
+    TableWidget,
+    TableWidgetMap,
+)
+from fastapi_cabinet.fastapi import include_cabinet
+from fastapi_cabinet.registry import CabinetRegistry
+from fastapi_cabinet.site import CabinetSite, cabinet_site
+
+__all__ = [
+    "ActionRoute",
+    "AllowAllPermissionProvider",
+    "CabinetAdmin",
+    "CabinetLayoutMap",
+    "CabinetPage",
+    "CabinetProvider",
+    "CabinetRegistry",
+    "CabinetSite",
+    "ChartDatasetMap",
+    "ChartWidget",
+    "ChartWidgetMap",
+    "DashboardWidget",
+    "DetailFieldMap",
+    "DetailPage",
+    "DetailPageMap",
+    "DetailSectionMap",
+    "FilterChoiceMap",
+    "FilterFieldMap",
+    "FormChoiceMap",
+    "FormFieldMap",
+    "FormPage",
+    "FormPageMap",
+    "HeaderGroup",
+    "HeaderItem",
+    "ListPage",
+    "ListPageMap",
+    "ListWidget",
+    "ListWidgetMap",
+    "MetricWidget",
+    "MetricWidgetMap",
+    "OperationActionMap",
+    "OperationPage",
+    "OperationPageMap",
+    "PageLinkMap",
+    "PaginationMap",
+    "PermissionProvider",
+    "SidebarItem",
+    "TableActionMap",
+    "TableColumnMap",
+    "TableWidget",
+    "TableWidgetMap",
+    "cabinet_site",
+    "include_cabinet",
+]

fastapi_cabinet/contracts/__init__.py

@@ -0,0 +1,86 @@
+from fastapi_cabinet.contracts.admin import ActionRoute, CabinetAdmin
+from fastapi_cabinet.contracts.layout import CabinetLayoutMap, HeaderGroup
+from fastapi_cabinet.contracts.navigation import HeaderItem, SidebarItem
+from fastapi_cabinet.contracts.pages import (
+    CabinetPage,
+    DetailFieldMap,
+    DetailPage,
+    DetailPageMap,
+    DetailSectionMap,
+    FilterChoiceMap,
+    FilterFieldMap,
+    FormChoiceMap,
+    FormFieldMap,
+    FormPage,
+    FormPageMap,
+    ListPage,
+    ListPageMap,
+    OperationActionMap,
+    OperationPage,
+    OperationPageMap,
+    PageLinkMap,
+    PageMap,
+    PaginationMap,
+)
+from fastapi_cabinet.contracts.permissions import AllowAllPermissionProvider, PermissionProvider
+from fastapi_cabinet.contracts.providers import CabinetProvider, ProviderResult
+from fastapi_cabinet.contracts.widgets import (
+    ChartDatasetMap,
+    ChartWidget,
+    ChartWidgetMap,
+    DashboardWidget,
+    ListWidget,
+    ListWidgetMap,
+    MetricWidget,
+    MetricWidgetMap,
+    TableActionMap,
+    TableColumnMap,
+    TableWidget,
+    TableWidgetMap,
+    WidgetMap,
+)
+
+__all__ = [
+    "ActionRoute",
+    "AllowAllPermissionProvider",
+    "CabinetAdmin",
+    "CabinetLayoutMap",
+    "CabinetPage",
+    "CabinetProvider",
+    "ChartDatasetMap",
+    "ChartWidget",
+    "ChartWidgetMap",
+    "DashboardWidget",
+    "DetailFieldMap",
+    "DetailPage",
+    "DetailPageMap",
+    "DetailSectionMap",
+    "FilterChoiceMap",
+    "FilterFieldMap",
+    "FormChoiceMap",
+    "FormFieldMap",
+    "FormPage",
+    "FormPageMap",
+    "HeaderGroup",
+    "HeaderItem",
+    "ListPage",
+    "ListPageMap",
+    "ListWidget",
+    "ListWidgetMap",
+    "MetricWidget",
+    "MetricWidgetMap",
+    "OperationActionMap",
+    "OperationPage",
+    "OperationPageMap",
+    "PageLinkMap",
+    "PageMap",
+    "PaginationMap",
+    "PermissionProvider",
+    "ProviderResult",
+    "SidebarItem",
+    "TableActionMap",
+    "TableColumnMap",
+    "TableWidget",
+    "TableWidgetMap",
+    "WidgetMap",
+]

fastapi_cabinet/contracts/admin.py

@@ -0,0 +1,50 @@
+from typing import ClassVar, Literal
+
+from fastapi import Request
+from pydantic import BaseModel, ConfigDict
+from starlette.responses import Response
+
+from fastapi_cabinet.contracts.navigation import SidebarItem
+from fastapi_cabinet.contracts.pages import CabinetPage
+from fastapi_cabinet.contracts.providers import CabinetProvider
+from fastapi_cabinet.contracts.widgets import DashboardWidget
+
+
+class ActionRoute(BaseModel):
+    """Route declaration bound to a method on a CabinetAdmin instance."""
+
+    model_config = ConfigDict(frozen=True)
+
+    path: str
+    method: Literal["POST", "PUT", "PATCH", "DELETE"]
+    handler: str
+    permission: str | None = None
+    name: str | None = None
+
+
+class CabinetAdmin:
+    """Static module declaration plus application-owned async providers."""
+
+    key: ClassVar[str]
+    label: ClassVar[str]
+    icon: ClassVar[str] = ""
+    path: ClassVar[str | None] = None
+    group: ClassVar[str] = "main"
+    group_label: ClassVar[str] = ""
+    order: ClassVar[int] = 100
+    permission: ClassVar[str | None] = None
+
+    sidebar: ClassVar[tuple[SidebarItem, ...]] = ()
+    dashboard_widgets: ClassVar[tuple[DashboardWidget, ...]] = ()
+    pages: ClassVar[tuple[CabinetPage, ...]] = ()
+    providers: ClassVar[dict[str, CabinetProvider]] = {}
+    actions: ClassVar[tuple[ActionRoute, ...]] = ()
+
+    async def get_dashboard_context(self, request: Request) -> dict[str, object]:
+        return {}
+
+    async def get_sidebar_badges(self, request: Request) -> dict[str, int | str]:
+        return {}
+
+    async def dispatch_action(self, request: Request) -> Response:
+        raise NotImplementedError

fastapi_cabinet/contracts/layout.py

@@ -0,0 +1,22 @@
+from pydantic import BaseModel, Field
+
+from fastapi_cabinet.contracts.navigation import HeaderItem, SidebarItem
+
+
+class HeaderGroup(BaseModel):
+    key: str
+    label: str
+    items: list[HeaderItem]
+
+
+class CabinetLayoutMap(BaseModel):
+    mount_path: str
+    static_mount_path: str
+    static_version: str = "0"
+    brand_name: str
+    title: str
+    active_module: str | None
+    active_path: str = ""
+    header_groups: list[HeaderGroup] = Field(default_factory=list)
+    sidebar: list[SidebarItem] = Field(default_factory=list)
+    sidebar_badges: dict[str, int | str] = Field(default_factory=dict)