@wxn0brp/vql-client 0.2.5 → 0.2.7

package/dist/index.d.ts

@@ -23,3 +23,4 @@ export interface FetchOptions {
 export declare const VConfig: Config;
 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,7 +1,7 @@
 ;
 export const VConfig = {
     transport: defTransport,
-    fetchImplementation: fetch,
+    fetchImplementation: (input, init) => fetch(input, init),
     hooks: {},
     url: "/VQL"
 };
@@ -53,10 +53,17 @@ export async function defTransport(query, fetchOptions) {
         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 c=Object.defineProperty;var L=Object.getOwnPropertyDescriptor;var w=Object.getOwnPropertyNames;var h=Object.prototype.hasOwnProperty;var m=(n,t)=>{for(var e in t)c(n,e,{get:t[e],enumerable:!0})},b=(n,t,e,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of w(t))!h.call(n,a)&&a!==e&&c(n,a,{get:()=>t[a],enumerable:!(s=L(t,a))||s.enumerable});return n};var T=n=>b(c({},"__esModule",{value:!0}),n);var x={};m(x,{VConfig:()=>i,defTransport:()=>y,fetchVQL:()=>u});var i={transport:y,fetchImplementation:fetch,hooks:{},url:"/VQL"};async function u(n,t={},e={},s={}){var d,f,p,Q;let{transport:a,hooks:r}=i,g=Date.now();try{e=Object.assign({},i.hookContext,t,e),(d=r.onStart)==null||d.call(r,n,e),typeof n=="string"&&Object.keys(t).length&&(n={query:n,var:t});let o=await a(n,s),V=Date.now()-g;if((f=r.onEnd)==null||f.call(r,n,V,o,e),o!=null&&o.err){let l=new Error(o.err);throw(p=r.onError)==null||p.call(r,n,l,o,e),l}return o.result!==void 0?o.result:o}catch(o){throw(Q=r.onError)==null||Q.call(r,n,o,null,e),o}}async function y(n,t){let e=Object.assign({"Content-Type":"application/json"},i.headers,t.headers),s=Object.assign({},i.body,t.body,{query:n}),a={method:"POST",headers:e,body:JSON.stringify(s)};t.signal&&(a.signal=t.signal);let r=await i.fetchImplementation(i.url,a);if(!r.ok)throw new Error(`VQL request failed: ${r.status}`);return await r.json()}typeof window!="undefined"&&(window.VQLClient={fetchVQL:u,defTransport:y,cfg:i});return T(x);})();
+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

