lesgo 0.7.8 → 2.1.0

package/dist/utils/dynamodb/updateRecord.js

@@ -0,0 +1,53 @@
+var __awaiter =
+  (this && this.__awaiter) ||
+  function (thisArg, _arguments, P, generator) {
+    function adopt(value) {
+      return value instanceof P
+        ? value
+        : new P(function (resolve) {
+            resolve(value);
+          });
+    }
+    return new (P || (P = Promise))(function (resolve, reject) {
+      function fulfilled(value) {
+        try {
+          step(generator.next(value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function rejected(value) {
+        try {
+          step(generator['throw'](value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function step(result) {
+        result.done
+          ? resolve(result.value)
+          : adopt(result.value).then(fulfilled, rejected);
+      }
+      step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+  };
+import updateRecordService from '../../services/DynamoDbService/updateRecord';
+export const updateRecord = (
+  key,
+  tableAlias,
+  updateExpression,
+  expressionAttributeValues,
+  opts,
+  clientOpts
+) =>
+  __awaiter(void 0, void 0, void 0, function* () {
+    return updateRecordService(
+      key,
+      tableAlias,
+      updateExpression,
+      expressionAttributeValues,
+      opts,
+      clientOpts
+    );
+  });
+export default updateRecord;

package/dist/utils/formatUnixTimestamp.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Formats a Unix timestamp into a string representation.
+ *
+ * @param {number} timestamp - The Unix timestamp to format.
+ * @returns {string} The formatted timestamp string in UTC in the format "YYYY-MM-DD HH:MM:SS".
+ */
+declare const formatUnixTimestamp: (timestamp: number) => string;
+export default formatUnixTimestamp;

package/dist/utils/formatUnixTimestamp.js

@@ -0,0 +1,17 @@
+/**
+ * Formats a Unix timestamp into a string representation.
+ *
+ * @param {number} timestamp - The Unix timestamp to format.
+ * @returns {string} The formatted timestamp string in UTC in the format "YYYY-MM-DD HH:MM:SS".
+ */
+const formatUnixTimestamp = timestamp => {
+  const date = new Date(timestamp * 1000); // Convert to milliseconds
+  const year = date.getUTCFullYear();
+  const month = String(date.getUTCMonth() + 1).padStart(2, '0');
+  const day = String(date.getUTCDate()).padStart(2, '0');
+  const hours = String(date.getUTCHours()).padStart(2, '0');
+  const minutes = String(date.getUTCMinutes()).padStart(2, '0');
+  const seconds = String(date.getUTCSeconds()).padStart(2, '0');
+  return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`;
+};
+export default formatUnixTimestamp;

package/dist/utils/generateUid.d.ts

@@ -0,0 +1,13 @@
+export interface GenerateUidParams {
+    prefix?: string;
+    suffix?: string;
+    length?: number;
+}
+/**
+ * Generates a unique identifier with optional prefix, suffix, and length.
+ *
+ * @param params - The parameters for generating the unique identifier.
+ * @returns The generated unique identifier.
+ */
+declare const generateUid: (params?: GenerateUidParams) => string;
+export default generateUid;

package/{src → dist}/utils/generateUid.js

@@ -1,12 +1,17 @@
 import { customAlphabet } from 'nanoid';
-
-export default async (params = {}) => {
+/**
+ * Generates a unique identifier with optional prefix, suffix, and length.
+ *
+ * @param params - The parameters for generating the unique identifier.
+ * @returns The generated unique identifier.
+ */
+const generateUid = (params = {}) => {
   const { prefix, suffix, length } = params;
-
   const nanoid = customAlphabet(
     '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz',
     !length ? 21 : length
   );
-  const uid = await nanoid();
+  const uid = nanoid();
   return `${!prefix ? '' : `${prefix}-`}${uid}${!suffix ? '' : `-${suffix}`}`;
 };
+export default generateUid;

package/dist/utils/getCurrentDatetime.d.ts

@@ -0,0 +1,2 @@
+declare const getCurrentDatetime: () => string;
+export default getCurrentDatetime;

package/dist/utils/getCurrentDatetime.js

@@ -0,0 +1,4 @@
+const getCurrentDatetime = () => {
+  return new Date().toUTCString();
+};
+export default getCurrentDatetime;

package/dist/utils/getCurrentTimestamp.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns the current timestamp in seconds.
+ *
+ * @returns The current timestamp in seconds.
+ */
+declare const getCurrentTimestamp: () => number;
+export default getCurrentTimestamp;

package/dist/utils/getCurrentTimestamp.js

@@ -0,0 +1,9 @@
+/**
+ * Returns the current timestamp in seconds.
+ *
+ * @returns The current timestamp in seconds.
+ */
+const getCurrentTimestamp = () => {
+  return Math.floor(Date.now() / 1000);
+};
+export default getCurrentTimestamp;

package/dist/utils/getJwtSubFromAuthHeader.d.ts

@@ -0,0 +1,9 @@
+export declare const getTokenData: (authHeader: string) => any;
+/**
+ * Extracts the subject (sub) claim from the JWT token in the provided authorization header.
+ *
+ * @param authHeader - The authorization header containing the JWT token.
+ * @returns The subject (sub) claim from the JWT token, or null if the header is empty or the subject claim is not present.
+ */
+declare const getJwtSubFromAuthHeader: (authHeader: string) => any;
+export default getJwtSubFromAuthHeader;

package/dist/utils/getJwtSubFromAuthHeader.js

@@ -0,0 +1,24 @@
+import isEmpty from './isEmpty';
+export const getTokenData = authHeader => {
+  try {
+    return JSON.parse(
+      Buffer.from(authHeader.split('.')[1], 'base64').toString()
+    );
+  } catch (err) {
+    return {};
+  }
+};
+/**
+ * Extracts the subject (sub) claim from the JWT token in the provided authorization header.
+ *
+ * @param authHeader - The authorization header containing the JWT token.
+ * @returns The subject (sub) claim from the JWT token, or null if the header is empty or the subject claim is not present.
+ */
+const getJwtSubFromAuthHeader = authHeader => {
+  if (isEmpty(authHeader)) {
+    return null;
+  }
+  const data = getTokenData(authHeader);
+  return data.sub || null;
+};
+export default getJwtSubFromAuthHeader;

package/dist/utils/index.d.ts

@@ -0,0 +1,9 @@
+export { default as formatUnixTimestamp } from './formatUnixTimestamp';
+export { default as generateUid } from './generateUid';
+export { default as getCurrentDatetime } from './getCurrentDatetime';
+export { default as getCurrentTimestamp } from './getCurrentTimestamp';
+export { default as isDecimal } from './isDecimal';
+export { default as isEmail } from './isEmail';
+export { default as isEmpty } from './isEmpty';
+export { default as logger } from './logger';
+export { default as validateFields } from './validateFields';

package/dist/utils/index.js

@@ -0,0 +1,9 @@
+export { default as formatUnixTimestamp } from './formatUnixTimestamp';
+export { default as generateUid } from './generateUid';
+export { default as getCurrentDatetime } from './getCurrentDatetime';
+export { default as getCurrentTimestamp } from './getCurrentTimestamp';
+export { default as isDecimal } from './isDecimal';
+export { default as isEmail } from './isEmail';
+export { default as isEmpty } from './isEmpty';
+export { default as logger } from './logger';
+export { default as validateFields } from './validateFields';

package/dist/utils/isDecimal.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if a given number or string representation of a number is a decimal.
+ *
+ * @param number - The number or string representation of a number to check.
+ * @returns A boolean indicating whether the number is a decimal or not.
+ */
+declare const isDecimal: (number: number | string) => boolean;
+export default isDecimal;

package/dist/utils/isDecimal.js

@@ -0,0 +1,9 @@
+/**
+ * Checks if a given number or string representation of a number is a decimal.
+ *
+ * @param number - The number or string representation of a number to check.
+ * @returns A boolean indicating whether the number is a decimal or not.
+ */
+const isDecimal = number =>
+  typeof number !== 'string' && number.toString().indexOf('.') !== -1;
+export default isDecimal;

package/dist/utils/isEmail.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Checks if a given string is a valid email address.
+ *
+ * @param email - The email address to validate.
+ * @returns `true` if the email is valid, `false` otherwise.
+ * @throws {LesgoException} If the `email` parameter is empty.
+ */
+declare const isEmail: (email: string) => boolean;
+export default isEmail;

package/{src → dist}/utils/isEmail.js

@@ -1,15 +1,20 @@
 import isEmpty from './isEmpty';
 import LesgoException from '../exceptions/LesgoException';
-
-export default email => {
+/**
+ * Checks if a given string is a valid email address.
+ *
+ * @param email - The email address to validate.
+ * @returns `true` if the email is valid, `false` otherwise.
+ * @throws {LesgoException} If the `email` parameter is empty.
+ */
+const isEmail = email => {
   const pattern = /^[\w\-\.\+]+\@[a-zA-Z0-9\.\-]+\.[a-zA-z0-9]{2,5}$/; // eslint-disable-line no-useless-escape
-
   if (isEmpty(email)) {
     throw new LesgoException(
       'Empty parameter supplied',
       'IS_EMAIL_EMPTY_PARAMETER'
     );
   }
-
   return pattern.test(email);
 };
+export default isEmail;

package/dist/utils/isEmpty.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if a value is empty.
+ *
+ * @param value - The value to check.
+ * @returns Returns `true` if the value is empty, otherwise `false`.
+ */
+declare const isEmpty: (value: any) => boolean;
+export default isEmpty;

package/dist/utils/isEmpty.js

@@ -0,0 +1,19 @@
+/**
+ * Checks if a value is empty.
+ *
+ * @param value - The value to check.
+ * @returns Returns `true` if the value is empty, otherwise `false`.
+ */
+const isEmpty = value => {
+  if (value === undefined || value === null || value === '') {
+    return true;
+  }
+  if (Array.isArray(value) && value.length === 0) {
+    return true;
+  }
+  if (typeof value === 'object' && Object.keys(value).length === 0) {
+    return true;
+  }
+  return false;
+};
+export default isEmpty;

package/dist/utils/jwt/index.d.ts

@@ -0,0 +1,2 @@
+export { default as sign } from './sign';
+export { default as verify } from './verify';

package/dist/utils/jwt/index.js

@@ -0,0 +1,2 @@
+export { default as sign } from './sign';
+export { default as verify } from './verify';

package/dist/utils/jwt/sign.d.ts

@@ -0,0 +1,3 @@
+import { SignOptions } from 'jsonwebtoken';
+declare const sign: (payload: any, secret?: string, opts?: SignOptions) => string;
+export default sign;

package/dist/utils/jwt/sign.js

@@ -0,0 +1,5 @@
+import signService from '../../services/JWTService/sign';
+const sign = (payload, secret, opts) => {
+  return signService(payload, secret, opts);
+};
+export default sign;

package/dist/utils/jwt/verify.d.ts

@@ -0,0 +1,3 @@
+import { VerifyInputOptions } from '../../services/JWTService/verify';
+declare const verify: (token: string, secret?: string, opts?: VerifyInputOptions) => string | import("jsonwebtoken").JwtPayload | import("jsonwebtoken").Jwt;
+export default verify;

package/dist/utils/jwt/verify.js

@@ -0,0 +1,12 @@
+import verifyService from '../../services/JWTService/verify';
+import logger from '../logger';
+const FILE = 'lesgo.utils.jwt.verify';
+const verify = (token, secret, opts) => {
+  logger.debug(`${FILE}::REQUEST_RECEIVED`, { token, opts });
+  if (token.includes('Bearer')) {
+    token = token.replace('Bearer ', '');
+  }
+  const decoded = verifyService(token, secret, opts);
+  return decoded;
+};
+export default verify;

package/dist/utils/logger.d.ts

@@ -0,0 +1,20 @@
+import { LoggerService } from '../services';
+/**
+ * Logger module for handling application logs.
+ *
+ * @module logger
+ *
+ * @usage
+ * ```typescript
+ * import logger from './utils/logger';
+ *
+ * logger.error('This is an error message');
+ * logger.warn('This is a warning message');
+ * logger.info('This is an info message');
+ * logger.debug('This is a debug message');
+ * logger.notice('This is a notice message');
+ * logger.log('info', 'This is a log message');
+ * ```
+ */
+declare const logger: LoggerService;
+export default logger;

package/dist/utils/logger.js

@@ -0,0 +1,38 @@
+import appConfig from '../config/app';
+import { LoggerService } from '../services';
+const transports = [
+  {
+    logType: 'console',
+    level: appConfig.debug ? 'debug' : 'info',
+    config: {
+      getCreatedAt: true,
+      tags: {
+        env: appConfig.env,
+        service: appConfig.name,
+      },
+    },
+  },
+];
+const loggerOptions = {
+  defaultMeta: {},
+  transports,
+};
+/**
+ * Logger module for handling application logs.
+ *
+ * @module logger
+ *
+ * @usage
+ * ```typescript
+ * import logger from './utils/logger';
+ *
+ * logger.error('This is an error message');
+ * logger.warn('This is a warning message');
+ * logger.info('This is an info message');
+ * logger.debug('This is a debug message');
+ * logger.notice('This is a notice message');
+ * logger.log('info', 'This is a log message');
+ * ```
+ */
+const logger = new LoggerService(loggerOptions);
+export default logger;

package/dist/utils/s3/getClient.d.ts

@@ -0,0 +1,3 @@
+import { ClientOptions } from '../../types/aws';
+declare const getClient: (clientOpts?: ClientOptions) => import("@aws-sdk/client-s3").S3Client;
+export default getClient;

package/dist/utils/s3/getClient.js

@@ -0,0 +1,5 @@
+import getClientService from '../../services/S3Service/getClient';
+const getClient = clientOpts => {
+  return getClientService(clientOpts);
+};
+export default getClient;

package/dist/utils/s3/getDownloadSignedUrl.d.ts

@@ -0,0 +1,5 @@
+import { GetSignedUrlOptions } from '../../services/S3Service/getDownloadSignedUrl';
+import { GetObjectOptions } from '../../services/S3Service/getObject';
+import { ClientOptions } from '../../types/aws';
+declare const getDownloadSignedUrl: (key: string, opts?: GetObjectOptions, signingOpts?: GetSignedUrlOptions, clientOpts?: ClientOptions) => Promise<string>;
+export default getDownloadSignedUrl;

package/dist/utils/s3/getDownloadSignedUrl.js

@@ -0,0 +1,39 @@
+var __awaiter =
+  (this && this.__awaiter) ||
+  function (thisArg, _arguments, P, generator) {
+    function adopt(value) {
+      return value instanceof P
+        ? value
+        : new P(function (resolve) {
+            resolve(value);
+          });
+    }
+    return new (P || (P = Promise))(function (resolve, reject) {
+      function fulfilled(value) {
+        try {
+          step(generator.next(value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function rejected(value) {
+        try {
+          step(generator['throw'](value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function step(result) {
+        result.done
+          ? resolve(result.value)
+          : adopt(result.value).then(fulfilled, rejected);
+      }
+      step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+  };
+import getDownloadSignedUrlService from '../../services/S3Service/getDownloadSignedUrl';
+const getDownloadSignedUrl = (key, opts, signingOpts, clientOpts) =>
+  __awaiter(void 0, void 0, void 0, function* () {
+    return getDownloadSignedUrlService(key, opts, signingOpts, clientOpts);
+  });
+export default getDownloadSignedUrl;

package/dist/utils/s3/getHeadObject.d.ts

@@ -0,0 +1,10 @@
+import { HeadObjectOptions } from '../../services/S3Service/getHeadObject';
+import { ClientOptions } from '../../types/aws';
+declare const getHeadObject: (key: string, opts?: HeadObjectOptions, clientOpts?: ClientOptions) => Promise<{
+    LastModified: Date | undefined;
+    ContentLength: number | undefined;
+    ETag: string | undefined;
+    ContentType: string | undefined;
+    Metadata: Record<string, string> | undefined;
+}>;
+export default getHeadObject;

package/dist/utils/s3/getHeadObject.js

@@ -0,0 +1,39 @@
+var __awaiter =
+  (this && this.__awaiter) ||
+  function (thisArg, _arguments, P, generator) {
+    function adopt(value) {
+      return value instanceof P
+        ? value
+        : new P(function (resolve) {
+            resolve(value);
+          });
+    }
+    return new (P || (P = Promise))(function (resolve, reject) {
+      function fulfilled(value) {
+        try {
+          step(generator.next(value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function rejected(value) {
+        try {
+          step(generator['throw'](value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function step(result) {
+        result.done
+          ? resolve(result.value)
+          : adopt(result.value).then(fulfilled, rejected);
+      }
+      step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+  };
+import getHeadObjectService from '../../services/S3Service/getHeadObject';
+const getHeadObject = (key, opts, clientOpts) =>
+  __awaiter(void 0, void 0, void 0, function* () {
+    return getHeadObjectService(key, opts, clientOpts);
+  });
+export default getHeadObject;

package/dist/utils/s3/getObject.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+import { GetObjectOptions } from '../../services/S3Service/getObject';
+import { ClientOptions } from '../../types/aws';
+/**
+ * Retrieves an object from S3 based on the provided key.
+ *
+ * @param key - The key of the object to retrieve.
+ * @param opts - Optional parameters for retrieving the object.
+ * @param clientOpts - Optional client options for the S3 client.
+ * @returns A Promise that resolves to the body of the retrieved object.
+ */
+declare const getObject: (key: string, opts?: GetObjectOptions, clientOpts?: ClientOptions) => Promise<Buffer>;
+export default getObject;

package/dist/utils/s3/getObject.js

@@ -0,0 +1,51 @@
+var __awaiter =
+  (this && this.__awaiter) ||
+  function (thisArg, _arguments, P, generator) {
+    function adopt(value) {
+      return value instanceof P
+        ? value
+        : new P(function (resolve) {
+            resolve(value);
+          });
+    }
+    return new (P || (P = Promise))(function (resolve, reject) {
+      function fulfilled(value) {
+        try {
+          step(generator.next(value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function rejected(value) {
+        try {
+          step(generator['throw'](value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function step(result) {
+        result.done
+          ? resolve(result.value)
+          : adopt(result.value).then(fulfilled, rejected);
+      }
+      step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+  };
+import getObjectService, {
+  streamToBuffer,
+} from '../../services/S3Service/getObject';
+/**
+ * Retrieves an object from S3 based on the provided key.
+ *
+ * @param key - The key of the object to retrieve.
+ * @param opts - Optional parameters for retrieving the object.
+ * @param clientOpts - Optional client options for the S3 client.
+ * @returns A Promise that resolves to the body of the retrieved object.
+ */
+const getObject = (key, opts, clientOpts) =>
+  __awaiter(void 0, void 0, void 0, function* () {
+    const { Body } = yield getObjectService(key, opts, clientOpts);
+    const objectBody = yield streamToBuffer(Body);
+    return objectBody;
+  });
+export default getObject;

package/dist/utils/s3/getUploadSignedUrl.d.ts

@@ -0,0 +1,5 @@
+import { GetSignedUrlOptions } from '../../services/S3Service/getUploadSignedUrl';
+import { ClientOptions } from '../../types/aws';
+import { PutObjectOptions } from '../../services/S3Service/putObject';
+declare const getUploadSignedUrl: (key: string, opts?: PutObjectOptions, signingOpts?: GetSignedUrlOptions, clientOpts?: ClientOptions) => Promise<string>;
+export default getUploadSignedUrl;

package/dist/utils/s3/getUploadSignedUrl.js

@@ -0,0 +1,39 @@
+var __awaiter =
+  (this && this.__awaiter) ||
+  function (thisArg, _arguments, P, generator) {
+    function adopt(value) {
+      return value instanceof P
+        ? value
+        : new P(function (resolve) {
+            resolve(value);
+          });
+    }
+    return new (P || (P = Promise))(function (resolve, reject) {
+      function fulfilled(value) {
+        try {
+          step(generator.next(value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function rejected(value) {
+        try {
+          step(generator['throw'](value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function step(result) {
+        result.done
+          ? resolve(result.value)
+          : adopt(result.value).then(fulfilled, rejected);
+      }
+      step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+  };
+import getUploadSignedUrlService from '../../services/S3Service/getUploadSignedUrl';
+const getUploadSignedUrl = (key, opts, signingOpts, clientOpts) =>
+  __awaiter(void 0, void 0, void 0, function* () {
+    return getUploadSignedUrlService(key, opts, signingOpts, clientOpts);
+  });
+export default getUploadSignedUrl;

package/dist/utils/s3/index.d.ts

@@ -0,0 +1,6 @@
+export { default as getClient } from './getClient';
+export { default as getObject } from './getObject';
+export { default as getHeadObject } from './getHeadObject';
+export { default as getDownloadSignedUrl } from './getDownloadSignedUrl';
+export { default as getUploadSignedUrl } from './getUploadSignedUrl';
+export { default as putObject } from './putObject';

package/dist/utils/s3/index.js

@@ -0,0 +1,6 @@
+export { default as getClient } from './getClient';
+export { default as getObject } from './getObject';
+export { default as getHeadObject } from './getHeadObject';
+export { default as getDownloadSignedUrl } from './getDownloadSignedUrl';
+export { default as getUploadSignedUrl } from './getUploadSignedUrl';
+export { default as putObject } from './putObject';

package/dist/utils/s3/putObject.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="node" />
+import { PutObjectOptions } from '../../services/S3Service/putObject';
+import { ClientOptions } from '../../types/aws';
+declare const putObject: (key: string, file: Buffer | Uint8Array | Blob | string, opts?: PutObjectOptions, clientOpts?: ClientOptions) => Promise<import("@aws-sdk/client-s3").PutObjectCommandOutput>;
+export default putObject;