kysely-rizzolver 0.0.2 → 0.0.3

package/dist/cjs/fks.d.ts

@@ -0,0 +1,111 @@
+import type { ExpressionBuilder, Kysely, OperandExpression, Selectable, SelectType } from 'kysely';
+import type { FKDefsEntry } from './kysely-rizzolver-fk-builder.js';
+import { type KyselyRizzolverBase, type KyselyRizzolverFKs } from './kysely-rizzolver.js';
+import type { ModelCollection } from './model-collection.js';
+import type { OmitByValue } from './type-helpers.js';
+/**
+ * The maximum depth to gather FKs in a single gather operation.
+ *
+ * If you change this, you must also change {@link NextDepth}.
+ */
+export declare const MAX_FK_GATHER_DEPTH = 3;
+/**
+ * For each supported gather depth, assigns the value depth - 1. This is used to recursively construct the types for {@link ModelFkInstance}.
+ *
+ * If you change this, you must also change {@link MAX_FK_GATHER_DEPTH}.
+ */
+type NextDepth = {
+    3: 2;
+    2: 1;
+    1: 0;
+};
+/**
+ * The depth at which FKs can be gathered.
+ *
+ * A depth of 0 = bare model only. This is equivalent to a fetch without gathers.
+ */
+export type ValidFkDepth = (keyof NextDepth & number) | 0;
+type Fk<DB, Referencing extends keyof DB & string, Referenced extends keyof DB & string, IsNullable extends boolean> = {
+    myTable: Referencing;
+    myField: string;
+    otherTable: Referenced;
+    otherField: string;
+    isNullable: IsNullable;
+};
+/**
+ * Omit FK properties from `T`.
+ */
+export type OmitFks<T> = OmitByValue<T, Fk<any, any, any, any>>;
+export declare class ModelFkGatherError extends Error {
+    constructor(table: string, id: number, reason: string);
+}
+/**
+ * A model whose FK fields have not been gathered.
+ */
+export type ModelFkBare<DBFk, Table extends keyof DBFk & string> = {
+    __fkDepth: 0;
+    __table: Table;
+} & Selectable<OmitFks<DBFk[Table]>>;
+/**
+ * A model whose FKs fields have been gathered up to a specific depth.
+ */
+export type ModelFkGathered<DBFk, Table extends keyof DBFk & string, Depth extends Exclude<ValidFkDepth, 0>> = {
+    __fkDepth: Depth;
+    __table: Table;
+} & {
+    [k in keyof DBFk[Table]]: DBFk[Table][k] extends infer U ? U extends Fk<any, any, infer UU, infer NN> ? MaybeNullable<ModelFkInstance<DBFk, UU & keyof DBFk, NextDepth[Depth]>, NN> : SelectType<U> : never;
+};
+export type ModelFkInstance<DBFk, Table extends keyof DBFk & string, Depth extends ValidFkDepth> = Depth extends 0 ? ModelFkBare<DBFk, Table> : ModelFkGathered<DBFk, Table, Exclude<Depth, 0>>;
+type MaybeNullable<T, Nullable extends boolean> = Nullable extends true ? T | null : T;
+export type ModelFkExtractSelectable<DB, Model> = Model extends ModelFkInstance<any, infer Table, any> ? Table extends keyof DB & string ? Selectable<DB[Table]> : never : Model extends undefined ? undefined : Model extends null ? null : never;
+/**
+ * A database schema `DB` with FK fields populated according to `FKDefs`.
+ *
+ * `FKDefs` is of type {@link KyselyRizzolverFKs}.
+ */
+export type DBWithFk<DB, FKDefs extends KyselyRizzolverFKs<DB>> = {
+    [K in keyof DB & string]: DB[K] & {
+        [F in keyof FKDefs[K] & string]: FKDefs[K][F] extends infer U ? U extends FKDefsEntry<DB, any, any, any, any> ? Fk<DB, K, U['otherTable'], U['isNullable']> : never : never;
+    };
+};
+/**
+ * Given a database schema with FKs `DBFK`, returns a database schema without
+ * FKs.
+ */
+export type DBWithoutFk<DBFK> = {
+    [k in keyof DBFK & string]: OmitFks<DBFK[k]>;
+};
+export type GatherOpts<DB, Depth extends ValidFkDepth> = {
+    /**
+     * The depth to gather FKs to. Default: {@link MAX_FK_GATHER_DEPTH}.
+     */
+    depth?: Depth;
+    /**
+     * When an invalid model is found, the gather function can either:
+     * - `throw` - throws a {@link ModelFkGatherError}.
+     * - `omit` - omits the model from the result array.
+     * - `null` - puts `null` values in the result array. This is useful if you
+     *   want to match the input array to the output array by index while still
+     *   indicating that a model is invalid.
+     * - `keep` - keeps the invalid model in the result array.
+     *
+     * An invalid model is a model that has an FK field that is unexpectedly
+     * missing.
+     *
+     * For example, if the model has a `user_id` field whose value is 3 but
+     * there is no user with ID 3 in the database, the model is invalid.
+     *
+     * Default: `omit`
+     */
+    onInvalidModel?: 'omit' | 'throw' | 'null' | 'keep';
+    /**
+     * If provided, will populate this collection with the gathered models.
+     */
+    modelCollection?: ModelCollection<DB>;
+};
+export type NoNullGatherOpts<DB, Depth extends ValidFkDepth> = Omit<GatherOpts<DB, Depth>, 'onInvalidModel'> & {
+    onInvalidModel?: 'omit' | 'throw' | 'keep';
+};
+export type GatherWhereExpression<DB, Table extends keyof DB & string> = (eb: ExpressionBuilder<Pick<DB, Table>, Table>) => OperandExpression<any>;
+export declare function gatherModelFks<DB, FKDefs extends KyselyRizzolverFKs<DB>, KY extends KyselyRizzolverBase<DB, Record<keyof DB & string, any>, FKDefs>, Table extends keyof DB & string, Depth extends ValidFkDepth = typeof MAX_FK_GATHER_DEPTH>(rizzolver: KY, dbInstance: Kysely<DB>, table: Table, where: GatherWhereExpression<DB, Table>, opts?: GatherOpts<DB, Depth>): Promise<(ModelFkInstance<DBWithFk<DB, FKDefs>, Table, Depth> | null)[]>;
+export {};

