flowquery 1.0.46 → 1.0.47

package/misc/queries/analyze_catfacts.cql

@@ -1,75 +0,0 @@
-/*
-  This query demonstrates how to use the OpenAI API in FlowQuery to analyze cat facts.
-  
-  To run this query, you need to create a .env file in the same folder as this query within your VSCode project.
-  Create two variables in the .env file:
-    OPENAI_API_KEY='YOUR_OPENAI_API_KEY'
-    OPENAI_ORGANIZATION_ID='YOUR_OPENAI_ORGANIZATION_ID'
-
-  This FlowQuery script implements a chain-of-thoughts LLM pipeline which does the following steps:
-    1. Fetches 10 cat facts from the Cat Facts API and collects them into a list.
-    2. Creates a prompt to analyze the cat facts.
-    3. Calls the OpenAI API with the prompt to get an analysis of the cat facts.
-    4. Creates a second prompt to extract topics from the analysis.
-    5. Calls the OpenAI API with the second prompt to get a list of topics.
-    6. Returns the cat facts, the analysis, and the topics.
-*/
-
-// Setup OpenAI API key and organization ID (read from .env file in same directory as this query file)
-with
-    '$OPENAI_API_KEY' as OPENAI_API_KEY,
-    '$OPENAI_ORGANIZATION_ID' as OPENAI_ORGANIZATION_ID
-
-// 1. Get 10 cat facts and collect them into a list
-unwind range(0,10) as i
-load json from "https://catfact.ninja/fact" as item
-with collect(item.fact) as catfacts
-
-// 2. Create prompt to analyze cat facts
-with f"
-Analyze the following cat facts and answer with a short (1-3 sentences max) summary of the most interesting facts, and what they imply about cats as pets:
-{stringify(catfacts)}
-" as catfacts_analysis_prompt
-
-// 3. Call OpenAI API to analyze cat facts
-load json from 'https://api.openai.com/v1/chat/completions'
-headers {
-    `Content-Type`: 'application/json',
-    Authorization: f'Bearer {OPENAI_API_KEY}',
-    `OpenAI-Organization`: OPENAI_ORGANIZATION_ID
-}
-post {
-    model: 'gpt-4o-mini',
-    messages: [{role: 'user', content: catfacts_analysis_prompt}],
-    temperature: 0.7
-} as openai_response
-with openai_response.choices[0].message.content as catfacts_analysis
-
-// 4. Create a second prompt to extract topics from the analysis
-with f"
-Extract the main topics from the following analysis of cat facts, only single-word topics. Return the topics as a comma-separated list.
-Analysis:
-{catfacts_analysis}
-" as catfacts_topics_prompt
-
-// 5. Call OpenAI API to extract topics
-load json from 'https://api.openai.com/v1/chat/completions'
-headers {
-    `Content-Type`: 'application/json',
-    Authorization: f'Bearer {OPENAI_API_KEY}',
-    `OpenAI-Organization`: OPENAI_ORGANIZATION_ID
-}
-post {
-    model: 'gpt-4o-mini',
-    messages: [{role: 'user', content: catfacts_topics_prompt}],
-    temperature: 0.7
-} as openai_topics_response
-with openai_topics_response.choices[0].message.content as catfacts_topics
-
-// 6. Return the analysis
-return
-    catfacts as `Cat Facts from API`,
-    catfacts_analysis_prompt as `Cat Facts Analysis Prompt`,
-    catfacts_analysis as `Cat Facts Analysis by gpt-4o-mini`,
-    catfacts_topics_prompt as `Cat Facts Topics Prompt`,
-    catfacts_topics as `Cat Facts Topics by gpt-4o-mini`

package/misc/queries/azure_openai_completions.cql

