@cqse/commons 0.1.0-beta.8 → 1.0.0-beta.2

package/lib/ConfigWithOverwrites.js

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurationWithOverwrites = void 0;
+exports.makeConfigProxy = makeConfigProxy;
+const Contract_1 = require("./Contract");
+const ConfigParser_1 = require("./ConfigParser");
+const node_crypto_1 = require("node:crypto");
+/**
+ * Configuration with a possibility to overwrite configuration values for this app run,
+ * delegating to the base configuration if no overwrite was performed.
+ * For type-safe access, use `makeConfigProxy` to create a proxy object.
+ */
+class ConfigurationWithOverwrites {
+    constructor(allParameters, redefinableParameters, baseConfiguration, overwrites) {
+        this.baseConfiguration = Contract_1.Contract.requireDefined(baseConfiguration);
+        this.redefinableParameters = Contract_1.Contract.requireDefined(redefinableParameters);
+        this.allParameters = Contract_1.Contract.requireDefined(allParameters);
+        this.overwrites = overwrites !== null && overwrites !== void 0 ? overwrites : {};
+        this.hash = undefined;
+    }
+    /**
+     * Retrieves the value of a configuration parameter based on the provided parameter ID.
+     */
+    get(parameterId) {
+        var _a;
+        this.assertParameterExists(parameterId);
+        return (_a = this.overwrites[parameterId]) !== null && _a !== void 0 ? _a : this.baseConfiguration[parameterId];
+    }
+    /**
+     * Sets the specified parameter with a given value in the `overwrites` map.
+     */
+    set(parameterId, value) {
+        if (this.redefinableParameters.lookupParameter(parameterId) === undefined) {
+            throw new Error(`Unknown configuration parameter: ${parameterId}`);
+        }
+        this.overwriteConfig(parameterId, value);
+        this.hash = undefined;
+    }
+    /**
+     * Updates or removes a configuration-overwrite for the given parameter.
+     */
+    overwriteConfig(parameter, value) {
+        const parameterId = (0, ConfigParser_1.parameterNameToParameterId)(parameter);
+        this.assertParameterExists(parameterId);
+        if (value === undefined) {
+            delete this.overwrites[parameterId];
+            return;
+        }
+        this.overwrites[parameterId] = this.castConfigArgument(parameterId, value);
+        this.hash = undefined;
+    }
+    castConfigArgument(parameterId, value) {
+        const parameter = this.getParameter(parameterId);
+        const type = parameter.type;
+        if (type === 'int') {
+            if (typeof value === 'number') {
+                return Math.floor(value);
+            }
+            if (typeof value === 'string') {
+                return parseInt(value, 10);
+            }
+            if (typeof value === 'boolean') {
+                return value ? 1 : 0;
+            }
+        }
+        else if (type === 'bool') {
+            if (typeof value === 'boolean') {
+                return value;
+            }
+            if (typeof value === 'string') {
+                return value.toLowerCase() === 'true';
+            }
+            if (typeof value === 'number') {
+                return value !== 0;
+            }
+        }
+        else if (type === 'string[]') {
+            if (value === undefined || value == null) {
+                return [];
+            }
+            if (Array.isArray(value)) {
+                return value.map(String);
+            }
+            if (typeof value === 'string') {
+                return value.split(',').map(s => s.trim());
+            }
+        }
+        else {
+            // string type
+            return String(value);
+        }
+        throw new Error(`Cannot cast value of type ${typeof value} to ${type}`);
+    }
+    assertParameterExists(parameterId) {
+        if (this.allParameters.lookupParameter(parameterId) === undefined) {
+            throw new Error(`Unknown configuration parameter: ${parameterId}`);
+        }
+    }
+    getParameter(parameterId) {
+        const parameter = this.redefinableParameters.lookupParameter(parameterId);
+        if (parameter === undefined) {
+            throw new Error(`Unknown configuration parameter: ${parameterId}`);
+        }
+        return parameter;
+    }
+    /**
+     * Computes a hash for the given (possibly overwritten) configuration.
+     */
+    getHash() {
+        if (this.hash === undefined) {
+            const hash = (0, node_crypto_1.createHash)('sha256');
+            for (const [key, value] of Object.entries(this.baseConfiguration)) {
+                hash.update(key);
+                hash.update(String(value));
+            }
+            for (const [key, value] of Object.entries(this.overwrites)) {
+                hash.update(key);
+                hash.update(String(value));
+            }
+            this.hash = hash.digest('hex');
+        }
+        return this.hash;
+    }
+    /**
+     * Copies the given configuration along with the overrides.
+     */
+    copy() {
+        const overwritesCopy = JSON.parse(JSON.stringify(this.overwrites));
+        return new ConfigurationWithOverwrites(this.allParameters, this.redefinableParameters, this.baseConfiguration, overwritesCopy);
+    }
+}
+exports.ConfigurationWithOverwrites = ConfigurationWithOverwrites;
+/**
+ * Creates a proxy object to retrieve and set config options via the attributes in the `BaseConfigType` interface.
+ */
+function makeConfigProxy(configuration) {
+    return new Proxy(configuration, {
+        get(_, property) {
+            return configuration.get(property.toString());
+        },
+        set(target, property, value) {
+            configuration.set(property.toString(), value);
+            return true;
+        }
+    });
+}
+//# sourceMappingURL=ConfigWithOverwrites.js.map

