@extrahorizon/exh-cli 1.5.0 → 1.5.1-dev-27-7bdff2e

package/CHANGELOG.md

@@ -1,53 +1,56 @@
-# Extra Horizon CLI changelog
-
-### v1.5.0
-* Updated the supported runtimes for task functions
-* `exh data schemas verify` and `exh tasks create-repo` no longer require you to be authenticated
-* `@extra-horizon/javascript-sdk` has been updated to `8.2.0`
-* Unused dependencies have been removed
-
-### v1.4.0
-* Added a validation check for `id` properties in objects within arrays in data schemas, this will now be reported as an error if present.
-* Added validation for duplicate transition names in data schemas, this will now be reported as an error if present.
-* Changed the strictness of validation for properties of input conditions. Modifiers such as `enum`, `minLength`, `maxLength`, etc... will no longer produce an error if not present in the condition property.
-
-### v1.3.0
-* Added a command to synchronize Dispatchers `exh dispatchers sync --file=<path>` the file argument must point to a JSON file containing an array of Dispatchers to be synchronized.
-* Added Dispatchers to the general `exh sync` command, this will synchronize all Dispatchers within a file named `dispatchers.json` in the working directory or within the provided `path` argument directory.
-* Added an argument `exh sync --dispatchers` to synchronize only Dispatchers.
-* Added arguments to clean up Extra Horizon Dispatchers during synchronization `exh dispatchers sync --clean` and `exh sync --cleanDispatchers`. These arguments will remove all Dispatchers created by the CLI that are no longer present in the local Dispatchers file.
-
-### v1.2.0
-* Added a sync argument `exh sync ... --ignoreSchemaVerificationErrors` to bypass schema verification errors, this allows schemas to be synced even if errors are reported
-* Added a schema sync argument `exh data schemas sync ... --ignoreVerificationErrors` to bypass schema verification errors, this allows schemas to be synced even if errors are reported
-* Fixed an issue synchronizing statuses with an existing schema, excess properties should now be correctly removed from statuses
-* Updated the supported runtimes for tasks
-* The `--help` information now correctly displays `exh` rather than `index.js` as the command.
-
-### v1.1.0
-* Added single file sync command for schemas with `exh data schemas sync --file=<path>`
-* Added a dry run argument for schema sync `exh data schemas sync --file=<path> --dry`. This will report the properties to be added, removed and updated in the terminal, without persisting schema changes.
-* Added verification and validation for statuses that are defined, but not present in transitions.
-* Added validation to ensure that properties in a creation transition exist in the schema properties.
-* Added verification and validation of transition conditions.
-* Added terminal notifications for if a newer release of the CLI available.
-
-### v1.0.4
-* Security update
-
-### v1.0.3
-* Fix setting of execution permission
-* Set credentials as environment variables as well, but only if they're not defined yet
-
-### v1.0.2
-* Fix JSON schema for transition where `configuration` was marked as mandatory
-
-### v1.0.1
-* Fixed broken environment variables
-
-### v1.0.0
-
-* Add support for setting execution permission when syncing a task. Options are `permissionRequired`, `allUsers` or `public`.
-* Remove implicit settings from task config syncing: some settings, such as `memoryLimit` or `timeLimit`, were given default values when not specified in task config. This can give undesired results, for example overriding custom values in the backend. __This change causes the backend defaults to be used if not specified in the task-config.json. Please verify that this is the desired behaviour__
-* Add support for setting `retryPolicy` in task-config.json.
-* Example task-config.json can be found [here](examples/task-config.example.json).
+# Extra Horizon CLI changelog
+
+### v1.5.1
+* Now also publishing to the NPM registry, no longer needing to authenticate with GitHub Packages to install the CLI
+
+### v1.5.0
+* Updated the supported runtimes for task functions
+* `exh data schemas verify` and `exh tasks create-repo` no longer require you to be authenticated
+* `@extra-horizon/javascript-sdk` has been updated to `8.2.0`
+* Unused dependencies have been removed
+
+### v1.4.0
+* Added a validation check for `id` properties in objects within arrays in data schemas, this will now be reported as an error if present.
+* Added validation for duplicate transition names in data schemas, this will now be reported as an error if present.
+* Changed the strictness of validation for properties of input conditions. Modifiers such as `enum`, `minLength`, `maxLength`, etc... will no longer produce an error if not present in the condition property.
+
+### v1.3.0
+* Added a command to synchronize Dispatchers `exh dispatchers sync --file=<path>` the file argument must point to a JSON file containing an array of Dispatchers to be synchronized.
+* Added Dispatchers to the general `exh sync` command, this will synchronize all Dispatchers within a file named `dispatchers.json` in the working directory or within the provided `path` argument directory.
+* Added an argument `exh sync --dispatchers` to synchronize only Dispatchers.
+* Added arguments to clean up Extra Horizon Dispatchers during synchronization `exh dispatchers sync --clean` and `exh sync --cleanDispatchers`. These arguments will remove all Dispatchers created by the CLI that are no longer present in the local Dispatchers file.
+
+### v1.2.0
+* Added a sync argument `exh sync ... --ignoreSchemaVerificationErrors` to bypass schema verification errors, this allows schemas to be synced even if errors are reported
+* Added a schema sync argument `exh data schemas sync ... --ignoreVerificationErrors` to bypass schema verification errors, this allows schemas to be synced even if errors are reported
+* Fixed an issue synchronizing statuses with an existing schema, excess properties should now be correctly removed from statuses
+* Updated the supported runtimes for tasks
+* The `--help` information now correctly displays `exh` rather than `index.js` as the command.
+
+### v1.1.0
+* Added single file sync command for schemas with `exh data schemas sync --file=<path>`
+* Added a dry run argument for schema sync `exh data schemas sync --file=<path> --dry`. This will report the properties to be added, removed and updated in the terminal, without persisting schema changes.
+* Added verification and validation for statuses that are defined, but not present in transitions.
+* Added validation to ensure that properties in a creation transition exist in the schema properties.
+* Added verification and validation of transition conditions.
+* Added terminal notifications for if a newer release of the CLI available.
+
+### v1.0.4
+* Security update
+
+### v1.0.3
+* Fix setting of execution permission
+* Set credentials as environment variables as well, but only if they're not defined yet
+
+### v1.0.2
+* Fix JSON schema for transition where `configuration` was marked as mandatory
+
+### v1.0.1
+* Fixed broken environment variables
+
+### v1.0.0
+
+* Add support for setting execution permission when syncing a task. Options are `permissionRequired`, `allUsers` or `public`.
+* Remove implicit settings from task config syncing: some settings, such as `memoryLimit` or `timeLimit`, were given default values when not specified in task config. This can give undesired results, for example overriding custom values in the backend. __This change causes the backend defaults to be used if not specified in the task-config.json. Please verify that this is the desired behaviour__
+* Add support for setting `retryPolicy` in task-config.json.
+* Example task-config.json can be found [here](examples/task-config.example.json).

