@antelopejs/interface-data-api 0.4.0 → 0.6.0

package/dist/internal/foreign.js

@@ -0,0 +1,116 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Foreign = Foreign;
+const interface_database_1 = require("@antelopejs/interface-database");
+const tables_1 = require("./tables");
+function Foreign(db, meta, query, pluck) {
+    if ((0, interface_database_1.IsStream)(query)) {
+        for (const [name, field] of Object.entries(meta.fields)) {
+            if (!field.foreign || (pluck && !pluck.has(name))) {
+                continue;
+            }
+            const [table, tableClass, index, multi, pluckField, schemaName, targetJoined,] = field.foreign;
+            const other = (0, tables_1.targetTable)(db, { table, tableClass, schemaName });
+            const hasTargetJoined = !multi && !!targetJoined?.length;
+            if (pluckField) {
+                const lookupPluck = hasTargetJoined
+                    ? Array.from(new Set([...pluckField, ...targetJoined.map((g) => g.localKey)]))
+                    : pluckField;
+                query = query.lookup((0, tables_1.pluckedTable)(other, ...lookupPluck), name, index || "_id");
+            }
+            else {
+                query = query.lookup(other, name, index || "_id");
+            }
+            if (hasTargetJoined) {
+                query = applyForeignJoinedStream(db, query, name, targetJoined);
+            }
+        }
+        return query;
+    }
+    else {
+        const oldForeign = (obj) => {
+            const changedFields = {};
+            for (const [name, field] of Object.entries(meta.fields)) {
+                if (!field.foreign || (pluck && !pluck.has(name))) {
+                    continue;
+                }
+                const [table, tableClass, index, multi, pluckField, schemaName, targetJoined,] = field.foreign;
+                const remote = (0, tables_1.targetTable)(db, { table, tableClass, schemaName });
+                if (multi) {
+                    changedFields[name] = obj
+                        .key(name)
+                        .cast()
+                        .default([])
+                        .map((val) => {
+                        let foreignObject = (0, tables_1.Get)(remote, val, index);
+                        if (pluckField) {
+                            foreignObject = foreignObject.pluck("_internal", ...pluckField);
+                        }
+                        return foreignObject.default(null);
+                    });
+                }
+                else {
+                    let foreignObject = (0, tables_1.Get)(remote, obj.key(name).cast(), index);
+                    if (targetJoined && targetJoined.length > 0) {
+                        foreignObject = applyForeignJoinedDatum(db, foreignObject, targetJoined);
+                    }
+                    changedFields[name] = foreignObject.default(null);
+                }
+            }
+            return obj.merge(changedFields);
+        };
+        return query.do(oldForeign);
+    }
+}
+/**
+ * Re-materializes the `@Joined` fields of a relation target on the looked-up
+ * sub-object (Stream/list path). The base `Foreign` lookup only plucks the
+ * target's physical columns, so a joined label would come back empty; here we
+ * resolve each joined field with a second lookup keyed on the target's
+ * (already plucked) local key, then merge it back into the relation object.
+ * For an orphan foreign key the merge yields `{ [joined]: null }`: the
+ * database DSL has no value-level conditional to null the relation here, so
+ * {@link Validation.ClearInternal} normalizes it back to a null relation.
+ */
+function applyForeignJoinedStream(db, stream, foreignName, groups) {
+    let s = stream;
+    for (const group of groups) {
+        const remoteTable = (0, tables_1.pluckedTable)((0, tables_1.targetTable)(db, group), group.remoteIndex, group.remoteField);
+        const tmpKey = `__fjoin_${foreignName}_${group.name}`;
+        s = s
+            .map((row) => row.merge({
+            [tmpKey]: row.key(foreignName).key(group.localKey),
+        }))
+            .lookup(remoteTable, tmpKey, group.remoteIndex)
+            .map((row) => row.merge({
+            [foreignName]: row.key(foreignName).merge({
+                [group.name]: row
+                    .key(tmpKey)
+                    .default({})
+                    .key(group.remoteField)
+                    .default(null),
+            }),
+        }))
+            .without(tmpKey);
+    }
+    return s;
+}
+/**
+ * Datum/get counterpart of {@link applyForeignJoinedStream}: resolves each of
+ * the target's `@Joined` fields with a secondary `Get` and merges it into the
+ * relation object.
+ */
+function applyForeignJoinedDatum(db, datum, groups) {
+    let d = datum;
+    for (const group of groups) {
+        const remoteTable = (0, tables_1.targetTable)(db, group);
+        d = d.do((row) => row.merge({
+            [group.name]: (0, tables_1.Get)(remoteTable, row.key(group.localKey), group.remoteIndex)
+                .key(group.remoteField)
+                .default(null),
+        }));
+    }
+    return d;
+}
+//# sourceMappingURL=foreign.js.map