package/lib/ConfigWithOverwrites.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigWithOverwrites.js","sourceRoot":"","sources":["../src/ConfigWithOverwrites.ts"],"names":[],"mappings":";;;AA+JA,0CAWC;AA1KD,yCAAsC;AACtC,iDAMwB;AACxB,6CAAyC;AAEzC;;;;GAIG;AACH,MAAa,2BAA2B;IAYvC,YAAY,aAAsC,EAAE,qBAA8C,EAC/F,iBAAkD,EAAE,UAA4C;QAClG,IAAI,CAAC,iBAAiB,GAAG,mBAAQ,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;QACpE,IAAI,CAAC,qBAAqB,GAAG,mBAAQ,CAAC,cAAc,CAAC,qBAAqB,CAAC,CAAC;QAC5E,IAAI,CAAC,aAAa,GAAG,mBAAQ,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,IAAI,CAAC,UAAU,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAmD,CAAC;QACpF,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,WAAmB;;QAC7B,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;QACxC,OAAO,MAAA,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,mCAAI,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,WAAmB,EAAE,KAAsB;QACrD,IAAI,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,WAAW,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3E,MAAM,IAAI,KAAK,CAAC,oCAAoC,WAAW,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,SAAiB,EAAE,KAAkC;QAC3E,MAAM,WAAW,GAAG,IAAA,yCAA0B,EAAC,SAAS,CAAC,CAAC;QAC1D,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;QACxC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YACpC,OAAO;QACR,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAC3E,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;IACvB,CAAC;IAEO,kBAAkB,CAAC,WAAmB,EAAE,KAAc;QAC7D,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QACjD,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC;QAC5B,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACpB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;YACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC/B,OAAO,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC5B,CAAC;YACD,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;gBAChC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACtB,CAAC;QACF,CAAC;aAAM,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YAC5B,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;gBAChC,OAAO,KAAK,CAAC;YACd,CAAC;YACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC/B,OAAO,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;YACvC,CAAC;YACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC/B,OAAO,KAAK,KAAK,CAAC,CAAC;YACpB,CAAC;QACF,CAAC;aAAM,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;YAChC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;gBAC1C,OAAO,EAAE,CAAC;YACX,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1B,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC1B,CAAC;YACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC/B,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAC5C,CAAC;QACF,CAAC;aAAM,CAAC;YACP,cAAc;YACd,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,6BAA6B,OAAO,KAAK,OAAO,IAAI,EAAE,CAAC,CAAC;IACzE,CAAC;IAEO,qBAAqB,CAAC,WAAmB;QAChD,IAAI,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,WAAW,CAAC,KAAK,SAAS,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,oCAAoC,WAAW,EAAE,CAAC,CAAC;QACpE,CAAC;IACF,CAAC;IAEO,YAAY,CAAC,WAAmB;QACvC,MAAM,SAAS,GAAG,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC1E,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,oCAAoC,WAAW,EAAE,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,OAAO;QACb,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,GAAG,IAAA,wBAAU,EAAC,QAAQ,CAAC,CAAC;YAClC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBACnE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC5B,CAAC;YACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC5D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC5B,CAAC;YACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,IAAI;QACV,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QACnE,OAAO,IAAI,2BAA2B,CAAiB,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,iBAAiB,EAC5H,cAAc,CAAC,CAAC;IAClB,CAAC;CAED;AA3ID,kEA2IC;AAED;;GAEG;AACH,SAAgB,eAAe,CAC9B,aAA0D;IAC1D,OAAO,IAAI,KAAK,CAAC,aAAa,EAAE;QAC/B,GAAG,CAAC,CAAC,EAAE,QAAyB;YAC/B,OAAO,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC;QACD,GAAG,CAAC,MAAM,EAAE,QAAyB,EAAE,KAAsB;YAC5D,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;YAC9C,OAAO,IAAI,CAAC;QACb,CAAC;KACD,CAA8B,CAAC;AACjC,CAAC"}