package/README.md

@@ -7,18 +7,6 @@ See [changelog](CHANGELOG.md) for the latest changes.
 
 ## Installation
 
-### Configuring .npmrc
-Assuming you've created a project (using npm init or equivalent), you need to create a file called .npmrc at the root level of your project and add the following lines:
-```
-@extrahorizon:registry=https://npm.pkg.github.com
-//npm.pkg.github.com/:_authToken=${AUTH_TOKEN}
-```
-Replace ${AUTH_TOKEN} with your personal access token. You can get a new one at https://github.com/settings/tokens/new. Make sure you enable the read:packages scope.
-Explanation from GitHub on how to add your token can be found here: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages
-
-You can also add the .npmrc to your home directory. In which case it will apply to all your projects.
-
-### Install
 *Note: The exh-cli requires at least node version 14*
 
 To install in your project:

package/build/commands/completion.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="yargs" />
-export declare const command = "completion";
-export declare const desc = "Install shell completion for bash & zsh";
-export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, never> & import("yargs").InferredOptionTypes<{}>>;
-export declare const handler: () => Promise<void>;
+/// <reference types="yargs" />
+export declare const command = "completion";
+export declare const desc = "Install shell completion for bash & zsh";
+export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, never> & import("yargs").InferredOptionTypes<{}>>;
+export declare const handler: () => Promise<void>;

package/build/commands/completion.js

