@commercelayer/provisioning-sdk 1.0.0-beta.1

package/lib/cjs/commercelayer.d.ts

@@ -0,0 +1,36 @@
+import * as api from './api';
+import type { ApiError } from './error';
+import type { ErrorInterceptor, InterceptorType, RawResponseReader, RequestInterceptor, ResponseInterceptor } from './interceptor';
+import { type ResourcesInitConfig } from './resource';
+declare const OPEN_API_SCHEMA_VERSION = "1.0.0";
+export { OPEN_API_SCHEMA_VERSION };
+type SdkConfig = {};
+type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
+type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
+declare class CommerceLayerProvisioningClient {
+    #private;
+    readonly openApiSchemaVersion = "1.0.0";
+    api_credentials: api.ApiCredentials;
+    memberships: api.Memberships;
+    organizations: api.Organizations;
+    permissions: api.Permissions;
+    roles: api.Roles;
+    user: api.Users;
+    versions: api.Versions;
+    constructor(config: CommerceLayerInitConfig);
+    private localConfig;
+    config(config: CommerceLayerConfig): CommerceLayerProvisioningClient;
+    resources(): readonly string[];
+    isApiError(error: any): error is ApiError;
+    addRequestInterceptor(onFulfilled?: RequestInterceptor, onRejected?: ErrorInterceptor): number;
+    addResponseInterceptor(onFulfilled?: ResponseInterceptor, onRejected?: ErrorInterceptor): number;
+    removeInterceptor(type: InterceptorType, id: number): void;
+    addRawResponseReader(options?: {
+        headers: boolean;
+    }): RawResponseReader;
+    removeRawResponseReader(reader: number | RawResponseReader): void;
+}
+declare const CommerceLayerProvisioning: (config: CommerceLayerInitConfig) => CommerceLayerProvisioningClient;
+export default CommerceLayerProvisioning;
+export { CommerceLayerProvisioning };
+export type { CommerceLayerProvisioningClient, CommerceLayerConfig, CommerceLayerInitConfig };

package/lib/cjs/commercelayer.js

