@deenruv/core 1.0.0

package/dist/service/helpers/utils/move-to-index.d.ts

@@ -0,0 +1,8 @@
+import { Orderable } from "../../../common/types/common-types";
+import { DeenruvEntity } from "../../../entity/base/base.entity";
+/**
+ * Moves the target Orderable entity to the given index amongst its siblings.
+ * Returns the siblings (including the target) which should then be
+ * persisted to the database.
+ */
+export declare function moveToIndex<T extends Orderable & DeenruvEntity>(index: number, target: T, siblings: T[]): T[];

package/dist/service/helpers/utils/move-to-index.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.moveToIndex = void 0;
+const utils_1 = require("../../../common/utils");
+/**
+ * Moves the target Orderable entity to the given index amongst its siblings.
+ * Returns the siblings (including the target) which should then be
+ * persisted to the database.
+ */
+function moveToIndex(index, target, siblings) {
+    const normalizedIndex = Math.max(Math.min(index, siblings.length), 0);
+    let currentIndex = siblings.findIndex((sibling) => (0, utils_1.idsAreEqual)(sibling.id, target.id));
+    const orderedSiblings = [...siblings].sort((a, b) => a.position > b.position ? 1 : -1);
+    const siblingsWithTarget = currentIndex < 0 ? [...orderedSiblings, target] : [...orderedSiblings];
+    currentIndex = siblingsWithTarget.findIndex((sibling) => (0, utils_1.idsAreEqual)(sibling.id, target.id));
+    if (currentIndex !== normalizedIndex) {
+        siblingsWithTarget.splice(normalizedIndex, 0, siblingsWithTarget.splice(currentIndex, 1)[0]);
+        siblingsWithTarget.forEach((collection, i) => {
+            collection.position = i;
+            if (target.id === collection.id) {
+                target.position = i;
+            }
+        });
+    }
+    return siblingsWithTarget;
+}
+exports.moveToIndex = moveToIndex;
+//# sourceMappingURL=move-to-index.js.map

package/dist/service/helpers/utils/move-to-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"move-to-index.js","sourceRoot":"","sources":["../../../../src/service/helpers/utils/move-to-index.ts"],"names":[],"mappings":";;;AACA,iDAAoD;AAGpD;;;;GAIG;AACH,SAAgB,WAAW,CACzB,KAAa,EACb,MAAS,EACT,QAAa;IAEb,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IACtE,IAAI,YAAY,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE,CAChD,IAAA,mBAAW,EAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,CACnC,CAAC;IACF,MAAM,eAAe,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAClD,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACjC,CAAC;IACF,MAAM,kBAAkB,GACtB,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC;IACzE,YAAY,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE,CACtD,IAAA,mBAAW,EAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,CACnC,CAAC;IACF,IAAI,YAAY,KAAK,eAAe,EAAE,CAAC;QACrC,kBAAkB,CAAC,MAAM,CACvB,eAAe,EACf,CAAC,EACD,kBAAkB,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAC9C,CAAC;QACF,kBAAkB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE;YAC3C,UAAU,CAAC,QAAQ,GAAG,CAAC,CAAC;YACxB,IAAI,MAAM,CAAC,EAAE,KAAK,UAAU,CAAC,EAAE,EAAE,CAAC;gBAChC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;YACtB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AA/BD,kCA+BC"}

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

@@ -0,0 +1,34 @@
+import { OrderLineInput } from "@deenruv/common/lib/generated-types";
+import { RequestContext } from "../../../api/common/request-context";
+import { TransactionalConnection } from "../../../connection/transactional-connection";
+import { Order } from "../../../entity/order/order.entity";
+import { PaymentState } from "../payment-state-machine/payment-state";
+/**
+ * Returns true if the Order total is covered by Payments in the specified state.
+ */
+export declare function orderTotalIsCovered(order: Order, state: PaymentState | PaymentState[]): boolean;
+/**
+ * Returns the total amount covered by all Payments (minus any refunds)
+ */
+export declare function totalCoveredByPayments(order: Order, state?: PaymentState | PaymentState[]): number;
+/**
+ * Returns true if all (non-cancelled) OrderItems are delivered.
+ */
+export declare function orderItemsAreDelivered(order: Order): boolean;
+/**
+ * Returns true if at least one, but not all (non-cancelled) OrderItems are delivered.
+ */
+export declare function orderItemsArePartiallyDelivered(order: Order): boolean;
+/**
+ * Returns true if at least one, but not all (non-cancelled) OrderItems are shipped.
+ */
+export declare function orderItemsArePartiallyShipped(order: Order): boolean;
+/**
+ * Returns true if all (non-cancelled) OrderItems are shipped.
+ */
+export declare function orderItemsAreShipped(order: Order): boolean;
+/**
+ * Returns true if all OrderItems in the order are cancelled
+ */
+export declare function orderLinesAreAllCancelled(order: Order): boolean;
+export declare function getOrdersFromLines(ctx: RequestContext, connection: TransactionalConnection, orderLinesInput: OrderLineInput[]): Promise<Order[]>;

