bump-cli 2.9.11 → 2.10.0

package/README.md

@@ -9,15 +9,21 @@
   <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.
+- [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 API of [developers.bump.sh](https://developers.bump.sh). 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)
 [![License](https://img.shields.io/npm/l/bump-cli.svg)](https://github.com/bump-sh/cli/blob/master/package.json)
@@ -37,9 +43,9 @@ The Bump.sh CLI is a node package currently distributed via NPM. This means you
 
 _If you are looking to use Bump.sh in a continuous integration environment you might be interested by [our Github Action](https://github.com/marketplace/actions/bump-sh-api-documentation-changelog)._
 
+> [!NOTE]
 > You can download a standalone package directly from the latest
 > Github release assets if you don’t use Node.
-{: .info}
 
 ### Global installation
 
@@ -124,8 +130,8 @@ When an API is updated, the documentation should be updated at the same time. Th
 bump deploy path/to/api-document.yml --doc my-documentation --token $DOC_TOKEN
 ```
 
-> You can find your own `my-documentation` slug and `$DOC_TOKEN` api key from your [documentation settings](https://bump.sh/docs).
-{: .info}
+> [!TIP]
+> You can find your own `my-documentation` slug and `$DOC_TOKEN` api key from your [documentation settings](https://bump.sh/dashboard).
 
 You can also deploy a given API document to a different branch of your documentation with the `--branch <branch-name>` parameter. Please note the branch will be created if it doesn’t exist. More details about the branching feature are available on [this dedicated help page](https://docs.bump.sh/help/branching). E.g. deploy the API document to the `staging` branch of the documentation:
 
@@ -141,8 +147,8 @@ If you already have a hub in your [Bump.sh](https://bump.sh) account, you can au
 bump deploy dir/path/to/apis/ --auto-create --hub my-hub --token $HUB_TOKEN
 ```
 
+> [!TIP]
 > You can find your own `my-hub` slug and `$HUB_TOKEN` api key from your [hub settings](https://bump.sh/hubs).
-{: .info}
 
 Please note, by default, only files named `{slug}-api.[format]` are published. Where `{slug}` is a name for your API and `[format]` is either `yaml` or `json`. Adjust to your file naming convention using the `--filename-pattern <pattern>` option.
 
@@ -175,6 +181,30 @@ bump deploy path/to/api-document.yml --dry-run --doc my-documentation --token $D
 
 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.
+
+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-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
+
 ### The `diff` command
 
 Using the `diff` command can help to spot differences between the local API
@@ -271,14 +301,14 @@ bump preview --live --open api-document.yaml
 - Watch the live preview being updated each time you save your file.
 - The additional `--open` flag helps to automatically open the preview URL in your browser.
 
+> [!NOTE]
 > You can create as many previews as you like without being authenticated. This is a **free and unlimited service**.
-{: .info}
 
 Please check `bump preview --help` for more usage details
 
 ### The `overlay` command
 
-The [Overlay Specification](https://spec.openapis.org/overlay/v1.0.0.html) from the OpenAPI Initiative makes it possible to modify the content of an API definition by adding a layer on top of it. That layer helps adding, removing or changing some or all of the content of the original definition. 
+The [Overlay Specification](https://spec.openapis.org/overlay/v1.0.0.html) from the OpenAPI Initiative makes it possible to modify the content of an API definition by adding a layer on top of it. That layer helps adding, removing or changing some or all of the content of the original definition.
 
 The `bump overlay` command takes an original API document, applies the changes from the overlay document, and outputs a modified version. No changes are made directly to the original document.
 

package/dist/api/index.d.ts

@@ -1,6 +1,6 @@
 import { Config } from '@oclif/core';
 import { AxiosInstance, AxiosResponse } from 'axios';
-import { DiffRequest, DiffResponse, PingResponse, PreviewRequest, PreviewResponse, VersionRequest, VersionResponse, WithDiff } from './models.js';
+import { DiffRequest, DiffResponse, PingResponse, PreviewRequest, PreviewResponse, VersionRequest, VersionResponse, WithDiff, WorkflowVersionRequest, WorkflowVersionResponse } from './models.js';
 declare class BumpApi {
     protected config?: Config | undefined;
     protected readonly client: AxiosInstance;
@@ -8,6 +8,7 @@ declare class BumpApi {
     getPing: () => Promise<AxiosResponse<PingResponse>>;
     getVersion: (versionId: string, token: string) => Promise<AxiosResponse<VersionResponse & WithDiff>>;
     postDiff: (body: DiffRequest) => Promise<AxiosResponse<DiffResponse>>;
+    postMCPServerDeploy: (mcpServerIdOrSlug: string, body: WorkflowVersionRequest, token: string) => Promise<AxiosResponse<WorkflowVersionResponse>>;
     postPreview: (body?: PreviewRequest) => Promise<AxiosResponse<PreviewResponse>>;
     postValidation: (body: VersionRequest, token: string) => Promise<AxiosResponse<void>>;
     postVersion: (body: VersionRequest, token: string) => Promise<AxiosResponse<VersionResponse>>;

package/dist/api/index.js

@@ -12,6 +12,9 @@ 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, {
+        headers: this.authorizationHeader(token),
+    });
     postPreview = (body) => this.client.post('/previews', body);
     postValidation = (body, token) => this.client.post('/validations', body, {
         headers: this.authorizationHeader(token),

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;
@@ -67,3 +68,11 @@ export interface DiffItem {
     status: string;
     type: string;
 }
+export interface WorkflowVersionRequest {
+    definition: string;
+    references?: Reference[];
+}
+export interface WorkflowVersionResponse {
+    id: string;
+    mcp_server_id: string;
+}

package/dist/commands/deploy.d.ts

@@ -15,11 +15,13 @@ 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>;
+        'mcp-server': 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>;
         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, overlays?: 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>;
+    protected deploySingleWorkflowFile(workflowDefinition: API, mcpServer: string, token: string): Promise<void>;
     run(): Promise<void>;
 }

package/dist/commands/deploy.js

@@ -7,6 +7,7 @@ import { DefinitionDirectory } from '../core/definition-directory.js';
 import { Deploy as CoreDeploy } from '../core/deploy.js';
 import { isDir } from '../core/utils/file.js';
 import { confirm as promptConfirm } from '../core/utils/prompts.js';
+import { WorkflowDeploy as CoreWorkflowDeploy } from '../core/workflow-deploy.js';
 import { API } from '../definition.js';
 import * as flagsBuilder from '../flags.js';
 export default class Deploy extends BaseCommand {
@@ -46,6 +47,12 @@ Let's deploy a new version to your my-jobs-service documentation on Bump.sh... d
 ${chalk.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_token>')}
 * Let's validate on Bump.sh... done
 * Definition is valid
+`,
+        `Deploy a new workflow document of ${chalk.underline('an existing MCP server')}
+
+${chalk.dim('$ bump deploy FILE --mcp-server <your_mcp_server_id_or_slug> --token <your_organization_token>')}
+* Let's deploy on Bump.sh... done
+* Your <your_mcp_server_id_or_slug> MCP server... has received a new workflow definition which will soon be ready.
 `,
     ];
     static flags = {
@@ -57,6 +64,7 @@ ${chalk.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_tok
         'filename-pattern': flagsBuilder.filenamePattern(),
         hub: flagsBuilder.hub(),
         interactive: flagsBuilder.interactive(),
+        'mcp-server': flagsBuilder.mcpServer(),
         overlay: flagsBuilder.overlay(),
         preview: flagsBuilder.preview(),
         token: flagsBuilder.token(),
@@ -114,6 +122,17 @@ ${chalk.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_tok
             ux.warn(`Your ${documentation} 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);
+        if (response) {
+            process.stdout.write(ux.colorize('green', `Your ${mcpServer} MCP server...`));
+            ux.stdout(ux.colorize('green', `has received a new workflow definition which will soon be ready.`));
+        }
+        else {
+            ux.warn(`Your ${mcpServer} MCP server has not changed.`);
+        }
+    }
     /*
       Oclif doesn't type parsed args & flags correctly and especially
       required-ness which is not known by the compiler, thus the use of
@@ -122,7 +141,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, temporary,] = [
+        const [dryRun, documentation, token, hub, autoCreate, interactive, filenamePattern, documentationName, branch, overlay, temporary, mcpServer,] = [
             flags['dry-run'],
             flags.doc,
             flags.token,
@@ -137,6 +156,7 @@ ${chalk.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_tok
             flags.overlay,
             /* when --preview is provided, generate temporary version */
             flags.preview,
+            flags['mcp-server'],
         ];
         const action = dryRun ? 'validate' : temporary ? 'preview' : 'deploy';
         ux.action.start(`Let's ${action} on Bump.sh`);
@@ -153,8 +173,12 @@ ${chalk.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_tok
             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, temporary);
         }
+        else if (mcpServer) {
+            const workflowDefinition = await API.load(args.file);
+            await this.deploySingleWorkflowFile(workflowDefinition, mcpServer, token);
+        }
         else {
-            throw new CLIError('Missing required flag --doc=<slug>');
+            throw new CLIError('Missing required flag --doc=<slug> or --mcp-server=<slug>');
         }
         ux.action.stop();
     }

package/dist/core/overlay.js

@@ -119,7 +119,7 @@ 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 });
+            const merger = mergician({ appendArrays: true, dedupArrays: 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

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,
+    },
+};