@powersync/common 0.0.0-dev-20240506092851

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,6 @@
+# PowerSync SDK common JS
+
+This package contains a TypeScript implementation of a PowerSync database connector and streaming sync bucket implementation, which is used in the following SDKs:
+
+- [packages/react-native](./packages/react-native/README.md)
+- [packages/web](./packages/web/README.md)

package/lib/client/AbstractPowerSyncDatabase.d.ts

@@ -0,0 +1,367 @@
+/// <reference types="node" />
+import { Mutex } from 'async-mutex';
+import { ILogger } from 'js-logger';
+import { DBAdapter, QueryResult, Transaction } from '../db/DBAdapter';
+import { SyncStatus } from '../db/crud/SyncStatus';
+import { UploadQueueStats } from '../db/crud/UploadQueueStatus';
+import { Schema } from '../db/schema/Schema';
+import { BaseObserver } from '../utils/BaseObserver';
+import { PowerSyncBackendConnector } from './connection/PowerSyncBackendConnector';
+import { BucketStorageAdapter } from './sync/bucket/BucketStorageAdapter';
+import { CrudBatch } from './sync/bucket/CrudBatch';
+import { CrudTransaction } from './sync/bucket/CrudTransaction';
+import { AbstractStreamingSyncImplementation, StreamingSyncImplementationListener, StreamingSyncImplementation } from './sync/stream/AbstractStreamingSyncImplementation';
+export interface DisconnectAndClearOptions {
+    /** When set to false, data in local-only tables is preserved. */
+    clearLocal?: boolean;
+}
+export interface PowerSyncDatabaseOptions {
+    /** Schema used for the local database. */
+    schema: Schema;
+    database: DBAdapter;
+    /**
+     * Delay for retrying sync streaming operations
+     * from the PowerSync backend after an error occurs.
+     */
+    retryDelay?: number;
+    /**
+     * Backend Connector CRUD operations are throttled
+     * to occur at most every `crudUploadThrottleMs`
+     * milliseconds.
+     */
+    crudUploadThrottleMs?: number;
+    logger?: ILogger;
+}
+export interface SQLWatchOptions {
+    signal?: AbortSignal;
+    tables?: string[];
+    /** The minimum interval between queries. */
+    throttleMs?: number;
+    /**
+     * Allows for watching any SQL table
+     * by not removing PowerSync table name prefixes
+     */
+    rawTableNames?: boolean;
+}
+export interface WatchOnChangeEvent {
+    changedTables: string[];
+}
+export interface WatchHandler {
+    onResult: (results: QueryResult) => void;
+    onError?: (error: Error) => void;
+}
+export interface WatchOnChangeHandler {
+    onChange: (event: WatchOnChangeEvent) => void;
+    onError?: (error: Error) => void;
+}
+export interface PowerSyncDBListener extends StreamingSyncImplementationListener {
+    initialized: () => void;
+}
+export interface PowerSyncCloseOptions {
+    /**
+     * Disconnect the sync stream client if connected.
+     * This is usually true, but can be false for Web when using
+     * multiple tabs and a shared sync provider.
+     */
+    disconnect?: boolean;
+}
+export declare const DEFAULT_POWERSYNC_CLOSE_OPTIONS: PowerSyncCloseOptions;
+export declare const DEFAULT_WATCH_THROTTLE_MS = 30;
+export declare const DEFAULT_POWERSYNC_DB_OPTIONS: {
+    retryDelay: number;
+    logger: ILogger;
+    crudUploadThrottleMs: number;
+};
+/**
+ * Requesting nested or recursive locks can block the application in some circumstances.
+ * This default lock timeout will act as a failsafe to throw an error if a lock cannot
+ * be obtained.
+ */
+export declare const DEFAULT_LOCK_TIMEOUT_MS = 120000;
+export declare abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDBListener> {
+    protected options: PowerSyncDatabaseOptions;
+    /**
+     * Transactions should be queued in the DBAdapter, but we also want to prevent
+     * calls to `.execute` while an async transaction is running.
+     */
+    protected static transactionMutex: Mutex;
+    /**
+     * Returns true if the connection is closed.
+     */
+    closed: boolean;
+    ready: boolean;
+    /**
+     * Current connection status.
+     */
+    currentStatus: SyncStatus;
+    syncStreamImplementation?: StreamingSyncImplementation;
+    sdkVersion: string;
+    protected bucketStorageAdapter: BucketStorageAdapter;
+    private syncStatusListenerDisposer?;
+    protected _isReadyPromise: Promise<void>;
+    private hasSyncedWatchDisposer?;
+    protected _schema: Schema;
+    constructor(options: PowerSyncDatabaseOptions);
+    /**
+     * Schema used for the local database.
+     */
+    get schema(): Schema<{
+        [x: string]: import("..").TableV2<any>;
+    }>;
+    /**
+     * The underlying database.
+     *
+     * For the most part, behavior is the same whether querying on the underlying database, or on {@link AbstractPowerSyncDatabase}.
+     */
+    get database(): DBAdapter;
+    /**
+     * Whether a connection to the PowerSync service is currently open.
+     */
+    get connected(): boolean;
+    protected abstract generateSyncStreamImplementation(connector: PowerSyncBackendConnector): AbstractStreamingSyncImplementation;
+    protected abstract generateBucketStorageAdapter(): BucketStorageAdapter;
+    /**
+     * @returns A promise which will resolve once initialization is completed.
+     */
+    waitForReady(): Promise<void>;
+    /**
+     * @returns A promise which will resolve once the first full sync has completed.
+     */
+    waitForFirstSync(signal?: AbortSignal): Promise<void>;
+    /**
+     * Allows for extended implementations to execute custom initialization
+     * logic as part of the total init process
+     */
+    abstract _initialize(): Promise<void>;
+    /**
+     * Entry point for executing initialization logic.
+     * This is to be automatically executed in the constructor.
+     */
+    protected initialize(): Promise<void>;
+    protected updateHasSynced(): Promise<void>;
+    /**
+     * Replace the schema with a new version. This is for advanced use cases - typically the schema should just be specified once in the constructor.
+     *
+     * Cannot be used while connected - this should only be called before {@link AbstractPowerSyncDatabase.connect}.
+     */
+    updateSchema(schema: Schema): Promise<void>;
+    /**
+     * Wait for initialization to complete.
+     * While initializing is automatic, this helps to catch and report initialization errors.
+     */
+    init(): Promise<void>;
+    /**
+     * Connects to stream of events from the PowerSync instance.
+     */
+    connect(connector: PowerSyncBackendConnector): Promise<void>;
+    /**
+     * Close the sync connection.
+     *
+     * Use {@link connect} to connect again.
+     */
+    disconnect(): Promise<void>;
+    /**
+     *  Disconnect and clear the database.
+     *  Use this when logging out.
+     *  The database can still be queried after this is called, but the tables
+     *  would be empty.
+     *
+     * To preserve data in local-only tables, set clearLocal to false.
+     */
+    disconnectAndClear(options?: DisconnectAndClearOptions): Promise<void>;
+    /**
+     * Close the database, releasing resources.
+     *
+     * Also disconnects any active connection.
+     *
+     * Once close is called, this connection cannot be used again - a new one
+     * must be constructed.
+     */
+    close(options?: PowerSyncCloseOptions): Promise<void>;
+    /**
+     * Get upload queue size estimate and count.
+     */
+    getUploadQueueStats(includeSize?: boolean): Promise<UploadQueueStats>;
+    /**
+     * Get a batch of crud data to upload.
+     *
+     * Returns null if there is no data to upload.
+     *
+     * Use this from the {@link PowerSyncBackendConnector.uploadData} callback.
+     *
+     * Once the data have been successfully uploaded, call {@link CrudBatch.complete} before
+     * requesting the next batch.
+     *
+     * Use {@link limit} to specify the maximum number of updates to return in a single
+     * batch.
+     *
+     * This method does include transaction ids in the result, but does not group
+     * data by transaction. One batch may contain data from multiple transactions,
+     * and a single transaction may be split over multiple batches.
+     */
+    getCrudBatch(limit: number): Promise<CrudBatch | null>;
+    /**
+     * Get the next recorded transaction to upload.
+     *
+     * Returns null if there is no data to upload.
+     *
+     * Use this from the {@link PowerSyncBackendConnector.uploadData} callback.
+     *
+     * Once the data have been successfully uploaded, call {@link CrudTransaction.complete} before
+     * requesting the next transaction.
+     *
+     * Unlike {@link getCrudBatch}, this only returns data from a single transaction at a time.
+     * All data for the transaction is loaded into memory.
+     */
+    getNextCrudTransaction(): Promise<CrudTransaction | null>;
+    private handleCrudCheckpoint;
+    /**
+     * Execute a write (INSERT/UPDATE/DELETE) query
+     * and optionally return results.
+     */
+    execute(sql: string, parameters?: any[]): Promise<QueryResult>;
+    /**
+     * Execute a write query (INSERT/UPDATE/DELETE) multiple times with each parameter set
+     * and optionally return results.
+     * This is faster than executing separately with each parameter set.
+     */
+    executeBatch(sql: string, parameters?: any[][]): Promise<QueryResult>;
+    /**
+     *  Execute a read-only query and return results.
+     */
+    getAll<T>(sql: string, parameters?: any[]): Promise<T[]>;
+    /**
+     * Execute a read-only query and return the first result, or null if the ResultSet is empty.
+     */
+    getOptional<T>(sql: string, parameters?: any[]): Promise<T | null>;
+    /**
+     * Execute a read-only query and return the first result, error if the ResultSet is empty.
+     */
+    get<T>(sql: string, parameters?: any[]): Promise<T>;
+    /**
+     * Takes a read lock, without starting a transaction.
+     * In most cases, {@link readTransaction} should be used instead.
+     */
+    readLock<T>(callback: (db: DBAdapter) => Promise<T>): Promise<T>;
+    /**
+     * Takes a global lock, without starting a transaction.
+     * In most cases, {@link writeTransaction} should be used instead.
+     */
+    writeLock<T>(callback: (db: DBAdapter) => Promise<T>): Promise<T>;
+    /**
+     * Open a read-only transaction.
+     * Read transactions can run concurrently to a write transaction.
+     * Changes from any write transaction are not visible to read transactions started before it.
+     */
+    readTransaction<T>(callback: (tx: Transaction) => Promise<T>, lockTimeout?: number): Promise<T>;
+    /**
+     * Open a read-write transaction.
+     * This takes a global lock - only one write transaction can execute against the database at a time.
+     * Statements within the transaction must be done on the provided {@link Transaction} interface.
+     */
+    writeTransaction<T>(callback: (tx: Transaction) => Promise<T>, lockTimeout?: number): Promise<T>;
+    /**
+     * This version of `watch` uses {@link AsyncGenerator}, for documentation see {@link watchWithAsyncGenerator}.
+     * Can be overloaded to use a callback handler instead, for documentation see {@link watchWithCallback}.
+     *
+     * @example
+     * ```javascript
+     * async *attachmentIds() {
+     *   for await (const result of this.powersync.watch(
+     *     `SELECT photo_id as id FROM todos WHERE photo_id IS NOT NULL`,
+     *     []
+     *   )) {
+     *     yield result.rows?._array.map((r) => r.id) ?? [];
+     *   }
+     * }
+     * ```
+     */
+    watch(sql: string, parameters?: any[], options?: SQLWatchOptions): AsyncIterable<QueryResult>;
+    /**
+     * See {@link watchWithCallback}.
+     *
+     * @example
+     * ```javascript
+     * onAttachmentIdsChange(onResult) {
+     *   this.powersync.watch(
+     *     `SELECT photo_id as id FROM todos WHERE photo_id IS NOT NULL`,
+     *     [],
+     *     {
+     *       onResult: (result) => onResult(result.rows?._array.map((r) => r.id) ?? [])
+     *     }
+     *   );
+     * }
+     * ```
+     */
+    watch(sql: string, parameters?: any[], handler?: WatchHandler, options?: SQLWatchOptions): void;
+    /**
+     * Execute a read query every time the source tables are modified.
+     * Use {@link SQLWatchOptions.throttleMs} to specify the minimum interval between queries.
+     * Source tables are automatically detected using `EXPLAIN QUERY PLAN`.
+     *
+     * Note that the `onChange` callback member of the handler is required.
+     */
+    watchWithCallback(sql: string, parameters?: any[], handler?: WatchHandler, options?: SQLWatchOptions): void;
+    /**
+     * Execute a read query every time the source tables are modified.
+     * Use {@link SQLWatchOptions.throttleMs} to specify the minimum interval between queries.
+     * Source tables are automatically detected using `EXPLAIN QUERY PLAN`.
+     */
+    watchWithAsyncGenerator(sql: string, parameters?: any[], options?: SQLWatchOptions): AsyncIterable<QueryResult>;
+    resolveTables(sql: string, parameters?: any[], options?: SQLWatchOptions): Promise<string[]>;
+    /**
+     * This version of `onChange` uses {@link AsyncGenerator}, for documentation see {@link onChangeWithAsyncGenerator}.
+     * Can be overloaded to use a callback handler instead, for documentation see {@link onChangeWithCallback}.
+     *
+     * @example
+     * ```javascript
+     * async monitorChanges() {
+     *   for await (const event of this.powersync.onChange({tables: ['todos']})) {
+     *     console.log('Detected change event:', event);
+     *   }
+     * }
+     * ```
+     */
+    onChange(options?: SQLWatchOptions): AsyncIterable<WatchOnChangeEvent>;
+    /**
+     * See {@link onChangeWithCallback}.
+     *
+     * @example
+     * ```javascript
+     * monitorChanges() {
+     *   this.powersync.onChange({
+     *     onChange: (event) => {
+     *       console.log('Change detected:', event);
+     *     }
+     *   }, { tables: ['todos'] });
+     * }
+     * ```
+     */
+    onChange(handler?: WatchOnChangeHandler, options?: SQLWatchOptions): () => void;
+    /**
+     * Invoke the provided callback on any changes to any of the specified tables.
+     *
+     * This is preferred over {@link watchWithCallback} when multiple queries need to be performed
+     * together when data is changed.
+     *
+     * Note that the `onChange` callback member of the handler is required.
+     *
+     * Returns dispose function to stop watching.
+     */
+    onChangeWithCallback(handler?: WatchOnChangeHandler, options?: SQLWatchOptions): () => void;
+    /**
+     * Create a Stream of changes to any of the specified tables.
+     *
+     * This is preferred over {@link watchWithAsyncGenerator} when multiple queries need to be performed
+     * together when data is changed.
+     *
+     * Note, do not declare this as `async *onChange` as it will not work in React Native
+     */
+    onChangeWithAsyncGenerator(options?: SQLWatchOptions): AsyncIterable<WatchOnChangeEvent>;
+    private handleTableChanges;
+    private processTableUpdates;
+    /**
+     * @ignore
+     */
+    private executeReadOnly;
+}