@nu-art/ts-common 0.105.0 → 0.105.1

package/utils/crypto-tools.js

@@ -0,0 +1,36 @@
+"use strict";
+/*
+ * ts-common is the basic building blocks of our typescript projects
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hashPasswordWithSalt = exports.randomObject = exports.randomNumber = void 0;
+var crypto_1 = require("crypto");
+function randomNumber(range) {
+    return Math.floor(Math.random() * (range));
+}
+exports.randomNumber = randomNumber;
+function randomObject(items) {
+    return items[randomNumber(items.length)];
+}
+exports.randomObject = randomObject;
+function hashPasswordWithSalt(salt, password) {
+    return (0, crypto_1.createHmac)('sha512', salt)
+        .update(password)
+        .digest('hex');
+}
+exports.hashPasswordWithSalt = hashPasswordWithSalt;
+//# sourceMappingURL=crypto-tools.js.map

package/utils/crypto-tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto-tools.js","sourceRoot":"","sources":["../../src/main/utils/crypto-tools.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;AAEH,iCAAkC;AAElC,SAAgB,YAAY,CAAC,KAAa;IACzC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAA;AAC3C,CAAC;AAFD,oCAEC;AAED,SAAgB,YAAY,CAAI,KAAU;IACzC,OAAO,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;AAC1C,CAAC;AAFD,oCAEC;AAED,SAAgB,oBAAoB,CAAC,IAAqB,EAAE,QAAyB;IACpF,OAAO,IAAA,mBAAU,EAAC,QAAQ,EAAE,IAAI,CAAC;SAC/B,MAAM,CAAC,QAAQ,CAAC;SAChB,MAAM,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC;AAJD,oDAIC"}

package/utils/date-time-tools.d.ts

@@ -0,0 +1,28 @@
+import { AuditBy, Timestamp } from './types';
+export declare const Second = 1000;
+export declare const Minute: number;
+export declare const Hour: number;
+export declare const Day: number;
+export declare const Week: number;
+export declare const Format_HHmmss_DDMMYYYY = "HH:mm:ss_DD-MM-YYYY";
+export declare const Format_YYYYMMDD_HHmmss = "YYYY-MM-DD_HH:mm:ss";
+export type Weekday = 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday';
+export declare const Weekdays: Weekday[];
+export type TimerHandler = (...args: any[]) => void;
+export declare function timeout(sleepMs: number): Promise<unknown>;
+export declare function _setTimeout(handler: TimerHandler, sleepMs?: number, ...args: any[]): number;
+export declare function _clearTimeout(handlerId?: number): void;
+export declare function _setInterval(handler: TimerHandler, sleepMs?: number, ...args: any[]): number;
+export declare function _clearInterval(handlerId?: number): void;
+export declare function auditBy(user: string, comment?: string, timestamp?: number): AuditBy;
+export declare function currentTimeMillis(): number;
+export declare function specificTimeTodayMillis(hours: number, minutes: number): number;
+export declare function currentLocalTimeMillis(): number;
+export declare function currentTimeMillisWithTimeZone(): number;
+export declare function createReadableTimestampObject(pattern?: string, timestamp?: number, timezone?: string): Timestamp;
+/**
+ * For detailed list of formats visit https://momentjs.com/docs/#/displaying/format/
+ */
+export declare function formatTimestamp(pattern?: string, timestamp?: number, timezone?: string): string;
+export declare function parseTimeString(timestamp: string, pattern?: string): number;
+export declare function normalizeTimestamp(timestamp: number, pattern: string): number;

package/utils/date-time-tools.js

