@xixixao/convex-migrations 0.3.1-alpha.1

package/dist/component/lib.js

@@ -0,0 +1,290 @@
+import { ConvexError, v } from "convex/values";
+import { migrationStatus, } from "../shared.js";
+import { api } from "./_generated/api.js";
+import { mutation, query, } from "./_generated/server.js";
+const runMigrationArgs = {
+    name: v.string(),
+    fnHandle: v.string(),
+    cursor: v.optional(v.union(v.string(), v.null())),
+    batchSize: v.optional(v.number()),
+    oneBatchOnly: v.optional(v.boolean()),
+    next: v.optional(v.array(v.object({
+        name: v.string(),
+        fnHandle: v.string(),
+    }))),
+    dryRun: v.boolean(),
+    args: v.optional(v.any()),
+};
+export const migrate = mutation({
+    args: runMigrationArgs,
+    returns: migrationStatus,
+    handler: async (ctx, args) => {
+        // Step 1: Get or create the state.
+        const { fnHandle, batchSize, next: next_, dryRun, name } = args;
+        if (batchSize !== undefined && batchSize <= 0) {
+            throw new Error("Batch size must be greater than 0");
+        }
+        if (!fnHandle.startsWith("function://")) {
+            throw new Error("Invalid fnHandle.\n" +
+                "Do not call this from the CLI or dashboard directly.\n" +
+                "Instead use the `migrations.runner` function to run migrations." +
+                "See https://www.convex.dev/components/migrations");
+        }
+        const state = (await ctx.db
+            .query("migrations")
+            .withIndex("name", (q) => q.eq("name", name))
+            .unique()) ??
+            (await ctx.db.get(await ctx.db.insert("migrations", {
+                name,
+                cursor: args.cursor ?? null,
+                isDone: false,
+                processed: 0,
+                latestStart: Date.now(),
+                args: args.args,
+            })));
+        // Update the state if the cursor arg differs.
+        if (state.cursor !== args.cursor) {
+            // This happens if:
+            // 1. The migration is being started/resumed (args.cursor unset).
+            // 2. The migration is being resumed at a different cursor.
+            // 3. There are two instances of the same migration racing.
+            const worker = state.workerId && (await ctx.db.system.get(state.workerId));
+            if (worker &&
+                (worker.state.kind === "pending" || worker.state.kind === "inProgress")) {
+                // Case 3. The migration is already in progress.
+                console.debug({ state, worker });
+                return getMigrationState(ctx, state);
+            }
+            // Case 2. Update the cursor.
+            if (args.cursor !== undefined) {
+                state.cursor = args.cursor;
+                state.isDone = false;
+                state.latestStart = Date.now();
+                state.latestEnd = undefined;
+                state.processed = 0;
+            }
+            // For Case 1, Step 2 will take the right action.
+        }
+        function updateState(result) {
+            state.cursor = result.continueCursor;
+            state.isDone = result.isDone;
+            state.processed += result.processed;
+            if (result.isDone && state.latestEnd === undefined) {
+                state.latestEnd = Date.now();
+            }
+        }
+        try {
+            // Step 2: Run the migration.
+            if (!state.isDone) {
+                const result = await ctx.runMutation(fnHandle, {
+                    cursor: state.cursor,
+                    batchSize,
+                    dryRun,
+                    args: args.args,
+                });
+                updateState(result);
+                state.error = undefined;
+            }
+            // Step 3: Schedule the next batch or next migration.
+            if (args.oneBatchOnly) {
+                state.workerId = undefined;
+            }
+            else if (!state.isDone) {
+                // Recursively schedule the next batch.
+                state.workerId = await ctx.scheduler.runAfter(0, api.lib.migrate, {
+                    ...args,
+                    cursor: state.cursor,
+                });
+            }
+            else {
+                state.workerId = undefined;
+                // Schedule the next migration in the series.
+                const next = next_ ?? [];
+                // Find the next migration that hasn't been done.
+                let i = 0;
+                for (; i < next.length; i++) {
+                    const doc = await ctx.db
+                        .query("migrations")
+                        .withIndex("name", (q) => q.eq("name", next[i].name))
+                        .unique();
+                    if (!doc || !doc.isDone) {
+                        const [nextFn, ...rest] = next.slice(i);
+                        if (nextFn) {
+                            await ctx.scheduler.runAfter(0, api.lib.migrate, {
+                                name: nextFn.name,
+                                fnHandle: nextFn.fnHandle,
+                                next: rest,
+                                batchSize,
+                                dryRun,
+                            });
+                        }
+                        break;
+                    }
+                }
+                if (args.cursor === undefined) {
+                    if (next.length && i === next.length) {
+                        console.info(`Migration${i > 0 ? "s" : ""} up next already done.`);
+                    }
+                }
+                else {
+                    console.info(`Migration ${name} is done.` +
+                        (i < next.length ? ` Next: ${next[i].name}` : ""));
+                }
+            }
+        }
+        catch (e) {
+            state.workerId = undefined;
+            if (dryRun && e instanceof ConvexError && e.data.kind === "DRY RUN") {
+                // Add the state to the error to bubble up.
+                updateState(e.data.result);
+            }
+            else {
+                state.error = e instanceof Error ? e.message : String(e);
+                console.error(`Migration ${name} failed: ${state.error}`);
+            }
+            if (dryRun) {
+                const status = await getMigrationState(ctx, state);
+                status.batchSize = batchSize;
+                status.next = next_?.map((n) => n.name);
+                throw new ConvexError({
+                    kind: "DRY RUN",
+                    status,
+                });
+            }
+        }
+        // Step 4: Update the state
+        await ctx.db.patch(state._id, state);
+        if (args.dryRun) {
+            // By throwing an error, the transaction will be rolled back and nothing
+            // will be scheduled.
+            console.debug({ args, state });
+            throw new Error("Error: Dry run attempted to update state - rolling back transaction.");
+        }
+        return getMigrationState(ctx, state);
+    },
+});
+export const getStatus = query({
+    args: {
+        names: v.optional(v.array(v.string())),
+        limit: v.optional(v.number()),
+    },
+    returns: v.array(migrationStatus),
+    handler: async (ctx, args) => {
+        const docs = args.names
+            ? await Promise.all(args.names.map(async (m) => (await ctx.db
+                .query("migrations")
+                .withIndex("name", (q) => q.eq("name", m))
+                .unique()) ?? {
+                name: m,
+                processed: 0,
+                cursor: null,
+                latestStart: 0,
+                workerId: undefined,
+                isDone: false,
+            }))
+            : await ctx.db
+                .query("migrations")
+                .order("desc")
+                .take(args.limit ?? 10);
+        return Promise.all(docs
+            .reverse()
+            .map(async (migration) => getMigrationState(ctx, migration)));
+    },
+});
+async function getMigrationState(ctx, migration) {
+    const worker = migration.workerId && (await ctx.db.system.get(migration.workerId));
+    const args = worker?.args[0];
+    const state = migration.isDone
+        ? "success"
+        : migration.error || worker?.state.kind === "failed"
+            ? "failed"
+            : worker?.state.kind === "canceled"
+                ? "canceled"
+                : worker?.state.kind === "inProgress" ||
+                    worker?.state.kind === "pending"
+                    ? "inProgress"
+                    : "unknown";
+    return {
+        name: migration.name,
+        cursor: migration.cursor,
+        processed: migration.processed,
+        isDone: migration.isDone,
+        latestStart: migration.latestStart,
+        latestEnd: migration.latestEnd,
+        error: migration.error,
+        state,
+        batchSize: args?.batchSize,
+        next: args?.next?.map((n) => n.name),
+    };
+}
+export const cancel = mutation({
+    args: { name: v.string() },
+    returns: migrationStatus,
+    handler: async (ctx, args) => {
+        const migration = await ctx.db
+            .query("migrations")
+            .withIndex("name", (q) => q.eq("name", args.name))
+            .unique();
+        if (!migration) {
+            throw new Error(`Migration ${args.name} not found`);
+        }
+        const state = await cancelMigration(ctx, migration);
+        if (state.state !== "canceled") {
+            console.log(`Did not cancel migration ${migration.name}. Status was ${state.state}`);
+        }
+        return state;
+    },
+});
+async function cancelMigration(ctx, migration) {
+    const state = await getMigrationState(ctx, migration);
+    if (state.isDone) {
+        return state;
+    }
+    if (state.state === "inProgress") {
+        if (!migration.workerId) {
+            await ctx.scheduler.cancel(migration.workerId);
+        }
+        console.log(`Canceled migration ${migration.name}`);
+        return { ...state, state: "canceled" };
+    }
+    return state;
+}
+export const cancelAll = mutation({
+    // Paginating with creation time for now
+    args: { sinceTs: v.optional(v.number()) },
+    returns: v.array(migrationStatus),
+    handler: async (ctx, args) => {
+        const results = await ctx.db
+            .query("migrations")
+            .withIndex("isDone", (q) => args.sinceTs
+            ? q.eq("isDone", false).gte("_creationTime", args.sinceTs)
+            : q.eq("isDone", false))
+            .take(100);
+        if (results.length === 100) {
+            await ctx.scheduler.runAfter(0, api.lib.cancelAll, {
+                sinceTs: results[results.length - 1]._creationTime,
+            });
+        }
+        return Promise.all(results.map((m) => cancelMigration(ctx, m)));
+    },
+});
+export const clearAll = mutation({
+    args: { before: v.optional(v.number()) },
+    returns: v.null(),
+    handler: async (ctx, args) => {
+        const results = await ctx.db
+            .query("migrations")
+            .withIndex("by_creation_time", (q) => q.lte("_creationTime", args.before ?? Date.now()))
+            .order("desc")
+            .take(100);
+        for (const m of results) {
+            await ctx.db.delete(m._id);
+        }
+        if (results.length === 100) {
+            await ctx.scheduler.runAfter(0, api.lib.clearAll, {
+                before: results[99]._creationTime,
+            });
+        }
+    },
+});
+//# sourceMappingURL=lib.js.map

