flowquery 1.0.46 → 1.0.47

package/src/parsing/functions/substring.ts

@@ -1,68 +0,0 @@
-import ASTNode from "../ast_node";
-import Function from "./function";
-import { FunctionDef } from "./function_metadata";
-
-@FunctionDef({
-    description:
-        "Returns a substring of a string, starting at a 0-based index with an optional length",
-    category: "scalar",
-    parameters: [
-        { name: "original", description: "The original string", type: "string" },
-        { name: "start", description: "The 0-based start index", type: "integer" },
-        {
-            name: "length",
-            description: "The length of the substring (optional, defaults to remainder of string)",
-            type: "integer",
-        },
-    ],
-    output: { description: "The substring", type: "string", example: "llo" },
-    examples: ["RETURN substring('hello', 1, 3)", "RETURN substring('hello', 2)"],
-})
-class Substring extends Function {
-    constructor() {
-        super("substring");
-    }
-
-    public set parameters(nodes: ASTNode[]) {
-        if (nodes.length < 2 || nodes.length > 3) {
-            throw new Error(
-                `Function substring expected 2 or 3 parameters, but got ${nodes.length}`
-            );
-        }
-        this.children = nodes;
-    }
-
-    public value(): any {
-        const children = this.getChildren();
-        const original = children[0].value();
-        const start = children[1].value();
-
-        if (original === null || original === undefined) {
-            return null;
-        }
-        if (typeof original !== "string") {
-            throw new Error(
-                "Invalid argument for substring function: expected a string as the first argument"
-            );
-        }
-        if (typeof start !== "number" || !Number.isInteger(start)) {
-            throw new Error(
-                "Invalid argument for substring function: expected an integer as the second argument"
-            );
-        }
-
-        if (children.length === 3) {
-            const length = children[2].value();
-            if (typeof length !== "number" || !Number.isInteger(length)) {
-                throw new Error(
-                    "Invalid argument for substring function: expected an integer as the third argument"
-                );
-            }
-            return original.substring(start, start + length);
-        }
-
-        return original.substring(start);
-    }
-}
-
-export default Substring;

package/src/parsing/functions/sum.ts

@@ -1,41 +0,0 @@
-import AggregateFunction from "./aggregate_function";
-import ReducerElement from "./reducer_element";
-import { FunctionDef } from "./function_metadata";
-
-class SumReducerElement extends ReducerElement {
-    private _value: any = null;
-    public get value(): any {
-        return this._value;
-    }
-    public set value(value: any) {
-        if(this._value !== null) {
-            this._value += value;
-        } else {
-            this._value = value;
-        }
-    }
-}
-
-@FunctionDef({
-    description: "Calculates the sum of numeric values across grouped rows",
-    category: "aggregate",
-    parameters: [
-        { name: "value", description: "Numeric value to sum", type: "number" }
-    ],
-    output: { description: "Sum of all values", type: "number", example: 150 },
-    examples: ["WITH [1, 2, 3] AS nums UNWIND nums AS n RETURN sum(n)"]
-})
-class Sum extends AggregateFunction {
-    constructor() {
-        super("sum");
-        this._expectedParameterCount = 1;
-    }
-    public reduce(element: SumReducerElement): void {
-        element.value = this.firstChild().value();
-    }
-    public element(): SumReducerElement {
-        return new SumReducerElement();
-    }
-}
-
-export default Sum;

package/src/parsing/functions/tail.ts

@@ -1,39 +0,0 @@
-import Function from "./function";
-import { FunctionDef } from "./function_metadata";
-
-@FunctionDef({
-    description: "Returns all elements of a list except the first",
-    category: "scalar",
-    parameters: [
-        {
-            name: "list",
-            description: "The list to get all but the first element from",
-            type: "array",
-        },
-    ],
-    output: {
-        description: "All elements except the first",
-        type: "array",
-        example: "[2, 3]",
-    },
-    examples: ["RETURN tail([1, 2, 3])", "WITH ['a', 'b', 'c'] AS items RETURN tail(items)"],
-})
-class Tail extends Function {
-    constructor() {
-        super("tail");
-        this._expectedParameterCount = 1;
-    }
-
-    public value(): any {
-        const val = this.getChildren()[0].value();
-        if (val === null || val === undefined) {
-            return null;
-        }
-        if (!Array.isArray(val)) {
-            throw new Error("tail() expects a list");
-        }
-        return val.slice(1);
-    }
-}
-
-export default Tail;

