@provartesting/provardx-cli 0.0.1

package/README.md

@@ -0,0 +1,16 @@
+Run In dev provardx plugin on your local
+# Prerequisite:
+    Node, npm , nvm, yarn, Latest sf cli.
+# Steps to run on local:
+1. git clone the Repo from the feature branch: https://github.com/ProvarTesting/provardx-cli/
+2. Install the dependencies on your local from package.json: npm i
+3. Build the project using the command: yarn prepack
+4. Need to copy the bin/dev folder to run the commands locally in Dev. Plugin.
+5. To run the command manually: bin/dev ${command} (example: bin/dev sf provar config generate)
+6. To run NUTS on your local: yarn run test:nuts
+
+# Naming conventions used in provardx-cli development
+1. camelCase for fileNames/methodNames/Variables
+2. PascalCase for classNames.
+
+Also, we are adding the Copyright/licensing text over every ts file

package/lib/Utility/errorCode.d.ts

@@ -0,0 +1 @@
+export type ErrorCode = 'MISSING_FILE' | 'MALFORMED_FILE' | 'MISSING_PROPERTY' | 'MISSING_PROPERTIES' | 'INVALID_VALUES' | 'INVALID_VALUE' | 'MISSING_VALUE' | 'INVALID_FILE_EXTENSION' | 'GENERATE_OPERATION_DENIED' | 'INVALID_PATH' | 'INSUFFICIENT_PERMISSIONS' | 'INVALID_ARGUMENT' | 'INVALID_PROPERTY' | 'UNKNOWN_PROPERTY';

package/lib/Utility/errorCode.js

@@ -0,0 +1,9 @@
+"use strict";
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=errorCode.js.map

package/lib/Utility/errorCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorCode.js","sourceRoot":"","sources":["../../src/Utility/errorCode.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/lib/Utility/errorHandler.d.ts

@@ -0,0 +1,15 @@
+import { ErrorCode } from './errorCode';
+/**
+ * ErrorHandler to manage multiple errors thrown while execution of commands.
+ *
+ */
+export type Error = {
+    code: ErrorCode;
+    message: string;
+};
+export default class ErrorHandler {
+    private errors;
+    addErrorsToList(eCode: ErrorCode, eMessage: string): void;
+    getErrors(): Error[];
+    errorsToStringArray(): string[];
+}

package/lib/Utility/errorHandler.js

@@ -0,0 +1,27 @@
+"use strict";
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+class ErrorHandler {
+    constructor() {
+        this.errors = [];
+    }
+    addErrorsToList(eCode, eMessage) {
+        this.errors.push({
+            code: eCode,
+            message: eMessage,
+        });
+    }
+    getErrors() {
+        return this.errors;
+    }
+    errorsToStringArray() {
+        return this.errors.map((e) => `[${e.code}] ${e.message}`);
+    }
+}
+exports.default = ErrorHandler;
+//# sourceMappingURL=errorHandler.js.map

package/lib/Utility/errorHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorHandler.js","sourceRoot":"","sources":["../../src/Utility/errorHandler.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAcH,MAAqB,YAAY;IAAjC;QACU,WAAM,GAAY,EAAE,CAAC;IAgB/B,CAAC;IAdQ,eAAe,CAAC,KAAgB,EAAE,QAAgB;QACvD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACf,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,QAAQ;SAClB,CAAC,CAAC;IACL,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AAjBD,+BAiBC"}

package/lib/Utility/fileSupport.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Contains all the methods that deals with generic file related operations.
+ *
+ */
+export declare function generateFile(filePath: string): void;
+export declare function getExtension(filename: string): string;

package/lib/Utility/fileSupport.js

@@ -0,0 +1,51 @@
+"use strict";
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExtension = exports.generateFile = void 0;
+const fs = __importStar(require("fs"));
+const propertyFileContent_json_1 = __importDefault(require("../constants/propertyFileContent.json"));
+/**
+ * Contains all the methods that deals with generic file related operations.
+ *
+ */
+function generateFile(filePath) {
+    fs.writeFileSync(filePath, JSON.stringify(propertyFileContent_json_1.default, null, 3));
+}
+exports.generateFile = generateFile;
+function getExtension(filename) {
+    const i = filename.lastIndexOf('.');
+    return i < 0 ? '' : filename.substr(i);
+}
+exports.getExtension = getExtension;
+//# sourceMappingURL=fileSupport.js.map

