@e-xi/xion 0.0.6

package/dist/renderer/services/index.js

@@ -0,0 +1,444 @@
+// src/renderer/services/orval-axios-mutator.ts
+import { AxiosError, AxiosHeaders } from "axios";
+async function axiosRequest(config) {
+  const response = await window.xion.remoteService.request({
+    method: (config.method ?? "GET").toUpperCase(),
+    path: config.url?.trim() ?? "",
+    query: normalizeQuery(config.params),
+    headers: normalizeHeaders(config.headers),
+    body: config.data
+  });
+  const axiosResponse = {
+    data: response.data,
+    status: response.status,
+    statusText: response.statusText,
+    headers: AxiosHeaders.from(response.headers),
+    config
+  };
+  const validateStatus = config.validateStatus ?? ((status) => status >= 200 && status < 300);
+  if (!validateStatus(response.status)) {
+    throw new AxiosError(
+      `\u670D\u52A1\u8BF7\u6C42\u5931\u8D25\uFF0CHTTP \u72B6\u6001\u7801 ${response.status}`,
+      AxiosError.ERR_BAD_RESPONSE,
+      config,
+      void 0,
+      axiosResponse
+    );
+  }
+  return axiosResponse;
+}
+function normalizeHeaders(headers) {
+  const result = {};
+  const values = AxiosHeaders.from(headers).toJSON();
+  for (const [name, value] of Object.entries(values)) {
+    if (value === null || value === void 0) {
+      continue;
+    }
+    result[name] = Array.isArray(value) ? value.join(", ") : String(value);
+  }
+  return result;
+}
+function normalizeQuery(params) {
+  if (!params) {
+    return void 0;
+  }
+  if (params instanceof URLSearchParams) {
+    const result2 = {};
+    for (const [name, value] of params.entries()) {
+      const current = result2[name];
+      result2[name] = current === void 0 ? value : Array.isArray(current) ? [...current, value] : [current, value];
+    }
+    return result2;
+  }
+  if (typeof params !== "object" || Array.isArray(params)) {
+    throw new TypeError("\u67E5\u8BE2\u53C2\u6570\u5FC5\u987B\u662F\u666E\u901A\u5BF9\u8C61\u6216 URLSearchParams");
+  }
+  const result = {};
+  for (const [name, value] of Object.entries(params)) {
+    if (value === null || value === void 0) {
+      continue;
+    }
+    if (Array.isArray(value)) {
+      result[name] = value.map((item) => normalizeQueryValue(name, item));
+      continue;
+    }
+    result[name] = normalizeQueryValue(name, value);
+  }
+  return result;
+}
+function normalizeQueryValue(name, value) {
+  if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
+    return value;
+  }
+  throw new TypeError(`\u67E5\u8BE2\u53C2\u6570 ${name} \u53EA\u652F\u6301\u5B57\u7B26\u4E32\u3001\u6570\u5B57\u6216\u5E03\u5C14\u503C`);
+}
+
+// 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/renderer/services/xo-api-requester.ts
+import { isAxiosError } from "axios";
+var XoApiRequester = class _XoApiRequester {
+  /** 业务响应选择器 */
+  selectors;
+  /**
+   * 使用业务响应选择器初始化 API 请求器
+   * @param {XoApi.Selectors<TResponse>} selectors 业务响应选择器
+   */
+  constructor(selectors) {
+    this.selectors = selectors;
+  }
+  /**
+   * 创建 API 请求器
+   * @template TResponse 业务响应结构
+   * @param {XoApi.Selectors<TResponse>} selectors 业务响应选择器
+   * @returns {XoApiRequester<TResponse>}
+   */
+  static create(selectors) {
+    return new _XoApiRequester(selectors);
+  }
+  async request(requester, ...optionParams) {
+    const options = optionParams[0] ?? {};
+    try {
+      const args = this.requestArguments(options.args);
+      const response = await requester(...args);
+      const selectedResponse = response;
+      if (this.selectors.isFail?.(selectedResponse)) {
+        this.handleFail(this.responseMessage(selectedResponse), options);
+        return void 0;
+      }
+      const data = this.selectors.data(selectedResponse);
+      if (data === void 0) {
+        this.handleError("\u54CD\u5E94\u6570\u636E\u4E3A\u7A7A", options);
+        return void 0;
+      }
+      return data;
+    } catch (error) {
+      if (isAxiosError(error) && error.response) {
+        try {
+          this.handleFail(
+            this.responseMessage(
+              error.response,
+              error.message || "\u8BF7\u6C42\u5931\u8D25"
+            ),
+            options
+          );
+        } catch (selectorError) {
+          this.handleError(this.errorMessage(selectorError), options);
+        }
+        return void 0;
+      }
+      this.handleError(this.errorMessage(error), options);
+      return void 0;
+    } finally {
+      options.complete?.();
+    }
+  }
+  /**
+   * 将请求参数转换为参数元组
+   * @template TArgs API 请求参数元组
+   * @param {XoApi.Args<TArgs>} args 请求参数
+   * @returns {TArgs}
+   * @private
+   */
+  requestArguments(args) {
+    if (args === void 0) {
+      return [];
+    }
+    return Array.isArray(args) ? args : [args];
+  }
+  /**
+   * 获取业务响应信息
+   * @param {AxiosResponse<TResponse>} response 业务选择器使用的 Axios 响应
+   * @param {string}                   fallback 默认信息
+   * @returns {string}
+   * @private
+   */
+  responseMessage(response, fallback = "\u8BF7\u6C42\u5931\u8D25") {
+    const message = this.selectors.message(response);
+    return typeof message === "string" && message.trim() ? message : fallback;
+  }
+  /**
+   * 处理业务失败
+   * @param {string}                   message 失败信息
+   * @param {XoApi.Callbacks} options 请求配置
+   * @returns {void}
+   * @private
+   */
+  handleFail(message, options) {
+    if (options.fail) {
+      options.fail(message);
+    } else {
+      MessageUtil.error(message);
+    }
+  }
+  /**
+   * 处理请求异常
+   * @param {string}                   message 错误信息
+   * @param {XoApi.Callbacks} options 请求配置
+   * @returns {void}
+   * @private
+   */
+  handleError(message, options) {
+    if (options.error) {
+      options.error(message);
+    } else {
+      MessageUtil.error(message);
+    }
+  }
+  /**
+   * 获取请求异常信息
+   * @param {unknown} error 请求异常
+   * @returns {string}
+   * @private
+   */
+  errorMessage(error) {
+    return error instanceof Error ? error.message : "\u8BF7\u6C42\u5931\u8D25";
+  }
+};
+export {
+  XoApiRequester,
+  axiosRequest
+};

