v2.1.10: api

Author: BenPaoDeXiaoZhi

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ccw-api/api",
-  "version": "2.1.9",
+  "version": "2.1.10",
   "description": "ccw api collections",
   "license": "MIT",
   "author": "Meng Fuzi",

src/community-web/comment/like_record/delete.ts

@@ -0,0 +1,22 @@
+import { request } from "src/request";
+import { ApiResponse } from "src/types/api";
+
+export const url = "https://community-web.ccw.site/comment/like_record/delete";
+
+export type Req = {
+  commentId: number;
+};
+
+export type Res = boolean;
+
+/**
+ * 取消点赞评论
+ * @param {number} commentId 评论id
+ * @returns {Promise<Res>} 操作是否成功
+ */
+export async function unlikeComment(commentId: number): Promise<Res> {
+  const req: Req = { commentId };
+  return await request
+    .post<ApiResponse<Res>>(url, req)
+    .then((res) => res.data.body);
+}

src/community-web/index.ts

@@ -30,6 +30,8 @@ import { getMyHashTagCreations } from "./hash_tag_creation/mine";
 import { getHashTagDetail } from "./hash_tag/detail";
 import { getManagedHashTags } from "./hash_tag/managed/list";
 import { getHashTagFavoriteDetail } from "./hash_tag_favorite/detail";
+import { getCloudProjectDetail } from "./study-cloud-database/cloud_project/detail";
+import { saveCloudProject } from "./study-cloud-database/cloud_project/save";
 import { getDonatedRecordRanking } from "./creation_donated_record/ranking_list";
 import { getCreationFavoriteDetail } from "./creation_favorite/detail";
 import { getCreationRecommendPositionList } from "./creation_recommend_position/list";
@@ -109,6 +111,8 @@ import { resetCommentWeight } from "./study-community/comment/reset_weight";
 import { deleteComment } from "./study-community/comment/delete";
 import { createComment } from "./comment/create";
 import { likeComment } from "./comment/like_record/create";
+import { unlikeComment } from "./comment/like_record/delete";
+import { createReportLog } from "./report_log/create";
 import { getStudentFollowingPage } from "./student/following/page";
 import { donateTrade } from "./study-trade/trade/donate";
 import { getUserProductsPage } from "./user_package/user_product";
