timonel 0.2.1 → 0.4.0

package/dist/lib/UmbrellaRutter.d.ts

@@ -0,0 +1,34 @@
+import type { Rutter } from './Rutter';
+import type { HelmChartMeta } from './HelmChartWriter';
+export interface SubchartSpec {
+    name: string;
+    rutter: Rutter;
+    version?: string;
+    condition?: string;
+    tags?: string[];
+    repository?: string;
+}
+export interface UmbrellaRutterProps {
+    meta: HelmChartMeta;
+    subcharts: SubchartSpec[];
+    defaultValues?: Record<string, unknown>;
+    envValues?: Record<string, Record<string, unknown>>;
+}
+/**
+ * UmbrellaRutter manages multiple Rutter instances as subcharts
+ * to create Helm umbrella charts with dependencies.
+ */
+export declare class UmbrellaRutter {
+    private readonly props;
+    constructor(props: UmbrellaRutterProps);
+    private validateMetadata;
+    /**
+     * Write the umbrella chart with all subcharts to the output directory
+     */
+    write(outDir: string): void;
+    private writeParentChart;
+    private writeParentValues;
+    private deepMerge;
+    private generateNotesTemplate;
+}
+//# sourceMappingURL=UmbrellaRutter.d.ts.map

package/dist/lib/UmbrellaRutter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UmbrellaRutter.d.ts","sourceRoot":"","sources":["../../src/lib/UmbrellaRutter.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,YAAY,EAAE,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;gBAEhC,KAAK,EAAE,mBAAmB;IAMtC,OAAO,CAAC,gBAAgB;IAcxB;;OAEG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAmC3B,OAAO,CAAC,gBAAgB;IAyBxB,OAAO,CAAC,iBAAiB;IA8BzB,OAAO,CAAC,SAAS;IAqBjB,OAAO,CAAC,qBAAqB;CAe9B"}

package/dist/lib/UmbrellaRutter.js

