@fplpool/fpl-models 1.0.0 → 1.1.1

package/src/models/pool-wallet.model.ts

@@ -1,89 +0,0 @@
-import { Schema, model, Types, Document } from "mongoose";
-import config from "../config";
-import { poolAmountPattern } from "./pool-transaction.model";
-
-
-
-export interface IPoolWallet extends Document {
-    _id: Types.ObjectId;
-    pool: Types.ObjectId;
-    balance: string;
-    availableBalance: string;
-    createdAt: Date;
-    updatedAt: Date;
-}
-
-const poolWalletSchema = new Schema<IPoolWallet>({
-    pool: {
-        type: Schema.Types.ObjectId, 
-        ref: config.models.pool,
-        required: true
-    },
-    balance: {
-        type: String,
-        required: true,
-        match: poolAmountPattern,
-        set: function(value: string) {
-            // If value already looks like a float (has a .), ensure two decimals
-            if (typeof value === "string") {
-                if (poolAmountPattern.test(value)) {
-                    // If it has a dot but is not two decimals, pad right
-                    if (value.indexOf('.') !== -1) {
-                        let [whole, decimals] = value.split('.');
-                        if (decimals === undefined) return whole + ".00";
-                        if (decimals.length === 1) return whole + "." + decimals + "0";
-                        if (decimals.length === 2) return value;
-                        if (decimals.length > 2) return whole + "." + decimals.slice(0,2);
-                    }
-                    // No decimal: add .00
-                    return value + ".00";
-                }
-                // If it's an integer, add .00
-                if (/^\d+$/.test(value)) {
-                    return value + ".00";
-                }
-            }
-            return value;
-        },
-        default: "0.00"
-    },
-    availableBalance: {
-        type: String,
-        required: false,
-        match: poolAmountPattern,
-        set: function(value: string) {
-            // If value already looks like a float (has a .), ensure two decimals
-            if (typeof value === "string") {
-                if (poolAmountPattern.test(value)) {
-                    // If it has a dot but is not two decimals, pad right
-                    if (value.indexOf('.') !== -1) {
-                        let [whole, decimals] = value.split('.');
-                        if (decimals === undefined) return whole + ".00";
-                        if (decimals.length === 1) return whole + "." + decimals + "0";
-                        if (decimals.length === 2) return value;
-                        if (decimals.length > 2) return whole + "." + decimals.slice(0,2);
-                    }
-                    // No decimal: add .00
-                    return value + ".00";
-                }
-                // If it's an integer, add .00
-                if (/^\d+$/.test(value)) {
-                    return value + ".00";
-                }
-            }
-            return value;
-        },
-        default: "0.00"
-    }
-}, {
-    timestamps: true,
-    toJSON: {virtuals: true},
-    toObject: {virtuals: true}
-})
-
-
-
-
-const PoolWallet = model<IPoolWallet>(config.models.poolWallet, poolWalletSchema);
-
-export default PoolWallet;

package/src/models/session.model.ts

@@ -1,45 +0,0 @@
-import {Schema, model, Types, Document} from "mongoose";
-
-import config from "../config";
-
-
-
-
-export interface ISession extends Document{
-    _id: Types.ObjectId;
-    user: Types.ObjectId;
-    userAgent: String;
-    device: Object;
-    expired: Boolean;
-    createdAt: Date;
-    updatedAt: Date;
-}
-
-
-const sessionSchema = new Schema<ISession>({
-    user: {
-        type: Schema.Types.ObjectId,
-        ref: config.models.user,
-        required: true
-    },
-    device: Object,
-    userAgent: String,
-    expired: {
-        required: true,
-        type: Boolean,
-        default: false
-    },
-}, 
-{
-    timestamps: true,
-    toJSON: {virtuals: true},
-    toObject: {virtuals: true}
-});
-
-
-
-
-const Session = model<ISession>(config.models.session, sessionSchema);
-
-
-export default Session;

package/src/models/wallet.model.ts