@@ -0,0 +1,126 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _CommerceLayerProvisioningClient_adapter;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommerceLayerProvisioning = exports.OPEN_API_SCHEMA_VERSION = void 0;
+const api = __importStar(require("./api"));
+const static_1 = require("./static");
+const resource_1 = __importDefault(require("./resource"));
+const debug_1 = __importDefault(require("./debug"));
+const debug = (0, debug_1.default)('commercelayer');
+// Autogenerated schema version number, do not remove this line
+const OPEN_API_SCHEMA_VERSION = '1.0.0';
+exports.OPEN_API_SCHEMA_VERSION = OPEN_API_SCHEMA_VERSION;
+class CommerceLayerProvisioningClient {
+    // ##__CL_RESOURCES_DEF_STOP__##
+    constructor(config) {
+        // static get openApiSchemaVersion(): string { return OPEN_API_SCHEMA_VERSION }
+        this.openApiSchemaVersion = OPEN_API_SCHEMA_VERSION;
+        _CommerceLayerProvisioningClient_adapter.set(this, void 0);
+        debug('new commercelayer provisioning instance %O', config);
+        __classPrivateFieldSet(this, _CommerceLayerProvisioningClient_adapter, new resource_1.default(config), "f");
+        // this.#environment = 'test'
+        // ##__CL_RESOURCES_INIT_START__##
+        // ##__CL_RESOURCES_INIT_TEMPLATE:: ##__TAB__####__TAB__##this.##__RESOURCE_TYPE__## = new api.##__RESOURCE_CLASS__##(this.#adapter)
+        this.api_credentials = new api.ApiCredentials(__classPrivateFieldGet(this, _CommerceLayerProvisioningClient_adapter, "f"));
+        this.memberships = new api.Memberships(__classPrivateFieldGet(this, _CommerceLayerProvisioningClient_adapter, "f"));
+        this.organizations = new api.Organizations(__classPrivateFieldGet(this, _CommerceLayerProvisioningClient_adapter, "f"));
+        this.permissions = new api.Permissions(__classPrivateFieldGet(this, _CommerceLayerProvisioningClient_adapter, "f"));
+        this.roles = new api.Roles(__classPrivateFieldGet(this, _CommerceLayerProvisioningClient_adapter, "f"));
+        this.user = new api.Users(__classPrivateFieldGet(this, _CommerceLayerProvisioningClient_adapter, "f"));
+        this.versions = new api.Versions(__classPrivateFieldGet(this, _CommerceLayerProvisioningClient_adapter, "f"));
+        // ##__CL_RESOURCES_INIT_STOP__##
+    }
+    // get environment(): ApiMode { return this.#environment }
+    localConfig(config /* & { organization?: string } */) {
+    }
+    config(config) {
+        debug('config %o', config);
+        // CommerceLayer config
+        this.localConfig(config);
+        // ResourceAdapter config
+        // To rebuild baseUrl in client in case only the domain is defined
+        // if (!config.organization) config.organization = this.currentOrganization
+        __classPrivateFieldGet(this, _CommerceLayerProvisioningClient_adapter, "f").config(config);
+        return this;
+    }
+    resources() {
+        return static_1.CommerceLayerProvisioningStatic.resources();
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isApiError(error) {
+        return static_1.CommerceLayerProvisioningStatic.isApiError(error);
+    }
+    addRequestInterceptor(onFulfilled, onRejected) {
+        return __classPrivateFieldGet(this, _CommerceLayerProvisioningClient_adapter, "f").interceptors.request.use(onFulfilled, onRejected);
+    }
+    addResponseInterceptor(onFulfilled, onRejected) {
+        return __classPrivateFieldGet(this, _CommerceLayerProvisioningClient_adapter, "f").interceptors.response.use(onFulfilled, onRejected);
+    }
+    removeInterceptor(type, id) {
+        __classPrivateFieldGet(this, _CommerceLayerProvisioningClient_adapter, "f").interceptors[type].eject(id);
+    }
+    addRawResponseReader(options) {
+        const reader = {
+            id: undefined,
+            rawResponse: undefined,
+            headers: undefined,
+        };
+        function rawResponseInterceptor(response) {
+            reader.rawResponse = response === null || response === void 0 ? void 0 : response.data;
+            if (options === null || options === void 0 ? void 0 : options.headers)
+                reader.headers = response.headers;
+            return response;
+        }
+        const interceptor = this.addResponseInterceptor(rawResponseInterceptor);
+        reader.id = interceptor;
+        return reader;
+    }
+    removeRawResponseReader(reader) {
+        const id = (typeof reader === 'number') ? reader : reader === null || reader === void 0 ? void 0 : reader.id;
+        if (id && (id >= 0))
+            this.removeInterceptor('response', id);
+    }
+}
+_CommerceLayerProvisioningClient_adapter = new WeakMap();
+const CommerceLayerProvisioning = (config) => {
+    return new CommerceLayerProvisioningClient(config);
+};
+exports.CommerceLayerProvisioning = CommerceLayerProvisioning;
+exports.default = CommerceLayerProvisioning;

package/lib/cjs/common.d.ts

@@ -0,0 +1,5 @@
+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/cjs/common.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isResourceType = exports.isResourceId = void 0;
+const api_1 = require("./api");
+const isResourceId = (resource) => {
+    return ((resource === null || resource === void 0 ? void 0 : resource.type) && resource.id) && api_1.resourceList.includes(resource.type);
+};
+exports.isResourceId = isResourceId;
+const isResourceType = (resource) => {
+    return resource && (typeof resource.type !== 'undefined') && resource.type && api_1.resourceList.includes(resource.type);
+};
+exports.isResourceType = isResourceType;

package/lib/cjs/config.d.ts

@@ -0,0 +1,12 @@
+declare const config: {
+    readonly default: {
+        readonly domain: "commercelayer.io";
+        readonly pageNumber: 1;
+        readonly pageSize: 10;
+    };
+    readonly client: {
+        readonly timeout: 15000;
+        readonly requiredAttributes: readonly ["accessToken"];
+    };
+};
+export default config;

package/lib/cjs/config.js

@@ -0,0 +1,16 @@
+"use strict";
+// export type ApiMode = 'test' | 'live'
+Object.defineProperty(exports, "__esModule", { value: true });
+const config = {
+    default: {
+        // environment: 'test',
+        domain: 'commercelayer.io',
+        pageNumber: 1,
+        pageSize: 10,
+    },
+    client: {
+        timeout: 15000,
+        requiredAttributes: ['accessToken'],
+    }
+};
+exports.default = config;

package/lib/cjs/debug.d.ts

@@ -0,0 +1,3 @@
+type Debugger = (pattern: string, ...args: any[]) => void;
+declare const debug: (namespace: string) => Debugger;
+export default debug;

package/lib/cjs/debug.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* Nope debugger */
+const debuggerFunction = (_pattern, ..._args) => {
+    // console.log(_pattern)
+};
+let debuggerFactory = (_namespace) => debuggerFunction;
+/* Try loading 'debug' module */
+try {
+    const debugModule = require('debug');
+    if (debugModule && (typeof debugModule === 'function'))
+        debuggerFactory = debugModule;
+}
+catch (error) {
+    //
+}
+const debugPrefix = 'clsdk';
+/* Retrieve the name of the caller 'module' */
+/*
+const caller = (): string => {
+
+    const err = new Error()
+
+    Error.prepareStackTrace = (_, stack) => stack
+    const stack = err.stack as unknown as NodeJS.CallSite[]
+    Error.prepareStackTrace = undefined
+
+    const fileName = stack[2].getFileName() || '/'
+
+    return fileName.replace(/^.*[\\/]/, '').replace('.ts', '')
+
+}
+*/
+/* Return a debugger for the defined namespace */
+const debug = (namespace) => {
+    return debuggerFactory(`${debugPrefix}:${namespace}`);
+};
+exports.default = debug;

package/lib/cjs/error.d.ts

@@ -0,0 +1,31 @@
+declare enum ErrorType {
+    CLIENT = "client",
+    REQUEST = "request",
+    RESPONSE = "response",
+    CANCEL = "cancel",
+    PARSE = "parse",
+    GENERIC = "generic"
+}
+declare class SdkError extends Error {
+    static NAME: string;
+    static isSdkError(error: any): error is ApiError;
+    type: string;
+    code?: string;
+    source?: Error;
+    request?: any;
+    constructor(error: {
+        message: string;
+        type?: ErrorType;
+    });
+}
+declare class ApiError extends SdkError {
+    static NAME: string;
+    static isApiError(error: any): error is ApiError;
+    errors: any[];
+    status?: number;
+    statusText?: string;
+    constructor(error: SdkError);
+    first(): any;
+}
+declare const handleError: (error: Error) => never;
+export { SdkError, ApiError, ErrorType, handleError };

package/lib/cjs/error.js

@@ -0,0 +1,77 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleError = exports.ErrorType = exports.ApiError = exports.SdkError = void 0;
+const axios_1 = __importDefault(require("axios"));
+var ErrorType;
+(function (ErrorType) {
+    ErrorType["CLIENT"] = "client";
+    ErrorType["REQUEST"] = "request";
+    ErrorType["RESPONSE"] = "response";
+    ErrorType["CANCEL"] = "cancel";
+    ErrorType["PARSE"] = "parse";
+    ErrorType["GENERIC"] = "generic";
+})(ErrorType || (exports.ErrorType = ErrorType = {}));
+class SdkError extends Error {
+    static isSdkError(error) {
+        return error && [SdkError.NAME, ApiError.NAME].includes(error.name) && Object.values(ErrorType).includes(error.type);
+    }
+    constructor(error) {
+        super(error.message);
+        this.name = SdkError.NAME; // this.constructor.name
+        this.type = error.type || ErrorType.GENERIC;
+    }
+}
+exports.SdkError = SdkError;
+SdkError.NAME = 'SdkError';
+class ApiError extends SdkError {
+    static isApiError(error) {
+        return SdkError.isSdkError(error) && (error.name === ApiError.NAME) && (error.type === ErrorType.RESPONSE);
+    }
+    constructor(error) {
+        super({ ...error, type: ErrorType.RESPONSE });
+        this.errors = [];
+        this.name = ApiError.NAME; // this.constructor.name
+    }
+    first() {
+        var _a;
+        return (((_a = this.errors) === null || _a === void 0 ? void 0 : _a.length) > 0) ? this.errors[0] : undefined;
+    }
+}
+exports.ApiError = ApiError;
+ApiError.NAME = 'ApiError';
+const handleError = (error) => {
+    let sdkError = new SdkError({ message: error.message });
+    if (axios_1.default.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_1.default.isCancel(error))
+        sdkError.type = ErrorType.CANCEL;
+    else
+        sdkError.source = error;
+    throw sdkError;
+};
+exports.handleError = handleError;

package/lib/cjs/index.d.ts

@@ -0,0 +1,7 @@
+export { default, CommerceLayerProvisioning } from './commercelayer';
+export type { CommerceLayerProvisioningClient } from './commercelayer';
+export { CommerceLayerProvisioningStatic } from './static';
+export type { QueryParamsRetrieve, QueryParamsList, QueryParams } from './query';
+export type * from './model';
+export type { RequestObj, ResponseObj, ErrorObj, HeadersObj } from './interceptor';
+export type { SdkError, ApiError, ErrorType } from './error';

package/lib/cjs/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommerceLayerProvisioningStatic = exports.CommerceLayerProvisioning = exports.default = void 0;
+// SDK
+var commercelayer_1 = require("./commercelayer");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(commercelayer_1).default; } });
+Object.defineProperty(exports, "CommerceLayerProvisioning", { enumerable: true, get: function () { return commercelayer_1.CommerceLayerProvisioning; } });
+// Commerce Layer static functions
+var static_1 = require("./static");
+Object.defineProperty(exports, "CommerceLayerProvisioningStatic", { enumerable: true, get: function () { return static_1.CommerceLayerProvisioningStatic; } });

