@celonis/content-cli 1.14.1 → 1.15.0

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

@@ -52,13 +52,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                     .catch((e) => (0, asset_registry_error_1.handleAssetRegistryApiError)(`getting examples for asset type '${assetType}'`, e));
             });
         }
-        validate(assetType, body) {
-            return __awaiter(this, void 0, void 0, function* () {
-                return this.httpClient()
-                    .post(AssetRegistryApi.endpointUrl("validate", encodeURIComponent(assetType)), body)
-                    .catch((e) => (0, asset_registry_error_1.handleAssetRegistryApiError)(`validating asset type '${assetType}'`, e));
-            });
-        }
         static endpointUrl(...segments) {
             return `${AssetRegistryApi.BASE_URL}/${segments.join("/")}`;
         }

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

@@ -74,54 +74,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 yield this.outputResponse(data, jsonResponse);
             });
         }
-        validate(opts) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const payload = this.buildValidatePayload(opts);
-                const data = yield this.api.validate(opts.assetType, payload);
-                yield this.outputResponse(data, opts.json);
-            });
-        }
-        buildValidatePayload(opts) {
-            const hasNodeKey = !!opts.nodeKey;
-            const hasConfig = !!opts.configuration;
-            const hasFile = !!opts.file;
-            if (hasFile && (hasNodeKey || hasConfig || !!opts.packageKey)) {
-                throw new logger_1.FatalError("Option -f is mutually exclusive with --packageKey, --nodeKey and --configuration.");
-            }
-            if (hasFile) {
-                return this.parseJson(file_service_1.fileService.readFile(opts.file), `-f ${opts.file}`);
-            }
-            if (hasNodeKey && hasConfig) {
-                throw new logger_1.FatalError("Options --nodeKey and --configuration are mutually exclusive. Use --nodeKey to validate a stored node, or --configuration to validate a configuration. For full control, use -f.");
-            }
-            if (!hasNodeKey && !hasConfig) {
-                throw new logger_1.FatalError("Provide --packageKey with one of --nodeKey (validate a stored node) or --configuration (validate a configuration), or use -f for a full request file.");
-            }
-            if (!opts.packageKey) {
-                throw new logger_1.FatalError("--packageKey is required when using --nodeKey or --configuration.");
-            }
-            if (hasNodeKey) {
-                return {
-                    assetType: opts.assetType,
-                    packageKey: opts.packageKey,
-                    nodeKeys: [opts.nodeKey],
-                };
-            }
-            const configJson = this.parseJson(opts.configuration, "--configuration");
-            return {
-                assetType: opts.assetType,
-                packageKey: opts.packageKey,
-                nodes: [{ key: AssetRegistryService.INLINE_VALIDATION_NODE_KEY, configuration: configJson }],
-            };
-        }
-        parseJson(raw, source) {
-            try {
-                return JSON.parse(raw);
-            }
-            catch (_a) {
-                throw new logger_1.FatalError(`Invalid JSON in ${source}.`);
-            }
-        }
         outputResponse(data, jsonResponse) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (jsonResponse) {
@@ -164,5 +116,4 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         }
     }
     exports.AssetRegistryService = AssetRegistryService;
-    AssetRegistryService.INLINE_VALIDATION_NODE_KEY = "validation-node";
 });

package/commands/asset-registry/module.js

@@ -42,15 +42,6 @@ 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.getExamples);
-            assetRegistryCommand.command("validate")
-                .description("Validate asset configuration against the asset service's validate endpoint.")
-                .requiredOption("--assetType <assetType>", "The asset type identifier (e.g., BOARD_V2)")
-                .option("--packageKey <packageKey>", "Package key. Required when validating with --nodeKey or --configuration.")
-                .option("--nodeKey <nodeKey>", "Key of an already-stored node to validate (use with --packageKey).")
-                .option("--configuration <configuration>", "Inline JSON of a configuration to validate (use with --packageKey).")
-                .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);
         }
         listTypes(context, command, options) {
             return __awaiter(this, void 0, void 0, function* () {
@@ -67,18 +58,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 yield new asset_registry_service_1.AssetRegistryService(context).getSchema(options.assetType, !!options.json);
             });
         }
