x-fidelity 3.2.0 → 3.3.1

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [3.3.1](https://github.com/zotoio/x-fidelity/compare/v3.3.0...v3.3.1) (2025-02-26)
+
+
+### Bug Fixes
+
+* **engine:** node 18 ([6c3e157](https://github.com/zotoio/x-fidelity/commit/6c3e157d0873dbd6148c568f213ee7ad997744bd))
+
+# [3.3.0](https://github.com/zotoio/x-fidelity/compare/v3.2.0...v3.3.0) (2025-02-22)
+
+
+### Bug Fixes
+
+* add required compareValue parameter to missingRequiredFiles operator ([65ea1b6](https://github.com/zotoio/x-fidelity/commit/65ea1b6ad93f50357eeb17929d52d1b3ee7c39cc))
+
+
+### Features
+
+* add missingRequiredFiles operator to plugin and update rule ([c9a8f79](https://github.com/zotoio/x-fidelity/commit/c9a8f79bc9d2d5db61f953ca22563442c276b659))
+* add required files plugin with configurable path checks ([3561c04](https://github.com/zotoio/x-fidelity/commit/3561c04a90add046c18b9a1e998dc94c24776ed0))
+* Enhance missingRequiredFiles operator with path validation and logging ([962cf38](https://github.com/zotoio/x-fidelity/commit/962cf387bcd8dfbb16d62ec842d11153602b967c))
+
 # [3.2.0](https://github.com/zotoio/x-fidelity/compare/v3.1.1...v3.2.0) (2025-02-20)
 
 

package/dist/core/cli.js

@@ -15,6 +15,18 @@ const prettyjson_1 = __importDefault(require("prettyjson"));
 exports.DEMO_CONFIG_PATH = path_1.default.resolve(__dirname, '../demoConfig');
 exports.options = commander_1.program.opts();
 function initCLI() {
+    const bannerArt = `\n
+=====================================
+ __    __          ________  ______ 
+| ##  | ##        | ######## \\######
+ \\##\\/  ## ______ | ##__      | ##  
+  >##  ## |      \\| ##  \\     | ##  
+ /  ####\\  \\######| ######    | ##  
+|  ## \\##\\        | ##       _| ##_ 
+| ##  | ##        | ##      |   ## \\
+ \\##   \\##         \\##       \\######
+------------------------------------- 
+`;
     // Ensure logger is initialized
     if (!logger_1.logger || typeof logger_1.logger.info !== 'function') {
         console.error({ msg: 'Logger is not properly initialized' });
@@ -40,7 +52,7 @@ function initCLI() {
         }
     });
     commander_1.program
-        .option("-d, --dir <directory>", "code directory to analyze. equivalent of directory argument")
+        .option("-d, --dir <directory>", "local git repo directory path to analyze. equivalent of directory argument")
         .option("-a, --archetype <archetype>", "The archetype to use for analysis", "node-fullstack")
         .option("-c, --configServer <configServer>", "The config server URL for fetching remote archetype configurations and rules. This takes precedence over localConfigPath.")
         .option("-o, --openaiEnabled <boolean>", "Enable OpenAI analysis", false)
@@ -53,7 +65,11 @@ function initCLI() {
         .option("-x, --examine <archetype>", "Examine the archetype configuration and rules")
         .version(package_json_1.version, "-v, --version", "Output the version number of xfidelity")
         .helpOption("-h, --help", "Display help for command")
-        .argument('[directory]', 'code directory to analyze');
+        .summary("CLI for analyzing codebases for architectural fidelity")
+        .usage("[directory] [options]")
+        .argument('[directory]', 'local git repo directory path to analyze')
+        .addHelpText('before', bannerArt)
+        .addHelpText('after', '-------------------------------------');
     commander_1.program.parse(process.argv);
     // Resolve paths
     const resolvePath = (inputPath) => {
@@ -90,18 +106,18 @@ function initCLI() {
         if (process.env.NODE_ENV !== 'test')
             commander_1.program.error(`LocalConfigPath does not exist or is invalid: ${error}`);
     }
-    const bannerArt = `\n
-=====================================
- __    __          ________  ______ 
-| ##  | ##        | ######## \\######
- \\##\\/  ## ______ | ##__      | ##  
-  >##  ## |      \\| ##  \\     | ##  
- /  ####\\  \\######| ######    | ##  
-|  ## \\##\\        | ##       _| ##_ 
-| ##  | ##        | ##      |   ## \\
- \\##   \\##         \\##       \\######
-------------------------------------- 
-`;
+    // const bannerArt = `\n
+    // =====================================
+    //  __    __          ________  ______ 
+    // | ##  | ##        | ######## \\######
+    //  \\##\\/  ## ______ | ##__      | ##  
+    //   >##  ## |      \\| ##  \\     | ##  
+    //  /  ####\\  \\######| ######    | ##  
+    // |  ## \\##\\        | ##       _| ##_ 
+    // | ##  | ##        | ##      |   ## \\
+    //  \\##   \\##         \\##       \\######
+    // ------------------------------------- 
+    // `;
     logger_1.logger.info(bannerArt);
     logger_1.logger.info(`\n${prettyjson_1.default.render({
         version: package_json_1.version,

package/dist/core/configManager.d.ts

@@ -1,5 +1,6 @@
 import { ExecutionConfig, GetConfigParams } from "../types/typeDefs";
 export declare const REPO_GLOBAL_CHECK = "REPO_GLOBAL_CHECK";
+export declare function repoDir(): any;
 export declare class ConfigManager {
     private static configs;
     private static MAX_RETRIES;

package/dist/core/configManager.js

@@ -46,6 +46,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigManager = exports.REPO_GLOBAL_CHECK = void 0;
+exports.repoDir = repoDir;
 const child_process_1 = require("child_process");
 const axiosClient_1 = require("../utils/axiosClient");
 const logger_1 = require("../utils/logger");
@@ -57,6 +58,9 @@ const path = __importStar(require("path"));
 const jsonSchemas_1 = require("../utils/jsonSchemas");
 const ruleUtils_1 = require("../utils/ruleUtils");
 exports.REPO_GLOBAL_CHECK = 'REPO_GLOBAL_CHECK';
+function repoDir() {
+    return cli_1.options.dir;
+}
 class ConfigManager {
     static getLoadedConfigs() {
         return Object.keys(ConfigManager.configs);

package/dist/core/engine/analyzer.js

@@ -71,6 +71,8 @@ function analyzeCodebase(params) {
         // add functions for dependency and file analysis
         engine.addFact('repoDependencyAnalysis', repoDependencyFacts_1.repoDependencyAnalysis);
         engine.addFact('repoFileAnalysis', repoFilesystemFacts_1.repoFileAnalysis);
+        engine.addFact('globalFileMetadata', fileData, { priority: 50 });
+        logger_1.logger.trace(fileData, 'Added globalFileData as fact');
         // add xfiConfig as a fact
         engine.addFact('repoXFIConfig', repoXFIConfig);
         logger_1.logger.info({ repoXFIConfig }, 'Added repoXFIConfig as fact');
@@ -85,22 +87,25 @@ function analyzeCodebase(params) {
         const finishMsg = `\n==========================\nCHECKS COMPLETED..\n==========================`;
         logger_1.logger.info(finishMsg);
         const totalFailureCount = (0, utils_1.countRuleFailures)(failures);
-        logger_1.logger.info(`${fileData.length} files analyzed. ${totalFailureCount} rule failures.`);
+        logger_1.logger.info(`${fileData.length - 1} files analyzed. ${totalFailureCount} rule failures.`);
         const fatalityCount = (0, utils_1.countRuleFailures)(failures, 'fatality');
         const warningCount = (0, utils_1.countRuleFailures)(failures, 'warning');
         const exemptCount = (0, utils_1.countRuleFailures)(failures, 'exempt');
         const errorCount = (0, utils_1.countRuleFailures)(failures, 'error');
         const finishTime = new Date().getTime();
+        const memoryUsage = process.memoryUsage();
+        logger_1.logger.info('Assemblying result metadata..');
         const resultMetadata = {
             XFI_RESULT: {
                 archetype,
                 telemetryData,
+                memoryUsage,
                 repoXFIConfig: repoXFIConfig,
                 issueDetails: failures,
                 startTime: telemetryData.startTime,
                 finishTime: finishTime,
                 durationSeconds: (finishTime - telemetryData.startTime) / 1000,
-                fileCount: fileData.length,
+                fileCount: fileData.length - 1,
                 totalIssues: totalFailureCount,
                 warningCount: warningCount,
                 fatalityCount: fatalityCount,
@@ -108,6 +113,7 @@ function analyzeCodebase(params) {
                 exemptCount: exemptCount,
                 options: cli_1.options,
                 repoPath,
+                repoUrl
             }
         };
         // Send telemetry for analysis end

package/dist/core/engine/analyzer.test.js

@@ -106,15 +106,17 @@ describe('analyzeCodebase', () => {
             XFI_RESULT: expect.objectContaining({
                 archetype: 'node-fullstack',
                 repoPath: 'mockRepoPath',
-                fileCount: 3,
+                fileCount: expect.any(Number),
                 totalIssues: expect.any(Number),
                 warningCount: expect.any(Number),
                 fatalityCount: expect.any(Number),
+                errorCount: expect.any(Number),
                 exemptCount: expect.any(Number),
                 issueDetails: expect.any(Array),
                 durationSeconds: expect.any(Number),
                 finishTime: expect.any(Number),
                 startTime: expect.any(Number),
+                memoryUsage: expect.any(Object),
                 options: expect.objectContaining({
                     archetype: 'node-fullstack',
                     configServer: '',
@@ -132,6 +134,7 @@ describe('analyzeCodebase', () => {
                     startTime: expect.any(Number),
                     userInfo: expect.any(Object),
                 }),
+                repoUrl: expect.any(String),
                 repoXFIConfig: expect.objectContaining({
                     sensitiveFileFalsePositives: expect.any(Array),
                 })
@@ -177,7 +180,7 @@ describe('analyzeCodebase', () => {
             XFI_RESULT: expect.objectContaining({
                 archetype: 'node-fullstack',
                 repoPath: 'mockRepoPath',
-                fileCount: 3,
+                fileCount: expect.any(Number),
                 totalIssues: 3,
                 warningCount: 0,
                 fatalityCount: 0,
@@ -202,8 +205,10 @@ describe('analyzeCodebase', () => {
                 durationSeconds: expect.any(Number),
                 finishTime: expect.any(Number),
                 startTime: expect.any(Number),
+                memoryUsage: expect.any(Object),
                 options: expect.any(Object),
                 telemetryData: expect.any(Object),
+                repoUrl: expect.any(String),
                 repoXFIConfig: expect.objectContaining({
                     sensitiveFileFalsePositives: expect.any(Array)
                 })
@@ -305,7 +310,7 @@ describe('analyzeCodebase', () => {
             XFI_RESULT: expect.objectContaining({
                 archetype: 'node-fullstack',
                 repoPath: 'mockRepoPath',
-                fileCount: 3,
+                fileCount: expect.any(Number),
                 totalIssues: 3,
                 warningCount: 0,
                 fatalityCount: 3,
@@ -321,8 +326,11 @@ describe('analyzeCodebase', () => {
                 durationSeconds: expect.any(Number),
                 finishTime: expect.any(Number),
                 startTime: expect.any(Number),
+                memoryUsage: expect.any(Object),
                 options: expect.any(Object),
                 telemetryData: expect.any(Object),
+                repoUrl: expect.any(String),
+                repoXFIConfig: expect.any(Object)
             })
         });
         expect(telemetry_1.sendTelemetry).toHaveBeenCalledTimes(2); // Start and end

package/dist/core/engine/engineRunner.js

@@ -20,13 +20,15 @@ function runEngineOnFiles(params) {
         const msg = `\n==========================\nRUNNING FILE CHECKS..\n==========================`;
         logger_1.logger.info(msg);
         const failures = [];
-        for (const file of fileData) {
+        const fileCount = fileData.length;
+        for (let i = 0; i < fileCount; i++) {
+            const file = fileData[i];
             if (file.fileName === configManager_1.REPO_GLOBAL_CHECK) {
                 const msg = `\n==========================\nRUNNING GLOBAL REPO CHECKS..\n==========================`;
                 logger_1.logger.info(msg);
             }
             else {
-                const msg = `analysing ${file.filePath} ...`;
+                const msg = `analysing (${i + 1} of ${fileCount - 1}) ${file.filePath} ...`;
                 logger_1.logger.info(msg);
             }
             const facts = {

package/dist/demoConfig/node-fullstack.json

@@ -7,20 +7,23 @@
         "nonStandardDirectoryStructure-global",
         "openaiAnalysisTop5-global",
         "openaiAnalysisA11y-global",
-        "invalidSystemIdConfigured-iterative"
+        "invalidSystemIdConfigured-iterative",
+        "missingRequiredFiles-global"
     ],
     "operators": [
         "fileContains",
         "outdatedFramework",
         "nonStandardDirectoryStructure",
         "openaiAnalysisHighSeverity",
-        "invalidRemoteValidation"
+        "invalidRemoteValidation",
+        "missingRequiredFiles"
     ],
     "facts": [
         "repoFilesystemFacts",
         "repoDependencyFacts",
         "openaiAnalysisFacts",
-        "remoteSubstringValidation"
+        "remoteSubstringValidation",
+        "missingRequiredFiles"
     ],
     "config": {
         "minimumDependencyVersions": {
@@ -44,7 +47,8 @@
         ],
         "whitelistPatterns": [
             ".*\\.(ts|tsx|js|jsx)$",
-            ".*\\/xfiTestMatch\\.json$"
+            ".*\\/xfiTestMatch\\.json$",
+            ".*\\/README\\.md$"
         ]
     }
 }

package/dist/demoConfig/rules/missingRequiredFiles-global-rule.json

@@ -0,0 +1,35 @@
+{
+    "name": "missingRequiredFiles-global",
+    "conditions": {
+        "all": [
+            {
+                "fact": "fileData",
+                "path": "$.fileName",
+                "operator": "equal",
+                "value": "REPO_GLOBAL_CHECK"
+            },
+            {
+                "fact": "missingRequiredFiles",
+                "params": {
+                    "requiredFiles": [
+                        "/README.md",
+                        "../../src/\\core//cli&.ts",
+                        "missingRequiredFiles-testing.js"
+                    ],
+                    "resultFact": "missingRequiredFilesResult"
+                },
+                "operator": "missingRequiredFiles",
+                "value": true
+            }
+        ]
+    },
+    "event": {
+        "type": "fatality",
+        "params": {
+            "message": "Required files are missing from the repository",
+            "details": {
+                "fact": "missingRequiredFilesResult"
+            }
+        }
+    }
+}

package/dist/demoConfig/rules/sensitiveLogging-iterative-rule.json

@@ -26,7 +26,8 @@
                         "(password|passphrase)",
                         "(private[_-]?key|ssh[_-]?key)",
                         "(oauth[_-]?token|jwt[_-]?token)",
-                        "db[_-]?password"
+                        "db[_-]?password",
+                        "(declare)"
                     ],
                     "resultFact": "fileResults"
                 },

package/dist/facts/repoDependencyFacts.js

@@ -76,7 +76,6 @@ function collectLocalDependencies() {
         else {
             logger_1.logger.error('No yarn.lock or package-lock.json found');
             process.exit(1);
-            throw new Error('Unsupported package manager');
         }
         logger_1.logger.trace(`collectLocalDependencies: ${(0, utils_1.safeStringify)(result)}`);
         return result;

package/dist/index.d.ts

@@ -1,7 +1,5 @@
 #!/usr/bin/env node
 export declare function main(): Promise<void>;
-export * from './utils/axiosClient';
-export * from './core/configManager';
+export { repoDir } from './core/configManager';
 export * from './utils/logger';
-export * from './core/engine/analyzer';
 export * from './types';

package/dist/index.js

@@ -49,11 +49,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.repoDir = void 0;
 exports.main = main;
 const logger_1 = require("./utils/logger");
 const cli_1 = require("./core/cli");
 if (require.main === module) {
-    (0, logger_1.initializeLogger)();
     (0, logger_1.setLogLevel)(process.env.XFI_LOG_LEVEL || 'info');
     (0, cli_1.initCLI)();
 }
@@ -70,7 +70,8 @@ const handleError = (error) => __awaiter(void 0, void 0, void 0, function* () {
             archetype: cli_1.options.archetype,
             repoPath: cli_1.options.dir,
             options: cli_1.options,
-            errorMessage: error.message
+            errorMessage: error.message,
+            errorStack: error.stack
         },
         timestamp: new Date().toISOString()
     }, executionLogPrefix);
@@ -100,38 +101,41 @@ function main() {
                         localConfigPath: cli_1.options.localConfigPath,
                         executionLogPrefix
                     });
+                    const resultString = JSON.stringify(resultMetadata);
+                    const prettyResult = prettyjson_1.default.render(resultMetadata.XFI_RESULT);
                     // if results are found, there were issues found in the codebase
                     if (resultMetadata.XFI_RESULT.totalIssues > 0) {
                         logger_1.logger.warn(`WARNING: lo-fi attributes detected in codebase. ${resultMetadata.XFI_RESULT.warningCount} are warnings, ${resultMetadata.XFI_RESULT.fatalityCount} are fatal.`);
-                        logger_1.logger.warn(JSON.stringify(resultMetadata));
+                        logger_1.logger.warn(resultString);
                         if (resultMetadata.XFI_RESULT.errorCount > 0) {
                             logger_1.logger.error(outcomeMessage(`THERE WERE ${resultMetadata.XFI_RESULT.errorCount} UNEXPECTED ERRORS!`));
-                            logger_1.logger.error(`\n${prettyjson_1.default.render(resultMetadata.XFI_RESULT)}\n\n`);
+                            logger_1.logger.error(`\n${prettyResult}\n\n`);
                             logger_1.logger.error(outcomeMessage(`THERE WERE ${resultMetadata.XFI_RESULT.errorCount} UNEXPECTED ERRORS!`));
                             process.exit(1);
                         }
                         if (resultMetadata.XFI_RESULT.fatalityCount > 0) {
                             logger_1.logger.error(outcomeMessage(`THERE WERE ${resultMetadata.XFI_RESULT.fatalityCount} FATAL ERRORS DETECTED TO BE IMMEDIATELY ADDRESSED!`));
-                            logger_1.logger.error(`\n${prettyjson_1.default.render(resultMetadata.XFI_RESULT)}\n\n`);
+                            logger_1.logger.error(`\n${prettyResult}\n\n`);
                             logger_1.logger.error(outcomeMessage(`THERE WERE ${resultMetadata.XFI_RESULT.fatalityCount} FATAL ERRORS DETECTED TO BE IMMEDIATELY ADDRESSED!`));
                             process.exit(1);
                         }
                         else {
                             logger_1.logger.warn(outcomeMessage('No fatal errors were found, however please review the following warnings.'));
-                            logger_1.logger.warn(`\n${prettyjson_1.default.render(resultMetadata.XFI_RESULT)}\n\n`);
+                            logger_1.logger.warn(`\n${prettyResult}\n\n`);
                             logger_1.logger.warn(outcomeMessage('No fatal errors were found, however please review the above warnings.'));
                         }
                     }
                     else {
                         logger_1.logger.info(outcomeMessage('SUCCESS! hi-fi codebase detected.'));
-                        logger_1.logger.info(JSON.stringify(resultMetadata));
-                        logger_1.logger.info(`\n${prettyjson_1.default.render(resultMetadata)}\n\n`);
+                        logger_1.logger.info(resultString);
+                        logger_1.logger.info(`\n${prettyResult}\n\n`);
                         logger_1.logger.info(outcomeMessage('SUCCESS! hi-fi codebase detected.'));
                     }
                 }
             }
         }
         catch (e) {
+            logger_1.logger.error(e, `Error during execution ${JSON.stringify(e.message)} \n ${e.stack}`);
             yield handleError(e).then(() => {
                 // give some time async ops to finish if not handled directly
                 if (process.env.NODE_ENV !== 'test') {
@@ -143,10 +147,9 @@ function main() {
         }
     });
 }
-__exportStar(require("./utils/axiosClient"), exports);
-__exportStar(require("./core/configManager"), exports);
+var configManager_1 = require("./core/configManager");
+Object.defineProperty(exports, "repoDir", { enumerable: true, get: function () { return configManager_1.repoDir; } });
 __exportStar(require("./utils/logger"), exports);
-__exportStar(require("./core/engine/analyzer"), exports);
 __exportStar(require("./types"), exports);
 if (require.main === module) {
     main();

package/dist/operators/nonStandardDirectoryStructure.js

@@ -16,7 +16,7 @@ const nonStandardDirectoryStructure = {
         if (filePath !== configManager_1.REPO_GLOBAL_CHECK) {
             return false;
         }
-        logger_1.logger.debug(`running global directory structure analysis..`);
+        logger_1.logger.info(`running global directory structure analysis..`);
         const repoPath = cli_1.options.dir || process.cwd();
         let result = false;
         // check the directory structure of the repo against the standard structure

package/dist/plugins/xfiPluginRequiredFiles/facts/missingRequiredFiles.d.ts

@@ -0,0 +1,2 @@
+import { FactDefn } from '../../../types/typeDefs';
+export declare const missingRequiredFiles: FactDefn;

package/dist/plugins/xfiPluginRequiredFiles/facts/missingRequiredFiles.js

@@ -0,0 +1,75 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.missingRequiredFiles = void 0;
+const logger_1 = require("../../../utils/logger");
+const configManager_1 = require("../../../core/configManager");
+const path_1 = __importDefault(require("path"));
+exports.missingRequiredFiles = {
+    name: 'missingRequiredFiles',
+    fn: (params, almanac) => __awaiter(void 0, void 0, void 0, function* () {
+        const result = { 'result': [] };
+        try {
+            // Get the required files from params
+            const requiredFiles = params.requiredFiles;
+            if (!Array.isArray(requiredFiles)) {
+                return { result: ['Required files parameter must be an array'] };
+            }
+            // Get globalFileData from almanac
+            const globalFileMetadata = yield almanac.factValue('globalFileMetadata');
+            if (!Array.isArray(globalFileMetadata)) {
+                return { result: ['Invalid globalFileData'] };
+            }
+            logger_1.logger.info('Executing missingRequiredFiles check', { requiredFiles });
+            // Get all file paths from the fileData fact
+            const repoFiles = new Set(globalFileMetadata.map((file) => {
+                logger_1.logger.trace(`${file.filePath} added to missingRequiredFiles check set`);
+                return file.filePath;
+            }));
+            // get the repo dir for the current repo as prefix
+            const repoDirPrefix = (0, configManager_1.repoDir)();
+            logger_1.logger.info(`Repo dir prefix: ${repoDirPrefix}`);
+            // Find which required files are missing
+            const missingFiles = requiredFiles.filter(file => {
+                let pathCheck = path_1.default.join(repoDirPrefix, file);
+                if (!pathCheck.startsWith(repoDirPrefix)) {
+                    logger_1.logger.error(`Potential malicious input detected: ${file}`);
+                    return true;
+                }
+                let result = !repoFiles.has(pathCheck);
+                if (result) {
+                    logger_1.logger.error(`Required file: ${pathCheck} is missing`);
+                }
+                else {
+                    logger_1.logger.info(`Required file: ${pathCheck} is present`);
+                }
+                return result;
+            });
+            if (missingFiles.length > 0) {
+                logger_1.logger.error(`Missing required files: ${JSON.stringify(missingFiles)}`);
+                result.result = missingFiles;
+            }
+            else {
+                logger_1.logger.debug('All required files present');
+            }
+            // Add the result to the almanac
+            almanac.addRuntimeFact(params.resultFact, result);
+            return result;
+        }
+        catch (error) {
+            logger_1.logger.error(`Error in missingRequiredFiles: ${error}`);
+            return result;
+        }
+    })
+};

package/dist/plugins/xfiPluginRequiredFiles/index.d.ts

@@ -0,0 +1 @@
+export { plugin } from './xfiPluginRequiredFiles';

package/dist/plugins/xfiPluginRequiredFiles/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.plugin = void 0;
+var xfiPluginRequiredFiles_1 = require("./xfiPluginRequiredFiles");
+Object.defineProperty(exports, "plugin", { enumerable: true, get: function () { return xfiPluginRequiredFiles_1.plugin; } });

package/dist/plugins/xfiPluginRequiredFiles/operators/missingRequiredFiles.d.ts

@@ -0,0 +1,2 @@
+import { OperatorDefn } from '../../../types/typeDefs';
+export declare const missingRequiredFiles: OperatorDefn;

package/dist/plugins/xfiPluginRequiredFiles/operators/missingRequiredFiles.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.missingRequiredFiles = void 0;
+const logger_1 = require("../../../utils/logger");
+exports.missingRequiredFiles = {
+    name: 'missingRequiredFiles',
+    fn: (factValue, compareValue) => {
+        var _a;
+        try {
+            logger_1.logger.debug('missingRequiredFiles: processing..');
+            if (((_a = factValue === null || factValue === void 0 ? void 0 : factValue.result) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+                logger_1.logger.debug('missingRequiredFiles: true');
+                return compareValue;
+            }
+            logger_1.logger.debug('missingRequiredFiles: false');
+            return !compareValue;
+        }
+        catch (e) {
+            logger_1.logger.error(`missingRequiredFiles: ${e}`);
+            return !compareValue;
+        }
+    }
+};

package/dist/plugins/xfiPluginRequiredFiles/operators/missingRequiredFiles.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/xfiPluginRequiredFiles/operators/missingRequiredFiles.test.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const missingRequiredFiles_1 = require("./missingRequiredFiles");
+const logger_1 = require("../../../utils/logger");
+jest.mock('../../../utils/logger', () => ({
+    logger: {
+        debug: jest.fn(),
+        error: jest.fn()
+    },
+}));
+describe('missingRequiredFiles', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    it('should return true when missing files are found', () => {
+        const factValue = {
+            result: [{ file: 'missing.txt' }]
+        };
+        const result = missingRequiredFiles_1.missingRequiredFiles.fn(factValue, true);
+        expect(result).toBe(true);
+        expect(logger_1.logger.debug).toHaveBeenCalledWith('missingRequiredFiles: true');
+    });
+    it('should return false when no missing files are found', () => {
+        const factValue = {
+            result: []
+        };
+        const result = missingRequiredFiles_1.missingRequiredFiles.fn(factValue, true);
+        expect(result).toBe(false);
+        expect(logger_1.logger.debug).toHaveBeenCalledWith('missingRequiredFiles: false');
+    });
+    it('should handle undefined input gracefully', () => {
+        const result = missingRequiredFiles_1.missingRequiredFiles.fn(undefined, true);
+        expect(result).toBe(false);
+        expect(logger_1.logger.debug).toHaveBeenCalledWith('missingRequiredFiles: false');
+    });
+    it('should handle errors gracefully', () => {
+        const factValue = null;
+        const result = missingRequiredFiles_1.missingRequiredFiles.fn(factValue, true);
+        expect(result).toBe(false);
+        expect(logger_1.logger.debug).toHaveBeenCalledWith('missingRequiredFiles: false');
+    });
+});

package/dist/plugins/xfiPluginRequiredFiles/xfiPluginRequiredFiles.d.ts

@@ -0,0 +1,3 @@
+import { XFiPlugin } from '../../types/typeDefs';
+declare const plugin: XFiPlugin;
+export { plugin };

package/dist/plugins/xfiPluginRequiredFiles/xfiPluginRequiredFiles.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.plugin = void 0;
+const missingRequiredFiles_1 = require("./facts/missingRequiredFiles");
+const missingRequiredFiles_2 = require("./operators/missingRequiredFiles");
+const plugin = {
+    name: 'xfiPluginRequiredFiles',
+    version: '1.0.0',
+    facts: [missingRequiredFiles_1.missingRequiredFiles],
+    operators: [missingRequiredFiles_2.missingRequiredFiles],
+    onError: (error) => ({
+        message: `Required files check error: ${error.message}`,
+        level: 'warning',
+        details: error.stack
+    })
+};
+exports.plugin = plugin;