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

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

Using this module

Use the Memory server migration package module for using the public contracts and operations for this capability boundary. It exports 1 constant, 4 functions, 9 interfaces, 2 types.

Import from the package entrypoint

import {
  memoryServerMigrationPackageSpec,
  lifecycleFailureError,
  runMemoryServerMigrationPackageAcceptance,
  runMigrationStateMachineAcceptance,
  runRuntimeLifecycleAcceptance,
} from '@codesoul-co/hypha-memory';

import type {
  MemoryServerLifecycleFailureEvidence,
  MemoryServerMigrationPackageFinding,
  MemoryServerMigrationPackagePorts,
  MemoryServerMigrationPackageReport,
  MemoryServerMigrationPackageSpec,
  MemoryServerMigrationPackageSuiteReport,
  MemoryServerMigrationStateMachinePort,
  MemoryServerRuntimeLifecycleEvidence,
} from '@codesoul-co/hypha-memory';

// The complete export list is documented below.

Usage patterns

• Use the 11 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.
• The 1 constant/enum export provides stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Public exports

Symbol	Kind	Signature	Description
memoryServerMigrationPackageSpec	constant	const memoryServerMigrationPackageSpec: MemoryServerMigrationPackageSpec	Memory Server Migration Package Spec constant exported by the memory-server-migration-package module.
lifecycleFailureError	function	lifecycleFailureError(point: MemoryServerLifecycleFailurePoint): NormalizedMemoryError	Lifecycle Failure Error function with 1 public call signature; parameters and return types are listed below.
runMemoryServerMigrationPackageAcceptance	function	runMemoryServerMigrationPackageAcceptance(ports: MemoryServerMigrationPackagePorts, spec?: MemoryServerMigrationPackageSpec): Promise<MemoryServerMigrationPackageReport>	Run Memory Server Migration Package Acceptance function with 1 public call signature; parameters and return types are listed below.
runMigrationStateMachineAcceptance	function	runMigrationStateMachineAcceptance(port: MemoryServerMigrationStateMachinePort): Promise<MemoryServerMigrationPackageSuiteReport>	Run Migration State Machine Acceptance function with 1 public call signature; parameters and return types are listed below.
runRuntimeLifecycleAcceptance	function	runRuntimeLifecycleAcceptance(port: MemoryServerRuntimeLifecyclePort, spec?: MemoryServerMigrationPackageSpec): Promise<MemoryServerMigrationPackageSuiteReport>	Run Runtime Lifecycle Acceptance function with 1 public call signature; parameters and return types are listed below.
MemoryServerLifecycleFailureEvidence	interface	interface MemoryServerLifecycleFailureEvidence	Memory Server Lifecycle Failure Evidence interface with 5 public fields or methods.
MemoryServerMigrationPackageFinding	interface	interface MemoryServerMigrationPackageFinding	Memory Server Migration Package Finding interface with 4 public fields or methods.
MemoryServerMigrationPackagePorts	interface	interface MemoryServerMigrationPackagePorts	Memory Server Migration Package Ports interface with 5 public fields or methods.
MemoryServerMigrationPackageReport	interface	interface MemoryServerMigrationPackageReport	Memory Server Migration Package Report interface with 4 public fields or methods.
MemoryServerMigrationPackageSpec	interface	interface MemoryServerMigrationPackageSpec	Memory Server Migration Package Spec interface with 4 public fields or methods.
MemoryServerMigrationPackageSuiteReport	interface	interface MemoryServerMigrationPackageSuiteReport	Memory Server Migration Package Suite Report interface with 4 public fields or methods.
MemoryServerMigrationStateMachinePort	interface	interface MemoryServerMigrationStateMachinePort	Memory Server Migration State Machine Port interface with 2 public fields or methods.
MemoryServerRuntimeLifecycleEvidence	interface	interface MemoryServerRuntimeLifecycleEvidence	Memory Server Runtime Lifecycle Evidence interface with 5 public fields or methods.
MemoryServerRuntimeLifecyclePort	interface	interface MemoryServerRuntimeLifecyclePort	Memory Server Runtime Lifecycle Port interface with 1 public fields or methods.
MemoryServerLifecycleFailurePoint	type	type MemoryServerLifecycleFailurePoint = (typeof memoryServerMigrationPackageSpec.lifecycleFailurePoints)[number]	Public type alias for Memory Server Lifecycle Failure Point; the declaration contains its complete type expression.
MemoryServerMigrationPackageSuiteId	type	type MemoryServerMigrationPackageSuiteId = 'consumer_contract' | 'redis_behavior' | 'permanent_behavior' | 'migration_state_machine' | 'runtime_lifecycle'	Public type alias for Memory Server Migration Package Suite ID; the declaration contains its complete type expression.

