@ccw-api/api 0.4.0 → 0.4.2

package/dist/node/src/queryPages.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_PAGE_ARGS = void 0;
-exports.queryPage = queryPage;
-/**
- * 生成ccw分页查询url
- * @param url_ 分页查询api
- * @param {PageArgs<SortField>} pageArgs 分页参数
- * @returns 生成的实际查询url
- */
-function queryPage(url_, pageArgs) {
-    const url = new URL(url_);
-    Object.entries(pageArgs).forEach(([k, v]) => {
-        if (v == null) {
-            return;
-        }
-        url.searchParams.set(k, v);
-    });
-    return url.toString();
-}
-exports.DEFAULT_PAGE_ARGS = {
-    page: 1,
-    perPage: 20,
-    sortType: "DESC",
-    sortField: "",
-};

package/dist/node/src/sso/index.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sso = void 0;
-const login_by_password_1 = require("./web/auth/login-by-password");
-const logout_1 = require("./web/auth/logout");
-const logout_by_session_1 = require("./web/auth/logout_by_session");
-exports.sso = {
-    loginByPassword: login_by_password_1.loginByPassword,
-    logout: logout_1.logout,
-    logoutBySession: logout_by_session_1.logoutBySession,
-};

package/dist/node/src/sso/web/auth/auth.test.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const login_by_password_1 = require("./login-by-password");
-const logout_1 = require("./logout");
-const logout_by_session_1 = require("./logout_by_session");
-test("expect wrong password to be error", async () => {
-    await expect(async () => await (0, login_by_password_1.loginByPassword)("abc", "foo", {
-        device: "test",
-        browser: "test",
-    })).rejects.toThrow("ccw axios Request failed: 账号或密码错误(4001092401)");
-});
-test("expect logout to be error when no token", async () => {
-    await expect(logout_1.logout).rejects.toThrow("ccw axios Request failed: token不能为空(4001092X01)");
-});
-test("expect logout-by-session to be error when not logged in", async () => {
-    await expect(async () => await (0, logout_by_session_1.logoutBySession)(1145)).rejects.toThrow("ccw axios Request failed: 用户未登录(4001092401)");
-});

package/dist/node/src/sso/web/auth/login-by-password.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.loginByPassword = loginByPassword;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://sso.ccw.site/web/auth/login-by-password";
-/**
- * 通过密码登录
- * @param {string} loginKey 用户名
- * @param {string} password 密码
- * @param {ReqExtra} reqExtra 额外信息
- * @returns {Res<Extra>}
- */
-async function loginByPassword(loginKey, password, reqExtra = {
-    device: "Node",
-    browser: "Node.js",
-}) {
-    const { extra, ...restBody } = await axios_1.ccwAxios
-        .post(exports.url, {
-        loginKey,
-        password,
-        clientCode: "STUDY_COMMUNITY",
-        extra: JSON.stringify({ ...reqExtra, scene: null }),
-    })
-        .then((res) => res.data.body);
-    const resExtra = JSON.parse(extra);
-    return {
-        ...restBody,
-        extra: resExtra,
-    };
-}

package/dist/node/src/sso/web/auth/logout.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.logout = logout;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://sso.ccw.site/web/auth/logout";
-/**
- * 退出
- * @returns {Promise<null>}
- */
-async function logout() {
-    return await axios_1.ccwAxios
-        .post(exports.url, {})
-        .then((res) => res.data.body);
-}

package/dist/node/src/sso/web/auth/logout_by_session.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.logoutBySession = logoutBySession;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://sso.ccw.site/web/auth/logout_by_session";
-/**
- * 根据sessionId退出登陆设备
- * @param {number} sessionId
- * @returns {Promise<boolean>} 是否成功
- */
-async function logoutBySession(sessionId) {
-    return await axios_1.ccwAxios
-        .post(exports.url, { id: sessionId })
-        .then((res) => res.data.body);
-}

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

@@ -1,42 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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/check_in_record/detail.d.ts

@@ -1,17 +0,0 @@
-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/src/community-web/check_in_record/insert.d.ts

@@ -1,10 +0,0 @@
-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/src/community-web/cloud_asset/search.d.ts