package/dist/cjs/fks.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelFkGatherError = exports.MAX_FK_GATHER_DEPTH = void 0;
+exports.gatherModelFks = gatherModelFks;
+/**
+ * The maximum depth to gather FKs in a single gather operation.
+ *
+ * If you change this, you must also change {@link NextDepth}.
+ */
+exports.MAX_FK_GATHER_DEPTH = 3;
+class ModelFkGatherError extends Error {
+    constructor(table, id, reason) {
+        super(`Failed to gather model (table: '${table}', id: ${id}): ${reason}`);
+    }
+}
+exports.ModelFkGatherError = ModelFkGatherError;
+async function gatherModelFks(rizzolver, dbInstance, table, where, opts = {}) {
+    const depth = opts.depth ?? exports.MAX_FK_GATHER_DEPTH;
+    const onInvalidModel = opts.onInvalidModel ?? 'omit';
+    const modelCollection = opts.modelCollection ?? null;
+    const fkDefs = rizzolver._types.fkDefs;
+    let qb = rizzolver
+        .newQueryBuilder()
+        .add(table, table, rizzolver._types.fields[table]);
+    const gatherItems = [];
+    qb = _collectGatherData(fkDefs, table, qb, depth, gatherItems);
+    let ky = dbInstance.selectFrom(table);
+    for (const gatherItem of gatherItems) {
+        ky = ky.leftJoin(gatherItem.tableAlias, gatherItem.join);
+    }
+    ky = ky.select(qb.allFields()).where((eb) => where(eb));
+    const rizzult = await qb.run(() => ky.execute());
+    const collection = rizzult.models;
+    modelCollection?.addCollection(collection);
+    const result = rizzult.rows.map((row) => {
+        const baseModel = row.selectors[table];
+        const gatheredModel = _baseToGatheredModel(fkDefs, table, baseModel, collection, exports.MAX_FK_GATHER_DEPTH, onInvalidModel);
+        return gatheredModel;
+    });
+    if (onInvalidModel === 'omit') {
+        return result.filter((model) => model !== null);
+    }
+    return result;
+}
+function _collectGatherData(fkDefs, table, qb, depthLeft, result) {
+    if (depthLeft <= 0) {
+        return qb;
+    }
+    const myAlias = qb.numSelectors == 1 ? table : `fk${qb.numSelectors - 1}`;
+    const myFkDefs = fkDefs[table] ?? {};
+    for (const fkDef of Object.values(myFkDefs)) {
+        const otherAlias = `fk${qb.numSelectors}`;
+        qb = qb.add(fkDef.otherTable, otherAlias);
+        const myField = `${myAlias}.${fkDef.myField}`; // qb.selectors[myAlias].field(fkDef.myField).str;
+        const otherField = `${otherAlias}.${fkDef.otherField}`; // qb.selectors[otherAlias].field(fkDef.otherField).str;
+        const join = (join) => join.onRef(myField, '=', otherField);
+        result.push({ tableAlias: qb.table(otherAlias), join });
+        qb = _collectGatherData(fkDefs, fkDef.otherTable, qb, (depthLeft - 1), result);
+    }
+    return qb;
+}
+function _baseToGatheredModel(fkDefs, table, baseModel, collection, depth, onInvalidModel) {
+    if (depth <= 0) {
+        return { __fkDepth: 0, __table: table, ...baseModel };
+    }
+    const myId = baseModel['id'];
+    if (!myId || typeof myId !== 'number') {
+        throw new Error('Expected model to have a valid id');
+    }
+    const gatheredModel = { __fkDepth: depth, __table: table, ...baseModel };
+    const myFkDefs = fkDefs[table] ?? {};
+    for (const [fkName, fkDef] of Object.entries(myFkDefs)) {
+        const fkValue = baseModel[fkDef.myField];
+        if (fkValue !== null && fkValue !== undefined && typeof fkValue !== 'number') {
+            throw new ModelFkGatherError(table, myId, `Invalid looking FK value for reference '${fkName}' (field: '${fkDef.myField}'). Expected positive number, got: '${JSON.stringify(fkValue)}'`);
+        }
+        const expectsOtherModel = fkValue !== null && fkValue !== undefined && fkValue !== 0;
+        const otherBaseModel = expectsOtherModel
+            ? collection.get(fkDef.otherTable, fkValue) ?? null
+            : null;
+        const isValid = expectsOtherModel === !!otherBaseModel;
+        if (!isValid) {
+            switch (onInvalidModel) {
+                case 'omit':
+                case 'null':
+                    return null;
+                case 'throw':
+                    throw new ModelFkGatherError(table, myId, `Could not find model for FK reference '${fkName}' (field: '${fkDef.myField}') for id ${fkValue}`);
+            }
+        }
+        if (otherBaseModel) {
+            const otherGatheredModel = _baseToGatheredModel(fkDefs, fkDef.otherTable, otherBaseModel, collection, (depth - 1), onInvalidModel);
+            gatheredModel[fkName] = otherGatheredModel;
+        }
+        else {
+            gatheredModel[fkName] = undefined;
+        }
+    }
+    return gatheredModel;
+}
+//# sourceMappingURL=fks.js.map

