tttools/frontend/bindings/TengTuToolbox/settingsservice.js

// @ts-check
// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
// This file is automatically generated. DO NOT EDIT

/**
 * SettingsService 暴露「设置」页需要的后端能力给前端调用。
 * 前端通过 bindings 调用 GetSettings / SaveSettings / GetStocks 等方法。
 * @module
 */

// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore: Unused imports
import { Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create } from "@wailsio/runtime";

// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore: Unused imports
import * as $models from "./models.js";

/**
 * AppVersion 返回应用版本号，供 footer 展示。
 * 版本常量在 settings.go 的 AppVersion（与 build/windows/info.json 的 ProductVersion 一致）。
 * @returns {$CancellablePromise<string>}
 */
export function AppVersion() {
    return $Call.ByID(609040257);
}

/**
 * BackupFile 把指定文本文件按当前时间备份到配置的备份目录。
 * 备份文件名带时间戳：<原名>_YYYYMMDD_HHMMSS<扩展名>；目录不存在时自动创建。
 * 返回备份后的完整路径，供前端提示。
 * @param {string} path
 * @returns {$CancellablePromise<string>}
 */
export function BackupFile(path) {
    return $Call.ByID(122452644, path);
}

/**
 * CancelShutdown 取消延时关机（工具页「取消」按钮调用）。
 * @returns {$CancellablePromise<void>}
 */
export function CancelShutdown() {
    return $Call.ByID(1266387008);
}

/**
 * CaptureScreen 截取屏幕并返回 PNG 数据 URI，供「主机」页预览。
 * display 为显示器索引，-1 表示全部屏幕。
 * @param {number} display
 * @returns {$CancellablePromise<string>}
 */
export function CaptureScreen(display) {
    return $Call.ByID(2784207426, display);
}

/**
 * ClearAPILogs 清空 Gin 日志缓冲
 * @returns {$CancellablePromise<void>}
 */
export function ClearAPILogs() {
    return $Call.ByID(1756290968);
}

/**
 * CloseLEDWindow 关闭 LED 滚动窗口（窗口已关则忽略）。
 * @returns {$CancellablePromise<void>}
 */
export function CloseLEDWindow() {
    return $Call.ByID(3709239437);
}

/**
 * GenerateQRCode 把输入字符串生成 PNG 二维码，返回 data URI 供前端展示。
 * size 为图片边长（像素），<=0 时用默认值 300。
 * @param {string} text
 * @param {number} size
 * @returns {$CancellablePromise<string>}
 */
export function GenerateQRCode(text, size) {
    return $Call.ByID(3713602369, text, size);
}

/**
 * GetAPILogs 返回 Gin 日志环形缓冲的全部内容
 * @returns {$CancellablePromise<string[]>}
 */
export function GetAPILogs() {
    return $Call.ByID(524575579).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType0($result);
    }));
}

/**
 * GetAPIStatus 返回内置 API 服务运行状态
 * @returns {$CancellablePromise<$models.APIStatus>}
 */
export function GetAPIStatus() {
    return $Call.ByID(3299247002).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType1($result);
    }));
}

/**
 * GetBiliDynamic 抓取 B站「关注的人最新动态」。
 * 需要设置里配置 B站登录 cookie（含 SESSDATA）；cookie 为空或失效时回退热门视频。
 * @returns {$CancellablePromise<$models.BiliDynamicItem[]>}
 */
export function GetBiliDynamic() {
    return $Call.ByID(258599011).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType3($result);
    }));
}

/**
 * GetGithubFeeds 抓取设置中所有 GitHub 仓库的最新提交
 * @returns {$CancellablePromise<$models.RepoFeed[]>}
 */
export function GetGithubFeeds() {
    return $Call.ByID(2441556896).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType5($result);
    }));
}

/**
 * GetKLine 拉取指定股票的日 K 数据，count 为交易日数量
 * @param {string} code
 * @param {number} count
 * @returns {$CancellablePromise<$models.KLineBar[]>}
 */
export function GetKLine(code, count) {
    return $Call.ByID(1009336803, code, count).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType7($result);
    }));
}

/**
 * GetLEDColor 返回当前 LED 点阵颜色字符串（默认 #ff4d4d）。
 * @returns {$CancellablePromise<string>}
 */
export function GetLEDColor() {
    return $Call.ByID(3663445744);
}

/**
 * GetLEDSpeed 返回当前 LED 滚动速度（px/s），<=0 用默认 60。
 * @returns {$CancellablePromise<number>}
 */
export function GetLEDSpeed() {
    return $Call.ByID(3083387432);
}