package/dist/internal/foreign.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"foreign.js","sourceRoot":"","sources":["../../src/internal/foreign.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AAiCtC,0BA0FC;AAzHD,uEAMwC;AAGxC,qCAAyE;AAsBzE,SAAgB,OAAO,CACrB,EAAuB,EACvB,IAAiB,EACjB,KAA+B,EAC/B,KAAmB;IAEnB,IAAI,IAAA,6BAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;QACpB,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACxD,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gBAClD,SAAS;YACX,CAAC;YACD,MAAM,CACJ,KAAK,EACL,UAAU,EACV,KAAK,EACL,KAAK,EACL,UAAU,EACV,UAAU,EACV,YAAY,EACb,GAAG,KAAK,CAAC,OAAO,CAAC;YAClB,MAAM,KAAK,GAAG,IAAA,oBAAW,EAAC,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC;YACjE,MAAM,eAAe,GAAG,CAAC,KAAK,IAAI,CAAC,CAAC,YAAY,EAAE,MAAM,CAAC;YACzD,IAAI,UAAU,EAAE,CAAC;gBACf,MAAM,WAAW,GAAG,eAAe;oBACjC,CAAC,CAAC,KAAK,CAAC,IAAI,CACR,IAAI,GAAG,CAAC,CAAC,GAAG,UAAU,EAAE,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CACjE;oBACH,CAAC,CAAC,UAAU,CAAC;gBACf,KAAK,GAAG,KAAK,CAAC,MAAM,CAClB,IAAA,qBAAY,EAAC,KAAK,EAAE,GAAG,WAAW,CAAC,EACnC,IAAI,EACJ,KAAK,IAAI,KAAK,CACf,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,KAAK,CAAC,CAAC;YACpD,CAAC;YACD,IAAI,eAAe,EAAE,CAAC;gBACpB,KAAK,GAAG,wBAAwB,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;YAClE,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;SAAM,CAAC;QACN,MAAM,UAAU,GAAG,CAAC,GAAa,EAAE,EAAE;YACnC,MAAM,aAAa,GAAiD,EAAE,CAAC;YACvE,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBACxD,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;oBAClD,SAAS;gBACX,CAAC;gBACD,MAAM,CACJ,KAAK,EACL,UAAU,EACV,KAAK,EACL,KAAK,EACL,UAAU,EACV,UAAU,EACV,YAAY,EACb,GAAG,KAAK,CAAC,OAAO,CAAC;gBAClB,MAAM,MAAM,GAAG,IAAA,oBAAW,EAAC,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC;gBAClE,IAAI,KAAK,EAAE,CAAC;oBACV,aAAa,CAAC,IAAI,CAAC,GAAG,GAAG;yBACtB,GAAG,CAAC,IAAI,CAAC;yBACT,IAAI,EAAY;yBAChB,OAAO,CAAC,EAAE,CAAC;yBACX,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;wBACX,IAAI,aAAa,GAAe,IAAA,YAAG,EAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;wBACxD,IAAI,UAAU,EAAE,CAAC;4BACf,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,UAAU,CAAC,CAAC;wBAClE,CAAC;wBACD,OAAO,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBACrC,CAAC,CAAC,CAAC;gBACP,CAAC;qBAAM,CAAC;oBACN,IAAI,aAAa,GAAe,IAAA,YAAG,EACjC,MAAM,EACN,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,EAAU,EAC5B,KAAK,CACN,CAAC;oBACF,IAAI,YAAY,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAC5C,aAAa,GAAG,uBAAuB,CACrC,EAAE,EACF,aAAa,EACb,YAAY,CACb,CAAC;oBACJ,CAAC;oBACD,aAAa,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACpD,CAAC;YACH,CAAC;YACD,OAAO,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAClC,CAAC,CAAC;QACF,OAAO,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,wBAAwB,CAC/B,EAAuB,EACvB,MAAmB,EACnB,WAAmB,EACnB,MAA0B;IAE1B,IAAI,CAAC,GAAG,MAAM,CAAC;IACf,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,WAAW,GAAG,IAAA,qBAAY,EAC9B,IAAA,oBAAW,EAAC,EAAE,EAAE,KAAK,CAAC,EACtB,KAAK,CAAC,WAAW,EACjB,KAAK,CAAC,WAAW,CAClB,CAAC;QACF,MAAM,MAAM,GAAG,WAAW,WAAW,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACtD,CAAC,GAAG,CAAC;aACF,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACX,GAAG,CAAC,KAAK,CAAC;YACR,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC;SACnD,CAAC,CACH;aACA,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC;aAC9C,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACX,GAAG,CAAC,KAAK,CAAC;YACR,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;gBACxC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG;qBACd,GAAG,CAAC,MAAM,CAAC;qBACX,OAAO,CAAC,EAAE,CAAC;qBACX,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC;qBACtB,OAAO,CAAC,IAAI,CAAC;aACjB,CAAC;SACH,CAAC,CACH;aACA,OAAO,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;;;GAIG;AACH,SAAS,uBAAuB,CAC9B,EAAuB,EACvB,KAAiB,EACjB,MAA0B;IAE1B,IAAI,CAAC,GAAG,KAAK,CAAC;IACd,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,WAAW,GAAG,IAAA,oBAAW,EAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC3C,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,EAAE,CACf,GAAG,CAAC,KAAK,CAAC;YACR,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAA,YAAG,EACf,WAAW,EACX,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,EACvB,KAAK,CAAC,WAAW,CAClB;iBACE,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC;iBACtB,OAAO,CAAC,IAAI,CAAC;SACjB,CAAC,CACH,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC"}

