@deenruv/core 1.0.0

package/dist/service/helpers/list-query-builder/parse-filter-params.js

@@ -0,0 +1,209 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseFilterParams = void 0;
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const DateUtils_1 = require("typeorm/util/DateUtils");
+const errors_1 = require("../../../common/error/errors");
+const connection_utils_1 = require("./connection-utils");
+const get_calculated_columns_1 = require("./get-calculated-columns");
+function parseFilterParams(connection, entity, filterParams, customPropertyMap, entityAlias) {
+    if (!filterParams) {
+        return [];
+    }
+    const { columns, translationColumns, alias: defaultAlias, } = (0, connection_utils_1.getColumnMetadata)(connection, entity);
+    const alias = entityAlias !== null && entityAlias !== void 0 ? entityAlias : defaultAlias;
+    const calculatedColumns = (0, get_calculated_columns_1.getCalculatedColumns)(entity);
+    const dbType = connection.options.type;
+    let argIndex = 1;
+    function buildConditionsForField(key, operation) {
+        const output = [];
+        const calculatedColumnDef = calculatedColumns.find((c) => c.name === key);
+        const instruction = calculatedColumnDef === null || calculatedColumnDef === void 0 ? void 0 : calculatedColumnDef.listQuery;
+        const calculatedColumnExpression = instruction === null || instruction === void 0 ? void 0 : instruction.expression;
+        for (const [operator, operand] of Object.entries(operation)) {
+            let fieldName;
+            if (columns.find((c) => c.propertyName === key)) {
+                fieldName = `${alias}.${key}`;
+            }
+            else if (translationColumns.find((c) => c.propertyName === key)) {
+                const translationsAlias = [alias, "translations"].join("__");
+                fieldName = `${translationsAlias}.${key}`;
+            }
+            else if (calculatedColumnExpression) {
+                fieldName = (0, connection_utils_1.escapeCalculatedColumnExpression)(connection, calculatedColumnExpression);
+            }
+            else if (customPropertyMap === null || customPropertyMap === void 0 ? void 0 : customPropertyMap[key]) {
+                fieldName = customPropertyMap[key];
+            }
+            else {
+                throw new errors_1.UserInputError("error.invalid-filter-field");
+            }
+            const condition = buildWhereCondition(fieldName, operator, operand, argIndex, dbType);
+            output.push(condition);
+            argIndex++;
+        }
+        return output;
+    }
+    function processFilterParameter(param) {
+        const result = [];
+        for (const [key, operation] of Object.entries(param)) {
+            if (key === "_and" || key === "_or") {
+                result.push({
+                    operator: key === "_and" ? generated_types_1.LogicalOperator.AND : generated_types_1.LogicalOperator.OR,
+                    conditions: operation.map((o) => processFilterParameter(o)).flat(),
+                });
+            }
+            else if (operation && !Array.isArray(operation)) {
+                result.push(...buildConditionsForField(key, operation));
+            }
+        }
+        return result;
+    }
+    const conditions = processFilterParameter(filterParams);
+    return conditions;
+}
+exports.parseFilterParams = parseFilterParams;
+function buildWhereCondition(fieldName, operator, operand, argIndex, dbType) {
+    switch (operator) {
+        case "eq":
+            return {
+                clause: `${fieldName} = :arg${argIndex}`,
+                parameters: { [`arg${argIndex}`]: convertDate(operand) },
+            };
+        case "notEq":
+            return {
+                clause: `${fieldName} != :arg${argIndex}`,
+                parameters: { [`arg${argIndex}`]: convertDate(operand) },
+            };
+        case "inList":
+        case "contains": {
+            const LIKE = dbType === "postgres" ? "ILIKE" : "LIKE";
+            return {
+                clause: `${fieldName} ${LIKE} :arg${argIndex}`,
+                parameters: {
+                    [`arg${argIndex}`]: `%${typeof operand === "string" ? operand.trim() : operand}%`,
+                },
+            };
+        }
+        case "notContains": {
+            const LIKE = dbType === "postgres" ? "ILIKE" : "LIKE";
+            return {
+                clause: `${fieldName} NOT ${LIKE} :arg${argIndex}`,
+                parameters: { [`arg${argIndex}`]: `%${operand.trim()}%` },
+            };
+        }
+        case "in": {
+            if (Array.isArray(operand) && operand.length) {
+                return {
+                    clause: `${fieldName} IN (:...arg${argIndex})`,
+                    parameters: { [`arg${argIndex}`]: operand },
+                };
+            }
+            else {
+                // "in" with an empty set should always return nothing
+                return {
+                    clause: "1 = 0",
+                    parameters: {},
+                };
+            }
+        }
+        case "notIn": {
+            if (Array.isArray(operand) && operand.length) {
+                return {
+                    clause: `${fieldName} NOT IN (:...arg${argIndex})`,
+                    parameters: { [`arg${argIndex}`]: operand },
+                };
+            }
+            else {
+                // "notIn" with an empty set should always return all
+                return {
+                    clause: "1 = 1",
+                    parameters: {},
+                };
+            }
+        }
+        case "regex":
+            return {
+                clause: getRegexpClause(fieldName, argIndex, dbType),
+                parameters: { [`arg${argIndex}`]: operand },
+            };
+        case "lt":
+        case "before":
+            return {
+                clause: `${fieldName} < :arg${argIndex}`,
+                parameters: { [`arg${argIndex}`]: convertDate(operand) },
+            };
+        case "gt":
+        case "after":
+            return {
+                clause: `${fieldName} > :arg${argIndex}`,
+                parameters: { [`arg${argIndex}`]: convertDate(operand) },
+            };
+        case "lte":
+            return {
+                clause: `${fieldName} <= :arg${argIndex}`,
+                parameters: { [`arg${argIndex}`]: operand },
+            };
+        case "gte":
+            return {
+                clause: `${fieldName} >= :arg${argIndex}`,
+                parameters: { [`arg${argIndex}`]: operand },
+            };
+        case "between":
+            return {
+                clause: `${fieldName} BETWEEN :arg${argIndex}_a AND :arg${argIndex}_b`,
+                parameters: {
+                    [`arg${argIndex}_a`]: convertDate(operand.start),
+                    [`arg${argIndex}_b`]: convertDate(operand.end),
+                },
+            };
+        case "isNull":
+            return {
+                clause: operand === true
+                    ? `${fieldName} IS NULL`
+                    : `${fieldName} IS NOT NULL`,
+                parameters: {},
+            };
+        default:
+            (0, shared_utils_1.assertNever)(operator);
+    }
+    return {
+        clause: "1",
+        parameters: {},
+    };
+}
+/**
+ * Converts a JS Date object to a string format recognized by all DB engines.
+ * See https://github.com/deenruv-ecommerce/deenruv/issues/251
+ */
+function convertDate(input) {
+    if (input instanceof Date) {
+        return DateUtils_1.DateUtils.mixedDateToUtcDatetimeString(input);
+    }
+    return input;
+}
+/**
+ * Returns a valid regexp clause based on the current DB driver type.
+ */
+function getRegexpClause(fieldName, argIndex, dbType) {
+    switch (dbType) {
+        case "mariadb":
+        case "mysql":
+        case "sqljs":
+        case "better-sqlite3":
+        case "aurora-mysql":
+            return `${fieldName} REGEXP :arg${argIndex}`;
+        case "postgres":
+        case "aurora-postgres":
+        case "cockroachdb":
+            return `${fieldName} ~* :arg${argIndex}`;
+        // The node-sqlite3 driver does not support user-defined functions
+        // and therefore we are unable to define a custom regexp
+        // function. See https://github.com/mapbox/node-sqlite3/issues/140
+        case "sqlite":
+        default:
+            throw new errors_1.InternalServerError(`The 'regex' filter is not available when using the '${dbType}' driver`);
+    }
+}
+//# sourceMappingURL=parse-filter-params.js.map

