@codesoul-co/hypha-memory / memory-runtime-factory

• 包索引: @codesoul-co/hypha-memory
• 源码: packages/memory/src/memory-runtime-factory.ts
• 导出数: 14

模块用法

用于执行该边界的运行时行为。Memory runtime factory 模块公开 2 类、2 常量、1 函数、8 接口、1 类型。

从包入口导入

import {
  MemoryManagementProviderRegistry,
  MemoryRuntimeFactory,
  memoryRuntimeConfigSchema,
  memoryRuntimeProfileSchema,
  validateMemoryRuntimeConfig,
} from '@codesoul-co/hypha-memory';

import type {
  MemoryManagementProviderFactory,
  MemoryManagementProviderFactoryContext,
  MemoryManagementProviderInstallation,
  MemoryRuntime,
  MemoryRuntimeCompositionReceipt,
  MemoryRuntimeConfig,
  MemoryRuntimeFactoryOptions,
  MemoryRuntimeProfile,
} from '@codesoul-co/hypha-memory';

// 完整导出列表见下方。

使用要点

• 9 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
• 2 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。
• 1 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。
• 2 个常量/枚举提供稳定值、Schema、Definition 或默认配置；应复用这些导出，避免在应用中复制内部值。

公共导出

Symbol	种类	签名	说明
MemoryManagementProviderRegistry	类	new MemoryManagementProviderRegistry(): MemoryManagementProviderRegistry	Memory Management Provider Registry 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。
MemoryRuntimeFactory	类	new MemoryRuntimeFactory(options: MemoryRuntimeFactoryOptions): MemoryRuntimeFactory	Strict composition root for all Memory consumers.
memoryRuntimeConfigSchema	常量	const memoryRuntimeConfigSchema: ZodType<MemoryRuntimeConfig, ZodTypeDef, MemoryRuntimeConfig>	Memory Runtime Config 的运行时 Schema。
memoryRuntimeProfileSchema	常量	const memoryRuntimeProfileSchema: ZodType<MemoryRuntimeProfile, ZodTypeDef, MemoryRuntimeProfile>	Memory Runtime Profile 的运行时 Schema。
validateMemoryRuntimeConfig	函数	validateMemoryRuntimeConfig(input: unknown): MemoryRuntimeConfig	Validate Memory Runtime Config 函数，提供 1 个公开调用签名；参数与返回类型见下表。
MemoryManagementProviderFactory	接口	interface MemoryManagementProviderFactory	Memory Management Provider Factory 接口，共包含 3 个公开字段或方法。
MemoryManagementProviderFactoryContext	接口	interface MemoryManagementProviderFactoryContext	Memory Management Provider Factory Context 接口，共包含 3 个公开字段或方法。
MemoryManagementProviderInstallation	接口	interface MemoryManagementProviderInstallation	Memory Management Provider Installation 接口，共包含 4 个公开字段或方法。
MemoryRuntime	接口	interface MemoryRuntime	Memory Runtime 接口，共包含 10 个公开字段或方法。
MemoryRuntimeCompositionReceipt	接口	interface MemoryRuntimeCompositionReceipt	Memory Runtime Composition Receipt 接口，共包含 10 个公开字段或方法。
MemoryRuntimeConfig	接口	interface MemoryRuntimeConfig	Memory Runtime Config 接口，共包含 2 个公开字段或方法。
MemoryRuntimeFactoryOptions	接口	interface MemoryRuntimeFactoryOptions	Memory Runtime Factory Options 接口，共包含 12 个公开字段或方法。
MemoryRuntimeProfile	接口	interface MemoryRuntimeProfile	Memory Runtime Profile 接口，共包含 2 个公开字段或方法。
MemoryRuntimeSearchCacheOptions	类型	type MemoryRuntimeSearchCacheOptions = Omit<CachedMemoryManagementProviderOptions, 'provider' | 'providerRevision' | 'requiredScopeFields' | 'cacheAuthorization' | 'requireCacheAuthorization'>	Memory Runtime Search Cache Options 公共类型别名；完整类型表达式见声明。

MemoryManagementProviderRegistry

Memory Management Provider Registry 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。