/**
 * GetLEDText 返回当前要显示的 LED 文字。
 * @returns {$CancellablePromise<string>}
 */
export function GetLEDText() {
    return $Call.ByID(2840292550);
}

/**
 * GetMinuteChart 拉取指定股票的分时数据（点击股市行打开分时图时调用）
 * @param {string} code
 * @returns {$CancellablePromise<$models.MinuteChart>}
 */
export function GetMinuteChart(code) {
    return $Call.ByID(1171130824, code).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType8($result);
    }));
}

/**
 * GetNews 抓取新闻标题，按设置的关键词标记命中项并优先排序
 * @returns {$CancellablePromise<$models.NewsItem[]>}
 */
export function GetNews() {
    return $Call.ByID(1306230863).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType10($result);
    }));
}

/**
 * GetNtfyChatTopic 返回当前监听的聊天室主题（空表示未监听）
 * @returns {$CancellablePromise<string>}
 */
export function GetNtfyChatTopic() {
    return $Call.ByID(3733537608);
}

/**
 * GetNtfyNicknames 返回已记忆的昵称列表（用于前端下拉建议）
 * @returns {$CancellablePromise<string[]>}
 */
export function GetNtfyNicknames() {
    return $Call.ByID(3922015524).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType0($result);
    }));
}

/**
 * GetNtfyTopics 返回已记忆的主题列表（用于前端下拉建议）
 * @returns {$CancellablePromise<string[]>}
 */
export function GetNtfyTopics() {
    return $Call.ByID(1599033699).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType0($result);
    }));
}

/**
 * GetPCStatus 返回电源控制命令状态
 * @returns {$CancellablePromise<$models.PCStatus>}
 */
export function GetPCStatus() {
    return $Call.ByID(4166939475).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType11($result);
    }));
}

/**
 * GetRandomPoem 返回一首随机古诗（供主窗口前端加载 / 手动刷新调用）
 * @returns {$CancellablePromise<$models.PoemData>}
 */
export function GetRandomPoem() {
    return $Call.ByID(3860766604).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType12($result);
    }));
}

/**
 * GetRecordItems 返回所有历史名称（去重排序），供名称输入框自动补全。
 * @returns {$CancellablePromise<string[]>}
 */
export function GetRecordItems() {
    return $Call.ByID(1250968375).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType0($result);
    }));
}

/**
 * GetRecordNames 返回所有历史姓名（去重排序），供姓名输入框自动补全。
 * @returns {$CancellablePromise<string[]>}
 */
export function GetRecordNames() {
    return $Call.ByID(2424781591).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType0($result);
    }));
}

/**
 * GetSettings 返回当前配置（读取配置文件，不存在则返回默认值）
 * @returns {$CancellablePromise<$models.AppSettings>}
 */
export function GetSettings() {
    return $Call.ByID(3034808949).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType13($result);
    }));
}

/**
 * GetStocks 按已保存的股票代码拉取最新行情
 * @returns {$CancellablePromise<$models.StockQuote[]>}
 */
export function GetStocks() {
    return $Call.ByID(3187718815).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType15($result);
    }));
}

/**
 * GetTrendingRepos 抓取 GitHub Trending 页的热门仓库列表（英文简介已自动翻译为中文）
 * @returns {$CancellablePromise<$models.TrendingRepo[]>}
 */
export function GetTrendingRepos() {
    return $Call.ByID(4191072422).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType17($result);
    }));
}

/**
 * HandleFlash 触发拖动手柄圆点闪烁：向所有前端窗口广播 handleFlash 事件。
 * count 为闪烁次数（<=0 默认 3 次）。前端订阅后播放颜色 + 大小变化动画。
 * @param {number} count
 * @returns {$CancellablePromise<void>}
 */
export function HandleFlash(count) {
    return $Call.ByID(863239368, count);
}

/**
 * MD5Hash 计算输入字符串的 MD5 摘要（32 位小写十六进制）。
 * 空输入返回空串（前端用于校验）。
 * @param {string} text
 * @returns {$CancellablePromise<string>}
 */
export function MD5Hash(text) {
    return $Call.ByID(2582579328, text);
}

/**
 * MarkGithubRepoChecked 标记某仓库已检视：把本地版本更新为最新 release 版本，消除「发现新版本」提示
 * @param {string} url
 * @param {string} latest
 * @returns {$CancellablePromise<void>}
 */
export function MarkGithubRepoChecked(url, latest) {
    return $Call.ByID(1378316359, url, latest);
}