package/lib/Utility/fileSupport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileSupport.js","sourceRoot":"","sources":["../../src/Utility/fileSupport.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,qGAAwE;AAExE;;;GAGG;AAEH,SAAgB,YAAY,CAAC,QAAgB;IAC3C,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,kCAAmB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAC3E,CAAC;AAFD,oCAEC;AAED,SAAgB,YAAY,CAAC,QAAgB;IAC3C,MAAM,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACpC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzC,CAAC;AAHD,oCAGC"}

package/lib/Utility/jsonSupport.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Custom logics from JSON manipulation.
+ *
+ */
+export declare function getNestedProperty(jsonData: any, property: string): any;
+export declare function checkNestedProperty(jsonData: any, property: string): boolean;
+export declare function setNestedProperty(jsonData: any, property: string, value: string | undefined): void;
+export declare function parseJSONString(jsonInput: string): any;

package/lib/Utility/jsonSupport.js

@@ -0,0 +1,55 @@
+"use strict";
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseJSONString = exports.setNestedProperty = exports.checkNestedProperty = exports.getNestedProperty = void 0;
+/**
+ * Custom logics from JSON manipulation.
+ *
+ */
+/* eslint-disable */
+function getNestedProperty(jsonData, property) {
+    const propertyPath = property.split('.');
+    for (let i = 0; i < propertyPath.length; i++) {
+        jsonData = jsonData[propertyPath[i]];
+    }
+    return jsonData;
+}
+exports.getNestedProperty = getNestedProperty;
+function checkNestedProperty(jsonData, property) {
+    const propertyPath = property.split('.');
+    for (const nestedProperty of propertyPath) {
+        if (!jsonData?.hasOwnProperty(nestedProperty)) {
+            return false;
+        }
+        jsonData = jsonData[nestedProperty];
+    }
+    return true;
+}
+exports.checkNestedProperty = checkNestedProperty;
+function setNestedProperty(jsonData, property, value) {
+    const propertyPath = property.split('.');
+    const propertyPathLength = propertyPath.length;
+    for (var i = 0; i < propertyPathLength - 1; i++) {
+        var nestedProperty = propertyPath[i];
+        if (!jsonData[nestedProperty])
+            jsonData[nestedProperty] = {};
+        jsonData = jsonData[nestedProperty];
+    }
+    jsonData[propertyPath[propertyPathLength - 1]] = value;
+}
+exports.setNestedProperty = setNestedProperty;
+function parseJSONString(jsonInput) {
+    try {
+        return JSON.parse(jsonInput);
+    }
+    catch (err) {
+        return jsonInput;
+    }
+}
+exports.parseJSONString = parseJSONString;
+//# sourceMappingURL=jsonSupport.js.map

package/lib/Utility/jsonSupport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonSupport.js","sourceRoot":"","sources":["../../src/Utility/jsonSupport.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH;;;GAGG;AAEH,oBAAoB;AACpB,SAAgB,iBAAiB,CAAC,QAAa,EAAE,QAAgB;IAC/D,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC5C,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;KACtC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAND,8CAMC;AAED,SAAgB,mBAAmB,CAAC,QAAa,EAAE,QAAgB;IACjE,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzC,KAAK,MAAM,cAAc,IAAI,YAAY,EAAE;QACzC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,cAAc,CAAC,EAAE;YAC7C,OAAO,KAAK,CAAC;SACd;QACD,QAAQ,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;KACrC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AATD,kDASC;AAED,SAAgB,iBAAiB,CAAC,QAAa,EAAE,QAAgB,EAAE,KAAyB;IAC1F,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzC,MAAM,kBAAkB,GAAG,YAAY,CAAC,MAAM,CAAC;IAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,kBAAkB,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC/C,IAAI,cAAc,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;QACrC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;YAAE,QAAQ,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC;QAC7D,QAAQ,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;KACrC;IACD,QAAQ,CAAC,YAAY,CAAC,kBAAkB,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;AACzD,CAAC;AATD,8CASC;AAED,SAAgB,eAAe,CAAC,SAAiB;IAC/C,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;KAC9B;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AAND,0CAMC"}

package/lib/Utility/propertyFileValidator.d.ts

