@powersync/lib-services-framework 0.0.0-dev-20241111122558 → 0.0.0-dev-20241219091224

package/dist/container.d.ts

@@ -1,14 +1,17 @@
 import { ErrorReporter } from './alerts/definitions.js';
+import { MigrationManager } from './migrations/MigrationManager.js';
 import { ProbeModule, TerminationHandler } from './signals/signals-index.js';
 export declare enum ContainerImplementation {
     REPORTER = "reporter",
     PROBES = "probes",
-    TERMINATION_HANDLER = "termination-handler"
+    TERMINATION_HANDLER = "termination-handler",
+    MIGRATION_MANAGER = "migration-manager"
 }
 export type ContainerImplementationTypes = {
     [ContainerImplementation.REPORTER]: ErrorReporter;
     [ContainerImplementation.PROBES]: ProbeModule;
     [ContainerImplementation.TERMINATION_HANDLER]: TerminationHandler;
+    [ContainerImplementation.MIGRATION_MANAGER]: MigrationManager;
 };
 export type RegisterDefaultsOptions = {
     skip?: ContainerImplementation[];
@@ -52,6 +55,10 @@ export declare class Container {
         handleTerminationSignalLast: (handler: import("./signals/termination-handler.js").Handler) => void;
         gracefully: <T>(exec: () => T | Promise<T>, handler: (component: T, signal: import("./signals/termination-handler.js").Signal) => Promise<void> | void) => Promise<T>;
     };
+    /**
+     * Manager for system migrations.
+     */
+    get migrationManager(): MigrationManager<import("./index.js").MigrationAgentGenerics>;
     constructor();
     /**
      * Gets an implementation given an identifier.

package/dist/container.js

@@ -1,16 +1,19 @@
 import _ from 'lodash';
 import { NoOpReporter } from './alerts/no-op-reporter.js';
+import { MigrationManager } from './migrations/MigrationManager.js';
 import { createFSProbe, createTerminationHandler } from './signals/signals-index.js';
 export var ContainerImplementation;
 (function (ContainerImplementation) {
     ContainerImplementation["REPORTER"] = "reporter";
     ContainerImplementation["PROBES"] = "probes";
     ContainerImplementation["TERMINATION_HANDLER"] = "termination-handler";
+    ContainerImplementation["MIGRATION_MANAGER"] = "migration-manager";
 })(ContainerImplementation || (ContainerImplementation = {}));
 const DEFAULT_GENERATORS = {
     [ContainerImplementation.REPORTER]: () => NoOpReporter,
     [ContainerImplementation.PROBES]: () => createFSProbe(),
-    [ContainerImplementation.TERMINATION_HANDLER]: () => createTerminationHandler()
+    [ContainerImplementation.TERMINATION_HANDLER]: () => createTerminationHandler(),
+    [ContainerImplementation.MIGRATION_MANAGER]: () => new MigrationManager()
 };
 /**
  * A container which provides means for registering and getting various
@@ -35,6 +38,12 @@ export class Container {
     get terminationHandler() {
         return this.getImplementation(ContainerImplementation.TERMINATION_HANDLER);
     }
+    /**
+     * Manager for system migrations.
+     */
+    get migrationManager() {
+        return this.getImplementation(ContainerImplementation.MIGRATION_MANAGER);
+    }
     constructor() {
         this.implementations = new Map();
     }

package/dist/container.js.map

@@ -1 +1 @@
-{"version":3,"file":"container.js","sourceRoot":"","sources":["../src/container.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAC;AAEvB,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAmC,aAAa,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtH,MAAM,CAAN,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,gDAAqB,CAAA;IACrB,4CAAiB,CAAA;IACjB,sEAA2C,CAAA;AAC7C,CAAC,EAJW,uBAAuB,KAAvB,uBAAuB,QAIlC;AAgCD,MAAM,kBAAkB,GAA6C;IACnE,CAAC,uBAAuB,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,YAAY;IACtD,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,aAAa,EAAE;IACvD,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,EAAE,GAAG,EAAE,CAAC,wBAAwB,EAAE;CAChF,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,SAAS;IAGpB;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;IAC7E,CAAC;IAED;QACE,IAAI,CAAC,eAAe,GAAG,IAAI,GAAG,EAAE,CAAC;IACnC,CAAC;IAWD,iBAAiB,CAAI,UAAgC;QACnD,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,sBAAsB,MAAM,CAAC,UAAU,CAAC,2BAA2B,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAWD,WAAW,CAAI,UAAgC;QAC7C,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,OAAiC;QAChD,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACzF,MAAM,SAAS,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CAAI,UAAgC,EAAE,cAAiB;QAC7D,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACvD,CAAC;CACF;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC"}
+{"version":3,"file":"container.js","sourceRoot":"","sources":["../src/container.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAC;AAEvB,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAmC,aAAa,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtH,MAAM,CAAN,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,gDAAqB,CAAA;IACrB,4CAAiB,CAAA;IACjB,sEAA2C,CAAA;IAC3C,kEAAuC,CAAA;AACzC,CAAC,EALW,uBAAuB,KAAvB,uBAAuB,QAKlC;AAiCD,MAAM,kBAAkB,GAA6C;IACnE,CAAC,uBAAuB,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,YAAY;IACtD,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,aAAa,EAAE;IACvD,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,EAAE,GAAG,EAAE,CAAC,wBAAwB,EAAE;IAC/E,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,gBAAgB,EAAE;CAC1E,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,SAAS;IAGpB;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;IAC3E,CAAC;IAED;QACE,IAAI,CAAC,eAAe,GAAG,IAAI,GAAG,EAAE,CAAC;IACnC,CAAC;IAWD,iBAAiB,CAAI,UAAgC;QACnD,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,sBAAsB,MAAM,CAAC,UAAU,CAAC,2BAA2B,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAWD,WAAW,CAAI,UAAgC;QAC7C,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,OAAiC;QAChD,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACzF,MAAM,SAAS,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CAAI,UAAgC,EAAE,cAAiB;QAC7D,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACvD,CAAC;CACF;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC"}

package/dist/index.d.ts

@@ -6,6 +6,10 @@ export * from './container.js';
 export * from './errors/errors-index.js';
 export * as errors from './errors/errors-index.js';
 export * from './logger/Logger.js';
+export * from './locks/locks-index.js';
+export * as locks from './locks/locks-index.js';
+export * from './migrations/migrations-index.js';
+export * as migrations from './migrations/migrations-index.js';
 export * from './schema/schema-index.js';
 export * as schema from './schema/schema-index.js';
 export * from './signals/signals-index.js';

package/dist/index.js

@@ -6,6 +6,10 @@ export * from './container.js';
 export * from './errors/errors-index.js';
 export * as errors from './errors/errors-index.js';
 export * from './logger/Logger.js';
+export * from './locks/locks-index.js';
+export * as locks from './locks/locks-index.js';
+export * from './migrations/migrations-index.js';
+export * as migrations from './migrations/migrations-index.js';
 export * from './schema/schema-index.js';
 export * as schema from './schema/schema-index.js';
 export * from './signals/signals-index.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,wBAAwB,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAC;AAEjD,cAAc,gBAAgB,CAAC;AAE/B,cAAc,0BAA0B,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,oBAAoB,CAAC;AAEnC,cAAc,0BAA0B,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,4BAA4B,CAAC;AAC3C,OAAO,KAAK,OAAO,MAAM,4BAA4B,CAAC;AAEtD,cAAc,0BAA0B,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,8BAA8B,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,wBAAwB,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,wBAAwB,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAC;AAEjD,cAAc,gBAAgB,CAAC;AAE/B,cAAc,0BAA0B,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,oBAAoB,CAAC;AAEnC,cAAc,wBAAwB,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,wBAAwB,CAAC;AAEhD,cAAc,kCAAkC,CAAC;AACjD,OAAO,KAAK,UAAU,MAAM,kCAAkC,CAAC;AAE/D,cAAc,0BAA0B,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,4BAA4B,CAAC;AAC3C,OAAO,KAAK,OAAO,MAAM,4BAA4B,CAAC;AAEtD,cAAc,0BAA0B,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,8BAA8B,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,wBAAwB,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,wBAAwB,CAAC"}

package/dist/locks/LockManager.d.ts

@@ -0,0 +1,16 @@
+export declare class LockActiveError extends Error {
+    constructor();
+}
+export type LockAcquireOptions = {
+    /**
+     * Optionally retry and wait for the lock to be acquired
+     */
+    max_wait_ms?: number;
+};
+export type LockManager = {
+    init?: () => Promise<void>;
+    acquire: (options?: LockAcquireOptions) => Promise<string | null>;
+    refresh: (lock_id: string) => Promise<void>;
+    release: (lock_id: string) => Promise<void>;
+    lock: (handler: (refresh: () => Promise<void>) => Promise<void>) => Promise<void>;
+};

package/dist/locks/LockManager.js

@@ -0,0 +1,7 @@
+export class LockActiveError extends Error {
+    constructor() {
+        super('Lock is already active');
+        this.name = this.constructor.name;
+    }
+}
+//# sourceMappingURL=LockManager.js.map

package/dist/locks/LockManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LockManager.js","sourceRoot":"","sources":["../../src/locks/LockManager.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxC;QACE,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF"}

package/dist/locks/locks-index.d.ts

@@ -0,0 +1 @@
+export * from './LockManager.js';

package/dist/locks/locks-index.js

@@ -0,0 +1,2 @@
+export * from './LockManager.js';
+//# sourceMappingURL=locks-index.js.map

package/dist/locks/locks-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"locks-index.js","sourceRoot":"","sources":["../../src/locks/locks-index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/dist/migrations/AbstractMigrationAgent.d.ts

@@ -0,0 +1,34 @@
+import { LockManager } from '../locks/LockManager.js';
+import * as defs from './migration-definitions.js';
+export type MigrationParams<Generics extends MigrationAgentGenerics = MigrationAgentGenerics> = {
+    count?: number;
+    direction: defs.Direction;
+    migrationContext?: Generics['MIGRATION_CONTEXT'];
+};
+type WriteLogsParams = {
+    state?: defs.MigrationState;
+    log_stream: Iterable<defs.ExecutedMigration> | AsyncIterable<defs.ExecutedMigration>;
+};
+export type MigrationAgentGenerics = {
+    MIGRATION_CONTEXT?: {};
+};
+export type RunMigrationParams<Generics extends MigrationAgentGenerics = MigrationAgentGenerics> = MigrationParams & {
+    migrations: defs.Migration<Generics['MIGRATION_CONTEXT']>[];
+    maxLockWaitMs?: number;
+};
+type ExecuteParams = RunMigrationParams & {
+    state?: defs.MigrationState;
+};
+export declare const DEFAULT_MAX_LOCK_WAIT_MS: number;
+export declare abstract class AbstractMigrationAgent<Generics extends MigrationAgentGenerics = MigrationAgentGenerics> implements AsyncDisposable {
+    abstract get store(): defs.MigrationStore;
+    abstract get locks(): LockManager;
+    abstract loadInternalMigrations(): Promise<defs.Migration<Generics['MIGRATION_CONTEXT']>[]>;
+    abstract [Symbol.asyncDispose](): Promise<void>;
+    protected init(): Promise<void>;
+    run(params: RunMigrationParams): Promise<void>;
+    protected execute(params: ExecuteParams): AsyncGenerator<defs.ExecutedMigration>;
+    resetStore(): Promise<void>;
+    protected writeLogsToStore: (params: WriteLogsParams) => Promise<void>;
+}
+export {};

package/dist/migrations/AbstractMigrationAgent.js

@@ -0,0 +1,118 @@
+import { logger } from '../logger/Logger.js';
+import * as defs from './migration-definitions.js';
+export const DEFAULT_MAX_LOCK_WAIT_MS = 3 * 60 * 1000; // 3 minutes
+export class AbstractMigrationAgent {
+    constructor() {
+        this.writeLogsToStore = async (params) => {
+            const log = [...(params.state?.log || [])];
+            for await (const migration of params.log_stream) {
+                log.push(migration);
+                await this.store.save({
+                    last_run: migration.name,
+                    log: log
+                });
+            }
+        };
+    }
+    async init() {
+        await this.locks.init?.();
+        await this.store.init?.();
+    }
+    async run(params) {
+        await this.init();
+        const { direction, migrations, migrationContext } = params;
+        // Only one process should execute this at a time.
+        logger.info('Acquiring lock for migrations');
+        const lockId = await this.locks.acquire({ max_wait_ms: params.maxLockWaitMs ?? DEFAULT_MAX_LOCK_WAIT_MS });
+        if (!lockId) {
+            throw new Error('Could not acquire lock');
+        }
+        let isReleased = false;
+        const releaseLock = async () => {
+            if (isReleased) {
+                return;
+            }
+            await this.locks.release(lockId);
+            isReleased = true;
+        };
+        // For the case where the migration is terminated
+        process.addListener('beforeExit', releaseLock);
+        try {
+            const state = await this.store.load();
+            logger.info('Running migrations');
+            const logStream = this.execute({
+                direction,
+                migrations,
+                state,
+                migrationContext
+            });
+            await this.writeLogsToStore({
+                log_stream: logStream,
+                state
+            });
+        }
+        finally {
+            logger.info('Releasing migration lock');
+            await releaseLock();
+            process.removeListener('beforeExit', releaseLock);
+            logger.info('Done with migrations');
+        }
+    }
+    async *execute(params) {
+        const internalMigrations = await this.loadInternalMigrations();
+        let migrations = [...internalMigrations, ...params.migrations];
+        if (params.direction === defs.Direction.Down) {
+            migrations.reverse();
+        }
+        let index = 0;
+        if (params.state) {
+            // Find the index of the last run
+            index = migrations.findIndex((migration) => {
+                return migration.name === params.state.last_run;
+            });
+            if (index === -1) {
+                throw new Error(`The last run migration ${params.state?.last_run} was not found in the given set of migrations`);
+            }
+            // If we are migrating down then we want to include the last run migration, otherwise we want to start at the next one
+            if (params.direction === defs.Direction.Up) {
+                index += 1;
+            }
+        }
+        migrations = migrations.slice(index);
+        let i = 0;
+        const { migrationContext } = params;
+        for (const migration of migrations) {
+            if (params.count && params.count === i) {
+                return;
+            }
+            logger.info(`Executing ${migration.name} (${params.direction})`);
+            try {
+                switch (params.direction) {
+                    case defs.Direction.Up: {
+                        await migration.up(migrationContext);
+                        break;
+                    }
+                    case defs.Direction.Down: {
+                        await migration.down(migrationContext);
+                        break;
+                    }
+                }
+                logger.debug(`Success`);
+            }
+            catch (err) {
+                logger.error(`Failed`, err);
+                process.exit(1);
+            }
+            yield {
+                name: migration.name,
+                direction: params.direction,
+                timestamp: new Date()
+            };
+            i++;
+        }
+    }
+    resetStore() {
+        return this.store.clear();
+    }
+}
+//# sourceMappingURL=AbstractMigrationAgent.js.map

package/dist/migrations/AbstractMigrationAgent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractMigrationAgent.js","sourceRoot":"","sources":["../../src/migrations/AbstractMigrationAgent.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,4BAA4B,CAAC;AA0BnD,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,YAAY;AAEnE,MAAM,OAAgB,sBAAsB;IAA5C;QAmIY,qBAAgB,GAAG,KAAK,EAAE,MAAuB,EAAiB,EAAE;YAC5E,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;YAC3C,IAAI,KAAK,EAAE,MAAM,SAAS,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;gBAChD,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACpB,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;oBACpB,QAAQ,EAAE,SAAS,CAAC,IAAI;oBACxB,GAAG,EAAE,GAAG;iBACT,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IAnIW,KAAK,CAAC,IAAI;QAClB,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;QAC1B,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,MAA0B;QAClC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAElB,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;QAC3D,kDAAkD;QAClD,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,aAAa,IAAI,wBAAwB,EAAE,CAAC,CAAC;QAE3G,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE;YAC7B,IAAI,UAAU,EAAE,CAAC;gBACf,OAAO;YACT,CAAC;YACD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACjC,UAAU,GAAG,IAAI,CAAC;QACpB,CAAC,CAAC;QAEF,iDAAiD;QACjD,OAAO,CAAC,WAAW,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QAE/C,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAEtC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;YAClC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC;gBAC7B,SAAS;gBACT,UAAU;gBACV,KAAK;gBACL,gBAAgB;aACjB,CAAC,CAAC;YAEH,MAAM,IAAI,CAAC,gBAAgB,CAAC;gBAC1B,UAAU,EAAE,SAAS;gBACrB,KAAK;aACN,CAAC,CAAC;QACL,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;YACxC,MAAM,WAAW,EAAE,CAAC;YACpB,OAAO,CAAC,cAAc,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;YAClD,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAES,KAAK,CAAC,CAAC,OAAO,CAAC,MAAqB;QAC5C,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC/D,IAAI,UAAU,GAAG,CAAC,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YAC7C,UAAU,CAAC,OAAO,EAAE,CAAC;QACvB,CAAC;QAED,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,iCAAiC;YACjC,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE;gBACzC,OAAO,SAAS,CAAC,IAAI,KAAK,MAAM,CAAC,KAAM,CAAC,QAAQ,CAAC;YACnD,CAAC,CAAC,CAAC;YAEH,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CACb,0BAA0B,MAAM,CAAC,KAAK,EAAE,QAAQ,+CAA+C,CAChG,CAAC;YACJ,CAAC;YAED,sHAAsH;YACtH,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC;gBAC3C,KAAK,IAAI,CAAC,CAAC;YACb,CAAC;QACH,CAAC;QAED,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAErC,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;QACpC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;gBACvC,OAAO;YACT,CAAC;YAED,MAAM,CAAC,IAAI,CAAC,aAAa,SAAS,CAAC,IAAI,KAAK,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC;YACjE,IAAI,CAAC;gBACH,QAAQ,MAAM,CAAC,SAAS,EAAE,CAAC;oBACzB,KAAK,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;wBACvB,MAAM,SAAS,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC;wBACrC,MAAM;oBACR,CAAC;oBACD,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;wBACzB,MAAM,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;wBACvC,MAAM;oBACR,CAAC;gBACH,CAAC;gBACD,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC1B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;gBAC5B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC;YAED,MAAM;gBACJ,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,SAAS,EAAE,IAAI,IAAI,EAAE;aACtB,CAAC;YAEF,CAAC,EAAE,CAAC;QACN,CAAC;IACH,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;CAYF"}

package/dist/migrations/MigrationManager.d.ts

@@ -0,0 +1,11 @@
+import { AbstractMigrationAgent, MigrationAgentGenerics, MigrationParams } from './AbstractMigrationAgent.js';
+import * as defs from './migration-definitions.js';
+export declare class MigrationManager<Generics extends MigrationAgentGenerics = MigrationAgentGenerics> implements AsyncDisposable {
+    private migrations;
+    private _agent;
+    constructor();
+    registerMigrationAgent(agent: AbstractMigrationAgent<Generics>): void;
+    registerMigrations(migrations: defs.Migration<Generics['MIGRATION_CONTEXT']>[]): void;
+    migrate(params: MigrationParams<Generics>): Promise<void>;
+    [Symbol.asyncDispose](): Promise<void | undefined>;
+}

package/dist/migrations/MigrationManager.js

@@ -0,0 +1,28 @@
+export class MigrationManager {
+    constructor() {
+        this.migrations = [];
+        this._agent = null;
+    }
+    registerMigrationAgent(agent) {
+        if (this._agent) {
+            throw new Error(`A migration agent has already been registered. Only a single agent is supported.`);
+        }
+        this._agent = agent;
+    }
+    registerMigrations(migrations) {
+        this.migrations.push(...migrations);
+    }
+    async migrate(params) {
+        if (!this._agent) {
+            throw new Error(`A migration agent has not been registered yet.`);
+        }
+        return this._agent.run({
+            ...params,
+            migrations: this.migrations
+        });
+    }
+    async [Symbol.asyncDispose]() {
+        return this._agent?.[Symbol.asyncDispose]();
+    }
+}
+//# sourceMappingURL=MigrationManager.js.map

package/dist/migrations/MigrationManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MigrationManager.js","sourceRoot":"","sources":["../../src/migrations/MigrationManager.ts"],"names":[],"mappings":"AAGA,MAAM,OAAO,gBAAgB;IAM3B;QACE,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACrB,CAAC;IAED,sBAAsB,CAAC,KAAuC;QAC5D,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;QACtG,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,kBAAkB,CAAC,UAA2D;QAC5E,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAiC;QAC7C,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;YACrB,GAAG,MAAM;YACT,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;QACzB,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;IAC9C,CAAC;CACF"}

package/dist/migrations/migration-definitions.d.ts

@@ -0,0 +1,28 @@
+export type MigrationFunction<Context extends {} | undefined = undefined> = (context: Context) => Promise<void>;
+export type Migration<Context extends {} | undefined = undefined> = {
+    name: string;
+    up: MigrationFunction<Context>;
+    down: MigrationFunction<Context>;
+};
+export declare enum Direction {
+    Up = "up",
+    Down = "down"
+}
+export type ExecutedMigration = {
+    name: string;
+    direction: Direction;
+    timestamp: Date;
+};
+export type MigrationState = {
+    last_run: string;
+    log: ExecutedMigration[];
+};
+export type MigrationStore = {
+    init?: () => Promise<void>;
+    load: () => Promise<MigrationState | undefined>;
+    save: (state: MigrationState) => Promise<void>;
+    /**
+     * Resets the migration store state. Mostly used for tests.
+     */
+    clear: () => Promise<void>;
+};

package/dist/migrations/migration-definitions.js

@@ -0,0 +1,6 @@
+export var Direction;
+(function (Direction) {
+    Direction["Up"] = "up";
+    Direction["Down"] = "down";
+})(Direction || (Direction = {}));
+//# sourceMappingURL=migration-definitions.js.map

package/dist/migrations/migration-definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration-definitions.js","sourceRoot":"","sources":["../../src/migrations/migration-definitions.ts"],"names":[],"mappings":"AAQA,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,sBAAS,CAAA;IACT,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}

package/dist/migrations/migrations-index.d.ts

@@ -0,0 +1,3 @@
+export * from './AbstractMigrationAgent.js';
+export * from './migration-definitions.js';
+export * from './MigrationManager.js';

package/dist/migrations/migrations-index.js

@@ -0,0 +1,4 @@
+export * from './AbstractMigrationAgent.js';
+export * from './migration-definitions.js';
+export * from './MigrationManager.js';
+//# sourceMappingURL=migrations-index.js.map

package/dist/migrations/migrations-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrations-index.js","sourceRoot":"","sources":["../../src/migrations/migrations-index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@powersync/lib-services-framework",
   "repository": "https://github.com/powersync-ja/powersync-service",
-  "version": "0.0.0-dev-20241111122558",
+  "version": "0.0.0-dev-20241219091224",
   "main": "dist/index.js",
   "type": "module",
   "types": "dist/index.d.ts",
@@ -19,7 +19,7 @@
     "bson": "^6.6.0",
     "dotenv": "^16.4.5",
     "lodash": "^4.17.21",
-    "ts-codec": "^1.2.2",
+    "ts-codec": "^1.3.0",
     "uuid": "^9.0.1",
     "winston": "^3.13.0",
     "zod": "^3.23.8"