@ceschiatti/redistail 0.0.2 → 0.0.3

package/src/cli/types.ts

@@ -0,0 +1,302 @@
+/**
+ * Core data types and error definitions for the redistail CLI utility.
+ *
+ * This module defines immutable data structures using Effect Data types
+ * and error types using Data.TaggedError for type-safe error handling.
+ */
+
+import { Data } from 'effect';
+
+// ============================================================================
+// CLI Configuration Types
+// ============================================================================
+
+/**
+ * CLI configuration parsed from command line arguments
+ */
+export interface CLIConfig {
+  readonly connectionType: 'pubsub' | 'stream';
+  readonly topicName: string;
+  readonly help?: boolean;
+  readonly version?: boolean;
+}
+
+/**
+ * Complete redistail configuration including Redis connection and display settings
+ */
+export interface RedistailConfig {
+  readonly redis: {
+    readonly host: string;
+    readonly port: number;
+    readonly url?: string;
+    readonly timeout: number;
+    readonly retryAttempts: number;
+    readonly retryDelay: number;
+  };
+  readonly display: {
+    readonly colors: boolean;
+    readonly timestamps: boolean;
+    readonly prettyJson: boolean;
+  };
+  readonly monitoring: {
+    readonly blockTimeout: number;
+    readonly maxReconnectAttempts: number;
+  };
+}
+
+// Data constructors for immutable data structures
+export const CLIConfig = Data.struct<CLIConfig>;
+export const RedistailConfig = Data.struct<RedistailConfig>;
+
+// ============================================================================
+// Message Types
+// ============================================================================
+
+/**
+ * Pub/Sub message data structure
+ */
+export interface PubSubMessage {
+  readonly timestamp: Date;
+  readonly channel: string;
+  readonly content: string;
+}
+
+/**
+ * Redis Stream message data structure
+ */
+export interface StreamMessage {
+  readonly timestamp: Date;
+  readonly streamKey: string;
+  readonly entryId: string;
+  readonly fields: Record<string, string>;
+}
+
+// Data constructors for message types
+export const PubSubMessage = Data.struct<PubSubMessage>;
+export const StreamMessage = Data.struct<StreamMessage>;
+
+// ============================================================================
+// Error Types using Data.TaggedError
+// ============================================================================
+
+/**
+ * CLI-specific errors for argument parsing and validation
+ */
+export class CLIError extends Data.TaggedError('CLIError')<{
+  readonly reason: 'InvalidArguments' | 'MissingArguments' | 'UnknownCommand';
+  readonly message: string;
+  readonly context?: string;
+}> {}
+
+/**
+ * Configuration errors for environment variables and Redis connection
+ */
+export class ConfigError extends Data.TaggedError('ConfigError')<{
+  readonly reason:
+    | 'InvalidEnvironment'
+    | 'ConnectionFailed'
+    | 'ValidationFailed';
+  readonly message: string;
+  readonly cause?: unknown;
+  readonly context?: string;
+}> {}
+
+/**
+ * Runtime monitoring errors for subscription and connection issues
+ */
+export class MonitoringError extends Data.TaggedError('MonitoringError')<{
+  readonly reason: 'ConnectionLost' | 'SubscriptionFailed' | 'StreamReadFailed';
+  readonly message: string;
+  readonly retryable: boolean;
+  readonly cause?: unknown;
+}> {}
+
+/**
+ * Union type for all redistail-specific errors
+ */
+export type RedistailError = CLIError | ConfigError | MonitoringError;
+
+// ============================================================================
+// Stream Monitor Options
+// ============================================================================
+
+/**
+ * Options for Redis Stream monitoring
+ */
+export interface StreamMonitorOptions {
+  readonly startId?: string;
+  readonly blockTimeout?: number;
+  readonly count?: number;
+}
+
+export const StreamMonitorOptions = Data.struct<StreamMonitorOptions>;
+
+// ============================================================================
+// Type Guards and Utilities
+// ============================================================================
+
+/**
+ * Type guard to check if a connection type is valid
+ */
+export const isValidConnectionType = (
+  type: string,
+): type is 'pubsub' | 'stream' => type === 'pubsub' || type === 'stream';
+
+/**
+ * Type guard to check if a topic name is valid (non-empty after trimming)
+ */
+export const isValidTopicName = (name: string): boolean =>
+  typeof name === 'string' && name.trim().length > 0;
+
+/**
+ * Helper to create CLIError for invalid arguments
+ */
+export const createInvalidArgumentError = (
+  message: string,
+  context?: string,
+): CLIError =>
+  new CLIError({
+    reason: 'InvalidArguments',
+    message,
+    context,
+  });
+
+/**
+ * Helper to create CLIError for missing arguments
+ */
+export const createMissingArgumentError = (
+  message: string,
+  context?: string,
+): CLIError =>
+  new CLIError({
+    reason: 'MissingArguments',
+    message,
+    context,
+  });
+
+/**
+ * Helper to create ConfigError for environment issues
+ */
+export const createEnvironmentError = (
+  message: string,
+  cause?: unknown,
+  context?: string,
+): ConfigError =>
+  new ConfigError({
+    reason: 'InvalidEnvironment',
+    message,
+    cause,
+    context,
+  });
+
+/**
+ * Helper to create ConfigError for connection failures
+ */
+export const createConnectionError = (
+  message: string,
+  cause?: unknown,
+  context?: string,
+): ConfigError =>
+  new ConfigError({
+    reason: 'ConnectionFailed',
+    message,
+    cause,
+    context,
+  });
+
+/**
+ * Helper to create MonitoringError for connection loss
+ */
+export const createConnectionLostError = (
+  message: string,
+  cause?: unknown,
+): MonitoringError =>
+  new MonitoringError({
+    reason: 'ConnectionLost',
+    message,
+    retryable: true,
+    cause,
+  });
+
+/**
+ * Helper to create MonitoringError for subscription failures
+ */
+export const createSubscriptionFailedError = (
+  message: string,
+  retryable = true,
+  cause?: unknown,
+): MonitoringError =>
+  new MonitoringError({
+    reason: 'SubscriptionFailed',
+    message,
+    retryable,
+    cause,
+  });
+
+/**
+ * Helper to create MonitoringError for stream read failures
+ */
+export const createStreamReadFailedError = (
+  message: string,
+  retryable = true,
+  cause?: unknown,
+): MonitoringError =>
+  new MonitoringError({
+    reason: 'StreamReadFailed',
+    message,
+    retryable,
+    cause,
+  });
+
+// ============================================================================
+// Default Configuration Values
+// ============================================================================
+
+/**
+ * Default Redis configuration values for CLI
+ */
+export const DEFAULT_CLI_REDIS_CONFIG = {
+  host: '127.0.0.1',
+  port: 6379,
+  timeout: 5000,
+  retryAttempts: 3,
+  retryDelay: 1000,
+} as const;
+
+/**
+ * Default display configuration values
+ */
+export const DEFAULT_DISPLAY_CONFIG = {
+  colors: true,
+  timestamps: true,
+  prettyJson: true,
+} as const;
+
+/**
+ * Default monitoring configuration values
+ */
+export const DEFAULT_MONITORING_CONFIG = {
+  blockTimeout: 5000,
+  maxReconnectAttempts: 5,
+} as const;
+
+/**
+ * Helper to create a default RedistailConfig with overrides
+ */
+export const createDefaultRedistailConfig = (
+  overrides?: Partial<RedistailConfig>,
+): RedistailConfig =>
+  RedistailConfig({
+    redis: {
+      ...DEFAULT_CLI_REDIS_CONFIG,
+      ...overrides?.redis,
+    },
+    display: {
+      ...DEFAULT_DISPLAY_CONFIG,
+      ...overrides?.display,
+    },
+    monitoring: {
+      ...DEFAULT_MONITORING_CONFIG,
+      ...overrides?.monitoring,
+    },
+  });

