@codesoul-co/hypha-memory / context-source-resolver

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/context-source-resolver.ts
• Exports: 5

Using this module

Use the Context source resolver module for using the public contracts and operations for this capability boundary. It exports 3 classes, 1 interface, 1 type.

Import from the package entrypoint

import {
  CallbackContextSourceResolver,
  DefaultContextSourceResolverRegistry,
  SourceResolvingMemoryContextBuilder,
} from '@codesoul-co/hypha-memory';

import type {
  CallbackContextSourceResolverOptions,
  ContextSourceLoader,
} 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 3 classes as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
CallbackContextSourceResolver	class	new CallbackContextSourceResolver(options: CallbackContextSourceResolverOptions): CallbackContextSourceResolver	Callback Context Source Resolver class with 4 public constructor or member entries; its exact declarations are listed below.
DefaultContextSourceResolverRegistry	class	new DefaultContextSourceResolverRegistry(resolvers: readonly ContextSourceResolver[]): DefaultContextSourceResolverRegistry	Default Context Source Resolver Registry class with 2 public constructor or member entries; its exact declarations are listed below.
SourceResolvingMemoryContextBuilder	class	new SourceResolvingMemoryContextBuilder(sources: ContextSourceResolverRegistry, builder?: MemoryContextBuilder): SourceResolvingMemoryContextBuilder	Source Resolving Memory Context Builder class with 3 public constructor or member entries; its exact declarations are listed below.
CallbackContextSourceResolverOptions	interface	interface CallbackContextSourceResolverOptions	Callback Context Source Resolver Options interface with 3 public fields or methods.
ContextSourceLoader	type	type ContextSourceLoader = (request: ContextSourceResolutionInput) => Promise<ContextItem[]>	Public type alias for Context Source Loader; the declaration contains its complete type expression.

CallbackContextSourceResolver

Callback Context Source Resolver class with 4 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { CallbackContextSourceResolver } from '@codesoul-co/hypha-memory';
• Source module: context-source-resolver

Declaration

export declare class CallbackContextSourceResolver implements ContextSourceResolver {
    readonly id: string;
    constructor(options: CallbackContextSourceResolverOptions);
    supports(source: ContextSourceSpec): boolean;
    resolve(request: ContextSourceResolutionInput): Promise<ContextItem[]>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: CallbackContextSourceResolverOptions): CallbackContextSourceResolver	Creates an instance of this class.
id	property	readonly id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
resolve	method	resolve(request: ContextSourceResolutionInput): Promise<ContextItem[]>	Public method; parameters and return type are shown in the signature.
supports	method	supports(source: ContextSourceSpec): boolean	Public method; parameters and return type are shown in the signature.

DefaultContextSourceResolverRegistry

Default Context Source Resolver Registry class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DefaultContextSourceResolverRegistry } from '@codesoul-co/hypha-memory';
• Source module: context-source-resolver

Declaration

export declare class DefaultContextSourceResolverRegistry implements ContextSourceResolverRegistry {
    constructor(resolvers: readonly ContextSourceResolver[]);
    resolve(request: ResolvedContextBuildInput): Promise<ContextItem[]>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(resolvers: readonly ContextSourceResolver[]): DefaultContextSourceResolverRegistry	Creates an instance of this class.
resolve	method	resolve(request: ResolvedContextBuildInput): Promise<ContextItem[]>	Public method; parameters and return type are shown in the signature.

SourceResolvingMemoryContextBuilder

Source Resolving Memory Context Builder class with 3 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { SourceResolvingMemoryContextBuilder } from '@codesoul-co/hypha-memory';
• Source module: context-source-resolver

Declaration

export declare class SourceResolvingMemoryContextBuilder {
    constructor(sources: ContextSourceResolverRegistry, builder?: MemoryContextBuilder);
    build(request: ResolvedContextBuildInput): Promise<ContextBundle>;
    explain(contextHash: string): Promise<ContextBuildExplanation | null>;
}

Public members

Member	Kind	Signature	Description
build	method	build(request: ResolvedContextBuildInput): Promise<ContextBundle>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(sources: ContextSourceResolverRegistry, builder?: MemoryContextBuilder): SourceResolvingMemoryContextBuilder	Creates an instance of this class.
explain	method	explain(contextHash: string): Promise<ContextBuildExplanation | null>	Public method; parameters and return type are shown in the signature.

CallbackContextSourceResolverOptions

Callback Context Source Resolver Options interface with 3 public fields or methods.

• Kind: interface
• Import: import type { CallbackContextSourceResolverOptions } from '@codesoul-co/hypha-memory';
• Source module: context-source-resolver

Declaration

export interface CallbackContextSourceResolverOptions {
    id: string;
    sourceTypes: ContextSourceType[];
    load: ContextSourceLoader;
}

Contract members

Member	Kind	Signature	Description
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
load	method	load(request: ContextSourceResolutionInput): Promise<ContextItem[]>	Public method; parameters and return type are shown in the signature.
sourceTypes	property	sourceTypes: ContextSourceType[]	Public property; its type, readonly modifier and optionality are shown in the signature.

ContextSourceLoader

Public type alias for Context Source Loader; the declaration contains its complete type expression.

• Kind: type
• Import: import type { ContextSourceLoader } from '@codesoul-co/hypha-memory';
• Source module: context-source-resolver

Declaration

export type ContextSourceLoader = (request: ContextSourceResolutionInput) => Promise<ContextItem[]>;