piper-utils 1.0.0

package/.babelrc

@@ -0,0 +1,12 @@
+{
+    "presets": [
+        [
+            "env",
+            {
+                "targets": {
+                    "node": "16"
+                }
+            }
+        ]
+    ]
+}

package/README.md

@@ -0,0 +1,119 @@
+### Piper-Utils
+
+This repository contains a collection of utilities for working with Cognito Lambda Sequelize and AWS
+
+### Installation
+ Import items using npm bitbucket link in package.json
+
+```
+"piper-utils":"git+ssh://git@bitbucket.org/kevinlbatchelor/piper-utils.git",
+```
+
+Add ssh key to repo to allow npm install to work
+
+
+### Publish
+
+```npm run build```
+- Tag and Commit
+
+### TEST
+```npm run test```
+
+#### accessRightsUtils
+
+- Takes an event object and returns a intersection list of requested businessIds and allowed businessIds
+
+```
+const businessIds = accessRightsUtils(event);
+```
+#### parseBody
+- Takes the event and returns the post body as a JSON object
+ 
+```
+const eventBody = parseBody(event);
+```
+#### getCurrentUser
+- Takes the event and returns an object with the current user's id and email 
+ 
+```
+const user = getCurrentUser(event);
+user = {id: '123', email: 'test@test.com'}
+```
+#### checkWriteAccess
+- Takes the event, looks for a businessId property in the event body, and returns the businessId if the user has write access to it. If the user does not have write access, it will throw an error. 
+ 
+```
+const businessId = checkWriteAccess(event);
+```
+#### createFilters
+- Takes the event and Sequelize object filter and creates a Sequelize where with applied filters 
+ 
+```
+const where = createFilters(event, partFilter);
+```
+#### createSort
+- Takes the event and sequelize object sort and creates a Sequelize order with applied sort 
+ 
+```
+const order = createSort(event, partSort);
+```
+#### createIncludes
+- Takes the event and sequelize object includes and creates a Sequelize includes from query string params 
+ 
+```
+const includes = createIncludes(event, partSort);
+```
+#### findAll
+- Takes a Sequelize object and options, wraps sequelize findAll in a try/catch, and returns the results with pagination and applies default options. Applies accessRightsUtils 
+ 
+```
+const part = await findAll(Part, {
+                where,
+                order,
+                offset,
+                limit
+            }
+        );
+```
+#### success
+- Takes json object and options. Returns a json object with the status code and the json object. Closes the database connection if it is open. Creates correct http response object and status code. 
+ 
+```
+const response = success(part, { dbClose });
+return success(part, { dbClose });
+
+//response
+{
+    statusCode: 200,
+    headers: {
+        'Access-Control-Allow-Origin': '*',
+        'Access-Control-Allow-Credentials': true
+    },
+    body: //JSON BODY
+}
+
+```
+#### failure
+- Takes error object and options. Returns a json object with the status code and the error object. Closes the database connection if it is open. Creates correct http response object and status code. Logs error to console. Reads out Sequelize errors, Axios and others to readable format. setts correct error message and error status code 
+ 
+```
+const response = failure(part, { dbClose });
+return failure(error, { dbClose });
+
+//error
+{
+    statusCode: 500, errorCode: '5XX', message: ''
+}
+
+//response
+{
+    statusCode: 500, headers: {
+        'Access-Control-Allow-Origin': '*',
+        'Access-Control-Allow-Credentials': true
+    }, body: '{"statusCode":500,"errorCode":"5XX","message":""}'
+}
+
+```
+
+