@lovrabet/sdk 1.1.14 → 1.1.16

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

@@ -1,4 +1,4 @@
-import type { BaseModelMethods, ListParams, ListResponse, ModelConfig, ClientConfig } from '../types';
+import type { BaseModelMethods, ListParams, ListResponse, ModelConfig, ClientConfig, SortList } from '../types';
 import type { HttpClient } from '../http/http-client';
 /**
  * 抽象基础模型类
@@ -13,8 +13,8 @@ export declare abstract class AbstractBaseModel implements BaseModelMethods {
     constructor(modelName: string, httpClient: HttpClient, globalConfig: ClientConfig);
     private resolveModelConfig;
     protected abstract getApiPath(method: string): string;
-    protected abstract buildRequestBody(method: string, data: any): any;
-    getList<T = any>(params?: ListParams): Promise<ListResponse<T>>;
+    protected abstract buildRequestBody(method: string, data: any, sortList?: SortList): any;
+    getList<T = any>(params?: ListParams, sortList?: SortList): 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

@@ -1,4 +1,5 @@
 import { AbstractBaseModel } from './abstract-base-model';
+import type { SortList } from '../types';
 /**
  * OpenAPI 模型实现
  * 处理 OpenAPI 模式下的 URL 生成和请求体构建
@@ -13,5 +14,5 @@ export declare class OpenApiModel extends AbstractBaseModel {
      * 认证信息（token、timeStamp）由 HttpClient 自动添加到请求头（Header）中
      * 请求体只包含业务数据
      */
-    protected buildRequestBody(method: string, data: any): any;
+    protected buildRequestBody(method: string, data: any, sortList?: SortList): any;
 }

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

@@ -1,4 +1,5 @@
 import { AbstractBaseModel } from './abstract-base-model';
+import type { SortList } from '../types';
 /**
  * WebAPI 模型实现
  * 处理 WebAPI 模式下的 URL 生成和请求体构建
@@ -11,5 +12,5 @@ export declare class WebApiModel extends AbstractBaseModel {
     /**
      * WebAPI 模式的请求体构建策略
      */
-    protected buildRequestBody(method: string, data: any): any;
+    protected buildRequestBody(method: string, data: any, sortList?: SortList): any;
 }

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

@@ -13,6 +13,28 @@
  * @description 支持的运行环境，用于区分不同的 API 端点
  */
 export type Environment = 'online' | 'daily';
+/**
+ * 排序方向枚举
+ * @description 定义数据排序的方向
+ */
+export declare enum SortOrder {
+    /** 升序 */
+    ASC = "asc",
+    /** 降序 */
+    DESC = "desc"
+}
+/**
+ * 排序配置类型
+ * @description 定义排序规则的 key-value 格式，key 为字段名，value 为排序方向
+ * @example
+ * ```typescript
+ * const sortList: SortList = [
+ *   { "id": SortOrder.DESC },
+ *   { "name": SortOrder.ASC }
+ * ];
+ * ```
+ */
+export type SortList = Record<string, SortOrder>[];
 /**
  * 列表查询参数接口
  * @description 用于分页查询的通用参数接口
@@ -49,6 +71,8 @@ export interface ModelConfig {
     tableName: string;
     /** 数据集代码 */
     datasetCode: string;
+    /** 数据集名称 */
+    name?: string;
 }
 /**
  * 模型配置集合接口
@@ -146,9 +170,10 @@ export interface BaseModelMethods {
      * 获取数据列表
      * @template T 返回数据的类型
      * @param params 查询参数，包含分页等信息
+     * @param sortList 排序配置列表，可选参数
      * @returns 返回分页数据
      */
-    getList<T = any>(params?: ListParams): Promise<ListResponse<T>>;
+    getList<T = any>(params?: ListParams, sortList?: SortList): Promise<ListResponse<T>>;
     /**
      * 获取单条数据
      * @template T 返回数据的类型

package/package.json

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