@ccw-api/api 0.6.0 → 0.7.0

package/dist/types/types/comment.d.ts

@@ -0,0 +1,60 @@
+import { OtherUser } from "./userData";
+export interface Comment {
+    commenter: OtherUser;
+    commenterId: number;
+    /**
+     * 评论内容
+     */
+    content: string;
+    createdAt: number;
+    dislikeCount: number;
+    disliked: boolean;
+    ext: {};
+    hiddenOpinion: null;
+    id: number;
+    likeCount: number;
+    liked: boolean;
+    /**
+     * 如果是评论,则为null,如果是回复,则为回复的评论的id
+     */
+    parentId: number | null;
+    receiver: OtherUser | null;
+    receiverId: number;
+    replyCount: null | number;
+    replyToId: number;
+    reported: boolean;
+    sectionType: "COMMENT";
+    status: "PUBLISHED" | "FOLDED";
+    subComments: [];
+    topic: TopicInfo;
+    /**
+     * 回复的文章/扩展id
+     */
+    topicId: number;
+    updatedAt: number;
+    weight: number;
+}
+export interface TopicInfo extends MinimalTopicInfo {
+    createdAt: number;
+    ext: {
+        /**
+         * 文章uuid可能被包含
+         */
+        slug?: string;
+    };
+    id: number;
+    /**
+     * 文章名称/扩展名称/作品名称
+     */
+    updatedAt: number;
+}
+export type MinimalTopicInfo = {
+    /**
+     * 和响应无关,但至少要传一个字符进去
+     */
+    outline?: string;
+    subjectOid: string;
+    subjectType: SubjectType;
+};
+export type SubjectType = "EXTENSION" | "POST" | "CREATION";
+export type SectionType = "REVIEW" | "COMMENT" | "PROFILE";

package/dist/types/types/creation.d.ts

