@cyberismo/data-handler 0.0.2

package/dist/utils/lexorank.js

@@ -0,0 +1,159 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+const ALPHABET = 'abcdefghijklmnopqrstuvwxyz';
+const ALPHABET_SIZE = ALPHABET.length;
+const PREFIX = '0|'; // prefix to allow easy addition of buckets later if required
+export const FIRST_RANK = PREFIX + ALPHABET[0];
+export const LAST_RANK = PREFIX + ALPHABET[ALPHABET_SIZE - 1];
+export const EMPTY_RANK = `1|${ALPHABET[0]}`; // rank to be used when no rank is available
+/**
+ * Convert a number to base 26
+ * @param num number to convert to base 26
+ * @returns the string representation of the number in base 26
+ */
+export function enbase(num) {
+    if (num === 0)
+        return ALPHABET[0];
+    let result = '';
+    while (num > 0) {
+        result =
+            String.fromCharCode(ALPHABET.charCodeAt(0) + (num % ALPHABET_SIZE)) +
+                result;
+        num = Math.floor(num / ALPHABET_SIZE);
+    }
+    return result;
+}
+/**
+ * Convert a rank to a number
+ * @param str rank to convert to a number
+ * @returns the number representation of the rank
+ */
+export function debase(str) {
+    let result = 0;
+    for (let i = 0; i < str.length; i++) {
+        result +=
+            (str.charCodeAt(i) - ALPHABET.charCodeAt(0)) *
+                Math.pow(ALPHABET_SIZE, str.length - i - 1);
+    }
+    return result;
+}
+/**
+ * Returns the next available rank after the given rank
+ * @param rank rank to get the next rank after
+ * @returns the next available rank after the given rank
+ */
+export function getRankAfter(rank) {
+    rank = rank.replace(PREFIX, '');
+    let num = debase(rank);
+    num++;
+    const newRank = enbase(num);
+    if (newRank.length > rank.length) {
+        return PREFIX + rank + ALPHABET[ALPHABET_SIZE / 2];
+    }
+    return PREFIX + newRank;
+}
+/**
+ * Returns the previous available rank before the given rank
+ * if the rank is already the first rank, it throws an error
+ * @param rank rank to get the previous rank before
+ * @returns the previous available rank before the given rank
+ */
+export function getRankBefore(rank) {
+    rank = rank.replace(PREFIX, '');
+    let num = debase(rank);
+    num--;
+    if (num < 0) {
+        throw new Error('Rank cannot be negative');
+    }
+    return PREFIX + enbase(num);
+}
+/**
+ * Get the rank between two ranks
+ * Rank is a string that represents a number in base 26
+ * Rank must be a string of lowercase letters
+ * @param rank1 first rank
+ * @param rank2 second rank
+ * @returns the rank between the two ranks
+ */
+export function getRankBetween(rank1, rank2) {
+    // must be padded for the comparison
+    rank1 = rank1.replace(PREFIX, '');
+    rank2 = rank2.replace(PREFIX, '');
+    const length = Math.max(rank1.length, rank2.length);
+    // padding with 'a' to make the ranks equal length
+    // since comparison is done lexicographically
+    // it does not effect the comparison
+    const paddedRank1 = rank1.padEnd(length, ALPHABET[0]);
+    const paddedRank2 = rank2.padEnd(length, ALPHABET[0]);
+    const num1 = debase(paddedRank1);
+    const num2 = debase(paddedRank2);
+    if (num1 >= num2) {
+        throw new Error('Rank1 must be smaller than rank2');
+    }
+    const res = enbase(Math.floor((num1 + num2) / 2)).padStart(length, ALPHABET[0]);
+    if (res !== paddedRank1 && res !== paddedRank2) {
+        return PREFIX + res;
+    }
+    return PREFIX + res + ALPHABET[ALPHABET_SIZE / 2];
+}
+/**
+ * Rebalance the ranks so that the distance between each rank is equal
+ * @param rankAmount number of ranks to rebalance
+ * @returns rebalanced ranks
+ */
+export function rebalanceRanks(rankAmount) {
+    if (rankAmount === 0)
+        return [];
+    if (rankAmount === 1)
+        return [FIRST_RANK];
+    const requiredLevels = Math.ceil(Math.log(rankAmount) / Math.log(ALPHABET_SIZE));
+    // set minumum rank consisting of all 'a's and maximum rank consisting of all 'z's
+    const minRank = ALPHABET[0].repeat(requiredLevels);
+    const maxRank = ALPHABET[ALPHABET_SIZE - 1].repeat(requiredLevels);
+    // step size determines the distance between each rank
+    const stepSize = Math.floor(debase(maxRank) / (rankAmount - 1));
+    const ranks = [];
+    for (let i = 0; i < rankAmount; i++) {
+        if (i === 0) {
+            ranks.push(PREFIX + minRank);
+        }
+        else if (i === rankAmount - 1) {
+            ranks.push(PREFIX + maxRank);
+        }
+        else {
+            const rank = debase(minRank) + stepSize * i;
+            ranks.push(PREFIX + enbase(rank));
+        }
+    }
+    return ranks;
+}
+/**
+ * Sort items based on lexorank
+ * @param items items to sort
+ * @param rankGetter should return the lexorank of the item
+ * @returns sorted items
+ */
+export function sortItems(items, rankGetter) {
+    if (items.length === 0)
+        return items;
+    return items.sort((a, b) => compare(rankGetter(a), rankGetter(b)));
+}
+/**
+ * default compare function
+ * @param a first string
+ * @param b second string
+ * @returns -1 if a < b, 0 if a === b, 1 if a > b
+ */
+export function compare(a, b) {
+    return a.localeCompare(b);
+}
+//# sourceMappingURL=lexorank.js.map