package/dist/component/lib.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.js","sourceRoot":"","sources":["../../src/component/lib.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAmB,CAAC,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAIL,eAAe,GAChB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAE1C,OAAO,EACL,QAAQ,EAER,KAAK,GAEN,MAAM,wBAAwB,CAAC;AAQhC,MAAM,gBAAgB,GAAG;IACvB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAEjD,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,QAAQ,CACd,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;KACrB,CAAC,CACH,CACF;IACD,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC;IAC9B,IAAI,EAAE,gBAAgB;IACtB,OAAO,EAAE,eAAe;IACxB,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC3B,mCAAmC;QACnC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAChE,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,IAAI,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CACb,qBAAqB;gBACnB,wDAAwD;gBACxD,iEAAiE;gBACjE,kDAAkD,CACrD,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GACT,CAAC,MAAM,GAAG,CAAC,EAAE;aACV,KAAK,CAAC,YAAY,CAAC;aACnB,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;aAC5C,MAAM,EAAE,CAAC;YACZ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CACf,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,EAAE;gBAChC,IAAI;gBACJ,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,IAAI;gBAC3B,MAAM,EAAE,KAAK;gBACb,SAAS,EAAE,CAAC;gBACZ,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE;gBACvB,IAAI,EAAE,IAAI,CAAC,IAAI;aAChB,CAAC,CACH,CAAE,CAAC;QAEN,8CAA8C;QAC9C,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YACjC,mBAAmB;YACnB,iEAAiE;YACjE,2DAA2D;YAC3D,2DAA2D;YAC3D,MAAM,MAAM,GACV,KAAK,CAAC,QAAQ,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC9D,IACE,MAAM;gBACN,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC,EACvE,CAAC;gBACD,gDAAgD;gBAChD,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;gBACjC,OAAO,iBAAiB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACvC,CAAC;YACD,6BAA6B;YAC7B,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC9B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;gBAC3B,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;gBACrB,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC/B,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;gBAC5B,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC;YACtB,CAAC;YACD,iDAAiD;QACnD,CAAC;QAED,SAAS,WAAW,CAAC,MAAuB;YAC1C,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC;YACrC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;YAC7B,KAAK,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC;YACpC,IAAI,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBACnD,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC/B,CAAC;QACH,CAAC;QAED,IAAI,CAAC;YACH,6BAA6B;YAC7B,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;gBAClB,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,WAAW,CAClC,QAAmC,EACnC;oBACE,MAAM,EAAE,KAAK,CAAC,MAAM;oBACpB,SAAS;oBACT,MAAM;oBACN,IAAI,EAAE,IAAI,CAAC,IAAI;iBAChB,CACF,CAAC;gBACF,WAAW,CAAC,MAAM,CAAC,CAAC;gBACpB,KAAK,CAAC,KAAK,GAAG,SAAS,CAAC;YAC1B,CAAC;YAED,qDAAqD;YACrD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtB,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;YAC7B,CAAC;iBAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;gBACzB,uCAAuC;gBACvC,KAAK,CAAC,QAAQ,GAAG,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE;oBAChE,GAAG,IAAI;oBACP,MAAM,EAAE,KAAK,CAAC,MAAM;iBACrB,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;gBAC3B,6CAA6C;gBAC7C,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACzB,iDAAiD;gBACjD,IAAI,CAAC,GAAG,CAAC,CAAC;gBACV,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC5B,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,EAAE;yBACrB,KAAK,CAAC,YAAY,CAAC;yBACnB,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAE,CAAC,IAAI,CAAC,CAAC;yBACrD,MAAM,EAAE,CAAC;oBACZ,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;wBACxB,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBACxC,IAAI,MAAM,EAAE,CAAC;4BACX,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE;gCAC/C,IAAI,EAAE,MAAM,CAAC,IAAI;gCACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;gCACzB,IAAI,EAAE,IAAI;gCACV,SAAS;gCACT,MAAM;6BACP,CAAC,CAAC;wBACL,CAAC;wBACD,MAAM;oBACR,CAAC;gBACH,CAAC;gBACD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;oBAC9B,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;wBACrC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAAC;oBACrE,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,IAAI,CACV,aAAa,IAAI,WAAW;wBAC1B,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACrD,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;YAC3B,IAAI,MAAM,IAAI,CAAC,YAAY,WAAW,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBACpE,2CAA2C;gBAC3C,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,KAAK,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACzD,OAAO,CAAC,KAAK,CAAC,aAAa,IAAI,YAAY,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;YAC5D,CAAC;YACD,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACnD,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;gBAC7B,MAAM,CAAC,IAAI,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBACxC,MAAM,IAAI,WAAW,CAAC;oBACpB,IAAI,EAAE,SAAS;oBACf,MAAM;iBACP,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,2BAA2B;QAC3B,MAAM,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACrC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,wEAAwE;YACxE,qBAAqB;YACrB,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;QACJ,CAAC;QACD,OAAO,iBAAiB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,CAAC;IAC7B,IAAI,EAAE;QACJ,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QACtC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;KAC9B;IACD,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;IACjC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK;YACrB,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,CACf,IAAI,CAAC,KAAK,CAAC,GAAG,CACZ,KAAK,EAAE,CAAC,EAAE,EAAE,CACV,CAAC,MAAM,GAAG,CAAC,EAAE;iBACV,KAAK,CAAC,YAAY,CAAC;iBACnB,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;iBACzC,MAAM,EAAE,CAAC,IAAI;gBACd,IAAI,EAAE,CAAC;gBACP,SAAS,EAAE,CAAC;gBACZ,MAAM,EAAE,IAAI;gBACZ,WAAW,EAAE,CAAC;gBACd,QAAQ,EAAE,SAAS;gBACnB,MAAM,EAAE,KAAc;aACvB,CACJ,CACF;YACH,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;iBACT,KAAK,CAAC,YAAY,CAAC;iBACnB,KAAK,CAAC,MAAM,CAAC;iBACb,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;QAE9B,OAAO,OAAO,CAAC,GAAG,CAChB,IAAI;aACD,OAAO,EAAE;aACT,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,iBAAiB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAC/D,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,KAAK,UAAU,iBAAiB,CAC9B,GAAa,EACb,SAAiD;IAEjD,MAAM,MAAM,GACV,SAAS,CAAC,QAAQ,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtE,MAAM,IAAI,GAAG,MAAM,EAAE,IAAI,CAAC,CAAC,CAEd,CAAC;IACd,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM;QAC5B,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,MAAM,EAAE,KAAK,CAAC,IAAI,KAAK,QAAQ;YAClD,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,KAAK,UAAU;gBACjC,CAAC,CAAC,UAAU;gBACZ,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,KAAK,YAAY;oBACjC,MAAM,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS;oBAClC,CAAC,CAAC,YAAY;oBACd,CAAC,CAAC,SAAS,CAAC;IACpB,OAAO;QACL,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,MAAM,EAAE,SAAS,CAAC,MAAM;QACxB,SAAS,EAAE,SAAS,CAAC,SAAS;QAC9B,MAAM,EAAE,SAAS,CAAC,MAAM;QACxB,WAAW,EAAE,SAAS,CAAC,WAAW;QAClC,SAAS,EAAE,SAAS,CAAC,SAAS;QAC9B,KAAK,EAAE,SAAS,CAAC,KAAK;QACtB,KAAK;QACL,SAAS,EAAE,IAAI,EAAE,SAAS;QAC1B,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAmB,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;KACvD,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,QAAQ,CAAC;IAC7B,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE;IAC1B,OAAO,EAAE,eAAe;IACxB,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC3B,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,EAAE;aAC3B,KAAK,CAAC,YAAY,CAAC;aACnB,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;aACjD,MAAM,EAAE,CAAC;QAEZ,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,CAAC,IAAI,YAAY,CAAC,CAAC;QACtD,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACpD,IAAI,KAAK,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;YAC/B,OAAO,CAAC,GAAG,CACT,4BAA4B,SAAS,CAAC,IAAI,gBAAgB,KAAK,CAAC,KAAK,EAAE,CACxE,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF,CAAC,CAAC;AAEH,KAAK,UAAU,eAAe,CAAC,GAAgB,EAAE,SAA4B;IAC3E,MAAM,KAAK,GAAG,MAAM,iBAAiB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACtD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,KAAK,CAAC,KAAK,KAAK,YAAY,EAAE,CAAC;QACjC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;YACxB,MAAM,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,QAAS,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,sBAAsB,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;QACpD,OAAO,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,UAAmB,EAAE,CAAC;IAClD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,QAAQ,CAAC;IAChC,wCAAwC;IACxC,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE;IACzC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;IACjC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC3B,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,EAAE;aACzB,KAAK,CAAC,YAAY,CAAC;aACnB,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CACzB,IAAI,CAAC,OAAO;YACV,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC;YAC1D,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAC1B;aACA,IAAI,CAAC,GAAG,CAAC,CAAC;QACb,IAAI,OAAO,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC3B,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE;gBACjD,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAE,CAAC,aAAa;aACpD,CAAC,CAAC;QACL,CAAC;QACD,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,QAAQ,GAAG,QAAQ,CAAC;IAC/B,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE;IACxC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;IACjB,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC3B,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,EAAE;aACzB,KAAK,CAAC,YAAY,CAAC;aACnB,SAAS,CAAC,kBAAkB,EAAE,CAAC,CAAC,EAAE,EAAE,CACnC,CAAC,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,CAClD;aACA,KAAK,CAAC,MAAM,CAAC;aACb,IAAI,CAAC,GAAG,CAAC,CAAC;QACb,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACxB,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC3B,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE;gBAChD,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,aAAa;aAClC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF,CAAC,CAAC"}

