@ccw-api/api 0.3.1 → 0.4.1

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

@@ -0,0 +1,11 @@
+export declare const url = "https://community-web.ccw.site/muted_user/detail";
+export type Req = {
+    studentNumber: string;
+};
+export type Res = null;
+/**
+ * 获取禁言用户详情
+ * @param {string} studentNumber 用户number(244373873)
+ * @returns {Promise<Res>} 禁言用户详情（null表示未禁言）
+ */
+export declare function getMutedUserDetail(studentNumber: string): Promise<Res>;

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

@@ -0,0 +1,15 @@
+import { PagesRes, PageArgs } from "types/pages";
+import { NotificationGroup, Notification } from "types/notification";
+export declare const url = "https://community-web.ccw.site/notification/page";
+export type Req = {
+    notifyGroup: NotificationGroup;
+    page: number;
+};
+export type Res = PagesRes<Notification>;
+/**
+ * 分页获取通知列表
+ * @param {NotificationGroup} notifyGroup 通知分组
+ * @param {Partial<PageArgs<"createdAt" | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 分页通知数据
+ */
+export declare function getNotificationPage<T extends string>(notifyGroup?: NotificationGroup, pageArgs_?: Partial<PageArgs<"createdAt" | T>>): Promise<Res>;

package/dist/types/src/community-web/notification/stats/v2.d.ts

@@ -0,0 +1,12 @@
+import { NotificationStats } from "types/notification";
+export declare const url = "https://community-web.ccw.site/notification/stats/v2";
+export type Req = {
+    countAll: boolean;
+};
+export type Res = NotificationStats;
+/**
+ * 获取通知统计
+ * @param {boolean} countAll 是否统计全部
+ * @returns {Promise<Res>} 通知统计数据
+ */
+export declare function getNotificationStats(countAll?: boolean): Promise<Res>;

package/dist/types/src/community-web/notify_message/show.d.ts

@@ -0,0 +1,17 @@
+export declare const url = "https://community-web.ccw.site/notify_message/show";
+export type NotifyMessageType = "COMMENT_AUDIT";
+export type Req = {
+    type: NotifyMessageType;
+};
+export type NotifyMessage = {
+    /** @example title = '广告或垃圾信息' */
+    title: string;
+    /** @example message = '由于包含广告或垃圾信息，已被管理员删除！' */
+    message: string;
+};
+export type Res = NotifyMessage[];
+/**
+ * 获取通知删除原因列表
+ * @returns {Promise<Res>} 消息删除原因列表
+ */
+export declare function getNotifyDeleteReasons(): Promise<Res>;

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

@@ -0,0 +1,50 @@
+import { MongoDBId, CNameOssUrl } from "types/api";
+export declare const url = "https://community-web.ccw.site/post/detail";
+export type PostTag = {
+    name: string;
+    slag: string;
+};
+export type PostFeatureImage = {
+    alt: string;
+    caption: string;
+    url: CNameOssUrl;
+};
+export type PostAuthor = {
+    avatar: CNameOssUrl;
+    name: string;
+    oid: MongoDBId;
+};
+export type Req = {
+    slug: string;
+};
+export type Res = {
+    author: PostAuthor;
+    authorOid: MongoDBId;
+    collectCount: null | number;
+    commentCount: number;
+    content: string;
+    createdAt: number;
+    draftContent: null | string;
+    excerpt: string;
+    featureImage: PostFeatureImage;
+    keywords: null | string[];
+    oid: MongoDBId;
+    pageView: number;
+    publishedAt: number;
+    rank: string;
+    rankUpdatedAt: null | number;
+    reviewedAt: number;
+    slug: string;
+    status: string;
+    tagRefs: PostTag[];
+    tags: string[];
+    title: string;
+    updatedAt: number;
+    visibility: string;
+};
+/**
+ * 获取帖子详情
+ * @param {string} slug 帖子slug
+ * @returns {Promise<Res>} 帖子详情
+ */
+export declare function getPostDetail(slug: string): Promise<Res>;

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

