@common-stack/store-redis 8.2.5-alpha.33

package/lib/utils/redis-key-builder.js

@@ -0,0 +1,68 @@
+import { sanitizeKeyComponent } from './redis-key-sanitizer.js';
+
+/**
+ * Get application name from environment or config
+ * This will be replaced with actual config import during migration
+ */
+const getAppName = () => {
+    return process.env.APP_NAME || 'APP';
+};
+/**
+ * Build a standardized Redis key with proper formatting and sanitization
+ *
+ * Format: <APP_NAME>:<tenantId>:<namespace>:<segments...>
+ *
+ * @example
+ * buildRedisKey({
+ *   tenantId: 'tenant-123',
+ *   namespace: RedisNamespace.CACHE,
+ *   segments: ['user', 'profile']
+ * })
+ * // Returns: "APP_NAME:tenant-123:cache:user:profile"
+ */
+function buildRedisKey(options) {
+    const { tenantId = 'default', namespace, segments, userId } = options;
+    // Sanitize all components
+    const sanitizedTenantId = sanitizeKeyComponent(tenantId);
+    const sanitizedNamespace = sanitizeKeyComponent(namespace);
+    const sanitizedSegments = segments.map(sanitizeKeyComponent);
+    // Build key parts
+    const parts = [getAppName(), sanitizedTenantId, sanitizedNamespace, ...sanitizedSegments];
+    // Add userId if provided
+    if (userId) {
+        parts.splice(2, 0, sanitizeKeyComponent(userId));
+    }
+    return parts.join(':');
+}
+/**
+ * Build a Redis key pattern for wildcard matching
+ *
+ * @example
+ * buildRedisKeyPattern({
+ *   tenantId: 'tenant-123',
+ *   namespace: RedisNamespace.CACHE,
+ *   segments: ['user', '*']
+ * })
+ * // Returns: "APP_NAME:tenant-123:cache:user:*"
+ */
+function buildRedisKeyPattern(options) {
+    // Same as buildRedisKey but allows '*' in segments
+    return buildRedisKey(options);
+}
+/**
+ * Validate if a string is a valid Redis key
+ * Redis keys can be up to 512MB but should be kept reasonable
+ */
+function isValidRedisKey(key) {
+    // Basic validation rules
+    if (!key || key.length === 0)
+        return false;
+    if (key.length > 1024)
+        return false; // Reasonable limit
+    // Check for invalid characters after sanitization
+    // After sanitization, keys should only contain alphanumeric, colons, hyphens, underscores
+    const validPattern = /^[a-zA-Z0-9:_-]+$/;
+    return validPattern.test(key);
+}
+
+export { buildRedisKey, buildRedisKeyPattern, isValidRedisKey };

package/lib/utils/redis-key-sanitizer.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Sanitize a Redis key component to ensure it's valid and safe
+ *
+ * Redis keys can contain any binary sequence, but for best practices:
+ * - Avoid whitespace (spaces, tabs, newlines) - replace with underscores
+ * - Avoid control characters (0x00-0x1F, 0x7F) - remove them
+ * - Avoid quotes and backslashes that could cause escaping issues - remove them
+ * - Replace pipes (|) with hyphens since Auth0 userIds use pipes (auth0|123)
+ *
+ * @param component - The key component to sanitize
+ * @returns Sanitized key component
+ */
+export declare function sanitizeKeyComponent(component: string): string;
+/**
+ * Sanitize an entire Redis key (all components)
+ * Useful for keys that are already constructed
+ *
+ * @param key - The complete Redis key to sanitize
+ * @returns Sanitized Redis key
+ */
+export declare function sanitizeRedisKey(key: string): string;
+/**
+ * Escape special Redis pattern characters for exact matching
+ * Useful when you want to search for keys containing wildcards literally
+ * Note: Hyphens are not escaped as they're commonly used in keys
+ *
+ * @param pattern - The pattern to escape
+ * @returns Escaped pattern
+ */
+export declare function escapeRedisPattern(pattern: string): string;

package/lib/utils/redis-key-sanitizer.js

