@revealui/core 0.0.1-pre.3 → 0.2.0

package/dist/utils/access-conversion.js

@@ -0,0 +1,96 @@
+// Create a RevealUI access rule
+export function createRevealUIAccessRule(options) {
+    return {
+        tenant: options.tenant,
+        user: options.user,
+        permissions: options.permissions,
+        condition: options.condition,
+    };
+}
+// Convert from a simple permission-based rule to RevealUI access rule
+export function convertToRevealUIAccessRule(permissions) {
+    return createRevealUIAccessRule({
+        permissions,
+        condition: (context) => {
+            // Check if user has required permissions
+            if (!context.user)
+                return false;
+            const userPermissions = context.user.revealUI?.isSuperAdmin
+                ? ['create', 'read', 'update', 'delete', 'publish', 'admin']
+                : context.user.roles || [];
+            return permissions.every((permission) => userPermissions.includes(permission) || userPermissions.includes('admin'));
+        },
+    });
+}
+// Create an enhanced access rule with tenant scoping
+export function createEnhancedAccessRule(options) {
+    return createRevealUIAccessRule({
+        permissions: options.permissions,
+        condition: (context) => {
+            // Check super admin override
+            if (options.allowSuperAdmin !== false && context.user?.revealUI?.isSuperAdmin) {
+                return true;
+            }
+            // Check custom condition first
+            if (options.customCondition) {
+                const customResult = options.customCondition(context);
+                if (customResult !== true) {
+                    return customResult;
+                }
+            }
+            // Check tenant scoping
+            if (options.tenantScoped && context.tenant) {
+                const userTenants = context.user?.tenants || [];
+                if (!userTenants.includes(context.tenant.id)) {
+                    return false;
+                }
+            }
+            // Check permissions
+            if (!context.user)
+                return false;
+            const userPermissions = context.user.roles || [];
+            return options.permissions.every((permission) => userPermissions.includes(permission) || userPermissions.includes('admin'));
+        },
+    });
+}
+// Evaluate an access rule against a context
+export function evaluateRevealUIAccessRule(rule, context) {
+    // Check tenant constraint
+    if (rule.tenant && context.tenant?.id !== rule.tenant) {
+        return false;
+    }
+    // Check user constraint
+    if (rule.user && context.user?.id !== rule.user) {
+        return false;
+    }
+    // Check permissions
+    if (rule.permissions && rule.permissions.length > 0) {
+        if (!context.user)
+            return false;
+        const userPermissions = context.user.revealUI?.isSuperAdmin
+            ? ['create', 'read', 'update', 'delete', 'publish', 'admin']
+            : context.user.roles || [];
+        const hasPermission = rule.permissions.every((permission) => userPermissions.includes(permission) || userPermissions.includes('admin'));
+        if (!hasPermission) {
+            return false;
+        }
+    }
+    // Check custom condition
+    if (rule.condition) {
+        return rule.condition(context);
+    }
+    return true;
+}
+// Combine multiple access rules with OR logic
+export function combineRevealUIAccessRules(rules, operator = 'OR') {
+    return createRevealUIAccessRule({
+        condition: (context) => {
+            if (operator === 'OR') {
+                return rules.some((rule) => evaluateRevealUIAccessRule(rule, context) === true);
+            }
+            else {
+                return rules.every((rule) => evaluateRevealUIAccessRule(rule, context) === true);
+            }
+        },
+    });
+}

package/dist/utils/api-wrapper.d.ts