package/dist/component/schema.d.ts

@@ -0,0 +1,28 @@
+declare const _default: import("convex/server").SchemaDefinition<{
+    migrations: import("convex/server").TableDefinition<import("convex/values").VObject<{
+        workerId?: import("convex/values").GenericId<"_scheduled_functions"> | undefined;
+        error?: string | undefined;
+        latestEnd?: number | undefined;
+        args?: any;
+        name: string;
+        cursor: string | null;
+        isDone: boolean;
+        processed: number;
+        latestStart: number;
+    }, {
+        name: import("convex/values").VString<string, "required">;
+        cursor: import("convex/values").VUnion<string | null, [import("convex/values").VString<string, "required">, import("convex/values").VNull<null, "required">], "required", never>;
+        isDone: import("convex/values").VBoolean<boolean, "required">;
+        workerId: import("convex/values").VId<import("convex/values").GenericId<"_scheduled_functions"> | undefined, "optional">;
+        error: import("convex/values").VString<string | undefined, "optional">;
+        processed: import("convex/values").VFloat64<number, "required">;
+        latestStart: import("convex/values").VFloat64<number, "required">;
+        latestEnd: import("convex/values").VFloat64<number | undefined, "optional">;
+        args: import("convex/values").VAny<any, "optional", string>;
+    }, "required", "name" | "cursor" | "isDone" | "workerId" | "error" | "processed" | "latestStart" | "latestEnd" | "args" | `args.${string}`>, {
+        name: ["name", "_creationTime"];
+        isDone: ["isDone", "_creationTime"];
+    }, {}, {}>;
+}, true>;
+export default _default;
+//# sourceMappingURL=schema.d.ts.map

