flowquery 1.0.46 → 1.0.47

package/src/graph/relationship.ts

@@ -1,167 +0,0 @@
-import ASTNode from "../parsing/ast_node";
-import Expression from "../parsing/expressions/expression";
-import Hops from "./hops";
-import Node from "./node";
-import RelationshipData, { RelationshipRecord } from "./relationship_data";
-import RelationshipMatchCollector, {
-    RelationshipMatchRecord,
-} from "./relationship_match_collector";
-
-class Relationship extends ASTNode {
-    protected _identifier: string | null = null;
-    protected _types: string[] = [];
-    protected _properties: Map<string, Expression> = new Map();
-    protected _hops: Hops = new Hops();
-
-    protected _value: RelationshipMatchRecord | RelationshipMatchRecord[] | null = null;
-    protected _matches: RelationshipMatchCollector = new RelationshipMatchCollector();
-
-    protected _source: Node | null = null;
-    protected _target: Node | null = null;
-    protected _direction: "left" | "right" = "right";
-
-    private _data: RelationshipData | null = null;
-
-    constructor(identifier: string | null = null, type: string | null = null) {
-        super();
-        this._identifier = identifier;
-        if (type !== null) {
-            this._types = [type];
-        }
-    }
-    public set identifier(identifier: string) {
-        this._identifier = identifier;
-    }
-    public get identifier(): string | null {
-        return this._identifier;
-    }
-    public set type(type: string) {
-        this._types = [type];
-    }
-    public get type(): string | null {
-        return this._types.length > 0 ? this._types[0] : null;
-    }
-    public set types(types: string[]) {
-        this._types = types;
-    }
-    public get types(): string[] {
-        return this._types;
-    }
-    public get properties(): Map<string, Expression> {
-        return this._properties;
-    }
-    public set properties(properties: Map<string, Expression>) {
-        this._properties = properties;
-    }
-    private _matchesProperties(hop: number = 0): boolean {
-        const data: RelationshipData = this._data!;
-        for (const [key, expression] of this._properties) {
-            const record: RelationshipRecord = data.current(hop)!;
-            if (record === null) {
-                throw new Error("No current relationship data available");
-            }
-            if (!(key in record)) {
-                throw new Error("Relationship does not have property");
-            }
-            return record[key] === expression.value();
-        }
-        return true;
-    }
-    public setProperty(key: string, value: Expression): void {
-        this._properties.set(key, value);
-    }
-    public getProperty(key: string): Expression | null {
-        return this._properties.get(key) || null;
-    }
-    public set hops(hops: Hops) {
-        this._hops = hops;
-    }
-    public get hops(): Hops | null {
-        return this._hops;
-    }
-    public setValue(relationship: Relationship, traversalId: string = ""): void {
-        const match: RelationshipMatchRecord = this._matches.push(relationship, traversalId);
-        this._value = this._matches.value();
-    }
-    public set source(node: Node | null) {
-        this._source = node;
-    }
-    public get source(): Node | null {
-        return this._source;
-    }
-    public set target(node: Node | null) {
-        this._target = node;
-    }
-    public get target(): Node | null {
-        return this._target;
-    }
-    public set direction(direction: "left" | "right") {
-        this._direction = direction;
-    }
-    public get direction(): "left" | "right" {
-        return this._direction;
-    }
-    public value(): RelationshipMatchRecord | RelationshipMatchRecord[] | null {
-        return this._value;
-    }
-    public get matches(): RelationshipMatchRecord[] {
-        return this._matches.matches;
-    }
-    public setData(data: RelationshipData | null): void {
-        this._data = data;
-    }
-    public getData(): RelationshipData | null {
-        return this._data;
-    }
-    public setEndNode(node: Node): void {
-        this._matches.endNode = node;
-    }
-    public _left_id_or_right_id(): string {
-        return this._direction === "left" ? "left_id" : "right_id";
-    }
-    public async find(left_id: string, hop: number = 0): Promise<void> {
-        // Save original source node
-        const original = this._source;
-        if (hop > 0) {
-            // For hops greater than 0, the source becomes the target of the previous hop
-            this._source = this._target;
-        }
-        if (hop === 0) {
-            this._data?.reset();
-
-            // Handle zero-hop case: when min is 0 on a variable-length relationship,
-            // match source node as target (no traversal)
-            if (this.hops?.multi() && this.hops.min === 0 && this._target) {
-                // For zero-hop, target finds the same node as source (left_id)
-                // No relationship match is pushed since no edge is traversed
-                await this._target.find(left_id, hop);
-            }
-        }
-        while (this._data!.find(left_id, hop, this._direction)) {
-            const data: RelationshipRecord = this._data?.current(hop) as RelationshipRecord;
-            const id = data[this._left_id_or_right_id()];
-            if (hop + 1 >= this.hops!.min) {
-                this.setValue(this, left_id);
-                if (!this._matchesProperties(hop)) {
-                    continue;
-                }
-                await this._target?.find(id, hop);
-                if (hop + 1 < this.hops!.max) {
-                    if (this._matches.isCircular(id)) {
-                        this._matches.pop();
-                        continue;
-                    }
-                    await this.find(id, hop + 1);
-                }
-                this._matches.pop();
-            } else {
-                // Below minimum hops: traverse the edge without yielding a match
-                await this.find(id, hop + 1);
-            }
-        }
-        // Restore original source node
-        this._source = original;
-    }
-}
-
-export default Relationship;

