pixelarraythirdparty 1.2.8__tar.gz → 1.3.0__tar.gz

{pixelarraythirdparty-1.2.8 → pixelarraythirdparty-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pixelarraythirdparty
-Version: 1.2.8
+Version: 1.3.0
 Summary: PixelArray 第三方微服务客户端
 Author-email: Lu qi <qi.lu@pixelarrayai.com>
 License-Expression: MIT

{pixelarraythirdparty-1.2.8 → pixelarraythirdparty-1.3.0}/pixelarraythirdparty/__init__.py

@@ -12,11 +12,13 @@ PixelArray 第三方微服务客户端
 - feedback: 客户反馈模块
 - project: 项目管理模块
 - support_chat: 在线客服（临时会话链接）
+- custom_events: 自定义事件上报（需在 Portal 配置事件定义）
 """
 
 from .support_chat.support_chat import SupportChatManagerAsync
+from .custom_events.custom_events import CustomEventsManagerAsync
 
-__version__ = "1.2.8"
+__version__ = "1.3.0"
 __author__ = "Lu qi"
 __email__ = "qi.lu@pixelarrayai.com"
 
@@ -29,5 +31,7 @@ __all__ = [
     "feedback",
     "project",
     "support_chat",
+    "custom_events",
     "SupportChatManagerAsync",
+    "CustomEventsManagerAsync",
 ]

pixelarraythirdparty-1.3.0/pixelarraythirdparty/custom_events/__init__.py

@@ -0,0 +1,3 @@
+from .custom_events import CustomEventsManagerAsync
+
+__all__ = ["CustomEventsManagerAsync"]

pixelarraythirdparty-1.3.0/pixelarraythirdparty/custom_events/custom_events.py

@@ -0,0 +1,52 @@
+from pixelarraythirdparty.client import AsyncClient
+from typing import Any, Dict, List, Optional, Tuple
+
+
+class CustomEventsManagerAsync(AsyncClient):
+    """自定义事件上报（需先在 Portal 配置事件定义与字段 schema）。"""
+
+    async def report_custom_event(
+        self,
+        project_id: int,
+        event_key: str,
+        payload: Dict[str, Any],
+        client_occurred_at: Optional[str] = None,
+    ) -> Tuple[Dict[str, Any], bool]:
+        """
+        description:
+            上报单条自定义事件日志（JSON 载荷须符合 Portal 中配置的 field_schema）
+        parameters:
+            project_id(int): 项目 ID
+            event_key(str): 事件键
+            payload(dict): JSON 对象，键与类型须与定义一致
+            client_occurred_at(str, optional): 客户端事件发生时间，ISO8601 字符串
+        return:
+            data(dict): 成功时为日志记录；失败时含 message 等
+            success(bool): 是否成功
+        """
+        data: Dict[str, Any] = {
+            "project_id": project_id,
+            "event_key": event_key,
+            "payload": payload,
+        }
+        if client_occurred_at is not None:
+            data["client_occurred_at"] = client_occurred_at
+        return await self._request("POST", "/api/custom-events/report", json=data)
+
+    async def report_custom_events_batch(
+        self,
+        project_id: int,
+        items: List[Dict[str, Any]],
+    ) -> Tuple[Dict[str, Any], bool]:
+        """
+        description:
+            批量上报自定义事件（同一 project_id；任一条校验失败则整批失败）
+        parameters:
+            project_id(int): 项目 ID
+            items(list): 每项为 dict，须含 event_key、payload；可选 client_occurred_at（字符串）
+        return:
+            data(dict): 成功时为日志列表；失败时含 message
+            success(bool): 是否成功
+        """
+        body = {"project_id": project_id, "items": items}
+        return await self._request("POST", "/api/custom-events/report/batch", json=body)

{pixelarraythirdparty-1.2.8 → pixelarraythirdparty-1.3.0}/pixelarraythirdparty/unified_login/unified_login.py

@@ -6,6 +6,20 @@ from typing import Any, Dict, Optional, Tuple
 from pixelarraythirdparty.client import AsyncClient
 
 
+def _normalized_project_name(project_name: Optional[str]) -> Optional[str]:
+    if project_name is None:
+        return None
+    s = str(project_name).strip()
+    return s or None
+
+
+def _auth_url_json(project_name: Optional[str]) -> Optional[Dict[str, Any]]:
+    s = _normalized_project_name(project_name)
+    if s is None:
+        return None
+    return {"project_name": s}
+
+
 class OAuth2Login(AsyncClient):
     """
     统一的 OAuth2 登录客户端基类
@@ -66,7 +80,13 @@ class OAuth2Login(AsyncClient):
         },
     }
 