@@ -0,0 +1,63 @@
+/**
+ * API Route Wrapper
+ *
+ * Wraps Next.js API routes to automatically set up request context,
+ * error handling, and logging.
+ */
+import type { NextRequest } from 'next/server';
+import { NextResponse } from 'next/server';
+/**
+ * API route handler function
+ */
+export type ApiHandler<T = unknown> = (request: NextRequest) => Promise<Response | NextResponse<T>>;
+/**
+ * Wrap an API route handler with request context, logging, and error handling
+ *
+ * Benefits:
+ * - Automatic request ID generation and propagation
+ * - Request context available via getRequestContext()
+ * - Automatic error handling with proper status codes
+ * - Request/response logging with timing
+ * - All logs include request ID automatically
+ *
+ * @param handler - API route handler function
+ * @returns Wrapped handler with request context
+ *
+ * @example
+ * ```typescript
+ * // app/api/users/route.ts
+ * import { withRequestContext } from '@revealui/core/utils/api-wrapper'
+ * import { NextResponse } from 'next/server'
+ *
+ * export const GET = withRequestContext(async (request) => {
+ *   // Request ID automatically available in logs
+ *   logger.info('Fetching users') // Includes requestId automatically
+ *
+ *   const users = await db.query.users.findMany()
+ *   return NextResponse.json(users)
+ * })
+ * ```
+ */
+export declare function withRequestContext<T = unknown>(handler: ApiHandler<T>): ApiHandler<T>;
+/**
+ * Server action wrapper for request context
+ *
+ * Use this for Next.js Server Actions to enable request tracing
+ *
+ * @param action - Server action function
+ * @returns Wrapped action with request context
+ *
+ * @example
+ * ```typescript
+ * 'use server'
+ *
+ * import { withServerActionContext } from '@revealui/core/utils/api-wrapper'
+ *
+ * export const createUser = withServerActionContext(async (data) => {
+ *   logger.info('Creating user') // Includes requestId
+ *   return await db.insert(users).values(data)
+ * })
+ * ```
+ */
+export declare function withServerActionContext<TArgs extends unknown[], TReturn>(action: (...args: TArgs) => Promise<TReturn>): (...args: TArgs) => Promise<TReturn>;
+//# sourceMappingURL=api-wrapper.d.ts.map

package/dist/utils/api-wrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-wrapper.d.ts","sourceRoot":"","sources":["../../src/utils/api-wrapper.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAK1C;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;AAEnG;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAwErF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,SAAS,OAAO,EAAE,EAAE,OAAO,EACtE,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,OAAO,CAAC,GAC3C,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,OAAO,CAAC,CAkCtC"}

package/dist/utils/api-wrapper.js

