bigal 12.1.4 → 13.0.0-beta1

package/eslint.config.mjs

@@ -0,0 +1,25 @@
+import { defaultConfig } from 'eslint-config-decent';
+import tsEslint from 'typescript-eslint';
+
+export default tsEslint.config(
+  ...defaultConfig(),
+  {
+    files: ['**/*.mjs'],
+    rules: {
+      '@typescript-eslint/no-unsafe-call': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+    },
+  },
+  {
+    files: ['**/*.ts'],
+    rules: {
+      '@typescript-eslint/no-invalid-void-type': 'off',
+    },
+  },
+  {
+    files: ['tests/**/*.ts'],
+    rules: {
+      '@typescript-eslint/no-non-null-assertion': 'off',
+    },
+  },
+);

package/package.json

@@ -1,9 +1,23 @@
 {
   "name": "bigal",
-  "version": "12.1.4",
+  "version": "13.0.0-beta1",
   "description": "A fast and lightweight orm for postgres and node.js, written in typescript.",
-  "main": "index.js",
-  "types": "index.d.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
   "keywords": [
     "orm",
     "postgres",
@@ -19,66 +33,61 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@types/lodash": "^4.17.0",
-    "@types/pg": "^8.11.4",
     "lodash": "^4.17.21",
-    "pg": "^8.11.5",
-    "postgres-pool": "^8.1.5"
+    "pg": "^8.12.0",
+    "postgres-pool": "^9.0.0-beta2"
   },
   "devDependencies": {
     "@faker-js/faker": "^8.4.1",
-    "@types/chai": "^4.3.14",
-    "@types/mocha": "10.0.6",
+    "@types/chai": "^4.3.16",
+    "@types/lodash": "^4.17.6",
+    "@types/mocha": "10.0.7",
     "@types/node": ">=20",
-    "@typescript-eslint/eslint-plugin": "^7.6.0",
-    "@typescript-eslint/parser": "^7.6.0",
-    "chai": "^4.4.1",
-    "eslint": "^8.57.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-airbnb-typescript": "^18.0.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsdoc": "^48.2.3",
-    "eslint-plugin-mocha": "10.4.1",
-    "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-security": "^2.1.1",
+    "@types/pg": "^8.11.6",
+    "chai": "^5.1.1",
+    "eslint": "^9.6.0",
+    "eslint-config-decent": "^1.2.2",
     "husky": "^9.0.11",
-    "lint-staged": "^15.2.2",
-    "markdownlint-cli": "^0.39.0",
-    "mocha": "^10.4.0",
+    "lint-staged": "^15.2.7",
+    "markdownlint-cli": "^0.41.0",
+    "mocha": "^10.5.2",
     "npm-run-all": "^4.1.5",
     "pinst": "^3.0.0",
-    "prettier": "^3.2.5",
-    "rimraf": "^5.0.5",
+    "prettier": "^3.3.2",
     "strict-event-emitter-types": "^2.0.0",
     "ts-mockito": "^2.6.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.4"
+    "typescript": "^5.5.3",
+    "typescript-eslint": "^8.0.0-alpha.39",
+    "unbuild": "^2.0.0"
   },
   "scripts": {
-    "check:types": "tsc -p tsconfig.lint.json --noEmit",
-    "prebuild": "rimraf dist",
-    "build": "tsc",
-    "test": "mocha -r ts-node/register tests/**/*.tests.ts",
+    "build": "unbuild",
+    "check:types": "tsc --noEmit --skipLibCheck",
+    "test": "mocha --loader=ts-node/esm tests/**/*.tests.ts",
     "lint:markdown": "prettier --write '*.md' '!(node_modules|dist)/**/*.md' && markdownlint '*.md' '!(node_modules|dist)/**/*.md' --config=.github/linters/.markdown-lint.yml --fix",
-    "lint:code": "eslint --fix --ext .ts src tests",
+    "lint:code": "eslint --fix",
     "lint": "run-p lint:*",
     "lint-staged": "lint-staged",
-    "dist": "if [ -d \"src\" ]; then rm -rf dist && npm run build && npm run lint && npm run test && cp package.json dist && cp package-lock.json dist && cp *.md dist && cp LICENSE dist && cp .npmignore dist && cd dist && npm publish; fi",
-    "beta": "if [ -d \"src\" ]; then rm -rf dist && npm run build && npm run lint && npm run test && cp package.json dist && cp package-lock.json dist && cp *.md dist && cp LICENSE dist && cp .npmignore dist && cd dist && npm publish --tag beta; fi",
-    "prepublishOnly": "if [ -d \"src\" ]; then echo \"Please use: npm run dist\" && exit 125; fi && pinst --disable",
+    "beta": "npm publish --tag beta",
+    "prepublishOnly": "npm run lint && npm run test && npm run build && pinst --disable",
     "postpublish": "pinst --enable",
     "prepare": "husky"
   },
   "lint-staged": {
     "*.md": [
-      "prettier --write",
+      "prettier --write --cache",
       "markdownlint --config=.github/linters/.markdown-lint.yml --fix"
     ],
     "*.js": [
       "eslint --fix"
     ],
+    "*.cjs": [
+      "eslint --fix"
+    ],
+    "*.mjs": [
+      "eslint --fix"
+    ],
     "*.ts": [
       "eslint --fix"
     ]

package/tsconfig.build.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src"
+  },
+  "include": ["src"]
+}

