@eagleoutice/flowr 1.4.2 → 1.5.1

package/cli/repl/core.js

@@ -1,172 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadReplHistory = exports.repl = exports.replProcessAnswer = exports.DEFAULT_REPL_READLINE_CONFIGURATION = exports.replCompleter = void 0;
-/**
- * Basically a helper file to allow the main 'flowr' script (located in the source root) to provide its repl
- *
- * @module
- */
-const r_bridge_1 = require("../../r-bridge");
-const statistics_1 = require("../../statistics");
-const prompt_1 = require("./prompt");
-const commands_1 = require("./commands");
-const readline = __importStar(require("readline"));
-const args_1 = require("../../util/args");
-const execute_1 = require("./commands/execute");
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
-const common_1 = require("../common");
-let _replCompleterKeywords = undefined;
-function replCompleterKeywords() {
-    if (_replCompleterKeywords === undefined) {
-        _replCompleterKeywords = Array.from((0, commands_1.getCommandNames)(), s => `:${s}`);
-    }
-    return _replCompleterKeywords;
-}
-const defaultHistoryFile = path_1.default.join(os_1.default.tmpdir(), '.flowrhistory');
-/**
- * Used by the repl to provide automatic completions for a given (partial) input line
- */
-function replCompleter(line) {
-    const splitLine = (0, args_1.splitAtEscapeSensitive)(line);
-    // did we just type a space (and are starting a new arg right now)?
-    const startingNewArg = line.endsWith(' ');
-    // if we typed a command fully already, autocomplete the arguments
-    if (splitLine.length > 1 || startingNewArg) {
-        const commandNameColon = replCompleterKeywords().find(k => splitLine[0] === k);
-        if (commandNameColon) {
-            const completions = [];
-            const commandName = commandNameColon.slice(1);
-            if ((0, commands_1.getCommand)(commandName)?.script === true) {
-                // autocomplete script arguments
-                const options = common_1.scripts[commandName].options;
-                completions.push(...(0, common_1.getValidOptionsForCompletion)(options, splitLine).map(o => `${o} `));
-            }
-            else {
-                // autocomplete command arguments (specifically, autocomplete the file:// protocol)
-                completions.push(r_bridge_1.fileProtocol);
-            }
-            // add an empty option so that it doesn't autocomplete the only defined option immediately
-            completions.push(' ');
-            const currentArg = startingNewArg ? '' : splitLine[splitLine.length - 1];
-            return [completions.filter(a => a.startsWith(currentArg)), currentArg];
-        }
-    }
-    // if no command is already typed, just return all commands that match
-    return [replCompleterKeywords().filter(k => k.startsWith(line)).map(k => `${k} `), line];
-}
-exports.replCompleter = replCompleter;
-exports.DEFAULT_REPL_READLINE_CONFIGURATION = {
-    input: process.stdin,
-    output: process.stdout,
-    tabSize: 4,
-    terminal: true,
-    history: loadReplHistory(defaultHistoryFile),
-    removeHistoryDuplicates: true,
-    completer: replCompleter
-};
-async function replProcessStatement(output, statement, shell) {
-    if (statement.startsWith(':')) {
-        const command = statement.slice(1).split(' ')[0].toLowerCase();
-        const processor = (0, commands_1.getCommand)(command);
-        if (processor) {
-            try {
-                await processor.fn(output, shell, statement.slice(command.length + 2).trim());
-            }
-            catch (e) {
-                console.log(`${(0, statistics_1.bold)(`Failed to execute command ${command}`)}: ${e?.message}. Using the ${(0, statistics_1.bold)('--verbose')} flag on startup may provide additional information.`);
-            }
-        }
-        else {
-            console.log(`the command '${command}' is unknown, try ${(0, statistics_1.bold)(':help')} for more information`);
-        }
-    }
-    else {
-        await (0, execute_1.executeRShellCommand)(output, shell, statement);
-    }
-}
-/**
- * This function interprets the given `expr` as a REPL command (see {@link repl} for more on the semantics).
- *
- * @param output   - Defines two methods that every function in the repl uses to output its data.
- * @param expr     - The expression to process.
- * @param shell    - The {@link RShell} to use (see {@link repl}).
- */
-async function replProcessAnswer(output, expr, shell) {
-    const statements = (0, args_1.splitAtEscapeSensitive)(expr, false, ';');
-    for (const statement of statements) {
-        await replProcessStatement(output, statement, shell);
-    }
-}
-exports.replProcessAnswer = replProcessAnswer;
-/**
- * Provides a never-ending repl (read-evaluate-print loop) processor that can be used to interact with a {@link RShell} as well as all flowR scripts.
- *
- * The repl allows for two kinds of inputs:
- * - Starting with a colon `:`, indicating a command (probe `:help`, and refer to {@link commands}) </li>
- * - Starting with anything else, indicating default R code to be directly executed. If you kill the underlying shell, that is on you! </li>
- *
- * @param shell     - The shell to use, if you do not pass one it will automatically create a new one with the `revive` option set to 'always'
- * @param rl        - A potentially customized readline interface to be used for the repl to *read* from the user, we write the output with the {@link ReplOutput | `output` } interface.
- *                    If you want to provide a custom one but use the same `completer`, refer to {@link replCompleter}.
- *                    For the default arguments, see {@link DEFAULT_REPL_READLINE_CONFIGURATION}.
- * @param output    - Defines two methods that every function in the repl uses to output its data.
- * @param historyFile - The file to use for persisting the repl's history. Passing undefined causes history not to be saved.
- *
- * For the execution, this function makes use of {@link replProcessAnswer}
- *
- */
-async function repl(shell = new r_bridge_1.RShell({ revive: 'always' }), rl = readline.createInterface(exports.DEFAULT_REPL_READLINE_CONFIGURATION), output = commands_1.standardReplOutput, historyFile = defaultHistoryFile) {
-    if (historyFile) {
-        rl.on('history', h => fs_1.default.writeFileSync(historyFile, h.join('\n'), { encoding: 'utf-8' }));
-    }
-    // the incredible repl :D, we kill it with ':quit'
-    // eslint-disable-next-line no-constant-condition,@typescript-eslint/no-unnecessary-condition
-    while (true) {
-        await new Promise((resolve, reject) => {
-            rl.question((0, prompt_1.prompt)(), answer => {
-                rl.pause();
-                replProcessAnswer(output, answer, shell).then(() => {
-                    rl.resume();
-                    resolve();
-                }).catch(reject);
-            });
-        });
-    }
-}
-exports.repl = repl;
-function loadReplHistory(historyFile) {
-    if (!fs_1.default.existsSync(historyFile)) {
-        return undefined;
-    }
-    return fs_1.default.readFileSync(historyFile, { encoding: 'utf-8' }).split('\n');
-}
-exports.loadReplHistory = loadReplHistory;
-//# sourceMappingURL=core.js.map

