bump-cli 2.7.3-beta.1 → 2.8.0

package/README.md

@@ -283,6 +283,10 @@ We currently support [OpenAPI](https://github.com/OAI/OpenAPI-Specification) fro
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/bump-sh/cli>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+## Thanks
+
+- [Lorna Mitchel](https://github.com/lornajane/) for [openapi-overlay-js](https://github.com/lornajane/openapi-overlays-js)
+
 ## License
 
 The Bump CLI project is released under the [MIT License](http://opensource.org/licenses/MIT).

package/lib/args.d.ts

@@ -9,6 +9,7 @@ declare const otherFileArg: {
 };
 declare const overlayFileArg: {
     name: string;
+    required: boolean;
     description: string;
 };
 export { fileArg, otherFileArg, overlayFileArg };

package/lib/args.js

@@ -14,6 +14,7 @@ const otherFileArg = {
 exports.otherFileArg = otherFileArg;
 const overlayFileArg = {
     name: 'OVERLAY_FILE',
+    required: true,
     description: 'Path or URL to an overlay file',
 };
 exports.overlayFileArg = overlayFileArg;

package/lib/commands/deploy.d.ts

@@ -14,6 +14,7 @@ export default class Deploy extends Command {
         interactive: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         'filename-pattern': flagsBuilder.IOptionFlag<string | undefined>;
         'dry-run': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+        overlay: flagsBuilder.IOptionFlag<string | undefined>;
     };
     static args: {
         name: string;

package/lib/commands/deploy.js

@@ -22,7 +22,7 @@ class Deploy extends command_1.default {
     */
     async run() {
         const { args, flags } = this.parse(Deploy);
-        const [dryRun, documentation, token, hub, autoCreate, interactive, filenamePattern, documentationName, branch,] = [
+        const [dryRun, documentation, token, hub, autoCreate, interactive, filenamePattern, documentationName, branch, overlay,] = [
             flags['dry-run'],
             flags.doc,
             /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
@@ -36,6 +36,7 @@ class Deploy extends command_1.default {
             flags['filename-pattern'],
             flags['doc-name'],
             flags.branch,
+            flags.overlay,
         ];
         if ((0, file_1.isDir)(args.FILE)) {
             if (hub) {
@@ -49,7 +50,7 @@ class Deploy extends command_1.default {
             if (documentation) {
                 const api = await definition_1.API.load(args.FILE);
                 this.d(`${args.FILE} looks like an ${api.specName} spec version ${api.version}`);
-                await this.deploySingleFile(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch);
+                await this.deploySingleFile(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch, overlay);
             }
             else {
                 throw new errors_1.RequiredFlagError({ flag: Deploy.flags.doc, parse: {} });
@@ -90,10 +91,10 @@ class Deploy extends command_1.default {
         }
         return;
     }
-    async deploySingleFile(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch) {
+    async deploySingleFile(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch, overlay) {
         const action = dryRun ? 'validate' : 'deploy';
         cli_1.cli.action.start(`Let's ${action} a new version to your ${documentation} documentation on Bump.sh`);
-        const response = await new deploy_1.Deploy(this.config).run(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch);
+        const response = await new deploy_1.Deploy(this.config).run(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch, overlay);
         if (dryRun) {
             await cli_1.cli.styledSuccess('Definition is valid');
         }
@@ -158,5 +159,6 @@ Deploy.flags = {
     interactive: flagsBuilder.interactive(),
     'filename-pattern': flagsBuilder.filenamePattern(),
     'dry-run': flagsBuilder.dryRun(),
+    overlay: flagsBuilder.overlay(),
 };
 Deploy.args = [args_1.fileArg];

package/lib/commands/overlay.d.ts

@@ -1,14 +1,16 @@
 import Command from '../command';
+import * as flagsBuilder from '../flags';
 export default class Overlay extends Command {
     static description: string;
     static examples: string[];
     static flags: {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+        out: flagsBuilder.IOptionFlag<string | undefined>;
     };
     static args: {
         name: string;
+        required: boolean;
         description: string;
     }[];
     run(): Promise<void>;
-    applyOverlay(file: string, overlayFile: string): Promise<string>;
 }

package/lib/commands/overlay.js

@@ -1,48 +1,56 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const errors_1 = require("@oclif/errors");
-const yaml_1 = require("@stoplight/yaml");
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const promises_1 = require("node:fs/promises");
+const node_fs_1 = require("node:fs");
+const path_1 = require("path");
 const definition_1 = require("../definition");
+const prompts_1 = require("../core/utils/prompts");
 const command_1 = (0, tslib_1.__importDefault)(require("../command"));
 const flagsBuilder = (0, tslib_1.__importStar)(require("../flags"));
 const args_1 = require("../args");
 const cli_1 = require("../cli");
-const overlay_1 = require("../core/overlay");
 class Overlay extends command_1.default {
     async run() {
-        const { args } = this.parse(Overlay);
-        const newDefinition = await this.applyOverlay(args.FILE, args.OVERLAY_FILE);
-        cli_1.cli.log(newDefinition);
-        return;
-    }
-    async applyOverlay(file, overlayFile) {
-        const api = await definition_1.API.load(file);
-        const definition = api.definition;
-        this.d(`${file} looks like an ${api.specName} spec version ${api.version}`);
-        const overlay = await definition_1.API.load(overlayFile);
-        const overlayDefinition = overlay.definition;
-        if (!definition_1.API.isOpenAPIOverlay(overlayDefinition)) {
-            throw new errors_1.CLIError(`${overlayFile} does not look like an OpenAPI overlay`);
-        }
+        const { args, flags } = this.parse(Overlay);
+        const outputPath = flags.out;
         cli_1.cli.action.start("* Let's apply the overlay to the main definition");
-        const newDefinition = (0, overlay_1.applyOverlay)(definition, overlayDefinition);
+        const api = await definition_1.API.load(args.FILE);
+        await api.applyOverlay(args.OVERLAY_FILE);
+        const [overlayedDefinition] = api.extractDefinition(outputPath);
         cli_1.cli.action.stop();
-        if (file.endsWith('.json')) {
-            return JSON.stringify(newDefinition);
+        if (outputPath) {
+            await (0, promises_1.mkdir)((0, path_1.dirname)(outputPath), { recursive: true });
+            let confirm = true;
+            if ((0, node_fs_1.existsSync)(outputPath)) {
+                await (0, prompts_1.confirm)(`Do you want to override the existing destination file? (${outputPath})`).catch(() => {
+                    confirm = false;
+                });
+            }
+            if (confirm) {
+                await (0, promises_1.writeFile)(outputPath, overlayedDefinition);
+            }
         }
         else {
-            return (0, yaml_1.safeStringify)(newDefinition);
+            cli_1.cli.log(overlayedDefinition);
         }
+        return;
     }
 }
 exports.default = Overlay;
 Overlay.description = 'Apply an OpenAPI specified overlay to your API definition.';
 Overlay.examples = [
-    `$ bump overlay DEFINITION_FILE OVERLAY_FILE
+    `Apply the OVERLAY_FILE to the existing DEFINITION_FILE. The resulting
+definition is output on stdout meaning you can redirect it to a new
+file.
+
+${chalk_1.default.dim('$ bump overlay DEFINITION_FILE OVERLAY_FILE > destination/file.json')}
+* Let's apply the overlay to the main definition... done
 `,
 ];
 Overlay.flags = {
     help: flagsBuilder.help({ char: 'h' }),
+    out: flagsBuilder.out(),
 };
 Overlay.args = [args_1.fileArg, args_1.overlayFileArg];

package/lib/core/deploy.d.ts

@@ -6,7 +6,7 @@ export declare class Deploy {
     _bump: BumpApi;
     _config: Config.IConfig;
     constructor(config: Config.IConfig);
-    run(api: API, dryRun: boolean, documentation: string, token: string, hub: string | undefined, autoCreate: boolean, documentationName: string | undefined, branch: string | undefined): Promise<VersionResponse | undefined>;
+    run(api: API, dryRun: boolean, documentation: string, token: string, hub: string | undefined, autoCreate: boolean, documentationName: string | undefined, branch: string | undefined, overlay?: string | undefined): Promise<VersionResponse | undefined>;
     get bumpClient(): BumpApi;
     createVersion(request: VersionRequest, token: string): Promise<VersionResponse | undefined>;
     validateVersion(version: VersionRequest, token: string): Promise<undefined>;

package/lib/core/deploy.js

@@ -8,8 +8,11 @@ class Deploy {
     constructor(config) {
         this._config = config;
     }
-    async run(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch) {
+    async run(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch, overlay) {
         let version = undefined;
+        if (overlay) {
+            await api.applyOverlay(overlay);
+        }
         const [definition, references] = api.extractDefinition();
         const request = {
             documentation,

package/lib/core/overlay.d.ts

@@ -1,2 +1,5 @@
 import { APIDefinition, OpenAPIOverlay } from '../definition';
-export declare function applyOverlay(spec: APIDefinition, overlay: OpenAPIOverlay): APIDefinition;
+export declare class Overlay {
+    run(spec: APIDefinition, overlay: OpenAPIOverlay): APIDefinition;
+    d(formatter: any, ...args: any[]): void;
+}

package/lib/core/overlay.js

@@ -1,69 +1,78 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyOverlay = void 0;
+exports.Overlay = void 0;
 const tslib_1 = require("tslib");
-// WIP @github.com/lornajane/openapi-overlays-js
-//
-// I couldn't get the upstream lib to be imported properly due to some
-// issues with ESM module imports so this is file was copied from
-// github.com/lornajane/openapi-overlays-js and has been adapted to
-// make our Typescript build happy.
-//
-// If you make any changes here, please also make them upstream.
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
 const jsonpath_1 = (0, tslib_1.__importDefault)(require("jsonpath"));
 const mergician_1 = (0, tslib_1.__importDefault)(require("mergician"));
-function applyOverlay(spec, overlay) {
-    // Use jsonpath.apply to do the changes
-    if (overlay.actions && overlay.actions.length >= 1)
-        overlay.actions.forEach((a) => {
-            const action = a;
-            if (!action.target) {
-                process.stderr.write('Action with a missing target\n');
-                return;
-            }
-            const target = action.target;
-            // Is it a remove?
-            if (action.hasOwnProperty('remove')) {
-                while (true) {
-                    const path = jsonpath_1.default.paths(spec, target, 1);
-                    if (path.length == 0) {
-                        break;
-                    }
-                    const parent = jsonpath_1.default.parent(spec, target);
-                    const thingToRemove = path[0][path[0].length - 1];
-                    if (Array.isArray(parent)) {
-                        parent.splice(thingToRemove, 1);
-                    }
-                    else {
-                        delete parent[thingToRemove];
-                    }
+class Overlay {
+    // WIP @github.com/lornajane/openapi-overlays-js
+    //
+    // I couldn't get the upstream lib to be imported properly due to
+    // some issues with ESM module imports so this is method was copied
+    // from github.com/lornajane/openapi-overlays-js and has been
+    // adapted to make our Typescript build happy.
+    //
+    // If you make any changes here, PLEASE ALSO MAKE THEM UPSTREAM.
+    run(spec, overlay) {
+        // Use jsonpath.apply to do the changes
+        if (overlay.actions && overlay.actions.length >= 1)
+            overlay.actions.forEach((a) => {
+                const action = a;
+                if (!action.target) {
+                    process.stderr.write('Action with a missing target\n');
+                    return;
                 }
-            }
-            else {
-                try {
-                    // It must be an update
-                    jsonpath_1.default.apply(spec, target, (chunk) => {
-                        if (typeof chunk === 'object' && typeof action.update === 'object') {
-                            if (Array.isArray(chunk) && Array.isArray(action.update)) {
-                                return chunk.concat(action.update);
-                            }
-                            else {
-                                // Deep merge objects using a module (built-in spread operator is only shallow)
-                                const merger = (0, mergician_1.default)({ appendArrays: true });
-                                return merger(chunk, action.update);
-                            }
+                const target = action.target;
+                // Is it a remove?
+                if (action.hasOwnProperty('remove')) {
+                    while (true) {
+                        const path = jsonpath_1.default.paths(spec, target, 1);
+                        if (path.length == 0) {
+                            break;
+                        }
+                        const parent = jsonpath_1.default.parent(spec, target);
+                        const thingToRemove = path[0][path[0].length - 1];
+                        if (Array.isArray(parent)) {
+                            parent.splice(thingToRemove, 1);
                         }
                         else {
-                            return action.update;
+                            delete parent[thingToRemove];
                         }
-                    });
+                    }
                 }
-                catch (ex) {
-                    process.stderr.write(`Error applying overlay: ${ex.message}\n`);
-                    //return chunk
+                else {
+                    try {
+                        // It must be an update
+                        jsonpath_1.default.apply(spec, target, (chunk) => {
+                            if (typeof chunk === 'object' && typeof action.update === 'object') {
+                                if (Array.isArray(chunk) && Array.isArray(action.update)) {
+                                    return chunk.concat(action.update);
+                                }
+                                else {
+                                    // Deep merge objects using a module (built-in spread operator is only shallow)
+                                    const merger = (0, mergician_1.default)({ appendArrays: true });
+                                    return merger(chunk, action.update);
+                                }
+                            }
+                            else {
+                                return action.update;
+                            }
+                        });
+                    }
+                    catch (ex) {
+                        process.stderr.write(`Error applying overlay: ${ex.message}\n`);
+                        //return chunk
+                    }
                 }
-            }
-        });
-    return spec;
+            });
+        return spec;
+    }
+    // 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:overlay`)(formatter, ...args);
+    }
 }
-exports.applyOverlay = applyOverlay;
+exports.Overlay = Overlay;

package/lib/definition.d.ts

@@ -9,6 +9,7 @@ declare class API {
     readonly location: string;
     readonly rawDefinition: string;
     readonly definition: APIDefinition;
+    overlayedDefinition: APIDefinition | undefined;
     readonly references: APIReference[];
     readonly version: string;
     readonly specName: string;
@@ -17,13 +18,16 @@ declare class API {
     getSpec(definition: APIDefinition): SpecSchema;
     getSpecName(definition: APIDefinition): string;
     getVersion(definition: APIDefinition): string;
+    guessFormat(output?: string): string;
     versionWithoutPatch(): string;
     resolveRelativeLocation(absPath: string): string;
     resolveContent($refs: $RefParser.$Refs): [string, APIDefinition];
+    serializeDefinition(outputPath?: string): string;
     static isOpenAPI(definition: JSONSchema4Object | JSONSchema6Object): definition is OpenAPI;
     static isAsyncAPI(definition: JSONSchema4Object | JSONSchema6Object): definition is AsyncAPI;
     static isOpenAPIOverlay(definition: JSONSchema4Object | JSONSchema6Object): definition is OpenAPIOverlay;
-    extractDefinition(): [string, APIReference[]];
+    extractDefinition(outputPath?: string): [string, APIReference[]];
+    applyOverlay(overlayPath: string): Promise<void>;
     static load(path: string): Promise<API>;
 }
 declare type APIReference = {
@@ -31,18 +35,23 @@ declare type APIReference = {
     content: string;
 };
 declare type APIDefinition = OpenAPI | AsyncAPI | OpenAPIOverlay;
+declare type InfoObject = {
+    readonly title: string;
+    readonly version: string;
+    readonly description?: string;
+};
 declare type OpenAPI = JSONSchema4Object & {
     readonly openapi?: string;
     readonly swagger?: string;
-    readonly info: string;
+    readonly info: InfoObject;
 };
 declare type OpenAPIOverlay = JSONSchema4Object & {
     readonly overlay: string;
-    readonly info: string;
+    readonly info: InfoObject;
     readonly actions: JSONSchema4Array;
 };
 declare type AsyncAPI = JSONSchema4Object & {
     readonly asyncapi: string;
-    readonly info: string;
+    readonly info: InfoObject;
 };
 export { API, APIDefinition, OpenAPIOverlay, SupportedFormat };

package/lib/definition.js

@@ -7,6 +7,8 @@ const json_schema_ref_parser_1 = (0, tslib_1.__importDefault)(require("@apidevto
 const options_1 = require("@apidevtools/json-schema-ref-parser/lib/options");
 const specs_1 = (0, tslib_1.__importDefault)(require("@asyncapi/specs"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const yaml_1 = require("@stoplight/yaml");
+const overlay_1 = require("./core/overlay");
 class SupportedFormat {
 }
 exports.SupportedFormat = SupportedFormat;
@@ -76,6 +78,9 @@ class API {
             return (definition.openapi || definition.swagger);
         }
     }
+    guessFormat(output) {
+        return (output || this.location).endsWith('.json') ? 'json' : 'yaml';
+    }
     versionWithoutPatch() {
         const [major, minor] = this.version.split('.', 3);
         return `${major}.${minor}`;
@@ -135,6 +140,21 @@ class API {
         }
         return [raw, parsed];
     }
+    serializeDefinition(outputPath) {
+        if (this.overlayedDefinition) {
+            let serializedDefinition;
+            if (this.guessFormat(outputPath) == 'json') {
+                serializedDefinition = JSON.stringify(this.overlayedDefinition);
+            }
+            else {
+                serializedDefinition = (0, yaml_1.safeStringify)(this.overlayedDefinition);
+            }
+            return serializedDefinition;
+        }
+        else {
+            return this.rawDefinition;
+        }
+    }
     static isOpenAPI(definition) {
         return (typeof definition.openapi === 'string' || typeof definition.swagger === 'string');
     }
@@ -144,7 +164,7 @@ class API {
     static isOpenAPIOverlay(definition) {
         return 'overlay' in definition;
     }
-    extractDefinition() {
+    extractDefinition(outputPath) {
         const references = [];
         for (let i = 0; i < this.references.length; i++) {
             const reference = this.references[i];
@@ -153,7 +173,15 @@ class API {
                 content: reference.content,
             });
         }
-        return [this.rawDefinition, references];
+        return [this.serializeDefinition(outputPath), references];
+    }
+    async applyOverlay(overlayPath) {
+        const overlay = await API.load(overlayPath);
+        const overlayDefinition = overlay.definition;
+        if (!API.isOpenAPIOverlay(overlayDefinition)) {
+            throw new Error(`${overlayPath} does not look like an OpenAPI overlay`);
+        }
+        this.overlayedDefinition = await new overlay_1.Overlay().run(this.definition, overlayDefinition);
     }
     static async load(path) {
         const JSONParser = options_1.defaults.parse.json;

package/lib/flags.d.ts

@@ -15,4 +15,6 @@ declare const failOnBreaking: (options?: {}) => Parser.flags.IBooleanFlag<boolea
 declare const live: (options?: {}) => Parser.flags.IBooleanFlag<boolean>;
 declare const format: flags.Definition<string>;
 declare const expires: flags.Definition<string>;
-export { doc, docName, hub, branch, token, autoCreate, interactive, filenamePattern, dryRun, open, failOnBreaking, live, format, expires, };
+declare const out: flags.Definition<string>;
+declare const overlay: flags.Definition<string>;
+export { doc, docName, hub, branch, token, autoCreate, interactive, filenamePattern, dryRun, open, failOnBreaking, live, format, expires, out, overlay, };

package/lib/flags.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.expires = exports.format = exports.live = exports.failOnBreaking = exports.open = exports.dryRun = exports.filenamePattern = exports.interactive = exports.autoCreate = exports.token = exports.branch = exports.hub = exports.docName = exports.doc = void 0;
+exports.overlay = exports.out = exports.expires = exports.format = exports.live = exports.failOnBreaking = exports.open = exports.dryRun = exports.filenamePattern = exports.interactive = 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
@@ -104,3 +104,13 @@ const expires = command_1.flags.build({
     description: "Specify a longer expiration date for public diffs (defaults to 1 day). Use iso8601 format to provide a date, or you can use `--expires 'never'` to keep the result live indefinitely.",
 });
 exports.expires = expires;
+const out = command_1.flags.build({
+    char: 'o',
+    description: 'Output file path',
+});
+exports.out = out;
+const overlay = command_1.flags.build({
+    char: 'o',
+    description: 'Path or URL of an overlay file to apply before deploying',
+});
+exports.overlay = overlay;

package/lib/index.d.ts

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

package/lib/index.js

@@ -6,9 +6,9 @@ const command_1 = require("@oclif/command");
 Object.defineProperty(exports, "run", { enumerable: true, get: function () { return command_1.run; } });
 const diff_1 = require("./core/diff");
 Object.defineProperty(exports, "Diff", { enumerable: true, get: function () { return diff_1.Diff; } });
+const overlay_1 = require("./core/overlay");
+Object.defineProperty(exports, "Overlay", { enumerable: true, get: function () { return overlay_1.Overlay; } });
 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"));
 exports.Preview = preview_1.default;
-const overlay_1 = (0, tslib_1.__importDefault)(require("./commands/overlay"));
-exports.Overlay = overlay_1.default;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.7.3-beta.1","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","Deploy a whole directory of API definitions files to a hub\n\n$ bump deploy DIR --filename-pattern *-{slug}-api --hub <hub_slug> --token <hub_token>\nWe've found 2 valid API definitions to deploy\n└─ DIR\n   └─ source-my-service-api.yml (OpenAPI spec version 3.1.0)\n   └─ source-my-jobs-service-api.yml (AsyncAPI spec version 2.6.0)\n\nLet's deploy those documentations to your <hub_slug> hub on Bump.sh\n\n* Your new documentation version will soon be ready\nLet's deploy a new version to your my-service documentation on Bump.sh... done\n\n* Your new documentation version will soon be ready\nLet's deploy a new version to your my-jobs-service documentation on Bump.sh... done\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"},"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},"interactive":{"name":"interactive","type":"boolean","description":"Interactively create a configuration file to deploy a Hub (only available with a --hub flag). This will start an interactive process if you don't have a CLI configuration file. Default: false","allowNo":false},"filename-pattern":{"name":"filename-pattern","type":"option","description":"Pattern to extract the documentation slug from filenames when deploying a DIRECTORY. Pattern uses only '*' and '{slug}' as special characters to extract the slug from a filename without extension. Used with --hub flag only.","default":"{slug}-api"},"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.\nPath can also be a directory when deploying to a Hub.","required":true}]},"diff":{"id":"diff","description":"Get a comparison 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"},"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},"fail-on-breaking":{"name":"fail-on-breaking","type":"boolean","char":"F","description":"Fail when diff contains a breaking change","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"},"expires":{"name":"expires","type":"option","char":"e","description":"Specify a longer expiration date for public diffs (defaults to 1 day). Use iso8601 format to provide a date, or you can use `--expires 'never'` to keep the result live indefinitely."}},"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.\nPath can also be a directory when deploying to a Hub.","required":true},{"name":"FILE2","description":"Path or URL to a second API documentation file to compute its diff"}]},"overlay":{"id":"overlay","description":"Apply an OpenAPI specified overlay to your API definition.","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["$ bump overlay DEFINITION_FILE OVERLAY_FILE\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","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.\nPath can also be a directory when deploying to a Hub.","required":true},{"name":"OVERLAY_FILE","description":"Path or URL to an overlay file"}]},"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.\nPath can also be a directory when deploying to a Hub.","required":true}]}}}
+{"version":"2.8.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","Deploy a whole directory of API definitions files to a hub\n\n$ bump deploy DIR --filename-pattern *-{slug}-api --hub <hub_slug> --token <hub_token>\nWe've found 2 valid API definitions to deploy\n└─ DIR\n   └─ source-my-service-api.yml (OpenAPI spec version 3.1.0)\n   └─ source-my-jobs-service-api.yml (AsyncAPI spec version 2.6.0)\n\nLet's deploy those documentations to your <hub_slug> hub on Bump.sh\n\n* Your new documentation version will soon be ready\nLet's deploy a new version to your my-service documentation on Bump.sh... done\n\n* Your new documentation version will soon be ready\nLet's deploy a new version to your my-jobs-service documentation on Bump.sh... done\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"},"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},"interactive":{"name":"interactive","type":"boolean","description":"Interactively create a configuration file to deploy a Hub (only available with a --hub flag). This will start an interactive process if you don't have a CLI configuration file. Default: false","allowNo":false},"filename-pattern":{"name":"filename-pattern","type":"option","description":"Pattern to extract the documentation slug from filenames when deploying a DIRECTORY. Pattern uses only '*' and '{slug}' as special characters to extract the slug from a filename without extension. Used with --hub flag only.","default":"{slug}-api"},"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},"overlay":{"name":"overlay","type":"option","char":"o","description":"Path or URL of an overlay file to apply before deploying"}},"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.\nPath can also be a directory when deploying to a Hub.","required":true}]},"diff":{"id":"diff","description":"Get a comparison 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"},"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},"fail-on-breaking":{"name":"fail-on-breaking","type":"boolean","char":"F","description":"Fail when diff contains a breaking change","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"},"expires":{"name":"expires","type":"option","char":"e","description":"Specify a longer expiration date for public diffs (defaults to 1 day). Use iso8601 format to provide a date, or you can use `--expires 'never'` to keep the result live indefinitely."}},"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.\nPath can also be a directory when deploying to a Hub.","required":true},{"name":"FILE2","description":"Path or URL to a second API documentation file to compute its diff"}]},"overlay":{"id":"overlay","description":"Apply an OpenAPI specified overlay to your API definition.","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["Apply the OVERLAY_FILE to the existing DEFINITION_FILE. The resulting\ndefinition is output on stdout meaning you can redirect it to a new\nfile.\n\n$ bump overlay DEFINITION_FILE OVERLAY_FILE > destination/file.json\n* Let's apply the overlay to the main definition... done\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"out":{"name":"out","type":"option","char":"o","description":"Output file path"}},"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.\nPath can also be a directory when deploying to a Hub.","required":true},{"name":"OVERLAY_FILE","description":"Path or URL to an overlay file","required":true}]},"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.\nPath can also be a directory when deploying to a Hub.","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.7.3-beta.1",
+  "version": "2.8.0",
   "author": "Paul Bonaud <paulr@bump.sh>",
   "bin": {
     "bump": "./bin/run"