@@ -0,0 +1,13 @@
+import { ValidatorResult } from 'jsonschema';
+import ErrorHandler, { Error } from './errorHandler';
+/**
+ * Contains code to load the config file and validation login for provardx-properties.json
+ *
+ */
+export default class PropertyFileValidator {
+    validationResults: ValidatorResult;
+    private errorHandler;
+    constructor(errorHandler: ErrorHandler);
+    validate(): Promise<boolean>;
+    getValidationErrors(): Error[];
+}

package/lib/Utility/propertyFileValidator.js

@@ -0,0 +1,103 @@
+"use strict";
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fileSystem = __importStar(require("fs"));
+const jsonschema_1 = require("jsonschema");
+const errorMessages_1 = require("../constants/errorMessages");
+const propertyFileSchema_1 = require("../constants/propertyFileSchema");
+const stringSupport_1 = require("./stringSupport");
+const provarConfig_1 = require("./provarConfig");
+/**
+ * Contains code to load the config file and validation login for provardx-properties.json
+ *
+ */
+class PropertyFileValidator {
+    constructor(errorHandler) {
+        this.errorHandler = errorHandler;
+    }
+    async validate() {
+        const config = await provarConfig_1.ProvarConfig.loadConfig(this.errorHandler);
+        const filePath = config.get('PROVARDX_PROPERTIES_FILE_PATH')?.toString();
+        const missingRequiredProperties = [];
+        const invalidPropertiesValue = [];
+        if (filePath === undefined || !fileSystem.existsSync(filePath)) {
+            this.errorHandler.addErrorsToList('MISSING_FILE', errorMessages_1.errorMessages.MISSINGFILEERROR);
+        }
+        else {
+            /* eslint-disable */
+            const jsonValidator = new jsonschema_1.Validator();
+            try {
+                this.validationResults = jsonValidator.validate(JSON.parse(fileSystem.readFileSync(filePath).toString()), propertyFileSchema_1.propertyFileSchema);
+                if (this.validationResults.errors.length > 0) {
+                    for (const validationError of this.validationResults.errors) {
+                        if (validationError.name === 'required') {
+                            let substring = (0, stringSupport_1.substringAfter)(validationError.property, '.');
+                            if (substring) {
+                                substring = substring.concat('.');
+                            }
+                            missingRequiredProperties.push(substring + validationError.argument);
+                        }
+                        else if (validationError.name === 'enum' || validationError.name === 'type') {
+                            invalidPropertiesValue.push((0, stringSupport_1.substringAfter)(validationError.property, '.'));
+                        }
+                    }
+                }
+            }
+            catch (errors) {
+                this.errorHandler.addErrorsToList('MALFORMED_FILE', errorMessages_1.errorMessages.MALFORMEDFILEERROR);
+                return false;
+            }
+            const missingPropertiesCount = missingRequiredProperties.length;
+            const invalidValuesCount = invalidPropertiesValue.length;
+            if (missingPropertiesCount > 1) {
+                this.errorHandler.addErrorsToList('MISSING_PROPERTIES', `The properties ${(0, stringSupport_1.addQuotesAround)(missingRequiredProperties).join(', ')} are missing.`);
+            }
+            else if (missingPropertiesCount == 1) {
+                this.errorHandler.addErrorsToList('MISSING_PROPERTY', `The property ${(0, stringSupport_1.addQuotesAround)(missingRequiredProperties)} is missing.`);
+            }
+            if (invalidValuesCount > 1) {
+                this.errorHandler.addErrorsToList('INVALID_VALUES', `The properties ${(0, stringSupport_1.addQuotesAround)(invalidPropertiesValue).join(', ')} values are not valid.`);
+            }
+            else if (invalidValuesCount == 1) {
+                this.errorHandler.addErrorsToList('INVALID_VALUE', `The property ${(0, stringSupport_1.addQuotesAround)(invalidPropertiesValue)} value is not valid.`);
+            }
+        }
+        if (this.errorHandler.getErrors().length > 0) {
+            return false;
+        }
+        return true;
+    }
+    getValidationErrors() {
+        return this.errorHandler.getErrors();
+    }
+}
+exports.default = PropertyFileValidator;
+//# sourceMappingURL=propertyFileValidator.js.map

