@commercelayer/sdk 4.41.0 → 4.42.0

package/lib/esm/client.js

@@ -10,50 +10,22 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ApiClient_accessToken, _ApiClient_client;
-/* eslint-disable @typescript-eslint/no-explicit-any */
 import axios from 'axios';
-import { SdkError, ApiError, ErrorType } from './error';
+import { SdkError, handleError } from './error';
 import config from './config';
+// import type { Agent as HttpAgent } from 'http'
+// import type { Agent as HttpsAgent } from 'https'
+// import { packageInfo } from './util'
 import Debug from './debug';
 const debug = Debug('client');
 const baseURL = (organization, domain) => {
     return `https://${organization.toLowerCase()}.${domain || config.default.domain}/api`;
 };
-const handleError = (error) => {
-    let sdkError = new SdkError({ message: error.message });
-    if (axios.isAxiosError(error)) {
-        if (error.response) {
-            // The request was made and the server responded with a status code that falls out of the range of 2xx
-            const apiError = new ApiError(sdkError);
-            apiError.type = ErrorType.RESPONSE;
-            apiError.status = error.response.status;
-            apiError.code = String(apiError.status);
-            apiError.errors = error.response.data.errors;
-            sdkError = apiError;
-        }
-        else if (error.request) {
-            // The request was made but no response was received
-            // `error.request` is an instance of XMLHttpRequest in the browser and an instance of http.ClientRequest in node.js
-            sdkError.type = ErrorType.REQUEST;
-            sdkError.request = error.request;
-        }
-        else {
-            // Something happened in setting up the request that triggered an Error
-            sdkError.type = ErrorType.CLIENT;
-        }
-    }
-    else if (axios.isCancel(error))
-        sdkError.type = ErrorType.CANCEL;
-    else
-        sdkError.source = error;
-    throw sdkError;
-};
 class ApiClient {
     static create(options) {
-        if (!(options === null || options === void 0 ? void 0 : options.organization))
-            throw new Error("Undefined 'organization' parameter");
-        if (!(options === null || options === void 0 ? void 0 : options.accessToken))
-            throw new Error("Undefined 'accessToken' parameter");
+        for (const attr of config.client.requiredAttributes)
+            if (!options || !options[attr])
+                throw new SdkError({ message: `Undefined '${attr}' parameter` });
         return new ApiClient(options);
     }
     constructor(options) {
@@ -66,13 +38,32 @@ class ApiClient {
             timeout: options.timeout || config.client.timeout,
             proxy: options.proxy,
             httpAgent: options.httpAgent,
-            httpsAgent: options.httpsAgent,
+            httpsAgent: options.httpsAgent
+        };
+        // Set custom headers
+        const customHeaders = this.customHeaders(options.headers);
+        // Set headers
+        const headers = {
+            ...customHeaders,
+            'Accept': 'application/vnd.api+json',
+            'Content-Type': 'application/vnd.api+json',
+            'Authorization': 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f")
         };
-        const axiosOptions = Object.assign({ baseURL: this.baseUrl, timeout: config.client.timeout, headers: {
-                'Accept': 'application/vnd.api+json',
-                'Content-Type': 'application/vnd.api+json',
-                'Authorization': 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f"),
-            } }, axiosConfig);
+        // Set User-Agent
+        let userAgent = options.userAgent; // || `SDK-core axios/${axios.VERSION}`
+        if (userAgent) {
+            if (!userAgent.includes('axios/'))
+                userAgent += ` axios/${axios.VERSION}`;
+            headers['User-Agent'] = userAgent;
+        }
+        const axiosOptions = {
+            baseURL: this.baseUrl,
+            timeout: config.client.timeout,
+            headers,
+            ...axiosConfig
+        };
+        if (options.adapter)
+            axiosOptions.adapter = options.adapter;
         debug('axios options: %O', axiosOptions);
         __classPrivateFieldSet(this, _ApiClient_client, axios.create(axiosOptions), "f");
         this.interceptors = __classPrivateFieldGet(this, _ApiClient_client, "f").interceptors;
@@ -89,6 +80,10 @@ class ApiClient {
             def.httpAgent = config.httpAgent;
         if (config.httpsAgent)
             def.httpsAgent = config.httpsAgent;
+        if (config.adapter)
+            this.adapter(config.adapter);
+        if (config.userAgent)
+            this.userAgent(config.userAgent);
         // API Client config
         if (config.organization)
             this.baseUrl = baseURL(config.organization, config.domain);
@@ -96,23 +91,59 @@ class ApiClient {
             __classPrivateFieldSet(this, _ApiClient_accessToken, config.accessToken, "f");
             def.headers.common.Authorization = 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f");
         }
+        if (config.headers)
+            def.headers.common = this.customHeaders(config.headers);
+        return this;
+    }
+    userAgent(userAgent) {
+        if (userAgent) {
+            let ua = userAgent;
+            if (!ua.includes('axios/')) {
+                // const axiosVer = packageInfo(['dependencies.axios'], { nestedName: true })
+                if (axios.VERSION)
+                    ua += ` axios/${axios.VERSION}`;
+            }
+            __classPrivateFieldGet(this, _ApiClient_client, "f").defaults.headers['User-Agent'] = ua;
+        }
+        return this;
+    }
+    adapter(adapter) {
+        if (adapter)
+            __classPrivateFieldGet(this, _ApiClient_client, "f").defaults.adapter = adapter;
+        return this;
     }
     async request(method, path, body, options) {
         debug('request %s %s, %O, %O', method, path, body || {}, options || {});
+        // Ignored params alerts (in debug mode)
+        if (options === null || options === void 0 ? void 0 : options.adapter)
+            debug('Adapter ignored in request config');
+        if (options === null || options === void 0 ? void 0 : options.userAgent)
+            debug('User-Agent header ignored in request config');
         const data = body ? { data: body } : undefined;
         const url = path;
         // Runtime request parameters
         const baseUrl = (options === null || options === void 0 ? void 0 : options.organization) ? baseURL(options.organization, options.domain) : undefined;
         const accessToken = (options === null || options === void 0 ? void 0 : options.accessToken) || __classPrivateFieldGet(this, _ApiClient_accessToken, "f");
-        const headers = accessToken ? { 'Authorization': 'Bearer ' + accessToken } : undefined;
-        const requestParams = Object.assign({ method, baseURL: baseUrl, url, data, headers }, options);
+        const headers = this.customHeaders(options === null || options === void 0 ? void 0 : options.headers);
+        if (accessToken)
+            headers.Authorization = 'Bearer ' + accessToken;
+        const requestParams = { method, baseURL: baseUrl, url, data, ...options, headers };
         debug('request params: %O', requestParams);
         // const start = Date.now()
         return __classPrivateFieldGet(this, _ApiClient_client, "f").request(requestParams)
             .then(response => response.data)
-            .catch(error => handleError(error));
+            .catch((error) => handleError(error));
         // .finally(() => console.log(`<<-- ${method} ${path} ${Date.now() - start}`))
     }
+    customHeaders(headers) {
+        const customHeaders = {};
+        if (headers) {
+            for (const [name, value] of Object.entries(headers))
+                if (!['accept', 'content-type', 'authorization', 'user-agent'].includes(name.toLowerCase()))
+                    customHeaders[name] = value;
+        }
+        return customHeaders;
+    }
 }
 _ApiClient_accessToken = new WeakMap(), _ApiClient_client = new WeakMap();
 export default ApiClient;

package/lib/esm/commercelayer.d.ts

@@ -1,16 +1,15 @@
 import * as api from './api';
-import { ApiError } from './error';
+import type { ApiError } from './error';
 import type { ErrorInterceptor, InterceptorType, RawResponseReader, RequestInterceptor, ResponseInterceptor } from './interceptor';
-import { ResourcesInitConfig } from './resource';
-declare const OPEN_API_SCHEMA_VERSION = "4.23.0";
+import { type ResourcesInitConfig } from './resource';
+declare const OPEN_API_SCHEMA_VERSION = "4.24.0";
 export { OPEN_API_SCHEMA_VERSION };
 type SdkConfig = {};
 type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
 type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
 declare class CommerceLayerClient {
     #private;
-    static get openApiSchemaVersion(): string;
-    readonly openApiSchemaVersion = "4.23.0";
+    readonly openApiSchemaVersion = "4.24.0";
     addresses: api.Addresses;
     adjustments: api.Adjustments;
     adyen_gateways: api.AdyenGateways;
@@ -134,8 +133,10 @@ declare class CommerceLayerClient {
     constructor(config: CommerceLayerInitConfig);
     get currentOrganization(): string;
     private localConfig;
-    config(config: CommerceLayerConfig): void;
+    config(config: CommerceLayerConfig): CommerceLayerClient;
     resources(): readonly string[];
+    singletons(): readonly string[];
+    isSingleton(resource: api.ResourceTypeLock): boolean;
     isApiError(error: any): error is ApiError;
     addRequestInterceptor(onFulfilled?: RequestInterceptor, onRejected?: ErrorInterceptor): number;
     addResponseInterceptor(onFulfilled?: ResponseInterceptor, onRejected?: ErrorInterceptor): number;

package/lib/esm/commercelayer.js

@@ -16,18 +16,19 @@ import ResourceAdapter from './resource';
 import Debug from './debug';
 const debug = Debug('commercelayer');
 // Autogenerated schema version number, do not remove this line
-const OPEN_API_SCHEMA_VERSION = '4.23.0';
+const OPEN_API_SCHEMA_VERSION = '4.24.0';
 export { OPEN_API_SCHEMA_VERSION };
 class CommerceLayerClient {
-    static get openApiSchemaVersion() { return OPEN_API_SCHEMA_VERSION; }
     // ##__CL_RESOURCES_DEF_STOP__##
     constructor(config) {
+        // static get openApiSchemaVersion(): string { return OPEN_API_SCHEMA_VERSION }
         this.openApiSchemaVersion = OPEN_API_SCHEMA_VERSION;
         _CommerceLayerClient_adapter.set(this, void 0);
         _CommerceLayerClient_organization.set(this, void 0);
         debug('new commercelayer instance %O', config);
         __classPrivateFieldSet(this, _CommerceLayerClient_adapter, new ResourceAdapter(config), "f");
         __classPrivateFieldSet(this, _CommerceLayerClient_organization, config.organization, "f");
+        // this.#environment = 'test'
         // ##__CL_RESOURCES_INIT_START__##
         // ##__CL_RESOURCES_INIT_TEMPLATE:: ##__TAB__####__TAB__##this.##__RESOURCE_TYPE__## = new api.##__RESOURCE_CLASS__##(this.#adapter)
         this.addresses = new api.Addresses(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
@@ -153,6 +154,8 @@ class CommerceLayerClient {
         // ##__CL_RESOURCES_INIT_STOP__##
     }
     get currentOrganization() { return __classPrivateFieldGet(this, _CommerceLayerClient_organization, "f"); }
+    // get currentAccessToken(): string { return this.#adapter?.clientInstance?.currentAccessToken}
+    // get environment(): ApiMode { return this.#environment }
     localConfig(config) {
         if (config.organization)
             __classPrivateFieldSet(this, _CommerceLayerClient_organization, config.organization, "f");
@@ -166,10 +169,17 @@ class CommerceLayerClient {
         if (!config.organization)
             config.organization = this.currentOrganization;
         __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").config(config);
+        return this;
     }
     resources() {
         return CommerceLayerStatic.resources();
     }
+    singletons() {
+        return CommerceLayerStatic.singletons();
+    }
+    isSingleton(resource) {
+        return CommerceLayerStatic.isSingleton(resource);
+    }
     // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isApiError(error) {
         return CommerceLayerStatic.isApiError(error);
@@ -181,7 +191,7 @@ class CommerceLayerClient {
         return __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").interceptors.response.use(onFulfilled, onRejected);
     }
     removeInterceptor(type, id) {
-        return __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").interceptors[type].eject(id);
+        __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").interceptors[type].eject(id);
     }
     addRawResponseReader(options) {
         const reader = {
@@ -202,7 +212,7 @@ class CommerceLayerClient {
     removeRawResponseReader(reader) {
         const id = (typeof reader === 'number') ? reader : reader === null || reader === void 0 ? void 0 : reader.id;
         if (id && (id >= 0))
-            return this.removeInterceptor('response', id);
+            this.removeInterceptor('response', id);
     }
 }
 _CommerceLayerClient_adapter = new WeakMap(), _CommerceLayerClient_organization = new WeakMap();

package/lib/esm/common.d.ts

@@ -2,3 +2,4 @@ import type { ResourceId, ResourceType } from './resource';
 declare const isResourceId: (resource: any) => resource is ResourceId;
 declare const isResourceType: (resource: any) => resource is ResourceType;
 export { isResourceId, isResourceType };
+export type ObjectType = Record<string, any>;

package/lib/esm/common.js

@@ -1,5 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
 import { resourceList } from './api';
 const isResourceId = (resource) => {
     return ((resource === null || resource === void 0 ? void 0 : resource.type) && resource.id) && resourceList.includes(resource.type);
@@ -8,3 +6,14 @@ const isResourceType = (resource) => {
     return resource && (typeof resource.type !== 'undefined') && resource.type && resourceList.includes(resource.type);
 };
 export { isResourceId, isResourceType };
+/*
+// Nullable types
+type StringNullable = string | null
+type NumberNullable = number | null
+type BooleanNullable = boolean | null
+type ResourceNullable<R extends Resource> = R | null
+type ResourceArrayNullable<R extends Resource> = R[] | null
+
+
+export type { StringNullable, NumberNullable, BooleanNullable, ResourceNullable, ResourceArrayNullable }
+*/

package/lib/esm/config.d.ts

@@ -6,6 +6,7 @@ declare const config: {
     };
     readonly client: {
         readonly timeout: 15000;
+        readonly requiredAttributes: readonly ["organization", "accessToken"];
     };
 };
 export default config;

package/lib/esm/config.js

@@ -1,11 +1,14 @@
+// export type ApiMode = 'test' | 'live'
 const config = {
     default: {
+        // environment: 'test',
         domain: 'commercelayer.io',
         pageNumber: 1,
         pageSize: 10,
     },
     client: {
         timeout: 15000,
+        requiredAttributes: ['organization', 'accessToken'],
     }
 };
 export default config;

package/lib/esm/debug.js

@@ -1,6 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/no-unused-vars */
-// import Debug from 'debug'
 /* Nope debugger */
 const debuggerFunction = (_pattern, ..._args) => {
     // console.log(_pattern)
@@ -8,7 +5,6 @@ const debuggerFunction = (_pattern, ..._args) => {
 let debuggerFactory = (_namespace) => debuggerFunction;
 /* Try loading 'debug' module */
 try {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     const debugModule = require('debug');
     if (debugModule && (typeof debugModule === 'function'))
         debuggerFactory = debugModule;

package/lib/esm/error.d.ts

@@ -1,14 +1,15 @@
 declare enum ErrorType {
-    CLIENT = "client",
-    REQUEST = "request",
-    RESPONSE = "response",
-    GENERIC = "generic",
-    CANCEL = "cancel"
+    CLIENT = "client",// Error instantiating the client
+    REQUEST = "request",// Error preparing API request
+    RESPONSE = "response",// Error response from API
+    CANCEL = "cancel",// Forced request abort using interceptor
+    PARSE = "parse",// Error parsing API resource
+    GENERIC = "generic"
 }
 declare class SdkError extends Error {
     static NAME: string;
-    static isSdkError(error: any): error is ApiError;
-    type: string;
+    static isSdkError(error: any): error is SdkError;
+    type: ErrorType;
     code?: string;
     source?: Error;
     request?: any;
@@ -22,7 +23,9 @@ declare class ApiError extends SdkError {
     static isApiError(error: any): error is ApiError;
     errors: any[];
     status?: number;
+    statusText?: string;
     constructor(error: SdkError);
     first(): any;
 }
-export { SdkError, ApiError, ErrorType };
+declare const handleError: (error: Error) => never;
+export { SdkError, ApiError, ErrorType, handleError };

package/lib/esm/error.js

@@ -1,14 +1,14 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
+import axios from 'axios';
 var ErrorType;
 (function (ErrorType) {
     ErrorType["CLIENT"] = "client";
     ErrorType["REQUEST"] = "request";
     ErrorType["RESPONSE"] = "response";
-    ErrorType["GENERIC"] = "generic";
     ErrorType["CANCEL"] = "cancel";
+    ErrorType["PARSE"] = "parse";
+    ErrorType["GENERIC"] = "generic";
 })(ErrorType || (ErrorType = {}));
 class SdkError extends Error {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     static isSdkError(error) {
         return error && [SdkError.NAME, ApiError.NAME].includes(error.name) && Object.values(ErrorType).includes(error.type);
     }
@@ -20,12 +20,11 @@ class SdkError extends Error {
 }
 SdkError.NAME = 'SdkError';
 class ApiError extends SdkError {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     static isApiError(error) {
         return SdkError.isSdkError(error) && (error.name === ApiError.NAME) && (error.type === ErrorType.RESPONSE);
     }
     constructor(error) {
-        super(Object.assign(Object.assign({}, error), { type: ErrorType.RESPONSE }));
+        super({ ...error, type: ErrorType.RESPONSE });
         this.errors = [];
         this.name = ApiError.NAME; // this.constructor.name
     }
@@ -35,4 +34,36 @@ class ApiError extends SdkError {
     }
 }
 ApiError.NAME = 'ApiError';
-export { SdkError, ApiError, ErrorType };
+const handleError = (error) => {
+    let sdkError = new SdkError({ message: error.message });
+    if (axios.isAxiosError(error)) {
+        if (error.response) {
+            // The request was made and the server responded with a status code that falls out of the range of 2xx
+            const apiError = new ApiError(sdkError);
+            apiError.type = ErrorType.RESPONSE;
+            apiError.status = error.response.status;
+            apiError.statusText = error.response.statusText;
+            apiError.code = String(apiError.status);
+            apiError.errors = error.response.data.errors;
+            if (!apiError.message && apiError.statusText)
+                apiError.message = apiError.statusText;
+            sdkError = apiError;
+        }
+        else if (error.request) {
+            // The request was made but no response was received
+            // `error.request` is an instance of XMLHttpRequest in the browser and an instance of http.ClientRequest in node.js
+            sdkError.type = ErrorType.REQUEST;
+            sdkError.request = error.request;
+        }
+        else {
+            // Something happened in setting up the request that triggered an Error
+            sdkError.type = ErrorType.CLIENT;
+        }
+    }
+    else if (axios.isCancel(error))
+        sdkError.type = ErrorType.CANCEL;
+    else
+        sdkError.source = error;
+    throw sdkError;
+};
+export { SdkError, ApiError, ErrorType, handleError };

package/lib/esm/index.d.ts

@@ -2,6 +2,6 @@ export { default, CommerceLayer } from './commercelayer';
 export type { CommerceLayerClient } from './commercelayer';
 export { CommerceLayerStatic } from './static';
 export type { QueryParamsRetrieve, QueryParamsList, QueryParams } from './query';
-export * from './model';
+export type * from './model';
 export type { RequestObj, ResponseObj, ErrorObj, HeadersObj } from './interceptor';
 export type { SdkError, ApiError, ErrorType } from './error';

package/lib/esm/index.js

@@ -2,5 +2,3 @@
 export { default, CommerceLayer } from './commercelayer';
 // Commerce Layer static functions
 export { CommerceLayerStatic } from './static';
-// Resource model types
-export * from './model';

package/lib/esm/interceptor.d.ts

@@ -1,4 +1,4 @@
-import { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders } from 'axios';
+import type { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders } from 'axios';
 type InterceptorManager = {
     request: AxiosInterceptorManager<AxiosRequestConfig>;
     response: AxiosInterceptorManager<any>;
@@ -7,7 +7,11 @@ type RequestObj = AxiosRequestConfig;
 type RequestInterceptor = (request: RequestObj) => RequestObj | Promise<RequestObj>;
 type ResponseObj = AxiosResponse;
 type ResponseInterceptor = (response: ResponseObj) => ResponseObj;
-type HeadersObj = AxiosResponseHeaders | RawAxiosResponseHeaders;
+type ApiHeadersList = 'x-ratelimit-limit' | 'x-ratelimit-count' | 'x-ratelimit-period' | 'x-ratelimit-interval' | 'x-ratelimit-remaining';
+type ApiHeaders = {
+    [key in ApiHeadersList]: string | number | boolean;
+};
+type HeadersObj = (AxiosResponseHeaders | RawAxiosResponseHeaders) & ApiHeaders;
 type ErrorObj = AxiosError;
 type ErrorInterceptor = (error: ErrorObj) => ErrorObj;
 type InterceptorType = 'request' | 'response';

package/lib/esm/jsonapi.d.ts

@@ -1,5 +1,6 @@
 import type { DocWithData, ResourceObject as JSONAPIObject } from 'jsonapi-typescript';
 import type { ResourceCreate, ResourceUpdate, ResourceId, ResourceType, Resource } from './resource';
+export type { DocWithData };
 declare const denormalize: <R extends Resource>(response: DocWithData) => R | R[];
 declare const normalize: (resource: (ResourceCreate & ResourceType) | (ResourceUpdate & ResourceId)) => JSONAPIObject;
 export { denormalize, normalize };

package/lib/esm/jsonapi.js

@@ -28,13 +28,17 @@ const denormalizeResource = (res, included) => {
     debug('denormalize resource: %O, %o', res, included || {});
     if (!res)
         return res;
-    const resource = Object.assign({ id: res.id, type: res.type }, res.attributes);
+    const resource = {
+        id: res.id,
+        type: res.type,
+        ...res.attributes,
+    };
     if (res.relationships)
         Object.keys(res.relationships).forEach(key => {
             const rel = res.relationships[key].data;
             if (rel) {
                 if (Array.isArray(rel))
-                    resource[key] = rel.map(r => denormalizeResource(findIncluded(r, included), included));
+                    resource[key] = rel.map((r) => denormalizeResource(findIncluded(r, included), included));
                 else
                     resource[key] = denormalizeResource(findIncluded(rel, included), included);
             }
@@ -53,7 +57,10 @@ const normalize = (resource) => {
         if (['type', 'id'].includes(field))
             continue;
         const value = resource[field];
-        if (value && isResourceType(value) && value.id === null) {
+        if (Array.isArray(value) && (value.length === 1) && isResourceType(value[0]) && (value[0].id === null)) {
+            relationships[field] = { data: [] };
+        }
+        else if (value && isResourceType(value) && (value.id === null)) {
             relationships[field] = { data: null };
         }
         else if (value && (isResourceId(value) || (Array.isArray(value) && isResourceId(value[0])))) {

package/lib/esm/query.d.ts

@@ -1,23 +1,17 @@
-import { ResourceType } from "./resource";
+import type { ResourceType } from "./resource";
+type QueryFilter = Record<string, string | number | boolean>;
 interface QueryParamsRetrieve {
     include?: string[];
-    fields?: string[] | {
-        [key: string]: string[];
-    };
+    fields?: string[] | Record<string, string[]>;
 }
 interface QueryParamsList extends QueryParamsRetrieve {
-    sort?: string[] | {
-        [key: string]: 'asc' | 'desc';
-    };
-    filters?: {
-        [key: string]: string | number | boolean;
-    };
+    sort?: string[] | Record<string, 'asc' | 'desc'>;
+    filters?: QueryFilter;
     pageNumber?: number;
     pageSize?: number;
 }
 type QueryParams = QueryParamsRetrieve | QueryParamsList;
-export { QueryParamsRetrieve, QueryParamsList, QueryParams };
-declare const generateQueryStringParams: (params: QueryParamsRetrieve | QueryParamsList | undefined, res: string | ResourceType) => {
-    [key: string]: string;
-};
-export { generateQueryStringParams };
+export type { QueryParamsRetrieve, QueryParamsList, QueryParams, QueryFilter };
+declare const isParamsList: (params: any) => params is QueryParamsList;
+declare const generateQueryStringParams: (params: QueryParamsRetrieve | QueryParamsList | undefined, res: string | ResourceType) => Record<string, string>;
+export { generateQueryStringParams, isParamsList };

package/lib/esm/query.js

@@ -1,7 +1,7 @@
 import Debug from './debug';
 const debug = Debug('query');
 const isParamsList = (params) => {
-    return (params.filters || params.pageNumber || params.pageSize || params.sort);
+    return params && (params.filters || params.pageNumber || params.pageSize || params.sort);
 };
 const generateQueryStringParams = (params, res) => {
     debug('generate query string params: %O, %O', params, res);
@@ -42,4 +42,4 @@ const generateQueryStringParams = (params, res) => {
     debug('query string params: %O', qp);
     return qp;
 };
-export { generateQueryStringParams };
+export { generateQueryStringParams, isParamsList };