@ccw-api/api 0.10.2 → 0.11.0

package/dist/index-CTK9UFeW.d.cts

@@ -0,0 +1,41 @@
+type Res$1 = {
+    captchaExpired: boolean;
+    errorMsg: string | null;
+    success: boolean;
+};
+/**
+ * 校验图形验证码（拼图滑块坐标）
+ * @param {string} token createCaptcha 返回的 token
+ * @param {number} x 拼图滑块目标位置的 x 坐标
+ * @param {number} y 拼图滑块目标位置的 y 坐标
+ * @returns {Promise<Res>} 校验结果
+ */
+declare function checkCaptcha(token: string, x: number, y?: number): Promise<Res$1>;
+
+type CaptchaType = "BLOCK_PUZZLE";
+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用于后续校验
+ */
+declare function createCaptcha(type?: CaptchaType): Promise<Res>;
+
+declare const opParentApi: {
+    createCaptcha: typeof createCaptcha;
+    checkCaptcha: typeof checkCaptcha;
+};
+
+export { checkCaptcha as a, createCaptcha as c, opParentApi as o };

package/dist/index-CTK9UFeW.d.ts

@@ -0,0 +1,41 @@
+type Res$1 = {
+    captchaExpired: boolean;
+    errorMsg: string | null;
+    success: boolean;
+};
+/**
+ * 校验图形验证码（拼图滑块坐标）
+ * @param {string} token createCaptcha 返回的 token
+ * @param {number} x 拼图滑块目标位置的 x 坐标
+ * @param {number} y 拼图滑块目标位置的 y 坐标
+ * @returns {Promise<Res>} 校验结果
+ */
+declare function checkCaptcha(token: string, x: number, y?: number): Promise<Res$1>;
+
+type CaptchaType = "BLOCK_PUZZLE";
+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用于后续校验
+ */
+declare function createCaptcha(type?: CaptchaType): Promise<Res>;
+
+declare const opParentApi: {
+    createCaptcha: typeof createCaptcha;
+    checkCaptcha: typeof checkCaptcha;
+};
+
+export { checkCaptcha as a, createCaptcha as c, opParentApi as o };

package/dist/index-CYQhPzUX.d.ts

@@ -0,0 +1,108 @@
+import { P as PageArgs, a as PagesRes, S as SortType } from './pages-BgT6bhJd.js';
+import { M as MongoDBId, C as CNameOssUrl } from './api-eD9o12yg.js';
+
+type Res$2 = number;
+/**
+ * 获取服务端当前时间戳
+ * @returns {Promise<Res>} 当前时间戳（毫秒）
+ */
+declare function getCurrentTimestamp(): Promise<Res$2>;
+
+type BulletinItem = {
+    createdAt: number;
+    id: number;
+    publishedAt: number;
+    status: "PUBLISHED";
+    title: string;
+    updatedAt: number;
+};
+type SortField = "publishedAt";
+type Res$1 = PagesRes<BulletinItem>;
+/**
+ * 获取公告分页列表
+ * @param {'PUBLISHED' | S} status 公告状态过滤
+ * @param {Partial<PageArgs<SortField | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 公告分页列表
+ */
+declare function getBulletinsPage<T extends string, S extends string>(status?: "PUBLISHED" | S, pageArgs_?: Partial<PageArgs<SortField | T>>): Promise<Res$1>;
+
+type BulletinDetail = {
+    createdAt: number;
+    id: number;
+    publishedAt: number;
+    status: "PUBLISHED";
+    title: string;
+    updatedAt: number;
+};
+type Res = BulletinDetail;
+/**
+ * 获取公告详情
+ * @param {number} id 公告id
+ * @returns {Promise<Res>} 公告详情
+ */
+declare function getBulletinDetail(id: number): Promise<Res>;
+
+type SubmitRes = boolean;
+type LeaderboardUser = {
+    avatar: null | CNameOssUrl;
+    id: MongoDBId;
+    locked: null | boolean;
+    nickname: null | string;
+};
+type LeaderboardRecord = {
+    createdAt: number;
+    ext: string;
+    leaderboardOid: MongoDBId;
+    oid: MongoDBId;
+    ranking: number;
+    score: number;
+    updatedAt: number;
+    user: LeaderboardUser;
+    userId: MongoDBId;
+};
+type ScoreFormat = "DECIMAL_WITH_SEPARATOR" | string;
+type ScoreStorageRule = "BEST" | string;
+type StatsCycle = "ALL_DAYS" | string;
+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>} 是否提交成功
+ */
+declare function submitLeaderboardRecord(leaderboardOid: MongoDBId, score: number, userOid: MongoDBId, ext?: string): Promise<SubmitRes>;
+/**
+ * 获取作品排行榜记录列表
+ * @param {MongoDBId} leaderboardOid 排行榜id
+ * @returns {Promise<LeaderboardRecordsRes>} 排行榜记录列表
+ */
+declare function getLeaderboardRecords(leaderboardOid: MongoDBId): Promise<LeaderboardRecordsRes>;
+
+declare const gandiMain: {
+    getCurrentTimestamp: typeof getCurrentTimestamp;
+    getBulletinsPage: typeof getBulletinsPage;
+    getBulletinDetail: typeof getBulletinDetail;
+    submitLeaderboardRecord: typeof submitLeaderboardRecord;
+    getLeaderboardRecords: typeof getLeaderboardRecords;
+};
+
+export { getBulletinsPage as a, getBulletinDetail as b, getLeaderboardRecords as c, gandiMain as d, getCurrentTimestamp as g, submitLeaderboardRecord as s };

