@alexify/migronaut 2.2.0 → 2.4.0

package/migronaut.schema.json

@@ -182,6 +182,43 @@
       "minimum": 1,
       "default": 600000,
       "description": "How long waitForSearchIndexes waits, in milliseconds, before the converge fails (the build goes on)"
+    },
+    "backgroundCollection": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^(?!system\\.)[^$\\u0000]+$",
+      "default": "_migronaut_background",
+      "description": "Where background migrations keep their state — and, named after it, their partitions (<name>_partitions) and drift-watch resume tokens (<name>_watch). Experimental"
+    },
+    "backgroundInline": {
+      "type": "boolean",
+      "default": false,
+      "description": "Run a background migration to the end inside the up that registers it, under the migration lock (small collections, tests). Experimental"
+    },
+    "backgroundOnDrift": {
+      "enum": [
+        "reopen",
+        "report"
+      ],
+      "default": "reopen",
+      "description": "What the drift watch does with old-shape documents after a background migration completed: reopen it, or only report. Experimental"
+    },
+    "backgroundDrift": {
+      "enum": [
+        "poll",
+        "stream",
+        "both"
+      ],
+      "default": "poll",
+      "description": "How drift is watched: a periodic check (poll), change streams (stream, with the poll as a backstop), or both in full. Experimental"
+    },
+    "backgroundShardAware": {
+      "enum": [
+        "auto",
+        "off"
+      ],
+      "default": "auto",
+      "description": "Partition a sharded collection by its shard key and target each write at one shard (auto), or treat it like any other (off). Experimental"
     }
   },
   "definitions": {
@@ -206,6 +243,11 @@
           "required": [
             "searchIndexes"
           ]
+        },
+        {
+          "required": [
+            "versioning"
+          ]
         }
       ],
       "properties": {
@@ -246,7 +288,7 @@
             "strict",
             "moderate"
           ],
-          "description": "How the validator applies to updates. Defaults to 'strict'"
+          "description": "How the validator applies to updates. Defaults to 'strict' — 'moderate' when the only rules are the ones versioning adds"
         },
         "validationAction": {
           "enum": [
@@ -259,6 +301,56 @@
         "prune": {
           "type": "boolean",
           "description": "Drop indexes (and search indexes, when declared) this definition does not declare — otherwise they are kept and reported"
+        },
+        "versioning": {
+          "$ref": "#/definitions/versioning"
+        }
+      }
+    },
+    "versioning": {
+      "type": "object",
+      "required": [
+        "current"
+      ],
+      "additionalProperties": false,
+      "description": "Document shape versioning: a validator rule and an index for the version field (and the revision field, for optimistic concurrency). Experimental",
+      "properties": {
+        "current": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The shape version new documents are written at"
+        },
+        "min": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 1,
+          "description": "The oldest shape version still allowed — 0 types the fields without requiring them. Converge refuses to raise it while documents below it remain"
+        },
+        "field": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "pattern": "^(?!\\$)(?!_id$)[^.\\u0000]+$",
+          "default": "__v",
+          "description": "The version field"
+        },
+        "revision": {
+          "type": "boolean",
+          "default": true,
+          "description": "Also manage a revision field for optimistic concurrency"
+        },
+        "revisionField": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "pattern": "^(?!\\$)(?!_id$)[^.\\u0000]+$",
+          "default": "__rev",
+          "description": "The revision field"
+        },
+        "index": {
+          "type": "boolean",
+          "default": true,
+          "description": "Declare the { <field>: 1, _id: 1 } index background migrations scan"
         }
       }
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alexify/migronaut",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "description": "Elegant, fast, fully-typed, zero-dependency MongoDB migrations for Node.js — adopts an existing migrate-mongo changelog in one command",
   "license": "MIT",
   "author": "Alex Dolid <dolid.sasha@gmail.com>",
@@ -28,6 +28,10 @@
     "./bullmq": {
       "types": "./bullmq.d.ts",
       "default": "./bullmq.js"
+    },
+    "./versioning": {
+      "types": "./versioning.d.ts",
+      "default": "./versioning.js"
     }
   },
   "directories": {
@@ -38,6 +42,8 @@
     "index.d.ts",
     "bullmq.js",
     "bullmq.d.ts",
+    "versioning.js",
+    "versioning.d.ts",
     "migronaut.schema.json",
     "bin",
     "src",
@@ -96,6 +102,7 @@
     "c8": "^10.1.3",
     "esbuild": "^0.28.1",
     "ioredis": "^5.11.1",
+    "mermaid": "^11.17.2",
     "mongodb": "^6.12.0",
     "mongodb-memory-server": "10.4.3",
     "mongoose": "^8.9.2",
@@ -112,7 +119,7 @@
     "test:integration": "node scripts/node-test.js --test-concurrency=1 \"tests/integration/**/*.test.js\"",
     "test:coverage": "c8 --all --include 'src/**' --check-coverage --lines 90 --branches 90 --functions 90 --reporter text --reporter lcov node scripts/node-test.js --test-concurrency=1 \"tests/unit/**/*.test.js\" \"tests/integration/**/*.test.js\"",
     "test:types": "tsd",
-    "check:dts": "tsc --noEmit --strict --skipLibCheck false index.d.ts bullmq.d.ts",
+    "check:dts": "tsc --noEmit --strict --skipLibCheck false index.d.ts bullmq.d.ts versioning.d.ts",
     "lint": "oxlint src bin scripts tests bench examples",
     "format": "oxfmt src bin scripts tests bench examples",
     "format:check": "oxfmt --check src bin scripts tests bench examples",