@ccw-api/api 0.3.1 → 0.4.1

package/dist/esm/src/community-web/creation_donated_record/ranking_list.test.js

@@ -0,0 +1,12 @@
+import { getDonatedRecordRanking } from "./ranking_list";
+const CREATION_OID = "62bd863874c3155ff7a54308";
+test("get donated record ranking should return data", async () => {
+    const res = await getDonatedRecordRanking(CREATION_OID, { perPage: 5 });
+    expect(res.totalBucks).toBeDefined();
+    expect(res.rankingList.data.length).toBeGreaterThan(0);
+    res.rankingList.data.forEach((record) => {
+        expect(record.bucks).toBeDefined();
+        expect(record.donatorName).toBeDefined();
+        expect(record.donatorOid).toBeDefined();
+    });
+});

package/dist/esm/src/community-web/creation_favorite/detail.js

@@ -0,0 +1,13 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/creation_favorite/detail";
+/**
+ * 获取作品收藏详情（需要登录）
+ * @param {MongoDBId} creationOid 作品id
+ * @returns {Promise<Res>} 收藏详情（未收藏返回null）
+ */
+export async function getCreationFavoriteDetail(creationOid) {
+    const req = { creationOid };
+    return await ccwAxios
+        .post(url, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/creation_favorite/detail.test.js

@@ -0,0 +1,5 @@
+import { getCreationFavoriteDetail } from "./detail";
+const CREATION_OID = "62bd863874c3155ff7a54308";
+test("get creation favorite detail should reject without login", async () => {
+    await expect(getCreationFavoriteDetail(CREATION_OID)).rejects.toThrow("ccw axios Request failed: token为空(4001082401)");
+});

package/dist/esm/src/community-web/creation_recommend_position/list.js

@@ -0,0 +1,14 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/creation_recommend_position/list";
+/**
+ * 获取作品推荐位置列表
+ * @deprecated 此接口不可用，请使用 `getRecommendCreations` from `src/community-web/creation/recommend.ts`
+ * @param {MongoDBId} creationOid 作品id
+ * @returns {Promise<Res>} 推荐位置列表,因为不知道什么bug,固定为[]
+ */
+export async function getCreationRecommendPositionList(creationOid) {
+    const req = { creationOid };
+    return await ccwAxios
+        .post(url, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/creation_recommend_position/list.test.js

@@ -0,0 +1,5 @@
+import { getCreationRecommendPositionList } from "./list";
+test("get creation recommend position list returns array without token", async () => {
+    const result = await getCreationRecommendPositionList("63c2807d669fa967f17f5559");
+    expect(Array.isArray(result)).toBe(true);
+});

package/dist/esm/src/community-web/creation_release/code_profiling/detail.js

@@ -0,0 +1,14 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/creation_release/code_profiling/detail";
+/**
+ * 获取作品工程统计详情
+ * @param {MongoDBId} creationOid 作品id
+ * @param {MongoDBId} creationReleaseOid 发布版本id
+ * @returns {Promise<Res>} 代码分析详情
+ */
+export async function getCodeProfilingDetail(creationOid, creationReleaseOid) {
+    const req = { creationOid, creationReleaseOid };
+    return await ccwAxios
+        .post(url, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/creation_release/code_profiling/detail.test.js

@@ -0,0 +1,5 @@
+import { getCodeProfilingDetail } from "./detail";
+test("get code profiling detail returns null or object without token", async () => {
+    const result = await getCodeProfilingDetail("63c2807d669fa967f17f5559", "63c2807d669fa967f17f5559");
+    expect(result === null || typeof result === "object").toBe(true);
+});

package/dist/esm/src/community-web/creation_release/page.js

@@ -0,0 +1,24 @@
+import { ccwAxios } from "@ccw-api/axios";
+import { DEFAULT_PAGE_ARGS, queryPage } from "src/queryPages";
+export const url = "https://community-web.ccw.site/creation_release/page";
+/**
+ * 获取作品发布记录分页
+ * @param {MongoDBId} creationOid 作品id
+ * @param {Partial<PageArgs<SortField | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 发布记录分页列表
+ */
+export async function getCreationReleasePage(creationOid, pageArgs_ = {
+    sortField: "submittedAt",
+}) {
+    const pageArgs = {
+        ...DEFAULT_PAGE_ARGS,
+        ...pageArgs_,
+    };
+    const queryUrl = queryPage(url, pageArgs);
+    const req = {
+        creationOid,
+    };
+    return await ccwAxios
+        .post(queryUrl, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/creation_release/page.test.js

@@ -0,0 +1,12 @@
+import { getCreationReleasePage } from "./page";
+test("get creation release page returns PagesRes without token", async () => {
+    const result = await getCreationReleasePage("69929185f8d6142487fd4b2e");
+    expect(result).toHaveProperty("data");
+    expect(result).toHaveProperty("page");
+    expect(result).toHaveProperty("perPage");
+    expect(result).toHaveProperty("totalNum");
+    expect(result).toHaveProperty("totalPages");
+    expect(Array.isArray(result.data)).toBe(true);
+    expect(typeof result.totalNum).toBe("number");
+    expect(typeof result.totalPages).toBe("number");
+});

package/dist/esm/src/community-web/creation_screenshot/page.js

@@ -0,0 +1,20 @@
+import { ccwAxios } from "@ccw-api/axios";
+import { DEFAULT_PAGE_ARGS, queryPage } from "src/queryPages";
+export const url = "https://community-web.ccw.site/creation_screenshot/page";
+/**
+ * 获取作品截图分页
+ * @param {MongoDBId} subjectOid 作品id
+ * @param {Partial<PageArgs<"createdAt" | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 分页截图列表
+ */
+export async function getCreationScreenshotPage(subjectOid, pageArgs_ = {}) {
+    const pageArgs = {
+        ...DEFAULT_PAGE_ARGS,
+        ...pageArgs_,
+    };
+    const queryUrl = queryPage(url, pageArgs);
+    const req = { subjectOid };
+    return await ccwAxios
+        .post(queryUrl, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/creation_screenshot/page.test.js

@@ -0,0 +1,11 @@
+import { getCreationScreenshotPage } from "./page";
+const CREATION_OID = "62bd863874c3155ff7a54308";
+test("get creation screenshot page should return data", async () => {
+    const res = await getCreationScreenshotPage(CREATION_OID, { perPage: 5 });
+    expect(Array.isArray(res.data)).toBe(true);
+    if (res.data.length > 0) {
+        expect(res.data[0].creationScreenshot).toBeDefined();
+        expect(res.data[0].commenter).toBeDefined();
+        expect(res.data[0].topicId).toBeDefined();
+    }
+});

package/dist/esm/src/community-web/creation_stats/view.js

@@ -0,0 +1,14 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/creation_stats/view";
+/**
+ * 查看作品统计（增加浏览量）
+ * @param {MongoDBId} oid 作品id
+ * @param {string} inviteCode 邀请码
+ * @returns {Promise<boolean>} 是否成功
+ */
+export async function viewCreationStats(oid, inviteCode = "") {
+    const req = { oid, inviteCode };
+    return await ccwAxios
+        .post(url, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/creation_stats/view.test.js

@@ -0,0 +1,6 @@
+import { viewCreationStats } from "./view";
+const CREATION_OID = "62bd863874c3155ff7a54308";
+test("view creation stats should return boolean", async () => {
+    const res = await viewCreationStats(CREATION_OID);
+    expect(typeof res).toBe("boolean");
+});

package/dist/esm/src/community-web/currency/account/personal.js

@@ -0,0 +1,11 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/currency/account/personal";
+/**
+ * 获取个人金币信息
+ * @returns {Promise<Res>} 账户金币余额信息
+ */
+export async function getPersonalCurrencyAccount() {
+    return await ccwAxios
+        .post(url)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/currency/account/personal.test.js

@@ -0,0 +1,4 @@
+import { getPersonalCurrencyAccount } from "./personal";
+test("get personal currency account should reject without login", async () => {
+    await expect(getPersonalCurrencyAccount()).rejects.toThrow();
+});

package/dist/esm/src/community-web/emoji/all.js

@@ -0,0 +1,11 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/emoji/all";
+/**
+ * 获取所有表情包
+ * @returns {Promise<Res>} 表情包列表
+ */
+export async function getAllEmojis() {
+    return await ccwAxios
+        .post(url, {})
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/emoji/all.test.js

@@ -0,0 +1,11 @@
+import { getAllEmojis } from "./all";
+test("get all emojis should return data", async () => {
+    const res = await getAllEmojis();
+    expect(Array.isArray(res)).toBe(true);
+    if (res.length > 0) {
+        expect(res[0].id).toBeDefined();
+        expect(res[0].name).toBeDefined();
+        expect(res[0].imageUrl).toBeDefined();
+        expect(res[0].category).toBeDefined();
+    }
+});

package/dist/esm/src/community-web/emoji/category/list.js

@@ -0,0 +1,11 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/emoji/category/list";
+/**
+ * 获取表情包分类列表
+ * @returns {Promise<Res>} 表情包分类列表
+ */
+export async function getEmojiCategoryList() {
+    return await ccwAxios
+        .post(url, {})
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/emoji/category/list.test.js

@@ -0,0 +1,9 @@
+import { getEmojiCategoryList } from "./list";
+test("get emoji category list should return data", async () => {
+    const res = await getEmojiCategoryList();
+    expect(Array.isArray(res)).toBe(true);
+    if (res.length > 0) {
+        expect(res[0].id).toBeDefined();
+        expect(res[0].name).toBeDefined();
+    }
+});

package/dist/esm/src/community-web/emoji/page.js

@@ -0,0 +1,23 @@
+import { ccwAxios } from "@ccw-api/axios";
+import { queryPage, DEFAULT_PAGE_ARGS } from "src/queryPages";
+export const url = "https://community-web.ccw.site/emoji/page";
+/**
+ * 分页获取表情包
+ * @param {string} status 表情包状态
+ * @param {Partial<PageArgs<"createdAt" | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 分页表情包数据
+ */
+export async function getEmojiPage(status = "ENABLED", pageArgs_ = {
+    sortField: "createdAt",
+}) {
+    const pageArgs = { ...DEFAULT_PAGE_ARGS, ...pageArgs_ };
+    const queryUrl = queryPage(url, pageArgs);
+    const req = {
+        page: pageArgs.page,
+        perPage: pageArgs.perPage,
+        status,
+    };
+    return await ccwAxios
+        .post(queryUrl, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/emoji/page.test.js

@@ -0,0 +1,12 @@
+import { getEmojiPage } from "./page";
+test("get emoji page should return data", async () => {
+    const res = await getEmojiPage("PUBLISHED", { perPage: 5 });
+    expect(res.data).toBeDefined();
+    expect(Array.isArray(res.data)).toBe(true);
+    expect(res.totalNum).toBeDefined();
+    expect(res.totalPages).toBeDefined();
+    if (res.data.length > 0) {
+        expect(res.data[0].id).toBeDefined();
+        expect(res.data[0].name).toBeDefined();
+    }
+});

package/dist/esm/src/community-web/event.js

@@ -0,0 +1,13 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/event";
+/**
+ * 发送事件
+ * @param {string} actionId 事件ID
+ * @returns {Promise<Res>} 是否成功
+ */
+export async function sendEvent(actionId) {
+    const req = { actionId };
+    return await ccwAxios
+        .post(url, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/event.test.js

@@ -0,0 +1,5 @@
+import { sendEvent } from "./event";
+const ACTION_ID = "test-action-id";
+test("send event should reject with invalid actionId", async () => {
+    await expect(sendEvent(ACTION_ID)).rejects.toThrow();
+});

package/dist/esm/src/community-web/hash_tag/detail.js

@@ -0,0 +1,13 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/hash_tag/detail";
+/**
+ * 获取星球详情
+ * @param {string} identifier 星球标识符（名称）
+ * @returns {Promise<Res>} 星球详情
+ */
+export async function getHashTagDetail(identifier) {
+    const req = { identifier };
+    return await ccwAxios
+        .post(url, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/hash_tag/hash_tag_detail.test.js

@@ -0,0 +1,9 @@
+import { getHashTagDetail } from "./detail";
+test("get hash tag detail should return data", async () => {
+    const res = await getHashTagDetail("蔚蓝档案");
+    expect(res.identifier).toBe("蔚蓝档案");
+    expect(res.id).toBe(29887);
+    expect(res.status).toBe("ENABLED");
+    expect(Array.isArray(res.managers)).toBe(true);
+    expect(Array.isArray(res.managerIds)).toBe(true);
+});

package/dist/esm/src/community-web/hash_tag/managed/list.js

@@ -0,0 +1,29 @@
+import { ccwAxios } from "@ccw-api/axios";
+import { DEFAULT_PAGE_ARGS, queryPage } from "src/queryPages";
+export const url = "https://community-web.ccw.site/hash_tag/managed/list";
+const dpa = {
+    ...DEFAULT_PAGE_ARGS,
+    sortField: "createdAt",
+};
+/**
+ * 获取用户管理的星球列表
+ * @param {MongoDBId} studentOid 学生oid
+ * @param {number[]} excludeHashTagIds 排除的星球id列表
+ * @param {Partial<PageArgs<SortField | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 管理的星球分页结果
+ */
+export async function getManagedHashTags(studentOid, excludeHashTagIds = [], pageArgs_ = {}) {
+    const pageArgs = {
+        ...dpa,
+        ...pageArgs_,
+    };
+    const queryUrl = queryPage(url, pageArgs);
+    const req = {
+        ...pageArgs,
+        studentOid,
+        excludeHashTagIds,
+    };
+    return await ccwAxios
+        .post(queryUrl, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/hash_tag/managed/managed_list.test.js

@@ -0,0 +1,10 @@
+import { getManagedHashTags } from "./list";
+const STUDENT_OID = "63c2807d669fa967f17f5559";
+test("get managed hash tags should return data", async () => {
+    const res = await getManagedHashTags(STUDENT_OID);
+    expect(typeof res.totalPages).toBe("number");
+    expect(typeof res.totalNum).toBe("number");
+    expect(Array.isArray(res.data)).toBe(true);
+    expect(res.page).toBeGreaterThanOrEqual(1);
+    expect(res.perPage).toBeGreaterThanOrEqual(1);
+});

package/dist/esm/src/community-web/hash_tag/recommend/list.js

@@ -0,0 +1,11 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/hash_tag/recommend/list";
+/**
+ * 获取推荐星球列表
+ * @returns {Promise<Res>} 推荐星球列表
+ */
+export async function getRecommendHashTags() {
+    return await ccwAxios
+        .post(url)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/hash_tag/recommend/list.test.js

@@ -0,0 +1,4 @@
+import { getRecommendHashTags } from "./list";
+test("get recommend hash tags should fail without token", async () => {
+    await expect(getRecommendHashTags()).resolves.toHaveLength(1);
+});

package/dist/esm/src/community-web/hash_tag_creation/hash_tag_creation_list_relation.test.js

@@ -0,0 +1,4 @@
+import { getPlanetsOfCreation } from "./list_relation";
+test("get hash tag creation relation list should reject without login", async () => {
+    await expect(getPlanetsOfCreation("6880873d2211fa69e41c9d19")).rejects.toThrow("token为空");
+});

package/dist/esm/src/community-web/hash_tag_creation/hash_tag_creation_mine.test.js

@@ -0,0 +1,4 @@
+import { getMyHashTagCreations } from "./mine";
+test("get my hash tag creations should reject without login", async () => {
+    await expect(getMyHashTagCreations()).rejects.toThrow("token为空");
+});

package/dist/esm/src/community-web/hash_tag_creation/list_relation.js

@@ -0,0 +1,13 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/hash_tag_creation/list_relation";
+/**
+ * 获取作品所在星球列表
+ * @param {MongoDBId} creationOid 作品ID
+ * @returns {Promise<Res>} 星球列表
+ */
+export async function getPlanetsOfCreation(creationOid) {
+    const req = { creationOid };
+    return await ccwAxios
+        .post(url, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/hash_tag_creation/list_relation.test.js

@@ -0,0 +1,5 @@
+import { getPlanetsOfCreation } from "./list_relation";
+const CREATION_OID = "62bd863874c3155ff7a54308";
+test("get hash tag creation relation list should reject without login", async () => {
+    await expect(getPlanetsOfCreation(CREATION_OID)).rejects.toThrow();
+});

package/dist/esm/src/community-web/hash_tag_creation/mine.js

@@ -0,0 +1,29 @@
+import { ccwAxios } from "@ccw-api/axios";
+import { DEFAULT_PAGE_ARGS, queryPage } from "src/queryPages";
+export const url = "https://community-web.ccw.site/hash_tag_creation/mine";
+const dpa = {
+    ...DEFAULT_PAGE_ARGS,
+    sortField: "lastPassedAt",
+};
+/**
+ * 获取当前用户提交到星球的作品列表
+ * @param {string} [excludeHashTag] 排除的星球标识符（名称）
+ * @param {HashTagCreationStatus[]} [statuses] 作品状态筛选，例如 ["PUBLISHED"]
+ * @param {Partial<PageArgs<SortField | T>>} [pageArgs_] 分页参数
+ * @returns {Promise<Res>} 星球作品分页结果
+ */
+export async function getMyHashTagCreations(excludeHashTag, statuses, pageArgs_ = {}) {
+    const pageArgs = {
+        ...dpa,
+        ...pageArgs_,
+    };
+    const queryUrl = queryPage(url, pageArgs);
+    const req = {
+        ...pageArgs,
+        excludeHashTag,
+        statuses,
+    };
+    return await ccwAxios
+        .post(queryUrl, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/hash_tag_favorite/detail.js

@@ -0,0 +1,13 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/hash_tag_favorite/detail";
+/**
+ * 获取星球收藏详情
+ * @param {number} hashTagId 星球ID
+ * @returns {Promise<Res>} 星球收藏详情
+ */
+export async function getHashTagFavoriteDetail(hashTagId) {
+    const req = { hashTagId };
+    return await ccwAxios
+        .post(url, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/hash_tag_favorite/hash_tag_favorite_detail.test.js

@@ -0,0 +1,4 @@
+import { getHashTagFavoriteDetail } from "./detail";
+test("get hash tag favorite detail should reject without login", async () => {
+    await expect(getHashTagFavoriteDetail(29887)).rejects.toThrow("token为空");
+});

package/dist/esm/src/community-web/health/check.js

@@ -0,0 +1,12 @@
+import { ccwAxios } from "@ccw-api/axios";
+export const url = "https://community-web.ccw.site/health/check";
+/**
+ * @deprecated 仅用于初始化axios
+ * health check接口
+ * @returns {Promise<Res>}
+ */
+export async function healthCheck() {
+    return await ccwAxios
+        .post(url)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/health/check.test.js

@@ -0,0 +1,10 @@
+import { healthCheck } from "./check";
+test("health check should return data", async () => {
+    const res = await healthCheck();
+    expect(Array.isArray(res)).toBe(true);
+    if (res.length > 0) {
+        expect(res[0].name).toBeDefined();
+        expect(res[0].status).toBeDefined();
+        expect(res[0].traceId).toBeDefined();
+    }
+});

package/dist/esm/src/community-web/historical_team_member/page.js

@@ -0,0 +1,27 @@
+import { ccwAxios } from "@ccw-api/axios";
+import { DEFAULT_PAGE_ARGS, queryPage } from "src/queryPages";
+export const url = "https://community-web.ccw.site/historical_team_member/page";
+/**
+ * 获取历史团队成员分页
+ * 不知道怎么用
+ * @param {MongoDBId} creationOid 作品id
+ * @param {Partial<PageArgs<string | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 历史团队成员分页列表
+ */
+export async function getHistoricalTeamMemberPage(creationOid, pageArgs_ = {
+    sortField: "createdAt",
+}) {
+    const pageArgs = {
+        ...DEFAULT_PAGE_ARGS,
+        ...pageArgs_,
+    };
+    const queryUrl = queryPage(url, pageArgs);
+    const req = {
+        creationOid,
+        page: pageArgs.page,
+        perPage: pageArgs.perPage,
+    };
+    return await ccwAxios
+        .post(queryUrl, req)
+        .then((res) => res.data.body);
+}

package/dist/esm/src/community-web/historical_team_member/page.test.js

@@ -0,0 +1,12 @@
+import { getHistoricalTeamMemberPage } from "./page";
+test("get historical team member page returns PagesRes without token", async () => {
+    const result = await getHistoricalTeamMemberPage("63c2807d669fa967f17f5559");
+    expect(result).toHaveProperty("data");
+    expect(result).toHaveProperty("page");
+    expect(result).toHaveProperty("perPage");
+    expect(result).toHaveProperty("totalNum");
+    expect(result).toHaveProperty("totalPages");
+    expect(Array.isArray(result.data)).toBe(true);
+    expect(typeof result.totalNum).toBe("number");
+    expect(typeof result.totalPages).toBe("number");
+});