@@ -0,0 +1,151 @@
+/**
+ * API Route Wrapper
+ *
+ * Wraps Next.js API routes to automatically set up request context,
+ * error handling, and logging.
+ */
+import { NextResponse } from 'next/server';
+import { handleApiError } from './errors.js';
+import { logger } from './logger.js';
+import { createRequestContext, getRequestDuration, runInRequestContext } from './request-context.js';
+/**
+ * Wrap an API route handler with request context, logging, and error handling
+ *
+ * Benefits:
+ * - Automatic request ID generation and propagation
+ * - Request context available via getRequestContext()
+ * - Automatic error handling with proper status codes
+ * - Request/response logging with timing
+ * - All logs include request ID automatically
+ *
+ * @param handler - API route handler function
+ * @returns Wrapped handler with request context
+ *
+ * @example
+ * ```typescript
+ * // app/api/users/route.ts
+ * import { withRequestContext } from '@revealui/core/utils/api-wrapper'
+ * import { NextResponse } from 'next/server'
+ *
+ * export const GET = withRequestContext(async (request) => {
+ *   // Request ID automatically available in logs
+ *   logger.info('Fetching users') // Includes requestId automatically
+ *
+ *   const users = await db.query.users.findMany()
+ *   return NextResponse.json(users)
+ * })
+ * ```
+ */
+export function withRequestContext(handler) {
+    return async (request) => {
+        // Create request context from headers
+        const context = createRequestContext({
+            headers: Object.fromEntries(request.headers.entries()),
+            path: request.nextUrl.pathname,
+            method: request.method,
+            ip: request.headers.get('x-forwarded-for') || request.headers.get('x-real-ip') || undefined,
+        });
+        // Log incoming request
+        logger.info('Incoming request', {
+            method: context.method,
+            path: context.path,
+            ip: context.ip,
+            userAgent: context.userAgent,
+        });
+        try {
+            // Run handler within request context
+            const response = await runInRequestContext(context, () => handler(request));
+            // Log successful response
+            const duration = getRequestDuration();
+            logger.info('Request completed', {
+                method: context.method,
+                path: context.path,
+                status: response.status,
+                duration,
+            });
+            // Add request ID to response headers
+            if (response instanceof NextResponse) {
+                response.headers.set('x-request-id', context.requestId);
+                response.headers.set('x-request-duration', duration?.toString() || '0');
+            }
+            return response;
+        }
+        catch (error) {
+            // Handle errors with proper logging and status codes
+            const duration = getRequestDuration();
+            logger.error('Request failed', {
+                method: context.method,
+                path: context.path,
+                error: error instanceof Error ? error.message : String(error),
+                duration,
+            });
+            // Convert error to API response
+            const apiError = handleApiError(error, {
+                method: context.method,
+                path: context.path,
+            });
+            const errorResponse = NextResponse.json({
+                error: {
+                    message: apiError.message,
+                    code: apiError.code,
+                    ...(apiError.retryable !== undefined && { retryable: apiError.retryable }),
+                },
+            }, { status: apiError.statusCode });
+            // Add request ID to error response
+            errorResponse.headers.set('x-request-id', context.requestId);
+            errorResponse.headers.set('x-request-duration', duration?.toString() || '0');
+            return errorResponse;
+        }
+    };
+}
+/**
+ * Server action wrapper for request context
+ *
+ * Use this for Next.js Server Actions to enable request tracing
+ *
+ * @param action - Server action function
+ * @returns Wrapped action with request context
+ *
+ * @example
+ * ```typescript
+ * 'use server'
+ *
+ * import { withServerActionContext } from '@revealui/core/utils/api-wrapper'
+ *
+ * export const createUser = withServerActionContext(async (data) => {
+ *   logger.info('Creating user') // Includes requestId
+ *   return await db.insert(users).values(data)
+ * })
+ * ```
+ */
+export function withServerActionContext(action) {
+    return async (...args) => {
+        // Create request context (no headers available in server actions)
+        const context = createRequestContext({});
+        // Log server action execution
+        logger.info('Server action started', {
+            action: action.name || 'anonymous',
+        });
+        try {
+            // Run action within request context
+            const result = await runInRequestContext(context, () => action(...args));
+            // Log successful execution
+            const duration = getRequestDuration();
+            logger.info('Server action completed', {
+                action: action.name || 'anonymous',
+                duration,
+            });
+            return result;
+        }
+        catch (error) {
+            // Log error
+            const duration = getRequestDuration();
+            logger.error('Server action failed', {
+                action: action.name || 'anonymous',
+                error: error instanceof Error ? error.message : String(error),
+                duration,
+            });
+            throw error;
+        }
+    };
+}

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

@@ -0,0 +1,21 @@
+import type React from 'react';
+import type { Block, RevealUIBlock, RevealUIContext } from '../types/index.js';
+export declare function convertToRevealUIBlock(block: Block): RevealUIBlock;
+export declare function convertFromRevealUIBlock(revealUIBlock: RevealUIBlock): Block;
+export declare function enhanceBlockWithRevealUI(block: Block, revealUIOptions?: RevealUIBlock['revealUI']): RevealUIBlock;
+/**
+ * Validate a RevealUI block
+ *
+ * @async
+ * @param block - The RevealUI block to validate
+ * @param data - The data to validate against the block
+ * @param context - The RevealUI context for validation
+ * @returns Promise resolving to a record of field errors (empty if valid)
+ */
+export declare function validateRevealUIBlock(block: RevealUIBlock, data: Record<string, unknown>, context: RevealUIContext): Promise<Record<string, string>>;
+export declare function getRevealUIBlockComponent(block: RevealUIBlock): React.ComponentType<{
+    data: Record<string, unknown>;
+    onChange: (data: Record<string, unknown>) => void;
+    revealUI?: RevealUIContext;
+}>;
+//# sourceMappingURL=block-conversion.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"block-conversion.d.ts","sourceRoot":"","sources":["../../src/utils/block-conversion.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,KAAK,EAAE,KAAK,EAAS,aAAa,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAIrF,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,KAAK,GAAG,aAAa,CAalE;AAGD,wBAAgB,wBAAwB,CAAC,aAAa,EAAE,aAAa,GAAG,KAAK,CAa5E;AAGD,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,KAAK,EACZ,eAAe,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,GAC1C,aAAa,CAWf;AAED;;;;;;;;GAQG;AACH,wBAAsB,qBAAqB,CACzC,KAAK,EAAE,aAAa,EACpB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CA0BjC;AAGD,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;IACnF,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;IACjD,QAAQ,CAAC,EAAE,eAAe,CAAA;CAC3B,CAAC,CAsDD"}

