bigal 10.0.0-beta2 → 10.0.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-## 10.0.0-beta1 - 2022-01-03
+## 10.0.0 - 2022-01-07
 
 - Fix populated entities to be QueryResult
 - Improve return types when doing partial selects

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bigal",
-  "version": "10.0.0-beta2",
+  "version": "10.0.0",
   "description": "A fast and lightweight orm for postgres and node.js, written in typescript.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -45,7 +45,7 @@
     "eslint-plugin-security": "^1.4.0",
     "faker": "^5.5.3",
     "husky": "^7.0.4",
-    "lint-staged": "^12.1.5",
+    "lint-staged": "^12.1.7",
     "markdownlint-cli": "^0.30.0",
     "mocha": "^9.1.3",
     "npm-run-all": "^4.1.5",
@@ -58,6 +58,7 @@
     "typescript": "^4.5.4"
   },
   "scripts": {
+    "check:types": "tsc -p tsconfig.lint.json --noEmit",
     "prebuild": "rimraf dist",
     "build": "tsc",
     "test": "mocha -r ts-node/register tests/**/*.tests.ts",
@@ -65,7 +66,7 @@
     "lint:code": "eslint --fix --ext .ts src tests",
     "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 --tag beta; fi",
+    "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",
     "prepublishOnly": "if [ -d \"src\" ]; then echo \"Please use: npm run dist\" && exit 125; fi && pinst --disable",
     "_postinstall": "husky install",
     "postpublish": "pinst --enable"

package/query/WhereQuery.d.ts

@@ -1,24 +1,23 @@
 import type { Entity, NotEntityBrand } from '../Entity';
-import type { EntityPrimitiveOrId, ExcludeEntityCollections, ExcludeFunctions } from '../types';
-export declare type WhereClauseValue<TValue> = TValue extends NotEntityBrand | undefined ? Exclude<TValue, undefined> : TValue extends Entity ? {
-    id: unknown;
-}[] | Exclude<EntityPrimitiveOrId<TValue>, undefined> | Exclude<EntityPrimitiveOrId<TValue>, undefined>[] | {
-    id: unknown;
-} | null : Exclude<(TValue | null)[] | TValue, undefined> | null;
+import type { ExcludeEntityCollections, ExcludeFunctions } from '../types';
+declare type ExcludeUndefined<T> = Exclude<T, undefined>;
+export declare type LiteralValues<TValue> = (ExcludeUndefined<TValue> | null)[] | ExcludeUndefined<TValue> | null;
+export declare type WhereClauseValue<TValue> = TValue extends NotEntityBrand | undefined ? Exclude<TValue, NotEntityBrand | undefined> : Extract<TValue, Entity> extends undefined ? LiteralValues<TValue> : (ExcludeUndefined<Exclude<TValue, Entity>> | null)[] | (Pick<Extract<ExcludeUndefined<TValue>, Entity>, 'id'> | null)[] | ExcludeUndefined<Exclude<TValue, Entity>> | Pick<Extract<ExcludeUndefined<TValue>, Entity>, 'id'> | null;
 export declare type StringConstraint<TValue extends string> = {
-    [P in 'contains' | 'endsWith' | 'like' | 'startsWith']?: WhereClauseValue<TValue>;
+    [P in 'contains' | 'endsWith' | 'like' | 'startsWith']?: LiteralValues<TValue>;
 };
 export declare type NumberOrDateConstraint<TValue extends Date | number> = {
-    [P in '<' | '<=' | '>' | '>=']?: WhereClauseValue<TValue>;
+    [P in '<' | '<=' | '>' | '>=']?: LiteralValues<TValue>;
 };
 export declare type NegatableConstraint<TValue> = TValue | {
     '!': TValue;
 };
 export declare type WhereQueryStatement<TValue> = TValue extends string ? NegatableConstraint<StringConstraint<TValue> | WhereClauseValue<TValue>> : TValue extends Date | number ? NegatableConstraint<NumberOrDateConstraint<TValue> | WhereClauseValue<TValue>> : NegatableConstraint<WhereClauseValue<TValue>>;
 export declare type WhereQuery<T extends Entity> = {
-    [K in keyof T as ExcludeEntityCollections<T[K], ExcludeFunctions<T[K], K>>]?: K extends 'id' ? WhereQueryStatement<T | T[K]> : T[K] extends (infer U)[] | undefined ? WhereQueryStatement<U> : Exclude<(T[K] | null)[] | T[K], undefined> | WhereQueryStatement<T[K]> | {
-        '!': Exclude<(T[K] | null)[] | T[K], undefined>;
+    [K in keyof T as ExcludeEntityCollections<T[K], ExcludeFunctions<T[K], K>>]?: K extends 'id' ? WhereQueryStatement<T | T[K]> : T[K] extends (infer U)[] | undefined ? WhereQueryStatement<U> : (ExcludeUndefined<T[K]> | null)[] | T[K] | WhereQueryStatement<T[K]> | {
+        '!': LiteralValues<T[K]>;
     };
 } & {
     or?: WhereQuery<T>[];
 };
+export {};

package/types/CreateUpdateParams.d.ts

@@ -1,12 +1,9 @@
 import type { Entity, NotEntityBrand } from '../Entity';
-import type { EntityPrimitiveOrId } from './EntityPrimitiveOrId';
 import type { ExcludeEntityCollections } from './ExcludeEntityCollections';
 import type { ExcludeFunctions } from './ExcludeFunctions';
 /**
  * Changes all Entity value properties to Primitive (string|number) | Pick<Entity, 'id'>
  */
 export declare type CreateUpdateParams<T extends Entity> = {
-    [K in keyof T as ExcludeEntityCollections<NonNullable<T[K]>, ExcludeFunctions<T[K], K>>]?: T[K] extends NotEntityBrand | undefined ? T[K] : T[K] extends Entity ? EntityPrimitiveOrId<T[K]> | {
-        id: unknown;
-    } : T[K];
+    [K in keyof T as ExcludeEntityCollections<NonNullable<T[K]>, ExcludeFunctions<T[K], K>>]?: T[K] extends NotEntityBrand | undefined ? T[K] : Extract<T[K], Entity> extends undefined ? T[K] : Exclude<T[K], Entity> | Pick<Extract<T[K], Entity>, 'id'>;
 };

package/types/EntityPrimitiveOrId.d.ts

@@ -1,2 +1,2 @@
 import type { Entity } from '../Entity';
-export declare type EntityPrimitiveOrId<T extends Entity, TIdKey extends keyof T = 'id'> = T extends Entity ? Exclude<T, Entity> | Pick<T, TIdKey> : T;
+export declare type EntityPrimitiveOrId<T> = T extends [] ? T extends (infer U)[] ? EntityPrimitiveOrId<U>[] : T : Extract<NonNullable<T>, Entity> extends undefined ? T : Exclude<NonNullable<T>, Entity> | Pick<Extract<NonNullable<T>, Entity>, 'id'>;

package/types/QueryResultOptionalPopulated.d.ts

@@ -0,0 +1,9 @@
+import type { Entity } from '../Entity';
+import type { QueryResult } from './QueryResult';
+import { EntityPrimitiveOrId } from "./EntityPrimitiveOrId";
+/**
+ * Allows a QueryResult type with specific properties optionally populated. If the property is populated, only the id property is needed
+ */
+export declare type QueryResultOptionalPopulated<T extends Entity, K extends keyof T> = Omit<QueryResult<T>, K> & {
+    [P in K]-?: T[P] extends [] ? undefined extends T[P] ? EntityPrimitiveOrId<T[P]> | null : EntityPrimitiveOrId<T[P]> : EntityPrimitiveOrId<T[P]>;
+};

package/types/QueryResultOptionalPopulated.js

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

package/types/QueryResultOptionalPopulated.js.map

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

package/types/index.d.ts

@@ -13,3 +13,4 @@ export * from './PickFunctions';
 export * from './Populated';
 export * from './QueryResult';
 export * from './QueryResultPopulated';
+export * from './QueryResultOptionalPopulated';

package/types/index.js

@@ -25,4 +25,5 @@ __exportStar(require("./PickFunctions"), exports);
 __exportStar(require("./Populated"), exports);
 __exportStar(require("./QueryResult"), exports);
 __exportStar(require("./QueryResultPopulated"), exports);
+__exportStar(require("./QueryResultOptionalPopulated"), exports);
 //# sourceMappingURL=index.js.map

package/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"./","sources":["types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uDAAqC;AACrC,wDAAsC;AACtC,6DAA2C;AAC3C,qDAAmC;AACnC,iDAA+B;AAC/B,qDAAmC;AACnC,kDAAgC;AAChC,0DAAwC;AACxC,kDAAgC;AAChC,+CAA6B;AAC7B,oDAAkC;AAClC,kDAAgC;AAChC,8CAA4B;AAC5B,gDAA8B;AAC9B,yDAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"./","sources":["types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uDAAqC;AACrC,wDAAsC;AACtC,6DAA2C;AAC3C,qDAAmC;AACnC,iDAA+B;AAC/B,qDAAmC;AACnC,kDAAgC;AAChC,0DAAwC;AACxC,kDAAgC;AAChC,+CAA6B;AAC7B,oDAAkC;AAClC,kDAAgC;AAChC,8CAA4B;AAC5B,gDAA8B;AAC9B,yDAAuC;AACvC,iEAA8C"}