@celonis/content-cli 1.9.0 → 1.9.1

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

@@ -42,6 +42,33 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 });
             });
         }
+        getSchema(assetType) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .get(`/pacman/api/core/asset-registry/schemas/${encodeURIComponent(assetType)}`)
+                    .catch((e) => {
+                    throw new logger_1.FatalError(`Problem getting schema for asset type '${assetType}': ${e}`);
+                });
+            });
+        }
+        getExamples(assetType) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .get(`/pacman/api/core/asset-registry/examples/${encodeURIComponent(assetType)}`)
+                    .catch((e) => {
+                    throw new logger_1.FatalError(`Problem getting examples for asset type '${assetType}': ${e}`);
+                });
+            });
+        }
+        getMethodology(assetType) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .get(`/pacman/api/core/asset-registry/methodologies/${encodeURIComponent(assetType)}`)
+                    .catch((e) => {
+                    throw new logger_1.FatalError(`Problem getting methodology for asset type '${assetType}': ${e}`);
+                });
+            });
+        }
     }
     exports.AssetRegistryApi = AssetRegistryApi;
 });

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

@@ -60,6 +60,34 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 }
             });
         }
+        getSchema(assetType, jsonResponse) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const data = yield this.api.getSchema(assetType);
+                this.outputResponse(data, jsonResponse);
+            });
+        }
+        getExamples(assetType, jsonResponse) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const data = yield this.api.getExamples(assetType);
+                this.outputResponse(data, jsonResponse);
+            });
+        }
+        getMethodology(assetType, jsonResponse) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const data = yield this.api.getMethodology(assetType);
+                this.outputResponse(data, jsonResponse);
+            });
+        }
+        outputResponse(data, jsonResponse) {
+            if (jsonResponse) {
+                const filename = (0, uuid_1.v4)() + ".json";
+                file_service_1.fileService.writeToFileWithGivenName(JSON.stringify(data, null, 2), filename);
+                logger_1.logger.info(file_service_1.FileService.fileDownloadedMessage + filename);
+            }
+            else {
+                logger_1.logger.info(typeof data === "string" ? data : JSON.stringify(data, null, 2));
+            }
+        }
         logDescriptorSummary(descriptor) {
             logger_1.logger.info(`${descriptor.assetType} - ${descriptor.displayName} [${descriptor.group}] (basePath: ${descriptor.service.basePath})`);
         }

package/commands/asset-registry/module.js

@@ -32,6 +32,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 .requiredOption("--assetType <assetType>", "The asset type identifier (e.g., BOARD_V2)")
                 .option("--json", "Return the response as a JSON file")
                 .action(this.getType);
+            assetRegistryCommand.command("schema")
+                .description("Get the JSON schema for an asset type's configuration")
+                .requiredOption("--assetType <assetType>", "The asset type identifier (e.g., BOARD_V2)")
+                .option("--json", "Return the response as a JSON file")
+                .action(this.getSchema);
+            assetRegistryCommand.command("examples")
+                .description("Get example configurations for an asset type")
+                .requiredOption("--assetType <assetType>", "The asset type identifier (e.g., BOARD_V2)")
+                .option("--json", "Return the response as a JSON file")
+                .action(this.getExamples);
+            assetRegistryCommand.command("methodology")
+                .description("Get the methodology / best-practices guide for an asset type")
+                .requiredOption("--assetType <assetType>", "The asset type identifier (e.g., BOARD_V2)")
+                .option("--json", "Return the response as a JSON file")
+                .action(this.getMethodology);
         }
         listTypes(context, command, options) {
             return __awaiter(this, void 0, void 0, function* () {
@@ -43,6 +58,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 yield new asset_registry_service_1.AssetRegistryService(context).getType(options.assetType, !!options.json);
             });
         }
+        getSchema(context, command, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                yield new asset_registry_service_1.AssetRegistryService(context).getSchema(options.assetType, !!options.json);
+            });
+        }
+        getExamples(context, command, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                yield new asset_registry_service_1.AssetRegistryService(context).getExamples(options.assetType, !!options.json);
+            });
+        }
+        getMethodology(context, command, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                yield new asset_registry_service_1.AssetRegistryService(context).getMethodology(options.assetType, !!options.json);
+            });
+        }
     }
     return Module;
 });

package/lib/commands/asset-registry/asset-registry-api.d.ts

@@ -5,4 +5,7 @@ export declare class AssetRegistryApi {
     constructor(context: Context);
     listTypes(): Promise<AssetRegistryMetadata>;
     getType(assetType: string): Promise<AssetRegistryDescriptor>;
+    getSchema(assetType: string): Promise<any>;
+    getExamples(assetType: string): Promise<any>;
+    getMethodology(assetType: string): Promise<any>;
 }

package/lib/commands/asset-registry/asset-registry.service.d.ts