@@ -1,154 +0,0 @@
-import {Schema, model, Types, Document} from "mongoose";
-
-import config from "../config";
-import { poolAmountPattern } from "./pool-transaction.model";
-import { ITransaction } from "./transaction.model";
-import AdvancedError from "../errors/advanced.error";
-import StatusCode from "../enums/status-code.enum";
-import { TransactionStatus, TransactionType } from "../types/wallet";
-import transactionLogger from "../loggers/transaction";
-
-
-
-export interface IWallet extends Document {
-    _id: Types.ObjectId;
-    user: Types.ObjectId;
-    cards: Types.ObjectId[];
-    balance: string;
-    availableBalance: string;
-    customerId?: string;
-    createdAt: Date;
-    updatedAt: Date;
-    debit: (transaction: ITransaction) => Promise<void>;
-    refund: (transaction: ITransaction) => Promise<void>;
-}
-
-
-
-const walletSchema = new Schema<IWallet>({
-    user: {
-        type: Schema.Types.ObjectId,
-        ref: config.models.user,
-        required: true,
-        unique: [true, 'User already has a wallet'],
-    },
-    customerId: {
-        type: String,
-        required: false,
-        default: null,
-        unique: true
-    },
-    cards: [{
-        type: Schema.Types.ObjectId,
-        ref: config.models.card
-    }],
-    balance: {
-        type: String,
-        required: true,
-        match: poolAmountPattern,
-        set: function(value: string) {
-            // If value already looks like a float (has a .), ensure two decimals
-            if (typeof value === "string") {
-                if (poolAmountPattern.test(value)) {
-                    // If it has a dot but is not two decimals, pad right
-                    if (value.indexOf('.') !== -1) {
-                        let [whole, decimals] = value.split('.');
-                        if (decimals === undefined) return whole + ".00";
-                        if (decimals.length === 1) return whole + "." + decimals + "0";
-                        if (decimals.length === 2) return value;
-                        if (decimals.length > 2) return whole + "." + decimals.slice(0,2);
-                    }
-                    // No decimal: add .00
-                    return value + ".00";
-                }
-                // If it's an integer, add .00
-                if (/^\d+$/.test(value)) {
-                    return value + ".00";
-                }
-            }
-            return value;
-        },
-        default: "0.00"
-    },
-    availableBalance: {
-        type: String,
-        required: false,
-        match: poolAmountPattern,
-        set: function(value: string) {
-            // If value already looks like a float (has a .), ensure two decimals
-            if (typeof value === "string") {
-                if (poolAmountPattern.test(value)) {
-                    // If it has a dot but is not two decimals, pad right
-                    if (value.indexOf('.') !== -1) {
-                        let [whole, decimals] = value.split('.');
-                        if (decimals === undefined) return whole + ".00";
-                        if (decimals.length === 1) return whole + "." + decimals + "0";
-                        if (decimals.length === 2) return value;
-                        if (decimals.length > 2) return whole + "." + decimals.slice(0,2);
-                    }
-                    // No decimal: add .00
-                    return value + ".00";
-                }
-                // If it's an integer, add .00
-                if (/^\d+$/.test(value)) {
-                    return value + ".00";
-                }
-            }
-            return value;
-        },
-        default: "0.00"
-    }
-}, {
-    timestamps: true,
-    toJSON: {virtuals: true},
-    toObject: {virtuals: true}
-})
-
-
-walletSchema.methods.debit = async function(transaction: ITransaction): Promise<void> {
-    try{
-        if(transaction.type !== TransactionType.Debit) throw new AdvancedError('Invalid debit transaction', StatusCode.BAD_REQUEST);
-        if(transaction.status === TransactionStatus.Failed) throw new AdvancedError('This transaction has already failed', StatusCode.BAD_REQUEST);
-
-        //at this point the wallet was found
-        let hasEnoughBalance = parseFloat(this.balance) >= parseFloat(transaction.amount);
-        if(!hasEnoughBalance) throw new AdvancedError('Insufficient balance', StatusCode.BAD_REQUEST);
-
-        //at this point the wallet has enough funds to make the debit
-        if(transaction.status === TransactionStatus.Pending) throw new AdvancedError('This transaction is still pending', StatusCode.BAD_REQUEST);
-
-        //at this point the status is completed
-        this.balance = (parseFloat(this.balance) - parseFloat(transaction.amount)).toString();
-        transactionLogger.info("[*] Wallet debited", {wallet: this.toJSON(), transaction: transaction.toJSON()});
-
-        await this.save();
-    }catch(e: any){
-        transactionLogger.error("[*] Error debiting wallet", {error: e.message, stack: e.stack});
-        throw new AdvancedError(e.message, e.statusCode || StatusCode.INTERNAL_SERVER_ERROR)
-    }
-}
-
-
-walletSchema.methods.refund = async function(transaction: ITransaction): Promise<void> {
-    try{
-        //check that the transaction is a debit transaction
-        if(transaction.type !== TransactionType.Debit) throw new AdvancedError("Cannot refund a credit transaction", StatusCode.BAD_REQUEST);
-        if(transaction.status !== TransactionStatus.Failed) throw new AdvancedError("Cannot refund a successful or pending transaction", StatusCode.BAD_REQUEST);
-
-        //at this point the transaction checks out
-        //now we can refund the balance to their available balance, since we deducted it from their available balance only
-        this.availableBalance = parseFloat(this.availableBalance) + parseFloat(transaction.amount);
-        transactionLogger.info("[*] Wallet refunded", {wallet: this.toJSON(), transaction: transaction.toJSON()});
-
-        await this.save();
-    }catch(e: any){
-        transactionLogger.error("[*] Error refunding wallet", {error: e.message, stack: e.stack});
-        throw new AdvancedError(e.message, e.statusCode || StatusCode.INTERNAL_SERVER_ERROR)
-    }
-}
-
-
-const Wallet = model<IWallet>(config.models.wallet, walletSchema);
-
-
-export default Wallet;

