@rws-framework/db 2.4.6 → 3.0.1

package/dist/models/core/RWSModel.d.ts

@@ -3,12 +3,15 @@ import { IRWSModelServices } from '../interfaces/IRWSModelServices';
 import { OpModelType } from '../interfaces/OpModelType';
 import { FindByType, IPaginationParams } from '../../types/FindParams';
 import { DBService } from '../../services/DBService';
+import { ISuperTagData } from '../../decorators/RWSCollection';
 declare class RWSModel<T> implements IModel {
     static services: IRWSModelServices;
     [key: string]: any;
     id: string | number;
     static _collection: string;
     static _RELATIONS: {};
+    static _NO_ID: boolean;
+    static _SUPER_TAGS: ISuperTagData[];
     static _BANNED_KEYS: string[];
     static allModels: OpModelType<any>[];
     static _CUT_KEYS: string[];
@@ -51,14 +54,14 @@ declare class RWSModel<T> implements IModel {
     sanitizeDBData(data: any): any;
     static watchCollection<T extends RWSModel<T>>(this: OpModelType<T>, preRun: () => void): Promise<any>;
     static findOneBy<T extends RWSModel<T>>(this: OpModelType<T>, findParams?: FindByType): Promise<T | null>;
-    static find<T extends RWSModel<T>>(this: OpModelType<T>, id: string, findParams?: Omit<FindByType, 'conditions'>): Promise<T | null>;
+    static find<T extends RWSModel<T>>(this: OpModelType<T>, id: string | number, findParams?: Omit<FindByType, 'conditions'>): Promise<T | null>;
     static findBy<T extends RWSModel<T>>(this: OpModelType<T>, findParams?: FindByType): Promise<T[]>;
     static delete<T extends RWSModel<T>>(this: OpModelType<T>, conditions: any): Promise<void>;
     delete<T extends RWSModel<T>>(): Promise<void>;
     static create<T extends RWSModel<T>>(this: new () => T, data: any): Promise<T>;
     static loadModels(): OpModelType<any>[];
     loadModels(): OpModelType<any>[];
-    private checkRelEnabled;
+    private checkRelDisabled;
     static setServices(services: IRWSModelServices): void;
     getDb(): DBService;
     static getDb(): DBService;

package/dist/models/core/RWSModel.js

@@ -94,7 +94,7 @@ class RWSModel {
                     continue;
                 }
                 const relMeta = relManyData[key];
-                const relationEnabled = RelationUtils_1.RelationUtils.checkRelEnabled(this, relMeta.key);
+                const relationEnabled = !RelationUtils_1.RelationUtils.checkRelDisabled(this, relMeta.key);
                 if (relationEnabled) {
                     this[relMeta.key] = await relMeta.inversionModel.findBy({
                         conditions: {
@@ -110,7 +110,7 @@ class RWSModel {
                     continue;
                 }
                 const relMeta = relOneData[key];
-                const relationEnabled = RelationUtils_1.RelationUtils.checkRelEnabled(this, relMeta.key);
+                const relationEnabled = !RelationUtils_1.RelationUtils.checkRelDisabled(this, relMeta.key);
                 if (!data[relMeta.hydrationField] && relMeta.required) {
                     throw new Error(`Relation field "${relMeta.hydrationField}" is required in model ${this.constructor.name}.`);
                 }
@@ -122,7 +122,8 @@ class RWSModel {
                     this[relMeta.key] = await newRelModel.save();
                 }
                 const cutKeys = this.constructor._CUT_KEYS;
-                if (!cutKeys.includes(relMeta.hydrationField)) {
+                const trackedField = Object.keys((await ModelUtils_1.ModelUtils.getModelAnnotations(this.constructor))).includes(relMeta.hydrationField);
+                if (!cutKeys.includes(relMeta.hydrationField) && !trackedField) {
                     cutKeys.push(relMeta.hydrationField);
                 }
             }
@@ -373,8 +374,8 @@ class RWSModel {
     loadModels() {
         return RWSModel.loadModels();
     }
-    checkRelEnabled(key) {
-        return RelationUtils_1.RelationUtils.checkRelEnabled(this, key);
+    checkRelDisabled(key) {
+        return RelationUtils_1.RelationUtils.checkRelDisabled(this, key);
     }
     static setServices(services) {
         this.allModels = services.configService.get('db_models');
@@ -391,6 +392,8 @@ exports.RWSModel = RWSModel;
 RWSModel.services = {};
 RWSModel._collection = null;
 RWSModel._RELATIONS = {};
+RWSModel._NO_ID = false;
+RWSModel._SUPER_TAGS = [];
 RWSModel._BANNED_KEYS = ['_collection'];
 RWSModel.allModels = [];
 RWSModel._CUT_KEYS = [];

package/dist/models/index.d.ts

@@ -3,5 +3,5 @@ import { IRWSModelServices } from './interfaces/IRWSModelServices';
 import { OpModelType } from './interfaces/OpModelType';
 import { RelationBindType, RelOneMetaType, RelManyMetaType } from './types/RelationTypes';
 import { RWSModel } from './core/RWSModel';
-import { TrackType, IMetaOpts } from '../decorators';
-export { IModel, IRWSModelServices, OpModelType, RelationBindType, RelOneMetaType, RelManyMetaType, RWSModel, TrackType, IMetaOpts };
+import { TrackType, ITrackerMetaOpts } from '../decorators';
+export { IModel, IRWSModelServices, OpModelType, RelationBindType, RelOneMetaType, RelManyMetaType, RWSModel, TrackType, ITrackerMetaOpts };

package/dist/models/interfaces/IDbOpts.d.ts

@@ -0,0 +1,17 @@
+export interface IDbOpts {
+    dbOptions?: {
+        mysql?: {
+            useType?: string;
+            useText?: boolean;
+            maxLength?: number;
+            useUuid?: boolean;
+        };
+        postgres?: {
+            useText?: boolean;
+            useUuid?: boolean;
+        };
+        mongodb?: {
+            customType?: string;
+        };
+    };
+}

package/dist/models/interfaces/IDbOpts.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/interfaces/IIdOpts.js

@@ -0,0 +1 @@
+"use strict";

package/dist/models/interfaces/IIdTypeOpts.d.ts

@@ -0,0 +1,3 @@
+import { IDbOpts } from "./IDbOpts";
+export interface IIdTypeOpts extends IDbOpts {
+}

package/dist/models/interfaces/IIdTypeOpts.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/interfaces/ITrackerOpts.d.ts

@@ -0,0 +1,12 @@
+import { IDbOpts } from "./IDbOpts";
+import { OpModelType } from "./OpModelType";
+export interface ITrackerOpts extends IDbOpts {
+    required?: boolean;
+    unique?: boolean | string;
+    isArray?: boolean;
+    relationField?: string;
+    relatedToField?: string;
+    relatedTo?: OpModelType<any>;
+    inversionModel?: OpModelType<any>;
+    relationName?: string;
+}

package/dist/models/interfaces/ITrackerOpts.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/interfaces/OpModelType.d.ts

@@ -4,11 +4,14 @@ import { IRWSModelServices } from './IRWSModelServices';
 import { RelOneMetaType, RelManyMetaType } from '../types/RelationTypes';
 import { DBService } from '../../services/DBService';
 import type { RWSModel } from '../core/RWSModel';
+import { ISuperTagData } from '../../decorators/RWSCollection';
 export interface OpModelType<T> {
     new (data?: any | null): T;
     services: IRWSModelServices;
     name: string;
     _collection: string;
+    _NO_ID: boolean;
+    _SUPER_TAGS: ISuperTagData[];
     _RELATIONS: {
         [key: string]: boolean;
     };
@@ -18,7 +21,7 @@ export interface OpModelType<T> {
     checkForInclusionWithThrow: (className: string) => void;
     checkForInclusion: (className: string) => boolean;
     findOneBy<T extends RWSModel<T>>(this: OpModelType<T>, findParams?: FindByType): Promise<T | null>;
-    find<T extends RWSModel<T>>(this: OpModelType<T>, id: string, findParams?: Omit<FindByType, 'conditions'>): Promise<T | null>;
+    find<T extends RWSModel<T>>(this: OpModelType<T>, id: string | number, findParams?: Omit<FindByType, 'conditions'>): Promise<T | null>;
     findBy<T extends RWSModel<T>>(this: OpModelType<T>, findParams?: FindByType): Promise<T[]>;
     paginate<T extends RWSModel<T>>(this: OpModelType<T>, paginateParams?: IPaginationParams, findParams?: FindByType): Promise<T[]>;
     delete<T extends RWSModel<T>>(this: OpModelType<T>, conditions: any): Promise<void>;

package/dist/models/utils/RelationUtils.d.ts

@@ -10,5 +10,5 @@ export declare class RelationUtils {
         };
     };
     static hasRelation(model: RWSModel<any>, key: string): boolean;
-    static checkRelEnabled(model: RWSModel<any>, key: string): boolean;
+    static checkRelDisabled(model: RWSModel<any>, key: string): boolean;
 }

package/dist/models/utils/RelationUtils.js

@@ -57,9 +57,9 @@ class RelationUtils {
         // Check if the property exists and is an object with an id property
         return !!model[key] && typeof model[key] === 'object' && model[key] !== null && 'id' in model[key];
     }
-    static checkRelEnabled(model, key) {
+    static checkRelDisabled(model, key) {
         return Object.keys(model.constructor._RELATIONS).includes(key) &&
-            model.constructor._RELATIONS[key] === true;
+            model.constructor._RELATIONS[key] === false;
     }
 }
 exports.RelationUtils = RelationUtils;

package/dist/types/DbConfigHandler.d.ts

@@ -2,7 +2,7 @@ import { OpModelType } from "../models/interfaces/OpModelType";
 export interface IDbConfigParams {
     db_url?: string;
     db_name?: string;
-    db_type?: 'mongodb' | 'mysql' | 'sqlite';
+    db_type?: 'mongodb' | 'mysql' | 'sqlite' | 'postgresql' | 'postgres';
     db_models?: OpModelType<any>[];
 }
 export interface IdGeneratorOptions {

package/dist/types/IRWSModel.d.ts

@@ -1,3 +1,3 @@
 export interface IRWSModel {
-    id?: string;
+    id?: string | number;
 }

package/exec/console.js

@@ -1,111 +1,111 @@
-#!/usr/bin/env node
-
-const { rwsShell, rwsPath } = require('@rws-framework/console');
-const chalk = require('chalk');
-const crypto = require('crypto');
-const path = require('path');
-const fs = require('fs');
-
-const params = process.argv.splice(2);
-let paramsString = params.length ? (' ' + params.join(' ')) : '';
-
-const appRoot = process.cwd();
-const rwsCliConfigDir = path.resolve(appRoot, 'node_modules', '.rws', 'cli');
-const getCachedPath = (key) => path.resolve(rwsCliConfigDir, key);
-
-const currentCwd = path.resolve(__dirname);
-
-console.log({params})
-
-
-const commandString = `npx webpack --config db.rws.webpack.config.js --output-path ./build ${process.cwd()} ${params[2]}`;
-function needsCacheWarming(){
-
-    if(!fs.existsSync(getCachedPath('paths')) || !fs.existsSync(getCachedPath('checksum'))){
-        return true;
-    }
-    
-    const fileList = fs.readFileSync(getCachedPath('paths'), 'utf-8').split('\n');    
-
-    if(fileList.length){
-        const fileContents = [];
-        for(const filePath of fileList){
-            if(fs.existsSync(filePath)){
-                fileContents.push(fs.readFileSync(filePath, 'utf-8'));
-            }
-        }
-        const finalMD5 = crypto.createHash('md5').update(fileContents.join('\n')).digest('hex');
-        const cachedMD5 = fs.readFileSync(getCachedPath('checksum'), 'utf-8');
-
-        if(finalMD5 === cachedMD5){            
-            return false;
-        }
-    }        
-
-    return true;
-}
-
-async function main()
-{
-    const hasRebuild = paramsString.split(' ').pop().indexOf('--rebuild') > -1;
-    const doWarmCache = needsCacheWarming() || hasRebuild;  
-    
-    if(!((params[0] || false) && (params[1] || false) && (params[2] || false))){
-        throw new Error(`CLI command MUST have 3 parameters: {DB_URL, DB_NAME, MODELS_DIR}`);
-    }
-
-    if(doWarmCache){
-        console.log(chalk.yellow('[RWS DB CLI] Building CLI client...'));
-
-        const cacheTypes = ['paths', 'checksum'];
-
-        for(const type of cacheTypes){
-            if(fs.existsSync(getCachedPath(type))){
-                fs.unlinkSync(getCachedPath(type));
-            }
-        }
-
-        await tsc();
-
-        await rwsShell.runCommand(commandString, currentCwd);      
-       
-        
-    }else{
-        console.log(chalk.blue('[RWS CLI CACHE] Starting command from built CLI client.'));
-    }    
-
-    let startSlice = hasRebuild ? -1 : paramsString.split(' ').length;
-    let endSlice = hasRebuild ? -1 : null ;
-
-    paramsString = [
-        ...paramsString.split(' ').slice(0, startSlice), 
-        currentCwd, 
-        endSlice ? 
-            paramsString.split(' ').at(endSlice) 
-        : null
-    ].filter((item) => item !== null).join(' ');
-
-    await rwsShell.runCommand(`node ${path.join(currentCwd, 'build', 'main.cli.rws.js')}${paramsString}`, process.cwd());
-}
-
-async function tsc (){
-    const tempConfigContent = {
-        "extends": "./tsconfig.json",
-        "include": [
-            path.join(process.cwd(), params[2], 'index.ts')
-        ],           
-    };
-            
-    const tempConfigPath = path.join(currentCwd, '.tmp.gitignore.json');
-    fs.writeFileSync(tempConfigPath, JSON.stringify(tempConfigContent, null, 2));
-    
-    
-    await rwsShell.runCommand(`tsc -p ${tempConfigPath}`, currentCwd);                
-    fs.unlinkSync(tempConfigPath);        
-}
-
-main().then((data) => {
-    console.log(chalk.green('[RWS DB CLI] Command complete.'));
-}).catch((e) => {
-    console.error(e.message);
+#!/usr/bin/env node
+
+const { rwsShell, rwsPath } = require('@rws-framework/console');
+const chalk = require('chalk');
+const crypto = require('crypto');
+const path = require('path');
+const fs = require('fs');
+
+const params = process.argv.splice(2);
+let paramsString = params.length ? (' ' + params.join(' ')) : '';
+
+const appRoot = process.cwd();
+const rwsCliConfigDir = path.resolve(appRoot, 'node_modules', '.rws', 'cli');
+const getCachedPath = (key) => path.resolve(rwsCliConfigDir, key);
+
+const currentCwd = path.resolve(__dirname);
+
+console.log({params})
+
+
+const commandString = `npx webpack --config db.rws.webpack.config.js --output-path ./build ${process.cwd()} ${params[2]}`;
+function needsCacheWarming(){
+
+    if(!fs.existsSync(getCachedPath('paths')) || !fs.existsSync(getCachedPath('checksum'))){
+        return true;
+    }
+    
+    const fileList = fs.readFileSync(getCachedPath('paths'), 'utf-8').split('\n');    
+
+    if(fileList.length){
+        const fileContents = [];
+        for(const filePath of fileList){
+            if(fs.existsSync(filePath)){
+                fileContents.push(fs.readFileSync(filePath, 'utf-8'));
+            }
+        }
+        const finalMD5 = crypto.createHash('md5').update(fileContents.join('\n')).digest('hex');
+        const cachedMD5 = fs.readFileSync(getCachedPath('checksum'), 'utf-8');
+
+        if(finalMD5 === cachedMD5){            
+            return false;
+        }
+    }        
+
+    return true;
+}
+
+async function main()
+{
+    const hasRebuild = paramsString.split(' ').pop().indexOf('--rebuild') > -1;
+    const doWarmCache = needsCacheWarming() || hasRebuild;  
+    
+    if(!((params[0] || false) && (params[1] || false) && (params[2] || false))){
+        throw new Error(`CLI command MUST have 3 parameters: {DB_URL, DB_NAME, MODELS_DIR}`);
+    }
+
+    if(doWarmCache){
+        console.log(chalk.yellow('[RWS DB CLI] Building CLI client...'));
+
+        const cacheTypes = ['paths', 'checksum'];
+
+        for(const type of cacheTypes){
+            if(fs.existsSync(getCachedPath(type))){
+                fs.unlinkSync(getCachedPath(type));
+            }
+        }
+
+        await tsc();
+
+        await rwsShell.runCommand(commandString, currentCwd);      
+       
+        
+    }else{
+        console.log(chalk.blue('[RWS CLI CACHE] Starting command from built CLI client.'));
+    }    
+
+    let startSlice = hasRebuild ? -1 : paramsString.split(' ').length;
+    let endSlice = hasRebuild ? -1 : null ;
+
+    paramsString = [
+        ...paramsString.split(' ').slice(0, startSlice), 
+        currentCwd, 
+        endSlice ? 
+            paramsString.split(' ').at(endSlice) 
+        : null
+    ].filter((item) => item !== null).join(' ');
+
+    await rwsShell.runCommand(`node ${path.join(currentCwd, 'build', 'main.cli.rws.js')}${paramsString}`, process.cwd());
+}
+
+async function tsc (){
+    const tempConfigContent = {
+        "extends": "./tsconfig.json",
+        "include": [
+            path.join(process.cwd(), params[2], 'index.ts')
+        ],           
+    };
+            
+    const tempConfigPath = path.join(currentCwd, '.tmp.gitignore.json');
+    fs.writeFileSync(tempConfigPath, JSON.stringify(tempConfigContent, null, 2));
+    
+    
+    await rwsShell.runCommand(`tsc -p ${tempConfigPath}`, currentCwd);                
+    fs.unlinkSync(tempConfigPath);        
+}
+
+main().then((data) => {
+    console.log(chalk.green('[RWS DB CLI] Command complete.'));
+}).catch((e) => {
+    console.error(e.message);
 });