@omnifyjp/omnify 0.1.0

package/README.md

@@ -0,0 +1,130 @@
+# @famgia/omnify-bin
+
+Schema-driven code generation for Laravel, TypeScript, and SQL. Define your database schemas in YAML once, then generate migrations, models, interfaces, and more.
+
+## Installation
+
+```bash
+# Global install
+npm install -g @famgia/omnify-bin
+
+# Or use npx
+npx @famgia/omnify-bin generate
+```
+
+## Quick Start
+
+```bash
+# Initialize a new project
+omnify init
+
+# Define schemas in schemas/ directory, then generate
+omnify generate
+
+# Validate your schemas
+omnify validate
+
+# Show what changed since last generation
+omnify diff
+
+# Start MCP server for AI assistant integration
+omnify mcp
+```
+
+## Schema Example
+
+```yaml
+# schemas/User.yaml
+name: User
+kind: object
+displayName:
+  en: User
+  ja: ユーザー
+options:
+  timestamps: true
+  softDelete: true
+properties:
+  name:
+    type: String
+    length: 100
+    required: true
+    displayName:
+      en: Name
+      ja: 名前
+  email:
+    type: String
+    length: 255
+    required: true
+    unique: true
+    displayName:
+      en: Email
+      ja: メールアドレス
+  role:
+    type: Enum
+    enum: [admin, editor, viewer]
+    default: viewer
+    displayName:
+      en: Role
+      ja: 役割
+```
+
+## Configuration
+
+Create `omnify.yaml` in your project root:
+
+```yaml
+schemasDir: schemas
+generators:
+  laravel:
+    enabled: true
+    migrationsDir: database/migrations
+    modelsDir: app/Models
+  sql:
+    enabled: true
+    outputDir: migrations
+    dialect: mysql
+```
+
+## MCP Integration
+
+omnify includes a built-in MCP (Model Context Protocol) server for AI assistants:
+
+```json
+{
+  "mcpServers": {
+    "omnify": {
+      "command": "omnify",
+      "args": ["mcp"]
+    }
+  }
+}
+```
+
+If installed via npm:
+
+```json
+{
+  "mcpServers": {
+    "omnify": {
+      "command": "npx",
+      "args": ["@famgia/omnify-bin", "mcp"]
+    }
+  }
+}
+```
+
+## Supported Platforms
+
+| Platform | Architecture | Package |
+|----------|-------------|---------|
+| macOS | Apple Silicon (arm64) | `@famgia/omnify-bin-darwin-arm64` |
+| macOS | Intel (x64) | `@famgia/omnify-bin-darwin-x64` |
+| Linux | x86_64 | `@famgia/omnify-bin-linux-x64` |
+| Linux | ARM64 | `@famgia/omnify-bin-linux-arm64` |
+| Windows | x86_64 | `@famgia/omnify-bin-win32-x64` |
+
+The correct platform package is installed automatically via `optionalDependencies`.
+
+## License
+
+MIT

