@contentstack/cli-audit 1.9.0 → 1.11.0

package/lib/modules/index.d.ts

@@ -5,4 +5,5 @@ import Workflows from './workflows';
 import Extensions from './extensions';
 import CustomRoles from './custom-roles';
 import Assets from './assets';
-export { Entries, GlobalField, ContentType, Workflows, Extensions, Assets, CustomRoles };
+import FieldRule from './field_rules';
+export { Entries, GlobalField, ContentType, Workflows, Extensions, Assets, CustomRoles, FieldRule };

package/lib/modules/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomRoles = exports.Assets = exports.Extensions = exports.Workflows = exports.ContentType = exports.GlobalField = exports.Entries = void 0;
+exports.FieldRule = exports.CustomRoles = exports.Assets = exports.Extensions = exports.Workflows = exports.ContentType = exports.GlobalField = exports.Entries = void 0;
 const tslib_1 = require("tslib");
 const entries_1 = tslib_1.__importDefault(require("./entries"));
 exports.Entries = entries_1.default;
@@ -16,3 +16,5 @@ const custom_roles_1 = tslib_1.__importDefault(require("./custom-roles"));
 exports.CustomRoles = custom_roles_1.default;
 const assets_1 = tslib_1.__importDefault(require("./assets"));
 exports.Assets = assets_1.default;
+const field_rules_1 = tslib_1.__importDefault(require("./field_rules"));
+exports.FieldRule = field_rules_1.default;

package/lib/modules/workflows.js

@@ -106,7 +106,7 @@ class Workflows {
                     const { name, uid } = workflow;
                     const warningMessage = (0, messages_1.$t)(messages_1.commonMsg.WORKFLOW_FIX_WARN, { name, uid });
                     this.log(warningMessage, { color: 'yellow' });
-                    if (this.config.flags.yes || (await cli_utilities_1.ux.confirm(messages_1.commonMsg.WORKFLOW_FIX_CONFIRMATION))) {
+                    if (this.config.flags.yes || (await cli_utilities_1.cliux.confirm(messages_1.commonMsg.WORKFLOW_FIX_CONFIRMATION))) {
                         delete newWorkflowSchema[workflow.uid];
                     }
                 }
@@ -120,7 +120,7 @@ class Workflows {
             (this.config.flags['copy-dir'] ||
                 ((_a = this.config.flags['external-config']) === null || _a === void 0 ? void 0 : _a.skipConfirm) ||
                 this.config.flags.yes ||
-                (await cli_utilities_1.ux.confirm(messages_1.commonMsg.FIX_CONFIRMATION)))) {
+                (await cli_utilities_1.cliux.confirm(messages_1.commonMsg.FIX_CONFIRMATION)))) {
             (0, fs_1.writeFileSync)((0, path_1.join)(this.folderPath, this.config.moduleConfig[this.moduleName].fileName), JSON.stringify(newWorkflowSchema));
         }
     }

package/lib/types/common.d.ts

@@ -1,8 +1,6 @@
-import { ux } from "@contentstack/cli-utilities";
-type IFlags = typeof ux.table.Flags;
 type IncludeFlags<T, K extends keyof T> = Pick<T, K>;
 type CommandNames = 'cm:stacks:audit' | 'cm:stacks:audit:fix';
 interface AnyProperty {
     [propName: string]: any;
 }
-export { IFlags, IncludeFlags, CommandNames, AnyProperty };
+export { IncludeFlags, CommandNames, AnyProperty };

package/lib/types/content-types.d.ts

@@ -1,13 +1,15 @@
 import config from '../config';
 import { AnyProperty } from './common';
 import { ConfigType, LogFn } from './utils';
