@ccw-api/api 0.3.1 → 0.4.1

package/dist/types/community-web/approval/list.d.ts

@@ -0,0 +1,27 @@
+import { AccountTypes } from "types/account";
+import { CachedOssUrl, MongoDBId } from "types/api";
+import { ApprovalTag } from "types/approval";
+export type Req = {
+    objectId: MongoDBId;
+    objectType: AccountTypes;
+};
+export type Res<Tid extends number, Tn extends string> = ApprovalStatus<Tid, Tn>[];
+export type ApprovalStatus<Tid extends number, Tn extends string> = {
+    adorned: boolean;
+    approvalIconLink: CachedOssUrl;
+    approvalTag: ApprovalTag<Tid, Tn>;
+    approvalTagId: Tid;
+    approvalTagName: Tn;
+    createdAt: number;
+    id: number;
+    objectId: MongoDBId;
+    objectType: AccountTypes;
+    updatedAt: number;
+};
+export declare const url = "https://community-web.ccw.site/approval/list";
+/**
+ * 获取特定用户的勋章数据
+ * @param {MongoDBId} studentOid 用户id
+ * @returns {Promise<Res<Tid, Tn>>} 勋章数据
+ */
+export declare function getApprovalTags<Tid extends number = number, Tn extends string = string>(studentOid: MongoDBId): Promise<Res<Tid, Tn>>;

package/dist/types/community-web/base/dateTime.d.ts

@@ -0,0 +1,5 @@
+export declare const url = "https://community-web.ccw.site/base/dateTime";
+/**
+ * @returns {Promise<number>} 当前时间戳,相当于Date.now()
+ */
+export declare function getTime(): Promise<number>;

package/dist/types/community-web/campaign_resource/detail.d.ts

@@ -0,0 +1,17 @@
+export declare const url = "https://community-web.ccw.site/campaign_resource/detail";
+export type CampaignKeywords = "tags" | "mmo";
+export type Res<K extends string> = {
+    createdAt: number;
+    hiddenNavbar: false;
+    id: number;
+    keyword: K;
+    resourceIds: string[];
+    resourceType: "SUBJECT_AREA";
+    updatedAt: number;
+};
+/**
+ * 不知道这个接口有什么用,请查看https://www.ccw.site/pages/tags自行寻找用法
+ * @param {K} keyword 活动关键词
+ * @returns {Promise<Res<K>>}
+ */
+export declare function getCampaignResources<K extends CampaignKeywords>(keyword: K): Promise<Res<K>>;

package/dist/types/community-web/check_in_record/detail.d.ts

@@ -0,0 +1,14 @@
+export declare const url = "https://community-web.ccw.site/check_in_record/detail";
+export type Req = {
+    scene: "HOMEPAGE";
+};
+export type Res = {
+    checkInRecordResps: DailyRecord[];
+    checkInTimes: number;
+    todayIndex: number;
+};
+export interface DailyRecord {
+    bucks: number;
+    isCheckIn: boolean;
+}
+export declare function getCheckInRecords(): Promise<Res>;

package/dist/types/community-web/check_in_record/insert.d.ts

@@ -0,0 +1,10 @@
+export declare const url = "https://community-web.ccw.site/check_in_record/insert";
+export type Req = {
+    scene: "HOMEPAGE";
+};
+export type Res = boolean;
+/**
+ * 插入签到记录
+ * @returns {Promise<boolean>} 是否成功
+ */
+export declare function insertCheckInRecord(): Promise<Res>;

package/dist/types/community-web/cloud_asset/search.d.ts

