@webitel/api-services 0.0.25 → 0.0.28

package/src/api/defaults/getDefaultGetParams/getDefaultGetParams.ts

@@ -1,6 +1,11 @@
-const getDefaultGetParams = ({ page = 1, size = 10 } = {}) => ({
-  page,
-  size,
+/**
+ * Creates default parameters for get operations with pagination
+ * @param options - Options for the parameters
+ * @param options.page - Page number (default: 1)
+ * @param options.size - Page size (default: 10)
+ * @returns Default parameters object with page and size
+ */
+export const getDefaultGetParams = ({ page = 1, size = 10 } = {}) => ({
+	page,
+	size,
 });
-
-export default getDefaultGetParams;

package/src/api/defaults/getDefaultInstance/getDefaultInstance.ts

@@ -1,21 +1,21 @@
 import qs from 'qs';
-import generateInstance from '../../axios/generateInstance';
-import updateTokenInterceptor from '../../interceptors/request/updateToken.interceptor';
-import handleUnauthorizedInterceptor from '../../interceptors/response/handleUnauthorized.interceptor';
+import { generateInstance } from '../../axios/generateInstance';
+import { updateTokenInterceptor } from '../../interceptors/request/updateToken.interceptor';
+import { handleUnauthorizedInterceptor } from '../../interceptors/response/handleUnauthorized.interceptor';
 
-const getDefaultInstance = () => {
-  return generateInstance({
-    interceptors: {
-      request: [updateTokenInterceptor],
-      response: [handleUnauthorizedInterceptor],
-    },
-    baseURL: import.meta.env.VITE_API_URL,
-    paramsSerializer: (params) => {
-      return qs.stringify(params);
-    },
-  });
+/**
+ * Creates a default Axios instance with standard configuration
+ * @returns Configured Axios instance
+ */
+export const getDefaultInstance = () => {
+	return generateInstance({
+		interceptors: {
+			request: [updateTokenInterceptor],
+			response: [handleUnauthorizedInterceptor],
+		},
+		baseURL: import.meta.env.VITE_API_URL,
+		paramsSerializer: (params) => {
+			return qs.stringify(params);
+		},
+	});
 };
-
-export { getDefaultInstance };
-
-export default getDefaultInstance;

package/src/api/defaults/getDefaultOpenAPIConfig/getDefaultOpenAPIConfig.ts

@@ -1,10 +1,12 @@
 import { Configuration } from 'webitel-sdk';
 
-const getDefaultOpenAPIConfig = () =>
-  new Configuration({
-    basePath: import.meta.env.VITE_API_URL,
-    apiKey: localStorage.getItem('access-key') || '',
-    accessToken: localStorage.getItem('access-key') || '',
-  });
-
-export default getDefaultOpenAPIConfig;
+/**
+ * Creates a default configuration for OpenAPI clients
+ * @returns Configuration object with basePath, apiKey, and accessToken
+ */
+export const getDefaultOpenAPIConfig = () =>
+	new Configuration({
+		basePath: import.meta.env.VITE_API_URL,
+		apiKey: localStorage.getItem('access-key') || '',
+		accessToken: localStorage.getItem('access-key') || '',
+	});

package/src/api/defaults/index.ts

@@ -1,11 +1,4 @@
-import getDefaultGetListResponse from './getDefaultGetListResponse/getDefaultGetListResponse';
-import getDefaultGetParams from './getDefaultGetParams/getDefaultGetParams';
-import getDefaultInstance from './getDefaultInstance/getDefaultInstance';
-import getDefaultOpenAPIConfig from './getDefaultOpenAPIConfig/getDefaultOpenAPIConfig';
-
-export {
-  getDefaultGetListResponse,
-  getDefaultGetParams,
-  getDefaultInstance,
-  getDefaultOpenAPIConfig,
-};
+export * from './getDefaultGetListResponse/getDefaultGetListResponse';
+export * from './getDefaultGetParams/getDefaultGetParams';
+export * from './getDefaultInstance/getDefaultInstance';
+export * from './getDefaultOpenAPIConfig/getDefaultOpenAPIConfig';

package/src/api/index.ts

@@ -3,4 +3,4 @@ export * from './axios';
 export * from './clients';
 export * from './defaults';
 export * from './interceptors';
-export * from './transformers';
+export * from './transformers';

package/src/api/interceptors/index.ts

@@ -1,3 +1,3 @@
 // Export interceptors
 export * from './request';
-export * from './response';
+export * from './response';

package/src/api/interceptors/request/index.ts

@@ -1,2 +1,2 @@
 // Export request interceptors
-export { default as updateTokenInterceptor } from './updateToken.interceptor';
+export { updateTokenInterceptor } from './updateToken.interceptor';

package/src/api/interceptors/request/updateToken.interceptor.ts

@@ -1,10 +1,11 @@
-const updateTokenInterceptor = [
-  (config) => {
-    config.headers['X-Webitel-Access'] =
-      localStorage.getItem('access-token') || '';
-    return config;
-  },
-  (error) => Promise.reject(error),
+/**
+ * Axios request interceptor that updates the X-Webitel-Access header with the current access token
+ */
+export const updateTokenInterceptor = [
+	(config) => {
+		config.headers['X-Webitel-Access'] =
+			localStorage.getItem('access-token') || '';
+		return config;
+	},
+	(error) => Promise.reject(error),
 ];
-
-export default updateTokenInterceptor;

package/src/api/interceptors/response/handleUnauthorized.interceptor.ts

@@ -1,12 +1,14 @@
-const handleUnauthorizedInterceptor = [
-  (response) => response,
-  (error) => {
-    if (error.response && error.response.status === 401) {
-      console.warn('intercepted 401');
-      localStorage.removeItem('access-token');
-    }
-    return Promise.reject(error);
-  },
+/**
+ * Axios response interceptor that handles 401 Unauthorized responses
+ * by removing the access token from localStorage
+ */
+export const handleUnauthorizedInterceptor = [
+	(response) => response,
+	(error) => {
+		if (error.response && error.response.status === 401) {
+			console.warn('intercepted 401');
+			localStorage.removeItem('access-token');
+		}
+		return Promise.reject(error);
+	},
 ];
-
-export default handleUnauthorizedInterceptor;

package/src/api/interceptors/response/index.ts

@@ -1,2 +1,2 @@
 // Export response interceptors
-export { default as handleUnauthorizedInterceptor } from './handleUnauthorized.interceptor';
+export { handleUnauthorizedInterceptor } from './handleUnauthorized.interceptor';

package/src/api/transformers/addQueryParamsToUrl/addQueryParamsToUrl.transformer.ts

@@ -2,18 +2,18 @@
 // This function adds query parameters to a given URL.
 // Where queryArray is an array of query parameters in the format 'key=value'.
 const addQueryParamsToUrl = (queryArray) => (url) => {
-  let modifyUrl = url;
+	let modifyUrl = url;
 
-  if (queryArray && queryArray.length > 0) {
-    if (modifyUrl.includes('?')) {
-      modifyUrl += '&' + queryArray.join('&');
+	if (queryArray && queryArray.length > 0) {
+		if (modifyUrl.includes('?')) {
+			modifyUrl += `&${queryArray.join('&')}`;
 
-      return modifyUrl;
-    }
+			return modifyUrl;
+		}
 
-    modifyUrl += '?' + queryArray.join('&');
-  }
+		modifyUrl += `?${queryArray.join('&')}`;
+	}
 
-  return modifyUrl;
+	return modifyUrl;
 };
 export default addQueryParamsToUrl;

package/src/api/transformers/applyTransform.ts

@@ -1,17 +1,24 @@
-const applyTransform = (
-  target,
-  transformers,
-  { debug = false, withContext = null } = {},
+/**
+ * Applies a series of transformers to a target object
+ * @param target - The object to transform
+ * @param transformers - Array of transformer functions to apply
+ * @param options - Configuration options
+ * @param options.debug - Whether to log debug information
+ * @param options.withContext - Context to pass to transformers
+ * @returns The transformed object
+ */
+export const applyTransform = (
+	target,
+	transformers,
+	{ debug = false, withContext = null } = {},
 ) => {
-  return transformers.reduce((result, transformer, index) => {
-    if (debug) console.info(`applyTransform debug on step ${index}`, result);
+	return transformers.reduce((result, transformer, index) => {
+		if (debug) console.info(`applyTransform debug on step ${index}`, result);
 
-    if (withContext) {
-      return transformer(result, withContext);
-    }
+		if (withContext) {
+			return transformer(result, withContext);
+		}
 
-    return transformer(result);
-  }, target);
+		return transformer(result);
+	}, target);
 };
-
-export default applyTransform;

package/src/api/transformers/camelToSnake/camelToSnake.transformer.ts

@@ -1,5 +1,5 @@
-import { objCamelToSnake } from '../../../scripts/caseConverters';
+import { objCamelToSnake } from '../../../utils/api/caseConverters';
 
 const camelToSnakeTransformer = (skipKeys) => (obj) =>
-  objCamelToSnake(obj, skipKeys);
+	objCamelToSnake(obj, skipKeys);
 export default camelToSnakeTransformer;

package/src/api/transformers/generateUrl/generateUrl.transformer.ts

@@ -1,13 +1,13 @@
 import qs from 'query-string';
 
 const generateUrlTransformer = (baseUrl) => (params) => {
-  const stringifyOptions = {
-    skipEmptyString: true,
-    skipNull: true,
-  };
+	const stringifyOptions = {
+		skipEmptyString: true,
+		skipNull: true,
+	};
 
-  const url = `${baseUrl}?${qs.stringify(params, stringifyOptions)}`;
-  return url;
+	const url = `${baseUrl}?${qs.stringify(params, stringifyOptions)}`;
+	return url;
 };
 
 export default generateUrlTransformer;

package/src/api/transformers/index.ts

@@ -1,5 +1,5 @@
 import addQueryParamsToUrl from './addQueryParamsToUrl/addQueryParamsToUrl.transformer';
-import applyTransform from './applyTransform';
+import { applyTransform } from './applyTransform';
 import camelToSnake from './camelToSnake/camelToSnake.transformer';
 import generateUrl from './generateUrl/generateUrl.transformer';
 import log from './log/log.transformer';
@@ -12,17 +12,16 @@ import snakeToCamel from './snakeToCamel/snakeToCamel.transformer';
 import starToSearch from './starToSearch/starToSearch.transformer';
 
 export {
-  addQueryParamsToUrl,
-  camelToSnake,
-  generateUrl,
-  log,
-  merge,
-  mergeEach,
-  notify,
-  sanitize,
-  skipIf,
-  snakeToCamel,
-  starToSearch,
+	addQueryParamsToUrl,
+	applyTransform,
+	camelToSnake,
+	generateUrl,
+	log,
+	merge,
+	mergeEach,
+	notify,
+	sanitize,
+	skipIf,
+	snakeToCamel,
+	starToSearch,
 };
-
-export default applyTransform;

package/src/api/transformers/log/log.transformer.ts

@@ -1,6 +1,6 @@
 const logTransformer = (arg) => {
-  console.log(arg);
-  return arg;
+	console.log(arg);
+	return arg;
 };
 
 export default logTransformer;

package/src/api/transformers/merge/merge.transformer.ts

@@ -1,8 +1,8 @@
 import merge from 'deepmerge';
 
 const mergeTransformer =
-  (...args) =>
-  (main) =>
-    merge.all([...args, main]);
+	(...args) =>
+	(main) =>
+		merge.all([...args, main]);
 
 export default mergeTransformer;

package/src/api/transformers/mergeEach/mergeEach.transformer.ts

@@ -1,8 +1,8 @@
 import merge from 'deepmerge';
 
 const mergeEachTransformer =
-  (...args) =>
-  (main) =>
-    main.map((item) => merge.all([...args, item]));
+	(...args) =>
+	(main) =>
+		main.map((item) => merge.all([...args, item]));
 
 export default mergeEachTransformer;

package/src/api/transformers/notify/notify.transformer.ts

@@ -1,39 +1,39 @@
-import eventBus from '../../../scripts/eventBus';
+import { config as apiServicesConfig } from '../../../config/config';
 
 const notifyTransformer = (notificationObject) => {
-  /*
+	/*
   if passed arg is function, then this notification - static content,
   predefined before actual transformer is called in applyTransform flow
    */
-  if (typeof notificationObject === 'function') {
-    /*
+	if (typeof notificationObject === 'function') {
+		/*
     so, create a callback which will send notification with params, passed to it
      */
-    const callback = ({ type, text }) =>
-      eventBus.$emit('notification', {
-        type,
-        text,
-      });
+		const callback = ({ type, text }) =>
+			apiServicesConfig.eventBus.$emit('notification', {
+				type,
+				text,
+			});
 
-    /*
+		/*
     and, then, return a function, which will be called in main applyTransform flow,
     calling passed arg function with callback, and returning actual notify payload
      */
-    return (payload) => {
-      notificationObject({ callback });
-      return payload;
-    };
-  }
-  if (notificationObject instanceof Error) {
-    eventBus.$emit('notification', {
-      type: 'error',
-      text:
-        notificationObject.response?.data?.detail ||
-        notificationObject.response?.data?.message ||
-        notificationObject,
-    });
-  }
-  return notificationObject;
+		return (payload) => {
+			notificationObject({ callback });
+			return payload;
+		};
+	}
+	if (notificationObject instanceof Error) {
+		apiServicesConfig.eventBus?.$emit('notification', {
+			type: 'error',
+			text:
+				notificationObject.response?.data?.detail ||
+				notificationObject.response?.data?.message ||
+				notificationObject,
+		});
+	}
+	return notificationObject;
 };
 
 export default notifyTransformer;

package/src/api/transformers/sanitize/sanitize.transformer.ts

@@ -1,12 +1,12 @@
 const sanitizeTransformer = (fieldsToSend) => (item) => {
-  return Object.keys(item).reduce((sanitizedItem, key) => {
-    if (fieldsToSend.indexOf(key) === -1) return sanitizedItem;
+	return Object.keys(item).reduce((sanitizedItem, key) => {
+		if (fieldsToSend.indexOf(key) === -1) return sanitizedItem;
 
-    return {
-      ...sanitizedItem,
-      [key]: item[key],
-    };
-  }, {});
+		return {
+			...sanitizedItem,
+			[key]: item[key],
+		};
+	}, {});
 };
 
 export default sanitizeTransformer;

package/src/api/transformers/skipIf/skipIf.ts

@@ -1,11 +1,11 @@
 export const skipIf =
-  (
-    transformer: (...payload: unknown[]) => unknown,
-    ifFn: boolean | ((...payload: unknown[]) => boolean),
-  ) =>
-  (payload: unknown) => {
-    if (typeof ifFn === 'function' ? ifFn(payload) : ifFn) {
-      return payload;
-    }
-    return transformer(payload);
-  };
+	(
+		transformer: (...payload: unknown[]) => unknown,
+		ifFn: boolean | ((...payload: unknown[]) => boolean),
+	) =>
+	(payload: unknown) => {
+		if (typeof ifFn === 'function' ? ifFn(payload) : ifFn) {
+			return payload;
+		}
+		return transformer(payload);
+	};

package/src/api/transformers/snakeToCamel/snakeToCamel.transformer.ts

@@ -1,5 +1,5 @@
-import { objSnakeToCamel } from '../../../scripts/caseConverters';
+import { objSnakeToCamel } from '../../../utils/api/caseConverters';
 
 const snakeToCamelTransformer = (skipKeys) => (obj) =>
-  objSnakeToCamel(obj, skipKeys);
+	objSnakeToCamel(obj, skipKeys);
 export default snakeToCamelTransformer;

package/src/api/transformers/starToSearch/starToSearch.transformer.ts

@@ -1,15 +1,13 @@
 import deepcopy from 'deep-copy';
-import get from 'lodash/get';
-
-import updateObject from '../../../scripts/updateObject';
+import { get, set } from 'lodash-es';
 
 const starToSearchTransformer =
-  (path = 'search') =>
-  (params) => {
-    const copy = deepcopy(params);
-    const value = get(copy, path);
-    if (!value || value.slice(-1) === '*') return copy;
-    return updateObject({ obj: copy, path, value: `${value}*` });
-  };
+	(path = 'search') =>
+	(params) => {
+		const copy = deepcopy(params);
+		const value = get(copy, path);
+		if (!value || value.slice(-1) === '*') return copy;
+		return set(copy, path, `${value}*`);
+	};
 
 export default starToSearchTransformer;

package/src/config/config.ts

@@ -0,0 +1,13 @@
+export type ApiServicesConfig = {
+	eventBus?: {
+		$emit: (event: string, payload: unknown) => unknown;
+	};
+};
+
+export const config: ApiServicesConfig = {
+	eventBus: null,
+};
+
+export const setConfig = (conf: ApiServicesConfig) => {
+	Object.assign(config, conf);
+};

package/src/gen/_docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/src/gen/_docs/html/assets/hierarchy.js

@@ -1 +1 @@
-window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzytWsqqurQUAmx4Kpg=="
+window.hierarchyData = 'eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzytWsqqurQUAmx4Kpg==';