@contentstack/cli-audit 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Contentstack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,402 @@
+<!-- Insert Nodejs CI here -->
+<!-- Insert Audit version here -->
+
+# @contentstack/cli-audit
+Audit plugin
+
+## How to install this plugin
+
+```shell
+$ csdx plugins:install @contentstack/cli-audit
+```
+
+## How to use this plugin
+
+This plugin requires you to be authenticated using [csdx auth:login](https://www.contentstack.com/docs/developers/cli/authenticate-with-the-cli/).
+
+<!-- usage -->
+```sh-session
+$ npm install -g @contentstack/cli-audit
+$ csdx COMMAND
+running command...
+$ csdx (--version|-v)
+@contentstack/cli-audit/1.0.0 linux-x64 node-v18.18.0
+$ csdx --help [COMMAND]
+USAGE
+  $ csdx COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+<!-- commands -->
+* [`csdx cm::stacks:audit:fix`](#csdx-cmstacksauditfix)
+* [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
+* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix-1)
+* [`csdx help [COMMANDS]`](#csdx-help-commands)
+* [`csdx plugins`](#csdx-plugins)
+* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin)
+* [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
+* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin-1)
+* [`csdx plugins:link PLUGIN`](#csdx-pluginslink-plugin)
+* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin)
+* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-1)
+* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-2)
+* [`csdx plugins:update`](#csdx-pluginsupdate)
+
+## `csdx cm::stacks:audit:fix`
+
+Audit fix command
+
+```
+USAGE
+  $ csdx cm::stacks:audit:fix [-c <value>] [-d <value>]
+
+FLAGS
+  -c, --config=<value>    Path of the external config.
+  -d, --data-dir=<value>  Path where the data is stored.
+
+DESCRIPTION
+  Audit fix command
+
+ALIASES
+  $ csdx cm::stacks:audit:fix
+
+EXAMPLES
+  $ csdx cm::stacks:audit:fix
+```
+
+_See code: [src/commands/cm/stacks/audit/fix.ts](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
+
+## `csdx cm:stacks:audit`
+
+Perform audits and find possible errors in the exported Contentstack data
+
+```
+USAGE
+  $ csdx cm:stacks:audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
+    content-types|global-fields|entries] [--columns <value> | ] [--sort <value>] [--filter <value>] [--csv |
+    --no-truncate]
+
+FLAGS
+  -c, --config=<value>    Path of the external config.
+  -d, --data-dir=<value>  Path where the data is stored.
+  --columns=<value>       only show provided columns (comma-separated)
+  --csv                   output is csv format [alias: --output=csv]
+  --filter=<value>        filter property by partial string matching, ex: name=foo
+  --modules=<option>...   Provide the list of modules to be audited.
+                          <options: content-types|global-fields|entries>
+  --no-truncate           do not truncate output to fit screen
+  --report-path=<value>   Path to store the audit reports.
+  --sort=<value>          property to sort by (prepend '-' for descending)
+
+DESCRIPTION
+  Perform audits and find possible errors in the exported Contentstack data
+
+ALIASES
+  $ csdx cm:stacks:audit
+
+EXAMPLES
+  $ csdx cm:stacks:audit
+
+  $ csdx cm:stacks:audit --report-path=<path>
+
+  $ csdx cm:stacks:audit --report-path=<path> --csv
+
+  $ csdx cm:stacks:audit --report-path=<path> --filter="name=<filter-value>"
+
+  $ csdx cm:stacks:audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
+```
+
+_See code: [src/commands/cm/stacks/audit/index.ts](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts)_
+
+## `csdx cm:stacks:audit:fix`
+
+Audit fix command
+
+```
+USAGE
+  $ csdx cm:stacks:audit:fix [-c <value>] [-d <value>]
+
+FLAGS
+  -c, --config=<value>    Path of the external config.
+  -d, --data-dir=<value>  Path where the data is stored.
+
+DESCRIPTION
+  Audit fix command
+
+ALIASES
+  $ csdx cm::stacks:audit:fix
+
+EXAMPLES
+  $ csdx cm:stacks:audit:fix
+```
+
+_See code: [src/commands/cm/stacks/audit/fix.ts](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
+
+## `csdx help [COMMANDS]`
+
+Display help for csdx.
+
+```
+USAGE
+  $ csdx help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for csdx.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
+
+## `csdx plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ csdx plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ csdx plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/index.ts)_
+
+## `csdx plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ csdx plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ csdx plugins:add
+
+EXAMPLES
+  $ csdx plugins:install myplugin 
+
+  $ csdx plugins:install https://github.com/someuser/someplugin
+
+  $ csdx plugins:install someuser/someplugin
+```
+
+## `csdx plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ csdx plugins:inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ csdx plugins:inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/inspect.ts)_
+
+## `csdx plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ csdx plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ csdx plugins:add
+
+EXAMPLES
+  $ csdx plugins:install myplugin 
+
+  $ csdx plugins:install https://github.com/someuser/someplugin
+
+  $ csdx plugins:install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/install.ts)_
+
+## `csdx plugins:link PLUGIN`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ csdx plugins:link PLUGIN
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ csdx plugins:link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/link.ts)_
+
+## `csdx plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ csdx plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ csdx plugins:unlink
+  $ csdx plugins:remove
+```
+
+## `csdx plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ csdx plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ csdx plugins:unlink
+  $ csdx plugins:remove
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/uninstall.ts)_
+
+## `csdx plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ csdx plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ csdx plugins:unlink
+  $ csdx plugins:remove
+```
+
+## `csdx plugins:update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ csdx plugins:update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/update.ts)_
+<!-- commandsstop -->

