@famgia/omnify-types 0.0.3 → 0.0.5

package/README.md

@@ -1,6 +1,6 @@
 # @famgia/omnify-types
 
-Shared TypeScript types for the Omnify schema system.
+Shared TypeScript type definitions for the Omnify schema system.
 
 ## Installation
 
@@ -12,22 +12,217 @@ npm install @famgia/omnify-types
 
 ```typescript
 import type {
+  // Schema types
   SchemaDefinition,
   LoadedSchema,
+  SchemaCollection,
   PropertyDefinition,
   AssociationDefinition,
-  OmnifyPlugin
+
+  // Plugin types
+  OmnifyPlugin,
+  PluginContext,
+  PluginLogger,
+  CustomTypeDefinition,
+
+  // Generator types
+  GeneratorDefinition,
+  GeneratorContext,
+  GeneratorOutput,
+  GeneratorOutputType,
+
+  // Config types
+  OmnifyConfig,
+  ResolvedOmnifyConfig,
 } from '@famgia/omnify-types';
 ```
 
-## Types
+## Type Reference
+
+### Schema Types
+
+#### `SchemaDefinition`
+Raw schema definition as loaded from YAML/JSON.
+
+```typescript
+interface SchemaDefinition {
+  name: string;
+  kind: 'object' | 'enum';
+  displayName?: string;
+  properties?: Record<string, PropertyDefinition>;
+  associations?: Record<string, AssociationDefinition>;
+  options?: SchemaOptions;
+  values?: string[]; // For enums
+}
+```
+
+#### `LoadedSchema`
+Parsed and validated schema with file path.
+
+```typescript
+interface LoadedSchema extends SchemaDefinition {
+  filePath: string;
+}
+```
+
+#### `SchemaCollection`
+Map of schema name to loaded schema.
+
+```typescript
+type SchemaCollection = Record<string, LoadedSchema>;
+```
+
+#### `PropertyDefinition`
+Field/property definition.
+
+```typescript
+interface PropertyDefinition {
+  type: string;
+  nullable?: boolean;
+  unique?: boolean;
+  default?: unknown;
+  displayName?: string;
+}
+```
+
+#### `AssociationDefinition`
+Relationship definition.
+
+```typescript
+interface AssociationDefinition {
+  type: 'belongsTo' | 'hasMany' | 'hasOne' | 'belongsToMany';
+  model: string;
+  foreignKey?: string;
+  pivotTable?: string;
+}
+```
+
+### Plugin Types
+
+#### `OmnifyPlugin`
+Plugin interface for extending Omnify.
+
+```typescript
+interface OmnifyPlugin {
+  name: string;
+  version: string;
+
+  // Lifecycle hooks
+  setup?: (context: PluginContext) => Promise<void>;
+  teardown?: () => Promise<void>;
+
+  // Custom types
+  types?: CustomTypeDefinition[];
+
+  // Generators
+  generators?: GeneratorDefinition[];
+}
+```
 