-    def __init__(self, api_key: str, provider: str, login_type: Optional[str] = None):
+    def __init__(
+        self,
+        api_key: str,
+        provider: str,
+        login_type: Optional[str] = None,
+        project_name: Optional[str] = None,
+    ):
         """
         description:
             初始化OAuth2登录客户端
@@ -74,10 +94,12 @@ class OAuth2Login(AsyncClient):
             api_key(str): API密钥
             provider(str): 提供商名称，可选值：google, wechat, github, gitlab, douyin, tiktok
             login_type(str, optional): 登录类型，仅对微信有效，可选值：desktop（PC端扫码）, mobile（手机端）
+            project_name(str, optional): 绑定项目名；不传或空字符串则匿名登录
         """
         super().__init__(api_key)
         self.provider = provider.lower()
         self.login_type = login_type
+        self._project_name = project_name
 
         # 验证提供商是否支持
         if self.provider not in self.PROVIDER_ENDPOINTS:
@@ -118,7 +140,11 @@ class OAuth2Login(AsyncClient):
             success(bool): 是否成功
         """
         endpoint = self._get_endpoint("auth_url")
-        data, success = await self._request("POST", endpoint)
+        payload = _auth_url_json(self._project_name)
+        if payload:
+            data, success = await self._request("POST", endpoint, json=payload)
+        else:
+            data, success = await self._request("POST", endpoint)
         if not success:
             return data, False
         auth_url = data.get("auth_url")
@@ -215,20 +241,30 @@ class GoogleLogin(AsyncClient):
     def __init__(self, api_key: str):
         super().__init__(api_key)
 
-    async def get_auth_url(self) -> Tuple[Optional[Dict[str, str]], bool]:
+    async def get_auth_url(
+        self, project_name: Optional[str] = None
+    ) -> Tuple[Optional[Dict[str, str]], bool]:
         """
         description:
             获取Google OAuth授权URL（公共方法，供服务端调用）
 
             服务端应该调用此方法获取授权URL，然后将URL返回给前端让用户点击授权。
             获取到state后，使用wait_for_login方法等待登录结果。
+        parameters:
+            project_name(str, optional): 绑定项目名；不传或空字符串则匿名登录
         return:
             auth_data(dict, optional): 授权数据字典，包含auth_url和state
             success(bool): 是否成功
         """
-        data, success = await self._request(
-            "POST", "/api/unified-login/google/auth-url"
-        )
+        payload = _auth_url_json(project_name)
+        if payload:
+            data, success = await self._request(
+                "POST", "/api/unified-login/google/auth-url", json=payload
+            )
+        else:
+            data, success = await self._request(
+                "POST", "/api/unified-login/google/auth-url"
+            )
         if not success:
             return data, False
         auth_url = data.get("auth_url")
@@ -328,7 +364,7 @@ class WechatLogin(AsyncClient):
         super().__init__(api_key)
 
     async def get_auth_url(
-        self, login_type: str = "desktop"
+        self, login_type: str = "desktop", project_name: Optional[str] = None
     ) -> Tuple[Optional[Dict[str, str]], bool]:
         """
         description:
@@ -338,6 +374,7 @@ class WechatLogin(AsyncClient):
             获取到state后，使用wait_for_login方法等待登录结果。
         parameters:
             login_type(str, optional): 登录类型，desktop表示PC端扫码登录，mobile表示微信公众号登录，默认为desktop
+            project_name(str, optional): 绑定项目名；不传或空字符串则匿名登录
         return:
             auth_data(dict, optional): 授权数据字典，包含auth_url和state
             success(bool): 是否成功
@@ -349,7 +386,11 @@ class WechatLogin(AsyncClient):
             # PC端扫码登录
             endpoint = "/api/unified-login/wechat/auth-url"
 
-        data, success = await self._request("POST", endpoint)
+        payload = _auth_url_json(project_name)
+        if payload:
+            data, success = await self._request("POST", endpoint, json=payload)
+        else:
+            data, success = await self._request("POST", endpoint)
         if not success:
             return data, False
         auth_url = data.get("auth_url")
@@ -424,20 +465,30 @@ class GitHubLogin(AsyncClient):
     def __init__(self, api_key: str):
         super().__init__(api_key)
 
