@solazah/solazah-runtime 0.1.153 → 0.1.155

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solazah/solazah-runtime",
-  "version": "0.1.153",
+  "version": "0.1.155",
   "main": "index.cjs",
   "module": "index.js",
   "types": "types/index.d.ts",

package/types/PluginSettings.d.ts

@@ -1,4 +1,10 @@
 import { default as IpcRenderer } from './IpcRenderer';
+/** 集合里的一项：id 必填，order 可选（手工位次，列表按它排前），其余字段由插件自定。 */
+export interface PluginSettingItem {
+    id: string;
+    order?: number;
+    [key: string]: any;
+}
 export default class PluginSettings {
     private transport;
     constructor(transport?: IpcRenderer);
@@ -30,4 +36,32 @@ export default class PluginSettings {
      * @returns 无返回。无法定位发起方插件或该 key 对应的设置不存在时不执行任何操作。
      */
     removeSetting: (key: string) => Promise<any>;
+    /**
+     * 列出某个集合里的全部项。集合是一项一行存储的列表（键 = `集合名/项 id`），跨设备同步时逐项合并，
+     * 不会整份互相覆盖——列表类数据（自定义命令、链接、分组…）一律用集合，不要整份数组存进一个键。
+     * 带 order 的项按 order 排前，其余按写入先后。
+     *
+     * @param collection 集合名，只能用字母、数字、点、下划线、横线。
+     * @param options    可选。legacyKey：旧版把整份数组存在这个键里，那一行还在就先迁成行（缺 order 的按数组下标补）再删掉它，迁移幂等。
+     * @returns 项数组，每项带 id；无法定位发起方插件时返回 undefined。
+     */
+    listItems: (collection: string, options?: {
+        legacyKey?: string;
+    }) => Promise<PluginSettingItem[] | undefined>;
+    /**
+     * 写入集合里的一项（有则覆盖，无则新建）。
+     *
+     * @param collection 集合名。
+     * @param item       项，必须带非空字符串 id；可带数字 order 表示手工位次。
+     * @returns 无返回。无法定位发起方插件时不执行任何操作。
+     */
+    putItem: (collection: string, item: PluginSettingItem) => Promise<void>;
+    /**
+     * 删除集合里的一项；本来就没有时不做任何事。
+     *
+     * @param collection 集合名。
+     * @param id         项的 id。
+     * @returns 无返回。无法定位发起方插件时不执行任何操作。
+     */
+    removeItem: (collection: string, id: string) => Promise<void>;
 }