package/dist/component/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/component/schema.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,wBAgBG"}

package/dist/component/schema.js

@@ -0,0 +1,20 @@
+import { defineSchema, defineTable } from "convex/server";
+import { v } from "convex/values";
+export default defineSchema({
+    migrations: defineTable({
+        name: v.string(), // Defaults to the function name.
+        cursor: v.union(v.string(), v.null()),
+        isDone: v.boolean(),
+        workerId: v.optional(v.id("_scheduled_functions")),
+        error: v.optional(v.string()),
+        // The number of documents processed so far.
+        processed: v.number(),
+        latestStart: v.number(),
+        latestEnd: v.optional(v.number()),
+        // Runtime args passed to the migration.
+        args: v.optional(v.any()),
+    })
+        .index("name", ["name"])
+        .index("isDone", ["isDone"]),
+});
+//# sourceMappingURL=schema.js.map

package/dist/component/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/component/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,CAAC,EAAE,MAAM,eAAe,CAAC;AAElC,eAAe,YAAY,CAAC;IAC1B,UAAU,EAAE,WAAW,CAAC;QACtB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,iCAAiC;QACnD,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QACrC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;QACnB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,sBAAsB,CAAC,CAAC;QAClD,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAC7B,4CAA4C;QAC5C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;QACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QACjC,wCAAwC;QACxC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;KAC1B,CAAC;SACC,KAAK,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;SACvB,KAAK,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC;CAC/B,CAAC,CAAC"}

