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

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

模块用法

用于执行该边界的运行时行为。Memory runtime coordinator 模块公开 3 类、8 接口、1 类型。

从包入口导入

import {
  InMemoryMemoryRuntimeControlStore,
  MemoryRuntimeCoordinator,
  StructuredMemoryRuntimeControlStore,
} from '@codesoul-co/hypha-memory';

import type {
  MemoryRuntimeActiveState,
  MemoryRuntimeControlStore,
  MemoryRuntimeCoordinatorOptions,
  MemoryRuntimeCreator,
  MemoryRuntimeGeneration,
  MemoryRuntimeRevisionState,
  MemoryRuntimeSwitchResult,
  StructuredMemoryRuntimeControlStoreOptions,
} from '@codesoul-co/hypha-memory';

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

使用要点

• 9 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
• 3 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。

公共导出

Symbol	种类	签名	说明
InMemoryMemoryRuntimeControlStore	类	new InMemoryMemoryRuntimeControlStore(): InMemoryMemoryRuntimeControlStore	In Memory Memory Runtime Control Store 类，共公开 7 个构造函数或成员；精确签名见本条目的声明与成员表。
MemoryRuntimeCoordinator	类	new MemoryRuntimeCoordinator(options: MemoryRuntimeCoordinatorOptions): MemoryRuntimeCoordinator	Memory Runtime Coordinator 类，共公开 8 个构造函数或成员；精确签名见本条目的声明与成员表。
StructuredMemoryRuntimeControlStore	类	new StructuredMemoryRuntimeControlStore(options: StructuredMemoryRuntimeControlStoreOptions): StructuredMemoryRuntimeControlStore	Structured Memory Runtime Control Store 类，共公开 7 个构造函数或成员；精确签名见本条目的声明与成员表。
MemoryRuntimeActiveState	接口	interface MemoryRuntimeActiveState extends MemoryRuntimeRevisionState	Memory Runtime Active State 接口，共包含 14 个公开字段或方法。
MemoryRuntimeControlStore	接口	interface MemoryRuntimeControlStore	Memory Runtime Control Store 接口，共包含 6 个公开字段或方法。
MemoryRuntimeCoordinatorOptions	接口	interface MemoryRuntimeCoordinatorOptions	Memory Runtime Coordinator Options 接口，共包含 6 个公开字段或方法。
MemoryRuntimeCreator	接口	interface MemoryRuntimeCreator	Memory Runtime Creator 接口，共包含 1 个公开字段或方法。
MemoryRuntimeGeneration	接口	interface MemoryRuntimeGeneration	Memory Runtime Generation 接口，共包含 6 个公开字段或方法。
MemoryRuntimeRevisionState	接口	interface MemoryRuntimeRevisionState	Memory Runtime Revision State 接口，共包含 14 个公开字段或方法。
MemoryRuntimeSwitchResult	接口	interface MemoryRuntimeSwitchResult extends MemoryRuntimeGeneration	Memory Runtime Switch Result 接口，共包含 7 个公开字段或方法。
StructuredMemoryRuntimeControlStoreOptions	接口	interface StructuredMemoryRuntimeControlStoreOptions	Structured Memory Runtime Control Store Options 接口，共包含 3 个公开字段或方法。
MemoryRuntimeRevisionStatus	类型	type MemoryRuntimeRevisionStatus = 'active' | 'draining' | 'retired' | 'quarantined'	Memory Runtime Revision Status 公共类型别名；完整类型表达式见声明。

InMemoryMemoryRuntimeControlStore

In Memory Memory Runtime Control Store 类，共公开 7 个构造函数或成员；精确签名见本条目的声明与成员表。

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

声明

export declare class InMemoryMemoryRuntimeControlStore implements MemoryRuntimeControlStore {
    readonly durability: "ephemeral";
    getActive(coordinatorId: string): Promise<MemoryRuntimeActiveState | null>;
    activate(coordinatorId: string, expectedGeneration: number | null, next: MemoryRuntimeActiveState, previous?: MemoryRuntimeRevisionState): Promise<boolean>;
    getRevision(coordinatorId: string, profileRevision: string): Promise<MemoryRuntimeRevisionState | null>;
    setRevision(state: MemoryRuntimeRevisionState): Promise<void>;
    listRevisions(coordinatorId: string): Promise<MemoryRuntimeRevisionState[]>;
}

公开成员