@@ -0,0 +1,44 @@
+import { CachedOssUrl, MongoDBId } from "types/api";
+import { PagesRes, PageArgs } from "types/pages";
+export declare const url = "https://community-web.ccw.site/cloud_asset/search";
+export type SortField = "type" | "createdAt";
+export type Req = {
+    creatorOid: MongoDBId;
+    path: string;
+};
+export type Res = PagesRes<CloudAsset>;
+export interface CloudAsset {
+    categories: [];
+    /**
+     * 毫秒级时间戳
+     */
+    createdAt: number;
+    creatorOid: MongoDBId;
+    customizedInfo: null;
+    ext: {};
+    id: string;
+    keywords: [];
+    name: string;
+    /**
+     * @example "/23azZqHBnqj/2BzzTdi5I5C/2BzzTdi5I5w"
+     */
+    path: string;
+    previewImages: [CachedOssUrl];
+    size: number;
+    tags: [];
+    type: CloudAssetType;
+    updatedAt: number;
+    /**
+     * 素材直链
+     */
+    uri: CachedOssUrl;
+}
+export type CloudAssetType = "COSTUME" | "FOLDER" | "VIDEO" | "AUDIO";
+/**
+ *
+ * @param {MongoDBId} creatorOid 用户id
+ * @param {string} path 目录(例如'/23azZqHBnqj/2BzzTdi5I5C/')
+ * @param {Partial<PageArgs>} pageArgs_ 分页参数
+ * @returns {Promise<CloudAsset[]>} 目录内的素材
+ */
+export declare function searchCloudAssets(creatorOid: MongoDBId, path?: string, pageArgs_?: Partial<PageArgs<SortField>>): Promise<CloudAsset[]>;

package/dist/types/community-web/cloud_asset/user/privacy.d.ts

@@ -0,0 +1,14 @@
+export declare const url = "https://community-web.ccw.site/cloud_asset/user/privacy";
+export type Req = {};
+export type Res = {
+    /**
+     * @example 100MB: "104857600"
+     */
+    totalStorage: string;
+    usedStorage: string;
+};
+/**
+ * 获取用户云存储空间信息
+ * @returns {Promise<Res>} 存储空间信息
+ */
+export declare function getUserAssetStorageSize(): Promise<Res>;

package/dist/types/community-web/comment/page.d.ts

@@ -0,0 +1,19 @@
+import { PagesRes, PageArgs } from "types/pages";
+import { Comment } from "types/comment";
+export declare const url = "https://community-web.ccw.site/comment/page";
+export type SortField = null;
+export type Req = {
+    topicId: number;
+    parentId: number;
+    statuses: ("PUBLISHED" | "FOLDED")[];
+};
+export type Res = PagesRes<Comment>;
+/**
+ * 根据topicId获取评论的回复
+ * @param {number} topicId 话题id
+ * @param {number} parentId 父评论id
+ * @param {("PUBLISHED" | "FOLDED")[]} statuses 状态过滤
+ * @param {Partial<PageArgs<SortField>>} pageArgs_ 分页参数
+ * @returns {Promise<Comment[]>} 评论列表
+ */
+export declare function getCommentReplies(topicId: number, parentId: number, statuses?: ("PUBLISHED" | "FOLDED")[], pageArgs_?: Partial<PageArgs<SortField>>): Promise<Comment[]>;

package/dist/types/community-web/comment/page_by_topic.d.ts

@@ -0,0 +1,19 @@
+import { PagesRes, PageArgs } from "types/pages";
+import { Comment, SectionType, SubjectType } from "types/comment";
+export declare const url = "https://community-web.ccw.site/comment/page_by_topic";
+export type SortField = "createdAt" | "likes";
+export type Req = {
+    subjectOid: string;
+    subjectType: string;
+    sectionType: SectionType;
+};
+export type Res = PagesRes<Comment>;
+/**
+ * 根据主题获取评论列表
+ * @param {string} subjectOid 主题oid
+ * @param {SubjectType} subjectType 主题类型 (如: "POST")
+ * @param {string} sectionType 区块类型 (如: "COMMENT")
+ * @param {Partial<PageArgs<SortField>>} pageArgs_ 分页参数
+ * @returns {Promise<Comment[]>} 评论列表
+ */
+export declare function getCommentsByTopic(subjectOid: string, subjectType: SubjectType, sectionType: SectionType, pageArgs_?: Partial<PageArgs<SortField>>): Promise<Comment[]>;

package/dist/types/community-web/config/detail.d.ts

@@ -0,0 +1,11 @@
+export declare const url = "https://community-web.ccw.site/config/detail";
+export type Req = {
+    key: string;
+};
+export type Res = string | number | boolean | null | object;
+/**
+ * 获取配置详情
+ * @param {string} key 配置键
+ * @returns {Promise<Res>} 配置值
+ */
+export declare function getConfigDetail(key: string): Promise<Res>;

package/dist/types/community-web/creation/detail.d.ts

