API reference / @evolu/common / local-first/Public

local-first/Public

Public local-first API exported from "@evolu/common"

This module provides the supported consumer-facing API for Evolu's local-first system: prefer importing from @evolu/common (this module) when using Evolu in applications. If you require access to lower level internals, consider importing from @evolu/common/local-first.

Namespaces

Namespace	Description
kysely	-

Interfaces

Interface	Description
AuthenticationPrompt	Configuration for the biometric/device credential prompt shown when a protected item is accessed.
AuthList	-
AuthResult	-
LocalAuth	Local authentication and authorization system for Evolu. This is API is subject to change and not recommended for production use.
LocalAuthDep	-
LocalAuthOptions	-
LocalAuthOptionsValues	-
MutationResult	-
SecureStorage	Secure storage interface that must be implemented by each platform.
SecureStorageDep	-
SensitiveInfoGetRequest	-
SensitiveInfoItem	-
StorageMetadata	-

Type Aliases

Type Alias	Description
AccessControl	Enumerates the access-control policy enforced by the underlying secure storage.
SecurityLevel	Enumerates the highest security tier that was effectively applied while storing a value.
StorageBackend	Enumerates the native storage backend used to persist sensitive data.

Variables

Variable	Description
localAuth_Namespace	-
localAuthDefaultOptions	-

Functions

Function	Description
createLocalAuth	Creates a local auth using the given secure storage implementation. This factory function allows each platform to provide its own storage layer while sharing the common auth logic.

AppOwner

Re-exports AppOwner

---

AppOwnerDep

Re-exports AppOwnerDep

---

createAppOwner

Re-exports createAppOwner

---

createEvolu

Re-exports createEvolu

---

createOwnerSecret

Re-exports createOwnerSecret

---

createOwnerWebSocketTransport

Re-exports createOwnerWebSocketTransport

---

createOwnerWriteKey

Re-exports createOwnerWriteKey

---

createShardOwner

Re-exports createShardOwner

---

createSharedOwner

Re-exports createSharedOwner

---

createSharedReadonlyOwner

Re-exports createSharedReadonlyOwner

---

deriveShardOwner

Re-exports deriveShardOwner

---

Evolu

Re-exports Evolu

---

EvoluConfig

Re-exports EvoluConfig

---

EvoluDeps

Re-exports EvoluDeps

---

EvoluError

Re-exports EvoluError

---

EvoluSchema

Re-exports EvoluSchema

---

InferRow

Re-exports InferRow

---

mnemonicToOwnerSecret

Re-exports mnemonicToOwnerSecret

---

NetworkError

Re-exports NetworkError

---

Owner

Re-exports Owner

---

OwnerEncryptionKey

Re-exports OwnerEncryptionKey

---

OwnerError

Re-exports OwnerError

---

OwnerId

Re-exports OwnerId

---

OwnerIdBytes

Re-exports OwnerIdBytes

---

ownerIdBytesToOwnerId

Re-exports ownerIdBytesToOwnerId

---

ownerIdToOwnerIdBytes

Re-exports ownerIdToOwnerIdBytes

---

OwnerSecret

Re-exports OwnerSecret

---

ownerSecretToMnemonic

Re-exports ownerSecretToMnemonic

---

OwnerTransport

Re-exports OwnerTransport

---

OwnerUsage

Re-exports OwnerUsage

---

OwnerWebSocketTransport

Re-exports OwnerWebSocketTransport

---

OwnerWriteKey

Re-exports OwnerWriteKey

---

ownerWriteKeyLength

Re-exports ownerWriteKeyLength

---

parseOwnerIdFromOwnerWebSocketTransportUrl

Re-exports parseOwnerIdFromOwnerWebSocketTransportUrl

---

PaymentRequiredError

Re-exports PaymentRequiredError

---

Query

Re-exports Query

---

QueryRows

Re-exports QueryRows

---

ReadonlyOwner

Re-exports ReadonlyOwner

---

Row

Re-exports Row

---

ServerError

Re-exports ServerError

---

ShardOwner

Re-exports ShardOwner

---

SharedOwner

Re-exports SharedOwner

---

SharedReadonlyOwner

Re-exports SharedReadonlyOwner

---

SyncOwner

Re-exports SyncOwner

---

SyncState

Re-exports SyncState

---

SyncStateInitial

Re-exports SyncStateInitial

---

SyncStateIsNotSynced

Re-exports SyncStateIsNotSynced

---

SyncStateIsSynced

Re-exports SyncStateIsSynced

---

SyncStateIsSyncing

Re-exports SyncStateIsSyncing

---

Timestamp

Re-exports Timestamp

---

TimestampBytes

Re-exports TimestampBytes

---

timestampBytesToTimestamp

Re-exports timestampBytesToTimestamp

---

TimestampCounterOverflowError

Re-exports TimestampCounterOverflowError

---

TimestampDriftError

Re-exports TimestampDriftError

---

TimestampError

Re-exports TimestampError

---

TimestampTimeOutOfRangeError

Re-exports TimestampTimeOutOfRangeError

---

timestampToTimestampBytes

Re-exports timestampToTimestampBytes

---

UnuseOwner

Re-exports UnuseOwner