@ccw-api/api 0.6.0 → 0.8.0

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

@@ -1,19 +0,0 @@
-import { CNameOssUrl, LatestCNameOssUrl, MongoDBId } from "src/types/api";
-import { CreationScreenMode } from "src/types/creation";
-export declare const url = "https://community-web.ccw.site/creation/update";
-export type Req = {
-    latestCoverLink: string;
-    latestProjectLink: LatestCNameOssUrl;
-    oid: MongoDBId;
-    screenMode: CreationScreenMode;
-};
-export type Res = boolean;
-/**
- * 更新作品信息
- * @param {MongoDBId} oid 作品id
- * @param {LatestCNameOssUrl} latestProjectLink_ 最新项目链接
- * @param {CreationScreenMode} screenMode 屏幕模式
- * @param {CNameOssUrl} latestCoverLink 最新封面链接
- * @returns {Promise<Res>} 更新是否成功
- */
-export declare function updateCreation(oid: MongoDBId, latestProjectLink_: CNameOssUrl, screenMode: CreationScreenMode, latestCoverLink: CNameOssUrl): Promise<Res>;

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

@@ -1,20 +0,0 @@
-import { MongoDBId } from "src/types/api";
-export declare const url = "https://community-web.ccw.site/creation_activity_stats/list";
-export type CreationActivityStatsItem = {
-    activeAt: number;
-    activeAtDayOfWeek: number;
-    creationOid: MongoDBId;
-    duration: number;
-    id: number;
-};
-export type Req = {
-    creationOid: MongoDBId;
-    type: "DAY";
-};
-export type Res = CreationActivityStatsItem[];
-/**
- * 获取作品创作活跃统计数据列表(绿格子)
- * @param {MongoDBId} creationOid 作品id
- * @returns {Promise<Res>} 活动统计数据
- */
-export declare function getCreationActivityStatsList(creationOid: MongoDBId): Promise<Res>;

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

@@ -1,34 +0,0 @@
-import { MongoDBId } from "src/types/api";
-export declare const url = "https://community-web.ccw.site/creation_attribute/detail";
-export type KeypadConfig = {
-    maxR: number;
-    minR: number;
-    r: number;
-    slot: string;
-    value: string;
-    x: number;
-    y: number;
-};
-export type CreationAttribute<KC> = {
-    createdAt: number;
-    creationOid: MongoDBId;
-    endorsement: null;
-    ext: {
-        KEYPAD_CONFIG: KC;
-    };
-    recommendationCreation: unknown[];
-    recommendationPost: unknown[];
-    recommendationProjectTemplate: unknown[];
-    specialThanks: unknown[];
-    updatedAt: number;
-};
-export type Req = {
-    creationOid: MongoDBId;
-};
-export type Res<KC> = CreationAttribute<KC>;
-/**
- * 获取作品属性详情
- * @param {MongoDBId} creationOid 作品id
- * @returns {Promise<Res | null>} 作品属性
- */
-export declare function getCreationAttributeDetail(creationOid: MongoDBId): Promise<Res<KeypadConfig[]> | null>;

package/dist/types/community-web/creation_donated_record/ranking_list.d.ts

@@ -1,19 +0,0 @@
-import { MongoDBId } from "src/types/api";
-import { PagesRes, PageArgs } from "src/types/pages";
-import { DonatedRecord } from "src/types/creation";
-export declare const url = "https://community-web.ccw.site/creation_donated_record/ranking_list";
-export type Req = {
-    creationOid: MongoDBId;
-};
-export type Res = {
-    curUserDonatedRecord: null | DonatedRecord;
-    rankingList: PagesRes<DonatedRecord>;
-    totalBucks: null | number;
-};
-/**
- * 获取作品投币排行
- * @param {MongoDBId} creationOid 作品id
- * @param {Partial<PageArgs<"createdAt" | T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 投币排行数据
- */
-export declare function getDonatedRecordRanking<T extends string>(creationOid: MongoDBId, pageArgs_?: Partial<PageArgs<"createdAt" | T>>): Promise<Res>;

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

