mcsmapi 0.1.7__py3-none-any.whl → 0.1.8b1__py3-none-any.whl

mcsmapi/models/overview.py

@@ -1,94 +1,105 @@
 from enum import Enum
 from typing import Literal
 from pydantic import BaseModel
-from mcsmapi.models.common import CpuMemChart, InstanceInfo, ProcessInfo
+from mcsmapi.models.common import CpuMemChart, ProcessInfo
 from mcsmapi.models.daemon import DaemonModel
 
 
 class SystemUser(BaseModel):
     """系统用户信息"""
 
-    uid: int = 0
+    uid: int
     """用户 ID (UID)"""
-    gid: int = 0
+    gid: int
     """用户组 ID (GID)"""
-    username: str = ""
+    username: str
     """用户名"""
-    homedir: str = ""
+    homedir: str
     """用户主目录"""
-    shell: str | None = None
+    shell: str | None
     """默认 Shell 解释器"""
 
 
 class SystemInfo(BaseModel):
     """系统信息"""
 
-    user: SystemUser = SystemUser()
+    user: SystemUser
     """当前登录用户信息"""
-    time: int = 0
+    time: int
     """系统当前时间 (Unix 时间戳)"""
-    totalmem: int = 0
+    totalmem: int
     """系统总内存大小 (单位: 字节)"""
-    freemem: int = 0
+    freemem: int
     """系统空闲内存大小 (单位: 字节)"""
-    type: str = ""
+    type: str
     """操作系统类型"""
-    version: str = ""
+    version: str
     """操作系统版本"""
-    node: str = ""
-    """系统节点名称"""
-    hostname: str = ""
+    node: str
+    """系统NodeJS版本"""
+    hostname: str
     """主机名"""
-    loadavg: list[float] = []
+    loadavg: tuple[float, float, float]
     """系统负载平均值 (过去 1、5、15 分钟)"""
-    platform: str = ""
+    platform: str
     """操作系统平台"""
-    release: str = ""
+    release: str
     """系统发行版本信息"""
-    uptime: float = 0
+    uptime: float
     """系统运行时间 (单位: 秒)"""
-    cpu: float = 0
+    cpu: float
     """CPU 当前使用率 (单位: %)"""
 
 
 class RecordInfo(BaseModel):
     """安全记录信息"""
 
-    logined: int = 0
-    """成功登录次数"""
-    illegalAccess: int = 0
+    logined: int
+    """登录成功次数"""
+    illegalAccess: int
     """非法访问次数"""
-    banips: int = 0
+    banips: int
     """被封禁的 IP 数量"""
-    loginFailed: int = 0
+    loginFailed: int
     """登录失败次数"""
 
 
+class RequestChart(BaseModel):
+    """应用实例运行和接口请求量趋势"""
+
+    value: int
+    """接口请求量"""
+    totalInstance: int
+    """总实例数量"""
+    runningInstance: int
+    """运行中实例数量"""
+
+
 class ChartInfo(BaseModel):
     """图表数据信息"""
 
     system: list[CpuMemChart]
-    """系统统计信息"""
-    request: list[InstanceInfo]
-    """实例统计信息"""
+    """系统资源使用趋势"""
+    request: list[RequestChart]
+    """应用实例运行和接口请求量趋势"""
 
 
 class RemoteCountInfo(BaseModel):
-    """远程守护进程统计信息"""
+    """远程节点统计信息"""
 
     total: int
-    """远程守护进程总数"""
+    """远程节点总数"""
     available: int
-    """可用的远程守护进程数量"""
+    """可用的远程节点数量"""
 
 
 class OverviewModel(BaseModel):
     """系统概览信息"""
 
     version: str
-    """系统当前版本"""
+    """面板当前版本"""
     specifiedDaemonVersion: str
-    """指定的守护进程 (Daemon) 版本"""
+    """指定的远程节点版本"""
     system: SystemInfo
     """系统信息"""
     record: RecordInfo
