@plyaz/db 0.0.0

package/dist/utils/validation.d.ts

@@ -0,0 +1,146 @@
+/**
+ * @fileoverview Validation utilities for @plyaz/db package
+ *
+ * This module provides comprehensive validation functions for database operations
+ * including filter validation, table name validation, ID validation, and input sanitization.
+ *
+ * Part of the @plyaz/db package - a TypeScript database abstraction layer with
+ * support for multiple adapters (Drizzle, Supabase, SQL), extensions (audit, encryption,
+ * soft delete), and advanced features (caching, read replicas, multi-tenancy).
+ *
+ */
+import type { Filter } from "@plyaz/types/db";
+/**
+ * Validates a filter object for database queries
+ *
+ * Performs comprehensive validation of filter objects used across all database adapters
+ * (DrizzleAdapter, SupabaseAdapter, SQLAdapter). Ensures field names are safe from
+ * SQL injection and operators are supported.
+ *
+ * @param {Filter} filter - The filter object from @plyaz/types/db to validate
+ * @returns {boolean} True if the filter is valid and safe for database operations
+ *
+ * @example
+ * ```typescript
+ * import { validateFilter } from '@plyaz/db';
+ *
+ * // Valid filter for DatabaseService operations
+ * const validFilter = { field: 'user_name', operator: 'eq', value: 'john_doe' };
+ * console.log(validateFilter(validFilter)); // true
+ *
+ * // Invalid filter (unsafe field name)
+ * const invalidFilter = { field: 'user; DROP TABLE users;', operator: 'eq', value: 'test' };
+ * console.log(validateFilter(invalidFilter)); // false
+ * ```
+ *
+ */
+/**
+ * Valid database query operators supported across all adapters
+ *
+ * These operators are validated and supported by:
+ * - DrizzleAdapter: Maps to Drizzle ORM operators
+ * - SupabaseAdapter: Maps to Supabase query operators
+ * - SQLAdapter: Maps to raw SQL WHERE clause operators
+ *
+ * @constant {string[]} validOperators - List of supported query operators
+ */
+export declare const validOperators: string[];
+export declare function validateFilter(filter: Filter): boolean;
+/**
+ * Validates a database table name for all supported adapters
+ *
+ * Ensures table names are safe for use across DrizzleAdapter, SupabaseAdapter, and SQLAdapter.
+ * Follows PostgreSQL naming conventions (63 character limit) for maximum compatibility.
+ *
+ * Validation rules:
+ * - Must be a non-empty string
+ * - Must start with a letter or underscore
+ * - Can only contain letters, numbers, and underscores
+ * - Maximum length of 63 characters (PostgreSQL limit)
+ *
+ * @param {string} name - The table name to validate
+ * @returns {boolean} True if the table name is valid for database operations
+ *
+ * @example
+ * ```typescript
+ * import { validateTableName } from '@plyaz/db';
+ *
+ * // Valid table names for DatabaseService
+ * console.log(validateTableName('users')); // true
+ * console.log(validateTableName('user_profiles')); // true
+ * console.log(validateTableName('_audit_logs')); // true
+ *
+ * // Invalid table names
+ * console.log(validateTableName('123users')); // false - starts with number
+ * console.log(validateTableName('user-profiles')); // false - contains hyphen
+ * console.log(validateTableName('')); // false - empty string
+ * ```
+ *
+ */
+export declare function validateTableName(name: string): boolean;
+/**
+ * Validates a database record ID for all adapter operations
+ *
+ * Performs security validation of record IDs used in DatabaseService operations
+ * across all adapters. Prevents control character injection and ensures reasonable
+ * length limits for database performance.
+ *
+ * Validation rules:
+ * - Must be a non-empty string
+ * - Maximum length of 255 characters
+ * - No control characters (ASCII 0-31, 127)
+ *
+ * @param {string} id - The record ID to validate
+ * @returns {boolean} True if the ID is safe for database operations
+ *
+ * @example
+ * ```typescript
+ * import { validateId } from '@plyaz/db';
+ *
+ * // Valid IDs for DatabaseService.findById()
+ * console.log(validateId('user_123')); // true
+ * console.log(validateId('550e8400-e29b-41d4-a716-446655440000')); // true - UUID
+ * console.log(validateId('abc-def-123')); // true
+ *
+ * // Invalid IDs
+ * console.log(validateId('')); // false - empty
+ * console.log(validateId('id\x00injection')); // false - control character
+ * ```
+ *
+ */
+export declare function validateId(id: string): boolean;
+/**
+ * Sanitizes input strings to prevent SQL injection across all database adapters
+ *
+ * Provides defense-in-depth security for user input used in database operations.
+ * Used internally by SQLAdapter and as a fallback security measure for other adapters.
+ *
+ * **Security Note:** This function complements parameterized queries used by
+ * DrizzleAdapter and SupabaseAdapter. SQLAdapter uses this for additional protection.
+ *
+ * Escapes dangerous characters:
+ * - Null bytes, backspace, tab, newline, carriage return
+ * - Single and double quotes
+ * - Backslashes and percent signs
+ * - Control-Z character
+ *
+ * @param {string} input - The user input string to sanitize
+ * @returns {string} The sanitized string with escaped dangerous characters
+ * @throws {Error} If input is not a string or sanitization fails
+ *
+ * @example
+ * ```typescript
+ * import { sanitizeInput } from '@plyaz/db';
+ *
+ * // Sanitize user input before database operations
+ * const userInput = "Robert'); DROP TABLE users; --";
+ * const sanitized = sanitizeInput(userInput);
+ * console.log(sanitized); // "Robert\\'); DROP TABLE users; --"
+ *
+ * // Used internally by SQLAdapter for additional security
+ * const safeValue = sanitizeInput(userProvidedData);
+ * ```
+ *
+ */
+export declare function sanitizeInput(input: string): string;
+//# sourceMappingURL=validation.d.ts.map