• 种类: 类
• 导入: import { MemoryManagementProviderRegistry } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export declare class MemoryManagementProviderRegistry {
    register(factory: MemoryManagementProviderFactory): this;
    resolve(spec: MemoryManagementProviderSpec): MemoryManagementProviderFactory;
}

公开成员

成员	种类	签名	说明
constructor	构造函数	(): MemoryManagementProviderRegistry	创建该类的实例。
register	方法	register(factory: MemoryManagementProviderFactory): MemoryManagementProviderRegistry	公开方法；参数与返回类型以签名列为准。
resolve	方法	resolve(spec: MemoryManagementProviderSpec): MemoryManagementProviderFactory	公开方法；参数与返回类型以签名列为准。

MemoryRuntimeFactory

Strict composition root for all Memory consumers.

• 种类: 类
• 导入: import { MemoryRuntimeFactory } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export declare class MemoryRuntimeFactory {
    constructor(options: MemoryRuntimeFactoryOptions);
    create(input: unknown, references?: ReadonlyMap<string, unknown>): Promise<MemoryRuntime>;
}

公开成员

成员	种类	签名	说明
constructor	构造函数	(options: MemoryRuntimeFactoryOptions): MemoryRuntimeFactory	创建该类的实例。
create	方法	create(input: unknown, references?: ReadonlyMap<string, unknown>): Promise<MemoryRuntime>	公开方法；参数与返回类型以签名列为准。

memoryRuntimeConfigSchema

Memory Runtime Config 的运行时 Schema。

• 种类: 常量
• 导入: import { memoryRuntimeConfigSchema } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export declare const memoryRuntimeConfigSchema: ZodType<MemoryRuntimeConfig, ZodTypeDef, MemoryRuntimeConfig>;

memoryRuntimeProfileSchema

Memory Runtime Profile 的运行时 Schema。

• 种类: 常量
• 导入: import { memoryRuntimeProfileSchema } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export declare const memoryRuntimeProfileSchema: ZodType<MemoryRuntimeProfile, ZodTypeDef, MemoryRuntimeProfile>;

validateMemoryRuntimeConfig

Validate Memory Runtime Config 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { validateMemoryRuntimeConfig } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export declare function validateMemoryRuntimeConfig(input: unknown): MemoryRuntimeConfig;

调用签名

validateMemoryRuntimeConfig(input: unknown): MemoryRuntimeConfig

参数

参数	类型	必需	说明
input	unknown	是	必需参数；接受的值由类型列定义。

返回值

• 类型: MemoryRuntimeConfig
• 说明: 返回值契约由上述类型定义。

MemoryManagementProviderFactory

Memory Management Provider Factory 接口，共包含 3 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryManagementProviderFactory } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export interface MemoryManagementProviderFactory {
    readonly id: string;
    supports(spec: MemoryManagementProviderSpec): boolean;
    create(context: MemoryManagementProviderFactoryContext): Promise<MemoryManagementProvider | MemoryManagementProviderInstallation>;
}

契约成员

成员	种类	签名	说明
create	方法	create(context: MemoryManagementProviderFactoryContext): Promise<MemoryManagementProvider | MemoryManagementProviderInstallation>	公开方法；参数与返回类型以签名列为准。
id	属性	readonly id: string	公开属性；类型、只读和可选状态以签名列为准。
supports	方法	supports(spec: MemoryManagementProviderSpec): boolean	公开方法；参数与返回类型以签名列为准。

MemoryManagementProviderFactoryContext

Memory Management Provider Factory Context 接口，共包含 3 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryManagementProviderFactoryContext } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export interface MemoryManagementProviderFactoryContext {
    profile: MemoryProfileSpec;
    spec: MemoryManagementProviderSpec;
    references?: ReadonlyMap<string, unknown>;
}

契约成员

成员	种类	签名	说明
profile	属性	profile: MemoryProfileSpec	公开属性；类型、只读和可选状态以签名列为准。
references	属性	references?: ReadonlyMap<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
spec	属性	spec: MemoryManagementProviderSpec	公开属性；类型、只读和可选状态以签名列为准。

MemoryManagementProviderInstallation