-type ContentTypeSchemaType = ReferenceFieldDataType | GlobalFieldDataType | ExtensionOrAppFieldDataType | JsonRTEFieldDataType | GroupFieldDataType | ModularBlocksDataType | SelectFeildStruct;
+type ContentTypeSchemaType = ReferenceFieldDataType | GlobalFieldDataType | ExtensionOrAppFieldDataType | JsonRTEFieldDataType | GroupFieldDataType | ModularBlocksDataType | SelectFeildStruct | any;
 type ContentTypeStruct = {
+    field_rules: any;
     uid: string;
     title: string;
     description: string;
     schema?: ContentTypeSchemaType[];
     mandatory: boolean;
+    multiple: boolean;
 };
 type ModuleConstructorParam = {
     log: LogFn;
@@ -28,6 +30,7 @@ type CommonDataTypeStruct = {
         allow_json_rte: boolean;
     } & AnyProperty;
     mandatory: boolean;
+    multiple: boolean;
 };
 type RefErrorReturnType = {
     name: string;
@@ -114,6 +117,22 @@ declare enum OutputColumn {
     'publish_environment' = "publish_environment",
     'asset_uid' = "asset_uid",
     'selectedValue' = "selectedValue",
-    'fixStatus' = "fixStatus"
+    'fixStatus' = "fixStatus",
+    'Content_type_uid' = "ct_uid",
+    'action' = "action",
+    'field_uid' = "field_uid",
+    'multiple' = "multiple"
 }
-export { CtConstructorParam, ContentTypeStruct, ModuleConstructorParam, ReferenceFieldDataType, GlobalFieldDataType, ExtensionOrAppFieldDataType, JsonRTEFieldDataType, GroupFieldDataType, ModularBlocksDataType, RefErrorReturnType, ModularBlocksSchemaTypes, ModularBlockType, OutputColumn, ContentTypeSchemaType, GlobalFieldSchemaTypes, WorkflowExtensionsRefErrorReturnType, SelectFeildStruct, };
+export { CtConstructorParam, ContentTypeStruct, ModuleConstructorParam, ReferenceFieldDataType, GlobalFieldDataType, ExtensionOrAppFieldDataType, JsonRTEFieldDataType, GroupFieldDataType, ModularBlocksDataType, RefErrorReturnType, ModularBlocksSchemaTypes, ModularBlockType, OutputColumn, ContentTypeSchemaType, GlobalFieldSchemaTypes, WorkflowExtensionsRefErrorReturnType, SelectFeildStruct, FieldRuleStruct, };
+type FieldRuleStruct = {
+    match_type: string;
+    actions: Array<{
+        action: string;
+        target_field: string;
+    }> | undefined;
+    conditions: Array<{
+        value: string;
+        operand_field: string;
+        operator: string;
+    }> | undefined;
+};

package/lib/types/content-types.js

@@ -31,5 +31,8 @@ var OutputColumn;
     OutputColumn["asset_uid"] = "asset_uid";
     OutputColumn["selectedValue"] = "selectedValue";
     OutputColumn["fixStatus"] = "fixStatus";
-})(OutputColumn || (OutputColumn = {}));
-exports.OutputColumn = OutputColumn;
+    OutputColumn["Content_type_uid"] = "ct_uid";
+    OutputColumn["action"] = "action";
+    OutputColumn["field_uid"] = "field_uid";
+    OutputColumn["multiple"] = "multiple";
+})(OutputColumn || (exports.OutputColumn = OutputColumn = {}));

package/lib/util/flags.d.ts

@@ -1,13 +1,5 @@
 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.
- * @param {(keyof IFlags)[]} columns - An optional array of column keys from the IFlags interface. The
- * default value is ['columns', 'sort', 'filter', 'csv', 'no-truncate'].
- * @returns an object of type `IncludeFlags<IFlags, keyof IFlags>`.
- */
-declare function getTableFlags(columns?: (keyof IFlags)[]): IncludeFlags<IFlags, keyof IFlags>;
+import { JSONFlagOptions } from '../types';
 /**
  * The function `getJsonInputFlags` returns a flag definition for parsing JSON input.
  * @param {JSONFlagOptions} options - The `options` parameter is an object that contains the following
@@ -15,4 +7,5 @@ declare function getTableFlags(columns?: (keyof IFlags)[]): IncludeFlags<IFlags,
  * @returns a `FlagDefinition` object.
  */
 declare function getJsonInputFlags(options?: JSONFlagOptions): FlagDefinition<Record<string, unknown>, Record<string, unknown>>;