@@ -0,0 +1,54 @@
+/**
+ * Sanitize a Redis key component to ensure it's valid and safe
+ *
+ * Redis keys can contain any binary sequence, but for best practices:
+ * - Avoid whitespace (spaces, tabs, newlines) - replace with underscores
+ * - Avoid control characters (0x00-0x1F, 0x7F) - remove them
+ * - Avoid quotes and backslashes that could cause escaping issues - remove them
+ * - Replace pipes (|) with hyphens since Auth0 userIds use pipes (auth0|123)
+ *
+ * @param component - The key component to sanitize
+ * @returns Sanitized key component
+ */
+function sanitizeKeyComponent(component) {
+    if (!component)
+        return '';
+    return component
+        .trim() // Trim first to remove leading/trailing whitespace
+        .replace(/[\s\r\n\t]+/g, '_') // Replace whitespace with underscore
+        .replace(/\|/g, '-') // Replace pipe with hyphen (Auth0 userIds: auth0|123 → auth0-123)
+        .replace(/[\x00-\x1F\x7F]/g, '') // Remove control characters
+        .replace(/["'\\]/g, ''); // Remove quotes and backslashes
+}
+/**
+ * Sanitize an entire Redis key (all components)
+ * Useful for keys that are already constructed
+ *
+ * @param key - The complete Redis key to sanitize
+ * @returns Sanitized Redis key
+ */
+function sanitizeRedisKey(key) {
+    if (!key)
+        return '';
+    // Split by colon, sanitize each part, rejoin
+    return key
+        .split(':')
+        .map(sanitizeKeyComponent)
+        .filter((part) => part.length > 0)
+        .join(':');
+}
+/**
+ * Escape special Redis pattern characters for exact matching
+ * Useful when you want to search for keys containing wildcards literally
+ * Note: Hyphens are not escaped as they're commonly used in keys
+ *
+ * @param pattern - The pattern to escape
+ * @returns Escaped pattern
+ */
+function escapeRedisPattern(pattern) {
+    // Escape Redis KEYS pattern special characters: * ? [ ] ^ \
+    // Note: We don't escape hyphen (-) as it's not special outside character classes
+    return pattern.replace(/[*?[\]^\\]/g, '\\$&');
+}
+
+export { escapeRedisPattern, sanitizeKeyComponent, sanitizeRedisKey };

package/package.json

@@ -0,0 +1,58 @@
+{
+    "name": "@common-stack/store-redis",
+    "version": "8.2.5-alpha.33",
+    "description": "Redis store utilities and services for common-stack",
+    "license": "UNLICENSED",
+    "author": "CDMBase LLC",
+    "type": "module",
+    "main": "lib/index.js",
+    "module": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "files": [
+        "lib"
+    ],
+    "scripts": {
+        "build": "npm run build:clean && npm run build:lib",
+        "build:clean": "rimraf lib",
+        "build:lib": "rollup -c rollup.config.mjs",
+        "build:lib:watch": "npm run build:lib -- --watch",
+        "jest": "./node_modules/.bin/jest",
+        "prepublish": "npm run build",
+        "test": "cross-env ENV_FILE=../../config/test/test.env jest",
+        "test:debug": "npm test -- --runInBand",
+        "test:watch": "npm test -- --watch",
+        "watch": "npm run build:lib:watch"
+    },
+    "dependencies": {
+        "@common-stack/core": "8.2.5-alpha.15"
+    },
+    "devDependencies": {
+        "common": "8.2.5-alpha.15",
+        "ioredis": "^5.3.2"
+    },
+    "peerDependencies": {
+        "inversify": "*",
+        "ioredis": ">=5.0.0"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "cdecode": {
+        "common": {
+            "constants": [
+                "./${libDir}/templates/constants/SERVER_TYPES.ts.template"
+            ],
+            "repositories": [
+                "./${libDir}/templates/repositories/IRedisKeyBuilder.ts.template",
+                "./${libDir}/templates/repositories/IRedisStorageBackend.ts.template",
+                "./${libDir}/templates/repositories/IRedisCacheManager.ts.template",
+                "./${libDir}/templates/repositories/IRedisService.ts.template",
+                "./${libDir}/templates/repositories/redisCommonTypes.ts.template"
+            ]
+        }
+    },
+    "typescript": {
+        "definition": "lib/index.d.ts"
+    },
+    "gitHead": "5745649eba49ac589b9ace8c55378b6cbe130096"
+}