成员	种类	签名	说明
activate	方法	activate(coordinatorId: string, expectedGeneration: number | null, next: MemoryRuntimeActiveState, previous?: MemoryRuntimeRevisionState): Promise<boolean>	公开方法；参数与返回类型以签名列为准。
constructor	构造函数	(): InMemoryMemoryRuntimeControlStore	创建该类的实例。
durability	属性	readonly durability: "ephemeral"	公开属性；类型、只读和可选状态以签名列为准。
getActive	方法	getActive(coordinatorId: string): Promise<MemoryRuntimeActiveState | null>	公开方法；参数与返回类型以签名列为准。
getRevision	方法	getRevision(coordinatorId: string, profileRevision: string): Promise<MemoryRuntimeRevisionState | null>	公开方法；参数与返回类型以签名列为准。
listRevisions	方法	listRevisions(coordinatorId: string): Promise<MemoryRuntimeRevisionState[]>	公开方法；参数与返回类型以签名列为准。
setRevision	方法	setRevision(state: MemoryRuntimeRevisionState): Promise<void>	公开方法；参数与返回类型以签名列为准。

MemoryRuntimeCoordinator

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

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

声明

export declare class MemoryRuntimeCoordinator {
    constructor(options: MemoryRuntimeCoordinatorOptions);
    initialize(input: unknown, references?: ReadonlyMap<string, unknown>): Promise<MemoryRuntimeSwitchResult>;
    switchRevision(input: unknown, references?: ReadonlyMap<string, unknown>, expectedProfileRevision?: string): Promise<MemoryRuntimeSwitchResult>;
    withRuntime<T>(operation: (runtime: MemoryRuntime, generation: MemoryRuntimeGeneration) => Promise<T>): Promise<T>;
    probeActive(): Promise<MemoryRuntimeRevisionState>;
    current(): MemoryRuntimeGeneration | null;
    drain(): Promise<void>;
    close(): Promise<void>;
}

公开成员

成员	种类	签名	说明
close	方法	close(): Promise<void>	公开方法；参数与返回类型以签名列为准。
constructor	构造函数	(options: MemoryRuntimeCoordinatorOptions): MemoryRuntimeCoordinator	创建该类的实例。
current	方法	current(): MemoryRuntimeGeneration | null	公开方法；参数与返回类型以签名列为准。
drain	方法	drain(): Promise<void>	公开方法；参数与返回类型以签名列为准。
initialize	方法	initialize(input: unknown, references?: ReadonlyMap<string, unknown>): Promise<MemoryRuntimeSwitchResult>	公开方法；参数与返回类型以签名列为准。
probeActive	方法	probeActive(): Promise<MemoryRuntimeRevisionState>	公开方法；参数与返回类型以签名列为准。
switchRevision	方法	switchRevision(input: unknown, references?: ReadonlyMap<string, unknown>, expectedProfileRevision?: string): Promise<MemoryRuntimeSwitchResult>	公开方法；参数与返回类型以签名列为准。
withRuntime	方法	withRuntime<T>(operation: (runtime: MemoryRuntime, generation: MemoryRuntimeGeneration) => Promise<T>): Promise<T>	公开方法；参数与返回类型以签名列为准。

StructuredMemoryRuntimeControlStore

Structured Memory Runtime Control Store 类，共公开 7 个构造函数或成员；精确签名见本条目的声明与成员表。

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

声明

export declare class StructuredMemoryRuntimeControlStore implements MemoryRuntimeControlStore {
    readonly durability: "durable";
    constructor(options: StructuredMemoryRuntimeControlStoreOptions);
    getActive(coordinatorId: string): Promise<MemoryRuntimeActiveState | null>;
    activate(coordinatorId: string, expectedGeneration: number | null, next: MemoryRuntimeActiveState, previous?: MemoryRuntimeRevisionState): Promise<boolean>;
    getRevision(coordinatorId: string, profileRevision: string): Promise<MemoryRuntimeRevisionState | null>;
    setRevision(state: MemoryRuntimeRevisionState): Promise<void>;
    listRevisions(coordinatorId: string): Promise<MemoryRuntimeRevisionState[]>;
}

公开成员

成员	种类	签名	说明
activate	方法	activate(coordinatorId: string, expectedGeneration: number | null, next: MemoryRuntimeActiveState, previous?: MemoryRuntimeRevisionState): Promise<boolean>	公开方法；参数与返回类型以签名列为准。
constructor	构造函数	(options: StructuredMemoryRuntimeControlStoreOptions): StructuredMemoryRuntimeControlStore	创建该类的实例。
durability	属性	readonly durability: "durable"	公开属性；类型、只读和可选状态以签名列为准。
getActive	方法	getActive(coordinatorId: string): Promise<MemoryRuntimeActiveState | null>	公开方法；参数与返回类型以签名列为准。
getRevision	方法	getRevision(coordinatorId: string, profileRevision: string): Promise<MemoryRuntimeRevisionState | null>	公开方法；参数与返回类型以签名列为准。
listRevisions	方法	listRevisions(coordinatorId: string): Promise<MemoryRuntimeRevisionState[]>	公开方法；参数与返回类型以签名列为准。
setRevision	方法	setRevision(state: MemoryRuntimeRevisionState): Promise<void>	公开方法；参数与返回类型以签名列为准。