@@ -150,6 +154,7 @@ export const communityWeb = {
   fetchObserverInviteToken,
   createCloudVariable,
   createComment,
+  createReportLog,
   createShortUrl,
   createSmsCaptchaBySession,
   createSplitRule,
@@ -175,6 +180,7 @@ export const communityWeb = {
   getCreationDashboardMetricsDistribution,
   getCreationDashboardOverview,
   getCreationFavoriteDetail,
+  getCloudProjectDetail,
   getCreationIntroduction,
   getConnectCommunityCreationLikeStatus,
   getCreationRecommendPositionList,
@@ -255,6 +261,7 @@ export const communityWeb = {
   insertCheckInRecord,
   investSmartContract,
   likeComment,
+  unlikeComment,
   produceTeamMemberTicket,
   resetCommentWeight,
   resolveExternalIp,
@@ -264,6 +271,7 @@ export const communityWeb = {
   searchPosts,
   searchStudents,
   searchAll,
+  saveCloudProject,
   sendEvent,
   setUserProductStatus,
   shareCreation,

src/community-web/report_log/create.ts

@@ -0,0 +1,49 @@
+import { request } from "src/request";
+import { ApiResponse } from "src/types/api";
+
+export const url = "https://community-web.ccw.site/report_log/create";
+
+export type ReportSubjectType = "COMMENT" | "CREATION" | string;
+
+export type Req = {
+  description?: string;
+  evidence: Array<string>;
+  reason: string;
+  reportedSubjectOid: string;
+  reportedSubjectType: ReportSubjectType;
+  version?: string;
+};
+
+export type Res = boolean;
+
+/**
+ * 举报内容（评论/作品等）
+ * @param {string} reason 上报理由，例如："引战"
+ * @param {string} reportedSubjectOid 被上报对象的 id（可为数字或字符串形式）
+ * @param {string[]} evidence 证据列表（如截图链接）
+ * @param {ReportSubjectType} reportedSubjectType 被上报对象类型，示例："COMMENT"
+ * @param {string} description 补充描述（可选）
+ * @param {string} version 接口版本（可选）
+ * @returns {Promise<Res>} 是否上报成功
+ */
+export async function createReportLog(
+  reason: string,
+  reportedSubjectOid: string,
+  evidence: Array<string> = [],
+  reportedSubjectType: ReportSubjectType = "COMMENT",
+  description: string = "",
+  version: string = "1.0",
+): Promise<Res> {
+  const req: Req = {
+    reason,
+    reportedSubjectOid,
+    evidence,
+    reportedSubjectType,
+    description,
+    version,
+  };
+
+  return await request
+    .post<ApiResponse<Res>>(url, req)
+    .then((res) => res.data.body);
+}

src/community-web/study-cloud-database/cloud_project/detail.ts

@@ -0,0 +1,47 @@
+import { request } from "src/request";
+import { ApiResponse, MongoDBId } from "src/types/api";
+
+export const url =
+  "https://community-web.ccw.site/study-cloud-database/cloud_project/detail";
+
+export type Req = {
+  creationOid: MongoDBId;
+};
+
+export type CloudProjectMeta = {
+  agent?: string;
+  platform?: {
+    name?: string;
+    url?: string;
+  };
+  semver?: string;
+  vm?: string;
+};
+
+export type CloudProjectData = {
+  cloudProject: {
+    extensions: string[];
+    gandi: null | Record<string, any>;
+    meta: CloudProjectMeta;
+    monitors: Record<string, any>;
+    targets: string;
+  };
+  creationOid: MongoDBId;
+  lastModified: number;
+};
+
+export type Res = CloudProjectData;
+
+/**
+ * 获取云项目详情
+ * @param {MongoDBId} creationOid 作品 oid
+ * @returns {Promise<Res>} 云项目详情
+ */
+export async function getCloudProjectDetail(
+  creationOid: MongoDBId,
+): Promise<Res> {
+  const req: Req = { creationOid };
+  return await request
+    .post<ApiResponse<Res>>(url, req)
+    .then((res) => res.data.body);
+}

src/community-web/study-cloud-database/cloud_project/save.ts

@@ -0,0 +1,58 @@
+import { request } from "src/request";
+import { ApiResponse, MongoDBId } from "src/types/api";
+
+export const url =
+  "https://community-web.ccw.site/study-cloud-database/cloud_project/save";
+
+export type CloudProjectMeta = {
+  agent?: string;
+  platform?: {
+    name?: string;
+    url?: string;
+  };
+  semver?: string;
+  vm?: string;
+};
+
+export type Req = {
+  creationOid: MongoDBId;
+  extensions?: string[];
+  lastModified: number;
+  meta?: CloudProjectMeta;
+  monitors?: Record<string, any>;
+  targets: Record<string, any>;
+};
+
+export type Res = boolean;
+
+/**
+ * 保存云项目
+ * @param {MongoDBId} creationOid 作品 oid
+ * @param {number} lastModified 最后更新时间（毫秒）
+ * @param {Record<string, unknown>} targets 项目目标对象
+ * @param {CloudProjectMeta} meta 项目元信息（可选）
+ * @param {Record<string, unknown>} monitors 监控对象（可选）
+ * @param {string[]} extensions 扩展列表（可选）
+ * @returns {Promise<boolean>} 是否保存成功
+ */
+export async function saveCloudProject(
+  creationOid: MongoDBId,
+  lastModified: number,
+  targets: Record<string, unknown>,
+  meta: CloudProjectMeta = {},
+  monitors: Record<string, unknown> = {},
+  extensions: string[] = [],
+): Promise<Res> {
+  const req: Req = {
+    creationOid,
+    lastModified,
+    targets,
+    meta,
+    monitors,
+    extensions,
+  };
+
+  return await request
+    .post<ApiResponse<Res>>(url, req)
+    .then((res) => res.data.body);
+}

src/sso/index.ts

@@ -5,6 +5,7 @@ import { createSmsCaptcha } from "./web/auth/assistant/captcha/v2/create";
 import { loginByPhone } from "./web/auth/v3/login/by-phone";
 import { oauthAuthorize } from "./oauth/authorize";
 import { getOauthToken } from "./oauth/token";
+import { touchSession } from "./internal/auth/touch-session";
 
 export const sso = {
   loginByPassword,
@@ -14,4 +15,5 @@ export const sso = {
   loginByPhone,
   oauthAuthorize,
   getOauthToken,
+  touchSession,
 };

src/sso/internal/auth/touch-session.ts

@@ -0,0 +1,41 @@
+import { request } from "src/request";
+import { ApiResponse, MongoDBId } from "src/types/api";
+
+export const url = "https://sso.ccw.site/internal/auth/touch-session";
+
+export type Req = {
+  token?: string;
+};
+
+export type TouchSessionSuccess = {
+  accountId: number;
+  accountObjectId: MongoDBId;
+  accountType: string;
+  clientCode: string;
+  createdAt: number;
+  email: string | null;
+  expireTime: number;
+  extra: string; // JSON string
+  id: number;
+  lastAccessTime: number;
+  orgId: string;
+  scene: string | null;
+  status: string;
+  token: string;
+  urlEncodedFullName: string | null;
+};
+
+export type Res = TouchSessionSuccess | null;
+
+/**
+ * 刷新/校验会话（内部接口）
+ * 当 token 为空时后端会返回 token 不能为空 的错误；成功时返回会话信息。
+ * @param {string} token 会话 token（可选）
+ * @returns {Promise<Res>} 成功返回会话信息，失败会抛出错误
+ */
+export async function touchSession(token?: string): Promise<Res> {
+  const query = token ? `?token=${encodeURIComponent(token)}` : "";
+  return await request
+    .get<ApiResponse<TouchSessionSuccess | null>>(`${url}${query}`)
+    .then((res) => res.data.body);
+}