@lovrabet/sdk 1.2.5-beta.1 → 1.2.6

package/dist/src/models/abstract-base-model.d.ts

@@ -1,4 +1,4 @@
-import type { BaseModelMethods, ListParams, ListResponse, ModelConfig, ClientConfig, SortList, SelectOption, SelectOptionsParams, FilterParams } from '../types';
+import type { BaseModelMethods, ListParams, ListResponse, ModelConfig, ClientConfig, SortList, SelectOption, SelectOptionsParams, FilterParams, AggregateParams } from '../types';
 import type { HttpClient } from '../http/http-client';
 /**
  * 抽象基础模型类
@@ -31,6 +31,7 @@ export declare abstract class AbstractBaseModel implements BaseModelMethods {
     delete(id: string | number): Promise<void>;
     getSelectOptions(params: SelectOptionsParams): Promise<SelectOption[]>;
     excelExport<T = any>(params?: ListParams): Promise<T>;
+    aggregate<T = any>(params?: AggregateParams): Promise<ListResponse<T>>;
     getConfig(): ModelConfig;
     getModelName(): string;
 }

package/dist/src/models/openapi-model.d.ts

@@ -1,5 +1,5 @@
 import { AbstractBaseModel } from './abstract-base-model';
-import type { SortList } from '../types';
+import type { SortList, ListResponse, AggregateParams } from '../types';
 /**
  * OpenAPI 模型实现
  * 处理 OpenAPI 模式下的 URL 生成和请求体构建
@@ -25,4 +25,9 @@ export declare class OpenApiModel extends AbstractBaseModel {
      * @throws LovrabetError 当尝试调用 excelExport 时抛出错误
      */
     excelExport(params?: any): Promise<any>;
+    /**
+     * OpenAPI 模式暂不支持 aggregate 操作
+     * @throws LovrabetError 当尝试调用 aggregate 时抛出错误
+     */
+    aggregate<T = any>(params?: AggregateParams): Promise<ListResponse<T>>;
 }

package/dist/src/types/index.d.ts

@@ -140,6 +140,92 @@ export interface FilterParams {
     /** 每页数量 */
     pageSize?: number;
 }
+/**
+ * 聚合类型
+ */
+export type AggregateType = 'SUM' | 'COUNT' | 'AVG';
+/**
+ * 聚合字段配置
+ */
+export interface AggregateField {
+    /** 聚合类型 */
+    type: AggregateType;
+    /** 字段名 */
+    field: string;
+    /** 字段别名 */
+    alias?: string;
+    /** 是否 distinct */
+    distinct?: boolean;
+    /** 是否 round */
+    round?: boolean;
+    /** round 精度 */
+    precision?: number;
+}
+/**
+ * Join 类型
+ */
+export type JoinType = 'LEFT' | 'RIGHT' | 'INNER';
+/**
+ * Join 配置
+ */
+export interface JoinConfig {
+    /** Join 类型 */
+    type: JoinType;
+    /** 关联表名 */
+    table: string;
+    /** 关联条件，key 为当前表字段，value 为关联表字段 */
+    condition: Record<string, string>;
+}
+/**
+ * Having 条件
+ */
+export interface HavingCondition {
+    /** 列名（通常是聚合字段的别名） */
+    columnName: string;
+    /** 条件 */
+    condition: FieldCondition;
+}
+/**
+ * Aggregate 参数接口
+ * @description 用于 aggregate 方法的聚合查询参数
+ * @example
+ * ```typescript
+ * const aggregateParams: AggregateParams = {
+ *   select: ['category_id'],
+ *   aggregate: [
+ *     { type: 'SUM', field: 'amount', alias: 'total_amount', round: true, precision: 2 }
+ *   ],
+ *   where: { status: { $eq: 'active' } },
+ *   groupBy: ['category_id'],
+ *   having: [
+ *     { columnName: 'total_amount', condition: { $gte: 1000 } }
+ *   ],
+ *   orderBy: [{ total_amount: SortOrder.DESC }],
+ *   currentPage: 1,
+ *   pageSize: 20
+ * };
+ * ```
+ */
+export interface AggregateParams {
+    /** 选择返回的字段列表 */
+    select?: string[];
+    /** 聚合字段配置 */
+    aggregate?: AggregateField[];
+    /** Where 条件 */
+    where?: WhereCondition;
+    /** Group By 字段列表 */
+    groupBy?: string[];
+    /** Having 条件 */
+    having?: HavingCondition[];
+    /** Join 配置 */
+    join?: JoinConfig[];
+    /** 排序规则 */
+    orderBy?: SortList;
+    /** 当前页码，从 1 开始 */
+    currentPage?: number;
+    /** 每页数量 */
+    pageSize?: number;
+}
 /**
  * 下拉选项接口
  * @description 用于 Select 组件的选项数据格式
@@ -398,6 +484,25 @@ export interface BaseModelMethods {
      * ```
      */
     excelExport<T = string>(params?: ListParams): Promise<T>;
+    /**
+     * 聚合查询
+     * @template T 返回数据的类型
+     * @param params 聚合查询参数，支持 SUM、COUNT、AVG 等聚合函数，以及 GROUP BY、HAVING、JOIN
+     * @returns 返回分页数据
+     * @example
+     * ```typescript
+     * const result = await model.aggregate({
+     *   select: ['category_id'],
+     *   aggregate: [
+     *     { type: 'SUM', field: 'amount', alias: 'total_amount', round: true, precision: 2 }
+     *   ],
+     *   groupBy: ['category_id'],
+     *   having: [{ columnName: 'total_amount', condition: { $gte: 1000 } }],
+     *   orderBy: [{ total_amount: SortOrder.DESC }]
+     * });
+     * ```
+     */
+    aggregate<T = any>(params?: AggregateParams): Promise<ListResponse<T>>;
 }
 /**
  * 模型管理器接口

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lovrabet/sdk",
-  "version": "1.2.5-beta.1",
+  "version": "1.2.6",
   "license": "SEE LICENSE IN LICENSE",
   "main": "dist/index.js",
   "module": "dist/index.js",