sonolus-models 0.1.1__tar.gz

sonolus_models-0.1.1/.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

sonolus_models-0.1.1/.python-version

@@ -0,0 +1 @@
+3.13

sonolus_models-0.1.1/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: sonolus-models
+Version: 0.1.1
+Summary: Define a Pydantic model for use within the Sonolus server and similar environments.
+Project-URL: Homepage, https://github.com/yourusername/sonolus-models
+Project-URL: Repository, https://github.com/yourusername/sonolus-models
+Author-email: Your Name <your.email@example.com>
+License: MIT
+Keywords: models,pydantic,sonolus
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Requires-Dist: pydantic>=2.12.5
+Description-Content-Type: text/markdown
+
+# Sonolus-Models

sonolus_models-0.1.1/README.md

@@ -0,0 +1 @@
+# Sonolus-Models

sonolus_models-0.1.1/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sonolus-models"
+version = "0.1.1"
+description = "Define a Pydantic model for use within the Sonolus server and similar environments."
+readme = "README.md"
+requires-python = ">=3.12"
+license = {text = "MIT"}
+authors = [
+    {name = "Your Name", email = "your.email@example.com"}
+]
+keywords = ["sonolus", "pydantic", "models"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "pydantic>=2.12.5",
+]
+
+[project.urls]
+Homepage = "https://github.com/yourusername/sonolus-models"
+Repository = "https://github.com/yourusername/sonolus-models"

sonolus_models-0.1.1/sonolus_models/Request/ServerAuthenticateExternal.py

@@ -0,0 +1,16 @@
+from pydantic import BaseModel, Field
+from ..userprofile import ServiceUserProfile
+
+class ServerAuthenticateExternalRequest(BaseModel):
+    """
+    サーバー外部認証リクエストモデル
+    """
+    type: str
+    url: str
+    time: int
+    user_profile: ServiceUserProfile = Field(..., alias='userProfile')
+    
+    class Config:
+        populate_by_name = True
+        extra = 'ignore'
+        validate_by_name = True

sonolus_models-0.1.1/sonolus_models/Request/ServerSubmitItemCommunityActionRequest.py

@@ -0,0 +1,4 @@
+from pydantic import BaseModel
+
+class ServerSubmitItemCommunityActionRequest(BaseModel):
+    values: str

sonolus_models-0.1.1/sonolus_models/Request/ServerSubmitLevelResultRequest.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel
+from ..items.replay import ReplayItem
+
+class ServerSubmitLevelResultRequest(BaseModel):
+    """
+    レベル結果提出リクエストモデル
+    """
+    replay: ReplayItem
+    values: str

sonolus_models-0.1.1/sonolus_models/Request/authenticate.py

@@ -0,0 +1,17 @@
+from pydantic import BaseModel, Field
+from typing import Optional
+from ..userprofile import ServiceUserProfile
+
+class ServerAuthenticateRequest(BaseModel):
+    """
+    サーバー認証リクエストモデル
+    """
+    type: str
+    address: str  
+    time: int
+    user_profile: ServiceUserProfile = Field(..., alias='userProfile')
+    
+    class Config:
+        populate_by_name = True
+        extra = 'ignore'
+        validate_by_name = True

sonolus_models-0.1.1/sonolus_models/Response/ServerAuthenticateExternal.py

@@ -0,0 +1,14 @@
+from pydantic import BaseModel, Field
+
+class ServerAuthenticateExternalResponse(BaseModel):
+    """
+    サーバー外部認証レスポンスモデル
+    """
+    message: str = Field(..., description="サーバーメッセージ")
+    token: str = Field(..., description="認証トークン")
+    secret: str = Field(..., description="認証シークレット")
+
+    class Config:
+        populate_by_name = True
+        extra = 'ignore'
+        validate_by_name = True

sonolus_models-0.1.1/sonolus_models/Response/ServerSubmitItemActionResponse.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel
+from typing import Optional
+
+class ServerSubmitItemActionResponse(BaseModel):
+    key: str
+    hashes: list[str]
+    shouldUpdateItem: Optional[bool] = None
+    shouldRemoveItem: Optional[bool] = None
+    shouldNavigateToItem: Optional[str] = None

