@ethlete/query 2.2.0 → 2.4.0

package/fesm2020/ethlete-query.mjs

@@ -1,5 +1,5 @@
 import { BehaviorSubjectWithSubscriberCount, getCookie, setCookie, deleteCookie, DestroyService, equal, clone } from '@ethlete/core';
-import { Observable, filter, takeWhile, switchMap, of, BehaviorSubject, Subject, takeUntil, interval, startWith, tap, timer, fromEvent, concat, take, debounceTime, combineLatest, map, distinctUntilChanged } from 'rxjs';
+import { Observable, filter, takeWhile, switchMap, of, BehaviorSubject, Subject, takeUntil, interval, startWith, finalize, tap, timer, fromEvent, take, concat, debounceTime, combineLatest, map, distinctUntilChanged } from 'rxjs';
 import * as i0 from '@angular/core';
 import { Directive, Input, InjectionToken, inject, ChangeDetectorRef, ViewContainerRef, TemplateRef, ErrorHandler, ElementRef } from '@angular/core';
 import { FormGroup } from '@angular/forms';
@@ -32,29 +32,6 @@ class BasicAuthProvider {
     }
 }
 
-const getOpName = /(query|mutation) ?([\w\d-_]+)? ?\(.*?\)? \{/;
-const transformGql = (str) => {
-    str = Array.isArray(str) ? str.join('') : str;
-    const name = getOpName.exec(str);
-    return function (variables) {
-        const data = { query: str };
-        if (variables)
-            data['variables'] = JSON.stringify(variables);
-        if (name && name.length) {
-            const operationName = name[2];
-            if (operationName)
-                data['operationName'] = name[2];
-        }
-        return data;
-    };
-};
-const gql = (strings, ...values) => {
-    const str = strings.reduce((acc, cur, i) => {
-        return acc + cur + (values[i] || '');
-    }, '');
-    return str;
-};
-
 const buildErrorMessage = (code, message) => `[@ethlete\\query:${code}] ${message}`;
 class QueryError extends Error {
     constructor(code, message, data) {
@@ -100,9 +77,15 @@ const buildRoute = (options) => {
 const buildQueryString = (params) => {
     const validParams = filterInvalidParams(params);
     const queryString = Object.keys(validParams)
-        .map((key) => Array.isArray(validParams[key])
-        ? buildQueryArrayString(key, validParams[key])
-        : `${key}=${encodeURIComponent(validParams[key])}`)
+        .map((key) => {
+        if (Array.isArray(validParams[key])) {
+            return buildQueryArrayString(key, validParams[key]);
+        }
+        if (typeof validParams[key] === 'object' && validParams[key] !== null) {
+            return buildQueryString(validParams[key]);
+        }
+        return `${key}=${encodeURIComponent(validParams[key])}`;
+    })
         .join('&');
     return queryString || null;
 };
@@ -204,11 +187,14 @@ const serializeBody = (body) => {
     }
     return body.toString();
 };
-const transformMethod = (method) => {
-    if (method === 'GQL_QUERY' || method === 'GQL_MUTATE') {
-        return 'POST';
+const transformMethod = (config) => {
+    if (config.method === 'GQL_QUERY' || config.method === 'GQL_MUTATE') {
+        if (!config.transferVia) {
+            return 'POST';
+        }
+        return config.transferVia;
     }
-    return method;
+    return config.method;
 };
 const detectContentTypeHeader = (body) => {
     // An empty body has no content type.
@@ -489,11 +475,39 @@ const request = (config) => {
     });
 };
 
+const getOpName = /(query|mutation) ?([\w\d-_]+)? ?\(.*?\)? \{/;
+const transformGql = (str) => {
+    str = Array.isArray(str) ? str.join('') : str;
+    const name = getOpName.exec(str);
+    return function (variables) {
+        const data = { query: str };
+        if (variables)
+            data['variables'] = JSON.stringify(variables);
+        if (name && name.length) {
+            const operationName = name[2];
+            if (operationName)
+                data['operationName'] = name[2];
+        }
+        return data;
+    };
+};
+const gql = (strings, ...values) => {
+    const str = strings.reduce((acc, cur, i) => {
+        return acc + cur + (values[i] || '');
+    }, '');
+    return str;
+};
+
 function filterSuccess() {
     return function (source) {
         return source.pipe(filter((value) => isQueryStateSuccess(value)));
     };
 }
+function ignoreAutoRefresh() {
+    return function (source) {
+        return source.pipe(filter((value) => !isAutoRefresh(value)));
+    };
+}
 function filterFailure() {
     return function (source) {
         return source.pipe(filter((value) => isQueryStateFailure(value)));
@@ -534,6 +548,7 @@ const isQueryStateSuccess = (state) => state?.type === "SUCCESS" /* QueryStateTy
 const isQueryStateFailure = (state) => state?.type === "FAILURE" /* QueryStateType.Failure */;
 const isQueryStateCancelled = (state) => state?.type === "CANCELLED" /* QueryStateType.Cancelled */;
 const isQueryStatePrepared = (state) => state?.type === "PREPARED" /* QueryStateType.Prepared */;
+const isAutoRefresh = (state) => state?.meta.triggeredVia === 'auto';
 const mergeHeaders = (...headers) => {
     return headers.reduce((acc, headers) => {
         if (!headers) {
@@ -576,6 +591,73 @@ const getDefaultHeaders = (headers, method) => {
     }
     return headers;
 };
+const castQueryCreatorTypes = (config) => {
+    if (config.args?.pathParams) {
+        console.error(config);
+        throw new Error('Path params cannot be overridden in castQueryCreatorTypes. Create a new query creator instead.');
+    }
+    return config.creator;
+};
+const computeQueryMethod = (config) => {
+    let method;
+    if (isGqlQueryConfig(config.config)) {
+        method = transformMethod({ method: config.config.method, transferVia: config.config.transferVia });
+    }
+    else {
+        method = transformMethod({ method: config.config.method });
+    }
+    return method;
+};
+const computeQueryBody = (config) => {
+    let body;
+    if (config.method === 'GET' ||
+        config.method === 'HEAD' ||
+        config.method === 'OPTIONS' ||
+        (isGqlQueryConfig(config.config) && config.config.transferVia === 'GET')) {
+        return undefined;
+    }
+    if (isGqlQueryConfig(config.config)) {
+        const queryTemplate = config.config.query;
+        const query = transformGql(queryTemplate);
+        body = query(config.args?.variables);
+    }
+    else {
+        body = config.args?.body;
+    }
+    return body;
+};
+const computeQueryAuthHeader = (config) => {
+    let authHeader = null;
+    if (config.config.secure) {
+        const header = config.client.authProvider?.header;
+        if (header) {
+            authHeader = header;
+        }
+    }
+    else if (config.client.authProvider?.header) {
+        if (config.config.secure === undefined || config.config.secure) {
+            authHeader = config.client.authProvider.header;
+        }
+    }
+    return authHeader;
+};
+const computeQueryHeaders = (config) => {
+    const authHeader = computeQueryAuthHeader(config);
+    const mergedHeaders = mergeHeaders(getDefaultHeaders(config.client.config.request?.headers, config.config.method), authHeader, config.args?.headers) || undefined;
+    return mergedHeaders;
+};
+const computeQueryQueryParams = (config) => {
+    if (isGqlQueryConfig(config.config) && config.config.transferVia === 'GET') {
+        const queryTemplate = config.config.query;
+        const query = transformGql(queryTemplate);
+        let params = query(config.args?.variables);
+        if (config.args?.queryParams) {
+            params = { ...params, ...config.args?.queryParams };
+        }
+        return params;
+    }
+    return config.args?.queryParams;
+};
 
 class Query {
     get _nextId() {
@@ -656,33 +738,14 @@ class Query {
             meta,
         });
         this._updateUseResultInDependencies();
-        let body;
-        if (isGqlQueryConfig(this._queryConfig)) {
-            const queryTemplate = this._queryConfig.query;
-            const query = transformGql(queryTemplate);
-            body = query(this._args?.variables);
-        }
-        else {
-            body = this._args?.body;
-        }
-        let authHeader = null;
-        if (this._queryConfig.secure) {
-            const header = this._client.authProvider?.header;
-            if (header) {
-                authHeader = header;
-            }
-        }
-        else if (this._client.authProvider?.header) {
-            if (this._queryConfig.secure === undefined || this._queryConfig.secure) {
-                authHeader = this._client.authProvider.header;
-            }
-        }
-        const mergedHeaders = mergeHeaders(getDefaultHeaders(this._client.config.request?.headers, this._queryConfig.method), authHeader, this._args?.headers) || undefined;
+        const method = computeQueryMethod({ config: this._queryConfig });
+        const body = computeQueryBody({ config: this._queryConfig, args: this._args, method });
+        const headers = computeQueryHeaders({ client: this._client, config: this._queryConfig, args: this._args });
         request({
             urlWithParams: this._routeWithParams,
-            method: transformMethod(this._queryConfig.method),
+            method,
             body,
-            headers: mergedHeaders,
+            headers,
             reportProgress: this._queryConfig.reportProgress,
             responseType: this._queryConfig.responseType,
             withCredentials: this._queryConfig.withCredentials,
@@ -773,7 +836,7 @@ class Query {
             ? interval(config.interval).pipe(startWith(-1))
             : interval(config.interval);
         this._pollingSubscription = _interval
-            .pipe(takeUntil(config.takeUntil))
+            .pipe(takeUntil(config.takeUntil), finalize(() => this.stopPolling()))
             .subscribe(() => this.execute({ skipCache: true, _triggeredVia: 'poll' }));
         return this;
     }
@@ -1061,9 +1124,9 @@ class QueryDirective {
         }
     }
 }
-QueryDirective.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.1", ngImport: i0, type: QueryDirective, deps: [{ token: i0.TemplateRef }, { token: i0.ViewContainerRef }, { token: i0.ErrorHandler }, { token: i0.ChangeDetectorRef }], target: i0.ɵɵFactoryTarget.Directive });
-QueryDirective.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "15.2.1", type: QueryDirective, isStandalone: true, selector: "[query]", inputs: { query: "query", cache: ["queryCache", "cache"] }, ngImport: i0 });
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.1", ngImport: i0, type: QueryDirective, decorators: [{
+QueryDirective.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.2", ngImport: i0, type: QueryDirective, deps: [{ token: i0.TemplateRef }, { token: i0.ViewContainerRef }, { token: i0.ErrorHandler }, { token: i0.ChangeDetectorRef }], target: i0.ɵɵFactoryTarget.Directive });
+QueryDirective.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "15.2.2", type: QueryDirective, isStandalone: true, selector: "[query]", inputs: { query: "query", cache: ["queryCache", "cache"] }, ngImport: i0 });
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.2", ngImport: i0, type: QueryDirective, decorators: [{
             type: Directive,
             args: [{
                     // eslint-disable-next-line @angular-eslint/directive-selector
@@ -1155,6 +1218,9 @@ class InfinityQuery {
         this._data$.next([]);
         this.nextPage();
     }
+    /**
+     * @internal
+     */
     _clearSubscriptions() {
         this._subscriptions.forEach((sub) => sub.unsubscribe());
         this._subscriptions = [];
@@ -1285,7 +1351,7 @@ class InfinityQueryDirective {
         this._cleanup();
         this._infinityQuery = v;
         this._infinityQueryInstance = this._setupInfinityQuery(v);
-        this._loadNextPage();
+        this.loadNextPage();
     }
     get context() {
         return this._viewContext;
@@ -1358,12 +1424,25 @@ class InfinityQueryDirective {
             .subscribe();
         return instance;
     }
+    /**
+     * @deprecated Use `loadNextPage` instead
+     * @breaking 3.0.0
+     */
     _loadNextPage() {
+        this.loadNextPage();
+    }
+    loadNextPage() {
         if (!this._infinityQueryInstance) {
             return;
         }
         this._infinityQueryInstance.nextPage();
     }
+    reset(newConfig) {
+        if (!this._infinityQueryInstance) {
+            return;
+        }
+        this._infinityQueryInstance.reset(newConfig);
+    }
     _renderMainView() {
         if (!this._isMainViewCreated) {
             this._isMainViewCreated = true;
@@ -1385,9 +1464,9 @@ class InfinityQueryDirective {
         this._data$.next([]);
     }
 }
-InfinityQueryDirective.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.1", ngImport: i0, type: InfinityQueryDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive });
-InfinityQueryDirective.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "15.2.1", type: InfinityQueryDirective, isStandalone: true, selector: "[infinityQuery]", inputs: { infinityQuery: "infinityQuery" }, providers: [{ provide: INFINITY_QUERY_TOKEN, useExisting: InfinityQueryDirective }, DestroyService], exportAs: ["infinityQuery"], ngImport: i0 });
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.1", ngImport: i0, type: InfinityQueryDirective, decorators: [{
+InfinityQueryDirective.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.2", ngImport: i0, type: InfinityQueryDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive });
+InfinityQueryDirective.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "15.2.2", type: InfinityQueryDirective, isStandalone: true, selector: "[infinityQuery]", inputs: { infinityQuery: "infinityQuery" }, providers: [{ provide: INFINITY_QUERY_TOKEN, useExisting: InfinityQueryDirective }, DestroyService], exportAs: ["infinityQuery"], ngImport: i0 });
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.2", ngImport: i0, type: InfinityQueryDirective, decorators: [{
             type: Directive,
             args: [{
                     // eslint-disable-next-line @angular-eslint/directive-selector
@@ -1412,7 +1491,7 @@ class InfinityQueryTriggerDirective {
     ngOnInit() {
         const isInteractive = this._elementRef.nativeElement.hasAttribute('infinityQueryTrigger');
         if (isInteractive) {
-            this.click$.pipe(takeUntil(this._destroy)).subscribe(() => this._infinityQuery._loadNextPage());
+            this.click$.pipe(takeUntil(this._destroy)).subscribe(() => this._infinityQuery.loadNextPage());
         }
         else {
             this._setupIntersectionObserver();
@@ -1427,7 +1506,7 @@ class InfinityQueryTriggerDirective {
         this._observer = new IntersectionObserver((entries) => {
             const entry = entries[0];
             if (entry.isIntersecting && !this._infinityQuery.context.loading) {
-                this._infinityQuery._loadNextPage();
+                this._infinityQuery.loadNextPage();
             }
         }, {
             root: this.scrollContainerSelector ? document.querySelector(this.scrollContainerSelector) : null,
@@ -1437,9 +1516,9 @@ class InfinityQueryTriggerDirective {
         this._observer.observe(this._elementRef.nativeElement);
     }
 }
-InfinityQueryTriggerDirective.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.1", ngImport: i0, type: InfinityQueryTriggerDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive });
-InfinityQueryTriggerDirective.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "15.2.1", type: InfinityQueryTriggerDirective, isStandalone: true, selector: "[infinityQueryTrigger], infinity-query-trigger", inputs: { scrollContainerSelector: "scrollContainerSelector" }, ngImport: i0 });
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.1", ngImport: i0, type: InfinityQueryTriggerDirective, decorators: [{
+InfinityQueryTriggerDirective.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.2", ngImport: i0, type: InfinityQueryTriggerDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive });
+InfinityQueryTriggerDirective.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "15.2.2", type: InfinityQueryTriggerDirective, isStandalone: true, selector: "[infinityQueryTrigger], infinity-query-trigger", inputs: { scrollContainerSelector: "scrollContainerSelector" }, ngImport: i0 });
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.2", ngImport: i0, type: InfinityQueryTriggerDirective, decorators: [{
             type: Directive,
             args: [{
                     // eslint-disable-next-line @angular-eslint/directive-selector
@@ -1455,6 +1534,8 @@ class QueryStore {
         this._config = _config;
         this._store = new Map();
         this._garbageCollector = null;
+        this._isInLowResourceMode = false;
+        this._lastBlurTimestamp = Date.now();
         this._initSmartQueryHandling();
     }
     add(id, query) {
@@ -1491,27 +1572,39 @@ class QueryStore {
         const windowBlur$ = fromEvent(window, 'blur');
         const windowFocus$ = fromEvent(window, 'focus');
         windowBlur$.subscribe(() => {
-            this._stopGarbageCollector();
-            if (this._config?.enableSmartPolling) {
-                this.forEach((query) => {
-                    if (!query.isPolling || !query._enableSmartPolling) {
-                        return;
-                    }
-                    query.pausePolling();
-                });
-            }
+            timer(5000)
+                .pipe(takeUntil(windowFocus$), take(1))
+                .subscribe(() => {
+                this._lastBlurTimestamp = Date.now();
+                this._isInLowResourceMode = true;
+                this._stopGarbageCollector();
+                if (this._config?.enableSmartPolling) {
+                    this.forEach((query) => {
+                        if (!query.isPolling || !query._enableSmartPolling) {
+                            return;
+                        }
+                        query.pausePolling();
+                    });
+                }
+            });
         });
         windowFocus$.subscribe(() => {
+            if (!this._isInLowResourceMode) {
+                return;
+            }
+            this._isInLowResourceMode = false;
             if (this._config?.enableSmartPolling || this._config?.autoRefreshQueriesOnWindowFocus) {
                 this.forEach((query) => {
                     if (this._config?.enableSmartPolling && query._isPollingPaused) {
                         query.resumePolling();
                     }
-                    if (this._config?.autoRefreshQueriesOnWindowFocus &&
-                        query.isExpired &&
-                        query.isInUse &&
-                        query.autoRefreshOnConfig.windowFocus) {
-                        query.execute({ skipCache: true, _triggeredVia: 'auto' });
+                    if (Date.now() - this._lastBlurTimestamp > 15000) {
+                        if (this._config?.autoRefreshQueriesOnWindowFocus &&
+                            query.isExpired &&
+                            query.isInUse &&
+                            query.autoRefreshOnConfig.windowFocus) {
+                            query.execute({ skipCache: true, _triggeredVia: 'auto' });
+                        }
                     }
                 });
             }
@@ -1542,6 +1635,7 @@ class QueryStore {
         if (this._garbageCollector !== null) {
             window.clearInterval(this._garbageCollector);
             this._garbageCollector = null;
+            this._logGarbageCollector('Stop');
         }
     }
     _runGarbageCollector() {
@@ -1554,7 +1648,6 @@ class QueryStore {
         this._logGarbageCollector('Collection done');
         if (!this._store.size) {
             this._stopGarbageCollector();
-            this._logGarbageCollector('Stop');
         }
     }
     _logGarbageCollector(action) {
@@ -1627,7 +1720,7 @@ class QueryClient {
                     base: this._clientConfig.baseRoute,
                     route: queryConfig.route,
                     pathParams: args?.pathParams,
-                    queryParams: args?.queryParams,
+                    queryParams: computeQueryQueryParams({ config: queryConfig, args }),
                 });
                 const cacheKey = isGqlQueryConfig(queryConfig) ? buildGqlCacheKey(queryConfig, args) : route;
                 if (shouldCacheQuery(queryConfig.method)) {
@@ -1926,5 +2019,5 @@ const def = () => null;
  * Generated bundle index. Do not edit.
  */
 
-export { BasicAuthProvider, BearerAuthProvider, CustomHeaderAuthProvider, INFINITY_QUERY_TOKEN, InfinityQuery, InfinityQueryDirective, InfinityQueryTriggerDirective, Query, QueryClient, QueryDirective, QueryError, QueryField, QueryForm, QueryStore, buildErrorMessage, buildGqlCacheKey, buildQueryArrayString, buildQueryString, buildRoute, buildTimestampFromSeconds, createInfinityQueryConfig, createQueryCollection, decryptBearer, deepFreeze, def, detectContentTypeHeader, extractExpiresInSeconds, extractQuery, filterFailure, filterInvalidParams, filterNull, filterQueryStates, filterSuccess, forEachHeader, getDefaultHeaders, getResponseUrl, gql, hasHeader, invalidBaseRouteError, invalidBodyError, invalidRouteError, isBasicAuthProvider, isBearerAuthProvider, isCustomHeaderAuthProvider, isFetchResponse, isGqlQueryConfig, isParamValid, isQuery, isQueryStateCancelled, isQueryStateFailure, isQueryStateLoading, isQueryStatePrepared, isQueryStateSuccess, isRequestError, mergeHeaders, parseAllXhrResponseHeaders, pathParamsMissingInRouteFunctionError, queryStateAlreadyHasKeyError, queryStateCannotTransformError, queryStateDoesNotContainKeyError, request, serializeBody, shouldCacheQuery, shouldRetryRequest, skipPaginationPageParamCalculator, switchQueryCollectionState, switchQueryState, takeUntilResponse, transformGql, transformMethod, transformToBoolean, transformToBooleanArray, transformToDate, transformToDateArray, transformToNumber, transformToNumberArray, transformToSort, transformToSortQueryParam, transformToString, transformToStringArray };
+export { BasicAuthProvider, BearerAuthProvider, CustomHeaderAuthProvider, INFINITY_QUERY_TOKEN, InfinityQuery, InfinityQueryDirective, InfinityQueryTriggerDirective, Query, QueryClient, QueryDirective, QueryError, QueryField, QueryForm, QueryStore, buildErrorMessage, buildGqlCacheKey, buildQueryArrayString, buildQueryString, buildRoute, buildTimestampFromSeconds, castQueryCreatorTypes, computeQueryAuthHeader, computeQueryBody, computeQueryHeaders, computeQueryMethod, computeQueryQueryParams, createInfinityQueryConfig, createQueryCollection, decryptBearer, deepFreeze, def, detectContentTypeHeader, extractExpiresInSeconds, extractQuery, filterFailure, filterInvalidParams, filterNull, filterQueryStates, filterSuccess, forEachHeader, getDefaultHeaders, getResponseUrl, gql, hasHeader, ignoreAutoRefresh, invalidBaseRouteError, invalidBodyError, invalidRouteError, isAutoRefresh, isBasicAuthProvider, isBearerAuthProvider, isCustomHeaderAuthProvider, isFetchResponse, isGqlQueryConfig, isParamValid, isQuery, isQueryStateCancelled, isQueryStateFailure, isQueryStateLoading, isQueryStatePrepared, isQueryStateSuccess, isRequestError, mergeHeaders, parseAllXhrResponseHeaders, pathParamsMissingInRouteFunctionError, queryStateAlreadyHasKeyError, queryStateCannotTransformError, queryStateDoesNotContainKeyError, request, serializeBody, shouldCacheQuery, shouldRetryRequest, skipPaginationPageParamCalculator, switchQueryCollectionState, switchQueryState, takeUntilResponse, transformGql, transformMethod, transformToBoolean, transformToBooleanArray, transformToDate, transformToDateArray, transformToNumber, transformToNumberArray, transformToSort, transformToSortQueryParam, transformToString, transformToStringArray };
 //# sourceMappingURL=ethlete-query.mjs.map