package/lib/Utility/propertyFileValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"propertyFileValidator.js","sourceRoot":"","sources":["../../src/Utility/propertyFileValidator.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,+CAAiC;AACjC,2CAAwD;AACxD,8DAA2D;AAC3D,wEAAqE;AAErE,mDAAkE;AAClE,iDAA8C;AAE9C;;;GAGG;AAEH,MAAqB,qBAAqB;IAIxC,YAAmB,YAA0B;QAC3C,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,QAAQ;QACnB,MAAM,MAAM,GAAiB,MAAM,2BAAY,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC9E,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,+BAA+B,CAAC,EAAE,QAAQ,EAAE,CAAC;QAEzE,MAAM,yBAAyB,GAAa,EAAE,CAAC;QAC/C,MAAM,sBAAsB,GAAa,EAAE,CAAC;QAC5C,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YAC9D,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,cAAc,EAAE,6BAAa,CAAC,gBAAgB,CAAC,CAAC;SACnF;aAAM;YACL,oBAAoB;YACpB,MAAM,aAAa,GAAG,IAAI,sBAAS,EAAE,CAAC;YACtC,IAAI;gBACF,IAAI,CAAC,iBAAiB,GAAG,aAAa,CAAC,QAAQ,CAC7C,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,EACxD,uCAAkB,CACnB,CAAC;gBACF,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC5C,KAAK,MAAM,eAAe,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE;wBAC3D,IAAI,eAAe,CAAC,IAAI,KAAK,UAAU,EAAE;4BACvC,IAAI,SAAS,GAAG,IAAA,8BAAc,EAAC,eAAe,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;4BAC9D,IAAI,SAAS,EAAE;gCACb,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;6BACnC;4BACD,yBAAyB,CAAC,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;yBACtE;6BAAM,IAAI,eAAe,CAAC,IAAI,KAAK,MAAM,IAAI,eAAe,CAAC,IAAI,KAAK,MAAM,EAAE;4BAC7E,sBAAsB,CAAC,IAAI,CAAC,IAAA,8BAAc,EAAC,eAAe,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;yBAC5E;qBACF;iBACF;aACF;YAAC,OAAO,MAAW,EAAE;gBACpB,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,gBAAgB,EAAE,6BAAa,CAAC,kBAAkB,CAAC,CAAC;gBACtF,OAAO,KAAK,CAAC;aACd;YACD,MAAM,sBAAsB,GAAG,yBAAyB,CAAC,MAAM,CAAC;YAChE,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,MAAM,CAAC;YAEzD,IAAI,sBAAsB,GAAG,CAAC,EAAE;gBAC9B,IAAI,CAAC,YAAY,CAAC,eAAe,CAC/B,oBAAoB,EACpB,kBAAkB,IAAA,+BAAe,EAAC,yBAAyB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CACvF,CAAC;aACH;iBAAM,IAAI,sBAAsB,IAAI,CAAC,EAAE;gBACtC,IAAI,CAAC,YAAY,CAAC,eAAe,CAC/B,kBAAkB,EAClB,gBAAgB,IAAA,+BAAe,EAAC,yBAAyB,CAAC,cAAc,CACzE,CAAC;aACH;YAED,IAAI,kBAAkB,GAAG,CAAC,EAAE;gBAC1B,IAAI,CAAC,YAAY,CAAC,eAAe,CAC/B,gBAAgB,EAChB,kBAAkB,IAAA,+BAAe,EAAC,sBAAsB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAC7F,CAAC;aACH;iBAAM,IAAI,kBAAkB,IAAI,CAAC,EAAE;gBAClC,IAAI,CAAC,YAAY,CAAC,eAAe,CAC/B,eAAe,EACf,gBAAgB,IAAA,+BAAe,EAAC,sBAAsB,CAAC,sBAAsB,CAC9E,CAAC;aACH;SACF;QACD,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5C,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;IACvC,CAAC;CACF;AA7ED,wCA6EC"}

package/lib/Utility/provarConfig.d.ts

@@ -0,0 +1,11 @@
+import { Config } from '@salesforce/core';
+import ErrorHandler from './errorHandler';
+/**
+ * sfdxConfig extended class that deals with any operation over .sf/config.json.
+ * ex: what all properties we can add to config.json.
+ *
+ */
+export declare class ProvarConfig extends Config {
+    constructor();
+    static loadConfig(errorHandler: ErrorHandler): Promise<ProvarConfig>;
+}

package/lib/Utility/provarConfig.js

