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

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Extra Horizon CLI changelog
 
 ### v1.13.0
+* Introduced `exh settings sync`, by default enabling synchronization of service settings from a `service-settings.json` file.
+* Added `exh dispatchers init`, which creates a dispatcher in a new `dispatchers.json` file or appends a new dispatcher to an existing configuration.
+* Added `exh templates init`, generating a basic email template in the `./templates` directory.
+* Introduced `exh tasks init`, replacing `exh tasks create-repo` for task creation.
+  * Aligned behavior with other `init` commands by initializing new tasks in the `./tasks` directory by default.
+* Added support for a `templateName` field in mail actions within dispatchers.
+  * The CLI automatically resolves the template id based on the provided template name.
+* Removed validation for v1 templates, focusing on improved support for v2 templates in JetBrains IDEs using the provided JSON schemas via `$schema`.
+* Updated `exh tasks sync` to create users with `activationMode: 'manual'`, preventing unnecessary activation emails.
+* Made file argument optional for `exh dispatchers sync`, defaults to `./dispatchers.json` when no file argument is provided.
+* Deprecated `exh tasks create-repo` in favor of the new `exh tasks init` command.
+* Deprecated the use of `templateId` in mail actions, recommending `templateName` instead.
 
 ### v1.12.0
 * Now adding `$schema` as the last property when creating a new schema via `exh data schemas init`

package/build/commands/data/schemas/sync.d.ts

@@ -4,22 +4,22 @@ export declare const desc = "Sync all schemas in a directory with the ExH cloud"
 export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "file" | "dir" | "dry" | "ignoreVerificationErrors"> & import("yargs").InferredOptionTypes<{
     dir: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "string";
     };
     file: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "string";
     };
     dry: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "boolean";
     };
     ignoreVerificationErrors: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "boolean";
         default: boolean;
     };

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

