shop_system_models 1.0.0.dev26932__tar.gz → 1.0.0.dev27178__tar.gz

{shop_system_models-1.0.0.dev26932 → shop_system_models-1.0.0.dev27178}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: shop_system_models
-Version: 1.0.0.dev26932
+Version: 1.0.0.dev27178
 Summary: Shared model definitions for shop system services
 Author: Pavel Mulin
 Author-email: pavel@tg-shops.com

{shop_system_models-1.0.0.dev26932 → shop_system_models-1.0.0.dev27178}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "shop_system_models"
-version = "v1.0.0.dev26932"
+version = "v1.0.0.dev27178"
 description = "Shared model definitions for shop system services"
 authors = ["Pavel Mulin <pavel@tg-shops.com>"]
 readme = "README.md"

shop_system_models-1.0.0.dev27178/shop_system_models/consts/languages.py

@@ -0,0 +1,4 @@
+TG_LANGUAGES_MAPPING = {'ru': 'RU',
+                        'en': 'EN'}
+
+LANGUAGES = {value: key for key, value in TG_LANGUAGES_MAPPING.items()}  # reverse TG_LANGUAGES

shop_system_models-1.0.0.dev27178/shop_system_models/consts/languages.pyi

@@ -0,0 +1,4 @@
+from _typeshed import Incomplete
+
+TG_LANGUAGES_MAPPING: Incomplete
+LANGUAGES: Incomplete

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/request/authorization.py

@@ -0,0 +1,6 @@
+from shop_system_models.deployment_api.request.users import User
+
+
+class Token(User):
+    initData: str
+

{shop_system_models-1.0.0.dev26932 → shop_system_models-1.0.0.dev27178}/shop_system_models/deployment_api/request/processes.py

@@ -12,3 +12,4 @@ class DeployVariables(BaseModel):
     contact_phone: Optional[str]
     bot_token: Optional[str]
     invite_user: bool = True
+

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/request/services.py

@@ -0,0 +1,36 @@
+from typing import Optional
+
+from shop_system_models.consts.enums import ServiceNames
+from pydantic import BaseModel, computed_field
+
+
+class ServiceConfig(BaseModel):
+    name: ServiceNames
+    version: Optional[str] = 'latest'
+
+    class Config:
+        use_enum_values = True
+
+
+class ProjectConfiguration(BaseModel):
+    shop_name: str
+
+    # Константы для URL — будут задаваться в рантайме
+    SHOP_BOT_URL: str = ''
+    SHOP_API_URL: str = ''
+    SHOP_APP_URL: str = ''
+
+    @computed_field  # type: ignore
+    @property
+    def shop_bot_url(self) -> str:
+        return f"{self.SHOP_BOT_URL}/{self.shop_name}"
+
+    @computed_field  # type: ignore
+    @property
+    def shop_api_url(self) -> str:
+        return f"{self.SHOP_API_URL}/{self.shop_name}"
+
+    @computed_field  # type: ignore
+    @property
+    def shop_url(self) -> str:
+        return f"{self.SHOP_APP_URL}/{self.shop_name}"

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/request/shop_categories.py

@@ -0,0 +1,9 @@
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class ShopCategory(BaseModel):
+    name: str
+    description: Optional[str] = None
+    preview_url: Optional[str] = None

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/request/shop_content/blocks.py

@@ -0,0 +1,21 @@
+from typing import Optional
+
+from fastapi import HTTPException
+from pydantic import BaseModel, field_validator
+
+
+def link_validation(link: str) -> str:
+    if not link.startswith('http://') and not link.startswith('https://'):
+        raise HTTPException(status_code=400, detail=f'Invalid link: {link}')
+    return link
+
+
+class LinkBlocks(BaseModel):
+    contacts: Optional[str] = None
+    info: Optional[str] = None
+
+    @field_validator('contacts', 'info')
+    def link_validation(cls, value: str) -> str:
+        if value:
+            return link_validation(link=value)
+        return value

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/request/shop_content/delivery_types.py

