@antelopejs/interface-data-api 0.4.0 → 0.5.0

package/dist/internal/tables.js

@@ -0,0 +1,37 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.targetTable = targetTable;
+exports.pluckedTable = pluckedTable;
+exports.Get = Get;
+const interface_api_util_1 = require("@antelopejs/interface-api-util");
+const guards_1 = require("./guards");
+function isTableClass(value) {
+    return ((0, guards_1.isFunction)(value) &&
+        "table" in value &&
+        (0, guards_1.isFunction)(value.table) &&
+        "with" in value &&
+        (0, guards_1.isFunction)(value.with));
+}
+function targetTable(sourceDb, target) {
+    if (!target.schemaName)
+        return sourceDb.table(target.table);
+    (0, interface_api_util_1.assert)(isTableClass(target.tableClass), 500, `Table "${target.table}" of schema "${target.schemaName}" has no registered table class`);
+    return target.tableClass.table();
+}
+/**
+ * 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.
+ */
+function pluckedTable(table, ...fields) {
+    // SAFETY: pluck returns a Stream, which has none of Table's own methods; pluckedTable is only called in joined.ts and foreign.ts to build the right-hand side of lookup, and lookup reads that argument only through its stage list (build()), which the pluck stage extends.
+    return table.pluck("_internal", ...fields);
+}
+function Get(table, id, index) {
+    if (!index)
+        return table.get(id);
+    const key = (0, guards_1.isString)(id) ? id : id.cast();
+    return table.getAll(key, index).nth(0);
+}
+//# sourceMappingURL=tables.js.map

package/dist/internal/tables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tables.js","sourceRoot":"","sources":["../../src/internal/tables.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AAkCtC,kCAWC;AAOD,oCAMC;AAED,kBAQC;AAlED,uEAAwD;AAUxD,qCAAgD;AAUhD,SAAS,YAAY,CACnB,KAAgC;IAEhC,OAAO,CACL,IAAA,mBAAU,EAAC,KAAK,CAAC;QACjB,OAAO,IAAI,KAAK;QAChB,IAAA,mBAAU,EAAC,KAAK,CAAC,KAAK,CAAC;QACvB,MAAM,IAAI,KAAK;QACf,IAAA,mBAAU,EAAC,KAAK,CAAC,IAAI,CAAC,CACvB,CAAC;AACJ,CAAC;AAED,SAAgB,WAAW,CACzB,QAA6B,EAC7B,MAA4B;IAE5B,IAAI,CAAC,MAAM,CAAC,UAAU;QAAE,OAAO,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC5D,IAAA,2BAAM,EACJ,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,EAC/B,GAAG,EACH,UAAU,MAAM,CAAC,KAAK,gBAAgB,MAAM,CAAC,UAAU,iCAAiC,CACzF,CAAC;IACF,OAAO,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAC1B,KAAiB,EACjB,GAAG,MAAgB;IAEnB,8QAA8Q;IAC9Q,OAAO,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,MAAM,CAAe,CAAC;AAC3D,CAAC;AAED,SAAgB,GAAG,CACjB,KAAiB,EACjB,EAA+B,EAC/B,KAAc;IAEd,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,IAAA,iBAAQ,EAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,EAA6B,CAAC;IACrE,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACzC,CAAC"}

package/dist/internal/validation.d.ts

@@ -0,0 +1,11 @@
+/** @internal @packageDocumentation */
+import type { ValueProxy } from "@antelopejs/interface-database";
+import type { Validation } from "../components";
+import type { DataAPIMeta } from "../metadata";
+type RequestBody = Validation.RequestBody;
+type WrittenBody = Validation.WrittenBody;
+export declare function ParseBody(body: WrittenBody): RequestBody;
+export declare function Unlock(obj: any, meta: DataAPIMeta, dbData: any): void;
+export declare function UnlockRequest<T extends {}, K extends keyof T>(obj: any, meta: DataAPIMeta, row: ValueProxy<T>, field: K): ValueProxy<T[K]>;
+export declare function ClearInternal(meta: DataAPIMeta, obj: Parameters<typeof Validation.ClearInternal>[1]): void;
+export {};

