@celonis/content-cli 1.16.0 → 1.17.0

package/commands/sdk/module.js

@@ -0,0 +1,54 @@
+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", "./sdk.service"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    const module_handler_1 = require("../../core/command/module-handler");
+    const sdk_service_1 = require("./sdk.service");
+    class Module extends module_handler_1.IModule {
+        register(context, configurator) {
+            const sdkCommand = configurator
+                .command("sdk")
+                .beta()
+                .description("Implement custom apps for Codespace assets using the Celonis SDK");
+            sdkCommand
+                .command("download")
+                .beta()
+                .description("Download the latest Celonis SDK generated for a Codespace asset")
+                .requiredOption("--appId <appId>", "Identifier of the app to download the SDK for")
+                .action(this.downloadSdk);
+            sdkCommand
+                .command("publish")
+                .beta()
+                .description("Publish a build of a custom app as a new version of its Codespace asset")
+                .requiredOption("--appId <appId>", "Identifier of the app to publish the build for")
+                .requiredOption("--dist <dist>", "Directory containing the build of the app")
+                .action(this.publishApp);
+        }
+        downloadSdk(context, command, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                yield new sdk_service_1.SdkService(context).downloadSdk(options.appId);
+            });
+        }
+        publishApp(context, command, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                yield new sdk_service_1.SdkService(context).publishApp(options.appId, options.dist);
+            });
+        }
+    }
+    return Module;
+});

package/commands/sdk/sdk-api.js

@@ -0,0 +1,48 @@
+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.SdkApi = void 0;
+    const logger_1 = require("../../core/utils/logger");
+    class SdkApi {
+        constructor(context) {
+            this.httpClient = () => context.httpClient;
+        }
+        downloadSdk(appId) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .getFile(`/pro-code-app-manager/api/npm/@celonis-sdk/${appId}/-/${appId}-latest.tgz`)
+                    .catch((e) => {
+                    const problem = `Problem downloading SDK for app ${appId}`;
+                    throw new logger_1.FatalError(e ? `${problem}: ${e}` : problem);
+                });
+            });
+        }
+        publishApp(appId, bundle) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .postBinary(`/pro-code-app-manager/api/codespace/apps/${appId}/publish`, bundle, "application/zip")
+                    .catch((e) => {
+                    throw new logger_1.FatalError(`Problem publishing app ${appId}: ${e}`);
+                });
+            });
+        }
+    }
+    exports.SdkApi = SdkApi;
+});

package/commands/sdk/sdk.service.js

@@ -0,0 +1,64 @@
+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", "node:fs", "node:path", "adm-zip", "./sdk-api", "../../core/utils/logger"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.SdkService = void 0;
+    const fs = require("node:fs");
+    const path = require("node:path");
+    const AdmZip = require("adm-zip");
+    const sdk_api_1 = require("./sdk-api");
+    const logger_1 = require("../../core/utils/logger");
+    class SdkService {
+        constructor(context) {
+            this.sdkApi = new sdk_api_1.SdkApi(context);
+        }
+        downloadSdk(appId) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const sdk = yield this.sdkApi.downloadSdk(appId);
+                const sdkDirectory = path.resolve(process.cwd(), SdkService.SDK_DIRECTORY);
+                fs.rmSync(sdkDirectory, { recursive: true, force: true });
+                fs.mkdirSync(sdkDirectory, { recursive: true });
+                const sdkFile = path.join(SdkService.SDK_DIRECTORY, `${appId}.tgz`);
+                fs.writeFileSync(path.resolve(process.cwd(), sdkFile), sdk);
+                logger_1.logger.info(`SDK downloaded successfully: ${sdkFile}`);
+            });
+        }
+        publishApp(appId, dist) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const distDirectory = path.resolve(process.cwd(), dist);
+                this.requireDirectory(distDirectory);
+                const bundle = this.compressDirectory(distDirectory);
+                const { version } = yield this.sdkApi.publishApp(appId, bundle);
+                logger_1.logger.info(`App published successfully as version '${version}'`);
+            });
+        }
+        requireDirectory(directory) {
+            if (!fs.existsSync(directory) || !fs.statSync(directory).isDirectory()) {
+                throw new logger_1.FatalError(`The dist directory ${directory} does not exist or is no directory`);
+            }
+        }
+        compressDirectory(directory) {
+            const zip = new AdmZip();
+            zip.addLocalFolder(directory);
+            return zip.toBuffer();
+        }
+    }
+    exports.SdkService = SdkService;
+    SdkService.SDK_DIRECTORY = ".celonis-sdk";
+});

package/core/http/http-client.js

@@ -133,6 +133,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 });
             });
         }