-export { getTableFlags, getJsonInputFlags };
+declare const tableFlags: import("@contentstack/cli-utilities").FlagInput<import("@contentstack/cli-utilities").TableFlags>;
+export { getJsonInputFlags, tableFlags };

package/lib/util/flags.js

@@ -1,30 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getJsonInputFlags = exports.getTableFlags = void 0;
+exports.tableFlags = void 0;
+exports.getJsonInputFlags = getJsonInputFlags;
 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.
- * @param {(keyof IFlags)[]} columns - An optional array of column keys from the IFlags interface. The
- * default value is ['columns', 'sort', 'filter', 'csv', 'no-truncate'].
- * @returns an object of type `IncludeFlags<IFlags, keyof IFlags>`.
- */
-function getTableFlags(columns = ['columns', 'sort', 'filter', 'csv', 'no-truncate']) {
-    const flags = cli_utilities_1.ux.table.flags({
-        only: columns,
-    });
-    // NOTE Assign group and update Descriptions
-    columns.forEach((element) => {
-        var _a;
-        flags[element].helpGroup = 'TABLE';
-        const descriptionKey = `TABLE_${element.toUpperCase()}`;
-        flags[element].description = (_a = messages_1.tableColumnDescriptions[descriptionKey]) !== null && _a !== void 0 ? _a : flags[element].description;
-    });
-    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
@@ -46,4 +25,5 @@ function getJsonInputFlags(options = defaultJSONOptions) {
         },
     });
 }
-exports.getJsonInputFlags = getJsonInputFlags;
+const tableFlags = cli_utilities_1.CLITable.getTableFlags(['columns', 'sort', 'filter', 'csv', 'no-truncate', 'no-header', 'output']);
+exports.tableFlags = tableFlags;

package/lib/util/log.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.print = void 0;
+exports.print = print;
 const tslib_1 = require("tslib");
 const map_1 = tslib_1.__importDefault(require("lodash/map"));
 const winston_1 = tslib_1.__importDefault(require("winston"));
@@ -150,4 +150,3 @@ function print(printInput) {
     }).join(' ');
     cli_utilities_1.cliux.print(str);
 }
-exports.print = print;

package/oclif.manifest.json

