@eagleoutice/flowr 2.9.12 → 2.9.14

package/util/mermaid/mermaid.d.ts

@@ -1,14 +1,59 @@
 /**
- * Escapes markdown special characters in a string.
+ * Global mermaid helper object with useful functions.
  */
-export declare function escapeMarkdown(text: string): string;
-/**
- * Escapes a string or number to be used as a mermaid node id.
- */
-export declare function escapeId(text: string | number): string;
-/**
- * Converts mermaid code (potentially produced by {@link graphToMermaid}) to an url that presents the graph in the mermaid editor.
- * @param code - code to convert
- * @param edit - if true, the url will point to the editor, otherwise it will point to the viewer
- */
-export declare function mermaidCodeToUrl(code: string, edit?: boolean): string;
+export declare const Mermaid: {
+    readonly name: "Mermaid";
+    /**
+     * Replacements applied by escape functions!
+     */
+    readonly replacements: {
+        readonly '\\n': "\n";
+        readonly '`': "#96;";
+        readonly '[': "#91;";
+        readonly ']': "#93;";
+        readonly '<': "#60;";
+        readonly '>': "#62;";
+        readonly '*': "#42;";
+        readonly '+': "#43;";
+        readonly '-': "#45;";
+        readonly '"': "#34;";
+        readonly '\\': "#92;";
+        readonly _: "#95;";
+        readonly '{': "#123;";
+        readonly '}': "#125;";
+        readonly '&': "#38;";
+        readonly '\'': "#39;";
+        readonly ':': "#58;";
+        readonly '\u2228': "#8744;";
+        readonly '\u2227': "#8743;";
+        readonly '\u00AC': "#172;";
+        readonly '\u2192': "#8594;";
+        readonly '\u2194': "#8596;";
+        readonly '\u21D2': "#8658;";
+        readonly '\u21D4': "#8660;";
+        readonly '\u2200': "#8704;";
+        readonly '\u2203': "#8707;";
+        readonly '\u2208': "#8712;";
+        readonly '\u2209': "#8713;";
+        readonly '\u220B': "#8715;";
+        readonly '\u220C': "#8716;";
+        readonly '\u2229': "#8745;";
+        readonly '\u222A': "#8746;";
+        readonly '\u222B': "#8747;";
+        readonly '\u2295': "#8853;";
+    };
+    /**
+     * Escapes markdown special characters in a string.
+     */
+    readonly escape: (this: void, text: string) => string;
+    /**
+     * Escapes a string or number to be used as a mermaid node id.
+     */
+    readonly escapeId: (this: void, text: string | number) => string;
+    /**
+     * Converts mermaid code (potentially produced by {@link DataflowMermaid.convert}) to an url that presents the graph in the mermaid editor.
+     * @param code - code to convert
+     * @param edit - if true, the url will point to the editor, otherwise it will point to the viewer
+     */
+    readonly codeToUrl: (this: void, code: string, edit?: boolean) => string;
+};

package/util/mermaid/mermaid.js

@@ -1,73 +1,80 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.escapeMarkdown = escapeMarkdown;
-exports.escapeId = escapeId;
-exports.mermaidCodeToUrl = mermaidCodeToUrl;
-const replacements = {
-    // keep newlines
-    '\\n': '\n',
-    '`': '#96;',
-    '[': '#91;',
-    ']': '#93;',
-    '<': '#60;',
-    '>': '#62;',
-    '*': '#42;',
-    '+': '#43;',
-    '-': '#45;',
-    '"': '#34;',
-    '\\': '#92;',
-    '_': '#95;',
-    '{': '#123;',
-    '}': '#125;',
-    '&': '#38;',
-    '\'': '#39;',
-    ':': '#58;',
-    '∨': '#8744;',
-    '∧': '#8743;',
-    '¬': '#172;',
-    '→': '#8594;',
-    '↔': '#8596;',
-    '⇒': '#8658;',
-    '⇔': '#8660;',
-    '∀': '#8704;',
-    '∃': '#8707;',
-    '∈': '#8712;',
-    '∉': '#8713;',
-    '∋': '#8715;',
-    '∌': '#8716;',
-    '∩': '#8745;',
-    '∪': '#8746;',
-    '∫': '#8747;',
-    '⊕': '#8853;',
-};
-/**
- * Escapes markdown special characters in a string.
- */
-function escapeMarkdown(text) {
-    for (const [key, value] of Object.entries(replacements)) {
-        text = text.replaceAll(key, value);
-    }
-    return text;
-}
+exports.Mermaid = void 0;
 /**
- * Escapes a string or number to be used as a mermaid node id.
+ * Global mermaid helper object with useful functions.
  */
