@suitegeezus/suitecloud-cli 3.1.4

package/src/utils/FileUtils.js

@@ -0,0 +1,43 @@
+/*
+** Copyright (c) 2024 Oracle and/or its affiliates.  All rights reserved.
+** Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+*/
+'use strict';
+
+const fs = require('fs');
+const UTF8 = 'utf8';
+
+class FileUtils {
+	create(fileName, object) {
+		const content = JSON.stringify(object, null,'\t');
+
+		fs.writeFileSync(fileName, content, UTF8, function (error) {
+			if (error) {
+				// Using hardcoded message to avoid circular dependency as NodeTranslationService imports FileUtils
+				// TODO restore: throw NodeTranslationService.getMessage(ERRORS.WRITING_FILE, fileName, JSON.stringify(error));
+				// when NodeTranslationService is refactored to use node require to retrieve messages.json file
+				throw `There was a problem while creating the file ${fileName}.\n  Error: ${error}`
+			}
+		});
+	}
+
+	readAsJson(filePath) {
+		const content = fs.readFileSync(filePath, UTF8);
+		return JSON.parse(content);
+	}
+
+	readAsString(fileName) {
+		return fs.readFileSync(fileName, UTF8);
+	}
+
+	exists(fileName) {
+		return fs.existsSync(fileName);
+	}
+
+	createDirectory(dirPath) {
+		fs.mkdirSync(dirPath, { recursive: true })
+	}
+
+}
+
+module.exports = new FileUtils();

package/src/utils/SdkOperationResult.js

@@ -0,0 +1,68 @@
+/*
+ ** Copyright (c) 2024 Oracle and/or its affiliates.  All rights reserved.
+ ** Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+ */
+'use strict';
+const assert = require('assert');
+
+/* 
+// Sample SdkOperation results
+const SdkOperationResultSuccess =
+{
+	status: 'SUCCESS',
+	data: { needsReauthorization: true },
+	errorMessages: []
+}
+// data: could be of any shape/type of object
+
+const SdkOperationResultError =
+{
+	status: 'ERROR',
+	errorCode: 'SAS0001',
+	errorMessages: [
+		'The authentication process has been interrupted.\r\n' +
+		'The request was canceled.'
+	]
+}
+ */
+const STATUS = {
+	SUCCESS: 'SUCCESS',
+	ERROR: 'ERROR',
+}
+module.exports = class SdkOperationResult {
+	status;
+	data;
+	resultMessage;
+	errorCode;
+	errorMessages;
+
+	constructor(rawOpertionResult) {
+		assert(rawOpertionResult)
+		assert(rawOpertionResult.status, 'status is required when creating an SdkOperationResult object.')
+		// Note: not checking existence of rawOpertionResult.data when status === SUCCESS as refrehAuthorization command returns successfully without data
+		if (rawOpertionResult.status === STATUS.ERROR) {
+			assert(rawOpertionResult.errorMessages, 'errorMessages is required when SdkOperationResult is an error.');
+			assert(Array.isArray(rawOpertionResult.errorMessages), 'errorMessages property must be an array');
+		}
+		this.status = rawOpertionResult.status;
+		this.data = rawOpertionResult.data;
+		this.resultMessage = rawOpertionResult.resultMessage;
+		this.errorCode = rawOpertionResult.errorCode;
+		this.errorMessages = rawOpertionResult.errorMessages;
+	}
+
+	isSuccess() {
+		return this.status === STATUS.SUCCESS
+	}
+
+	get errorMessages() {
+		if (this.status === STATUS.SUCCESS) {
+			throw 'Accessing errorMessages on a successful SdkOperationResult'
+		}
+		this.errorMessages;
+	}
+
+	get resultMessage() {
+		return this.resultMessage ? this.resultMessage : '';
+	}
+}

package/src/utils/SdkOperationResultUtils.js