@@ -0,0 +1,42 @@
+"use strict";
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProvarConfig = void 0;
+const core_1 = require("@salesforce/core");
+/**
+ * sfdxConfig extended class that deals with any operation over .sf/config.json.
+ * ex: what all properties we can add to config.json.
+ *
+ */
+class ProvarConfig extends core_1.Config {
+    constructor() {
+        const option = { isGlobal: true, isState: true, filename: 'config.json', stateFolder: '.provardx' };
+        const allowedProeprties = [];
+        allowedProeprties.push({ key: 'PROVARDX_PROPERTIES_FILE_PATH', description: '' });
+        ProvarConfig.addAllowedProperties(allowedProeprties);
+        super(Object.assign({
+            isGlobal: true,
+        }, option));
+    }
+    static async loadConfig(errorHandler) {
+        try {
+            const config = await ProvarConfig.create();
+            await config.read();
+            return config;
+        }
+        catch (error) {
+            if (error instanceof core_1.SfError) {
+                // eslint-disable-next-line
+                errorHandler.addErrorsToList(error.code, error.message);
+            }
+            throw error;
+        }
+    }
+}
+exports.ProvarConfig = ProvarConfig;
+//# sourceMappingURL=provarConfig.js.map

package/lib/Utility/provarConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provarConfig.js","sourceRoot":"","sources":["../../src/Utility/provarConfig.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,2CAAuE;AAGvE;;;;GAIG;AAEH,MAAa,YAAa,SAAQ,aAAM;IACtC;QACE,MAAM,MAAM,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;QACpG,MAAM,iBAAiB,GAAyB,EAAE,CAAC;QACnD,iBAAiB,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,+BAA+B,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QAClF,YAAY,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACrD,KAAK,CACH,MAAM,CAAC,MAAM,CACX;YACE,QAAQ,EAAE,IAAI;SACf,EACD,MAAM,CACP,CACF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,YAA0B;QACvD,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE,CAAC;YAC3C,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,KAAK,YAAY,cAAO,EAAE;gBAC5B,2BAA2B;gBAC3B,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;aACzD;YACD,MAAM,KAAK,CAAC;SACb;IACH,CAAC;CACF;AA7BD,oCA6BC"}

package/lib/Utility/sfProvarCommandResult.d.ts

@@ -0,0 +1,12 @@
+import { Messages } from '@salesforce/core';
+import ErrorHandler, { Error } from './errorHandler';
+/**
+ * Declaring return type and populating return object for async run method of the commands.
+ *
+ */
+export type SfProvarCommandResult = {
+    success: boolean;
+    value?: string;
+    errors?: Error[];
+};
+export declare function populateResult(flags: any, errorHandler: ErrorHandler, messages: Messages<string>, log: Function, value?: string): SfProvarCommandResult;

package/lib/Utility/sfProvarCommandResult.js

@@ -0,0 +1,34 @@
+"use strict";
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.populateResult = void 0;
+/* eslint-disable */
+function populateResult(flags, errorHandler, messages, log, value) {
+    let result = { success: true };
+    if (errorHandler.getErrors().length > 0) {
+        const errorObjects = errorHandler.getErrors();
+        if (!flags['json']) {
+            throw messages.createError('error.MULTIPLE_ERRORS', errorHandler.errorsToStringArray());
+        }
+        result = {
+            success: false,
+            errors: errorObjects,
+        };
+    }
+    else {
+        messages.messages.has('success_message') ? log(messages.getMessage('success_message')) : '';
+        value != null ? log(value) : '';
+        result = {
+            success: true,
+            value: value,
+        };
+    }
+    return result;
+}
+exports.populateResult = populateResult;
+//# sourceMappingURL=sfProvarCommandResult.js.map

package/lib/Utility/sfProvarCommandResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sfProvarCommandResult.js","sourceRoot":"","sources":["../../src/Utility/sfProvarCommandResult.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAgBH,oBAAoB;AACpB,SAAgB,cAAc,CAC5B,KAAU,EACV,YAA0B,EAC1B,QAA0B,EAC1B,GAAa,EACb,KAAc;IAEd,IAAI,MAAM,GAA0B,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAEtD,IAAI,YAAY,CAAC,SAAS,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;QACvC,MAAM,YAAY,GAAY,YAAY,CAAC,SAAS,EAAE,CAAC;QACvD,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;YAClB,MAAM,QAAQ,CAAC,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC,mBAAmB,EAAE,CAAC,CAAC;SACzF;QACD,MAAM,GAAG;YACP,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,YAAY;SACrB,CAAC;KACH;SAAM;QACL,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5F,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAChC,MAAM,GAAG;YACP,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,KAAK;SACb,CAAC;KACH;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AA3BD,wCA2BC"}

