@codesoul-co/hypha-memory / integration-contracts

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/integration-contracts.ts
• Exports: 32

Using this module

Use the Integration contracts module for declaring and runtime-validating contracts. It exports 2 classes, 8 functions, 20 interfaces, 2 types.

Import from the package entrypoint

import {
  DefaultMemoryActivityPort,
  MemoryContextInferenceBridge,
  createContextBuildActivityHandler,
  createDomainMemoryDependencySnapshot,
  createMemoryCacheValidityInput,
  createMemorySearchActivityHandler,
  memoryCacheValidityHash,
  memoryRecordVersionSetHash,
} from '@codesoul-co/hypha-memory';

import type {
  DefaultMemoryActivityPortOptions,
  DomainMemoryDependencySnapshot,
  InferenceContextInput,
  InferenceContextPort,
  MemoryActivityHarnessHook,
  MemoryActivityObserver,
  MemoryActivityPolicyDecision,
  MemoryActivityPolicyPort,
} from '@codesoul-co/hypha-memory';

// The complete export list is documented below.

Usage patterns

• Use the 22 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 2 classes as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
• The module exposes 8 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
DefaultMemoryActivityPort	class	new DefaultMemoryActivityPort(options: DefaultMemoryActivityPortOptions): DefaultMemoryActivityPort	Default Memory Activity Port class with 3 public constructor or member entries; its exact declarations are listed below.
MemoryContextInferenceBridge	class	new MemoryContextInferenceBridge(activities: MemoryActivityPort, inference: InferenceContextPort): MemoryContextInferenceBridge	Memory Context Inference Bridge class with 2 public constructor or member entries; its exact declarations are listed below.
createContextBuildActivityHandler	function	createContextBuildActivityHandler(builder: MemoryContextBuilder, gateway: ContextInjectionGateway): MemoryActivityHandler	Create Context Build Activity Handler function with 1 public call signature; parameters and return types are listed below.
createDomainMemoryDependencySnapshot	function	createDomainMemoryDependencySnapshot(input: Omit<DomainMemoryDependencySnapshot, "dependencyHash" | "createdAt">, now?: string): DomainMemoryDependencySnapshot	Create Domain Memory Dependency Snapshot function with 1 public call signature; parameters and return types are listed below.
createMemoryCacheValidityInput	function	createMemoryCacheValidityInput(input: Omit<MemoryCacheValidityInput, "scopeHash"> & { scope: ManagedMemoryScope; }): MemoryCacheValidityInput	Create Memory Cache Validity Input function with 1 public call signature; parameters and return types are listed below.
createMemorySearchActivityHandler	function	createMemorySearchActivityHandler(provider: MemoryManagementProvider): MemoryActivityHandler	Create Memory Search Activity Handler function with 1 public call signature; parameters and return types are listed below.
memoryCacheValidityHash	function	memoryCacheValidityHash(input: MemoryCacheValidityInput): string	Memory Cache Validity Hash function with 1 public call signature; parameters and return types are listed below.
memoryRecordVersionSetHash	function	memoryRecordVersionSetHash(versionIds: string[]): string	Memory Record Version Set Hash function with 1 public call signature; parameters and return types are listed below.
validateMemoryBindingCapabilities	function	validateMemoryBindingCapabilities(binding: WorkflowStateMemoryBinding, capabilities: MemoryManagementCapabilities): string[]	Validate Memory Binding Capabilities function with 1 public call signature; parameters and return types are listed below.
validateMemoryProfileCapabilities	function	validateMemoryProfileCapabilities(profile: MemoryProfileSpec, capabilities: MemoryManagementCapabilities): string[]	Validate Memory Profile Capabilities function with 1 public call signature; parameters and return types are listed below.
DefaultMemoryActivityPortOptions	interface	interface DefaultMemoryActivityPortOptions	Default Memory Activity Port Options interface with 4 public fields or methods.
DomainMemoryDependencySnapshot	interface	interface DomainMemoryDependencySnapshot	Domain Memory Dependency Snapshot interface with 10 public fields or methods.
InferenceContextInput	interface	interface InferenceContextInput	Inference Context Input interface with 3 public fields or methods.
InferenceContextPort	interface	interface InferenceContextPort	Inference Context Port interface with 1 public fields or methods.
MemoryActivityHarnessHook	interface	interface MemoryActivityHarnessHook	Memory Activity Harness Hook interface with 2 public fields or methods.
MemoryActivityObserver	interface	interface MemoryActivityObserver	Memory Activity Observer interface with 3 public fields or methods.
MemoryActivityPolicyDecision	interface	interface MemoryActivityPolicyDecision	Memory Activity Policy Decision interface with 3 public fields or methods.
MemoryActivityPolicyPort	interface	interface MemoryActivityPolicyPort	Memory Activity Policy Port interface with 1 public fields or methods.
MemoryActivityPort	interface	interface MemoryActivityPort	Memory Activity Port interface with 1 public fields or methods.
MemoryActivityRequest	interface	interface MemoryActivityRequest	Memory Activity Request interface with 9 public fields or methods.
MemoryActivityResult	interface	interface MemoryActivityResult	Memory Activity Result interface with 8 public fields or methods.
MemoryCacheInvalidation	interface	interface MemoryCacheInvalidation	Memory Cache Invalidation interface with 7 public fields or methods.
MemoryCacheValidityInput	interface	interface MemoryCacheValidityInput	Memory Cache Validity Input interface with 10 public fields or methods.
MemoryContextInferenceResult	interface	interface MemoryContextInferenceResult	Memory Context Inference Result interface with 2 public fields or methods.
MemoryEvaluationCase	interface	interface MemoryEvaluationCase	Memory Evaluation Case interface with 6 public fields or methods.
MemoryEvaluationObservation	interface	interface MemoryEvaluationObservation	Memory Evaluation Observation interface with 7 public fields or methods.
MemoryEvaluationPort	interface	interface MemoryEvaluationPort	Memory Evaluation Port interface with 1 public fields or methods.
MemoryReplayReference	interface	interface MemoryReplayReference	Memory Replay Reference interface with 7 public fields or methods.
SessionMemoryBinding	interface	interface SessionMemoryBinding	Session Memory Binding interface with 4 public fields or methods.
WorkflowStateMemoryBinding	interface	interface WorkflowStateMemoryBinding	Workflow State Memory Binding interface with 8 public fields or methods.
MemoryActivityHandler	type	type MemoryActivityHandler = (request: MemoryActivityRequest, signal?: AbortSignal) => Promise<Omit<MemoryActivityResult, 'operationId'>>	Public type alias for Memory Activity Handler; the declaration contains its complete type expression.
MemoryActivityOperation	type	type MemoryActivityOperation = 'add' | 'extract' | 'search' | 'get' | 'list' | 'update' | 'write' | 'maintain' | 'delete' | 'history' | 'build_context'	Public type alias for Memory Activity Operation; the declaration contains its complete type expression.

