@lovrabet/sdk 1.3.0-beta.2 → 1.3.0

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

@@ -23,18 +23,30 @@ export declare enum SortOrder {
     /** 降序 */
     DESC = "desc"
 }
+/**
+ * 排序方向类型（同时支持枚举和字符串）
+ * @description 支持使用 SortOrder.ASC/DESC 或直接使用 "asc"/"desc" 字符串
+ */
+export type SortOrderValue = SortOrder | "asc" | "desc";
 /**
  * 排序配置类型
  * @description 定义排序规则的 key-value 格式，key 为字段名，value 为排序方向
  * @example
  * ```typescript
- * const sortList: SortList = [
+ * // 使用枚举
+ * const sortList1: SortList = [
  *   { "id": SortOrder.DESC },
  *   { "name": SortOrder.ASC }
  * ];
+ *
+ * // 使用字符串（更简洁）
+ * const sortList2: SortList = [
+ *   { "id": "desc" },
+ *   { "name": "asc" }
+ * ];
  * ```
  */
-export type SortList = Record<string, SortOrder>[];
+export type SortList = Record<string, SortOrderValue>[];
 /**
  * 列表查询参数接口
  * @description 用于分页查询的通用参数接口
@@ -109,16 +121,15 @@ export type WhereCondition = {
  * @description 用于 filter 方法的查询参数
  * @example
  * ```typescript
- * const filterParams: FilterParams = {
+ * // 使用枚举
+ * const filterParams1: FilterParams = {
  *   where: {
  *     $and: [
  *       { age: { $gte: 18, $lte: 45 } },
- *       { country: { $in: ['中国', '美国', '日本'] } },
- *       { vip: { $ne: null } },
- *       { name: { $contain: 'hello' } }
+ *       { country: { $in: ['中国', '美国', '日本'] } }
  *     ]
  *   },
- *   select: ['id', 'name', 'age', 'country', 'lastLoginAt'],
+ *   select: ['id', 'name', 'age', 'country'],
  *   orderBy: [
  *     { lastLoginAt: SortOrder.DESC },
  *     { name: SortOrder.ASC }
@@ -126,6 +137,14 @@ export type WhereCondition = {
  *   currentPage: 1,
  *   pageSize: 20
  * };
+ *
+ * // 或使用字符串（更简洁）
+ * const filterParams2: FilterParams = {
+ *   orderBy: [
+ *     { lastLoginAt: "desc" },
+ *     { name: "asc" }
+ *   ]
+ * };
  * ```
  */
 export interface FilterParams {
@@ -190,7 +209,8 @@ export interface HavingCondition {
  * @description 用于 aggregate 方法的聚合查询参数
  * @example
  * ```typescript
- * const aggregateParams: AggregateParams = {
+ * // 使用枚举
+ * const aggregateParams1: AggregateParams = {
  *   select: ['category_id'],
  *   aggregate: [
  *     { type: 'SUM', field: 'amount', alias: 'total_amount', round: true, precision: 2 }
@@ -204,6 +224,11 @@ export interface HavingCondition {
  *   currentPage: 1,
  *   pageSize: 20
  * };
+ *
+ * // 或使用字符串
+ * const aggregateParams2: AggregateParams = {
+ *   orderBy: [{ total_amount: "desc" }]
+ * };
  * ```
  */
 export interface AggregateParams {
@@ -402,7 +427,8 @@ export interface BaseModelMethods {
      * @description 提供比 getList 更强大的查询能力，支持复杂的 where 条件、字段选择等（仅 WebAPI 模式支持）
      * @example
      * ```typescript
-     * const result = await model.filter({
+     * // 使用枚举
+     * const result1 = await model.filter({
      *   where: {
      *     $and: [
      *       { age: { $gte: 18, $lte: 45 } },
@@ -415,6 +441,11 @@ export interface BaseModelMethods {
      *   currentPage: 1,
      *   pageSize: 20
      * });
+     *
+     * // 或使用字符串（更简洁）
+     * const result2 = await model.filter({
+     *   orderBy: [{ lastLoginAt: "desc" }]
+     * });
      * ```
      */
     filter<T = any>(params?: FilterParams): Promise<ListResponse<T>>;
@@ -491,7 +522,8 @@ export interface BaseModelMethods {
      * @returns 返回分页数据
      * @example
      * ```typescript
-     * const result = await model.aggregate({
+     * // 使用枚举
+     * const result1 = await model.aggregate({
      *   select: ['category_id'],
      *   aggregate: [
      *     { type: 'SUM', field: 'amount', alias: 'total_amount', round: true, precision: 2 }
@@ -500,6 +532,11 @@ export interface BaseModelMethods {
      *   having: [{ columnName: 'total_amount', condition: { $gte: 1000 } }],
      *   orderBy: [{ total_amount: SortOrder.DESC }]
      * });
+     *
+     * // 或使用字符串
+     * const result2 = await model.aggregate({
+     *   orderBy: [{ total_amount: "desc" }]
+     * });
      * ```
      */
     aggregate<T = any>(params?: AggregateParams): Promise<ListResponse<T>>;

package/package.json

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