@extrahorizon/exh-cli 1.8.2-feat-84-88251d7 → 1.9.0-dev-85-4c62b0a

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Extra Horizon CLI changelog
 
+### v1.9.0
+* Introduced the `executionCredentials` field in the task configuration:
+  * Specify the permissions your task needs
+  * The CLI automatically creates a user, role, and credentials for your task
+  * These credentials are injected as environment variables into the task automatically
+
 ### v1.8.2
 * Updated the ExH SDK to `8.6.0` to fix a security warning from `axios`
 

package/build/commands/tasks/sync.js

@@ -5,6 +5,7 @@ const fs = require("fs/promises");
 const chalk = require("chalk");
 const constants_1 = require("../../constants");
 const util_1 = require("../../helpers/util");
+const authRepository = require("../../repositories/auth");
 const functionRepository = require("../../repositories/functions");
 const taskConfig_1 = require("./taskConfig");
 const util_2 = require("./util");
@@ -107,7 +108,7 @@ async function syncSingleTask(sdk, config) {
         });
         config.environment = {
             ...config.environment,
-            API_HOST: process.env.API_HOST,
+            API_HOST: authRepository.getHost(sdk),
             API_OAUTH_CONSUMER_KEY: process.env.API_OAUTH_CONSUMER_KEY,
             API_OAUTH_CONSUMER_SECRET: process.env.API_OAUTH_CONSUMER_SECRET,
             API_OAUTH_TOKEN: credentials.token,

package/build/commands/tasks/util.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.syncFunctionUser = exports.zipFileFromDirectory = void 0;
 const fs_1 = require("fs");
 const os_1 = require("os");
+const javascript_sdk_1 = require("@extrahorizon/javascript-sdk");
 const archiver = require("archiver");
 const chalk = require("chalk");
 const uuid_1 = require("uuid");
@@ -37,10 +38,13 @@ async function syncFunctionUser(sdk, data) {
     const roleName = `exh.tasks.${taskName}`;
     const role = await syncRoleWithPermissions(sdk, taskName, roleName, targetPermissions);
     let user = await userRepository.findUserByEmail(sdk, email);
-    console.group(chalk.white(`🔄  Syncing user: ${email}`));
     if (!user) {
-        console.log(chalk.white('⚙️  Creating the user...'));
-        user = await userRepository.createUser(sdk, {
+        console.log(chalk.white('⚙️  Creating a user for the task'));
+        const { emailAvailable } = await sdk.users.isEmailAvailable(email);
+        if (!emailAvailable) {
+            throw new Error('❌ The user could not be created as the email address is already in use');
+        }
+        user = await sdk.users.createAccount({
             firstName: `${taskName}`,
             lastName: 'exh.tasks',
             email,
@@ -48,13 +52,11 @@ async function syncFunctionUser(sdk, data) {
             phoneNumber: '0000000000',
             language: 'EN',
         });
+        console.log(chalk.green('✅ Successfully created a user for task'));
         await assignRoleToUser(sdk, user.id, role.id);
-        const oAuth1Tokens = await createOAuth1Tokens(sdk, email, password);
-        console.groupEnd();
-        console.log(chalk.green('✅  Successfully synced user'));
-        console.log('');
-        return oAuth1Tokens;
+        return await createOAuth1Tokens(sdk, email, password);
     }
+    console.log(chalk.white('⚙️  Checking for the existing users credentials'));
     const currentFunction = await functionRepository.findByName(sdk, taskName);
     const hasExistingCredentials = (currentFunction?.environmentVariables?.API_HOST?.value &&
         currentFunction?.environmentVariables?.API_OAUTH_TOKEN_SECRET?.value &&
@@ -64,14 +66,11 @@ async function syncFunctionUser(sdk, data) {
     if (!hasExistingCredentials) {
         throw new Error('❌ No credentials were found for the existing user');
     }
-    console.log(chalk.white('⚙️  Reusing existing user credentials...'));
     const userRole = user.roles.find(({ name }) => name === roleName);
     if (!userRole) {
         await assignRoleToUser(sdk, user.id, role.id);
     }
-    console.groupEnd();
-    console.log(chalk.green('✅  Successfully synced user'));
-    console.log('');
+    console.log(chalk.green('✅ Using existing credentials for the user'));
     return {
         token: currentFunction.environmentVariables.API_OAUTH_TOKEN.value,
         tokenSecret: currentFunction.environmentVariables.API_OAUTH_TOKEN_SECRET.value,
@@ -79,50 +78,38 @@ async function syncFunctionUser(sdk, data) {
 }
 exports.syncFunctionUser = syncFunctionUser;
 async function syncRoleWithPermissions(sdk, taskName, roleName, targetPermissions) {
-    console.group(chalk.white(`🔄  Syncing role: ${roleName}`));
-    if (targetPermissions.length === 0) {
-        console.log(chalk.yellow('⚠️  No permissions have been defined for the role'));
-    }
-    let role = await userRepository.findGlobalRoleByName(sdk, roleName);
+    console.log(chalk.white('⚙️  Checking if the role exists'));
+    let role = await sdk.users.globalRoles.findByName(roleName);
     if (!role) {
-        console.log(chalk.white('⚙️  Creating the role...'));
-        const roleDescription = `A role created by the CLI for the execution of the task ${taskName}`;
-        role = await userRepository.createGlobalRole(sdk, roleName, roleDescription);
-        if (targetPermissions.length !== 0) {
-            await userRepository.addPermissionsToGlobalRole(sdk, roleName, targetPermissions);
-        }
-        console.log(chalk.white(`🔐  Permissions added: [${targetPermissions.join(', ')}]`));
-        console.groupEnd();
-        console.log(chalk.green('✅  Successfully synced role'));
-        console.log('');
+        console.log(chalk.white('⚙️  Role does not exist, creating a new role'));
+        role = await sdk.users.globalRoles.create({
+            name: roleName,
+            description: `A role created by the CLI for the execution of the task ${taskName}`,
+        });
+        console.log(chalk.white('⚙️  Assigning permissions to the role'));
+        await sdk.users.globalRoles.addPermissions((0, javascript_sdk_1.rqlBuilder)().eq('name', roleName).build(), { permissions: targetPermissions });
+        console.log(chalk.green('✅ Successfully assigned permissions to the role'));
         return role;
     }
-    console.log(chalk.white('⚙️  Updating the role...'));
     const currentPermissions = role.permissions?.flatMap(permission => permission.name) || [];
     const permissionsToAdd = targetPermissions.filter(targetPermission => !currentPermissions.includes(targetPermission));
     const permissionsToRemove = currentPermissions.filter(currentPermission => !targetPermissions.includes(currentPermission));
     if (permissionsToAdd.length > 0) {
-        await userRepository.addPermissionsToGlobalRole(sdk, roleName, permissionsToAdd);
-        console.log(chalk.white(`🔐  Permissions added: [${permissionsToAdd.join(',')}]`));
+        console.log(chalk.white('⚙️  Adding missing permissions to the role'));
+        await sdk.users.globalRoles.addPermissions((0, javascript_sdk_1.rqlBuilder)().eq('name', roleName).build(), { permissions: permissionsToAdd });
+        console.log(chalk.green('✅ Successfully added missing permissions to the role'));
     }
     if (permissionsToRemove.length > 0) {
-        await userRepository.removePermissionsFromGlobalRole(sdk, roleName, permissionsToRemove);
-        console.log(chalk.white(`🔐  Permissions removed: [${permissionsToRemove.join(',')}]`));
+        console.log(chalk.white('⚙️  Removing excess permissions from the role'));
+        await sdk.users.globalRoles.removePermissions((0, javascript_sdk_1.rqlBuilder)().eq('name', roleName).build(), { permissions: permissionsToRemove });
+        console.log(chalk.green('✅ Successfully removed excess permissions from the role'));
     }
-    console.groupEnd();
-    console.log(chalk.green('✅  Successfully synced role'));
-    console.log('');
     return role;
 }
 async function assignRoleToUser(sdk, userId, roleId) {
-    console.log(chalk.white('⚙️  Assigning the role to the user...'));
-    await userRepository.addGlobalRoleToUser(sdk, userId, roleId);
-}
-async function createOAuth1Tokens(sdk, email, password) {
-    console.log(chalk.white('⚙️  Creating credentials...'));
-    const response = await authRepository.createOAuth1Tokens(sdk, email, password);
-    const { token, tokenSecret } = response;
-    return { token, tokenSecret };
+    console.log(chalk.white('⚙️  Assigning the role to the user'));
+    await sdk.users.globalRoles.addToUsers((0, javascript_sdk_1.rqlBuilder)().eq('id', userId).build(), { roles: [roleId] });
+    console.log(chalk.green('✅ Successfully assigned the role to the user'));
 }
 function validateEmail(email) {
     const emailRegex = /.+@.+\..+/;
@@ -130,3 +117,10 @@ function validateEmail(email) {
         throw new Error('Invalid email address');
     }
 }
+async function createOAuth1Tokens(sdk, email, password) {
+    console.log(chalk.white('⚙️  Creating OAuth1 tokens for the user', email));
+    const response = await authRepository.createOAuth1Tokens(sdk, email, password);
+    const { token, tokenSecret } = response.data;
+    console.log(chalk.green('✅ Successfully created OAuth1 tokens for the user', email));
+    return { token, tokenSecret };
+}

package/build/repositories/functions.js

@@ -7,11 +7,7 @@ async function find(sdk) {
 }
 exports.find = find;
 async function findByName(sdk, name) {
-    const response = await sdk.raw.get(`/tasks/v1/functions/${name}`, { customResponseKeys: ['*'] })
-        .catch(e => e);
-    if (response.status === 404) {
-        return undefined;
-    }
+    const response = await sdk.raw.get(`/tasks/v1/functions/${name}`, { customResponseKeys: ['*'] });
     return response.data;
 }
 exports.findByName = findByName;

package/build/repositories/user.d.ts

@@ -1,9 +1,2 @@
-import { OAuth1Client, RegisterUserData } from '@extrahorizon/javascript-sdk';
+import { OAuth1Client } from '@extrahorizon/javascript-sdk';
 export declare function findUserByEmail(sdk: OAuth1Client, email: string): Promise<import("@extrahorizon/javascript-sdk").UserData>;
-export declare function isEmailAvailable(sdk: OAuth1Client, email: string): Promise<boolean>;
-export declare function createUser(sdk: OAuth1Client, data: RegisterUserData): Promise<import("@extrahorizon/javascript-sdk").UserData>;
-export declare function findGlobalRoleByName(sdk: OAuth1Client, name: string): Promise<import("@extrahorizon/javascript-sdk").Role>;
-export declare function createGlobalRole(sdk: OAuth1Client, name: string, description: string): Promise<import("@extrahorizon/javascript-sdk").Role>;
-export declare function addPermissionsToGlobalRole(sdk: OAuth1Client, name: string, permissions: string[]): Promise<import("@extrahorizon/javascript-sdk").AffectedRecords>;
-export declare function removePermissionsFromGlobalRole(sdk: OAuth1Client, name: string, permissions: string[]): Promise<import("@extrahorizon/javascript-sdk").AffectedRecords>;
-export declare function addGlobalRoleToUser(sdk: OAuth1Client, userId: string, roleId: string): Promise<import("@extrahorizon/javascript-sdk").AffectedRecords>;

package/build/repositories/user.js

@@ -1,38 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addGlobalRoleToUser = exports.removePermissionsFromGlobalRole = exports.addPermissionsToGlobalRole = exports.createGlobalRole = exports.findGlobalRoleByName = exports.createUser = exports.isEmailAvailable = exports.findUserByEmail = void 0;
+exports.findUserByEmail = void 0;
 const javascript_sdk_1 = require("@extrahorizon/javascript-sdk");
 async function findUserByEmail(sdk, email) {
     const rql = (0, javascript_sdk_1.rqlBuilder)().eq('email', email).build();
     return await sdk.users.findFirst({ rql });
 }
 exports.findUserByEmail = findUserByEmail;
-async function isEmailAvailable(sdk, email) {
-    const { emailAvailable } = await sdk.users.isEmailAvailable(email);
-    return emailAvailable;
-}
-exports.isEmailAvailable = isEmailAvailable;
-async function createUser(sdk, data) {
-    return await sdk.users.createAccount(data);
-}
-exports.createUser = createUser;
-async function findGlobalRoleByName(sdk, name) {
-    return await sdk.users.globalRoles.findByName(name);
-}
-exports.findGlobalRoleByName = findGlobalRoleByName;
-async function createGlobalRole(sdk, name, description) {
-    return await sdk.users.globalRoles.create({ name, description });
-}
-exports.createGlobalRole = createGlobalRole;
-async function addPermissionsToGlobalRole(sdk, name, permissions) {
-    return await sdk.users.globalRoles.addPermissions((0, javascript_sdk_1.rqlBuilder)().eq('name', name).build(), { permissions });
-}
-exports.addPermissionsToGlobalRole = addPermissionsToGlobalRole;
-async function removePermissionsFromGlobalRole(sdk, name, permissions) {
-    return await sdk.users.globalRoles.removePermissions((0, javascript_sdk_1.rqlBuilder)().eq('name', name).build(), { permissions });
-}
-exports.removePermissionsFromGlobalRole = removePermissionsFromGlobalRole;
-async function addGlobalRoleToUser(sdk, userId, roleId) {
-    return await sdk.users.globalRoles.addToUsers((0, javascript_sdk_1.rqlBuilder)().eq('id', userId).build(), { roles: [roleId] });
-}
-exports.addGlobalRoleToUser = addGlobalRoleToUser;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/exh-cli",
-  "version": "1.8.2-feat-84-88251d7",
+  "version": "1.9.0-dev-85-4c62b0a",
   "main": "build/index.js",
   "exports": "./build/index.js",
   "license": "MIT",