@ccw-api/api 0.6.0 → 0.7.0

package/dist/types/types/userData.d.ts

@@ -0,0 +1,363 @@
+import { MongoDBId, CNameOssUrl } from "./api";
+import { ApprovalTag } from "./approval";
+import { AccountTypes } from "./account";
+export interface BaseUser {
+    avatar: CNameOssUrl;
+    name: string;
+    picUrl: CNameOssUrl;
+    virtualValue: CNameOssUrl;
+}
+export interface StudentSimple extends BaseUser {
+    bio: string;
+    oid: MongoDBId;
+}
+export interface Student extends StudentSimple {
+    approvedContent: null | string;
+    approvedType: null | string;
+    commentCount: number;
+    creationCount: number;
+    favoriteCount: number;
+    followerCount: number;
+    followingCount: number;
+    followingStatus: "UNFOLLOWED" | "FOLLOWED";
+    isSelf: boolean;
+    likeCount: number;
+    remixedCount: number;
+    viewCount: number;
+}
+export interface StudentOverview {
+    approvedContent: null | string;
+    approvedType: null | string;
+    avatar: CNameOssUrl;
+    bio: string;
+    commentCount: null | number;
+    creationCount: null | number;
+    favoriteCount: null | number;
+    followerCount: null | number;
+    followingCount: null | number;
+    followingStatus: null | "UNFOLLOWED" | "FOLLOWED" | "BOTH_FOLLOWED" | string;
+    isSelf: null | boolean;
+    likeCount: null | number;
+    name: string;
+    oid: MongoDBId;
+    picUrl: null | CNameOssUrl;
+    remixedCount: null | number;
+    viewCount: null | number;
+    virtualValue: null | CNameOssUrl;
+}
+export interface OtherUser extends BaseUser {
+    accountOid: MongoDBId;
+    accountType: AccountTypes;
+    approvalTagRelations: ApprovalTag[];
+    createdAt: number;
+    currentCreationPlaytime: null;
+    ext: {};
+    hideGender: boolean;
+    id: number;
+    status: "NORMAL";
+    updatedAt: number;
+    virtualValue: CNameOssUrl;
+}
+export type UserLabels = "POTENTIAL_CREATION";
+export interface ProfileExtraInfo {
+    hobbies: string;
+    learnedProgrammingLanguages: string;
+    programmingCapability: string;
+    selfIntroduction: string;
+}
+export interface MemberArchive {
+    accountOid: null | MongoDBId;
+    defaultEditor: string;
+    greatCreationOid: MongoDBId;
+    homepageCover: CNameOssUrl;
+}
+export interface ReputationScore {
+    rank: string;
+    score: number;
+    studentOid: MongoDBId;
+}
+export interface ProfileStatistics {
+    badgesCount: null | number;
+    homeworkCount: number;
+    likeHomeworkCount: number;
+}
+export interface ReputationScoreLog {
+    createdAt: number;
+    description: string;
+    id: number;
+    score: number;
+    studentOid: MongoDBId;
+}
+export interface StudentProfile extends BaseUser {
+    bio: string;
+    birthday: number;
+    category: string;
+    commentCount: number;
+    extraInfo: ProfileExtraInfo;
+    gender: string;
+    hideGender: boolean;
+    identityAuthRank: string;
+    lastLoginAt: number;
+    memberArchive: MemberArchive;
+    regChannel: null | string;
+    reputationScore: ReputationScore;
+    statistics: ProfileStatistics;
+    studentCreatedDays: number;
+    studentNumber: string;
+    studentOid: MongoDBId;
+}
+export interface ParentInfo {
+    acceptedCashInviteOnce: null | boolean;
+    alphaUser: null | boolean;
+    altName: null | string;
+    annualIncome: null | string;
+    archive: null | boolean;
+    authedTime: null | number;
+    avatar: null | CNameOssUrl;
+    bindPhone: string;
+    birthday: null | number;
+    cashInviteCreatedAt: null | number;
+    cashInviteRestartAt: null | number;
+    clazzDevice: null | string;
+    company: null | string;
+    countryCode: null | string;
+    createdAt: null | number;
+    degree: null | string;
+    distinctId: string;
+    divorced: null | boolean;
+    email: null | string;
+    ext: {};
+    followTeachers: object[];
+    fullName: null | string;
+    gender: null | string;
+    giftCardCampaign: null | string;
+    guestOid: null | MongoDBId;
+    idcard: null | string;
+    industry: null | string;
+    integer: null | number;
+    inviterableId: null | string;
+    inviterableType: null | string;
+    isEmployee: null | boolean;
+    jobPosition: null | string;
+    lastSubscribeAt: null | number;
+    mainContact: null | boolean;
+    name: null | string;
+    needSelectClazz: null | boolean;
+    oid: MongoDBId;
+    overseaExperience: null | boolean;
+    phoneAddr: null | string;
+    powerUser: null | boolean;
+    realName: null | string;
+    relationship: null | string;
+    remarkName: null | string;
+    rewardsCashesCount: null | number;
+    source: null | string;
+    sourceCategory: null | string;
+    sourceInfo: null | string;
+    status: null | string;
+    student: null | object;
+    studentOid: MongoDBId;
+    subscribe: null | boolean;
+    subscribeScene: null | string;
+    tags: null | string[];
+    telephone: string;
+    university: null | string;
+    updatedAt: null | number;
+    userTags: string[];
+    userType: null | string;
+    wechatAccount: null | string;
+    wechatCity: null | string;
+    wechatCountry: null | string;
+    wechatOpenid: null | string;
+    wechatProvince: null | string;
+    wechatUnionid: null | string;
+    wehubWxid: null | string;
+    wxid: null | string;
+}
+export interface CurrentParent {
+    bindPhone: string;
+    qqNickname: string;
+    qqNum: null | string;
+}
+export interface InfoModifyDate {
+    avatarModifiedAt: null | number;
+    nameModifiedAt: null | number;
+}
+export type StudentSelfDetailFields = "abGroup" | "accountNumber" | "address" | "age" | "avatar" | "bio" | "birthday" | "city" | "commentCount" | "countryCode" | "createdAt" | "currentParent" | "email" | "extraInfo" | "fullName" | "gender" | "grade" | "hideGender" | "host" | "identity" | "identityAuthRank" | "identityType" | "informationModifyDate" | "lastLoginAt" | "name" | "oid" | "parents" | "picUrl" | "province" | "qq" | "reputationScore" | "school" | "studentNumber" | "updatedAt" | "virtualValue";
+export interface StudentSelfDetail {
+    abGroup: null | string;
+    accountNumber: string;
+    address: null | string;
+    addressCode: null | string;
+    age: number;
+    archive: null | boolean;
+    avatar: CNameOssUrl;
+    bio: string;
+    birthYear: null | number;
+    birthday: number;
+    category: null | string;
+    city: null | string;
+    commentCount: number;
+    contactPhone: null | string;
+    countryCode: null | string;
+    createdAt: number;
+    currentMajorClazzOid: null | MongoDBId;
+    currentParent: CurrentParent;
+    distinctId: null | string;
+    district: null | string;
+    email: null | string;
+    energy: null | number;
+    energyRegain: null | number;
+    examScore: null | number;
+    extraInfo: ProfileExtraInfo;
+    firstTime: null | boolean;
+    followingStatus: null | string;
+    fullName: string;
+    gender: string;
+    grade: number;
+    group: null | string;
+    guest: null | boolean;
+    guestNumber: null | string;
+    hideGender: boolean;
+    host: string;
+    identity: string;
+    identityAuthRank: string;
+    identityType: string;
+    informationModifyDate: InfoModifyDate;
+    keywords: string[];
+    lastLoginAt: null | number;
+    lastStudyAt: null | number;
+    lowAge: null | boolean;
+    midexamScore: null | number;
+    miniprojectFreeNum: null | number;
+    mpClicked: null | boolean;
+    mpShowedModal: null | boolean;
+    mpTutorial: null | string;
+    name: string;
+    newWorkbenchTutorial: null | boolean;
+    oid: MongoDBId;
+    orgId: null | string;
+    parents: ParentInfo[];
+    passwordDigest: null | string;
+    photo: null | string;
+    picUrl: CNameOssUrl;
+    province: null | string;
+    qq: string;
+    receiver: null | string;
+    regChannel: null | string;
+    remarkName: null | string;
+    reputationScore: ReputationScore;
+    role: null | string;
+    school: string;
+    showServiceTerm: null | boolean;
+    showTaskList: null | boolean;
+    stats: null | object;
+    studentNumber: string;
+    task: null | object;
+    teacherUnreadedMessages: null | number;
+    tutorialSteps: null | string;
+    updatedAt: number;
+    validateSchool: null | boolean;
+    virtualValue: CNameOssUrl;
+    watchedMiniProjectTutorailVideo: null | boolean;
+    xiguaStudentNo: null | string;
+}
+export interface StudentListItem {
+    abGroup: null | string;
+    accountNumber: null | string;
+    address: null | string;
+    addressCode: null | string;
+    age: null | number;
+    archive: null | boolean;
+    avatar: CNameOssUrl;
+    bio: null | string;
+    birthYear: null | number;
+    birthday: null | number;
+    category: null | string;
+    city: null | string;
+    commentCount: null | number;
+    contactPhone: null | string;
+    countryCode: null | string;
+    createdAt: null | number;
+    currentMajorClazzOid: null | MongoDBId;
+    currentParent: null | object;
+    distinctId: null | string;
+    district: null | string;
+    email: null | string;
+    energy: null | number;
+    energyRegain: null | number;
+    examScore: null | number;
+    extraInfo: null | object;
+    firstTime: null | boolean;
+    followingStatus: null | string;
+    fullName: null | string;
+    gender: null | string;
+    grade: null | number;
+    group: null | string;
+    guest: null | boolean;
+    guestNumber: null | string;
+    hideGender: null | boolean;
+    host: null | string;
+    identity: null | string;
+    identityAuthRank: null | string;
+    identityType: null | string;
+    informationModifyDate: null | object;
+    keywords: string[];
+    lastLoginAt: null | number;
+    lastStudyAt: null | number;
+    lowAge: null | boolean;
+    midexamScore: null | number;
+    miniprojectFreeNum: null | number;
+    mpClicked: null | boolean;
+    mpShowedModal: null | boolean;
+    mpTutorial: null | string;
+    name: string;
+    newWorkbenchTutorial: null | boolean;
+    oid: MongoDBId;
+    orgId: null | string;
+    parents: object[];
+    passwordDigest: null | string;
+    photo: null | string;
+    picUrl: CNameOssUrl;
+    province: null | string;
+    qq: null | string;
+    receiver: null | string;
+    regChannel: null | string;
+    remarkName: null | string;
+    reputationScore: null | number;
+    role: null | string;
+    school: null | string;
+    showServiceTerm: null | boolean;
+    showTaskList: null | boolean;
+    stats: null | object;
+    studentNumber: string;
+    task: null | object;
+    teacherUnreadedMessages: null | number;
+    tutorialSteps: null | string;
+    updatedAt: null | number;
+    validateSchool: null | boolean;
+    virtualValue: CNameOssUrl;
+    watchedMiniProjectTutorailVideo: null | boolean;
+    xiguaStudentNo: null | string;
+}
+export interface CreatorScore {
+    rank: "ORDINARY" | "HACKER" | "ADVANCED";
+    rankRetentionDate: null;
+    score: number;
+    studentOid: MongoDBId;
+}
+export interface StudentFollowerStats {
+    followerCount: number;
+    followingCount: number;
+}
+export interface StudentUpdateReq {
+    birthday: number;
+    fullName: string;
+    gender: string;
+    hideGender: boolean;
+    hobbies: string;
+    learnedProgrammingLanguages: string;
+    programmingCapability: string;
+    qq: string;
+    school: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ccw-api/api",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "ccw api collections",
   "license": "MIT",
   "author": "Meng Fuzi",
@@ -26,7 +26,7 @@
     "test:dev": "jest --watch",
     "doc": "typedoc",
     "doc:dev": "typedoc --watch",
-    "build": "tsc --project tsconfig.node.json && tsc --project tsconfig.esm.json && tsc --project tsconfig.types.json"
+    "build": "tsc --project tsconfig.node.json && resolve-tspaths --project tsconfig.node.json --src ./src --out ./dist/node && tsc --project tsconfig.esm.json && resolve-tspaths --project tsconfig.esm.json --src ./src --out ./dist/esm && tsc --project tsconfig.types.json && resolve-tspaths --project tsconfig.types.json --src ./src --out ./dist/types"
   },
   "dependencies": {
     "@ccw-api/axios": "^3.0.0"
@@ -36,6 +36,7 @@
     "@types/node": "^26.0.1",
     "jest": "^30.4.2",
     "prettier-plugin-sort-members": "^0.2.4",
+    "resolve-tspaths": "^0.8.23",
     "ts-jest": "^29.4.11",
     "typedoc": "^0.28.19"
   }