package/dist/service/helpers/list-query-builder/parse-filter-params.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-filter-params.js","sourceRoot":"","sources":["../../../../src/service/helpers/list-query-builder/parse-filter-params.ts"],"names":[],"mappings":";;;AAAA,yEAAsE;AAEtE,mEAA+D;AAE/D,sDAAmD;AAEnD,yDAGsC;AAYtC,yDAG4B;AAC5B,qEAAgE;AAmBhE,SAAgB,iBAAiB,CAS/B,UAAsB,EACtB,MAAe,EACf,YAAwB,EACxB,iBAA8C,EAC9C,WAAoB;IAEpB,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,EAAkB,CAAC;IAC5B,CAAC;IACD,MAAM,EACJ,OAAO,EACP,kBAAkB,EAClB,KAAK,EAAE,YAAY,GACpB,GAAG,IAAA,oCAAiB,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,YAAY,CAAC;IAC1C,MAAM,iBAAiB,GAAG,IAAA,6CAAoB,EAAC,MAAM,CAAC,CAAC;IAEvD,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;IACvC,IAAI,QAAQ,GAAG,CAAC,CAAC;IAEjB,SAAS,uBAAuB,CAC9B,GAAW,EACX,SAA6B;QAE7B,MAAM,MAAM,GAAqB,EAAE,CAAC;QACpC,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,SAAS,CAAC;QACnD,MAAM,0BAA0B,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,CAAC;QAC3D,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAmB,CAAC,EAAE,CAAC;YACtE,IAAI,SAAiB,CAAC;YACtB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,GAAG,CAAC,EAAE,CAAC;gBAChD,SAAS,GAAG,GAAG,KAAK,IAAI,GAAG,EAAE,CAAC;YAChC,CAAC;iBAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,GAAG,CAAC,EAAE,CAAC;gBAClE,MAAM,iBAAiB,GAAG,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC7D,SAAS,GAAG,GAAG,iBAAiB,IAAI,GAAG,EAAE,CAAC;YAC5C,CAAC;iBAAM,IAAI,0BAA0B,EAAE,CAAC;gBACtC,SAAS,GAAG,IAAA,mDAAgC,EAC1C,UAAU,EACV,0BAA0B,CAC3B,CAAC;YACJ,CAAC;iBAAM,IAAI,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAG,GAAG,CAAC,EAAE,CAAC;gBACpC,SAAS,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;YACrC,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,uBAAc,CAAC,4BAA4B,CAAC,CAAC;YACzD,CAAC;YACD,MAAM,SAAS,GAAG,mBAAmB,CACnC,SAAS,EACT,QAAoB,EACpB,OAAO,EACP,QAAQ,EACR,MAAM,CACP,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACvB,QAAQ,EAAE,CAAC;QACb,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,SAAS,sBAAsB,CAAC,KAAyB;QACvD,MAAM,MAAM,GAAuC,EAAE,CAAC;QACtD,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;gBACpC,MAAM,CAAC,IAAI,CAAC;oBACV,QAAQ,EAAE,GAAG,KAAK,MAAM,CAAC,CAAC,CAAC,iCAAe,CAAC,GAAG,CAAC,CAAC,CAAC,iCAAe,CAAC,EAAE;oBACnE,UAAU,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;iBACnE,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBAClD,MAAM,CAAC,IAAI,CAAC,GAAG,uBAAuB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,UAAU,GAAG,sBAAsB,CAAC,YAAkC,CAAC,CAAC;IAE9E,OAAO,UAAe,CAAC;AACzB,CAAC;AArFD,8CAqFC;AAED,SAAS,mBAAmB,CAC1B,SAAiB,EACjB,QAAkB,EAClB,OAAY,EACZ,QAAgB,EAChB,MAAiC;IAEjC,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,IAAI;YACP,OAAO;gBACL,MAAM,EAAE,GAAG,SAAS,UAAU,QAAQ,EAAE;gBACxC,UAAU,EAAE,EAAE,CAAC,MAAM,QAAQ,EAAE,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE;aACzD,CAAC;QACJ,KAAK,OAAO;YACV,OAAO;gBACL,MAAM,EAAE,GAAG,SAAS,WAAW,QAAQ,EAAE;gBACzC,UAAU,EAAE,EAAE,CAAC,MAAM,QAAQ,EAAE,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE;aACzD,CAAC;QACJ,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,MAAM,IAAI,GAAG,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;YACtD,OAAO;gBACL,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,QAAQ,QAAQ,EAAE;gBAC9C,UAAU,EAAE;oBACV,CAAC,MAAM,QAAQ,EAAE,CAAC,EAAE,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,GAAG;iBAClF;aACF,CAAC;QACJ,CAAC;QACD,KAAK,aAAa,CAAC,CAAC,CAAC;YACnB,MAAM,IAAI,GAAG,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;YACtD,OAAO;gBACL,MAAM,EAAE,GAAG,SAAS,QAAQ,IAAI,QAAQ,QAAQ,EAAE;gBAElD,UAAU,EAAE,EAAE,CAAC,MAAM,QAAQ,EAAE,CAAC,EAAE,IAAI,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE;aAC1D,CAAC;QACJ,CAAC;QACD,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBAC7C,OAAO;oBACL,MAAM,EAAE,GAAG,SAAS,eAAe,QAAQ,GAAG;oBAC9C,UAAU,EAAE,EAAE,CAAC,MAAM,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE;iBAC5C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,sDAAsD;gBACtD,OAAO;oBACL,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,EAAE;iBACf,CAAC;YACJ,CAAC;QACH,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBAC7C,OAAO;oBACL,MAAM,EAAE,GAAG,SAAS,mBAAmB,QAAQ,GAAG;oBAClD,UAAU,EAAE,EAAE,CAAC,MAAM,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE;iBAC5C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,qDAAqD;gBACrD,OAAO;oBACL,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,EAAE;iBACf,CAAC;YACJ,CAAC;QACH,CAAC;QACD,KAAK,OAAO;YACV,OAAO;gBACL,MAAM,EAAE,eAAe,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC;gBACpD,UAAU,EAAE,EAAE,CAAC,MAAM,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE;aAC5C,CAAC;QACJ,KAAK,IAAI,CAAC;QACV,KAAK,QAAQ;YACX,OAAO;gBACL,MAAM,EAAE,GAAG,SAAS,UAAU,QAAQ,EAAE;gBACxC,UAAU,EAAE,EAAE,CAAC,MAAM,QAAQ,EAAE,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE;aACzD,CAAC;QACJ,KAAK,IAAI,CAAC;QACV,KAAK,OAAO;YACV,OAAO;gBACL,MAAM,EAAE,GAAG,SAAS,UAAU,QAAQ,EAAE;gBACxC,UAAU,EAAE,EAAE,CAAC,MAAM,QAAQ,EAAE,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE;aACzD,CAAC;QACJ,KAAK,KAAK;YACR,OAAO;gBACL,MAAM,EAAE,GAAG,SAAS,WAAW,QAAQ,EAAE;gBACzC,UAAU,EAAE,EAAE,CAAC,MAAM,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE;aAC5C,CAAC;QACJ,KAAK,KAAK;YACR,OAAO;gBACL,MAAM,EAAE,GAAG,SAAS,WAAW,QAAQ,EAAE;gBACzC,UAAU,EAAE,EAAE,CAAC,MAAM,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE;aAC5C,CAAC;QACJ,KAAK,SAAS;YACZ,OAAO;gBACL,MAAM,EAAE,GAAG,SAAS,gBAAgB,QAAQ,cAAc,QAAQ,IAAI;gBACtE,UAAU,EAAE;oBACV,CAAC,MAAM,QAAQ,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC;oBAChD,CAAC,MAAM,QAAQ,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC;iBAC/C;aACF,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO;gBACL,MAAM,EACJ,OAAO,KAAK,IAAI;oBACd,CAAC,CAAC,GAAG,SAAS,UAAU;oBACxB,CAAC,CAAC,GAAG,SAAS,cAAc;gBAChC,UAAU,EAAE,EAAE;aACf,CAAC;QACJ;YACE,IAAA,0BAAW,EAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO;QACL,MAAM,EAAE,GAAG;QACX,UAAU,EAAE,EAAE;KACf,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,KAA6B;IAChD,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,OAAO,qBAAS,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CACtB,SAAiB,EACjB,QAAgB,EAChB,MAAiC;IAEjC,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,SAAS,CAAC;QACf,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC;QACb,KAAK,gBAAgB,CAAC;QACtB,KAAK,cAAc;YACjB,OAAO,GAAG,SAAS,eAAe,QAAQ,EAAE,CAAC;QAC/C,KAAK,UAAU,CAAC;QAChB,KAAK,iBAAiB,CAAC;QACvB,KAAK,aAAa;YAChB,OAAO,GAAG,SAAS,WAAW,QAAQ,EAAE,CAAC;QAC3C,kEAAkE;QAClE,wDAAwD;QACxD,kEAAkE;QAClE,KAAK,QAAQ,CAAC;QACd;YACE,MAAM,IAAI,4BAAmB,CAC3B,uDAAuD,MAAM,UAAU,CACxE,CAAC;IACN,CAAC;AACH,CAAC"}

