flowquery 1.0.2 → 1.0.5

package/dist/tokenization/token_mapper.d.ts

@@ -0,0 +1,40 @@
+import Token from "./token";
+/**
+ * Maps string values to tokens using a Trie for efficient lookup.
+ *
+ * Takes an enum of keywords, operators, or symbols and builds a trie
+ * for fast token matching during tokenization.
+ *
+ * @example
+ * ```typescript
+ * const mapper = new TokenMapper(Keyword);
+ * const token = mapper.map("WITH");
+ * ```
+ */
+declare class TokenMapper {
+    private _enum;
+    private _trie;
+    /**
+     * Creates a TokenMapper from an enum of token values.
+     *
+     * @param _enum - An enum object containing token values
+     */
+    constructor(_enum: {
+        [key: string]: any;
+    });
+    /**
+     * Maps a string value to its corresponding token.
+     *
+     * @param value - The string value to map
+     * @returns The matched token, or undefined if no match found
+     */
+    map(value: string): Token | undefined;
+    /**
+     * Gets the last matched string from the most recent map operation.
+     *
+     * @returns The last found string, or null if no match
+     */
+    get last_found(): string | null;
+}
+export default TokenMapper;
+//# sourceMappingURL=token_mapper.d.ts.map

package/dist/tokenization/token_mapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token_mapper.d.ts","sourceRoot":"","sources":["../../src/tokenization/token_mapper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,SAAS,CAAC;AAG5B;;;;;;;;;;;GAWG;AACH,cAAM,WAAW;IAQD,OAAO,CAAC,KAAK;IAPzB,OAAO,CAAC,KAAK,CAAoB;IAEjC;;;;OAIG;gBACiB,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IASjD;;;;;OAKG;IACI,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAI5C;;;;OAIG;IACH,IAAW,UAAU,IAAI,MAAM,GAAG,IAAI,CAErC;CACJ;AAED,eAAe,WAAW,CAAC"}

package/dist/tokenization/token_mapper.js

@@ -3,8 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const token_1 = __importDefault(require("../../src/tokenization/token"));
-const trie_1 = __importDefault(require("../../src/tokenization/trie"));
+const token_1 = __importDefault(require("./token"));
+const trie_1 = __importDefault(require("./trie"));
 /**
  * Maps string values to tokens using a Trie for efficient lookup.
  *

package/dist/tokenization/token_mapper.js.map

@@ -1 +1 @@
-{"version":3,"file":"token_mapper.js","sourceRoot":"","sources":["../../src/tokenization/token_mapper.ts"],"names":[],"mappings":";;;;;AAAA,yEAAiD;AACjD,uEAA+C;AAE/C;;;;;;;;;;;GAWG;AACH,MAAM,WAAW;IAGb;;;;OAIG;IACH,YAAoB,KAA6B;QAA7B,UAAK,GAAL,KAAK,CAAwB;QAPzC,UAAK,GAAS,IAAI,cAAI,EAAE,CAAC;QAQ7B,KAAI,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAsB,eAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACnD,IAAG,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC7C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC7B,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,GAAG,CAAC,KAAa;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;IACjC,CAAC;CACJ;AAED,kBAAe,WAAW,CAAC"}
+{"version":3,"file":"token_mapper.js","sourceRoot":"","sources":["../../src/tokenization/token_mapper.ts"],"names":[],"mappings":";;;;;AAAA,oDAA4B;AAC5B,kDAA0B;AAE1B;;;;;;;;;;;GAWG;AACH,MAAM,WAAW;IAGb;;;;OAIG;IACH,YAAoB,KAA6B;QAA7B,UAAK,GAAL,KAAK,CAAwB;QAPzC,UAAK,GAAS,IAAI,cAAI,EAAE,CAAC;QAQ7B,KAAI,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAsB,eAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACnD,IAAG,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC7C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC7B,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,GAAG,CAAC,KAAa;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;IACjC,CAAC;CACJ;AAED,kBAAe,WAAW,CAAC"}

package/dist/tokenization/token_type.d.ts

@@ -0,0 +1,16 @@
+declare enum TokenType {
+    KEYWORD = "KEYWORD",
+    OPERATOR = "OPERATOR",
+    UNARY_OPERATOR = "UNARY_OPERATOR",
+    IDENTIFIER = "IDENTIFIER",
+    STRING = "STRING",
+    F_STRING = "F-STRING",
+    BACKTICK_STRING = "BACKTICK_STRING",
+    NUMBER = "NUMBER",
+    SYMBOL = "SYMBOL",
+    WHITESPACE = "WHITESPACE",
+    COMMENT = "COMMENT",
+    EOF = "EOF"
+}
+export default TokenType;
+//# sourceMappingURL=token_type.d.ts.map

package/dist/tokenization/token_type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token_type.d.ts","sourceRoot":"","sources":["../../src/tokenization/token_type.ts"],"names":[],"mappings":"AAAA,aAAK,SAAS;IACV,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,cAAc,mBAAmB;IACjC,UAAU,eAAe;IACzB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,GAAG,QAAQ;CACd;AACD,eAAe,SAAS,CAAC"}

package/dist/tokenization/tokenizer.d.ts

@@ -0,0 +1,45 @@
+import Token from './token';
+/**
+ * Tokenizes FlowQuery input strings into a sequence of tokens.
+ *
+ * The tokenizer performs lexical analysis, breaking down the input text into
+ * meaningful tokens such as keywords, identifiers, operators, strings, numbers,
+ * and symbols. It handles comments, whitespace, and f-strings.
+ *
+ * @example
+ * ```typescript
+ * const tokenizer = new Tokenizer("WITH x = 1 RETURN x");
+ * const tokens = tokenizer.tokenize();
+ * ```
+ */
+declare class Tokenizer {
+    private walker;
+    private keywords;
+    private symbols;
+    private operators;
+    /**
+     * Creates a new Tokenizer instance for the given input.
+     *
+     * @param input - The FlowQuery input string to tokenize
+     */
+    constructor(input: string);
+    /**
+     * Tokenizes the input string into an array of tokens.
+     *
+     * @returns An array of Token objects representing the tokenized input
+     * @throws {Error} If an unrecognized token is encountered
+     */
+    tokenize(): Token[];
+    private getLastNonWhitespaceOrNonCommentToken;
+    private getNextToken;
+    comment(): Token | null;
+    private identifier;
+    private string;
+    private f_string;
+    private whitespace;
+    private number;
+    private lookup;
+    private skipMinus;
+}
+export default Tokenizer;
+//# sourceMappingURL=tokenizer.d.ts.map