package/dist/esm/bfs-web/extensions/{eid}/donate.test.js

@@ -1,4 +0,0 @@
-import { donateExtension } from "./donate";
-test("donate extension should fail without token", async () => {
-    await expect(donateExtension("spineAnimation", 1)).rejects.toThrow();
-});

package/dist/esm/bfs-web/users/{oid}/extensions.test.js

@@ -1,4 +0,0 @@
-import { getUserExtensions } from "./extensions";
-test("get user extensions should fail without token", async () => {
-    await expect(getUserExtensions("63c2807d669fa967f17f5559")).resolves.toHaveProperty("data");
-});

package/dist/esm/community-web/api/v1/short_code/shortcode.test.js

@@ -1,5 +0,0 @@
-import { encodeShortCode } from "./encode";
-test("test shortcode", async () => {
-    const res = await encodeShortCode("63c2807d669fa967f17f5559", "https://m.ccw.site/user_projects_assets/244373873/3fc7886d05aed9f369d2c0bb2d677fc0.jpeg", "孟夫子驾到", "6386e11cfc1ed14684de07f8");
-    expect(res.code).toHaveLength("yZdXmD3PvwVPA30W".length);
-});

package/dist/esm/community-web/approval/approval.test.js

@@ -1,5 +0,0 @@
-import { getApprovalTags } from "./list";
-test("test approval list", async () => {
-    const tags = await getApprovalTags("63c2807d669fa967f17f5559");
-    expect(tags.find((v) => v.approvalTagId == 235).approvalTagName).toEqual("Gandi 开发者");
-});

