API reference › @evolu/common › local‑first/Relay › RelayConfig

Defined in: packages/common/src/local-first/Relay.ts:42

Extends

Extended by

Properties

isOwnerAllowed?

readonly optional isOwnerAllowed?: (ownerId: string & Brand<"Id"> & Brand<"OwnerId">) => Awaitable<boolean>;

Defined in: packages/common/src/local-first/Relay.ts:94

Optional callback to check if an OwnerId is allowed to access the relay. If this callback is not provided, all owners are allowed.

The callback receives the OwnerId and returns a Awaitable boolean: true to allow access, or false to deny.

The callback can be synchronous (for SQLite or in-memory checks) or asynchronous (for calling remote APIs).

The callback returns a boolean rather than an error type because error handling and logging are the responsibility of the callback implementation.

OwnerId is used rather than short-lived tokens because this only controls relay access, not write permissions. Since all data is encrypted on the relay, OwnerId exposure is safe.

Owners specify which relays to connect to via OwnerTransport. In WebSocket-based implementations, this check occurs before accepting the connection, with the OwnerId typically extracted from the URL Path (e.g., ws://localhost:4000/<ownerId>). The relay requires the URL to be in the correct format for OwnerId extraction.

Example

// Client
const transport = createOwnerWebSocketTransport({
  url: "wss://relay.evolu.dev",
  ownerId: owner.id,
});

const evolu = createEvolu(deps)(Schema, {
  transports: [transport],
});

// Relay
isOwnerAllowed: (ownerId) =>
  Promise.resolve(ownerId === "6jy_2F4RT5qqeLgJ14_dnQ"),

isOwnerWithinQuota

readonly isOwnerWithinQuota: (ownerId: string & Brand<"Id"> & Brand<"OwnerId">, requiredBytes: number & Brand<"Int"> & Brand<"NonNegative"> & Brand<"Positive">) => Awaitable<boolean>;

Defined in: packages/common/src/local-first/Storage.ts:74

Callback called before an attempt to write, to check if an OwnerId has sufficient quota for the write.

The callback receives the OwnerId and the total bytes that would be stored after the write (current stored bytes plus incoming bytes), and returns a Awaitable boolean: true to allow the write, or false to deny it due to quota limits.

The callback can be synchronous (for SQLite or in-memory checks) or asynchronous (for calling remote APIs).

The callback returns a boolean rather than an error because error handling and logging are the responsibility of the callback implementation.

Example

// Client
// evolu.subscribeError

// Relay
isOwnerWithinQuota: (ownerId, requiredBytes) => {
  console.log(ownerId, requiredBytes);
  // Check error via evolu.subscribeError
  return true;
};

Inherited from

StorageConfig.isOwnerWithinQuota

name?

readonly optional name?: string & Brand<"UrlSafeString"> & Brand<"Name">;

Defined in: packages/common/src/local-first/Relay.ts:49

The relay name.

Implementations can use this for identification purposes (e.g., database file name, logging).

Markdown for LLMs