@@ -1,13 +0,0 @@
-import { MongoDBId } from "src/types/api";
-import { FavoriteDetail } from "src/types/creation";
-export declare const url = "https://community-web.ccw.site/creation_favorite/detail";
-export type Req = {
-    creationOid: MongoDBId;
-};
-export type Res = null | FavoriteDetail;
-/**
- * 获取作品收藏详情（需要登录）
- * @param {MongoDBId} creationOid 作品id
- * @returns {Promise<Res>} 收藏详情（未收藏返回null）
- */
-export declare function getCreationFavoriteDetail(creationOid: MongoDBId): Promise<Res>;

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

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

package/dist/types/community-web/creation_release/code_profiling/detail.d.ts

@@ -1,60 +0,0 @@
-import { MongoDBId } from "src/types/api";
-export declare const url = "https://community-web.ccw.site/creation_release/code_profiling/detail";
-export type ProfilingCodes = Record<string, number>;
-export type ProfilingExt = Record<string, number>;
-export type ProfilingMath = {
-    arithmetic: number;
-    logic: number;
-    math: number;
-};
-export type ProfilingMastery = {
-    abstractionPoints: number;
-    dataRepresentationPoints: number;
-    flowControlPoints: number;
-    logicPoints: number;
-    parallelizationPoints: number;
-    synchronizationPoints: number;
-    userInteractivityPoints: number;
-};
-export type Profiling = {
-    audioCount: number;
-    audioSize: `${number}`;
-    blockChangeCount: number;
-    codes: ProfilingCodes;
-    costumeCount: number;
-    costumeSize: string;
-    count: number;
-    ext: ProfilingExt;
-    firstComparedChangedBlockCount: number;
-    firstComparedChangedSpriteCount: number;
-    functionCount: number;
-    hatBlockCount: number;
-    listCount: number;
-    mastery: ProfilingMastery;
-    math: ProfilingMath;
-    projectSize: `${number}`;
-    spriteChangeCount: number;
-    spriteCount: number;
-    validBlockCount: number;
-    varCount: number;
-};
-export type CodeProfilingDetail = {
-    createdAt: number;
-    creationOid: MongoDBId;
-    creationReleaseOid: MongoDBId;
-    id: number;
-    profiling: Profiling;
-    updatedAt: number;
-};
-export type Req = {
-    creationOid: MongoDBId;
-    creationReleaseOid: MongoDBId;
-};
-export type Res = CodeProfilingDetail;
-/**
- * 获取作品工程统计详情
- * @param {MongoDBId} creationOid 作品id
- * @param {MongoDBId} creationReleaseOid 发布版本id
- * @returns {Promise<Res>} 代码分析详情
- */
-export declare function getCodeProfilingDetail(creationOid: MongoDBId, creationReleaseOid: MongoDBId): Promise<Res>;

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

@@ -1,16 +0,0 @@
-import { MongoDBId } from "src/types/api";
-import { PagesRes, PageArgs } from "src/types/pages";
-import { CreationRelease } from "src/types/creation";
-export declare const url = "https://community-web.ccw.site/creation_release/page";
-export type SortField = "submittedAt";
-export type Req = {
-    creationOid: MongoDBId;
-};
-export type Res = PagesRes<CreationRelease>;
-/**
- * 获取作品发布记录分页
- * @param {MongoDBId} creationOid 作品id
- * @param {Partial<PageArgs<SortField | T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 发布记录分页列表
- */
-export declare function getCreationReleasePage<T extends string>(creationOid: MongoDBId, pageArgs_?: Partial<PageArgs<SortField | T>>): Promise<Res>;

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

@@ -1,15 +0,0 @@
-import { MongoDBId } from "src/types/api";
-import { PagesRes, PageArgs } from "src/types/pages";
-import { CreationScreenshot } from "src/types/creation";
-export declare const url = "https://community-web.ccw.site/creation_screenshot/page";
-export type Req = {
-    subjectOid: MongoDBId;
-};
-export type Res = PagesRes<CreationScreenshot>;
-/**
- * 获取作品截图分页
- * @param {MongoDBId} subjectOid 作品id
- * @param {Partial<PageArgs<"createdAt" | T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 分页截图列表
- */
-export declare function getCreationScreenshotPage<T extends string>(subjectOid: MongoDBId, pageArgs_?: Partial<PageArgs<"createdAt" | T>>): Promise<Res>;

