@jmruthers/pace-core 0.6.9 → 0.6.11

package/src/rbac/compliance/quick-fix-suggestions.ts

@@ -1,209 +0,0 @@
-/**
- * Quick Fix Suggestions for RBAC/Auth Compliance
- * @package @jmruthers/pace-core
- * @module RBAC/Compliance/QuickFixSuggestions
- * @since 1.0.0
- * 
- * This module provides auto-suggest fixes for common RBAC/auth compliance issues.
- */
-
-export interface QuickFix {
-  issue: string;
-  suggestion: string;
-  codeExample?: string;
-  migrationSteps?: string[];
-}
-
-/**
- * Get quick fix suggestions for custom auth code
- */
-export function getCustomAuthCodeFixes(customCodeName: string, type: 'hook' | 'component' | 'util'): QuickFix {
-  const fixes: Record<string, QuickFix> = {
-    'useAuth': {
-      issue: `Custom ${type} '${customCodeName}' detected`,
-      suggestion: `Replace with useUnifiedAuth from pace-core`,
-      codeExample: `// Before
-import { useAuth } from './hooks/useAuth';
-
-// After
-import { useUnifiedAuth } from '@jmruthers/pace-core';`,
-      migrationSteps: [
-        'Remove custom useAuth hook',
-        'Import useUnifiedAuth from @jmruthers/pace-core',
-        'Update all usages to use useUnifiedAuth',
-        'Ensure UnifiedAuthProvider wraps your app'
-      ]
-    },
-    'usePermissions': {
-      issue: `Custom ${type} '${customCodeName}' detected`,
-      suggestion: `Replace with usePermissions from pace-core`,
-      codeExample: `// Before
-import { usePermissions } from './hooks/usePermissions';
-
-// After
-import { usePermissions } from '@jmruthers/pace-core/rbac';`,
-      migrationSteps: [
-        'Remove custom usePermissions hook',
-        'Import usePermissions from @jmruthers/pace-core/rbac',
-        'Update all usages - ensure setupRBAC() has been called',
-        'Verify provider hierarchy is correct'
-      ]
-    },
-    'PermissionGuard': {
-      issue: `Custom ${type} '${customCodeName}' detected`,
-      suggestion: `Replace with PagePermissionGuard from pace-core`,
-      codeExample: `// Before
-import { PermissionGuard } from './components/PermissionGuard';
-
-// After
-import { PagePermissionGuard } from '@jmruthers/pace-core/rbac';`,
-      migrationSteps: [
-        'Remove custom PermissionGuard component',
-        'Import PagePermissionGuard from @jmruthers/pace-core/rbac',
-        'Wrap pages with PagePermissionGuard',
-        'Use pageName and operation props instead of custom permission strings'
-      ]
-    },
-    'checkPermission': {
-      issue: `Custom ${type} '${customCodeName}' detected`,
-      suggestion: `Replace with isPermitted from pace-core`,
-      codeExample: `// Before
-import { checkPermission } from './utils/permissions';
-
-// After
-import { isPermitted } from '@jmruthers/pace-core/rbac';`,
-      migrationSteps: [
-        'Remove custom checkPermission utility',
-        'Import isPermitted from @jmruthers/pace-core/rbac',
-        'Update all usages to use isPermitted with proper scope',
-        'Ensure setupRBAC() has been called'
-      ]
-    }
-  };
-  
-  return fixes[customCodeName] || {
-    issue: `Custom ${type} '${customCodeName}' detected`,
-    suggestion: `Use pace-core's equivalent instead. Check @jmruthers/pace-core documentation for the correct import.`,
-    migrationSteps: [
-      `Remove custom ${customCodeName} ${type}`,
-      'Find equivalent in pace-core',
-      'Import from @jmruthers/pace-core or @jmruthers/pace-core/rbac',
-      'Update all usages'
-    ]
-  };
-}
-
-/**
- * Get quick fix suggestions for duplicate Supabase config
- */
-export function getDuplicateConfigFixes(): QuickFix {
-  return {
-    issue: 'Multiple Supabase client instantiations found',
-    suggestion: 'Consolidate to a single Supabase client configuration',
-    codeExample: `// Before - Multiple createClient calls
-// src/lib/supabase.ts
-export const supabase = createClient(url, key);
-
-// src/utils/api.ts
-export const supabase = createClient(url, key);
-
-// After - Single configuration
-// src/lib/supabase.ts
-export const supabase = createClient(
-  import.meta.env.VITE_SUPABASE_URL,
-  import.meta.env.VITE_SUPABASE_PUBLISHABLE_KEY
-);
-
-// src/utils/api.ts
-import { supabase } from '../lib/supabase';`,
-    migrationSteps: [
-      'Create a single supabase.ts file in a shared location (e.g., src/lib/supabase.ts)',
-      'Move all Supabase client creation to this file',
-      'Export the client instance',
-      'Update all files to import from the shared location',
-      'Remove duplicate createClient calls'
-    ]
-  };
-}
-
-/**
- * Get quick fix suggestions for unprotected pages
- */
-export function getUnprotectedPageFixes(): QuickFix {
-  return {
-    issue: 'Route/page found without PagePermissionGuard',
-    suggestion: 'Wrap all routes with PagePermissionGuard',
-    codeExample: `// Before
-<Route path="/dashboard" element={<Dashboard />} />
-
-// After
-<Route 
-  path="/dashboard" 
-  element={
-    <PagePermissionGuard pageName="dashboard" operation="read">
-      <Dashboard />
-    </PagePermissionGuard>
-  } 
-/>`,
-    migrationSteps: [
-      'Import PagePermissionGuard from @jmruthers/pace-core/rbac',
-      'Wrap each route/page component with PagePermissionGuard',
-      'Set pageName prop to match your page name in rbac_app_pages table',
-      'Set operation prop (read, create, update, or delete)',
-      'Ensure setupRBAC() has been called and providers are set up correctly'
-    ]
-  };
-}
-
-/**
- * Get quick fix suggestions for direct Supabase auth usage
- */
-export function getDirectSupabaseAuthFixes(): QuickFix {
-  return {
-    issue: 'Direct Supabase auth usage detected',
-    suggestion: 'Use UnifiedAuthProvider and useUnifiedAuth from pace-core',
-    codeExample: `// Before
-import { createClient } from '@supabase/supabase-js';
-const supabase = createClient(url, key);
-await supabase.auth.signInWithPassword({ email, password });
-
-// After
-import { useUnifiedAuth } from '@jmruthers/pace-core';
-const { signIn } = useUnifiedAuth();
-await signIn({ email, password });`,
-    migrationSteps: [
-      'Remove direct Supabase auth calls',
-      'Import useUnifiedAuth from @jmruthers/pace-core',
-      'Use the auth methods from useUnifiedAuth hook',
-      'Ensure UnifiedAuthProvider wraps your app',
-      'Update all auth-related code to use pace-core hooks'
-    ]
-  };
-}
-
-/**
- * Get all quick fix suggestions for a compliance issue
- */
-export function getQuickFixes(issueType: string, details?: Record<string, any>): QuickFix[] {
-  const fixes: QuickFix[] = [];
-  
-  switch (issueType) {
-    case 'custom-auth-code':
-      if (details?.name && details?.type) {
-        fixes.push(getCustomAuthCodeFixes(details.name, details.type));
-      }
-      break;
-    case 'duplicate-config':
-      fixes.push(getDuplicateConfigFixes());
-      break;
-    case 'unprotected-pages':
-      fixes.push(getUnprotectedPageFixes());
-      break;
-    case 'direct-supabase-auth':
-      fixes.push(getDirectSupabaseAuthFixes());
-      break;
-  }
-  
-  return fixes;
-}
-