package/dist/service/helpers/utils/order-utils.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOrdersFromLines = exports.orderLinesAreAllCancelled = exports.orderItemsAreShipped = exports.orderItemsArePartiallyShipped = exports.orderItemsArePartiallyDelivered = exports.orderItemsAreDelivered = exports.totalCoveredByPayments = exports.orderTotalIsCovered = void 0;
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const unique_1 = require("@deenruv/common/lib/unique");
+const typeorm_1 = require("typeorm");
+const errors_1 = require("../../../common/error/errors");
+const utils_1 = require("../../../common/utils");
+const order_line_entity_1 = require("../../../entity/order-line/order-line.entity");
+/**
+ * Returns true if the Order total is covered by Payments in the specified state.
+ */
+function orderTotalIsCovered(order, state) {
+    const paymentsTotal = totalCoveredByPayments(order, state);
+    return paymentsTotal >= order.totalWithTax;
+}
+exports.orderTotalIsCovered = orderTotalIsCovered;
+/**
+ * Returns the total amount covered by all Payments (minus any refunds)
+ */
+function totalCoveredByPayments(order, state) {
+    const payments = state
+        ? Array.isArray(state)
+            ? order.payments.filter((p) => state.includes(p.state))
+            : order.payments.filter((p) => p.state === state)
+        : order.payments.filter((p) => p.state !== "Error" &&
+            p.state !== "Declined" &&
+            p.state !== "Cancelled");
+    let total = 0;
+    for (const payment of payments) {
+        const refundTotal = (0, shared_utils_1.summate)(payment.refunds, "total");
+        total += payment.amount - Math.abs(refundTotal);
+    }
+    return total;
+}
+exports.totalCoveredByPayments = totalCoveredByPayments;
+/**
+ * Returns true if all (non-cancelled) OrderItems are delivered.
+ */
+function orderItemsAreDelivered(order) {
+    return (getOrderLinesFulfillmentStates(order).every((state) => state === "Delivered") && !isOrderPartiallyFulfilled(order));
+}
+exports.orderItemsAreDelivered = orderItemsAreDelivered;
+/**
+ * Returns true if at least one, but not all (non-cancelled) OrderItems are delivered.
+ */
+function orderItemsArePartiallyDelivered(order) {
+    const states = getOrderLinesFulfillmentStates(order);
+    return (states.some((state) => state === "Delivered") &&
+        (!states.every((state) => state === "Delivered") ||
+            isOrderPartiallyFulfilled(order)));
+}
+exports.orderItemsArePartiallyDelivered = orderItemsArePartiallyDelivered;
+function getOrderLinesFulfillmentStates(order) {
+    const fulfillmentLines = getOrderFulfillmentLines(order);
+    const states = (0, unique_1.unique)(order.lines
+        .filter((line) => line.quantity !== 0)
+        .map((line) => {
+        const matchingFulfillmentLines = fulfillmentLines.filter((fl) => (0, utils_1.idsAreEqual)(fl.orderLineId, line.id));
+        const totalFulfilled = (0, shared_utils_1.summate)(matchingFulfillmentLines, "quantity");
+        if (0 < totalFulfilled) {
+            return matchingFulfillmentLines.map((l) => l.fulfillment.state);
+        }
+        else {
+            return undefined;
+        }
+    })
+        .flat());
+    return states;
+}
+/**
+ * Returns true if at least one, but not all (non-cancelled) OrderItems are shipped.
+ */
+function orderItemsArePartiallyShipped(order) {
+    const states = getOrderLinesFulfillmentStates(order);
+    return (states.some((state) => state === "Shipped") &&
+        (!states.every((state) => state === "Shipped") ||
+            isOrderPartiallyFulfilled(order)));
+}
+exports.orderItemsArePartiallyShipped = orderItemsArePartiallyShipped;
+/**
+ * Returns true if all (non-cancelled) OrderItems are shipped.
+ */
+function orderItemsAreShipped(order) {
+    return (getOrderLinesFulfillmentStates(order).every((state) => state === "Shipped") && !isOrderPartiallyFulfilled(order));
+}
+exports.orderItemsAreShipped = orderItemsAreShipped;
+/**
+ * Returns true if all OrderItems in the order are cancelled
+ */
+function orderLinesAreAllCancelled(order) {
+    return order.lines.every((line) => line.quantity === 0);
+}
+exports.orderLinesAreAllCancelled = orderLinesAreAllCancelled;
+function getOrderFulfillmentLines(order) {
+    return order.fulfillments
+        .filter((f) => f.state !== "Cancelled")
+        .reduce((fulfillmentLines, fulfillment) => [
+        ...fulfillmentLines,
+        ...fulfillment.lines,
+    ], []);
+}
+/**
+ * Returns true if Fulfillments exist for only some but not all of the
+ * order items.
+ */
+function isOrderPartiallyFulfilled(order) {
+    const fulfillmentLines = getOrderFulfillmentLines(order);
+    const lines = fulfillmentLines.reduce((acc, item) => {
+        acc[item.orderLineId] = (acc[item.orderLineId] || 0) + item.quantity;
+        return acc;
+    }, {});
+    return order.lines.some((line) => line.quantity > lines[line.id]);
+}
+async function getOrdersFromLines(ctx, connection, orderLinesInput) {
+    const orders = new Map();
+    const lines = await connection.getRepository(ctx, order_line_entity_1.OrderLine).find({
+        where: { id: (0, typeorm_1.In)(orderLinesInput.map((l) => l.orderLineId)) },
+        relations: ["order", "order.channels"],
+        order: { id: "ASC" },
+    });
+    for (const line of lines) {
+        const inputLine = orderLinesInput.find((l) => (0, utils_1.idsAreEqual)(l.orderLineId, line.id));
+        if (!inputLine) {
+            continue;
+        }
+        const order = line.order;
+        if (!order.channels.some((channel) => channel.id === ctx.channelId)) {
+            throw new errors_1.EntityNotFoundError("Order", order.id);
+        }
+        if (!orders.has(order.id)) {
+            orders.set(order.id, order);
+        }
+    }
+    return Array.from(orders.values());
+}
+exports.getOrdersFromLines = getOrdersFromLines;
+//# sourceMappingURL=order-utils.js.map