package/src/parsing/functions/temporal_utils.ts

@@ -1,180 +0,0 @@
-/**
- * Shared utility functions for temporal (date/time) operations.
- *
- * These helpers are used by the datetime, date, time, localdatetime,
- * localtime, and timestamp functions.
- */
-
-/**
- * Computes the ISO day of the week (1 = Monday, 7 = Sunday).
- */
-function isoDayOfWeek(d: Date): number {
-    const jsDay = d.getDay(); // 0 = Sunday, 6 = Saturday
-    return jsDay === 0 ? 7 : jsDay;
-}
-
-/**
- * Computes the day of the year (1-based).
- */
-function dayOfYear(d: Date): number {
-    const start = new Date(d.getFullYear(), 0, 0);
-    const diff = d.getTime() - start.getTime();
-    const oneDay = 1000 * 60 * 60 * 24;
-    return Math.floor(diff / oneDay);
-}
-
-/**
- * Computes the quarter (1-4) from a month (0-11).
- */
-function quarter(month: number): number {
-    return Math.floor(month / 3) + 1;
-}
-
-/**
- * Pads a number to a given width with leading zeros.
- */
-function pad(n: number, width: number = 2): string {
-    return String(n).padStart(width, "0");
-}
-
-/**
- * Formats a timezone offset in ±HH:MM format.
- */
-function formatTimezoneOffset(d: Date): string {
-    const offset = -d.getTimezoneOffset();
-    if (offset === 0) return "Z";
-    const sign = offset > 0 ? "+" : "-";
-    const absOffset = Math.abs(offset);
-    const hours = Math.floor(absOffset / 60);
-    const minutes = absOffset % 60;
-    return `${sign}${pad(hours)}:${pad(minutes)}`;
-}
-
-/**
- * Parses a temporal argument (string or map) into a Date object.
- *
- * @param arg - The argument to parse (string or object with year/month/day/hour/minute/second/millisecond)
- * @param fnName - The calling function name for error messages
- * @returns A Date object
- */
-export function parseTemporalArg(arg: any, fnName: string): Date {
-    if (typeof arg === "string") {
-        const d = new Date(arg);
-        if (isNaN(d.getTime())) {
-            throw new Error(`${fnName}(): Invalid temporal string: '${arg}'`);
-        }
-        return d;
-    }
-
-    if (typeof arg === "number") {
-        // Treat as epoch milliseconds
-        return new Date(arg);
-    }
-
-    if (typeof arg === "object" && arg !== null && !Array.isArray(arg)) {
-        // Map-style construction: {year, month, day, hour, minute, second, millisecond}
-        const year = arg.year ?? new Date().getFullYear();
-        const month = (arg.month ?? 1) - 1; // JS months are 0-based
-        const day = arg.day ?? 1;
-        const hour = arg.hour ?? 0;
-        const minute = arg.minute ?? 0;
-        const second = arg.second ?? 0;
-        const millisecond = arg.millisecond ?? 0;
-        return new Date(year, month, day, hour, minute, second, millisecond);
-    }
-
-    throw new Error(
-        `${fnName}(): Expected a string, number (epoch millis), or map argument, got ${typeof arg}`
-    );
-}
-
-/**
- * Builds a datetime result object with full temporal properties.
- *
- * @param d - The Date object
- * @param utc - If true, use UTC values; if false, use local values
- * @returns An object with year, month, day, hour, minute, second, millisecond,
- *          epochMillis, epochSeconds, dayOfWeek, dayOfYear, quarter, formatted
- */
-export function buildDatetimeObject(d: Date, utc: boolean): Record<string, any> {
-    const year = utc ? d.getUTCFullYear() : d.getFullYear();
-    const month = utc ? d.getUTCMonth() + 1 : d.getMonth() + 1;
-    const day = utc ? d.getUTCDate() : d.getDate();
-    const hour = utc ? d.getUTCHours() : d.getHours();
-    const minute = utc ? d.getUTCMinutes() : d.getMinutes();
-    const second = utc ? d.getUTCSeconds() : d.getSeconds();
-    const millisecond = utc ? d.getUTCMilliseconds() : d.getMilliseconds();
-
-    const datePart = new Date(year, month - 1, day);
-
-    const formatted = utc
-        ? d.toISOString()
-        : `${year}-${pad(month)}-${pad(day)}T${pad(hour)}:${pad(minute)}:${pad(second)}.${pad(millisecond, 3)}`;
-
-    return {
-        year,
-        month,
-        day,
-        hour,
-        minute,
-        second,
-        millisecond,
-        epochMillis: d.getTime(),
-        epochSeconds: Math.floor(d.getTime() / 1000),
-        dayOfWeek: isoDayOfWeek(datePart),
-        dayOfYear: dayOfYear(datePart),
-        quarter: quarter(month - 1),
-        formatted,
-    };
-}
-
-/**
- * Builds a date result object (no time component).
- *
- * @param d - The Date object
- * @returns An object with year, month, day, epochMillis, dayOfWeek, dayOfYear, quarter, formatted
- */
-export function buildDateObject(d: Date): Record<string, any> {
-    const year = d.getFullYear();
-    const month = d.getMonth() + 1;
-    const day = d.getDate();
-
-    // Strip time component for epoch calculation
-    const dateOnly = new Date(year, month - 1, day);
-
-    return {
-        year,
-        month,
-        day,
-        epochMillis: dateOnly.getTime(),
-        dayOfWeek: isoDayOfWeek(dateOnly),
-        dayOfYear: dayOfYear(dateOnly),
-        quarter: quarter(month - 1),
-        formatted: `${year}-${pad(month)}-${pad(day)}`,
-    };
-}
-
-/**
- * Builds a time result object (no date component).
- *
- * @param d - The Date object
- * @param utc - If true, use UTC values; if false, use local values
- * @returns An object with hour, minute, second, millisecond, formatted
- */
-export function buildTimeObject(d: Date, utc: boolean): Record<string, any> {
-    const hour = utc ? d.getUTCHours() : d.getHours();
-    const minute = utc ? d.getUTCMinutes() : d.getMinutes();
-    const second = utc ? d.getUTCSeconds() : d.getSeconds();
-    const millisecond = utc ? d.getUTCMilliseconds() : d.getMilliseconds();
-
-    const timePart = `${pad(hour)}:${pad(minute)}:${pad(second)}.${pad(millisecond, 3)}`;
-    const formatted = utc ? `${timePart}Z` : timePart;
-
-    return {
-        hour,
-        minute,
-        second,
-        millisecond,
-        formatted,
-    };
-}