@@ -8,22 +8,22 @@ exports.desc = 'Sync all schemas in a directory with the ExH cloud';
 const builder = (yargs) => (0, util_1.epilogue)(yargs).options({
     dir: {
         demandOption: false,
-        describe: 'Directory containing the schemas which need to be synced',
+        description: 'Directory containing the schemas which need to be synced',
         type: 'string',
     },
     file: {
         demandOption: false,
-        describe: 'File containing a schema which needs to be synced',
+        description: 'File containing a schema which needs to be synced',
         type: 'string',
     },
     dry: {
         demandOption: false,
-        describe: 'When set, a dry-run will be performed. Only output will be printed, but no changes will be pushed to the back-end.',
+        description: 'When set, a dry-run will be performed. Only output will be printed, but no changes will be pushed to the back-end.',
         type: 'boolean',
     },
     ignoreVerificationErrors: {
         demandOption: false,
-        describe: 'Allow synchronization to proceed with validation errors.',
+        description: 'Allow synchronization to proceed with validation errors.',
         type: 'boolean',
         default: false,
     },

package/build/commands/data/schemas/verify.d.ts

@@ -3,11 +3,11 @@ export declare const command = "verify";
 export declare const desc = "Syntactically verify a local schema";
 export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "file" | "dir"> & import("yargs").InferredOptionTypes<{
     file: {
-        describe: string;
+        description: string;
         type: "string";
     };
     dir: {
-        describe: string;
+        description: string;
         type: "string";
     };
 }>>;

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

@@ -10,11 +10,11 @@ exports.desc = 'Syntactically verify a local schema';
 const builder = (yargs) => (0, util_1.epilogue)(yargs)
     .options({
     file: {
-        describe: 'schema json file which needs to be verified',
+        description: 'schema json file which needs to be verified',
         type: 'string',
     },
     dir: {
-        describe: 'directory containing schemas to be verified',
+        description: 'directory containing schemas to be verified',
         type: 'string',
     },
 })

package/build/commands/dispatchers/init.d.ts

@@ -3,14 +3,14 @@ export declare const command = "init <name>";
 export declare const desc = "Create a basic Dispatcher";
 export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{
     name: string;
-}, "path"> & import("yargs").InferredOptionTypes<{
-    path: {
+}, "file"> & import("yargs").InferredOptionTypes<{
+    file: {
         description: string;
         type: "string";
         default: string;
     };
 }>>;
-export declare const handler: ({ name, path }: {
+export declare const handler: ({ name, file }: {
     name: string;
-    path: string;
+    file: string;
 }) => Promise<void>;

package/build/commands/dispatchers/init.js

@@ -12,14 +12,14 @@ const builder = (yargs) => (0, util_1.epilogue)(yargs)
     type: 'string',
 })
     .options({
-    path: {
-        description: 'The path to the folder where the Dispatchers file should be created',
+    file: {
+        description: 'Path to the file where the new Dispatcher should be added',
         type: 'string',
-        default: './',
+        default: './dispatchers.json',
     },
 });
 exports.builder = builder;
-const handler = async function init({ name, path }) {
-    await dispatcherService.init(name, path);
+const handler = async function init({ name, file }) {
+    await dispatcherService.init(name, file);
 };
 exports.handler = handler;

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

@@ -3,13 +3,14 @@ export declare const command = "sync";
 export declare const desc = "Synchronize Dispatchers, if a declared Dispatcher does not exist, it will be created";
 export declare const builder: (yargs: Argv) => Argv<import("yargs").Omit<{}, "file" | "clean"> & import("yargs").InferredOptionTypes<{
     file: {
-        demandOption: true;
-        describe: string;
+        demandOption: false;
+        description: string;
         type: "string";
+        default: string;
     };
     clean: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "boolean";
     };
 }>>;

package/build/commands/dispatchers/sync.js

@@ -7,13 +7,14 @@ exports.command = 'sync';
 exports.desc = 'Synchronize Dispatchers, if a declared Dispatcher does not exist, it will be created';
 const builder = (yargs) => (0, util_1.epilogue)(yargs).options({
     file: {
-        demandOption: true,
-        describe: 'Path to the file containing the Dispatcher(s) configuration',
+        demandOption: false,
+        description: 'Path to the file containing the Dispatcher(s) configuration',
         type: 'string',
+        default: './dispatchers.json',
     },
     clean: {
         demandOption: false,
-        describe: 'Delete Dispatchers created using the CLI, that are no longer present in the local Dispatcher file',
+        description: 'Delete Dispatchers created using the CLI, that are no longer present in the local Dispatcher file',
         type: 'boolean',
     },
 });

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

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

package/build/commands/localizations/sync.js

@@ -8,7 +8,7 @@ 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',
+        description: 'Directory containing the localizations which need to be synced in a JSON format. By Default: ./localizations',
         type: 'string',
         default: './localizations',
     },

package/build/commands/login.d.ts

@@ -5,27 +5,27 @@ export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs
     host: {
         demandOption: true;
         type: "string";
-        describe: string;
+        description: string;
     };
     email: {
         demandOption: true;
         type: "string";
-        describe: string;
+        description: string;
     };
     password: {
         demandOption: true;
         type: "string";
-        describe: string;
+        description: string;
     };
     consumerKey: {
         demandOption: true;
         type: "string";
-        describe: string;
+        description: string;
     };
     consumerSecret: {
         demandOption: true;
         type: "string";
-        describe: string;
+        description: string;
     };
 }>>;
 export declare const handler: ({ host, email, password, consumerKey, consumerSecret }: {

package/build/commands/login.js

@@ -9,27 +9,27 @@ const builder = (yargs) => (0, util_1.epilogue)(yargs).options({
     host: {
         demandOption: true,
         type: 'string',
-        describe: 'the address of your ExH cloud instance (eg. https://api.dev.my-instance.extrahorizon.io)',
+        description: 'the address of your ExH cloud instance (eg. https://api.dev.my-instance.extrahorizon.io)',
     },
     email: {
         demandOption: true,
         type: 'string',
-        describe: 'email address of your ExH account',
+        description: 'email address of your ExH account',
     },
     password: {
         demandOption: true,
         type: 'string',
-        describe: 'password of your ExH account',
+        description: 'password of your ExH account',
     },
     consumerKey: {
         demandOption: true,
         type: 'string',
-        describe: 'Consumer key',
+        description: 'Consumer key',
     },
     consumerSecret: {
         demandOption: true,
         type: 'string',
-        describe: 'Consumer secret',
+        description: 'Consumer secret',
     },
 });
 exports.builder = builder;

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

@@ -1,5 +1,14 @@
 import { Argv } from 'yargs';
 export declare const command = "sync";
 export declare const desc = "Synchronize Service Settings";
-export declare const builder: (yargs: Argv) => Argv<import("yargs").Omit<{}, never> & import("yargs").InferredOptionTypes<{}>>;
-export declare const handler: () => Promise<void>;
+export declare const builder: (yargs: Argv) => Argv<import("yargs").Omit<{}, "file"> & import("yargs").InferredOptionTypes<{
+    file: {
+        demandOption: false;
+        description: string;
+        type: "string";
+        default: string;
+    };
+}>>;
+export declare const handler: ({ file }: {
+    file: string;
+}) => Promise<void>;

package/build/commands/settings/sync.js

@@ -1,15 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handler = exports.builder = exports.desc = exports.command = void 0;
-const path = require("node:path");
 const util_1 = require("../../helpers/util");
 const serviceSettingService = require("../../services/settings");
 exports.command = 'sync';
 exports.desc = 'Synchronize Service Settings';
-const builder = (yargs) => (0, util_1.epilogue)(yargs).options({});
+const builder = (yargs) => (0, util_1.epilogue)(yargs).options({
+    file: {
+        demandOption: false,
+        description: 'Path to the file containing the Service Settings configuration',
+        type: 'string',
+        default: './service-settings.json',
+    },
+});
 exports.builder = builder;
-const handler = async () => {
-    const filePath = path.join(process.cwd(), 'service-settings.json');
-    await serviceSettingService.sync(filePath);
+const handler = async ({ file }) => {
+    await serviceSettingService.sync(file);
 };
 exports.handler = handler;

package/build/commands/sync.d.ts

@@ -4,53 +4,53 @@ export declare const desc = "Sync your ExH configuration to the cloud environmen
 export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "path" | "settings" | "schemas" | "dispatchers" | "tasks" | "templates" | "localizations" | "cleanDispatchers" | "ignoreSchemaVerificationErrors"> & import("yargs").InferredOptionTypes<{
     path: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "string";
     };
     schemas: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "boolean";
         default: boolean;
     };
     tasks: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "boolean";
         default: boolean;
     };
     templates: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "boolean";
         default: boolean;
     };
     dispatchers: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "boolean";
         default: boolean;
     };
     cleanDispatchers: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "boolean";
     };
     localizations: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "boolean";
         default: boolean;
     };
     settings: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "boolean";
         default: boolean;
     };
     ignoreSchemaVerificationErrors: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "boolean";
         default: boolean;
     };

