`@codesoul-co/hypha-adapters-local` / `index`

Package index: @codesoul-co/hypha-adapters-local
Source: packages/adapters-local/src/index.ts
Exports: 26

Using this module

Aggregates the public entrypoint exports for @codesoul-co/hypha-adapters-local; applications import these symbols from the package entrypoint instead of internal file paths.

Import from the package entrypoint

import {
  ArtifactStoreToolPort,
  FileArtifactStore,
  FileMCPCapabilityCatalogStore,
  FileToolContractSnapshotStore,
  FileToolObservationStore,
  FileToolRuntimeStore,
  InMemoryArtifactStore,
  InMemoryStructuredStore,
} from '@codesoul-co/hypha-adapters-local';

import type {
  FileArtifactStoreOptions,
  FileToolRuntimeStoreOptions,
  LocalAdapterProfile,
  LocalHashEmbeddingProviderOptions,
  LocalStorageBackbone,
  LocalStorageBackboneOptions,
  LocalVectorIndexProviderOptions,
  SQLiteEventStoreOptions,
} from '@codesoul-co/hypha-adapters-local';

// The complete export list is documented below.

Usage patterns

Use the 9 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 14 classes as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
The module exposes 2 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
The 1 constant/enum export provides stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Public exports

Symbol	Kind	Signature	Description
`ArtifactStoreToolPort`	class	`new ArtifactStoreToolPort(artifacts: ArtifactStoreProvider): ArtifactStoreToolPort`	Artifact Store Tool Port class with 2 public constructor or member entries; its exact declarations are listed below.
`FileArtifactStore`	class	`new FileArtifactStore(options: FileArtifactStoreOptions): FileArtifactStore`	File Artifact Store class with 4 public constructor or member entries; its exact declarations are listed below.
`FileMCPCapabilityCatalogStore`	class	`new FileMCPCapabilityCatalogStore(filename: string): FileMCPCapabilityCatalogStore`	File MCP Capability Catalog Store class with 3 public constructor or member entries; its exact declarations are listed below.
`FileToolContractSnapshotStore`	class	`new FileToolContractSnapshotStore(rootPath: string): FileToolContractSnapshotStore`	File Tool Contract Snapshot Store class with 3 public constructor or member entries; its exact declarations are listed below.
`FileToolObservationStore`	class	`new FileToolObservationStore(rootPath: string): FileToolObservationStore`	File Tool Observation Store class with 2 public constructor or member entries; its exact declarations are listed below.
`FileToolRuntimeStore`	class	`new FileToolRuntimeStore(options: FileToolRuntimeStoreOptions): FileToolRuntimeStore`	File Tool Runtime Store class with 13 public constructor or member entries; its exact declarations are listed below.
`InMemoryArtifactStore`	class	`new InMemoryArtifactStore(): InMemoryArtifactStore`	In Memory Artifact Store class with 4 public constructor or member entries; its exact declarations are listed below.
`InMemoryStructuredStore`	class	`new InMemoryStructuredStore(): InMemoryStructuredStore`	In Memory Structured Store class with 7 public constructor or member entries; its exact declarations are listed below.
`InMemoryVectorIndexProvider`	class	`new InMemoryVectorIndexProvider(): InMemoryVectorIndexProvider`	In Memory Vector Index Provider class with 4 public constructor or member entries; its exact declarations are listed below.
`LocalHashEmbeddingProvider`	class	`new LocalHashEmbeddingProvider(options?: LocalHashEmbeddingProviderOptions): LocalHashEmbeddingProvider`	Zero-dependency lexical embedding for the local backbone. This is deliberately named by its algorithm rather than presented as a neural semantic model. Token and character n-gram feature hashing gives related local text stable overlap while keeping dimensions and persistence deterministic. Deployments that require semantic recall should inject a concrete embedding Provider through `createLocalStorageBackbone`.
`LocalVectorIndexProvider`	class	`new LocalVectorIndexProvider(options: LocalVectorIndexProviderOptions): LocalVectorIndexProvider`	Local Vector Index Provider class with 4 public constructor or member entries; its exact declarations are listed below.
`MockEmbeddingProvider`	class	`new MockEmbeddingProvider(): MockEmbeddingProvider`	Mock Embedding Provider class with 2 public constructor or member entries; its exact declarations are listed below.
`SQLiteEventStore`	class	`new SQLiteEventStore(options: SQLiteEventStoreOptions): SQLiteEventStore`	SQLite Event Store class with 6 public constructor or member entries; its exact declarations are listed below.
`SQLiteStructuredStore`	class	`new SQLiteStructuredStore(options: SQLiteStructuredStoreOptions): SQLiteStructuredStore`	SQLite Structured Store class with 7 public constructor or member entries; its exact declarations are listed below.
`LOCAL_ADAPTER_TYPES`	constant	`const LOCAL_ADAPTER_TYPES: readonly ["sqlite", "local-vector", "file-artifact"]`	LOCAL ADAPTER TYPES constant exported by the `index` module.
`createLocalStorageBackbone`	function	`createLocalStorageBackbone(options: LocalStorageBackboneOptions): LocalStorageBackbone`	Create Local Storage Backbone function with 1 public call signature; parameters and return types are listed below.
`createLocalStorageProfiles`	function	`createLocalStorageProfiles(input: { eventDbFilename: string; structuredDbFilename: string; vectorFilename: string; artifactRootPath: string; }): StorageProviderProfile[]`	Create Local Storage Profiles function with 1 public call signature; parameters and return types are listed below.
`FileArtifactStoreOptions`	interface	`interface FileArtifactStoreOptions`	File Artifact Store Options interface with 1 public fields or methods.
`FileToolRuntimeStoreOptions`	interface	`interface FileToolRuntimeStoreOptions`	File Tool Runtime Store Options interface with 1 public fields or methods.
`LocalAdapterProfile`	interface	`interface LocalAdapterProfile`	Local Adapter Profile interface with 4 public fields or methods.
`LocalHashEmbeddingProviderOptions`	interface	`interface LocalHashEmbeddingProviderOptions`	Local Hash Embedding Provider Options interface with 1 public fields or methods.
`LocalStorageBackbone`	interface	`interface LocalStorageBackbone`	Local Storage Backbone interface with 7 public fields or methods.
`LocalStorageBackboneOptions`	interface	`interface LocalStorageBackboneOptions`	Local Storage Backbone Options interface with 8 public fields or methods.
`LocalVectorIndexProviderOptions`	interface	`interface LocalVectorIndexProviderOptions`	Local Vector Index Provider Options interface with 1 public fields or methods.
`SQLiteEventStoreOptions`	interface	`interface SQLiteEventStoreOptions`	SQLite Event Store Options interface with 3 public fields or methods.
`SQLiteStructuredStoreOptions`	interface	`interface SQLiteStructuredStoreOptions`	SQLite Structured Store Options interface with 3 public fields or methods.

