@famgia/omnify-laravel 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,402 @@
+import { PropertyDefinition, SchemaCollection, LoadedSchema } from '@famgia/omnify-types';
+
+/**
+ * @famgia/omnify-laravel - Migration Types
+ *
+ * Types for Laravel migration generation.
+ */
+/**
+ * Laravel migration file structure.
+ */
+interface MigrationFile {
+    /** File name with timestamp prefix */
+    readonly fileName: string;
+    /** Migration class name */
+    readonly className: string;
+    /** Full file content */
+    readonly content: string;
+    /** Tables affected */
+    readonly tables: readonly string[];
+    /** Whether this is a create or alter migration */
+    readonly type: 'create' | 'alter' | 'drop';
+}
+/**
+ * Migration generation options.
+ */
+interface MigrationOptions {
+    /** Output directory for migrations */
+    readonly outputDir?: string | undefined;
+    /** Timestamp prefix (defaults to current time) */
+    readonly timestamp?: string | undefined;
+    /** Whether to generate down migration */
+    readonly generateDown?: boolean | undefined;
+    /** Database connection name */
+    readonly connection?: string | undefined;
+}
+/**
+ * Schema Builder column method.
+ */
+interface ColumnMethod {
+    /** Column name */
+    readonly name: string;
+    /** Method name (e.g., 'string', 'integer', 'boolean') */
+    readonly method: string;
+    /** Method arguments */
+    readonly args: readonly (string | number | boolean)[];
+    /** Chained modifiers (e.g., nullable(), unique(), default()) */
+    readonly modifiers: readonly ColumnModifier[];
+}
+/**
+ * Column modifier (chained method).
+ */
+interface ColumnModifier {
+    /** Modifier method name */
+    readonly method: string;
+    /** Modifier arguments */
+    readonly args?: readonly (string | number | boolean)[] | undefined;
+}
+/**
+ * Foreign key definition for Schema Builder.
+ */
+interface ForeignKeyDefinition {
+    /** Local column(s) */
+    readonly columns: readonly string[];
+    /** Referenced table */
+    readonly references: string;
+    /** Referenced column(s) */
+    readonly on: readonly string[];
+    /** ON DELETE action */
+    readonly onDelete?: string | undefined;
+    /** ON UPDATE action */
+    readonly onUpdate?: string | undefined;
+}
+/**
+ * Index definition for Schema Builder.
+ */
+interface IndexDefinition {
+    /** Index name */
+    readonly name?: string | undefined;
+    /** Columns in the index */
+    readonly columns: readonly string[];
+    /** Whether this is a unique index */
+    readonly unique: boolean;
+}
+/**
+ * Table blueprint for Schema Builder.
+ */
+interface TableBlueprint {
+    /** Table name */
+    readonly tableName: string;
+    /** Column definitions */
+    readonly columns: readonly ColumnMethod[];
+    /** Primary key column(s) */
+    readonly primaryKey?: readonly string[] | undefined;
+    /** Foreign key constraints */
+    readonly foreignKeys: readonly ForeignKeyDefinition[];
+    /** Index definitions */
+    readonly indexes: readonly IndexDefinition[];
+}
+/**
+ * Migration operation (up or down).
+ */
+interface MigrationOperation {
+    /** Operation type */
+    readonly type: 'create' | 'table' | 'drop' | 'dropIfExists';
+    /** Table name */
+    readonly tableName: string;
+    /** Blueprint (for create/table operations) */
+    readonly blueprint?: TableBlueprint | undefined;
+}
+/**
+ * Complete migration definition.
+ */
+interface MigrationDefinition {
+    /** Migration class name */
+    readonly className: string;
+    /** UP operations */
+    readonly up: readonly MigrationOperation[];
+    /** DOWN operations */
+    readonly down: readonly MigrationOperation[];
+    /** Database connection */
+    readonly connection?: string | undefined;
+}
+
+/**
+ * @famgia/omnify-laravel - Schema Builder Converter
+ *
+ * Converts SQL types and operations to Laravel Schema Builder methods.
+ */
+
+/**
+ * Converts a property name to snake_case column name.
+ */
+declare function toColumnName(propertyName: string): string;
+/**
+ * Converts schema name to snake_case plural table name.
+ */
+declare function toTableName(schemaName: string): string;
+/**
+ * Converts a property to Laravel column method.
+ */
+declare function propertyToColumnMethod(propertyName: string, property: PropertyDefinition): ColumnMethod | null;
+/**
+ * Generates primary key column method.
+ */
+declare function generatePrimaryKeyColumn(pkType?: 'Int' | 'BigInt' | 'Uuid' | 'String'): ColumnMethod;
+/**
+ * Generates timestamp columns.
+ */
+declare function generateTimestampColumns(): ColumnMethod[];
+/**
+ * Generates soft delete column.
+ */
+declare function generateSoftDeleteColumn(): ColumnMethod;
+/**
+ * Generates foreign key column and constraint from association.
+ */
+declare function generateForeignKey(propertyName: string, property: PropertyDefinition, allSchemas: SchemaCollection): {
+    column: ColumnMethod;
+    foreignKey: ForeignKeyDefinition;
+    index: IndexDefinition;
+} | null;
+/**
+ * Generates table blueprint from schema.
+ */
+declare function schemaToBlueprint(schema: LoadedSchema, allSchemas: SchemaCollection): TableBlueprint;
+/**
+ * Formats a column method to PHP code.
+ */
+declare function formatColumnMethod(column: ColumnMethod): string;
+/**
+ * Formats a foreign key to PHP code.
+ */
+declare function formatForeignKey(fk: ForeignKeyDefinition): string;
+/**
+ * Formats an index to PHP code.
+ */
+declare function formatIndex(index: IndexDefinition): string;
+
+/**
+ * @famgia/omnify-laravel - Migration Generator
+ *
+ * Generates Laravel migration files from schemas.
+ */
+
+/**
+ * Generates migrations for all schemas.
+ */
+declare function generateMigrations(schemas: SchemaCollection, options?: MigrationOptions): MigrationFile[];
+/**
+ * Generates migration from a single schema.
+ */
+declare function generateMigrationFromSchema(schema: LoadedSchema, allSchemas: SchemaCollection, options?: MigrationOptions): MigrationFile;
+/**
+ * Generates drop migration for a table.
+ */
+declare function generateDropMigrationForTable(tableName: string, options?: MigrationOptions): MigrationFile;
+/**
+ * Formats migration content for writing to file.
+ */
+declare function formatMigrationFile(migration: MigrationFile): string;
+/**
+ * Gets the output path for a migration file.
+ */
+declare function getMigrationPath(migration: MigrationFile, outputDir?: string): string;
+
+/**
+ * @famgia/omnify-laravel - TypeScript Types
+ *
+ * Types for TypeScript code generation.
+ */
+/**
+ * Generated TypeScript file.
+ */
+interface TypeScriptFile {
+    /** File name */
+    readonly fileName: string;
+    /** Full file content */
+    readonly content: string;
+    /** Types defined in this file */
+    readonly types: readonly string[];
+}
+/**
+ * TypeScript generation options.
+ */
+interface TypeScriptOptions {
+    /** Output directory for TypeScript files */
+    readonly outputDir?: string | undefined;
+    /** Whether to generate a single file or multiple files */
+    readonly singleFile?: boolean | undefined;
+    /** File name for single file output */
+    readonly fileName?: string | undefined;
+    /** Whether to export as default */
+    readonly exportDefault?: boolean | undefined;
+    /** Whether to include readonly modifiers */
+    readonly readonly?: boolean | undefined;
+    /** Whether to use strict null checks compatible types */
+    readonly strictNullChecks?: boolean | undefined;
+}
+/**
+ * TypeScript property definition.
+ */
+interface TSProperty {
+    /** Property name */
+    readonly name: string;
+    /** TypeScript type */
+    readonly type: string;
+    /** Whether the property is optional */
+    readonly optional: boolean;
+    /** Whether the property is readonly */
+    readonly readonly: boolean;
+    /** JSDoc comment */
+    readonly comment?: string | undefined;
+}
+/**
+ * TypeScript interface definition.
+ */
+interface TSInterface {
+    /** Interface name */
+    readonly name: string;
+    /** Properties */
+    readonly properties: readonly TSProperty[];
+    /** Extended interfaces */
+    readonly extends?: readonly string[] | undefined;
+    /** JSDoc comment */
+    readonly comment?: string | undefined;
+}
+/**
+ * TypeScript enum definition.
+ */
+interface TSEnum {
+    /** Enum name */
+    readonly name: string;
+    /** Enum values */
+    readonly values: readonly TSEnumValue[];
+    /** JSDoc comment */
+    readonly comment?: string | undefined;
+}
+/**
+ * TypeScript enum value.
+ */
+interface TSEnumValue {
+    /** Value name */
+    readonly name: string;
+    /** Value (string or number) */
+    readonly value: string | number;
+}
+/**
+ * TypeScript type alias definition.
+ */
+interface TSTypeAlias {
+    /** Type name */
+    readonly name: string;
+    /** Type definition */
+    readonly type: string;
+    /** JSDoc comment */
+    readonly comment?: string | undefined;
+}
+
+/**
+ * @famgia/omnify-laravel - TypeScript Interface Generator
+ *
+ * Generates TypeScript interfaces from schemas.
+ */
+
+/**
+ * Converts property name to TypeScript property name.
+ * Preserves camelCase.
+ */
+declare function toPropertyName(name: string): string;
+/**
+ * Converts schema name to TypeScript interface name.
+ * Preserves PascalCase.
+ */
+declare function toInterfaceName(schemaName: string): string;
+/**
+ * Gets TypeScript type for a property.
+ */
+declare function getPropertyType(property: PropertyDefinition, _allSchemas: SchemaCollection): string;
+/**
+ * Converts a property to TypeScript property definition.
+ */
+declare function propertyToTSProperty(propertyName: string, property: PropertyDefinition, allSchemas: SchemaCollection, options?: TypeScriptOptions): TSProperty;
+/**
+ * Generates TypeScript interface from schema.
+ */
+declare function schemaToInterface(schema: LoadedSchema, allSchemas: SchemaCollection, options?: TypeScriptOptions): TSInterface;
+/**
+ * Formats a TypeScript property.
+ */
+declare function formatProperty(property: TSProperty): string;
+/**
+ * Formats a TypeScript interface.
+ */
+declare function formatInterface(iface: TSInterface): string;
+/**
+ * Generates interfaces for all schemas.
+ */
+declare function generateInterfaces(schemas: SchemaCollection, options?: TypeScriptOptions): TSInterface[];
+
+/**
+ * @famgia/omnify-laravel - TypeScript Enum Generator
+ *
+ * Generates TypeScript enums from schema enum definitions.
+ */
+
+/**
+ * Converts enum value to valid TypeScript enum member name.
+ */
+declare function toEnumMemberName(value: string): string;
+/**
+ * Converts schema name to TypeScript enum name.
+ */
+declare function toEnumName(schemaName: string): string;
+/**
+ * Generates TypeScript enum from schema enum.
+ */
+declare function schemaToEnum(schema: LoadedSchema): TSEnum | null;
+/**
+ * Generates enums for all enum schemas.
+ */
+declare function generateEnums(schemas: SchemaCollection): TSEnum[];
+/**
+ * Formats a TypeScript enum.
+ */
+declare function formatEnum(enumDef: TSEnum): string;
+/**
+ * Generates a union type alias as an alternative to enum.
+ */
+declare function enumToUnionType(enumDef: TSEnum): TSTypeAlias;
+/**
+ * Formats a TypeScript type alias.
+ */
+declare function formatTypeAlias(alias: TSTypeAlias): string;
+/**
+ * Extracts inline enums from properties for type generation.
+ */
+declare function extractInlineEnums(schemas: SchemaCollection): TSTypeAlias[];
+
+/**
+ * @famgia/omnify-laravel - TypeScript Generator
+ *
+ * Main TypeScript code generator combining interfaces, enums, and types.
+ */
+
+/**
+ * Generates all TypeScript code as a single file.
+ */
+declare function generateTypeScriptFile(schemas: SchemaCollection, options?: TypeScriptOptions): TypeScriptFile;
+/**
+ * Generates TypeScript code as multiple files.
+ */
+declare function generateTypeScriptFiles(schemas: SchemaCollection, options?: TypeScriptOptions): TypeScriptFile[];
+/**
+ * Generates TypeScript types with configurable output.
+ */
+declare function generateTypeScript(schemas: SchemaCollection, options?: TypeScriptOptions): TypeScriptFile[];
+/**
+ * Gets output path for a TypeScript file.
+ */
+declare function getTypeScriptPath(file: TypeScriptFile, outputDir?: string): string;
+
+export { type ColumnMethod, type ColumnModifier, type ForeignKeyDefinition, type IndexDefinition, type MigrationDefinition, type MigrationFile, type MigrationOperation, type MigrationOptions, type TSEnum, type TSEnumValue, type TSInterface, type TSProperty, type TSTypeAlias, type TableBlueprint, type TypeScriptFile, type TypeScriptOptions, enumToUnionType, extractInlineEnums, formatColumnMethod, formatEnum, formatForeignKey, formatIndex, formatInterface, formatMigrationFile, formatProperty, formatTypeAlias, generateDropMigrationForTable, generateEnums, generateForeignKey, generateInterfaces, generateMigrationFromSchema, generateMigrations, generatePrimaryKeyColumn, generateSoftDeleteColumn, generateTimestampColumns, generateTypeScript, generateTypeScriptFile, generateTypeScriptFiles, getMigrationPath, getPropertyType, getTypeScriptPath, propertyToColumnMethod, propertyToTSProperty, schemaToBlueprint, schemaToEnum, schemaToInterface, toColumnName, toEnumMemberName, toEnumName, toInterfaceName, toPropertyName, toTableName };