@flarum/cli 2.0.0-beta.9 → 3.0.0

package/lib/steps/stubs/backend/{api-serializer.js → api-resource.js}

@@ -1,31 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GenerateApiSerializerStub = void 0;
+exports.GenerateApiResourceStub = void 0;
 const tslib_1 = require("tslib");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const validation_1 = require("../../../utils/validation");
 const model_name_1 = require("../../../utils/model-name");
 const php_base_1 = require("../php-base");
-class GenerateApiSerializerStub extends php_base_1.BasePhpStubStep {
+class GenerateApiResourceStub extends php_base_1.BasePhpStubStep {
     constructor() {
         super(...arguments);
-        this.type = 'Generate Api Serializer Class';
-        this.additionalExposes = ['className', 'modelClass', 'modelClassName'];
+        this.type = 'Generate Api Resource Class';
+        this.additionalExposes = ['className', 'modelClass', 'modelClassName', 'modelType'];
         this.additionalImplicitParams = ['modelType'];
         this.phpClassParams = ['modelClass'];
         this.schema = {
-            recommendedSubdir: 'Api/Serializer',
-            sourceFile: 'backend/api-serializer.php',
+            recommendedSubdir: 'Api/Resource',
+            sourceFile: 'backend/api-resource.php',
             params: [
                 {
                     name: 'className',
                     type: 'text',
-                    message: 'Serializer class name',
+                    message: 'Resource class name',
                     validate: validation_1.Validator.className,
                 },
                 {
                     name: 'classNamespace',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
                 {
                     name: 'modelClass',
@@ -36,10 +37,12 @@ class GenerateApiSerializerStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'modelClassName',
                     type: 'text',
+                    message: 'Model class name',
                 },
                 {
                     name: 'modelType',
                     type: 'text',
+                    message: 'Model type',
                 },
             ],
         };
@@ -50,4 +53,4 @@ class GenerateApiSerializerStub extends php_base_1.BasePhpStubStep {
         return params;
     }
 }
-exports.GenerateApiSerializerStub = GenerateApiSerializerStub;
+exports.GenerateApiResourceStub = GenerateApiResourceStub;

package/lib/steps/stubs/backend/command.d.ts

@@ -1,27 +1,8 @@
-import { Validator } from '../../../utils/validation';
 import { BasePhpStubStep } from '../php-base';
+import { StubGenerationSchema } from 'boilersmith/steps/stub-base';
 export declare class GenerateCommandStub extends BasePhpStubStep {
     type: string;
     protected additionalExposes: never[];
     protected phpClassParams: never[];
-    protected schema: {
-        recommendedSubdir: string;
-        sourceFile: string;
-        params: ({
-            name: string;
-            type: string;
-            message: string;
-            validate: typeof Validator.className;
-        } | {
-            name: string;
-            type: string;
-            message?: undefined;
-            validate?: undefined;
-        } | {
-            name: string;
-            type: string;
-            message: string;
-            validate?: undefined;
-        })[];
-    };
+    protected schema: StubGenerationSchema;
 }

package/lib/steps/stubs/backend/command.js

@@ -2,9 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateCommandStub = void 0;
 const tslib_1 = require("tslib");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const validation_1 = require("../../../utils/validation");
 const php_base_1 = require("../php-base");
+const string_1 = tslib_1.__importDefault(require("string"));
 class GenerateCommandStub extends php_base_1.BasePhpStubStep {
     constructor() {
         super(...arguments);
@@ -24,17 +25,30 @@ class GenerateCommandStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'classNamespace',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
                 {
                     name: 'commandName',
                     type: 'text',
                     message: `Command name (${chalk_1.default.dim('namespace:command')})`,
                     validate: validation_1.Validator.commandName,
+                    initial: (_prev, params) => {
+                        const extensionId = params.get('extensionId');
+                        const command = (0, string_1.default)(params.get('className'))
+                            .underscore()
+                            .dasherize()
+                            .toString()
+                            .replace(/-command$/, '');
+                        return `${extensionId}:${command}`;
+                    },
                 },
                 {
                     name: 'commandDescription',
                     type: 'text',
                     message: 'Command description',
+                    initial: (_prev, params) => (0, string_1.default)(params.get('className'))
+                        .humanize()
+                        .toString(),
                 },
             ],
         };

package/lib/steps/stubs/backend/{api-controller.d.ts → controller.d.ts}

@@ -1,9 +1,9 @@
 import { Validator } from '../../../utils/validation';
 import { BasePhpStubStep } from '../php-base';
-export declare class GenerateApiControllerStub extends BasePhpStubStep {
+export declare class GenerateControllerStub extends BasePhpStubStep {
     type: string;
-    protected additionalExposes: never[];
-    protected phpClassParams: string[];
+    protected additionalExposes: string[];
+    protected phpClassParams: never[];
     protected schema: {
         recommendedSubdir: string;
         sourceFile: string;
@@ -13,14 +13,12 @@ export declare class GenerateApiControllerStub extends BasePhpStubStep {
             message: string;
             validate: typeof Validator.className;
             choices?: undefined;
-            optional?: undefined;
         } | {
             name: string;
             type: string;
-            message?: undefined;
+            message: string;
             validate?: undefined;
             choices?: undefined;
-            optional?: undefined;
         } | {
             name: string;
             type: string;
@@ -30,14 +28,6 @@ export declare class GenerateApiControllerStub extends BasePhpStubStep {
                 value: string;
             }[];
             validate?: undefined;
-            optional?: undefined;
-        } | {
-            name: string;
-            type: string;
-            message: string;
-            validate: typeof Validator.optionalClass;
-            optional: boolean;
-            choices?: undefined;
         })[];
     };
 }

package/lib/steps/stubs/backend/controller.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateControllerStub = void 0;
+const validation_1 = require("../../../utils/validation");
+const php_base_1 = require("../php-base");
+class GenerateControllerStub extends php_base_1.BasePhpStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate Controller Class';
+        this.additionalExposes = ['frontend'];
+        this.phpClassParams = [];
+        this.schema = {
+            recommendedSubdir: 'Controller',
+            sourceFile: 'backend/controller.php',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Controller class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+                {
+                    name: 'frontend',
+                    type: 'autocomplete',
+                    message: 'Controller type/frontend',
+                    choices: ['forum', 'admin', 'api'].map((type) => ({
+                        title: type,
+                        value: type.toLowerCase(),
+                    })),
+                },
+            ],
+        };
+    }
+}
+exports.GenerateControllerStub = GenerateControllerStub;