sonolus_models-0.1.1/sonolus_models/Response/ServerSubmitItemCommunityActionResponse.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel
+from typing import List, Optional
+
+class ServerSubmitItemCommunityActionResponse(BaseModel):
+    key: str
+    hashes: List[str]
+    shouldUpdateCommunity: Optional[bool] = None
+    shouldUpdateComments: Optional[bool] = None
+    shouldNavigateCommentsToPage: Optional[int] = None

sonolus_models-0.1.1/sonolus_models/Response/ServerSubmitLevelResultResponse.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel
+
+class ServerSubmitLevelResultResponse(BaseModel):
+    """
+    レベル結果提出レスポンスモデル
+    """
+    key: str
+    hashes: list[str]

sonolus_models-0.1.1/sonolus_models/Response/authenticate.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel
+
+class ServerAuthenticateResponse(BaseModel):
+    """
+    サーバー認証レスポンスモデル
+    """
+    session: str
+    expiration: int

sonolus_models-0.1.1/sonolus_models/ServerItemCommunityComment.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel
+from .ServerOption import ServerForm
+
+class ServerItemCommunityComment(BaseModel):
+    name: str
+    author: str
+    time: int
+    content: str
+    actions: list[ServerForm] = []

sonolus_models-0.1.1/sonolus_models/ServerItemCommunityCommentList.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel
+from typing import Optional
+from .ServerItemCommunityComment import ServerItemCommunityComment
+
+class ServerItemCommunityCommentList(BaseModel):
+    pageCount: int
+    cursor: Optional[str] = None
+    comments: list[ServerItemCommunityComment]

sonolus_models-0.1.1/sonolus_models/ServerItemCommunityInfo.py

@@ -0,0 +1,7 @@
+from pydantic import BaseModel
+from .ServerItemCommunityComment import ServerItemCommunityComment
+from .ServerOption import ServerForm
+
+class ServerItemCommunityInfo(BaseModel):
+    actions: list[ServerForm] = []
+    topComments: list[ServerItemCommunityComment] = []

sonolus_models-0.1.1/sonolus_models/ServerItemDetails.py

@@ -0,0 +1,19 @@
+from pydantic import BaseModel, Field
+from typing import Generic, TypeVar, Optional, List, Union
+from .ServerOption import ServerForm
+from .sections import ServerItemSection
+
+T = TypeVar('T')
+
+class ServerItemLeaderboard(BaseModel):
+    name: str
+    title: str
+    description: Optional[str] = None
+
+class ServerItemDetails(BaseModel, Generic[T]):
+    item: T
+    description: Optional[str] = None
+    actions: List[ServerForm] = Field(default_factory=list)
+    hasCommunity: bool
+    leaderboards: List[ServerItemLeaderboard] = Field(default_factory=list)
+    sections: List[ServerItemSection] = Field(default_factory=list)

sonolus_models-0.1.1/sonolus_models/ServerItemInfo.py

@@ -0,0 +1,15 @@
+from pydantic import BaseModel, Field
+from typing import List, Dict, Any, Optional
+from .base import SonolusResourceLocator
+from .ServerOption import ServerForm
+from .sections import ServerItemSection
+
+class ServerItemInfo(BaseModel):
+    # https://wiki.sonolus.com/ja/custom-server-specs/endpoints/get-sonolus-type-info
+    """
+    サーバーのアイテム情報を定義
+    """
+    creates: List[ServerForm] = Field(default_factory=list)
+    searches: List[ServerForm] = Field(default_factory=list)
+    sections: List[ServerItemSection] = Field(default_factory=list) 
+    banner: Optional[SonolusResourceLocator] = None

sonolus_models-0.1.1/sonolus_models/ServerItemLeaderboardDetails.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+from typing import List
+from .ServerItemLeaderboardRecord import ServerItemLeaderboardRecord
+
+class ServerItemLeaderboardDetails(BaseModel):
+    topRecords: List[ServerItemLeaderboardRecord]

sonolus_models-0.1.1/sonolus_models/ServerItemLeaderboardRecord.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel
+from typing import Union
+
+class ServerItemLeaderboardRecord(BaseModel):
+    name: str
+    rank: str
+    player: str
+    value: str

sonolus_models-0.1.1/sonolus_models/ServerItemList.py

