@cqse/commons 0.0.1-beta.25 → 0.0.1-beta.29

package/lib/Contract.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Nullable type.
+ */
+export declare type Nullable<Type> = Type | null;
+/**
+ * Methods to express and check code contracts.
+ */
+export declare class Contract {
+    /**
+     * The given predicate `condition` has to be satisfied.
+     *
+     * @param condition Condition predicate (boolean value)
+     * @param message Message describing the condition.
+     */
+    static require(condition: boolean, message?: string): void;
+    /**
+     * Require that the given argument `obj` is defined.
+     *
+     * @param obj The object that has to be defined.
+     * @param message The message describing this requirement.
+     */
+    static requireDefined<E>(obj: Nullable<E>, message?: string): E;
+    /**
+     * Require that the given string is not empty.
+     *
+     * @param text The string to check.
+     * @param message The message that describes the requirement.
+     */
+    static requireNonEmpty(text: string, message?: string): string;
+    /**
+     * Require that the string adheres to a particular pattern.
+     *
+     * @param text The string to check.
+     * @param regexp The regular expression to satisfy.
+     * @param message The message describing the requirement.
+     */
+    static requireStringPattern(text: string, regexp: string, message?: string): string;
+}
+//# sourceMappingURL=Contract.d.ts.map

package/lib/Contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Contract.d.ts","sourceRoot":"","sources":["../src/Contract.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,QAAQ,CAAC,IAAI,IAAI,IAAI,GAAG,IAAI,CAAC;AAEzC;;GAEG;AACH,qBAAa,QAAQ;IACpB;;;;;OAKG;WACW,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAMjE;;;;;OAKG;WACW,cAAc,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC;IAqBtE;;;;;OAKG;WACW,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM;IASrE;;;;;;OAMG;WACW,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM;CAU1F"}

package/lib/Contract.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Contract = void 0;
+const Exceptions_1 = require("./Exceptions");
+/**
+ * Methods to express and check code contracts.
+ */
+class Contract {
+    /**
+     * The given predicate `condition` has to be satisfied.
+     *
+     * @param condition Condition predicate (boolean value)
+     * @param message Message describing the condition.
+     */
+    static require(condition, message) {
+        if (!condition) {
+            throw new Exceptions_1.IllegalArgumentException(message);
+        }
+    }
+    /**
+     * Require that the given argument `obj` is defined.
+     *
+     * @param obj The object that has to be defined.
+     * @param message The message describing this requirement.
+     */
+    static requireDefined(obj, message) {
+        if (obj) {
+            return obj;
+        }
+        if (typeof obj === 'number' || typeof obj === 'boolean') {
+            return obj;
+        }
+        if (typeof obj === 'string' || obj instanceof String) {
+            // Deal with the case `obj === ""`
+            return obj;
+        }
+        if (message) {
+            throw new Exceptions_1.IllegalArgumentException(message);
+        }
+        else {
+            throw new Exceptions_1.IllegalArgumentException('Reference must be defined.');
+        }
+    }
+    /**
+     * Require that the given string is not empty.
+     *
+     * @param text The string to check.
+     * @param message The message that describes the requirement.
+     */
+    static requireNonEmpty(text, message) {
+        this.requireDefined(text);
+        if (text.length === 0) {
+            throw new Exceptions_1.IllegalArgumentException(message);
+        }
+        return text;
+    }
+    /**
+     * Require that the string adheres to a particular pattern.
+     *
+     * @param text The string to check.
+     * @param regexp The regular expression to satisfy.
+     * @param message The message describing the requirement.
+     */
+    static requireStringPattern(text, regexp, message) {
+        this.requireDefined(text);
+        this.requireDefined(regexp);
+        if (!text.match(regexp)) {
+            throw new Exceptions_1.IllegalArgumentException(message);
+        }
+        return text;
+    }
+}
+exports.Contract = Contract;
+//# sourceMappingURL=Contract.js.map

package/lib/Contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Contract.js","sourceRoot":"","sources":["../src/Contract.ts"],"names":[],"mappings":";;;AAAA,6CAAwD;AAOxD;;GAEG;AACH,MAAa,QAAQ;IACpB;;;;;OAKG;IACI,MAAM,CAAC,OAAO,CAAC,SAAkB,EAAE,OAAgB;QACzD,IAAI,CAAC,SAAS,EAAE;YACf,MAAM,IAAI,qCAAwB,CAAC,OAAO,CAAC,CAAC;SAC5C;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAI,GAAgB,EAAE,OAAgB;QACjE,IAAI,GAAG,EAAE;YACR,OAAO,GAAG,CAAC;SACX;QAED,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,SAAS,EAAE;YACxD,OAAO,GAAG,CAAC;SACX;QAED,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,YAAY,MAAM,EAAE;YACrD,kCAAkC;YAClC,OAAO,GAAG,CAAC;SACX;QAED,IAAI,OAAO,EAAE;YACZ,MAAM,IAAI,qCAAwB,CAAC,OAAO,CAAC,CAAC;SAC5C;aAAM;YACN,MAAM,IAAI,qCAAwB,CAAC,4BAA4B,CAAC,CAAC;SACjE;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,OAAgB;QAC3D,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACtB,MAAM,IAAI,qCAAwB,CAAC,OAAO,CAAC,CAAC;SAC5C;QAED,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,oBAAoB,CAAC,IAAY,EAAE,MAAc,EAAE,OAAgB;QAChF,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAE5B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;YACxB,MAAM,IAAI,qCAAwB,CAAC,OAAO,CAAC,CAAC;SAC5C;QAED,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAxED,4BAwEC"}