@@ -1,38 +1,38 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.handler = exports.builder = exports.desc = exports.command = void 0;
-const readline = require("readline");
-const util_1 = require("../helpers/util");
-exports.command = 'completion';
-exports.desc = 'Install shell completion for bash & zsh';
-const builder = (yargs) => (0, util_1.epilogue)(yargs).options({});
-exports.builder = builder;
-const handler = async () => {
-    const isZsh = (process.env.SHELL?.includes('zsh') || process.env.ZSH_NAME?.includes('zsh')) ?? false;
-    try {
-        const result = await (0, util_1.asyncExec)(`grep yargs_completions ${isZsh ? '~/.zshrc' : '~/.bashrc'}`);
-        if (result.length > 0) {
-            console.log('Completion already present ✅');
-            return;
-        }
-    }
-    catch (err) { }
-    const rl = readline.createInterface({
-        input: process.stdin,
-        output: process.stdout,
-    });
-    rl.question('Do you want to add completion to your shell (Y/n)? ', async (yesno) => {
-        if (!yesno || yesno.toLowerCase() === 'y') {
-            console.log(await (0, util_1.asyncExec)(`exh generate_completion >> ${isZsh ? '~/.zshrc' : '~/.bashrc'}`));
-            console.log('Completion added ✅');
-        }
-        else {
-            console.log('Completion not added ❌');
-        }
-        rl.close();
-    });
-    rl.on('close', () => {
-        process.exit(0);
-    });
-};
-exports.handler = handler;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.builder = exports.desc = exports.command = void 0;
+const readline = require("readline");
+const util_1 = require("../helpers/util");
+exports.command = 'completion';
+exports.desc = 'Install shell completion for bash & zsh';
+const builder = (yargs) => (0, util_1.epilogue)(yargs).options({});
+exports.builder = builder;
+const handler = async () => {
+    const isZsh = (process.env.SHELL?.includes('zsh') || process.env.ZSH_NAME?.includes('zsh')) ?? false;
+    try {
+        const result = await (0, util_1.asyncExec)(`grep yargs_completions ${isZsh ? '~/.zshrc' : '~/.bashrc'}`);
+        if (result.length > 0) {
+            console.log('Completion already present ✅');
+            return;
+        }
+    }
+    catch (err) { }
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+    rl.question('Do you want to add completion to your shell (Y/n)? ', async (yesno) => {
+        if (!yesno || yesno.toLowerCase() === 'y') {
+            console.log(await (0, util_1.asyncExec)(`exh generate_completion >> ${isZsh ? '~/.zshrc' : '~/.bashrc'}`));
+            console.log('Completion added ✅');
+        }
+        else {
+            console.log('Completion not added ❌');
+        }
+        rl.close();
+    });
+    rl.on('close', () => {
+        process.exit(0);
+    });
+};
+exports.handler = handler;

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

@@ -1,10 +1,10 @@
-/// <reference types="yargs" />
-export declare const command = "delete";
-export declare const desc = "Delete a schema";
-export declare const builder: (yargs: any) => import("yargs").Argv<{
-    id: string;
-}>;
-export declare const handler: ({ sdk, id }: {
-    sdk: any;
-    id: any;
-}) => Promise<void>;
+/// <reference types="yargs" />
+export declare const command = "delete";
+export declare const desc = "Delete a schema";
+export declare const builder: (yargs: any) => import("yargs").Argv<{
+    id: string;
+}>;
+export declare const handler: ({ sdk, id }: {
+    sdk: any;
+    id: any;
+}) => Promise<void>;

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

@@ -1,29 +1,29 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.handler = exports.builder = exports.desc = exports.command = void 0;
-const chalk = require("chalk");
-const util_1 = require("../../../helpers/util");
-const schemaRepository = require("../../../repositories/schemas");
-exports.command = 'delete';
-exports.desc = 'Delete a schema';
-const builder = (yargs) => (0, util_1.epilogue)(yargs).option('id', {
-    demandOption: true,
-    description: 'The ID of the schema',
-    type: 'string',
-});
-exports.builder = builder;
-const handler = async ({ sdk, id }) => {
-    const disableResponse = await schemaRepository.disable(sdk, id);
-    if (disableResponse.affectedRecords !== 1) {
-        console.log(chalk.red('Failed to delete schema', id));
-        return;
-    }
-    const deleteResponse = await schemaRepository.remove(sdk, id);
-    if (deleteResponse.affectedRecords) {
-        console.log(chalk.green('Successfully deleted schema', id));
-    }
-    else {
-        console.log(chalk.red('Failed to delete schema', id));
-    }
-};
-exports.handler = handler;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.builder = exports.desc = exports.command = void 0;
+const chalk = require("chalk");
+const util_1 = require("../../../helpers/util");
+const schemaRepository = require("../../../repositories/schemas");
+exports.command = 'delete';
+exports.desc = 'Delete a schema';
+const builder = (yargs) => (0, util_1.epilogue)(yargs).option('id', {
+    demandOption: true,
+    description: 'The ID of the schema',
+    type: 'string',
+});
+exports.builder = builder;
+const handler = async ({ sdk, id }) => {
+    const disableResponse = await schemaRepository.disable(sdk, id);
+    if (disableResponse.affectedRecords !== 1) {
+        console.log(chalk.red('Failed to delete schema', id));
+        return;
+    }
+    const deleteResponse = await schemaRepository.remove(sdk, id);
+    if (deleteResponse.affectedRecords) {
+        console.log(chalk.green('Successfully deleted schema', id));
+    }
+    else {
+        console.log(chalk.red('Failed to delete schema', id));
+    }
+};
+exports.handler = handler;

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