package/dist/types/community-web/creation_stats/view.d.ts

@@ -1,14 +0,0 @@
-import { MongoDBId } from "src/types/api";
-export declare const url = "https://community-web.ccw.site/creation_stats/view";
-export type Req = {
-    inviteCode: string;
-    oid: MongoDBId;
-};
-export type Res = boolean;
-/**
- * 查看作品统计（增加浏览量）
- * @param {MongoDBId} oid 作品id
- * @param {string} inviteCode 邀请码
- * @returns {Promise<boolean>} 是否成功
- */
-export declare function viewCreationStats(oid: MongoDBId, inviteCode?: string): Promise<Res>;

package/dist/types/community-web/currency/account/personal.d.ts

@@ -1,12 +0,0 @@
-export declare const url = "https://community-web.ccw.site/currency/account/personal";
-export type Req = undefined;
-export type Res = {
-    internalCurrencyBalance: number;
-    topUpCurrencyBalance: number;
-    withdrawCurrencyBalance: number;
-};
-/**
- * 获取个人金币信息
- * @returns {Promise<Res>} 账户金币余额信息
- */
-export declare function getPersonalCurrencyAccount(): Promise<Res>;

package/dist/types/community-web/emoji/all.d.ts

@@ -1,27 +0,0 @@
-import { CNameOssUrl, MongoDBId } from "src/types/api";
-export declare const url = "https://community-web.ccw.site/emoji/all";
-export type Req = {};
-export interface Emoji {
-    category: `${number}`;
-    createdAt: number;
-    id: number;
-    imageUrl: CNameOssUrl;
-    /**
-     * 表情包名称
-     */
-    name: string;
-    /**
-     * 表情包作者
-     */
-    operatorName: string;
-    operatorOid: MongoDBId;
-    priority: number;
-    status: "ENABLED";
-    updatedAt: number;
-}
-export type Res = Emoji[];
-/**
- * 获取所有表情包
- * @returns {Promise<Res>} 表情包列表
- */
-export declare function getAllEmojis(): Promise<Res>;

package/dist/types/community-web/emoji/category/list.d.ts

@@ -1,16 +0,0 @@
-import { CNameOssUrl } from "src/types/api";
-export declare const url = "https://community-web.ccw.site/emoji/category/list";
-export type Req = {};
-export interface EmojiCategory {
-    createdAt: number;
-    id: number;
-    imageUrl: CNameOssUrl;
-    name: string;
-    updatedAt: number;
-}
-export type Res = EmojiCategory[];
-/**
- * 获取表情包分类列表
- * @returns {Promise<Res>} 表情包分类列表
- */
-export declare function getEmojiCategoryList(): Promise<Res>;

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

@@ -1,17 +0,0 @@
-import { PagesRes, PageArgs } from "src/types/pages";
-import { Emoji } from "./all";
-export declare const url = "https://community-web.ccw.site/emoji/page";
-export type Req = {
-    page: number;
-    perPage: number;
-    status: string;
-};
-export type Res = PagesRes<Emoji>;
-export type EmojiStatus = "ENABLED" | "PUBLISHED";
-/**
- * 分页获取表情包
- * @param {string} status 表情包状态
- * @param {Partial<PageArgs<"createdAt" | T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 分页表情包数据
- */
-export declare function getEmojiPage<T extends string>(status?: EmojiStatus, pageArgs_?: Partial<PageArgs<"createdAt" | T>>): Promise<Res>;

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

@@ -1,11 +0,0 @@
-export declare const url = "https://community-web.ccw.site/event";
-export type Req = {
-    actionId: string;
-};
-export type Res = boolean;
-/**
- * 发送事件
- * @param {string} actionId 事件ID
- * @returns {Promise<Res>} 是否成功
- */
-export declare function sendEvent(actionId: string): Promise<Res>;

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