package/lib/Strings.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removePrefix = void 0;
+exports.removePrefix = removePrefix;
 /**
  * Remove the given prefix, if present, from the given string.
  *
@@ -15,5 +15,4 @@ function removePrefix(prefix, removeFrom) {
     }
     return removeFrom;
 }
-exports.removePrefix = removePrefix;
 //# sourceMappingURL=Strings.js.map

package/lib/Strings.js.map

@@ -1 +1 @@
-{"version":3,"file":"Strings.js","sourceRoot":"","sources":["../src/Strings.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,SAAgB,YAAY,CAAC,MAAc,EAAE,UAAkB;IAC9D,IAAI,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACnC,OAAO,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,UAAU,CAAC;AACnB,CAAC;AALD,oCAKC"}
+{"version":3,"file":"Strings.js","sourceRoot":"","sources":["../src/Strings.ts"],"names":[],"mappings":";;AAQA,oCAKC;AAbD;;;;;;;GAOG;AACH,SAAgB,YAAY,CAAC,MAAc,EAAE,UAAkB;IAC9D,IAAI,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACnC,OAAO,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,UAAU,CAAC;AACnB,CAAC"}

package/lib/index.d.ts

@@ -2,4 +2,7 @@
 export * from './Contract';
 export * from './Exceptions';
 export * from './Strings';
+export * from './ConfigParser';
+export * from './ConfigWithOverwrites';
+export * from './CollectorConfig';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC"}

package/lib/index.js

@@ -18,4 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Contract"), exports);
 __exportStar(require("./Exceptions"), exports);
 __exportStar(require("./Strings"), exports);
+__exportStar(require("./ConfigParser"), exports);
+__exportStar(require("./ConfigWithOverwrites"), exports);
+__exportStar(require("./CollectorConfig"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA4C;AAC5C,6CAA2B;AAC3B,+CAA6B;AAC7B,4CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA4C;AAC5C,6CAA2B;AAC3B,+CAA6B;AAC7B,4CAA0B;AAC1B,iDAA+B;AAC/B,yDAAuC;AACvC,oDAAkC"}

package/package.json

@@ -1,14 +1,11 @@
 {
   "name": "@cqse/commons",
-  "version": "0.1.0-beta.8",
+  "version": "1.0.0-beta.2",
   "description": "A collection of generic functionality for TypeScript projects.",
   "author": "CQSE GmbH",
   "main": "lib/index.js",
   "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/cqse/teamscale-javascript-profiler.git"
-  },
+  "homepage": "https://docs.teamscale.com/howto/setting-up-profiler-tga/javascript/",
   "files": [
     "dist/**/*",
     "lib/**/*"
@@ -17,16 +14,16 @@
     "typescript-optional": "^2.0.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.24.4",
-    "@babel/preset-env": "^7.24.4",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.12.6",
+    "@babel/core": "^7.26.8",
+    "@babel/preset-env": "^7.26.8",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.13.4",
     "babel-jest": "^29.7.0",
     "jest": "^29.7.0",
-    "rimraf": "^5.0.5",
-    "ts-jest": "^29.1.2",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.4"
+    "typescript": "^5.7.3"
   },
   "publishConfig": {
     "access": "public"