@@ -0,0 +1,20 @@
+/*
+ ** Copyright (c) 2024 Oracle and/or its affiliates.  All rights reserved.
+ ** Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+ */
+'use strict';
+
+module.exports = {
+	// TODO: we could be always wrapping OperationResults whenever we run sdkCommand using the sdkExecutor with the SdkOperationResult.js class
+	// and then use SdkOperationResult.isSuccess() method instead of (operationResult.status === SdkOperationResultUtils.STATUS.SUCCESS)
+	// Also the SdkOperationResult.js class allows to type using jsdocs the return type of any sdkCommand, as done in AuthenticationUtils.refreshAuthorization
+	STATUS: {
+		SUCCESS: 'SUCCESS',
+		ERROR: 'ERROR',
+	},
+
+	getResultMessage: (operationResult) => {
+		const { resultMessage } = operationResult;
+		return resultMessage ? resultMessage : '';
+	},
+};

package/src/utils/ValidationErrorsFormatter.js

@@ -0,0 +1,23 @@
+/*
+ ** Copyright (c) 2024 Oracle and/or its affiliates.  All rights reserved.
+ ** Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+ */
+'use strict';
+
+const NodeTranslationService = require('../services/NodeTranslationService');
+const TRANSLATION_KEYS = require('../services/TranslationKeys');
+const { lineBreak } = require('../loggers/LoggerOsConstants');
+const assert = require('assert');
+
+class ValidationErrorsFormatter {
+	formatErrors(validationErrors) {
+		assert(validationErrors);
+		assert(Array.isArray(validationErrors));
+
+		const errorMessageHeader = NodeTranslationService.getMessage(TRANSLATION_KEYS.COMMAND_OPTIONS.VALIDATION_ERRORS);
+		const validationErrorsString = validationErrors.join(lineBreak);
+		return `${errorMessageHeader}${lineBreak}${validationErrorsString}`;
+	}
+}
+
+module.exports = new ValidationErrorsFormatter();

package/src/utils/http/HttpConstants.js

@@ -0,0 +1,39 @@
+/*
+ ** Copyright (c) 2024 Oracle and/or its affiliates.  All rights reserved.
+ ** Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+ */
+ 'use strict';
+ 
+const ENCODING = {
+	BINARY: 'binary'
+}
+
+const EVENT = {
+	CLOSE: 'close',
+	CONNECT: 'connect',
+	DATA: 'data',
+	END: 'end',
+	ERROR: 'error',
+	TIMEOUT: 'timeout',
+};
+
+const HEADER = {
+	CONTENT_TYPE: 'content-type'
+}
+
+const PROTOCOL = {
+	HTTP: 'http:',
+	HTTPS: 'https:',
+};
+
+const METHOD = {
+	CONNECT: 'CONNECT',
+};
+
+module.exports = {
+	ENCODING,
+	EVENT,
+	HEADER,
+	PROTOCOL,
+	METHOD
+}

package/src/utils/http/ProxyAgent.js