MemoryRuntimeActiveState

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

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

声明

export interface MemoryRuntimeActiveState extends MemoryRuntimeRevisionState {
    id: string;
}

契约成员

成员	种类	签名	说明
capabilityHash	属性	capabilityHash: string	公开属性；类型、只读和可选状态以签名列为准。
capabilitySnapshot	属性	capabilitySnapshot: MemoryManagementCapabilities	公开属性；类型、只读和可选状态以签名列为准。
coordinatorId	属性	coordinatorId: string	公开属性；类型、只读和可选状态以签名列为准。
generation	属性	generation: number	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
observedAt	属性	observedAt: string	公开属性；类型、只读和可选状态以签名列为准。
profileHash	属性	profileHash: string	公开属性；类型、只读和可选状态以签名列为准。
profileId	属性	profileId: string	公开属性；类型、只读和可选状态以签名列为准。
profileRevision	属性	profileRevision: string	公开属性；类型、只读和可选状态以签名列为准。
providerId	属性	providerId: string	公开属性；类型、只读和可选状态以签名列为准。
providerRevision	属性	providerRevision: string	公开属性；类型、只读和可选状态以签名列为准。
quarantineError	属性	quarantineError?: NormalizedMemoryError	公开属性；类型、只读和可选状态以签名列为准。
runtimeId	属性	runtimeId: string	公开属性；类型、只读和可选状态以签名列为准。
status	属性	status: MemoryRuntimeRevisionStatus	公开属性；类型、只读和可选状态以签名列为准。

MemoryRuntimeControlStore

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

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

声明

export interface MemoryRuntimeControlStore {
    readonly durability: 'ephemeral' | 'durable';
    getActive(coordinatorId: string): Promise<MemoryRuntimeActiveState | null>;
    activate(coordinatorId: string, expectedGeneration: number | null, next: MemoryRuntimeActiveState, previous?: MemoryRuntimeRevisionState): Promise<boolean>;
    getRevision(coordinatorId: string, profileRevision: string): Promise<MemoryRuntimeRevisionState | null>;
    setRevision(state: MemoryRuntimeRevisionState): Promise<void>;
    listRevisions(coordinatorId: string): Promise<MemoryRuntimeRevisionState[]>;
}

契约成员

成员	种类	签名	说明
activate	方法	activate(coordinatorId: string, expectedGeneration: number | null, next: MemoryRuntimeActiveState, previous?: MemoryRuntimeRevisionState): Promise<boolean>	公开方法；参数与返回类型以签名列为准。
durability	属性	readonly durability: "ephemeral" | "durable"	公开属性；类型、只读和可选状态以签名列为准。
getActive	方法	getActive(coordinatorId: string): Promise<MemoryRuntimeActiveState | null>	公开方法；参数与返回类型以签名列为准。
getRevision	方法	getRevision(coordinatorId: string, profileRevision: string): Promise<MemoryRuntimeRevisionState | null>	公开方法；参数与返回类型以签名列为准。
listRevisions	方法	listRevisions(coordinatorId: string): Promise<MemoryRuntimeRevisionState[]>	公开方法；参数与返回类型以签名列为准。
setRevision	方法	setRevision(state: MemoryRuntimeRevisionState): Promise<void>	公开方法；参数与返回类型以签名列为准。

MemoryRuntimeCoordinatorOptions

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

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

声明

export interface MemoryRuntimeCoordinatorOptions {
    id: string;
    factory: MemoryRuntimeFactory | MemoryRuntimeCreator;
    store: MemoryRuntimeControlStore;
    requireDurableStore?: boolean;
    now?: () => Date;
    capabilityProbeIntervalMs?: number;
}

契约成员

成员	种类	签名	说明
capabilityProbeIntervalMs	属性	capabilityProbeIntervalMs?: number	公开属性；类型、只读和可选状态以签名列为准。
factory	属性	factory: MemoryRuntimeFactory | MemoryRuntimeCreator	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
now	方法	now?(): Date	公开方法；参数与返回类型以签名列为准。
requireDurableStore	属性	requireDurableStore?: boolean	公开属性；类型、只读和可选状态以签名列为准。
store	属性	store: MemoryRuntimeControlStore	公开属性；类型、只读和可选状态以签名列为准。

MemoryRuntimeCreator

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

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

声明

export interface MemoryRuntimeCreator {
    create(input: unknown, references?: ReadonlyMap<string, unknown>): Promise<MemoryRuntime>;
}