-        validate(context, command, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                yield new asset_registry_service_1.AssetRegistryService(context).validate({
-                    assetType: options.assetType,
-                    packageKey: options.packageKey,
-                    nodeKey: options.nodeKey,
-                    configuration: options.configuration,
-                    file: options.file,
-                    json: !!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);

package/commands/git-profile/module.js

@@ -27,7 +27,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             const gitCommand = configurator.command("git")
                 .description("Commands related to Git settings");
             const gitProfileCommand = gitCommand.command("profile")
-                .description("Manage Git profiles required to use git-related operations.");
+                .description("Manage Git profiles required to use git-related operations.")
+                .skipProfileLoading();
             gitProfileCommand.command("list")
                 .description("Command to list all stored Git profiles")
                 .action(this.listProfiles);

package/commands/profile/module.js

@@ -26,7 +26,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     class Module extends module_handler_1.IModule {
         register(context, configurator) {
             const command = configurator.command("profile")
-                .description("Manage profiles required to access a system.");
+                .description("Manage profiles required to access a system.")
+                .skipProfileLoading();
             command.command("list")
                 .description("Command to list all stored profiles")
                 .action(this.listProfiles);

package/content-cli.js

@@ -19,7 +19,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.createProgram = void 0;
+    exports.loadProfileOnDemand = exports.createProgram = void 0;
     const semverSatisfies = require("semver/functions/satisfies");
     const commander_1 = require("commander");
     const module_handler_1 = require("./core/command/module-handler");
@@ -69,6 +69,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         return program;
     }
     exports.createProgram = createProgram;
+    function loadProfileOnDemand(program, context) {
+        program.hook("preAction", (_program, actionCommand) => __awaiter(this, void 0, void 0, function* () {
+            if ((0, module_handler_1.shouldLoadProfile)(actionCommand)) {
+                yield context.init();
+            }
+        }));
+    }
+    exports.loadProfileOnDemand = loadProfileOnDemand;
     /**
      * To support the legacy command structure, we have to configure some root commands
      * that the individual modules will extend.
@@ -103,8 +111,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 });
             }
             const context = new cli_context_1.Context(globalOpts);
-            yield context.init();
             const program = createProgram(context, { devMode: !!globalOpts.dev });
+            loadProfileOnDemand(program, context);
             try {
                 yield program.parseAsync(process.argv);
             }

package/core/command/module-handler.js

@@ -18,7 +18,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.CommandConfig = exports.Configurator = exports.ModuleHandler = exports.IModule = void 0;
+    exports.CommandConfig = exports.Configurator = exports.shouldLoadProfile = exports.ModuleHandler = exports.IModule = void 0;
     const path = require("path");
     const fs = require("fs");
     const commander_1 = require("commander");
@@ -120,6 +120,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         }
     }
     exports.ModuleHandler = ModuleHandler;
+    function shouldLoadProfile(command) {
+        for (let cmd = command; cmd; cmd = cmd.parent) {
+            if (cmd.skipsProfileLoading) {
+                return false;
+            }
+        }
+        return true;
+    }
+    exports.shouldLoadProfile = shouldLoadProfile;
     /**
      * Allows the creation of root level commands.
      */
@@ -192,6 +201,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             this.cmd.isBeta = true;
             return this;
         }
+        skipProfileLoading() {
+            this.cmd.skipsProfileLoading = true;
+            return this;
+        }
         action(handler) {
             this.cmd.action(() => __awaiter(this, void 0, void 0, function* () {
                 try {

package/core/http/http-client.js

@@ -246,11 +246,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             return Object.assign(Object.assign(Object.assign({}, this.buildAuthorizationHeaders(this.context.profile, contentType)), tracing_1.TracingUtils.getTracingHeaders()), { "User-Agent": "content-cli v" + version_1.VersionUtils.getCurrentCliVersion() });
         }
         buildAuthorizationHeaders(profile, contentType) {
-            const authenticationType = profile.authenticationType || profile_interface_1.AuthenticationType.BEARER;
-            return {
-                Authorization: `${authenticationType} ${profile.apiToken}`,
+            const headers = {
                 "Content-Type": contentType !== null && contentType !== void 0 ? contentType : "application/json",
             };
+            if (profile.apiToken) {
+                const authenticationType = profile.authenticationType || profile_interface_1.AuthenticationType.BEARER;
+                headers.Authorization = `${authenticationType} ${profile.apiToken}`;
+            }
+            return headers;
         }
     }
     exports.HttpClient = HttpClient;

package/core/profile/profile.service.js

@@ -72,15 +72,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                                     .catch(() => reject(`The profile ${profileName} couldn't be resolved.`));
                             }
                         }
-                        else if (process.env.TEAM_URL && process.env.API_TOKEN) {
-                            resolve(this.buildProfileFromEnvVariables());
-                        }
-                        else if (process.env.CELONIS_URL && process.env.CELONIS_API_TOKEN) {
-                            this.mapCelonisEnvProfile();
-                            resolve(this.buildProfileFromEnvVariables());
-                        }
                         else {
-                            reject(`The profile ${profileName} couldn't be resolved due to missing environment variables.`);
+                            const envProfileSource = this.selectEnvProfileSource();
+                            if (envProfileSource) {
+                                if (envProfileSource.requiresCelonisMapping) {
+                                    this.mapCelonisEnvProfile();
+                                }
+                                resolve(this.buildProfileFromEnvVariables());
+                            }
+                            else {
+                                reject(`The profile ${profileName} couldn't be resolved due to missing environment variables.`);
+                            }
                         }
                     }
                     catch (e) {
@@ -136,6 +138,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 });
             });
         }