@@ -0,0 +1,180 @@
+"use strict";
+/*
+ * ts-common is the basic building blocks of our typescript projects
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeTimestamp = exports.parseTimeString = exports.formatTimestamp = exports.createReadableTimestampObject = exports.currentTimeMillisWithTimeZone = exports.currentLocalTimeMillis = exports.specificTimeTodayMillis = exports.currentTimeMillis = exports.auditBy = exports._clearInterval = exports._setInterval = exports._clearTimeout = exports._setTimeout = exports.timeout = exports.Weekdays = exports.Format_YYYYMMDD_HHmmss = exports.Format_HHmmss_DDMMYYYY = exports.Week = exports.Day = exports.Hour = exports.Minute = exports.Second = void 0;
+var moment = require("moment");
+exports.Second = 1000;
+exports.Minute = exports.Second * 60;
+exports.Hour = exports.Minute * 60;
+exports.Day = exports.Hour * 24;
+exports.Week = exports.Day * 7;
+exports.Format_HHmmss_DDMMYYYY = 'HH:mm:ss_DD-MM-YYYY';
+exports.Format_YYYYMMDD_HHmmss = 'YYYY-MM-DD_HH:mm:ss';
+exports.Weekdays = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'];
+function timeout(sleepMs) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, new Promise(function (resolve) { return setTimeout(resolve, sleepMs, undefined); })];
+        });
+    });
+}
+exports.timeout = timeout;
+function _setTimeout(handler, sleepMs) {
+    if (sleepMs === void 0) { sleepMs = 0; }
+    var args = [];
+    for (var _i = 2; _i < arguments.length; _i++) {
+        args[_i - 2] = arguments[_i];
+    }
+    return setTimeout.apply(void 0, __spreadArray([handler, sleepMs], args, false));
+}
+exports._setTimeout = _setTimeout;
+function _clearTimeout(handlerId) {
+    if (!handlerId)
+        return;
+    return clearTimeout(handlerId);
+}
+exports._clearTimeout = _clearTimeout;
+function _setInterval(handler, sleepMs) {
+    if (sleepMs === void 0) { sleepMs = 0; }
+    var args = [];
+    for (var _i = 2; _i < arguments.length; _i++) {
+        args[_i - 2] = arguments[_i];
+    }
+    return setInterval.apply(void 0, __spreadArray([handler, sleepMs], args, false));
+}
+exports._setInterval = _setInterval;
+function _clearInterval(handlerId) {
+    if (!handlerId)
+        return;
+    return clearInterval(handlerId);
+}
+exports._clearInterval = _clearInterval;
+function auditBy(user, comment, timestamp) {
+    if (timestamp === void 0) { timestamp = currentTimeMillis(); }
+    var _auditBy = {
+        auditBy: user,
+        auditAt: createReadableTimestampObject(exports.Format_HHmmss_DDMMYYYY, timestamp)
+    };
+    if (comment)
+        _auditBy.comment = comment;
+    return _auditBy;
+}
+exports.auditBy = auditBy;
+function currentTimeMillis() {
+    var date = new Date();
+    return date.getTime();
+}
+exports.currentTimeMillis = currentTimeMillis;
+function specificTimeTodayMillis(hours, minutes) {
+    var date = new Date();
+    date.setHours(hours);
+    date.setMinutes(minutes);
+    return date.getTime();
+}
+exports.specificTimeTodayMillis = specificTimeTodayMillis;
+function currentLocalTimeMillis() {
+    var date = new Date();
+    return date.getTime();
+}
+exports.currentLocalTimeMillis = currentLocalTimeMillis;
+function currentTimeMillisWithTimeZone() {
+    var date = new Date();
+    return date.getTime() + date.getTimezoneOffset();
+}
+exports.currentTimeMillisWithTimeZone = currentTimeMillisWithTimeZone;
+function createReadableTimestampObject(pattern, timestamp, timezone) {
+    if (pattern === void 0) { pattern = exports.Format_HHmmss_DDMMYYYY; }
+    if (timestamp === void 0) { timestamp = currentTimeMillis(); }
+    var timeObj = {
+        timestamp: timestamp,
+        pretty: formatTimestamp(pattern, timestamp)
+    };
+    if (timezone)
+        timeObj.timezone = timezone;
+    return timeObj;
+}
+exports.createReadableTimestampObject = createReadableTimestampObject;
+/**
+ * For detailed list of formats visit https://momentjs.com/docs/#/displaying/format/
+ */
+function formatTimestamp(pattern, timestamp, timezone) {
+    if (pattern === void 0) { pattern = exports.Format_HHmmss_DDMMYYYY; }
+    if (timestamp === void 0) { timestamp = currentTimeMillis(); }
+    if (timezone === void 0) { timezone = Intl.DateTimeFormat()
+        .resolvedOptions().timeZone; }
+    var m = moment.utc(timestamp);
+    m.utcOffset(-new Date().getTimezoneOffset());
+    return m.format(pattern);
+}
+exports.formatTimestamp = formatTimestamp;
+function parseTimeString(timestamp, pattern) {
+    if (pattern === void 0) { pattern = exports.Format_HHmmss_DDMMYYYY; }
+    return moment.utc(timestamp, pattern).valueOf();
+}
+exports.parseTimeString = parseTimeString;
+function normalizeTimestamp(timestamp, pattern) {
+    return parseTimeString(formatTimestamp(pattern, timestamp), pattern);
+}
+exports.normalizeTimestamp = normalizeTimestamp;
+//# sourceMappingURL=date-time-tools.js.map