Memory Management Provider Installation 接口，共包含 4 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryManagementProviderInstallation } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export interface MemoryManagementProviderInstallation {
    provider: MemoryManagementProvider;
    reconciliationStore?: MemoryLifecycleTaskStore;
    resources?: unknown;
    close?(): Promise<void>;
}

契约成员

成员	种类	签名	说明
close	方法	close?(): Promise<void>	公开方法；参数与返回类型以签名列为准。
provider	属性	provider: MemoryManagementProvider	公开属性；类型、只读和可选状态以签名列为准。
reconciliationStore	属性	reconciliationStore?: MemoryLifecycleTaskStore	公开属性；类型、只读和可选状态以签名列为准。
resources	属性	resources?: unknown	公开属性；类型、只读和可选状态以签名列为准。

MemoryRuntime

Memory Runtime 接口，共包含 10 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryRuntime } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export interface MemoryRuntime {
    service: MemoryApplicationService;
    provider: MemoryManagementProvider;
    profile: MemoryProfileSpec;
    providerSpec: MemoryManagementProviderSpec;
    profileHash: string;
    capabilities: MemoryManagementCapabilities;
    compositionReceipt: MemoryRuntimeCompositionReceipt;
    resources?: unknown;
    close(): Promise<void>;
    telemetry?: MemoryProviderTelemetry;
}

契约成员

成员	种类	签名	说明
capabilities	属性	capabilities: MemoryManagementCapabilities	公开属性；类型、只读和可选状态以签名列为准。
close	方法	close(): Promise<void>	公开方法；参数与返回类型以签名列为准。
compositionReceipt	属性	compositionReceipt: MemoryRuntimeCompositionReceipt	公开属性；类型、只读和可选状态以签名列为准。
profile	属性	profile: MemoryProfileSpec	公开属性；类型、只读和可选状态以签名列为准。
profileHash	属性	profileHash: string	公开属性；类型、只读和可选状态以签名列为准。
provider	属性	provider: MemoryManagementProvider	公开属性；类型、只读和可选状态以签名列为准。
providerSpec	属性	providerSpec: MemoryManagementProviderSpec	公开属性；类型、只读和可选状态以签名列为准。
resources	属性	resources?: unknown	公开属性；类型、只读和可选状态以签名列为准。
service	属性	service: MemoryApplicationService	公开属性；类型、只读和可选状态以签名列为准。
telemetry	属性	telemetry?: MemoryProviderTelemetry	公开属性；类型、只读和可选状态以签名列为准。

MemoryRuntimeCompositionReceipt

Memory Runtime Composition Receipt 接口，共包含 10 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryRuntimeCompositionReceipt } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export interface MemoryRuntimeCompositionReceipt {
    runtimeId: string;
    serviceInstanceId: string;
    serviceContract: '@codesoul-co/hypha-memory.MemoryApplicationService';
    activeProfileId: string;
    providerId: string;
    providerSpecId: string;
    configHash: string;
    profileHash: string;
    resolvedDependencyRefs: string[];
    createdAt: string;
}

契约成员

成员	种类	签名	说明
activeProfileId	属性	activeProfileId: string	公开属性；类型、只读和可选状态以签名列为准。
configHash	属性	configHash: string	公开属性；类型、只读和可选状态以签名列为准。
createdAt	属性	createdAt: string	公开属性；类型、只读和可选状态以签名列为准。
profileHash	属性	profileHash: string	公开属性；类型、只读和可选状态以签名列为准。
providerId	属性	providerId: string	公开属性；类型、只读和可选状态以签名列为准。
providerSpecId	属性	providerSpecId: string	公开属性；类型、只读和可选状态以签名列为准。
resolvedDependencyRefs	属性	resolvedDependencyRefs: string[]	公开属性；类型、只读和可选状态以签名列为准。
runtimeId	属性	runtimeId: string	公开属性；类型、只读和可选状态以签名列为准。
serviceContract	属性	serviceContract: "@codesoul-co/hypha-memory.MemoryApplicationService"	公开属性；类型、只读和可选状态以签名列为准。
serviceInstanceId	属性	serviceInstanceId: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryRuntimeConfig

Memory Runtime Config 接口，共包含 2 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryRuntimeConfig } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export interface MemoryRuntimeConfig {
    activeProfile: string;
    profiles: Record<string, MemoryRuntimeProfile>;
}

