bump-cli 2.3.3 → 2.4.0

package/README.md

@@ -110,6 +110,32 @@ Please check `bump deploy --help` for more usage details
 
 _If you want to receive automatic `bump diff` results on your Github Pull Requests you might be interested by [our Github Action](https://github.com/marketplace/actions/api-documentation-on-bump#api-diff-on-pull-requests) diff command._
 
+#### Public API diffs
+
+From any two definition files or URLs, you can retrieve a comprehensive changelog of what has changed between them.
+
+```sh-session
+$ bump diff path/to/your/file.yml path/to/your/second_file.yml
+* Comparing the two given definition files... done
+Modified: GET /consommations
+  Response modified: 200
+    [Breaking] Body attribute modified: energie
+```
+
+Or from two URLs:
+
+```sh-session
+$ bump diff https://demo.bump.sh/doc/trips-books/changes/bfec0a43-b870-44da-9e07-60c8955e15d5.json https://demo.bump.sh/doc/trips-books.json
+* Comparing the two given definition files... done
+Modified: POST /books
+  Response modified: 200
+    [Breaking] Body attribute removed: cent
+```
+
+_Note: You can also test this feature in our dedicated web application at <https://api-diff.io/>._
+
+#### Authenticated diffs attached to your Bump documentation
+
 From a Bump documentation, the `diff` command will retrieve a comparaison changelog between your existing documentation and the given file or URL:
 
 ```sh-session
@@ -136,7 +162,7 @@ Please check `bump diff --help` for full usage details.
 
 ## Development
 
-Make sure to have Node.js (At least v12) installed on your machine.
+Make sure to have Node.js (At least v14) installed on your machine.
 
 - Install node dependencies with
   

package/lib/api/error.js

@@ -26,7 +26,7 @@ class APIError extends errors_1.CLIError {
             super(info.join('\n'));
         }
         else {
-            super(`Unhandled API error (status: ${status})`);
+            super(`Unhandled API error (status: ${status}) (error: ${httpError})`);
         }
         this.exitCode = exit;
         this.http = httpError;

package/lib/api/index.d.ts

@@ -12,7 +12,7 @@ declare class BumpApi {
     putPreview: (versionId: string, body?: PreviewRequest | undefined) => Promise<AxiosResponse<PreviewResponse>>;
     postVersion: (body: VersionRequest, token: string) => Promise<AxiosResponse<VersionResponse>>;
     postDiff: (body: DiffRequest) => Promise<AxiosResponse<DiffResponse>>;
-    getDiff: (diffId: string) => Promise<AxiosResponse<DiffResponse>>;
+    getDiff: (diffId: string, format: string) => Promise<AxiosResponse<DiffResponse>>;
     postValidation: (body: VersionRequest, token: string) => Promise<AxiosResponse<void>>;
     private initializeResponseInterceptor;
     private handleError;

package/lib/api/index.js

@@ -32,8 +32,10 @@ class BumpApi {
         this.postDiff = (body) => {
             return this.client.post('/diffs', body);
         };
-        this.getDiff = (diffId) => {
-            return this.client.get(`/diffs/${diffId}`);
+        this.getDiff = (diffId, format) => {
+            return this.client.get(`/diffs/${diffId}`, {
+                params: { formats: [format] },
+            });
         };
         this.postValidation = (body, token) => {
             return this.client.post('/validations', body, {

package/lib/api/models.d.ts

@@ -29,6 +29,7 @@ export interface VersionRequest {
     references?: Reference[];
     unpublished?: boolean;
     previous_version_id?: string;
+    branch_name?: string;
 }
 export interface VersionResponse {
     id: string;
@@ -50,10 +51,11 @@ export interface DiffRequest {
 export interface DiffResponse {
     id: string;
     public_url?: string;
+    breaking?: boolean;
     text?: string;
     markdown?: string;
     details?: DiffItem[];
-    breaking?: boolean;
+    html?: string;
 }
 export interface DiffItem {
     id: string;

package/lib/cli/index.d.ts

@@ -1,23 +1,24 @@
+import { CliUx } from '@oclif/core';
 import success from './styled/success';
 declare const cli: {
     styledSuccess: typeof success;
-    config: import("cli-ux").Config;
+    config: CliUx.Config;
     warn: typeof import("@oclif/core/lib/errors").warn;
     error: typeof import("@oclif/core/lib/errors").error;
     exit: typeof import("@oclif/core/lib/errors").exit;
-    prompt: typeof import("cli-ux/lib/prompt").prompt;
-    anykey: typeof import("cli-ux/lib/prompt").anykey;
-    confirm: typeof import("cli-ux/lib/prompt").confirm;
-    action: import("cli-ux").ActionBase;
-    prideAction: import("cli-ux").ActionBase;
+    prompt: typeof import("@oclif/core/lib/cli-ux/prompt").prompt;
+    anykey: typeof import("@oclif/core/lib/cli-ux/prompt").anykey;
+    confirm: typeof import("@oclif/core/lib/cli-ux/prompt").confirm;
+    action: CliUx.ActionBase;
+    prideAction: CliUx.ActionBase;
     styledObject(obj: any, keys?: string[] | undefined): void;
-    styledHeader: typeof import("cli-ux/lib/styled/header").default;
-    styledJSON: typeof import("cli-ux/lib/styled/json").default;
-    table: typeof import("cli-ux/lib/styled/table").table;
-    tree: typeof import("cli-ux/lib/styled/tree").default;
-    open: typeof import("cli-ux/lib/open").default;
+    styledHeader: typeof import("@oclif/core/lib/cli-ux/styled/header").default;
+    styledJSON: typeof import("@oclif/core/lib/cli-ux/styled/json").default;
+    table: typeof CliUx.Table.table;
+    tree: typeof import("@oclif/core/lib/cli-ux/styled/tree").default;
+    open: typeof import("@oclif/core/lib/cli-ux/open").default;
     wait: (ms?: number | undefined) => Promise<unknown>;
-    progress: typeof import("cli-ux/lib/styled/progress").default;
+    progress: typeof import("@oclif/core/lib/cli-ux/styled/progress").default;
     done(): Promise<void>;
     trace(format: string, ...args: string[]): void;
     debug(format: string, ...args: string[]): void;

package/lib/cli/index.js

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cli = void 0;
 const tslib_1 = require("tslib");
-const cli_ux_1 = (0, tslib_1.__importDefault)(require("cli-ux"));
+const core_1 = require("@oclif/core");
 const success_1 = (0, tslib_1.__importDefault)(require("./styled/success"));
 if (process.env.BUMP_LOG_LEVEL) {
     const logLevel = process.env.BUMP_LOG_LEVEL;
-    cli_ux_1.default.config['outputLevel'] = logLevel;
+    core_1.CliUx.config['outputLevel'] = logLevel;
 }
-const cli = Object.assign(Object.assign({}, cli_ux_1.default), { get styledSuccess() {
+const cli = Object.assign(Object.assign({}, core_1.CliUx.ux), { get styledSuccess() {
         return success_1.default;
     } });
 exports.cli = cli;

package/lib/commands/deploy.d.ts

@@ -8,6 +8,7 @@ export default class Deploy extends Command {
         doc: flags.IOptionFlag<string | undefined>;
         'doc-name': flags.IOptionFlag<string | undefined>;
         hub: flags.IOptionFlag<string | undefined>;
+        branch: flags.IOptionFlag<string | undefined>;
         token: flags.IOptionFlag<string | undefined>;
         'auto-create': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         'dry-run': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;

package/lib/commands/deploy.js

@@ -29,6 +29,7 @@ class Deploy extends command_1.default {
             auto_create_documentation: flags['auto-create'] && !flags['dry-run'],
             definition,
             references,
+            branch_name: flags.branch,
         };
         const response = flags['dry-run']
             ? await this.bump.postValidation(request, token)
@@ -78,6 +79,7 @@ Deploy.flags = {
     doc: flags.doc(),
     'doc-name': flags.docName(),
     hub: flags.hub(),
+    branch: flags.branch(),
     token: flags.token(),
     'auto-create': flags.autoCreate(),
     'dry-run': flags.dryRun(),

package/lib/commands/diff.d.ts

@@ -8,6 +8,7 @@ export default class Diff extends Command {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         doc: flags.IOptionFlag<string | undefined>;
         hub: flags.IOptionFlag<string | undefined>;
+        branch: flags.IOptionFlag<string | undefined>;
         token: flags.IOptionFlag<string | undefined>;
         open: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         format: flags.IOptionFlag<string | undefined>;

package/lib/commands/diff.js

@@ -16,8 +16,17 @@ class Diff extends command_1.default {
     */
     async run() {
         const { args, flags } = this.parse(Diff);
-        const [documentation, hub, token] = [flags.doc, flags.hub, flags.token];
-        if (flags.format == 'text') {
+        /* Flags.format has a default value, so it's always defined. But
+         * oclif types doesn't detect it */
+        const [documentation, hub, branch, token, format] = [
+            flags.doc,
+            flags.hub,
+            flags.branch,
+            flags.token,
+            /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
+            flags.format,
+        ];
+        if (format === 'text') {
             if (args.FILE2) {
                 cli_1.cli.action.start('* Comparing the two given definition files');
             }
@@ -28,13 +37,10 @@ class Diff extends command_1.default {
         if (!args.FILE2 && (!documentation || !token)) {
             throw new errors_1.CLIError('Please provide a second file argument or login with an existing token');
         }
-        const diff = await new diff_1.Diff(this.config).run(args.FILE, args.FILE2, documentation, hub, token);
+        const diff = await new diff_1.Diff(this.config).run(args.FILE, args.FILE2, documentation, hub, branch, token, format);
         cli_1.cli.action.stop();
         if (diff) {
-            /* Flags format has a default value, so it's always defined. But
-             * oclif types can"t detect it */
-            /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
-            await this.displayCompareResult(diff, flags.format, flags.open);
+            await this.displayCompareResult(diff, format, flags.open);
         }
         else {
             await cli_1.cli.log('No changes detected.');
@@ -51,6 +57,9 @@ class Diff extends command_1.default {
         else if (format == 'json' && result.details) {
             await cli_1.cli.log(JSON.stringify(result.details, null, 2));
         }
+        else if (format == 'html' && result.html) {
+            await cli_1.cli.log(result.html);
+        }
         else {
             await cli_1.cli.log('No structural changes detected.');
         }
@@ -96,6 +105,7 @@ Diff.flags = {
     help: flags.help({ char: 'h' }),
     doc: flags.doc({ required: false }),
     hub: flags.hub(),
+    branch: flags.branch(),
     token: flags.token({ required: false }),
     open: flags.open({ description: 'Open the visual diff in your browser' }),
     format: flags.format(),

package/lib/core/diff.d.ts

@@ -5,13 +5,14 @@ export declare class Diff {
     _bump: BumpApi;
     _config: Config.IConfig;
     constructor(config: Config.IConfig);
-    run(file1: string, file2: string | undefined, documentation: string | undefined, hub: string | undefined, token: string | undefined): Promise<DiffResponse | undefined>;
+    run(file1: string, file2: string | undefined, documentation: string | undefined, hub: string | undefined, branch: string | undefined, token: string | undefined, format: string): Promise<DiffResponse | undefined>;
     get bumpClient(): BumpApi;
     get pollingPeriod(): number;
     createDiff(file1: string, file2: string): Promise<DiffResponse | undefined>;
-    createVersion(file: string, documentation: string, token: string, hub: string | undefined, previous_version_id?: string | undefined): Promise<VersionResponse | undefined>;
+    createVersion(file: string, documentation: string, token: string, hub: string | undefined, branch_name: string | undefined, previous_version_id?: string | undefined): Promise<VersionResponse | undefined>;
     waitResult(result: VersionResponse | DiffResponse, token: string | undefined, opts: {
         timeout: number;
+        format: string;
     }): Promise<DiffResponse>;
     pollingDelay(): Promise<void>;
     private delay;

package/lib/core/diff.js

@@ -10,7 +10,7 @@ class Diff {
     constructor(config) {
         this._config = config;
     }
-    async run(file1, file2, documentation, hub, token) {
+    async run(file1, file2, documentation, hub, branch, token, format) {
         let diffVersion = undefined;
         if (file2 && (!documentation || !token)) {
             diffVersion = await this.createDiff(file1, file2);
@@ -19,14 +19,15 @@ class Diff {
             if (!documentation || !token) {
                 throw new Error('Please login to bump (with documentation & token) when using a single file argument');
             }
-            diffVersion = await this.createVersion(file1, documentation, token, hub);
+            diffVersion = await this.createVersion(file1, documentation, token, hub, branch);
             if (file2) {
-                diffVersion = await this.createVersion(file2, documentation, token, hub, diffVersion && diffVersion.id);
+                diffVersion = await this.createVersion(file2, documentation, token, hub, branch, diffVersion && diffVersion.id);
             }
         }
         if (diffVersion) {
             return await this.waitResult(diffVersion, token, {
                 timeout: 30,
+                format,
             });
         }
         else {
@@ -64,7 +65,7 @@ class Diff {
         }
         return;
     }
-    async createVersion(file, documentation, token, hub, previous_version_id = undefined) {
+    async createVersion(file, documentation, token, hub, branch_name, previous_version_id = undefined) {
         const api = await definition_1.API.load(file);
         const [definition, references] = api.extractDefinition();
         const request = {
@@ -74,6 +75,7 @@ class Diff {
             references,
             unpublished: true,
             previous_version_id,
+            branch_name,
         };
         const response = await this.bumpClient.postVersion(request, token);
         switch (response.status) {
@@ -92,7 +94,7 @@ class Diff {
             pollingResponse = await this.bumpClient.getVersion(result.id, token);
         }
         else {
-            pollingResponse = await this.bumpClient.getDiff(result.id);
+            pollingResponse = await this.bumpClient.getDiff(result.id, opts.format);
         }
         if (opts.timeout <= 0) {
             throw new errors_1.CLIError('We were unable to compute your documentation diff. Sorry about that. Please try again later');
@@ -112,6 +114,7 @@ class Diff {
                 await this.pollingDelay();
                 return await this.waitResult(result, token, {
                     timeout: opts.timeout - 1,
+                    format: opts.format,
                 });
                 break;
         }

package/lib/definition.js

@@ -19,6 +19,7 @@ SupportedFormat.asyncapi = {
     '2.1': specs_1.default['2.1.0'],
     '2.2': specs_1.default['2.2.0'],
     '2.3': specs_1.default['2.3.0'],
+    '2.4': specs_1.default['2.4.0'],
 };
 class UnsupportedFormat extends errors_1.CLIError {
     constructor(message = '') {

package/lib/flags.d.ts

@@ -4,10 +4,11 @@ export * from '@oclif/command/lib/flags';
 declare const doc: flags.Definition<string>;
 declare const docName: flags.Definition<string>;
 declare const hub: flags.Definition<string>;
+declare const branch: flags.Definition<string>;
 declare const token: flags.Definition<string>;
 declare const autoCreate: (options?: {}) => Parser.flags.IBooleanFlag<boolean>;
 declare const dryRun: (options?: {}) => Parser.flags.IBooleanFlag<boolean>;
 declare const open: (options?: {}) => Parser.flags.IBooleanFlag<boolean>;
 declare const live: (options?: {}) => Parser.flags.IBooleanFlag<boolean>;
 declare const format: flags.Definition<string>;
-export { doc, docName, hub, token, autoCreate, dryRun, open, live, format };
+export { doc, docName, hub, branch, token, autoCreate, dryRun, open, live, format };

package/lib/flags.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.format = exports.live = exports.open = exports.dryRun = exports.autoCreate = exports.token = exports.hub = exports.docName = exports.doc = void 0;
+exports.format = exports.live = exports.open = exports.dryRun = exports.autoCreate = exports.token = exports.branch = exports.hub = exports.docName = exports.doc = void 0;
 const tslib_1 = require("tslib");
 const command_1 = require("@oclif/command");
 // Re-export oclif flags https://oclif.io/docs/flags
@@ -35,6 +35,16 @@ const hub = command_1.flags.build({
     },
 });
 exports.hub = hub;
+const branch = command_1.flags.build({
+    char: 'B',
+    description: 'Branch name. Can be provided via BUMP_BRANCH_NAME environment variable',
+    default: () => {
+        const envBranch = process.env.BUMP_BRANCH_NAME;
+        if (envBranch)
+            return envBranch;
+    },
+});
+exports.branch = branch;
 const token = command_1.flags.build({
     char: 't',
     required: true,
@@ -66,6 +76,6 @@ const format = command_1.flags.build({
     char: 'f',
     description: 'Format in which to provide the diff result',
     default: 'text',
-    options: ['text', 'markdown', 'json'],
+    options: ['text', 'markdown', 'json', 'html'],
 });
 exports.format = format;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.3.3","commands":{"deploy":{"id":"deploy","description":"create a new version of your documentation from the given file or URL","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["Deploy a new version of an existing documentation\n\n$ bump deploy FILE --doc <your_doc_id_or_slug> --token <your_doc_token>\n* Let's deploy a new documentation version on Bump... done\n* Your new documentation version will soon be ready\n","Deploy a new version of an existing documentation attached to a hub\n\n$ bump deploy FILE --doc <doc_slug> --hub <your_hub_id_or_slug> --token <your_doc_token>\n* Let's deploy a new documentation version on Bump... done\n* Your new documentation version will soon be ready\n","Validate a new documentation version before deploying it\n\n$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_token>\n* Let's validate a new documentation version on Bump... done\n* Definition is valid\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"doc":{"name":"doc","type":"option","char":"d","description":"Documentation public id or slug. Can be provided via BUMP_ID environment variable","required":true},"doc-name":{"name":"doc-name","type":"option","char":"n","description":"Documentation name. Used with --auto-create flag."},"hub":{"name":"hub","type":"option","char":"b","description":"Hub id or slug. Can be provided via BUMP_HUB_ID environment variable"},"token":{"name":"token","type":"option","char":"t","description":"Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable","required":true},"auto-create":{"name":"auto-create","type":"boolean","description":"Automatically create the documentation if needed (only available with a --hub flag). Documentation name can be provided with --doc-name flag. Default: false","allowNo":false},"dry-run":{"name":"dry-run","type":"boolean","description":"Validate a new documentation version. Does everything a normal deploy would do except publishing the new version. Useful in automated environments such as test platforms or continuous integration. Default: false","allowNo":false}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.","required":true}]},"diff":{"id":"diff","description":"Get a comparaison diff with your documentation from the given file or URL","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["Compare a potential new version with the currently published one:\n\n  $ bump diff FILE --doc <your_doc_id_or_slug> --token <your_doc_token>\n  * Comparing the given definition file with the currently deployed one... done\n  Removed: GET /compare\n  Added: GET /versions/{versionId}\n","Store the diff in a dedicated file:\n\n  $ bump diff FILE --doc <doc_slug> --token <doc_token> > /tmp/my-saved-diff\n  * Comparing the given definition file with the currently deployed one... done\n\n  $ cat /tmp/my-saved-diff\n  Removed: GET /compare\n  Added: GET /versions/{versionId}\n","In case of a non modified definition FILE compared to your existing documentation, no changes are output:\n\n  $ bump diff FILE --doc <doc_slug> --token <your_doc_token>\n  * Comparing the given definition file with the currently deployed one... done\n   ›   Warning: Your documentation has not changed\n","Compare two different input files or URL independently to the one published on bump.sh\n\n  $ bump diff FILE FILE2 --doc <doc_slug> --token <your_doc_token>\n  * Comparing the two given definition files... done\n  Updated: POST /versions\n    Body attribute added: previous_version_id\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"doc":{"name":"doc","type":"option","char":"d","description":"Documentation public id or slug. Can be provided via BUMP_ID environment variable","required":false},"hub":{"name":"hub","type":"option","char":"b","description":"Hub id or slug. Can be provided via BUMP_HUB_ID environment variable"},"token":{"name":"token","type":"option","char":"t","description":"Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable","required":false},"open":{"name":"open","type":"boolean","char":"o","description":"Open the visual diff in your browser","allowNo":false},"format":{"name":"format","type":"option","char":"f","description":"Format in which to provide the diff result","options":["text","markdown","json"],"default":"text"}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.","required":true},{"name":"FILE2","description":"Path or URL to a second API documentation file to compute its diff"}]},"preview":{"id":"preview","description":"create a documentation preview from the given file or URL","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["$ bump preview FILE\n* Your preview is visible at: https://bump.sh/preview/45807371-9a32-48a7-b6e4-1cb7088b5b9b\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"live":{"name":"live","type":"boolean","char":"l","description":"Generate a preview each time you save the given file","allowNo":false},"open":{"name":"open","type":"boolean","char":"o","description":"Open the generated preview URL in your browser","allowNo":false}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.","required":true}]}}}
+{"version":"2.4.0","commands":{"deploy":{"id":"deploy","description":"create a new version of your documentation from the given file or URL","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["Deploy a new version of an existing documentation\n\n$ bump deploy FILE --doc <your_doc_id_or_slug> --token <your_doc_token>\n* Let's deploy a new documentation version on Bump... done\n* Your new documentation version will soon be ready\n","Deploy a new version of an existing documentation attached to a hub\n\n$ bump deploy FILE --doc <doc_slug> --hub <your_hub_id_or_slug> --token <your_doc_token>\n* Let's deploy a new documentation version on Bump... done\n* Your new documentation version will soon be ready\n","Validate a new documentation version before deploying it\n\n$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_token>\n* Let's validate a new documentation version on Bump... done\n* Definition is valid\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"doc":{"name":"doc","type":"option","char":"d","description":"Documentation public id or slug. Can be provided via BUMP_ID environment variable","required":true},"doc-name":{"name":"doc-name","type":"option","char":"n","description":"Documentation name. Used with --auto-create flag."},"hub":{"name":"hub","type":"option","char":"b","description":"Hub id or slug. Can be provided via BUMP_HUB_ID environment variable"},"branch":{"name":"branch","type":"option","char":"B","description":"Branch name. Can be provided via BUMP_BRANCH_NAME environment variable"},"token":{"name":"token","type":"option","char":"t","description":"Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable","required":true},"auto-create":{"name":"auto-create","type":"boolean","description":"Automatically create the documentation if needed (only available with a --hub flag). Documentation name can be provided with --doc-name flag. Default: false","allowNo":false},"dry-run":{"name":"dry-run","type":"boolean","description":"Validate a new documentation version. Does everything a normal deploy would do except publishing the new version. Useful in automated environments such as test platforms or continuous integration. Default: false","allowNo":false}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.","required":true}]},"diff":{"id":"diff","description":"Get a comparaison diff with your documentation from the given file or URL","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["Compare a potential new version with the currently published one:\n\n  $ bump diff FILE --doc <your_doc_id_or_slug> --token <your_doc_token>\n  * Comparing the given definition file with the currently deployed one... done\n  Removed: GET /compare\n  Added: GET /versions/{versionId}\n","Store the diff in a dedicated file:\n\n  $ bump diff FILE --doc <doc_slug> --token <doc_token> > /tmp/my-saved-diff\n  * Comparing the given definition file with the currently deployed one... done\n\n  $ cat /tmp/my-saved-diff\n  Removed: GET /compare\n  Added: GET /versions/{versionId}\n","In case of a non modified definition FILE compared to your existing documentation, no changes are output:\n\n  $ bump diff FILE --doc <doc_slug> --token <your_doc_token>\n  * Comparing the given definition file with the currently deployed one... done\n   ›   Warning: Your documentation has not changed\n","Compare two different input files or URL independently to the one published on bump.sh\n\n  $ bump diff FILE FILE2 --doc <doc_slug> --token <your_doc_token>\n  * Comparing the two given definition files... done\n  Updated: POST /versions\n    Body attribute added: previous_version_id\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"doc":{"name":"doc","type":"option","char":"d","description":"Documentation public id or slug. Can be provided via BUMP_ID environment variable","required":false},"hub":{"name":"hub","type":"option","char":"b","description":"Hub id or slug. Can be provided via BUMP_HUB_ID environment variable"},"branch":{"name":"branch","type":"option","char":"B","description":"Branch name. Can be provided via BUMP_BRANCH_NAME environment variable"},"token":{"name":"token","type":"option","char":"t","description":"Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable","required":false},"open":{"name":"open","type":"boolean","char":"o","description":"Open the visual diff in your browser","allowNo":false},"format":{"name":"format","type":"option","char":"f","description":"Format in which to provide the diff result","options":["text","markdown","json","html"],"default":"text"}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.","required":true},{"name":"FILE2","description":"Path or URL to a second API documentation file to compute its diff"}]},"preview":{"id":"preview","description":"create a documentation preview from the given file or URL","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["$ bump preview FILE\n* Your preview is visible at: https://bump.sh/preview/45807371-9a32-48a7-b6e4-1cb7088b5b9b\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"live":{"name":"live","type":"boolean","char":"l","description":"Generate a preview each time you save the given file","allowNo":false},"open":{"name":"open","type":"boolean","char":"o","description":"Open the generated preview URL in your browser","allowNo":false}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.","required":true}]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bump-cli",
   "description": "The Bump CLI is used to interact with your API documentation hosted on Bump by using the API of developers.bump.sh",
-  "version": "2.3.3",
+  "version": "2.4.0",
   "author": "Paul Bonaud <paulr@bump.sh>",
   "bin": {
     "bump": "./bin/run"
@@ -21,18 +21,18 @@
     "eslint-config-prettier": "^8.1.0",
     "eslint-plugin-prettier": "^4.0.0",
     "globby": "^11.0.3",
-    "mocha": "^9.0.3",
+    "mocha": "^10.0.0",
     "nock": "^13.0.11",
     "np": "^7.5.0",
     "nyc": "^15.1.0",
     "prettier": "^2.2.1",
-    "sinon": "^12.0.1",
+    "sinon": "^14.0.0",
     "stdout-stderr": "^0.1.13",
     "ts-node": "^10.0.0",
     "typescript": "^4.3.3"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "files": [
     "/bin",
@@ -77,13 +77,13 @@
   "types": "lib/index.d.ts",
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.7",
-    "@asyncapi/specs": "^2.13.0",
-    "@oclif/command": "^1.8.0",
+    "@asyncapi/specs": "^3.0.0",
+    "@oclif/command": "^1.8.16",
     "@oclif/config": "^1.17.0",
+    "@oclif/core": "^1.3.3",
     "@oclif/plugin-help": "^5.1.10",
     "async-mutex": "^0.3.2",
-    "axios": "^0.25.0",
-    "cli-ux": "^6.0.7",
+    "axios": "^0.27.2",
     "debug": "^4.3.1",
     "oas-schemas": "git+https://git@github.com/OAI/OpenAPI-Specification.git#0f9d3ec7c033fef184ec54e1ffc201b2d61ce023",
     "tslib": "^2.3.0"