@wxn0brp/vql-client 0.0.12 → 0.1.0

package/README.md

@@ -5,21 +5,16 @@ Minimalistic, pluggable client for **VQL** query execution.
 Supports:
 
 - ✅ ESM (`import`)
-- ✅ CJS (`require`)
 - ✅ CDN / `<script>` (`VQLClient`)
 - ✅ Fully typed with TypeScript
 - ✅ Custom transport layers and lifecycle hooks
 
-## 📦 Installation
+## 🚀 Usage
 
-### NPM
-
-```bash
-npm install @wxn0brp/vql-client
-```
+### ESM
 
 ```ts
-import { fetchVQL, initVQLClient, resetVQLClient } from "@wxn0brp/vql-client";
+import { fetchVQL, VConfig } from "@wxn0brp/vql-client";
 
 const result = await fetchVQL("db1 user! s._id = xyz");
 ```
@@ -27,51 +22,43 @@ const result = await fetchVQL("db1 user! s._id = xyz");
 ### CDN
 
 ```html
-<script src="/dist/vql-client.min.js"></script>
+<script src="https://unpkg.com/@wxn0brp/vql-client/dist/min.js"></script>
 <script>
   VQLClient.fetchVQL("db1 user! s._id = xyz").then(console.log);
 </script>
 ```
 
-You can also serve `vql-client.min.js` from your own CDN or static server.
-
 ## 🧠 Usage
 
 ### `fetchVQL<T = any>(query: string | object): Promise<T>`
 
 Executes a VQL query and returns the result (unwrapped from `{ result }`, unless an error is present).
 
-### `initVQLClient(config: { transport?: fn, hooks?: {...} })`
+### `VConfig`
 
 Customize client behavior.
 
 #### Example – custom transport and hooks:
 
 ```ts
-initVQLClient({
-  transport: async (query) => {
-    return await fetch("/VQL", {
-      method: "POST",
-      headers: { "Content-Type": "application/json" },
-      body: JSON.stringify({ query })
-    }).then(res => res.json());
-  },
-  hooks: {
-    onStart: (q) => console.log("VQL start", q),
-    onEnd: (q, ms, r) => console.log("VQL end", ms + "ms", r),
-    onError: (q, e) => console.error("VQL error", e)
-  }
-});
+VConfig.transport = async (query) => {
+  return await fetch("/VQL", {
+    method: "POST",
+    headers: { "Content-Type": "application/json" },
+    body: JSON.stringify({ query })
+  }).then(res => res.json());
+}
+VConfig.hooks = {
+  onStart: (q) => console.log("VQL start", q),
+  onEnd: (q, ms, r) => console.log("VQL end", ms + "ms", r),
+  onError: (q, e) => console.error("VQL error", e)
+}
 ```
 
-### `resetVQLClient()`
-
-Reset transport and hooks to default.
-
 ## ✈️ Default Transport
 
 ```ts
-defaultFetchTransport(query): Promise<any>
+defTransport(query): Promise<any>
 ```
 
 Sends:
@@ -91,45 +78,15 @@ Returns:
 }
 ```
 
-Use `initVQLClient({ transport })` to override with WebSocket, RPC, etc.
-
 ## 📁 Output Files
 
 ```
 dist/
 ├── index.js               # ESM build (import)
 ├── index.d.ts             # TypeScript types
