bump-cli 2.9.12 → 2.10.1

package/README.md

@@ -9,14 +9,20 @@
   <a href="https://bump.sh/users/sign_up">Sign up</a>
 </p>
 
-The Bump.sh CLI is used to interact with API documentation and hubs hosted on Bump.sh from your choice of popular API description formats: OpenAPI, Swagger, or AsyncAPI.
+The Bump.sh CLI is used to interact with API documentation, hubs and workflows hosted on Bump.sh from your choice of popular API description formats: OpenAPI, Swagger, or AsyncAPI for API documentation. Flower or Arazzo for API workflows.
 
 Using [OpenAPI](https://github.com/OAI/OpenAPI-Specification) (v3.x and v2.0) or [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest) (2.x), you can do any of the following:
 
 - Validate an API document before publishing to your documentation.
-- Publish an API document to your Bump.sh documentation or hubs.
-- Compare two API documents to generate a human-readable diff from your API definition.
-Under the hood, it uses the API of [developers.bump.sh](https://developers.bump.sh). And is built with the [`oclif`](https://oclif.io) framework in Typescript.
+- [Publish an API document](#the-deploy-command) to your Bump.sh documentation or hubs.
+- [Compare two API documents](#the-diff-command) to generate a human-readable diff from your API definition.
+Under the hood, it uses the workspace API of [developers.bump.sh](https://developers.bump.sh/doc/workspace/). And is built with the [`oclif`](https://oclif.io) framework in Typescript.
+
+Using [Flower](https://docs.bump.sh/help/mcp-servers/specification-support/flower-support/) or [Arazzo](https://docs.bump.sh/arazzo/v1.0/), you can:
+
+- [Deploy a workflow document](#deploy-a-workflow-document-on-your-mcp-server) to your Bump.sh MCP server
+
+Have fun designing APIs ✨.
 
 [![Version](https://img.shields.io/npm/v/bump-cli.svg)](https://npmjs.org/package/bump-cli)
 [![Tests](https://github.com/bump-sh/cli/actions/workflows/checks.yml/badge.svg)](https://github.com/bump-sh/cli/actions/workflows/checks.yml)
@@ -77,7 +83,7 @@ npx bump --help
 
 ### 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).
+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/doc/workspace/) (advanced usage only).
 
 ## Usage
 
@@ -177,15 +183,25 @@ Please check `bump deploy --help` for more usage details.
 
 #### Deploy a workflow document on your MCP server
 
-Use the `bump deploy` command with the `--mcp-server` flag to push a workflow definition to your MCP server.
+Use the `bump deploy` command with the `--mcp-server` flag to push a
+workflow definition to your MCP server.
+
+Documents following either [Arazzo](https://docs.bump.sh/arazzo/v1.0/)
+or
+[Flower](https://docs.bump.sh/help/mcp-servers/specification-support/flower-support/)
+specification are supported.
+
 
 ```shell
-bump deploy path/to/flower-document.yml --mcp-server my-mcp-server-id-or-slug --token $BUMP_TOKEN
+bump deploy path/to/flower-or-arazzo-document.yml --mcp-server my-mcp-server-id-or-slug --token $BUMP_TOKEN
 ```
 
 > [!NOTE]
 > You can find your own `mcp-server-id-or-slug` and `$BUMP_TOKEN` api key from your [MCP server settings](https://bump.sh/dashboard) at 'https://bump.sh/{your-organization}/workflow/set/{mcp-server-id}/tokens'.
 
+More details about the MCP server feature are available on [this
+dedicated help section](https://docs.bump.sh/help/mcp-servers/).
+
 This feature is currently in closed beta.
 Request an early access at hello@bump.sh
 
@@ -268,7 +284,7 @@ bump preview path/to/file.json
 You can also preview a document available via a URL:
 
 ```shell
-bump preview https://developers.bump.sh/source.yaml
+bump preview https://developers.bump.sh/doc/workspace/source.yaml
 ```
 
 #### Live preview
@@ -368,7 +384,7 @@ For example to generate a preview:
   > 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/).
+Please note that even if CLI is running locally, by default requests are sent to [Bump.sh API](https://developers.bump.sh/doc/workspace/).
 
 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`:

package/dist/api/index.js

@@ -12,7 +12,7 @@ class BumpApi {
         headers: this.authorizationHeader(token),
     });
     postDiff = (body) => this.client.post('/diffs', body);
-    postMCPServerDeploy = (mcpServerIdOrSlug, body, token) => this.client.post(`/mcp_servers/${mcpServerIdOrSlug}/deploy`, body, {
+    postMCPServerDeploy = (mcpServerIdOrSlug, body, token) => this.client.post(`/mcp-servers/${mcpServerIdOrSlug}/deploy`, body, {
         headers: this.authorizationHeader(token),
     });
     postPreview = (body) => this.client.post('/previews', body);

package/dist/api/models.d.ts

@@ -17,8 +17,9 @@ export interface PreviewRequest {
     references?: Reference[];
 }
 export interface Reference {
-    content?: string;
-    location?: string;
+    content: string;
+    location: string;
+    name?: string;
 }
 export interface VersionRequest {
     auto_create_documentation?: boolean;
@@ -33,6 +34,7 @@ export interface VersionRequest {
     unpublished?: boolean;
 }
 export interface VersionResponse {
+    doc_name: string;
     doc_public_url?: string;
     id: string;
 }
@@ -69,8 +71,10 @@ export interface DiffItem {
 }
 export interface WorkflowVersionRequest {
     definition: string;
+    references?: Reference[];
 }
 export interface WorkflowVersionResponse {
     id: string;
     mcp_server_id: string;
+    mcp_server_name: string;
 }

package/dist/commands/deploy.js

@@ -110,23 +110,25 @@ ${chalk.dim('$ bump deploy FILE --mcp-server <your_mcp_server_id_or_slug> --toke
     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, temporary);
+        const docName = response?.doc_name || documentation;
         if (dryRun) {
             ux.stdout(ux.colorize('green', 'Definition is valid'));
         }
         else if (response) {
-            process.stdout.write(ux.colorize('green', `Your ${documentation} documentation...`));
+            process.stdout.write(ux.colorize('green', `Your ${docName} documentation...`));
             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 {
-            ux.warn(`Your ${documentation} documentation has not changed`);
+            ux.warn(`Your ${docName} documentation has not changed`);
         }
     }
     async deploySingleWorkflowFile(workflowDefinition, mcpServer, token) {
         ux.action.status = `...a new workflow definition to your ${mcpServer} MCP server`;
         const response = await new CoreWorkflowDeploy(this.bump).run(workflowDefinition, mcpServer, token);
+        const mcpServerName = response?.mcp_server_name || mcpServer;
         if (response) {
-            process.stdout.write(ux.colorize('green', `Your ${mcpServer} MCP server...`));
+            process.stdout.write(ux.colorize('green', `Your ${mcpServerName} MCP server...`));
             ux.stdout(ux.colorize('green', `has received a new workflow definition which will soon be ready.`));
         }
         else {

package/dist/core/diff.d.ts

@@ -1,6 +1,9 @@
 import { Config } from '@oclif/core';
 import { BumpApi } from '../api/index.js';
 import { DiffResponse, VersionResponse, WithDiff } from '../api/models.js';
+export interface DiffResult extends DiffResponse {
+    doc_name?: string;
+}
 export declare class Diff {
     static readonly TIMEOUT = 120;
     private _bump;
@@ -11,14 +14,14 @@ export declare class Diff {
     createDiff(file1: string, file2: string, expires: string | undefined, overlays1?: string[] | undefined, overlays2?: string[] | undefined): Promise<DiffResponse | undefined>;
     createVersion(file: string, documentation: string, token: string, hub: string | undefined, branch_name: string | undefined, previous_version_id?: string | undefined, overlays?: string[] | undefined): Promise<VersionResponse | undefined>;
     d(formatter: any, ...args: any[]): void;
-    extractDiff(versionWithDiff: VersionResponse & WithDiff): DiffResponse;
+    extractDiff(versionWithDiff: VersionResponse & WithDiff): DiffResult;
     isVersion(result: DiffResponse | VersionResponse): result is VersionResponse;
     isVersionWithDiff(result: DiffResponse | (VersionResponse & WithDiff)): result is VersionResponse & WithDiff;
     pollingDelay(): Promise<void>;
-    run(file1: string, file2: string | undefined, documentation: string | undefined, hub: string | undefined, branch: string | undefined, token: string | undefined, format: string, expires?: string | undefined, overlays1?: string[] | undefined, overlays2?: string[] | undefined): Promise<DiffResponse | undefined>;
-    waitResult(result: DiffResponse | VersionResponse, token: string | undefined, opts: {
+    run(file1: string, file2: string | undefined, documentation: string | undefined, hub: string | undefined, branch: string | undefined, token: string | undefined, format: string, expires?: string | undefined, overlays1?: string[] | undefined, overlays2?: string[] | undefined): Promise<DiffResult | undefined>;
+    waitResult(apiResponse: DiffResponse | VersionResponse, token: string | undefined, opts: {
         format: string;
         timeout: number;
-    }): Promise<DiffResponse>;
+    }): Promise<DiffResult>;
     private delay;
 }

package/dist/core/diff.js

@@ -82,6 +82,7 @@ export class Diff {
         return {
             breaking: versionWithDiff.diff_breaking,
             details: versionWithDiff.diff_details,
+            doc_name: versionWithDiff.doc_name,
             id: versionWithDiff.id,
             markdown: versionWithDiff.diff_markdown,
             public_url: versionWithDiff.diff_public_url,
@@ -122,35 +123,34 @@ export class Diff {
         }
         return undefined;
     }
-    async waitResult(result, token, opts) {
-        const pollingResponse = await (this.isVersion(result) && token
-            ? this.bumpClient.getVersion(result.id, token)
-            : this.bumpClient.getDiff(result.id, opts.format));
+    async waitResult(apiResponse, token, opts) {
+        let diffResult = { id: apiResponse.id };
+        const pollingResponse = await (this.isVersion(apiResponse) && token
+            ? this.bumpClient.getVersion(apiResponse.id, token)
+            : this.bumpClient.getDiff(apiResponse.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.');
         }
         switch (pollingResponse.status) {
             case 200: {
-                let diff = pollingResponse.data;
-                if (this.isVersionWithDiff(diff)) {
-                    diff = this.extractDiff(diff);
-                }
+                const diff = pollingResponse.data;
+                diffResult = this.isVersionWithDiff(diff) ? this.extractDiff(diff) : diff;
                 this.d('Received diff:');
-                this.d(diff);
-                return diff;
+                this.d(diffResult);
+                return diffResult;
                 break;
             }
             case 202: {
                 this.d('Waiting 1 sec before next poll');
                 await this.pollingDelay();
-                return this.waitResult(result, token, {
+                return this.waitResult(apiResponse, token, {
                     format: opts.format,
                     timeout: opts.timeout - 1,
                 });
                 break;
             }
         }
-        return {};
+        return diffResult;
     }
     async delay(ms) {
         return new Promise((resolve) => {

package/dist/core/overlay.d.ts

@@ -4,6 +4,7 @@ export declare class Overlay {
     run(spec: APIDefinition, overlay: OpenAPIOverlay): APIDefinition;
     private executeAction;
     private humanName;
+    private mergeWithEnumDedup;
     private pathEntryToKey;
     private remove;
     private update;

package/dist/core/overlay.js

@@ -98,6 +98,18 @@ export class Overlay {
     humanName(action) {
         return action.description ? `Action '${action.description}'` : 'Action';
     }
+    // Deep merge objects using a module (built-in spread operator is only shallow)
+    mergeWithEnumDedup(target, update) {
+        const merger = mergician({
+            afterEach(options) {
+                if (options.key === 'enum' && Array.isArray(options.mergeVal)) {
+                    return [...new Set(options.mergeVal)];
+                }
+            },
+            appendArrays: true,
+        });
+        return merger(target, update);
+    }
     // The last path entry (e.g. "'price']" or '0]') contains a final
     // ']' so we need to remove it AND we need to replace single quotes
     // to double quotes AND FINALLY parse the element to transform the
@@ -118,13 +130,11 @@ export class Overlay {
     }
     update(spec, parent, update, property_or_index) {
         try {
-            // Deep merge objects using a module (built-in spread operator is only shallow)
-            const merger = mergician({ appendArrays: true });
             if (property_or_index === '$') {
                 // You can't actually merge an update on a root object
                 // target with the jsonpathly lib, this is just us merging
                 // the given update with the whole spec.
-                spec = merger(spec, update);
+                spec = this.mergeWithEnumDedup(spec, update);
             }
             else if (property_or_index !== undefined) {
                 const targetObject = parent[property_or_index];
@@ -132,7 +142,7 @@ export class Overlay {
                     parent[property_or_index] =
                         Array.isArray(targetObject) && Array.isArray(update)
                             ? [...targetObject, ...update]
-                            : merger(targetObject, update);
+                            : this.mergeWithEnumDedup(targetObject, update);
                 }
                 else {
                     parent[property_or_index] = update;

package/dist/core/schemas/arazzo-schemas/index.d.ts

@@ -0,0 +1,7 @@
+import type { JSONSchema7 } from 'json-schema';
+declare const _default: {
+    schemas: {
+        '1.0': JSONSchema7;
+    };
+};
+export default _default;

package/dist/core/schemas/arazzo-schemas/index.js

@@ -0,0 +1,8 @@
+// Spec definitions are copied from the official
+// spec repo https://spec.openapis.org/arazzo/
+import schemaV10 from './v1.0/schema.json' with { type: 'json' };
+export default {
+    schemas: {
+        '1.0': schemaV10,
+    },
+};