package/cli/repl/execute.d.ts

@@ -1,28 +0,0 @@
-/// <reference types="node" />
-import type { Readable, Writable } from 'stream';
-type Stdio = [stdin: Writable | null, stdout: Readable | null, stderr: Readable | null, extra: Writable | Readable | null | undefined, extra: Writable | Readable | null | undefined];
-export type StdioProcessor = (stdio: Stdio) => void;
-/**
- * Simply captures the output of the script executed by {@link waitOnScript}.
- *
- * @param stdio        - The standard io tuple provided by {@link waitOnScript}
- * @param onStdOutLine - The callback is executed each time we receive a new line from the standard output channel.
- * @param onStdErrLine - The callback is executed each time we receive a new line from the standard error channel.
- */
-export declare function stdioCaptureProcessor(stdio: Stdio, onStdOutLine: (msg: string) => void, onStdErrLine: (msg: string) => void): void;
-/**
- * Run the given module with the presented arguments, and wait for it to exit.
- *
- * @param module      - The (flowR) module that you want to use for the fork.
- *                      It is probably best to use {@link __dirname} so you can specify the module relative to your
- *                      current one.
- * @param args        - The arguments you want to start your process with.
- * @param io          - If you omit this argument, the in-, out- and error-channels of the script execution
- *                      will be automatically forwarded to the respective in-, out- and error-channels of your process.
- *                      However, by defining `io` you essentially gain full control on what should happen
- *                      with these streams. For a simple capturing processor, for example if you want to collect
- *                      the output of the script, see {@link stdioCaptureProcessor}.
- * @param exitOnError - If set to `true`, the process will exit with the exit code of the script.
- */
-export declare function waitOnScript(module: string, args: string[], io?: StdioProcessor, exitOnError?: boolean): Promise<void>;
-export {};