package/src/parsing/functions/time.ts

@@ -1,58 +0,0 @@
-import Function from "./function";
-import { FunctionDef } from "./function_metadata";
-import { buildTimeObject, parseTemporalArg } from "./temporal_utils";
-
-/**
- * Returns a time value (with timezone offset awareness).
- * When called with no arguments, returns the current UTC time.
- * When called with a string argument, parses it as an ISO 8601 time.
- *
- * @example
- * ```
- * RETURN time() AS now
- * RETURN time('12:30:00') AS t
- * ```
- */
-@FunctionDef({
-    description:
-        "Returns a time value. With no arguments returns the current UTC time. " +
-        "Accepts an ISO 8601 time string or a map of components (hour, minute, second, millisecond).",
-    category: "scalar",
-    parameters: [
-        {
-            name: "input",
-            description: "Optional. An ISO 8601 time string (HH:MM:SS) or a map of components.",
-            type: "string",
-            required: false,
-        },
-    ],
-    output: {
-        description: "A time object with properties: hour, minute, second, millisecond, formatted",
-        type: "object",
-    },
-    examples: [
-        "RETURN time() AS now",
-        "RETURN time('12:30:00') AS t",
-        "WITH time() AS t RETURN t.hour, t.minute",
-    ],
-})
-class Time extends Function {
-    constructor() {
-        super("time");
-        this._expectedParameterCount = null;
-    }
-
-    public value(): any {
-        const children = this.getChildren();
-        if (children.length > 1) {
-            throw new Error("time() accepts at most one argument");
-        }
-
-        const d: Date =
-            children.length === 1 ? parseTemporalArg(children[0].value(), "time") : new Date();
-
-        return buildTimeObject(d, true);
-    }
-}
-
-export default Time;

package/src/parsing/functions/timestamp.ts

