lesgo 0.7.8 → 2.1.0

package/dist/utils/s3/putObject.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 putObjectService from '../../services/S3Service/putObject';
+const putObject = (key, file, opts, clientOpts) =>
+  __awaiter(void 0, void 0, void 0, function* () {
+    return putObjectService(key, file, opts, clientOpts);
+  });
+export default putObject;

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

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

package/dist/utils/secretsmanager/getClient.js

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

package/dist/utils/secretsmanager/getSecretValue.d.ts

@@ -0,0 +1,4 @@
+import { GetSecretValueOptions } from '../../services/SecretsManagerService/getSecretValue';
+import { ClientOptions } from '../../types/aws';
+declare const getSecretValue: (secretId: string, opts?: GetSecretValueOptions, clientOpts?: ClientOptions) => Promise<any>;
+export default getSecretValue;

package/dist/utils/secretsmanager/getSecretValue.js

@@ -0,0 +1,68 @@
+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 { LesgoException } from '../../exceptions';
+import getSecretValueService from '../../services/SecretsManagerService/getSecretValue';
+import isEmpty from '../isEmpty';
+const FILE = 'lesgo.utils.secretsmanager.getSecretValue';
+const getSecretValue = (secretId, opts, clientOpts) =>
+  __awaiter(void 0, void 0, void 0, function* () {
+    let secretString;
+    try {
+      const { SecretString } = yield getSecretValueService(
+        secretId,
+        opts,
+        clientOpts
+      );
+      secretString = SecretString;
+    } catch (error) {
+      throw new LesgoException(
+        'Failed to get secret value',
+        `${FILE}::ERROR_GET_SECRET_VALUE`,
+        500
+      );
+    }
+    if (isEmpty(secretString)) {
+      throw new LesgoException(
+        'Missing secretString',
+        `${FILE}::SECRET_STRING_EMPTY`,
+        500
+      );
+    }
+    try {
+      return JSON.parse(secretString);
+    } catch (error) {
+      return secretString;
+    }
+  });
+export default getSecretValue;

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

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

package/dist/utils/secretsmanager/index.js

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

package/dist/utils/sqs/deleteMessage.d.ts

@@ -0,0 +1,5 @@
+import { DeleteMessageOptions } from '../../services/SQSService/deleteMessage';
+import { Queue } from '../../services/SQSService/getQueueUrl';
+import { ClientOptions } from '../../types/aws';
+export declare const deleteMessage: (queue: string | Queue, receiptHandle: string, opts?: DeleteMessageOptions, clientOpts?: ClientOptions) => Promise<void>;
+export default deleteMessage;

package/dist/utils/sqs/deleteMessage.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 deleteMessageService from '../../services/SQSService/deleteMessage';
+export const deleteMessage = (queue, receiptHandle, opts, clientOpts) =>
+  __awaiter(void 0, void 0, void 0, function* () {
+    return deleteMessageService(queue, receiptHandle, opts, clientOpts);
+  });
+export default deleteMessage;

package/dist/utils/sqs/dispatch.d.ts

@@ -0,0 +1,5 @@
+import { DispatchOptions } from '../../services/SQSService/dispatch';
+import { Queue } from '../../services/SQSService/getQueueUrl';
+import { ClientOptions } from '../../types/aws';
+export declare const dispatch: (payload: Record<any, any>, queue: string | Queue, opts?: DispatchOptions, clientOpts?: ClientOptions) => Promise<import("@aws-sdk/client-sqs").SendMessageCommandOutput>;
+export default dispatch;

package/dist/utils/sqs/dispatch.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 dispatchService from '../../services/SQSService/dispatch';
+export const dispatch = (payload, queue, opts, clientOpts) =>
+  __awaiter(void 0, void 0, void 0, function* () {
+    return dispatchService(payload, queue, opts, clientOpts);
+  });
+export default dispatch;

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

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

package/dist/utils/sqs/getClient.js

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

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

@@ -0,0 +1,4 @@
+export { default as deleteMessage } from './deleteMessage';
+export { default as dispatch } from './dispatch';
+export { default as getClient } from './getClient';
+export { default as receiveMessages } from './receiveMessages';

package/dist/utils/sqs/index.js

@@ -0,0 +1,4 @@
+export { default as deleteMessage } from './deleteMessage';
+export { default as dispatch } from './dispatch';
+export { default as getClient } from './getClient';
+export { default as receiveMessages } from './receiveMessages';