package/dist/cjs/fks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fks.js","sourceRoot":"","sources":["../../src/fks.ts"],"names":[],"mappings":";;;AA4KA,wCAoDC;AA9MD;;;;GAIG;AACU,QAAA,mBAAmB,GAAG,CAAC,CAAC;AAsCrC,MAAa,kBAAmB,SAAQ,KAAK;IAC5C,YAAY,KAAa,EAAE,EAAU,EAAE,MAAc;QACpD,KAAK,CAAC,mCAAmC,KAAK,UAAU,EAAE,MAAM,MAAM,EAAE,CAAC,CAAC;IAC3E,CAAC;CACD;AAJD,gDAIC;AA2GM,KAAK,UAAU,cAAc,CAOnC,SAAa,EACb,UAAsB,EACtB,KAAY,EACZ,KAAuC,EACvC,OAA8B,EAAE;IAEhC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,2BAAmB,CAAC;IAChD,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,MAAM,CAAC;IACrD,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC;IAErD,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC;IACvC,IAAI,EAAE,GAAI,SAAuD;SAC/D,eAAe,EAAE;SACjB,GAAG,CAAC,KAAK,EAAE,KAAY,EAAE,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAoB,CAAC;IAE9E,MAAM,WAAW,GAAiB,EAAE,CAAC;IACrC,EAAE,GAAG,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IAE/D,IAAI,EAAE,GAAG,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACtC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACtC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAiB,EAAE,UAAU,CAAC,IAAI,CAAQ,CAAC;IACxE,CAAC;IACD,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,EAAS,CAAC,CAAC,CAAC;IAC/D,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IAEjD,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAClC,eAAe,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IAC3C,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACvC,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,KAAK,CAAE,CAAC;QACxC,MAAM,aAAa,GAAG,oBAAoB,CACzC,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,EACV,2BAAmB,EACnB,cAAc,CACd,CAAC;QACF,OAAO,aAA2E,CAAC;IACpF,CAAC,CAAC,CAAC;IAEH,IAAI,cAAc,KAAK,MAAM,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,MAAM,CAAC;AACf,CAAC;AAOD,SAAS,kBAAkB,CAC1B,MAA+B,EAC/B,KAAa,EACb,EAAmB,EACnB,SAAuB,EACvB,MAAoB;IAEpB,IAAI,SAAS,IAAI,CAAC,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC;IAC1E,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACrC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7C,MAAM,UAAU,GAAG,KAAK,EAAE,CAAC,YAAY,EAAE,CAAC;QAC1C,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAE1C,MAAM,OAAO,GAAG,GAAG,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,kDAAkD;QACjG,MAAM,UAAU,GAAG,GAAG,UAAU,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,wDAAwD;QAChH,MAAM,IAAI,GAA0C,CAAC,IAAI,EAAE,EAAE,CAC5D,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;QAEtC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QAExD,EAAE,GAAG,kBAAkB,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,EAAE,EAAE,CAAC,SAAS,GAAG,CAAC,CAAiB,EAAE,MAAM,CAAC,CAAC;IAChG,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC;AAED,SAAS,oBAAoB,CAC5B,MAA+B,EAC/B,KAAa,EACb,SAAkC,EAClC,UAAgC,EAChC,KAAmB,EACnB,cAAmE;IAEnE,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QAChB,OAAO,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,SAAS,EAAE,CAAC;IACvD,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC7B,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACtD,CAAC;IAED,MAAM,aAAa,GAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,SAAS,EAAE,CAAC;IAC9E,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACrC,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxD,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC9E,MAAM,IAAI,kBAAkB,CAC3B,KAAK,EACL,IAAI,EACJ,2CAA2C,MAAM,cAChD,KAAK,CAAC,OACP,uCAAuC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CACjE,CAAC;QACH,CAAC;QAED,MAAM,iBAAiB,GAAG,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,CAAC;QACrF,MAAM,cAAc,GAAG,iBAAiB;YACvC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,IAAI;YACnD,CAAC,CAAC,IAAI,CAAC;QAER,MAAM,OAAO,GAAG,iBAAiB,KAAK,CAAC,CAAC,cAAc,CAAC;QACvD,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,QAAQ,cAAc,EAAE,CAAC;gBACxB,KAAK,MAAM,CAAC;gBACZ,KAAK,MAAM;oBACV,OAAO,IAAI,CAAC;gBACb,KAAK,OAAO;oBACX,MAAM,IAAI,kBAAkB,CAC3B,KAAK,EACL,IAAI,EACJ,0CAA0C,MAAM,cAAc,KAAK,CAAC,OAAO,aAAa,OAAO,EAAE,CACjG,CAAC;YACJ,CAAC;QACF,CAAC;QAED,IAAI,cAAc,EAAE,CAAC;YACpB,MAAM,kBAAkB,GAAG,oBAAoB,CAC9C,MAAM,EACN,KAAK,CAAC,UAAU,EAChB,cAAc,EACd,UAAU,EACV,CAAC,KAAK,GAAG,CAAC,CAAiB,EAC3B,cAAc,CACd,CAAC;YAEF,aAAa,CAAC,MAAM,CAAC,GAAG,kBAAkB,CAAC;QAC5C,CAAC;aAAM,CAAC;YACP,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;QACnC,CAAC;IACF,CAAC;IAED,OAAO,aAAa,CAAC;AACtB,CAAC"}

package/dist/cjs/index.d.ts

@@ -1,10 +1,16 @@
 export { KyselyRizzolver } from './kysely-rizzolver.js';
-export type { AllTableFields, AnyTableField, KyselyRizzolverBuilderForSchema, KyselyRizzolverBuilderNoSchema, KyDB as RizzolverDB, TableName } from './kysely-rizzolver.js';
-export { assertIsFetchOneResult, assertIsFetchOneXResult, assertIsFetchSomeResult, isFetchOneResult, isFetchOneXResult, isFetchSomeResult, newFetchOneResult, newFetchOneXResult, newFetchSomeResult } from './fetch-result.js';
+export type { KyAllTableFields as AllTableFields, KyAnyTableField as AnyTableField, KyDB as RizzolverDB, KyTableName as TableName } from './kysely-rizzolver.js';
+export { assertIsFetchOneResult, assertIsFetchOneXResult, assertIsFetchSomeResult, isFetchOneResult, isFetchOneXResult, isFetchResult, isFetchSomeResult, newFetchOneResult, newFetchOneXResult, newFetchSomeResult } from './fetch-result.js';
 export type { AsFetchOneResult, AsFetchOneXResult, AsFetchSomeResult, FetchOneResult, FetchOneXResult, FetchResult, FetchSomeResult } from './fetch-result.js';