package/dist/service/helpers/utils/order-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-utils.js","sourceRoot":"","sources":["../../../../src/service/helpers/utils/order-utils.ts"],"names":[],"mappings":";;;AAEA,mEAA2D;AAC3D,uDAAoD;AACpD,qCAA6B;AAG7B,yDAAmE;AACnE,iDAAoD;AAGpD,oFAAyE;AAKzE;;GAEG;AACH,SAAgB,mBAAmB,CACjC,KAAY,EACZ,KAAoC;IAEpC,MAAM,aAAa,GAAG,sBAAsB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC3D,OAAO,aAAa,IAAI,KAAK,CAAC,YAAY,CAAC;AAC7C,CAAC;AAND,kDAMC;AAED;;GAEG;AACH,SAAgB,sBAAsB,CACpC,KAAY,EACZ,KAAqC;IAErC,MAAM,QAAQ,GAAG,KAAK;QACpB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YACpB,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACvD,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC;QACnD,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CACnB,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,KAAK,KAAK,OAAO;YACnB,CAAC,CAAC,KAAK,KAAK,UAAU;YACtB,CAAC,CAAC,KAAK,KAAK,WAAW,CAC1B,CAAC;IACN,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,WAAW,GAAG,IAAA,sBAAO,EAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACtD,KAAK,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AApBD,wDAoBC;AAED;;GAEG;AACH,SAAgB,sBAAsB,CAAC,KAAY;IACjD,OAAO,CACL,8BAA8B,CAAC,KAAK,CAAC,CAAC,KAAK,CACzC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,WAAW,CACjC,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,CACvC,CAAC;AACJ,CAAC;AAND,wDAMC;AAED;;GAEG;AACH,SAAgB,+BAA+B,CAAC,KAAY;IAC1D,MAAM,MAAM,GAAG,8BAA8B,CAAC,KAAK,CAAC,CAAC;IACrD,OAAO,CACL,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,WAAW,CAAC;QAC7C,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,WAAW,CAAC;YAC9C,yBAAyB,CAAC,KAAK,CAAC,CAAC,CACpC,CAAC;AACJ,CAAC;AAPD,0EAOC;AAED,SAAS,8BAA8B,CACrC,KAAY;IAEZ,MAAM,gBAAgB,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,IAAA,eAAM,EACnB,KAAK,CAAC,KAAK;SACR,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,CAAC;SACrC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACZ,MAAM,wBAAwB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAC9D,IAAA,mBAAW,EAAC,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC,CACrC,CAAC;QACF,MAAM,cAAc,GAAG,IAAA,sBAAO,EAAC,wBAAwB,EAAE,UAAU,CAAC,CAAC;QACrE,IAAI,CAAC,GAAG,cAAc,EAAE,CAAC;YACvB,OAAO,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAClE,CAAC;aAAM,CAAC;YACN,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC,CAAC;SACD,IAAI,EAAE,CACV,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAgB,6BAA6B,CAAC,KAAY;IACxD,MAAM,MAAM,GAAG,8BAA8B,CAAC,KAAK,CAAC,CAAC;IACrD,OAAO,CACL,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC;QAC3C,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC;YAC5C,yBAAyB,CAAC,KAAK,CAAC,CAAC,CACpC,CAAC;AACJ,CAAC;AAPD,sEAOC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAAC,KAAY;IAC/C,OAAO,CACL,8BAA8B,CAAC,KAAK,CAAC,CAAC,KAAK,CACzC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAC/B,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,CACvC,CAAC;AACJ,CAAC;AAND,oDAMC;AAED;;GAEG;AACH,SAAgB,yBAAyB,CAAC,KAAY;IACpD,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC;AAC1D,CAAC;AAFD,8DAEC;AAED,SAAS,wBAAwB,CAAC,KAAY;IAC5C,OAAO,KAAK,CAAC,YAAY;SACtB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,WAAW,CAAC;SACtC,MAAM,CACL,CAAC,gBAAgB,EAAE,WAAW,EAAE,EAAE,CAAC;QACjC,GAAG,gBAAgB;QACnB,GAAG,WAAW,CAAC,KAAK;KACrB,EACD,EAAuB,CACxB,CAAC;AACN,CAAC;AAED;;;GAGG;AACH,SAAS,yBAAyB,CAAC,KAAY;IAC7C,MAAM,gBAAgB,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,gBAAgB,CAAC,MAAM,CACnC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACZ,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACrE,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAuC,CACxC,CAAC;IACF,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;AACpE,CAAC;AAEM,KAAK,UAAU,kBAAkB,CACtC,GAAmB,EACnB,UAAmC,EACnC,eAAiC;IAEjC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAa,CAAC;IACpC,MAAM,KAAK,GAAG,MAAM,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE,6BAAS,CAAC,CAAC,IAAI,CAAC;QAChE,KAAK,EAAE,EAAE,EAAE,EAAE,IAAA,YAAE,EAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE;QAC5D,SAAS,EAAE,CAAC,OAAO,EAAE,gBAAgB,CAAC;QACtC,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE;KACrB,CAAC,CAAC;IACH,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAC3C,IAAA,mBAAW,EAAC,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC,CACpC,CAAC;QACF,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS;QACX,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YACpE,MAAM,IAAI,4BAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;AACrC,CAAC;AA3BD,gDA2BC"}

