@celonis/content-cli 1.3.0 → 1.4.1

package/commands/configuration-management/api/node-dependency-api.js

@@ -24,7 +24,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         constructor(context) {
             this.httpClient = () => context.httpClient;
         }
-        findAll(packageKey, nodeKey, version) {
+        findAllStaging(packageKey, nodeKey) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .get(`/pacman/api/core/staging/packages/${packageKey}/nodes/${nodeKey}/dependencies`)
+                    .catch((e) => {
+                    throw new logger_1.FatalError(`Problem finding dependencies for node ${nodeKey} in package ${packageKey}: ${e}`);
+                });
+            });
+        }
+        findAllByVersion(packageKey, nodeKey, version) {
             return __awaiter(this, void 0, void 0, function* () {
                 const queryParams = new URLSearchParams();
                 queryParams.set("version", version);

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

@@ -0,0 +1,38 @@
+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.PackageVersionApi = void 0;
+    const logger_1 = require("../../../core/utils/logger");
+    class PackageVersionApi {
+        constructor(context) {
+            this.httpClient = () => context.httpClient;
+        }
+        findOne(packageKey, version) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .get(`/pacman/api/core/packages/${packageKey}/versions/${version}`)
+                    .catch(e => {
+                    throw new logger_1.FatalError(`Problem finding Package with key '${packageKey}' and version '${version}': ${e}`);
+                });
+            });
+        }
+    }
+    exports.PackageVersionApi = PackageVersionApi;
+});

package/commands/configuration-management/interfaces/package-version.interfaces.js