package/dist/utils/lexorank.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexorank.js","sourceRoot":"","sources":["../../src/utils/lexorank.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AACF,MAAM,QAAQ,GAAG,4BAA4B,CAAC;AAC9C,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC;AAEtC,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,6DAA6D;AAElF,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;AAC/C,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,GAAG,QAAQ,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;AAE9D,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,4CAA4C;AAI1F;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,GAAW;IAChC,IAAI,GAAG,KAAK,CAAC;QAAE,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;IAElC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,OAAO,GAAG,GAAG,CAAC,EAAE,CAAC;QACf,MAAM;YACJ,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,aAAa,CAAC,CAAC;gBACnE,MAAM,CAAC;QACT,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,aAAa,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,GAAW;IAChC,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,MAAM;YACJ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBAC5C,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,IAAU;IACrC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAChC,IAAI,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IACvB,GAAG,EAAE,CAAC;IACN,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IAC5B,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACjC,OAAO,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,MAAM,GAAG,OAAO,CAAC;AAC1B,CAAC;AACD;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,IAAU;IACtC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAChC,IAAI,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IACvB,GAAG,EAAE,CAAC;IACN,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa,EAAE,KAAa;IACzD,oCAAoC;IAEpC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAClC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAElC,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpD,kDAAkD;IAClD,6CAA6C;IAC7C,oCAAoC;IAEpC,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAEtD,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAEtD,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;IACjC,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;IAEjC,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACtD,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CACxD,MAAM,EACN,QAAQ,CAAC,CAAC,CAAC,CACZ,CAAC;IACF,IAAI,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;QAC/C,OAAO,MAAM,GAAG,GAAG,CAAC;IACtB,CAAC;IACD,OAAO,MAAM,GAAG,GAAG,GAAG,QAAQ,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;AACpD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,UAAkB;IAC/C,IAAI,UAAU,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAChC,IAAI,UAAU,KAAK,CAAC;QAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1C,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAC9B,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAC/C,CAAC;IACF,kFAAkF;IAClF,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IACnD,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAEnE,sDAAsD;IACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC;IAEhE,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACZ,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QAC/B,CAAC;aAAM,IAAI,CAAC,KAAK,UAAU,GAAG,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,QAAQ,GAAG,CAAC,CAAC;YAC5C,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAI,KAAU,EAAE,UAA+B;IACtE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACrC,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACrE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,CAAS,EAAE,CAAS;IAC1C,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;AAC5B,CAAC"}

