@codesoul-co/hypha-memory / memory-projection-invalidation

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/memory-projection-invalidation.ts
• Exports: 9

Using this module

Use the Memory projection invalidation module for using the public contracts and operations for this capability boundary. It exports 3 classes, 5 interfaces, 1 type.

Import from the package entrypoint

import {
  InMemoryMemoryMutationGenerationStore,
  MemoryProjectionInvalidationCoordinator,
  MemorySearchCacheInvalidationTarget,
} from '@codesoul-co/hypha-memory';

import type {
  MemoryMutationGenerationStore,
  MemoryProjectionInvalidationPort,
  MemoryProjectionInvalidationReceipt,
  MemoryProjectionInvalidationRequest,
  MemoryProjectionInvalidationTarget,
  MemoryProjectionInvalidationReason,
} from '@codesoul-co/hypha-memory';

Usage patterns

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

Public exports

Symbol	Kind	Signature	Description
InMemoryMemoryMutationGenerationStore	class	new InMemoryMemoryMutationGenerationStore(): InMemoryMemoryMutationGenerationStore	In Memory Memory Mutation Generation Store class with 3 public constructor or member entries; its exact declarations are listed below.
MemoryProjectionInvalidationCoordinator	class	new MemoryProjectionInvalidationCoordinator(generations: MemoryMutationGenerationStore, targets: readonly MemoryProjectionInvalidationTarget[]): MemoryProjectionInvalidationCoordinator	Memory Projection Invalidation Coordinator class with 2 public constructor or member entries; its exact declarations are listed below.
MemorySearchCacheInvalidationTarget	class	new MemorySearchCacheInvalidationTarget(store: MemorySearchCacheStore, id?: string): MemorySearchCacheInvalidationTarget	Memory Search Cache Invalidation Target class with 3 public constructor or member entries; its exact declarations are listed below.
MemoryMutationGenerationStore	interface	interface MemoryMutationGenerationStore	Memory Mutation Generation Store interface with 2 public fields or methods.
MemoryProjectionInvalidationPort	interface	interface MemoryProjectionInvalidationPort	Memory Projection Invalidation Port interface with 1 public fields or methods.
MemoryProjectionInvalidationReceipt	interface	interface MemoryProjectionInvalidationReceipt	Memory Projection Invalidation Receipt interface with 5 public fields or methods.
MemoryProjectionInvalidationRequest	interface	interface MemoryProjectionInvalidationRequest	Memory Projection Invalidation Request interface with 5 public fields or methods.
MemoryProjectionInvalidationTarget	interface	interface MemoryProjectionInvalidationTarget	Memory Projection Invalidation Target interface with 2 public fields or methods.
MemoryProjectionInvalidationReason	type	type MemoryProjectionInvalidationReason = 'updated' | 'deleted'	Public type alias for Memory Projection Invalidation Reason; the declaration contains its complete type expression.

InMemoryMemoryMutationGenerationStore

In Memory Memory Mutation Generation Store class with 3 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { InMemoryMemoryMutationGenerationStore } from '@codesoul-co/hypha-memory';
• Source module: memory-projection-invalidation

Declaration

export declare class InMemoryMemoryMutationGenerationStore implements MemoryMutationGenerationStore {
    current(scopeHash: string): Promise<string>;
    advance(scopeHash: string, operationId: string): Promise<string>;
}

Public members

Member	Kind	Signature	Description
advance	method	advance(scopeHash: string, operationId: string): Promise<string>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(): InMemoryMemoryMutationGenerationStore	Creates an instance of this class.
current	method	current(scopeHash: string): Promise<string>	Public method; parameters and return type are shown in the signature.

MemoryProjectionInvalidationCoordinator

Memory Projection Invalidation Coordinator class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { MemoryProjectionInvalidationCoordinator } from '@codesoul-co/hypha-memory';
• Source module: memory-projection-invalidation

Declaration