/**
 * OpenInBrowser 用配置的浏览器打开网址。
 * 若设置页指定了浏览器路径（BrowserPath）且文件存在，则用该浏览器打开；
 * 否则回退到系统默认浏览器（通过 Wails OpenURL 能力）。
 * @param {string} url
 * @returns {$CancellablePromise<void>}
 */
export function OpenInBrowser(url) {
    return $Call.ByID(1476290681, url);
}

/**
 * OpenLEDWindow 打开（或更新）LED 点阵滚动窗口并显示指定文字。
 * text 为空时不更新内容（保留上次文字），但窗口未开则忽略。
 * color 非空时保存为点阵颜色并持久化到设置。
 * speed > 0 时更新滚动速度（px/s）。
 * 返回是否成功打开（供前端提示）。
 * @param {string} text
 * @param {string} color
 * @param {number} speed
 * @returns {$CancellablePromise<boolean>}
 */
export function OpenLEDWindow(text, color, speed) {
    return $Call.ByID(3302455249, text, color, speed);
}

/**
 * PickBrowserPath 弹出文件选择对话框，让用户指定浏览器可执行文件（如 chrome.exe / msedge.exe / firefox.exe）。
 * 返回选中的 exe 路径（取消返回空串）。
 * @returns {$CancellablePromise<string>}
 */
export function PickBrowserPath() {
    return $Call.ByID(165230808);
}

/**
 * PickSendFiles 弹出多选文件对话框，用于 LocalSend 发送文件。
 * 返回选中的文件路径列表（取消返回空列表）。
 * @returns {$CancellablePromise<string[]>}
 */
export function PickSendFiles() {
    return $Call.ByID(1674315782).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType0($result);
    }));
}

/**
 * PickUploadFile 弹出文件选择对话框，返回用户选中的本地文件路径（取消返回空串）。
 * @returns {$CancellablePromise<string>}
 */
export function PickUploadFile() {
    return $Call.ByID(2719376250);
}

/**
 * PickWebDir 弹出目录选择对话框，返回选中的目录（取消返回空串）。
 * @returns {$CancellablePromise<string>}
 */
export function PickWebDir() {
    return $Call.ByID(1493546416);
}

/**
 * ReadRecords 读取全部记录（按 id 升序，保持录入顺序）。
 * 前端 loadRecords 渲染列表；柱状图按返回顺序绘制。
 * @returns {$CancellablePromise<$models.RecordItem[]>}
 */
export function ReadRecords() {
    return $Call.ByID(2989114738).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType19($result);
    }));
}

/**
 * ReadTextFile 读取任意文本文件内容（供「自定义 Tab」文件类型页面使用）。
 * 文件不存在时返回空内容；其他错误原样返回。
 * @param {string} path
 * @returns {$CancellablePromise<string>}
 */
export function ReadTextFile(path) {
    return $Call.ByID(3179291801, path);
}

/**
 * ReadTodo 读取待办文件内容（每行一个任务）；文件不存在时返回空
 * @returns {$CancellablePromise<string>}
 */
export function ReadTodo() {
    return $Call.ByID(1630526072);
}

/**
 * ReminderStatus 查询当前定时提醒状态（运行中 / 间隔 / 下次时刻）。
 * @returns {$CancellablePromise<string>}
 */
export function ReminderStatus() {
    return $Call.ByID(1750819476);
}

/**
 * RenderMarkdown 把 Markdown 文本渲染为安全 HTML 片段（供文件类自定义 Tab 展示）。
 * 使用 gomarkdown 渲染，并启用 CommonMark 扩展（表格、任务列表、围栏代码等）。
 * @param {string} md
 * @returns {$CancellablePromise<string>}
 */
export function RenderMarkdown(md) {
    return $Call.ByID(3516797141, md);
}

/**
 * SHA256Hash 计算输入字符串的 SHA256 摘要（64 位小写十六进制）。
 * 空输入返回空串（前端用于校验）。
 * @param {string} text
 * @returns {$CancellablePromise<string>}
 */
export function SHA256Hash(text) {
    return $Call.ByID(3463776099, text);
}

/**
 * SaveSettings 保存配置并立即生效：热键、窗口置顶、开机启动、页面地址、股票代码等
 * @param {$models.AppSettings} settings
 * @returns {$CancellablePromise<$models.AppSettings>}
 */
export function SaveSettings(settings) {
    return $Call.ByID(2662658340, settings).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType13($result);
    }));
}

/**
 * SaveTickerEnabled 保存滚动条开关状态（新闻条 / 股票条右侧「关闭」按钮调用）
 * @param {string} kind
 * @param {boolean} enabled
 * @returns {$CancellablePromise<void>}
 */
