@lovrabet/sdk 1.4.3 → 1.5.1-beta.1

package/README.md

@@ -61,6 +61,7 @@ import { createClient } from "@lovrabet/sdk";
 // 使用 accessKey 认证（推荐）
 const client = createClient({
   appCode: "your-app-code",
+  authMode: "openapi", // 使用 accessKey 时必须显式声明；缺省 authMode 一律走 cookie，accessKey 会被忽略
   accessKey: process.env.LOVRABET_ACCESS_KEY,
   models: [
     { tableName: "users", datasetCode: "abc123def456", alias: "users" },
@@ -107,6 +108,7 @@ const { token, timestamp } = await fetch("/api/token").then((r) => r.json());
 // 创建客户端
 const client = createClient({
   appCode: "your-app-code",
+  authMode: "openapi", // 使用 token 时必须显式声明；缺省 authMode 一律走 cookie，token 会被忽略
   token: token,
   timestamp: timestamp,
   models: [
@@ -551,20 +553,40 @@ interface ClientConfig {
   secretKey?: string; // 密钥（可选）
   token?: string; // 预生成 token（浏览器）
   timestamp?: number; // token 时间戳
-  env?: "online" | "daily"; // 环境
+  env?: "production" | "online" | "daily" | "development"; // 环境
+  region?: "cn" | "id"; // 官方节点，默认 cn
+  runtimeDomain?: string; // 企业独立部署覆盖，优先于 region
   models?: ModelsConfig; // 模型配置
 }
 ```
 
+官方印尼节点：
+
+```typescript
+const client = createClient({
+  appCode: "app-xxx",
+  region: "id",
+  env: "production"
+});
+```
+
+企业独立部署直接传入 `runtimeDomain`。解析优先级为：`runtimeDomain` →
+兼容字段 `serverUrl` → 页面注入的 `RUNTIME_API_DOMAIN` → `region + env`
+→ 默认 CN Production。
+
+SDK 会对显式 Runtime 地址去除首尾空白和尾斜杠，并拒绝非法 URL、凭证、
+query 或 fragment。未传 `region` 时默认 `cn`；显式传入 `cn` / `id` 以外的值
+会抛出 `INVALID_REGION`，不会静默请求其他区域。
+
 ### CRUD 操作
 
 ```typescript
-// 查询列表（返回 tableData/total/currentPage/pageSize）
+// 查询列表（返回 tableData 与 paging: totalCount/currentPage/pageSize）
 const response = await client.models.users.getList({
   currentPage: 1,
   pageSize: 20,
 });
-console.log(response.total);     // 总数量
+console.log(response.paging.totalCount); // 总数量
 console.log(response.tableData); // 数据列表
 
 // 查询列表（带排序）
@@ -641,8 +663,8 @@ const result = await client.models.users.filter({
   pageSize: 20
 });
 
-console.log(result.tableData); // 数据列表
-console.log(result.total);     // 总数量
+console.log(result.tableData);           // 数据列表
+console.log(result.paging.totalCount);   // 总数量
 ```
 
 #### 复杂条件组合
@@ -679,12 +701,15 @@ const result = await client.models.users.filter({
 |--------|------|------|
 | `$eq` | 等于 | `{ status: { $eq: 'active' } }` |
 | `$ne` | 不等于 | `{ status: { $ne: 'deleted' } }` |
-| `$gte` / `$gteq` | 大于等于 | `{ age: { $gte: 18 } }` |
-| `$lte` / `$lteq` | 小于等于 | `{ age: { $lte: 65 } }` |
+| `$gt` | 大于 | `{ age: { $gt: 18 } }` |
+| `$lt` | 小于 | `{ age: { $lt: 65 } }` |
+| `$gte`（推荐）/ `$gteq`（兼容旧写法） | 大于等于 | `{ age: { $gte: 18 } }` |
+| `$lte`（推荐）/ `$lteq`（兼容旧写法） | 小于等于 | `{ age: { $lte: 65 } }` |
 | `$in` | 在集合内 | `{ country: { $in: ['中国', '美国'] } }` |
 | `$contain` | 包含（模糊匹配） | `{ name: { $contain: 'test' } }` |
 | `$startWith` | 以...开头 | `{ name: { $startWith: 'Mr.' } }` |
 | `$endWith` | 以...结尾 | `{ email: { $endWith: '@example.com' } }` |
+| `$notNull` | 非空判断 | `{ app_code: { $notNull: true } }` |
 
 #### 逻辑连接符
 
@@ -747,8 +772,8 @@ const result = await client.models.users.filter({
 
 **OpenAPI 模式暂不支持以下操作：**
 
-- ❌ `delete()` - 删除操作（如需删除，请使用 WebAPI 模式）
-- ❌ `getSelectOptions()` - 获取下拉选项（仅 WebAPI 模式支持）
+- ❌ `delete()` - 删除操作（OpenAPI 不支持；WebAPI 与 Client AK 模式可用）
+- ❌ `getSelectOptions()` - 获取下拉选项（OpenAPI 不支持；WebAPI 与 Client AK 模式可用）
 
 ```typescript
 // OpenAPI 模式调用 delete 会抛出错误
@@ -777,6 +802,7 @@ await webApiClient.models.users.delete("user-id"); // ✅ 可以使用
 ```typescript
 // 绝不要在客户端代码中硬编码 accessKey
 const client = createClient({
+  authMode: "openapi",
   accessKey: "sk_live_xxx", // 危险！会暴露密钥
 });
 ```
@@ -788,6 +814,7 @@ const client = createClient({
 ```typescript
 // 使用环境变量存储敏感信息
 const client = createClient({
+  authMode: "openapi", // 使用 accessKey 时必须显式声明；缺省 authMode 一律走 cookie，accessKey 会被忽略
   accessKey: process.env.LOVRABET_ACCESS_KEY,
 });
 ```
@@ -795,9 +822,9 @@ const client = createClient({
 **客户端：**
 
 ```typescript
-// 使用服务端生成的 token
-const { token } = await fetch("/api/token").then((r) => r.json());
-const client = createClient({ token });
+// 使用服务端生成的 token（OpenAPI 预计算 token 必须配对 timestamp）
+const { token, timestamp } = await fetch("/api/token").then((r) => r.json());
+const client = createClient({ authMode: "openapi", token, timestamp });
 ```
 
 ## 🎯 选择正确的认证模式
@@ -939,6 +966,7 @@ const client = createClient({ token });
   ```typescript
   const client = createClient({
     appCode: "your-app-code",
+    authMode: "openapi", // 使用 accessKey 时必须显式声明；缺省 authMode 一律走 cookie
     accessKey: process.env.LOVRABET_ACCESS_KEY, // OpenAPI 模式下使用 filter（v1.1.22+）
     models: [
       { tableName: "users", datasetCode: "abc123def456", alias: "users" },
@@ -1135,6 +1163,7 @@ const client = createClient({ token });
   ```typescript
   const client = createClient({
     appCode: "your-app",
+    authMode: "openapi", // 使用 accessKey 时必须显式声明；缺省 authMode 一律走 cookie
     accessKey: process.env.ACCESS_KEY,
     options: {
       debug: true, // 启用调试日志

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export { createClient } from "./src/client/index";
 export { registerModels, getRegisteredModels, getRegisteredConfigNames, unregisterModels, clearAllRegistrations, } from "./src/config/model-registry";
-export { getApiEndpoint, getAvailableEnvironments, } from "./src/config/endpoints";
-export { CONFIG_NAMES, ENVIRONMENTS, DEFAULTS, HTTP_STATUS, ERROR_MESSAGES, API_PATHS, } from "./src/config/constants";
+export { getApiEndpoint, getAvailableEnvironments, getAvailableRegions, } from "./src/config/endpoints";
+export { CONFIG_NAMES, ENVIRONMENTS, REGIONS, DEFAULTS, HTTP_STATUS, ERROR_MESSAGES, API_PATHS, } from "./src/config/constants";
 export { LovrabetError } from "./src/utils/errors";
 export { safe } from "./src/utils/safe";
 export type { SafeResult } from "./src/utils/safe";
@@ -11,9 +11,11 @@ export { AbstractBaseModel, OpenApiModel, WebApiModel, ClientAkModel, ModelFacto
 export { ApiNamespace } from "./src/api/index";
 export { ServicesNamespace, FileClient, OcrClient, OcrType, OCR_TYPES, } from "./src/services/index";
 export type { LovrabetServices, FileQueryUrlRequest, FileService, FileUploadRequest, FileUploadResponse, FileUrlResponse, OcrRecognizeRequest, OcrRecognizeResponse, OcrService, ServiceRequestOptions, } from "./src/services/index";
+export { PersonalNamespace, PersonalBffClient, } from "./src/personal/index";
+export type { LovrabetPersonal, PersonalBffExecuteRequest, PersonalBffService, PersonalRequestOptions, } from "./src/personal/index";
 export { AuthManager, } from "./src/auth/index";
 export { generateOpenApiToken, TokenGenerator, isTokenExpiring, getTokenRemainingTime, type GenerateTokenParams, type TokenResult } from "./src/auth/index";
-export type { ClientConfig, LovrabetClient, ModelConfig, ModelsConfig, AuthMode, } from "./src/types/index";
+export type { ClientConfig, LovrabetClient, ModelConfig, ModelsConfig, AuthMode, Region, } from "./src/types/index";
 export type { ListParams, ListResponse, FilterParams, WhereCondition, FieldCondition, ConditionOperator, Environment, BaseModelMethods, SortList, SelectOption, SelectOptionsParams, AggregateParams, AggregateField, HavingCondition, } from "./src/types/index";
 export type { SqlExecuteRequest, SqlExecuteResult, } from "./src/api/types";
 export { SortOrder, } from "./src/types/index";