@flarum/cli 2.0.0-beta.8 → 3.0.0

package/lib/steps/stubs/frontend/notification.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateNotificationStub = void 0;
+const tslib_1 = require("tslib");
+const validation_1 = require("../../../utils/validation");
+const js_base_1 = require("../js-base");
+const string_1 = tslib_1.__importDefault(require("string"));
+class GenerateNotificationStub extends js_base_1.BaseJsStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate a Notification';
+        this.additionalExposes = ['frontend', 'classNamespace', 'type'];
+        this.schema = {
+            recommendedSubdir: 'forum/components',
+            sourceFile: 'frontend/notification.js',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Notification class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+                {
+                    name: 'type',
+                    message: 'Notification type',
+                    type: 'text',
+                    initial: (_prev, params) => {
+                        return (0, string_1.default)(params.get('className'))
+                            .underscore()
+                            .toString()
+                            .replace(/_notification$/, '');
+                    },
+                },
+            ],
+        };
+    }
+    async precompileParams(fs, paths, io) {
+        const params = await super.precompileParams(fs, paths, io);
+        params.frontend = 'forum';
+        return params;
+    }
+}
+exports.GenerateNotificationStub = GenerateNotificationStub;

package/lib/steps/stubs/frontend/post-type.d.ts

@@ -0,0 +1,11 @@
+import { BaseJsStubStep } from '../js-base';
+import { StubGenerationSchema } from 'boilersmith/steps/stub-base';
+import { Store } from 'mem-fs';
+import { IO } from 'boilersmith/io';
+import { Paths } from 'boilersmith/paths';
+export declare class GeneratePostTypeStub extends BaseJsStubStep {
+    type: string;
+    protected additionalExposes: string[];
+    protected schema: StubGenerationSchema;
+    protected precompileParams(fs: Store, paths: Paths, io: IO): Promise<Record<string, unknown>>;
+}

package/lib/steps/stubs/frontend/post-type.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneratePostTypeStub = void 0;
+const tslib_1 = require("tslib");
+const validation_1 = require("../../../utils/validation");
+const js_base_1 = require("../js-base");
+const string_1 = tslib_1.__importDefault(require("string"));
+class GeneratePostTypeStub extends js_base_1.BaseJsStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate a new post type component';
+        this.additionalExposes = ['frontend', 'classNamespace', 'postType'];
+        this.schema = {
+            recommendedSubdir: 'forum/components',
+            sourceFile: 'frontend/post-type.js',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Post Type class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+                {
+                    name: 'postType',
+                    message: 'Notification type',
+                    type: 'text',
+                    initial: (_prev, params) => {
+                        return (0, string_1.default)(params.get('className'))
+                            .underscore()
+                            .toString()
+                            .replace(/_post$/, '');
+                    },
+                },
+            ],
+        };
+    }
+    async precompileParams(fs, paths, io) {
+        const params = await super.precompileParams(fs, paths, io);
+        params.frontend = 'forum';
+        return params;
+    }
+}
+exports.GeneratePostTypeStub = GeneratePostTypeStub;

package/lib/steps/stubs/js-base.js

