@e-xi/xion 0.0.6

package/dist/renderer/composables/index.js

@@ -0,0 +1,570 @@
+// src/renderer/composables/use-xo-boolean.ts
+import { reactive } from "vue";
+function useXoBoolean(initialValue = false) {
+  const state = reactive({
+    value: initialValue,
+    get isTrue() {
+      return this.value;
+    },
+    set isTrue(value) {
+      this.value = value;
+    },
+    get isFalse() {
+      return !this.value;
+    },
+    set isFalse(value) {
+      this.value = !value;
+    },
+    setTrue: () => {
+      state.value = true;
+    },
+    setFalse: () => {
+      state.value = false;
+    }
+  });
+  return state;
+}
+
+// src/renderer/utils/message-util.ts
+import { ElMessage, ElMessageBox, ElNotification } from "element-plus";
+var MessageUtil = class _MessageUtil {
+  //<editor-fold desc="Message">
+  /**
+   * 默认消息配置
+   * @type {XoMessageOptions}
+   * @private
+   */
+  static defaultOptions = {
+    duration: 3e3,
+    grouping: true,
+    offset: 16
+  };
+  /**
+   * 打开消息
+   * @param {MessageOptions} options 消息配置
+   * @returns {MessageHandler}
+   */
+  static open(options) {
+    const placement = options.placement ?? _MessageUtil.defaultOptions.placement ?? "top";
+    const defaultOffset = _MessageUtil.defaultOptions.offset ?? 16;
+    const offset = placement.startsWith("bottom") ? defaultOffset : defaultOffset + (window.xionTitleBar?.height ?? 0);
+    return ElMessage({
+      ..._MessageUtil.defaultOptions,
+      ...options,
+      offset: options.offset ?? offset
+    });
+  }
+  /**
+   * 显示指定类型消息
+   * @param {MessageType}      type    消息类型
+   * @param {XoMessageContent} message 消息内容
+   * @param {XoMessageOptions} options 消息配置
+   * @returns {MessageHandler}
+   * @private
+   */
+  static show(type, message, options) {
+    return _MessageUtil.open({
+      ...options,
+      type,
+      message
+    });
+  }
+  /**
+   * 成功消息
+   * @param {XoMessageContent} message 消息内容
+   * @param {XoMessageOptions} options 消息配置
+   * @returns {MessageHandler}
+   */
+  static success(message, options = {}) {
+    return _MessageUtil.show("success", message, options);
+  }
+  /**
+   * 主要消息
+   * @param {XoMessageContent} message 消息内容
+   * @param {XoMessageOptions} options 消息配置
+   * @returns {MessageHandler}
+   */
+  static primary(message, options = {}) {
+    return _MessageUtil.show("primary", message, options);
+  }
+  /**
+   * 信息消息
+   * @param {XoMessageContent} message 消息内容
+   * @param {XoMessageOptions} options 消息配置
+   * @returns {MessageHandler}
+   */
+  static info(message, options = {}) {
+    return _MessageUtil.show("info", message, options);
+  }
+  /**
+   * 警告消息
+   * @param {XoMessageContent} message 消息内容
+   * @param {XoMessageOptions} options 消息配置
+   * @returns {MessageHandler}
+   */
+  static warning(message, options = {}) {
+    return _MessageUtil.show("warning", message, options);
+  }
+  /**
+   * 错误消息
+   * @param {unknown}                    error           错误
+   * @param {string | XoMessageOptions}  fallbackOptions 兜底消息或消息配置
+   * @param {XoMessageOptions}           options         消息配置
+   * @returns {MessageHandler}
+   */
+  static error(error, fallbackOptions = "\u64CD\u4F5C\u5931\u8D25", options = {}) {
+    const fallback = typeof fallbackOptions === "string" ? fallbackOptions : "\u64CD\u4F5C\u5931\u8D25";
+    const config = typeof fallbackOptions === "string" ? options : fallbackOptions;
+    return _MessageUtil.show("error", _MessageUtil.parseErrorMessage(error, fallback), config);
+  }
+  /**
+   * 关闭全部消息
+   * @param {MessageType} type 消息类型
+   */
+  static closeAll(type) {
+    ElMessage.closeAll(type);
+  }
+  /**
+   * 解析错误消息
+   * @param {unknown} error    错误
+   * @param {string}  fallback 兜底消息
+   * @returns {string}
+   * @private
+   */
+  static parseErrorMessage(error, fallback) {
+    if (typeof error === "string") {
+      return error.trim() || fallback;
+    }
+    if (error instanceof Error) {
+      return error.message || fallback;
+    }
+    if (_MessageUtil.isMessageObject(error)) {
+      return error.message.trim() || fallback;
+    }
+    return fallback;
+  }
+  /**
+   * 判断是否为包含 message 的对象
+   * @param {unknown} value 值
+   * @returns {value is {message: string}}
+   * @private
+   */
+  static isMessageObject(value) {
+    return typeof value === "object" && value !== null && "message" in value && typeof value.message === "string";
+  }
+  //</editor-fold>
+  //<editor-fold desc="Notification">
+  /**
+   * 打开通知
+   * @param {NotificationOptions} options 通知配置
+   * @returns {NotificationHandle}
+   */
+  static notify(options) {
+    const position = options.position ?? "top-right";
+    const offset = position.startsWith("bottom") ? 0 : window.xionTitleBar?.height ?? 0;
+    return ElNotification({
+      ...options,
+      offset: options.offset ?? offset
+    });
+  }
+  /**
+   * 关闭全部通知
+   */
+  static closeAllNotifications() {
+    ElNotification.closeAll();
+  }
+  //</editor-fold>
+  //<editor-fold desc="MessageBox">
+  /**
+   * 默认消息弹窗配置
+   * @type {XoMessageBoxOptions}
+   * @private
+   */
+  static defaultBoxOptions = {
+    confirmButtonText: "\u786E\u5B9A",
+    cancelButtonText: "\u53D6\u6D88"
+  };
+  /**
+   * 警告弹窗
+   * @param {XoMessageBoxContent}          message      消息内容
+   * @param {string | XoMessageBoxOptions} titleOptions 标题
+   * @param {XoMessageBoxOptions}          options      消息弹窗配置
+   * @returns {Promise<void>}
+   */
+  static async alert(message, titleOptions = "\u63D0\u793A", options = {}) {
+    const title = typeof titleOptions === "string" ? titleOptions : "\u63D0\u793A";
+    const config = typeof titleOptions === "string" ? options : titleOptions;
+    try {
+      await ElMessageBox.alert(message, title, {
+        ..._MessageUtil.defaultBoxOptions,
+        ...config
+      });
+    } catch (reason) {
+      if (!_MessageUtil.isBoxDismissed(reason)) {
+        throw reason;
+      }
+    }
+  }
+  /**
+   * 确认弹窗
+   * @param {XoMessageBoxContent}          message      消息内容
+   * @param {string | XoMessageBoxOptions} titleOptions 标题
+   * @param {XoMessageBoxOptions}          options      消息弹窗配置
+   * @returns {Promise<boolean>} 是否确认
+   */
+  static async confirm(message, titleOptions = "\u63D0\u793A", options = {}) {
+    const title = typeof titleOptions === "string" ? titleOptions : "\u63D0\u793A";
+    const config = typeof titleOptions === "string" ? options : titleOptions;
+    try {
+      await ElMessageBox.confirm(message, title, {
+        ..._MessageUtil.defaultBoxOptions,
+        ...config
+      });
+      return true;
+    } catch (reason) {
+      if (_MessageUtil.isBoxDismissed(reason)) {
+        return false;
+      }
+      throw reason;
+    }
+  }
+  /**
+   * 输入弹窗
+   * @param {XoMessageBoxContent}          message      消息内容
+   * @param {string | XoMessageBoxOptions} titleOptions 标题
+   * @param {XoMessageBoxOptions}          options      消息弹窗配置
+   * @returns {Promise<string | undefined>} 输入值，取消或关闭时返回 undefined
+   */
+  static async prompt(message, titleOptions = "\u63D0\u793A", options = {}) {
+    const title = typeof titleOptions === "string" ? titleOptions : "\u63D0\u793A";
+    const config = typeof titleOptions === "string" ? options : titleOptions;
+    try {
+      const { value } = await ElMessageBox.prompt(message, title, {
+        ..._MessageUtil.defaultBoxOptions,
+        ...config
+      });
+      return value;
+    } catch (reason) {
+      if (_MessageUtil.isBoxDismissed(reason)) {
+        return void 0;
+      }
+      throw reason;
+    }
+  }
+  //</editor-fold>
+  /**
+   * 关闭当前消息弹窗
+   */
+  static closeBox() {
+    ElMessageBox.close();
+  }
+  /**
+   * 判断消息弹窗是否被取消或关闭
+   * @param {unknown} reason Promise 拒绝原因
+   * @returns {boolean}
+   * @private
+   */
+  static isBoxDismissed(reason) {
+    return reason === "cancel" || reason === "close";
+  }
+  //</editor-fold>
+};
+
+// src/shared/utils/log-util.ts
+var MaxMessageLength = 16 * 1024;
+var MaxValueLength = 8 * 1024;
+var MaxDataItems = 100;
+var MaxCollectionItems = 100;
+var MaxDepth = 10;
+var MaxNodes = 500;
+var LogUtil = class _LogUtil {
+  /**
+   * 标准化渲染进程日志请求
+   * @param {unknown} message 日志消息
+   * @param {unknown} data    附加数据
+   * @returns {XoIpcLogger.Request}
+   */
+  static normalizeRequest(message, data) {
+    const budget = { remaining: MaxNodes };
+    const seen = /* @__PURE__ */ new WeakSet();
+    return {
+      message: _LogUtil.normalizeText(typeof message === "string" ? message : String(message ?? ""), MaxMessageLength),
+      data: (Array.isArray(data) ? data : []).slice(0, MaxDataItems).map((value) => _LogUtil.normalizeValue(value, 0, seen, budget))
+    };
+  }
+  /**
+   * 标准化日志值
+   * @param {unknown}         value            原始值
+   * @param {number}          depth            当前深度
+   * @param {WeakSet<object>} seen             已处理对象
+   * @param {NormalizeBudget} budget           处理预算
+   * @param {boolean}         preserveNewlines 是否保留换行
+   * @returns {XoIpcLogger.Value}
+   * @private
+   */
+  static normalizeValue(value, depth, seen, budget, preserveNewlines = false) {
+    if (budget.remaining <= 0) return "[Truncated]";
+    budget.remaining--;
+    if (value === null) return null;
+    if (typeof value === "string") return _LogUtil.normalizeText(value, MaxValueLength, preserveNewlines);
+    if (typeof value === "boolean") return value;
+    if (typeof value === "number") return Number.isFinite(value) ? value : String(value);
+    if (typeof value === "bigint") return `${value}n`;
+    if (typeof value === "undefined") return "[undefined]";
+    if (typeof value === "symbol") return `[Symbol ${value.description ?? ""}]`;
+    if (typeof value === "function") return `[Function ${value.name || "anonymous"}]`;
+    if (value instanceof Date) {
+      return Number.isNaN(value.getTime()) ? "[Invalid Date]" : value.toISOString();
+    }
+    if (value instanceof Error) {
+      return {
+        name: _LogUtil.normalizeText(value.name, MaxValueLength),
+        message: _LogUtil.normalizeText(value.message, MaxValueLength),
+        stack: _LogUtil.normalizeText(value.stack ?? "", MaxValueLength, true)
+      };
+    }
+    if (depth >= MaxDepth) return "[Max Depth]";
+    if (seen.has(value)) return "[Circular]";
+    seen.add(value);
+    try {
+      if (Array.isArray(value)) {
+        return value.slice(0, MaxCollectionItems).map((item) => _LogUtil.normalizeValue(item, depth + 1, seen, budget));
+      }
+      return Object.fromEntries(
+        Object.entries(value).slice(0, MaxCollectionItems).map(([key, item]) => [
+          _LogUtil.normalizeText(key, 128),
+          _LogUtil.normalizeValue(item, depth + 1, seen, budget, key === "stack")
+        ])
+      );
+    } catch {
+      return "[Unserializable Object]";
+    } finally {
+      seen.delete(value);
+    }
+  }
+  /**
+   * 清理日志文本中的控制字符并限制长度
+   * @param {string}  text             原始文本
+   * @param {number}  maxLength        最大长度
+   * @param {boolean} preserveNewlines 是否保留换行
+   * @returns {string}
+   * @private
+   */
+  static normalizeText(text, maxLength, preserveNewlines = false) {
+    const normalized = preserveNewlines ? text.replace(/\r\n?/g, "\n") : text.replace(/\r\n?|\n/g, "\\n");
+    return normalized.replace(/[\u0000-\u0008\u000B\u000C\u000E-\u001F\u007F]/g, "").slice(0, maxLength);
+  }
+};
+
+// src/renderer/utils/renderer-log-util.ts
+var RendererLogUtil = class _RendererLogUtil {
+  /**
+   * 写入 debug 日志
+   * @param {string}    message 日志消息
+   * @param {unknown[]} data    附加数据
+   * @returns {Promise<void>}
+   */
+  static async debug(message, ...data) {
+    await _RendererLogUtil.write("debug", message, data);
+  }
+  /**
+   * 写入 info 日志
+   * @param {string}    message 日志消息
+   * @param {unknown[]} data    附加数据
+   * @returns {Promise<void>}
+   */
+  static async info(message, ...data) {
+    await _RendererLogUtil.write("info", message, data);
+  }
+  /**
+   * 写入 warn 日志
+   * @param {string}    message 日志消息
+   * @param {unknown[]} data    附加数据
+   * @returns {Promise<void>}
+   */
+  static async warn(message, ...data) {
+    await _RendererLogUtil.write("warn", message, data);
+  }
+  /**
+   * 写入 error 日志
+   * @param {string}    message 日志消息
+   * @param {unknown[]} data    附加数据
+   * @returns {Promise<void>}
+   */
+  static async error(message, ...data) {
+    await _RendererLogUtil.write("error", message, data);
+  }
+  /**
+   * 标准化并写入日志
+   * @param {XoIpcLogger.Level} level   日志等级
+   * @param {string}            message 日志消息
+   * @param {unknown[]}         data    附加数据
+   * @returns {Promise<void>}
+   * @private
+   */
+  static async write(level, message, data) {
+    const normalized = LogUtil.normalizeRequest(message, data);
+    await window.xion.log[level](normalized.message, ...normalized.data);
+  }
+};
+
+// src/renderer/composables/use-xo-data-loader.ts
+import { reactive as reactive2, toRaw } from "vue";
+function useXoDataLoader(options) {
+  let loadingCount = 0;
+  const loadRequest = options.request;
+  const formData = options.form?.();
+  const submitRequest = options.onSubmit;
+  const loader = reactive2({
+    loading: false,
+    loaded: false,
+    inputWidth: options.inputWidth ?? 200,
+    bottomGap: options.bottomGap ?? 20,
+    formData,
+    submitting: false,
+    // 加载处理器
+    load: async () => {
+      if (loader.loading && options.allowRepeatedLoad !== true) {
+        MessageUtil.warning(options.repeatedLoadWarning ?? "\u5DF2\u5FFD\u7565\u91CD\u590D\u8BF7\u6C42...");
+        return void 0;
+      }
+      loadingCount++;
+      loader.loading = true;
+      loader.loaded = false;
+      try {
+        const results = typeof loadRequest === "function" ? await loadRequest() : await Promise.all(loadRequest.map((request) => request()));
+        await options.onLoadSuccess?.(results, loader.formData);
+        return results;
+      } catch (error) {
+        MessageUtil.error(error, options.loadErrorMessage ?? "\u52A0\u8F7D\u5931\u8D25");
+        void RendererLogUtil.error(`${options.name ? `[${options.name}] ` : ""}${options.loadErrorLogMessage ?? "\u6570\u636E\u52A0\u8F7D\u5931\u8D25"}`, error);
+        await options.onLoadError?.(error);
+        return void 0;
+      } finally {
+        loadingCount--;
+        loader.loading = loadingCount > 0;
+        loader.loaded = loadingCount === 0;
+        await options.onLoadComplete?.();
+      }
+    },
+    // 表单提交处理器
+    submit: async () => {
+      if (!options.form || !submitRequest || loader.submitting) {
+        return void 0;
+      }
+      loader.submitting = true;
+      try {
+        const result = await submitRequest(toRaw(loader.formData));
+        await options.onSubmitSuccess?.(result, loader.formData);
+        return result;
+      } catch (error) {
+        MessageUtil.error(error, options.submitErrorMessage ?? "\u63D0\u4EA4\u5931\u8D25");
+        void RendererLogUtil.error(`${options.name ? `[${options.name}] ` : ""}${options.submitErrorLogMessage ?? "\u8868\u5355\u63D0\u4EA4\u5931\u8D25"}`, error);
+        await options.onSubmitError?.(error, loader.formData);
+        return void 0;
+      } finally {
+        loader.submitting = false;
+        await options.onSubmitComplete?.(loader.formData);
+      }
+    }
+  });
+  return loader;
+}
+
+// src/renderer/composables/use-xo-form-control.ts
+import { reactive as reactive3 } from "vue";
+function useXoInput(option) {
+  return reactive3({
+    model: option.model,
+    onChange: (value, evt) => {
+      option.onChange?.(value, evt);
+    }
+  });
+}
+function useXoInputOtp(option) {
+  return reactive3({
+    model: option.model,
+    onChange: (value) => {
+      option.onChange?.(value);
+    }
+  });
+}
+function useXoInputTag(option) {
+  return reactive3({
+    model: option.model,
+    onChange: (value) => {
+      option.onChange?.(value ?? []);
+    }
+  });
+}
+function useXoInputNumber(option) {
+  return reactive3({
+    model: option.model,
+    onChange: (cur, prev) => {
+      option.onChange?.(cur, prev);
+    }
+  });
+}
+function useXoSwitch(option) {
+  const onChange = (value) => {
+    option.onChange?.(value);
+  };
+  return reactive3({
+    model: option.model,
+    onChange
+  });
+}
+function useXoRadioGroup(option) {
+  const onChange = (value) => {
+    if (option.options.some((item) => Object.is(item.value, value))) {
+      option.onChange?.(value);
+    }
+  };
+  return reactive3({
+    model: option.model,
+    options: option.options,
+    onChange
+  });
+}
+
+// src/renderer/composables/use-xo-updater-action.ts
+import { reactive as reactive4 } from "vue";
+function useXoUpdaterAction(options) {
+  const action = reactive4({
+    loading: false,
+    run: async () => {
+      if (action.loading) {
+        return void 0;
+      }
+      action.loading = true;
+      let result;
+      let error;
+      try {
+        await options.before?.();
+        result = await options.execute();
+        return result;
+      } catch (caught) {
+        error = caught;
+        throw caught;
+      } finally {
+        try {
+          await options.after?.(result, error);
+        } finally {
+          action.loading = false;
+        }
+      }
+    }
+  });
+  return action;
+}
+export {
+  useXoBoolean,
+  useXoDataLoader,
+  useXoInput,
+  useXoInputNumber,
+  useXoInputOtp,
+  useXoInputTag,
+  useXoRadioGroup,
+  useXoSwitch,
+  useXoUpdaterAction
+};