memoryServerMigrationPackageSpec

Memory Server Migration Package Spec constant exported by the memory-server-migration-package module.

• Kind: constant
• Import: import { memoryServerMigrationPackageSpec } from '@codesoul-co/hypha-memory';
• Source module: memory-server-migration-package

Declaration

export declare const memoryServerMigrationPackageSpec: MemoryServerMigrationPackageSpec;

lifecycleFailureError

Lifecycle Failure Error function with 1 public call signature; parameters and return types are listed below.

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

Declaration

export declare function lifecycleFailureError(point: MemoryServerLifecycleFailurePoint): NormalizedMemoryError;

Call signature

lifecycleFailureError(point: MemoryServerLifecycleFailurePoint): NormalizedMemoryError

Parameters

Parameter	Type	Required	Description
point	"provider_create" | "capability_negotiation" | "health_check" | "activity_registration"	Yes	Required parameter; accepted values are defined by the type column.

Returns

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

runMemoryServerMigrationPackageAcceptance

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

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

Declaration

export declare function runMemoryServerMigrationPackageAcceptance(ports: MemoryServerMigrationPackagePorts, spec?: MemoryServerMigrationPackageSpec): Promise<MemoryServerMigrationPackageReport>;

Call signature

runMemoryServerMigrationPackageAcceptance(ports: MemoryServerMigrationPackagePorts, spec?: MemoryServerMigrationPackageSpec): Promise<MemoryServerMigrationPackageReport>

Parameters

Parameter	Type	Required	Description
ports	MemoryServerMigrationPackagePorts	Yes	Required parameter; accepted values are defined by the type column.
spec	MemoryServerMigrationPackageSpec	No	Optional parameter; accepted values are defined by the type column.

Returns

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

runMigrationStateMachineAcceptance

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

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

Declaration

export declare function runMigrationStateMachineAcceptance(port: MemoryServerMigrationStateMachinePort): Promise<MemoryServerMigrationPackageSuiteReport>;

Call signature

runMigrationStateMachineAcceptance(port: MemoryServerMigrationStateMachinePort): Promise<MemoryServerMigrationPackageSuiteReport>

Parameters

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

Returns

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

runRuntimeLifecycleAcceptance

Run Runtime Lifecycle Acceptance function with 1 public call signature; parameters and return types are listed below.

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

Declaration

export declare function runRuntimeLifecycleAcceptance(port: MemoryServerRuntimeLifecyclePort, spec?: MemoryServerMigrationPackageSpec): Promise<MemoryServerMigrationPackageSuiteReport>;

Call signature

runRuntimeLifecycleAcceptance(port: MemoryServerRuntimeLifecyclePort, spec?: MemoryServerMigrationPackageSpec): Promise<MemoryServerMigrationPackageSuiteReport>

Parameters

Parameter	Type	Required	Description
port	MemoryServerRuntimeLifecyclePort	Yes	Required parameter; accepted values are defined by the type column.
spec	MemoryServerMigrationPackageSpec	No	Optional parameter; accepted values are defined by the type column.

Returns

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

MemoryServerLifecycleFailureEvidence

Memory Server Lifecycle Failure Evidence interface with 5 public fields or methods.

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

Declaration

export interface MemoryServerLifecycleFailureEvidence {
    point: MemoryServerLifecycleFailurePoint;
    rejected: boolean;
    resourcesCreated: number;
    resourcesClosed: number;
    openHandleCount: number;
}

