@lovrabet/sdk 1.1.20 → 1.1.21

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

@@ -1,4 +1,4 @@
-import type { BaseModelMethods, ListParams, ListResponse, ModelConfig, ClientConfig, SortList, SelectOption, SelectOptionsParams } from '../types';
+import type { BaseModelMethods, ListParams, ListResponse, ModelConfig, ClientConfig, SortList, SelectOption, SelectOptionsParams, FilterParams } from '../types';
 import type { HttpClient } from '../http/http-client';
 /**
  * 抽象基础模型类
@@ -15,6 +15,7 @@ export declare abstract class AbstractBaseModel implements BaseModelMethods {
     protected abstract getApiPath(method: string): string;
     protected abstract buildRequestBody(method: string, data: any, sortList?: SortList): any;
     getList<T = any>(params?: ListParams, sortList?: SortList): Promise<ListResponse<T>>;
+    filter<T = any>(params?: FilterParams): Promise<ListResponse<T>>;
     getOne<T = any>(id: string | number): Promise<T>;
     create<T = any>(data: Record<string, any>): Promise<T>;
     update<T = any>(id: string | number, data: Record<string, any>): Promise<T>;

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

@@ -15,9 +15,14 @@ export declare class OpenApiModel extends AbstractBaseModel {
      * 请求体只包含业务数据
      */
     protected buildRequestBody(method: string, data: any, sortList?: SortList): any;
+    /**
+     * OpenAPI 模式暂不支持 filter 操作
+     * @throws Error 当尝试调用 filter 时抛出错误
+     */
+    filter(): Promise<any>;
     /**
      * OpenAPI 模式暂不支持 delete 操作
      * @throws Error 当尝试调用 delete 时抛出错误
      */
-    delete(id: string | number): Promise<void>;
+    delete(): Promise<void>;
 }

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

@@ -62,6 +62,84 @@ export interface ListResponse<T> {
     /** 每页数量 */
     pageSize: number;
 }
+/**
+ * 条件操作符类型
+ * @description 用于构建查询条件的操作符
+ *
+ * 支持的操作符：
+ * - $eq: 等于
+ * - $ne: 不等于
+ * - $gte / $gteq: 大于等于
+ * - $lte / $lteq: 小于等于
+ * - $in: 在集合内
+ * - $contain: 包含（模糊匹配）
+ * - $startWith: 以...开头
+ * - $endWith: 以...结尾
+ */
+export type ConditionOperator = '$eq' | '$ne' | '$gte' | '$gteq' | '$lte' | '$lteq' | '$in' | '$contain' | '$startWith' | '$endWith';
+/**
+ * 字段条件类型
+ * @description 单个字段的查询条件
+ * @example
+ * ```typescript
+ * // 等于
+ * { age: { $eq: 18 } }
+ * // 区间
+ * { age: { $gte: 18, $lte: 45 } }
+ * // 包含
+ * { country: { $in: ['中国', '美国', '日本'] } }
+ * // 模糊匹配
+ * { name: { $contain: 'hello' } }
+ * ```
+ */
+export type FieldCondition = {
+    [K in ConditionOperator]?: any;
+};
+/**
+ * Where 条件类型
+ * @description 支持字段条件和逻辑连接符的递归定义
+ */
+export type WhereCondition = {
+    $and?: WhereCondition[];
+    $or?: WhereCondition[];
+    [field: string]: FieldCondition | WhereCondition[] | any;
+};
+/**
+ * Filter 参数接口
+ * @description 用于 filter 方法的查询参数
+ * @example
+ * ```typescript
+ * const filterParams: FilterParams = {
+ *   where: {
+ *     $and: [
+ *       { age: { $gte: 18, $lte: 45 } },
+ *       { country: { $in: ['中国', '美国', '日本'] } },
+ *       { vip: { $ne: null } },
+ *       { name: { $contain: 'hello' } }
+ *     ]
+ *   },
+ *   select: ['id', 'name', 'age', 'country', 'lastLoginAt'],
+ *   orderBy: [
+ *     { lastLoginAt: SortOrder.DESC },
+ *     { name: SortOrder.ASC }
+ *   ],
+ *   currentPage: 1,
+ *   pageSize: 20
+ * };
+ * ```
+ */
+export interface FilterParams {
+    /** Where 条件 */
+    where?: WhereCondition;
+    /** 选择返回的字段列表 */
+    select?: string[];
+    /** 排序规则 */
+    orderBy?: SortList;
+    /** 当前页码，从 1 开始 */
+    currentPage?: number;
+    /** 每页数量 */
+    pageSize?: number;
+}
 /**
  * 下拉选项接口
  * @description 用于 Select 组件的选项数据格式
@@ -203,6 +281,30 @@ export interface BaseModelMethods {
      * @returns 返回分页数据
      */
     getList<T = any>(params?: ListParams, sortList?: SortList): Promise<ListResponse<T>>;
+    /**
+     * 高级过滤查询（推荐使用）
+     * @template T 返回数据的类型
+     * @param params Filter 查询参数，支持复杂条件、字段选择、排序和分页
+     * @returns 返回分页数据
+     * @description 提供比 getList 更强大的查询能力，支持复杂的 where 条件、字段选择等（仅 WebAPI 模式支持）
+     * @example
+     * ```typescript
+     * const result = await model.filter({
+     *   where: {
+     *     $and: [
+     *       { age: { $gte: 18, $lte: 45 } },
+     *       { country: { $in: ['中国', '美国', '日本'] } },
+     *       { name: { $contain: 'hello' } }
+     *     ]
+     *   },
+     *   select: ['id', 'name', 'age', 'country'],
+     *   orderBy: [{ lastLoginAt: SortOrder.DESC }],
+     *   currentPage: 1,
+     *   pageSize: 20
+     * });
+     * ```
+     */
+    filter<T = any>(params?: FilterParams): Promise<ListResponse<T>>;
     /**
      * 获取单条数据
      * @template T 返回数据的类型

package/package.json

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