package/Entity.d.ts

@@ -1,16 +0,0 @@
-import type { CreateUpdateParams } from './types';
-export type EntityFieldValue = boolean[] | Date | number[] | Record<string, unknown> | string[] | boolean | number | string | unknown | null;
-export declare abstract class Entity {
-    abstract id: unknown;
-    static beforeCreate(values: CreateUpdateParams<Entity>): CreateUpdateParams<Entity> | Promise<CreateUpdateParams<Entity>>;
-    static beforeUpdate(values: CreateUpdateParams<Entity>): CreateUpdateParams<Entity> | Promise<CreateUpdateParams<Entity>>;
-}
-export interface NotEntityBrand {
-    _notEntityBrand: void;
-}
-export type NotEntity<T> = NotEntityBrand & T;
-export interface EntityStatic<T extends Entity> {
-    beforeCreate?: (values: CreateUpdateParams<any>) => CreateUpdateParams<any> | Promise<CreateUpdateParams<any>>;
-    beforeUpdate?: (values: CreateUpdateParams<any>) => CreateUpdateParams<any> | Promise<CreateUpdateParams<any>>;
-    new (): T;
-}

package/Entity.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Entity = void 0;
-class Entity {
-    static beforeCreate(values) {
-        return values;
-    }
-    static beforeUpdate(values) {
-        return values;
-    }
-}
-exports.Entity = Entity;
-//# sourceMappingURL=Entity.js.map

package/Entity.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Entity.js","sourceRoot":"./","sources":["Entity.ts"],"names":[],"mappings":";;;AAKA,MAAsB,MAAM;IAGnB,MAAM,CAAC,YAAY,CAAC,MAAkC;QAC3D,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,MAAkC;QAC3D,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAVD,wBAUC"}

package/IReadonlyRepository.d.ts

@@ -1,36 +0,0 @@
-import type { Entity } from './Entity';
-import type { ModelMetadata } from './metadata';
-import type { CountResult, FindArgs, FindOneArgs, FindOneResult, FindResult, WhereQuery } from './query';
-import type { CountArgs } from './query/CountArgs';
-import type { QueryResult } from './types';
-export interface IReadonlyRepository<T extends Entity> {
-    readonly model: ModelMetadata<T>;
-    /**
-     * Gets a single object
-     * @param {object} [args] - Arguments
-     * @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|string[]|object[]} [args.sort] - Property name(s) to sort by
-     * @param {object} [args.pool] - Override the db pool to use for the query
-     */
-    findOne<K extends string & keyof T, TReturn = QueryResult<Pick<T, K | 'id'>>>(args: FindOneArgs<T, K> | WhereQuery<T>): FindOneResult<T, TReturn>;
-    /**
-     * Gets a collection of objects
-     * @param {object} [args] - Arguments
-     * @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|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
-     * @param {object} [args.pool] - Override the db pool to use for the query
-     */
-    find<K extends string & keyof T, TReturn = QueryResult<Pick<T, K | 'id'>>>(args: FindArgs<T, K> | WhereQuery<T>): FindResult<T, TReturn>;
-    /**
-     * Gets a count of rows matching the where query
-     * @param {object} [args] - Arguments
-     * @param {object} [args.where] - Object representing the where query
-     * @param {object} [args.pool] - Override the db pool to use for the query
-     * @returns {number} Number of records matching the where criteria
-     */
-    count(args?: CountArgs<T> | WhereQuery<T>): CountResult<T>;
-}