package/build/commands/sync.js

@@ -12,54 +12,54 @@ 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.
+        description: `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, etc...`,
         type: 'string',
     },
     schemas: {
         demandOption: false,
-        describe: 'Sync schemas only',
+        description: 'Sync schemas only',
         type: 'boolean',
         default: false,
     },
     tasks: {
         demandOption: false,
-        describe: 'Sync tasks only',
+        description: 'Sync tasks only',
         type: 'boolean',
         default: false,
     },
     templates: {
         demandOption: false,
-        describe: 'Sync templates only',
+        description: 'Sync templates only',
         type: 'boolean',
         default: false,
     },
     dispatchers: {
         demandOption: false,
-        describe: 'Sync Dispatchers only',
+        description: 'Sync Dispatchers only',
         type: 'boolean',
         default: false,
     },
     cleanDispatchers: {
         demandOption: false,
-        describe: 'Delete Dispatchers created using the CLI, that are no longer present in the local Dispatcher file',
+        description: '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',
+        description: 'Sync localizations only',
         type: 'boolean',
         default: false,
     },
     settings: {
         demandOption: false,
-        describe: 'Sync service settings only',
+        description: 'Sync service settings only',
         type: 'boolean',
         default: false,
     },
     ignoreSchemaVerificationErrors: {
         demandOption: false,
-        describe: 'Allow schema synchronization to proceed with validation errors.',
+        description: 'Allow schema synchronization to proceed with validation errors.',
         type: 'boolean',
         default: false,
     },

package/build/commands/tasks/{createrepo.d.ts → create-repo.d.ts}

@@ -1,9 +1,10 @@
 /// <reference types="yargs" />
 export declare const command = "create-repo <name>";