package/dist/service/helpers/list-query-builder/parse-sort-params.d.ts

@@ -0,0 +1,19 @@
+import { Type } from "@deenruv/common/lib/shared-types";
+import { OrderByCondition } from "typeorm";
+import { DataSource } from "typeorm/data-source/DataSource";
+import { NullOptionals, SortParameter } from "../../../common/types/common-types";
+import { CustomFieldConfig } from "../../../config/custom-field/custom-field-types";
+import { DeenruvEntity } from "../../../entity/base/base.entity";
+/**
+ * Parses the provided SortParameter array against the metadata of the given entity, ensuring that only
+ * valid fields are being sorted against. The output assumes
+ * @param connection
+ * @param entity
+ * @param sortParams
+ * @param customPropertyMap
+ * @param entityAlias
+ * @param customFields
+ */
+export declare function parseSortParams<T extends DeenruvEntity>(connection: DataSource, entity: Type<T>, sortParams?: NullOptionals<SortParameter<T>> | null, customPropertyMap?: {
+    [name: string]: string;
+}, entityAlias?: string, customFields?: CustomFieldConfig[]): OrderByCondition;

package/dist/service/helpers/list-query-builder/parse-sort-params.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseSortParams = void 0;
+const unique_1 = require("@deenruv/common/lib/unique");
+const errors_1 = require("../../../common/error/errors");
+const connection_utils_1 = require("./connection-utils");
+const get_calculated_columns_1 = require("./get-calculated-columns");
+/**
+ * Parses the provided SortParameter array against the metadata of the given entity, ensuring that only
+ * valid fields are being sorted against. The output assumes
+ * @param connection
+ * @param entity
+ * @param sortParams
+ * @param customPropertyMap
+ * @param entityAlias
+ * @param customFields
+ */
+function parseSortParams(connection, entity, sortParams, customPropertyMap, entityAlias, customFields) {
+    var _a;
+    if (!sortParams || Object.keys(sortParams).length === 0) {
+        return {};
+    }
+    const { columns, translationColumns, alias: defaultAlias, } = (0, connection_utils_1.getColumnMetadata)(connection, entity);
+    const alias = entityAlias !== null && entityAlias !== void 0 ? entityAlias : defaultAlias;
+    const calculatedColumns = (0, get_calculated_columns_1.getCalculatedColumns)(entity);
+    const output = {};
+    for (const [key, order] of Object.entries(sortParams)) {
+        const calculatedColumnDef = calculatedColumns.find((c) => c.name === key);
+        const matchingColumn = columns.find((c) => c.propertyName === key);
+        if (matchingColumn) {
+            output[`${alias}.${matchingColumn.propertyPath}`] = order;
+        }
+        else if (translationColumns.find((c) => c.propertyName === key)) {
+            const translationsAlias = connection.namingStrategy.joinTableName(alias, "translations", "", "");
+            const pathParts = [translationsAlias];
+            const isLocaleStringCustomField = ((_a = customFields === null || customFields === void 0 ? void 0 : customFields.find((f) => f.name === key)) === null || _a === void 0 ? void 0 : _a.type) === "localeString";
+            if (isLocaleStringCustomField) {
+                pathParts.push("customFields");
+            }
+            pathParts.push(key);
+            output[pathParts.join(".")] = order;
+        }
+        else if (calculatedColumnDef) {
+            const instruction = calculatedColumnDef.listQuery;
+            if (instruction && instruction.expression) {
+                output[(0, connection_utils_1.escapeCalculatedColumnExpression)(connection, instruction.expression)] = order;
+            }
+        }
+        else if (customPropertyMap === null || customPropertyMap === void 0 ? void 0 : customPropertyMap[key]) {
+            output[customPropertyMap[key]] = order;
+        }
+        else {
+            throw new errors_1.UserInputError("error.invalid-sort-field", {
+                fieldName: key,
+                validFields: [
+                    ...getValidSortFields([...columns, ...translationColumns]),
+                    ...calculatedColumns.map((c) => c.name.toString()),
+                ].join(", "),
+            });
+        }
+    }
+    return output;
+}
+exports.parseSortParams = parseSortParams;
+function getValidSortFields(columns) {
+    return (0, unique_1.unique)(columns.map((c) => c.propertyName));
+}
+//# sourceMappingURL=parse-sort-params.js.map

