@antelopejs/interface-data-api 0.4.0 → 0.5.0

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 && name in filters);
+    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,IAAI,IAAI,OAAO,CACrC,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 } 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: any, 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,178 @@
+"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 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 = filters ? (0, metadata_1.FilterValuesOf)(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
+        ? (0, metadata_1.FilterValuesOf)(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 && name in filters);
+    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) => name in meta.filters));
+    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

package/dist/internal/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../src/internal/list.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AA0MtC,oBAoEC;AA+BD,4BAaC;AAxTD,6EAA+E;AAS/E,uFAAqG;AAGrG,0CAIqB;AACrB,yCAAsC;AACtC,qEAA8D;AAC9D,uCAAoC;AACpC,qCAKkB;AAClB,6CAA6C;AAmB7C,SAAS,eAAe,CACtB,UAAqB,EACrB,KAAoB,EACpB,IAAiB,EACjB,WAA6B,EAC7B,EAAE,EAAE,EAAE,OAAO,EAAmB;IAEhC,MAAM,cAAc,GAAG,IAAA,6BAAoB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAC/D,IAAI,OAAO,EAAE,oBAAoB,IAAI,CAAC,EAAE,IAAI,cAAc,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACtE,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO;QACL,IAAA,2CAAkB,EAAC,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,CAAC;QACxD,KAAK;QACL,IAAI,GAAG,EAAE;KACV,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,MAAM,iBAAiB,GAAG,oBAAoB,CAAC;AAE/C;;;;GAIG;AACH,SAAS,qBAAqB,CAAC,IAAiB,EAAE,KAAa;IAC7D,MAAM,KAAK,GAAG,IAAI,GAAG,CACnB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAClE,CAAC;IACF,OAAO,CACL,IAAA,oBAAW,EAAC,IAAI,CAAC,UAAU,EAAE,gCAAuB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,CACvE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAC1B,IAAI,KAAK,CACX,CAAC;AACJ,CAAC;AAWD;;;GAGG;AACH,SAAS,aAAa,CACpB,IAAiB,EACjB,OAAiB,EACjB,UAAyB,EACzB,OAAqC;IAErC,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE;QAC1C,MAAM,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,IAAA,yBAAc,EAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,OAAO,CACL,YAAY,CAAC,MAAM,KAAK,CAAC;YACzB,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI;YAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,SAAS,CAC9B,CAAC;IACJ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACR,MAAM,SAAS,GAAG,OAAO;QACvB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,IAAI,OAAO;QACxC,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,QAAQ,GAAG,OAAO;QACtB,CAAC,CAAC,IAAA,yBAAc,EAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,MAAM,GAAc,SAAS;QACjC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,SAAS,CAAC;QAChD,CAAC,CAAC,OAAO,CAAC;IACZ,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AAC1C,CAAC;AAED;;;GAGG;AACH,SAAS,uBAAuB,CAC9B,MAAiB,EACjB,IAAiB,EACjB,EAAmC,EACnC,WAA6B,EAC7B,EAAE,UAAU,EAAiC;IAE7C,MAAM,MAAM,GACV,EAAE,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC;QAC/B,CAAC,CAAC,IAAA,eAAM,EAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC;QAC9C,CAAC,CAAC,MAAM,CAAC;IACb,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAC9B,UAAU;SACP,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC;SACvB,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,CACnD,CAAC;IACF,MAAM,MAAM,GACV,EAAE,IAAI,gBAAgB,CAAC,IAAI,GAAG,CAAC;QAC7B,CAAC,CAAC,IAAA,mBAAQ,EAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC;QAC9C,CAAC,CAAC,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;AACtC,CAAC;AAED,+EAA+E;AAC/E,SAAS,QAAQ,CAAC,IAAiB,EAAE,OAAoB;IACvD,MAAM,SAAS,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5E,MAAM,cAAc,GAClB,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,SAAS,IAAI,qBAAqB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACxE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC;AACnD,CAAC;AAED,6EAA6E;AAC7E,SAAS,cAAc,CACrB,MAAiB,EACjB,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAA+B,EACtE,OAAoB;IAEpB,IAAI,UAAU,EAAE,OAAO,IAAI,SAAS,IAAI,CAAC,cAAc,EAAE,CAAC;QACxD,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAUD;;;GAGG;AACH,SAAS,qBAAqB,CAC5B,MAAiB,EACjB,SAA6B,EAC7B,EAAE,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,gBAAgB,EAAqB;IAE9D,IAAI,CAAC,EAAE;QAAE,OAAO,MAAM,CAAC;IACvB,MAAM,MAAM,GACV,WAAW,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC;QACvB,CAAC,CAAC,IAAA,eAAM,EAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC;QAC5C,CAAC,CAAC,MAAM,CAAC;IACb,MAAM,eAAe,GACnB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,QAAQ;QAClC,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACnC,OAAO,eAAe;QACpB,CAAC,CAAC,IAAA,mBAAQ,EAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QAClD,CAAC,CAAC,MAAM,CAAC;AACb,CAAC;AAED,SAAgB,IAAI,CAClB,GAAQ,EACR,IAAiB,EACjB,OAAiB,EACjB,MAAsB,EACtB,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAiB;IAEhD,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CACpD,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,OAAO,IAAI,IAAI,IAAI,OAAO,CACvC,CAAC;IACF,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,aAAa,CAC3C,IAAI,EACJ,OAAO,EACP,UAAU,EACV,OAAO,CACR,CAAC;IACF,MAAM,WAAW,GAAG,IAAA,0BAAiB,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAG,uBAAuB,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,WAAW,EAAE;QACvE,UAAU;KACX,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACrC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IACvD,IAAI,UAAU,GAAG,cAAc,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACjE,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;YACrD,MAAM,WAAW,GAAG,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;YACpC,IAAI,CAAC,WAAW,IAAI,IAAI,KAAK,WAAW;gBAAE,OAAO,GAAG,CAAC;YACrD,OAAO,IAAA,yBAAc,EAAC,WAAW,CAAC,CAAC,MAAM,CACvC,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAC1B,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CACtB,MAAM,CACJ,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EACpC,IAAA,0BAAa,EAAC,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,IAAI,EACJ,KAAK,EACL,IAAI,EACJ,GAAG,CAAC,IAAI,EAAkB,CAC3B,CACF,EACH,GAAG,CACJ,CAAC;QACJ,CAAC,EAAE,UAAU,CAAC,CAAC;IACjB,CAAC;IACD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC;IACjC,UAAU,GAAG,qBAAqB,CAAC,UAAU,EAAE,SAAS,EAAE;QACxD,EAAE;QACF,IAAI;QACJ,WAAW;QACX,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;KAC7C,CAAC,CAAC;IACH,IAAI,cAAc,IAAI,SAAS,EAAE,CAAC;QAChC,UAAU,GAAG,UAAU;aACpB,IAAI,EAAkB;aACtB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACX,GAAG,CAAC,KAAK,CAAC;YACR,CAAC,iBAAiB,CAAC,EAAE,IAAA,0BAAa,EAAC,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,CAAC;SAC9D,CAAC,CACH;aACA,OAAO,CAAC,iBAAiB,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC;aACjD,OAAO,CAAC,iBAAiB,CAAC;aAC1B,IAAI,EAAK,CAAC;IACf,CAAC;SAAM,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC;QAC1D,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,eAAe,CAAC,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE;QAC3D,EAAE;QACF,OAAO;KACR,CAAC,CAAC;AACL,CAAC;AAED,SAAS,kBAAkB,CACzB,IAAiB,EACjB,OAAwB;IAExB,MAAM,MAAM,GAAG,IAAI,GAAG,CACpB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,CAC1E,CAAC;IACF,IAAI,OAAO,CAAC,OAAO;QAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;SACtC,MAAM,CACL,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAChB,KAAK,CAAC,QAAQ;QACd,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;QACjB,CAAC,CAAC,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAC9C;SACA,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IACzB,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;AACxB,CAAC;AAED,SAAS,gBAAgB,CACvB,OAAwB,EACxB,cAAuB;IAEvB,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,IAAI,IAAI,GAAG,EAAU,CAAC;IAC7D,IAAI,cAAc,IAAI,CAAC,OAAO,CAAC,KAAK;QAAE,OAAO,QAAQ,CAAC;IACtD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAC5B,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,SAAgB,QAAQ,CACtB,EAAuB,EACvB,IAAiB,EACjB,KAAkB,EAClB,OAAwB;IAExB,IAAI,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACtD,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IAC5D,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC;QAAE,IAAI,GAAG,IAAA,eAAM,EAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC3D,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC;QAAE,IAAI,GAAG,IAAA,mBAAQ,EAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACjE,IAAI,CAAC,OAAO,CAAC,SAAS;QAAE,IAAI,GAAG,IAAA,iBAAO,EAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACtE,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC1E,CAAC"}