package/dist/utils/block-conversion.js

@@ -0,0 +1,109 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { convertToRevealUIField } from './field-conversion.js';
+// Convert from standard block to RevealUI block
+export function convertToRevealUIBlock(block) {
+    return {
+        slug: block.slug,
+        fields: block.fields.map(convertToRevealUIField),
+        revealUI: {
+            category: 'content',
+            icon: 'block',
+            preview: undefined,
+            permissions: ['read', 'write'],
+            tenantScoped: false,
+        },
+        labels: block.labels || { singular: block.slug, plural: `${block.slug}s` },
+    };
+}
+// Convert from RevealUI block to standard block
+export function convertFromRevealUIBlock(revealUIBlock) {
+    return {
+        slug: revealUIBlock.slug,
+        fields: revealUIBlock.fields.map((field) => ({
+            name: field.name,
+            type: field.type,
+            label: field.label,
+            required: field.required,
+            admin: field.admin,
+            validate: field.validate,
+        })),
+        labels: revealUIBlock.labels,
+    };
+}
+// Enhance a standard block with RevealUI features
+export function enhanceBlockWithRevealUI(block, revealUIOptions) {
+    const revealUIBlock = convertToRevealUIBlock(block);
+    if (revealUIOptions) {
+        revealUIBlock.revealUI = {
+            ...revealUIBlock.revealUI,
+            ...revealUIOptions,
+        };
+    }
+    return revealUIBlock;
+}
+/**
+ * Validate a RevealUI block
+ *
+ * @async
+ * @param block - The RevealUI block to validate
+ * @param data - The data to validate against the block
+ * @param context - The RevealUI context for validation
+ * @returns Promise resolving to a record of field errors (empty if valid)
+ */
+export async function validateRevealUIBlock(block, data, context) {
+    const errors = {};
+    // Validate each field in the block
+    for (const field of block.fields) {
+        if (!field.name)
+            continue; // Skip fields without names
+        const value = data[field.name];
+        const validationContext = {
+            data,
+            siblingData: data,
+            user: context.user ?? undefined,
+            tenant: context.tenant,
+            operation: 'update',
+        };
+        // Import the validation function dynamically to avoid circular imports
+        const { validateRevealUIField } = await import('./field-conversion.js');
+        const result = validateRevealUIField(field, value, validationContext);
+        if (result !== true) {
+            errors[field.name] = result;
+        }
+    }
+    return errors;
+}
+// Get a React component for rendering a RevealUI block
+export function getRevealUIBlockComponent(block) {
+    return function RevealUIBlockComponent({ data, onChange, revealUI }) {
+        void revealUI;
+        const blockFields = block.fields.map((field) => {
+            return {
+                name: field.name,
+                type: field.type,
+                label: field.label,
+                required: field.required,
+            };
+        });
+        const formatValue = (value) => {
+            if (value === null || value === undefined)
+                return '';
+            if (typeof value === 'string')
+                return value;
+            if (typeof value === 'number' || typeof value === 'boolean' || typeof value === 'bigint') {
+                return String(value);
+            }
+            if (typeof value === 'symbol')
+                return value.description ?? value.toString();
+            if (typeof value === 'function')
+                return value.name || 'function';
+            return JSON.stringify(value);
+        };
+        return (_jsx("div", { className: "reveal-ui-block", "data-block-slug": block.slug, children: _jsx("div", { className: "reveal-ui-block-fields", children: blockFields.map((field) => {
+                    const fieldName = typeof field.name === 'string' ? field.name : '';
+                    const fieldLabel = typeof field.label === 'string' ? field.label : fieldName || 'Field';
+                    const value = fieldName ? data[fieldName] : undefined;
+                    return (_jsxs("div", { className: "reveal-ui-field", children: [_jsxs("label", { className: "reveal-ui-field-label", htmlFor: `field-${fieldName}`, children: [fieldLabel, field.required && _jsx("span", { className: "required", children: "*" })] }), _jsx("div", { className: "reveal-ui-field-input", children: _jsx("input", { type: "text", id: `field-${fieldName}`, value: formatValue(value), onChange: (e) => onChange({ ...data, [fieldName]: e.target.value }), required: field.required }) })] }, fieldName || Math.random()));
+                }) }) }));
+    };
+}