@@ -1,13 +0,0 @@
-// Test completion from Azure OpenAI API
-with
-    '$AZURE_OPENAI_API_KEY' as AZURE_OPENAI_API_KEY
-load json from '$AZURE_OPENAI_ENDPOINT'
-headers {
-    `Content-Type`: 'application/json',
-    `api-key`: AZURE_OPENAI_API_KEY,
-}
-post {
-    messages: [{role: 'user', content: 'Answer with this is a test!'}],
-    temperature: 0.7
-} as data
-return data

package/misc/queries/azure_openai_models.cql

@@ -1,9 +0,0 @@
-// Return models from Azure OpenAI API
-with
-    '$AZURE_OPENAI_API_KEY' as AZURE_OPENAI_API_KEY
-load json from '$AZURE_OPENAI_MODELS_LIST_ENDPOINT'
-headers {
-    `api-key`: f'{AZURE_OPENAI_API_KEY}'
-} as l
-unwind l.data as model
-return model

package/misc/queries/mock_pipeline.cql

@@ -1,84 +0,0 @@
-unwind [
-    {
-        situation_recap: "Once upon a time, there was a conversation. It was a good conversation. There were many objectives in the conversation.",
-        objectives: ["Objective 1", "Objective 2"],
-        feedbacks: [
-            {
-                feedbackType: "compliment",
-                reasoning: "You conversed well",
-                title: "Good job"
-            },
-            {
-                feedbackType: "suggestion",
-                reasoning: "Don't forget to remember",
-                title: "Don't forget"
-            }
-        ],
-        contacts: [
-            {email: "bob@mail.com", displayName: "Bob"},
-            {email: "jane@mail.com", displayName: "Jane"}
-        ],
-        dimension: "Coaching",
-        supporting_messages: [
-            {
-                text: "This is a supporting message",
-                sender: {
-                    email: "bob@mail.com",
-                    displayName: "Bob"
-                }
-            },
-            {
-                text: "This is another supporting message",
-                sender: {
-                    email: "jane@mail.com",
-                    displayName: "Jane"
-                }
-            }
-        ]
-    },
-    {
-        situation_recap: "The conversation was about a topic. The objectives were clear. The feedbacks were insightful.",
-        objectives: ["Objective 3", "Objective 4"],
-        feedbacks: [
-            {
-                feedbackType: "compliment",
-                reasoning: "Very funny conversation",
-                title: "Good job"
-            },
-            {
-                feedbackType: "suggestion",
-                reasoning: "Remember to not forget",
-                title: "Remember"
-            }
-        ],
-        contacts: [
-            {email: "robot@mail.com", displayName: "Robot"},
-            {email: "r2d2@mail.com", displayName: "R2D2"}
-        ],
-        dimension: "Coaching",
-        supporting_messages: [
-            {
-                text: "This is a robot supporting message",
-                sender: {
-                    email: "robot@mail.com",
-                    displayName: "Robot"
-                }
-            },
-            {
-                text: "This is a R2D2 supporting message",
-                sender: {
-                    email: "r2d2@mail.com",
-                    displayName: "R2D2"
-                }
-            }
-        ]
-    }
-] as coach_note
-return
-    coach_note.situation_recap as situation_recap,
-    coach_note.objectives as objectives,
-    coach_note.feedbacks as feedbacks,
-    coach_note.contacts as contacts,
-    coach_note.dimension as dimension,
-    'AGGREGATE_COACH_NOTE' as type,
-    coach_note.supporting_messages as supporting_messages

package/misc/queries/openai_completions.cql

@@ -1,15 +0,0 @@
-// Test completion from OpenAI API
-with
-    '$OPENAI_API_KEY' as OPENAI_API_KEY
-load json from 'https://api.openai.com/v1/chat/completions'
-headers {
-    `Content-Type`: 'application/json',
-    Authorization: f'Bearer {OPENAI_API_KEY}',
-    `OpenAI-Organization`: '$OPENAI_ORGANIZATION_ID' // Must be set to the organization ID
-}
-post {
-    model: 'gpt-4o-mini',
-    messages: [{role: 'user', content: 'Answer with this is a test!'}],
-    temperature: 0.7
-} as data
-return data

