@gct-paas/api 0.1.0-dev.2 → 0.1.0-dev.3

package/es/platform/service/index.d.ts

@@ -5,6 +5,7 @@ import type { AppMemberService } from './apis/app-member.service';
 import type { AppSettingService } from './apis/app-setting.service';
 import type { AssetsService } from './apis/assets.service';
 import type { AuditLogService } from './apis/audit-log.service';
+import type { BiAppService } from './apis/bi-app.service';
 import type { BiDataSetService } from './apis/bi-data-set.service';
 import type { BiFileDatasetConfigService } from './apis/bi-file-dataset-config.service';
 import type { BiFileService } from './apis/bi-file.service';
@@ -20,6 +21,9 @@ import type { DatasourceDevopsService } from './apis/datasource-devops.service';
 import type { DatasourceMoveService } from './apis/datasource-move.service';
 import type { DatasourceMoveDataService } from './apis/datasource-move-data.service';
 import type { DatasourceMoveDetailService } from './apis/datasource-move-detail.service';
+import type { DeviceInterconnectionService } from './apis/device-interconnection.service';
+import type { DeviceInterconnectionParamService } from './apis/device-interconnection-param.service';
+import type { DeviceParamRefService } from './apis/device-param-ref.service';
 import type { ExternalMessageService } from './apis/external-message.service';
 import type { FileTaskService } from './apis/file-task.service';
 import type { FileService } from './apis/file.service';