@@ -0,0 +1,15 @@
+import { MongoDBId } from "types/api";
+import { Creation } from "types/creation";
+export declare const url = "https://community-web.ccw.site/creation/detail";
+export type Req = {
+    oid: MongoDBId;
+    accessKey: string;
+};
+export type Res = Creation;
+/**
+ * 获取作品详情
+ * @param {MongoDBId} oid 作品id
+ * @param {string} accessKey
+ * @returns {Promise<Creation>} 作品详情
+ */
+export declare function getCreationDetail(oid: MongoDBId, accessKey: string): Promise<Res>;

package/dist/types/community-web/creation/excellent/list.d.ts

@@ -0,0 +1,12 @@
+import { CreationSimple } from "types/creation";
+export declare const url = "https://community-web.ccw.site/creation/excellent/list";
+export type Req = {
+    num: number;
+};
+export type Res = CreationSimple[];
+/**
+ * 获取精选作品列表
+ * @param {number} num 数量
+ * @returns {Promise<CreationSimple[]>} 作品列表
+ */
+export declare function getExcellentCreations(num: number): Promise<Res>;

package/dist/types/community-web/creation/introduction/detail.d.ts

@@ -0,0 +1,13 @@
+import { MongoDBId } from "types/api";
+import { Creation } from "types/creation";
+export declare const url = "https://community-web.ccw.site/creation/introduction/detail";
+export type Req = {
+    studentOid: MongoDBId;
+};
+export type Res = Creation;
+/**
+ * 获取用户代表作
+ * @param {MongoDBId} studentOid 学生id
+ * @returns {Promise<Creation>} 作品详情
+ */
+export declare function getCreationIntroduction(studentOid: MongoDBId): Promise<Res>;

package/dist/types/community-web/creation/like/detail.d.ts

@@ -0,0 +1,13 @@
+import { MongoDBId } from "types/api";
+import { UserLikeDetail } from "types/creation";
+export declare const url = "https://community-web.ccw.site/creation/like/detail";
+export type Req = {
+    creationOid: MongoDBId;
+};
+export type Res = UserLikeDetail;
+/**
+ * 获取用户是否曾给作品点赞及点赞动作
+ * @param {MongoDBId} creationOid 作品id
+ * @returns {Promise<UserLikeDetail>} 点赞详情
+ */
+export declare function getLikeDetail(creationOid: MongoDBId): Promise<Res>;

package/dist/types/community-web/creation/loading/tips.d.ts

@@ -0,0 +1,9 @@
+import { LoadingTip } from "types/creation";
+export declare const url = "https://community-web.ccw.site/creation/loading/tips";
+export type Req = {};
+export type Res = LoadingTip;
+/**
+ * 获取加载提示语
+ * @returns {Promise<LoadingTip>} 加载提示语
+ */
+export declare function getLoadingTips(): Promise<Res>;

package/dist/types/community-web/creation/page.d.ts

@@ -0,0 +1,16 @@
+import { MongoDBId } from "types/api";
+import { PagesRes, PageArgs } from "types/pages";
+import { CreationSimple } from "types/creation";
+export declare const url = "https://community-web.ccw.site/creation/page";
+export type SortField = "createdAt" | "likeCount" | "viewCount" | "updatedAt" | "commentCount";
+export type Req = {
+    remixCreationOids: MongoDBId[];
+};
+export type Res = PagesRes<CreationSimple>;
+/**
+ * 根据原作品id获取改编作品分页列表
+ * @param {MongoDBId[]} remixCreationOids 原作品id列表
+ * @param {Partial<PageArgs<SortField>>} pageArgs_ 分页参数
+ * @returns {Promise<CreationSimple[]>} 改编作品列表
+ */
+export declare function getCreationPage(remixCreationOids: MongoDBId[], pageArgs_?: Partial<PageArgs<SortField>>): Promise<CreationSimple[]>;

package/dist/types/community-web/creation/page_by_student.d.ts

