pocketbase-zod-schema 0.1.2

package/dist/cli/utils/index.d.cts

@@ -0,0 +1,232 @@
+import { Ora } from 'ora';
+import { f as SchemaDiff } from '../../types-BbTgmg6H.cjs';
+import '../../permissions-ZHafVSIx.cjs';
+
+/**
+ * Configuration loader for migration tool
+ * Handles loading and merging configuration from various sources
+ */
+/**
+ * Migration tool configuration
+ */
+interface MigrationConfig {
+    schema: {
+        directory: string;
+        exclude: string[];
+    };
+    migrations: {
+        directory: string;
+        format: string;
+    };
+    diff: {
+        warnOnDelete: boolean;
+        requireForceForDestructive: boolean;
+    };
+}
+/**
+ * Partial configuration for merging
+ */
+type PartialMigrationConfig = {
+    schema?: Partial<MigrationConfig["schema"]>;
+    migrations?: Partial<MigrationConfig["migrations"]>;
+    diff?: Partial<MigrationConfig["diff"]>;
+};
+/**
+ * Loads configuration from CLI arguments
+ */
+declare function loadConfigFromArgs(options: any): PartialMigrationConfig;
+/**
+ * Loads and merges configuration from all sources
+ * Priority: CLI args > Environment variables > Config file > Defaults
+ */
+declare function loadConfig(options?: any): Promise<MigrationConfig>;
+/**
+ * Gets the absolute path to the schema directory
+ */
+declare function getSchemaDirectory(config: MigrationConfig): string;
+/**
+ * Gets the absolute path to the migrations directory
+ */
+declare function getMigrationsDirectory(config: MigrationConfig): string;
+/**
+ * Gets the default configuration
+ */
+declare function getDefaultConfig(): MigrationConfig;
+/**
+ * Creates a sample configuration file content
+ */
+declare function getSampleConfig(format: "json" | "js"): string;
+
+/**
+ * Logging utilities for CLI output
+ * Provides colored console output and formatting helpers
+ */
+
+/**
+ * Verbosity levels for logging
+ */
+type VerbosityLevel = "quiet" | "normal" | "verbose";
+/**
+ * Sets the verbosity level for logging
+ *
+ * @param level - Verbosity level to set
+ */
+declare function setVerbosity(level: VerbosityLevel): void;
+/**
+ * Gets the current verbosity level
+ *
+ * @returns Current verbosity level
+ */
+declare function getVerbosity(): VerbosityLevel;
+/**
+ * Creates a spinner for long-running operations
+ *
+ * @param text - Initial spinner text
+ * @returns Ora spinner instance
+ */
+declare function createSpinner(text: string): Ora;
+/**
+ * Logs a success message in green
+ *
+ * @param message - Message to log
+ */
+declare function logSuccess(message: string): void;
+/**
+ * Logs an error message in red
+ * Always shown regardless of verbosity level
+ *
+ * @param message - Message to log
+ */
+declare function logError(message: string): void;
+/**
+ * Logs a warning message in yellow
+ *
+ * @param message - Message to log
+ */
+declare function logWarning(message: string): void;
+/**
+ * Logs an info message in blue
+ *
+ * @param message - Message to log
+ */
+declare function logInfo(message: string): void;
+/**
+ * Logs a debug message in gray
+ * Only shown in verbose mode
+ *
+ * @param message - Message to log
+ */
+declare function logDebug(message: string): void;
+/**
+ * Logs a section header
+ *
+ * @param title - Section title
+ */
+declare function logSection(title: string): void;
+/**
+ * Formats a change summary for display
+ * Creates a formatted, colored summary of detected changes
+ *
+ * @param diff - Schema diff containing all changes
+ * @returns Formatted summary string
+ */
+declare function formatChangeSummary(diff: SchemaDiff): string;
+/**
+ * Displays a progress indicator for a long operation
+ *
+ * @param message - Progress message
+ * @param operation - Async operation to perform
+ * @returns Result of the operation
+ */
+declare function withProgress<T>(message: string, operation: () => Promise<T>): Promise<T>;
+/**
+ * Logs a step in a multi-step process
+ *
+ * @param step - Current step number
+ * @param total - Total number of steps
+ * @param message - Step description
+ */
+declare function logStep(step: number, total: number, message: string): void;
+/**
+ * Logs a list of items with bullet points
+ *
+ * @param items - Items to list
+ * @param indent - Indentation level (default: 2)
+ */
+declare function logList(items: string[], indent?: number): void;
+/**
+ * Logs a key-value pair
+ *
+ * @param key - Key name
+ * @param value - Value to display
+ * @param indent - Indentation level (default: 2)
+ */
+declare function logKeyValue(key: string, value: string, indent?: number): void;
+/**
+ * Logs a table of data
+ *
+ * @param headers - Column headers
+ * @param rows - Data rows
+ */
+declare function logTable(headers: string[], rows: string[][]): void;
+/**
+ * Logs a box with a title and content
+ *
+ * @param title - Box title
+ * @param content - Box content (array of lines)
+ */
+declare function logBox(title: string, content: string[]): void;
+/**
+ * Creates a progress bar string
+ *
+ * @param current - Current progress value
+ * @param total - Total value
+ * @param width - Bar width in characters (default: 20)
+ * @returns Formatted progress bar string
+ */
+declare function createProgressBar(current: number, total: number, width?: number): string;
+/**
+ * Logs a timestamp with a message
+ *
+ * @param message - Message to log
+ */
+declare function logTimestamp(message: string): void;
+/**
+ * Formats a duration in milliseconds to a human-readable string
+ *
+ * @param ms - Duration in milliseconds
+ * @returns Formatted duration string
+ */
+declare function formatDuration(ms: number): string;
+/**
+ * Logs a timed operation result
+ *
+ * @param message - Operation description
+ * @param startTime - Start time from Date.now()
+ */
+declare function logTimed(message: string, startTime: number): void;
+/**
+ * Status output interface for JSON output mode
+ */
+interface StatusOutput {
+    status: "up-to-date" | "changes-pending" | "first-time-setup";
+    collections: {
+        current: number;
+        snapshot: number;
+    };
+    changes: {
+        create: number;
+        delete: number;
+        modify: number;
+    };
+    destructive: boolean;
+}
+/**
+ * Formats status output as JSON
+ *
+ * @param output - Status output object
+ * @returns JSON string
+ */
+declare function formatStatusJson(output: StatusOutput): string;
+
+export { type MigrationConfig, type PartialMigrationConfig, type StatusOutput, type VerbosityLevel, createProgressBar, createSpinner, formatChangeSummary, formatDuration, formatStatusJson, getDefaultConfig, getMigrationsDirectory, getSampleConfig, getSchemaDirectory, getVerbosity, loadConfig, loadConfigFromArgs, logBox, logDebug, logError, logInfo, logKeyValue, logList, logSection, logStep, logSuccess, logTable, logTimed, logTimestamp, logWarning, setVerbosity, withProgress };

