@pylonts/dsl 1.1.3 → 1.1.5

package/src/typebox-driver.ts

@@ -1,193 +1,194 @@
-import { DtoArrayField, DtoField, DtoMessage, DtoObjectField, ImportBase, ImportRef } from './dto.js';
-import { Field } from './dsl.js';
-
-// TypeBox driver: renders a DtoMessage into TypeBox TypeScript source.
-// Shape matches the codegen product consumed by fastify v5 TypeBoxTypeProvider:
-//
-//   export const RegisterUserInput = Type.Object({...});
-//   export type RegisterUserInput = Static<typeof RegisterUserInput>;
-//
-// ENUM fields reference a generated enum (see enum-driver) by its import
-// location — the resolver maps a jsName to its product import.
-// DTO bases (.include()) render as Type.Intersect([...bases, Type.Object({...})]).
-
-export type EnumResolver = (enumName: string) => ImportBase | undefined;
-
-function renderString(s: string): string {
-  return `'${s.replace(/\\/g, '\\\\').replace(/'/g, "\\'")}'`;
-}
-
-function renderDefault(v: unknown): string {
-  if (typeof v === 'string') return renderString(v);
-  return JSON.stringify(v);
-}
-
-function renderBasic(
-  field: Field,
-  pattern: string | undefined,
-  defaultValue: unknown,
-  resolver: EnumResolver | undefined,
-): string {
-  if (pattern !== undefined && field.type !== 'string') {
-    throw new Error(`pattern is only supported on string fields, got ${field.type} (${field.name})`);
-  }
-  const def = defaultValue !== undefined ? `default: ${renderDefault(defaultValue)}` : undefined;
-  switch (field.type) {
-    case 'string': {
-      const opts: string[] = [];
-      if (field.minLength !== undefined) opts.push(`minLength: ${field.minLength}`);
-      if (field.maxLength !== undefined) opts.push(`maxLength: ${field.maxLength}`);
-      if (pattern !== undefined) opts.push(`pattern: ${renderString(pattern)}`);
-      if (def !== undefined) opts.push(def);
-      return opts.length > 0 ? `Type.String({ ${opts.join(', ')} })` : 'Type.String()';
-    }
-    case 'text':
-      return def !== undefined ? `Type.String({ ${def} })` : 'Type.String()';
-    case 'integer': {
-      const opts: string[] = [];
-      if (field.min !== undefined) opts.push(`minimum: ${field.min}`);
-      if (field.max !== undefined) opts.push(`maximum: ${field.max}`);
-      if (def !== undefined) opts.push(def);
-      return opts.length > 0 ? `Type.Integer({ ${opts.join(', ')} })` : 'Type.Integer()';
-    }
-    case 'bigint':
-    case 'decimal':
-    case 'time':
-    case 'date':
-    case 'datetime':
-      // Transmitted as string over HTTP: bigint/decimal keep full precision,
-      // date/time serialize to string.
-      return def !== undefined ? `Type.String({ ${def} })` : 'Type.String()';
-    case 'boolean':
-      return def !== undefined ? `Type.Boolean({ ${def} })` : 'Type.Boolean()';
-    case 'json':
-      return def !== undefined ? `Type.Unknown({ ${def} })` : 'Type.Unknown()';
-    case 'enum': {
-      const ref = resolver?.(field.enum.jsName);
-      if (!ref) throw new Error(`enum field ${field.name}: no import ref for ${field.enum.jsName} — pass an EnumResolver`);
-      if (def !== undefined) {
-        const member = field.enum.values.find((v) => v.value === defaultValue);
-        if (!member) {
-          throw new Error(
-            `enum field ${field.name}: default ${renderDefault(defaultValue)} is not a member of ${field.enum.jsName}`,
-          );
-        }
-        return `Type.Enum(${ref.name}, { default: ${ref.name}.${member.symbol} })`;
-      }
-      return `Type.Enum(${ref.name})`;
-    }
-    default:
-      // Field union is exhaustive; this branch is unreachable at runtime.
-      throw new Error(`unsupported field type: ${String((field as Field).type)}`);
-  }
-}
-
-function renderObject(fields: Record<string, DtoField>, indent: number, resolver: EnumResolver | undefined): string {
-  const pad = '  '.repeat(indent);
-  const entries = Object.entries(fields).map(([name, f]) => `${pad}${name}: ${renderField(f, indent, resolver)}`);
-  return `Type.Object({\n${entries.join(',\n')}\n${'  '.repeat(indent - 1)}})`;
-}
-
-function renderField(f: DtoField, indent: number, resolver: EnumResolver | undefined): string {
-  const base = renderValue(f, indent, resolver);
-  return f.isOptional() ? `Type.Optional(${base})` : base;
-}
-
-function renderValue(f: DtoField, indent: number, resolver: EnumResolver | undefined): string {
-  if (f.field.type === 'array') {
-    const items = f.field.items;
-    // Referenced DTO element — render by name (same-file export), not expanded.
-    if (isDtoMessage(items)) return `Type.Array(${items.name})`;
-    return `Type.Array(${renderField(items, indent + 1, resolver)})`;
-  }
-  if (f.field.type === 'object') {
-    return renderObject(f.field.properties, indent + 1, resolver);
-  }
-  // DtoField only wraps a database Field; array/object defs live in the subclasses.
-  // Only DTO-level defaults (setDefault) are emitted as TypeBox default
-  // annotations; DB field defaults are not carried into the API contract.
-  return renderBasic(f.field as Field, f.pattern, f.default, resolver);
-}
-
-/** Structural check — DtoMessage instances may come from a different module copy, so instanceof is unreliable. */
-function isDtoMessage(v: unknown): v is DtoMessage {
-  if (typeof v !== 'object' || v === null) return false;
-  return (v as Record<string, unknown>).type === 'dto';
-}
-
-function collectEnumImports(
-  f: DtoField,
-  resolver: EnumResolver | undefined,
-  out: Map<string, ImportBase>,
-): void {
-  if (f.field.type === 'array') {
-    const items = f.field.items;
-    if (!isDtoMessage(items)) collectEnumImports(items, resolver, out);
-    return;
-  }
-  if (f.field.type === 'object') {
-    for (const child of Object.values(f.field.properties)) collectEnumImports(child, resolver, out);
-    return;
-  }
-  if (f.field.type === 'enum') {
-    const ref = resolver?.(f.field.enum.jsName);
-    if (!ref) throw new Error(`enum field ${f.field.name}: no import ref for ${f.field.enum.jsName} — pass an EnumResolver`);
-    out.set(`${ref.from}#${ref.name}`, ref);
-  }
-}
-
-/** Collect all imports needed to render a DTO: include() bases + enum references. */
-export function collectDtoImports(
-  schema: DtoMessage,
-  resolver: EnumResolver | undefined,
-  out: Map<string, ImportBase>,
-): void {
-  for (const base of schema.bases ?? []) out.set(`${base.from}#${base.name}`, base);
-  for (const f of Object.values(schema.fields)) collectEnumImports(f, resolver, out);
-}
-
-/** Render one DTO export (const + type) — no file header, for file-level generation. */
-export function renderDtoExport(schema: DtoMessage, resolver: EnumResolver | undefined): string {
-  const object = renderObject(schema.fields, 1, resolver);
-  const bases = schema.bases ?? [];
-  const body =
-    bases.length > 0
-      ? `Type.Intersect([${bases.map(renderBase).join(', ')}, ${object}])`
-      : object;
-  return `export const ${schema.name} = ${body};`;
-}
-
-/** Render the Static type export for a DTO. */
-export function renderDtoTypeExport(name: string): string {
-  return `export type ${name} = Static<typeof ${name}>;`;
-}
-
-export function renderDtoMessage(
-  schema: DtoMessage,
-  options: { resolver?: EnumResolver; source?: string } = {},
-): string {
-  const { resolver, source } = options;
-  const imports = new Map<string, ImportBase>();
-  collectDtoImports(schema, resolver, imports);
-
-  const header = [
-    '// AUTO-GENERATED by typebox-driver — DO NOT EDIT',
-    ...(source !== undefined ? [`// Source: ${source}`] : []),
-    "import { Type, Static } from '@sinclair/typebox';",
-    ...[...imports.values()].map((r) => `import${r.type ? ' type' : ''} { ${r.name} } from '${r.from}';`),
-  ];
-
-  return [
-    ...header,
-    '',
-    renderDtoExport(schema, resolver),
-    renderDtoTypeExport(schema.name),
-    '',
-  ].join('\n');
-}
-
-function renderBase(base: ImportRef): string {
-  if (base.args === undefined || base.args.length === 0) return base.name;
-  const args = base.args.map((a) => (typeof a === 'string' ? a : a.name));
-  return `${base.name}(${args.join(', ')})`;
+import { DtoArrayField, DtoField, DtoMessage, DtoObjectField, ImportBase, ImportRef } from './dto.js';
+import { Field } from './dsl.js';
+
+// TypeBox driver: renders a DtoMessage into TypeBox TypeScript source.
+// Shape matches the codegen product consumed by fastify v5 TypeBoxTypeProvider:
+//
+//   export const RegisterUserInput = Type.Object({...});
+//   export type RegisterUserInput = Static<typeof RegisterUserInput>;
+//
+// ENUM fields reference a generated enum (see enum-driver) by its import
+// location — the resolver maps a jsName to its product import.
+// DTO bases (.include()) render as Type.Intersect([...bases, Type.Object({...})]).
+
+export type EnumResolver = (enumName: string) => ImportBase | undefined;
+
+function renderString(s: string): string {
+  return `'${s.replace(/\\/g, '\\\\').replace(/'/g, "\\'")}'`;
+}
+
+function renderDefault(v: unknown): string {
+  if (typeof v === 'string') return renderString(v);
+  return JSON.stringify(v);
+}
+
+function renderBasic(
+  field: Field,
+  pattern: string | undefined,
+  defaultValue: unknown,
+  resolver: EnumResolver | undefined,
+): string {
+  if (pattern !== undefined && field.type !== 'string') {
+    throw new Error(`pattern is only supported on string fields, got ${field.type} (${field.name})`);
+  }
+  const def = defaultValue !== undefined ? `default: ${renderDefault(defaultValue)}` : undefined;
+  switch (field.type) {
+    case 'string': {
+      const opts: string[] = [];
+      if (field.minLength !== undefined) opts.push(`minLength: ${field.minLength}`);
+      if (field.maxLength !== undefined) opts.push(`maxLength: ${field.maxLength}`);
+      if (pattern !== undefined) opts.push(`pattern: ${renderString(pattern)}`);
+      if (def !== undefined) opts.push(def);
+      return opts.length > 0 ? `Type.String({ ${opts.join(', ')} })` : 'Type.String()';
+    }
+    case 'text':
+      return def !== undefined ? `Type.String({ ${def} })` : 'Type.String()';
+    case 'integer': {
+      const opts: string[] = [];
+      if (field.min !== undefined) opts.push(`minimum: ${field.min}`);
+      if (field.max !== undefined) opts.push(`maximum: ${field.max}`);
+      if (def !== undefined) opts.push(def);
+      return opts.length > 0 ? `Type.Integer({ ${opts.join(', ')} })` : 'Type.Integer()';
+    }
+    case 'bigint':
+    case 'decimal':
+    case 'rate':
+    case 'time':
+    case 'date':
+    case 'datetime':
+      // Transmitted as string over HTTP: bigint/decimal/rate keep full
+      // precision, date/time serialize to string.
+      return def !== undefined ? `Type.String({ ${def} })` : 'Type.String()';
+    case 'boolean':
+      return def !== undefined ? `Type.Boolean({ ${def} })` : 'Type.Boolean()';
+    case 'json':
+      return def !== undefined ? `Type.Unknown({ ${def} })` : 'Type.Unknown()';
+    case 'enum': {
+      const ref = resolver?.(field.enum.jsName);
+      if (!ref) throw new Error(`enum field ${field.name}: no import ref for ${field.enum.jsName} — pass an EnumResolver`);
+      if (def !== undefined) {
+        const member = field.enum.values.find((v) => v.value === defaultValue);
+        if (!member) {
+          throw new Error(
+            `enum field ${field.name}: default ${renderDefault(defaultValue)} is not a member of ${field.enum.jsName}`,
+          );
+        }
+        return `Type.Enum(${ref.name}, { default: ${ref.name}.${member.symbol} })`;
+      }
+      return `Type.Enum(${ref.name})`;
+    }
+    default:
+      // Field union is exhaustive; this branch is unreachable at runtime.
+      throw new Error(`unsupported field type: ${String((field as Field).type)}`);
+  }
+}
+
+function renderObject(fields: Record<string, DtoField>, indent: number, resolver: EnumResolver | undefined): string {
+  const pad = '  '.repeat(indent);
+  const entries = Object.entries(fields).map(([name, f]) => `${pad}${name}: ${renderField(f, indent, resolver)}`);
+  return `Type.Object({\n${entries.join(',\n')}\n${'  '.repeat(indent - 1)}})`;
+}
+
+function renderField(f: DtoField, indent: number, resolver: EnumResolver | undefined): string {
+  const base = renderValue(f, indent, resolver);
+  return f.isOptional() ? `Type.Optional(${base})` : base;
+}
+
+function renderValue(f: DtoField, indent: number, resolver: EnumResolver | undefined): string {
+  if (f.field.type === 'array') {
+    const items = f.field.items;
+    // Referenced DTO element — render by name (same-file export), not expanded.
+    if (isDtoMessage(items)) return `Type.Array(${items.name})`;
+    return `Type.Array(${renderField(items, indent + 1, resolver)})`;
+  }
+  if (f.field.type === 'object') {
+    return renderObject(f.field.properties, indent + 1, resolver);
+  }
+  // DtoField only wraps a database Field; array/object defs live in the subclasses.
+  // Only DTO-level defaults (setDefault) are emitted as TypeBox default
+  // annotations; DB field defaults are not carried into the API contract.
+  return renderBasic(f.field as Field, f.pattern, f.default, resolver);
+}
+
+/** Structural check — DtoMessage instances may come from a different module copy, so instanceof is unreliable. */
+function isDtoMessage(v: unknown): v is DtoMessage {
+  if (typeof v !== 'object' || v === null) return false;
+  return (v as Record<string, unknown>).type === 'dto';
+}
+
+function collectEnumImports(
+  f: DtoField,
+  resolver: EnumResolver | undefined,
+  out: Map<string, ImportBase>,
+): void {
+  if (f.field.type === 'array') {
+    const items = f.field.items;
+    if (!isDtoMessage(items)) collectEnumImports(items, resolver, out);
+    return;
+  }
+  if (f.field.type === 'object') {
+    for (const child of Object.values(f.field.properties)) collectEnumImports(child, resolver, out);
+    return;
+  }
+  if (f.field.type === 'enum') {
+    const ref = resolver?.(f.field.enum.jsName);
+    if (!ref) throw new Error(`enum field ${f.field.name}: no import ref for ${f.field.enum.jsName} — pass an EnumResolver`);
+    out.set(`${ref.from}#${ref.name}`, ref);
+  }
+}
+
+/** Collect all imports needed to render a DTO: include() bases + enum references. */
+export function collectDtoImports(
+  schema: DtoMessage,
+  resolver: EnumResolver | undefined,
+  out: Map<string, ImportBase>,
+): void {
+  for (const base of schema.bases ?? []) out.set(`${base.from}#${base.name}`, base);
+  for (const f of Object.values(schema.fields)) collectEnumImports(f, resolver, out);
+}
+
+/** Render one DTO export (const + type) — no file header, for file-level generation. */
+export function renderDtoExport(schema: DtoMessage, resolver: EnumResolver | undefined): string {
+  const object = renderObject(schema.fields, 1, resolver);
+  const bases = schema.bases ?? [];
+  const body =
+    bases.length > 0
+      ? `Type.Intersect([${bases.map(renderBase).join(', ')}, ${object}])`
+      : object;
+  return `export const ${schema.name} = ${body};`;
+}
+
+/** Render the Static type export for a DTO. */
+export function renderDtoTypeExport(name: string): string {
+  return `export type ${name} = Static<typeof ${name}>;`;
+}
+
+export function renderDtoMessage(
+  schema: DtoMessage,
+  options: { resolver?: EnumResolver; source?: string } = {},
+): string {
+  const { resolver, source } = options;
+  const imports = new Map<string, ImportBase>();
+  collectDtoImports(schema, resolver, imports);
+
+  const header = [
+    '// AUTO-GENERATED by typebox-driver — DO NOT EDIT',
+    ...(source !== undefined ? [`// Source: ${source}`] : []),
+    "import { Type, Static } from '@sinclair/typebox';",
+    ...[...imports.values()].map((r) => `import${r.type ? ' type' : ''} { ${r.name} } from '${r.from}';`),
+  ];
+
+  return [
+    ...header,
+    '',
+    renderDtoExport(schema, resolver),
+    renderDtoTypeExport(schema.name),
+    '',
+  ].join('\n');
+}
+
+function renderBase(base: ImportRef): string {
+  if (base.args === undefined || base.args.length === 0) return base.name;
+  const args = base.args.map((a) => (typeof a === 'string' ? a : a.name));
+  return `${base.name}(${args.join(', ')})`;
 }

package/src/utils.ts

@@ -8,4 +8,20 @@ export function toCamelCase(name: string): string {
 /** snake_case → PascalCase: mer_id → MerId */
 export function toPascalCase(snake: string): string {
   return snake.replace(/(^|_)([a-z])/g, (_m, _p, c: string) => c.toUpperCase());
+}
+
+// ── schema ──
+
+import { SchemaBase } from './dsl.js';
+import { FrontAppSchema } from './project.js';
+
+/** A utility module bound to exactly one frontend app. */
+export interface UtilsSchema extends SchemaBase {
+  type: 'utils';
+  /** The frontend app this utility module belongs to (shared instance from project.config). */
+  app: FrontAppSchema;
+}
+
+export function defineUtils(name: string, app: FrontAppSchema, description?: string): UtilsSchema {
+  return { name, type: 'utils', app, description };
 }