@antelopejs/interface-data-api 0.4.0 → 0.6.0

package/dist/internal/computed.js

@@ -0,0 +1,51 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Computed = Computed;
+const interface_database_1 = require("@antelopejs/interface-database");
+function collectComputedEntries(meta, only) {
+    return Object.entries(meta.fields).flatMap(([name, field]) => field.computed && (!only || only.has(name))
+        ? [[name, field.computed]]
+        : []);
+}
+function buildComputedMappers(db, entries) {
+    const mergeExpressions = (row) => {
+        const merged = {};
+        for (const [name, computed] of entries) {
+            merged[name] = computed.expr(row, db);
+        }
+        return row.merge(merged).cast();
+    };
+    const defaulted = entries.filter(([, computed]) => computed.default !== undefined);
+    if (defaulted.length === 0) {
+        return [mergeExpressions];
+    }
+    const applyDefaults = (row) => {
+        const merged = {};
+        for (const [name, computed] of defaulted) {
+            merged[name] = row.key(name).default(computed.default);
+        }
+        return row.merge(merged).cast();
+    };
+    return [mergeExpressions, applyDefaults];
+}
+function Computed(db, meta, query, only) {
+    const entries = collectComputedEntries(meta, only);
+    if (entries.length === 0) {
+        return query;
+    }
+    const mappers = buildComputedMappers(db, entries);
+    if ((0, interface_database_1.IsStream)(query)) {
+        let stream = query;
+        for (const mapper of mappers) {
+            stream = stream.map(mapper);
+        }
+        return stream;
+    }
+    let datum = query;
+    for (const mapper of mappers) {
+        datum = datum.do(mapper);
+    }
+    return datum;
+}
+//# sourceMappingURL=computed.js.map

package/dist/internal/computed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"computed.js","sourceRoot":"","sources":["../../src/internal/computed.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AA4EtC,4BAuBC;AAjGD,uEAMwC;AASxC,SAAS,sBAAsB,CAC7B,IAAiB,EACjB,IAAkB;IAElB,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CACxC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAmB,EAAE,CACjC,KAAK,CAAC,QAAQ,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC1B,CAAC,CAAC,EAAE,CACT,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAC3B,EAAuB,EACvB,OAAwB;IAExB,MAAM,gBAAgB,GAAc,CAAC,GAAG,EAAE,EAAE;QAC1C,MAAM,MAAM,GAA0D,EAAE,CAAC;QACzE,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,OAAO,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAe,CAAC;IAC/C,CAAC,CAAC;IACF,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAC9B,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,CACjD,CAAC;IACF,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5B,CAAC;IACD,MAAM,aAAa,GAAc,CAAC,GAAG,EAAE,EAAE;QACvC,MAAM,MAAM,GAAoC,EAAE,CAAC;QACnD,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,SAAS,EAAE,CAAC;YACzC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAe,CAAC;IAC/C,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;AAC3C,CAAC;AAsBD,SAAgB,QAAQ,CACtB,EAAuB,EACvB,IAAiB,EACjB,KAA+B,EAC/B,IAAkB;IAElB,MAAM,OAAO,GAAG,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,OAAO,GAAG,oBAAoB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAClD,IAAI,IAAA,6BAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;QACpB,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,KAAK,GAAG,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/internal/controller-types.d.ts

@@ -0,0 +1,34 @@
+/** @internal @packageDocumentation */
+import type { ControllerClass } from "@antelopejs/interface-api";
+import type { ParameterDecorator } from "@antelopejs/interface-core/decorators";
+/** The controller a data route runs on: an instance of a class built by `DataController`. */
+export type DataControllerInstance = InstanceType<ControllerClass>;
+/**
+ * One route of a data controller. Entry `i` of `args` injects parameter `i`
+ * of `func`, so `A` lists what `func` receives, one element per entry; the
+ * stock routes take the request context first and their parameters second.
+ * Without `A`, the route is one whose parameters are not known, as a
+ * {@link DataControllerDef} holds it: its `func` takes `O` second and anything
+ * else, unchecked.
+ *
+ * @typeParam O The options the route receives in its second parameter
+ * @typeParam R What `func` answers, resolved
+ * @typeParam A The parameters of `func`, one per entry of `args`
+ */
+export type DataControllerCallback<O = any, R = unknown, A extends unknown[] = [ctx: any, opts: O, ...args: any[]]> = {
+    args: (ParameterDecorator | ParameterDecorator[])[];
+    method: string;
+    func: (...args: A) => R | Promise<R>;
+};
+export type DataControllerCallbackWithOptions<O = any, R = unknown, A extends unknown[] = [ctx: any, opts: O, ...args: any[]]> = {
+    endpoint?: string;
+    options?: Partial<O>;
+    callback: DataControllerCallback<O, R, A>;
+};
+export type ExtractCallback<T> = T extends DataControllerCallbackWithOptions ? T["callback"]["func"] : T extends DataControllerCallback ? T["func"] : never;
+export type DataControllerDef = {
+    [name: string]: DataControllerCallback | DataControllerCallbackWithOptions;
+};
+export type ExtractDefCallbacks<T extends {}> = {
+    [K in keyof T]: ExtractCallback<T[K]>;
+};

package/dist/internal/controller-types.js

@@ -0,0 +1,4 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=controller-types.js.map

package/dist/internal/controller-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"controller-types.js","sourceRoot":"","sources":["../../src/internal/controller-types.ts"],"names":[],"mappings":";AAAA,sCAAsC"}

