bump-cli 2.9.0-0 → 2.9.2

package/README.md

@@ -54,7 +54,7 @@ Or, with Yarn via
 yarn global add bump-cli
 ```
 
-### Add Bump.sh to your node project
+### Add Bump.sh to your Node project
 
 As our CLI is a node package, you can easily embed it into your project by adding the package to your `package.json` file, either with NPM
 
@@ -74,7 +74,7 @@ You can then use any Bump.sh commands with `npx` (same as `npm exec`)
 npx bump --help
 ```
 
-### How should I do if I'm not using npm ?
+### Can I install Bump.sh CLI without using NodeJS?
 
 Unfortunately, at the moment we only support the Node environment. However, you can download a standalone package directly from the [latest Github release](https://github.com/bump-sh/cli/releases) assets which you can run as a standalone binary. Or you can push your documentation using [our API](https://developers.bump.sh/) (advanced usage only).
 
@@ -87,7 +87,7 @@ $ bump --help
 The Bump.sh CLI is used to interact with your API documentation hosted on Bump.sh by using the API of developers.bump.sh
 
 VERSION
-  bump-cli/2.8.0 linux-x64 node-v16.19.0
+  bump-cli/2.9.1 linux-x64 node-v20.18.1
 
 USAGE
   $ bump [COMMAND]
@@ -102,7 +102,7 @@ COMMANDS
 
  You can also get some help anytime by adding `--help` to any command. Example: `bump deploy --help`.
 
-## Prepare your Bump.sh account
+### Prepare your Bump.sh account
 
 While some commands don't need any API token (`preview` or `diff`) you will need an access key if you want to interact with your Bump.sh documentation.
 
@@ -176,13 +176,16 @@ Please check `bump deploy --help` for more usage details.
 
 ### `bump diff [FILE]`
 
-_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._
+_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/bump-sh-api-documentation-changelog) which also has a diff command._
 
 Please note that by default the command will always exit with a
 successful return code. If you want to use this command in a CI
 environment and want the command to fail **in case of a breaking
 change**, you will need to add the `--fail-on-breaking` flag to your
-diff command.
+diff command. By default if the environment variable `CI=1` is present
+(in most continuous integration environment), the flag will be
+enabled. In that case you can disable the failures with
+`--no-fail-on-breaking` flag.
 
 #### Public API diffs
 
@@ -198,7 +201,7 @@ Modified: GET /consommations
 > You can create as many diffs as you like without being authenticated. This is a **free and unlimited service** provided as long as you use the service fairly.
 {: .info}
 
-_Note: You can also test this feature in our dedicated web application at <https://api-diff.io/>._
+_**Note:** You can also test this feature in our dedicated web application at <https://api-diff.io/>._
 
 #### Authenticated diffs related to your Bump.sh documentation
 
@@ -249,7 +252,7 @@ bump preview --live --open openapi-definition.json
 > You can create as many previews as you like without being authenticated. This is a **free and unlimited service**.
 {: .info}
 
-_Note: the additional `--open` flag helps to automatically open the preview URL in your browser._
+_**Note:** the additional `--open` flag helps to automatically open the preview URL in your browser._
 
 Please check `bump preview --help` for more usage details
 
@@ -267,7 +270,7 @@ To redirect the output of the command to a new file you can run the following:
 bump overlay api-document.yaml overlay-file.yaml > api-overlayed-document.yaml
 ```
 
-_Note: you can also apply the overlay during the [`bump deploy` command]((#bump-deploy-file)) with the new `--overlay` flag:_
+_Note: you can also apply overlays during the [`bump deploy` command]((#bump-deploy-file)) with the `--overlay` flag (which can be used multiples times):_
 
 ```shell
 bump deploy api-document.yaml --doc my-doc --token my-token --overlay overlay-file.yaml