package/dist/utils/log-utils.d.ts

@@ -0,0 +1,40 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+import pino from 'pino';
+export declare const logger: pino.Logger<never, boolean>;
+/**
+ * Returns error message string from an Error object.
+ * @param error Error object
+ * @returns Error message.
+ */
+export declare function errorFunction(error: unknown): string;
+/**
+ * Same as 'errorFunction' but can do automatic replacement fof the error message string.
+ * @param message Error message
+ * @param toReplace replacement substring
+ * @param replaceWith string that 'toReplace' is replaced with.
+ * @returns Modified error message.
+ */
+export declare function errorMessage(message: string, toReplace?: string, replaceWith?: string): string;
+/**
+ * Logs error from Error object.
+ * @param error potentially an Error object. When exceptions are raised, they are typically Error objects.
+ */
+export declare function logError(error: unknown): void;
+/**
+ * Log error message in RED. Certain parts of messages can be replaced.
+ * This is useful, if including a message from external sources, and want to reduce the verbosity of the message.
+ * @param message Error message to log.
+ * @param toReplace String to look for.
+ * @param replaceWith Replace 'toReplace' with this. Only replaces first instance of 'toReplace'.
+ */
+export declare function logErrorMessage(message: string, toReplace?: string, replaceWith?: string): void;

package/dist/utils/log-utils.js

@@ -0,0 +1,109 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+import { join } from 'path';
+import pino from 'pino';
+import { fileURLToPath } from 'url';
+const LOG_FILE_LOCATION = join(fileURLToPath(import.meta.url), '../../../../../logs/data-handler.trace');
+function getLogger() {
+    const all = [
+        {
+            target: 'pino/file',
+            options: { destination: LOG_FILE_LOCATION, mkdir: true }, // trace file
+            level: 'trace',
+        },
+        {
+            target: 'pino-pretty',
+            level: process.env.LOG_LEVEL || 'debug',
+        },
+    ];
+    const [file, stdout] = all;
+    if (process.env.NODE_ENV === 'test') {
+        // While testing, we simply use stdout and info level by default
+        return pino.default({
+            level: process.env.LOG_LEVEL || 'info',
+            transport: stdout,
+        });
+    }
+    if (process.env.NODE_ENV === 'development') {
+        // In dev mode, only stdout and debug logs by default
+        return pino.default({
+            level: 'trace',
+            transport: {
+                targets: all,
+            },
+        });
+    }
+    return pino.default({
+        level: 'trace',
+        transport: file,
+    });
+}
+export const logger = getLogger();
+/**
+ * Returns error message string from an Error object.
+ * @param error Error object
+ * @returns Error message.
+ */
+export function errorFunction(error) {
+    if (error instanceof Error) {
+        const err = error;
+        return errorMessage(`${err.message}`);
+    }
+    else if (typeof error === 'string') {
+        return errorMessage(`${error}`);
+    }
+    else {
+        return `${logError.name} called without an error object. Actual object is ${JSON.stringify(error)}`;
+    }
+}
+/**
+ * Same as 'errorFunction' but can do automatic replacement fof the error message string.
+ * @param message Error message
+ * @param toReplace replacement substring
+ * @param replaceWith string that 'toReplace' is replaced with.
+ * @returns Modified error message.
+ */
+export function errorMessage(message, toReplace, replaceWith) {
+    let errorMessage = message;
+    if (toReplace && replaceWith) {
+        errorMessage = message.replace(toReplace, replaceWith);
+    }
+    return `${errorMessage}`;
+}
+/**
+ * Logs error from Error object.
+ * @param error potentially an Error object. When exceptions are raised, they are typically Error objects.
+ */
+export function logError(error) {
+    if (error instanceof Error) {
+        const err = error;
+        logErrorMessage(`${err.message}`);
+    }
+    else {
+        console.error(`${logError.name} called without an error object. Actual object is ${JSON.stringify(error)}`);
+    }
+}
+/**
+ * Log error message in RED. Certain parts of messages can be replaced.
+ * This is useful, if including a message from external sources, and want to reduce the verbosity of the message.
+ * @param message Error message to log.
+ * @param toReplace String to look for.
+ * @param replaceWith Replace 'toReplace' with this. Only replaces first instance of 'toReplace'.
+ */
+export function logErrorMessage(message, toReplace, replaceWith) {
+    let errorMessage = message;
+    if (toReplace && replaceWith) {
+        errorMessage = message.replace(toReplace, replaceWith);
+    }
+    console.error(`${errorMessage}`);
+}
+//# sourceMappingURL=log-utils.js.map