package/src/repositories/generic.repository.ts

@@ -1,86 +0,0 @@
-import { Model, PipelineStage, Types, UpdateQuery, QueryFilter } from "mongoose";
-
-
-
-export default class GenericRepository<U> {
-
-    public constructor(public readonly model: Model<U>){}
-
-    public async create(data: Partial<U>): Promise<U>{
-        const newEntity = await this.model.create(data)
-        await newEntity.save()
-
-        console.log(`Entity created: ${newEntity.toJSON()}`)
-
-        return newEntity
-    }
-
-
-    public async get(filters: QueryFilter<U>, populate: string[] = []): Promise<U | null>{
-        const entity = await this.model.findOne(filters).populate(populate)
-
-        return entity
-    }
-
-
-    public async aggregate(pipeline: PipelineStage[]): Promise<any[]> {
-        const result = await this.model.aggregate(pipeline).exec();
-
-        return result;
-    }
-
-    
-    public async exists(filters: QueryFilter<U>): Promise<boolean>{
-        const entity = await this.model.exists(filters);
-        return entity ? true : false
-    } 
-
-    
-    public async count(filters: QueryFilter<U>): Promise<number>{
-        const count = await this.model.countDocuments(filters);
-        
-        return count
-    }
-
-
-    public async getAll(filters: QueryFilter<U>, populate: string[] = []): Promise<U[]>{
-        const entities = await this.model.find(filters).populate(populate);
-        
-        return entities
-    }
-
-
-    public async getAllWithoutVirtuals(filters: QueryFilter<U>, virtuals: boolean, populate: string[] = []): Promise<U[]> {
-        const entities = await this.model.find(filters).populate(populate).lean({virtuals});
-
-        return entities as U[];
-    }
-
-
-    public async paginate(filters: QueryFilter<U>, populate: string[] = [], limit: number = 20, page: number=1, order: 'asc' | 'desc' = 'desc'): Promise<U[]>{
-        const entities = await this.model.find(filters).skip(limit * (page - 1)).limit(limit).populate(populate).sort({createdAt: order});
-        
-        return entities
-    }
-
-
-    public async update(id: Types.ObjectId, entity: UpdateQuery<U>): Promise<U | null>{
-        const updatedEntity = await this.model.findByIdAndUpdate(id, entity, {new: true})
-        
-        return updatedEntity
-    }
-    
-
-    public async delete(id: Types.ObjectId): Promise<U | null>{
-        const deletedEntity = await this.model.findByIdAndDelete(id)
-        
-        return deletedEntity
-    }
-
-
-    public async deleteMany(filters: QueryFilter<U>): Promise<void> {
-        await this.model.deleteMany(filters);
-        console.log(`Entities deleted: ${filters}`);
-    }
-
-}

package/tsconfig.json

@@ -1,103 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig to read more about this file */
-
-    /* Projects */
-    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
-    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
-    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
-    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
-    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
-    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
-
-    /* Language and Environment */
-    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
-    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
-    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
-    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
-    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
-    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
-    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
-    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
-    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
-    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
-    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
-    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
-
-    /* Modules */
-    "module": "commonjs",                                /* Specify what module code is generated. */
-    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
-    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
-    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
-    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
-    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
-    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
-    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
-    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
-    // "resolveJsonModule": true,                        /* Enable importing .json files. */
-    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
-
-    /* JavaScript Support */
-    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
-    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
-    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
-
-    /* Emit */
-    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
-    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
-    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
-    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
-    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
-    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
-    // "removeComments": true,                           /* Disable emitting comments. */
-    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
-    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
-    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
-    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
-    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
-    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
-    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
-    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
-    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
-    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
-    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
-    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
-    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
-    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
-    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
-
-    /* Interop Constraints */
-    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
-    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
-    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
-    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
-
-    /* Type Checking */
-    "strict": true,                                      /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
-    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
-    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
-    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
-    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
-    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
-    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
-    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
-    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
-    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
-    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
-    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
-    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
-    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
-    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
-    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
-    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
-
-    /* Completeness */
-    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
-    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
-  }
-}