package/utils/date-time-tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-time-tools.js","sourceRoot":"","sources":["../../src/main/utils/date-time-tools.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,+BAAiC;AAIpB,QAAA,MAAM,GAAG,IAAI,CAAC;AACd,QAAA,MAAM,GAAG,cAAM,GAAG,EAAE,CAAC;AACrB,QAAA,IAAI,GAAG,cAAM,GAAG,EAAE,CAAC;AACnB,QAAA,GAAG,GAAG,YAAI,GAAG,EAAE,CAAC;AAChB,QAAA,IAAI,GAAG,WAAG,GAAG,CAAC,CAAC;AAEf,QAAA,sBAAsB,GAAG,qBAAqB,CAAC;AAC/C,QAAA,sBAAsB,GAAG,qBAAqB,CAAC;AAE/C,QAAA,QAAQ,GAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AAGlH,SAAsB,OAAO,CAAC,OAAe;;;YAC5C,sBAAO,IAAI,OAAO,CAAC,UAAA,OAAO,IAAI,OAAA,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,EAAvC,CAAuC,CAAC,EAAC;;;CACvE;AAFD,0BAEC;AAED,SAAgB,WAAW,CAAC,OAAqB,EAAE,OAAW;IAAX,wBAAA,EAAA,WAAW;IAAE,cAAc;SAAd,UAAc,EAAd,qBAAc,EAAd,IAAc;QAAd,6BAAc;;IAC7E,OAAO,UAAU,8BAAC,OAAO,EAAE,OAAO,GAAK,IAAI,SAAsB,CAAC;AACnE,CAAC;AAFD,kCAEC;AAED,SAAgB,aAAa,CAAC,SAAkB;IAC/C,IAAI,CAAC,SAAS;QACb,OAAO;IACR,OAAO,YAAY,CAAC,SAAqD,CAAC,CAAC;AAC5E,CAAC;AAJD,sCAIC;AAED,SAAgB,YAAY,CAAC,OAAqB,EAAE,OAAW;IAAX,wBAAA,EAAA,WAAW;IAAE,cAAc;SAAd,UAAc,EAAd,qBAAc,EAAd,IAAc;QAAd,6BAAc;;IAC9E,OAAO,WAAW,8BAAC,OAAO,EAAE,OAAO,GAAK,IAAI,SAAsB,CAAC;AACpE,CAAC;AAFD,oCAEC;AAED,SAAgB,cAAc,CAAC,SAAkB;IAChD,IAAI,CAAC,SAAS;QACb,OAAO;IACR,OAAO,aAAa,CAAC,SAAsD,CAAC,CAAC;AAC9E,CAAC;AAJD,wCAIC;AAED,SAAgB,OAAO,CAAC,IAAY,EAAE,OAAgB,EAAE,SAAuC;IAAvC,0BAAA,EAAA,YAAoB,iBAAiB,EAAE;IAC9F,IAAM,QAAQ,GAAY;QACzB,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,6BAA6B,CAAC,8BAAsB,EAAE,SAAS,CAAC;KACzE,CAAC;IAEF,IAAI,OAAO;QACV,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;IAC5B,OAAO,QAAQ,CAAC;AACjB,CAAC;AATD,0BASC;AAED,SAAgB,iBAAiB;IAChC,IAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IACxB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;AACvB,CAAC;AAHD,8CAGC;AAED,SAAgB,uBAAuB,CAAC,KAAa,EAAE,OAAe;IACrE,IAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IACxB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACzB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;AACvB,CAAC;AALD,0DAKC;AAED,SAAgB,sBAAsB;IACrC,IAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IACxB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;AACvB,CAAC;AAHD,wDAGC;AAED,SAAgB,6BAA6B;IAC5C,IAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IACxB,OAAO,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;AAClD,CAAC;AAHD,sEAGC;AAED,SAAgB,6BAA6B,CAAC,OAAwC,EAAE,SAAuC,EAAE,QAAiB;IAApG,wBAAA,EAAA,UAAkB,8BAAsB;IAAE,0BAAA,EAAA,YAAoB,iBAAiB,EAAE;IAE9H,IAAM,OAAO,GAAc;QAC1B,SAAS,EAAE,SAAS;QACpB,MAAM,EAAE,eAAe,CAAC,OAAO,EAAE,SAAS,CAAC;KAC3C,CAAC;IAEF,IAAI,QAAQ;QACX,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAE7B,OAAO,OAAO,CAAC;AAChB,CAAC;AAXD,sEAWC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,OAAwC,EAAE,SAAuC,EAAE,QACvF;IADI,wBAAA,EAAA,UAAkB,8BAAsB;IAAE,0BAAA,EAAA,YAAoB,iBAAiB,EAAE;IAAE,yBAAA,EAAA,WAAmB,IAAI,CAAC,cAAc,EAAE;SACzJ,eAAe,EAAE,CAAC,QAAQ;IAC3B,IAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAChC,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC7C,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAC1B,CAAC;AALD,0CAKC;AAED,SAAgB,eAAe,CAAC,SAAiB,EAAE,OAAwC;IAAxC,wBAAA,EAAA,UAAkB,8BAAsB;IAC1F,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;AACjD,CAAC;AAFD,0CAEC;AAED,SAAgB,kBAAkB,CAAC,SAAiB,EAAE,OAAe;IACpE,OAAO,eAAe,CAAC,eAAe,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;AACtE,CAAC;AAFD,gDAEC"}