package/dist/internal/default-filter.d.ts

@@ -0,0 +1,4 @@
+/** @internal @packageDocumentation */
+import type { DataAPIMeta } from "../metadata";
+export type DefaultFilterFunction = Parameters<DataAPIMeta["setFilter"]>[1];
+export declare function createDefaultFilter(): DefaultFilterFunction;

package/dist/internal/default-filter.js

@@ -0,0 +1,29 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDefaultFilter = createDefaultFilter;
+const interface_api_util_1 = require("@antelopejs/interface-api-util");
+const meta_records_1 = require("./meta-records");
+const DEFAULT_FILTER_OPERATORS = {
+    eq: (proxy, value) => proxy.eq(value),
+    ne: (proxy, value) => proxy.ne(value),
+    gt: (proxy, value) => proxy.gt(value),
+    ge: (proxy, value) => proxy.ge(value),
+    lt: (proxy, value) => proxy.lt(value),
+    le: (proxy, value) => proxy.le(value),
+};
+/**
+ * Applies a comparison to the column.
+ *
+ * @throws HTTPResult 400 when `mode` is not one of the default filter's
+ * comparisons; a custom filter receives its mode unchecked
+ */
+function applyDefaultFilterMode(proxy, value, mode) {
+    const operator = (0, meta_records_1.ownEntry)(DEFAULT_FILTER_OPERATORS, mode);
+    (0, interface_api_util_1.assert)(operator, 400, `Unknown filter comparison "${mode}": use one of ${Object.keys(DEFAULT_FILTER_OPERATORS).join(", ")}, or start a value that contains a colon with "eq:".`);
+    return operator(proxy, value);
+}
+function createDefaultFilter() {
+    return (_context, proxy, _key, value, mode) => applyDefaultFilterMode(proxy, value, mode);
+}
+//# sourceMappingURL=default-filter.js.map

package/dist/internal/default-filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-filter.js","sourceRoot":"","sources":["../../src/internal/default-filter.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AAkDtC,kDAGC;AAnDD,uEAAwD;AAQxD,iDAA0C;AAW1C,MAAM,wBAAwB,GAA2B;IACvD,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC;IACrC,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC;IACrC,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC;IACrC,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC;IACrC,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC;IACrC,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC;CACtC,CAAC;AAEF;;;;;GAKG;AACH,SAAS,sBAAsB,CAC7B,KAA0B,EAC1B,KAAa,EACb,IAAoB;IAEpB,MAAM,QAAQ,GAAG,IAAA,uBAAQ,EAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;IAC1D,IAAA,2BAAM,EACJ,QAAQ,EACR,GAAG,EACH,8BAA8B,IAAI,iBAAiB,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,sDAAsD,CAC1J,CAAC;IACF,OAAO,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAChC,CAAC;AAED,SAAgB,mBAAmB;IACjC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAC5C,sBAAsB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC"}