@@ -0,0 +1,12 @@
+(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"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});

package/commands/configuration-management/module.js

@@ -16,7 +16,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", "../../core/command/module-handler", "./config-command.service", "./variable-command.service", "./node.service", "./node-diff.service", "./node-dependency.service"], factory);
+        define(["require", "exports", "../../core/command/module-handler", "./config-command.service", "./variable-command.service", "./node.service", "./node-diff.service", "./node-dependency.service", "./package-version-command.service"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -26,6 +26,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     const node_service_1 = require("./node.service");
     const node_diff_service_1 = require("./node-diff.service");
     const node_dependency_service_1 = require("./node-dependency.service");
+    const package_version_command_service_1 = require("./package-version-command.service");
     class Module extends module_handler_1.IModule {
         register(context, configurator) {
             const configCommand = configurator.command("config");
@@ -44,8 +45,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 .option("--keysByVersion <keysByVersion...>", "Keys of packages to export by version")
                 .option("--withDependencies", "Include variables and dependencies", "")
                 .option("--unzip", "Unzip the exported file", "")
-                .betaOption("--gitProfile <gitProfile>", "Git profile which you want to use for the Git operations")
-                .betaOption("--gitBranch <gitBranch>", "Git branch in which you want to push the exported file")
+                .option("--gitProfile <gitProfile>", "Git profile which you want to use for the Git operations")
+                .option("--gitBranch <gitBranch>", "Git branch in which you want to push the exported file")
                 .action(this.batchExportPackages);
             const metadataCommand = configCommand.command("metadata")
                 .description("Commands related to package metadata");
@@ -58,8 +59,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             configCommand.command("import")
                 .description("Command to import package configs")
                 .option("--overwrite", "Flag to allow overwriting of packages")
-                .betaOption("--gitProfile <gitProfile>", "Git profile which you want to use for the Git operations")
-                .betaOption("--gitBranch <gitBranch>", "Git branch from which you want to pull the exported file and import")
+                .option("--gitProfile <gitProfile>", "Git profile which you want to use for the Git operations")
+                .option("--gitBranch <gitBranch>", "Git branch from which you want to pull the exported file and import")
                 .option("-f, --file <file>", "Exported packages file (relative path)")
                 .option("-d, --directory <directory>", "Exported packages directory (relative path)")
                 .action(this.batchImportPackages);
@@ -69,6 +70,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 .option("--json", "Return the response as a JSON file")
                 .requiredOption("-f, --file <file>", "Exported packages file (relative or absolute path)")
                 .action(this.diffPackages);
+            const configVersionCommand = configCommand.command("versions")
+                .description("Commands related to Package version metadata");
+            configVersionCommand.command("get")
+                .description("Get version metadata for a specific package version")
+                .requiredOption("--packageKey <packageKey>", "Identifier of the package")
+                .requiredOption("--packageVersion <packageVersion>", "Version of the package. Can be a specific version or \"LATEST\" keyword, which will return the most recently created version.")
+                .option("--json", "Return the response as a JSON file")
+                .action(this.getPackageVersion);
             const variablesCommand = configCommand.command("variables")
                 .description("Commands related to variable configs");
             variablesCommand.command("list")
@@ -110,7 +119,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 .description("List dependencies of a specific node in a package")
                 .requiredOption("--packageKey <packageKey>", "Identifier of the package")
                 .requiredOption("--nodeKey <nodeKey>", "Identifier of the node")
-                .requiredOption("--packageVersion <packageVersion>", "Version of the package")
+                .option("--packageVersion <packageVersion>", "Version of the package. If not sent, the staging state of the package will be used.")
                 .option("--json", "Return the response as a JSON file")
                 .action(this.listNodeDependencies);
             const listCommand = configurator.command("list");
@@ -144,6 +153,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 yield new config_command_service_1.ConfigCommandService(context).batchExportPackagesMetadata(options.packageKeys, options.json);
             });
         }
+        getPackageVersion(context, command, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                yield new package_version_command_service_1.PackageVersionCommandService(context).getPackageVersion(options.packageKey, options.packageVersion, options.json);
+            });
+        }
         batchImportPackages(context, command, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (options.gitProfile && !options.gitBranch) {
@@ -185,6 +199,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         }
         listNodeDependencies(context, command, options) {
             return __awaiter(this, void 0, void 0, function* () {
+                if (options.packageVersion === "") {
+                    throw new Error("Please specify a valid package version");
+                }
                 yield new node_dependency_service_1.NodeDependencyService(context).listNodeDependencies(options.packageKey, options.nodeKey, options.packageVersion, options.json);
             });
         }

package/commands/configuration-management/node-dependency.service.js

@@ -29,7 +29,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         }
         listNodeDependencies(packageKey, nodeKey, version, jsonResponse) {
             return __awaiter(this, void 0, void 0, function* () {
-                const dependencies = yield this.nodeDependencyApi.findAll(packageKey, nodeKey, version);
+                let dependencies;
+                if (version) {
+                    dependencies = yield this.nodeDependencyApi.findAllByVersion(packageKey, nodeKey, version);
+                }
+                else {
+                    dependencies = yield this.nodeDependencyApi.findAllStaging(packageKey, nodeKey);
+                }
                 if (jsonResponse) {
                     const filename = (0, uuid_1.v4)() + ".json";
                     file_service_1.fileService.writeToFileWithGivenName(JSON.stringify(dependencies, null, 2), filename);

package/commands/configuration-management/package-version-command.service.js

@@ -0,0 +1,34 @@
+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", "./package-version.service"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.PackageVersionCommandService = void 0;
+    const package_version_service_1 = require("./package-version.service");
+    class PackageVersionCommandService {
+        constructor(context) {
+            this.packageVersionService = new package_version_service_1.PackageVersionService(context);
+        }
+        getPackageVersion(packageKey, version, jsonResponse) {
+            return __awaiter(this, void 0, void 0, function* () {
+                yield this.packageVersionService.findPackageVersion(packageKey, version, jsonResponse);
+            });
+        }
+    }
+    exports.PackageVersionCommandService = PackageVersionCommandService;
+});

package/commands/configuration-management/package-version.service.js

@@ -0,0 +1,55 @@
+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/file-service", "../../core/utils/logger", "uuid", "./api/package-version-api"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.PackageVersionService = void 0;
+    const file_service_1 = require("../../core/utils/file-service");
+    const logger_1 = require("../../core/utils/logger");
+    const uuid_1 = require("uuid");
+    const package_version_api_1 = require("./api/package-version-api");
+    class PackageVersionService {
+        constructor(context) {
+            this.packageVersionApi = new package_version_api_1.PackageVersionApi(context);
+        }
+        findPackageVersion(packageKey, version, jsonResponse) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const packageVersionTransport = yield this.packageVersionApi.findOne(packageKey, version);
+                if (jsonResponse) {
+                    const filename = (0, uuid_1.v4)() + ".json";
+                    file_service_1.fileService.writeToFileWithGivenName(JSON.stringify(packageVersionTransport, null, 2), filename);
+                    logger_1.logger.info(file_service_1.FileService.fileDownloadedMessage + filename);
+                }
+                else {
+                    this.printPackageVersionTransport(packageVersionTransport);
+                }
+            });
+        }
+        printPackageVersionTransport(packageVersionTransport) {
+            logger_1.logger.info(`Package Key: ${packageVersionTransport.packageKey}`);
+            logger_1.logger.info(`Version: ${packageVersionTransport.version}`);
+            logger_1.logger.info(`History ID: ${packageVersionTransport.historyId}`);
+            logger_1.logger.info(`Change Date: ${new Date(packageVersionTransport.changeDate).toISOString()}`);
+            logger_1.logger.info(`Publish Date: ${new Date(packageVersionTransport.publishDate).toISOString()}`);
+            logger_1.logger.info(`Publish Message: ${packageVersionTransport.publishMessage}`);
+            logger_1.logger.info(`Deployed: ${packageVersionTransport.deployed}`);
+            logger_1.logger.info(`Published By: ${packageVersionTransport.publishedBy}`);
+        }
+    }
+    exports.PackageVersionService = PackageVersionService;
+});

