sails-hook-blueprint-utils
v1.2.1
Published
Adds utility methods to Sails API blueprints
Downloads
6
Maintainers
Readme
sails-hook-blueprint-utils
Adds utility methods to Sails API blueprints.
Installation
In Sails.js v0.11+ installed hooks are run automatically. Therefore, simply install the hook via npm
:
npm install --save sails-hook-blueprint-utils
Create config/installedHooks.js
module.exports.installedHooks = {
"sails-hook-blueprint-utils": {
"name": "blueprintUtils",
"configKey": "blueprintUtils"
}
}
If you want to use a policy, add it to your sails.config:
...
blueprintUtils: {
policy: 'isAllowed'
}
...
Right now only one policy is supported.
Ingredients
- Count
Returns total record count of the specified model.
"where" parameter is optional. If it's used it's used in the same way like you use it in default blueprint API .find() method
GET /users/count?where={:CRITERIA}
{
count: 42000
}
GET /users/5694f97cc48a107117e19c2d/products/
{
count: 42000
}
- Associations
Returns related tables/collections associated with the model
GET /users/associations
{
associations: [
{
"alias": "endpoints",
"type": "collection",
"collection": "endpoint",
"via": "users"
},
{
"alias": "clients",
"type": "collection",
"collection": "client",
"via": "user"
}
]
}
- Schema
Returns the data model / schema of the specified model
GET /users/schema
{
schema:
{
"name": {
"type": "string",
"required": true,
"minLength": 1,
"maxLength": 50
},
"email": {
"type": "email",
"required": true,
"unique": true,
"isValidEmail": true
},
"password": {
"type": "string",
"required": true,
"minLength": 3,
"maxLength": 15,
"protected": true
}
}
}
- Filters
Returns the filterable fields of the specified model to use in frontend
Filters are defined in model itself as fieldname: field text
Protected values are excluded from filters.
module.exports = {
schema: true,
filters: {
"name": 'Name',
"createdAt": 'Created At',
"updatedAt": 'Updated At'
},
attributes: {
"name": {
"type": "string",
"required": true,
"minLength": 1,
"maxLength": 50
},
"email": {
"type": "email",
"required": true,
"unique": true,
"isValidEmail": true
},
"password": {
"type": "string",
"required": true,
"minLength": 3,
"maxLength": 15,
"protected": true
}
}
}
GET /users/filters
{
"filters": [
{
"name": "username",
"text": "Username",
"type": "string"
},
{
"name": "createdAt",
"text": "Created At",
"type": "datetime"
},
{
"name": "updatedAt",
"text": "Updated At",
"type": "datetime"
}
]
}
Credits
- kristian-ackar creator of the count function & https://github.com/kristian-ackar/sails-hook-blueprint-count
- buraktt association count function and policy integration