package/lib/Exceptions.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Excepting signaling that there is functionality that is supposed
+ * to be implemented in case the exception is thrown.
+ *
+ * This is helpful for writing prototypes and not yet handling all possible cases.
+ */
+export declare class ImplementMeException extends Error {
+    private readonly _implementMeFor;
+    constructor(implementMeFor?: string);
+    get message(): string;
+}
+/**
+ * Exception signaling that the application is in an invalid state.
+ */
+export declare class IllegalStateException extends Error {
+}
+/**
+ * Exception signaling that an invalid argument has been passed for a parameter.
+ */
+export declare class IllegalArgumentException extends Error {
+}
+/**
+ * Exception signaling that a component is mis-configured.
+ */
+export declare class InvalidConfigurationException extends Error {
+}
+//# sourceMappingURL=Exceptions.d.ts.map

package/lib/Exceptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Exceptions.d.ts","sourceRoot":"","sources":["../src/Exceptions.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,qBAAa,oBAAqB,SAAQ,KAAK;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAmB;gBAEvC,cAAc,CAAC,EAAE,MAAM;IAKnC,IAAI,OAAO,IAAI,MAAM,CAMpB;CACD;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,KAAK;CAAG;AAEnD;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,KAAK;CAAG;AAEtD;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,KAAK;CAAG"}

package/lib/Exceptions.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvalidConfigurationException = exports.IllegalArgumentException = exports.IllegalStateException = exports.ImplementMeException = void 0;
+const typescript_optional_1 = require("typescript-optional");
+/**
+ * Excepting signaling that there is functionality that is supposed
+ * to be implemented in case the exception is thrown.
+ *
+ * This is helpful for writing prototypes and not yet handling all possible cases.
+ */
+class ImplementMeException extends Error {
+    constructor(implementMeFor) {
+        super('Implement me!');
+        this._implementMeFor = typescript_optional_1.Optional.ofNullable(implementMeFor);
+    }
+    get message() {
+        if (this._implementMeFor.isPresent()) {
+            return `Implement me for: ${this._implementMeFor.get()}`;
+        }
+        else {
+            return 'Implement me!';
+        }
+    }
+}
+exports.ImplementMeException = ImplementMeException;
+/**
+ * Exception signaling that the application is in an invalid state.
+ */
+class IllegalStateException extends Error {
+}
+exports.IllegalStateException = IllegalStateException;
+/**
+ * Exception signaling that an invalid argument has been passed for a parameter.
+ */
+class IllegalArgumentException extends Error {
+}
+exports.IllegalArgumentException = IllegalArgumentException;
+/**
+ * Exception signaling that a component is mis-configured.
+ */
+class InvalidConfigurationException extends Error {
+}
+exports.InvalidConfigurationException = InvalidConfigurationException;
+//# sourceMappingURL=Exceptions.js.map

package/lib/Exceptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Exceptions.js","sourceRoot":"","sources":["../src/Exceptions.ts"],"names":[],"mappings":";;;AAAA,6DAA+C;AAE/C;;;;;GAKG;AACH,MAAa,oBAAqB,SAAQ,KAAK;IAG9C,YAAY,cAAuB;QAClC,KAAK,CAAC,eAAe,CAAC,CAAC;QACvB,IAAI,CAAC,eAAe,GAAG,8BAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,OAAO;QACV,IAAI,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,EAAE;YACrC,OAAO,qBAAqB,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC;SACzD;aAAM;YACN,OAAO,eAAe,CAAC;SACvB;IACF,CAAC;CACD;AAfD,oDAeC;AAED;;GAEG;AACH,MAAa,qBAAsB,SAAQ,KAAK;CAAG;AAAnD,sDAAmD;AAEnD;;GAEG;AACH,MAAa,wBAAyB,SAAQ,KAAK;CAAG;AAAtD,4DAAsD;AAEtD;;GAEG;AACH,MAAa,6BAA8B,SAAQ,KAAK;CAAG;AAA3D,sEAA2D"}

package/lib/Strings.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Remove the given prefix, if present, from the given string.
+ *
+ * @param prefix - The prefix to remove.
+ * @param removeFrom - The string to remove the prefix from.
+ *
+ * @returns a new string where the prefix is removed.
+ */
+export declare function removePrefix(prefix: string, removeFrom: string): string;
+//# sourceMappingURL=Strings.d.ts.map

package/lib/Strings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Strings.d.ts","sourceRoot":"","sources":["../src/Strings.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAKvE"}

package/lib/Strings.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removePrefix = void 0;
+/**
+ * Remove the given prefix, if present, from the given string.
+ *
+ * @param prefix - The prefix to remove.
+ * @param removeFrom - The string to remove the prefix from.
+ *
+ * @returns a new string where the prefix is removed.
+ */
+function removePrefix(prefix, removeFrom) {
+    if (removeFrom.startsWith(prefix)) {
+        return removeFrom.substring(prefix.length);
+    }
+    return removeFrom;
+}
+exports.removePrefix = removePrefix;
+//# sourceMappingURL=Strings.js.map

package/lib/Strings.js.map

@@ -0,0 +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;QAClC,OAAO,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;KAC3C;IACD,OAAO,UAAU,CAAC;AACnB,CAAC;AALD,oCAKC"}

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+/** Exports of this Node package / module */
+export * from './Contract';
+export * from './Exceptions';
+export * from './Strings';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +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"}

package/lib/index.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cqse/commons",
-  "version": "0.0.1-beta.25",
+  "version": "0.0.1-beta.29",
   "description": "A collection of generic functionality for TypeScript projects.",
   "author": "CQSE GmbH",
   "main": "lib/index.js",
@@ -10,7 +10,8 @@
     "url": "https://github.com/cqse/teamscale-javascript-profiler.git"
   },
   "files": [
-    "dist/**/*"
+    "dist/**/*",
+    "lib/**/*"
   ],
   "scripts": {
     "build": "tsc",