@@ -7,66 +7,74 @@ export interface VContext {
 export type KeysMatching<T, V, C = V> = {
     [K in keyof T]-?: T[K] extends C ? K : never;
 }[keyof T];
-export type PartialOfType<T, V, C = V> = Partial<Record<KeysMatching<T, V, C>, V>>;
-export type PartialPickMatching<T, V, C = V> = Partial<Pick<T, KeysMatching<T, V, C>>>;
+export type NestedValue<T, V, C = V> = {
+    [K in keyof T as T[K] extends C ? K : T[K] extends object ? K : never]?: T[K] extends C ? V : T[K] extends object ? NestedValue<T[K], V, C> : never;
+};
+export type DeepPartial<T> = {
+    [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
+};
 export type LogicalOperators<T = any> = {
     $and?: Array<SearchOptions<T>>;
     $or?: Array<SearchOptions<T>>;
     $not?: SearchOptions<T>;
 };
 export type ComparisonOperators<T = any> = {
-    $gt?: PartialOfType<T, number>;
-    $lt?: PartialOfType<T, number>;
-    $gte?: PartialOfType<T, number>;
-    $lte?: PartialOfType<T, number>;
-    $between?: PartialOfType<T, [
+    $gt?: NestedValue<T, number, number>;
+    $lt?: NestedValue<T, number, number>;
+    $gte?: NestedValue<T, number, number>;
+    $lte?: NestedValue<T, number, number>;
+    $between?: NestedValue<T, [
         number,
         number
     ], number>;
-    $in?: Partial<Record<keyof T, T[keyof T][]>>;
-    $nin?: Partial<Record<keyof T, T[keyof T][]>>;
-    $idGt?: PartialOfType<T, string | number>;
-    $idLt?: PartialOfType<T, string | number>;
-    $idGte?: PartialOfType<T, string | number>;
-    $idLte?: PartialOfType<T, string | number>;
+    $in?: DeepPartial<T> & {
+        [K in keyof T]?: T[K] extends any[] ? T[K] : T[K][];
+    };
+    $nin?: DeepPartial<T> & {
+        [K in keyof T]?: T[K] extends any[] ? T[K] : T[K][];
+    };
+    $idGt?: NestedValue<T, string | number, string | number>;
+    $idLt?: NestedValue<T, string | number, string | number>;
+    $idGte?: NestedValue<T, string | number, string | number>;
+    $idLte?: NestedValue<T, string | number, string | number>;
 };
 export type TypeAndExistenceOperators<T = any> = {
-    $exists?: PartialOfType<T, boolean, any>;
-    $type?: PartialOfType<T, string>;
+    $exists?: NestedValue<T, boolean>;
+    $type?: NestedValue<T, string>;
 };
 export type ArrayOperators<T = any> = {
-    $arrinc?: PartialPickMatching<T, any[]>;
-    $arrincall?: PartialPickMatching<T, any[]>;
-    $size?: PartialOfType<T, number>;
+    $arrinc?: DeepPartial<T>;
+    $arrincall?: DeepPartial<T>;
+    $size?: NestedValue<T, number>;
 };
 export type StringOperators<T = any> = {
-    $regex?: PartialOfType<T, RegExp | string, string>;
-    $startsWith?: PartialOfType<T, string>;
-    $endsWith?: PartialOfType<T, string>;
+    $regex?: NestedValue<T, RegExp | string, string>;
+    $startsWith?: NestedValue<T, string, string>;
+    $endsWith?: NestedValue<T, string, string>;
 };
 export type OtherOperators<T = any> = {
-    $subset?: Partial<Record<keyof T, T[keyof T]>>;
+    $subset?: DeepPartial<T>;
 };
 export type PredefinedSearchOperators<T = any> = LogicalOperators<T> & ComparisonOperators<T> & TypeAndExistenceOperators<T> & ArrayOperators<T> & StringOperators<T> & OtherOperators<T>;
-export type SearchOptions<T = any> = PredefinedSearchOperators<T> & Arg<T>;
+export type SearchOptions<T = any> = PredefinedSearchOperators<T> & DeepPartial<T> & Record<string, any>;
 export type ArrayUpdater<T = any> = {
-    $push?: PartialOfType<T, any>;
-    $pushset?: PartialOfType<T, any>;
-    $pull?: PartialOfType<T, any>;
-    $pullall?: PartialOfType<T, any>;
+    $push?: NestedValue<T, any>;
+    $pushset?: NestedValue<T, any>;
+    $pull?: NestedValue<T, any>;
+    $pullall?: NestedValue<T, any>;
 };
 export type ObjectUpdater<T = any> = {
-    $merge?: PartialOfType<T, any>;
-    $deepMerge?: PartialOfType<T, any>;
+    $merge?: NestedValue<T, any>;
+    $deepMerge?: NestedValue<T, any>;
 };
 export type ValueUpdater<T = any> = {
-    $inc?: PartialOfType<T, number>;
-    $dec?: PartialOfType<T, number>;
-    $unset?: PartialOfType<T, any>;
-    $rename?: PartialOfType<T, any>;
-    $set?: PartialOfType<T, any>;
+    $inc?: NestedValue<T, number>;
+    $dec?: NestedValue<T, number>;
+    $unset?: NestedValue<T, any>;
+    $rename?: NestedValue<T, any>;
+    $set?: NestedValue<T, any>;
 };
-export type UpdaterArg<T = any> = ArrayUpdater<T> & ObjectUpdater<T> & ValueUpdater<T> & Arg<T>;
+export type UpdaterArg<T = any> = ArrayUpdater<T> & ObjectUpdater<T> & ValueUpdater<T> & DeepPartial<T> & Record<string, any>;
 export type Arg<T = any> = {
     [K in keyof T]?: any;
 } & Record<string, any>;
@@ -76,7 +84,7 @@ export type Search<T = any> = SearchOptions<T> | SearchFunc<T>;
 export type Updater<T = any> = UpdaterArg<T> | UpdaterArg<T>[] | UpdaterFunc<T>;
 export interface DbFindOpts<T = any> {
     reverse?: boolean;
-    max?: number;
+    limit?: number;
     offset?: number;
     sortBy?: KeysMatching<T, any>;
     sortAsc?: boolean;
@@ -91,14 +99,14 @@ declare class CollectionManager<D = Data> {
     private collection;
     constructor(db: ValtheraCompatible, collection: string);
     add<T = Data>(data: Arg<T & D>, id_gen?: boolean): Promise<T>;
-    find<T = Data>(search?: Search<T & D>, options?: DbFindOpts<T & Data>, findOpts?: FindOpts<T & Data>, context?: VContext): Promise<T[]>;
-    findOne<T = Data>(search?: Search<T & Data>, findOpts?: FindOpts<T & Data>, context?: VContext): 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, context, id_gen }: UpdateOneOrAdd<T & Data>): Promise<boolean>;
-    toggleOne<T = Data>(search: Search<T & Data>, data?: Arg<T & Data>, context?: VContext): Promise<boolean>;
+    find<T = Data>(search?: Search<T & D>, options?: DbFindOpts<T & D>, findOpts?: FindOpts<T & D>, context?: VContext): Promise<T[]>;
+    findOne<T = Data>(search?: Search<T & D>, findOpts?: FindOpts<T & D>, context?: VContext): Promise<T>;
+    update<T = Data>(search: Search<T & D>, updater: Updater<T & D>, context?: VContext): Promise<boolean>;
+    updateOne<T = Data>(search: Search<T & D>, updater: Updater<T & D>, context?: VContext): Promise<boolean>;
+    remove<T = Data>(search: Search<T & D>, context?: VContext): Promise<boolean>;
+    removeOne<T = Data>(search: Search<T & D>, context?: VContext): Promise<boolean>;
+    updateOneOrAdd<T = Data>(search: Search<T & D>, updater: Updater<T & D>, { add_arg, context, id_gen }: UpdateOneOrAdd<T & D>): Promise<boolean>;
+    toggleOne<T = Data>(search: Search<T & D>, data?: Arg<T & D>, context?: VContext): Promise<boolean>;
 }
 export interface ValtheraCompatible {
     c(collection: string): CollectionManager;

package/package.json

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