timonel 2.8.1 → 2.8.3

package/dist/lib/helmChartWriter.d.ts

@@ -1,44 +1,19 @@
-/**
- * @fileoverview Helm chart writer for generating complete Helm chart structures
- * @since 1.0.0
- */
-/**
- * Metadata for a Helm chart
- *
- * Contains all the information needed for Chart.yaml file generation
- * following Helm chart specification.
- *
- * @interface HelmChartMeta
- * @since 1.0.0
- */
 export interface HelmChartMeta {
-    /** Chart name */
     name: string;
-    /** SemVer chart version */
     version: string;
-    /** Chart description */
     description?: string;
-    /** Underlying application version */
     appVersion?: string;
-    /** Chart type */
     type?: 'application' | 'library';
-    /** Kubernetes version constraint */
     kubeVersion?: string;
-    /** Chart keywords for searchability */
     keywords?: string[];
-    /** Chart home page URL */
     home?: string;
-    /** Source code URLs */
     sources?: string[];
-    /** Chart maintainers */
     maintainers?: {
         name: string;
         email?: string;
         url?: string;
     }[];
-    /** Chart icon URL */
     icon?: string;
-    /** Chart dependencies */
     dependencies?: Array<{
         name: string;
         version: string;
@@ -49,190 +24,37 @@ export interface HelmChartMeta {
         importValues?: unknown;
     }>;
 }
-/**
- * Environment-specific values mapping
- *
- * @interface EnvValuesMap
- * @since 1.0.0
- */
 export interface EnvValuesMap {
     [env: string]: Record<string, unknown>;
 }
-/**
- * Synthesized Kubernetes asset for Helm chart
- *
- * Represents a Kubernetes manifest that will be written to the chart's
- * templates or crds directory.
- *
- * @interface SynthAsset
- * @since 1.0.0
- */
 export interface SynthAsset {
-    /** Filename or logical identifier */
     id: string;
-    /** YAML content, may contain multiple documents separated by --- */
     yaml: string;
-    /** Target directory inside chart */
     target?: 'templates' | 'crds';
-    /** If true, don't split into multiple files even with multiple docs */
     singleFile?: boolean;
 }
-/**
- * Options for writing a complete Helm chart
- *
- * @interface HelmChartWriteOptions
- * @since 1.0.0
- */
 export interface HelmChartWriteOptions {
-    /** Output directory path (e.g., dist/charts/my-chart) */
     outDir: string;
-    /** Chart metadata */
     meta: HelmChartMeta;
-    /** Default values for values.yaml */
     defaultValues?: Record<string, unknown> | undefined;
-    /** Environment-specific values (e.g., { dev: {...}, prod: {...} }) */
     envValues?: EnvValuesMap | undefined;
-    /** Kubernetes manifests to place under templates/ */
     assets: SynthAsset[];
-    /** Helm helpers content for templates/_helpers.tpl */
     helpersTpl?: string | HelperDefinition[];
-    /** NOTES.txt content under templates/ */
     notesTpl?: string;
-    /** JSON schema for values validation */
     valuesSchema?: Record<string, unknown>;
 }
-/**
- * Helm template helper definition
- *
- * @interface HelperDefinition
- * @since 1.0.0
- */
 export interface HelperDefinition {
-    /** Template name */
     name: string;
-    /** Template body content */
     body: string;
 }
-/**
- * Helm chart writer for generating complete chart structures
- *
- * This class provides static methods to generate a complete Helm chart
- * including Chart.yaml, values.yaml, templates, and auxiliary files.
- *
- * @class HelmChartWriter
- * @since 1.0.0
- *
- * @example
- * ```typescript
- * HelmChartWriter.write({
- *   outDir: './dist/my-chart',
- *   meta: { name: 'my-app', version: '1.0.0' },
- *   assets: []
- * });
- * ```
- */
 export declare class HelmChartWriter {
-    /**
-     * Writes a complete Helm chart to the specified directory
-     *
-     * Creates the full directory structure and writes all necessary files
-     * for a valid Helm chart including Chart.yaml, values files, templates,
-     * and auxiliary files.
-     *
-     * @param {HelmChartWriteOptions} opts - Chart configuration options
-     * @throws {Error} If output directory path is invalid
-     * @throws {Error} If chart metadata is invalid
-     *
-     * @example
-     * ```typescript
-     * HelmChartWriter.write({
-     *   outDir: './charts/my-app',
-     *   meta: {
-     *     name: 'my-app',
-     *     version: '1.0.0',
-     *     description: 'My application'
-     *   },
-     *   defaultValues: { replicas: 3 },
-     *   assets: []
-     * });
-     * ```
-     *
-     * @since 1.0.0
-     */
     static write(opts: HelmChartWriteOptions): void;
-    /**
-     * Creates the necessary directory structure for the chart
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @throws {Error} If directories cannot be created
-     * @since 1.0.0
-     */
     private static createDirectories;
-    /**
-     * Writes the Chart.yaml file with chart metadata
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @param {HelmChartMeta} meta - Chart metadata
-     * @throws {Error} If Chart.yaml cannot be written
-     * @since 1.0.0
-     */
     private static writeChartYaml;
-    /**
-     * Writes values.yaml and environment-specific values files
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @param {Record<string, unknown>} defaultValues - Default values
-     * @param {EnvValuesMap} envValues - Environment-specific values
-     * @throws {Error} If values files cannot be written
-     * @since 1.0.0
-     */
     private static writeValuesFiles;
-    /**
-     * Writes Kubernetes manifest assets to templates directory
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @param {SynthAsset[]} assets - Kubernetes manifests to write
-     * @since 1.0.0
-     */
     private static writeAssets;
-    /**
-     * Writes Helm template helpers to _helpers.tpl file
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @param {string | HelperDefinition[]} [helpersTpl] - Helpers content
-     * @since 1.0.0
-     */
     private static writeHelpers;
-    /**
-     * Writes NOTES.txt file for post-install instructions
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @param {string} [notesTpl] - Notes content
-     * @since 1.0.0
-     */
     private static writeNotes;
-    /**
-     * Writes values.schema.json for values validation
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @param {Record<string, unknown>} [valuesSchema] - JSON schema
-     * @since 1.0.0
-     */
     private static writeSchema;
-    /**
-     * Writes .helmignore file with common ignore patterns
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @since 1.0.0
-     */
     private static writeHelmIgnore;
 }
-//# sourceMappingURL=helmChartWriter.d.ts.map

package/dist/lib/helmChartWriter.js

@@ -1,64 +1,12 @@
-/**
- * @fileoverview Helm chart writer for generating complete Helm chart structures
- * @since 1.0.0
- */
 import * as fs from 'fs';
 import * as path from 'path';
 import YAML from 'yaml';
 import { SecurityUtils } from './security.js';
-/**
- * Helm chart writer for generating complete chart structures
- *
- * This class provides static methods to generate a complete Helm chart
- * including Chart.yaml, values.yaml, templates, and auxiliary files.
- *
- * @class HelmChartWriter
- * @since 1.0.0
- *
- * @example
- * ```typescript
- * HelmChartWriter.write({
- *   outDir: './dist/my-chart',
- *   meta: { name: 'my-app', version: '1.0.0' },
- *   assets: []
- * });
- * ```
- */
 export class HelmChartWriter {
-    /**
-     * Writes a complete Helm chart to the specified directory
-     *
-     * Creates the full directory structure and writes all necessary files
-     * for a valid Helm chart including Chart.yaml, values files, templates,
-     * and auxiliary files.
-     *
-     * @param {HelmChartWriteOptions} opts - Chart configuration options
-     * @throws {Error} If output directory path is invalid
-     * @throws {Error} If chart metadata is invalid
-     *
-     * @example
-     * ```typescript
-     * HelmChartWriter.write({
-     *   outDir: './charts/my-app',
-     *   meta: {
-     *     name: 'my-app',
-     *     version: '1.0.0',
-     *     description: 'My application'
-     *   },
-     *   defaultValues: { replicas: 3 },
-     *   assets: []
-     * });
-     * ```
-     *
-     * @since 1.0.0
-     */
     static write(opts) {
         const { outDir, meta, defaultValues = {}, envValues = {}, assets, helpersTpl, notesTpl, valuesSchema, } = opts;
-        // Validate output directory path
         const validatedOutDir = SecurityUtils.validatePath(outDir, process.cwd());
-        // Create directory structure
         this.createDirectories(validatedOutDir);
-        // Write chart files
         this.writeChartYaml(validatedOutDir, meta);
         this.writeValuesFiles(validatedOutDir, defaultValues, envValues);
         this.writeAssets(validatedOutDir, assets);
@@ -67,28 +15,9 @@ export class HelmChartWriter {
         this.writeSchema(validatedOutDir, valuesSchema);
         this.writeHelmIgnore(validatedOutDir);
     }
-    /**
-     * Creates the necessary directory structure for the chart
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @throws {Error} If directories cannot be created
-     * @since 1.0.0
-     */
     static createDirectories(outDir) {
-        // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
         fs.mkdirSync(path.join(outDir, 'templates'), { recursive: true });
-        // Create crds directory only if needed later
     }
-    /**
-     * Writes the Chart.yaml file with chart metadata
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @param {HelmChartMeta} meta - Chart metadata
-     * @throws {Error} If Chart.yaml cannot be written
-     * @since 1.0.0
-     */
     static writeChartYaml(outDir, meta) {
         const chartYaml = YAML.stringify({
             apiVersion: 'v2',
@@ -105,48 +34,18 @@ export class HelmChartWriter {
             icon: meta.icon,
             dependencies: meta.dependencies,
         });
-        // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
         fs.writeFileSync(path.join(outDir, 'Chart.yaml'), chartYaml);
     }
-    /**
-     * Writes values.yaml and environment-specific values files
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @param {Record<string, unknown>} defaultValues - Default values
-     * @param {EnvValuesMap} envValues - Environment-specific values
-     * @throws {Error} If values files cannot be written
-     * @since 1.0.0
-     */
     static writeValuesFiles(outDir, defaultValues, envValues) {
-        // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
         fs.writeFileSync(path.join(outDir, 'values.yaml'), YAML.stringify(defaultValues));
         for (const [env, values] of Object.entries(envValues)) {
-            // Use centralized environment name sanitization
             const sanitizedEnv = SecurityUtils.sanitizeEnvironmentName(env);
-            // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
             fs.writeFileSync(path.join(outDir, `values-${sanitizedEnv}.yaml`), YAML.stringify(values));
         }
     }
-    /**
-     * Writes Kubernetes manifest assets to templates directory
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @param {SynthAsset[]} assets - Kubernetes manifests to write
-     * @since 1.0.0
-     */
     static writeAssets(outDir, assets) {
         writeAssets(outDir, assets);
     }
-    /**
-     * Writes Helm template helpers to _helpers.tpl file
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @param {string | HelperDefinition[]} [helpersTpl] - Helpers content
-     * @since 1.0.0
-     */
     static writeHelpers(outDir, helpersTpl) {
         if (!helpersTpl)
             return;
@@ -159,47 +58,20 @@ export class HelmChartWriter {
                 .map((h) => [`{{- define "${h.name}" -}}`, h.body.trimEnd(), '{{- end }}', ''].join('\n'))
                 .join('\n');
         }
-        // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
         fs.writeFileSync(path.join(outDir, 'templates', '_helpers.tpl'), content);
     }
-    /**
-     * Writes NOTES.txt file for post-install instructions
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @param {string} [notesTpl] - Notes content
-     * @since 1.0.0
-     */
     static writeNotes(outDir, notesTpl) {
         if (!notesTpl)
             return;
-        // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
         fs.writeFileSync(path.join(outDir, 'templates', 'NOTES.txt'), notesTpl.endsWith('\n') ? notesTpl : notesTpl + '\n');
     }
-    /**
-     * Writes values.schema.json for values validation
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @param {Record<string, unknown>} [valuesSchema] - JSON schema
-     * @since 1.0.0
-     */
     static writeSchema(outDir, valuesSchema) {
         if (!valuesSchema)
             return;
-        // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
         fs.writeFileSync(path.join(outDir, 'values.schema.json'), JSON.stringify(valuesSchema, null, 2) + '\n');
     }
-    /**
-     * Writes .helmignore file with common ignore patterns
-     *
-     * @private
-     * @param {string} outDir - Output directory path
-     * @since 1.0.0
-     */
     static writeHelmIgnore(outDir) {
         const helmIgnorePath = path.join(outDir, '.helmignore');
-        // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
         if (!fs.existsSync(helmIgnorePath)) {
             const helmIgnore = [
                 '# VCS',
@@ -223,37 +95,18 @@ export class HelmChartWriter {
                 '*.tgz',
                 '',
             ].join('\n');
-            // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
             fs.writeFileSync(helmIgnorePath, helmIgnore);
         }
     }
 }
-/**
- * Splits YAML string into individual documents
- *
- * @private
- * @param {string} yamlStr - YAML string with potential document separators
- * @returns {string[]} Array of individual YAML documents
- * @since 1.0.0
- */
 function splitDocs(yamlStr) {
     return yamlStr
         .split(/^---\s*$/m)
         .map((p) => p.trim())
         .filter((p) => p.length);
 }
-/**
- * Writes all synthesized assets to the chart directory
- *
- * @private
- * @param {string} outDir - Output directory path
- * @param {SynthAsset[]} assets - Assets to write
- * @throws {Error} If asset ID contains invalid characters
- * @since 1.0.0
- */
 function writeAssets(outDir, assets) {
     for (const asset of assets) {
-        // Sanitize asset ID to prevent path traversal
         const sanitizedId = asset.id.replace(/[^a-zA-Z0-9-_]/g, '');
         if (sanitizedId !== asset.id) {
             throw new Error(`Invalid asset ID: ${SecurityUtils.sanitizeLogMessage(asset.id)}`);
@@ -267,52 +120,19 @@ function writeAssets(outDir, assets) {
         }
     }
 }
-/**
- * Gets the target directory for an asset
- *
- * @private
- * @param {('templates' | 'crds')} [target] - Target directory type
- * @returns {string} Directory name
- * @since 1.0.0
- */
 function getTargetDirectory(target) {
     return target === 'crds' ? 'crds' : 'templates';
 }
-/**
- * Writes a single asset file without document splitting
- *
- * @private
- * @param {string} outDir - Output directory path
- * @param {string} targetDir - Target subdirectory
- * @param {string} assetId - Asset identifier
- * @param {string} yaml - YAML content
- * @since 1.0.0
- */
 function writeSingleAssetFile(outDir, targetDir, assetId, yaml) {
     const filename = `${assetId}.yaml`;
-    // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
     fs.mkdirSync(path.join(outDir, targetDir), { recursive: true });
-    // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
     fs.writeFileSync(path.join(outDir, targetDir, filename), yaml + '\n');
 }
-/**
- * Writes multiple asset files by splitting YAML documents
- *
- * @private
- * @param {string} outDir - Output directory path
- * @param {string} targetDir - Target subdirectory
- * @param {string} assetId - Asset identifier
- * @param {string} yaml - YAML content with potential multiple documents
- * @since 1.0.0
- */
 function writeMultipleAssetFiles(outDir, targetDir, assetId, yaml) {
     const parts = splitDocs(yaml);
     parts.forEach((doc, index) => {
         const filename = `${assetId}${parts.length > 1 ? `-${index + 1}` : ''}.yaml`;
-        // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
         fs.mkdirSync(path.join(outDir, targetDir), { recursive: true });
-        // eslint-disable-next-line security/detect-non-literal-fs-filename -- Chart writer needs dynamic paths
         fs.writeFileSync(path.join(outDir, targetDir, filename), doc + '\n');
     });
 }
-//# sourceMappingURL=helmChartWriter.js.map

package/dist/lib/resources/baseResourceProvider.d.ts

@@ -1,59 +1,13 @@
 import { ApiObject } from 'cdk8s';
 import type { Chart } from 'cdk8s';
-/**
- * Base interface for all resource providers
- * Provides common functionality and ensures consistent patterns across providers
- *
- * @since 2.4.0
- */
 export interface IResourceProvider {
-    /** Reference to the CDK8s chart */
     readonly chart: Chart;
 }
-/**
- * Abstract base class for resource providers
- * Implements common functionality and validation patterns
- *
- * @since 2.4.0
- */
 export declare abstract class BaseResourceProvider implements IResourceProvider {
     readonly chart: Chart;
     constructor(chart: Chart);
-    /**
-     * Validates that a name follows Kubernetes naming conventions
-     * @param name - Resource name to validate
-     * @param resourceType - Type of resource for error messages
-     * @throws Error if name is invalid
-     */
     protected validateKubernetesName(name: string, resourceType: string): void;
-    /**
-     * Validates that labels follow Kubernetes conventions
-     * @param labels - Labels to validate
-     * @param resourceType - Type of resource for error messages
-     */
     protected validateLabels(labels: Record<string, string> | undefined, resourceType: string): void;
-    /**
-     * Creates a standardized ApiObject with common metadata
-     * @param name - Resource name
-     * @param apiVersion - Kubernetes API version
-     * @param kind - Kubernetes resource kind
-     * @param spec - Resource specification
-     * @param labels - Optional labels
-     * @param annotations - Optional annotations
-     * @returns Created ApiObject
-     */
     protected createApiObject(name: string, apiVersion: string, kind: string, spec: Record<string, unknown>, labels?: Record<string, string>, annotations?: Record<string, string>): ApiObject;
-    /**
-     * Creates an ApiObject for resources that don't use spec wrapper (like StorageClass)
-     * @param name - Resource name
-     * @param apiVersion - API version
-     * @param kind - Resource kind
-     * @param fields - Root-level fields for the resource
-     * @param labels - Optional labels
-     * @param annotations - Optional annotations
-     * @returns Created ApiObject
-     * @since 2.5.0
-     */
     protected createRootLevelApiObject(name: string, apiVersion: string, kind: string, fields: Record<string, unknown>, labels?: Record<string, string>, annotations?: Record<string, string>): ApiObject;
 }
-//# sourceMappingURL=baseResourceProvider.d.ts.map

package/dist/lib/resources/baseResourceProvider.js

@@ -1,70 +1,36 @@
 import { ApiObject } from 'cdk8s';
-/**
- * Abstract base class for resource providers
- * Implements common functionality and validation patterns
- *
- * @since 2.4.0
- */
 export class BaseResourceProvider {
     constructor(chart) {
         this.chart = chart;
     }
-    /**
-     * Validates that a name follows Kubernetes naming conventions
-     * @param name - Resource name to validate
-     * @param resourceType - Type of resource for error messages
-     * @throws Error if name is invalid
-     */
     validateKubernetesName(name, resourceType) {
         if (!name || typeof name !== 'string') {
             throw new Error(`${resourceType} name must be a non-empty string`);
         }
-        // Kubernetes name validation (RFC 1123 subdomain)
-        // eslint-disable-next-line security/detect-unsafe-regex -- Simple character class regex is safe
         const nameRegex = /^[a-z0-9]([-a-z0-9]*[a-z0-9])?$/;
         if (!nameRegex.test(name) || name.length > 63) {
             throw new Error(`${resourceType} name '${name}' must be a valid Kubernetes name (lowercase alphanumeric and hyphens, max 63 chars)`);
         }
     }
-    /**
-     * Validates that labels follow Kubernetes conventions
-     * @param labels - Labels to validate
-     * @param resourceType - Type of resource for error messages
-     */
     validateLabels(labels, resourceType) {
         if (!labels)
             return;
         Object.entries(labels).forEach(([key, value]) => {
-            // Validate label key
             if (key.length > 253) {
                 throw new Error(`${resourceType} label key '${key}' exceeds 253 characters`);
             }
-            // Validate label value
             if (value.length > 63) {
                 throw new Error(`${resourceType} label value '${value}' exceeds 63 characters`);
             }
-            // Skip validation for Helm template values
             if (value.includes('{{') && value.includes('}}')) {
                 return;
             }
-            // Basic character validation
-            // eslint-disable-next-line security/detect-unsafe-regex -- Simple character class regex is safe
             const labelRegex = /^[a-zA-Z0-9]([-a-zA-Z0-9_.]*[a-zA-Z0-9])?$/;
             if (!labelRegex.test(value)) {
                 throw new Error(`${resourceType} label value '${value}' contains invalid characters`);
             }
         });
     }
-    /**
-     * Creates a standardized ApiObject with common metadata
-     * @param name - Resource name
-     * @param apiVersion - Kubernetes API version
-     * @param kind - Kubernetes resource kind
-     * @param spec - Resource specification
-     * @param labels - Optional labels
-     * @param annotations - Optional annotations
-     * @returns Created ApiObject
-     */
     createApiObject(name, apiVersion, kind, spec, labels, annotations) {
         this.validateKubernetesName(name, kind);
         this.validateLabels(labels, kind);
@@ -79,17 +45,6 @@ export class BaseResourceProvider {
             spec,
         });
     }
-    /**
-     * Creates an ApiObject for resources that don't use spec wrapper (like StorageClass)
-     * @param name - Resource name
-     * @param apiVersion - API version
-     * @param kind - Resource kind
-     * @param fields - Root-level fields for the resource
-     * @param labels - Optional labels
-     * @param annotations - Optional annotations
-     * @returns Created ApiObject
-     * @since 2.5.0
-     */
     createRootLevelApiObject(name, apiVersion, kind, fields, labels, annotations) {
         this.validateKubernetesName(name, kind);
         this.validateLabels(labels, kind);
@@ -101,8 +56,7 @@ export class BaseResourceProvider {
                 ...(labels && Object.keys(labels).length > 0 ? { labels } : {}),
                 ...(annotations && Object.keys(annotations).length > 0 ? { annotations } : {}),
             },
-            ...fields, // Fields go at root level, not under spec
+            ...fields,
         });
     }
 }
-//# sourceMappingURL=baseResourceProvider.js.map