@@ -0,0 +1,14 @@
+from pydantic import BaseModel, Field
+from typing import List, Dict, Any, Optional, Union, TypeVar
+from .ServerOption import ServerForm
+
+T = TypeVar('T')
+
+class ServerItemList(BaseModel):
+    # https://wiki.sonolus.com/ja/custom-server-specs/endpoints/get-sonolus-type-list
+    """
+    サーバーのアイテムリストを定義
+    """
+    pageCount: int = Field(..., description="ページ数")
+    items: List[T] = Field(default_factory=list, description="アイテムのリスト") # 一ページ20個まで
+    searches: Optional[List[ServerForm]] = Field(None, description="検索フォームのリスト")

sonolus_models-0.1.1/sonolus_models/ServerMessage.py

@@ -0,0 +1,7 @@
+from pydantic import BaseModel
+
+class ServerMessage(BaseModel):
+    """
+    サーバーメッセージモデル
+    """
+    message: str

sonolus_models-0.1.1/sonolus_models/ServerOption.py

@@ -0,0 +1,142 @@
+from pydantic import BaseModel, Field
+from typing import List, Dict, Any, Optional, Union, Literal
+from enum import Enum
+
+class ItemType(str, Enum):
+    """アイテムタイプの定義"""
+    POST = "post"
+    PLAYLIST = "playlist"
+    LEVEL = "level"
+    SKIN = "skin"
+    BACKGROUND = "background"
+    EFFECT = "effect"
+    PARTICLE = "particle"
+    ENGINE = "engine"
+    REPLAY = "replay"
+    ROOM = "room"
+
+class SelectValue(BaseModel):
+    """セレクト/マルチオプションの値"""
+    name: str
+    title: Union[str, Dict[str, Any]]  # Text型（多言語対応）またはstring
+
+class ServerOptionBase(BaseModel):
+    """全てのServerOptionの基底クラス"""
+    query: str
+    name: Union[str, Dict[str, Any]]  # Text型（多言語対応）またはstring
+    description: Optional[str] = None
+    required: bool
+
+class ServerTextOption(ServerOptionBase):
+    """テキスト入力オプション"""
+    type: Literal["text"] = "text"
+    def_: str = Field(alias="def")  # Pythonの予約語を回避
+    placeholder: Union[str, Dict[str, Any]]
+    limit: int
+    shortcuts: List[str]
+    class Config:
+        populate_by_name = True
+
+class ServerTextAreaOption(ServerOptionBase):
+    """テキストエリア入力オプション"""
+    type: Literal["textArea"] = "textArea"
+    def_: str = Field(alias="def")
+    placeholder: Union[str, Dict[str, Any]]
+    limit: int
+    shortcuts: List[str]
+    class Config:
+        populate_by_name = True
+
+class ServerSliderOption(ServerOptionBase):
+    """スライダー入力オプション"""
+    type: Literal["slider"] = "slider"
+    def_: float = Field(alias="def")
+    min: float
+    max: float
+    step: float
+    unit: Optional[Union[str, Dict[str, Any]]] = None
+    class Config:
+        populate_by_name = True
+
+class ServerToggleOption(ServerOptionBase):
+    """トグル（ON/OFF）オプション"""
+    type: Literal["toggle"] = "toggle"
+    def_: bool = Field(alias="def")
+    class Config:
+        populate_by_name = True
+
+class ServerSelectOption(ServerOptionBase):
+    """セレクト（単一選択）オプション"""
+    type: Literal["select"] = "select"
+    def_: str = Field(alias="def")
+    values: List[SelectValue]
+    class Config:
+        populate_by_name = True
+
+class ServerMultiOption(ServerOptionBase):
+    """マルチ（複数選択）オプション"""
+    type: Literal["multi"] = "multi"
+    def_: List[bool] = Field(alias="def")
+    values: List[SelectValue]
+    class Config:
+        populate_by_name = True
+
+class ServerServerItemOption(ServerOptionBase):
+    """サーバーアイテム（単一）オプション"""
+    type: Literal["serverItem"] = "serverItem"
+    item_type: ItemType = Field(alias="itemType")
+    def_: Optional[str] = Field(alias="def")  # Sil型（簡略化してstringとする）
+    allow_other_servers: bool = Field(alias="allowOtherServers")
+    class Config:
+        populate_by_name = True
+
+class ServerServerItemsOption(ServerOptionBase):
+    """サーバーアイテム（複数）オプション"""
+    type: Literal["serverItems"] = "serverItems"
+    item_type: ItemType = Field(alias="itemType")
+    def_: List[str] = Field(alias="def")  # Sil[]型（簡略化してList[string]とする）
+    allow_other_servers: bool = Field(alias="allowOtherServers")
+    limit: int
+    class Config:
+        populate_by_name = True
+
+class ServerCollectionItemOption(ServerOptionBase):
+    """コレクションアイテムオプション"""
+    type: Literal["collectionItem"] = "collectionItem"
+    item_type: ItemType = Field(alias="itemType")
+    class Config:
+        populate_by_name = True
+        
+class ServerFileOption(ServerOptionBase):
+    """ファイルオプション"""
+    type: Literal["file"] = "file"
+    def_: str = Field(alias="def")
+    class Config:
+        populate_by_name = True
+        
+# Union型でServerOptionを定義
+ServerOption = Union[
+    ServerTextOption,
+    ServerTextAreaOption,
+    ServerSliderOption,
+    ServerToggleOption,
+    ServerSelectOption,
+    ServerMultiOption,
+    ServerServerItemOption,
+    ServerServerItemsOption,
+    ServerCollectionItemOption,
+    ServerFileOption
+]
+
+class ServerForm(BaseModel):
+    """サーバーフォームの定義"""
+    type: str
+    title: Union[str, Dict[str, Any]]  # Text型（多言語対応）またはstring
+    icon: Optional[Union[str, Dict[str, Any]]] = None  # Icon型（簡略化してstringまたはDict）
+    description: Optional[str] = None
+    help: Optional[str] = None
+    require_confirmation: bool = Field(alias="requireConfirmation")
+    options: List[ServerOption]
+    
+    class Config:
+        validate_by_name = True

