@famgia/omnify-sql 0.0.2

package/dist/plugin.d.cts

@@ -0,0 +1,68 @@
+import { OmnifyPlugin } from '@famgia/omnify-types';
+import { c as SqlDialect } from './types-DkJkHX8d.cjs';
+
+/**
+ * @famgia/omnify-sql - Plugin
+ *
+ * Plugin wrapper for SQL migration generator.
+ *
+ * @example
+ * ```typescript
+ * import { defineConfig } from '@famgia/omnify';
+ * import sql from '@famgia/omnify-sql/plugin';
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     sql({
+ *       dialect: 'postgresql',
+ *       migrationsPath: 'migrations',
+ *     }),
+ *   ],
+ * });
+ * ```
+ */
+
+/**
+ * Options for the SQL plugin.
+ */
+interface SqlPluginOptions {
+    /**
+     * SQL dialect to generate.
+     * @default 'mysql'
+     */
+    dialect?: SqlDialect;
+    /**
+     * Path for SQL migration files.
+     * @default 'migrations'
+     */
+    migrationsPath?: string;
+    /**
+     * Use IF NOT EXISTS in CREATE TABLE.
+     * @default true
+     */
+    ifNotExists?: boolean;
+    /**
+     * Include commented DROP TABLE in migrations.
+     * @default true
+     */
+    generateDown?: boolean;
+    /**
+     * Starting version number.
+     * @default 1
+     */
+    startVersion?: number;
+    /**
+     * Version number padding (e.g., 4 for 0001).
+     * @default 4
+     */
+    versionPadding?: number;
+}
+/**
+ * Creates the SQL plugin with the specified options.
+ *
+ * @param options - Plugin configuration options
+ * @returns OmnifyPlugin configured for SQL
+ */
+declare function sqlPlugin(options?: SqlPluginOptions): OmnifyPlugin;
+
+export { type SqlPluginOptions, sqlPlugin as default, sqlPlugin };

package/dist/plugin.d.ts

@@ -0,0 +1,68 @@
+import { OmnifyPlugin } from '@famgia/omnify-types';
+import { c as SqlDialect } from './types-DkJkHX8d.js';
+
+/**
+ * @famgia/omnify-sql - Plugin
+ *
+ * Plugin wrapper for SQL migration generator.
+ *
+ * @example
+ * ```typescript
+ * import { defineConfig } from '@famgia/omnify';
+ * import sql from '@famgia/omnify-sql/plugin';
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     sql({
+ *       dialect: 'postgresql',
+ *       migrationsPath: 'migrations',
+ *     }),
+ *   ],
+ * });
+ * ```
+ */
+
+/**
+ * Options for the SQL plugin.
+ */
+interface SqlPluginOptions {
+    /**
+     * SQL dialect to generate.
+     * @default 'mysql'
+     */
+    dialect?: SqlDialect;
+    /**
+     * Path for SQL migration files.
+     * @default 'migrations'
+     */
+    migrationsPath?: string;
+    /**
+     * Use IF NOT EXISTS in CREATE TABLE.
+     * @default true
+     */
+    ifNotExists?: boolean;
+    /**
+     * Include commented DROP TABLE in migrations.
+     * @default true
+     */
+    generateDown?: boolean;
+    /**
+     * Starting version number.
+     * @default 1
+     */
+    startVersion?: number;
+    /**
+     * Version number padding (e.g., 4 for 0001).
+     * @default 4
+     */
+    versionPadding?: number;
+}
+/**
+ * Creates the SQL plugin with the specified options.
+ *
+ * @param options - Plugin configuration options
+ * @returns OmnifyPlugin configured for SQL
+ */
+declare function sqlPlugin(options?: SqlPluginOptions): OmnifyPlugin;
+
+export { type SqlPluginOptions, sqlPlugin as default, sqlPlugin };

package/dist/plugin.js