package/dist/service/helpers/utils/patch-entity.d.ts

@@ -0,0 +1,10 @@
+import { DeenruvEntity } from "../../../entity/base/base.entity";
+export type InputPatch<T> = {
+    [K in keyof T]?: T[K] | null;
+};
+/**
+ * Updates only the specified properties from an Input object as long as the value is not
+ * undefined. Null values can be passed, however, which will set the corresponding entity
+ * field to "null". So care must be taken that this is only done on nullable fields.
+ */
+export declare function patchEntity<T extends DeenruvEntity, I extends InputPatch<T>>(entity: T, input: I): T;

package/dist/service/helpers/utils/patch-entity.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.patchEntity = void 0;
+/**
+ * Updates only the specified properties from an Input object as long as the value is not
+ * undefined. Null values can be passed, however, which will set the corresponding entity
+ * field to "null". So care must be taken that this is only done on nullable fields.
+ */
+function patchEntity(entity, input) {
+    for (const key of Object.keys(entity)) {
+        const value = input[key];
+        if (key === "customFields" && value) {
+            patchEntity(entity[key], value);
+        }
+        else if (value !== undefined && key !== "id") {
+            entity[key] = value;
+        }
+    }
+    return entity;
+}
+exports.patchEntity = patchEntity;
+//# sourceMappingURL=patch-entity.js.map

package/dist/service/helpers/utils/patch-entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch-entity.js","sourceRoot":"","sources":["../../../../src/service/helpers/utils/patch-entity.ts"],"names":[],"mappings":";;;AAIA;;;;GAIG;AACH,SAAgB,WAAW,CACzB,MAAS,EACT,KAAQ;IAER,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAc,CAAC,CAAC;QACpC,IAAI,GAAG,KAAK,cAAc,IAAI,KAAK,EAAE,CAAC;YACpC,WAAW,CAAE,MAAc,CAAC,GAAG,CAAC,EAAE,KAAY,CAAC,CAAC;QAClD,CAAC;aAAM,IAAI,KAAK,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAC/C,MAAM,CAAC,GAAc,CAAC,GAAG,KAAY,CAAC;QACxC,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAbD,kCAaC"}

package/dist/service/helpers/utils/samples-each.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Returns true if and only if exactly one item from each
+ * of the "groups" arrays appears in the "sample" array.
+ */
+export declare function samplesEach<T>(sample: T[], groups: T[][]): boolean;

package/dist/service/helpers/utils/samples-each.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.samplesEach = void 0;
+/**
+ * Returns true if and only if exactly one item from each
+ * of the "groups" arrays appears in the "sample" array.
+ */
+function samplesEach(sample, groups) {
+    if (sample.length !== groups.length) {
+        return false;
+    }
+    return groups.every((group) => {
+        for (const item of sample) {
+            if (group.includes(item)) {
+                return true;
+            }
+        }
+        return false;
+    });
+}
+exports.samplesEach = samplesEach;
+//# sourceMappingURL=samples-each.js.map

package/dist/service/helpers/utils/samples-each.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"samples-each.js","sourceRoot":"","sources":["../../../../src/service/helpers/utils/samples-each.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,SAAgB,WAAW,CAAI,MAAW,EAAE,MAAa;IACvD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzB,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;AACL,CAAC;AAZD,kCAYC"}

package/dist/service/helpers/utils/translate-entity.d.ts

@@ -0,0 +1,34 @@
+import { LanguageCode } from "@deenruv/common/lib/generated-types";
+import { UnwrappedArray } from "../../../common/types/common-types";
+import { Translatable, Translated } from "../../../common/types/locale-types";
+import { DeenruvEntity } from "../../../entity/base/base.entity";
+export type TranslatableRelationsKeys<T> = {
+    [K in keyof T]: T[K] extends string ? never : T[K] extends number ? never : T[K] extends boolean ? never : T[K] extends undefined ? never : T[K] extends string[] ? never : T[K] extends number[] ? never : T[K] extends boolean[] ? never : K extends 'translations' ? never : K extends 'customFields' ? never : K;
+}[keyof T];
+export type NestedTranslatableRelations<T> = {
+    [K in TranslatableRelationsKeys<T>]: T[K] extends any[] ? [
+        K,
+        TranslatableRelationsKeys<UnwrappedArray<T[K]>>
+    ] : [
+        K,
+        TranslatableRelationsKeys<T[K]>
+    ];
+};
+export type NestedTranslatableRelationKeys<T> = NestedTranslatableRelations<T>[keyof NestedTranslatableRelations<T>];
+export type DeepTranslatableRelations<T> = Array<TranslatableRelationsKeys<T> | NestedTranslatableRelationKeys<T>>;
+/**
+ * Converts a Translatable entity into the public-facing entity by unwrapping
+ * the translated strings from the matching Translation entity.
+ */
+export declare function translateEntity<T extends Translatable & DeenruvEntity>(translatable: T, languageCode: LanguageCode | [LanguageCode, ...LanguageCode[]]): Translated<T>;
+/**
+ * Translates an entity and its deeply-nested translatable properties. Supports up to 2 levels of nesting.
+ */
+export declare function translateDeep<T extends Translatable & DeenruvEntity>(translatable: T, languageCode: LanguageCode | [LanguageCode, ...LanguageCode[]], translatableRelations?: DeepTranslatableRelations<T>): Translated<T>;
+export type TreeNode = {
+    children: TreeNode[];
+} & Translatable & DeenruvEntity;
+/**
+ * Translates a tree structure of Translatable entities
+ */
+export declare function translateTree<T extends TreeNode>(node: T, languageCode: LanguageCode | [LanguageCode, ...LanguageCode[]], translatableRelations?: DeepTranslatableRelations<T>): Translated<T>;

