feat: add new registry schema for new ui

This commit is contained in:
2026-09-03 15:58:20 +05:00
parent a57acd1ff2
commit 1ae4b36c9c
3 changed files with 255 additions and 20 deletions
+84
View File
@@ -0,0 +1,84 @@
import { describe, expect, it } from "vitest";
import {
defaultSchemaParams,
field,
sanitizeSchemaParams,
toolSchema,
} from "./registry-schema";
interface FrameParams {
thickness: number;
color: string;
enabled: boolean;
count: string;
}
const frameSchema = toolSchema<FrameParams>(
{
thickness: field.slider({ min: 1, max: 500, default: 5 }),
color: field.color({ default: "#000000" }),
enabled: field.checkbox({ default: true }),
count: field.select({
default: "two",
options: [
{ value: "one", label: "One" },
{ value: "two", label: "Two" },
],
}),
},
{ layout: { group: "frame", cols: 2 }, label: "Frame" },
);
describe("registry-schema: дефолты из схемы", () => {
it("собирает дефолты всех полей", () => {
expect(defaultSchemaParams(frameSchema)).toEqual({
thickness: 5,
color: "#000000",
enabled: true,
count: "two",
});
});
});
describe("registry-schema: санитайз", () => {
it("пропускает валидные значения", () => {
const out = sanitizeSchemaParams(frameSchema, {
thickness: 40,
color: "#ff0000",
enabled: false,
count: "one",
});
expect(out).toEqual({
thickness: 40,
color: "#ff0000",
enabled: false,
count: "one",
});
});
it("заменяет мусор дефолтами", () => {
const out = sanitizeSchemaParams(frameSchema, {
thickness: "abc",
color: "not-a-color",
enabled: "yes",
count: "wat",
extra: 123,
});
expect(out).toEqual({
thickness: 5,
color: "#000000",
enabled: true,
count: "two",
});
});
it("clamp-ит числовые поля к min/max", () => {
const out = sanitizeSchemaParams(frameSchema, {
thickness: 9999,
color: "#000000",
enabled: true,
count: "two",
});
expect(out.thickness).toBe(500);
});
});
+162
View File
@@ -0,0 +1,162 @@
// Новая типизированная схема параметров (для нового UI, старый UI не трогаем).
//
// Параллельный источник правды к старому `ParamDef[]`: старый pipeline
// продолжает работать на `ParamDef[]` как сейчас, а новый строит UI/deфолты/
// валидацию поверх `ToolSchema<P>`.
//
// Связка типов на этапе компиляции (защита от рассинхрона):
// - `field.x<T>()` возвращает `Field<T>` — phantom `__fieldT` связывает
// runtime-спецификацию поля с ожидаемым типом значения (`number`|`string`|`boolean`).
// - `toolSchema<P>(fields)` требует, чтобы ключи `fields` в точности совпадали
// с полями `P`, а `Field<P[K]>` тип-проверялся на соответствие `P[K]`.
// Ошибки компилятора ловят расхождения между интерфейсом Params и схемой.
export interface NumberSpec {
kind: "number";
default: number;
min?: number;
max?: number;
step?: number;
}
export interface SliderSpec {
kind: "slider";
default: number;
min: number;
max: number;
step?: number;
}
export interface ColorSpec {
kind: "color";
default: string;
}
export interface SelectSpec<V extends string = string> {
kind: "select";
default: V;
options: { value: V; label: string }[];
}
export interface TextSpec {
kind: "text";
default: string;
placeholder?: string;
}
export interface CheckboxSpec {
kind: "checkbox";
default: boolean;
}
export type FieldSpec =
NumberSpec | SliderSpec | ColorSpec | SelectSpec | TextSpec | CheckboxSpec;
/** `Field<T>`: runtime-спека поля + phantom-тип ожидаемого значения (number|string|boolean). */
export interface Field<T> {
spec: FieldSpec;
/** Phantom, только для типобезопасности — не задаётся и не читается в рантайме. */
__fieldT?: T;
}
export interface ToolSchemaMeta {
/** Пер-инструмент раскладка полей (группировка/колонки). */
layout?: { group?: string; cols?: number };
/** Короткая подпись инструмента для нового UI (необязательно). */
label?: string;
}
export interface ToolSchema<P> {
fields: { [K in keyof P]: Field<P[K]> };
layout?: { group?: string; cols?: number };
label?: string;
}
export const field = {
number: (s: Omit<NumberSpec, "kind">): Field<number> => ({
spec: { kind: "number", ...s },
}),
slider: (s: Omit<SliderSpec, "kind">): Field<number> => ({
spec: { kind: "slider", ...s },
}),
color: (s: Omit<ColorSpec, "kind">): Field<string> => ({
spec: { kind: "color", ...s },
}),
select: <V extends string>(s: Omit<SelectSpec<V>, "kind">): Field<V> => ({
spec: { kind: "select", ...s },
}),
text: (s: Omit<TextSpec, "kind">): Field<string> => ({
spec: { kind: "text", ...s },
}),
checkbox: (s: Omit<CheckboxSpec, "kind">): Field<boolean> => ({
spec: { kind: "checkbox", ...s },
}),
};
/**
* Собирает `ToolSchema<P>` из объявленных полей.
* Компилятор проверяет: ключи `fields` === полям `P`, типы полей совместимы с `P[K]`.
*/
export function toolSchema<P>(
fields: { [K in keyof P]: Field<P[K]> },
meta?: ToolSchemaMeta,
): ToolSchema<P> {
return { fields, ...(meta ?? {}) };
}
function clamp(value: number, min?: number, max?: number): number {
if (min !== undefined && value < min) return min;
if (max !== undefined && value > max) return max;
return value;
}
/** Дефолты из схемы — единый источник значений по умолчанию для нового UI. */
export function defaultSchemaParams<P>(
schema: ToolSchema<P>,
): Record<keyof P, unknown> {
const out = {} as Record<keyof P, unknown>;
for (const key of Object.keys(schema.fields) as (keyof P)[]) {
out[key] = schema.fields[key].spec.default;
}
return out;
}
/** Валидация/нормализация значений по схеме. Аналог старого `sanitizeParams`. */
export function sanitizeSchemaParams<P>(
schema: ToolSchema<P>,
values: Record<string, unknown>,
): Record<keyof P, unknown> {
const out = {} as Record<keyof P, unknown>;
for (const key of Object.keys(schema.fields) as (keyof P)[]) {
const spec = schema.fields[key].spec;
const raw = values[key as string];
switch (spec.kind) {
case "number":
case "slider": {
const n =
typeof raw === "number" && Number.isFinite(raw) ? raw : spec.default;
out[key] = clamp(n, spec.min, spec.max);
break;
}
case "select":
out[key] =
typeof raw === "string" && spec.options.some((o) => o.value === raw)
? raw
: spec.default;
break;
case "checkbox":
out[key] = typeof raw === "boolean" ? raw : spec.default;
break;
case "color":
out[key] =
typeof raw === "string" && /^#[0-9a-f]{6}$/i.test(raw)
? raw
: spec.default;
break;
case "text":
out[key] = typeof raw === "string" ? raw : spec.default;
break;
}
}
return out;
}
+9 -20
View File
@@ -1,4 +1,5 @@
import type { CategoryId } from "./categories"; import type { CategoryId } from "./categories";
import type { ToolSchema } from "./registry-schema";
import { ToolError } from "./core/errors"; import { ToolError } from "./core/errors";
import { import {
colorMask, colorMask,
@@ -189,34 +190,22 @@ export type OutputFormat = {
export type SourceMode = "file" | "none" | "text"; export type SourceMode = "file" | "none" | "text";
export type ToolEntry = { export type ToolEntry<P = Record<string, unknown>> = {
id: string; id: string;
title: string; title: string;
description: string; description: string;
category: CategoryId; category: CategoryId;
sourceMode?: SourceMode; sourceMode?: SourceMode;
params: ParamDef[]; params: ParamDef[];
run?: ( /** Новая типизированная схема для нового UI. Опциональна — старый UI её не использует. */
img: PixelImage, schema?: ToolSchema<P>;
params: Record<string, unknown>, run?: (img: PixelImage, params: P) => Promise<PixelImage> | PixelImage;
) => Promise<PixelImage> | PixelImage; generate?: (params: P) => Promise<PixelImage> | PixelImage;
generate?: ( toText?: (img: PixelImage, params: P) => Promise<string> | string;
params: Record<string, unknown>, runFromText?: (text: string, params: P) => Promise<PixelImage> | PixelImage;
) => Promise<PixelImage> | PixelImage;
toText?: (
img: PixelImage,
params: Record<string, unknown>,
) => Promise<string> | string;
runFromText?: (
text: string,
params: Record<string, unknown>,
) => Promise<PixelImage> | PixelImage;
/** Текстовый источник + текстовый результат без промежуточного изображения. */ /** Текстовый источник + текстовый результат без промежуточного изображения. */
textToText?: (text: string) => Promise<string> | string; textToText?: (text: string) => Promise<string> | string;
preview?: ( preview?: (img: PixelImage, params: P) => Promise<PixelImage> | PixelImage;
img: PixelImage,
params: Record<string, unknown>,
) => Promise<PixelImage> | PixelImage;
popularity?: number; popularity?: number;
icon?: string; icon?: string;
resultType?: "image" | "info" | "text"; resultType?: "image" | "info" | "text";