@eagleoutice/flowr 2.1.11 → 2.1.12

package/documentation/print-search-wiki.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const shell_1 = require("../r-bridge/shell");
+const log_1 = require("../../test/functionality/_helper/log");
+const doc_files_1 = require("./doc-util/doc-files");
+const doc_auto_gen_1 = require("./doc-util/doc-auto-gen");
+const doc_search_1 = require("./doc-util/doc-search");
+const flowr_search_builder_1 = require("../search/flowr-search-builder");
+const vertex_1 = require("../dataflow/graph/vertex");
+const doc_types_1 = require("./doc-util/doc-types");
+const path_1 = __importDefault(require("path"));
+async function getText(shell) {
+    const rversion = (await shell.usedRVersion())?.format() ?? 'unknown';
+    const types = (0, doc_types_1.getTypesFromFolderAsMermaid)({
+        rootFolder: path_1.default.resolve('./src/search/'),
+        typeName: 'FlowrSearchGenerator',
+        inlineTypes: doc_types_1.mermaidHide
+    });
+    return `${(0, doc_auto_gen_1.autoGenHeader)({ filename: module.filename, purpose: 'search API', rVersion: rversion })}
+
+This page briefly summarizes flowR's search API which provides a set of functions to search for nodes in the [Dataflow Graph](${doc_files_1.FlowrWikiBaseRef}/Dataflow%20Graph) and the 
+[Normalized AST](${doc_files_1.FlowrWikiBaseRef}/Normalized%20AST) of a given R code (the search will always consider both, with respect to your search query).
+Please see the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface) wiki page for more information on how to access this API.
+Within code, you can execute a search using the ${(0, doc_types_1.shortLink)('runSearch', types.info)} function.
+
+For an initial motivation, let's have a look at the following example:
+
+${await (0, doc_search_1.showSearch)(shell, 'x <- x * x', flowr_search_builder_1.Q.var('x'))}
+
+This returns all references to the variable \`x\` in the code.
+However, the search API is not limited to simple variable references and can do much more.
+
+For example, let's have every definition of \`x\` in the code but the first one:
+
+${await (0, doc_search_1.showSearch)(shell, 'x <- x * x\nprint(x)\nx <- y <- 3\nprint(x)\nx <- 2', flowr_search_builder_1.Q.var('x').filter(vertex_1.VertexType.VariableDefinition).skip(1))}
+
+In summary, every search has two parts. It is initialized with a _generator_ (such as \`Q.var('x')\`)
+and can be further refined with _transformers_ or _modifiers_.
+Such queries can be constructed starting from the ${(0, doc_types_1.shortLink)('Q', types.info)} object (backed by ${(0, doc_types_1.shortLink)('FlowrSearchGenerator', types.info)}) and
+are fully serializable so you can use them when communicating with the [Query API](${doc_files_1.FlowrWikiBaseRef}/Query%20API).
+
+We offer the following generators:
+
+${Object.keys(flowr_search_builder_1.Q).sort().map(key => `- ${(0, doc_types_1.shortLink)(`FlowrSearchGenerator::${key}`, types.info)}\\\n${(0, doc_types_1.getDocumentationForType)(`FlowrSearchGenerator::${key}`, types.info)}`).join('\n')}
+
+Likewise, we have a palette of _transformers_ and _modifiers_:
+
+${
+    /* let's iterate over all methods of FlowrSearchBuilder */
+    Object.getOwnPropertyNames(Object.getPrototypeOf(new flowr_search_builder_1.FlowrSearchBuilder(undefined)))
+        .filter(n => n !== 'constructor').sort().map(key => `- ${(0, doc_types_1.shortLink)(`FlowrSearchBuilder::${key}`, types.info)}\\\n${(0, doc_types_1.getDocumentationForType)(`FlowrSearchBuilder::${key}`, types.info)}`).join('\n')}
+
+Every search (and consequently the search pipeline) works with an array of ${(0, doc_types_1.shortLink)('FlowrSearchElement', types.info)} (neatly wrapped in ${(0, doc_types_1.shortLink)('FlowrSearchElements', types.info)}).
+Hence, even operations such as \`.first\` or \`.last\` return an array of elements (albeit with a single or no element).
+The search API does its best to stay typesafe wrt. to the return type and the transformers in use. 
+In addition, it offers optimizer passes to optimize the search pipeline before execution.
+They are executed with \`.build\` which may happen automatically, whenever you want to run a search using ${(0, doc_types_1.shortLink)('runSearch', types.info)}.
+
+`;
+}
+/** if we run this script, we want a Markdown representation of the capabilities */
+if (require.main === module) {
+    (0, log_1.setMinLevelOfAllLogs)(6 /* LogLevel.Fatal */);
+    const shell = new shell_1.RShell();
+    void getText(shell).then(str => {
+        console.log(str);
+    }).finally(() => {
+        shell.close();
+    });
+}
+//# sourceMappingURL=print-search-wiki.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eagleoutice/flowr",
-  "version": "2.1.11",
+  "version": "2.1.12",
   "description": "Static Dataflow Analyzer and Program Slicer for the R Programming Language",
   "types": "dist/src/index.d.ts",
   "repository": {
@@ -28,6 +28,7 @@
     "wiki:df-graph": "ts-node src/documentation/print-dataflow-graph-wiki.ts",
     "wiki:normalized-ast": "ts-node src/documentation/print-normalized-ast-wiki.ts",
     "wiki:query-api": "ts-node src/documentation/print-query-wiki.ts",
+    "wiki:search-api": "ts-node src/documentation/print-search-wiki.ts",
     "wiki:linting-and-testing": "ts-node src/documentation/print-linting-and-testing-wiki.ts",
     "wiki:interface": "ts-node src/documentation/print-interface-wiki.ts",
     "build": "tsc --project .",

package/queries/base-query-format.d.ts

@@ -1,5 +1,5 @@
 import type { NormalizedAst } from '../r-bridge/lang-4.x/ast/model/processing/decorate';
-import type { DataflowGraph } from '../dataflow/graph/graph';
+import type { DataflowInformation } from '../dataflow/info';
 export interface BaseQueryFormat {
     /** used to select the query type :) */
     readonly type: string;
@@ -13,5 +13,5 @@ export interface BaseQueryResult {
 }
 export interface BasicQueryData {
     readonly ast: NormalizedAst;
-    readonly graph: DataflowGraph;
+    readonly dataflow: DataflowInformation;
 }

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

@@ -9,4 +9,4 @@ import type { BasicQueryData } from '../../base-query-format';
  *    This happens during the main resolution!
  * 4. Attach `linkTo` calls to the respective calls.
  */
-export declare function executeCallContextQueries({ graph, ast }: BasicQueryData, queries: readonly CallContextQuery[]): CallContextQueryResult;
+export declare function executeCallContextQueries({ dataflow: { graph }, ast }: BasicQueryData, queries: readonly CallContextQuery[]): CallContextQueryResult;

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

@@ -158,7 +158,7 @@ function doesFilepathMatch(file, filter) {
  *    This happens during the main resolution!
  * 4. Attach `linkTo` calls to the respective calls.
  */
-function executeCallContextQueries({ graph, ast }, queries) {
+function executeCallContextQueries({ dataflow: { graph }, ast }, queries) {
     /* omit performance page load */
     const now = Date.now();
     /* the node id and call targets if present */

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

@@ -1,3 +1,3 @@
 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;
+export declare function executeDataflowClusterQuery({ dataflow: { graph } }: BasicQueryData, queries: readonly DataflowClusterQuery[]): DataflowClusterQueryResult;

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

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeDataflowClusterQuery = executeDataflowClusterQuery;
 const log_1 = require("../../../util/log");
 const cluster_1 = require("../../../dataflow/cluster");
-function executeDataflowClusterQuery({ graph }, queries) {
+function executeDataflowClusterQuery({ dataflow: { graph } }, queries) {
     if (queries.length !== 1) {
         log_1.log.warn('The dataflow cluster query expects only up to one query, but got', queries.length);
     }

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

@@ -1,3 +1,3 @@
 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;
+export declare function executeDataflowQuery({ dataflow: { graph } }: BasicQueryData, queries: readonly DataflowQuery[]): DataflowQueryResult;

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

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeDataflowQuery = executeDataflowQuery;
 const log_1 = require("../../../util/log");
-function executeDataflowQuery({ graph }, queries) {
+function executeDataflowQuery({ dataflow: { graph } }, queries) {
     if (queries.length !== 1) {
         log_1.log.warn('Dataflow query expects only up to one query, but got', queries.length);
     }

package/queries/catalog/dependencies-query/dependencies-query-executor.js

@@ -83,7 +83,7 @@ function makeCallContextQuery(functions, kind) {
 }
 function getResults(data, results, kind, functions, makeInfo, additionalAllowedTypes) {
     return Object.entries(results?.kinds[kind]?.subkinds ?? {}).flatMap(([name, results]) => results.flatMap(({ id, linkedIds }) => {
-        const vertex = data.graph.getVertex(id);
+        const vertex = data.dataflow.graph.getVertex(id);
         const info = functions.find(f => f.name === name);
         let index = info.argIdx;
         if (info.argName) {
@@ -99,7 +99,7 @@ function getResults(data, results, kind, functions, makeInfo, additionalAllowedT
         return args.flatMap(a => (0, objects_1.compactRecord)(makeInfo(id, vertex, a, linkedIds)));
     })).filter(assert_1.isNotUndefined) ?? [];
 }
-function getArgumentValue({ graph }, vertex, argumentIndex, additionalAllowedTypes) {
+function getArgumentValue({ dataflow: { graph } }, vertex, argumentIndex, additionalAllowedTypes) {
     if (vertex) {
         if (argumentIndex === 'unnamed') {
             // return all unnamed arguments

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

@@ -1,3 +1,3 @@
 import type { LineageQuery, LineageQueryResult } from './lineage-query-format';
 import type { BasicQueryData } from '../../base-query-format';
-export declare function executeLineageQuery({ graph, ast }: BasicQueryData, queries: readonly LineageQuery[]): LineageQueryResult;
+export declare function executeLineageQuery({ dataflow: { graph }, ast }: BasicQueryData, queries: readonly LineageQuery[]): LineageQueryResult;

package/queries/catalog/lineage-query/lineage-query-executor.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeLineageQuery = executeLineageQuery;
 const log_1 = require("../../../util/log");
 const repl_lineage_1 = require("../../../cli/repl/commands/repl-lineage");
-function executeLineageQuery({ graph, ast }, queries) {
+function executeLineageQuery({ dataflow: { graph }, ast }, queries) {
     const start = Date.now();
     const result = {};
     for (const { criterion } of queries) {

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

@@ -0,0 +1,3 @@
+import type { BasicQueryData } from '../../base-query-format';
+import type { SearchQuery, SearchQueryResult } from './search-query-format';
+export declare function executeSearch({ ast, dataflow }: BasicQueryData, queries: readonly SearchQuery[]): SearchQueryResult;

package/queries/catalog/search-query/search-query-executor.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeSearch = executeSearch;
+const log_1 = require("../../../util/log");
+const flowr_search_executor_1 = require("../../../search/flowr-search-executor");
+function executeSearch({ ast, dataflow }, queries) {
+    const start = Date.now();
+    if (queries.length !== 1) {
+        log_1.log.warn('Id-Map query expects only up to one query, but got', queries.length);
+    }
+    const results = [];
+    for (const query of queries) {
+        const { search } = query;
+        results.push({
+            ids: (0, flowr_search_executor_1.runSearch)(search, { normalize: ast, dataflow })
+                .map(({ node }) => node.info.id),
+            search
+        });
+    }
+    return {
+        '.meta': {
+            timing: Date.now() - start
+        },
+        results
+    };
+}
+//# sourceMappingURL=search-query-executor.js.map

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

@@ -0,0 +1,72 @@
+import type { BaseQueryFormat, BaseQueryResult } from '../../base-query-format';
+import Joi from 'joi';
+import type { FlowrSearch } from '../../../search/flowr-search-builder';
+import type { NodeId } from '../../../r-bridge/lang-4.x/ast/model/processing/node-id';
+import { executeSearch } from './search-query-executor';
+export interface SearchQuery extends BaseQueryFormat {
+    readonly type: 'search';
+    readonly search: FlowrSearch;
+}
+export interface SearchQueryResult extends BaseQueryResult {
+    readonly results: {
+        ids: NodeId[];
+        search: FlowrSearch;
+    }[];
+}
+export declare const SearchQueryDefinition: {
+    readonly executor: typeof executeSearch;
+    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/search-query/search-query-format.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchQueryDefinition = void 0;
+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 search_query_executor_1 = require("./search-query-executor");
+const flowr_search_printer_1 = require("../../../search/flowr-search-printer");
+const mermaid_1 = require("../../../util/mermaid/mermaid");
+exports.SearchQueryDefinition = {
+    executor: search_query_executor_1.executeSearch,
+    asciiSummarizer: (formatter, _processed, queryResults, result) => {
+        const out = queryResults;
+        result.push(`Query: ${(0, ansi_1.bold)('search', formatter)} (${(0, time_1.printAsMs)(out['.meta'].timing, 0)})`);
+        for (const [, { ids, search }] of out.results.entries()) {
+            result.push(`   ╰ [query](${(0, mermaid_1.mermaidCodeToUrl)((0, flowr_search_printer_1.flowrSearchToMermaid)(search))}): {${(0, query_print_1.summarizeIdsIfTooLong)(formatter, ids)}}`);
+        }
+        return true;
+    },
+    schema: joi_1.default.object({
+        type: joi_1.default.string().valid('search').required().description('The type of the query.'),
+        search: joi_1.default.object().required().description('The search query to execute.')
+    }).description('The id map query retrieves the id map from the normalized AST.')
+};
+//# sourceMappingURL=search-query-format.js.map

package/queries/catalog/static-slice-query/static-slice-query-executor.d.ts

@@ -1,4 +1,4 @@
 import type { StaticSliceQuery, StaticSliceQueryResult } from './static-slice-query-format';
 import type { BasicQueryData } from '../../base-query-format';
 export declare function fingerPrintOfQuery(query: StaticSliceQuery): string;
-export declare function executeStaticSliceQuery({ graph, ast }: BasicQueryData, queries: readonly StaticSliceQuery[]): StaticSliceQueryResult;
+export declare function executeStaticSliceQuery({ dataflow: { graph }, ast }: BasicQueryData, queries: readonly StaticSliceQuery[]): StaticSliceQueryResult;

package/queries/catalog/static-slice-query/static-slice-query-executor.js

@@ -10,7 +10,7 @@ const log_1 = require("../../../util/log");
 function fingerPrintOfQuery(query) {
     return JSON.stringify(query);
 }
-function executeStaticSliceQuery({ graph, ast }, queries) {
+function executeStaticSliceQuery({ dataflow: { graph }, ast }, queries) {
     const start = Date.now();
     const results = {};
     for (const query of queries) {

package/queries/query.d.ts

@@ -15,7 +15,8 @@ import type { DEFAULT_DATAFLOW_PIPELINE } from '../core/steps/pipeline/default-p
 import Joi from 'joi';
 import type { LocationMapQuery } from './catalog/location-map-query/location-map-query-format';
 import type { ConfigQuery } from './catalog/config-query/config-query-format';
-export type Query = CallContextQuery | ConfigQuery | DataflowQuery | NormalizedAstQuery | IdMapQuery | DataflowClusterQuery | StaticSliceQuery | LineageQuery | DependenciesQuery | LocationMapQuery;
+import type { SearchQuery } from './catalog/search-query/search-query-format';
+export type Query = CallContextQuery | ConfigQuery | SearchQuery | DataflowQuery | NormalizedAstQuery | IdMapQuery | DataflowClusterQuery | StaticSliceQuery | LineageQuery | DependenciesQuery | LocationMapQuery;
 export type QueryArgumentsWithType<QueryType extends BaseQueryFormat['type']> = Query & {
     type: QueryType;
 };
@@ -443,6 +444,63 @@ export declare const SupportedQueries: {
         readonly asciiSummarizer: (formatter: OutputFormatter, _processed: unknown, queryResults: BaseQueryResult, result: string[]) => boolean;
         readonly schema: Joi.ObjectSchema<any>;
     };
+    readonly search: {
+        readonly executor: typeof import("./catalog/search-query/search-query-executor").executeSearch;
+        readonly asciiSummarizer: (formatter: OutputFormatter, _processed: 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>;
+    };
 };
 export type SupportedQueryTypes = keyof typeof SupportedQueries;
 export type QueryResult<Type extends Query['type']> = ReturnType<typeof SupportedQueries[Type]['executor']>;

package/queries/query.js

@@ -23,6 +23,7 @@ const dependencies_query_format_1 = require("./catalog/dependencies-query/depend
 const joi_1 = __importDefault(require("joi"));
 const location_map_query_format_1 = require("./catalog/location-map-query/location-map-query-format");
 const config_query_format_1 = require("./catalog/config-query/config-query-format");
+const search_query_format_1 = require("./catalog/search-query/search-query-format");
 exports.SupportedQueries = {
     'call-context': call_context_query_format_1.CallContextQueryDefinition,
     'config': config_query_format_1.ConfigQueryDefinition,
@@ -33,7 +34,8 @@ exports.SupportedQueries = {
     'static-slice': static_slice_query_format_1.StaticSliceQueryDefinition,
     'lineage': lineage_query_format_1.LineageQueryDefinition,
     'dependencies': dependencies_query_format_1.DependenciesQueryDefinition,
-    'location-map': location_map_query_format_1.LocationMapQueryDefinition
+    'location-map': location_map_query_format_1.LocationMapQueryDefinition,
+    'search': search_query_format_1.SearchQueryDefinition
 };
 function executeQueriesOfSameType(data, ...queries) {
     (0, assert_1.guard)(queries.length > 0, 'At least one query must be provided');

package/r-bridge/lang-4.x/ast/model/type.d.ts

@@ -204,6 +204,10 @@ export declare enum RType {
      */
     Delimiter = "RDelimiter"
 }
+export declare const ValidRTypes: Set<string>;
+export declare const ValidRTypesReverse: {
+    [k: string]: string;
+};
 /**
  * Validates, whether the given type can be used as a symbol in R
  *

package/r-bridge/lang-4.x/ast/model/type.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RType = exports.RawRType = void 0;
+exports.ValidRTypesReverse = exports.ValidRTypes = exports.RType = exports.RawRType = void 0;
 exports.isSymbol = isSymbol;
 /**
  * Token types as they are produced by the R parser.
@@ -211,6 +211,8 @@ var RType;
      */
     RType["Delimiter"] = "RDelimiter";
 })(RType || (exports.RType = RType = {}));
+exports.ValidRTypes = new Set(Object.values(RType));
+exports.ValidRTypesReverse = Object.fromEntries(Object.entries(RType).map(([k, v]) => [v, k]));
 const validSymbolTypes = new Set([
     RawRType.Symbol,
     RawRType.SymbolPackage,