package/dist/utils/log-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-utils.js","sourceRoot":"","sources":["../../src/utils/log-utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,IAAqC,MAAM,MAAM,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,MAAM,iBAAiB,GAAW,IAAI,CACpC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAC9B,wCAAwC,CACzC,CAAC;AAEF,SAAS,SAAS;IAChB,MAAM,GAAG,GAA6B;QACpC;YACE,MAAM,EAAE,WAAW;YACnB,OAAO,EAAE,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,aAAa;YACvE,KAAK,EAAE,OAAO;SACf;QACD;YACE,MAAM,EAAE,aAAa;YACrB,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,OAAO;SACxC;KACF,CAAC;IAEF,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,GAAG,CAAC;IAE3B,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;QACpC,gEAAgE;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,MAAM;YACtC,SAAS,EAAE,MAAM;SAClB,CAAC,CAAC;IACL,CAAC;IACD,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,EAAE,CAAC;QAC3C,qDAAqD;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,KAAK,EAAE,OAAO;YACd,SAAS,EAAE;gBACT,OAAO,EAAE,GAAG;aACb;SACF,CAAC,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC,OAAO,CAAC;QAClB,KAAK,EAAE,OAAO;QACd,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;AAElC;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAU,KAAK,CAAC;QACzB,OAAO,YAAY,CAAC,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,YAAY,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,QAAQ,CAAC,IAAI,qDAAqD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;IACtG,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAe,EACf,SAAkB,EAClB,WAAoB;IAEpB,IAAI,YAAY,GAAG,OAAO,CAAC;IAC3B,IAAI,SAAS,IAAI,WAAW,EAAE,CAAC;QAC7B,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,GAAG,YAAY,EAAE,CAAC;AAC3B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAU,KAAK,CAAC;QACzB,eAAe,CAAC,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACpC,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,KAAK,CACX,GAAG,QAAQ,CAAC,IAAI,qDAAqD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAC7F,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAC7B,OAAe,EACf,SAAkB,EAClB,WAAoB;IAEpB,IAAI,YAAY,GAAG,OAAO,CAAC;IAC3B,IAAI,SAAS,IAAI,WAAW,EAAE,CAAC;QAC7B,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,GAAG,YAAY,EAAE,CAAC,CAAC;AACnC,CAAC"}

package/dist/utils/random.d.ts

@@ -0,0 +1,19 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+/**
+ * Returns a random string in given base with given length.
+ * @param base which base to be used, e.g. 36 for base-36, must be an integer
+ * @param length length of string, must be an integer
+ * @returns a random string
+ * @throws if parameters are not integer numbers
+ */
+export declare function generateRandomString(base: number, length: number): string;

package/dist/utils/random.js