@@ -0,0 +1,51 @@
+from typing import List, Optional
+
+from fastapi import HTTPException
+from pydantic import BaseModel, field_validator
+
+
+class Coordinates(BaseModel):
+    latitude: float
+    longitude: float
+
+
+class ExtraField(BaseModel):
+    name: str
+    description: str
+    is_required: bool
+
+
+# class ExtraFieldPayload(BaseModel):
+#     name: str
+#     value: str
+
+
+class DeliveryType(BaseModel):
+    name: str
+    amount: float = 0.0
+    is_address_required: bool = False
+    address_hint: Optional[str] = ''
+    extra_fields: List[ExtraField] = []
+    is_timepicker_required: bool = False
+    details: str = ''
+    country: Optional[str] = ''
+    country_code: Optional[str] = ''  # ISO format, ex.: RU, KZ, BY...
+    city: Optional[str] = None
+    delivery_location: Optional[Coordinates] = None
+    delivery_radius: Optional[int] = None
+    delivery_min_hour: Optional[int] = None
+    delivery_max_hour: Optional[int] = None
+    delivery_minutes_interval: Optional[int] = None
+    delivery_min_day: Optional[int] = None
+    delivery_max_day: Optional[int] = None
+
+    @field_validator('name')
+    def name_validation(cls, name):
+        name = name.strip()
+        if len(name) <= 2:
+            raise HTTPException(status_code=400, detail=f'Invalid delivery name: {name}')
+        return name
+
+
+class DeliveryTypeResponse(DeliveryType):
+    id: str

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/request/shop_content/payment_methods.py

@@ -0,0 +1,32 @@
+from enum import Enum
+from typing import List, Optional
+
+from pydantic import BaseModel
+
+
+class PaymentTypes(str, Enum):
+    manual_payment_request = 'ManualPaymentRequest'
+    external_card_payment_provider = 'ExternalCardPaymentProvider'
+    crypto_ton = 'CryptoTON'
+    xtr = 'XTR'
+    life_pay = 'LifePay'
+    yookassa = "yookassa"
+    tkassa = "tkassa"
+
+class Metadata(BaseModel):
+    key: str
+    value: List[str]
+
+
+class PaymentMethod(BaseModel):
+    name: str
+    type: PaymentTypes
+    payment_data: str  # payment_token, TON address etc....
+    meta: Optional[List[Metadata]] = []
+
+    class Config:
+        use_enum_values = True
+
+
+class PaymentMethodResponse(PaymentMethod):
+    id: str

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/request/shop_templates.py

@@ -0,0 +1,18 @@
+from typing import Optional
+
+from fastapi import HTTPException
+from pydantic import BaseModel, field_validator
+
+
+class ShopTemplate(BaseModel):
+    template_id: str
+    name: str
+    description: Optional[str] = ''
+    bot_url: str
+    language: str
+
+    @field_validator('bot_url')
+    def url_validation(cls, bot_url):
+        if bot_url.startswith('http://') or bot_url.startswith('https://'):
+            return bot_url
+        raise HTTPException(status_code=400, detail=f'Invalid bot_url: {bot_url}')

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/request/shops.py