package/dist/internal/guards.d.ts

@@ -0,0 +1,39 @@
+/** @internal @packageDocumentation */
+import type { Class } from "@antelopejs/interface-core/decorators";
+import type { WriteDocument, WriteValue } from "@antelopejs/interface-database/common";
+import type { FieldValue, FieldValues, RowFields } from "./field-types";
+/** Whether a value is a string. */
+export declare function isString(value: unknown): value is string;
+/** Whether `typeof` calls a value an object and it is not `null`: arrays qualify, functions do not (the predicate `object` still types a function as one). */
+export declare function isObject(value: unknown): value is object;
+/** Whether a value is a function, whatever its parameters. */
+export declare function isFunction(value: unknown): value is Function;
+/**
+ * Whether a value is a class: a function with an object `prototype`, which
+ * arrow functions, methods and bound functions lack. A generator function
+ * has one too, a language limit this check shares with every `prototype`
+ * test.
+ */
+export declare function isClass(value: unknown): value is Class<object>;
+/** Whether a value is a number. */
+export declare function isNumber(value: unknown): value is number;
+/** Whether a value is a boolean. */
+export declare function isBoolean(value: unknown): value is boolean;
+/**
+ * Whether a value is a {@link FieldValue}: JSON or `Date` all the way down,
+ * with no cycle. The walk keeps its own stack, so a deeply nested body is
+ * not bounded by the call stack.
+ */
+export declare function isFieldValue(value: unknown): value is FieldValue;
+/** Whether a value is {@link FieldValues}: a plain object holding field values. */
+export declare function isFieldValues(value: unknown): value is FieldValues;
+/**
+ * Whether a value is a {@link WriteValue}: `null`, text, a number, a boolean,
+ * `undefined`, or an object whose own enumerable values are write values, all
+ * the way down. A `bigint`, a `symbol` or a function anywhere fails. An object
+ * is read by its own values whatever its prototype, as the type reads it, and
+ * an object met again, as in a cycle, is read once.
+ */
+export declare function isWriteValue(value: unknown): value is WriteValue;
+/** Whether every own field of a row holds a {@link WriteValue}. */
+export declare function isWriteDocument(row: RowFields): row is WriteDocument;

package/dist/internal/guards.js

@@ -0,0 +1,116 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isString = isString;
+exports.isObject = isObject;
+exports.isFunction = isFunction;
+exports.isClass = isClass;
+exports.isNumber = isNumber;
+exports.isBoolean = isBoolean;
+exports.isFieldValue = isFieldValue;
+exports.isFieldValues = isFieldValues;
+exports.isWriteValue = isWriteValue;
+exports.isWriteDocument = isWriteDocument;
+/** Whether a value is a string. */
+function isString(value) {
+    return typeof value === "string";
+}
+/** Whether `typeof` calls a value an object and it is not `null`: arrays qualify, functions do not (the predicate `object` still types a function as one). */
+function isObject(value) {
+    return typeof value === "object" && value !== null;
+}
+/** Whether a value is a function, whatever its parameters. */
+function isFunction(value) {
+    return typeof value === "function";
+}
+/**
+ * Whether a value is a class: a function with an object `prototype`, which
+ * arrow functions, methods and bound functions lack. A generator function
+ * has one too, a language limit this check shares with every `prototype`
+ * test.
+ */
+function isClass(value) {
+    return isFunction(value) && isObject(value.prototype);
+}
+/** Whether a value is a number. */
+function isNumber(value) {
+    return typeof value === "number";
+}
+/** Whether a value is a boolean. */
+function isBoolean(value) {
+    return typeof value === "boolean";
+}
+/**
+ * Whether a value is a {@link FieldValue}: JSON or `Date` all the way down,
+ * with no cycle. The walk keeps its own stack, so a deeply nested body is
+ * not bounded by the call stack.
+ */
+function isFieldValue(value) {
+    const ancestors = new Set();
+    const steps = [{ value, leaving: false }];
+    for (let step = steps.pop(); step; step = steps.pop()) {
+        if (step.leaving) {
+            ancestors.delete(step.value);
+            continue;
+        }
+        const current = step.value;
+        if (current === null || isString(current) || isNumber(current))
+            continue;
+        if (isBoolean(current) || current instanceof Date)
+            continue;
+        if (!isObject(current) || ancestors.has(current))
+            return false;
+        const isArray = Array.isArray(current);
+        const prototype = Object.getPrototypeOf(current);
+        if (!isArray && prototype !== Object.prototype && prototype !== null) {
+            return false;
+        }
+        ancestors.add(current);
+        steps.push({ value: current, leaving: true });
+        for (const member of Object.values(current)) {
+            if (member === undefined && isArray)
+                return false;
+            if (member !== undefined)
+                steps.push({ value: member, leaving: false });
+        }
+    }
+    return true;
+}
+/** Whether a value is {@link FieldValues}: a plain object holding field values. */
+function isFieldValues(value) {
+    return (isFieldValue(value) &&
+        isObject(value) &&
+        !Array.isArray(value) &&
+        !(value instanceof Date));
+}
+/** The `typeof` answers of the primitives a {@link WriteValue} may be. */
+const STORED_PRIMITIVES = new Set(["string", "number", "boolean", "undefined"]);
+/**
+ * Whether a value is a {@link WriteValue}: `null`, text, a number, a boolean,
+ * `undefined`, or an object whose own enumerable values are write values, all
+ * the way down. A `bigint`, a `symbol` or a function anywhere fails. An object
+ * is read by its own values whatever its prototype, as the type reads it, and
+ * an object met again, as in a cycle, is read once.
+ */
+function isWriteValue(value) {
+    const seen = new Set();
+    const pending = [value];
+    while (pending.length > 0) {
+        const current = pending.pop();
+        if (current === null || STORED_PRIMITIVES.has(typeof current))
+            continue;
+        if (!isObject(current))
+            return false;
+        if (seen.has(current))
+            continue;
+        seen.add(current);
+        for (const member of Object.values(current))
+            pending.push(member);
+    }
+    return true;
+}
+/** Whether every own field of a row holds a {@link WriteValue}. */
+function isWriteDocument(row) {
+    return Object.values(row).every(isWriteValue);
+}
+//# sourceMappingURL=guards.js.map

