@eagleoutice/flowr 2.6.1 → 2.6.3

package/core/print/normalize-printer.d.ts

@@ -1,7 +1,27 @@
-import type { QuadSerializationConfiguration } from '../../util/quads';
+import { type QuadSerializationConfiguration } from '../../util/quads';
 import type { NormalizedAst } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
 /** Should work with larger things as well */
 export declare function normalizedAstToJson(ast: NormalizedAst): string;
+/**
+ * Normalized AST to quads serialization this does not have multi-file support
+ * @see {@link serialize2quads}
+ * @see {@link QuadSerializationConfiguration}
+ * @see {@link normalizedAstToMermaid}
+ * @see {@link normalizedAstToMermaidUrl}
+ * @see {@link printNormalizedAstToMermaidUrl}
+ */
 export declare function normalizedAstToQuads(ast: NormalizedAst, config: QuadSerializationConfiguration): string;
+/**
+ * Serialize the normalized AST to mermaid format
+ * @see {@link normalizedAstToMermaid}
+ * @see {@link normalizedAstToMermaidUrl}
+ * @see {@link printNormalizedAstToMermaidUrl}
+ */
 export declare function printNormalizedAstToMermaid(ast: NormalizedAst): string;
+/**
+ * Serialize the normalized AST to a mermaid URL
+ * @see {@link normalizedAstToMermaid}
+ * @see {@link normalizedAstToMermaidUrl}
+ * @see {@link printNormalizedAstToMermaid}
+ */
 export declare function printNormalizedAstToMermaidUrl(ast: NormalizedAst): string;

package/core/print/normalize-printer.js

@@ -17,12 +17,32 @@ function normalizedAstToJson(ast) {
         return (0, json_1.jsonReplacer)(k, v);
     });
 }
+/**
+ * Normalized AST to quads serialization this does not have multi-file support
+ * @see {@link serialize2quads}
+ * @see {@link QuadSerializationConfiguration}
+ * @see {@link normalizedAstToMermaid}
+ * @see {@link normalizedAstToMermaidUrl}
+ * @see {@link printNormalizedAstToMermaidUrl}
+ */
 function normalizedAstToQuads(ast, config) {
-    return (0, quads_1.serialize2quads)(ast.ast, config);
+    return (0, quads_1.serialize2quads)(ast.ast.files[0].root, config);
 }
+/**
+ * Serialize the normalized AST to mermaid format
+ * @see {@link normalizedAstToMermaid}
+ * @see {@link normalizedAstToMermaidUrl}
+ * @see {@link printNormalizedAstToMermaidUrl}
+ */
 function printNormalizedAstToMermaid(ast) {
     return (0, ast_1.normalizedAstToMermaid)(ast.ast);
 }
+/**
+ * Serialize the normalized AST to a mermaid URL
+ * @see {@link normalizedAstToMermaid}
+ * @see {@link normalizedAstToMermaidUrl}
+ * @see {@link printNormalizedAstToMermaid}
+ */
 function printNormalizedAstToMermaidUrl(ast) {
     return (0, ast_1.normalizedAstToMermaidUrl)(ast.ast);
 }

package/core/print/parse-printer.d.ts

@@ -1,2 +1,7 @@
-import type { QuadSerializationConfiguration } from '../../util/quads';
+import { type QuadSerializationConfiguration } from '../../util/quads';
+/**
+ * Parse R code and serialize it to quads
+ * @see {@link serialize2quads}
+ * @see {@link QuadSerializationConfiguration}
+ */
 export declare function parseToQuads(code: string, config: QuadSerializationConfiguration): string;

package/core/print/parse-printer.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseToQuads = parseToQuads;
 const quads_1 = require("../../util/quads");
 const format_1 = require("../../r-bridge/lang-4.x/ast/parser/json/format");
+/**
+ * Parse R code and serialize it to quads
+ * @see {@link serialize2quads}
+ * @see {@link QuadSerializationConfiguration}
+ */
 function parseToQuads(code, config) {
     return (0, quads_1.serialize2quads)((0, format_1.convertPreparedParsedData)((0, format_1.prepareParsedData)(code)), config);
 }

package/core/print/print.d.ts

@@ -37,7 +37,6 @@ export declare const enum StepOutputFormat {
 }
 /**
  * Helper function to support the {@link Internal} format, as it is simply returning the input.
- *
  * @see IPipelineStepPrinter
  */
 export declare function internalPrinter<Input>(input: Input): Input;

package/core/print/print.js

