@solidxai/core 0.1.12 → 0.1.13-beta.2

package/dist/services/crud-helper.service.js

@@ -17,6 +17,8 @@ var UserIdFields;
     UserIdFields["CREATED_BY"] = "createdBy";
     UserIdFields["UPDATED_BY"] = "updatedBy";
 })(UserIdFields || (exports.UserIdFields = UserIdFields = {}));
+const SUPPORTED_FIELD_FUNCTIONS = ['COUNT', 'SUM', 'AVG', 'MIN', 'MAX'];
+const SUPPORTED_GRANULARITIES = ['day', 'week', 'month', 'year'];
 class CrudHelperService {
     constructor() {
         this.logger = new common_1.Logger(CrudHelperService.name);
@@ -61,6 +63,50 @@ class CrudHelperService {
             return matchingPermssions.length > 0;
         };
     }
+    resolveFieldPathFromMetadata(rootMetadata, pathParts, { allowRelationLeaf = false } = {}) {
+        if (!rootMetadata)
+            throw new common_1.BadRequestException(`Cannot resolve field '${this.describeInvalidField(pathParts?.join('.'))}'`);
+        if (!pathParts?.length || pathParts.some(part => !part)) {
+            throw new common_1.BadRequestException(`Invalid field path '${this.describeInvalidField(pathParts?.join('.'))}'`);
+        }
+        let metadata = rootMetadata;
+        const relationSegments = [];
+        for (let i = 0; i < pathParts.length; i++) {
+            const isLeaf = i === pathParts.length - 1;
+            const relation = metadata.findRelationWithPropertyPath(pathParts[i]);
+            const column = metadata.findColumnWithPropertyName(pathParts[i]);
+            if (!isLeaf) {
+                if (!relation) {
+                    throw new common_1.BadRequestException(`Invalid relation '${this.describeInvalidField(pathParts[i])}' in '${this.describeInvalidField(pathParts.join('.'))}'`);
+                }
+                relationSegments.push(relation.propertyName);
+                metadata = relation.inverseEntityMetadata;
+                continue;
+            }
+            if (allowRelationLeaf && relation) {
+                relationSegments.push(relation.propertyName);
+                return { relationSegments, leafIsRelation: true };
+            }
+            if (column) {
+                return { relationSegments, leafProperty: column.propertyName, leafIsRelation: false };
+            }
+            throw new common_1.BadRequestException(`Invalid field '${this.describeInvalidField(pathParts[i])}' in '${this.describeInvalidField(pathParts.join('.'))}'`);
+        }
+        throw new common_1.BadRequestException(`Invalid field path '${this.describeInvalidField(pathParts.join('.'))}'`);
+    }
+    resolveFieldPath(qb, pathParts, { allowRelationLeaf = false, startAlias } = {}) {
+        const aliasMetadata = startAlias ? this.findAliasMetadata(qb, startAlias) : undefined;
+        const rootMetadata = aliasMetadata ?? qb?.expressionMap?.mainAlias?.metadata;
+        return this.resolveFieldPathFromMetadata(rootMetadata, pathParts, { allowRelationLeaf });
+    }
+    findAliasMetadata(qb, alias) {
+        const found = qb?.expressionMap?.aliases?.find(a => a.name === alias);
+        return found?.hasMetadata ? found.metadata : undefined;
+    }
+    describeInvalidField(value) {
+        const text = String(value ?? '');
+        return text.length > 80 ? `${text.slice(0, 80)}...` : text;
+    }
     orderOptions(sort = []) {
         const orderOptions = {};
         sort.forEach((s) => {
@@ -106,26 +152,34 @@ class CrudHelperService {
                 const operatorOrField = Object.keys(normalizedPrimaryFilterObj)[0];
                 if (operatorOrField.startsWith('$')) {
                     const operator = operatorOrField;
+                    const { leafProperty } = this.resolveFieldPath(selectQb, [rawField], { startAlias: alias });
                     let columnExpression;
                     if (funcAlias) {
                         try {
-                            columnExpression = this.buildDateGranularityExpression(this.getDriver(selectQb), `${alias}.${rawField}`, funcAlias);
+                            columnExpression = this.buildDateGranularityExpression(this.getDriver(selectQb), `${alias}.${leafProperty}`, funcAlias);
                         }
-                        catch {
-                            throw new common_1.BadRequestException(`Unsupported field function '${funcAlias}'. Supported functions are: day, week, month, year.`);
+                        catch (error) {
+                            if (error instanceof common_1.BadRequestException)
+                                throw error;
+                            throw new common_1.BadRequestException(`Unsupported field function '${this.describeInvalidField(funcAlias)}'. Supported functions are: ${SUPPORTED_GRANULARITIES.join(', ')}.`);
                         }
                     }
-                    this.buildOperatorQuery(qb, alias, rawField, normalizedPrimaryFilterObj, operator, columnExpression);
+                    this.buildOperatorQuery(qb, alias, leafProperty, normalizedPrimaryFilterObj, operator, columnExpression);
                     return;
                 }
                 else {
                     if (funcAlias) {
                         throw new common_1.BadRequestException(`Function alias ':${funcAlias}' is not valid on relation field '${rawField}'. It can only be applied to scalar fields.`);
                     }
-                    const joinField = `${alias}.${rawField}`;
+                    const resolvedRelation = this.resolveFieldPath(selectQb, [rawField], { allowRelationLeaf: true, startAlias: alias });
+                    if (!resolvedRelation.leafIsRelation) {
+                        throw new common_1.BadRequestException(`'${this.describeInvalidField(rawField)}' is not a relation and cannot contain nested filters.`);
+                    }
+                    const relationName = resolvedRelation.relationSegments[resolvedRelation.relationSegments.length - 1];
+                    const joinField = `${alias}.${relationName}`;
                     if (!this.isRelationJoined(selectQb, joinField))
-                        selectQb.leftJoin(joinField, rawField);
-                    this.applyFilters(qb, primaryFilterObj, rawField, selectQb);
+                        selectQb.leftJoin(joinField, relationName);
+                    this.applyFilters(qb, primaryFilterObj, relationName, selectQb);
                 }
             });
         }
@@ -287,7 +341,7 @@ class CrudHelperService {
         }
         if (normalizedFields && normalizedFields.length) {
             qb.select(normalizedFields.map(field => {
-                return this.wrapFieldWithAlias(field, entityAlias);
+                return this.wrapFieldWithAlias(qb, field, entityAlias);
             }));
         }
         if (applySorting && normalizedSort && normalizedSort.length) {
@@ -309,7 +363,8 @@ class CrudHelperService {
                             qb.addSelect(orderColumn);
                     }
                     else {
-                        qb.addOrderBy(`${entityAlias}.${field}`, value);
+                        const { leafProperty } = this.resolveFieldPath(qb, [field]);
+                        qb.addOrderBy(`${entityAlias}.${leafProperty}`, value);
                     }
                 });
                 if (!hasExplicitIdSort) {
@@ -322,7 +377,7 @@ class CrudHelperService {
         }
         if (showSoftDeleted === 'exclusive') {
             qb.withDeleted();
-            qb.where(`${entityAlias}.deletedAt IS NOT NULL`);
+            qb.andWhere(`${entityAlias}.deletedAt IS NOT NULL`);
         }
         if (applyPagination) {
             if (limit)
@@ -359,13 +414,14 @@ class CrudHelperService {
         return existingJoin?.alias?.name;
     }
     ensureRelationPathJoined(qb, rootAlias, pathParts) {
+        const resolved = this.resolveFieldPath(qb, pathParts);
         const mainAlias = qb.expressionMap?.mainAlias?.name ||
             qb.expressionMap?.aliases?.find(a => a.metadata)?.name ||
             qb.expressionMap?.aliases?.[0]?.name;
         let parentAlias = mainAlias || rootAlias;
         let leafJoinCreated = false;
-        for (let i = 0; i < pathParts.length - 1; i++) {
-            const part = pathParts[i];
+        for (let i = 0; i < resolved.relationSegments.length; i++) {
+            const part = resolved.relationSegments[i];
             const joinProperty = `${parentAlias}.${part}`;
             const existingAlias = this.getExistingJoinAlias(qb, joinProperty);
             const joinAlias = existingAlias ?? this.sanitizeAlias(`${parentAlias}_${part}`);
@@ -378,12 +434,15 @@ class CrudHelperService {
             }
             parentAlias = joinAlias;
         }
-        return { alias: parentAlias, property: pathParts[pathParts.length - 1], created: leafJoinCreated };
+        return { alias: parentAlias, property: resolved.leafProperty, created: leafJoinCreated };
     }
     getDriver(qb) {
         return qb.connection.options.type;
     }
     buildDateGranularityExpression(driver, columnExpr, granularity) {
+        if (!SUPPORTED_GRANULARITIES.includes(granularity)) {
+            throw new common_1.BadRequestException(`Unsupported granularity '${this.describeInvalidField(granularity)}'. Supported granularities are: ${SUPPORTED_GRANULARITIES.join(', ')}.`);
+        }
         switch (driver) {
             case 'postgres':
             case 'cockroachdb':
@@ -494,7 +553,10 @@ class CrudHelperService {
             const orderOptions = this.orderOptions(normalizedSort);
             const orderOptionKeys = Object.keys(orderOptions);
             orderOptionKeys.forEach((key) => {
-                const resolvedKey = aliasMap[key] || key;
+                const resolvedKey = aliasMap[key];
+                if (!resolvedKey) {
+                    throw new common_1.BadRequestException(`Cannot sort by '${this.describeInvalidField(String(key))}' on a grouped query. Sort only by a groupBy or aggregate field.`);
+                }
                 const value = orderOptions[key];
                 qb.addOrderBy(`"${resolvedKey}"`, value);
             });
@@ -518,11 +580,15 @@ class CrudHelperService {
     }
     buildJoinQueryForRelation(qb, entityAlias, relation) {
         const relationParts = relation.split('.');
+        const { relationSegments, leafIsRelation } = this.resolveFieldPath(qb, relationParts, { allowRelationLeaf: true });
+        if (!leafIsRelation) {
+            throw new common_1.BadRequestException(`'${this.describeInvalidField(relation)}' is not a relation and cannot be populated.`);
+        }
         let parentAlias = entityAlias;
-        relationParts.forEach((part, i) => {
+        relationSegments.forEach((part, i) => {
             const joinProperty = `${parentAlias}.${part}`;
             if (!this.isRelationJoined(qb, joinProperty)) {
-                const joinAlias = relationParts.slice(0, i + 1).join('_');
+                const joinAlias = this.sanitizeAlias(relationSegments.slice(0, i + 1).join('_'));
                 qb.leftJoinAndSelect(joinProperty, joinAlias);
             }
             else {
@@ -532,13 +598,24 @@ class CrudHelperService {
         });
         return qb;
     }
-    wrapFieldWithAlias(field, entityAlias) {
-        if (!this.isAggregateField(field))
-            return `${entityAlias}.${field}`;
+    wrapFieldWithAlias(qb, field, entityAlias) {
+        if (!this.isAggregateField(field)) {
+            return `${entityAlias}.${this.resolveOwnColumn(qb, field, 'fields')}`;
+        }
         const fieldParts = field.split('(');
-        const aggregateFunction = fieldParts[0];
-        const fieldName = fieldParts[1].replace(')', '');
-        return `${aggregateFunction}(${entityAlias}.${fieldName})`;
+        const aggregateFunction = fieldParts[0].trim().toUpperCase();
+        if (!SUPPORTED_FIELD_FUNCTIONS.includes(aggregateFunction)) {
+            throw new common_1.BadRequestException(`Unsupported field function '${this.describeInvalidField(fieldParts[0])}'. Supported functions are: ${SUPPORTED_FIELD_FUNCTIONS.join(', ')}.`);
+        }
+        const fieldName = fieldParts[1].replace(')', '').trim();
+        return `${aggregateFunction}(${entityAlias}.${this.resolveOwnColumn(qb, fieldName, 'fields')})`;
+    }
+    resolveOwnColumn(qb, field, context) {
+        const resolved = this.resolveFieldPath(qb, field.split('.'));
+        if (resolved.relationSegments.length) {
+            throw new common_1.BadRequestException(`Related field '${this.describeInvalidField(field)}' is not supported in '${context}'. Use 'populate' to fetch related records.`);
+        }
+        return resolved.leafProperty;
     }
     isAggregateField(field) {
         return field.includes('(');