package/dist/service/helpers/utils/translate-entity.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.translateTree = exports.translateDeep = exports.translateEntity = void 0;
+const constants_1 = require("../../../common/constants");
+const errors_1 = require("../../../common/error/errors");
+/**
+ * Converts a Translatable entity into the public-facing entity by unwrapping
+ * the translated strings from the matching Translation entity.
+ */
+function translateEntity(translatable, languageCode) {
+    let translation;
+    if (translatable.translations) {
+        if (Array.isArray(languageCode)) {
+            for (const lc of languageCode) {
+                translation = translatable.translations.find((t) => t.languageCode === lc);
+                if (translation)
+                    break;
+            }
+        }
+        else {
+            translation = translatable.translations.find((t) => t.languageCode === languageCode);
+        }
+        if (!translation && languageCode !== constants_1.DEFAULT_LANGUAGE_CODE) {
+            translation = translatable.translations.find((t) => t.languageCode === constants_1.DEFAULT_LANGUAGE_CODE);
+        }
+        if (!translation) {
+            // If we cannot find any suitable translation, just return the first one to at least
+            // prevent graphql errors when returning the entity.
+            translation = translatable.translations[0];
+        }
+    }
+    if (!translation) {
+        throw new errors_1.InternalServerError("error.entity-has-no-translation-in-language", {
+            entityName: translatable.constructor.name,
+            languageCode: Array.isArray(languageCode)
+                ? languageCode.join()
+                : languageCode,
+        });
+    }
+    const translated = Object.create(Object.getPrototypeOf(translatable), Object.getOwnPropertyDescriptors(translatable));
+    for (const [key, value] of Object.entries(translation)) {
+        if (key === "customFields") {
+            if (!translated.customFields) {
+                translated.customFields = {};
+            }
+            Object.assign(translated.customFields, value);
+        }
+        else if (key !== "base" &&
+            key !== "id" &&
+            key !== "createdAt" &&
+            key !== "updatedAt") {
+            translated[key] = value !== null && value !== void 0 ? value : "";
+        }
+    }
+    return translated;
+}
+exports.translateEntity = translateEntity;
+/**
+ * Translates an entity and its deeply-nested translatable properties. Supports up to 2 levels of nesting.
+ */
+function translateDeep(translatable, languageCode, translatableRelations = []) {
+    let translatedEntity;
+    try {
+        translatedEntity = translateEntity(translatable, languageCode);
+    }
+    catch (e) {
+        translatedEntity = translatable;
+    }
+    for (const path of translatableRelations) {
+        let object;
+        let property;
+        let value;
+        if (Array.isArray(path) && path.length === 2) {
+            const [path0, path1] = path;
+            const valueLevel0 = translatable[path0];
+            if (Array.isArray(valueLevel0)) {
+                valueLevel0.forEach((nested1, index) => {
+                    object = translatedEntity[path0][index];
+                    property = path1;
+                    object[property] = translateLeaf(object, property, languageCode);
+                });
+                property = "";
+                object = null;
+            }
+            else {
+                object = translatedEntity[path0];
+                property = path1;
+                value = translateLeaf(object, property, languageCode);
+            }
+        }
+        else {
+            object = translatedEntity;
+            property = path;
+            value = translateLeaf(object, property, languageCode);
+        }
+        if (object && property) {
+            object[property] = value;
+        }
+    }
+    return translatedEntity;
+}
+exports.translateDeep = translateDeep;
+function translateLeaf(object, property, languageCode) {
+    if (object && object[property]) {
+        if (Array.isArray(object[property])) {
+            return object[property].map((nested2) => translateEntity(nested2, languageCode));
+        }
+        else if (object[property]) {
+            return translateEntity(object[property], languageCode);
+        }
+    }
+}
+/**
+ * Translates a tree structure of Translatable entities
+ */
+function translateTree(node, languageCode, translatableRelations = []) {
+    const output = translateDeep(node, languageCode, translatableRelations);
+    if (Array.isArray(output.children)) {
+        output.children = output.children.map((child) => translateTree(child, languageCode, translatableRelations));
+    }
+    return output;
+}
+exports.translateTree = translateTree;
+//# sourceMappingURL=translate-entity.js.map