package/dist/utils/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/utils/validation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAM9C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,UAa1B,CAAC;AAGF,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CA8EtD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAkCvD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAsC9C;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CA4DnD"}

package/package.json

@@ -0,0 +1,156 @@
+{
+  "name": "@plyaz/db",
+  "version": "0.0.0",
+  "description": "Package description",
+  "type": "module",
+  "keywords": [],
+  "packageManager": "pnpm@10.11.0",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.mjs"
+    },
+    "./security": {
+      "types": "./dist/security/index.d.ts",
+      "import": "./dist/security/index.mjs",
+      "require": "./dist/security/index.cjs",
+      "default": "./dist/security/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=22.4.0",
+    "pnpm": ">=8.0.0"
+  },
+  "author": "Redeemer Pace",
+  "license": "ISC",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@nestjs/common": "^11.1.3",
+    "@plyaz/config": "^1.7.12",
+    "@plyaz/errors": "^1.3.5",
+    "@plyaz/logger": "^1.3.2",
+    "@plyaz/testing": "^1.5.1",
+    "@plyaz/types": "^1.15.13",
+    "@supabase/supabase-js": "^2.75.0",
+    "drizzle-orm": "^0.44.6",
+    "ioredis": "^5.8.1",
+    "next": "15.4.7",
+    "pg": "^8.16.3",
+    "react": "^19.1.0",
+    "sanitize-html": "^2.17.0",
+    "zod": "^4.1.11"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.29.5",
+    "@darraghor/eslint-plugin-nestjs-typed": "^6.6.2",
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.15.0",
+    "@eslint/markdown": "^6.5.0",
+    "@next/eslint-plugin-next": "^15.0.3",
+    "@plyaz/devtools": "^1.8.5",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/react": "^16.3.0",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.14.0",
+    "@types/pg": "^8.15.5",
+    "@types/react": "^19.1.8",
+    "@types/react-dom": "^19.1.6",
+    "@types/sanitize-html": "^2.16.0",
+    "@typescript-eslint/eslint-plugin": "^8.15.0",
+    "@typescript-eslint/parser": "^8.15.0",
+    "@vitest/coverage-istanbul": "3.2.4",
+    "@vitest/coverage-v8": "^3.1.3",
+    "eslint": "^9.29.0",
+    "eslint-config-next": "^15.3.3",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.10.1",
+    "eslint-mdx": "^3.5.0",
+    "eslint-plugin-better-tailwindcss": "3.2.1",
+    "eslint-plugin-functional": "^4.4.1",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jest": "^28.13.5",
+    "eslint-plugin-jsdoc": "^50.8.0",
+    "eslint-plugin-jsonc": "^2.20.1",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-markdownlint": "^0.9.0",
+    "eslint-plugin-mdx": "^3.5.0",
+    "eslint-plugin-n": "^17.20.0",
+    "eslint-plugin-prettier": "^5.5.0",
+    "eslint-plugin-promise": "^7.2.1",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "eslint-plugin-react-refresh": "^0.4.19",
+    "eslint-plugin-regexp": "^2.9.0",
+    "eslint-plugin-security": "^3.0.1",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-sonarjs": "^0.23.0",
+    "eslint-plugin-storybook": "^0.12.0",
+    "eslint-plugin-testing-library": "^6.5.0",
+    "eslint-plugin-unicorn": "^56.0.1",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "jiti": "^2.4.2",
+    "jsdom": "^26.1.0",
+    "markdownlint": "^0.38.0",
+    "next": "15.3.3",
+    "prettier": "^3.5.3",
+    "standard-version": "^9.5.0",
+    "tailwindcss": "^4.1.8",
+    "tsup": "8.5.0",
+    "typescript": "^5",
+    "typescript-eslint": "^8.34.0",
+    "vite": "^6.3.5",
+    "vite-plugin-dts": "^4.5.3",
+    "vitest": "3.2.4"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    },
+    "next": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "pnpm clean && pnpm build:js && pnpm build:types",
+    "build:js": "tsup",
+    "build:types": "tsc -p tsconfig.build.json",
+    "build:watch": "tsup --watch",
+    "dev": "tsup --watch",
+    "lint": "eslint ./src ./tests",
+    "lint:fix": "eslint ./src ./tests --fix",
+    "format": "prettier --write './**/*.{ts,tsx,js,jsx}'",
+    "format:check": "prettier --check './**/*.{ts,tsx,js,jsx}'",
+    "type:check": "tsc --noEmit",
+    "test": "vitest run --no-watch",
+    "test:ci": "vitest run --no-watch",
+    "test:watch": "vitest --watch",
+    "test:coverage": "vitest run --coverage",
+    "test:ui": "vitest --ui",
+    "clean": "rm -rf dist",
+    "audit": "pnpm audit",
+    "audit:moderate": "pnpm audit --audit-level moderate",
+    "audit:high": "pnpm audit --audit-level high",
+    "audit:critical": "pnpm audit --audit-level critical",
+    "audit:fix": "pnpm audit --fix",
+    "audit:enhanced": "npx audit-ci --moderate",
+    "security:check": "pnpm audit:moderate && npx audit-ci --moderate",
+    "remove:unused": "pnpm remove:unused:fnc && pnpm remove:unused:interfaces",
+    "remove:unused:interfaces": "pnpm exec ./node_modules/@plyaz/devtools/scripts/check_types.ts --remove --report=./internal-reports/unused-types-report.md",
+    "remove:unused:fnc": "pnpm exec ./node_modules/@plyaz/devtools/scripts/check_fnc.ts --report=./internal-reports/unused-declarations.md",
+    "check:dependencies": "npx tsx ./node_modules/@plyaz/devtools/scripts/check_dependencies_versions.ts --report=./internal-reports/dependency-report.md",
+    "move:types": "npx tsx ./scripts/move_types.ts src/ --report=internal-reports/moved_types.md",
+    "move:constants": "npx tsx ./node_modules/@plyaz/devtools/scripts/move_constants.ts src/ --report=internal-reports/moved_consts.md"
+  }
+}