sonolus_models-0.1.1/sonolus_models/__init__.py

@@ -0,0 +1,48 @@
+from .base import *
+from .common import *
+from .icon import SonolusIcon
+from .pack import *
+from .server_info import *
+
+from .ServerItemCommunityComment import ServerItemCommunityComment
+from .ServerItemCommunityCommentList import ServerItemCommunityCommentList
+from .ServerItemCommunityInfo import ServerItemCommunityInfo
+from .ServerItemDetails import ServerItemDetails
+from .ServerItemInfo import ServerItemInfo
+from .ServerItemLeaderboardDetails import ServerItemLeaderboardDetails
+from .ServerItemLeaderboardRecord import ServerItemLeaderboardRecord
+from .ServerItemList import ServerItemList
+from .ServerMessage import ServerMessage
+from .ServerOption import ServerOption
+
+from . import sonolus_types
+from .text import SonolusText
+from .userprofile import *
+
+__all__ = [
+	# core modules
+	"base", "common", "SonolusIcon", "pack", "server_info",
+
+	# server-related modules
+	"ServerItemCommunityComment",
+	"ServerItemCommunityCommentList",
+	"ServerItemCommunityInfo",
+	"ServerItemDetails",
+	"ServerItemInfo",
+	"ServerItemLeaderboardDetails",
+	"ServerItemLeaderboardRecord",
+	"ServerItemList",
+	"ServerMessage",
+	"ServerOption",
+
+	# base classes
+	"SonolusResourceLocator",
+	"SonolusButtonType",
+	"SonolusButton",
+	"SonolusConfiguration",
+	"SonolusServerInfo",
+
+	# helpers / types
+	"sonolus_types", "SonolusText", "userprofile",
+]
+

sonolus_models-0.1.1/sonolus_models/base.py

@@ -0,0 +1,48 @@
+# ここでベースとなるモデルの定義
+
+from pydantic import BaseModel, Field
+from typing import Dict, List, Optional, Any, Union
+from enum import Enum
+from .ServerOption import ServerOption
+
+class SonolusResourceLocator(BaseModel):
+    # https://wiki.sonolus.com/ja/custom-server-specs/misc/srl
+    
+    hash: str
+    url: str
+
+
+class SonolusButtonType(str, Enum):
+    # https://wiki.sonolus.com/ja/custom-server-specs/endpoints/get-sonolus-info
+    
+    AUTHENTICATION = "authentication"
+    POST = "post"
+    LEVEL = "level"
+    SKIN = "skin"
+    BACKGROUND = "background"
+    EFFECT = "effect"
+    PARTICLE = "particle"
+    ENGINE = "engine"
+    CONFIGURATION = "configuration"
+
+    
+class SonolusButton(BaseModel):
+    # ボタンの定義
+    
+    type: SonolusButtonType
+
+    
+class SonolusConfiguration(BaseModel):
+    # サーバーの設定の情報
+    options: List[ServerOption] = Field(default_factory=list)
+
+    
+class SonolusServerInfo(BaseModel):
+    # サーバーの情報を定義
+    # Sonolusのサーバーに入ったときの最初のメニュー
+    
+    title: str
+    description: Optional[str] = None
+    buttons: List[SonolusButton] = Field(default_factory=list)
+    configuration: SonolusConfiguration = Field(default_factory=SonolusConfiguration)
+    banner: Optional[SonolusResourceLocator] = None