package/lib/Utility/stringSupport.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Deals with the custom operations on strings.
+ *
+ */
+export declare function substringAfter(str: string, separator: string): string;
+export declare function addQuotesAround(array: string[]): string[];

package/lib/Utility/stringSupport.js

@@ -0,0 +1,32 @@
+"use strict";
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addQuotesAround = exports.substringAfter = void 0;
+/**
+ * Deals with the custom operations on strings.
+ *
+ */
+function substringAfter(str, separator) {
+    if (!str) {
+        return str;
+    }
+    if (separator == null) {
+        return '';
+    }
+    const pos = str.indexOf(separator);
+    if (pos === -1) {
+        return '';
+    }
+    return str.substring(pos + separator.length);
+}
+exports.substringAfter = substringAfter;
+function addQuotesAround(array) {
+    return array.map((item) => "'" + item + "'");
+}
+exports.addQuotesAround = addQuotesAround;
+//# sourceMappingURL=stringSupport.js.map

package/lib/Utility/stringSupport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringSupport.js","sourceRoot":"","sources":["../../src/Utility/stringSupport.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH;;;GAGG;AAEH,SAAgB,cAAc,CAAC,GAAW,EAAE,SAAiB;IAC3D,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,GAAG,CAAC;KACZ;IACD,IAAI,SAAS,IAAI,IAAI,EAAE;QACrB,OAAO,EAAE,CAAC;KACX;IACD,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACnC,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE;QACd,OAAO,EAAE,CAAC;KACX;IAED,OAAO,GAAG,CAAC,SAAS,CAAC,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;AAC/C,CAAC;AAbD,wCAaC;AACD,SAAgB,eAAe,CAAC,KAAe;IAC7C,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC,CAAC;AAC/C,CAAC;AAFD,0CAEC"}

package/lib/commands/sf/provar/config/generate.d.ts

@@ -0,0 +1,14 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+import { SfProvarCommandResult } from '../../../../Utility/sfProvarCommandResult';
+export default class SfProvarConfigGenerate extends SfCommand<SfProvarCommandResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        'properties-file': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'no-prompt': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    private errorHandler;
+    run(): Promise<SfProvarCommandResult>;
+    private generatePropertiesFile;
+}

package/lib/commands/sf/provar/config/generate.js

@@ -0,0 +1,102 @@
+"use strict";
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("fs"));
+const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
+const core_1 = require("@salesforce/core");
+const fileSupport_1 = require("../../../../Utility/fileSupport");
+const errorHandler_1 = __importDefault(require("../../../../Utility/errorHandler"));
+const sfProvarCommandResult_1 = require("../../../../Utility/sfProvarCommandResult");
+const errorMessages_1 = require("../../../../constants/errorMessages");
+/**
+ * Generates the boiler plate provardx-properties.json
+ *
+ */
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@provartesting/provardx-cli', 'sf.provar.config.generate');
+class SfProvarConfigGenerate extends sf_plugins_core_1.SfCommand {
+    constructor() {
+        super(...arguments);
+        this.errorHandler = new errorHandler_1.default();
+    }
+    async run() {
+        const { flags } = await this.parse(SfProvarConfigGenerate);
+        const PropertiesFileName = flags['properties-file'];
+        if ((0, fileSupport_1.getExtension)(PropertiesFileName) !== '.json') {
+            this.errorHandler.addErrorsToList('INVALID_FILE_EXTENSION', 'Only the .json file extension is supported.');
+        }
+        else if (fs.existsSync(PropertiesFileName) && !flags['no-prompt']) {
+            if (!(await this.confirm(messages.getMessage('PropertiesFileOverwritePromptConfirm')))) {
+                this.errorHandler.addErrorsToList('GENERATE_OPERATION_DENIED', errorMessages_1.errorMessages.GENERATE_OPERATION_DENIED);
+            }
+            else {
+                this.generatePropertiesFile(PropertiesFileName);
+            }
+        }
+        else {
+            this.generatePropertiesFile(PropertiesFileName);
+        }
+        return (0, sfProvarCommandResult_1.populateResult)(flags, this.errorHandler, messages, this.log.bind(this));
+    }
+    generatePropertiesFile(PropertiesFileName) {
+        try {
+            (0, fileSupport_1.generateFile)(PropertiesFileName);
+            /* eslint-disable */
+        }
+        catch (error) {
+            if (error.code === 'ENOENT') {
+                this.errorHandler.addErrorsToList('INVALID_PATH', errorMessages_1.errorMessages.INVALID_PATH);
+            }
+            else if (error.code === 'EPERM' || error.code === 'EACCES') {
+                this.errorHandler.addErrorsToList('INSUFFICIENT_PERMISSIONS', 'The user does not have permissions to create the file.');
+            }
+        }
+    }
+}
+SfProvarConfigGenerate.summary = messages.getMessage('summary');
+SfProvarConfigGenerate.description = messages.getMessage('description');
+SfProvarConfigGenerate.examples = messages.getMessages('examples');
+SfProvarConfigGenerate.flags = {
+    'properties-file': sf_plugins_core_1.Flags.string({
+        summary: messages.getMessage('flags.properties-file.summary'),
+        char: 'p',
+        required: true,
+    }),
+    'no-prompt': sf_plugins_core_1.Flags.boolean({
+        summary: messages.getMessage('flags.no-prompt.summary'),
+        char: 'n',
+    }),
+};
+exports.default = SfProvarConfigGenerate;
+//# sourceMappingURL=generate.js.map

