@codesoul-co/hypha-storage / index

• Package index: @codesoul-co/hypha-storage
• Source: packages/storage/src/index.ts
• Exports: 46

Using this module

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

Import from the package entrypoint

import {
  storageCapabilitySchema,
  storageConnectionSpecSchema,
  storageDeploymentModeSchema,
  storageEngineSchema,
  storageProviderKindSchema,
  storageProviderProfileDefinition,
  storageProviderProfileExample,
  storageProviderProfileJsonSchema,
} from '@codesoul-co/hypha-storage';

import type {
  ResolvedStorageConnection,
  StorageConnectionSpec,
  StorageProviderProfile,
  StorageSecretRef,
  StorageTopologySpec,
  EnvSource,
  StorageCapability,
  StorageDeploymentMode,
} from '@codesoul-co/hypha-storage';

// The complete export list is documented below.

Usage patterns

• Use the 12 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 17 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
• The 17 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Runtime validation example

import { storageCapabilitySchema } from '@codesoul-co/hypha-storage';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = storageCapabilitySchema.parse(input);

Parse untrusted configuration, network, or persisted input with the runtime schema before passing it to functions or classes that expect a validated contract.

Public exports

Symbol	Kind	Signature	Description
storageCapabilitySchema	constant	const storageCapabilitySchema: z.ZodEnum<["structured", "transactions", "events", "cache", "queue", "pubsub", "streams", "vector_search", "metadata_filter", "artifact_bytes", "managed_backup", "tls", "multi_region"]>	Runtime schema for Storage Capability.
storageConnectionSpecSchema	constant	const storageConnectionSpecSchema: z.ZodObject<{ uri: z.ZodOptional<z.ZodString>; uriEnv: z.ZodOptional<z.ZodString>; host: z.ZodOptional<z.ZodString>; port: z.ZodOptional<z.ZodNumber>; database: z.ZodOptional<z.ZodString>; username: z.ZodOptional<z.ZodString>; usernameEnv: z.ZodOptional<z.ZodString>; passwordEnv: z.ZodOptional<z.ZodString>; tls: z.ZodOptional<z.ZodBoolean>; region: z.ZodOptional<z.ZodString>; opt...	Runtime schema for Storage Connection Spec.
storageDeploymentModeSchema	constant	const storageDeploymentModeSchema: z.ZodEnum<["local", "self_hosted", "managed", "cloud"]>	Runtime schema for Storage Deployment Mode.
storageEngineSchema	constant	const storageEngineSchema: z.ZodEnum<["sqlite", "postgres", "mysql", "mongodb", "redis", "kafka", "local-vector", "pgvector", "qdrant", "milvus", "chroma", "pinecone", "weaviate", "file-artifact", "s3", "gcs", "azure-blob", "json"]>	Runtime schema for Storage Engine.
storageProviderKindSchema	constant	const storageProviderKindSchema: z.ZodEnum<["relational", "document", "messaging", "cache", "vector", "object", "event", "hybrid"]>	Runtime schema for Storage Provider Kind.
storageProviderProfileDefinition	constant	const storageProviderProfileDefinition: SpecSchemaDefinition<StorageProviderProfile>	Storage Provider Profile Definition constant exported by the index module.
storageProviderProfileExample	constant	const storageProviderProfileExample: StorageProviderProfile	Valid example value for Storage Provider Profile.
storageProviderProfileJsonSchema	constant	const storageProviderProfileJsonSchema: JsonSchema	JSON Schema for Storage Provider Profile.
storageProviderProfileSchema	constant	const storageProviderProfileSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { kind: z.ZodEnum<["relational", "document", "messaging", "cache", "vector",...	Runtime schema for Storage Provider Profile.
storageRoleSchema	constant	const storageRoleSchema: z.ZodEnum<["source_of_truth", "event_log", "semantic_index", "cache", "message_queue", "artifact_store", "document_store", "hybrid_memory"]>	Runtime schema for Storage Role.
storageSecretRefSchema	constant	const storageSecretRefSchema: z.ZodObject<{ env: z.ZodOptional<z.ZodString>; secretRef: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { env?: string | undefined; secretRef?: string | undefined; }, { env?: string | undefined; secretRef?: string | undefined; }>	Runtime schema for Storage Secret Ref.
storageSpecDefinitions	constant	const storageSpecDefinitions: readonly [SpecSchemaDefinition<StorageProviderProfile>, SpecSchemaDefinition<StorageTopologySpec>]	Storage Spec Definitions constant exported by the index module.
storageSpecJsonSchemas	constant	const storageSpecJsonSchemas: Record<string, JsonSchema>	Storage Spec JSON Schemas constant exported by the index module.
storageTopologySpecDefinition	constant	const storageTopologySpecDefinition: SpecSchemaDefinition<StorageTopologySpec>	Runtime validation entrypoint for the Storage Topology spec, combining its parser, example and JSON Schema.
storageTopologySpecExample	constant	const storageTopologySpecExample: StorageTopologySpec	Valid example value for Storage Topology Spec.
storageTopologySpecJsonSchema	constant	const storageTopologySpecJsonSchema: JsonSchema	JSON Schema for Storage Topology Spec.
storageTopologySpecSchema	constant	const storageTopologySpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { providers: z.ZodArray<z.ZodObject<{ id: z.ZodString; version: z.ZodString; } ...	Runtime schema for Storage Topology Spec.
assertStorageCapability	function	assertStorageCapability(profile: StorageProviderProfile, capability: StorageCapability): void	Assert Storage Capability function with 1 public call signature; parameters and return types are listed below.
createChromaStorageProfile	function	createChromaStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile	Create Chroma Storage Profile function with 1 public call signature; parameters and return types are listed below.
createFileArtifactStorageProfile	function	createFileArtifactStorageProfile(input?: { id?: string; uri?: string; rootPath?: string; }): StorageProviderProfile	Create File Artifact Storage Profile function with 1 public call signature; parameters and return types are listed below.
createKafkaStorageProfile	function	createKafkaStorageProfile(input?: { id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; tls?: boolean; region?: string; }): StorageProviderProfile	Create Kafka Storage Profile function with 1 public call signature; parameters and return types are listed below.
createLocalVectorStorageProfile	function	createLocalVectorStorageProfile(input?: { id?: string; uri?: string; database?: string; }): StorageProviderProfile	Create Local Vector Storage Profile function with 1 public call signature; parameters and return types are listed below.
createMongoStorageProfile	function	createMongoStorageProfile(input?: { id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; }): StorageProviderProfile	Create Mongo Storage Profile function with 1 public call signature; parameters and return types are listed below.
createPineconeStorageProfile	function	createPineconeStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile	Create Pinecone Storage Profile function with 1 public call signature; parameters and return types are listed below.
createQdrantStorageProfile	function	createQdrantStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile	Create Qdrant Storage Profile function with 1 public call signature; parameters and return types are listed below.
createRedisStorageProfile	function	createRedisStorageProfile(input?: { id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; }): StorageProviderProfile	Create Redis Storage Profile function with 1 public call signature; parameters and return types are listed below.
createSQLiteStorageProfile	function	createSQLiteStorageProfile(input?: { id?: string; role?: Extract<StorageRole, "source_of_truth" | "event_log">; uri?: string; database?: string; }): StorageProviderProfile	Create SQLite Storage Profile function with 1 public call signature; parameters and return types are listed below.
createVectorStorageProfile	function	createVectorStorageProfile(input: { engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }): StorageProviderProfile	Create Vector Storage Profile function with 1 public call signature; parameters and return types are listed below.
createWeaviateStorageProfile	function	createWeaviateStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile	Create Weaviate Storage Profile function with 1 public call signature; parameters and return types are listed below.
inferStorageDeployment	function	inferStorageDeployment(profile: StorageProviderProfile, uri?: string): StorageDeploymentMode	Infer Storage Deployment function with 1 public call signature; parameters and return types are listed below.
redactStorageConnection	function	redactStorageConnection(connection: ResolvedStorageConnection): ResolvedStorageConnection	Redact Storage Connection function with 1 public call signature; parameters and return types are listed below.
resolveStorageConnection	function	resolveStorageConnection(profile: StorageProviderProfile, env?: EnvSource): ResolvedStorageConnection	Resolve Storage Connection function with 1 public call signature; parameters and return types are listed below.
validateStorageProviderProfile	function	validateStorageProviderProfile(input: unknown): StorageProviderProfile	Validate Storage Provider Profile function with 1 public call signature; parameters and return types are listed below.
validateStorageTopologySpec	function	validateStorageTopologySpec(input: unknown): StorageTopologySpec	Validate Storage Topology Spec function with 1 public call signature; parameters and return types are listed below.
ResolvedStorageConnection	interface	interface ResolvedStorageConnection	Resolved Storage Connection interface with 12 public fields or methods.
StorageConnectionSpec	interface	interface StorageConnectionSpec	Storage Connection Spec interface with 11 public fields or methods.
StorageProviderProfile	interface	interface StorageProviderProfile extends VersionedSpec, SpecMetadata	Storage Provider Profile interface with 17 public fields or methods.
StorageSecretRef	interface	interface StorageSecretRef	Storage Secret Ref interface with 2 public fields or methods.
StorageTopologySpec	interface	interface StorageTopologySpec extends VersionedSpec, SpecMetadata	Storage Topology Spec interface with 10 public fields or methods.
EnvSource	type	type EnvSource = Record<string, string | undefined>	Public type alias for Env Source; the declaration contains its complete type expression.
StorageCapability	type	type StorageCapability = 'structured' | 'transactions' | 'events' | 'cache' | 'queue' | 'pubsub' | 'streams' | 'vector_search' | 'metadata_filter' | 'artifact_bytes' | 'managed_backup' | 'tls' | 'multi_region'	Public type alias for Storage Capability; the declaration contains its complete type expression.
StorageDeploymentMode	type	type StorageDeploymentMode = 'local' | 'self_hosted' | 'managed' | 'cloud'	Public type alias for Storage Deployment Mode; the declaration contains its complete type expression.
StorageEngine	type	type StorageEngine = 'sqlite' | 'postgres' | 'mysql' | 'mongodb' | 'redis' | 'kafka' | 'local-vector' | 'pgvector' | 'qdrant' | 'milvus' | 'chroma' | 'pinecone' | 'weaviate' | 'file-artifact' | 's3' | 'gcs' | 'azure-blob' | 'json'	Public type alias for Storage Engine; the declaration contains its complete type expression.
StorageProviderKind	type	type StorageProviderKind = 'relational' | 'document' | 'messaging' | 'cache' | 'vector' | 'object' | 'event' | 'hybrid'	Public type alias for Storage Provider Kind; the declaration contains its complete type expression.
StorageRole	type	type StorageRole = 'source_of_truth' | 'event_log' | 'semantic_index' | 'cache' | 'message_queue' | 'artifact_store' | 'document_store' | 'hybrid_memory'	Public type alias for Storage Role; the declaration contains its complete type expression.
VectorStorageEngine	type	type VectorStorageEngine = Extract<StorageEngine, 'pgvector' | 'qdrant' | 'milvus' | 'chroma' | 'pinecone' | 'weaviate'>	Public type alias for Vector Storage Engine; the declaration contains its complete type expression.

storageCapabilitySchema

Runtime schema for Storage Capability.

• Kind: constant
• Import: import { storageCapabilitySchema } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageCapabilitySchema: z.ZodEnum<["structured", "transactions", "events", "cache", "queue", "pubsub", "streams", "vector_search", "metadata_filter", "artifact_bytes", "managed_backup", "tls", "multi_region"]>;

storageConnectionSpecSchema

Runtime schema for Storage Connection Spec.

• Kind: constant
• Import: import { storageConnectionSpecSchema } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageConnectionSpecSchema: z.ZodObject<{ uri: z.ZodOptional<z.ZodString>; uriEnv: z.ZodOptional<z.ZodString>; host: z.ZodOptional<z.ZodString>; port: z.ZodOptional<z.ZodNumber>; database: z.ZodOptional<z.ZodString>; username: z.ZodOptional<z.ZodString>; usernameEnv: z.ZodOptional<z.ZodString>; passwordEnv: z.ZodOptional<z.ZodString>; tls: z.ZodOptional<z.ZodBoolean>; region: z.ZodOptional<z.ZodString>; options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strip", z.ZodTypeAny, { tls?: boolean | undefined; options?: Record<string, unknown> | undefined; uri?: string | undefined; uriEnv?: string | undefined; host?: string | undefined; port?: number | undefined; database?: string | undefined; username?: string | undefined; usernameEnv?: string | undefined; passwordEnv?: string | undefined; region?: string | undefined; }, { tls?: boolean | undefined; options?: Record<string, unknown> | undefined; uri?: string | undefined; uriEnv?: string | undefined; host?: string | undefined; port?: number | undefined; database?: string | undefined; username?: string | undefined; usernameEnv?: string | undefined; passwordEnv?: string | undefined; region?: string | undefined; }>;

storageDeploymentModeSchema

Runtime schema for Storage Deployment Mode.

• Kind: constant
• Import: import { storageDeploymentModeSchema } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageDeploymentModeSchema: z.ZodEnum<["local", "self_hosted", "managed", "cloud"]>;

storageEngineSchema

Runtime schema for Storage Engine.

• Kind: constant
• Import: import { storageEngineSchema } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageEngineSchema: z.ZodEnum<["sqlite", "postgres", "mysql", "mongodb", "redis", "kafka", "local-vector", "pgvector", "qdrant", "milvus", "chroma", "pinecone", "weaviate", "file-artifact", "s3", "gcs", "azure-blob", "json"]>;

storageProviderKindSchema

Runtime schema for Storage Provider Kind.

• Kind: constant
• Import: import { storageProviderKindSchema } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageProviderKindSchema: z.ZodEnum<["relational", "document", "messaging", "cache", "vector", "object", "event", "hybrid"]>;

storageProviderProfileDefinition

Storage Provider Profile Definition constant exported by the index module.

• Kind: constant
• Import: import { storageProviderProfileDefinition } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageProviderProfileDefinition: SpecSchemaDefinition<StorageProviderProfile>;

storageProviderProfileExample

Valid example value for Storage Provider Profile.

• Kind: constant
• Import: import { storageProviderProfileExample } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageProviderProfileExample: StorageProviderProfile;

storageProviderProfileJsonSchema

JSON Schema for Storage Provider Profile.

• Kind: constant
• Import: import { storageProviderProfileJsonSchema } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageProviderProfileJsonSchema: JsonSchema;

storageProviderProfileSchema

Runtime schema for Storage Provider Profile.

• Kind: constant
• Import: import { storageProviderProfileSchema } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const storageProviderProfileSchema: (typeof import('@codesoul-co/hypha-storage'))['storageProviderProfileSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

storageRoleSchema

Runtime schema for Storage Role.

• Kind: constant
• Import: import { storageRoleSchema } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageRoleSchema: z.ZodEnum<["source_of_truth", "event_log", "semantic_index", "cache", "message_queue", "artifact_store", "document_store", "hybrid_memory"]>;

storageSecretRefSchema

Runtime schema for Storage Secret Ref.

• Kind: constant
• Import: import { storageSecretRefSchema } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageSecretRefSchema: z.ZodObject<{ env: z.ZodOptional<z.ZodString>; secretRef: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { env?: string | undefined; secretRef?: string | undefined; }, { env?: string | undefined; secretRef?: string | undefined; }>;

storageSpecDefinitions

Storage Spec Definitions constant exported by the index module.

• Kind: constant
• Import: import { storageSpecDefinitions } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageSpecDefinitions: readonly [SpecSchemaDefinition<StorageProviderProfile>, SpecSchemaDefinition<StorageTopologySpec>];

storageSpecJsonSchemas

Storage Spec JSON Schemas constant exported by the index module.

• Kind: constant
• Import: import { storageSpecJsonSchemas } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageSpecJsonSchemas: Record<string, JsonSchema>;

storageTopologySpecDefinition

Runtime validation entrypoint for the Storage Topology spec, combining its parser, example and JSON Schema.

• Kind: constant
• Import: import { storageTopologySpecDefinition } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageTopologySpecDefinition: SpecSchemaDefinition<StorageTopologySpec>;

storageTopologySpecExample

Valid example value for Storage Topology Spec.

• Kind: constant
• Import: import { storageTopologySpecExample } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageTopologySpecExample: StorageTopologySpec;

storageTopologySpecJsonSchema

JSON Schema for Storage Topology Spec.

• Kind: constant
• Import: import { storageTopologySpecJsonSchema } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare const storageTopologySpecJsonSchema: JsonSchema;

storageTopologySpecSchema

Runtime schema for Storage Topology Spec.

• Kind: constant
• Import: import { storageTopologySpecSchema } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const storageTopologySpecSchema: (typeof import('@codesoul-co/hypha-storage'))['storageTopologySpecSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

assertStorageCapability

Assert Storage Capability function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { assertStorageCapability } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function assertStorageCapability(profile: StorageProviderProfile, capability: StorageCapability): void;

Call signature

assertStorageCapability(profile: StorageProviderProfile, capability: StorageCapability): void

Parameters

Parameter	Type	Required	Description
profile	StorageProviderProfile	Yes	Required parameter; accepted values are defined by the type column.
capability	StorageCapability	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: void
• Description: Returns no value.

createChromaStorageProfile

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

• Kind: function
• Import: import { createChromaStorageProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function createChromaStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], 'engine'>): StorageProviderProfile;

Call signature

createChromaStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile

Parameters

Parameter	Type	Required	Description
input	Omit<{ engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }, "engine">	No	Optional parameter; accepted values are defined by the type column.

Returns

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

createFileArtifactStorageProfile

Create File Artifact Storage Profile function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { createFileArtifactStorageProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function createFileArtifactStorageProfile(input?: {
    id?: string;
    uri?: string;
    rootPath?: string;
}): StorageProviderProfile;

Call signature

createFileArtifactStorageProfile(input?: { id?: string; uri?: string; rootPath?: string; }): StorageProviderProfile

Parameters

Parameter	Type	Required	Description
input	{ id?: string; uri?: string; rootPath?: string; }	No	Optional parameter; accepted values are defined by the type column.

Returns

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

createKafkaStorageProfile

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

• Kind: function
• Import: import { createKafkaStorageProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function createKafkaStorageProfile(input?: {
    id?: string;
    deployment?: StorageDeploymentMode;
    uriEnv?: string;
    uri?: string;
    host?: string;
    port?: number;
    tls?: boolean;
    region?: string;
}): StorageProviderProfile;

Call signature

createKafkaStorageProfile(input?: { id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; tls?: boolean; region?: string; }): StorageProviderProfile

Parameters

Parameter	Type	Required	Description
input	{ id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; tls?: boolean; region?: string; }	No	Optional parameter; accepted values are defined by the type column.

Returns

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

createLocalVectorStorageProfile

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

• Kind: function
• Import: import { createLocalVectorStorageProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function createLocalVectorStorageProfile(input?: {
    id?: string;
    uri?: string;
    database?: string;
}): StorageProviderProfile;

Call signature

createLocalVectorStorageProfile(input?: { id?: string; uri?: string; database?: string; }): StorageProviderProfile

Parameters

Parameter	Type	Required	Description
input	{ id?: string; uri?: string; database?: string; }	No	Optional parameter; accepted values are defined by the type column.

Returns

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

createMongoStorageProfile

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

• Kind: function
• Import: import { createMongoStorageProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function createMongoStorageProfile(input?: {
    id?: string;
    deployment?: StorageDeploymentMode;
    uriEnv?: string;
    uri?: string;
    host?: string;
    port?: number;
    database?: string;
    tls?: boolean;
}): StorageProviderProfile;

Call signature

createMongoStorageProfile(input?: { id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; }): StorageProviderProfile

Parameters

Parameter	Type	Required	Description
input	{ id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; }	No	Optional parameter; accepted values are defined by the type column.

Returns

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

createPineconeStorageProfile

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

• Kind: function
• Import: import { createPineconeStorageProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function createPineconeStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], 'engine'>): StorageProviderProfile;

Call signature

createPineconeStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile

Parameters

Parameter	Type	Required	Description
input	Omit<{ engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }, "engine">	No	Optional parameter; accepted values are defined by the type column.

Returns

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

createQdrantStorageProfile

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

• Kind: function
• Import: import { createQdrantStorageProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function createQdrantStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], 'engine'>): StorageProviderProfile;

Call signature

createQdrantStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile

Parameters

Parameter	Type	Required	Description
input	Omit<{ engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }, "engine">	No	Optional parameter; accepted values are defined by the type column.

Returns

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

createRedisStorageProfile

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

• Kind: function
• Import: import { createRedisStorageProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function createRedisStorageProfile(input?: {
    id?: string;
    deployment?: StorageDeploymentMode;
    uriEnv?: string;
    uri?: string;
    host?: string;
    port?: number;
    database?: string;
    tls?: boolean;
}): StorageProviderProfile;

Call signature

createRedisStorageProfile(input?: { id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; }): StorageProviderProfile

Parameters

Parameter	Type	Required	Description
input	{ id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; }	No	Optional parameter; accepted values are defined by the type column.

Returns

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

createSQLiteStorageProfile

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

• Kind: function
• Import: import { createSQLiteStorageProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function createSQLiteStorageProfile(input?: {
    id?: string;
    role?: Extract<StorageRole, 'source_of_truth' | 'event_log'>;
    uri?: string;
    database?: string;
}): StorageProviderProfile;

Call signature

createSQLiteStorageProfile(input?: { id?: string; role?: Extract<StorageRole, "source_of_truth" | "event_log">; uri?: string; database?: string; }): StorageProviderProfile

Parameters

Parameter	Type	Required	Description
input	{ id?: string; role?: Extract<StorageRole, "source_of_truth" | "event_log">; uri?: string; database?: string; }	No	Optional parameter; accepted values are defined by the type column.

Returns

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

createVectorStorageProfile

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

• Kind: function
• Import: import { createVectorStorageProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function createVectorStorageProfile(input: {
    engine: VectorStorageEngine;
    id?: string;
    deployment?: StorageDeploymentMode;
    uriEnv?: string;
    uri?: string;
    host?: string;
    port?: number;
    database?: string;
    tls?: boolean;
    region?: string;
    apiKeyEnv?: string;
    options?: Record<string, unknown>;
}): StorageProviderProfile;

Call signature

createVectorStorageProfile(input: { engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }): StorageProviderProfile

Parameters

Parameter	Type	Required	Description
input	{ engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }	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.

createWeaviateStorageProfile

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

• Kind: function
• Import: import { createWeaviateStorageProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function createWeaviateStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], 'engine'>): StorageProviderProfile;

Call signature

createWeaviateStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile

Parameters

Parameter	Type	Required	Description
input	Omit<{ engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }, "engine">	No	Optional parameter; accepted values are defined by the type column.

Returns

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

inferStorageDeployment

Infer Storage Deployment function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { inferStorageDeployment } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function inferStorageDeployment(profile: StorageProviderProfile, uri?: string): StorageDeploymentMode;

Call signature

inferStorageDeployment(profile: StorageProviderProfile, uri?: string): StorageDeploymentMode

Parameters

Parameter	Type	Required	Description
profile	StorageProviderProfile	Yes	Required parameter; accepted values are defined by the type column.
uri	string	No	Optional parameter; accepted values are defined by the type column.

Returns

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

redactStorageConnection

Redact Storage Connection function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { redactStorageConnection } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function redactStorageConnection(connection: ResolvedStorageConnection): ResolvedStorageConnection;

Call signature

redactStorageConnection(connection: ResolvedStorageConnection): ResolvedStorageConnection

Parameters

Parameter	Type	Required	Description
connection	ResolvedStorageConnection	Yes	Required parameter; accepted values are defined by the type column.

Returns

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

resolveStorageConnection

Resolve Storage Connection function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { resolveStorageConnection } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function resolveStorageConnection(profile: StorageProviderProfile, env?: EnvSource): ResolvedStorageConnection;

Call signature

resolveStorageConnection(profile: StorageProviderProfile, env?: EnvSource): ResolvedStorageConnection

Parameters

Parameter	Type	Required	Description
profile	StorageProviderProfile	Yes	Required parameter; accepted values are defined by the type column.
env	EnvSource	No	Optional parameter; accepted values are defined by the type column.

Returns

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

validateStorageProviderProfile

Validate Storage Provider Profile function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateStorageProviderProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function validateStorageProviderProfile(input: unknown): StorageProviderProfile;

Call signature

validateStorageProviderProfile(input: unknown): StorageProviderProfile

Parameters

Parameter	Type	Required	Description
input	unknown	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.

validateStorageTopologySpec

Validate Storage Topology Spec function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateStorageTopologySpec } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export declare function validateStorageTopologySpec(input: unknown): StorageTopologySpec;

Call signature

validateStorageTopologySpec(input: unknown): StorageTopologySpec

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

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

ResolvedStorageConnection

Resolved Storage Connection interface with 12 public fields or methods.

• Kind: interface
• Import: import type { ResolvedStorageConnection } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export interface ResolvedStorageConnection {
    profileId: string;
    engine: StorageEngine;
    deployment: StorageDeploymentMode;
    uri?: string;
    uriSource?: 'env' | 'inline' | 'composed';
    host?: string;
    port?: number;
    database?: string;
    username?: string;
    tls?: boolean;
    region?: string;
    options?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
database	property	database?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
deployment	property	deployment: StorageDeploymentMode	Public property; its type, readonly modifier and optionality are shown in the signature.
engine	property	engine: StorageEngine	Public property; its type, readonly modifier and optionality are shown in the signature.
host	property	host?: 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.
port	property	port?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
profileId	property	profileId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
region	property	region?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
tls	property	tls?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
uri	property	uri?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
uriSource	property	uriSource?: "env" | "inline" | "composed"	Public property; its type, readonly modifier and optionality are shown in the signature.
username	property	username?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

StorageConnectionSpec

Storage Connection Spec interface with 11 public fields or methods.

• Kind: interface
• Import: import type { StorageConnectionSpec } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export interface StorageConnectionSpec {
    uri?: string;
    uriEnv?: string;
    host?: string;
    port?: number;
    database?: string;
    username?: string;
    usernameEnv?: string;
    passwordEnv?: string;
    tls?: boolean;
    region?: string;
    options?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
database	property	database?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
host	property	host?: 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.
passwordEnv	property	passwordEnv?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
port	property	port?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
region	property	region?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
tls	property	tls?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
uri	property	uri?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
uriEnv	property	uriEnv?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
username	property	username?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
usernameEnv	property	usernameEnv?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

StorageProviderProfile

Storage Provider Profile interface with 17 public fields or methods.

• Kind: interface
• Import: import type { StorageProviderProfile } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export interface StorageProviderProfile extends VersionedSpec, SpecMetadata {
    kind: StorageProviderKind;
    engine: StorageEngine;
    deployment: StorageDeploymentMode;
    role: StorageRole;
    connection?: StorageConnectionSpec;
    capabilities?: StorageCapability[];
    consistency?: 'strong' | 'eventual';
    secrets?: {
        apiKey?: StorageSecretRef;
        username?: StorageSecretRef;
        password?: StorageSecretRef;
        token?: StorageSecretRef;
    };
    configSchema?: JsonSchema;
}

Contract members

Member	Kind	Signature	Description
capabilities	property	capabilities?: StorageCapability[]	Public property; its type, readonly modifier and optionality are shown in the signature.
configSchema	property	configSchema?: JsonSchema	Public property; its type, readonly modifier and optionality are shown in the signature.
connection	property	connection?: StorageConnectionSpec	Public property; its type, readonly modifier and optionality are shown in the signature.
consistency	property	consistency?: "strong" | "eventual"	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.
deployment	property	deployment: StorageDeploymentMode	Public property; its type, readonly modifier and optionality are shown in the signature.
description	property	description?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
engine	property	engine: StorageEngine	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.
kind	property	kind: StorageProviderKind	Public property; its type, readonly modifier and optionality are shown in the signature.
name	property	name?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
owner	property	owner?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
role	property	role: StorageRole	Public property; its type, readonly modifier and optionality are shown in the signature.
secrets	property	secrets?: { apiKey?: StorageSecretRef; username?: StorageSecretRef; password?: StorageSecretRef; token?: StorageSecretRef; }	Public property; its type, readonly modifier and optionality are shown in the signature.
tags	property	tags?: string[]	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.
version	property	version: string	Public property; its type, readonly modifier and optionality are shown in the signature.

StorageSecretRef

Storage Secret Ref interface with 2 public fields or methods.

• Kind: interface
• Import: import type { StorageSecretRef } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export interface StorageSecretRef {
    env?: string;
    secretRef?: string;
}

Contract members

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

StorageTopologySpec

Storage Topology Spec interface with 10 public fields or methods.

• Kind: interface
• Import: import type { StorageTopologySpec } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export interface StorageTopologySpec extends VersionedSpec, SpecMetadata {
    providers: StorageProviderProfile[];
    defaults: {
        relationalRef?: SpecRef;
        documentRef?: SpecRef;
        messagingRef?: SpecRef;
        cacheRef?: SpecRef;
        vectorRef?: SpecRef;
        artifactRef?: SpecRef;
        eventRef?: SpecRef;
        memoryRef?: SpecRef;
    };
}

Contract members

Member	Kind	Signature	Description
createdAt	property	createdAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
defaults	property	defaults: { relationalRef?: SpecRef; documentRef?: SpecRef; messagingRef?: SpecRef; cacheRef?: SpecRef; vectorRef?: SpecRef; artifactRef?: SpecRef; eventRef?: SpecRef; memoryRef?: SpecRef; }	Public property; its type, readonly modifier and optionality are shown in the signature.
description	property	description?: string	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.
name	property	name?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
owner	property	owner?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
providers	property	providers: StorageProviderProfile[]	Public property; its type, readonly modifier and optionality are shown in the signature.
tags	property	tags?: string[]	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.
version	property	version: string	Public property; its type, readonly modifier and optionality are shown in the signature.

EnvSource

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

• Kind: type
• Import: import type { EnvSource } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export type EnvSource = Record<string, string | undefined>;

StorageCapability

Public type alias for Storage Capability; the declaration contains its complete type expression.

• Kind: type
• Import: import type { StorageCapability } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export type StorageCapability = 'structured' | 'transactions' | 'events' | 'cache' | 'queue' | 'pubsub' | 'streams' | 'vector_search' | 'metadata_filter' | 'artifact_bytes' | 'managed_backup' | 'tls' | 'multi_region';

StorageDeploymentMode

Public type alias for Storage Deployment Mode; the declaration contains its complete type expression.

• Kind: type
• Import: import type { StorageDeploymentMode } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export type StorageDeploymentMode = 'local' | 'self_hosted' | 'managed' | 'cloud';

StorageEngine

Public type alias for Storage Engine; the declaration contains its complete type expression.

• Kind: type
• Import: import type { StorageEngine } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export type StorageEngine = 'sqlite' | 'postgres' | 'mysql' | 'mongodb' | 'redis' | 'kafka' | 'local-vector' | 'pgvector' | 'qdrant' | 'milvus' | 'chroma' | 'pinecone' | 'weaviate' | 'file-artifact' | 's3' | 'gcs' | 'azure-blob' | 'json';

StorageProviderKind

Public type alias for Storage Provider Kind; the declaration contains its complete type expression.

• Kind: type
• Import: import type { StorageProviderKind } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export type StorageProviderKind = 'relational' | 'document' | 'messaging' | 'cache' | 'vector' | 'object' | 'event' | 'hybrid';

StorageRole

Public type alias for Storage Role; the declaration contains its complete type expression.

• Kind: type
• Import: import type { StorageRole } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export type StorageRole = 'source_of_truth' | 'event_log' | 'semantic_index' | 'cache' | 'message_queue' | 'artifact_store' | 'document_store' | 'hybrid_memory';

VectorStorageEngine

Public type alias for Vector Storage Engine; the declaration contains its complete type expression.

• Kind: type
• Import: import type { VectorStorageEngine } from '@codesoul-co/hypha-storage';
• Source module: index

Declaration

export type VectorStorageEngine = Extract<StorageEngine, 'pgvector' | 'qdrant' | 'milvus' | 'chroma' | 'pinecone' | 'weaviate'>;