@extrahorizon/exh-cli 1.5.1 → 1.6.0-dev-39-14d33ad

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Extra Horizon CLI changelog
 
+### v1.6.0
+* Removed the update notifier. The version of the package we used had security vulnerabilities and we're unable to migrate to the latest version right now. We'll look into this again in the future.
+* Added the `exh whoami` command, showing the currently logged in user
+* Added the `exh localizations sync` command, allowing you to sync localizations from a folder containing your translations
+* Added localization syncing support to the `exh sync` command
+* The `exh sync` command now also supports absolute paths for the `--path` argument
+
 ### v1.5.1
 * Now also publishing to the NPM registry, no longer needing to authenticate with GitHub Packages to install the CLI
 

package/README.md

@@ -1,6 +1,6 @@
 # Extra Horizon CLI
 
-This is the command-line interface to the Extra Horizon platform. It allows you to manage schemas & tasks for now, but
+This is the command-line interface to the Extra Horizon platform. It allows you to manage just some parts of your Extra Horizon configuration for now, but
 will be extended with additional functionality.
 
 See [changelog](CHANGELOG.md) for the latest changes.

package/build/commands/localizations/sync.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="yargs" />
+import { OAuth1Client } from '@extrahorizon/javascript-sdk';
+export declare const command = "sync";
+export declare const desc = "Sync all localizations in a directory with the ExH cloud";
+export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "path"> & import("yargs").InferredOptionTypes<{
+    path: {
+        demandOption: false;
+        describe: string;
+        type: "string";
+        default: string;
+    };
+}>>;
+export declare const handler: ({ sdk, path }: {
+    sdk: OAuth1Client;
+    path?: string;
+}) => Promise<void>;

package/build/commands/localizations/sync.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.builder = exports.desc = exports.command = void 0;
+const util_1 = require("../../helpers/util");
+const localizationsService = require("../../services/localizations");
+exports.command = 'sync';
+exports.desc = 'Sync all localizations in a directory with the ExH cloud';
+const builder = (yargs) => (0, util_1.epilogue)(yargs).options({
+    path: {
+        demandOption: false,
+        describe: 'Directory containing the localizations which need to be synced in a JSON format. By Default: ./localizations',
+        type: 'string',
+        default: './localizations',
+    },
+});
+exports.builder = builder;
+const handler = async ({ sdk, path }) => {
+    await localizationsService.sync(sdk, path);
+};
+exports.handler = handler;

package/build/commands/localizations.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="yargs" />
+export declare const command = "localizations <command>";
+export declare const desc = "Manage localizations";
+export declare const builder: (yargs: any) => import("yargs").Argv<{}>;
+export declare const handler: () => void;

package/build/commands/localizations.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.builder = exports.desc = exports.command = void 0;
+const util_1 = require("../helpers/util");
+exports.command = 'localizations <command>';
+exports.desc = 'Manage localizations';
+const builder = (yargs) => (0, util_1.epilogue)(yargs).commandDir('localizations');
+exports.builder = builder;
+const handler = () => { };
+exports.handler = handler;

package/build/commands/sync.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="yargs" />
+import { OAuth1Client } from '@extrahorizon/javascript-sdk';
 export declare const command = "sync";