package/lib/cjs/interceptor.d.ts

@@ -0,0 +1,25 @@
+import type { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders } from 'axios';
+type InterceptorManager = {
+    request: AxiosInterceptorManager<AxiosRequestConfig>;
+    response: AxiosInterceptorManager<any>;
+};
+type RequestObj = AxiosRequestConfig;
+type RequestInterceptor = (request: RequestObj) => RequestObj | Promise<RequestObj>;
+type ResponseObj = AxiosResponse;
+type ResponseInterceptor = (response: ResponseObj) => ResponseObj;
+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';
+export type { InterceptorManager, RequestInterceptor, ResponseInterceptor, ErrorInterceptor, InterceptorType };
+export type { RequestObj, ResponseObj, ErrorObj, HeadersObj };
+type RawResponseReader = {
+    id: number | undefined;
+    rawResponse: ResponseObj | undefined;
+    headers: HeadersObj | undefined;
+};
+export type { RawResponseReader };

package/lib/cjs/interceptor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/jsonapi.d.ts

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

package/lib/cjs/jsonapi.js

@@ -0,0 +1,89 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalize = exports.denormalize = void 0;
+const common_1 = require("./common");
+const debug_1 = __importDefault(require("./debug"));
+const debug = (0, debug_1.default)('jsonapi');
+// DENORMALIZATION
+const denormalize = (response) => {
+    let denormalizedResponse;
+    if (response.links)
+        delete response.links;
+    const data = response.data;
+    const included = response.included;
+    if (!data)
+        denormalizedResponse = data;
+    else {
+        if (Array.isArray(data))
+            denormalizedResponse = data.map(res => denormalizeResource(res, included));
+        else
+            denormalizedResponse = denormalizeResource(data, included);
+    }
+    return denormalizedResponse;
+};
+exports.denormalize = denormalize;
+const findIncluded = (rel, included = []) => {
+    const inc = included.find(inc => {
+        return (rel.id === inc.id) && (rel.type === inc.type);
+    });
+    return inc || rel;
+};
+const denormalizeResource = (res, included) => {
+    debug('denormalize resource: %O, %o', res, included || {});
+    if (!res)
+        return res;
+    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));
+                else
+                    resource[key] = denormalizeResource(findIncluded(rel, included), included);
+            }
+            else if (rel === null)
+                resource[key] = null;
+        });
+    debug('denormalized resource: %O', resource);
+    return resource;
+};
+// NORMALIZATION
+const normalize = (resource) => {
+    debug('normalize resource: %O', resource);
+    const attributes = {};
+    const relationships = {};
+    for (const field in resource) {
+        if (['type', 'id'].includes(field))
+            continue;
+        const value = resource[field];
+        if (Array.isArray(value) && (value.length === 1) && (0, common_1.isResourceType)(value[0]) && (value[0].id === null)) {
+            relationships[field] = { data: [] };
+        }
+        else if (value && (0, common_1.isResourceType)(value) && (value.id === null)) {
+            relationships[field] = { data: null };
+        }
+        else if (value && ((0, common_1.isResourceId)(value) || (Array.isArray(value) && (0, common_1.isResourceId)(value[0])))) {
+            relationships[field] = { data: value };
+        }
+        else
+            attributes[field] = value;
+    }
+    const normalized = {
+        type: resource.type,
+        attributes,
+        relationships
+    };
+    if ((0, common_1.isResourceId)(resource))
+        normalized.id = resource.id;
+    debug('normalized resource: %O', normalized);
+    return normalized;
+};
+exports.normalize = normalize;

