@codesoul-co/hypha-memory / self-hosted-provider-factories

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/self-hosted-provider-factories.ts
• Exports: 5

Using this module

Use the Self hosted provider factories module for binding external or local providers to Hypha ports. It exports 1 constant, 2 functions, 2 interfaces.

Import from the package entrypoint

import {
  MEM0_OSS_FACTORY_ID,
  createMem0OssMemoryProviderFactory,
  registerMem0OssMemoryProvider,
} from '@codesoul-co/hypha-memory';

import type {
  Mem0OssConnection,
  Mem0OssProviderFactoryOptions,
} 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 2 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
MEM0_OSS_FACTORY_ID	constant	const MEM0_OSS_FACTORY_ID: "memory.factory.mem0.oss-rest"	MEM0 OSS FACTORY ID constant exported by the self-hosted-provider-factories module.
createMem0OssMemoryProviderFactory	function	createMem0OssMemoryProviderFactory(options?: Mem0OssProviderFactoryOptions): MemoryManagementProviderFactory	Create Mem0 Oss Memory Provider Factory function with 1 public call signature; parameters and return types are listed below.
registerMem0OssMemoryProvider	function	registerMem0OssMemoryProvider(registry: MemoryManagementProviderRegistry, options?: Mem0OssProviderFactoryOptions): MemoryManagementProviderRegistry	Register Mem0 Oss Memory Provider function with 1 public call signature; parameters and return types are listed below.
Mem0OssConnection	interface	interface Mem0OssConnection	Mem0 Oss Connection interface with 5 public fields or methods.
Mem0OssProviderFactoryOptions	interface	interface Mem0OssProviderFactoryOptions	Mem0 Oss Provider Factory Options interface with 1 public fields or methods.

MEM0_OSS_FACTORY_ID

MEM0 OSS FACTORY ID constant exported by the self-hosted-provider-factories module.

• Kind: constant
• Import: import { MEM0_OSS_FACTORY_ID } from '@codesoul-co/hypha-memory';
• Source module: self-hosted-provider-factories

Declaration

export declare const MEM0_OSS_FACTORY_ID: "memory.factory.mem0.oss-rest";

createMem0OssMemoryProviderFactory

Create Mem0 Oss Memory Provider Factory function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { createMem0OssMemoryProviderFactory } from '@codesoul-co/hypha-memory';
• Source module: self-hosted-provider-factories

Declaration

export declare function createMem0OssMemoryProviderFactory(options?: Mem0OssProviderFactoryOptions): MemoryManagementProviderFactory;

Call signature

createMem0OssMemoryProviderFactory(options?: Mem0OssProviderFactoryOptions): MemoryManagementProviderFactory

Parameters

Parameter	Type	Required	Description
options	Mem0OssProviderFactoryOptions	No	Optional parameter; accepted values are defined by the type column.

Returns

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

registerMem0OssMemoryProvider

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

• Kind: function
• Import: import { registerMem0OssMemoryProvider } from '@codesoul-co/hypha-memory';
• Source module: self-hosted-provider-factories

Declaration

export declare function registerMem0OssMemoryProvider(registry: MemoryManagementProviderRegistry, options?: Mem0OssProviderFactoryOptions): MemoryManagementProviderRegistry;

Call signature

registerMem0OssMemoryProvider(registry: MemoryManagementProviderRegistry, options?: Mem0OssProviderFactoryOptions): MemoryManagementProviderRegistry

Parameters

Parameter	Type	Required	Description
registry	MemoryManagementProviderRegistry	Yes	Required parameter; accepted values are defined by the type column.
options	Mem0OssProviderFactoryOptions	No	Optional parameter; accepted values are defined by the type column.

Returns

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

Mem0OssConnection

Mem0 Oss Connection interface with 5 public fields or methods.

• Kind: interface
• Import: import type { Mem0OssConnection } from '@codesoul-co/hypha-memory';
• Source module: self-hosted-provider-factories

Declaration

export interface Mem0OssConnection {
    baseUrl: string;
    apiKey?: string;
    authMode?: Mem0OssClientOptions['authMode'];
    providerVersion?: string;
    fetch?: Mem0HttpFetch;
}

Contract members

Member	Kind	Signature	Description
apiKey	property	apiKey?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
authMode	property	authMode?: "none" | "x-api-key" | "bearer"	Public property; its type, readonly modifier and optionality are shown in the signature.
baseUrl	property	baseUrl: 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.
providerVersion	property	providerVersion?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

Mem0OssProviderFactoryOptions

Mem0 Oss Provider Factory Options interface with 1 public fields or methods.

• Kind: interface
• Import: import type { Mem0OssProviderFactoryOptions } from '@codesoul-co/hypha-memory';
• Source module: self-hosted-provider-factories

Declaration

export interface Mem0OssProviderFactoryOptions {
    fetch?: Mem0HttpFetch;
}

Contract members

Member	Kind	Signature	Description
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.