package/dist/internal/validation.js

@@ -0,0 +1,88 @@
+"use strict";
+/** @internal @packageDocumentation */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParseBody = ParseBody;
+exports.Unlock = Unlock;
+exports.UnlockRequest = UnlockRequest;
+exports.ClearInternal = ClearInternal;
+const interface_api_util_1 = require("@antelopejs/interface-api-util");
+const common_1 = require("@antelopejs/interface-database-decorators/modifiers/common");
+const guards_1 = require("./guards");
+function ParseBody(body) {
+    let data = body;
+    if (Buffer.isBuffer(body)) {
+        try {
+            data = JSON.parse(body.toString());
+        }
+        catch {
+            (0, interface_api_util_1.assert)(false, 400, "Invalid JSON body.");
+        }
+    }
+    (0, interface_api_util_1.assert)((0, guards_1.isFieldValues)(data), 400, "The request body must be a JSON object.");
+    return data;
+}
+function Unlock(obj, meta, dbData) {
+    for (const [name, field] of Object.entries(meta.fields)) {
+        if (field.foreign && (0, guards_1.isObject)(dbData[name]) && field.foreign[1]) {
+            const foreignSchema = field.foreign[1];
+            dbData[name] = Array.isArray(dbData[name])
+                ? dbData[name].map((entry) => (0, common_1.fromDatabase)(entry, foreignSchema))
+                : (0, common_1.fromDatabase)(dbData[name], field.foreign[1]);
+        }
+    }
+    for (const [modifier, field] of meta.modifierKeys.entries()) {
+        const key = obj[field];
+        (0, common_1.unlock)(dbData, modifier, undefined, key);
+        for (const [foreign, fieldData] of Object.entries(meta.fields)) {
+            if (fieldData.foreign && (0, guards_1.isObject)(dbData[foreign])) {
+                (0, common_1.unlock)(dbData[foreign], modifier, undefined, key);
+            }
+        }
+    }
+}
+function UnlockRequest(obj, meta, row, field) {
+    const modifiers = Array.from(meta.modifierKeys.entries()).map(([modifier, field]) => ({
+        modifier,
+        args: [obj[field]],
+    }));
+    return (0, common_1.unlockrequest)(meta.tableClass, row, field, modifiers);
+}
+function ClearInternal(meta, obj) {
+    const results = Array.isArray(obj) ? obj : [obj];
+    const foreignFields = Object.entries(meta.fields).filter(([, field]) => field.foreign);
+    for (const entry of results) {
+        delete entry._internal;
+        for (const [name, { foreign }] of foreignFields) {
+            if (foreign &&
+                (0, guards_1.isObject)(entry[name]) &&
+                (!Array.isArray(entry[name]) ||
+                    entry[name][0] === null ||
+                    (0, guards_1.isObject)(entry[name][0]))) {
+                const processForeign = (data) => {
+                    const plain = (0, common_1.toPlainData)(data);
+                    if (!foreign?.[4]) {
+                        return plain;
+                    }
+                    const targetJoined = foreign[6];
+                    if (targetJoined?.length) {
+                        const joinedNames = new Set(targetJoined.map((g) => g.name));
+                        const physicalKeys = foreign[4].filter((k) => !joinedNames.has(k));
+                        if (physicalKeys.length > 0 &&
+                            physicalKeys.every((k) => plain[k] === null || plain[k] === undefined)) {
+                            return null;
+                        }
+                    }
+                    const plainPlucked = {};
+                    for (const key of foreign[4]) {
+                        plainPlucked[key] = plain[key];
+                    }
+                    return plainPlucked;
+                };
+                entry[name] = Array.isArray(entry[name])
+                    ? entry[name].map(processForeign)
+                    : processForeign(entry[name]);
+            }
+        }
+    }
+}
+//# sourceMappingURL=validation.js.map

