flowquery 1.0.1 → 1.0.3

package/.github/workflows/release.yml

@@ -47,6 +47,12 @@ jobs:
           cp dist/flowquery.min.js flowquery-vscode/flowQueryEngine/
           ls -la flowquery-vscode/flowQueryEngine/
       
+      - name: Copy to docs folder
+        run: |
+          echo "Copying flowquery.min.js to docs folder for GitHub Pages..."
+          cp dist/flowquery.min.js docs/
+          ls -la docs/flowquery.min.js
+      
       - name: Bump version
         id: version
         run: |
@@ -61,7 +67,7 @@ jobs:
           echo "tag=v${NEW_VERSION}" >> $GITHUB_OUTPUT
           
           # Commit the version bump
-          git add package.json package-lock.json
+          git add package.json package-lock.json docs/flowquery.min.js
           git commit -m "chore: bump version to ${NEW_VERSION} [skip ci]"
           git push
       

package/README.md

@@ -18,8 +18,61 @@ FlowQuery is written in TypeScript (https://www.typescriptlang.org/) and built/c
   - This will run all unit tests.
 - Build: ```npm run build``` (builds for both Node and web)
 
+## Installation & Usage
+
+### Node.js
+
+Install FlowQuery from npm:
+
+```bash
+npm install flowquery
+```
+
+Then use it in your code:
+
+```javascript
+const FlowQuery = require('flowquery').default;
+// Or with ES modules:
+// import FlowQuery from 'flowquery';
+
+async function main() {
+    const query = new FlowQuery('WITH 1 AS x RETURN x + 1');
+    await query.run();
+    console.log(query.results); // [ { expr0: 2 } ]
+}
+
+main();
+```
+
+### Browser
+
+Include the minified bundle in your HTML:
+
+```html
+<script src="https://microsoft.github.io/FlowQuery/flowquery.min.js"></script>
+<script>
+async function main() {
+    const query = new FlowQuery('WITH 1 AS x RETURN x + 1');
+    await query.run();
+    console.log(query.results); // [ { expr0: 2 } ]
+}
+
+main();
+</script>
+```
+
+Or import from the browser-specific entry point:
+
+```javascript
+import FlowQuery from 'flowquery/browser';
+
+const query = new FlowQuery('WITH "Hello" AS greeting RETURN greeting');
+await query.run();
+console.log(query.results);
+```
+
 ## Examples
-See also .\queries and .\tests\compute\runner.test.ts for more examples.
+See also ./misc/queries and ./tests/compute/runner.test.ts for more examples.
 ```cypher
 /*
 Collect 10 random pieces of wisdom and create a letter histogram.

package/dist/parsing/parser.js

@@ -52,7 +52,7 @@ const null_1 = __importDefault(require("./components/null"));
  * @example
  * ```typescript
  * const parser = new Parser();
- * const ast = parser.parse("unwind [1, 2, 3, 4, 5, 6] as num return num");
+ * const ast = parser.parse("unwind [1, 2, 3, 4, 5] as num return num");
  * ```
  */
 class Parser extends base_parser_1.default {

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/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.2"
+  },
+  "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 { run } 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 = `return 1`;
+
+    try {
+        const result = await run(query);
+        console.log('Result:', result);
+    } 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.1",
+  "version": "1.0.3",
   "description": "A declarative query language for data processing pipelines.",
   "main": "dist/index.node.js",
   "types": "dist/index.node.d.ts",
@@ -37,6 +37,7 @@
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
     "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
     "typedoc": "^0.28.14",
     "typescript": "^5.7.2",
     "webpack": "^5.97.1",

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, 6] as num return num");
+ * const ast = parser.parse("unwind [1, 2, 3, 4, 5] 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.