package/dist/renderer/composables/use-xo-boolean.d.ts

@@ -0,0 +1,14 @@
+import { type Reactive } from 'vue';
+export interface XoBoolean {
+    value: boolean;
+    isTrue: boolean;
+    isFalse: boolean;
+    setTrue: () => void;
+    setFalse: () => void;
+}
+/**
+ * 布尔值控制组合式函数
+ * @param {boolean} initialValue 初始值
+ * @returns {Reactive<XoBoolean>}
+ */
+export declare function useXoBoolean(initialValue?: boolean): Reactive<XoBoolean>;

package/dist/renderer/composables/use-xo-data-loader.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 数据加载结果
+ * @template LReq 加载请求类型或请求列表类型
+ * @template LRes 加载结果类型
+ * @template K    加载请求索引类型
+ */
+type DataLoadResults<LReq extends readonly DataLoadRequest[]> = {
+    -readonly [K in keyof LReq]: LReq[K] extends DataLoadRequest<infer LRes> ? LRes : never;
+};
+/**
+ * 数据加载参数对应的结果
+ * @template LReq 加载请求类型或请求列表类型
+ * @template LRes 加载结果类型
+ */
+type DataLoadResult<LReq extends DataLoadRequest | readonly DataLoadRequest[]> = LReq extends DataLoadRequest<infer LRes> ? LRes : LReq extends readonly DataLoadRequest[] ? DataLoadResults<LReq> : never;
+/**
+ * 数据加载请求
+ * @template R 加载结果类型
+ * .e.g. const request: DataLoadRequest<User[]> = async () => await api.getUsers()
+ */
+export type DataLoadRequest<R = unknown> = () => Promise<R>;
+/**
+ * 数据加载器配置
+ * @template LR 加载请求类型或请求列表类型
+ * @template FD 表单数据类型
+ * @template FR 表单提交结果类型
+ */
+export interface DataLoaderOptions<LR extends DataLoadRequest | readonly DataLoadRequest[], FD = undefined, FR = unknown> {
+    name?: string;
+    request: LR;
+    allowRepeatedLoad?: boolean;
+    repeatedLoadWarning?: string;
+    inputWidth?: number;
+    bottomGap?: number;
+    loadErrorMessage?: string;
+    loadErrorLogMessage?: string;
+    onLoadSuccess?: (results: DataLoadResult<LR>, formData: FD) => void | Promise<void>;
+    onLoadError?: (error: unknown) => void | Promise<void>;
+    onLoadComplete?: () => void | Promise<void>;
+    form?: () => FD;
+    onSubmit?: (formData: FD) => Promise<FR>;
+    onSubmitSuccess?: (result: FR, formData: FD) => void | Promise<void>;
+    onSubmitError?: (error: unknown, formData: FD) => void | Promise<void>;
+    onSubmitComplete?: (formData: FD) => void | Promise<void>;
+    submitErrorMessage?: string;
+    submitErrorLogMessage?: string;
+}
+/**
+ * 数据加载状态
+ * @template LR 加载请求类型或请求列表类型
+ * @template FD 表单数据类型
+ * @template FR 表单提交结果类型
+ */
+export interface DataLoader<LR, FD = undefined, FR = unknown> {
+    loading: boolean;
+    loaded: boolean;
+    inputWidth: number;
+    bottomGap: number;
+    formData: FD;
+    submitting: boolean;
+    load: () => Promise<LR | undefined>;
+    submit: () => Promise<FR | undefined>;
+}
+/**
+ * 数据加载器组合式函数
+ * @template LR 加载请求类型或请求列表类型
+ * @template FD 表单数据类型
+ * @template FR 表单提交结果类型
+ * @param {DataLoaderOptions<LR, FD, FR>} options 选项
+ * @returns {DataLoader<DataLoadResult<LR>, FD, FR>}
+ */
+export declare function useXoDataLoader<const LR extends DataLoadRequest | readonly DataLoadRequest[], FD = undefined, FR = unknown>(options: DataLoaderOptions<LR, FD, FR>): DataLoader<DataLoadResult<LR>, FD, FR>;
+export {};