package/bin/dev

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+(async () => {
+  const { execute } = require('@contentstack/cli-utilities');
+  await execute({ type: 'cjs', development: true, dir: __dirname });
+})();

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/lib/base-command.d.ts

@@ -0,0 +1,45 @@
+import { Command } from '@contentstack/cli-command';
+import { FlagInput, Interfaces } from '@contentstack/cli-utilities';
+import { Logger } from './util';
+import { ConfigType, LogFn } from './types';
+import messages, { $t } from './messages';
+export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
+export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof BaseCommand)['baseFlags'] & T['flags']>;
+export declare abstract class BaseCommand<T extends typeof Command> extends Command {
+    log: LogFn;
+    logger: Logger;
+    readonly $t: typeof $t;
+    protected sharedConfig: ConfigType;
+    readonly messages: typeof messages;
+    protected args: Args<T>;
+    protected flags: Flags<T>;
+    static baseFlags: FlagInput;
+    /**
+     * The `init` function initializes the command by parsing arguments and flags, registering search
+     * plugins, registering the configuration, and initializing the logger.
+     */
+    init(): Promise<void>;
+    /**
+     * The catch function is used to handle errors from a command, either by adding custom logic or
+     * returning the parent class error handling.
+     * @param err - The `err` parameter is of type `Error & { exitCode?: number }`. This means that it is
+     * an object that extends the `Error` class and may also have an optional property `exitCode` of type
+     * `number`.
+     * @returns The parent class error handling is being returned.
+     */
+    protected catch(err: Error & {
+        exitCode?: number;
+    }): Promise<any>;
+    /**
+     * The `finally` function is called after the `run` and `catch` functions, regardless of whether or not
+     * an error occurred.
+     * @param {Error | undefined} _ - The parameter "_" represents an error object or undefined.
+     * @returns The `finally` method is returning the result of calling the `finally` method of the
+     * superclass, which is a promise.
+     */
+    protected finally(_: Error | undefined): Promise<any>;
+    /**
+     * The function checks if a configuration file exists and if so, reads and parses it as JSON.
+     */
+    registerConfig(): void;
+}

package/lib/base-command.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseCommand = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const cli_command_1 = require("@contentstack/cli-command");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const config_1 = tslib_1.__importDefault(require("./config"));
+const util_1 = require("./util");
+const messages_1 = tslib_1.__importStar(require("./messages"));
+class BaseCommand extends cli_command_1.Command {
+    constructor() {
+        super(...arguments);
+        this.$t = messages_1.$t;
+        this.sharedConfig = Object.assign(Object.assign({}, config_1.default), { basePath: process.cwd() });
+        this.messages = messages_1.default;
+    }
+    /**
+     * The `init` function initializes the command by parsing arguments and flags, registering search
+     * plugins, registering the configuration, and initializing the logger.
+     */
+    async init() {
+        await super.init();
+        const { args, flags } = await this.parse({
+            flags: this.ctor.flags,
+            baseFlags: super.ctor.baseFlags,
+            args: this.ctor.args,
+            strict: this.ctor.strict,
+        });
+        this.flags = flags;
+        this.args = args;
+        this.sharedConfig = Object.assign(this.sharedConfig, { flags: this.flags });
+        cli_utilities_1.cliux.registerSearchPlugin();
+        this.registerConfig();
+        // Init logger
+        const logger = new util_1.Logger(this.sharedConfig);
+        this.log = logger.log.bind(logger);
+    }
+    /**
+     * The catch function is used to handle errors from a command, either by adding custom logic or
+     * returning the parent class error handling.
+     * @param err - The `err` parameter is of type `Error & { exitCode?: number }`. This means that it is
+     * an object that extends the `Error` class and may also have an optional property `exitCode` of type
+     * `number`.
+     * @returns The parent class error handling is being returned.
+     */
+    async catch(err) {
+        // add any custom logic to handle errors from the command
+        // or simply return the parent class error handling
+        return super.catch(err);
+    }
+    /**
+     * The `finally` function is called after the `run` and `catch` functions, regardless of whether or not
+     * an error occurred.
+     * @param {Error | undefined} _ - The parameter "_" represents an error object or undefined.
+     * @returns The `finally` method is returning the result of calling the `finally` method of the
+     * superclass, which is a promise.
+     */
+    async finally(_) {
+        // called after run and catch regardless of whether or not the command errored
+        return super.finally(_);
+    }
+    /**
+     * The function checks if a configuration file exists and if so, reads and parses it as JSON.
+     */
+    registerConfig() {
+        if (this.flags.config && (0, fs_1.existsSync)(this.flags.config)) {
+            try {
+                this.sharedConfig = JSON.parse((0, fs_1.readFileSync)(this.flags.config, { encoding: 'utf-8' }));
+            }
+            catch (error) {
+                this.log(error, 'error');
+            }
+        }
+    }
+}
+exports.BaseCommand = BaseCommand;
+// NOTE define flags that can be inherited by any command that extends BaseCommand
+BaseCommand.baseFlags = {
+    config: cli_utilities_1.Flags.string({
+        char: 'c',
+        description: messages_1.commonMsg.CONFIG,
+    }),
+    'data-dir': cli_utilities_1.Flags.string({
+        char: 'd',
+        description: messages_1.commonMsg.DATA_DIR,
+    }),
+};