package/dist/internal/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/internal/validation.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AAkBtC,8BAWC;AAED,wBAkBC;AAED,sCAaC;AAED,sCAiDC;AAjHD,uEAAwD;AAExD,uFAKoE;AAIpE,qCAAmD;AAKnD,SAAgB,SAAS,CAAC,IAAiB;IACzC,IAAI,IAAI,GAAY,IAAI,CAAC;IACzB,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACrC,CAAC;QAAC,MAAM,CAAC;YACP,IAAA,2BAAM,EAAC,KAAK,EAAE,GAAG,EAAE,oBAAoB,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IACD,IAAA,2BAAM,EAAC,IAAA,sBAAa,EAAC,IAAI,CAAC,EAAE,GAAG,EAAE,yCAAyC,CAAC,CAAC;IAC5E,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAgB,MAAM,CAAC,GAAQ,EAAE,IAAiB,EAAE,MAAW;IAC7D,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,IAAI,KAAK,CAAC,OAAO,IAAI,IAAA,iBAAQ,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YAChE,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACxC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,qBAAY,EAAC,KAAK,EAAE,aAAa,CAAC,CAAC;gBACjE,CAAC,CAAC,IAAA,qBAAY,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IACD,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,CAAC;QAC5D,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;QACvB,IAAA,eAAM,EAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;QACzC,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/D,IAAI,SAAS,CAAC,OAAO,IAAI,IAAA,iBAAQ,EAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;gBACnD,IAAA,eAAM,EAAC,MAAM,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,aAAa,CAC3B,GAAQ,EACR,IAAiB,EACjB,GAAkB,EAClB,KAAQ;IAER,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAC3D,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QACtB,QAAQ;QACR,IAAI,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;KACnB,CAAC,CACH,CAAC;IACF,OAAO,IAAA,sBAAa,EAAC,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;AAC/D,CAAC;AAED,SAAgB,aAAa,CAC3B,IAAiB,EACjB,GAAmD;IAEnD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAEjD,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CACtD,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAC7B,CAAC;IACF,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC,SAAS,CAAC;QACvB,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,IAAI,aAAa,EAAE,CAAC;YAChD,IACE,OAAO;gBACP,IAAA,iBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACrB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBAC1B,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI;oBACvB,IAAA,iBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAC3B,CAAC;gBACD,MAAM,cAAc,GAAG,CAAC,IAAS,EAAE,EAAE;oBACnC,MAAM,KAAK,GAAG,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;oBAChC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;wBAClB,OAAO,KAAK,CAAC;oBACf,CAAC;oBACD,MAAM,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;oBAChC,IAAI,YAAY,EAAE,MAAM,EAAE,CAAC;wBACzB,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;wBAC7D,MAAM,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;wBACnE,IACE,YAAY,CAAC,MAAM,GAAG,CAAC;4BACvB,YAAY,CAAC,KAAK,CAChB,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CACnD,EACD,CAAC;4BACD,OAAO,IAAI,CAAC;wBACd,CAAC;oBACH,CAAC;oBACD,MAAM,YAAY,GAAmC,EAAE,CAAC;oBACxD,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;wBAC7B,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;oBACjC,CAAC;oBACD,OAAO,YAAY,CAAC;gBACtB,CAAC,CAAC;gBACF,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACtC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC;oBACjC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/metadata.d.ts

@@ -1,25 +1,10 @@
-import type { RequestContext } from "@antelopejs/interface-api";
 import type { ContainerModifier } from "@antelopejs/interface-database-decorators/modifiers/common";
-import type { Query, SchemaInstance, ValueProxy, ValueProxyOrValue } from "@antelopejs/interface-database";
 import { type Table } from "@antelopejs/interface-database-decorators";
