bigal 13.0.6 → 13.0.8

package/dist/index.mjs

@@ -86,6 +86,7 @@ class ColumnCollectionMetadata extends ColumnBaseMetadata {
   _throughFn;
   /**
    * Type of the items in the collection
+   * @returns Name of collection
    */
   get collection() {
     if (this._collectionString) {
@@ -103,6 +104,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) {
@@ -112,7 +114,7 @@ class ColumnCollectionMetadata extends ColumnBaseMetadata {
       this._throughString = this._throughFn();
       return this._throughString;
     }
-    return undefined;
+    return void 0;
   }
   constructor({
     target,
@@ -161,6 +163,7 @@ class ColumnModelMetadata extends ColumnBaseMetadata {
   _modelFn;
   /**
    * Name of the model represented by this column id
+   * @returns Name of model
    */
   get model() {
     if (this._modelString) {
@@ -1325,6 +1328,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()`);
@@ -1350,7 +1354,7 @@ class ReadonlyRepository {
           poolOverride = value;
           break;
         default:
-          select = undefined;
+          select = void 0;
           where = args;
           sort = null;
           isWhereCriteria = true;
@@ -1368,6 +1372,7 @@ class ReadonlyRepository {
       /**
        * Filters the query
        * @param {object} value - Object representing the where query
+       * @returns Query instance
        */
       where(value) {
         where = value;
@@ -1382,6 +1387,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)) {
@@ -1405,6 +1411,7 @@ class ReadonlyRepository {
       /**
        * Sorts the query
        * @param {string|object} [value]
+       * @returns Query instance
        */
       sort(value) {
         if (value) {
@@ -1472,6 +1479,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()`);
@@ -1505,7 +1513,7 @@ ${stack ?? ""}`;
           poolOverride = value;
           break;
         default:
-          select = undefined;
+          select = void 0;
           where = args;
           sort = null;
           skip = null;
@@ -1524,6 +1532,7 @@ ${stack ?? ""}`;
       /**
        * Filters the query
        * @param {object} value - Object representing the where query
+       * @returns Query instance
        */
       where(value) {
         where = value;
@@ -1538,6 +1547,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)) {
@@ -1561,6 +1571,7 @@ ${stack ?? ""}`;
       /**
        * Sorts the query
        * @param {string|string[]|object} [value]
+       * @returns Query instance
        */
       sort(value) {
         if (value) {
@@ -1571,6 +1582,7 @@ ${stack ?? ""}`;
       /**
        * Limits results returned by the query
        * @param {number} value
+       * @returns Query instance
        */
       limit(value) {
         limit = value;
@@ -1579,6 +1591,7 @@ ${stack ?? ""}`;
       /**
        * Skips records returned by the query
        * @param {number} value
+       * @returns Query instance
        */
       skip(value) {
         skip = value;
@@ -1590,8 +1603,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);
@@ -1665,6 +1679,7 @@ ${stack ?? ""}`;
       /**
        * Filters the query
        * @param {object} value - Object representing the where query
+       * @returns Count result
        */
       where(value) {
         where = value;
@@ -1962,7 +1977,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
@@ -2009,14 +2024,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
    */
@@ -2051,13 +2066,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
    */
@@ -2073,6 +2088,7 @@ class Repository extends ReadonlyRepository {
       /**
        * Filters the query
        * @param {object} value - Object representing the where query
+       * @returns Query instance
        */
       where(value) {
         where = value;
@@ -2113,21 +2129,15 @@ ${stack}`;
 
 function column(dbColumnNameOrOptions, options) {
   return function columnDecorator(object, propertyName) {
-    if (!dbColumnNameOrOptions) {
-      dbColumnNameOrOptions = _.snakeCase(propertyName);
-    }
+    dbColumnNameOrOptions ??= _.snakeCase(propertyName);
     let dbColumnName;
     if (typeof dbColumnNameOrOptions === "string") {
       dbColumnName = dbColumnNameOrOptions;
     } else {
       options = dbColumnNameOrOptions;
     }
-    if (!options) {
-      options = {};
-    }
-    if (!dbColumnName) {
-      dbColumnName = options.name ?? _.snakeCase(propertyName);
-    }
+    options ??= {};
+    dbColumnName ??= options.name ?? _.snakeCase(propertyName);
     const metadataStorage = getMetadataStorage();
     const columnCollectionOptions = options;
     if (columnCollectionOptions.collection || columnCollectionOptions.via) {
@@ -2186,12 +2196,8 @@ function createDateColumn(dbColumnNameOrOptions, options) {
       options = dbColumnNameOrOptions;
     }
     if (dbColumnNameOrOptions) {
-      if (!options) {
-        options = {};
-      }
-      if (!dbColumnName) {
-        dbColumnName = options.name ?? _.snakeCase(propertyName);
-      }
+      options ??= {};
+      dbColumnName ??= options.name ?? _.snakeCase(propertyName);
       metadataStorage.columns.push(
         new ColumnTypeMetadata({
           target: object.constructor.name,
@@ -2208,7 +2214,7 @@ function createDateColumn(dbColumnNameOrOptions, options) {
         name: dbColumnName ?? _.snakeCase(propertyName),
         propertyName,
         createDate: true,
-        required: options ? options.required : undefined,
+        required: options ? options.required : void 0,
         type: options ? options.type : "datetime"
       });
     }
@@ -2224,12 +2230,8 @@ function primaryColumn(dbColumnNameOrOptions, options) {
       options = dbColumnNameOrOptions;
     }
     if (dbColumnNameOrOptions) {
-      if (!options) {
-        options = {};
-      }
-      if (!dbColumnName) {
-        dbColumnName = options.name ?? _.snakeCase(propertyName);
-      }
+      options ??= {};
+      dbColumnName ??= options.name ?? _.snakeCase(propertyName);
       const { type } = options;
       const { model } = options;
       const metadataStorage = getMetadataStorage();
@@ -2263,9 +2265,9 @@ function primaryColumn(dbColumnNameOrOptions, options) {
         name: dbColumnName ?? _.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
       });
     }
   };
@@ -2280,12 +2282,8 @@ function table(dbNameOrTableOptions, options) {
     } else {
       options = dbNameOrTableOptions;
     }
-    if (!options) {
-      options = {};
-    }
-    if (!options.name) {
-      options.name = dbTableName ?? _.snakeCase(className);
-    }
+    options ??= {};
+    options.name ??= dbTableName ?? _.snakeCase(className);
     const metadataStorage = getMetadataStorage();
     const modelMetadata = new ModelMetadata({
       name: className,
@@ -2307,12 +2305,8 @@ function updateDateColumn(dbColumnNameOrOptions, options) {
       options = dbColumnNameOrOptions;
     }
     if (dbColumnNameOrOptions) {
-      if (!options) {
-        options = {};
-      }
-      if (!dbColumnName) {
-        dbColumnName = options.name ?? _.snakeCase(propertyName);
-      }
+      options ??= {};
+      dbColumnName ??= options.name ?? _.snakeCase(propertyName);
       const metadataStorage = getMetadataStorage();
       metadataStorage.columns.push(
         new ColumnTypeMetadata({
@@ -2331,7 +2325,7 @@ function updateDateColumn(dbColumnNameOrOptions, options) {
         name: dbColumnName ?? _.snakeCase(propertyName),
         propertyName,
         updateDate: true,
-        required: options ? options.required : undefined,
+        required: options ? options.required : void 0,
         type: options ? options.type : "datetime"
       });
     }
@@ -2347,12 +2341,8 @@ function versionColumn(dbColumnNameOrOptions, options) {
       options = dbColumnNameOrOptions;
     }
     if (dbColumnNameOrOptions) {
-      if (!options) {
-        options = {};
-      }
-      if (!dbColumnName) {
-        dbColumnName = options.name ?? _.snakeCase(propertyName);
-      }
+      options ??= {};
+      dbColumnName ??= options.name ?? _.snakeCase(propertyName);
       const metadataStorage = getMetadataStorage();
       metadataStorage.columns.push(
         new ColumnTypeMetadata({
@@ -2371,8 +2361,8 @@ function versionColumn(dbColumnNameOrOptions, options) {
         name: dbColumnName ?? _.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
       });
     }
   };
@@ -2451,6 +2441,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bigal",
-  "version": "13.0.6",
+  "version": "13.0.8",
   "description": "A fast and lightweight orm for postgres and node.js, written in typescript.",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -33,32 +33,39 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@types/pg": "^8.11.10",
-    "lodash": "^4.17.21",
-    "pg": "^8.13.1",
-    "postgres-pool": "^9.0.6"
+    "@types/pg": "8.11.11",
+    "lodash": "4.17.21",
+    "pg": "8.14.1",
+    "postgres-pool": "10.1.0"
   },
   "devDependencies": {
-    "@faker-js/faker": "^9.3.0",
-    "@types/chai": "^5.0.1",
-    "@types/lodash": "^4.17.14",
+    "@faker-js/faker": "9.6.0",
+    "@semantic-release/changelog": "6.0.3",
+    "@semantic-release/commit-analyzer": "13.0.1",
+    "@semantic-release/git": "10.0.1",
+    "@semantic-release/github": "11.0.1",
+    "@semantic-release/npm": "12.0.1",
+    "@semantic-release/release-notes-generator": "14.0.3",
+    "@types/chai": "5.2.1",
+    "@types/lodash": "4.17.16",
     "@types/mocha": "10.0.10",
-    "@types/node": ">=22",
-    "chai": "^5.1.2",
-    "eslint": "^9.17.0",
-    "eslint-config-decent": "^2.3.1",
-    "husky": "^9.1.7",
-    "lint-staged": "^15.3.0",
-    "markdownlint-cli": "^0.43.0",
-    "mocha": "^11.0.1",
-    "npm-run-all": "^4.1.5",
-    "pinst": "^3.0.0",
-    "prettier": "^3.4.2",
-    "strict-event-emitter-types": "^2.0.0",
-    "ts-mockito": "^2.6.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.7.2",
-    "unbuild": "^3.2.0"
+    "@types/node": "22.14.0",
+    "chai": "5.2.0",
+    "eslint": "9.24.0",
+    "eslint-config-decent": "2.6.4",
+    "husky": "9.1.7",
+    "lint-staged": "15.5.0",
+    "markdownlint-cli": "0.44.0",
+    "mocha": "11.1.0",
+    "npm-run-all2": "7.0.2",
+    "pinst": "3.0.0",
+    "prettier": "3.5.3",
+    "semantic-release": "24.2.3",
+    "strict-event-emitter-types": "2.0.0",
+    "ts-mockito": "2.6.1",
+    "ts-node": "10.9.2",
+    "typescript": "5.8.3",
+    "unbuild": "3.5.0"
   },
   "scripts": {
     "build": "unbuild",
@@ -78,17 +85,11 @@
       "prettier --write --cache",
       "markdownlint --config=.github/linters/.markdown-lint.yml --fix"
     ],
-    "*.js": [
+    "*.{js,cjs,mjs,ts}": [
       "eslint --fix"
     ],
-    "*.cjs": [
-      "eslint --fix"
-    ],
-    "*.mjs": [
-      "eslint --fix"
-    ],
-    "*.ts": [
-      "eslint --fix"
+    "*.{json5,yml}": [
+      "prettier --write"
     ]
   },
   "repository": {

package/release.config.mjs

@@ -0,0 +1,43 @@
+export default {
+  branches: ['main', 'beta'],
+  plugins: [
+    [
+      '@semantic-release/commit-analyzer',
+      {
+        preset: 'angular',
+        releaseRules: [
+          { type: 'docs', release: 'patch' },
+          { type: 'feat', release: 'minor' },
+          { type: 'fix', release: 'patch' },
+          { type: 'test', release: 'patch' },
+          { type: 'chore', release: 'patch' },
+        ],
+        parserOpts: {
+          headerPattern: /^(\w*): (.*)$/,
+          headerCorrespondence: ['type', 'subject'],
+        },
+      },
+    ],
+    '@semantic-release/release-notes-generator',
+    [
+      '@semantic-release/changelog',
+      {
+        changelogFile: 'CHANGELOG.md',
+      },
+    ],
+    '@semantic-release/npm',
+    [
+      '@semantic-release/github',
+      {
+        assets: [],
+      },
+    ],
+    [
+      '@semantic-release/git',
+      {
+        assets: ['CHANGELOG.md', 'package.json', 'package-lock.json'],
+        message: `chore: release \${nextRelease.version} [skip ci]\n\n\${nextRelease.notes}`,
+      },
+    ],
+  ],
+};