@@ -1,8 +1,8 @@
-/// <reference types="yargs" />
-export declare const command = "list";
-export declare const desc = "List all schemas";
-export declare const builder: (yargs: any) => import("yargs").Argv<{}>;
-export declare const handler: ({ sdk, isTTY }: {
-    sdk: any;
-    isTTY: any;
-}) => Promise<void>;
+/// <reference types="yargs" />
+export declare const command = "list";
+export declare const desc = "List all schemas";
+export declare const builder: (yargs: any) => import("yargs").Argv<{}>;
+export declare const handler: ({ sdk, isTTY }: {
+    sdk: any;
+    isTTY: any;
+}) => Promise<void>;

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

@@ -1,20 +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");
-exports.command = 'list';
-exports.desc = 'List all schemas';
-const builder = (yargs) => (0, util_1.epilogue)(yargs);
-exports.builder = builder;
-const handler = async function list({ sdk, isTTY }) {
-    const schemaListResponse = await sdk.raw.get('/data/v1/');
-    if (schemaListResponse.data.data.length !== 0) {
-        if (isTTY) {
-            console.table(schemaListResponse.data.data.map((c) => ({ Id: c.id, Name: c.name, Description: c.description || '<none>' })));
-        }
-        else {
-            schemaListResponse.data.data.forEach((f) => (console.log([f.id, f.name].join(','))));
-        }
-    }
-};
-exports.handler = handler;
+"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 = 'list';
+exports.desc = 'List all schemas';
+const builder = (yargs) => (0, util_1.epilogue)(yargs);
+exports.builder = builder;
+const handler = async function list({ sdk, isTTY }) {
+    const schemaListResponse = await sdk.raw.get('/data/v1/');
+    if (schemaListResponse.data.data.length !== 0) {
+        if (isTTY) {
+            console.table(schemaListResponse.data.data.map((c) => ({ Id: c.id, Name: c.name, Description: c.description || '<none>' })));
+        }
+        else {
+            schemaListResponse.data.data.forEach((f) => (console.log([f.id, f.name].join(','))));
+        }
+    }
+};
+exports.handler = handler;

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

@@ -1,3 +1,3 @@
-import { Changes } from '../util/syncSchema';
-export declare function compareStatuses(localSchema: any, cloudSchema: any): Changes;
-export declare function calculateStatusUpdateData(localStatus: any, cloudStatus: any): Record<string, string>;
+import { Changes } from '../util/syncSchema';
+export declare function compareStatuses(localSchema: any, cloudSchema: any): Changes;
+export declare function calculateStatusUpdateData(localStatus: any, cloudStatus: any): Record<string, string>;

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