package/src/graph/relationship_data.ts

@@ -1,31 +0,0 @@
-import Data from "./data";
-
-export type RelationshipRecord = { left_id: string; right_id: string } & Record<string, any>;
-
-class RelationshipData extends Data {
-    constructor(records: RelationshipRecord[] = []) {
-        super(records);
-        super._buildIndex("left_id");
-        super._buildIndex("right_id");
-    }
-    public find(id: string, hop: number = 0, direction: "left" | "right" = "right"): boolean {
-        return super._find(id, hop, direction === "left" ? "right_id" : "left_id");
-    }
-    /*
-    ** Get the properties of the current relationship record
-    '' excluding the left_id and right_id fields
-    */
-    public properties(): Record<string, any> | null {
-        const current = this.current();
-        if (current) {
-            const { left_id, right_id, _type, ...props } = current;
-            return props;
-        }
-        return null;
-    }
-    public current(hop: number = 0): RelationshipRecord | null {
-        return super.current(hop) as RelationshipRecord | null;
-    }
-}
-
-export default RelationshipData;

package/src/graph/relationship_match_collector.ts

@@ -1,64 +0,0 @@
-import Relationship from "./relationship";
-
-export type RelationshipMatchRecord = {
-    type: string;
-    startNode: Record<string, any>;
-    endNode: Record<string, any> | null;
-    properties: Record<string, any>;
-    [key: string]: any;
-};
-
-class RelationshipMatchCollector {
-    private _matches: RelationshipMatchRecord[] = [];
-    private _nodeIds: Array<string> = [];
-
-    public push(relationship: Relationship, traversalId: string): RelationshipMatchRecord {
-        const data = relationship.getData();
-        const currentRecord = data?.current();
-        const actualType =
-            currentRecord && "_type" in currentRecord ? currentRecord["_type"] : relationship.type!;
-        const relProperties = data?.properties() as Record<string, any>;
-        const match: RelationshipMatchRecord = {
-            ...(relProperties || {}),
-            type: actualType,
-            startNode: relationship.source?.value() || {},
-            endNode: null,
-            properties: relProperties,
-        };
-        this._matches.push(match);
-        this._nodeIds.push(traversalId);
-        return match;
-    }
-    public set endNode(node: any) {
-        if (this._matches.length > 0) {
-            this._matches[this._matches.length - 1].endNode = node.value();
-        }
-    }
-    public pop(): RelationshipMatchRecord | undefined {
-        this._nodeIds.pop();
-        return this._matches.pop();
-    }
-    public value(): RelationshipMatchRecord | RelationshipMatchRecord[] | null {
-        if (this._matches.length === 0) {
-            return null;
-        } else if (this._matches.length === 1) {
-            const _match = this._matches[0];
-            return _match;
-        } else {
-            const _matches = this._matches;
-            return _matches;
-        }
-    }
-    public get matches(): RelationshipMatchRecord[] {
-        return this._matches;
-    }
-    /*
-     ** Checks if traversing to the given node id would form a cycle
-     ** in the current traversal path
-     */
-    public isCircular(nextId: string): boolean {
-        return this._nodeIds.includes(nextId);
-    }
-}
-
-export default RelationshipMatchCollector;

package/src/graph/relationship_reference.ts

@@ -1,25 +0,0 @@
-import Relationship from "./relationship";
-import { RelationshipRecord } from "./relationship_data";
-
-class RelationshipReference extends Relationship {
-    private _reference: Relationship | null = null;
-    constructor(base: Relationship, reference: Relationship) {
-        super();
-        this._identifier = base.identifier;
-        this._types = base.types;
-        this._hops = base.hops!;
-        this._source = base.source;
-        this._target = base.target;
-        this._reference = reference;
-    }
-    public async find(left_id: string, hop: number = 0): Promise<void> {
-        this.setValue(this._reference!);
-        const data: RelationshipRecord = this._reference!.getData()?.current(
-            hop
-        ) as RelationshipRecord;
-        const followId = this._direction === "left" ? "left_id" : "right_id";
-        await this._target?.find(data[followId], hop);
-    }
-}
-
-export default RelationshipReference;

package/src/index.browser.ts