@@ -0,0 +1,171 @@
+import { MongoDBId, CNameOssUrl } from "./api";
+import { OtherUser, StudentOverview } from "./userData";
+import { AccountTypes } from "./account";
+import { ExtensionStats } from "./extensions";
+export interface CreationRelease {
+    checked: boolean;
+    coverGifLink: CNameOssUrl;
+    coverLink: CNameOssUrl;
+    createdAt: number;
+    customVersion: string;
+    description: string;
+    extensions: string[];
+    hasCloudVariables: boolean;
+    keyboardLayout: KBDLayout;
+    oid: MongoDBId;
+    operatingInstruction: string;
+    profiling: null | string;
+    projectLink: string;
+    status: CreationStatus;
+    submittedAt: number;
+    tags: string[];
+    updatedAt: number;
+    version: string;
+    videoLink: null | string;
+}
+export interface TeamMemberResp {
+    authority: string;
+    avatar: string;
+    createdAt: number;
+    creationOid: MongoDBId;
+    name: string;
+    online: null | boolean;
+    priority: number;
+    profile: null | string;
+    role: string;
+    userOid: MongoDBId;
+}
+export interface TeamworkStatus {
+    currentTeamMemberList: TeamMemberResp[];
+    online: boolean;
+}
+export interface CreationSimple extends CreationMinimal {
+    artifactType: string;
+    createdAt: number;
+    currentReleaseOid: MongoDBId;
+    description: string;
+    ext: {
+        SUBMIT_HASH_TAGS: string[];
+        keyboardLayout: KBDLayout;
+        requireLogin: boolean;
+    };
+    featuredCoverLink: string;
+    forEveryone: boolean;
+    hashTags: string[];
+    isOpenSource: boolean;
+    isTeamwork: boolean;
+    keyboardLayout: KBDLayout;
+    lastPassedAt: number;
+    latestProjectLink: string;
+    operatedAt: number;
+    rank: string;
+    requireLogin: boolean;
+    screenMode: CreationScreenMode;
+    sourceOpenLevel: SourceOpenLevel;
+    status: CreationStatus;
+    student: StudentOverview;
+    studentOid: MongoDBId;
+    tags: string[];
+    teamMemberRespList: TeamMemberResp[];
+    type: string;
+    updatedAt: number;
+    /**
+     * ALL: 所有人可见
+     * PRIVATE: 仅自己可见
+     */
+    visibleScope: "PRIVATE" | "ALL";
+}
+export interface Creation extends CreationSimple {
+    creationReleaseList: CreationRelease[];
+    currentHashTag: null | string;
+    eid: null | string;
+    firstPublishedRelease: null | CreationRelease;
+    isSelf: null | boolean;
+    projectLastModifiedAt: null | number;
+    remixCreationOid: null | MongoDBId;
+    remixedCreation: null | object;
+    repostedSource: null | object;
+    stats: null | ExtensionStats;
+    student: StudentOverview;
+    teamworkStatus: null | TeamworkStatus;
+    typicalProjectId: null | string;
+}
+export interface CreationTag {
+    code: string;
+    createdAt: number;
+    id: number;
+    priority: number;
+    title: string;
+    updatedAt: number;
+    visibility: "PUBLIC";
+}
+export interface LoadingTip {
+    妮可: string[];
+    孙小弟: string[];
+    小八: string[];
+    胖达: string[];
+}
+export interface UserLikeDetail {
+    action: LikeActions;
+    createdAt: number;
+    /**
+     * 作品id
+     */
+    creationOid: MongoDBId;
+    oid: MongoDBId;
+    /**
+     * 一般为作品作者
+     */
+    receiverOid: MongoDBId;
+    /**
+     * 用户id
+     */
+    senderOid: MongoDBId;
+}
+export type LikeActions = "SIX" | "HEART" | "HANDSHAKE" | "LIKE" | "SMILE" | "FLOWER" | "WATERMELON";
+export interface DonatedRecord {
+    bucks: number;
+    createdAt: number;
+    creationOid: MongoDBId;
+    donatorAvatar: CNameOssUrl;
+    donatorName: string;
+    donatorOid: MongoDBId;
+    donatorType: AccountTypes;
+    id: number;
+    updatedAt: number;
+}
+export interface CreationScreenshot {
+    commenter: OtherUser;
+    commenterId: number;
+    createdAt: number;
+    creationScreenshot: CNameOssUrl;
+    ext: {};
+    id: number;
+    msg: string;
+    status: null;
+    topicId: number;
+    updatedAt: number;
+    weight: number;
+}
+export interface FavoriteDetail {
+    creationOid: MongoDBId;
+    favoritedAt: number;
+    studentOid: MongoDBId;
+    updatedAt: number;
+}
+export interface CreationMinimal {
+    commentCount: number;
+    creationRelease: CreationRelease;
+    favoriteCount: number;
+    latestCoverLink: string;
+    likeCount: number;
+    oid: MongoDBId;
+    remixedCount: number;
+    title: string;
+    viewCount: number;
+}
+export type CreationScreenMode = "LANDSCAPE";
+export type ReleaseTag = "Alpha" | "Beta" | "RC" | "Release";
+export type KBDLayout = "CUSTOM" | "TOUCH" | "DISABLED";
+export type SourceOpenLevel = "PRIVATE" | "SOURCE_READABLE" | "PUBLIC";
+export type CreationStatus = "PUBLISHED" | "BANNED" | "SUBMITTED" | "REJECTED";

package/dist/types/types/extensions.d.ts

