@ccw-api/api 0.4.2 → 0.5.0

package/dist/types/community-web/user_package/user_product.d.ts

@@ -0,0 +1,40 @@
+import { MongoDBId, CNameOssUrl } from "src/types/api";
+import { PagesRes, PageArgs } from "src/types/pages";
+import { AccountTypes } from "src/types/account";
+export declare const url = "https://community-web.ccw.site/user_package/user_product";
+export type Req = {
+    page: number;
+    perPage: number;
+    productCategory: number;
+    sortType: "ASC" | "DESC";
+};
+export type Res = PagesRes<UserProduct>;
+export type UserProduct = {
+    createdAt: number | null;
+    description: string;
+    exchangeOrderId: string | null;
+    expiredAt: number | null;
+    id: number;
+    isExpire: boolean;
+    name: string;
+    picUrl: CNameOssUrl;
+    productCategory: number;
+    productOid: MongoDBId;
+    productSource: null;
+    status: boolean;
+    updatedAt: number | null;
+    userOid: MongoDBId;
+    userType: AccountTypes;
+    validFrom: number;
+    virtualValue: CNameOssUrl;
+};
+export declare enum ProductCategory {
+    AVATAR_FRAME = 5
+}
+/**
+ * 分页获取用户商品（如头像框）
+ * @param {ProductCategory} productCategory 商品分类，默认5为头像框
+ * @param {Partial<PageArgs<SortField>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 分页用户商品数据
+ */
+export declare function getUserProductsPage<SortField extends string>(productCategory?: ProductCategory, pageArgs_?: Partial<PageArgs<SortField>>): Promise<Res>;

package/dist/types/community-web-cloud-database/cloud_variable/save.d.ts

@@ -0,0 +1,26 @@
+import { MongoDBId } from "src/types/api";
+export declare const url = "https://community-web-cloud-database.ccw.site/cloud_variable/save";
+export type SaveCloudVariableReq<T extends Record<string, unknown>> = {
+    primaryKey: string;
+    secondaryKey: string;
+    value: T;
+};
+export type SaveCloudVariableRes<T extends Record<string, unknown>> = T;
+/**
+ * 保存作品云变量到云数据库
+ * @param {MongoDBId} projectId 作品id
+ * @param {string} secondaryKey 次级键 - 变量名或标识
+ * @param {T} value 要保存数据
+ * @returns {Promise<SaveCloudVariableRes<T>>} 保存后的值对象
+ */
+export declare function saveProjectCloudVariable<T extends string>(projectId: MongoDBId, secondaryKey: string, value: T): Promise<SaveCloudVariableRes<{
+    v: T;
+}>>;
+/**
+ * 保存数据到用户云数据库
+ * @param {MongoDBId} projectId 作品id
+ * @param {number} studentNum 次级键 - 用户id
+ * @param {T} value 要保存的键值对
+ * @returns {Promise<SaveCloudVariableRes<T>>} 保存后的值对象
+ */
+export declare function saveUserCloudVariable<T extends Record<string, string>>(projectId: MongoDBId, studentNum: number, value: T): Promise<SaveCloudVariableRes<T>>;

package/dist/types/community-web-cloud-database/index.d.ts

@@ -0,0 +1,5 @@
+import { saveProjectCloudVariable, saveUserCloudVariable } from "./cloud_variable/save";
+export declare const communityWebCloudDatabase: {
+    saveProjectCloudVariable: typeof saveProjectCloudVariable;
+    saveUserCloudVariable: typeof saveUserCloudVariable;
+};

package/dist/types/gandi-main/creation/leaderboards/{oid}/records.d.ts

