@omnifyjp/ts 0.3.0

package/dist/generator.js

@@ -0,0 +1,330 @@
+/**
+ * @omnify/ts — Main Generator
+ *
+ * Orchestrates TypeScript code generation from schemas.json.
+ * Reads the JSON, builds options, calls sub-generators, and assembles output files.
+ *
+ * Output structure:
+ *   base/{SchemaName}.ts   — Auto-generated interfaces + Zod + i18n (always overwritten)
+ *   enum/{EnumName}.ts     — Auto-generated enums (always overwritten)
+ *   common.ts              — Shared types (DateTimeString, etc.)
+ *   i18n.ts                — Validation messages + locale helpers
+ *   {SchemaName}.ts        — User-editable models extending base (created once, never overwritten)
+ *   index.ts               — Re-exports (always overwritten)
+ */
+import { schemaToInterface, formatInterface, needsDateTimeImports, } from './interface-generator.js';
+import { generateEnums, generatePluginEnums, formatEnum, formatTypeAlias, extractInlineEnums, } from './enum-generator.js';
+import { generateZodSchemas, generateDisplayNames, getExcludedFields, formatZodSchemasSection, formatZodModelFile, } from './zod-generator.js';
+import { generateI18nFileContent } from './i18n-generator.js';
+/** Auto-generated file header. */
+function generateBaseHeader() {
+    return `/**
+ * ⚠️ DO NOT EDIT THIS FILE! ⚠️
+ * このファイルを編集しないでください！
+ *
+ * Auto-generated by omnify-ts from schemas.json.
+ * Any manual changes will be OVERWRITTEN on next generation.
+ */
+
+`;
+}
+/** Build GeneratorOptions from schemas.json. */
+function buildOptions(input) {
+    return {
+        locales: input.locale.locales,
+        defaultLocale: input.locale.defaultLocale,
+        fallbackLocale: input.locale.fallbackLocale,
+        customTypes: input.customTypes,
+    };
+}
+/** Generate a base interface file for a schema. */
+function generateBaseInterfaceFile(schemaName, schemas, options) {
+    const schema = schemas[schemaName];
+    if (!schema)
+        throw new Error(`Schema not found: ${schemaName}`);
+    const iface = schemaToInterface(schema, schemas, options);
+    const parts = [generateBaseHeader()];
+    // Zod import
+    parts.push(`import { z } from 'zod';\n`);
+    // DateTimeString / DateString imports
+    const dateImports = needsDateTimeImports(iface);
+    const commonImports = [];
+    if (dateImports.dateTime)
+        commonImports.push('DateTimeString');
+    if (dateImports.date)
+        commonImports.push('DateString');
+    if (commonImports.length > 0) {
+        parts.push(`import type { ${commonImports.join(', ')} } from '../common.js';\n`);
+    }
+    // Enum imports (schema enums + plugin enums are all in ../enum/)
+    if (iface.enumDependencies && iface.enumDependencies.length > 0) {
+        for (const enumName of iface.enumDependencies) {
+            parts.push(`import { ${enumName} } from '../enum/${enumName}.js';\n`);
+        }
+    }
+    // Dependency imports (other schema interfaces in base/)
+    if (iface.dependencies && iface.dependencies.length > 0) {
+        for (const dep of iface.dependencies) {
+            parts.push(`import type { ${dep} } from './${dep}.js';\n`);
+        }
+        parts.push('\n');
+    }
+    else if (commonImports.length > 0 || (iface.enumDependencies && iface.enumDependencies.length > 0)) {
+        parts.push('\n');
+    }
+    // Interface
+    parts.push(formatInterface(iface));
+    parts.push('\n');
+    // Zod schemas + i18n
+    const zodSchemas = generateZodSchemas(schema, options);
+    const displayNames = generateDisplayNames(schema, options);
+    const excludedFields = getExcludedFields(schema);
+    parts.push('\n');
+    parts.push(formatZodSchemasSection(schemaName, zodSchemas, displayNames, excludedFields));
+    return {
+        filePath: `base/${schemaName}.ts`,
+        content: parts.join(''),
+        types: [schemaName, `${schemaName}Create`, `${schemaName}Update`],
+        overwrite: true,
+        category: 'base',
+    };
+}
+/** Generate an enum file. */
+function generateEnumFile(enumDef, isPlugin) {
+    const parts = [generateBaseHeader()];
+    parts.push(formatEnum(enumDef));
+    parts.push('\n');
+    return {
+        filePath: `${enumDef.name}.ts`,
+        content: parts.join(''),
+        types: [enumDef.name],
+        overwrite: true,
+        category: isPlugin ? 'plugin-enum' : 'enum',
+    };
+}
+/** Generate a type alias file. */
+function generateTypeAliasFile(alias) {
+    const parts = [generateBaseHeader()];
+    parts.push(formatTypeAlias(alias));
+    parts.push('\n');
+    return {
+        filePath: `${alias.name}.ts`,
+        content: parts.join(''),
+        types: [alias.name],
+        overwrite: true,
+        category: 'enum',
+    };
+}
+/** Generate user model file. */
+function generateModelFile(schemaName) {
+    return {
+        filePath: `${schemaName}.ts`,
+        content: formatZodModelFile(schemaName),
+        types: [schemaName],
+        overwrite: false,
+    };
+}
+/** Generate common.ts with shared types. */
+function generateCommonFile(options) {
+    const localeUnion = options.locales.map(l => `'${l}'`).join(' | ');
+    const content = `${generateBaseHeader()}/**
+ * Locale map for multi-language support.
+ */
+export interface LocaleMap {
+  [locale: string]: string;
+}
+
+/**
+ * Supported locales in this project.
+ */
+export type Locale = ${localeUnion};
+
+/**
+ * ISO 8601 date-time string.
+ */
+export type DateTimeString = string;
+
+/**
+ * ISO 8601 date string (YYYY-MM-DD).
+ */
+export type DateString = string;
+`;
+    return {
+        filePath: 'common.ts',
+        content,
+        types: ['LocaleMap', 'Locale', 'DateTimeString', 'DateString'],
+        overwrite: true,
+    };
+}
+/** Generate i18n.ts with validation messages. */
+function generateI18nFile(options) {
+    return {
+        filePath: 'i18n.ts',
+        content: generateBaseHeader() + generateI18nFileContent(options),
+        types: ['validationMessages', 'getMessage', 'getMessages'],
+        overwrite: true,
+    };
+}
+/** Generate index.ts re-exports. */
+function generateIndexFile(schemas, schemaEnums, pluginEnums, typeAliases) {
+    const parts = [generateBaseHeader()];
+    // Common types
+    parts.push(`// Common Types\n`);
+    parts.push(`export type { LocaleMap, Locale, DateTimeString, DateString } from './common.js';\n\n`);
+    // I18n
+    parts.push(`// i18n (Internationalization)\n`);
+    parts.push(`export {\n`);
+    parts.push(`  defaultLocale,\n`);
+    parts.push(`  fallbackLocale,\n`);
+    parts.push(`  supportedLocales,\n`);
+    parts.push(`  validationMessages,\n`);
+    parts.push(`  getMessage,\n`);
+    parts.push(`  getMessages,\n`);
+    parts.push(`} from './i18n.js';\n\n`);
+    // Schema enums
+    if (schemaEnums.length > 0) {
+        parts.push(`// Schema Enums\n`);
+        for (const enumDef of schemaEnums) {
+            parts.push(`export {\n`);
+            parts.push(`  ${enumDef.name},\n`);
+            parts.push(`  ${enumDef.name}Values,\n`);
+            parts.push(`  is${enumDef.name},\n`);
+            parts.push(`  get${enumDef.name}Label,\n`);
+            parts.push(`  get${enumDef.name}Extra,\n`);
+            parts.push(`} from './enum/${enumDef.name}.js';\n`);
+        }
+        parts.push('\n');
+    }
+    // Plugin enums
+    if (pluginEnums.length > 0) {
+        parts.push(`// Plugin Enums\n`);
+        for (const enumDef of pluginEnums) {
+            parts.push(`export {\n`);
+            parts.push(`  ${enumDef.name},\n`);
+            parts.push(`  ${enumDef.name}Values,\n`);
+            parts.push(`  is${enumDef.name},\n`);
+            parts.push(`  get${enumDef.name}Label,\n`);
+            parts.push(`  get${enumDef.name}Extra,\n`);
+            parts.push(`} from './enum/${enumDef.name}.js';\n`);
+        }
+        parts.push('\n');
+    }
+    // Inline enum type aliases
+    if (typeAliases.length > 0) {
+        parts.push(`// Inline Enums (Type Aliases)\n`);
+        for (const alias of typeAliases) {
+            parts.push(`export {\n`);
+            parts.push(`  type ${alias.name},\n`);
+            parts.push(`  ${alias.name}Values,\n`);
+            parts.push(`  is${alias.name},\n`);
+            parts.push(`  get${alias.name}Label,\n`);
+            parts.push(`  get${alias.name}Extra,\n`);
+            parts.push(`} from './enum/${alias.name}.js';\n`);
+        }
+        parts.push('\n');
+    }
+    // Models
+    parts.push(`// Models (with Zod schemas, i18n, and Create/Update types)\n`);
+    for (const schema of Object.values(schemas)) {
+        if (schema.kind === 'enum')
+            continue;
+        if (schema.options?.hidden === true)
+            continue;
+        const lowerName = schema.name.charAt(0).toLowerCase() + schema.name.slice(1);
+        parts.push(`export type { ${schema.name}, ${schema.name}Create, ${schema.name}Update } from './${schema.name}.js';\n`);
+        parts.push(`export {\n`);
+        parts.push(`  ${lowerName}Schemas,\n`);
+        parts.push(`  ${lowerName}CreateSchema,\n`);
+        parts.push(`  ${lowerName}UpdateSchema,\n`);
+        parts.push(`  ${lowerName}I18n,\n`);
+        parts.push(`  get${schema.name}Label,\n`);
+        parts.push(`  get${schema.name}FieldLabel,\n`);
+        parts.push(`  get${schema.name}FieldPlaceholder,\n`);
+        parts.push(`} from './${schema.name}.js';\n`);
+    }
+    return {
+        filePath: 'index.ts',
+        content: parts.join(''),
+        types: [],
+        overwrite: true,
+    };
+}
+/**
+ * Reserved names that cannot be used as schema names.
+ * These would collide with auto-generated infrastructure files at root level.
+ * Comparison is case-insensitive because macOS/Windows file systems are case-insensitive.
+ *
+ * Note: "common" and "i18n" are lowercase and schema names are PascalCase,
+ * so they won't collide on case-sensitive FS. But "Index" would collide with "index.ts".
+ */
+const RESERVED_NAMES = new Set(['index', 'common', 'i18n']);
+/**
+ * Validate that no schema name collides with reserved file names.
+ */
+function validateSchemaNames(schemas) {
+    for (const schema of Object.values(schemas)) {
+        if (schema.kind === 'enum')
+            continue;
+        const lower = schema.name.toLowerCase();
+        if (RESERVED_NAMES.has(lower)) {
+            throw new Error(`Schema name "${schema.name}" is reserved by omnify-ts (collides with ${lower}.ts). ` +
+                `Please rename this schema.`);
+        }
+    }
+}
+/**
+ * Generate all TypeScript files from schemas.json input.
+ */
+export function generateTypeScript(input) {
+    const options = buildOptions(input);
+    const schemas = input.schemas;
+    // Validate no reserved name collisions
+    validateSchemaNames(schemas);
+    const files = [];
+    // Schema enums (e.g., PostStatus)
+    const schemaEnums = generateEnums(schemas, options);
+    for (const enumDef of schemaEnums) {
+        files.push(generateEnumFile(enumDef, false));
+    }
+    // Plugin enums (e.g., Prefecture, BankAccountType from customTypes.enums)
+    const pluginEnums = generatePluginEnums(input.customTypes.enums, options);
+    for (const enumDef of pluginEnums) {
+        files.push(generateEnumFile(enumDef, true));
+    }
+    // Inline enums from properties (type aliases or full enums)
+    const inlineEnums = extractInlineEnums(schemas, options);
+    const inlineTypeAliases = [];
+    for (const item of inlineEnums) {
+        if (item.enum) {
+            schemaEnums.push(item.enum);
+            files.push(generateEnumFile(item.enum, false));
+        }
+        else if (item.typeAlias) {
+            inlineTypeAliases.push(item.typeAlias);
+            files.push(generateTypeAliasFile(item.typeAlias));
+        }
+    }
+    // Base interface files
+    for (const schema of Object.values(schemas)) {
+        if (schema.kind === 'enum')
+            continue;
+        if (schema.options?.hidden === true)
+            continue;
+        files.push(generateBaseInterfaceFile(schema.name, schemas, options));
+    }
+    // Model files (user-editable, created once)
+    for (const schema of Object.values(schemas)) {
+        if (schema.kind === 'enum')
+            continue;
+        if (schema.options?.hidden === true)
+            continue;
+        files.push(generateModelFile(schema.name));
+    }
+    // Common types
+    files.push(generateCommonFile(options));
+    // I18n
+    files.push(generateI18nFile(options));
+    // Index re-exports
+    files.push(generateIndexFile(schemas, schemaEnums, pluginEnums, inlineTypeAliases));
+    return files;
+}