@@ -0,0 +1,16 @@
+import { MongoDBId } from "types/api";
+import { PagesRes, PageArgs } from "types/pages";
+import { Creation } from "types/creation";
+export declare const url = "https://community-web.ccw.site/creation/page_by_student";
+export type SortField = "createdAt" | "likeCount" | "viewCount";
+export type Req = {
+    studentOids: MongoDBId[];
+};
+export type Res = PagesRes<Creation>;
+/**
+ * 获取学生的作品列表
+ * @param {MongoDBId[]} studentOids 学生id列表
+ * @param {Partial<PageArgs<SortField>>} pageArgs_ 分页参数
+ * @returns {Promise<Creation[]>} 作品列表
+ */
+export declare function getCreationsByStudent(studentOids: MongoDBId[], pageArgs_?: Partial<PageArgs<SortField>>): Promise<Creation[]>;

package/dist/types/community-web/creation/potential/list.d.ts

@@ -0,0 +1,12 @@
+import { CreationSimple } from "types/creation";
+export declare const url = "https://community-web.ccw.site/creation/potential/list";
+export type Req = {
+    num: number;
+};
+export type Res = CreationSimple[];
+/**
+ * 获取潜力作品列表
+ * @param {number} num 数量
+ * @returns {Promise<CreationSimple[]>} 作品列表
+ */
+export declare function getPotentialCreations(num: number): Promise<Res>;

package/dist/types/community-web/creation/recommend.d.ts

@@ -0,0 +1,15 @@
+import { PagesRes, PageArgs } from "types/pages";
+import { CreationSimple } from "types/creation";
+export declare const url = "https://community-web.ccw.site/creation/recommend";
+export type SortField = "createdAt" | "likeCount" | "viewCount";
+export type Req = {
+    num: number;
+    subjectType: "POTENTIAL";
+};
+export type Res = PagesRes<CreationSimple>;
+/**
+ * 获取推荐作品列表
+ * @param {Partial<PageArgs<SortField>>} pageArgs_ 分页参数
+ * @returns {Promise<CreationSimple[]>} 作品列表
+ */
+export declare function getRecommendCreations(num: number, pageArgs_?: Partial<PageArgs<SortField>>): Promise<CreationSimple[]>;

package/dist/types/community-web/creation/search/page.d.ts

@@ -0,0 +1,15 @@
+import { PagesRes, PageArgs } from "types/pages";
+import { CreationSimple } from "types/creation";
+export declare const url = "https://community-web.ccw.site/creation/search/page";
+export type SortField = "createdAt" | "likeCount" | "viewCount";
+export type Req = {
+    tag: string;
+};
+export type Res = PagesRes<CreationSimple>;
+/**
+ * 按标签搜索作品
+ * @param {string} tag 标签 例如:游戏 动画故事 角色扮演
+ * @param {Partial<PageArgs<SortField>>} pageArgs_ 分页参数
+ * @returns {Promise<CreationSimple[]>} 作品列表
+ */
+export declare function searchCreationsByTag(tag: string, pageArgs_?: Partial<PageArgs<SortField>>): Promise<CreationSimple[]>;

package/dist/types/community-web/creation/student/detail.d.ts

@@ -0,0 +1,13 @@
+import { MongoDBId } from "types/api";
+import { Student } from "types/userData";
+export declare const url = "https://community-web.ccw.site/creation/student/detail";
+export type Req = {
+    studentOid: MongoDBId;
+};
+export type Res = Student;
+/**
+ * 获取学生详情
+ * @param {MongoDBId} studentOid 学生id
+ * @returns {Promise<Student>} 学生详情
+ */
+export declare function getCreationStudentDetail(studentOid: MongoDBId): Promise<Res>;

package/dist/types/community-web/creation/tag/list.d.ts

@@ -0,0 +1,11 @@
+import { CreationTag } from "types/creation";
+export declare const url = "https://community-web.ccw.site/creation/tag/list";
+export type Req = {
+    visibility: "PUBLIC";
+};
+export type Res = CreationTag[];
+/**
+ * 获取作品标签列表 例如 https://www.ccw.site/pages/tags/anime
+ * @returns {Promise<CreationTag[]>} 标签列表
+ */
+export declare function getCreationTags(): Promise<Res>;

package/dist/types/community-web/index.d.ts