@@ -0,0 +1,102 @@
+import re
+from datetime import datetime
+from typing import Any, List, Optional, Union
+
+from pydantic import BaseModel, ValidationError, computed_field, model_validator, Field
+from transliterate import translit  # type: ignore
+
+from shop_system_models.consts.enums import ShopStatuses
+from shop_system_models.deployment_api.request.nocodb import NocoDBConfig
+from shop_system_models.deployment_api.request.services import ProjectConfiguration
+from shop_system_models.deployment_api.request.tasks import Task
+from shop_system_models.deployment_api.response.shops import ShopCategoryResponse
+
+
+class Location(BaseModel):
+    latitude: float
+    longitude: float
+    address: str
+
+
+class CreateShop(BaseModel):
+    name: str
+    categories: List[ShopCategoryResponse] = []
+    locations: Optional[List[Location]] = []
+    contact_email: str
+    template_id: str
+    orders_chat_id: int = 0
+    friendly_name: str = ''
+    contact_phone: Optional[str] = ''
+    bot_token: Optional[str] = ''
+    zone: Optional[int] = None
+
+    @model_validator(mode='before')
+    def set_friendly_name_and_format_name(cls, values: dict):
+        name = values.get('name', '')
+        if len(name) > 35:
+            raise ValueError('Shop name too long; must be less than 35 symbols')
+
+        if not values.get('friendly_name'):
+            values['friendly_name'] = name.strip().strip("-")
+
+        transliterated_name = translit(name, 'ru', reversed=True) if name else ''
+        no_whitespaces_and_underscores = transliterated_name.replace(' ', '-').replace('_', '-')
+        no_double_dashes = re.sub(r'-{2,}', '-', no_whitespaces_and_underscores)
+        to_lowercase = no_double_dashes.lower()
+        no_special_characters = re.sub(r'[^a-z0-9_-]', '', to_lowercase)
+        formatted_name = re.sub(r'^[^a-z0-9]+|[^a-z0-9]+$', '', no_special_characters)
+
+        values['name'] = formatted_name
+        return values
+
+
+class Shop(CreateShop):
+    # КОНСТАНТЫ ИЗ CONFIG
+    WEB_APP_URL: str = ''
+    FRONTEND_HOST: str = ''
+
+    placeholder: Optional[Union[ShopStatuses, Any]] = ShopStatuses.deploying
+    tasks: List[Task] = []
+    language: str = 'RU'
+    nocodb_config: NocoDBConfig = NocoDBConfig()
+
+    search_enabled: Optional[bool] = False
+    warehouse_accounting: Optional[bool] = False
+    weekly_reports: Optional[bool] = True
+    orders_history_chat_id: Optional[int] = None
+    topic_chat_id: Optional[int] = None
+    premium_expiration_date: Optional[datetime] = None
+    broadcast_messages_count: Optional[int] = 0
+    web_app_url: str = Field(default_factory=lambda: Shop.WEB_APP_URL)
+
+    blocked: bool = False
+    block_reason: str = ""
+
+    @computed_field  # type: ignore
+    @property
+    def sheet_link(self) -> Optional[str]:
+        if self.nocodb_config and self.nocodb_config.nocodb_project_id:
+            return f"{self.FRONTEND_HOST}/dashboard/#/nc/{self.nocodb_config.nocodb_project_id}"
+        return None
+
+
+class ShopDB(Shop):
+    id: str
+    tg_admin_id: int = 0
+    is_changeable: Optional[bool] = True
+    order_process: str = "The-devs.Shop.CreateOrder"
+    nocodb_config: NocoDBConfig = NocoDBConfig()
+    preview_url: Optional[str] = None
+    views_id: List[str] = []
+
+    @computed_field  # type: ignore
+    @property
+    def configuration(self) -> ProjectConfiguration:
+        return ProjectConfiguration(
+            shop_name=self.name
+        )
+
+
+class UpdateFromProcess(BaseModel):
+    nocodb_config: NocoDBConfig
+    language: str

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/request/tasks.py

@@ -0,0 +1,24 @@
+from typing import List
+
+from shop_system_models.consts.enums import TaskStatuses
+from pydantic import BaseModel
+
+
+class Task(BaseModel):
+    title: str
+    assignee_role: List = []
+    shop_id: str
+    shop_name: str
+    submit_url: str = ''
+    variables: dict
+    element_id: str
+    form_json: dict
+    job_key: int
+    process_id: str
+    process_instance_key: int
+    process_monitoring_url: str
+    deadline: int
+    status: TaskStatuses = TaskStatuses.pending
+
+    class Config:
+        use_enum_values = True

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/request/users.py

@@ -0,0 +1,53 @@
+from typing import List, Optional
+
+from shop_system_models.consts.enums import UserRoles
+from shop_system_models.consts.languages import TG_LANGUAGES_MAPPING
+from pydantic import BaseModel, field_validator, model_validator, computed_field
+
+
+class ReferralUser(BaseModel):
+    first_name: str
+    last_name: Optional[str] = ''
+    username: Optional[str] = ''
+    tg_id: int
+
+
+class User(BaseModel):
+    first_name: str
+    last_name: Optional[str] = ''
+    username: Optional[str] = ''
+    tg_id: int
+    tg_language: str = ''  # language_code from TG
+
+    @computed_field  # type: ignore
+    @property
+    def language(self) -> str:
+        return TG_LANGUAGES_MAPPING.get(self.tg_language, 'EN')
+
+
+class UserDB(User):
+    invited_by_id: Optional[str] = None
+    invited_by_user: Optional[ReferralUser] = None
+    cache_key: Optional[str] = None
+
+
+class UserExtended(UserDB):
+    SHOPS_LIMIT: int = 0  # сюда потом в рантайме подставишь значение из конфига
+
+    roles: List[str] = []  # 'shop_admin:<shop_id>' or 'admin'
+    shops_available: int = SHOPS_LIMIT
+
+    @field_validator('roles')
+    def if_admin(cls, roles: list):
+        for role in roles:
+            if role == UserRoles.admin.value:
+                return [UserRoles.admin.value]
+        return roles
+
+    @field_validator('shops_available')
+    def admin_limit(cls, shops_available, model):
+        roles = model.data['roles']
+        for role in roles:
+            if role == UserRoles.admin.value:
+                return 10
+        return shops_available

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/request/web_app_url.py

