npm - @carecard/common-util - Versions diffs - 1.0.1 → 2.0.1 - Mend

@carecard/common-util 1.0.1 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

package/coverage/clover.xml +90 -0
package/coverage/coverage-final.json +5 -0
package/coverage/lcov-report/appErrorHandlers.ts.html +802 -0
package/coverage/lcov-report/base.css +224 -0
package/coverage/lcov-report/block-navigation.js +87 -0
package/coverage/lcov-report/favicon.png +0 -0
package/coverage/lcov-report/index.html +161 -0
package/coverage/lcov-report/index.ts.html +94 -0
package/coverage/lcov-report/prettify.css +1 -0
package/coverage/lcov-report/prettify.js +2 -0
package/coverage/lcov-report/responseStatus.ts.html +301 -0
package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
package/coverage/lcov-report/sorter.js +210 -0
package/coverage/lcov-report/utilityFunctions.ts.html +187 -0
package/coverage/lcov.info +194 -0
package/index.js +5 -0
package/lib/appErrorHandlers.js +264 -0
package/lib/responseStatus.js +77 -0
package/lib/untilityFunctions.js +18 -0
package/package.json +13 -45
package/readme.md +6 -2

package/coverage/lcov-report/utilityFunctions.ts.html ADDED Viewed

@@ -0,0 +1,187 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <title>Code coverage report for utilityFunctions.ts</title>
+    <meta charset="utf-8" />
+    <link rel="stylesheet" href="prettify.css" />
+    <link rel="stylesheet" href="base.css" />
+    <link rel="shortcut icon" type="image/x-icon" href="favicon.png" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style type='text/css'>
+        .coverage-summary .sorter {
+            background-image: url(sort-arrow-sprite.png);
+        }
+    </style>
+</head>
+<body>
+<div class='wrapper'>
+    <div class='pad1'>
+        <h1><a href="index.html">All files</a> utilityFunctions.ts</h1>
+        <div class='clearfix'>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">88.88% </span>
+                <span class="quiet">Statements</span>
+                <span class='fraction'>8/9</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">50% </span>
+                <span class="quiet">Branches</span>
+                <span class='fraction'>2/4</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Functions</span>
+                <span class='fraction'>1/1</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">88.88% </span>
+                <span class="quiet">Lines</span>
+                <span class='fraction'>8/9</span>
+            </div>
+        </div>
+        <p class="quiet">
+            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
+        </p>
+        <template id="filterTemplate">
+            <div class="quiet">
+                Filter:
+                <input type="search" id="fileSearch">
+            </div>
+        </template>
+    </div>
+    <div class='status-line high'></div>
+    <pre><table class="coverage">
+<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
+<a name='L2'></a><a href='#L2'>2</a>
+<a name='L3'></a><a href='#L3'>3</a>
+<a name='L4'></a><a href='#L4'>4</a>
+<a name='L5'></a><a href='#L5'>5</a>
+<a name='L6'></a><a href='#L6'>6</a>
+<a name='L7'></a><a href='#L7'>7</a>
+<a name='L8'></a><a href='#L8'>8</a>
+<a name='L9'></a><a href='#L9'>9</a>
+<a name='L10'></a><a href='#L10'>10</a>
+<a name='L11'></a><a href='#L11'>11</a>
+<a name='L12'></a><a href='#L12'>12</a>
+<a name='L13'></a><a href='#L13'>13</a>
+<a name='L14'></a><a href='#L14'>14</a>
+<a name='L15'></a><a href='#L15'>15</a>
+<a name='L16'></a><a href='#L16'>16</a>
+<a name='L17'></a><a href='#L17'>17</a>
+<a name='L18'></a><a href='#L18'>18</a>
+<a name='L19'></a><a href='#L19'>19</a>
+<a name='L20'></a><a href='#L20'>20</a>
+<a name='L21'></a><a href='#L21'>21</a>
+<a name='L22'></a><a href='#L22'>22</a>
+<a name='L23'></a><a href='#L23'>23</a>
+<a name='L24'></a><a href='#L24'>24</a>
+<a name='L25'></a><a href='#L25'>25</a>
+<a name='L26'></a><a href='#L26'>26</a>
+<a name='L27'></a><a href='#L27'>27</a>
+<a name='L28'></a><a href='#L28'>28</a>
+<a name='L29'></a><a href='#L29'>29</a>
+<a name='L30'></a><a href='#L30'>30</a>
+<a name='L31'></a><a href='#L31'>31</a>
+<a name='L32'></a><a href='#L32'>32</a>
+<a name='L33'></a><a href='#L33'>33</a>
+<a name='L34'></a><a href='#L34'>34</a>
+<a name='L35'></a><a href='#L35'>35</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">3x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-yes">2x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">2x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">2x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">// src/utilityFunctions.ts
+&nbsp;
+/**
+ * Create a new object containing only the properties listed in `arrayOfProperties`.
+ * Keeps the original behavior: only copies properties whose values are truthy.
+ *
+ * Example:
+ *   extractObjectWithProperties({ a: 1, b: 0, c: 'x' }, ['a', 'b', 'c'])
+ *   -&gt; { a: 1, c: 'x' }  // 'b' is omitted because 0 is falsy
+ */
+export function extractObjectWithProperties&lt;T extends Record&lt;string, unknown&gt;, K extends keyof T&gt;(
+  obj: T | null | undefined,
+  arrayOfProperties: ReadonlyArray&lt;K&gt;,
+): Partial&lt;Pick&lt;T, K&gt;&gt; {
+  // Initialize with the correct type to avoid "element implicitly has an 'any' type"
+  const returnObj: Partial&lt;Pick&lt;T, K&gt;&gt; = {};
+&nbsp;
+  // If obj is null/undefined, return an empty object
+  <span class="missing-if-branch" title="if path not taken" >I</span>if (!obj) {
+<span class="cstat-no" title="statement not covered" >    return returnObj;</span>
+  }
+&nbsp;
+  // Iterate using `for...of` to avoid lib/target issues with Array.prototype.find for older configs
+  for (const nameOfProperty of arrayOfProperties) {
+    const value = obj[nameOfProperty];
+    // Preserve original "truthy" filter: only copy if value is truthy
+    <span class="missing-if-branch" title="else path not taken" >E</span>if (value) {
+      // Assign with proper typing
+      returnObj[nameOfProperty] = value as T[K];
+    }
+  }
+&nbsp;
+  return returnObj;
+}
+&nbsp;</pre></td></tr></table></pre>
+                <div class='push'></div><!-- for sticky footer -->
+            </div><!-- /wrapper -->
+            <div class='footer quiet pad2 space-top1 center small'>
+                Code coverage generated by
+                <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
+                at 2025-12-24T01:50:18.316Z
+            </div>
+        <script src="prettify.js"></script>
+        <script>
+            window.onload = function () {
+                prettyPrint();
+            };
+        </script>
+        <script src="sorter.js"></script>
+        <script src="block-navigation.js"></script>
+    </body>
+</html>

