@codesoul-co/hypha-memory / lifecycle-workers

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/lifecycle-workers.ts
• Exports: 15

Using this module

Use the Lifecycle workers module for using the public contracts and operations for this capability boundary. It exports 8 classes, 5 interfaces, 2 types.

Import from the package entrypoint

import {
  InMemoryMemoryLifecycleTaskStore,
  LeasedMemoryLifecycleWorker,
  MemoryConsolidationWorker,
  MemoryDecayWorker,
  MemoryDeletionWorker,
  MemoryReindexWorker,
  MemoryRetentionWorker,
  ProviderReconciliationWorker,
} from '@codesoul-co/hypha-memory';

import type {
  MemoryLifecycleTask,
  MemoryLifecycleTaskStore,
  MemoryLifecycleWorkerEvent,
  MemoryLifecycleWorkerOptions,
  MemoryLifecycleWorkerRunResult,
  MemoryLifecycleTaskHandler,
  MemoryLifecycleWorkerType,
} from '@codesoul-co/hypha-memory';

Usage patterns

• Use the 7 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 8 classes as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
InMemoryMemoryLifecycleTaskStore	class	new InMemoryMemoryLifecycleTaskStore(): InMemoryMemoryLifecycleTaskStore	In Memory Memory Lifecycle Task Store class with 7 public constructor or member entries; its exact declarations are listed below.
LeasedMemoryLifecycleWorker	class	new LeasedMemoryLifecycleWorker(options: MemoryLifecycleWorkerOptions): LeasedMemoryLifecycleWorker	Leased Memory Lifecycle Worker class with 6 public constructor or member entries; its exact declarations are listed below.
MemoryConsolidationWorker	class	new MemoryConsolidationWorker(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryConsolidationWorker	Memory Consolidation Worker class with 6 public constructor or member entries; its exact declarations are listed below.
MemoryDecayWorker	class	new MemoryDecayWorker(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryDecayWorker	Memory Decay Worker class with 6 public constructor or member entries; its exact declarations are listed below.
MemoryDeletionWorker	class	new MemoryDeletionWorker(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryDeletionWorker	Memory Deletion Worker class with 6 public constructor or member entries; its exact declarations are listed below.
MemoryReindexWorker	class	new MemoryReindexWorker(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryReindexWorker	Memory Reindex Worker class with 6 public constructor or member entries; its exact declarations are listed below.
MemoryRetentionWorker	class	new MemoryRetentionWorker(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryRetentionWorker	Memory Retention Worker class with 6 public constructor or member entries; its exact declarations are listed below.
ProviderReconciliationWorker	class	new ProviderReconciliationWorker(options: Omit<MemoryLifecycleWorkerOptions, "type">): ProviderReconciliationWorker	Provider Reconciliation Worker class with 6 public constructor or member entries; its exact declarations are listed below.
MemoryLifecycleTask	interface	interface MemoryLifecycleTask	Memory Lifecycle Task interface with 15 public fields or methods.
MemoryLifecycleTaskStore	interface	interface MemoryLifecycleTaskStore	Memory Lifecycle Task Store interface with 6 public fields or methods.
MemoryLifecycleWorkerEvent	interface	interface MemoryLifecycleWorkerEvent	Memory Lifecycle Worker Event interface with 5 public fields or methods.
MemoryLifecycleWorkerOptions	interface	interface MemoryLifecycleWorkerOptions	Memory Lifecycle Worker Options interface with 12 public fields or methods.
MemoryLifecycleWorkerRunResult	interface	interface MemoryLifecycleWorkerRunResult	Memory Lifecycle Worker Run Result interface with 4 public fields or methods.
MemoryLifecycleTaskHandler	type	type MemoryLifecycleTaskHandler = (task: MemoryLifecycleTask, signal: AbortSignal) => Promise<void>	Public type alias for Memory Lifecycle Task Handler; the declaration contains its complete type expression.
MemoryLifecycleWorkerType	type	type MemoryLifecycleWorkerType = 'retention' | 'decay' | 'consolidation' | 'deletion' | 'reindex' | 'provider_reconciliation'	Public type alias for Memory Lifecycle Worker Type; the declaration contains its complete type expression.

InMemoryMemoryLifecycleTaskStore

In Memory Memory Lifecycle Task Store class with 7 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { InMemoryMemoryLifecycleTaskStore } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export declare class InMemoryMemoryLifecycleTaskStore implements MemoryLifecycleTaskStore {
    enqueue(task: MemoryLifecycleTask): Promise<void>;
    lease(type: MemoryLifecycleWorkerType, ownerId: string, now: string, leaseUntil: string, limit: number): Promise<MemoryLifecycleTask[]>;
    renew(taskId: string, ownerId: string, leaseToken: string, now: string, leaseUntil: string): Promise<boolean>;
    complete(taskId: string, ownerId: string, leaseToken: string, now: string): Promise<boolean>;
    fail(taskId: string, ownerId: string, leaseToken: string, now: string, error: NormalizedMemoryError, retryAt: string, deadLetter: boolean): Promise<boolean>;
    list(type?: MemoryLifecycleWorkerType): Promise<MemoryLifecycleTask[]>;
}

Public members

Member	Kind	Signature	Description
complete	method	complete(taskId: string, ownerId: string, leaseToken: string, now: string): Promise<boolean>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(): InMemoryMemoryLifecycleTaskStore	Creates an instance of this class.
enqueue	method	enqueue(task: MemoryLifecycleTask): Promise<void>	Public method; parameters and return type are shown in the signature.
fail	method	fail(taskId: string, ownerId: string, leaseToken: string, now: string, error: NormalizedMemoryError, retryAt: string, deadLetter: boolean): Promise<boolean>	Public method; parameters and return type are shown in the signature.
lease	method	lease(type: MemoryLifecycleWorkerType, ownerId: string, now: string, leaseUntil: string, limit: number): Promise<MemoryLifecycleTask[]>	Public method; parameters and return type are shown in the signature.
list	method	list(type?: MemoryLifecycleWorkerType): Promise<MemoryLifecycleTask[]>	Public method; parameters and return type are shown in the signature.
renew	method	renew(taskId: string, ownerId: string, leaseToken: string, now: string, leaseUntil: string): Promise<boolean>	Public method; parameters and return type are shown in the signature.

LeasedMemoryLifecycleWorker

Leased Memory Lifecycle Worker class with 6 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { LeasedMemoryLifecycleWorker } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export declare class LeasedMemoryLifecycleWorker {
    constructor(options: MemoryLifecycleWorkerOptions);
    runOnce(): Promise<MemoryLifecycleWorkerRunResult>;
    start(): void;
    stop(): void;
    drain(): Promise<void>;
    stopAndDrain(): Promise<void>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: MemoryLifecycleWorkerOptions): LeasedMemoryLifecycleWorker	Creates an instance of this class.
drain	method	drain(): Promise<void>	Public method; parameters and return type are shown in the signature.
runOnce	method	runOnce(): Promise<MemoryLifecycleWorkerRunResult>	Public method; parameters and return type are shown in the signature.
start	method	start(): void	Public method; parameters and return type are shown in the signature.
stop	method	stop(): void	Public method; parameters and return type are shown in the signature.
stopAndDrain	method	stopAndDrain(): Promise<void>	Public method; parameters and return type are shown in the signature.

MemoryConsolidationWorker

Memory Consolidation Worker class with 6 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { MemoryConsolidationWorker } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export declare class MemoryConsolidationWorker extends LeasedMemoryLifecycleWorker {
    constructor(options: Omit<MemoryLifecycleWorkerOptions, 'type'>);
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryConsolidationWorker	Creates an instance of this class.
drain	method	drain(): Promise<void>	Public method; parameters and return type are shown in the signature.
runOnce	method	runOnce(): Promise<MemoryLifecycleWorkerRunResult>	Public method; parameters and return type are shown in the signature.
start	method	start(): void	Public method; parameters and return type are shown in the signature.
stop	method	stop(): void	Public method; parameters and return type are shown in the signature.
stopAndDrain	method	stopAndDrain(): Promise<void>	Public method; parameters and return type are shown in the signature.

MemoryDecayWorker

Memory Decay Worker class with 6 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { MemoryDecayWorker } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export declare class MemoryDecayWorker extends LeasedMemoryLifecycleWorker {
    constructor(options: Omit<MemoryLifecycleWorkerOptions, 'type'>);
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryDecayWorker	Creates an instance of this class.
drain	method	drain(): Promise<void>	Public method; parameters and return type are shown in the signature.
runOnce	method	runOnce(): Promise<MemoryLifecycleWorkerRunResult>	Public method; parameters and return type are shown in the signature.
start	method	start(): void	Public method; parameters and return type are shown in the signature.
stop	method	stop(): void	Public method; parameters and return type are shown in the signature.
stopAndDrain	method	stopAndDrain(): Promise<void>	Public method; parameters and return type are shown in the signature.

MemoryDeletionWorker

Memory Deletion Worker class with 6 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { MemoryDeletionWorker } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export declare class MemoryDeletionWorker extends LeasedMemoryLifecycleWorker {
    constructor(options: Omit<MemoryLifecycleWorkerOptions, 'type'>);
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryDeletionWorker	Creates an instance of this class.
drain	method	drain(): Promise<void>	Public method; parameters and return type are shown in the signature.
runOnce	method	runOnce(): Promise<MemoryLifecycleWorkerRunResult>	Public method; parameters and return type are shown in the signature.
start	method	start(): void	Public method; parameters and return type are shown in the signature.
stop	method	stop(): void	Public method; parameters and return type are shown in the signature.
stopAndDrain	method	stopAndDrain(): Promise<void>	Public method; parameters and return type are shown in the signature.

MemoryReindexWorker

Memory Reindex Worker class with 6 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { MemoryReindexWorker } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export declare class MemoryReindexWorker extends LeasedMemoryLifecycleWorker {
    constructor(options: Omit<MemoryLifecycleWorkerOptions, 'type'>);
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryReindexWorker	Creates an instance of this class.
drain	method	drain(): Promise<void>	Public method; parameters and return type are shown in the signature.
runOnce	method	runOnce(): Promise<MemoryLifecycleWorkerRunResult>	Public method; parameters and return type are shown in the signature.
start	method	start(): void	Public method; parameters and return type are shown in the signature.
stop	method	stop(): void	Public method; parameters and return type are shown in the signature.
stopAndDrain	method	stopAndDrain(): Promise<void>	Public method; parameters and return type are shown in the signature.

MemoryRetentionWorker

Memory Retention Worker class with 6 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { MemoryRetentionWorker } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export declare class MemoryRetentionWorker extends LeasedMemoryLifecycleWorker {
    constructor(options: Omit<MemoryLifecycleWorkerOptions, 'type'>);
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryRetentionWorker	Creates an instance of this class.
drain	method	drain(): Promise<void>	Public method; parameters and return type are shown in the signature.
runOnce	method	runOnce(): Promise<MemoryLifecycleWorkerRunResult>	Public method; parameters and return type are shown in the signature.
start	method	start(): void	Public method; parameters and return type are shown in the signature.
stop	method	stop(): void	Public method; parameters and return type are shown in the signature.
stopAndDrain	method	stopAndDrain(): Promise<void>	Public method; parameters and return type are shown in the signature.

ProviderReconciliationWorker

Provider Reconciliation Worker class with 6 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { ProviderReconciliationWorker } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export declare class ProviderReconciliationWorker extends LeasedMemoryLifecycleWorker {
    constructor(options: Omit<MemoryLifecycleWorkerOptions, 'type'>);
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: Omit<MemoryLifecycleWorkerOptions, "type">): ProviderReconciliationWorker	Creates an instance of this class.
drain	method	drain(): Promise<void>	Public method; parameters and return type are shown in the signature.
runOnce	method	runOnce(): Promise<MemoryLifecycleWorkerRunResult>	Public method; parameters and return type are shown in the signature.
start	method	start(): void	Public method; parameters and return type are shown in the signature.
stop	method	stop(): void	Public method; parameters and return type are shown in the signature.
stopAndDrain	method	stopAndDrain(): Promise<void>	Public method; parameters and return type are shown in the signature.

MemoryLifecycleTask

Memory Lifecycle Task interface with 15 public fields or methods.

• Kind: interface
• Import: import type { MemoryLifecycleTask } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export interface MemoryLifecycleTask<TPayload = unknown> {
    id: string;
    operationId: string;
    type: MemoryLifecycleWorkerType;
    scopeHash: string;
    payload: TPayload;
    state: 'pending' | 'processing' | 'completed' | 'failed' | 'dead_letter';
    attempts: number;
    availableAt: string;
    leaseOwner?: string;
    leaseToken?: string;
    leaseExpiresAt?: string;
    fencingToken?: number;
    lastError?: NormalizedMemoryError;
    createdAt: string;
    updatedAt: string;
}

Contract members

Member	Kind	Signature	Description
attempts	property	attempts: number	Public property; its type, readonly modifier and optionality are shown in the signature.
availableAt	property	availableAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAt	property	createdAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
fencingToken	property	fencingToken?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
lastError	property	lastError?: NormalizedMemoryError	Public property; its type, readonly modifier and optionality are shown in the signature.
leaseExpiresAt	property	leaseExpiresAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
leaseOwner	property	leaseOwner?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
leaseToken	property	leaseToken?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
payload	property	payload: TPayload	Public property; its type, readonly modifier and optionality are shown in the signature.
scopeHash	property	scopeHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
state	property	state: "completed" | "failed" | "processing" | "pending" | "dead_letter"	Public property; its type, readonly modifier and optionality are shown in the signature.
type	property	type: MemoryLifecycleWorkerType	Public property; its type, readonly modifier and optionality are shown in the signature.
updatedAt	property	updatedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryLifecycleTaskStore

Memory Lifecycle Task Store interface with 6 public fields or methods.

• Kind: interface
• Import: import type { MemoryLifecycleTaskStore } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export interface MemoryLifecycleTaskStore {
    enqueue(task: MemoryLifecycleTask): Promise<void>;
    lease(type: MemoryLifecycleWorkerType, ownerId: string, now: string, leaseUntil: string, limit: number): Promise<MemoryLifecycleTask[]>;
    renew(taskId: string, ownerId: string, leaseToken: string, now: string, leaseUntil: string): Promise<boolean>;
    complete(taskId: string, ownerId: string, leaseToken: string, now: string): Promise<boolean>;
    fail(taskId: string, ownerId: string, leaseToken: string, now: string, error: NormalizedMemoryError, retryAt: string, deadLetter: boolean): Promise<boolean>;
    list(type?: MemoryLifecycleWorkerType): Promise<MemoryLifecycleTask[]>;
}

Contract members

Member	Kind	Signature	Description
complete	method	complete(taskId: string, ownerId: string, leaseToken: string, now: string): Promise<boolean>	Public method; parameters and return type are shown in the signature.
enqueue	method	enqueue(task: MemoryLifecycleTask): Promise<void>	Public method; parameters and return type are shown in the signature.
fail	method	fail(taskId: string, ownerId: string, leaseToken: string, now: string, error: NormalizedMemoryError, retryAt: string, deadLetter: boolean): Promise<boolean>	Public method; parameters and return type are shown in the signature.
lease	method	lease(type: MemoryLifecycleWorkerType, ownerId: string, now: string, leaseUntil: string, limit: number): Promise<MemoryLifecycleTask[]>	Public method; parameters and return type are shown in the signature.
list	method	list(type?: MemoryLifecycleWorkerType): Promise<MemoryLifecycleTask[]>	Public method; parameters and return type are shown in the signature.
renew	method	renew(taskId: string, ownerId: string, leaseToken: string, now: string, leaseUntil: string): Promise<boolean>	Public method; parameters and return type are shown in the signature.

MemoryLifecycleWorkerEvent

Memory Lifecycle Worker Event interface with 5 public fields or methods.

• Kind: interface
• Import: import type { MemoryLifecycleWorkerEvent } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export interface MemoryLifecycleWorkerEvent {
    type: 'memory.worker.started' | 'memory.worker.stopped' | 'memory.worker.failed' | 'memory.worker.dead_lettered';
    workerType: MemoryLifecycleWorkerType;
    taskId?: string;
    operationId?: string;
    error?: NormalizedMemoryError;
}

Contract members

Member	Kind	Signature	Description
error	property	error?: NormalizedMemoryError	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
taskId	property	taskId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
type	property	type: "memory.worker.started" | "memory.worker.stopped" | "memory.worker.failed" | "memory.worker.dead_lettered"	Public property; its type, readonly modifier and optionality are shown in the signature.
workerType	property	workerType: MemoryLifecycleWorkerType	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryLifecycleWorkerOptions

Memory Lifecycle Worker Options interface with 12 public fields or methods.

• Kind: interface
• Import: import type { MemoryLifecycleWorkerOptions } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export interface MemoryLifecycleWorkerOptions {
    type: MemoryLifecycleWorkerType;
    ownerId: string;
    store: MemoryLifecycleTaskStore;
    handler: MemoryLifecycleTaskHandler;
    batchSize?: number;
    leaseMs?: number;
    renewalMs?: number;
    retryDelayMs?: number;
    maxAttempts?: number;
    pollIntervalMs?: number;
    now?: () => Date;
    onEvent?: (event: MemoryLifecycleWorkerEvent) => void | Promise<void>;
}

Contract members

Member	Kind	Signature	Description
batchSize	property	batchSize?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
handler	method	handler(task: MemoryLifecycleTask, signal: AbortSignal): Promise<void>	Public method; parameters and return type are shown in the signature.
leaseMs	property	leaseMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxAttempts	property	maxAttempts?: number	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.
onEvent	method	onEvent?(event: MemoryLifecycleWorkerEvent): void | Promise<void>	Public method; parameters and return type are shown in the signature.
ownerId	property	ownerId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
pollIntervalMs	property	pollIntervalMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
renewalMs	property	renewalMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
retryDelayMs	property	retryDelayMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
store	property	store: MemoryLifecycleTaskStore	Public property; its type, readonly modifier and optionality are shown in the signature.
type	property	type: MemoryLifecycleWorkerType	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryLifecycleWorkerRunResult

Memory Lifecycle Worker Run Result interface with 4 public fields or methods.

• Kind: interface
• Import: import type { MemoryLifecycleWorkerRunResult } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export interface MemoryLifecycleWorkerRunResult {
    leased: number;
    completed: number;
    failed: number;
    deadLettered: number;
}

Contract members

Member	Kind	Signature	Description
completed	property	completed: number	Public property; its type, readonly modifier and optionality are shown in the signature.
deadLettered	property	deadLettered: number	Public property; its type, readonly modifier and optionality are shown in the signature.
failed	property	failed: number	Public property; its type, readonly modifier and optionality are shown in the signature.
leased	property	leased: number	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryLifecycleTaskHandler

Public type alias for Memory Lifecycle Task Handler; the declaration contains its complete type expression.

• Kind: type
• Import: import type { MemoryLifecycleTaskHandler } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export type MemoryLifecycleTaskHandler = (task: MemoryLifecycleTask, signal: AbortSignal) => Promise<void>;

MemoryLifecycleWorkerType

Public type alias for Memory Lifecycle Worker Type; the declaration contains its complete type expression.

• Kind: type
• Import: import type { MemoryLifecycleWorkerType } from '@codesoul-co/hypha-memory';
• Source module: lifecycle-workers

Declaration

export type MemoryLifecycleWorkerType = 'retention' | 'decay' | 'consolidation' | 'deletion' | 'reindex' | 'provider_reconciliation';