tinybase 9.5.0 → 9.6.0-beta.1

package/@types/persisters/persister-pg/with-schemas/index.d.ts

@@ -0,0 +1,222 @@
+/**
+ * The persister-pg module of the TinyBase project lets you save and load Store
+ * data to and from a PostgreSQL database, via the `pg` module (in an
+ * appropriate environment).
+ *
+ * Since the `pg` module is the de facto standard PostgreSQL driver for Node.js,
+ * this module also works with the many hosted PostgreSQL services that provide
+ * a `pg`-compatible driver, such as Neon.
+ * @see Database Persistence guide
+ * @packageDocumentation
+ * @module persister-pg
+ * @since 9.6.0
+ */
+import type {Client, Pool} from 'pg';
+import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
+import type {
+  OptionalSchemas,
+  Store,
+} from '../../../store/with-schemas/index.d.ts';
+import type {
+  DatabasePersisterConfig,
+  DpcJson,
+  Persister,
+  Persists,
+} from '../../with-schemas/index.d.ts';
+
+/**
+ * The PgPersister interface represents a Persister that lets you save and load
+ * Store data to and from a PostgreSQL database, via the `pg` module.
+ *
+ * You should use the createPgPersister function to create a PgPersister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getPg method for accessing a reference to the database connection the
+ * Store is being persisted to.
+ * @category Persister
+ * @since 9.6.0
+ */
+export interface PgPersister<Schemas extends OptionalSchemas> extends Persister<
+  Schemas,
+  Persists.StoreOrMergeableStore
+> {
+  /**
+   * The getPg method returns a reference to the database connection the Store
+   * is being persisted to.
+   * @returns A reference to the `pg` Pool or Client.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the database connection back out again.
+   *
+   * ```js
+   * import {Pool} from 'pg';
+   * import {createStore} from 'tinybase';
+   * import {createPgPersister} from 'tinybase/persisters/persister-pg';
+   *
+   * const pool = new Pool({
+   *   connectionString: 'postgres://localhost:5432/tinybase',
+   * });
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = await createPgPersister(store, pool, 'my_tinybase');
+   *
+   * console.log(persister.getPg() == pool);
+   * // -> true
+   *
+   * await persister.destroy();
+   * await pool.end();
+   * ```
+   * @category Getter
+   * @since 9.6.0
+   */
+  getPg(): Pool | Client;
+}
+
+/**
+ * The createPgPersister function creates a PgPersister object that can persist
+ * the Store to a PostgreSQL database via the `pg` module.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createPgPersister<StoreType extends Store>(
+ *   store: StoreType,
+ *   pg: Pool | Client,
+ *   configOrStoreTableName?:
+ *     | (NoInfer<StoreType> extends MergeableStore
+ *         ? DpcJson
+ *         : DatabasePersisterConfig)
+ *     | string,
+ *   onSqlCommand?: (sql: string, params?: any[]) => void,
+ *   onIgnoredError?: (error: any) => void,
+ * ): Promise<PgPersister>;
+ * ```
+ *
+ * A PgPersister supports regular Store objects, and can also be used to persist
+ * the metadata of a MergeableStore when using the JSON serialization mode, as
+ * described below.
+ *
+ * As well as providing a reference to the Store to persist, you must provide a
+ * `pg` parameter which is either a Pool or a Client. If you provide a Pool, one
+ * connection is checked out for the lifetime of the Persister (and a second
+ * while automatic loading is enabled), since the Persister needs to issue
+ * transactions on a stable connection. Make sure your pool is large enough to
+ * accommodate that.
+ *
+ * A database Persister uses one of two modes: either a JSON serialization of
+ * the whole Store stored in a single row of a table (the default), or a tabular
+ * mapping of Table Ids to database table names and vice-versa).
+ *
+ * The third argument is a DatabasePersisterConfig object that configures which
+ * of those modes to use, and settings for each. If the third argument is simply
+ * a string, it is used as the `storeTableName` property of the JSON
+ * serialization.
+ *
+ * See the documentation for the DpcJson and DpcTabular types for more
+ * information on how both of those modes can be configured.
+ *
+ * Note: When using tabular mode, SQL NULL values are loaded as TinyBase null
+ * values, making tables dense (every Row has every Cell). See the Database
+ * Persistence guide for details.
+ *
+ * This method is asynchronous because it will await the creation of a dedicated
+ * new connection to the database. You will need to `await` a call to this
+ * function or handle the return type natively as a Promise.
+ * @param store The Store or MergeableStore to persist.
+ * @param pg The `pg` Pool or Client that identifies the database connection.
+ * @param configOrStoreTableName A DatabasePersisterConfig to configure the
+ * persistence mode (or a string to set the `storeTableName` property of the
+ * JSON serialization).
+ * @param onSqlCommand An optional handler called every time the Persister
+ * executes a SQL command or query. This is suitable for logging persistence
+ * behavior in a development environment.
+ * @param onIgnoredError An optional handler for the errors that the Persister
+ * would otherwise ignore when trying to save or load data. This is suitable for
+ * debugging persistence issues in a development environment.
+ * @returns A reference to the new PgPersister object.
+ * @example
+ * This example creates a PgPersister object and persists the Store to a local
+ * PostgreSQL database as a JSON serialization into the `my_tinybase` table. It
+ * makes a change to the database directly and then reloads it back into the
+ * Store.
+ *
+ * ```js
+ * import {Pool} from 'pg';
+ * import {createStore} from 'tinybase';
+ * import {createPgPersister} from 'tinybase/persisters/persister-pg';
+ *
+ * const pool = new Pool({
+ *   connectionString: 'postgres://localhost:5432/tinybase',
+ * });
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = await createPgPersister(store, pool, 'my_tinybase');
+ *
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log((await pool.query('SELECT * FROM my_tinybase;')).rows);
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * const json = '[{"pets":{"felix":{"species":"cat"}}},{}]';
+ * await pool.query('UPDATE my_tinybase SET store = $1 WHERE _id = $2;', [
+ *   json,
+ *   '_',
+ * ]);
+ *
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {felix: {species: 'cat'}}}
+ *
+ * await persister.destroy();
+ * await pool.end();
+ * ```
+ * @example
+ * This example creates a PgPersister object and persists the Store to a local
+ * PostgreSQL database with tabular mapping.
+ *
+ * ```js
+ * import {Pool} from 'pg';
+ * import {createStore} from 'tinybase';
+ * import {createPgPersister} from 'tinybase/persisters/persister-pg';
+ *
+ * const pool = new Pool({
+ *   connectionString: 'postgres://localhost:5432/tinybase',
+ * });
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = await createPgPersister(store, pool, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log((await pool.query('SELECT * FROM pets;')).rows);
+ * // -> [{_id: 'fido', species: '"dog"'}]
+ * // Note that Cells and Values are JSON-encoded in PostgreSQL databases.
+ *
+ * await pool.query(
+ *   `INSERT INTO pets (_id, species) VALUES ('felix', '"cat"')`,
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * await persister.destroy();
+ * await pool.query('DROP TABLE IF EXISTS pets');
+ * await pool.end();
+ * ```
+ * @category Creation
+ * @since 9.6.0
+ */
+export function createPgPersister<Schemas extends OptionalSchemas>(
+  store: MergeableStore<Schemas>,
+  pg: Pool | Client,
+  configOrStoreTableName?: DpcJson | string,
+  onSqlCommand?: (sql: string, params?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): Promise<PgPersister<Schemas>>;
+export function createPgPersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas> & {getMergeableContent?: never},
+  pg: Pool | Client,
+  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
+  onSqlCommand?: (sql: string, params?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): Promise<PgPersister<Schemas>>;

package/@types/persisters/persister-supabase/index.d.ts

@@ -0,0 +1,201 @@
+/**
+ * The persister-supabase module of the TinyBase project lets you save and load
+ * Store data to and from a Supabase project, via the `@supabase/supabase-js`
+ * module.
+ *
+ * Unlike the other PostgreSQL Persisters, this one talks to Supabase's REST API
+ * rather than to the database directly. That means it works in a browser or
+ * edge runtime, that row-level security policies apply to the data it reads and
+ * writes, and that changes can arrive over Supabase Realtime instead of
+ * polling.
+ *
+ * It also means that only the JSON serialization mode is available, since the
+ * REST API cannot execute the arbitrary SQL that tabular mapping needs.
+ *
+ * Most importantly, it means this Persister issues no DDL whatsoever, which is
+ * a real departure from how the other database Persisters behave. Those create
+ * their table when it is missing, add columns as new Cells appear, drop columns
+ * and tables that have become empty, and, in PostgreSQL, install the functions
+ * and event triggers they need to listen for changes and drop them again when
+ * they are destroyed. This one does none of that: it reads and writes a single
+ * row of a table you have already set up, and if that table is missing or
+ * shaped wrong, it reports the error rather than correcting the schema. Your
+ * database structure is yours, and stays exactly as your migrations left it.
+ *
+ * If you want a Persister that manages its own schema, or you need tabular
+ * mode, connect to the database directly with the persister-pg module instead.
+ * @see Database Persistence guide
+ * @packageDocumentation
+ * @module persister-supabase
+ * @since 9.6.0
+ */
+import type {SupabaseClient} from '@supabase/supabase-js';
+import type {MergeableStore} from '../../mergeable-store/index.d.ts';
+import type {Store} from '../../store/index.d.ts';
+import type {DpcJson, Persister, Persists} from '../index.d.ts';
+
+/**
+ * The SupabasePersister interface represents a Persister that lets you save and
+ * load Store data to and from a Supabase project.
+ *
+ * You should use the createSupabasePersister function to create a
+ * SupabasePersister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getSupabase method for accessing a reference to the Supabase client the
+ * Store is being persisted with.
+ * @category Persister
+ * @since 9.6.0
+ */
+export interface SupabasePersister extends Persister<Persists.StoreOrMergeableStore> {
+  /**
+   * The getSupabase method returns a reference to the Supabase client the Store
+   * is being persisted with.
+   * @returns A reference to the Supabase client.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the Supabase client back out again.
+   *
+   * ```js ignore
+   * import {createClient} from '@supabase/supabase-js';
+   * import {createStore} from 'tinybase';
+   * import {createSupabasePersister} from 'tinybase/persisters/persister-supabase';
+   *
+   * const supabase = createClient(
+   *   'https://my-project.supabase.co',
+   *   'anon-key',
+   * );
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createSupabasePersister(store, supabase, 'my_tinybase');
+   *
+   * console.log(persister.getSupabase() == supabase);
+   * // -> true
+   *
+   * await persister.destroy();
+   * ```
+   * @category Getter
+   * @since 9.6.0
+   */
+  getSupabase(): SupabaseClient;
+}
+
+/**
+ * The createSupabasePersister function creates a SupabasePersister object that
+ * can persist the Store to a Supabase project.
+ *
+ * A SupabasePersister supports regular Store objects, and can also be used to
+ * persist the metadata of a MergeableStore.
+ *
+ * As well as providing a reference to the Store to persist, you must provide a
+ * `supabase` parameter which is the client returned from Supabase's
+ * `createClient` function.
+ *
+ * The Persister stores a JSON serialization of the whole Store in a single row
+ * of a table. The third argument is a DpcJson object that configures the table
+ * and column names to use, or, if it is simply a string, it is used as the
+ * `storeTableName` property.
+ *
+ * Unlike the other database Persisters, this one will not create or alter any
+ * of that structure for you, so you need to set it up yourself with a migration
+ * or the Supabase SQL editor before the Persister will work at all. By default
+ * it expects a table called `tinybase` with a text primary key called `_id` and
+ * a text column called `store`:
+ *
+ * ```sql ignore
+ * CREATE TABLE tinybase (_id text PRIMARY KEY, store text);
+ * ```
+ *
+ * Row-level security applies to everything the Persister does, so it will read
+ * nothing and save nothing until a policy grants access to it. What that policy
+ * should be depends on who is allowed to see the Store: the following lets any
+ * signed-in user read and write it, which suits a Store that a whole team
+ * shares, but a per-user Store wants a policy that compares `auth.uid()` to a
+ * column of its own instead.
+ *
+ * ```sql ignore
+ * ALTER TABLE tinybase ENABLE ROW LEVEL SECURITY;
+ * CREATE POLICY tinybase_access ON tinybase
+ *   FOR ALL TO authenticated USING (true) WITH CHECK (true);
+ * ```
+ *
+ * For the startAutoLoad method to pick up changes made elsewhere, the table
+ * must also be published to Supabase Realtime:
+ *
+ * ```sql ignore
+ * ALTER PUBLICATION supabase_realtime ADD TABLE tinybase;
+ * ```
+ *
+ * Note that Realtime checks a client's `SELECT` policy before it will send that
+ * client a change, so a Store that loads and saves correctly but never
+ * auto-loads is usually a policy problem rather than a publication one.
+ *
+ * If you cannot enable Realtime, set the `autoLoadIntervalSeconds` property of
+ * the DpcJson object, and the Persister will additionally poll the table at
+ * that interval. It does not poll unless you provide that property.
+ * @param store The Store or MergeableStore to persist.
+ * @param supabase The Supabase client that was returned from `createClient`.
+ * @param configOrStoreTableName A DpcJson object to configure the table and
+ * column names (or a string to set the `storeTableName` property).
+ * @param onIgnoredError An optional handler for the errors that the Persister
+ * would otherwise ignore when trying to save or load data. This is suitable for
+ * debugging persistence issues in a development environment.
+ * @returns A reference to the new SupabasePersister object.
+ * @example
+ * This example creates a SupabasePersister object and persists the Store to a
+ * Supabase project as a JSON serialization into the `my_tinybase` table.
+ *
+ * ```js ignore
+ * import {createClient} from '@supabase/supabase-js';
+ * import {createStore} from 'tinybase';
+ * import {createSupabasePersister} from 'tinybase/persisters/persister-supabase';
+ *
+ * const supabase = createClient(
+ *   'https://my-project.supabase.co',
+ *   'anon-key',
+ * );
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createSupabasePersister(store, supabase, 'my_tinybase');
+ *
+ * await persister.save();
+ * // Store will be saved to the Supabase table.
+ *
+ * console.log((await supabase.from('my_tinybase').select('store')).data);
+ * // -> [{store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * await persister.destroy();
+ * ```
+ * @example
+ * This example creates a SupabasePersister object that automatically loads
+ * changes made to the table by other clients, over Supabase Realtime.
+ *
+ * ```js ignore
+ * import {createClient} from '@supabase/supabase-js';
+ * import {createStore} from 'tinybase';
+ * import {createSupabasePersister} from 'tinybase/persisters/persister-supabase';
+ *
+ * const supabase = createClient(
+ *   'https://my-project.supabase.co',
+ *   'anon-key',
+ * );
+ * const store = createStore();
+ * const persister = createSupabasePersister(store, supabase, {
+ *   mode: 'json',
+ *   storeTableName: 'my_tinybase',
+ * });
+ *
+ * await persister.startAutoLoad();
+ * await persister.startAutoSave();
+ *
+ * // Changes made by other clients now arrive over Realtime.
+ *
+ * await persister.destroy();
+ * ```
+ * @category Creation
+ * @since 9.6.0
+ */
+export function createSupabasePersister(
+  store: Store | MergeableStore,
+  supabase: SupabaseClient,
+  configOrStoreTableName?: DpcJson | string,
+  onIgnoredError?: (error: any) => void,
+): SupabasePersister;

package/@types/persisters/persister-supabase/with-schemas/index.d.ts

@@ -0,0 +1,217 @@
+/**
+ * The persister-supabase module of the TinyBase project lets you save and load
+ * Store data to and from a Supabase project, via the `@supabase/supabase-js`
+ * module.
+ *
+ * Unlike the other PostgreSQL Persisters, this one talks to Supabase's REST API
+ * rather than to the database directly. That means it works in a browser or
+ * edge runtime, that row-level security policies apply to the data it reads and
+ * writes, and that changes can arrive over Supabase Realtime instead of
+ * polling.
+ *
+ * It also means that only the JSON serialization mode is available, since the
+ * REST API cannot execute the arbitrary SQL that tabular mapping needs.
+ *
+ * Most importantly, it means this Persister issues no DDL whatsoever, which is
+ * a real departure from how the other database Persisters behave. Those create
+ * their table when it is missing, add columns as new Cells appear, drop columns
+ * and tables that have become empty, and, in PostgreSQL, install the functions
+ * and event triggers they need to listen for changes and drop them again when
+ * they are destroyed. This one does none of that: it reads and writes a single
+ * row of a table you have already set up, and if that table is missing or
+ * shaped wrong, it reports the error rather than correcting the schema. Your
+ * database structure is yours, and stays exactly as your migrations left it.
+ *
+ * If you want a Persister that manages its own schema, or you need tabular
+ * mode, connect to the database directly with the persister-pg module instead.
+ * @see Database Persistence guide
+ * @packageDocumentation
+ * @module persister-supabase
+ * @since 9.6.0
+ */
+import type {SupabaseClient} from '@supabase/supabase-js';
+import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
+import type {
+  OptionalSchemas,
+  Store,
+} from '../../../store/with-schemas/index.d.ts';
+import type {DpcJson, Persister, Persists} from '../../with-schemas/index.d.ts';
+
+/**
+ * The SupabasePersister interface represents a Persister that lets you save and
+ * load Store data to and from a Supabase project.
+ *
+ * You should use the createSupabasePersister function to create a
+ * SupabasePersister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getSupabase method for accessing a reference to the Supabase client the
+ * Store is being persisted with.
+ * @category Persister
+ * @since 9.6.0
+ */
+export interface SupabasePersister<
+  Schemas extends OptionalSchemas,
+> extends Persister<Schemas, Persists.StoreOrMergeableStore> {
+  /**
+   * The getSupabase method returns a reference to the Supabase client the Store
+   * is being persisted with.
+   * @returns A reference to the Supabase client.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the Supabase client back out again.
+   *
+   * ```js ignore
+   * import {createClient} from '@supabase/supabase-js';
+   * import {createStore} from 'tinybase';
+   * import {createSupabasePersister} from 'tinybase/persisters/persister-supabase';
+   *
+   * const supabase = createClient(
+   *   'https://my-project.supabase.co',
+   *   'anon-key',
+   * );
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createSupabasePersister(store, supabase, 'my_tinybase');
+   *
+   * console.log(persister.getSupabase() == supabase);
+   * // -> true
+   *
+   * await persister.destroy();
+   * ```
+   * @category Getter
+   * @since 9.6.0
+   */
+  getSupabase(): SupabaseClient;
+}
+
+/**
+ * The createSupabasePersister function creates a SupabasePersister object that
+ * can persist the Store to a Supabase project.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createSupabasePersister(
+ *   store: Store | MergeableStore,
+ *   supabase: SupabaseClient,
+ *   configOrStoreTableName?: DpcJson | string,
+ *   onIgnoredError?: (error: any) => void,
+ * ): SupabasePersister;
+ * ```
+ *
+ * A SupabasePersister supports regular Store objects, and can also be used to
+ * persist the metadata of a MergeableStore.
+ *
+ * As well as providing a reference to the Store to persist, you must provide a
+ * `supabase` parameter which is the client returned from Supabase's
+ * `createClient` function.
+ *
+ * The Persister stores a JSON serialization of the whole Store in a single row
+ * of a table. The third argument is a DpcJson object that configures the table
+ * and column names to use, or, if it is simply a string, it is used as the
+ * `storeTableName` property.
+ *
+ * Unlike the other database Persisters, this one will not create or alter any
+ * of that structure for you, so you need to set it up yourself with a migration
+ * or the Supabase SQL editor before the Persister will work at all. By default
+ * it expects a table called `tinybase` with a text primary key called `_id` and
+ * a text column called `store`:
+ *
+ * ```sql ignore
+ * CREATE TABLE tinybase (_id text PRIMARY KEY, store text);
+ * ```
+ *
+ * Row-level security applies to everything the Persister does, so it will read
+ * nothing and save nothing until a policy grants access to it. What that policy
+ * should be depends on who is allowed to see the Store: the following lets any
+ * signed-in user read and write it, which suits a Store that a whole team
+ * shares, but a per-user Store wants a policy that compares `auth.uid()` to a
+ * column of its own instead.
+ *
+ * ```sql ignore
+ * ALTER TABLE tinybase ENABLE ROW LEVEL SECURITY;
+ * CREATE POLICY tinybase_access ON tinybase
+ *   FOR ALL TO authenticated USING (true) WITH CHECK (true);
+ * ```
+ *
+ * For the startAutoLoad method to pick up changes made elsewhere, the table
+ * must also be published to Supabase Realtime:
+ *
+ * ```sql ignore
+ * ALTER PUBLICATION supabase_realtime ADD TABLE tinybase;
+ * ```
+ *
+ * Note that Realtime checks a client's `SELECT` policy before it will send that
+ * client a change, so a Store that loads and saves correctly but never
+ * auto-loads is usually a policy problem rather than a publication one.
+ *
+ * If you cannot enable Realtime, set the `autoLoadIntervalSeconds` property of
+ * the DpcJson object, and the Persister will additionally poll the table at
+ * that interval. It does not poll unless you provide that property.
+ * @param store The Store or MergeableStore to persist.
+ * @param supabase The Supabase client that was returned from `createClient`.
+ * @param configOrStoreTableName A DpcJson object to configure the table and
+ * column names (or a string to set the `storeTableName` property).
+ * @param onIgnoredError An optional handler for the errors that the Persister
+ * would otherwise ignore when trying to save or load data. This is suitable for
+ * debugging persistence issues in a development environment.
+ * @returns A reference to the new SupabasePersister object.
+ * @example
+ * This example creates a SupabasePersister object and persists the Store to a
+ * Supabase project as a JSON serialization into the `my_tinybase` table.
+ *
+ * ```js ignore
+ * import {createClient} from '@supabase/supabase-js';
+ * import {createStore} from 'tinybase';
+ * import {createSupabasePersister} from 'tinybase/persisters/persister-supabase';
+ *
+ * const supabase = createClient(
+ *   'https://my-project.supabase.co',
+ *   'anon-key',
+ * );
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createSupabasePersister(store, supabase, 'my_tinybase');
+ *
+ * await persister.save();
+ * // Store will be saved to the Supabase table.
+ *
+ * console.log((await supabase.from('my_tinybase').select('store')).data);
+ * // -> [{store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * await persister.destroy();
+ * ```
+ * @example
+ * This example creates a SupabasePersister object that automatically loads
+ * changes made to the table by other clients, over Supabase Realtime.
+ *
+ * ```js ignore
+ * import {createClient} from '@supabase/supabase-js';
+ * import {createStore} from 'tinybase';
+ * import {createSupabasePersister} from 'tinybase/persisters/persister-supabase';
+ *
+ * const supabase = createClient(
+ *   'https://my-project.supabase.co',
+ *   'anon-key',
+ * );
+ * const store = createStore();
+ * const persister = createSupabasePersister(store, supabase, {
+ *   mode: 'json',
+ *   storeTableName: 'my_tinybase',
+ * });
+ *
+ * await persister.startAutoLoad();
+ * await persister.startAutoSave();
+ *
+ * // Changes made by other clients now arrive over Realtime.
+ *
+ * await persister.destroy();
+ * ```
+ * @category Creation
+ * @since 9.6.0
+ */
+export function createSupabasePersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas> | MergeableStore<Schemas>,
+  supabase: SupabaseClient,
+  configOrStoreTableName?: DpcJson | string,
+  onIgnoredError?: (error: any) => void,
+): SupabasePersister<Schemas>;

package/@types/persisters/with-schemas/index.d.ts

@@ -2110,11 +2110,18 @@ export function createCustomPersister<
  * ideas on how to build your own Persister type, and as functional examples.
  * Examine the implementation of the createSqlite3Persister function as a good
  * starting point, for example.
+ *
+ * Your `executeCommand` function is given SQL that uses SQLite's anonymous `?`
+ * placeholders, with the parameters to bind to them in order. SQLite drivers
+ * agree on that form, whereas they vary in how they handle the numbered
+ * placeholders that PostgreSQL requires, so you should not need to rewrite
+ * statements before passing them on.
  * @param store The Store to persist.
  * @param configOrStoreTableName A DatabasePersisterConfig object, or a string
  * that will be used as the name of the Store's table in the database.
  * @param executeCommand A function that will execute a command against the
- * database.
+ * database. It receives SQL with anonymous `?` placeholders, and the parameters
+ * to bind to them in order.
  * @param addChangeListener A function that will register a listener for changes
  * to the database.
  * @param delChangeListener A function that will unregister the listener for