c2-mongoose 1.0.0

package/README.md

@@ -0,0 +1,92 @@
+# c2-mongoose
+
+
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+
+## Add your files
+
+- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
+- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+
+```
+cd existing_repo
+git remote add origin https://gitlab.com/cabral_consultoria/c2-mongoose.git
+git branch -M main
+git push -uf origin main
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project integrations](https://gitlab.com/cabral_consultoria/c2-mongoose/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
+- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

package/dist/src/configuration/Environment.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dbCollation = void 0;
+exports.dbCollation = process.env.DB_COLLACTION;
+exports.default = process.env;

package/dist/src/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Search = void 0;
+exports.Search = __importStar(require("./model/Search"));

package/dist/src/model/Search.js

@@ -0,0 +1,174 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Environment_1 = require("../configuration/Environment");
+const Utils_1 = require("../utils/Utils");
+class Search {
+    constructor(params) {
+        this.buildPopulate = () => {
+            if ((0, Utils_1.isEmpty)(this.populate)) {
+                return;
+            }
+            var propertiesArray = this.populate.split(',');
+            var populates = [];
+            for (var property of propertiesArray) {
+                let [first, ...rest] = property.split('.');
+                let nested = rest.join('.');
+                populates.push(this.buildPath(first, nested));
+            }
+            this.populate = populates;
+        };
+        this.buildPath = (target, nested = "") => {
+            var populate = {};
+            populate.path = target;
+            if ((0, Utils_1.isNotEmpty)(nested)) {
+                let [first, ...rest] = nested.split('.');
+                let nested2 = rest.join('.');
+                populate.populate = this.buildPath(first, nested2);
+            }
+            return populate;
+        };
+        this.buildOrdenation = () => {
+            let order = {};
+            this.orderBy = this.orderBy || "_id";
+            order[this.orderBy] = this.order === "desc" ? -1 : 1;
+            return order;
+        };
+        this.isPageable = () => {
+            if (this.page >= 0) {
+                return true;
+            }
+            return false;
+        };
+        this.diacriticSensitiveRegex = (string = "") => {
+            return string
+                .replace(/[a|á|à|ä|â|A|Á|Â|Ã|Ä]/g, '[a,á,à,ä,â,A,Á,Â,Ã,Ä]')
+                .replace(/[e|é|ë|è|E|É|Ë|È]/g, '[e,é,ë,è,E,É,Ë,È]')
+                .replace(/[i|í|ï|ì|I|Í|Ï|Ì]/g, '[i,í,ï,ì,I,Í,Ï,Ì]')
+                .replace(/[o|ó|ö|ò|õ|O|Ó|Ö|Ô|Õ]/g, '[o,ó,ö,ò,õ,O,Ó,Ö,Ô,Õ]')
+                .replace(/[u|ü|ú|ù|U|Ú|Ü|Ù]/g, '[u,ü,ú,ù,U,Ú,Ü,Ù]')
+                .replace(/[ç|Ç|c|C]/g, '[c,C,ç,Ç]');
+        };
+        this.search = (model) => __awaiter(this, void 0, void 0, function* () {
+            if (this.isPageable()) {
+                return yield this.searchPageable(model);
+            }
+            return yield this.searchNoPageable(model);
+        });
+        this.searchPageable = (model) => __awaiter(this, void 0, void 0, function* () {
+            const sort = this.buildOrdenation();
+            var items = yield model
+                .find(this.filters, this.select)
+                .populate(this.populate)
+                .skip(this.page * this.limit)
+                .limit(this.limit)
+                .sort(sort)
+                .collation({
+                locale: Environment_1.dbCollation || "pt"
+            });
+            return this.result(model, items);
+        });
+        this.searchNoPageable = (model) => __awaiter(this, void 0, void 0, function* () {
+            const sort = this.buildOrdenation();
+            var items = yield model
+                .find(this.filters, this.select)
+                .populate(this.populate)
+                .sort(sort)
+                .collation({
+                locale: Environment_1.dbCollation || "pt"
+            });
+            return this.result(model, items);
+        });
+        this.result = (model, items) => __awaiter(this, void 0, void 0, function* () {
+            var total = yield this.count(model);
+            var paging = {};
+            paging.total = total;
+            paging.page = this.page;
+            paging.limit = this.limit;
+            var searchResponse = {};
+            searchResponse.items = items;
+            searchResponse.paging = paging;
+            return searchResponse;
+        });
+        this.count = (model) => __awaiter(this, void 0, void 0, function* () {
+            return yield model.countDocuments(this.filters).exec();
+        });
+        this.sumBy = (model, _sum, _by) => __awaiter(this, void 0, void 0, function* () {
+            const ret = yield model.aggregate([
+                {
+                    '$match': this.filters
+                },
+                {
+                    $group: {
+                        _id: _by,
+                        totalValue: { "$sum": _sum },
+                        count: { "$sum": 1 }
+                    }
+                }
+            ]);
+            return ret;
+        });
+        this.buildDefaultFilters = (objectSearch) => {
+            let filters = { $and: [] };
+            Object.entries(objectSearch).forEach(([key, value]) => {
+                if ((0, Utils_1.isNotEmpty)(value)) {
+                    let condition = {};
+                    if (['order', 'orderBy', 'properties', 'populate', 'page', 'limit', 'model', 'searchText'].includes(key)) {
+                        return;
+                    }
+                    if (key.endsWith('DateRange')) {
+                        var keyAux = key.replace('Range', '');
+                        var values = value;
+                        if ((0, Utils_1.isNotEmpty)(values[0])) {
+                            condition[keyAux] = Object.assign(Object.assign({}, condition[keyAux]), { $gte: new Date(values[0]) });
+                        }
+                        if ((0, Utils_1.isNotEmpty)(values[1])) {
+                            condition[keyAux] = Object.assign(Object.assign({}, condition[keyAux]), { $lte: new Date(values[1]) });
+                        }
+                    }
+                    else {
+                        if (!Array.isArray(value)) {
+                            condition[key] = value;
+                        }
+                        else {
+                            condition[key] = { $in: value };
+                        }
+                    }
+                    filters.$and.push(condition);
+                }
+            });
+            if ((0, Utils_1.isNotEmpty)(objectSearch.model)) {
+                this.addFilterModel(objectSearch.model, filters);
+            }
+            if (filters.$and.length === 0)
+                delete filters['$and'];
+            return filters;
+        };
+        this.addFilterModel = (model, filters) => {
+            Object.entries(model).forEach(([key, value]) => {
+                if ((0, Utils_1.isNotEmpty)(value)) {
+                    let condition = {};
+                    condition[key] = value;
+                    filters.$and.push(condition);
+                }
+            });
+        };
+        this.searchText = params.searchText || "";
+        this.order = params.order || "asc";
+        this.orderBy = params.orderBy || "_id";
+        this.select = params.select;
+        this.populate = params.populate;
+        this.page = params.page || -1;
+        this.limit = params.limit || 25;
+        this.buildPopulate();
+    }
+}
+exports.default = Search;

package/dist/src/utils/Utils.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareDesc = exports.compareAsc = exports.isNotIterable = exports.isIterable = exports.isEmpty = exports.isNotEmpty = void 0;
+const isNotEmpty = (obj) => {
+    return !(0, exports.isEmpty)(obj);
+};
+exports.isNotEmpty = isNotEmpty;
+const isEmpty = (obj) => {
+    if (!obj) {
+        return true;
+    }
+    if (Array.isArray(obj)) {
+        if (obj.length == 0) {
+            return true;
+        }
+    }
+    if (obj === "") {
+        return true;
+    }
+    return false;
+};
+exports.isEmpty = isEmpty;
+const isIterable = (input) => {
+    if (input === null || input === undefined) {
+        return false;
+    }
+    if ('string' === typeof input) {
+        return false;
+    }
+    return typeof input[Symbol.iterator] === 'function';
+};
+exports.isIterable = isIterable;
+const isNotIterable = (input) => {
+    return !(0, exports.isIterable)(input);
+};
+exports.isNotIterable = isNotIterable;
+const compareAsc = (a, b) => {
+    if (a._id < b._id) {
+        return -1;
+    }
+    if (a._id > b._id) {
+        return 1;
+    }
+    return 0;
+};
+exports.compareAsc = compareAsc;
+const compareDesc = (a, b) => {
+    if (a._id > b._id) {
+        return -1;
+    }
+    if (a._id < b._id) {
+        return 1;
+    }
+    return 0;
+};
+exports.compareDesc = compareDesc;

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "c2-mongoose",
+  "version": "1.0.0",
+  "description": "Lib to make any search in database mongoose and use as basic crud",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/cabral_consultoria/c2-mongoose.git"
+  },
+  "keywords": [
+    "mongoose",
+    "crud"
+  ],
+  "author": "Cabral Consultoria e Assessoria em Software",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://gitlab.com/cabral_consultoria/c2-mongoose/issues"
+  },
+  "homepage": "https://gitlab.com/cabral_consultoria/c2-mongoose#readme",
+  "dependencies": {
+    "dotenv": "^16.0.3",
+    "mongoose": "^7.0.1"
+  }
+}

package/src/configuration/Environment.ts

@@ -0,0 +1,3 @@
+export const dbCollation = process.env.DB_COLLACTION as string
+
+export default process.env

package/src/index.ts

@@ -0,0 +1 @@
+export * as Search from "./model/Search"

package/src/model/Search.ts

@@ -0,0 +1,208 @@
+import mongoose from "mongoose"
+import { dbCollation } from "../configuration/Environment"
+import { isEmpty, isNotEmpty } from "../utils/Utils"
+
+abstract class Search {
+  searchText: string
+  order: string
+  orderBy: string
+  page: number
+  limit: number
+  select: string
+  populate: string | [] | any
+  filters: any
+
+  constructor(params: any) {
+    this.searchText = params.searchText || ""
+    this.order = params.order || "asc"
+    this.orderBy = params.orderBy || "_id"
+    this.select = params.select
+    this.populate = params.populate
+    this.page = params.page || -1
+    this.limit = params.limit || 25
+    this.buildPopulate()
+  }
+
+  public buildPopulate = (): any => {
+    if (isEmpty(this.populate)) {
+      return
+    }
+    var propertiesArray = this.populate.split(',')
+    var populates = [] as any
+    for (var property of propertiesArray) {
+      let [first, ...rest] = property.split('.')
+      let nested = rest.join('.')
+      populates.push(this.buildPath(first, nested))
+    }
+
+    this.populate = populates
+  }
+
+  public buildPath = (target: string, nested: string = "") => {
+    var populate = {} as any
+    populate.path = target
+    if (isNotEmpty(nested)) {
+      let [first, ...rest] = nested.split('.')
+      let nested2 = rest.join('.')
+      populate.populate = this.buildPath(first, nested2)
+    }
+    return populate
+  }
+
+  public buildOrdenation = () => {
+    let order = {} as any
+    this.orderBy = this.orderBy || "_id"
+    order[this.orderBy] = this.order === "desc" ? -1 : 1
+    return order
+  }
+
+  private isPageable = () => {
+    if (this.page >= 0) {
+      return true
+    }
+
+    return false
+  }
+
+  private diacriticSensitiveRegex = (string = "") => {
+    return string
+      .replace(/[a|á|à|ä|â|A|Á|Â|Ã|Ä]/g, '[a,á,à,ä,â,A,Á,Â,Ã,Ä]')
+      .replace(/[e|é|ë|è|E|É|Ë|È]/g, '[e,é,ë,è,E,É,Ë,È]')
+      .replace(/[i|í|ï|ì|I|Í|Ï|Ì]/g, '[i,í,ï,ì,I,Í,Ï,Ì]')
+      .replace(/[o|ó|ö|ò|õ|O|Ó|Ö|Ô|Õ]/g, '[o,ó,ö,ò,õ,O,Ó,Ö,Ô,Õ]')
+      .replace(/[u|ü|ú|ù|U|Ú|Ü|Ù]/g, '[u,ü,ú,ù,U,Ú,Ü,Ù]')
+      .replace(/[ç|Ç|c|C]/g, '[c,C,ç,Ç]')
+  }
+
+  public search = async (model: mongoose.Model<any>): Promise<SearchResponse<any>> => {
+    if (this.isPageable()) {
+      return await this.searchPageable(model)
+    }
+
+    return await this.searchNoPageable(model)
+  }
+
+  private searchPageable = async (model: mongoose.Model<any>): Promise<SearchResponse<any>> => {
+    const sort = this.buildOrdenation()
+    var items = await model
+      .find(this.filters, this.select)
+      .populate(this.populate)
+      .skip(this.page * this.limit)
+      .limit(this.limit)
+      .sort(sort)
+      .collation({
+        locale: dbCollation || "pt"
+      }) as []
+
+    return this.result(model, items)
+  }
+
+  private searchNoPageable = async (model: mongoose.Model<any>): Promise<SearchResponse<any>> => {
+    const sort = this.buildOrdenation()
+    var items = await model
+      .find(this.filters, this.select)
+      .populate(this.populate)
+      .sort(sort)
+      .collation({
+        locale: dbCollation || "pt"
+      }) as []
+
+    return this.result(model, items)
+  }
+
+  private result = async (model: mongoose.Model<any>, items: []): Promise<SearchResponse<any>> => {
+    var total = await this.count(model)
+
+    var paging: Paging = {}
+    paging.total = total
+    paging.page = this.page
+    paging.limit = this.limit
+
+    var searchResponse: SearchResponse<any> = {}
+    searchResponse.items = items
+    searchResponse.paging = paging
+
+    return searchResponse
+  }
+
+  public count = async (model: mongoose.Model<any>): Promise<number> => {
+    return await model.countDocuments(this.filters).exec()
+  }
+
+  public sumBy = async (model: mongoose.Model<any>, _sum: any, _by: any): Promise<any[]> => {
+    const ret = await model.aggregate(
+      [
+        {
+          '$match': this.filters
+        },
+        {
+          $group: {
+            _id: _by,
+            totalValue: { "$sum": _sum },
+            count: { "$sum": 1 }
+          }
+        }
+      ]
+    )
+    return ret
+  }
+
+  public buildDefaultFilters = (objectSearch: any) => {
+    let filters = { $and: [] } as any
+    Object.entries(objectSearch).forEach(([key, value]) => {
+      if (isNotEmpty(value)) {
+        let condition = {} as any
+        if (['order', 'orderBy', 'properties', 'populate', 'page', 'limit', 'model', 'searchText'].includes(key)) {
+          return
+        }
+
+        if (key.endsWith('DateRange')) {
+          var keyAux = key.replace('Range', '')
+          var values = value as any
+          if (isNotEmpty(values[0])) {
+            condition[keyAux] = {
+              ...condition[keyAux],
+              $gte: new Date(values[0])
+            }
+          }
+
+          if (isNotEmpty(values[1])) {
+            condition[keyAux] = {
+              ...condition[keyAux],
+              $lte: new Date(values[1])
+            }
+          }
+        } else {
+          if (!Array.isArray(value)) {
+            condition[key] = value
+          } else {
+            condition[key] = { $in: value }
+          }
+        }
+        filters.$and.push(condition)
+      }
+    })
+
+
+    if (isNotEmpty(objectSearch.model)) {
+      this.addFilterModel(objectSearch.model, filters)
+    }
+
+    if (filters.$and.length === 0)
+      delete filters['$and']
+
+    return filters
+  }
+
+  public addFilterModel = (model: any, filters: any) => {
+    Object.entries(model).forEach(([key, value]) => {
+      if (isNotEmpty(value)) {
+        let condition = {} as any
+        condition[key] = value
+        filters.$and.push(condition)
+      }
+    })
+  }
+}
+
+export default Search

package/src/types/SearchResponse.d.ts

@@ -0,0 +1,10 @@
+declare interface SearchResponse<T> {
+    paging?: Paging,
+    items?: T[]
+}
+
+declare interface Paging {
+    total?: number,
+    page?: number,
+    limit?: number
+}

package/src/utils/Utils.ts

@@ -0,0 +1,57 @@
+export const isNotEmpty = (obj: any) => {
+    return !isEmpty(obj)
+}
+
+export const isEmpty = (obj: any) => {
+    if (!obj) {
+        return true
+    }
+
+    if (Array.isArray(obj)) {
+        if (obj.length == 0) {
+            return true
+        }
+    }
+
+    if (obj === "") {
+        return true
+    }
+
+    return false
+}
+
+export const isIterable = (input: any) => {
+    if (input === null || input === undefined) {
+        return false
+    }
+
+    if ('string' === typeof input) {
+        return false
+    }
+
+    return typeof input[Symbol.iterator] === 'function'
+}
+
+export const isNotIterable = (input: any) => {
+    return !isIterable(input)
+}
+
+export const compareAsc = (a: any, b: any) => {
+    if (a._id < b._id) {
+        return -1;
+    }
+    if (a._id > b._id) {
+        return 1;
+    }
+    return 0;
+}
+
+export const compareDesc = (a: any, b: any) => {
+    if (a._id > b._id) {
+        return -1;
+    }
+    if (a._id < b._id) {
+        return 1;
+    }
+    return 0;
+}

package/tsconfig.json

@@ -0,0 +1,104 @@
+{
+  "include": [
+    "**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ],
+  "buildOnSave": true,
+  "compileOnSave": true,
+  "declaration": true,
+  "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": "./dist",                                   /* 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. */
+  }
+}