Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-masters/node-lib
It's very useful, but just for us at App Masters. To you it must be a useless code mess.
https://github.com/app-masters/node-lib
Last synced: 8 days ago
JSON representation
It's very useful, but just for us at App Masters. To you it must be a useless code mess.
- Host: GitHub
- URL: https://github.com/app-masters/node-lib
- Owner: app-masters
- Created: 2017-10-26T20:00:54.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-06T16:27:37.000Z (over 1 year ago)
- Last Synced: 2024-04-14T02:52:47.179Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.25 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# node-lib
# apiBootstrap
A short start to App Masters APIs:
```
// Requires for bootstrap
const express = require('express');
const app = express();
const envs = require('./config/config');
const packag = require('./package');
const passport = require('passport');
const userSchema = require('./app/model/userSchema');
const apiBootstrap = require('./apiBoostrap');
// 1 - Api Bootstrap tests
apiBootstrap.setup(app, envs, packag, passport);
// 2 - Include Routes
require('./app/routes')(app);
// 3 - Listen API
apiBootstrap.listen(app);
```
### Environment
When using the `apiBootstrapS`, you can use a local development variables.
Create a .env file in the project root and set the variables.
Right now, the bootstrap is accepting:
````
DATABASE_URL=postgres://...?ssl=true //If not set here, must be specified on config file
````
### Config
```
{
security:{
singleLoginSignup:true // will enable login and signup at same route: /login/
}
}
```
# nodeRestful
Easy [node-restful](https://github.com/baugarten/node-restful) use with less code and more resources.
### registerRoute
Will register a route with node-restful.
```
let route = {
route: '/api/user',
modelName: 'user',
schema: mySchema,
};
nodeRestful.registerRoute(app, router, routeParams);
```
### registerMultipleRoutes
Do same as registerRoute, but receiving an array of routes.
## exposeModelMethods
Allow to call a model method directly from rest route.
Eg: `http://myapi.com/user/5a3168e1f60a471f02fb92f5/sendGreetings` will call referred user `user.sendGreetings()`.
First it will check for `mongoose.model(yourModel).sendGreetings` method, if it found, well be called `mongoose.model(yourModel).sendGreetings(5a3168e1f60a471f02fb92f5)`.
If the method don't exists on mongoose model, will check on model instance, like `mongoose.model(yourModel).find(5a3168e1f60a471f02fb92f5).sendGreetings`, if it exists will be called without any parameter.
To all of this work you just need pass `exposeModelMethods` to registerRoute.
```
let route = {
route: '/api/user',
modelName: 'user',
schema: mySchema,
exposeModelMethods: ['sendGreetings','getMoreData','sendMoreSpam']
};
nodeRestful.registerRoute(app, router, routeParams);
```
# amMailing
# amInvite
Add invite key on api config file:
```
envs.development = {
invite: {
singleUserLink: true,
baseUrlAndRoute: 'http://publicurl.com/invite/',
sendEmail: true
}
};
```
If you want to know if some user accept an invite, call somewhere:
```
AMInvite.setAcceptCallback((invite=>{
// invite have all data you need
}));
```
#### Examples:
- https://gitlab.com/app-masters/lowcarb-app/blob/dev/api/src/app/routes/invite.js
````
http://emagrecaja.com.br/convite/0197039120321730918
http://eisaquestao.ufjf.br/amigo/0197039120321730918
````
# Message
Allow to manage the message sending.
#### Configuration
- On the config.js file, set the message config (this file will be used as a parameter in the message.setup(config) method).
- The example bellow sets a configuration object for the 'feedback' message key that will save on the de dataBase (saveToDb: boolean).
- message.fields sets the fields expected and the correspond string that will be displayed to the final user.
```javascript
const message = {
feedback: {
to: "[email protected]",
subject: "Feedback de uso",
saveToDb: true,
fields: {name: 'Nome', gender: 'Sexo', text: 'Mensagem'}
}
};
```
#### Usage
```javascript
// Router example
router.post('/message/:messageKey', Message.sendMessage);
```
# Notification (api)
#### Firebase initialize and lib setup
- The notification config object must look exactly like this
```javascript
// you can do this way
const firebaseServiceAccount = require('path-to-your/service-account.json');
// or this way (the firebaseServiceAccount must have this structure)
const firebaseServiceAccount = {
'type': 'service_account',
'project_id': '',
'private_key_id': '',
'private_key': '-----BEGIN PRIVATE KEY----------END PRIVATE KEY-----\n',
'client_email': '',
'client_id': '',
'auth_uri': '',
'token_uri': '',
'auth_provider_x509_cert_url': '',
'client_x509_cert_url': ''
};
const notification = {
credential: firebaseServiceAccount,
databaseURL: ''
};
```
- Our apiBootstrap will handle this object and setup the Notification
```javascript
if(config.notification){
Notification.setup(config.notification);
}
```
- But if you don't want to use the apiBoostrap just call: `Notification.setup(notification)`
#### Lib methods
##### setup
- Receives the config object and sets its credentials on the firebase-admin instance
# Stats
# Development
```
npm install
```
# Model
## ModelSequelize
### Setup
```javascript
const ModelSequelize = require('@app-masters/node-lib').modelSequelize;
const sequelize = require('../resources/sequelize'); //sequelize connection
const otherModel = require('./path/to/otherModel');
const MyModel extends ModelSequelize {}
const schema = {/*sequelize schema with foreign key to 'other'*/};
const modelOptions = [{model: otherModel, options: {foreignKey: 'otherId'}}]);
MyModel.setup( modelName, schema, itemInstance, relationArray, modelOptions);
module.exports = MyModel.model;
```
# Session
To use sessions just add a session key on your config.
```
{
session:{
someThing:true
}
}
```
# Tests
- **Message** ```npm run test test/sequelizeMessage.test.js```
# Change Log
Check all changes on [changelog](CHANGELOG.md).