@livequery/rest 2.0.7 → 2.0.17

package/build/RestTransporter.d.ts

@@ -1,35 +1,29 @@
-import { Transporter, QueryOption, QueryStream, Response } from '@livequery/types';
-import { Observable } from 'rxjs';
+import { Transporter, QueryOption, QueryStream, Response as ApiResponse, TransporterHook } from '@livequery/types';
 type MaybePromise<T> = T | Promise<T>;
-export type Request = {
+export type ApiRequest = {
     url: RequestInfo | URL | string;
     options?: RequestInit;
 };
 export type RestTransporterConfig = {
-    websocket_url: () => MaybePromise<string>;
     base_url: () => MaybePromise<string>;
-    headers?: () => Promise<{
-        [key: string]: string;
-    }>;
-    hooks?: (o: Observable<Request>) => Observable<Request>;
+    websocket_url?: () => MaybePromise<string>;
 };
 export declare class RestTransporter implements Transporter {
     #private;
     private config;
     private socket;
     constructor(config: RestTransporterConfig);
+    hook(hook: TransporterHook): RestTransporter;
     query<T extends {
         id: string;
-    }>(ref: string, options?: Partial<QueryOption<T>>): Observable<QueryStream<T> | {
+    }>(ref: string, options?: Partial<QueryOption<T>>): import("rxjs").Observable<QueryStream<T> | {
         error: any;
-    }> & {
-        reload: () => void;
-    };
+    }>;
     private call;
     get<T>(ref: string, query?: any): Promise<T>;
     add<T extends {} = {}>(ref: string, data: Partial<T>): Promise<any>;
     update<T extends {} = {}>(ref: string, data: Partial<T>, method?: 'PATCH' | 'PUT'): Promise<any>;
     remove<T>(ref: string): Promise<T>;
-    trigger<T extends {}>(ref: string, name: string, payload?: any, query?: any): Promise<Response<T>>;
+    trigger<T extends {}>(ref: string, name: string, payload?: any, query?: any): Promise<ApiResponse<T>>;
 }
 export {};

package/build/RestTransporter.js

@@ -1,6 +1,6 @@
-import { of, lastValueFrom } from 'rxjs';
+import { of, firstValueFrom } from 'rxjs';
 import { catchError, map, mergeMap } from 'rxjs/operators';