package/dist/tokenization/tokenizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenizer.d.ts","sourceRoot":"","sources":["../../src/tokenization/tokenizer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,SAAS,CAAC;AAO5B;;;;;;;;;;;;GAYG;AACH,cAAM,SAAS;IACX,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,QAAQ,CAAyC;IACzD,OAAO,CAAC,OAAO,CAAwC;IACvD,OAAO,CAAC,SAAS,CAA0C;IAE3D;;;;OAIG;gBACS,KAAK,EAAE,MAAM;IAIzB;;;;;OAKG;IACI,QAAQ,IAAI,KAAK,EAAE;IAgB1B,OAAO,CAAC,qCAAqC;IAU7C,OAAO,CAAC,YAAY;IAgBb,OAAO,IAAI,KAAK,GAAG,IAAI;IAS9B,OAAO,CAAC,UAAU;IAWlB,OAAO,CAAC,MAAM;IAwBd,OAAO,CAAE,QAAQ;IA6CjB,OAAO,CAAC,UAAU;IASlB,OAAO,CAAC,MAAM;IAiBd,OAAO,CAAC,MAAM;IAkBd,OAAO,CAAC,SAAS;CASpB;AAED,eAAe,SAAS,CAAC"}

package/dist/tokenization/trie.d.ts

@@ -0,0 +1,41 @@
+import Token from "./token";
+/**
+ * Trie (prefix tree) data structure for efficient keyword and operator lookup.
+ *
+ * Used during tokenization to quickly match input strings against known keywords
+ * and operators. Supports case-insensitive matching and tracks the longest match found.
+ *
+ * @example
+ * ```typescript
+ * const trie = new Trie();
+ * trie.insert(Token.WITH);
+ * const found = trie.find("WITH");
+ * ```
+ */
+declare class Trie {
+    private _root;
+    private _max_length;
+    private _last_found;
+    /**
+     * Inserts a token into the trie.
+     *
+     * @param token - The token to insert
+     * @throws {Error} If the token value is null or empty
+     */
+    insert(token: Token): void;
+    /**
+     * Finds a token by searching for the longest matching prefix in the trie.
+     *
+     * @param value - The string value to search for
+     * @returns The token if found, undefined otherwise
+     */
+    find(value: string): Token | undefined;
+    /**
+     * Gets the last matched string from the most recent find operation.
+     *
+     * @returns The last found string, or null if no match was found
+     */
+    get last_found(): string | null;
+}
+export default Trie;
+//# sourceMappingURL=trie.d.ts.map

