@researchdatabox/redbox-dev-tools 0.0.1-beta.9700 → 0.0.1-beta.9909

package/dist/cli.js

@@ -383,6 +383,32 @@ generate
         process.exit(1);
     }
 });
+generate
+    .command('migration <description>')
+    .description('Generate an app-local data migration in api/migrations/ (runs at lift, before coreBootstrap)')
+    .action(async (description) => {
+    try {
+        const globalOptions = program.opts();
+        const paths = (0, paths_1.resolvePaths)(globalOptions);
+        const { MigrationGenerator } = require('./generators/migration');
+        const generator = new MigrationGenerator({
+            description,
+            dryRun: globalOptions.dryRun,
+            root: paths.root,
+        });
+        console.log(`\n🛠️  Generating data migration: ${description}...\n`);
+        await generator.generate();
+        console.log(`\n✅ Done! Created migration '${generator.migrationName}'.\n`);
+        console.log('Next steps:');
+        console.log(`  1. Implement up() in ${path.relative(paths.root, generator.migrationPath)} (remove the placeholder throw)`);
+        console.log('  2. Make sure up() is idempotent - it can run more than once');
+        console.log('  3. Test by lifting the app, then verify the Migration table contains the new name\n');
+    }
+    catch (error) {
+        console.error(`\n❌ Error: ${error.message}\n`);
+        process.exit(1);
+    }
+});
 generate
     .command('form-field <name>')
     .description('Generate a new form field DSL configuration')

package/dist/completion/index.js