@@ -1,44 +0,0 @@
-import { CNameOssUrl, 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: [CNameOssUrl];
-    size: number;
-    tags: [];
-    type: CloudAssetType;
-    updatedAt: number;
-    /**
-     * 素材直链
-     */
-    uri: CNameOssUrl;
-}
-export type CloudAssetType = "COSTUME" | "FOLDER" | "VIDEO" | "AUDIO";
-/**
- * 获取用户云背包特定目录内素材
- * @param {MongoDBId} creatorOid 用户id
- * @param {string} path 目录(例如'/23azZqHBnqj/2BzzTdi5I5C/')
- * @param {Partial<PageArgs<SortField | T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 目录内的素材分页结果
- */
-export declare function searchCloudAssets<T extends string>(creatorOid: MongoDBId, path?: string, pageArgs_?: Partial<PageArgs<SortField | T>>): Promise<Res>;

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

@@ -1,14 +0,0 @@
-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/src/community-web/comment/page.d.ts

@@ -1,19 +0,0 @@
-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 = "createdAt";
-export type Req = {
-    parentId: number;
-    statuses: ("PUBLISHED" | "FOLDED")[];
-    topicId: number;
-};
-export type Res = PagesRes<Comment>;
-/**
- * 根据topicId获取评论的回复
- * @param {number} topicId 话题id
- * @param {number} parentId 父评论id
- * @param {("PUBLISHED" | "FOLDED")[]} statuses 状态过滤
- * @param {Partial<PageArgs<SortField|T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 评论分页结果
- */
-export declare function getCommentReplies<T extends string>(topicId: number, parentId: number, statuses?: ("PUBLISHED" | "FOLDED")[], pageArgs_?: Partial<PageArgs<SortField | T>>): Promise<Res>;

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

@@ -1,19 +0,0 @@
-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| T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 评论分页结果
- */
-export declare function getCommentsByTopic<T extends string>(subjectOid: string, subjectType: SubjectType, sectionType: SectionType, pageArgs_?: Partial<PageArgs<SortField | T>>): Promise<Res>;

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

@@ -1,11 +0,0 @@
-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/src/community-web/creation/detail.d.ts

@@ -1,15 +0,0 @@
-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/src/community-web/creation/excellent/list.d.ts

@@ -1,12 +0,0 @@
-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/src/community-web/creation/introduction/detail.d.ts

@@ -1,13 +0,0 @@
-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/src/community-web/creation/like/detail.d.ts

@@ -1,13 +0,0 @@
-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/src/community-web/creation/loading/tips.d.ts

@@ -1,9 +0,0 @@
-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/src/community-web/creation/page.d.ts

@@ -1,16 +0,0 @@
-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[]} originCreationOids 原作品id列表
- * @param {Partial<PageArgs<SortField | T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 改编作品分页结果
- */
-export declare function getRemixedCreationPage<T extends string>(originCreationOids: MongoDBId[], pageArgs_?: Partial<PageArgs<SortField | T>>): Promise<Res>;

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

@@ -1,16 +0,0 @@
-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|T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 作品分页结果
- */
-export declare function getCreationsByStudent<T extends string>(studentOids: MongoDBId[], pageArgs_?: Partial<PageArgs<SortField | T>>): Promise<Res>;

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

@@ -1,12 +0,0 @@
-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/src/community-web/creation/recommend.d.ts

@@ -1,15 +0,0 @@
-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 | T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 作品分页结果
- */
-export declare function getRecommendCreations<T extends string>(num: number, pageArgs_?: Partial<PageArgs<SortField | T>>): Promise<Res>;

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

@@ -1,17 +0,0 @@
-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 = {
-    oids?: string[];
-    tag?: string;
-};
-export type Res = PagesRes<CreationSimple>;
-/**
- * 搜索作品
- * @param {string} req.tag 标签 例如:游戏 动画故事 角色扮演 kukeChat
- * @param {string[]} req.oids 作品id列表
- * @param {Partial<PageArgs<SortField | T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 作品分页结果
- */
-export declare function searchCreationsByTag<T extends string>(req: Req, pageArgs_?: Partial<PageArgs<SortField | T>>): Promise<Res>;

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

@@ -1,13 +0,0 @@
-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/src/community-web/creation/tag/list.d.ts

@@ -1,11 +0,0 @@
-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>;