@ccw-api/api 0.7.0 → 0.8.0

package/dist/esm/sso/web/auth/logout.js

@@ -1,11 +0,0 @@
-import { ccwAxios } from "@ccw-api/axios";
-export const url = "https://sso.ccw.site/web/auth/logout";
-/**
- * 退出
- * @returns {Promise<null>}
- */
-export async function logout() {
-    return await ccwAxios
-        .post(url, {})
-        .then((res) => res.data.body);
-}

package/dist/esm/sso/web/auth/logout_by_session.js

@@ -1,12 +0,0 @@
-import { ccwAxios } from "@ccw-api/axios";
-export const url = "https://sso.ccw.site/web/auth/logout_by_session";
-/**
- * 根据sessionId退出登陆设备
- * @param {number} sessionId
- * @returns {Promise<boolean>} 是否成功
- */
-export async function logoutBySession(sessionId) {
-    return await ccwAxios
-        .post(url, { id: sessionId })
-        .then((res) => res.data.body);
-}

package/dist/esm/sso/web/auth/v3/login/by-phone.js

@@ -1,33 +0,0 @@
-import { ccwAxios } from "@ccw-api/axios";
-export const url = "https://sso.ccw.site/web/auth/v3/login/by_phone";
-/**
- * 通过手机号+短信验证码登录（V3）
- * @param {string} phone 手机号，如 "12345671145"
- * @param {string} code 收到的短信验证码
- * @param {ReqExtra} reqExtra 设备和浏览器信息
- * @param {string} countryCode 国家代码，默认 "86"
- * @param {LoginRuleCode} ruleCode 短信规则编码，默认 "ccw_sms"
- * @param {LoginScene} scene 登录场景，默认 "loginbyPhone"
- * @returns {Promise<Res<Extra>>} session 信息
- */
-export async function loginByPhone(phone, code, reqExtra = {
-    device: "Node",
-    browser: "Node.js",
-}, countryCode = "86", ruleCode = "ccw_sms", scene = "loginbyPhone") {
-    const { extra, ...restBody } = await ccwAxios
-        .post(url, {
-        phone,
-        code,
-        countryCode,
-        ruleCode,
-        scene,
-        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/esm/types/account.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/api.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/approval.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/comment.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/creation.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/extensions.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/hashTag.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/index.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/notification.js

@@ -1,7 +0,0 @@
-export var NotificationGroup;
-(function (NotificationGroup) {
-    NotificationGroup["CreationInteraction"] = "CREATION_INTERACTION";
-    NotificationGroup["CommentToMe"] = "COMMENT_TO_ME";
-    NotificationGroup["FriendShare"] = "FRIEND_SHARE";
-    NotificationGroup["WebSystem"] = "WEB_SYSTEM";
-})(NotificationGroup || (NotificationGroup = {}));

package/dist/esm/types/notificationContent.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/pages.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/session.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/teamwork.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/userData.js

@@ -1 +0,0 @@
-export {};

package/dist/node/bfs-web/extensions/{eid}/donate.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.donateExtension = donateExtension;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://bfs-web.ccw.site/extensions";
-/**
- * 向扩展投币
- * @param {ExtensionDonateEid} eid 扩展id
- * @param {number} bucks 捐赠金币数量
- * @returns {Promise<Res>} 是否捐赠成功
- */
-async function donateExtension(eid, bucks) {
-    const req = { eid, bucks };
-    return await axios_1.ccwAxios
-        .post(`${exports.url}/${eid}/donate`, req)
-        .then((res) => res.data.body);
-}

package/dist/node/bfs-web/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.bfsWeb = void 0;
-const extensions_1 = require("./users/{oid}/extensions");
-const donate_1 = require("./extensions/{eid}/donate");
-exports.bfsWeb = {
-    donateExtension: donate_1.donateExtension,
-    getUserExtensions: extensions_1.getUserExtensions,
-};

package/dist/node/bfs-web/users/{oid}/extensions.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getUserExtensions = getUserExtensions;
-const axios_1 = require("@ccw-api/axios");
-const queryPages_1 = require("../../../queryPages");
-exports.url = "https://bfs-web.ccw.site/users";
-/**
- * 获取用户扩展列表分页
- * @param {MongoDBId} userOid 用户id
- * @param {Partial<PageArgs<"createdAt" | "updatedAt" | T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 扩展分页列表
- */
-async function getUserExtensions(userOid, pageArgs_ = {
-    sortField: "updatedAt",
-}) {
-    const pageArgs = {
-        ...queryPages_1.DEFAULT_PAGE_ARGS,
-        ...pageArgs_,
-    };
-    const queryUrl = (0, queryPages_1.queryPage)(`${exports.url}/${userOid}/extensions`, pageArgs);
-    return await axios_1.ccwAxios
-        .get(queryUrl)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/api/v1/short_code/encode.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.encodeShortCode = encodeShortCode;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/api/v1/short_code/encode";
-/**
- * 生成作品邀请码
- * @param {MongoDBId} inviterId 邀请人id
- * @param {CNameOssUrl} inviterAvatar 邀请人头像
- * @param {string} inviterName 邀请人用户名
- * @param {MongoDBId} creationOid 作品id
- * @returns {Promise<Res>}
- */
-async function encodeShortCode(inviterId, inviterAvatar, inviterName, creationOid) {
-    const req = {
-        origin: {
-            inviterAvatar,
-            inviterName,
-            inviterId,
-            inviterType: "STUDENT",
-            entrance: "create_detail",
-            creationOid,
-        },
-    };
-    return await axios_1.ccwAxios
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/approval/list.js

@@ -1,23 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getApprovalTags = getApprovalTags;
-const axios_1 = __importDefault(require("@ccw-api/axios"));
-exports.url = "https://community-web.ccw.site/approval/list";
-/**
- * 获取特定用户的勋章数据
- * @param {MongoDBId} studentOid 用户id
- * @returns {Promise<Res<Tid, Tn>>} 勋章数据
- */
-async function getApprovalTags(studentOid) {
-    const req = {
-        objectId: studentOid,
-        objectType: "STUDENT",
-    };
-    return await axios_1.default
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/base/dateTime.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getTime = getTime;
-const axios_1 = __importDefault(require("@ccw-api/axios"));
-exports.url = "https://community-web.ccw.site/base/dateTime";
-/**
- * @returns {Promise<number>} 当前时间戳,相当于Date.now()
- */
-async function getTime() {
-    return axios_1.default
-        .post(exports.url, undefined)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/campaign_resource/detail.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getCampaignResources = getCampaignResources;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/campaign_resource/detail";
-/**
- * 不知道这个接口有什么用,请查看https://www.ccw.site/pages/tags自行寻找用法
- * @param {K} keyword 活动关键词
- * @returns {Promise<Res<K>>}
- */
-async function getCampaignResources(keyword) {
-    return await axios_1.ccwAxios
-        .post(exports.url, { keyword })
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/ccw-main/status.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getCCWMainStatus = getCCWMainStatus;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/ccw-main/status";
-/**
- * ccw-main/status
- * @returns {Promise<Res>} 信息
- */
-async function getCCWMainStatus() {
-    const req = {};
-    return await axios_1.ccwAxios
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/ccw-mall/ccw/product/fe/query.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProductCategory = exports.url = void 0;
-exports.queryMallProducts = queryMallProducts;
-const axios_1 = require("@ccw-api/axios");
-const queryPages_1 = require("../../../../../queryPages");
-exports.url = "https://community-web.ccw.site/ccw-mall/ccw/product/fe/query";
-var ProductCategory;
-(function (ProductCategory) {
-    ProductCategory[ProductCategory["Merchandise"] = 7] = "Merchandise";
-    ProductCategory[ProductCategory["AvatarFrame"] = 5] = "AvatarFrame";
-    ProductCategory[ProductCategory["EMOJI"] = 10] = "EMOJI";
-})(ProductCategory || (exports.ProductCategory = ProductCategory = {}));
-/**
- * 分页查询CCW小商店商品列表
- * @param {ProductCategory | undefined} productCategory 商品分类（可选）：5=头像框，7=周边商品，10=表情 等
- * @param {Partial<PageArgs<ProductSortField>>} pageArgs_ 分页参数（默认 page=1, perPage=30, sortType="DESC"）
- * @returns {Promise<Res>} 商品分页结果 PagesRes<Product>
- */
-async function queryMallProducts(productCategory, pageArgs_ = {
-    sortField: "createdAt",
-}) {
-    const pageArgs = {
-        ...queryPages_1.DEFAULT_PAGE_ARGS,
-        ...pageArgs_,
-    };
-    const queryUrl = (0, queryPages_1.queryPage)(exports.url, pageArgs);
-    const req = {
-        page: pageArgs.page,
-        perPage: pageArgs.perPage,
-        sortType: pageArgs.sortType,
-        productCategory,
-        source: "CCW_OFFICIAL",
-    };
-    return await axios_1.ccwAxios
-        .post(queryUrl, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/check_in_record/detail.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getCheckInRecords = getCheckInRecords;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/check_in_record/detail";
-/**
- * 获取本月签到记录
- */
-async function getCheckInRecords() {
-    const req = { scene: "HOMEPAGE" };
-    return await axios_1.ccwAxios
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/check_in_record/insert.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.insertCheckInRecord = insertCheckInRecord;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/check_in_record/insert";
-/**
- * 插入签到记录（相当于签到）
- * @returns {Promise<boolean>} 是否成功
- */
-async function insertCheckInRecord() {
-    const req = { scene: "HOMEPAGE" };
-    return await axios_1.ccwAxios
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/cloud_asset/search.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.searchCloudAssets = searchCloudAssets;
-const axios_1 = require("@ccw-api/axios");
-const queryPages_1 = require("../../queryPages");
-exports.url = "https://community-web.ccw.site/cloud_asset/search";
-const dpa = {
-    ...queryPages_1.DEFAULT_PAGE_ARGS,
-    sortField: "createdAt",
-};
-/**
- * 获取用户云背包特定目录内素材
- * @param {MongoDBId} creatorOid 用户id
- * @param {string} path 目录(例如'/23azZqHBnqj/2BzzTdi5I5C/')
- * @param {Partial<PageArgs<SortField | T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 目录内的素材分页结果
- */
-async function searchCloudAssets(creatorOid, path = "/", pageArgs_ = {}) {
-    const pageArgs = {
-        ...dpa,
-        ...pageArgs_,
-    };
-    const queryUrl = (0, queryPages_1.queryPage)(exports.url, pageArgs);
-    const req = { creatorOid, path };
-    return await axios_1.ccwAxios
-        .post(queryUrl, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/cloud_asset/user/privacy.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getUserAssetStorageSize = getUserAssetStorageSize;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/cloud_asset/user/privacy";
-/**
- * 获取用户云存储空间信息
- * @returns {Promise<Res>} 存储空间信息
- */
-async function getUserAssetStorageSize() {
-    return await axios_1.ccwAxios
-        .post(exports.url, {})
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/comment/create.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.createComment = createComment;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/comment/create";
-/**
- * 创建评论
- * @param {string} content 评论内容
- * @param {MinimalTopicInfo} topic 主题信息
- * @param {string} sectionType 板块类型
- * @returns {Promise<Res>} 创建的评论
- */
-async function createComment(content, topic, sectionType) {
-    topic.outline ??= "foo";
-    const req = { content, topic, sectionType };
-    return await axios_1.ccwAxios
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/comment/like_record/create.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.likeComment = likeComment;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/comment/like_record/create";
-/**
- * 点赞评论
- * @param {number} commentId 评论id
- * @returns {Promise<Res>} 操作是否成功
- */
-async function likeComment(commentId) {
-    const req = { commentId };
-    return await axios_1.ccwAxios
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/comment/page.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getCommentReplies = getCommentReplies;
-const axios_1 = require("@ccw-api/axios");
-const queryPages_1 = require("../../queryPages");
-exports.url = "https://community-web.ccw.site/comment/page";
-/**
- * 根据topicId获取评论的回复
- * @param {number} topicId 话题id
- * @param {number} parentId 父评论id
- * @param {("PUBLISHED" | "FOLDED")[]} statuses 状态过滤
- * @param {Partial<PageArgs<SortField|T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 评论分页结果
- */
-async function getCommentReplies(topicId, parentId, statuses = ["PUBLISHED", "FOLDED"], pageArgs_ = {
-    sortField: "createdAt",
-}) {
-    const pageArgs = {
-        ...queryPages_1.DEFAULT_PAGE_ARGS,
-        ...pageArgs_,
-    };
-    const queryUrl = (0, queryPages_1.queryPage)(exports.url, pageArgs);
-    const req = { topicId, parentId, statuses };
-    return await axios_1.ccwAxios
-        .post(queryUrl, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/comment/page_by_topic.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getCommentsByTopic = getCommentsByTopic;
-const axios_1 = require("@ccw-api/axios");
-const queryPages_1 = require("../../queryPages");
-exports.url = "https://community-web.ccw.site/comment/page_by_topic";
-const dpa = {
-    ...queryPages_1.DEFAULT_PAGE_ARGS,
-    sortField: "createdAt",
-};
-/**
- * 根据主题获取评论列表
- * @param {string} subjectOid 主题oid
- * @param {SubjectType} subjectType 主题类型 (如: "POST")
- * @param {SectionType} sectionType 区块类型 (如: "COMMENT")
- * @param {Partial<PageArgs<SortField| T>>} pageArgs_ 分页参数
- * @returns {Promise<Res>} 评论分页结果
- */
-async function getCommentsByTopic(subjectOid, subjectType, sectionType, pageArgs_ = {
-    sortField: "createdAt",
-}) {
-    const pageArgs = {
-        ...dpa,
-        ...pageArgs_,
-    };
-    const queryUrl = (0, queryPages_1.queryPage)(exports.url, pageArgs);
-    const req = { subjectOid, subjectType, sectionType };
-    return await axios_1.ccwAxios
-        .post(queryUrl, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/comment/reply.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.replyComment = replyComment;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/comment/reply";
-/**
- *回复评论
- * @param content 回复内容
- * @param replyToId 评论id
- * @returns {Promise<Res>} 回复的评论
- */
-async function replyComment(content, replyToId) {
-    const req = {
-        content,
-        replyToId: `${replyToId}`,
-    };
-    return await axios_1.ccwAxios
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/config/detail.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getConfigDetail = getConfigDetail;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/config/detail";
-/**
- * 获取配置详情
- * @param {string} key 配置键
- * @returns {Promise<Res>} 配置值
- */
-async function getConfigDetail(key) {
-    const req = { key };
-    return await axios_1.ccwAxios
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/creation/detail.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getCreationDetail = getCreationDetail;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/creation/detail";
-/**
- * 获取作品详情
- * @param {MongoDBId} oid 作品id
- * @param {string} accessKey
- * @returns {Promise<Creation>} 作品详情
- */
-async function getCreationDetail(oid, accessKey) {
-    const req = { oid, accessKey };
-    return await axios_1.ccwAxios
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/creation/excellent/list.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getExcellentCreations = getExcellentCreations;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/creation/excellent/list";
-/**
- * 获取精选作品列表
- * @param {number} num 数量
- * @returns {Promise<CreationSimple[]>} 作品列表
- */
-async function getExcellentCreations(num) {
-    const req = { num };
-    return await axios_1.ccwAxios
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/creation/introduction/detail.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getCreationIntroduction = getCreationIntroduction;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/creation/introduction/detail";
-/**
- * 获取用户代表作
- * @param {MongoDBId} studentOid 学生id
- * @returns {Promise<Creation>} 作品详情
- */
-async function getCreationIntroduction(studentOid) {
-    const req = { studentOid };
-    return await axios_1.ccwAxios
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/creation/like/detail.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getLikeDetail = getLikeDetail;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/creation/like/detail";
-/**
- * 获取用户是否曾给作品点赞及点赞动作
- * @param {MongoDBId} creationOid 作品id
- * @returns {Promise<UserLikeDetail>} 点赞详情
- */
-async function getLikeDetail(creationOid) {
-    const req = { creationOid };
-    return await axios_1.ccwAxios
-        .post(exports.url, req)
-        .then((res) => res.data.body);
-}

package/dist/node/community-web/creation/loading/tips.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
-exports.getLoadingTips = getLoadingTips;
-const axios_1 = require("@ccw-api/axios");
-exports.url = "https://community-web.ccw.site/creation/loading/tips";
-/**
- * 获取加载提示语
- * @returns {Promise<LoadingTip>} 加载提示语
- */
-async function getLoadingTips() {
-    return await axios_1.ccwAxios
-        .post(exports.url, {})
-        .then((res) => res.data.body);
-}