@carecard/common-util 1.0.1 → 2.0.1

package/lib/responseStatus.js

@@ -0,0 +1,77 @@
+/**
+ *  The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.
+ *  It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full
+ *  response if the content was not changed. Additionally, etags help to prevent simultaneous updates of
+ *  a resource from overwriting each other ("mid-air collisions").
+ *
+ * If the resource at a given URL changes, a new Etag value must be generated. A comparison of them can
+ * determine whether two representations of a resource are the same. Etags are therefore similar to fingerprints, a
+ * nd might also be used for tracking purposes by some servers. They might also be set to persist indefinitely
+ * by a tracking server.
+ *
+ *  For example, when editing a wiki, the current wiki content may be hashed and put into an Etag header
+ *  in the response:
+ *
+ * ETag: "33a64df551425fcc55e4d42a148795d9f25f89d4"
+ *
+ * When saving changes to a wiki page (posting data), the POST request will contain the If-Match header containing
+ * the ETag values to check freshness against.
+ *
+ * If-Match: "33a64df551425fcc55e4d42a148795d9f25f89d4"
+ *
+ * If the hashes don't match, it means that the document has been edited in-between and a 412 Precondition Failed
+ * error is thrown.
+ *
+ * @param res
+ * @param ETag
+ * @returns {*}
+ */
+function setOk200( res, ETag ) {
+
+    res.set( { ETag: ETag } );
+    res.status( 200 );
+
+    return res;
+}
+
+/**
+ *    The 201 (Created) status code indicates that the request has been
+ *    fulfilled and has resulted in one or more new resources being
+ *    created.  The primary resource created by the request is identified
+ *    by either a Location header field in the response or, if no Location
+ *    field is received, by the effective request URI.
+ *
+ *    The 201 response payload typically describes and links to the
+ *    resource(s) created.  See
+ *    https://datatracker.ietf.org/doc/html/rfc7231#section-7.2
+ *    for a discussion of the meaning and purpose of validator header
+ *    fields, such as ETag and Last-Modified, in a 201 response.
+ *
+ * @param res
+ * @returns {*}
+ */
+function setCreated201( res ) {
+    res.status( 201 );
+    return res;
+}
+
+/**
+ *    The 400 (Bad Request) status code indicates that the server cannot or
+ *    will not process the request due to something that is perceived to be
+ *    a client error (e.g., malformed request syntax, invalid request
+ *    message framing, or deceptive request routing).
+ *
+ * @param res
+ * @returns {*}
+ */
+function setBadRequest400ClientError( res ) {
+    res.status( 400 );
+    return res;
+}
+
+module.exports = {
+    setOk200,
+    setCreated201,
+    setBadRequest400ClientError
+};
+

package/lib/untilityFunctions.js

@@ -0,0 +1,18 @@
+// Create new object only with properties given in array.
+function extractObjectWithProperties( obj, arrayOfProperties ) {
+    let returnObj = {};
+
+    arrayOfProperties.forEach( nameOfProperty => {
+        if ( obj?.[ nameOfProperty ] ) {
+            returnObj[ nameOfProperty ] = obj?.[ nameOfProperty ];
+        }
+    } );
+
+    return returnObj;
+}
+
+
+
+module.exports = {
+    extractObjectWithProperties
+};

package/package.json

@@ -1,55 +1,23 @@
 {
   "name": "@carecard/common-util",
-  "version": "1.0.1",
-  "private": false,
+  "version": "2.0.1",
+  "repository": "https://github.com/CareCard-ca/pkg-common-util",
   "description": "Common utility for MVC framework",
-  "license": "ISC",
-  "author": "PK Singh",
-  "repository": {
-    "type": "git",
-    "url": "git+https:github.com/CareCard-ca/pkg-common-util.git"
-  },
-  "type": "module",
-  "publishConfig": {
-    "access": "public"
-  },
-  "main": "./dist/cjs/index.cjs",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/esm/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.cjs",
-      "types": "./dist/esm/index.d.ts"
-    }
-  },
-  "files": [
-    "dist"
-  ],
+  "main": "index.js",
   "scripts": {
-    "build": "npm run build:esm && npm run build:cjs",
-    "build:esm": "tsc -p tsconfig.esm.json",
-    "build:cjs": "tsc -p tsconfig.cjs.json && node ./scripts/rename-cjs.js",
-    "test": "NODE_NO_WARNINGS=1 jest --coverage",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
-    "lint": "eslint",
-    "prepare": "husky"
+    "test": "export NODE_ENV=test && mocha --watch --recursive"
   },
+  "keywords": [
+    "validate",
+    "data"
+  ],
+  "author": "CareCard team",
+  "license": "ISC",
   "devDependencies": {
-    "@types/express": "5.0.6",
-    "@types/jest": "30.0.0",
-    "@types/supertest": "^6.0.3",
-    "eslint": "9.39.2",
-    "husky": "9.1.7",
-    "jest": "30.2.0",
-    "prettier": "3.7.4",
-    "supertest": "7.1.4",
-    "ts-jest": "29.4.6",
-    "typescript": "5.9.3",
-    "typescript-eslint": "8.50.1"
+    "mocha": "11.7.5",
+    "supertest": "7.1.4"
   },
   "dependencies": {
-    "express": "5.2.1"
+    "express": "5.1.0"
   }
 }

package/readme.md

@@ -1,3 +1,7 @@
-# pkg-common-util
+#Common Utility
+### Functions
 
-These are common utility functions for express application.
+Extract specific attributes from an object
+```js
+extractObjectWithProperties( obj, arrayOfProperties )
+```