package/utils/db-object-tools.d.ts

@@ -0,0 +1,3 @@
+import { DB_Object } from './types';
+export declare const KeysOfDB_Object: (keyof DB_Object)[];
+export declare function dbObjectToId(i: DB_Object): string;

package/utils/db-object-tools.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dbObjectToId = exports.KeysOfDB_Object = void 0;
+exports.KeysOfDB_Object = ['_id', '_v', '__created', '__updated'];
+function dbObjectToId(i) {
+    return i._id;
+}
+exports.dbObjectToId = dbObjectToId;
+//# sourceMappingURL=db-object-tools.js.map

package/utils/db-object-tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"db-object-tools.js","sourceRoot":"","sources":["../../src/main/utils/db-object-tools.ts"],"names":[],"mappings":";;;AAGa,QAAA,eAAe,GAAwB,CAAC,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;AAE5F,SAAgB,YAAY,CAAC,CAAY;IACxC,OAAO,CAAC,CAAC,GAAG,CAAC;AACd,CAAC;AAFD,oCAEC"}

package/utils/filter-tools.d.ts

@@ -0,0 +1,137 @@
+/**
+ * # Filter
+ *
+ * ## <ins>Intro:</ins>
+ *
+ * A filter tool for filtering a collection or testing items by comparing string values</br>
+ * This tool aims to simplify filtering arrays of strings or objects containing string fields
+ * by defining which fields are tested (via a mapper function) testing those fields against a string
+ *
+ * ## <ins>Example data:</ins>
+ *
+ * type T in the following examples will be:
+ *
+ * ```js
+ * type T = {
+ *   name: string;
+ * }
+ * ```
+ *
+ * items:
+ * ```js
+ * const item1: T = {name: 'Matan'};
+ * const item2: T = {name: 'Adam'};
+ * const item3: T = {name: 'Itay'};
+ * const items: T[] = [item1, item2, item3];
+ * ```
+ */
+export declare class Filter<T> {
+    private regexp;
+    private readonly mapper;
+    private originFilterText?;
+    private _filter;
+    static translateStringToRegexFilter: (filter: string, regexp: boolean) => RegExp;
+    /**
+     * Returns an instance of a filter, where the tested fields are the one provided by the mapper.
+     *
+     * @param mapper a function that returns a string array
+     *
+     * @return
+     *
+     * #### <ins>Usage:</ins>
+     * ```js
+     * //Prepares a filter instance where tests are run on the item.name
+     * const filter = new Filter<T>((item)=>[item.name]);
+     * ```
+     */
+    constructor(mapper: (item: T) => string[]);
+    /**
+     * A function to set the Filter.regexp boolean flag
+     *
+     * @param regexp
+     * </br>
+     * @returns - the Filter instance
+     * </br></br>
+     *
+     * #### <ins>Usage:</ins>
+     * ```js
+     * const filter = new Filter().setRegexp(false);
+     * ```
+     *
+     */
+    setRegexp(regexp: boolean): this;
+    /**
+     * A function returning a boolean value for if the item passes the filter</br>
+     * The function checks the item fields (based on the mapper given when the Filter instance was created) against the filterText argument
+     *
+     * @param item The item to check
+     * @param filterText A string to filter by
+     *
+     * @return
+     *
+     * </br>
+     *
+     * #### <ins>Usage:</ins>
+     * ```js
+     * const item: T = {name: 'Matan'}
+     *
+     * //Will print 'true'
+     * console.log(filter.filterItem(item, 'Matan'))
+     *
+     * //Will print 'false'
+     * console.log(filter.filterItem(item, 'Adam'))
+     * ```
+     */
+    filterItem(item: T, filterText: string): boolean;
+    /**
+     * A function returning an array of items that pass the filter</br>
+     * The function checks each item's fields (based on the mapper given when the Filter instance was created) against the filterText argument.
+     *
+     * @param items An array of items to check
+     * @param filterText - A string to filter by
+     *
+     * @return
+     *
+     * </br>
+     *
+     * #### <ins>Usage:</ins>
+     * ```js
+     * //Will return [item2]
+     * const filteredItems = filter.filter(items,'Adam');
+     * ```
+     */
+    filter(items: T[], filterText: string): T[];
+    filterSort(items: T[], filterText: string): T[];
+    /**
+     * A function return a boolean value as to if any of the item fields passes the Filter._filter</br>
+     * Regular expression set by the "setRegexp" function.</br>
+     * This function serves as a "default mapper" to pass to a prototype.filter function instead of using this Filter functionality.
+     *
+     * @param item The item to check
+     *
+     * @return
+     *
+     * #### <ins>Usage:</ins>
+     * ```js
+     * const filter = new Filter();
+     *
+     * filter.prepareFilter('REGEX');
+     *
+     * const filteredItems = [item1,item2,item3].filter(filter.filterImpl);
+     * ```
+     */
+    filterImpl: (item: T) => boolean;
+    /**
+     * A function that sets the Filter instance's filter text and regex.
+     *
+     * @param filter a filter string
+     *
+     * @returns - the Filter instance
+     *
+     * #### <ins>Usage:</ins>
+     * ```js
+     * const filter = new Filter().prepareFilter('REGEX');
+     * ```
+     */
+    prepareFilter(filter?: string): this;
+}