package/dist/tokenization/trie.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trie.d.ts","sourceRoot":"","sources":["../../src/tokenization/trie.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,SAAS,CAAC;AAqC5B;;;;;;;;;;;;GAYG;AACH,cAAM,IAAI;IACN,OAAO,CAAC,KAAK,CAAoB;IACjC,OAAO,CAAC,WAAW,CAAa;IAChC,OAAO,CAAC,WAAW,CAAuB;IAE1C;;;;;OAKG;IACI,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAcjC;;;;;OAKG;IACI,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAyB7C;;;;OAIG;IACH,IAAW,UAAU,IAAI,MAAM,GAAG,IAAI,CAErC;CACJ;AAED,eAAe,IAAI,CAAC"}

package/dist/utils/object_utils.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Utility class for object-related operations.
+ */
+declare class ObjectUtils {
+    /**
+     * Checks if an object is an instance of any of the provided classes.
+     *
+     * @param obj - The object to check
+     * @param classes - Array of class constructors to test against
+     * @returns True if the object is an instance of any class, false otherwise
+     */
+    static isInstanceOfAny(obj: any, classes: any[]): boolean;
+}
+export default ObjectUtils;
+//# sourceMappingURL=object_utils.d.ts.map

package/dist/utils/object_utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object_utils.d.ts","sourceRoot":"","sources":["../../src/utils/object_utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAM,WAAW;IACb;;;;;;OAMG;IACH,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,OAAO;CAG5D;AAED,eAAe,WAAW,CAAC"}

package/dist/utils/string_utils.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Utility class for string manipulation and validation.
+ *
+ * Provides methods for handling quoted strings, comments, escape sequences,
+ * and identifier validation.
+ */
+declare class StringUtils {
+    static readonly quotes: string[];
+    static readonly letters = "abcdefghijklmnopqrstuvwxyz";
+    static readonly digits = "0123456789";
+    static readonly whitespace = " \t\n\r";
+    static readonly word_valid_chars: string;
+    /**
+     * Removes surrounding quotes from a string.
+     *
+     * @param str - The string to unquote
+     * @returns The unquoted string
+     */
+    static unquote(str: string): string;
+    /**
+     * Removes comment markers from a string.
+     *
+     * @param str - The comment string
+     * @returns The string without comment markers
+     */
+    static uncomment(str: string): string;
+    /**
+     * Removes escape sequences before quotes in a string.
+     *
+     * @param str - The string to process
+     * @param quoteChar - The quote character that was escaped
+     * @returns The string with escape sequences removed
+     */
+    static removeEscapedQuotes(str: string, quoteChar: string): string;
+    /**
+     * Removes escaped braces ({{ and }}) from f-strings.
+     *
+     * @param str - The string to process
+     * @returns The string with escaped braces resolved
+     */
+    static removeEscapedBraces(str: string): string;
+    /**
+     * Checks if a string is a valid identifier.
+     *
+     * @param str - The string to validate
+     * @returns True if the string can be used as an identifier, false otherwise
+     */
+    static can_be_identifier(str: string): boolean;
+}
+export default StringUtils;
+//# sourceMappingURL=string_utils.d.ts.map

package/dist/utils/string_utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string_utils.d.ts","sourceRoot":"","sources":["../../src/utils/string_utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,cAAM,WAAW;IACb,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAmB;IACnD,MAAM,CAAC,QAAQ,CAAC,OAAO,gCAAgC;IACvD,MAAM,CAAC,QAAQ,CAAC,MAAM,gBAAgB;IACtC,MAAM,CAAC,QAAQ,CAAC,UAAU,aAAa;IACvC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,SAAkD;IAElF;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAqBnC;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAarC;;;;;;OAMG;IACH,MAAM,CAAC,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IAWlE;;;;;OAKG;IACH,MAAM,CAAC,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAW/C;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;CAWjD;AAED,eAAe,WAAW,CAAC"}

package/misc/apps/RAG/README.md

