@deenruv/cli 1.0.0

package/dist/commands/add/entity/templates/entity.template.ts

@@ -0,0 +1,36 @@
+import {
+  DeepPartial,
+  HasCustomFields,
+  LocaleString,
+  Translatable,
+  Translation,
+  DeenruvEntity,
+} from "@deenruv/core";
+import { Column, Entity, OneToMany } from "typeorm";
+
+import { ScaffoldTranslation } from "./entity-translation.template";
+
+export class ScaffoldEntityCustomFields {}
+
+@Entity()
+export class ScaffoldEntity
+  extends DeenruvEntity
+  implements Translatable, HasCustomFields
+{
+  constructor(input?: DeepPartial<ScaffoldEntity>) {
+    super(input);
+  }
+
+  @Column()
+  code: string;
+
+  @Column((type) => ScaffoldEntityCustomFields)
+  customFields: ScaffoldEntityCustomFields;
+
+  localizedName: LocaleString;
+
+  @OneToMany((type) => ScaffoldTranslation, (translation) => translation.base, {
+    eager: true,
+  })
+  translations: Array<Translation<ScaffoldEntity>>;
+}

package/dist/commands/add/job-queue/add-job-queue.d.ts

@@ -0,0 +1,9 @@
+import { CliCommand, CliCommandReturnVal } from "../../../shared/cli-command";
+import { ServiceRef } from "../../../shared/service-ref";
+import { DeenruvPluginRef } from "../../../shared/deenruv-plugin-ref";
+export interface AddJobQueueOptions {
+    plugin?: DeenruvPluginRef;
+}
+export declare const addJobQueueCommand: CliCommand<Record<string, any>, CliCommandReturnVal<{
+    serviceRef: ServiceRef;
+}>>;