@@ -0,0 +1,55 @@
+import {
+  generateMigrations,
+  getMigrationPath
+} from "./chunk-V7HEGSN4.js";
+
+// src/plugin.ts
+function resolveOptions(options) {
+  return {
+    dialect: options?.dialect ?? "mysql",
+    migrationsPath: options?.migrationsPath ?? "migrations",
+    ifNotExists: options?.ifNotExists ?? true,
+    generateDown: options?.generateDown ?? true,
+    startVersion: options?.startVersion ?? 1,
+    versionPadding: options?.versionPadding ?? 4
+  };
+}
+function sqlPlugin(options) {
+  const resolved = resolveOptions(options);
+  return {
+    name: "@famgia/omnify-sql",
+    version: "0.0.1",
+    generators: [
+      {
+        name: "sql-migrations",
+        description: `Generate ${resolved.dialect.toUpperCase()} SQL migration files`,
+        generate: async (ctx) => {
+          const generatorOptions = {
+            dialect: resolved.dialect,
+            ifNotExists: resolved.ifNotExists,
+            generateDown: resolved.generateDown,
+            startVersion: resolved.startVersion,
+            versionPadding: resolved.versionPadding
+          };
+          const migrations = generateMigrations(ctx.schemas, generatorOptions);
+          return migrations.map((migration) => ({
+            path: getMigrationPath(migration, resolved.migrationsPath),
+            content: migration.content,
+            type: "migration",
+            metadata: {
+              version: migration.version,
+              tables: migration.tables,
+              migrationType: migration.type,
+              dialect: resolved.dialect
+            }
+          }));
+        }
+      }
+    ]
+  };
+}
+export {
+  sqlPlugin as default,
+  sqlPlugin
+};
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["/**\n * @famgia/omnify-sql - Plugin\n *\n * Plugin wrapper for SQL migration generator.\n *\n * @example\n * ```typescript\n * import { defineConfig } from '@famgia/omnify';\n * import sql from '@famgia/omnify-sql/plugin';\n *\n * export default defineConfig({\n *   plugins: [\n *     sql({\n *       dialect: 'postgresql',\n *       migrationsPath: 'migrations',\n *     }),\n *   ],\n * });\n * ```\n */\n\nimport type { OmnifyPlugin, GeneratorOutput, GeneratorContext } from '@famgia/omnify-types';\nimport type { SqlDialect, SqlGeneratorOptions } from './types.js';\nimport { generateMigrations, getMigrationPath } from './migration/index.js';\n\n/**\n * Options for the SQL plugin.\n */\nexport interface SqlPluginOptions {\n  /**\n   * SQL dialect to generate.\n   * @default 'mysql'\n   */\n  dialect?: SqlDialect;\n\n  /**\n   * Path for SQL migration files.\n   * @default 'migrations'\n   */\n  migrationsPath?: string;\n\n  /**\n   * Use IF NOT EXISTS in CREATE TABLE.\n   * @default true\n   */\n  ifNotExists?: boolean;\n\n  /**\n   * Include commented DROP TABLE in migrations.\n   * @default true\n   */\n  generateDown?: boolean;\n\n  /**\n   * Starting version number.\n   * @default 1\n   */\n  startVersion?: number;\n\n  /**\n   * Version number padding (e.g., 4 for 0001).\n   * @default 4\n   */\n  versionPadding?: number;\n}\n\n/**\n * Resolved options with defaults.\n */\ninterface ResolvedPluginOptions {\n  dialect: SqlDialect;\n  migrationsPath: string;\n  ifNotExists: boolean;\n  generateDown: boolean;\n  startVersion: number;\n  versionPadding: number;\n}\n\n/**\n * Resolves options with defaults.\n */\nfunction resolveOptions(options?: SqlPluginOptions): ResolvedPluginOptions {\n  return {\n    dialect: options?.dialect ?? 'mysql',\n    migrationsPath: options?.migrationsPath ?? 'migrations',\n    ifNotExists: options?.ifNotExists ?? true,\n    generateDown: options?.generateDown ?? true,\n    startVersion: options?.startVersion ?? 1,\n    versionPadding: options?.versionPadding ?? 4,\n  };\n}\n\n/**\n * Creates the SQL plugin with the specified options.\n *\n * @param options - Plugin configuration options\n * @returns OmnifyPlugin configured for SQL\n */\nexport default function sqlPlugin(options?: SqlPluginOptions): OmnifyPlugin {\n  const resolved = resolveOptions(options);\n\n  return {\n    name: '@famgia/omnify-sql',\n    version: '0.0.1',\n\n    generators: [\n      {\n        name: 'sql-migrations',\n        description: `Generate ${resolved.dialect.toUpperCase()} SQL migration files`,\n\n        generate: async (ctx: GeneratorContext): Promise<GeneratorOutput[]> => {\n          const generatorOptions: SqlGeneratorOptions = {\n            dialect: resolved.dialect,\n            ifNotExists: resolved.ifNotExists,\n            generateDown: resolved.generateDown,\n            startVersion: resolved.startVersion,\n            versionPadding: resolved.versionPadding,\n          };\n\n          const migrations = generateMigrations(ctx.schemas, generatorOptions);\n\n          return migrations.map((migration) => ({\n            path: getMigrationPath(migration, resolved.migrationsPath),\n            content: migration.content,\n            type: 'migration' as const,\n            metadata: {\n              version: migration.version,\n              tables: migration.tables,\n              migrationType: migration.type,\n              dialect: resolved.dialect,\n            },\n          }));\n        },\n      },\n    ],\n  };\n}\n\n// Named export for flexibility\nexport { sqlPlugin };\n"],"mappings":";;;;;;AAiFA,SAAS,eAAe,SAAmD;AACzE,SAAO;AAAA,IACL,SAAS,SAAS,WAAW;AAAA,IAC7B,gBAAgB,SAAS,kBAAkB;AAAA,IAC3C,aAAa,SAAS,eAAe;AAAA,IACrC,cAAc,SAAS,gBAAgB;AAAA,IACvC,cAAc,SAAS,gBAAgB;AAAA,IACvC,gBAAgB,SAAS,kBAAkB;AAAA,EAC7C;AACF;AAQe,SAAR,UAA2B,SAA0C;AAC1E,QAAM,WAAW,eAAe,OAAO;AAEvC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,SAAS;AAAA,IAET,YAAY;AAAA,MACV;AAAA,QACE,MAAM;AAAA,QACN,aAAa,YAAY,SAAS,QAAQ,YAAY,CAAC;AAAA,QAEvD,UAAU,OAAO,QAAsD;AACrE,gBAAM,mBAAwC;AAAA,YAC5C,SAAS,SAAS;AAAA,YAClB,aAAa,SAAS;AAAA,YACtB,cAAc,SAAS;AAAA,YACvB,cAAc,SAAS;AAAA,YACvB,gBAAgB,SAAS;AAAA,UAC3B;AAEA,gBAAM,aAAa,mBAAmB,IAAI,SAAS,gBAAgB;AAEnE,iBAAO,WAAW,IAAI,CAAC,eAAe;AAAA,YACpC,MAAM,iBAAiB,WAAW,SAAS,cAAc;AAAA,YACzD,SAAS,UAAU;AAAA,YACnB,MAAM;AAAA,YACN,UAAU;AAAA,cACR,SAAS,UAAU;AAAA,cACnB,QAAQ,UAAU;AAAA,cAClB,eAAe,UAAU;AAAA,cACzB,SAAS,SAAS;AAAA,YACpB;AAAA,UACF,EAAE;AAAA,QACJ;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;","names":[]}