package/dist/esm/community-web/base/dateTime.test.js

@@ -1,6 +0,0 @@
-import { getTime } from "../base/dateTime";
-test("get time should return a number", async () => {
-    const time = await getTime();
-    expect(typeof time).toBe("number");
-    expect(time).toBeGreaterThan(0);
-});

package/dist/esm/community-web/campaign_resource/detail.test.js

@@ -1,10 +0,0 @@
-import { getCampaignResources } from "./detail";
-test("get campaign resources with tags keyword", async () => {
-    const res = await getCampaignResources("tags");
-    expect(res.keyword).toBe("tags");
-    expect(res.resourceType).toBe("SUBJECT_AREA");
-});
-test("get campaign resources with mmo keyword", async () => {
-    const res = await getCampaignResources("mmo");
-    expect(res.keyword).toBe("mmo");
-});

package/dist/esm/community-web/ccw-main/status.test.js

@@ -1,4 +0,0 @@
-import { getCCWMainStatus } from "./status";
-test("get ccw main status should fail without token", async () => {
-    await expect(getCCWMainStatus()).rejects.toThrow("token为空");
-});

package/dist/esm/community-web/ccw-mall/ccw/product/fe/query.test.js

@@ -1,8 +0,0 @@
-import { queryMallProducts } from "./query";
-test("query mall product page should fail without token", async () => {
-    await expect(queryMallProducts(7, {
-        page: 1,
-        perPage: 30,
-        sortType: "DESC",
-    })).rejects.toThrow();
-});

