@revealui/core 0.0.1-pre.4 → 0.2.1

package/dist/utils/errors.js

@@ -0,0 +1,397 @@
+/**
+ * Error Handling Utilities
+ *
+ * Standardized error handling for RevealUI framework.
+ */
+import { logger } from './logger.js';
+/**
+ * Application Error
+ * Use for business logic failures, validation failures, expected errors
+ */
+export class ApplicationError extends Error {
+    code;
+    statusCode;
+    context;
+    constructor(message, code, statusCode = 500, context) {
+        super(message);
+        this.code = code;
+        this.statusCode = statusCode;
+        this.context = context;
+        this.name = 'ApplicationError';
+        Error.captureStackTrace(this, ApplicationError);
+    }
+}
+/**
+ * Validation Error
+ * Use for input validation failures, schema validation failures
+ */
+export class ValidationError extends Error {
+    field;
+    value;
+    context;
+    constructor(message, field, value, context) {
+        super(message);
+        this.field = field;
+        this.value = value;
+        this.context = context;
+        this.name = 'ValidationError';
+        Error.captureStackTrace(this, ValidationError);
+    }
+}
+/**
+ * Database Error
+ * Use for database operation failures with Postgres error code parsing
+ */
+export class DatabaseError extends Error {
+    code;
+    statusCode;
+    pgCode;
+    constraint;
+    table;
+    column;
+    context;
+    constructor(message, code, statusCode = 500, pgCode, constraint, table, column, context) {
+        super(message);
+        this.code = code;
+        this.statusCode = statusCode;
+        this.pgCode = pgCode;
+        this.constraint = constraint;
+        this.table = table;
+        this.column = column;
+        this.context = context;
+        this.name = 'DatabaseError';
+        Error.captureStackTrace(this, DatabaseError);
+    }
+}
+/**
+ * Postgres Error Codes
+ * Reference: https://www.postgresql.org/docs/current/errcodes-appendix.html
+ */
+export const PostgresErrorCode = {
+    // Class 23 - Integrity Constraint Violation
+    UNIQUE_VIOLATION: '23505',
+    FOREIGN_KEY_VIOLATION: '23503',
+    NOT_NULL_VIOLATION: '23502',
+    CHECK_VIOLATION: '23514',
+    // Class 42 - Syntax Error or Access Rule Violation
+    UNDEFINED_TABLE: '42P01',
+    UNDEFINED_COLUMN: '42703',
+    DUPLICATE_TABLE: '42P07',
+    DUPLICATE_COLUMN: '42701',
+    // Class 40 - Transaction Rollback
+    DEADLOCK_DETECTED: '40P01',
+    SERIALIZATION_FAILURE: '40001',
+    // Class 57 - Operator Intervention
+    QUERY_CANCELED: '57014',
+    ADMIN_SHUTDOWN: '57P01',
+    // Class 53 - Insufficient Resources
+    DISK_FULL: '53100',
+    OUT_OF_MEMORY: '53200',
+    TOO_MANY_CONNECTIONS: '53300',
+    // Class 08 - Connection Exception
+    CONNECTION_EXCEPTION: '08000',
+    CONNECTION_FAILURE: '08006',
+    CONNECTION_DOES_NOT_EXIST: '08003',
+    // Class 25 - Invalid Transaction State
+    INVALID_TRANSACTION_STATE: '25000',
+    ACTIVE_SQL_TRANSACTION: '25001',
+};
+/**
+ * Extract Postgres error information from an error object
+ */
+function parsePostgresError(error) {
+    // Handle Postgres/pg library errors
+    if (error && typeof error === 'object' && 'code' in error && typeof error.code === 'string') {
+        const pgError = error;
+        return {
+            pgCode: pgError.code,
+            constraint: pgError.constraint,
+            table: pgError.table,
+            column: pgError.column,
+            detail: pgError.detail,
+        };
+    }
+    return {};
+}
+/**
+ * Handle and log error in API routes
+ *
+ * @param error - The error to handle
+ * @param context - Additional context to log
+ * @returns User-friendly error message
+ */
+export function handleApiError(error, context) {
+    if (error instanceof DatabaseError) {
+        logger.error('Database error in API', {
+            message: error.message,
+            code: error.code,
+            statusCode: error.statusCode,
+            pgCode: error.pgCode,
+            constraint: error.constraint,
+            table: error.table,
+            column: error.column,
+            ...error.context,
+            ...context,
+        });
+        return {
+            message: error.message,
+            statusCode: error.statusCode,
+            code: error.code,
+            retryable: error.context?.retryable,
+        };
+    }
+    if (error instanceof ApplicationError) {
+        logger.error('Application error', {
+            message: error.message,
+            code: error.code,
+            statusCode: error.statusCode,
+            ...error.context,
+            ...context,
+        });
+        return {
+            message: error.message,
+            statusCode: error.statusCode,
+            code: error.code,
+        };
+    }
+    if (error instanceof ValidationError) {
+        logger.warn('Validation error', {
+            message: error.message,
+            field: error.field,
+            ...error.context,
+            ...context,
+        });
+        return {
+            message: error.message,
+            statusCode: 400,
+            code: 'VALIDATION_ERROR',
+        };
+    }
+    // Unknown error - log with full details, return generic message
+    const err = error instanceof Error ? error : new Error(String(error));
+    // Always use logger - it's always available from the same package
+    logger.error('Unexpected error', { error: err.message, stack: err.stack });
+    return {
+        message: 'An error occurred',
+        statusCode: 500,
+    };
+}
+/**
+ * Handle database errors with Postgres error code parsing
+ *
+ * @param error - Database error
+ * @param operation - Operation being performed (e.g., 'insert user', 'update order')
+ * @param context - Additional context (e.g., { userId: '123', table: 'users' })
+ * @returns Never - always throws a DatabaseError
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await db.insert(users).values({ email: 'existing@example.com' })
+ * } catch (error) {
+ *   handleDatabaseError(error, 'insert user', { email: 'existing@example.com' })
+ * }
+ * ```
+ */
+export function handleDatabaseError(error, operation, context) {
+    const pgError = parsePostgresError(error);
+    const errorMessage = error instanceof Error ? error.message : String(error);
+    // Parse Postgres error codes for specific error types
+    if (pgError.pgCode) {
+        switch (pgError.pgCode) {
+            // Unique constraint violation
+            case PostgresErrorCode.UNIQUE_VIOLATION: {
+                const field = pgError.constraint?.replace(/_/g, ' ') || 'field';
+                const message = `Duplicate ${field}: this value already exists`;
+                logger.warn('Unique constraint violation', {
+                    operation,
+                    constraint: pgError.constraint,
+                    table: pgError.table,
+                    detail: pgError.detail,
+                    ...context,
+                });
+                throw new DatabaseError(message, 'UNIQUE_VIOLATION', 409, pgError.pgCode, pgError.constraint, pgError.table, pgError.column, {
+                    operation,
+                    detail: pgError.detail,
+                    ...context,
+                });
+            }
+            // Foreign key constraint violation
+            case PostgresErrorCode.FOREIGN_KEY_VIOLATION: {
+                const constraint = pgError.constraint?.replace(/_/g, ' ') || 'reference';
+                const message = `Invalid ${constraint}: referenced record does not exist`;
+                logger.warn('Foreign key violation', {
+                    operation,
+                    constraint: pgError.constraint,
+                    table: pgError.table,
+                    detail: pgError.detail,
+                    ...context,
+                });
+                throw new DatabaseError(message, 'FOREIGN_KEY_VIOLATION', 400, pgError.pgCode, pgError.constraint, pgError.table, pgError.column, {
+                    operation,
+                    detail: pgError.detail,
+                    ...context,
+                });
+            }
+            // Not null constraint violation
+            case PostgresErrorCode.NOT_NULL_VIOLATION: {
+                const field = pgError.column || 'field';
+                const message = `Missing required field: ${field} cannot be null`;
+                logger.warn('Not null violation', {
+                    operation,
+                    column: pgError.column,
+                    table: pgError.table,
+                    ...context,
+                });
+                throw new DatabaseError(message, 'NOT_NULL_VIOLATION', 400, pgError.pgCode, pgError.constraint, pgError.table, pgError.column, {
+                    operation,
+                    ...context,
+                });
+            }
+            // Check constraint violation
+            case PostgresErrorCode.CHECK_VIOLATION: {
+                const constraint = pgError.constraint?.replace(/_/g, ' ') || 'constraint';
+                const message = `Validation failed: ${constraint} check constraint violated`;
+                logger.warn('Check constraint violation', {
+                    operation,
+                    constraint: pgError.constraint,
+                    table: pgError.table,
+                    detail: pgError.detail,
+                    ...context,
+                });
+                throw new DatabaseError(message, 'CHECK_VIOLATION', 400, pgError.pgCode, pgError.constraint, pgError.table, pgError.column, {
+                    operation,
+                    detail: pgError.detail,
+                    ...context,
+                });
+            }
+            // Deadlock detected
+            case PostgresErrorCode.DEADLOCK_DETECTED: {
+                const message = 'Database deadlock detected - please retry the operation';
+                logger.error('Deadlock detected', {
+                    operation,
+                    table: pgError.table,
+                    ...context,
+                });
+                throw new DatabaseError(message, 'DEADLOCK_DETECTED', 409, pgError.pgCode, pgError.constraint, pgError.table, pgError.column, {
+                    operation,
+                    retryable: true,
+                    ...context,
+                });
+            }
+            // Serialization failure (concurrent update conflict)
+            case PostgresErrorCode.SERIALIZATION_FAILURE: {
+                const message = 'Concurrent update conflict - please retry the operation';
+                logger.warn('Serialization failure', {
+                    operation,
+                    ...context,
+                });
+                throw new DatabaseError(message, 'SERIALIZATION_FAILURE', 409, pgError.pgCode, pgError.constraint, pgError.table, pgError.column, {
+                    operation,
+                    retryable: true,
+                    ...context,
+                });
+            }
+            // Query canceled (timeout)
+            case PostgresErrorCode.QUERY_CANCELED: {
+                const message = 'Database query timeout - operation took too long';
+                logger.error('Query timeout', {
+                    operation,
+                    ...context,
+                });
+                throw new DatabaseError(message, 'QUERY_TIMEOUT', 504, pgError.pgCode, pgError.constraint, pgError.table, pgError.column, {
+                    operation,
+                    ...context,
+                });
+            }
+            // Connection errors
+            case PostgresErrorCode.CONNECTION_EXCEPTION:
+            case PostgresErrorCode.CONNECTION_FAILURE:
+            case PostgresErrorCode.CONNECTION_DOES_NOT_EXIST: {
+                const message = 'Database connection error - please try again';
+                logger.error('Database connection error', {
+                    operation,
+                    pgCode: pgError.pgCode,
+                    ...context,
+                });
+                throw new DatabaseError(message, 'CONNECTION_ERROR', 503, pgError.pgCode, pgError.constraint, pgError.table, pgError.column, {
+                    operation,
+                    retryable: true,
+                    ...context,
+                });
+            }
+            // Resource errors
+            case PostgresErrorCode.DISK_FULL:
+            case PostgresErrorCode.OUT_OF_MEMORY:
+            case PostgresErrorCode.TOO_MANY_CONNECTIONS: {
+                const message = 'Database resource limit reached - please try again later';
+                logger.error('Database resource error', {
+                    operation,
+                    pgCode: pgError.pgCode,
+                    ...context,
+                });
+                throw new DatabaseError(message, 'RESOURCE_ERROR', 503, pgError.pgCode, pgError.constraint, pgError.table, pgError.column, {
+                    operation,
+                    retryable: true,
+                    ...context,
+                });
+            }
+            // Undefined table/column
+            case PostgresErrorCode.UNDEFINED_TABLE:
+            case PostgresErrorCode.UNDEFINED_COLUMN: {
+                const message = 'Database schema error - table or column does not exist';
+                logger.error('Schema error', {
+                    operation,
+                    pgCode: pgError.pgCode,
+                    table: pgError.table,
+                    column: pgError.column,
+                    ...context,
+                });
+                throw new DatabaseError(message, 'SCHEMA_ERROR', 500, pgError.pgCode, pgError.constraint, pgError.table, pgError.column, {
+                    operation,
+                    ...context,
+                });
+            }
+        }
+    }
+    // Fallback: Check error message for common patterns (if no pgCode)
+    if (error instanceof Error) {
+        if (errorMessage.includes('unique') || errorMessage.includes('duplicate')) {
+            logger.warn('Unique violation (message-based)', {
+                operation,
+                message: errorMessage,
+                ...context,
+            });
+            throw new DatabaseError('Resource already exists', 'UNIQUE_VIOLATION', 409, undefined, undefined, undefined, undefined, { operation, ...context });
+        }
+        if (errorMessage.includes('foreign key') ||
+            errorMessage.includes('violates foreign key constraint')) {
+            logger.warn('Foreign key violation (message-based)', {
+                operation,
+                message: errorMessage,
+                ...context,
+            });
+            throw new DatabaseError('Invalid reference', 'FOREIGN_KEY_VIOLATION', 400, undefined, undefined, undefined, undefined, { operation, ...context });
+        }
+        if (errorMessage.includes('not found') || errorMessage.includes('does not exist')) {
+            logger.warn('Not found (message-based)', { operation, message: errorMessage, ...context });
+            throw new DatabaseError('Resource not found', 'NOT_FOUND', 404, undefined, undefined, undefined, undefined, { operation, ...context });
+        }
+    }
+    // Unknown database error - log with full details
+    logger.error('Unexpected database error', {
+        operation,
+        error: errorMessage,
+        pgCode: pgError.pgCode,
+        constraint: pgError.constraint,
+        table: pgError.table,
+        column: pgError.column,
+        detail: pgError.detail,
+        ...context,
+    });
+    throw new DatabaseError('Database operation failed', 'DATABASE_ERROR', 500, pgError.pgCode, pgError.constraint, pgError.table, pgError.column, {
+        operation,
+        originalError: errorMessage,
+        ...context,
+    });
+}