package/dist/internal/guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.js","sourceRoot":"","sources":["../../src/internal/guards.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AAWtC,4BAEC;AAGD,4BAEC;AAGD,gCAEC;AAQD,0BAEC;AAGD,4BAEC;AAGD,8BAEC;AAaD,oCAyBC;AAGD,sCAOC;AAYD,oCAYC;AAGD,0CAEC;AA9GD,mCAAmC;AACnC,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED,8JAA8J;AAC9J,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC;AAED,8DAA8D;AAC9D,SAAgB,UAAU,CAAC,KAAc;IACvC,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,OAAO,CAAC,KAAc;IACpC,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACxD,CAAC;AAED,mCAAmC;AACnC,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED,oCAAoC;AACpC,SAAgB,SAAS,CAAC,KAAc;IACtC,OAAO,OAAO,KAAK,KAAK,SAAS,CAAC;AACpC,CAAC;AAQD;;;;GAIG;AACH,SAAgB,YAAY,CAAC,KAAc;IACzC,MAAM,SAAS,GAAG,IAAI,GAAG,EAAW,CAAC;IACrC,MAAM,KAAK,GAAe,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IACtD,KAAK,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC;QACtD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC7B,SAAS;QACX,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC;QAC3B,IAAI,OAAO,KAAK,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC;YAAE,SAAS;QACzE,IAAI,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,YAAY,IAAI;YAAE,SAAS;QAC5D,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC;YAAE,OAAO,KAAK,CAAC;QAC/D,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,SAAS,GAAY,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,OAAO,IAAI,SAAS,KAAK,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;YACrE,OAAO,KAAK,CAAC;QACf,CAAC;QACD,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5C,IAAI,MAAM,KAAK,SAAS,IAAI,OAAO;gBAAE,OAAO,KAAK,CAAC;YAClD,IAAI,MAAM,KAAK,SAAS;gBAAE,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,mFAAmF;AACnF,SAAgB,aAAa,CAAC,KAAc;IAC1C,OAAO,CACL,YAAY,CAAC,KAAK,CAAC;QACnB,QAAQ,CAAC,KAAK,CAAC;QACf,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACrB,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,CACzB,CAAC;AACJ,CAAC;AAED,0EAA0E;AAC1E,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;AAEhF;;;;;;GAMG;AACH,SAAgB,YAAY,CAAC,KAAc;IACzC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,OAAO,GAAc,CAAC,KAAK,CAAC,CAAC;IACnC,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;QAC9B,IAAI,OAAO,KAAK,IAAI,IAAI,iBAAiB,CAAC,GAAG,CAAC,OAAO,OAAO,CAAC;YAAE,SAAS;QACxE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,OAAO,KAAK,CAAC;QACrC,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;YAAE,SAAS;QAChC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClB,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;YAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,mEAAmE;AACnE,SAAgB,eAAe,CAAC,GAAc;IAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;AAChD,CAAC"}

package/dist/internal/joined.d.ts