@@ -4,6 +4,10 @@ export declare class AssetRegistryService {
     constructor(context: Context);
     listTypes(jsonResponse: boolean): Promise<void>;
     getType(assetType: string, jsonResponse: boolean): Promise<void>;
+    getSchema(assetType: string, jsonResponse: boolean): Promise<void>;
+    getExamples(assetType: string, jsonResponse: boolean): Promise<void>;
+    getMethodology(assetType: string, jsonResponse: boolean): Promise<void>;
+    private outputResponse;
     private logDescriptorSummary;
     private logDescriptorDetail;
 }

package/lib/commands/asset-registry/module.d.ts

@@ -4,5 +4,8 @@ declare class Module extends IModule {
     register(context: Context, configurator: Configurator): void;
     private listTypes;
     private getType;
+    private getSchema;
+    private getExamples;
+    private getMethodology;
 }
 export = Module;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@celonis/content-cli",
-  "version": "1.9.0",
+  "version": "1.9.1",
   "description": "CLI Tool to help manage content in Celonis Platform",
   "main": "content-cli.js",
   "bin": {

package/commands/api/api.service.js

@@ -1,81 +0,0 @@
-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", "../../core/utils/file-service", "uuid"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    exports.ApiService = void 0;
-    const logger_1 = require("../../core/utils/logger");
-    const file_service_1 = require("../../core/utils/file-service");
-    const uuid_1 = require("uuid");
-    class ApiService {
-        constructor(context) {
-            this.httpClient = () => context.httpClient;
-        }
-        request(path, method, body, jsonFile) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!path.startsWith("/")) {
-                    throw new logger_1.FatalError("Path must start with /");
-                }
-                const validMethods = ["GET", "POST", "PUT", "DELETE"];
-                if (!validMethods.includes(method)) {
-                    throw new logger_1.FatalError(`Invalid method '${method}'. Must be one of: ${validMethods.join(", ")}`);
-                }
-                logger_1.logger.info(`${method} ${path}`);
-                let parsedBody;
-                if (body) {
-                    try {
-                        parsedBody = JSON.parse(body);
-                    }
-                    catch (_a) {
-                        throw new logger_1.FatalError("--body must be valid JSON");
-                    }
-                }
-                const data = yield this.execute(method, path, parsedBody);
-                if (jsonFile) {
-                    const filename = (0, uuid_1.v4)() + ".json";
-                    file_service_1.fileService.writeToFileWithGivenName(JSON.stringify(data, null, 2), filename);
-                    logger_1.logger.info(file_service_1.FileService.fileDownloadedMessage + filename);
-                }
-                else {
-                    const output = typeof data === "string" ? data : JSON.stringify(data, null, 2);
-                    logger_1.logger.info(output);
-                }
-            });
-        }
-        execute(method, path, body) {
-            return __awaiter(this, void 0, void 0, function* () {
-                try {
-                    switch (method) {
-                        case "GET":
-                            return yield this.httpClient().get(path);
-                        case "POST":
-                            return yield this.httpClient().post(path, body !== null && body !== void 0 ? body : {});
-                        case "PUT":
-                            return yield this.httpClient().put(path, body !== null && body !== void 0 ? body : {});
-                        case "DELETE":
-                            return yield this.httpClient().delete(path);
-                    }
-                }
-                catch (e) {
-                    throw new logger_1.FatalError(`${method} ${path} failed: ${e}`);
-                }
-            });
-        }
-    }
-    exports.ApiService = ApiService;
-});

package/commands/api/module.js

@@ -1,42 +0,0 @@
-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", "./api.service"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    const module_handler_1 = require("../../core/command/module-handler");
-    const api_service_1 = require("./api.service");
-    class Module extends module_handler_1.IModule {
-        register(context, configurator) {
-            configurator.command("api")
-                .description("Send raw HTTP requests to Celonis APIs on the configured team (beta — testing only).")
-                .beta()
-                .command("request")
-                .description("Send a request to the given Celonis API path (e.g. /package-manager/api/packages)")
-                .requiredOption("--path <path>", "API path starting with / (e.g. /package-manager/api/packages)")
-                .option("--method <method>", "HTTP method: GET, POST, PUT, DELETE", "GET")
-                .option("--body <body>", "Request body as JSON string (for POST/PUT)")
-                .option("--json", "Write the response to a JSON file instead of printing it")
-                .action(this.request);
-        }
-        request(context, command, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                yield new api_service_1.ApiService(context).request(options.path, options.method.toUpperCase(), options.body, !!options.json);
-            });
-        }
-    }
-    return Module;
-});

package/lib/commands/api/api.service.d.ts

@@ -1,7 +0,0 @@
-import { Context } from "../../core/command/cli-context";
-export declare class ApiService {
-    private httpClient;
-    constructor(context: Context);
-    request(path: string, method: string, body?: string, jsonFile?: boolean): Promise<void>;
-    private execute;
-}

package/lib/commands/api/module.d.ts

@@ -1,7 +0,0 @@
-import { Configurator, IModule } from "../../core/command/module-handler";
-import { Context } from "../../core/command/cli-context";
-declare class Module extends IModule {
-    register(context: Context, configurator: Configurator): void;
-    private request;
-}
-export = Module;