+        selectEnvProfileSource() {
+            var _a, _b;
+            const sources = [
+                { teamUrl: process.env.TEAM_URL, apiToken: process.env.API_TOKEN, requiresCelonisMapping: false },
+                { teamUrl: process.env.CELONIS_URL, apiToken: process.env.CELONIS_API_TOKEN, requiresCelonisMapping: true },
+            ].filter(source => !!source.teamUrl);
+            return (_b = (_a = sources.find(source => !!source.apiToken)) !== null && _a !== void 0 ? _a : sources[0]) !== null && _b !== void 0 ? _b : null;
+        }
         buildProfileFromEnvVariables() {
             return __awaiter(this, void 0, void 0, function* () {
                 const profileVariables = this.getProfileEnvVariables();
@@ -146,7 +156,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                     authenticationType: profile_interface_1.AuthenticationType.BEARER,
                     type: profile_interface_1.ProfileType.KEY
                 };
-                profile.authenticationType = yield profile_validator_1.ProfileValidator.validateProfile(profile);
+                profile_validator_1.ProfileValidator.validateEnvironmentProfile(profile);
+                if (!profile.apiToken) {
+                    logger_1.logger.warn(`No API token provided. Requests to ${profile.team} will be sent without an authorization header.`);
+                }
                 return profile;
             });
         }
@@ -266,9 +279,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 if (!this.isProfileExpired(profile, expiryBuffer)) {
                     return;
                 }