-    async def get_auth_url(self) -> Tuple[Optional[Dict[str, str]], bool]:
+    async def get_auth_url(
+        self, project_name: Optional[str] = None
+    ) -> Tuple[Optional[Dict[str, str]], bool]:
         """
         description:
             获取GitHub OAuth授权URL（公共方法，供服务端调用）
 
             服务端应该调用此方法获取授权URL，然后将URL返回给前端让用户点击授权。
             获取到state后，使用wait_for_login方法等待登录结果。
+        parameters:
+            project_name(str, optional): 绑定项目名；不传或空字符串则匿名登录
         return:
             auth_data(dict, optional): 授权数据字典，包含auth_url和state
             success(bool): 是否成功
         """
-        data, success = await self._request(
-            "POST", "/api/unified-login/github/auth-url"
-        )
+        payload = _auth_url_json(project_name)
+        if payload:
+            data, success = await self._request(
+                "POST", "/api/unified-login/github/auth-url", json=payload
+            )
+        else:
+            data, success = await self._request(
+                "POST", "/api/unified-login/github/auth-url"
+            )
         if not success:
             return data, False
         auth_url = data.get("auth_url")
@@ -503,20 +554,30 @@ class DouyinLogin(AsyncClient):
     def __init__(self, api_key: str):
         super().__init__(api_key)
 
-    async def get_auth_url(self) -> Tuple[Optional[Dict[str, str]], bool]:
+    async def get_auth_url(
+        self, project_name: Optional[str] = None
+    ) -> Tuple[Optional[Dict[str, str]], bool]:
         """
         description:
             获取抖音OAuth授权URL（公共方法，供服务端调用）
 
             服务端应该调用此方法获取授权URL，然后将URL返回给前端让用户点击授权。
             获取到state后，使用wait_for_login方法等待登录结果。
+        parameters:
+            project_name(str, optional): 绑定项目名；不传或空字符串则匿名登录
         return:
             auth_data(dict, optional): 授权数据字典，包含auth_url和state
             success(bool): 是否成功
         """
-        data, success = await self._request(
-            "POST", "/api/unified-login/douyin/auth-url"
-        )
+        payload = _auth_url_json(project_name)
+        if payload:
+            data, success = await self._request(
+                "POST", "/api/unified-login/douyin/auth-url", json=payload
+            )
+        else:
+            data, success = await self._request(
+                "POST", "/api/unified-login/douyin/auth-url"
+            )
         if not success:
             return data, False
         auth_url = data.get("auth_url")
@@ -582,20 +643,30 @@ class TiktokLogin(AsyncClient):
     def __init__(self, api_key: str):
         super().__init__(api_key)
 
-    async def get_auth_url(self) -> Tuple[Optional[Dict[str, str]], bool]:
+    async def get_auth_url(
+        self, project_name: Optional[str] = None
+    ) -> Tuple[Optional[Dict[str, str]], bool]:
         """
         description:
             获取TikTok OAuth授权URL（公共方法，供服务端调用）
 
             服务端应该调用此方法获取授权URL，然后将URL返回给前端让用户点击授权。
             获取到state后，使用wait_for_login方法等待登录结果。
+        parameters:
+            project_name(str, optional): 绑定项目名；不传或空字符串则匿名登录
         return:
             auth_data(dict, optional): 授权数据字典，包含auth_url和state
             success(bool): 是否成功
         """
-        data, success = await self._request(
-            "POST", "/api/unified-login/tiktok/auth-url"
-        )
+        payload = _auth_url_json(project_name)
+        if payload:
+            data, success = await self._request(
+                "POST", "/api/unified-login/tiktok/auth-url", json=payload
+            )
+        else:
+            data, success = await self._request(
+                "POST", "/api/unified-login/tiktok/auth-url"
+            )
         if not success:
             return data, False
         auth_url = data.get("auth_url")
@@ -661,20 +732,30 @@ class GitLabLogin(AsyncClient):
     def __init__(self, api_key: str):
         super().__init__(api_key)
 
-    async def get_auth_url(self) -> Tuple[Optional[Dict[str, str]], bool]:
+    async def get_auth_url(
+        self, project_name: Optional[str] = None
+    ) -> Tuple[Optional[Dict[str, str]], bool]:
         """
         description:
             获取GitLab OAuth授权URL（公共方法，供服务端调用）
 
             服务端应该调用此方法获取授权URL，然后将URL返回给前端让用户点击授权。
             获取到state后，使用wait_for_login方法等待登录结果。
+        parameters:
+            project_name(str, optional): 绑定项目名；不传或空字符串则匿名登录
         return:
             auth_data(dict, optional): 授权数据字典，包含auth_url和state
             success(bool): 是否成功
         """