package/dist/service/helpers/utils/translate-entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"translate-entity.js","sourceRoot":"","sources":["../../../../src/service/helpers/utils/translate-entity.ts"],"names":[],"mappings":";;;AAEA,yDAAkE;AAClE,yDAAmE;AAmCnE;;;GAGG;AACH,SAAgB,eAAe,CAC7B,YAAe,EACf,YAA8D;IAE9D,IAAI,WAAmD,CAAC;IACxD,IAAI,YAAY,CAAC,YAAY,EAAE,CAAC;QAC9B,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YAChC,KAAK,MAAM,EAAE,IAAI,YAAY,EAAE,CAAC;gBAC9B,WAAW,GAAG,YAAY,CAAC,YAAY,CAAC,IAAI,CAC1C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,EAAE,CAC7B,CAAC;gBACF,IAAI,WAAW;oBAAE,MAAM;YACzB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,WAAW,GAAG,YAAY,CAAC,YAAY,CAAC,IAAI,CAC1C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,YAAY,CACvC,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,WAAW,IAAI,YAAY,KAAK,iCAAqB,EAAE,CAAC;YAC3D,WAAW,GAAG,YAAY,CAAC,YAAY,CAAC,IAAI,CAC1C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,iCAAqB,CAChD,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,oFAAoF;YACpF,oDAAoD;YACpD,WAAW,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAED,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,4BAAmB,CAC3B,6CAA6C,EAC7C;YACE,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,IAAI;YACzC,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;gBACvC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE;gBACrB,CAAC,CAAC,YAAY;SACjB,CACF,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAC9B,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,EACnC,MAAM,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAC/C,CAAC;IAEF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QACvD,IAAI,GAAG,KAAK,cAAc,EAAE,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;gBAC7B,UAAU,CAAC,YAAY,GAAG,EAAE,CAAC;YAC/B,CAAC;YACD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QAChD,CAAC;aAAM,IACL,GAAG,KAAK,MAAM;YACd,GAAG,KAAK,IAAI;YACZ,GAAG,KAAK,WAAW;YACnB,GAAG,KAAK,WAAW,EACnB,CAAC;YACD,UAAU,CAAC,GAAG,CAAC,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC;QAChC,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAhED,0CAgEC;AAED;;GAEG;AACH,SAAgB,aAAa,CAC3B,YAAe,EACf,YAA8D,EAC9D,wBAAsD,EAAE;IAExD,IAAI,gBAA+B,CAAC;IACpC,IAAI,CAAC;QACH,gBAAgB,GAAG,eAAe,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IACjE,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,gBAAgB,GAAG,YAAmB,CAAC;IACzC,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,qBAAqB,EAAE,CAAC;QACzC,IAAI,MAAW,CAAC;QAChB,IAAI,QAAgB,CAAC;QACrB,IAAI,KAAU,CAAC;QAEf,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7C,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,IAAW,CAAC;YACnC,MAAM,WAAW,GAAI,YAAoB,CAAC,KAAK,CAAC,CAAC;YAEjD,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC/B,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;oBACrC,MAAM,GAAI,gBAAwB,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC;oBACjD,QAAQ,GAAG,KAAK,CAAC;oBACjB,MAAM,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;gBACnE,CAAC,CAAC,CAAC;gBACH,QAAQ,GAAG,EAAE,CAAC;gBACd,MAAM,GAAG,IAAI,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAI,gBAAwB,CAAC,KAAK,CAAC,CAAC;gBAC1C,QAAQ,GAAG,KAAK,CAAC;gBACjB,KAAK,GAAG,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,gBAAgB,CAAC;YAC1B,QAAQ,GAAG,IAAW,CAAC;YACvB,KAAK,GAAG,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,MAAM,IAAI,QAAQ,EAAE,CAAC;YACvB,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AA9CD,sCA8CC;AAED,SAAS,aAAa,CACpB,MAA0C,EAC1C,QAAgB,EAChB,YAA8D;IAE9D,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YACpC,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,OAAY,EAAE,EAAE,CAC3C,eAAe,CAAC,OAAO,EAAE,YAAY,CAAC,CACvC,CAAC;QACJ,CAAC;aAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,OAAO,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;AACH,CAAC;AAID;;GAEG;AACH,SAAgB,aAAa,CAC3B,IAAO,EACP,YAA8D,EAC9D,wBAAsD,EAAE;IAExD,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,qBAAqB,CAAC,CAAC;IACxE,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAC9C,aAAa,CAAC,KAAK,EAAE,YAAY,EAAE,qBAA4B,CAAC,CACjE,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAZD,sCAYC"}

package/dist/service/helpers/utils/tree-relations-qb-joiner.d.ts

@@ -0,0 +1,30 @@
+import { FindOneOptions, SelectQueryBuilder } from "typeorm";
+import { EntityTarget } from "typeorm/common/EntityTarget";
+import { DeenruvEntity } from "../../../entity";
+/**
+ * Dynamically joins tree relations and their eager counterparts in a TypeORM SelectQueryBuilder, addressing
+ * challenges of managing deeply nested relations and optimizing query efficiency. It leverages TypeORM tree
+ * decorators (@TreeParent, @TreeChildren) to automate joins of self-related entities, including those marked for eager loading.
+ * The process avoids duplicate joins and manual join specifications by using relation metadata.
+ *
+ * @param {SelectQueryBuilder<T>} qb - The query builder instance for joining relations.
+ * @param {EntityTarget<T>} entity - The target entity class or schema name, used to access entity metadata.
+ * @param {string[]} [requestedRelations=[]] - An array of relation paths (e.g., 'parent.children') to join dynamically.
+ * @param {number} [maxEagerDepth=1] - Limits the depth of eager relation joins to avoid excessively deep joins.
+ * @returns {Map<string, string>} - A Map of joined relation paths to their aliases, aiding in tracking and preventing duplicates.
+ * @template T - The entity type, extending DeenruvEntity for compatibility with Deenruv's data layer.
+ *
+ * Usage Notes:
+ * - Only entities utilizing TypeORM tree decorators and having nested relations are supported.
+ * - The `maxEagerDepth` parameter controls the recursion depth for eager relations, preventing performance issues.
+ *
+ * For more context on the issue this function addresses, refer to TypeORM issue #9936:
+ * https://github.com/typeorm/typeorm/issues/9936
+ *
+ * Example:
+ * ```typescript
+ * const qb = repository.createQueryBuilder("entity");
+ * joinTreeRelationsDynamically(qb, EntityClass, ["parent.children"], 2);
+ * ```
+ */
+export declare function joinTreeRelationsDynamically<T extends DeenruvEntity>(qb: SelectQueryBuilder<T>, entity: EntityTarget<T>, requestedRelations?: FindOneOptions["relations"], maxEagerDepth?: number): Map<string, string>;

