kysely-hydrate 0.4.0 → 0.4.2

package/dist/index.d.mts

@@ -127,20 +127,6 @@ type HydratorArg<Input, Output> = MappedHydrator<Input, Output> | HydratorFactor
  * The input type is automatically prefixed based on the parent's prefix.
  */
 type ChildHydratorArg<P extends string, ParentInput, ChildOutput> = MappedHydrator<SelectAndStripPrefix<P, ParentInput>, ChildOutput> | ((create: CreateHydratorFn<SelectAndStripPrefix<P, ParentInput>>) => MappedHydrator<SelectAndStripPrefix<P, ParentInput>, ChildOutput>);
-/**
- * Ensures fields are included in the Hydrator's output if they don't already
- * have an explicit configuration (including explicit omission).
- *
- * This is used internally by `HydratedQueryBuilder` to auto-detect selected
- * fields without overwriting explicit field mappings or omissions from
- * `mapFields()` and `omit()`.
- *
- * @param hydrator - The Hydrator instance
- * @param fieldNames - Field names to ensure are included
- * @returns A new Hydrator with the fields ensured
- * @internal
- */
-
 declare const IsFullHydrator: unique symbol;
 /**
  * A configuration for how to hydrate flat database rows into a denormalized structure.
@@ -1042,13 +1028,6 @@ declare class UnsupportedTableAliasNodeTypeError extends KyselyHydrateError {
 declare class UnsupportedNodeTypeError extends KyselyHydrateError {
   constructor(kind: string);
 }
-/**
- * Error thrown when attempting to call a private method on an instance that
- * was not properly registered with the private accessor.
- */
-declare class InvalidInstanceError extends KyselyHydrateError {
-  constructor();
-}
 /**
  * Error thrown when attempting to extend a Hydrator with another Hydrator
  * that has a different keyBy configuration.
@@ -1057,4 +1036,4 @@ declare class KeyByMismatchError extends KyselyHydrateError {
   constructor(thisKeyBy: string, otherKeyBy: string);
 }
 //#endregion
-export { AmbiguousColumnReferenceError, ExpectedOneItemError, HydratePlugin, type Hydrator, InvalidInstanceError, KeyByMismatchError, KyselyHydrateError, UnexpectedCaseError, UnexpectedComplexAliasError, UnexpectedSelectAllError, UnexpectedSelectionTypeError, UnsupportedAliasNodeTypeError, UnsupportedNodeTypeError, UnsupportedTableAliasNodeTypeError, WildcardSelectionError, createHydrator, hydrate, hydrateData, isFullHydrator, map };
+export { AmbiguousColumnReferenceError, ExpectedOneItemError, HydratePlugin, type Hydrator, KeyByMismatchError, KyselyHydrateError, UnexpectedCaseError, UnexpectedComplexAliasError, UnexpectedSelectAllError, UnexpectedSelectionTypeError, UnsupportedAliasNodeTypeError, UnsupportedNodeTypeError, UnsupportedTableAliasNodeTypeError, WildcardSelectionError, createHydrator, hydrate, hydrateData, isFullHydrator, map };

package/dist/index.mjs

@@ -70,15 +70,6 @@ var UnsupportedNodeTypeError = class extends KyselyHydrateError {
 	}
 };
 /**
-* Error thrown when attempting to call a private method on an instance that
-* was not properly registered with the private accessor.
-*/
-var InvalidInstanceError = class extends KyselyHydrateError {
-	constructor() {
-		super("Invalid instance - private method not registered");
-	}
-};
-/**
 * Error thrown when attempting to extend a Hydrator with another Hydrator
 * that has a different keyBy configuration.
 */
@@ -103,12 +94,6 @@ function makePrefix(prefix, key) {
 	return `${prefix}${key}${SEP}`;
 }
 /**
-* Indicates whether a string has any prefixes from `makePrefix`applied to it.
-*/
-function hasAnyPrefix(string) {
-	return string.includes(SEP);
-}
-/**
 * Applies a prefix to a key.
 *
 * ```ts
@@ -171,49 +156,6 @@ function addObjectToMap(map$1, obj) {
 	}
 	return clone;
 }
-/**
-* Creates a pair of functions for accessing private instance methods from outside the class.
-* Uses a WeakMap to store bound methods, ensuring proper memory cleanup.
-*
-* @returns An object with `call` and `register` functions
-*   - call: Calls the private method on an instance
-*   - register: Registers a private method for an instance (call in constructor)
-*
-* @example
-* ```ts
-* const privateAccessor = createPrivateAccessor<
-*   MyClass,
-*   [arg1: string, arg2: number],
-*   ReturnType
-* >();
-*
-* class MyClass {
-*   constructor() {
-*     privateAccessor.register(this, this.#privateMethod.bind(this));
-*   }
-*   #privateMethod(arg1: string, arg2: number): ReturnType { ... }
-* }
-*
-* // External usage with proper JSDoc:
-* \/**
-*  * Documentation here
-*  *\/
-* export const callPrivateMethod = privateAccessor.call;
-* ```
-*/
-function createPrivateAccessor() {
-	const registry = /* @__PURE__ */ new WeakMap();
-	return {
-		register: (instance, method) => {
-			registry.set(instance, method);
-		},
-		call: (instance, ...args) => {
-			const method = registry.get(instance);
-			if (!method) throw new InvalidInstanceError();
-			return method(...args);
-		}
-	};
-}
 
 //#endregion
 //#region src/hydrator.ts