@@ -0,0 +1,34 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+import { randomInt } from 'node:crypto';
+// Maximum base for randomInt.
+const MAX_VALUE = Math.pow(2, 48) - 1;
+/**
+ * Returns a random string in given base with given length.
+ * @param base which base to be used, e.g. 36 for base-36, must be an integer
+ * @param length length of string, must be an integer
+ * @returns a random string
+ * @throws if parameters are not integer numbers
+ */
+export function generateRandomString(base, length) {
+    if (!Number.isInteger(base) || !Number.isInteger(length)) {
+        throw new Error('parameters must be integers');
+    }
+    // Generate a random number between 0 and given base max number - 1
+    const maxBaseNumber = Math.min(MAX_VALUE, Math.pow(base, length));
+    let generatedString = '';
+    while (generatedString.length < length) {
+        generatedString += randomInt(maxBaseNumber).toString(base);
+    }
+    return generatedString.substring(0, length);
+}
+//# sourceMappingURL=random.js.map

package/dist/utils/random.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"random.js","sourceRoot":"","sources":["../../src/utils/random.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,8BAA8B;AAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAY,EAAE,MAAc;IAC/D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAED,mEAAmE;IACnE,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAClE,IAAI,eAAe,GAAG,EAAE,CAAC;IACzB,OAAO,eAAe,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;QACvC,eAAe,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,eAAe,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAC9C,CAAC"}

package/dist/utils/resource-utils.d.ts

@@ -0,0 +1,45 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+import type { Project } from '../containers/project.js';
+export interface ResourceName {
+    prefix: string;
+    type: string;
+    identifier: string;
+}
+export declare function isResourceName(name: string): boolean;
+/**
+ * Returns resource name parts (project prefix, type in plural, name of the resource).
+ * @param resourceName Name of the resource (e.g. <prefix>/<type>/<name>)
+ * @param strict If true, does not allow names without 'prefix' and 'type'.
+ * @throws if 'resourceName' is not valid resource name.
+ * @returns resource name parts: project or module prefix, resource type (plural) and actual name of the resource.
+ * @todo: In the future, switch the default value of 'strict' to true. Only in certain cases should we accept names with just 'identifier'.
+ */
+export declare function resourceName(resourceName: string, strict?: boolean): ResourceName;
+/**
+ * Converts resource name to path.
+ * @param project Project
+ * @param resourceName Name of the resource (e.g. <prefix>/<type>/<name>)
+ * @returns path to resource metadata file
+ */
+export declare function resourceNameToPath(project: Project, resourceName: ResourceName): string;
+/**
+ * Resource metadata file path to resource name (e.g. <prefix>/<type>/<name>)
+ * @param project Project where resource is in
+ * @param path Path to resource metadata file
+ * @returns Resource name (<prefix>/<type>/<name>)
+ */
+export declare function pathToResourceName(project: Project, path: string): ResourceName;
+/**
+ * Returns ResourceName as a single string.
+ * @param resourceName Resource name to convert.
+ * @returns resource name as a single string.
+ * @note that valid resource names are: empty string, identifier alone and prefix/type/identifier combination.
+ */
+export declare function resourceNameToString(resourceName: ResourceName): string;

package/dist/utils/resource-utils.js