package/lib/steps/stubs/backend/event-listener.d.ts

@@ -15,7 +15,7 @@ export declare class GenerateEventListenerStub extends BasePhpStubStep {
         } | {
             name: string;
             type: string;
-            message?: undefined;
+            message: string;
             validate?: undefined;
         })[];
     };

package/lib/steps/stubs/backend/event-listener.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateEventListenerStub = void 0;
 const tslib_1 = require("tslib");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const validation_1 = require("../../../utils/validation");
 const php_base_1 = require("../php-base");
 class GenerateEventListenerStub extends php_base_1.BasePhpStubStep {
@@ -24,6 +24,7 @@ class GenerateEventListenerStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'classNamespace',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
                 {
                     name: 'eventClass',
@@ -34,6 +35,7 @@ class GenerateEventListenerStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'eventClassName',
                     type: 'text',
+                    message: 'Event Class Name',
                 },
             ],
         };

package/lib/steps/stubs/backend/filter.d.ts

@@ -0,0 +1,8 @@
+import { BasePhpStubStep } from '../php-base';
+import { StubGenerationSchema } from 'boilersmith/steps/stub-base';
+export declare class GenerateFilterStub extends BasePhpStubStep {
+    type: string;
+    protected additionalExposes: string[];
+    phpClassParams: string[];
+    protected schema: StubGenerationSchema;
+}

