@famgia/omnify-types 0.0.1

package/dist/index.cjs

@@ -0,0 +1,40 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  err: () => err,
+  ok: () => ok
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/errors.ts
+function ok(value) {
+  return { ok: true, value };
+}
+function err(error) {
+  return { ok: false, error };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  err,
+  ok
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +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":[]}

package/dist/index.d.cts

@@ -0,0 +1,511 @@
+/**
+ * @famgia/omnify-types - Schema Definition Types
+ *
+ * Core type definitions for schema objects, properties, and associations.
+ */
+/**
+ * Built-in property types supported by omnify-schema.
+ * Custom types can be added via plugins.
+ */
+type BuiltInPropertyType = 'String' | 'Int' | 'BigInt' | 'Float' | 'Boolean' | 'Text' | 'LongText' | 'Date' | 'Time' | 'Timestamp' | 'Json' | 'Email' | 'Password' | 'File' | 'MultiFile' | 'Enum' | 'Select' | 'Lookup' | 'Association' | 'Polymorphic';
+/**
+ * Property type - can be a built-in type or a custom plugin type (string).
+ */
+type PropertyType = BuiltInPropertyType | (string & {});
+/**
+ * Relationship cardinality types for associations.
+ */
+type AssociationRelation = 'OneToOne' | 'OneToMany' | 'ManyToOne' | 'ManyToMany';
+/**
+ * Referential action for foreign key constraints.
+ */
+type ReferentialAction = 'CASCADE' | 'SET NULL' | 'SET DEFAULT' | 'RESTRICT' | 'NO ACTION';
+/**
+ * Association property definition - defines a relationship to another schema.
+ */
+interface AssociationDefinition {
+    /** Display name for the association */
+    readonly displayName?: string;
+    /** Must be 'Association' for association properties */
+    readonly type: 'Association';
+    /** Relationship cardinality */
+    readonly relation: AssociationRelation;
+    /** Target schema name (e.g., 'User', 'Product') */
+    readonly target: string;
+    /** Property name on the target schema that maps back (for bidirectional) */
+    readonly inversedBy?: string;
+    /** Property name on this schema that is mapped by target (for bidirectional) */
+    readonly mappedBy?: string;
+    /** Action when referenced record is deleted */
+    readonly onDelete?: ReferentialAction;
+    /** Action when referenced record is updated */
+    readonly onUpdate?: ReferentialAction;
+    /** Whether this side owns the relationship (has the foreign key) */
+    readonly owning?: boolean;
+    /** Custom join table name for ManyToMany */
+    readonly joinTable?: string;
+}
+/**
+ * Base property definition shared by all property types.
+ */
+interface BasePropertyDefinition {
+    /** Property type (String, Int, Association, etc.) */
+    readonly type: PropertyType;
+    /** Human-readable display name */
+    readonly displayName?: string;
+    /** Whether the field can be null */
+    readonly nullable?: boolean;
+    /** Default value for the field */
+    readonly default?: unknown;
+    /** Whether this field must be unique */
+    readonly unique?: boolean;
+    /** Field description/comment */
+    readonly description?: string;
+}
+/**
+ * String property with length constraint.
+ */
+interface StringPropertyDefinition extends BasePropertyDefinition {
+    readonly type: 'String' | 'Email' | 'Password';
+    /** Maximum character length */
+    readonly length?: number;
+}
+/**
+ * Numeric property definition.
+ */
+interface NumericPropertyDefinition extends BasePropertyDefinition {
+    readonly type: 'Int' | 'BigInt' | 'Float';
+    /** Whether the number is unsigned (positive only) */
+    readonly unsigned?: boolean;
+    /** Precision for decimal types */
+    readonly precision?: number;
+    /** Scale for decimal types */
+    readonly scale?: number;
+}
+/**
+ * Enum property definition - references an enum.
+ */
+interface EnumPropertyDefinition extends BasePropertyDefinition {
+    readonly type: 'Enum';
+    /** Enum name or inline enum values */
+    readonly enum: string | readonly string[];
+}
+/**
+ * Select/Lookup property definition.
+ */
+interface SelectPropertyDefinition extends BasePropertyDefinition {
+    readonly type: 'Select' | 'Lookup';
+    /** Available options */
+    readonly options?: readonly string[];
+    /** Reference to another schema for lookup */
+    readonly source?: string;
+}
+/**
+ * Union type for all property definitions.
+ */
+type PropertyDefinition = (BasePropertyDefinition & {
+    readonly type: PropertyType;
+}) | StringPropertyDefinition | NumericPropertyDefinition | EnumPropertyDefinition | SelectPropertyDefinition | AssociationDefinition;
+/**
+ * Index definition for database optimization.
+ */
+interface IndexDefinition {
+    /** Columns to include in the index */
+    readonly columns: readonly string[];
+    /** Whether this is a unique index */
+    readonly unique?: boolean;
+    /** Custom index name */
+    readonly name?: string;
+}
+/**
+ * Schema-level options for behavior configuration.
+ */
+interface SchemaOptions {
+    /** Add created_at and updated_at timestamp columns */
+    readonly timestamps?: boolean;
+    /** Add deleted_at column for soft deletes */
+    readonly softDelete?: boolean;
+    /** Columns that should be unique (simple unique constraints) */
+    readonly unique?: readonly string[] | readonly (readonly string[])[];
+    /** Database indexes for query optimization */
+    readonly indexes?: readonly IndexDefinition[];
+    /** Enable translations support */
+    readonly translations?: boolean;
+    /** Custom table name (defaults to pluralized snake_case of schema name) */
+    readonly tableName?: string;
+    /** Primary key type */
+    readonly primaryKeyType?: 'Int' | 'BigInt' | 'Uuid' | 'String';
+    /** Enable authenticatable trait (for User-like schemas) */
+    readonly authenticatable?: boolean;
+    /** Login ID field for authenticatable */
+    readonly authenticatableLoginIdField?: string;
+    /** Password field for authenticatable */
+    readonly authenticatablePasswordField?: string;
+    /** Guard name for authenticatable */
+    readonly authenticatableGuardName?: string;
+}
+/**
+ * Schema kind - determines how the schema is processed.
+ */
+type SchemaKind = 'object' | 'enum';
+/**
+ * Complete schema definition representing a database entity.
+ */
+interface SchemaDefinition {
+    /** Schema kind (defaults to 'object') */
+    readonly kind?: SchemaKind;
+    /** Human-readable display name */
+    readonly displayName?: string;
+    /** Property to use as the title/label for records */
+    readonly titleIndex?: string;
+    /** Schema group for organization */
+    readonly group?: string;
+    /** Schema-level options */
+    readonly options?: SchemaOptions;
+    /** Property definitions */
+    readonly properties?: Readonly<Record<string, PropertyDefinition>>;
+    /** Enum values (when kind is 'enum') */
+    readonly values?: readonly string[];
+}
+/**
+ * Loaded schema with additional metadata.
+ */
+interface LoadedSchema extends SchemaDefinition {
+    /** Schema name (derived from file name) */
+    readonly name: string;
+    /** File path where the schema was loaded from */
+    readonly filePath: string;
+    /** Relative path within schemas directory */
+    readonly relativePath: string;
+}
+/**
+ * Collection of loaded schemas indexed by name.
+ */
+type SchemaCollection = Readonly<Record<string, LoadedSchema>>;
+
+/**
+ * @famgia/omnify-types - Plugin Types
+ *
+ * Type definitions for omnify plugins that provide custom types.
+ */
+
+/**
+ * SQL column definition for a custom type.
+ */
+interface SqlColumnDefinition {
+    /** SQL type (e.g., 'VARCHAR', 'INT', 'TEXT') */
+    readonly sqlType: string;
+    /** Column length/size if applicable */
+    readonly length?: number;
+    /** Precision for decimal types */
+    readonly precision?: number;
+    /** Scale for decimal types */
+    readonly scale?: number;
+    /** Whether the column is nullable */
+    readonly nullable?: boolean;
+    /** Default value */
+    readonly default?: unknown;
+}
+/**
+ * TypeScript type information for code generation.
+ */
+interface TypeScriptTypeInfo {
+    /** TypeScript type as a string (e.g., 'string', 'number', 'MyCustomType') */
+    readonly type: string;
+    /** Whether to import this type from somewhere */
+    readonly import?: {
+        readonly from: string;
+        readonly name: string;
+    };
+}
+/**
+ * Expanded field definition for compound types.
+ * Used when a single custom type expands to multiple database columns.
+ */
+interface ExpandedFieldDefinition {
+    /** Field name suffix (appended to property name) */
+    readonly suffix: string;
+    /** SQL column definition */
+    readonly sql: SqlColumnDefinition;
+    /** TypeScript type for this field */
+    readonly typescript: TypeScriptTypeInfo;
+}
+/**
+ * Definition of a custom property type provided by a plugin.
+ */
+interface CustomTypeDefinition {
+    /** Type name as used in schema files (e.g., 'JapanPhone') */
+    readonly name: string;
+    /**
+     * Description of this custom type.
+     */
+    readonly description?: string;
+    /**
+     * Whether this is a compound type that expands to multiple columns.
+     * If true, use `expand` to define the columns.
+     * If false or undefined, use `sql` and `typescript` for single column.
+     */
+    readonly compound?: boolean;
+    /**
+     * SQL column definition (for single-column types).
+     */
+    readonly sql?: SqlColumnDefinition;
+    /**
+     * TypeScript type info (for single-column types).
+     */
+    readonly typescript?: TypeScriptTypeInfo;
+    /**
+     * Expanded field definitions (for compound types).
+     * Each entry creates an additional column.
+     */
+    readonly expand?: readonly ExpandedFieldDefinition[];
+    /**
+     * Validation function for schema validation.
+     * @param value - The property definition using this type
+     * @returns Error message if invalid, undefined if valid
+     */
+    readonly validate?: (value: PropertyDefinition) => string | undefined;
+}
+/**
+ * Plugin context provided during plugin initialization.
+ */
+interface PluginContext {
+    /** Current working directory */
+    readonly cwd: string;
+    /** Whether verbose logging is enabled */
+    readonly verbose: boolean;
+    /** Logger for plugin output */
+    readonly logger: PluginLogger;
+}
+/**
+ * Logger interface for plugin output.
+ */
+interface PluginLogger {
+    /** Log debug message (only in verbose mode) */
+    debug(message: string): void;
+    /** Log info message */
+    info(message: string): void;
+    /** Log warning message */
+    warn(message: string): void;
+    /** Log error message */
+    error(message: string): void;
+}
+/**
+ * Plugin interface for extending omnify with custom types.
+ *
+ * @example
+ * ```typescript
+ * const japanTypesPlugin: OmnifyPlugin = {
+ *   name: '@famgia/omnify-japan',
+ *   version: '1.0.0',
+ *   types: [
+ *     {
+ *       name: 'JapanPhone',
+ *       sql: { sqlType: 'VARCHAR', length: 15 },
+ *       typescript: { type: 'string' },
+ *     },
+ *     {
+ *       name: 'JapanAddress',
+ *       compound: true,
+ *       expand: [
+ *         { suffix: '_postal', sql: { sqlType: 'VARCHAR', length: 8 }, typescript: { type: 'string' } },
+ *         { suffix: '_prefecture', sql: { sqlType: 'VARCHAR', length: 10 }, typescript: { type: 'string' } },
+ *         { suffix: '_city', sql: { sqlType: 'VARCHAR', length: 100 }, typescript: { type: 'string' } },
+ *         { suffix: '_address', sql: { sqlType: 'VARCHAR', length: 255 }, typescript: { type: 'string' } },
+ *       ],
+ *     },
+ *   ],
+ * };
+ * ```
+ */
+interface OmnifyPlugin {
+    /** Plugin name (typically npm package name) */
+    readonly name: string;
+    /** Plugin version */
+    readonly version: string;
+    /**
+     * Custom type definitions provided by this plugin.
+     */
+    readonly types?: readonly CustomTypeDefinition[];
+    /**
+     * Optional setup function called when plugin is loaded.
+     * @param context - Plugin context with utilities
+     */
+    readonly setup?: (context: PluginContext) => void | Promise<void>;
+    /**
+     * Optional cleanup function called when plugin is unloaded.
+     */
+    readonly teardown?: () => void | Promise<void>;
+}
+/**
+ * Factory function type for creating plugins.
+ * Useful for plugins that need configuration.
+ */
+type PluginFactory<TOptions = unknown> = (options?: TOptions) => OmnifyPlugin;
+
+/**
+ * @famgia/omnify-types - Configuration Types
+ *
+ * Type definitions for omnify.config.ts configuration file.
+ */
+
+/**
+ * Supported database drivers.
+ */
+type DatabaseDriver = 'mysql' | 'pgsql' | 'postgres' | 'sqlite' | 'sqlsrv' | 'mariadb';
+/**
+ * Database configuration for Atlas and migrations.
+ */
+interface DatabaseConfig {
+    /** Database driver type */
+    readonly driver: DatabaseDriver;
+    /** Development database URL for Atlas diff operations */
+    readonly devUrl?: string;
+    /** Enable field comments in migrations (MySQL only) */
+    readonly enableFieldComments?: boolean;
+}
+/**
+ * Laravel output configuration.
+ */
+interface LaravelOutputConfig {
+    /** Directory for generated migration files */
+    readonly migrationsPath: string;
+    /** Directory for generated model files */
+    readonly modelsPath?: string;
+    /** Model namespace */
+    readonly modelsNamespace?: string;
+    /** Directory for generated factory files */
+    readonly factoriesPath?: string;
+    /** Directory for generated enum files */
+    readonly enumsPath?: string;
+    /** Enum namespace */
+    readonly enumsNamespace?: string;
+}
+/**
+ * TypeScript output configuration.
+ */
+interface TypeScriptOutputConfig {
+    /** Output file or directory for TypeScript types */
+    readonly path: string;
+    /** Whether to generate a single file or multiple files */
+    readonly singleFile?: boolean;
+    /** Whether to generate enum types */
+    readonly generateEnums?: boolean;
+    /** Whether to generate relationship types */
+    readonly generateRelationships?: boolean;
+}
+/**
+ * Combined output configuration.
+ */
+interface OutputConfig {
+    /** Laravel migration and model output */
+    readonly laravel?: LaravelOutputConfig;
+    /** TypeScript type definitions output */
+    readonly typescript?: TypeScriptOutputConfig;
+}
+/**
+ * Main omnify configuration interface.
+ * Used in omnify.config.ts files.
+ */
+interface OmnifyConfig {
+    /**
+     * Directory containing schema definition files.
+     * @default './schemas'
+     */
+    readonly schemasDir?: string;
+    /**
+     * Database configuration.
+     */
+    readonly database: DatabaseConfig;
+    /**
+     * Output configuration for generated files.
+     */
+    readonly output?: OutputConfig;
+    /**
+     * Plugins to load for custom types.
+     * Can be npm package names or plugin objects.
+     */
+    readonly plugins?: readonly (string | OmnifyPlugin)[];
+    /**
+     * Enable verbose logging.
+     * @default false
+     */
+    readonly verbose?: boolean;
+    /**
+     * Lock file path for tracking schema state.
+     * @default '.omnify.lock'
+     */
+    readonly lockFilePath?: string;
+}
+/**
+ * Resolved configuration with all defaults applied.
+ */
+interface ResolvedOmnifyConfig extends Required<Omit<OmnifyConfig, 'plugins'>> {
+    readonly plugins: readonly OmnifyPlugin[];
+}
+
+/**
+ * @famgia/omnify-types - Error Types
+ *
+ * Type definitions for omnify error handling.
+ * Errors follow the format: file:line + message + suggestion
+ */
+/**
+ * Error code categories:
+ * - E0xx: Configuration errors
+ * - E1xx: Schema parsing errors
+ * - E2xx: Schema validation errors
+ * - E3xx: Plugin errors
+ * - E4xx: Atlas/Database errors
+ * - E5xx: Generation errors
+ * - E9xx: Internal errors
+ */
+type ErrorCode = 'E001' | 'E002' | 'E003' | 'E004' | 'E005' | 'E101' | 'E102' | 'E103' | 'E104' | 'E105' | 'E201' | 'E202' | 'E203' | 'E204' | 'E205' | 'E206' | 'E207' | 'E208' | 'E301' | 'E302' | 'E303' | 'E304' | 'E305' | 'E401' | 'E402' | 'E403' | 'E404' | 'E405' | 'E501' | 'E502' | 'E503' | 'E504' | 'E901' | 'E902';
+/**
+ * Source location where an error occurred.
+ */
+interface ErrorLocation {
+    /** File path where the error occurred */
+    readonly file?: string;
+    /** Line number (1-based) */
+    readonly line?: number;
+    /** Column number (1-based) */
+    readonly column?: number;
+}
+/**
+ * Structured error information for omnify errors.
+ */
+interface OmnifyErrorInfo {
+    /** Error code (e.g., 'E201') */
+    readonly code: ErrorCode;
+    /** Human-readable error message */
+    readonly message: string;
+    /** Location where the error occurred */
+    readonly location?: ErrorLocation;
+    /** Suggested fix for the error */
+    readonly suggestion?: string;
+    /** Additional context or details */
+    readonly details?: Record<string, unknown>;
+    /** Original error if this wraps another error */
+    readonly cause?: Error;
+}
+/**
+ * Result type for operations that may fail.
+ */
+type Result<T, E = OmnifyErrorInfo> = {
+    readonly ok: true;
+    readonly value: T;
+} | {
+    readonly ok: false;
+    readonly error: E;
+};
+/**
+ * Helper to create a successful result.
+ */
+declare function ok<T>(value: T): Result<T, never>;
+/**
+ * Helper to create an error result.
+ */
+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 };