@@ -16,16 +16,23 @@ class BaseJsStubStep extends flarum_base_1.FlarumBaseStubStep {
     }
     async precompileParams(fs, paths, io) {
         const params = await super.precompileParams(fs, paths, io);
-        const paramDefs = this.schema.params.filter(param => !this.implicitParams.includes(param.name));
-        this.subdir = this.schema.forceRecommendedSubdir || paths.requestedDir() === null ? this.schema.recommendedSubdir : paths.requestedDir().slice(`${paths.package('js/src')}/`.length);
-        params.frontend = await io.getParam(paramDefs.find(param => param.name === 'frontend'));
-        params.className = await io.getParam(paramDefs.find(param => param.name === 'className'));
+        io.pushCache(params);
+        const paramDefs = this.schema.params.filter((param) => !this.implicitParams.includes(param.name));
+        this.subdir =
+            this.schema.forceRecommendedSubdir || paths.requestedDir() === null
+                ? this.schema.recommendedSubdir
+                : paths.requestedDir().slice(`${paths.package('js/src')}/`.length);
+        const frontendParamDef = paramDefs.find((param) => param.name === 'frontend');
+        if (frontendParamDef) {
+            params.frontend = await io.getParam(frontendParamDef);
+        }
+        params.className = await io.getParam(paramDefs.find((param) => param.name === 'className'));
         this.subdir = (0, clone_and_fill_1.cloneAndFill)(this.subdir, params);
         params.classNamespace = `${this.subdir}/${params.className}`;
         return params;
     }
     async getFileName(_fs, _paths, io) {
-        return await io.getParam({ name: 'className', type: 'text' }) + '.js';
+        return (await io.getParam({ name: 'className', message: 'File name', type: 'text' })) + '.js';
     }
 }
 exports.BaseJsStubStep = BaseJsStubStep;

package/lib/steps/stubs/php-base.js

