@extrahorizon/exh-cli 1.13.0-feat-168-eab0ce8 → 1.13.0

package/build/commands/tasks/sync.js

@@ -11,46 +11,46 @@ const builder = (yargs) => (0, util_1.epilogue)(yargs)
     .options({
     path: {
         demandOption: false,
-        describe: `Path of the configuration json file containing task parameters. If a directory is given instead, all sub-directories will be searched for a task-config.json file & synced. 
+        description: `Path of the configuration json file containing task parameters. If a directory is given instead, all sub-directories will be searched for a task-config.json file & synced. 
       If this option is not used, each parameter (name, code, entryPoint, runtime, ...) will need to be supplied separately`,
         type: 'string',
     },
     name: {
         demandOption: false,
-        describe: 'Name of the task',
+        description: 'Name of the task',
         type: 'string',
     },
     code: {
         demandOption: false,
-        describe: 'The path to a directory containing the built task. exh-cli will compress the directory and upload it',
+        description: 'The path to a directory containing the built task. exh-cli will compress the directory and upload it',
         type: 'string',
     },
     entryPoint: {
         demandOption: false,
-        describe: "The code function that should be invoked. For example 'index.handler' for Nodejs",
+        description: "The code function that should be invoked. For example 'index.handler' for Nodejs",
         type: 'string',
     },
     runtime: {
         demandOption: false,
-        describe: 'Runtime to use for the task',
+        description: 'Runtime to use for the task',
         choices: constants_1.runtimeChoices,
         type: 'string',
     },
     description: {
-        describe: 'A description for this task',
+        description: 'A description for this task',
         type: 'string',
         default: '',
     },
     timeLimit: {
-        describe: 'The execution time limit for this task (in seconds). Min: 3 max: 900',
+        description: 'The execution time limit for this task (in seconds). Min: 3 max: 900',
         type: 'number',
     },
     memoryLimit: {
-        describe: 'The allocated memory for this task (in MB). Min: 128 max: 10240',
+        description: 'The allocated memory for this task (in MB). Min: 128 max: 10240',
         type: 'number',
     },
     env: {
-        describe: 'Environment Variables set for this task. This option can be used multiple times.',
+        description: 'Environment Variables set for this task. This option can be used multiple times.',
         type: 'string',
         default: [],
     },

package/build/commands/templates/delete.d.ts

@@ -3,11 +3,11 @@ export declare const command = "delete";
 export declare const desc = "Delete a template";
 export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "id" | "name"> & import("yargs").InferredOptionTypes<{
     name: {
-        describe: string;
+        description: string;
         type: "string";
     };
     id: {
-        describe: string;
+        description: string;
         type: "string";
     };
 }>>;

package/build/commands/templates/delete.js

@@ -8,11 +8,11 @@ exports.desc = 'Delete a template';
 const builder = (yargs) => (0, util_1.epilogue)(yargs)
     .options({
     name: {
-        describe: 'Name of the template to delete',
+        description: 'Name of the template to delete',
         type: 'string',
     },
     id: {
-        describe: 'ID of the template to delete',
+        description: 'ID of the template to delete',
         type: 'string',
     },
 })

package/build/commands/templates/get.d.ts

@@ -3,11 +3,11 @@ export declare const command = "get";
 export declare const desc = "Fetch a template";
 export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "id" | "name"> & import("yargs").InferredOptionTypes<{
     name: {
-        describe: string;
+        description: string;
         type: "string";
     };
     id: {
-        describe: string;
+        description: string;
         type: "string";
     };
 }>>;

package/build/commands/templates/get.js

@@ -8,11 +8,11 @@ exports.desc = 'Fetch a template';
 const builder = (yargs) => (0, util_1.epilogue)(yargs)
     .options({
     name: {
-        describe: 'Name of the template',
+        description: 'Name of the template',
         type: 'string',
     },
     id: {
-        describe: 'ID of the template',
+        description: 'ID of the template',
         type: 'string',
     },
 })

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

@@ -4,12 +4,12 @@ export declare const desc = "Sync all templates in a directory with the ExH clou
 export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "template" | "path"> & import("yargs").InferredOptionTypes<{
     path: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "string";
     };
     template: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "string";
     };
 }>>;

package/build/commands/templates/sync.js

@@ -11,12 +11,12 @@ const builder = (yargs) => (0, util_1.epilogue)(yargs)
     .options({
     path: {
         demandOption: false,
-        describe: 'Directory containing the templates which need to be synced',
+        description: 'Directory containing the templates which need to be synced',
         type: 'string',
     },
     template: {
         demandOption: false,
-        describe: 'Template file to sync',
+        description: 'Template file to sync',
         type: 'string',
     },
 })

package/build/config-json-schemas/Dispatchers.json

@@ -71,7 +71,11 @@
         },
         "MailAction": {
             "type": "object",
-            "required": ["type", "name", "recipients", "templateId"],
+            "required": ["type", "name", "recipients"],
+            "anyOf": [
+                { "required": ["templateId"] },
+                { "required": ["templateName"] }
+            ],
             "properties": {
                 "type": { "const": "mail" },
                 "name": { "type": "string" },
@@ -94,7 +98,15 @@
                         }
                     }
                 },
-                "templateId": { "type": "string" }
+                "templateId": {
+                    "deprecated": true,
+                    "description": "Deprecated, use templateName instead to target a V2 template by its name.",
+                    "type": "string"
+                },
+                "templateName": {
+                    "description": "The name of a V2 template",
+                    "type": "string"
+                }
             }
         },
         "TaskAction": {

package/build/config-json-schemas/Template.json

@@ -1,67 +1,38 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "if": {
-        "description": "Try to determine if we have V1 schema",
-        "anyOf": [
-            {
-                "type": "object",
-                "required": ["version"],
-                "properties": { "version": { "const": 1 } }
-            },
-            {
-                "type": "object",
-                "required": ["schema"],
-                "properties": {
-                    "version": { "const": 1 },
-                    "schema": true
-                }
-            },
-            {
-                "type": "object",
-                "required": ["fields"],
-                "properties": {
-                    "version": { "const": 1 },
-                    "fields": true
-                }
-            }
-        ]
-    },
-    "then": { "$ref": "#/definitions/TemplateV1" },
-    "else": { "$ref": "#/definitions/TemplateV2" },
-    "definitions": {
-        "TemplateV2": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "$schema": { "type": "string" },
+        "description": {
+            "type": "string",
+            "minLength": 1
+        },
+        "extendsTemplate": { "type": "string" },
+        "inputs": {
             "type": "object",
-            "additionalProperties": false,
-            "properties": {
-                "version": { "const": 2 },
-                "$schema": { "type": "string" },
-                "description": {
-                    "type": "string",
-                    "minLength": 1
-                },
-                "extendsTemplate": { "type": "string" },
-                "inputs": {
-                    "type": "object",
-                    "additionalProperties": { "$ref": "#/definitions/TypeConfigurationV2" }
-                },
-                "outputs": {
-                    "type": "object",
-                    "additionalProperties": {
-                        "type": "string",
-                        "minLength": 1
-                    }
-                },
-                "variables": {
-                    "type": "object",
-                    "additionalProperties": { "type": "string" }
-                }
+            "additionalProperties": { "$ref": "#/definitions/TypeConfigurationV2" }
+        },
+        "outputs": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string",
+                "minLength": 1
             }
         },
+        "variables": {
+            "type": "object",
+            "additionalProperties": { "type": "string" }
+        }
+    },
+    "definitions": {
         "TypeConfigurationV2": {
             "type": "object",
             "required": ["type"],
             "properties": {
-                "type": { "enum": ["object", "array", "string", "number", "boolean"] }
+                "type": {
+                    "enum": ["object", "array", "string", "number", "boolean"]
+                }
             },
             "allOf": [
                 {
@@ -155,149 +126,6 @@
             "properties": {
                 "type": { "const": "boolean" }
             }
-        },
-        "TemplateV1": {
-            "type": "object",
-            "required": ["description", "schema", "fields"],
-            "properties": {
-                "version": { "const": 1 },
-                "$schema": { "type": "string" },
-                "extends_template": { "type": "string" },
-                "description": { "type": "string" },
-                "schema": { "$ref": "#/definitions/ObjectConfiguration" },
-                "fields": {
-                    "type": "object",
-                    "additionalProperties": { "type": "string" }
-                }
-            }
-        },
-        "TypeConfiguration": {
-            "type": "object",
-            "required": ["type"],
-            "properties": {
-                "type": { "enum": ["object", "array", "string", "number", "boolean", "object_id", "date"] }
-            },
-            "allOf": [
-                {
-                    "if": {
-                        "type": "object",
-                        "properties": {
-                            "type": { "const": "object" }
-                        }
-                    },
-                    "then": { "$ref": "#/definitions/ObjectConfiguration" }
-                },
-                {
-                    "if": {
-                        "type": "object",
-                        "properties": {
-                            "type": { "const": "array" }
-                        }
-                    },
-                    "then": { "$ref": "#/definitions/ArrayConfiguration" }
-                },
-                {
-                    "if": {
-                        "type": "object",
-                        "properties": {
-                            "type": { "const": "string" }
-                        }
-                    },
-                    "then": { "$ref": "#/definitions/StringConfiguration" }
-                },
-                {
-                    "if": {
-                        "type": "object",
-                        "properties": {
-                            "type": { "const": "number" }
-                        }
-                    },
-                    "then": { "$ref": "#/definitions/NumberConfiguration" }
-                },
-                {
-                    "if": {
-                        "type": "object",
-                        "properties": {
-                            "type": { "const": "boolean" }
-                        }
-                    },
-                    "then": { "$ref": "#/definitions/BooleanConfiguration" }
-                },
-                {
-                    "if": {
-                        "type": "object",
-                        "properties": {
-                            "type": { "const": "object_id" }
-                        }
-                    },
-                    "then": { "$ref": "#/definitions/ObjectIdConfiguration" }
-                },
-                {
-                    "if": {
-                        "type": "object",
-                        "properties": {
-                            "type": { "const": "date" }
-                        }
-                    },
-                    "then": { "$ref": "#/definitions/DateConfiguration" }
-                }
-            ]
-        },
-        "ObjectConfiguration": {
-            "type": "object",
-            "required": ["type"],
-            "properties": {
-                "type": { "const": "object" },
-                "fields": {
-                    "type": "object",
-                    "additionalProperties": {
-                        "$ref": "#/definitions/TypeConfiguration"
-                    }
-                }
-            }
-        },
-        "ArrayConfiguration": {
-            "type": "object",
-            "required": ["type", "type_configuration"],
-            "properties": {
-                "type": { "const": "array" },
-                "type_configuration": { "$ref": "#/definitions/TypeConfiguration" }
-            }
-        },
-        "StringConfiguration": {
-            "type": "object",
-            "required": ["type"],
-            "properties": {
-                "type": { "const": "string" }
-            }
-        },
-        "NumberConfiguration": {
-            "type": "object",
-            "required": ["type"],
-            "properties": {
-                "type": { "const": "number" }
-            }
-        },
-        "BooleanConfiguration": {
-            "type": "object",
-            "required": ["type"],
-            "properties": {
-                "type": { "const": "boolean" }
-            }
-        },
-        "ObjectIdConfiguration": {
-            "type": "object",
-            "required": ["type"],
-            "properties": {
-                "type": { "const": "object_id" }
-            }
-        },
-        "DateConfiguration": {
-            "type": "object",
-            "required": ["type"],
-            "properties": {
-                "type": { "const": "date" }
-            }
         }
     }
 }

package/build/exh.d.ts

@@ -1,4 +1,5 @@
 import { OAuth1Client } from '@extrahorizon/javascript-sdk';
-export declare function sdkInitOnly(apiHost: string, consumerKey: string, consumerSecret: string): OAuth1Client;
 export declare function sdkAuth(): Promise<OAuth1Client>;
 export declare function getSdk(): OAuth1Client;
+export declare function getNewSdkInstance(): OAuth1Client;
+export declare function writeCredentialsToFile(host: string, consumerKey: string, consumerSecret: string, token: string, tokenSecret: string): void;

package/build/exh.js

@@ -1,25 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSdk = exports.sdkAuth = exports.sdkInitOnly = void 0;
+exports.writeCredentialsToFile = exports.getNewSdkInstance = exports.getSdk = exports.sdkAuth = void 0;
+const fs = require("fs");
 const javascript_sdk_1 = require("@extrahorizon/javascript-sdk");
-const util_1 = require("./helpers/util");
+const chalk = require("chalk");
+const constants_1 = require("./constants");
 let sdk = null;
-function sdkInitOnly(apiHost, consumerKey, consumerSecret) {
-    sdk = (0, javascript_sdk_1.createOAuth1Client)({
-        consumerKey,
-        consumerSecret,
-        host: apiHost,
-    });
-    return sdk;
-}
-exports.sdkInitOnly = sdkInitOnly;
 async function sdkAuth() {
-    (0, util_1.loadAndAssertCredentials)();
-    sdk = (0, javascript_sdk_1.createOAuth1Client)({
-        host: process.env.API_HOST,
-        consumerKey: process.env.API_OAUTH_CONSUMER_KEY,
-        consumerSecret: process.env.API_OAUTH_CONSUMER_SECRET,
-    });
+    loadAndAssertCredentials();
+    sdk = getNewSdkInstance();
     try {
         await sdk.auth.authenticate({
             token: process.env.API_OAUTH_TOKEN,
@@ -39,3 +28,55 @@ function getSdk() {
     return sdk;
 }
 exports.getSdk = getSdk;
+function getNewSdkInstance() {
+    return (0, javascript_sdk_1.createOAuth1Client)({
+        host: process.env.API_HOST,
+        consumerKey: process.env.API_OAUTH_CONSUMER_KEY,
+        consumerSecret: process.env.API_OAUTH_CONSUMER_SECRET,
+    });
+}
+exports.getNewSdkInstance = getNewSdkInstance;
+function loadAndAssertCredentials() {
+    const credentials = {};
+    let errorMessage = '';
+    try {
+        const credentialsFile = fs.readFileSync(constants_1.EXH_CONFIG_FILE, 'utf-8');
+        const credentialFileLines = credentialsFile.split(/\r?\n/);
+        for (const credentialFileLine of credentialFileLines) {
+            const [key, value] = credentialFileLine.split('=');
+            if (key && value) {
+                credentials[key.trim()] = value.trim();
+            }
+        }
+    }
+    catch (e) {
+        errorMessage += 'Couldn\'t open ~/.exh/credentials. ';
+    }
+    const requiredEnvVariables = ['API_HOST', 'API_OAUTH_CONSUMER_KEY', 'API_OAUTH_CONSUMER_SECRET', 'API_OAUTH_TOKEN', 'API_OAUTH_TOKEN_SECRET'];
+    for (const key of requiredEnvVariables) {
+        if (credentials[key] && !process.env[key]) {
+            process.env[key] = credentials[key];
+        }
+    }
+    const missingEnvironmentVariables = requiredEnvVariables.filter(key => !process.env[key]);
+    if (missingEnvironmentVariables.length > 0) {
+        errorMessage += `Missing environment variables: ${missingEnvironmentVariables.join(',')}`;
+        throw new Error(`Failed to retrieve all credentials. ${errorMessage}`);
+    }
+}
+function writeCredentialsToFile(host, consumerKey, consumerSecret, token, tokenSecret) {
+    try {
+        fs.statSync(constants_1.EXH_CONFIG_FILE_DIR);
+    }
+    catch (err) {
+        fs.mkdirSync(constants_1.EXH_CONFIG_FILE_DIR);
+    }
+    fs.writeFileSync(constants_1.EXH_CONFIG_FILE, `API_HOST=${host}
+API_OAUTH_CONSUMER_KEY=${consumerKey}
+API_OAUTH_CONSUMER_SECRET=${consumerSecret}
+API_OAUTH_TOKEN=${token}
+API_OAUTH_TOKEN_SECRET=${tokenSecret}
+`);
+    console.log(chalk.green('Wrote credentials to', constants_1.EXH_CONFIG_FILE));
+}
+exports.writeCredentialsToFile = writeCredentialsToFile;

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): Promise<any>;
+export declare function getRepoConfig(targetPath: string): any;

package/build/helpers/repoConfig.js

@@ -1,57 +1,63 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRepoConfig = exports.REPO_CONFIG_FILE = void 0;
-const fs = require("fs/promises");
+const fs = require("fs");
 const ospath = require("path");
 const chalk = require("chalk");
 exports.REPO_CONFIG_FILE = 'repo-config.json';
-async function getDefaultConfig(targetPath) {
+function getRepoConfig(targetPath) {
+    let cfg = getDefaultConfig(targetPath);
+    try {
+        const fileContent = fs.readFileSync(ospath.join(targetPath, exports.REPO_CONFIG_FILE), 'utf-8');
+        cfg = JSON.parse(fileContent);
+    }
+    catch (err) { }
+    return validateRepoConfig(targetPath, cfg);
+}
+exports.getRepoConfig = getRepoConfig;
+function getDefaultConfig(targetPath) {
     const config = {};
     const sections = ['schemas', 'templates', 'tasks', 'localizations'];
     for (const s of sections) {
-        try {
-            await fs.access(ospath.join(targetPath, s));
+        if (pathExists(ospath.join(targetPath, s))) {
             config[s] = [s];
         }
-        catch (err) {
-            continue;
-        }
     }
     return config;
 }
-async function validateRepoConfig(targetPath, config) {
-    const checkDirAccess = async (basePath, paths) => {
-        const result = [];
-        if (!Array.isArray(paths)) {
-            throw new Error('Not an array');
-        }
-        for (const p of paths) {
-            try {
-                await fs.access(ospath.join(basePath, p));
-            }
-            catch (err) {
-                console.log(chalk.yellow(`Warning: '${p}' directory not found`));
-                continue;
-            }
-            if (!(await fs.stat(ospath.join(basePath, p))).isDirectory()) {
-                throw new Error(`${p} is not a directory`);
-            }
-            result.push(p);
-        }
-        return result;
-    };
+function validateRepoConfig(targetPath, config) {
     const newConfig = { ...config };
     for (const [key] of Object.entries(config)) {
-        newConfig[key] = await checkDirAccess(targetPath, config[key]);
+        newConfig[key] = checkDirAccess(targetPath, config[key]);
     }
     return newConfig;
 }
-async function getRepoConfig(targetPath) {
-    let cfg = await getDefaultConfig(targetPath);
+function checkDirAccess(basePath, paths) {
+    const result = [];
+    if (!Array.isArray(paths)) {
+        throw new Error('Not an array');
+    }
+    for (const p of paths) {
+        if (!pathExists(ospath.join(basePath, p))) {
+            console.log(chalk.yellow(`Warning: '${p}' directory not found`));
+            continue;
+        }
+        if (!isDirectory(ospath.join(basePath, p))) {
+            throw new Error(`${p} is not a directory`);
+        }
+        result.push(p);
+    }
+    return result;
+}
+function pathExists(p) {
     try {
-        cfg = JSON.parse((await fs.readFile(ospath.join(targetPath, exports.REPO_CONFIG_FILE))).toString());
+        fs.accessSync(p);
+        return true;
+    }
+    catch {
+        return false;
     }
-    catch (err) { }
-    return await validateRepoConfig(targetPath, cfg);
 }
-exports.getRepoConfig = getRepoConfig;
+function isDirectory(path) {
+    return fs.statSync(path).isDirectory();
+}

package/build/helpers/util.d.ts

@@ -1,7 +1,6 @@
 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 loadAndAssertCredentials(): void;
 export declare function getSwaggerDocumentationUrl(subPath: string): string;
 export declare function ajvValidate<T>(schema: any, data: any): asserts data is T;
 export declare function getAjvErrorStrings(errors: any[]): string[];