@@ -1,18 +0,0 @@
-import { MongoDBId } from "src/types/api";
-export declare const url = "https://community-web.ccw.site/extensions/creation-like/detail";
-export type Req = {
-    playingCreationOid: MongoDBId;
-    creationOid: MongoDBId;
-};
-export type Res = {
-    interactionStatus: boolean;
-    oid: MongoDBId;
-    title: string;
-};
-/**
- * [连接社区扩展] 查询用户对作品的点赞交互状态
- * @param {MongoDBId} playingCreationOid 当前播放的作品 OID
- * @param {MongoDBId} creationOid 目标作品 OID
- * @returns {Promise<Res>} 点赞状态及作品信息
- */
-export declare function getConnectCommunityCreationLikeStatus(playingCreationOid: MongoDBId, creationOid: MongoDBId): Promise<Res>;

package/dist/types/community-web/extensions/following/status.d.ts

@@ -1,19 +0,0 @@
-import { MongoDBId, CNameOssUrl } from "src/types/api";
-export declare const url = "https://community-web.ccw.site/extensions/following/status";
-export type Req = {
-    playingCreationOid: MongoDBId;
-    userOid: MongoDBId;
-};
-export type Res = {
-    avatar: CNameOssUrl;
-    isFollowing: boolean;
-    name: string;
-    oid: MongoDBId;
-};
-/**
- * [连接社区扩展] 查询是否关注了指定创作者
- * @param {MongoDBId} playingCreationOid 当前播放的作品 OID
- * @param {MongoDBId} userOid 目标用户 OID
- * @returns {Promise<Res>} 关注状态及用户信息
- */
-export declare function getConnectCommunityFollowingStatus(playingCreationOid: MongoDBId, userOid: MongoDBId): Promise<Res>;

package/dist/types/community-web/great_creation/update.d.ts

@@ -1,12 +0,0 @@
-import { MongoDBId } from "src/types/api";
-export declare const url = "https://community-web.ccw.site/great_creation/update";
-export type Req = {
-    creationOid: MongoDBId | "";
-};
-export type Res = boolean;
-/**
- * 更换代表作
- * @param {MongoDBId|""} creationOid 作品OID 若为""则是取消展示
- * @returns {Promise<Res>} 更换结果
- */
-export declare function updateGreatCreation(creationOid: MongoDBId | ""): Promise<Res>;

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

@@ -1,12 +0,0 @@
-import { HashTag } from "src/types/hashTag";
-export declare const url = "https://community-web.ccw.site/hash_tag/detail";
-export type Req = {
-    identifier: string;
-};
-export type Res = HashTag;
-/**
- * 获取星球详情
- * @param {string} identifier 星球标识符（名称）
- * @returns {Promise<Res>} 星球详情
- */
-export declare function getHashTagDetail(identifier: string): Promise<Res>;

package/dist/types/community-web/hash_tag/managed/list.d.ts

@@ -1,18 +0,0 @@
-import { MongoDBId } from "src/types/api";
-import { PagesRes, PageArgs } from "src/types/pages";
-import { HashTag } from "src/types/hashTag";
-export declare const url = "https://community-web.ccw.site/hash_tag/managed/list";
-export type SortField = "createdAt" | "priority" | string;
-export type Req = PageArgs<SortField> & {
-    excludeHashTagIds: number[];
-    studentOid: MongoDBId;
-};
-export type Res = PagesRes<HashTag, SortField>;
-/**
- * 获取用户管理的星球列表
- * @param {MongoDBId} studentOid 学生oid
- * @param {number[]} excludeHashTagIds 排除的星球id列表
- * @param {Partial<PageArgs<SortField | T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 管理的星球分页结果
- */
-export declare function getManagedHashTags<T extends string>(studentOid: MongoDBId, excludeHashTagIds?: number[], pageArgs_?: Partial<PageArgs<SortField | T>>): Promise<Res>;

package/dist/types/community-web/hash_tag/recommend/list.d.ts