@@ -0,0 +1,50 @@
+import { encodeShortCode } from "./api/v1/short_code/encode";
+import { getApprovalTags } from "./approval/list";
+import { getTime } from "./base/dateTime";
+import { getCampaignResources } from "./campaign_resource/detail";
+import { getCheckInRecords } from "./check_in_record/detail";
+import { insertCheckInRecord } from "./check_in_record/insert";
+import { getUserAssetStorageSize } from "./cloud_asset/user/privacy";
+import { searchCloudAssets } from "./cloud_asset/search";
+import { getCommentReplies } from "./comment/page";
+import { getCommentsByTopic } from "./comment/page_by_topic";
+import { getConfigDetail } from "./config/detail";
+import { getCreationDetail } from "./creation/detail";
+import { getExcellentCreations } from "./creation/excellent/list";
+import { getCreationIntroduction } from "./creation/introduction/detail";
+import { getLikeDetail } from "./creation/like/detail";
+import { getLoadingTips } from "./creation/loading/tips";
+import { getCreationPage } from "./creation/page";
+import { getCreationsByStudent } from "./creation/page_by_student";
+import { getPotentialCreations } from "./creation/potential/list";
+import { getRecommendCreations } from "./creation/recommend";
+import { searchCreationsByTag } from "./creation/search/page";
+import { getCreationStudentDetail } from "./creation/student/detail";
+import { getCreationTags } from "./creation/tag/list";
+import { createShortUrl } from "./short_url/create";
+export declare const communityWeb: {
+    encodeShortCode: typeof encodeShortCode;
+    createShortUrl: typeof createShortUrl;
+    getApprovalTags: typeof getApprovalTags;
+    getCampaignResources: typeof getCampaignResources;
+    getCheckInRecords: typeof getCheckInRecords;
+    getCommentReplies: typeof getCommentReplies;
+    getCommentsByTopic: typeof getCommentsByTopic;
+    getConfigDetail: typeof getConfigDetail;
+    getCreationDetail: typeof getCreationDetail;
+    getCreationIntroduction: typeof getCreationIntroduction;
+    getCreationPage: typeof getCreationPage;
+    getCreationStudentDetail: typeof getCreationStudentDetail;
+    getCreationTags: typeof getCreationTags;
+    getCreationsByStudent: typeof getCreationsByStudent;
+    getExcellentCreations: typeof getExcellentCreations;
+    getLikeDetail: typeof getLikeDetail;
+    getLoadingTips: typeof getLoadingTips;
+    getPotentialCreations: typeof getPotentialCreations;
+    getRecommendCreations: typeof getRecommendCreations;
+    getUserAssetStorageSize: typeof getUserAssetStorageSize;
+    insertCheckInRecord: typeof insertCheckInRecord;
+    searchCloudAssets: typeof searchCloudAssets;
+    searchCreationsByTag: typeof searchCreationsByTag;
+    getTime: typeof getTime;
+};

package/dist/types/community-web/short_url/create.d.ts

@@ -0,0 +1,11 @@
+export declare const url = "https://community-web.ccw.site/short_url/create";
+export type Req = {
+    originUrl: string;
+};
+export type Res = `https://ccw.site/s/${string}`;
+/**
+ * 创建短链接(用于分享)
+ * @param originUrl 原链接
+ * @returns {Promise<Res>} 创建的短链接
+ */
+export declare function createShortUrl(originUrl: string): Promise<Res>;

package/dist/types/index.d.ts