package/dist/i18n-generator.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @omnify/ts — I18n Generator
+ *
+ * Generates validation message templates and locale helpers.
+ */
+import type { GeneratorOptions } from './types.js';
+/**
+ * Generate i18n.ts file content with validation messages and locale helpers.
+ */
+export declare function generateI18nFileContent(options: GeneratorOptions): string;

package/dist/i18n-generator.js

@@ -0,0 +1,143 @@
+/**
+ * @omnify/ts — I18n Generator
+ *
+ * Generates validation message templates and locale helpers.
+ */
+/**
+ * Default validation messages for all supported locales.
+ */
+const DEFAULT_VALIDATION_MESSAGES = {
+    required: {
+        en: '${displayName} is required',
+        ja: '${displayName}は必須です',
+        vi: '${displayName} là bắt buộc',
+        ko: '${displayName}은(는) 필수입니다',
+        zh: '${displayName}为必填项',
+    },
+    minLength: {
+        en: '${displayName} must be at least ${min} characters',
+        ja: '${displayName}は${min}文字以上で入力してください',
+        vi: '${displayName} phải có ít nhất ${min} ký tự',
+        ko: '${displayName}은(는) ${min}자 이상이어야 합니다',
+        zh: '${displayName}至少需要${min}个字符',
+    },
+    maxLength: {
+        en: '${displayName} must be at most ${max} characters',
+        ja: '${displayName}は${max}文字以内で入力してください',
+        vi: '${displayName} tối đa ${max} ký tự',
+        ko: '${displayName}은(는) ${max}자 이하여야 합니다',
+        zh: '${displayName}不能超过${max}个字符',
+    },
+    min: {
+        en: '${displayName} must be at least ${min}',
+        ja: '${displayName}は${min}以上で入力してください',
+        vi: '${displayName} phải lớn hơn hoặc bằng ${min}',
+        ko: '${displayName}은(는) ${min} 이상이어야 합니다',
+        zh: '${displayName}必须大于等于${min}',
+    },
+    max: {
+        en: '${displayName} must be at most ${max}',
+        ja: '${displayName}は${max}以下で入力してください',
+        vi: '${displayName} phải nhỏ hơn hoặc bằng ${max}',
+        ko: '${displayName}은(는) ${max} 이하여야 합니다',
+        zh: '${displayName}必须小于等于${max}',
+    },
+    email: {
+        en: 'Please enter a valid email address',
+        ja: '有効なメールアドレスを入力してください',
+        vi: 'Vui lòng nhập địa chỉ email hợp lệ',
+        ko: '유효한 이메일 주소를 입력하세요',
+        zh: '请输入有效的电子邮件地址',
+    },
+    url: {
+        en: 'Please enter a valid URL',
+        ja: '有効なURLを入力してください',
+        vi: 'Vui lòng nhập URL hợp lệ',
+        ko: '유효한 URL을 입력하세요',
+        zh: '请输入有效的URL',
+    },
+    pattern: {
+        en: '${displayName} format is invalid',
+        ja: '${displayName}の形式が正しくありません',
+        vi: '${displayName} không đúng định dạng',
+        ko: '${displayName} 형식이 올바르지 않습니다',
+        zh: '${displayName}格式不正确',
+    },
+};
+/**
+ * Generate i18n.ts file content with validation messages and locale helpers.
+ */
+export function generateI18nFileContent(options) {
+    const { locales, defaultLocale, fallbackLocale } = options;
+    // Filter messages to configured locales only
+    const filteredMessages = {};
+    for (const [key, msgs] of Object.entries(DEFAULT_VALIDATION_MESSAGES)) {
+        filteredMessages[key] = {};
+        for (const locale of locales) {
+            if (msgs[locale]) {
+                filteredMessages[key][locale] = msgs[locale];
+            }
+        }
+    }
+    const messagesJson = JSON.stringify(filteredMessages, null, 2);
+    return `import type { LocaleMap } from './common.js';
+
+/**
+ * Default locale for this project.
+ */
+export const defaultLocale = '${defaultLocale}' as const;
+
+/**
+ * Fallback locale when requested locale is not found.
+ */
+export const fallbackLocale = '${fallbackLocale}' as const;
+
+/**
+ * Supported locales in this project.
+ */
+export const supportedLocales = ${JSON.stringify(locales)} as const;
+
+/**
+ * Validation messages for all supported locales.
+ */
+export const validationMessages = ${messagesJson} as const;
+
+/**
+ * Get validation message for a specific key and locale.
+ * Supports template placeholders: \${displayName}, \${min}, \${max}, etc.
+ */
+export function getMessage(
+  key: string,
+  locale: string,
+  params: Record<string, string | number> = {},
+): string {
+  const messages = validationMessages[key as keyof typeof validationMessages];
+  if (!messages) return key;
+
+  let message = (messages as LocaleMap)[locale]
+    ?? (messages as LocaleMap)[fallbackLocale]
+    ?? (messages as LocaleMap)[defaultLocale]
+    ?? key;
+
+  for (const [param, value] of Object.entries(params)) {
+    message = message.replace(new RegExp(\`\\\\\\$\\{\${param}\\}\`, 'g'), String(value));
+  }
+
+  return message;
+}
+
+/**
+ * Get all validation messages for a specific locale.
+ */
+export function getMessages(locale: string): Record<string, string> {
+  const result: Record<string, string> = {};
+  for (const [key, messages] of Object.entries(validationMessages)) {
+    result[key] = (messages as LocaleMap)[locale]
+      ?? (messages as LocaleMap)[fallbackLocale]
+      ?? (messages as LocaleMap)[defaultLocale]
+      ?? key;
+  }
+  return result;
+}
+`;
+}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @omnify/ts — Public API
+ *
+ * TypeScript model type generator from Omnify schemas.json.
+ */
+export { generateTypeScript } from './generator.js';
+export type { SchemasJson, SchemaDefinition, PropertyDefinition, TypeScriptFile, TSInterface, TSProperty, TSEnum, TSEnumValue, TSTypeAlias, GeneratorOptions, LocalizedString, LocaleMap, } from './types.js';
+export { schemaToInterface, formatInterface, formatProperty, generateInterfaces, getPropertyType, toSnakeCase, } from './interface-generator.js';
+export { generateEnums, generatePluginEnums, formatEnum, formatTypeAlias, extractInlineEnums, toPascalCase, toEnumMemberName, } from './enum-generator.js';
+export { generateZodSchemas, generateDisplayNames, getExcludedFields, formatZodSchemasSection, formatZodModelFile, } from './zod-generator.js';