-        data, success = await self._request(
-            "POST", "/api/unified-login/gitlab/auth-url"
-        )
+        payload = _auth_url_json(project_name)
+        if payload:
+            data, success = await self._request(
+                "POST", "/api/unified-login/gitlab/auth-url", json=payload
+            )
+        else:
+            data, success = await self._request(
+                "POST", "/api/unified-login/gitlab/auth-url"
+            )
         if not success:
             return data, False
         auth_url = data.get("auth_url")
@@ -769,18 +850,25 @@ class SMSLogin(AsyncClient):
         )
         return bool(success)
 
-    async def verify_code(self, phone: str, code: str) -> bool:
+    async def verify_code(
+        self, phone: str, code: str, project_name: Optional[str] = None
+    ) -> bool:
         """
         验证短信验证码
 
         :param phone: 手机号码
         :param code: 验证码
+        :param project_name: 绑定项目名；不传或空字符串则匿名登录
         :return: success 是否成功
         """
+        payload: Dict[str, Any] = {"phone": phone, "code": code}
+        pn = _normalized_project_name(project_name)
+        if pn is not None:
+            payload["project_name"] = pn
         _, success = await self._request(
             "POST",
             "/api/unified-login/sms/verify-code",
-            json={"phone": phone, "code": code},
+            json=payload,
         )
         return bool(success)
 
@@ -812,7 +900,11 @@ class SMSLogin(AsyncClient):
         return {"message": "登录超时或未完成授权"}, False
 
     async def login(
-        self, phone: str, code: str, timeout: int = 180
+        self,
+        phone: str,
+        code: str,
+        timeout: int = 180,
+        project_name: Optional[str] = None,
     ) -> Tuple[Dict, bool]:
         """
         验证验证码并等待登录结果
@@ -820,9 +912,10 @@ class SMSLogin(AsyncClient):
         :param phone: 手机号码
         :param code: 验证码
         :param timeout: 等待登录结果的超时时间（秒）
+        :param project_name: 绑定项目名；不传或空字符串则匿名登录
         :return: (用户信息, 是否成功)
         """
-        success = await self.verify_code(phone, code)
+        success = await self.verify_code(phone, code, project_name=project_name)
         if not success:
             return {"message": "验证码校验失败"}, False
 
@@ -859,18 +952,25 @@ class EmailLogin(AsyncClient):
         )
         return bool(success)
 
-    async def verify_code(self, email: str, code: str) -> bool:
+    async def verify_code(
+        self, email: str, code: str, project_name: Optional[str] = None
+    ) -> bool:
         """
         验证邮箱验证码
 
         :param email: 邮箱地址
         :param code: 验证码
+        :param project_name: 绑定项目名；不传或空字符串则匿名登录
         :return: success 是否成功
         """
+        payload: Dict[str, Any] = {"email": email, "code": code}
+        pn = _normalized_project_name(project_name)
+        if pn is not None:
+            payload["project_name"] = pn
         _, success = await self._request(
             "POST",
             "/api/unified-login/email/verify-code",
-            json={"email": email, "code": code},
+            json=payload,
         )
         return bool(success)
 
@@ -902,7 +1002,11 @@ class EmailLogin(AsyncClient):
         return {"message": "登录超时或未完成授权"}, False
 
     async def login(
-        self, email: str, code: str, timeout: int = 180
+        self,
+        email: str,
+        code: str,
+        timeout: int = 180,
+        project_name: Optional[str] = None,
     ) -> Tuple[Dict, bool]:
         """
         验证验证码并等待登录结果
@@ -910,9 +1014,10 @@ class EmailLogin(AsyncClient):
         :param email: 邮箱地址
         :param code: 验证码
         :param timeout: 等待登录结果的超时时间（秒）
+        :param project_name: 绑定项目名；不传或空字符串则匿名登录
         :return: (用户信息, 是否成功)
         """
-        success = await self.verify_code(email, code)
+        success = await self.verify_code(email, code, project_name=project_name)
         if not success:
             return {"message": "验证码校验失败"}, False
 