@@ -98,9 +109,9 @@ class OverviewModel(BaseModel):
     chart: ChartInfo
     """系统与请求统计图表数据"""
     remoteCount: RemoteCountInfo
-    """远程守护进程统计信息"""
+    """远程节点统计信息"""
     remote: list[DaemonModel]
-    """远程守护进程详细信息"""
+    """远程节点详细信息"""
 
 
 class LogType(Enum):
@@ -108,37 +119,59 @@ class LogType(Enum):
 
     # 系统相关
     SYSTEM_CONFIG_CHANGE = "system_config_change"
+    """系统配置修改"""
 
     # 用户相关
     USER_LOGIN = "user_login"
+    """用户登录"""
     USER_CONFIG_CHANGE = "user_config_change"
+    """修改用户配置"""
     USER_DELETE = "user_delete"
+    """删除用户"""
     USER_CREATE = "user_create"
+    """创建用户"""
 
-    # 守护进程相关
+    # 节点相关
     DAEMON_CONFIG_CHANGE = "daemon_config_change"
+    """修改节点配置"""
     DAEMON_REMOVE = "daemon_remove"
+    """删除节点"""
     DAEMON_CREATE = "daemon_create"
+    """创建节点"""
 
     # 实例任务相关
     INSTANCE_TASK_DELETE = "instance_task_delete"
+    """删除实例计划任务"""
     INSTANCE_TASK_CREATE = "instance_task_create"
+    """创建实例计划任务"""
 
     # 实例文件相关
     INSTANCE_FILE_DELETE = "instance_file_delete"
+    """删除实例文件"""
     INSTANCE_FILE_DOWNLOAD = "instance_file_download"
+    """下载实例文件"""
     INSTANCE_FILE_UPDATE = "instance_file_update"
+    """更新实例文件"""
     INSTANCE_FILE_UPLOAD = "instance_file_upload"
+    """上传实例文件"""
 
     # 实例操作相关
     INSTANCE_DELETE = "instance_delete"
+    """删除实例"""
     INSTANCE_CREATE = "instance_create"
+    """创建实例"""
     INSTANCE_CONFIG_CHANGE = "instance_config_change"
+    """修改实例配置"""
     INSTANCE_KILL = "instance_kill"
+    """强制停止实例"""
     INSTANCE_UPDATE = "instance_update"
+    """更新实例"""
     INSTANCE_RESTART = "instance_restart"
+    """重启实例"""
     INSTANCE_STOP = "instance_stop"
+    """停止实例"""
     INSTANCE_START = "instance_start"
+    """启动实例"""
 
 
 class LogDetail(BaseModel):
@@ -161,10 +194,10 @@ class LogDetail(BaseModel):
     instance_id: str | None = None
     """实例ID(仅实例事件存在)"""
     daemon_id: str | None = None
-    """守护进程ID(仅实例事件和守护进程事件存在)"""
+    """节点ID(仅实例事件和节点事件存在)"""
     login_result: bool | None = None
     """登录结果(仅登录事件存在)"""
-    file: str | None = None
-    """文件名(仅文件操作事件存在)"""
+    file: list[str] | str | None = None
+    """被操作的文件(仅文件操作事件存在)"""
     task_name: str | None = None
     """任务名称(仅任务操作事件存在)"""

mcsmapi/models/user.py

@@ -5,61 +5,71 @@ from mcsmapi.models.instance import InstanceDetail, UserInstancesList
 
 
 class UserPermission(IntEnum):
+    """用户权限级别"""
+
     BANNED = -1
     USER = 1
     ADMIN = 10
 
 
+class UserCreateResult(BaseModel):
+    """用户创建结果"""
+
+    uuid: str
+    """用户UUID"""
+    userName: str
+    """用户名"""
+    permission: UserPermission
+    """用户权限级别"""
+
+
 class UserModel(BaseModel):
     """用户信息模型"""
 
-    uuid: str = ""
-    """用户唯一标识符 (UUID)"""
-    userName: str = ""
+    uuid: str
+    """用户UUID"""
+    userName: str
     """用户名"""
