Skip to content

feat: add support allowed_layouts in smartapp manifest #526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmitriichmil merged 1 commit into from
Oct 9, 2025
Merged

feat: add support allowed_layouts in smartapp manifest #526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion pybotx/client/smartapps_api/smartapp_manifest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import List, Literal
from typing import List, Literal, Optional
from uuid import UUID

from pydantic import Field
Expand All @@ -24,6 +24,7 @@ class SmartappManifestAuroraParams(VerifiedPayloadBaseModel):
class SmartappManifestWebParams(VerifiedPayloadBaseModel):
default_layout: WebLayoutChoices = WebLayoutChoices.minimal
expanded_layout: WebLayoutChoices = WebLayoutChoices.half
allowed_layouts: Optional[list[WebLayoutChoices]] = None
always_pinned: bool = False


Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "pybotx"
version = "0.75.3"
version = "0.75.4"
description = "A python library for interacting with eXpress BotX API"
authors = [
"Sidnev Nikolay <nsidnev@ccsteam.ru>",
Expand Down
324 changes: 324 additions & 0 deletions tests/client/smartapps_api/test_smartapp_manifest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ async def test__send_smartapp_manifest__all_params_provided__succeed(
"fullscreen_layout": False,
},
"web": {
"allowed_layouts": None,
"always_pinned": True,
"default_layout": "full",
"expanded_layout": "full",
Expand All @@ -69,6 +70,7 @@ async def test__send_smartapp_manifest__all_params_provided__succeed(
"fullscreen_layout": False,
},
"web": {
"allowed_layouts": None,
"always_pinned": True,
"default_layout": "full",
"expanded_layout": "full",
Expand Down Expand Up @@ -155,6 +157,7 @@ async def test__send_smartapp_manifest__only_default_params_provided__succeed(
"fullscreen_layout": False,
},
"web": {
"allowed_layouts": None,
"always_pinned": False,
"default_layout": "minimal",
"expanded_layout": "half",
Expand Down Expand Up @@ -196,3 +199,324 @@ async def test__send_smartapp_manifest__only_default_params_provided__succeed(
app_id=[],
),
)


async def test__send_smartapp_manifest__with_only_full_layout__succeed(
respx_mock: MockRouter,
host: str,
bot_id: UUID,
bot_account: BotAccountWithSecret,
) -> None:
# - Arrange -
endpoint = respx_mock.post(
f"https://{host}/api/v1/botx/smartapps/manifest",
headers={"Authorization": "Bearer token", "Content-Type": "application/json"},
json={
"manifest": {
"android": {"fullscreen_layout": False},
"ios": {"fullscreen_layout": False},
"unread_counter_link": {
"app_id": ["test_app"],
"group_chat_id": [],
"user_huid": [],
},
"web": {
"allowed_layouts": ["full"],
"always_pinned": False,
"default_layout": "full",
"expanded_layout": "full",
},
},
},
).mock(
return_value=httpx.Response(
HTTPStatus.ACCEPTED,
json={
"result": {
"android": {
"always_pinned": False,
"fullscreen_layout": False,
"lock_portrait_orientation": False,
},
"ios": {"always_pinned": False, "fullscreen_layout": False},
"unread_counter_link": {
"app_id": ["test_app"],
"group_chat_id": [],
"user_huid": [],
},
"web": {
"allowed_layouts": ["full"],
"always_pinned": False,
"default_layout": "full",
"expanded_layout": "full",
"raster_icon": None,
"vector_icon": None,
},
},
"status": "ok",
},
),
)

built_bot = Bot(collectors=[HandlerCollector()], bot_accounts=[bot_account])

# - Act -
async with lifespan_wrapper(built_bot) as bot:
smartapp_manifest = await bot.send_smartapp_manifest(
bot_id=bot_id,
ios=SmartappManifestIosParams(
fullscreen_layout=False,
),
android=SmartappManifestAndroidParams(
fullscreen_layout=False,
),
web_layout=SmartappManifestWebParams(
default_layout=SmartappManifestWebLayoutChoices.full,
expanded_layout=SmartappManifestWebLayoutChoices.full,
allowed_layouts=[SmartappManifestWebLayoutChoices.full],
always_pinned=False,
),
unread_counter=SmartappManifestUnreadCounterParams(
user_huid=[],
group_chat_id=[],
app_id=["test_app"],
),
)

# - Assert -
assert endpoint.called
assert smartapp_manifest == SmartappManifest(
ios=SmartappManifestIosParams(
fullscreen_layout=False,
),
android=SmartappManifestAndroidParams(
fullscreen_layout=False,
),
web=SmartappManifestWebParams(
default_layout=SmartappManifestWebLayoutChoices.full,
expanded_layout=SmartappManifestWebLayoutChoices.full,
allowed_layouts=[SmartappManifestWebLayoutChoices.full],
always_pinned=False,
),
unread_counter_link=SmartappManifestUnreadCounterParams(
user_huid=[],
group_chat_id=[],
app_id=["test_app"],
),
)


async def test__send_smartapp_manifest__with_only_minimal_and_full_layout__succeed(
respx_mock: MockRouter,
host: str,
bot_id: UUID,
bot_account: BotAccountWithSecret,
) -> None:
# - Arrange -
endpoint = respx_mock.post(
f"https://{host}/api/v1/botx/smartapps/manifest",
headers={"Authorization": "Bearer token", "Content-Type": "application/json"},
json={
"manifest": {
"android": {"fullscreen_layout": False},
"ios": {"fullscreen_layout": False},
"unread_counter_link": {
"app_id": ["test_app"],
"group_chat_id": [],
"user_huid": [],
},
"web": {
"allowed_layouts": ["minimal", "full"],
"always_pinned": False,
"default_layout": "minimal",
"expanded_layout": "full",
},
},
},
).mock(
return_value=httpx.Response(
HTTPStatus.ACCEPTED,
json={
"result": {
"android": {
"always_pinned": False,
"fullscreen_layout": False,
"lock_portrait_orientation": False,
},
"ios": {"always_pinned": False, "fullscreen_layout": False},
"unread_counter_link": {
"app_id": ["test_app"],
"group_chat_id": [],
"user_huid": [],
},
"web": {
"allowed_layouts": ["minimal", "full"],
"always_pinned": False,
"default_layout": "minimal",
"expanded_layout": "full",
"raster_icon": None,
"vector_icon": None,
},
},
"status": "ok",
},
),
)

built_bot = Bot(collectors=[HandlerCollector()], bot_accounts=[bot_account])

# - Act -
async with lifespan_wrapper(built_bot) as bot:
smartapp_manifest = await bot.send_smartapp_manifest(
bot_id=bot_id,
ios=SmartappManifestIosParams(
fullscreen_layout=False,
),
android=SmartappManifestAndroidParams(
fullscreen_layout=False,
),
web_layout=SmartappManifestWebParams(
default_layout=SmartappManifestWebLayoutChoices.minimal,
expanded_layout=SmartappManifestWebLayoutChoices.full,
allowed_layouts=[
SmartappManifestWebLayoutChoices.minimal,
SmartappManifestWebLayoutChoices.full,
],
always_pinned=False,
),
unread_counter=SmartappManifestUnreadCounterParams(
user_huid=[],
group_chat_id=[],
app_id=["test_app"],
),
)

# - Assert -
assert endpoint.called
assert smartapp_manifest == SmartappManifest(
ios=SmartappManifestIosParams(
fullscreen_layout=False,
),
android=SmartappManifestAndroidParams(
fullscreen_layout=False,
),
web=SmartappManifestWebParams(
default_layout=SmartappManifestWebLayoutChoices.minimal,
expanded_layout=SmartappManifestWebLayoutChoices.full,
allowed_layouts=[
SmartappManifestWebLayoutChoices.minimal,
SmartappManifestWebLayoutChoices.full,
],
always_pinned=False,
),
unread_counter_link=SmartappManifestUnreadCounterParams(
user_huid=[],
group_chat_id=[],
app_id=["test_app"],
),
)


async def test__send_smartapp_manifest__with_empty_layout__succeed(
respx_mock: MockRouter,
host: str,
bot_id: UUID,
bot_account: BotAccountWithSecret,
) -> None:
# - Arrange -
endpoint = respx_mock.post(
f"https://{host}/api/v1/botx/smartapps/manifest",
headers={"Authorization": "Bearer token", "Content-Type": "application/json"},
json={
"manifest": {
"android": {"fullscreen_layout": False},
"ios": {"fullscreen_layout": False},
"unread_counter_link": {
"app_id": ["test_app"],
"group_chat_id": [],
"user_huid": [],
},
"web": {
"allowed_layouts": [],
"always_pinned": False,
"default_layout": "minimal",
"expanded_layout": "full",
},
},
},
).mock(
return_value=httpx.Response(
HTTPStatus.ACCEPTED,
json={
"result": {
"android": {
"always_pinned": False,
"fullscreen_layout": False,
"lock_portrait_orientation": False,
},
"ios": {"always_pinned": False, "fullscreen_layout": False},
"unread_counter_link": {
"app_id": ["test_app"],
"group_chat_id": [],
"user_huid": [],
},
"web": {
"allowed_layouts": [],
"always_pinned": False,
"default_layout": "minimal",
"expanded_layout": "full",
"raster_icon": None,
"vector_icon": None,
},
},
"status": "ok",
},
),
)

built_bot = Bot(collectors=[HandlerCollector()], bot_accounts=[bot_account])

# - Act -
async with lifespan_wrapper(built_bot) as bot:
smartapp_manifest = await bot.send_smartapp_manifest(
bot_id=bot_id,
ios=SmartappManifestIosParams(
fullscreen_layout=False,
),
android=SmartappManifestAndroidParams(
fullscreen_layout=False,
),
web_layout=SmartappManifestWebParams(
default_layout=SmartappManifestWebLayoutChoices.minimal,
expanded_layout=SmartappManifestWebLayoutChoices.full,
allowed_layouts=[],
always_pinned=False,
),
unread_counter=SmartappManifestUnreadCounterParams(
user_huid=[],
group_chat_id=[],
app_id=["test_app"],
),
)

# - Assert -
assert endpoint.called
assert smartapp_manifest == SmartappManifest(
ios=SmartappManifestIosParams(
fullscreen_layout=False,
),
android=SmartappManifestAndroidParams(
fullscreen_layout=False,
),
web=SmartappManifestWebParams(
default_layout=SmartappManifestWebLayoutChoices.minimal,
expanded_layout=SmartappManifestWebLayoutChoices.full,
allowed_layouts=[],
always_pinned=False,
),
unread_counter_link=SmartappManifestUnreadCounterParams(
user_huid=[],
group_chat_id=[],
app_id=["test_app"],
),
)
Loading