@@ -0,0 +1,14 @@
+import re
+
+from pydantic import BaseModel, Field, field_validator
+
+
+class WebAppUrlUpdateRequest(BaseModel):
+    web_app_url: str = Field(..., description="The URL of the telegram web app")
+
+    @field_validator("web_app_url")
+    def validate_web_app_url(cls, value):
+        pattern = r"^https://t\.me/[A-Za-z0-9_]+/[A-Za-z0-9_]+$"
+        if not re.match(pattern, value):
+            raise ValueError("web_app_url must follow the pattern: 'https://t.me/{bot_name}/{webapp_name}', where bot_name and webapp_name can vary.")
+        return value

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/response/general.py

@@ -0,0 +1,23 @@
+import enum
+from pydantic import BaseModel
+
+
+class PageInfo(BaseModel):
+    total_rows: int
+    page: int
+    page_size: int
+    is_first_page: bool
+    is_last_page: bool
+
+
+class ListResponseModel(BaseModel):
+    page_info: PageInfo
+
+
+class ExtraOptionsModel(str, enum.Enum):
+    enabled = 'enabled'
+    disabled = 'disabled'
+
+
+class ExtraOptionsStatusResponse(BaseModel):
+    status: ExtraOptionsModel

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/response/permissions.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class InviteLinkResponse(BaseModel):
+    valid_until: int
+    link: str

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/response/premium.py

@@ -0,0 +1,15 @@
+from pydantic import BaseModel
+
+from shop_system_models.deployment_api.request.premium import PremiumPlanTypes
+
+
+class PremiumLinkResponseModel(BaseModel):
+    shop_name: str
+    premium_type: str
+    link: str
+
+
+class PremiumPlanType(BaseModel):
+    price: int
+    final_price: int
+    type: PremiumPlanTypes

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/response/shops.py

@@ -0,0 +1,51 @@
+from datetime import datetime
+from typing import List, Optional
+
+
+from shop_system_models.deployment_api.request.nocodb import NocoDBConfig
+from shop_system_models.deployment_api.request.shop_categories import ShopCategory
+from shop_system_models.deployment_api.request.shop_content.blocks import LinkBlocks
+from shop_system_models.deployment_api.request.shop_content.delivery_types import DeliveryTypeResponse
+from shop_system_models.deployment_api.request.shop_content.payment_methods import PaymentMethodResponse
+from pydantic import BaseModel, Field
+
+
+class ContentDataResponseModel(BaseModel):
+    blocks: Optional[LinkBlocks]
+    delivery_types: Optional[List[DeliveryTypeResponse]]
+    payment_methods: Optional[List[PaymentMethodResponse]]
+
+
+class ShopDetails(BaseModel):
+    shop_id: str
+    shop_name: str
+    friendly_name: str
+    shop_language: Optional[str] = 'RU'
+    shop_api_url: str
+    contact_phone: str
+    contact_email: str
+    orders_chat_id: int # orders_management_chat_id
+    orders_history_chat_id: Optional[int] = None
+    topic_chat_id: Optional[int] = None
+    bot_url: str
+    bot_token: str
+    placeholder: str
+    order_process: str
+    search_enabled: bool = False
+    warehouse_accounting: bool = False
+    nocodb_config: Optional[NocoDBConfig] = None
+    nocodb_project_id: Optional[str] = None
+    nocodb_categories_table: Optional[str] = None
+    nocodb_products_table: Optional[str] = None
+    nocodb_orders_table: Optional[str] = None
+    nocodb_status_table: Optional[str] = None
+    nocodb_bot_commands_table: Optional[str] = None
+    nocodb_options_table: Optional[str] = ""
+    nocodb_options_category_table: Optional[str] = ""
+    premium_expiration_date: Optional[datetime] = None
+    broadcast_messages_count: Optional[int] = 0
+    web_app_url: str
+
+
+class ShopCategoryResponse(ShopCategory):
+    id: str

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/response/simple_responses.py