@@ -0,0 +1,48 @@
+# RAG FlowQuery App
+
+A RAG (Retrieval Augmented Generation) loop based on [FlowQuery](https://www.npmjs.com/package/flowquery).
+
+## Prerequisites
+
+- Node.js 18+
+- npm
+
+## Getting Started
+
+```bash
+# Install dependencies
+npm install
+
+# Run in development mode (with ts-node)
+npm run dev
+
+# Or build and run
+npm run build
+npm start
+```
+
+## Available Scripts
+
+| Script | Description |
+|--------|-------------|
+| `npm run dev` | Run directly with ts-node (for development) |
+| `npm run build` | Compile TypeScript to `dist/` |
+| `npm start` | Run the compiled JavaScript |
+| `npm run build:bundle` | Create a webpack bundle |
+| `npm run watch` | Watch mode for TypeScript compilation |
+
+## Project Structure
+
+```
+RAG/
+├── src/
+│   └── index.ts      # Main entry point
+├── dist/             # Compiled output (generated)
+├── package.json
+├── tsconfig.json
+└── webpack.config.js
+```
+
+## License
+
+MIT

package/misc/apps/RAG/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "rag-flowquery",
+  "version": "1.0.0",
+  "description": "A RAG (Retrieval Augmented Generation) loop based on FlowQuery.",
+  "main": "dist/index.js",
+  "scripts": {
+    "start": "node dist/index.js",
+    "dev": "ts-node src/index.ts",
+    "build": "tsc",
+    "build:bundle": "webpack",
+    "watch": "tsc --watch"
+  },
+  "keywords": [
+    "rag",
+    "flowquery",
+    "retrieval-augmented-generation"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "flowquery": "^1.0.3"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.2",
+    "webpack": "^5.97.1",
+    "webpack-cli": "^6.0.1"
+  }
+}

package/misc/apps/RAG/src/index.ts

@@ -0,0 +1,20 @@
+import { FlowQuery } from 'flowquery';
+
+/**
+ * RAG (Retrieval Augmented Generation) loop using FlowQuery.
+ * 
+ * This is a starter template - customize it for your RAG implementation.
+ */
+async function main() {
+    // Example: Run a simple FlowQuery query
+    const query = new FlowQuery('WITH 1 AS x RETURN x + 1');
+
+    try {
+        await query.run();
+        console.log('Result:', query.results); // [ { expr0: 2 } ]
+    } catch (error) {
+        console.error('Error running query:', error);
+    }
+}
+
+main();

package/misc/apps/RAG/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "target": "ES2020",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "sourceMap": true,
+    "resolveJsonModule": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/misc/apps/RAG/webpack.config.js

@@ -0,0 +1,32 @@
+const path = require('path');
+
+module.exports = {
+  mode: 'production',
+  entry: './src/index.ts',
+  target: 'node',
+  output: {
+    filename: 'rag.bundle.js',
+    path: path.resolve(__dirname, 'dist'),
+    libraryTarget: 'commonjs2'
+  },
+  resolve: {
+    extensions: ['.ts', '.js']
+  },
+  module: {
+    rules: [
+      {
+        test: /\.ts$/,
+        use: 'ts-loader',
+        exclude: /node_modules/
+      }
+    ]
+  },
+  externals: {
+    // Add any externals here if needed
+    // For example, if you want to exclude flowquery from the bundle:
+    // 'flowquery': 'commonjs flowquery'
+  },
+  optimization: {
+    minimize: true
+  }
+};

package/misc/apps/README.md

@@ -0,0 +1 @@
+Example apps using FlowQuery.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flowquery",
-  "version": "1.0.2",
+  "version": "1.0.5",
   "description": "A declarative query language for data processing pipelines.",
   "main": "dist/index.node.js",
   "types": "dist/index.node.d.ts",

package/src/parsing/parser.ts

@@ -50,7 +50,7 @@ import Null from "./components/null";
  * @example
  * ```typescript
  * const parser = new Parser();
- * const ast = parser.parse("unwind [1, 2, 3, 4, 5] as num return num");
+ * const ast = parser.parse("unwind [1, 2, 3, 4] as num return num");
  * ```
  */
 class Parser extends BaseParser {

package/src/tokenization/token_mapper.ts

@@ -1,5 +1,5 @@
-import Token from "../../src/tokenization/token";
-import Trie from "../../src/tokenization/trie";
+import Token from "./token";
+import Trie from "./trie";
 
 /**
  * Maps string values to tokens using a Trie for efficient lookup.

package/tsconfig.json

@@ -9,7 +9,9 @@
     "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
     "strict": true,
     "types": ["node", "jest"],
-    "sourceMap": true
+    "sourceMap": true,
+    "declaration": true,                                 /* Generate .d.ts declaration files. */
+    "declarationMap": true                               /* Generate sourcemaps for .d.ts files. */
   },
   "include": ["src"]
 }