@lovrabet/sdk 1.1.15 → 1.1.17

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, SelectOption, SelectOptionsParams } from '../types';
 import type { HttpClient } from '../http/http-client';
 /**
  * 抽象基础模型类
@@ -13,13 +13,14 @@ 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>;
     delete(id: string | number): Promise<void>;
     getDatasetList<T = any>(): Promise<T[]>;
+    getSelectOptions(params: SelectOptionsParams): Promise<SelectOption[]>;
     private isOpenApiMode;
     getConfig(): ModelConfig;
     getModelName(): string;

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,10 @@ 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;
+    /**
+     * OpenAPI 模式暂不支持 delete 操作
+     * @throws Error 当尝试调用 delete 时抛出错误
+     */
+    delete(id: string | number): Promise<void>;
 }

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 用于分页查询的通用参数接口
@@ -40,6 +62,35 @@ export interface ListResponse<T> {
     /** 每页数量 */
     pageSize: number;
 }
+/**
+ * 下拉选项接口
+ * @description 用于 Select 组件的选项数据格式
+ */
+export interface SelectOption {
+    /** 显示文本 */
+    label: string;
+    /** 选项值 */
+    value: string;
+}
+/**
+ * 获取下拉选项的参数接口
+ * @description 指定用于生成下拉选项的字段映射
+ * @example
+ * ```typescript
+ * // 获取用户列表的下拉选项
+ * const options = await model.getSelectOptions({
+ *   code: 'user_id',   // 将 user_id 字段作为 value
+ *   label: 'user_name' // 将 user_name 字段作为 label
+ * });
+ * // 返回: [{ label: '张三', value: 'user001' }, ...]
+ * ```
+ */
+export interface SelectOptionsParams {
+    /** 用作选项值的字段名 */
+    code: string;
+    /** 用作显示文本的字段名 */
+    label: string;
+}
 /**
  * 单个模型配置接口
  * @description 定义数据模型的基本配置信息
@@ -148,9 +199,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 返回数据的类型
@@ -177,6 +229,7 @@ export interface BaseModelMethods {
      * 删除数据
      * @param id 要删除的数据 ID
      * @returns Promise<void>
+     * @throws Error OpenAPI 模式暂不支持此操作，仅 WebAPI 模式可用
      */
     delete(id: string | number): Promise<void>;
     /**
@@ -186,6 +239,22 @@ export interface BaseModelMethods {
      * @description 获取当前应用下的所有数据集列表，主要用于 OpenAPI 模式
      */
     getDatasetList<T = any>(): Promise<T[]>;
+    /**
+     * 获取下拉选项
+     * @param params 字段映射参数，指定用作 value 和 label 的字段名
+     * @returns 返回下拉选项数组
+     * @description 用于获取数据表的下拉选项数据，适用于 Select 组件（仅 WebAPI 模式支持）
+     * @example
+     * ```typescript
+     * // 获取用户下拉选项
+     * const options = await model.getSelectOptions({
+     *   code: 'user_id',
+     *   label: 'user_name'
+     * });
+     * // 返回: [{ label: '张三', value: 'user001' }, { label: '李四', value: 'user002' }]
+     * ```
+     */
+    getSelectOptions(params: SelectOptionsParams): Promise<SelectOption[]>;
 }
 /**
  * 模型管理器接口

package/package.json

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