@@ -0,0 +1,61 @@
+from typing import List, Optional
+
+
+from shop_system_models.deployment_api.request.services import ServiceConfig
+from shop_system_models.deployment_api.request.shop_templates import ShopTemplate
+from shop_system_models.deployment_api.request.shops import CreateShop, Shop, ShopDB
+from shop_system_models.deployment_api.request.tasks import Task
+from shop_system_models.deployment_api.request.users import User, UserExtended
+from pydantic import BaseModel
+
+from shop_system_models.deployment_api.response.general import ListResponseModel
+
+
+class BasicResponse(BaseModel):
+    message: str
+
+
+
+
+
+class ServiceConfigResponse(ServiceConfig):
+    id: str
+
+
+class CreateShopResponse(CreateShop):
+    id: str
+
+
+class ShopResponse(Shop):
+    id: str
+    preview_url: Optional[str] = None
+
+
+class ShopResponseId(ShopDB):
+    id: str
+
+
+class ShopsListResponseModel(ListResponseModel):
+    shops: List[ShopResponseId]
+
+
+class ShopDBResponse(ShopDB):
+    id: str
+
+
+class TaskResponse(Task):
+    id: str
+
+
+class UserResponse(UserExtended):
+    id: str
+    invited_users: Optional[List[User]] = None
+    cache_key: Optional[str] = None
+
+
+class TokenResponse(BaseModel):
+    access_token: str
+
+
+class ShopTemplateResponse(ShopTemplate):
+    id: str

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/response/web_app_url.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class WebAppUrlResponse(BaseModel):
+    web_app_url: str

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/shared.pyi

@@ -0,0 +1,34 @@
+from datetime import datetime
+from pydantic import BaseModel
+
+class NocoDBConfig(BaseModel):
+    nocodb_project_id: str
+    nocodb_categories_table: str
+    nocodb_products_table: str
+    nocodb_orders_table: str
+    nocodb_status_table: str
+    nocodb_bot_commands_table: str
+    nocodb_options_table: str | None
+    nocodb_options_category_table: str | None
+
+class ShopDetailsModel(BaseModel):
+    shop_id: str
+    shop_name: str
+    friendly_name: str
+    shop_language: str
+    shop_api_url: str
+    contact_phone: str | None
+    contact_email: str
+    orders_chat_id: int
+    orders_history_chat_id: int | None
+    search_enabled: bool | None
+    warehouse_accounting: bool
+    bot_url: str | None
+    bot_token: str
+    payment_token: str | None
+    placeholder: str
+    order_process: str
+    nocodb_config: NocoDBConfig | None
+    topic_chat_id: int | None
+    premium_expiration_date: datetime | None
+    web_app_url: str

shop_system_models-1.0.0.dev27178/shop_system_models/deployment_api/users.pyi

@@ -0,0 +1,37 @@
+from pydantic import BaseModel
+
+class UserHeadersUpdatingModel(BaseModel):
+    tg_id: int
+    first_name: str | None
+    last_name: str | None
+    tg_language: str | None
+    username: str | None
+
+class UserModel(UserHeadersUpdatingModel):
+    password: str | None
+    preview_url: str | None
+    rights: str
+    delivery_addresses: list[str] | None
+
+class ReferralUser(BaseModel):
+    tg_id: int
+    first_name: str
+    last_name: str | None
+    username: str | None
+
+class InvitedUser(ReferralUser):
+    tg_language: str | None
+    language: str | None
+
+class UserDeploymentModel(BaseModel):
+    id: str
+    first_name: str
+    last_name: str | None
+    username: str | None
+    tg_id: int
+    tg_language: str
+    invited_by_id: str | None
+    invited_by_user: ReferralUser | None
+    roles: list[str] | None
+    shops_available: int
+    invited_users: list[InvitedUser] | None

{shop_system_models-1.0.0.dev26932 → shop_system_models-1.0.0.dev27178}/shop_system_models/shop_api/shop/request/orders.py

@@ -89,6 +89,7 @@ class OrderPaymentDetails(BaseModel):
     expires_at: datetime
     link: str
 
+
 # This depends on UserBasketResponseModelV2 which we'll define in a separate file
 # For now, we'll create a placeholder class that can be updated later
 class OrderModel(CreateOrderModel):

shop_system_models-1.0.0.dev26932/shop_system_models/deployment_api/request/authorization.py

@@ -1 +0,0 @@
-