pangea-server 1.0.77 → 1.0.79

package/dist/authentication/authentication.helpers.js

@@ -12,7 +12,7 @@ async function login(authHeader, db, accessToken, userCtor, extraWhere = {}) {
     if (!username || !password)
         helpers_1.AppError.ThrowInvalidCredentials();
     const where = { ...extraWhere, username };
-    const user = await db.findOneOrNull(userCtor, where, { scopes: ['withExcludedAttributes'] });
+    const user = await db.findOneOrNull(userCtor, where, { scopes: ['withHiddenAttributes'] });
     if (!user)
         helpers_1.AppError.ThrowInvalidCredentials();
     const isPasswordValid = await (0, helpers_1.comparePasswords)(password, user.password);

package/dist/database/database.types.d.ts

@@ -9,12 +9,12 @@ declare global {
     type ModelName = string;
     type BaseModelCtor<BM extends BaseModel = BaseModel> = typeof BaseModel & ModelCtor<BM>;
     type ColOptional<T> = CreationOptional<T>;
-    type ColExcluded<T> = T & {
-        __brand: 'excluded';
+    type ColHidden<T> = T & {
+        __brand: 'hidden';
     };
     type ColVirtual<T> = NonAttribute<T>;
     type Where<BM extends BaseModel> = WhereOptions<BM> & Record<symbol, any>;
-    type InsertParams<BM extends BaseModel> = OptionalIfNullish<OptionalIfOptional<StripRelations<OptionalFields<IncludeExcluded<Omit<InferCreationAttributes<BM>, '__brand'>>, Exclude<keyof InferCreationAttributes<BM>, '__brand'> & 'id'>>>>;
+    type InsertParams<BM extends BaseModel> = OptionalIfNullish<OptionalIfOptional<StripRelations<OptionalFields<IncludeHidden<Omit<InferCreationAttributes<BM>, '__brand'>>, Exclude<keyof InferCreationAttributes<BM>, '__brand'> & 'id'>>>>;
     type UpdateParams<BM extends BaseModel> = Partial<InsertParams<BM>>;
     type Tx = Transaction;
     type Db = _Db;
@@ -26,6 +26,7 @@ export type Seeds<M extends Models> = {
 export type ConnectDatabase = () => void;
 export type DisconnectDatabase = () => void;
 export type Index = {
+    name?: string;
     field?: string;
     fields?: string[];
     unique?: boolean;
@@ -37,7 +38,7 @@ export type ColGeneralOptions = {
     defaultValue?: DefaultValue;
     index?: boolean;
     unique?: boolean;
-    exclude?: boolean;
+    hideByDefault?: boolean;
 };
 export type ColVirtualGet = (this: any) => unknown;
 export type ColVirtualSet = (this: any, val: any) => void;
@@ -51,8 +52,8 @@ type OptionalIfOptional<T> = {
 } & {
     [K in keyof T as undefined extends T[K] ? never : K]: T[K];
 };
-type IncludeExcluded<T> = {
-    [K in keyof T]-?: Exclude<T[K], undefined> extends ColExcluded<infer U> ? U : T[K];
+type IncludeHidden<T> = {
+    [K in keyof T]-?: Exclude<T[K], undefined> extends ColHidden<infer U> ? U : T[K];
 };
 type IsRelation<T> = NonNullable<T> extends BaseModel | Array<BaseModel> ? true : false;
 type StripRelations<T> = {

package/dist/database/db.class.js

@@ -270,6 +270,8 @@ function getInclude(model, config = {}, relDepth = new Map()) {
         const maxDepth = rel.joinDepth;
         if (currentDepth >= maxDepth)
             continue;
+        if (rel.exclude)
+            continue;
         const relWhere = cleanWhere[relName];
         delete cleanWhere[relName];
         const newRelDepth = new Map(relDepth);

package/dist/database/decorators/columns/column.js

@@ -26,7 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Column = void 0;
 const seq = __importStar(require("sequelize-typescript"));
 function Column(type, options = {}) {
-    const { nullable = false, defaultValue, index, unique = false, exclude, get, set, ...restOptions } = options;
+    const { nullable = false, defaultValue, index, unique = false, hideByDefault, get, set, ...restOptions } = options;
     return function (target, propertyName) {
         seq.Column({
             type: typeof type === 'string' ? seq.DataType[type] : type,
@@ -40,8 +40,8 @@ function Column(type, options = {}) {
         model.AddColumn(propertyName, { allowNull: nullable, defaultValue });
         if (index || unique)
             model.AddColumnIndex({ field: propertyName, unique });
-        if (exclude)
-            model.AddExcludedAttribute(propertyName);
+        if (hideByDefault)
+            model.AddHiddenAttribute(propertyName);
     };
 }
 exports.Column = Column;

package/dist/database/decorators/columns/general.columns.d.ts

@@ -1,4 +1,4 @@
 import type { ColGeneralOptions, ColVirtualGet, ColVirtualOptions, GetModelFn } from '../../../database/database.types';
 export declare function ColBool(options?: ColGeneralOptions): (target: any, propertyName: string) => void;
-export declare function ColForeignKey(getModelFn: GetModelFn, options?: ColGeneralOptions): (target: any, propertyName: string) => void;
+export declare function ColForeignKey(getModelFn: GetModelFn, options?: Omit<ColGeneralOptions, 'index'>): (target: any, propertyName: string) => void;
 export declare function ColVirtual(options?: ColVirtualOptions | ColVirtualGet): Function;

package/dist/database/decorators/columns/general.columns.js

@@ -32,7 +32,7 @@ function ColBool(options) {
 exports.ColBool = ColBool;
 function ColForeignKey(getModelFn, options) {
     return function (target, propertyName) {
-        (0, column_1.Column)('INTEGER', { ...options, onUpdate: 'RESTRICT', onDelete: 'RESTRICT' })(target, propertyName);
+        (0, column_1.Column)('INTEGER', { ...options, index: true, onUpdate: 'RESTRICT', onDelete: 'RESTRICT' })(target, propertyName);
         seq.ForeignKey(getModelFn)(target, propertyName);
     };
 }

package/dist/database/decorators/relations.d.ts

@@ -1,9 +1,10 @@
 import type { GetModelFn } from '../database.types';
 type RelationOptions = {
+    foreignKey?: string;
+    exclude?: boolean;
     required?: boolean;
     paranoid?: boolean;
     joinDepth?: number;
-    foreignKey?: string;
 };
 export declare const BelongsTo: (getModelFn: GetModelFn, options?: RelationOptions) => (target: any, propertyName: string) => void;
 export declare const HasOne: (getModelFn: GetModelFn, options?: RelationOptions) => (target: any, propertyName: string) => void;

package/dist/database/decorators/relations.js

@@ -35,8 +35,8 @@ function getRelation(relationFn) {
             const { foreignKey, ...relOptions } = options;
             relationFn(getModelFn, { as: propertyName, ...(foreignKey && { foreignKey }) })(target, propertyName);
             const model = target.constructor;
-            const { required = relationFn === seq.BelongsTo ? !model.Columns[`${propertyName}Id`].allowNull : false, paranoid = relationFn !== seq.BelongsTo, joinDepth = 1, ...restOptions } = relOptions;
-            model.AddRelation(propertyName, { getModelFn, required, paranoid, joinDepth, ...restOptions });
+            const { exclude = false, required = relationFn === seq.BelongsTo ? !model.Columns[`${propertyName}Id`].allowNull : false, paranoid = relationFn !== seq.BelongsTo, joinDepth = 1, ...restOptions } = relOptions;
+            model.AddRelation(propertyName, { getModelFn, exclude, required, paranoid, joinDepth, ...restOptions });
         };
     };
 }

package/dist/database/decorators/table.js

@@ -40,15 +40,16 @@ function Table(tableName, options = {}) {
             underscored: true,
             timestamps: true,
             paranoid: true,
-            indexes: allIndexes.map(({ field, fields, ...restIndex }) => {
-                return { ...restIndex, fields: fields ? fields.map(pangea_helpers_1.camelToSnake) : field ? [(0, pangea_helpers_1.camelToSnake)(field)] : [] };
-            }),
+            indexes: allIndexes.map(({ field, fields, ...restIndex }) => ({
+                ...restIndex,
+                fields: fields ? fields.map(pangea_helpers_1.camelToSnake) : field ? [(0, pangea_helpers_1.camelToSnake)(field)] : [],
+            })),
         })(target);
-        const excludedAttributes = target.ExcludedAttributes;
-        if (!excludedAttributes.length)
+        const hiddenAttributes = target.HiddenAttributes;
+        if (!hiddenAttributes.length)
             return;
-        seq.DefaultScope(() => ({ attributes: { exclude: excludedAttributes } }))(target);
-        seq.Scopes(() => ({ withExcludedAttributes: { attributes: { include: excludedAttributes } } }))(target);
+        seq.DefaultScope(() => ({ attributes: { exclude: hiddenAttributes } }))(target);
+        seq.Scopes(() => ({ withHiddenAttributes: { attributes: { include: hiddenAttributes } } }))(target);
     };
 }
 exports.Table = Table;

package/dist/database/models/base-model.class.d.ts

@@ -7,22 +7,23 @@ type Column = {
 type Columns = Record<string, Column>;
 type Relation = {
     getModelFn: GetModelFn;
+    exclude: boolean;
     required: boolean;
     paranoid: boolean;
     joinDepth: number;
 };
 type Relations = Record<string, Relation>;
 export declare abstract class BaseModel extends Model {
-    private static __ExcludedAttributes?;
+    private static __HiddenAttributes?;
     private static __Columns?;
     private static __ColumnIndexes?;
     private static __Relations?;
     id: ModelId;
-    static get ExcludedAttributes(): string[];
+    static get HiddenAttributes(): string[];
     static get Columns(): Columns;
     static get ColumnIndexes(): Index[];
     static get Relations(): Relations;
-    static AddExcludedAttribute(attribute: string): void;
+    static AddHiddenAttribute(attribute: string): void;
     static AddColumn(colName: string, col: Column): void;
     static AddColumnIndex(index: Index): void;
     static AddRelation(relName: string, rel: Relation): void;

package/dist/database/models/base-model.class.js

@@ -12,8 +12,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseModel = void 0;
 const sequelize_typescript_1 = require("sequelize-typescript");
 class BaseModel extends sequelize_typescript_1.Model {
-    static get ExcludedAttributes() {
-        return this.__ExcludedAttributes || [];
+    static get HiddenAttributes() {
+        return this.__HiddenAttributes || [];
     }
     static get Columns() {
         return this.__Columns || {};
@@ -24,9 +24,9 @@ class BaseModel extends sequelize_typescript_1.Model {
     static get Relations() {
         return this.__Relations || {};
     }
-    static AddExcludedAttribute(attribute) {
-        this.__SetArray('__ExcludedAttributes');
-        this.__ExcludedAttributes.push(attribute);
+    static AddHiddenAttribute(attribute) {
+        this.__SetArray('__HiddenAttributes');
+        this.__HiddenAttributes.push(attribute);
     }
     static AddColumn(colName, col) {
         this.__SetObject('__Columns');

package/dist/database/models/user.model.d.ts

@@ -1,5 +1,5 @@
 import { BaseModel } from './base-model.class';
 export declare abstract class User extends BaseModel {
     username: string;
-    password?: ColExcluded<string>;
+    password?: ColHidden<string>;
 }

package/dist/database/models/user.model.js

@@ -16,6 +16,6 @@ class User extends base_model_class_1.BaseModel {
 }
 exports.User = User;
 __decorate([
-    decorators_1.col.Str({ exclude: true, maxLength: 'medium' }),
+    decorators_1.col.Str({ hideByDefault: true, maxLength: 'medium' }),
     __metadata("design:type", Object)
 ], User.prototype, "password", void 0);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pangea-server",
   "description": "",
-  "version": "1.0.77",
+  "version": "1.0.79",
   "files": [
     "dist"
   ],