@@ -1,46 +0,0 @@
-/**
- * FlowQuery - A declarative query language for data processing pipelines.
- *
- * This is the main entry point for the FlowQuery in-browser usage.
- *
- * @packageDocumentation
- */
-import { default as FlowQuery } from "./compute/flowquery";
-import Function from "./parsing/functions/function";
-import FunctionFactory from "./parsing/functions/function_factory";
-import {
-    FunctionMetadata,
-    OutputSchema,
-    ParameterSchema,
-} from "./parsing/functions/function_metadata";
-
-/**
- * List all registered functions with their metadata.
- *
- * @param options - Optional filter options
- * @returns Array of function metadata
- */
-FlowQuery.listFunctions = function (options?: {
-    category?: string;
-    asyncOnly?: boolean;
-    syncOnly?: boolean;
-}): FunctionMetadata[] {
-    return FunctionFactory.listFunctions(options);
-};
-
-/**
- * Get metadata for a specific function.
- *
- * @param name - The function name
- * @returns Function metadata or undefined
- */
-FlowQuery.getFunctionMetadata = function (name: string): FunctionMetadata | undefined {
-    return FunctionFactory.getMetadata(name);
-};
-
-/**
- * Base Function class for creating custom plugin functions.
- */
-FlowQuery.Function = Function;
-
-export default FlowQuery;

package/src/index.node.ts

@@ -1,55 +0,0 @@
-/**
- * FlowQuery - A declarative query language for data processing pipelines.
- *
- * This is the main entry point for the FlowQuery Node.js library usage.
- *
- * @packageDocumentation
- */
-import { default as FlowQuery } from "./compute/flowquery";
-import Function from "./parsing/functions/function";
-import FunctionFactory, { AsyncDataProvider } from "./parsing/functions/function_factory";
-import {
-    FunctionMetadata,
-    OutputSchema,
-    ParameterSchema,
-} from "./parsing/functions/function_metadata";
-
-/**
- * List all registered functions with their metadata.
- *
- * @param options - Optional filter options
- * @returns Array of function metadata
- */
-FlowQuery.listFunctions = function (options?: {
-    category?: string;
-    asyncOnly?: boolean;
-    syncOnly?: boolean;
-}): FunctionMetadata[] {
-    return FunctionFactory.listFunctions(options);
-};
-
-/**
- * Get metadata for a specific function.
- *
- * @param name - The function name
- * @returns Function metadata or undefined
- */
-FlowQuery.getFunctionMetadata = function (name: string): FunctionMetadata | undefined {
-    return FunctionFactory.getMetadata(name);
-};
-
-/**
- * Base Function class for creating custom plugin functions.
- */
-FlowQuery.Function = Function;
-
-export default FlowQuery;
-export {
-    FlowQuery,
-    Function,
-    FunctionFactory,
-    AsyncDataProvider,
-    FunctionMetadata,
-    ParameterSchema,
-    OutputSchema,
-};

package/src/index.ts

@@ -1,12 +0,0 @@
-/**
- * FlowQuery - A declarative query language for data processing pipelines.
- *
- * Main entry point for the FlowQuery command-line interface.
- *
- * @packageDocumentation
- */
-
-import CommandLine from "./io/command_line";
-
-const commandLine = new CommandLine();
-commandLine.loop();

package/src/io/command_line.ts

@@ -1,74 +0,0 @@
-import Runner from '../compute/runner';
-import * as readline from 'readline';
-
-/**
- * Interactive command-line interface for FlowQuery.
- * 
- * Provides a REPL (Read-Eval-Print Loop) for executing FlowQuery statements
- * and displaying results.
- * 
- * @example
- * ```typescript
- * const cli = new CommandLine();
- * cli.loop(); // Starts interactive mode
- * ```
- */
-class CommandLine {
-    private rl: readline.Interface;
-
-    /**
-     * Creates a new CommandLine interface.
-     */
-    constructor() {
-        this.rl = readline.createInterface({
-            input: process.stdin,
-            output: process.stdout
-        });
-    }
-
-    /**
-     * Starts the interactive command loop.
-     * 
-     * Prompts the user for FlowQuery statements, executes them, and displays results.
-     * Type "exit" to quit the loop.
-     */
-    public loop() {
-        console.log('Welcome to FlowQuery! Type "exit" to quit.');
-        this.rl.setPrompt('> ');
-        this.rl.prompt();
-
-        this.rl.on('line', (input: string) => {
-            if (input === 'exit') {
-                this.rl.close();
-                return;
-            }
-            if(input.trim() === '') {
-                this.rl.prompt();
-                return;
-            }
-            try {
-                const runner = new Runner(input);
-                const promise = runner.run();
-                promise.then(
-                    () => {
-                        console.log(runner.results);
-                    }
-                );
-                promise.catch(
-                    (e) => console.error(e)
-                );
-                promise.finally(
-                    () => this.rl.prompt()
-                );
-            } catch (e) {
-                console.error(e);
-                this.rl.prompt();
-            }
-        }).on('close', () => {
-            console.log('Exiting FlowQuery.');
-            process.exit(0);
-        });
-    }
-}
-
-export default CommandLine;