package/utils/filter-tools.js

@@ -0,0 +1,217 @@
+"use strict";
+/*
+ * ts-common is the basic building blocks of our typescript projects
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Filter = void 0;
+var array_tools_1 = require("./array-tools");
+var specialChars = ['(', ')', '?', '[', ']', '*', '\\', '/'];
+/**
+ * # Filter
+ *
+ * ## <ins>Intro:</ins>
+ *
+ * A filter tool for filtering a collection or testing items by comparing string values</br>
+ * This tool aims to simplify filtering arrays of strings or objects containing string fields
+ * by defining which fields are tested (via a mapper function) testing those fields against a string
+ *
+ * ## <ins>Example data:</ins>
+ *
+ * type T in the following examples will be:
+ *
+ * ```js
+ * type T = {
+ *   name: string;
+ * }
+ * ```
+ *
+ * items:
+ * ```js
+ * const item1: T = {name: 'Matan'};
+ * const item2: T = {name: 'Adam'};
+ * const item3: T = {name: 'Itay'};
+ * const items: T[] = [item1, item2, item3];
+ * ```
+ */
+var Filter = /** @class */ (function () {
+    /**
+     * Returns an instance of a filter, where the tested fields are the one provided by the mapper.
+     *
+     * @param mapper a function that returns a string array
+     *
+     * @return
+     *
+     * #### <ins>Usage:</ins>
+     * ```js
+     * //Prepares a filter instance where tests are run on the item.name
+     * const filter = new Filter<T>((item)=>[item.name]);
+     * ```
+     */
+    function Filter(mapper) {
+        var _this = this;
+        this.regexp = true;
+        /**
+         * A function return a boolean value as to if any of the item fields passes the Filter._filter</br>
+         * Regular expression set by the "setRegexp" function.</br>
+         * This function serves as a "default mapper" to pass to a prototype.filter function instead of using this Filter functionality.
+         *
+         * @param item The item to check
+         *
+         * @return
+         *
+         * #### <ins>Usage:</ins>
+         * ```js
+         * const filter = new Filter();
+         *
+         * filter.prepareFilter('REGEX');
+         *
+         * const filteredItems = [item1,item2,item3].filter(filter.filterImpl);
+         * ```
+         */
+        this.filterImpl = function (item) {
+            var keysToFilter = _this.mapper(item);
+            for (var _i = 0, keysToFilter_1 = keysToFilter; _i < keysToFilter_1.length; _i++) {
+                var key = keysToFilter_1[_i];
+                if (key.toLowerCase().match(_this._filter))
+                    return true;
+            }
+            return false;
+        };
+        this.mapper = mapper;
+    }
+    /**
+     * A function to set the Filter.regexp boolean flag
+     *
+     * @param regexp
+     * </br>
+     * @returns - the Filter instance
+     * </br></br>
+     *
+     * #### <ins>Usage:</ins>
+     * ```js
+     * const filter = new Filter().setRegexp(false);
+     * ```
+     *
+     */
+    Filter.prototype.setRegexp = function (regexp) {
+        this.regexp = regexp;
+        delete this.originFilterText;
+        return this;
+    };
+    /**
+     * A function returning a boolean value for if the item passes the filter</br>
+     * The function checks the item fields (based on the mapper given when the Filter instance was created) against the filterText argument
+     *
+     * @param item The item to check
+     * @param filterText A string to filter by
+     *
+     * @return
+     *
+     * </br>
+     *
+     * #### <ins>Usage:</ins>
+     * ```js
+     * const item: T = {name: 'Matan'}
+     *
+     * //Will print 'true'
+     * console.log(filter.filterItem(item, 'Matan'))
+     *
+     * //Will print 'false'
+     * console.log(filter.filterItem(item, 'Adam'))
+     * ```
+     */
+    Filter.prototype.filterItem = function (item, filterText) {
+        this.prepareFilter(filterText);
+        return this.filterImpl(item);
+    };
+    /**
+     * A function returning an array of items that pass the filter</br>
+     * The function checks each item's fields (based on the mapper given when the Filter instance was created) against the filterText argument.
+     *
+     * @param items An array of items to check
+     * @param filterText - A string to filter by
+     *
+     * @return
+     *
+     * </br>
+     *
+     * #### <ins>Usage:</ins>
+     * ```js
+     * //Will return [item2]
+     * const filteredItems = filter.filter(items,'Adam');
+     * ```
+     */
+    Filter.prototype.filter = function (items, filterText) {
+        this.prepareFilter(filterText);
+        return items.filter(this.filterImpl);
+    };
+    Filter.prototype.filterSort = function (items, filterText) {
+        var _this = this;
+        this.prepareFilter(filterText);
+        var text = filterText.toLowerCase();
+        var filteredItems = items.filter(this.filterImpl);
+        return (0, array_tools_1.sortArray)(filteredItems, function (item) {
+            var values = _this.mapper(item).map(function (value) { return value.toLowerCase(); });
+            //Exact Match
+            if (values.includes(text)) {
+                return 0;
+            }
+            for (var _i = 0, values_1 = values; _i < values_1.length; _i++) {
+                var value = values_1[_i];
+                if (value.includes(text)) {
+                    return 1;
+                }
+            }
+            return 2;
+        });
+    };
+    /**
+     * A function that sets the Filter instance's filter text and regex.
+     *
+     * @param filter a filter string
+     *
+     * @returns - the Filter instance
+     *
+     * #### <ins>Usage:</ins>
+     * ```js
+     * const filter = new Filter().prepareFilter('REGEX');
+     * ```
+     */
+    Filter.prototype.prepareFilter = function (filter) {
+        if (this.originFilterText === filter)
+            return this;
+        this._filter = Filter.translateStringToRegexFilter(filter || '', this.regexp);
+        this.originFilterText = filter;
+        return this;
+    };
+    Filter.translateStringToRegexFilter = function (filter, regexp) {
+        filter = (filter || '').trim();
+        filter = filter.toLowerCase();
+        filter = filter.replace(/\s+/, ' ');
+        if (regexp) {
+            filter = Array.from(filter).map(function (char) { return specialChars.includes(char) ? ".*?\\".concat(char) : ".*?".concat(char); }).join('');
+        }
+        else {
+            filter = ".*?".concat(filter);
+        }
+        filter.length === 0 ? filter = '.*?' : filter += '.*';
+        return new RegExp(filter);
+    };
+    return Filter;
+}());
+exports.Filter = Filter;
+//# sourceMappingURL=filter-tools.js.map

