@famgia/omnify-cli 2.0.10 → 2.0.12

package/dist/index.d.cts

@@ -423,4 +423,83 @@ declare class Logger {
  */
 declare const logger: Logger;
 
-export { type AdditionalSchemaPath, type DatabaseConfig, type DatabaseDriver, type LaravelOutputConfig, type OmnifyConfig, type OutputConfig, type PackageLaravelOutputConfig, type PackageOutputConfig, type ResolvedOmnifyConfig, type TypeScriptOutputConfig, defineConfig, loadConfig, logger, registerDiffCommand, registerGenerateCommand, registerInitCommand, registerValidateCommand, runInit };
+/**
+ * @famgia/omnify-cli - Version Lock
+ *
+ * Manages version locking for omnify plugins to ensure compatibility.
+ * When running `omnify generate`, checks if installed plugin versions
+ * meet the minimum requirements from the lock file.
+ */
+
+/**
+ * Version lock file name.
+ */
+declare const VERSION_LOCK_FILE = ".omnify-versions.lock";
+/**
+ * Plugin version entry in the lock file.
+ */
+interface PluginVersionEntry {
+    /** Plugin name (e.g., '@famgia/omnify-laravel') */
+    name: string;
+    /** Locked version (minimum required) */
+    version: string;
+    /** Last updated timestamp */
+    updatedAt: string;
+}
+/**
+ * Version lock file structure.
+ */
+interface VersionLockFile {
+    /** Lock file format version */
+    version: 1;
+    /** CLI version used to create/update this lock */
+    cliVersion: string;
+    /** Plugin versions */
+    plugins: PluginVersionEntry[];
+    /** When the lock was last updated */
+    updatedAt: string;
+}
+/**
+ * Result of version check.
+ */
+interface VersionCheckResult {
+    /** Whether all versions pass */
+    valid: boolean;
+    /** List of plugins with version mismatches */
+    mismatches: VersionMismatch[];
+    /** List of plugins not in lock file (new plugins) */
+    newPlugins: string[];
+}
+/**
+ * Version mismatch information.
+ */
+interface VersionMismatch {
+    /** Plugin name */
+    name: string;
+    /** Required version (from lock file) */
+    required: string;
+    /** Installed version */
+    installed: string;
+}
+/**
+ * Reads the version lock file.
+ */
+declare function readVersionLock(rootDir: string): VersionLockFile | null;
+/**
+ * Writes the version lock file.
+ */
+declare function writeVersionLock(rootDir: string, lock: VersionLockFile): void;
+/**
+ * Checks if installed plugin versions meet the lock file requirements.
+ */
+declare function checkPluginVersions(plugins: readonly OmnifyPlugin[], lockFile: VersionLockFile): VersionCheckResult;
+/**
+ * Creates or updates the version lock file with current plugin versions.
+ */
+declare function updateVersionLock(rootDir: string, plugins: readonly OmnifyPlugin[], cliVersion: string): VersionLockFile;
+/**
+ * Gets the CLI version from package.json.
+ */
+declare function getCliVersion(): string;
+
+export { type AdditionalSchemaPath, type DatabaseConfig, type DatabaseDriver, type LaravelOutputConfig, type OmnifyConfig, type OutputConfig, type PackageLaravelOutputConfig, type PackageOutputConfig, type PluginVersionEntry, type ResolvedOmnifyConfig, type TypeScriptOutputConfig, VERSION_LOCK_FILE, type VersionCheckResult, type VersionLockFile, type VersionMismatch, checkPluginVersions, defineConfig, getCliVersion, loadConfig, logger, readVersionLock, registerDiffCommand, registerGenerateCommand, registerInitCommand, registerValidateCommand, runInit, updateVersionLock, writeVersionLock };

package/dist/index.d.ts

@@ -423,4 +423,83 @@ declare class Logger {
  */
 declare const logger: Logger;
 
-export { type AdditionalSchemaPath, type DatabaseConfig, type DatabaseDriver, type LaravelOutputConfig, type OmnifyConfig, type OutputConfig, type PackageLaravelOutputConfig, type PackageOutputConfig, type ResolvedOmnifyConfig, type TypeScriptOutputConfig, defineConfig, loadConfig, logger, registerDiffCommand, registerGenerateCommand, registerInitCommand, registerValidateCommand, runInit };
+/**
+ * @famgia/omnify-cli - Version Lock
+ *
+ * Manages version locking for omnify plugins to ensure compatibility.
+ * When running `omnify generate`, checks if installed plugin versions
+ * meet the minimum requirements from the lock file.
+ */
+
+/**
+ * Version lock file name.
+ */
+declare const VERSION_LOCK_FILE = ".omnify-versions.lock";
+/**
+ * Plugin version entry in the lock file.
+ */
+interface PluginVersionEntry {
+    /** Plugin name (e.g., '@famgia/omnify-laravel') */
+    name: string;
+    /** Locked version (minimum required) */
+    version: string;
+    /** Last updated timestamp */
+    updatedAt: string;
+}
+/**
+ * Version lock file structure.
+ */
+interface VersionLockFile {
+    /** Lock file format version */
+    version: 1;
+    /** CLI version used to create/update this lock */
+    cliVersion: string;
+    /** Plugin versions */
+    plugins: PluginVersionEntry[];
+    /** When the lock was last updated */
+    updatedAt: string;
+}
+/**
+ * Result of version check.
+ */
+interface VersionCheckResult {
+    /** Whether all versions pass */
+    valid: boolean;
+    /** List of plugins with version mismatches */
+    mismatches: VersionMismatch[];
+    /** List of plugins not in lock file (new plugins) */
+    newPlugins: string[];
+}
+/**
+ * Version mismatch information.
+ */
+interface VersionMismatch {
+    /** Plugin name */
+    name: string;
+    /** Required version (from lock file) */
+    required: string;
+    /** Installed version */
+    installed: string;
+}
+/**
+ * Reads the version lock file.
+ */
+declare function readVersionLock(rootDir: string): VersionLockFile | null;
+/**
+ * Writes the version lock file.
+ */
+declare function writeVersionLock(rootDir: string, lock: VersionLockFile): void;
+/**
+ * Checks if installed plugin versions meet the lock file requirements.
+ */
+declare function checkPluginVersions(plugins: readonly OmnifyPlugin[], lockFile: VersionLockFile): VersionCheckResult;
+/**
+ * Creates or updates the version lock file with current plugin versions.
+ */
+declare function updateVersionLock(rootDir: string, plugins: readonly OmnifyPlugin[], cliVersion: string): VersionLockFile;
+/**
+ * Gets the CLI version from package.json.
+ */
+declare function getCliVersion(): string;
+
+export { type AdditionalSchemaPath, type DatabaseConfig, type DatabaseDriver, type LaravelOutputConfig, type OmnifyConfig, type OutputConfig, type PackageLaravelOutputConfig, type PackageOutputConfig, type PluginVersionEntry, type ResolvedOmnifyConfig, type TypeScriptOutputConfig, VERSION_LOCK_FILE, type VersionCheckResult, type VersionLockFile, type VersionMismatch, checkPluginVersions, defineConfig, getCliVersion, loadConfig, logger, readVersionLock, registerDiffCommand, registerGenerateCommand, registerInitCommand, registerValidateCommand, runInit, updateVersionLock, writeVersionLock };