package/dist/internal/deferred-joined-stream.d.ts

@@ -0,0 +1,11 @@
+/** @internal @packageDocumentation */
+import { type SchemaInstance, Stream } from "@antelopejs/interface-database";
+import type { DataAPIMeta } from "../metadata";
+/**
+ * Wraps `raw` into a {@link DeferredJoinedStream}. The wrapper keeps the
+ * raw stages as its own (an unobservable fallback, since every operation
+ * is overridden) while `build()` serializes the materialized pipeline, so
+ * a wrapper embedded as an argument of another query never leaks rows
+ * without the joined fields.
+ */
+export declare function wrapDeferredJoined(db: SchemaInstance<any>, meta: DataAPIMeta, names: Set<string>, raw: Stream<any>): Stream<any>;

package/dist/internal/deferred-joined-stream.js

@@ -0,0 +1,125 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapDeferredJoined = wrapDeferredJoined;
+const interface_database_1 = require("@antelopejs/interface-database");
+const joined_1 = require("./joined");
+/**
+ * Stream returned by {@link List} when the deferred joined fields are not
+ * exposed to the caller: it resolves them itself, so consumers that
+ * destructure `[query, total]` alone still observe every `@Joined` field.
+ * The lookups are appended after `slice`/`nth`, keeping them on the
+ * requested page only; bare `count()` calls and field aggregates on
+ * non-joined fields skip them (left-join lookups never change the row
+ * count nor other fields); `changes()` attaches to the raw stream, since
+ * change feeds cannot carry the lookups. Any other operation may observe
+ * the joined fields, so it materializes them first.
+ */
+class DeferredJoinedStream extends interface_database_1.Stream {
+}
+function materializeDeferredJoin(stream) {
+    const { db, meta, names, raw } = stream.deferredJoin;
+    return (0, joined_1.Joined)(db, meta, raw, names);
+}
+function pagedDeferredJoinOperation() {
+    return function (...args) {
+        const { db, meta, names, raw } = this.deferredJoin;
+        return (0, joined_1.Joined)(db, meta, raw.slice(...args), names);
+    };
+}
+/**
+ * Resolves the joined fields through the stream form of {@link Joined}
+ * rather than its datum form: only the datum form has no way to drop the
+ * temporary key it stages (neither `Datum` nor `ValueProxy` exposes
+ * `without`), so it would leave `__joined_orig_*` on the row.
+ */
+function nthDeferredJoinOperation() {
+    return function (n) {
+        const { db, meta, names, raw } = this.deferredJoin;
+        return (0, joined_1.Joined)(db, meta, raw.slice(n, 1), names).nth(0);
+    };
+}
+function rawDeferredJoinOperation() {
+    return function () {
+        return this.deferredJoin.raw.changes();
+    };
+}
+function aggregate(stream, name, field) {
+    switch (name) {
+        case "count":
+            return stream.count(field);
+        case "sum":
+            return stream.sum(field);
+        case "avg":
+            return stream.avg(field);
+        case "min":
+            return stream.min(field);
+        case "max":
+            return stream.max(field);
+        case "distinct":
+            return field === undefined ? stream.distinct() : stream.distinct(field);
+    }
+}
+function fieldAggregateDeferredJoinOperation(name, bareCallOnRaw) {
+    return function (field) {
+        const { db, meta, names, raw } = this.deferredJoin;
+        if (!field) {
+            const bareTarget = bareCallOnRaw ? raw : materializeDeferredJoin(this);
+            return aggregate(bareTarget, name);
+        }
+        const target = names.has(field)
+            ? (0, joined_1.Joined)(db, meta, raw, new Set([field]))
+            : raw;
+        return aggregate(target, name, field);
+    };
+}
+function forwardingDeferredJoinOperation(name) {
+    return function (...args) {
+        // SAFETY: name comes from wireDeferredJoinedStream, which lists the own method names of Stream.prototype plus run, cursor and build, all present on any Stream, and Joined returns a Stream for the raw Stream it is given.
+        // oxlint-disable-next-line typescript/no-unsafe-return -- the method is looked up by a runtime name on a Stream, which TypeScript cannot relate to a signature; Reflect.apply and a typed lookup were tried and moved the finding to no-reflect-get, no-reflect-apply and no-unknown-returns
+        return materializeDeferredJoin(this)[name](...args);
+    };
+}
+/** The operation a {@link DeferredJoinedStream} installs for a stream method. */
+const DEFERRED_JOIN_OPERATION_FACTORIES = new Map([
+    ["slice", pagedDeferredJoinOperation],
+    ["nth", nthDeferredJoinOperation],
+    ["changes", rawDeferredJoinOperation],
+    ["count", () => fieldAggregateDeferredJoinOperation("count", true)],
+    ["sum", () => fieldAggregateDeferredJoinOperation("sum", false)],
+    ["avg", () => fieldAggregateDeferredJoinOperation("avg", false)],
+    ["min", () => fieldAggregateDeferredJoinOperation("min", false)],
+    ["max", () => fieldAggregateDeferredJoinOperation("max", false)],
+    ["distinct", () => fieldAggregateDeferredJoinOperation("distinct", false)],
+]);
+const DEFERRED_JOIN_INHERITED_OPERATIONS = new Set(["constructor", "cast"]);
+function wireDeferredJoinedStream() {
+    const operationNames = [
+        ...Object.getOwnPropertyNames(interface_database_1.Stream.prototype),
+        "run",
+        "cursor",
+        "build",
+    ].filter((name) => !DEFERRED_JOIN_INHERITED_OPERATIONS.has(name));
+    for (const name of operationNames) {
+        const factory = DEFERRED_JOIN_OPERATION_FACTORIES.get(name) ??
+            forwardingDeferredJoinOperation;
+        // SAFETY: name is a method name of Stream.prototype (or run, cursor, build), so the key is a writable data property on DeferredJoinedStream's prototype chain and assigning a function to it cannot throw; each installed operation takes the arguments of the Stream method it replaces.
+        DeferredJoinedStream.prototype[name] = factory(name);
+    }
+}
+wireDeferredJoinedStream();
+/**
+ * Wraps `raw` into a {@link DeferredJoinedStream}. The wrapper keeps the
+ * raw stages as its own (an unobservable fallback, since every operation
+ * is overridden) while `build()` serializes the materialized pipeline, so
+ * a wrapper embedded as an argument of another query never leaks rows
+ * without the joined fields.
+ */
+function wrapDeferredJoined(db, meta, names, raw) {
+    const stages = raw.build();
+    const wrapped = new DeferredJoinedStream(stages[0]);
+    Object.assign(wrapped, { stages });
+    wrapped.deferredJoin = { db, meta, names, raw };
+    return wrapped;
+}
+//# sourceMappingURL=deferred-joined-stream.js.map