package/dist/service/helpers/list-query-builder/parse-sort-params.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-sort-params.js","sourceRoot":"","sources":["../../../../src/service/helpers/list-query-builder/parse-sort-params.ts"],"names":[],"mappings":";;;AACA,uDAAoD;AAKpD,yDAA8D;AAQ9D,yDAG4B;AAC5B,qEAAgE;AAEhE;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAC7B,UAAsB,EACtB,MAAe,EACf,UAAmD,EACnD,iBAA8C,EAC9C,WAAoB,EACpB,YAAkC;;IAElC,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxD,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,EACJ,OAAO,EACP,kBAAkB,EAClB,KAAK,EAAE,YAAY,GACpB,GAAG,IAAA,oCAAiB,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,YAAY,CAAC;IAC1C,MAAM,iBAAiB,GAAG,IAAA,6CAAoB,EAAC,MAAM,CAAC,CAAC;IACvD,MAAM,MAAM,GAAqB,EAAE,CAAC;IACpC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACtD,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;QAC1E,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,GAAG,CAAC,CAAC;QACnE,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,CAAC,GAAG,KAAK,IAAI,cAAc,CAAC,YAAY,EAAE,CAAC,GAAG,KAAY,CAAC;QACnE,CAAC;aAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,GAAG,CAAC,EAAE,CAAC;YAClE,MAAM,iBAAiB,GAAG,UAAU,CAAC,cAAc,CAAC,aAAa,CAC/D,KAAK,EACL,cAAc,EACd,EAAE,EACF,EAAE,CACH,CAAC;YAEF,MAAM,SAAS,GAAG,CAAC,iBAAiB,CAAC,CAAC;YACtC,MAAM,yBAAyB,GAC7B,CAAA,MAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,0CAAE,IAAI,MAAK,cAAc,CAAC;YACrE,IAAI,yBAAyB,EAAE,CAAC;gBAC9B,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACjC,CAAC;YACD,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACpB,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,KAAY,CAAC;QAC7C,CAAC;aAAM,IAAI,mBAAmB,EAAE,CAAC;YAC/B,MAAM,WAAW,GAAG,mBAAmB,CAAC,SAAS,CAAC;YAClD,IAAI,WAAW,IAAI,WAAW,CAAC,UAAU,EAAE,CAAC;gBAC1C,MAAM,CACJ,IAAA,mDAAgC,EAAC,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC,CACrE,GAAG,KAAY,CAAC;YACnB,CAAC;QACH,CAAC;aAAM,IAAI,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAG,GAAG,CAAC,EAAE,CAAC;YACpC,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,GAAG,KAAY,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,uBAAc,CAAC,0BAA0B,EAAE;gBACnD,SAAS,EAAE,GAAG;gBACd,WAAW,EAAE;oBACX,GAAG,kBAAkB,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,kBAAkB,CAAC,CAAC;oBAC1D,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;iBACnD,CAAC,IAAI,CAAC,IAAI,CAAC;aACb,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AA5DD,0CA4DC;AAED,SAAS,kBAAkB,CAAC,OAAyB;IACnD,OAAO,IAAA,eAAM,EAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;AACpD,CAAC"}

