bump-cli 2.9.11 → 2.10.0

package/dist/definition.js

@@ -5,8 +5,11 @@ import { parseWithPointers, safeStringify } from '@stoplight/yaml';
 import debug from 'debug';
 import { default as nodePath } from 'node:path';
 import { Overlay } from './core/overlay.js';
+import arazzoSchemas from './core/schemas/arazzo-schemas/index.js';
+import flowerSchemas from './core/schemas/flower-schemas/index.js';
 import openapiSchemas from './core/schemas/oas-schemas/index.js';
 class SupportedFormat {
+    static arazzo = arazzoSchemas.schemas;
     static asyncapi = {
         '2.0': asyncapi.schemas['2.0.0'],
         '2.1': asyncapi.schemas['2.1.0'],
@@ -16,12 +19,8 @@ class SupportedFormat {
         '2.5': asyncapi.schemas['2.5.0'],
         '2.6': asyncapi.schemas['2.6.0'],
     };
-    static openapi = {
-        '2.0': openapiSchemas.schemas['2.0'],
-        '3.0': openapiSchemas.schemas['3.0'],
-        '3.1': openapiSchemas.schemas['3.1'],
-        '3.2': openapiSchemas.schemas['3.2'],
-    };
+    static flower = flowerSchemas.schemas;
+    static openapi = openapiSchemas.schemas;
 }
 class UnsupportedFormat extends CLIError {
     constructor(message = '') {
@@ -40,31 +39,42 @@ class API {
     overlayedDefinition;
     rawDefinition;
     references;
-    spec;
     specName;
     version;
-    constructor(location, values) {
+    constructor(location, data) {
         this.location = location;
-        this.references = [];
-        const [raw, parsed] = this.resolveContent(values);
+        const [raw, parsed, references] = this._resolveContentFrom(data);
+        this.references = references || [];
         this.rawDefinition = raw;
         this.definition = parsed;
         this.specName = this.getSpecName(parsed);
         this.version = this.getVersion(parsed);
-        this.spec = this.getSpec(parsed);
-        if (this.spec === undefined) {
+        if (!this.getSpec(parsed)) {
             throw new UnsupportedFormat(`${this.specName} ${this.version}`);
         }
     }
+    static isArazzo(definition) {
+        return 'arazzo' in definition;
+    }
     static isAsyncAPI(definition) {
         return 'asyncapi' in definition;
     }
+    static isFlower(definition) {
+        return 'flower' in definition;
+    }
     static isOpenAPI(definition) {
         return typeof definition.openapi === 'string' || typeof definition.swagger === 'string';
     }
     static isOpenAPIOverlay(definition) {
         return 'overlay' in definition;
     }
+    static isSupportedFormat(definition) {
+        return (API.isArazzo(definition) ||
+            API.isAsyncAPI(definition) ||
+            API.isFlower(definition) ||
+            API.isOpenAPI(definition) ||
+            API.isOpenAPIOverlay(definition));
+    }
     static async load(path) {
         const { json, text, yaml } = getJsonSchemaRefParserDefaultOptions().parse;
         // Not sure why the lib types the parser as potentially
@@ -109,8 +119,17 @@ class API {
             },
         })
             .then(($refs) => {
-            const values = $refs.values();
-            return new API(path, values);
+            // JSON schema refs parser lib doesn't type the output of this
+            // method well (it types it as a generic JSON schema) where as
+            // it builds a Map of string (the path/URLs of each reference)
+            // to JSONSchema (the reference value)
+            //
+            // We also change the reference values in our custom parsers
+            // defined above to include the raw values which gets “widen”
+            // by the lib. We thus need to force the type output to a more
+            // precise type.
+            const data = $refs.values();
+            return new API(path, data);
         })
             .catch((error) => {
             throw new CLIError(error);
@@ -142,36 +161,69 @@ class API {
             }
             /* eslint-enable no-await-in-loop */
         }
+        if (API.isArazzo(this.definition)) {
+            await this._resolveArazzoSourceDescriptions();
+        }
         const references = [];
         for (let i = 0; i < this.references.length; i++) {
-            const reference = this.references[i];
-            references.push({
-                content: reference.content,
-                location: reference.location,
-            });
+            const { content, location, name } = this.references[i];
+            references.push({ content, location, name });
         }
         return [this.serializeDefinition(outputPath), references];
     }
     getSpec(definition) {
+        if (API.isArazzo(definition)) {
+            return SupportedFormat.arazzo[this.versionWithoutPatch()];
+        }
         if (API.isAsyncAPI(definition)) {
             return SupportedFormat.asyncapi[this.versionWithoutPatch()];
         }
+        if (API.isFlower(definition)) {
+            return SupportedFormat.flower[this.versionWithoutPatch()];
+        }
+        if (API.isOpenAPI(definition)) {
+            return SupportedFormat.openapi[this.versionWithoutPatch()];
+        }
         if (API.isOpenAPIOverlay(definition)) {
             return { overlay: { type: 'string' } };
         }
-        return SupportedFormat.openapi[this.versionWithoutPatch()];
+        return undefined;
     }
     getSpecName(definition) {
+        if (API.isArazzo(definition)) {
+            return 'Arazzo';
+        }
         if (API.isAsyncAPI(definition)) {
             return 'AsyncAPI';
         }
-        return 'OpenAPI';
+        if (API.isFlower(definition)) {
+            return 'Flower';
+        }
+        if (API.isOpenAPI(definition)) {
+            return 'OpenAPI';
+        }
+        if (API.isOpenAPIOverlay(definition)) {
+            return 'OpenAPIOverlay';
+        }
+        return undefined;
     }
     getVersion(definition) {
+        if (API.isArazzo(definition)) {
+            return definition.arazzo;
+        }
         if (API.isAsyncAPI(definition)) {
             return definition.asyncapi;
         }
-        return (definition.openapi || definition.swagger);
+        if (API.isFlower(definition)) {
+            return definition.flower;
+        }
+        if (API.isOpenAPI(definition)) {
+            return (definition.openapi || definition.swagger);
+        }
+        if (API.isOpenAPIOverlay(definition)) {
+            return definition.overlay;
+        }
+        return undefined;
     }
     guessFormat(output) {
         return (output || this.location).endsWith('.json') ? 'json' : 'yaml';
@@ -186,65 +238,100 @@ class API {
             .join(nodePath?.posix?.sep ?? '/');
         return path === this.location || path === resolvedAbsLocation;
     }
-    resolveContent(values) {
-        let mainReference = { parsed: {}, raw: '' };
-        for (const [absPath, reference] of Object.entries(values)) {
+    serializeDefinition(outputPath) {
+        if (this.overlayedDefinition) {
+            const { comments } = parseWithPointers(this.rawDefinition, { attachComments: true });
+            const dumpOptions = { comments, lineWidth: Number.POSITIVE_INFINITY, noRefs: true };
+            return this.guessFormat(outputPath) === 'json'
+                ? JSON.stringify(this.overlayedDefinition)
+                : safeStringify(this.overlayedDefinition, dumpOptions);
+        }
+        return this.rawDefinition;
+    }
+    versionWithoutPatch() {
+        if (!this.version) {
+            return '';
+        }
+        const [major, minor] = this.version.split('.', 3);
+        return `${major}.${minor}`;
+    }
+    async _resolveArazzoSourceDescriptions() {
+        if (!API.isArazzo(this.definition)) {
+            debug('bump-cli:definition')('This is not an Arazzo definition, no source descriptions to resolve');
+        }
+        else if (this.definition.sourceDescriptions) {
+            const sources = this.definition.sourceDescriptions;
+            for (const { name, type: sourceType, url: location } of sources) {
+                if (sourceType === 'openapi') {
+                    const relativeLocation = this._resolveRelativeLocation(location);
+                    /* eslint-disable no-await-in-loop */
+                    const api = await API.load(relativeLocation);
+                    const [content] = await api.extractDefinition();
+                    /* eslint-enable no-await-in-loop */
+                    this.references.push({ content, location: relativeLocation, name });
+                }
+                else {
+                    debug('bump-cli:definition')(`Arazzo source description of type ${sourceType} is not yet supported.`);
+                }
+            }
+        }
+        else {
+            debug('bump-cli:definition')("Arazzo definition doesn't have any sourceDescriptions");
+        }
+    }
+    _resolveContentFrom(data) {
+        let definition;
+        let rawDefinition;
+        const references = [];
+        // data contains all refs as a map of paths/URLs and their
+        // correspond values
+        for (const [absPath, reference] of Object.entries(data)) {
             if (this.isMainRefPath(absPath)) {
-                // $refs.values is not properly typed so we need to force it
-                // with the resulting type of our custom defined parser
-                mainReference = reference;
+                ;
+                ({ parsed: definition, raw: rawDefinition } = reference);
             }
             else {
-                // $refs.values is not properly typed so we need to force it
-                // with the resulting type of our custom defined parser
-                const { raw } = reference;
-                if (!raw) {
+                if (!reference.raw) {
                     throw new UnsupportedFormat(`Reference ${absPath} is empty`);
                 }
-                this.references.push({
-                    content: raw,
-                    location: this.resolveRelativeLocation(absPath),
+                references.push({
+                    content: reference.raw,
+                    location: this._resolveRelativeLocation(absPath),
                 });
             }
         }
-        const { parsed, raw } = mainReference;
-        if (!parsed || !raw || !(parsed instanceof Object) || !('info' in parsed)) {
-            debug('bump-cli:definition')(`Main location (${this.location}) not found or empty (within ${JSON.stringify(Object.keys(values))})`);
-            throw new UnsupportedFormat("Definition needs to be an object with at least an 'info' key");
+        if (!definition ||
+            !rawDefinition ||
+            !(definition instanceof Object) ||
+            !('info' in definition || 'flower' in definition)) {
+            debug('bump-cli:definition')(`Main location (${this.location}) not found or empty (within ${JSON.stringify(Object.keys(data))})`);
+            throw new UnsupportedFormat('Definition needs to be a valid Object');
         }
-        if (!API.isOpenAPI(parsed) && !API.isAsyncAPI(parsed) && !API.isOpenAPIOverlay(parsed)) {
+        if (!API.isSupportedFormat(definition)) {
             throw new UnsupportedFormat();
         }
-        return [raw, parsed];
+        return [rawDefinition, definition, references];
     }
-    /* Resolve reference absolute paths to the main api location when possible */
-    resolveRelativeLocation(absPath) {
+    /* Resolve reference paths to the main api location when possible */
+    _resolveRelativeLocation(path) {
         const definitionUrl = this.url();
-        const refUrl = this.url(absPath);
-        if ((refUrl.hostname === '' && // filesystem path
-            (/^\//.test(absPath) || // Unix style
-                /^[A-Za-z]+:[/\\]/.test(absPath))) || // Windows style
-            (/^https?:\/\//.test(absPath) && definitionUrl.hostname === refUrl.hostname) // Same domain URLs
-        ) {
-            const relativeLocation = nodePath.relative(nodePath.dirname(this.location), absPath);
-            debug('bump-cli:definition')(`Resolved relative $ref location: ${relativeLocation}`);
-            return relativeLocation;
-        }
-        return absPath;
-    }
-    serializeDefinition(outputPath) {
-        if (this.overlayedDefinition) {
-            const { comments } = parseWithPointers(this.rawDefinition, { attachComments: true });
-            const dumpOptions = { comments, lineWidth: Number.POSITIVE_INFINITY, noRefs: true };
-            return this.guessFormat(outputPath) === 'json'
-                ? JSON.stringify(this.overlayedDefinition)
-                : safeStringify(this.overlayedDefinition, dumpOptions);
+        const refUrl = this.url(path);
+        const unixStyle = /^\//.test(path);
+        const windowsStyle = /^[A-Za-z]+:[/\\]/.test(path);
+        const isUrl = /^https?:\/\//.test(path);
+        // Guard: Absolute URL on different domain we return an untouched
+        // path
+        if (isUrl && definitionUrl.hostname !== refUrl.hostname) {
+            return path;
         }
-        return this.rawDefinition;
-    }
-    versionWithoutPatch() {
-        const [major, minor] = this.version.split('.', 3);
-        return `${major}.${minor}`;
+        const isAbsolutePath = refUrl.hostname === '' && (unixStyle || windowsStyle);
+        // Absolute path or URL on **same domain**
+        const isAbsolute = isAbsolutePath || isUrl;
+        const relativeLocation = isAbsolute
+            ? nodePath.relative(nodePath.dirname(this.location), path)
+            : nodePath.join(nodePath.dirname(this.location), path);
+        debug('bump-cli:definition')(`Resolved relative $ref location: ${relativeLocation}`);
+        return relativeLocation;
     }
     url(location = this.location) {
         try {

package/dist/flags.d.ts

@@ -46,4 +46,8 @@ 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, preview, token, };
+declare const mcpServer: Interfaces.FlagDefinition<string, Interfaces.CustomOptions, {
+    multiple: false;
+    requiredOrDefaulted: false;
+}>;
+export { autoCreate, branch, doc, docName, dryRun, expires, failOnBreaking, filenamePattern, format, hub, interactive, live, mcpServer, open, out, overlay, preview, token, };

package/dist/flags.js

@@ -45,7 +45,7 @@ const token = Flags.custom({
         if (envToken)
             return envToken;
     },
-    description: 'Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable',
+    description: 'Documentation, Hub or Organization token. Can be provided via BUMP_TOKEN environment variable',
     required: true,
 });
 const autoCreate = (opts = {}) => {
@@ -123,4 +123,8 @@ 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, preview, token, };
+const mcpServer = Flags.custom({
+    char: 'm',
+    description: 'MCP server id or slug',
+});
+export { autoCreate, branch, doc, docName, dryRun, expires, failOnBreaking, filenamePattern, format, hub, interactive, live, mcpServer, open, out, overlay, preview, token, };

package/oclif.manifest.json

@@ -14,7 +14,8 @@
         "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 on Bump.sh... 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",
+        "Deploy a new workflow document of an existing MCP server\n\n$ bump deploy FILE --mcp-server <your_mcp_server_id_or_slug> --token <your_organization_token>\n* Let's deploy on Bump.sh... done\n* Your <your_mcp_server_id_or_slug> MCP server... has received a new workflow definition which will soon be ready.\n"
       ],
       "flags": {
         "auto-create": {
@@ -84,6 +85,14 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "mcp-server": {
+          "char": "m",
+          "description": "MCP server id or slug",
+          "name": "mcp-server",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "overlay": {
           "char": "o",
           "description": "Path or URL of overlay file(s) to apply before deploying",
@@ -101,7 +110,7 @@
         },
         "token": {
           "char": "t",
-          "description": "Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable",
+          "description": "Documentation, Hub or Organization token. Can be provided via BUMP_TOKEN environment variable",
           "name": "token",
           "required": true,
           "default": "99f52837852249b328c0a00249f846a3",
@@ -203,7 +212,7 @@
         },
         "token": {
           "char": "t",
-          "description": "Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable",
+          "description": "Documentation, Hub or Organization token. Can be provided via BUMP_TOKEN environment variable",
           "name": "token",
           "required": false,
           "default": "99f52837852249b328c0a00249f846a3",
@@ -294,5 +303,5 @@
       "strict": true
     }
   },
-  "version": "2.9.11"
+  "version": "2.10.0"
 }

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.11",
+  "version": "2.10.0",
   "author": "Paul Bonaud <paulr@bump.sh>",
   "bin": {
     "bump": "./bin/run.js"
@@ -14,8 +14,8 @@
     "@types/debug": "^4.1.12",
     "@types/jsonpath": "^0.2.4",
     "@types/mocha": "^10",
-    "@types/node": "^24",
-    "@types/sinon": "^17.0.3",
+    "@types/node": "^25",
+    "@types/sinon": "^21.0.0",
     "@typescript-eslint/eslint-plugin": "^8.13.0",
     "chai": "^6.2.2",
     "eslint": "^8",
@@ -92,7 +92,7 @@
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^11.7.2",
     "@asyncapi/specs": "^6.8.0",
-    "@clack/prompts": "^0.11.0",
+    "@clack/prompts": "^1.0.0",
     "@oclif/core": "^4",
     "@oclif/plugin-help": "^6",
     "@oclif/plugin-warn-if-update-available": "^3.1.20",
@@ -103,6 +103,6 @@
     "debug": "^4.3.7",
     "jsonpathly": "^3.0.0",
     "mergician": "^2.0.2",
-    "open": "^10.1.0"
+    "open": "^11.0.0"
   }
 }