@@ -955,6 +1060,7 @@ class PasswordLogin(AsyncClient):
         user_identifier: str,
         password: str,
         display_name: Optional[str] = None,
+        project_name: Optional[str] = None,
     ) -> bool:
         """
         注册/设置密码：将密码哈希后写入外部用户表（login_method=password）。
@@ -963,6 +1069,7 @@ class PasswordLogin(AsyncClient):
         :param user_identifier: 用户标识（邮箱）
         :param password: 密码（6～100 位）
         :param display_name: 展示名称，可选
+        :param project_name: 绑定项目名；不传或空字符串则匿名登录
         :return: 是否成功
         """
         payload: Dict[str, Any] = {
@@ -971,6 +1078,9 @@ class PasswordLogin(AsyncClient):
         }
         if display_name is not None:
             payload["display_name"] = display_name
+        pn = _normalized_project_name(project_name)
+        if pn is not None:
+            payload["project_name"] = pn
         _, success = await self._request(
             "POST",
             "/api/unified-login/password/register",
@@ -982,21 +1092,27 @@ class PasswordLogin(AsyncClient):
         self,
         user_identifier: str,
         password: str,
+        project_name: Optional[str] = None,
     ) -> Tuple[Dict, bool]:
         """
         密码登录：校验邮箱与密码，成功则返回用户信息（与其它统一登录方式格式一致）。
 
         :param user_identifier: 用户标识（邮箱）
         :param password: 密码
+        :param project_name: 绑定项目名；不传或空字符串则匿名登录
         :return: (用户信息字典, 是否成功)
         """
+        body: Dict[str, Any] = {
+            "user_identifier": user_identifier,
+            "password": password,
+        }
+        pn = _normalized_project_name(project_name)
+        if pn is not None:
+            body["project_name"] = pn
         data, success = await self._request(
             "POST",
             "/api/unified-login/password/login",
-            json={
-                "user_identifier": user_identifier,
-                "password": password,
-            },
+            json=body,
         )
         if not success:
             return data if isinstance(data, dict) else {"message": data}, False
@@ -1007,6 +1123,7 @@ class PasswordLogin(AsyncClient):
         user_identifier: str,
         old_password: str,
         new_password: str,
+        project_name: Optional[str] = None,
     ) -> bool:
         """
         修改密码：校验原密码后更新为新密码。
@@ -1014,15 +1131,20 @@ class PasswordLogin(AsyncClient):
         :param user_identifier: 用户标识（邮箱）
         :param old_password: 当前密码
         :param new_password: 新密码（6～100 位）
+        :param project_name: 绑定项目名；不传或空字符串则匿名登录
         :return: 是否成功
         """
+        body: Dict[str, Any] = {
+            "user_identifier": user_identifier,
+            "old_password": old_password,
+            "new_password": new_password,
+        }
+        pn = _normalized_project_name(project_name)
+        if pn is not None:
+            body["project_name"] = pn
         _, success = await self._request(
             "POST",
             "/api/unified-login/password/change",
-            json={
-                "user_identifier": user_identifier,
-                "old_password": old_password,
-                "new_password": new_password,
-            },
+            json=body,
         )
         return bool(success)

{pixelarraythirdparty-1.2.8 → pixelarraythirdparty-1.3.0}/pixelarraythirdparty.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pixelarraythirdparty
-Version: 1.2.8
+Version: 1.3.0
 Summary: PixelArray 第三方微服务客户端
 Author-email: Lu qi <qi.lu@pixelarrayai.com>
 License-Expression: MIT

{pixelarraythirdparty-1.2.8 → pixelarraythirdparty-1.3.0}/pixelarraythirdparty.egg-info/SOURCES.txt

@@ -10,6 +10,8 @@ pixelarraythirdparty.egg-info/requires.txt
 pixelarraythirdparty.egg-info/top_level.txt
 pixelarraythirdparty/cron/__init__.py
 pixelarraythirdparty/cron/cron.py
+pixelarraythirdparty/custom_events/__init__.py
+pixelarraythirdparty/custom_events/custom_events.py
 pixelarraythirdparty/feedback/__init__.py
 pixelarraythirdparty/feedback/feedback.py
 pixelarraythirdparty/order/__init__.py

{pixelarraythirdparty-1.2.8 → pixelarraythirdparty-1.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pixelarraythirdparty"
-version = "1.2.8"
+version = "1.3.0"
 authors = [
     {name = "Lu qi", email = "qi.lu@pixelarrayai.com"},
 ]