Complete export index

Exhaustive package-by-package index of every supported Ownfold public entry point, value, class, function, interface, and type.

This page is the exhaustive symbol lookup for the current beta packages. Import only from the entry points shown here. Source files, dist files, unlisted worker-protocol helpers, and generated schema internals are not public API.

`@ownfold/core`

Values and parser namespaces

Area	Exports
Encoding	`Base64Url`, `Utf8`
Envelope and record	`EncryptedEnvelope`, `EncryptedRecordWrite`
Recovery and devices	`RecoveryKit`, `DeviceEnvelope`, `DeviceData`
Pairing and rotation	`PairingOffer`, `PairingData`, `Rotation`
Vault data	`VaultMetadataData`, `VaultRecordData`
Remote input	`RemoteVaultInput`, `RemoteRotationInput`
Compatibility	`PersistedCryptoCapabilities`, `PersistedCryptoFormat`, `PersistedFormatSupport`

Schema values

EncryptedEnvelopeSchema, EncryptedEnvelopeV1Schema, EncryptedEnvelopeV2Schema, RecoveryKitV1Schema, DeviceEnvelopeV1Schema, DeviceSummarySchema, DeviceRecordSchema, PairingOfferV1Schema, PairingRequestSchema, PairingRecordSchema, VaultMetadataSchema, VaultRecordSchema, RotationStateSchema, RotationRecordSchema, PersistedCryptoCapabilitiesV1Schema, CreateRemoteVaultInputSchema, MarkRecoveryVerifiedInputSchema, ReplaceRemoteRecoveryKitInputSchema, RegisterRemoteDeviceInputSchema, TouchRemoteDeviceInputSchema, RevokeRemoteDeviceInputSchema, CreatePairingRequestInputSchema, GetPairingRequestInputSchema, ApprovePairingRequestInputSchema, CancelPairingRequestInputSchema, BeginRemoteRotationInputSchema, UpdateRemoteRotationProgressInputSchema, and CompleteRemoteRotationInputSchema.

Domain and state types

JsonPrimitive, JsonValue, RecordContext, EncryptedEnvelopeV1, EncryptedEnvelopeV2, EncryptedEnvelopeValue, RecoveryKitV1, DeviceEnvelopeV1, DeviceStatus, DeviceSummary, DeviceRecord, PairingOfferV1, PairingRequest, PairingRecord, ApprovedPairing, RecoveryStatus, VaultMetadata, VaultRecord, RemoteVaultState, VaultState, StableVaultState, RotationState, RotationRecord, CryptoSuiteVersionSupport, PersistedCryptoCapabilitiesV1, CryptoCapabilityCompatibility, and PersistedFormatVersionSupport. Record-write types are EncryptedRecordExpectation and EncryptedRecordWriteValue.

Crypto contract types

RootKeyHandle, ProtectedDevicePrivateKeyV1, DeviceKeyHandle, CryptoEngine, CryptoError, EncryptRecordInput, DecryptRecordInput, RewrapRecordDataKeyInput, CreateRecoveryKitInput, OpenRecoveryKitInput, WrapRootKeyForDeviceInput, and OpenDeviceEnvelopeInput.

Adapter input and contract types

CreateVaultInput, UpdateRecoveryStatusInput, ReplaceRecoveryKitInput, RegisterDeviceInput, TouchDeviceInput, RevokeDeviceInput, CreatePairingInput, ApprovePairingInput, CancelPairingInput, VaultAdapter, BeginRotationInput, UpdateRotationProgressInput, RotationDeviceEnvelopeInput, CompleteRotationInput, CompletedRotation, and VaultRotationAdapter.

Remote input and transport types

