bigal 14.0.87 → 14.1.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [14.1.0](https://github.com/bigalorm/bigal/compare/v14.0.87...v14.1.0) (2025-12-02)
+
+### Features
+
+- Add select as a return on FindResult and FindOneResult ([#223](https://github.com/bigalorm/bigal/issues/223)) ([7fa0e60](https://github.com/bigalorm/bigal/commit/7fa0e6047a53bbb901677246e3b31acdd41be636))
+
 ## [14.0.87](https://github.com/bigalorm/bigal/compare/v14.0.86...v14.0.87) (2025-11-30)
 
 ## [14.0.86](https://github.com/bigalorm/bigal/compare/v14.0.85...v14.0.86) (2025-11-29)

package/dist/index.cjs

@@ -1385,6 +1385,15 @@ class ReadonlyRepository {
     const sorts = sort ? this._convertSortsToOrderBy(sort) : [];
     const modelInstance = this;
     return {
+      /**
+       * Columns to select from the entity
+       * @param {string[]} keys - Columns to select from the entity
+       * @returns Query instance
+       */
+      select(keys) {
+        select = new Set(keys);
+        return this;
+      },
       /**
        * Filters the query
        * @param {object} value - Object representing the where query
@@ -1545,6 +1554,15 @@ ${stack ?? ""}`;
     const sorts = sort ? this._convertSortsToOrderBy(sort) : [];
     const modelInstance = this;
     return {
+      /**
+       * Columns to select from the entity
+       * @param {string[]} keys - Columns to select from the entity
+       * @returns Query instance
+       */
+      select(keys) {
+        select = new Set(keys);
+        return this;
+      },
       /**
        * Filters the query
        * @param {object} value - Object representing the where query

package/dist/index.d.cts

@@ -480,6 +480,7 @@ interface PopulateArgs<T extends Entity, K extends keyof T> {
 }
 
 interface FindOneResult<T extends Entity, TReturn> extends PromiseLike<TReturn | null> {
+    select<TKeys extends string & keyof T>(keys: TKeys[]): FindOneResult<T, Pick<T, TKeys>>;
     where(args: WhereQuery<T>): FindOneResult<T, TReturn>;
     populate<TProperty extends string & keyof PickByValueType<T, Entity> & keyof T, TPopulateType extends GetValueType<T[TProperty], Entity>, TPopulateSelectKeys extends string & keyof TPopulateType>(propertyName: TProperty, options?: PopulateArgs<TPopulateType, TPopulateSelectKeys>): FindOneResult<T, Omit<TReturn, TProperty> & Populated<T, TProperty, TPopulateType, TPopulateSelectKeys>>;
     sort(value?: Sort<T>): FindOneResult<T, TReturn>;
@@ -493,6 +494,7 @@ interface PaginateOptions {
 }
 
 interface FindResult<T extends Entity, TReturn> extends PromiseLike<TReturn[]> {
+    select<TKeys extends string & keyof T>(keys: TKeys[]): FindResult<T, Pick<T, TKeys>>;
     where(args: WhereQuery<T>): FindResult<T, TReturn>;
     populate<TProperty extends string & keyof PickByValueType<T, Entity> & keyof T, TPopulateType extends GetValueType<T[TProperty], Entity>, TPopulateSelectKeys extends string & keyof TPopulateType>(propertyName: TProperty, options?: PopulateArgs<TPopulateType, TPopulateSelectKeys>): FindResult<T, Omit<TReturn, TProperty> & Populated<T, TProperty, TPopulateType, TPopulateSelectKeys>>;
     sort(value?: Sort<T>): FindResult<T, TReturn>;

package/dist/index.d.mts

@@ -480,6 +480,7 @@ interface PopulateArgs<T extends Entity, K extends keyof T> {
 }
 
 interface FindOneResult<T extends Entity, TReturn> extends PromiseLike<TReturn | null> {
+    select<TKeys extends string & keyof T>(keys: TKeys[]): FindOneResult<T, Pick<T, TKeys>>;
     where(args: WhereQuery<T>): FindOneResult<T, TReturn>;
     populate<TProperty extends string & keyof PickByValueType<T, Entity> & keyof T, TPopulateType extends GetValueType<T[TProperty], Entity>, TPopulateSelectKeys extends string & keyof TPopulateType>(propertyName: TProperty, options?: PopulateArgs<TPopulateType, TPopulateSelectKeys>): FindOneResult<T, Omit<TReturn, TProperty> & Populated<T, TProperty, TPopulateType, TPopulateSelectKeys>>;
     sort(value?: Sort<T>): FindOneResult<T, TReturn>;
@@ -493,6 +494,7 @@ interface PaginateOptions {
 }
 
 interface FindResult<T extends Entity, TReturn> extends PromiseLike<TReturn[]> {
+    select<TKeys extends string & keyof T>(keys: TKeys[]): FindResult<T, Pick<T, TKeys>>;
     where(args: WhereQuery<T>): FindResult<T, TReturn>;
     populate<TProperty extends string & keyof PickByValueType<T, Entity> & keyof T, TPopulateType extends GetValueType<T[TProperty], Entity>, TPopulateSelectKeys extends string & keyof TPopulateType>(propertyName: TProperty, options?: PopulateArgs<TPopulateType, TPopulateSelectKeys>): FindResult<T, Omit<TReturn, TProperty> & Populated<T, TProperty, TPopulateType, TPopulateSelectKeys>>;
     sort(value?: Sort<T>): FindResult<T, TReturn>;

package/dist/index.d.ts

@@ -480,6 +480,7 @@ interface PopulateArgs<T extends Entity, K extends keyof T> {
 }
 
 interface FindOneResult<T extends Entity, TReturn> extends PromiseLike<TReturn | null> {
+    select<TKeys extends string & keyof T>(keys: TKeys[]): FindOneResult<T, Pick<T, TKeys>>;
     where(args: WhereQuery<T>): FindOneResult<T, TReturn>;
     populate<TProperty extends string & keyof PickByValueType<T, Entity> & keyof T, TPopulateType extends GetValueType<T[TProperty], Entity>, TPopulateSelectKeys extends string & keyof TPopulateType>(propertyName: TProperty, options?: PopulateArgs<TPopulateType, TPopulateSelectKeys>): FindOneResult<T, Omit<TReturn, TProperty> & Populated<T, TProperty, TPopulateType, TPopulateSelectKeys>>;
     sort(value?: Sort<T>): FindOneResult<T, TReturn>;
@@ -493,6 +494,7 @@ interface PaginateOptions {
 }
 
 interface FindResult<T extends Entity, TReturn> extends PromiseLike<TReturn[]> {
+    select<TKeys extends string & keyof T>(keys: TKeys[]): FindResult<T, Pick<T, TKeys>>;
     where(args: WhereQuery<T>): FindResult<T, TReturn>;
     populate<TProperty extends string & keyof PickByValueType<T, Entity> & keyof T, TPopulateType extends GetValueType<T[TProperty], Entity>, TPopulateSelectKeys extends string & keyof TPopulateType>(propertyName: TProperty, options?: PopulateArgs<TPopulateType, TPopulateSelectKeys>): FindResult<T, Omit<TReturn, TProperty> & Populated<T, TProperty, TPopulateType, TPopulateSelectKeys>>;
     sort(value?: Sort<T>): FindResult<T, TReturn>;

package/dist/index.mjs

@@ -1379,6 +1379,15 @@ class ReadonlyRepository {
     const sorts = sort ? this._convertSortsToOrderBy(sort) : [];
     const modelInstance = this;
     return {
+      /**
+       * Columns to select from the entity
+       * @param {string[]} keys - Columns to select from the entity
+       * @returns Query instance
+       */
+      select(keys) {
+        select = new Set(keys);
+        return this;
+      },
       /**
        * Filters the query
        * @param {object} value - Object representing the where query
@@ -1539,6 +1548,15 @@ ${stack ?? ""}`;
     const sorts = sort ? this._convertSortsToOrderBy(sort) : [];
     const modelInstance = this;
     return {
+      /**
+       * Columns to select from the entity
+       * @param {string[]} keys - Columns to select from the entity
+       * @returns Query instance
+       */
+      select(keys) {
+        select = new Set(keys);
+        return this;
+      },
       /**
        * Filters the query
        * @param {object} value - Object representing the where query

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bigal",
-  "version": "14.0.87",
+  "version": "14.1.0",
   "description": "A fast and lightweight orm for postgres and node.js, written in typescript.",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",