-function escapeId(text) {
-    text = String(text).replace(/[^a-zA-Z0-9:-]/g, '_');
-    return text;
-}
-/**
- * Converts mermaid code (potentially produced by {@link graphToMermaid}) to an url that presents the graph in the mermaid editor.
- * @param code - code to convert
- * @param edit - if true, the url will point to the editor, otherwise it will point to the viewer
- */
-function mermaidCodeToUrl(code, edit = false) {
-    const obj = {
-        code,
-        mermaid: {
-            autoSync: true
+exports.Mermaid = {
+    name: 'Mermaid',
+    /**
+     * Replacements applied by escape functions!
+     */
+    replacements: {
+        // keep newlines
+        '\\n': '\n',
+        '`': '#96;',
+        '[': '#91;',
+        ']': '#93;',
+        '<': '#60;',
+        '>': '#62;',
+        '*': '#42;',
+        '+': '#43;',
+        '-': '#45;',
+        '"': '#34;',
+        '\\': '#92;',
+        '_': '#95;',
+        '{': '#123;',
+        '}': '#125;',
+        '&': '#38;',
+        '\'': '#39;',
+        ':': '#58;',
+        '∨': '#8744;',
+        '∧': '#8743;',
+        '¬': '#172;',
+        '→': '#8594;',
+        '↔': '#8596;',
+        '⇒': '#8658;',
+        '⇔': '#8660;',
+        '∀': '#8704;',
+        '∃': '#8707;',
+        '∈': '#8712;',
+        '∉': '#8713;',
+        '∋': '#8715;',
+        '∌': '#8716;',
+        '∩': '#8745;',
+        '∪': '#8746;',
+        '∫': '#8747;',
+        '⊕': '#8853;',
+    },
+    /**
+     * Escapes markdown special characters in a string.
+     */
+    escape(text) {
+        for (const [key, value] of Object.entries(exports.Mermaid.replacements)) {
+            text = text.replaceAll(key, value);
         }
-    };
-    return `https://mermaid.live/${edit ? 'edit' : 'view'}#base64:${Buffer.from(JSON.stringify(obj)).toString('base64')}`;
-}
+        return text;
+    },
+    /**
+     * Escapes a string or number to be used as a mermaid node id.
+     */
+    escapeId(text) {
+        text = String(text).replace(/[^a-zA-Z0-9:-]/g, '_');
+        return text;
+    },
+    /**
+     * Converts mermaid code (potentially produced by {@link DataflowMermaid.convert}) to an url that presents the graph in the mermaid editor.
+     * @param code - code to convert
+     * @param edit - if true, the url will point to the editor, otherwise it will point to the viewer
+     */
+    codeToUrl(code, edit = false) {
+        const obj = {
+            code,
+            mermaid: {
+                autoSync: true
+            }
+        };
+        return `https://mermaid.live/${edit ? 'edit' : 'view'}#base64:${Buffer.from(JSON.stringify(obj)).toString('base64')}`;
+    }
+};
 //# sourceMappingURL=mermaid.js.map

package/util/objects.d.ts

@@ -32,4 +32,16 @@ type DefinedRecord<T> = {
 export declare function compactRecord<T extends Record<string, unknown>>(record: T): DefinedRecord<T>;
 export declare function compactRecord(record: undefined): undefined;
 export declare function compactRecord<T extends Record<string, unknown>>(record: T | undefined): DefinedRecord<T> | undefined;
+type Primitive = string | number | boolean | bigint | symbol | null | undefined | Date | Function;
+/**
+ * Given an object type `T`, produces a union of string literal types representing all possible paths to primitive values within that object.
+ * Sadly, right now, the ts-essential paths property breaks when it comes to deeper nested objects
+ */
+export type AutocompletablePaths<T, Prefix extends string = ''> = T extends Primitive | readonly unknown[] ? never : {
+    [K in keyof T & string]: `${Prefix}${K}` | (T[K] extends Primitive | readonly unknown[] ? never : AutocompletablePaths<T[K], `${Prefix}${K}.`>);
+}[keyof T & string];
+/**
+ * This is a version of a deep clone that preserves unclonable values (like functions, symbols, ...) by keeping the same reference to them.
+ */
+export declare function deepClonePreserveUnclonable<T>(obj: T): T;
 export {};

package/util/objects.js

@@ -4,6 +4,7 @@ exports.isObjectOrArray = isObjectOrArray;
 exports.deepMergeObject = deepMergeObject;
 exports.deepMergeObjectInPlace = deepMergeObjectInPlace;
 exports.compactRecord = compactRecord;
+exports.deepClonePreserveUnclonable = deepClonePreserveUnclonable;
 const json_1 = require("./json");
 /**
  * checks if `item` is an object (it may be an array, ...)
@@ -100,4 +101,31 @@ function compactRecord(record) {
     }
     return result;
 }
+/**
+ * This is a version of a deep clone that preserves unclonable values (like functions, symbols, ...) by keeping the same reference to them.
+ */
+function deepClonePreserveUnclonable(obj) {
+    if (typeof obj !== 'object' || obj === null) {
+        return obj;
+    }
+    else if (Array.isArray(obj)) {
+        return obj.map(deepClonePreserveUnclonable);
+    }
+    else if (obj instanceof Date) {
+        return new Date(obj.getTime());
+    }
+    else if (obj instanceof Map) {
+        return new Map(obj.entries().map(([k, v]) => [deepClonePreserveUnclonable(k), deepClonePreserveUnclonable(v)]));
+    }
+    else if (obj instanceof Set) {
+        return new Set(obj.values().map(deepClonePreserveUnclonable));
+    }
+    else {
+        const result = {};
+        for (const key of Object.keys(obj)) {
+            result[key] = deepClonePreserveUnclonable(obj[key]);
+        }
+        return result;
+    }
+}
 //# sourceMappingURL=objects.js.map

package/util/range.d.ts

@@ -31,6 +31,14 @@ export declare const SourcePosition: {
      * returns an invalid source position
      */
     readonly invalid: (this: void) => SourcePosition;
+    /**
+     * Returns the line of a source position
+     */
+    readonly getLine: (this: void, pos: SourcePosition) => number;
+    /**
+     * Returns the column of a source position
+     */
+    readonly getColumn: (this: void, pos: SourcePosition) => number;
 };
 /**
  * **Please note** that for multi-file projects we also have a {@link SourceLocation|source location} type that includes the file name.

package/util/range.js

@@ -31,7 +31,19 @@ exports.SourcePosition = {
      */
     invalid() {
         return [-1, -1];
-    }
+    },
+    /**
+     * Returns the line of a source position
+     */
+    getLine(pos) {
+        return pos[0];
+    },
+    /**
+     * Returns the column of a source position
+     */
+    getColumn(pos) {
+        return pos[1];
+    },
 };
 /**
  * Utility functions for {@link SourceRange|source ranges}.

package/util/slice-direction.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The direction to slice a program.
+ */
+export declare enum SliceDirection {
+    Backward = "backward",
+    Forward = "forward"
+}