package/lib/steps/stubs/backend/filter.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateFilterStub = void 0;
+const tslib_1 = require("tslib");
+const validation_1 = require("../../../utils/validation");
+const php_base_1 = require("../php-base");
+const string_1 = tslib_1.__importDefault(require("string"));
+class GenerateFilterStub extends php_base_1.BasePhpStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate a filter Class';
+        this.additionalExposes = ['filterClass'];
+        this.phpClassParams = ['filterClass'];
+        this.schema = {
+            recommendedSubdir: 'Search',
+            sourceFile: 'backend/filter.php',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Filter class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+                {
+                    name: 'filterKey',
+                    type: 'text',
+                    message: 'Filter key',
+                    validate: validation_1.Validator.alphaNumeric,
+                    initial: (_prev, params) => (0, string_1.default)(params.get('className'))
+                        .underscore()
+                        .camelize()
+                        .toString()
+                        .replace(/Filter$/, ''),
+                },
+            ],
+        };
+    }
+}
+exports.GenerateFilterStub = GenerateFilterStub;

package/lib/steps/stubs/backend/handler-command.d.ts

@@ -1,33 +1,8 @@
-import { Validator } from '../../../utils/validation';
 import { BasePhpStubStep } from '../php-base';
+import { StubGenerationSchema } from 'boilersmith/steps/stub-base';
 export declare class GenerateHandlerCommandStub extends BasePhpStubStep {
     type: string;
     protected additionalExposes: string[];
     protected phpClassParams: never[];
-    protected schema: {
-        recommendedSubdir: string;
-        sourceFile: string;
-        params: ({
-            name: string;
-            type: string;
-            message: string;
-            validate: typeof Validator.className;
-            choices?: undefined;
-        } | {
-            name: string;
-            type: string;
-            message?: undefined;
-            validate?: undefined;
-            choices?: undefined;
-        } | {
-            name: string;
-            type: string;
-            message: string;
-            choices: {
-                title: string;
-                value: string;
-            }[];
-            validate?: undefined;
-        })[];
-    };
+    protected schema: StubGenerationSchema;
 }

package/lib/steps/stubs/backend/handler-command.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateHandlerCommandStub = void 0;
 const tslib_1 = require("tslib");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const validation_1 = require("../../../utils/validation");
 const php_base_1 = require("../php-base");
 class GenerateHandlerCommandStub extends php_base_1.BasePhpStubStep {
@@ -24,6 +24,7 @@ class GenerateHandlerCommandStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'classNamespace',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
                 {
                     name: 'classType',
@@ -32,6 +33,7 @@ class GenerateHandlerCommandStub extends php_base_1.BasePhpStubStep {
                     choices: ['None', 'Create', 'Update', 'Delete'].map((type) => ({
                         title: type,
                         value: type.toLowerCase(),
+                        selected: type === 'None',
                     })),
                 },
             ],

package/lib/steps/stubs/backend/handler.d.ts

@@ -17,7 +17,7 @@ export declare class GenerateHandlerStub extends BasePhpStubStep {
         } | {
             name: string;
             type: string;
-            message?: undefined;
+            message: string;
             validate?: undefined;
             optional?: undefined;
         } | {

package/lib/steps/stubs/backend/handler.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateHandlerStub = void 0;
 const tslib_1 = require("tslib");
 /* eslint-disable no-warning-comments */
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const validation_1 = require("../../../utils/validation");
 const php_base_1 = require("../php-base");
 class GenerateHandlerStub extends php_base_1.BasePhpStubStep {
@@ -26,6 +26,7 @@ class GenerateHandlerStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'classNamespace',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
                 {
                     name: 'handlerCommandClass',
@@ -36,6 +37,7 @@ class GenerateHandlerStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'handlerCommandClassName',
                     type: 'text',
+                    message: 'Handler command class name',
                 },
                 {
                     name: 'repositoryClass',
@@ -46,6 +48,7 @@ class GenerateHandlerStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'repositoryClassName',
                     type: 'text',
+                    message: 'Repository Class Name',
                 },
                 {
                     name: 'validatorClass',
@@ -56,6 +59,7 @@ class GenerateHandlerStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'validatorClassName',
                     type: 'text',
+                    message: 'Validator Class Name',
                 },
             ],
         };

package/lib/steps/stubs/backend/integration-test.d.ts

@@ -16,7 +16,7 @@ export declare class GenerateIntegrationTestStub extends BasePhpStubStep {
         } | {
             name: string;
             type: string;
-            message?: undefined;
+            message: string;
             validate?: undefined;
         })[];
     };