+export { assertIsGatherOneResult, assertIsGatherOneXResult, assertIsGatherSomeResult, isGatherOneResult, isGatherOneXResult, isGatherResult, isGatherSomeResult, newGatherOneResult, newGatherOneXResult, newGatherSomeResult } from './fk-gather-result.js';
+export type { AsGatherOneResult, AsGatherOneXResult, AsGatherSomeResult, FkGatherOneResult, FkGatherOneXResult, FkGatherResult, FkGatherSomeResult } from './fk-gather-result.js';
+export { MAX_FK_GATHER_DEPTH, ModelFkGatherError } from './fks.js';
+export type { ModelFkBare, ModelFkGathered, ModelFkInstance, ValidFkDepth, GatherWhereExpression } from './fks.js';
+export type { KyselyRizzolverBuilder } from './kysely-rizzolver-builder.js';
+export type { KyselyRizzolverFkBuilder } from './kysely-rizzolver-fk-builder.js';
 export { newSelector } from './selector.js';
-export type { Selector } from './selector.js';
+export type { AnySelector, Selector } from './selector.js';
 export { newQueryBuilder } from './query-builder.js';
-export type { QueryBuilder } from './query-builder.js';
+export type { AnyQueryBuilder, QueryBuilder } from './query-builder.js';
 export { newModelCollection } from './model-collection.js';
 export type { ModelCollection } from './model-collection.js';

package/dist/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.newModelCollection = exports.newQueryBuilder = exports.newSelector = exports.newFetchSomeResult = exports.newFetchOneXResult = exports.newFetchOneResult = exports.isFetchSomeResult = exports.isFetchOneXResult = exports.isFetchOneResult = exports.assertIsFetchSomeResult = exports.assertIsFetchOneXResult = exports.assertIsFetchOneResult = exports.KyselyRizzolver = void 0;
+exports.newModelCollection = exports.newQueryBuilder = exports.newSelector = exports.ModelFkGatherError = exports.MAX_FK_GATHER_DEPTH = exports.newGatherSomeResult = exports.newGatherOneXResult = exports.newGatherOneResult = exports.isGatherSomeResult = exports.isGatherResult = exports.isGatherOneXResult = exports.isGatherOneResult = exports.assertIsGatherSomeResult = exports.assertIsGatherOneXResult = exports.assertIsGatherOneResult = exports.newFetchSomeResult = exports.newFetchOneXResult = exports.newFetchOneResult = exports.isFetchSomeResult = exports.isFetchResult = exports.isFetchOneXResult = exports.isFetchOneResult = exports.assertIsFetchSomeResult = exports.assertIsFetchOneXResult = exports.assertIsFetchOneResult = exports.KyselyRizzolver = void 0;
 var kysely_rizzolver_js_1 = require("./kysely-rizzolver.js");
 Object.defineProperty(exports, "KyselyRizzolver", { enumerable: true, get: function () { return kysely_rizzolver_js_1.KyselyRizzolver; } });
 var fetch_result_js_1 = require("./fetch-result.js");