@@ -0,0 +1,110 @@
+/*
+ ** Copyright (c) 2024 Oracle and/or its affiliates.  All rights reserved.
+ ** Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+ */
+'use strict';
+
+const http = require('http');
+const { URL } = require('url');
+const tls = require('tls');
+const net = require('net');
+const { PROTOCOL, EVENT, METHOD } = require('./HttpConstants');
+
+class ProxyAgent {
+	constructor(proxyString, agentOptions) {
+		this.proxyString = proxyString;
+		this.agentOptions = agentOptions;
+		this.initProxyURL();
+	}
+
+	initProxyURL() {
+		try {
+			const proxy = new URL(this.proxyString);
+			proxy.host = proxy.hostname || proxy.host;
+			proxy.port = +proxy.port || (proxy.protocol.toLowerCase() === PROTOCOL.HTTPS ? 443 : 80);
+			this.proxyURL = proxy;
+		} catch (err) {
+			throw new ProxyAgentError(`${err.input} ${ERROR_MESSAGES.BAD_PROXY}`);
+		}
+	}
+
+	addRequest(req, options) {
+		req.shouldKeepAlive = false;
+
+		this.createConnection(options)
+			.then((socket) => {
+				req.onSocket(socket);
+			})
+			.catch((err) => {
+				req.emit(EVENT.ERROR, err);
+			});
+	}
+
+	createConnection(options) {
+		return new Promise((resolve, reject) => {
+			const useSSL = options.protocol ? options.protocol.toLowerCase() === PROTOCOL.HTTPS : false;
+			if (useSSL && this.agentOptions.tunnel === true) {
+				if (options.port === 80) options.port = 443;
+				// CONNECT Method
+				const req = http.request({
+					host: this.proxyURL.hostname,
+					port: this.proxyURL.port,
+					auth: this.proxyURL.auth,
+					method: METHOD.CONNECT,
+					path: (options.hostname || options.host) + ':' + options.port,
+					headers: {
+						host: options.host,
+					},
+					timeout: this.agentOptions.timeout,
+				});
+
+				req.once(EVENT.CONNECT, (res, socket, head) => {
+					const tunnel = tls.connect({
+						socket: socket,
+						host: options.hostname || options.host,
+						port: +options.port,
+						servername: options.servername || options.host,
+					});
+					resolve(tunnel);
+				});
+
+				req.once(EVENT.TIMEOUT, () => {
+					req.destroy();
+					reject(new ProxyAgentError(ERROR_MESSAGES.CONNECT_TIMEOUT));
+				});
+
+				req.once(EVENT.ERROR, (err) => {
+					reject(err);
+				});
+
+				req.once(EVENT.CLOSE, () => {
+					reject(new ProxyAgentError(ERROR_MESSAGES.SERVER_CLOSE_EVENT));
+				});
+
+				req.end();
+			} else {
+				const socket = net.connect({
+					host: this.proxyURL.host,
+					port: this.proxyURL.port === '' ? 80 : +this.proxyURL.port,
+					auth: this.proxyURL.auth,
+				});
+				resolve(socket);
+			}
+		});
+	}
+}
+
+class ProxyAgentError extends Error {
+	constructor(message) {
+		super(message);
+		this.name = 'ProxyAgentError';
+	}
+}
+
+const ERROR_MESSAGES = {
+	CONNECT_TIMEOUT: 'CONNECT request timeout.',
+	SERVER_CLOSE_EVENT: 'Tunnel failed. Socket closed prematurely.',
+	BAD_PROXY: 'is not a valid value for proxy.'
+}
+
+module.exports = ProxyAgent;

package/src/validation/InteractiveAnswersValidator.js