package/dist/internal/meta-records.d.ts

@@ -0,0 +1,17 @@
+/** @internal @packageDocumentation */
+import type { FieldData, ForeignJoinedRef } from "./field-types";
+/** Copies into `dst` the entries of `src` it lacks. */
+export declare function merge<Value>(src: Record<string, Value>, dst: Record<string, Value>): void;
+/** Rebuilds the fields each list mode plucks from the fields' listable modes. */
+export declare function rebuildPluck(pluck: Record<string, Set<string>>, fields: Record<string, FieldData>): void;
+/**
+ * The `@Joined` fields of a relation target that `pluck` names, or all of
+ * them when `pluck` is unset; `undefined` when there are none.
+ */
+export declare function targetJoinedFields(fields: Record<string, FieldData>, pluck?: string[]): ForeignJoinedRef[] | undefined;
+/**
+ * The database fields a listable field selects: itself (`true`), none
+ * (`false`) or the given ones, plus the field and its local key when it is
+ * joined and selects any.
+ */
+export declare function listedNames(name: string, requiredFields: boolean | string[], field: FieldData): string[];

package/dist/internal/meta-records.js

@@ -0,0 +1,73 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.merge = merge;
+exports.rebuildPluck = rebuildPluck;
+exports.targetJoinedFields = targetJoinedFields;
+exports.listedNames = listedNames;
+/** Copies into `dst` the entries of `src` it lacks. */
+function merge(src, dst) {
+    for (const key in src) {
+        if (!(key in dst)) {
+            dst[key] = src[key];
+        }
+    }
+}
+/** Rebuilds the fields each list mode plucks from the fields' listable modes. */
+function rebuildPluck(pluck, fields) {
+    for (const set of Object.values(pluck)) {
+        set.clear();
+    }
+    for (const [_, field] of Object.entries(fields)) {
+        if (field.listable) {
+            for (const [mode, names] of Object.entries(field.listable)) {
+                if (!(mode in pluck)) {
+                    pluck[mode] = new Set();
+                }
+                for (const name of names) {
+                    pluck[mode].add(name);
+                }
+            }
+        }
+    }
+}
+/**
+ * The `@Joined` fields of a relation target that `pluck` names, or all of
+ * them when `pluck` is unset; `undefined` when there are none.
+ */
+function targetJoinedFields(fields, pluck) {
+    const pluckSet = pluck ? new Set(pluck) : undefined;
+    const groups = [];
+    for (const [fieldName, field] of Object.entries(fields)) {
+        if (!field.joined || (pluckSet && !pluckSet.has(fieldName))) {
+            continue;
+        }
+        const j = field.joined;
+        groups.push({
+            name: fieldName,
+            table: j.table,
+            tableClass: j.tableClass,
+            localKey: j.localKey,
+            remoteField: j.remoteField,
+            remoteIndex: j.remoteIndex,
+            schemaName: j.schemaName,
+        });
+    }
+    return groups.length > 0 ? groups : undefined;
+}
+/**
+ * The database fields a listable field selects: itself (`true`), none
+ * (`false`) or the given ones, plus the field and its local key when it is
+ * joined and selects any.
+ */
+function listedNames(name, requiredFields, field) {
+    const baseNames = requiredFields === true
+        ? [name]
+        : requiredFields === false
+            ? []
+            : requiredFields;
+    return baseNames.length > 0 && field.joined
+        ? Array.from(new Set([...baseNames, name, field.joined.localKey]))
+        : baseNames;
+}
+//# sourceMappingURL=meta-records.js.map