export function SaveTickerEnabled(kind, enabled) {
    return $Call.ByID(3033168348, kind, enabled);
}

/**
 * SaveTickerPos 保存滚动条窗口拖动后的位置（只更新配置，不重建窗口）
 * @param {string} kind
 * @param {number} x
 * @param {number} y
 * @returns {$CancellablePromise<void>}
 */
export function SaveTickerPos(kind, x, y) {
    return $Call.ByID(371275047, kind, x, y);
}

/**
 * SendNtfyChat 向聊天室（主题）发送一条消息，nickname 作为标题发送。
 * 与 SendNtfyMessage 的区别：昵称固定作为标题，便于聊天室按昵称区分发言者。
 * @param {string} topic
 * @param {string} nickname
 * @param {string} message
 * @returns {$CancellablePromise<void>}
 */
export function SendNtfyChat(topic, nickname, message) {
    return $Call.ByID(2994892543, topic, nickname, message);
}

/**
 * SendNtfyMessage 向指定主题推送一条 ntfy 消息。
 * topic 为推送主题（频道名），title 可为空（使用主题名），message 为消息内容。
 * @param {string} topic
 * @param {string} title
 * @param {string} message
 * @returns {$CancellablePromise<void>}
 */
export function SendNtfyMessage(topic, title, message) {
    return $Call.ByID(1563997112, topic, title, message);
}

/**
 * SetLEDTransparent 保留空实现：原生分层窗口透明由 SetLayeredWindowAttributes
 * 在建窗时设置，无需前端补设。兼容前端 bindings 调用（不再报错）。
 * @returns {$CancellablePromise<void>}
 */
export function SetLEDTransparent() {
    return $Call.ByID(1774887829);
}

/**
 * SetMobileMode 前端在窗口尺寸变化时调用：移动端（窄屏）隐藏主机 Tab 并禁止滚动条
 * @param {boolean} mobile
 * @returns {$CancellablePromise<void>}
 */
export function SetMobileMode(mobile) {
    return $Call.ByID(2881494037, mobile);
}

/**
 * SetNtfyChatTopic 设置聊天室要监听的主题。
 * 传入空字符串则停止监听（无主题不监听）。
 * 若与当前监听主题相同则不做任何事；不同则先停止旧监听再启动新监听。
 * @param {string} topic
 * @returns {$CancellablePromise<void>}
 */
export function SetNtfyChatTopic(topic) {
    return $Call.ByID(1718497116, topic);
}

/**
 * ShowWindow 供前端主动呼出窗口（例如通知点击后回到主界面）
 * @returns {$CancellablePromise<void>}
 */
export function ShowWindow() {
    return $Call.ByID(3712560909);
}

/**
 * ShutdownDelay 在指定分钟后执行关机。
 * minutes 必须 > 0；返回计划执行时间（HH:MM:SS）与提示信息。
 * @param {number} minutes
 * @returns {$CancellablePromise<string>}
 */
export function ShutdownDelay(minutes) {
    return $Call.ByID(3801676825, minutes);
}

/**
 * StartAPIService 启动 / 重启内置 API 服务（服务页手动启动）
 * @returns {$CancellablePromise<void>}
 */
export function StartAPIService() {
    return $Call.ByID(3942830483);
}

/**
 * StartReminder 启动（或更新）定时提醒：每 every 分钟提醒一次，直到取消。
 * message 为提醒信息，minutes 为间隔分钟数（必须 >=1）。
 * 返回启动状态描述（含下次提醒时刻），供前端提示。
 * @param {string} message
 * @param {number} minutes
 * @returns {$CancellablePromise<string>}
 */
export function StartReminder(message, minutes) {
    return $Call.ByID(2273071398, message, minutes);
}

/**
 * StartWebService 启动静态文件服务（默认页 index.html 或 readme.md）。
 * @param {string} dir
 * @returns {$CancellablePromise<$models.WebServiceInfo>}
 */
export function StartWebService(dir) {
    return $Call.ByID(3007036157, dir).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType20($result);
    }));
}

/**
 * StopAPIService 停止内置 API 服务（服务页手动停止）
 * @returns {$CancellablePromise<void>}
 */
export function StopAPIService() {
    return $Call.ByID(1470228927);
}

/**
 * StopReminder 取消定时提醒。返回是否在运行过。
 * @returns {$CancellablePromise<string>}
 */
export function StopReminder() {
    return $Call.ByID(1962022930);
}

/**
 * StopWebService 停止静态文件服务。
 * @returns {$CancellablePromise<void>}
 */