@@ -0,0 +1,37 @@
+import { sso } from "./sso/index";
+import { communityWeb } from "./community-web";
+export { sso, communityWeb };
+declare const _default: {
+    sso: {
+        loginByPassword: typeof import("./sso/web/auth/login-by-password").loginByPassword;
+        logout: typeof import("./sso/web/auth/logout").logout;
+        logoutBySession: typeof import("./sso/web/auth/logout_by_session").logoutBySession;
+    };
+    communityWeb: {
+        encodeShortCode: typeof import("./community-web/api/v1/short_code/encode").encodeShortCode;
+        createShortUrl: typeof import("./community-web/short_url/create").createShortUrl;
+        getApprovalTags: typeof import("./community-web/approval/list").getApprovalTags;
+        getCampaignResources: typeof import("./community-web/campaign_resource/detail").getCampaignResources;
+        getCheckInRecords: typeof import("./community-web/check_in_record/detail").getCheckInRecords;
+        getCommentReplies: typeof import("./community-web/comment/page").getCommentReplies;
+        getCommentsByTopic: typeof import("./community-web/comment/page_by_topic").getCommentsByTopic;
+        getConfigDetail: typeof import("./community-web/config/detail").getConfigDetail;
+        getCreationDetail: typeof import("./community-web/creation/detail").getCreationDetail;
+        getCreationIntroduction: typeof import("./community-web/creation/introduction/detail").getCreationIntroduction;
+        getCreationPage: typeof import("./community-web/creation/page").getCreationPage;
+        getCreationStudentDetail: typeof import("./community-web/creation/student/detail").getCreationStudentDetail;
+        getCreationTags: typeof import("./community-web/creation/tag/list").getCreationTags;
+        getCreationsByStudent: typeof import("./community-web/creation/page_by_student").getCreationsByStudent;
+        getExcellentCreations: typeof import("./community-web/creation/excellent/list").getExcellentCreations;
+        getLikeDetail: typeof import("./community-web/creation/like/detail").getLikeDetail;
+        getLoadingTips: typeof import("./community-web/creation/loading/tips").getLoadingTips;
+        getPotentialCreations: typeof import("./community-web/creation/potential/list").getPotentialCreations;
+        getRecommendCreations: typeof import("./community-web/creation/recommend").getRecommendCreations;
+        getUserAssetStorageSize: typeof import("./community-web/cloud_asset/user/privacy").getUserAssetStorageSize;
+        insertCheckInRecord: typeof import("./community-web/check_in_record/insert").insertCheckInRecord;
+        searchCloudAssets: typeof import("./community-web/cloud_asset/search").searchCloudAssets;
+        searchCreationsByTag: typeof import("./community-web/creation/search/page").searchCreationsByTag;
+        getTime: typeof import("./community-web/base/dateTime").getTime;
+    };
+};
+export default _default;

package/dist/types/queryPages.d.ts

@@ -0,0 +1,9 @@
+import { PageArgs } from "types/pages";
+/**
+ * 生成ccw分页查询url
+ * @param url_ 分页查询api
+ * @param {PageArgs} pageArgs 分页参数
+ * @returns 生成的实际查询url
+ */
+export declare function queryPage<SortField extends string>(url_: string, pageArgs: PageArgs<SortField>): string;
+export declare const DEFAULT_PAGE_ARGS: PageArgs<string>;

package/dist/types/src/bfs-web/extensions/{eid}/donate.d.ts

@@ -0,0 +1,13 @@
+export declare const url = "https://bfs-web.ccw.site/extensions";
+export type Req = {
+    bucks: number;
+    eid: string;
+};
+export type Res = boolean;
+/**
+ * 向扩展投币
+ * @param {ExtensionDonateEid} eid 扩展id
+ * @param {number} bucks 捐赠金币数量
+ * @returns {Promise<Res>} 是否捐赠成功
+ */
+export declare function donateExtension(eid: string, bucks: number): Promise<Res>;

package/dist/types/src/bfs-web/index.d.ts

@@ -0,0 +1,6 @@
+import { getUserExtensions } from "./users/{oid}/extensions";
+import { donateExtension } from "./extensions/{eid}/donate";
+export declare const bfsWeb: {
+    donateExtension: typeof donateExtension;
+    getUserExtensions: typeof getUserExtensions;
+};

package/dist/types/src/bfs-web/users/{oid}/extensions.d.ts

@@ -0,0 +1,12 @@
+import { MongoDBId } from "types/api";
+import { Extension } from "types/extensions";
+import { PagesRes, PageArgs } from "types/pages";
+export declare const url = "https://bfs-web.ccw.site/users";
+export type Res = PagesRes<Extension>;
+/**
+ * 获取用户扩展列表分页
+ * @param {MongoDBId} userOid 用户id
+ * @param {Partial<PageArgs<"createdAt" | "updatedAt" | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 扩展分页列表
+ */
+export declare function getUserExtensions<T extends string>(userOid: MongoDBId, pageArgs_?: Partial<PageArgs<"createdAt" | "updatedAt" | T>>): Promise<Res>;

package/dist/types/src/community-web/api/v1/short_code/encode.d.ts