-import { type Class, type ParameterDecorator } from "@antelopejs/interface-core/decorators";
-export type DataControllerCallback<O = any> = {
-    args: (ParameterDecorator | ParameterDecorator[])[];
-    method: string;
-    func: (ctx: any, opts: O, ...args: any[]) => any;
-};
-export type DataControllerCallbackWithOptions<O = any> = {
-    endpoint?: string;
-    options?: Partial<O>;
-    callback: DataControllerCallback<O>;
-};
-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]>;
-};
+import { type Class } from "@antelopejs/interface-core/decorators";
+import type { DataControllerCallbackWithOptions } from "./internal/controller-types";
+import type { FieldValidator, FieldData, ComputedExpression, ComputedOptions, FilterValue, FieldFilter, FilterFunction, ForeignOptions, ReadableAccessFields, WritableAccessFields } from "./internal/field-types";
+export type { DataControllerCallback, DataControllerCallbackWithOptions, ExtractCallback, DataControllerDef, ExtractDefCallbacks, } from "./internal/controller-types";
+export type { ForeignJoinedRef, FieldParseSuccess, FieldParseFailure, FieldParseResult, FieldValidationResult, FieldValue, FieldValues, ForeignOptions, FieldValidator, FieldData, ComputedExpression, ComputedOptions, ComputedFieldData, FilterValue, FieldFilter, FilterFunction, ReadableAccessFields, WritableAccessFields, } from "./internal/field-types";
 /**
  * Field access mode enum.
  */
@@ -28,126 +13,6 @@ export declare enum AccessMode {
     WriteOnly = 2,
     ReadWrite = 3
 }
-/**
- * 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;
-}
-/**
- * DataAPI Metadata field information.
- */
-/** Parse outcome accepting the field value, carrying the value to write. */
-export interface FieldParseSuccess {
-    success: true;
-    data: unknown;
-}
-/** 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: unknown) => FieldValidationResult | Promise<FieldValidationResult>;
-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;
-}
 /**
  * The access a field has in one data API action (`get`, `list`, `new`,
  * `edit`…): its {@link FieldData.modeOverrides} entry for that action, else
@@ -155,102 +20,35 @@ export interface FieldData {
  * field's own mode.
  */
 export declare function GetEffectiveMode(field: Pick<FieldData, "mode" | "modeOverrides">, action?: string): AccessMode | undefined;
-/**
- * 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`) or a per-row subquery
- * (ex: an aggregate over another table).
- */
-export type ComputedExpression = (row: ValueProxy<Record<string, any>>, db: SchemaInstance<any>) => ValueProxyOrValue<unknown> | Query<unknown>;
-/**
- * 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?: unknown;
-}
-/**
- * Computed field information.
- */
-export interface ComputedFieldData extends ComputedOptions {
-    expr: ComputedExpression;
-}
-type Comparison = "eq" | "ne" | "gt" | "ge" | "lt" | "le";
-export type FilterValue = [value: string, mode: Comparison];
-/**
- * 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[];
 /** The filters of one field as a list, whether it holds one or several. */
 export declare function FilterValuesOf(filter: FieldFilter): FilterValue[];