@@ -15,35 +15,39 @@ class BasePhpStubStep extends flarum_base_1.FlarumBaseStubStep {
         return [...super.implicitParams, 'classNamespace'];
     }
     async precompileParams(fs, paths, io) {
-        const params = Object.assign(Object.assign({}, await super.precompileParams(fs, paths, io)), { classNamespace: this.stubNamespace(await this.scaffolder.templateParamVal('packageNamespace', fs, paths, io), paths) });
-        let paramDefs = this.schema.params.filter(param => !this.implicitParams.includes(param.name));
+        var _a;
+        const params = Object.assign(Object.assign({}, (await super.precompileParams(fs, paths, io))), { classNamespace: this.stubNamespace(await this.scaffolder.templateParamVal('packageNamespace', fs, paths, io), paths) });
+        io.pushCache(params);
+        let paramDefs = this.schema.params.filter((param) => !this.implicitParams.includes(param.name));
         const classParams = [...this.phpClassParams];
-        const classNameParam = paramDefs.find(param => param.name === 'className');
+        const classNameParam = paramDefs.find((param) => param.name === 'className');
         if (classNameParam) {
             params.className = await io.getParam(classNameParam);
             params.class = `${params.classNamespace}\\${params.className}`;
-            paramDefs = paramDefs.filter(param => param.name !== 'class' && param.name !== 'className');
+            paramDefs = paramDefs.filter((param) => param.name !== 'class' && param.name !== 'className');
         }
         else {
             classParams.push('class');
         }
         for (const classParam of classParams) {
-            const paramDef = this.schema.params.find(param => param.name === classParam);
+            const paramDef = this.schema.params.find((param) => param.name === classParam);
             if (!paramDef) {
                 continue;
             }
             // eslint-disable-next-line no-await-in-loop
             params[classParam] = await io.getParam(paramDef);
-            params[`${classParam}Name`] = params[classParam].split('\\').pop();
-            paramDefs = paramDefs.filter(param => param.name !== classParam && param.name !== `${classParam}Name`);
+            params[`${classParam}Name`] = (_a = params[classParam]) === null || _a === void 0 ? void 0 : _a.split('\\').pop();
+            paramDefs = paramDefs.filter((param) => param.name !== classParam && param.name !== `${classParam}Name`);
         }
         return params;
     }
     async getFileName(_fs, _paths, io) {
-        return await io.getParam({ name: 'className', type: 'text' }) + '.php';
+        return (await io.getParam({ name: 'className', message: 'Class Name', type: 'text' })) + '.php';
     }
     stubNamespace(packageNamespace, paths) {
-        const subdir = this.schema.forceRecommendedSubdir || paths.requestedDir() === null ? this.schema.recommendedSubdir.replace('\\', '.').replace('/', '.') : paths.requestedDir().slice(`${paths.package((this.schema.root || this.defaultRoot).replace('./', ''))}/`.length);
+        const subdir = this.schema.forceRecommendedSubdir || paths.requestedDir() === null
+            ? this.schema.recommendedSubdir.replace('\\', '.').replace('/', '.')
+            : paths.requestedDir().slice(`${paths.package((this.schema.root || this.defaultRoot).replace('./', ''))}/`.length);
         this.subdir = subdir.replace('.', '/');
         let namespace = packageNamespace;
         if (this.schema.root === './tests') {

package/lib/steps/update/js-imports.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpdateJSImports = void 0;
 const tslib_1 = require("tslib");
-const globby_1 = (0, tslib_1.__importDefault)(require("globby"));
+const globby_1 = tslib_1.__importDefault(require("globby"));
 const mem_fs_editor_1 = require("mem-fs-editor");
 const CORE_JS_NAMESPACES = ['admin', 'common', 'forum'];
 const CORE_NAMESPACE_REGEX = new RegExp(`^(${CORE_JS_NAMESPACES.join('|')})/`);
@@ -18,7 +18,10 @@ class UpdateJSImports {
         const importMap = {};
         const jsSrcDir = paths.package('vendor/flarum/core/js/src');
         const vendorRegex = new RegExp(`${jsSrcDir}/.*(js|jsx|ts|tsx)`);
-        const fsVendorFilePaths = fs.all().map(file => file.path).filter(path => path && vendorRegex.test(path));
+        const fsVendorFilePaths = fs
+            .all()
+            .map((file) => file.path)
+            .filter((path) => path && vendorRegex.test(path));
         const persistedVendorFilePaths = globby_1.default.sync(`${jsSrcDir}/**/*.{js,jsx,ts,tsx}`);
         for (const currPath of [...fsVendorFilePaths, ...persistedVendorFilePaths]) {
             const withNamespace = currPath.slice(jsSrcDir.length + 1).replace(/\.(js|jsx|ts|tsx)$/, '');
@@ -26,7 +29,10 @@ class UpdateJSImports {
             importMap[`flarum/${noNamespace}`] = `flarum/${withNamespace}`;
         }
         const srcRegex = new RegExp(`${paths.package('js/src')}/.*(js|jsx|ts|tsx)`);
-        const fsSrcFilePaths = fs.all().map(file => file.path).filter(path => path && srcRegex.test(path));
+        const fsSrcFilePaths = fs
+            .all()
+            .map((file) => file.path)
+            .filter((path) => path && srcRegex.test(path));
         const persistedSrcFilePaths = globby_1.default.sync(paths.package('js/src/**/*.{js,jsx,ts,tsx}'));
         for (const match of [...fsSrcFilePaths, ...persistedSrcFilePaths]) {
             let fileCounted = false;

package/lib/steps/upgrade/twopointoh/backend/email-views.d.ts

@@ -0,0 +1,18 @@
+import { BaseUpgradeStep, GitCommit, Replacement } from '../base';
+export default class EmailViews extends BaseUpgradeStep {
+    type: string;
+    protected collected: {
+        [file: string]: {
+            html: string;
+            text: string;
+        };
+    };
+    protected templates: {
+        html: string;
+        text: string;
+    };
+    replacements(file: string): Replacement[];
+    targets(): string[];
+    gitCommit(): GitCommit;
+    pauseMessage(): string;
+}

package/lib/steps/upgrade/twopointoh/backend/email-views.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const ejs_1 = tslib_1.__importDefault(require("ejs"));
+const base_1 = require("../base");
+class EmailViews extends base_1.BaseUpgradeStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Email notifications now require both Plain Text and HTML views.';
+        this.collected = {};
+        this.templates = {
+            html: '/../../../../../boilerplate/stubs/views/email/html/notification.blade.php',
+            text: '/../../../../../boilerplate/stubs/views/email/plain/notification.blade.php',
+        };
+    }
+    replacements(file) {
+        if (!file.endsWith('.php'))
+            return [];
+        return [
+            async (file, code) => {
+                if (!code.includes('MailableInterface')) {
+                    return null;
+                }
+                const output = this.php.run('upgrade.2-0.email-views', { file, code });
+                this.collected[file] = output.collected;
+                return {
+                    updated: output.code,
+                };
+            },
+            async (file, code) => {
+                if (Object.keys(this.collected).length === 0)
+                    return null;
+                const fileName = file.split('/').pop();
+                const newFiles = [];
+                Object.keys(this.collected).forEach((classFile) => {
+                    if (!this.collected[classFile]) {
+                        return;
+                    }
+                    if (!this.collected[classFile].html && !this.collected[classFile].text) {
+                        return;
+                    }
+                    // if there is a text view but no html view, use the same content for both.
+                    // same for html view but no text view.
+                    ['text', 'html'].forEach((view) => {
+                        const viewType = view;
+                        const viewPath = this.collected[classFile][viewType] || this.collected[classFile][viewType === 'html' ? 'text' : 'html'];
+                        const viewFileName = viewPath.split('::')[1].split('.').pop();
+                        if (fileName === `${viewFileName}.blade.php`) {
+                            const templateContent = this.fsEditor.read(__dirname + this.templates[viewType]);
+                            const viewTypePath = viewType === 'text' ? 'plain' : 'html';
+                            newFiles.push({
+                                path: file.split('/views/')[0] + '/views/email/' + viewTypePath + '/' + viewFileName + '.blade.php',
+                                code: ejs_1.default.render(templateContent, { content: code.trimEnd() }),
+                            });
+                        }
+                    });
+                });
+                return {
+                    updated: code,
+                    delete: newFiles.length > 0,
+                    newFiles,
+                };
+            },
+        ];
+    }
+    targets() {
+        return ['src/**/*', 'views/**/*.blade.php', 'resources/views/**/*.blade.php'];
+    }
+    gitCommit() {
+        return {
+            message: 'chore(2.0): notification emails now require both plain text and HTML views',
+            description: 'You now need to provide both plain text and HTML views for notification emails.',
+        };
+    }
+    pauseMessage() {
+        return `Flarum 2.0 requires both plain text and HTML views for notification emails.
+                     The upgrader has attempted to convert your email views to include both.
+                     Please review the changes and ensure that both views are present. Then proceed.`;
+    }
+}
+exports.default = EmailViews;

package/lib/steps/upgrade/twopointoh/backend/filesystem.d.ts

@@ -0,0 +1,8 @@
+import { BaseUpgradeStep, GitCommit, Replacement } from '../base';
+export default class Filesystem extends BaseUpgradeStep {
+    type: string;
+    replacements(file: string): Replacement[];
+    targets(): string[];
+    gitCommit(): GitCommit;
+    pauseMessage(): string;
+}

package/lib/steps/upgrade/twopointoh/backend/filesystem.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const base_1 = require("../base");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+class Filesystem extends base_1.BaseUpgradeStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Filesystem dependencies changes.';
+    }
+    replacements(file) {
+        if (!file.endsWith('.php'))
+            return [];
+        return [
+            (file, code) => ({
+                updated: this.php.run('upgrade.2-0.filesystem', { file, code }).code,
+            }),
+        ];
+    }
+    targets() {
+        return ['extend.php', 'src/**/*'];
+    }
+    gitCommit() {
+        return {
+            message: 'chore(2.0): filesystem changes',
+            description: 'Flysystem 3.x changes',
+        };
+    }
+    pauseMessage() {
+        const link = 'https://docs.flarum.org/2.x/extend/update-2_0#flysystem-updated-from-1x-to-3x';
+        const readMore = chalk_1.default.dim(`Read more: ${link}`);
+        const otherLink = 'https://flysystem.thephpleague.com/docs/upgrade-from-1.x/';
+        const otherReadMore = chalk_1.default.dim(`For more details, read the Flysystem 1.x to V2 & V3 upgrade guide: ${otherLink}`);
+        return `Flarum 2.0 uses Flysystem 3.x. The tool has attempted to update your code accordingly.
+                     Some filesystem methods have been renamed or removed. Please review the changes and ensure everything is correct.
+                     ${readMore}
+                     ${otherReadMore}`;
+    }
+}
+exports.default = Filesystem;

package/lib/steps/upgrade/twopointoh/backend/intervention-image.d.ts

@@ -0,0 +1,8 @@
+import { BaseUpgradeStep, GitCommit, Replacement } from '../base';
+export default class InterventionImage extends BaseUpgradeStep {
+    type: string;
+    replacements(file: string): Replacement[];
+    targets(): string[];
+    gitCommit(): GitCommit;
+    pauseMessage(): string;
+}

package/lib/steps/upgrade/twopointoh/backend/intervention-image.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const base_1 = require("../base");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+class InterventionImage extends base_1.BaseUpgradeStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Intervention Image Library v3';
+    }
+    replacements(file) {
+        if (!file.endsWith('.php'))
+            return [];
+        return [
+            (file, code) => ({
+                updated: this.php.run('upgrade.2-0.intervention-image', { file, code }).code,
+            }),
+        ];
+    }
+    targets() {
+        return ['src/**/*'];
+    }
+    gitCommit() {
+        return {
+            message: 'chore(2.0): `intervention/image` v3 changes',
+            description: 'Intervention Image Library v3 changes',
+        };
+    }
+    pauseMessage() {
+        const link = 'https://docs.flarum.org/2.x/extend/update-2_0#intervention-image-v3';
+        const readMore = chalk_1.default.dim(`Read more: ${link}`);
+        const otherLink = 'https://image.intervention.io/v3/introduction/upgrade';
+        const otherReadMore = chalk_1.default.dim(`For more details, read the library's v3 upgrade guide: ${otherLink}`);
+        const additionalLink = 'https://github.com/flarum/framework/pull/3947/files';
+        const additionalReadMore = chalk_1.default.dim(`Additionally, you can see the changes made to the core code here: ${additionalLink}`);
+        return `Flarum 2.0 uses intervention/image v3. The tool cannot automatically update your code to the new version.
+                     Comments have been added where changes are needed. You should make these changes now, then test and adapt your code once the upgrade process is over.
+                     ${readMore}
+                     ${otherReadMore}
+
+                     ${additionalReadMore}`;
+    }
+}
+exports.default = InterventionImage;