package/cli/repl/execute.js

@@ -1,79 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitOnScript = exports.stdioCaptureProcessor = void 0;
-const log_1 = require("../../util/log");
-const child_process_1 = __importDefault(require("child_process"));
-const readline_1 = __importDefault(require("readline"));
-const assert_1 = require("../../util/assert");
-/**
- * Simply captures the output of the script executed by {@link waitOnScript}.
- *
- * @param stdio        - The standard io tuple provided by {@link waitOnScript}
- * @param onStdOutLine - The callback is executed each time we receive a new line from the standard output channel.
- * @param onStdErrLine - The callback is executed each time we receive a new line from the standard error channel.
- */
-function stdioCaptureProcessor(stdio, onStdOutLine, onStdErrLine) {
-    (0, assert_1.guard)(stdio[1] !== null, 'no stdout given in stdio!');
-    const outRl = readline_1.default.createInterface({
-        input: stdio[1],
-        terminal: false
-    });
-    (0, assert_1.guard)(stdio[2] !== null, 'no stderr given in stdio!');
-    const errRl = readline_1.default.createInterface({
-        input: stdio[2],
-        terminal: false
-    });
-    outRl.on('line', onStdOutLine);
-    errRl.on('line', onStdErrLine);
-}
-exports.stdioCaptureProcessor = stdioCaptureProcessor;
-/**
- * Run the given module with the presented arguments, and wait for it to exit.
- *
- * @param module      - The (flowR) module that you want to use for the fork.
- *                      It is probably best to use {@link __dirname} so you can specify the module relative to your
- *                      current one.
- * @param args        - The arguments you want to start your process with.
- * @param io          - If you omit this argument, the in-, out- and error-channels of the script execution
- *                      will be automatically forwarded to the respective in-, out- and error-channels of your process.
- *                      However, by defining `io` you essentially gain full control on what should happen
- *                      with these streams. For a simple capturing processor, for example if you want to collect
- *                      the output of the script, see {@link stdioCaptureProcessor}.
- * @param exitOnError - If set to `true`, the process will exit with the exit code of the script.
- */
-async function waitOnScript(module, args, io, exitOnError = false) {
-    log_1.log.info(`starting script ${module} with args ${JSON.stringify(args)}`);
-    const child = child_process_1.default.fork(module, args, {
-        silent: io !== undefined
-    });
-    if (io !== undefined) {
-        io(child.stdio);
-    }
-    child.on('exit', (code, signal) => {
-        if (code) {
-            console.error(`Script ${module} exited with code ${String(code)} and signal ${JSON.stringify(signal)}`);
-            if (exitOnError) {
-                process.exit(code);
-            }
-        }
-    });
-    child.on('error', err => {
-        console.error(`Script ${module} signaled error ${JSON.stringify(err)}`);
-        if (exitOnError) {
-            process.exit(1);
-        }
-    });
-    await new Promise((resolve, reject) => child.on('exit', code => {
-        if (exitOnError && code) {
-            reject(new Error(`Script ${module} exited with code ${String(code)}`));
-        }
-        else {
-            resolve();
-        }
-    }));
-}
-exports.waitOnScript = waitOnScript;
-//# sourceMappingURL=execute.js.map