package/dist/types-DkJkHX8d.d.cts

@@ -0,0 +1,127 @@
+/**
+ * @famgia/omnify-sql - Types
+ *
+ * Type definitions for SQL migration generator.
+ */
+/**
+ * Supported SQL dialects.
+ */
+type SqlDialect = 'mysql' | 'postgresql' | 'sqlite';
+/**
+ * SQL migration file.
+ */
+interface SqlMigration {
+    /** Migration version number (e.g., 1, 2, 3) */
+    readonly version: number;
+    /** Migration name (e.g., 'create_users') */
+    readonly name: string;
+    /** Full file name (e.g., '0001_create_users.sql') */
+    readonly fileName: string;
+    /** SQL content */
+    readonly content: string;
+    /** Tables affected */
+    readonly tables: readonly string[];
+    /** Migration type */
+    readonly type: 'create' | 'alter' | 'drop' | 'pivot';
+}
+/**
+ * SQL column definition.
+ */
+interface SqlColumn {
+    /** Column name */
+    readonly name: string;
+    /** SQL type (e.g., 'VARCHAR(255)', 'BIGINT') */
+    readonly type: string;
+    /** Is nullable */
+    readonly nullable: boolean;
+    /** Default value */
+    readonly defaultValue?: string | undefined;
+    /** Is primary key */
+    readonly primaryKey: boolean;
+    /** Is auto increment */
+    readonly autoIncrement: boolean;
+    /** Is unique */
+    readonly unique: boolean;
+    /** Is unsigned (MySQL) */
+    readonly unsigned: boolean;
+    /** Column comment */
+    readonly comment?: string | undefined;
+}
+/**
+ * SQL foreign key definition.
+ */
+interface SqlForeignKey {
+    /** Constraint name */
+    readonly name: string;
+    /** Local column(s) */
+    readonly columns: readonly string[];
+    /** Referenced table */
+    readonly referencesTable: string;
+    /** Referenced column(s) */
+    readonly referencesColumns: readonly string[];
+    /** ON DELETE action */
+    readonly onDelete: string;
+    /** ON UPDATE action */
+    readonly onUpdate: string;
+}
+/**
+ * SQL index type.
+ */
+type SqlIndexType = 'btree' | 'hash' | 'fulltext' | 'spatial' | 'gin' | 'gist';
+/**
+ * SQL index definition.
+ */
+interface SqlIndex {
+    /** Index name */
+    readonly name: string;
+    /** Columns in the index */
+    readonly columns: readonly string[];
+    /** Is unique index */
+    readonly unique: boolean;
+    /** Index type (fulltext, spatial, etc.) */
+    readonly type?: SqlIndexType | undefined;
+}
+/**
+ * SQL table definition.
+ */
+interface SqlTable {
+    /** Table name */
+    readonly name: string;
+    /** Columns */
+    readonly columns: readonly SqlColumn[];
+    /** Foreign keys */
+    readonly foreignKeys: readonly SqlForeignKey[];
+    /** Indexes */
+    readonly indexes: readonly SqlIndex[];
+    /** Table comment */
+    readonly comment?: string | undefined;
+}
+/**
+ * Options for SQL generation.
+ */
+interface SqlGeneratorOptions {
+    /** SQL dialect */
+    readonly dialect?: SqlDialect;
+    /** Use IF NOT EXISTS for CREATE TABLE */
+    readonly ifNotExists?: boolean;
+    /** Add DROP TABLE statements in down migration */
+    readonly generateDown?: boolean;
+    /** Starting version number */
+    readonly startVersion?: number;
+    /** Version number padding (e.g., 4 for 0001) */
+    readonly versionPadding?: number;
+    /** Custom timestamp for file names */
+    readonly timestamp?: string;
+}
+/**
+ * Resolved options with defaults.
+ */
+interface ResolvedSqlOptions {
+    readonly dialect: SqlDialect;
+    readonly ifNotExists: boolean;
+    readonly generateDown: boolean;
+    readonly startVersion: number;
+    readonly versionPadding: number;
+}
+
+export type { ResolvedSqlOptions as R, SqlGeneratorOptions as S, SqlMigration as a, SqlTable as b, SqlDialect as c, SqlColumn as d, SqlForeignKey as e, SqlIndex as f, SqlIndexType as g };

