@suitegeezus/suitecloud-cli 3.1.4

package/src/commands/file/list/ListFilesCommand.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';
+
+const Command = require('../../Command');
+const ListFilesAction = require('./ListFilesAction');
+const ListFilesInputHandler = require('./ListFilesInputHandler');
+const ListFilesOutputHandler = require('./ListFilesOutputHandler');
+
+module.exports = {
+	create(options) {
+		return Command.Builder.withOptions(options)
+			.withAction(ListFilesAction)
+			.withInput(ListFilesInputHandler)
+			.withOutput(ListFilesOutputHandler)
+			.build();
+	}
+};

package/src/commands/file/list/ListFilesInputHandler.js

@@ -0,0 +1,55 @@
+/*
+ ** 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 { default: { prompt} } = require('inquirer');
+const CommandUtils = require('../../../utils/CommandUtils');
+const AccountFileCabinetService = require('../../../services/AccountFileCabinetService');
+const { getProjectDefaultAuthId } = require('../../../utils/AuthenticationUtils');
+const NodeTranslationService = require('../../../services/NodeTranslationService');
+const BaseInputHandler = require('../../base/BaseInputHandler');
+const SdkExecutor = require('../../../SdkExecutor');
+const {
+	COMMAND_LISTFILES: { ERRORS, SELECT_FOLDER },
+} = require('../../../services/TranslationKeys');
+
+const SUITE_SCRIPTS_FOLDER = '/SuiteScripts';
+
+module.exports = class ListFilesInputHandler extends BaseInputHandler {
+	constructor(options) {
+		super(options);
+
+		// TODO input handlers shouldn't execute actions. rework this
+		this._sdkExecutor = new SdkExecutor(this._sdkPath, this._executionEnvironmentContext);
+		this._accountFileCabinetService = new AccountFileCabinetService(
+			this._sdkPath,
+			this._executionEnvironmentContext,
+			 this._authId
+		);
+	}
+
+	async getParameters(params) {
+		const accountFileCabinetFolders = await this._accountFileCabinetService.getAccountFileCabinetFolders();
+		if (accountFileCabinetFolders.length === 0) {
+			throw NodeTranslationService.getMessage(ERRORS.NO_FOLDERS_FOUND);
+		}
+		const fileCabinetFolders = accountFileCabinetFolders.map((folderPath) => {
+			return {
+				name: folderPath,
+				value: folderPath,
+			};
+		});
+
+		return prompt([
+			{
+				type: CommandUtils.INQUIRER_TYPES.LIST,
+				name: this._commandMetadata.options.folder.name,
+				message: NodeTranslationService.getMessage(SELECT_FOLDER),
+				default: SUITE_SCRIPTS_FOLDER,
+				choices: fileCabinetFolders,
+			},
+		]);
+	}
+};

package/src/commands/file/list/ListFilesOutputHandler.js

@@ -0,0 +1,24 @@
+/*
+ ** 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 BaseOutputHandler = require('../../base/BaseOutputHandler');
+const ActionResultUtils = require('../../../utils/ActionResultUtils');
+
+module.exports = class ListFilesOutputHandler extends BaseOutputHandler {
+	constructor(options) {
+		super(options);
+	}
+
+	parse(actionResult) {
+		ActionResultUtils.logResultMessage(actionResult, this._log);
+
+		if (Array.isArray(actionResult.data)) {
+			actionResult.data.forEach((fileName) => {
+				this._log.result(fileName);
+			});
+		}
+		return actionResult;
+	}
+};

package/src/commands/file/upload/UploadFilesAction.js

@@ -0,0 +1,67 @@
+/*
+ ** 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 BaseAction = require('../../base/BaseAction');
+const CommandUtils = require('../../../utils/CommandUtils');
+const { executeWithSpinner } = require('../../../ui/CliSpinner');
+const SdkOperationResultUtils = require('../../../utils/SdkOperationResultUtils');
+const SdkExecutionContext = require('../../../SdkExecutionContext');
+const NodeTranslationService = require('../../../services/NodeTranslationService');
+const { ActionResult } = require('../../../services/actionresult/ActionResult');
+const { getProjectDefaultAuthId } = require('../../../utils/AuthenticationUtils');
+
+const {
+	COMMAND_UPLOADFILES: { MESSAGES },
+} = require('../../../services/TranslationKeys');
+
+const COMMAND_OPTIONS = {
+	PATHS: 'paths',
+	PROJECT: 'project',
+	AUTH_ID: 'authid',
+};
+
+module.exports = class UploadFilesAction extends BaseAction {
+	constructor(options) {
+		super(options);
+	}
+
+	preExecute(params) {
+		const { PATHS } = COMMAND_OPTIONS;
+
+		if (params.hasOwnProperty(PATHS)) {
+			if (Array.isArray(params[PATHS])) {
+				params[PATHS] = params[PATHS].map(CommandUtils.quoteString).join(' ');
+			} else {
+				params[PATHS] = CommandUtils.quoteString(params[PATHS]);
+			}
+		}
+		params[COMMAND_OPTIONS.PROJECT] = CommandUtils.quoteString(this._projectFolder);
+		return params;
+	}
+
+	async execute(params) {
+		try {
+			const executionContextUploadFiles = SdkExecutionContext.Builder.forCommand(this._commandMetadata.sdkCommand)
+				.integration()
+				.addParams(params)
+				.build();
+
+			const operationResult = await executeWithSpinner({
+				action: this._sdkExecutor.execute(executionContextUploadFiles),
+				message: NodeTranslationService.getMessage(MESSAGES.UPLOADING_FILES),
+			});
+			return operationResult.status === SdkOperationResultUtils.STATUS.SUCCESS
+				? ActionResult.Builder.withData(operationResult.data)
+					.withResultMessage(operationResult.resultMessage)
+					.withProjectFolder(this._projectFolder)
+					.withCommandParameters(params)
+					.build()
+				: ActionResult.Builder.withErrors(operationResult.errorMessages).withCommandParameters(params).build();
+		} catch (error) {
+			return ActionResult.Builder.withErrors([error]).build();
+		}
+	}
+};

package/src/commands/file/upload/UploadFilesCommand.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';
+
+const Command = require('../../Command');
+const UploadFilesAction = require('./UploadFilesAction');
+const UploadFilesInputHandler = require('./UploadFilesInputHandler');
+const UploadFilesOutputHandler = require('./UploadFilesOutputHandler');
+
+module.exports = {
+	create(options) {
+		return Command.Builder.withOptions(options)
+			.withAction(UploadFilesAction)
+			.withInput(UploadFilesInputHandler)
+			.withOutput(UploadFilesOutputHandler)
+			.build();
+	}
+};

package/src/commands/file/upload/UploadFilesInputHandler.js

@@ -0,0 +1,125 @@
+/*
+ ** 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 { default: { prompt } } = require('inquirer');
+const BaseInputHandler = require('../../base/BaseInputHandler');
+const CommandUtils = require('../../../utils/CommandUtils');
+const FileCabinetService = require('../../../services/FileCabinetService');
+const FileSystemService = require('../../../services/FileSystemService');
+const path = require('path');
+const NodeTranslationService = require('../../../services/NodeTranslationService');
+
+const {
+	COMMAND_UPLOADFILES: { QUESTIONS, MESSAGES, ERRORS },
+	NO,
+	YES,
+} = require('../../../services/TranslationKeys');
+
+const { FILE_CABINET } = require('../../../ApplicationConstants').FOLDERS;
+const { validateArrayIsNotEmpty, showValidationResults } = require('../../../validation/InteractiveAnswersValidator');
+
+const COMMAND_OPTIONS = {
+	PATHS: 'paths',
+	PROJECT: 'project',
+	AUTH_ID: 'authid',
+};
+
+const COMMAND_ANSWERS = {
+	SELECTED_FOLDER: 'selectedFolder',
+	OVERWRITE_FILES: 'overwrite',
+};
+
+module.exports = class UploadFilesInputHandler extends BaseInputHandler {
+	constructor(options) {
+		super(options);
+		this._fileSystemService = new FileSystemService();
+		this._fileCabinetService = new FileCabinetService(path.join(this._projectFolder, FILE_CABINET));
+	}
+
+	async getParameters(params) {
+		const selectFolderQuestion = this._generateSelectFolderQuestion();
+		const selectFolderAnswer = await prompt(selectFolderQuestion);
+
+		const selectFilesQuestion = this._generateSelectFilesQuestion(selectFolderAnswer.selectedFolder);
+		const selectFilesAnswer = await prompt(selectFilesQuestion);
+
+		const overwriteAnswer = await prompt([this._generateOverwriteQuestion()]);
+		if (overwriteAnswer[COMMAND_ANSWERS.OVERWRITE_FILES] === false) {
+			throw NodeTranslationService.getMessage(MESSAGES.CANCEL_UPLOAD);
+		}
+
+		return selectFilesAnswer;
+	}
+
+	_generateSelectFolderQuestion() {
+		const localFileCabinetSubFolders = this._fileCabinetService.getFileCabinetFolders();
+
+		const transformFoldersToChoicesFunc = (folder) => {
+			const name = this._fileCabinetService.getFileCabinetRelativePath(folder);
+
+			let disabledMessage = '';
+			if (!this._fileCabinetService.isUnrestrictedPath(name)) {
+				disabledMessage = NodeTranslationService.getMessage(MESSAGES.RESTRICTED_FOLDER);
+			} else if (!this._fileSystemService.getFilesFromDirectory(folder).length) {
+				disabledMessage = NodeTranslationService.getMessage(MESSAGES.EMPTY_FOLDER);
+			}
+
+			return {
+				name: name,
+				value: folder,
+				disabled: disabledMessage,
+			};
+		};
+
+		const localFileCabinetFoldersChoices = localFileCabinetSubFolders.map(transformFoldersToChoicesFunc);
+
+		if (!localFileCabinetFoldersChoices.some((choice) => !choice.disabled)) {
+			throw NodeTranslationService.getMessage(MESSAGES.NOTHING_TO_UPLOAD);
+		}
+
+		return [
+			{
+				message: NodeTranslationService.getMessage(QUESTIONS.SELECT_FOLDER),
+				type: CommandUtils.INQUIRER_TYPES.LIST,
+				name: COMMAND_ANSWERS.SELECTED_FOLDER,
+				choices: localFileCabinetFoldersChoices,
+			},
+		];
+	}
+
+	_generateSelectFilesQuestion(selectedFolder) {
+		const files = this._fileSystemService.getFilesFromDirectory(selectedFolder);
+
+		const transformFilesToChoicesFunc = (file) => {
+			const path = this._fileCabinetService.getFileCabinetRelativePath(file);
+			return { name: path, value: path };
+		};
+		const filesChoices = files.map(transformFilesToChoicesFunc);
+
+		return [
+			{
+				message: NodeTranslationService.getMessage(QUESTIONS.SELECT_FILES),
+				type: CommandUtils.INQUIRER_TYPES.CHECKBOX,
+				name: COMMAND_OPTIONS.PATHS,
+				choices: filesChoices,
+				validate: (fieldValue) => showValidationResults(fieldValue, validateArrayIsNotEmpty),
+			},
+		];
+	}
+
+	_generateOverwriteQuestion() {
+		return {
+			type: CommandUtils.INQUIRER_TYPES.LIST,
+			name: COMMAND_ANSWERS.OVERWRITE_FILES,
+			message: NodeTranslationService.getMessage(QUESTIONS.OVERWRITE_FILES),
+			default: true,
+			choices: [
+				{ name: NodeTranslationService.getMessage(YES), value: true },
+				{ name: NodeTranslationService.getMessage(NO), value: false },
+			],
+		};
+	}
+};

package/src/commands/file/upload/UploadFilesOutputHandler.js

@@ -0,0 +1,49 @@
+/*
+ ** 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 BaseOutputHandler = require('../../base/BaseOutputHandler');
+const FileCabinetService = require('../../../services/FileCabinetService');
+const NodeTranslationService = require('../../../services/NodeTranslationService');
+const { FILE_CABINET } = require('../../../ApplicationConstants').FOLDERS;
+const path = require('path');
+
+const {
+	COMMAND_UPLOADFILES: { OUTPUT },
+} = require('../../../services/TranslationKeys');
+
+const UPLOAD_FILE_RESULT_STATUS = {
+	SUCCESS: 'SUCCESS',
+	ERROR: 'ERROR',
+};
+
+module.exports = class UploadFilesOutputHandler extends BaseOutputHandler {
+	constructor(options) {
+		super(options);
+	}
+
+	parse(actionResult) {
+		const { data } = actionResult;
+
+		if (Array.isArray(data)) {
+			const successfulUploads = data.filter((result) => result.type === UPLOAD_FILE_RESULT_STATUS.SUCCESS);
+			const unsuccessfulUploads = data.filter((result) => result.type === UPLOAD_FILE_RESULT_STATUS.ERROR);
+			const localFileCabinetFolder = path.join(actionResult.projectFolder, FILE_CABINET);
+			this._fileCabinetService = new FileCabinetService(localFileCabinetFolder);
+			if (successfulUploads && successfulUploads.length) {
+				this._log.result(NodeTranslationService.getMessage(OUTPUT.FILES_UPLOADED));
+				successfulUploads.forEach((result) => {
+					this._log.result(this._fileCabinetService.getFileCabinetRelativePath(result.file.path));
+				});
+			}
+			if (unsuccessfulUploads && unsuccessfulUploads.length) {
+				this._log.warning(NodeTranslationService.getMessage(OUTPUT.FILES_NOT_UPLOADED));
+				unsuccessfulUploads.forEach((result) => {
+					this._log.warning(`${this._fileCabinetService.getFileCabinetRelativePath(result.file.path)}: ${result.errorMessage}`);
+				});
+			}
+		}
+		return actionResult;
+	}
+};

package/src/commands/object/create/CreateObjectAction.js

@@ -0,0 +1,33 @@
+/*
+ ** 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 TemplateKeys = require('../../../templates/TemplateKeys');
+const BaseAction = require('../../base/BaseAction');
+const FileSystemService = require('../../../services/FileSystemService');
+
+module.exports = class CreateObjectAction extends BaseAction {
+	constructor(options) {
+		super(options);
+		this._fileSystemService = new FileSystemService();
+	}
+
+	async execute(params) {
+		const createFilePromise = this._fileSystemService.createFileFromTemplate({
+			template: TemplateKeys.SCRIPTS['blankscript'],
+			destinationFolder: params.relatedfiledestinationfolder,
+			fileName: params.relatedfilename,
+			fileExtension: 'js',
+		});
+		const createObjectPromise = this._fileSystemService.createFileFromTemplate({
+			template: TemplateKeys.OBJECTS['commerceextension'],
+			destinationFolder: params.folder,
+			fileName: params.objectfilename,
+			fileExtension: 'xml',
+			bindings: [{ id: 'scriptid', value: params.type.prefix + params.objectfilename }],
+		});
+		await Promise.all([createFilePromise, createObjectPromise]);
+	}
+};

package/src/commands/object/create/CreateObjectCommand.js

@@ -0,0 +1,19 @@
+/*
+ ** 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 Command = require('../../Command');
+const CreateObjectAction = require('./CreateObjectAction');
+const CreateObjectInputHandler = require('./CreateObjectInputHandler');
+
+
+module.exports = {
+	create(options) {
+		return Command.Builder.withOptions(options)
+			.withAction(CreateObjectAction)
+			.withInput(CreateObjectInputHandler)
+			.build();
+	}
+};

package/src/commands/object/create/CreateObjectInputHandler.js

@@ -0,0 +1,82 @@
+/*
+ ** 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';
+/**
+ * The create:object command is no longer in use; as a result, this class is now deprecated. If there is a need to use this class in the future,
+ * the imports and implementation related to chalk and inquirer will need to be updated accordingly.
+ */
+const OBJECT_TYPES = require('../../../metadata/ObjectTypesMetadata');
+// const { prompt } = require('inquirer');
+// const chalk = require('chalk');
+const { join } = require('path');
+const { FOLDERS } = require('../../../ApplicationConstants');
+const BaseInputHandler = require('../../base/BaseInputHandler');
+const FileSystemService = require('../../../services/FileSystemService');
+
+module.exports = class CreateObjectInputHandler extends BaseInputHandler {
+	constructor(options) {
+		super(options);
+
+		this._fileSystemService = new FileSystemService();
+	}
+
+	async getParameters(params) {
+		const transformFoldersToChoicesFunc = (folder) => {
+			return { name: folder.replace(this._projectFolder, ''), value: folder };
+		};
+		const objectDirectoryChoices = this._fileSystemService
+			.getFoldersFromDirectory(join(this._projectFolder, FOLDERS.OBJECTS))
+			.map(transformFoldersToChoicesFunc);
+
+		// const mainAnswers = await prompt([
+		// 	{
+		// 		type: 'list',
+		// 		name: 'type',
+		// 		message: 'What object type would you like to create?',
+		// 		choices: OBJECT_TYPES,
+		// 	},
+		// 	{
+		// 		type: 'input',
+		// 		name: 'objectfilename',
+		// 		message: (answers_1) => `Please specify the filename for the ${chalk.green.bold(answers_1.type.name)} object`,
+		// 		transformer: (input_1, answers_2, flags) => `${answers_2.type.prefix}${input_1}.xml`,
+		// 	},
+		// 	{
+		// 		type: 'list',
+		// 		name: 'folder',
+		// 		message: (answers_4) =>
+		// 			`Where would you like to store the ${chalk.green.bold(answers_4.type.prefix + answers_4.objectfilename + '.xml')} file?`,
+		// 		choices: objectDirectoryChoices,
+		// 	},
+		// 	{
+		// 		type: 'confirm',
+		// 		name: 'createrelatedfiles',
+		// 		message: 'Would you like to also create associated files with this object?',
+		// 		when: (answers_6) => answers_6.type.hasRelatedFiles,
+		// 	},
+		// ]);
+		// if (mainAnswers.createrelatedfiles) {
+		// 	const fileCabinetDirectoryChoices = this._fileSystemService
+		// 		.getFoldersFromDirectory(join(this._projectFolder, FOLDERS.FILE_CABINET))
+		// 		.map(transformFoldersToChoicesFunc);
+		// 	const answers_10 = await prompt([
+		// 		{
+		// 			type: 'input',
+		// 			name: 'relatedfilename',
+		// 			message: 'Please specify the script filename',
+		// 			transformer: (input_3, answers_7, flags) => `${input_3}.js`,
+		// 		},
+		// 		{
+		// 			type: 'list',
+		// 			name: 'relatedfiledestinationfolder',
+		// 			message: (answers_9) => `Where would you like to store the ${chalk.green.bold(answers_9.relatedfilename)}.js file?`,
+		// 			choices: fileCabinetDirectoryChoices,
+		// 		},
+		// 	]);
+		// 	return { ...answers_10, ...mainAnswers };
+		// }
+		// return mainAnswers;
+	}
+};