-├── vql-client.cjs         # CommonJS build (require)
 ├── vql-client.min.js      # Global (CDN, window.VQLClient)
 ```
 
-## 🧾 Typings in Browser
-
-You can manually copy `index.d.ts` to your local project or declare global types:
-
-```ts
-declare const VQLClient: {
-  fetchVQL<T = any>(query: string | object): Promise<T>;
-  initVQLClient(config: {
-    transport?: (query: string | object) => Promise<any>,
-    hooks?: {
-      onStart?: (query: string | object) => void,
-      onEnd?: (query: string | object, ms: number, result: any) => void,
-      onError?: (query: string | object, error: unknown) => void
-    }
-  }): void;
-  resetVQLClient(): void;
-  defaultFetchTransport(query: string | object): Promise<any>;
-};
-```
-
-## 🧪 Example
-
-```ts
-const result = await fetchVQL("api getUser! s._id = abc123");
-console.log(result.name);
-```
-
 ## 📜 License
 
-MIT © wxn0brP
+MIT wxn0brP

package/dist/index.d.ts

@@ -1,16 +1,16 @@
-import { VqlQueryRaw } from "./vql.js";
+import { VqlQueryRaw } from "./vql";
 export type VQLResult<T = any> = Promise<T>;
 export type VQLTransport = (query: VqlQueryRaw) => VQLResult;
-export type VQLHooks = {
+export interface VQLHooks {
     onStart?: (query: VqlQueryRaw, hookContext: any) => void;
     onEnd?: (query: VqlQueryRaw, durationMs: number, result: any, hookContext: any) => void;
     onError?: (query: VqlQueryRaw, error: unknown, result?: any, hookContext?: any) => void;
-};
-export declare function initVQLClient(config: {
+}
+export interface Config {
     transport?: VQLTransport;
     hooks?: VQLHooks;
-    defaultFetchUrl?: string;
-}): void;
+    url?: string;
+}
+export declare const VConfig: Config;
 export declare function fetchVQL<T = any>(query: VqlQueryRaw<T>, hookContext?: any): Promise<T>;
-export declare function resetVQLClient(): void;
-export declare function defaultFetchTransport(query: VqlQueryRaw): Promise<any>;
+export declare function defTransport(query: VqlQueryRaw): Promise<any>;

package/dist/index.js

@@ -1,15 +1,11 @@
-let transport = defaultFetchTransport;
-let hooks = {};
-let defaultFetchUrl = "/VQL";
-export function initVQLClient(config) {
-    if (config.transport)
-        transport = config.transport;
-    if (config.hooks)
-        hooks = config.hooks;
-    if (config.defaultFetchUrl)
-        defaultFetchUrl = config.defaultFetchUrl;
-}
+;
+export const VConfig = {
+    transport: defTransport,
+    hooks: {},
+    url: "/VQL"
+};
 export async function fetchVQL(query, hookContext = {}) {
+    const { transport, hooks } = VConfig;
     const start = Date.now();
     try {
         hooks.onStart?.(query, hookContext);
@@ -30,12 +26,8 @@ export async function fetchVQL(query, hookContext = {}) {
         throw e;
     }
 }
-export function resetVQLClient() {
-    transport = defaultFetchTransport;
-    hooks = {};
-}
-export async function defaultFetchTransport(query) {
-    const res = await fetch(defaultFetchUrl, {
+export async function defTransport(query) {
+    const res = await fetch(VConfig.url, {
         method: "POST",
         headers: {
             "Content-Type": "application/json"
@@ -49,8 +41,7 @@ export async function defaultFetchTransport(query) {
 if (typeof window !== "undefined") {
     window.VQLClient = {
         fetchVQL,
-        initVQLClient,
-        resetVQLClient,
-        defaultFetchTransport
+        defTransport,
+        cfg: VConfig
     };
 }

package/dist/min.js

@@ -0,0 +1 @@
+var VQLClient=(()=>{var s=Object.defineProperty;var V=Object.getOwnPropertyDescriptor;var Q=Object.getOwnPropertyNames;var L=Object.prototype.hasOwnProperty;var T=(n,r)=>{for(var a in r)s(n,a,{get:r[a],enumerable:!0})},R=(n,r,a,t)=>{if(r&&typeof r=="object"||typeof r=="function")for(let o of Q(r))!L.call(n,o)&&o!==a&&s(n,o,{get:()=>r[o],enumerable:!(t=V(r,o))||t.enumerable});return n};var q=n=>R(s({},"__esModule",{value:!0}),n);var m={};T(m,{VConfig:()=>i,defTransport:()=>u,fetchVQL:()=>c});var i={transport:u,hooks:{},url:"/VQL"};async function c(n,r={}){var y,w,f,l;let{transport:a,hooks:t}=i,o=Date.now();try{(y=t.onStart)==null||y.call(t,n,r);let e=await a(n),d=Date.now()-o;if((w=t.onEnd)==null||w.call(t,n,d,e,r),e!=null&&e.err){let p=new Error(e.err);throw(f=t.onError)==null||f.call(t,n,p,e,r),p}return e.result!==void 0?e.result:e}catch(e){throw(l=t.onError)==null||l.call(t,n,e,null,r),e}}async function u(n){let r=await fetch(i.url,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({query:n})});if(!r.ok)throw new Error(`VQL request failed: ${r.status}`);return await r.json()}typeof window!="undefined"&&(window.VQLClient={fetchVQL:c,defTransport:u,cfg:i});return q(m);})();

package/dist/vql.d.ts

@@ -80,23 +80,23 @@ export interface FindOpts<T = any> {
     exclude?: KeysMatching<T, any>[];
     transform?: Function;
 }
-declare class CollectionManager {
+declare class CollectionManager<D = Data> {
     private db;
     private collection;
     constructor(db: ValtheraCompatible, collection: string);
-    add<T = Data>(data: Arg, id_gen?: boolean): Promise<T>;
-    find<T = Data>(search: Search, context?: VContext, options?: DbFindOpts, findOpts?: FindOpts): Promise<T[]>;
-    findOne<T = Data>(search: Search, context?: VContext, findOpts?: FindOpts): Promise<T>;
-    update(search: Search, updater: Updater, context?: VContext): Promise<boolean>;
-    updateOne(search: Search, updater: Updater, context?: VContext): Promise<boolean>;
-    remove(search: Search, context?: VContext): Promise<boolean>;
-    removeOne(search: Search, context?: VContext): Promise<boolean>;
-    updateOneOrAdd(search: Search, updater: Updater, add_arg?: Arg, context?: VContext, id_gen?: boolean): Promise<boolean>;
+    add<T = Data>(data: Arg<T & D>, id_gen?: boolean): Promise<T>;
+    find<T = Data>(search?: Search<T & D>, context?: VContext, options?: DbFindOpts<T & Data>, findOpts?: FindOpts<T & Data>): Promise<T[]>;
+    findOne<T = Data>(search?: Search<T & Data>, context?: VContext, findOpts?: FindOpts<T & Data>): Promise<T>;
+    update<T = Data>(search: Search<T & Data>, updater: Updater<T & Data>, context?: VContext): Promise<boolean>;
+    updateOne<T = Data>(search: Search<T & Data>, updater: Updater<T & Data>, context?: VContext): Promise<boolean>;
+    remove<T = Data>(search: Search<T & Data>, context?: VContext): Promise<boolean>;
+    removeOne<T = Data>(search: Search<T & Data>, context?: VContext): Promise<boolean>;
+    updateOneOrAdd<T = Data>(search: Search<T & Data>, updater: Updater<T & Data>, add_arg?: Arg<T & Data>, context?: VContext, id_gen?: boolean): Promise<boolean>;
 }
 export interface ValtheraCompatible {
     c(collection: string): CollectionManager;
     getCollections(): Promise<string[]>;
-    checkCollection(collection: string): Promise<boolean>;
+    ensureCollection(collection: string): Promise<boolean>;
     issetCollection(collection: string): Promise<boolean>;
     add<T = Data>(collection: string, data: Arg<T>, id_gen?: boolean): Promise<T>;
     find<T = Data>(collection: string, search: Search<T>, context?: VContext, options?: DbFindOpts<T>, findOpts?: FindOpts<T>): Promise<T[]>;
@@ -148,7 +148,7 @@ export interface VQLQuery<T = any> {
     removeOne: VQLRemoveOne<T>;
     updateOneOrAdd: VQLUpdateOneOrAdd<T>;
     removeCollection: VQLCollectionOperation;
-    checkCollection: VQLCollectionOperation;
+    ensureCollection: VQLCollectionOperation;
     issetCollection: VQLCollectionOperation;
     getCollections: {};
 }
@@ -173,7 +173,7 @@ export type VQLQueryData<T = any> = {
 } | {
     removeCollection: VQLCollectionOperation;
 } | {
-    checkCollection: VQLCollectionOperation;
+    ensureCollection: VQLCollectionOperation;
 } | {
     issetCollection: VQLCollectionOperation;
 } | {

package/package.json

@@ -1,15 +1,20 @@
 {
   "name": "@wxn0brp/vql-client",
-  "version": "0.0.12",
+  "version": "0.1.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "description": "VQL Client",
+  "homepage": "https://github.com/wxn0brP/VQL-client",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wxn0brP/VQL-client.git"
+  },
   "author": "wxn0brP",
   "license": "MIT",
   "type": "module",
   "devDependencies": {
-    "esbuild": "^0.25.4",
-    "tsc-alias": "^1.8.10",
-    "typescript": "^5.7.3"
+    "esbuild": "^0.25.8",
+    "typescript": "^5.8.3"
   },
   "files": [
     "dist"
@@ -18,13 +23,11 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
       "default": "./dist/index.js"
     },
     "./*": {
       "types": "./dist/*.d.ts",
       "import": "./dist/*.js",
-      "require": "./dist/*.cjs",
       "default": "./dist/*.js"
     }
   }

package/dist/vql-client.cjs

@@ -1,78 +0,0 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  defaultFetchTransport: () => defaultFetchTransport,
-  fetchVQL: () => fetchVQL,
-  initVQLClient: () => initVQLClient,
-  resetVQLClient: () => resetVQLClient
-});
-module.exports = __toCommonJS(index_exports);
-var transport = defaultFetchTransport;
-var hooks = {};
-var defaultFetchUrl = "/VQL";
-function initVQLClient(config) {
-  if (config.transport) transport = config.transport;
-  if (config.hooks) hooks = config.hooks;
-  if (config.defaultFetchUrl) defaultFetchUrl = config.defaultFetchUrl;
-}
-async function fetchVQL(query, hookContext = {}) {
-  var _a, _b, _c, _d;
-  const start = Date.now();
-  try {
-    (_a = hooks.onStart) == null ? void 0 : _a.call(hooks, query, hookContext);
-    const res = await transport(query);
-    const duration = Date.now() - start;
-    (_b = hooks.onEnd) == null ? void 0 : _b.call(hooks, query, duration, res, hookContext);
-    if (res == null ? void 0 : res.err) {
-      const error = new Error(res.err);
-      (_c = hooks.onError) == null ? void 0 : _c.call(hooks, query, error, res, hookContext);
-      throw error;
-    }
-    if (res.result !== void 0) return res.result;
-    return res;
-  } catch (e) {
-    (_d = hooks.onError) == null ? void 0 : _d.call(hooks, query, e, null, hookContext);
-    throw e;
-  }
-}
-function resetVQLClient() {
-  transport = defaultFetchTransport;
-  hooks = {};
-}
-async function defaultFetchTransport(query) {
-  const res = await fetch(defaultFetchUrl, {
-    method: "POST",
-    headers: {
-      "Content-Type": "application/json"
-    },
-    body: JSON.stringify({ query })
-  });
-  if (!res.ok) throw new Error(`VQL request failed: ${res.status}`);
-  return await res.json();
-}
-if (typeof window !== "undefined") {
-  window.VQLClient = {
-    fetchVQL,
-    initVQLClient,
-    resetVQLClient,
-    defaultFetchTransport
-  };
-}

package/dist/vql-client.min.js

@@ -1 +0,0 @@
-var VQLClient=(()=>{var i=Object.defineProperty;var L=Object.getOwnPropertyDescriptor;var T=Object.getOwnPropertyNames;var h=Object.prototype.hasOwnProperty;var R=(r,t)=>{for(var a in t)i(r,a,{get:t[a],enumerable:!0})},q=(r,t,a,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of T(t))!h.call(r,o)&&o!==a&&i(r,o,{get:()=>t[o],enumerable:!(s=L(t,o))||s.enumerable});return r};var m=r=>q(i({},"__esModule",{value:!0}),r);var x={};R(x,{defaultFetchTransport:()=>u,fetchVQL:()=>V,initVQLClient:()=>Q,resetVQLClient:()=>f});var l=u,e={},w="/VQL";function Q(r){r.transport&&(l=r.transport),r.hooks&&(e=r.hooks),r.defaultFetchUrl&&(w=r.defaultFetchUrl)}async function V(r,t={}){var s,o,y,p;let a=Date.now();try{(s=e.onStart)==null||s.call(e,r,t);let n=await l(r),c=Date.now()-a;if((o=e.onEnd)==null||o.call(e,r,c,n,t),n!=null&&n.err){let d=new Error(n.err);throw(y=e.onError)==null||y.call(e,r,d,n,t),d}return n.result!==void 0?n.result:n}catch(n){throw(p=e.onError)==null||p.call(e,r,n,null,t),n}}function f(){l=u,e={}}async function u(r){let t=await fetch(w,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({query:r})});if(!t.ok)throw new Error(`VQL request failed: ${t.status}`);return await t.json()}typeof window!="undefined"&&(window.VQLClient={fetchVQL:V,initVQLClient:Q,resetVQLClient:f,defaultFetchTransport:u});return m(x);})();