@codesoul-co/hypha-memory / canonical-runtime-config

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/canonical-runtime-config.ts
• Exports: 7

Using this module

Use the Canonical runtime config module for executing runtime behavior at this boundary. It exports 1 class, 3 constants, 3 interfaces.

Import from the package entrypoint

import {
  CanonicalMemoryRuntimeLoader,
  canonicalMemoryRuntimeConfigExample,
  canonicalMemoryRuntimeConfigJsonSchema,
  canonicalMemoryRuntimeConfigSchema,
} from '@codesoul-co/hypha-memory';

import type {
  CanonicalMemoryRuntimeConfig,
  LoadedCanonicalMemoryRuntimeConfig,
  MemoryRuntimeReferenceResolver,
} from '@codesoul-co/hypha-memory';

Usage patterns

• Use the 3 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 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
• The 3 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Public exports

Symbol	Kind	Signature	Description
CanonicalMemoryRuntimeLoader	class	new CanonicalMemoryRuntimeLoader(resolver: MemoryRuntimeReferenceResolver): CanonicalMemoryRuntimeLoader	Canonical Memory Runtime Loader class with 3 public constructor or member entries; its exact declarations are listed below.
canonicalMemoryRuntimeConfigExample	constant	const canonicalMemoryRuntimeConfigExample: CanonicalMemoryRuntimeConfig	Valid example value for Canonical Memory Runtime Config.
canonicalMemoryRuntimeConfigJsonSchema	constant	const canonicalMemoryRuntimeConfigJsonSchema: JsonSchema	JSON Schema for Canonical Memory Runtime Config.
canonicalMemoryRuntimeConfigSchema	constant	const canonicalMemoryRuntimeConfigSchema: ZodType<CanonicalMemoryRuntimeConfig, ZodTypeDef, CanonicalMemoryRuntimeConfig>	Runtime schema for Canonical Memory Runtime Config.
CanonicalMemoryRuntimeConfig	interface	interface CanonicalMemoryRuntimeConfig extends MemoryRuntimeConfig	Canonical Memory Runtime Config interface with 3 public fields or methods.
LoadedCanonicalMemoryRuntimeConfig	interface	interface LoadedCanonicalMemoryRuntimeConfig	Loaded Canonical Memory Runtime Config interface with 2 public fields or methods.
MemoryRuntimeReferenceResolver	interface	interface MemoryRuntimeReferenceResolver	Memory Runtime Reference Resolver interface with 1 public fields or methods.

CanonicalMemoryRuntimeLoader

Canonical Memory Runtime Loader class with 3 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { CanonicalMemoryRuntimeLoader } from '@codesoul-co/hypha-memory';
• Source module: canonical-runtime-config

Declaration

export declare class CanonicalMemoryRuntimeLoader {
    constructor(resolver: MemoryRuntimeReferenceResolver);
    load(input: unknown): Promise<LoadedCanonicalMemoryRuntimeConfig>;
    create(factory: MemoryRuntimeFactory, input: unknown): Promise<MemoryRuntime>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(resolver: MemoryRuntimeReferenceResolver): CanonicalMemoryRuntimeLoader	Creates an instance of this class.
create	method	create(factory: MemoryRuntimeFactory, input: unknown): Promise<MemoryRuntime>	Public method; parameters and return type are shown in the signature.
load	method	load(input: unknown): Promise<LoadedCanonicalMemoryRuntimeConfig>	Public method; parameters and return type are shown in the signature.

canonicalMemoryRuntimeConfigExample

Valid example value for Canonical Memory Runtime Config.

• Kind: constant
• Import: import { canonicalMemoryRuntimeConfigExample } from '@codesoul-co/hypha-memory';
• Source module: canonical-runtime-config

Declaration

export declare const canonicalMemoryRuntimeConfigExample: CanonicalMemoryRuntimeConfig;

canonicalMemoryRuntimeConfigJsonSchema

JSON Schema for Canonical Memory Runtime Config.

• Kind: constant
• Import: import { canonicalMemoryRuntimeConfigJsonSchema } from '@codesoul-co/hypha-memory';
• Source module: canonical-runtime-config

Declaration

export declare const canonicalMemoryRuntimeConfigJsonSchema: JsonSchema;

canonicalMemoryRuntimeConfigSchema

Runtime schema for Canonical Memory Runtime Config.

• Kind: constant
• Import: import { canonicalMemoryRuntimeConfigSchema } from '@codesoul-co/hypha-memory';
• Source module: canonical-runtime-config

Declaration

export declare const canonicalMemoryRuntimeConfigSchema: ZodType<CanonicalMemoryRuntimeConfig, ZodTypeDef, CanonicalMemoryRuntimeConfig>;

CanonicalMemoryRuntimeConfig

Canonical Memory Runtime Config interface with 3 public fields or methods.

• Kind: interface
• Import: import type { CanonicalMemoryRuntimeConfig } from '@codesoul-co/hypha-memory';
• Source module: canonical-runtime-config

Declaration

export interface CanonicalMemoryRuntimeConfig extends MemoryRuntimeConfig {
    schemaVersion: '1.0';
}

Contract members

Member	Kind	Signature	Description
activeProfile	property	activeProfile: string	Public property; its type, readonly modifier and optionality are shown in the signature.
profiles	property	profiles: Record<string, MemoryRuntimeProfile>	Public property; its type, readonly modifier and optionality are shown in the signature.
schemaVersion	property	schemaVersion: "1.0"	Public property; its type, readonly modifier and optionality are shown in the signature.

LoadedCanonicalMemoryRuntimeConfig

Loaded Canonical Memory Runtime Config interface with 2 public fields or methods.

• Kind: interface
• Import: import type { LoadedCanonicalMemoryRuntimeConfig } from '@codesoul-co/hypha-memory';
• Source module: canonical-runtime-config

Declaration

export interface LoadedCanonicalMemoryRuntimeConfig {
    config: MemoryRuntimeConfig;
    references: ReadonlyMap<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
config	property	config: MemoryRuntimeConfig	Public property; its type, readonly modifier and optionality are shown in the signature.
references	property	references: ReadonlyMap<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryRuntimeReferenceResolver

Memory Runtime Reference Resolver interface with 1 public fields or methods.

• Kind: interface
• Import: import type { MemoryRuntimeReferenceResolver } from '@codesoul-co/hypha-memory';
• Source module: canonical-runtime-config

Declaration

export interface MemoryRuntimeReferenceResolver {
    resolve(reference: string, kind: 'connection' | 'secret' | 'environment' | 'dependency'): Promise<unknown>;
}

Contract members

Member	Kind	Signature	Description
resolve	method	resolve(reference: string, kind: "connection" | "secret" | "environment" | "dependency"): Promise<unknown>	Public method; parameters and return type are shown in the signature.