@@ -186,6 +190,7 @@ export interface ApiManage {
   readonly appSetting: AppSettingService;
   readonly assets: AssetsService;
   readonly auditLog: AuditLogService;
+  readonly biApp: BiAppService;
   readonly biDataSet: BiDataSetService;
   readonly biFileDatasetConfig: BiFileDatasetConfigService;
   readonly biFile: BiFileService;
@@ -201,6 +206,9 @@ export interface ApiManage {
   readonly datasourceMove: DatasourceMoveService;
   readonly datasourceMoveData: DatasourceMoveDataService;
   readonly datasourceMoveDetail: DatasourceMoveDetailService;
+  readonly deviceInterconnection: DeviceInterconnectionService;
+  readonly deviceInterconnectionParam: DeviceInterconnectionParamService;
+  readonly deviceParamRef: DeviceParamRefService;
   readonly externalMessage: ExternalMessageService;
   readonly fileTask: FileTaskService;
   readonly file: FileService;

package/es/service/api-manage.d.ts

@@ -0,0 +1,26 @@
+import { ApiService } from './api-service';
+import type { ApiConfigItem } from './api-service.interface';
+/**
+ * API 管理类
+ * 使用 Proxy 模式根据配置动态创建和管理 API 服务实例
+ *
+ * @author chitanda
+ * @date 2025-08-21 17:08:42
+ * @export
+ * @class ApiManage
+ */
+export declare class ApiManage {
+    /**
+     * 动态 API 服务实例索引签名
+     */
+    [key: string]: ApiService;
+    /**
+     * 根据 api 配置挂载请求对象以及方法
+     *
+     * @author chitanda
+     * @date 2025-08-21 18:08:04
+     * @param {string} url 服务基础 URL
+     * @param {ApiConfigItem[]} configs API 配置项数组
+     */
+    constructor(url: string, configs: ApiConfigItem[]);
+}

package/es/service/api-manage.mjs

@@ -0,0 +1,29 @@
+import path from "path-browserify";
+import { ApiService } from "./api-service.mjs";
+export class ApiManage {
+  /**
+   * 根据 api 配置挂载请求对象以及方法
+   *
+   * @author chitanda
+   * @date 2025-08-21 18:08:04
+   * @param {string} url 服务基础 URL
+   * @param {ApiConfigItem[]} configs API 配置项数组
+   */
+  constructor(url, configs) {
+    return new Proxy(this, {
+      get(manage, property) {
+        const config = configs.find((item) => item.name === property);
+        if (!config) {
+          return void 0;
+        }
+        if (!(property in manage)) {
+          manage[property] = new ApiService(
+            path.join(url, config.entityName),
+            config
+          );
+        }
+        return manage[property];
+      }
+    });
+  }
+}

package/es/service/api-service.d.ts

@@ -0,0 +1,96 @@
+import type { ApiConfigItem, IHttpResponse } from './api-service.interface';
+/**
+ * 服务基类
+ * 提供基础的 HTTP 请求方法封装
+ *
+ * @export
+ * @class ApiService
+ */
+export declare class ApiService {
+    private url;
+    /**
+     * Creates an instance of ApiService.
+     * @author chitanda
+     * @date 2025-08-21 18:08:19
+     * @param {string} url 服务基础 URL
+     * @param {ApiConfigItem} config 当前实例的 api 配置
+     */
+    constructor(url: string, config: ApiConfigItem);
+    /**
+     * PUT 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _put(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+    /**
+     * GET 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _get(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+    /**
+     * DELETE 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _delete(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+    /**
+     * POST 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _post(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+    /**
+     * OPTIONS 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _options(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+    /**
+     * PATCH 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _patch(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+    /**
+     * HEAD 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _head(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+}

package/es/service/api-service.interface.d.ts

@@ -0,0 +1,159 @@
+import { type ApiManage as APaasApiManage } from '../apaas';
+import { type ApiManage as PlatformApiManage } from '../platform';
+/**
+ * HTTP 响应接口
+ *
+ * @export
+ * @interface IHttpResponse
+ * @template T - 响应数据类型
+ */
+export interface IHttpResponse<T = any> {
+    /**
+     * 请求状态码
+     *
+     * @type {number}
+     */
+    code: number;
+    /**
+     * 响应数据
+     *
+     * @type {T}
+     */
+    data: T;
+    /**
+     * 是否请求成功
+     *
+     * @type {boolean}
+     */
+    ok: boolean;
+    /**
+     * 响应消息
+     *
+     * @type {string}
+     */
+    message: string;
+    /**
+     * 子状态码
+     *
+     * @type {number}
+     * @memberof IHttpResponse
+     */
+    subCode?: number;
+    /**
+     * 子状态消息
+     *
+     * @type {string}
+     * @memberof IHttpResponse
+     */
+    subMessage?: string;
+}
+/**
+ * API 接口项
+ *
+ * @author chitanda
+ * @date 2025-08-21 17:08:36
+ * @export
+ * @interface ApiItem
+ */
+export interface ApiItem {
+    /**
+     * 请求方式
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:40
+     * @type {string}
+     */
+    mode: string;
+    /**
+     * 方法名称
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:50
+     * @type {string}
+     */
+    method: string;
+    /**
+     * 请求路径
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:57
+     * @type {string}
+     */
+    path: string;
+    /**
+     * 是否有查询参数
+     *
+     * @author chitanda
+     * @date 2025-08-21 19:08:35
+     * @type {boolean}
+     */
+    hasQuery: boolean;
+    /**
+     * 是否有请求体
+     *
+     * @author chitanda
+     * @date 2025-08-21 19:08:41
+     * @type {boolean}
+     */
+    hasData: boolean;
+}
+/**
+ * 接口配置项
+ *
+ * @author chitanda
+ * @date 2025-08-21 17:08:09
+ * @export
+ * @interface ApiConfigItem
+ */
+export interface ApiConfigItem {
+    /**
+     * 实体名称 camelCase 模式
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:24
+     * @type {string}
+     */
+    name: string;
+    /**
+     * 实体名称
+     *
+     * @author chitanda
+     * @date 2025-08-21 19:08:57
+     * @type {string}
+     */
+    entityName: string;
+    /**
+     * 实体所有 api
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:07
+     * @type {ApiItem[]}
+     */
+    apis: ApiItem[];
+}
+/**
+ * API 映射
+ *
+ * @author chitanda
+ * @date 2025-08-21 17:08:39
+ * @export
+ * @interface ApiMap
+ */
+export interface ApiMap {
+    /**
+     * APaas 平台 API 管理
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:53
+     * @type {APaasApiManage}
+     */
+    apaas: APaasApiManage;
+    /**
+     * 平台 API 管理
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:50
+     * @type {PlatformApiManage}
+     */
+    platform: PlatformApiManage;
+}

package/es/service/api-service.mjs

@@ -0,0 +1,169 @@
+import path from "path-browserify";
+import { HttpUtil } from "./http.util.mjs";
+export class ApiService {
+  /**
+   * Creates an instance of ApiService.
+   * @author chitanda
+   * @date 2025-08-21 18:08:19
+   * @param {string} url 服务基础 URL
+   * @param {ApiConfigItem} config 当前实例的 api 配置
+   */
+  constructor(url, config) {
+    this.url = url;
+    return new Proxy(this, {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      get(api, property) {
+        if (!(property in api)) {
+          const cfg = config.apis.find((item) => item.method === property);
+          if (cfg) {
+            const modeFn = `_${cfg.mode}`;
+            if (cfg.hasData && cfg.hasQuery) {
+              api[property] = (data, query, config2) => {
+                return api[modeFn](cfg.path, query, data, config2);
+              };
+            } else if (cfg.hasData) {
+              api[property] = function(data, config2) {
+                return api[modeFn](cfg.path, data, void 0, config2);
+              };
+            } else if (cfg.hasQuery) {
+              api[property] = function(query, config2) {
+                return api[modeFn](cfg.path, void 0, query, config2);
+              };
+            } else {
+              api[property] = function(config2) {
+                return api[modeFn](cfg.path, void 0, void 0, config2);
+              };
+            }
+          }
+        }
+        return api[property];
+      }
+    });
+  }
+  /**
+   * PUT 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _put(method, data, query, config) {
+    return HttpUtil.put(
+      query?.id ? path.join(this.url, method, query.id) : path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+  /**
+   * GET 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _get(method, data, query, config) {
+    return HttpUtil.get(
+      path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+  /**
+   * DELETE 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _delete(method, data, query, config) {
+    return HttpUtil.delete(
+      path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+  /**
+   * POST 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _post(method, data, query, config) {
+    return HttpUtil.post(
+      path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+  /**
+   * OPTIONS 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _options(method, data, query, config) {
+    return HttpUtil.options(
+      path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+  /**
+   * PATCH 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _patch(method, data, query, config) {
+    return HttpUtil.patch(
+      path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+  /**
+   * HEAD 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _head(method, data, query, config) {
+    return HttpUtil.head(
+      path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+}

package/es/service/http.enum.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 请求结果枚举
+ *
+ * @description: Request result set
+ */
+export declare enum ResultEnum {
+    SUCCESS = 200,
+    ERROR = -1,
+    TIMEOUT = 401,
+    TYPE = "success"
+}
+/**
+ * 请求方法枚举
+ *
+ * @description: request method
+ */
+export declare enum RequestEnum {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    DELETE = "DELETE"
+}
+/**
+ * 内容类型枚举
+ *
+ * @description: contentType
+ */
+export declare enum ContentTypeEnum {
+    JSON = "application/json;charset=UTF-8",
+    FORM_URLENCODED = "application/x-www-form-urlencoded;charset=UTF-8",
+    FORM_DATA = "multipart/form-data;charset=UTF-8"
+}
+/**
+ * 业务服务枚举
+ *
+ * @description: Business service enum
+ */
+export declare enum BizServiceEnum {
+    submit = "post",
+    listByIds = "get",
+    getone = "post",
+    listAll = "post",
+    listByPage = "post",
+    listTree = "post",
+    save = "post",
+    saveOrUpdate = "post",
+    saveBatch = "post",
+    importData = "post",
+    exportData = "post",
+    remove = "post",
+    removeById = "delete",
+    removeByIds = "delete",
+    update = "put",
+    updateById = "put",
+    updateByIds = "put",
+    rdoSave = "post",
+    rdoListAll = "post",
+    rdoListByPage = "post",
+    rdoListVersionById = "get",
+    rdoSaveVersion = "post",
+    rdoSaveBatch = "post",
+    rdoUpdateVersionById = "put",
+    rdoRemoveVersionById = "delete",
+    rdoRemoveById = "delete",
+    rdoGetVersionById = "get",
+    getOne = "post",
+    rdoGetVersionByRefId = "post",
+    getById = "get",
+    rdoListAllVersion = "post",
+    rdoRefListByPage = "post",
+    export = "post",
+    import = "post",
+    rdoExport = "post",
+    rdoImport = "post",
+    biz_search = "post"
+}

package/es/service/http.enum.mjs

@@ -0,0 +1,60 @@
+export var ResultEnum = /* @__PURE__ */ ((ResultEnum2) => {
+  ResultEnum2[ResultEnum2["SUCCESS"] = 200] = "SUCCESS";
+  ResultEnum2[ResultEnum2["ERROR"] = -1] = "ERROR";
+  ResultEnum2[ResultEnum2["TIMEOUT"] = 401] = "TIMEOUT";
+  ResultEnum2["TYPE"] = "success";
+  return ResultEnum2;
+})(ResultEnum || {});
+export var RequestEnum = /* @__PURE__ */ ((RequestEnum2) => {
+  RequestEnum2["GET"] = "GET";
+  RequestEnum2["POST"] = "POST";
+  RequestEnum2["PUT"] = "PUT";
+  RequestEnum2["DELETE"] = "DELETE";
+  return RequestEnum2;
+})(RequestEnum || {});
+export var ContentTypeEnum = /* @__PURE__ */ ((ContentTypeEnum2) => {
+  ContentTypeEnum2["JSON"] = "application/json;charset=UTF-8";
+  ContentTypeEnum2["FORM_URLENCODED"] = "application/x-www-form-urlencoded;charset=UTF-8";
+  ContentTypeEnum2["FORM_DATA"] = "multipart/form-data;charset=UTF-8";
+  return ContentTypeEnum2;
+})(ContentTypeEnum || {});
+export var BizServiceEnum = /* @__PURE__ */ ((BizServiceEnum2) => {
+  BizServiceEnum2["submit"] = "post";
+  BizServiceEnum2["listByIds"] = "get";
+  BizServiceEnum2["getone"] = "post";
+  BizServiceEnum2["listAll"] = "post";
+  BizServiceEnum2["listByPage"] = "post";
+  BizServiceEnum2["listTree"] = "post";
+  BizServiceEnum2["save"] = "post";
+  BizServiceEnum2["saveOrUpdate"] = "post";
+  BizServiceEnum2["saveBatch"] = "post";
+  BizServiceEnum2["importData"] = "post";
+  BizServiceEnum2["exportData"] = "post";
+  BizServiceEnum2["remove"] = "post";
+  BizServiceEnum2["removeById"] = "delete";
+  BizServiceEnum2["removeByIds"] = "delete";
+  BizServiceEnum2["update"] = "put";
+  BizServiceEnum2["updateById"] = "put";
+  BizServiceEnum2["updateByIds"] = "put";
+  BizServiceEnum2["rdoSave"] = "post";
+  BizServiceEnum2["rdoListAll"] = "post";
+  BizServiceEnum2["rdoListByPage"] = "post";
+  BizServiceEnum2["rdoListVersionById"] = "get";
+  BizServiceEnum2["rdoSaveVersion"] = "post";
+  BizServiceEnum2["rdoSaveBatch"] = "post";
+  BizServiceEnum2["rdoUpdateVersionById"] = "put";
+  BizServiceEnum2["rdoRemoveVersionById"] = "delete";
+  BizServiceEnum2["rdoRemoveById"] = "delete";
+  BizServiceEnum2["rdoGetVersionById"] = "get";
+  BizServiceEnum2["getOne"] = "post";
+  BizServiceEnum2["rdoGetVersionByRefId"] = "post";
+  BizServiceEnum2["getById"] = "get";
+  BizServiceEnum2["rdoListAllVersion"] = "post";
+  BizServiceEnum2["rdoRefListByPage"] = "post";
+  BizServiceEnum2["export"] = "post";
+  BizServiceEnum2["import"] = "post";
+  BizServiceEnum2["rdoExport"] = "post";
+  BizServiceEnum2["rdoImport"] = "post";
+  BizServiceEnum2["biz_search"] = "post";
+  return BizServiceEnum2;
+})(BizServiceEnum || {});