@memberjunction/cli 1.8.1 → 2.1.1

package/README.md

@@ -12,7 +12,7 @@ $ npm install -g @memberjunction/cli
 $ mj COMMAND
 running command...
 $ mj (--version)
-@memberjunction/cli/1.8.1 linux-x64 node-v20.14.0
+@memberjunction/cli/2.1.1 linux-x64 node-v20.15.1
 $ mj --help [COMMAND]
 USAGE
   $ mj COMMAND
@@ -21,10 +21,32 @@ USAGE
 <!-- usagestop -->
 # Commands
 <!-- commands -->
+* [`mj clean`](#mj-clean)
 * [`mj help [COMMAND]`](#mj-help-command)
 * [`mj install`](#mj-install)
+* [`mj migrate`](#mj-migrate)
 * [`mj version`](#mj-version)
 
+## `mj clean`
+
+Resets the MemberJunction database to a pre-installation state
+
+```
+USAGE
+  $ mj clean [-v]
+
+FLAGS
+  -v, --verbose  Enable additional logging
+
+DESCRIPTION
+  Resets the MemberJunction database to a pre-installation state
+
+EXAMPLES
+  $ mj clean
+```
+
+_See code: [src/commands/clean/index.ts](https://github.com/MemberJunction/MJ/blob/v2.1.1/src/commands/clean/index.ts)_
+
 ## `mj help [COMMAND]`
 
 Display help for mj.
@@ -43,7 +65,7 @@ DESCRIPTION
   Display help for mj.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.0/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.3/src/commands/help.ts)_
 
 ## `mj install`
 
@@ -63,7 +85,27 @@ EXAMPLES
   $ mj install
 ```
 
-_See code: [src/commands/install/index.ts](https://github.com/MemberJunction/MJ/blob/v1.8.1/src/commands/install/index.ts)_
+_See code: [src/commands/install/index.ts](https://github.com/MemberJunction/MJ/blob/v2.1.1/src/commands/install/index.ts)_
+
+## `mj migrate`
+
+Migrate MemberJunction database to latest version
+
+```
+USAGE
+  $ mj migrate [-v]
+
+FLAGS
+  -v, --verbose  Enable additional logging
+
+DESCRIPTION
+  Migrate MemberJunction database to latest version
+
+EXAMPLES
+  $ mj migrate
+```
+
+_See code: [src/commands/migrate/index.ts](https://github.com/MemberJunction/MJ/blob/v2.1.1/src/commands/migrate/index.ts)_
 
 ## `mj version`
 
@@ -83,5 +125,5 @@ FLAG DESCRIPTIONS
     Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
 ```
 
-_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v2.2.2/src/commands/version.ts)_
+_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v2.2.4/src/commands/version.ts)_
 <!-- commandsstop -->

package/dist/commands/clean/index.d.ts

@@ -0,0 +1,11 @@
+import { Command } from '@oclif/core';
+import { ParserOutput } from '@oclif/core/lib/interfaces/parser';
+export default class Clean extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        verbose: import("@oclif/core/lib/interfaces/parser").BooleanFlag<boolean>;
+    };
+    flags: ParserOutput<Clean>['flags'];
+    run(): Promise<void>;
+}

package/dist/commands/clean/index.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const node_flyway_1 = require("node-flyway");
+const config_1 = require("../../config");
+const ora_classic_1 = __importDefault(require("ora-classic"));
+class Clean extends core_1.Command {
+    static description = 'Resets the MemberJunction database to a pre-installation state';
+    static examples = [
+        `<%= config.bin %> <%= command.id %>
+`,
+    ];
+    static flags = {
+        verbose: core_1.Flags.boolean({ char: 'v', description: 'Enable additional logging' }),
+    };
+    flags;
+    async run() {
+        const parsed = await this.parse(Clean);
+        this.flags = parsed.flags;
+        if (!config_1.config) {
+            this.error('No configuration found');
+        }
+        const flywayConfig = (0, config_1.getFlywayConfig)(config_1.config);
+        const flyway = new node_flyway_1.Flyway(flywayConfig);
+        this.log('Resetting MJ database to pre-installation state');
+        this.log('Note that users and roles have not been dropped');
+        const spinner = (0, ora_classic_1.default)('Cleaning up...');
+        spinner.start();
+        const result = await flyway.clean();
+        if (result.success) {
+            spinner.succeed();
+            this.log(`The database has been reset. Schemas dropped:\n\t- ${result.flywayResponse?.schemasDropped.join('\n\t- ')}`);
+        }
+        else {
+            spinner.fail();
+            if (result.error) {
+                this.logToStderr(result.error.message);
+                if (this.flags.verbose) {
+                    this.logToStderr(`ERROR CODE: ${result.error.errorCode}`);
+                    this.logToStderr(result.error.stackTrace);
+                }
+            }
+            this.error('Command failed');
+        }
+    }
+}
+exports.default = Clean;

package/dist/commands/install/index.d.ts

@@ -28,12 +28,12 @@ declare const configSchema: z.ZodObject<{
     anthropicAPIKey: z.ZodOptional<z.ZodString>;
     mistralAPIKey: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    dbUrl: string;
-    dbInstance: string;
-    dbTrustServerCertificate: "N" | "Y";
     dbDatabase: string;
     dbPort: number;
     codeGenLogin: string;
+    dbTrustServerCertificate: "Y" | "N";
+    dbUrl: string;
+    dbInstance: string;
     codeGenPwD: string;
     mjAPILogin: string;
     mjAPIPwD: string;
@@ -45,7 +45,7 @@ declare const configSchema: z.ZodObject<{
     auth0ClientId?: string | undefined;
     auth0ClientSecret?: string | undefined;
     auth0Domain?: string | undefined;
-    createNewUser?: "N" | "Y" | undefined;
+    createNewUser?: "Y" | "N" | undefined;
     userFirstName?: string | undefined;
     userLastName?: string | undefined;
     userName?: string | undefined;
@@ -53,12 +53,12 @@ declare const configSchema: z.ZodObject<{
     anthropicAPIKey?: string | undefined;
     mistralAPIKey?: string | undefined;
 }, {
-    dbUrl: string;
-    dbInstance: string;
-    dbTrustServerCertificate: "N" | "Y";
     dbDatabase: string;
     dbPort: number;
     codeGenLogin: string;
+    dbTrustServerCertificate: "Y" | "N";
+    dbUrl: string;
+    dbInstance: string;
     codeGenPwD: string;
     mjAPILogin: string;
     mjAPIPwD: string;
@@ -69,7 +69,7 @@ declare const configSchema: z.ZodObject<{
     auth0ClientId?: string | undefined;
     auth0ClientSecret?: string | undefined;
     auth0Domain?: string | undefined;
-    createNewUser?: "N" | "Y" | undefined;
+    createNewUser?: "Y" | "N" | undefined;
     userEmail?: string | undefined;
     userFirstName?: string | undefined;
     userLastName?: string | undefined;
@@ -88,12 +88,12 @@ export default class Install extends Command {
     userConfig: Config;
     run(): Promise<void>;
     getUserConfiguration(): Promise<{
-        dbUrl: string;
-        dbInstance: string;
-        dbTrustServerCertificate: "N" | "Y";
         dbDatabase: string;
         dbPort: number;
         codeGenLogin: string;
+        dbTrustServerCertificate: "Y" | "N";
+        dbUrl: string;
+        dbInstance: string;
         codeGenPwD: string;
         mjAPILogin: string;
         mjAPIPwD: string;
@@ -105,7 +105,7 @@ export default class Install extends Command {
         auth0ClientId?: string | undefined;
         auth0ClientSecret?: string | undefined;
         auth0Domain?: string | undefined;
-        createNewUser?: "N" | "Y" | undefined;
+        createNewUser?: "Y" | "N" | undefined;
         userFirstName?: string | undefined;
         userLastName?: string | undefined;
         userName?: string | undefined;

package/dist/commands/migrate/index.d.ts

@@ -0,0 +1,11 @@
+import { Command } from '@oclif/core';
+import { ParserOutput } from '@oclif/core/lib/interfaces/parser';
+export default class Migrate extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        verbose: import("@oclif/core/lib/interfaces/parser").BooleanFlag<boolean>;
+    };
+    flags: ParserOutput<Migrate>['flags'];
+    run(): Promise<void>;
+}

package/dist/commands/migrate/index.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const node_flyway_1 = require("node-flyway");
+const config_1 = require("../../config");
+const ora_classic_1 = __importDefault(require("ora-classic"));
+class Migrate extends core_1.Command {
+    static description = 'Migrate MemberJunction database to latest version';
+    static examples = [
+        `<%= config.bin %> <%= command.id %>
+`,
+    ];
+    static flags = {
+        verbose: core_1.Flags.boolean({ char: 'v', description: 'Enable additional logging' }),
+    };
+    flags;
+    async run() {
+        const parsed = await this.parse(Migrate);
+        this.flags = parsed.flags;
+        if (!config_1.config) {
+            this.error('No configuration found');
+        }
+        const flywayConfig = (0, config_1.getFlywayConfig)(config_1.config);
+        const flyway = new node_flyway_1.Flyway(flywayConfig);
+        if (this.flags.verbose) {
+            this.log(`Connecting to ${flywayConfig.url}`);
+            this.log(`Migrating ${config_1.config.coreSchema} schema using migrations from:\n\t- ${flywayConfig.migrationLocations.join('\n\t- ')}\n`);
+        }
+        const spinner = (0, ora_classic_1.default)('Running migrations...');
+        spinner.start();
+        const result = await flyway.migrate();
+        if (result.success) {
+            spinner.succeed();
+            this.log(`Migrations complete in ${result.additionalDetails.executionTime / 1000}s`);
+            if (result.flywayResponse?.success && this.flags.verbose) {
+                this.log(`\tUpdated to ${result.flywayResponse?.targetSchemaVersion}`);
+            }
+        }
+        else {
+            spinner.fail();
+            if (result.error) {
+                this.logToStderr(result.error.message);
+                if (this.flags.verbose) {
+                    this.logToStderr(`ERROR CODE: ${result.error.errorCode}`);
+                    this.logToStderr(result.error.stackTrace);
+                }
+            }
+            this.error('Migrations failed');
+        }
+    }
+}
+exports.default = Migrate;

package/dist/config.d.ts

@@ -0,0 +1,48 @@
+import { z } from 'zod';
+import { FlywayConfig } from 'node-flyway/dist/types/types';
+export type MJConfig = z.infer<typeof mjConfigSchema>;
+declare const mjConfigSchema: z.ZodObject<{
+    dbHost: z.ZodDefault<z.ZodString>;
+    dbDatabase: z.ZodString;
+    dbPort: z.ZodDefault<z.ZodNumber>;
+    codeGenLogin: z.ZodString;
+    codeGenPassword: z.ZodString;
+    migrationsLocation: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    dbTrustServerCertificate: z.ZodDefault<z.ZodEnum<["Y", "N"]>>;
+    coreSchema: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    cleanDisabled: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    cleanDisabled: boolean;
+    dbHost: string;
+    dbDatabase: string;
+    dbPort: number;
+    codeGenLogin: string;
+    codeGenPassword: string;
+    migrationsLocation: string;
+    dbTrustServerCertificate: "Y" | "N";
+    coreSchema: string;
+}, {
+    dbDatabase: string;
+    codeGenLogin: string;
+    codeGenPassword: string;
+    cleanDisabled?: boolean | undefined;
+    dbHost?: string | undefined;
+    dbPort?: number | undefined;
+    migrationsLocation?: string | undefined;
+    dbTrustServerCertificate?: "Y" | "N" | undefined;
+    coreSchema?: string | undefined;
+}>;
+export declare const config: {
+    cleanDisabled: boolean;
+    dbHost: string;
+    dbDatabase: string;
+    dbPort: number;
+    codeGenLogin: string;
+    codeGenPassword: string;
+    migrationsLocation: string;
+    dbTrustServerCertificate: "Y" | "N";
+    coreSchema: string;
+} | undefined;
+export declare const createFlywayUrl: (mjConfig: MJConfig) => string;
+export declare const getFlywayConfig: (mjConfig: MJConfig) => FlywayConfig;
+export {};

package/dist/config.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFlywayConfig = exports.createFlywayUrl = exports.config = void 0;
+const zod_1 = require("zod");
+const cosmiconfig_1 = require("cosmiconfig");
+const explorer = (0, cosmiconfig_1.cosmiconfigSync)('mj');
+const result = explorer.search(process.cwd());
+const mjConfigSchema = zod_1.z.object({
+    dbHost: zod_1.z.string().default('localhost'),
+    dbDatabase: zod_1.z.string(),
+    dbPort: zod_1.z.number({ coerce: true }).default(1433),
+    codeGenLogin: zod_1.z.string(),
+    codeGenPassword: zod_1.z.string(),
+    migrationsLocation: zod_1.z.string().optional().default('filesystem:./migrations'),
+    dbTrustServerCertificate: zod_1.z.enum(['Y', 'N']).default('Y'),
+    coreSchema: zod_1.z.string().optional().default('__mj'),
+    cleanDisabled: zod_1.z.boolean().default(true),
+});
+const parsedConfig = mjConfigSchema.safeParse(result?.config);
+exports.config = parsedConfig.success ? parsedConfig.data : undefined;
+const createFlywayUrl = (mjConfig) => {
+    return `jdbc:sqlserver://${mjConfig.dbHost}:${mjConfig.dbPort}; databaseName=${mjConfig.dbDatabase}${mjConfig.dbTrustServerCertificate === 'Y' ? '; trustServerCertificate=true' : ''}`;
+};
+exports.createFlywayUrl = createFlywayUrl;
+const getFlywayConfig = (mjConfig) => ({
+    url: (0, exports.createFlywayUrl)(mjConfig),
+    user: mjConfig.codeGenLogin,
+    password: mjConfig.codeGenPassword,
+    migrationLocations: [mjConfig.migrationsLocation],
+    advanced: { schemas: [mjConfig.coreSchema], cleanDisabled: mjConfig.cleanDisabled === false ? false : undefined },
+});
+exports.getFlywayConfig = getFlywayConfig;

package/dist/hooks/init.d.ts

@@ -0,0 +1,3 @@
+import { Hook } from '@oclif/core';
+declare const hook: Hook<'init'>;
+export default hook;

package/dist/hooks/init.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const figlet_1 = __importDefault(require("figlet"));
+const hook = async function (options) {
+    console.log(figlet_1.default.textSync('MemberJunction', {
+        font: 'Standard',
+        horizontalLayout: 'default',
+        verticalLayout: 'default',
+        width: 100,
+        whitespaceBreak: true,
+    }));
+};
+exports.default = hook;

package/oclif.manifest.json

@@ -1,5 +1,37 @@
 {
   "commands": {
+    "clean": {
+      "aliases": [],
+      "args": {},
+      "description": "Resets the MemberJunction database to a pre-installation state",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>\n"
+      ],
+      "flags": {
+        "verbose": {
+          "char": "v",
+          "description": "Enable additional logging",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "clean",
+      "pluginAlias": "@memberjunction/cli",
+      "pluginName": "@memberjunction/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "clean",
+        "index.js"
+      ]
+    },
     "install": {
       "aliases": [],
       "args": {},
@@ -31,7 +63,39 @@
         "install",
         "index.js"
       ]
+    },
+    "migrate": {
+      "aliases": [],
+      "args": {},
+      "description": "Migrate MemberJunction database to latest version",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>\n"
+      ],
+      "flags": {
+        "verbose": {
+          "char": "v",
+          "description": "Enable additional logging",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "migrate",
+      "pluginAlias": "@memberjunction/cli",
+      "pluginName": "@memberjunction/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "migrate",
+        "index.js"
+      ]
     }
   },
-  "version": "1.8.1"
+  "version": "2.1.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/cli",
-  "version": "1.8.1",
+  "version": "2.1.1",
   "description": "MemberJunction command line tools",
   "keywords": [
     "oclif"
@@ -26,7 +26,7 @@
     "/oclif.manifest.json"
   ],
   "scripts": {
-    "build": "rimraf dist && tsc -b",
+    "build": "tsc -b",
     "prepack": "npm run build && oclif manifest && oclif readme",
     "postpack": "rimraf oclif.manifest.json",
     "version": "oclif readme && git add README.md"
@@ -34,6 +34,9 @@
   "oclif": {
     "bin": "mj",
     "commands": "./dist/commands",
+    "hooks": {
+      "init": "./dist/hooks/init"
+    },
     "dirname": "mj",
     "plugins": [
       "@oclif/plugin-help",
@@ -50,11 +53,17 @@
     "@oclif/plugin-help": "^6",
     "@oclif/plugin-version": "^2.0.17",
     "@oclif/plugin-warn-if-update-available": "^3.0.16",
+    "cosmiconfig": "9.0.0",
+    "dotenv": "16.4.5",
+    "figlet": "^1.7.0",
     "fs-extra": "^11.2.0",
+    "node-flyway": "0.0.10",
+    "ora-classic": "^5.4.2",
     "zod": "^3.23.4"
   },
   "devDependencies": {
     "@oclif/prettier-config": "^0.2.1",
+    "@types/figlet": "^1.5.8",
     "@types/fs-extra": "^11.0.4",
     "oclif": "^4",
     "rimraf": "5.0.7",