package/dist/internal/meta-records.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta-records.js","sourceRoot":"","sources":["../../src/internal/meta-records.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AAKtC,sBASC;AAGD,oCAmBC;AAMD,gDAsBC;AAOD,kCAcC;AAjFD,uDAAuD;AACvD,SAAgB,KAAK,CACnB,GAA0B,EAC1B,GAA0B;IAE1B,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC;YAClB,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;AACH,CAAC;AAED,iFAAiF;AACjF,SAAgB,YAAY,CAC1B,KAAkC,EAClC,MAAiC;IAEjC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,GAAG,CAAC,KAAK,EAAE,CAAC;IACd,CAAC;IACD,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC3D,IAAI,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;oBACrB,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC;gBAC1B,CAAC;gBACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAChC,MAAiC,EACjC,KAAgB;IAEhB,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACpD,MAAM,MAAM,GAAuB,EAAE,CAAC;IACtC,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAC5D,SAAS;QACX,CAAC;QACD,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;QACvB,MAAM,CAAC,IAAI,CAAC;YACV,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,UAAU,EAAE,CAAC,CAAC,UAAU;YACxB,QAAQ,EAAE,CAAC,CAAC,QAAQ;YACpB,WAAW,EAAE,CAAC,CAAC,WAAW;YAC1B,WAAW,EAAE,CAAC,CAAC,WAAW;YAC1B,UAAU,EAAE,CAAC,CAAC,UAAU;SACzB,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AAChD,CAAC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CACzB,IAAY,EACZ,cAAkC,EAClC,KAAgB;IAEhB,MAAM,SAAS,GACb,cAAc,KAAK,IAAI;QACrB,CAAC,CAAC,CAAC,IAAI,CAAC;QACR,CAAC,CAAC,cAAc,KAAK,KAAK;YACxB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,cAAc,CAAC;IACvB,OAAO,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM;QACzC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QAClE,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC"}