export declare class MemoryProjectionInvalidationCoordinator implements MemoryProjectionInvalidationPort {
    constructor(generations: MemoryMutationGenerationStore, targets: readonly MemoryProjectionInvalidationTarget[]);
    invalidate(request: MemoryProjectionInvalidationRequest): Promise<MemoryProjectionInvalidationReceipt>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(generations: MemoryMutationGenerationStore, targets: readonly MemoryProjectionInvalidationTarget[]): MemoryProjectionInvalidationCoordinator	Creates an instance of this class.
invalidate	method	invalidate(request: MemoryProjectionInvalidationRequest): Promise<MemoryProjectionInvalidationReceipt>	Public method; parameters and return type are shown in the signature.

MemorySearchCacheInvalidationTarget

Memory Search Cache Invalidation Target class with 3 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { MemorySearchCacheInvalidationTarget } from '@codesoul-co/hypha-memory';
• Source module: memory-projection-invalidation

Declaration

export declare class MemorySearchCacheInvalidationTarget implements MemoryProjectionInvalidationTarget {
    readonly id: string;
    constructor(store: MemorySearchCacheStore, id?: string);
    invalidateScope(scopeHash: string): Promise<number>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(store: MemorySearchCacheStore, id?: string): MemorySearchCacheInvalidationTarget	Creates an instance of this class.
id	property	readonly id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
invalidateScope	method	invalidateScope(scopeHash: string): Promise<number>	Public method; parameters and return type are shown in the signature.

MemoryMutationGenerationStore

Memory Mutation Generation Store interface with 2 public fields or methods.

• Kind: interface
• Import: import type { MemoryMutationGenerationStore } from '@codesoul-co/hypha-memory';
• Source module: memory-projection-invalidation

Declaration

export interface MemoryMutationGenerationStore {
    current(scopeHash: string): Promise<string>;
    advance(scopeHash: string, operationId: string): Promise<string>;
}

Contract members

Member	Kind	Signature	Description
advance	method	advance(scopeHash: string, operationId: string): Promise<string>	Public method; parameters and return type are shown in the signature.
current	method	current(scopeHash: string): Promise<string>	Public method; parameters and return type are shown in the signature.

MemoryProjectionInvalidationPort

Memory Projection Invalidation Port interface with 1 public fields or methods.

• Kind: interface
• Import: import type { MemoryProjectionInvalidationPort } from '@codesoul-co/hypha-memory';
• Source module: memory-projection-invalidation

Declaration

export interface MemoryProjectionInvalidationPort {
    invalidate(request: MemoryProjectionInvalidationRequest): Promise<MemoryProjectionInvalidationReceipt>;
}

Contract members

Member	Kind	Signature	Description
invalidate	method	invalidate(request: MemoryProjectionInvalidationRequest): Promise<MemoryProjectionInvalidationReceipt>	Public method; parameters and return type are shown in the signature.

MemoryProjectionInvalidationReceipt

Memory Projection Invalidation Receipt interface with 5 public fields or methods.

• Kind: interface
• Import: import type { MemoryProjectionInvalidationReceipt } from '@codesoul-co/hypha-memory';
• Source module: memory-projection-invalidation

Declaration

export interface MemoryProjectionInvalidationReceipt {
    operationId: string;
    scopeHash: string;
    mutationGeneration: string;
    reason: MemoryProjectionInvalidationReason;
    targets: Array<{
        id: string;
        invalidatedEntries: number;
    }>;
}

Contract members

Member	Kind	Signature	Description
mutationGeneration	property	mutationGeneration: 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.
reason	property	reason: MemoryProjectionInvalidationReason	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.
targets	property	targets: { id: string; invalidatedEntries: number; }[]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryProjectionInvalidationRequest

Memory Projection Invalidation Request interface with 5 public fields or methods.

• Kind: interface
• Import: import type { MemoryProjectionInvalidationRequest } from '@codesoul-co/hypha-memory';
• Source module: memory-projection-invalidation

Declaration

export interface MemoryProjectionInvalidationRequest {
    operationId: string;
    scope: ManagedMemoryScope;
    reason: MemoryProjectionInvalidationReason;
    memoryIds: string[];
    memoryVersionIds?: string[];
}

Contract members

Member	Kind	Signature	Description
memoryIds	property	memoryIds: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryVersionIds	property	memoryVersionIds?: 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.
reason	property	reason: MemoryProjectionInvalidationReason	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: ManagedMemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryProjectionInvalidationTarget

Memory Projection Invalidation Target interface with 2 public fields or methods.

• Kind: interface
• Import: import type { MemoryProjectionInvalidationTarget } from '@codesoul-co/hypha-memory';
• Source module: memory-projection-invalidation

Declaration

export interface MemoryProjectionInvalidationTarget {
    readonly id: string;
    invalidateScope(scopeHash: string, mutationGeneration: string): Promise<number>;
}

Contract members

Member	Kind	Signature	Description
id	property	readonly id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
invalidateScope	method	invalidateScope(scopeHash: string, mutationGeneration: string): Promise<number>	Public method; parameters and return type are shown in the signature.

MemoryProjectionInvalidationReason

Public type alias for Memory Projection Invalidation Reason; the declaration contains its complete type expression.

• Kind: type
• Import: import type { MemoryProjectionInvalidationReason } from '@codesoul-co/hypha-memory';
• Source module: memory-projection-invalidation

Declaration

export type MemoryProjectionInvalidationReason = 'updated' | 'deleted';