npm package: @nomadinteractive/generator-mens
Description: MENS Stack API model and CRUD endpoints generator with PlopJS
Author: Nomad Interactive
Latest version: 1.0.1

# MENS API model and CRUD endpoints generator with "Plop"

See "ployfile.js" for simple breakdown of inputs, actions for the sequalize model generation.

Read more about plop here: https://plopjs.com/


## Schema YML format

Below a sample API schema that contains all practical features we use on our api endpoints:

```yml
name:
  singular: government document
  plural: government documents
endpointPrefix: /api/v1/
fields:
  id: int#
  user_id: int*
  name: string+
  description:
    type: string
    required: true
  created_at: timestamp
```

Few additional markers in simple "type" annotation to be extended with:

- "*" character designates required (i.e: ```user_id: int*```)
- "+" character designates allowNull: false (i.e: ```name: string+```)
- "#" character designates primaryKey (required, allowNull: false and autoIncrement) (i.e: ```id: int#```)


#### Field object properties in the model yml

- ```type```: int/string/text/date/datetime/timestamp/enum
- ```required```: true/false
- ```primaryKey```: true/false
- ```allowNull```: true/false (default: true)
- ```autoIncrement```: true/false
- ```foreignKey```: true/false
- ```references```: (object) all object keys are mirrored directly in the sequalize model
- ```values```: [...]
- ```defaultValue```: ...


## Set up configuration file in your project:

Add following json configuration to your project root with .nomad-generators-config file:

```json
{
    "sequalize": {
        "models_path": "models"
    },
	"mens": {
		"controllers_directory": "controllers",
		"validators_directory": "validators",
		"database_file": "database.js",
		"database_file_prepend_pattern": "// $Generator: New Database Methods Here",
		"docs_tags_file": "docs/tags.js",
		"docs_tags_file_prepend_pattern": " *   # $Generator: New Tags Here",
		"docs_parameters_file": "docs/parameters.js",
		"docs_parameters_file_prepend_pattern": " *     # $Generator: New Parameters Here",
		"routes_file": "routes.js",
		"routes_prepend_patterns": {
			"controllers_imports": "// $Generator: New Controllers Imports Here",
			"validator_imports": "// $Generator: New Validator Imports Here",
			"controllers_init": "\t// $Generator: New Controllers Init Here",
			"validator_init": "\t// $Generator: New Validator Init Here",
			"endpoints"	: "\t// $Generator: New Endpoints Here"
		}
	}
}
```


## Install (as clonned code)

- ```npm install```
- ```npm run generate-crud <yml-file-path>```

Integrate with a MENS api boilerplate manually

Review all plopfile.js "modify" type actions and the pattern that are noted in the target files. These files are existing MENS structural files (database helper methods, router files, documentation...). Add the matching patterns to your own MESN boilerplate files (see output-example for a minimal skimmed version of MENS app files).


## Install (as package in parent/project)

Add the dependency and script to your package.json

devDependencies (or dependencies):
```npm install --save-dev @nomadinteractive/generator-mens```

scripts:
```"generate-crud": "nomad-generator-crud"```

Then, run
```npm install```
to install packages and register executable scripts


### Usage

To create a new model with yml schema:
```npm run generate-crud```

You can also send the yml parameter in this command as argument like:

```npm run generate-crud scheme.yml```


## TODOS (Future Capabilities)

- [ ] Add feature authRequired: true/false (overall or per endpoint)
- [ ] Add feature endpoint type based enable/disable (i.e: disable delete)
- [ ] Add feature for list returnFields (return object sanitization, so list endpoint only returns id, name, created_at for example)
- [ ] Add same returnFields feature to get single object endpoint's template
- [ ] Add feature for list / pagination: true
- [ ] Add feature for list filter: true
- [ ] Add feature for list sort: true

## License

[MIT](LICENSE.md)