package/lib/commands/cm/stacks/audit/fix.d.ts

@@ -0,0 +1,8 @@
+import { BaseCommand } from '../../../../base-command';
+export default class AuditFix extends BaseCommand<typeof AuditFix> {
+    static description: string;
+    static aliases: string[];
+    static examples: string[];
+    static flags: {};
+    run(): Promise<void>;
+}

package/lib/commands/cm/stacks/audit/fix.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_command_1 = require("../../../../base-command");
+class AuditFix extends base_command_1.BaseCommand {
+    async run() { }
+}
+exports.default = AuditFix;
+AuditFix.description = 'Audit fix command';
+AuditFix.aliases = ['cm::stacks:audit:fix'];
+AuditFix.examples = ['$ <%= config.bin %> <%= command.id %>'];
+AuditFix.flags = {};

package/lib/commands/cm/stacks/audit/index.d.ts

@@ -0,0 +1,62 @@
+import { FlagInput } from '@contentstack/cli-utilities';
+import config from '../../../../config';
+import { BaseCommand } from '../../../../base-command';
+import { ContentTypeStruct } from '../../../../types';
+export default class Audit extends BaseCommand<typeof Audit> {
+    static aliases: string[];
+    static description: string;
+    static examples: string[];
+    static flags: FlagInput;
+    /**
+     * The `run` function is an asynchronous function that performs an audit on different modules
+     * (content-types, global-fields, entries) and generates a report.
+     */
+    run(): Promise<void>;
+    /**
+     * The `promptQueue` function prompts the user to enter a data directory path if the `data-dir` flag
+     * is missing, and sets the `basePath` property of the `sharedConfig` object to the entered path.
+     */
+    promptQueue(): Promise<void>;
+    /**
+     * The function `getCtAndGfSchema` reads and parses JSON files containing content type and global
+     * field schemas, and returns them as an object.
+     * @returns The function `getCtAndGfSchema()` returns an object with two properties: `ctSchema` and
+     * `gfSchema`. The values of these properties are the parsed JSON data from two different files.
+     */
+    getCtAndGfSchema(): {
+        ctSchema: ContentTypeStruct[];
+        gfSchema: ContentTypeStruct[];
+    };
+    /**
+     * The function `showOutputOnScreen` displays missing references on the terminal screen if the
+     * `showTerminalOutput` flag is set to true.
+     * @param {{ module: string; missingRefs?: Record<string, any> }[]} allMissingRefs - An array of
+     * objects, where each object has two properties:
+     */
+    showOutputOnScreen(allMissingRefs: {
+        module: string;
+        missingRefs?: Record<string, any>;
+    }[]): void;
+    /**
+     * The function prepares a report by writing a JSON file and a CSV file with a list of missing
+     * references for a given module.
+     * @param moduleName - The `moduleName` parameter is a string that represents the name of a module.
+     * It is used to generate the filename for the report.
+     * @param listOfMissingRefs - The `listOfMissingRefs` parameter is a record object that contains
+     * information about missing references. It is a key-value pair where the key represents the
+     * reference name and the value represents additional information about the missing reference.
+     * @returns The function `prepareReport` returns a Promise that resolves to `void`.
+     */
+    prepareReport(moduleName: keyof typeof config.moduleConfig, listOfMissingRefs: Record<string, any>): Promise<void>;
+    /**
+     * The function `prepareCSV` takes a module name and a list of missing references, and generates a
+     * CSV file with the specified columns and filtered rows.
+     * @param moduleName - The `moduleName` parameter is a string that represents the name of a module.
+     * It is used to generate the name of the CSV file that will be created.
+     * @param listOfMissingRefs - The `listOfMissingRefs` parameter is a record object that contains
+     * information about missing references. Each key in the record represents a reference, and the
+     * corresponding value is an array of objects that contain details about the missing reference.
+     * @returns The function `prepareCSV` returns a Promise that resolves to `void`.
+     */
+    prepareCSV(moduleName: keyof typeof config.moduleConfig, listOfMissingRefs: Record<string, any>): Promise<void>;
+}