-import { merge, Subject, BehaviorSubject } from 'rxjs';
+import { merge, pipe } from 'rxjs';
 import { Socket } from './Socket.js';
 import qs from 'query-string';
 export class RestTransporter {
@@ -10,10 +10,38 @@ export class RestTransporter {
         this.config = config;
         config.websocket_url && (this.socket = new Socket(config.websocket_url));
     }
+    hook(hook) {
+        return {
+            ...this,
+            hook: (next_hook) => {
+                return this.hook(next => pipe(hook(() => next_hook(next))));
+            },
+            get: (ref, query = {}) => {
+                return this.call(ref, 'GET', null, query, hook);
+            },
+            add: (ref, data) => {
+                return this.call(ref, 'POST', data, {}, hook);
+            },
+            update: (ref, data, method = 'PATCH') => {
+                return this.call(ref, method, data, {}, hook);
+            },
+            remove: (ref) => {
+                return this.call(ref, 'DELETE', hook);
+            },
+            trigger: (ref, name, payload, query) => {
+                return this.call(`${ref}/~${name}`, 'POST', payload, query, hook);
+            },
+            query: (ref, options) => {
+                return this.#query(ref, options, hook);
+            }
+        };
+    }
     query(ref, options) {
-        const $on_reload = new Subject();
-        const http_request = merge(of(1), this.socket?.$reconnect || of(), $on_reload)
-            .pipe(mergeMap(() => this.call(ref, 'GET', undefined, options)), map(({ data, error }) => {
+        return this.#query(ref, options);
+    }
+    #query(ref, options, hook) {
+        const http_request = merge(of(1), this.socket?.$reconnect || of())
+            .pipe(mergeMap(() => this.call(ref, 'GET', undefined, options, hook)), map(({ data, error }) => {
             if (error)
                 throw error;
             data.subscription_token && this.socket?.subscribe(data.subscription_token);
@@ -37,22 +65,19 @@ export class RestTransporter {
             };
         }), catchError(error => of({ error })));
         const websocket_sync = (!this.socket || options[':after'] || options[':before'] || options[':around']) ? of() : (this.socket.listen(ref).pipe(map((change) => ({ data: { changes: [change] } }))));
-        return Object.assign(merge(http_request, websocket_sync), {
-            reload: () => $on_reload.next()
-        });
+        return merge(http_request, websocket_sync);
     }
-    #encode_query(query) {
-        if (!query || Object.keys(query || {}).length == 0)
-            return '';
-        const encoded_query = Object.keys(query).reduce((o, key) => ({
-            ...o,
-            [key]: typeof query[key] == 'object' ? JSON.stringify(query[key]) : query[key]
-        }), {});
-        return `?${qs.stringify(encoded_query)}`;
-    }
-    async call(url, method, payload, query = {}) {
+    async call(url, method, payload, query = {}, hook) {
+        function encode_query(query) {
+            if (!query || Object.keys(query || {}).length == 0)
+                return '';
+            const encoded_query = Object.keys(query).reduce((o, key) => ({
+                ...o,
+                [key]: typeof query[key] == 'object' ? JSON.stringify(query[key]) : query[key]
+            }), {});
+            return `?${qs.stringify(encoded_query)}`;
+        }
         const headers = {
-            ...await this.config.headers?.() || {},
             ...payload ? {
                 'Content-Type': 'application/json'
             } : {},
@@ -60,16 +85,21 @@ export class RestTransporter {
         };
         try {
             const request = {
-                url: `${this.config.base_url()}/${url}${this.#encode_query(query)}`,
+                url: `${this.config.base_url()}/${url}${encode_query(query)}`,
                 options: {
                     method,
                     headers: headers,
                     ...payload ? { body: JSON.stringify(payload) } : {},
                 }
             };
-            const mapped = this.config.hooks ? await lastValueFrom(this.config.hooks(new BehaviorSubject(request))) : request;
-            const response = await fetch(mapped.url, mapped.options);
-            const body = await response.json();
+            const next = () => pipe(mergeMap(async (mapped) => {
+                const response = await fetch(mapped.url, mapped.options).then(r => r.json());
+                return {
+                    ...response,
+                    __request: mapped
+                };
+            }));
+            const body = await firstValueFrom(of(request).pipe(hook ? hook(next) : next()));
             if (body.error)
                 throw body.error;
             return body;

package/build/hooks/AddHeadersHook.d.ts

@@ -0,0 +1,3 @@
+import { Observable } from "rxjs";
+import { ApiRequest } from "../RestTransporter";
+export declare const AddHeadersHook: (get_headers: any) => (next: any) => import("rxjs").UnaryFunction<Observable<ApiRequest>, unknown>;

package/build/hooks/AddHeadersHook.js

@@ -0,0 +1,16 @@
+import { pipe, mergeMap, firstValueFrom, Observable } from "rxjs";
+export const AddHeadersHook = (get_headers) => {
+    return next => pipe(mergeMap(async (r) => {
+        const headers = typeof get_headers == 'function' ? await firstValueFrom(get_headers()) : (get_headers instanceof Observable ? await firstValueFrom(get_headers) : get_headers);
+        return {
+            ...r,
+            options: {
+                ...r.options || {},
+                headers: {
+                    ...r.options?.headers || {},
+                    ...headers
+                }
+            }
+        };
+    }), next());
+};

package/build/hooks/Deduplicate.d.ts

@@ -0,0 +1,2 @@
+import { ApiRequest } from "../RestTransporter";
+export declare const Deduplicate: (ms?: number) => (next: any) => import("rxjs").UnaryFunction<import("rxjs").Observable<ApiRequest>, import("rxjs").Observable<any>>;

package/build/hooks/Deduplicate.js

@@ -0,0 +1,23 @@
+import { pipe, mergeMap, BehaviorSubject, tap, of, filter, first } from "rxjs";
+const requests = new Map();
+export const Deduplicate = (ms = 1000) => next => {
+    return pipe(mergeMap(async (r) => {
+        const url = r.url.toString();
+        const cached = requests.get(url);
+        if (cached) {
+            if (cached.time > Date.now() - ms) {
+                return cached.response.pipe(filter(Boolean), first());
+            }
+            else {
+                requests.delete(url);
+            }
+        }
+        requests.set(url, {
+            response: new BehaviorSubject(undefined),
+            time: Date.now()
+        });
+        return of(r).pipe(next(), tap(response => {
+            requests.get(url)?.response.next(response);
+        }));
+    }), mergeMap($ => $));
+};

package/build/index.d.ts

@@ -1,2 +1,4 @@
-export { RestTransporter } from './RestTransporter.js';
+export { Deduplicate } from './hooks/Deduplicate.js';
+export { RestTransporter, ApiRequest } from './RestTransporter.js';
 export { Socket } from './Socket.js';
+export { AddHeadersHook } from './hooks/AddHeadersHook.js';

package/build/index.js

@@ -1,2 +1,4 @@
+export { Deduplicate } from './hooks/Deduplicate.js';
 export { RestTransporter } from './RestTransporter.js';
 export { Socket } from './Socket.js';
+export { AddHeadersHook } from './hooks/AddHeadersHook.js';

package/build/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/index.ts","../src/resttransporter.ts","../src/socket.ts"],"version":"5.6.3"}
+{"root":["../src/index.ts","../src/resttransporter.ts","../src/socket.ts","../src/hooks/addheadershook.ts","../src/hooks/deduplicate.ts"],"version":"5.6.3"}

package/package.json

@@ -3,7 +3,7 @@
     "repository": {
         "url": "https://github.com/livequery/rest"
     },
-    "version": "2.0.7",
+    "version": "2.0.17",
     "type": "module",
     "description": "",
     "main": "build/index.js",
@@ -19,7 +19,7 @@
         "rxjs": "^7.8.1",
         "typescript": "5.6.3",
         "@types/uuid": "^8.3.0",
-        "@livequery/types": "2.0.7"
+        "@livequery/types": "2.0.15"
     },
     "peerDependencies": {},
     "scripts": {