package/dist/service/helpers/locale-string-hydrator/locale-string-hydrator.d.ts

@@ -0,0 +1,28 @@
+import { LanguageCode } from "@deenruv/common/lib/generated-types";
+import { RequestContext } from "../../../api/common/request-context";
+import { RequestContextCacheService } from "../../../cache/request-context-cache.service";
+import { Translatable, TranslatableKeys } from "../../../common/types/locale-types";
+import { TransactionalConnection } from "../../../connection/transactional-connection";
+import { DeenruvEntity } from "../../../entity/base/base.entity";
+import { TranslatorService } from "../translator/translator.service";
+/**
+ * This helper class is to be used in GraphQL entity resolvers, to resolve fields which depend on being
+ * translated (i.e. the corresponding entity field is of type `LocaleString`).
+ */
+export declare class LocaleStringHydrator {
+    private connection;
+    private requestCache;
+    private translator;
+    constructor(connection: TransactionalConnection, requestCache: RequestContextCacheService, translator: TranslatorService);
+    hydrateLocaleStringField<T extends DeenruvEntity & Translatable & {
+        languageCode?: LanguageCode;
+    }>(ctx: RequestContext, entity: T, fieldName: TranslatableKeys<T> | "languageCode"): Promise<string>;
+    /**
+     * Takes a translatable entity and populates all the LocaleString fields
+     * by fetching the translations from the database (they will be eagerly loaded).
+     *
+     * This method includes a caching optimization to prevent multiple DB calls when many
+     * translatable fields are needed on the same entity in a resolver.
+     */
+    private hydrateLocaleStrings;
+}