package/dist/index.js

@@ -0,0 +1,9 @@
+/**
+ * @omnify/ts — Public API
+ *
+ * TypeScript model type generator from Omnify schemas.json.
+ */
+export { generateTypeScript } from './generator.js';
+export { schemaToInterface, formatInterface, formatProperty, generateInterfaces, getPropertyType, toSnakeCase, } from './interface-generator.js';
+export { generateEnums, generatePluginEnums, formatEnum, formatTypeAlias, extractInlineEnums, toPascalCase, toEnumMemberName, } from './enum-generator.js';
+export { generateZodSchemas, generateDisplayNames, getExcludedFields, formatZodSchemasSection, formatZodModelFile, } from './zod-generator.js';

package/dist/interface-generator.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @omnify/ts — TypeScript Interface Generator
+ *
+ * Generates TypeScript interfaces from schema definitions.
+ * Handles compound type expansion via expandedProperties, association types,
+ * enum references, and all standard property types.
+ */
+import type { SchemaDefinition, PropertyDefinition, TSInterface, TSProperty, GeneratorOptions } from './types.js';
+/** Convert PascalCase/camelCase to snake_case. */
+export declare function toSnakeCase(str: string): string;
+/** Gets TypeScript type for a property. */
+export declare function getPropertyType(property: PropertyDefinition, allSchemas: Record<string, SchemaDefinition>): string;
+/**
+ * Convert a property to TSProperty array.
+ * Compound types expand to multiple properties via expandedProperties.
+ * MorphTo and ManyToOne also return multiple properties (FK + relation).
+ */
+export declare function propertyToTSProperties(propertyName: string, property: PropertyDefinition, schema: SchemaDefinition, allSchemas: Record<string, SchemaDefinition>, options: GeneratorOptions): TSProperty[];
+/** Generate a TSInterface from a schema definition. */
+export declare function schemaToInterface(schema: SchemaDefinition, allSchemas: Record<string, SchemaDefinition>, options: GeneratorOptions): TSInterface;
+/** Format a TypeScript property line. */
+export declare function formatProperty(property: TSProperty): string;
+/** Format a TypeScript interface. */
+export declare function formatInterface(iface: TSInterface): string;
+/** Generate interfaces for all non-enum, non-hidden schemas. */
+export declare function generateInterfaces(schemas: Record<string, SchemaDefinition>, options: GeneratorOptions): TSInterface[];
+/** Check if interface uses DateTimeString or DateString types. */
+export declare function needsDateTimeImports(iface: TSInterface): {
+    dateTime: boolean;
+    date: boolean;
+};