package/dist/esm/community-web/check_in_record/check_in_record.test.js

@@ -1,8 +0,0 @@
-import { getCheckInRecords } from "./detail";
-import { insertCheckInRecord } from "./insert";
-test("get check in records should fail without channel", async () => {
-    await expect(getCheckInRecords).rejects.toThrow("ccw axios Request failed: token为空(4001082401)");
-});
-test("insert check in record should fail without token", async () => {
-    await expect(insertCheckInRecord).rejects.toThrow("ccw axios Request failed: token为空(4001082401)");
-});

package/dist/esm/community-web/cloud_asset/search.test.js

@@ -1,6 +0,0 @@
-import { searchCloudAssets } from "./search";
-test("search cloud assets should fail without token", async () => {
-    const userId = "63c2807d669fa967f17f5559";
-    const path = "/23azZqHBnqj/";
-    await expect(searchCloudAssets(userId, path)).rejects.toThrow("ccw axios Request failed: token为空(4001082401)");
-});

package/dist/esm/community-web/cloud_asset/user/privacy.test.js

@@ -1,4 +0,0 @@
-import { getUserAssetStorageSize } from "./privacy";
-test("get user asset storage size should fail without token", async () => {
-    await expect(getUserAssetStorageSize()).rejects.toThrow("ccw axios Request failed: token为空");
-});

