@powersync/common 0.0.0-dev-20260226160529 → 0.0.0-dev-20260305124002

package/dist/bundle.node.cjs

@@ -105,6 +105,21 @@ class Index {
     }
 }
 
+/**
+ * @internal Not exported from `index.ts`.
+ */
+function encodeTableOptions(options) {
+    const trackPrevious = options.trackPrevious;
+    return {
+        local_only: options.localOnly,
+        insert_only: options.insertOnly,
+        include_old: trackPrevious && (trackPrevious.columns ?? true),
+        include_old_only_when_changed: typeof trackPrevious == 'object' && trackPrevious.onlyWhenChanged == true,
+        include_metadata: options.trackMetadata,
+        ignore_empty_update: options.ignoreEmptyUpdates
+    };
+}
+
 const DEFAULT_TABLE_OPTIONS = {
     indexes: [],
     insertOnly: false,
@@ -294,18 +309,12 @@ class Table {
         }
     }
     toJSON() {
-        const trackPrevious = this.trackPrevious;
         return {
             name: this.name,
             view_name: this.viewName,
-            local_only: this.localOnly,
-            insert_only: this.insertOnly,
-            include_old: trackPrevious && (trackPrevious.columns ?? true),
-            include_old_only_when_changed: typeof trackPrevious == 'object' && trackPrevious.onlyWhenChanged == true,
-            include_metadata: this.trackMetadata,
-            ignore_empty_update: this.ignoreEmptyUpdates,
             columns: this.columns.map((c) => c.toJSON()),
-            indexes: this.indexes.map((e) => e.toJSON(this))
+            indexes: this.indexes.map((e) => e.toJSON(this)),
+            ...encodeTableOptions(this)
         };
     }
 }