package/dist/shared.d.ts

@@ -0,0 +1,40 @@
+import { type Infer, type ObjectType } from "convex/values";
+export declare const migrationArgs: {
+    fn: import("convex/values").VString<string | undefined, "optional">;
+    cursor: import("convex/values").VUnion<string | null | undefined, [import("convex/values").VString<string, "required">, import("convex/values").VNull<null, "required">], "optional", never>;
+    batchSize: import("convex/values").VFloat64<number | undefined, "optional">;
+    dryRun: import("convex/values").VBoolean<boolean | undefined, "optional">;
+    next: import("convex/values").VArray<string[] | undefined, import("convex/values").VString<string, "required">, "optional">;
+    args: import("convex/values").VAny<any, "optional", string>;
+};
+export type MigrationArgs = ObjectType<typeof migrationArgs>;
+export type MigrationResult = {
+    continueCursor: string;
+    isDone: boolean;
+    processed: number;
+};
+export declare const migrationStatus: import("convex/values").VObject<{
+    cursor?: string | null | undefined;
+    batchSize?: number | undefined;
+    next?: string[] | undefined;
+    error?: string | undefined;
+    latestEnd?: number | undefined;
+    name: string;
+    processed: number;
+    isDone: boolean;
+    state: "inProgress" | "success" | "failed" | "canceled" | "unknown";
+    latestStart: number;
+}, {
+    name: import("convex/values").VString<string, "required">;
+    cursor: import("convex/values").VUnion<string | null | undefined, [import("convex/values").VString<string, "required">, import("convex/values").VNull<null, "required">], "optional", never>;
+    processed: import("convex/values").VFloat64<number, "required">;
+    isDone: import("convex/values").VBoolean<boolean, "required">;
+    error: import("convex/values").VString<string | undefined, "optional">;
+    state: import("convex/values").VUnion<"inProgress" | "success" | "failed" | "canceled" | "unknown", [import("convex/values").VLiteral<"inProgress", "required">, import("convex/values").VLiteral<"success", "required">, import("convex/values").VLiteral<"failed", "required">, import("convex/values").VLiteral<"canceled", "required">, import("convex/values").VLiteral<"unknown", "required">], "required", never>;
+    latestStart: import("convex/values").VFloat64<number, "required">;
+    latestEnd: import("convex/values").VFloat64<number | undefined, "optional">;
+    batchSize: import("convex/values").VFloat64<number | undefined, "optional">;
+    next: import("convex/values").VArray<string[] | undefined, import("convex/values").VString<string, "required">, "optional">;
+}, "required", "cursor" | "batchSize" | "next" | "name" | "processed" | "isDone" | "error" | "state" | "latestStart" | "latestEnd">;
+export type MigrationStatus = Infer<typeof migrationStatus>;
+//# sourceMappingURL=shared.d.ts.map

