@rivi-software/d1-migrations 0.1.0 → 0.1.1

package/dist/bundle.d.ts

@@ -2,10 +2,15 @@ import { type MigrationsSource } from "./files.js";
 import { type D1Migration } from "./index.js";
 export { compareMigrationPaths, listMigrationFiles } from "./files.js";
 export type { MigrationFile, MigrationFiles, MigrationsSource } from "./files.js";
+/**
+ * Where {@link readD1Migrations} finds the migrations, and the table that records them: the D1
+ * binding's fields in the Wrangler config.
+ */
 export type ReadD1MigrationsOptions = MigrationsSource & {
     /** The binding's `migrations_table`. Default `d1_migrations`. */
     table?: string;
 };
+/** {@link readD1Migrations}'s options, and the module {@link bundleD1Migrations} writes. */
 export type BundleD1MigrationsOptions = ReadD1MigrationsOptions & {
     /**
      * The module to write, relative to `cwd`. A `.ts` file gets type annotations; any other gets
@@ -13,10 +18,13 @@ export type BundleD1MigrationsOptions = ReadD1MigrationsOptions & {
      */
     out: string;
 };
+/** What {@link bundleD1Migrations} put in the module, and whether it wrote it. */
 export type BundleD1MigrationsResult = {
     /** The module's absolute path. */
     out: string;
+    /** The migrations table the module names. */
     table: string;
+    /** The migrations in the module, in Wrangler's order, each split into its statements. */
     migrations: D1Migration[];
     /** Whether the module changed. An unchanged module is not written, so no watcher wakes. */
     changed: boolean;

package/dist/index.d.ts

@@ -31,6 +31,7 @@ export interface D1DatabaseLike {
     prepare(query: string): D1StatementLike;
     batch(statements: D1StatementLike[]): Promise<unknown>;
 }
+/** What {@link migrateD1} resolves to once every migration the database lacked is applied. */
 export type MigrateD1Result = {
     /** The migrations this call applied, in order. Empty when the database was up to date. */
     applied: string[];

package/dist/journal.d.ts

@@ -2,10 +2,12 @@ import { type MigrationsSource } from "./files.js";
 export type { MigrationsSource } from "./files.js";
 /** The journal's file name in the migrations directory, unless `journal` names another file. */
 export declare const JOURNAL_FILE = "JOURNAL.json";
+/** Where the migrations are, as the D1 binding in the Wrangler config says, and the journal. */
 export type JournalOptions = MigrationsSource & {
     /** The journal, relative to `cwd`. Default `JOURNAL.json` in the migrations directory. */
     journal?: string;
 };
+/** One recorded migration: its name, and the hash of its text when it was recorded. */
 export type JournalEntry = {
     /** The migration's name, as its migrations table records it. */
     name: string;
@@ -25,12 +27,14 @@ export type JournalProblem = {
     name: string;
     kind: "edited" | "deleted" | "unrecorded";
 };
+/** What {@link checkJournal} found. It writes nothing. */
 export type JournalCheck = {
     /** The journal's absolute path. */
     journal: string;
     /** Empty when every migration matches the journal. */
     problems: JournalProblem[];
 };
+/** What {@link updateJournal} recorded, or the problems that kept it from writing anything. */
 export type JournalUpdate = {
     /** The journal's absolute path. */
     journal: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivi-software/d1-migrations",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "D1 migrations from inside a Worker, for databases an app creates at runtime: the same files, order and d1_migrations table as wrangler d1 migrations apply, and a journal of hashes that fails CI when an applied migration is edited",
   "keywords": [
     "cloudflare",