helm-env-delta 1.12.0 → 1.13.0

package/README.md

@@ -413,10 +413,13 @@ exclude: # Optional: Exclude patterns
 
 prune: false # Optional: Delete dest files not in source
 confirmationDelay: 3000 # Optional: Delay in ms before sync (default: 3000, 0 to disable)
+requiredVersion: '1.10.0' # Optional: Minimum tool version required to process this config
 ```
 
 **Note:** Source and destination paths cannot resolve to the same folder.
 
+**`requiredVersion`:** When set, the CLI checks that the installed version of helm-env-delta meets this minimum. If the installed version is older, the CLI exits immediately with a clear upgrade message. This prevents running configs that depend on newer features with an outdated tool version. Supports `"1.2.3"` or `"v1.2.3"` format.
+
 ---
 
 ### 🔒 Path Filtering (skipPath)
@@ -777,7 +780,7 @@ stopRules: # Add production safety rules
 
 **Merging:**
 
-- Primitives (`source`, `destination`, `prune`, `confirmationDelay`): Child overrides parent
+- Primitives (`source`, `destination`, `prune`, `confirmationDelay`, `requiredVersion`): Child overrides parent
 - Arrays (`include`, `exclude`): Concatenated (parent + child)
 - Per-file Records (`skipPath`, `transforms`, `stopRules`, `fixedValues`): Keys merged, arrays concatenated
 - `outputFormat`: Shallow merged (child fields override parent)

package/dist/configFile.d.ts

@@ -102,6 +102,7 @@ declare const transformRulesSchema: z.ZodObject<{
 }, z.core.$strip>;
 declare const baseConfigSchema: z.ZodObject<{
     extends: z.ZodOptional<z.ZodString>;
+    requiredVersion: z.ZodOptional<z.ZodString>;
     source: z.ZodOptional<z.ZodString>;
     destination: z.ZodOptional<z.ZodString>;
     include: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -188,6 +189,7 @@ declare const finalConfigSchema: z.ZodObject<{
         contentFile: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
         filenameFile: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
     }, z.core.$strip>>>;
+    requiredVersion: z.ZodOptional<z.ZodString>;
     source: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
     destination: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
     skipPath: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;
@@ -262,6 +264,7 @@ declare const formatOnlyConfigSchema: z.ZodObject<{
         contentFile: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
         filenameFile: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
     }, z.core.$strip>>>;
+    requiredVersion: z.ZodOptional<z.ZodString>;
     source: z.ZodOptional<z.ZodString>;
     destination: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
     skipPath: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;

package/dist/configFile.js

@@ -116,6 +116,13 @@ const transformRulesSchema = zod_1.z
 });
 const baseConfigSchema = zod_1.z.object({
     extends: zod_1.z.string().min(1).optional(),
+    requiredVersion: zod_1.z
+        .string()
+        .min(1)
+        .regex(/^v?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/, {
+        message: 'Must be a valid semver version (e.g., "1.2.3" or "v1.2.3")'
+    })
+        .optional(),
     source: zod_1.z.string().min(1).optional(),
     destination: zod_1.z.string().min(1).optional(),
     include: zod_1.z.array(zod_1.z.string().min(1)).optional(),

package/dist/configLoader.d.ts

@@ -1,6 +1,25 @@
 import { type FinalConfig, type FormatOnlyConfig } from './configFile';
+declare const ConfigLoaderErrorClass: {
+    new (message: string, options?: import("./utils").ErrorOptions): {
+        [key: string]: unknown;
+        readonly code?: string;
+        readonly path?: string;
+        readonly cause?: Error;
+        readonly hints?: string[];
+        name: string;
+        message: string;
+        stack?: string;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
+    stackTraceLimit: number;
+};
+export declare class ConfigLoaderError extends ConfigLoaderErrorClass {
+}
+export declare const isConfigLoaderError: (error: unknown) => error is ConfigLoaderError;
 export type Config = FinalConfig;
 export type LoadConfigOptions = {
     formatOnly?: boolean;
 };
 export declare const loadConfigFile: (configPath: string, quiet?: boolean, logger?: import("./logger").Logger, options?: LoadConfigOptions) => FinalConfig | FormatOnlyConfig;
+export {};

package/dist/configLoader.js

@@ -3,11 +3,36 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadConfigFile = void 0;
+exports.loadConfigFile = exports.isConfigLoaderError = exports.ConfigLoaderError = void 0;
 const node_path_1 = __importDefault(require("node:path"));
+const package_json_1 = __importDefault(require("../package.json"));
 const configFile_1 = require("./configFile");
 const configMerger_1 = require("./configMerger");
 const utils_1 = require("./utils");
+const ConfigLoaderErrorClass = (0, utils_1.createErrorClass)('Config Loader Error', {
+    VERSION_REQUIREMENT: 'Installed version does not meet the required version'
+}, (message, options) => {
+    let fullMessage = `Config Loader Error: ${message}`;
+    if (options['requiredVersion'])
+        fullMessage += `\n  Required version: ${options['requiredVersion']}`;
+    if (options['currentVersion'])
+        fullMessage += `\n  Current version: ${options['currentVersion']}`;
+    fullMessage += '\n\n  Hint: Run "npm install" to update helm-env-delta to the required version.';
+    return fullMessage;
+});
+class ConfigLoaderError extends ConfigLoaderErrorClass {
+}
+exports.ConfigLoaderError = ConfigLoaderError;
+exports.isConfigLoaderError = (0, utils_1.createErrorTypeGuard)(ConfigLoaderError);
+const checkRequiredVersion = (requiredVersion) => {
+    const currentVersion = package_json_1.default.version;
+    if ((0, utils_1.isNewerVersion)(currentVersion, requiredVersion))
+        throw new ConfigLoaderError(`This config requires helm-env-delta v${requiredVersion} or newer`, {
+            code: 'VERSION_REQUIREMENT',
+            requiredVersion,
+            currentVersion
+        });
+};
 const expandTransformFiles = (config, configDirectory) => {
     if (!config.transforms)
         return config;
@@ -34,6 +59,8 @@ const loadConfigFile = (configPath, quiet = false, logger, options = {}) => {
     const configDirectory = node_path_1.default.dirname(node_path_1.default.resolve(configPath));
     const mergedConfig = (0, configMerger_1.resolveConfigWithExtends)(configPath, new Set(), 0, logger);
     const expandedConfig = expandTransformFiles(mergedConfig, configDirectory);
+    if (expandedConfig.requiredVersion)
+        checkRequiredVersion(expandedConfig.requiredVersion);
     const config = options.formatOnly
         ? (0, configFile_1.parseFormatOnlyConfig)(expandedConfig, configPath)
         : (0, configFile_1.parseFinalConfig)(expandedConfig, configPath);

package/dist/configMerger.js

@@ -88,6 +88,10 @@ const mergeConfigs = (parent, child) => {
         merged.confirmationDelay = child.confirmationDelay;
     else if (parent.confirmationDelay !== undefined)
         merged.confirmationDelay = parent.confirmationDelay;
+    if (child.requiredVersion !== undefined)
+        merged.requiredVersion = child.requiredVersion;
+    else if (parent.requiredVersion !== undefined)
+        merged.requiredVersion = parent.requiredVersion;
     const parentInclude = parent.include ?? [];
     const childInclude = child.include ?? [];
     if (parentInclude.length > 0 || childInclude.length > 0)

package/dist/index.js

@@ -337,6 +337,8 @@ const main = async () => {
     catch (error) {
         if ((0, configMerger_1.isConfigMergerError)(error))
             console.error(error.message);
+        else if ((0, configLoader_1.isConfigLoaderError)(error))
+            console.error(error.message);
         else if ((0, ZodError_1.isZodValidationError)(error))
             console.error(error.message);
         else if ((0, fileLoader_1.isFileLoaderError)(error))

package/dist/utils/index.d.ts

@@ -7,7 +7,8 @@ export { clearJsonPathCache, getValueAtPath, isFilterSegment, matchesFilter, par
 export { isYamlFile } from './fileType';
 export { globalMatcher, PatternMatcher } from './patternMatcher';
 export { generateUnifiedDiff } from './diffGenerator';
-export { checkForUpdates, isVersionCheckerError, VersionCheckerError } from './versionChecker';
+export type { SemverParts } from './versionChecker';
+export { checkForUpdates, isNewerVersion, isVersionCheckerError, parseVersion, VersionCheckerError } from './versionChecker';
 export { escapeRegex, isYamlFileLoaderError, loadYamlFile, YamlFileLoaderError } from './yamlFileLoader';
 export { isTransformFileLoaderError, loadTransformFile, loadTransformFiles, TransformFileLoaderError } from './transformFileLoader';
 export { isRegexPatternFileLoaderError, loadRegexPatternArray, loadRegexPatternsFromKeys, RegexPatternFileLoaderError } from './regexPatternFileLoader';

package/dist/utils/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NUMERIC_MIN_MULTIPLIER = exports.NUMERIC_MIN_FLOOR = exports.MAX_EXAMPLES_PER_SUGGESTION = exports.ISO_TIMESTAMP_PATTERN = exports.FILTER_THRESHOLDS = exports.CONSTRAINT_FIELD_NAMES = exports.CONFIDENCE_DEFAULTS = exports.ARRAY_KEY_FIELDS = exports.ANTONYM_PAIRS = exports.isYamlSeq = exports.isYamlMap = exports.isYamlCollection = exports.isScalar = exports.extractScalarValue = exports.extractKeyValue = exports.validateVersionString = exports.applyRegexRulesSequentially = exports.validateTargetedRegex = exports.validatePathlessRegex = exports.getAllValuesRecursive = exports.RegexPatternFileLoaderError = exports.loadRegexPatternsFromKeys = exports.loadRegexPatternArray = exports.isRegexPatternFileLoaderError = exports.TransformFileLoaderError = exports.loadTransformFiles = exports.loadTransformFile = exports.isTransformFileLoaderError = exports.YamlFileLoaderError = exports.loadYamlFile = exports.isYamlFileLoaderError = exports.escapeRegex = exports.VersionCheckerError = exports.isVersionCheckerError = exports.checkForUpdates = exports.generateUnifiedDiff = exports.PatternMatcher = exports.globalMatcher = exports.isYamlFile = exports.parseJsonPath = exports.parseFilterSegment = exports.matchesFilter = exports.isFilterSegment = exports.getValueAtPath = exports.clearJsonPathCache = exports.serializeForDiff = exports.normalizeForComparison = exports.deepEqual = exports.createErrorTypeGuard = exports.createErrorClass = void 0;
-exports.parseFilterExpression = exports.isFilterParseError = exports.FilterParseError = exports.filterFileMaps = exports.filterFileMap = exports.fileMatchesFilter = exports.isCommentOnlyContent = exports.shouldPreserveItem = exports.itemMatchesAnyFilter = exports.getApplicableArrayFilters = exports.findMatchingTargetItem = exports.setValueAtPath = exports.getFixedValuesForFile = exports.applyFixedValues = exports.UUID_PATTERN = exports.SEMVER_PATTERN = exports.SEMANTIC_PATTERNS = exports.SEMANTIC_KEYWORDS = exports.PROBLEMATIC_REGEX_CHARS = void 0;
+exports.MAX_EXAMPLES_PER_SUGGESTION = exports.ISO_TIMESTAMP_PATTERN = exports.FILTER_THRESHOLDS = exports.CONSTRAINT_FIELD_NAMES = exports.CONFIDENCE_DEFAULTS = exports.ARRAY_KEY_FIELDS = exports.ANTONYM_PAIRS = exports.isYamlSeq = exports.isYamlMap = exports.isYamlCollection = exports.isScalar = exports.extractScalarValue = exports.extractKeyValue = exports.validateVersionString = exports.applyRegexRulesSequentially = exports.validateTargetedRegex = exports.validatePathlessRegex = exports.getAllValuesRecursive = exports.RegexPatternFileLoaderError = exports.loadRegexPatternsFromKeys = exports.loadRegexPatternArray = exports.isRegexPatternFileLoaderError = exports.TransformFileLoaderError = exports.loadTransformFiles = exports.loadTransformFile = exports.isTransformFileLoaderError = exports.YamlFileLoaderError = exports.loadYamlFile = exports.isYamlFileLoaderError = exports.escapeRegex = exports.VersionCheckerError = exports.parseVersion = exports.isVersionCheckerError = exports.isNewerVersion = exports.checkForUpdates = exports.generateUnifiedDiff = exports.PatternMatcher = exports.globalMatcher = exports.isYamlFile = exports.parseJsonPath = exports.parseFilterSegment = exports.matchesFilter = exports.isFilterSegment = exports.getValueAtPath = exports.clearJsonPathCache = exports.serializeForDiff = exports.normalizeForComparison = exports.deepEqual = exports.createErrorTypeGuard = exports.createErrorClass = void 0;
+exports.parseFilterExpression = exports.isFilterParseError = exports.FilterParseError = exports.filterFileMaps = exports.filterFileMap = exports.fileMatchesFilter = exports.isCommentOnlyContent = exports.shouldPreserveItem = exports.itemMatchesAnyFilter = exports.getApplicableArrayFilters = exports.findMatchingTargetItem = exports.setValueAtPath = exports.getFixedValuesForFile = exports.applyFixedValues = exports.UUID_PATTERN = exports.SEMVER_PATTERN = exports.SEMANTIC_PATTERNS = exports.SEMANTIC_KEYWORDS = exports.PROBLEMATIC_REGEX_CHARS = exports.NUMERIC_MIN_MULTIPLIER = exports.NUMERIC_MIN_FLOOR = void 0;
 var errors_1 = require("./errors");
 Object.defineProperty(exports, "createErrorClass", { enumerable: true, get: function () { return errors_1.createErrorClass; } });
 Object.defineProperty(exports, "createErrorTypeGuard", { enumerable: true, get: function () { return errors_1.createErrorTypeGuard; } });
@@ -26,7 +26,9 @@ var diffGenerator_1 = require("./diffGenerator");
 Object.defineProperty(exports, "generateUnifiedDiff", { enumerable: true, get: function () { return diffGenerator_1.generateUnifiedDiff; } });
 var versionChecker_1 = require("./versionChecker");
 Object.defineProperty(exports, "checkForUpdates", { enumerable: true, get: function () { return versionChecker_1.checkForUpdates; } });
+Object.defineProperty(exports, "isNewerVersion", { enumerable: true, get: function () { return versionChecker_1.isNewerVersion; } });
 Object.defineProperty(exports, "isVersionCheckerError", { enumerable: true, get: function () { return versionChecker_1.isVersionCheckerError; } });
+Object.defineProperty(exports, "parseVersion", { enumerable: true, get: function () { return versionChecker_1.parseVersion; } });
 Object.defineProperty(exports, "VersionCheckerError", { enumerable: true, get: function () { return versionChecker_1.VersionCheckerError; } });
 var yamlFileLoader_1 = require("./yamlFileLoader");
 Object.defineProperty(exports, "escapeRegex", { enumerable: true, get: function () { return yamlFileLoader_1.escapeRegex; } });

package/dist/utils/versionChecker.d.ts

@@ -16,5 +16,12 @@ declare const VersionCheckerErrorClass: {
 export declare class VersionCheckerError extends VersionCheckerErrorClass {
 }
 export declare const isVersionCheckerError: (error: unknown) => error is VersionCheckerError;
+export interface SemverParts {
+    major: number;
+    minor: number;
+    patch: number;
+}
+export declare const parseVersion: (version: string) => SemverParts | undefined;
+export declare const isNewerVersion: (current: string, latest: string) => boolean;
 export declare const checkForUpdates: (currentVersion: string) => Promise<void>;
 export {};

package/dist/utils/versionChecker.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkForUpdates = exports.isVersionCheckerError = exports.VersionCheckerError = void 0;
+exports.checkForUpdates = exports.isNewerVersion = exports.parseVersion = exports.isVersionCheckerError = exports.VersionCheckerError = void 0;
 const node_https_1 = __importDefault(require("node:https"));
 const chalk_1 = __importDefault(require("chalk"));
 const package_json_1 = __importDefault(require("../../package.json"));
@@ -44,9 +44,10 @@ const parseVersion = (version) => {
         patch: Number.parseInt(match[3], 10)
     };
 };
+exports.parseVersion = parseVersion;
 const isNewerVersion = (current, latest) => {
-    const currentParts = parseVersion(current);
-    const latestParts = parseVersion(latest);
+    const currentParts = (0, exports.parseVersion)(current);
+    const latestParts = (0, exports.parseVersion)(latest);
     if (!currentParts || !latestParts)
         return false;
     if (latestParts.major > currentParts.major)
@@ -59,6 +60,7 @@ const isNewerVersion = (current, latest) => {
         return false;
     return latestParts.patch > currentParts.patch;
 };
+exports.isNewerVersion = isNewerVersion;
 const fetchLatestVersion = (packageName, timeout) => {
     return new Promise((resolve, reject) => {
         const url = `https://registry.npmjs.org/${packageName}/latest`;
@@ -108,7 +110,7 @@ const checkForUpdates = async (currentVersion) => {
         return;
     try {
         const latestVersion = await fetchLatestVersion('helm-env-delta', 3000);
-        if (isNewerVersion(currentVersion, latestVersion))
+        if ((0, exports.isNewerVersion)(currentVersion, latestVersion))
             displayUpdateNotification(currentVersion, latestVersion);
     }
     catch {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "helm-env-delta",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "HelmEnvDelta – environment-aware YAML delta and sync for GitOps",
   "author": "BCsabaEngine",
   "license": "ISC",