@@ -222,24 +164,6 @@ function createPrivateAccessor() {
 * Only used when the input type has an "id" property.
 */
 const DEFAULT_KEY_BY = "id";
-/**
-* Private accessor for the ensureFields method.
-*/
-const ensureFieldsAccessor = createPrivateAccessor();
-/**
-* Ensures fields are included in the Hydrator's output if they don't already
-* have an explicit configuration (including explicit omission).
-*
-* This is used internally by `HydratedQueryBuilder` to auto-detect selected
-* fields without overwriting explicit field mappings or omissions from
-* `mapFields()` and `omit()`.
-*
-* @param hydrator - The Hydrator instance
-* @param fieldNames - Field names to ensure are included
-* @returns A new Hydrator with the fields ensured
-* @internal
-*/
-const ensureFields = ensureFieldsAccessor.call;
 const IsFullHydrator = Symbol("HydratorType");
 /**
 * Determines if a hydrator is a full hydrator, meaning it has not had a .map()
@@ -261,13 +185,16 @@ const asFullHydrator = (hydrator) => {
 	throw new Error("Hydrator is not a full hydrator");
 };
 /**
+* Special constant to enable auto-inclusion of fields at each level.
+*/
+const EnableAutoInclusion = Symbol();
+/**
 * Implements the entire inheritance chain of Hydrators.
 */
 var HydratorImpl = class HydratorImpl {
 	#props;
 	constructor(props) {
 		this.#props = props;
-		ensureFieldsAccessor.register(this, this.#ensureFields.bind(this));
 	}
 	get [IsFullHydrator]() {
 		return !this.#props.mapFns?.length;
@@ -285,14 +212,6 @@ var HydratorImpl = class HydratorImpl {
 			fields: addObjectToMap(this.#props.fields, omitFields)
 		});
 	}
-	#ensureFields(fieldNames) {
-		const clone = new Map(this.#props.fields);
-		for (const name of fieldNames) if (!clone.has(name)) clone.set(name, true);
-		return new HydratorImpl({
-			...this.#props,
-			fields: clone
-		});
-	}
 	extras(extras) {
 		return new HydratorImpl({
 			...this.#props,
@@ -367,7 +286,7 @@ var HydratorImpl = class HydratorImpl {
 	*
 	* Writes directly to the provided attachedDataMap and fetchPromises array.
 	*/
-	#fetchAllAttachedCollections(prefix, inputs, attachedDataMap, fetchPromises) {
+	#fetchAllAttachedCollections(ctx, prefix, inputs, fetchPromises) {
 		const { attachedCollections, collections } = this.#props;
 		if (attachedCollections) {
 			let inputArray;
@@ -380,21 +299,45 @@ var HydratorImpl = class HydratorImpl {
 				const mapKey = prefix ? applyPrefix(prefix, key) : key;
 				fetchPromises.push(Promise.resolve(attachedCollection.fetchFn(inputArray)).then((attachedOutputs) => {
 					const grouped = groupByKey("", attachedOutputs, attachedCollection.matchChild);
-					attachedDataMap.set(mapKey, grouped);
+					ctx.attachedDataMap.set(mapKey, grouped);
 				}));
 			}
 		}
 		if (collections) for (const collection of collections.values()) {
 			const childPrefix = applyPrefix(prefix, collection.prefix);
-			collection.hydrator.#fetchAllAttachedCollections(childPrefix, inputs, attachedDataMap, fetchPromises);
+			collection.hydrator.#fetchAllAttachedCollections(ctx, childPrefix, inputs, fetchPromises);
+		}
+	}
+	/**
+	* Gets all the fields belonging to the current prefix level; not to the
+	* parent, and not to any nested collection.  Does this once per hydration
+	* (assumes all inputs have the same keys).
+	*/
+	#getAutoFields(ctx, prefix, input) {
+		const cached = ctx.autoFieldsCache.get(prefix);
+		if (cached) return cached;
+		if (typeof input !== "object" || input === null) return [];
+		const { fields, extras, collections } = this.#props;
+		const nestedPrefixes = [];
+		if (collections) for (const collection of collections.values()) nestedPrefixes.push(applyPrefix(prefix, collection.prefix));
+		const autoFields = [];
+		for (const inputKey of Object.keys(input)) {
+			if (!hasPrefix(prefix, inputKey)) continue;
+			if (nestedPrefixes.some((nestedPrefix) => hasPrefix(nestedPrefix, inputKey))) continue;
+			const unprefixedKey = removePrefix(prefix, inputKey);
+			if (fields?.has(unprefixedKey) || extras?.has(unprefixedKey)) continue;
+			autoFields.push(unprefixedKey);
 		}
+		ctx.autoFieldsCache.set(prefix, autoFields);
+		return autoFields;
 	}
 	/**
 	* Hydrates a single entity. All attach collections are already fetched and provided in attachedDataMap.
 	*/
-	#hydrateOne(prefix, attachedDataMap, input, inputRows) {
+	#hydrateOne(ctx, prefix, input, inputRows) {
 		const { fields, extras, collections, attachedCollections } = this.#props;
 		const entity = {};
+		if (ctx.autoIncludeFields) for (const key of this.#getAutoFields(ctx, prefix, input)) entity[key] = getPrefixedValue(prefix, input, key);
 		if (fields) for (const [key, field] of fields) {
 			if (field === false) continue;
 			const value = getPrefixedValue(prefix, input, key);
@@ -406,12 +349,12 @@ var HydratorImpl = class HydratorImpl {
 		}
 		if (collections) for (const [key, collection] of collections) {
 			const childPrefix = applyPrefix(prefix, collection.prefix);
-			entity[key] = applyCollectionMode(collection.hydrator.#hydrateMany(childPrefix, inputRows, attachedDataMap), collection.mode, key);
+			entity[key] = applyCollectionMode(collection.hydrator.#hydrateMany(ctx, childPrefix, inputRows), collection.mode, key);
 		}
 		if (attachedCollections) for (const [key, collection] of attachedCollections) {
 			const inputKey = getKey(prefix, input, collection.toParent);
 			const mapKey = prefix ? applyPrefix(prefix, key) : key;
-			const attachedRows = attachedDataMap.get(mapKey)?.get(inputKey);
+			const attachedRows = ctx.attachedDataMap.get(mapKey)?.get(inputKey);
 			entity[key] = applyCollectionMode(attachedRows, collection.mode, key);
 		}
 		const { mapFns } = this.#props;
@@ -425,13 +368,13 @@ var HydratorImpl = class HydratorImpl {
 	/**
 	* Hydrates many entities. All attach collections are already fetched and provided in attachedDataMap.
 	*/
-	#hydrateMany(prefix, inputs, attachedDataMap) {
+	#hydrateMany(ctx, prefix, inputs) {
 		const { keyBy, collections } = this.#props;
 		const result = [];
 		if (!collections) {
 			for (const input of inputs) {
 				if (isKeyNil(getKey(prefix, input, keyBy))) continue;
-				const entity = this.#hydrateOne(prefix, attachedDataMap, input, [input]);
+				const entity = this.#hydrateOne(ctx, prefix, input, [input]);
 				result.push(entity);
 			}
 			return result;
@@ -439,18 +382,22 @@ var HydratorImpl = class HydratorImpl {
 		const grouped = groupByKey(prefix, inputs, keyBy);
 		for (const groupRows of grouped.values()) {
 			const firstRow = groupRows[0];
-			const entity = this.#hydrateOne(prefix, attachedDataMap, firstRow, groupRows);
+			const entity = this.#hydrateOne(ctx, prefix, firstRow, groupRows);
 			result.push(entity);
 		}
 		return result;
 	}
-	hydrate(input) {
-		const attachedDataMap = /* @__PURE__ */ new Map();
+	hydrate(input, autoIncludeFields) {
+		const ctx = {
+			autoIncludeFields: autoIncludeFields === EnableAutoInclusion,
+			attachedDataMap: /* @__PURE__ */ new Map(),
+			autoFieldsCache: /* @__PURE__ */ new Map()
+		};
 		const fetchPromises = [];
-		this.#fetchAllAttachedCollections("", isIterable(input) ? input : [input], attachedDataMap, fetchPromises);
+		this.#fetchAllAttachedCollections(ctx, "", isIterable(input) ? input : [input], fetchPromises);
 		const hydrateWithData = () => {
-			if (isIterable(input)) return this.#hydrateMany("", input, attachedDataMap);
-			return this.#hydrateOne("", attachedDataMap, input, [input]);
+			if (isIterable(input)) return this.#hydrateMany(ctx, "", input);
+			return this.#hydrateOne(ctx, "", input, [input]);
 		};
 		return fetchPromises.length > 0 ? Promise.all(fetchPromises).then(hydrateWithData) : Promise.resolve(hydrateWithData());
 	}
@@ -647,23 +594,20 @@ var HydratedQueryBuilderImpl = class HydratedQueryBuilderImpl {
 		return new AliasedHydratedQueryBuilder(alias, this);
 	}
 	#hydrate(rows) {
-		const isArray = Array.isArray(rows);
-		const firstRow = isArray ? rows[0] : rows;
-		if (!firstRow) return isArray ? [] : void 0;
-		const fieldNames = Object.keys(firstRow).filter((key) => !hasAnyPrefix(key));
-		return ensureFields(this.#props.hydrator, fieldNames).hydrate(rows);
+		return this.#props.hydrator.hydrate(rows, EnableAutoInclusion);
 	}
 	async execute() {
 		const rows = await this.#props.qb.execute();
 		return this.#hydrate(rows);
 	}
 	async executeTakeFirst() {
-		const result = await this.#props.qb.executeTakeFirst();
-		return result ? this.#hydrate(result) : void 0;
+		const [result] = await this.execute();
+		return result;
 	}
 	async executeTakeFirstOrThrow(errorConstructor = k.NoResultError) {
-		const result = await this.#props.qb.executeTakeFirstOrThrow(errorConstructor);
-		return this.#hydrate(result);
+		const result = await this.executeTakeFirst();
+		if (result === void 0) throw k.isNoResultErrorConstructor(errorConstructor) ? new errorConstructor(this.toOperationNode()) : errorConstructor(this.toOperationNode());
+		return result;
 	}
 	extras(extras) {
 		return new HydratedQueryBuilderImpl({
@@ -729,8 +673,7 @@ var HydratedQueryBuilderImpl = class HydratedQueryBuilderImpl {
 		const prefixedSelections = prefixSelectArg(this.#props.prefix, selection);
 		return new HydratedQueryBuilderImpl({
 			...this.#props,
-			qb: this.#props.qb.select(prefixedSelections),
-			hydrator: asFullHydrator(this.#props.hydrator).fields(prefixedSelections.map((selection$1) => selection$1.originalName))
+			qb: this.#props.qb.select(prefixedSelections)
 		});
 	}
 	#join(method, from, ...args) {
@@ -748,8 +691,7 @@ var HydratedQueryBuilderImpl = class HydratedQueryBuilderImpl {
 		let newQb = this.#props.qb;
 		newQb = newQb[method](aliasedQb, ...args);
 		newQb = newQb.select(hoistedSelections);
-		let newHydrator = asFullHydrator(this.#props.hydrator).extend(nestedHydrator);
-		newHydrator = ensureFields(newHydrator, hoistedSelections.map((selection) => selection.originalName).filter((name) => !hasAnyPrefix(name)));
+		const newHydrator = asFullHydrator(this.#props.hydrator).extend(nestedHydrator);
 		return new HydratedQueryBuilderImpl({
 			...this.#props,
 			qb: newQb,
@@ -1175,4 +1117,4 @@ var HydratePlugin = class {
 };
 
 //#endregion
-export { AmbiguousColumnReferenceError, ExpectedOneItemError, HydratePlugin, InvalidInstanceError, KeyByMismatchError, KyselyHydrateError, UnexpectedCaseError, UnexpectedComplexAliasError, UnexpectedSelectAllError, UnexpectedSelectionTypeError, UnsupportedAliasNodeTypeError, UnsupportedNodeTypeError, UnsupportedTableAliasNodeTypeError, WildcardSelectionError, createHydrator, hydrate, hydrateData, isFullHydrator, map };
+export { AmbiguousColumnReferenceError, ExpectedOneItemError, HydratePlugin, KeyByMismatchError, KyselyHydrateError, UnexpectedCaseError, UnexpectedComplexAliasError, UnexpectedSelectAllError, UnexpectedSelectionTypeError, UnsupportedAliasNodeTypeError, UnsupportedNodeTypeError, UnsupportedTableAliasNodeTypeError, WildcardSelectionError, createHydrator, hydrate, hydrateData, isFullHydrator, map };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely-hydrate",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Explicit ORM-style queries with Kysely",
   "license": "MIT",
   "author": {