package/src/cli/version-generated.ts

@@ -0,0 +1,27 @@
+/**
+ * Build version information
+ *
+ * This file is a template that gets replaced during the build process
+ * DO NOT EDIT MANUALLY
+ */
+
+// These values are replaced at build time by build-cli.js
+export const BUILD_COMMIT: string = '72aad04';
+export const BUILD_VERSION: string = '0.0.3';
+
+/**
+ * Get formatted version information for display
+ */
+export const getVersionInfo = () => ({
+  version: BUILD_VERSION,
+  commit: BUILD_COMMIT,
+  isDev: BUILD_VERSION === '__BUILD_VERSION__',
+});
+
+/**
+ * Format version information as a string
+ */
+export const formatVersion = () => {
+  const info = getVersionInfo();
+  return `${info.version}${info.isDev ? ' (dev)' : ` (${info.commit})`}`;
+};

package/src/cli/version.ts

@@ -0,0 +1,27 @@
+/**
+ * Build version information
+ *
+ * This file is a template that gets replaced during the build process
+ * DO NOT EDIT MANUALLY
+ */
+
+// These values are replaced at build time by build-cli.js
+export const BUILD_COMMIT: string = '__BUILD_COMMIT__';
+export const BUILD_VERSION: string = '__BUILD_VERSION__';
+
+/**
+ * Get formatted version information for display
+ */
+export const getVersionInfo = () => ({
+  version: BUILD_VERSION,
+  commit: BUILD_COMMIT,
+  isDev: BUILD_VERSION === '__BUILD_VERSION__',
+});
+
+/**
+ * Format version information as a string
+ */
+export const formatVersion = () => {
+  const info = getVersionInfo();
+  return `${info.version}${info.isDev ? ' (dev)' : ` (${info.commit})`}`;
+};