package/bin/omnify

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+
+const { spawnSync } = require("child_process");
+const path = require("path");
+
+const PLATFORM_MAP = {
+  "darwin-arm64": "@famgia/omnify-bin-darwin-arm64",
+  "darwin-x64": "@famgia/omnify-bin-darwin-x64",
+  "linux-x64": "@famgia/omnify-bin-linux-x64",
+  "linux-arm64": "@famgia/omnify-bin-linux-arm64",
+  "win32-x64": "@famgia/omnify-bin-win32-x64",
+};
+
+const platformKey = `${process.platform}-${process.arch}`;
+const pkg = PLATFORM_MAP[platformKey];
+
+if (!pkg) {
+  console.error(
+    `Unsupported platform: ${process.platform}-${process.arch}\n` +
+      `Supported: ${Object.keys(PLATFORM_MAP).join(", ")}`
+  );
+  process.exit(1);
+}
+
+const binName = process.platform === "win32" ? "omnify.exe" : "omnify";
+
+let binPath;
+try {
+  binPath = require.resolve(path.join(pkg, "bin", binName));
+} catch {
+  console.error(
+    `Could not find omnify binary for ${platformKey}.\n` +
+      `Expected package: ${pkg}\n` +
+      `Try reinstalling: npm install -g @famgia/omnify-bin`
+  );
+  process.exit(1);
+}
+
+const result = spawnSync(binPath, process.argv.slice(2), {
+  stdio: "inherit",
+  env: process.env,
+});
+
+if (result.error) {
+  if (result.error.code === "EACCES") {
+    console.error(
+      `Permission denied. Try: chmod +x "${binPath}"`
+    );
+  } else {
+    console.error(`Failed to run omnify: ${result.error.message}`);
+  }
+  process.exit(1);
+}
+
+process.exit(result.status ?? 1);

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@omnifyjp/omnify",
+  "version": "0.1.0",
+  "description": "Schema-driven code generation for Laravel, TypeScript, and SQL",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/omnifyjp/omnify-go"
+  },
+  "bin": {
+    "omnify": "bin/omnify"
+  },
+  "types": "types/index.d.ts",
+  "exports": {
+    "./types": {
+      "types": "./types/index.d.ts"
+    },
+    "./types/*": {
+      "types": "./types/*.d.ts"
+    },
+    "./omnify-schema.json": "./omnify-schema.json",
+    "./omnify-config-schema.json": "./omnify-config-schema.json"
+  },
+  "files": ["bin/", "types/", "omnify-schema.json", "omnify-config-schema.json", "README.md"],
+  "optionalDependencies": {
+    "@omnifyjp/omnify-darwin-arm64": "0.1.0",
+    "@omnifyjp/omnify-darwin-x64": "0.1.0",
+    "@omnifyjp/omnify-linux-x64": "0.1.0",
+    "@omnifyjp/omnify-linux-arm64": "0.1.0",
+    "@omnifyjp/omnify-win32-x64": "0.1.0"
+  }
+}

package/types/config.d.ts

@@ -0,0 +1,70 @@
+import type { LocaleConfig } from "./i18n";
+
+/** Supported database driver identifiers. */
+export type DatabaseDriver = "mysql" | "pgsql" | "postgres" | "sqlite";
+
+/** SQL dialect for generated migrations. */
+export type SQLDialect = "mysql" | "postgresql" | "sqlite";
+
+/** Laravel output configuration. */
+export interface LaravelOutputConfig {
+  /** Directory for Laravel migration files. */
+  migrationsPath: string;
+  /** Path for exported schemas JSON (used by omnify-php-laravel). */
+  schemasPath?: string;
+}
+
+/** Raw SQL output configuration. */
+export interface SQLOutputConfig {
+  /** Directory for SQL migration files. */
+  path: string;
+  /** SQL dialect for generated migrations. */
+  dialect?: SQLDialect;
+}
+
+/** TypeScript output configuration. */
+export interface TypeScriptOutputConfig {
+  /** Directory for generated TypeScript model files. */
+  path: string;
+}
+
+/** All output configurations for a connection. */
+export interface OutputConfig {
+  laravel?: LaravelOutputConfig;
+  sql?: SQLOutputConfig;
+  typescript?: TypeScriptOutputConfig;
+}
+
+/** Per-connection database and output configuration. */
+export interface ConnectionConfig {
+  driver: DatabaseDriver;
+  output: OutputConfig;
+}
+
+/** Additional schema directory to load. */
+export interface AdditionalSchemaPath {
+  /** Path to the additional schema directory. */
+  path: string;
+  /** Namespace prefix for schemas in this directory. */
+  namespace?: string;
+}
+
+/** Main Omnify configuration (omnify.yaml). */
+export interface OmnifyConfig {
+  /** Directory containing schema YAML files. */
+  schemasDir?: string;
+  /** Additional schema directories to load. */
+  additionalSchemaPaths?: AdditionalSchemaPath[];
+  /** Path to the lock file for tracking migration state. */
+  lockFilePath?: string;
+  /** Database connection configurations. */
+  connections?: Record<string, ConnectionConfig>;
+  /** Default connection name. */
+  default?: string;
+  /** Locale settings for multi-language support. */
+  locale?: LocaleConfig;
+  /** Built-in compound type packs to enable (e.g. "japan"). */
+  compoundTypes?: string[];
+  /** Enable verbose output during generation. */
+  verbose?: boolean;
+}

package/types/i18n.d.ts