@@ -0,0 +1,137 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+// node
+import { join, parse, sep } from 'node:path';
+import { stripExtension } from './file-utils.js';
+// Indexes of resource name parts
+const PREFIX_INDEX = 0;
+const TYPE_INDEX = 1;
+const IDENTIFIER_INDEX = 2;
+// Valid resource name has three parts
+const RESOURCE_NAME_PARTS = 3;
+// Checks if name is valid (3 parts, separated by '/').
+export function isResourceName(name) {
+    const partsCount = name.split('/').length;
+    return partsCount === RESOURCE_NAME_PARTS;
+}
+/**
+ * Returns resource name parts (project prefix, type in plural, name of the resource).
+ * @param resourceName Name of the resource (e.g. <prefix>/<type>/<name>)
+ * @param strict If true, does not allow names without 'prefix' and 'type'.
+ * @throws if 'resourceName' is not valid resource name.
+ * @returns resource name parts: project or module prefix, resource type (plural) and actual name of the resource.
+ * @todo: In the future, switch the default value of 'strict' to true. Only in certain cases should we accept names with just 'identifier'.
+ */
+export function resourceName(resourceName, strict = false) {
+    const parts = resourceName.split('/');
+    // just resource identifier - type and prefix are unknown
+    if (parts.length === 1 && parts.at(0) !== '') {
+        if (strict) {
+            throw new Error(`Name '${resourceName}' is not valid resource name`);
+        }
+        return {
+            prefix: '',
+            type: '',
+            identifier: resourceName,
+        };
+    }
+    // resource name
+    if (parts.length === RESOURCE_NAME_PARTS) {
+        return {
+            prefix: parts[PREFIX_INDEX],
+            type: parts[TYPE_INDEX],
+            identifier: parse(parts[IDENTIFIER_INDEX]).name,
+        };
+    }
+    // other formats are not accepted
+    if (resourceName === '') {
+        throw new Error('Must define resource name to query its details');
+    }
+    throw new Error(`Name '${resourceName}' is not valid resource name`);
+}
+/**
+ * Converts resource name to path.
+ * @param project Project
+ * @param resourceName Name of the resource (e.g. <prefix>/<type>/<name>)
+ * @returns path to resource metadata file
+ */
+export function resourceNameToPath(project, resourceName) {
+    if (project.projectPrefix === resourceName.prefix) {
+        return join(project.paths.resourcesFolder, resourceName.type, resourceName.identifier + '.json');
+    }
+    else if (resourceName.prefix !== '') {
+        return join(project.paths.modulesFolder, resourceName.prefix, resourceName.type, resourceName.identifier + '.json');
+    }
+    throw new Error('resourceName does not contain prefix');
+}
+/**
+ * Resource metadata file path to resource name (e.g. <prefix>/<type>/<name>)
+ * @param project Project where resource is in
+ * @param path Path to resource metadata file
+ * @returns Resource name (<prefix>/<type>/<name>)
+ */
+export function pathToResourceName(project, path) {
+    const parts = path.split(sep);
+    const modulesIndex = parts.lastIndexOf('modules');
+    const localIndex = parts.lastIndexOf('local');
+    // Check that either 'local' or 'modules' is included in path (but not both).
+    // And after that there is required amount of parts.
+    if ((modulesIndex === -1 && localIndex === -1) ||
+        (modulesIndex !== -1 && localIndex !== -1) ||
+        (modulesIndex !== -1 &&
+            localIndex === 1 &&
+            parts.length === modulesIndex + 3) ||
+        (modulesIndex === -1 &&
+            localIndex !== -1 &&
+            parts.length === localIndex + 2)) {
+        throw new Error(`invalid path: ${path}`);
+    }
+    // Finally check that all relevant parts are defined.
+    const prefix = modulesIndex !== -1 ? parts.at(modulesIndex + 1) : project.projectPrefix;
+    const typeIndex = modulesIndex !== -1 ? modulesIndex + 2 : localIndex + 1;
+    const identifierIndex = modulesIndex !== -1 ? modulesIndex + 3 : localIndex + 2;
+    const type = parts.at(typeIndex);
+    const identifier = stripExtension(parts.at(identifierIndex));
+    if (!identifier || !type || !prefix) {
+        throw new Error(`invalid path: ${path}`);
+    }
+    return {
+        prefix: prefix,
+        type: type,
+        identifier: identifier,
+    };
+}
+/**
+ * Returns ResourceName as a single string.
+ * @param resourceName Resource name to convert.
+ * @returns resource name as a single string.
+ * @note that valid resource names are: empty string, identifier alone and prefix/type/identifier combination.
+ */
+export function resourceNameToString(resourceName) {
+    if (!resourceName.prefix && !resourceName.type && !resourceName.identifier) {
+        return '';
+    }
+    if (resourceName.identifier === '') {
+        throw new Error(`Not a valid resource name. Identifier is missing.`);
+    }
+    if (resourceName.prefix &&
+        resourceName.identifier &&
+        resourceName.type === '') {
+        throw new Error(`Not a valid resource name. Type is missing.`);
+    }
+    if (resourceName.prefix === '' &&
+        resourceName.identifier &&
+        resourceName.type) {
+        throw new Error(`Not a valid resource name. Prefix is missing.`);
+    }
+    return resourceName.prefix && resourceName.type && resourceName.prefix
+        ? `${resourceName.prefix}/${resourceName.type}/${resourceName.identifier}`
+        : `${resourceName.identifier}`;
+}
+//# sourceMappingURL=resource-utils.js.map

