@noego/proper 0.2.1 → 0.3.0

package/bin/index.d.mts

@@ -6,6 +6,11 @@ interface MigrationConfig {
     migration_table: string;
     migration_folder: string;
     database: string;
+    /**
+     * Exact canonical migration keys whose historical rounded stamps are
+     * explicitly allowed. Proper remains strict for every other migration.
+     */
+    legacy_migration_keys?: readonly string[];
     /**
      * Folder containing one-shot ledger patch files. Defaults to a `patches`
      * sibling of `migration_folder` (e.g. `migrations` -> `patches`,

package/bin/index.d.ts

@@ -6,6 +6,11 @@ interface MigrationConfig {
     migration_table: string;
     migration_folder: string;
     database: string;
+    /**
+     * Exact canonical migration keys whose historical rounded stamps are
+     * explicitly allowed. Proper remains strict for every other migration.
+     */
+    legacy_migration_keys?: readonly string[];
     /**
      * Folder containing one-shot ledger patch files. Defaults to a `patches`
      * sibling of `migration_folder` (e.g. `migrations` -> `patches`,

package/bin/index.js

@@ -90,9 +90,6 @@ module.exports = __toCommonJS(index_exports);
 // framework/MigrationRunner.ts
 var import_fs6 = __toESM(require("fs"));
 
-// framework/MigrationDirectoryReader.ts
-var import_fs2 = __toESM(require("fs"));
-
 // framework/errors.ts
 var MigrationError = class _MigrationError extends Error {
   constructor(message) {
@@ -157,6 +154,16 @@ var DatabaseConnectionError = class _DatabaseConnectionError extends MigrationEr
     return new _DatabaseConnectionError(`Authentication failed for ${dbType} database`);
   }
 };
+var MigrationStampError = class _MigrationStampError extends MigrationError {
+  constructor(migrationKey) {
+    super(
+      `Migration '${migrationKey}' cannot be migrated: its timestamp ends in "000", so it does not look like it was generated by 'proper create'. Recreate it with 'proper create <name>' and move the SQL into the generated files.`
+    );
+    this.migrationKey = migrationKey;
+    this.name = "MigrationStampError";
+    Object.setPrototypeOf(this, _MigrationStampError.prototype);
+  }
+};
 var MigrationExecutionError = class _MigrationExecutionError extends MigrationError {
   constructor(message, migrationName, sql, originalError) {
     let fullMessage = `Migration Execution Error${migrationName ? ` in '${migrationName}'` : ""}: ${message}`;
@@ -285,6 +292,71 @@ var CLIError = class _CLIError extends MigrationError {
   }
 };
 
+// framework/MigrationManifest.ts
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var MIGRATION_FILE_REGEX = /(?:\.(mysql|sqlite|pg))?\.(up|down)\.(sql|js)$/i;
+function isMigrationFile(fileName) {
+  return MIGRATION_FILE_REGEX.test(fileName);
+}
+function canonicalMigrationKey(value) {
+  return value.replace(MIGRATION_FILE_REGEX, "").toLowerCase();
+}
+function mintMigrationStamp(now = Date.now()) {
+  return now % 10 === 0 ? now + 1 : now;
+}
+function isHandStampedKey(key) {
+  const stamp = key.split("_")[0];
+  return /^\d+$/.test(stamp) && /000$/.test(stamp);
+}
+function resolveMigrationFile(directory, baseName, direction, dialect) {
+  const dialectExt = dialect === "sql" ? "mysql" : dialect;
+  const dialectFile = import_path.default.join(directory, `${baseName}.${dialectExt}.${direction}.sql`);
+  if (import_fs.default.existsSync(dialectFile)) return dialectFile;
+  const genericFile = import_path.default.join(directory, `${baseName}.${direction}.sql`);
+  if (import_fs.default.existsSync(genericFile)) return genericFile;
+  return null;
+}
+function loadMigrationManifest(directory, dialect) {
+  const manifest = /* @__PURE__ */ new Map();
+  if (!import_fs.default.existsSync(directory)) return manifest;
+  const files = import_fs.default.readdirSync(directory, { withFileTypes: true }).filter((f) => f.isFile()).map((f) => f.name).filter(isMigrationFile);
+  const uniqueKeys = /* @__PURE__ */ new Set();
+  files.forEach((file) => uniqueKeys.add(canonicalMigrationKey(file)));
+  uniqueKeys.forEach((key) => {
+    manifest.set(key, {
+      key,
+      upFile: resolveMigrationFile(directory, key, "up", dialect),
+      downFile: resolveMigrationFile(directory, key, "down", dialect)
+    });
+  });
+  return manifest;
+}
+
+// framework/MigrationConfig.ts
+function validateLegacyMigrationKeys(value) {
+  if (value === void 0) {
+    return;
+  }
+  if (!Array.isArray(value) || value.some((key) => !isExactCanonicalMigrationKey(key))) {
+    throw new ConfigurationError(
+      "legacy_migration_keys must be an array of nonempty exact canonical migration keys; filenames, paths, wildcards, and nonstrings are not allowed"
+    );
+  }
+}
+function isExactCanonicalMigrationKey(value) {
+  if (typeof value !== "string" || value.length === 0 || value !== value.trim()) {
+    return false;
+  }
+  if (value.includes("/") || value.includes("\\") || ["*", "?", "[", "]", "{", "}"].some((token) => value.includes(token))) {
+    return false;
+  }
+  return !isMigrationFile(value) && canonicalMigrationKey(value) === value;
+}
+
+// framework/MigrationDirectoryReader.ts
+var import_fs2 = __toESM(require("fs"));
+
 // framework/MigrationNode.ts
 var MigrationNode = class {
   constructor(name) {
@@ -416,40 +488,6 @@ var SqlMigrationBuilder = class {
   }
 };
 
-// framework/MigrationManifest.ts
-var import_fs = __toESM(require("fs"));
-var import_path = __toESM(require("path"));
-var MIGRATION_FILE_REGEX = /(?:\.(mysql|sqlite|pg))?\.(up|down)\.(sql|js)$/i;
-function isMigrationFile(fileName) {
-  return MIGRATION_FILE_REGEX.test(fileName);
-}
-function canonicalMigrationKey(value) {
-  return value.replace(MIGRATION_FILE_REGEX, "").toLowerCase();
-}
-function resolveMigrationFile(directory, baseName, direction, dialect) {
-  const dialectExt = dialect === "sql" ? "mysql" : dialect;
-  const dialectFile = import_path.default.join(directory, `${baseName}.${dialectExt}.${direction}.sql`);
-  if (import_fs.default.existsSync(dialectFile)) return dialectFile;
-  const genericFile = import_path.default.join(directory, `${baseName}.${direction}.sql`);
-  if (import_fs.default.existsSync(genericFile)) return genericFile;
-  return null;
-}
-function loadMigrationManifest(directory, dialect) {
-  const manifest = /* @__PURE__ */ new Map();
-  if (!import_fs.default.existsSync(directory)) return manifest;
-  const files = import_fs.default.readdirSync(directory, { withFileTypes: true }).filter((f) => f.isFile()).map((f) => f.name).filter(isMigrationFile);
-  const uniqueKeys = /* @__PURE__ */ new Set();
-  files.forEach((file) => uniqueKeys.add(canonicalMigrationKey(file)));
-  uniqueKeys.forEach((key) => {
-    manifest.set(key, {
-      key,
-      upFile: resolveMigrationFile(directory, key, "up", dialect),
-      downFile: resolveMigrationFile(directory, key, "down", dialect)
-    });
-  });
-  return manifest;
-}
-
 // framework/MigrationDirectoryReader.ts
 var MigrationDirectoryReader = class {
   constructor(directory, read_strategy, sqlrunner, dialect = "sql") {
@@ -1337,7 +1375,7 @@ var PatchCreator = class _PatchCreator {
     if (!import_fs5.default.existsSync(this.patchFolder)) {
       import_fs5.default.mkdirSync(this.patchFolder, { recursive: true });
     }
-    let stamp = Date.now();
+    let stamp = mintMigrationStamp();
     for (let attempt = 0; attempt < 1e3; attempt++) {
       const filePath = import_path4.default.join(this.patchFolder, `${stamp}_${normalized}.yaml`);
       try {
@@ -1345,7 +1383,7 @@ var PatchCreator = class _PatchCreator {
         return filePath;
       } catch (error) {
         if (error && error.code === "EEXIST") {
-          stamp += 1;
+          stamp = mintMigrationStamp(stamp + 1);
           continue;
         }
         throw error;
@@ -1834,6 +1872,7 @@ var MySQLMigrationRunner = class {
      */
     this.preflightPromise = null;
     this.lastPatchResults = [];
+    validateLegacyMigrationKeys(config.legacy_migration_keys);
   }
   setup() {
     return __async(this, null, function* () {
@@ -1939,7 +1978,17 @@ var MySQLMigrationRunner = class {
   }
   migrate(migrationNodes, forward) {
     return __async(this, null, function* () {
+      var _a;
       yield this.setup();
+      if (forward) {
+        const legacyMigrationKeys = new Set((_a = this.config.legacy_migration_keys) != null ? _a : []);
+        for (const node of migrationNodes) {
+          const key = node.get_key();
+          if (isHandStampedKey(key) && !legacyMigrationKeys.has(key) && !(yield node.status()).completed) {
+            throw new MigrationStampError(key);
+          }
+        }
+      }
       for (let node of migrationNodes) {
         try {
           if (forward) {
@@ -2035,6 +2084,7 @@ var FileMigrationConfigReader = class {
     try {
       const fileContent = import_fs6.default.readFileSync(this.configFile);
       const config = JSON.parse(fileContent.toString());
+      validateLegacyMigrationKeys(config.legacy_migration_keys);
       if (!config.migration_folder) {
         throw ConfigurationError.missingRequiredProperty("migration_folder");
       }
@@ -2077,7 +2127,7 @@ var MigrationCreator = class {
       if (!import_fs6.default.existsSync(this.config.migration_folder)) {
         import_fs6.default.mkdirSync(this.config.migration_folder, { recursive: true });
       }
-      const now_timestamp = Date.now();
+      const now_timestamp = mintMigrationStamp();
       const filename_up = `${now_timestamp}_${name}.up.sql`;
       const filename_down = `${now_timestamp}_${name}.down.sql`;
       import_fs6.default.writeFileSync(`${this.config.migration_folder}/${filename_up}`, `