@@ -0,0 +1,18 @@
+/** BCP-47 locale code (e.g. "ja", "en", "vi"). */
+export type LocaleCode = string;
+
+/** Map of locale codes to translated strings. */
+export type LocaleMap = Record<LocaleCode, string>;
+
+/** A plain string or a locale map for multi-language support. */
+export type LocalizedString = string | LocaleMap;
+
+/** Locale settings for multi-language support. */
+export interface LocaleConfig {
+  /** Supported locale codes (e.g. ["ja", "en", "vi"]). */
+  locales?: LocaleCode[];
+  /** Default locale code. */
+  defaultLocale?: string;
+  /** Fallback locale when translation is missing. */
+  fallbackLocale?: string;
+}

package/types/index.d.ts

@@ -0,0 +1,36 @@
+export type {
+  LocaleCode,
+  LocaleMap,
+  LocalizedString,
+  LocaleConfig,
+} from "./i18n";
+
+export type {
+  BuiltInPropertyType,
+  AssociationRelation,
+  ReferentialAction,
+  SchemaKind,
+  IdType,
+  IndexType,
+  InlineEnumValue,
+  CompoundFieldOverride,
+  PivotFieldDefinition,
+  ValidationRules,
+  PropertyDefinition,
+  IndexDefinition,
+  SchemaOptions,
+  SchemaDefinition,
+  LoadedSchema,
+  SchemaCollection,
+} from "./schema";
+
+export type {
+  DatabaseDriver,
+  SQLDialect,
+  LaravelOutputConfig,
+  SQLOutputConfig,
+  OutputConfig,
+  ConnectionConfig,
+  AdditionalSchemaPath,
+  OmnifyConfig,
+} from "./config";

package/types/schema.d.ts