package/dist/utils/sqs/receiveMessages.d.ts

@@ -0,0 +1,5 @@
+import { ReceiveMessagesOptions } from '../../services/SQSService/receiveMessages';
+import { Queue } from '../../services/SQSService/getQueueUrl';
+import { ClientOptions } from '../../types/aws';
+export declare const receiveMessages: (queue: string | Queue, opts?: ReceiveMessagesOptions, clientOpts?: ClientOptions) => Promise<import("@aws-sdk/client-sqs").ReceiveMessageCommandOutput>;
+export default receiveMessages;

package/dist/utils/sqs/receiveMessages.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 receiveMessagesService from '../../services/SQSService/receiveMessages';
+export const receiveMessages = (queue, opts, clientOpts) =>
+  __awaiter(void 0, void 0, void 0, function* () {
+    return receiveMessagesService(queue, opts, clientOpts);
+  });
+export default receiveMessages;

package/dist/utils/validateFields.d.ts

@@ -0,0 +1,22 @@
+export type Params = {
+    [key: string]: any;
+};
+export type Field = {
+    key: string;
+    type: string;
+    required: boolean;
+    isCollection?: boolean;
+    enumValues?: string[];
+};
+/**
+ * Validates the fields of an object based on the provided validation rules.
+ *
+ * @param params - The object containing the fields to be validated.
+ * @param validFields - An array of field validation rules.
+ * @returns An object containing the validated fields.
+ * @throws {LesgoException} If a required field is missing or if a field has an invalid type.
+ */
+declare const validateFields: (params: Params, validFields: Field[]) => {
+    [key: string]: any;
+};
+export default validateFields;

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

@@ -1,30 +1,30 @@
 import LesgoException from '../exceptions/LesgoException';
 import isEmail from './isEmail';
 import isDecimal from './isDecimal';
