@pylonts/dsl 1.1.4 → 1.1.5

package/src/curd.ts

@@ -1,94 +1,94 @@
-import { SchemaBase, Field, Operator } from './dsl.js';
-import { TableSchema } from './db.js';
-import { FrontAppSchema } from './project.js';
-import { ActionSchema } from './action.js';
-
-// Admin-only CRUD page standard: binds one entity table to a frontend admin
-// app, describing everything needed to generate the list page plus optional
-// add/update/detail pages. Field-level columns are plain Field instances
-// (table fields, cross-table refs allowed) — DTOs are derived by the generator,
-// the schema itself never references DtoMessage.
-
-/** Mode of an action page: modal dialog or standalone route. */
-export type ActionPageMode = 'modal' | 'route';
-
-/** One CRUD action page (add / update / detail). */
-export interface ActionPage {
-  mode: ActionPageMode;
-  /** For add/update: when true, render as modal on list page; when false/undefined, render as standalone route page. */
-  modal?: boolean;
-  /** Fields rendered on this page. Required, non-empty — every field the
-   *  frontend shows must be listed explicitly. */
-  columns: Field[];
-}
-
-/** List page configuration. */
-export interface CurdListConfig {
-  /** List columns; required, non-empty. Every field the list shows must be
-   *  listed explicitly. May include cross-table fields via foreign refs. */
-  columns: Field[];
-  /** Fuzzy keyword search on this table's columns. */
-  keyword?: { columns: Field[] };
-  /** Default sort. Required — column and direction are both mandatory. */
-  orderBy: { column: Field; direction: 'asc' | 'desc' };
-  /** Search condition fields; op defaults to 'eq'. */
-  searchFields?: { field: Field; op?: Operator }[];
-  /** Column header text overrides: Field.name → header text. */
-  columnTitles?: Record<string, string>;
-}
-
-/** Admin-only CRUD page standard: binds one entity table to a frontend
- *  admin app. Drives generation of the list page plus optional
- *  add/update/detail pages. */
-export interface CurdSchema extends SchemaBase {
-  /** The admin frontend app this CRUD belongs to (shared instance, type must be 'admin'). */
-  app: FrontAppSchema;
-  /** The bound entity table (shared instance). */
-  table: TableSchema;
-  /** List page Chinese title. */
-  title: string;
-  /** Sidebar menu section (group) this CRUD page belongs to. */
-  section: string;
-  /** Extra user actions on this page (beyond the standard CRUD). */
-  actions?: ActionSchema[];
-  /** Add/update/detail action pages. */
-  actionPages?: {
-    add?: ActionPage;
-    update?: ActionPage;
-    detail?: ActionPage;
-  };
-  list: CurdListConfig;
-}
-
-function assertColumns(curd: CurdSchema, pageName: string, columns: Field[]): void {
-  if (columns.length === 0) {
-    throw new Error(`curd ${curd.name}: ${pageName}.columns must be non-empty`);
-  }
-}
-
-function assertFieldsOwnTable(curd: CurdSchema, label: string, fields: Field[]): void {
-  for (const f of fields) {
-    if (f.schema !== curd.table) {
-      throw new Error(`curd ${curd.name}: ${label} field ${f.name} does not belong to table ${curd.table.name}`);
-    }
-  }
-}
-
-/** Defines an admin CRUD page standard. Runtime-validates admin app binding,
- *  non-empty columns and table field ownership (same style as defineTable). */
-export function defineCurd(name: string, schema: Omit<CurdSchema, 'name'>): CurdSchema {
-  const curd: CurdSchema = { name, ...schema };
-  if (curd.app.type !== 'admin') {
-    throw new Error(`curd ${name}: app ${curd.app.name} must be type 'admin' (got '${curd.app.type}')`);
-  }
-  if (!curd.section) {
-    throw new Error(`curd ${name}: section is required (sidebar menu group, e.g. '商户管理')`);
-  }
-  assertColumns(curd, 'list', curd.list.columns);
-  for (const [pageName, page] of Object.entries(curd.actionPages ?? {})) {
-    if (page) assertColumns(curd, `actionPages.${pageName}`, page.columns);
-  }
-  assertFieldsOwnTable(curd, 'keyword', curd.list.keyword?.columns ?? []);
-  assertFieldsOwnTable(curd, 'orderBy', [curd.list.orderBy.column]);
-  return curd;
+import { SchemaBase, Field, Operator } from './dsl.js';
+import { TableSchema } from './db.js';
+import { FrontAppSchema } from './project.js';
+import { ActionSchema } from './action.js';
+
+// Admin-only CRUD page standard: binds one entity table to a frontend admin
+// app, describing everything needed to generate the list page plus optional
+// add/update/detail pages. Field-level columns are plain Field instances
+// (table fields, cross-table refs allowed) — DTOs are derived by the generator,
+// the schema itself never references DtoMessage.
+
+/** Mode of an action page: modal dialog or standalone route. */
+export type ActionPageMode = 'modal' | 'route';
+
+/** One CRUD action page (add / update / detail). */
+export interface ActionPage {
+  mode: ActionPageMode;
+  /** For add/update: when true, render as modal on list page; when false/undefined, render as standalone route page. */
+  modal?: boolean;
+  /** Fields rendered on this page. Required, non-empty — every field the
+   *  frontend shows must be listed explicitly. */
+  columns: Field[];
+}
+
+/** List page configuration. */
+export interface CurdListConfig {
+  /** List columns; required, non-empty. Every field the list shows must be
+   *  listed explicitly. May include cross-table fields via foreign refs. */
+  columns: Field[];
+  /** Fuzzy keyword search on this table's columns. */
+  keyword?: { columns: Field[] };
+  /** Default sort. Required — column and direction are both mandatory. */
+  orderBy: { column: Field; direction: 'asc' | 'desc' };
+  /** Search condition fields; op defaults to 'eq'. */
+  searchFields?: { field: Field; op?: Operator }[];
+  /** Column header text overrides: Field.name → header text. */
+  columnTitles?: Record<string, string>;
+}
+
+/** Admin-only CRUD page standard: binds one entity table to a frontend
+ *  admin app. Drives generation of the list page plus optional
+ *  add/update/detail pages. */
+export interface CurdSchema extends SchemaBase {
+  /** The admin frontend app this CRUD belongs to (shared instance, type must be 'admin'). */
+  app: FrontAppSchema;
+  /** The bound entity table (shared instance). */
+  table: TableSchema;
+  /** List page Chinese title. */
+  title: string;
+  /** Sidebar menu section (group) this CRUD page belongs to. */
+  section: string;
+  /** Extra user actions on this page (beyond the standard CRUD). */
+  actions?: ActionSchema[];
+  /** Add/update/detail action pages. */
+  actionPages?: {
+    add?: ActionPage;
+    update?: ActionPage;
+    detail?: ActionPage;
+  };
+  list: CurdListConfig;
+}
+
+function assertColumns(curd: CurdSchema, pageName: string, columns: Field[]): void {
+  if (columns.length === 0) {
+    throw new Error(`curd ${curd.name}: ${pageName}.columns must be non-empty`);
+  }
+}
+
+function assertFieldsOwnTable(curd: CurdSchema, label: string, fields: Field[]): void {
+  for (const f of fields) {
+    if (f.schema !== curd.table) {
+      throw new Error(`curd ${curd.name}: ${label} field ${f.name} does not belong to table ${curd.table.name}`);
+    }
+  }
+}
+
+/** Defines an admin CRUD page standard. Runtime-validates admin app binding,
+ *  non-empty columns and table field ownership (same style as defineTable). */
+export function defineCurd(name: string, schema: Omit<CurdSchema, 'name'>): CurdSchema {
+  const curd: CurdSchema = { name, ...schema };
+  if (curd.app.type !== 'admin') {
+    throw new Error(`curd ${name}: app ${curd.app.name} must be type 'admin' (got '${curd.app.type}')`);
+  }
+  if (!curd.section) {
+    throw new Error(`curd ${name}: section is required (sidebar menu group, e.g. '商户管理')`);
+  }
+  assertColumns(curd, 'list', curd.list.columns);
+  for (const [pageName, page] of Object.entries(curd.actionPages ?? {})) {
+    if (page) assertColumns(curd, `actionPages.${pageName}`, page.columns);
+  }
+  assertFieldsOwnTable(curd, 'keyword', curd.list.keyword?.columns ?? []);
+  assertFieldsOwnTable(curd, 'orderBy', [curd.list.orderBy.column]);
+  return curd;
 }

package/src/dao.ts

@@ -1,13 +1,13 @@
-import { SchemaBase } from './dsl.js';
-import { FrontAppSchema } from './project.js';
-
-/** A data-access layer bound to exactly one frontend app. */
-export interface DaoSchema extends SchemaBase {
-  type: 'dao';
-  /** The frontend app this DAO belongs to (shared instance from project.config). */
-  app: FrontAppSchema;
-}
-
-export function defineDao(name: string, app: FrontAppSchema, description?: string): DaoSchema {
-  return { name, type: 'dao', app, description };
-}
+import { SchemaBase } from './dsl.js';
+import { FrontAppSchema } from './project.js';
+
+/** A data-access layer bound to exactly one frontend app. */
+export interface DaoSchema extends SchemaBase {
+  type: 'dao';
+  /** The frontend app this DAO belongs to (shared instance from project.config). */
+  app: FrontAppSchema;
+}
+
+export function defineDao(name: string, app: FrontAppSchema, description?: string): DaoSchema {
+  return { name, type: 'dao', app, description };
+}

package/src/db.ts

@@ -1,182 +1,182 @@
-// DB table definitions.
-// Shape: { type: 'table', <extension fields> }
-
-import type { EntityPhrase } from './dictionary.js';
-import type { CollectionSchemaBase, EnumDef, Field } from './dsl.js';
-
-export type Index = {
-  name?: string;
-  columns: Field | Field[];
-  unique?: boolean;
-};
-
-export type ForeignKey = {
-  columns: Field | Field[];
-  references: Field | Field[];
-};
-
-export interface TableSchemaOptions<
-  N extends string = string,
-  C extends Record<string, Field> = Record<string, Field>,
-  E extends Record<string, EnumDef> = Record<string, EnumDef>
-> {
-  description?: string;
-  paginated: boolean;
-  actor?: boolean;
-  generator?: string;
-  autoIncrement?: Field;
-  /** 本表用于关联显示的名称字段（如 name / username）。被外键引用时，自动用该字段做 label 展示。 */
-  label?: Field;
-  primaryKey?: Field | Field[];
-  indexes?: Index[];
-  foreignKeys?: Record<string, ForeignKey>;
-  /** 引用的实体短语（词典条目）：本表归属的实体；关联表等多实体场景不需要 */
-  phrase?: EntityPhrase;
-  /** 本表引用的所有枚举定义（map，key 为枚举标识），显式声明供 gen-enums 收集 */
-  enums: E;
-  columns: C;
-}
-
-export class TableSchema<
-  N extends string = string,
-  C extends Record<string, Field> = Record<string, Field>,
-  E extends Record<string, EnumDef> = Record<string, EnumDef>
-> implements CollectionSchemaBase {
-  type = 'table';
-  name: N;
-  description?: string;
-  /** 分页 */
-  paginated: boolean;
-  /** 系统操作者（如小程序为 C 端用户，管理端为运营） */
-  actor?: boolean;
-  /** id 生成器 */
-  generator?: string;
-  /** 自增主键字段 */
-  autoIncrement?: Field;
-  primaryKey?: Field | Field[];
-  indexes?: Index[];
-  /** 外键，引用其他表的字段 */
-  foreignKeys?: Record<string, ForeignKey>;
-  /** 本表用于关联显示的名称字段（如 name / username）。被外键引用时，自动用该字段做 label 展示。 */
-  label?: Field;
-  /** 引用的实体短语（词典条目）：本表归属的实体；关联表等多实体场景不需要 */
-  phrase?: EntityPhrase;
-  /** 本表引用的所有枚举定义（map，key 为枚举标识），显式声明供 gen-enums 收集 */
-  enums: E;
-  columns: C;
-
-  constructor(name: N, options: TableSchemaOptions<N, C, E>) {
-    if (!options.enums) {
-      throw new Error(`table '${name}': enums is required — declare enums: {} when the table has no enums`);
-    }
-    if (options.paginated === undefined || options.paginated === null) {
-      throw new Error(`table '${name}': paginated is required — discuss with user whether this table needs pagination, then set paginated: true or paginated: false`);
-    }
-    this.name = name;
-    this.description = options.description;
-    this.paginated = options.paginated;
-    this.actor = options.actor;
-    this.generator = options.generator;
-    this.autoIncrement = options.autoIncrement;
-    this.primaryKey = options.primaryKey;
-    this.indexes = options.indexes;
-    this.foreignKeys = options.foreignKeys;
-    this.label = options.label;
-    this.phrase = options.phrase;
-    this.enums = options.enums;
-    this.columns = options.columns;
-  }
-
-  /** True when the field is part of this table's primary key */
-  isPk(fieldRef: Field): boolean {
-    if (this.primaryKey === undefined) return false;
-    return Array.isArray(this.primaryKey)
-      ? this.primaryKey.includes(fieldRef)
-      : this.primaryKey === fieldRef;
-  }
-}
-
-export function defineTable<
-  N extends string,
-  C extends Record<string, Field>,
-  E extends Record<string, EnumDef> = Record<string, EnumDef>
->(
-  name: N,
-  schema: TableSchemaOptions<N, C, E>,
-): TableSchema<N, C, E> {
-  const table = new TableSchema<N, C, E>(name, schema);
-  if (table.generator && table.autoIncrement) {
-    throw new Error(`table '${name}': generator and autoIncrement are mutually exclusive`);
-  }
-  if (table.label && !Object.values(table.columns).includes(table.label)) {
-    throw new Error(`table '${name}': label field '${table.label.name}' must be one of the table's columns`);
-  }
-  for (const key of Object.keys(table.columns)) {
-    const field = table.columns[key] as Field;
-    if (field.schema && field.schema !== table) {
-      throw new Error(
-        `field ${key}: belongs to table ${field.schema.name}, cannot reuse in table ${table.name}`,
-      );
-    }
-  }
-  for (const key of Object.keys(table.columns)) {
-    table.columns[key].name = key;
-    table.columns[key].schema = table;
-  }
-  if (table.primaryKey) {
-    const pkFields = Array.isArray(table.primaryKey) ? table.primaryKey : [table.primaryKey];
-    const colRefs = Object.values(table.columns);
-    for (const pk of pkFields) {
-      if (!colRefs.includes(pk)) {
-        throw new Error(
-          `table '${name}': primaryKey field '${pk.name}' must be the exact same object as the corresponding column (extract it to a const and reuse)`,
-        );
-      }
-    }
-  }
-  for (const [fkName, fk] of Object.entries(table.foreignKeys ?? {})) {
-    const refs = Array.isArray(fk.references) ? fk.references : [fk.references];
-    const fields = Array.isArray(fk.columns) ? fk.columns : [fk.columns];
-    const colRefs = Object.values(table.columns);
-    for (const fkField of fields) {
-      if (!colRefs.includes(fkField)) {
-        throw new Error(
-          `foreign key ${fkName}: column '${fkField.name}' must be the exact same object as the corresponding column in the table (extract it to a const and reuse)`,
-        );
-      }
-    }
-    for (let i = 0; i < refs.length; i++) {
-      const ref = refs[i];
-      if (!ref.schema) throw new Error(`foreign key ${fkName}: references field has no schema`);
-      if (ref.schema === table) throw new Error(`foreign key ${fkName}: cannot reference own table ${table.name}`);
-      const phrase = (ref.schema as TableSchema).phrase;
-      if (!phrase) throw new Error(`foreign key ${fkName}: referenced table ${ref.schema.name} has no phrase, cannot check field naming`);
-      const expected = `${phrase.name}_${ref.name}`;
-      const fkField = fields[i];
-      if (fkField.name !== expected) {
-        throw new Error(
-          `foreign key ${fkName}: field must be named ${expected} (phrase ${phrase.name} + ${ref.name}), got ${fkField.name}`,
-        );
-      }
-    }
-  }
-  for (const [idxKey, index] of Object.entries(table.indexes ?? {})) {
-    const cols = Array.isArray(index.columns) ? index.columns : [index.columns];
-    const colRefs = Object.values(table.columns);
-    for (const col of cols) {
-      if (typeof col !== 'object' || col === null || typeof (col as Field).type !== 'string') {
-        const idxName = index.name ?? idxKey;
-        throw new Error(
-          `index ${idxName}: columns must be Field instances (stringField()/intField()/...), got ${JSON.stringify(col)}`,
-        );
-      }
-      if (!colRefs.includes(col)) {
-        const idxName = index.name ?? idxKey;
-        throw new Error(
-          `index ${idxName}: column '${col.name}' must be the exact same object as the corresponding column in the table (extract it to a const and reuse)`,
-        );
-      }
-    }
-  }
-  return table;
+// DB table definitions.
+// Shape: { type: 'table', <extension fields> }
+
+import type { EntityPhrase } from './dictionary.js';
+import type { CollectionSchemaBase, EnumDef, Field } from './dsl.js';
+
+export type Index = {
+  name?: string;
+  columns: Field | Field[];
+  unique?: boolean;
+};
+
+export type ForeignKey = {
+  columns: Field | Field[];
+  references: Field | Field[];
+};
+
+export interface TableSchemaOptions<
+  N extends string = string,
+  C extends Record<string, Field> = Record<string, Field>,
+  E extends Record<string, EnumDef> = Record<string, EnumDef>
+> {
+  description?: string;
+  paginated: boolean;
+  actor?: boolean;
+  generator?: string;
+  autoIncrement?: Field;
+  /** 本表用于关联显示的名称字段（如 name / username）。被外键引用时，自动用该字段做 label 展示。 */
+  label?: Field;
+  primaryKey?: Field | Field[];
+  indexes?: Index[];
+  foreignKeys?: Record<string, ForeignKey>;
+  /** 引用的实体短语（词典条目）：本表归属的实体；关联表等多实体场景不需要 */
+  phrase?: EntityPhrase;
+  /** 本表引用的所有枚举定义（map，key 为枚举标识），显式声明供 gen-enums 收集 */
+  enums: E;
+  columns: C;
+}
+
+export class TableSchema<
+  N extends string = string,
+  C extends Record<string, Field> = Record<string, Field>,
+  E extends Record<string, EnumDef> = Record<string, EnumDef>
+> implements CollectionSchemaBase {
+  type = 'table';
+  name: N;
+  description?: string;
+  /** 分页 */
+  paginated: boolean;
+  /** 系统操作者（如小程序为 C 端用户，管理端为运营） */
+  actor?: boolean;
+  /** id 生成器 */
+  generator?: string;
+  /** 自增主键字段 */
+  autoIncrement?: Field;
+  primaryKey?: Field | Field[];
+  indexes?: Index[];
+  /** 外键，引用其他表的字段 */
+  foreignKeys?: Record<string, ForeignKey>;
+  /** 本表用于关联显示的名称字段（如 name / username）。被外键引用时，自动用该字段做 label 展示。 */
+  label?: Field;
+  /** 引用的实体短语（词典条目）：本表归属的实体；关联表等多实体场景不需要 */
+  phrase?: EntityPhrase;
+  /** 本表引用的所有枚举定义（map，key 为枚举标识），显式声明供 gen-enums 收集 */
+  enums: E;
+  columns: C;
+
+  constructor(name: N, options: TableSchemaOptions<N, C, E>) {
+    if (!options.enums) {
+      throw new Error(`table '${name}': enums is required — declare enums: {} when the table has no enums`);
+    }
+    if (options.paginated === undefined || options.paginated === null) {
+      throw new Error(`table '${name}': paginated is required — discuss with user whether this table needs pagination, then set paginated: true or paginated: false`);
+    }
+    this.name = name;
+    this.description = options.description;
+    this.paginated = options.paginated;
+    this.actor = options.actor;
+    this.generator = options.generator;
+    this.autoIncrement = options.autoIncrement;
+    this.primaryKey = options.primaryKey;
+    this.indexes = options.indexes;
+    this.foreignKeys = options.foreignKeys;
+    this.label = options.label;
+    this.phrase = options.phrase;
+    this.enums = options.enums;
+    this.columns = options.columns;
+  }
+
+  /** True when the field is part of this table's primary key */
+  isPk(fieldRef: Field): boolean {
+    if (this.primaryKey === undefined) return false;
+    return Array.isArray(this.primaryKey)
+      ? this.primaryKey.includes(fieldRef)
+      : this.primaryKey === fieldRef;
+  }
+}
+
+export function defineTable<
+  N extends string,
+  C extends Record<string, Field>,
+  E extends Record<string, EnumDef> = Record<string, EnumDef>
+>(
+  name: N,
+  schema: TableSchemaOptions<N, C, E>,
+): TableSchema<N, C, E> {
+  const table = new TableSchema<N, C, E>(name, schema);
+  if (table.generator && table.autoIncrement) {
+    throw new Error(`table '${name}': generator and autoIncrement are mutually exclusive`);
+  }
+  if (table.label && !Object.values(table.columns).includes(table.label)) {
+    throw new Error(`table '${name}': label field '${table.label.name}' must be one of the table's columns`);
+  }
+  for (const key of Object.keys(table.columns)) {
+    const field = table.columns[key] as Field;
+    if (field.schema && field.schema !== table) {
+      throw new Error(
+        `field ${key}: belongs to table ${field.schema.name}, cannot reuse in table ${table.name}`,
+      );
+    }
+  }
+  for (const key of Object.keys(table.columns)) {
+    table.columns[key].name = key;
+    table.columns[key].schema = table;
+  }
+  if (table.primaryKey) {
+    const pkFields = Array.isArray(table.primaryKey) ? table.primaryKey : [table.primaryKey];
+    const colRefs = Object.values(table.columns);
+    for (const pk of pkFields) {
+      if (!colRefs.includes(pk)) {
+        throw new Error(
+          `table '${name}': primaryKey field '${pk.name}' must be the exact same object as the corresponding column (extract it to a const and reuse)`,
+        );
+      }
+    }
+  }
+  for (const [fkName, fk] of Object.entries(table.foreignKeys ?? {})) {
+    const refs = Array.isArray(fk.references) ? fk.references : [fk.references];
+    const fields = Array.isArray(fk.columns) ? fk.columns : [fk.columns];
+    const colRefs = Object.values(table.columns);
+    for (const fkField of fields) {
+      if (!colRefs.includes(fkField)) {
+        throw new Error(
+          `foreign key ${fkName}: column '${fkField.name}' must be the exact same object as the corresponding column in the table (extract it to a const and reuse)`,
+        );
+      }
+    }
+    for (let i = 0; i < refs.length; i++) {
+      const ref = refs[i];
+      if (!ref.schema) throw new Error(`foreign key ${fkName}: references field has no schema`);
+      if (ref.schema === table) throw new Error(`foreign key ${fkName}: cannot reference own table ${table.name}`);
+      const phrase = (ref.schema as TableSchema).phrase;
+      if (!phrase) throw new Error(`foreign key ${fkName}: referenced table ${ref.schema.name} has no phrase, cannot check field naming`);
+      const expected = `${phrase.name}_${ref.name}`;
+      const fkField = fields[i];
+      if (fkField.name !== expected) {
+        throw new Error(
+          `foreign key ${fkName}: field must be named ${expected} (phrase ${phrase.name} + ${ref.name}), got ${fkField.name}`,
+        );
+      }
+    }
+  }
+  for (const [idxKey, index] of Object.entries(table.indexes ?? {})) {
+    const cols = Array.isArray(index.columns) ? index.columns : [index.columns];
+    const colRefs = Object.values(table.columns);
+    for (const col of cols) {
+      if (typeof col !== 'object' || col === null || typeof (col as Field).type !== 'string') {
+        const idxName = index.name ?? idxKey;
+        throw new Error(
+          `index ${idxName}: columns must be Field instances (stringField()/intField()/...), got ${JSON.stringify(col)}`,
+        );
+      }
+      if (!colRefs.includes(col)) {
+        const idxName = index.name ?? idxKey;
+        throw new Error(
+          `index ${idxName}: column '${col.name}' must be the exact same object as the corresponding column in the table (extract it to a const and reuse)`,
+        );
+      }
+    }
+  }
+  return table;
 }

package/src/dsl.ts

@@ -71,6 +71,24 @@ interface DecimalField extends BaseField {
   // Value is transported as string to avoid binary float error.
 }
 
+type RateUnit = 'pct' | 'pm' | 'bp';
+
+export function rateScale(unit: RateUnit): number {
+  switch (unit) {
+    case 'pct': return 2;
+    case 'pm':  return 3;
+    case 'bp':  return 4;
+  }
+}
+
+interface RateField extends BaseField {
+  type: 'rate';
+  jsType: 'string';
+  unit: RateUnit;
+  // Precision/scale are derived from unit at DDL/TypeBox render time,
+  // not stored on the field.
+}
+
 interface BooleanField extends BaseField {
   type: 'boolean';
   jsType: 'boolean';
@@ -131,6 +149,7 @@ export type Field =
   | IntField
   | BigintField
   | DecimalField
+  | RateField
   | BooleanField
   | DateField
   | TimeField
@@ -163,6 +182,10 @@ export function decimalField(extra: FieldExtras<DecimalField>): DecimalField {
   return { name: '', type: 'decimal', jsType: 'string', ...extra };
 }
 
+export function rateField(unit: RateUnit, extra: Omit<FieldExtras<RateField>, 'unit'> = {}): RateField {
+  return { name: '', type: 'rate', jsType: 'string', unit, ...extra };
+}
+
 export function booleanField(extra: FieldExtras<BooleanField> = {}): BooleanField {
   return { name: '', type: 'boolean', jsType: 'boolean', ...extra };
 }