@flarum/cli 2.0.0-beta.9 → 3.0.0

package/lib/steps/stubs/backend/notification-blueprint.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateNotificationBlueprintStub = 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 GenerateNotificationBlueprintStub extends php_base_1.BasePhpStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate Notification Blueprint';
+        this.additionalExposes = ['className', 'type'];
+        this.schema = {
+            recommendedSubdir: 'Notification',
+            sourceFile: 'backend/notification-blueprint.php',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Notification blueprint 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()
+                            .camelize()
+                            .toString()
+                            .replace(/Blueprint$/, '');
+                    },
+                },
+            ],
+        };
+    }
+}
+exports.GenerateNotificationBlueprintStub = GenerateNotificationBlueprintStub;

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

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

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

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

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

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

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

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GeneratePolicyStub = 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 GeneratePolicyStub extends php_base_1.BasePhpStubStep {
@@ -24,6 +24,7 @@ class GeneratePolicyStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'classNamespace',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
                 {
                     name: 'modelClass',
@@ -34,6 +35,7 @@ class GeneratePolicyStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'modelClassName',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
             ],
         };

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

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

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

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneratePostTypeStub = 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 GeneratePostTypeStub extends php_base_1.BasePhpStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate Event Post class';
+        this.additionalExposes = ['className', 'postType'];
+        this.schema = {
+            recommendedSubdir: 'Post',
+            sourceFile: 'backend/post-type.php',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Post class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+                {
+                    name: 'postType',
+                    type: 'text',
+                    message: 'Post type',
+                    initial: (_prev, params) => {
+                        return (0, string_1.default)(params.get('className'))
+                            .underscore()
+                            .camelize()
+                            .toString()
+                            .replace(/Post$/, '');
+                    },
+                },
+            ],
+        };
+    }
+}
+exports.GeneratePostTypeStub = GeneratePostTypeStub;

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

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

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

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateRepositoryStub = 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 GenerateRepositoryStub extends php_base_1.BasePhpStubStep {
@@ -24,6 +24,7 @@ class GenerateRepositoryStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'classNamespace',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
                 {
                     name: 'modelClass',
@@ -34,6 +35,7 @@ class GenerateRepositoryStub extends php_base_1.BasePhpStubStep {
                 {
                     name: 'modelClassName',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
             ],
         };

package/lib/steps/stubs/backend/search-driver-searcher.d.ts

@@ -0,0 +1,24 @@
+import { Validator } from '../../../utils/validation';
+import { BasePhpStubStep } from '../php-base';
+export declare class GenerateSearchDriverAbstractModelSearcherStub 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;
+            initial: string;
+        } | {
+            name: string;
+            type: string;
+            message: string;
+            validate?: undefined;
+            initial?: undefined;
+        })[];
+    };
+}

package/lib/steps/stubs/backend/search-driver-searcher.js

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

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

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

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

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateSearchDriverStub = 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 GenerateSearchDriverStub extends php_base_1.BasePhpStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate Search Driver';
+        this.additionalExposes = ['driverName'];
+        this.phpClassParams = [];
+        this.schema = {
+            recommendedSubdir: 'Search',
+            sourceFile: 'backend/search/driver.php',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Driver class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+                {
+                    name: 'driverName',
+                    type: 'text',
+                    message: 'Unique driver name (e.g. extension-name-driver-name)',
+                    validate: validation_1.Validator.alphaDash,
+                    initial: (_prev, params) => {
+                        const extensionId = params.get('extensionId');
+                        const driverName = (0, string_1.default)(params.get('className'))
+                            .underscore()
+                            .dasherize()
+                            .toString()
+                            .replace(/-search-driver$/, '')
+                            .replace(/-driver$/, '');
+                        return `${extensionId}-${driverName}`;
+                    },
+                },
+            ],
+        };
+    }
+}
+exports.GenerateSearchDriverStub = GenerateSearchDriverStub;

package/lib/steps/stubs/backend/service-provider.d.ts

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

package/lib/steps/stubs/backend/service-provider.js

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

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

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

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

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

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

@@ -4,7 +4,7 @@ exports.FlarumBaseStubStep = void 0;
 const stub_base_1 = require("boilersmith/steps/stub-base");
 class FlarumBaseStubStep extends stub_base_1.BaseStubStep {
     async precompileParams(fs, paths, io) {
-        return Object.assign(Object.assign({}, await super.precompileParams(fs, paths, io)), { extensionId: this.scaffolder.templateParamVal('extensionId', fs, paths, io) });
+        return Object.assign(Object.assign({}, (await super.precompileParams(fs, paths, io))), { extensionId: await this.scaffolder.templateParamVal('extensionId', fs, paths, io), packageNamespace: await this.scaffolder.templateParamVal('packageNamespace', fs, paths, io) });
     }
 }
 exports.FlarumBaseStubStep = FlarumBaseStubStep;

package/lib/steps/stubs/frontend/component.d.ts

@@ -16,11 +16,6 @@ export declare class GenerateComponentStub extends BaseJsStubStep {
             type: string;
             message: string;
             validate: typeof Validator.className;
-        } | {
-            name: string;
-            type: string;
-            message?: undefined;
-            validate?: undefined;
         })[];
     };
 }

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

@@ -26,6 +26,7 @@ class GenerateComponentStub extends js_base_1.BaseJsStubStep {
                 {
                     name: 'classNamespace',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
             ],
         };

package/lib/steps/stubs/frontend/forum-page.d.ts

