Abstract Class: BaseSupabaseConnector

Defined in: packages/db/src/BaseConnector.ts:33

Extends

• BaseObserver<SupabaseConnectorListener>

Implements

• PowerSyncBackendConnector

Constructors

Constructor

new BaseSupabaseConnector(): BaseSupabaseConnector;

Defined in: node_modules/.bun/@powersync+common@1.47.0/node_modules/@powersync/common/lib/utils/BaseObserver.d.ts:10

Returns

BaseSupabaseConnector

Inherited from

BaseObserver<SupabaseConnectorListener>.constructor

Properties

client

abstract readonly client: SupabaseClient;

Defined in: packages/db/src/BaseConnector.ts:37

---

config

abstract readonly config: SupabaseConfig;

Defined in: packages/db/src/BaseConnector.ts:38

---

currentSession

currentSession: Session | null = null;

Defined in: packages/db/src/BaseConnector.ts:41

---

ready

ready: boolean = false;

Defined in: packages/db/src/BaseConnector.ts:40

Methods

fetchCredentials()

fetchCredentials(): Promise<{
  endpoint: string;
  token: string;
}>;

Defined in: packages/db/src/BaseConnector.ts:105

Allows the PowerSync client to retrieve an authentication token from your backend which is used to authenticate against the PowerSync service.

This should always fetch a fresh set of credentials - don’t use cached values.

Return null if the user is not signed in. Throw an error if credentials cannot be fetched due to a network error or other temporary error.

This token is kept for the duration of a sync connection.

Returns

Promise<{ endpoint: string; token: string; }>

Implementation of

PowerSyncBackendConnector.fetchCredentials

---

getCurrentSession()

getCurrentSession(): Promise<Session | null>;

Defined in: packages/db/src/BaseConnector.ts:55

Returns

Promise<Session | null>

---

init()

init(): Promise<void>;

Defined in: packages/db/src/BaseConnector.ts:43

Returns

Promise<void>

---

login()

login(username, password): Promise<void>;

Defined in: packages/db/src/BaseConnector.ts:67

Parameters

Parameter	Type
username	string
password	string

Returns

Promise<void>

---

logout()

logout(): Promise<void>;

Defined in: packages/db/src/BaseConnector.ts:83

Returns

Promise<void>

---

register()

register(email, password): Promise<void>;

Defined in: packages/db/src/BaseConnector.ts:92

Parameters

Parameter	Type
email	string
password	string

Returns

Promise<void>

---

updateSession()

updateSession(session): void;

Defined in: packages/db/src/BaseConnector.ts:184

Parameters

Parameter	Type
session	Session | null

Returns

void

---

uploadData()

uploadData(database): Promise<void>;

Defined in: packages/db/src/BaseConnector.ts:126

Upload local changes to the app backend.

Use AbstractPowerSyncDatabase.getCrudBatch to get a batch of changes to upload.

Any thrown errors will result in a retry after the configured wait period (default: 5 seconds).

Parameters

Parameter	Type
database	AbstractPowerSyncDatabase

Returns

Promise<void>

Implementation of

PowerSyncBackendConnector.uploadData