package/dist/types-DkJkHX8d.d.ts

@@ -0,0 +1,127 @@
+/**
+ * @famgia/omnify-sql - Types
+ *
+ * Type definitions for SQL migration generator.
+ */
+/**
+ * Supported SQL dialects.
+ */
+type SqlDialect = 'mysql' | 'postgresql' | 'sqlite';
+/**
+ * SQL migration file.
+ */
+interface SqlMigration {
+    /** Migration version number (e.g., 1, 2, 3) */
+    readonly version: number;
+    /** Migration name (e.g., 'create_users') */
+    readonly name: string;
+    /** Full file name (e.g., '0001_create_users.sql') */
+    readonly fileName: string;
+    /** SQL content */
+    readonly content: string;
+    /** Tables affected */
+    readonly tables: readonly string[];
+    /** Migration type */
+    readonly type: 'create' | 'alter' | 'drop' | 'pivot';
+}
+/**
+ * SQL column definition.
+ */
+interface SqlColumn {
+    /** Column name */
+    readonly name: string;
+    /** SQL type (e.g., 'VARCHAR(255)', 'BIGINT') */
+    readonly type: string;
+    /** Is nullable */
+    readonly nullable: boolean;
+    /** Default value */
+    readonly defaultValue?: string | undefined;
+    /** Is primary key */
+    readonly primaryKey: boolean;
+    /** Is auto increment */
+    readonly autoIncrement: boolean;
+    /** Is unique */
+    readonly unique: boolean;
+    /** Is unsigned (MySQL) */
+    readonly unsigned: boolean;
+    /** Column comment */
+    readonly comment?: string | undefined;
+}
+/**
+ * SQL foreign key definition.
+ */
+interface SqlForeignKey {
+    /** Constraint name */
+    readonly name: string;
+    /** Local column(s) */
+    readonly columns: readonly string[];
+    /** Referenced table */
+    readonly referencesTable: string;
+    /** Referenced column(s) */
+    readonly referencesColumns: readonly string[];
+    /** ON DELETE action */
+    readonly onDelete: string;
+    /** ON UPDATE action */
+    readonly onUpdate: string;
+}
+/**
+ * SQL index type.
+ */
+type SqlIndexType = 'btree' | 'hash' | 'fulltext' | 'spatial' | 'gin' | 'gist';
+/**
+ * SQL index definition.
+ */
+interface SqlIndex {
+    /** Index name */
+    readonly name: string;
+    /** Columns in the index */
+    readonly columns: readonly string[];
+    /** Is unique index */
+    readonly unique: boolean;
+    /** Index type (fulltext, spatial, etc.) */
+    readonly type?: SqlIndexType | undefined;
+}
+/**
+ * SQL table definition.
+ */
+interface SqlTable {
+    /** Table name */
+    readonly name: string;
+    /** Columns */
+    readonly columns: readonly SqlColumn[];
+    /** Foreign keys */
+    readonly foreignKeys: readonly SqlForeignKey[];
+    /** Indexes */
+    readonly indexes: readonly SqlIndex[];
+    /** Table comment */
+    readonly comment?: string | undefined;
+}
+/**
+ * Options for SQL generation.
+ */
+interface SqlGeneratorOptions {
+    /** SQL dialect */
+    readonly dialect?: SqlDialect;
+    /** Use IF NOT EXISTS for CREATE TABLE */
+    readonly ifNotExists?: boolean;
+    /** Add DROP TABLE statements in down migration */
+    readonly generateDown?: boolean;
+    /** Starting version number */
+    readonly startVersion?: number;
+    /** Version number padding (e.g., 4 for 0001) */
+    readonly versionPadding?: number;
+    /** Custom timestamp for file names */
+    readonly timestamp?: string;
+}
+/**
+ * Resolved options with defaults.
+ */
+interface ResolvedSqlOptions {
+    readonly dialect: SqlDialect;
+    readonly ifNotExists: boolean;
+    readonly generateDown: boolean;
+    readonly startVersion: number;
+    readonly versionPadding: number;
+}
+
+export type { ResolvedSqlOptions as R, SqlGeneratorOptions as S, SqlMigration as a, SqlTable as b, SqlDialect as c, SqlColumn as d, SqlForeignKey as e, SqlIndex as f, SqlIndexType as g };

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@famgia/omnify-sql",
+  "version": "0.0.2",
+  "description": "Raw SQL migration generator for Omnify Schema",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./plugin": {
+      "import": {
+        "types": "./dist/plugin.d.ts",
+        "default": "./dist/plugin.js"
+      },
+      "require": {
+        "types": "./dist/plugin.d.cts",
+        "default": "./dist/plugin.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@famgia/omnify-types": "0.0.8"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.8.3",
+    "vitest": "^1.6.1",
+    "@famgia/omnify-core": "0.0.8"
+  },
+  "peerDependencies": {
+    "@famgia/omnify-core": ">=0.0.7"
+  },
+  "keywords": [
+    "omnify",
+    "sql",
+    "migrations",
+    "database",
+    "schema"
+  ],
+  "author": "Famgia",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/famgia/omnify-ts.git",
+    "directory": "packages/sql-generator"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run --passWithNoTests",
+    "clean": "rm -rf dist"
+  }
+}