@@ -0,0 +1,11 @@
+export declare const url = "https://community-web.ccw.site/search/hot_words";
+export type Req = {
+    length: number;
+};
+export type Res = string[];
+/**
+ * 获取搜索热词
+ * @param {number} length 热词数量
+ * @returns {Promise<Res>} 热词列表
+ */
+export declare function getSearchHotWords(length: number): Promise<Res>;

package/dist/types/src/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/src/community-web/short_url/decompress.d.ts

@@ -0,0 +1,11 @@
+export declare const url = "https://community-web.ccw.site/short_url/decompress";
+export type Req = {
+    shortUrlCode: string;
+};
+export type Res = string;
+/**
+ * 解压缩短链接
+ * @param {string} shortUrlCode 短链接码
+ * @returns {Promise<Res>} 原始URL
+ */
+export declare function decompressShortUrl(shortUrlCode: string): Promise<Res>;

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

@@ -0,0 +1,35 @@
+import { AccountTypes } from "types/account";
+import { MongoDBId } from "types/api";
+export declare const url = "https://community-web.ccw.site/student/block_record/detail";
+/**
+ * 用户是否在我的黑名单中
+ */
+export type BlockStatus = "NOT_BLOCKED" | "BLOCKING";
+export type Req = {
+    studentOid: MongoDBId;
+};
+export type BlockActionRecord = {
+    action: "BLOCK";
+    createdAt: number;
+    deletedAt: null;
+    ext: null;
+    /**
+     * 我的用户id
+     */
+    fromEntityId: MongoDBId;
+    fromEntityType: AccountTypes;
+    oid: MongoDBId;
+    /**
+     * 被加入黑名单的id
+     */
+    relatedEntityId: MongoDBId;
+    relatedEntityType: AccountTypes;
+    updatedAt: number;
+};
+export type Res = BlockActionRecord | null;
+/**
+ * 获取特定用户黑名单详细信息
+ * @param {MongoDBId} studentOid 学生id
+ * @returns {Promise<Res>} 封禁状态
+ */
+export declare function getStudentBlockRecordDetail(studentOid: MongoDBId): Promise<Res>;

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

@@ -0,0 +1,18 @@
+import { MongoDBId } from "types/api";
+import { PagesRes, PageArgs } from "types/pages";
+export declare const url = "https://community-web.ccw.site/student/block_record/list";
+export type BlockRecord = {
+    id: number;
+    studentOid: MongoDBId;
+    reason: string;
+    createdAt: number;
+    expireAt: number;
+};
+export type Req = {};
+export type Res = PagesRes<BlockRecord>;
+/**
+ * 获取学生封禁记录列表
+ * @param {Partial<PageArgs<"createdAt" | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 封禁记录分页数据
+ */
+export declare function getStudentBlockRecordList<T extends string>(pageArgs_?: Partial<PageArgs<"createdAt" | T>>): Promise<Res>;

package/dist/types/src/community-web/student/block_record/status.d.ts

@@ -0,0 +1,16 @@
+import { MongoDBId } from "types/api";
+export declare const url = "https://community-web.ccw.site/student/block_record/status";
+/**
+ * 用户是否在我的黑名单中
+ */
+export type BlockStatus = "NOT_BLOCKED" | "BLOCKING";
+export type Req = {
+    studentOid: MongoDBId;
+};
+export type Res = BlockStatus;
+/**
+ * 获取特定用户黑名单状态
+ * @param {MongoDBId} studentOid 学生id
+ * @returns {Promise<Res>} 封禁状态
+ */
+export declare function getStudentBlockStatus(studentOid: MongoDBId): Promise<Res>;

package/dist/types/src/community-web/student/following/page.d.ts

@@ -0,0 +1,17 @@
+import { MongoDBId } from "types/api";
+import { PagesRes, PageArgs } from "types/pages";
+import { StudentSimple } from "types/userData";
+export declare const url = "https://community-web.ccw.site/student/following/page";
+export type Req = {
+    studentOid: MongoDBId;
+};
+export type Res = PagesRes<StudentSimple & {
+    operatorFollowingStatus: "FOLLOWED" | "BOTH_FOLLOWED";
+}>;
+/**
+ * 获取学生关注列表分页
+ * @param {MongoDBId} studentOid 学生id
+ * @param {Partial<PageArgs<"createdAt" | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 关注列表分页
+ */
+export declare function getStudentFollowingPage<T extends string>(studentOid: MongoDBId, pageArgs_?: Partial<PageArgs<"createdAt" | T>>): Promise<Res>;