@@ -5,7 +5,6 @@ exports.printStepResult = printStepResult;
 const assert_1 = require("../../util/assert");
 /**
  * Helper function to support the {@link Internal} format, as it is simply returning the input.
- *
  * @see IPipelineStepPrinter
  */
 function internalPrinter(input) {

package/core/print/slice-diff-ansi.d.ts

@@ -1,3 +1,6 @@
 import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
 import type { NormalizedAst } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
+/**
+ * Print a slice diff with ANSI colors
+ */
 export declare function sliceDiffAnsi(slice: ReadonlySet<NodeId>, normalized: NormalizedAst, criteriaIds: ReadonlySet<NodeId>, originalCode: string): string;

package/core/print/slice-diff-ansi.js

@@ -26,6 +26,9 @@ function highlight(s, selected) {
     const primary = ansi_1.ansiFormatter.format(s, { color: 3 /* Colors.Yellow */, effect: ansi_1.ColorEffect.Foreground, style: 1 /* FontStyles.Bold */ });
     return selected ? ansi_1.ansiFormatter.format(primary, { style: 4 /* FontStyles.Underline */ }) : primary;
 }
+/**
+ * Print a slice diff with ANSI colors
+ */
 function sliceDiffAnsi(slice, normalized, criteriaIds, originalCode) {
     let importantLocations = Array.from(normalized.idMap.entries())
         .filter(([id, { location }]) => slice.has(id) && (0, assert_1.isNotUndefined)(location))

package/core/steps/all/core/00-parse.d.ts

@@ -1,7 +1,7 @@
 import { internalPrinter } from '../../../print/print';
 import { PipelineStepStage } from '../../pipeline-step';
 import type { QuadSerializationConfiguration } from '../../../../util/quads';
-import type { ParseRequiredInput } from '../../../../r-bridge/parser';
+import { type ParseRequiredInput } from '../../../../r-bridge/parser';
 export declare const PARSE_WITH_R_SHELL_STEP: {
     readonly name: "parse";
     readonly humanReadableName: "parse with R shell";
@@ -14,7 +14,7 @@ export declare const PARSE_WITH_R_SHELL_STEP: {
             (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("../../../../r-bridge/parser").ParseStepOutput<string>, config: QuadSerializationConfiguration) => string;
+        readonly 5: (p: import("../../../../r-bridge/parser").ParseStepOutput<string>, config: QuadSerializationConfiguration) => string;
     };
     readonly dependencies: readonly [];
     readonly requiredInput: ParseRequiredInput<string>;

package/core/steps/all/core/00-parse.js

@@ -13,7 +13,7 @@ exports.PARSE_WITH_R_SHELL_STEP = {
     printer: {
         [0 /* StepOutputFormat.Internal */]: print_1.internalPrinter,
         [2 /* StepOutputFormat.Json */]: JSON.stringify,
-        [5 /* StepOutputFormat.RdfQuads */]: ({ parsed }, config) => (0, parse_printer_1.parseToQuads)(parsed, config)
+        [5 /* StepOutputFormat.RdfQuads */]: (p, config) => (0, parse_printer_1.parseToQuads)(p.files[0].parsed, config)
     },
     dependencies: [],
     requiredInput: undefined

package/core/steps/all/core/01-parse-tree-sitter.d.ts

@@ -1,17 +1,7 @@
 import { PipelineStepStage } from '../../pipeline-step';
 import { internalPrinter } from '../../../print/print';
 import type { Tree } from 'web-tree-sitter';
-import type { ParseRequiredInput } from '../../../../r-bridge/parser';
-export interface ParseStepOutputTS {
-    readonly parsed: Tree;
-}
-export interface TreeSitterParseJson {
-    readonly '.meta': {
-        readonly tokenCount: number;
-        readonly tokenCountNoComments: number;
-    };
-    readonly str: string;
-}
+import { type ParseRequiredInput } from '../../../../r-bridge/parser';
 export declare const PARSE_WITH_TREE_SITTER_STEP: {
     readonly name: "parse";
     readonly humanReadableName: "parse with tree-sitter";

package/core/steps/all/core/10-normalize.d.ts

@@ -3,19 +3,16 @@ import { normalizedAstToJson, normalizedAstToQuads, printNormalizedAstToMermaid,
 import { PipelineStepStage } from '../../pipeline-step';
 import type { IdGenerator } from '../../../../r-bridge/lang-4.x/ast/model/processing/decorate';
 import type { NoInfo } from '../../../../r-bridge/lang-4.x/ast/model/model';
-import type { RParseRequests } from '../../../../r-bridge/retriever';
 import type { ParseStepOutput } from '../../../../r-bridge/parser';
+import type { FlowrAnalyzerContext } from '../../../../project/context/flowr-analyzer-context';
 export interface NormalizeRequiredInput {
     /** This id generator is only necessary if you want to retrieve a dataflow from the parsed R AST, it determines the id generator to use and by default uses the {@link deterministicCountingIdGenerator}*/
     readonly getId?: IdGenerator<NoInfo>;
-    readonly request: RParseRequests;
-    /** assume the input stems from a file and use the given path as the file path for the AST */
-    readonly overwriteFilePath?: string;
+    readonly context: FlowrAnalyzerContext;
 }
-export declare function getCurrentRequestFile(request: RParseRequests | undefined): string | undefined;
 declare function processor(results: {
     parse?: ParseStepOutput<string>;
-}, input: Partial<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>>;
+}, input: Partial<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/nodes/r-project").RProject<import("../../../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>>;
 export declare const NORMALIZE: {
     readonly name: "normalize";
     readonly humanReadableName: "normalize";

package/core/steps/all/core/10-normalize.js

@@ -1,23 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NORMALIZE = void 0;
-exports.getCurrentRequestFile = getCurrentRequestFile;
 const print_1 = require("../../../print/print");
 const normalize_printer_1 = require("../../../print/normalize-printer");
 const parser_1 = require("../../../../r-bridge/lang-4.x/ast/parser/json/parser");
-function getCurrentRequestFile(request) {
-    if (request === undefined) {
-        return undefined;
-    }
-    else if (Array.isArray(request)) {
-        return request[0].request === 'file' ? request[0].content : undefined;
-    }
-    else {
-        return request.request === 'file' ? request.content : undefined;
-    }
-}
 function processor(results, input) {
-    return (0, parser_1.normalize)(results.parse, input.getId, input.overwriteFilePath ?? getCurrentRequestFile(input.request));
+    return (0, parser_1.normalize)(results.parse, input.getId);
 }
 exports.NORMALIZE = {
     name: 'normalize',

package/core/steps/all/core/11-normalize-tree-sitter.d.ts

@@ -1,12 +1,12 @@
 import { internalPrinter } from '../../../print/print';
 import { normalizedAstToJson, normalizedAstToQuads, printNormalizedAstToMermaid, printNormalizedAstToMermaidUrl } from '../../../print/normalize-printer';
 import { PipelineStepStage } from '../../pipeline-step';
-import type { NormalizeRequiredInput } from './10-normalize';
-import type { ParseStepOutputTS } from './01-parse-tree-sitter';
-import type { FlowrConfigOptions } from '../../../../config';
+import { type NormalizeRequiredInput } from './10-normalize';
+import type { ParseStepOutput } from '../../../../r-bridge/parser';
+import type { Tree } from 'web-tree-sitter';
 declare function processor(results: {
-    'parse'?: ParseStepOutputTS;
-}, input: Partial<NormalizeRequiredInput>, config: FlowrConfigOptions): 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>>;
+    parse?: ParseStepOutput<Tree>;
+}, input: Partial<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/nodes/r-project").RProject<import("../../../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>>;
 export declare const NORMALIZE_TREE_SITTER: {
     readonly name: "normalize";
     readonly humanReadableName: "normalize tree-sitter tree";

package/core/steps/all/core/11-normalize-tree-sitter.js

@@ -4,9 +4,8 @@ exports.NORMALIZE_TREE_SITTER = void 0;
 const print_1 = require("../../../print/print");
 const normalize_printer_1 = require("../../../print/normalize-printer");
 const parser_1 = require("../../../../r-bridge/lang-4.x/ast/parser/json/parser");
-const _10_normalize_1 = require("./10-normalize");
-function processor(results, input, config) {
-    return (0, parser_1.normalizeTreeSitter)(results['parse'], input.getId, config, input.overwriteFilePath ?? (0, _10_normalize_1.getCurrentRequestFile)(input.request));
+function processor(results, input) {
+    return (0, parser_1.normalizeTreeSitter)(results.parse, input.getId, input.context.config);
 }
 exports.NORMALIZE_TREE_SITTER = {
     name: 'normalize',

package/core/steps/all/core/20-dataflow.d.ts

@@ -2,15 +2,14 @@ import { internalPrinter } from '../../../print/print';
 import { PipelineStepStage } from '../../pipeline-step';
 import { dataflowGraphToJson, dataflowGraphToMermaid, dataflowGraphToMermaidUrl, dataflowGraphToQuads } from '../../../print/dataflow-printer';
 import type { NormalizedAst } from '../../../../r-bridge/lang-4.x/ast/model/processing/decorate';
-import type { RParseRequests } from '../../../../r-bridge/retriever';
 import type { KnownParserType, Parser } from '../../../../r-bridge/parser';
-import type { FlowrConfigOptions } from '../../../../config';
+import type { FlowrAnalyzerContext } from '../../../../project/context/flowr-analyzer-context';
 declare function processor(results: {
     normalize?: NormalizedAst;
 }, input: {
-    request?: RParseRequests;
     parser?: Parser<KnownParserType>;
-}, config: FlowrConfigOptions): import("../../../../dataflow/info").DataflowInformation & {
+    context?: FlowrAnalyzerContext;
+}): import("../../../../dataflow/info").DataflowInformation & {
     cfgQuick: import("../../../../control-flow/control-flow-graph").ControlFlowInformation | undefined;
 };
 export declare const STATIC_DATAFLOW: {

package/core/steps/all/core/20-dataflow.js

@@ -17,8 +17,8 @@ const staticDataflowCommon = {
     },
     dependencies: ['normalize'],
 };
-function processor(results, input, config) {
-    return (0, extractor_1.produceDataFlowGraph)(input.parser, input.request, results.normalize, config);
+function processor(results, input) {
+    return (0, extractor_1.produceDataFlowGraph)(input.parser, results.normalize, input.context);
 }
 exports.STATIC_DATAFLOW = {
     ...staticDataflowCommon,

package/core/steps/all/static-slicing/00-slice.d.ts

@@ -3,7 +3,6 @@ import { PipelineStepStage } from '../../pipeline-step';
 import type { DataflowInformation } from '../../../../dataflow/info';
 import type { SlicingCriteria } from '../../../../slicing/criterion/parse';
 import type { NormalizedAst } from '../../../../r-bridge/lang-4.x/ast/model/processing/decorate';
-import type { FlowrConfigOptions } from '../../../../config';
 export interface SliceRequiredInput {
     /** The slicing criterion is only of interest if you actually want to slice the R code */
     readonly criterion: SlicingCriteria;
@@ -19,7 +18,7 @@ export declare enum SliceDirection {
 declare function processor(results: {
     dataflow?: DataflowInformation;
     normalize?: NormalizedAst;
-}, input: Partial<SliceRequiredInput>, _config: FlowrConfigOptions): Readonly<import("../../../../slicing/static/slicer-types").SliceResult>;
+}, input: Partial<SliceRequiredInput>): Readonly<import("../../../../slicing/static/slicer-types").SliceResult>;
 export declare const STATIC_SLICE: {
     readonly name: "slice";
     readonly humanReadableName: "static slice";

package/core/steps/all/static-slicing/00-slice.js

@@ -8,7 +8,7 @@ var SliceDirection;
     SliceDirection["Backward"] = "backward";
     SliceDirection["Forward"] = "forward";
 })(SliceDirection || (exports.SliceDirection = SliceDirection = {}));
-function processor(results, input, _config) {
+function processor(results, input) {
     const direction = input.direction ?? SliceDirection.Backward;
     return (0, static_slicer_1.staticSlice)(results.dataflow, results.normalize, input.criterion, direction, input.threshold);
 }

package/core/steps/all/static-slicing/10-reconstruct.d.ts

@@ -5,6 +5,14 @@ import type { NormalizedAst } from '../../../../r-bridge/lang-4.x/ast/model/proc
 import type { AutoSelectPredicate } from '../../../../reconstruct/auto-select/auto-select-defaults';
 export interface ReconstructRequiredInput {
     autoSelectIf?: AutoSelectPredicate;
+    /**
+     * When confronted with a project of multiple files the question for reconstruct arises wrt. which files to rebuild.
+     * This option can be used to either reconstruct all files or only specific files by their index in the project.
+     * By default, (for legacy) this will reconstruct the *first* file (index 0).
+     *
+     * Either you can set this to `'all'` to reconstruct all files or provide an array of file indices in the files context to reconstruct only those files.
+     */
+    reconstructFiles?: 'all' | number[];
 }
 declare function processor(results: {
     normalize?: NormalizedAst;

package/core/steps/all/static-slicing/10-reconstruct.js

@@ -4,7 +4,10 @@ exports.NAIVE_RECONSTRUCT = void 0;
 const print_1 = require("../../../print/print");
 const reconstruct_1 = require("../../../../reconstruct/reconstruct");
 function processor(results, input) {
-    return (0, reconstruct_1.reconstructToCode)(results.normalize, results.slice.result, input.autoSelectIf);
+    return (0, reconstruct_1.reconstructToCode)(results.normalize, {
+        nodes: results.slice.result,
+        reconstructFiles: input.reconstructFiles
+    }, input.autoSelectIf);
 }
 exports.NAIVE_RECONSTRUCT = {
     name: 'reconstruct',

package/core/steps/pipeline/create-pipeline.d.ts

@@ -1,4 +1,4 @@
-import type { IPipelineStep } from '../pipeline-step';
+import { type IPipelineStep } from '../pipeline-step';
 import type { Pipeline } from './pipeline';
 /**
  * Given a set of {@link IPipelineStep|steps} with their dependencies, this function verifies all requirements of {@link createPipeline}.