🌱 背包物品数据库建立&读写

src/plugins/Sqlite/modules/userBagMaterial.ts

@@ -0,0 +1,148 @@
+/**
+ * 用户背包材料模块
+ * @since Beta v0.9.0
+ */
+import { timestampToDate } from "@utils/toolFunc.js";
+
+import TGSqlite from "../index.js";
+
+/**
+ * 获取插入Sql
+ * @since Beta v0.9.0
+ * @param {TGApp.Sqlite.UserBag.TableMaterialRaw} tb -表格
+ * @returns {string}
+ */
+function getInsertSql(tb: TGApp.Sqlite.UserBag.TableMaterialRaw): string {
+  return `
+      INSERT INTO UserBagMaterial(uid, id, count, records, updated)
+      VALUES (${tb.uid}, ${tb.id}, ${tb.count}, '${tb.records}', '${tb.updated}') ON CONFLICT(uid, id) DO
+      UPDATE
+          SET count = ${tb.count},
+          records = '${tb.records}',
+          updated = '${tb.updated}';
+  `;
+}
+
+/**
+ * 插入或更新材料数据
+ * @since Beta v0.9.0
+ * @param {number} uid - 存档UID
+ * @param {number} itemId - 材料ID
+ * @param {number} count - 材料数量
+ * @param {Array<TGApp.Sqlite.UserBag.MaterialRecord>} [records] - 更新记录
+ * @returns {Promise<void>}
+ */
+async function insertMaterial(
+  uid: number,
+  itemId: number,
+  count: number,
+  records: Array<TGApp.Sqlite.UserBag.MaterialRecord> = [],
+): Promise<void> {
+  const now = Date.now();
+  const newRecord: TGApp.Sqlite.UserBag.MaterialRecord = {
+    count: count,
+    time: Math.floor(now / 1000),
+  };
+  const newRecords = [...records, newRecord];
+  const newTable: TGApp.Sqlite.UserBag.TableMaterialRaw = {
+    uid: uid,
+    id: itemId,
+    count: count,
+    records: JSON.stringify(newRecords),
+    updated: timestampToDate(now),
+  };
+  const db = await TGSqlite.getDB();
+  const sql = getInsertSql(newTable);
+  await db.execute(sql);
+}
+
+/**
+ * 获取UID列表
+ * @since Beta v0.9.0
+ */
+async function getAllUid(): Promise<Array<number>> {
+  const db = await TGSqlite.getDB();
+  type resType = Array<{ uid: number }>;
+  const res = await db.select<resType>("SELECT DISTINCT uid FROM UserBagMaterial");
+  return res.map((u) => u.uid);
+}
+
+/**
+ * 解析表格数据
+ * @since Beta v0.9.0
+ * @param {TGApp.Sqlite.UserBag.TableMaterialRaw} raw 原始数据
+ * @return {TGApp.Sqlite.UserBag.TableMaterial} 解析数据
+ */
+function parseMaterial(
+  raw: TGApp.Sqlite.UserBag.TableMaterialRaw,
+): TGApp.Sqlite.UserBag.TableMaterial {
+  return {
+    ...raw,
+    records: JSON.parse(raw.records),
+  };
+}
+
+/**
+ * 获取指定UID的材料数据
+ * @since Beta v0.9.0
+ * @param {number} uid - 存档UID
+ * @param {number} [id] - 材料ID
+ * @returns {Promise<Array<TGApp.Sqlite.UserBag.TableMaterial>>}
+ */
+async function getMaterial(
+  uid: number,
+  id?: number,
+): Promise<Array<TGApp.Sqlite.UserBag.TableMaterial>> {
+  const db = await TGSqlite.getDB();
+  let res: Array<TGApp.Sqlite.UserBag.TableMaterialRaw>;
+  if (id) {
+    res = await db.select<Array<TGApp.Sqlite.UserBag.TableMaterialRaw>>(
+      "SELECT * FROM UserBagMaterial WHERE uid = ? AND id = ?",
+      [uid, id],
+    );
+  } else {
+    res = await db.select<Array<TGApp.Sqlite.UserBag.TableMaterialRaw>>(
+      "SELECT * FROM UserBagMaterial WHERE uid =",
+      [uid],
+    );
+  }
+  return res.map(parseMaterial);
+}
+
+/**
+ * 保存Yae获取的材料数据
+ * @since Beta v0.9.0
+ * @param {number} uid - 存档UID
+ * @param {Array<TGApp.Plugins.Yae.BagItem<"material">>} list - 材料数据
+ * @returns {Promise<void>}
+ */
+async function saveYaeData(
+  uid: number,
+  list: Array<TGApp.Plugins.Yae.BagItem<"material">>,
+): Promise<number> {
+  let skip = 0;
+  for (const item of list) {
+    const read = await getMaterial(uid, item.item_id);
+    if (read.length === 0) {
+      await insertMaterial(uid, item.item_id, item.info.count);
+      continue;
+    }
+    const local = read[0];
+    // 数量相同，不更新
+    if (item.info.count === local.count) {
+      skip++;
+      continue;
+    }
+    await insertMaterial(uid, item.item_id, item.info.count, local.records);
+  }
+  return skip;
+}
+
+const TSUserBagMaterial = {
+  getAllUid,
+  saveYaeData,
+  getMaterial,
+  insertMaterial,
+};
+
+export default TSUserBagMaterial;

src/plugins/Sqlite/sql/createTable.sql

