@codesoul-co/hypha-memory / memory-application-service

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/memory-application-service.ts
• Exports: 3

Using this module

Use the Memory application service module for using the public contracts and operations for this capability boundary. It exports 1 class, 2 interfaces.

Import from the package entrypoint

import {
  DefaultMemoryApplicationService,
} from '@codesoul-co/hypha-memory';

import type {
  DefaultMemoryApplicationServiceOptions,
  MemoryApplicationService,
} 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.

Public exports

Symbol	Kind	Signature	Description
DefaultMemoryApplicationService	class	new DefaultMemoryApplicationService(options: DefaultMemoryApplicationServiceOptions): DefaultMemoryApplicationService	Canonical application-facing Memory surface. HTTP, Chat, Workflow and Harness integrations consume this service instead of selecting a Provider or Store.
DefaultMemoryApplicationServiceOptions	interface	interface DefaultMemoryApplicationServiceOptions	Default Memory Application Service Options interface with 6 public fields or methods.
MemoryApplicationService	interface	interface MemoryApplicationService	Memory Application Service interface with 12 public fields or methods.

DefaultMemoryApplicationService

Canonical application-facing Memory surface. HTTP, Chat, Workflow and Harness integrations consume this service instead of selecting a Provider or Store.

• Kind: class
• Import: import { DefaultMemoryApplicationService } from '@codesoul-co/hypha-memory';
• Source module: memory-application-service

Declaration

export declare class DefaultMemoryApplicationService implements MemoryApplicationService {
    constructor(options: DefaultMemoryApplicationServiceOptions);
    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[]>;
    buildContext(request: ContextBuildInput, signal?: AbortSignal): Promise<ContextEnvelope>;
    explainContext(contextHash: string): Promise<ContextBuildExplanation | null>;
    providerCapabilities(): Promise<MemoryManagementCapabilities>;
    providerHealth(): Promise<ProviderHealth>;
    close(): Promise<void>;
}

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.
buildContext	method	buildContext(request: ContextBuildInput, signal?: AbortSignal): Promise<ContextEnvelope>	Public method; parameters and return type are shown in the signature.
close	method	close(): Promise<void>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: DefaultMemoryApplicationServiceOptions): DefaultMemoryApplicationService	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.
explainContext	method	explainContext(contextHash: string): Promise<ContextBuildExplanation | null>	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.
providerCapabilities	method	providerCapabilities(): Promise<MemoryManagementCapabilities>	Public method; parameters and return type are shown in the signature.
providerHealth	method	providerHealth(): Promise<ProviderHealth>	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.

DefaultMemoryApplicationServiceOptions

Default Memory Application Service Options interface with 6 public fields or methods.

• Kind: interface
• Import: import type { DefaultMemoryApplicationServiceOptions } from '@codesoul-co/hypha-memory';
• Source module: memory-application-service

Declaration

export interface DefaultMemoryApplicationServiceOptions {
    manager: GovernedMemoryManager;
    activities: MemoryActivityPort;
    provider: MemoryManagementProvider;
    contextBuilder?: MemoryContextBuilder;
    eventContext: MemoryEventContext | ((request: ContextBuildInput) => MemoryEventContext);
    contextTimeoutMs?: number;
}

Contract members

Member	Kind	Signature	Description
activities	property	activities: MemoryActivityPort	Public property; its type, readonly modifier and optionality are shown in the signature.
contextBuilder	property	contextBuilder?: MemoryContextBuilder	Public property; its type, readonly modifier and optionality are shown in the signature.
contextTimeoutMs	property	contextTimeoutMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
eventContext	property	eventContext: MemoryEventContext | ((request: ContextBuildInput) => MemoryEventContext)	Public property; its type, readonly modifier and optionality are shown in the signature.
manager	property	manager: GovernedMemoryManager	Public property; its type, readonly modifier and optionality are shown in the signature.
provider	property	provider: MemoryManagementProvider	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryApplicationService

Memory Application Service interface with 12 public fields or methods.

• Kind: interface
• Import: import type { MemoryApplicationService } from '@codesoul-co/hypha-memory';
• Source module: memory-application-service

Declaration

export interface MemoryApplicationService {
    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[]>;
    buildContext(request: ContextBuildInput, signal?: AbortSignal): Promise<ContextEnvelope>;
    explainContext(contextHash: string): Promise<ContextBuildExplanation | null>;
    providerCapabilities(): Promise<MemoryManagementCapabilities>;
    providerHealth(): Promise<ProviderHealth>;
    close(): Promise<void>;
}

Contract 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.
buildContext	method	buildContext(request: ContextBuildInput, signal?: AbortSignal): Promise<ContextEnvelope>	Public method; parameters and return type are shown in the signature.
close	method	close(): Promise<void>	Public method; parameters and return type are shown in the signature.
delete	method	delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult>	Public method; parameters and return type are shown in the signature.
explainContext	method	explainContext(contextHash: string): Promise<ContextBuildExplanation | null>	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.
providerCapabilities	method	providerCapabilities(): Promise<MemoryManagementCapabilities>	Public method; parameters and return type are shown in the signature.
providerHealth	method	providerHealth(): Promise<ProviderHealth>	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.