package/dist/internal/deferred-joined-stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deferred-joined-stream.js","sourceRoot":"","sources":["../../src/internal/deferred-joined-stream.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AA6JtC,gDAWC;AAtKD,uEAA6E;AAG7E,qCAAkC;AASlC;;;;;;;;;;GAUG;AACH,MAAM,oBAAqB,SAAQ,2BAAW;CAE7C;AAOD,SAAS,uBAAuB,CAAC,MAA4B;IAC3D,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC;IACrD,OAAO,IAAA,eAAM,EAAC,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,0BAA0B;IACjC,OAAO,UAEL,GAAG,IAAsC;QAEzC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC;QACnD,OAAO,IAAA,eAAM,EAAC,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,wBAAwB;IAC/B,OAAO,UAAsC,CAAS;QACpD,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC;QACnD,OAAO,IAAA,eAAM,EAAC,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB;IAC/B,OAAO;QACL,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACzC,CAAC,CAAC;AACJ,CAAC;AAID,SAAS,SAAS,CAAC,MAAmB,EAAE,IAAoB,EAAE,KAAc;IAC1E,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,OAAO;YACV,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC7B,KAAK,KAAK;YACR,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,KAAK,KAAK;YACR,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,KAAK,KAAK;YACR,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,KAAK,KAAK;YACR,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,KAAK,UAAU;YACb,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5E,CAAC;AACH,CAAC;AAED,SAAS,mCAAmC,CAC1C,IAAoB,EACpB,aAAsB;IAEtB,OAAO,UAAsC,KAAc;QACzD,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC;QACnD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,UAAU,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;YACvE,OAAO,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QACrC,CAAC;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC;YAC7B,CAAC,CAAC,IAAA,eAAM,EAAC,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACzC,CAAC,CAAC,GAAG,CAAC;QACR,OAAO,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,+BAA+B,CACtC,IAAY;IAEZ,OAAO,UAAsC,GAAG,IAAW;QACzD,4NAA4N;QAC5N,6RAA6R;QAC7R,OAAQ,uBAAuB,CAAC,IAAI,CAAS,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC/D,CAAC,CAAC;AACJ,CAAC;AAED,iFAAiF;AACjF,MAAM,iCAAiC,GAAG,IAAI,GAAG,CAG/C;IACA,CAAC,OAAO,EAAE,0BAA0B,CAAC;IACrC,CAAC,KAAK,EAAE,wBAAwB,CAAC;IACjC,CAAC,SAAS,EAAE,wBAAwB,CAAC;IACrC,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,mCAAmC,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,mCAAmC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,mCAAmC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,mCAAmC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,mCAAmC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,mCAAmC,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;CAC3E,CAAC,CAAC;AAEH,MAAM,kCAAkC,GAAG,IAAI,GAAG,CAAC,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;AAE5E,SAAS,wBAAwB;IAC/B,MAAM,cAAc,GAAG;QACrB,GAAG,MAAM,CAAC,mBAAmB,CAAC,2BAAM,CAAC,SAAS,CAAC;QAC/C,KAAK;QACL,QAAQ;QACR,OAAO;KACR,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,kCAAkC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAClE,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;QAClC,MAAM,OAAO,GACX,iCAAiC,CAAC,GAAG,CAAC,IAAI,CAAC;YAC3C,+BAA+B,CAAC;QAClC,0RAA0R;QACzR,oBAAoB,CAAC,SAAiB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,CAAC;AACH,CAAC;AAED,wBAAwB,EAAE,CAAC;AAE3B;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAChC,EAAuB,EACvB,IAAiB,EACjB,KAAkB,EAClB,GAAgB;IAEhB,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACpD,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACnC,OAAO,CAAC,YAAY,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IAChD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/internal/extractors.d.ts