@@ -1,37 +0,0 @@
-import Function from "./function";
-import { FunctionDef } from "./function_metadata";
-
-/**
- * Returns the number of milliseconds since the Unix epoch (1970-01-01T00:00:00Z).
- *
- * @example
- * ```
- * RETURN timestamp() AS ts
- * ```
- */
-@FunctionDef({
-    description: "Returns the number of milliseconds since the Unix epoch (1970-01-01T00:00:00Z).",
-    category: "scalar",
-    parameters: [],
-    output: {
-        description: "Milliseconds since Unix epoch",
-        type: "number",
-        example: 1718450000000,
-    },
-    examples: [
-        "RETURN timestamp() AS ts",
-        "WITH timestamp() AS before, timestamp() AS after RETURN after - before",
-    ],
-})
-class Timestamp extends Function {
-    constructor() {
-        super("timestamp");
-        this._expectedParameterCount = 0;
-    }
-
-    public value(): any {
-        return Date.now();
-    }
-}
-
-export default Timestamp;

package/src/parsing/functions/to_float.ts

@@ -1,50 +0,0 @@
-import Function from "./function";
-import { FunctionDef } from "./function_metadata";
-
-@FunctionDef({
-    description: "Converts a value to a floating point number",
-    category: "scalar",
-    parameters: [
-        {
-            name: "value",
-            description: "The value to convert to a float",
-            type: "any",
-        },
-    ],
-    output: {
-        description: "The floating point representation of the value",
-        type: "number",
-        example: "3.14",
-    },
-    examples: ['RETURN toFloat("3.14")', "RETURN toFloat(42)", "RETURN toFloat(true)"],
-})
-class ToFloat extends Function {
-    constructor() {
-        super("tofloat");
-        this._expectedParameterCount = 1;
-    }
-
-    public value(): any {
-        const val = this.getChildren()[0].value();
-        if (val === null || val === undefined) {
-            return null;
-        }
-        if (typeof val === "boolean") {
-            return val ? 1.0 : 0.0;
-        }
-        if (typeof val === "number") {
-            return val;
-        }
-        if (typeof val === "string") {
-            const trimmed = val.trim();
-            const parsed = Number(trimmed);
-            if (isNaN(parsed)) {
-                throw new Error(`Cannot convert string "${val}" to float`);
-            }
-            return parsed;
-        }
-        throw new Error("toFloat() expects a number, string, or boolean");
-    }
-}
-
-export default ToFloat;

package/src/parsing/functions/to_integer.ts

@@ -1,50 +0,0 @@
-import Function from "./function";
-import { FunctionDef } from "./function_metadata";
-
-@FunctionDef({
-    description: "Converts a value to an integer",
-    category: "scalar",
-    parameters: [
-        {
-            name: "value",
-            description: "The value to convert to an integer",
-            type: "any",
-        },
-    ],
-    output: {
-        description: "The integer representation of the value",
-        type: "number",
-        example: "42",
-    },
-    examples: ['RETURN toInteger("42")', "RETURN toInteger(3.14)", "RETURN toInteger(true)"],
-})
-class ToInteger extends Function {
-    constructor() {
-        super("tointeger");
-        this._expectedParameterCount = 1;
-    }
-
-    public value(): any {
-        const val = this.getChildren()[0].value();
-        if (val === null || val === undefined) {
-            return null;
-        }
-        if (typeof val === "boolean") {
-            return val ? 1 : 0;
-        }
-        if (typeof val === "number") {
-            return Math.trunc(val);
-        }
-        if (typeof val === "string") {
-            const trimmed = val.trim();
-            const parsed = Number(trimmed);
-            if (isNaN(parsed)) {
-                throw new Error(`Cannot convert string "${val}" to integer`);
-            }
-            return Math.trunc(parsed);
-        }
-        throw new Error("toInteger() expects a number, string, or boolean");
-    }
-}
-
-export default ToInteger;

package/src/parsing/functions/to_json.ts

@@ -1,28 +0,0 @@
-import Function from "./function";
-import { FunctionDef } from "./function_metadata";
-
-@FunctionDef({
-    description: "Parses a JSON string into an object",
-    category: "scalar",
-    parameters: [{ name: "text", description: "JSON string to parse", type: "string" }],
-    output: { description: "Parsed object or array", type: "object", example: { a: 1 } },
-    examples: ["WITH '{\"a\": 1}' AS s RETURN tojson(s)"],
-})
-class ToJson extends Function {
-    constructor() {
-        super("tojson");
-        this._expectedParameterCount = 1;
-    }
-    public value(): any {
-        const str = this.getChildren()[0].value();
-        if (str === null || str === undefined) {
-            return null;
-        }
-        if (typeof str !== "string") {
-            throw new Error("Invalid arguments for tojson function");
-        }
-        return JSON.parse(str);
-    }
-}
-
-export default ToJson;