package/dist/esm/community-web/comment/create.test.js

@@ -1,13 +0,0 @@
-import { createComment } from "./create";
-import { getPostDetail } from "../post/detail";
-let samplePost;
-beforeAll(async () => {
-    samplePost = await getPostDetail("0173b23d-139d-4c48-ad98-0aa17b5d3b60");
-}, 30000);
-test("create comment should fail without token", async () => {
-    await expect(createComment("test", {
-        outline: "a",
-        subjectOid: samplePost.oid,
-        subjectType: "POST",
-    }, "COMMENT")).rejects.toThrow("token为空");
-});

package/dist/esm/community-web/comment/like_record/create.test.js

@@ -1,4 +0,0 @@
-import { likeComment } from "./create";
-test("like comment should fail without token", async () => {
-    await expect(likeComment(1)).rejects.toThrow("token为空");
-});

package/dist/esm/community-web/comment/page.test.js

@@ -1,15 +0,0 @@
-import { getCommentReplies } from "./page";
-test("get comment replies should return data", async () => {
-    const topicId = 819086;
-    const parentId = 9611280;
-    const statuses = ["PUBLISHED", "FOLDED"];
-    const res = await getCommentReplies(topicId, parentId, statuses);
-    expect(Array.isArray(res.data)).toBe(true);
-    res.data.forEach((comment) => {
-        expect(comment.id).toBeDefined();
-        expect(comment.topicId).toBe(topicId);
-        expect(comment.parentId).toBe(parentId);
-        expect(comment.content).toBeDefined();
-        expect(["PUBLISHED", "FOLDED"]).toContain(comment.status);
-    });
-});

package/dist/esm/community-web/comment/page_by_topic.test.js

@@ -1,13 +0,0 @@
-import { getCommentsByTopic } from "./page_by_topic";
-test("get comments by topic should return data", async () => {
-    const subjectOid = "6a3c73a3b6c84711978d92f2";
-    const subjectType = "POST";
-    const sectionType = "COMMENT";
-    const res = await getCommentsByTopic(subjectOid, subjectType, sectionType);
-    expect(Array.isArray(res.data)).toBe(true);
-    res.data.forEach((comment) => {
-        expect(comment.id).toBeDefined();
-        expect(comment.content).toBeDefined();
-        expect(["PUBLISHED", "FOLDED"]).toContain(comment.status);
-    });
-});

package/dist/esm/community-web/comment/reply.test.js

@@ -1,4 +0,0 @@
-import { replyComment } from "./reply";
-test("reply comment should fail without token", async () => {
-    await expect(replyComment("test reply", 1)).rejects.toThrow("token为空");
-});

package/dist/esm/community-web/config/detail.test.js

@@ -1,9 +0,0 @@
-import { getConfigDetail } from "./detail";
-test("get config detail returns value without token", async () => {
-    const result = await getConfigDetail("foo");
-    expect(result === null ||
-        typeof result === "string" ||
-        typeof result === "number" ||
-        typeof result === "boolean" ||
-        typeof result === "object").toBe(true);
-});

package/dist/esm/community-web/creation/detail.test.js

@@ -1,18 +0,0 @@
-import { getCreationDetail } from "./detail";
-import { getExcellentCreations } from "./excellent/list";
-let sampleCreationOid;
-beforeAll(async () => {
-    const creations = await getExcellentCreations(1);
-    if (creations.length > 0) {
-        sampleCreationOid = creations[0].oid;
-    }
-}, 30000);
-test("get creation detail should return data", async () => {
-    if (!sampleCreationOid) {
-        return;
-    }
-    const res = await getCreationDetail(sampleCreationOid, "");
-    expect(res.oid).toBe(sampleCreationOid);
-    expect(res.title).toBeDefined();
-    expect(res.student).toBeDefined();
-});