@@ -0,0 +1,25 @@
+/** @internal @packageDocumentation */
+import type { RequestContext } from "@antelopejs/interface-api";
+import type { DataAPIMeta } from "../metadata";
+/**
+ * Reads one field of a route's parameters from the request. `undefined` leaves
+ * the field out. `key` is the field's name.
+ */
+export type ParameterExtractor<Value> = (reqCtx: RequestContext, meta: DataAPIMeta, key: string) => Value | undefined;
+/** The extractors of a route's parameters, by field. */
+export type ParameterExtractors<T> = {
+    [K in keyof T]?: ParameterExtractor<T[K]>;
+};
+export declare function fromSearch<Value>(convert: (text: string) => Value): ParameterExtractor<Value>;
+/** Reads a field from the query string, under the field's name. */
+export declare const FromSearch: {
+    number: ParameterExtractor<number>;
+    int: ParameterExtractor<number>;
+    bool: ParameterExtractor<boolean>;
+    string: ParameterExtractor<string>;
+    /** Every value of the field, none when the request sends none. */
+    numbers: ParameterExtractor<number[]>;
+    ints: ParameterExtractor<number[]>;
+    bools: ParameterExtractor<boolean[]>;
+    strings: ParameterExtractor<string[]>;
+};

package/dist/internal/extractors.js