CreateRemoteVaultInput, MarkRecoveryVerifiedInput, ReplaceRemoteRecoveryKitInput, RegisterRemoteDeviceInput, TouchRemoteDeviceInput, RevokeRemoteDeviceInput, CreatePairingRequestInput, GetPairingRequestInput, ApprovePairingRequestInput, CancelPairingRequestInput, VaultTransport, BeginRemoteRotationInput, UpdateRemoteRotationProgressInput, CompleteRemoteRotationInput, CompletedRemoteRotation, and VaultRotationTransport.

Error classes and unions

InvalidInputError, VaultNotCreatedError, VaultLockedError, VaultUnavailableOnDeviceError, InvalidRecoveryKitError, RecoveryAuthenticationFailedError, CorruptedEnvelopeError, UnsupportedEnvelopeVersionError, UnsupportedRecoveryKitVersionError, AuthenticationFailedError, KeyVersionUnavailableError, StorageAdapterError, TransportError, CryptoEngineError, ConflictError, InvalidStateTransitionError, DeviceRevokedError, DeviceNotRegisteredError, UnsupportedDeviceEnvelopeVersionError, InvalidPairingOfferError, UnsupportedPairingOfferVersionError, PairingExpiredError, PairingUnavailableError, RotationInProgressError, RateLimitExceededError, OwnfoldError, CryptoError, and EncryptedRecordWriteError.

See Core SDK and Errors.

`@ownfold/crypto`

Entry point	Exports
`@ownfold/crypto`	`createSodiumCryptoEngine`
`@ownfold/crypto/testing`	`createDeterministicCryptoEngine`, `withEnvelopeVersionForTesting`

See Crypto engine.

`@ownfold/browser`

Client

VaultClient, createVaultClient, VaultClientOptions, VaultClientResult, EncryptJsonInput, DecryptJsonInput, EncryptBinaryInput, DecryptBinaryInput, VaultStateListener, and RotationProgressListener.

Recovery, rotation, and storage

RecoveryCode, RecoveryKitFile, rewrapRotationRecords, RewrapRecordsInput, RotationRecordItem, RewrappedRotationRecord, RotationRecordBatch, RotationRecordStore, CompleteRootKeyRotationInput, RootKeyRotationPhase, RootKeyRotationProgress, VaultStorage, IndexedDbVaultStorage, LocalVaultRecord, LocalDeviceIdentity, PendingPairingIdentity, PendingRotationIdentity, and PendingRecoveryKitReplacement.

Lifecycle channels and worker client

VaultLifecycleMessage, VaultLifecycleChannel, VaultLifecycleChannelFactory, createBroadcastVaultLifecycleChannel, WorkerCryptoEngine, createWorkerCryptoEngine, WorkerCryptoEngineOptions, CryptoWorkerPort, and CryptoWorkerEventType.

Worker entry point	Exports
`@ownfold/browser/worker`	`exposeOwnfoldCryptoWorker`, `OwnfoldCryptoWorkerOptions`

See Browser client and Crypto engine.

`@ownfold/react`

VaultProvider, VaultProviderProps, useVault, useVaultStatus, useVaultLock, useRecoveryKit, useVaultDevices, useVaultPairing, useKeyRotation, and useKeyRotationProgress.

See React API.

`@ownfold/server`

VaultServer, createVaultServer, VaultServerOptions, VaultServerError, VaultServerOperation, OwnfoldUserResolver, singleUserResolver, VaultRateLimitContext, VaultRateLimitHook, VaultAuditEvent, VaultAuditHook, VaultAuditDeliveryErrorHook, VaultAdapter, and VaultRotationAdapter.

See Vault server.

Transport packages

`@ownfold/fetch`

createVaultFetchHandler, VaultFetchHandler, VaultFetchHandlerOptions, createFetchVaultTransport, FetchVaultTransportOptions, readBoundedJsonRequest, readBoundedJsonResponse, BoundedJsonOptions, VAULT_HTTP_DEFAULT_BASE_PATH, VAULT_HTTP_MAX_BODY_BYTES, VaultHttpResponse, and VaultHttpError.

`@ownfold/trpc`