DefaultMemoryActivityPort

Default Memory Activity Port class with 3 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DefaultMemoryActivityPort } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export declare class DefaultMemoryActivityPort implements MemoryActivityPort {
    constructor(options: DefaultMemoryActivityPortOptions);
    register(operation: MemoryActivityOperation, handler: MemoryActivityHandler): this;
    execute(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryActivityResult>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: DefaultMemoryActivityPortOptions): DefaultMemoryActivityPort	Creates an instance of this class.
execute	method	execute(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryActivityResult>	Public method; parameters and return type are shown in the signature.
register	method	register(operation: MemoryActivityOperation, handler: MemoryActivityHandler): DefaultMemoryActivityPort	Public method; parameters and return type are shown in the signature.

MemoryContextInferenceBridge

Memory Context Inference Bridge class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { MemoryContextInferenceBridge } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export declare class MemoryContextInferenceBridge {
    constructor(activities: MemoryActivityPort, inference: InferenceContextPort);
    execute(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryContextInferenceResult>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(activities: MemoryActivityPort, inference: InferenceContextPort): MemoryContextInferenceBridge	Creates an instance of this class.
execute	method	execute(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryContextInferenceResult>	Public method; parameters and return type are shown in the signature.

createContextBuildActivityHandler

Create Context Build Activity Handler function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { createContextBuildActivityHandler } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export declare function createContextBuildActivityHandler(builder: MemoryContextBuilder, gateway: ContextInjectionGateway): MemoryActivityHandler;

Call signature

createContextBuildActivityHandler(builder: MemoryContextBuilder, gateway: ContextInjectionGateway): MemoryActivityHandler

Parameters

Parameter	Type	Required	Description
builder	MemoryContextBuilder	Yes	Required parameter; accepted values are defined by the type column.
gateway	ContextInjectionGateway	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: MemoryActivityHandler
• Description: The return contract is defined by the type shown above.

createDomainMemoryDependencySnapshot

Create Domain Memory Dependency Snapshot function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { createDomainMemoryDependencySnapshot } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export declare function createDomainMemoryDependencySnapshot(input: Omit<DomainMemoryDependencySnapshot, 'dependencyHash' | 'createdAt'>, now?: string): DomainMemoryDependencySnapshot;

Call signature

createDomainMemoryDependencySnapshot(input: Omit<DomainMemoryDependencySnapshot, "dependencyHash" | "createdAt">, now?: string): DomainMemoryDependencySnapshot

Parameters

Parameter	Type	Required	Description
input	Omit<DomainMemoryDependencySnapshot, "createdAt" | "dependencyHash">	Yes	Required parameter; accepted values are defined by the type column.
now	string	No	Optional parameter; accepted values are defined by the type column.

Returns

• Type: DomainMemoryDependencySnapshot
• Description: The return contract is defined by the type shown above.

createMemoryCacheValidityInput

Create Memory Cache Validity Input function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { createMemoryCacheValidityInput } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export declare function createMemoryCacheValidityInput(input: Omit<MemoryCacheValidityInput, 'scopeHash'> & {
    scope: ManagedMemoryScope;
}): MemoryCacheValidityInput;

Call signature

createMemoryCacheValidityInput(input: Omit<MemoryCacheValidityInput, "scopeHash"> & { scope: ManagedMemoryScope; }): MemoryCacheValidityInput

Parameters

Parameter	Type	Required	Description
input	Omit<MemoryCacheValidityInput, "scopeHash"> & { scope: ManagedMemoryScope; }	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: MemoryCacheValidityInput
• Description: The return contract is defined by the type shown above.

createMemorySearchActivityHandler

Create Memory Search Activity Handler function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { createMemorySearchActivityHandler } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export declare function createMemorySearchActivityHandler(provider: MemoryManagementProvider): MemoryActivityHandler;

Call signature

createMemorySearchActivityHandler(provider: MemoryManagementProvider): MemoryActivityHandler

Parameters

Parameter	Type	Required	Description
provider	MemoryManagementProvider	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: MemoryActivityHandler
• Description: The return contract is defined by the type shown above.

memoryCacheValidityHash

Memory Cache Validity Hash function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { memoryCacheValidityHash } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export declare function memoryCacheValidityHash(input: MemoryCacheValidityInput): string;

Call signature

memoryCacheValidityHash(input: MemoryCacheValidityInput): string

Parameters

Parameter	Type	Required	Description
input	MemoryCacheValidityInput	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: string
• Description: The return contract is defined by the type shown above.

memoryRecordVersionSetHash

Memory Record Version Set Hash function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { memoryRecordVersionSetHash } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export declare function memoryRecordVersionSetHash(versionIds: string[]): string;

Call signature

memoryRecordVersionSetHash(versionIds: string[]): string

Parameters

Parameter	Type	Required	Description
versionIds	string[]	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: string
• Description: The return contract is defined by the type shown above.

validateMemoryBindingCapabilities

Validate Memory Binding Capabilities function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateMemoryBindingCapabilities } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export declare function validateMemoryBindingCapabilities(binding: WorkflowStateMemoryBinding, capabilities: MemoryManagementCapabilities): string[];

Call signature

validateMemoryBindingCapabilities(binding: WorkflowStateMemoryBinding, capabilities: MemoryManagementCapabilities): string[]

Parameters

Parameter	Type	Required	Description
binding	WorkflowStateMemoryBinding	Yes	Required parameter; accepted values are defined by the type column.
capabilities	MemoryManagementCapabilities	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: string[]
• Description: The return contract is defined by the type shown above.

validateMemoryProfileCapabilities

Validate Memory Profile Capabilities function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateMemoryProfileCapabilities } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export declare function validateMemoryProfileCapabilities(profile: MemoryProfileSpec, capabilities: MemoryManagementCapabilities): string[];

Call signature

validateMemoryProfileCapabilities(profile: MemoryProfileSpec, capabilities: MemoryManagementCapabilities): string[]

Parameters

Parameter	Type	Required	Description
profile	MemoryProfileSpec	Yes	Required parameter; accepted values are defined by the type column.
capabilities	MemoryManagementCapabilities	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: string[]
• Description: The return contract is defined by the type shown above.

DefaultMemoryActivityPortOptions

Default Memory Activity Port Options interface with 4 public fields or methods.

• Kind: interface
• Import: import type { DefaultMemoryActivityPortOptions } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface DefaultMemoryActivityPortOptions {
    policy: MemoryActivityPolicyPort;
    events: MemoryEventPublisher;
    harness: MemoryActivityHarnessHook;
    observers?: MemoryActivityObserver[];
}

Contract members

Member	Kind	Signature	Description
events	property	events: MemoryEventPublisher	Public property; its type, readonly modifier and optionality are shown in the signature.
harness	property	harness: MemoryActivityHarnessHook	Public property; its type, readonly modifier and optionality are shown in the signature.
observers	property	observers?: MemoryActivityObserver[]	Public property; its type, readonly modifier and optionality are shown in the signature.
policy	property	policy: MemoryActivityPolicyPort	Public property; its type, readonly modifier and optionality are shown in the signature.

DomainMemoryDependencySnapshot

Domain Memory Dependency Snapshot interface with 10 public fields or methods.

• Kind: interface
• Import: import type { DomainMemoryDependencySnapshot } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface DomainMemoryDependencySnapshot {
    domainPackRef: SpecRef;
    memoryProfileRef?: SpecRef;
    contextProfileRef?: SpecRef;
    extractionProfileRef?: SpecRef;
    providerRefs: SpecRef[];
    policyRefs: SpecRef[];
    scopeTemplate?: Partial<ManagedMemoryScope>;
    capabilitySnapshot: Partial<MemoryManagementCapabilities>;
    dependencyHash: string;
    createdAt: string;
}

Contract members

Member	Kind	Signature	Description
capabilitySnapshot	property	capabilitySnapshot: Partial<MemoryManagementCapabilities>	Public property; its type, readonly modifier and optionality are shown in the signature.
contextProfileRef	property	contextProfileRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAt	property	createdAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
dependencyHash	property	dependencyHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
domainPackRef	property	domainPackRef: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
extractionProfileRef	property	extractionProfileRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryProfileRef	property	memoryProfileRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
policyRefs	property	policyRefs: SpecRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
providerRefs	property	providerRefs: SpecRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
scopeTemplate	property	scopeTemplate?: Partial<ManagedMemoryScope>	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceContextInput

Inference Context Input interface with 3 public fields or methods.

• Kind: interface
• Import: import type { InferenceContextInput } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface InferenceContextInput {
    envelope: ContextEnvelope;
    contextHash: string;
    provenanceRequired: boolean;
}

Contract members

Member	Kind	Signature	Description
contextHash	property	contextHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
envelope	property	envelope: ContextEnvelope	Public property; its type, readonly modifier and optionality are shown in the signature.
provenanceRequired	property	provenanceRequired: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceContextPort

Inference Context Port interface with 1 public fields or methods.

• Kind: interface
• Import: import type { InferenceContextPort } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface InferenceContextPort<TOutput = unknown> {
    invoke(input: InferenceContextInput, signal?: AbortSignal): Promise<TOutput>;
}

Contract members

Member	Kind	Signature	Description
invoke	method	invoke(input: InferenceContextInput, signal?: AbortSignal): Promise<TOutput>	Public method; parameters and return type are shown in the signature.

MemoryActivityHarnessHook

Memory Activity Harness Hook interface with 2 public fields or methods.

• Kind: interface
• Import: import type { MemoryActivityHarnessHook } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryActivityHarnessHook {
    beforeExecute(request: MemoryActivityRequest, signal: AbortSignal): void | Promise<void>;
    afterExecute(request: MemoryActivityRequest, result: MemoryActivityResult): void | Promise<void>;
}

Contract members

Member	Kind	Signature	Description
afterExecute	method	afterExecute(request: MemoryActivityRequest, result: MemoryActivityResult): void | Promise<void>	Public method; parameters and return type are shown in the signature.
beforeExecute	method	beforeExecute(request: MemoryActivityRequest, signal: AbortSignal): void | Promise<void>	Public method; parameters and return type are shown in the signature.

MemoryActivityObserver

Memory Activity Observer interface with 3 public fields or methods.

• Kind: interface
• Import: import type { MemoryActivityObserver } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryActivityObserver {
    onStarted?(request: MemoryActivityRequest): void | Promise<void>;
    onCompleted?(request: MemoryActivityRequest, result: MemoryActivityResult): void | Promise<void>;
    onFailed?(request: MemoryActivityRequest, result: MemoryActivityResult): void | Promise<void>;
}

Contract members

Member	Kind	Signature	Description
onCompleted	method	onCompleted?(request: MemoryActivityRequest, result: MemoryActivityResult): void | Promise<void>	Public method; parameters and return type are shown in the signature.
onFailed	method	onFailed?(request: MemoryActivityRequest, result: MemoryActivityResult): void | Promise<void>	Public method; parameters and return type are shown in the signature.
onStarted	method	onStarted?(request: MemoryActivityRequest): void | Promise<void>	Public method; parameters and return type are shown in the signature.

MemoryActivityPolicyDecision

Memory Activity Policy Decision interface with 3 public fields or methods.

• Kind: interface
• Import: import type { MemoryActivityPolicyDecision } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryActivityPolicyDecision {
    allowed: boolean;
    reason?: string;
    policyRevision?: string;
}

Contract members

Member	Kind	Signature	Description
allowed	property	allowed: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
policyRevision	property	policyRevision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryActivityPolicyPort

Memory Activity Policy Port interface with 1 public fields or methods.

• Kind: interface
• Import: import type { MemoryActivityPolicyPort } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryActivityPolicyPort {
    authorize(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryActivityPolicyDecision>;
}

Contract members

Member	Kind	Signature	Description
authorize	method	authorize(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryActivityPolicyDecision>	Public method; parameters and return type are shown in the signature.

MemoryActivityPort

Memory Activity Port interface with 1 public fields or methods.

• Kind: interface
• Import: import type { MemoryActivityPort } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryActivityPort {
    execute(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryActivityResult>;
}

Contract members

Member	Kind	Signature	Description
execute	method	execute(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryActivityResult>	Public method; parameters and return type are shown in the signature.

MemoryActivityRequest

Memory Activity Request interface with 9 public fields or methods.

• Kind: interface
• Import: import type { MemoryActivityRequest } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryActivityRequest {
    operationId: string;
    operation: MemoryActivityOperation;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    profileRef: SpecRef;
    eventContext: MemoryEventContext;
    payload: unknown;
    timeoutMs?: number;
    idempotencyKey?: string;
}

Contract members

Member	Kind	Signature	Description
eventContext	property	eventContext: MemoryEventContext	Public property; its type, readonly modifier and optionality are shown in the signature.
idempotencyKey	property	idempotencyKey?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operation	property	operation: MemoryActivityOperation	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
payload	property	payload: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: MemoryPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
profileRef	property	profileRef: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: ManagedMemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.
timeoutMs	property	timeoutMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryActivityResult

Memory Activity Result interface with 8 public fields or methods.

• Kind: interface
• Import: import type { MemoryActivityResult } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryActivityResult {
    operationId: string;
    status: 'completed' | 'failed' | 'cancelled' | 'partial';
    memoryRefs?: string[];
    contextEnvelopeRef?: string;
    eventIds: string[];
    error?: NormalizedMemoryError;
    evidence?: MemoryProviderReturnEvidence;
    output?: unknown;
}

Contract members

Member	Kind	Signature	Description
contextEnvelopeRef	property	contextEnvelopeRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
error	property	error?: NormalizedMemoryError	Public property; its type, readonly modifier and optionality are shown in the signature.
eventIds	property	eventIds: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
evidence	property	evidence?: MemoryProviderReturnEvidence	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryRefs	property	memoryRefs?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
output	property	output?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
status	property	status: "completed" | "cancelled" | "failed" | "partial"	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryCacheInvalidation

Memory Cache Invalidation interface with 7 public fields or methods.

• Kind: interface
• Import: import type { MemoryCacheInvalidation } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryCacheInvalidation {
    operationId: string;
    scopeHash: string;
    reason: 'created' | 'updated' | 'invalidated' | 'deleted' | 'provider_revision';
    memoryIds: string[];
    memoryVersionIds?: string[];
    mutationGeneration: string;
    validityHash: string;
}

Contract members

Member	Kind	Signature	Description
memoryIds	property	memoryIds: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryVersionIds	property	memoryVersionIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
mutationGeneration	property	mutationGeneration: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason: "created" | "invalidated" | "deleted" | "updated" | "provider_revision"	Public property; its type, readonly modifier and optionality are shown in the signature.
scopeHash	property	scopeHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
validityHash	property	validityHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryCacheValidityInput

Memory Cache Validity Input interface with 10 public fields or methods.

• Kind: interface
• Import: import type { MemoryCacheValidityInput } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryCacheValidityInput {
    memoryProfileRevision: string;
    mutationGeneration: string;
    contextProfileRevision?: string;
    scopeHash: string;
    queryHash?: string;
    recordSetRevision?: string;
    selectedMemoryVersionIds?: string[];
    providerRevision?: string;
    embeddingRevision?: string;
    policyRevision?: string;
}

Contract members

Member	Kind	Signature	Description
contextProfileRevision	property	contextProfileRevision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
embeddingRevision	property	embeddingRevision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryProfileRevision	property	memoryProfileRevision: string	Public property; its type, readonly modifier and optionality are shown in the signature.
mutationGeneration	property	mutationGeneration: string	Public property; its type, readonly modifier and optionality are shown in the signature.
policyRevision	property	policyRevision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
providerRevision	property	providerRevision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
queryHash	property	queryHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
recordSetRevision	property	recordSetRevision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
scopeHash	property	scopeHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
selectedMemoryVersionIds	property	selectedMemoryVersionIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryContextInferenceResult

Memory Context Inference Result interface with 2 public fields or methods.

• Kind: interface
• Import: import type { MemoryContextInferenceResult } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryContextInferenceResult<TOutput = unknown> {
    activity: MemoryActivityResult;
    inferenceOutput: TOutput;
}

Contract members

Member	Kind	Signature	Description
activity	property	activity: MemoryActivityResult	Public property; its type, readonly modifier and optionality are shown in the signature.
inferenceOutput	property	inferenceOutput: TOutput	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryEvaluationCase

Memory Evaluation Case interface with 6 public fields or methods.

• Kind: interface
• Import: import type { MemoryEvaluationCase } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryEvaluationCase {
    id: string;
    category: 'extraction' | 'retrieval' | 'context' | 'lifecycle';
    inputRef: string;
    expectedRef?: string;
    metricIds: string[];
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
category	property	category: "lifecycle" | "context" | "extraction" | "retrieval"	Public property; its type, readonly modifier and optionality are shown in the signature.
expectedRef	property	expectedRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
inputRef	property	inputRef: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
metricIds	property	metricIds: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryEvaluationObservation

Memory Evaluation Observation interface with 7 public fields or methods.

• Kind: interface
• Import: import type { MemoryEvaluationObservation } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryEvaluationObservation {
    caseId: string;
    operationId: string;
    traceEventIds: string[];
    memoryVersionIds?: string[];
    retrievalSnapshotId?: string;
    contextHash?: string;
    metrics?: Record<string, number>;
}

Contract members

Member	Kind	Signature	Description
caseId	property	caseId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
contextHash	property	contextHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryVersionIds	property	memoryVersionIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
metrics	property	metrics?: Record<string, number>	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
retrievalSnapshotId	property	retrievalSnapshotId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
traceEventIds	property	traceEventIds: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryEvaluationPort

Memory Evaluation Port interface with 1 public fields or methods.

• Kind: interface
• Import: import type { MemoryEvaluationPort } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryEvaluationPort {
    record(observation: MemoryEvaluationObservation): Promise<void>;
}

Contract members

Member	Kind	Signature	Description
record	method	record(observation: MemoryEvaluationObservation): Promise<void>	Public method; parameters and return type are shown in the signature.

MemoryReplayReference

Memory Replay Reference interface with 7 public fields or methods.

• Kind: interface
• Import: import type { MemoryReplayReference } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface MemoryReplayReference {
    operationId: string;
    profileRevision: string;
    scopeHash: string;
    eventIds: string[];
    memoryVersionIds: string[];
    retrievalSnapshotId?: string;
    contextHash?: string;
}

Contract members

Member	Kind	Signature	Description
contextHash	property	contextHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
eventIds	property	eventIds: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryVersionIds	property	memoryVersionIds: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
profileRevision	property	profileRevision: string	Public property; its type, readonly modifier and optionality are shown in the signature.
retrievalSnapshotId	property	retrievalSnapshotId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
scopeHash	property	scopeHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.

SessionMemoryBinding

Session Memory Binding interface with 4 public fields or methods.

• Kind: interface
• Import: import type { SessionMemoryBinding } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface SessionMemoryBinding {
    memoryProfileRef?: SpecRef;
    contextProfileRef?: SpecRef;
    memoryScopeTemplate?: Partial<ManagedMemoryScope>;
    sessionScopeMode?: 'isolated' | 'user_shared' | 'workspace_shared';
}

Contract members

Member	Kind	Signature	Description
contextProfileRef	property	contextProfileRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryProfileRef	property	memoryProfileRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryScopeTemplate	property	memoryScopeTemplate?: Partial<ManagedMemoryScope>	Public property; its type, readonly modifier and optionality are shown in the signature.
sessionScopeMode	property	sessionScopeMode?: "isolated" | "user_shared" | "workspace_shared"	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkflowStateMemoryBinding

Workflow State Memory Binding interface with 8 public fields or methods.

• Kind: interface
• Import: import type { WorkflowStateMemoryBinding } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export interface WorkflowStateMemoryBinding {
    memoryProfileRef?: SpecRef;
    contextProfileRef?: SpecRef;
    extractionProfileRef?: SpecRef;
    readPolicyRef?: SpecRef;
    writePolicyRef?: SpecRef;
    allowedMemoryTypes?: ManagedMemoryType[];
    memoryAccessMode?: 'none' | 'read' | 'write' | 'read_write';
    autoCapture?: boolean;
}

Contract members

Member	Kind	Signature	Description
allowedMemoryTypes	property	allowedMemoryTypes?: ManagedMemoryType[]	Public property; its type, readonly modifier and optionality are shown in the signature.
autoCapture	property	autoCapture?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
contextProfileRef	property	contextProfileRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
extractionProfileRef	property	extractionProfileRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryAccessMode	property	memoryAccessMode?: "none" | "read" | "write" | "read_write"	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryProfileRef	property	memoryProfileRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
readPolicyRef	property	readPolicyRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
writePolicyRef	property	writePolicyRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryActivityHandler

Public type alias for Memory Activity Handler; the declaration contains its complete type expression.

• Kind: type
• Import: import type { MemoryActivityHandler } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export type MemoryActivityHandler = (request: MemoryActivityRequest, signal?: AbortSignal) => Promise<Omit<MemoryActivityResult, 'operationId'>>;

MemoryActivityOperation

Public type alias for Memory Activity Operation; the declaration contains its complete type expression.

• Kind: type
• Import: import type { MemoryActivityOperation } from '@codesoul-co/hypha-memory';
• Source module: integration-contracts

Declaration

export type MemoryActivityOperation = 'add' | 'extract' | 'search' | 'get' | 'list' | 'update' | 'write' | 'maintain' | 'delete' | 'history' | 'build_context';