@@ -0,0 +1,31 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FromSearch = void 0;
+exports.fromSearch = fromSearch;
+function fromSearch(convert) {
+    return (reqCtx, _meta, key) => {
+        const text = reqCtx.url.searchParams.get(key);
+        return text === null ? undefined : convert(text);
+    };
+}
+function allFromSearch(convert) {
+    return (reqCtx, _meta, key) => reqCtx.url.searchParams.getAll(key).map((text) => convert(text));
+}
+const toNumber = (text) => parseFloat(text);
+const toInt = (text) => parseInt(text, 10);
+const toBool = (text) => text !== "0";
+const toText = (text) => text;
+/** Reads a field from the query string, under the field's name. */
+exports.FromSearch = {
+    number: fromSearch(toNumber),
+    int: fromSearch(toInt),
+    bool: fromSearch(toBool),
+    string: fromSearch(toText),
+    /** Every value of the field, none when the request sends none. */
+    numbers: allFromSearch(toNumber),
+    ints: allFromSearch(toInt),
+    bools: allFromSearch(toBool),
+    strings: allFromSearch(toText),
+};
+//# sourceMappingURL=extractors.js.map

package/dist/internal/extractors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractors.js","sourceRoot":"","sources":["../../src/internal/extractors.ts"],"names":[],"mappings":";AAAA,sCAAsC;;;AAqBtC,gCAOC;AAPD,SAAgB,UAAU,CACxB,OAAgC;IAEhC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9C,OAAO,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CACpB,OAAgC;IAEhC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,CAC5B,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AACpD,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AACnD,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC;AAC9C,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC;AAEtC,mEAAmE;AACtD,QAAA,UAAU,GAAG;IACxB,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC;IAC5B,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC;IACtB,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC;IACxB,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC;IAC1B,kEAAkE;IAClE,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC;IAChC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC;IAC1B,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC;IAC5B,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC;CAC/B,CAAC"}

package/dist/internal/field-types.d.ts