@@ -0,0 +1,28 @@
+/** @internal @packageDocumentation */
+import { type Datum, type SchemaInstance, type Stream } from "@antelopejs/interface-database";
+import type { DataAPIMeta, FieldFilter } from "../metadata";
+export interface JoinedFieldSplit {
+    filter: Set<string>;
+    sort: Set<string>;
+}
+/**
+ * Splits the joined fields of `meta` between those {@link List} must
+ * materialize before the filter and count (`filter`) and those it only
+ * needs after the count (`sort`). Joined fields referenced by neither are
+ * left out so the list route can defer their lookups to the returned page.
+ *
+ * Computed expressions may read joined fields, so materializing a computed
+ * field pulls every remaining joined group in with it. Groups whose local
+ * key is also a foreign field must resolve before `Foreign` replaces the
+ * key with the looked-up record.
+ */
+export declare function splitJoinedFields(meta: DataAPIMeta, sorting?: [string, "asc" | "desc" | undefined], filters?: Record<string, FieldFilter>): JoinedFieldSplit;
+/**
+ * Joined field names that {@link List} does not materialize for the given
+ * split. The default list route resolves these after pagination so their
+ * lookups only run on the returned page.
+ */
+export declare function deferredJoinedFields(meta: DataAPIMeta, split: JoinedFieldSplit): Set<string>;
+export declare function Joined(db: SchemaInstance<any>, meta: DataAPIMeta, query: Stream<any>, only?: Set<string>): Stream<any>;
+export declare function Joined(db: SchemaInstance<any>, meta: DataAPIMeta, query: Datum<any>, only?: Set<string>): Datum<any>;
+export declare function Joined(db: SchemaInstance<any>, meta: DataAPIMeta, query: Stream<any> | Datum<any>, only?: Set<string>): Stream<any> | Datum<any>;

package/dist/internal/joined.js

@@ -0,0 +1,127 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.splitJoinedFields = splitJoinedFields;
+exports.deferredJoinedFields = deferredJoinedFields;
+exports.Joined = Joined;
+const interface_database_1 = require("@antelopejs/interface-database");
+const tables_1 = require("./tables");
+function collectJoinedGroups(meta) {
+    const groups = new Map();
+    for (const [name, field] of Object.entries(meta.fields)) {
+        if (!field.joined)
+            continue;
+        const j = field.joined;
+        const groupKey = `${j.schemaName ?? ""}|${j.table}|${j.localKey}|${j.remoteIndex}`;
+        let group = groups.get(groupKey);
+        if (!group) {
+            group = {
+                table: j.table,
+                tableClass: j.tableClass,
+                localKey: j.localKey,
+                remoteIndex: j.remoteIndex,
+                schemaName: j.schemaName,
+                fields: [],
+            };
+            groups.set(groupKey, group);
+        }
+        group.fields.push({ name, remoteField: j.remoteField });
+    }
+    return Array.from(groups.values());
+}
+function addAll(target, names) {
+    for (const name of names) {
+        target.add(name);
+    }
+}
+/**
+ * Splits the joined fields of `meta` between those {@link List} must
+ * materialize before the filter and count (`filter`) and those it only
+ * needs after the count (`sort`). Joined fields referenced by neither are
+ * left out so the list route can defer their lookups to the returned page.
+ *
+ * Computed expressions may read joined fields, so materializing a computed
+ * field pulls every remaining joined group in with it. Groups whose local
+ * key is also a foreign field must resolve before `Foreign` replaces the
+ * key with the looked-up record.
+ */
+function splitJoinedFields(meta, sorting, filters) {
+    const split = { filter: new Set(), sort: new Set() };
+    const filterNames = Object.keys(meta.filters).filter((name) => filters && Object.hasOwn(filters, name));
+    const hasComputedFilter = filterNames.some((name) => meta.fields[name]?.computed);
+    const sortField = sorting?.[0];
+    const hasComputedSort = !!sortField && !!meta.fields[sortField]?.computed;
+    for (const group of collectJoinedGroups(meta)) {
+        const names = group.fields.map((field) => field.name);
+        if (hasComputedFilter || names.some((name) => filterNames.includes(name))) {
+            addAll(split.filter, names);
+        }
+        else if (hasComputedSort ||
+            (sortField && names.includes(sortField)) ||
+            meta.fields[group.localKey]?.foreign) {
+            addAll(split.sort, names);
+        }
+    }
+    return split;
+}
+/**
+ * Joined field names that {@link List} does not materialize for the given
+ * split. The default list route resolves these after pagination so their
+ * lookups only run on the returned page.
+ */
+function deferredJoinedFields(meta, split) {
+    return new Set(Object.entries(meta.fields)
+        .filter(([name, field]) => field.joined && !split.filter.has(name) && !split.sort.has(name))
+        .map(([name]) => name));
+}
+function Joined(db, meta, query, only) {
+    const groups = collectJoinedGroups(meta).filter((group) => !only || group.fields.some((field) => only.has(field.name)));
+    if (groups.length === 0) {
+        return query;
+    }
+    const emptyRemote = {};
+    const tmpKeyFor = (localKey) => `__joined_orig_${localKey}`;
+    if ((0, interface_database_1.IsStream)(query)) {
+        let stream = query;
+        const tmpKeys = [];
+        for (const group of groups) {
+            const remoteFields = group.fields.map((f) => f.remoteField);
+            const remoteTable = (0, tables_1.pluckedTable)((0, tables_1.targetTable)(db, group), group.remoteIndex, ...remoteFields);
+            const tmpKey = tmpKeyFor(group.localKey);
+            tmpKeys.push(tmpKey);
+            stream = stream
+                .map((row) => row.merge({ [tmpKey]: row.key(group.localKey) }))
+                .lookup(remoteTable, group.localKey, group.remoteIndex)
+                .map((row) => {
+                const merged = {};
+                const remote = row.key(group.localKey).default(emptyRemote);
+                for (const f of group.fields) {
+                    merged[f.name] = remote.key(f.remoteField).default(null);
+                }
+                merged[group.localKey] = row.key(tmpKey);
+                return row.merge(merged);
+            });
+        }
+        return stream.without(...tmpKeys);
+    }
+    let datum = query;
+    for (const group of groups) {
+        const remoteFields = group.fields.map((f) => f.remoteField);
+        const remoteTable = (0, tables_1.pluckedTable)((0, tables_1.targetTable)(db, group), group.remoteIndex, ...remoteFields);
+        const tmpKey = tmpKeyFor(group.localKey);
+        datum = datum
+            .do((row) => row.merge({ [tmpKey]: row.key(group.localKey) }))
+            .lookup(remoteTable, group.localKey, group.remoteIndex)
+            .do((row) => {
+            const merged = {};
+            const remote = row.key(group.localKey).default(emptyRemote);
+            for (const f of group.fields) {
+                merged[f.name] = remote.key(f.remoteField).default(null);
+            }
+            merged[group.localKey] = row.key(tmpKey);
+            return row.merge(merged);
+        });
+    }
+    return datum;
+}
+//# sourceMappingURL=joined.js.map