package/lib/steps/stubs/backend/integration-test.js

@@ -23,10 +23,7 @@ class GenerateIntegrationTestStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'classNamespace',
                     type: 'text',
-                },
-                {
-                    name: 'extensionId',
-                    type: 'text',
+                    message: 'Class Namespace',
                 },
             ],
         };

package/lib/steps/stubs/backend/job.d.ts

@@ -13,7 +13,7 @@ export declare class GenerateJobStub extends BasePhpStubStep {
         } | {
             name: string;
             type: string;
-            message?: undefined;
+            message: string;
             validate?: undefined;
         })[];
     };

package/lib/steps/stubs/backend/job.js

@@ -20,6 +20,7 @@ class GenerateJobStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'classNamespace',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
             ],
         };

package/lib/steps/stubs/backend/mail-driver.d.ts

@@ -0,0 +1,7 @@
+import { BasePhpStubStep } from '../php-base';
+import { StubGenerationSchema } from 'boilersmith/steps/stub-base';
+export declare class GenerateMailDriverStub extends BasePhpStubStep {
+    type: string;
+    additionalExposes: string[];
+    protected schema: StubGenerationSchema;
+}

package/lib/steps/stubs/backend/mail-driver.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateMailDriverStub = void 0;
+const validation_1 = require("../../../utils/validation");
+const php_base_1 = require("../php-base");
+class GenerateMailDriverStub extends php_base_1.BasePhpStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate Mail Driver';
+        this.additionalExposes = ['className'];
+        this.schema = {
+            recommendedSubdir: 'Mail',
+            sourceFile: 'backend/mail-driver.php',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Mail driver class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+            ],
+        };
+    }
+}
+exports.GenerateMailDriverStub = GenerateMailDriverStub;

package/lib/steps/stubs/backend/middleware.d.ts

@@ -0,0 +1,22 @@
+import { Validator } from '../../../utils/validation';
+import { BasePhpStubStep } from '../php-base';
+export declare class GenerateMiddlewareStub extends BasePhpStubStep {
+    type: string;
+    protected additionalExposes: string[];
+    protected phpClassParams: never[];
+    protected schema: {
+        recommendedSubdir: string;
+        sourceFile: string;
+        params: ({
+            name: string;
+            type: string;
+            message: string;
+            validate: typeof Validator.className;
+        } | {
+            name: string;
+            type: string;
+            message: string;
+            validate?: undefined;
+        })[];
+    };
+}

package/lib/steps/stubs/backend/middleware.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateMiddlewareStub = void 0;
+const validation_1 = require("../../../utils/validation");
+const php_base_1 = require("../php-base");
+class GenerateMiddlewareStub extends php_base_1.BasePhpStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate a middleware class';
+        this.additionalExposes = ['className'];
+        this.phpClassParams = [];
+        this.schema = {
+            recommendedSubdir: 'Middleware',
+            sourceFile: 'backend/middleware.php',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Middleware class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+            ],
+        };
+    }
+}
+exports.GenerateMiddlewareStub = GenerateMiddlewareStub;