package/dist/commands/add/job-queue/add-job-queue.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addJobQueueCommand = void 0;
+const prompts_1 = require("@clack/prompts");
+const change_case_1 = require("change-case");
+const ts_morph_1 = require("ts-morph");
+const cli_command_1 = require("../../../shared/cli-command");
+const shared_prompts_1 = require("../../../shared/shared-prompts");
+const ast_utils_1 = require("../../../utilities/ast-utils");
+const cancelledMessage = "Add API extension cancelled";
+exports.addJobQueueCommand = new cli_command_1.CliCommand({
+    id: "add-job-queue",
+    category: "Plugin: Job Queue",
+    description: "Defines an new job queue on a service",
+    run: (options) => addJobQueue(options),
+});
+async function addJobQueue(options) {
+    var _a;
+    const providedDeenruvPlugin = options === null || options === void 0 ? void 0 : options.plugin;
+    const { project } = await (0, shared_prompts_1.analyzeProject)({
+        providedDeenruvPlugin,
+        cancelledMessage,
+    });
+    const plugin = providedDeenruvPlugin !== null && providedDeenruvPlugin !== void 0 ? providedDeenruvPlugin : (await (0, shared_prompts_1.selectPlugin)(project, cancelledMessage));
+    const serviceRef = await (0, shared_prompts_1.selectServiceRef)(project, plugin);
+    const jobQueueName = await (0, prompts_1.text)({
+        message: "What is the name of the job queue?",
+        initialValue: "my-background-task",
+        validate: (input) => {
+            if (!/^[a-z][a-z-0-9]+$/.test(input)) {
+                return "The job queue name must be lowercase and contain only letters, numbers and dashes";
+            }
+        },
+    });
+    if ((0, prompts_1.isCancel)(jobQueueName)) {
+        (0, prompts_1.cancel)(cancelledMessage);
+        process.exit(0);
+    }
+    (0, ast_utils_1.addImportsToFile)(serviceRef.classDeclaration.getSourceFile(), {
+        moduleSpecifier: "@deenruv/core",
+        namedImports: ["JobQueue", "JobQueueService", "SerializedRequestContext"],
+    });
+    (0, ast_utils_1.addImportsToFile)(serviceRef.classDeclaration.getSourceFile(), {
+        moduleSpecifier: "@deenruv/common/lib/generated-types",
+        namedImports: ["JobState"],
+    });
+    (0, ast_utils_1.addImportsToFile)(serviceRef.classDeclaration.getSourceFile(), {
+        moduleSpecifier: "@nestjs/common",
+        namedImports: ["OnModuleInit"],
+    });
+    serviceRef.injectDependency({
+        name: "jobQueueService",
+        type: "JobQueueService",
+    });
+    const jobQueuePropertyName = (0, change_case_1.camelCase)(jobQueueName) + "Queue";
+    serviceRef.classDeclaration.insertProperty(0, {
+        name: jobQueuePropertyName,
+        scope: ts_morph_1.Scope.Private,
+        type: (writer) => writer.write("JobQueue<{ ctx: SerializedRequestContext, someArg: string; }>"),
+    });
+    serviceRef.classDeclaration.addImplements("OnModuleInit");
+    let onModuleInitMethod = serviceRef.classDeclaration.getMethod("onModuleInit");
+    if (!onModuleInitMethod) {
+        const constructor = serviceRef.classDeclaration.getConstructors()[0];
+        const constructorChildIndex = (_a = constructor === null || constructor === void 0 ? void 0 : constructor.getChildIndex()) !== null && _a !== void 0 ? _a : 0;
+        onModuleInitMethod = serviceRef.classDeclaration.insertMethod(constructorChildIndex + 1, {
+            name: "onModuleInit",
+            isAsync: false,
+            returnType: "void",
+            scope: ts_morph_1.Scope.Public,
+        });
+    }
+    onModuleInitMethod.setIsAsync(true);
+    onModuleInitMethod.setReturnType("Promise<void>");
+    const body = onModuleInitMethod.getBody();
+    if (ts_morph_1.Node.isBlock(body)) {
+        body
+            .addStatements((writer) => {
+            writer
+                .write(`this.${jobQueuePropertyName} = await this.jobQueueService.createQueue({
+                name: '${jobQueueName}',
+                process: async job => {
+                    // Deserialize the RequestContext from the job data
+                    const ctx = RequestContext.deserialize(job.data.ctx);
+                    // The "someArg" property is passed in when the job is triggered
+                    const someArg = job.data.someArg;
+
+                    // Inside the \`process\` function we define how each job
+                    // in the queue will be processed.
+                    // Let's simulate some long-running task
+                    const totalItems = 10;
+                    for (let i = 0; i < totalItems; i++) {
+                        await new Promise(resolve => setTimeout(resolve, 500));
+
+                        // You can optionally respond to the job being cancelled
+                        // during processing. This can be useful for very long-running
+                        // tasks which can be cancelled by the user.
+                        if (job.state === JobState.CANCELLED) {
+                            throw new Error('Job was cancelled');
+                        }
+
+                        // Progress can be reported as a percentage like this
+                        job.setProgress(Math.floor(i / totalItems * 100));
+                    }
+
+                    // The value returned from the \`process\` function is stored
+                    // as the "result" field of the job
+                    return {
+                        processedCount: totalItems,
+                        message: \`Successfully processed \${totalItems} items\`,
+                    };
+                },
+            })`)
+                .newLine();
+        })
+            .forEach((s) => s.formatText());
+    }
+    serviceRef.classDeclaration
+        .addMethod({
+        name: `trigger${(0, change_case_1.pascalCase)(jobQueueName)}`,
+        scope: ts_morph_1.Scope.Public,
+        parameters: [{ name: "ctx", type: "RequestContext" }],
+        statements: (writer) => {
+            writer.write(`return this.${jobQueuePropertyName}.add({
+                ctx: ctx.serialize(),
+                someArg: 'foo',
+            })`);
+        },
+    })
+        .formatText();
+    prompts_1.log.success(`New job queue created in ${serviceRef.name}`);
+    await project.save();
+    return {
+        project,
+        modifiedSourceFiles: [serviceRef.classDeclaration.getSourceFile()],
+        serviceRef,
+    };
+}
+//# sourceMappingURL=add-job-queue.js.map