package/dist/service/helpers/locale-string-hydrator/locale-string-hydrator.js

@@ -0,0 +1,85 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocaleStringHydrator = void 0;
+const common_1 = require("@nestjs/common");
+const request_context_cache_service_1 = require("../../../cache/request-context-cache.service");
+const transactional_connection_1 = require("../../../connection/transactional-connection");
+const translator_service_1 = require("../translator/translator.service");
+/**
+ * This helper class is to be used in GraphQL entity resolvers, to resolve fields which depend on being
+ * translated (i.e. the corresponding entity field is of type `LocaleString`).
+ */
+let LocaleStringHydrator = class LocaleStringHydrator {
+    constructor(connection, requestCache, translator) {
+        this.connection = connection;
+        this.requestCache = requestCache;
+        this.translator = translator;
+    }
+    async hydrateLocaleStringField(ctx, entity, fieldName) {
+        if (entity[fieldName]) {
+            // Already hydrated, so return the value
+            return entity[fieldName];
+        }
+        await this.hydrateLocaleStrings(ctx, entity);
+        return entity[fieldName];
+    }
+    /**
+     * Takes a translatable entity and populates all the LocaleString fields
+     * by fetching the translations from the database (they will be eagerly loaded).
+     *
+     * This method includes a caching optimization to prevent multiple DB calls when many
+     * translatable fields are needed on the same entity in a resolver.
+     */
+    async hydrateLocaleStrings(ctx, entity) {
+        var _a, _b, _c;
+        const entityType = entity.constructor.name;
+        if (!((_a = entity.translations) === null || _a === void 0 ? void 0 : _a.length)) {
+            const cacheKey = `hydrate-${entityType}-${entity.id}`;
+            let dbCallPromise = this.requestCache.get(ctx, cacheKey);
+            if (!dbCallPromise) {
+                dbCallPromise = this.connection
+                    .getRepository(ctx, entityType)
+                    .findOne({ where: { id: entity.id } });
+                this.requestCache.set(ctx, cacheKey, dbCallPromise);
+            }
+            await dbCallPromise.then((withTranslations) => {
+                entity.translations = withTranslations.translations;
+            });
+        }
+        if (entity.translations.length) {
+            const translated = this.translator.translate(entity, ctx);
+            for (const localeStringProp of Object.keys(entity.translations[0])) {
+                if (localeStringProp === "base" ||
+                    localeStringProp === "id" ||
+                    localeStringProp === "createdAt" ||
+                    localeStringProp === "updatedAt") {
+                    continue;
+                }
+                if (localeStringProp === "customFields") {
+                    entity[localeStringProp] = Object.assign((_b = entity[localeStringProp]) !== null && _b !== void 0 ? _b : {}, (_c = translated[localeStringProp]) !== null && _c !== void 0 ? _c : {});
+                }
+                else {
+                    entity[localeStringProp] = translated[localeStringProp];
+                }
+            }
+        }
+        return entity;
+    }
+};
+exports.LocaleStringHydrator = LocaleStringHydrator;
+exports.LocaleStringHydrator = LocaleStringHydrator = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [transactional_connection_1.TransactionalConnection,
+        request_context_cache_service_1.RequestContextCacheService,
+        translator_service_1.TranslatorService])
+], LocaleStringHydrator);
+//# sourceMappingURL=locale-string-hydrator.js.map