package/commands/git-profile/module.js

@@ -25,23 +25,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     class Module extends module_handler_1.IModule {
         register(context, configurator) {
             const gitCommand = configurator.command("git")
-                .beta()
                 .description("Commands related to Git settings");
             const gitProfileCommand = gitCommand.command("profile")
-                .beta()
                 .description("Manage Git profiles required to use git-related operations.");
             gitProfileCommand.command("list")
                 .description("Command to list all stored Git profiles")
-                .beta()
                 .action(this.listProfiles);
             gitProfileCommand.command("create")
                 .description("Command to create a new Git profile")
                 .option("--setAsDefault", "Set this Git profile as default")
-                .beta()
                 .action(this.createProfile);
             gitProfileCommand.command("default <profile>")
                 .description("Command to set a Git profile as default")
-                .beta()
                 .action(this.defaultProfile);
         }
         defaultProfile(context, command) {

package/core/command/cli-context.js

@@ -38,7 +38,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         }
         get httpClient() {
             if (!this._httpClient) {
-                throw new logger_1.FatalError("No profile provided. Please provide a profile or a TEAM_URL and API_TOKEN through env variables");
+                throw new logger_1.FatalError("No profile provided. Please provide a profile or a team url and api token through env variables");
             }
             return this._httpClient;
         }

package/core/profile/profile.service.js

@@ -40,6 +40,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         findProfile(profileName) {
             return __awaiter(this, void 0, void 0, function* () {
                 return new Promise((resolve, reject) => {
+                    this.mapCelonisEnvProfile();
                     this.checkIfMissingProfile(profileName, reject);
                     try {
                         if (process.env.TEAM_URL && process.env.API_TOKEN) {
@@ -311,6 +312,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 reject("Profile not found");
             }
         }
+        mapCelonisEnvProfile() {
+            if (!process.env.CELONIS_URL) {
+                return;
+            }
+            process.env.TEAM_URL = process.env.CELONIS_URL;
+            if (process.env.CELONIS_API_TOKEN) {
+                process.env.API_TOKEN = process.env.CELONIS_API_TOKEN;
+            }
+            else {
+                delete process.env.API_TOKEN;
+            }
+        }
     }
     exports.ProfileService = ProfileService;
     exports.profileService = new ProfileService();

package/core/utils/file-service.js

@@ -63,20 +63,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             }
             return targetDir;
         }
-        copyDirectoryToCurrentLocation(sourceDir, targetName) {
-            fs.mkdirSync(targetName, { recursive: true });
-            fs.cpSync(sourceDir, targetName, { recursive: true });
-        }
         isDirectory(sourcePath) {
             var _a;
             return (_a = fs.statSync(sourcePath)) === null || _a === void 0 ? void 0 : _a.isDirectory();
         }
         zipDirectoryInBatchExportFormat(sourceDir) {
+            if (fs.lstatSync(sourceDir).isSymbolicLink()) {
+                throw new logger_1.FatalError("Source directory cannot be a symbolic link.");
+            }
             const files = fs.readdirSync(sourceDir);
             const finalZip = new AdmZip();
             files.forEach(file => {
                 const fullPath = path.join(sourceDir, file);
-                const stat = fs.statSync(fullPath);
+                const stat = fs.lstatSync(fullPath);
                 if (stat.isDirectory()) {
                     const zip = new AdmZip();
                     zip.addLocalFolder(fullPath);

package/lib/commands/configuration-management/api/node-dependency-api.d.ts

@@ -3,5 +3,6 @@ import { NodeDependencyTransport } from "../interfaces/node-dependency.interface
 export declare class NodeDependencyApi {
     private httpClient;
     constructor(context: Context);
-    findAll(packageKey: string, nodeKey: string, version: string): Promise<NodeDependencyTransport[]>;
+    findAllStaging(packageKey: string, nodeKey: string): Promise<NodeDependencyTransport[]>;
+    findAllByVersion(packageKey: string, nodeKey: string, version: string): Promise<NodeDependencyTransport[]>;
 }

package/lib/commands/configuration-management/api/package-version-api.d.ts

@@ -0,0 +1,7 @@
+import { Context } from "../../../core/command/cli-context";
+import { PackageVersionTransport } from "../interfaces/package-version.interfaces";
+export declare class PackageVersionApi {
+    private httpClient;
+    constructor(context: Context);
+    findOne(packageKey: string, version: string): Promise<PackageVersionTransport>;
+}

package/lib/commands/configuration-management/interfaces/package-version.interfaces.d.ts

@@ -0,0 +1,10 @@
+export interface PackageVersionTransport {
+    packageKey: string;
+    historyId: string;
+    version: string;
+    changeDate: string;
+    publishDate: string;
+    publishMessage: string;
+    deployed: boolean;
+    publishedBy: string;
+}

package/lib/commands/configuration-management/module.d.ts

@@ -8,6 +8,7 @@ declare class Module extends IModule {
     private listActivePackages;
     private batchExportPackages;
     private batchExportPackagesMetadata;
+    private getPackageVersion;
     private batchImportPackages;
     private diffPackages;
     private listVariables;

package/lib/commands/configuration-management/package-version-command.service.d.ts

@@ -0,0 +1,6 @@
+import { Context } from "../../core/command/cli-context";
+export declare class PackageVersionCommandService {
+    private packageVersionService;
+    constructor(context: Context);
+    getPackageVersion(packageKey: string, version: string, jsonResponse: boolean): Promise<void>;
+}

package/lib/commands/configuration-management/package-version.service.d.ts

@@ -0,0 +1,7 @@
+import { Context } from "../../core/command/cli-context";
+export declare class PackageVersionService {
+    private packageVersionApi;
+    constructor(context: Context);
+    findPackageVersion(packageKey: string, version: string, jsonResponse: boolean): Promise<void>;
+    private printPackageVersionTransport;
+}

package/lib/core/profile/profile.service.d.ts

@@ -22,5 +22,6 @@ export declare class ProfileService {
     private isProfileExpired;
     private tryKeyAuthentication;
     private checkIfMissingProfile;
+    private mapCelonisEnvProfile;
 }
 export declare const profileService: ProfileService;

package/lib/core/utils/file-service.d.ts

@@ -6,7 +6,6 @@ export declare class FileService {
     readFile(filename: string): string;
     extractExportedZipWithNestedZips(zipFile: AdmZip): string;
     extractExportedZipWithNestedZipsToDir(zipFile: AdmZip, targetDir: string): string;
-    copyDirectoryToCurrentLocation(sourceDir: string, targetName: string): void;
     isDirectory(sourcePath: string): boolean;
     zipDirectoryInBatchExportFormat(sourceDir: string): string;
     private getSerializedFileContent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@celonis/content-cli",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "CLI Tool to help manage content in Celonis Platform",
   "main": "content-cli.js",
   "bin": {
@@ -53,5 +53,8 @@
       "prettier --write",
       "git add"
     ]
+  },
+  "repository": {
+    "url": "https://github.com/celonis/content-cli"
   }
 }