@@ -0,0 +1,205 @@
+/*
+ ** Copyright (c) 2024 Oracle and/or its affiliates.  All rights reserved.
+ ** Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+ */
+'use strict';
+
+const path = require('path');
+const ApplicationConstants = require('../ApplicationConstants');
+const FileSystemService = require('../services/FileSystemService');
+const NodeTranslationService = require('../services/NodeTranslationService');
+
+const VALIDATION_RESULT_FAILURE = (validationError) => ({
+	result: false,
+	validationMessage: validationError,
+});
+const VALIDATION_RESULT_SUCCESS = { result: true };
+
+const { ANSWERS_VALIDATION_MESSAGES, COMMAND_OPTIONS } = require('../services/TranslationKeys');
+
+const ALPHANUMERIC_LOWERCASE_REGEX = '[a-z0-9]+';
+const ALPHANUMERIC_LOWERCASE_WHOLE_REGEX = `^${ALPHANUMERIC_LOWERCASE_REGEX}$`;
+const ALPHANUMERIC_HYPHEN_UNDERSCORE = /^[a-zA-Z0-9-_]+$/;
+const ALPHANUMERIC_HYPHEN_UNDERSCORE_EXTENDED = /^[a-zA-Z0-9-_ ]+([.]*[a-zA-Z0-9-_ ]+)*$/;
+const SCRIPT_ID_REGEX = /^[a-z0-9_]+$/;
+const STRING_WITH_SPACES_REGEX = /\s/;
+const XML_FORBIDDEN_CHARACTERS_REGEX = /[<>&'"]/;
+const FILENAME_FORBIDDEN_CHARACTERS_REGEX = /[\\/:*?"<>|]/;
+const DOT_AT_THE_END_OF_A_STRING_REGEX = /^.*\.$/;
+const PROJECT_VERSION_FORMAT_REGEX = '^\\d+(\\.\\d+){2}$';
+const SUITEAPP_ID_FORMAT_REGEX = '^' + ALPHANUMERIC_LOWERCASE_REGEX + '(\\.' + ALPHANUMERIC_LOWERCASE_REGEX + '){2}$';
+const SUITEAPP_PUBLISHER_ID_FORMAT_REGEX = '^' + ALPHANUMERIC_LOWERCASE_REGEX + '\\.' + ALPHANUMERIC_LOWERCASE_REGEX + '$';
+
+const FILE_EXTENSION_JS = '.js';
+
+module.exports = {
+	showValidationResults(value, ...funcs) {
+		for (const func of funcs) {
+			const validationOutput = func(value);
+			if (!validationOutput.result) {
+				return validationOutput.validationMessage;
+			}
+		}
+		return true;
+	},
+
+	validateFieldIsNotEmpty(fieldValue) {
+		return fieldValue !== ''
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.EMPTY_FIELD));
+	},
+
+	validateAlphanumericHyphenUnderscoreExtended(fieldValue) {
+		return ALPHANUMERIC_HYPHEN_UNDERSCORE_EXTENDED.test(fieldValue)
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.ALPHANUMERIC_HYPHEN_UNDERSCORE_EXTENDED));
+	},
+
+	validateFieldHasNoSpaces(fieldValue) {
+		return !STRING_WITH_SPACES_REGEX.test(fieldValue)
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.FIELD_HAS_SPACES));
+	},
+
+	validateFieldIsLowerCase(fieldOptionId, fieldValue) {
+		return fieldValue.match(ALPHANUMERIC_LOWERCASE_WHOLE_REGEX)
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.FIELD_NOT_LOWER_CASE, fieldOptionId));
+	},
+
+	validatePublisherId(fieldValue) {
+		return fieldValue.match(SUITEAPP_PUBLISHER_ID_FORMAT_REGEX)
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.PUBLISHER_ID_FORMAT));
+	},
+
+	validateProjectVersion(fieldValue) {
+		return fieldValue.match(PROJECT_VERSION_FORMAT_REGEX)
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.PROJECT_VERSION_FORMAT));
+	},
+
+	validateArrayIsNotEmpty(array) {
+		return array.length > 0
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.CHOOSE_OPTION));
+	},
+
+	validateSuiteApp(fieldValue) {
+		let notEmpty =
+			fieldValue !== ''
+				? VALIDATION_RESULT_SUCCESS
+				: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.EMPTY_FIELD));
+
+		if (notEmpty.result !== true) {
+			return notEmpty;
+		} else if (!fieldValue.match(SUITEAPP_ID_FORMAT_REGEX)) {
+			return VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.APP_ID_FORMAT));
+		}
+		return VALIDATION_RESULT_SUCCESS;
+	},
+
+	validateScriptId(fieldValue) {
+		let notEmpty =
+			fieldValue !== ''
+				? VALIDATION_RESULT_SUCCESS
+				: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.EMPTY_FIELD));
+
+		if (notEmpty.result !== true) {
+			return notEmpty;
+		} else if (!fieldValue.match(SCRIPT_ID_REGEX)) {
+			return VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.SCRIPT_ID_FORMAT));
+		}
+		return VALIDATION_RESULT_SUCCESS;
+	},
+
+	validateXMLCharacters(fieldValue) {
+		return !XML_FORBIDDEN_CHARACTERS_REGEX.test(fieldValue)
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.FIELD_HAS_XML_FORBIDDEN_CHARACTERS));
+	},
+
+	validateNotUndefined(value, optionName) {
+		return value !== undefined
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(COMMAND_OPTIONS.IS_MANDATORY, optionName));
+	},
+
+	validateProjectType(value) {
+		return [ApplicationConstants.PROJECT_SUITEAPP, ApplicationConstants.PROJECT_ACP].includes(value)
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.WRONG_PROJECT_TYPE));
+	},
+
+	validateSameAuthID(newAuthID, authID) {
+		return authID != newAuthID
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.CURRENT_AUTHID, newAuthID));
+	},
+
+	validateAuthIDNotInList(newAuthID, authIDsList) {
+		return !authIDsList.includes(newAuthID)
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.AUTH_ID_ALREADY_USED));
+	},
+
+	validateAlphanumericHyphenUnderscore(fieldValue) {
+		return ALPHANUMERIC_HYPHEN_UNDERSCORE.test(fieldValue)
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.ALPHANUMERIC_HYPHEN_UNDERSCORE));
+	},
+
+	validateMaximumLength(fieldValue, maxLength = 40) {
+		return fieldValue.length <= maxLength
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.MAX_LENGTH, maxLength));
+	},
+
+	validateNonProductionDomain(fieldValue) {
+		return !fieldValue.match(ApplicationConstants.DOMAIN.PRODUCTION.PRODUCTION_DOMAIN_REGEX) ||
+			fieldValue.match(ApplicationConstants.DOMAIN.NON_PRODUCTION.F_DOMAIN_REGEX) ||
+			fieldValue.match(ApplicationConstants.DOMAIN.NON_PRODUCTION.SNAP_DOMAIN_REGEX)
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.PRODUCTION_DOMAIN));
+	},
+
+	validateNonProductionAccountSpecificDomain(fieldValue) {
+		return !fieldValue.match(ApplicationConstants.DOMAIN.PRODUCTION.PRODUCTION_ACCOUNT_SPECIFIC_DOMAIN_REGEX) ||
+			fieldValue.match(ApplicationConstants.DOMAIN.NON_PRODUCTION.F_ACCOUNT_SPECIFIC_DOMAIN_REGEX) ||
+			fieldValue.match(ApplicationConstants.DOMAIN.NON_PRODUCTION.SNAP_ACCOUNT_SPECIFIC_DOMAIN_REGEX)
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.PRODUCTION_DOMAIN));
+	},
+
+	validateSuiteScriptFileDoesNotExist(parentFolderPath, filename) {
+		const filenameParts = path.parse(filename);
+		const filenameExtension = filenameParts.ext;
+		let filenameWithExtension = filename;
+		if (!filenameExtension) {
+			filenameWithExtension = filenameWithExtension + FILE_EXTENSION_JS;
+		}
+
+		const fileSystemService = new FileSystemService();
+		return !fileSystemService.fileExists(path.join(parentFolderPath, filenameWithExtension))
+			? VALIDATION_RESULT_SUCCESS
+			: VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.FILE_ALREADY_EXISTS));
+	},
+
+	validateFolderDoesNotExist(path) {
+		const fileSystemService = new FileSystemService();
+
+		return !fileSystemService.folderExists(path)
+			? VALIDATION_RESULT_SUCCESS
+			: NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.FOLDER_ALREADY_EXISTS, path);
+	},
+
+	validateFileName(filename) {
+		if (FILENAME_FORBIDDEN_CHARACTERS_REGEX.test(filename)) {
+			return VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.FILENAME_CONTAINS_FORBIDDEN_CHARACTERS));
+		}
+
+		return DOT_AT_THE_END_OF_A_STRING_REGEX.test(filename)
+			? VALIDATION_RESULT_FAILURE(NodeTranslationService.getMessage(ANSWERS_VALIDATION_MESSAGES.FILENAME_ENDS_WITH_PERIOD))
+			: VALIDATION_RESULT_SUCCESS;
+	},
+};