@@ -0,0 +1,60 @@
+import { CNameOssUrl, MongoDBId } from "./api";
+import { ReleaseTag } from "./creation";
+export interface ExtensionStats {
+    averageRating: number;
+    mostApprovedReviewIds: string[];
+    reviewCount: number;
+    reviewTags: string[];
+}
+export interface ExtensionStatsWithCounts extends ExtensionStats {
+    commentCount: number;
+    donateCount: number;
+    favoriteCount: number;
+    likeCount: number;
+    reviewTags: [];
+}
+export interface Extension {
+    activeVersionId: number;
+    cover: CNameOssUrl;
+    createdAt: number;
+    creationId: MongoDBId;
+    description: string;
+    eid: string;
+    icon: "test";
+    id: number;
+    latestProjectCoverLink: null;
+    latestProjectLink: null;
+    name: string;
+    publisher: {
+        avatar: CNameOssUrl;
+        id: MongoDBId;
+        locked: null;
+        nickname: string;
+    };
+    publisherId: MongoDBId;
+    stats: ExtensionStatsWithCounts;
+    updatedAt: number;
+    versions: ExtensionVersion[];
+}
+export interface ExtensionVersion {
+    assetUri: CNameOssUrl;
+    changelog: string;
+    createdAt: number;
+    demos: [];
+    eid: string;
+    id: number;
+    license: null;
+    previews: [CNameOssUrl];
+    projectCoverLink: null;
+    projectLink: CNameOssUrl;
+    readme: string;
+    rejectReason: null;
+    releaseTags: ReleaseTag[];
+    releasedAt: number;
+    status: ExtensionApproveStatus;
+    tags: [];
+    tutorials: [];
+    updatedAt: number;
+    version: string;
+}
+export type ExtensionApproveStatus = "PENDING" | "APPROVED" | "REJECTED";

package/dist/types/types/hashTag.d.ts

@@ -0,0 +1,71 @@
+import { MongoDBId, CNameOssUrl } from "./api";
+import { CreationStatus } from "./creation";
+export type HashTagCreationRank = "ORDINARY";
+export type HashTagCreationStatus = CreationStatus;
+export interface HashTagCreationRelation {
+    blurb: null | string;
+    canAudit: boolean;
+    createdAt: number;
+    creationOid: MongoDBId;
+    hashTagId: number;
+    hashTagIdentifier: string;
+    id: number;
+    lastPublishedAt: number;
+    lastSubmittedAt: number;
+    projectLastModifiedAt: null | number;
+    rank: HashTagCreationRank;
+    status: HashTagCreationStatus;
+    /**
+     * 作品作者id,不是星球管理id
+     */
+    studentOid: MongoDBId;
+    updatedAt: number;
+}
+export type HashTagFollowingStatus = "UNFOLLOWED" | "FOLLOWED" | "BOTH_FOLLOWED";
+export interface HashTagMemberSimple {
+    avatar: CNameOssUrl;
+    followingStatus: HashTagFollowingStatus;
+    name: string;
+    oid: MongoDBId;
+}
+export type HashTagStatus = "ENABLED";
+export type HashTagType = "ORDINARY";
+export interface HashTag {
+    bulletin: string | null;
+    bulletinOperatedAt: number | null;
+    bulletinOperator: HashTagMemberSimple | null;
+    bulletinOperatorOid: MongoDBId | null;
+    commentCount: number | null;
+    coverLink: CNameOssUrl;
+    createdAt: number;
+    creationCount: number;
+    description: string | null;
+    enableApplyManager: boolean | null;
+    enableBatchAudit: boolean | null;
+    favoriteStatus: unknown | null;
+    favoritedStudentCount: number;
+    hashTagScoreStatsResp: unknown | null;
+    id: number;
+    identifier: string;
+    latestFavoritedStudents: HashTagMemberSimple[];
+    managerIds: MongoDBId[];
+    managers: HashTagMemberSimple[];
+    memberCount: number;
+    ownerType: unknown | null;
+    priority: number;
+    recommended: boolean;
+    relatedStarNum: number | null;
+    status: HashTagStatus;
+    type: HashTagType;
+    updatedAt: number;
+}
+export interface HashTagFavorite {
+    createdAt: number;
+    ext: object;
+    hashTagId: number;
+    id: number;
+    lastFavoritedAt: number;
+    studentOid: MongoDBId;
+    unfavoritedAt: number | null;
+    updatedAt: number;
+}