-- `SchemaDefinition` - Raw schema definition from YAML/JSON
-- `LoadedSchema` - Parsed and validated schema
-- `PropertyDefinition` - Field/property definition
-- `AssociationDefinition` - Relationship definition
-- `OmnifyPlugin` - Plugin interface
-- `OmnifyConfig` - Configuration options
+#### `CustomTypeDefinition`
+Custom type for extending schema types.
+
+```typescript
+interface CustomTypeDefinition {
+  name: string;
+  typescript: string;
+  laravel: string;
+  laravelParams?: unknown[];
+}
+```
+
+### Generator Types
+
+#### `GeneratorDefinition`
+Generator definition for creating output files.
+
+```typescript
+interface GeneratorDefinition {
+  name: string;
+  description?: string;
+  dependsOn?: string[];
+  generate: (ctx: GeneratorContext) => Promise<GeneratorOutput[]>;
+}
+```
+
+#### `GeneratorContext`
+Context passed to generator functions.
+
+```typescript
+interface GeneratorContext {
+  schemas: SchemaCollection;
+  pluginConfig: Record<string, unknown>;
+  cwd: string;
+  logger: PluginLogger;
+  previousOutputs: ReadonlyMap<string, readonly GeneratorOutput[]>;
+}
+```
+
+#### `GeneratorOutput`
+Output file from a generator.
+
+```typescript
+interface GeneratorOutput {
+  path: string;
+  content: string;
+  type: GeneratorOutputType;
+  metadata?: Record<string, unknown>;
+}
+
+type GeneratorOutputType = 'migration' | 'type' | 'model' | 'schema' | 'other';
+```
+
+### Config Types
+
+#### `OmnifyConfig`
+Configuration options.
+
+```typescript
+interface OmnifyConfig {
+  schemasDir: string;
+  lockFilePath?: string;
+  database?: DatabaseConfig;
+  output?: OutputConfig;
+  plugins?: OmnifyPlugin[];
+}
+```
+
+## Creating a Plugin
+
+```typescript
+import type { OmnifyPlugin } from '@famgia/omnify-types';
+
+const myPlugin: OmnifyPlugin = {
+  name: 'my-plugin',
+  version: '1.0.0',
+
+  types: [
+    {
+      name: 'Money',
+      typescript: 'number',
+      laravel: 'decimal',
+      laravelParams: [10, 2],
+    },
+  ],
+
+  generators: [
+    {
+      name: 'my-generator',
+      dependsOn: ['other-generator'],
+
+      generate: async (ctx) => {
+        return [{
+          path: 'output/file.ts',
+          content: '// Generated',
+          type: 'other',
+        }];
+      },
+    },
+  ],
+};
+
+export default myPlugin;
+```
 
 ## Related Packages
 

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/errors.ts"],"sourcesContent":["/**\n * @famgia/omnify-types\n * Core type definitions for omnify-schema\n *\n * This package provides shared TypeScript interfaces and types\n * used across all omnify packages.\n */\n\n// ============================================================================\n// Schema Types\n// ============================================================================\n\nexport type {\n  // Property types\n  BuiltInPropertyType,\n  PropertyType,\n  // Association types\n  AssociationRelation,\n  ReferentialAction,\n  AssociationDefinition,\n  // Property definitions\n  BasePropertyDefinition,\n  StringPropertyDefinition,\n  NumericPropertyDefinition,\n  EnumPropertyDefinition,\n  SelectPropertyDefinition,\n  PropertyDefinition,\n  // Schema options\n  IndexDefinition,\n  SchemaOptions,\n  // Schema definitions\n  SchemaKind,\n  SchemaDefinition,\n  LoadedSchema,\n  SchemaCollection,\n} from './schema.js';\n\n// ============================================================================\n// Configuration Types\n// ============================================================================\n\nexport type {\n  // Database config\n  DatabaseDriver,\n  DatabaseConfig,\n  // Output config\n  LaravelOutputConfig,\n  TypeScriptOutputConfig,\n  OutputConfig,\n  // Main config\n  OmnifyConfig,\n  ResolvedOmnifyConfig,\n} from './config.js';\n\n// ============================================================================\n// Plugin Types\n// ============================================================================\n\nexport type {\n  // Type definitions\n  SqlColumnDefinition,\n  TypeScriptTypeInfo,\n  ExpandedFieldDefinition,\n  CustomTypeDefinition,\n  // Plugin interface\n  PluginContext,\n  PluginLogger,\n  OmnifyPlugin,\n  PluginFactory,\n} from './plugin.js';\n\n// ============================================================================\n// Error Types\n// ============================================================================\n\nexport type {\n  ErrorCode,\n  ErrorLocation,\n  OmnifyErrorInfo,\n  Result,\n} from './errors.js';\n\nexport { ok, err } from './errors.js';\n","/**\n * @famgia/omnify-types - Error Types\n *\n * Type definitions for omnify error handling.\n * Errors follow the format: file:line + message + suggestion\n */\n\n// ============================================================================\n// Error Codes\n// ============================================================================\n\n/**\n * Error code categories:\n * - E0xx: Configuration errors\n * - E1xx: Schema parsing errors\n * - E2xx: Schema validation errors\n * - E3xx: Plugin errors\n * - E4xx: Atlas/Database errors\n * - E5xx: Generation errors\n * - E9xx: Internal errors\n */\nexport type ErrorCode =\n  // Configuration errors (E0xx)\n  | 'E001' // Config file not found\n  | 'E002' // Invalid config format\n  | 'E003' // Missing required config field\n  | 'E004' // Invalid database driver\n  | 'E005' // Invalid output path\n  // Schema parsing errors (E1xx)\n  | 'E101' // Schema file not found\n  | 'E102' // Invalid YAML syntax\n  | 'E103' // Invalid JSON syntax\n  | 'E104' // Empty schema file\n  | 'E105' // Schema read error\n  // Schema validation errors (E2xx)\n  | 'E201' // Invalid property type\n  | 'E202' // Missing required field\n  | 'E203' // Invalid association target\n  | 'E204' // Circular reference detected\n  | 'E205' // Duplicate schema name\n  | 'E206' // Invalid schema options\n  | 'E207' // Invalid enum values\n  | 'E208' // Orphaned inverse relation\n  // Plugin errors (E3xx)\n  | 'E301' // Plugin not found\n  | 'E302' // Plugin load error\n  | 'E303' // Invalid plugin format\n  | 'E304' // Plugin type conflict\n  | 'E305' // Plugin setup error\n  // Atlas/Database errors (E4xx)\n  | 'E401' // Atlas CLI not found\n  | 'E402' // Atlas diff failed\n  | 'E403' // Database connection error\n  | 'E404' // HCL generation error\n  | 'E405' // Lock file error\n  // Generation errors (E5xx)\n  | 'E501' // Migration generation failed\n  | 'E502' // TypeScript generation failed\n  | 'E503' // Output write error\n  | 'E504' // Template error\n  // Internal errors (E9xx)\n  | 'E901' // Unexpected error\n  | 'E902'; // Not implemented\n\n// ============================================================================\n// Error Info\n// ============================================================================\n\n/**\n * Source location where an error occurred.\n */\nexport interface ErrorLocation {\n  /** File path where the error occurred */\n  readonly file?: string;\n  /** Line number (1-based) */\n  readonly line?: number;\n  /** Column number (1-based) */\n  readonly column?: number;\n}\n\n/**\n * Structured error information for omnify errors.\n */\nexport interface OmnifyErrorInfo {\n  /** Error code (e.g., 'E201') */\n  readonly code: ErrorCode;\n  /** Human-readable error message */\n  readonly message: string;\n  /** Location where the error occurred */\n  readonly location?: ErrorLocation;\n  /** Suggested fix for the error */\n  readonly suggestion?: string;\n  /** Additional context or details */\n  readonly details?: Record<string, unknown>;\n  /** Original error if this wraps another error */\n  readonly cause?: Error;\n}\n\n/**\n * Result type for operations that may fail.\n */\nexport type Result<T, E = OmnifyErrorInfo> =\n  | { readonly ok: true; readonly value: T }\n  | { readonly ok: false; readonly error: E };\n\n/**\n * Helper to create a successful result.\n */\nexport function ok<T>(value: T): Result<T, never> {\n  return { ok: true, value };\n}\n\n/**\n * Helper to create an error result.\n */\nexport function err<E>(error: E): Result<never, E> {\n  return { ok: false, error };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;AC4GO,SAAS,GAAM,OAA4B;AAChD,SAAO,EAAE,IAAI,MAAM,MAAM;AAC3B;AAKO,SAAS,IAAO,OAA4B;AACjD,SAAO,EAAE,IAAI,OAAO,MAAM;AAC5B;","names":[]}
+{"version":3,"sources":["../src/index.ts","../src/errors.ts"],"sourcesContent":["/**\n * @famgia/omnify-types\n * Core type definitions for omnify-schema\n *\n * This package provides shared TypeScript interfaces and types\n * used across all omnify packages.\n */\n\n// ============================================================================\n// Schema Types\n// ============================================================================\n\nexport type {\n  // Property types\n  BuiltInPropertyType,\n  PropertyType,\n  // Association types\n  AssociationRelation,\n  ReferentialAction,\n  AssociationDefinition,\n  // Property definitions\n  BasePropertyDefinition,\n  StringPropertyDefinition,\n  NumericPropertyDefinition,\n  EnumPropertyDefinition,\n  SelectPropertyDefinition,\n  PropertyDefinition,\n  // Schema options\n  IndexDefinition,\n  SchemaOptions,\n  // Schema definitions\n  SchemaKind,\n  SchemaDefinition,\n  LoadedSchema,\n  SchemaCollection,\n} from './schema.js';\n\n// ============================================================================\n// Configuration Types\n// ============================================================================\n\nexport type {\n  // Database config\n  DatabaseDriver,\n  DatabaseConfig,\n  // Output config\n  LaravelOutputConfig,\n  TypeScriptOutputConfig,\n  OutputConfig,\n  // Main config\n  OmnifyConfig,\n  ResolvedOmnifyConfig,\n} from './config.js';\n\n// ============================================================================\n// Plugin Types\n// ============================================================================\n\nexport type {\n  // Type definitions\n  SqlColumnDefinition,\n  TypeScriptTypeInfo,\n  ExpandedFieldDefinition,\n  CustomTypeDefinition,\n  // Plugin interface\n  PluginContext,\n  PluginLogger,\n  OmnifyPlugin,\n  PluginFactory,\n  // Generator types\n  GeneratorOutputType,\n  GeneratorOutput,\n  GeneratorContext,\n  GeneratorDefinition,\n} from './plugin.js';\n\n// ============================================================================\n// Error Types\n// ============================================================================\n\nexport type {\n  ErrorCode,\n  ErrorLocation,\n  OmnifyErrorInfo,\n  Result,\n} from './errors.js';\n\nexport { ok, err } from './errors.js';\n","/**\n * @famgia/omnify-types - Error Types\n *\n * Type definitions for omnify error handling.\n * Errors follow the format: file:line + message + suggestion\n */\n\n// ============================================================================\n// Error Codes\n// ============================================================================\n\n/**\n * Error code categories:\n * - E0xx: Configuration errors\n * - E1xx: Schema parsing errors\n * - E2xx: Schema validation errors\n * - E3xx: Plugin errors\n * - E4xx: Atlas/Database errors\n * - E5xx: Generation errors\n * - E9xx: Internal errors\n */\nexport type ErrorCode =\n  // Configuration errors (E0xx)\n  | 'E001' // Config file not found\n  | 'E002' // Invalid config format\n  | 'E003' // Missing required config field\n  | 'E004' // Invalid database driver\n  | 'E005' // Invalid output path\n  // Schema parsing errors (E1xx)\n  | 'E101' // Schema file not found\n  | 'E102' // Invalid YAML syntax\n  | 'E103' // Invalid JSON syntax\n  | 'E104' // Empty schema file\n  | 'E105' // Schema read error\n  // Schema validation errors (E2xx)\n  | 'E201' // Invalid property type\n  | 'E202' // Missing required field\n  | 'E203' // Invalid association target\n  | 'E204' // Circular reference detected\n  | 'E205' // Duplicate schema name\n  | 'E206' // Invalid schema options\n  | 'E207' // Invalid enum values\n  | 'E208' // Orphaned inverse relation\n  // Plugin errors (E3xx)\n  | 'E301' // Plugin not found\n  | 'E302' // Plugin load error\n  | 'E303' // Invalid plugin format\n  | 'E304' // Plugin type conflict\n  | 'E305' // Plugin setup error\n  // Atlas/Database errors (E4xx)\n  | 'E401' // Atlas CLI not found\n  | 'E402' // Atlas diff failed\n  | 'E403' // Database connection error\n  | 'E404' // HCL generation error\n  | 'E405' // Lock file error\n  // Generation errors (E5xx)\n  | 'E501' // Migration generation failed\n  | 'E502' // TypeScript generation failed\n  | 'E503' // Output write error\n  | 'E504' // Template error\n  // Internal errors (E9xx)\n  | 'E901' // Unexpected error\n  | 'E902'; // Not implemented\n\n// ============================================================================\n// Error Info\n// ============================================================================\n\n/**\n * Source location where an error occurred.\n */\nexport interface ErrorLocation {\n  /** File path where the error occurred */\n  readonly file?: string;\n  /** Line number (1-based) */\n  readonly line?: number;\n  /** Column number (1-based) */\n  readonly column?: number;\n}\n\n/**\n * Structured error information for omnify errors.\n */\nexport interface OmnifyErrorInfo {\n  /** Error code (e.g., 'E201') */\n  readonly code: ErrorCode;\n  /** Human-readable error message */\n  readonly message: string;\n  /** Location where the error occurred */\n  readonly location?: ErrorLocation;\n  /** Suggested fix for the error */\n  readonly suggestion?: string;\n  /** Additional context or details */\n  readonly details?: Record<string, unknown>;\n  /** Original error if this wraps another error */\n  readonly cause?: Error;\n}\n\n/**\n * Result type for operations that may fail.\n */\nexport type Result<T, E = OmnifyErrorInfo> =\n  | { readonly ok: true; readonly value: T }\n  | { readonly ok: false; readonly error: E };\n\n/**\n * Helper to create a successful result.\n */\nexport function ok<T>(value: T): Result<T, never> {\n  return { ok: true, value };\n}\n\n/**\n * Helper to create an error result.\n */\nexport function err<E>(error: E): Result<never, E> {\n  return { ok: false, error };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;AC4GO,SAAS,GAAM,OAA4B;AAChD,SAAO,EAAE,IAAI,MAAM,MAAM;AAC3B;AAKO,SAAS,IAAO,OAA4B;AACjD,SAAO,EAAE,IAAI,OAAO,MAAM;AAC5B;","names":[]}

package/dist/index.d.cts

@@ -327,6 +327,11 @@ interface OmnifyPlugin {
      * Custom type definitions provided by this plugin.
      */
     readonly types?: readonly CustomTypeDefinition[];
+    /**
+     * Generator definitions provided by this plugin.
+     * Generators produce output files (migrations, types, models, etc.)
+     */
+    readonly generators?: readonly GeneratorDefinition[];
     /**
      * Optional setup function called when plugin is loaded.
      * @param context - Plugin context with utilities
@@ -342,6 +347,75 @@ interface OmnifyPlugin {
  * Useful for plugins that need configuration.
  */
 type PluginFactory<TOptions = unknown> = (options?: TOptions) => OmnifyPlugin;
+/**
+ * Output type for generated files.
+ */
+type GeneratorOutputType = 'migration' | 'type' | 'model' | 'schema' | 'other';
+/**
+ * Output from a generator - represents a file to be written.
+ */
+interface GeneratorOutput {
+    /** Relative path where the file should be written */
+    readonly path: string;
+    /** Content of the file */
+    readonly content: string;
+    /** Type of output for categorization */
+    readonly type: GeneratorOutputType;
+    /** Optional metadata */
+    readonly metadata?: Record<string, unknown>;
+}
+/**
+ * Context provided to generators during execution.
+ */
+interface GeneratorContext {
+    /** Loaded and validated schema collection */
+    readonly schemas: SchemaCollection;
+    /** Plugin-specific configuration (passed to plugin factory) */
+    readonly pluginConfig: Record<string, unknown>;
+    /** Current working directory */
+    readonly cwd: string;
+    /** Logger for output */
+    readonly logger: PluginLogger;
+    /** Outputs from previously run generators (for dependencies) */
+    readonly previousOutputs: ReadonlyMap<string, readonly GeneratorOutput[]>;
+}
+/**
+ * Definition of a generator provided by a plugin.
+ *
+ * @example
+ * ```typescript
+ * const migrationGenerator: GeneratorDefinition = {
+ *   name: 'laravel-migrations',
+ *   description: 'Generate Laravel migration files',
+ *   generate: async (ctx) => {
+ *     const migrations = generateMigrations(ctx.schemas);
+ *     return migrations.map(m => ({
+ *       path: `database/migrations/${m.fileName}`,
+ *       content: m.content,
+ *       type: 'migration',
+ *     }));
+ *   },
+ * };
+ * ```
+ */
+interface GeneratorDefinition {
+    /** Unique generator name (e.g., 'laravel-migrations') */
+    readonly name: string;
+    /** Human-readable description */
+    readonly description?: string;
+    /**
+     * Dependencies on other generators.
+     * This generator will run after all dependencies have completed.
+     * Used for topological sorting (DAG).
+     */
+    readonly dependsOn?: readonly string[];
+    /**
+     * Generator function.
+     * @param ctx - Generator context with schemas and configuration
+     * @returns Array of files to generate
+     */
+    readonly generate: (ctx: GeneratorContext) => GeneratorOutput[] | Promise<GeneratorOutput[]>;
+}
 
 /**
  * @famgia/omnify-types - Configuration Types
@@ -508,4 +582,4 @@ declare function ok<T>(value: T): Result<T, never>;
  */
 declare function err<E>(error: E): Result<never, E>;
 
-export { type AssociationDefinition, type AssociationRelation, type BasePropertyDefinition, type BuiltInPropertyType, type CustomTypeDefinition, type DatabaseConfig, type DatabaseDriver, type EnumPropertyDefinition, type ErrorCode, type ErrorLocation, type ExpandedFieldDefinition, type IndexDefinition, type LaravelOutputConfig, type LoadedSchema, type NumericPropertyDefinition, type OmnifyConfig, type OmnifyErrorInfo, type OmnifyPlugin, type OutputConfig, type PluginContext, type PluginFactory, type PluginLogger, type PropertyDefinition, type PropertyType, type ReferentialAction, type ResolvedOmnifyConfig, type Result, type SchemaCollection, type SchemaDefinition, type SchemaKind, type SchemaOptions, type SelectPropertyDefinition, type SqlColumnDefinition, type StringPropertyDefinition, type TypeScriptOutputConfig, type TypeScriptTypeInfo, err, ok };
+export { type AssociationDefinition, type AssociationRelation, type BasePropertyDefinition, type BuiltInPropertyType, type CustomTypeDefinition, type DatabaseConfig, type DatabaseDriver, type EnumPropertyDefinition, type ErrorCode, type ErrorLocation, type ExpandedFieldDefinition, type GeneratorContext, type GeneratorDefinition, type GeneratorOutput, type GeneratorOutputType, type IndexDefinition, type LaravelOutputConfig, type LoadedSchema, type NumericPropertyDefinition, type OmnifyConfig, type OmnifyErrorInfo, type OmnifyPlugin, type OutputConfig, type PluginContext, type PluginFactory, type PluginLogger, type PropertyDefinition, type PropertyType, type ReferentialAction, type ResolvedOmnifyConfig, type Result, type SchemaCollection, type SchemaDefinition, type SchemaKind, type SchemaOptions, type SelectPropertyDefinition, type SqlColumnDefinition, type StringPropertyDefinition, type TypeScriptOutputConfig, type TypeScriptTypeInfo, err, ok };

package/dist/index.d.ts

@@ -327,6 +327,11 @@ interface OmnifyPlugin {
      * Custom type definitions provided by this plugin.
      */
     readonly types?: readonly CustomTypeDefinition[];
+    /**
+     * Generator definitions provided by this plugin.
+     * Generators produce output files (migrations, types, models, etc.)
+     */
+    readonly generators?: readonly GeneratorDefinition[];
     /**
      * Optional setup function called when plugin is loaded.
      * @param context - Plugin context with utilities
@@ -342,6 +347,75 @@ interface OmnifyPlugin {
  * Useful for plugins that need configuration.
  */
 type PluginFactory<TOptions = unknown> = (options?: TOptions) => OmnifyPlugin;
+/**
+ * Output type for generated files.
+ */
+type GeneratorOutputType = 'migration' | 'type' | 'model' | 'schema' | 'other';
+/**
+ * Output from a generator - represents a file to be written.
+ */
+interface GeneratorOutput {
+    /** Relative path where the file should be written */
+    readonly path: string;
+    /** Content of the file */
+    readonly content: string;
+    /** Type of output for categorization */
+    readonly type: GeneratorOutputType;
+    /** Optional metadata */
+    readonly metadata?: Record<string, unknown>;
+}
+/**
+ * Context provided to generators during execution.
+ */
+interface GeneratorContext {
+    /** Loaded and validated schema collection */
+    readonly schemas: SchemaCollection;
+    /** Plugin-specific configuration (passed to plugin factory) */
+    readonly pluginConfig: Record<string, unknown>;
+    /** Current working directory */
+    readonly cwd: string;
+    /** Logger for output */
+    readonly logger: PluginLogger;
+    /** Outputs from previously run generators (for dependencies) */
+    readonly previousOutputs: ReadonlyMap<string, readonly GeneratorOutput[]>;
+}
+/**
+ * Definition of a generator provided by a plugin.
+ *
+ * @example
+ * ```typescript
+ * const migrationGenerator: GeneratorDefinition = {
+ *   name: 'laravel-migrations',
+ *   description: 'Generate Laravel migration files',
+ *   generate: async (ctx) => {
+ *     const migrations = generateMigrations(ctx.schemas);
+ *     return migrations.map(m => ({
+ *       path: `database/migrations/${m.fileName}`,
+ *       content: m.content,
+ *       type: 'migration',
+ *     }));
+ *   },
+ * };
+ * ```
+ */
+interface GeneratorDefinition {
+    /** Unique generator name (e.g., 'laravel-migrations') */
+    readonly name: string;
+    /** Human-readable description */
+    readonly description?: string;
+    /**
+     * Dependencies on other generators.
+     * This generator will run after all dependencies have completed.
+     * Used for topological sorting (DAG).
+     */
+    readonly dependsOn?: readonly string[];
+    /**
+     * Generator function.
+     * @param ctx - Generator context with schemas and configuration
+     * @returns Array of files to generate
+     */
+    readonly generate: (ctx: GeneratorContext) => GeneratorOutput[] | Promise<GeneratorOutput[]>;
+}
 
 /**
  * @famgia/omnify-types - Configuration Types
@@ -508,4 +582,4 @@ declare function ok<T>(value: T): Result<T, never>;
  */
 declare function err<E>(error: E): Result<never, E>;
 
-export { type AssociationDefinition, type AssociationRelation, type BasePropertyDefinition, type BuiltInPropertyType, type CustomTypeDefinition, type DatabaseConfig, type DatabaseDriver, type EnumPropertyDefinition, type ErrorCode, type ErrorLocation, type ExpandedFieldDefinition, type IndexDefinition, type LaravelOutputConfig, type LoadedSchema, type NumericPropertyDefinition, type OmnifyConfig, type OmnifyErrorInfo, type OmnifyPlugin, type OutputConfig, type PluginContext, type PluginFactory, type PluginLogger, type PropertyDefinition, type PropertyType, type ReferentialAction, type ResolvedOmnifyConfig, type Result, type SchemaCollection, type SchemaDefinition, type SchemaKind, type SchemaOptions, type SelectPropertyDefinition, type SqlColumnDefinition, type StringPropertyDefinition, type TypeScriptOutputConfig, type TypeScriptTypeInfo, err, ok };
+export { type AssociationDefinition, type AssociationRelation, type BasePropertyDefinition, type BuiltInPropertyType, type CustomTypeDefinition, type DatabaseConfig, type DatabaseDriver, type EnumPropertyDefinition, type ErrorCode, type ErrorLocation, type ExpandedFieldDefinition, type GeneratorContext, type GeneratorDefinition, type GeneratorOutput, type GeneratorOutputType, type IndexDefinition, type LaravelOutputConfig, type LoadedSchema, type NumericPropertyDefinition, type OmnifyConfig, type OmnifyErrorInfo, type OmnifyPlugin, type OutputConfig, type PluginContext, type PluginFactory, type PluginLogger, type PropertyDefinition, type PropertyType, type ReferentialAction, type ResolvedOmnifyConfig, type Result, type SchemaCollection, type SchemaDefinition, type SchemaKind, type SchemaOptions, type SelectPropertyDefinition, type SqlColumnDefinition, type StringPropertyDefinition, type TypeScriptOutputConfig, type TypeScriptTypeInfo, err, ok };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@famgia/omnify-types",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Shared TypeScript types for omnify-schema",
   "type": "module",
   "main": "./dist/index.js",