package/dist/index.d.ts

@@ -0,0 +1,511 @@
+/**
+ * @famgia/omnify-types - Schema Definition Types
+ *
+ * Core type definitions for schema objects, properties, and associations.
+ */
+/**
+ * Built-in property types supported by omnify-schema.
+ * Custom types can be added via plugins.
+ */
+type BuiltInPropertyType = 'String' | 'Int' | 'BigInt' | 'Float' | 'Boolean' | 'Text' | 'LongText' | 'Date' | 'Time' | 'Timestamp' | 'Json' | 'Email' | 'Password' | 'File' | 'MultiFile' | 'Enum' | 'Select' | 'Lookup' | 'Association' | 'Polymorphic';
+/**
+ * Property type - can be a built-in type or a custom plugin type (string).
+ */
+type PropertyType = BuiltInPropertyType | (string & {});
+/**
+ * Relationship cardinality types for associations.
+ */
+type AssociationRelation = 'OneToOne' | 'OneToMany' | 'ManyToOne' | 'ManyToMany';
+/**
+ * Referential action for foreign key constraints.
+ */
+type ReferentialAction = 'CASCADE' | 'SET NULL' | 'SET DEFAULT' | 'RESTRICT' | 'NO ACTION';
+/**
+ * Association property definition - defines a relationship to another schema.
+ */
+interface AssociationDefinition {
+    /** Display name for the association */
+    readonly displayName?: string;
+    /** Must be 'Association' for association properties */
+    readonly type: 'Association';
+    /** Relationship cardinality */
+    readonly relation: AssociationRelation;
+    /** Target schema name (e.g., 'User', 'Product') */
+    readonly target: string;
+    /** Property name on the target schema that maps back (for bidirectional) */
+    readonly inversedBy?: string;
+    /** Property name on this schema that is mapped by target (for bidirectional) */
+    readonly mappedBy?: string;
+    /** Action when referenced record is deleted */
+    readonly onDelete?: ReferentialAction;
+    /** Action when referenced record is updated */
+    readonly onUpdate?: ReferentialAction;
+    /** Whether this side owns the relationship (has the foreign key) */
+    readonly owning?: boolean;
+    /** Custom join table name for ManyToMany */
+    readonly joinTable?: string;
+}
+/**
+ * Base property definition shared by all property types.
+ */
+interface BasePropertyDefinition {
+    /** Property type (String, Int, Association, etc.) */
+    readonly type: PropertyType;
+    /** Human-readable display name */
+    readonly displayName?: string;
+    /** Whether the field can be null */
+    readonly nullable?: boolean;
+    /** Default value for the field */
+    readonly default?: unknown;
+    /** Whether this field must be unique */
+    readonly unique?: boolean;
+    /** Field description/comment */
+    readonly description?: string;
+}
+/**
+ * String property with length constraint.
+ */
+interface StringPropertyDefinition extends BasePropertyDefinition {
+    readonly type: 'String' | 'Email' | 'Password';
+    /** Maximum character length */
+    readonly length?: number;
+}
+/**
+ * Numeric property definition.
+ */
+interface NumericPropertyDefinition extends BasePropertyDefinition {
+    readonly type: 'Int' | 'BigInt' | 'Float';
+    /** Whether the number is unsigned (positive only) */
+    readonly unsigned?: boolean;
+    /** Precision for decimal types */
+    readonly precision?: number;
+    /** Scale for decimal types */
+    readonly scale?: number;
+}
+/**
+ * Enum property definition - references an enum.
+ */
+interface EnumPropertyDefinition extends BasePropertyDefinition {
+    readonly type: 'Enum';
+    /** Enum name or inline enum values */
+    readonly enum: string | readonly string[];
+}
+/**
+ * Select/Lookup property definition.
+ */
+interface SelectPropertyDefinition extends BasePropertyDefinition {
+    readonly type: 'Select' | 'Lookup';
+    /** Available options */
+    readonly options?: readonly string[];
+    /** Reference to another schema for lookup */
+    readonly source?: string;
+}
+/**
+ * Union type for all property definitions.
+ */
+type PropertyDefinition = (BasePropertyDefinition & {
+    readonly type: PropertyType;
+}) | StringPropertyDefinition | NumericPropertyDefinition | EnumPropertyDefinition | SelectPropertyDefinition | AssociationDefinition;
+/**
+ * Index definition for database optimization.
+ */
+interface IndexDefinition {
+    /** Columns to include in the index */
+    readonly columns: readonly string[];
+    /** Whether this is a unique index */
+    readonly unique?: boolean;
+    /** Custom index name */
+    readonly name?: string;
+}
+/**
+ * Schema-level options for behavior configuration.
+ */
+interface SchemaOptions {
+    /** Add created_at and updated_at timestamp columns */
+    readonly timestamps?: boolean;
+    /** Add deleted_at column for soft deletes */
+    readonly softDelete?: boolean;
+    /** Columns that should be unique (simple unique constraints) */
+    readonly unique?: readonly string[] | readonly (readonly string[])[];
+    /** Database indexes for query optimization */
+    readonly indexes?: readonly IndexDefinition[];
+    /** Enable translations support */
+    readonly translations?: boolean;
+    /** Custom table name (defaults to pluralized snake_case of schema name) */
+    readonly tableName?: string;
+    /** Primary key type */
+    readonly primaryKeyType?: 'Int' | 'BigInt' | 'Uuid' | 'String';
+    /** Enable authenticatable trait (for User-like schemas) */
+    readonly authenticatable?: boolean;
+    /** Login ID field for authenticatable */
+    readonly authenticatableLoginIdField?: string;
+    /** Password field for authenticatable */
+    readonly authenticatablePasswordField?: string;
+    /** Guard name for authenticatable */
+    readonly authenticatableGuardName?: string;
+}
+/**
+ * Schema kind - determines how the schema is processed.
+ */
+type SchemaKind = 'object' | 'enum';
+/**
+ * Complete schema definition representing a database entity.
+ */
+interface SchemaDefinition {
+    /** Schema kind (defaults to 'object') */
+    readonly kind?: SchemaKind;
+    /** Human-readable display name */
+    readonly displayName?: string;
+    /** Property to use as the title/label for records */
+    readonly titleIndex?: string;
+    /** Schema group for organization */
+    readonly group?: string;
+    /** Schema-level options */
+    readonly options?: SchemaOptions;
+    /** Property definitions */
+    readonly properties?: Readonly<Record<string, PropertyDefinition>>;
+    /** Enum values (when kind is 'enum') */
+    readonly values?: readonly string[];
+}
+/**
+ * Loaded schema with additional metadata.
+ */
+interface LoadedSchema extends SchemaDefinition {
+    /** Schema name (derived from file name) */
+    readonly name: string;
+    /** File path where the schema was loaded from */
+    readonly filePath: string;
+    /** Relative path within schemas directory */
+    readonly relativePath: string;
+}
+/**
+ * Collection of loaded schemas indexed by name.
+ */
+type SchemaCollection = Readonly<Record<string, LoadedSchema>>;
+
+/**
+ * @famgia/omnify-types - Plugin Types
+ *
+ * Type definitions for omnify plugins that provide custom types.
+ */
+
+/**
+ * SQL column definition for a custom type.
+ */
+interface SqlColumnDefinition {
+    /** SQL type (e.g., 'VARCHAR', 'INT', 'TEXT') */
+    readonly sqlType: string;
+    /** Column length/size if applicable */
+    readonly length?: number;
+    /** Precision for decimal types */
+    readonly precision?: number;
+    /** Scale for decimal types */
+    readonly scale?: number;
+    /** Whether the column is nullable */
+    readonly nullable?: boolean;
+    /** Default value */
+    readonly default?: unknown;
+}
+/**
+ * TypeScript type information for code generation.
+ */
+interface TypeScriptTypeInfo {
+    /** TypeScript type as a string (e.g., 'string', 'number', 'MyCustomType') */
+    readonly type: string;
+    /** Whether to import this type from somewhere */
+    readonly import?: {
+        readonly from: string;
+        readonly name: string;
+    };
+}
+/**
+ * Expanded field definition for compound types.
+ * Used when a single custom type expands to multiple database columns.
+ */
+interface ExpandedFieldDefinition {
+    /** Field name suffix (appended to property name) */
+    readonly suffix: string;
+    /** SQL column definition */
+    readonly sql: SqlColumnDefinition;
+    /** TypeScript type for this field */
+    readonly typescript: TypeScriptTypeInfo;
+}
+/**
+ * Definition of a custom property type provided by a plugin.
+ */
+interface CustomTypeDefinition {
+    /** Type name as used in schema files (e.g., 'JapanPhone') */
+    readonly name: string;
+    /**
+     * Description of this custom type.
+     */
+    readonly description?: string;
+    /**
+     * Whether this is a compound type that expands to multiple columns.
+     * If true, use `expand` to define the columns.
+     * If false or undefined, use `sql` and `typescript` for single column.
+     */
+    readonly compound?: boolean;
+    /**
+     * SQL column definition (for single-column types).
+     */
+    readonly sql?: SqlColumnDefinition;
+    /**
+     * TypeScript type info (for single-column types).
+     */
+    readonly typescript?: TypeScriptTypeInfo;
+    /**
+     * Expanded field definitions (for compound types).
+     * Each entry creates an additional column.
+     */
+    readonly expand?: readonly ExpandedFieldDefinition[];
+    /**
+     * Validation function for schema validation.
+     * @param value - The property definition using this type
+     * @returns Error message if invalid, undefined if valid
+     */
+    readonly validate?: (value: PropertyDefinition) => string | undefined;
+}
+/**
+ * Plugin context provided during plugin initialization.
+ */
+interface PluginContext {
+    /** Current working directory */
+    readonly cwd: string;
+    /** Whether verbose logging is enabled */
+    readonly verbose: boolean;
+    /** Logger for plugin output */
+    readonly logger: PluginLogger;
+}
+/**
+ * Logger interface for plugin output.
+ */
+interface PluginLogger {
+    /** Log debug message (only in verbose mode) */
+    debug(message: string): void;
+    /** Log info message */
+    info(message: string): void;
+    /** Log warning message */
+    warn(message: string): void;
+    /** Log error message */
+    error(message: string): void;
+}
+/**
+ * Plugin interface for extending omnify with custom types.
+ *
+ * @example
+ * ```typescript
+ * const japanTypesPlugin: OmnifyPlugin = {
+ *   name: '@famgia/omnify-japan',
+ *   version: '1.0.0',
+ *   types: [
+ *     {
+ *       name: 'JapanPhone',
+ *       sql: { sqlType: 'VARCHAR', length: 15 },
+ *       typescript: { type: 'string' },
+ *     },
+ *     {
+ *       name: 'JapanAddress',
+ *       compound: true,
+ *       expand: [
+ *         { suffix: '_postal', sql: { sqlType: 'VARCHAR', length: 8 }, typescript: { type: 'string' } },
+ *         { suffix: '_prefecture', sql: { sqlType: 'VARCHAR', length: 10 }, typescript: { type: 'string' } },
+ *         { suffix: '_city', sql: { sqlType: 'VARCHAR', length: 100 }, typescript: { type: 'string' } },
+ *         { suffix: '_address', sql: { sqlType: 'VARCHAR', length: 255 }, typescript: { type: 'string' } },
+ *       ],
+ *     },
+ *   ],
+ * };
+ * ```
+ */
+interface OmnifyPlugin {
+    /** Plugin name (typically npm package name) */
+    readonly name: string;
+    /** Plugin version */
+    readonly version: string;
+    /**
+     * Custom type definitions provided by this plugin.
+     */
+    readonly types?: readonly CustomTypeDefinition[];
+    /**
+     * Optional setup function called when plugin is loaded.
+     * @param context - Plugin context with utilities
+     */
+    readonly setup?: (context: PluginContext) => void | Promise<void>;
+    /**
+     * Optional cleanup function called when plugin is unloaded.
+     */
+    readonly teardown?: () => void | Promise<void>;
+}
+/**
+ * Factory function type for creating plugins.
+ * Useful for plugins that need configuration.
+ */
+type PluginFactory<TOptions = unknown> = (options?: TOptions) => OmnifyPlugin;
+
+/**
+ * @famgia/omnify-types - Configuration Types
+ *
+ * Type definitions for omnify.config.ts configuration file.
+ */
+
+/**
+ * Supported database drivers.
+ */
+type DatabaseDriver = 'mysql' | 'pgsql' | 'postgres' | 'sqlite' | 'sqlsrv' | 'mariadb';
+/**
+ * Database configuration for Atlas and migrations.
+ */
+interface DatabaseConfig {
+    /** Database driver type */
+    readonly driver: DatabaseDriver;
+    /** Development database URL for Atlas diff operations */
+    readonly devUrl?: string;
+    /** Enable field comments in migrations (MySQL only) */
+    readonly enableFieldComments?: boolean;
+}
+/**
+ * Laravel output configuration.
+ */
+interface LaravelOutputConfig {
+    /** Directory for generated migration files */
+    readonly migrationsPath: string;
+    /** Directory for generated model files */
+    readonly modelsPath?: string;
+    /** Model namespace */
+    readonly modelsNamespace?: string;
+    /** Directory for generated factory files */
+    readonly factoriesPath?: string;
+    /** Directory for generated enum files */
+    readonly enumsPath?: string;
+    /** Enum namespace */
+    readonly enumsNamespace?: string;
+}
+/**
+ * TypeScript output configuration.
+ */
+interface TypeScriptOutputConfig {
+    /** Output file or directory for TypeScript types */
+    readonly path: string;
+    /** Whether to generate a single file or multiple files */
+    readonly singleFile?: boolean;
+    /** Whether to generate enum types */
+    readonly generateEnums?: boolean;
+    /** Whether to generate relationship types */
+    readonly generateRelationships?: boolean;
+}
+/**
+ * Combined output configuration.
+ */
+interface OutputConfig {
+    /** Laravel migration and model output */
+    readonly laravel?: LaravelOutputConfig;
+    /** TypeScript type definitions output */
+    readonly typescript?: TypeScriptOutputConfig;
+}
+/**
+ * Main omnify configuration interface.
+ * Used in omnify.config.ts files.
+ */
+interface OmnifyConfig {
+    /**
+     * Directory containing schema definition files.
+     * @default './schemas'
+     */
+    readonly schemasDir?: string;
+    /**
+     * Database configuration.
+     */
+    readonly database: DatabaseConfig;
+    /**
+     * Output configuration for generated files.
+     */
+    readonly output?: OutputConfig;
+    /**
+     * Plugins to load for custom types.
+     * Can be npm package names or plugin objects.
+     */
+    readonly plugins?: readonly (string | OmnifyPlugin)[];
+    /**
+     * Enable verbose logging.
+     * @default false
+     */
+    readonly verbose?: boolean;
+    /**
+     * Lock file path for tracking schema state.
+     * @default '.omnify.lock'
+     */
+    readonly lockFilePath?: string;
+}
+/**
+ * Resolved configuration with all defaults applied.
+ */
+interface ResolvedOmnifyConfig extends Required<Omit<OmnifyConfig, 'plugins'>> {
+    readonly plugins: readonly OmnifyPlugin[];
+}
+
+/**
+ * @famgia/omnify-types - Error Types
+ *
+ * Type definitions for omnify error handling.
+ * Errors follow the format: file:line + message + suggestion
+ */
+/**
+ * Error code categories:
+ * - E0xx: Configuration errors
+ * - E1xx: Schema parsing errors
+ * - E2xx: Schema validation errors
+ * - E3xx: Plugin errors
+ * - E4xx: Atlas/Database errors
+ * - E5xx: Generation errors
+ * - E9xx: Internal errors
+ */
+type ErrorCode = 'E001' | 'E002' | 'E003' | 'E004' | 'E005' | 'E101' | 'E102' | 'E103' | 'E104' | 'E105' | 'E201' | 'E202' | 'E203' | 'E204' | 'E205' | 'E206' | 'E207' | 'E208' | 'E301' | 'E302' | 'E303' | 'E304' | 'E305' | 'E401' | 'E402' | 'E403' | 'E404' | 'E405' | 'E501' | 'E502' | 'E503' | 'E504' | 'E901' | 'E902';
+/**
+ * Source location where an error occurred.
+ */
+interface ErrorLocation {
+    /** File path where the error occurred */
+    readonly file?: string;
+    /** Line number (1-based) */
+    readonly line?: number;
+    /** Column number (1-based) */
+    readonly column?: number;
+}
+/**
+ * Structured error information for omnify errors.
+ */
+interface OmnifyErrorInfo {
+    /** Error code (e.g., 'E201') */
+    readonly code: ErrorCode;
+    /** Human-readable error message */
+    readonly message: string;
+    /** Location where the error occurred */
+    readonly location?: ErrorLocation;
+    /** Suggested fix for the error */
+    readonly suggestion?: string;
+    /** Additional context or details */
+    readonly details?: Record<string, unknown>;
+    /** Original error if this wraps another error */
+    readonly cause?: Error;
+}
+/**
+ * Result type for operations that may fail.
+ */
+type Result<T, E = OmnifyErrorInfo> = {
+    readonly ok: true;
+    readonly value: T;
+} | {
+    readonly ok: false;
+    readonly error: E;
+};
+/**
+ * Helper to create a successful result.
+ */
+declare function ok<T>(value: T): Result<T, never>;
+/**
+ * Helper to create an error result.
+ */
+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 };

package/dist/index.js

@@ -0,0 +1,12 @@
+// src/errors.ts
+function ok(value) {
+  return { ok: true, value };
+}
+function err(error) {
+  return { ok: false, error };
+}
+export {
+  err,
+  ok
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/errors.ts"],"sourcesContent":["/**\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":";AA4GO,SAAS,GAAM,OAA4B;AAChD,SAAO,EAAE,IAAI,MAAM,MAAM;AAC3B;AAKO,SAAS,IAAO,OAA4B;AACjD,SAAO,EAAE,IAAI,OAAO,MAAM;AAC5B;","names":[]}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@famgia/omnify-types",
+  "version": "0.0.1",
+  "description": "Shared TypeScript types for omnify-schema",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest",
+    "lint": "eslint src"
+  }
+}