Class ComplianceServiceAdapter

constructor

• new ComplianceServiceAdapter(
      dataProvider: CIADataProvider,
  ): ComplianceServiceAdapter

  Create a new ComplianceServiceAdapter instance

  Parameters

  • dataProvider: CIADataProvider

    Data provider for CIA options and compliance data

  Returns ComplianceServiceAdapter

  Throws

  If dataProvider is not provided

Readonlyname

frameworkRequirements

getComplianceStatus

• getComplianceStatus(
      availabilityLevel: SecurityLevel,
      integrityLevel: SecurityLevel,
      confidentialityLevel: SecurityLevel,
  ): ComplianceStatusDetails

  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

  • availabilityLevel: SecurityLevel

    Availability security level

  • integrityLevel: SecurityLevel

    Integrity security level

  • confidentialityLevel: SecurityLevel

    Confidentiality security level

  Returns ComplianceStatusDetails

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

  Throws

  If any security level is invalid

  Example

  const status = adapter.getComplianceStatus('High', 'High', 'Very High');
  console.log(`Compliant with ${status.compliantFrameworks.length} frameworks`);
  Copy

getComplianceStatusText

• getComplianceStatusText(
      availabilityLevel: SecurityLevel,
      integrityLevel?: SecurityLevel,
      confidentialityLevel?: SecurityLevel,
  ): string

  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

  Throws

  If any security level is invalid

  Example

  const statusText = adapter.getComplianceStatusText('High', 'High', 'Very High');
  console.log(statusText); // "Compliant with all major frameworks"
  Copy

getCompliantFrameworks

• getCompliantFrameworks(
      availabilityLevel: SecurityLevel,
      integrityLevel?: SecurityLevel,
      confidentialityLevel?: SecurityLevel,
  ): string[]

  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

  Throws

  If any security level is invalid

  Example

  const frameworks = adapter.getCompliantFrameworks('High', 'High', 'Very High');
  console.log(`Compliant with: ${frameworks.join(', ')}`);
  Copy

getFrameworkDescription

• getFrameworkDescription(framework: string): string

  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

  Example

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

getFrameworkStatus

• getFrameworkStatus(
      framework: string,
      availabilityLevel: SecurityLevel,
      integrityLevel: SecurityLevel,
      confidentialityLevel: SecurityLevel,
  ): { status: string }

  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)

  Throws

  If any security level is invalid

  Example

  const status = adapter.getFrameworkStatus('HIPAA', 'High', 'High', 'Very High');
  console.log(status.status); // "Compliant"
  Copy

isFrameworkApplicable

• isFrameworkApplicable(
      _framework: string,
      _industry?: string,
      _region?: string,
  ): boolean

  Check if a framework is applicable to an industry/region

  Parameters

  • _framework: string
  • Optional_industry: string
  • Optional_region: string

  Returns boolean

  True if the framework is applicable

getFrameworkRequiredLevel

• getFrameworkRequiredLevel(
      framework: string,
      component: CIAComponentType,
  ): SecurityLevel

  Get required security level for a specific framework and component

  Parameters

  • framework: string

    Framework name

  • component: CIAComponentType

    CIA component

  Returns SecurityLevel

  Required security level

getComplianceGapAnalysis

• getComplianceGapAnalysis(
      availabilityLevel: SecurityLevel,
      integrityLevel: SecurityLevel,
      confidentialityLevel: SecurityLevel,
      framework?: string,
  ): ComplianceGapAnalysis

  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

  Throws

  If any security level is invalid

  Example

  const gapAnalysis = adapter.getComplianceGapAnalysis('Moderate', 'Moderate', 'High', 'HIPAA');
  console.log(`Compliance score: ${gapAnalysis.complianceScore}%`);
  console.log(`Number of gaps: ${gapAnalysis.gaps.length}`);
  Copy