package/lib/steps/upgrade/twopointoh/backend/json-api.d.ts

@@ -0,0 +1,12 @@
+import { AdvancedContent, BaseUpgradeStep, GitCommit, Replacement } from '../base';
+export default class JsonApi extends BaseUpgradeStep {
+    type: string;
+    beforeHook: boolean;
+    protected modelEndpoints: Record<string, any>;
+    protected models: Record<string, any>;
+    before(file: string, code: string, _advanced: AdvancedContent): void;
+    replacements(file: string): Replacement[];
+    targets(): string[];
+    gitCommit(): GitCommit;
+    pauseMessage(): string;
+}

package/lib/steps/upgrade/twopointoh/backend/json-api.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const base_1 = require("../base");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const gen_ext_scaffolder_1 = require("../../../gen-ext-scaffolder");
+const api_resource_1 = require("../../../extenders/api-resource");
+const step_manager_1 = require("boilersmith/step-manager");
+const advanced_api_resource_1 = require("../../../stubs/backend/advanced-api-resource");
+class JsonApi extends base_1.BaseUpgradeStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Prepare for JSON:API changes.';
+        this.beforeHook = true;
+        this.modelEndpoints = {};
+        this.models = {};
+    }
+    before(file, code, _advanced) {
+        var _a, _b;
+        var _c;
+        // files with the patterns CreateXController, DeleteXController, ListXController, ShowXController, UpdateXController
+        const matches = file.match(/(Create|Delete|List|Show|Update)([A-Z][A-z]+)+Controller\.php/);
+        if (matches) {
+            let model = matches[2];
+            if (matches[1].startsWith('List')) {
+                model = model.endsWith('ies') ? model.slice(0, -3) + 'y' : model.endsWith('s') ? model.slice(0, -1) : model;
+            }
+            (_a = (_c = this.modelEndpoints)[model]) !== null && _a !== void 0 ? _a : (_c[model] = []);
+            this.modelEndpoints[model].push(matches[1].toLowerCase());
+            return;
+        }
+        if ((code.includes(' extends AbstractModel') && code.includes('use Flarum\\Database\\AbstractModel')) ||
+            (code.includes(' extends Model') && code.includes('use Illuminate\\Database\\Eloquent\\Model'))) {
+            const className = file.split('/').pop().replace('.php', '');
+            const namespace = (_b = code.match(/namespace ([^;]+);/)) === null || _b === void 0 ? void 0 : _b[1];
+            this.models[className] = `${namespace}\\${className}`;
+        }
+    }
+    replacements(file) {
+        if (!file.endsWith('.php'))
+            return [];
+        let collected = null;
+        return [
+            async (file, code) => {
+                const output = this.php.run('upgrade.2-0.json-api', { file, code });
+                collected = output.collected;
+                return {
+                    updated: output.code,
+                };
+            },
+            async (file) => {
+                var _a;
+                if (!collected)
+                    return null;
+                if (file.endsWith('extend.php'))
+                    return null;
+                if (Object.keys(collected).length > 0 && collected.serializer) {
+                    const modelClassName = collected.model ? collected.model.split('\\').pop() : collected.serializer.replace('Serializer', '');
+                    const predefinedParams = {
+                        className: `${modelClassName}Resource`,
+                        modelClass: collected.model || this.models[modelClassName],
+                        modelType: collected.type,
+                        endpoints: (_a = this.modelEndpoints[modelClassName]) !== null && _a !== void 0 ? _a : [],
+                        relations: collected.relations,
+                    };
+                    const result = await this.command.runSteps(new step_manager_1.StepManager().silentGroup((steps) => {
+                        steps
+                            .namedStep('api-resource-stub', new advanced_api_resource_1.GenerateAdvancedApiResourceStub(this.command.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()), {}, [], predefinedParams)
+                            .step(new api_resource_1.GenerateApiResourceExtender(), {}, [
+                            {
+                                sourceStep: 'api-resource-stub',
+                                exposedName: 'class',
+                                consumedName: 'resourceClass',
+                            },
+                        ]);
+                    }));
+                    if (!result.succeeded) {
+                        this.command.error(result.error);
+                    }
+                }
+                return null;
+            },
+        ];
+    }
+    targets() {
+        return ['src/**/*', 'extend.php'];
+    }
+    gitCommit() {
+        return {
+            message: 'chore(2.0): JSON:API changes',
+            description: 'Flarum 2.0 completely changes the JSON:API implementation',
+        };
+    }
+    pauseMessage() {
+        const link = 'https://docs.flarum.org/2.x/extend/update-2_0#jsonapi';
+        const readMore = chalk_1.default.dim(`Read more: ${link}`);
+        const guideLink = 'https://docs.flarum.org/2.x/extend/update-2_0-api';
+        const exampleReadMore = chalk_1.default.dim(`Checkout our additional guide which provides concrete examples for the upgrading process of the JSON:API layer:`);
+        return `Flarum 2.0 completely refactors the JSON:API implementation. The way resource CRUD operations,
+                     serialization and extending other resources is done has completely changed.
+
+                     The tool cannot completely automate this change, but it has added some boilerplate code and TODO comments to help you get started.
+                     You should make whatever changes you can now, then properly test and adapt your code once the upgrade process is over.
+
+                     ${readMore}
+
+                     ${exampleReadMore}
+                     ${guideLink}`;
+    }
+}
+exports.default = JsonApi;

