@suitegeezus/suitecloud-cli 3.1.4

package/src/services/actionresult/AuthenticateActionResult.js

@@ -0,0 +1,85 @@
+/*
+ ** 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');
+const { ActionResult, ActionResultBuilder, STATUS } = require('./ActionResult');
+
+class AuthenticateActionResult extends ActionResult {
+	constructor(parameters) {
+		super(parameters);
+		this._mode = parameters.mode;
+		this._authId = parameters.authId;
+		this._accountInfo = parameters.accountInfo;
+	}
+
+	validateParameters(parameters) {
+		assert(parameters);
+		assert(parameters.status, 'status is required when creating an ActionResult object.');
+		if (parameters.status === STATUS.SUCCESS) {
+			assert(parameters.mode, 'mode is required when ActionResult is a success.');
+			assert(parameters.authId, 'authId is required when ActionResult is a success.');
+			assert(parameters.accountInfo, 'accountInfo is required when ActionResult is a success.');
+		} else {
+			assert(parameters.errorMessages, 'errorMessages is required when ActionResult is an error.');
+			assert(Array.isArray(parameters.errorMessages), 'errorMessages argument must be an array');
+		}
+	}
+
+	get mode() {
+		return this._mode;
+	}
+
+	get authId() {
+		return this._authId;
+	}
+
+	get accountInfo() {
+		return this._accountInfo;
+	}
+
+	static get Builder() {
+		return new AuthenticateActionResultBuilder();
+	}
+}
+
+class AuthenticateActionResultBuilder extends ActionResultBuilder {
+	constructor() {
+		super();
+	}
+
+	success() {
+		this.status = STATUS.SUCCESS;
+		return this;
+	}
+
+	withMode(mode) {
+		this.mode = mode;
+		return this;
+	}
+
+	withAuthId(authId) {
+		this.authId = authId;
+		return this;
+	}
+
+	withAccountInfo(accountInfo) {
+		this.accountInfo = accountInfo;
+		return this;
+	}
+
+	build() {
+		return new AuthenticateActionResult({
+			status: this.status,
+			...(this.errorMessages && { errorMessages: this.errorMessages }),
+			...(this.mode && { mode: this.mode }),
+			...(this.authId && { authId: this.authId }),
+			...(this.accountInfo && { accountInfo: this.accountInfo }),
+			...(this.projectFolder && { projectFolder: this.projectFolder }),
+			...(this.commandParameters && { commandParameters: this.commandParameters }),
+		});
+	}
+}
+
+module.exports = AuthenticateActionResult;

package/src/services/actionresult/CreateProjectActionResult.js

@@ -0,0 +1,100 @@
+/*
+ ** 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');
+const { ActionResult, ActionResultBuilder } = require('./ActionResult');
+
+class CreateProjectActionResult extends ActionResult {
+	constructor(parameters) {
+		super(parameters);
+		this._projectType = parameters.projectType;
+		this._projectName = parameters.projectName;
+		this._projectDirectory = parameters.projectDirectory;
+		this._includeUnitTesting = parameters.includeUnitTesting;
+		this._npmPackageInitialized = parameters.npmPackageInitialized;
+	}
+
+	validateParameters(parameters) {
+		super.validateParameters(parameters);
+		if (this.isSuccess()) {
+			assert(parameters.projectDirectory, 'projectDirectory is required when ActionResult is a success.');
+			assert(parameters.projectType, 'projectType is required when ActionResult is a success.');
+		}
+	}
+
+	get projectType() {
+		return this._projectType;
+	}
+
+	get projectName() {
+		return this._projectName;
+	}
+
+	get projectDirectory() {
+		return this._projectDirectory;
+	}
+
+	get includeUnitTesting() {
+		return this._includeUnitTesting;
+	}
+
+	get npmPackageInitialized() {
+		return this._npmPackageInitialized;
+	}
+
+	static get Builder() {
+		return new CreateProjectActionResultBuilder();
+	}
+}
+
+class CreateProjectActionResultBuilder extends ActionResultBuilder {
+	constructor() {
+		super();
+	}
+
+	withProjectType(projectType) {
+		this.projectType = projectType;
+		return this;
+	}
+
+	withProjectName(projectName) {
+		this.projectName = projectName;
+		return this;
+	}
+
+	withProjectDirectory(projectDirectory) {
+		this.projectDirectory = projectDirectory;
+		return this;
+	}
+
+	withUnitTesting(includeUnitTesting) {
+		this.includeUnitTesting = includeUnitTesting;
+		return this;
+	}
+
+	withNpmPackageInitialized(npmPackageInitialized) {
+		this.npmPackageInitialized = npmPackageInitialized;
+		return this;
+	}
+
+	build() {
+		return new CreateProjectActionResult({
+			status: this.status,
+			...(this.data && { data: this.data }),
+			...(this.resultMessage && { resultMessage: this.resultMessage }),
+			...(this.errorMessages && { errorMessages: this.errorMessages }),
+			...(this.projectType && { projectType: this.projectType }),
+			...(this.projectName && { projectName: this.projectName }),
+			...(this.projectDirectory && { projectDirectory: this.projectDirectory }),
+			...(this.includeUnitTesting && { includeUnitTesting: this.includeUnitTesting }),
+			...(this.npmPackageInitialized && { npmPackageInitialized: this.npmPackageInitialized }),
+			...(this.projectFolder && { projectFolder: this.projectFolder }),
+			...(this.commandParameters && { commandParameters: this.commandParameters }),
+			...(this.commandFlags && { commandFlags: this.commandFlags }),
+		});
+	}
+}
+
+module.exports = CreateProjectActionResult;

package/src/services/actionresult/DeployActionResult.js

@@ -0,0 +1,69 @@
+/*
+ ** 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 { ActionResult, ActionResultBuilder } = require('./ActionResult');
+
+class DeployActionResult extends ActionResult {
+	constructor(parameters) {
+		super(parameters);
+		this._isServerValidation = !!parameters.isServerValidation;
+		this._appliedInstallationPreferences = !!parameters.appliedInstallationPreferences;
+		this._projectType = parameters.projectType;
+	}
+
+	get isServerValidation() {
+		return this._isServerValidation;
+	}
+
+	get appliedInstallationPreferences() {
+		return this._appliedInstallationPreferences;
+	}
+
+	get projectType() {
+		return this._projectType;
+	}
+
+	static get Builder() {
+		return new DeployActionResultBuilder();
+	}
+}
+
+class DeployActionResultBuilder extends ActionResultBuilder {
+	constructor() {
+		super();
+	}
+
+	withServerValidation(isServerValidation) {
+		this.isServerValidation = isServerValidation;
+		return this;
+	}
+
+	withAppliedInstallationPreferences(appliedInstallationPreferences) {
+		this.appliedInstallationPreferences = appliedInstallationPreferences;
+		return this;
+	}
+
+	withProjectType(projectType) {
+		this.projectType = projectType;
+		return this;
+	}
+
+	build() {
+		return new DeployActionResult({
+			status: this.status,
+			...(this.data && { data: this.data }),
+			...(this.resultMessage && { resultMessage: this.resultMessage }),
+			...(this.errorMessages && { errorMessages: this.errorMessages }),
+			...(this.isServerValidation && { isServerValidation: this.isServerValidation }),
+			...(this.appliedInstallationPreferences && { appliedInstallationPreferences: this.appliedInstallationPreferences }),
+			...(this.projectType && { projectType: this.projectType }),
+			...(this.projectFolder && { projectFolder: this.projectFolder }),
+			...(this.commandParameters && { commandParameters: this.commandParameters }),
+			...(this.commandFlags && { commandFlags: this.commandFlags }),
+		});
+	}
+}
+
+module.exports = DeployActionResult;

package/src/services/actionresult/HelloActionResult.js

@@ -0,0 +1,13 @@
+
+const { ActionResult,
+	ActionResultBuilder,
+	STATUS
+} = require('./ActionResult');
+
+class HelloActionResult extends ActionResult {
+	constructor(parameters) {
+		super(parameters);
+	}
+}
+
+module.exports.HelloActionResult = HelloActionResult;

package/src/services/actionresult/ManageAccountActionResult.js

@@ -0,0 +1,70 @@
+/*
+ ** 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');
+const { ActionResult, ActionResultBuilder, STATUS } = require('./ActionResult');
+
+const MANAGE_ACTION = {
+	LIST: 'list',
+	EXIT: 'exit',
+	INFO: 'info',
+	RENAME: 'rename',
+	REMOVE: 'remove',
+	REVOKE: 'revoke',
+	UNKNOWN: 'unknown',
+};
+
+class ManageAccountActionResult extends ActionResult {
+	constructor(parameters) {
+		super(parameters);
+		this._actionExecuted = parameters.actionExecuted;
+	}
+
+	validateParameters(parameters) {
+		assert(parameters);
+		assert(parameters.status, 'status is required when creating an ActionResult object.');
+		if (parameters.status === STATUS.SUCCESS) {
+			assert(parameters.actionExecuted);
+		}
+		if (parameters.status === STATUS.ERROR) {
+			assert(parameters.errorMessages, 'errorMessages is required when ActionResult is an error.');
+			assert(Array.isArray(parameters.errorMessages), 'errorMessages argument must be an array');
+		}
+	}
+
+	get actionExecuted() {
+		return this._actionExecuted;
+	}
+
+	static get Builder() {
+		return new ManageAccountActionResultBuilder();
+	}
+}
+
+class ManageAccountActionResultBuilder extends ActionResultBuilder {
+	constructor() {
+		super();
+	}
+
+	withExecutedAction(actionExecuted) {
+		this.actionExecuted = actionExecuted;
+		return this;
+	}
+
+	build() {
+		return new ManageAccountActionResult({
+			status: this.status,
+			...(this.data && { data: this.data }),
+			...(this.resultMessage && { resultMessage: this.resultMessage }),
+			...(this.errorMessages && { errorMessages: this.errorMessages }),
+			...(this.actionExecuted && { actionExecuted: this.actionExecuted }),
+			...(this.commandParameters && { commandParameters: this.commandParameters }),
+		});
+	}
+}
+
+module.exports.ManageAccountActionResult = ManageAccountActionResult;
+module.exports.ManageAccountActionResultBuilder = ManageAccountActionResultBuilder;
+module.exports.MANAGE_ACTION = MANAGE_ACTION;

package/src/services/settings/CLISettings.js

@@ -0,0 +1,46 @@
+/*
+** 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_CLI_SETTINGS = {
+	isJavaVersionValid: false,
+}
+
+module.exports = class CLISettings {
+	// should not be directly used, use static fromJson(json) method
+	constructor(options) {
+		this._isJavaVersionValid = options.isJavaVersionValid ? options.isJavaVersionValid : DEFAULT_CLI_SETTINGS.isJavaVersionValid;
+		// we only accept an object as a value for vmOptions
+		if (options.hasOwnProperty("vmOptions")) {
+			if (options.vmOptions !== null && typeof options.vmOptions === 'object') {
+				this._vmOptions = options.vmOptions;
+			} else {
+				this._vmOptions = {};
+			}
+		}
+	}
+
+	get isJavaVersionValid() {
+		return this._isJavaVersionValid;
+	}
+
+	get vmOptions() {
+		return this._vmOptions;
+	}
+
+	toJSON() {
+		return {
+			isJavaVersionValid: this._isJavaVersionValid,
+			...(this._vmOptions && { vmOptions: this._vmOptions }),
+		};
+	}
+
+	static fromJson(json) {
+		return new CLISettings({
+			isJavaVersionValid: json.isJavaVersionValid,
+			...(json.hasOwnProperty("vmOptions") && { vmOptions: json.vmOptions })
+		});
+	}
+};

package/src/services/settings/CLISettingsService.js

@@ -0,0 +1,132 @@
+/*
+ ** 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 FileUtils = require('../../utils/FileUtils');
+const CLISettings = require('./CLISettings');
+const path = require('path');
+const NodeTranslationService = require('../NodeTranslationService');
+const {
+	ERRORS: { SDK_SETTINGS_FILE },
+} = require('../TranslationKeys');
+
+const HOME_PATH = require('os').homedir();
+const { FILES, FOLDERS } = require('../../ApplicationConstants');
+
+const SDK_SETTINGS_FILEPATH = path.join(HOME_PATH, FOLDERS.SUITECLOUD_SDK, FILES.SDK_SETTINGS);
+
+const CLI_SETTINGS_PROPERTIES_KEYS = ['isJavaVersionValid'];
+const DEFAULT_CLI_SETTINGS = CLISettings.fromJson({
+	isJavaVersionValid: false,
+});
+
+const VM_OPTION_VALIDATION_ERROR_NAME = 'VmOptionValidationError';
+const SYNTAX_ERROR_NAME = 'SyntaxError';
+class VmOptionValidationError extends Error {
+	constructor(message) {
+		super(message);
+		this.name = VM_OPTION_VALIDATION_ERROR_NAME;
+	}
+}
+
+let CACHED_CLI_SETTINGS;
+
+module.exports = class CLISettingsService {
+	constructor() {
+		this._fileSystemService = new FileSystemService();
+	}
+
+	_saveSettings(cliSettings) {
+		this._fileSystemService.createFolder(HOME_PATH, FOLDERS.SUITECLOUD_SDK);
+		FileUtils.create(SDK_SETTINGS_FILEPATH, cliSettings);
+	}
+
+	_getSettings() {
+		if (CACHED_CLI_SETTINGS) {
+			return CACHED_CLI_SETTINGS;
+		}
+		if (FileUtils.exists(SDK_SETTINGS_FILEPATH)) {
+			try {
+				const cliSettingsJson = FileUtils.readAsJson(SDK_SETTINGS_FILEPATH);
+				CACHED_CLI_SETTINGS = CLISettings.fromJson(cliSettingsJson);
+
+				// check if the settings file has the expected properties
+				if (!this._settingsFileHasExpectedProperties(cliSettingsJson) || this._settingsFileHasVmOptionsNotObjectType(cliSettingsJson)) {
+					// regenerate the file with the missing properties default values
+					this._saveSettings(CACHED_CLI_SETTINGS);
+				}
+				this._validateVmOptions(CACHED_CLI_SETTINGS.vmOptions);
+				return CACHED_CLI_SETTINGS;
+			} catch (error) {
+				if (error && error.constructor && error.constructor.name) {
+					if (error.constructor.name === SYNTAX_ERROR_NAME) {
+						throw NodeTranslationService.getMessage(SDK_SETTINGS_FILE.WRONG_JSON_SYNTAX, SDK_SETTINGS_FILEPATH, error);
+					}
+					if (error.constructor.name === VM_OPTION_VALIDATION_ERROR_NAME) {
+						throw NodeTranslationService.getMessage(SDK_SETTINGS_FILE.INVALID_CUSTOM_VM_OPTION, SDK_SETTINGS_FILEPATH, error);
+					}
+				}
+				throw NodeTranslationService.getMessage(
+					SDK_SETTINGS_FILE.GENERIC_PROBLEM,
+					SDK_SETTINGS_FILEPATH,
+					error
+				);
+			}
+		}
+		CACHED_CLI_SETTINGS = DEFAULT_CLI_SETTINGS;
+		return DEFAULT_CLI_SETTINGS;
+	}
+
+	isJavaVersionValid() {
+		return this._getSettings().isJavaVersionValid === true;
+	}
+
+	setJavaVersionValid(value) {
+		const newSettings = this._getSettings().toJSON();
+		if (newSettings.isJavaVersionValid === value) {
+			return;
+		}
+		newSettings.isJavaVersionValid = value;
+		CACHED_CLI_SETTINGS = CLISettings.fromJson(newSettings);
+		this._saveSettings(CACHED_CLI_SETTINGS);
+	}
+
+	getCustomVmOptions() {
+		return this._getSettings().vmOptions;
+	}
+
+	_settingsFileHasExpectedProperties(settingsFromFile) {
+		return CLI_SETTINGS_PROPERTIES_KEYS.every((key) => settingsFromFile.hasOwnProperty(key));
+	}
+
+	_settingsFileHasVmOptionsNotObjectType(settingsFromFile) {
+		if (!settingsFromFile.hasOwnProperty('vmOptions')) {
+			return false;
+		}
+
+		if (settingsFromFile.vmOptions !== null && typeof settingsFromFile.vmOptions === 'object') {
+			return false;
+		}
+
+		return true;
+	}
+
+	_validateVmOptions(vmOptions) {
+		if (vmOptions === null || vmOptions === undefined) {
+			return;
+		}
+
+		for (const [key, value] of Object.entries(vmOptions)) {
+			// All vmOptions should be named '-Dx' and have at least another character
+			if (!key.startsWith('-D') || key.lenght < 3) {
+				throw new VmOptionValidationError(`vmOptions keys must start with '-D', and contain at least three characters.`);
+			}
+			if (typeof value !== 'string') {
+				throw new VmOptionValidationError(`vmOptions keys only support string values.`);
+			}
+		}
+	}
+};

package/src/suitecloud.js

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+/*
+ ** 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 CLI = require('./CLI');
+const CommandsMetadataService = require('./core/CommandsMetadataService');
+const CommandActionExecutor = require('./core/CommandActionExecutor');
+const CommandRegistrationService = require('./core/CommandRegistrationService');
+const CommandOptionsValidator = require('./core/CommandOptionsValidator');
+const CLIConfigurationService = require('./core/extensibility/CLIConfigurationService');
+const sdkPath = require('./core/sdksetup/SdkProperties').getSdkPath();
+const NodeConsoleLogger = require('./loggers/NodeConsoleLogger');
+
+const executionPath = process.cwd();
+const commandsMetadataServiceSingleton = new CommandsMetadataService();
+
+const cliInstance = new CLI({
+	commandsMetadataService: commandsMetadataServiceSingleton,
+	commandRegistrationService: new CommandRegistrationService(),
+	commandActionExecutor: new CommandActionExecutor({
+		executionPath,
+		commandOptionsValidator: new CommandOptionsValidator(),
+		cliConfigurationService: new CLIConfigurationService(),
+		commandsMetadataService: commandsMetadataServiceSingleton,
+		log: NodeConsoleLogger,
+		sdkPath: sdkPath
+	}),
+});
+
+cliInstance.start(process);

package/src/templates/TemplateKeys.js

@@ -0,0 +1,25 @@
+/*
+** 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 = {
+	SCRIPTS: {
+		blankscript: require.resolve('./scripts/blankscript.js'),
+	},
+	OBJECTS: {
+		commerceextension: require.resolve('./objects/commerceextension.xml'),
+	},
+	PROJECTCONFIGS: {
+		cliconfig: require.resolve('./projectconfigs/suitecloud.config.js'),
+		gitignore: require.resolve('./projectconfigs/default_gitignore.template')
+	},
+	UNIT_TEST: {
+		cliconfig: require.resolve('./unittest/suitecloud.config.js.template'),
+		jestconfig: require.resolve('./unittest/jest.config.js.template'),
+		packagejson: require.resolve('./unittest/package.json.template'),
+		sampletest: require.resolve('./unittest/sample-test.js.template'),
+		jsconfig: require.resolve('./unittest/jsconfig.json.template')
+	}
+};

package/src/templates/objects/commerceextension.xml

@@ -0,0 +1,9 @@
+<commerceextension objecttypeappid="" scriptid="{{scriptid}}">
+	 <name></name>
+	 <description></description>
+	 <vendor></vendor>
+	 <type></type>
+	 <version></version>
+	 <target></target>
+	 <basepath></basepath>
+</commerceextension>

package/src/templates/projectconfigs/default_gitignore.template

@@ -0,0 +1,47 @@
+# IDEs and editors
+.idea
+*.iml
+*.iws
+.project
+.classpath
+*.launch
+.settings
+*.sublime-workspace
+.vscode
+
+# Dependency directories
+node_modules
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Packaged SuiteCloud projects
+build
+
+# misc
+.sass-cache
+
+# Optional npm cache directory
+.npm
+
+# System Files
+.DS_Store
+Thumbs.db
+
+# Output of 'npm pack'
+*.tgz
+
+# Project config
+project.json
+
+# temp files
+sdftemp*
+
+# default deploy and manifest file
+deploy.xml
+manifest.xml

package/src/templates/projectconfigs/sdf.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+    defaultProjectFolder: "src",
+    commands: {}
+};

package/src/templates/projectconfigs/suitecloud.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+	defaultProjectFolder: "src",
+	commands: {}
+};

package/src/templates/scripts/blankscript.js

@@ -0,0 +1,3 @@
+function main(){
+    return 'hello world'
+}

package/src/templates/unittest/jest.config.js.template

@@ -0,0 +1,7 @@
+const SuiteCloudJestConfiguration = require("@oracle/suitecloud-unit-testing/jest-configuration/SuiteCloudJestConfiguration");
+const cliConfig = require("./suitecloud.config");
+
+module.exports = SuiteCloudJestConfiguration.build({
+	projectFolder: cliConfig.defaultProjectFolder,
+	projectType: {{projectType}},
+});

package/src/templates/unittest/jsconfig.json.template

@@ -0,0 +1,5 @@
+{
+    "typeAcquisition": {
+        "include": ["jest"]
+    }
+}

package/src/templates/unittest/package.json.template

@@ -0,0 +1,12 @@
+{
+  "name": "suitecloud-project",
+  "version": "{{version}}",
+  "scripts": {
+    "test": "jest"
+  },
+  "devDependencies": {
+    "jest": "29.7.0",
+    "@types/jest": "29.5.14",
+    "@oracle/suitecloud-unit-testing": "^1.7.0"
+  }
+}