-    passWord: str = ""
-    """用户密码 (存储加密后的字符串)"""
-    passWordType: int = 0
-    """密码类型 (0=默认类型)"""
-    salt: str = ""
-    """密码盐值 (用于加密)"""
-    permission: UserPermission = UserPermission.USER
+    permission: UserPermission
     """用户权限级别"""
-    registerTime: str = ""
-    """用户注册时间 (时间字符串格式)"""
-    loginTime: str = ""
-    """用户最后登录时间 (时间字符串格式)"""
-    apiKey: str = ""
+    registerTime: str
+    """用户注册时间 (YYYY/M/D hh:mm:ss)"""
+    loginTime: str
+    """用户最后登录时间 (YYYY/M/D hh:mm:ss)"""
+    apiKey: str
     """用户 API 密钥"""
-    isInit: bool = False
-    """是否为初始化用户 (系统内置用户)"""
-    secret: str = ""
-    """用户安全密钥 (可能用于额外的身份验证)"""
-    open2FA: bool = False
+    open2FA: bool
     """是否启用双因素认证 (2FA)"""
-    instances: list[UserInstancesList] = []
+    instances: list[UserInstancesList]
     """用户关联的实例列表"""
-
-    def delete(self) -> bool:
+    isInit: bool
+    """是否为初始化用户 (已弃用)"""
+    secret: str
+    """用户安全密钥 (已弃用)"""
+    passWord: str
+    """用户密码 (已弃用)"""
+    passWordType: int
+    """密码类型 (已弃用)"""
+    salt: str
+    """密码盐值 (已弃用)"""
+
+    def delete(self):
         """
-        删除该用户。
+        删除该用户
 
-        **返回:**
-        - bool: 删除成功后返回True。
+        :returns: 删除成功后返回True
         """
         from mcsmapi.apis.user import User
 
         return User().delete([self.uuid])
 
-    def update(self, config: dict[str, Any]) -> bool:
+    def update(self, config: dict[str, Any]):
         """
-        更新该用户的信息。
+        更新该用户的信息
 
-        参数:
-        - config (dict[str, Any]): 用户的新信息，以字典形式提供，缺失内容使用原用户信息填充。
+        :params config: 用户的新信息，以字典形式提供，缺失内容使用原用户信息填充
 
-        返回:
-        - bool: 更新成功后返回True。
+        :returns: 更新成功后返回True
         """
         from mcsmapi.apis.user import User
 
@@ -80,38 +90,44 @@ class UserModel(BaseModel):
 class SearchUserModel(BaseModel):
     """用户搜索结果"""
 
-    total: int = 0
+    total: int
     """匹配的用户总数"""
-    page: int = 0
+    page: int
     """当前页码"""
-    page_size: int = 0
+    page_size: int
     """每页返回的用户数量"""
-    max_page: int = 0
+    max_page: int
     """最大可用页数"""
-    data: list[UserModel] = []
+    data: list[UserModel]
     """用户信息列表"""
 
 
 class UserConfig(BaseModel):
     """用户配置信息"""
 
-    uuid: str
-    """用户唯一标识符 (UUID)"""
-    userName: str
+    uuid: str = ""
+    """用户UUID"""
+    userName: str = ""
     """用户名"""
-    loginTime: str
+    loginTime: str = ""
     """最后登录时间"""
-    registerTime: str
+    registerTime: str = ""
     """注册时间"""
-    instances: list[InstanceDetail]
+    instances: list[InstanceDetail] = []
     """用户拥有的实例列表"""
-    permission: UserPermission
+    permission: UserPermission = UserPermission.USER
     """用户权限级别"""
-    apiKey: str
-    """用户 API 密钥"""
-    isInit: bool
-    """是否为初始化用户 (系统内置用户)"""
-    secret: str
-    """用户安全密钥 (可能用于额外的身份验证)"""
-    open2FA: bool
+    passWord: str = ""
+    """用户密码"""
+    open2FA: bool = False
     """是否启用双因素认证 (2FA)"""