`ArtifactStoreToolPort`

Artifact Store Tool Port class with 2 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { ArtifactStoreToolPort } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class ArtifactStoreToolPort implements ToolArtifactPort {
    constructor(artifacts: ArtifactStoreProvider);
    store(request: {
            invocationId: string;
            toolId: string;
            value: unknown;
            mimeType?: string;
            metadata?: Record<string, unknown>;
        }): Promise<string>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(artifacts: ArtifactStoreProvider): ArtifactStoreToolPort`	Creates an instance of this class.
`store`	method	`store(request: { invocationId: string; toolId: string; value: unknown; mimeType?: string; metadata?: Record<string, unknown>; }): Promise<string>`	Public method; parameters and return type are shown in the signature.

`FileArtifactStore`

File Artifact Store class with 4 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { FileArtifactStore } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class FileArtifactStore implements ArtifactStoreProvider {
    constructor(options: FileArtifactStoreOptions);
    put(filePath: string, content: Buffer | string, meta?: ArtifactMeta): Promise<ArtifactRef>;
    get(ref: ArtifactRef): Promise<Buffer>;
    delete(ref: ArtifactRef): Promise<void>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(options: FileArtifactStoreOptions): FileArtifactStore`	Creates an instance of this class.
`delete`	method	`delete(ref: ArtifactRef): Promise<void>`	Public method; parameters and return type are shown in the signature.
`get`	method	`get(ref: ArtifactRef): Promise<Buffer>`	Public method; parameters and return type are shown in the signature.
`put`	method	`put(filePath: string, content: Buffer \| string, meta?: ArtifactMeta): Promise<ArtifactRef>`	Public method; parameters and return type are shown in the signature.

`FileMCPCapabilityCatalogStore`

File MCP Capability Catalog Store class with 3 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { FileMCPCapabilityCatalogStore } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class FileMCPCapabilityCatalogStore implements MCPCapabilityCatalogStore {
    constructor(filename: string);
    list(serverId?: string): Promise<MCPCapabilityRecord[]>;
    save(record: MCPCapabilityRecord, options?: {
            expected?: MCPCapabilityRecord | null;
        }): Promise<boolean>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(filename: string): FileMCPCapabilityCatalogStore`	Creates an instance of this class.
`list`	method	`list(serverId?: string): Promise<MCPCapabilityRecord[]>`	Public method; parameters and return type are shown in the signature.
`save`	method	`save(record: MCPCapabilityRecord, options?: { expected?: MCPCapabilityRecord \| null; }): Promise<boolean>`	Public method; parameters and return type are shown in the signature.

`FileToolContractSnapshotStore`

File Tool Contract Snapshot Store class with 3 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { FileToolContractSnapshotStore } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class FileToolContractSnapshotStore implements ToolContractSnapshotStore {
    constructor(rootPath: string);
    get(snapshotId: string): Promise<ToolContractSnapshot | null>;
    save(snapshot: ToolContractSnapshot): Promise<void>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(rootPath: string): FileToolContractSnapshotStore`	Creates an instance of this class.
`get`	method	`get(snapshotId: string): Promise<ToolContractSnapshot \| null>`	Public method; parameters and return type are shown in the signature.
`save`	method	`save(snapshot: ToolContractSnapshot): Promise<void>`	Public method; parameters and return type are shown in the signature.

`FileToolObservationStore`

File Tool Observation Store class with 2 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { FileToolObservationStore } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class FileToolObservationStore implements ToolObservationPort {
    constructor(rootPath: string);
    record(request: {
            invocationId: string;
            toolId: string;
            toolRevision: string;
            runId: string;
            stepId: string;
            inputHash: string;
            outputHash: string;
            value: unknown;
            artifactRefs?: string[];
            provenance: Record<string, unknown>;
        }): Promise<string>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(rootPath: string): FileToolObservationStore`	Creates an instance of this class.
`record`	method	`record(request: { invocationId: string; toolId: string; toolRevision: string; runId: string; stepId: string; inputHash: string; outputHash: string; value: unknown; artifactRefs?: string[]; provenance: Record<string, unknown>; }): Promise<string>`	Public method; parameters and return type are shown in the signature.

`FileToolRuntimeStore`

File Tool Runtime Store class with 13 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { FileToolRuntimeStore } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class FileToolRuntimeStore implements ToolInvocationStore, ToolApprovalStore {
    constructor(options: FileToolRuntimeStoreOptions);
    get(invocationId: string): Promise<ToolInvocationRecord | null>;
    findByIdempotency(request: ToolIdempotencyLookup): Promise<ToolInvocationRecord | null>;
    list(request?: ToolInvocationListRequest): Promise<ToolInvocationRecord[]>;
    create(record: ToolInvocationRecord): Promise<ToolInvocationRecord>;
    update(invocationId: string, patch: ToolInvocationPatch, options?: {
            expectedStatuses?: readonly ToolInvocationStatus[];
            expectedRevision?: number;
        }): Promise<ToolInvocationRecord>;
    getCompleted(invocationId: string): Promise<ToolCallResult | null>;
    saveCompleted(invocationId: string, result: ToolCallResult): Promise<void>;
    getRequest(invocationId: string): Promise<ToolApprovalRequest | null>;
    requestApproval(request: ToolApprovalRequest): Promise<ToolApprovalRequest>;
    getGrant(invocationId: string): Promise<ToolApprovalGrant | null>;
    approve(invocationId: string, approvedBy: string, options?: {
            approvedAt?: string;
            expiresAt?: string;
        }): Promise<ToolApprovalGrant>;
    reject(invocationId: string): Promise<ToolApprovalRequest>;
}

Public members

Member	Kind	Signature	Description
`approve`	method	`approve(invocationId: string, approvedBy: string, options?: { approvedAt?: string; expiresAt?: string; }): Promise<ToolApprovalGrant>`	Public method; parameters and return type are shown in the signature.
`constructor`	constructor	`(options: FileToolRuntimeStoreOptions): FileToolRuntimeStore`	Creates an instance of this class.
`create`	method	`create(record: ToolInvocationRecord): Promise<ToolInvocationRecord>`	Public method; parameters and return type are shown in the signature.
`findByIdempotency`	method	`findByIdempotency(request: ToolIdempotencyLookup): Promise<ToolInvocationRecord \| null>`	Public method; parameters and return type are shown in the signature.
`get`	method	`get(invocationId: string): Promise<ToolInvocationRecord \| null>`	Public method; parameters and return type are shown in the signature.
`getCompleted`	method	`getCompleted(invocationId: string): Promise<ToolCallResult \| null>`	Public method; parameters and return type are shown in the signature.
`getGrant`	method	`getGrant(invocationId: string): Promise<ToolApprovalGrant \| null>`	Public method; parameters and return type are shown in the signature.
`getRequest`	method	`getRequest(invocationId: string): Promise<ToolApprovalRequest \| null>`	Public method; parameters and return type are shown in the signature.
`list`	method	`list(request?: ToolInvocationListRequest): Promise<ToolInvocationRecord[]>`	Public method; parameters and return type are shown in the signature.
`reject`	method	`reject(invocationId: string): Promise<ToolApprovalRequest>`	Public method; parameters and return type are shown in the signature.
`requestApproval`	method	`requestApproval(request: ToolApprovalRequest): Promise<ToolApprovalRequest>`	Public method; parameters and return type are shown in the signature.
`saveCompleted`	method	`saveCompleted(invocationId: string, result: ToolCallResult): Promise<void>`	Public method; parameters and return type are shown in the signature.
`update`	method	`update(invocationId: string, patch: ToolInvocationPatch, options?: { expectedStatuses?: readonly ToolInvocationStatus[]; expectedRevision?: number; }): Promise<ToolInvocationRecord>`	Public method; parameters and return type are shown in the signature.

`InMemoryArtifactStore`

In Memory Artifact Store class with 4 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { InMemoryArtifactStore } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class InMemoryArtifactStore implements ArtifactStoreProvider {
    put(path: string, content: Buffer | string, meta?: ArtifactMeta): Promise<ArtifactRef>;
    get(ref: ArtifactRef): Promise<Buffer>;
    delete(ref: ArtifactRef): Promise<void>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(): InMemoryArtifactStore`	Creates an instance of this class.
`delete`	method	`delete(ref: ArtifactRef): Promise<void>`	Public method; parameters and return type are shown in the signature.
`get`	method	`get(ref: ArtifactRef): Promise<Buffer>`	Public method; parameters and return type are shown in the signature.
`put`	method	`put(path: string, content: Buffer \| string, meta?: ArtifactMeta): Promise<ArtifactRef>`	Public method; parameters and return type are shown in the signature.

`InMemoryStructuredStore`

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

Kind: class
Import: import { InMemoryStructuredStore } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class InMemoryStructuredStore implements StructuredStoreProvider {
    get<T>(table: string, id: string): Promise<T | null>;
    insert<T extends {
            id: string;
        }>(table: string, record: T): Promise<void>;
    update<T>(table: string, id: string, patch: Partial<T>): Promise<void>;
    delete(table: string, id: string): Promise<void>;
    query<T>(table: string, query: StructuredQuery): Promise<T[]>;
    transaction<T>(fn: (tx: StructuredStoreProvider) => Promise<T>): Promise<T>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(): InMemoryStructuredStore`	Creates an instance of this class.
`delete`	method	`delete(table: string, id: string): Promise<void>`	Public method; parameters and return type are shown in the signature.
`get`	method	`get<T>(table: string, id: string): Promise<T \| null>`	Public method; parameters and return type are shown in the signature.
`insert`	method	`insert<T extends { id: string; }>(table: string, record: T): Promise<void>`	Public method; parameters and return type are shown in the signature.
`query`	method	`query<T>(table: string, query: StructuredQuery): Promise<T[]>`	Public method; parameters and return type are shown in the signature.
`transaction`	method	`transaction<T>(fn: (tx: StructuredStoreProvider) => Promise<T>): Promise<T>`	Public method; parameters and return type are shown in the signature.
`update`	method	`update<T>(table: string, id: string, patch: Partial<T>): Promise<void>`	Public method; parameters and return type are shown in the signature.

`InMemoryVectorIndexProvider`

In Memory Vector Index Provider class with 4 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { InMemoryVectorIndexProvider } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class InMemoryVectorIndexProvider implements VectorIndexProvider {
    upsert(records: VectorRecord[]): Promise<void>;
    search(query: VectorQuery): Promise<VectorSearchResult[]>;
    delete(ids: string[]): Promise<void>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(): InMemoryVectorIndexProvider`	Creates an instance of this class.
`delete`	method	`delete(ids: string[]): Promise<void>`	Public method; parameters and return type are shown in the signature.
`search`	method	`search(query: VectorQuery): Promise<VectorSearchResult[]>`	Public method; parameters and return type are shown in the signature.
`upsert`	method	`upsert(records: VectorRecord[]): Promise<void>`	Public method; parameters and return type are shown in the signature.

`LocalHashEmbeddingProvider`

Zero-dependency lexical embedding for the local backbone. This is deliberately named by its algorithm rather than presented as a neural semantic model. Token and character n-gram feature hashing gives related local text stable overlap while keeping dimensions and persistence deterministic. Deployments that require semantic recall should inject a concrete embedding Provider through createLocalStorageBackbone.

Kind: class
Import: import { LocalHashEmbeddingProvider } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class LocalHashEmbeddingProvider implements EmbeddingProvider {
    constructor(options?: LocalHashEmbeddingProviderOptions);
    embed(input: string[]): Promise<number[][]>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(options?: LocalHashEmbeddingProviderOptions): LocalHashEmbeddingProvider`	Creates an instance of this class.
`embed`	method	`embed(input: string[]): Promise<number[][]>`	Public method; parameters and return type are shown in the signature.

`LocalVectorIndexProvider`

Local Vector Index Provider class with 4 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { LocalVectorIndexProvider } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class LocalVectorIndexProvider implements VectorIndexProvider {
    constructor(options: LocalVectorIndexProviderOptions);
    upsert(records: VectorRecord[]): Promise<void>;
    search(query: VectorQuery): Promise<VectorSearchResult[]>;
    delete(ids: string[]): Promise<void>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(options: LocalVectorIndexProviderOptions): LocalVectorIndexProvider`	Creates an instance of this class.
`delete`	method	`delete(ids: string[]): Promise<void>`	Public method; parameters and return type are shown in the signature.
`search`	method	`search(query: VectorQuery): Promise<VectorSearchResult[]>`	Public method; parameters and return type are shown in the signature.
`upsert`	method	`upsert(records: VectorRecord[]): Promise<void>`	Public method; parameters and return type are shown in the signature.

`MockEmbeddingProvider`

Mock Embedding Provider class with 2 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { MockEmbeddingProvider } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class MockEmbeddingProvider implements EmbeddingProvider {
    embed(input: string[]): Promise<number[][]>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(): MockEmbeddingProvider`	Creates an instance of this class.
`embed`	method	`embed(input: string[]): Promise<number[][]>`	Public method; parameters and return type are shown in the signature.

`SQLiteEventStore`

SQLite Event Store class with 6 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { SQLiteEventStore } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class SQLiteEventStore implements EventStore, TraceRecorder {
    constructor(options: SQLiteEventStoreOptions);
    append(event: FrameworkEvent): Promise<void>;
    record(event: FrameworkEvent): Promise<void>;
    list(filter?: EventFilter): Promise<FrameworkEvent[]>;
    exportJsonl(filename: string, filter?: EventFilter): Promise<number>;
    importJsonl(filename: string): Promise<number>;
}

Public members

Member	Kind	Signature	Description
`append`	method	`append(event: FrameworkEvent): Promise<void>`	Public method; parameters and return type are shown in the signature.
`constructor`	constructor	`(options: SQLiteEventStoreOptions): SQLiteEventStore`	Creates an instance of this class.
`exportJsonl`	method	`exportJsonl(filename: string, filter?: EventFilter): Promise<number>`	Public method; parameters and return type are shown in the signature.
`importJsonl`	method	`importJsonl(filename: string): Promise<number>`	Public method; parameters and return type are shown in the signature.
`list`	method	`list(filter?: EventFilter): Promise<FrameworkEvent[]>`	Public method; parameters and return type are shown in the signature.
`record`	method	`record(event: FrameworkEvent): Promise<void>`	Public method; parameters and return type are shown in the signature.

`SQLiteStructuredStore`

SQLite Structured Store class with 7 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { SQLiteStructuredStore } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare class SQLiteStructuredStore implements StructuredStoreProvider {
    constructor(options: SQLiteStructuredStoreOptions);
    get<T>(table: string, id: string): Promise<T | null>;
    insert<T extends {
            id: string;
        }>(table: string, record: T): Promise<void>;
    update<T>(table: string, id: string, patch: Partial<T>): Promise<void>;
    delete(table: string, id: string): Promise<void>;
    query<T>(table: string, query: StructuredQuery): Promise<T[]>;
    transaction<T>(fn: (tx: StructuredStoreProvider) => Promise<T>): Promise<T>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(options: SQLiteStructuredStoreOptions): SQLiteStructuredStore`	Creates an instance of this class.
`delete`	method	`delete(table: string, id: string): Promise<void>`	Public method; parameters and return type are shown in the signature.
`get`	method	`get<T>(table: string, id: string): Promise<T \| null>`	Public method; parameters and return type are shown in the signature.
`insert`	method	`insert<T extends { id: string; }>(table: string, record: T): Promise<void>`	Public method; parameters and return type are shown in the signature.
`query`	method	`query<T>(table: string, query: StructuredQuery): Promise<T[]>`	Public method; parameters and return type are shown in the signature.
`transaction`	method	`transaction<T>(fn: (tx: StructuredStoreProvider) => Promise<T>): Promise<T>`	Public method; parameters and return type are shown in the signature.
`update`	method	`update<T>(table: string, id: string, patch: Partial<T>): Promise<void>`	Public method; parameters and return type are shown in the signature.

`LOCAL_ADAPTER_TYPES`

LOCAL ADAPTER TYPES constant exported by the index module.

Kind: constant
Import: import { LOCAL_ADAPTER_TYPES } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare const LOCAL_ADAPTER_TYPES: readonly ["sqlite", "local-vector", "file-artifact"];

`createLocalStorageBackbone`

Create Local Storage Backbone function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { createLocalStorageBackbone } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare function createLocalStorageBackbone(options: LocalStorageBackboneOptions): LocalStorageBackbone;

Call signature

text

createLocalStorageBackbone(options: LocalStorageBackboneOptions): LocalStorageBackbone

Parameters

Parameter	Type	Required	Description
`options`	`LocalStorageBackboneOptions`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: LocalStorageBackbone
Description: The return contract is defined by the type shown above.

`createLocalStorageProfiles`

Create Local Storage Profiles function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { createLocalStorageProfiles } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export declare function createLocalStorageProfiles(input: {
    eventDbFilename: string;
    structuredDbFilename: string;
    vectorFilename: string;
    artifactRootPath: string;
}): StorageProviderProfile[];

Call signature

text

createLocalStorageProfiles(input: { eventDbFilename: string; structuredDbFilename: string; vectorFilename: string; artifactRootPath: string; }): StorageProviderProfile[]

Parameters

Parameter	Type	Required	Description
`input`	`{ eventDbFilename: string; structuredDbFilename: string; vectorFilename: string; artifactRootPath: string; }`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: StorageProviderProfile[]
Description: The return contract is defined by the type shown above.

`FileArtifactStoreOptions`

File Artifact Store Options interface with 1 public fields or methods.

Kind: interface
Import: import type { FileArtifactStoreOptions } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export interface FileArtifactStoreOptions {
    rootPath: string;
}

Contract members

Member	Kind	Signature	Description
`rootPath`	property	`rootPath: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`FileToolRuntimeStoreOptions`

File Tool Runtime Store Options interface with 1 public fields or methods.

Kind: interface
Import: import type { FileToolRuntimeStoreOptions } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export interface FileToolRuntimeStoreOptions {
    filename: string;
}

Contract members

Member	Kind	Signature	Description
`filename`	property	`filename: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`LocalAdapterProfile`

Local Adapter Profile interface with 4 public fields or methods.

Kind: interface
Import: import type { LocalAdapterProfile } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export interface LocalAdapterProfile {
    id: string;
    type: 'sqlite' | 'local-vector' | 'file-artifact';
    rootPath?: string;
    options?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`id`	property	`id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`options`	property	`options?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`rootPath`	property	`rootPath?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`type`	property	`type: "sqlite" \| "local-vector" \| "file-artifact"`	Public property; its type, readonly modifier and optionality are shown in the signature.

`LocalHashEmbeddingProviderOptions`

Local Hash Embedding Provider Options interface with 1 public fields or methods.

Kind: interface
Import: import type { LocalHashEmbeddingProviderOptions } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export interface LocalHashEmbeddingProviderOptions {
    dimensions?: number;
}

Contract members

Member	Kind	Signature	Description
`dimensions`	property	`dimensions?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.

`LocalStorageBackbone`

Local Storage Backbone interface with 7 public fields or methods.

Kind: interface
Import: import type { LocalStorageBackbone } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export interface LocalStorageBackbone {
    profiles: StorageProviderProfile[];
    eventStore: SQLiteEventStore;
    structured: SQLiteStructuredStore;
    vector: LocalVectorIndexProvider;
    artifacts: FileArtifactStore;
    embeddings: EmbeddingProvider;
    memory: HybridMemoryProvider;
}

Contract members

Member	Kind	Signature	Description
`artifacts`	property	`artifacts: FileArtifactStore`	Public property; its type, readonly modifier and optionality are shown in the signature.
`embeddings`	property	`embeddings: EmbeddingProvider`	Public property; its type, readonly modifier and optionality are shown in the signature.
`eventStore`	property	`eventStore: SQLiteEventStore`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memory`	property	`memory: HybridMemoryProvider`	Public property; its type, readonly modifier and optionality are shown in the signature.
`profiles`	property	`profiles: StorageProviderProfile[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`structured`	property	`structured: SQLiteStructuredStore`	Public property; its type, readonly modifier and optionality are shown in the signature.
`vector`	property	`vector: LocalVectorIndexProvider`	Public property; its type, readonly modifier and optionality are shown in the signature.

`LocalStorageBackboneOptions`

Local Storage Backbone Options interface with 8 public fields or methods.

Kind: interface
Import: import type { LocalStorageBackboneOptions } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export interface LocalStorageBackboneOptions {
    rootPath: string;
    sqliteMode?: SQLiteEventStoreOptions['mode'];
    eventDbFilename?: string;
    structuredDbFilename?: string;
    vectorFilename?: string;
    artifactRootPath?: string;
    memoryTableName?: string;
    embeddings?: EmbeddingProvider;
}

Contract members

Member	Kind	Signature	Description
`artifactRootPath`	property	`artifactRootPath?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`embeddings`	property	`embeddings?: EmbeddingProvider`	Public property; its type, readonly modifier and optionality are shown in the signature.
`eventDbFilename`	property	`eventDbFilename?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryTableName`	property	`memoryTableName?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`rootPath`	property	`rootPath: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sqliteMode`	property	`sqliteMode?: "sqlite" \| "json" \| "auto" \| "node-sqlite"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`structuredDbFilename`	property	`structuredDbFilename?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`vectorFilename`	property	`vectorFilename?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`LocalVectorIndexProviderOptions`

Local Vector Index Provider Options interface with 1 public fields or methods.

Kind: interface
Import: import type { LocalVectorIndexProviderOptions } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export interface LocalVectorIndexProviderOptions {
    filename: string;
}

Contract members

Member	Kind	Signature	Description
`filename`	property	`filename: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`SQLiteEventStoreOptions`

SQLite Event Store Options interface with 3 public fields or methods.

Kind: interface
Import: import type { SQLiteEventStoreOptions } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export interface SQLiteEventStoreOptions {
    filename: string;
    mode?: 'auto' | 'sqlite' | 'node-sqlite' | 'json';
    jsonFallbackFilename?: string;
}

Contract members

Member	Kind	Signature	Description
`filename`	property	`filename: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`jsonFallbackFilename`	property	`jsonFallbackFilename?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`mode`	property	`mode?: "sqlite" \| "json" \| "auto" \| "node-sqlite"`	Public property; its type, readonly modifier and optionality are shown in the signature.

`SQLiteStructuredStoreOptions`

SQLite Structured Store Options interface with 3 public fields or methods.

Kind: interface
Import: import type { SQLiteStructuredStoreOptions } from '@codesoul-co/hypha-adapters-local';
Source module: index

Declaration

text

export interface SQLiteStructuredStoreOptions {
    filename: string;
    mode?: 'auto' | 'sqlite' | 'node-sqlite' | 'json';
    jsonFallbackFilename?: string;
}

Contract members

Member	Kind	Signature	Description
`filename`	property	`filename: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`jsonFallbackFilename`	property	`jsonFallbackFilename?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`mode`	property	`mode?: "sqlite" \| "json" \| "auto" \| "node-sqlite"`	Public property; its type, readonly modifier and optionality are shown in the signature.

@codesoul-co/hypha-adapters-local / index ​

Using this module ​

Import from the package entrypoint ​

Usage patterns ​

Public exports ​

ArtifactStoreToolPort ​

Declaration ​

Public members ​

FileArtifactStore ​

Declaration ​

Public members ​

FileMCPCapabilityCatalogStore ​

Declaration ​

Public members ​

FileToolContractSnapshotStore ​

Declaration ​

Public members ​

FileToolObservationStore ​

Declaration ​

Public members ​

FileToolRuntimeStore ​

Declaration ​

Public members ​

InMemoryArtifactStore ​

Declaration ​

Public members ​

InMemoryStructuredStore ​

Declaration ​

Public members ​

InMemoryVectorIndexProvider ​

Declaration ​

Public members ​

LocalHashEmbeddingProvider ​

Declaration ​

Public members ​

LocalVectorIndexProvider ​

Declaration ​

Public members ​

MockEmbeddingProvider ​

Declaration ​

Public members ​

SQLiteEventStore ​

Declaration ​

Public members ​

SQLiteStructuredStore ​

Declaration ​

Public members ​

LOCAL_ADAPTER_TYPES ​

Declaration ​

createLocalStorageBackbone ​

Declaration ​

Call signature ​

Parameters ​

Returns ​

createLocalStorageProfiles ​

Declaration ​

Call signature ​

Parameters ​

Returns ​

FileArtifactStoreOptions ​

Declaration ​

Contract members ​

FileToolRuntimeStoreOptions ​

Declaration ​

Contract members ​

LocalAdapterProfile ​

Declaration ​

Contract members ​

LocalHashEmbeddingProviderOptions ​

Declaration ​

Contract members ​

LocalStorageBackbone ​

Declaration ​

Contract members ​

LocalStorageBackboneOptions ​

Declaration ​

Contract members ​

LocalVectorIndexProviderOptions ​

Declaration ​

Contract members ​

`@codesoul-co/hypha-adapters-local` / `index`

Using this module

Import from the package entrypoint

Usage patterns

Public exports

`ArtifactStoreToolPort`

Declaration

Public members

`FileArtifactStore`

Declaration

Public members

`FileMCPCapabilityCatalogStore`

Declaration

Public members

`FileToolContractSnapshotStore`

Declaration

Public members

`FileToolObservationStore`

Declaration

Public members

`FileToolRuntimeStore`

Declaration

Public members

`InMemoryArtifactStore`

Declaration

Public members

`InMemoryStructuredStore`

Declaration

Public members

`InMemoryVectorIndexProvider`

Declaration

Public members

`LocalHashEmbeddingProvider`

Declaration

Public members

`LocalVectorIndexProvider`

Declaration

Public members

`MockEmbeddingProvider`

Declaration

Public members

`SQLiteEventStore`

Declaration

Public members

`SQLiteStructuredStore`

Declaration

Public members

`LOCAL_ADAPTER_TYPES`

Declaration

`createLocalStorageBackbone`

Declaration

Call signature

Parameters

Returns

`createLocalStorageProfiles`

Declaration

Call signature

Parameters

Returns

`FileArtifactStoreOptions`

Declaration

Contract members

`FileToolRuntimeStoreOptions`

Declaration

Contract members

`LocalAdapterProfile`

Declaration

Contract members

`LocalHashEmbeddingProviderOptions`

Declaration

Contract members

`LocalStorageBackbone`

Declaration

Contract members

`LocalStorageBackboneOptions`

Declaration

Contract members

`LocalVectorIndexProviderOptions`

Declaration

Contract members