package/dist/utils/field-conversion.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Field Conversion Utilities
+ *
+ * Converts between standard Field types and RevealUIField types.
+ *
+ * NOTE ON TYPE ASSERTIONS:
+ * The type assertions in this file are necessary due to TypeScript's limitation
+ * with narrowing separate variables. Here's why:
+ *
+ * 1. `baseField` is initialized as `RevealUIField` (a union type) or `Field` (a union type)
+ * 2. TypeScript can narrow `field` or `revealUIField` in conditionals/switches
+ * 3. However, TypeScript CANNOT narrow `baseField` because it's a separate variable
+ *    that was explicitly typed, not derived from the narrowed value
+ *
+ * The assertions (`as RevealUITextField`, etc.) are used to tell TypeScript that
+ * after type narrowing checks, we're assigning type-specific properties that exist
+ * on the narrowed type but not on the base union type.
+ *
+ * Alternative approaches considered:
+ * - Returning different object literals per type: Would work but duplicates code
+ * - Using type predicates on baseField: Not possible without runtime checks
+ * - Restructuring to avoid mutations: Would require significant refactoring
+ *
+ * These assertions are safe because they're guarded by runtime type checks
+ * (isTextField, isArrayField, switch on field.type).
+ */
+import type { Field, RevealUIField } from '../types/index.js';
+export declare function convertToRevealUIField(field: Field): RevealUIField;
+export declare function convertFromRevealUIField(revealUIField: RevealUIField): Field;
+export declare function enhanceFieldWithRevealUI(field: Field, revealUIOptions?: RevealUIField['revealUI']): RevealUIField;
+interface RevealUIValidationContext {
+    data: Record<string, unknown>;
+    siblingData: Record<string, unknown>;
+    user?: unknown;
+    operation: 'create' | 'update';
+    tenant?: string;
+}
+export declare function validateRevealUIField(field: RevealUIField, value: unknown, context: RevealUIValidationContext): string | true;
+export {};
+//# sourceMappingURL=field-conversion.d.ts.map

package/dist/utils/field-conversion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-conversion.d.ts","sourceRoot":"","sources":["../../src/utils/field-conversion.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAIH,OAAO,KAAK,EAGV,KAAK,EACL,aAAa,EAGd,MAAM,mBAAmB,CAAA;AAoB1B,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,KAAK,GAAG,aAAa,CA6ElE;AAGD,wBAAgB,wBAAwB,CAAC,aAAa,EAAE,aAAa,GAAG,KAAK,CAqE5E;AAGD,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,KAAK,EACZ,eAAe,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,GAC1C,aAAa,CAWf;AAGD,UAAU,yBAAyB;IACjC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,SAAS,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAGD,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,aAAa,EACpB,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,yBAAyB,GACjC,MAAM,GAAG,IAAI,CAqFf"}