package/dist/cli/utils/index.d.ts

@@ -0,0 +1,232 @@
+import { Ora } from 'ora';
+import { f as SchemaDiff } from '../../types-z1Dkjg8m.js';
+import '../../permissions-ZHafVSIx.js';
+
+/**
+ * Configuration loader for migration tool
+ * Handles loading and merging configuration from various sources
+ */
+/**
+ * Migration tool configuration
+ */
+interface MigrationConfig {
+    schema: {
+        directory: string;
+        exclude: string[];
+    };
+    migrations: {
+        directory: string;
+        format: string;
+    };
+    diff: {
+        warnOnDelete: boolean;
+        requireForceForDestructive: boolean;
+    };
+}
+/**
+ * Partial configuration for merging
+ */
+type PartialMigrationConfig = {
+    schema?: Partial<MigrationConfig["schema"]>;
+    migrations?: Partial<MigrationConfig["migrations"]>;
+    diff?: Partial<MigrationConfig["diff"]>;
+};
+/**
+ * Loads configuration from CLI arguments
+ */
+declare function loadConfigFromArgs(options: any): PartialMigrationConfig;
+/**
+ * Loads and merges configuration from all sources
+ * Priority: CLI args > Environment variables > Config file > Defaults
+ */
+declare function loadConfig(options?: any): Promise<MigrationConfig>;
+/**
+ * Gets the absolute path to the schema directory
+ */
+declare function getSchemaDirectory(config: MigrationConfig): string;
+/**
+ * Gets the absolute path to the migrations directory
+ */
+declare function getMigrationsDirectory(config: MigrationConfig): string;
+/**
+ * Gets the default configuration
+ */
+declare function getDefaultConfig(): MigrationConfig;
+/**
+ * Creates a sample configuration file content
+ */
+declare function getSampleConfig(format: "json" | "js"): string;
+
+/**
+ * Logging utilities for CLI output
+ * Provides colored console output and formatting helpers
+ */
+
+/**
+ * Verbosity levels for logging
+ */
+type VerbosityLevel = "quiet" | "normal" | "verbose";
+/**
+ * Sets the verbosity level for logging
+ *
+ * @param level - Verbosity level to set
+ */
+declare function setVerbosity(level: VerbosityLevel): void;
+/**
+ * Gets the current verbosity level
+ *
+ * @returns Current verbosity level
+ */
+declare function getVerbosity(): VerbosityLevel;
+/**
+ * Creates a spinner for long-running operations
+ *
+ * @param text - Initial spinner text
+ * @returns Ora spinner instance
+ */
+declare function createSpinner(text: string): Ora;
+/**
+ * Logs a success message in green
+ *
+ * @param message - Message to log
+ */
+declare function logSuccess(message: string): void;
+/**
+ * Logs an error message in red
+ * Always shown regardless of verbosity level
+ *
+ * @param message - Message to log
+ */
+declare function logError(message: string): void;
+/**
+ * Logs a warning message in yellow
+ *
+ * @param message - Message to log
+ */
+declare function logWarning(message: string): void;
+/**
+ * Logs an info message in blue
+ *
+ * @param message - Message to log
+ */
+declare function logInfo(message: string): void;
+/**
+ * Logs a debug message in gray
+ * Only shown in verbose mode
+ *
+ * @param message - Message to log
+ */
+declare function logDebug(message: string): void;
+/**
+ * Logs a section header
+ *
+ * @param title - Section title
+ */
+declare function logSection(title: string): void;
+/**
+ * Formats a change summary for display
+ * Creates a formatted, colored summary of detected changes
+ *
+ * @param diff - Schema diff containing all changes
+ * @returns Formatted summary string
+ */
+declare function formatChangeSummary(diff: SchemaDiff): string;
+/**
+ * Displays a progress indicator for a long operation
+ *
+ * @param message - Progress message
+ * @param operation - Async operation to perform
+ * @returns Result of the operation
+ */
+declare function withProgress<T>(message: string, operation: () => Promise<T>): Promise<T>;
+/**
+ * Logs a step in a multi-step process
+ *
+ * @param step - Current step number
+ * @param total - Total number of steps
+ * @param message - Step description
+ */
+declare function logStep(step: number, total: number, message: string): void;
+/**
+ * Logs a list of items with bullet points
+ *
+ * @param items - Items to list
+ * @param indent - Indentation level (default: 2)
+ */
+declare function logList(items: string[], indent?: number): void;
+/**
+ * Logs a key-value pair
+ *
+ * @param key - Key name
+ * @param value - Value to display
+ * @param indent - Indentation level (default: 2)
+ */
+declare function logKeyValue(key: string, value: string, indent?: number): void;
+/**
+ * Logs a table of data
+ *
+ * @param headers - Column headers
+ * @param rows - Data rows
+ */
+declare function logTable(headers: string[], rows: string[][]): void;
+/**
+ * Logs a box with a title and content
+ *
+ * @param title - Box title
+ * @param content - Box content (array of lines)
+ */
+declare function logBox(title: string, content: string[]): void;
+/**
+ * Creates a progress bar string
+ *
+ * @param current - Current progress value
+ * @param total - Total value
+ * @param width - Bar width in characters (default: 20)
+ * @returns Formatted progress bar string
+ */
+declare function createProgressBar(current: number, total: number, width?: number): string;
+/**
+ * Logs a timestamp with a message
+ *
+ * @param message - Message to log
+ */
+declare function logTimestamp(message: string): void;
+/**
+ * Formats a duration in milliseconds to a human-readable string
+ *
+ * @param ms - Duration in milliseconds
+ * @returns Formatted duration string
+ */
+declare function formatDuration(ms: number): string;
+/**
+ * Logs a timed operation result
+ *
+ * @param message - Operation description
+ * @param startTime - Start time from Date.now()
+ */
+declare function logTimed(message: string, startTime: number): void;
+/**
+ * Status output interface for JSON output mode
+ */
+interface StatusOutput {
+    status: "up-to-date" | "changes-pending" | "first-time-setup";
+    collections: {
+        current: number;
+        snapshot: number;
+    };
+    changes: {
+        create: number;
+        delete: number;
+        modify: number;
+    };
+    destructive: boolean;
+}
+/**
+ * Formats status output as JSON
+ *
+ * @param output - Status output object
+ * @returns JSON string
+ */
+declare function formatStatusJson(output: StatusOutput): string;
+
+export { type MigrationConfig, type PartialMigrationConfig, type StatusOutput, type VerbosityLevel, createProgressBar, createSpinner, formatChangeSummary, formatDuration, formatStatusJson, getDefaultConfig, getMigrationsDirectory, getSampleConfig, getSchemaDirectory, getVerbosity, loadConfig, loadConfigFromArgs, logBox, logDebug, logError, logInfo, logKeyValue, logList, logSection, logStep, logSuccess, logTable, logTimed, logTimestamp, logWarning, setVerbosity, withProgress };