@naturalcycles/js-lib 14.266.0 → 14.267.0

package/dist/http/fetcher.js

@@ -118,10 +118,21 @@ class Fetcher {
      * @experimental
      */
     async queryGraphQL(opt) {
-        opt.json = {
+        opt.method ||= this.cfg.init.method; // defaults to GET
+        const payload = (0, object_util_1._filterFalsyValues)({
             query: opt.query,
             variables: opt.variables,
-        };
+        });
+        // Checking the query length, and not allowing to use GET if above 1900
+        if (opt.method === 'GET' && opt.query.length < 1900) {
+            opt.searchParams = {
+                ...opt.searchParams,
+                ...payload,
+            };
+        }
+        else {
+            opt.json = payload;
+        }
         const res = await this.doFetch(opt);
         if (res.err) {
             throw res.err;
@@ -131,6 +142,7 @@ class Fetcher {
             const err = res.body.errors[0];
             // todo: consider creating a new GraphQLError class for this
             throw new error_util_1.HttpRequestError(err.message, {
+                ...payload, // query and variables
                 errors: res.body.errors, // full errors payload returned
                 response: res.fetchResponse,
                 responseStatusCode: res.statusCode,
@@ -141,7 +153,11 @@ class Fetcher {
                 requestDuration: Date.now() - res.req.started,
             });
         }
-        return res.body.data;
+        const { data } = res.body;
+        if (opt.unwrapObject) {
+            return data[opt.unwrapObject];
+        }
+        return data;
     }
     // responseType=readableStream
     /**

package/dist/http/fetcher.model.d.ts

@@ -119,6 +119,18 @@ export interface FetcherRequest extends Omit<FetcherOptions, 'method' | 'headers
 export interface FetcherGraphQLOptions extends FetcherOptions {
     query: string;
     variables?: AnyObject;
+    /**
+     * When querying singular entities, it may be convenient to specify 1st level object to unwrap.
+     * Example:
+     * {
+     *   homePage: { ... }
+     * }
+     *
+     * unwrapObject: 'homePage'
+     *
+     * would return the contents of `{ ... }`
+     */
+    unwrapObject?: string;
 }
 export interface FetcherOptions {
     method?: HttpMethod;

package/dist-esm/http/fetcher.js

@@ -6,7 +6,7 @@ import { isServerSide } from '../env';
 import { _assertErrorClassOrRethrow, _assertIsError } from '../error/assert';
 import { _anyToError, _anyToErrorObject, _errorDataAppend, _errorLikeToErrorObject, HttpRequestError, TimeoutError, UnexpectedPassError, } from '../error/error.util';
 import { _clamp } from '../number/number.util';
-import { _filterNullishValues, _filterUndefinedValues, _mapKeys, _merge, _omit, _pick, } from '../object/object.util';
+import { _filterFalsyValues, _filterNullishValues, _filterUndefinedValues, _mapKeys, _merge, _omit, _pick, } from '../object/object.util';
 import { pDelay } from '../promise/pDelay';
 import { pTimeout } from '../promise/pTimeout';
 import { _jsonParse, _jsonParseIfPossible } from '../string/json.util';
@@ -111,10 +111,21 @@ export class Fetcher {
      * @experimental
      */
     async queryGraphQL(opt) {
-        opt.json = {
+        opt.method || (opt.method = this.cfg.init.method); // defaults to GET
+        const payload = _filterFalsyValues({
             query: opt.query,
             variables: opt.variables,
-        };
+        });
+        // Checking the query length, and not allowing to use GET if above 1900
+        if (opt.method === 'GET' && opt.query.length < 1900) {
+            opt.searchParams = {
+                ...opt.searchParams,
+                ...payload,
+            };
+        }
+        else {
+            opt.json = payload;
+        }
         const res = await this.doFetch(opt);
         if (res.err) {
             throw res.err;
@@ -124,6 +135,7 @@ export class Fetcher {
             const err = res.body.errors[0];
             // todo: consider creating a new GraphQLError class for this
             throw new HttpRequestError(err.message, {
+                ...payload, // query and variables
                 errors: res.body.errors, // full errors payload returned
                 response: res.fetchResponse,
                 responseStatusCode: res.statusCode,
@@ -134,7 +146,11 @@ export class Fetcher {
                 requestDuration: Date.now() - res.req.started,
             });
         }
-        return res.body.data;
+        const { data } = res.body;
+        if (opt.unwrapObject) {
+            return data[opt.unwrapObject];
+        }
+        return data;
     }
     // responseType=readableStream
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.266.0",
+  "version": "14.267.0",
   "scripts": {
     "prepare": "husky",
     "build": "dev-lib build-esm-cjs",

package/src/http/fetcher.model.ts

@@ -155,6 +155,18 @@ export interface FetcherRequest
 export interface FetcherGraphQLOptions extends FetcherOptions {
   query: string
   variables?: AnyObject
+  /**
+   * When querying singular entities, it may be convenient to specify 1st level object to unwrap.
+   * Example:
+   * {
+   *   homePage: { ... }
+   * }
+   *
+   * unwrapObject: 'homePage'
+   *
+   * would return the contents of `{ ... }`
+   */
+  unwrapObject?: string
 }
 
 export interface FetcherOptions {

package/src/http/fetcher.ts

@@ -16,6 +16,7 @@ import {
 } from '../error/error.util'
 import { _clamp } from '../number/number.util'
 import {
+  _filterFalsyValues,
   _filterNullishValues,
   _filterUndefinedValues,
   _mapKeys,
@@ -28,7 +29,7 @@ import { pTimeout } from '../promise/pTimeout'
 import { _jsonParse, _jsonParseIfPossible } from '../string/json.util'
 import { _stringify } from '../string/stringify'
 import { _ms, _since } from '../time/time.util'
-import { ErrorDataTuple, NumberOfMilliseconds, UnixTimestampMillis } from '../types'
+import { AnyObject, ErrorDataTuple, NumberOfMilliseconds, UnixTimestampMillis } from '../types'
 import {
   FetcherAfterResponseHook,
   FetcherBeforeRequestHook,
@@ -185,9 +186,21 @@ export class Fetcher {
    * @experimental
    */
   async queryGraphQL<T = unknown>(opt: FetcherGraphQLOptions): Promise<T> {
-    opt.json = {
+    opt.method ||= this.cfg.init.method // defaults to GET
+
+    const payload: AnyObject = _filterFalsyValues({
       query: opt.query,
       variables: opt.variables,
+    })
+
+    // Checking the query length, and not allowing to use GET if above 1900
+    if (opt.method === 'GET' && opt.query.length < 1900) {
+      opt.searchParams = {
+        ...opt.searchParams,
+        ...payload,
+      }
+    } else {
+      opt.json = payload
     }
 
     const res = await this.doFetch<GraphQLResponse<T>>(opt)
@@ -201,6 +214,7 @@ export class Fetcher {
 
       // todo: consider creating a new GraphQLError class for this
       throw new HttpRequestError(err.message, {
+        ...payload, // query and variables
         errors: res.body.errors, // full errors payload returned
         response: res.fetchResponse,
         responseStatusCode: res.statusCode,
@@ -212,7 +226,12 @@ export class Fetcher {
       })
     }
 
-    return res.body.data
+    const { data } = res.body
+    if (opt.unwrapObject) {
+      return (data as any)[opt.unwrapObject]
+    }
+
+    return data
   }
 
   // responseType=readableStream