@extrahorizon/exh-cli 1.5.1 → 1.6.0-dev-38-562ae51

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 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
+
 ### 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,29 @@
+/// <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<{}, "keys" | "path" | "languages"> & import("yargs").InferredOptionTypes<{
+    path: {
+        demandOption: false;
+        describe: string;
+        type: "string";
+    };
+    keys: {
+        demandOption: false;
+        describe: string;
+        type: "string";
+    };
+    languages: {
+        demandOption: false;
+        describe: string;
+        type: "string";
+    };
+}>>;
+interface HandlerInput {
+    sdk: OAuth1Client;
+    path?: string;
+    languages?: string;
+    keys?: string;
+}
+export declare const handler: ({ keys: rawKeys, languages: rawLanguages, path, sdk }: HandlerInput) => Promise<void>;
+export {};

package/build/commands/localizations/sync.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.builder = exports.desc = exports.command = void 0;
+const fs = require("fs");
+const ospath = require("path");
+const util_1 = require("../../helpers/util");
+const assertValidKey_1 = require("./utils/assertValidKey");
+const assertValidLanguageCode_1 = require("./utils/assertValidLanguageCode");
+const fetchLocalizations_1 = require("./utils/fetchLocalizations");
+const readLocalizationFiles_1 = require("./utils/readLocalizationFiles");
+const syncLocalizations_1 = require("./utils/syncLocalizations");
+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: /locales',
+        type: 'string',
+    },
+    keys: {
+        demandOption: false,
+        describe: 'The keys separated by a "," to sync',
+        type: 'string',
+    },
+    languages: {
+        demandOption: false,
+        describe: 'The languages separated by a "," to sync',
+        type: 'string',
+    },
+}).check(({ path, keys: rawKeys, languages: rawLanguages }) => {
+    if (path && !fs.existsSync(ospath.join(process.cwd(), path))) {
+        throw new Error('please provide a valid file path for your localizations');
+    }
+    if (rawLanguages) {
+        const languageCodes = rawLanguages.toLocaleUpperCase().split(',');
+        for (const languageCode of languageCodes) {
+            (0, assertValidLanguageCode_1.assertValidLanguageCode)(languageCode);
+        }
+    }
+    if (rawKeys) {
+        const keys = rawKeys.split(',');
+        for (const key of keys) {
+            (0, assertValidKey_1.assertValidKey)(key);
+        }
+    }
+    return true;
+});
+exports.builder = builder;
+const handler = async ({ keys: rawKeys, languages: rawLanguages, path, sdk }) => {
+    const keys = rawKeys?.split(',');
+    const selectedLanguageCodes = rawLanguages?.toUpperCase().split(',');
+    const fullPath = ospath.join(process.cwd(), path ?? 'locales');
+    console.log(`- Reading the localization configuration from ${fullPath}`);
+    const { localizations, languageCodes } = (0, readLocalizationFiles_1.readLocalizationFiles)(fullPath, keys, selectedLanguageCodes);
+    console.log('- Fetching the localization configuration from the localizations service');
+    const savedLocalizations = await (0, fetchLocalizations_1.fetchLocalizations)(sdk, localizations.map(localization => localization.key), languageCodes);
+    await (0, syncLocalizations_1.syncLocalizations)(sdk, localizations, savedLocalizations);
+};
+exports.handler = handler;

package/build/commands/localizations/utils/assertValidKey.d.ts

@@ -0,0 +1 @@
+export declare const assertValidKey: (key: string) => void;

package/build/commands/localizations/utils/assertValidKey.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertValidKey = void 0;
+const assertValidKey = (key) => {
+    const validKeyRegex = /^[a-zA-Z][a-zA-Z0-9_]*$/;
+    if (!validKeyRegex.test(key)) {
+        throw new Error(`The key ${key} is not valid! Must follow the pattern ${validKeyRegex}!`);
+    }
+};
+exports.assertValidKey = assertValidKey;

package/build/commands/localizations/utils/assertValidLanguageCode.d.ts

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

package/build/commands/localizations/utils/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',
+];
+const 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/commands/localizations/utils/fetchLocalizations.d.ts

@@ -0,0 +1,2 @@
+import { Localization, OAuth1Client } from '@extrahorizon/javascript-sdk';
+export declare const fetchLocalizations: (sdk: OAuth1Client, keys: string[], languageCodes: string[]) => Promise<Localization[]>;

package/build/commands/localizations/utils/fetchLocalizations.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchLocalizations = void 0;
+const javascript_sdk_1 = require("@extrahorizon/javascript-sdk");
+const lodash_1 = require("lodash");
+const fetchLocalizations = async (sdk, keys, languageCodes) => {
+    const localizations = [];
+    const keyChunks = (0, lodash_1.chunk)(keys, 5);
+    for (const keyChunk of keyChunks) {
+        const result = await sdk.localizations.find({
+            rql: (0, javascript_sdk_1.rqlBuilder)()
+                .in('key', keyChunk)
+                .select(['key'].concat(languageCodes.map(languageCode => `text.${languageCode}`)))
+                .build(),
+        });
+        localizations.push(...result.data);
+    }
+    return localizations;
+};
+exports.fetchLocalizations = fetchLocalizations;

package/build/commands/localizations/utils/readLocalizationFiles.d.ts

@@ -0,0 +1,6 @@
+import { Localization } from '@extrahorizon/javascript-sdk';
+export interface LocalizationFilesOutput {
+    localizations: Pick<Localization, 'key' | 'text'>[];
+    languageCodes: string[];
+}
+export declare const readLocalizationFiles: (path: string, keys?: string[], languageCodes?: string[]) => LocalizationFilesOutput;