package/lib/steps/upgrade/twopointoh/backend/mailer.d.ts

@@ -0,0 +1,8 @@
+import { BaseUpgradeStep, GitCommit, Replacement } from '../base';
+export default class Mailer extends BaseUpgradeStep {
+    type: string;
+    replacements(file: string): Replacement[];
+    targets(): string[];
+    gitCommit(): GitCommit;
+    pauseMessage(): string;
+}

package/lib/steps/upgrade/twopointoh/backend/mailer.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const base_1 = require("../base");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+class Mailer extends base_1.BaseUpgradeStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Check for Swift mailer usage.';
+    }
+    replacements(file) {
+        if (!file.endsWith('.php'))
+            return [];
+        return [
+            (_file, code) => ({
+                updated: code.replace(/^(.*Swift_Mailer.*)$/gm, `$1 // TODO: Swift mailer was replaced with Symfony mailer`),
+            }),
+        ];
+    }
+    targets() {
+        return ['extend.php', 'src/**/*'];
+    }
+    gitCommit() {
+        return {
+            message: 'chore(2.0): swift mailer was replaced with symfony mailer',
+            description: 'Swift mailer was replaced with Symfony mailer',
+        };
+    }
+    pauseMessage() {
+        const link = 'https://symfony.com/doc/current/mailer.html';
+        const readMore = chalk_1.default.dim(`Read more: ${link}`);
+        return `Flarum 2.0 uses Symfony mailer instead of Swift mailer. TODO comments have been added to your code to indicate where Swift mailer is currently being used.
+                     Update your code to use Symfony mailer instead. Then proceed. Or proceed now and update your code later.
+                     ${readMore}`;
+    }
+}
+exports.default = Mailer;