@@ -0,0 +1,240 @@
+import type { LocalizedString } from "./i18n";
+
+// ---------------------------------------------------------------------------
+// Type unions
+// ---------------------------------------------------------------------------
+
+/** Built-in property types supported by Omnify. */
+export type BuiltInPropertyType =
+  | "String"
+  | "TinyInt"
+  | "Int"
+  | "BigInt"
+  | "Float"
+  | "Decimal"
+  | "Boolean"
+  | "Text"
+  | "MediumText"
+  | "LongText"
+  | "Date"
+  | "Time"
+  | "Timestamp"
+  | "DateTime"
+  | "Json"
+  | "Email"
+  | "Password"
+  | "File"
+  | "Point"
+  | "Coordinates"
+  | "Enum"
+  | "EnumRef"
+  | "Association"
+  | "Uuid";
+
+/** Relationship cardinality types. */
+export type AssociationRelation =
+  | "OneToOne"
+  | "OneToMany"
+  | "ManyToOne"
+  | "ManyToMany"
+  | "MorphTo"
+  | "MorphOne"
+  | "MorphMany"
+  | "MorphToMany"
+  | "MorphedByMany";
+
+/** Referential action for foreign key constraints. */
+export type ReferentialAction =
+  | "CASCADE"
+  | "SET NULL"
+  | "SET DEFAULT"
+  | "RESTRICT"
+  | "NO ACTION";
+
+/** Schema kind determines how a schema is processed. */
+export type SchemaKind = "object" | "enum" | "partial" | "extend" | "pivot";
+
+/** Primary key column type. */
+export type IdType = "BigInt" | "Int" | "Uuid" | "String";
+
+/** Database index type. */
+export type IndexType = "btree" | "hash" | "fulltext" | "spatial" | "gin" | "gist";
+
+// ---------------------------------------------------------------------------
+// Interfaces
+// ---------------------------------------------------------------------------
+
+/** An enum value with optional label and extra properties. */
+export interface InlineEnumValue {
+  /** Enum value stored in database. */
+  value: string;
+  /** Human-readable label (supports multi-language). */
+  label?: LocalizedString;
+  /** Additional metadata. */
+  extra?: Record<string, unknown>;
+}
+
+/** Per-field overrides for compound types (e.g. JapaneseName sub-fields). */
+export interface CompoundFieldOverride {
+  nullable?: boolean;
+  hidden?: boolean;
+  fillable?: boolean;
+  /** Override length for string fields. */
+  length?: number;
+  displayName?: LocalizedString;
+  placeholder?: LocalizedString;
+}
+
+/** Field definition on a pivot table. */
+export interface PivotFieldDefinition {
+  type: BuiltInPropertyType;
+  nullable?: boolean;
+  default?: unknown;
+  length?: number;
+  unsigned?: boolean;
+  /** Inline enum values or reference. */
+  enum?: (string | InlineEnumValue)[] | string;
+  displayName?: LocalizedString;
+}
+
+/** Application-level validation rules. */
+export interface ValidationRules {
+  required?: boolean;
+  // String rules
+  minLength?: number;
+  maxLength?: number;
+  url?: boolean;
+  uuid?: boolean;
+  ip?: boolean;
+  ipv4?: boolean;
+  ipv6?: boolean;
+  alpha?: boolean;
+  alphaNum?: boolean;
+  alphaDash?: boolean;
+  numeric?: boolean;
+  digits?: number;
+  digitsBetween?: [number, number];
+  startsWith?: string | string[];
+  endsWith?: string | string[];
+  lowercase?: boolean;
+  uppercase?: boolean;
+  // Numeric rules
+  min?: number;
+  max?: number;
+  between?: [number, number];
+  gt?: number;
+  lt?: number;
+  multipleOf?: number;
+  // Array rules
+  arrayMin?: number;
+  arrayMax?: number;
+}
+
+/** Flat property definition covering all property types. */
+export interface PropertyDefinition {
+  type: BuiltInPropertyType;
+  displayName?: LocalizedString;
+  nullable?: boolean;
+  default?: unknown;
+  unique?: boolean;
+  description?: LocalizedString;
+  renamedFrom?: string;
+  rules?: ValidationRules;
+  primary?: boolean;
+  hidden?: boolean;
+  fillable?: boolean;
+  placeholder?: LocalizedString;
+  /** Per-field overrides for compound types. */
+  fields?: Record<string, CompoundFieldOverride>;
+
+  // String-specific
+  length?: number;
+
+  // Numeric-specific
+  unsigned?: boolean;
+  precision?: number;
+  scale?: number;
+
+  // Timestamp-specific
+  useCurrent?: boolean;
+  useCurrentOnUpdate?: boolean;
+
+  // Enum-specific (array for inline Enum, string for EnumRef)
+  enum?: (string | InlineEnumValue)[] | string;
+
+  // File-specific
+  multiple?: boolean;
+  maxFiles?: number;
+  accept?: string[];
+  maxSize?: number;
+
+  // Association-specific
+  relation?: AssociationRelation;
+  target?: string;
+  targets?: string[];
+  morphName?: string;
+  inversedBy?: string;
+  mappedBy?: string;
+  onDelete?: ReferentialAction;
+  onUpdate?: ReferentialAction;
+  owning?: boolean;
+  joinTable?: string;
+  pivotFields?: Record<string, PivotFieldDefinition>;
+  targetNamespace?: string;
+  idType?: IdType;
+}
+
+/** Database index definition. */
+export interface IndexDefinition {
+  columns: string[];
+  unique?: boolean;
+  name?: string;
+  type?: IndexType;
+}
+
+/** Schema-level configuration options. */
+export interface SchemaOptions {
+  /** Whether to auto-generate an 'id' primary key column. */
+  id?: boolean;
+  idType?: IdType;
+  /** Custom primary key — single column or composite. */
+  primaryKey?: string | string[];
+  timestamps?: boolean;
+  softDelete?: boolean;
+  /** Unique constraints — column list or array of column lists. */
+  unique?: string[] | string[][];
+  indexes?: IndexDefinition[];
+  translations?: boolean;
+  tableName?: string;
+  authenticatable?: boolean;
+  hidden?: boolean;
+}
+
+/** Complete schema definition (corresponds to a single YAML file). */
+export interface SchemaDefinition {
+  connection?: string;
+  kind?: SchemaKind;
+  /** Target schema name for partial/extend schemas. */
+  target?: string;
+  /** Priority for partial merging (default 50). */
+  priority?: number;
+  /** Schema names this pivot is for. */
+  pivotFor?: string[];
+  displayName?: LocalizedString;
+  titleIndex?: string;
+  group?: string;
+  options?: SchemaOptions;
+  properties?: Record<string, PropertyDefinition>;
+  /** Enum values (only when kind is "enum"). */
+  values?: (string | InlineEnumValue)[];
+}
+
+/** A schema with metadata from loading. */
+export interface LoadedSchema extends SchemaDefinition {
+  name: string;
+  filePath: string;
+  relativePath: string;
+}
+
+/** Map of schema name to loaded schema. */
+export type SchemaCollection = Record<string, LoadedSchema>;