sonolus_models-0.1.1/sonolus_models/common.py

@@ -0,0 +1,27 @@
+from pydantic import BaseModel, Field
+from typing import Optional, Union, TypeVar, Generic, Annotated
+from .base import SonolusResourceLocator
+
+Text = Annotated[str, Field(description="テキスト型")]
+
+Icon = Annotated[str, Field(description="アイコン型")]
+
+class Tag(BaseModel):
+    """タグ情報を提供"""
+    title: str
+    icon: Optional[str] = None
+
+T = TypeVar('T')
+
+class UseItemDefault(BaseModel):
+    """デフォルトアイテムを使用"""
+    useDefault: bool = True
+
+class UseItemCustom(BaseModel, Generic[T]):
+    """カスタムアイテムを使用"""
+    useDefault: bool = False
+    item: T
+
+def UseItem(item_type: T) -> Union[UseItemDefault, UseItemCustom[T]]:
+    """UseItem型のファクトリー関数"""
+    return Union[UseItemDefault, UseItemCustom[item_type]]

sonolus_models-0.1.1/sonolus_models/icon.py

@@ -0,0 +1,76 @@
+from enum import StrEnum
+
+
+class SonolusIcon(StrEnum):
+	Advanced = "advanced"
+	AngleDown = "angleDown"
+	AngleLeft = "angleLeft"
+	AngleRight = "angleRight"
+	AnglesDown = "anglesDown"
+	AnglesLeft = "anglesLeft"
+	AnglesRight = "anglesRight"
+	AnglesUp = "anglesUp"
+	AngleUp = "angleUp"
+	ArrowDown = "arrowDown"
+	ArrowLeft = "arrowLeft"
+	ArrowRight = "arrowRight"
+	ArrowUp = "arrowUp"
+	Award = "award"
+	Background = "background"
+	Bell = "bell"
+	BellSlash = "bellSlash"
+	Bookmark = "bookmark"
+	BookmarkHollow = "bookmarkHollow"
+	Check = "check"
+	Clock = "clock"
+	Comment = "comment"
+	Crown = "crown"
+	CustomServer = "customServer"
+	Delete = "delete"
+	Edit = "edit"
+	Effect = "effect"
+	Engine = "engine"
+	Envelope = "envelope"
+	EnvelopeOpen = "envelopeOpen"
+	Globe = "globe"
+	Heart = "heart"
+	HeartHollow = "heartHollow"
+	Hide = "hide"
+	Information = "information"
+	Level = "level"
+	Lock = "lock"
+	Medal = "medal"
+	Message = "message"
+	Minus = "minus"
+	Options = "options"
+	Particle = "particle"
+	Pin = "pin"
+	Player = "player"
+	Playlist = "playlist"
+	Plus = "plus"
+	Post = "post"
+	Question = "question"
+	Ranking = "ranking"
+	Replay = "replay"
+	Reply = "reply"
+	Restore = "restore"
+	Room = "room"
+	Search = "search"
+	Settings = "settings"
+	Show = "show"
+	Shuffle = "shuffle"
+	Skin = "skin"
+	Star = "star"
+	StarHalf = "starHalf"
+	StarHollow = "starHollow"
+	Stopwatch = "stopwatch"
+	Tag = "tag"
+	ThumbsDown = "thumbsDown"
+	ThumbsDownHollow = "thumbsDownHollow"
+	ThumbsUp = "thumbsUp"
+	ThumbsUpHollow = "thumbsUpHollow"
+	Trophy = "trophy"
+	Unlock = "unlock"
+	XMark = "xMark"
+
+