@codesoul-co/hypha-memory / memory-server-migration-acceptance

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/memory-server-migration-acceptance.ts
• Exports: 12

Using this module

Use the Memory server migration acceptance module for using the public contracts and operations for this capability boundary. It exports 4 functions, 8 interfaces.

Import from the package entrypoint

import {
  runCanonicalConsumerMigrationAcceptance,
  runMemoryServerMigrationAcceptance,
  runPermanentMemoryMigrationAcceptance,
  runRedisWorkingMemoryMigrationAcceptance,
} from '@codesoul-co/hypha-memory';

import type {
  CanonicalMemoryConsumerObservation,
  MemoryMigrationObservationPort,
  MemoryServerMigrationAcceptancePorts,
  MemoryServerMigrationAcceptanceReport,
  MemoryServerMigrationFinding,
  MemoryServerMigrationSuiteReport,
  PermanentMemoryFailureObservation,
  RedisWorkingMemoryObservation,
} from '@codesoul-co/hypha-memory';

Usage patterns

• Use the 8 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 4 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
runCanonicalConsumerMigrationAcceptance	function	runCanonicalConsumerMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts["canonicalConsumer"], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>	Run Canonical Consumer Migration Acceptance function with 1 public call signature; parameters and return types are listed below.
runMemoryServerMigrationAcceptance	function	runMemoryServerMigrationAcceptance(ports: MemoryServerMigrationAcceptancePorts, acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationAcceptanceReport>	Run Memory Server Migration Acceptance function with 1 public call signature; parameters and return types are listed below.
runPermanentMemoryMigrationAcceptance	function	runPermanentMemoryMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts["permanentMemory"], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>	Run Permanent Memory Migration Acceptance function with 1 public call signature; parameters and return types are listed below.
runRedisWorkingMemoryMigrationAcceptance	function	runRedisWorkingMemoryMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts["redisWorkingMemory"], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>	Run Redis Working Memory Migration Acceptance function with 1 public call signature; parameters and return types are listed below.
CanonicalMemoryConsumerObservation	interface	interface CanonicalMemoryConsumerObservation	Canonical Memory Consumer Observation interface with 9 public fields or methods.
MemoryMigrationObservationPort	interface	interface MemoryMigrationObservationPort	Memory Migration Observation Port interface with 1 public fields or methods.
MemoryServerMigrationAcceptancePorts	interface	interface MemoryServerMigrationAcceptancePorts	Memory Server Migration Acceptance Ports interface with 3 public fields or methods.
MemoryServerMigrationAcceptanceReport	interface	interface MemoryServerMigrationAcceptanceReport	Memory Server Migration Acceptance Report interface with 3 public fields or methods.
MemoryServerMigrationFinding	interface	interface MemoryServerMigrationFinding	Memory Server Migration Finding interface with 3 public fields or methods.
MemoryServerMigrationSuiteReport	interface	interface MemoryServerMigrationSuiteReport	Memory Server Migration Suite Report interface with 3 public fields or methods.
PermanentMemoryFailureObservation	interface	interface PermanentMemoryFailureObservation	Permanent Memory Failure Observation interface with 4 public fields or methods.
RedisWorkingMemoryObservation	interface	interface RedisWorkingMemoryObservation	Redis Working Memory Observation interface with 3 public fields or methods.

runCanonicalConsumerMigrationAcceptance

Run Canonical Consumer Migration Acceptance function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { runCanonicalConsumerMigrationAcceptance } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-acceptance

Declaration

export declare function runCanonicalConsumerMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts['canonicalConsumer'], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>;

Call signature

runCanonicalConsumerMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts["canonicalConsumer"], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>

Parameters

Parameter	Type	Required	Description
port	MemoryMigrationObservationPort<CanonicalMemoryConsumerObservation>	Yes	Required parameter; accepted values are defined by the type column.
acceptance	MemoryServerMigrationAcceptance	No	Optional parameter; accepted values are defined by the type column.

Returns

• Type: Promise<MemoryServerMigrationSuiteReport>
• Description: The return contract is defined by the type shown above.

runMemoryServerMigrationAcceptance

Run Memory Server Migration Acceptance function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { runMemoryServerMigrationAcceptance } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-acceptance

Declaration

export declare function runMemoryServerMigrationAcceptance(ports: MemoryServerMigrationAcceptancePorts, acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationAcceptanceReport>;

Call signature

runMemoryServerMigrationAcceptance(ports: MemoryServerMigrationAcceptancePorts, acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationAcceptanceReport>

Parameters

Parameter	Type	Required	Description
ports	MemoryServerMigrationAcceptancePorts	Yes	Required parameter; accepted values are defined by the type column.
acceptance	MemoryServerMigrationAcceptance	No	Optional parameter; accepted values are defined by the type column.

Returns

• Type: Promise<MemoryServerMigrationAcceptanceReport>
• Description: The return contract is defined by the type shown above.

runPermanentMemoryMigrationAcceptance

Run Permanent Memory Migration Acceptance function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { runPermanentMemoryMigrationAcceptance } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-acceptance

Declaration

export declare function runPermanentMemoryMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts['permanentMemory'], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>;

Call signature

runPermanentMemoryMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts["permanentMemory"], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>

Parameters

Parameter	Type	Required	Description
port	MemoryMigrationObservationPort<PermanentMemoryFailureObservation>	Yes	Required parameter; accepted values are defined by the type column.
acceptance	MemoryServerMigrationAcceptance	No	Optional parameter; accepted values are defined by the type column.

Returns

• Type: Promise<MemoryServerMigrationSuiteReport>
• Description: The return contract is defined by the type shown above.

runRedisWorkingMemoryMigrationAcceptance

Run Redis Working Memory Migration Acceptance function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { runRedisWorkingMemoryMigrationAcceptance } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-acceptance

Declaration

export declare function runRedisWorkingMemoryMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts['redisWorkingMemory'], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>;

Call signature

runRedisWorkingMemoryMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts["redisWorkingMemory"], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>

Parameters

Parameter	Type	Required	Description
port	MemoryMigrationObservationPort<RedisWorkingMemoryObservation>	Yes	Required parameter; accepted values are defined by the type column.
acceptance	MemoryServerMigrationAcceptance	No	Optional parameter; accepted values are defined by the type column.

Returns

• Type: Promise<MemoryServerMigrationSuiteReport>
• Description: The return contract is defined by the type shown above.

CanonicalMemoryConsumerObservation

Canonical Memory Consumer Observation interface with 9 public fields or methods.

• Kind: interface
• Import: import type { CanonicalMemoryConsumerObservation } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-acceptance

Declaration

export interface CanonicalMemoryConsumerObservation {
    compositionReceipt?: MemoryRuntimeCompositionReceipt;
    consumerServiceInstanceIds: Partial<Record<MemoryServerConsumer, string>>;
    serviceRegistrationCount: number;
    runtimeDependencies: readonly string[];
    unresolvedDependencyRefs: readonly string[];
    directStoreConsumers: readonly MemoryServerConsumer[];
    secondWritePaths: readonly string[];
    profileSwitches: readonly CanonicalProfileSwitchObservation[];
    legacyAdapterResponsibilities: readonly string[];
}

Contract members

Member	Kind	Signature	Description
compositionReceipt	property	compositionReceipt?: MemoryRuntimeCompositionReceipt	Public property; its type, readonly modifier and optionality are shown in the signature.
consumerServiceInstanceIds	property	consumerServiceInstanceIds: Partial<Record<MemoryServerConsumer, string>>	Public property; its type, readonly modifier and optionality are shown in the signature.
directStoreConsumers	property	directStoreConsumers: readonly MemoryServerConsumer[]	Public property; its type, readonly modifier and optionality are shown in the signature.
legacyAdapterResponsibilities	property	legacyAdapterResponsibilities: readonly string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
profileSwitches	property	profileSwitches: readonly CanonicalProfileSwitchObservation[]	Public property; its type, readonly modifier and optionality are shown in the signature.
runtimeDependencies	property	runtimeDependencies: readonly string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
secondWritePaths	property	secondWritePaths: readonly string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
serviceRegistrationCount	property	serviceRegistrationCount: number	Public property; its type, readonly modifier and optionality are shown in the signature.
unresolvedDependencyRefs	property	unresolvedDependencyRefs: readonly string[]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryMigrationObservationPort

Memory Migration Observation Port interface with 1 public fields or methods.

• Kind: interface
• Import: import type { MemoryMigrationObservationPort } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-acceptance

Declaration

export interface MemoryMigrationObservationPort<T> {
    observe(fixture: MemoryServerMigrationSharedFixture): Promise<T>;
}

Contract members

Member	Kind	Signature	Description
observe	method	observe(fixture: MemoryServerMigrationSharedFixture): Promise<T>	Public method; parameters and return type are shown in the signature.

MemoryServerMigrationAcceptancePorts

Memory Server Migration Acceptance Ports interface with 3 public fields or methods.

• Kind: interface
• Import: import type { MemoryServerMigrationAcceptancePorts } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-acceptance

Declaration

export interface MemoryServerMigrationAcceptancePorts {
    canonicalConsumer: MemoryMigrationObservationPort<CanonicalMemoryConsumerObservation>;
    redisWorkingMemory: MemoryMigrationObservationPort<RedisWorkingMemoryObservation>;
    permanentMemory: MemoryMigrationObservationPort<PermanentMemoryFailureObservation>;
}

Contract members

Member	Kind	Signature	Description
canonicalConsumer	property	canonicalConsumer: MemoryMigrationObservationPort<CanonicalMemoryConsumerObservation>	Public property; its type, readonly modifier and optionality are shown in the signature.
permanentMemory	property	permanentMemory: MemoryMigrationObservationPort<PermanentMemoryFailureObservation>	Public property; its type, readonly modifier and optionality are shown in the signature.
redisWorkingMemory	property	redisWorkingMemory: MemoryMigrationObservationPort<RedisWorkingMemoryObservation>	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryServerMigrationAcceptanceReport

Memory Server Migration Acceptance Report interface with 3 public fields or methods.

• Kind: interface
• Import: import type { MemoryServerMigrationAcceptanceReport } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-acceptance

Declaration

export interface MemoryServerMigrationAcceptanceReport {
    contractRef: MemoryServerMigrationAcceptance['contractRef'];
    passed: boolean;
    suites: readonly MemoryServerMigrationSuiteReport[];
}

Contract members

Member	Kind	Signature	Description
contractRef	property	contractRef: import("/Users/erwin/Downloads/codespace/Hypha/packages/memory/dist/contracts").MemoryContractSpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
passed	property	passed: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
suites	property	suites: readonly MemoryServerMigrationSuiteReport[]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryServerMigrationFinding

Memory Server Migration Finding interface with 3 public fields or methods.

• Kind: interface
• Import: import type { MemoryServerMigrationFinding } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-acceptance

Declaration

export interface MemoryServerMigrationFinding {
    issue: MemoryServerMigrationIssue;
    code: string;
    message: string;
}

Contract members

Member	Kind	Signature	Description
code	property	code: string	Public property; its type, readonly modifier and optionality are shown in the signature.
issue	property	issue: MemoryServerMigrationIssue	Public property; its type, readonly modifier and optionality are shown in the signature.
message	property	message: string	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryServerMigrationSuiteReport

Memory Server Migration Suite Report interface with 3 public fields or methods.

• Kind: interface
• Import: import type { MemoryServerMigrationSuiteReport } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-acceptance

Declaration

export interface MemoryServerMigrationSuiteReport {
    issue: MemoryServerMigrationIssue;
    passed: boolean;
    findings: MemoryServerMigrationFinding[];
}

Contract members

Member	Kind	Signature	Description
findings	property	findings: MemoryServerMigrationFinding[]	Public property; its type, readonly modifier and optionality are shown in the signature.
issue	property	issue: MemoryServerMigrationIssue	Public property; its type, readonly modifier and optionality are shown in the signature.
passed	property	passed: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

PermanentMemoryFailureObservation

Permanent Memory Failure Observation interface with 4 public fields or methods.

• Kind: interface
• Import: import type { PermanentMemoryFailureObservation } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-acceptance

Declaration

export interface PermanentMemoryFailureObservation {
    notFoundReturnsEmpty: boolean;
    providerFailureResult: 'normalized_error' | 'empty_result' | 'success';
    normalizedFailure?: NormalizedMemoryError;
    failureDisposition: 'retry_reconcile_quarantine_or_dlq' | 'empty_result' | 'none';
}

Contract members

Member	Kind	Signature	Description
failureDisposition	property	failureDisposition: "none" | "retry_reconcile_quarantine_or_dlq" | "empty_result"	Public property; its type, readonly modifier and optionality are shown in the signature.
normalizedFailure	property	normalizedFailure?: NormalizedMemoryError	Public property; its type, readonly modifier and optionality are shown in the signature.
notFoundReturnsEmpty	property	notFoundReturnsEmpty: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
providerFailureResult	property	providerFailureResult: "normalized_error" | "success" | "empty_result"	Public property; its type, readonly modifier and optionality are shown in the signature.

RedisWorkingMemoryObservation

Redis Working Memory Observation interface with 3 public fields or methods.

• Kind: interface
• Import: import type { RedisWorkingMemoryObservation } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-acceptance

Declaration

export interface RedisWorkingMemoryObservation {
    trimArgumentSemantics: 'target_max_length' | 'deletion_count';
    newestReadStrategy: 'reverse_range' | 'forward_range' | 'reliable_metadata';
    cleanupStrategy: 'scan' | 'keys';
}

Contract members

Member	Kind	Signature	Description
cleanupStrategy	property	cleanupStrategy: "scan" | "keys"	Public property; its type, readonly modifier and optionality are shown in the signature.
newestReadStrategy	property	newestReadStrategy: "reverse_range" | "forward_range" | "reliable_metadata"	Public property; its type, readonly modifier and optionality are shown in the signature.
trimArgumentSemantics	property	trimArgumentSemantics: "target_max_length" | "deletion_count"	Public property; its type, readonly modifier and optionality are shown in the signature.