package/src/rbac/compliance/runtime-compliance.ts

@@ -1,99 +0,0 @@
-/**
- * Runtime Compliance Checking
- * @package @jmruthers/pace-core
- * @module RBAC/Compliance/RuntimeCompliance
- * @since 1.0.0
- * 
- * This module provides runtime compliance checking utilities.
- */
-
-import { validateRBACSetup, SetupIssue } from './setup-validator';
-import { getRBACLogger } from '../config';
-import { detectPatternViolations, logPatternViolations, type PatternDetectionResult } from './pattern-detector';
-
-export interface RuntimeComplianceResult {
-  setup: {
-    isCompliant: boolean;
-    issues: SetupIssue[];
-  };
-  warnings: string[];
-  providerContext?: {
-    available: boolean;
-    message?: string;
-  };
-  patternDetection?: PatternDetectionResult;
-}
-
-/**
- * Check runtime compliance
- * 
- * This function checks if the RBAC system is properly set up and logs warnings
- * to the console if issues are found. This is intended for development-time
- * validation only.
- * 
- * @returns Runtime compliance result
- */
-export function checkRuntimeCompliance(): RuntimeComplianceResult {
-  const logger = getRBACLogger();
-  const setupValidation = validateRBACSetup();
-  const warnings: string[] = [];
-  
-  if (!setupValidation.isCompliant) {
-    setupValidation.issues.forEach(issue => {
-      const warning = `[RBAC Compliance] ${issue.message}\n  Recommendation: ${issue.recommendation}`;
-      warnings.push(warning);
-      logger.warn(warning);
-    });
-  }
-  
-  // Check for provider context issues
-  const providerContextIssues = setupValidation.issues.filter(
-    issue => issue.type === 'missing-provider-context' || issue.type === 'not-initialized'
-  );
-  
-  const providerContext = providerContextIssues.length > 0 ? {
-    available: false,
-    message: 'UnifiedAuthProvider context may not be available. Ensure your app is wrapped with UnifiedAuthProvider from @jmruthers/pace-core.'
-  } : {
-    available: true
-  };
-  
-  return {
-    setup: setupValidation,
-    warnings,
-    providerContext
-  };
-}
-
-/**
- * Validate and warn about RBAC setup issues
- * 
- * This is a convenience function that checks compliance and logs warnings.
- * Call this in development mode to get early warnings about setup issues.
- */
-export function validateAndWarn(): void {
-  if (import.meta.env.MODE === 'development' || import.meta.env.DEV) {
-    checkRuntimeCompliance();
-  }
-}
-
-/**
- * Check pattern violations in source code
- * 
- * This function analyzes source code for RBAC pattern violations.
- * It can be used for static analysis or runtime code inspection.
- * 
- * @param code - Source code to analyze
- * @param filePath - Optional file path for better error reporting
- * @returns Pattern detection result
- */
-export function checkPatternCompliance(code: string, filePath?: string): PatternDetectionResult {
-  const result = detectPatternViolations(code, filePath);
-  
-  if (!result.isCompliant) {
-    logPatternViolations(result);
-  }
-  
-  return result;
-}
-

