getta 1.0.19 → 1.0.21

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "getta",
   "description": "An isomorphic rest client based on the Fetch API.",
-  "version": "1.0.19",
+  "version": "1.0.21",
   "author": "miami-man",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/getta",

package/src/helpers/buildEndpoint/index.ts

@@ -1,18 +1,12 @@
-import { omitBy } from 'lodash-es';
+import { isFunction, omitBy } from 'lodash-es';
 import queryString from 'query-string';
-import { type PlainObject } from '#types.ts';
+import { type SearchParams } from '#types.js';
 import { type BuildEndpointOptions } from './types.ts';
 
 export const buildEndpoint = (
   basePath: string,
   path: string,
-  {
-    optionalPathTemplateRegExp,
-    pathTemplateCallback,
-    pathTemplateData,
-    pathTemplateRegExp,
-    queryParams = {},
-  }: BuildEndpointOptions,
+  { optionalPathTemplateRegExp, pathTemplateCallback, pathTemplateData, pathTemplateRegExp }: BuildEndpointOptions,
 ) => {
   const pathJoiner = basePath.endsWith('/') || path.startsWith('/') ? '' : '/';
   let endpoint = `${basePath}${pathJoiner}${path}`;
@@ -27,7 +21,22 @@ export const buildEndpoint = (
     endpoint = endpoint.slice(0, Math.max(0, endpoint.length - 1));
   }
 
-  const sanitisedSearchParams = omitBy<PlainObject>(queryParams, entry => entry === undefined);
+  return endpoint;
+};
+
+export const appendSearchParams = (
+  endpoint: string,
+  searchParams: SearchParams,
+  extraSearchParam: Record<string, string> = {},
+) => {
+  const mergedSearchParams = {
+    ...(isFunction(searchParams) ? searchParams(endpoint, extraSearchParam) : searchParams),
+    ...extraSearchParam,
+  };
+
+  // We have seen instances where value can be undefined
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  const sanitisedSearchParams = omitBy<Record<string, string>>(mergedSearchParams, entry => entry === undefined);
 
   if (Object.keys(sanitisedSearchParams).length > 0) {
     const queryJoin = queryString.extract(endpoint) ? '&' : '?';

package/src/helpers/buildEndpoint/types.ts

@@ -1,4 +1,4 @@
-import { type PathTemplateCallback, type RequestOptions } from '../../types.ts';
+import { type PathTemplateCallback, type RequestOptions } from '#types.ts';
 
 export interface BuildEndpointOptions extends Omit<RequestOptions, 'headers'> {
   optionalPathTemplateRegExp: RegExp;

package/src/main.ts

@@ -4,7 +4,7 @@ import { castArray, merge } from 'lodash-es';
 import { Md5 } from 'ts-md5';
 import { type SetRequired } from 'type-fest';
 import * as consts from './constants.ts';
-import { buildEndpoint } from './helpers/buildEndpoint/index.ts';
+import { appendSearchParams, buildEndpoint } from './helpers/buildEndpoint/index.ts';
 import { defaultPathTemplateCallback } from './helpers/defaultPathTemplateCallback/index.ts';
 import { delay } from './helpers/delay/index.ts';
 import { getResponseGroup } from './helpers/getResponseGroup/index.ts';
@@ -25,6 +25,7 @@ import {
   type RequestOptions,
   type RequestQueue,
   type RequestTracker,
+  type SearchParams,
   type ShortcutProperties,
   type Shortcuts,
   type StreamReader,
@@ -44,7 +45,7 @@ export class Getta {
   private _pathTemplateCallback: PathTemplateCallback;
   private _pathTemplateRegExp: RegExp;
   private _performance: Performance;
-  private _queryParams: PlainObject;
+  private _queryParams: SearchParams;
   private _rateLimit: boolean;
   private _rateLimitCount = 0;
   private _rateLimitedRequestQueue: RequestQueue = [];
@@ -189,14 +190,14 @@ export class Getta {
     { headers = {}, pathTemplateData, queryParams = {}, ...rest }: Omit<RequestOptions, 'method'>,
     context?: Context,
   ) {
-    const endpoint = buildEndpoint(this._basePath, path, {
+    let endpoint = buildEndpoint(this._basePath, path, {
       optionalPathTemplateRegExp: this._optionalPathTemplateRegExp,
       pathTemplateCallback: this._pathTemplateCallback,
       pathTemplateData,
       pathTemplateRegExp: this._pathTemplateRegExp,
-      queryParams: { ...this._queryParams, ...queryParams },
     });
 
+    endpoint = appendSearchParams(endpoint, this._queryParams, queryParams);
     const requestHash = Md5.hashStr(endpoint);
     const cacheability = await this._cacheEntryHas(requestHash);
 
@@ -366,14 +367,15 @@ export class Getta {
     { headers = {}, pathTemplateData, queryParams = {} }: Omit<RequestOptions, 'method'>,
     context?: Context,
   ) {
-    const endpoint = buildEndpoint(this._basePath, path, {
+    let endpoint = buildEndpoint(this._basePath, path, {
       optionalPathTemplateRegExp: this._optionalPathTemplateRegExp,
       pathTemplateCallback: this._pathTemplateCallback,
       pathTemplateData,
       pathTemplateRegExp: this._pathTemplateRegExp,
-      queryParams: { ...this._queryParams, ...queryParams },
     });
 
+    endpoint = appendSearchParams(endpoint, this._queryParams, queryParams);
+
     const requestHash = Md5.hashStr(endpoint);
     const cacheability = await this._cacheEntryHas(requestHash);
 
@@ -484,14 +486,15 @@ export class Getta {
     { body, headers, method, pathTemplateData, queryParams, ...rest }: SetRequired<RequestOptions, 'method'>,
     context?: Context,
   ) {
-    const endpoint = buildEndpoint(this._basePath, path, {
+    let endpoint = buildEndpoint(this._basePath, path, {
       optionalPathTemplateRegExp: this._optionalPathTemplateRegExp,
       pathTemplateCallback: this._pathTemplateCallback,
       pathTemplateData,
       pathTemplateRegExp: this._pathTemplateRegExp,
-      queryParams: { ...this._queryParams, ...queryParams },
     });
 
+    endpoint = appendSearchParams(endpoint, this._queryParams, queryParams);
+
     return this._fetch(
       endpoint,
       {

package/src/types.ts

@@ -18,6 +18,10 @@ export type ShortcutProperties<T extends string | number> = Record<
   <Resource = PlainObject>(...args: any[]) => Promise<FetchResponse<Resource>>
 >;
 
+export type SearchParams =
+  | Record<string, string>
+  | ((endpoint: string, extraSearchParams?: Record<string, string>) => Record<string, string>);
+
 export interface ConstructorOptions {
   /**
    * The base path of the url for all requests made from
@@ -91,7 +95,7 @@ export interface ConstructorOptions {
   /**
    * Any query params to attach to every request.
    */
-  queryParams?: PlainObject;
+  queryParams?: SearchParams;
   /**
    * Whether to enable the rate limit feature.
    */
@@ -153,7 +157,7 @@ export interface RequestOptions {
   /**
    * Any query params to attach to the request.
    */
-  queryParams?: PlainObject;
+  queryParams?: Record<string, string>;
 }
 
 export type RequestQueue = [(value: FetchResponse) => void, string, FetchOptions, PlainObject][];