package/cli/repl/index.d.ts

@@ -1,5 +0,0 @@
-export * from './server/messages/messages';
-export * from './core';
-export * from './prompt';
-export * from './server/messages/messages';
-export * from './execute';

package/cli/repl/index.js

@@ -1,22 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./server/messages/messages"), exports);
-__exportStar(require("./core"), exports);
-__exportStar(require("./prompt"), exports);
-__exportStar(require("./server/messages/messages"), exports);
-__exportStar(require("./execute"), exports);
-//# sourceMappingURL=index.js.map

package/cli/repl/prompt.d.ts

@@ -1,2 +0,0 @@
-export declare const rawPrompt = "R>";
-export declare const prompt: () => string;

package/cli/repl/prompt.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.prompt = exports.rawPrompt = void 0;
-const statistics_1 = require("../../statistics");
-exports.rawPrompt = 'R>';
-// is a function as the 'formatter' is configured only after the cli options have been read
-const prompt = () => `${statistics_1.formatter.format(exports.rawPrompt, { color: 6 /* Colors.Cyan */, effect: statistics_1.ColorEffect.Foreground })} `;
-exports.prompt = prompt;
-//# sourceMappingURL=prompt.js.map

package/cli/repl/server/connection.d.ts

@@ -1,21 +0,0 @@
-import type { RShell } from '../../../r-bridge';
-import type { Socket } from './net';
-/**
- * Each connection handles a single client, answering to its requests.
- * There is no need to construct this class manually, {@link FlowRServer} will do it for you.
- */
-export declare class FlowRServerConnection {
-    private readonly socket;
-    private readonly shell;
-    private readonly name;
-    private readonly logger;
-    private readonly fileMap;
-    constructor(socket: Socket, name: string, shell: RShell);
-    private currentMessageBuffer;
-    private handleData;
-    private handleFileAnalysisRequest;
-    private sendFileAnalysisResponse;
-    private createSteppingSlicerForRequest;
-    private handleSliceRequest;
-    private handleRepl;
-}

package/cli/repl/server/connection.js

