bazaar-contrib-server-overview 0.3.0rc1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,31 @@
1
+ Metadata-Version: 2.4
2
+ Name: bazaar-contrib-server-overview
3
+ Version: 0.3.0rc1
4
+ Summary: The overview of the Bazaar Compute server, where modules put what is worth a glance
5
+ License-Expression: Apache-2.0
6
+ License-File: LICENSE
7
+ Requires-Dist: bazaar-core~=0.3.0rc1
8
+ Requires-Dist: bazaar-contrib-schema~=0.3.0rc1
9
+ Requires-Dist: bazaar-contrib-storage~=0.3.0rc1
10
+ Requires-Dist: bazaar-contrib-server~=0.3.0rc3
11
+ Requires-Dist: bazaar-contrib-server-database~=0.3.0rc1
12
+ Requires-Dist: bazaar-contrib-server-migrations~=0.3.0rc2
13
+ Requires-Dist: pydantic>=2.12.0
14
+ Requires-Dist: python-multipart>=0.0.32
15
+ Requires-Dist: starlette>=0.48.0
16
+ Requires-Python: >=3.15
17
+ Project-URL: Repository, https://github.com/open-bazaar/contrib-server-overview
18
+ Description-Content-Type: text/markdown
19
+
20
+ # bazaar-contrib-server-overview
21
+
22
+ The overview of the Bazaar Compute server: the first page in the sidebar, where contribs put what is worth a glance and each account arranges it as it likes.
23
+
24
+ ```toml
25
+ [[contribs]]
26
+ package = "bazaar-contrib-server-overview~=0.3.0rc1"
27
+ [[contribs.enabled]]
28
+ entry = "server-overview"
29
+ ```
30
+
31
+ A contrib puts its content on the overview by accepting `OVERVIEW`.
@@ -0,0 +1,12 @@
1
+ # bazaar-contrib-server-overview
2
+
3
+ The overview of the Bazaar Compute server: the first page in the sidebar, where contribs put what is worth a glance and each account arranges it as it likes.
4
+
5
+ ```toml
6
+ [[contribs]]
7
+ package = "bazaar-contrib-server-overview~=0.3.0rc1"
8
+ [[contribs.enabled]]
9
+ entry = "server-overview"
10
+ ```
11
+
12
+ A contrib puts its content on the overview by accepting `OVERVIEW`.
@@ -0,0 +1,69 @@
1
+ [project]
2
+ name = "bazaar-contrib-server-overview"
3
+ version = "0.3.0rc1"
4
+ description = "The overview of the Bazaar Compute server, where modules put what is worth a glance"
5
+ readme = "README.md"
6
+ license = "Apache-2.0"
7
+ license-files = ["LICENSE"]
8
+ requires-python = ">=3.15"
9
+ dependencies = [
10
+ "bazaar-core~=0.3.0rc1",
11
+ "bazaar-contrib-schema~=0.3.0rc1",
12
+ "bazaar-contrib-storage~=0.3.0rc1",
13
+ "bazaar-contrib-server~=0.3.0rc3",
14
+ "bazaar-contrib-server-database~=0.3.0rc1",
15
+ "bazaar-contrib-server-migrations~=0.3.0rc2",
16
+ "pydantic>=2.12.0",
17
+ "python-multipart>=0.0.32",
18
+ "starlette>=0.48.0",
19
+ ]
20
+
21
+ [project.entry-points."bazaar_compute_node.contribs"]
22
+ server-overview = "bazaar_contrib_server_overview:overview"
23
+
24
+ [project.urls]
25
+ Repository = "https://github.com/open-bazaar/contrib-server-overview"
26
+
27
+ [build-system]
28
+ requires = ["uv_build>=0.13.0,<0.14.0"]
29
+ build-backend = "uv_build"
30
+
31
+ [tool.pytest.ini_options]
32
+ testpaths = ["tests"]
33
+ addopts = "-p no:anyio"
34
+ asyncio_mode = "auto"
35
+ asyncio_default_fixture_loop_scope = "function"
36
+
37
+ [tool.pyright]
38
+ include = [
39
+ "src",
40
+ "tests",
41
+ "scripts",
42
+ ]
43
+ pythonVersion = "3.15"
44
+ pythonPlatform = "All"
45
+ venvPath = "."
46
+ venv = ".venv"
47
+ typeCheckingMode = "basic"
48
+ reportMatchNotExhaustive = "error"
49
+ reportUnreachable = "warning"
50
+ reportUnusedFunction = "warning"
51
+ reportUnusedVariable = "warning"
52
+
53
+ [tool.ruff.lint]
54
+ extend-select = ["ASYNC"]
55
+
56
+ [dependency-groups]
57
+ dev = [
58
+ "bazaar-contrib-http~=0.3.0rc1",
59
+ "bazaar-contrib-server-access~=0.3.0rc2",
60
+ "bazaar-contrib-sqlite~=0.3.0rc1",
61
+ "bazaar-contrib-timer-wheel~=0.3.0rc1",
62
+ "blockbuster>=1.5.29,<1.6",
63
+ "httpx>=0.28.0,<1",
64
+ "playwright>=1.55.0",
65
+ "pyright==1.1.414",
66
+ "pytest>=8.3.0",
67
+ "pytest-asyncio>=0.24.0",
68
+ "ruff>=0.9.0",
69
+ ]
@@ -0,0 +1,65 @@
1
+ [project]
2
+ name = "bazaar-contrib-server-overview"
3
+ version = "0.3.0rc1"
4
+ description = "The overview of the Bazaar Compute server, where modules put what is worth a glance"
5
+ readme = "README.md"
6
+ license = "Apache-2.0"
7
+ license-files = ["LICENSE"]
8
+ requires-python = ">=3.15"
9
+ dependencies = [
10
+ "bazaar-core~=0.3.0rc1",
11
+ "bazaar-contrib-schema~=0.3.0rc1",
12
+ "bazaar-contrib-storage~=0.3.0rc1",
13
+ "bazaar-contrib-server~=0.3.0rc3",
14
+ "bazaar-contrib-server-database~=0.3.0rc1",
15
+ "bazaar-contrib-server-migrations~=0.3.0rc2",
16
+ "pydantic>=2.12.0",
17
+ "python-multipart>=0.0.32",
18
+ "starlette>=0.48.0",
19
+ ]
20
+
21
+ [project.entry-points."bazaar_compute_node.contribs"]
22
+ server-overview = "bazaar_contrib_server_overview:overview"
23
+
24
+ [project.urls]
25
+ Repository = "https://github.com/open-bazaar/contrib-server-overview"
26
+
27
+ [build-system]
28
+ requires = ["uv_build>=0.13.0,<0.14.0"]
29
+ build-backend = "uv_build"
30
+
31
+ [tool.pytest.ini_options]
32
+ testpaths = ["tests"]
33
+ addopts = "-p no:anyio"
34
+ asyncio_mode = "auto"
35
+ asyncio_default_fixture_loop_scope = "function"
36
+
37
+ [tool.pyright]
38
+ include = ["src", "tests", "scripts"]
39
+ pythonVersion = "3.15"
40
+ pythonPlatform = "All"
41
+ venvPath = "."
42
+ venv = ".venv"
43
+ typeCheckingMode = "basic"
44
+ reportMatchNotExhaustive = "error"
45
+ reportUnreachable = "warning"
46
+ reportUnusedFunction = "warning"
47
+ reportUnusedVariable = "warning"
48
+
49
+ [tool.ruff.lint]
50
+ extend-select = ["ASYNC"]
51
+
52
+ [dependency-groups]
53
+ dev = [
54
+ "bazaar-contrib-http~=0.3.0rc1",
55
+ "bazaar-contrib-server-access~=0.3.0rc2",
56
+ "bazaar-contrib-sqlite~=0.3.0rc1",
57
+ "bazaar-contrib-timer-wheel~=0.3.0rc1",
58
+ "blockbuster>=1.5.29,<1.6",
59
+ "httpx>=0.28.0,<1",
60
+ "playwright>=1.55.0",
61
+ "pyright==1.1.414",
62
+ "pytest>=8.3.0",
63
+ "pytest-asyncio>=0.24.0",
64
+ "ruff>=0.9.0",
65
+ ]
@@ -0,0 +1,53 @@
1
+ """The overview: the place in the sidebar's workbench where modules put what is
2
+ worth a glance, each account ordering it as it likes."""
3
+
4
+ from __future__ import annotations
5
+
6
+ from contextlib import asynccontextmanager
7
+ lazy import asyncio
8
+ lazy from collections.abc import AsyncIterator
9
+ lazy from importlib.resources import files
10
+ lazy from pathlib import Path
11
+
12
+ from bazaar_contrib_server import SERVER, SidebarItem
13
+ from bazaar_contrib_server_database import SERVER_DB, SERVER_SCHEMA
14
+ from bazaar_contrib_server_migrations import SERVER_MIGRATIONS
15
+ from bazaar_core import Context, Contrib
16
+
17
+ from .contracts import OVERVIEW, Overview, OverviewItem
18
+ lazy from .board import Board
19
+ lazy from .schema import MODULE
20
+
21
+ __all__ = ["OVERVIEW", "Overview", "OverviewItem", "overview"]
22
+
23
+
24
+ @asynccontextmanager
25
+ async def _overview(ctx: Context) -> AsyncIterator[None]:
26
+ server = ctx.accept(SERVER)
27
+ async with ctx.accept(SERVER_SCHEMA).register(MODULE):
28
+ resources = Path(str(files(__name__))) / "resources"
29
+ icon = await asyncio.to_thread(
30
+ (resources / "templates" / "overview" / "layout-dashboard.svg").read_text,
31
+ encoding="utf-8",
32
+ )
33
+ board = Board(await server.pages("overview", __name__), ctx.accept(SERVER_DB))
34
+ async with (
35
+ server.module("overview", ui=board.app, locales=resources / "locales"),
36
+ server.sidebar(
37
+ SidebarItem(
38
+ text="overview.title",
39
+ icon=icon,
40
+ path="/overview",
41
+ group="server.sidebar.workbench",
42
+ )
43
+ ),
44
+ ):
45
+ ctx.offer(OVERVIEW, board)
46
+ yield
47
+
48
+
49
+ overview = Contrib(
50
+ accepts=[SERVER, SERVER_DB, SERVER_SCHEMA, SERVER_MIGRATIONS],
51
+ offers=[OVERVIEW],
52
+ lifespan=_overview,
53
+ )
@@ -0,0 +1,135 @@
1
+ """The overview page: the content the account may see, in the order it chose."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from contextlib import asynccontextmanager
6
+ lazy from collections.abc import AsyncIterator
7
+ lazy from typing import Literal, cast
8
+
9
+ lazy from bazaar_contrib_server import Account, Pages
10
+ lazy from bazaar_contrib_storage import (
11
+ Column,
12
+ Compare,
13
+ Database,
14
+ Delete,
15
+ Insert,
16
+ Select,
17
+ Session,
18
+ Value,
19
+ )
20
+ lazy from pydantic import BaseModel, ValidationError
21
+ lazy from starlette.exceptions import HTTPException
22
+ lazy from starlette.requests import Request
23
+ lazy from starlette.responses import Response
24
+ lazy from starlette.routing import Route
25
+ lazy from starlette.types import ASGIApp
26
+
27
+ lazy from .contracts import OverviewItem
28
+
29
+
30
+ class _Move(BaseModel):
31
+ key: str
32
+ toward: Literal["earlier", "later"]
33
+
34
+
35
+ class Board:
36
+ """OVERVIEW: the content registered on the overview, and its page."""
37
+
38
+ def __init__(self, pages: Pages, database: Database) -> None:
39
+ self._pages = pages
40
+ self._database = database
41
+ self._items: list[OverviewItem] = []
42
+ self.app: ASGIApp = pages.application(
43
+ [Route("/", self._page), Route("/move", self._move, methods=["POST"])]
44
+ )
45
+
46
+ @asynccontextmanager
47
+ async def register(self, item: OverviewItem) -> AsyncIterator[None]:
48
+ if any(registered.key == item.key for registered in self._items):
49
+ raise ValueError(f"overview content {item.key!r} is already registered")
50
+ self._items.append(item)
51
+ try:
52
+ yield
53
+ finally:
54
+ self._items.remove(item)
55
+
56
+ async def _positions(self, account: Account) -> dict[str, int]:
57
+ rows = await self._database.read(
58
+ lambda session: session.select(
59
+ Select(
60
+ table="overview_positions",
61
+ where=Compare(
62
+ left=Column(name="account_id"),
63
+ operator="=",
64
+ right=Value(value=account.id),
65
+ ),
66
+ )
67
+ )
68
+ )
69
+ return {cast(str, row["key"]): cast(int, row["position"]) for row in rows}
70
+
71
+ def _ordered(
72
+ self, account: Account, positions: dict[str, int]
73
+ ) -> list[OverviewItem]:
74
+ """The content the account may see, in the order it chose; what it
75
+ never placed follows, in the order it was registered."""
76
+ return sorted(
77
+ (
78
+ item
79
+ for item in self._items
80
+ if item.permission is None or account.allows(item.permission)
81
+ ),
82
+ key=lambda item: (item.key not in positions, positions.get(item.key, 0)),
83
+ )
84
+
85
+ async def _page(self, request: Request) -> Response:
86
+ account: Account = request.state.account
87
+ return await self._pages.render(
88
+ request,
89
+ "overview/overview.html",
90
+ items=self._ordered(account, await self._positions(account)),
91
+ )
92
+
93
+ async def _move(self, request: Request) -> Response:
94
+ account: Account = request.state.account
95
+ try:
96
+ move = _Move.model_validate(dict(await request.form()))
97
+ except ValidationError as error:
98
+ raise HTTPException(status_code=422, detail=str(error)) from error
99
+ positions = await self._positions(account)
100
+ items = self._ordered(account, positions)
101
+ keys = [item.key for item in items]
102
+ if move.key not in keys:
103
+ raise HTTPException(status_code=404)
104
+ index = keys.index(move.key)
105
+ step = -1 if move.toward == "earlier" else 1
106
+ items.insert(min(max(index + step, 0), len(items) - 1), items.pop(index))
107
+ # what the account cannot see now keeps its place for when it can again
108
+ shown = iter(item.key for item in items)
109
+ order = [
110
+ next(shown) if key in keys else key
111
+ for key in [
112
+ *sorted(positions, key=positions.__getitem__),
113
+ *(key for key in keys if key not in positions),
114
+ ]
115
+ ]
116
+
117
+ async def save(session: Session) -> None:
118
+ mine = Compare(
119
+ left=Column(name="account_id"),
120
+ operator="=",
121
+ right=Value(value=account.id),
122
+ )
123
+ await session.delete(Delete(table="overview_positions", where=mine))
124
+ await session.insert(
125
+ Insert(
126
+ table="overview_positions",
127
+ rows=tuple(
128
+ {"account_id": account.id, "key": key, "position": place}
129
+ for place, key in enumerate(order)
130
+ ),
131
+ )
132
+ )
133
+
134
+ await self._database.transaction(save)
135
+ return await self._pages.render(request, "overview/board.html", items=items)
@@ -0,0 +1,33 @@
1
+ """What modules hold the overview to: where they put what is worth a glance."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing import Protocol
6
+ lazy from contextlib import AbstractAsyncContextManager
7
+
8
+ from bazaar_core import ServiceKey
9
+ from pydantic import BaseModel, ConfigDict, Field
10
+
11
+ # one segment of an address, as the server's own registrations take
12
+ NAME = r"^[a-z][a-z0-9-]*$"
13
+
14
+
15
+ class OverviewItem(BaseModel):
16
+ """Content of the overview, loaded in an iframe, for the accounts holding
17
+ its permission point."""
18
+
19
+ model_config = ConfigDict(extra="forbid", frozen=True)
20
+
21
+ key: str = Field(pattern=NAME)
22
+ title: str
23
+ src: str
24
+ permission: str | None = None
25
+
26
+
27
+ class Overview(Protocol):
28
+ def register(self, item: OverviewItem) -> AbstractAsyncContextManager[None]:
29
+ """Show the content on the overview while open."""
30
+ ...
31
+
32
+
33
+ OVERVIEW = ServiceKey[Overview]("server.overview")
@@ -0,0 +1,4 @@
1
+ "overview.title" = "Overview"
2
+ "overview.empty" = "Nothing is on the overview yet."
3
+ "overview.earlier" = "Move earlier"
4
+ "overview.later" = "Move later"
@@ -0,0 +1,4 @@
1
+ "overview.title" = "总览"
2
+ "overview.empty" = "总览上还没有内容。"
3
+ "overview.earlier" = "前移"
4
+ "overview.later" = "后移"
@@ -0,0 +1,17 @@
1
+ {% import "server/icons.html" as icons %}
2
+ <div class="board" id="board">
3
+ {% for item in items %}
4
+ <article class="card tile">
5
+ <header class="card-hd">
6
+ <h3>{{ t.text(item.title) }}</h3>
7
+ <span class="more">
8
+ {% if not loop.first %}<button class="btn ghost sm" type="button" hx-post="move" hx-vals='{{ {"key": item.key, "toward": "earlier"} | tojson }}' hx-target="#board" hx-swap="outerHTML" aria-label="{{ t.text('overview.earlier') }}">{{ icons.icon("chevron-left") }}</button>{% endif %}
9
+ {% if not loop.last %}<button class="btn ghost sm" type="button" hx-post="move" hx-vals='{{ {"key": item.key, "toward": "later"} | tojson }}' hx-target="#board" hx-swap="outerHTML" aria-label="{{ t.text('overview.later') }}">{{ icons.icon("chevron-right") }}</button>{% endif %}
10
+ </span>
11
+ </header>
12
+ <iframe src="{{ item.src }}" data-fit title="{{ t.text(item.title) }}"></iframe>
13
+ </article>
14
+ {% else %}
15
+ <p class="empty">{{ t.text("overview.empty") }}</p>
16
+ {% endfor %}
17
+ </div>
@@ -0,0 +1 @@
1
+ <!-- @license lucide-static v1.46.0 - ISC --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" ><rect width="7" height="9" x="3" y="3" rx="1" /><rect width="7" height="5" x="14" y="3" rx="1" /><rect width="7" height="9" x="14" y="12" rx="1" /><rect width="7" height="5" x="3" y="16" rx="1" /></svg>
@@ -0,0 +1,5 @@
1
+ {% extends "server/base.html" %}
2
+ {% block title %}{{ t.text("overview.title") }}{% endblock %}
3
+ {% block body %}
4
+ <section class="content">{% include "overview/board.html" %}</section>
5
+ {% endblock %}
@@ -0,0 +1,25 @@
1
+ """The order each account gave the overview's content."""
2
+
3
+ import bazaar_contrib_storage as s
4
+ from bazaar_contrib_schema import Migration, ModuleSchema
5
+
6
+ POSITIONS = s.Table(
7
+ name="overview_positions",
8
+ columns=(
9
+ s.ColumnDefinition(name="account_id", type="text"),
10
+ s.ColumnDefinition(name="key", type="text"),
11
+ s.ColumnDefinition(name="position", type="integer"),
12
+ ),
13
+ primary_key=("account_id", "key"),
14
+ )
15
+
16
+ MODULE = ModuleSchema(
17
+ tables=("overview_positions",),
18
+ migrations=(
19
+ Migration(
20
+ version=1,
21
+ name="overview_positions",
22
+ operations=(s.CreateTable(table=POSITIONS),),
23
+ ),
24
+ ),
25
+ )