package/dist/esm/community-web/creation/excellent/list.test.js

@@ -1,10 +0,0 @@
-import { getExcellentCreations } from "./list";
-test("get excellent creations should return data", async () => {
-    const res = await getExcellentCreations(15);
-    expect(Array.isArray(res)).toBe(true);
-    res.forEach((c) => {
-        expect(c.oid).toBeDefined();
-        expect(c.title).toBeDefined();
-    });
-    expect(res).toHaveLength(15);
-});

package/dist/esm/community-web/creation/introduction/detail.test.js

@@ -1,17 +0,0 @@
-import { getCreationIntroduction } from "./detail";
-import { getExcellentCreations } from "../excellent/list";
-let sampleStudentOid;
-beforeAll(async () => {
-    const creations = await getExcellentCreations(1);
-    if (creations.length > 0) {
-        sampleStudentOid = creations[0].studentOid;
-    }
-}, 30000);
-test("get creation introduction should return data", async () => {
-    if (!sampleStudentOid) {
-        return;
-    }
-    const res = await getCreationIntroduction(sampleStudentOid);
-    expect(res.oid).toBeDefined();
-    expect(res.title).toBeDefined();
-});

package/dist/esm/community-web/creation/like/detail.test.js

@@ -1,19 +0,0 @@
-import { getLikeDetail } from "./detail";
-import { getExcellentCreations } from "../excellent/list";
-let sampleCreationOid;
-beforeAll(async () => {
-    const creations = await getExcellentCreations(1);
-    if (creations.length > 0) {
-        sampleCreationOid = creations[0].oid;
-    }
-}, 30000);
-test("get like detail should return data", async () => {
-    if (!sampleCreationOid) {
-        return;
-    }
-    const res = await getLikeDetail(sampleCreationOid);
-    if (res) {
-        expect(res.creationOid).toBe(sampleCreationOid);
-        expect(res.action).toBeDefined();
-    }
-});

package/dist/esm/community-web/creation/loading/tips.test.js

@@ -1,8 +0,0 @@
-import { getLoadingTips } from "./tips";
-test("get loading tips should return data", async () => {
-    const res = await getLoadingTips();
-    expect(res["小八"]).toBeDefined();
-    expect(res["胖达"]).toBeDefined();
-    expect(res["妮可"]).toBeDefined();
-    expect(res["孙小弟"]).toBeDefined();
-});

package/dist/esm/community-web/creation/own/page.test.js

@@ -1,4 +0,0 @@
-import { getOwnCreationPage } from "./page";
-test("get own creation page should fail without token", async () => {
-    await expect(getOwnCreationPage()).rejects.toThrow("token为空");
-});

package/dist/esm/community-web/creation/page.test.js

@@ -1,16 +0,0 @@
-import { getRemixedCreationPage } from "./page";
-import { getExcellentCreations } from "./excellent/list";
-let sampleCreationOid;
-beforeAll(async () => {
-    const creations = await getExcellentCreations(1);
-    if (creations.length > 0) {
-        sampleCreationOid = creations[0].oid;
-    }
-}, 30000);
-test("get creation page should return data", async () => {
-    if (!sampleCreationOid) {
-        return;
-    }
-    const res = await getRemixedCreationPage([sampleCreationOid]);
-    expect(Array.isArray(res.data)).toBe(true);
-});

package/dist/esm/community-web/creation/page_by_student.test.js

@@ -1,20 +0,0 @@
-import { getCreationsByStudent } from "./page_by_student";
-import { getExcellentCreations } from "./excellent/list";
-let sampleStudentOid;
-beforeAll(async () => {
-    const creations = await getExcellentCreations(1);
-    if (creations.length > 0) {
-        sampleStudentOid = creations[0].studentOid;
-    }
-}, 30000);
-test("get creations by student should return data", async () => {
-    if (!sampleStudentOid) {
-        return;
-    }
-    const res = await getCreationsByStudent([sampleStudentOid]);
-    expect(Array.isArray(res.data)).toBe(true);
-    res.data.forEach((c) => {
-        expect(c.oid).toBeDefined();
-        expect(c.studentOid).toBeDefined();
-    });
-});