package/misc/queries/openai_models.cql

@@ -1,13 +0,0 @@
-// Return models from OpenAI API
-with
-    '$OPENAI_API_KEY' as OPENAI_API_KEY
-load json from 'https://api.openai.com/v1/models'
-headers {
-    Authorization: f'Bearer {OPENAI_API_KEY}'
-} as l
-unwind l.data as model
-return
-    model.id as `Model ID`,
-    model.object as `Object Type`,
-    model.created as `Created Timestamp`,
-    model.owned_by as `Owned By`

package/misc/queries/test.cql

@@ -1,6 +0,0 @@
-// 1. Get 10 cat facts and collect them into a list
-unwind range(0,10) as i
-load json from "https://catfact.ninja/fact" as fact
-
-// Return the cat facts
-return fact.fact as `Fact about cats`, fact.length as `Fact Length`

package/misc/queries/tool_inference.cql

@@ -1,24 +0,0 @@
-with
-    '$OPENAI_API_KEY' as OPENAI_API_KEY,
-    '$OPENAI_ORGANIZATION_ID' as OPENAI_ORG_ID
-unwind ["Where is my document?", "Who is Niclas?", "Who is my manager?"] as query
-with f`
-If query is people-related, then output:
-people_search('query')
-Otherwise, output:
-search('query')
-
-Here is the query: "{query}"
-` as instruction
-load json from 'https://api.openai.com/v1/chat/completions'
-headers {
-    `Content-Type`: 'application/json',
-    Authorization: f'Bearer {OPENAI_API_KEY}',
-    `OpenAI-Organization`: OPENAI_ORG_ID
-}
-post {
-    model: 'gpt-4o-mini',
-    messages: [{role: 'user', content: instruction}],
-    temperature: 0.7
-} as data
-return query, data.choices[0].message.content as tool

package/misc/queries/wisdom.cql

@@ -1,6 +0,0 @@
-/*
-Collect 10 random pieces of wisdom from the Advice Slip API and return them.
-*/
-unwind range(0,10) as i
-load json from "https://api.adviceslip.com/advice" as item
-return item.slip.advice as `Wisdom`

package/misc/queries/wisdom_letter_histogram.cql

@@ -1,8 +0,0 @@
-/*
-Collect 10 random pieces of wisdom and create a letter histogram.
-*/
-unwind range(0,10) as i
-load json from "https://api.adviceslip.com/advice" as item
-with join(collect(item.slip.advice),"") as wisdom
-unwind split(wisdom,"") as letter
-return letter, sum(1) as lettercount

package/src/compute/flowquery.ts

@@ -1,46 +0,0 @@
-import Function from "../parsing/functions/function";
-import { FunctionMetadata } from "../parsing/functions/function_metadata";
-import Runner from "./runner";
-
-/**
- * FlowQuery is the public API surface for the FlowQuery library.
- *
- * It extends {@link Runner} with extensibility features such as function
- * listing and plugin registration, keeping the Runner focused on execution.
- *
- * The static members are assigned dynamically in
- * {@link ../index.browser.ts | index.browser.ts} and
- * {@link ../index.node.ts | index.node.ts}.
- *
- * @example
- * ```typescript
- * const fq = new FlowQuery("WITH 1 as x RETURN x");
- * await fq.run();
- * console.log(fq.results); // [{ x: 1 }]
- *
- * // List all registered functions
- * const functions = FlowQuery.listFunctions();
- * ```
- */
-class FlowQuery extends Runner {
-    /**
-     * List all registered functions with their metadata.
-     */
-    static listFunctions: (options?: {
-        category?: string;
-        asyncOnly?: boolean;
-        syncOnly?: boolean;
-    }) => FunctionMetadata[];
-
-    /**
-     * Get metadata for a specific function.
-     */
-    static getFunctionMetadata: (name: string) => FunctionMetadata | undefined;
-
-    /**
-     * Base Function class for creating custom plugin functions.
-     */
-    static Function: typeof Function;
-}
-
-export default FlowQuery;