package/lib/cjs/model.d.ts

@@ -0,0 +1,10 @@
+/**
+ * ©2023 Commerce Layer Inc.
+ **/
+export type { ApiCredential, ApiCredentialCreate, ApiCredentialUpdate } from './resources/api_credentials';
+export type { Membership, MembershipCreate, MembershipUpdate } from './resources/memberships';
+export type { Organization, OrganizationCreate, OrganizationUpdate } from './resources/organizations';
+export type { Permission, PermissionCreate, PermissionUpdate } from './resources/permissions';
+export type { Role, RoleCreate, RoleUpdate } from './resources/roles';
+export type { User, UserUpdate } from './resources/user';
+export type { Version } from './resources/versions';

package/lib/cjs/model.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// ##__MODEL_TYPES_STOP__##

package/lib/cjs/query.d.ts

@@ -0,0 +1,17 @@
+import type { ResourceType } from "./resource";
+type QueryFilter = Record<string, string | number | boolean>;
+interface QueryParamsRetrieve {
+    include?: string[];
+    fields?: string[] | Record<string, string[]>;
+}
+interface QueryParamsList extends QueryParamsRetrieve {
+    sort?: string[] | Record<string, 'asc' | 'desc'>;
+    filters?: QueryFilter;
+    pageNumber?: number;
+    pageSize?: number;
+}
+type QueryParams = QueryParamsRetrieve | QueryParamsList;
+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/cjs/query.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isParamsList = exports.generateQueryStringParams = void 0;
+const debug_1 = __importDefault(require("./debug"));
+const debug = (0, debug_1.default)('query');
+const isParamsList = (params) => {
+    return params && (params.filters || params.pageNumber || params.pageSize || params.sort);
+};
+exports.isParamsList = isParamsList;
+const generateQueryStringParams = (params, res) => {
+    debug('generate query string params: %O, %O', params, res);
+    const qp = {};
+    if (!params)
+        return qp;
+    // Include
+    if (params.include)
+        qp.include = params.include.join(',');
+    // Fields
+    if (params.fields) {
+        if (Array.isArray(params.fields))
+            params.fields = { [res.type || res]: params.fields };
+        Object.entries(params.fields).forEach(([p, v]) => {
+            qp[`fields[${p}]`] = v.join(',');
+        });
+    }
+    if (isParamsList(params)) {
+        // Sort
+        if (params.sort) {
+            if (Array.isArray(params.sort))
+                qp.sort = params.sort.join(',');
+            else
+                qp.sort = Object.entries(params.sort).map(([k, v]) => `${v === 'desc' ? '-' : ''}${k}`).join(',');
+        }
+        // Page
+        if (params.pageNumber)
+            qp['page[number]'] = String(params.pageNumber);
+        if (params.pageSize)
+            qp['page[size]'] = String(params.pageSize);
+        // Filters
+        if (params.filters) {
+            Object.entries(params.filters).forEach(([p, v]) => {
+                qp[`filter[q][${p}]`] = String(v);
+            });
+        }
+    }
+    debug('query string params: %O', qp);
+    return qp;
+};
+exports.generateQueryStringParams = generateQueryStringParams;