package/dist/commands/add/job-queue/add-job-queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-job-queue.js","sourceRoot":"","sources":["../../../../src/commands/add/job-queue/add-job-queue.ts"],"names":[],"mappings":";;;AAAA,4CAA6D;AAC7D,6CAAoD;AACpD,uCAAuC;AAEvC,6DAA8E;AAE9E,mEAIwC;AAExC,4DAAgE;AAEhE,MAAM,gBAAgB,GAAG,6BAA6B,CAAC;AAM1C,QAAA,kBAAkB,GAAG,IAAI,wBAAU,CAAC;IAC/C,EAAE,EAAE,eAAe;IACnB,QAAQ,EAAE,mBAAmB;IAC7B,WAAW,EAAE,uCAAuC;IACpD,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC;CACvC,CAAC,CAAC;AAEH,KAAK,UAAU,WAAW,CACxB,OAA4B;;IAE5B,MAAM,qBAAqB,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC;IAC9C,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAA,+BAAc,EAAC;QACvC,qBAAqB;QACrB,gBAAgB;KACjB,CAAC,CAAC;IACH,MAAM,MAAM,GACV,qBAAqB,aAArB,qBAAqB,cAArB,qBAAqB,GAAI,CAAC,MAAM,IAAA,6BAAY,EAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAG,MAAM,IAAA,iCAAgB,EAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAE3D,MAAM,YAAY,GAAG,MAAM,IAAA,cAAI,EAAC;QAC9B,OAAO,EAAE,oCAAoC;QAC7C,YAAY,EAAE,oBAAoB;QAClC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;YAClB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrC,OAAO,mFAAmF,CAAC;YAC7F,CAAC;QACH,CAAC;KACF,CAAC,CAAC;IAEH,IAAI,IAAA,kBAAQ,EAAC,YAAY,CAAC,EAAE,CAAC;QAC3B,IAAA,gBAAM,EAAC,gBAAgB,CAAC,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAA,4BAAgB,EAAC,UAAU,CAAC,gBAAgB,CAAC,aAAa,EAAE,EAAE;QAC5D,eAAe,EAAE,eAAe;QAChC,YAAY,EAAE,CAAC,UAAU,EAAE,iBAAiB,EAAE,0BAA0B,CAAC;KAC1E,CAAC,CAAC;IAEH,IAAA,4BAAgB,EAAC,UAAU,CAAC,gBAAgB,CAAC,aAAa,EAAE,EAAE;QAC5D,eAAe,EAAE,qCAAqC;QACtD,YAAY,EAAE,CAAC,UAAU,CAAC;KAC3B,CAAC,CAAC;IAEH,IAAA,4BAAgB,EAAC,UAAU,CAAC,gBAAgB,CAAC,aAAa,EAAE,EAAE;QAC5D,eAAe,EAAE,gBAAgB;QACjC,YAAY,EAAE,CAAC,cAAc,CAAC;KAC/B,CAAC,CAAC;IAEH,UAAU,CAAC,gBAAgB,CAAC;QAC1B,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,iBAAiB;KACxB,CAAC,CAAC;IAEH,MAAM,oBAAoB,GAAG,IAAA,uBAAS,EAAC,YAAY,CAAC,GAAG,OAAO,CAAC;IAE/D,UAAU,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,EAAE;QAC5C,IAAI,EAAE,oBAAoB;QAC1B,KAAK,EAAE,gBAAK,CAAC,OAAO;QACpB,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,CACf,MAAM,CAAC,KAAK,CACV,+DAA+D,CAChE;KACJ,CAAC,CAAC;IAEH,UAAU,CAAC,gBAAgB,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IAC1D,IAAI,kBAAkB,GACpB,UAAU,CAAC,gBAAgB,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IACxD,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAExB,MAAM,WAAW,GAAG,UAAU,CAAC,gBAAgB,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;QACrE,MAAM,qBAAqB,GAAG,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,aAAa,EAAE,mCAAI,CAAC,CAAC;QAEhE,kBAAkB,GAAG,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAC3D,qBAAqB,GAAG,CAAC,EACzB;YACE,IAAI,EAAE,cAAc;YACpB,OAAO,EAAE,KAAK;YACd,UAAU,EAAE,MAAM;YAClB,KAAK,EAAE,gBAAK,CAAC,MAAM;SACpB,CACF,CAAC;IACJ,CAAC;IACD,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACpC,kBAAkB,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,kBAAkB,CAAC,OAAO,EAAE,CAAC;IAC1C,IAAI,eAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACvB,IAAI;aACD,aAAa,CAAC,CAAC,MAAM,EAAE,EAAE;YACxB,MAAM;iBACH,KAAK,CACJ,QAAQ,oBAAoB;yBACf,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAgCtB,CACJ;iBACA,OAAO,EAAE,CAAC;QACf,CAAC,CAAC;aACD,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,UAAU,CAAC,gBAAgB;SACxB,SAAS,CAAC;QACT,IAAI,EAAE,UAAU,IAAA,wBAAU,EAAC,YAAY,CAAC,EAAE;QAC1C,KAAK,EAAE,gBAAK,CAAC,MAAM;QACnB,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;QACrD,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE;YACrB,MAAM,CAAC,KAAK,CAAC,eAAe,oBAAoB;;;eAGzC,CAAC,CAAC;QACX,CAAC;KACF,CAAC;SACD,UAAU,EAAE,CAAC;IAEhB,aAAG,CAAC,OAAO,CAAC,4BAA4B,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;IAE3D,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;IAErB,OAAO;QACL,OAAO;QACP,mBAAmB,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC;QAClE,UAAU;KACX,CAAC;AACJ,CAAC"}

package/dist/commands/add/plugin/create-new-plugin.d.ts