package/lib/steps/stubs/backend/migration.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateMigrationStub = void 0;
-const node_fs_1 = require("node:fs");
+const fs_1 = require("fs");
 const validation_1 = require("../../../utils/validation");
 const migration_1 = require("../../../utils/migration");
 const php_base_1 = require("../php-base");
@@ -36,12 +36,15 @@ class GenerateMigrationStub extends php_base_1.BasePhpStubStep {
     async getFileName(fs, paths, _paramProvider) {
         let persistedMigrations;
         try {
-            persistedMigrations = (0, node_fs_1.readdirSync)(paths.package('migrations'));
+            persistedMigrations = (0, fs_1.readdirSync)(paths.package('migrations'));
         }
         catch (_a) {
             persistedMigrations = [];
         }
-        const memMigrations = fs.all().map(f => f.path).filter(p => p.startsWith(paths.package('migrations')));
+        const memMigrations = fs
+            .all()
+            .map((f) => f.path)
+            .filter((p) => p.startsWith(paths.package('migrations')));
         return (0, migration_1.getNextMigrationName)([...persistedMigrations, ...memMigrations], this.params.name) + '.php';
     }
 }

package/lib/steps/stubs/backend/model.d.ts

@@ -1,34 +1,12 @@
 import { IO } from 'boilersmith/io';
 import { Paths } from 'boilersmith/paths';
-import { Validator } from '../../../utils/validation';
 import { BasePhpStubStep } from '../php-base';
 import { Store } from 'mem-fs';
+import { StubGenerationSchema } from 'boilersmith/steps/stub-base';
 export declare class GenerateModelStub extends BasePhpStubStep {
     type: string;
     protected additionalExposes: string[];
     protected phpClassParams: never[];
-    protected schema: {
-        recommendedSubdir: string;
-        sourceFile: string;
-        params: ({
-            name: string;
-            type: string;
-            message: string;
-            validate: typeof Validator.className;
-            optional?: undefined;
-        } | {
-            name: string;
-            type: string;
-            message?: undefined;
-            validate?: undefined;
-            optional?: undefined;
-        } | {
-            name: string;
-            type: string;
-            message: string;
-            validate: typeof Validator.tableName;
-            optional: boolean;
-        })[];
-    };
+    protected schema: StubGenerationSchema;
     protected compileParams(fs: Store, paths: Paths, io: IO): Promise<Record<string, unknown>>;
 }

package/lib/steps/stubs/backend/model.js

@@ -23,13 +23,14 @@ class GenerateModelStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'classNamespace',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
                 {
                     name: 'tableName',
                     type: 'text',
-                    message: 'Table name (Optional)',
+                    message: 'Table name',
                     validate: validation_1.Validator.tableName,
-                    optional: true,
+                    initial: (_prev, params) => (0, model_name_1.pluralSnakeCaseModel)(params.get('className')),
                 },
             ],
         };
@@ -38,9 +39,6 @@ class GenerateModelStub extends php_base_1.BasePhpStubStep {
         const params = await super.compileParams(fs, paths, io);
         params.modelPluralSnake = (0, model_name_1.pluralSnakeCaseModel)(params.className);
         params.modelPluralKebab = (0, model_name_1.pluralKebabCaseModel)(params.className);
-        if (!params.tableName) {
-            params.tableName = params.modelPluralSnake;
-        }
         params.migrationName = `create_${params.tableName}_table`;
         return params;
     }

package/lib/steps/stubs/backend/notification-blueprint.d.ts

@@ -0,0 +1,7 @@
+import { BasePhpStubStep } from '../php-base';
+import { StubGenerationSchema } from 'boilersmith/steps/stub-base';
+export declare class GenerateNotificationBlueprintStub extends BasePhpStubStep {
+    type: string;
+    additionalExposes: string[];
+    protected schema: StubGenerationSchema;
+}