package/utils/filter-tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-tools.js","sourceRoot":"","sources":["../../src/main/utils/filter-tools.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;AAGH,6CAAwC;AAExC,IAAM,YAAY,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH;IAsBC;;;;;;;;;;;;OAYG;IACH,gBAAY,MAA6B;QAAzC,iBAEC;QApCO,WAAM,GAAG,IAAI,CAAC;QAkItB;;;;;;;;;;;;;;;;;WAiBG;QACH,eAAU,GAAG,UAAC,IAAO;YACpB,IAAM,YAAY,GAAG,KAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACvC,KAAkB,UAAY,EAAZ,6BAAY,EAAZ,0BAAY,EAAZ,IAAY,EAAE;gBAA3B,IAAM,GAAG,qBAAA;gBACb,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,KAAI,CAAC,OAAO,CAAC;oBACxC,OAAO,IAAI,CAAC;aACb;YAED,OAAO,KAAK,CAAC;QACd,CAAC,CAAC;QAzHD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,0BAAS,GAAT,UAAU,MAAe;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC,gBAAgB,CAAC;QAC7B,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,2BAAU,GAAV,UAAW,IAAO,EAAE,UAAkB;QACrC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IAEH,uBAAM,GAAN,UAAO,KAAU,EAAE,UAAkB;QACpC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC/B,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAED,2BAAU,GAAV,UAAW,KAAU,EAAE,UAAkB;QAAzC,iBAoBC;QAnBA,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC/B,IAAM,IAAI,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;QAEtC,IAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpD,OAAO,IAAA,uBAAS,EAAC,aAAa,EAAE,UAAA,IAAI;YACnC,IAAM,MAAM,GAAG,KAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,WAAW,EAAE,EAAnB,CAAmB,CAAC,CAAC;YACnE,aAAa;YACb,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAC1B,OAAO,CAAC,CAAC;aACT;YAED,KAAoB,UAAM,EAAN,iBAAM,EAAN,oBAAM,EAAN,IAAM,EAAE;gBAAvB,IAAM,KAAK,eAAA;gBACf,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;oBACzB,OAAO,CAAC,CAAC;iBACT;aACD;YACD,OAAO,CAAC,CAAC;QACV,CAAC,CAAC,CAAC;IACJ,CAAC;IA8BD;;;;;;;;;;;OAWG;IACH,8BAAa,GAAb,UAAc,MAAe;QAC5B,IAAI,IAAI,CAAC,gBAAgB,KAAK,MAAM;YACnC,OAAO,IAAI,CAAC;QAEb,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,4BAA4B,CAAC,MAAM,IAAI,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9E,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC;IACb,CAAC;IA3KM,mCAA4B,GAAG,UAAC,MAAc,EAAE,MAAe;QACrE,MAAM,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC/B,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;QAC9B,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAEpC,IAAI,MAAM,EAAE;YACX,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAQ,IAAI,CAAE,CAAC,CAAC,CAAC,aAAM,IAAI,CAAE,EAA3D,CAA2D,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SAC9G;aAAM;YACN,MAAM,GAAG,aAAM,MAAM,CAAE,CAAC;SACxB;QAED,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC;QACtD,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC,CAAC;IA+JH,aAAC;CAAA,AAnLD,IAmLC;AAnLY,wBAAM"}

package/utils/hash-tools.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+export declare function md5(toBeConverted: any): string;
+export declare function sha1(toBeConverted: any): string;
+export declare function sha256(toBeConverted: any): string;
+export declare function sha384(toBeConverted: any): string;
+export declare function sha512(toBeConverted: any): string;
+export declare function encode(data: string | number | Buffer, encoding?: BufferEncoding): string;
+export declare function decode(encoded: string, from?: BufferEncoding, to?: BufferEncoding): string;