bigal 13.0.6 → 13.0.8

package/CONTRIBUTING.md

@@ -1,22 +1,25 @@
-# Contributors
+# Contributing Guidelines
 
-## Checkin
+## Pull Request Format
 
-- Do checkin source (src)
-- Do not checkin build output (dist)
-- Do not checkin node_modules
+The title of your PR should match the following format:
 
-## Development
+```text
+<type>: <short description>
+```
 
-In order to handle code style and static analysis, we run [Husky](https://github.com/typicode/husky) before each commit.
-This step ensures that formatting and checkin rules are followed. To make sure Husky runs correctly, please use the
-following workflow:
+### Types
 
-```sh
-npm install                                 # installs all devDependencies including Husky
-git add abc.ext                             # Add the files you've changed. This should include files in src, lib, and node_modules (see above)
-git commit -m "Informative commit message"  # Commit. This will run Husky
-```
+- **docs** - Documentation changes only
+- **feat** - Any new functionality additions
+- **fix** - Bugfixes that don't add new functionality
+- **test** - Test changes only
+- **chore** - Anything else
+
+Within the body of your PR, make sure you reference the issue that you have worked on, as well as pointing out anything
+of note you wish us to look at during our review.
+
+### Commits
 
-During the commit step, Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier).
-It will also make sure these changes are appropriately included in your commit (no further work is needed)
+We do not care about the number, or style of commits in your history, because we squash merge every PR into main.
+Feel free to commit in whatever style you feel comfortable with.

package/dist/index.cjs