@@ -1,5 +1,16 @@
--- @brief sqlite数据库创建表语句
--- @since Beta v0.8.4
+-- sqlite数据库创建表语句
+-- @since Beta v0.9.0
+
+-- @brief 创建背包物品表
+create table if not exists UserBagMaterial
+(
+    uid     integer not null,
+    id      integer not null,
+    count   integer default 0,
+    records text,
+    updated text,
+    primary key (uid, id)
+);
 
 -- @brief 创建成就数据表
 create table if not exists Achievements

src/types/Plugins/Yae.d.ts

@@ -1,6 +1,6 @@
 /**
  * Yae 插件类型定义
- * @since Beta v0.7.8
+ * @since Beta v0.9.0
  */
 
 declare namespace TGApp.Plugins.Yae {
@@ -9,4 +9,146 @@ declare namespace TGApp.Plugins.Yae {
    * @since Beta v0.7.8
    */
   type AchiListRes = Array<TGApp.Plugins.UIAF.Achievement>;
+
+  /**
+   * 后端返的背包物品数据
+   * @since Beta v0.9.0
+   */
+  type BagListRes = Array<BagItemUnion>;
+
+  /**
+   * 背包物品类型
+   * @since Beta v0.9.0
+   */
+  type BagItemUnion =
+    | BagItem<"material">
+    | BagItem<"weapon">
+    | BagItem<"reliquary">
+    | BagItem<"furniture">
+    | BagItem<"virtual">
+    | BagItem<"unknown">;
+
+  /**
+   * 背包物品信息
+   * @since Beta v0.9.0
+   */
+  type BagItem<T extends ItemKindEnum> = {
+    /** 物品ID */
+    item_id: number;
+    /** 物品类型 */
+    kind: T;
+    /** 物品信息 */
+    info: ItemInfoMap[T];
+  };
+
+  /**
+   * 物品信息表，用于锁定类型
+   * @since Beta v0.9.0
+   */
+  type ItemInfoMap = {
+    /** 材料 */
+    material: MaterialInfo;
+    /** 圣遗物 */
+    reliquary: ReliquaryInfo;
+    /** 武器 */
+    weapon: WeaponInfo;
+    /** 家具 */
+    furniture: FurnitureInfo;
+    /** 虚拟物品 */
+    virtual: VirtualInfo;
+    /** 未知 */
+    unknown: Record<string, never>;
+  };
+
+  /**
+   * 物品类型
+   * @since Beta v0.9.0
+   */
+  const ItemKindType = <const>{
+    /** 材料 */
+    material: "material",
+    /** 圣遗物 */
+    relic: "reliquary",
+    /** 武器 */
+    weapon: "weapon",
+    /** 家具 */
+    furniture: "furniture",
+    /** 虚拟物品 */
+    virtual: "virtual",
+    /** 未知 */
+    unknown: "unknown",
+  };
+
+  /**
+   * 物品类型枚举
+   * @since Beta v0.9.0
+   */
+  type ItemKindEnum = (typeof ItemKindType)[keyof typeof ItemKindType];
+
+  /**
+   * 材料物品信息
+   * @since Beta v0.9.0
+   */
+  type MaterialInfo = {
+    /** 数量 */
+    count: number;
+  };
+
+  /**
+   * 圣遗物物品信息
+   * @since Beta v0.9.0
+   */
+  type ReliquaryInfo = {
+    /** 等级 */
+    level: number;
+    /** 经验 */
+    exp: number;
+    /** 精炼等级 */
+    promote_level: number;
+    /** 主属性ID */
+    main_prop_id: number;
+    /** 副属性 */
+    append_prop_id_list: Array<number>;
+    /** 是否标记 */
+    is_marked: boolean;
+    /** 是否锁定 */
+    is_locked: true;
+  };
+
+  /**
+   * 武器信息
+   * @since Beta v0.9.0
+   */
+  type WeaponInfo = {
+    /** 等级 */
+    level: number;
+    /** 经验 */
+    exp: number;
+    /** 精炼等级 */
+    promote_level: number;
+    /** 未知Map */
+    affix_map: Record<string, number>;
+    /** 未知属性 */
+    is_arkhe_ousia: boolean;
+    /** 是否锁定 */
+    is_locked: boolean;
+  };
+
+  /**
+   * 家具信息
+   * @since Beta v0.9.0
+   */
+  type FurnitureInfo = {
+    /** 数量 */
+    count: number;
+  };
+
+  /**
+   * 虚拟物品
+   * @since Beta v0.9.0
+   */
+  type VirtualInfo = {
+    /** 数量 */
+    count: number;
+  };
 }

src/types/Sqlite/UserBag.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 用户背包物品相关类型定义文件
+ * @since Beta v0.9.0
+ */
+
+declare namespace TGApp.Sqlite.UserBag {
+  /**
+   * 用户背包材料表-存储数据
+   * @since Beta v0.9.0
+   */
+  type TableMaterialRaw = {
+    /** 存档/用户UID */
+    uid: number;
+    /** 材料ID */
+    id: number;
+    /** 材料数量 */
+    count: number;
+    /** 材料更新记录 */
+    records: string;
+    /** 更新时间 */
+    updated: string;
+  };
+
+  /**
+   * 用户背包材料表-解析数据
+   * @since Beta v0.9.0
+   */
+  type TableMaterial = {
+    /** 存档/用户UID */
+    uid: number;
+    /** 材料ID */
+    id: number;
+    /** 材料数量 */
+    count: number;
+    /** 材料更新记录 */
+    records: Array<MaterialRecord>;
+    /** 更新时间 */
+    updated: string;
+  };
+
+  /**
+   * 材料更新记录
+   * @since Beta v0.9.0
+   */
+  type MaterialRecord = {
+    /** 数量 */
+    count: number;
+    /** 时间戳（秒） */
+    time: number;
+  };
+}