package/dist/index-Ci0X9uqV.d.cts

@@ -0,0 +1,108 @@
+import { P as PageArgs, a as PagesRes, S as SortType } from './pages-BgT6bhJd.cjs';
+import { M as MongoDBId, C as CNameOssUrl } from './api-eD9o12yg.cjs';
+
+type Res$2 = number;
+/**
+ * 获取服务端当前时间戳
+ * @returns {Promise<Res>} 当前时间戳（毫秒）
+ */
+declare function getCurrentTimestamp(): Promise<Res$2>;
+
+type BulletinItem = {
+    createdAt: number;
+    id: number;
+    publishedAt: number;
+    status: "PUBLISHED";
+    title: string;
+    updatedAt: number;
+};
+type SortField = "publishedAt";
+type Res$1 = PagesRes<BulletinItem>;
+/**
+ * 获取公告分页列表
+ * @param {'PUBLISHED' | S} status 公告状态过滤
+ * @param {Partial<PageArgs<SortField | T>>} pageArgs_ 分页参数
+ * @returns {Promise<Res>} 公告分页列表
+ */
+declare function getBulletinsPage<T extends string, S extends string>(status?: "PUBLISHED" | S, pageArgs_?: Partial<PageArgs<SortField | T>>): Promise<Res$1>;
+
+type BulletinDetail = {
+    createdAt: number;
+    id: number;
+    publishedAt: number;
+    status: "PUBLISHED";
+    title: string;
+    updatedAt: number;
+};
+type Res = BulletinDetail;
+/**
+ * 获取公告详情
+ * @param {number} id 公告id
+ * @returns {Promise<Res>} 公告详情
+ */
+declare function getBulletinDetail(id: number): Promise<Res>;
+
+type SubmitRes = boolean;
+type LeaderboardUser = {
+    avatar: null | CNameOssUrl;
+    id: MongoDBId;
+    locked: null | boolean;
+    nickname: null | string;
+};
+type LeaderboardRecord = {
+    createdAt: number;
+    ext: string;
+    leaderboardOid: MongoDBId;
+    oid: MongoDBId;
+    ranking: number;
+    score: number;
+    updatedAt: number;
+    user: LeaderboardUser;
+    userId: MongoDBId;
+};
+type ScoreFormat = "DECIMAL_WITH_SEPARATOR" | string;
+type ScoreStorageRule = "BEST" | string;
+type StatsCycle = "ALL_DAYS" | string;
+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>} 是否提交成功
+ */
+declare function submitLeaderboardRecord(leaderboardOid: MongoDBId, score: number, userOid: MongoDBId, ext?: string): Promise<SubmitRes>;
+/**
+ * 获取作品排行榜记录列表
+ * @param {MongoDBId} leaderboardOid 排行榜id
+ * @returns {Promise<LeaderboardRecordsRes>} 排行榜记录列表
+ */
+declare function getLeaderboardRecords(leaderboardOid: MongoDBId): Promise<LeaderboardRecordsRes>;
+
+declare const gandiMain: {
+    getCurrentTimestamp: typeof getCurrentTimestamp;
+    getBulletinsPage: typeof getBulletinsPage;
+    getBulletinDetail: typeof getBulletinDetail;
+    submitLeaderboardRecord: typeof submitLeaderboardRecord;
+    getLeaderboardRecords: typeof getLeaderboardRecords;
+};
+
+export { getBulletinsPage as a, getBulletinDetail as b, getLeaderboardRecords as c, gandiMain as d, getCurrentTimestamp as g, submitLeaderboardRecord as s };