package/dist/internal/properties.d.ts

@@ -0,0 +1,4 @@
+/** @internal @packageDocumentation */
+import type { Query } from "../components";
+import type { DataAPIMeta } from "../metadata";
+export declare function WriteProperties(obj: any, meta: DataAPIMeta, bodyData: Parameters<typeof Query.WriteProperties>[2], action?: string, existingDBData?: Parameters<typeof Query.WriteProperties>[4]): Record<string, any>;

package/dist/internal/properties.js

@@ -0,0 +1,43 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WriteProperties = WriteProperties;
+function writableInBody(writable, bodyData) {
+    return {
+        props: writable.props.filter(([key]) => Object.hasOwn(bodyData, key)),
+        setters: writable.setters.filter(([key]) => Object.hasOwn(bodyData, key)),
+    };
+}
+function writeTargetDefaults(instance, meta, dbData) {
+    for (const [key, value] of Object.entries(new meta.target())) {
+        if (value !== undefined) {
+            instance[key] = value;
+            if (key in meta.fields) {
+                dbData[meta.fields[key].dbName || key] = value;
+            }
+        }
+    }
+}
+function WriteProperties(obj, meta, bodyData, action, existingDBData) {
+    const actionWritable = meta.writable[action ?? "_default"] ?? meta.writable._default;
+    const writable = existingDBData
+        ? writableInBody(actionWritable, bodyData)
+        : actionWritable;
+    const instance = { ...obj };
+    const dbData = existingDBData || {};
+    Object.setPrototypeOf(dbData, meta.tableClass.prototype);
+    if (!existingDBData) {
+        writeTargetDefaults(instance, meta, dbData);
+    }
+    for (const [key, field] of writable.props) {
+        instance[key] = bodyData[key];
+        dbData[field.dbName || key] = bodyData[key];
+    }
+    instance.table = dbData;
+    Object.setPrototypeOf(instance, meta.target.prototype);
+    for (const [key, field] of writable.setters) {
+        field.desc?.set?.apply(instance, [bodyData[key]]);
+    }
+    return dbData;
+}
+//# sourceMappingURL=properties.js.map

