@zhin.js/schema 1.1.3 → 1.1.4

package/lib/json-schema.d.ts

@@ -1,4 +1,10 @@
 import type { Schema } from './schema.js';
+/** Optional display metadata; translated labels never change stored values. */
+export type ConfigFieldI18n = Readonly<Partial<Record<'zh-CN' | 'en', Readonly<{
+    title?: string;
+    description?: string;
+    enumLabels?: Readonly<Record<string, string>>;
+}>>>>;
 /** Form annotations on the same JSON Schema used for configuration validation. */
 export interface ConfigFieldMetadata {
     readonly secret?: boolean;

package/lib/json-schema.js

@@ -69,6 +69,8 @@ export function toJsonSchema(schema) {
     }
     if (meta.description !== undefined)
         result.description = meta.description;
+    if (meta.i18n !== undefined)
+        result['x-i18n'] = structuredClone(meta.i18n);
     if (meta.default !== undefined) {
         assertJsonValue(meta.default);
         assertPublicDefault(schema, meta.default);

package/lib/schema.d.ts

@@ -1,5 +1,5 @@
 import { safeParseSchema, type SchemaSafeParseResult } from './validate.js';
-import { type ConfigFieldMetadata } from './json-schema.js';
+import { type ConfigFieldMetadata, type ConfigFieldI18n } from './json-schema.js';
 export { SchemaValidationError, type SchemaSafeParseResult, type SchemaValidationIssue } from './validate.js';
 export { safeParseSchema };
 declare const configPresent: unique symbol;
@@ -23,6 +23,8 @@ export declare class Schema<S = any, T = S> {
     hidden(): this;
     /** 设置描述 */
     description(description: string): this;
+    /** Translate form labels without changing validation, defaults or values. */
+    i18n(translations: ConfigFieldI18n): this;
     /** 设置默认值 */
     default(defaultValue: T): this & Schema.Present;
     /** Secret values remain environment references in application configuration. */
@@ -114,6 +116,7 @@ export declare namespace Schema {
         multiple?: boolean;
         key?: string;
         description?: string;
+        i18n?: ConfigFieldI18n;
         component?: string;
         min?: number;
         max?: number;

package/lib/schema.js

@@ -75,6 +75,11 @@ export class Schema {
         this.meta.description = description;
         return this;
     }
+    /** Translate form labels without changing validation, defaults or values. */
+    i18n(translations) {
+        this.meta.i18n = structuredClone(translations);
+        return this;
+    }
     /** 设置默认值 */
     default(defaultValue) {
         this.meta.default = defaultValue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/schema",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Configuration validation and schema system for Zhin.js",
   "type": "module",
   "main": "./lib/index.js",