package/build/commands/localizations/utils/readLocalizationFiles.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readLocalizationFiles = void 0;
+const fs_1 = require("fs");
+const ospath = require("path");
+const util_1 = require("../../../helpers/util");
+const assertValidLanguageCode_1 = require("./assertValidLanguageCode");
+const readLocalizationFiles = (path, keys, languageCodes) => {
+    const uniqueLanguageCodes = new Set();
+    const localizationMap = {};
+    const fileNames = (0, fs_1.readdirSync)(path);
+    for (const fileName of fileNames) {
+        const parsedFileName = ospath.parse(fileName);
+        const languageCode = parsedFileName.name.toUpperCase();
+        (0, assertValidLanguageCode_1.assertValidLanguageCode)(languageCode);
+        if (parsedFileName.ext !== '.json') {
+            continue;
+        }
+        if (languageCodes && !languageCodes.includes(languageCode)) {
+            continue;
+        }
+        uniqueLanguageCodes.add(languageCode);
+        const localizationJson = (0, util_1.readJsonFileSync)(ospath.join(path, fileName));
+        for (const [key, text] of Object.entries(localizationJson)) {
+            if (keys && !keys.includes(key)) {
+                continue;
+            }
+            if (!(key in localizationMap)) {
+                localizationMap[key] = { key, text: {} };
+            }
+            localizationMap[key].text[languageCode] = text;
+        }
+    }
+    return {
+        localizations: Object.values(localizationMap),
+        languageCodes: [...uniqueLanguageCodes.values()],
+    };
+};
+exports.readLocalizationFiles = readLocalizationFiles;

package/build/commands/localizations/utils/syncLocalizations.d.ts

@@ -0,0 +1,2 @@
+import { Localization, OAuth1Client } from '@extrahorizon/javascript-sdk';
+export declare const syncLocalizations: (sdk: OAuth1Client, configLocalizations: Pick<Localization, 'key' | 'text'>[], fetchedLocalizations: Localization[]) => Promise<void>;

package/build/commands/localizations/utils/syncLocalizations.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.syncLocalizations = void 0;
+const chalk = require("chalk");
+const getMissingLocalizations = (configLocalizations, fetchedLocalizations) => configLocalizations.filter(configLocalization => fetchedLocalizations.find(fetchedLocalization => fetchedLocalization.key === configLocalization.key) === undefined);
+const getChangedLocalizations = (configLocalizations, fetchedLocalizations) => {
+    const changedLocalizations = [];
+    for (const configLocalization of configLocalizations) {
+        const knownLocalization = fetchedLocalizations.find(fetchedLocalization => fetchedLocalization.key === configLocalization.key);
+        if (knownLocalization) {
+            const localizationUpdateData = {
+                key: configLocalization.key,
+                text: {},
+            };
+            for (const [newLanguage, newText] of Object.entries(configLocalization.text)) {
+                const knownText = knownLocalization.text[newLanguage];
+                if (!knownText || knownText !== newText) {
+                    localizationUpdateData.text[newLanguage] = newText;
+                }
+            }
+            if (Object.keys(localizationUpdateData.text).length > 0) {
+                changedLocalizations.push(localizationUpdateData);
+            }
+        }
+    }
+    return changedLocalizations;
+};
+const syncLocalizations = async (sdk, configLocalizations, fetchedLocalizations) => {
+    const localizationsToCreate = getMissingLocalizations(configLocalizations, fetchedLocalizations);
+    const localizationsToUpdate = getChangedLocalizations(configLocalizations, fetchedLocalizations);
+    console.log(`- Creating of ${localizationsToCreate.length} new localization key(s).`);
+    if (localizationsToCreate.length > 0) {
+        await sdk.localizations.create({
+            localizations: localizationsToCreate,
+        });
+        console.log(chalk.green('Successful!'));
+    }
+    console.log(`- Updating of ${localizationsToUpdate.length} new localization key(s).`);
+    if (localizationsToUpdate.length > 0) {
+        await sdk.localizations.update({
+            localizations: localizationsToUpdate,
+        });
+        console.log(chalk.green('Successful!'));
+    }
+};
+exports.syncLocalizations = syncLocalizations;

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/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/util.d.ts

@@ -1,3 +1,4 @@
 import * as yargs from 'yargs';
 export declare function epilogue(y: yargs.Argv): yargs.Argv;
 export declare function asyncExec(cmd: string): Promise<string>;
+export declare function readJsonFileSync<T>(path: string): T;

package/build/helpers/util.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asyncExec = exports.epilogue = void 0;
+exports.readJsonFileSync = exports.asyncExec = exports.epilogue = void 0;
 const child_process_1 = require("child_process");
+const fs_1 = require("fs");
 const chalk = require("chalk");
 const error_1 = require("./error");
 function epilogue(y) {
@@ -34,3 +35,8 @@ async function asyncExec(cmd) {
     });
 }
 exports.asyncExec = asyncExec;
+function readJsonFileSync(path) {
+    const fileContent = (0, fs_1.readFileSync)(path, { encoding: 'utf-8' });
+    return JSON.parse(fileContent);
+}
+exports.readJsonFileSync = readJsonFileSync;

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/exh-cli",
-  "version": "1.5.1",
+  "version": "1.6.0-dev-38-562ae51",
   "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"
   }