package/src/compute/runner.ts

@@ -1,66 +0,0 @@
-import ASTNode from "../parsing/ast_node";
-import Operation from "../parsing/operations/operation";
-import Parser from "../parsing/parser";
-
-/**
- * Executes a FlowQuery statement and retrieves the results.
- *
- * The Runner class parses a FlowQuery statement into an AST and executes it,
- * managing the execution flow from the first operation to the final return statement.
- *
- * @example
- * ```typescript
- * const runner = new Runner("WITH 1 as x RETURN x");
- * await runner.run();
- * console.log(runner.results); // [{ x: 1 }]
- * ```
- */
-class Runner {
-    private first: Operation;
-    private last: Operation;
-
-    /**
-     * Creates a new Runner instance and parses the FlowQuery statement.
-     *
-     * @param statement - The FlowQuery statement to execute
-     * @throws {Error} If the statement is null, empty, or contains syntax errors
-     */
-    constructor(statement: string | null = null, ast: ASTNode | null = null) {
-        if ((statement === null || statement === "") && ast === null) {
-            throw new Error("Either statement or AST must be provided");
-        }
-        const _ast = ast !== null ? ast : new Parser().parse(statement!);
-        this.first = _ast.firstChild() as Operation;
-        this.last = _ast.lastChild() as Operation;
-    }
-
-    /**
-     * Executes the parsed FlowQuery statement.
-     *
-     * @returns A promise that resolves when execution completes
-     * @throws {Error} If an error occurs during execution
-     */
-    public async run(): Promise<void> {
-        return new Promise<void>(async (resolve, reject) => {
-            try {
-                await this.first.initialize();
-                await this.first.run();
-                await this.first.finish();
-                resolve();
-            } catch (e) {
-                reject(e);
-            }
-        });
-    }
-
-    /**
-     * Gets the results from the executed statement.
-     *
-     * @returns The results from the last operation (typically a RETURN statement)
-     */
-    public get results(): any {
-        return this.last.results;
-    }
-}
-
-export default Runner;

package/src/extensibility.ts

@@ -1,45 +0,0 @@
-/**
- * FlowQuery Extensibility API
- * 
- * This module provides all the exports needed to create custom FlowQuery functions.
- * 
- * @packageDocumentation
- * 
- * @example
- * ```typescript
- * import { Function, FunctionDef } from 'flowquery/extensibility';
- * 
- * @FunctionDef({
- *     description: "Converts a string to uppercase",
- *     category: "string",
- *     parameters: [{ name: "text", description: "String to convert", type: "string" }],
- *     output: { description: "Uppercase string", type: "string" }
- * })
- * class UpperCase extends Function {
- *     constructor() {
- *         super("uppercase");
- *         this._expectedParameterCount = 1;
- *     }
- *     public value(): string {
- *         return String(this.getChildren()[0].value()).toUpperCase();
- *     }
- * }
- * ```
- */
-
-// Base function classes for creating custom functions
-export { default as Function } from "./parsing/functions/function";
-export { default as AggregateFunction } from "./parsing/functions/aggregate_function";
-export { default as AsyncFunction } from "./parsing/functions/async_function";
-export { default as PredicateFunction } from "./parsing/functions/predicate_function";
-export { default as ReducerElement } from "./parsing/functions/reducer_element";
-
-// Decorator and metadata types for function registration
-export { 
-    FunctionDef,
-    FunctionMetadata,
-    FunctionDefOptions,
-    ParameterSchema,
-    OutputSchema,
-    FunctionCategory
-} from "./parsing/functions/function_metadata";

package/src/graph/data.ts

