Change Log

Introduced exh data schemas init to create a new schema file with a basic structure
Added autocomplete support and inline documentation for task-config.json
- Via "$schema": "https://swagger.extrahorizon.com/cli/1.10.0/config-json-schemas/TaskConfig.json"
- Automatically added when using exh tasks create-repo
You no longer need to be logged in to run exh completion
Updated the archiver package to resolve some deprecations
Removed the dependency on joi and uuid

Introduced the executionCredentials field in the task configuration:
- Specify the permissions your task needs
- The CLI automatically creates a user, role, and credentials for your task
- These credentials are injected as environment variables into the task automatically
- If you want to migrate your existing tasks to use this feature, see the migration guide.

Schemas:
- createMode, readMode, updateMode and deleteMode have been updated to accept multiple granular options, matching the revamped access mode changes in Data Service 1.4.0
- Transition Action type: "task" now supports the priority field
- Transition afterActions now supports the type: "task" Action
- exh data schemas sync now doesn't try to sync description fields for Conditions and Actions in the creationTransition

exh data schemas sync now allows your schema .json files to contain a $schema property
- This allows you to specify a json-schema for the schema files themselves, providing hints and validation in your editor
- Add "$schema": "https://swagger.extrahorizon.com/cli/1.7.0/config-json-schemas/Schema.json" to the top of your schemas to use the same json-schema as the CLI does internally
exh data schemas sync now allows all components in a schema to have a description property
- These descriptions are not synced, but allow you to provide inline documentation for the components in your schema
Revamped the schema validation to use the more complete json-schema definition
- This affects exh data schemas verify as well as exh data schemas sync and more accurately reports errors in your schemas
- This also means that some errors that were previously not reported might now be reported
- We believe this is a good thing moving forward and we're happy to help you resolve any issues you might encounter
- The --ignoreSchemaVerificationErrors flag can always be used to sync while you might be working on a schema with errors
Fixed some output inconsistencies in the sync commands

exh data schemas sync no longer logs the full schema definition json
Fixed exh data schemas sync not being able to traverse an object definition with only additionalProperties set

Fixed some security vulnerabilities in the dependencies (Thanks @tran-simon)
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
Added the exh localizations sync command, allowing you to sync localizations from a folder containing your translations (Thanks @Lroemon for the initial implementation)
Added localization syncing support to the exh sync command
The exh sync command now also supports absolute paths for the --path argument

Now also publishing to the NPM registry, no longer needing to authenticate with GitHub Packages to install the CLI

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

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.

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.

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.

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.

Fix setting of execution permission
Set credentials as environment variables as well, but only if they're not defined yet

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.

Last updated 1 month ago