package/dist/renderer/services/orval-axios-mutator.d.ts

@@ -0,0 +1,9 @@
+import type { AxiosRequestConfig, AxiosResponse } from 'axios';
+/**
+ * Orval Axios 请求适配器（用于指定 orval 生成配置需要的公共请求方法）
+ * <p>生成接口保留 AxiosResponse 返回结构，实际请求通过 preload IPC 交给主进程</p>
+ * @template T OpenAPI 响应数据类型
+ * @param {AxiosRequestConfig} config Orval 生成的 Axios 请求配置
+ * @returns {Promise<AxiosResponse<T>>}
+ */
+export declare function axiosRequest<T>(config: AxiosRequestConfig): Promise<AxiosResponse<T>>;

package/dist/renderer/services/types/xo-api.d.ts

@@ -0,0 +1,92 @@
+import type {AxiosResponse} from 'axios'
+
+declare global {
+
+    /**
+     * 渲染进程 API 请求器 命名空间
+     */
+    namespace XoApi {
+
+        /**
+         * 从实际响应类型中提取业务数据类型
+         * @template TResponse API 实际响应类型
+         */
+        type ResponseData<TResponse> =
+            TResponse extends { data?: unknown }
+                ? TResponse['data']
+                : unknown
+
+        /**
+         * 响应值选择器
+         * @template TResponse 选择器响应
+         * @template TValue    选择结果
+         */
+        type Selector<TResponse, TValue> = (response: TResponse) => TValue
+
+        /**
+         * 业务响应选择器
+         * <p>选择器负责运行时解析响应字段，与响应族提供的编译期类型推断相互独立。</p>
+         * @template TResponse 业务响应结构
+         */
+        interface Selectors<TResponse> {
+            // 响应信息选择器，仅非空字符串会作为提示信息
+            message: Selector<AxiosResponse<TResponse>, string>
+            // 业务数据选择器，返回 undefined 时视为响应数据为空
+            data: Selector<AxiosResponse<TResponse>, unknown>
+            // 业务失败判断方法，未设置时 HTTP 请求成功即视为业务成功
+            isFail?: Selector<AxiosResponse<TResponse>, boolean>
+        }
+
+        /**
+         * 请求回调配置
+         */
+        interface Callbacks {
+            // HTTP 或业务失败回调
+            fail?: (message: string) => void
+            // 网络、IPC、选择器或程序运行异常回调
+            error?: (message: string) => void
+            // 请求完成回调
+            complete?: () => void
+        }
+
+        /**
+         * API 请求参数
+         * <p>单个非数组参数可以直接传入，也可以使用参数元组；单个数组参数必须使用参数元组。</p>
+         * @template TArgs API 请求参数元组
+         */
+        type Args<TArgs extends unknown[]> =
+            TArgs extends []
+                ? undefined | []
+                : TArgs extends [infer TArg]
+                    ? TArg extends readonly unknown[]
+                        ? TArgs
+                        : TArg | TArgs
+                    : TArgs
+
+        /**
+         * API 请求参数配置
+         * <p>请求函数允许无参数调用时，args 可以省略。</p>
+         * @template TArgs API 请求参数元组
+         */
+        type ArgOptions<TArgs extends unknown[]> = [] extends TArgs
+            ? { args?: Args<TArgs> }
+            : { args: Args<TArgs> }
+
+        /**
+         * API 请求配置
+         * @template TArgs API 请求参数元组
+         */
+        type Options<TArgs extends unknown[]> = Callbacks & ArgOptions<TArgs>
+
+        /**
+         * API 请求配置参数
+         * <p>请求函数允许无参数调用时可以省略请求配置，否则必须提供请求配置。</p>
+         * @template TArgs API 请求参数元组
+         */
+        type OptionParams<TArgs extends unknown[]> = [] extends TArgs
+            ? [options?: Options<TArgs>]
+            : [options: Options<TArgs>]
+    }
+}
+
+export {}