package/coverage/lcov.info ADDED Viewed

@@ -0,0 +1,194 @@
+TN:
+SF:src/appErrorHandlers.ts
+FN:35,(anonymous_0)
+FN:140,throwAppError
+FN:149,(anonymous_2)
+FN:152,(anonymous_3)
+FN:155,(anonymous_4)
+FN:157,(anonymous_5)
+FN:160,(anonymous_6)
+FN:163,(anonymous_7)
+FN:166,(anonymous_8)
+FN:168,(anonymous_9)
+FN:171,(anonymous_10)
+FN:173,(anonymous_11)
+FN:176,(anonymous_12)
+FN:179,(anonymous_13)
+FN:182,(anonymous_14)
+FN:184,(anonymous_15)
+FN:187,(anonymous_16)
+FN:190,(anonymous_17)
+FN:197,notFound404
+FN:207,appErrorHandler
+FNF:20
+FNH:19
+FNDA:16,(anonymous_0)
+FNDA:16,throwAppError
+FNDA:1,(anonymous_2)
+FNDA:1,(anonymous_3)
+FNDA:1,(anonymous_4)
+FNDA:1,(anonymous_5)
+FNDA:1,(anonymous_6)
+FNDA:1,(anonymous_7)
+FNDA:1,(anonymous_8)
+FNDA:1,(anonymous_9)
+FNDA:1,(anonymous_10)
+FNDA:1,(anonymous_11)
+FNDA:1,(anonymous_12)
+FNDA:1,(anonymous_13)
+FNDA:1,(anonymous_14)
+FNDA:1,(anonymous_15)
+FNDA:1,(anonymous_16)
+FNDA:1,(anonymous_17)
+FNDA:0,notFound404
+FNDA:16,appErrorHandler
+DA:30,3
+DA:36,16
+DA:37,16
+DA:38,16
+DA:39,16
+DA:40,16
+DA:48,3
+DA:140,3
+DA:141,16
+DA:142,16
+DA:149,3
+DA:150,1
+DA:152,3
+DA:153,1
+DA:155,3
+DA:157,3
+DA:158,1
+DA:160,3
+DA:161,1
+DA:163,3
+DA:164,1
+DA:166,3
+DA:168,3
+DA:169,1
+DA:171,3
+DA:173,3
+DA:174,1
+DA:176,3
+DA:177,1
+DA:179,3
+DA:180,1
+DA:182,3
+DA:184,3
+DA:185,1
+DA:187,3
+DA:188,1
+DA:190,3
+DA:191,1
+DA:197,3
+DA:198,0
+DA:207,3
+DA:219,16
+DA:221,16
+DA:222,16
+DA:223,136
+DA:224,136
+DA:225,16
+DA:226,16
+DA:230,16
+DA:232,16
+LF:50
+LH:49
+BRDA:35,0,0,0
+BRDA:39,1,0,16
+BRDA:39,1,1,16
+BRDA:40,2,0,16
+BRDA:40,2,1,16
+BRDA:140,3,0,0
+BRDA:149,4,0,1
+BRDA:152,5,0,1
+BRDA:155,6,0,1
+BRDA:157,7,0,1
+BRDA:160,8,0,1
+BRDA:163,9,0,1
+BRDA:166,10,0,1
+BRDA:168,11,0,1
+BRDA:171,12,0,1
+BRDA:173,13,0,1
+BRDA:176,14,0,1
+BRDA:179,15,0,1
+BRDA:182,16,0,1
+BRDA:184,17,0,1
+BRDA:187,18,0,1
+BRDA:190,19,0,1
+BRDA:224,20,0,16
+BRDA:224,20,1,120
+BRDA:230,21,0,16
+BRDA:230,21,1,0
+BRDA:234,22,0,16
+BRDA:234,22,1,0
+BRDA:234,22,2,0
+BRDA:235,23,0,16
+BRDA:235,23,1,16
+BRDA:235,23,2,0
+BRDA:236,24,0,16
+BRDA:236,24,1,16
+BRF:34
+BRH:28
+end_of_record
+TN:
+SF:src/index.ts
+FNF:0
+FNH:0
+DA:1,3
+DA:2,3
+DA:3,3
+LF:3
+LH:3
+BRF:0
+BRH:0
+end_of_record
+TN:
+SF:src/responseStatus.ts
+FN:29,setOk200
+FN:55,setCreated201
+FN:69,setBadRequest400ClientError
+FNF:3
+FNH:3
+FNDA:1,setOk200
+FNDA:1,setCreated201
+FNDA:1,setBadRequest400ClientError
+DA:29,3
+DA:33,1
+DA:34,1
+DA:36,1
+DA:55,3
+DA:56,1
+DA:57,1
+DA:69,3
+DA:70,1
+DA:71,1
+LF:10
+LH:10
+BRF:0
+BRH:0
+end_of_record
+TN:
+SF:src/utilityFunctions.ts
+FN:11,extractObjectWithProperties
+FNF:1
+FNH:1
+FNDA:1,extractObjectWithProperties
+DA:11,3
+DA:16,1
+DA:19,1
+DA:20,0
+DA:24,1
+DA:25,2
+DA:27,2
+DA:29,2
+DA:33,1
+LF:9
+LH:8
+BRDA:19,0,0,0
+BRDA:19,0,1,1
+BRDA:27,1,0,2
+BRDA:27,1,1,0
+BRF:4
+BRH:2
+end_of_record