@@ -0,0 +1,10 @@
+import { Project, SourceFile } from "ts-morph";
+import { CliCommand, CliCommandReturnVal } from "../../../shared/cli-command";
+import { DeenruvPluginRef } from "../../../shared/deenruv-plugin-ref";
+import { GeneratePluginOptions } from "./types";
+export declare const createNewPluginCommand: CliCommand<Record<string, any>, CliCommandReturnVal>;
+export declare function createNewPlugin(): Promise<CliCommandReturnVal>;
+export declare function generatePlugin(project: Project, options: GeneratePluginOptions): Promise<{
+    plugin: DeenruvPluginRef;
+    modifiedSourceFiles: SourceFile[];
+}>;

package/dist/commands/add/plugin/create-new-plugin.js

@@ -0,0 +1,240 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generatePlugin = exports.createNewPlugin = exports.createNewPluginCommand = void 0;
+const prompts_1 = require("@clack/prompts");
+const change_case_1 = require("change-case");
+const fs = __importStar(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const cli_command_1 = require("../../../shared/cli-command");
+const shared_prompts_1 = require("../../../shared/shared-prompts");
+const deenruv_config_ref_1 = require("../../../shared/deenruv-config-ref");
+const deenruv_plugin_ref_1 = require("../../../shared/deenruv-plugin-ref");
+const ast_utils_1 = require("../../../utilities/ast-utils");
+const utils_1 = require("../../../utilities/utils");
+const add_api_extension_1 = require("../api-extension/add-api-extension");
+const add_codegen_1 = require("../codegen/add-codegen");
+const add_entity_1 = require("../entity/add-entity");
+const add_job_queue_1 = require("../job-queue/add-job-queue");
+const add_service_1 = require("../service/add-service");
+const add_ui_extensions_1 = require("../ui-extensions/add-ui-extensions");
+exports.createNewPluginCommand = new cli_command_1.CliCommand({
+    id: "create-new-plugin",
+    category: "Plugin",
+    description: "Create a new Deenruv plugin",
+    run: createNewPlugin,
+});
+const cancelledMessage = "Plugin setup cancelled.";
+async function createNewPlugin() {
+    const options = {
+        name: "",
+        customEntityName: "",
+        pluginDir: "",
+    };
+    (0, prompts_1.intro)("Adding a new Deenruv plugin!");
+    const { project } = await (0, shared_prompts_1.analyzeProject)({ cancelledMessage });
+    if (!options.name) {
+        const name = await (0, prompts_1.text)({
+            message: "What is the name of the plugin?",
+            initialValue: "my-new-feature",
+            validate: (input) => {
+                if (!/^[a-z][a-z-0-9]+$/.test(input)) {
+                    return "The plugin name must be lowercase and contain only letters, numbers and dashes";
+                }
+            },
+        });
+        if ((0, prompts_1.isCancel)(name)) {
+            (0, prompts_1.cancel)(cancelledMessage);
+            process.exit(0);
+        }
+        else {
+            options.name = name;
+        }
+    }
+    const existingPluginDir = findExistingPluginsDir(project);
+    const pluginDir = getPluginDirName(options.name, existingPluginDir);
+    const confirmation = await (0, prompts_1.text)({
+        message: "Plugin location",
+        initialValue: pluginDir,
+        placeholder: "",
+        validate: (input) => {
+            if (fs.existsSync(input)) {
+                return `A directory named "${input}" already exists. Please specify a different directory.`;
+            }
+        },
+    });
+    if ((0, prompts_1.isCancel)(confirmation)) {
+        (0, prompts_1.cancel)(cancelledMessage);
+        process.exit(0);
+    }
+    options.pluginDir = confirmation;
+    const { plugin, modifiedSourceFiles } = await generatePlugin(project, options);
+    const configSpinner = (0, prompts_1.spinner)();
+    configSpinner.start("Updating DeenruvConfig...");
+    await (0, utils_1.pauseForPromptDisplay)();
+    const deenruvConfig = new deenruv_config_ref_1.DeenruvConfigRef(project);
+    deenruvConfig.addToPluginsArray(`${plugin.name}.init({})`);
+    (0, ast_utils_1.addImportsToFile)(deenruvConfig.sourceFile, {
+        moduleSpecifier: plugin.getSourceFile(),
+        namedImports: [plugin.name],
+    });
+    await deenruvConfig.sourceFile.getProject().save();
+    configSpinner.stop("Updated DeenruvConfig");
+    let done = false;
+    const followUpCommands = [
+        add_entity_1.addEntityCommand,
+        add_service_1.addServiceCommand,
+        add_api_extension_1.addApiExtensionCommand,
+        add_job_queue_1.addJobQueueCommand,
+        add_ui_extensions_1.addUiExtensionsCommand,
+        add_codegen_1.addCodegenCommand,
+    ];
+    let allModifiedSourceFiles = [...modifiedSourceFiles];
+    while (!done) {
+        const featureType = await (0, prompts_1.select)({
+            message: `Add features to ${options.name}?`,
+            options: [
+                { value: "no", label: "[Finish] No, I'm done!" },
+                ...followUpCommands.map((c) => ({
+                    value: c.id,
+                    label: `[${c.category}] ${c.description}`,
+                })),
+            ],
+        });
+        if ((0, prompts_1.isCancel)(featureType)) {
+            done = true;
+        }
+        if (featureType === "no") {
+            done = true;
+        }
+        else {
+            const command = followUpCommands.find((c) => c.id === featureType);
+            try {
+                const result = await command.run({ plugin });
+                allModifiedSourceFiles = result.modifiedSourceFiles;
+                for (const sourceFile of allModifiedSourceFiles) {
+                    sourceFile.organizeImports();
+                }
+            }
+            catch (e) {
+                prompts_1.log.error(`Error adding feature "${command.id}"`);
+                prompts_1.log.error(e.stack);
+            }
+        }
+    }
+    return {
+        project,
+        modifiedSourceFiles: [],
+    };
+}
+exports.createNewPlugin = createNewPlugin;
+async function generatePlugin(project, options) {
+    var _a, _b, _c, _d;
+    const nameWithoutPlugin = options.name.replace(/-?plugin$/i, "");
+    const normalizedName = nameWithoutPlugin + "-plugin";
+    const templateContext = Object.assign(Object.assign({}, options), { pluginName: (0, change_case_1.pascalCase)(normalizedName), pluginInitOptionsName: (0, change_case_1.constantCase)(normalizedName) + "_OPTIONS" });
+    const projectSpinner = (0, prompts_1.spinner)();
+    projectSpinner.start("Generating plugin scaffold...");
+    await (0, utils_1.pauseForPromptDisplay)();
+    const pluginFile = (0, ast_utils_1.createFile)(project, path_1.default.join(__dirname, "templates/plugin.template.ts"), path_1.default.join(options.pluginDir, (0, change_case_1.paramCase)(nameWithoutPlugin) + ".plugin.ts"));
+    const pluginClass = pluginFile.getClass("TemplatePlugin");
+    if (!pluginClass) {
+        throw new Error("Could not find the plugin class in the generated file");
+    }
+    (_a = pluginFile
+        .getImportDeclaration("./constants.template")) === null || _a === void 0 ? void 0 : _a.setModuleSpecifier("./constants");
+    (_b = pluginFile
+        .getImportDeclaration("./types.template")) === null || _b === void 0 ? void 0 : _b.setModuleSpecifier("./types");
+    pluginClass.rename(templateContext.pluginName);
+    const typesFile = (0, ast_utils_1.createFile)(project, path_1.default.join(__dirname, "templates/types.template.ts"), path_1.default.join(options.pluginDir, "types.ts"));
+    const constantsFile = (0, ast_utils_1.createFile)(project, path_1.default.join(__dirname, "templates/constants.template.ts"), path_1.default.join(options.pluginDir, "constants.ts"));
+    (_c = constantsFile
+        .getVariableDeclaration("TEMPLATE_PLUGIN_OPTIONS")) === null || _c === void 0 ? void 0 : _c.rename(templateContext.pluginInitOptionsName).set({ initializer: `Symbol('${templateContext.pluginInitOptionsName}')` });
+    (_d = constantsFile
+        .getVariableDeclaration("loggerCtx")) === null || _d === void 0 ? void 0 : _d.set({ initializer: `'${templateContext.pluginName}'` });
+    projectSpinner.stop("Generated plugin scaffold");
+    await project.save();
+    return {
+        modifiedSourceFiles: [pluginFile, typesFile, constantsFile],
+        plugin: new deenruv_plugin_ref_1.DeenruvPluginRef(pluginClass),
+    };
+}
+exports.generatePlugin = generatePlugin;
+function findExistingPluginsDir(project) {
+    const pluginClasses = (0, ast_utils_1.getPluginClasses)(project);
+    if (pluginClasses.length === 0) {
+        return;
+    }
+    if (pluginClasses.length === 1) {
+        return {
+            prefix: path_1.default.dirname(pluginClasses[0].getSourceFile().getDirectoryPath()),
+            suffix: "",
+        };
+    }
+    const pluginDirs = pluginClasses.map((c) => {
+        return c.getSourceFile().getDirectoryPath();
+    });
+    const prefix = findCommonPath(pluginDirs);
+    const suffixStartIndex = prefix.length;
+    const rest = pluginDirs[0]
+        .substring(suffixStartIndex)
+        .replace(/^\//, "")
+        .split("/");
+    const suffix = rest.length > 1 ? rest.slice(1).join("/") : "";
+    return { prefix, suffix };
+}
+function getPluginDirName(name, existingPluginDirPattern) {
+    const cwd = process.cwd();
+    const nameWithoutPlugin = name.replace(/-?plugin$/i, "");
+    if (existingPluginDirPattern) {
+        return path_1.default.join(existingPluginDirPattern.prefix, (0, change_case_1.paramCase)(nameWithoutPlugin), existingPluginDirPattern.suffix);
+    }
+    else {
+        return path_1.default.join(cwd, "src", "plugins", (0, change_case_1.paramCase)(nameWithoutPlugin));
+    }
+}
+function findCommonPath(paths) {
+    if (paths.length === 0) {
+        return "";
+    }
+    const pathSegmentsList = paths.map((p) => p.split("/"));
+    const minLength = Math.min(...pathSegmentsList.map((segments) => segments.length));
+    const commonPath = [];
+    for (let i = 0; i < minLength; i++) {
+        const currentSegment = pathSegmentsList[0][i];
+        const isCommon = pathSegmentsList.every((segments) => segments[i] === currentSegment);
+        if (isCommon) {
+            commonPath.push(currentSegment);
+        }
+        else {
+            break;
+        }
+    }
+    return commonPath.join("/");
+}
+//# sourceMappingURL=create-new-plugin.js.map

package/dist/commands/add/plugin/create-new-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-new-plugin.js","sourceRoot":"","sources":["../../../../src/commands/add/plugin/create-new-plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAQwB;AACxB,6CAAkE;AAClE,6CAA+B;AAC/B,gDAAwB;AAGxB,6DAA8E;AAC9E,mEAAgE;AAChE,2EAAsE;AACtE,2EAAsE;AACtE,4DAIsC;AACtC,oDAAiE;AACjE,0EAA4E;AAC5E,wDAA2D;AAC3D,qDAAwD;AACxD,8DAAgE;AAChE,wDAA2D;AAC3D,0EAA4E;AAI/D,QAAA,sBAAsB,GAAG,IAAI,wBAAU,CAAC;IACnD,EAAE,EAAE,mBAAmB;IACvB,QAAQ,EAAE,QAAQ;IAClB,WAAW,EAAE,6BAA6B;IAC1C,GAAG,EAAE,eAAe;CACrB,CAAC,CAAC;AAEH,MAAM,gBAAgB,GAAG,yBAAyB,CAAC;AAE5C,KAAK,UAAU,eAAe;IACnC,MAAM,OAAO,GAA0B;QACrC,IAAI,EAAE,EAAE;QACR,gBAAgB,EAAE,EAAE;QACpB,SAAS,EAAE,EAAE;KACP,CAAC;IACT,IAAA,eAAK,EAAC,8BAA8B,CAAC,CAAC;IACtC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAA,+BAAc,EAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC/D,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,GAAG,MAAM,IAAA,cAAI,EAAC;YACtB,OAAO,EAAE,iCAAiC;YAC1C,YAAY,EAAE,gBAAgB;YAC9B,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrC,OAAO,gFAAgF,CAAC;gBAC1F,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,IAAA,kBAAQ,EAAC,IAAI,CAAC,EAAE,CAAC;YACnB,IAAA,gBAAM,EAAC,gBAAgB,CAAC,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QACtB,CAAC;IACH,CAAC;IACD,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAC1D,MAAM,SAAS,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IACpE,MAAM,YAAY,GAAG,MAAM,IAAA,cAAI,EAAC;QAC9B,OAAO,EAAE,iBAAiB;QAC1B,YAAY,EAAE,SAAS;QACvB,WAAW,EAAE,EAAE;QACf,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;YAClB,IAAI,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,sBAAsB,KAAK,yDAAyD,CAAC;YAC9F,CAAC;QACH,CAAC;KACF,CAAC,CAAC;IAEH,IAAI,IAAA,kBAAQ,EAAC,YAAY,CAAC,EAAE,CAAC;QAC3B,IAAA,gBAAM,EAAC,gBAAgB,CAAC,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,OAAO,CAAC,SAAS,GAAG,YAAY,CAAC;IACjC,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,cAAc,CAC1D,OAAO,EACP,OAAO,CACR,CAAC;IAEF,MAAM,aAAa,GAAG,IAAA,iBAAO,GAAE,CAAC;IAChC,aAAa,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACjD,MAAM,IAAA,6BAAqB,GAAE,CAAC;IAC9B,MAAM,aAAa,GAAG,IAAI,qCAAgB,CAAC,OAAO,CAAC,CAAC;IACpD,aAAa,CAAC,iBAAiB,CAAC,GAAG,MAAM,CAAC,IAAI,WAAW,CAAC,CAAC;IAC3D,IAAA,4BAAgB,EAAC,aAAa,CAAC,UAAU,EAAE;QACzC,eAAe,EAAE,MAAM,CAAC,aAAa,EAAE;QACvC,YAAY,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;KAC5B,CAAC,CAAC;IACH,MAAM,aAAa,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,CAAC;IACnD,aAAa,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IAE5C,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,MAAM,gBAAgB,GAAG;QACvB,6BAAgB;QAChB,+BAAiB;QACjB,0CAAsB;QACtB,kCAAkB;QAClB,0CAAsB;QACtB,+BAAiB;KAClB,CAAC;IACF,IAAI,sBAAsB,GAAG,CAAC,GAAG,mBAAmB,CAAC,CAAC;IACtD,OAAO,CAAC,IAAI,EAAE,CAAC;QACb,MAAM,WAAW,GAAG,MAAM,IAAA,gBAAM,EAAC;YAC/B,OAAO,EAAE,mBAAmB,OAAO,CAAC,IAAI,GAAG;YAC3C,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,wBAAwB,EAAE;gBAChD,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC9B,KAAK,EAAE,CAAC,CAAC,EAAE;oBACX,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,WAAW,EAAE;iBAC1C,CAAC,CAAC;aACJ;SACF,CAAC,CAAC;QACH,IAAI,IAAA,kBAAQ,EAAC,WAAW,CAAC,EAAE,CAAC;YAC1B,IAAI,GAAG,IAAI,CAAC;QACd,CAAC;QACD,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;YACzB,IAAI,GAAG,IAAI,CAAC;QACd,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,WAAW,CAAE,CAAC;YAEpE,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;gBAC7C,sBAAsB,GAAG,MAAM,CAAC,mBAAmB,CAAC;gBAGpD,KAAK,MAAM,UAAU,IAAI,sBAAsB,EAAE,CAAC;oBAChD,UAAU,CAAC,eAAe,EAAE,CAAC;gBAC/B,CAAC;YACH,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,aAAG,CAAC,KAAK,CAAC,yBAAyB,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC;gBAClD,aAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,OAAO;QACP,mBAAmB,EAAE,EAAE;KACxB,CAAC;AACJ,CAAC;AA9GD,0CA8GC;AAEM,KAAK,UAAU,cAAc,CAClC,OAAgB,EAChB,OAA8B;;IAE9B,MAAM,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IACjE,MAAM,cAAc,GAAG,iBAAiB,GAAG,SAAS,CAAC;IACrD,MAAM,eAAe,mCAChB,OAAO,KACV,UAAU,EAAE,IAAA,wBAAU,EAAC,cAAc,CAAC,EACtC,qBAAqB,EAAE,IAAA,0BAAY,EAAC,cAAc,CAAC,GAAG,UAAU,GACjE,CAAC;IAEF,MAAM,cAAc,GAAG,IAAA,iBAAO,GAAE,CAAC;IACjC,cAAc,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACtD,MAAM,IAAA,6BAAqB,GAAE,CAAC;IAE9B,MAAM,UAAU,GAAG,IAAA,sBAAU,EAC3B,OAAO,EACP,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,8BAA8B,CAAC,EACpD,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAA,uBAAS,EAAC,iBAAiB,CAAC,GAAG,YAAY,CAAC,CAC1E,CAAC;IACF,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAC1D,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC3E,CAAC;IACD,MAAA,UAAU;SACP,oBAAoB,CAAC,sBAAsB,CAAC,0CAC3C,kBAAkB,CAAC,aAAa,CAAC,CAAC;IACtC,MAAA,UAAU;SACP,oBAAoB,CAAC,kBAAkB,CAAC,0CACvC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAClC,WAAW,CAAC,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IAE/C,MAAM,SAAS,GAAG,IAAA,sBAAU,EAC1B,OAAO,EACP,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,6BAA6B,CAAC,EACnD,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CACzC,CAAC;IAEF,MAAM,aAAa,GAAG,IAAA,sBAAU,EAC9B,OAAO,EACP,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iCAAiC,CAAC,EACvD,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,CAC7C,CAAC;IACF,MAAA,aAAa;SACV,sBAAsB,CAAC,yBAAyB,CAAC,0CAChD,MAAM,CAAC,eAAe,CAAC,qBAAqB,EAC7C,GAAG,CAAC,EAAE,WAAW,EAAE,WAAW,eAAe,CAAC,qBAAqB,IAAI,EAAE,CAAC,CAAC;IAC9E,MAAA,aAAa;SACV,sBAAsB,CAAC,WAAW,CAAC,0CAClC,GAAG,CAAC,EAAE,WAAW,EAAE,IAAI,eAAe,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC;IAE5D,cAAc,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IACjD,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;IACrB,OAAO;QACL,mBAAmB,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,aAAa,CAAC;QAC3D,MAAM,EAAE,IAAI,qCAAgB,CAAC,WAAW,CAAC;KAC1C,CAAC;AACJ,CAAC;AA1DD,wCA0DC;AAED,SAAS,sBAAsB,CAC7B,OAAgB;IAEhB,MAAM,aAAa,GAAG,IAAA,4BAAgB,EAAC,OAAO,CAAC,CAAC;IAChD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO;IACT,CAAC;IACD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO;YACL,MAAM,EAAE,cAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACzE,MAAM,EAAE,EAAE;SACX,CAAC;IACJ,CAAC;IACD,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACzC,OAAO,CAAC,CAAC,aAAa,EAAE,CAAC,gBAAgB,EAAE,CAAC;IAC9C,CAAC,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;IAC1C,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC;IACvC,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC;SACvB,SAAS,CAAC,gBAAgB,CAAC;SAC3B,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;SAClB,KAAK,CAAC,GAAG,CAAC,CAAC;IACd,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAC5B,CAAC;AAED,SAAS,gBAAgB,CACvB,IAAY,EACZ,wBAAwE;IAExE,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC1B,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IACzD,IAAI,wBAAwB,EAAE,CAAC;QAC7B,OAAO,cAAI,CAAC,IAAI,CACd,wBAAwB,CAAC,MAAM,EAC/B,IAAA,uBAAS,EAAC,iBAAiB,CAAC,EAC5B,wBAAwB,CAAC,MAAM,CAChC,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,OAAO,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,IAAA,uBAAS,EAAC,iBAAiB,CAAC,CAAC,CAAC;IACxE,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,KAAe;IACrC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAGD,MAAM,gBAAgB,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAGxD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CACxB,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CACvD,CAAC;IAGF,MAAM,UAAU,GAAa,EAAE,CAAC;IAGhC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC;QAEnC,MAAM,cAAc,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE9C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,KAAK,CACrC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,cAAc,CAC7C,CAAC;QACF,IAAI,QAAQ,EAAE,CAAC;YAEb,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YAEN,MAAM;QACR,CAAC;IACH,CAAC;IAGD,OAAO,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC9B,CAAC"}

package/dist/commands/add/plugin/templates/constants.template.ts

@@ -0,0 +1,2 @@
+export const TEMPLATE_PLUGIN_OPTIONS = Symbol("TEMPLATE_PLUGIN_OPTIONS");
+export const loggerCtx = "TemplatePlugin";

package/dist/commands/add/plugin/templates/plugin.template.ts

@@ -0,0 +1,30 @@
+import { PluginCommonModule, Type, DeenruvPlugin } from "@deenruv/core";
+
+import { TEMPLATE_PLUGIN_OPTIONS } from "./constants.template";
+import { PluginInitOptions } from "./types.template";
+
+@DeenruvPlugin({
+  imports: [PluginCommonModule],
+  providers: [
+    {
+      provide: TEMPLATE_PLUGIN_OPTIONS,
+      useFactory: () => TemplatePlugin.options,
+    },
+  ],
+  configuration: (config) => {
+    // Plugin-specific configuration
+    // such as custom fields, custom permissions,
+    // strategies etc. can be configured here by
+    // modifying the `config` object.
+    return config;
+  },
+  compatibility: "^0.0.0",
+})
+export class TemplatePlugin {
+  static options: PluginInitOptions;
+
+  static init(options: PluginInitOptions): Type<TemplatePlugin> {
+    this.options = options;
+    return TemplatePlugin;
+  }
+}

package/dist/commands/add/plugin/templates/types.template.ts

@@ -0,0 +1,7 @@
+/**
+ * @description
+ * The plugin can be configured using the following options:
+ */
+export interface PluginInitOptions {
+  exampleOption?: string;
+}

package/dist/commands/add/plugin/types.d.ts

@@ -0,0 +1,8 @@
+export interface GeneratePluginOptions {
+    name: string;
+    pluginDir: string;
+}
+export type NewPluginTemplateContext = GeneratePluginOptions & {
+    pluginName: string;
+    pluginInitOptionsName: string;
+};

package/dist/commands/add/plugin/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/commands/add/plugin/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/commands/add/plugin/types.ts"],"names":[],"mappings":""}

package/dist/commands/add/service/add-service.d.ts

@@ -0,0 +1,5 @@
+import { CliCommand, CliCommandReturnVal } from "../../../shared/cli-command";
+import { ServiceRef } from "../../../shared/service-ref";
+export declare const addServiceCommand: CliCommand<Record<string, any>, CliCommandReturnVal<{
+    serviceRef: ServiceRef;
+}>>;