契约成员

成员	种类	签名	说明
activeProfile	属性	activeProfile: string	公开属性；类型、只读和可选状态以签名列为准。
profiles	属性	profiles: Record<string, MemoryRuntimeProfile>	公开属性；类型、只读和可选状态以签名列为准。

MemoryRuntimeFactoryOptions

Memory Runtime Factory Options 接口，共包含 12 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryRuntimeFactoryOptions } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export interface MemoryRuntimeFactoryOptions {
    registry: MemoryManagementProviderRegistry;
    activities: DefaultMemoryActivityPortOptions;
    eventContext: (request: MemoryRuntimeRequestContext) => MemoryEventContext;
    contextBuilder?: MemoryContextBuilder;
    contextGateway?: ContextInjectionGateway;
    reconciliationStore?: MemoryLifecycleTaskStore;
    telemetry?: MemoryProviderTelemetry;
    operationalMetrics?: MemoryOperationalMetrics;
    providerCostEstimator?: MemoryProviderCostEstimator;
    searchCache?: MemoryRuntimeSearchCacheOptions;
    projectionInvalidation?: MemoryProjectionInvalidationPort;
    now?: () => string;
}

契约成员

成员	种类	签名	说明
activities	属性	activities: DefaultMemoryActivityPortOptions	公开属性；类型、只读和可选状态以签名列为准。
contextBuilder	属性	contextBuilder?: MemoryContextBuilder	公开属性；类型、只读和可选状态以签名列为准。
contextGateway	属性	contextGateway?: ContextInjectionGateway	公开属性；类型、只读和可选状态以签名列为准。
eventContext	方法	eventContext(request: MemoryRuntimeRequestContext): MemoryEventContext	公开方法；参数与返回类型以签名列为准。
now	方法	now?(): string	公开方法；参数与返回类型以签名列为准。
operationalMetrics	属性	operationalMetrics?: MemoryOperationalMetrics	公开属性；类型、只读和可选状态以签名列为准。
projectionInvalidation	属性	projectionInvalidation?: MemoryProjectionInvalidationPort	公开属性；类型、只读和可选状态以签名列为准。
providerCostEstimator	方法	providerCostEstimator?(operation: import("/Users/erwin/Downloads/codespace/Hypha/packages/memory/dist/provider-observability").MemoryProviderOperation, request: unknown): import("/Users/erwin/Downloads/codespace/Hypha/packages/memory/dist/provider-observability").MemoryProviderOperationEstimate	公开方法；参数与返回类型以签名列为准。
reconciliationStore	属性	reconciliationStore?: MemoryLifecycleTaskStore	公开属性；类型、只读和可选状态以签名列为准。
registry	属性	registry: MemoryManagementProviderRegistry	公开属性；类型、只读和可选状态以签名列为准。
searchCache	属性	searchCache?: MemoryRuntimeSearchCacheOptions	公开属性；类型、只读和可选状态以签名列为准。
telemetry	属性	telemetry?: MemoryProviderTelemetry	公开属性；类型、只读和可选状态以签名列为准。

MemoryRuntimeProfile

Memory Runtime Profile 接口，共包含 2 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryRuntimeProfile } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export interface MemoryRuntimeProfile {
    profile: MemoryProfileSpec;
    management: MemoryManagementProviderSpec;
}

契约成员

成员	种类	签名	说明
management	属性	management: MemoryManagementProviderSpec	公开属性；类型、只读和可选状态以签名列为准。
profile	属性	profile: MemoryProfileSpec	公开属性；类型、只读和可选状态以签名列为准。

MemoryRuntimeSearchCacheOptions

Memory Runtime Search Cache Options 公共类型别名；完整类型表达式见声明。

• 种类: 类型
• 导入: import type { MemoryRuntimeSearchCacheOptions } from '@codesoul-co/hypha-memory';
• 源码模块: memory-runtime-factory

声明

export type MemoryRuntimeSearchCacheOptions = Omit<CachedMemoryManagementProviderOptions, 'provider' | 'providerRevision' | 'requiredScopeFields' | 'cacheAuthorization' | 'requireCacheAuthorization'>;