@@ -0,0 +1,146 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UmbrellaRutter = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const yaml_1 = __importDefault(require("yaml"));
+/**
+ * UmbrellaRutter manages multiple Rutter instances as subcharts
+ * to create Helm umbrella charts with dependencies.
+ */
+class UmbrellaRutter {
+    constructor(props) {
+        // Validate chart metadata
+        this.validateMetadata(props.meta);
+        this.props = props;
+    }
+    validateMetadata(meta) {
+        // Validate chart name follows Helm conventions
+        // eslint-disable-next-line security/detect-unsafe-regex -- Safe regex for chart name validation
+        if (!/^[a-z0-9]([-a-z0-9]*[a-z0-9])?$/.test(meta.name)) {
+            throw new Error('Chart name must contain only lowercase letters, numbers, and dashes');
+        }
+        // Validate semantic versioning
+        // eslint-disable-next-line security/detect-unsafe-regex -- Safe regex for semver validation
+        if (!/^\d+\.\d+\.\d+(-[a-zA-Z0-9.-]+)?(\+[a-zA-Z0-9.-]+)?$/.test(meta.version)) {
+            throw new Error('Chart version must follow semantic versioning (e.g., 1.0.0)');
+        }
+    }
+    /**
+     * Write the umbrella chart with all subcharts to the output directory
+     */
+    write(outDir) {
+        // Sanitize paths to prevent directory traversal
+        // eslint-disable-next-line @typescript-eslint/no-var-requires -- Dynamic import needed for path operations
+        const path = require('path');
+        const sanitizedOutDir = path.normalize(path.resolve(outDir));
+        const cwd = process.cwd();
+        if (!sanitizedOutDir.startsWith(cwd)) {
+            throw new Error('Output directory must be within current working directory');
+        }
+        // Create output directory structure
+        // eslint-disable-next-line security/detect-non-literal-fs-filename -- CLI tool needs dynamic paths
+        (0, fs_1.mkdirSync)(sanitizedOutDir, { recursive: true });
+        // eslint-disable-next-line security/detect-non-literal-fs-filename -- CLI tool needs dynamic paths
+        (0, fs_1.mkdirSync)((0, path_1.join)(sanitizedOutDir, 'charts'), { recursive: true });
+        // Write each subchart to charts/ directory
+        for (const subchart of this.props.subcharts) {
+            const subchartDir = (0, path_1.join)(sanitizedOutDir, 'charts', subchart.name);
+            subchart.rutter.write(subchartDir);
+        }
+        // Generate parent Chart.yaml with dependencies
+        this.writeParentChart(sanitizedOutDir);
+        // Generate parent values.yaml
+        this.writeParentValues(sanitizedOutDir);
+        // Generate empty templates directory (umbrella charts typically don't have templates)
+        // eslint-disable-next-line security/detect-non-literal-fs-filename -- CLI tool needs dynamic paths
+        (0, fs_1.mkdirSync)((0, path_1.join)(sanitizedOutDir, 'templates'), { recursive: true });
+        // eslint-disable-next-line security/detect-non-literal-fs-filename -- CLI tool needs dynamic paths
+        (0, fs_1.writeFileSync)((0, path_1.join)(sanitizedOutDir, 'templates', 'NOTES.txt'), this.generateNotesTemplate());
+    }
+    writeParentChart(outDir) {
+        const chartYaml = {
+            apiVersion: 'v2',
+            name: this.props.meta.name,
+            description: this.props.meta.description || `${this.props.meta.name} umbrella chart`,
+            type: 'application',
+            version: this.props.meta.version,
+            appVersion: this.props.meta.appVersion,
+            keywords: this.props.meta.keywords || [],
+            home: this.props.meta.home,
+            sources: this.props.meta.sources,
+            maintainers: this.props.meta.maintainers,
+            dependencies: this.props.subcharts.map((subchart) => ({
+                name: subchart.name,
+                version: subchart.version || '0.1.0',
+                repository: subchart.repository || `file://./charts/${subchart.name}`,
+                condition: subchart.condition,
+                tags: subchart.tags,
+            })),
+        };
+        // eslint-disable-next-line security/detect-non-literal-fs-filename -- CLI tool needs dynamic paths
+        (0, fs_1.writeFileSync)((0, path_1.join)(outDir, 'Chart.yaml'), yaml_1.default.stringify(chartYaml));
+    }
+    writeParentValues(outDir) {
+        const values = {
+            // Global values that can be shared across subcharts
+            global: {},
+            // Individual subchart values
+            ...this.props.defaultValues,
+        };
+        // Add subchart-specific value sections
+        for (const subchart of this.props.subcharts) {
+            if (!(subchart.name in values)) {
+                values[subchart.name] = {
+                    enabled: true,
+                };
+            }
+        }
+        // eslint-disable-next-line security/detect-non-literal-fs-filename -- CLI tool needs dynamic paths
+        (0, fs_1.writeFileSync)((0, path_1.join)(outDir, 'values.yaml'), yaml_1.default.stringify(values));
+        // Write environment-specific values files
+        if (this.props.envValues) {
+            for (const [env, envVals] of Object.entries(this.props.envValues)) {
+                const envValues = this.deepMerge(values, envVals);
+                // eslint-disable-next-line security/detect-non-literal-fs-filename -- CLI tool needs dynamic paths
+                (0, fs_1.writeFileSync)((0, path_1.join)(outDir, `values-${env}.yaml`), yaml_1.default.stringify(envValues));
+            }
+        }
+    }
+    deepMerge(target, source) {
+        const result = { ...target };
+        for (const [key, value] of Object.entries(source)) {
+            if (value && typeof value === 'object' && !Array.isArray(value)) {
+                // eslint-disable-next-line security/detect-object-injection -- Safe object property access in deep merge
+                result[key] = this.deepMerge(
+                // eslint-disable-next-line security/detect-object-injection -- Safe object property access in deep merge
+                result[key] || {}, value);
+            }
+            else {
+                // eslint-disable-next-line security/detect-object-injection -- Safe object property access in deep merge
+                result[key] = value;
+            }
+        }
+        return result;
+    }
+    generateNotesTemplate() {
+        return `1. Get the application URLs by running these commands:
+{{- range $subchart := .Values }}
+{{- if and (hasKey $subchart "enabled") $subchart.enabled }}
+  {{ $subchart | quote }} is enabled
+{{- end }}
+{{- end }}
+
+2. Check the status of subcharts:
+  helm list -A
+
+3. For more information about each subchart, check:
+${this.props.subcharts.map((s) => `  - charts/${s.name}/README.md`).join('\n')}
+`;
+    }
+}
+exports.UmbrellaRutter = UmbrellaRutter;
+//# sourceMappingURL=UmbrellaRutter.js.map