@@ -9959,7 +9968,7 @@ class TriggerManagerImpl {
     }
     async createDiffTrigger(options) {
         await this.db.waitForReady();
-        const { source, destination, columns, when, hooks, 
+        const { source, destination, columns, when, hooks, manageDestinationExternally = false, 
         // Fall back to the provided default if not given on this level
         useStorage = this.defaultConfig.useStorageByDefault } = options;
         const operations = Object.keys(when);
@@ -10018,23 +10027,27 @@ class TriggerManagerImpl {
             disposeWarningListener();
             return this.db.writeLock(async (tx) => {
                 await this.removeTriggers(tx, triggerIds);
-                await tx.execute(/* sql */ `DROP TABLE IF EXISTS ${destination};`);
+                if (!manageDestinationExternally) {
+                    await tx.execute(/* sql */ `DROP TABLE IF EXISTS ${destination};`);
+                }
                 await releaseStorageClaim?.();
             });
         };
         const setup = async (tx) => {
             // Allow user code to execute in this lock context before the trigger is created.
             await hooks?.beforeCreate?.(tx);
-            await tx.execute(/* sql */ `
-        CREATE ${tableTriggerTypeClause} TABLE ${destination} (
-          operation_id INTEGER PRIMARY KEY AUTOINCREMENT,
-          id TEXT,
-          operation TEXT,
-          timestamp TEXT,
-          value TEXT,
-          previous_value TEXT
-        )
-      `);
+            if (!manageDestinationExternally) {
+                await tx.execute(/* sql */ `
+          CREATE ${tableTriggerTypeClause} TABLE ${destination} (
+            operation_id INTEGER PRIMARY KEY AUTOINCREMENT,
+            id TEXT,
+            operation TEXT,
+            timestamp TEXT,
+            value TEXT,
+            previous_value TEXT
+          )
+        `);
+            }
             if (operations.includes(exports.DiffTriggerOperation.INSERT)) {
                 const insertTriggerId = this.generateTriggerName(exports.DiffTriggerOperation.INSERT, destination, id);
                 triggerIds.push(insertTriggerId);
@@ -10502,11 +10515,7 @@ class AbstractPowerSyncDatabase extends BaseObserver {
             this.logger.warn('Schema validation failed. Unexpected behaviour could occur', ex);
         }
         this._schema = schema;
-        // powersync_replace_schema starts a transaction internally, but we can be more efficient by using BEGIN EXCLUSIVE
-        // on some DB adapters.
-        this.database.writeTransaction((tx) => {
-            return tx.execute('SELECT powersync_replace_schema(?)', [JSON.stringify(this.schema.toJSON())]);
-        });
+        await this.database.execute('SELECT powersync_replace_schema(?)', [JSON.stringify(this.schema.toJSON())]);
         await this.database.refreshSchema();
         this.iterateListeners(async (cb) => cb.schemaChanged?.(schema));
     }
@@ -11611,39 +11620,6 @@ class ConnectionClosedError extends Error {
     }
 }
 
-/**
- * Instructs PowerSync to sync data into a "raw" table.
- *
- * Since raw tables are not backed by JSON, running complex queries on them may be more efficient. Further, they allow
- * using client-side table and column constraints.
- *
- * To collect local writes to raw tables with PowerSync, custom triggers are required. See
- * {@link https://docs.powersync.com/usage/use-case-examples/raw-tables the documentation} for details and an example on
- * using raw tables.
- *
- * Note that raw tables are only supported when using the new `SyncClientImplementation.rust` sync client.
- *
- * @experimental Please note that this feature is experimental at the moment, and not covered by PowerSync semver or
- * stability guarantees.
- */
-class RawTable {
-    /**
-     * The name of the table.
-     *
-     * This does not have to match the actual table name in the schema - {@link put} and {@link delete} are free to use
-     * another table. Instead, this name is used by the sync client to recognize that operations on this table (as it
-     * appears in the source / backend database) are to be handled specially.
-     */
-    name;
-    put;
-    delete;
-    constructor(name, type) {
-        this.name = name;
-        this.put = type.put;
-        this.delete = type.delete;
-    }
-}
-
 /**
  * A schema is a collection of tables. It is used to define the structure of a database.
  */
@@ -11688,7 +11664,7 @@ class Schema {
      */
     withRawTables(tables) {
         for (const [name, rawTableDefinition] of Object.entries(tables)) {
-            this.rawTables.push(new RawTable(name, rawTableDefinition));
+            this.rawTables.push({ name, ...rawTableDefinition });
         }
     }
     validate() {
@@ -11699,8 +11675,30 @@ class Schema {
     toJSON() {
         return {
             tables: this.tables.map((t) => t.toJSON()),
-            raw_tables: this.rawTables
+            raw_tables: this.rawTables.map(Schema.rawTableToJson)
+        };
+    }
+    /**
+     * Returns a representation of the raw table that is understood by the PowerSync SQLite core extension.
+     *
+     * The output of this can be passed through `JSON.serialize` and then used in `powersync_create_raw_table_crud_trigger`
+     * to define triggers for this table.
+     */
+    static rawTableToJson(table) {
+        const serialized = {
+            name: table.name,
+            put: table.put,
+            delete: table.delete,
+            clear: table.clear
         };
+        if ('schema' in table) {
+            // We have schema options, those are flattened into the outer JSON object for the core extension.
+            const schema = table.schema;
+            serialized.table_name = schema.tableName ?? table.name;
+            serialized.synced_columns = schema.syncedColumns;
+            Object.assign(serialized, encodeTableOptions(table.schema));
+        }
+        return serialized;
     }
 }
 
@@ -11913,7 +11911,6 @@ exports.MEMORY_TRIGGER_CLAIM_MANAGER = MEMORY_TRIGGER_CLAIM_MANAGER;
 exports.OnChangeQueryProcessor = OnChangeQueryProcessor;
 exports.OpType = OpType;
 exports.OplogEntry = OplogEntry;
-exports.RawTable = RawTable;
 exports.Schema = Schema;
 exports.SqliteBucketStorage = SqliteBucketStorage;
 exports.SyncDataBatch = SyncDataBatch;