Entry point	Exports
`@ownfold/trpc`	`createVaultTRPCRouter`, `VaultTRPCRouter`, `VaultTRPCRouterOptions`, `VaultTRPCContext`
`@ownfold/trpc/client`	`trpcVaultTransport`, `VaultTRPCClient`

See Transport APIs.

Framework packages

Package	Exports
`@ownfold/next`	`createNextVaultHandlers`, `NextVaultHandlers`
`@ownfold/node`	`createNodeVaultHandler`, `createExpressVaultMiddleware`, `NodeVaultHandler`, `NodeVaultHandlerOptions`, `NodeVaultOrigin`
`@ownfold/fastify`	`createFastifyVaultHandler`, `FastifyVaultHandler`, `FastifyVaultHandlerOptions`, `FastifyVaultRequest`, `FastifyVaultReply`
`@ownfold/hono`	`createHonoVaultHandler`
`@ownfold/elysia`	`createElysiaVaultHandler`, `ElysiaVaultHandler`
`@ownfold/tanstack-start`	`createTanStackStartVaultHandlers`, `TanStackStartServerRouteInput`, `TanStackStartVaultHandlers`

See Framework handler APIs.

Authentication packages

Package	Exports
`@ownfold/better-auth`	`betterAuthUserResolver`, `BetterAuthSessionProvider`
`@ownfold/auth-js`	`authJsUserResolver`, `AuthJsSessionLoader`

singleUserResolver and OwnfoldUserResolver are exported by @ownfold/server. See Authentication APIs.

Database packages

`@ownfold/sqlite`

SqliteVaultAdapter, applyOwnfoldSqliteSchema, and ownfoldSqliteSchema.

`@ownfold/postgres`

Entry point	Exports
`@ownfold/postgres`	`PostgresVaultAdapter`, `postgresVaultAdapter`, `PostgresExecutor`, `PostgresQueryResult`
`@ownfold/postgres/node-postgres`	`nodePostgresVaultAdapter`

`@ownfold/drizzle`

Entry point	Exports
`@ownfold/drizzle`	`DrizzleVaultAdapter`, `drizzleVaultAdapter`
`@ownfold/drizzle/schema`	`ownfoldVaults`, `ownfoldDevices`, `ownfoldPairings`, `ownfoldRotations`

`@ownfold/prisma`

PrismaVaultAdapter, prismaVaultAdapter, PrismaVaultClient, PrismaTransactionClient, PrismaVaultRow, PrismaVaultDelegate, PrismaDeviceRow, PrismaDeviceCreateRow, PrismaDeviceDelegate, PrismaPairingRow, PrismaPairingCreateRow, PrismaPairingDelegate, PrismaRotationRow, PrismaRotationDelegate, PrismaJsonValue, and PrismaJsonNestedValue.

See Database adapter APIs.

`@ownfold/testing`

checkVaultAdapterCompliance, checkVaultRotationAdapterCompliance, InMemoryVaultAdapter, InMemoryVaultTransport, createInMemoryVaultTransport, MemoryTransportOperation, MemoryVaultStorage, MemoryVaultLifecycleChannelHub, InMemoryEncryptedRecordRepository, and corruptBase64Url.

See Testing APIs.

`@ownfold/cli`

The executable entry point is ownfold. The programmatic entry point exports readConfig, initializeProject, generateSchema, migrateDatabase, CliResult, OwnfoldConfig, GenerateOptions, InitOptions, MigrateOptions, DatabaseProvider, and IdentityProvider.

See CLI for commands and flags.

Stability rules

Names on this page are public beta API unless a reference page explicitly marks them test-only.
Package root and documented subpath imports are supported; source and dist paths are not.
Type-only exports may disappear from emitted JavaScript; use import type where appropriate.
Persisted format compatibility is governed by format versions, not this symbol list.
A removed or incompatible public symbol requires the release process described under versioning.