package/src/parsing/functions/to_lower.ts

@@ -1,28 +0,0 @@
-import Function from "./function";
-import { FunctionDef } from "./function_metadata";
-
-@FunctionDef({
-    description: "Converts a string to lowercase",
-    category: "scalar",
-    parameters: [{ name: "text", description: "String to convert to lowercase", type: "string" }],
-    output: { description: "Lowercase string", type: "string", example: "hello world" },
-    examples: ["WITH 'Hello World' AS s RETURN toLower(s)", "WITH 'FOO' AS s RETURN toLower(s)"],
-})
-class ToLower extends Function {
-    constructor() {
-        super("tolower");
-        this._expectedParameterCount = 1;
-    }
-    public value(): any {
-        const val = this.getChildren()[0].value();
-        if (val === null || val === undefined) {
-            return null;
-        }
-        if (typeof val !== "string") {
-            throw new Error("Invalid argument for toLower function: expected a string");
-        }
-        return val.toLowerCase();
-    }
-}
-
-export default ToLower;

package/src/parsing/functions/to_string.ts

@@ -1,32 +0,0 @@
-import Function from "./function";
-import { FunctionDef } from "./function_metadata";
-
-@FunctionDef({
-    description: "Converts a value to its string representation",
-    category: "scalar",
-    parameters: [{ name: "value", description: "Value to convert to a string", type: "any" }],
-    output: { description: "String representation of the value", type: "string", example: "42" },
-    examples: [
-        "WITH 42 AS n RETURN toString(n)",
-        "WITH true AS b RETURN toString(b)",
-        "WITH [1, 2, 3] AS arr RETURN toString(arr)",
-    ],
-})
-class ToString extends Function {
-    constructor() {
-        super("tostring");
-        this._expectedParameterCount = 1;
-    }
-    public value(): any {
-        const val = this.getChildren()[0].value();
-        if (val === null || val === undefined) {
-            return null;
-        }
-        if (typeof val === "object") {
-            return JSON.stringify(val);
-        }
-        return String(val);
-    }
-}
-
-export default ToString;

package/src/parsing/functions/trim.ts

@@ -1,28 +0,0 @@
-import Function from "./function";
-import { FunctionDef } from "./function_metadata";
-
-@FunctionDef({
-    description: "Removes leading and trailing whitespace from a string",
-    category: "scalar",
-    parameters: [{ name: "text", description: "String to trim", type: "string" }],
-    output: { description: "Trimmed string", type: "string", example: "hello" },
-    examples: ["WITH '  hello  ' AS s RETURN trim(s)", "WITH '\\tfoo\\n' AS s RETURN trim(s)"],
-})
-class Trim extends Function {
-    constructor() {
-        super("trim");
-        this._expectedParameterCount = 1;
-    }
-    public value(): any {
-        const val = this.getChildren()[0].value();
-        if (val === null || val === undefined) {
-            return null;
-        }
-        if (typeof val !== "string") {
-            throw new Error("Invalid argument for trim function: expected a string");
-        }
-        return val.trim();
-    }
-}
-
-export default Trim;

package/src/parsing/functions/type.ts

@@ -1,39 +0,0 @@
-import Function from "./function";
-import { FunctionDef } from "./function_metadata";
-
-@FunctionDef({
-    description: "Returns the type of a value as a string",
-    category: "scalar",
-    parameters: [
-        { name: "value", description: "Value to check the type of", type: "any" }
-    ],
-    output: { description: "Type of the input value", type: "string", example: "string" },
-    examples: [
-        "WITH 'hello' AS val RETURN type(val)",
-        "WITH 42 AS val RETURN type(val)",
-        "WITH [1, 2, 3] AS val RETURN type(val)"
-    ]
-})
-class Type extends Function {
-    constructor() {
-        super("type");
-        this._expectedParameterCount = 1;
-    }
-
-    public value(): any {
-        const val = this.getChildren()[0].value();
-        
-        if (val === null) {
-            return "null";
-        }
-        if (val === undefined) {
-            return "undefined";
-        }
-        if (Array.isArray(val)) {
-            return "array";
-        }
-        return typeof val;
-    }
-}
-
-export default Type;