bump-cli 2.9.3 → 2.9.5

package/README.md

@@ -88,7 +88,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.9.2 linux-x64 node-v20.18.1
+  bump-cli/2.9.3 linux-x64 node-v20.18.1
 
 USAGE
   $ bump [COMMAND]
@@ -325,12 +325,37 @@ Make sure to have Node.js (At least v20) installed on your machine.
   ```
 
 - Run the test suites
-  
+
   ```shell
   npm run test
   npm run test-coverage # Run tests with coverage
   ```
 
+### Use package in local environment
+
+You can run the package by executing the file `bin/run.js` locally:
+
+  ```shell
+  bin/run.js
+  ```
+
+For example to generate a preview:
+
+  ```shell
+  ./bin/run.js preview path/to/file.json
+  > Your preview is visible at: https://bump.sh/preview/42
+  ```
+
+Please note that even if CLI is running locally, by default requests are sent to [Bump.sh API](https://developers.bump.sh/).
+
+If you have a local version of the Bump.sh API, you can run CLI 100% in local environment
+by setting the environment variable `BUMP_HOST`:
+
+  ```shell
+  BUMP_HOST="http://localhost:3000" ./bin/run.js preview path/to/file.json
+  > Your preview is visible at: http://localhost:3000/preview/42
+  ```
+
 ## License
 
 The Bump CLI project is released under the [MIT License](http://opensource.org/licenses/MIT).

package/dist/api/models.d.ts

@@ -29,6 +29,7 @@ export interface VersionRequest {
     hub?: string;
     previous_version_id?: string;
     references?: Reference[];
+    temporary?: boolean;
     unpublished?: boolean;
 }
 export interface VersionResponse {

package/dist/commands/deploy.d.ts

@@ -16,9 +16,10 @@ export default class Deploy extends BaseCommand<typeof Deploy> {
         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>;
+        preview: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         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, temporary?: boolean | undefined): Promise<void>;
     run(): Promise<void>;
 }

package/dist/commands/deploy.js

@@ -58,6 +58,7 @@ ${chalk.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_tok
         hub: flagsBuilder.hub(),
         interactive: flagsBuilder.interactive(),
         overlay: flagsBuilder.overlay(),
+        preview: flagsBuilder.preview(),
         token: flagsBuilder.token(),
     };
     async deployDirectory(dir, dryRun, token, hub, autoCreate, interactive, filenamePattern, documentationName, branch) {
@@ -98,15 +99,15 @@ ${chalk.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_tok
             throw new CLIError(`No documentation found in ${dir} with the pattern '${filenamePattern}'.\nYou should check with the ${chalk.dim('--filename-pattern')} flag to select your files from your naming convention.\nIf you don't have a naming convention we can help naming your API definition files:\nTry the ${chalk.dim('--interactive')} flag for that.`);
         }
     }