package/index.js ADDED Viewed

@@ -0,0 +1,5 @@
+module.exports = {
+    util: require( './lib/untilityFunctions' ),
+    error: require( './lib/appErrorHandlers' ),
+    resCode: require( './lib/responseStatus' )
+}

package/lib/appErrorHandlers.js ADDED Viewed

@@ -0,0 +1,264 @@
+'use strict';
+/**
+ * These are application level error handlers. All error responses should be send using these functions.
+ * These should be use in app.js file, not in controller files.
+ */
+module.exports = {
+    notFound404,
+    appErrorHandler,
+    throwValidationFailureError,
+    throwRecordExistError,
+    throwWrongCredentialsError,
+    throwLoginRequiredError,
+    throwRecordNotFoundError,
+    throwRecordNotSavedError,
+    throwUpdateFailedError,
+    throwTransactionFailedError,
+    throwUsedTokenError,
+    throwBadVisitorTokenError: throwVisitorTokenError,
+    throwFileFormatNotSupportedError,
+    throwNotAuthorizedError,
+    throwBadInputError,
+    throwInputNotUuidError,
+    throwFileTooLargeError,
+    throwInvalidTimeValueError
+}
+function notFound404( req, res, next ) {
+    res.status( 404 );
+    const response = {
+        error:
+            {
+                code: 'NOT_FOUND',
+                message: 'Not found',
+                details: null
+            }
+    }
+    res.send( response )
+}
+function appErrorHandler( err, req, res, next ) {
+    const response =
+        {
+            error:
+                {
+                    code: err.code ?? null,
+                    message: err.userMessage ?? null,
+                    details: err.details ?? null
+                }
+        };
+    switch ( err?.message ) {
+        case "Validation_Failure":
+            res.status( 401 );
+            res.send( response )
+            break;
+        case "Used_Token":
+        case "Wrong_Credentials":
+            res.status( 401 );
+            res.send( response )
+            break;
+        case "Bad_Visitor_Token":
+            res.status( 401 );
+            res.send( response )
+            break;
+        case "Record_NotSaved":
+            res.status( 400 );
+            res.send( response )
+            break;
+        case "Record_Exist":
+            res.status( 409 );
+            res.send( response )
+            break;
+        case "Record_NotFound":
+            res.status( 404 );
+            res.send( response )
+            break;
+        case "Update_Failed":
+            res.status( 400 );
+            res.send( response )
+            break;
+        case "Login_Required":
+            res.status( 401 );
+            res.send( response )
+            break;
+        case "Transaction_Failed":
+            res.status( 400 );
+            res.send( response )
+            break;
+        case "File_Format_Not_Supported":
+            res.status( 415 );
+            res.send( response )
+            break;
+        case "Not_Authorized":
+            res.status( 401 );
+            res.send( response )
+            break;
+        case "Bad_Input":
+            res.status( 400 );
+            res.send( response );
+            break;
+        case  "Input_Not_Uuid" :
+            res.status( 400 );
+            res.send( response )
+            break;
+        case "File too large":
+            res.status( 413 );
+            res.send( response )
+            break;
+        case "Invalid time value":
+            res.status( 403 );
+            res.send( response )
+            break;
+        default:
+            res.status( 500 );
+            res.send( response )
+    }
+}
+function throwValidationFailureError(params={}) {
+    const error = new Error( "Validation_Failure" );
+    error.code = "VALIDATION_FAILURE";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwWrongCredentialsError(params={}) {
+    const error = new Error( "Wrong_Credentials" );
+    error.code = "WRONG_CREDENTIALS";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwRecordExistError(params={}) {
+    const error = new Error( "Record_Exist" );
+    error.code = "RECORD_EXIST";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwRecordNotFoundError(params={}) {
+    const error = new Error( "Record_NotFound" );
+    error.code = "RECORD_NOT_FOUND";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwRecordNotSavedError(params={}) {
+    const error = new Error( "Record_NotSaved" );
+    error.code = "RECORD_NOT_SAVED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwLoginRequiredError(params={}) {
+    const error = new Error( "Login_Required" );
+    error.code = "LOGIN_REQUIRED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwUpdateFailedError(params={}) {
+    const error = new Error( "Update_Failed" );
+    error.code = "UPDATE_FAILED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwTransactionFailedError(params={}) {
+    const error = new Error( "Transaction_Failed" );
+    error.code = "TRANSACTION_FAILED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwUsedTokenError(params={}) {
+    const error = new Error( "Used_Token" );
+    error.code = "USED_TOKEN";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwVisitorTokenError(params={}) {
+    const error = new Error( "Bad_Visitor_Token" );
+    error.code = "BAD_VISITOR_TOKEN";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwFileFormatNotSupportedError(params={}) {
+    const error = new Error( "File_Format_Not_Supported" );
+    error.code = "FILE_FORMAT_NOT_SUPPORTED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwNotAuthorizedError(params={}) {
+    const error = new Error( "Not_Authorized" );
+    error.code = "NOT_AUTHORIZED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwBadInputError(params={}) {
+    const error = new Error( "Bad_Input" );
+    error.code = "BAD_INPUT";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwInputNotUuidError(params={}) {
+    const error = new Error( "Input_Not_Uuid" );
+    error.code = "INPUT_NOT_UUID";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwFileTooLargeError(params={}) {
+    const error = new Error( "File too large" );
+    error.code = "FILE_TOO_LARGE";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+function throwInvalidTimeValueError(params={}) {
+    const error = new Error( "Invalid time value" );
+    error.code = "INVALID_TIME_VALUE";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}