Merge Release 5.7.1

.github/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# How to Contribue
+
+## Before making a Pull Request
+
+- Make sure all tests pass locally
+- Make sure you have run tslint & if something should come up, fix it to keep the code in one style
+- When you add documentation please make sure to keep the existing style
+- Make sure you read [Mastering-Markdown](https://guides.github.com/features/mastering-markdown/), thanks
+- Make sure when you make documentation of a something, you use the [TSDoc standard](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/), not JSDoc, thanks
+
+---
+
+## How to structure Commits
+
+```
+Some Title
+- moving fileA to folderB/
+- removing fileB
+- adding tests for FeatureX
+- adding `@prop({ optionA })`
+- adding tsdoc for FeatureX
+- modify README to include Docs about A
+- 
+```
+*Legend:*
+- add `[#1]` at the end when there is an issue for it (and modify it to the actual number)
+- the title should be a short introduction like (for small fixes)`Add @mapProp for Maps with tests` (for bigger)`Adding TSDoc`[preferably split the commits when they get to large with adding more features]
+- the first word should be "adding" "removing" "moving", expect if it cant be expressed with those
+
+*Note: if you make a Pull Request that dosnt conform with this structure, it will be first rebased and then merged*
+
+---
+*this is just the base, changes will occure*

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,34 @@
+---
+name: Bug
+about: Create a bug report
+title: ''
+labels: bug
+assignees: ''
+---
+
+---
+*please remove the parts in "---"*
+
+- In Versions, only include the Typegoose version you use (NPM or from GIT)
+- in "Code Example" add as many code blocks as needed
+- in "Do you know *why* it happenes replace the "*no*" if you know why
+
+---
+
+## Versions
+
+- NodeJS: 0.0.0
+- Typegoose(NPM): 0.0.0
+- Typegoose(GIT): commithash
+- mongoose: 0.0.0
+- mongodb: 0.0.0
+
+## Code Example
+
+```ts
+code here
+```
+
+## Do you know *why* it happenes?
+
+*no*

.github/ISSUE_TEMPLATE/feature parity.md

@@ -0,0 +1,30 @@
+---
+name: Feature parity
+about: Ask for feature parity with mongoose
+title: '[FP] '
+labels: parity
+assignees: ''
+---
+
+---
+*please remove the parts in "---"*
+
+## How to Structure your Feature Parity request
+
+- remove "not needed" from your parity below
+- Make sure you read [Mastering-Markdown](https://guides.github.com/features/mastering-markdown/), thanks
+
+---
+
+## Which feature
+
+- [Example Feature 1](documentation_link)
+- [Example Feature 2](documentation_link)
+
+## Why do you want it
+
+just because
+
+## Additional Notes
+
+- add it here

.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,25 @@
+---
+name: Feature
+about: Request a feature
+title: '[Request] '
+labels: request
+assignees: ''
+---
+
+---
+*please remove the parts in "---"*
+
+## How to Structure your Feature request
+
+- When you have an Implementation Idea, remove "*no*"
+- Make sure you read [Mastering-Markdown](https://guides.github.com/features/mastering-markdown/), thanks
+
+---
+
+## Describe what you need | want
+
+description here
+
+## Do you have already an idea for the implementation?
+
+*no*

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,18 @@
+---
+name: Question
+about: Ask a question
+title: '[Question] '
+labels: question
+assignees: ''
+---
+
+---
+*please remove the parts in "---"*
+
+## What to include in your Questions
+
+- Make sure you provide an understandable question
+- Make sure you provide all the needed code
+- Make sure you read [Mastering-Markdown](https://guides.github.com/features/mastering-markdown/), thanks
+
+---

.github/Notes to Maintainers.md

@@ -0,0 +1,19 @@
+# Notes to Maintainers
+
+## Before a Merge
+
+- Make sure Travis Builds a passing
+- Run the tests locally
+- Review the Pull-Request if something should be changed
+
+## How to Merge
+
+Try to to use Fast-Forward merge if it fits with the styles
+-> if it dosnt fit, rebase it manually
+
+## Versioning
+
+[look at README#Versioning](../README.md#versioning)
+
+---
+*this is just the base, changes will occure*

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+try to use an template, found at .github/PULL_REQUEST_TEMPLATE/
+[here](https://github.com/szokodiakos/typegoose/tree/master/.github/PULL_REQUEST_TEMPLATE)
+please dont forget to click on raw, and copy that, not the already "compiled" one

.github/PULL_REQUEST_TEMPLATE/docs.md

@@ -0,0 +1,16 @@
+
+---
+*please remove the parts in "---"*
+
+## Make sure you have done these steps
+
+- Make sure you have Read & followed these steps in [CONTRIBUTING](.github/CONTRIBUTING.md)
+- in "Adds Documentation for" remove the "(#) when there is no issue for it
+- remove the parts that are not applicable
+
+---
+
+## Adds Documentation for
+
+- @prop({ something }) (#1)
+- @prop({ something }) (#2)

.github/PULL_REQUEST_TEMPLATE/enhancement.md

@@ -0,0 +1,18 @@
+
+---
+*please remove the parts in "---"*
+
+## Make sure you have done these steps
+
+- Make sure you have Read & followed these steps in [CONTRIBUTING](.github/CONTRIBUTING.md)
+- remove the parts that are not applicable
+
+---
+
+## What does the Enchancement do
+
+*description here*
+
+## Related Issues/PR's
+
+- #1

.github/PULL_REQUEST_TEMPLATE/feature parity.md

@@ -0,0 +1,18 @@
+
+---
+*please remove the parts in "---"*
+
+## Make sure you have done these steps
+
+- Make sure you have Read & followed these steps in [CONTRIBUTING](.github/CONTRIBUTING.md)
+- remove the parts that are not applicable
+
+---
+
+## What Feature from mongoose
+
+*description here* [link](mongoose feature URL)
+
+## Related Issues/PR's
+
+- #1

.github/PULL_REQUEST_TEMPLATE/feature.md

@@ -0,0 +1,18 @@
+
+---
+*please remove the parts in "---"*
+
+## Make sure you have done these steps
+
+- Make sure you have Read & followed these steps in [CONTRIBUTING](.github/CONTRIBUTING.md)
+- remove the parts that are not applicable
+
+---
+
+## What does the Feature do
+
+*description here*
+
+## Related Issues/PR's
+
+- #1

.github/PULL_REQUEST_TEMPLATE/fix.md

@@ -0,0 +1,22 @@
+
+---
+*please remove the parts in "---"*
+
+this template is meant for "bug fixes" and "pr fixes"(if its an old pr, and gets remade with todays standards)
+
+## Make sure you have done these steps
+
+- Make sure you have Read & followed these steps in [CONTRIBUTING](.github/CONTRIBUTING.md)
+- remove the parts that are not applicable
+
+---
+
+## Collection of what it does / fixes
+
+- {mode} {description}
+- adds @prop({ alias })
+- moves filea to test/
+
+## Fixes Issues/PR's
+
+- #1

.github/SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+|  Version  | Supported          |
+| --------- | ------------------ |
+|   latest  | :white_check_mark: |
+| < latest  | :x:                |
+
+## Reporting a Vulnerability
+
+Because this is an open-source Project, it can be normally be reported as any other issue

.gitignore

@@ -222,3 +222,12 @@ $RECYCLE.BIN/
 build
 .env
 lib
+
+# ts's build info
+.tsbuildinfo
+
+# the config
+test/config.json
+
+# typedoc docs folder
+doc/

.mocharc.yml

@@ -0,0 +1,9 @@
+color: true
+recursive: true
+require: 
+  - "ts-node/register"
+  - "source-map-support/register"
+extension: 
+  - ts
+ui: "bdd"
+check-leaks: true

.npmignore

@@ -220,3 +220,6 @@ $RECYCLE.BIN/
 
 build
 .env
+
+# ts's build info
+.tsbuildinfo

.nycrc.json

@@ -0,0 +1,27 @@
+{
+  "extends": "@istanbuljs/nyc-config-typescript",
+  "extension": [
+    ".ts"
+  ],
+  "exclude": [
+    "**/*.d.ts"
+  ],
+  "include": [
+    "src/**/*.ts"
+  ],
+  "check-coverage": true,
+  "per-file": true,
+  "cache": true,
+  "all": true,
+  "reporter": [
+    "text",
+    "html"
+  ],
+  "sourceMap": true,
+  "instrument": true,
+  "_comment": "this below is just while porting to gitlab is going on",
+  "lines": 0,
+  "statements": 0,
+  "functions": 0,
+  "branches": 0
+}

.prettierrc

@@ -6,8 +6,7 @@
   "useTabs": false,
   "arrowParens": "avoid",
   "endOfLine": "auto",
-  "insertPragma": true,
-  "requirePragma": true,
+  "insertPragma": false,
   "printWidth": 120,
   "proseWrap": "always"
 }

.travis.yml

@@ -1,22 +1,13 @@
 language: node_js
-services:
-- mongodb
 node_js:
+# Test against oldest node version in package.json
+- "8"
+# Test against highest node version available
 - lts/*
-env:
-- USE_OLDEST_NPM_VERSIONS=0
-- USE_OLDEST_NPM_VERSIONS=1
-before_install:
-- |
-  if [ $USE_OLDEST_NPM_VERSIONS -eq 1 ]
-  then
-    # Test against oldest allowed versions in package.json - Use sed to remove ^ characters
-    sed -i 's/"\^/"/g' package.json
-    npm i [email protected] [email protected]
-  else
-    npm i mongoose reflect-metadata
-  fi
 script:
+# Audit to make sure there are no vulnerabilities, but do not affect the whole build
+- (npm audit || exit 0)
+# Test everything
 - npm test
 deploy:
   provider: npm
@@ -29,4 +20,8 @@ deploy:
       only:
       - master
 after_success:
-- npm run coverage
+# Generate the Coverage only for one version
+- |
+  if [[ $TRAVIS_NODE_VERSION == "lts/*" ]]; then
+    npm run coverage
+  fi