@wxn0brp/vql 0.4.3 → 0.6.0-alpha.0

package/README.md

@@ -2,6 +2,10 @@
 
 VQL is a query language and processing framework designed for managing and interacting with databases using ValtheraDB. It provides a robust permission system, query execution, and a GUI for managing ACL rules and database structures.
 
+[![npm version](https://img.shields.io/npm/v/@wxn0brp/vql)](https://www.npmjs.com/package/@wxn0brp/vql)
+[![License](https://img.shields.io/npm/l/@wxn0brp/vql)](./LICENSE)
+[![Downloads](https://img.shields.io/npm/dm/@wxn0brp/vql)](https://www.npmjs.com/package/@wxn0brp/vql)
+
 ## Features
 
 - **Query Execution**: Supports CRUD operations and advanced query capabilities.
@@ -16,18 +20,14 @@ Here is an example of how to use the `VQLProcessor` to execute a query:
 ```typescript
 import VQLProcessor from "@wxn0brp/vql";
 import { Valthera } from "@wxn0brp/db";
-import { GateWarden } from "@wxn0brp/gate-warden";
 
 // Initialize database instances
 const dbInstances = {
     myDatabase: new Valthera("path/to/database"),
 };
 
-// Initialize Gate Warden
-const gw = new GateWarden("path/to/gate-warden/database");
-
 // Create a VQLProcessor instance
-const processor = new VQLProcessor(dbInstances, gw);
+const processor = new VQLProcessor(dbInstances);
 
 // Define a query (VQLR)
 const query = {
@@ -49,31 +49,11 @@ s.$gt.age = 18
 f.name = 1
 f.age = 1
 `
-// Or (use backticks like json)
-const VQLB = `
-myDatabase users
-{
-    collection: "users",
-    search: { $gt: { age: 18 } },
-    fields: { name: 1, age: 1 },
-}
-`
-// Or (use markup like yaml)
-const VQLM = `
-myDatabase users
-collection: users
-search:
-  $gt:
-    age: 18
-fields:
-  name: 1
-  age: 1
-`
 
 // Execute the query
 (async () => {
     try {
-        const result = await processor.execute(query, { id: "user123" });
+        const result = await processor.execute(query);
         console.log("Query Result:", result);
     } catch (error) {
         console.error("Error executing query:", error);
@@ -85,7 +65,6 @@ fields:
 
 - [Base/Map](./docs/lang/base.md)
 - [VQLS](./docs/lang/VQLS.md)
-- [VQLM/B](./docs/lang/VQLM.md)
 - [VQLR](./docs/lang/VQLR.md)
 
 ## License

package/dist/apiAbstract.d.ts

@@ -13,7 +13,7 @@ export interface ValtheraResolver {
     meta?: ValtheraResolverMeta;
     getCollections?: ResolverFn<[], string[]>;
     issetCollection?: ResolverFn<[collection: string], boolean>;
-    checkCollection?: ResolverFn<[collection: string], boolean>;
+    ensureCollection?: ResolverFn<[collection: string], boolean>;
     add?: ResolverFn<[collection: string, data: any, id_gen?: boolean], any>;
     find?: ResolverFn<[
         collection: string,

package/dist/apiAbstract.js

@@ -12,7 +12,7 @@ export function createValtheraAdapter(resolver, extendedFind = false) {
         c: null,
         getCollections: () => safe(resolver.getCollections)(),
         issetCollection: (c) => safe(resolver.issetCollection)(c),
-        checkCollection: (c) => safe(resolver.checkCollection)(c),
+        ensureCollection: (c) => safe(resolver.ensureCollection)(c),
         add: (col, data, id_gen) => safe(resolver.add)(col, data, id_gen),
         find: (col, search, context, options, findOpts) => safe(resolver.find)(col, search, context, options, findOpts),
         findOne: (col, search, context, findOpts) => safe(resolver.findOne)(col, search, context, findOpts),

package/dist/config.d.ts

@@ -3,13 +3,11 @@ export interface VQLConfigInterface {
     strictSelect: boolean;
     strictACL: boolean;
     noCheckPermissions: boolean;
-    formatAjv: boolean;
 }
 export declare class VQLConfig implements VQLConfigInterface {
     hidePath: boolean;
     strictSelect: boolean;
     strictACL: boolean;
     noCheckPermissions: boolean;
-    formatAjv: boolean;
     constructor(config?: Partial<VQLConfigInterface>);
 }

package/dist/config.js

@@ -1,9 +1,8 @@
 export class VQLConfig {
-    hidePath = true;
-    strictSelect = true;
-    strictACL = true;
-    noCheckPermissions = false;
-    formatAjv = true;
+    hidePath = false;
+    strictSelect = false;
+    strictACL = false;
+    noCheckPermissions = true;
     constructor(config) {
         if (config) {
             Object.assign(this, config);

package/dist/cpu/relation.js

@@ -21,7 +21,7 @@ export async function executeRelation(cpu, query, user) {
     const checkDb = checkDBsExist(cpu, query.r);
     if (checkDb.err)
         return checkDb;
-    if (!cpu.config.noCheckPermissions && !await checkRelationPermission(cpu.config, cpu.gw, user, query)) {
+    if (!cpu.config.noCheckPermissions && !await checkRelationPermission(cpu.config, cpu.validFn, user, query)) {
         return { err: true, msg: "Permission denied", c: 403 };
     }
     const req = query.r;

package/dist/cpu/request.js

@@ -5,7 +5,7 @@ export async function executeQuery(cpu, query, user) {
         return { err: true, msg: `Invalid query - db "${query.db || "undefined"}" not found`, c: 400 };
     const db = cpu.dbInstances[query.db];
     const operation = Object.keys(query.d)[0];
-    if (!cpu.config.noCheckPermissions && !await checkRequestPermission(cpu.config, cpu.gw, user, query)) {
+    if (!cpu.config.noCheckPermissions && !await checkRequestPermission(cpu.config, cpu.validFn, user, query)) {
         return { err: true, msg: "Permission denied", c: 403 };
     }
     if (operation === "find") {
@@ -50,9 +50,9 @@ export async function executeQuery(cpu, query, user) {
         const params = query.d[operation];
         return db.removeCollection(params.collection);
     }
-    else if (operation === "checkCollection") {
+    else if (operation === "ensureCollection") {
         const params = query.d[operation];
-        return db.checkCollection(params.collection);
+        return db.ensureCollection(params.collection);
     }
     else if (operation === "issetCollection") {
         const params = query.d[operation];

package/dist/cpu/string/index.d.ts

@@ -1,8 +1,2 @@
 import { VQL } from "../../types/vql.js";
-export type VQLParserMode = "VQLS" | "VQLM" | "VQLB" | "VQLR";
-export declare function guessParser(query: string): {
-    mode: VQLParserMode;
-    query: string;
-};
-declare function parseStringQuery(query: string): VQL;
-export { parseStringQuery };
+export declare function parseVQLS(query: string): VQL;

package/dist/cpu/string/index.js

@@ -1,56 +1,153 @@
-import logger from "../../logger.js";
-import { parseVQLB } from "./json5.js";
-import { parseVQLS } from "./simple.js";
-import { parseVQLM } from "./yaml.js";
-function get3rdAnd4thWord(query) {
-    let words = [];
-    let word = "";
-    let i = 0;
-    while (i < query.length && words.length < 4) {
-        const c = query[i++];
-        if (" \t\n\r".includes(c)) {
-            if (word)
-                words.push(word);
-            word = "";
+import { convertSearchObjToSearchArray, extractMeta } from "./utils.js";
+const aliases = {
+    s: "search",
+    f: "fields",
+    o: "options",
+    r: "relations",
+    d: "data",
+    e: "select",
+    u: "updater",
+};
+function parseArgs(input) {
+    const result = {};
+    const tokens = [];
+    let current = "";
+    let inQuotes = false;
+    let escape = false;
+    for (let i = 0; i < input.length; i++) {
+        const char = input[i];
+        if (escape) {
+            current += char;
+            escape = false;
+        }
+        else if (char === "\\") {
+            escape = true;
+        }
+        else if (char === "\"") {
+            inQuotes = !inQuotes;
+        }
+        else if (!inQuotes && (char === " " || char === "=")) {
+            if (current !== "") {
+                tokens.push(current);
+                current = "";
+            }
         }
         else {
-            word += c;
+            current += char;
+        }
+    }
+    if (current !== "") {
+        tokens.push(current);
+    }
+    for (let i = 0; i < tokens.length; i += 2) {
+        const key = tokens[i];
+        let value = tokens[i + 1] ?? true;
+        if (typeof value === "string") {
+            const trimmed = value.trim();
+            if (trimmed === "") {
+                value = true;
+            }
+            else if (/^".*"$/.test(trimmed)) {
+                value = trimmed.slice(1, -1);
+            }
+            else if (trimmed.toLowerCase() === "true") {
+                value = true;
+            }
+            else if (trimmed.toLowerCase() === "false") {
+                value = false;
+            }
+            else if (!isNaN(Number(trimmed))) {
+                value = Number(trimmed);
+            }
+            else if ((trimmed.startsWith("{") && trimmed.endsWith("}")) || (trimmed.startsWith("[") && trimmed.endsWith("]"))) {
+                try {
+                    value = JSON.parse(trimmed);
+                }
+                catch { }
+            }
         }
+        result[key] = value;
     }
-    if (word && words.length < 4)
-        words.push(word);
-    return words[2] + (words[3] ? " " + words[3] : "");
+    return result;
 }
-export function guessParser(query) {
-    query = query.trimStart();
-    if (query[0] === "#") {
+function buildVQL(db, op, collection, query) {
+    const hasRelations = "relations" in query;
+    if (hasRelations) {
+        const relations = {};
+        for (const key in query.relations) {
+            const value = query.relations[key];
+            relations[key] = {
+                path: [value.db || db, value.c || key],
+                ...value
+            };
+            delete relations[key].db;
+            delete relations[key].c;
+        }
+        if ("select" in query) {
+            query.select = convertSearchObjToSearchArray(query.select);
+        }
         return {
-            mode: "VQL" + query[1].toUpperCase(),
-            query: query.slice(2)
+            r: {
+                path: [db, collection],
+                ...query,
+                relations,
+            }
+        };
+    }
+    else {
+        if (query.fields && !query.select) {
+            query.select = query.fields;
+            delete query.fields;
+        }
+        if ("select" in query) {
+            query.select = [...new Set(convertSearchObjToSearchArray(query.select).map(k => k[0]).flat())];
+        }
+        return {
+            db,
+            d: {
+                [op]: {
+                    collection,
+                    ...query,
+                }
+            }
         };
     }
-    const _34word = get3rdAnd4thWord(query);
-    let mode = "VQLS";
-    if (_34word.includes("{"))
-        mode = "VQLB";
-    else if (_34word.includes(":"))
-        mode = "VQLM";
-    return {
-        mode,
-        query
-    };
 }
-function parseStringQuery(query) {
-    const { mode, query: queryRaw } = guessParser(query);
-    logger.debug("Query mode: " + mode);
-    if (mode === "VQLB") {
-        return parseVQLB(queryRaw);
+export function parseVQLS(query) {
+    const { db, op, collection, body } = extractMeta(query);
+    const parsed = parseArgs(body);
+    for (const keysRaw of Object.keys(parsed)) {
+        const keys = keysRaw.split(".");
+        if (keys.length === 1) {
+            continue;
+        }
+        let obj = parsed;
+        for (let i = 0; i < keys.length; i++) {
+            const key = keys[i];
+            if (i < keys.length - 1) {
+                if (!(key in obj)) {
+                    obj[key] = {};
+                }
+                obj = obj[key];
+            }
+            else {
+                obj[key] = parsed[keysRaw];
+                delete parsed[keysRaw];
+            }
+        }
+    }
+    for (const key in aliases) {
+        if (key in parsed) {
+            parsed[aliases[key]] = parsed[key];
+            delete parsed[key];
+        }
     }
-    else if (mode === "VQLM") {
-        return parseVQLM(queryRaw);
+    if ((op === "find" || op === "findOne") && !("search" in parsed)) {
+        parsed.search = {};
     }
-    else {
-        return parseVQLS(queryRaw);
+    if ((op === "update" || op === "remove") && !("updater" in parsed) && ("data" in parsed)) {
+        parsed.updater = parsed.data;
+        delete parsed.data;
     }
+    return buildVQL(db, op, collection, parsed);
 }
-export { parseStringQuery };

package/dist/cpu/string/utils.d.ts

@@ -15,3 +15,4 @@ export declare function extractMeta(input: string): {
     collection: string;
     body: string;
 };
+export declare function convertSearchObjToSearchArray(obj: Record<string, any>, parentKeys?: string[]): string[][];

package/dist/cpu/string/utils.js

@@ -9,7 +9,7 @@ const operations = [
     "update", "updateOne",
     "remove", "removeOne",
     "updateOneOrAdd",
-    "checkCollection", "issetCollection",
+    "ensureCollection", "issetCollection",
 ];
 /**
  * Extracts metadata from a query string, including database name, operation,
@@ -87,3 +87,17 @@ function extendedCollectionToData(collection) {
     }
     return { op, collection: collectionName };
 }
+export function convertSearchObjToSearchArray(obj, parentKeys = []) {
+    return Object.entries(obj).reduce((acc, [key, value]) => {
+        const currentPath = [...parentKeys, key];
+        if (!value) {
+            return acc;
+        }
+        else if (typeof value === 'object' && value !== null && !Array.isArray(value)) {
+            return [...acc, ...convertSearchObjToSearchArray(value, currentPath)];
+        }
+        else {
+            return [...acc, currentPath];
+        }
+    }, []);
+}

package/dist/falconFrame.js

@@ -1,4 +1,4 @@
-import { parseStringQuery } from "./cpu/string/index.js";
+import { parseVQLS } from "./cpu/string/index.js";
 export function FF_VQL(app, processor, options = {}) {
     const path = options.path || "/VQL";
     const getContext = options.getUser || (() => ({}));
@@ -18,7 +18,7 @@ export function FF_VQL(app, processor, options = {}) {
     if (options.dev) {
         app.get(path + "-query", (req, res) => {
             try {
-                return res.json(parseStringQuery(req.query?.query || ""));
+                return res.json(parseVQLS(req.query?.query || ""));
             }
             catch (e) {
                 res.status(500);

package/dist/gw.d.ts

@@ -0,0 +1,3 @@
+import { GateWarden } from "@wxn0brp/gate-warden";
+import { ValidFn } from "./types/perm.js";
+export declare function createGwValidFn(gw: GateWarden): ValidFn;

package/dist/gw.js

@@ -0,0 +1,5 @@
+export function createGwValidFn(gw) {
+    return async (path, perm, user) => {
+        return gw.hasAccess(user.id, path, perm);
+    };
+}

package/dist/permissions/relation.d.ts

@@ -1,4 +1,4 @@
-import { GateWarden } from "@wxn0brp/gate-warden";
+import { ValidFn } from "../types/perm.js";
 import { RelationQuery } from "../types/vql.js";
 import { VQLConfig } from "../config.js";
-export declare function checkRelationPermission(config: VQLConfig, gw: GateWarden<any>, user: any, query: RelationQuery): Promise<boolean>;
+export declare function checkRelationPermission(config: VQLConfig, validFn: ValidFn, user: any, query: RelationQuery): Promise<boolean>;

package/dist/permissions/relation.js

@@ -1,11 +1,12 @@
 import { PermCRUD } from "../types/perm.js";
 import { extractPathsFromData, hashKey } from "./utils.js";
-export async function checkRelationPermission(config, gw, user, query) {
+export async function checkRelationPermission(config, validFn, user, query) {
     const { path, search, relations, select } = query.r;
     // Helper function to recursively check permissions with fallback mechanism
     const checkPermissionRecursively = async (entityId, fallbackLevels = []) => {
         // Check if the user has access to the current entity
-        const result = await gw.hasAccess(user.id, entityId, PermCRUD.READ);
+        // const result = await gw.hasAccess(user.id, entityId, PermCRUD.READ);
+        const result = await validFn(entityId, PermCRUD.READ, user);
         if (result.granted) {
             return true;
         }
@@ -42,7 +43,7 @@ export async function checkRelationPermission(config, gw, user, query) {
     if (relations) {
         for (const relationKey in relations) {
             const r = relations[relationKey];
-            if (!await checkRelationPermission(config, gw, user, { r })) {
+            if (!await checkRelationPermission(config, validFn, user, { r })) {
                 return false;
             }
         }

package/dist/permissions/request.d.ts

@@ -1,5 +1,4 @@
-import { GateWarden } from "@wxn0brp/gate-warden";
-import { PermCRUD } from "../types/perm.js";
+import { PermCRUD, ValidFn } from "../types/perm.js";
 import { VQLRequest } from "../types/vql.js";
 import { VQLConfig } from "../config.js";
 export declare function extractPaths(config: VQLConfig, query: VQLRequest): {
@@ -16,4 +15,4 @@ export declare function processFieldPath(pathObj: {
     path: string[];
     key: string;
 }): string[];
-export declare function checkRequestPermission(config: VQLConfig, gw: GateWarden<any>, user: any, query: VQLRequest): Promise<boolean>;
+export declare function checkRequestPermission(config: VQLConfig, validFn: ValidFn, user: any, query: VQLRequest): Promise<boolean>;

package/dist/permissions/request.js

@@ -34,7 +34,7 @@ export function extractPaths(config, query) {
             permPaths.paths.push({ filed: extractPathsFromData(qo.search), p: PermCRUD.READ });
             permPaths.paths.push({ filed: extractPathsFromData(qo.updater), p: PermCRUD.UPDATE });
             break;
-        case "checkCollection":
+        case "ensureCollection":
         case "getCollections":
         case "issetCollection":
         case "removeCollection":
@@ -79,14 +79,15 @@ export function processFieldPath(pathObj) {
     }
     return processedPath;
 }
-export async function checkRequestPermission(config, gw, user, query) {
+export async function checkRequestPermission(config, validFn, user, query) {
     if (!query)
         return false;
     const permPaths = extractPaths(config, query);
     // Helper function to recursively check permissions
     const checkPermissionRecursively = async (entityId, requiredPerm, fallbackLevels = []) => {
         // Check if the user has access to the current entity
-        const result = await gw.hasAccess(user.id, entityId, requiredPerm);
+        // const result = await gw.hasAccess(user.id, entityId, requiredPerm);
+        const result = await validFn(entityId, requiredPerm, user);
         if (result.granted) {
             return true;
         }

package/dist/processor.d.ts

@@ -1,13 +1,13 @@
 import { Relation, ValtheraCompatible } from "@wxn0brp/db-core";
-import { GateWarden } from "@wxn0brp/gate-warden";
-import { VQLConfig } from "./config.js";
+import { VQLConfig, VQLConfigInterface } from "./config.js";
 import { VQL, VQLError, VqlQueryRaw } from "./types/vql.js";
-export declare class VQLProcessor<GW = any> {
+import { ValidFn } from "./types/perm.js";
+export declare class VQLProcessor {
     dbInstances: Record<string, ValtheraCompatible>;
-    gw: GateWarden<GW>;
-    config: VQLConfig;
+    validFn: ValidFn;
     relation: Relation;
     preDefinedSheets: Map<string, VQL>;
-    constructor(dbInstances: Record<string, ValtheraCompatible>, gw?: GateWarden<GW>, config?: VQLConfig);
-    execute<T = any>(queryRaw: VqlQueryRaw<T>, user: any): Promise<T | VQLError>;
+    config: VQLConfig;
+    constructor(dbInstances: Record<string, ValtheraCompatible>, config?: VQLConfig | Partial<VQLConfigInterface>, validFn?: ValidFn);
+    execute<T = any>(queryRaw: VqlQueryRaw<T>, user?: any): Promise<T | VQLError>;
 }

package/dist/processor.js

@@ -2,23 +2,23 @@ import { Relation } from "@wxn0brp/db-core";
 import { VQLConfig } from "./config.js";
 import { executeRelation } from "./cpu/relation.js";
 import { executeQuery } from "./cpu/request.js";
-import { parseStringQuery } from "./cpu/string/index.js";
 import logger from "./logger.js";
 import { executeSheetAndReplaceVars } from "./sheet/index.js";
 import { validateRaw, validateVql } from "./valid.js";
+import { parseVQLS } from "./cpu/string/index.js";
 export class VQLProcessor {
     dbInstances;
-    gw;
-    config;
+    validFn;
     relation;
     preDefinedSheets = new Map();
-    constructor(dbInstances, gw = null, config = new VQLConfig()) {
+    config;
+    constructor(dbInstances, config = new VQLConfig(), validFn = async () => ({ granted: true, via: "" })) {
         this.dbInstances = dbInstances;
-        this.gw = gw;
-        this.config = config;
+        this.validFn = validFn;
         this.relation = new Relation(dbInstances);
+        this.config = config instanceof VQLConfig ? config : new VQLConfig(config);
     }
-    async execute(queryRaw, user) {
+    async execute(queryRaw, user = {}) {
         if (typeof queryRaw === "string" || "query" in queryRaw) {
             logger.info("Incoming string query");
             const q = typeof queryRaw === "string" ? queryRaw : queryRaw.query;
@@ -26,7 +26,7 @@ export class VQLProcessor {
             const ref = typeof queryRaw === "string" ? null : queryRaw.ref;
             logger.debug(q);
             try {
-                queryRaw = parseStringQuery(q);
+                queryRaw = parseVQLS(q);
                 logger.debug("transformed query: ", queryRaw);
             }
             catch (e) {
@@ -43,14 +43,14 @@ export class VQLProcessor {
             logger.info("Incoming object query");
             logger.debug("Raw query: ", queryRaw);
         }
-        const validateRawResult = validateRaw(this.config, queryRaw);
+        const validateRawResult = validateRaw(queryRaw);
         if (validateRawResult !== true) {
             logger.warn("Raw validation failed:", validateRawResult);
             return validateRawResult;
         }
         const query = executeSheetAndReplaceVars(queryRaw, this.preDefinedSheets, user);
         logger.debug("Executed sheet (expanded query):", query);
-        const validateVqlResult = validateVql(this.config, query);
+        const validateVqlResult = validateVql(query);
         if (validateVqlResult !== true) {
             logger.warn("VQL validation failed:", validateVqlResult);
             return validateVqlResult;

package/dist/types/perm.d.ts

@@ -5,3 +5,8 @@ export declare enum PermCRUD {
     DELETE = 8,
     COLLECTION = 16
 }
+export interface ValidFnResult {
+    granted: boolean;
+    via?: string;
+}
+export type ValidFn = (path: string, perm: number, user: any) => Promise<ValidFnResult>;

package/dist/types/vql.d.ts

@@ -13,7 +13,7 @@ export interface VQLQuery<T = any> {
     removeOne: VQLRemoveOne<T>;
     updateOneOrAdd: VQLUpdateOneOrAdd<T>;
     removeCollection: VQLCollectionOperation;
-    checkCollection: VQLCollectionOperation;
+    ensureCollection: VQLCollectionOperation;
     issetCollection: VQLCollectionOperation;
     getCollections: {};
 }
@@ -38,7 +38,7 @@ export type VQLQueryData<T = any> = {
 } | {
     removeCollection: VQLCollectionOperation;
 } | {
-    checkCollection: VQLCollectionOperation;
+    ensureCollection: VQLCollectionOperation;
 } | {
     issetCollection: VQLCollectionOperation;
 } | {

package/dist/valid.d.ts

@@ -1,6 +1,3 @@
-import Ajv from "ajv";
-import { VQLConfig } from "./config.js";
 import { VQL, VQLError, VQLR } from "./types/vql.js";
-export declare const ajv: Ajv;
-export declare function validateRaw(config: VQLConfig, query: VQLR): true | VQLError;
-export declare function validateVql(config: VQLConfig, query: VQL): true | VQLError;
+export declare function validateRaw(query: VQLR): true | VQLError;
+export declare function validateVql(query: VQL): true | VQLError;