@@ -92,6 +92,7 @@ class ColumnCollectionMetadata extends ColumnBaseMetadata {
   _throughFn;
   /**
    * Type of the items in the collection
+   * @returns Name of collection
    */
   get collection() {
     if (this._collectionString) {
@@ -109,6 +110,7 @@ class ColumnCollectionMetadata extends ColumnBaseMetadata {
   via;
   /**
    * Name of the junction table for multi-multi associations
+   * @returns Name of junction table
    */
   get through() {
     if (this._throughString) {
@@ -118,7 +120,7 @@ class ColumnCollectionMetadata extends ColumnBaseMetadata {
       this._throughString = this._throughFn();
       return this._throughString;
     }
-    return undefined;
+    return void 0;
   }
   constructor({
     target,
@@ -167,6 +169,7 @@ class ColumnModelMetadata extends ColumnBaseMetadata {
   _modelFn;
   /**
    * Name of the model represented by this column id
+   * @returns Name of model
    */
   get model() {
     if (this._modelString) {
@@ -1331,6 +1334,7 @@ class ReadonlyRepository {
    * @param {string[]} [args.select] - Array of model property names to return from the query.
    * @param {object} [args.where] - Object representing the where query
    * @param {string|object} [args.sort] - Property name(s) to sort by
+   * @returns Database record or null
    */
   findOne(args = {}) {
     const { stack } = new Error(`${this.model.name}.findOne()`);
@@ -1356,7 +1360,7 @@ class ReadonlyRepository {
           poolOverride = value;
           break;
         default:
-          select = undefined;
+          select = void 0;
           where = args;
           sort = null;
           isWhereCriteria = true;
@@ -1374,6 +1378,7 @@ class ReadonlyRepository {
       /**
        * Filters the query
        * @param {object} value - Object representing the where query
+       * @returns Query instance
        */
       where(value) {
         where = value;
@@ -1388,6 +1393,7 @@ class ReadonlyRepository {
        * @param {string|object} [options.sort] - Property name(s) to sort by
        * @param {string|number} [options.skip] - Number of records to skip
        * @param {string|number} [options.limit] - Number of results to return
+       * @returns Query instance
        */
       populate(propertyName, options) {
         if (select && !select.has(propertyName)) {
@@ -1411,6 +1417,7 @@ class ReadonlyRepository {
       /**
        * Sorts the query
        * @param {string|object} [value]
+       * @returns Query instance
        */
       sort(value) {
         if (value) {
@@ -1478,6 +1485,7 @@ ${stack ?? ""}`;
    * @param {string|object} [args.sort] - Property name(s) to sort by
    * @param {string|number} [args.skip] - Number of records to skip
    * @param {string|number} [args.limit] - Number of results to return
+   * @returns Database records
    */
   find(args = {}) {
     const { stack } = new Error(`${this.model.name}.find()`);
@@ -1511,7 +1519,7 @@ ${stack ?? ""}`;
           poolOverride = value;
           break;
         default:
-          select = undefined;
+          select = void 0;
           where = args;
           sort = null;
           skip = null;
@@ -1530,6 +1538,7 @@ ${stack ?? ""}`;
       /**
        * Filters the query
        * @param {object} value - Object representing the where query
+       * @returns Query instance
        */
       where(value) {
         where = value;
@@ -1544,6 +1553,7 @@ ${stack ?? ""}`;
        * @param {string|object} [options.sort] - Property name(s) to sort by
        * @param {string|number} [options.skip] - Number of records to skip
        * @param {string|number} [options.limit] - Number of results to return
+       * @returns Query instance
        */
       populate(propertyName, options) {
         if (select && !select.has(propertyName)) {
@@ -1567,6 +1577,7 @@ ${stack ?? ""}`;
       /**
        * Sorts the query
        * @param {string|string[]|object} [value]
+       * @returns Query instance
        */
       sort(value) {
         if (value) {
@@ -1577,6 +1588,7 @@ ${stack ?? ""}`;
       /**
        * Limits results returned by the query
        * @param {number} value
+       * @returns Query instance
        */
       limit(value) {
         limit = value;
@@ -1585,6 +1597,7 @@ ${stack ?? ""}`;
       /**
        * Skips records returned by the query
        * @param {number} value
+       * @returns Query instance
        */
       skip(value) {
         skip = value;
@@ -1596,8 +1609,9 @@ ${stack ?? ""}`;
       },
       /**
        * Pages records returned by the query
-       * @param {number} [page=1] - Page to return - Starts at 1
-       * @param {number} [limit=10] - Number of records to return
+       * @param {number} [page] - Page to return - Starts at 1
+       * @param {number} [limit] - Number of records to return
+       * @returns Query instance
        */
       paginate({ page = 1, limit: paginateLimit = 10 }) {
         const safePage = Math.max(page, 1);
@@ -1671,6 +1685,7 @@ ${stack ?? ""}`;
       /**
        * Filters the query
        * @param {object} value - Object representing the where query
+       * @returns Count result
        */
       where(value) {
         where = value;
@@ -1968,7 +1983,7 @@ class Repository extends ReadonlyRepository {
    * Creates an object using the specified values
    * @param {object|object[]} values - Values to insert as a new object. If an array is specified, multiple rows will be inserted
    * @param {object} [options]
-   * @param {boolean} [options.returnRecords=true] - Determines if inserted records should be returned
+   * @param {boolean} [options.returnRecords] - Determines if inserted records should be returned
    * @param {string[]} [options.returnSelect] - Array of model property names to return from the query.
    * @param {object} [options.onConflict] - Options to handle conflicts due to a unique constraint or exclusion constraint error during insert
    * @returns {object|object[]|void} Return value from the db
@@ -2015,14 +2030,14 @@ class Repository extends ReadonlyRepository {
       }
       throw new Error("Unknown error getting created rows back from the database");
     }
-    return undefined;
+    return void 0;
   }
   /**
    * Updates object(s) matching the where query, with the specified values
    * @param {object} where - Object representing the where query
    * @param {object} values - Values to update
    * @param {object} [options]
-   * @param {boolean} [options.returnRecords=true] - Determines if inserted records should be returned
+   * @param {boolean} [options.returnRecords] - Determines if inserted records should be returned
    * @param {string[]} [options.returnSelect] - Array of model property names to return from the query.
    * @returns {object[]|void} Return values from the db or `true` if returnRecords=false
    */
@@ -2057,13 +2072,13 @@ class Repository extends ReadonlyRepository {
     if (returnRecords) {
       return this._buildInstances(results.rows);
     }
-    return undefined;
+    return void 0;
   }
   /**
    * Destroys object(s) matching the where query
    * @param {object} where - Object representing the where query
    * @param {object} [options]
-   * @param {boolean} [options.returnRecords=false] - Determines if inserted records should be returned
+   * @param {boolean} [options.returnRecords] - Determines if inserted records should be returned
    * @param {string[]} [options.returnSelect] - Array of model property names to return from the query.
    * @returns {object[]|void} `void` or records affected if returnRecords=true
    */
@@ -2079,6 +2094,7 @@ class Repository extends ReadonlyRepository {
       /**
        * Filters the query
        * @param {object} value - Object representing the where query
+       * @returns Query instance
        */
       where(value) {
         where = value;
@@ -2119,21 +2135,15 @@ ${stack}`;
 
 function column(dbColumnNameOrOptions, options) {
   return function columnDecorator(object, propertyName) {
-    if (!dbColumnNameOrOptions) {
-      dbColumnNameOrOptions = ___default.snakeCase(propertyName);
-    }
+    dbColumnNameOrOptions ??= ___default.snakeCase(propertyName);
     let dbColumnName;
     if (typeof dbColumnNameOrOptions === "string") {
       dbColumnName = dbColumnNameOrOptions;
     } else {
       options = dbColumnNameOrOptions;
     }
-    if (!options) {
-      options = {};
-    }
-    if (!dbColumnName) {
-      dbColumnName = options.name ?? ___default.snakeCase(propertyName);
-    }
+    options ??= {};
+    dbColumnName ??= options.name ?? ___default.snakeCase(propertyName);
     const metadataStorage = getMetadataStorage();
     const columnCollectionOptions = options;
     if (columnCollectionOptions.collection || columnCollectionOptions.via) {
@@ -2192,12 +2202,8 @@ function createDateColumn(dbColumnNameOrOptions, options) {
       options = dbColumnNameOrOptions;
     }
     if (dbColumnNameOrOptions) {
-      if (!options) {
-        options = {};
-      }
-      if (!dbColumnName) {
-        dbColumnName = options.name ?? ___default.snakeCase(propertyName);
-      }
+      options ??= {};
+      dbColumnName ??= options.name ?? ___default.snakeCase(propertyName);
       metadataStorage.columns.push(
         new ColumnTypeMetadata({
           target: object.constructor.name,
@@ -2214,7 +2220,7 @@ function createDateColumn(dbColumnNameOrOptions, options) {
         name: dbColumnName ?? ___default.snakeCase(propertyName),
         propertyName,
         createDate: true,
-        required: options ? options.required : undefined,
+        required: options ? options.required : void 0,
         type: options ? options.type : "datetime"
       });
     }
@@ -2230,12 +2236,8 @@ function primaryColumn(dbColumnNameOrOptions, options) {
       options = dbColumnNameOrOptions;
     }
     if (dbColumnNameOrOptions) {
-      if (!options) {
-        options = {};
-      }
-      if (!dbColumnName) {
-        dbColumnName = options.name ?? ___default.snakeCase(propertyName);
-      }
+      options ??= {};
+      dbColumnName ??= options.name ?? ___default.snakeCase(propertyName);
       const { type } = options;
       const { model } = options;
       const metadataStorage = getMetadataStorage();
@@ -2269,9 +2271,9 @@ function primaryColumn(dbColumnNameOrOptions, options) {
         name: dbColumnName ?? ___default.snakeCase(propertyName),
         propertyName,
         primary: true,
-        required: options ? options.required : undefined,
-        type: options ? options.type : undefined,
-        model: options ? options.model : undefined
+        required: options ? options.required : void 0,
+        type: options ? options.type : void 0,
+        model: options ? options.model : void 0
       });
     }
   };
@@ -2286,12 +2288,8 @@ function table(dbNameOrTableOptions, options) {
     } else {
       options = dbNameOrTableOptions;
     }
-    if (!options) {
-      options = {};
-    }
-    if (!options.name) {
-      options.name = dbTableName ?? ___default.snakeCase(className);
-    }
+    options ??= {};
+    options.name ??= dbTableName ?? ___default.snakeCase(className);
     const metadataStorage = getMetadataStorage();
     const modelMetadata = new ModelMetadata({
       name: className,
@@ -2313,12 +2311,8 @@ function updateDateColumn(dbColumnNameOrOptions, options) {
       options = dbColumnNameOrOptions;
     }
     if (dbColumnNameOrOptions) {
-      if (!options) {
-        options = {};
-      }
-      if (!dbColumnName) {
-        dbColumnName = options.name ?? ___default.snakeCase(propertyName);
-      }
+      options ??= {};
+      dbColumnName ??= options.name ?? ___default.snakeCase(propertyName);
       const metadataStorage = getMetadataStorage();
       metadataStorage.columns.push(
         new ColumnTypeMetadata({
@@ -2337,7 +2331,7 @@ function updateDateColumn(dbColumnNameOrOptions, options) {
         name: dbColumnName ?? ___default.snakeCase(propertyName),
         propertyName,
         updateDate: true,
-        required: options ? options.required : undefined,
+        required: options ? options.required : void 0,
         type: options ? options.type : "datetime"
       });
     }
@@ -2353,12 +2347,8 @@ function versionColumn(dbColumnNameOrOptions, options) {
       options = dbColumnNameOrOptions;
     }
     if (dbColumnNameOrOptions) {
-      if (!options) {
-        options = {};
-      }
-      if (!dbColumnName) {
-        dbColumnName = options.name ?? ___default.snakeCase(propertyName);
-      }
+      options ??= {};
+      dbColumnName ??= options.name ?? ___default.snakeCase(propertyName);
       const metadataStorage = getMetadataStorage();
       metadataStorage.columns.push(
         new ColumnTypeMetadata({
@@ -2377,8 +2367,8 @@ function versionColumn(dbColumnNameOrOptions, options) {
         name: dbColumnName ?? ___default.snakeCase(propertyName),
         propertyName,
         version: true,
-        required: options ? options.required : undefined,
-        type: options ? options.type : undefined
+        required: options ? options.required : void 0,
+        type: options ? options.type : void 0
       });
     }
   };
@@ -2457,6 +2447,7 @@ function initialize({ models, pool, readonlyPool = pool, connections = {}, expos
       throw new Error(`Unable to find @table() on ${model.name}`);
     }
     modelMetadataByModelName[model.name] = new ModelMetadata({
+      // eslint-disable-next-line @typescript-eslint/no-misused-spread
       ...modelMetadata,
       name: model.name,
       type: model

package/dist/index.d.cts

@@ -223,6 +223,7 @@ declare class ColumnCollectionMetadata extends ColumnBaseMetadata {
     private _throughFn?;
     /**
      * Type of the items in the collection
+     * @returns Name of collection
      */
     get collection(): string;
     /**
@@ -231,6 +232,7 @@ declare class ColumnCollectionMetadata extends ColumnBaseMetadata {
     via: string;
     /**
      * Name of the junction table for multi-multi associations
+     * @returns Name of junction table
      */
     get through(): string | undefined;
     constructor({ target, //
@@ -248,6 +250,7 @@ declare class ColumnModelMetadata extends ColumnBaseMetadata {
     private _modelFn?;
     /**
      * Name of the model represented by this column id
+     * @returns Name of model
      */
     get model(): string;
     constructor({ target, //
@@ -439,7 +442,7 @@ interface DestroyResult<TEntity extends Entity, TReturn> extends PromiseLike<TRe
     where(args: WhereQuery<TEntity>): DestroyResult<TEntity, TReturn>;
 }
 
-type SortString<T extends Entity> = `${string & keyof OmitFunctions<OmitEntityCollections<T>>} ASC` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} asc` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} DESC` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} desc` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>}`;
+type SortString<T extends Entity> = `${string & keyof OmitFunctions<OmitEntityCollections<T>>} ASC` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} asc` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} DESC` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} desc` | (string & keyof OmitFunctions<OmitEntityCollections<T>>);
 type ValidateMultipleSorts<T extends Entity, TNextSortPart extends string, TPreviouslyValidatedSortString extends string, TSortString extends string> = TNextSortPart extends `, ${SortString<T>}${infer TRestSortPart}` ? TRestSortPart extends '' ? TSortString : ValidateMultipleSorts<T, TRestSortPart, TNextSortPart extends `${infer TValidatedSortPart}${TRestSortPart}` ? `${TPreviouslyValidatedSortString}${TValidatedSortPart}` : never, TSortString> : `${TPreviouslyValidatedSortString}, ${SortString<T>}`;
 type MultipleSortString<T extends Entity, TSortString extends string = string> = TSortString extends `${SortString<T>}${infer TRestSortPart}` ? TRestSortPart extends '' ? TSortString : ValidateMultipleSorts<T, TRestSortPart, TSortString extends `${infer TPreviouslyValidatedSortString}${TRestSortPart}` ? TPreviouslyValidatedSortString : never, TSortString> : SortString<T>;
 type SortObjectValue = -1 | 'asc' | 'desc' | 1;
@@ -679,6 +682,7 @@ declare class ReadonlyRepository<T extends Entity> implements IReadonlyRepositor
      * @param {string[]} [args.select] - Array of model property names to return from the query.
      * @param {object} [args.where] - Object representing the where query
      * @param {string|object} [args.sort] - Property name(s) to sort by
+     * @returns Database record or null
      */
     findOne<K extends string & keyof T, TReturn = QueryResult<Pick<T, K | keyof PickFunctions<T> | 'id'>>>(args?: FindOneArgs<T, K> | WhereQuery<T>): FindOneResult<T, TReturn>;
     /**
@@ -689,6 +693,7 @@ declare class ReadonlyRepository<T extends Entity> implements IReadonlyRepositor
      * @param {string|object} [args.sort] - Property name(s) to sort by
      * @param {string|number} [args.skip] - Number of records to skip
      * @param {string|number} [args.limit] - Number of results to return
+     * @returns Database records
      */
     find<K extends string & keyof T, TReturn = QueryResult<Pick<T, K | keyof PickFunctions<T> | 'id'>>>(args?: FindArgs<T, K> | WhereQuery<T>): FindResult<T, TReturn>;
     /**

package/dist/index.d.mts

@@ -223,6 +223,7 @@ declare class ColumnCollectionMetadata extends ColumnBaseMetadata {
     private _throughFn?;
     /**
      * Type of the items in the collection
+     * @returns Name of collection
      */
     get collection(): string;
     /**
@@ -231,6 +232,7 @@ declare class ColumnCollectionMetadata extends ColumnBaseMetadata {
     via: string;
     /**
      * Name of the junction table for multi-multi associations
+     * @returns Name of junction table
      */
     get through(): string | undefined;
     constructor({ target, //
@@ -248,6 +250,7 @@ declare class ColumnModelMetadata extends ColumnBaseMetadata {
     private _modelFn?;
     /**
      * Name of the model represented by this column id
+     * @returns Name of model
      */
     get model(): string;
     constructor({ target, //
@@ -439,7 +442,7 @@ interface DestroyResult<TEntity extends Entity, TReturn> extends PromiseLike<TRe
     where(args: WhereQuery<TEntity>): DestroyResult<TEntity, TReturn>;
 }
 
-type SortString<T extends Entity> = `${string & keyof OmitFunctions<OmitEntityCollections<T>>} ASC` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} asc` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} DESC` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} desc` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>}`;
+type SortString<T extends Entity> = `${string & keyof OmitFunctions<OmitEntityCollections<T>>} ASC` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} asc` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} DESC` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} desc` | (string & keyof OmitFunctions<OmitEntityCollections<T>>);
 type ValidateMultipleSorts<T extends Entity, TNextSortPart extends string, TPreviouslyValidatedSortString extends string, TSortString extends string> = TNextSortPart extends `, ${SortString<T>}${infer TRestSortPart}` ? TRestSortPart extends '' ? TSortString : ValidateMultipleSorts<T, TRestSortPart, TNextSortPart extends `${infer TValidatedSortPart}${TRestSortPart}` ? `${TPreviouslyValidatedSortString}${TValidatedSortPart}` : never, TSortString> : `${TPreviouslyValidatedSortString}, ${SortString<T>}`;
 type MultipleSortString<T extends Entity, TSortString extends string = string> = TSortString extends `${SortString<T>}${infer TRestSortPart}` ? TRestSortPart extends '' ? TSortString : ValidateMultipleSorts<T, TRestSortPart, TSortString extends `${infer TPreviouslyValidatedSortString}${TRestSortPart}` ? TPreviouslyValidatedSortString : never, TSortString> : SortString<T>;
 type SortObjectValue = -1 | 'asc' | 'desc' | 1;
@@ -679,6 +682,7 @@ declare class ReadonlyRepository<T extends Entity> implements IReadonlyRepositor
      * @param {string[]} [args.select] - Array of model property names to return from the query.
      * @param {object} [args.where] - Object representing the where query
      * @param {string|object} [args.sort] - Property name(s) to sort by
+     * @returns Database record or null
      */
     findOne<K extends string & keyof T, TReturn = QueryResult<Pick<T, K | keyof PickFunctions<T> | 'id'>>>(args?: FindOneArgs<T, K> | WhereQuery<T>): FindOneResult<T, TReturn>;
     /**
@@ -689,6 +693,7 @@ declare class ReadonlyRepository<T extends Entity> implements IReadonlyRepositor
      * @param {string|object} [args.sort] - Property name(s) to sort by
      * @param {string|number} [args.skip] - Number of records to skip
      * @param {string|number} [args.limit] - Number of results to return
+     * @returns Database records
      */
     find<K extends string & keyof T, TReturn = QueryResult<Pick<T, K | keyof PickFunctions<T> | 'id'>>>(args?: FindArgs<T, K> | WhereQuery<T>): FindResult<T, TReturn>;
     /**

package/dist/index.d.ts

@@ -223,6 +223,7 @@ declare class ColumnCollectionMetadata extends ColumnBaseMetadata {
     private _throughFn?;
     /**
      * Type of the items in the collection
+     * @returns Name of collection
      */
     get collection(): string;
     /**
@@ -231,6 +232,7 @@ declare class ColumnCollectionMetadata extends ColumnBaseMetadata {
     via: string;
     /**
      * Name of the junction table for multi-multi associations
+     * @returns Name of junction table
      */
     get through(): string | undefined;
     constructor({ target, //
@@ -248,6 +250,7 @@ declare class ColumnModelMetadata extends ColumnBaseMetadata {
     private _modelFn?;
     /**
      * Name of the model represented by this column id
+     * @returns Name of model
      */
     get model(): string;
     constructor({ target, //
@@ -439,7 +442,7 @@ interface DestroyResult<TEntity extends Entity, TReturn> extends PromiseLike<TRe
     where(args: WhereQuery<TEntity>): DestroyResult<TEntity, TReturn>;
 }
 
-type SortString<T extends Entity> = `${string & keyof OmitFunctions<OmitEntityCollections<T>>} ASC` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} asc` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} DESC` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} desc` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>}`;
+type SortString<T extends Entity> = `${string & keyof OmitFunctions<OmitEntityCollections<T>>} ASC` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} asc` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} DESC` | `${string & keyof OmitFunctions<OmitEntityCollections<T>>} desc` | (string & keyof OmitFunctions<OmitEntityCollections<T>>);
 type ValidateMultipleSorts<T extends Entity, TNextSortPart extends string, TPreviouslyValidatedSortString extends string, TSortString extends string> = TNextSortPart extends `, ${SortString<T>}${infer TRestSortPart}` ? TRestSortPart extends '' ? TSortString : ValidateMultipleSorts<T, TRestSortPart, TNextSortPart extends `${infer TValidatedSortPart}${TRestSortPart}` ? `${TPreviouslyValidatedSortString}${TValidatedSortPart}` : never, TSortString> : `${TPreviouslyValidatedSortString}, ${SortString<T>}`;
 type MultipleSortString<T extends Entity, TSortString extends string = string> = TSortString extends `${SortString<T>}${infer TRestSortPart}` ? TRestSortPart extends '' ? TSortString : ValidateMultipleSorts<T, TRestSortPart, TSortString extends `${infer TPreviouslyValidatedSortString}${TRestSortPart}` ? TPreviouslyValidatedSortString : never, TSortString> : SortString<T>;
 type SortObjectValue = -1 | 'asc' | 'desc' | 1;
@@ -679,6 +682,7 @@ declare class ReadonlyRepository<T extends Entity> implements IReadonlyRepositor
      * @param {string[]} [args.select] - Array of model property names to return from the query.
      * @param {object} [args.where] - Object representing the where query
      * @param {string|object} [args.sort] - Property name(s) to sort by
+     * @returns Database record or null
      */
     findOne<K extends string & keyof T, TReturn = QueryResult<Pick<T, K | keyof PickFunctions<T> | 'id'>>>(args?: FindOneArgs<T, K> | WhereQuery<T>): FindOneResult<T, TReturn>;
     /**
@@ -689,6 +693,7 @@ declare class ReadonlyRepository<T extends Entity> implements IReadonlyRepositor
      * @param {string|object} [args.sort] - Property name(s) to sort by
      * @param {string|number} [args.skip] - Number of records to skip
      * @param {string|number} [args.limit] - Number of results to return
+     * @returns Database records
      */
     find<K extends string & keyof T, TReturn = QueryResult<Pick<T, K | keyof PickFunctions<T> | 'id'>>>(args?: FindArgs<T, K> | WhereQuery<T>): FindResult<T, TReturn>;
     /**