package/dist/types/src/community-web/students/creator_score.d.ts

@@ -0,0 +1,9 @@
+import { CreatorScore } from "types/userData";
+export declare const url = "https://community-web.ccw.site/students/creator_score";
+export type Req = undefined;
+export type Res = CreatorScore;
+/**
+ * 获取当前学生创作分
+ * @returns {Promise<Res>} 创作分信息
+ */
+export declare function getCreatorScore(): Promise<Res>;

package/dist/types/src/community-web/students/last_active_at.d.ts

@@ -0,0 +1,14 @@
+import { MongoDBId } from "types/api";
+export declare const url = "https://community-web.ccw.site/students/last_active_at";
+export type Req = {
+    studentOid: MongoDBId;
+};
+export type Res = {
+    lastActiveAt: number;
+};
+/**
+ * 获取学生最后活跃时间
+ * @param {MongoDBId} studentOid 学生id
+ * @returns {Promise<Res>} 最后活跃时间数据
+ */
+export declare function getStudentLastActiveAt(studentOid: MongoDBId): Promise<Res>;

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

@@ -0,0 +1,13 @@
+import { MongoDBId } from "types/api";
+import { StudentListItem } from "types/userData";
+export declare const url = "https://community-web.ccw.site/students/list";
+export type Req = {
+    studentOids: MongoDBId[];
+};
+export type Res = StudentListItem[];
+/**
+ * 根据学生OID列表获取学生信息列表(这个会返回一堆null,不建议使用)
+ * @param {MongoDBId[]} studentOids 学生OID列表
+ * @returns {Promise<Res>} 学生信息列表
+ */
+export declare function getStudentsList(studentOids: MongoDBId[]): Promise<Res>;

package/dist/types/src/community-web/students/list_sessions.d.ts

@@ -0,0 +1,12 @@
+import { PagesRes, PageArgs } from "types/pages";
+import { StudentSession, SessionArea } from "types/session";
+export declare const url = "https://community-web.ccw.site/students/list_sessions";
+export type Req = {};
+export type Res = PagesRes<StudentSession>;
+/**
+ * 获取学生登录会话列表
+ * @param {Partial<PageArgs<"createdAt" | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 会话列表分页数据
+ */
+export declare function getStudentSessions<T extends string>(pageArgs_?: Partial<PageArgs<"createdAt" | T>>): Promise<Res>;
+export type { SessionArea, StudentSession };

package/dist/types/src/community-web/students/profile.d.ts

@@ -0,0 +1,13 @@
+import { MongoDBId } from "types/api";
+import { StudentProfile } from "types/userData";
+export declare const url = "https://community-web.ccw.site/students/profile";
+export type Req = {
+    studentOid: MongoDBId;
+};
+export type Res = StudentProfile;
+/**
+ * 获取学生个人主页资料
+ * @param {MongoDBId} studentOid 学生id
+ * @returns {Promise<Res>} 学生资料
+ */
+export declare function getStudentProfile(studentOid: MongoDBId): Promise<Res>;

package/dist/types/src/community-web/students/reputation_score_log/page.d.ts

@@ -0,0 +1,11 @@
+import { PagesRes, PageArgs } from "types/pages";
+import { ReputationScoreLog } from "types/userData";
+export declare const url = "https://community-web.ccw.site/students/reputation_score_log/page";
+export type Req = {};
+export type Res = PagesRes<ReputationScoreLog>;
+/**
+ * 获取学生信誉分记录
+ * @param {Partial<PageArgs<"createdAt" | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 信誉分记录分页数据
+ */
+export declare function getReputationScoreLog<T extends string>(pageArgs_?: Partial<PageArgs<"createdAt" | T>>): Promise<Res>;

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

