CIA Compliance Manager API Documentation - v1.1.6
    Preparing search index...

    Class ComplianceServiceAdapter

    Adapter for compliance service functionality

    Provides a simplified interface to compliance checking and framework mapping, adapting the ComplianceService for easier consumption by components and services. Enables organizations to understand their compliance posture and identify gaps. 📋

    Hierarchy (View Summary)

    Implements

    • IComplianceService
    Index

    Constructors

    Properties

    frameworkRequirements: Record<
        string,
        {
            availability: SecurityLevel;
            confidentiality: SecurityLevel;
            integrity: SecurityLevel;
        },
    > = ...

    Framework requirements mapping Maps compliance frameworks to their minimum security requirements

    name: string = 'ComplianceServiceAdapter'

    Service name for identification

    Methods

    • Get compliance gap analysis between current and required security levels

      Performs a comprehensive gap analysis, identifying where the current security posture falls short of compliance framework requirements and providing actionable remediation steps.

      Parameters

      • availabilityLevel: SecurityLevel

        Current availability security level

      • integrityLevel: SecurityLevel

        Current integrity security level

      • confidentialityLevel: SecurityLevel

        Current confidentiality security level

      • Optionalframework: string

        Optional specific framework to analyze (analyzes all if not provided)

      Returns ComplianceGapAnalysis

      Detailed gap analysis including gaps, recommendations, and compliance score

      If any security level is invalid

      const gapAnalysis = adapter.getComplianceGapAnalysis('Moderate', 'Moderate', 'High', 'HIPAA');
      console.log(`Compliance score: ${gapAnalysis.complianceScore}%`);
      console.log(`Number of gaps: ${gapAnalysis.gaps.length}`);
    • Get compliance status based on security levels

      Evaluates compliance with all supported frameworks based on the provided security levels for availability, integrity, and confidentiality.

      Parameters

      Returns ComplianceStatusDetails

      Compliance status details including compliant, partially compliant, and non-compliant frameworks

      If any security level is invalid

      const status = adapter.getComplianceStatus('High', 'High', 'Very High');
      console.log(`Compliant with ${status.compliantFrameworks.length} frameworks`);
    • Get compliance status text based on security levels

      Returns a human-readable text description of the overall compliance status.

      Parameters

      • availabilityLevel: SecurityLevel

        Availability security level

      • integrityLevel: SecurityLevel = availabilityLevel

        Integrity security level (defaults to availabilityLevel if not provided)

      • confidentialityLevel: SecurityLevel = availabilityLevel

        Confidentiality security level (defaults to availabilityLevel if not provided)

      Returns string

      Compliance status text description

      If any security level is invalid

      const statusText = adapter.getComplianceStatusText('High', 'High', 'Very High');
      console.log(statusText); // "Compliant with all major frameworks"
    • Get compliant frameworks for given security levels

      Returns a list of all compliance frameworks that are fully satisfied by the provided security levels.

      Parameters

      • availabilityLevel: SecurityLevel

        Availability security level

      • integrityLevel: SecurityLevel = availabilityLevel

        Integrity security level (defaults to availabilityLevel if not provided)

      • confidentialityLevel: SecurityLevel = availabilityLevel

        Confidentiality security level (defaults to availabilityLevel if not provided)

      Returns string[]

      Array of compliant framework names

      If any security level is invalid

      const frameworks = adapter.getCompliantFrameworks('High', 'High', 'Very High');
      console.log(`Compliant with: ${frameworks.join(', ')}`);
    • Get description of a compliance framework

      Returns a detailed description of the specified compliance framework, explaining its purpose and scope.

      Parameters

      • framework: string

        Framework name (e.g., 'NIST 800-53', 'ISO 27001', 'GDPR')

      Returns string

      Framework description or "No description available" if framework is unknown

      const desc = adapter.getFrameworkDescription('GDPR');
      console.log(desc); // "General Data Protection Regulation for protecting personal data in the EU"
    • Get framework compliance status

      Evaluates whether a specific framework's requirements are met by the given security levels.

      Parameters

      • framework: string

        Framework name to evaluate

      • availabilityLevel: SecurityLevel

        Availability security level

      • integrityLevel: SecurityLevel

        Integrity security level

      • confidentialityLevel: SecurityLevel

        Confidentiality security level

      Returns { status: string }

      Object containing status string (Compliant, Partially Compliant, or Non-Compliant)

      If any security level is invalid

      const status = adapter.getFrameworkStatus('HIPAA', 'High', 'High', 'Very High');
      console.log(status.status); // "Compliant"
    • Check if a framework is applicable to an industry/region

      Parameters

      • framework: string

        Framework name

      • Optionalindustry: string

        Industry (optional)

      • Optionalregion: string

        Region (optional)

      Returns boolean

      True if the framework is applicable

    • Validate input parameters (to be overridden by subclasses)

      Parameters

      • input: unknown

        Input to validate

      Returns boolean

      True if valid, false otherwise