@contentstack/cli-audit 1.3.1 → 1.3.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Contentstack
+Copyright (c) 2024 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

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli-audit/1.3.1 linux-x64 node-v18.19.0
+@contentstack/cli-audit/1.3.3 linux-x64 node-v18.19.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/audit-base-command.d.ts

@@ -16,7 +16,7 @@ export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditB
      * @param {string} command - The `command` parameter is a string that represents the current command
      * being executed.
      */
-    start(command: CommandNames): Promise<void>;
+    start(command: CommandNames): Promise<boolean>;
     /**
      * The `scan` function performs an audit on different modules (content-types, global-fields, and
      * entries) and returns the missing references for each module.

package/lib/audit-base-command.js

@@ -56,11 +56,14 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
         else {
             this.log(this.messages.NO_MISSING_REF_FOUND, 'info');
             this.log('');
-            if (this.currentCommand === 'cm:stacks:audit:fix' && (0, fs_1.existsSync)(this.sharedConfig.basePath)) {
+            if (this.flags['copy-dir'] &&
+                this.currentCommand === 'cm:stacks:audit:fix' &&
+                (0, fs_1.existsSync)(this.sharedConfig.basePath)) {
                 // NOTE Clean up the backup dir if no issue found while audit the content
                 (0, fs_1.rmSync)(this.sharedConfig.basePath, { recursive: true });
             }
         }
+        return !(0, isEmpty_1.default)(missingCtRefs) || !(0, isEmpty_1.default)(missingGfRefs) || !(0, isEmpty_1.default)(missingEntryRefs);
     }
     /**
      * The `scan` function performs an audit on different modules (content-types, global-fields, and
@@ -123,7 +126,9 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                 throw Error(this.$t(this.messages.NOT_VALID_PATH, { path: this.sharedConfig.basePath }));
             }
             // NOTE create bkp directory
-            const backupDirPath = `${(this.flags['copy-path'] || this.flags['data-dir']).replace(/\/+$/, '')}_backup_${(0, uuid_1.v4)()}`;
+            const backupDirPath = `${(this.flags['copy-path'] ||
+                this.flags['data-dir'] ||
+                this.sharedConfig.basePath).replace(/\/+$/, '')}_backup_${(0, uuid_1.v4)()}`;
             if (!(0, fs_1.existsSync)(backupDirPath)) {
                 (0, fs_1.mkdirSync)(backupDirPath, { recursive: true });
             }
@@ -162,8 +167,8 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
      * objects, where each object has two properties:
      */
     showOutputOnScreen(allMissingRefs) {
-        var _a;
-        if (this.sharedConfig.showTerminalOutput) {
+        var _a, _b;
+        if (this.sharedConfig.showTerminalOutput && !((_a = this.flags['external-config']) === null || _a === void 0 ? void 0 : _a.noTerminalOutput)) {
             this.log(''); // NOTE adding new line
             for (const { module, missingRefs } of allMissingRefs) {
                 if (!(0, isEmpty_1.default)(missingRefs)) {
@@ -190,7 +195,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                             get: (row) => {
                                 return chalk_1.default.red(typeof row.missingRefs === 'object' ? JSON.stringify(row.missingRefs) : row.missingRefs);
                             },
-                        } }, (((_a = tableValues[0]) === null || _a === void 0 ? void 0 : _a.fixStatus) ? this.fixStatus : {})), { treeStr: {
+                        } }, (((_b = tableValues[0]) === null || _b === void 0 ? void 0 : _b.fixStatus) ? this.fixStatus : {})), { treeStr: {
                             minWidth: 7,
                             header: 'Path',
                         } }), Object.assign({}, this.flags));

package/lib/base-command.js

@@ -3,12 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseCommand = void 0;
 const tslib_1 = require("tslib");
 const merge_1 = tslib_1.__importDefault(require("lodash/merge"));