package/dist/internal/joined.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"joined.js","sourceRoot":"","sources":["../../src/internal/joined.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AAiEtC,8CA2BC;AAOD,oDAYC;AAsBD,wBAmEC;AAtMD,uEAMwC;AAGxC,qCAAgF;AAShF,SAAS,mBAAmB,CAAC,IAAiB;IAC5C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAuB,CAAC;IAC9C,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,SAAS;QAC5B,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;QACvB,MAAM,QAAQ,GAAG,GAAG,CAAC,CAAC,UAAU,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;QACnF,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG;gBACN,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,UAAU,EAAE,CAAC,CAAC,UAAU;gBACxB,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,WAAW,EAAE,CAAC,CAAC,WAAW;gBAC1B,UAAU,EAAE,CAAC,CAAC,UAAU;gBACxB,MAAM,EAAE,EAAE;aACX,CAAC;YACF,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;AACrC,CAAC;AAOD,SAAS,MAAM,CAAC,MAAmB,EAAE,KAAe;IAClD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,iBAAiB,CAC/B,IAAiB,EACjB,OAA8C,EAC9C,OAAqC;IAErC,MAAM,KAAK,GAAqB,EAAE,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;IACvE,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAClD,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAClD,CAAC;IACF,MAAM,iBAAiB,GAAG,WAAW,CAAC,IAAI,CACxC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,CACtC,CAAC;IACF,MAAM,SAAS,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,eAAe,GAAG,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC;IAC1E,KAAK,MAAM,KAAK,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,iBAAiB,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC1E,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC;aAAM,IACL,eAAe;YACf,CAAC,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,OAAO,EACpC,CAAC;YACD,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAClC,IAAiB,EACjB,KAAuB;IAEvB,OAAO,IAAI,GAAG,CACZ,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;SACxB,MAAM,CACL,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAChB,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CACnE;SACA,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CACzB,CAAC;AACJ,CAAC;AAsBD,SAAgB,MAAM,CACpB,EAAuB,EACvB,IAAiB,EACjB,KAA+B,EAC/B,IAAkB;IAElB,MAAM,MAAM,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC,MAAM,CAC7C,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CACvE,CAAC;IACF,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,MAAM,SAAS,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,iBAAiB,QAAQ,EAAE,CAAC;IAEpE,IAAI,IAAA,6BAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;QACpB,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;YAC5D,MAAM,WAAW,GAAG,IAAA,qBAAY,EAC9B,IAAA,oBAAW,EAAC,EAAE,EAAE,KAAK,CAAC,EACtB,KAAK,CAAC,WAAW,EACjB,GAAG,YAAY,CAChB,CAAC;YACF,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACzC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACrB,MAAM,GAAG,MAAM;iBACZ,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;iBAC9D,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC;iBACtD,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBACX,MAAM,MAAM,GAAoC,EAAE,CAAC;gBACnD,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBAC5D,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;oBAC7B,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC3D,CAAC;gBACD,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACzC,OAAO,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;QACP,CAAC;QACD,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;QAC5D,MAAM,WAAW,GAAG,IAAA,qBAAY,EAC9B,IAAA,oBAAW,EAAC,EAAE,EAAE,KAAK,CAAC,EACtB,KAAK,CAAC,WAAW,EACjB,GAAG,YAAY,CAChB,CAAC;QACF,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACzC,KAAK,GAAG,KAAK;aACV,EAAE,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;aAC7D,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC;aACtD,EAAE,CAAC,CAAC,GAAG,EAAE,EAAE;YACV,MAAM,MAAM,GAAoC,EAAE,CAAC;YACnD,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAC5D,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;gBAC7B,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3D,CAAC;YACD,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACzC,OAAO,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/internal/list.d.ts

@@ -0,0 +1,16 @@
+/** @internal @packageDocumentation */
+import type { RequestContext } from "@antelopejs/interface-api";
+import type { Datum, SchemaInstance, Stream, Table } from "@antelopejs/interface-database";
+import type { Query } from "../components";
+import { type DataAPIMeta, type DataControllerInstance } from "../metadata";
+type ListPageOptions = Query.ListPageOptions;
+/** The arguments {@link Query.List} takes after the request context. */
+interface ListArguments {
+    sorting?: Parameters<typeof Query.List>[4];
+    filters?: Parameters<typeof Query.List>[5];
+    db?: Parameters<typeof Query.List>[6];
+    options?: Parameters<typeof Query.List>[7];
+}
+export declare function List<T extends Record<string, any>>(obj: DataControllerInstance, meta: DataAPIMeta, request: Table<T>, reqCtx: RequestContext, { sorting, filters, db, options }: ListArguments): [sorted: Stream<T>, total: Datum<number>, deferredJoined: Set<string>];
+export declare function ListPage(db: SchemaInstance<any>, meta: DataAPIMeta, query: Stream<any>, options: ListPageOptions): Stream<any>;
+export {};

package/dist/internal/list.js

@@ -0,0 +1,182 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.List = List;
+exports.ListPage = ListPage;
+const common_1 = require("@antelopejs/interface-database-decorators/common");
+const common_2 = require("@antelopejs/interface-database-decorators/modifiers/common");
+const metadata_1 = require("../metadata");
+const computed_1 = require("./computed");
+const deferred_joined_stream_1 = require("./deferred-joined-stream");
+const foreign_1 = require("./foreign");
+const joined_1 = require("./joined");
+const validation_1 = require("./validation");
+function listResultTuple(tmpRequest, total, meta, joinedSplit, { db, options }) {
+    const deferredJoined = (0, joined_1.deferredJoinedFields)(meta, joinedSplit);
+    if (options?.exposeDeferredJoined || !db || deferredJoined.size === 0) {
+        return [tmpRequest, total, deferredJoined];
+    }
+    return [
+        (0, deferred_joined_stream_1.wrapDeferredJoined)(db, meta, deferredJoined, tmpRequest),
+        total,
+        new Set(),
+    ];
+}
+/** Where a list sorted on a modifier-held field keeps the value it sorts on. */
+const MODIFIED_SORT_KEY = "__dataApiSortValue";
+/**
+ * Whether a field is held by a modifier the controller keys (a localized
+ * field read in the request's locale): stored under the modifier, it sorts
+ * on the value the request reads, not on the stored field.
+ */
+function isHeldByKeyedModifier(meta, field) {
+    const keyed = new Set(Array.from(meta.modifierKeys.keys(), (modifier) => modifier.name));
+    return ((0, common_1.getMetadata)(meta.tableClass, common_2.ModifiersStaticMetadata).fields[field]?.some(({ id }) => keyed.has(id)) ?? false);
+}
+/** The filters a request holds for a field, none when it holds none. */
+function filterValuesIn(filters, field) {
+    return filters && Object.hasOwn(filters, field)
+        ? (0, metadata_1.FilterValuesOf)(filters[field])
+        : [];
+}
+/**
+ * The rows {@link List} starts from: the index lookup serving the one field
+ * filtered once with `eq` on a single-field index, else the whole table.
+ */
+function indexedSource(meta, request, filterList, filters) {
+    const indexed = filterList.find(([field]) => {
+        const fieldFilters = filterValuesIn(filters, field);
+        return (fieldFilters.length === 1 &&
+            fieldFilters[0][1] === "eq" &&
+            meta.fields[field]?.indexable);
+    })?.[0];
+    const indexName = indexed
+        ? meta.fields[indexed].dbName || indexed
+        : undefined;
+    const equality = indexed ? filterValuesIn(filters, indexed)[0] : undefined;
+    const source = indexName
+        ? request.getAll(equality?.[0] ?? "", indexName)
+        : request;
+    return { indexFilter: indexed, source };
+}
+/**
+ * Merges the joined and computed fields the filters read, before
+ * {@link List} filters and counts.
+ */
+function materializeFilterFields(source, meta, db, joinedSplit, { filterList }) {
+    const joined = db && joinedSplit.filter.size > 0
+        ? (0, joined_1.Joined)(db, meta, source, joinedSplit.filter)
+        : source;
+    const filteredComputed = new Set(filterList
+        .map(([field]) => field)
+        .filter((field) => meta.fields[field]?.computed));
+    const stream = db && filteredComputed.size > 0
+        ? (0, computed_1.Computed)(db, meta, joined, filteredComputed)
+        : joined;
+    return { stream, filteredComputed };
+}
+/** The field a list request sorts on, how, and whether a modifier holds it. */
+function sortPlan(meta, sorting) {
+    const sortField = sorting?.[0];
+    const shouldSort = sortField ? meta.fields[sortField]?.sortable : undefined;
+    const isModifiedSort = !!shouldSort && !!sortField && isHeldByKeyedModifier(meta, sortField);
+    return { sortField, shouldSort, isModifiedSort };
+}
+/** Sorts on an indexed field before the filters, when the plan allows it. */
+function orderedByIndex(stream, { sortField, shouldSort, isModifiedSort }, sorting) {
+    if (shouldSort?.indexed && sortField && !isModifiedSort) {
+        return stream.orderBy(sortField, sorting?.[1] ?? "asc");
+    }
+    return stream;
+}
+/**
+ * Merges the joined fields the sort reads, then a computed sort field no
+ * filter already merged, after {@link List} counts.
+ */
+function materializeSortFields(stream, sortField, { db, meta, joinedSplit, filteredComputed }) {
+    if (!db)
+        return stream;
+    const joined = joinedSplit.sort.size > 0
+        ? (0, joined_1.Joined)(db, meta, stream, joinedSplit.sort)
+        : stream;
+    const sortsOnComputed = !!sortField &&
+        !!meta.fields[sortField]?.computed &&
+        !filteredComputed.has(sortField);
+    return sortsOnComputed
+        ? (0, computed_1.Computed)(db, meta, joined, new Set([sortField]))
+        : joined;
+}
+function List(obj, meta, request, reqCtx, { sorting, filters, db, options }) {
+    const filterList = Object.entries(meta.filters).filter(([name]) => filters && Object.hasOwn(filters, name));
+    const { indexFilter, source } = indexedSource(meta, request, filterList, filters);
+    const joinedSplit = (0, joined_1.splitJoinedFields)(meta, sorting, filters);
+    const filtering = materializeFilterFields(source, meta, db, joinedSplit, {
+        filterList,
+    });
+    const plan = sortPlan(meta, sorting);
+    const { sortField, shouldSort, isModifiedSort } = plan;
+    let tmpRequest = orderedByIndex(filtering.stream, plan, sorting);
+    if (filterList.length > 0) {
+        tmpRequest = filterList.reduce((req, [name, filter]) => {
+            const fieldFilter = filters?.[name];
+            if (!fieldFilter || name === indexFilter)
+                return req;
+            return (0, metadata_1.FilterValuesOf)(fieldFilter).reduce((filtered, [value, mode]) => filtered.filter((row) => filter(Object.assign(reqCtx, { this: obj }), (0, validation_1.UnlockRequest)(obj, meta, row, name), name, value, mode, row.cast())), req);
+        }, tmpRequest);
+    }
+    const total = tmpRequest.count();
+    tmpRequest = materializeSortFields(tmpRequest, sortField, {
+        db,
+        meta,
+        joinedSplit,
+        filteredComputed: filtering.filteredComputed,
+    });
+    if (isModifiedSort && sortField) {
+        tmpRequest = tmpRequest
+            .cast()
+            .map((row) => row.merge({
+            [MODIFIED_SORT_KEY]: (0, validation_1.UnlockRequest)(obj, meta, row, sortField),
+        }))
+            .orderBy(MODIFIED_SORT_KEY, sorting?.[1] ?? "asc")
+            .without(MODIFIED_SORT_KEY)
+            .cast();
+    }
+    else if (shouldSort && !shouldSort.indexed && sortField) {
+        tmpRequest = tmpRequest.orderBy(sortField, sorting?.[1] ?? "asc");
+    }
+    return listResultTuple(tmpRequest, total, meta, joinedSplit, {
+        db,
+        options,
+    });
+}
+function pageComputedFields(meta, options) {
+    const merged = new Set(Object.keys(options.filters ?? {}).filter((name) => Object.hasOwn(meta.filters, name)));
+    if (options.sortKey)
+        merged.add(options.sortKey);
+    const names = Object.entries(meta.fields)
+        .filter(([name, field]) => field.computed &&
+        !merged.has(name) &&
+        (!options.pluck || options.pluck.has(name)))
+        .map(([name]) => name);
+    return new Set(names);
+}
+function pageJoinedFields(options, materializeAll) {
+    const deferred = options.deferredJoined ?? new Set();
+    if (materializeAll || !options.pluck)
+        return deferred;
+    const pluck = options.pluck;
+    return new Set(Array.from(deferred).filter((name) => pluck.has(name)));
+}
+function ListPage(db, meta, query, options) {
+    let page = query.slice(options.offset, options.limit);
+    const computed = pageComputedFields(meta, options);
+    const joined = pageJoinedFields(options, computed.size > 0);
+    if (joined.size > 0)
+        page = (0, joined_1.Joined)(db, meta, page, joined);
+    if (computed.size > 0)
+        page = (0, computed_1.Computed)(db, meta, page, computed);
+    if (!options.noForeign)
+        page = (0, foreign_1.Foreign)(db, meta, page, options.pluck);
+    return options.pluck ? page.pluck("_internal", ...options.pluck) : page;
+}
+//# sourceMappingURL=list.js.map