@@ -0,0 +1,18 @@
+import { ProfileExtraInfo, ParentInfo, CurrentParent, InfoModifyDate, StudentSelfDetailFields, StudentSelfDetail } from "types/userData";
+export declare const url = "https://community-web.ccw.site/students/self/detail";
+export type StudentExtraInfo = ProfileExtraInfo;
+export type Req = {
+    needGrade: boolean;
+    needExtraInfo: boolean;
+    fields: StudentSelfDetailFields[];
+};
+export type Res = StudentSelfDetail;
+/**
+ * 获取当前登录学生的详细信息
+ * @param {boolean} needGrade 是否需要年级信息
+ * @param {boolean} needExtraInfo 是否需要扩展信息
+ * @param {StudentSelfDetailFields[]} fields 需要返回的字段列表
+ * @returns {Promise<Res>} 当前学生详情
+ */
+export declare function getStudentSelfDetail(needGrade: boolean, needExtraInfo: boolean, fields: StudentSelfDetailFields[]): Promise<Res>;
+export type { ParentInfo, CurrentParent, InfoModifyDate };

package/dist/types/src/community-web/students/stats.d.ts

@@ -0,0 +1,13 @@
+import { MongoDBId } from "types/api";
+import { StudentFollowerStats } from "types/userData";
+export declare const url = "https://community-web.ccw.site/students/stats";
+export type Req = {
+    studentOid: MongoDBId;
+};
+export type Res = StudentFollowerStats;
+/**
+ * 获取学生统计数据（关注数、粉丝数）
+ * @param {MongoDBId} studentOid 学生id
+ * @returns {Promise<Res>} 统计数据
+ */
+export declare function getStudentStats(studentOid: MongoDBId): Promise<Res>;

package/dist/types/src/community-web/students/update.d.ts

@@ -0,0 +1,18 @@
+import { StudentUpdateReq } from "types/userData";
+export declare const url = "https://community-web.ccw.site/students/update";
+export type Req = StudentUpdateReq;
+export type Res = boolean;
+/**
+ * 更新学生个人信息
+ * @param {string} gender 性别
+ * @param {boolean} hideGender 是否隐藏性别
+ * @param {string} fullName 全名
+ * @param {number} birthday 生日时间戳
+ * @param {string} programmingCapability 编程能力
+ * @param {string} school 学校
+ * @param {string} qq QQ号
+ * @param {string} hobbies 爱好
+ * @param {string} learnedProgrammingLanguages 学过的编程语言
+ * @returns {Promise<boolean>} 是否更新成功
+ */
+export declare function updateStudent(gender: string, hideGender: boolean, fullName: string, birthday: number, programmingCapability: string, school: string, qq: string, hobbies: string, learnedProgrammingLanguages: string): Promise<Res>;

package/dist/types/src/community-web/study-community/cloud_variable/create.d.ts

@@ -0,0 +1,15 @@
+import { MongoDBId } from "types/api";
+export declare const url = "https://community-web.ccw.site/study-community/cloud_variable/create";
+export type Req = {
+    projectId: MongoDBId;
+    variables: Record<string, unknown>;
+};
+export type Res = Record<string, never>;
+/**
+ * @deprecated 云变量几百年没用过了
+ * 创建云变量
+ * @param {MongoDBId} projectId 项目id
+ * @param {Record<string, unknown>} variables 变量数据
+ * @returns {Promise<Res>} 空对象
+ */
+export declare function createCloudVariable(projectId: MongoDBId, variables: Record<string, unknown>): Promise<Res>;

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

@@ -0,0 +1,11 @@
+export declare const url = "https://community-web.ccw.site/study-community/comment/delete";
+export type Req = {
+    id: number;
+};
+export type Res = boolean;
+/**
+ * 删除评论
+ * @param {number} id 评论id
+ * @returns {Promise<Res>} 操作是否成功
+ */
+export declare function deleteComment(id: number): Promise<Res>;

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

@@ -0,0 +1,11 @@
+export declare const url = "https://community-web.ccw.site/study-community/comment/fold";
+export type Req = {
+    id: number;
+};
+export type Res = boolean;
+/**
+ * 折叠评论
+ * @param {number} id 评论id
+ * @returns {Promise<Res>} 操作是否成功
+ */
+export declare function foldComment(id: number): Promise<Res>;

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