package/dist/utils/cache.d.ts

@@ -0,0 +1,86 @@
+/**
+ * LRU Cache with TTL (Time To Live)
+ *
+ * Provides a cache implementation with:
+ * - TTL (Time To Live) expiration
+ * - Size limits with LRU eviction
+ * - Type-safe generic interface
+ *
+ * @example
+ * ```typescript
+ * const cache = new LRUCache<string, User>({ maxSize: 100, ttlMs: 5 * 60 * 1000 })
+ * const user = await cache.fetch('user:123', () => fetchUserFromDB('123'))
+ * ```
+ */
+export interface LRUCacheOptions {
+    /**
+     * Maximum number of entries in the cache
+     * @default 100
+     */
+    maxSize?: number;
+    /**
+     * Time to live in milliseconds
+     * @default 5 minutes (300000)
+     */
+    ttlMs?: number;
+}
+/**
+ * LRU Cache with TTL for storing key-value pairs
+ *
+ * Features:
+ * - Automatic expiration based on TTL
+ * - Size limits with LRU (Least Recently Used) eviction
+ * - Type-safe generic interface
+ */
+export declare class LRUCache<K = string, V = unknown> {
+    private cache;
+    private readonly maxSize;
+    private readonly ttlMs;
+    constructor(options?: LRUCacheOptions);
+    /**
+     * Fetch a value from cache or compute it using the fetcher function
+     *
+     * @param key - Cache key
+     * @param fetcher - Function to fetch the value if not in cache
+     * @returns The cached or newly fetched value
+     */
+    fetch(key: K, fetcher: () => Promise<V> | V): Promise<V>;
+    /**
+     * Get a value from cache without fetching (returns undefined if not found or expired)
+     *
+     * @param key - Cache key
+     * @returns The cached value or undefined
+     */
+    get(key: K): V | undefined;
+    /**
+     * Set a value in the cache
+     *
+     * @param key - Cache key
+     * @param value - Value to cache
+     */
+    set(key: K, value: V): void;
+    /**
+     * Delete a value from the cache
+     *
+     * @param key - Cache key
+     * @returns true if the entry was deleted, false if it didn't exist
+     */
+    delete(key: K): boolean;
+    /**
+     * Clear all entries from the cache
+     */
+    clear(): void;
+    /**
+     * Get the current size of the cache
+     */
+    get size(): number;
+    /**
+     * Evict expired entries and LRU entries if at capacity
+     */
+    private evictIfNeeded;
+    /**
+     * Clean up expired entries (can be called periodically)
+     */
+    cleanup(): void;
+}
+//# sourceMappingURL=cache.d.ts.map

package/dist/utils/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../src/utils/cache.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAQD;;;;;;;GAOG;AACH,qBAAa,QAAQ,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,OAAO;IAC3C,OAAO,CAAC,KAAK,CAA8B;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;gBAElB,OAAO,GAAE,eAAoB;IAKzC;;;;;;OAMG;IACG,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IA8B9D;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAiB1B;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAW3B;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO;IAIvB;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,OAAO,CAAC,aAAa;IA4BrB;;OAEG;IACH,OAAO,IAAI,IAAI;CAQhB"}