@celonis/content-cli 1.9.1 → 1.11.0

package/core/utils/file.constants.js

@@ -0,0 +1,18 @@
+(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 });
+    exports.FileConstants = void 0;
+    var FileConstants;
+    (function (FileConstants) {
+        FileConstants[FileConstants["DEFAULT_FILE_PERMISSIONS"] = 384] = "DEFAULT_FILE_PERMISSIONS";
+        FileConstants[FileConstants["DEFAULT_FOLDER_PERMISSIONS"] = 448] = "DEFAULT_FOLDER_PERMISSIONS";
+    })(FileConstants || (exports.FileConstants = FileConstants = {}));
+});

package/core/utils/logger.js

@@ -4,7 +4,7 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "winston", "winston-transport", "os", "path", "fs"], factory);
+        define(["require", "exports", "winston", "winston-transport", "os", "path", "fs", "./file.constants"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -15,6 +15,7 @@
     const os = require("os");
     const path = require("path");
     const fs = require("fs");
+    const file_constants_1 = require("./file.constants");
     class CustomTransport extends Transport {
         constructor(opts) {
             super(opts);
@@ -43,7 +44,7 @@
     // --- Ensure log directory exists ---
     try {
         if (!fs.existsSync(logDir)) {
-            fs.mkdirSync(logDir, { recursive: true });
+            fs.mkdirSync(logDir, { recursive: true, mode: file_constants_1.FileConstants.DEFAULT_FOLDER_PERMISSIONS });
         }
     }
     catch (error) {

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

@@ -1,11 +1,12 @@
 import { Context } from "../../core/command/cli-context";
-import { AssetRegistryDescriptor, AssetRegistryMetadata } from "./asset-registry.interfaces";
+import { AgentSkillsResponse, AssetRegistryDescriptor, AssetRegistryMetadata } from "./asset-registry.interfaces";
 export declare class AssetRegistryApi {
     private httpClient;
     constructor(context: Context);
     listTypes(): Promise<AssetRegistryMetadata>;
+    listSkills(): Promise<AgentSkillsResponse>;
     getType(assetType: string): Promise<AssetRegistryDescriptor>;
     getSchema(assetType: string): Promise<any>;
     getExamples(assetType: string): Promise<any>;
-    getMethodology(assetType: string): Promise<any>;
+    validate(assetType: string, body: any): Promise<any>;
 }

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

@@ -0,0 +1,3 @@
+export declare const ASSET_REGISTRY_DISABLED_ERROR = "Asset registry feature is currently disabled";
+export declare const ASSET_REGISTRY_DISABLED_USER_MESSAGE = "Asset registry is not enabled for this team. Contact your administrator to enable the feature.";
+export declare function handleAssetRegistryApiError(operation: string, error: unknown): never;

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

@@ -20,11 +20,31 @@ export interface AssetService {
 export interface AssetEndpoints {
     schema: string;
     validate: string;
-    methodology?: string;
     examples?: string;
+    skills?: string;
 }
 export interface AssetContributions {
     pigEntityTypes: string[];
     dataPipelineEntityTypes: string[];
     actionTypes: string[];
 }
+export interface ValidateOptions {
+    assetType: string;
+    packageKey?: string;
+    nodeKey?: string;
+    configuration?: string;
+    file?: string;
+    json: boolean;
+}
+export interface AgentSkillMetadata {
+    version: string;
+}
+export interface AgentSkill {
+    name: string;
+    description: string;
+    path: string;
+    metadata: AgentSkillMetadata;
+}
+export interface AgentSkillsResponse {
+    skills: AgentSkill[];
+}

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

@@ -1,13 +1,19 @@
+import { ValidateOptions } from "./asset-registry.interfaces";
 import { Context } from "../../core/command/cli-context";
 export declare class AssetRegistryService {
     private api;
     constructor(context: Context);
     listTypes(jsonResponse: boolean): Promise<void>;
+    listSkills(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>;
+    validate(opts: ValidateOptions): Promise<void>;
+    private static readonly INLINE_VALIDATION_NODE_KEY;
+    private buildValidatePayload;
+    private parseJson;
     private outputResponse;
     private logDescriptorSummary;
+    private logSkillSummary;
     private logDescriptorDetail;
 }

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

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

package/lib/commands/configuration-management/api/batch-import-export-api.d.ts

@@ -5,8 +5,9 @@ import { Context } from "../../../core/command/cli-context";
 export declare class BatchImportExportApi {
     private httpClient;
     constructor(context: Context);
-    findAllActivePackages(flavors: string[], withDependencies?: boolean): Promise<PackageExportTransport[]>;
-    findActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string): Promise<PackageExportTransport[]>;
+    findAllActivePackages(flavors: string[], withDependencies?: boolean, includeBranches?: boolean): Promise<PackageExportTransport[]>;
+    findAllStagingPackages(flavors: string[], includeBranches?: boolean): Promise<PackageExportTransport[]>;
+    findActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string, includeBranches?: boolean): Promise<PackageExportTransport[]>;
     findActivePackagesByKeys(packageKeys: string[], withDependencies?: boolean): Promise<PackageExportTransport[]>;
     findPackagesByKeysAndVersion(packageKeysWithVersion: string[], withDependencies?: boolean): Promise<PackageExportTransport[]>;
     exportPackages(packageKeys: string[], withDependencies: boolean): Promise<Buffer>;

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

@@ -1,9 +1,12 @@
 import { Context } from "../../../core/command/cli-context";
-import { NodeTransport } from "../interfaces/node.interfaces";
+import { NodeTransport, SaveNodeTransport, UpdateNodeTransport } from "../interfaces/node.interfaces";
 export declare class NodeApi {
     private httpClient;
     constructor(context: Context);
     findStagingNodeByKey(packageKey: string, nodeKey: string, withConfiguration: boolean): Promise<NodeTransport>;
     findVersionedNodeByKey(packageKey: string, nodeKey: string, version: string, withConfiguration: boolean): Promise<NodeTransport>;
+    createStagingNode(packageKey: string, transport: SaveNodeTransport, validateOnly: boolean): Promise<NodeTransport | void>;
+    updateStagingNode(packageKey: string, nodeKey: string, transport: UpdateNodeTransport, validateOnly: boolean): Promise<NodeTransport | void>;
+    archiveStagingNode(packageKey: string, nodeKey: string, force: boolean): Promise<void>;
     findVersionedNodesByPackage(packageKey: string, version: string, withConfiguration: boolean, limit: number, offset: number): Promise<NodeTransport[]>;
 }

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

@@ -1,7 +1,8 @@
 import { Context } from "../../../core/command/cli-context";
-import { GetNodeDiffRequest, NodeConfigurationDiffTransport } from "../interfaces/node-diff.interfaces";
+import { GetNodeDiffRequest, GetNodeDiffWithFileRequest, NodeConfigurationDiffTransport } from "../interfaces/node-diff.interfaces";
 export declare class NodeDiffApi {
     private httpClient;
     constructor(context: Context);
     diff(request: GetNodeDiffRequest): Promise<NodeConfigurationDiffTransport>;
+    diffWithFile(request: GetNodeDiffWithFileRequest): Promise<NodeConfigurationDiffTransport>;
 }

package/lib/commands/configuration-management/batch-import-export.service.d.ts

@@ -5,14 +5,15 @@ export declare class BatchImportExportService {
     private studioService;
     private gitService;
     constructor(context: Context);
-    listActivePackages(flavors: string[]): Promise<void>;
-    findAndExportListOfPackages(flavors: string[], packageKeys: string[], keysByVersion: string[], withDependencies: boolean): Promise<void>;
+    listActivePackages(flavors: string[], includeBranches: boolean): Promise<void>;
+    listStagingPackages(flavors: string[], includeBranches: boolean, jsonResponse: boolean): Promise<void>;
+    findAndExportListOfPackages(flavors: string[], packageKeys: string[], keysByVersion: string[], withDependencies: boolean, includeBranches: boolean): Promise<void>;
     listPackagesByKeysWithVersion(keysByVersion: string[], withDependencies: boolean): Promise<void>;
     batchExportPackages(packageKeys: string[], packageKeysByVersion: string[], withDependencies: boolean, gitBranch: string, unzip: boolean): Promise<void>;
     batchExportPackagesMetadata(packageKeys: string[], jsonResponse: boolean): Promise<void>;
     batchImportPackages(sourcePath: string, overwrite: boolean, gitBranch: string, performValidation?: boolean): Promise<void>;
-    findAndExportListOfActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string): Promise<void>;
-    listActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string): Promise<void>;
+    findAndExportListOfActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string, includeBranches: boolean): Promise<void>;
+    listActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string, includeBranches: boolean): Promise<void>;
     private exportListOfPackages;
     private getVersionsByPackageKey;
     private getVersionedVariablesForPackagesWithKeys;

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

@@ -4,7 +4,7 @@ export declare class ConfigCommandService {
     private variableService;
     private diffService;
     constructor(context: Context);
-    listPackages(jsonResponse: boolean, flavors: string[], withDependencies: boolean, packageKeys: string[], keysByVersion: string[], variableValue: string, variableType: string): Promise<void>;
+    listPackages(jsonResponse: boolean, flavors: string[], withDependencies: boolean, packageKeys: string[], keysByVersion: string[], variableValue: string, variableType: string, includeBranches: boolean, staging: boolean): Promise<void>;
     listVariables(jsonResponse: boolean, keysByVersion: string[], keysByVersionFile: string, packageKeys: string[]): Promise<void>;
     batchExportPackages(packageKeys: string[], packageKeysByVersion: string[], withDependencies: boolean, gitBranch: string, unzip: boolean): Promise<void>;
     batchExportPackagesMetadata(packageKeys: string[], jsonResponse: boolean): Promise<void>;

package/lib/commands/configuration-management/interfaces/node-diff.interfaces.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import { ReadStream } from "node:fs";
 import { ConfigurationChangeTransport, NodeConfigurationChangeType } from "./diff-package.interfaces";
 export interface GetNodeDiffRequest {
     packageKey: string;
@@ -5,6 +7,12 @@ export interface GetNodeDiffRequest {
     baseVersion: string;
     compareVersion: string;
 }
+export interface GetNodeDiffWithFileRequest {
+    packageKey: string;
+    nodeKey: string;
+    baseVersion: string;
+    file: ReadStream;
+}
 export interface NodeConfigurationDiffTransport {
     packageKey: string;
     nodeKey: string;

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

@@ -19,3 +19,23 @@ export interface NodeTransport {
     schemaVersion: number;
     flavor?: string;
 }
+export interface SaveNodeTransport {
+    key: string;
+    name: string;
+    parentNodeKey: string;
+    type: string;
+    configuration?: NodeConfiguration;
+    invalidConfiguration?: string;
+    invalidContent?: boolean;
+    schemaVersion?: number;
+    [key: string]: any;
+}
+export interface UpdateNodeTransport {
+    name: string;
+    parentNodeKey: string;
+    configuration?: NodeConfiguration;
+    invalidConfiguration?: string;
+    invalidContent?: boolean;
+    schemaVersion?: number;
+    [key: string]: any;
+}

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

@@ -16,6 +16,9 @@ declare class Module extends IModule {
     private listVariables;
     private listAssignments;
     private findNode;
+    private createNode;
+    private updateNode;
+    private archiveNode;
     private listNodes;
     private diffNode;
     private listNodeDependencies;

package/lib/commands/configuration-management/node-diff.service.d.ts

@@ -3,4 +3,7 @@ export declare class NodeDiffService {
     private nodeDiffApi;
     constructor(context: Context);
     diff(packageKey: string, nodeKey: string, baseVersion: string, compareVersion: string, jsonResponse: boolean): Promise<void>;
+    diffWithFile(packageKey: string, nodeKey: string, baseVersion: string, file: string, jsonResponse: boolean): Promise<void>;
+    private exportDiffAsJson;
+    private logDiff;
 }

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

@@ -4,5 +4,9 @@ export declare class NodeService {
     constructor(context: Context);
     findNode(packageKey: string, nodeKey: string, withConfiguration: boolean, packageVersion: string | null, jsonResponse: boolean): Promise<void>;
     listNodes(packageKey: string, packageVersion: string, limit: number, offset: number, withConfiguration: boolean, jsonResponse: boolean): Promise<void>;
+    createNode(packageKey: string, body: string | undefined, file: string | undefined, validateOnly: boolean, jsonResponse: boolean): Promise<void>;
+    updateNode(packageKey: string, nodeKey: string, body: string | undefined, file: string | undefined, validateOnly: boolean, jsonResponse: boolean): Promise<void>;
+    archiveNode(packageKey: string, nodeKey: string, force: boolean): Promise<void>;
+    private static resolveBody;
     private printNode;
 }

package/lib/core/utils/branches.d.ts

@@ -0,0 +1,4 @@
+export declare class BranchUtils {
+    private static readonly BRANCH_SEPARATOR;
+    static isBranchPackageKey(packageKey: string): boolean;
+}

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

@@ -9,5 +9,6 @@ export declare class FileService {
     isDirectory(sourcePath: string): boolean;
     zipDirectoryInBatchExportFormat(sourceDir: string): string;
     private getSerializedFileContent;
+    private restrictFilePermissions;
 }
 export declare const fileService: FileService;

package/lib/core/utils/file.constants.d.ts

@@ -0,0 +1,4 @@
+export declare enum FileConstants {
+    DEFAULT_FILE_PERMISSIONS = 384,
+    DEFAULT_FOLDER_PERMISSIONS = 448
+}

package/package.json

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