@codesoul-co/hypha-memory / governed-memory-manager

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/governed-memory-manager.ts
• Exports: 6

Using this module

Use the Governed memory manager module for using the public contracts and operations for this capability boundary. It exports 1 class, 3 functions, 2 interfaces.

Import from the package entrypoint

import {
  GovernedMemoryManager,
  governedMemoryProviderCapabilities,
  governedMemoryProviderHealth,
  registerMemoryManagementProviderHandlers,
} from '@codesoul-co/hypha-memory';

import type {
  GovernedMemoryManagerOptions,
  MemoryActivityRegistrar,
} from '@codesoul-co/hypha-memory';

Usage patterns

• Use the 2 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 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
• The module exposes 3 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
GovernedMemoryManager	class	new GovernedMemoryManager(options: GovernedMemoryManagerOptions): GovernedMemoryManager	Canonical managed-memory entry point. Every operation is executed through the policy, harness, event, cancellation and timeout boundary of MemoryActivityPort.
governedMemoryProviderCapabilities	function	governedMemoryProviderCapabilities(provider: MemoryManagementProvider): Promise<MemoryManagementCapabilities>	Governed Memory Provider Capabilities function with 1 public call signature; parameters and return types are listed below.
governedMemoryProviderHealth	function	governedMemoryProviderHealth(provider: MemoryManagementProvider): Promise<ProviderHealth>	Governed Memory Provider Health function with 1 public call signature; parameters and return types are listed below.
registerMemoryManagementProviderHandlers	function	registerMemoryManagementProviderHandlers(activities: MemoryActivityRegistrar | DefaultMemoryActivityPort, provider: MemoryManagementProvider): void	Register Memory Management Provider Handlers function with 1 public call signature; parameters and return types are listed below.
GovernedMemoryManagerOptions	interface	interface GovernedMemoryManagerOptions	Governed Memory Manager Options interface with 8 public fields or methods.
MemoryActivityRegistrar	interface	interface MemoryActivityRegistrar	Memory Activity Registrar interface with 1 public fields or methods.

GovernedMemoryManager

Canonical managed-memory entry point. Every operation is executed through the policy, harness, event, cancellation and timeout boundary of MemoryActivityPort.

• Kind: class
• Import: import { GovernedMemoryManager } from '@codesoul-co/hypha-memory';
• Source module: governed-memory-manager

Declaration

export declare class GovernedMemoryManager {
    constructor(options: GovernedMemoryManagerOptions);
    add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>;
    search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]>;
    get(request: MemoryGetRequest, signal?: AbortSignal): Promise<ManagedMemoryRecord | null>;
    list(request: MemoryListRequest, signal?: AbortSignal): Promise<MemoryListResult>;
    update(request: ManagedMemoryUpdateRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>;
    delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult>;
    history(request: MemoryHistoryRequest, signal?: AbortSignal): Promise<MemoryVersion[]>;
}

Public members

Member	Kind	Signature	Description
add	method	add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: GovernedMemoryManagerOptions): GovernedMemoryManager	Creates an instance of this class.
delete	method	delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult>	Public method; parameters and return type are shown in the signature.
get	method	get(request: MemoryGetRequest, signal?: AbortSignal): Promise<ManagedMemoryRecord | null>	Public method; parameters and return type are shown in the signature.
history	method	history(request: MemoryHistoryRequest, signal?: AbortSignal): Promise<MemoryVersion[]>	Public method; parameters and return type are shown in the signature.
list	method	list(request: MemoryListRequest, signal?: AbortSignal): Promise<MemoryListResult>	Public method; parameters and return type are shown in the signature.
search	method	search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]>	Public method; parameters and return type are shown in the signature.
update	method	update(request: ManagedMemoryUpdateRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>	Public method; parameters and return type are shown in the signature.

governedMemoryProviderCapabilities

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

• Kind: function
• Import: import { governedMemoryProviderCapabilities } from '@codesoul-co/hypha-memory';
• Source module: governed-memory-manager

Declaration

export declare function governedMemoryProviderCapabilities(provider: MemoryManagementProvider): Promise<MemoryManagementCapabilities>;

Call signature

governedMemoryProviderCapabilities(provider: MemoryManagementProvider): Promise<MemoryManagementCapabilities>

Parameters

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

Returns

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

governedMemoryProviderHealth

Governed Memory Provider Health function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { governedMemoryProviderHealth } from '@codesoul-co/hypha-memory';
• Source module: governed-memory-manager

Declaration

export declare function governedMemoryProviderHealth(provider: MemoryManagementProvider): Promise<ProviderHealth>;

Call signature

governedMemoryProviderHealth(provider: MemoryManagementProvider): Promise<ProviderHealth>

Parameters

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

Returns

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

registerMemoryManagementProviderHandlers

Register Memory Management Provider Handlers function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { registerMemoryManagementProviderHandlers } from '@codesoul-co/hypha-memory';
• Source module: governed-memory-manager

Declaration

export declare function registerMemoryManagementProviderHandlers(activities: MemoryActivityRegistrar | DefaultMemoryActivityPort, provider: MemoryManagementProvider): void;

Call signature

registerMemoryManagementProviderHandlers(activities: MemoryActivityRegistrar | DefaultMemoryActivityPort, provider: MemoryManagementProvider): void

Parameters

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

Returns

• Type: void
• Description: Returns no value.

GovernedMemoryManagerOptions

Governed Memory Manager Options interface with 8 public fields or methods.

• Kind: interface
• Import: import type { GovernedMemoryManagerOptions } from '@codesoul-co/hypha-memory';
• Source module: governed-memory-manager

Declaration

export interface GovernedMemoryManagerOptions {
    activities: MemoryActivityPort;
    providerId: string;
    profileRef: MemoryContractSpecRef | ((request: GovernedMemoryRequest) => MemoryContractSpecRef);
    eventContext: MemoryEventContext | ((request: GovernedMemoryRequest) => MemoryEventContext);
    timeoutMs?: number;
    reconciliationStore?: MemoryLifecycleTaskStore;
    projectionInvalidation?: MemoryProjectionInvalidationPort;
    now?: () => string;
}

Contract members

Member	Kind	Signature	Description
activities	property	activities: MemoryActivityPort	Public property; its type, readonly modifier and optionality are shown in the signature.
eventContext	property	eventContext: MemoryEventContext | ((request: GovernedMemoryRequest) => MemoryEventContext)	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
profileRef	property	profileRef: MemoryContractSpecRef | ((request: GovernedMemoryRequest) => MemoryContractSpecRef)	Public property; its type, readonly modifier and optionality are shown in the signature.
projectionInvalidation	property	projectionInvalidation?: MemoryProjectionInvalidationPort	Public property; its type, readonly modifier and optionality are shown in the signature.
providerId	property	providerId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reconciliationStore	property	reconciliationStore?: MemoryLifecycleTaskStore	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.

MemoryActivityRegistrar

Memory Activity Registrar interface with 1 public fields or methods.

• Kind: interface
• Import: import type { MemoryActivityRegistrar } from '@codesoul-co/hypha-memory';
• Source module: governed-memory-manager

Declaration

export interface MemoryActivityRegistrar {
    register(operation: MemoryActivityOperation, handler: MemoryActivityHandler): unknown;
}

Contract members

Member	Kind	Signature	Description
register	method	register(operation: MemoryActivityOperation, handler: MemoryActivityHandler): unknown	Public method; parameters and return type are shown in the signature.