@@ -1,213 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FlowRServerConnection = void 0;
-const core_1 = require("../../../core");
-const send_1 = require("./send");
-const validate_1 = require("./validate");
-const analysis_1 = require("./messages/analysis");
-const slice_1 = require("./messages/slice");
-const server_1 = require("./server");
-const repl_1 = require("./messages/repl");
-const core_2 = require("../core");
-const statistics_1 = require("../../../statistics");
-const cfg_1 = require("../../../util/cfg/cfg");
-const quads_1 = require("../../../util/quads");
-/**
- * Each connection handles a single client, answering to its requests.
- * There is no need to construct this class manually, {@link FlowRServer} will do it for you.
- */
-class FlowRServerConnection {
-    socket;
-    shell;
-    name;
-    logger;
-    // maps token to information
-    fileMap = new Map();
-    // we do not have to ensure synchronized shell-access as we are always running synchronized
-    constructor(socket, name, shell) {
-        this.socket = socket;
-        this.shell = shell;
-        this.name = name;
-        this.logger = server_1.serverLog.getSubLogger({ name });
-        this.socket.on('data', data => this.handleData(String(data)));
-        this.socket.on('error', e => this.logger.error(`[${this.name}] Error while handling connection: ${String(e)}`));
-    }
-    currentMessageBuffer = '';
-    handleData(message) {
-        if (!message.endsWith('\n')) {
-            this.currentMessageBuffer += message;
-            this.logger.trace(`[${this.name}] Received partial message. Buffering ${this.currentMessageBuffer.length}.`);
-            return;
-        }
-        message = this.currentMessageBuffer + message;
-        if (this.logger.settings.minLevel >= 2 /* LogLevel.Debug */) {
-            this.logger.debug(`[${this.name}] Received message: ${message}`);
-        }
-        this.currentMessageBuffer = '';
-        const request = (0, validate_1.validateBaseMessageFormat)(message);
-        if (request.type === 'error') {
-            (0, validate_1.answerForValidationError)(this.socket, request);
-            return;
-        }
-        switch (request.message.type) {
-            case 'request-file-analysis':
-                this.handleFileAnalysisRequest(request.message);
-                break;
-            case 'request-slice':
-                this.handleSliceRequest(request.message);
-                break;
-            case 'request-repl-execution':
-                this.handleRepl(request.message);
-                break;
-            default:
-                (0, send_1.sendMessage)(this.socket, {
-                    id: request.message.id,
-                    type: 'error',
-                    fatal: true,
-                    reason: `The message type ${JSON.stringify(request.message.type ?? 'undefined')} is not supported.`
-                });
-                this.socket.end();
-        }
-    }
-    handleFileAnalysisRequest(base) {
-        const requestResult = (0, validate_1.validateMessage)(base, analysis_1.requestAnalysisMessage);
-        if (requestResult.type === 'error') {
-            (0, validate_1.answerForValidationError)(this.socket, requestResult, base.id);
-            return;
-        }
-        const message = requestResult.message;
-        this.logger.info(`[${this.name}] Received file analysis request for ${message.filename ?? 'unknown file'}${message.filetoken ? ' with token: ' + message.filetoken : ''}`);
-        if (message.filetoken && this.fileMap.has(message.filetoken)) {
-            this.logger.warn(`File token ${message.filetoken} already exists. Overwriting.`);
-        }
-        const slicer = this.createSteppingSlicerForRequest(message);
-        void slicer.allRemainingSteps(false).then(async (results) => await this.sendFileAnalysisResponse(results, message))
-            .catch(e => {
-            this.logger.error(`[${this.name}] Error while analyzing file ${message.filename ?? 'unknown file'}: ${String(e)}`);
-            (0, send_1.sendMessage)(this.socket, {
-                id: message.id,
-                type: 'error',
-                fatal: false,
-                reason: `Error while analyzing file ${message.filename ?? 'unknown file'}: ${String(e)}`
-            });
-        });
-    }
-    async sendFileAnalysisResponse(results, message) {
-        let cfg = undefined;
-        if (message.cfg) {
-            cfg = (0, cfg_1.extractCFG)(results.normalize);
-        }
-        const config = () => ({ context: message.filename ?? 'unknown', getId: (0, quads_1.defaultQuadIdGenerator)() });
-        if (message.format === 'n-quads') {
-            (0, send_1.sendMessage)(this.socket, {
-                type: 'response-file-analysis',
-                format: 'n-quads',
-                id: message.id,
-                cfg: cfg ? (0, cfg_1.cfg2quads)(cfg, config()) : undefined,
-                results: {
-                    parse: await (0, core_1.printStepResult)('parse', results.parse, 5 /* StepOutputFormat.RdfQuads */, config()),
-                    normalize: await (0, core_1.printStepResult)('normalize', results.normalize, 5 /* StepOutputFormat.RdfQuads */, config()),
-                    dataflow: await (0, core_1.printStepResult)('dataflow', results.dataflow, 5 /* StepOutputFormat.RdfQuads */, config())
-                }
-            });
-        }
-        else {
-            (0, send_1.sendMessage)(this.socket, {
-                type: 'response-file-analysis',
-                format: 'json',
-                id: message.id,
-                cfg,
-                results: {
-                    ...results,
-                    normalize: {
-                        ...results.normalize,
-                        idMap: undefined
-                    }
-                }
-            });
-        }
-    }
-    createSteppingSlicerForRequest(message) {
-        const slicer = new core_1.SteppingSlicer({
-            stepOfInterest: core_1.LAST_STEP,
-            shell: this.shell,
-            // we have to make sure, that the content is not interpreted as a file path if it starts with 'file://' therefore, we do it manually
-            request: {
-                request: message.content === undefined ? 'file' : 'text',
-                content: message.content ?? message.filepath
-            },
-            criterion: [] // currently unknown
-        });
-        if (message.filetoken) {
-            this.logger.info(`Storing file token ${message.filetoken}`);
-            this.fileMap.set(message.filetoken, {
-                filename: message.filename,
-                slicer
-            });
-        }
-        return slicer;
-    }
-    handleSliceRequest(base) {
-        const requestResult = (0, validate_1.validateMessage)(base, slice_1.requestSliceMessage);
-        if (requestResult.type === 'error') {
-            (0, validate_1.answerForValidationError)(this.socket, requestResult, base.id);
-            return;
-        }
-        const request = requestResult.message;
-        this.logger.info(`[${request.filetoken}] Received slice request with criteria ${JSON.stringify(request.criterion)}`);
-        const fileInformation = this.fileMap.get(request.filetoken);
-        if (!fileInformation) {
-            (0, send_1.sendMessage)(this.socket, {
-                id: request.id,
-                type: 'error',
-                fatal: false,
-                reason: `The file token ${request.filetoken} has never been analyzed.`
-            });
-            return;
-        }
-        fileInformation.slicer.updateCriterion(request.criterion);
-        void fileInformation.slicer.allRemainingSteps(true).then(results => {
-            (0, send_1.sendMessage)(this.socket, {
-                type: 'response-slice',
-                id: request.id,
-                results: Object.fromEntries(Object.entries(results).filter(([k,]) => Object.hasOwn(core_1.STEPS_PER_SLICE, k)))
-            });
-        }).catch(e => {
-            this.logger.error(`[${this.name}] Error while analyzing file for token ${request.filetoken}: ${String(e)}`);
-            (0, send_1.sendMessage)(this.socket, {
-                id: request.id,
-                type: 'error',
-                fatal: false,
-                reason: `Error while analyzing file for token ${request.filetoken}: ${String(e)}`
-            });
-        });
-    }
-    handleRepl(base) {
-        const requestResult = (0, validate_1.validateMessage)(base, repl_1.requestExecuteReplExpressionMessage);
-        if (requestResult.type === 'error') {
-            (0, validate_1.answerForValidationError)(this.socket, requestResult, base.id);
-            return;
-        }
-        const request = requestResult.message;
-        const out = (stream, msg) => {
-            (0, send_1.sendMessage)(this.socket, {
-                type: 'response-repl-execution',
-                id: request.id,
-                result: msg,
-                stream
-            });
-        };
-        void (0, core_2.replProcessAnswer)({
-            formatter: request.ansi ? statistics_1.ansiFormatter : statistics_1.voidFormatter,
-            stdout: msg => out('stdout', msg),
-            stderr: msg => out('stderr', msg)
-        }, request.expression, this.shell).then(() => {
-            (0, send_1.sendMessage)(this.socket, {
-                type: 'end-repl-execution',
-                id: request.id
-            });
-        });
-    }
-}
-exports.FlowRServerConnection = FlowRServerConnection;
-//# sourceMappingURL=connection.js.map