@@ -0,0 +1,62 @@
+import { CNameOssUrl, MongoDBId } from "src/types/api";
+import { SortType } from "src/types/pages";
+export declare const url = "https://gandi-main.ccw.site/creation/leaderboards";
+export type SubmitReq = {
+    ext: string;
+    oid: MongoDBId;
+    score: number;
+};
+export type SubmitRes = boolean;
+export type LeaderboardUser = {
+    avatar: null | CNameOssUrl;
+    id: MongoDBId;
+    locked: null | boolean;
+    nickname: null | string;
+};
+export type LeaderboardRecord = {
+    createdAt: number;
+    ext: string;
+    leaderboardOid: MongoDBId;
+    oid: MongoDBId;
+    ranking: number;
+    score: number;
+    updatedAt: number;
+    user: LeaderboardUser;
+    userId: MongoDBId;
+};
+export type ScoreFormat = "DECIMAL_WITH_SEPARATOR" | string;
+export type ScoreStorageRule = "BEST" | string;
+export type StatsCycle = "ALL_DAYS" | string;
+export type LeaderboardRecordsRes = {
+    coverLink: null | CNameOssUrl;
+    createdAt: number;
+    creationId: MongoDBId;
+    curUserLeaderboardRecord: null | LeaderboardRecord;
+    displayLines: number;
+    leaderboardRecordTotalNum: number;
+    leaderboardRecords: LeaderboardRecord[];
+    oid: MongoDBId;
+    scoreFormat: ScoreFormat;
+    scoreStorageRule: ScoreStorageRule;
+    scoreUnit: string;
+    showPersonalRanking: boolean;
+    sortType: SortType;
+    statsCycle: StatsCycle;
+    title: string;
+    updatedAt: number;
+};
+/**
+ * 向作品排行榜提交一条分数记录
+ * @param {MongoDBId} leaderboardOid 排行榜id
+ * @param {number} score 分数
+ * @param {MongoDBId} userOid 用户id
+ * @param {string} ext 扩展信息（可选）
+ * @returns {Promise<SubmitRes>} 是否提交成功
+ */
+export declare function submitLeaderboardRecord(leaderboardOid: MongoDBId, score: number, userOid: MongoDBId, ext?: string): Promise<SubmitRes>;
+/**
+ * 获取作品排行榜记录列表
+ * @param {MongoDBId} leaderboardOid 排行榜id
+ * @returns {Promise<LeaderboardRecordsRes>} 排行榜记录列表
+ */
+export declare function getLeaderboardRecords(leaderboardOid: MongoDBId): Promise<LeaderboardRecordsRes>;

package/dist/types/gandi-main/index.d.ts

@@ -1,8 +1,11 @@
 import { getCurrentTimestamp } from "./timestamp/current";
 import { getBulletinsPage } from "./bulletins/page";
 import { getBulletinDetail } from "./bulletins/detail";
+import { getLeaderboardRecords, submitLeaderboardRecord } from "./creation/leaderboards/{oid}/records";
 export declare const gandiMain: {
     getCurrentTimestamp: typeof getCurrentTimestamp;
     getBulletinsPage: typeof getBulletinsPage;
     getBulletinDetail: typeof getBulletinDetail;
+    submitLeaderboardRecord: typeof submitLeaderboardRecord;
+    getLeaderboardRecords: typeof getLeaderboardRecords;
 };

package/dist/types/index.d.ts

@@ -2,13 +2,17 @@ import { sso } from "./sso/index";
 import { communityWeb } from "./community-web";
 import { gandiMain } from "./gandi-main";
 import { bfsWeb } from "./bfs-web";