package/dist/service/helpers/locale-string-hydrator/locale-string-hydrator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"locale-string-hydrator.js","sourceRoot":"","sources":["../../../../src/service/helpers/locale-string-hydrator/locale-string-hydrator.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAK5C,gGAA0F;AAM1F,2FAAuF;AAEvF,yEAAqE;AAErE;;;GAGG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAC/B,YACU,UAAmC,EACnC,YAAwC,EACxC,UAA6B;QAF7B,eAAU,GAAV,UAAU,CAAyB;QACnC,iBAAY,GAAZ,YAAY,CAA4B;QACxC,eAAU,GAAV,UAAU,CAAmB;IACpC,CAAC;IAEJ,KAAK,CAAC,wBAAwB,CAG5B,GAAmB,EACnB,MAAS,EACT,SAA+C;QAE/C,IAAI,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACtB,wCAAwC;YACxC,OAAO,MAAM,CAAC,SAAS,CAAQ,CAAC;QAClC,CAAC;QACD,MAAM,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAC,SAAS,CAAQ,CAAC;IAClC,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,oBAAoB,CAChC,GAAmB,EACnB,MAAS;;QAET,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;QAC3C,IAAI,CAAC,CAAA,MAAA,MAAM,CAAC,YAAY,0CAAE,MAAM,CAAA,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,WAAW,UAAU,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;YACtD,IAAI,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CACvC,GAAG,EACH,QAAQ,CACT,CAAC;YAEF,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,aAAa,GAAG,IAAI,CAAC,UAAU;qBAC5B,aAAa,CAAI,GAAG,EAAE,UAAU,CAAC;qBACjC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,EAAuB,CAAC,CAAC;gBAC9D,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;YACtD,CAAC;YAED,MAAM,aAAa,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,EAAE;gBAC5C,MAAM,CAAC,YAAY,GAAG,gBAAiB,CAAC,YAAY,CAAC;YACvD,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YAC/B,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC1D,KAAK,MAAM,gBAAgB,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnE,IACE,gBAAgB,KAAK,MAAM;oBAC3B,gBAAgB,KAAK,IAAI;oBACzB,gBAAgB,KAAK,WAAW;oBAChC,gBAAgB,KAAK,WAAW,EAChC,CAAC;oBACD,SAAS;gBACX,CAAC;gBACD,IAAI,gBAAgB,KAAK,cAAc,EAAE,CAAC;oBACvC,MAAc,CAAC,gBAAgB,CAAC,GAAG,MAAM,CAAC,MAAM,CAC/C,MAAC,MAAc,CAAC,gBAAgB,CAAC,mCAAI,EAAE,EACvC,MAAC,UAAkB,CAAC,gBAAgB,CAAC,mCAAI,EAAE,CAC5C,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACL,MAAc,CAAC,gBAAgB,CAAC,GAAI,UAAkB,CACrD,gBAAgB,CACjB,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,MAAuB,CAAC;IACjC,CAAC;CACF,CAAA;AA7EY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;qCAGW,kDAAuB;QACrB,0DAA0B;QAC5B,sCAAiB;GAJ5B,oBAAoB,CA6EhC"}

