@wxn0brp/vql-client 0.2.4 → 0.2.6

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { VQLUQ } from "./vql";
 export type VQLResult<T = any> = Promise<T>;
-export type VQLTransport = (query: VQLUQ) => VQLResult;
+export type VQLTransport = (query: VQLUQ, fetchOptions?: FetchOptions) => VQLResult;
 export interface VQLHooks {
     onStart?: (query: VQLUQ, hookContext: any) => void;
     onEnd?: (query: VQLUQ, durationMs: number, result: any, hookContext: any) => void;
@@ -8,10 +8,19 @@ export interface VQLHooks {
 }
 export interface Config {
     transport?: VQLTransport;
+    fetchImplementation: typeof fetch;
     hooks?: VQLHooks;
     url?: string;
     body?: Record<string, any>;
+    headers?: Record<string, any>;
+    hookContext?: any;
+}
+export interface FetchOptions {
+    signal?: AbortSignal;
+    headers?: Record<string, any>;
+    body?: Record<string, any>;
 }
 export declare const VConfig: Config;
-export declare function fetchVQL<T = any>(query: VQLUQ<T>, vars?: any, hookContext?: any): Promise<T>;
-export declare function defTransport(query: VQLUQ): Promise<any>;
+export declare function fetchVQL<T = any>(query: VQLUQ<T>, vars?: any, hookContext?: any, fetchOptions?: FetchOptions): Promise<T>;
+export declare function defTransport(query: VQLUQ, fetchOptions?: FetchOptions): Promise<any>;
+export declare const V: <T = any>(strings: TemplateStringsArray, ...values: any[]) => Promise<T>;

package/dist/index.js

@@ -1,14 +1,15 @@
 ;
 export const VConfig = {
     transport: defTransport,
+    fetchImplementation: (input, init) => fetch(input, init),
     hooks: {},
     url: "/VQL"
 };
-export async function fetchVQL(query, vars = {}, hookContext = {}) {
+export async function fetchVQL(query, vars = {}, hookContext = {}, fetchOptions = {}) {
     const { transport, hooks } = VConfig;
     const start = Date.now();
     try {
-        hookContext = Object.assign({}, vars, hookContext);
+        hookContext = Object.assign({}, VConfig.hookContext, vars, hookContext);
         hooks.onStart?.(query, hookContext);
         if (typeof query === "string" && Object.keys(vars).length) {
             query = {
@@ -16,7 +17,7 @@ export async function fetchVQL(query, vars = {}, hookContext = {}) {
                 var: vars
             };
         }
-        const res = await transport(query);
+        const res = await transport(query, fetchOptions);
         const duration = Date.now() - start;
         hooks.onEnd?.(query, duration, res, hookContext);
         if (res?.err) {
@@ -33,22 +34,36 @@ export async function fetchVQL(query, vars = {}, hookContext = {}) {
         throw e;
     }
 }
-export async function defTransport(query) {
-    const res = await fetch(VConfig.url, {
-        method: "POST",
-        headers: {
-            "Content-Type": "application/json"
-        },
-        body: JSON.stringify({ query, ...(VConfig.body || {}) })
+export async function defTransport(query, fetchOptions) {
+    const headers = Object.assign({
+        "Content-Type": "application/json"
+    }, VConfig.headers, fetchOptions.headers);
+    const body = Object.assign({}, VConfig.body, fetchOptions.body, {
+        query
     });
+    const queryConfig = {
+        method: "POST",
+        headers,
+        body: JSON.stringify(body)
+    };
+    if (fetchOptions.signal)
+        queryConfig.signal = fetchOptions.signal;
+    const res = await VConfig.fetchImplementation(VConfig.url, queryConfig);
     if (!res.ok)
         throw new Error(`VQL request failed: ${res.status}`);
     return await res.json();
 }
+export const V = async (strings, ...values) => {
+    const query = strings
+        .map((str, i) => str.trim() + (values[i] !== undefined ? values[i] : ""))
+        .join(" ");
+    return fetchVQL(query);
+};
 if (typeof window !== "undefined") {
     window.VQLClient = {
         fetchVQL,
         defTransport,
+        VQL: V,
         cfg: VConfig
     };
 }

package/dist/min.js

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

package/dist/vql.d.ts

@@ -98,6 +98,7 @@ declare class CollectionManager<D = Data> {
     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, context, id_gen }: UpdateOneOrAdd<T & Data>): Promise<boolean>;
+    toggleOne<T = Data>(search: Search<T & Data>, data?: Arg<T & Data>, context?: VContext): Promise<boolean>;
 }
 export interface ValtheraCompatible {
     c(collection: string): CollectionManager;
@@ -113,6 +114,7 @@ export interface ValtheraCompatible {
     removeOne<T = Data>(collection: string, search: Search<T>, context?: VContext): Promise<boolean>;
     removeCollection(collection: string): Promise<boolean>;
     updateOneOrAdd<T = Data>(collection: string, search: Search<T>, updater: Updater<T>, opts?: UpdateOneOrAdd<T>): Promise<boolean>;
+    toggleOne<T = Data>(collection: string, search: Search<T>, data?: Arg<T>, context?: VContext): Promise<boolean>;
 }
 export interface UpdateOneOrAdd<T> {
     add_arg?: Arg<T>;
@@ -185,6 +187,11 @@ export interface VQL_OP_UpdateOneOrAdd<T = any> {
     add_arg?: Arg<T>;
     id_gen?: boolean;
 }
+export interface VQL_OP_ToggleOne<T = any> {
+    collection: string;
+    search: Search<T>;
+    data?: Arg<T>;
+}
 export interface VQL_OP_CollectionOperation {
     collection: string;
 }
@@ -207,6 +214,8 @@ export type VQL_Query_CRUD_Data<T = any> = {
     removeOne: VQL_OP_Remove<T>;
 } | {
     updateOneOrAdd: VQL_OP_UpdateOneOrAdd<T>;
+} | {
+    toggleOne: VQL_OP_ToggleOne<T>;
 } | {
     removeCollection: VQL_OP_CollectionOperation;
 } | {
@@ -216,6 +225,7 @@ export type VQL_Query_CRUD_Data<T = any> = {
 } | {
     getCollections: {};
 };
+export type VQL_Query_CRUD_Keys = VQL_Query_CRUD_Data extends infer U ? U extends Record<string, unknown> ? keyof U : never : never;
 export interface VQL_Query_CRUD<T = any> {
     db: string;
     d: VQL_Query_CRUD_Data<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/vql-client",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "description": "VQL Client",