@@ -0,0 +1,11 @@
+export declare const url = "https://community-web.ccw.site/study-community/comment/reset_weight";
+export type Req = {
+    id: number;
+};
+export type Res = boolean;
+/**
+ * 取消置顶
+ * @param {number} id 评论id
+ * @returns {Promise<Res>} 操作是否成功
+ */
+export declare function resetCommentWeight(id: number): Promise<Res>;

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

@@ -0,0 +1,14 @@
+export declare const url = "https://community-web.ccw.site/study-community/comment/top";
+export type Req = {
+    /**
+     * @example 9629592
+     */
+    id: number;
+};
+export type Res = boolean;
+/**
+ * 置顶评论
+ * @param {number} id 评论id
+ * @returns {Promise<Res>} 操作是否成功
+ */
+export declare function topComment(id: number): Promise<Res>;

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

@@ -0,0 +1,25 @@
+import { MongoDBId, CNameOssUrl } from "types/api";
+import { AccountTypes } from "types/account";
+export declare const url = "https://community-web.ccw.site/study-community/member/detail";
+export type Req = {};
+export type Res = {
+    accountOid: MongoDBId;
+    accountType: AccountTypes;
+    approvedContent: null | string;
+    approvedType: null | string;
+    avatar: CNameOssUrl;
+    createdAt: number;
+    ext: {};
+    hideGender: boolean;
+    id: number;
+    maxCheckedFeedId: string;
+    name: string;
+    status: "NORMAL";
+    studentNumber: `${number}`;
+    updatedAt: number;
+};
+/**
+ * 获取当前用户学习社区成员详情
+ * @returns {Promise<Res>} 我的社区成员详情
+ */
+export declare function getStudyCommunityMemberDetail(): Promise<Res>;

package/dist/types/src/community-web/study-community/spread_feed/unread/count.d.ts

@@ -0,0 +1,12 @@
+import { MongoDBId } from "types/api";
+export declare const url = "https://community-web.ccw.site/study-community/spread_feed/unread/count";
+export type Req = {
+    studentOid: MongoDBId;
+};
+export type Res = number;
+/**
+ * 获取动态未读消息数
+ * @param {MongoDBId} studentOid 学生id
+ * @returns {Promise<number>} 未读消息数
+ */
+export declare function getSpreadFeedUnreadCount(studentOid: MongoDBId): Promise<Res>;

package/dist/types/src/community-web/study-trade/trade/donate.d.ts

@@ -0,0 +1,17 @@
+import { MongoDBId } from "types/api";
+export declare const url = "https://community-web.ccw.site/study-trade/trade/donate";
+export type DonateObjectType = "CREATION";
+export type Req = {
+    bucks: number;
+    objectId: MongoDBId;
+    objectType: DonateObjectType;
+};
+export type Res = null;
+/**
+ * 向作品投币
+ * @param {number} bucks 投币数量
+ * @param {MongoDBId} objectId 作品id
+ * @param {DonateObjectType} objectType
+ * @returns {Promise<Res>} 无返回值
+ */
+export declare function donateTrade(bucks: number, objectId: MongoDBId, objectType?: DonateObjectType): Promise<Res>;

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