@@ -0,0 +1,25 @@
+import { IO } from 'boilersmith/io';
+import { Paths } from 'boilersmith/paths';
+import { Validator } from '../../../utils/validation';
+import { BaseJsStubStep } from '../js-base';
+import { Store } from 'mem-fs';
+export declare class GenerateForumPageStub extends BaseJsStubStep {
+    type: string;
+    protected additionalExposes: string[];
+    protected schema: {
+        recommendedSubdir: string;
+        sourceFile: string;
+        params: ({
+            name: string;
+            type: string;
+            message: string;
+            validate: typeof Validator.module;
+        } | {
+            name: string;
+            type: string;
+            message: string;
+            validate?: undefined;
+        })[];
+    };
+    protected compileParams(fs: Store, paths: Paths, io: IO): Promise<Record<string, unknown>>;
+}

package/lib/steps/stubs/frontend/forum-page.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateForumPageStub = void 0;
+const validation_1 = require("../../../utils/validation");
+const js_base_1 = require("../js-base");
+const model_name_1 = require("../../../utils/model-name");
+class GenerateForumPageStub extends js_base_1.BaseJsStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate Forum Page Class';
+        this.additionalExposes = ['frontend', 'classNamespace'];
+        this.schema = {
+            recommendedSubdir: 'forum/components',
+            sourceFile: 'frontend/forum-page.js',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Forum page module',
+                    validate: validation_1.Validator.module,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+            ],
+        };
+    }
+    async compileParams(fs, paths, io) {
+        const params = await super.compileParams(fs, paths, io);
+        params.frontend = 'forum';
+        params.pathName = (0, model_name_1.kebab)(params.className);
+        return params;
+    }
+}
+exports.GenerateForumPageStub = GenerateForumPageStub;

package/lib/steps/stubs/frontend/gambit.d.ts

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

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

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateGambitStub = void 0;
+const validation_1 = require("../../../utils/validation");
+const js_base_1 = require("../js-base");
+class GenerateGambitStub extends js_base_1.BaseJsStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate a Gambit';
+        this.additionalExposes = ['frontend', 'classNamespace'];
+        this.schema = {
+            recommendedSubdir: 'common/gambits',
+            sourceFile: 'frontend/gambit/${type}.js',
+            params: [
+                {
+                    name: 'frontend',
+                    type: 'text',
+                    message: 'Frontend name (common recommended)',
+                },
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Gambit class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+                {
+                    name: 'type',
+                    message: 'Gambit type',
+                    type: 'select',
+                    choices: ['boolean', 'key-value'].map((type) => ({
+                        title: type,
+                        value: type,
+                    })),
+                },
+                {
+                    name: 'filterKey',
+                    message: 'Backend filter key',
+                    type: 'text',
+                    validate: validation_1.Validator.alphaNumeric,
+                },
+            ],
+        };
+    }
+}
+exports.GenerateGambitStub = GenerateGambitStub;

package/lib/steps/stubs/frontend/modal.d.ts

@@ -16,11 +16,6 @@ export declare class GenerateModalStub extends BaseJsStubStep {
             type: string;
             message: string;
             validate: typeof Validator.className;
-        } | {
-            name: string;
-            type: string;
-            message?: undefined;
-            validate?: undefined;
         })[];
     };
 }

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

@@ -26,6 +26,7 @@ class GenerateModalStub extends js_base_1.BaseJsStubStep {
                 {
                     name: 'classNamespace',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
             ],
         };

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

@@ -6,6 +6,7 @@ import { Store } from 'mem-fs';
 export declare class GenerateModelStub extends BaseJsStubStep {
     type: string;
     protected additionalExposes: string[];
+    additionalImplicitParams: string[];
     protected schema: {
         recommendedSubdir: string;
         sourceFile: string;
@@ -13,16 +14,22 @@ export declare class GenerateModelStub extends BaseJsStubStep {
             name: string;
             type: string;
             message: string;
+            choices: {
+                title: string;
+                value: string;
+            }[];
             validate?: undefined;
         } | {
             name: string;
             type: string;
             message: string;
             validate: typeof Validator.className;
+            choices?: undefined;
         } | {
             name: string;
             type: string;
-            message?: undefined;
+            message: string;
+            choices?: undefined;
             validate?: undefined;
         })[];
     };

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

@@ -9,6 +9,7 @@ class GenerateModelStub extends js_base_1.BaseJsStubStep {
         super(...arguments);
         this.type = 'Generate Model Class';
         this.additionalExposes = ['frontend', 'modelType', 'classNamespace'];
+        this.additionalImplicitParams = ['modelType'];
         this.schema = {
             recommendedSubdir: '${frontend}/models',
             sourceFile: 'frontend/model.js',
@@ -17,6 +18,10 @@ class GenerateModelStub extends js_base_1.BaseJsStubStep {
                     name: 'frontend',
                     type: 'text',
                     message: 'Frontend name',
+                    choices: ['forum', 'admin', 'common'].map((type) => ({
+                        title: type,
+                        value: type.toLowerCase(),
+                    })),
                 },
                 {
                     name: 'className',
@@ -27,6 +32,7 @@ class GenerateModelStub extends js_base_1.BaseJsStubStep {
                 {
                     name: 'classNamespace',
                     type: 'text',
+                    message: 'Class Namespace',
                 },
             ],
         };

package/lib/steps/stubs/frontend/notification.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 GenerateNotificationStub extends BaseJsStubStep {
+    type: string;
+    protected additionalExposes: string[];
+    protected schema: StubGenerationSchema;
+    protected precompileParams(fs: Store, paths: Paths, io: IO): Promise<Record<string, unknown>>;
+}