+const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 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"));
+const noLog = (_message, _logType) => { };
 class BaseCommand extends cli_command_1.Command {
     constructor() {
         super(...arguments);
@@ -21,6 +23,7 @@ class BaseCommand extends cli_command_1.Command {
      * plugins, registering the configuration, and initializing the logger.
      */
     async init() {
+        var _a, _b, _c;
         await super.init();
         const { args, flags } = await this.parse({
             flags: this.ctor.flags,
@@ -31,11 +34,21 @@ class BaseCommand extends cli_command_1.Command {
         this.flags = flags;
         this.args = args;
         this.sharedConfig = Object.assign(this.sharedConfig, { flags: this.flags });
+        if (!(0, isEmpty_1.default)((_a = this.flags['external-config']) === null || _a === void 0 ? void 0 : _a.config)) {
+            this.sharedConfig = Object.assign(this.sharedConfig, (_b = this.flags['external-config']) === null || _b === void 0 ? void 0 : _b.config);
+        }
         cli_utilities_1.cliux.registerSearchPlugin();
         this.registerConfig();
         // Init logger
-        const logger = new util_1.Logger(this.sharedConfig);
-        this.log = logger.log.bind(logger);
+        if ((_c = this.flags['external-config']) === null || _c === void 0 ? void 0 : _c.noLog) {
+            this.log = noLog;
+            cli_utilities_1.ux.action.start = () => { };
+            cli_utilities_1.ux.action.stop = () => { };
+        }
+        else {
+            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

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

@@ -1,4 +1,5 @@
 import { FlagInput } from '@contentstack/cli-utilities';
+import { ConfigType } from '../../../../types';
 import { AuditBaseCommand } from '../../../../audit-base-command';
 export default class AuditFix extends AuditBaseCommand {
     static aliases: string[];
@@ -9,5 +10,8 @@ export default class AuditFix extends AuditBaseCommand {
      * 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>;
+    run(): Promise<void | {
+        config: ConfigType;
+        hasFix: boolean;
+    }>;
 }

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

@@ -3,17 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const config_1 = tslib_1.__importDefault(require("../../../../config"));
-const util_1 = require("../../../../util");
 const messages_1 = require("../../../../messages");
 const audit_base_command_1 = require("../../../../audit-base-command");
+const util_1 = require("../../../../util");
+const jsonFlag = (0, util_1.getJsonInputFlags)({ hidden: true });
 class AuditFix extends audit_base_command_1.AuditBaseCommand {
     /**
      * The `run` function is an asynchronous function that performs an audit on different modules
      * (content-types, global-fields, entries) and generates a report.
      */
     async run() {
+        var _a;
         try {
-            await this.start('cm:stacks:audit:fix');
+            const hasFix = await this.start('cm:stacks:audit:fix');
+            if ((_a = this.flags['external-config']) === null || _a === void 0 ? void 0 : _a.returnResponse) {
+                return { config: this.sharedConfig, hasFix };
+            }
         }
         catch (error) {
             this.log(error instanceof Error ? error.message : error, 'error');
@@ -56,4 +61,4 @@ AuditFix.flags = Object.assign({ 'report-path': cli_utilities_1.Flags.string({
         char: 'y',
         hidden: true,
         description: 'Use this flag to skip confirmation',
-    }) }, (0, util_1.getTableFlags)());
+    }), 'external-config': jsonFlag() }, (0, util_1.getTableFlags)());

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

@@ -16,6 +16,7 @@ class Audit extends audit_base_command_1.AuditBaseCommand {
             await this.start('cm:stacks:audit');
         }
         catch (error) {
+            console.trace(error);
             this.log(error instanceof Error ? error.message : error, 'error');
             cli_utilities_1.ux.action.stop('Process failed.!');
             this.exit(1);

package/lib/config/index.d.ts

@@ -1,6 +1,7 @@
 declare const config: {
     showTerminalOutput: boolean;
     skipRefs: string[];
+    skipFieldTypes: string[];
     modules: string[];
     'fix-fields': string[];
     moduleConfig: {

package/lib/config/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const config = {
     showTerminalOutput: true,
     skipRefs: ['sys_assets'],
+    skipFieldTypes: ['taxonomy'],
     modules: ['content-types', 'global-fields', 'entries'],
     'fix-fields': ['reference', 'global_field', 'json:rte', 'json:custom-field', 'blocks', 'group'],
     moduleConfig: {

package/lib/index.d.ts

@@ -1,2 +1,3 @@
-declare const _default: {};
-export default _default;
+import Audit from "./commands/cm/stacks/audit";
+import AuditFix from "./commands/cm/stacks/audit/fix";
+export { Audit, AuditFix };

package/lib/index.js

@@ -1,3 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {};
+exports.AuditFix = exports.Audit = void 0;
+const tslib_1 = require("tslib");
+const audit_1 = tslib_1.__importDefault(require("./commands/cm/stacks/audit"));
+exports.Audit = audit_1.default;
+const fix_1 = tslib_1.__importDefault(require("./commands/cm/stacks/audit/fix"));
+exports.AuditFix = fix_1.default;

package/lib/modules/content-types.js

@@ -61,11 +61,11 @@ class ContentType {
      * JSON to the specified file path.
      */
     async writeFixContent() {
-        var _a;
+        var _a, _b;
         let canWrite = true;
         if (!this.inMemoryFix && this.fix) {
-            if (!this.config.flags['copy-dir']) {
-                canWrite = (_a = this.config.flags.yes) !== null && _a !== void 0 ? _a : (await cli_utilities_1.ux.confirm(messages_1.commonMsg.FIX_CONFIRMATION));
+            if (!this.config.flags['copy-dir'] && !((_a = this.config.flags['external-config']) === null || _a === void 0 ? void 0 : _a.skipConfirm)) {
+                canWrite = (_b = this.config.flags.yes) !== null && _b !== void 0 ? _b : (await cli_utilities_1.ux.confirm(messages_1.commonMsg.FIX_CONFIRMATION));
             }
             if (canWrite) {
                 (0, fs_1.writeFileSync)((0, path_1.join)(this.folderPath, this.config.moduleConfig[this.moduleName].fileName), JSON.stringify(this.schema));
@@ -295,9 +295,11 @@ class ContentType {
             }
         })
             .filter((val) => {
-            if ((val === null || val === void 0 ? void 0 : val.schema) && (0, isEmpty_1.default)(val.schema))
+            if (this.config.skipFieldTypes.includes(val === null || val === void 0 ? void 0 : val.data_type))
+                return true;
+            if ((val === null || val === void 0 ? void 0 : val.schema) && (0, isEmpty_1.default)(val === null || val === void 0 ? void 0 : val.schema))
                 return false;
-            if ((val === null || val === void 0 ? void 0 : val.reference_to) && (0, isEmpty_1.default)(val.reference_to))
+            if ((val === null || val === void 0 ? void 0 : val.reference_to) && (0, isEmpty_1.default)(val === null || val === void 0 ? void 0 : val.reference_to))
                 return false;
             return !!val;
         });
@@ -380,8 +382,8 @@ class ContentType {
                 const refExist = (0, find_1.default)(this.gfSchema, { uid: reference_to });
                 if (!refExist) {
                     this.missingRefs[this.currentUid].push(refErrorObj);
+                    return block;
                 }
-                return refExist;
             }
             block.schema = this.runFixOnSchema(tree, block.schema);
             if ((0, isEmpty_1.default)(block.schema)) {

package/lib/modules/entries.js

@@ -48,8 +48,10 @@ class Entries {
                         const { uid, title } = entry;
                         this.currentUid = uid;
                         this.currentTitle = title;
-                        this.missingRefs[this.currentUid] = [];
-                        this.lookForReference([{ uid, name: title }], ctSchema, this.entries[entryUid]);
+                        if (!this.missingRefs[this.currentUid]) {
+                            this.missingRefs[this.currentUid] = [];
+                        }
+                        this.lookForReference([{ locale: code, uid, name: title }], ctSchema, this.entries[entryUid]);
                         this.log((0, messages_1.$t)(messages_1.auditMsg.SCAN_ENTRY_SUCCESS_MSG, {
                             title,
                             local: code,
@@ -103,9 +105,10 @@ class Entries {
      * JSON to the specified file path.
      */
     async writeFixContent(filePath, schema) {
+        var _a;
         let canWrite = true;
         if (this.fix) {
-            if (!this.config.flags['copy-dir']) {
+            if (!this.config.flags['copy-dir'] && !((_a = this.config.flags['external-config']) === null || _a === void 0 ? void 0 : _a.skipConfirm)) {
                 canWrite = this.config.flags.yes || (await cli_utilities_1.ux.confirm(messages_1.commonMsg.FIX_CONFIRMATION));
             }
             if (canWrite) {
@@ -330,6 +333,9 @@ class Entries {
         // NOTE Global field Fix
         schema.forEach((field) => {
             const { uid, data_type } = field;
+            if (!Object(entry).hasOwnProperty(uid)) {
+                return;
+            }
             switch (data_type) {
                 case 'global_field':
                     entry[uid] = this.fixGlobalFieldReferences([...tree, { uid: field.uid, name: field.display_name, data_type: field.data_type }], field, entry[uid]);
@@ -447,17 +453,19 @@ class Entries {
             });
         }
         else {
-            entry.children = entry.children
-                .map((child) => {
-                const refExist = this.jsonRefCheck(tree, field, child);
-                if (!refExist)
-                    return null;
-                if ((0, isEmpty_1.default)(child.children)) {
-                    child = this.fixJsonRteMissingReferences(tree, field, child);
-                }
-                return child;
-            })
-                .filter((val) => val);
+            if (entry === null || entry === void 0 ? void 0 : entry.children) {
+                entry.children = entry.children
+                    .map((child) => {
+                    const refExist = this.jsonRefCheck(tree, field, child);
+                    if (!refExist)
+                        return null;
+                    if (!(0, isEmpty_1.default)(child.children)) {
+                        child = this.fixJsonRteMissingReferences(tree, field, child);
+                    }
+                    return child;
+                })
+                    .filter((val) => val);
+            }
         }
         return entry;
     }

package/lib/types/utils.d.ts

@@ -16,3 +16,7 @@ export type PrintType = {
     bold?: boolean;
     color?: typeof Color;
 };
+export type JSONFlagOptions = {
+    hidden?: boolean;
+    description?: string;
+};

package/lib/util/flags.d.ts

@@ -1,4 +1,5 @@
-import { IFlags, IncludeFlags } from '../types';
+import { FlagDefinition } from '@contentstack/cli-utilities';
+import { IFlags, IncludeFlags, JSONFlagOptions } from '../types';
 /**
  * The function `getTableFlags` returns a set of table flags based on the specified columns, with
  * updated descriptions and help groups.
@@ -7,4 +8,11 @@ import { IFlags, IncludeFlags } from '../types';
  * @returns an object of type `IncludeFlags<IFlags, keyof IFlags>`.
  */
 declare function getTableFlags(columns?: (keyof IFlags)[]): IncludeFlags<IFlags, keyof IFlags>;
-export { getTableFlags };
+/**
+ * The function `getJsonInputFlags` returns a flag definition for parsing JSON input.
+ * @param {JSONFlagOptions} options - The `options` parameter is an object that contains the following
+ * properties:
+ * @returns a `FlagDefinition` object.
+ */
+declare function getJsonInputFlags(options?: JSONFlagOptions): FlagDefinition<Record<string, unknown>, Record<string, unknown>>;
+export { getTableFlags, getJsonInputFlags };

package/lib/util/flags.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTableFlags = void 0;
+exports.getJsonInputFlags = exports.getTableFlags = void 0;
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const messages_1 = require("../messages");
+const defaultJSONOptions = { description: 'Provide JSON input' };
 /**
  * The function `getTableFlags` returns a set of table flags based on the specified columns, with
  * updated descriptions and help groups.
@@ -24,3 +25,25 @@ function getTableFlags(columns = ['columns', 'sort', 'filter', 'csv', 'no-trunca
     return flags;
 }
 exports.getTableFlags = getTableFlags;
+/**
+ * The function `getJsonInputFlags` returns a flag definition for parsing JSON input.
+ * @param {JSONFlagOptions} options - The `options` parameter is an object that contains the following
+ * properties:
+ * @returns a `FlagDefinition` object.
+ */
+function getJsonInputFlags(options = defaultJSONOptions) {
+    const { hidden, description = defaultJSONOptions.description } = options;
+    return cli_utilities_1.Flags.custom({
+        hidden,
+        description,
+        parse: async (input, _opts) => {
+            try {
+                return JSON.parse(input);
+            }
+            catch (error) {
+                throw new Error('Invalid JSON');
+            }
+        },
+    });
+}
+exports.getJsonInputFlags = getJsonInputFlags;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.1",
+  "version": "1.3.3",
   "commands": {
     "cm:stacks:audit:fix": {
       "id": "cm:stacks:audit:fix",
@@ -98,6 +98,13 @@
           "hidden": true,
           "allowNo": false
         },
+        "external-config": {
+          "name": "external-config",
+          "type": "option",
+          "description": "Provide JSON input",
+          "hidden": true,
+          "multiple": false
+        },
         "columns": {
           "name": "columns",
           "type": "option",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",
@@ -19,7 +19,7 @@
   ],
   "dependencies": {
     "@contentstack/cli-command": "~1.2.16",
-    "@contentstack/cli-utilities": "~1.5.9",
+    "@contentstack/cli-utilities": "~1.5.10",
     "@oclif/plugin-help": "^5",
     "@oclif/plugin-plugins": "^4.1.9",
     "chalk": "^4.1.2",