@@ -0,0 +1,42 @@
+import { AccountTypes } from "types/account";
+import { CNameOssUrl, MongoDBId } from "types/api";
+export declare const url = "https://community-web.ccw.site/api/v1/short_code/encode";
+export type Req = {
+    origin: {
+        inviterId: MongoDBId;
+        inviterType: AccountTypes;
+        entrance: "create_detail";
+        inviterName: string;
+        inviterAvatar: CNameOssUrl;
+        creationOid: MongoDBId;
+    };
+};
+export type Res = {
+    /**
+     * 获取的inviteCode码
+     */
+    code: string;
+    createdAt: number;
+    ext: null;
+    id: number;
+    origin: {
+        inviterAvatar: string;
+        inviterId: MongoDBId;
+        entrance: "create_detail";
+        creationOid: MongoDBId;
+        inviterName: string;
+        inviterType: AccountTypes;
+    };
+    status: null;
+    type: "SHORT_CODE";
+    updatedAt: number;
+};
+/**
+ * 生成作品邀请码
+ * @param {MongoDBId} inviterId 邀请人id
+ * @param {CNameOssUrl} inviterAvatar 邀请人头像
+ * @param {string} inviterName 邀请人用户名
+ * @param {MongoDBId} creationOid 作品id
+ * @returns {Promise<Res>}
+ */
+export declare function encodeShortCode(inviterId: MongoDBId, inviterAvatar: CNameOssUrl, inviterName: string, creationOid: MongoDBId): Promise<Res>;

package/dist/types/src/community-web/approval/list.d.ts

@@ -0,0 +1,27 @@
+import { AccountTypes } from "types/account";
+import { CNameOssUrl, MongoDBId } from "types/api";
+import { ApprovalTag } from "types/approval";
+export type Req = {
+    objectId: MongoDBId;
+    objectType: AccountTypes;
+};
+export type Res<Tid extends number, Tn extends string> = ApprovalStatus<Tid, Tn>[];
+export type ApprovalStatus<Tid extends number, Tn extends string> = {
+    adorned: boolean;
+    approvalIconLink: CNameOssUrl;
+    approvalTag: ApprovalTag<Tid, Tn>;
+    approvalTagId: Tid;
+    approvalTagName: Tn;
+    createdAt: number;
+    id: number;
+    objectId: MongoDBId;
+    objectType: AccountTypes;
+    updatedAt: number;
+};
+export declare const url = "https://community-web.ccw.site/approval/list";
+/**
+ * 获取特定用户的勋章数据
+ * @param {MongoDBId} studentOid 用户id
+ * @returns {Promise<Res<Tid, Tn>>} 勋章数据
+ */
+export declare function getApprovalTags<Tid extends number = number, Tn extends string = string>(studentOid: MongoDBId): Promise<Res<Tid, Tn>>;

package/dist/types/src/community-web/base/dateTime.d.ts

@@ -0,0 +1,5 @@
+export declare const url = "https://community-web.ccw.site/base/dateTime";
+/**
+ * @returns {Promise<number>} 当前时间戳,相当于Date.now()
+ */
+export declare function getTime(): Promise<number>;

package/dist/types/src/community-web/campaign_resource/detail.d.ts

@@ -0,0 +1,17 @@
+export declare const url = "https://community-web.ccw.site/campaign_resource/detail";
+export type CampaignKeywords = "tags" | "mmo";
+export type Res<K extends string> = {
+    createdAt: number;
+    hiddenNavbar: false;
+    id: number;
+    keyword: K;
+    resourceIds: string[];
+    resourceType: "SUBJECT_AREA";
+    updatedAt: number;
+};
+/**
+ * 不知道这个接口有什么用,请查看https://www.ccw.site/pages/tags自行寻找用法
+ * @param {K} keyword 活动关键词
+ * @returns {Promise<Res<K>>}
+ */
+export declare function getCampaignResources<K extends CampaignKeywords>(keyword: K): Promise<Res<K>>;

package/dist/types/src/community-web/ccw-main/status.d.ts

@@ -0,0 +1,11 @@
+export declare const url = "https://community-web.ccw.site/ccw-main/status";
+export type Req = {};
+export type Res = {
+    data: string;
+    datetime: string;
+};
+/**
+ * ccw-main/status
+ * @returns {Promise<Res>} 信息
+ */
+export declare function getCCWMainStatus(): Promise<Res>;