@suitegeezus/suitecloud-cli 3.1.4

package/src/metadata/SdkCommandsMetadataPatch.json

@@ -0,0 +1,130 @@
+{
+	"account:manageauth": {
+		"options": {
+			"info": {
+					"description": "Prints the following information for the specified authentication ID: account ID, role ID, and url. Usage: account:manageauth --info [myAuthId]."
+			},
+			"list": {
+				"description": "Prints a list of all the configured authentication IDs. Usage: account:manageauth --list."
+			},
+			"remove": {
+				"description": "Removes an authentication ID. The tokens are not revoked in the account. Usage: account:manageauth --remove [myAuthId]."
+			},
+			"rename": {
+				"description": "Renames an authentication ID. You must specify it together with the renameto option. Usage: account:manageauth --rename [myAuthId] --renameto [newAuthId]."
+			},
+			"renameto": {
+				"description": "Specifies the new ID for an authentication ID. You must specify it together with the rename option. Usage: account:manageauth --rename [myAuthId] --renameto [newAuthId]."
+			}
+		}
+	},
+	"account:setup:ci": {
+		"description": "Sets up an account to use with SuiteCloud SDK and configures the default auth ID for the SuiteCloud project. No browser-based login required.\nTo change the default auth ID later, run: suitecloud account:setup:ci --select [myAuthId].",
+		"options": {
+			"domain": {
+				"name": "domain",
+				"option": "domain",
+				"description": "References the NetSuite domain of the account you want to use. You only need to specify the NetSuite domain if you are not using a production account.",
+				"mandatory": false,
+				"type": "SINGLE",
+				"usage": "",
+				"defaultOption": false,
+				"disableInIntegrationMode": false
+			},
+			"url": {
+				"disableInIntegrationMode": true
+			},
+			"account": {
+				"mandatory": false
+			},
+			"authid": {
+				"mandatory": false
+			},
+			"certificateid": {
+				"mandatory": false
+			},
+			"privatekeypath": {
+				"mandatory": false
+			},
+			"select": {
+				"name": "select",
+				"option": "select",
+				"description": "Selects an existing auth ID as the default for your SuiteCloud project. Usage account:setup:ci --select myAuthId.",
+				"mandatory": false,
+				"type": "SINGLE",
+				"usage": "",
+				"defaultOption": false,
+				"disableInIntegrationMode": false
+			}
+		}
+	},
+	"file:import": {
+		"options": {
+			"calledfromcomparefiles": {
+				"name": "calledfromcomparefiles",
+				"option": "calledfromcomparefiles",
+				"description": "Message displayed should be different if called from Compare Files.",
+				"mandatory": false,
+				"type": "FLAG",
+				"defaultOption": false,
+				"disableInIntegrationMode": true
+			},
+			"calledfromupdate": {
+				"name": "calledfromupdate",
+				"option": "calledfromupdate",
+				"description": "Message displayed should be different if called from Update File.",
+				"mandatory": false,
+				"type": "FLAG",
+				"defaultOption": false,
+				"disableInIntegrationMode": true
+			}
+		}
+	},
+	"object:update": {
+		"options": {
+			"includeinstances": {
+				"name": "includeinstances",
+				"option": "includeinstances",
+				"description": "Includes instances. This is only available for custom records.",
+				"mandatory": false,
+				"type": "FLAG",
+				"usage": "",
+				"defaultOption": true,
+				"disableInIntegrationMode": false
+			}
+		}
+	},
+	"project:create": {
+		"options": {
+			"includeunittesting": {
+				"name": "includeunittesting",
+				"type": "FLAG",
+				"disableInIntegrationMode": true
+			}
+		}
+	},
+	"project:deploy": {
+		"options": {
+			"dryrun": {
+				"name": "dryrun",
+				"option": "dryrun",
+				"description": "Runs a preview of your deploy process. Your project is not deployed.",
+				"mandatory": false,
+				"type": "FLAG",
+				"usage": "",
+				"defaultOption": false,
+				"disableInIntegrationMode": false
+			},
+			"applyinstallprefs": {
+				"alias": "a"
+			}
+		}
+	},
+	"project:validate": {
+		"options": {
+			"applyinstallprefs": {
+				"alias": "a"
+			}
+		}
+	}
+}

