@codesoul-co/hypha-memory / hindsight-local-client

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/hindsight-local-client.ts
• Exports: 6

Using this module

Use the Hindsight local client module for binding external or local providers to Hypha ports. It exports 1 class, 2 constants, 2 functions, 1 interface.

Import from the package entrypoint

import {
  HindsightLocalMemoryBankClient,
  HINDSIGHT_LOCAL_PROTOCOL,
  HINDSIGHT_LOCAL_VERSION,
  bankIdForScope,
  documentIdForOperation,
} from '@codesoul-co/hypha-memory';

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

Usage patterns

• Use the 1 type/interface export 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 2 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
• The 2 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Public exports

Symbol	Kind	Signature	Description
HindsightLocalMemoryBankClient	class	new HindsightLocalMemoryBankClient(options: HindsightLocalMemoryBankClientOptions): HindsightLocalMemoryBankClient	Native adapter for Hindsight Self-hosted HTTP API 0.8.
HINDSIGHT_LOCAL_PROTOCOL	constant	const HINDSIGHT_LOCAL_PROTOCOL: "hindsight.http.v0.8"	HINDSIGHT LOCAL PROTOCOL constant exported by the hindsight-local-client module.
HINDSIGHT_LOCAL_VERSION	constant	const HINDSIGHT_LOCAL_VERSION: "0.8.5"	HINDSIGHT LOCAL VERSION constant exported by the hindsight-local-client module.
bankIdForScope	function	bankIdForScope(scope: ManagedMemoryScope): string	Bank ID For Scope function with 1 public call signature; parameters and return types are listed below.
documentIdForOperation	function	documentIdForOperation(operationId: string): string	Document ID For Operation function with 1 public call signature; parameters and return types are listed below.
HindsightLocalMemoryBankClientOptions	interface	interface HindsightLocalMemoryBankClientOptions	Hindsight Local Memory Bank Client Options interface with 12 public fields or methods.

HindsightLocalMemoryBankClient

Native adapter for Hindsight Self-hosted HTTP API 0.8.

• Kind: class
• Import: import { HindsightLocalMemoryBankClient } from '@codesoul-co/hypha-memory';
• Source module: hindsight-local-client

Declaration

export declare class HindsightLocalMemoryBankClient implements ExternalMemoryClient {
    readonly protocol: "hindsight.http.v0.8";
    constructor(options: HindsightLocalMemoryBankClientOptions);
    capabilities(signal?: AbortSignal): Promise<Partial<MemoryManagementCapabilities>>;
    add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>;
    reconcileOperation(operationId: string, signal?: AbortSignal): Promise<ManagedMemoryWriteResult | null>;
    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[]>;
    health(signal?: AbortSignal): 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.
capabilities	method	capabilities(signal?: AbortSignal): Promise<Partial<MemoryManagementCapabilities>>	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: HindsightLocalMemoryBankClientOptions): HindsightLocalMemoryBankClient	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.
health	method	health(signal?: AbortSignal): Promise<ProviderHealth>	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.
protocol	property	readonly protocol: "hindsight.http.v0.8"	Public property; its type, readonly modifier and optionality are shown in the signature.
reconcileOperation	method	reconcileOperation(operationId: string, signal?: AbortSignal): Promise<ManagedMemoryWriteResult | null>	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.

HINDSIGHT_LOCAL_PROTOCOL

HINDSIGHT LOCAL PROTOCOL constant exported by the hindsight-local-client module.

• Kind: constant
• Import: import { HINDSIGHT_LOCAL_PROTOCOL } from '@codesoul-co/hypha-memory';
• Source module: hindsight-local-client

Declaration

export declare const HINDSIGHT_LOCAL_PROTOCOL: "hindsight.http.v0.8";

HINDSIGHT_LOCAL_VERSION

HINDSIGHT LOCAL VERSION constant exported by the hindsight-local-client module.

• Kind: constant
• Import: import { HINDSIGHT_LOCAL_VERSION } from '@codesoul-co/hypha-memory';
• Source module: hindsight-local-client

Declaration

export declare const HINDSIGHT_LOCAL_VERSION: "0.8.5";

bankIdForScope

Bank ID For Scope function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { bankIdForScope } from '@codesoul-co/hypha-memory';
• Source module: hindsight-local-client

Declaration

export declare function bankIdForScope(scope: ManagedMemoryScope): string;

Call signature

bankIdForScope(scope: ManagedMemoryScope): string

Parameters

Parameter	Type	Required	Description
scope	ManagedMemoryScope	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.

documentIdForOperation

Document ID For Operation function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { documentIdForOperation } from '@codesoul-co/hypha-memory';
• Source module: hindsight-local-client

Declaration

export declare function documentIdForOperation(operationId: string): string;

Call signature

documentIdForOperation(operationId: string): string

Parameters

Parameter	Type	Required	Description
operationId	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.

HindsightLocalMemoryBankClientOptions

Hindsight Local Memory Bank Client Options interface with 12 public fields or methods.

• Kind: interface
• Import: import type { HindsightLocalMemoryBankClientOptions } from '@codesoul-co/hypha-memory';
• Source module: hindsight-local-client

Declaration

export interface HindsightLocalMemoryBankClientOptions {
    baseUrl: string;
    bearerToken?: string;
    fetch?: Mem0HttpFetch;
    providerId?: string;
    mappingStore?: ExternalMemoryMappingStore;
    mappingProfile?: ExternalMemoryMappingRuntimeProfile;
    operationStore?: ExternalProviderOperationStore;
    operationProfile?: ExternalMemoryMappingRuntimeProfile;
    profileRef?: MemoryContractSpecRef;
    operationDeadlineMs?: number;
    now?: () => Date;
    expectedApiVersion?: string;
}

Contract members

Member	Kind	Signature	Description
baseUrl	property	baseUrl: string	Public property; its type, readonly modifier and optionality are shown in the signature.
bearerToken	property	bearerToken?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
expectedApiVersion	property	expectedApiVersion?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
fetch	method	fetch?(url: string, init?: { method?: string; headers?: Record<string, string>; body?: string; signal?: AbortSignal; }): Promise<import("/Users/erwin/Downloads/codespace/Hypha/packages/memory/dist/mem0-rest-client").Mem0HttpResponse>	Public method; parameters and return type are shown in the signature.
mappingProfile	property	mappingProfile?: ExternalMemoryMappingRuntimeProfile	Public property; its type, readonly modifier and optionality are shown in the signature.
mappingStore	property	mappingStore?: ExternalMemoryMappingStore	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): Date	Public method; parameters and return type are shown in the signature.
operationDeadlineMs	property	operationDeadlineMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
operationProfile	property	operationProfile?: ExternalMemoryMappingRuntimeProfile	Public property; its type, readonly modifier and optionality are shown in the signature.
operationStore	property	operationStore?: ExternalProviderOperationStore	Public property; its type, readonly modifier and optionality are shown in the signature.
profileRef	property	profileRef?: MemoryContractSpecRef	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.