package/IReadonlyRepository.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=IReadonlyRepository.js.map

package/IReadonlyRepository.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IReadonlyRepository.js","sourceRoot":"./","sources":["IReadonlyRepository.ts"],"names":[],"mappings":""}

package/IRepository.d.ts

@@ -1,99 +0,0 @@
-import type { Entity } from './Entity';
-import type { IReadonlyRepository } from './IReadonlyRepository';
-import type { CreateUpdateOptions, //
-DeleteOptions, DestroyResult, DoNotReturnRecords, ReturnSelect, WhereQuery } from './query';
-import type { CreateOptions } from './query/CreateOptions';
-import type { OnConflictOptions } from './query/OnConflictOptions';
-import type { CreateUpdateParams, QueryResult } from './types';
-export interface IRepository<T extends Entity> extends IReadonlyRepository<T> {
-    /**
-     * Creates an object using the specified values
-     * @param {object} values - Values to insert as multiple new objects.
-     * @param {object} [options]
-     * @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}
-     */
-    create(values: CreateUpdateParams<T>, options?: OnConflictOptions<T> | (Partial<OnConflictOptions<T>> & ReturnSelect<T>)): Promise<QueryResult<T>>;
-    /**
-     * Creates an object or objects using the specified values
-     * @param {object|object[]} values - Values to insert as multiple new objects.
-     * @param {object} options
-     * @param {boolean} options.returnRecords - Determines if inserted records should be returned
-     * @param {object} [options.onConflict] - Options to handle conflicts due to a unique constraint or exclusion constraint error during insert
-     * @returns {void}
-     */
-    create(values: CreateUpdateParams<T> | CreateUpdateParams<T>[], options: DoNotReturnRecords & Partial<OnConflictOptions<T>>): Promise<void>;
-    /**
-     * Creates objects using the specified values
-     * @param {object[]} values - Values to insert as multiple new objects.
-     * @param {object} [options]
-     * @param {object} [options.onConflict] - Options to handle conflicts due to a unique constraint or exclusion constraint error during insert
-     * @param {string[]} [options.returnSelect] - Array of model property names to return from the query.
-     * @returns {object[]}
-     */
-    create(values: CreateUpdateParams<T>[], options?: (OnConflictOptions<T> & Partial<ReturnSelect<T>>) | (Partial<OnConflictOptions<T>> & ReturnSelect<T>)): Promise<QueryResult<T>[]>;
-    /**
-     * 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 {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
-     */
-    create(values: CreateUpdateParams<T> | CreateUpdateParams<T>[], options?: CreateOptions<T>): Promise<QueryResult<T> | QueryResult<T>[] | void>;
-    /**
-     * 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 - Determines if inserted records should be returned
-     * @param {{returnRecords: false}} options
-     * @returns {void}
-     */
-    update(where: WhereQuery<T>, values: CreateUpdateParams<T>, options: DoNotReturnRecords): Promise<void>;
-    /**
-     * 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] - Values to update
-     * @param {string[]} [options.returnSelect] - Array of model property names to return from the query.
-     * @returns {object[]}
-     */
-    update(where: WhereQuery<T>, values: CreateUpdateParams<T>, options?: ReturnSelect<T>): Promise<QueryResult<T>[]>;
-    /**
-     * 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 {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
-     */
-    update(where: WhereQuery<T>, values: CreateUpdateParams<T>, options?: CreateUpdateOptions<T>): Promise<QueryResult<T>[] | void>;
-    /**
-     * Destroys object(s) matching the where query
-     * @param {object} [where] - Object representing the where query
-     * @returns {void}
-     */
-    destroy(where?: WhereQuery<T>): DestroyResult<T, void>;
-    /**
-     * Destroys object(s) matching the where query
-     * @param {object} where - Object representing the where query
-     * @param {object} options - 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[]}
-     */
-    destroy(where: WhereQuery<T>, options: DeleteOptions<T>): DestroyResult<T, QueryResult<T>[]>;
-    /**
-     * 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 {string[]} [options.returnSelect] - Array of model property names to return from the query.
-     * @returns {object[]|void} `void` or records affected if returnRecords=true
-     */
-    destroy<TOptions extends DeleteOptions<T> = DeleteOptions<T>>(where: WhereQuery<T>, options?: TOptions): DestroyResult<T, TOptions extends DeleteOptions<T> ? void : QueryResult<T>[]>;
-}