package/dist/renderer/services/xo-api-requester.d.ts

@@ -0,0 +1,129 @@
+/**
+ * API 请求函数
+ * @template TArgs     API 请求参数元组
+ * @template TResponse API 原始响应体
+ */
+type Requester<TArgs extends unknown[], TResponse> = (...args: TArgs) => Promise<{
+    data: TResponse;
+}>;
+/**
+ * API 请求器
+ * <p>业务端通过通用响应结构描述响应，并通过选择器配置响应信息、业务状态和业务数据的读取方式。</p>
+ * <p>调用 {@linkcode XoApiRequester.request} 时，从具体请求函数的响应类型自动推断业务数据类型。</p>
+ * @template TResponse 业务响应结构
+ * @class XoApiRequester
+ *
+ * @example
+ * // 后端通用响应结构
+ * export interface ApiResponse<T = unknown> {
+ *     // 业务状态码
+ *     code?: number
+ *     // 响应信息
+ *     message?: string
+ *     // 业务是否成功
+ *     success?: boolean
+ *     // 业务数据
+ *     data?: T
+ * }
+ *
+ * // 创建 API 请求器
+ * const Api = XoApiRequester.create<ApiResponse>({
+ *     // 选择消息
+ *     message: response => response.data.message ?? '',
+ *     // 选择业务数据
+ *     data   : response => response.data.data,
+ *     // 判断业务请求是否失败
+ *     isFail : response => response.data.success !== true,
+ * })
+ *
+ * // 调用 API 请求函数
+ * const login = await Api.request(HomeApi.loginPOST, {
+ *     args: loginRequest,
+ * })
+ * console.log(login) // {user: ..., token: ...}
+ *
+ * // 多参数调用
+ * const data = await Api.request(HomeApi.multiParameterPOST, {
+ *     args: [arg1, arg2, ...],
+ *     fail: (message: string) => {},
+ *     error: (message: string) => {},
+ *     complete: () => {},
+ * })
+ * console.log(data)
+ */
+export declare class XoApiRequester<TResponse> {
+    /** 业务响应选择器 */
+    private readonly selectors;
+    /**
+     * 使用业务响应选择器初始化 API 请求器
+     * @param {XoApi.Selectors<TResponse>} selectors 业务响应选择器
+     */
+    private constructor();
+    /**
+     * 创建 API 请求器
+     * @template TResponse 业务响应结构
+     * @param {XoApi.Selectors<TResponse>} selectors 业务响应选择器
+     * @returns {XoApiRequester<TResponse>}
+     */
+    static create<TResponse>(selectors: XoApi.Selectors<TResponse>): XoApiRequester<TResponse>;
+    /**
+     * 调用 API 并提取业务数据
+     * @template TArgs           API 请求参数元组
+     * @template TArg            API 请求参数
+     * @template TActualResponse API 实际响应体
+     * @param {Requester<TArgs, TActualResponse>} requester API 请求函数
+     * @param {XoApi.Callbacks & { args: TArg }}  options   请求配置
+     * @returns {Promise<XoApi.ResponseData<TActualResponse> | undefined>}
+     */
+    request<TArg, TActualResponse>(requester: (arg: TArg) => Promise<{
+        data: TActualResponse;
+    }>, options: XoApi.Callbacks & {
+        args: TArg;
+    }): Promise<XoApi.ResponseData<TActualResponse> | undefined>;
+    request<TArg, TActualResponse>(requester: (arg: TArg) => Promise<{
+        data: TActualResponse;
+    }>, options: XoApi.Callbacks & {
+        args: [TArg];
+    }): Promise<XoApi.ResponseData<TActualResponse> | undefined>;
+    request<TArgs extends unknown[], TActualResponse>(requester: Requester<TArgs, TActualResponse>, ...optionParams: XoApi.OptionParams<TArgs>): Promise<XoApi.ResponseData<TActualResponse> | undefined>;
+    /**
+     * 将请求参数转换为参数元组
+     * @template TArgs API 请求参数元组
+     * @param {XoApi.Args<TArgs>} args 请求参数
+     * @returns {TArgs}
+     * @private
+     */
+    private requestArguments;
+    /**
+     * 获取业务响应信息
+     * @param {AxiosResponse<TResponse>} response 业务选择器使用的 Axios 响应
+     * @param {string}                   fallback 默认信息
+     * @returns {string}
+     * @private
+     */
+    private responseMessage;
+    /**
+     * 处理业务失败
+     * @param {string}                   message 失败信息
+     * @param {XoApi.Callbacks} options 请求配置
+     * @returns {void}
+     * @private
+     */
+    private handleFail;
+    /**
+     * 处理请求异常
+     * @param {string}                   message 错误信息
+     * @param {XoApi.Callbacks} options 请求配置
+     * @returns {void}
+     * @private
+     */
+    private handleError;
+    /**
+     * 获取请求异常信息
+     * @param {unknown} error 请求异常
+     * @returns {string}
+     * @private
+     */
+    private errorMessage;
+}
+export {};