package/dist/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,UAAU,EAAK,MAAM,eAAe,CAAC;AAE/D,eAAO,MAAM,aAAa;;;;;;;CAOzB,CAAC;AACF,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAE7D,MAAM,MAAM,eAAe,GAAG;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;mIAiB1B,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/shared.js

@@ -0,0 +1,22 @@
+import { v } from "convex/values";
+export const migrationArgs = {
+    fn: v.optional(v.string()),
+    cursor: v.optional(v.union(v.string(), v.null())),
+    batchSize: v.optional(v.number()),
+    dryRun: v.optional(v.boolean()),
+    next: v.optional(v.array(v.string())),
+    args: v.optional(v.any()),
+};
+export const migrationStatus = v.object({
+    name: v.string(),
+    cursor: v.optional(v.union(v.string(), v.null())),
+    processed: v.number(),
+    isDone: v.boolean(),
+    error: v.optional(v.string()),
+    state: v.union(v.literal("inProgress"), v.literal("success"), v.literal("failed"), v.literal("canceled"), v.literal("unknown")),
+    latestStart: v.number(),
+    latestEnd: v.optional(v.number()),
+    batchSize: v.optional(v.number()),
+    next: v.optional(v.array(v.string())),
+});
+//# sourceMappingURL=shared.js.map