export function StopWebService() {
    return $Call.ByID(1864477289);
}

/**
 * TTS 用微软 Edge 神经网络语音合成文本，返回 data URI（audio/mp3）。
 * 前端直接赋给 <audio src> 播放。voice 可选：xiaoxiao/yunxi/yunjian/xiaoyi/yunyang。
 * 古诗词朗读用云希（yunxi，沉稳男声）效果最佳。
 * @param {string} text
 * @param {string} voice
 * @returns {$CancellablePromise<string>}
 */
export function TTS(text, voice) {
    return $Call.ByID(734529301, text, voice);
}

/**
 * ToggleWindowCompact 双击拖动手柄：在「全尺寸」与「仅手柄大小」之间切换。
 * 返回切换后是否处于紧凑（仅手柄）状态；前端据此切换 UI（隐藏内容、显示居中还原圆点）。
 * @returns {$CancellablePromise<boolean>}
 */
export function ToggleWindowCompact() {
    return $Call.ByID(1749284713);
}

/**
 * Translate 翻译文本：输入中文翻译为英文，输入英文翻译为中文（自动检测方向）。
 * 使用 MyMemory 免费 API，有每日配额限制。
 * @param {string} text
 * @returns {$CancellablePromise<$models.TranslateResult>}
 */
export function Translate(text) {
    return $Call.ByID(3284480866, text).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType21($result);
    }));
}

/**
 * UploadFile 供桌面端「服务」页直接上传本地文件（不走 HTTP、无需密码）。
 * 把本地文件压缩为 zip 存入上传目录（zip 内保留原文件名），返回下载信息。
 * 仅本机桌面调用，不暴露给外部网络。
 * @param {string} diskPath
 * @returns {$CancellablePromise<{ [_ in string]?: any }>}
 */
export function UploadFile(diskPath) {
    return $Call.ByID(417387035, diskPath).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType22($result);
    }));
}

/**
 * WebServiceStatus 返回静态文件服务当前状态。
 * @returns {$CancellablePromise<$models.WebServiceInfo>}
 */
export function WebServiceStatus() {
    return $Call.ByID(1311352355).then(/** @type {($result: any) => any} */(($result) => {
        return $$createType20($result);
    }));
}

/**
 * WriteRecords 全量替换记录：开启事务，先清空再批量插入。
 * 前端 saveRecords 提交当前列表全部行，保证与数据库完全一致。
 * @param {$models.RecordItem[]} items
 * @returns {$CancellablePromise<void>}
 */
export function WriteRecords(items) {
    return $Call.ByID(1978718139, items);
}

/**
 * WriteTextFile 把文本内容写回指定文件（目录不存在时自动创建）。
 * 供文件类自定义 Tab 的「保存」使用。
 * @param {string} path
 * @param {string} content
 * @returns {$CancellablePromise<void>}
 */
export function WriteTextFile(path, content) {
    return $Call.ByID(1781087370, path, content);
}

/**
 * WriteTodo 把待办内容写回待办文件（目录不存在时自动创建）
 * @param {string} content
 * @returns {$CancellablePromise<void>}
 */
export function WriteTodo(content) {
    return $Call.ByID(3129393963, content);
}

// Private type creation functions
const $$createType0 = $Create.Array($Create.Any);
const $$createType1 = $models.APIStatus.createFrom;
const $$createType2 = $models.BiliDynamicItem.createFrom;
const $$createType3 = $Create.Array($$createType2);
const $$createType4 = $models.RepoFeed.createFrom;
const $$createType5 = $Create.Array($$createType4);
const $$createType6 = $models.KLineBar.createFrom;
const $$createType7 = $Create.Array($$createType6);
const $$createType8 = $models.MinuteChart.createFrom;
const $$createType9 = $models.NewsItem.createFrom;
const $$createType10 = $Create.Array($$createType9);
const $$createType11 = $models.PCStatus.createFrom;
const $$createType12 = $models.PoemData.createFrom;
const $$createType13 = $models.AppSettings.createFrom;
const $$createType14 = $models.StockQuote.createFrom;
const $$createType15 = $Create.Array($$createType14);
const $$createType16 = $models.TrendingRepo.createFrom;
const $$createType17 = $Create.Array($$createType16);
const $$createType18 = $models.RecordItem.createFrom;
const $$createType19 = $Create.Array($$createType18);
const $$createType20 = $models.WebServiceInfo.createFrom;
const $$createType21 = $models.TranslateResult.createFrom;
const $$createType22 = $Create.Map($Create.Any, $Create.Any);