package/src/metadata/SuiteScriptModulesMetadata.js

@@ -0,0 +1,152 @@
+/*
+ ** 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 = [
+    {
+        id: "N/action"
+    },
+    {
+        id: "N/auth"
+    },
+    {
+        id: "N/cache"
+    },
+    {
+        id: "N/certificateControl"
+    },
+    {
+        id: "N/commerce"
+    },
+    {
+        id: "N/compress"
+    },
+    {
+        id: "N/config"
+    },
+    {
+        id: "N/crypto"
+    },
+    {
+        id: "N/crypto/certificate"
+    },
+    {
+        id: "N/currency"
+    },
+    {
+        id: "N/currentRecord"
+    },
+    {
+        id: "N/dataset"
+    },
+    {
+        id: "N/email"
+    },
+    {
+        id: "N/encode"
+    },
+    {
+        id: "N/error"
+    },
+    {
+        id: "N/file"
+    },
+    {
+        id: "N/format"
+    },
+    {
+        id: "N/format/i18n"
+    },
+    {
+        id: "N/http"
+    },
+    {
+        id: "N/https"
+    },
+    {
+        id: "N/https/clientCertificate"
+    },
+    {
+        id: "N/keyControl"
+    },
+    {
+        id: "N/log"
+    },
+    {
+        id: "N/piremoval"
+    },
+    {
+        id: "N/plugin"
+    },
+    {
+        id: "N/portlet"
+    },
+    {
+        id: "N/query"
+    },
+    {
+        id: "N/record"
+    },
+    {
+        id: "N/recordContext"
+    },
+    {
+        id: "N/redirect"
+    },
+    {
+        id: "N/render"
+    },
+    {
+        id: "N/runtime"
+    },
+    {
+        id: "N/search"
+    },
+    {
+        id: "N/sftp"
+    },
+    {
+        id: "N/sso"
+    },
+    {
+        id: "N/suiteAppInfo"
+    },
+    {
+        id: "N/task"
+    },
+    {
+        id: "N/task/accounting/recognition"
+    },
+    {
+        id: "N/transaction"
+    },
+    {
+        id: "N/translation"
+    },
+    {
+        id: "N/ui/dialog"
+    },
+    {
+        id: "N/ui/message"
+    },
+    {
+        id: "N/ui/serverWidget"
+    },
+    {
+        id: "N/url"
+    },
+    {
+        id: "N/util"
+    },
+    {
+        id: "N/workbook"
+    },
+    {
+        id: "N/workflow"
+    },
+    {
+        id: "N/xml"
+    }
+];

package/src/metadata/SuiteScriptTypesMetadata.js

@@ -0,0 +1,64 @@
+/*
+ ** 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 = [
+    {
+        id: "BundleInstallationScript",
+        name: "Bundle Installation Script",
+    },
+    {
+        id: "ClientScript",
+        name: "Client Script",
+    },
+    {
+        id: "CustomModule",
+        name: "Custom Module",
+    },
+    {
+        id: "plugintypeimpl",
+        name: "Custom Plug-in",
+    },
+    {
+        id: "customRecordAction",
+        name: "Custom Record Action Script",
+    },
+    {
+        id: "MapReduceScript",
+        name: "Map/Reduce Script",
+    },
+    {
+        id: "MassUpdateScript",
+        name: "Mass Update Script",
+    },
+    {
+        id: "Portlet",
+        name: "Portlet",
+    },
+    {
+        id: "Restlet",
+        name: "RESTlet",
+    },
+    {
+        id: "ScheduledScript",
+        name: "Scheduled Script",
+    },
+    {
+        id: "SDFInstallationScript",
+        name: "SDF Installation Script",
+    },
+    {
+        id: "Suitelet",
+        name: "Suitelet",
+    },
+    {
+        id: "UserEventScript",
+        name: "User Event Script"
+    },
+    {
+        id: "WorkflowActionScript",
+        name: "Workflow Action Script"
+    },
+];

package/src/services/AccountFileCabinetService.js

@@ -0,0 +1,86 @@
+/*
+ ** 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 SdkExecutionContext = require('../SdkExecutionContext');
+const SdkExecutor = require('../SdkExecutor');
+const NodeTranslationService = require('../services/NodeTranslationService');
+const executeWithSpinner = require('../ui/CliSpinner').executeWithSpinner;
+const CommandUtils = require('../utils/CommandUtils');
+const SdkOperationResultUtils = require('../utils/SdkOperationResultUtils');
+const { lineBreak } = require('../loggers/LoggerOsConstants');
+const {
+	COMMAND_IMPORTFILES: { MESSAGES },
+	COMMAND_LISTFILES: { LOADING_FOLDERS, GETTING_INERNAL_ERROR: GETTING_INTERNAL_ERROR },
+} = require('./TranslationKeys');
+
+const INTERMEDIATE_COMMANDS = {
+	LISTFILES: {
+		SDK_COMMAND: 'listfiles',
+		FILES_REFERENCE: 'File Cabinet files',
+		OPTIONS: {
+			AUTH_ID: 'authid',
+			FOLDER: 'folder',
+		},
+	},
+	LISTFOLDERS: {
+		SDK_COMMAND: 'listfolders',
+		FOLDERS_REFERENCE: 'File Cabinet folders',
+		OPTIONS: {
+			AUTH_ID: 'authid',
+		},
+	},
+};
+
+module.exports = class AccountFileCabinetService {
+	constructor(sdkPath, executionEnvironmentContext, authId) {
+		this._sdkExecutor = new SdkExecutor(sdkPath, executionEnvironmentContext);
+		this._authId = authId;
+	}
+
+	async getAccountFileCabinetFolders() {
+		const executionContext = SdkExecutionContext.Builder.forCommand(INTERMEDIATE_COMMANDS.LISTFOLDERS.SDK_COMMAND)
+			.integration()
+			.addParam(INTERMEDIATE_COMMANDS.LISTFOLDERS.OPTIONS.AUTH_ID, this._authId)
+			.build();
+
+		let listFoldersResult;
+		try {
+			listFoldersResult = await executeWithSpinner({
+				action: this._sdkExecutor.execute(executionContext),
+				message: NodeTranslationService.getMessage(LOADING_FOLDERS),
+			});
+		} catch (error) {
+			throw NodeTranslationService.getMessage(GETTING_INTERNAL_ERROR, INTERMEDIATE_COMMANDS.LISTFOLDERS.FOLDERS_REFERENCE, lineBreak, error);
+		}
+
+		if (listFoldersResult.status === SdkOperationResultUtils.STATUS.ERROR) {
+			throw listFoldersResult.errorMessages;
+		}
+		return listFoldersResult.data;
+	}
+
+	async listFiles(selectedFolder) {
+		// quote folder path to preserve spaces
+		const listFilesParams = {};
+		listFilesParams[INTERMEDIATE_COMMANDS.LISTFILES.OPTIONS.FOLDER] = CommandUtils.quoteString(selectedFolder);
+		listFilesParams[INTERMEDIATE_COMMANDS.LISTFILES.OPTIONS.AUTH_ID] = this._authId;
+
+		const executionContext = SdkExecutionContext.Builder.forCommand(INTERMEDIATE_COMMANDS.LISTFILES.SDK_COMMAND)
+			.integration()
+			.addParams(listFilesParams)
+			.build();
+		
+		try {
+			return await executeWithSpinner({
+				action: this._sdkExecutor.execute(executionContext),
+				message: NodeTranslationService.getMessage(MESSAGES.LOADING_FILES),
+			});
+		} catch (error) {
+			throw NodeTranslationService.getMessage(GETTING_INTERNAL_ERROR, INTERMEDIATE_COMMANDS.LISTFILES.FILES_REFERENCE, lineBreak, error);
+		}
+
+	}
+};

package/src/services/EnvironmentInformationService.js

@@ -0,0 +1,31 @@
+/*
+ ** 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 spawn = require('child_process').spawnSync;
+const { SDK_COMPATIBLE_JAVA_VERSIONS } = require('../ApplicationConstants');
+
+module.exports = class EnvironmentInformationService {
+	isInstalledJavaVersionValid() {
+		const installedJavaVersion = this.getInstalledJavaVersionString();
+		if (installedJavaVersion) {
+			for (const compatibleJavaVersion of SDK_COMPATIBLE_JAVA_VERSIONS) {
+				if (installedJavaVersion.startsWith(compatibleJavaVersion)) return true;
+			}
+			return false;
+		}
+		// in case there is no java installed or not available from path
+		return false;
+	}
+
+	getInstalledJavaVersionString() {
+		const childProcess = spawn('java', ['-version'], { shell: true });
+		const javaVersionOutput = childProcess.stderr.toString();
+		// The output should be similar to: java version "17.0.4" 2022-07-19 LTS
+		// It's expected to have the version surrounded by double quotes and only contain numbers and dots
+		const regex = /(?:\bjava version\b|\bopenjdk version\b) "([\d.]+)"/;
+		const matchResult = javaVersionOutput.match(regex);
+		return matchResult ? matchResult[1] : '';
+	}
+};

package/src/services/ExecutionContextService.js

@@ -0,0 +1,108 @@
+/*
+ ** 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_SETUPACCOUNT: {
+		ERRORS: {
+			BROWSER_BASED_NOT_ALLOWED,
+			MACHINE_TO_MACHINE_NOT_ALLOWED,
+			NON_CONSISTENT_AUTH_STATE,
+		},
+		MESSAGES: {
+			ROTATE_PASSWORD_WARNING
+		},
+	},
+
+} = require('./TranslationKeys');
+
+const {
+	ENV_VARS: {
+		SUITECLOUD_CI,
+		SUITECLOUD_CI_PASSKEY,
+		SUITECLOUD_FALLBACK_PASSKEY
+	},
+
+	LINKS: {
+		ERRORS: {
+			AUTHENTICATION_INFO,
+			AUTHENTICATION_FALLBACK_INFO,
+		},
+	},
+} = require('../ApplicationConstants');
+
+const NodeTranslationService = require('./NodeTranslationService');
+
+const ExecutionMode = {
+	CI: 'CI',
+	AUTH_CI_SETUP: 'AUTH_CI_SETUP',
+	DEV_MACHINE: 'DEV_MACHINE',
+	DEV_MACHINE_FALLBACK_PASSKEY: 'DEV_MACHINE_FALLBACK_PASSKEY',
+};
+
+const validateMachineToMachineAuthIsAllowed = () => {
+	const executionMode = getExecutionMode();
+	if (!(executionMode === ExecutionMode.CI || executionMode === ExecutionMode.AUTH_CI_SETUP)) {
+		throw NodeTranslationService.getMessage(MACHINE_TO_MACHINE_NOT_ALLOWED, AUTHENTICATION_INFO);
+	}
+};
+
+const validateBrowserBasedAuthIsAllowed = () => {
+	const executionMode = getExecutionMode();
+	if (!(executionMode === ExecutionMode.DEV_MACHINE || executionMode === ExecutionMode.DEV_MACHINE_FALLBACK_PASSKEY)) {
+		throw NodeTranslationService.getMessage(BROWSER_BASED_NOT_ALLOWED, AUTHENTICATION_INFO);
+	}
+};
+
+const getBrowserBasedWarningMessages = () => {
+	const executionMode = getExecutionMode();
+	if (executionMode === ExecutionMode.DEV_MACHINE_FALLBACK_PASSKEY) {
+		return NodeTranslationService.getMessage(ROTATE_PASSWORD_WARNING, AUTHENTICATION_FALLBACK_INFO);
+	}
+};
+
+const getExecutionMode = () => {
+	const envFallBackPassKey = process.env[SUITECLOUD_FALLBACK_PASSKEY];
+	const envCiPassKey = process.env[SUITECLOUD_CI_PASSKEY];
+	const envCi = process.env[SUITECLOUD_CI];
+
+	if (envCi && envCi !== '0') {
+		//CI
+		if (envCiPassKey && !envFallBackPassKey) {
+			return ExecutionMode.CI;
+		}
+	} else {
+		//Not CI
+		if (envCiPassKey && !envFallBackPassKey) {
+			return ExecutionMode.AUTH_CI_SETUP;
+		} else if (!envCiPassKey && !envFallBackPassKey) {
+			return ExecutionMode.DEV_MACHINE;
+		} else if (!envCiPassKey && envFallBackPassKey) {
+			return ExecutionMode.DEV_MACHINE_FALLBACK_PASSKEY;
+		}
+	}
+	//Default is non consistent states
+	throw NodeTranslationService.getMessage(NON_CONSISTENT_AUTH_STATE, getSuiteCloudEnvVariableList(), AUTHENTICATION_INFO);
+};
+
+const getSuiteCloudEnvVariableList = () => {
+	const envFallBackPassKey = process.env[SUITECLOUD_FALLBACK_PASSKEY];
+	const envCiPassKey = process.env[SUITECLOUD_CI_PASSKEY];
+	const envCi = process.env[SUITECLOUD_CI];
+
+	const variables = [];
+	if (envCi && envCi !== '0') {
+		variables.push(SUITECLOUD_CI);
+	}
+	if (envCiPassKey) {
+		variables.push(SUITECLOUD_CI_PASSKEY);
+	}
+	if (envFallBackPassKey) {
+		variables.push(SUITECLOUD_FALLBACK_PASSKEY);
+	}
+	return variables.join(', ');
+};
+
+module.exports = { validateBrowserBasedAuthIsAllowed, validateMachineToMachineAuthIsAllowed, getBrowserBasedWarningMessages };

package/src/services/FileCabinetService.js

@@ -0,0 +1,65 @@
+/*
+ ** 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 FileSystemService = require('./FileSystemService');
+const path = require('path');
+
+const SUITESCRIPTS_PATH = '/SuiteScripts';
+const TEMPLATES_PATH = '/Templates';
+const TEMPLATES_EMAIL_TEMPLATES_PATH = '/Templates/E-mail Templates';
+const TEMPLATES_MARKETING_TEMPLATES_PATH = '/Templates/Marketing Templates';
+const WEB_SITE_HOSTING_FILES_PATH = '/Web Site Hosting Files';
+const SUITEAPPS = '/SuiteApps';
+
+const UNRESTRICTED_PATHS = [
+	SUITESCRIPTS_PATH,
+	TEMPLATES_EMAIL_TEMPLATES_PATH,
+	TEMPLATES_MARKETING_TEMPLATES_PATH,
+	WEB_SITE_HOSTING_FILES_PATH,
+	SUITEAPPS,
+];
+
+module.exports = class FileCabinetService {
+	constructor(fileCabinetAbsolutePath) {
+		this._fileSystemService = new FileSystemService();
+		this._fileCabinetAbsolutePath = fileCabinetAbsolutePath;
+	}
+
+	getFileCabinetRelativePath(file) {
+		return file.replace(this._fileCabinetAbsolutePath, '').replace(/\\/g, '/');
+	}
+
+	getFileCabinetFolders() {
+		return this._getFileCabinetFolders(this._fileCabinetAbsolutePath);
+	}
+
+	_getFileCabinetFolders(parentFolder) {
+		const folders = [];
+		const getFoldersRecursively = source =>
+			this._fileSystemService.getFoldersFromDirectory(source).forEach(folder => {
+				folders.push(folder);
+				if (this._shouldEnterFolder(folder)) {
+					getFoldersRecursively(folder);
+				}
+			});
+		getFoldersRecursively(parentFolder);
+
+		return folders;
+	}
+
+	isUnrestrictedPath(path) {
+		return UNRESTRICTED_PATHS.some(unrestrictedPath => this.getFileCabinetRelativePath(path).startsWith(unrestrictedPath));
+	}
+
+	_shouldEnterFolder(folder) {
+		//Templates itself is restricted, but it has both restricted and unrestricted child folders, so we still need to get inside it.
+		return this._isTemplatesFolder(folder) || (this.isUnrestrictedPath(folder) && this._fileSystemService.getFilesFromDirectory(folder).length);
+	}
+
+	_isTemplatesFolder(folder) {
+		return folder === path.join(this._fileCabinetAbsolutePath, TEMPLATES_PATH);
+	}
+};