package/dist/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,CAAC,EAAE,MAAM,eAAe,CAAC;AAE/D,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC1B,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACjD,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC/B,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;CAC1B,CAAC;AASF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACjD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC7B,KAAK,EAAE,CAAC,CAAC,KAAK,CACZ,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EACvB,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EACpB,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EACnB,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EACrB,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CACrB;IACD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;CACtC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "@xixixao/convex-migrations",
+  "description": "A migrations component for Convex. Define, run, and track your database migrations. Run from a CLI or Convex server function.",
+  "repository": "github:get-convex/migrations",
+  "homepage": "https://github.com/get-convex/migrations#readme",
+  "bugs": {
+    "email": "support@convex.dev",
+    "url": "https://github.com/get-convex/migrations/issues"
+  },
+  "version": "0.3.1-alpha.1",
+  "license": "Apache-2.0",
+  "keywords": [
+    "convex",
+    "component"
+  ],
+  "type": "module",
+  "scripts": {
+    "dev": "run-p -r 'dev:*'",
+    "dev:backend": "convex dev --typecheck-components",
+    "dev:frontend": "cd example && vite --clearScreen false",
+    "dev:build": "chokidar 'tsconfig*.json' 'src/**/*.ts' -i '**/*.test.ts' -c 'npm run build:codegen' --initial",
+    "predev": "path-exists .env.local dist || (npm run build && convex dev --once)",
+    "build": "tsc --project ./tsconfig.build.json",
+    "build:codegen": "npx convex codegen --component-dir ./src/component && npm run build",
+    "build:clean": "rm -rf dist *.tsbuildinfo && npm run build:codegen",
+    "typecheck": "tsc --noEmit && tsc -p example && tsc -p example/convex",
+    "lint": "eslint .",
+    "all": "run-p -r 'dev:*' 'test:watch'",
+    "test": "vitest run --typecheck",
+    "test:watch": "vitest --typecheck --clearScreen false",
+    "test:debug": "vitest --inspect-brk --no-file-parallelism",
+    "test:coverage": "vitest run --coverage --coverage.reporter=text",
+    "preversion": "npm ci && npm run build:clean && run-p test lint typecheck",
+    "prepublishOnly": "npm whoami || npm login",
+    "alpha": "npm version prerelease --preid alpha && npm publish --tag alpha && git push --follow-tags",
+    "release": "npm version patch && npm publish && git push --follow-tags",
+    "version": "vim -c 'normal o' -c 'normal o## '$npm_package_version CHANGELOG.md && prettier -w CHANGELOG.md && git add CHANGELOG.md"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/client/index.d.ts",
+      "default": "./dist/client/index.js"
+    },
+    "./test": "./src/test.ts",
+    "./_generated/component.js": {
+      "types": "./dist/component/_generated/component.d.ts"
+    },
+    "./convex.config": {
+      "types": "./dist/component/convex.config.d.ts",
+      "default": "./dist/component/convex.config.js"
+    },
+    "./convex.config.js": {
+      "types": "./dist/component/convex.config.d.ts",
+      "default": "./dist/component/convex.config.js"
+    }
+  },
+  "peerDependencies": {
+    "convex": "^1.24.8"
+  },
+  "devDependencies": {
+    "@edge-runtime/vm": "5.0.0",
+    "@eslint/eslintrc": "3.3.1",
+    "@eslint/js": "9.39.1",
+    "@types/node": "20.19.24",
+    "@types/react": "18.3.26",
+    "@types/react-dom": "18.3.7",
+    "@vitejs/plugin-react": "5.0.4",
+    "chokidar-cli": "3.0.0",
+    "convex": "1.30.0",
+    "convex-test": "0.0.41",
+    "cpy-cli": "6.0.0",
+    "eslint": "9.39.1",
+    "eslint-plugin-react": "7.37.5",
+    "eslint-plugin-react-hooks": "5.2.0",
+    "eslint-plugin-react-refresh": "0.4.24",
+    "globals": "15.14.0",
+    "npm-run-all2": "7.0.2",
+    "path-exists-cli": "2.0.0",
+    "pkg-pr-new": "0.0.60",
+    "prettier": "3.6.2",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.46.4",
+    "vite": "^7.1.5",
+    "vitest": "3.2.4"
+  },
+  "types": "./dist/client/index.d.ts",
+  "module": "./dist/client/index.js"
+}

package/src/client/index.test.ts

@@ -0,0 +1,16 @@
+import { describe, test, expect } from "vitest";
+import { Migrations, DEFAULT_BATCH_SIZE } from "./index.js";
+import type { ComponentApi } from "../component/_generated/component.js";
+
+describe("Migrations class", () => {
+  test("can instantiate without error", () => {
+    const dummyComponent = {} as ComponentApi;
+    expect(() => new Migrations(dummyComponent)).not.toThrow();
+  });
+});
+
+describe("DEFAULT_BATCH_SIZE", () => {
+  test("should equal 100", () => {
+    expect(DEFAULT_BATCH_SIZE).toBe(100);
+  });
+});