@comicrelief/lambda-wrapper 1.10.1 → 1.10.2

package/README.md

@@ -6,6 +6,8 @@
 
 When writing Serverless endpoints, we have found ourselves replicating a lot of boiler plate code to do basic actions, such as reading request variables or writing to SQS. The aim of this package is to provide a wrapper for our Lambda functions, to provide some level of dependency and configuration injection and to reduce time spent on project setup.
 
+> 🚀 [Lambda Wrapper v2 is now available in beta!](https://github.com/comicrelief/lambda-wrapper/tree/beta) This major release includes TypeScript support and some significant design changes.
+
 ## Installation & usage
 
 Install via npm:

package/dist/Config/Dependencies.js

@@ -4,19 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = exports.DEPENDENCIES = exports.DEFINITIONS = void 0;
-
 var _HTTP = _interopRequireDefault(require("../Service/HTTP.service"));
-
 var _Logger = _interopRequireDefault(require("../Service/Logger.service"));
-
 var _Request = _interopRequireDefault(require("../Service/Request.service"));
-
 var _SQS = _interopRequireDefault(require("../Service/SQS.service"));
-
 var _Timer = _interopRequireDefault(require("../Service/Timer.service"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const DEFINITIONS = {
   HTTP: 'HTTP',
   LOGGER: 'LOGGER',

package/dist/DependencyInjection/DependencyAware.class.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _DependencyInjection = _interopRequireDefault(require("./DependencyInjection.class"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * DependencyAwareClass Class
  */
@@ -21,27 +18,23 @@ class DependencyAwareClass {
   constructor(di) {
     this.di = di;
   }
+
   /**
    * Get Dependency Injection Container
    *
    * @returns {DependencyInjection}
    */
-
-
   getContainer() {
     return this.di;
   }
+
   /**
    * Shortcut for `this.getContainer().definitions`
    *
    * @returns {object}
    */
-
-
   get definitions() {
     return this.getContainer().definitions;
   }
-
 }
-
 exports.default = DependencyAwareClass;

package/dist/DependencyInjection/DependencyInjection.class.js

@@ -4,9 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _Dependencies = require("../Config/Dependencies");
-
 /**
  * DependencyInjection class
  */
@@ -23,13 +21,13 @@ class DependencyInjection {
     this.context = context;
     this.dependencies = {};
     this.configuration = configuration;
-
     for (let x = 0; x <= 1; x += 1) {
       // Iterate over lapper dependencies and add to container
       Object.keys(_Dependencies.DEFINITIONS).forEach(dependencyKey => {
         this.dependencies[dependencyKey] = new _Dependencies.DEPENDENCIES[dependencyKey](this);
-      }); // Iterate over child dependencies and add to container
+      });
 
+      // Iterate over child dependencies and add to container
       if (typeof configuration.DEPENDENCIES !== 'undefined') {
         Object.keys(configuration.DEPENDENCIES).forEach(dependencyKey => {
           this.dependencies[dependencyKey] = new configuration.DEPENDENCIES[dependencyKey](this);
@@ -37,81 +35,71 @@ class DependencyInjection {
       }
     }
   }
+
   /**
    * Get Dependency
    *
    * @param definition
    * @returns {*}
    */
-
-
   get(definition) {
     if (typeof this.dependencies[definition] === 'undefined') {
       throw new TypeError(`${definition} does not exist in di container`);
     }
-
     return this.dependencies[definition];
   }
+
   /**
    * Get Event
    *
    * @returns {*}
    */
-
-
   getEvent() {
     return this.event;
   }
+
   /**
    * Get Context
    *
    * @returns {*}
    */
-
-
   getContext() {
     return this.context;
   }
+
   /**
    * Get Configuration
    *
    * @param definition string
    * @returns {*}
    */
-
-
   getConfiguration(definition = null) {
     if (definition !== null && typeof this.configuration[definition] === 'undefined') {
       return null;
     }
-
     if (typeof this.configuration[definition] !== 'undefined') {
       return this.configuration[definition];
     }
-
     return this.configuration;
   }
+
   /**
    * Check whether the function
    * is being executed in a serverless-offline context
    *
    * @returns {boolean}
    */
-
-
   get isOffline() {
     const context = this.getContext() || {};
-
     if (!Object.prototype.hasOwnProperty.call(context, 'invokedFunctionArn')) {
       return true;
     }
-
     if (context.invokedFunctionArn.includes('offline')) {
       return true;
     }
-
     return !!process.env.USE_SERVERLESS_OFFLINE;
   }
+
   /**
    * Returns the definitions
    * associated to this DependencyInjection
@@ -120,12 +108,8 @@ class DependencyInjection {
    *
    * @returns {object}
    */
-
-
   get definitions() {
     return this.configuration.DEFINITIONS;
   }
-
 }
-
 exports.default = DependencyInjection;

package/dist/Model/CloudEvent.model.js

@@ -4,13 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _uuid = require("uuid");
-
 var _Model = _interopRequireDefault(require("./Model.model"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * CloudEventModel class
  * Class to implement cloud events - https://github.com/cloudevents/spec/blob/master/spec.md
@@ -30,127 +26,113 @@ class CloudEventModel extends _Model.default {
     this.contentType = 'application/json';
     this.data = {};
   }
+
   /**
    * Get Cloud Events Version
    *
    * @returns {number}
    */
-
-
   getCloudEventsVersion() {
     return this.cloudEventsVersion;
   }
+
   /**
    * Get event type
    *
    * @returns {string|*}
    */
-
-
   getEventType() {
     return this.eventType;
   }
+
   /**
    * Set event type
    *
    * @param value string
    */
-
-
   setEventType(value) {
     this.eventType = value;
   }
+
   /**
    * Get source
    *
    * @returns {string|*}
    */
-
-
   getSource() {
     return this.source;
   }
+
   /**
    * Set source
    *
    * @param value string
    */
-
-
   setSource(value) {
     this.source = value;
   }
+
   /**
    * Get event id
    *
    * @returns {*|string}
    */
-
-
   getEventID() {
     return this.eventID;
   }
+
   /**
    * Get event time
    *
    * @returns {*|string}
    */
-
-
   getEventTime() {
     return this.eventTime;
   }
+
   /**
    * Get extensions
    *
    * @returns {{}|*}
    */
-
-
   getExtensions() {
     return this.extensions;
   }
+
   /**
    * Set extensions
    *
    * @param value object
    */
-
-
   setExtensions(value) {
     this.extensions = value;
   }
+
   /**
    * Get content type
    *
    * @returns {string}
    */
-
-
   getContentType() {
     return this.contentType;
   }
+
   /**
    * Get data
    *
    * @returns {{}|*}
    */
-
-
   getData() {
     return this.data;
   }
+
   /**
    * Set data
    *
    * @param value object
    */
-
-
   setData(value) {
     this.data = value;
   }
-
 }
-
 exports.default = CloudEventModel;

package/dist/Model/Model.model.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _validate = _interopRequireDefault(require("validate.js/validate"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /* eslint-disable class-methods-use-this */
 
 /**
@@ -26,6 +23,7 @@ class Model {
       this[classFunctionName](value);
     }
   }
+
   /**
    * Validate values against constraints
    *
@@ -33,13 +31,9 @@ class Model {
    * @param constraints object
    * @returns {boolean}
    */
-
-
   validateAgainstConstraints(values, constraints) {
     const validation = (0, _validate.default)(values, constraints);
     return typeof validation === 'undefined';
   }
-
 }
-
 exports.default = Model;

package/dist/Model/Response.model.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = exports.RESPONSE_HEADERS = exports.DEFAULT_MESSAGE = void 0;
-
 var _Model = _interopRequireDefault(require("./Model.model"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  *
  * @type {object}
@@ -18,22 +15,20 @@ const RESPONSE_HEADERS = {
   'Access-Control-Allow-Origin': '*',
   // Required for CORS support to work
   'Access-Control-Allow-Credentials': true // Required for cookies, authorization headers with HTTPS
-
 };
+
 /**
  * Default message provided as part of response
  *
  * @type {string}
  */
-
 exports.RESPONSE_HEADERS = RESPONSE_HEADERS;
 const DEFAULT_MESSAGE = 'success';
+
 /**
  * class ResponseModel
  */
-
 exports.DEFAULT_MESSAGE = DEFAULT_MESSAGE;
-
 class ResponseModel extends _Model.default {
   /**
    * ResponseModel Constructor
@@ -50,74 +45,67 @@ class ResponseModel extends _Model.default {
     };
     this.code = code !== null ? code : {};
   }
+
   /**
    * Add or update a body variable
    *
    * @param variable
    * @param value
    */
-
-
   setBodyVariable(variable, value) {
     this.body[variable] = value;
   }
+
   /**
    * Set Data
    *
    * @param data
    */
-
-
   setData(data) {
     this.body.data = data;
   }
+
   /**
    * Set Status Code
    *
    * @param code
    */
-
-
   setCode(code) {
     this.code = code;
   }
+
   /**
    * Get Status Code
    *
    * @returns {*}
    */
-
-
   getCode() {
     return this.code;
   }
+
   /**
    * Set message
    *
    * @param message
    */
-
-
   setMessage(message) {
     this.body.message = message;
   }
+
   /**
    * Get Message
    *
    * @returns {string|*}
    */
-
-
   getMessage() {
     return this.body.message;
   }
+
   /**
    * Geneate a response
    *
    * @returns {object}
    */
-
-
   generate() {
     return {
       statusCode: this.code,
@@ -125,6 +113,7 @@ class ResponseModel extends _Model.default {
       body: JSON.stringify(this.body)
     };
   }
+
   /**
    * Shorthand static method
    * that generates the response immediately
@@ -138,13 +127,9 @@ class ResponseModel extends _Model.default {
    * @param {*} message
    * @returns {object}
    */
-
-
   static generate(data = null, code = null, message = null) {
     const response = new this(data, code, message);
     return response.generate();
   }
-
 }
-
 exports.default = ResponseModel;