契约成员

成员	种类	签名	说明
create	方法	create(input: unknown, references?: ReadonlyMap<string, unknown>): Promise<MemoryRuntime>	公开方法；参数与返回类型以签名列为准。

MemoryRuntimeGeneration

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

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

声明

export interface MemoryRuntimeGeneration {
    generation: number;
    profileId: string;
    profileRevision: string;
    providerId: string;
    providerRevision: string;
    runtimeId: string;
}

契约成员

成员	种类	签名	说明
generation	属性	generation: number	公开属性；类型、只读和可选状态以签名列为准。
profileId	属性	profileId: string	公开属性；类型、只读和可选状态以签名列为准。
profileRevision	属性	profileRevision: string	公开属性；类型、只读和可选状态以签名列为准。
providerId	属性	providerId: string	公开属性；类型、只读和可选状态以签名列为准。
providerRevision	属性	providerRevision: string	公开属性；类型、只读和可选状态以签名列为准。
runtimeId	属性	runtimeId: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryRuntimeRevisionState

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

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

声明

export interface MemoryRuntimeRevisionState {
    id: string;
    coordinatorId: string;
    profileId: string;
    profileRevision: string;
    providerId: string;
    providerRevision: string;
    runtimeId: string;
    profileHash: string;
    capabilityHash: string;
    capabilitySnapshot: MemoryManagementCapabilities;
    status: MemoryRuntimeRevisionStatus;
    generation: number;
    observedAt: string;
    quarantineError?: NormalizedMemoryError;
}

契约成员

成员	种类	签名	说明
capabilityHash	属性	capabilityHash: string	公开属性；类型、只读和可选状态以签名列为准。
capabilitySnapshot	属性	capabilitySnapshot: MemoryManagementCapabilities	公开属性；类型、只读和可选状态以签名列为准。
coordinatorId	属性	coordinatorId: string	公开属性；类型、只读和可选状态以签名列为准。
generation	属性	generation: number	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
observedAt	属性	observedAt: string	公开属性；类型、只读和可选状态以签名列为准。
profileHash	属性	profileHash: string	公开属性；类型、只读和可选状态以签名列为准。
profileId	属性	profileId: string	公开属性；类型、只读和可选状态以签名列为准。
profileRevision	属性	profileRevision: string	公开属性；类型、只读和可选状态以签名列为准。
providerId	属性	providerId: string	公开属性；类型、只读和可选状态以签名列为准。
providerRevision	属性	providerRevision: string	公开属性；类型、只读和可选状态以签名列为准。
quarantineError	属性	quarantineError?: NormalizedMemoryError	公开属性；类型、只读和可选状态以签名列为准。
runtimeId	属性	runtimeId: string	公开属性；类型、只读和可选状态以签名列为准。
status	属性	status: MemoryRuntimeRevisionStatus	公开属性；类型、只读和可选状态以签名列为准。

MemoryRuntimeSwitchResult

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

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

声明

export interface MemoryRuntimeSwitchResult extends MemoryRuntimeGeneration {
    previousProfileRevision?: string;
}

契约成员

成员	种类	签名	说明
generation	属性	generation: number	公开属性；类型、只读和可选状态以签名列为准。
previousProfileRevision	属性	previousProfileRevision?: string	公开属性；类型、只读和可选状态以签名列为准。
profileId	属性	profileId: string	公开属性；类型、只读和可选状态以签名列为准。
profileRevision	属性	profileRevision: string	公开属性；类型、只读和可选状态以签名列为准。
providerId	属性	providerId: string	公开属性；类型、只读和可选状态以签名列为准。
providerRevision	属性	providerRevision: string	公开属性；类型、只读和可选状态以签名列为准。
runtimeId	属性	runtimeId: string	公开属性；类型、只读和可选状态以签名列为准。

StructuredMemoryRuntimeControlStoreOptions

Structured Memory Runtime Control Store Options 接口，共包含 3 个公开字段或方法。

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

声明

export interface StructuredMemoryRuntimeControlStoreOptions {
    provider: StructuredStoreProvider;
    activeTable?: string;
    revisionTable?: string;
}

契约成员

成员	种类	签名	说明
activeTable	属性	activeTable?: string	公开属性；类型、只读和可选状态以签名列为准。
provider	属性	provider: StructuredStoreProvider	公开属性；类型、只读和可选状态以签名列为准。
revisionTable	属性	revisionTable?: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryRuntimeRevisionStatus

Memory Runtime Revision Status 公共类型别名；完整类型表达式见声明。

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

声明

export type MemoryRuntimeRevisionStatus = 'active' | 'draining' | 'retired' | 'quarantined';