@@ -0,0 +1,199 @@
+/** @internal @packageDocumentation */
+import type { RequestContext } from "@antelopejs/interface-api";
+import type { Class } from "@antelopejs/interface-core/decorators";
+import type { Query, SchemaInstance, ValueProxy, ValueProxyOrValue } from "@antelopejs/interface-database";
+import type { Table } from "@antelopejs/interface-database-decorators";
+import type { AccessMode, DataAPIMeta } from "../metadata";
+/**
+ * A `@Joined` field declared on the target of a relation, captured so the
+ * foreign lookup can re-materialize it (joined fields are not physical columns,
+ * so a plain pluck of the target table would return them empty).
+ */
+export interface ForeignJoinedRef {
+    name: string;
+    table: string;
+    tableClass?: Class<Table>;
+    localKey: string;
+    remoteField: string;
+    remoteIndex: string;
+    schemaName?: string;
+}
+/** A value a request body or a table row holds. */
+export type FieldValue = string | number | boolean | null | Date | FieldValue[] | FieldValues;
+/** Fields by name, as a request body or a table row holds them. */
+export interface FieldValues {
+    [field: string]: FieldValue | undefined;
+}
+/**
+ * The fields of a table row a route holds, by name. The table class decides
+ * what they hold: a relation holds a row instance, and a getter's result is
+ * what the getter returned. Read a field through a guard.
+ */
+export interface RowFields {
+    [field: string]: unknown;
+}
+/** Parse outcome accepting the field value, carrying the value to write. */
+export interface FieldParseSuccess {
+    success: true;
+    data: FieldValue | undefined;
+}
+/** Parse outcome rejecting the field value. */
+export interface FieldParseFailure {
+    success: false;
+}
+/** Parse outcome of a field value, shaped like the result of zod's `safeParse`. */
+export type FieldParseResult = FieldParseSuccess | FieldParseFailure;
+/**
+ * Outcome of a field validator: `true`/`false` accepts or rejects the raw
+ * value, which is then written as received; a {@link FieldParseResult}
+ * accepts or rejects it, and on success its `data` is written instead of the
+ * raw value.
+ */
+export type FieldValidationResult = boolean | FieldParseResult;
+/** Field value validator, see {@link FieldValidationResult}. */
+export type FieldValidator = (value: FieldValue | undefined) => FieldValidationResult | Promise<FieldValidationResult>;
+/** What a foreign key declaration takes after the field and the other table. */
+export type ForeignOptions = [
+    index?: string,
+    multi?: boolean,
+    pluck?: string[],
+    schema?: string,
+    targetMeta?: DataAPIMeta
+];
+/** DataAPI Metadata field information. */
+export interface FieldData {
+    /**
+     * Field name in-database.
+     */
+    dbName?: string;
+    /**
+     * Field access mode.
+     *
+     * @see {@link AccessMode}
+     */
+    mode?: AccessMode;
+    /**
+     * Field access mode overrides per DataAPI action.
+     */
+    modeOverrides?: Record<string, AccessMode>;
+    /**
+     * DB Fields that should be selected for this field.
+     */
+    listable?: Record<string, string[]>;
+    /**
+     * Set of api methods for which the field must be set.
+     */
+    mandatory?: Set<string>;
+    /**
+     * Whether the DataAPI can be sorted using this field.
+     */
+    sortable?: {
+        indexed?: boolean;
+    };
+    /**
+     * Foreign key reference.
+     *
+     * `schemaName` is set when the target lives in another schema than the
+     * controller's table; runtime resolves the foreign lookup against that
+     * schema's default instance instead of the source instance.
+     */
+    foreign?: [
+        table: string,
+        tableClass?: Class<Table>,
+        index?: string,
+        multi?: true,
+        pluck?: string[],
+        schemaName?: string,
+        targetJoined?: ForeignJoinedRef[]
+    ];
+    /**
+     * Joined-from-other-table reference.
+     *
+     * Imports a single scalar field from another table at query time and
+     * flattens it into the row, enabling sort/search/filter natively in DB.
+     *
+     * `schemaName` is set when the target lives in another schema than the
+     * controller's table; runtime resolves the join against that schema's
+     * default instance instead of the source instance.
+     */
+    joined?: {
+        table: string;
+        tableClass?: Class<Table>;
+        localKey: string;
+        remoteField: string;
+        remoteIndex: string;
+        schemaName?: string;
+    };
+    /**
+     * In-database computed value.
+     *
+     * The expression is merged into each row at query time, enabling sort,
+     * filter, and pagination natively in DB.
+     */
+    computed?: ComputedFieldData;
+    /**
+     * Value validator callback.
+     */
+    validator?: FieldValidator;
+    /**
+     * Field property descriptor.
+     */
+    desc?: PropertyDescriptor;
+    /**
+     * Whether or not an `eq` filter with this field name can use an indexed lookup.
+     */
+    indexable?: boolean;
+}
+/**
+ * In-database computed field expression.
+ *
+ * Receives the row proxy and the schema instance of the controller's table.
+ * May return a row-local expression (built from `row`), a per-row subquery
+ * (ex: an aggregate over another table), or a constant. A value proxy is
+ * invariant in its value, so the proxy and the query take any value.
+ */
+export type ComputedExpression = (row: ValueProxy<FieldValues>, db: SchemaInstance<any>) => ValueProxy<any> | Query<any> | FieldValue;
+/**
+ * Computed field options.
+ */
+export interface ComputedOptions {
+    /**
+     * Fallback merged over the computed value when the expression yields null
+     * (ex: `0` for an aggregate count over an empty set).
+     */
+    default?: FieldValue;
+}
+/**
+ * Computed field information.
+ */
+export interface ComputedFieldData extends ComputedOptions {
+    expr: ComputedExpression;
+}
+/** The comparisons the default filter applies. */
+export type Comparison = "eq" | "ne" | "gt" | "ge" | "lt" | "le";
+/**
+ * One filter of a list request: the value, and the mode to compare it with.
+ * The mode is text: what the request sent, or what the route wrote. The
+ * default filter refuses a mode that is not a {@link Comparison}. A custom
+ * filter defines its own modes.
+ */
+export type FilterValue = [value: string, mode: string];
+/**
+ * The filters of one field in a list request: one {@link FilterValue}, or
+ * several a row must all pass (`?filter_age=ge:18&filter_age=lt:65`).
+ */
+export type FieldFilter = FilterValue | FilterValue[];
+/**
+ * Filter callback.
+ */
+export type FilterFunction<T extends Record<string, any>, U extends Record<string, any> = FieldValues> = (context: RequestContext & {
+    this: T;
+}, proxy: ValueProxy<any>, key: string, ...rest: [value: FilterValue[0], mode: FilterValue[1], row: ValueProxy<U>]) => ValueProxyOrValue<boolean>;
+export interface ReadableAccessFields {
+    getters: [string, FieldData][];
+    props: [string, FieldData][];
+}
+export interface WritableAccessFields {
+    setters: [string, FieldData][];
+    props: [string, FieldData][];
+}