@@ -1,49 +1,49 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateStatusUpdateData = exports.compareStatuses = void 0;
-const lodash_1 = require("lodash");
-function compareStatuses(localSchema, cloudSchema) {
-    const changes = {
-        toAdd: [],
-        toUpdate: [],
-        toRemove: [],
-    };
-    const cloudStatuses = cloudSchema.statuses;
-    const localStatuses = localSchema.statuses;
-    for (const statusName of Object.keys(localStatuses)) {
-        const cloudStatus = cloudStatuses[statusName];
-        const localStatus = localStatuses[statusName];
-        const isNewStatus = localStatus && !cloudStatus;
-        if (isNewStatus) {
-            changes.toAdd.push(statusName);
-        }
-        const isUpdatedStatus = localStatus && cloudStatus && !(0, lodash_1.isEqual)(localStatus, cloudStatus);
-        if (isUpdatedStatus) {
-            changes.toUpdate.push(statusName);
-        }
-    }
-    for (const statusName of Object.keys(cloudStatuses)) {
-        const cloudStatus = cloudStatuses[statusName];
-        const localStatus = localStatuses[statusName];
-        const isExcessStatus = !localStatus && cloudStatus;
-        if (isExcessStatus) {
-            changes.toRemove.push(statusName);
-        }
-    }
-    return changes;
-}
-exports.compareStatuses = compareStatuses;
-function calculateStatusUpdateData(localStatus, cloudStatus) {
-    const result = {};
-    for (const key of Object.keys(localStatus)) {
-        result[key] = localStatus[key];
-    }
-    for (const key of Object.keys(cloudStatus)) {
-        const isExcessProperty = !localStatus[key];
-        if (isExcessProperty) {
-            result[key] = null;
-        }
-    }
-    return result;
-}
-exports.calculateStatusUpdateData = calculateStatusUpdateData;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculateStatusUpdateData = exports.compareStatuses = void 0;
+const lodash_1 = require("lodash");
+function compareStatuses(localSchema, cloudSchema) {
+    const changes = {
+        toAdd: [],
+        toUpdate: [],
+        toRemove: [],
+    };
+    const cloudStatuses = cloudSchema.statuses;
+    const localStatuses = localSchema.statuses;
+    for (const statusName of Object.keys(localStatuses)) {
+        const cloudStatus = cloudStatuses[statusName];
+        const localStatus = localStatuses[statusName];
+        const isNewStatus = localStatus && !cloudStatus;
+        if (isNewStatus) {
+            changes.toAdd.push(statusName);
+        }
+        const isUpdatedStatus = localStatus && cloudStatus && !(0, lodash_1.isEqual)(localStatus, cloudStatus);
+        if (isUpdatedStatus) {
+            changes.toUpdate.push(statusName);
+        }
+    }
+    for (const statusName of Object.keys(cloudStatuses)) {
+        const cloudStatus = cloudStatuses[statusName];
+        const localStatus = localStatuses[statusName];
+        const isExcessStatus = !localStatus && cloudStatus;
+        if (isExcessStatus) {
+            changes.toRemove.push(statusName);
+        }
+    }
+    return changes;
+}
+exports.compareStatuses = compareStatuses;
+function calculateStatusUpdateData(localStatus, cloudStatus) {
+    const result = {};
+    for (const key of Object.keys(localStatus)) {
+        result[key] = localStatus[key];
+    }
+    for (const key of Object.keys(cloudStatus)) {
+        const isExcessProperty = !localStatus[key];
+        if (isExcessProperty) {
+            result[key] = null;
+        }
+    }
+    return result;
+}
+exports.calculateStatusUpdateData = calculateStatusUpdateData;

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

@@ -1,35 +1,35 @@
-/// <reference types="yargs" />
-export declare const command = "sync";
-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" | "ignoreVerificationErrors" | "dry"> & import("yargs").InferredOptionTypes<{
-    dir: {
-        demandOption: false;
-        describe: string;
-        type: "string";
-    };
-    file: {
-        demandOption: false;
-        describe: string;
-        type: "string";
-    };
-    dry: {
-        demandOption: false;
-        describe: string;
-        type: "boolean";
-    };
-    ignoreVerificationErrors: {
-        demandOption: false;
-        describe: string;
-        type: "boolean";
-        default: boolean;
-    };
-}>>;
-export declare const handler: ({ sdk, dir, file, dry, ignoreVerificationErrors }: {
-    sdk: any;
-    dir: any;
-    file: any;
-    dry: any;
-    ignoreVerificationErrors: any;
-}) => Promise<void>;
-export declare function syncTargetFile(sdk: any, targetFile: string, dry?: boolean, ignoreVerificationErrors?: boolean): Promise<void>;
-export declare function syncTargetDir(sdk: any, targetDir: string, dry?: boolean, ignoreVerificationErrors?: boolean): Promise<void>;
+/// <reference types="yargs" />
+export declare const command = "sync";
+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" | "ignoreVerificationErrors" | "dry"> & import("yargs").InferredOptionTypes<{
+    dir: {
+        demandOption: false;
+        describe: string;
+        type: "string";
+    };
+    file: {
+        demandOption: false;
+        describe: string;
+        type: "string";
+    };
+    dry: {
+        demandOption: false;
+        describe: string;
+        type: "boolean";
+    };
+    ignoreVerificationErrors: {
+        demandOption: false;
+        describe: string;
+        type: "boolean";
+        default: boolean;
+    };
+}>>;
+export declare const handler: ({ sdk, dir, file, dry, ignoreVerificationErrors }: {
+    sdk: any;
+    dir: any;
+    file: any;
+    dry: any;
+    ignoreVerificationErrors: any;
+}) => Promise<void>;
+export declare function syncTargetFile(sdk: any, targetFile: string, dry?: boolean, ignoreVerificationErrors?: boolean): Promise<void>;
+export declare function syncTargetDir(sdk: any, targetDir: string, dry?: boolean, ignoreVerificationErrors?: boolean): Promise<void>;