@extrahorizon/exh-cli 1.10.0-dev-104-c76c2f8 → 1.10.0-dev-106-ff8535b

package/build/commands/data/schemas/init.js

@@ -29,7 +29,7 @@ const handler = async function init({ name, path }) {
 exports.handler = handler;
 function createSchema(name) {
     return {
-        $schema: 'https://swagger.extrahorizon.com/cli/1.10.0/config-json-schemas/Schema.json',
+        $schema: `https://swagger.extrahorizon.com/cli/${(0, util_1.getCliVersion)()}/config-json-schemas/Schema.json`,
         name,
         description: `The ${name} schema`,
         createMode: 'allUsers',

package/build/commands/tasks/createrepo.js

@@ -34,6 +34,7 @@ async function changePackageFile(name) {
     }
     try {
         const taskConfig = JSON.parse((await (0, promises_1.readFile)(`${name}/task-config.json`)).toString());
+        taskConfig.$schema = `https://swagger.extrahorizon.com/cli/${(0, util_1.getCliVersion)()}/config-json-schemas/TaskConfig.json`;
         taskConfig.name = name;
         taskConfig.description = `${name} task`;
         await (0, promises_1.writeFile)(`${name}/task-config.json`, JSON.stringify(taskConfig, null, 4));

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

@@ -1,7 +1,7 @@
 /// <reference types="yargs" />
 export declare const command = "sync";
 export declare const desc = "Sync a task. Will create the task first if it doesn't exist yet";
-export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "description" | "code" | "name" | "path" | "env" | "entryPoint" | "runtime" | "timeLimit" | "memoryLimit" | "executionPermission"> & import("yargs").InferredOptionTypes<{
+export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "description" | "code" | "name" | "path" | "entryPoint" | "runtime" | "env" | "timeLimit" | "memoryLimit" | "executionPermission"> & import("yargs").InferredOptionTypes<{
     path: {
         demandOption: false;
         describe: string;

package/build/commands/tasks/taskConfig.js

@@ -4,33 +4,14 @@ exports.getValidatedConfigIterator = exports.loadSingleConfigFile = exports.vali
 const assert_1 = require("assert");
 const fs = require("fs/promises");
 const ospath = require("path");
-const Joi = require("joi");
-const constants_1 = require("../../constants");
+const ajv_1 = require("ajv");
+const taskConfigSchema = require("../../config-json-schemas/TaskConfig.json");
 var permissionModes;
 (function (permissionModes) {
     permissionModes["permissionRequired"] = "permissionRequired";
     permissionModes["allUsers"] = "allUsers";
     permissionModes["public"] = "public";
 })(permissionModes = exports.permissionModes || (exports.permissionModes = {}));
-const taskConfigSchema = Joi.object({
-    name: Joi.string().pattern(/^[A-Za-z0-9-]+$/).required(),
-    description: Joi.string(),
-    entryPoint: Joi.string().required(),
-    runtime: Joi.string().valid(...constants_1.runtimeChoices).required(),
-    timeLimit: Joi.number().min(constants_1.limits.time.min).max(constants_1.limits.time.max),
-    memoryLimit: Joi.number().min(constants_1.limits.memory.min).max(constants_1.limits.memory.max),
-    path: Joi.string(),
-    retryPolicy: Joi.object({
-        enabled: Joi.boolean().required(),
-        errorsToRetry: Joi.array().items(Joi.string()),
-    }),
-    environment: Joi.object().pattern(/.*/, Joi.string()),
-    executionPermission: Joi.string().valid(...Object.values(permissionModes)),
-    executionCredentials: Joi.object({
-        email: Joi.string(),
-        permissions: Joi.array().items(Joi.string()).required(),
-    }),
-});
 function assertExecutionPermission(mode) {
     if (mode !== undefined && !Object.values(permissionModes).includes(mode)) {
         throw new assert_1.AssertionError({ message: `executionPermission incorrect. Should be one of ${Object.values(permissionModes).join(',')}` });
@@ -70,25 +51,20 @@ function replaceConfigVariables(config) {
     return result;
 }
 async function validateConfig(config) {
+    const validate = new ajv_1.default().compile(taskConfigSchema);
+    const valid = validate(config);
+    if (!valid) {
+        const errors = getAjvErrorStrings(validate.errors);
+        throw new Error(errors[0] || 'Unknown config validation error');
+    }
     try {
-        Joi.attempt(config, taskConfigSchema);
+        await fs.access(config.path);
     }
     catch (err) {
-        throw new Error(err.details[0]?.message || 'Unknown config validation error');
+        throw new Error(`Please provide a valid directory path for your code, ${config.path} not found`);
     }
-    if (config.path) {
-        try {
-            await fs.access(config.path);
-        }
-        catch (err) {
-            throw new Error(`Please provide a valid directory path for your code, ${config.path} not found`);
-        }
-        if ((await fs.stat(config.path)).isFile()) {
-            throw new Error(`please provide a valid directory path for your code, ${config.path} points to a file`);
-        }
-    }
-    else {
-        throw new Error('Code path not specified');
+    if ((await fs.stat(config.path)).isFile()) {
+        throw new Error(`please provide a valid directory path for your code, ${config.path} points to a file`);
     }
     if (config.executionCredentials && config.environment) {
         const restrictedProperties = ['API_HOST', 'API_OAUTH_CONSUMER_KEY', 'API_OAUTH_CONSUMER_SECRET', 'API_OAUTH_TOKEN', 'API_OAUTH_TOKEN_SECRET'];
@@ -178,3 +154,16 @@ async function* getValidatedConfigIterator({ path, name, code, entryPoint, runti
     yield taskConfig;
 }
 exports.getValidatedConfigIterator = getValidatedConfigIterator;
+function getAjvErrorStrings(errors) {
+    return errors.map(error => {
+        let message = '';
+        if (error.instancePath) {
+            const normalizedPath = error.instancePath
+                .replace(/^\//, '')
+                .replace(/\//g, '.');
+            message += `"${normalizedPath}" `;
+        }
+        message += error.message || 'has an unknown error';
+        return message;
+    });
+}

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

@@ -0,0 +1,131 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "properties": {
+        "$schema": {
+            "type": "string"
+        },
+        "name": {
+            "description": "The unique identifier amongst all Functions.",
+            "type": "string",
+            "pattern": "^[A-Za-z0-9-]+$"
+        },
+        "description": {
+            "description": "A brief explanation regarding a Function's purpose.",
+            "type": "string"
+        },
+        "path": {
+            "description": "The location of the Function's source code, relative to the folder this configuration file is in. This should be a folder, the code will be zipped and uploaded. Use `./` for the current folder.",
+            "type": "string"
+        },
+        "entryPoint": {
+            "description": "The file and function name to be executed when the Function is invoked. The format is `fileName.functionName`, relative to the `path` property. For example, if the `path` is `./src` and the entry point is `index.handler`, it will look for `./src/index.js` and execute the `handler` function.",
+            "type": "string"
+        },
+        "runtime": {
+            "description": "The runtime (or environment) the Function will be running in.",
+            "type": "string",
+            "enum": [
+                "nodejs22.x",
+                "nodejs20.x",
+                "nodejs18.x",
+                "nodejs16.x",
+                "python3.13",
+                "python3.12",
+                "python3.11",
+                "python3.10",
+                "python3.9",
+                "python3.8",
+                "java21",
+                "java17",
+                "java11",
+                "java8.al2",
+                "dotnet9",
+                "dotnet8",
+                "dotnet7",
+                "dotnet6",
+                "ruby3.4",
+                "ruby3.3",
+                "ruby3.2",
+                "provided.al2023",
+                "provided.al2"
+            ]
+        },
+        "timeLimit": {
+            "description": "The maximum allowed execution time limit for this Function in seconds. It must be between 3 and 300 seconds.",
+            "type": "integer",
+            "minimum": 3,
+            "maximum": 300
+        },
+        "memoryLimit": {
+            "description": "The maximum amount of memory (in MB) that this Function can use. It must be between 128 and 10240.",
+            "type": "integer",
+            "minimum": 128,
+            "maximum": 10240
+        },
+        "executionPermission": {
+            "description": "Defines access for executing the function directly or for invoking it as an API function.",
+            "enum": [
+                "permissionRequired",
+                "allUsers",
+                "public"
+            ]
+        },
+        "environment": {
+            "description": "The environment variables added to the Function execution runtime.",
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "retryPolicy": {
+            "description": "The policy that determines system behavior after the execution of a Function fails.",
+            "type": "object",
+            "properties": {
+                "enabled": {
+                    "description": "The retry policy is disabled by default, If this field is set to true, the retry policy becomes active. If active the policy will retry a maximum of 3 times, with an increasing timeout of 2, 5 and 10 seconds respectively.",
+                    "type": "boolean"
+                },
+                "errorsToRetry": {
+                    "description": "A list of error names that should trigger a retry. If not specified, the default is to retry on all errors.",
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            },
+            "required": [
+                "enabled"
+            ],
+            "additionalProperties": false
+        },
+        "executionCredentials": {
+            "description": "When this property is set, the CLI will automatically create a User and Global Role with the defined permissions for the Function. Credentials for this User will be injected into the Function's environment automatically. The Global Role and its permissions will be managed by the CLI and synchronized whenever the executionCredentials.permissions property is updated.",
+            "type": "object",
+            "properties": {
+                "permissions": {
+                    "description": "The permissions that will be attached to the Global Role for the created user. The Global Role will be created with a name like exh.tasks.<your function name>.",
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "email": {
+                    "description": "By default the CLI generates an email address like exh.tasks+<your function name>@extrahorizon.com for the User which is created for the Function. If you like you can change this behavior and provide your own email address to retain ownership of the user account.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "permissions"
+            ],
+            "additionalProperties": false
+        }
+    },
+    "required": [
+        "name",
+        "path",
+        "entryPoint",
+        "runtime"
+    ],
+    "additionalProperties": false
+}

package/build/constants.js

@@ -3,33 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.limits = exports.runtimeChoices = exports.EXH_CONFIG_FILE = exports.EXH_CONFIG_FILE_DIR = void 0;
 const os_1 = require("os");
 const path = require("path");
+const taskConfigSchema = require("./config-json-schemas/TaskConfig.json");
 exports.EXH_CONFIG_FILE_DIR = path.join((0, os_1.homedir)(), '/.exh');
 exports.EXH_CONFIG_FILE = `${exports.EXH_CONFIG_FILE_DIR}/credentials`;
-exports.runtimeChoices = [
-    'nodejs22.x',
-    'nodejs16.x',
-    'nodejs20.x',
-    'nodejs18.x',
-    'python3.13',
-    'python3.12',
-    'python3.11',
-    'python3.10',
-    'python3.9',
-    'python3.8',
-    'java21',
-    'java17',
-    'java11',
-    'java8.al2',
-    'dotnet9',
-    'dotnet8',
-    'dotnet7',
-    'dotnet6',
-    'ruby3.4',
-    'ruby3.3',
-    'ruby3.2',
-    'provided.al2023',
-    'provided.al2',
-];
+exports.runtimeChoices = taskConfigSchema.properties.runtime.enum;
 exports.limits = {
     time: {
         min: 3,

package/build/helpers/util.d.ts

@@ -2,3 +2,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 loadAndAssertCredentials(): void;
+export declare function getCliVersion(): any;

package/build/helpers/util.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadAndAssertCredentials = exports.asyncExec = exports.epilogue = void 0;
+exports.getCliVersion = exports.loadAndAssertCredentials = exports.asyncExec = exports.epilogue = void 0;
 const child_process_1 = require("child_process");
 const fs = require("fs");
+const path = require("path");
 const chalk = require("chalk");
 const constants_1 = require("../constants");
 const error_1 = require("./error");
@@ -65,3 +66,9 @@ function loadAndAssertCredentials() {
     }
 }
 exports.loadAndAssertCredentials = loadAndAssertCredentials;
+function getCliVersion() {
+    const packageJsonPath = path.join(__dirname, '../../package.json');
+    const packageJsonString = fs.readFileSync(packageJsonPath, 'utf-8');
+    return JSON.parse(packageJsonString).version;
+}
+exports.getCliVersion = getCliVersion;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/exh-cli",
-  "version": "1.10.0-dev-104-c76c2f8",
+  "version": "1.10.0-dev-106-ff8535b",
   "main": "build/index.js",
   "exports": "./build/index.js",
   "license": "MIT",