package/IRepository.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=IRepository.js.map

package/IRepository.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IRepository.js","sourceRoot":"./","sources":["IRepository.ts"],"names":[],"mappings":""}

package/ReadonlyRepository.d.ts

@@ -1,69 +0,0 @@
-import type { Pool } from 'postgres-pool';
-import type { Entity, EntityStatic } from './Entity';
-import type { IReadonlyRepository } from './IReadonlyRepository';
-import type { IRepository } from './IRepository';
-import type { ModelMetadata } from './metadata';
-import type { CountResult, FindArgs, FindOneArgs, FindOneResult, FindResult, OrderBy, WhereQuery, SortObject } from './query';
-import type { CountArgs } from './query/CountArgs';
-import type { QueryResult, PickFunctions } from './types';
-export interface IRepositoryOptions<T extends Entity> {
-    modelMetadata: ModelMetadata<T>;
-    type: EntityStatic<T>;
-    repositoriesByModelNameLowered: Record<string, IReadonlyRepository<Entity> | IRepository<Entity>>;
-    pool: Pool;
-    readonlyPool?: Pool;
-}
-interface Populate {
-    propertyName: string;
-    where?: WhereQuery<Entity>;
-    select?: string[];
-    sort?: SortObject<Entity> | string;
-    skip?: number;
-    limit?: number;
-    pool?: Pool;
-}
-export declare class ReadonlyRepository<T extends Entity> implements IReadonlyRepository<T> {
-    private readonly _modelMetadata;
-    protected _type: EntityStatic<T>;
-    protected _pool: Pool;
-    protected _readonlyPool: Pool;
-    protected _repositoriesByModelNameLowered: Record<string, IReadonlyRepository<Entity> | IRepository<Entity>>;
-    protected _floatProperties: string[];
-    protected _intProperties: string[];
-    constructor({ modelMetadata, type, pool, readonlyPool, repositoriesByModelNameLowered }: IRepositoryOptions<T>);
-    get model(): ModelMetadata<T>;
-    /**
-     * Gets a single object
-     * @param {object} [args] - Arguments
-     * @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
-     */
-    findOne<K extends string & keyof T, TReturn = QueryResult<Pick<T, K | keyof PickFunctions<T> | 'id'>>>(args?: FindOneArgs<T, K> | WhereQuery<T>): FindOneResult<T, TReturn>;
-    /**
-     * Gets a collection of objects
-     * @param {object} [args] - Arguments
-     * @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
-     * @param {string|number} [args.skip] - Number of records to skip
-     * @param {string|number} [args.limit] - Number of results to return
-     */
-    find<K extends string & keyof T, TReturn = QueryResult<Pick<T, K | keyof PickFunctions<T> | 'id'>>>(args?: FindArgs<T, K> | WhereQuery<T>): FindResult<T, TReturn>;
-    /**
-     * Gets a count of rows matching the where query
-     * @param {object} [args] - Arguments
-     * @param {object} [args.where] - Object representing the where query
-     * @param {object} [args.pool] - Override the db pool to use for the query
-     * @returns {number} Number of records matching the where criteria
-     */
-    count(args?: CountArgs<T> | WhereQuery<T>): CountResult<T>;
-    protected _buildInstance(row: Partial<QueryResult<T>>): QueryResult<T>;
-    protected _buildInstances(rows: Partial<QueryResult<T>>[]): QueryResult<T>[];
-    protected _convertSortsToOrderBy(sorts: SortObject<T> | string): OrderBy<T>[];
-    protected populateFields(entities: QueryResult<T>[], populates: Populate[]): Promise<void>;
-    private populateSingleAssociation;
-    private populateOneManyCollection;
-    private populateManyManyCollection;
-}
-export {};