-export declare const desc = "Create a new task repository";
+export declare const desc = false;
+export declare const deprecated = "Use \"exh tasks init\" instead, which has more consistent behavior with other \"init\" commands.";
 export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{
     name: string;
-}, "repo" | "git"> & import("yargs").InferredOptionTypes<{
+}, "path" | "repo" | "git"> & import("yargs").InferredOptionTypes<{
     repo: {
         description: string;
         type: "string";
@@ -14,9 +15,15 @@ export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs
         type: "boolean";
         default: boolean;
     };
+    path: {
+        description: string;
+        type: "string";
+        default: string;
+    };
 }>>;
-export declare const handler: ({ name, repo, git }: {
+export declare const handler: ({ name, repo, git, path }: {
     name: any;
     repo: any;
     git: any;
+    path: any;
 }) => Promise<void>;

package/build/commands/tasks/{createrepo.js → create-repo.js}

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handler = exports.builder = exports.desc = exports.command = void 0;
+exports.handler = exports.builder = exports.deprecated = exports.desc = exports.command = void 0;
 const util_1 = require("../../helpers/util");
 const tasksService = require("../../services/tasks");
 exports.command = 'create-repo <name>';
-exports.desc = 'Create a new task repository';
+exports.desc = false;
+exports.deprecated = 'Use "exh tasks init" instead, which has more consistent behavior with other "init" commands.';
 const builder = (yargs) => (0, util_1.epilogue)(yargs)
     .positional('name', {
     demandOption: true,
@@ -22,9 +23,14 @@ const builder = (yargs) => (0, util_1.epilogue)(yargs)
         type: 'boolean',
         default: false,
     },
+    path: {
+        description: 'the path where the new repo/task should be created',
+        type: 'string',
+        default: './',
+    },
 });
 exports.builder = builder;
-const handler = async ({ name, repo, git }) => {
-    await tasksService.createRepo({ name, repo, git });
+const handler = async ({ name, repo, git, path }) => {
+    await tasksService.init({ name, repo, git, path });
 };
 exports.handler = handler;

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

@@ -0,0 +1,22 @@
+/// <reference types="yargs" />
+export declare const command = "init <name>";
+export declare const desc = "Create a new task";
+export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{
+    name: string;
+}, "path" | "repo"> & import("yargs").InferredOptionTypes<{
+    repo: {
+        description: string;
+        type: "string";
+        default: string;
+    };
+    path: {
+        description: string;
+        type: "string";
+        default: string;
+    };
+}>>;
+export declare const handler: ({ name, repo, path }: {
+    name: any;
+    repo: any;
+    path: any;
+}) => Promise<void>;

package/build/commands/tasks/init.js

@@ -0,0 +1,30 @@
+"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 tasksService = require("../../services/tasks");
+exports.command = 'init <name>';
+exports.desc = 'Create a new task';
+const builder = (yargs) => (0, util_1.epilogue)(yargs)
+    .positional('name', {
+    demandOption: true,
+    description: 'The name of the new task',
+    type: 'string',
+})
+    .options({
+    repo: {
+        description: 'Git repository template to clone',
+        type: 'string',
+        default: 'https://github.com/ExtraHorizon/template-task',
+    },
+    path: {
+        description: 'the path where the new task should be created',
+        type: 'string',
+        default: './tasks',
+    },
+});
+exports.builder = builder;
+const handler = async ({ name, repo, path }) => {
+    await tasksService.init({ name, repo, path });
+};
+exports.handler = handler;

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

@@ -4,45 +4,45 @@ export declare const desc = "Sync a task. Will create the task first if it doesn
 export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "description" | "code" | "name" | "path" | "entryPoint" | "runtime" | "env" | "timeLimit" | "memoryLimit" | "executionPermission" | "defaultPriority"> & import("yargs").InferredOptionTypes<{
     path: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "string";
     };
     name: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "string";
     };
     code: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "string";
     };
     entryPoint: {
         demandOption: false;
-        describe: string;
+        description: string;
         type: "string";
     };
     runtime: {
         demandOption: false;
-        describe: string;
+        description: string;
         choices: string[];
         type: "string";
     };
     description: {
-        describe: string;
+        description: string;
         type: "string";
         default: string;
     };
     timeLimit: {
-        describe: string;
+        description: string;
         type: "number";
     };
     memoryLimit: {
-        describe: string;
+        description: string;
         type: "number";
     };
     env: {
-        describe: string;
+        description: string;
         type: "string";
         default: any[];
     };