package/dist/service/helpers/order-calculator/order-calculator.d.ts

@@ -0,0 +1,82 @@
+import { RequestContext } from "../../../api/common/request-context";
+import { RequestContextCacheService } from "../../../cache/request-context-cache.service";
+import { ConfigService } from "../../../config/config.service";
+import { OrderLine } from "../../../entity";
+import { Order } from "../../../entity/order/order.entity";
+import { Promotion } from "../../../entity/promotion/promotion.entity";
+import { ShippingMethodService } from "../../services/shipping-method.service";
+import { TaxRateService } from "../../services/tax-rate.service";
+import { ZoneService } from "../../services/zone.service";
+import { ShippingCalculator } from "../shipping-calculator/shipping-calculator";
+/**
+ * @description
+ * This helper is used when making changes to an Order, to apply all applicable price adjustments to that Order,
+ * including:
+ *
+ * - Promotions
+ * - Taxes
+ * - Shipping
+ *
+ * @docsCategory service-helpers
+ */
+export declare class OrderCalculator {
+    private configService;
+    private zoneService;
+    private taxRateService;
+    private shippingMethodService;
+    private shippingCalculator;
+    private requestContextCache;
+    constructor(configService: ConfigService, zoneService: ZoneService, taxRateService: TaxRateService, shippingMethodService: ShippingMethodService, shippingCalculator: ShippingCalculator, requestContextCache: RequestContextCacheService);
+    /**
+     * @description
+     * Applies taxes and promotions to an Order. Mutates the order object.
+     * Returns an array of any OrderItems which had new adjustments
+     * applied, either tax or promotions.
+     */
+    applyPriceAdjustments(ctx: RequestContext, order: Order, promotions: Promotion[], updatedOrderLines?: OrderLine[], options?: {
+        recalculateShipping?: boolean;
+    }): Promise<Order>;
+    /**
+     * @description
+     * Applies the correct TaxRate to each OrderLine in the order.
+     */
+    private applyTaxes;
+    /**
+     * @description
+     * Applies the correct TaxRate to an OrderLine
+     */
+    private applyTaxesToOrderLine;
+    /**
+     * @description
+     * Returns a memoized function for performing an efficient
+     * lookup of the correct TaxRate for a given TaxCategory.
+     */
+    private createTaxRateGetter;
+    /**
+     * @description
+     * Applies any eligible promotions to each OrderLine in the order.
+     */
+    private applyPromotions;
+    /**
+     * @description
+     * Applies promotions to OrderItems. This is a quite complex function, due to the inherent complexity
+     * of applying the promotions, and also due to added complexity in the name of performance
+     * optimization. Therefore, it is heavily annotated so that the purpose of each step is clear.
+     */
+    private applyOrderItemPromotions;
+    private applyOrderPromotions;
+    private applyShippingPromotions;
+    private applyShipping;
+    /**
+     * @description
+     * Sets the totals properties on an Order by summing each OrderLine, and taking
+     * into account any Surcharges and ShippingLines. Does not save the Order, so
+     * the entity must be persisted to the DB after calling this method.
+     *
+     * Note that this method does *not* evaluate any taxes or promotions. It assumes
+     * that has already been done and is solely responsible for summing the
+     * totals.
+     */
+    calculateOrderTotals(order: Order): void;
+    private addPromotion;
+}