package/dist/utils/resource-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-utils.js","sourceRoot":"","sources":["../../src/utils/resource-utils.ts"],"names":[],"mappings":"AAAA;;;;;;;EAOE;AAEF,OAAO;AACP,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAG7C,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAYjD,iCAAiC;AACjC,MAAM,YAAY,GAAG,CAAC,CAAC;AACvB,MAAM,UAAU,GAAG,CAAC,CAAC;AACrB,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAC3B,sCAAsC;AACtC,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAE9B,uDAAuD;AACvD,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,OAAO,UAAU,KAAK,mBAAmB,CAAC;AAC5C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,YAAoB,EACpB,SAAkB,KAAK;IAEvB,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtC,yDAAyD;IACzD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;QAC7C,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,SAAS,YAAY,8BAA8B,CAAC,CAAC;QACvE,CAAC;QACD,OAAO;YACL,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,EAAE;YACR,UAAU,EAAE,YAAY;SACzB,CAAC;IACJ,CAAC;IACD,gBAAgB;IAChB,IAAI,KAAK,CAAC,MAAM,KAAK,mBAAmB,EAAE,CAAC;QACzC,OAAO;YACL,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC;YAC3B,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC;YACvB,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI;SAChD,CAAC;IACJ,CAAC;IACD,iCAAiC;IACjC,IAAI,YAAY,KAAK,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,SAAS,YAAY,8BAA8B,CAAC,CAAC;AACvE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAgB,EAChB,YAA0B;IAE1B,IAAI,OAAO,CAAC,aAAa,KAAK,YAAY,CAAC,MAAM,EAAE,CAAC;QAClD,OAAO,IAAI,CACT,OAAO,CAAC,KAAK,CAAC,eAAe,EAC7B,YAAY,CAAC,IAAI,EACjB,YAAY,CAAC,UAAU,GAAG,OAAO,CAClC,CAAC;IACJ,CAAC;SAAM,IAAI,YAAY,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QACtC,OAAO,IAAI,CACT,OAAO,CAAC,KAAK,CAAC,aAAa,EAC3B,YAAY,CAAC,MAAM,EACnB,YAAY,CAAC,IAAI,EACjB,YAAY,CAAC,UAAU,GAAG,OAAO,CAClC,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAgB,EAChB,IAAY;IAEZ,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,MAAM,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAClD,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAC9C,6EAA6E;IAC7E,oDAAoD;IACpD,IACE,CAAC,YAAY,KAAK,CAAC,CAAC,IAAI,UAAU,KAAK,CAAC,CAAC,CAAC;QAC1C,CAAC,YAAY,KAAK,CAAC,CAAC,IAAI,UAAU,KAAK,CAAC,CAAC,CAAC;QAC1C,CAAC,YAAY,KAAK,CAAC,CAAC;YAClB,UAAU,KAAK,CAAC;YAChB,KAAK,CAAC,MAAM,KAAK,YAAY,GAAG,CAAC,CAAC;QACpC,CAAC,YAAY,KAAK,CAAC,CAAC;YAClB,UAAU,KAAK,CAAC,CAAC;YACjB,KAAK,CAAC,MAAM,KAAK,UAAU,GAAG,CAAC,CAAC,EAClC,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IACD,qDAAqD;IACrD,MAAM,MAAM,GACV,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;IAC3E,MAAM,SAAS,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC;IAC1E,MAAM,eAAe,GACnB,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC;IAC1D,MAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;IACjC,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,CAAE,CAAC,CAAC;IAC9D,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO;QACL,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,IAAI;QACV,UAAU,EAAE,UAAU;KACvB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,YAA0B;IAC7D,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;QAC3E,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,YAAY,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACvE,CAAC;IACD,IACE,YAAY,CAAC,MAAM;QACnB,YAAY,CAAC,UAAU;QACvB,YAAY,CAAC,IAAI,KAAK,EAAE,EACxB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC;IACD,IACE,YAAY,CAAC,MAAM,KAAK,EAAE;QAC1B,YAAY,CAAC,UAAU;QACvB,YAAY,CAAC,IAAI,EACjB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,YAAY,CAAC,MAAM,IAAI,YAAY,CAAC,IAAI,IAAI,YAAY,CAAC,MAAM;QACpE,CAAC,CAAC,GAAG,YAAY,CAAC,MAAM,IAAI,YAAY,CAAC,IAAI,IAAI,YAAY,CAAC,UAAU,EAAE;QAC1E,CAAC,CAAC,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;AACnC,CAAC"}