package/src/parsing/alias.ts

@@ -1,23 +0,0 @@
-import ASTNode from "./ast_node";
-
-class Alias extends ASTNode {
-    private alias: string;
-    constructor(alias: string) {
-        super();
-        this.alias = alias;
-    }
-
-    public toString(): string {
-        return `Alias (${this.alias})`;
-    }
-
-    public getAlias(): string {
-        return this.alias;
-    }
-
-    public value(): string {
-        return this.alias;
-    }
-}
-
-export default Alias;

package/src/parsing/alias_option.ts

@@ -1,5 +0,0 @@
-export enum AliasOption {
-    NOT_ALLOWED = 0,
-    OPTIONAL = 1,
-    REQUIRED = 2,
-};

package/src/parsing/ast_node.ts

@@ -1,153 +0,0 @@
-/**
- * Represents a node in the Abstract Syntax Tree (AST).
- * 
- * The AST is a tree representation of the parsed FlowQuery statement structure.
- * Each node can have children and maintains a reference to its parent.
- * 
- * @example
- * ```typescript
- * const root = new ASTNode();
- * const child = new ASTNode();
- * root.addChild(child);
- * ```
- */
-class ASTNode {
-    protected _parent: ASTNode | null = null;
-    protected children: ASTNode[] = [];
-
-    /**
-     * Adds a child node to this node and sets the child's parent reference.
-     * 
-     * @param child - The child node to add
-     */
-    public addChild(child: ASTNode): void {
-        child._parent = this;
-        this.children.push(child);
-    }
-
-    /**
-     * Returns the first child node.
-     * 
-     * @returns The first child node
-     * @throws {Error} If the node has no children
-     */
-    public firstChild(): ASTNode {
-        if(this.children.length === 0) {
-            throw new Error('Expected child');
-        }
-        return this.children[0];
-    }
-
-    /**
-     * Returns the last child node.
-     * 
-     * @returns The last child node
-     * @throws {Error} If the node has no children
-     */
-    public lastChild(): ASTNode {
-        if(this.children.length === 0) {
-            throw new Error('Expected child');
-        }
-        return this.children[this.children.length - 1];
-    }
-
-    /**
-     * Returns all child nodes.
-     * 
-     * @returns Array of child nodes
-     */
-    public getChildren(): ASTNode[] {
-        return this.children;
-    }
-
-    /**
-     * Returns the number of child nodes.
-     * 
-     * @returns The count of children
-     */
-    public childCount(): number {
-        return this.children.length;
-    }
-
-    /**
-     * Returns the value of this node. Override in subclasses to provide specific values.
-     * 
-     * @returns The node's value, or null if not applicable
-     */
-    public value(): any {
-        return null;
-    }
-
-    /**
-     * Checks if this node represents an operator.
-     * 
-     * @returns True if this is an operator node, false otherwise
-     */
-    public isOperator(): boolean {
-        return false;
-    }
-
-    /**
-     * Checks if this node represents an operand (the opposite of an operator).
-     * 
-     * @returns True if this is an operand node, false otherwise
-     */
-    public isOperand(): boolean {
-        return !this.isOperator();
-    }
-
-    /**
-     * Gets the operator precedence for this node. Higher values indicate higher precedence.
-     * 
-     * @returns The precedence value (0 for non-operators)
-     */
-    public get precedence(): number {
-        return 0;
-    }
-
-    /**
-     * Indicates whether this operator is left-associative.
-     * 
-     * @returns True if left-associative, false otherwise
-     */
-    public get leftAssociative(): boolean {
-        return false;
-    }
-
-    /**
-     * Prints a string representation of the AST tree starting from this node.
-     * 
-     * @returns A formatted string showing the tree structure
-     */
-    public print(): string {
-        return Array.from(this._print(0)).join('\n');
-    }
-
-    /**
-     * Generator function for recursively printing the tree structure.
-     * 
-     * @param indent - The current indentation level
-     * @yields Lines representing each node in the tree
-     */
-    private *_print(indent: number): Generator<string> {
-        if(indent === 0) {
-            yield this.constructor.name;
-        } else if(indent > 0) {
-            yield '-'.repeat(indent) + ` ${this.toString()}`;
-        }
-        for(const child of this.children) {
-            yield* child._print(indent + 1);
-        }
-    }
-
-    /**
-     * Returns a string representation of this node. Override in subclasses for custom formatting.
-     * 
-     * @returns The string representation
-     */
-    protected toString(): string {
-        return this.constructor.name;
-    }
-}
-
-export default ASTNode;