bump-cli 2.2.6 → 2.3.2

package/README.md

@@ -114,7 +114,7 @@ From a Bump documentation, the `diff` command will retrieve a comparaison change
 
 ```sh-session
 $ bump diff path/to/your/file.yml --doc DOC_ID_OR_SLUG --token DOC_TOKEN
-* Let's compare the given definition file with the currently deployed one... done
+* Comparing the given definition file with the currently deployed one... done
 
 Updated: POST /validations
   Body attribute modified: documentation
@@ -124,7 +124,7 @@ If you want to compare two unpublished versions of your definition file, the `di
 
 ```sh-session
 $ bump diff path/to/your/file.yml path/to/your/next-file.yml --doc <doc_slug> --token <your_doc_token>
-* Let's compare the two given definition files... done
+* Comparing the two given definition files... done
 
 Updated: POST /versions
   Body attribute added: previous_version_id

package/lib/api/index.d.ts

@@ -1,16 +1,18 @@
 import * as Config from '@oclif/config';
 import { AxiosInstance, AxiosResponse } from 'axios';
-import { PingResponse, PreviewRequest, PreviewResponse, VersionRequest, VersionResponse } from './models';
+import { PingResponse, PreviewRequest, PreviewResponse, VersionRequest, VersionResponse, DiffRequest, DiffResponse, WithDiff } from './models';
 import APIError from './error';
 declare class BumpApi {
     protected config: Config.IConfig;
     protected readonly client: AxiosInstance;
     constructor(config: Config.IConfig);
     getPing: () => Promise<AxiosResponse<PingResponse>>;
-    getVersion: (versionId: string, token: string) => Promise<AxiosResponse<VersionResponse>>;
+    getVersion: (versionId: string, token: string) => Promise<AxiosResponse<VersionResponse & WithDiff>>;
     postPreview: (body?: PreviewRequest | undefined) => Promise<AxiosResponse<PreviewResponse>>;
     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>>;
     postValidation: (body: VersionRequest, token: string) => Promise<AxiosResponse<void>>;
     private initializeResponseInterceptor;
     private handleError;

package/lib/api/index.js

@@ -29,6 +29,12 @@ class BumpApi {
                 headers: this.authorizationHeader(token),
             });
         };
+        this.postDiff = (body) => {
+            return this.client.post('/diffs', body);
+        };
+        this.getDiff = (diffId) => {
+            return this.client.get(`/diffs/${diffId}`);
+        };
         this.postValidation = (body, token) => {
             return this.client.post('/validations', body, {
                 headers: this.authorizationHeader(token),

package/lib/api/models.d.ts

@@ -33,7 +33,33 @@ export interface VersionRequest {
 export interface VersionResponse {
     id: string;
     doc_public_url?: string;
+}
+export interface WithDiff {
     diff_public_url?: string;
     diff_summary?: string;
+    diff_markdown?: string;
+    diff_details?: DiffItem[];
     diff_breaking?: boolean;
 }
+export interface DiffRequest {
+    definition: string;
+    references?: Reference[];
+    previous_definition: string;
+    previous_references?: Reference[];
+}
+export interface DiffResponse {
+    id: string;
+    public_url?: string;
+    text?: string;
+    markdown?: string;
+    details?: DiffItem[];
+    breaking?: boolean;
+}
+export interface DiffItem {
+    id: string;
+    name: string;
+    status: string;
+    type: string;
+    breaking: boolean;
+    children: DiffItem[];
+}

package/lib/cli/index.d.ts

@@ -2,9 +2,9 @@ import success from './styled/success';
 declare const cli: {
     styledSuccess: typeof success;
     config: import("cli-ux").Config;
-    warn: typeof import("@oclif/errors").warn;
-    error: typeof import("@oclif/errors").error;
-    exit: typeof import("@oclif/errors").exit;
+    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;

package/lib/command.d.ts

@@ -1,14 +1,9 @@
 import { Command as Base } from '@oclif/command';
 import { BumpApi } from './api';
-import { Reference } from './api/models';
 export default abstract class Command extends Base {
     private base;
     _bump: BumpApi;
-    get pollingPeriod(): number;
     get bump(): BumpApi;
     catch(error?: Error): Promise<void>;
     d(formatter: any, ...args: any[]): void;
-    pollingDelay(): Promise<void>;
-    private delay;
-    prepareDefinition(filepath: string): Promise<[string, Reference[]]>;
 }

package/lib/command.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const command_1 = require("@oclif/command");
 const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
-const definition_1 = require("./definition");
 const api_1 = require("./api");
 const package_json_1 = (0, tslib_1.__importDefault)(require("../package.json"));
 class Command extends command_1.Command {
@@ -11,9 +10,6 @@ class Command extends command_1.Command {
         super(...arguments);
         this.base = `${package_json_1.default.name}@${package_json_1.default.version}`;
     }
-    get pollingPeriod() {
-        return 1000;
-    }
     get bump() {
         if (!this._bump)
             this._bump = new api_1.BumpApi(this.config);
@@ -31,24 +27,5 @@ class Command extends command_1.Command {
     d(formatter, ...args) {
         return (0, debug_1.default)(`bump-cli:command:${this.constructor.name.toLowerCase()}`)(formatter, ...args);
     }
-    async pollingDelay() {
-        return await this.delay(this.pollingPeriod);
-    }
-    async delay(ms) {
-        return new Promise((resolve) => setTimeout(resolve, ms));
-    }
-    async prepareDefinition(filepath) {
-        const api = await definition_1.API.loadAPI(filepath);
-        const references = [];
-        this.d(`${filepath} looks like an ${api.specName} spec version ${api.version}`);
-        for (let i = 0; i < api.references.length; i++) {
-            const reference = api.references[i];
-            references.push({
-                location: reference.location,
-                content: reference.content,
-            });
-        }
-        return [api.rawDefinition, references];
-    }
 }
 exports.default = Command;

package/lib/commands/deploy.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const definition_1 = require("../definition");
 const command_1 = (0, tslib_1.__importDefault)(require("../command"));
 const flags = (0, tslib_1.__importStar)(require("../flags"));
 const args_1 = require("../args");
@@ -14,10 +15,12 @@ class Deploy extends command_1.default {
     */
     async run() {
         const { args, flags } = this.parse(Deploy);
-        const [definition, references] = await this.prepareDefinition(args.FILE);
+        const api = await definition_1.API.load(args.FILE);
+        const [definition, references] = api.extractDefinition();
         const action = flags['dry-run'] ? 'validate' : 'deploy';
         /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
         const [documentation, token] = [flags.doc, flags.token];
+        this.d(`${args.FILE} looks like an ${api.specName} spec version ${api.version}`);
         cli_1.cli.action.start(`* Let's ${action} a new documentation version on Bump`);
         const request = {
             documentation,

package/lib/commands/diff.d.ts

@@ -1,6 +1,6 @@
 import Command from '../command';
 import * as flags from '../flags';
-import { VersionResponse } from '../api/models';
+import { DiffResponse } from '../api/models';
 export default class Diff extends Command {
     static description: string;
     static examples: string[];
@@ -10,15 +10,12 @@ export default class Diff extends Command {
         hub: flags.IOptionFlag<string | undefined>;
         token: flags.IOptionFlag<string | undefined>;
         open: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+        format: flags.IOptionFlag<string | undefined>;
     };
     static args: {
         name: string;
         description: string;
     }[];
-    run(): Promise<VersionResponse | void>;
-    createVersion(file: string, documentation: string, token: string, hub: string | undefined, previous_version_id?: string | undefined): Promise<VersionResponse | undefined>;
-    displayCompareResult(result: VersionResponse, token: string, open: boolean): Promise<void>;
-    waitChangesResult(versionId: string, token: string, opts: {
-        timeout: number;
-    }): Promise<VersionResponse>;
+    run(): Promise<void>;
+    displayCompareResult(result: DiffResponse, format: string, open: boolean): Promise<void>;
 }

package/lib/commands/diff.js

@@ -4,6 +4,7 @@ const tslib_1 = require("tslib");
 const errors_1 = require("@oclif/errors");
 const command_1 = (0, tslib_1.__importDefault)(require("../command"));
 const flags = (0, tslib_1.__importStar)(require("../flags"));
+const diff_1 = require("../core/diff");
 const args_1 = require("../args");
 const cli_1 = require("../cli");
 class Diff extends command_1.default {
@@ -15,85 +16,47 @@ class Diff extends command_1.default {
     */
     async run() {
         const { args, flags } = this.parse(Diff);
-        /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
         const [documentation, hub, token] = [flags.doc, flags.hub, flags.token];
-        if (args.FILE2) {
-            cli_1.cli.action.start("* Let's compare the two given definition files");
+        if (flags.format == 'text') {
+            if (args.FILE2) {
+                cli_1.cli.action.start('* Comparing the two given definition files');
+            }
+            else {
+                cli_1.cli.action.start('* Comparing the given definition file with the currently deployed one');
+            }
         }
-        else {
-            cli_1.cli.action.start("* Let's compare the given definition file with the currently deployed one");
+        if (!args.FILE2 && (!documentation || !token)) {
+            throw new errors_1.CLIError('Please provide a second file argument or login with an existing token');
         }
-        const version = await this.createVersion(args.FILE, documentation, token, hub);
-        let diffVersion = undefined;
-        if (args.FILE2) {
-            diffVersion = await this.createVersion(args.FILE2, documentation, token, hub, version && version.id);
+        const diff = await new diff_1.Diff(this.config).run(args.FILE, args.FILE2, documentation, hub, token);
+        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);
         }
         else {
-            diffVersion = version;
-        }
-        if (diffVersion) {
-            diffVersion = await this.waitChangesResult(diffVersion.id, token, {
-                timeout: 30,
-            });
-            await this.displayCompareResult(diffVersion, token, flags.open);
-        }
-        cli_1.cli.action.stop();
-        return diffVersion;
-    }
-    async createVersion(file, documentation, token, hub, previous_version_id = undefined) {
-        const [definition, references] = await this.prepareDefinition(file);
-        const request = {
-            documentation,
-            hub,
-            definition,
-            references,
-            unpublished: true,
-            previous_version_id,
-        };
-        const response = await this.bump.postVersion(request, token);
-        switch (response.status) {
-            case 201:
-                this.d(`Unpublished version created with ID ${response.data.id}`);
-                return response.data;
-                break;
-            case 204:
-                this.warn('Your documentation has not changed');
-                break;
+            await cli_1.cli.log('No changes detected.');
         }
         return;
     }
-    async displayCompareResult(result, token, open) {
-        if (result && result.diff_summary) {
-            await cli_1.cli.log(result.diff_summary);
-            if (open && result.diff_public_url) {
-                await cli_1.cli.open(result.diff_public_url);
-            }
+    async displayCompareResult(result, format, open) {
+        if (format == 'text' && result.text) {
+            await cli_1.cli.log(result.text);
         }
-        else {
-            this.warn('There were no structural changes in your new definition');
+        else if (format == 'markdown' && result.markdown) {
+            await cli_1.cli.log(result.markdown);
         }
-    }
-    async waitChangesResult(versionId, token, opts) {
-        const diffResponse = await this.bump.getVersion(versionId, token);
-        if (opts.timeout <= 0) {
-            throw new errors_1.CLIError('We were unable to compute your documentation diff. Sorry about that. Please try again later');
+        else if (format == 'json' && result.details) {
+            await cli_1.cli.log(JSON.stringify(result.details, null, 2));
+        }
+        else {
+            await cli_1.cli.log('No structural changes detected.');
         }
-        switch (diffResponse.status) {
-            case 200:
-                const version = diffResponse.data;
-                this.d(`Received version:`);
-                this.d(version);
-                return version;
-                break;
-            case 202:
-                this.d('Waiting 1 sec before next pool');
-                await this.pollingDelay();
-                return await this.waitChangesResult(versionId, token, {
-                    timeout: opts.timeout - 1,
-                });
-                break;
+        if (open && result.public_url) {
+            await cli_1.cli.open(result.public_url);
         }
-        return {};
     }
 }
 exports.default = Diff;
@@ -102,14 +65,14 @@ Diff.examples = [
     `Compare a potential new version with the currently published one:
 
   $ bump diff FILE --doc <your_doc_id_or_slug> --token <your_doc_token>
-  * Let's compare the given definition file with the currently deployed one... done
+  * Comparing the given definition file with the currently deployed one... done
   Removed: GET /compare
   Added: GET /versions/{versionId}
 `,
     `Store the diff in a dedicated file:
 
   $ bump diff FILE --doc <doc_slug> --token <doc_token> > /tmp/my-saved-diff
-  * Let's compare the given definition file with the currently deployed one... done
+  * Comparing the given definition file with the currently deployed one... done
 
   $ cat /tmp/my-saved-diff
   Removed: GET /compare
@@ -118,22 +81,23 @@ Diff.examples = [
     `In case of a non modified definition FILE compared to your existing documentation, no changes are output:
 
   $ bump diff FILE --doc <doc_slug> --token <your_doc_token>
-  * Let's compare the given definition file with the currently deployed one... done
+  * Comparing the given definition file with the currently deployed one... done
    ›   Warning: Your documentation has not changed
 `,
     `Compare two different input files or URL independently to the one published on bump.sh
 
   $ bump diff FILE FILE2 --doc <doc_slug> --token <your_doc_token>
-  * Let's compare the two given definition files... done
+  * Comparing the two given definition files... done
   Updated: POST /versions
     Body attribute added: previous_version_id
 `,
 ];
 Diff.flags = {
     help: flags.help({ char: 'h' }),
-    doc: flags.doc(),
+    doc: flags.doc({ required: false }),
     hub: flags.hub(),
-    token: flags.token(),
+    token: flags.token({ required: false }),
     open: flags.open({ description: 'Open the visual diff in your browser' }),
+    format: flags.format(),
 };
 Diff.args = [args_1.fileArg, args_1.otherFileArg];

package/lib/commands/preview.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const definition_1 = require("../definition");
 const command_1 = (0, tslib_1.__importDefault)(require("../command"));
 const flags = (0, tslib_1.__importStar)(require("../flags"));
 const args_1 = require("../args");
@@ -19,7 +20,9 @@ class Preview extends command_1.default {
         return;
     }
     async preview(file, open = false, currentPreview = undefined) {
-        const [definition, references] = await this.prepareDefinition(file);
+        const api = await definition_1.API.load(file);
+        const [definition, references] = api.extractDefinition();
+        this.d(`${file} looks like an ${api.specName} spec version ${api.version}`);
         if (!currentPreview) {
             cli_1.cli.action.start("* Let's render a preview on Bump");
         }

package/lib/core/diff.d.ts

@@ -0,0 +1,22 @@
+import * as Config from '@oclif/config';
+import { BumpApi } from '../api';
+import { VersionResponse, WithDiff, DiffResponse } from '../api/models';
+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>;
+    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>;
+    waitResult(result: VersionResponse | DiffResponse, token: string | undefined, opts: {
+        timeout: number;
+    }): Promise<DiffResponse>;
+    pollingDelay(): Promise<void>;
+    private delay;
+    d(formatter: any, ...args: any[]): void;
+    isVersion(result: VersionResponse | DiffResponse): result is VersionResponse;
+    isVersionWithDiff(result: (VersionResponse & WithDiff) | DiffResponse): result is VersionResponse & WithDiff;
+    extractDiff(versionWithDiff: VersionResponse & WithDiff): DiffResponse;
+}

package/lib/core/diff.js

@@ -0,0 +1,150 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Diff = void 0;
+const tslib_1 = require("tslib");
+const errors_1 = require("@oclif/errors");
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+const definition_1 = require("../definition");
+const api_1 = require("../api");
+class Diff {
+    constructor(config) {
+        this._config = config;
+    }
+    async run(file1, file2, documentation, hub, token) {
+        let diffVersion = undefined;
+        if (file2 && (!documentation || !token)) {
+            diffVersion = await this.createDiff(file1, file2);
+        }
+        else {
+            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);
+            if (file2) {
+                diffVersion = await this.createVersion(file2, documentation, token, hub, diffVersion && diffVersion.id);
+            }
+        }
+        if (diffVersion) {
+            return await this.waitResult(diffVersion, token, {
+                timeout: 30,
+            });
+        }
+        else {
+            return undefined;
+        }
+    }
+    get bumpClient() {
+        if (!this._bump)
+            this._bump = new api_1.BumpApi(this._config);
+        return this._bump;
+    }
+    get pollingPeriod() {
+        return 1000;
+    }
+    async createDiff(file1, file2) {
+        const api = await definition_1.API.load(file1);
+        const [previous_definition, previous_references] = api.extractDefinition();
+        const api2 = await definition_1.API.load(file2);
+        const [definition, references] = api2.extractDefinition();
+        const request = {
+            previous_definition,
+            previous_references,
+            definition,
+            references,
+        };
+        const response = await this.bumpClient.postDiff(request);
+        switch (response.status) {
+            case 201:
+                this.d(`Diff created with ID ${response.data.id}`);
+                this.d(response.data);
+                return response.data;
+                break;
+            case 204:
+                break;
+        }
+        return;
+    }
+    async createVersion(file, documentation, token, hub, previous_version_id = undefined) {
+        const api = await definition_1.API.load(file);
+        const [definition, references] = api.extractDefinition();
+        const request = {
+            documentation,
+            hub,
+            definition,
+            references,
+            unpublished: true,
+            previous_version_id,
+        };
+        const response = await this.bumpClient.postVersion(request, token);
+        switch (response.status) {
+            case 201:
+                this.d(`Unpublished version created with ID ${response.data.id}`);
+                return response.data;
+                break;
+            case 204:
+                break;
+        }
+        return;
+    }
+    async waitResult(result, token, opts) {
+        let pollingResponse = undefined;
+        if (this.isVersion(result) && token) {
+            pollingResponse = await this.bumpClient.getVersion(result.id, token);
+        }
+        else {
+            pollingResponse = await this.bumpClient.getDiff(result.id);
+        }
+        if (opts.timeout <= 0) {
+            throw new errors_1.CLIError('We were unable to compute your documentation diff. Sorry about that. Please try again later');
+        }
+        switch (pollingResponse.status) {
+            case 200:
+                let diff = pollingResponse.data;
+                if (this.isVersionWithDiff(diff)) {
+                    diff = this.extractDiff(diff);
+                }
+                this.d('Received diff:');
+                this.d(diff);
+                return diff;
+                break;
+            case 202:
+                this.d('Waiting 1 sec before next poll');
+                await this.pollingDelay();
+                return await this.waitResult(result, token, {
+                    timeout: opts.timeout - 1,
+                });
+                break;
+        }
+        return {};
+    }
+    async pollingDelay() {
+        return await this.delay(this.pollingPeriod);
+    }
+    async delay(ms) {
+        return new Promise((resolve) => setTimeout(resolve, ms));
+    }
+    // Function signature type taken from @types/debug
+    // Debugger(formatter: any, ...args: any[]): void;
+    /* eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any */
+    d(formatter, ...args) {
+        return (0, debug_1.default)(`bump-cli:core:diff`)(formatter, ...args);
+    }
+    isVersion(result) {
+        return result.doc_public_url !== undefined;
+    }
+    isVersionWithDiff(result) {
+        return result.diff_summary !== undefined;
+    }
+    extractDiff(versionWithDiff) {
+        // TODO: return a real diff_id in the GET /version API
+        return {
+            id: versionWithDiff.id,
+            public_url: versionWithDiff.diff_public_url,
+            text: versionWithDiff.diff_summary,
+            markdown: versionWithDiff.diff_markdown,
+            details: versionWithDiff.diff_details,
+            breaking: versionWithDiff.diff_breaking,
+        };
+    }
+}
+exports.Diff = Diff;

package/lib/definition.d.ts

@@ -17,7 +17,8 @@ declare class API {
     resolveContent($refs: $RefParser.$Refs): [string, APIDefinition];
     static isOpenAPI(definition: JSONSchema4Object | JSONSchema6Object): definition is OpenAPI;
     static isAsyncAPI(definition: JSONSchema4Object | JSONSchema6Object): definition is AsyncAPI;
-    static loadAPI(path: string): Promise<API>;
+    extractDefinition(): [string, APIReference[]];
+    static load(path: string): Promise<API>;
 }
 declare type APIReference = {
     location: string;

package/lib/definition.js

@@ -129,7 +129,18 @@ class API {
     static isAsyncAPI(definition) {
         return 'asyncapi' in definition;
     }
-    static async loadAPI(path) {
+    extractDefinition() {
+        const references = [];
+        for (let i = 0; i < this.references.length; i++) {
+            const reference = this.references[i];
+            references.push({
+                location: reference.location,
+                content: reference.content,
+            });
+        }
+        return [this.rawDefinition, references];
+    }
+    static async load(path) {
         const JSONParser = options_1.defaults.parse.json;
         const YAMLParser = options_1.defaults.parse.yaml;
         const TextParser = options_1.defaults.parse.text;

package/lib/flags.d.ts

@@ -9,4 +9,5 @@ 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>;
-export { doc, docName, hub, token, autoCreate, dryRun, open, live };
+declare const format: flags.Definition<string>;
+export { doc, docName, hub, token, autoCreate, dryRun, open, live, format };

package/lib/flags.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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
@@ -62,3 +62,10 @@ const live = (options = {}) => {
     return command_1.flags.boolean(Object.assign({ char: 'l', default: false }, options));
 };
 exports.live = live;
+const format = command_1.flags.build({
+    char: 'f',
+    description: 'Format in which to provide the diff result',
+    default: 'text',
+    options: ['text', 'markdown', 'json'],
+});
+exports.format = format;

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 import { run } from '@oclif/command';
-import Diff from './commands/diff';
+import { Diff } from './core/diff';
 import Deploy from './commands/deploy';
 import Preview from './commands/preview';
-import { VersionResponse } from './api/models';
-export { run, Deploy, Diff, Preview, VersionResponse };
+export { VersionResponse, PreviewResponse, DiffResponse, WithDiff } from './api/models';
+export { run, Deploy, Diff, Preview };

package/lib/index.js

@@ -4,8 +4,8 @@ exports.Preview = exports.Diff = exports.Deploy = exports.run = void 0;
 const tslib_1 = require("tslib");
 const command_1 = require("@oclif/command");
 Object.defineProperty(exports, "run", { enumerable: true, get: function () { return command_1.run; } });
-const diff_1 = (0, tslib_1.__importDefault)(require("./commands/diff"));
-exports.Diff = diff_1.default;
+const diff_1 = require("./core/diff");
+Object.defineProperty(exports, "Diff", { enumerable: true, get: function () { return diff_1.Diff; } });
 const deploy_1 = (0, tslib_1.__importDefault)(require("./commands/deploy"));
 exports.Deploy = deploy_1.default;
 const preview_1 = (0, tslib_1.__importDefault)(require("./commands/preview"));

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.2.6","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.0 to 2.2) 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  * Let's compare 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  * Let's compare 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  * Let's compare 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  * Let's compare 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":true},"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},"open":{"name":"open","type":"boolean","char":"o","description":"Open the visual diff 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.0 to 2.2) 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.0 to 2.2) specifications are currently supported.","required":true}]}}}
+{"version":"2.3.2","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.0 to 2.2) 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.0 to 2.2) 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.0 to 2.2) 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.2.6",
+  "version": "2.3.2",
   "author": "Paul Bonaud <paulr@bump.sh>",
   "bin": {
     "bump": "./bin/run"
@@ -9,10 +9,10 @@
   "bugs": "https://github.com/bump-sh/cli/issues",
   "devDependencies": {
     "@oclif/dev-cli": "^1.26.0",
-    "@oclif/test": "^1.2.8",
+    "@oclif/test": "^2.0.3",
     "@types/debug": "^4.1.5",
     "@types/mocha": "^9.0.0",
-    "@types/node": "^15.9.0",
+    "@types/node": "^17.0.4",
     "@typescript-eslint/eslint-plugin": "^4.21.0",
     "@typescript-eslint/parser": "^4.21.0",
     "chai": "^4.3.4",
@@ -26,7 +26,7 @@
     "np": "^7.5.0",
     "nyc": "^15.1.0",
     "prettier": "^2.2.1",
-    "sinon": "^11.1.1",
+    "sinon": "^12.0.1",
     "stdout-stderr": "^0.1.13",
     "ts-node": "^10.0.0",
     "typescript": "^4.3.3"
@@ -80,10 +80,10 @@
     "@asyncapi/specs": "^2.9.0",
     "@oclif/command": "^1.8.0",
     "@oclif/config": "^1.17.0",
-    "@oclif/plugin-help": "^3.2.2",
+    "@oclif/plugin-help": "^5.1.10",
     "async-mutex": "^0.3.2",
-    "axios": "^0.21.1",
-    "cli-ux": "^5.5.1",
+    "axios": "^0.25.0",
+    "cli-ux": "^6.0.7",
     "debug": "^4.3.1",
     "oas-schemas": "git+https://git@github.com/OAI/OpenAPI-Specification.git#0f9d3ec7c033fef184ec54e1ffc201b2d61ce023",
     "tslib": "^2.3.0"