@wxn0brp/vql 0.7.0 → 0.8.3

package/README.md

@@ -1,6 +1,6 @@
 # VQL (Valthera Query Language)
 
-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.
+VQL (Valthera Query Language) is a comprehensive framework for interacting with ValtheraDB. It combines a flexible query language, a powerful permission management system, and a suite of tools to build secure and efficient data-driven applications.
 
 [![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)
@@ -8,11 +8,16 @@ VQL is a query language and processing framework designed for managing and inter
 ![CI](https://img.shields.io/github/actions/workflow/status/wxn0brP/VQL/build.yml?branch=master)
 ![bundle size](https://img.shields.io/bundlephobia/minzip/@wxn0brp/vql)
 
-## Features
+## Key Features
 
-- **Query Execution**: Supports CRUD operations and advanced query capabilities.
-- **Permission Management**: Fine-grained access control using Gate Warden.
-- **Extensibility**: Easily extendable with pre-defined sheets and custom configurations.
+- **Dual Query Syntax**: Choose between VQLR (a JSON-based object query language for programmatic use) and VQLS (a human-readable string-based language for simpler queries and scripts).
+- **Multi-Database Support**: Process queries across multiple ValtheraDB instances seamlessly.
+- **Cross-Platform**: Run VQL in both Node.js and modern web browsers.
+- **Extensible by Design**: Customize and extend functionality with sheets and custom configurations.
+- **Advanced Relation Queries**: Natively handle complex relationships not just between collections, but also across entire databases.
+- **Permission System**: Built-in, granular access control powered by Gate Warden. It's disabled by default and can be enabled when needed to enforce complex security rules.
+- **Falcon Frame Integration**: Integrates with Falcon Frame for extended capabilities.
+- **Variable Support**: Use predefined or custom variables in your queries, allowing for more dynamic and reusable logic.
 
 ## Example Usage
 
@@ -62,6 +67,10 @@ f.age = 1
 })();
 ```
 
+## Development Tools
+
+For an enhanced development and debugging experience, you can use [VQL-dev](https://github.com/wxn0brP/VQL-dev), a dedicated tool for debugging VQL queries.
+
 ## Documentation
 
 - [Base/Map](./docs/lang/base.md)

package/dist/cpu/utils.d.ts

@@ -1,2 +1,2 @@
-import { VQLConfig } from "../config.js";
+import { VQLConfig } from "../helpers/config.js";
 export declare function parseSelect(config: VQLConfig, select: object | object[]): any[];

package/dist/{config.d.ts → helpers/config.d.ts}

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

package/dist/{config.js → helpers/config.js}

@@ -3,6 +3,7 @@ export class VQLConfig {
     strictSelect = false;
     strictACL = false;
     noCheckPermissions = true;
+    permissionDeniedIfNoUser = true;
     constructor(config) {
         if (config) {
             Object.assign(this, config);

package/dist/{falconFrame.d.ts → helpers/falconFrame.d.ts}

@@ -1,4 +1,4 @@
-import { type VQLProcessor } from "./processor.js";
+import { type VQLProcessor } from "../processor.js";
 import type { FalconFrame, FFRequest } from "@wxn0brp/falcon-frame";
 type ContextFn = (req: FFRequest) => Promise<any> | any;
 interface FF_VQL_Options {

package/dist/{falconFrame.js → helpers/falconFrame.js}

@@ -1,4 +1,4 @@
-import { parseVQLS } 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 || (() => ({}));

package/dist/{gw.d.ts → helpers/gw.d.ts}

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

package/dist/{merge.js → helpers/merge.js}

@@ -1,10 +1,10 @@
 export function deepMerge(target, source) {
-    if (typeof target !== 'object' || target === null) {
+    if (typeof target !== "object" || target === null) {
         target = {};
     }
     for (const key in source) {
         if (source.hasOwnProperty(key)) {
-            if (typeof source[key] === 'object' && source[key] !== null && !Array.isArray(source[key])) {
+            if (typeof source[key] === "object" && source[key] !== null && !Array.isArray(source[key])) {
                 if (!target[key]) {
                     target[key] = {};
                 }

package/dist/{sheet.d.ts → helpers/sheet.d.ts}

@@ -1,2 +1,2 @@
-import { VQL_Query } from "./types/vql.js";
+import { VQL_Query } from "../types/vql.js";
 export declare function replaceVars(query: VQL_Query, user: any): VQL_Query;

package/dist/{valid.d.ts → helpers/valid.d.ts}

@@ -1,3 +1,3 @@
-import { VQL_Query, VQLError } from "./types/vql.js";
+import { VQL_Query, VQLError } from "../types/vql.js";
 export declare function validateRaw(query: VQL_Query): true | VQLError;
 export declare function validateVql(query: VQL_Query): true | VQLError;

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import { VQLProcessor } from "./processor.js";
-import { VQLConfig } from "./config.js";
-import { createValtheraAdapter } from "./apiAbstract.js";
+import { VQLConfig } from "./helpers/config.js";
+import { createValtheraAdapter } from "./helpers/apiAbstract.js";
 import logger from "./logger.js";
 import { LogLevel } from "@wxn0brp/lucerna-log";
-import { FF_VQL } from "./falconFrame.js";
-import { createGwValidFn } from "./gw.js";
+import { FF_VQL } from "./helpers/falconFrame.js";
+import { createGwValidFn } from "./helpers/gw.js";
 export default VQLProcessor;
 export { VQLProcessor, createValtheraAdapter, VQLConfig, logger as VQLLogger, LogLevel as VQLLogLevel, FF_VQL, createGwValidFn };

package/dist/index.js

@@ -1,9 +1,9 @@
 import { VQLProcessor } from "./processor.js";
-import { VQLConfig } from "./config.js";
-import { createValtheraAdapter } from "./apiAbstract.js";
+import { VQLConfig } from "./helpers/config.js";
+import { createValtheraAdapter } from "./helpers/apiAbstract.js";
 import logger from "./logger.js";
 import { LogLevel } from "@wxn0brp/lucerna-log";
-import { FF_VQL } from "./falconFrame.js";
-import { createGwValidFn } from "./gw.js";
+import { FF_VQL } from "./helpers/falconFrame.js";
+import { createGwValidFn } from "./helpers/gw.js";
 export default VQLProcessor;
 export { VQLProcessor, createValtheraAdapter, VQLConfig, logger as VQLLogger, LogLevel as VQLLogLevel, FF_VQL, createGwValidFn };

package/dist/permissions/relation.d.ts

@@ -1,4 +1,4 @@
 import { PermValidFn } from "../types/perm.js";
 import { VQL_Query_Relation } from "../types/vql.js";
-import { VQLConfig } from "../config.js";
+import { VQLConfig } from "../helpers/config.js";
 export declare function checkRelationPermission(config: VQLConfig, permValidFn: PermValidFn, user: any, query: VQL_Query_Relation): Promise<boolean>;

package/dist/permissions/relation.js

@@ -1,6 +1,8 @@
 import { PermCRUD } from "../types/perm.js";
 import { extractPathsFromData, hashKey } from "./utils.js";
 export async function checkRelationPermission(config, permValidFn, user, query) {
+    if (!user && config.permissionDeniedIfNoUser)
+        return false;
     const { path, search, relations, select } = query.r;
     // Helper function to recursively check permissions with fallback mechanism
     const checkPermissionRecursively = async (entityId, originalPath, fallbackLevels = []) => {

package/dist/permissions/request.d.ts

@@ -1,4 +1,4 @@
-import { VQLConfig } from "../config.js";
+import { VQLConfig } from "../helpers/config.js";
 import { PermCRUD, PermValidFn } from "../types/perm.js";
 import { VQL_Query_CRUD } from "../types/vql.js";
 export declare function extractPaths(config: VQLConfig, query: VQL_Query_CRUD): Promise<{

package/dist/permissions/request.js

@@ -83,11 +83,12 @@ export function processFieldPath(pathObj) {
 export async function checkRequestPermission(config, permValidFn, user, query) {
     if (!query)
         return false;
+    if (!user && config.permissionDeniedIfNoUser)
+        return false;
     const permPaths = await extractPaths(config, query);
     // Helper function to recursively check permissions
     const checkPermissionRecursively = async (entityId, originalPath, requiredPerm, fallbackLevels = []) => {
         // Check if the user has access to the current entity
-        // const result = await gw.hasAccess(user.id, entityId, requiredPerm);
         const result = await permValidFn({
             field: entityId,
             path: originalPath,

package/dist/permissions/utils.d.ts

@@ -1,4 +1,4 @@
-import { VQLConfig } from "../config.js";
+import { VQLConfig } from "../helpers/config.js";
 export declare function getHash(json: string): Promise<string>;
 export declare function hashKey(config: VQLConfig, path: any): Promise<string>;
 export declare function extractPathsFromData(data: any, stack?: string[]): {

package/dist/processor.d.ts

@@ -1,5 +1,5 @@
 import { Relation, ValtheraCompatible } from "@wxn0brp/db-core";
-import { VQLConfig, VQLConfigInterface } from "./config.js";
+import { VQLConfig, VQLConfigInterface } from "./helpers/config.js";
 import { VQL_Query, VQLError, VQLUQ } from "./types/vql.js";
 import { PermValidFn } from "./types/perm.js";
 export declare class VQLProcessor {

package/dist/processor.js

@@ -1,10 +1,10 @@
 import { Relation } from "@wxn0brp/db-core";
-import { VQLConfig } from "./config.js";
+import { VQLConfig } from "./helpers/config.js";
 import { executeRelation } from "./cpu/relation.js";
 import { executeQuery } from "./cpu/request.js";
 import logger from "./logger.js";
-import { replaceVars } from "./sheet.js";
-import { validateRaw, validateVql } from "./valid.js";
+import { replaceVars } from "./helpers/sheet.js";
+import { validateRaw, validateVql } from "./helpers/valid.js";
 import { parseVQLS } from "./cpu/string/index.js";
 export class VQLProcessor {
     dbInstances;

package/dist/vql.d.ts

@@ -55,7 +55,7 @@ export type ArrayOperators<T = any> = {
 };
 /** String Operators */
 export type StringOperators<T = any> = {
-	$regex?: PartialOfType<T, RegExp, string>;
+	$regex?: PartialOfType<T, RegExp | string, string>;
 	$startsWith?: PartialOfType<T, string>;
 	$endsWith?: PartialOfType<T, string>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/vql",
-  "version": "0.7.0",
+  "version": "0.8.3",
   "main": "dist/index.js",
   "author": "wxn0brP",
   "license": "MIT",
@@ -14,10 +14,22 @@
   "files": [
     "dist"
   ],
+  "keywords": [
+    "vql",
+    "valthera",
+    "database",
+    "orm",
+    "api",
+    "crud",
+    "nosql",
+    "query",
+    "db",
+    "query-language"
+  ],
   "peerDependencies": {
-    "@wxn0brp/db-core": ">=0.2.2",
-    "@wxn0brp/falcon-frame": ">=0.1.0",
-    "@wxn0brp/gate-warden": ">=0.4.0"
+    "@wxn0brp/db-core": ">=0.2.5",
+    "@wxn0brp/falcon-frame": ">=0.5.1",
+    "@wxn0brp/gate-warden": ">=0.4.1"
   },
   "peerDependenciesMeta": {
     "@wxn0brp/falcon-frame": {
@@ -32,15 +44,16 @@
   },
   "devDependencies": {
     "@types/node": "*",
-    "@wxn0brp/db": "^0.40.0",
-    "@wxn0brp/falcon-frame": "0.1.0",
-    "@wxn0brp/gate-warden": "^0.4.0",
-    "esbuild": "^0.25.10",
+    "@wxn0brp/db": "^0.40.1",
+    "@wxn0brp/db-core": "^0.2.5",
+    "@wxn0brp/falcon-frame": "^0.5.1",
+    "@wxn0brp/gate-warden": "^0.4.1",
+    "esbuild": "^0.25.11",
     "tsc-alias": "*",
     "typescript": "*"
   },
   "dependencies": {
-    "@wxn0brp/lucerna-log": "^0.2.0"
+    "@wxn0brp/lucerna-log": "^0.2.1"
   },
   "exports": {
     ".": {
@@ -54,4 +67,4 @@
       "default": "./dist/*.js"
     }
   }
-}
+}