-    async deploySingleFile(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch, overlay) {
+    async deploySingleFile(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch, overlay, temporary) {
         ux.action.status = `...a new version to your ${documentation} documentation`;
-        const response = await new CoreDeploy(this.bump).run(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch, overlay);
+        const response = await new CoreDeploy(this.bump).run(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch, overlay, temporary);
         if (dryRun) {
             ux.stdout(ux.colorize('green', 'Definition is valid'));
         }
         else if (response) {
             process.stdout.write(ux.colorize('green', `Your ${documentation} documentation...`));
-            ux.stdout(ux.colorize('green', `has received a new deployment which will soon be ready at:`));
+            ux.stdout(ux.colorize('green', `has received a new ${temporary ? 'preview' : 'deployment'} which will soon be ready at:`));
             ux.stdout(ux.colorize('underline', response.doc_public_url));
         }
         else {
@@ -121,7 +122,7 @@ ${chalk.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_tok
     */
     async run() {
         const { args, flags } = await this.parse(Deploy);
-        const [dryRun, documentation, token, hub, autoCreate, interactive, filenamePattern, documentationName, branch, overlay,] = [
+        const [dryRun, documentation, token, hub, autoCreate, interactive, filenamePattern, documentationName, branch, overlay, temporary,] = [
             flags['dry-run'],
             flags.doc,
             flags.token,
@@ -134,8 +135,10 @@ ${chalk.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_tok
             flags['doc-name'],
             flags.branch,
             flags.overlay,
+            /* when --preview is provided, generate temporary version */
+            flags.preview,
         ];
-        const action = dryRun ? 'validate' : 'deploy';
+        const action = dryRun ? 'validate' : temporary ? 'preview' : 'deploy';
         ux.action.start(`Let's ${action} on Bump.sh`);
         if (isDir(args.file)) {
             if (hub) {
@@ -148,7 +151,7 @@ ${chalk.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_tok
         else if (documentation) {
             const api = await 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, overlay);
+            await this.deploySingleFile(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch, overlay, temporary);
         }
         else {
             throw new CLIError('Missing required flag --doc=<slug>');

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, temporary?: boolean | false): Promise<VersionResponse | undefined>;
     validateVersion(version: VersionRequest, token: string): Promise<undefined>;
 }

package/dist/core/deploy.js

@@ -26,7 +26,7 @@ export class Deploy {
     d(formatter, ...args) {
         return debug(`bump-cli:core:deploy`)(formatter, ...args);
     }
-    async run(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch, overlay) {
+    async run(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch, overlay, temporary) {
         let version;
         if (overlay) {
             /* eslint-disable no-await-in-loop */
@@ -46,6 +46,7 @@ export class Deploy {
             documentation_name: documentationName,
             hub,
             references,
+            temporary,
         };
         if (dryRun) {
             await this.validateVersion(request, token);

package/dist/core/diff.js

@@ -1,6 +1,7 @@
 import { Config } from '@oclif/core';
 import { CLIError } from '@oclif/core/errors';
 import debug from 'debug';
+import { resolve } from 'node:path';
 import { BumpApi } from '../api/index.js';
 import { API } from '../definition.js';
 export class Diff {
@@ -99,7 +100,7 @@ export class Diff {
     }
     async run(file1, file2, documentation, hub, branch, token, format, expires) {
         if (!this._config)
-            this._config = await Config.load('../../');
+            this._config = await Config.load(resolve(import.meta.dirname, './../../'));
         let diffVersion;
         if (file2 && (!documentation || !token)) {
             diffVersion = await this.createDiff(file1, file2, expires);

package/dist/core/overlay.js

@@ -36,10 +36,27 @@ export class Overlay {
                     process.stderr.write(`WARNING: Action target '${target}' has no matching elements\n`);
                     continue;
                 }
+                // When we execute a 'remove' action we need to be careful if
+                // the targets are elements of an array. Because the list of
+                // paths contains an index of each element.
+                //
+                // E.g.
+                // ["servers"][0]
+                // ["servers"][1]
+                // ["servers"][2]
+                //
+                // And if we remove elements starting from the 0, the array
+                // will be reindexed and thus the '2' index won't be valid
+                // anymore.
+                //
+                // Thus, in that case we revers the list of paths
+                if (action.remove) {
+                    paths.reverse();
+                }
                 for (const path of paths) {
                     // The 'executeAction' will mutate the passed spec object in
                     // place.
-                    this.executeAction(spec, action, path);
+                    spec = this.executeAction(spec, action, path);
                 }
             }
         }
@@ -71,14 +88,17 @@ export class Overlay {
         // Do the overlay action
         // Is it a remove?
         if (Object.hasOwn(action, 'remove')) {
+            this.d(`Executing 'remove' on target path: ${path}`);
             this.remove(parent, thingToActUpon);
         }
         else if (Object.hasOwn(action, 'update')) {
-            this.update(spec, parent, action.update, thingToActUpon);
+            this.d(`Executing 'update' on target path: ${path}`);
+            spec = this.update(spec, parent, action.update, thingToActUpon);
         }
         else {
             process.stderr.write(`WARNING: ${this.humanName(action)} needs either a 'remove' or an 'update' property\n`);
         }
+        return spec;
     }
     humanName(action) {
         return action.description ? `Action '${action.description}'` : 'Action';
@@ -101,7 +121,7 @@ export class Overlay {
                 // the given update with the whole spec.
                 spec = merger(spec, update);
             }
-            else if (property_or_index) {
+            else if (property_or_index !== undefined) {
                 const targetObject = parent[property_or_index];
                 if (typeof targetObject === 'object' && typeof update === 'object') {
                     parent[property_or_index] =
@@ -117,5 +137,6 @@ export class Overlay {
         catch (error) {
             process.stderr.write(`Error applying overlay: ${error.message}\n`);
         }
+        return spec;
     }
 }

package/dist/core/utils/file.d.ts

@@ -3,7 +3,7 @@ type FileDescription = {
     label: string;
     value: string;
 };
-export declare const isDir: (path: string) => boolean;
+export declare const isDir: (path_or_url: string) => boolean;
 export declare class File {
     protected static readonly supportedFormats: string[];
     static listInvalidConventionFiles(path: string, regex: RegExp): FileDescription[];

package/dist/core/utils/file.js

@@ -1,8 +1,24 @@
+import { CLIError } from '@oclif/core/errors';
 import { readdirSync, statSync } from 'node:fs';
 import { basename, extname } from 'node:path';
-export const isDir = (path) => {
+export const isDir = (path_or_url) => {
+    if (isHttpUrl(path_or_url)) {
+        return false;
+    }
+    try {
+        return statSync(path_or_url).isDirectory();
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            throw new CLIError(error);
+        }
+        return false;
+    }
+};
+const isHttpUrl = (path) => {
     try {
-        return statSync(path).isDirectory();
+        const url = new URL(path);
+        return ['http:', 'https:'].includes(url.protocol);
     }
     catch {
         return false;

package/dist/flags.d.ts

@@ -29,6 +29,7 @@ declare const dryRun: (opts?: Partial<Interfaces.BooleanFlag<boolean>>) => Inter
 declare const open: (opts?: Partial<Interfaces.BooleanFlag<boolean>>) => Interfaces.BooleanFlag<boolean>;
 declare const failOnBreaking: (opts?: Partial<Interfaces.BooleanFlag<boolean>>) => Interfaces.BooleanFlag<boolean>;
 declare const live: (opts?: Partial<Interfaces.BooleanFlag<boolean>>) => Interfaces.BooleanFlag<boolean>;
+declare const preview: (opts?: Partial<Interfaces.BooleanFlag<boolean>>) => Interfaces.BooleanFlag<boolean>;
 declare const format: Interfaces.FlagDefinition<string, Interfaces.CustomOptions, {
     multiple: false;
     requiredOrDefaulted: true;
@@ -45,4 +46,4 @@ declare const overlay: Interfaces.FlagDefinition<string[], Interfaces.CustomOpti
     multiple: true;
     requiredOrDefaulted: false;
 }>;
-export { autoCreate, branch, doc, docName, dryRun, expires, failOnBreaking, filenamePattern, format, hub, interactive, live, open, out, overlay, token, };
+export { autoCreate, branch, doc, docName, dryRun, expires, failOnBreaking, filenamePattern, format, hub, interactive, live, open, out, overlay, preview, token, };

package/dist/flags.js

@@ -96,6 +96,14 @@ const live = (opts = {}) => {
         default: false,
     });
 };
+const preview = (opts = {}) => {
+    return Flags.boolean({
+        ...opts,
+        char: 'p',
+        default: false,
+        description: 'Generate a preview in your API context. The resulting version is temporary and not visible by your documentation viewers.',
+    });
+};
 const format = Flags.custom({
     char: 'f',
     default: 'text',
@@ -115,4 +123,4 @@ const overlay = Flags.custom({
     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, };
+export { autoCreate, branch, doc, docName, dryRun, expires, failOnBreaking, filenamePattern, format, hub, interactive, live, open, out, overlay, preview, token, };

package/oclif.manifest.json

@@ -92,6 +92,13 @@
           "multiple": true,
           "type": "option"
         },
+        "preview": {
+          "char": "p",
+          "description": "Generate a preview in your API context. The resulting version is temporary and not visible by your documentation viewers.",
+          "name": "preview",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "token": {
           "char": "t",
           "description": "Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable",
@@ -277,5 +284,5 @@
       "strict": true
     }
   },
-  "version": "2.9.3"
+  "version": "2.9.5"
 }

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.sh by using the API of developers.bump.sh",
-  "version": "2.9.3",
+  "version": "2.9.5",
   "author": "Paul Bonaud <paulr@bump.sh>",
   "bin": {
     "bump": "./bin/run.js"