package/cli/repl/server/messages/analysis.d.ts

@@ -1,71 +0,0 @@
-import type { IdMessageBase, MessageDefinition } from './messages';
-import type { LAST_PER_FILE_STEP, StepResults } from '../../../../core';
-import type { ControlFlowInformation } from '../../../../util/cfg/cfg';
-/**
- * Send by the client to request an analysis of a given file.
- * Answered by either an {@link FlowrErrorMessage} or a {@link FileAnalysisResponseMessageJson}.
- */
-export interface FileAnalysisRequestMessage extends IdMessageBase {
-    type: 'request-file-analysis';
-    /**
-     * This is a unique token that you assign to subsequently slice the respective files.
-     * If you pass the same token multiple times, previous results will be overwritten.
-     *
-     * If you do not pass a file token, the server will _not_ store the results!
-     */
-    filetoken?: string;
-    /**
-     * A human-readable file name. If you present a `filepath` or read from a file this should be straightforward.
-     * However, the name is only for debugging and bears no semantic meaning.
-     */
-    filename?: string;
-    /** The contents of the file, or an R expression itself (like `1 + 1`), give either this or the `filepath`. */
-    content?: string;
-    /** The filepath on the local machine, accessible to flowR, or simply. Give either this or the `content` */
-    filepath?: string;
-    /** Can be used to additionally extract the {@link ControlFlowInformation} of the file, which is not exposed (and not fully calculated) by default. */
-    cfg?: boolean;
-    /** Controls the serialization of the `results` (and the {@link ControlFlowGraph} if the corresponding flag is set). If missing, we assume _json_. */
-    format?: 'json' | 'n-quads';
-}
-export declare const requestAnalysisMessage: MessageDefinition<FileAnalysisRequestMessage>;
-/**
- * Answer for a successful {@link FileAnalysisRequestMessage}.
- * It contains the results of the analysis in JSON format (guided by {@link FileAnalysisRequestMessage#format}).
- *
- * The `idMap` of the normalization step (see {@link NormalizedAst}) is not serialized as it would essentially
- * repeat the complete normalized AST.
- *
- * @note The serialization of maps and sets is controlled by the {@link jsonReplacer} as part of {@link sendMessage}.
- *
- * @see FileAnalysisResponseMessageNQuads
- */
-export interface FileAnalysisResponseMessageJson extends IdMessageBase {
-    type: 'response-file-analysis';
-    format: 'json';
-    /**
-     * See the {@link SteppingSlicer} and {@link StepResults} for details on the results.
-     */
-    results: StepResults<typeof LAST_PER_FILE_STEP>;
-    /**
-     * Only if the {@link FileAnalysisRequestMessage} contained a `cfg: true` this will contain the {@link ControlFlowInformation} of the file.
-     */
-    cfg?: ControlFlowInformation;
-}
-/**
- * Similar to {@link FileAnalysisResponseMessageJson} but using n-quads as serialization format.
- */
-export interface FileAnalysisResponseMessageNQuads extends IdMessageBase {
-    type: 'response-file-analysis';
-    format: 'n-quads';
-    /**
-     * @see FileAnalysisResponseMessageJson#results
-     */
-    results: {
-        [K in keyof StepResults<typeof LAST_PER_FILE_STEP>]: string;
-    };
-    /**
-     * @see FileAnalysisResponseMessageJson#cfg
-     */
-    cfg?: string;
-}

