finej3 1.0.15 → 2.1.0

package/dist/cjs/clients/main.d.ts

@@ -0,0 +1,442 @@
+import { HttpClient, type Jx3Envelope, type Jx3Options, type EmptyObject } from '../core/http.js';
+import type * as T from '../types/main.js';
+import type { RaidProgress } from '../types/client.js';
+/** 新版主站服务入口。 */
+export declare const MAIN_BASE_URL = "https://nico.nicemoe.cn";
+/** 响应保留 { status, detail }；使用 isSuccess 判断成功后读取业务数据。 */
+export declare class Jx3Api extends HttpClient {
+    constructor(options?: Jx3Options);
+    /** 活动日历。查询每日活动安排及本周秘境、副本信息。 */
+    activeCalendar(params: {
+        mode: 'list';
+        num?: number;
+    }): Promise<Jx3Envelope<T.ActiveCalendarList | EmptyObject>>;
+    activeCalendar(params?: {
+        mode?: 'day';
+        num?: number;
+    }): Promise<Jx3Envelope<T.ActiveCalendarDay | EmptyObject>>;
+    activeCalendar(params: {
+        mode?: 'day' | 'list';
+        num?: number;
+    }): Promise<Jx3Envelope<T.ActiveCalendarDay | T.ActiveCalendarList | EmptyObject>>;
+    /** 地图活动。查询指定地图活动当前及后续的 10 条安排，时间为北京时间。 */
+    activeCelebs(params: {
+        name: "楚天社" | "云从社" | "披风会" | "穹野卫";
+    }): Promise<Jx3Envelope<T.CelebActivity[] | EmptyObject>>;
+    /** 名剑排行。查询名剑大会周排行榜。 */
+    arenaAwesome(params?: {
+        limit?: number | null;
+        mode?: 22 | 33 | 55 | null;
+        node?: string;
+        ticket?: string;
+    }): Promise<Jx3Envelope<T.ArenaAwesomeItem[] | EmptyObject>>;
+    /** 名剑战绩。查询角色名剑大会表现及近期战绩。 */
+    arenaRecent(params: {
+        mode?: 0 | 22 | 33 | 55 | null;
+        name: string;
+        node?: string;
+        server: string;
+        ticket?: string;
+    }): Promise<Jx3Envelope<T.ArenaRecentData | EmptyObject>>;
+    /** 名剑统计。查询各门派的名剑大会周统计。 */
+    arenaSchools(params?: {
+        mode?: 22 | 33 | 55 | null;
+        node?: string;
+        ticket?: string;
+    }): Promise<Jx3Envelope<T.ArenaSchoolItem[] | EmptyObject>>;
+    /** 阵营拍卖。查询阵营拍卖成交记录。 */
+    auctionRecords(params: {
+        limit?: number | null;
+        name?: string;
+        server: string;
+    }): Promise<Jx3Envelope<T.AuctionRecord[] | EmptyObject>>;
+    /** 帮战记录。查询服务器最近 30 场帮战。 */
+    battleRecords(params: {
+        server: string;
+    }): Promise<Jx3Envelope<T.BattleRecord[] | EmptyObject>>;
+    /** DPS 计算。page 默认 pvedps，cycle 省略时使用上游默认循环。需同时检查 detail 内的上游错误。 */
+    calcdCalculate(params: {
+        server: string;
+        name: string;
+        cycle?: string;
+        page?: 'pvedps' | '界pvedps';
+    }): Promise<Jx3Envelope<T.CalcdCalculateData | T.UpstreamErrorDetail | EmptyObject>>;
+    /** 名片缓存。查询已缓存的角色名片。 */
+    cardCached(params: {
+        name: string;
+        server: string;
+    }): Promise<Jx3Envelope<T.CardRecord | EmptyObject>>;
+    /** 名片详情。查询角色名片图片与获赞数。 */
+    cardDetail(params: {
+        name: string;
+        node?: string;
+        server: string;
+        ticket?: string;
+    }): Promise<Jx3Envelope<T.CardPreset | EmptyObject>>;
+    /** 随机名片。随机获取一张角色名片。 */
+    cardRandom(params?: {
+        body?: string | null;
+        force?: string | null;
+        server?: string | null;
+    }): Promise<Jx3Envelope<T.CardRecord | EmptyObject>>;
+    /** 名片记录。查询角色名片。 */
+    cardRecord(params: {
+        name: string;
+        server: string;
+    }): Promise<Jx3Envelope<T.CardRecord | EmptyObject>>;
+    /** 名片历史。查询角色的历史名片。 */
+    cardRecords(params: {
+        like?: boolean;
+        name: string;
+        server: string;
+    }): Promise<Jx3Envelope<T.CardHistoryItem[] | EmptyObject>>;
+    /** 聊天内容。合并补充记录后去重分页，返回记录数组。 */
+    chatContent(params: {
+        server: string;
+        name: string;
+        limit?: number;
+        page?: number;
+    }): Promise<Jx3Envelope<T.ChatContentItem[] | EmptyObject>>;
+    /** 角色聊天。分页查询角色聊天记录。 */
+    chatRecords(params: {
+        limit?: number;
+        name: string;
+        page?: number;
+        server: string;
+    }): Promise<Jx3Envelope<T.ChatRecordsData | EmptyObject>>;
+    /** 今日赤兔。查询今日赤兔预告与出世记录。 */
+    chituRecords(): Promise<Jx3Envelope<T.ChituRecord[]>>;
+    /** 本周赤兔。查询本周赤兔预告与出世记录，每周二 07:00（北京时间）重置。 */
+    chituWeekRecords(): Promise<Jx3Envelope<T.ChituWeekRecords | EmptyObject>>;
+    /** 答案之书。随机获取一条答案和一句鼓励语。 */
+    choiceAnswer(): Promise<Jx3Envelope<T.ChoiceAnswerData | EmptyObject>>;
+    /** 喝什么。随机推荐 2～4 种饮品。 */
+    choiceDrink(): Promise<Jx3Envelope<T.ChoiceDrinkData | EmptyObject>>;
+    /** 吃什么。随机推荐 2～4 种食物。 */
+    choiceFood(): Promise<Jx3Envelope<T.ChoiceFoodData | EmptyObject>>;
+    /** 编辑器。查询编辑器资料。 */
+    editorSearch(params: {
+        name: string;
+        page?: number;
+    }): Promise<Jx3Envelope<T.EditorSearchData | EmptyObject>>;
+    /** 奇遇汇总。汇总服务器近期的奇遇次数及最近触发记录。 */
+    eventCollect(params: {
+        num?: number | null;
+        server: string;
+    }): Promise<Jx3Envelope<T.EventCollectItem[] | EmptyObject>>;
+    /** 近期奇遇。查询服务器最近的奇遇触发记录。 */
+    eventRecent(params: {
+        limit?: number | null;
+        server: string;
+    }): Promise<Jx3Envelope<T.EventRecentItem[] | EmptyObject>>;
+    /** 奇遇记录。查询角色的奇遇触发记录。 */
+    eventRecords(params: {
+        full?: 0 | 1 | null;
+        name: string;
+        server: string;
+    }): Promise<Jx3Envelope<T.EventRecordItem[] | EmptyObject>>;
+    /** 奇遇统计。查询指定奇遇最近的触发记录。 */
+    eventStatistics(params: {
+        limit?: number | null;
+        name: string;
+        server?: string;
+    }): Promise<Jx3Envelope<T.EventStatisticsItem[] | EmptyObject>>;
+    /** 奇遇攻略。查询奇遇的分类和等级资料。 */
+    eventStrategy(params: {
+        name: string;
+    }): Promise<Jx3Envelope<T.EventStrategy | EmptyObject>>;
+    /** 科举答案。搜索科举试题及答案。 */
+    examSearch(params: {
+        limit?: number | null;
+        subject: string;
+    }): Promise<Jx3Envelope<T.ExamAnswer[] | EmptyObject>>;
+    /** 烟花记录。查询角色发送或接收的烟花记录。 */
+    fireworkRecords(params: {
+        name: string;
+        server: string;
+    }): Promise<Jx3Envelope<T.FireworkRecord[] | EmptyObject>>;
+    /** 小吃小药。查询心法的小吃小药。 */
+    foodList(params?: {
+        name?: string;
+    }): Promise<Jx3Envelope<T.FoodItem[] | EmptyObject>>;
+    /** 骗子查询。查询角色 UID 对应的骗子记录。 */
+    fraudDetail(params: {
+        server?: string;
+        uid: number;
+    }): Promise<Jx3Envelope<T.FraudRecord[] | EmptyObject>>;
+    /** 家园鲜花。查询各家园地图的鲜花收购信息。 */
+    homeFlower(params: {
+        map?: string;
+        name?: string;
+        node?: string;
+        server: string;
+    }): Promise<Jx3Envelope<T.HomeFlowerData | EmptyObject>>;
+    /** 秘境方位。查询当前秘境方位及下次变化的倒计时。 */
+    mechDecrypt(): Promise<Jx3Envelope<T.MechDecrypt | EmptyObject>>;
+    /** 师徒列表。查询服务器的师徒招募信息。 */
+    mentorSearch(params: {
+        keyword?: string;
+        label?: number | null;
+        limit?: number | null;
+        server: string;
+    }): Promise<Jx3Envelope<T.MentorItem[] | EmptyObject>>;
+    /** 角色百战。查询角色的百战技能、体力、精力和场次。 */
+    monsterRecords(params: {
+        name: string;
+        server: string;
+    }): Promise<Jx3Envelope<T.MonsterRecords | EmptyObject>>;
+    /** 百战首领。查询本周百战首领、技能及效果。 */
+    monsterWeekly(): Promise<Jx3Envelope<T.MonsterWeekly | EmptyObject>>;
+    /** 维护公告。查询游戏维护更新公告。 */
+    newsAnnounce(params?: {
+        limit?: number | null;
+    }): Promise<Jx3Envelope<T.NewsItem[] | EmptyObject>>;
+    /** 新闻资讯。查询最新游戏新闻资讯。 */
+    newsRecords(params?: {
+        limit?: number | null;
+    }): Promise<Jx3Envelope<T.NewsItem[] | EmptyObject>>;
+    /** 团队副本进度。使用主站 /raid/records 路由。 */
+    raidRecords(params: {
+        server: string;
+        name: string;
+    }): Promise<Jx3Envelope<RaidProgress[] | EmptyObject>>;
+    /** 马场预告。查询各地图 NPC 播报的马匹预计出世时间。 */
+    ranchChat(params: {
+        server: string;
+    }): Promise<Jx3Envelope<T.RanchChatData>>;
+    /** 马场事件。查询马场预告及本周期赤兔、的卢出世情况。 */
+    ranchRecords(params: {
+        expired?: number;
+        server: string;
+    }): Promise<Jx3Envelope<T.RanchRecordsData>>;
+    /** 绝境战场。查询绝境战场榜单。 */
+    rankBattle(params: {
+        name: string;
+        server?: string;
+    }): Promise<Jx3Envelope<T.RankBattleGroup | T.RankBattleGroup[]>>;
+    /** 据点贡献。查询据点贡献榜。 */
+    rankCastle(params: {
+        name: string;
+        server?: string;
+    }): Promise<Jx3Envelope<T.RankCastleGroup | T.RankCastleGroup[]>>;
+    /** 武林争霸。查询指定阵营的武林争霸榜单。 */
+    rankContest(params?: {
+        camp?: 1 | 2 | null;
+        server?: string;
+    }): Promise<Jx3Envelope<T.RankContestGroup | T.RankContestGroup[]>>;
+    /** 帮会排行。查询帮会排行与战功榜。 */
+    rankGuild(params: {
+        name: string;
+        server?: string;
+    }): Promise<Jx3Envelope<T.RankGuildGroup | T.RankGuildGroup[]>>;
+    /** 江湖排行。查询江湖浪客与捕快荣誉榜。 */
+    rankJianghu(params: {
+        name: string;
+        server?: string;
+    }): Promise<Jx3Envelope<T.RankJianghuGroup | T.RankJianghuGroup[]>>;
+    /** 跨服名剑。查询跨服名剑榜单。 */
+    rankLadder(params?: {
+        mode?: number | null;
+        server?: string;
+    }): Promise<Jx3Envelope<T.RankLadderGroup | T.RankLadderGroup[]>>;
+    /** 个人排行。查询个人排行与贡献榜。 */
+    rankRecords(params: {
+        name: string;
+        server?: string;
+    }): Promise<Jx3Envelope<T.RankRecordsGroup | T.RankRecordsGroup[]>>;
+    /** 试炼之地。查询指定心法的试炼之地榜单。 */
+    rankTrials(params: {
+        kungfu: string;
+        server?: string;
+    }): Promise<Jx3Envelope<T.RankTrialsGroup | T.RankTrialsGroup[]>>;
+    /** 决斗挑战。查询公开或私密的决斗挑战榜单。 */
+    rankWanted(params?: {
+        mode?: 1 | 2 | null;
+        server?: string;
+    }): Promise<Jx3Envelope<T.RankWantedGroup | T.RankWantedGroup[]>>;
+    /** 团队招募。查询服务器的团队招募信息。 */
+    recruitSearch(params: {
+        keyword?: string;
+        label?: number | null;
+        limit?: number | null;
+        server: string;
+    }): Promise<Jx3Envelope<T.RecruitItem[] | EmptyObject>>;
+    /** 掉落统计。查询物品的掉落记录。 */
+    rewardStatistics(params: {
+        limit?: number | null;
+        name: string;
+        server?: string;
+    }): Promise<Jx3Envelope<T.RewardRecord[] | EmptyObject>>;
+    /** 批量角色资料。全局角色 ID 使用字符串，至少传一个 ID，未匹配的角色不出现在结果中。 */
+    roleBatch(params: {
+        ids: [string, ...string[]];
+    }): Promise<Jx3Envelope<T.RoleBatchItem[] | EmptyObject>>;
+    /** 角色详情。查询角色资料，可附带角色名和帮会历史。 */
+    roleDetail(params: {
+        history?: 0 | 1 | null;
+        name: string;
+        server: string;
+    }): Promise<Jx3Envelope<T.RoleDetail | EmptyObject>>;
+    /** 全服角色。查询全服已收录的同名角色。 */
+    roleDetails(params: {
+        name: string;
+    }): Promise<Jx3Envelope<T.RoleDetailsData | EmptyObject>>;
+    /** 沙盘据点。查询据点归属及本周祭祀次数。 */
+    sandRecords(params: {
+        server: string;
+    }): Promise<Jx3Envelope<T.SandRecordsData | EmptyObject>>;
+    /** 舔狗日志。随机获取一条舔狗日志。 */
+    saohuaContent(): Promise<Jx3Envelope<T.SaohuaRandom | EmptyObject>>;
+    /** 分类语录。按分类随机获取一条语录。 */
+    saohuaContext(params: {
+        name: string;
+    }): Promise<Jx3Envelope<T.SaohuaContext | EmptyObject>>;
+    /** 随机骚话。随机获取一条骚话。 */
+    saohuaRandom(): Promise<Jx3Envelope<T.SaohuaRandom | EmptyObject>>;
+    /** 渣男语录。随机获取一条渣男语录。 */
+    saohuaZhanan(): Promise<Jx3Envelope<T.SaohuaZhananData | EmptyObject>>;
+    /** 配装搜索。查询指定心法的推荐配装。 */
+    schoolSearch(params: {
+        mode?: string;
+        name: string;
+        node?: string;
+        ticket?: string;
+    }): Promise<Jx3Envelope<T.SchoolSearchItem[]>>;
+    /** 资历榜单。查询全服或指定服务器、门派的资历前 100 名。 */
+    schoolSeniority(params?: {
+        node?: string;
+        school?: string;
+        server?: string;
+        ticket?: string;
+    }): Promise<Jx3Envelope<T.SchoolSeniorityItem[] | EmptyObject>>;
+    /** 别名搜索。查询名称对应的主服务器。 */
+    serverSearch(params: {
+        server: string;
+    }): Promise<Jx3Envelope<T.ServerSearchData | EmptyObject>>;
+    /** 大区状态。查询服务器的开服或在线状态。 */
+    serverStatusCheck(params?: {
+        server?: string;
+        type?: number;
+    }): Promise<Jx3Envelope<T.ServerStatus[] | T.ServerOnlineStatus | T.ServerOnlineStatus[]>>;
+    /** 游戏版本。查询游戏最新版本及更新包大小。 */
+    serverVersionCheck(): Promise<Jx3Envelope<T.ServerVersionCheckData | EmptyObject>>;
+    /** 蹲宠查询。查询宠物最近触发时间及刷新信息。 */
+    shareStay(params: {
+        node?: string;
+        server: string;
+    }): Promise<Jx3Envelope<T.ShareStayItem[] | EmptyObject>>;
+    /** 副本掉落模拟。省略 name 使用服务端默认副本，需同时检查 detail 内的上游错误。 */
+    simulateRaid(params?: {
+        name?: string;
+    }): Promise<Jx3Envelope<T.RaidDropData | T.UpstreamErrorDetail | EmptyObject>>;
+    /** 试炼翻牌模拟。name 为层数序列，省略时默认 "123"。 */
+    simulateTrial(params?: {
+        name?: string;
+    }): Promise<Jx3Envelope<T.RaidFlipData | EmptyObject>>;
+    /** 急速计算。计算技能在各急速档位的读条时长。 */
+    skillCalculate(params?: {
+        cooldown?: number | null;
+    }): Promise<Jx3Envelope<T.SkillCalculateItem[] | EmptyObject>>;
+    /** 技改记录。查询官方武学调整公告。 */
+    skillRework(params?: {
+        node?: string;
+    }): Promise<Jx3Envelope<T.SkillReworkItem[] | EmptyObject>>;
+    /** 扶摇记录。查询已上报的扶摇九天记录及活动状态。 */
+    soarRecords(params?: {
+        limit?: number;
+        server?: string;
+    }): Promise<Jx3Envelope<T.SoarRecord[] | EmptyObject>>;
+    /** 的卢拍卖。查询的卢出世、捕获与拍卖记录。 */
+    steedRecords(params?: {
+        server?: string;
+    }): Promise<Jx3Envelope<T.SteedRecord[] | T.SteedServerRecord[]>>;
+    /** 外观记录。查询贴吧中的外观交易记录。 */
+    tiebaItemRecords(params: {
+        limit?: number | null;
+        name: string;
+        server?: string;
+    }): Promise<Jx3Envelope<T.TiebaItemRecord[] | EmptyObject>>;
+    /** 贴吧物价。查询物品在贴吧及其他渠道的最近价格记录。 */
+    tiebaItemSales(params: {
+        name: string;
+    }): Promise<Jx3Envelope<T.TiebaItemSalesData | EmptyObject>>;
+    /** 随机帖子。按类型随机查询近 31 天的贴吧帖子。 */
+    tiebaRandom(params: {
+        limit?: number | null;
+        server?: string;
+        tags: string;
+    }): Promise<Jx3Envelope<T.TiebaRandomItem[] | EmptyObject>>;
+    /** 贴吧总结。获取贴吧帖子的 AI 摘要。 */
+    tiebaSummary(params: {
+        id: string;
+    }): Promise<Jx3Envelope<T.TiebaSummary>>;
+    /** 金价行情。查询各渠道的金币价格。 */
+    tradeDemon(params?: {
+        limit?: number | null;
+        server?: string;
+    }): Promise<Jx3Envelope<T.TradeDemonItem[] | EmptyObject>>;
+    /** 外观价格。按物品全名查询成交价和寄售挂单。 */
+    tradeItemRecords(params: {
+        name: string;
+        node?: string;
+        server?: string;
+    }): Promise<Jx3Envelope<T.TradeItemRecords | EmptyObject>>;
+    /** 外观搜索。搜索外观及其基础资料。 */
+    tradeItemSearch(params: {
+        name: string;
+    }): Promise<Jx3Envelope<T.TradeItemInfo[] | EmptyObject>>;
+    /** 成本计算。查询成品售价并计算配方材料成本。 */
+    tradeManufacture(params: {
+        name: string;
+        node?: string;
+        server: string;
+        source?: 0 | 1 | null;
+    }): Promise<Jx3Envelope<T.TradeManufactureData | EmptyObject>>;
+    /** 物品价格。按物品名称或别名查询成交价和寄售挂单。 */
+    tradeRecords(params: {
+        name: string;
+        node?: string;
+        server?: string;
+    }): Promise<Jx3Envelope<T.TradeItemRecords | EmptyObject>>;
+    /** 编号搜索。按万宝楼角色编号查询寄售角色详情。 */
+    tradeWanbaolou(params: {
+        id: string;
+        node?: string;
+    }): Promise<Jx3Envelope<T.TradeWanbaolouData | EmptyObject>>;
+    /** 秒伤计算。查询当前赛季指定层数的首领血量与通关秒伤。 */
+    trialBosses(params: {
+        floor: number;
+    }): Promise<Jx3Envelope<T.TrialBosses | EmptyObject>>;
+    /** 赛季列表。查询当前试炼赛季及首领顺序。 */
+    trialSeasons(): Promise<Jx3Envelope<T.TrialSeason[] | EmptyObject>>;
+    /** 角色徽章。查询推栏角色徽章。 */
+    tuilanBadge(params: {
+        name: string;
+        node?: string;
+        server: string;
+        ticket?: string;
+    }): Promise<Jx3Envelope<T.TuilanBadgeData | EmptyObject>>;
+    /** 统战语音。查询统战 YY 频道的在线主播。 */
+    voiceChannels(params?: {
+        node?: string;
+        server?: string;
+    }): Promise<Jx3Envelope<T.VoiceChannelGroup[] | EmptyObject>>;
+    /** 角色信息。按万宝楼编号查询角色信息。 */
+    wblzsRole(params: {
+        id: string;
+    }): Promise<Jx3Envelope<T.WanbaolouRoleData | EmptyObject>>;
+    /** 搜索找人。按万宝楼订单查找卖家角色候选。 */
+    wblzsSomeone(params: {
+        id: string;
+        limit?: number;
+        node?: string;
+        range?: number;
+        ticket?: string;
+        type?: number;
+    }): Promise<Jx3Envelope<T.WanbaolouOrderData | EmptyObject>>;
+    /** 诛恶事件。查询诛恶事件刷新记录。 */
+    wickedRecords(params?: {
+        limit?: number;
+        server?: string;
+    }): Promise<Jx3Envelope<T.WickedRecord[] | EmptyObject>>;
+}