@ciscode/database-kit 1.0.0

package/dist/utils/validation.utils.js

@@ -0,0 +1,117 @@
+"use strict";
+// src/utils/validation.utils.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidMongoId = isValidMongoId;
+exports.isValidUuid = isValidUuid;
+exports.isPositiveInteger = isPositiveInteger;
+exports.sanitizeFilter = sanitizeFilter;
+exports.validateRequiredFields = validateRequiredFields;
+exports.pickFields = pickFields;
+exports.omitFields = omitFields;
+/**
+ * Utility functions for validation operations.
+ */
+/**
+ * Validates that a value is a valid MongoDB ObjectId string.
+ *
+ * @param id - The string to validate
+ * @returns True if valid ObjectId format
+ */
+function isValidMongoId(id) {
+    if (!id || typeof id !== 'string')
+        return false;
+    return /^[a-f\d]{24}$/i.test(id);
+}
+/**
+ * Validates that a value is a valid UUID (v4).
+ *
+ * @param id - The string to validate
+ * @returns True if valid UUID format
+ */
+function isValidUuid(id) {
+    if (!id || typeof id !== 'string')
+        return false;
+    return /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(id);
+}
+/**
+ * Validates that a value is a positive integer.
+ *
+ * @param value - The value to validate
+ * @returns True if positive integer
+ */
+function isPositiveInteger(value) {
+    if (typeof value === 'number') {
+        return Number.isInteger(value) && value > 0;
+    }
+    if (typeof value === 'string') {
+        const parsed = parseInt(value, 10);
+        return !isNaN(parsed) && parsed > 0 && String(parsed) === value;
+    }
+    return false;
+}
+/**
+ * Sanitizes a filter object by removing undefined and null values.
+ *
+ * @param filter - The filter object to sanitize
+ * @returns Sanitized filter object
+ */
+function sanitizeFilter(filter) {
+    const sanitized = {};
+    for (const [key, value] of Object.entries(filter)) {
+        if (value !== undefined && value !== null) {
+            sanitized[key] = value;
+        }
+    }
+    return sanitized;
+}
+/**
+ * Validates that all required fields are present in an object.
+ *
+ * @param obj - The object to validate
+ * @param requiredFields - Array of required field names
+ * @returns Object with isValid boolean and missing fields array
+ */
+function validateRequiredFields(obj, requiredFields) {
+    const missing = [];
+    for (const field of requiredFields) {
+        if (obj[field] === undefined || obj[field] === null || obj[field] === '') {
+            missing.push(field);
+        }
+    }
+    return {
+        isValid: missing.length === 0,
+        missing,
+    };
+}
+/**
+ * Extracts only allowed fields from an object.
+ * Useful for preventing mass assignment vulnerabilities.
+ *
+ * @param obj - The source object
+ * @param allowedFields - Array of allowed field names
+ * @returns New object with only allowed fields
+ */
+function pickFields(obj, allowedFields) {
+    const result = {};
+    for (const field of allowedFields) {
+        if (field in obj) {
+            result[field] = obj[field];
+        }
+    }
+    return result;
+}
+/**
+ * Omits specified fields from an object.
+ *
+ * @param obj - The source object
+ * @param fieldsToOmit - Array of field names to omit
+ * @returns New object without the omitted fields
+ */
+function omitFields(obj, fieldsToOmit) {
+    const result = { ...obj };
+    for (const field of fieldsToOmit) {
+        delete result[field];
+    }
+    return result;
+}
+//# sourceMappingURL=validation.utils.js.map

package/dist/utils/validation.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.utils.js","sourceRoot":"","sources":["../../src/utils/validation.utils.ts"],"names":[],"mappings":";AAAA,gCAAgC;;AAYhC,wCAGC;AAQD,kCAGC;AAQD,8CASC;AAQD,wCAYC;AASD,wDAgBC;AAUD,gCAaC;AASD,gCAWC;AAjID;;GAEG;AAEH;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,EAAU;IACvC,IAAI,CAAC,EAAE,IAAI,OAAO,EAAE,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAChD,OAAO,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,EAAU;IACpC,IAAI,CAAC,EAAE,IAAI,OAAO,EAAE,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAChD,OAAO,wEAAwE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC3F,CAAC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,KAAc;IAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;IAC9C,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACnC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC;IAClE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAC5B,MAAS;IAET,MAAM,SAAS,GAAe,EAAE,CAAC;IAEjC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACzC,SAAqC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACtD,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,sBAAsB,CACpC,GAA4B,EAC5B,cAAwB;IAExB,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE,CAAC;QACnC,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,SAAS,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;YACzE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IAED,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,MAAM,KAAK,CAAC;QAC7B,OAAO;KACR,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CACxB,GAAM,EACN,aAAuB;IAEvB,MAAM,MAAM,GAAe,EAAE,CAAC;IAE9B,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;QAClC,IAAI,KAAK,IAAI,GAAG,EAAE,CAAC;YAChB,MAAkC,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CACxB,GAAM,EACN,YAAsB;IAEtB,MAAM,MAAM,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;IAE1B,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;QACjC,OAAQ,MAAkC,CAAC,KAAK,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@ciscode/database-kit",
+  "version": "1.0.0",
+  "description": "A NestJS-friendly, OOP-style database library providing a unified repository API for MongoDB and PostgreSQL.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "MIT",
+  "author": "C International Service <info@ciscode.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/CISCODE-MA/DatabaseKit.git"
+  },
+  "homepage": "https://github.com/CISCODE-MA/DatabaseKit#readme",
+  "bugs": {
+    "url": "https://github.com/CISCODE-MA/DatabaseKit/issues"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
+    "build:watch": "tsc -w -p tsconfig.json",
+    "clean": "rm -rf dist",
+    "lint": "eslint 'src/**/*.ts'",
+    "lint:fix": "eslint 'src/**/*.ts' --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "database",
+    "mongodb",
+    "mongoose",
+    "postgres",
+    "postgresql",
+    "knex",
+    "repository",
+    "nestjs",
+    "nest",
+    "crud",
+    "orm",
+    "data-access",
+    "ciscode"
+  ],
+  "dependencies": {
+    "knex": "^3.1.0",
+    "mongoose": "^8.22.0",
+    "pg": "^8.18.0"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^10.0.0 || ^11.0.0",
+    "@nestjs/core": "^10.0.0 || ^11.0.0",
+    "reflect-metadata": "^0.2.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.28.0",
+    "@nestjs/common": "^11.1.12",
+    "@nestjs/core": "^11.1.12",
+    "@nestjs/testing": "^11.1.12",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.15.29",
+    "eslint": "^9.28.0",
+    "globals": "^16.2.0",
+    "jest": "^29.7.0",
+    "reflect-metadata": "^0.2.2",
+    "ts-jest": "^29.4.0",
+    "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.15",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.33.1"
+  },
+  "type": "commonjs",
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}