@@ -1,130 +0,0 @@
-class IndexEntry {
-    private _positions: number[];
-    private _index: number = -1;
-
-    constructor(positions: number[] = []) {
-        this._positions = positions;
-    }
-    public add(position: number): void {
-        this._positions.push(position);
-    }
-    public get position(): number {
-        return this._positions[this._index];
-    }
-    public reset(): void {
-        this._index = -1;
-    }
-    public next(): boolean {
-        if (this._index < this._positions.length - 1) {
-            this._index++;
-            return true;
-        }
-        return false;
-    }
-    public clone(): IndexEntry {
-        return new IndexEntry([...this._positions]);
-    }
-}
-
-class Layer {
-    private _indexes: Map<string, Map<string, IndexEntry>> = new Map();
-    private _current: number = -1;
-    constructor(indexes: Map<string, Map<string, IndexEntry>>) {
-        this._indexes = indexes;
-    }
-    public index(name: string): Map<string, IndexEntry> {
-        if (!this._indexes.has(name)) {
-            this._indexes.set(name, new Map());
-        }
-        return this._indexes.get(name)!;
-    }
-    public get indexes(): Map<string, Map<string, IndexEntry>> {
-        return this._indexes;
-    }
-    public get current(): number {
-        return this._current;
-    }
-    public set current(value: number) {
-        this._current = value;
-    }
-}
-
-class Data {
-    protected _records: Record<string, any>[] = [];
-    private _layers: Map<number, Layer> = new Map();
-
-    constructor(records: Record<string, any>[] = []) {
-        this._records = records;
-        this._layers.set(0, new Layer(new Map()));
-    }
-    protected _buildIndex(key: string, level: number = 0): void {
-        const idx = this.layer(level).index(key);
-        idx.clear();
-        this._records.forEach((record, i) => {
-            if (record.hasOwnProperty(key)) {
-                if (!idx.has(record[key])) {
-                    idx.set(record[key], new IndexEntry());
-                }
-                idx.get(record[key])!.add(i);
-            }
-        });
-    }
-    public layer(level: number = 0): Layer {
-        if (!this._layers.has(level)) {
-            const first = this._layers.get(0)!;
-            const clonedIndexes = new Map<string, Map<string, IndexEntry>>();
-            for (const [name, indexMap] of first.indexes) {
-                const clonedMap = new Map<string, IndexEntry>();
-                for (const [key, entry] of indexMap) {
-                    clonedMap.set(key, entry.clone());
-                }
-                clonedIndexes.set(name, clonedMap);
-            }
-            this._layers.set(level, new Layer(clonedIndexes));
-        }
-        return this._layers.get(level)!;
-    }
-    protected _find(key: string, level: number = 0, indexName?: string): boolean {
-        const idx = indexName
-            ? this.layer(level).index(indexName)
-            : this.layer(level).indexes.values().next().value;
-        if (!idx || !idx.has(key)) {
-            this.layer(level).current = this._records.length; // Move to end
-            return false;
-        } else {
-            const entry = idx.get(key)!;
-            const more = entry.next();
-            if (!more) {
-                this.layer(level).current = this._records.length; // Move to end
-                return false;
-            }
-            this.layer(level).current = entry.position;
-            return true;
-        }
-    }
-    public reset(): void {
-        for (const layer of this._layers.values()) {
-            layer.current = -1;
-            for (const indexMap of layer.indexes.values()) {
-                for (const entry of indexMap.values()) {
-                    entry.reset();
-                }
-            }
-        }
-    }
-    public next(level: number = 0): boolean {
-        if (this.layer(level).current < this._records.length - 1) {
-            this.layer(level).current++;
-            return true;
-        }
-        return false;
-    }
-    public current(level: number = 0): Record<string, any> | null {
-        if (this.layer(level).current < this._records.length) {
-            return this._records[this.layer(level).current];
-        }
-        return null;
-    }
-}
-
-export default Data;