@@ -1,18 +1,12 @@
 {
-  "version": "1.9.0",
   "commands": {
     "cm:stacks:audit:fix": {
-      "id": "cm:stacks:audit:fix",
-      "description": "Perform audits and fix possible errors in the exported Contentstack data.",
-      "strict": true,
-      "pluginName": "@contentstack/cli-audit",
-      "pluginAlias": "@contentstack/cli-audit",
-      "pluginType": "core",
       "aliases": [
         "audit:fix",
         "cm:stacks:audit:fix"
       ],
-      "hiddenAliases": [],
+      "args": {},
+      "description": "Perform audits and fix possible errors in the exported Contentstack data.",
       "examples": [
         "$ <%= config.bin %> <%= command.id %> --copy-dir",
         "$ <%= config.bin %> <%= command.id %> --report-path=<path> --copy-dir",
@@ -22,23 +16,42 @@
         "$ <%= config.bin %> <%= command.id %> --report-path=<path> --modules=content-types --filter=\"name=\"<filter-value>\" --copy-dir --copy-path=<path>"
       ],
       "flags": {
+        "config": {
+          "char": "c",
+          "description": "Path of the external config",
+          "helpGroup": "COMMON",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "data-dir": {
+          "char": "d",
+          "description": "Path where the data is stored",
+          "helpGroup": "COMMON",
+          "name": "data-dir",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "report-path": {
-          "name": "report-path",
-          "type": "option",
           "description": "Path to store the audit reports",
-          "multiple": false
+          "name": "report-path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         },
         "reference-only": {
-          "name": "reference-only",
-          "type": "boolean",
           "description": "Checks only for missing references.",
           "hidden": true,
-          "allowNo": false
+          "name": "reference-only",
+          "allowNo": false,
+          "type": "boolean"
         },
         "modules": {
-          "name": "modules",
-          "type": "option",
           "description": "Provide the list of modules to be audited",
+          "name": "modules",
+          "hasDynamicHelp": false,
           "multiple": true,
           "options": [
             "content-types",
@@ -47,28 +60,31 @@
             "extensions",
             "workflows",
             "custom-roles",
-            "assets"
-          ]
+            "assets",
+            "field-rules"
+          ],
+          "type": "option"
         },
         "copy-dir": {
-          "name": "copy-dir",
-          "type": "boolean",
           "description": "Create backup from the original data.",
-          "allowNo": false
+          "name": "copy-dir",
+          "allowNo": false,
+          "type": "boolean"
         },
         "copy-path": {
-          "name": "copy-path",
-          "type": "option",
-          "description": "Provide the path to backup the copied data",
-          "multiple": false,
           "dependsOn": [
             "copy-dir"
-          ]
+          ],
+          "description": "Provide the path to backup the copied data",
+          "name": "copy-path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         },
         "fix-only": {
-          "name": "fix-only",
-          "type": "option",
           "description": "Provide the list of fix options",
+          "name": "fix-only",
+          "hasDynamicHelp": false,
           "multiple": true,
           "options": [
             "reference",
@@ -78,82 +94,108 @@
             "blocks",
             "group",
             "content_types"
-          ]
+          ],
+          "type": "option"
         },
         "yes": {
-          "name": "yes",
-          "type": "boolean",
           "char": "y",
           "description": "Use this flag to skip confirmation",
           "hidden": true,
-          "allowNo": false
+          "name": "yes",
+          "allowNo": false,
+          "type": "boolean"
         },
         "external-config": {
-          "name": "external-config",
-          "type": "option",
           "description": "Provide JSON input",
           "hidden": true,
-          "multiple": false
+          "name": "external-config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         },
         "columns": {
-          "name": "columns",
-          "type": "option",
-          "description": "Show only the specified columns (comma-separated)",
+          "description": "Specify columns to display, comma-separated.",
           "helpGroup": "TABLE",
+          "name": "columns",
+          "hasDynamicHelp": false,
           "multiple": false,
-          "exclusive": [
-            "extended"
-          ]
+          "type": "option"
         },
         "sort": {
-          "name": "sort",
-          "type": "option",
-          "description": "Property to sort by (prepend '-' for descending)",
+          "description": "Sort the table by a column. Use \"-\" for descending.",
           "helpGroup": "TABLE",
-          "multiple": false
+          "name": "sort",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         },
         "filter": {
-          "name": "filter",
-          "type": "option",
-          "description": "Filter property by partial string matching. For example: name=foo",
+          "description": "Filter rows by a column value (e.g., name=foo).",
           "helpGroup": "TABLE",
-          "multiple": false
+          "name": "filter",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         },
         "csv": {
-          "name": "csv",
-          "type": "boolean",
-          "description": "The output is in the CSV format [alias: --output=csv]",
+          "description": "Output results in CSV format.",
           "helpGroup": "TABLE",
+          "name": "csv",
           "allowNo": false,
-          "exclusive": [
-            "no-truncate"
-          ]
+          "type": "boolean"
         },
         "no-truncate": {
+          "description": "Prevent truncation of long text in columns.",
+          "helpGroup": "TABLE",
           "name": "no-truncate",
-          "type": "boolean",
-          "description": "The output is not truncated to fit the screen",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "no-header": {
+          "description": "Hide table headers in output.",
           "helpGroup": "TABLE",
+          "name": "no-header",
           "allowNo": false,
-          "exclusive": [
-            "csv"
-          ]
+          "type": "boolean"
+        },
+        "output": {
+          "description": "Specify output format: csv, json, or yaml.",
+          "helpGroup": "TABLE",
+          "name": "output",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "csv",
+            "json",
+            "yaml"
+          ],
+          "type": "option"
         }
       },
-      "args": {}
-    },
-    "cm:stacks:audit": {
-      "id": "cm:stacks:audit",
-      "description": "Perform audits and find possible errors in the exported Contentstack data",
-      "strict": true,
-      "pluginName": "@contentstack/cli-audit",
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "cm:stacks:audit:fix",
       "pluginAlias": "@contentstack/cli-audit",
+      "pluginName": "@contentstack/cli-audit",
       "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "cm",
+        "stacks",
+        "audit",
+        "fix.js"
+      ]
+    },
+    "cm:stacks:audit": {
       "aliases": [
         "audit",
         "cm:stacks:audit"
       ],
-      "hiddenAliases": [],
+      "args": {},
+      "description": "Perform audits and find possible errors in the exported Contentstack data",
       "examples": [
         "$ <%= config.bin %> <%= command.id %>",
         "$ <%= config.bin %> <%= command.id %> --report-path=<path>",
@@ -162,23 +204,42 @@
         "$ <%= config.bin %> <%= command.id %> --report-path=<path> --modules=content-types --filter=\"name=\"<filter-value>\""
       ],
       "flags": {
+        "config": {
+          "char": "c",
+          "description": "Path of the external config",
+          "helpGroup": "COMMON",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "data-dir": {
+          "char": "d",
+          "description": "Path where the data is stored",
+          "helpGroup": "COMMON",
+          "name": "data-dir",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "report-path": {
-          "name": "report-path",
-          "type": "option",
           "description": "Path to store the audit reports",
-          "multiple": false
+          "name": "report-path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         },
         "reference-only": {
-          "name": "reference-only",
-          "type": "boolean",
           "description": "Checks only for missing references.",
           "hidden": true,
-          "allowNo": false
+          "name": "reference-only",
+          "allowNo": false,
+          "type": "boolean"
         },
         "modules": {
-          "name": "modules",
-          "type": "option",
           "description": "Provide the list of modules to be audited",
+          "name": "modules",
+          "hasDynamicHelp": false,
           "multiple": true,
           "options": [
             "content-types",
@@ -187,55 +248,87 @@
             "extensions",
             "workflows",
             "custom-roles",
-            "assets"
-          ]
+            "assets",
+            "field-rules"
+          ],
+          "type": "option"
         },
         "columns": {
-          "name": "columns",
-          "type": "option",
-          "description": "Show only the specified columns (comma-separated)",
+          "description": "Specify columns to display, comma-separated.",
           "helpGroup": "TABLE",
+          "name": "columns",
+          "hasDynamicHelp": false,
           "multiple": false,
-          "exclusive": [
-            "extended"
-          ]
+          "type": "option"
         },
         "sort": {
-          "name": "sort",
-          "type": "option",
-          "description": "Property to sort by (prepend '-' for descending)",
+          "description": "Sort the table by a column. Use \"-\" for descending.",
           "helpGroup": "TABLE",
-          "multiple": false
+          "name": "sort",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         },
         "filter": {
-          "name": "filter",
-          "type": "option",
-          "description": "Filter property by partial string matching. For example: name=foo",
+          "description": "Filter rows by a column value (e.g., name=foo).",
           "helpGroup": "TABLE",
-          "multiple": false
+          "name": "filter",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         },
         "csv": {
-          "name": "csv",
-          "type": "boolean",
-          "description": "The output is in the CSV format [alias: --output=csv]",
+          "description": "Output results in CSV format.",
           "helpGroup": "TABLE",
+          "name": "csv",
           "allowNo": false,
-          "exclusive": [
-            "no-truncate"
-          ]
+          "type": "boolean"
         },
         "no-truncate": {
+          "description": "Prevent truncation of long text in columns.",
+          "helpGroup": "TABLE",
           "name": "no-truncate",
-          "type": "boolean",
-          "description": "The output is not truncated to fit the screen",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "no-header": {
+          "description": "Hide table headers in output.",
           "helpGroup": "TABLE",
+          "name": "no-header",
           "allowNo": false,
-          "exclusive": [
-            "csv"
-          ]
+          "type": "boolean"
+        },
+        "output": {
+          "description": "Specify output format: csv, json, or yaml.",
+          "helpGroup": "TABLE",
+          "name": "output",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "csv",
+            "json",
+            "yaml"
+          ],
+          "type": "option"
         }
       },
-      "args": {}
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "cm:stacks:audit",
+      "pluginAlias": "@contentstack/cli-audit",
+      "pluginName": "@contentstack/cli-audit",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "cm",
+        "stacks",
+        "audit",
+        "index.js"
+      ]
     }
-  }
+  },
+  "version": "1.11.0"
 }