Contract members

Member	Kind	Signature	Description
openHandleCount	property	openHandleCount: number	Public property; its type, readonly modifier and optionality are shown in the signature.
point	property	point: "provider_create" | "capability_negotiation" | "health_check" | "activity_registration"	Public property; its type, readonly modifier and optionality are shown in the signature.
rejected	property	rejected: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
resourcesClosed	property	resourcesClosed: number	Public property; its type, readonly modifier and optionality are shown in the signature.
resourcesCreated	property	resourcesCreated: number	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryServerMigrationPackageFinding

Memory Server Migration Package Finding interface with 4 public fields or methods.

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

Declaration

export interface MemoryServerMigrationPackageFinding {
    code: string;
    message: string;
    fixtureId?: string;
    issue?: string;
}

Contract members

Member	Kind	Signature	Description
code	property	code: string	Public property; its type, readonly modifier and optionality are shown in the signature.
fixtureId	property	fixtureId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
issue	property	issue?: string	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.

MemoryServerMigrationPackagePorts

Memory Server Migration Package Ports interface with 5 public fields or methods.

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

Declaration

export interface MemoryServerMigrationPackagePorts {
    contract: MemoryServerMigrationAcceptancePorts;
    redisBehavior: WorkingMemoryMigrationHarnessFactory;
    permanentBehavior: PermanentMemoryMigrationHarnessFactory;
    migrationStateMachine: MemoryServerMigrationStateMachinePort;
    runtimeLifecycle: MemoryServerRuntimeLifecyclePort;
}

Contract members

Member	Kind	Signature	Description
contract	property	contract: MemoryServerMigrationAcceptancePorts	Public property; its type, readonly modifier and optionality are shown in the signature.
migrationStateMachine	property	migrationStateMachine: MemoryServerMigrationStateMachinePort	Public property; its type, readonly modifier and optionality are shown in the signature.
permanentBehavior	method	permanentBehavior(fixture: import("/Users/erwin/Downloads/codespace/Hypha/packages/memory/dist/memory-server-permanent-migration-fixtures").PermanentMemoryFailureFixture): import("/Users/erwin/Downloads/codespace/Hypha/packages/memory/dist/memory-server-permanent-migration-fixtures").PermanentMemoryMigrationAcceptanceHarness	Public method; parameters and return type are shown in the signature.
redisBehavior	method	redisBehavior(fixtureId: string): import("/Users/erwin/Downloads/codespace/Hypha/packages/memory/dist/memory-server-redis-migration-fixtures").WorkingMemoryMigrationAcceptanceHarness	Public method; parameters and return type are shown in the signature.
runtimeLifecycle	property	runtimeLifecycle: MemoryServerRuntimeLifecyclePort	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryServerMigrationPackageReport

Memory Server Migration Package Report interface with 4 public fields or methods.

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

Declaration

export interface MemoryServerMigrationPackageReport {
    contractRef: MemoryContractSpecRef;
    baseAcceptanceRef: MemoryContractSpecRef;
    passed: boolean;
    suites: readonly MemoryServerMigrationPackageSuiteReport[];
}

Contract members

Member	Kind	Signature	Description
baseAcceptanceRef	property	baseAcceptanceRef: MemoryContractSpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
contractRef	property	contractRef: 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 MemoryServerMigrationPackageSuiteReport[]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryServerMigrationPackageSpec

Memory Server Migration Package Spec interface with 4 public fields or methods.

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

Declaration

export interface MemoryServerMigrationPackageSpec {
    contractRef: MemoryContractSpecRef;
    baseAcceptanceRef: MemoryContractSpecRef;
    requiredSuites: readonly [
        'consumer_contract',
        'redis_behavior',
        'permanent_behavior',
        'migration_state_machine',
        'runtime_lifecycle'
    ];
    lifecycleFailurePoints: readonly [
        'provider_create',
        'capability_negotiation',
        'health_check',
        'activity_registration'
    ];
}

Contract members