package/src/rbac/compliance/setup-validator.ts

@@ -1,131 +0,0 @@
-/**
- * RBAC Setup Validator
- * @package @jmruthers/pace-core
- * @module RBAC/Compliance/SetupValidator
- * @since 1.0.0
- * 
- * This module provides utilities to validate RBAC setup state.
- */
-
-import { getRBACConfig } from '../config';
-import { RBACNotInitializedError } from '../errors';
-
-export interface SetupIssue {
-  type: 'not-initialized' | 'missing-config' | 'invalid-config' | 'missing-provider-context';
-  message: string;
-  recommendation: string;
-}
-
-export interface ComplianceResult {
-  isCompliant: boolean;
-  issues: SetupIssue[];
-}
-
-/**
- * Check if RBAC system is initialized
- * 
- * @returns true if RBAC is initialized, false otherwise
- */
-export function isRBACInitialized(): boolean {
-  try {
-    const config = getRBACConfig();
-    return config !== null && config.supabase !== null;
-  } catch (error) {
-    if (error instanceof RBACNotInitializedError) {
-      return false;
-    }
-    // Re-throw unexpected errors
-    throw error;
-  }
-}
-
-/**
- * Get setup issues
- * 
- * @returns Array of setup issues
- */
-export function getSetupIssues(): SetupIssue[] {
-  const issues: SetupIssue[] = [];
-  
-  const config = getRBACConfig();
-  
-  if (!config) {
-    issues.push({
-      type: 'not-initialized',
-      message: 'RBAC system has not been initialized. setupRBAC() has not been called.',
-      recommendation: 'Call setupRBAC(supabase) before using any RBAC features. This should be done in your main entry point (main.tsx or App.tsx) before rendering the app.'
-    });
-    return issues;
-  }
-  
-  if (!config.supabase) {
-    issues.push({
-      type: 'missing-config',
-      message: 'RBAC configuration is missing Supabase client.',
-      recommendation: 'Ensure setupRBAC() is called with a valid Supabase client instance.'
-    });
-  }
-  
-  return issues;
-}
-
-/**
- * Check if UnifiedAuthProvider context is available
- * 
- * This function can be called from React components to check if the context
- * is available. It uses React's useContext hook, so it must be called from
- * within a React component.
- * 
- * @returns true if context is available, false otherwise
- * @throws Error if called outside React component context
- */
-export function isUnifiedAuthContextAvailable(): boolean {
-  try {
-    // This will only work if called from within a React component
-    // We can't import useContext here directly as it would require React
-    // Instead, we'll check if the context can be accessed
-    // Note: This is a best-effort check and may not work in all scenarios
-    return true; // Context availability is checked by useUnifiedAuth hook itself
-  } catch (error) {
-    return false;
-  }
-}
-
-/**
- * Get provider context setup issues
- * 
- * This provides guidance on common provider setup problems.
- * Actual context availability must be checked at component level.
- * 
- * @returns Array of setup issues related to provider context
- */
-export function getProviderContextIssues(): SetupIssue[] {
-  const issues: SetupIssue[] = [];
-  
-  // Check if RBAC is initialized (prerequisite for provider context)
-  if (!isRBACInitialized()) {
-    issues.push({
-      type: 'not-initialized',
-      message: 'RBAC system must be initialized before provider context can be used.',
-      recommendation: 'Call setupRBAC(supabase) before rendering UnifiedAuthProvider.'
-    });
-  }
-  
-  return issues;
-}
-
-/**
- * Validate RBAC setup
- * 
- * @returns Compliance result with issues and recommendations
- */
-export function validateRBACSetup(): ComplianceResult {
-  const issues = getSetupIssues();
-  const providerIssues = getProviderContextIssues();
-  
-  return {
-    isCompliant: issues.length === 0 && providerIssues.length === 0,
-    issues: [...issues, ...providerIssues]
-  };
-}
-