@@ -1,8 +0,0 @@
-import { HashTag } from "src/types/hashTag";
-export declare const url = "https://community-web.ccw.site/hash_tag/recommend/list";
-export type Res = HashTag[];
-/**
- * 获取推荐星球列表
- * @returns {Promise<Res>} 推荐星球列表
- */
-export declare function getRecommendHashTags(): Promise<Res>;

package/dist/types/community-web/hash_tag_creation/list_relation.d.ts

@@ -1,13 +0,0 @@
-import { MongoDBId } from "src/types/api";
-import { HashTagCreationRelation } from "src/types/hashTag";
-export declare const url = "https://community-web.ccw.site/hash_tag_creation/list_relation";
-export type Req = {
-    creationOid: MongoDBId;
-};
-export type Res = HashTagCreationRelation[];
-/**
- * 获取作品所在星球列表
- * @param {MongoDBId} creationOid 作品ID
- * @returns {Promise<Res>} 星球列表
- */
-export declare function getPlanetsOfCreation(creationOid: MongoDBId): Promise<Res>;

package/dist/types/community-web/hash_tag_creation/mine.d.ts

@@ -1,18 +0,0 @@
-import { PagesRes, PageArgs } from "src/types/pages";
-import { Creation } from "src/types/creation";
-export declare const url = "https://community-web.ccw.site/hash_tag_creation/mine";
-export type SortField = "createdAt" | "lastPassedAt" | "lastSubmittedAt" | "lastPublishedAt" | string;
-export type HashTagCreationStatus = "PUBLISHED" | "SUBMITTED" | string;
-export type Req = PageArgs<SortField> & {
-    excludeHashTag?: string;
-    statuses?: HashTagCreationStatus[];
-};
-export type Res = PagesRes<Creation, SortField>;
-/**
- * 获取当前用户提交到星球的作品列表
- * @param {string} [excludeHashTag] 排除的星球标识符（名称）
- * @param {HashTagCreationStatus[]} [statuses] 作品状态筛选，例如 ["PUBLISHED"]
- * @param {Partial<PageArgs<SortField | T>>} [pageArgs_] 分页参数
- * @returns {Promise<Res>} 星球作品分页结果
- */
-export declare function getMyHashTagCreations<T extends string>(excludeHashTag?: string, statuses?: HashTagCreationStatus[], pageArgs_?: Partial<PageArgs<SortField | T>>): Promise<Res>;

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

@@ -1,12 +0,0 @@
-import { HashTagFavorite } from "src/types/hashTag";
-export declare const url = "https://community-web.ccw.site/hash_tag_favorite/detail";
-export type Req = {
-    hashTagId: number;
-};
-export type Res = HashTagFavorite;
-/**
- * 获取星球收藏详情
- * @param {number} hashTagId 星球ID
- * @returns {Promise<Res>} 星球收藏详情
- */
-export declare function getHashTagFavoriteDetail(hashTagId: number): Promise<Res>;

package/dist/types/community-web/health/check.d.ts

@@ -1,14 +0,0 @@
-export declare const url = "https://community-web.ccw.site/health/check";
-export type Req = undefined;
-export interface HealthCheckItem {
-    name: string;
-    status: string;
-    traceId: string;
-}
-export type Res = HealthCheckItem[];
-/**
- * @deprecated 仅用于初始化axios
- * health check接口
- * @returns {Promise<Res>}
- */
-export declare function healthCheck(): Promise<Res>;

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

@@ -1,17 +0,0 @@
-import { MongoDBId } from "src/types/api";
-import { PagesRes, PageArgs } from "src/types/pages";
-export declare const url = "https://community-web.ccw.site/historical_team_member/page";
-export type Req = {
-    creationOid: MongoDBId;
-    page: number;
-    perPage: number;
-};
-export type Res = PagesRes<Record<string, never>>;
-/**
- * 获取历史团队成员分页
- * 不知道怎么用
- * @param {MongoDBId} creationOid 作品id
- * @param {Partial<PageArgs<string | T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 历史团队成员分页列表
- */
-export declare function getHistoricalTeamMemberPage<T extends string>(creationOid: MongoDBId, pageArgs_?: Partial<PageArgs<string | T>>): Promise<Res>;