package/dist/internal/properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"properties.js","sourceRoot":"","sources":["../../src/internal/properties.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AA8BtC,0CA6BC;AAtDD,SAAS,cAAc,CACrB,QAA8B,EAC9B,QAAqD;IAErD,OAAO;QACL,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACrE,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;KAC1E,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAC1B,QAAqD,EACrD,IAAiB,EACjB,MAAuE;IAEvE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC;QAC7D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACtB,IAAI,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACvB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,GAAG,CAAC,GAAG,KAAK,CAAC;YACjD,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,eAAe,CAC7B,GAAQ,EACR,IAAiB,EACjB,QAAqD,EACrD,MAAe,EACf,cAA4D;IAE5D,MAAM,cAAc,GAClB,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,UAAU,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAChE,MAAM,QAAQ,GAAG,cAAc;QAC7B,CAAC,CAAC,cAAc,CAAC,cAAc,EAAE,QAAQ,CAAC;QAC1C,CAAC,CAAC,cAAc,CAAC;IACnB,MAAM,QAAQ,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;IAC5B,MAAM,MAAM,GACV,cAAc,IAAI,EAAE,CAAC;IACvB,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,mBAAmB,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;QAC1C,QAAQ,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IACD,QAAQ,CAAC,KAAK,GAAG,MAAM,CAAC;IACxB,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACvD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;QAC5C,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/internal/table-reference.d.ts

@@ -0,0 +1,11 @@
+/** @internal @packageDocumentation */
+import type { Class } from "@antelopejs/interface-core/decorators";
+import { type Table } from "@antelopejs/interface-database-decorators";
+interface ResolvedTableReference {
+    tableName: string;
+    tableClass?: Class<Table>;
+    /** `undefined` means same schema as the source DataAPI. */
+    schemaName?: string;
+}
+export declare function resolveTableReference(sourceSchemaName: string, table: string | Class<Table>, explicitSchema: string | undefined, contextLabel: string): ResolvedTableReference;
+export {};

package/dist/internal/table-reference.js

@@ -0,0 +1,46 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveTableReference = resolveTableReference;
+const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
+const guards_1 = require("./guards");
+function readTableMetadata(table) {
+    const meta = (0, interface_database_decorators_1.getMetadata)(table, interface_database_decorators_1.DatumStaticMetadata);
+    return { schemaName: meta?.schemaName, tableName: meta?.tableName };
+}
+function resolveTableReference(sourceSchemaName, table, explicitSchema, contextLabel) {
+    if (!(0, guards_1.isString)(table)) {
+        const inferred = readTableMetadata(table);
+        const schemaName = explicitSchema ?? inferred.schemaName;
+        const tableName = inferred.tableName;
+        if (!schemaName || !tableName) {
+            throw new Error(`Unable to infer table name/schema for ${contextLabel}: pass @RegisterTable on the table class`);
+        }
+        if (explicitSchema &&
+            inferred.schemaName &&
+            explicitSchema !== inferred.schemaName) {
+            throw new Error(`Schema mismatch for ${contextLabel}: class registers in "${inferred.schemaName}" but option specifies "${explicitSchema}"`);
+        }
+        return {
+            tableName,
+            tableClass: table,
+            schemaName: schemaName === sourceSchemaName ? undefined : schemaName,
+        };
+    }
+    const targetSchema = explicitSchema ?? sourceSchemaName;
+    const databaseSchema = (0, interface_database_decorators_1.getTablesForSchema)(targetSchema);
+    if (!databaseSchema) {
+        throw new Error(`Schema "${targetSchema}" not found for ${contextLabel}`);
+    }
+    const tableClass = databaseSchema[table];
+    const isOtherSchema = targetSchema !== sourceSchemaName;
+    if (isOtherSchema && !tableClass) {
+        throw new Error(`Table "${table}" is not registered in schema "${targetSchema}" for ${contextLabel}: register its class with @RegisterTable before declaring the field`);
+    }
+    return {
+        tableName: table,
+        tableClass,
+        schemaName: isOtherSchema ? targetSchema : undefined,
+    };
+}
+//# sourceMappingURL=table-reference.js.map

package/dist/internal/table-reference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table-reference.js","sourceRoot":"","sources":["../../src/internal/table-reference.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AAwBtC,sDAgDC;AArED,6FAKmD;AAEnD,qCAAoC;AASpC,SAAS,iBAAiB,CAAC,KAAmB;IAC5C,MAAM,IAAI,GAAG,IAAA,2CAAW,EAAC,KAAK,EAAE,mDAAmB,CAAC,CAAC;IACrD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AACtE,CAAC;AAED,SAAgB,qBAAqB,CACnC,gBAAwB,EACxB,KAA4B,EAC5B,cAAkC,EAClC,YAAoB;IAEpB,IAAI,CAAC,IAAA,iBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,cAAc,IAAI,QAAQ,CAAC,UAAU,CAAC;QACzD,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,UAAU,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,yCAAyC,YAAY,0CAA0C,CAChG,CAAC;QACJ,CAAC;QACD,IACE,cAAc;YACd,QAAQ,CAAC,UAAU;YACnB,cAAc,KAAK,QAAQ,CAAC,UAAU,EACtC,CAAC;YACD,MAAM,IAAI,KAAK,CACb,uBAAuB,YAAY,yBAAyB,QAAQ,CAAC,UAAU,2BAA2B,cAAc,GAAG,CAC5H,CAAC;QACJ,CAAC;QACD,OAAO;YACL,SAAS;YACT,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,UAAU,KAAK,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU;SACrE,CAAC;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,cAAc,IAAI,gBAAgB,CAAC;IACxD,MAAM,cAAc,GAAG,IAAA,kDAAkB,EAAC,YAAY,CAAC,CAAC;IACxD,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,WAAW,YAAY,mBAAmB,YAAY,EAAE,CAAC,CAAC;IAC5E,CAAC;IACD,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IACzC,MAAM,aAAa,GAAG,YAAY,KAAK,gBAAgB,CAAC;IACxD,IAAI,aAAa,IAAI,CAAC,UAAU,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CACb,UAAU,KAAK,kCAAkC,YAAY,SAAS,YAAY,qEAAqE,CACxJ,CAAC;IACJ,CAAC;IACD,OAAO;QACL,SAAS,EAAE,KAAK;QAChB,UAAU;QACV,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;KACrD,CAAC;AACJ,CAAC"}

package/dist/internal/tables.d.ts

@@ -0,0 +1,18 @@
+/** @internal @packageDocumentation */
+import type { Constructible } from "@antelopejs/interface-database-decorators/common";
+import type { SchemaInstance, Table, ValueProxy } from "@antelopejs/interface-database";
+import type { ComputedFieldData } from "../metadata";
+export type TableRow = Parameters<ComputedFieldData["expr"]>[0];
+export interface TableTargetReference {
+    table: string;
+    tableClass?: Constructible;
+    schemaName?: string;
+}
+export declare function targetTable(sourceDb: SchemaInstance<any>, target: TableTargetReference): Table<any>;
+/**
+ * The lookup side of a relation: `table` reduced to `fields`, with the
+ * internal fields the modifiers keep. A plucked table is a staged selection
+ * the database accepts wherever it takes a table, but its type is a stream.
+ */
+export declare function pluckedTable(table: Table<any>, ...fields: string[]): Table<any>;
+export declare function Get(table: Table<any>, id: string | ValueProxy<string>, index?: string): import("@antelopejs/interface-database").Datum<any>;