package/dist/internal/field-types.js

@@ -0,0 +1,4 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=field-types.js.map

package/dist/internal/field-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-types.js","sourceRoot":"","sources":["../../src/internal/field-types.ts"],"names":[],"mappings":";AAAA,sCAAsC"}

package/dist/internal/filters.d.ts

@@ -0,0 +1,6 @@
+/** @internal @packageDocumentation */
+import type { FieldFilter, FilterValue } from "./field-types";
+/** The filters of one field as a list, whether it holds one or several. */
+export declare function FilterValuesOf(filter: FieldFilter): FilterValue[];
+export declare function parseFilter(searchVal: string): FilterValue;
+export declare function copyFilter(filter: FieldFilter): FieldFilter;

package/dist/internal/filters.js

@@ -0,0 +1,22 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterValuesOf = FilterValuesOf;
+exports.parseFilter = parseFilter;
+exports.copyFilter = copyFilter;
+function isFilterList(filter) {
+    return Array.isArray(filter[0]);
+}
+/** The filters of one field as a list, whether it holds one or several. */
+function FilterValuesOf(filter) {
+    return isFilterList(filter) ? filter : [filter];
+}
+function parseFilter(searchVal) {
+    const match = searchVal.match(/([^:]+):(.*)/);
+    return match ? [match[2], match[1]] : [searchVal, "eq"];
+}
+function copyFilter(filter) {
+    const copies = FilterValuesOf(filter).map((value) => [...value]);
+    return copies.length === 1 ? copies[0] : copies;
+}
+//# sourceMappingURL=filters.js.map

package/dist/internal/filters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filters.js","sourceRoot":"","sources":["../../src/internal/filters.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AAStC,wCAEC;AAED,kCAGC;AAED,gCAGC;AAjBD,SAAS,YAAY,CAAC,MAAmB;IACvC,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAClC,CAAC;AAED,2EAA2E;AAC3E,SAAgB,cAAc,CAAC,MAAmB;IAChD,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAClD,CAAC;AAED,SAAgB,WAAW,CAAC,SAAiB;IAC3C,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAC9C,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAC1D,CAAC;AAED,SAAgB,UAAU,CAAC,MAAmB;IAC5C,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAe,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAC9E,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AAClD,CAAC"}

package/dist/internal/foreign.d.ts

@@ -0,0 +1,6 @@
+/** @internal @packageDocumentation */
+import { type Datum, type SchemaInstance, type Stream } from "@antelopejs/interface-database";
+import type { DataAPIMeta } from "../metadata";
+export declare function Foreign(db: SchemaInstance<any>, meta: DataAPIMeta, query: Stream<any>, pluck?: Set<string>): Stream<any>;
+export declare function Foreign(db: SchemaInstance<any>, meta: DataAPIMeta, query: Datum<any>, pluck?: Set<string>): Datum<any>;
+export declare function Foreign(db: SchemaInstance<any>, meta: DataAPIMeta, query: Stream<any> | Datum<any>, pluck?: Set<string>): Stream<any> | Datum<any>;