package/cli/repl/server/messages/analysis.js

@@ -1,21 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.requestAnalysisMessage = void 0;
-const joi_1 = __importDefault(require("joi"));
-exports.requestAnalysisMessage = {
-    type: 'request-file-analysis',
-    schema: joi_1.default.object({
-        type: joi_1.default.string().valid('request-file-analysis').required(),
-        id: joi_1.default.string().optional(),
-        filetoken: joi_1.default.string().optional(),
-        filename: joi_1.default.string().optional(),
-        content: joi_1.default.string().optional(),
-        filepath: joi_1.default.string().optional(),
-        cfg: joi_1.default.boolean().optional(),
-        format: joi_1.default.string().valid('json', 'n-quads').optional()
-    }).xor('content', 'filepath')
-};
-//# sourceMappingURL=analysis.js.map

package/cli/repl/server/messages/error.d.ts

@@ -1,11 +0,0 @@
-import type { IdMessageBase } from './messages';
-/**
- * Sent in case of any error (e.g., if the analysis fails, or the message contains syntax errors).
- */
-export interface FlowrErrorMessage extends IdMessageBase {
-    type: 'error';
-    /** if fatal, the connection will be partially closed afterward */
-    fatal: boolean;
-    /** the human-readable reason for the error */
-    reason: string;
-}