-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
258 lines (244 loc) · 8.47 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
const router = require('./lib/middleware/router');
const { setDatabase, setMainDatabase } = require('./lib/databases');
const {
runMigrations,
listMigrations,
makeMigrations,
latestMigrations,
rollbackMigrations,
upMigrations,
downMigrations,
currentVersionMigrations,
} = require('./lib/migrations');
const runSeeds = require('./lib/run-seeds');
const { addEvent: addBeforeEvent } = require('./lib/query-events/before');
const { addEvent: addAfterEvent } = require('./lib/query-events/after');
/**
* @class queryFaceNode
*
* @description
* <a href="https://github.com/enginustun/query-face-node" target="_blank">query-face-node</a>
* is a module that enables you to parse and execute
* <a href="https://github.com/enginustun/query-face" target="_blank">query-face</a> requests.
*
* @returns {router} router
* @example
* const express = require('express');
* const app = express();
* const queryFaceNode = require('query-face-node');
* app.post('/api', ...queryFaceNode);
*/
module.exports = router;
/**
* @memberof queryFaceNode.
* @function setDatabase
* @param {string} dbName database name alias
* @param {knex} database knex database instance you configured to use db operations
* @example
* // somewhere in your project
* // databases.js
* require('dotenv').config();
* module.exports = {
* todoDB: require('knex')({
* client: process.env.DB_CLIENT,
* connection: {
* host: process.env.DB_HOST,
* port: process.env.DB_PORT,
* user: process.env.DB_USER,
* password: process.env.DB_PASSWORD,
* database: process.env.DB_DATABASE
* },
* migrations: {
* tableName: process.env.DB_MIGRATION_TABLE,
* directory: process.env.DB_MIGRATION_DIRECTORY
* },
* seeds: {
* directory: process.env.DB_SEEDS_DIRECTORY
* }
* })
* };
*
* // app.js
* const databases = require('./databases');
* queryFaceNode.setDatabase('todoDB', databases.todoDB);
*/
module.exports.setDatabase = setDatabase;
/**
* @memberof queryFaceNode.
* @function setMainDatabase
* @param {knex} database knex database instance you configured to use qf db operations
* @example
* // somewhere in your project
* // databases.js
* require('dotenv').config();
* module.exports = {
* mainDB: require('knex')({
* client: process.env.QF_DB_CLIENT,
* connection: {
* host: process.env.QF_DB_HOST,
* port: process.env.QF_DB_PORT,
* user: process.env.QF_DB_USER,
* password: process.env.QF_DB_PASSWORD,
* database: process.env.QF_DB_DATABASE
* },
* migrations: {
* tableName: process.env.QF_DB_MIGRATION_TABLE,
* directory: process.env.QF_DB_MIGRATION_DIRECTORY
* },
* seeds: {
* directory: process.env.QF_DB_SEEDS_DIRECTORY
* }
* })
* };
*
* // app.js
* const databases = require('./databases');
* queryFaceNode.setMainDatabase(databases.mainDB);
*/
module.exports.setMainDatabase = setMainDatabase;
/**
* @memberof queryFaceNode.
* @function runMigrations
* @param {Object} databases knex database map to execute migrations on all databases
* @example
* const queryFaceNode = require('query-face-node');
* const databases = require('./databases');
* queryFaceNode.runMigrations(databases);
*/
module.exports.runMigrations = runMigrations;
/**
* Creates a new migration, with the name of the migration being added.
*
* @memberof queryFaceNode.
* @function makeMigrations
* @param {Object} db knex database to execute migrations on it
* @param {String} name migration name
* @param {Object} [config={}] migration config
* @example
* const queryFaceNode = require('query-face-node');
* const db = require('./databases').dbName;
* queryFaceNode.makeMigrations(db, 'dbName', config);
*/
module.exports.makeMigrations = makeMigrations;
/**
* Runs all migrations that have not yet been run.
*
* @memberof queryFaceNode.
* @function latestMigrations
* @param {Object} db knex database to execute latest function on it
* @param {Object} [config={}] migration config
* @example
* const queryFaceNode = require('query-face-node');
* const db = require('./databases').dbName;
* queryFaceNode.latestMigrations(db, config);
*/
module.exports.latestMigrations = latestMigrations;
/**
* Rolls back the latest migration group.
* If the all parameter is truthy, all applied migrations will be rolled back instead of just the last batch.
* The default value for this parameter is false.
*
* @memberof queryFaceNode.
* @function rollbackMigrations
* @param {Object} db knex database to execute rollback function on it
* @param {boolean} [all=false] if truthy all applied migrations will be rolled back
* @param {Object} [config={}] migration config
* @example
* const queryFaceNode = require('query-face-node');
* const db = require('./databases').dbName;
* queryFaceNode.rollbackMigrations(db, [true|false], config);
*/
module.exports.rollbackMigrations = rollbackMigrations;
/**
* Runs the specified (by config.name parameter) or the next chronological migration that has not yet be run.
*
* @memberof queryFaceNode.
* @function upMigrations
* @param {Object} db knex database to execute up function on it
* @param {Object} [config={}] migration config
* @example
* const queryFaceNode = require('query-face-node');
* const db = require('./databases').dbName;
* queryFaceNode.upMigrations(db, config);
*/
module.exports.upMigrations = upMigrations;
/**
* Will undo the specified (by config.name parameter) or the last migration that was run.
*
* @memberof queryFaceNode.
* @function downMigrations
* @param {Object} db knex database to execute down function on it
* @param {Object} [config={}] migration config
* @example
* const queryFaceNode = require('query-face-node');
* const db = require('./databases').dbName;
* queryFaceNode.downMigrations(db, config);
*/
module.exports.downMigrations = downMigrations;
/**
* Retrieves and returns the current migration version, as a promise.
* If there aren't any migrations run yet, returns "none" as the value for the currentVersion.
*
* @memberof queryFaceNode.
* @function currentVersionMigrations
* @param {Object} db knex database to execute currentVersion function on it
* @param {Object} [config={}] migration config
* @example
* const queryFaceNode = require('query-face-node');
* const db = require('./databases').dbName;
* queryFaceNode.currentVersionMigrations(db, config);
*/
module.exports.currentVersionMigrations = currentVersionMigrations;
/**
* Will return list of completed and pending migrations
*
* @memberof queryFaceNode.
* @function listMigrations
* @param {Object} db knex database to execute list function on it
* @param {Object} [config={}] migration config
* @example
* const queryFaceNode = require('query-face-node');
* const db = require('./databases').dbName;
* queryFaceNode.listMigrations(db, config);
*/
module.exports.listMigrations = listMigrations;
/**
* @memberof queryFaceNode.
* @function runSeeds
* @param {Object} databases knex database map to execute seeds on all databases
* @example
* const queryFaceNode = require('query-face-node');
* const databases = require('./databases');
* queryFaceNode.runSeeds(databases);
*/
module.exports.runSeeds = runSeeds;
/**
* @memberof queryFaceNode.
* @function addBeforeEvent
* @param {string} eventName this is the same as query template name you want to execute right before query
* @param {function} event this is the callback function that will be executed before specified query
* @returns {boolean|object} if you want to block operation you need to return false
* or error object that contains <strong>{status, error, ...customPropertiesYouNeed}</strong>
* @example
* queryFace.addBeforeEvent('getTodos', (req, res, query) => {
* // some calculations, checks, validations...
* // return false;
* return {
* status: 400,
* error: 'There are some errors',
* validationErrors: [{ field: 'email', message: 'This should be a valid email.' }]
* };
* });
*/
module.exports.addBeforeEvent = addBeforeEvent;
/**
* @memberof queryFaceNode.
* @function addAfterEvent
* @param {string} eventName this is the same as query template name you want to execute right after query
* @param {function} event this is the callback function that will be executed after specified query
* @example
* queryFaceNode.addAfterEvent('addTodo', (req, res, results, errors) => {
* console.log('after addTodo query, this function will be executed', results, errors);
* });
*/
module.exports.addAfterEvent = addAfterEvent;