-export declare const desc = "Upload all schemas, templates & tasks to the cloud environment";
-export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "path" | "schemas" | "tasks" | "dispatchers" | "templates" | "cleanDispatchers" | "ignoreSchemaVerificationErrors"> & import("yargs").InferredOptionTypes<{
+export declare const desc = "Sync your ExH configuration to the cloud environment";
+export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "path" | "schemas" | "tasks" | "dispatchers" | "localizations" | "templates" | "cleanDispatchers" | "ignoreSchemaVerificationErrors"> & import("yargs").InferredOptionTypes<{
     path: {
         demandOption: false;
         describe: string;
@@ -36,6 +37,12 @@ export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs
         describe: string;
         type: "boolean";
     };
+    localizations: {
+        demandOption: false;
+        describe: string;
+        type: "boolean";
+        default: boolean;
+    };
     ignoreSchemaVerificationErrors: {
         demandOption: false;
         describe: string;
@@ -43,13 +50,14 @@ export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs
         default: boolean;
     };
 }>>;
-export declare const handler: ({ sdk, path, schemas, tasks, templates, dispatchers, cleanDispatchers, ignoreSchemaVerificationErrors }: {
-    sdk: any;
-    path: any;
-    schemas: any;
-    tasks: any;
-    templates: any;
-    dispatchers: any;
-    cleanDispatchers: any;
-    ignoreSchemaVerificationErrors: any;
+export declare const handler: ({ sdk, path, schemas, tasks, templates, dispatchers, cleanDispatchers, localizations, ignoreSchemaVerificationErrors, }: {
+    sdk: OAuth1Client;
+    path?: string;
+    schemas?: boolean;
+    tasks?: boolean;
+    templates?: boolean;
+    dispatchers?: boolean;
+    cleanDispatchers?: boolean;
+    localizations?: boolean;
+    ignoreSchemaVerificationErrors?: boolean;
 }) => Promise<void>;

package/build/commands/sync.js

@@ -8,17 +8,18 @@ const chalk = require("chalk");
 const repoConfig_1 = require("../helpers/repoConfig");
 const util_1 = require("../helpers/util");
 const dispatchers_1 = require("../services/dispatchers");
+const localizations_1 = require("../services/localizations");
 const sync_1 = require("./data/schemas/sync");
 const sync_2 = require("./tasks/sync");
 const sync_3 = require("./templates/sync");
 exports.command = 'sync';
-exports.desc = 'Upload all schemas, templates & tasks to the cloud environment';
+exports.desc = 'Sync your ExH configuration to the cloud environment';
 const builder = (yargs) => (0, util_1.epilogue)(yargs)
     .options({
     path: {
         demandOption: false,
         describe: `Path to folder which needs to be synchronized. The target folder should contain a ${repoConfig_1.REPO_CONFIG_FILE} file. 
-If not, the local directory is assumed with a default configuration which assumes tasks are in a 'tasks' folder, schemas in  a 'schemas' folder and templates in a 'templates' folder`,
+If not, the local directory is assumed with a default configuration which assumes tasks are in a 'tasks' folder, schemas in  a 'schemas' folder, etc...`,
         type: 'string',
     },
     schemas: {
@@ -50,6 +51,12 @@ If not, the local directory is assumed with a default configuration which assume
         describe: 'Delete Dispatchers created using the CLI, that are no longer present in the local Dispatcher file',
         type: 'boolean',
     },
+    localizations: {
+        demandOption: false,
+        describe: 'Sync localizations only',
+        type: 'boolean',
+        default: false,
+    },
     ignoreSchemaVerificationErrors: {
         demandOption: false,
         describe: 'Allow schema synchronization to proceed with validation errors.',
@@ -71,10 +78,10 @@ If not, the local directory is assumed with a default configuration which assume
     return true;
 });
 exports.builder = builder;
-const handler = async ({ sdk, path, schemas, tasks, templates, dispatchers, cleanDispatchers, ignoreSchemaVerificationErrors }) => {
-    const targetPath = ospath.join(process.cwd(), path || '.');
-    const cfg = await (0, repoConfig_1.getRepoConfig)(targetPath, true);
-    const syncAll = !(schemas || tasks || templates || dispatchers);
+const handler = async ({ sdk, path, schemas, tasks, templates, dispatchers, cleanDispatchers, localizations, ignoreSchemaVerificationErrors, }) => {
+    const targetPath = path || '.';
+    const cfg = await (0, repoConfig_1.getRepoConfig)(targetPath);
+    const syncAll = !(schemas || tasks || templates || dispatchers || localizations);
     if ((syncAll || schemas) && cfg.schemas) {
         console.log(chalk.green('\n ⚙️  Syncing schemas ...'));
         for (const schema of cfg.schemas) {
@@ -93,6 +100,12 @@ const handler = async ({ sdk, path, schemas, tasks, templates, dispatchers, clea
             await (0, sync_2.handler)({ sdk, path: ospath.join(targetPath, task) });
         }
     }
+    if ((syncAll || localizations) && cfg.localizations) {
+        console.log(chalk.green('\n ⚙️  Syncing localizations...'));
+        for (const localization of cfg.localizations) {
+            await (0, localizations_1.sync)(sdk, ospath.join(targetPath, localization));
+        }
+    }
     if ((syncAll || dispatchers)) {
         const dispatchersPath = ospath.join(targetPath, 'dispatchers.json');
         const isValidPath = (0, fs_1.existsSync)(dispatchersPath);

package/build/commands/whoami.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="yargs" />
+import type { OAuth1Client } from '@extrahorizon/javascript-sdk';
+export declare const command = "whoami";
+export declare const desc = "Shows the currently logged in user";
+export declare const builder: (yargs: any) => import("yargs").Argv<{}>;
+export declare const handler: ({ sdk }: {
+    sdk: OAuth1Client;
+}) => Promise<void>;

package/build/commands/whoami.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.builder = exports.desc = exports.command = void 0;
+const util_1 = require("../helpers/util");
+const authRepository = require("../repositories/auth");
+exports.command = 'whoami';
+exports.desc = 'Shows the currently logged in user';
+const builder = (yargs) => (0, util_1.epilogue)(yargs);
+exports.builder = builder;
+const handler = async function list({ sdk }) {
+    const host = authRepository.getHost(sdk);
+    if (!host) {
+        console.log('No ExH cluster host was found in the configuration.');
+        return;
+    }
+    console.log('You are targeting:', host);
+    const currentUser = await authRepository.fetchMe(sdk);
+    console.log('You are logged in as:', currentUser.email);
+};
+exports.handler = handler;

package/build/helpers/repoConfig.d.ts

@@ -1,2 +1,2 @@
 export declare const REPO_CONFIG_FILE = "repo-config.json";
-export declare function getRepoConfig(targetPath: string, validate: boolean): Promise<any>;
+export declare function getRepoConfig(targetPath: string): Promise<any>;

package/build/helpers/repoConfig.js

@@ -7,7 +7,7 @@ const chalk = require("chalk");
 exports.REPO_CONFIG_FILE = 'repo-config.json';
 async function getDefaultConfig(targetPath) {
     const config = {};
-    const sections = ['schemas', 'templates', 'tasks'];
+    const sections = ['schemas', 'templates', 'tasks', 'localizations'];
     for (const s of sections) {
         try {
             await fs.access(ospath.join(targetPath, s));
@@ -46,15 +46,12 @@ async function validateRepoConfig(targetPath, config) {
     }
     return newConfig;
 }
-async function getRepoConfig(targetPath, validate) {
+async function getRepoConfig(targetPath) {
     let cfg = await getDefaultConfig(targetPath);
     try {
         cfg = JSON.parse((await fs.readFile(ospath.join(targetPath, exports.REPO_CONFIG_FILE))).toString());
     }
     catch (err) { }
-    if (validate) {
-        return await validateRepoConfig(targetPath, cfg);
-    }
-    return cfg;
+    return await validateRepoConfig(targetPath, cfg);
 }
 exports.getRepoConfig = getRepoConfig;

package/build/index.js

@@ -6,13 +6,6 @@ const lodash_1 = require("lodash");
 const yargs = require("yargs");
 const helpers_1 = require("yargs/helpers");
 const exh_1 = require("./exh");
-function checkVersion() {
-    const pkg = require('../package.json');
-    const updateNotifier = require('update-notifier');
-    const notifier = updateNotifier({ pkg, updateCheckInterval: 0 });
-    notifier.notify();
-}
-checkVersion();
 yargs((0, helpers_1.hideBin)(process.argv))
     .middleware(async (argv) => {
     const isTTY = tty.isatty(process.stdout.fd);

package/build/repositories/auth.d.ts

@@ -0,0 +1,3 @@
+import { OAuth1Client } from '@extrahorizon/javascript-sdk';
+export declare function getHost(sdk: OAuth1Client): string;
+export declare function fetchMe(sdk: OAuth1Client): Promise<import("@extrahorizon/javascript-sdk").UserData>;

package/build/repositories/auth.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchMe = exports.getHost = void 0;
+function getHost(sdk) {
+    return sdk?.raw?.defaults?.baseURL;
+}
+exports.getHost = getHost;
+async function fetchMe(sdk) {
+    return await sdk?.users.me();
+}
+exports.fetchMe = fetchMe;

package/build/repositories/localizations.d.ts

@@ -0,0 +1,4 @@
+import { Localization, OAuth1Client } from '@extrahorizon/javascript-sdk';
+export declare function create(sdk: OAuth1Client, localizations: PartialLocalization[]): Promise<import("@extrahorizon/javascript-sdk").BulkCreationResponse>;
+export declare function update(sdk: OAuth1Client, localizations: PartialLocalization[]): Promise<import("@extrahorizon/javascript-sdk").BulkUpdateResponse>;
+export declare type PartialLocalization = Pick<Localization, 'key' | 'text'>;

package/build/repositories/localizations.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.update = exports.create = void 0;
+async function create(sdk, localizations) {
+    return await sdk.localizations.create({ localizations });
+}
+exports.create = create;
+async function update(sdk, localizations) {
+    return await sdk.localizations.update({ localizations });
+}
+exports.update = update;

package/build/services/localizations/assertValidFileContent.d.ts

@@ -0,0 +1 @@
+export declare function assertValidFileContent(fileName: string, content: unknown): asserts content is Record<string, string>;

package/build/services/localizations/assertValidFileContent.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertValidFileContent = void 0;
+const Joi = require("joi");
+const keyPattern = /^[a-z0-9_.-]{1,200}$/i;
+const localizationFileSchema = Joi.object()
+    .pattern(keyPattern, Joi.string());
+function assertValidFileContent(fileName, content) {
+    const result = localizationFileSchema.validate(content);
+    if (result.error != null) {
+        throw new Error(`The content of localization file '${fileName}' is not valid: ${result.error.message}`);
+    }
+}
+exports.assertValidFileContent = assertValidFileContent;

package/build/services/localizations/assertValidLanguageCode.d.ts

@@ -0,0 +1,2 @@
+export declare const availableLanguagesCodes: string[];
+export declare function assertValidLanguageCode(languageCode: string): void;

package/build/services/localizations/assertValidLanguageCode.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertValidLanguageCode = exports.availableLanguagesCodes = void 0;
+exports.availableLanguagesCodes = [
+    'EN', 'AA', 'AB', 'AE', 'AF', 'AK', 'AM', 'AN', 'AR', 'AS', 'AV', 'AY', 'AZ', 'BA', 'BE', 'BG', 'BH', 'BI', 'BM', 'BN', 'BO',
+    'BR', 'BS', 'CA', 'CE', 'CH', 'CO', 'CR', 'CS', 'CU', 'CV', 'CY', 'DA', 'DE', 'DV', 'DZ', 'EE', 'EL', 'EO', 'ES', 'ET', 'EU',
+    'FA', 'FF', 'FI', 'FJ', 'FO', 'FR', 'FY', 'GA', 'GD', 'GL', 'GN', 'GU', 'GV', 'HA', 'HE', 'HI', 'HO', 'HR', 'HT', 'HU', 'HY',
+    'HZ', 'IA', 'ID', 'IE', 'IG', 'II', 'IK', 'IN', 'IO', 'IS', 'IT', 'IW', 'IU', 'JA', 'JI', 'JW', 'JV', 'KA', 'KG', 'KI', 'KJ',
+    'KK', 'KL', 'KM', 'KN', 'KO', 'KR', 'KS', 'KU', 'KV', 'KW', 'KY', 'LA', 'LB', 'LG', 'LI', 'LN', 'LO', 'LT', 'LU', 'LV', 'MG',
+    'MH', 'MI', 'MK', 'ML', 'MN', 'MO', 'MR', 'MS', 'MT', 'MY', 'NA', 'NB', 'ND', 'NE', 'NG', 'NL', 'NN', 'NO', 'NR', 'NV', 'NY',
+    'OC', 'OJ', 'OM', 'OR', 'OS', 'PA', 'PI', 'PL', 'PS', 'PT', 'QU', 'RM', 'RN', 'RO', 'RU', 'RW', 'SA', 'SC', 'SD', 'SE', 'SG',
+    'SH', 'SI', 'SK', 'SL', 'SM', 'SN', 'SO', 'SQ', 'SR', 'SS', 'ST', 'SU', 'SV', 'SW', 'TA', 'TE', 'TG', 'TH', 'TI', 'TK', 'TL',
+    'TN', 'TO', 'TR', 'TS', 'TT', 'TW', 'TY', 'UG', 'UK', 'UR', 'UZ', 'VE', 'VI', 'VO', 'WA', 'WO', 'XH', 'YI', 'YO', 'ZA', 'ZH',
+    'ZU',
+];
+function assertValidLanguageCode(languageCode) {
+    if (!exports.availableLanguagesCodes.includes(languageCode)) {
+        throw new Error(`The language code ${languageCode} is not available! The available language codes are: ${exports.availableLanguagesCodes.join(', ')}`);
+    }
+}
+exports.assertValidLanguageCode = assertValidLanguageCode;

package/build/services/localizations/index.d.ts

@@ -0,0 +1,2 @@
+import { OAuth1Client } from '@extrahorizon/javascript-sdk';
+export declare function sync(sdk: OAuth1Client, path: string): Promise<void>;

package/build/services/localizations/index.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sync = void 0;
+const chalk_1 = require("chalk");
+const readFiles_1 = require("./readFiles");
+const syncLocalizations_1 = require("./syncLocalizations");
+async function sync(sdk, path) {
+    console.log((0, chalk_1.yellow)(`Synchronizing localizations from ${path}`));
+    const localizations = (0, readFiles_1.readFiles)(path);
+    if (localizations.length < 1) {
+        console.log((0, chalk_1.yellow)('No localizations found'));
+        return;
+    }
+    assertDefaultLanguageSetForAll(localizations);
+    await (0, syncLocalizations_1.syncLocalizations)(sdk, localizations);
+}
+exports.sync = sync;
+function assertDefaultLanguageSetForAll(localizations) {
+    const defaultLanguage = 'EN';
+    const faultyLocalizations = localizations.filter(localization => localization.text[defaultLanguage] === undefined);
+    const faultyKeys = faultyLocalizations.map(localization => localization.key);
+    if (faultyKeys.length > 0) {
+        throw new Error(`The following localizations do not have a value for the default language (${defaultLanguage}): ${faultyKeys.join(', ')}`);
+    }
+}

package/build/services/localizations/readFiles.d.ts

@@ -0,0 +1,2 @@
+import { PartialLocalization } from '../../repositories/localizations';
+export declare function readFiles(path: string): PartialLocalization[];

package/build/services/localizations/readFiles.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readFiles = void 0;
+const fs_1 = require("fs");
+const osPath = require("path");
+const assertValidFileContent_1 = require("./assertValidFileContent");
+const assertValidLanguageCode_1 = require("./assertValidLanguageCode");
+function readFiles(path) {
+    let fileNames;
+    try {
+        fileNames = (0, fs_1.readdirSync)(path);
+    }
+    catch (error) {
+        throw new Error(`Was not able to list localization files in directory '${path}': ${error}`);
+    }
+    const localizationMap = {};
+    for (const fileName of fileNames) {
+        const parsedFileName = osPath.parse(fileName);
+        if (parsedFileName.ext !== '.json') {
+            continue;
+        }
+        const languageCode = parsedFileName.name.toUpperCase();
+        (0, assertValidLanguageCode_1.assertValidLanguageCode)(languageCode);
+        const localizationJson = readLocalizationFileSync(path, fileName);
+        (0, assertValidFileContent_1.assertValidFileContent)(fileName, localizationJson);
+        for (const [key, text] of Object.entries(localizationJson)) {
+            if (!(key in localizationMap)) {
+                localizationMap[key] = { key, text: {} };
+            }
+            localizationMap[key].text[languageCode] = text;
+        }
+    }
+    return Object.values(localizationMap);
+}
+exports.readFiles = readFiles;
+function readLocalizationFileSync(path, fileName) {
+    const fileContent = (0, fs_1.readFileSync)(osPath.join(path, fileName), { encoding: 'utf-8' });
+    try {
+        return JSON.parse(fileContent);
+    }
+    catch (error) {
+        throw Error(`Was not able to parse '${fileName}', not a valid JSON file`);
+    }
+}

package/build/services/localizations/syncLocalizations.d.ts

@@ -0,0 +1,3 @@
+import { OAuth1Client } from '@extrahorizon/javascript-sdk';
+import { PartialLocalization } from '../../repositories/localizations';
+export declare const syncLocalizations: (sdk: OAuth1Client, localizations: PartialLocalization[]) => Promise<void>;

package/build/services/localizations/syncLocalizations.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.syncLocalizations = void 0;
+const chalk = require("chalk");
+const lodash_1 = require("lodash");
+const localizationRepository = require("../../repositories/localizations");
+const chunkSize = 30;
+const syncLocalizations = async (sdk, localizations) => {
+    console.log(`${localizations.length} localization(s) to synchronize.`);
+    const localizationChunks = (0, lodash_1.chunk)(localizations, chunkSize);
+    for (const localizationChunk of localizationChunks) {
+        const creationResult = await localizationRepository.create(sdk, localizationChunk);
+        console.log(`Created ${creationResult.created} localization(s).`);
+        if (creationResult.existingIds && creationResult.existingIds.length > 0) {
+            const existingKeys = creationResult.existingIds;
+            const existingLocalizations = localizationChunk.filter(localization => existingKeys.includes(localization.key));
+            const updateResult = await localizationRepository.update(sdk, existingLocalizations);
+            console.log(`Updated ${updateResult.updated} localization(s).`);
+        }
+    }
+    console.log(chalk.green('Successful!'));
+};
+exports.syncLocalizations = syncLocalizations;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/exh-cli",
-  "version": "1.5.1",
+  "version": "1.6.0-dev-39-14d33ad",
   "main": "build/index.js",
   "exports": "./build/index.js",
   "license": "MIT",
@@ -11,7 +11,7 @@
     "url": "https://github.com/ExtraHorizon/exh-cli.git"
   },
   "scripts": {
-    "start": "yarn test",
+    "start": "yarn build && node ./build/index.js",
     "clean": "rimraf build",
     "build": "yarn clean && tsc",
     "test": "jest",
@@ -46,7 +46,6 @@
     "chalk": "^4.0.0",
     "joi": "^17.6.0",
     "lodash": "^4.17.21",
-    "update-notifier": "^5.1.0",
     "uuid": "^8.3.2",
     "yargs": "^17.5.1"
   }