package/dist/types/types/index.d.ts

@@ -0,0 +1,11 @@
+export type * as Account from "./account";
+export type * as Api from "./api";
+export type * as Approval from "./approval";
+export type * as Comment from "./comment";
+export type * as Creation from "./creation";
+export type * as HashTag from "./hashTag";
+export type * as Notification from "./notification";
+export type * as NotificationContent from "./notificationContent";
+export type * as Pages from "./pages";
+export type * as Session from "./session";
+export type * as UserData from "./userData";

package/dist/types/types/notification.d.ts

@@ -1,6 +1,6 @@
-import { CNameOssUrl, MongoDBId } from "src/types/api";
-import { CreationMinimal } from "src/types/creation";
-import { NotificationContent, ContentCategory, SubjectType } from "src/types/notificationContent";
+import { CNameOssUrl, MongoDBId } from "./api";
+import { CreationMinimal } from "./creation";
+import { NotificationContent, ContentCategory, SubjectType } from "./notificationContent";
 export declare enum NotificationGroup {
     CreationInteraction = "CREATION_INTERACTION",
     CommentToMe = "COMMENT_TO_ME",

package/dist/types/types/pages.d.ts

@@ -0,0 +1,37 @@
+export type SortType = "ASC" | "DESC";
+/**
+ * 分页参数
+ */
+export interface PageArgs<SortField extends string> {
+    /**
+     * 当前页码
+     */
+    page: number;
+    /**
+     * 每页数据量
+     */
+    perPage: number;
+    /**
+     * 排序依据
+     *
+     * 这个实际上可以根据返回值的任何键排序
+     */
+    sortField: SortField;
+    /**
+     * 排序方式
+     *
+     * ASC: 升序,
+     * DESC: 降序
+     */
+    sortType: SortType;
+}
+export type PagesRes<Item, SortField = string> = {
+    data: Item[];
+    offset: number;
+    page: number;
+    perPage: number;
+    sortField: SortField;
+    sortType: SortType;
+    totalNum: number;
+    totalPages: number;
+};

package/dist/types/types/session.d.ts

@@ -0,0 +1,38 @@
+import { AccountTypes } from "./account";
+import { MongoDBId } from "./api";
+export interface SessionArea {
+    city: string;
+    country: string;
+    ip: string;
+    province: string;
+}
+export interface StudentSession {
+    area: SessionArea;
+    browser: string;
+    clientCode: "STUDY_COMMUNITY";
+    createdAt: number;
+    currentDevice: boolean;
+    device: string;
+    expireTime: number;
+    extra: string;
+    id: number;
+    ip: string;
+    lastAccessTime: number;
+}
+export interface LoginSession<Extra = string> {
+    accountId: -1;
+    accountObjectId: MongoDBId;
+    accountType: AccountTypes;
+    clientCode: "STUDY_COMMUNITY";
+    createdAt: number;
+    email: null;
+    expireTime: number;
+    extra: Extra;
+    id: number;
+    lastAccessTime: number;
+    orgId: "";
+    scene: null;
+    status: "ENABLED";
+    token: string;
+    urlEncodedFullName: null;
+}

package/dist/types/types/teamwork.d.ts

@@ -0,0 +1,15 @@
+import { CNameOssUrl, MongoDBId } from "./api";
+export type TeamMemberAuthority = "ADMIN" | "MEMBER" | "OBSERVER";
+export type TeamMember = {
+    authority: TeamMemberAuthority;
+    avatar: CNameOssUrl;
+    creationOid: MongoDBId;
+    name: string;
+    /**
+     * 成员贡献信息
+     * @example profile = "开发,美工(偷懒)"
+     */
+    profile: string;
+    role: "ALL";
+    userOid: MongoDBId;
+};