package/lib/steps/upgrade/twopointoh/backend/misc.d.ts

@@ -0,0 +1,8 @@
+import { BaseUpgradeStep, GitCommit, Replacement } from '../base';
+export default class MiscBackendChanges extends BaseUpgradeStep {
+    type: string;
+    replacements(file: string): Replacement[];
+    targets(): string[];
+    gitCommit(): GitCommit;
+    pauseMessage(): string;
+}

package/lib/steps/upgrade/twopointoh/backend/misc.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const base_1 = require("../base");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+class MiscBackendChanges extends base_1.BaseUpgradeStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Miscellaneous backend changes.';
+    }
+    replacements(file) {
+        if (!file.endsWith('.php'))
+            return [];
+        return [
+            (file, code) => ({
+                updated: this.php.run('upgrade.2-0.misc', { file, code }).code,
+            }),
+        ];
+    }
+    targets() {
+        return ['extend.php', 'src/**/*'];
+    }
+    gitCommit() {
+        return {
+            message: 'chore(2.0): misc backend changes',
+            description: 'Miscellaneous backend changes',
+        };
+    }
+    pauseMessage() {
+        const link = 'https://docs.flarum.org/2.x/extend/update-2_0#miscellaneous-1';
+        const readMore = chalk_1.default.dim(`Read more: ${link}`);
+        const requiresManualChangeLink = 'https://laravel.com/docs/11.x/upgrade#modifying-columns';
+        return `Various breaking backend changes have been made in 2.0. The tool has attempted to update your code accordingly.
+                     Please review the changes and ensure everything is correct.
+                     ${readMore}
+
+                     Additionally, check every reference to a column definition change in your migrations, and make sure
+                     they are using the entire column definition. For more details, see:
+                     ${chalk_1.default.underline(requiresManualChangeLink)}`;
+    }
+}
+exports.default = MiscBackendChanges;