+        postBinary(url, body, contentType) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return new Promise((resolve, reject) => {
+                    this.axios.post(this.resolveUrl(url), body, {
+                        headers: this.buildHeaders(contentType)
+                    }).then(response => {
+                        this.handleResponse(response, resolve, reject);
+                    }).catch(err => {
+                        this.handleError(err, resolve, reject);
+                    });
+                }).catch(e => {
+                    throw new logger_1.FatalError(e);
+                });
+            });
+        }
         put(url, body) {
             return __awaiter(this, void 0, void 0, function* () {
                 return new Promise((resolve, reject) => {

package/core/profile/profile.service.js

@@ -36,6 +36,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     const OAUTH_SCOPES = ["studio", "package-manager", "integration.data-pools", "action-engine.projects"];
     /** Device code fallback: try without action-engine.projects if all 4 scopes fail. */
     const DEVICE_CODE_SCOPES_WITHOUT_ACTION_ENGINE = ["studio", "package-manager", "integration.data-pools"];
+    /** First attempt for both auth flows: all scopes plus the pro-code-app-manager scopes, which are not yet available on every environment. */
+    const OAUTH_SCOPES_WITH_PRO_CODE = [...OAUTH_SCOPES, "pro-code-app-manager.sdk:read", "pro-code-app-manager.publish"];
     class ProfileService {
         constructor() {
             this.profileContainerPath = path.resolve(homedir, ".celonis-content-cli-profiles");
@@ -216,13 +218,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                             }
                         }
                         break;
-                    case profile_interface_1.ProfileType.DEVICE_CODE:
+                    case profile_interface_1.ProfileType.DEVICE_CODE: {
                         const deviceCodeIssuer = yield openid_client_1.Issuer.discover(profile.team);
                         const deviceCodeOAuthClient = new deviceCodeIssuer.Client({
                             client_id: "content-cli",
                             token_endpoint_auth_method: "none",
                         });
-                        const deviceCodeScopeAttempts = [OAUTH_SCOPES, DEVICE_CODE_SCOPES_WITHOUT_ACTION_ENGINE];
+                        const deviceCodeScopeAttempts = [
+                            OAUTH_SCOPES_WITH_PRO_CODE,
+                            OAUTH_SCOPES,
+                            DEVICE_CODE_SCOPES_WITHOUT_ACTION_ENGINE,
+                        ];
                         let deviceCodeSuccess = false;
                         for (const scopeList of deviceCodeScopeAttempts) {
                             try {
@@ -245,6 +251,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                             throw new logger_1.FatalError("Device code authorization failed. The provided team or requested scopes may be invalid.");
                         }
                         break;
+                    }
                     case profile_interface_1.ProfileType.CLIENT_CREDENTIALS:
                         const clientCredentialsIssuer = yield openid_client_1.Issuer.discover(profile.team);
                         const basicResult = yield this.tryClientCredentialsGrant(clientCredentialsIssuer, profile, profile_interface_1.ClientAuthenticationMethod.CLIENT_SECRET_BASIC);
@@ -411,7 +418,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                     client_secret: profile.clientSecret,
                     token_endpoint_auth_method: tokenEndpointAuthMethod,
                 });
-                const scopeAttempts = this.getScopeCombinationsOrderedBySize(OAUTH_SCOPES);
+                const scopeAttempts = [OAUTH_SCOPES_WITH_PRO_CODE, ...this.getScopeCombinationsOrderedBySize(OAUTH_SCOPES)];
                 for (const scopeList of scopeAttempts) {
                     try {
                         const tokenSet = yield client.grant({

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

@@ -0,0 +1,8 @@
+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 downloadSdk;
+    private publishApp;
+}
+export = Module;

package/lib/commands/sdk/sdk-api.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import { Context } from "../../core/command/cli-context";
+export interface SdkPublishResponse {
+    version: string;
+}
+export declare class SdkApi {
+    private readonly httpClient;
+    constructor(context: Context);
+    downloadSdk(appId: string): Promise<Buffer>;
+    publishApp(appId: string, bundle: Buffer): Promise<SdkPublishResponse>;
+}

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

@@ -0,0 +1,10 @@
+import { Context } from "../../core/command/cli-context";
+export declare class SdkService {
+    static readonly SDK_DIRECTORY = ".celonis-sdk";
+    private readonly sdkApi;
+    constructor(context: Context);
+    downloadSdk(appId: string): Promise<void>;
+    publishApp(appId: string, dist: string): Promise<void>;
+    private requireDirectory;
+    private compressDirectory;
+}

package/lib/core/http/http-client.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import * as FormData from "form-data";
 import { Context } from "../command/cli-context";
 /**
@@ -16,6 +17,7 @@ export declare class HttpClient {
     getFile(url: string): Promise<any>;
     postFile(url: string, formData: FormData, parameters?: {}): Promise<any>;
     post(url: string, body: any): Promise<any>;
+    postBinary(url: string, body: Buffer, contentType: string): Promise<any>;
     put(url: string, body: object): Promise<any>;
     delete(url: string): Promise<any>;
     downloadFile(url: string): Promise<any>;

package/package.json

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