-export { sso, communityWeb, gandiMain, bfsWeb };
+import { communityWebCloudDatabase } from "./community-web-cloud-database";
+import { opParentApi } from "./op-parent-api";
+export { sso, communityWeb, gandiMain, bfsWeb, communityWebCloudDatabase, opParentApi, };
 export { setToken } from "@ccw-api/axios";
 declare const _default: {
     sso: {
         loginByPassword: typeof import("./sso/web/auth/login-by-password").loginByPassword;
         logout: typeof import("./sso/web/auth/logout").logout;
         logoutBySession: typeof import("./sso/web/auth/logout_by_session").logoutBySession;
+        createSmsCaptcha: typeof import("./sso/web/auth/assistant/captcha/v2/create").createSmsCaptcha;
+        loginByPhone: typeof import("./sso/web/auth/v3/login/by-phone").loginByPhone;
     };
     communityWeb: {
         acceptAward: typeof import("./community-web/task/award").acceptAward;
@@ -70,6 +74,7 @@ declare const _default: {
         getRemixedCreationPage: typeof import("./community-web/creation/page").getRemixedCreationPage;
         getReputationScoreLogPage: typeof import("./community-web/students/reputation_score_log/page").getReputationScoreLog;
         getSearchHotWords: typeof import("./community-web/search/hot_words").getSearchHotWords;
+        getSmartContractList: typeof import("./community-web/smart_contract/list").getSmartContractList;
         getSplitRuleDetail: typeof import("./community-web/creation/smart_contract/split_rule/detail").getSplitRuleDetail;
         getSpreadFeedUnreadCount: typeof import("./community-web/study-community/spread_feed/unread/count").getSpreadFeedUnreadCount;
         getStudentBlockRecordDetail: typeof import("./community-web/student/block_record/detail").getStudentBlockRecordDetail;
@@ -93,6 +98,7 @@ declare const _default: {
         getUserAssetStorageSize: typeof import("./community-web/cloud_asset/user/privacy").getUserAssetStorageSize;
         getUserCardDetail: typeof import("./community-web/user-card/detail").getUserCardDetail;
         getUserLabelList: typeof import("./community-web/user_label/list").getUserLabelList;
+        getUserProductsPage: typeof import("./community-web/user_package/user_product").getUserProductsPage;
         getCreationsByStudent: typeof import("./community-web/creation/page_by_student").getCreationsByStudent;
         insertCheckInRecord: typeof import("./community-web/check_in_record/insert").insertCheckInRecord;
         likeComment: typeof import("./community-web/comment/like_record/create").likeComment;
@@ -101,9 +107,11 @@ declare const _default: {
         searchCloudAssets: typeof import("./community-web/cloud_asset/search").searchCloudAssets;
         searchCreationsByTag: typeof import("./community-web/creation/search/page").searchCreationsByTag;
         sendEvent: typeof import("./community-web/event").sendEvent;
+        setUserProductStatus: typeof import("./community-web/user_package/status").setUserProductStatus;
         submitCreation: typeof import("./community-web/creation/submit").submitCreation;
         topComment: typeof import("./community-web/study-community/comment/top").topComment;
         updateCreation: typeof import("./community-web/creation/update").updateCreation;
+        updateGreatCreation: typeof import("./community-web/great_creation/update").updateGreatCreation;
         updateStudent: typeof import("./community-web/students/update").updateStudent;
         viewCreationStats: typeof import("./community-web/creation_stats/view").viewCreationStats;
     };
@@ -111,11 +119,21 @@ declare const _default: {
         getCurrentTimestamp: typeof import("./gandi-main/timestamp/current").getCurrentTimestamp;
         getBulletinsPage: typeof import("./gandi-main/bulletins/page").getBulletinsPage;
         getBulletinDetail: typeof import("./gandi-main/bulletins/detail").getBulletinDetail;
+        submitLeaderboardRecord: typeof import("./gandi-main/creation/leaderboards/{oid}/records").submitLeaderboardRecord;
+        getLeaderboardRecords: typeof import("./gandi-main/creation/leaderboards/{oid}/records").getLeaderboardRecords;
     };
     bfsWeb: {
         donateExtension: typeof import("./bfs-web/extensions/{eid}/donate").donateExtension;
         getUserExtensions: typeof import("./bfs-web/users/{oid}/extensions").getUserExtensions;
     };
+    communityWebCloudDatabase: {
+        saveProjectCloudVariable: typeof import("./community-web-cloud-database/cloud_variable/save").saveProjectCloudVariable;
+        saveUserCloudVariable: typeof import("./community-web-cloud-database/cloud_variable/save").saveUserCloudVariable;
+    };
+    opParentApi: {
+        createCaptcha: typeof import("./op-parent-api/captcha/create").createCaptcha;
+        checkCaptcha: typeof import("./op-parent-api/captcha/check").checkCaptcha;
+    };
 };
 export default _default;
 export type * from "./types";

package/dist/types/op-parent-api/captcha/check.d.ts

@@ -0,0 +1,21 @@
+export declare const url = "https://op-parent-api.xiguacity.cn/captcha/check";
+export type Req = {
+    data: {
+        x: number;
+        y: number;
+    };
+    token: string;
+};
+export type Res = {
+    captchaExpired: boolean;
+    errorMsg: string | null;
+    success: boolean;
+};
+/**
+ * 校验图形验证码（拼图滑块坐标）
+ * @param {string} token createCaptcha 返回的 token
+ * @param {number} x 拼图滑块目标位置的 x 坐标
+ * @param {number} y 拼图滑块目标位置的 y 坐标
+ * @returns {Promise<Res>} 校验结果
+ */
+export declare function checkCaptcha(token: string, x: number, y?: number): Promise<Res>;

package/dist/types/op-parent-api/captcha/create.d.ts

@@ -0,0 +1,24 @@
+export declare const url = "https://op-parent-api.xiguacity.cn/captcha/create";
+export type CaptchaType = "BLOCK_PUZZLE";
+export type Req = {
+    type: CaptchaType;
+};
+export type Res = {
+    data: {
+        /**
+         * data url
+         */
+        bgImg: string;
+        /**
+         * data url
+         */
+        jigsawImg: string;
+    };
+    token: string;
+};
+/**
+ * 创建图形验证码（拼图滑块）
+ * @param {CaptchaType} type 验证码类型,默认 BLOCK_PUZZLE（滑块拼图）
+ * @returns {Promise<Res>} 验证码信息:bgImg为背景图base64 data url,jigsawImg为拼图块base64 data url,token用于后续校验
+ */
+export declare function createCaptcha(type?: CaptchaType): Promise<Res>;

package/dist/types/op-parent-api/index.d.ts

@@ -0,0 +1,6 @@
+import { createCaptcha } from "./captcha/create";
+import { checkCaptcha } from "./captcha/check";
+export declare const opParentApi: {
+    createCaptcha: typeof createCaptcha;
+    checkCaptcha: typeof checkCaptcha;
+};

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

@@ -1,8 +1,12 @@
 import { loginByPassword } from "./web/auth/login-by-password";
 import { logout } from "./web/auth/logout";
 import { logoutBySession } from "./web/auth/logout_by_session";
+import { createSmsCaptcha } from "./web/auth/assistant/captcha/v2/create";
+import { loginByPhone } from "./web/auth/v3/login/by-phone";
 export declare const sso: {
     loginByPassword: typeof loginByPassword;
     logout: typeof logout;
     logoutBySession: typeof logoutBySession;
+    createSmsCaptcha: typeof createSmsCaptcha;
+    loginByPhone: typeof loginByPhone;
 };

package/dist/types/sso/web/auth/assistant/captcha/v2/create.d.ts

@@ -0,0 +1,34 @@
+export declare const url = "https://sso.ccw.site/web/auth/assistant/captcha/v2/create";
+export type SmsScene = "loginbyPhone";
+export type SmsRuleCode = "ccw_sms";
+export type CaptchaPayload = {
+    data: {
+        x: number;
+        y: number;
+    };
+    token: string;
+};
+export type Req = {
+    captcha?: CaptchaPayload;
+    countryCode: string;
+    recipient: string;
+    ruleCode: SmsRuleCode;
+    scene: SmsScene;
+};
+export type Res = {
+    batchId: string | null;
+    /**
+     * sendResult=1 表示成功
+     */
+    sendResult: 1 | 2;
+};
+/**
+ * 发送短信验证码
+ * @param {string} recipient 接收手机号，如 "10011451919"
+ * @param {SmsScene} scene 场景，默认 loginbyPhone
+ * @param {string} countryCode 国家代码，默认 "86"
+ * @param {SmsRuleCode} ruleCode 短信规则编码，默认 "ccw_sms"
+ * @param {CaptchaPayload} captcha 图形验证码校验结果（滑块拼图的坐标与token），可选（部分场景未强制要求时可省略，但失败时sendResult!=1）
+ * @returns {Promise<Res>} 发送结果：batchId 为短信批次ID，sendResult=1 表示成功
+ */
+export declare function createSmsCaptcha(recipient: string, scene?: SmsScene, countryCode?: string, ruleCode?: SmsRuleCode, captcha?: CaptchaPayload): Promise<Res>;

package/dist/types/sso/web/auth/login-by-password.d.ts

@@ -1,5 +1,5 @@
-import { AccountTypes } from "src/types/account";
 import { MongoDBId } from "src/types/api";
+import { LoginSession } from "src/types/session";
 export declare const url = "https://sso.ccw.site/web/auth/login-by-password";
 export type Req = {
     clientCode: "STUDY_COMMUNITY";
@@ -7,23 +7,7 @@ export type Req = {
     loginKey: string;
     password: string;
 };
-export type Res<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;
-};
+export type Res<Extra> = LoginSession<Extra>;
 export type Extra = {
     browser: string;
     device: string;

package/dist/types/sso/web/auth/v3/login/by-phone.d.ts

@@ -0,0 +1,38 @@
+import { MongoDBId } from "src/types/api";
+import { LoginSession } from "src/types/session";
+export declare const url = "https://sso.ccw.site/web/auth/v3/login/by_phone";
+export type LoginClientCode = "STUDY_COMMUNITY";
+export type LoginScene = "loginbyPhone";
+export type LoginRuleCode = "ccw_sms";
+export type Req = {
+    clientCode: LoginClientCode;
+    code: string;
+    countryCode: string;
+    extra: string;
+    phone: string;
+    ruleCode: LoginRuleCode;
+    scene: LoginScene;
+};
+export type Res<Extra> = LoginSession<Extra>;
+export type Extra = {
+    browser: string;
+    device: string;
+    ip: string;
+    loginParentOid: MongoDBId;
+    loginType: "BY_PHONE_LOGIN_OR_REGISTER";
+};
+export interface ReqExtra {
+    browser: string;
+    device: string;
+}
+/**
+ * 通过手机号+短信验证码登录（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 declare function loginByPhone(phone: string, code: string, reqExtra?: ReqExtra, countryCode?: string, ruleCode?: LoginRuleCode, scene?: LoginScene): Promise<Res<Extra>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ccw-api/api",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "description": "ccw api collections",
   "license": "MIT",
   "author": "Meng Fuzi",