@carecard/common-util 2.0.2 → 3.0.3

package/index.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Utility functions for object manipulation.
+ */
+export const util: {
+  /**
+   * Creates a new object containing only the specified properties from the source object.
+   * @param obj - The source object.
+   * @param arrayOfProperties - An array of property names to extract.
+   * @returns A new object with the extracted properties.
+   */
+  extractObjectWithProperties: (obj: any, arrayOfProperties: string[]) => Record<string, any>;
+};
+
+/**
+ * Application-level error handlers and throwers.
+ */
+export const error: {
+  /** Throws an Account_Suspended error. */
+  throwAccountSuspendedError: (userMessage?: string, details?: any) => never;
+  /** Throws an Account_Blocked error. */
+  throwAccountBlockedError: (userMessage?: string, details?: any) => never;
+  /** Throws an Account_Inactive error. */
+  throwAccountInactiveError: (userMessage?: string, details?: any) => never;
+  /** Middleware to handle 404 Not Found. */
+  notFound404: (req: any, res: any, next: any) => void;
+  /** Central application error handler middleware. */
+  appErrorHandler: (err: any, req: any, res: any, next: any) => void;
+  /** Throws a Validation_Failure error. */
+  throwValidationFailureError: (userMessage?: string, details?: any) => never;
+  /** Throws a Record_Exist error. */
+  throwRecordExistError: (userMessage?: string, details?: any) => never;
+  /** Throws a Wrong_Credentials error. */
+  throwWrongCredentialsError: (userMessage?: string, details?: any) => never;
+  /** Throws a Login_Required error. */
+  throwLoginRequiredError: (userMessage?: string, details?: any) => never;
+  /** Throws a Record_NotFound error. */
+  throwRecordNotFoundError: (userMessage?: string, details?: any) => never;
+  /** Throws a Record_NotSaved error. */
+  throwRecordNotSavedError: (userMessage?: string, details?: any) => never;
+  /** Throws an Update_Failed error. */
+  throwUpdateFailedError: (userMessage?: string, details?: any) => never;
+  /** Throws a Transaction_Failed error. */
+  throwTransactionFailedError: (userMessage?: string, details?: any) => never;
+  /** Throws a Used_Token error. */
+  throwUsedTokenError: (userMessage?: string, details?: any) => never;
+  /** Throws a Bad_Visitor_Token error. */
+  throwBadVisitorTokenError: (userMessage?: string, details?: any) => never;
+  /** Throws a File_Format_Not_Supported error. */
+  throwFileFormatNotSupportedError: (userMessage?: string, details?: any) => never;
+  /** Throws a Not_Authorized error. */
+  throwNotAuthorizedError: (userMessage?: string, details?: any) => never;
+  /** Throws a Bad_Input error. */
+  throwBadInputError: (userMessage?: string, details?: any) => never;
+  /** Throws an Input_Not_Uuid error. */
+  throwInputNotUuidError: (userMessage?: string, details?: any) => never;
+  /** Throws a File_Too_Large error. */
+  throwFileTooLargeError: (userMessage?: string, details?: any) => never;
+  /** Throws an Invalid_Time_Value error. */
+  throwInvalidTimeValueError: (userMessage?: string, details?: any) => never;
+};
+
+/**
+ * Utility functions for setting HTTP response status codes and headers.
+ */
+export const resCode: {
+  /** Sets 200 OK status and optionally an ETag header. */
+  setOk200: (res: any, ETag?: string) => any;
+  /** Sets 201 Created status. */
+  setCreated201: (res: any) => any;
+  /** Sets 400 Bad Request status. */
+  setBadRequest400ClientError: (res: any) => any;
+};

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@carecard/common-util",
-  "version": "2.0.2",
+  "version": "3.0.3",
   "repository": "https://github.com/CareCard-ca/pkg-common-util",
   "description": "Common utility for MVC framework",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
-    "test": "export NODE_ENV=test && mocha --watch --recursive"
+    "test": "export NODE_ENV=test && mocha --watch --recursive",
+    "test:types": "tsc --noEmit && mocha -r ts-node/register test/types.test.ts"
   },
   "keywords": [
     "validate",
@@ -14,8 +16,12 @@
   "author": "CareCard team",
   "license": "ISC",
   "devDependencies": {
+    "@types/mocha": "10.0.10",
+    "@types/node": "25.5.0",
     "mocha": "11.7.5",
-    "supertest": "7.1.4"
+    "supertest": "7.1.4",
+    "ts-node": "10.9.2",
+    "typescript": "5.9.3"
   },
   "dependencies": {
     "express": "5.1.0"