@shwfed/config 2.4.1 → 2.5.0

package/dist/runtime/components/table/schema.d.ts

@@ -96,6 +96,8 @@ export declare const ColumnGroup: Schema.Struct<{
     }>]>>;
 }>;
 export declare function configureTableActionsScope(env: Environment, configure: (env: Environment) => void): void;
+export declare function registerDataSourceRequestVars(env: Environment): void;
+export declare function registerDataSourceResponseVars(env: Environment): void;
 export declare function DataSource(configure: (env: Environment) => void, extras?: {
     request?: (env: Environment) => void;
     data?: (env: Environment) => void;
@@ -104,9 +106,9 @@ export declare function DataSource(configure: (env: Environment) => void, extras
     data: Schema.Schema<string, string, never>;
 }>;
 export declare function tableDataSource(configure: (env: Environment) => void): Schema.Struct<{
-    total: Schema.optional<Schema.Schema<string, string, never>>;
     request: Schema.optional<Schema.Schema<string, string, never>>;
     data: Schema.Schema<string, string, never>;
+    total: Schema.optional<Schema.Schema<string, string, never>>;
 }>;
 export declare function TableConfig(configure: (env: Environment) => void): Schema.refine<{
     readonly style?: string | undefined;
@@ -304,9 +306,9 @@ export declare function TableConfig(configure: (env: Environment) => void): Sche
         default: () => never[];
     }>;
     dataSource: Schema.optional<Schema.Struct<{
-        total: Schema.optional<Schema.Schema<string, string, never>>;
         request: Schema.optional<Schema.Schema<string, string, never>>;
         data: Schema.Schema<string, string, never>;
+        total: Schema.optional<Schema.Schema<string, string, never>>;
     }>>;
     actions: Schema.optional<Schema.Struct<{
         size: Schema.optionalWith<Schema.Literal<["default", "sm", "xs"]>, {

package/dist/runtime/components/table/schema.js

@@ -1,6 +1,7 @@
 import { Schema } from "effect";
 import { Expression } from "../../share/expression.js";
 import { Locale } from "../../share/locale.js";
+import { md } from "../../share/markdown.js";
 import { ActionSchemaFields } from "../actions/schema.js";
 import { FormConfig } from "../form/schema.js";
 import { allColumnSchemas } from "./utils/resolve.js";
@@ -127,6 +128,15 @@ export const ColumnGroup = Schema.Struct({
   description: "\u5217\u5206\u7EC4\u5B9A\u4E49"
 });
 const QUERY_VAR_DESCRIPTION = "\u641C\u7D22\u6761\u4EF6\u5F53\u524D\u72B6\u6001\uFF1B\u672A\u914D\u7F6E\u641C\u7D22\u6761\u4EF6\u65F6\u4E3A\u7A7A\u5BF9\u8C61";
+const JSON_VAR_DESCRIPTION = "\u5DF2\u89E3\u6790\u7684 JSON \u54CD\u5E94\uFF1B\u672A\u914D\u7F6E `request` \u65F6\u4E3A `none`";
+const SORTS_VAR_DESCRIPTION = md`
+  当前的排序状态，为一个**列表**，每个元素包含两个字段：
+
+  - \`key: string\` 为该列上配置的键
+  - \`mode: 'asc' | 'desc'\` 为该列的排序状态
+
+  未排序的字段，**不会出现在这个列表中**。
+`;
 export function configureTableActionsScope(env, configure) {
   configure(env);
   env.registerVariable("selected", "list<dyn>", {
@@ -137,6 +147,38 @@ export function configureTableActionsScope(env, configure) {
     label: "\u641C\u7D22\u6761\u4EF6",
     description: QUERY_VAR_DESCRIPTION
   });
+  env.registerVariable("sorts", "list<map<string, string>>", {
+    label: "\u6392\u5E8F\u72B6\u6001",
+    description: SORTS_VAR_DESCRIPTION
+  });
+}
+export function registerDataSourceRequestVars(env) {
+  env.registerVariable("pageIndex", "number", {
+    label: "\u5F53\u524D\u9875\u7801",
+    description: "\u4ECE `0` \u5F00\u59CB\uFF1B\u672A\u542F\u7528\u5206\u9875\u65F6\u4E3A `0`"
+  });
+  env.registerVariable("pageSize", "number", {
+    label: "\u6BCF\u9875\u884C\u6570",
+    description: "\u5F53\u524D\u6BCF\u9875\u884C\u6570\uFF1B\u672A\u542F\u7528\u5206\u9875\u65F6\u4E3A `0`"
+  });
+  env.registerVariable("sorts", "list<map<string, string>>", {
+    label: "\u6392\u5E8F\u72B6\u6001",
+    description: SORTS_VAR_DESCRIPTION
+  });
+  env.registerVariable("query", "dyn", {
+    label: "\u641C\u7D22\u6761\u4EF6",
+    description: QUERY_VAR_DESCRIPTION
+  });
+}
+export function registerDataSourceResponseVars(env) {
+  env.registerVariable("json", "optional<dyn>", {
+    label: "HTTP \u54CD\u5E94\u4F53",
+    description: JSON_VAR_DESCRIPTION
+  });
+  env.registerVariable("query", "dyn", {
+    label: "\u641C\u7D22\u6761\u4EF6",
+    description: QUERY_VAR_DESCRIPTION
+  });
 }
 export function DataSource(configure, extras) {
   const CelRequest = Expression({
@@ -171,28 +213,36 @@ export function DataSource(configure, extras) {
   });
 }
 export function tableDataSource(configure) {
-  const base = DataSource(configure, {
-    request: (env) => {
-      env.registerVariable("pageIndex", "number", { description: "\u5F53\u524D\u9875\u7801\uFF08\u4ECE 0 \u5F00\u59CB\uFF09\uFF1B\u672A\u542F\u7528\u5206\u9875\u65F6\u4E3A 0" });
-      env.registerVariable("pageSize", "number", { description: "\u6BCF\u9875\u884C\u6570\uFF1B\u672A\u542F\u7528\u5206\u9875\u65F6\u4E3A 0" });
-      env.registerVariable("query", "dyn", { description: QUERY_VAR_DESCRIPTION });
+  const CelRequest = Expression({
+    configure: (env) => {
+      configure(env);
+      registerDataSourceRequestVars(env);
     },
-    data: (env) => {
-      env.registerVariable("query", "dyn", { description: QUERY_VAR_DESCRIPTION });
-    }
+    resultType: "HttpRequest"
+  });
+  const CelRows = Expression({
+    configure: (env) => {
+      configure(env);
+      registerDataSourceResponseVars(env);
+    },
+    resultType: (type) => type.startsWith("list") || type === "dyn" || type.startsWith("optional")
   });
   const CelTotal = Expression({
     configure: (env) => {
       configure(env);
-      env.registerVariable("json", "optional<dyn>", {
-        description: "HTTP \u54CD\u5E94\u4F53\uFF08\u5DF2\u89E3\u6790 JSON\uFF09\uFF1B\u672A\u914D\u7F6E request \u65F6\u4E3A none"
-      });
-      env.registerVariable("query", "dyn", { description: QUERY_VAR_DESCRIPTION });
+      registerDataSourceResponseVars(env);
     },
     resultType: (type) => type === "number" || type === "dyn" || type.startsWith("optional")
   });
   return Schema.Struct({
-    ...base.fields,
+    request: Schema.optional(CelRequest).annotations({
+      title: "\u8BF7\u6C42",
+      description: "\u53EF\u9009\u7684 HTTP \u8BF7\u6C42\u8868\u8FBE\u5F0F\uFF1B\u672A\u914D\u7F6E\u65F6\u6570\u636E\u4ECE `data` \u8868\u8FBE\u5F0F\u4E2D\u8BFB\u53D6\uFF08\u901A\u5E38\u5F15\u7528\u4E0A\u4E0B\u6587\u53D8\u91CF\uFF09"
+    }),
+    data: CelRows.annotations({
+      title: "\u6570\u636E",
+      description: "\u8FD4\u56DE\u884C\u6570\u636E\u5217\u8868\uFF08`list<dyn>`\uFF09\u7684 CEL \u8868\u8FBE\u5F0F\uFF1B\u5728\u914D\u7F6E\u4E86 `request` \u65F6\u53EF\u901A\u8FC7 `json` \u5F15\u7528\u54CD\u5E94\u4F53"
+    }),
     total: Schema.optional(CelTotal).annotations({
       title: "\u603B\u6570",
       description: "\u8FD4\u56DE\u603B\u884C\u6570\uFF08`number`\uFF09\u7684 CEL \u8868\u8FBE\u5F0F\uFF1B\u914D\u7F6E\u540E\u542F\u7528\u670D\u52A1\u7AEF\u5206\u9875\uFF0C\u7559\u7A7A\u5219\u8D70\u524D\u7AEF\u5206\u9875"
@@ -283,6 +333,12 @@ export function TableConfig(configure) {
     if (cfg.dataSource?.total !== void 0 && cfg.pagination === void 0) {
       return "\u914D\u7F6E\u4E86 dataSource.total \u65F6\u5FC5\u987B\u542F\u7528\u5206\u9875";
     }
+    for (const col of cfg.columns) {
+      const c = col;
+      if (c.enableSorting === true && (c.sortKey === void 0 || c.sortKey.length === 0)) {
+        return "\u542F\u7528\u6392\u5E8F\u7684\u5217\u5FC5\u987B\u586B\u5199\u300C\u6392\u5E8F\u5B57\u6BB5\u300D(sortKey)";
+      }
+    }
     return true;
   })).annotations({
     title: "TableConfig",

package/dist/runtime/components/table/utils/shared.d.ts

@@ -17,6 +17,7 @@ export declare function columnFields(configure: (env: Environment) => void): {
     }>]>;
     accessor: Schema.Schema<string, string, never>;
     enableSorting: Schema.optional<Schema.SchemaClass<boolean, boolean, never>>;
+    sortKey: Schema.optional<Schema.refine<string, typeof Schema.String>>;
     size: Schema.optional<Schema.refine<number, Schema.filter<typeof Schema.Number>>>;
     grow: Schema.optional<Schema.SchemaClass<boolean, boolean, never>>;
     tooltip: Schema.optional<Schema.TupleType<readonly [Schema.Struct<{
@@ -39,6 +40,7 @@ export declare function editableColumnFields(): {
     }>]>;
     binding: Schema.refine<string, typeof Schema.String>;
     enableSorting: Schema.optional<Schema.SchemaClass<boolean, boolean, never>>;
+    sortKey: Schema.optional<Schema.refine<string, typeof Schema.String>>;
     size: Schema.optional<Schema.refine<number, Schema.filter<typeof Schema.Number>>>;
     grow: Schema.optional<Schema.SchemaClass<boolean, boolean, never>>;
     tooltip: Schema.optional<Schema.TupleType<readonly [Schema.Struct<{

package/dist/runtime/components/table/utils/shared.js

@@ -36,9 +36,13 @@ export function columnFields(configure) {
         | 数据量 | **全量**，能够跨越多页 | 当前页 |
         | 开发量 | 需要后端支持，可能影响性能 | **配置即启用，无需后端支持** |
 
-        注意：对于服务端排序，除了在这里打开排序开关，你还需要在「通用配置 → 数据源 → 请求」处，**将正在排序字段、排序状态传给后端**。
+        注意：对于服务端排序，除了在这里打开排序开关，你还需要在「通用配置 → 数据源 → 请求」处，通过 \`sorts\` 变量**将各列「排序字段」(sortKey)、排序方向传给后端**。
       `
     })),
+    sortKey: Schema.optional(Schema.String.pipe(Schema.minLength(1)).annotations({
+      title: "\u6392\u5E8F\u5B57\u6BB5",
+      description: "\u670D\u52A1\u7AEF\u6392\u5E8F\u65F6\u901A\u8FC7\u6570\u636E\u6E90\u8BF7\u6C42\u7684 `sorts` \u53D8\u91CF\u4F20\u7ED9\u540E\u7AEF\u7684\u5B57\u6BB5\u6807\u8BC6\uFF1B\u542F\u7528\u6392\u5E8F\u65F6\u5FC5\u586B"
+    })),
     size: Schema.optional(Schema.Number.pipe(Schema.finite(), Schema.positive()).annotations({
       title: "\u5217\u5BBD",
       description: "\u6307\u5B9A\u4E00\u4E2A\u5408\u9002\u7684\u8868\u683C\u5217\u5BBD\u5EA6\uFF0C\u5F53\u5217\u5185\u5BB9\u957F\u5EA6\u5927\u4E8E\u8FD9\u91CC\u6307\u5B9A\u7684\u5BBD\u5EA6\u540E\uFF0C\u4F1A\u5BFC\u81F4\u8D85\u51FA\u7684\u90E8\u5206\u88AB\u622A\u65AD\u3002"
@@ -57,7 +61,11 @@ export function editableColumnFields() {
     }),
     enableSorting: Schema.optional(Schema.Boolean.annotations({
       title: "\u5141\u8BB8\u6392\u5E8F",
-      description: "\u663E\u793A\u6392\u5E8F\u6309\u94AE\uFF1B\u542F\u7528\u5BA2\u6237\u7AEF\u6392\u5E8F\uFF0C\u6309\u5F53\u524D `binding` \u8DEF\u5F84\u4E0A\u7684\u503C\u6392\u5E8F"
+      description: "\u663E\u793A\u6392\u5E8F\u6309\u94AE\uFF1B\u5BA2\u6237\u7AEF\u6392\u5E8F\u6309\u5F53\u524D `binding` \u8DEF\u5F84\u4E0A\u7684\u503C\u6392\u5E8F\uFF0C\u670D\u52A1\u7AEF\u6392\u5E8F\u5219\u901A\u8FC7\u6570\u636E\u6E90\u8BF7\u6C42\u7684 `sorts` \u53D8\u91CF\u5C06\u300C\u6392\u5E8F\u5B57\u6BB5\u300D(sortKey) \u4F20\u7ED9\u540E\u7AEF"
+    })),
+    sortKey: Schema.optional(Schema.String.pipe(Schema.minLength(1)).annotations({
+      title: "\u6392\u5E8F\u5B57\u6BB5",
+      description: "\u670D\u52A1\u7AEF\u6392\u5E8F\u65F6\u901A\u8FC7\u6570\u636E\u6E90\u8BF7\u6C42\u7684 `sorts` \u53D8\u91CF\u4F20\u7ED9\u540E\u7AEF\u7684\u5B57\u6BB5\u6807\u8BC6\uFF1B\u542F\u7528\u6392\u5E8F\u65F6\u5FC5\u586B"
     })),
     size: Schema.optional(Schema.Number.pipe(Schema.finite(), Schema.positive()).annotations({
       title: "\u5217\u5BBD",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shwfed/config",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "description": "Configurable UI for SHWFED",
   "type": "module",
   "publishConfig": {

package/dist/preview/assets/index-CIrlYN0M.js

@@ -1 +0,0 @@
-import{aO as e}from"./index-DUDlWaQI.js";import{aP as r,aQ as s,aR as t}from"./index-DUDlWaQI.js";export{r as TableConfig,s as createTableConfig,e as default,t as getColumnTechnicalKey};