@codesoul-co/hypha-core / contracts/runtime-integrity-audit

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/contracts/runtime-integrity-audit.ts
• Exports: 9

Using this module

Use the Runtime integrity audit module for declaring and runtime-validating contracts. It exports 9 interfaces.

Import from the package entrypoint

import type {
  CanonicalEventScanPort,
  RuntimeIntegrityRepairCommand,
  RuntimeIntegrityRepairEvidence,
  RuntimeIntegrityRepairPort,
  RuntimeIntegrityRepairResult,
  RuntimeIntegrityStore,
  RuntimeIntegrityWatermark,
  ScanCanonicalEventsRequest,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns

• Use the 9 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.

Public exports

Symbol	Kind	Signature	Description
CanonicalEventScanPort	interface	interface CanonicalEventScanPort	Canonical Event Scan Port interface with 1 public fields or methods.
RuntimeIntegrityRepairCommand	interface	interface RuntimeIntegrityRepairCommand	Runtime Integrity Repair Command interface with 6 public fields or methods.
RuntimeIntegrityRepairEvidence	interface	interface RuntimeIntegrityRepairEvidence	Runtime Integrity Repair Evidence interface with 8 public fields or methods.
RuntimeIntegrityRepairPort	interface	interface RuntimeIntegrityRepairPort	Runtime Integrity Repair Port interface with 1 public fields or methods.
RuntimeIntegrityRepairResult	interface	interface RuntimeIntegrityRepairResult	Runtime Integrity Repair Result interface with 3 public fields or methods.
RuntimeIntegrityStore	interface	interface RuntimeIntegrityStore	Runtime Integrity Store interface with 4 public fields or methods.
RuntimeIntegrityWatermark	interface	interface RuntimeIntegrityWatermark	Runtime Integrity Watermark interface with 7 public fields or methods.
ScanCanonicalEventsRequest	interface	interface ScanCanonicalEventsRequest	Scan Canonical Events Request interface with 3 public fields or methods.
ScanCanonicalEventsResult	interface	interface ScanCanonicalEventsResult	Scan Canonical Events Result interface with 4 public fields or methods.

CanonicalEventScanPort

Canonical Event Scan Port interface with 1 public fields or methods.

• Kind: interface
• Import: import type { CanonicalEventScanPort } from '@codesoul-co/hypha-core';
• Source module: contracts/runtime-integrity-audit

Declaration

export interface CanonicalEventScanPort {
    scanCanonicalEvents(request: ScanCanonicalEventsRequest): Promise<ScanCanonicalEventsResult>;
}

Contract members

Member	Kind	Signature	Description
scanCanonicalEvents	method	scanCanonicalEvents(request: ScanCanonicalEventsRequest): Promise<ScanCanonicalEventsResult>	Public method; parameters and return type are shown in the signature.

RuntimeIntegrityRepairCommand

Runtime Integrity Repair Command interface with 6 public fields or methods.

• Kind: interface
• Import: import type { RuntimeIntegrityRepairCommand } from '@codesoul-co/hypha-core';
• Source module: contracts/runtime-integrity-audit

Declaration

export interface RuntimeIntegrityRepairCommand {
    version: '1.0.0';
    repairId: string;
    findingHash: string;
    requestedRevision: string;
    requestedBy: string;
    requestedAt: string;
}

Contract members

Member	Kind	Signature	Description
findingHash	property	findingHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
repairId	property	repairId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
requestedAt	property	requestedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
requestedBy	property	requestedBy: string	Public property; its type, readonly modifier and optionality are shown in the signature.
requestedRevision	property	requestedRevision: string	Public property; its type, readonly modifier and optionality are shown in the signature.
version	property	version: "1.0.0"	Public property; its type, readonly modifier and optionality are shown in the signature.

RuntimeIntegrityRepairEvidence

Runtime Integrity Repair Evidence interface with 8 public fields or methods.

• Kind: interface
• Import: import type { RuntimeIntegrityRepairEvidence } from '@codesoul-co/hypha-core';
• Source module: contracts/runtime-integrity-audit

Declaration

export interface RuntimeIntegrityRepairEvidence {
    version: '1.0.0';
    repairId: string;
    findingHash: string;
    repairedRevision: string;
    evidenceRef: string;
    evidenceHash: string;
    repairedBy: string;
    repairedAt: string;
}

Contract members

Member	Kind	Signature	Description
evidenceHash	property	evidenceHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
evidenceRef	property	evidenceRef: string	Public property; its type, readonly modifier and optionality are shown in the signature.
findingHash	property	findingHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
repairedAt	property	repairedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
repairedBy	property	repairedBy: string	Public property; its type, readonly modifier and optionality are shown in the signature.
repairedRevision	property	repairedRevision: string	Public property; its type, readonly modifier and optionality are shown in the signature.
repairId	property	repairId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
version	property	version: "1.0.0"	Public property; its type, readonly modifier and optionality are shown in the signature.

RuntimeIntegrityRepairPort

Runtime Integrity Repair Port interface with 1 public fields or methods.

• Kind: interface
• Import: import type { RuntimeIntegrityRepairPort } from '@codesoul-co/hypha-core';
• Source module: contracts/runtime-integrity-audit

Declaration

export interface RuntimeIntegrityRepairPort {
    repair(command: RuntimeIntegrityRepairCommand): Promise<RuntimeIntegrityRepairResult>;
}

Contract members

Member	Kind	Signature	Description
repair	method	repair(command: RuntimeIntegrityRepairCommand): Promise<RuntimeIntegrityRepairResult>	Public method; parameters and return type are shown in the signature.

RuntimeIntegrityRepairResult

Runtime Integrity Repair Result interface with 3 public fields or methods.

• Kind: interface
• Import: import type { RuntimeIntegrityRepairResult } from '@codesoul-co/hypha-core';
• Source module: contracts/runtime-integrity-audit

Declaration

export interface RuntimeIntegrityRepairResult {
    evidenceRef: string;
    evidenceHash: string;
    repairedRevision: string;
}

Contract members

Member	Kind	Signature	Description
evidenceHash	property	evidenceHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
evidenceRef	property	evidenceRef: string	Public property; its type, readonly modifier and optionality are shown in the signature.
repairedRevision	property	repairedRevision: string	Public property; its type, readonly modifier and optionality are shown in the signature.

RuntimeIntegrityStore

Runtime Integrity Store interface with 4 public fields or methods.

• Kind: interface
• Import: import type { RuntimeIntegrityStore } from '@codesoul-co/hypha-core';
• Source module: contracts/runtime-integrity-audit

Declaration

export interface RuntimeIntegrityStore {
    getWatermark(): Promise<RuntimeIntegrityWatermark | null>;
    putWatermark(watermark: RuntimeIntegrityWatermark, expectedLastGlobalSequence: number | null): Promise<void>;
    getRepair(repairId: string): Promise<RuntimeIntegrityRepairEvidence | null>;
    putRepair(evidence: RuntimeIntegrityRepairEvidence): Promise<void>;
}

Contract members

Member	Kind	Signature	Description
getRepair	method	getRepair(repairId: string): Promise<RuntimeIntegrityRepairEvidence | null>	Public method; parameters and return type are shown in the signature.
getWatermark	method	getWatermark(): Promise<RuntimeIntegrityWatermark | null>	Public method; parameters and return type are shown in the signature.
putRepair	method	putRepair(evidence: RuntimeIntegrityRepairEvidence): Promise<void>	Public method; parameters and return type are shown in the signature.
putWatermark	method	putWatermark(watermark: RuntimeIntegrityWatermark, expectedLastGlobalSequence: number | null): Promise<void>	Public method; parameters and return type are shown in the signature.

RuntimeIntegrityWatermark

Runtime Integrity Watermark interface with 7 public fields or methods.

• Kind: interface
• Import: import type { RuntimeIntegrityWatermark } from '@codesoul-co/hypha-core';
• Source module: contracts/runtime-integrity-audit

Declaration

export interface RuntimeIntegrityWatermark {
    version: '1.0.0';
    lastGlobalSequence: number;
    projectionRevision: string;
    schemaCatalogHash: string;
    streamFingerprintRevision: string;
    reportHash: string;
    auditedAt: string;
}

Contract members

Member	Kind	Signature	Description
auditedAt	property	auditedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
lastGlobalSequence	property	lastGlobalSequence: number	Public property; its type, readonly modifier and optionality are shown in the signature.
projectionRevision	property	projectionRevision: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reportHash	property	reportHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
schemaCatalogHash	property	schemaCatalogHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
streamFingerprintRevision	property	streamFingerprintRevision: string	Public property; its type, readonly modifier and optionality are shown in the signature.
version	property	version: "1.0.0"	Public property; its type, readonly modifier and optionality are shown in the signature.

ScanCanonicalEventsRequest

Scan Canonical Events Request interface with 3 public fields or methods.

• Kind: interface
• Import: import type { ScanCanonicalEventsRequest } from '@codesoul-co/hypha-core';
• Source module: contracts/runtime-integrity-audit

Declaration

export interface ScanCanonicalEventsRequest {
    afterGlobalSequence: number;
    limit: number;
    maxBytes: number;
}

Contract members

Member	Kind	Signature	Description
afterGlobalSequence	property	afterGlobalSequence: number	Public property; its type, readonly modifier and optionality are shown in the signature.
limit	property	limit: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxBytes	property	maxBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.

ScanCanonicalEventsResult

Scan Canonical Events Result interface with 4 public fields or methods.

• Kind: interface
• Import: import type { ScanCanonicalEventsResult } from '@codesoul-co/hypha-core';
• Source module: contracts/runtime-integrity-audit

Declaration

export interface ScanCanonicalEventsResult {
    events: PersistedFrameworkEvent[];
    scannedBytes: number;
    lastGlobalSequence: number;
    hasMore: boolean;
}

Contract members

Member	Kind	Signature	Description
events	property	events: PersistedFrameworkEvent<unknown>[]	Public property; its type, readonly modifier and optionality are shown in the signature.
hasMore	property	hasMore: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
lastGlobalSequence	property	lastGlobalSequence: number	Public property; its type, readonly modifier and optionality are shown in the signature.
scannedBytes	property	scannedBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.