@@ -4,7 +4,7 @@ exports.generateCompletionScript = generateCompletionScript;
 function getCompletionSpec() {
     const globalOptions = ['--root', '--core-types-root', '--angular-root', '--dry-run', '-h', '--help', '-V', '--version'];
     const topLevelCommands = ['init', 'check', 'migrate-hook-dependencies', 'generate', 'g', 'install-skills', 'skills', 'migrate-form-config', 'completion', 'help'];
-    const generateCommands = ['controller', 'service', 'method', 'angular-app', 'angular-service', 'form-component', 'form-field', 'model'];
+    const generateCommands = ['controller', 'service', 'method', 'angular-app', 'angular-service', 'form-component', 'form-field', 'migration', 'model'];
     const commandOptions = {
         'migrate-form-config': ['-i', '--input', '-o', '--output'],
         'check': [],
@@ -20,6 +20,7 @@ function getCompletionSpec() {
         'generate angular-service': ['--app', '--methods'],
         'generate form-component': ['--app', '--with-service'],
         'generate form-field': ['--type'],
+        'generate migration': [],
         'generate model': ['--identity', '--attrs', '--belongs-to', '--has-many']
     };
     const fileValueOptions = ['--root', '--core-types-root', '--angular-root', '--input', '--output', '--file'];
@@ -154,7 +155,7 @@ Register-ArgumentCompleter -Native -CommandName redbox-dev-tools -ScriptBlock {
   $tokens = $commandAst.CommandElements | ForEach-Object { $_.Extent.Text }
   $global = @('--root','--core-types-root','--angular-root','--dry-run','-h','--help','-V','--version')
   $top = @('init','check','migrate-hook-dependencies','generate','g','install-skills','skills','migrate-form-config','completion','help')
-  $generateSub = @('controller','service','method','angular-app','angular-service','form-component','form-field','model')
+  $generateSub = @('controller','service','method','angular-app','angular-service','form-component','form-field','migration','model')
 
   if ($tokens.Count -le 2) {
     @($top + $global) | Where-Object { $_ -like "$wordToComplete*" } | ForEach-Object {

package/dist/generators/migration.d.ts

@@ -0,0 +1,15 @@
+import { Generator, GeneratorOptions } from '../utils/generator';
+export interface MigrationGeneratorOptions extends GeneratorOptions {
+    description: string;
+    /** Override the clock, used by tests for deterministic file names. */
+    now?: Date;
+}
+export declare class MigrationGenerator extends Generator {
+    private description;
+    private now;
+    migrationName: string;
+    migrationPath: string;
+    constructor(options: MigrationGeneratorOptions);
+    generate(): Promise<void>;
+    private generateMigrationContent;
+}

package/dist/generators/migration.js

@@ -0,0 +1,100 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MigrationGenerator = void 0;
+const path = __importStar(require("path"));
+const generator_1 = require("../utils/generator");
+function slugify(description) {
+    return description
+        .trim()
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, '-')
+        .replace(/^-+|-+$/g, '');
+}
+function formatTimestamp(now) {
+    const pad = (value) => String(value).padStart(2, '0');
+    return (`${now.getUTCFullYear()}${pad(now.getUTCMonth() + 1)}${pad(now.getUTCDate())}` +
+        `T${pad(now.getUTCHours())}${pad(now.getUTCMinutes())}${pad(now.getUTCSeconds())}`);
+}
+class MigrationGenerator extends generator_1.Generator {
+    description;
+    now;
+    migrationName = '';
+    migrationPath = '';
+    constructor(options) {
+        super(options);
+        this.description = options.description;
+        this.now = options.now ?? new Date();
+    }
+    async generate() {
+        const slug = slugify(this.description);
+        if (!slug) {
+            throw new Error(`Cannot derive a migration name from description "${this.description}". Use letters, numbers, and hyphens.`);
+        }
+        this.migrationName = `${formatTimestamp(this.now)}-${slug}`;
+        this.migrationPath = path.join(this.root, 'api', 'migrations', `${this.migrationName}.js`);
+        this.writeFile(this.migrationPath, this.generateMigrationContent(slug));
+    }
+    generateMigrationContent(slug) {
+        return `'use strict';
+
+/**
+ * Data migration: ${slug}
+ *
+ * Runs once during application lift, before coreBootstrap().
+ * Migrations MUST be idempotent: if the process crashes after up() completes
+ * but before the run is logged, the migration runs again on the next lift.
+ * See the Data Migrations wiki page for the full contract.
+ */
+module.exports = {
+  name: '${this.migrationName}',
+
+  up: async ({ context: sails } = {}) => {
+    // TODO: implement the forward data transformation.
+    // Example:
+    // await sails.models.appconfig.update({ key: 'oldKey' }, { key: 'newKey' });
+    throw new Error('Migration ${this.migrationName} is not implemented yet');
+  },
+
+  // Optional manual rollback - only ever invoked by operator-driven Umzug
+  // usage, never by a normal lift. Omit it entirely if a safe reverse is
+  // not possible.
+  // down: async ({ context: sails } = {}) => {
+  // },
+};
+`;
+    }
+}
+exports.MigrationGenerator = MigrationGenerator;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@researchdatabox/redbox-dev-tools",
-  "version": "0.0.1-beta.9700",
+  "version": "0.0.1-beta.9909",
   "description": "ReDBox customisation dev tools - shared configuration, generators, and migration tooling",
   "type": "commonjs",
   "main": "index.js",
@@ -44,28 +44,28 @@
   },
   "homepage": "https://github.com/redbox-mint/redbox-portal/tree/v4.5.1#readme",
   "dependencies": {
-    "@researchdatabox/redbox-core": "0.0.1-beta.9700",
-    "@researchdatabox/sails-ng-common": "0.0.1-beta.9700",
-    "@tsconfig/node24": "24.0.1",
+    "@researchdatabox/redbox-core": "0.0.1-beta.9909",
+    "@researchdatabox/sails-ng-common": "0.0.1-beta.9909",
+    "@tsconfig/node24": "24.0.4",
     "@types/chai": "5.2.3",
     "@types/lodash": "4.17.24",
     "@types/mocha": "10.0.10",
-    "@types/node": "24.10.0",
-    "axios": "1.15.2",
+    "@types/node": "24.12.4",
+    "axios": "1.16.1",
     "chai": "6.2.2",
-    "commander": "14.0.3",
+    "commander": "15.0.0",
     "handlebars": "4.7.9",
-    "lodash": "4.18.0",
-    "mocha": "11.7.4",
-    "rxjs": "7.8.1",
+    "lodash": "4.18.1",
+    "mocha": "11.7.6",
+    "rxjs": "7.8.2",
     "ts-node": "10.9.2",
     "ts-morph": "28.0.0",
-    "typescript": "5.8.3",
-    "zod": "3.25.28"
+    "typescript": "5.9.3",
+    "zod": "3.25.76"
   },
   "devDependencies": {
     "@types/sinon": "21.0.1",
-    "sinon": "21.1.2"
+    "sinon": "22.0.0"
   },
   "peerDependenciesMeta": {
     "@researchdatabox/redbox-core": {
@@ -73,7 +73,7 @@
     }
   },
   "overrides": {
-    "diff": "8.0.3",
+    "diff": "8.0.4",
     "mocha": {
       "serialize-javascript": "7.0.5"
     }