package/lib/commands/sf/provar/config/generate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../../../src/commands/sf/provar/config/generate.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,iEAA+D;AAC/D,2CAA4C;AAC5C,iEAA6E;AAC7E,oFAA4D;AAC5D,qFAAkG;AAClG,uEAAoE;AAEpE;;;GAGG;AAEH,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,6BAA6B,EAAE,2BAA2B,CAAC,CAAC;AAEnG,MAAqB,sBAAuB,SAAQ,2BAAgC;IAApF;;QAiBU,iBAAY,GAAiB,IAAI,sBAAY,EAAE,CAAC;IAoC1D,CAAC;IAlCQ,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC3D,MAAM,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAEpD,IAAI,IAAA,0BAAY,EAAC,kBAAkB,CAAC,KAAK,OAAO,EAAE;YAChD,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,wBAAwB,EAAE,6CAA6C,CAAC,CAAC;SAC5G;aAAM,IAAI,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;YACnE,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,sCAAsC,CAAC,CAAC,CAAC,EAAE;gBACtF,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,2BAA2B,EAAE,6BAAa,CAAC,yBAAyB,CAAC,CAAC;aACzG;iBAAM;gBACL,IAAI,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;aACjD;SACF;aAAM;YACL,IAAI,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;SACjD;QAED,OAAO,IAAA,sCAAc,EAAC,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjF,CAAC;IAEO,sBAAsB,CAAC,kBAA0B;QACvD,IAAI;YACF,IAAA,0BAAY,EAAC,kBAAkB,CAAC,CAAC;YACjC,oBAAoB;SACrB;QAAC,OAAO,KAAU,EAAE;YACnB,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;gBAC3B,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,cAAc,EAAE,6BAAa,CAAC,YAAY,CAAC,CAAC;aAC/E;iBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;gBAC5D,IAAI,CAAC,YAAY,CAAC,eAAe,CAC/B,0BAA0B,EAC1B,wDAAwD,CACzD,CAAC;aACH;SACF;IACH,CAAC;;AAnDsB,8BAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,AAAjC,CAAkC;AACzC,kCAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,AAArC,CAAsC;AACjD,+BAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,AAAnC,CAAoC;AAE5C,4BAAK,GAAG;IAC7B,iBAAiB,EAAE,uBAAK,CAAC,MAAM,CAAC;QAC9B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC;QAC7D,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,WAAW,EAAE,uBAAK,CAAC,OAAO,CAAC;QACzB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;QACvD,IAAI,EAAE,GAAG;KACV,CAAC;CACH,AAV2B,CAU1B;kBAfiB,sBAAsB"}

package/lib/commands/sf/provar/config/get.d.ts

@@ -0,0 +1,10 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+import { SfProvarCommandResult } from '../../../../Utility/sfProvarCommandResult';
+export default class SfProvarConfigGet extends SfCommand<SfProvarCommandResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly strict = false;
+    private errorHandler;
+    run(): Promise<SfProvarCommandResult>;
+}