sm-utility 1.4.4 → 2.1.0

package/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Packages below are not fully implemented yet
+// export * from './array';
+// export * from './string';
+__exportStar(require("./date"), exports);
+__exportStar(require("./general"), exports);
+__exportStar(require("./infrastructure"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./request"), exports);
+__exportStar(require("./stubs"), exports);

package/package.json

@@ -1,31 +1,28 @@
 {
   "name": "sm-utility",
-  "version": "1.4.4",
+  "version": "2.1.0",
   "description": "reusable utility codes for sm projects",
   "main": "index.js",
-  "types": "index.d.ts",
+  "types": "./index.d.ts",
+  "typings": "./index.d.ts",
   "scripts": {
-    "clean": "rm -rf general/ date/ string/ array/ logger/ request/ infrastructure/",
-    "build": "npm run clean && tsc",
-    "prepare": "npm run build",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "clean": "rm -rf dist",
+    "prebuild":"npm run clean",
+    "build": "tsc",
+    "postbuild": "npm run copy-files",
+    "copy-files": "copyfiles package.json README.md ./dist",
+    "publish-package": "npm run build && cd ./dist && npm publish"
   },
   "author": "Caio Poyares",
   "license": "ISC",
   "files": [
-    "/infrastructure",
-    "/general",
-    "/date",
-    "/string",
-    "/array",
-    "/logger",
-    "/request",
-    "/typings"
+    "*/**"
   ],
   "devDependencies": {
     "@types/express": "^4.17.11",
     "@types/node": "^14.14.40",
     "@types/uuid": "^8.3.1",
+    "copyfiles": "^2.4.1",
     "typescript": "^4.2.4"
   },
   "dependencies": {

package/request/index.d.ts

@@ -1,3 +1,9 @@
-import { AxiosInstance } from 'axios';
-import { RequestConfig } from './types';
-export declare function createApi(axiosConfig?: RequestConfig): AxiosInstance;
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
+declare module 'axios' {
+    interface AxiosRequestConfig {
+        meta?: Record<string, any>;
+        logRequest?: boolean;
+        logResponse?: boolean;
+    }
+}
+export declare function createApi(axiosConfig?: Omit<AxiosRequestConfig, "meta">): AxiosInstance;

package/request/index.js

@@ -10,7 +10,7 @@ const logger_1 = require("../logger");
 function createApi(axiosConfig) {
     const axiosApi = axios_1.default.create(axiosConfig);
     axiosApi.interceptors.request.use((request) => {
-        if (axiosConfig === null || axiosConfig === void 0 ? void 0 : axiosConfig.logRequests) {
+        if (request === null || request === void 0 ? void 0 : request.logRequest) {
             const { data, params, method } = request;
             const fullUrl = getFullUrlFromConfig(request);
             request.meta = request.meta || {};
@@ -21,7 +21,8 @@ function createApi(axiosConfig) {
         return request;
     });
     axiosApi.interceptors.response.use((response) => {
-        if (axiosConfig === null || axiosConfig === void 0 ? void 0 : axiosConfig.logRequests) {
+        var _a;
+        if ((_a = response.config) === null || _a === void 0 ? void 0 : _a.logResponse) {
             const { status, data, config } = response;
             const { method, meta } = config;
             const fullUrl = getFullUrlFromConfig(config);
@@ -30,12 +31,10 @@ function createApi(axiosConfig) {
         }
         return response;
     }, (error) => {
-        if (axiosConfig === null || axiosConfig === void 0 ? void 0 : axiosConfig.logRequests) {
-            const { config, message, response } = error;
-            const { method, meta } = config;
-            const fullUrl = getFullUrlFromConfig(config);
-            logError(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, response === null || response === void 0 ? void 0 : response.data, response === null || response === void 0 ? void 0 : response.status, message);
-        }
+        const { config, message, response } = error;
+        const { method, meta } = config;
+        const fullUrl = getFullUrlFromConfig(config);
+        logError(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, response === null || response === void 0 ? void 0 : response.data, response === null || response === void 0 ? void 0 : response.status, message);
         throw error;
     });
     return axiosApi;

package/stubs/index.d.ts

@@ -0,0 +1,46 @@
+declare type GenericClass<T> = (new (...args: any[]) => T);
+declare type UnwrapPromise<T> = T extends Promise<infer U> ? U : T;
+declare type TypesByMethodNames<T> = {
+    [K in keyof T]?: T[K] extends (...args: any[]) => infer R ? R : never;
+};
+declare type ResolvedTypesByMethodNames<T> = {
+    [K in keyof T]?: T[K] extends (...args: any[]) => infer R ? UnwrapPromise<R> : never;
+};
+/**
+ * Creates a mock instance of a given class with customized method implementations,
+ * where method return values are automatically unwrapped if they are promises.
+ * @example
+ * const userRepository = mockResolvedClass(UserRepository, {
+ *   findUserByToken: { token: 'adhf753', name: 'John' },
+ * });
+ * @param Class - The class to mock.
+ * @param givenMethods - An object containing customized key-value pairs where the key
+ * is the method name and the value is the resolved method value.
+ * @returns A mocked instance of the provided class with overridden methods.
+ */
+export declare function mockResolvedClass<T>(Class: GenericClass<T>, givenMethods?: ResolvedTypesByMethodNames<T>): T;
+/**
+ * Creates a mock instance of a given class with customized method implementations.
+ * @example
+ * const userRepository = mockClass(UserRepository, {
+ *   findUserByToken: Promise.resolve({ token: 'adhf753', name: 'John' }),
+ * });
+ * @param Class - The class to mock.
+ * @param methods - An object containing customized key-value pairs where the key
+ * is the method name and the value is the returned method value.
+ * @returns A mocked instance of the provided class with overridden methods.
+ */
+export declare function mockClass<T>(Class: GenericClass<T>, givenMethods?: TypesByMethodNames<T>): T;
+/**
+ * Creates a raw mock instance of a given class with no method implementations.
+ * This function is intended for use with testing frameworks like jest (spyOn) when
+ * you want to set up **manual** method spies. Alternatively, consider using
+ * {@link mockClass} or {@link mockResolvedClass} for more comprehensive method mocking.
+ * @example
+ * const rawUserRepository = rawInstance(UserRepository);
+ * jest.spyOn(rawUserRepository, 'findUserByToken').mockRejectedValue(new Error('Token expired'));
+ * @param Class - The class to mock.
+ * @returns A raw mocked instance of the provided class with no implemented methods.
+ */
+export declare function rawInstance<T>(Class: GenericClass<T>): T;
+export {};

package/stubs/index.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rawInstance = exports.mockClass = exports.mockResolvedClass = void 0;
+class MockedClassInstance {
+}
+;
+/**
+ * Creates a mock instance of a given class with customized method implementations,
+ * where method return values are automatically unwrapped if they are promises.
+ * @example
+ * const userRepository = mockResolvedClass(UserRepository, {
+ *   findUserByToken: { token: 'adhf753', name: 'John' },
+ * });
+ * @param Class - The class to mock.
+ * @param givenMethods - An object containing customized key-value pairs where the key
+ * is the method name and the value is the resolved method value.
+ * @returns A mocked instance of the provided class with overridden methods.
+ */
+function mockResolvedClass(Class, givenMethods) {
+    const MockedClass = rawInstance(Class);
+    if (!givenMethods)
+        return MockedClass;
+    for (const classMethod in givenMethods) {
+        const methodName = classMethod;
+        const mockImplementation = () => givenMethods[methodName];
+        MockedClass[methodName] = mockImplementation;
+    }
+    return MockedClass;
+}
+exports.mockResolvedClass = mockResolvedClass;
+/**
+ * Creates a mock instance of a given class with customized method implementations.
+ * @example
+ * const userRepository = mockClass(UserRepository, {
+ *   findUserByToken: Promise.resolve({ token: 'adhf753', name: 'John' }),
+ * });
+ * @param Class - The class to mock.
+ * @param methods - An object containing customized key-value pairs where the key
+ * is the method name and the value is the returned method value.
+ * @returns A mocked instance of the provided class with overridden methods.
+ */
+function mockClass(Class, givenMethods) {
+    const MockedClass = rawInstance(Class);
+    if (!givenMethods)
+        return MockedClass;
+    for (const classMethod in givenMethods) {
+        const methodName = classMethod;
+        const mockImplementation = () => givenMethods[methodName];
+        MockedClass[methodName] = mockImplementation;
+    }
+    return MockedClass;
+}
+exports.mockClass = mockClass;
+/**
+ * Creates a raw mock instance of a given class with no method implementations.
+ * This function is intended for use with testing frameworks like jest (spyOn) when
+ * you want to set up **manual** method spies. Alternatively, consider using
+ * {@link mockClass} or {@link mockResolvedClass} for more comprehensive method mocking.
+ * @example
+ * const rawUserRepository = rawInstance(UserRepository);
+ * jest.spyOn(rawUserRepository, 'findUserByToken').mockRejectedValue(new Error('Token expired'));
+ * @param Class - The class to mock.
+ * @returns A raw mocked instance of the provided class with no implemented methods.
+ */
+function rawInstance(Class) {
+    const MockedClass = new MockedClassInstance();
+    const classMethods = Object.getOwnPropertyNames(Class.prototype).filter(methodName => methodName !== 'constructor' &&
+        typeof Class.prototype[methodName] === 'function');
+    for (const classMethod of classMethods) {
+        const methodName = classMethod;
+        const mockImplementation = () => {
+            throw new Error(`Method ${classMethod} not implemented`);
+        };
+        MockedClass[methodName] = mockImplementation;
+    }
+    return MockedClass;
+}
+exports.rawInstance = rawInstance;

package/request/types.d.ts

@@ -1,5 +0,0 @@
-import { AxiosRequestConfig } from 'axios';
-export interface RequestConfig extends AxiosRequestConfig {
-    meta?: Record<string, any>;
-    logRequests?: boolean;
-}

package/request/types.js

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