@@ -0,0 +1,71 @@
+import { MongoDBId, CNameOssUrl } from "types/api";
+import { PagesRes, PageArgs } from "types/pages";
+export declare const url = "https://community-web.ccw.site/subject_area/page";
+export type SubjectAreaModuleComponent = {
+    data: {
+        bgColor?: string;
+        bgImage?: CNameOssUrl;
+        col?: number;
+        creationOids?: MongoDBId[];
+        display?: string;
+        hover?: boolean;
+        origin: string;
+        overflow?: string;
+        row?: string;
+        targetLink?: string;
+        targetType?: string;
+    };
+    type: string;
+};
+export type SubjectAreaModule = {
+    components: SubjectAreaModuleComponent[];
+    filled: boolean;
+    gutter: number;
+    subtitle: string;
+    subtitleColor: string;
+    title: string;
+    titleColor: string;
+    type: string;
+};
+export type SubjectAreaGroup = {
+    bgAtmosphere: null | string;
+    bgColor: string;
+    bgImage: CNameOssUrl;
+    id: number;
+    lottieJsonUrl: null | CNameOssUrl;
+    modules: SubjectAreaModule[];
+    moreLink: null | string;
+    moreLinkText: null | string;
+    subjectAreaId: number;
+    subtitle: string;
+    subtitleColor: string;
+    title: string;
+    titleColor: string;
+    verticalPadding: number;
+};
+export type SubjectAreaScene = "HOMEPAGE";
+export type SubjectAreaItem = {
+    creationOids: MongoDBId[];
+    enabled: boolean;
+    iconLink: null | CNameOssUrl;
+    id: number;
+    location: null | string;
+    platform: "WEB";
+    priority: number;
+    subjectAreaGroup: SubjectAreaGroup;
+    subtitle: null | string;
+    targetLink: null | string;
+    title: string;
+    visibleFor: string[];
+};
+export type Req = {
+    scene: SubjectAreaScene;
+};
+export type Res = PagesRes<SubjectAreaItem>;
+/**
+ * 分页获取主页推荐列表
+ * @param {SubjectAreaScene} scene 场景
+ * @param {Partial<PageArgs<"createdAt" | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 主页推荐分页数据
+ */
+export declare function getSubjectAreaPage<T extends string>(scene: SubjectAreaScene, pageArgs_?: Partial<PageArgs<"createdAt" | T>>): Promise<Res>;

package/dist/types/src/community-web/subject_area/page_by_channel.d.ts

@@ -0,0 +1,73 @@
+import { MongoDBId, CNameOssUrl } from "types/api";
+import { PagesRes, PageArgs } from "types/pages";
+export declare const url = "https://community-web.ccw.site/subject_area/page_by_channel";
+export type SubjectAreaModuleComponent = {
+    data: {
+        bgColor?: string;
+        bgImage?: CNameOssUrl;
+        col?: number;
+        creationOids?: MongoDBId[];
+        display?: string;
+        hover?: boolean;
+        origin: string;
+        overflow?: string;
+        row?: string;
+        targetLink?: string;
+        targetType?: string;
+    };
+    type: string;
+};
+export type SubjectAreaModule = {
+    components: SubjectAreaModuleComponent[];
+    filled: boolean;
+    gutter: number;
+    subtitle: string;
+    subtitleColor: string;
+    title: string;
+    titleColor: string;
+    type: string;
+};
+export type SubjectAreaGroup = {
+    bgAtmosphere: null | string;
+    bgColor: string;
+    bgImage: CNameOssUrl;
+    id: number;
+    lottieJsonUrl: null | CNameOssUrl;
+    modules: SubjectAreaModule[];
+    moreLink: null | string;
+    moreLinkText: null | string;
+    subjectAreaId: number;
+    subtitle: string;
+    subtitleColor: string;
+    title: string;
+    titleColor: string;
+    verticalPadding: number;
+};
+export type SubjectAreaScene = "CUSTOM_PAGE";
+export type SubjectAreaChannel = "tags" | "mmo" | "adventure";
+export type SubjectAreaItem = {
+    creationOids: MongoDBId[];
+    enabled: boolean;
+    iconLink: null | CNameOssUrl;
+    id: number;
+    location: null | string;
+    platform: string;
+    priority: number;
+    subjectAreaGroup: SubjectAreaGroup;
+    subtitle: null | string;
+    targetLink: null | string;
+    title: string;
+    visibleFor: string[];
+};
+export type Req = {
+    channel: SubjectAreaChannel;
+    scene: SubjectAreaScene;
+};
+export type Res = PagesRes<SubjectAreaItem>;
+/**
+ * 按频道分页获取分区列表(用于上方nav bar的"热门分类" "联机" "联名挑战赛")
+ * @param {SubjectAreaChannel} channel 频道
+ * @param {Partial<PageArgs<"campaignResourceId" | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 学科区分页数据
+ */
+export declare function getSubjectAreaPageByChannel<T extends string>(channel: SubjectAreaChannel, pageArgs_?: Partial<PageArgs<"campaignResourceId" | T>>): Promise<Res>;