@@ -9,13 +9,29 @@ Object.defineProperty(exports, "assertIsFetchOneXResult", { enumerable: true, ge
 Object.defineProperty(exports, "assertIsFetchSomeResult", { enumerable: true, get: function () { return fetch_result_js_1.assertIsFetchSomeResult; } });
 Object.defineProperty(exports, "isFetchOneResult", { enumerable: true, get: function () { return fetch_result_js_1.isFetchOneResult; } });
 Object.defineProperty(exports, "isFetchOneXResult", { enumerable: true, get: function () { return fetch_result_js_1.isFetchOneXResult; } });
+Object.defineProperty(exports, "isFetchResult", { enumerable: true, get: function () { return fetch_result_js_1.isFetchResult; } });
 Object.defineProperty(exports, "isFetchSomeResult", { enumerable: true, get: function () { return fetch_result_js_1.isFetchSomeResult; } });
 Object.defineProperty(exports, "newFetchOneResult", { enumerable: true, get: function () { return fetch_result_js_1.newFetchOneResult; } });
 Object.defineProperty(exports, "newFetchOneXResult", { enumerable: true, get: function () { return fetch_result_js_1.newFetchOneXResult; } });
 Object.defineProperty(exports, "newFetchSomeResult", { enumerable: true, get: function () { return fetch_result_js_1.newFetchSomeResult; } });
+var fk_gather_result_js_1 = require("./fk-gather-result.js");
+Object.defineProperty(exports, "assertIsGatherOneResult", { enumerable: true, get: function () { return fk_gather_result_js_1.assertIsGatherOneResult; } });
+Object.defineProperty(exports, "assertIsGatherOneXResult", { enumerable: true, get: function () { return fk_gather_result_js_1.assertIsGatherOneXResult; } });
+Object.defineProperty(exports, "assertIsGatherSomeResult", { enumerable: true, get: function () { return fk_gather_result_js_1.assertIsGatherSomeResult; } });
+Object.defineProperty(exports, "isGatherOneResult", { enumerable: true, get: function () { return fk_gather_result_js_1.isGatherOneResult; } });
+Object.defineProperty(exports, "isGatherOneXResult", { enumerable: true, get: function () { return fk_gather_result_js_1.isGatherOneXResult; } });
+Object.defineProperty(exports, "isGatherResult", { enumerable: true, get: function () { return fk_gather_result_js_1.isGatherResult; } });
+Object.defineProperty(exports, "isGatherSomeResult", { enumerable: true, get: function () { return fk_gather_result_js_1.isGatherSomeResult; } });
+Object.defineProperty(exports, "newGatherOneResult", { enumerable: true, get: function () { return fk_gather_result_js_1.newGatherOneResult; } });
+Object.defineProperty(exports, "newGatherOneXResult", { enumerable: true, get: function () { return fk_gather_result_js_1.newGatherOneXResult; } });
+Object.defineProperty(exports, "newGatherSomeResult", { enumerable: true, get: function () { return fk_gather_result_js_1.newGatherSomeResult; } });
+var fks_js_1 = require("./fks.js");
+Object.defineProperty(exports, "MAX_FK_GATHER_DEPTH", { enumerable: true, get: function () { return fks_js_1.MAX_FK_GATHER_DEPTH; } });
+Object.defineProperty(exports, "ModelFkGatherError", { enumerable: true, get: function () { return fks_js_1.ModelFkGatherError; } });
 var selector_js_1 = require("./selector.js");
 Object.defineProperty(exports, "newSelector", { enumerable: true, get: function () { return selector_js_1.newSelector; } });
 var query_builder_js_1 = require("./query-builder.js");
 Object.defineProperty(exports, "newQueryBuilder", { enumerable: true, get: function () { return query_builder_js_1.newQueryBuilder; } });
 var model_collection_js_1 = require("./model-collection.js");
 Object.defineProperty(exports, "newModelCollection", { enumerable: true, get: function () { return model_collection_js_1.newModelCollection; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,6DAAwD;AAA/C,sHAAA,eAAe,OAAA;AAQxB,qDAW2B;AAV1B,yHAAA,sBAAsB,OAAA;AACtB,0HAAA,uBAAuB,OAAA;AACvB,0HAAA,uBAAuB,OAAA;AACvB,mHAAA,gBAAgB,OAAA;AAChB,oHAAA,iBAAiB,OAAA;AACjB,gHAAA,aAAa,OAAA;AACb,oHAAA,iBAAiB,OAAA;AACjB,oHAAA,iBAAiB,OAAA;AACjB,qHAAA,kBAAkB,OAAA;AAClB,qHAAA,kBAAkB,OAAA;AAYnB,6DAW+B;AAV9B,8HAAA,uBAAuB,OAAA;AACvB,+HAAA,wBAAwB,OAAA;AACxB,+HAAA,wBAAwB,OAAA;AACxB,wHAAA,iBAAiB,OAAA;AACjB,yHAAA,kBAAkB,OAAA;AAClB,qHAAA,cAAc,OAAA;AACd,yHAAA,kBAAkB,OAAA;AAClB,yHAAA,kBAAkB,OAAA;AAClB,0HAAA,mBAAmB,OAAA;AACnB,0HAAA,mBAAmB,OAAA;AAYpB,mCAAmE;AAA1D,6GAAA,mBAAmB,OAAA;AAAE,4GAAA,kBAAkB,OAAA;AAYhD,6CAA4C;AAAnC,0GAAA,WAAW,OAAA;AAGpB,uDAAqD;AAA5C,mHAAA,eAAe,OAAA;AAGxB,6DAA2D;AAAlD,yHAAA,kBAAkB,OAAA"}

package/dist/cjs/kysely-rizzolver-builder.d.ts

@@ -0,0 +1,17 @@
+import type { Simplify } from 'kysely';
+import { MAX_FK_GATHER_DEPTH, type ValidFkDepth } from './fks.js';
+import { type FkDefsBuilderCallback } from './kysely-rizzolver-fk-builder.js';
+import { KyselyRizzolver, type KyselyRizzolverFKs } from './kysely-rizzolver.js';
+export type KyselyRizzolverBuilder<DB, T extends Partial<Record<keyof DB & string, readonly string[]>>, DefaultGatherDepth extends ValidFkDepth = typeof MAX_FK_GATHER_DEPTH> = T extends Record<keyof DB & string, readonly string[]> ? _KyselyRizzolverBuilder_Valid<DB, T, DefaultGatherDepth> : _KyselyRizzolverBuilder_InProgress<DB, T, DefaultGatherDepth>;
+type _KyselyRizzolverBuilder_Valid<DB, T extends Record<keyof DB & string, readonly string[]>, DefaultGatherDepth extends ValidFkDepth = typeof MAX_FK_GATHER_DEPTH> = {
+    defaultGatherDepth<NewDepth extends ValidFkDepth>(depth: NewDepth): _KyselyRizzolverBuilder_Valid<DB, T, NewDepth>;
+    build<FKDefs extends KyselyRizzolverFKs<DB>>(fkBuilderCb: FkDefsBuilderCallback<DB, FKDefs>): KyselyRizzolver<DB, T, Simplify<FKDefs>, DefaultGatherDepth>;
+    build(): KyselyRizzolver<DB, T, {}, DefaultGatherDepth>;
+};
+type _KyselyRizzolverBuilder_InProgress<DB, T extends Partial<Record<keyof DB & string, readonly string[]>>, DefaultGatherDepth extends ValidFkDepth = typeof MAX_FK_GATHER_DEPTH> = {
+    table<K extends keyof DB & string, U extends readonly (keyof DB[K])[]>(name: K, fields: U & ([keyof DB[K]] extends [U[number]] ? unknown : `Missing key: ${Exclude<keyof DB[K] & string, U[number]>}`)): KyselyRizzolverBuilder<DB, T & {
+        [key in K]: U;
+    }, DefaultGatherDepth>;
+};
+export declare function newKyselyRizzolverBuilder<DB, T extends Partial<Record<keyof DB & string, readonly string[]>>, DefaultGatherDepth extends ValidFkDepth = typeof MAX_FK_GATHER_DEPTH>(fields: T, defaultGatherDepth?: DefaultGatherDepth): KyselyRizzolverBuilder<DB, T>;
+export {};

package/dist/cjs/kysely-rizzolver-builder.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.newKyselyRizzolverBuilder = newKyselyRizzolverBuilder;
+const kysely_rizzolver_fk_builder_js_1 = require("./kysely-rizzolver-fk-builder.js");
+const kysely_rizzolver_js_1 = require("./kysely-rizzolver.js");
+function newKyselyRizzolverBuilder(fields, defaultGatherDepth) {
+    return {
+        table(tableName, tableFields) {
+            return newKyselyRizzolverBuilder({
+                ...fields,
+                [tableName]: tableFields
+            });
+        },
+        defaultGatherDepth(depth) {
+            return newKyselyRizzolverBuilder(fields, depth);
+        },
+        build(cb) {
+            const defs = cb?.((0, kysely_rizzolver_fk_builder_js_1.newKyselyRizzolverFkBuilder)({}));
+            return new kysely_rizzolver_js_1.KyselyRizzolver(fields, defs ?? {}, defaultGatherDepth);
+        }
+    };
+}
+//# sourceMappingURL=kysely-rizzolver-builder.js.map

package/dist/cjs/kysely-rizzolver-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kysely-rizzolver-builder.js","sourceRoot":"","sources":["../../src/kysely-rizzolver-builder.ts"],"names":[],"mappings":";;AA4CA,8DA4BC;AAtED,qFAG0C;AAC1C,+DAAiF;AAsCjF,SAAgB,yBAAyB,CAIvC,MAAS,EAAE,kBAAuC;IACnD,OAAO;QACN,KAAK,CACJ,SAAY,EACZ,WAG+D;YAE/D,OAAO,yBAAyB,CAA6C;gBAC5E,GAAG,MAAM;gBACT,CAAC,SAAS,CAAC,EAAE,WAAW;aACxB,CAAQ,CAAC;QACX,CAAC;QAED,kBAAkB,CAAiC,KAAgB;YAClE,OAAO,yBAAyB,CAAmB,MAAM,EAAE,KAAK,CAAC,CAAC;QACnE,CAAC;QAED,KAAK,CAAwC,EAAsC;YAClF,MAAM,IAAI,GAAG,EAAE,EAAE,CAAC,IAAA,4DAA2B,EAAK,EAAE,CAAC,CAAC,CAAC;YACvD,OAAO,IAAI,qCAAe,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE,EAAE,kBAAkB,CAAC,CAAC;QACpE,CAAC;KAC2C,CAAC;AAC/C,CAAC"}

package/dist/cjs/kysely-rizzolver-fk-builder.d.ts

@@ -0,0 +1,20 @@
+import { KyselyRizzolverFKs } from './kysely-rizzolver.js';
+import { NumericFields } from './type-helpers.js';
+export type FkDefsBuilderCallback<DB, T> = (builder: KyselyRizzolverFkBuilder<DB, {}>) => T;
+export type KyselyRizzolverFkBuilder<DB, FKDefs extends KyselyRizzolverFKs<DB> = {}> = {
+    add<FromTable extends keyof DB & string, FromField extends Exclude<NumericFields<DB[FromTable]> & string, 'id'>, ToTable extends keyof DB & string, ToField extends NumericFields<DB[ToTable]> & string, FkName extends string, Nullable extends boolean = false>(fromTable: FromTable, fromField: FromField, toTable: ToTable, toField: ToField, fkName: FkName, nullable?: Nullable): KyselyRizzolverFkBuilder<DB, FKDefsAddEntry<DB, FKDefs, FromTable, FromField, ToTable, ToField, FkName, Nullable>>;
+    build(): FKDefs;
+};
+type FKDefsAddEntry<DB, FKDefs extends KyselyRizzolverFKs<DB>, FromTable extends keyof DB & string, FromField extends string, ToTable extends keyof DB & string, ToField extends string, FkName extends string, Nullable extends boolean> = FKDefs & {
+    [K in FromTable]: {
+        [N in FkName]: FKDefsEntry<DB, FromField, ToTable, ToField, Nullable>;
+    };
+};
+export type FKDefsEntry<DB, FromField extends string, ToTable extends keyof DB & string, ToField extends string, Nullable extends boolean> = {
+    myField: FromField;
+    otherTable: ToTable;
+    otherField: ToField;
+    isNullable: Nullable;
+};
+export declare function newKyselyRizzolverFkBuilder<DB, FKDefs extends KyselyRizzolverFKs<DB> = {}>(fkDefs: FKDefs): KyselyRizzolverFkBuilder<DB, FKDefs>;
+export {};

package/dist/cjs/kysely-rizzolver-fk-builder.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.newKyselyRizzolverFkBuilder = newKyselyRizzolverFkBuilder;
+function newKyselyRizzolverFkBuilder(fkDefs) {
+    return {
+        add(fromTable, fromField, toTable, toField, fkName, nullable) {
+            const defsForTable = (fkDefs[fromTable] ?? {});
+            const fkEntry = {
+                myField: fromField,
+                otherTable: toTable,
+                otherField: toField,
+                isNullable: nullable ?? false
+            };
+            defsForTable[fkName] = fkEntry;
+            fkDefs[fromTable] = defsForTable;
+            return newKyselyRizzolverFkBuilder(fkDefs);
+        },
+        build() {
+            return fkDefs;
+        }
+    };
+}
+//# sourceMappingURL=kysely-rizzolver-fk-builder.js.map

package/dist/cjs/kysely-rizzolver-fk-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kysely-rizzolver-fk-builder.js","sourceRoot":"","sources":["../../src/kysely-rizzolver-fk-builder.ts"],"names":[],"mappings":";;AAwDA,kEAqCC;AArCD,SAAgB,2BAA2B,CAC1C,MAAc;IAEd,OAAO;QACN,GAAG,CAQF,SAAoB,EACpB,SAAoB,EACpB,OAAgB,EAChB,OAAgB,EAChB,MAAc,EACd,QAAmB;YAEnB,MAAM,YAAY,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,CAAmC,CAAC;YACjF,MAAM,OAAO,GAAG;gBACf,OAAO,EAAE,SAAS;gBAClB,UAAU,EAAE,OAAO;gBACnB,UAAU,EAAE,OAAO;gBACnB,UAAU,EAAE,QAAQ,IAAI,KAAK;aAC6B,CAAC;YAE5D,YAAY,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC;YAC/B,MAAM,CAAC,SAAS,CAAC,GAAG,YAAY,CAAC;YAEjC,OAAO,2BAA2B,CAAU,MAAM,CAAC,CAAC;QACrD,CAAC;QAED,KAAK;YACJ,OAAO,MAAM,CAAC;QACf,CAAC;KACD,CAAC;AACH,CAAC"}

package/dist/cjs/kysely-rizzolver.d.ts

@@ -1,10 +1,17 @@
+import type { Kysely } from 'kysely';
 import { type FetchResultFactory } from './fetch-result-factory.js';
+import { FkGatherResultFactory } from './fk-gather-result-factory.js';
+import { DBWithFk, GatherOpts, GatherWhereExpression, MAX_FK_GATHER_DEPTH, NoNullGatherOpts, ValidFkDepth } from './fks.js';
+import { type ModelCollection } from './model-collection.js';
 import { type QueryBuilder } from './query-builder.js';
 import { type Selector } from './selector.js';
-import { type ModelCollection } from './model-collection.js';
-export interface KyselyRizzolverBase<DB, T extends Record<keyof DB & string, readonly string[]>> {
-    readonly fields: T;
-    readonly fetches: FetchResultFactory<DB>;
+import { WithMandatory } from './type-helpers.js';
+export interface KyselyRizzolverBase<DB, T extends Record<keyof DB & string, readonly string[]>, FKDefs extends KyselyRizzolverFKs<DB>> {
+    readonly _types: Readonly<{
+        fields: T;
+        fkDefs: FKDefs;
+        dbfk: DBWithFk<DB, FKDefs>;
+    }>;
 }
 /**
  * A {@link KyselyRizzolver} is a class that is used to define the structure of
@@ -17,14 +24,16 @@ export interface KyselyRizzolverBase<DB, T extends Record<keyof DB & string, rea
  * {@link KyselyRizzolver.builder|.builderForSchema()} or
  * {@link KyselyRizzolver.builderNoSchema|.builderNoSchema()}.
  */
-export declare class KyselyRizzolver<DB, T extends Record<keyof DB & string, readonly string[]>> implements KyselyRizzolverBase<DB, T> {
-    readonly fields: T;
-    readonly fetches: FetchResultFactory<DB>;
-    constructor(fields: T);
+export declare class KyselyRizzolver<DB, T extends Record<keyof DB & string, readonly string[]>, FKDefs extends KyselyRizzolverFKs<DB>, DefaultGatherDepth extends ValidFkDepth = typeof MAX_FK_GATHER_DEPTH> implements KyselyRizzolverBase<DB, T, FKDefs> {
+    readonly _types: KyselyRizzolverBase<DB, T, FKDefs>['_types'];
+    readonly fetchObjs: FetchResultFactory<DB>;
+    readonly gatherObjs: FkGatherResultFactory<DB, FKDefs>;
+    readonly defaultGatherDepth: DefaultGatherDepth;
+    constructor(fields: T, fks: FKDefs, defaultGatherDepth?: DefaultGatherDepth);
     /**
      * Intantiates a new {@link Selector} for the given table.
      */
-    newSelector<Table extends keyof DB & string, Alias extends string>(table: Table, alias: Alias): Selector<this, Table, Alias, AllTableFields<this, Table>>;
+    newSelector<Table extends keyof DB & string, Alias extends string>(table: Table, alias: Alias): Selector<this, Table, Alias, KyAllTableFields<this, Table>>;
     /**
      * Instantiates a new {@link QueryBuilder}.
      */
@@ -33,19 +42,25 @@ export declare class KyselyRizzolver<DB, T extends Record<keyof DB & string, rea
      * Instantiates a new {@link ModelCollection}.
      */
     newModelCollection(): ModelCollection<DB>;
+    gatherOne<Table extends keyof DB & string, Opts extends WithMandatory<GatherOpts<DB, ValidFkDepth>, 'depth'>>(db: Kysely<DB>, table: Table, where: GatherWhereExpression<DB, Table>, opts: Opts): Promise<ReturnType<typeof this.gatherObjs.newGatherOne<Table, Opts['depth']>>>;
+    gatherOne<Table extends keyof DB & string>(db: Kysely<DB>, table: Table, where: GatherWhereExpression<DB, Table>, opts?: Omit<GatherOpts<DB, any>, 'depth'>): Promise<ReturnType<typeof this.gatherObjs.newGatherOne<Table, DefaultGatherDepth>>>;
+    gatherOneX<Table extends keyof DB & string, Opts extends WithMandatory<GatherOpts<DB, ValidFkDepth>, 'depth'>>(db: Kysely<DB>, table: Table, where: GatherWhereExpression<DB, Table>, opts: Opts): Promise<ReturnType<typeof this.gatherObjs.newGatherOneX<Table, Opts['depth']>>>;
+    gatherOneX<Table extends keyof DB & string>(db: Kysely<DB>, table: Table, where: GatherWhereExpression<DB, Table>, opts?: Omit<GatherOpts<DB, any>, 'depth'>): Promise<ReturnType<typeof this.gatherObjs.newGatherOneX<Table, DefaultGatherDepth>>>;
+    gatherSome<Table extends keyof DB & string, Opts extends WithMandatory<NoNullGatherOpts<DB, ValidFkDepth>, 'depth'>>(db: Kysely<DB>, table: Table, where: GatherWhereExpression<DB, Table>, opts: Opts): Promise<ReturnType<typeof this.gatherObjs.newGatherSome<Table, Opts['depth']>>>;
+    gatherSome<Table extends keyof DB & string>(db: Kysely<DB>, table: Table, where: GatherWhereExpression<DB, Table>, opts?: Omit<NoNullGatherOpts<DB, any>, 'depth'>): Promise<ReturnType<typeof this.gatherObjs.newGatherSome<Table, DefaultGatherDepth>>>;
     /**
      * Starts building a new {@link KyselyRizzolver} using a builder pattern for
      * a schema.
      *
-     * Call {@link KyselyRizzolverBuilderForSchema.table|.table()} for each
+     * Call {@link KyselyRizzolverBuilder.table|.table()} for each
      * table that exists on the `DB` type parameter with all of their column
      * names as a const array. After all tables have been added, call
-     * {@link KyselyRizzolverBuilderForSchema.build|.build()} to get a new
+     * {@link KyselyRizzolverBuilder.build|.build()} to get a new
      * {@link KyselyRizzolver} instance.
      *
      * Example:
      * ```
-     * const rizzolver = KyselyRizzolver.builderForSchema<DB>()
+     * const rizzolver = KyselyRizzolver.builder<DB>()
      *   .table('user', ['id', 'name', 'email'] as const)
      *   .table('post', ['id', 'title', 'content', 'authorId'] as const)
      *   .build();
@@ -53,86 +68,50 @@ export declare class KyselyRizzolver<DB, T extends Record<keyof DB & string, rea
      *
      * Note: The `as const` assertion is necessary for correct type inference.
      */
-    static builderForSchema<DB>(): KyselyRizzolverBuilderForSchema<DB, {}>;
-    /**
-     * Starts building a new {@link KyselyRizzolver} using a builder pattern
-     * without a schema.
-     *
-     * Call {@link KyselyRizzolverBuilderNoSchema.table|.table()} for each
-     * table with all of their column names as a const array.
-     *
-     * Example:
-     * ```
-     * const rizzolver = KyselyRizzolver.builder()
-     *     .table('user', ['id', 'name', 'email'] as const) // note `as const` is necessary
-     *     .table('post', ['id', 'title', 'content', 'authorId'] as const)
-     *     .build();
-     * ```
-     *
-     * Since this version of builder is schemaless, it cannot infer the value
-     * types for the columns. The `user` type will be `{ id: unknown, name:
-     * unknown, email: unknown }`.
-     *
-     * You may call
-     * {@link KyselyRizzolverBuilderNoSchema.asModel|.asModel\<M\>()}
-     * immediately after the .table() call to provide the types, where `M` is an
-     * type like `{ column1: type1, column2: type2, ... }`.
-     *
-     * Example:
-     * ```
-     * const rizzolver = KyselyRizzolver.builder()
-     *     .table('user', ['id', 'name', 'email'] as const)
-     *     .asModel<{id: number, name: string, email: string}>()
-     *     .table('post', ['id', 'title', 'content', 'authorId'] as const)
-     *     .asModel<{id: number, title: string, content: string, authorId: number}>()
-     *     .build();
-     * ```
-     *
-     * p.s. if your .table() and .asModel() columns differ, it will let you know
-     * at compile time ;)
-     *
-     * Once all tables have been added, call
-     * {@link KyselyRizzolverBuilderNoSchema.build|.build()} to get a new
-     * {@link KyselyRizzolver} instance.
-     */
-    static builderNoSchema(): KyselyRizzolverBuilderNoSchema<{}, null>;
+    static builder<DB>(): import("./kysely-rizzolver-builder.js").KyselyRizzolverBuilder<DB, {}, 3>;
 }
-export type KyselyRizzolverBuilderForSchema<DB, T extends Partial<Record<keyof DB & string, readonly string[]>>> = {
-    table<K extends Exclude<keyof DB & string, keyof T>, U extends readonly (keyof DB[K])[]>(name: K, fields: U & ([keyof DB[K]] extends [U[number]] ? unknown : `Missing key: ${Exclude<keyof DB[K] & string, U[number]>}`)): KyselyRizzolverBuilderForSchema<DB, T & {
-        [key in K]: U;
-    }>;
-    build(): T extends Record<keyof DB & string, readonly string[]> ? KyselyRizzolver<DB, T> : never;
-};
-export type KyselyRizzolverBuilderNoSchema<T extends Record<string, {
-    model: any;
-    columns: readonly string[];
-}>, Last extends keyof T | null> = {
-    table<K extends string, U extends readonly string[]>(name: K, fields: U): KyselyRizzolverBuilderNoSchema<T & {
-        [k in K]: {
-            model: Record<U[number], unknown>;
-            columns: U;
-        };
-    }, K>;
-    asModel<M>(): Last extends keyof T ? keyof M extends T[Last]['columns'][number] ? T[Last]['columns'][number] extends keyof M ? KyselyRizzolverBuilderNoSchema<T & {
-        [k in Last]: {
-            model: M;
-            columns: T[k]['columns'];
+/**
+ * The shape of the foreign key definitions on a {@link KyselyRizzolverBase}.
+ */
+export type KyselyRizzolverFKs<DB> = {
+    [table in keyof DB & string]?: {
+        [fkName: string]: {
+            myField: string;
+            otherTable: keyof DB & string;
+            otherField: string;
+            isNullable: boolean;
         };
-    }, never> : `column '${Exclude<T[Last]['columns'][number], keyof M & string>}' defined in table() but missing from asModel()` : `column '${Exclude<keyof M & string, T[Last]['columns'][number]>}' defined in asModel() but missing from table()` : `asModel() must be called after table()`;
-    build(): KyselyRizzolver<{
-        [k in keyof T]: T[k]['model'];
-    }, {
-        [k in keyof T]: T[k]['columns'];
-    }>;
+    };
 };
-export type KyDB<KY extends KyselyRizzolverBase<any, any>> = KY extends KyselyRizzolverBase<infer DB, any> ? DB : never;
-export type TableName<T extends KyselyRizzolverBase<any, any>> = keyof KyDB<T> & string;
+/**
+ * Extracts the `DB` type from a {@link KyselyRizzolverBase}.
+ */
+export type KyDB<KY extends KyselyRizzolverBase<any, any, any>> = KY extends KyselyRizzolverBase<infer DB, any, any> ? DB : never;
+/**
+ * Variant of {@link TableName} that takes a {@link KyselyRizzolverBase} instead
+ * of a `DB` type.
+ */
+export type KyTableName<T extends KyselyRizzolverBase<any, any, any>> = keyof KyDB<T> & string;
+/**
+ * Variant of {@link AnyTableField} that takes a {@link KyselyRizzolverBase}
+ * instead of a `DB` type.
+ */
+export type KyAnyTableField<KY extends KyselyRizzolverBase<any, any, any>, Table extends KyTableName<KY>> = keyof KyDB<KY>[Table] & string;
+/**
+ * Variant of {@link AllTableFields} that takes a {@link KyselyRizzolverBase}
+ * instead of a `DB` type.
+ */
+export type KyAllTableFields<KY extends KyselyRizzolverBase<any, any, any>, Table extends KyTableName<KY>> = KY extends KyselyRizzolverBase<any, infer T, any> ? T[Table] extends infer U ? U extends readonly KyAnyTableField<KY, Table>[] ? U : never : never : never;
+/**
+ * A union of all the known table names of a database.
+ */
+export type TableName<DB> = keyof DB & string;
 /**
  * A union of all the known fields of a table.
  */
-export type AnyTableField<KY extends KyselyRizzolverBase<any, any>, Table extends TableName<KY>> = keyof KyDB<KY>[Table] & string;
+export type AnyTableField<DB, Table extends TableName<DB>> = keyof DB[Table] & string;
 /**
  * An array of all the known fields of a table, in a type that is compatible
  * with that table's ${@link Selectable} type.
  */
-export type AllTableFields<KY extends KyselyRizzolverBase<any, any>, Table extends TableName<KY>> = KY extends KyselyRizzolverBase<any, infer T> ? T[Table] extends infer U ? U extends readonly AnyTableField<KY, Table>[] ? U : never : never : never;
+export type AllTableFields<DB, Table extends TableName<DB>> = AnyTableField<DB, Table>[];