package/util/slice-direction.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SliceDirection = void 0;
+/**
+ * The direction to slice a program.
+ */
+var SliceDirection;
+(function (SliceDirection) {
+    SliceDirection["Backward"] = "backward";
+    SliceDirection["Forward"] = "forward";
+})(SliceDirection || (exports.SliceDirection = SliceDirection = {}));
+//# sourceMappingURL=slice-direction.js.map

package/util/summarizer.js

@@ -34,7 +34,7 @@ function summarizeMeasurement(data, totalNumberOfDataPoints) {
     // just to avoid in-place modification
     const sorted = [...data].sort((a, b) => a - b);
     const min = sorted[0];
-    const max = sorted[sorted.length - 1];
+    const max = sorted.at(-1);
     const median = sorted[Math.floor(sorted.length / 2)];
     const total = (0, arrays_1.arraySum)(sorted);
     const length = totalNumberOfDataPoints ?? sorted.length;

package/util/version.js

@@ -6,7 +6,7 @@ exports.printVersionInformation = printVersionInformation;
 const semver_1 = require("semver");
 const assert_1 = require("./assert");
 // this is automatically replaced with the current version by release-it
-const version = '2.9.12';
+const version = '2.9.14';
 /**
  * Retrieves the current flowR version as a new {@link SemVer} object.
  */

package/dataflow/graph/invert-dfg.d.ts

@@ -1,6 +0,0 @@
-import { DataflowGraph } from './graph';
-import type { REnvironmentInformation } from '../environments/environment';
-/**
- * Inverts the given dataflow graph by reversing all edges.
- */
-export declare function invertDfg(graph: DataflowGraph, cleanEnv: REnvironmentInformation): DataflowGraph;

package/dataflow/graph/invert-dfg.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.invertDfg = invertDfg;
-const graph_1 = require("./graph");
-/**
- * Inverts the given dataflow graph by reversing all edges.
- */
-function invertDfg(graph, cleanEnv) {
-    const invertedGraph = new graph_1.DataflowGraph(graph.idMap);
-    for (const [, v] of graph.vertices(true)) {
-        invertedGraph.addVertex(v, cleanEnv);
-    }
-    for (const [from, targets] of graph.edges()) {
-        for (const [to, { types }] of targets) {
-            invertedGraph.addEdge(to, from, types);
-        }
-    }
-    return invertedGraph;
-}
-//# sourceMappingURL=invert-dfg.js.map

package/dataflow/graph/resolve-graph.d.ts

@@ -1,8 +0,0 @@
-import { DataflowGraph } from './graph';
-import { type AstIdMap } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
-import type { ReadOnlyFlowrAnalyzerContext } from '../../project/context/flowr-analyzer-context';
-/**
- * Resolves the dataflow graph ids from slicing criterion form to ids.
- * This returns a **new** graph with the resolved ids.
- */
-export declare function resolveDataflowGraph(graph: DataflowGraph, ctx: ReadOnlyFlowrAnalyzerContext, idMap?: AstIdMap): DataflowGraph;

package/dataflow/graph/resolve-graph.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveDataflowGraph = resolveDataflowGraph;
-const graph_1 = require("./graph");
-const assert_1 = require("../../util/assert");
-const parse_1 = require("../../slicing/criterion/parse");
-const edge_1 = require("./edge");
-/**
- * Resolves the dataflow graph ids from slicing criterion form to ids.
- * This returns a **new** graph with the resolved ids.
- */
-function resolveDataflowGraph(graph, ctx, idMap) {
-    const resolveMap = idMap ?? graph.idMap;
-    (0, assert_1.guard)(resolveMap !== undefined, 'idMap must be provided to resolve the graph');
-    const cache = new Map();
-    const resolve = (id) => {
-        const cached = cache.get(id);
-        if (cached !== undefined) {
-            return cached;
-        }
-        let resolved;
-        try {
-            resolved = (0, parse_1.slicingCriterionToId)(id, resolveMap);
-        }
-        catch {
-            /* just keep it :D */
-            resolved = id;
-        }
-        cache.set(id, resolved);
-        return resolved;
-    };
-    const resultGraph = new graph_1.DataflowGraph(resolveMap);
-    const roots = graph.rootIds();
-    /* recreate vertices */
-    for (const [id, vertex] of graph.vertices(true)) {
-        resultGraph.addVertex({
-            ...vertex,
-            id: resolve(id)
-        }, ctx.env.makeCleanEnv(), roots.has(id));
-    }
-    /* recreate edges */
-    for (const [from, targets] of graph.edges()) {
-        for (const [to, info] of targets) {
-            for (const type of edge_1.DfEdge.splitTypes(info)) {
-                resultGraph.addEdge(resolve(from), resolve(to), type);
-            }
-        }
-    }
-    for (const unknown of graph.unknownSideEffects) {
-        if (typeof unknown === 'object') {
-            resultGraph.markIdForUnknownSideEffects(resolve(unknown.id), unknown.linkTo);
-        }
-        else {
-            resultGraph.markIdForUnknownSideEffects(resolve(unknown));
-        }
-    }
-    return resultGraph;
-}
-//# sourceMappingURL=resolve-graph.js.map