-                const issuer = yield openid_client_1.Issuer.discover(profile.team);
-                if (profile.type === profile_interface_1.ProfileType.DEVICE_CODE) {
-                    try {
+                try {
+                    const issuer = yield openid_client_1.Issuer.discover(profile.team);
+                    if (profile.type === profile_interface_1.ProfileType.DEVICE_CODE) {
                         const oauthClient = new issuer.Client({
                             client_id: "content-cli",
                             token_endpoint_auth_method: "none",
@@ -278,12 +291,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                         profile.expiresAt = tokenSet.expires_at;
                         profile.refreshToken = tokenSet.refresh_token;
                     }
-                    catch (err) {
-                        logger_1.logger.error(new logger_1.FatalError("The profile cannot be refreshed. Please retry or recreate profile."));
-                    }
-                }
-                else {
-                    try {
+                    else {
                         const oauthClient = new issuer.Client({
                             client_id: profile.clientId,
                             client_secret: profile.clientSecret,
@@ -296,13 +304,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                         profile.apiToken = tokenSet.access_token;
                         profile.expiresAt = tokenSet.expires_at;
                     }
-                    catch (err) {
-                        logger_1.logger.error(new logger_1.FatalError("The profile cannot be refreshed. Please retry or recreate profile."));
-                    }
+                }
+                catch (err) {
+                    throw this.unrefreshableProfile(profile.name, err);
                 }
                 yield this.storeProfile(profile);
             });
         }
+        unrefreshableProfile(profileName, err) {
+            const cause = err instanceof Error ? err.message : "an unrecognised error";
+            logger_1.logger.debug(`Refreshing the profile ${profileName} failed: ${cause}`);
+            logger_1.logger.warn(`The profile ${profileName} cannot be refreshed. Retry, or recreate it.`);
+            return new Error(`The profile ${profileName} cannot be refreshed.`);
+        }
         getProfileEnvVariables() {
             return {
                 teamUrl: this.getBaseTeamUrl(process.env.TEAM_URL),

package/core/profile/profile.validator.js

@@ -25,23 +25,33 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     class ProfileValidator {
         static validateProfile(profile) {
             return __awaiter(this, void 0, void 0, function* () {
-                if (profile.name == null) {
-                    logger_1.logger.error(new logger_1.FatalError("The name can not be empty"));
-                }
-                if (profile.team == null) {
-                    logger_1.logger.error(new logger_1.FatalError("The team can not be empty"));
-                }
+                this.validateIdentity(profile);
                 if (profile.type === profile_interface_1.ProfileType.KEY && profile.apiToken == null) {
                     logger_1.logger.error(new logger_1.FatalError("The api token can not be empty for this profile type"));
                 }
                 if (profile.type === profile_interface_1.ProfileType.CLIENT_CREDENTIALS && (profile.clientId == null || profile.clientSecret == null)) {
                     logger_1.logger.error(new logger_1.FatalError("The client id and secret can not be empty for this profile type"));
                 }
-                if (!validUrl.isUri(profile.team)) {
-                    logger_1.logger.error(new logger_1.FatalError("The provided url is not a valid url."));
-                }
+                this.validateTeamUrl(profile);
             });
         }
+        static validateEnvironmentProfile(profile) {
+            this.validateIdentity(profile);
+            this.validateTeamUrl(profile);
+        }
+        static validateIdentity(profile) {
+            if (profile.name == null) {
+                logger_1.logger.error(new logger_1.FatalError("The name can not be empty"));
+            }
+            if (profile.team == null) {
+                logger_1.logger.error(new logger_1.FatalError("The team can not be empty"));
+            }
+        }
+        static validateTeamUrl(profile) {
+            if (!validUrl.isUri(profile.team)) {
+                logger_1.logger.error(new logger_1.FatalError("The provided url is not a valid url."));
+            }
+        }
     }
     exports.ProfileValidator = ProfileValidator;
 });

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

@@ -8,6 +8,5 @@ export declare class AssetRegistryApi {
     getType(assetType: string): Promise<AssetRegistryDescriptor>;
     getSchema(assetType: string): Promise<any>;
     getExamples(assetType: string): Promise<any>;
-    validate(assetType: string, body: any): Promise<any>;
     private static endpointUrl;
 }

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

@@ -28,11 +28,3 @@ export interface AssetContributions {
     dataPipelineEntityTypes: string[];
     actionTypes: string[];
 }
-export interface ValidateOptions {
-    assetType: string;
-    packageKey?: string;
-    nodeKey?: string;
-    configuration?: string;
-    file?: string;
-    json: boolean;
-}

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

@@ -1,4 +1,3 @@
-import { ValidateOptions } from "./asset-registry.interfaces";
 import { Context } from "../../core/command/cli-context";
 export declare class AssetRegistryService {
     private readonly api;
@@ -8,10 +7,6 @@ export declare class AssetRegistryService {
     getType(assetType: string, jsonResponse: boolean): Promise<void>;
     getSchema(assetType: string, jsonResponse: boolean): Promise<void>;
     getExamples(assetType: string, jsonResponse: boolean): Promise<void>;
-    validate(opts: ValidateOptions): Promise<void>;
-    private static readonly INLINE_VALIDATION_NODE_KEY;
-    private buildValidatePayload;
-    private parseJson;
     private outputResponse;
     private logDescriptorSummary;
     private logDescriptorDetail;

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

@@ -5,7 +5,6 @@ declare class Module extends IModule {
     private listTypes;
     private getType;
     private getSchema;
-    private validate;
     private getExamples;
 }
 export = Module;

package/lib/content-cli.d.ts

@@ -14,3 +14,4 @@ export interface CreateProgramOptions {
  * Build a fully-configured Commander program without parsing argv
  */
 export declare function createProgram(context: Context, opts?: CreateProgramOptions): Command;
+export declare function loadProfileOnDemand(program: Command, context: Context): void;

package/lib/core/command/module-handler.d.ts

@@ -20,6 +20,7 @@ export declare class ModuleHandler {
     discoverAndRegisterModules(rootPath: string, devMode?: boolean): void;
 }
 type CommandHandler = (context: Context, command: Command, options: OptionValues) => Promise<void>;
+export declare function shouldLoadProfile(command: Command): boolean;
 /**
  * Allows the creation of root level commands.
  */
@@ -53,6 +54,7 @@ export declare class CommandConfig {
     requiredOption(flags: string, description?: string, defaultValue?: string | boolean | string[]): CommandConfig;
     deprecationNotice(deprecationMessage: string): CommandConfig;
     beta(): CommandConfig;
+    skipProfileLoading(): this;
     action(handler: CommandHandler): void;
     private printDeprecationNoticeIfDeprecated;
     private printBetaNoticeIfBetaCommand;

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

@@ -10,6 +10,7 @@ export declare class ProfileService {
     makeDefaultProfile(profileName: string): Promise<Profile>;
     getDefaultProfile(): string;
     storeProfile(profile: Profile): Promise<void>;
+    private selectEnvProfileSource;
     private buildProfileFromEnvVariables;
     private storeConfig;
     private createProfileContainerIfNotExists;
@@ -18,6 +19,7 @@ export declare class ProfileService {
     getAllFilesInDirectory(): string[];
     authorizeProfile(profile: Profile): Promise<void>;
     refreshProfile(profile: Profile): Promise<void>;
+    private unrefreshableProfile;
     private getProfileEnvVariables;
     private getBaseTeamUrl;
     private isProfileExpired;

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

@@ -1,4 +1,7 @@
 import { Profile } from "./profile.interface";
 export declare class ProfileValidator {
     static validateProfile(profile: Profile): Promise<any>;
+    static validateEnvironmentProfile(profile: Profile): void;
+    private static validateIdentity;
+    private static validateTeamUrl;
 }

package/package.json

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