+    apiKey: str = ""
+    """用户 API 密钥"""
+    passWordType: int = 1
+    """密码类型 (已弃用)"""
+    isInit: bool = False
+    """是否为初始化用户 (已弃用)"""
+    secret: str = ""
+    """用户安全密钥 (已弃用)"""
+    salt: str = ""
+    """用户密码盐值 (已弃用)"""

{mcsmapi-0.1.7.dist-info → mcsmapi-0.1.8b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcsmapi
-Version: 0.1.7
+Version: 0.1.8b1
 Summary: Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包
 Author-email: molanp <molanpp@outlook.com>
 License-Expression: MIT
@@ -11,7 +11,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
-Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pydantic<3.0.0,>=2.0.0
 Dynamic: license-file
 
 # MCSM API
@@ -84,9 +84,10 @@ mcsm.login_with_apikey("apikey")
 
 # Get dashboard data
 overview = mcsm.overview()
+overview_data = overview.overview()
 
 # Get MCSM version
-mcsm_version = mcsm.overview().version
+mcsm_version = overview_data.version
 ```
 
 ## Contributing

mcsmapi-0.1.8b1.dist-info/RECORD

@@ -0,0 +1,24 @@
+mcsmapi/__init__.py,sha256=TxBjQPMtwR_Eh0N7nZAoKinONAgnDsSbt47-cLvbeLk,1418
+mcsmapi/exceptions.py,sha256=mHsAHyoX9SiFDGBMEhesA_ao9hhZZ38EGTp97K7VDp8,184
+mcsmapi/pool.py,sha256=Xa1DvBdfn5zTZ-eB50BFbYxhKX8j-4vfus9QOGO_FQE,348
+mcsmapi/request.py,sha256=G6O4Q3oXidmauyraUgoMTkms5XFlY-iHPhZ3s0k9TmM,2743
+mcsmapi/apis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcsmapi/apis/daemon.py,sha256=0ng7Twv04gs4y09AYFIH2o5YPoxGV3c3TwsUkqxpgTI,2555
+mcsmapi/apis/file.py,sha256=1SYNw-6Qaiq5knS0Pu1_7-y82WtcB6EOHPGakYvvqjQ,9630
+mcsmapi/apis/image.py,sha256=ajTiZXSj0o5aMEDcPe6JkFI5JJcYZhQXszmNqnbSJxA,2656
+mcsmapi/apis/instance.py,sha256=h2y3gTLINvDZq7vOzBhQ3X02f3mmg5ZlPunMDkTahgo,8318
+mcsmapi/apis/overview.py,sha256=7wRAdhFzbtLq6Oknj4_ncO5fETZuZCGtliErA0NNju0,514
+mcsmapi/apis/user.py,sha256=KXd8OPjyQBprPTlJD-wLGE-BtaOsM_0WF1yqRlGgTfg,2414
+mcsmapi/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcsmapi/models/common.py,sha256=HNvYJnbxrtkJ7-H2zCXSuB-J-YXBXCcfyK0TzQprsKI,531
+mcsmapi/models/daemon.py,sha256=It7kPyxogqY6oBdyXYNi4EmyqlGwizu7j-N37snko8k,4093
+mcsmapi/models/file.py,sha256=vk9rQp3Yw_aK7F8ghi5eiBYuwcjK1m-2IQ0YbUWoj3A,5933
+mcsmapi/models/image.py,sha256=mpyS7KTVoOwH2opB-fQC2GD3An_bXcERLmLPDBuoYUA,5643
+mcsmapi/models/instance.py,sha256=FTFLkwi3r9OUQnusIQ1JI1f7dX4QIbH1Q5BxfUWIqxM,8362
+mcsmapi/models/overview.py,sha256=Q_MG04iCkQ7KdBZnji3xA9XzwM3JZ6fZe3NWap8lMdU,5284
+mcsmapi/models/user.py,sha256=f2fZS1EQFwqOJM7fKu91dcvHHAdRjhAhwY8XfwXhRvk,3318
+mcsmapi-0.1.8b1.dist-info/licenses/LICENSE,sha256=bMKDPsvaybvY-4TTlSZtCXPPtxb7KPpDVqXgDA8Ogo0,1068
+mcsmapi-0.1.8b1.dist-info/METADATA,sha256=FyYvDSMJwqwYImKbLTXSSNx4f7mI_LFb9EqxOITuWVs,3032
+mcsmapi-0.1.8b1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mcsmapi-0.1.8b1.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
+mcsmapi-0.1.8b1.dist-info/RECORD,,

mcsmapi-0.1.7.dist-info/RECORD

@@ -1,24 +0,0 @@
-mcsmapi/__init__.py,sha256=TxBjQPMtwR_Eh0N7nZAoKinONAgnDsSbt47-cLvbeLk,1418
-mcsmapi/exceptions.py,sha256=mHsAHyoX9SiFDGBMEhesA_ao9hhZZ38EGTp97K7VDp8,184
-mcsmapi/pool.py,sha256=Xa1DvBdfn5zTZ-eB50BFbYxhKX8j-4vfus9QOGO_FQE,348
-mcsmapi/request.py,sha256=G6O4Q3oXidmauyraUgoMTkms5XFlY-iHPhZ3s0k9TmM,2743
-mcsmapi/apis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mcsmapi/apis/daemon.py,sha256=4kGWkVHsT7wgMGaTOei3daUe8qJ3_LGJ12hjq9j6OaE,2759
-mcsmapi/apis/file.py,sha256=uoO6PSlbSfleMQnopc4Ajmf_Z4dMN4IkunXBzv9rvvQ,10955
-mcsmapi/apis/image.py,sha256=Onb_yciTyybB4r2TxyvW04Z6-nnTSDO2HanhtRbA3m4,2968
-mcsmapi/apis/instance.py,sha256=RHvR7dyKgOlIuKbQzemWVXw17jEUmLILZ0J-gFu6538,11117
-mcsmapi/apis/overview.py,sha256=MqLmEyLh3i9VsQRFn7WI_02yRBt6eqZvusOkhHFIgFw,518
-mcsmapi/apis/user.py,sha256=XdoIgT9j87fhp0FPO4UusPYDPf59WlvzRaeLAdMhikM,3022
-mcsmapi/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mcsmapi/models/common.py,sha256=2KiqbGiBRuipIoeSNPH9_p7sGyKOy406JtBhWR4K0dQ,598
-mcsmapi/models/daemon.py,sha256=FTt10oYFnGXG1WAXMJ4roPGLCX5R5U3YGIzeEu-2F4E,4344
-mcsmapi/models/file.py,sha256=0BltWCHZC0Mlic1_xaPRys0HyNdKScGNxui4_tzREUI,5976
-mcsmapi/models/image.py,sha256=jlEbLF6uEwBTRShOGI0vWYN7WAZyJoiMa1gw_UjKINw,5447
-mcsmapi/models/instance.py,sha256=vixAknesy-lop5BI8lKIHaDsSpa5xJtycAfX3zz0PGs,8810
-mcsmapi/models/overview.py,sha256=kGDvHtsur1iA0wbeT-QkZPf04wkmo6YsrFSLtGZpsd0,4583
-mcsmapi/models/user.py,sha256=OnELhHdnoJYvfJUH55QwAHsZDu1vwigYIjAdbZFyMnk,3182
-mcsmapi-0.1.7.dist-info/licenses/LICENSE,sha256=bMKDPsvaybvY-4TTlSZtCXPPtxb7KPpDVqXgDA8Ogo0,1068
-mcsmapi-0.1.7.dist-info/METADATA,sha256=7lsyKuG4FBPFGpyb0L3CpuNcW4zvuBpPECOEjhBzZEg,2989
-mcsmapi-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mcsmapi-0.1.7.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
-mcsmapi-0.1.7.dist-info/RECORD,,