-
-const FILE = 'Utils/validateFields';
-
-const isValidJSON = json => {
-  if (typeof json !== 'string') {
+const FILE = 'lesgo.utils.validateFields';
+const isValidJSON = jsonString => {
+  if (typeof jsonString !== 'string') {
     return false;
   }
-
-  // Cannot find a regex solution to this
   try {
-    JSON.parse(json);
-
+    JSON.parse(jsonString);
     return true;
-  } catch (_) {
+  } catch (err) {
     return false;
   }
 };
-
+/**
+ * Validates the fields of an object based on the provided validation rules.
+ *
+ * @param params - The object containing the fields to be validated.
+ * @param validFields - An array of field validation rules.
+ * @returns An object containing the validated fields.
+ * @throws {LesgoException} If a required field is missing or if a field has an invalid type.
+ */
 const validateFields = (params, validFields) => {
   const validated = {};
-
   validFields.forEach(field => {
     const { required, type, key, isCollection, enumValues = [] } = field;
-
     if (required) {
       if (typeof params[key] === 'object') {
         if (Array.isArray(params[key]) && params[key].length === 0) {
@@ -36,7 +36,6 @@ const validateFields = (params, validFields) => {
           );
         }
       }
-
       if (!params[key]) {
         if (typeof params[key] !== 'number') {
           throw new LesgoException(
@@ -48,7 +47,6 @@ const validateFields = (params, validFields) => {
         }
       }
     }
-
     if (isCollection) {
       try {
         validateFields({ [key]: params[key] }, [
@@ -63,7 +61,6 @@ const validateFields = (params, validFields) => {
         );
       }
     }
-
     (isCollection ? params[key] || [] : [params[key]]).forEach(paramsItem => {
       if (
         (type === 'string' &&
@@ -104,13 +101,10 @@ const validateFields = (params, validFields) => {
         );
       }
     });
-
     if (typeof params[key] !== 'undefined') {
       validated[key] = params[key];
     }
   });
-
   return validated;
 };
-
 export default validateFields;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "lesgo",
-  "version": "0.7.8",
+  "version": "2.1.0",
   "description": "Core framework for lesgo node.js serverless framework.",
-  "main": "./src/index.js",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "author": "Sufiyan Rahmat",
   "license": "MIT",
   "bugs": {
@@ -14,51 +15,153 @@
     "url": "git+https://github.com/reflex-media/lesgo-framework.git"
   },
   "files": [
-    "src",
+    "dist",
     "bin"
   ],
   "scripts": {
-    "pretest": "eslint .",
+    "pretest": "eslint 'src/**/*.{ts,tsx}'",
     "test": "jest",
     "coverage": "jest --coverage",
     "coveralls": "npm run coverage && cat ./coverage/lcov.info | coveralls",
-    "prepublishOnly": "npm run test",
-    "lint": "eslint '**/*.{js,ts,jsx,tsx}' --quiet",
-    "lint-fix": "eslint '**/*.{js,ts,jsx,tsx}' --fix"
+    "lint": "eslint 'src/**/*.{ts,tsx}' --quiet",
+    "lint:dist": "eslint 'dist/**/*.js' --fix --quiet",
+    "lint-fix": "eslint 'src/**/*.{js,ts,jsx,tsx}' --fix",
+    "format": "prettier --write 'dist/**/*.js'",
+    "build": "tsc && npm run format && npm run lint:dist",
+    "prepublishOnly": "npm run build"
   },
   "bin": {
     "lesgo-scripts": "./bin/lesgo-scripts.sh"
   },
-  "engines": {
-    "node": ">=12.0.0"
-  },
   "devDependencies": {
-    "@babel/cli": "^7.17.6",
-    "@babel/core": "^7.17.5",
-    "@babel/preset-env": "^7.16.11",
-    "aws-sdk": "^2.1084.0",
-    "babel-jest": "^24.9.0",
+    "@babel/cli": "^7.21.0",
+    "@babel/core": "^7.21.3",
+    "@babel/preset-env": "^7.20.2",
+    "@types/aws-lambda": "^8.10.140",
+    "@types/jest": "^29.5.12",
+    "@types/jsonwebtoken": "^9.0.6",
+    "@types/node": "^20.14.9",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
+    "aws-lambda": "^1.0.7",
+    "aws-sdk-client-mock": "^2.1.1",
+    "babel-jest": "^29.5.0",
     "coveralls": "^3.1.1",
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-config-prettier": "^6.15.0",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jest": "^22.21.0",
-    "eslint-plugin-prettier": "^3.4.1",
-    "husky": "^3.1.0",
-    "jest": "^24.9.0",
-    "lint-staged": "^9.5.0",
-    "prettier": "^1.19.1"
+    "eslint": "^8.57.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^8.10.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.3",
+    "jest": "^29.5.0",
+    "lint-staged": "^13.2.0",
+    "prettier": "^2.8.8",
+    "ts-jest": "^29.1.5",
+    "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@elastic/elasticsearch": "7.13.0",
-    "@firebase/app": "^0.7.17",
-    "data-api-client": "^1.2.0",
-    "firebase-admin": "^9.12.0",
-    "jsonwebtoken": "^8.5.1",
-    "memcache-plus": "^0.2.22",
-    "mysql2": "^2.3.3",
-    "nanoid": "^3.3.1"
+    "@aws-sdk/client-dynamodb": "^3.609.0",
+    "@aws-sdk/client-elasticache": "^3.620.0",
+    "@aws-sdk/client-s3": "^3.609.0",
+    "@aws-sdk/client-secrets-manager": "^3.616.0",
+    "@aws-sdk/client-sqs": "^3.609.0",
+    "@aws-sdk/credential-provider-node": "^3.609.0",
+    "@aws-sdk/lib-dynamodb": "^3.610.0",
+    "@aws-sdk/s3-request-presigner": "^3.609.0",
+    "@middy/core": "^5.4.3",
+    "@middy/do-not-wait-for-empty-event-loop": "^5.4.3",
+    "@middy/event-normalizer": "^5.4.3",
+    "@middy/http-event-normalizer": "^5.4.3",
+    "@middy/http-header-normalizer": "^5.4.3",
+    "@middy/http-json-body-parser": "^5.4.3",
+    "aws4": "^1.12.0",
+    "ioredis": "^5.4.1",
+    "jsonwebtoken": "^9.0.0",
+    "mysql2": "^3.10.3",
+    "nanoid": "^3.3.6"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./exceptions": {
+      "import": "./dist/exceptions/index.js",
+      "require": "./dist/exceptions/index.js"
+    },
+    "./middlewares": {
+      "import": "./dist/middlewares/index.js",
+      "require": "./dist/middlewares/index.js"
+    },
+    "./services/DynamoDbService": {
+      "import": "./dist/services/DynamoDbService/index.js",
+      "require": "./dist/services/DynamoDbService/index.js"
+    },
+    "./services/JWTService": {
+      "import": "./dist/services/JWTService/index.js",
+      "require": "./dist/services/JWTService/index.js"
+    },
+    "./services/RDSAuroraMySQLProxyService": {
+      "import": "./dist/services/RDSAuroraMySQLProxyService/index.js",
+      "require": "./dist/services/RDSAuroraMySQLProxyService/index.js"
+    },
+    "./services/S3Service": {
+      "import": "./dist/services/S3Service/index.js",
+      "require": "./dist/services/S3Service/index.js"
+    },
+    "./services/SecretsManagerService": {
+      "import": "./dist/services/SecretsManagerService/index.js",
+      "require": "./dist/services/SecretsManagerService/index.js"
+    },
+    "./services/SQSService": {
+      "import": "./dist/services/SQSService/index.js",
+      "require": "./dist/services/SQSService/index.js"
+    },
+    "./services/ElastiCacheRedisService": {
+      "import": "./dist/services/ElastiCacheRedisService/index.js",
+      "require": "./dist/services/ElastiCacheRedisService/index.js"
+    },
+    "./types": {
+      "import": "./dist/types/index.js",
+      "require": "./dist/types/index.js"
+    },
+    "./utils": {
+      "import": "./dist/utils/index.js",
+      "require": "./dist/utils/index.js"
+    },
+    "./utils/crypto": {
+      "import": "./dist/utils/crypto/index.js",
+      "require": "./dist/utils/crypto/index.js"
+    },
+    "./utils/jwt": {
+      "import": "./dist/utils/jwt/index.js",
+      "require": "./dist/utils/jwt/index.js"
+    },
+    "./utils/s3": {
+      "import": "./dist/utils/s3/index.js",
+      "require": "./dist/utils/s3/index.js"
+    },
+    "./utils/sqs": {
+      "import": "./dist/utils/sqs/index.js",
+      "require": "./dist/utils/sqs/index.js"
+    },
+    "./utils/dynamodb": {
+      "import": "./dist/utils/dynamodb/index.js",
+      "require": "./dist/utils/dynamodb/index.js"
+    },
+    "./utils/secretsmanager": {
+      "import": "./dist/utils/secretsmanager/index.js",
+      "require": "./dist/utils/secretsmanager/index.js"
+    },
+    "./utils/db/mysql/proxy": {
+      "import": "./dist/utils/db/mysql/proxy/index.js",
+      "require": "./dist/utils/db/mysql/proxy/index.js"
+    },
+    "./utils/cache/redis": {
+      "import": "./dist/utils/cache/redis/index.js",
+      "require": "./dist/utils/cache/redis/index.js"
+    }
   },
   "husky": {
     "hooks": {
@@ -71,5 +174,13 @@
       "npm run lint",
       "git add"
     ]
-  }
+  },
+  "engineStrict": true,
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "peerDependencies": {
+    "serverless": "^3.0.0"
+  },
+  "sideEffects": false
 }

package/CHANGELOG.md

@@ -1,9 +0,0 @@
-# Changes as of November 11, 2019:
- - Added DatabaseService
-   - where you could connect thru your own sql server (mysql, posgres and etc.)
- - Added ElasticSearchService
-   - this service provides a connection that can connect thru local or AWS' ElasticSearch as of the moment.
- - Added JwtService
-   - to validate jwt access token, and custom claims.
- - Added ElastiCacheService
-   - a service that can use memcached/redis for in-memory key-value search.

package/src/exceptions/__tests__/LesgoException.spec.js

@@ -1,24 +0,0 @@
-import LesgoException from '../LesgoException';
-
-describe('ExceptionsGroup: test LesgoException', () => {
-  it('test LesgoException with extra parameters', () => {
-    const lesgoException = new LesgoException(
-      'some message',
-      'LESGO_EXCEPTION',
-      411,
-      {
-        someParam: 'someValue',
-      }
-    );
-
-    expect(lesgoException).toMatchObject({
-      name: 'LesgoException',
-      message: 'some message',
-      statusCode: 411,
-      code: 'LESGO_EXCEPTION',
-      extra: {
-        someParam: 'someValue',
-      },
-    });
-  });
-});

package/src/exceptions/index.js

@@ -1,4 +0,0 @@
-import LesgoException from './LesgoException';
-
-// eslint-disable-next-line import/prefer-default-export
-export { LesgoException };

package/src/index.js

@@ -1,4 +0,0 @@
-export * from './exceptions';
-export * from './middlewares';
-export * from './services';
-export * from './utils';