@eagleoutice/flowr 2.1.3 → 2.1.5

package/queries/catalog/call-context-query/call-context-query-executor.js

@@ -1,69 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeCallContextQueries = executeCallContextQueries;
-const call_context_query_format_1 = require("./call-context-query-format");
 const node_id_1 = require("../../../r-bridge/lang-4.x/ast/model/processing/node-id");
 const vertex_1 = require("../../../dataflow/graph/vertex");
-const assert_1 = require("../../../util/assert");
 const edge_1 = require("../../../dataflow/graph/edge");
-const resolve_by_name_1 = require("../../../dataflow/environments/resolve-by-name");
-const built_in_1 = require("../../../dataflow/environments/built-in");
 const cfg_1 = require("../../../util/cfg/cfg");
 const two_layer_collector_1 = require("../../two-layer-collector");
 const objects_1 = require("../../../util/objects");
-const visitor_1 = require("../../../util/cfg/visitor");
-const identifier_1 = require("../../../dataflow/environments/identifier");
-function satisfiesCallTargets(id, graph, callTarget) {
-    const callVertex = graph.get(id);
-    if (callVertex === undefined || callVertex[0].tag !== vertex_1.VertexType.FunctionCall) {
-        return 'no';
-    }
-    const [info, outgoing] = callVertex;
-    const callTargets = [...outgoing]
-        .filter(([, e]) => (0, edge_1.edgeIncludesType)(e.types, edge_1.EdgeType.Calls))
-        .map(([t]) => t);
-    let builtIn = false;
-    if (info.environment === undefined) {
-        /* if we have a call with an unbound environment,
-         * this only happens if we are sure of built-in relations and want to save references
-         */
-        builtIn = true;
-    }
-    else {
-        /*
-         * for performance and scoping reasons, flowR will not identify the global linkage,
-         * including any potential built-in mapping.
-         */
-        const reResolved = (0, resolve_by_name_1.resolveByName)(info.name, info.environment, identifier_1.ReferenceType.Unknown);
-        if (reResolved?.some(t => t.definedAt === built_in_1.BuiltIn)) {
-            builtIn = true;
-        }
-    }
-    switch (callTarget) {
-        case call_context_query_format_1.CallTargets.Any:
-            return callTargets;
-        case call_context_query_format_1.CallTargets.OnlyGlobal:
-            if (callTargets.length === 0) {
-                return builtIn ? [built_in_1.BuiltIn] : [];
-            }
-            else {
-                return 'no';
-            }
-        case call_context_query_format_1.CallTargets.MustIncludeGlobal:
-            return builtIn || callTargets.length === 0 ? [...callTargets, built_in_1.BuiltIn] : 'no';
-        case call_context_query_format_1.CallTargets.OnlyLocal:
-            return !builtIn && callTargets.length > 0 ? callTargets : 'no';
-        case call_context_query_format_1.CallTargets.MustIncludeLocal:
-            if (callTargets.length > 0) {
-                return builtIn ? [...callTargets, built_in_1.BuiltIn] : callTargets;
-            }
-            else {
-                return 'no';
-            }
-        default:
-            (0, assert_1.assertUnreachable)(callTarget);
-    }
-}
+const identify_link_to_last_call_relation_1 = require("./identify-link-to-last-call-relation");
 /* if the node is effected by nse, we have an ingoing nse edge */
 function isQuoted(node, graph) {
     const vertex = graph.ingoingEdges(node);
@@ -77,6 +21,9 @@ function makeReport(collector) {
     for (const [kind, collected] of collector.store) {
         const subkinds = {};
         for (const [subkind, values] of collected) {
+            if (!Array.isArray(subkinds[subkind])) {
+                subkinds[subkind] = [];
+            }
             subkinds[subkind] ??= [];
             const collectIn = subkinds[subkind];
             for (const value of values) {
@@ -90,7 +37,7 @@ function makeReport(collector) {
     return result;
 }
 function isSubCallQuery(query) {
-    return 'linkTo' in query;
+    return 'linkTo' in query && query.linkTo !== undefined;
 }
 function exactCallNameRegex(name) {
     return new RegExp(`^(${name})$`);
@@ -121,24 +68,6 @@ function promoteQueryCallNames(queries) {
     });
     return { promotedQueries, requiresCfg };
 }
-function identifyLinkToLastCallRelation(from, cfg, graph, linkTo) {
-    const found = [];
-    (0, visitor_1.visitInReverseOrder)(cfg, from, node => {
-        /* we ignore the start id as it cannot be the last call */
-        if (node === from) {
-            return;
-        }
-        const vertex = graph.getVertex(node);
-        if (vertex === undefined || vertex.tag !== vertex_1.VertexType.FunctionCall) {
-            return;
-        }
-        if (linkTo.test(vertex.name)) {
-            found.push(node);
-            return true;
-        }
-    });
-    return found;
-}
 /* maybe we want to add caches to this */
 function retrieveAllCallAliases(nodeId, graph) {
     /* we want the names of all functions called at the source id, including synonyms and returns */
@@ -187,6 +116,22 @@ function retrieveAllCallAliases(nodeId, graph) {
     }
     return aliases;
 }
+function removeIdenticalDuplicates(collector) {
+    for (const [, collected] of collector.store) {
+        for (const [subkind, values] of collected) {
+            const seen = new Set();
+            const newValues = values.filter(v => {
+                const str = JSON.stringify(v);
+                if (seen.has(str)) {
+                    return false;
+                }
+                seen.add(str);
+                return true;
+            });
+            collected.set(subkind, newValues);
+        }
+    }
+}
 /**
  * Multi-stage call context query resolve.
  *
@@ -223,7 +168,7 @@ function executeCallContextQueries({ graph, ast }, queries) {
             for (const [l, ids] of targets.entries()) {
                 for (const query of queriesWhichWantAliases) {
                     if (query.callName.test(l)) {
-                        initialIdCollector.add(query.kind ?? '.', query.subkind ?? '.', (0, objects_1.compactRecord)({ id: nodeId, aliasRoots: ids }));
+                        initialIdCollector.add(query.kind ?? '.', query.subkind ?? '.', (0, objects_1.compactRecord)({ id: nodeId, name: info.name, aliasRoots: ids }));
                     }
                 }
             }
@@ -231,7 +176,7 @@ function executeCallContextQueries({ graph, ast }, queries) {
         for (const query of promotedQueries.filter(q => q.callName.test(info.name))) {
             let targets = undefined;
             if (query.callTargets) {
-                targets = satisfiesCallTargets(nodeId, graph, query.callTargets);
+                targets = (0, identify_link_to_last_call_relation_1.satisfiesCallTargets)(nodeId, graph, query.callTargets);
                 if (targets === 'no') {
                     continue;
                 }
@@ -243,14 +188,15 @@ function executeCallContextQueries({ graph, ast }, queries) {
             let linkedIds = undefined;
             if (cfg && isSubCallQuery(query)) {
                 /* if we have a linkTo query, we have to find the last call */
-                const lastCall = identifyLinkToLastCallRelation(nodeId, cfg.graph, graph, query.linkTo.callName);
+                const lastCall = (0, identify_link_to_last_call_relation_1.identifyLinkToLastCallRelation)(nodeId, cfg.graph, graph, query.linkTo.callName);
                 if (lastCall) {
                     linkedIds = lastCall;
                 }
             }
-            initialIdCollector.add(query.kind ?? '.', query.subkind ?? '.', (0, objects_1.compactRecord)({ id: nodeId, calls: targets, linkedIds }));
+            initialIdCollector.add(query.kind ?? '.', query.subkind ?? '.', (0, objects_1.compactRecord)({ id: nodeId, name: info.name, calls: targets, linkedIds }));
         }
     }
+    removeIdenticalDuplicates(initialIdCollector);
     return {
         '.meta': {
             timing: Date.now() - now,

package/queries/catalog/call-context-query/call-context-query-format.d.ts

@@ -1,17 +1,11 @@
 import type { BaseQueryFormat, BaseQueryResult } from '../../base-query-format';
 import type { NodeId } from '../../../r-bridge/lang-4.x/ast/model/processing/node-id';
-export declare enum CallTargets {
-    /** call targets a function that is not defined locally (e.g., the call targets a library function) */
-    OnlyGlobal = "global",
-    /** call targets a function that is defined locally or globally, but must include a global function */
-    MustIncludeGlobal = "must-include-global",
-    /** call targets a function that is defined locally  */
-    OnlyLocal = "local",
-    /** call targets a function that is defined locally or globally, but must include a local function */
-    MustIncludeLocal = "must-include-local",
-    /** call targets a function that is defined locally or globally */
-    Any = "any"
-}
+import { executeCallContextQueries } from './call-context-query-executor';
+import type { OutputFormatter } from '../../../util/ansi';
+import Joi from 'joi';
+import type { PipelineOutput } from '../../../core/steps/pipeline/pipeline';
+import type { DEFAULT_DATAFLOW_PIPELINE } from '../../../core/steps/pipeline/default-pipelines';
+import { CallTargets } from './identify-link-to-last-call-relation';
 export interface DefaultCallContextQueryFormat<CallName extends RegExp | string> extends BaseQueryFormat {
     readonly type: 'call-context';
     /** Regex regarding the function name, please note that strings will be interpreted as regular expressions too! */
@@ -45,13 +39,15 @@ interface LinkToLastCall<CallName extends RegExp | string = RegExp | string> ext
     /** Regex regarding the function name of the last call. Similar to {@link DefaultCallContextQueryFormat#callName}, strings are interpreted as a `RegExp`. */
     readonly callName: CallName;
 }
-type LinkTo<CallName extends RegExp | string> = LinkToLastCall<CallName>;
+export type LinkTo<CallName extends RegExp | string> = LinkToLastCall<CallName>;
 export interface SubCallContextQueryFormat<CallName extends RegExp | string = RegExp | string> extends DefaultCallContextQueryFormat<CallName> {
     readonly linkTo: LinkTo<CallName>;
 }
 export interface CallContextQuerySubKindResult {
     /** The id of the call vertex identified within the supplied dataflow graph */
     readonly id: NodeId;
+    /** The name of the function call */
+    readonly name: string;
     /**
      * Ids of functions which are called by the respective function call,
      * this will only be populated whenever you explicitly state the {@link DefaultCallContextQueryFormat#callTargets}.
@@ -73,4 +69,9 @@ export interface CallContextQueryResult extends BaseQueryResult {
     readonly kinds: CallContextQueryKindResult;
 }
 export type CallContextQuery<CallName extends RegExp | string = RegExp | string> = DefaultCallContextQueryFormat<CallName> | SubCallContextQueryFormat<CallName>;
+export declare const CallContextQueryDefinition: {
+    readonly executor: typeof executeCallContextQueries;
+    readonly asciiSummarizer: (formatter: OutputFormatter, processed: PipelineOutput<typeof DEFAULT_DATAFLOW_PIPELINE>, queryResults: BaseQueryResult, result: string[]) => boolean;
+    readonly schema: Joi.ObjectSchema<any>;
+};
 export {};

package/queries/catalog/call-context-query/call-context-query-format.js

@@ -1,17 +1,35 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CallTargets = void 0;
-var CallTargets;
-(function (CallTargets) {
-    /** call targets a function that is not defined locally (e.g., the call targets a library function) */
-    CallTargets["OnlyGlobal"] = "global";
-    /** call targets a function that is defined locally or globally, but must include a global function */
-    CallTargets["MustIncludeGlobal"] = "must-include-global";
-    /** call targets a function that is defined locally  */
-    CallTargets["OnlyLocal"] = "local";
-    /** call targets a function that is defined locally or globally, but must include a local function */
-    CallTargets["MustIncludeLocal"] = "must-include-local";
-    /** call targets a function that is defined locally or globally */
-    CallTargets["Any"] = "any";
-})(CallTargets || (exports.CallTargets = CallTargets = {}));
+exports.CallContextQueryDefinition = void 0;
+const call_context_query_executor_1 = require("./call-context-query-executor");
+const ansi_1 = require("../../../util/ansi");
+const time_1 = require("../../../util/time");
+const joi_1 = __importDefault(require("joi"));
+const query_print_1 = require("../../query-print");
+const identify_link_to_last_call_relation_1 = require("./identify-link-to-last-call-relation");
+exports.CallContextQueryDefinition = {
+    executor: call_context_query_executor_1.executeCallContextQueries,
+    asciiSummarizer: (formatter, processed, queryResults, result) => {
+        const out = queryResults;
+        result.push(`Query: ${(0, ansi_1.bold)('call-context', formatter)} (${(0, time_1.printAsMs)(out['.meta'].timing, 0)})`);
+        result.push((0, query_print_1.asciiCallContext)(formatter, out, processed));
+        return true;
+    },
+    schema: joi_1.default.object({
+        type: joi_1.default.string().valid('call-context').required().description('The type of the query.'),
+        callName: joi_1.default.string().required().description('Regex regarding the function name!'),
+        callNameExact: joi_1.default.boolean().optional().description('Should we automatically add the `^` and `$` anchors to the regex to make it an exact match?'),
+        kind: joi_1.default.string().optional().description('The kind of the call, this can be used to group calls together (e.g., linking `plot` to `visualize`). Defaults to `.`'),
+        subkind: joi_1.default.string().optional().description('The subkind of the call, this can be used to uniquely identify the respective call type when grouping the output (e.g., the normalized name, linking `ggplot` to `plot`). Defaults to `.`'),
+        callTargets: joi_1.default.string().valid(...Object.values(identify_link_to_last_call_relation_1.CallTargets)).optional().description('Call targets the function may have. This defaults to `any`. Request this specifically to gain all call targets we can resolve.'),
+        includeAliases: joi_1.default.boolean().optional().description('Consider a case like `f <- function_of_interest`, do you want uses of `f` to be included in the results?'),
+        linkTo: joi_1.default.object({
+            type: joi_1.default.string().valid('link-to-last-call').required().description('The type of the linkTo sub-query.'),
+            callName: joi_1.default.string().required().description('Regex regarding the function name of the last call. Similar to `callName`, strings are interpreted as a regular expression.')
+        }).optional().description('Links the current call to the last call of the given kind. This way, you can link a call like `points` to the latest graphics plot etc.')
+    }).description('Call context query used to find calls in the dataflow graph')
+};
 //# sourceMappingURL=call-context-query-format.js.map

package/queries/catalog/call-context-query/identify-link-to-last-call-relation.d.ts

@@ -0,0 +1,17 @@
+import type { NodeId } from '../../../r-bridge/lang-4.x/ast/model/processing/node-id';
+import type { ControlFlowGraph } from '../../../util/cfg/cfg';
+import type { DataflowGraph } from '../../../dataflow/graph/graph';
+export declare enum CallTargets {
+    /** call targets a function that is not defined locally (e.g., the call targets a library function) */
+    OnlyGlobal = "global",
+    /** call targets a function that is defined locally or globally, but must include a global function */
+    MustIncludeGlobal = "must-include-global",
+    /** call targets a function that is defined locally  */
+    OnlyLocal = "local",
+    /** call targets a function that is defined locally or globally, but must include a local function */
+    MustIncludeLocal = "must-include-local",
+    /** call targets a function that is defined locally or globally */
+    Any = "any"
+}
+export declare function satisfiesCallTargets(id: NodeId, graph: DataflowGraph, callTarget: CallTargets): NodeId[] | 'no';
+export declare function identifyLinkToLastCallRelation(from: NodeId, cfg: ControlFlowGraph, graph: DataflowGraph, linkTo: RegExp): NodeId[];

package/queries/catalog/call-context-query/identify-link-to-last-call-relation.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CallTargets = void 0;
+exports.satisfiesCallTargets = satisfiesCallTargets;
+exports.identifyLinkToLastCallRelation = identifyLinkToLastCallRelation;
+const visitor_1 = require("../../../util/cfg/visitor");
+const vertex_1 = require("../../../dataflow/graph/vertex");
+const edge_1 = require("../../../dataflow/graph/edge");
+const resolve_by_name_1 = require("../../../dataflow/environments/resolve-by-name");
+const identifier_1 = require("../../../dataflow/environments/identifier");
+const built_in_1 = require("../../../dataflow/environments/built-in");
+const assert_1 = require("../../../util/assert");
+var CallTargets;
+(function (CallTargets) {
+    /** call targets a function that is not defined locally (e.g., the call targets a library function) */
+    CallTargets["OnlyGlobal"] = "global";
+    /** call targets a function that is defined locally or globally, but must include a global function */
+    CallTargets["MustIncludeGlobal"] = "must-include-global";
+    /** call targets a function that is defined locally  */
+    CallTargets["OnlyLocal"] = "local";
+    /** call targets a function that is defined locally or globally, but must include a local function */
+    CallTargets["MustIncludeLocal"] = "must-include-local";
+    /** call targets a function that is defined locally or globally */
+    CallTargets["Any"] = "any";
+})(CallTargets || (exports.CallTargets = CallTargets = {}));
+function satisfiesCallTargets(id, graph, callTarget) {
+    const callVertex = graph.get(id);
+    if (callVertex === undefined || callVertex[0].tag !== vertex_1.VertexType.FunctionCall) {
+        return 'no';
+    }
+    const [info, outgoing] = callVertex;
+    const callTargets = [...outgoing]
+        .filter(([, e]) => (0, edge_1.edgeIncludesType)(e.types, edge_1.EdgeType.Calls))
+        .map(([t]) => t);
+    let builtIn = false;
+    if (info.environment === undefined) {
+        /* if we have a call with an unbound environment,
+         * this only happens if we are sure of built-in relations and want to save references
+         */
+        builtIn = true;
+    }
+    else {
+        /*
+         * for performance and scoping reasons, flowR will not identify the global linkage,
+         * including any potential built-in mapping.
+         */
+        const reResolved = (0, resolve_by_name_1.resolveByName)(info.name, info.environment, identifier_1.ReferenceType.Unknown);
+        if (reResolved?.some(t => t.definedAt === built_in_1.BuiltIn)) {
+            builtIn = true;
+        }
+    }
+    switch (callTarget) {
+        case CallTargets.Any:
+            return callTargets;
+        case CallTargets.OnlyGlobal:
+            if (callTargets.length === 0) {
+                return builtIn ? [built_in_1.BuiltIn] : [];
+            }
+            else {
+                return 'no';
+            }
+        case CallTargets.MustIncludeGlobal:
+            return builtIn || callTargets.length === 0 ? [...callTargets, built_in_1.BuiltIn] : 'no';
+        case CallTargets.OnlyLocal:
+            return !builtIn && callTargets.length > 0 ? callTargets : 'no';
+        case CallTargets.MustIncludeLocal:
+            if (callTargets.length > 0) {
+                return builtIn ? [...callTargets, built_in_1.BuiltIn] : callTargets;
+            }
+            else {
+                return 'no';
+            }
+        default:
+            (0, assert_1.assertUnreachable)(callTarget);
+    }
+}
+function identifyLinkToLastCallRelation(from, cfg, graph, linkTo) {
+    const found = [];
+    (0, visitor_1.visitInReverseOrder)(cfg, from, node => {
+        /* we ignore the start id as it cannot be the last call */
+        if (node === from) {
+            return;
+        }
+        const vertex = graph.get(node);
+        if (vertex === undefined || vertex[0].tag !== vertex_1.VertexType.FunctionCall) {
+            return;
+        }
+        if (linkTo.test(vertex[0].name)) {
+            const tar = satisfiesCallTargets(vertex[0].id, graph, CallTargets.MustIncludeGlobal);
+            if (tar === 'no') {
+                return true;
+            }
+            found.push(node);
+            return true;
+        }
+    });
+    return found;
+}
+//# sourceMappingURL=identify-link-to-last-call-relation.js.map

package/queries/catalog/cluster-query/cluster-query-executor.d.ts

@@ -1,3 +1,3 @@
-import type { BasicQueryData } from '../../query';
 import type { DataflowClusterQuery, DataflowClusterQueryResult } from './cluster-query-format';
+import type { BasicQueryData } from '../../base-query-format';
 export declare function executeDataflowClusterQuery({ graph }: BasicQueryData, queries: readonly DataflowClusterQuery[]): DataflowClusterQueryResult;

package/queries/catalog/cluster-query/cluster-query-format.d.ts

@@ -1,5 +1,7 @@
 import type { BaseQueryFormat, BaseQueryResult } from '../../base-query-format';
+import Joi from 'joi';
 import type { DataflowGraphClusters } from '../../../dataflow/cluster';
+import { executeDataflowClusterQuery } from './cluster-query-executor';
 /**
  * Calculates and returns all clusters encountered in the dataflow graph.
  */
@@ -10,3 +12,60 @@ export interface DataflowClusterQueryResult extends BaseQueryResult {
     /** All clusters found in the respective dataflow */
     readonly clusters: DataflowGraphClusters;
 }
+export declare const ClusterQueryDefinition: {
+    readonly executor: typeof executeDataflowClusterQuery;
+    readonly asciiSummarizer: (formatter: import("../../../util/ansi").OutputFormatter, processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
+        readonly name: "parse";
+        readonly humanReadableName: "parse with R shell";
+        readonly description: "Parse the given R code into an AST";
+        readonly processor: (_results: unknown, input: Partial<import("../../../core/steps/all/core/00-parse").ParseRequiredInput>) => Promise<import("../../../core/steps/all/core/00-parse").ParseStepOutput>;
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: {
+                (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
+                (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
+            };
+            readonly 5: ({ parsed }: import("../../../core/steps/all/core/00-parse").ParseStepOutput, config: import("../../../util/quads").QuadSerializationConfiguration) => string;
+        };
+        readonly dependencies: readonly [];
+        readonly requiredInput: import("../../../core/steps/all/core/00-parse").ParseRequiredInput;
+    } | {
+        readonly name: "normalize";
+        readonly humanReadableName: "normalize";
+        readonly description: "Normalize the AST to flowR's AST";
+        readonly processor: (results: {
+            parse?: import("../../../core/steps/all/core/00-parse").ParseStepOutput;
+        }, input: Partial<import("../../../core/steps/all/core/10-normalize").NormalizeRequiredInput>) => import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst<import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, import("../../../r-bridge/lang-4.x/ast/model/model").RNode<import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>>;
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: typeof import("../../../core/print/normalize-printer").normalizedAstToJson;
+            readonly 5: typeof import("../../../core/print/normalize-printer").normalizedAstToQuads;
+            readonly 3: typeof import("../../../core/print/normalize-printer").printNormalizedAstToMermaid;
+            readonly 4: typeof import("../../../core/print/normalize-printer").printNormalizedAstToMermaidUrl;
+        };
+        readonly dependencies: readonly ["parse"];
+        readonly requiredInput: import("../../../core/steps/all/core/10-normalize").NormalizeRequiredInput;
+    } | {
+        readonly humanReadableName: "dataflow";
+        readonly processor: (results: {
+            normalize?: import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
+        }, input: {
+            request?: import("../../../r-bridge/retriever").RParseRequests;
+        }) => import("../../../dataflow/info").DataflowInformation;
+        readonly requiredInput: {};
+        readonly name: "dataflow";
+        readonly description: "Construct the dataflow graph";
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: typeof import("../../../core/print/dataflow-printer").dataflowGraphToJson;
+            readonly 5: typeof import("../../../core/print/dataflow-printer").dataflowGraphToQuads;
+            readonly 3: typeof import("../../../core/print/dataflow-printer").dataflowGraphToMermaid;
+            readonly 4: typeof import("../../../core/print/dataflow-printer").dataflowGraphToMermaidUrl;
+        };
+        readonly dependencies: readonly ["normalize"];
+    }>>, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly schema: Joi.ObjectSchema<any>;
+};

package/queries/catalog/cluster-query/cluster-query-format.js

@@ -1,3 +1,32 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClusterQueryDefinition = void 0;
+const ansi_1 = require("../../../util/ansi");
+const joi_1 = __importDefault(require("joi"));
+const cluster_query_executor_1 = require("./cluster-query-executor");
+const dfg_1 = require("../../../util/mermaid/dfg");
+const query_print_1 = require("../../query-print");
+exports.ClusterQueryDefinition = {
+    executor: cluster_query_executor_1.executeDataflowClusterQuery,
+    asciiSummarizer: (formatter, processed, queryResults, result) => {
+        const out = queryResults;
+        result.push(`Query: ${(0, ansi_1.bold)('dataflow-cluster', formatter)} (${out['.meta'].timing.toFixed(0)}ms)`);
+        result.push(`   ╰ Found ${out.clusters.length} cluster${out.clusters.length === 1 ? '' : 's'}`);
+        for (const cluster of out.clusters) {
+            const unknownSideEffects = cluster.hasUnknownSideEffects ? '(has unknown side effect)' : '';
+            let suffix = '';
+            if (formatter === ansi_1.markdownFormatter) {
+                suffix = `([marked](${(0, dfg_1.graphToMermaidUrl)(processed.dataflow.graph, false, new Set(cluster.members))}))`;
+            }
+            result.push(`      ╰ ${unknownSideEffects} {${(0, query_print_1.summarizeIdsIfTooLong)(formatter, cluster.members)}} ${suffix}`);
+        }
+        return true;
+    },
+    schema: joi_1.default.object({
+        type: joi_1.default.string().valid('dataflow-cluster').required().description('The type of the query.'),
+    }).description('The cluster query calculates and returns all clusters in the dataflow graph.')
+};
 //# sourceMappingURL=cluster-query-format.js.map

package/queries/catalog/dataflow-query/dataflow-query-executor.d.ts

@@ -1,3 +1,3 @@
-import type { BasicQueryData } from '../../query';
 import type { DataflowQuery, DataflowQueryResult } from './dataflow-query-format';
+import type { BasicQueryData } from '../../base-query-format';
 export declare function executeDataflowQuery({ graph }: BasicQueryData, queries: readonly DataflowQuery[]): DataflowQueryResult;

package/queries/catalog/dataflow-query/dataflow-query-format.d.ts

@@ -1,5 +1,7 @@
 import type { BaseQueryFormat, BaseQueryResult } from '../../base-query-format';
 import type { DataflowGraph } from '../../../dataflow/graph/graph';
+import { executeDataflowQuery } from './dataflow-query-executor';
+import Joi from 'joi';
 /**
  * Simple re-returns the dataflow graph of the analysis.
  */
@@ -10,3 +12,60 @@ export interface DataflowQueryResult extends BaseQueryResult {
     /** Please be aware that this is the graph in its JSON representation, use {@link DataflowGraph#fromJson} if the result is serialized */
     readonly graph: DataflowGraph;
 }
+export declare const DataflowQueryDefinition: {
+    readonly executor: typeof executeDataflowQuery;
+    readonly asciiSummarizer: (formatter: import("../../../util/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
+        readonly name: "parse";
+        readonly humanReadableName: "parse with R shell";
+        readonly description: "Parse the given R code into an AST";
+        readonly processor: (_results: unknown, input: Partial<import("../../../core/steps/all/core/00-parse").ParseRequiredInput>) => Promise<import("../../../core/steps/all/core/00-parse").ParseStepOutput>;
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: {
+                (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
+                (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
+            };
+            readonly 5: ({ parsed }: import("../../../core/steps/all/core/00-parse").ParseStepOutput, config: import("../../../util/quads").QuadSerializationConfiguration) => string;
+        };
+        readonly dependencies: readonly [];
+        readonly requiredInput: import("../../../core/steps/all/core/00-parse").ParseRequiredInput;
+    } | {
+        readonly name: "normalize";
+        readonly humanReadableName: "normalize";
+        readonly description: "Normalize the AST to flowR's AST";
+        readonly processor: (results: {
+            parse?: import("../../../core/steps/all/core/00-parse").ParseStepOutput;
+        }, input: Partial<import("../../../core/steps/all/core/10-normalize").NormalizeRequiredInput>) => import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst<import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, import("../../../r-bridge/lang-4.x/ast/model/model").RNode<import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>>;
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: typeof import("../../../core/print/normalize-printer").normalizedAstToJson;
+            readonly 5: typeof import("../../../core/print/normalize-printer").normalizedAstToQuads;
+            readonly 3: typeof import("../../../core/print/normalize-printer").printNormalizedAstToMermaid;
+            readonly 4: typeof import("../../../core/print/normalize-printer").printNormalizedAstToMermaidUrl;
+        };
+        readonly dependencies: readonly ["parse"];
+        readonly requiredInput: import("../../../core/steps/all/core/10-normalize").NormalizeRequiredInput;
+    } | {
+        readonly humanReadableName: "dataflow";
+        readonly processor: (results: {
+            normalize?: import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
+        }, input: {
+            request?: import("../../../r-bridge/retriever").RParseRequests;
+        }) => import("../../../dataflow/info").DataflowInformation;
+        readonly requiredInput: {};
+        readonly name: "dataflow";
+        readonly description: "Construct the dataflow graph";
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: typeof import("../../../core/print/dataflow-printer").dataflowGraphToJson;
+            readonly 5: typeof import("../../../core/print/dataflow-printer").dataflowGraphToQuads;
+            readonly 3: typeof import("../../../core/print/dataflow-printer").dataflowGraphToMermaid;
+            readonly 4: typeof import("../../../core/print/dataflow-printer").dataflowGraphToMermaidUrl;
+        };
+        readonly dependencies: readonly ["normalize"];
+    }>>, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly schema: Joi.ObjectSchema<any>;
+};

package/queries/catalog/dataflow-query/dataflow-query-format.js

@@ -1,3 +1,24 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataflowQueryDefinition = void 0;
+const dataflow_query_executor_1 = require("./dataflow-query-executor");
+const ansi_1 = require("../../../util/ansi");
+const time_1 = require("../../../util/time");
+const dfg_1 = require("../../../util/mermaid/dfg");
+const joi_1 = __importDefault(require("joi"));
+exports.DataflowQueryDefinition = {
+    executor: dataflow_query_executor_1.executeDataflowQuery,
+    asciiSummarizer: (formatter, _processed, queryResults, result) => {
+        const out = queryResults;
+        result.push(`Query: ${(0, ansi_1.bold)('dataflow', formatter)} (${(0, time_1.printAsMs)(out['.meta'].timing, 0)})`);
+        result.push(`   ╰ [Dataflow Graph](${(0, dfg_1.graphToMermaidUrl)(out.graph)})`);
+        return true;
+    },
+    schema: joi_1.default.object({
+        type: joi_1.default.string().valid('dataflow').required().description('The type of the query.'),
+    }).description('The dataflow query simply returns the dataflow graph, there is no need to pass it multiple times!')
+};
 //# sourceMappingURL=dataflow-query-format.js.map

package/queries/catalog/dependencies-query/dependencies-query-executor.d.ts

@@ -0,0 +1,3 @@
+import type { DependenciesQuery, DependenciesQueryResult } from './dependencies-query-format';
+import type { BasicQueryData } from '../../base-query-format';
+export declare function executeDependenciesQuery(data: BasicQueryData, queries: readonly DependenciesQuery[]): DependenciesQueryResult;