package/dist/lib/UmbrellaRutter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UmbrellaRutter.js","sourceRoot":"","sources":["../../src/lib/UmbrellaRutter.ts"],"names":[],"mappings":";;;;;;AAAA,2BAA8C;AAC9C,+BAA4B;AAE5B,gDAAwB;AAqBxB;;;GAGG;AACH,MAAa,cAAc;IAGzB,YAAY,KAA0B;QACpC,0BAA0B;QAC1B,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEO,gBAAgB,CAAC,IAAmB;QAC1C,+CAA+C;QAC/C,gGAAgG;QAChG,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;QACzF,CAAC;QAED,+BAA+B;QAC/B,4FAA4F;QAC5F,IAAI,CAAC,sDAAsD,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAc;QAClB,gDAAgD;QAChD,2GAA2G;QAC3G,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7B,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7D,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC/E,CAAC;QAED,oCAAoC;QACpC,mGAAmG;QACnG,IAAA,cAAS,EAAC,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAChD,mGAAmG;QACnG,IAAA,cAAS,EAAC,IAAA,WAAI,EAAC,eAAe,EAAE,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEhE,2CAA2C;QAC3C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;YAC5C,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,eAAe,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;YACnE,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACrC,CAAC;QAED,+CAA+C;QAC/C,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAEvC,8BAA8B;QAC9B,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAExC,sFAAsF;QACtF,mGAAmG;QACnG,IAAA,cAAS,EAAC,IAAA,WAAI,EAAC,eAAe,EAAE,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACnE,mGAAmG;QACnG,IAAA,kBAAa,EAAC,IAAA,WAAI,EAAC,eAAe,EAAE,WAAW,EAAE,WAAW,CAAC,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC/F,CAAC;IAEO,gBAAgB,CAAC,MAAc;QACrC,MAAM,SAAS,GAAG;YAChB,UAAU,EAAE,IAAI;YAChB,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI;YAC1B,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,iBAAiB;YACpF,IAAI,EAAE,aAAa;YACnB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO;YAChC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU;YACtC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE;YACxC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI;YAC1B,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO;YAChC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW;YACxC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;gBACpD,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,OAAO,EAAE,QAAQ,CAAC,OAAO,IAAI,OAAO;gBACpC,UAAU,EAAE,QAAQ,CAAC,UAAU,IAAI,mBAAmB,QAAQ,CAAC,IAAI,EAAE;gBACrE,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,IAAI,EAAE,QAAQ,CAAC,IAAI;aACpB,CAAC,CAAC;SACJ,CAAC;QAEF,mGAAmG;QACnG,IAAA,kBAAa,EAAC,IAAA,WAAI,EAAC,MAAM,EAAE,YAAY,CAAC,EAAE,cAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IACvE,CAAC;IAEO,iBAAiB,CAAC,MAAc;QACtC,MAAM,MAAM,GAA4B;YACtC,oDAAoD;YACpD,MAAM,EAAE,EAAE;YACV,6BAA6B;YAC7B,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa;SAC5B,CAAC;QAEF,uCAAuC;QACvC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;YAC5C,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,CAAC;gBAC/B,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG;oBACtB,OAAO,EAAE,IAAI;iBACd,CAAC;YACJ,CAAC;QACH,CAAC;QAED,mGAAmG;QACnG,IAAA,kBAAa,EAAC,IAAA,WAAI,EAAC,MAAM,EAAE,aAAa,CAAC,EAAE,cAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAEnE,0CAA0C;QAC1C,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;YACzB,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBAClE,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAClD,mGAAmG;gBACnG,IAAA,kBAAa,EAAC,IAAA,WAAI,EAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,EAAE,cAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;IACH,CAAC;IAEO,SAAS,CACf,MAA+B,EAC/B,MAA+B;QAE/B,MAAM,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;QAC7B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChE,yGAAyG;gBACzG,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS;gBAC1B,yGAAyG;gBACxG,MAAM,CAAC,GAAG,CAA6B,IAAI,EAAE,EAC9C,KAAgC,CACjC,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,yGAAyG;gBACzG,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACtB,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,qBAAqB;QAC3B,OAAO;;;;;;;;;;;EAWT,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;CAC7E,CAAC;IACA,CAAC;CACF;AAxJD,wCAwJC"}

package/dist/lib/umbrella.d.ts

@@ -0,0 +1,7 @@
+import type { UmbrellaRutter, UmbrellaRutterProps } from './UmbrellaRutter';
+/**
+ * Create an umbrella chart from multiple Rutter instances
+ */
+export declare function createUmbrella(props: UmbrellaRutterProps): UmbrellaRutter;
+export type { UmbrellaRutterProps, SubchartSpec } from './UmbrellaRutter';
+//# sourceMappingURL=umbrella.d.ts.map

package/dist/lib/umbrella.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"umbrella.d.ts","sourceRoot":"","sources":["../../src/lib/umbrella.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAG5E;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,cAAc,CAEzE;AAGD,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/lib/umbrella.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createUmbrella = createUmbrella;
+const UmbrellaRutter_1 = require("./UmbrellaRutter");
+/**
+ * Create an umbrella chart from multiple Rutter instances
+ */
+function createUmbrella(props) {
+    return new UmbrellaRutter_1.UmbrellaRutter(props);
+}
+//# sourceMappingURL=umbrella.js.map

package/dist/lib/umbrella.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"umbrella.js","sourceRoot":"","sources":["../../src/lib/umbrella.ts"],"names":[],"mappings":";;AAMA,wCAEC;AAPD,qDAAyE;AAEzE;;GAEG;AACH,SAAgB,cAAc,CAAC,KAA0B;IACvD,OAAO,IAAI,+BAAmB,CAAC,KAAK,CAAC,CAAC;AACxC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "timonel",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "Timonel: programmatic Helm chart generator using cdk8s (TypeScript)",
   "bin": {
     "timonel": "dist/cli.js",
@@ -77,7 +77,6 @@
   },
   "dependencies": {
     "cdk8s": "^2.70.11",
-    "cdk8s-plus-28": "^2.5.6",
     "ts-node": "^10.9.2",
     "yaml": "^2.8.1"
   },