@celonis/content-cli 1.13.1 → 1.14.0

package/README.md

@@ -9,11 +9,12 @@ teams and execute commands in a profile's context.
 
 1. [Getting Started](#getting-started)
 2. [About the Project](#about-the-project)
-3. [Building the Project](#building-and-using-the-project-locally)
-4. [Troubleshooting](#troubleshooting)
-5. [Release Process](#release-process)
-6. [Contributing](#contributing)
-7. [License](#license)
+3. [Command Graph](#command-graph)
+4. [Building the Project](#building-and-using-the-project-locally)
+5. [Troubleshooting](#troubleshooting)
+6. [Release Process](#release-process)
+7. [Contributing](#contributing)
+8. [License](#license)
 
 ## Getting Started
 
@@ -83,6 +84,17 @@ content-cli -h
 content-cli pull package -h
 ```
 
+## Command Graph
+
+[**Open the interactive Command Graph**](https://raw.githack.com/celonis/content-cli/main/docs/command-graph.html) — a
+searchable visualization of every Content CLI command, grouped by command area, with descriptions and options shown
+on click. It's served live from the [`docs/command-graph.html`](./docs/command-graph.html) source file via
+[raw.githack.com](https://raw.githack.com/), so it renders directly in your browser without needing to be downloaded.
+
+> **Note for contributors:** this graph must be kept in sync manually. See 
+> [How to Add a Command](./docs/how-to-add-command.md#keeping-the-command-graph-up-to-date) for instructions on 
+> updating it whenever commands are added or changed.
+
 ## Building and Using the Project locally 
 
 This tool is tightly connected with the Celonis Platform and all capabilities require to have access to a Celonis Platform Team. 

package/commands/action-flows/module.js

@@ -25,7 +25,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     const skill_command_service_1 = require("./skill/skill-command.service");
     class Module extends module_handler_1.IModule {
         register(context, configurator) {
-            const analyzeCommand = configurator.command("analyze");
+            const analyzeCommand = configurator.command("analyze")
+                .description("Analyze action flows and return its dependencies");
             analyzeCommand.command("action-flows")
                 .description("Analyze Action Flows dependencies for a certain package")
                 .requiredOption("--packageId <packageId>", "ID of the package from which you want to export Action Flows")

package/commands/asset-registry/asset-registry-api.js

@@ -13,14 +13,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "./asset-registry-error", "../../core/utils/path"], factory);
+        define(["require", "exports", "./asset-registry-error"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.AssetRegistryApi = void 0;
     const asset_registry_error_1 = require("./asset-registry-error");
-    const path_1 = require("../../core/utils/path");
     class AssetRegistryApi {
         constructor(context) {
             this.httpClient = () => context.httpClient;
@@ -32,13 +31,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                     .catch((e) => (0, asset_registry_error_1.handleAssetRegistryApiError)("listing asset registry types", e));
             });
         }
-        listSkills() {
-            return __awaiter(this, void 0, void 0, function* () {
-                return this.httpClient()
-                    .get(AssetRegistryApi.endpointUrl("skills"))
-                    .catch((e) => (0, asset_registry_error_1.handleAssetRegistryApiError)("listing asset registry skills", e));
-            });
-        }
         getType(assetType) {
             return __awaiter(this, void 0, void 0, function* () {
                 return this.httpClient()
@@ -67,31 +59,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                     .catch((e) => (0, asset_registry_error_1.handleAssetRegistryApiError)(`validating asset type '${assetType}'`, e));
             });
         }
-        getSkillFile(skillPath, filePath) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const operation = filePath
-                    ? `getting skill file '${filePath}' for '${skillPath}'`
-                    : `getting SKILL.md for '${skillPath}'`;
-                const url = this.buildSkillFileUrl(skillPath, filePath);
-                return this.httpClient()
-                    .getFile(url)
-                    .catch((e) => (0, asset_registry_error_1.handleAssetRegistryApiError)(operation, e));
-            });
-        }
-        buildSkillFileUrl(skillPath, filePath) {
-            const segments = ["skills", encodePathSegments(skillPath)];
-            if (filePath) {
-                segments.push(encodePathSegments(filePath));
-            }
-            return AssetRegistryApi.endpointUrl(...segments);
-        }
         static endpointUrl(...segments) {
             return `${AssetRegistryApi.BASE_URL}/${segments.join("/")}`;
         }
     }
     exports.AssetRegistryApi = AssetRegistryApi;
     AssetRegistryApi.BASE_URL = "/pacman/api/core/asset-registry";
-    function encodePathSegments(value) {
-        return (0, path_1.trimSlashes)(value).split("/").map(encodeURIComponent).join("/");
-    }
 });

package/commands/asset-registry/asset-registry.service.js

@@ -13,7 +13,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "./asset-registry-api", "../../core/utils/file-service", "../../core/utils/logger", "../../core/utils/path", "uuid", "node:path"], factory);
+        define(["require", "exports", "./asset-registry-api", "../../core/utils/file-service", "../../core/utils/logger", "uuid"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -22,9 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     const asset_registry_api_1 = require("./asset-registry-api");
     const file_service_1 = require("../../core/utils/file-service");
     const logger_1 = require("../../core/utils/logger");
-    const path_1 = require("../../core/utils/path");
     const uuid_1 = require("uuid");
-    const path = require("node:path");
     class AssetRegistryService {
         constructor(context) {
             this.api = new asset_registry_api_1.AssetRegistryApi(context);
@@ -49,46 +47,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 }
             });
         }
-        getSkillFile(opts) {
-            var _a;
-            return __awaiter(this, void 0, void 0, function* () {
-                const filename = this.resolveLocalFilename(opts.file);
-                const targetDir = (_a = opts.output) !== null && _a !== void 0 ? _a : ".";
-                const buffer = yield this.api.getSkillFile(opts.path, opts.file);
-                const absolutePath = file_service_1.fileService.writeBufferToPath(targetDir, filename, buffer);
-                logger_1.logger.info(file_service_1.FileService.fileDownloadedMessage + absolutePath);
-            });
-        }
-        resolveLocalFilename(file) {
-            if (!file) {
-                return "SKILL.md";
-            }
-            const trimmed = (0, path_1.trimSlashes)(file);
-            const base = trimmed ? path.basename(trimmed) : "";
-            if (!base) {
-                throw new logger_1.FatalError(`--file must point to a file, got '${file}'.`);
-            }
-            return base;
-        }
-        listSkills(jsonResponse) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const response = yield this.api.listSkills();
-                if (jsonResponse) {
-                    const filename = (0, uuid_1.v4)() + ".json";
-                    file_service_1.fileService.writeToFileWithGivenName(JSON.stringify(response), filename);
-                    logger_1.logger.info(file_service_1.FileService.fileDownloadedMessage + filename);
-                }
-                else {
-                    if (response.skills.length === 0) {
-                        logger_1.logger.info("No agent skills registered.");
-                        return;
-                    }
-                    response.skills.forEach((skill) => {
-                        this.logSkillSummary(skill);
-                    });
-                }
-            });
-        }
         getType(assetType, jsonResponse) {
             return __awaiter(this, void 0, void 0, function* () {
                 const descriptor = yield this.api.getType(assetType);
@@ -181,15 +139,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 logger_1.logger.info(base);
             }
         }
-        logSkillSummary(skill) {
-            const base = `${skill.name} (${skill.path})`;
-            if (skill.description) {
-                logger_1.logger.info(`${base} - ${skill.description}`);
-            }
-            else {
-                logger_1.logger.info(base);
-            }
-        }
         logDescriptorDetail(descriptor) {
             logger_1.logger.info(`Asset Type:   ${descriptor.assetType}`);
             logger_1.logger.info(`Display Name: ${descriptor.displayName}`);

package/commands/asset-registry/module.js

@@ -51,18 +51,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 .option("-f, --file <file>", "Path to a JSON file containing a full ValidateRequest body. Mutually exclusive with the build-from-options flags.")
                 .option("--json", "Return the response as a JSON file")
                 .action(this.validate);
-            const skillsCommand = assetRegistryCommand.command("skills")
-                .description("Discover agent skills exposed by the asset registry");
-            skillsCommand.command("list")
-                .description("List all available agent skills (name, description, path)")
-                .option("--json", "Return the response as a JSON file")
-                .action(this.listSkills);
-            skillsCommand.command("get")
-                .description("Download a skill file (defaults to SKILL.md)")
-                .requiredOption("--path <path>", "Skill path from 'skills list' (e.g. platform/<skill> or asset/<assetType>/<skill>)")
-                .option("--file <file>", "Relative path of a reference file within the skill (defaults to SKILL.md)")
-                .option("--output <output>", "Destination directory (defaults to current working directory)")
-                .action(this.getSkillFile);
         }
         listTypes(context, command, options) {
             return __awaiter(this, void 0, void 0, function* () {
@@ -96,20 +84,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 yield new asset_registry_service_1.AssetRegistryService(context).getExamples(options.assetType, !!options.json);
             });
         }
-        listSkills(context, command, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                yield new asset_registry_service_1.AssetRegistryService(context).listSkills(!!options.json);
-            });
-        }
-        getSkillFile(context, command, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                yield new asset_registry_service_1.AssetRegistryService(context).getSkillFile({
-                    path: options.path,
-                    file: options.file,
-                    output: options.output,
-                });
-            });
-        }
     }
     return Module;
 });

package/commands/bookmarks/bookmarks-api.js

@@ -0,0 +1,49 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "../../core/utils/logger"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.BookmarksApi = void 0;
+    const logger_1 = require("../../core/utils/logger");
+    class BookmarksApi {
+        constructor(context) {
+            this.httpClient = () => context.httpClient;
+        }
+        exportBookmarks(packageKey) {
+            return __awaiter(this, void 0, void 0, function* () {
+                try {
+                    return yield this.httpClient().get(`/package-manager/api/packages/${encodeURIComponent(packageKey)}/bookmarks/export`);
+                }
+                catch (e) {
+                    throw new logger_1.FatalError(`Problem exporting bookmarks for package ${packageKey}: ${e}`);
+                }
+            });
+        }
+        importBookmarks(packageKey, payload) {
+            return __awaiter(this, void 0, void 0, function* () {
+                try {
+                    return yield this.httpClient().post(`/package-manager/api/packages/${encodeURIComponent(packageKey)}/bookmarks/import`, payload);
+                }
+                catch (e) {
+                    throw new logger_1.FatalError(`Problem importing bookmarks for package ${packageKey}: ${e}`);
+                }
+            });
+        }
+    }
+    exports.BookmarksApi = BookmarksApi;
+});

package/commands/bookmarks/bookmarks-command.service.js

@@ -0,0 +1,46 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "./bookmarks-api", "../../core/utils/file-service", "../../core/utils/logger"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.BookmarksCommandService = void 0;
+    const bookmarks_api_1 = require("./bookmarks-api");
+    const file_service_1 = require("../../core/utils/file-service");
+    const logger_1 = require("../../core/utils/logger");
+    class BookmarksCommandService {
+        constructor(context) {
+            this.bookmarksApi = new bookmarks_api_1.BookmarksApi(context);
+        }
+        exportBookmarks(packageKey, file) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const exportData = yield this.bookmarksApi.exportBookmarks(packageKey);
+                const fileName = file !== null && file !== void 0 ? file : `bookmarks-${packageKey}.json`;
+                file_service_1.fileService.writeToFileWithGivenName(JSON.stringify(exportData, null, 4), fileName);
+                logger_1.logger.info(file_service_1.FileService.fileDownloadedMessage + fileName);
+            });
+        }
+        importBookmarks(packageKey, file) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const payload = file_service_1.fileService.readFileToJson(file);
+                const result = yield this.bookmarksApi.importBookmarks(packageKey, payload);
+                logger_1.logger.info(`Bookmarks imported successfully: ${JSON.stringify(result, null, 4)}`);
+            });
+        }
+    }
+    exports.BookmarksCommandService = BookmarksCommandService;
+});

package/{core/utils/path.js → commands/bookmarks/bookmarks.interfaces.js}

@@ -9,9 +9,4 @@
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.trimSlashes = void 0;
-    function trimSlashes(value) {
-        return value.replace(/^\/+/, "").replace(/\/+$/, "");
-    }
-    exports.trimSlashes = trimSlashes;
 });

package/commands/bookmarks/module.js

@@ -0,0 +1,49 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "../../core/command/module-handler", "./bookmarks-command.service"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    const module_handler_1 = require("../../core/command/module-handler");
+    const bookmarks_command_service_1 = require("./bookmarks-command.service");
+    class Module extends module_handler_1.IModule {
+        register(context, configurator) {
+            const exportCommand = configurator.command("export");
+            exportCommand.command("bookmarks")
+                .description("Export bookmarks for a package")
+                .requiredOption("--packageKey <packageKey>", "Key of the package to export bookmarks from")
+                .option("-f, --file <file>", "Output file path (defaults to bookmarks-<packageKey>.json)")
+                .action(this.exportBookmarks);
+            const importCommand = configurator.command("import");
+            importCommand.command("bookmarks")
+                .description("Import bookmarks into a package")
+                .requiredOption("--packageKey <packageKey>", "Key of the package to import bookmarks into")
+                .requiredOption("-f, --file <file>", "Bookmarks JSON file to import")
+                .action(this.importBookmarks);
+        }
+        exportBookmarks(context, _command, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                yield new bookmarks_command_service_1.BookmarksCommandService(context).exportBookmarks(options.packageKey, options.file);
+            });
+        }
+        importBookmarks(context, _command, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                yield new bookmarks_command_service_1.BookmarksCommandService(context).importBookmarks(options.packageKey, options.file);
+            });
+        }
+    }
+    return Module;
+});

package/commands/configuration-management/branch/api/branch.api.js

@@ -0,0 +1,88 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "../../../../core/utils/logger"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.BranchApi = void 0;
+    const logger_1 = require("../../../../core/utils/logger");
+    class BranchApi {
+        constructor(context) {
+            this.httpClient = () => context.httpClient;
+        }
+        configureBranchingSettings(packageKey, transport) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .put(`/pacman/api/core/packages/${packageKey}/branch-settings`, transport)
+                    .catch(e => {
+                    throw new logger_1.FatalError(`Problem updating branch settings for package ${packageKey}: ${e}`);
+                });
+            });
+        }
+        createBranch(packageKey, transport, validate = false) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const params = new URLSearchParams();
+                if (validate) {
+                    params.set("validate", "true");
+                }
+                const query = params.toString().length ? `?${params.toString()}` : "";
+                return this.httpClient()
+                    .post(`/pacman/api/core/packages/${packageKey}/branches${query}`, transport)
+                    .catch(e => {
+                    throw new logger_1.FatalError(`Problem creating branch '${transport.branchKey}' from package ${packageKey}: ${e}`);
+                });
+            });
+        }
+        listBranches(packageKey) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .get(`/pacman/api/core/packages/${packageKey}/branches`)
+                    .catch(e => {
+                    throw new logger_1.FatalError(`Problem listing branches for package ${packageKey}: ${e}`);
+                });
+            });
+        }
+        mergePreview(packageKey, transport) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .post(`/pacman/api/core/staging/packages/${packageKey}/merge/preview`, transport)
+                    .catch(e => {
+                    throw new logger_1.FatalError(`Problem previewing merge into package ${packageKey} from ${transport.sourceKey}@${transport.sourceVersion}: ${e}`);
+                });
+            });
+        }
+        merge(packageKey, transport) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .post(`/pacman/api/core/staging/packages/${packageKey}/merge`, transport)
+                    .catch(e => {
+                    throw new logger_1.FatalError(`Problem merging into package ${packageKey} from ${transport.sourceKey}@${transport.sourceVersion}: ${e}`);
+                });
+            });
+        }
+        deleteBranch(branchPackageKey) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .delete(`/pacman/api/core/staging/packages/${branchPackageKey}/purge`)
+                    .catch(e => {
+                    throw new logger_1.FatalError(`Problem deleting branch ${branchPackageKey}: ${e}`);
+                });
+            });
+        }
+    }
+    exports.BranchApi = BranchApi;
+});