package/dist/utils/sanitize-svg.d.ts

@@ -0,0 +1,18 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+import { Buffer } from 'buffer';
+/**
+ * Sanitize an SVG Buffer and return a base64-encoded string
+ * @param buffer - SVG content as a Buffer
+ * @returns base64-encoded sanitized SVG string
+ */
+export declare function sanitizeSvgBase64(buffer: Buffer): string;

package/dist/utils/sanitize-svg.js

@@ -0,0 +1,38 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+import createDOMPurify from 'dompurify';
+import { Buffer } from 'buffer';
+import { JSDOM } from 'jsdom';
+const window = new JSDOM('').window;
+// Remove SVG size to make it scale in the application properly
+const removeSvgWidthAndHeight = (node) => {
+    if (node.nodeName === 'svg') {
+        node.removeAttribute('width');
+        node.removeAttribute('height');
+    }
+};
+/**
+ * Sanitize an SVG Buffer and return a base64-encoded string
+ * @param buffer - SVG content as a Buffer
+ * @returns base64-encoded sanitized SVG string
+ */
+export function sanitizeSvgBase64(buffer) {
+    const DOMPurify = createDOMPurify(window);
+    const dirty = buffer.toString('utf-8');
+    DOMPurify.setConfig({ USE_PROFILES: { svg: true } });
+    DOMPurify.addHook('afterSanitizeAttributes', removeSvgWidthAndHeight);
+    let cleaned = DOMPurify.sanitize(dirty);
+    // Remove link titles, quick fix for Clingraph/Graphviz generated titles for links that are quite strange
+    cleaned = cleaned.replace(/\s*xlink:title=(["']).*?\1/g, '');
+    return Buffer.from(cleaned, 'utf-8').toString('base64');
+}
+//# sourceMappingURL=sanitize-svg.js.map

package/dist/utils/sanitize-svg.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sanitize-svg.js","sourceRoot":"","sources":["../../src/utils/sanitize-svg.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,eAAoC,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAE9B,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,MAA2B,CAAC;AAEzD,+DAA+D;AAC/D,MAAM,uBAAuB,GAAG,CAAC,IAAa,EAAE,EAAE;IAChD,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;QAC5B,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAC9B,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;AACH,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,MAAM,SAAS,GAAG,eAAe,CAAC,MAA+B,CAAC,CAAC;IAEnE,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAEvC,SAAS,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IACrD,SAAS,CAAC,OAAO,CAAC,yBAAyB,EAAE,uBAAuB,CAAC,CAAC;IAEtE,IAAI,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAExC,yGAAyG;IACzG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,6BAA6B,EAAE,EAAE,CAAC,CAAC;IAE7D,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC1D,CAAC"}