TeyvatGuide/src/utils/UIAF.ts

/**
 * @file utils/UIAF.ts
 * @description UIAF工具类
 * @since Beta v0.4.7
 */

import { app, fs } from "@tauri-apps/api";
import Ajv from "ajv";
import { ErrorObject } from "ajv/lib/types/index.js";

import showSnackbar from "../components/func/snackbar.js";
import { UiafSchema } from "../data/index.js";

import TGLogger from "./TGLogger.js";

/**
 * @description 根据 completed 跟 progress 获取 status
 * @since Alpha v0.1.4
 * @param {boolean} completed - 是否完成
 * @param {number} progress - 进度
 * @returns {number} status
 */
export function getUiafStatus(completed: boolean, progress: number): number {
  if (progress !== 0 && !completed) {
    return 1;
  } else if (progress === 0 && completed) {
    return 2;
  } else if (progress !== 0 && completed) {
    return 3;
  } else {
    return 0;
  }
}

/**
 * @description 获取 UIAF 头部信息
 * @since Beta v0.3.4
 * @returns {Promise<TGApp.Plugins.UIAF.Export>}
 */
export async function getUiafHeader(): Promise<TGApp.Plugins.UIAF.Export> {
  return {
    export_app: "TeyvatGuide",
    export_timestamp: Math.floor(Date.now() / 1000),
    export_app_version: await app.getVersion(),
    uiaf_version: "v1.1",
  };
}

/**
 * @description 检测是否存在 UIAF 数据，采用 ajv 验证 schema
 * @since Beta v0.4.7
 * @param {string} path - UIAF 数据路径
 * @returns {Promise<boolean>} 是否存在 UIAF 数据
 */
export async function verifyUiafData(path: string): Promise<boolean> {
  const fileData: string = await fs.readTextFile(path);
  const ajv = new Ajv();
  const validate = ajv.compile(UiafSchema);
  try {
    const fileJson = JSON.parse(fileData);
    if (!validate(fileJson)) {
      const error: ErrorObject = validate.errors[0];
      showSnackbar({
        text: `${error.instancePath || error.schemaPath} ${error.message}`,
        color: "error",
      });
      await TGLogger.Error(`UIAF 数据验证失败，文件路径：${path}`);
      await TGLogger.Error(`错误信息 ${validate.errors?.toString()}`);
      return false;
    }
    return true;
  } catch (e) {
    showSnackbar({ text: `UIAF 数据格式错误 ${e}`, color: "error" });
    await TGLogger.Error(`UIAF 数据格式错误，文件路径：${path}`);
    await TGLogger.Error(`错误信息 ${e}`);
    return false;
  }
}

/**
 * @description 验证UIAF数据-剪贴板
 * @since Beta v0.4.7
 * @returns {boolean} 是否验证通过
 */
export async function verifyUiafDataClipboard(): Promise<boolean> {
  const ajv = new Ajv();
  const validate = ajv.compile(UiafSchema);
  const data = await window.navigator.clipboard.readText();
  try {
    const fileJson = JSON.parse(data);
    if (!validate(fileJson)) {
      const error: ErrorObject = validate.errors[0];
      showSnackbar({
        text: `${error.instancePath || error.schemaPath} ${error.message}`,
        color: "error",
      });
      await TGLogger.Error(`UIAF 数据验证失败，剪贴板数据：${data}`);
      await TGLogger.Error(`错误信息 ${validate.errors}`);
      return false;
    }
    return true;
  } catch (e) {
    showSnackbar({ text: `UIAF 数据格式错误 ${e}`, color: "error" });
    await TGLogger.Error(`UIAF 数据格式错误，剪贴板数据：${data}`);
    await TGLogger.Error(`错误信息 ${e}`);
    return false;
  }
}

/**
 * @description 读取 UIAF 数据
 * @since Alpha v0.2.3
 * @param {string} userPath - UIAF 数据路径
 * @returns {Promise<TGApp.Plugins.UIAF.Data>} UIAF 数据
 */
export async function readUiafData(userPath: string): Promise<TGApp.Plugins.UIAF.Data> {
  const fileData = await fs.readTextFile(userPath);
  return <TGApp.Plugins.UIAF.Data>JSON.parse(fileData);
}