@commercelayer/provisioning-sdk 1.0.4 → 2.0.0-beta.1

package/lib/cjs/common.d.ts

@@ -1,5 +0,0 @@
-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

@@ -1,12 +0,0 @@
-"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

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

package/lib/cjs/config.js

@@ -1,19 +0,0 @@
-"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']
-    },
-    jsonapi: {
-        maxResourceIncluded: 2
-    }
-};
-exports.default = config;

package/lib/cjs/debug.d.ts

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

package/lib/cjs/debug.js

@@ -1,38 +0,0 @@
-"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

@@ -1,31 +0,0 @@
-declare enum ErrorType {
-    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 SdkError;
-    type: ErrorType;
-    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

@@ -1,77 +0,0 @@
-"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

@@ -1,7 +0,0 @@
-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

@@ -1,13 +0,0 @@
-"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 Provisioning 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

@@ -1,25 +0,0 @@
-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

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

package/lib/cjs/jsonapi.d.ts

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

@@ -1,94 +0,0 @@
-"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 config_1 = __importDefault(require("./config"));
-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, chain = []) => {
-    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 (chain.filter(r => (r.id === rel.id) && (r.type === rel.type)).length >= config_1.default.jsonapi.maxResourceIncluded)
-                    resource[key] = rel;
-                else {
-                    if (Array.isArray(rel))
-                        resource[key] = rel.map((r) => denormalizeResource(findIncluded(r, included), included, [...chain, r]));
-                    else
-                        resource[key] = denormalizeResource(findIncluded(rel, included), included, [...chain, rel]);
-                }
-            }
-            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

@@ -1,11 +0,0 @@
-/**
- * ©2024 Commerce Layer Inc.
- **/
-export type { ApiCredential, ApiCredentialCreate, ApiCredentialUpdate } from './resources/api_credentials';
-export type { ApplicationMembership, ApplicationMembershipCreate, ApplicationMembershipUpdate } from './resources/application_memberships';
-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

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

package/lib/cjs/query.d.ts

@@ -1,17 +0,0 @@
-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

@@ -1,52 +0,0 @@
-"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;

package/lib/cjs/resource.d.ts

@@ -1,86 +0,0 @@
-import { type ApiClientInitConfig } from './client';
-import type { QueryParamsRetrieve, QueryParamsList, QueryFilter, QueryParams } from './query';
-import type { ResourceTypeLock } from './api';
-import type { InterceptorManager } from './interceptor';
-type ResourceNull = {
-    id: null;
-} & ResourceType;
-type ResourceRel = ResourceId | ResourceNull;
-type Metadata = Record<string, any>;
-interface ResourceType {
-    readonly type: ResourceTypeLock;
-}
-interface ResourceId extends ResourceType {
-    readonly id: string;
-}
-interface ResourceBase {
-    reference?: string | null;
-    reference_origin?: string | null;
-    metadata?: Metadata;
-}
-interface Resource extends ResourceBase, ResourceId {
-    readonly created_at: string;
-    readonly updated_at: string;
-}
-interface ResourceCreate extends ResourceBase {
-}
-interface ResourceUpdate extends ResourceBase {
-    readonly id: string;
-}
-type ListMeta = {
-    readonly pageCount: number;
-    readonly recordCount: number;
-    readonly currentPage: number;
-    readonly recordsPerPage: number;
-};
-declare class ListResponse<R> extends Array<R> {
-    readonly meta: ListMeta;
-    constructor(meta: ListMeta, data: R[]);
-    first(): R | undefined;
-    last(): R | undefined;
-    get(index: number): R | undefined;
-    hasNextPage(): boolean;
-    hasPrevPage(): boolean;
-    getRecordCount(): number;
-    getPageCount(): number;
-    get recordCount(): number;
-    get pageCount(): number;
-}
-export type { Metadata, ResourceType, ResourceId, Resource, ResourceCreate, ResourceUpdate, ListResponse, ListMeta, ResourceRel };
-type ResourceAdapterConfig = {};
-type ResourcesInitConfig = ResourceAdapterConfig & ApiClientInitConfig;
-type ResourcesConfig = Partial<ResourcesInitConfig>;
-declare class ResourceAdapter {
-    #private;
-    constructor(config: ResourcesInitConfig);
-    get interceptors(): InterceptorManager;
-    private localConfig;
-    config(config: ResourcesConfig): ResourceAdapter;
-    retrieve<R extends Resource>(resource: ResourceId | ResourceType, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
-    list<R extends Resource>(resource: ResourceType, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
-    create<C extends ResourceCreate, R extends Resource>(resource: C & ResourceType, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
-    update<U extends ResourceUpdate, R extends Resource>(resource: U & ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
-    delete(resource: ResourceId, options?: ResourcesConfig): Promise<void>;
-    fetch<R extends Resource>(resource: string | ResourceType, path: string, params?: QueryParams, options?: ResourcesConfig): Promise<R | ListResponse<R>>;
-    action(cmd: 'post' | 'patch', path: string, payload?: any, options?: ResourcesConfig): Promise<void>;
-}
-declare abstract class ApiResourceBase<R extends Resource> {
-    static readonly TYPE: ResourceTypeLock;
-    protected readonly resources: ResourceAdapter;
-    constructor(adapter: ResourceAdapter);
-    abstract relationship(id: string | ResourceId | null): ResourceRel;
-    abstract type(): ResourceTypeLock;
-    parse(resource: string): R | R[];
-    update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
-}
-declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R> {
-    retrieve(id: string | ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
-    count(filter?: QueryFilter | QueryParamsList, options?: ResourcesConfig): Promise<number>;
-}
-declare abstract class ApiSingleton<R extends Resource> extends ApiResourceBase<R> {
-    retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
-}
-export default ResourceAdapter;
-export { ApiResource, ApiSingleton };
-export type { ResourcesConfig, ResourcesInitConfig };