@@ -330,3 +333,4 @@ This npm package starts at v2.0.0 for two main reasons:
 - Our [first version](https://github.com/bump-sh/bump-cli) of the Bump CLI was written in Ruby, starting at v2.0.0, which makes it clear we are working on our second version of the Bump CLI
 
 - The `bump-cli` package used to be [owned by Rico](https://github.com/rstacruz) which already published v1.x packages. If you are looking for the old npm package please head to [`@rstacruz/bump-cli` package](https://www.npmjs.com/package/@rstacruz/bump-cli). _A big thanks to Rico for transferring the ownership of the `bump-cli` package name!_
+w

package/dist/api/index.d.ts

@@ -2,7 +2,7 @@ import { Config } from '@oclif/core';
 import { AxiosInstance, AxiosResponse } from 'axios';
 import { DiffRequest, DiffResponse, PingResponse, PreviewRequest, PreviewResponse, VersionRequest, VersionResponse, WithDiff } from './models.js';
 declare class BumpApi {
-    protected config: Config;
+    protected config?: Config | undefined;
     protected readonly client: AxiosInstance;
     getDiff: (diffId: string, format: string) => Promise<AxiosResponse<DiffResponse>>;
     getPing: () => Promise<AxiosResponse<PingResponse>>;
@@ -15,7 +15,7 @@ declare class BumpApi {
     private authorizationHeader;
     private handleError;
     private initializeResponseInterceptor;
-    constructor(config: Config);
+    constructor(config?: Config | undefined);
 }
 export { default as APIError } from './error.js';
 export { BumpApi };

package/dist/api/index.js

@@ -31,8 +31,9 @@ class BumpApi {
     constructor(config) {
         this.config = config;
         const baseURL = `${vars.apiUrl}${vars.apiBasePath}`;
+        const userAgent = config?.userAgent || 'bump-cli';
         const headers = {
-            'User-Agent': vars.apiUserAgent(config.userAgent),
+            'User-Agent': vars.apiUserAgent(userAgent),
         };
         this.client = axios.create({
             baseURL,

package/dist/commands/deploy.d.ts

@@ -15,10 +15,10 @@ export default class Deploy extends BaseCommand<typeof Deploy> {
         'filename-pattern': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         hub: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         interactive: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        overlay: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        overlay: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
         token: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
     };
     protected deployDirectory(dir: string, dryRun: boolean, token: string, hub: string, autoCreate: boolean, interactive: boolean, filenamePattern: string, documentationName: string | undefined, branch: string | undefined): Promise<void>;
-    protected deploySingleFile(api: API, dryRun: boolean, documentation: string, token: string, hub: string | undefined, autoCreate: boolean, documentationName: string | undefined, branch: string | undefined, overlay?: string | undefined): Promise<void>;
+    protected deploySingleFile(api: API, dryRun: boolean, documentation: string, token: string, hub: string | undefined, autoCreate: boolean, documentationName: string | undefined, branch: string | undefined, overlay?: string[] | undefined): Promise<void>;
     run(): Promise<void>;
 }

package/dist/commands/deploy.js

@@ -16,13 +16,13 @@ export default class Deploy extends BaseCommand {
         `Deploy a new version of ${chalk.underline('an existing documentation')}
 
 ${chalk.dim('$ bump deploy FILE --doc <your_doc_id_or_slug> --token <your_doc_token>')}
-* Let's deploy a new documentation version on Bump... done
+* Let's deploy on Bump.sh... done
 * Your new documentation version will soon be ready
 `,
         `Deploy a new version of ${chalk.underline('an existing documentation attached to a hub')}
 
 ${chalk.dim('$ bump deploy FILE --doc <doc_slug> --hub <your_hub_id_or_slug> --token <your_doc_token>')}
-* Let's deploy a new documentation version on Bump... done
+* Let's deploy on Bump.sh... done
 * Your new documentation version will soon be ready
 `,
         `Deploy a whole directory of ${chalk.underline('API definitions files to a hub')}
@@ -44,7 +44,7 @@ Let's deploy a new version to your my-jobs-service documentation on Bump.sh... d
         `${chalk.underline('Validate a new documentation version')} before deploying it
 
 ${chalk.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_token>')}
-* Let's validate a new documentation version on Bump... done
+* Let's validate on Bump.sh... done
 * Definition is valid
 `,
     ];

package/dist/commands/diff.js

@@ -45,7 +45,7 @@ export default class Diff extends BaseCommand {
         branch: flagsBuilder.branch(),
         doc: flagsBuilder.doc(),
         expires: flagsBuilder.expires(),
-        'fail-on-breaking': flagsBuilder.failOnBreaking(),
+        'fail-on-breaking': flagsBuilder.failOnBreaking({ allowNo: true }),
         format: flagsBuilder.format(),
         hub: flagsBuilder.hub(),
         token: flagsBuilder.token({ required: false }),
@@ -98,7 +98,7 @@ export default class Diff extends BaseCommand {
             throw new CLIError('Please provide a second file argument or login with an existing token');
         }
         ux.action.status = '...diff on Bump.sh in progress';
-        const diff = await new CoreDiff(this.bump).run(args.file, args.otherFile, documentation, hub, branch, token, format, expires);
+        const diff = await new CoreDiff(this.config).run(args.file, args.otherFile, documentation, hub, branch, token, format, expires);
         ux.action.stop();
         if (diff) {
             await this.displayCompareResult(diff, format, flags['fail-on-breaking']);

package/dist/core/deploy.d.ts

@@ -6,6 +6,6 @@ export declare class Deploy {
     constructor(bumpClient: BumpApi);
     protected createVersion(request: VersionRequest, token: string): Promise<VersionResponse | undefined>;
     d(formatter: any, ...args: any[]): void;
-    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>;
+    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>;
     validateVersion(version: VersionRequest, token: string): Promise<undefined>;
 }

package/dist/core/deploy.js

@@ -29,7 +29,13 @@ export class Deploy {
     async run(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch, overlay) {
         let version;
         if (overlay) {
-            await api.applyOverlay(overlay);
+            /* eslint-disable no-await-in-loop */
+            // Alternatively we can apply all overlays in parallel
+            // https://stackoverflow.com/questions/48957022/unexpected-await-inside-a-loop-no-await-in-loop
+            for (const overlayFile of overlay) {
+                await api.applyOverlay(overlayFile);
+            }
+            /* eslint-enable no-await-in-loop */
         }
         const [definition, references] = api.extractDefinition();
         const request = {

package/dist/core/diff.d.ts

@@ -1,9 +1,12 @@
+import { Config } from '@oclif/core';
 import { BumpApi } from '../api/index.js';
 import { DiffResponse, VersionResponse, WithDiff } from '../api/models.js';
 export declare class Diff {
     static readonly TIMEOUT = 120;
     private _bump;
-    constructor(bumpClient: BumpApi);
+    private _config;
+    constructor(config?: Config);
+    get bumpClient(): BumpApi;
     get pollingPeriod(): number;
     createDiff(file1: string, file2: string, expires: string | undefined): Promise<DiffResponse | undefined>;
     createVersion(file: string, documentation: string, token: string, hub: string | undefined, branch_name: string | undefined, previous_version_id?: string | undefined): Promise<VersionResponse | undefined>;

package/dist/core/diff.js

@@ -1,12 +1,22 @@
+import { Config } from '@oclif/core';
 import { CLIError } from '@oclif/core/errors';
 import debug from 'debug';
+import { BumpApi } from '../api/index.js';
 import { API } from '../definition.js';
 export class Diff {
     // 120 seconds = 2 minutes
     static TIMEOUT = 120;
     _bump;
-    constructor(bumpClient) {
-        this._bump = bumpClient;
+    _config;
+    constructor(config) {
+        if (config) {
+            this._config = config;
+        }
+    }
+    get bumpClient() {
+        if (!this._bump)
+            this._bump = new BumpApi(this._config);
+        return this._bump;
     }
     get pollingPeriod() {
         return process.env.BUMP_POLLING_PERIOD ? Number(process.env.BUMP_POLLING_PERIOD) : 1000;
@@ -23,7 +33,7 @@ export class Diff {
             previous_references,
             references,
         };
-        const response = await this._bump.postDiff(request);
+        const response = await this.bumpClient.postDiff(request);
         switch (response.status) {
             case 201: {
                 this.d(`Diff created with ID ${response.data.id}`);
@@ -48,7 +58,7 @@ export class Diff {
             references,
             unpublished: true,
         };
-        const response = await this._bump.postVersion(request, token);
+        const response = await this.bumpClient.postVersion(request, token);
         switch (response.status) {
             case 201: {
                 this.d(`Unpublished version created with ID ${response.data.id}`);
@@ -88,6 +98,8 @@ export class Diff {
         await this.delay(this.pollingPeriod);
     }
     async run(file1, file2, documentation, hub, branch, token, format, expires) {
+        if (!this._config)
+            this._config = await Config.load('../../');
         let diffVersion;
         if (file2 && (!documentation || !token)) {
             diffVersion = await this.createDiff(file1, file2, expires);
@@ -111,8 +123,8 @@ export class Diff {
     }
     async waitResult(result, token, opts) {
         const pollingResponse = await (this.isVersion(result) && token
-            ? this._bump.getVersion(result.id, token)
-            : this._bump.getDiff(result.id, opts.format));
+            ? this.bumpClient.getVersion(result.id, token)
+            : this.bumpClient.getDiff(result.id, opts.format));
         if (opts.timeout <= 0) {
             throw new CLIError('We were unable to compute your documentation diff. Sorry about that. Please try again later. If the error persists, please contact support at https://bump.sh.');
         }

package/dist/definition.js

@@ -1,7 +1,7 @@
 import { default as $RefParser, getJsonSchemaRefParserDefaultOptions } from '@apidevtools/json-schema-ref-parser';
 import asyncapi from '@asyncapi/specs';
 import { CLIError } from '@oclif/core/errors';
-import { safeStringify } from '@stoplight/yaml';
+import { parseWithPointers, safeStringify } from '@stoplight/yaml';
 import debug from 'debug';
 import { createRequire } from 'node:module';
 import { default as nodePath } from 'node:path';
@@ -120,10 +120,11 @@ class API {
     async applyOverlay(overlayPath) {
         const overlay = await API.load(overlayPath);
         const overlayDefinition = overlay.definition;
+        const currentDefinition = this.overlayedDefinition || this.definition;
         if (!API.isOpenAPIOverlay(overlayDefinition)) {
             throw new Error(`${overlayPath} does not look like an OpenAPI overlay`);
         }
-        this.overlayedDefinition = await new Overlay().run(this.definition, overlayDefinition);
+        this.overlayedDefinition = await new Overlay().run(currentDefinition, overlayDefinition);
     }
     extractDefinition(outputPath) {
         const references = [];
@@ -218,9 +219,11 @@ class API {
     }
     serializeDefinition(outputPath) {
         if (this.overlayedDefinition) {
+            const { comments } = parseWithPointers(this.rawDefinition, { attachComments: true });
+            const dumpOptions = { comments, lineWidth: Number.POSITIVE_INFINITY };
             return this.guessFormat(outputPath) === 'json'
                 ? JSON.stringify(this.overlayedDefinition)
-                : safeStringify(this.overlayedDefinition);
+                : safeStringify(this.overlayedDefinition, dumpOptions);
         }
         return this.rawDefinition;
     }

package/dist/flags.d.ts

@@ -41,8 +41,8 @@ declare const out: Interfaces.FlagDefinition<string, Interfaces.CustomOptions, {
     multiple: false;
     requiredOrDefaulted: false;
 }>;
-declare const overlay: Interfaces.FlagDefinition<string, Interfaces.CustomOptions, {
-    multiple: false;
+declare const overlay: Interfaces.FlagDefinition<string[], Interfaces.CustomOptions, {
+    multiple: true;
     requiredOrDefaulted: false;
 }>;
 export { autoCreate, branch, doc, docName, dryRun, expires, failOnBreaking, filenamePattern, format, hub, interactive, live, open, out, overlay, token, };

package/dist/flags.js

@@ -1,7 +1,4 @@
 import { Flags } from '@oclif/core';
-// import * as Parser from '@oclif/parser';
-// Re-export oclif flags https://oclif.io/docs/flags
-// export * from '@oclif/command/lib/flags';
 // Custom flags for bump-cli
 const doc = Flags.custom({
     char: 'd',
@@ -89,7 +86,7 @@ const failOnBreaking = (opts = {}) => {
             }
             return false;
         },
-        description: 'Fail when diff contains a breaking change',
+        description: 'Fail when diff contains a breaking change. Defaults to false locally. In CI environments where the env variable CI=1 is set, it defaults to true.',
     });
 };
 const live = (opts = {}) => {
@@ -115,6 +112,7 @@ const out = Flags.custom({
 });
 const overlay = Flags.custom({
     char: 'o',
-    description: 'Path or URL of an overlay file to apply before deploying',
+    description: 'Path or URL of overlay file(s) to apply before deploying',
+    multiple: true,
 });
 export { autoCreate, branch, doc, docName, dryRun, expires, failOnBreaking, filenamePattern, format, hub, interactive, live, open, out, overlay, token, };

package/oclif.manifest.json

@@ -11,10 +11,10 @@
       },
       "description": "Create a new version of your documentation from the given file or URL.",
       "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 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 on Bump.sh... 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 on Bump.sh... 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"
+        "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 on Bump.sh... done\n* Definition is valid\n"
       ],
       "flags": {
         "auto-create": {
@@ -86,10 +86,10 @@
         },
         "overlay": {
           "char": "o",
-          "description": "Path or URL of an overlay file to apply before deploying",
+          "description": "Path or URL of overlay file(s) to apply before deploying",
           "name": "overlay",
           "hasDynamicHelp": false,
-          "multiple": false,
+          "multiple": true,
           "type": "option"
         },
         "token": {
@@ -157,9 +157,9 @@
         },
         "fail-on-breaking": {
           "char": "F",
-          "description": "Fail when diff contains a breaking change",
+          "description": "Fail when diff contains a breaking change. Defaults to false locally. In CI environments where the env variable CI=1 is set, it defaults to true.",
           "name": "fail-on-breaking",
-          "allowNo": false,
+          "allowNo": true,
           "type": "boolean"
         },
         "format": {
@@ -277,5 +277,5 @@
       "strict": true
     }
   },
-  "version": "2.9.0-0"
+  "version": "2.9.2"
 }

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.9.0-0",
+  "description": "The Bump CLI is used to interact with your API documentation hosted on Bump.sh by using the API of developers.bump.sh",
+  "version": "2.9.2",
   "author": "Paul Bonaud <paulr@bump.sh>",
   "bin": {
     "bump": "./bin/run.js"
@@ -10,20 +10,20 @@
   "devDependencies": {
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^4",
-    "@types/chai": "^4",
+    "@types/chai": "^5",
     "@types/debug": "^4.1.12",
     "@types/jsonpath": "^0.2.4",
     "@types/mocha": "^10",
-    "@types/node": "^18",
+    "@types/node": "^22",
     "@types/sinon": "^17.0.3",
     "@typescript-eslint/eslint-plugin": "^8.13.0",
-    "chai": "^4.5.0",
+    "chai": "^5.1.2",
     "eslint": "^8",
     "eslint-config-oclif": "^5",
     "eslint-config-oclif-typescript": "^3",
-    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-prettier": "^5.2.1",
-    "mocha": "^10",
+    "mocha": "^11",
     "mock-stdin": "^1.0.0",
     "nock": "^14.0.0-beta.16",
     "np": "^10.1.0",
@@ -73,10 +73,12 @@
   },
   "repository": "bump-sh/cli",
   "scripts": {
+    "prepare": "npm run build",
     "build": "shx rm -rf dist && tsc -b",
     "clean": "rm -rf dist/ oclif.manifest.json",
     "lint": "eslint . --ext .ts",
     "fmt": "eslint --fix . --ext .ts",
+    "pack": "oclif pack tarballs",
     "postpack": "shx rm -f oclif.manifest.json",
     "posttest": "npm run lint",
     "prepack": "npm run clean && npm run build && oclif manifest && oclif readme",