Member	Kind	Signature	Description
baseAcceptanceRef	property	baseAcceptanceRef: MemoryContractSpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
contractRef	property	contractRef: MemoryContractSpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
lifecycleFailurePoints	property	lifecycleFailurePoints: readonly ["provider_create", "capability_negotiation", "health_check", "activity_registration"]	Public property; its type, readonly modifier and optionality are shown in the signature.
requiredSuites	property	requiredSuites: readonly ["consumer_contract", "redis_behavior", "permanent_behavior", "migration_state_machine", "runtime_lifecycle"]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryServerMigrationPackageSuiteReport

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

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

Declaration

export interface MemoryServerMigrationPackageSuiteReport {
    id: MemoryServerMigrationPackageSuiteId;
    passed: boolean;
    cases: number;
    findings: readonly MemoryServerMigrationPackageFinding[];
}

Contract members

Member	Kind	Signature	Description
cases	property	cases: number	Public property; its type, readonly modifier and optionality are shown in the signature.
findings	property	findings: readonly MemoryServerMigrationPackageFinding[]	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: MemoryServerMigrationPackageSuiteId	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.

MemoryServerMigrationStateMachinePort

Memory Server Migration State Machine Port interface with 2 public fields or methods.

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

Declaration

export interface MemoryServerMigrationStateMachinePort {
    create(input: {
        migrationId: string;
        revision: string;
        createdAt: string;
    }): MemoryServerCanonicalMigrationState | Promise<MemoryServerCanonicalMigrationState>;
    transition(current: MemoryServerCanonicalMigrationState, input: MemoryServerMigrationTransitionInput): MemoryServerMigrationTransitionResult | Promise<MemoryServerMigrationTransitionResult>;
}

Contract members

Member	Kind	Signature	Description
create	method	create(input: { migrationId: string; revision: string; createdAt: string; }): MemoryServerCanonicalMigrationState | Promise<MemoryServerCanonicalMigrationState>	Public method; parameters and return type are shown in the signature.
transition	method	transition(current: MemoryServerCanonicalMigrationState, input: MemoryServerMigrationTransitionInput): MemoryServerMigrationTransitionResult | Promise<MemoryServerMigrationTransitionResult>	Public method; parameters and return type are shown in the signature.

MemoryServerRuntimeLifecycleEvidence

Memory Server Runtime Lifecycle Evidence interface with 5 public fields or methods.

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

Declaration

export interface MemoryServerRuntimeLifecycleEvidence {
    closeInvocations: number;
    providerCloseCount: number;
    installationCloseCount: number;
    openHandleCount: number;
    failures: readonly MemoryServerLifecycleFailureEvidence[];
}

Contract members

Member	Kind	Signature	Description
closeInvocations	property	closeInvocations: number	Public property; its type, readonly modifier and optionality are shown in the signature.
failures	property	failures: readonly MemoryServerLifecycleFailureEvidence[]	Public property; its type, readonly modifier and optionality are shown in the signature.
installationCloseCount	property	installationCloseCount: number	Public property; its type, readonly modifier and optionality are shown in the signature.
openHandleCount	property	openHandleCount: number	Public property; its type, readonly modifier and optionality are shown in the signature.
providerCloseCount	property	providerCloseCount: number	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryServerRuntimeLifecyclePort

Memory Server Runtime Lifecycle Port interface with 1 public fields or methods.

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

Declaration

export interface MemoryServerRuntimeLifecyclePort {
    observe(): Promise<MemoryServerRuntimeLifecycleEvidence>;
}

Contract members

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

MemoryServerLifecycleFailurePoint

Public type alias for Memory Server Lifecycle Failure Point; the declaration contains its complete type expression.

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

Declaration

export type MemoryServerLifecycleFailurePoint = (typeof memoryServerMigrationPackageSpec.lifecycleFailurePoints)[number];

MemoryServerMigrationPackageSuiteId

Public type alias for Memory Server Migration Package Suite ID; the declaration contains its complete type expression.

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

Declaration

export type MemoryServerMigrationPackageSuiteId = 'consumer_contract' | 'redis_behavior' | 'permanent_behavior' | 'migration_state_machine' | 'runtime_lifecycle';