package/dist/service/helpers/utils/tree-relations-qb-joiner.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.joinTreeRelationsDynamically = void 0;
+const find_options_object_to_array_1 = require("../../../connection/find-options-object-to-array");
+/**
+ * @description
+ * Check if the current entity has one or more self-referencing relations
+ * to determine if it is a tree type or has tree relations.
+ * @param metadata
+ * @private
+ */
+function isTreeEntityMetadata(metadata) {
+    if (metadata.treeType !== undefined) {
+        return true;
+    }
+    for (const relation of metadata.relations) {
+        if (relation.isTreeParent || relation.isTreeChildren) {
+            return true;
+        }
+        if (relation.inverseEntityMetadata === metadata) {
+            return true;
+        }
+    }
+    return false;
+}
+/**
+ * Dynamically joins tree relations and their eager counterparts in a TypeORM SelectQueryBuilder, addressing
+ * challenges of managing deeply nested relations and optimizing query efficiency. It leverages TypeORM tree
+ * decorators (@TreeParent, @TreeChildren) to automate joins of self-related entities, including those marked for eager loading.
+ * The process avoids duplicate joins and manual join specifications by using relation metadata.
+ *
+ * @param {SelectQueryBuilder<T>} qb - The query builder instance for joining relations.
+ * @param {EntityTarget<T>} entity - The target entity class or schema name, used to access entity metadata.
+ * @param {string[]} [requestedRelations=[]] - An array of relation paths (e.g., 'parent.children') to join dynamically.
+ * @param {number} [maxEagerDepth=1] - Limits the depth of eager relation joins to avoid excessively deep joins.
+ * @returns {Map<string, string>} - A Map of joined relation paths to their aliases, aiding in tracking and preventing duplicates.
+ * @template T - The entity type, extending DeenruvEntity for compatibility with Deenruv's data layer.
+ *
+ * Usage Notes:
+ * - Only entities utilizing TypeORM tree decorators and having nested relations are supported.
+ * - The `maxEagerDepth` parameter controls the recursion depth for eager relations, preventing performance issues.
+ *
+ * For more context on the issue this function addresses, refer to TypeORM issue #9936:
+ * https://github.com/typeorm/typeorm/issues/9936
+ *
+ * Example:
+ * ```typescript
+ * const qb = repository.createQueryBuilder("entity");
+ * joinTreeRelationsDynamically(qb, EntityClass, ["parent.children"], 2);
+ * ```
+ */
+function joinTreeRelationsDynamically(qb, entity, requestedRelations = {}, maxEagerDepth = 1) {
+    const joinedRelations = new Map();
+    const relationsArray = (0, find_options_object_to_array_1.findOptionsObjectToArray)(requestedRelations);
+    if (!relationsArray.length) {
+        return joinedRelations;
+    }
+    const sourceMetadata = qb.connection.getMetadata(entity);
+    const sourceMetadataIsTree = isTreeEntityMetadata(sourceMetadata);
+    const processRelation = (currentMetadata, parentMetadataIsTree, currentPath, currentAlias, parentPath, eagerDepth = 0) => {
+        if (currentPath === "") {
+            return;
+        }
+        parentPath = parentPath === null || parentPath === void 0 ? void 0 : parentPath.filter((p) => p !== "");
+        const currentMetadataIsTree = isTreeEntityMetadata(currentMetadata) ||
+            sourceMetadataIsTree ||
+            parentMetadataIsTree;
+        if (!currentMetadataIsTree) {
+            return;
+        }
+        const parts = currentPath.split(".");
+        let part = parts.shift();
+        if (!part || !currentMetadata)
+            return;
+        if (part === "customFields" && parts.length > 0) {
+            const relation = parts.shift();
+            if (!relation)
+                return;
+            part += `.${relation}`;
+        }
+        const relationMetadata = currentMetadata.findRelationWithPropertyPath(part);
+        if (!relationMetadata) {
+            return;
+        }
+        let joinConnector = "_";
+        if (relationMetadata.isEager) {
+            joinConnector = "__";
+        }
+        const nextAlias = `${currentAlias}${joinConnector}${part.replace(/\./g, "_")}`;
+        const nextPath = parts.join(".");
+        const fullPath = [...(parentPath || []), part].join(".");
+        if (!qb.expressionMap.joinAttributes.some((ja) => ja.alias.name === nextAlias)) {
+            qb.leftJoinAndSelect(`${currentAlias}.${part}`, nextAlias);
+            joinedRelations.set(fullPath, nextAlias);
+        }
+        const inverseEntityMetadataIsTree = isTreeEntityMetadata(relationMetadata.inverseEntityMetadata);
+        if (!currentMetadataIsTree && !inverseEntityMetadataIsTree) {
+            return;
+        }
+        const newEagerDepth = relationMetadata.isEager
+            ? eagerDepth + 1
+            : eagerDepth;
+        if (newEagerDepth <= maxEagerDepth) {
+            relationMetadata.inverseEntityMetadata.relations.forEach((subRelation) => {
+                if (subRelation.isEager) {
+                    processRelation(relationMetadata.inverseEntityMetadata, currentMetadataIsTree, subRelation.propertyPath, nextAlias, [fullPath], newEagerDepth);
+                }
+            });
+        }
+        if (nextPath) {
+            processRelation(relationMetadata.inverseEntityMetadata, currentMetadataIsTree, nextPath, nextAlias, [fullPath]);
+        }
+    };
+    relationsArray.forEach((relationPath) => {
+        if (!joinedRelations.has(relationPath)) {
+            processRelation(sourceMetadata, sourceMetadataIsTree, relationPath, qb.alias);
+        }
+    });
+    return joinedRelations;
+}
+exports.joinTreeRelationsDynamically = joinTreeRelationsDynamically;
+//# sourceMappingURL=tree-relations-qb-joiner.js.map