-/**
- * Filter callback.
- */
-export type FilterFunction<T extends Record<string, any>, U extends Record<string, any> = Record<string, any>> = (context: RequestContext & {
-    this: T;
-}, proxy: ValueProxy<any>, key: string, 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][];
-}
 /**
  * Metadata Class containing the DataAPI information.
  */
 export declare class DataAPIMeta {
     readonly target: Class;
-    /**
-     * Key symbol.
-     */
+    /** Key symbol. */
     static key: symbol;
-    readonly filters: Record<string, FilterFunction<any>>;
-    /**
-     * Fields information.
-     */
+    readonly filters: Record<string, FilterFunction<any, any>>;
+    /** Fields information. */
     readonly fields: Record<string, FieldData>;
-    /**
-     * Fields to pluck in listing endpoints.
-     */
+    /** Fields to pluck in listing endpoints. */
     readonly pluck: Record<string, Set<string>>;
-    /**
-     * Key of the DataAPI class containing a database table instance.
-     */
-    modelKey?: string;
-    /**
-     * Keys of the DataAPI class containing database modifier keys.
-     */
-    modifierKeys: Map<typeof ContainerModifier<any>, string>;
-    /**
-     * Schema name where the table is registered.
-     */
+    /** Key of the DataAPI class containing a database table instance. */
+    modelKey?: PropertyKey;
+    /** Keys of the DataAPI class containing database modifier keys. */
+    modifierKeys: Map<typeof ContainerModifier<any>, PropertyKey>;
+    /** Schema name where the table is registered. */
     schemaName: string;
-    /**
-     * Database Schema class.
-     */
+    /** Database Schema class. */
     tableClass: Class;
-    /**
-     * Database Schema table name.
-     */
+    /** Database Schema table name. */
     tableName: string;
-    /**
-     * Readable fields.
-     */
+    /** Readable fields. */
     readonly readable: Record<string, ReadableAccessFields>;
-    /**
-     * Writeable fields.
-     */
+    /** Writeable fields. */
     readonly writable: Record<string, WritableAccessFields>;
-    /**
-     * Registered DataAPI endpoints.
-     */
+    /** Registered DataAPI endpoints. */
     readonly endpoints: Record<string, DataControllerCallbackWithOptions>;
     constructor(target: Class);
     inherit(parent: DataAPIMeta): void;
@@ -285,7 +83,6 @@ export declare class DataAPIMeta {
      * @param name Field name
      * @param active Sortable
      * @param noIndex Ignore database indexes
-     * @returns
      */
     setSortable(name: string, active: boolean, noIndex?: boolean): this;
     /**
@@ -325,8 +122,11 @@ export declare class DataAPIMeta {
      * @param table Other table
      * @param index Other table index
      * @param multi Index is a multi index
+     * @param targetMeta Metadata of the target's data controller. Its `@Joined`
+     *   fields that `pluck` names, or all of them when `pluck` is unset, are
+     *   resolved on the relation unless it is `multi`.
      */
-    setForeign(name: string, table: string | Class<Table>, index?: string, multi?: boolean, pluck?: string[], schema?: string, targetMeta?: DataAPIMeta): this;
+    setForeign(name: string, table: string | Class<Table>, ...[index, multi, pluck, schema, targetMeta]: ForeignOptions): this;
     /**
      * Set the validation function of a field.
      *
@@ -348,20 +148,20 @@ export declare class DataAPIMeta {
      * @param func Filter callback
      * @param index
      */
-    setFilter(name: string, func: FilterFunction<Record<string, any>, Record<string, any>>, useIndex?: boolean): this;
+    setFilter(name: string, func: FilterFunction<any, any>, useIndex?: boolean): this;
     /**
      * Sets the key containing the database table instance.
      *
      * @param name Field name
      */
-    setModelKey(name: string): this;
+    setModelKey(name: PropertyKey): this;
     /**
      * Sets the key containing the key for the given database modifier.
      *
      * @param name Field name
      * @param modifierClass Modifier
      */
-    setModifierKey(name: string, modifierClass: typeof ContainerModifier<any>): this;
+    setModifierKey(name: PropertyKey, modifierClass: typeof ContainerModifier<any>): this;
     /**
      * Adds the given endpoint to the DataAPI
      *
@@ -463,7 +263,7 @@ export declare const Validator: (validator: FieldValidator) => import("@antelope
  * to true for the default filter and false for custom filters. An indexed
  * equality lookup uses the raw string and bypasses the callback.
  */
-export declare const Filter: <T extends Record<string, any>>(func?: FilterFunction<T, T>, useIndex?: boolean) => (target: T, propertyKey: string | symbol) => void;
+export declare function Filter<T extends Record<string, any>>(func?: FilterFunction<T, T>, useIndex?: boolean): (target: T, propertyKey: string | symbol) => void;
 /**
  * Sets which field will contain the reference to the database model instance.
  */
@@ -475,4 +275,3 @@ export declare const ModelReference: () => import("@antelopejs/interface-core/de
  */
 export declare const ModifierKey: (modifierClass: typeof ContainerModifier<any>) => import("@antelopejs/interface-core/decorators").PropertyDecorator;
 export declare function GetDataControllerMeta(thisObj: any): DataAPIMeta;
-export {};