package/dist/service/helpers/utils/tree-relations-qb-joiner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-relations-qb-joiner.js","sourceRoot":"","sources":["../../../../src/service/helpers/utils/tree-relations-qb-joiner.ts"],"names":[],"mappings":";;;AAOA,mGAA4F;AAG5F;;;;;;GAMG;AACH,SAAS,oBAAoB,CAAC,QAAwB;IACpD,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,MAAM,QAAQ,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QAC1C,IAAI,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YACrD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,QAAQ,CAAC,qBAAqB,KAAK,QAAQ,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAgB,4BAA4B,CAC1C,EAAyB,EACzB,MAAuB,EACvB,qBAAkD,EAAE,EACpD,gBAAwB,CAAC;IAEzB,MAAM,eAAe,GAAG,IAAI,GAAG,EAAkB,CAAC;IAClD,MAAM,cAAc,GAAG,IAAA,uDAAwB,EAAC,kBAAkB,CAAC,CAAC;IACpE,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAC3B,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,MAAM,cAAc,GAAG,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACzD,MAAM,oBAAoB,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAElE,MAAM,eAAe,GAAG,CACtB,eAA+B,EAC/B,oBAA6B,EAC7B,WAAmB,EACnB,YAAoB,EACpB,UAAqB,EACrB,aAAqB,CAAC,EACtB,EAAE;QACF,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QACD,UAAU,GAAG,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QACjD,MAAM,qBAAqB,GACzB,oBAAoB,CAAC,eAAe,CAAC;YACrC,oBAAoB;YACpB,oBAAoB,CAAC;QACvB,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,IAAI,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;QAEzB,IAAI,CAAC,IAAI,IAAI,CAAC,eAAe;YAAE,OAAO;QAEtC,IAAI,IAAI,KAAK,cAAc,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ;gBAAE,OAAO;YACtB,IAAI,IAAI,IAAI,QAAQ,EAAE,CAAC;QACzB,CAAC;QAED,MAAM,gBAAgB,GAAG,eAAe,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;QAE5E,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,OAAO;QACT,CAAC;QAED,IAAI,aAAa,GAAG,GAAG,CAAC;QACxB,IAAI,gBAAgB,CAAC,OAAO,EAAE,CAAC;YAC7B,aAAa,GAAG,IAAI,CAAC;QACvB,CAAC;QACD,MAAM,SAAS,GAAG,GAAG,YAAY,GAAG,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;QAC/E,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzD,IACE,CAAC,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,EAC1E,CAAC;YACD,EAAE,CAAC,iBAAiB,CAAC,GAAG,YAAY,IAAI,IAAI,EAAE,EAAE,SAAS,CAAC,CAAC;YAC3D,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM,2BAA2B,GAAG,oBAAoB,CACtD,gBAAgB,CAAC,qBAAqB,CACvC,CAAC;QAEF,IAAI,CAAC,qBAAqB,IAAI,CAAC,2BAA2B,EAAE,CAAC;YAC3D,OAAO;QACT,CAAC;QAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,OAAO;YAC5C,CAAC,CAAC,UAAU,GAAG,CAAC;YAChB,CAAC,CAAC,UAAU,CAAC;QAEf,IAAI,aAAa,IAAI,aAAa,EAAE,CAAC;YACnC,gBAAgB,CAAC,qBAAqB,CAAC,SAAS,CAAC,OAAO,CACtD,CAAC,WAAW,EAAE,EAAE;gBACd,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;oBACxB,eAAe,CACb,gBAAgB,CAAC,qBAAqB,EACtC,qBAAqB,EACrB,WAAW,CAAC,YAAY,EACxB,SAAS,EACT,CAAC,QAAQ,CAAC,EACV,aAAa,CACd,CAAC;gBACJ,CAAC;YACH,CAAC,CACF,CAAC;QACJ,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,eAAe,CACb,gBAAgB,CAAC,qBAAqB,EACtC,qBAAqB,EACrB,QAAQ,EACR,SAAS,EACT,CAAC,QAAQ,CAAC,CACX,CAAC;QACJ,CAAC;IACH,CAAC,CAAC;IAEF,cAAc,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;QACtC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;YACvC,eAAe,CACb,cAAc,EACd,oBAAoB,EACpB,YAAY,EACZ,EAAE,CAAC,KAAK,CACT,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,eAAe,CAAC;AACzB,CAAC;AAtHD,oEAsHC"}