soul-cli 0.1.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Binary file
Binary file
@@ -0,0 +1,63 @@
1
+ const hello = {
2
+ method: 'GET',
3
+ path: '/api/hello-soul',
4
+ handler: (req, res, db) => {
5
+ res.status(200).json({
6
+ message: 'Hello Soul!',
7
+ });
8
+ },
9
+ };
10
+
11
+ const timestamp = {
12
+ method: 'GET',
13
+ path: '/api/timestamp',
14
+ handler: (req, res, db) => {
15
+ res.status(200).json({
16
+ timestamp: Date.now(),
17
+ });
18
+ },
19
+ };
20
+
21
+ const greetings = {
22
+ method: 'POST',
23
+ path: '/api/greetings/:name',
24
+ handler: (req, res, db) => {
25
+ const { name } = req.params;
26
+ const { greeting } = req.body;
27
+ res.status(200).json({
28
+ message: `${greeting} ${name}!`,
29
+ });
30
+ },
31
+ };
32
+
33
+ const searchTables = {
34
+ method: 'GET',
35
+ path: '/api/search-tables',
36
+ handler: (req, res, db) => {
37
+ const { q } = req.query;
38
+ const sql = `
39
+ SELECT name FROM sqlite_master
40
+ WHERE type='table'
41
+ AND name LIKE $searchQuery
42
+ `;
43
+ try {
44
+ const tables = db.prepare(sql).all({
45
+ searchQuery: `%${q}%`,
46
+ });
47
+ res.status(200).json({
48
+ tables,
49
+ });
50
+ } catch (error) {
51
+ res.status(500).json({
52
+ error: error.message,
53
+ });
54
+ }
55
+ },
56
+ };
57
+
58
+ module.exports = {
59
+ hello,
60
+ timestamp,
61
+ greetings,
62
+ searchTables,
63
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "soul-cli",
3
- "version": "0.1.0",
3
+ "version": "0.2.1",
4
4
  "description": "A SQLite REST and Realtime server",
5
5
  "main": "src/server.js",
6
6
  "bin": {
package/src/cli.js CHANGED
@@ -34,6 +34,12 @@ if (process.env.NO_CLI !== 'true') {
34
34
  demandOption: false,
35
35
  choices: ['console', null],
36
36
  })
37
+ .options('e', {
38
+ alias: 'extensions',
39
+ describe: 'Extensions directory path to load',
40
+ type: 'string',
41
+ demandOption: false,
42
+ })
37
43
  .help(true).argv;
38
44
  }
39
45
 
@@ -24,6 +24,8 @@ const envVarsSchema = Joi.object()
24
24
  RATE_LIMIT_ENABLED: Joi.boolean().default(false),
25
25
  RATE_LIMIT_WINDOW_MS: Joi.number().positive().default(1000),
26
26
  RATE_LIMIT_MAX_REQUESTS: Joi.number().positive().default(10),
27
+
28
+ EXTENSIONS: Joi.string().default(null),
27
29
  })
28
30
  .unknown();
29
31
 
@@ -76,4 +78,8 @@ module.exports = {
76
78
  windowMs: envVars.RATE_LIMIT_WINDOW,
77
79
  max: envVars.RATE_LIMIT_MAX,
78
80
  },
81
+
82
+ extensions: {
83
+ path: argv.extensions || envVars.EXTENSIONS,
84
+ },
79
85
  };
@@ -167,19 +167,22 @@ const listTables = async (req, res) => {
167
167
  // if search is provided, search the tables
168
168
  // e.g. ?_search=users
169
169
  if (_search) {
170
- query += ` AND name LIKE '%${_search}%'`;
170
+ query += ` AND name LIKE $searchQuery`;
171
171
  }
172
172
 
173
173
  // if ordering is provided, order the tables
174
174
  // e.g. ?_ordering=name (ascending) or ?_ordering=-name (descending)
175
175
  if (_ordering) {
176
- query += ` ORDER BY ${_ordering.replace('-', '')} ${
177
- _ordering.startsWith('-') ? 'DESC' : 'ASC'
178
- }`;
176
+ query += ` ORDER BY $ordering`;
179
177
  }
180
178
 
181
179
  try {
182
- const tables = db.prepare(query).all();
180
+ const tables = db.prepare(query).all({
181
+ searchQuery: `%${_search}%`,
182
+ ordering: `${_ordering?.replace('-', '')} ${
183
+ _ordering?.startsWith('-') ? 'DESC' : 'ASC'
184
+ }`,
185
+ });
183
186
 
184
187
  res.json({
185
188
  data: tables,
@@ -0,0 +1,47 @@
1
+ const fs = require('fs');
2
+
3
+ const { extensions: extensionsConfig } = require('./config');
4
+
5
+ const { path: extensionsPath } = extensionsConfig;
6
+
7
+ const setupExtensions = async (app, db) => {
8
+ if (extensionsPath) {
9
+ const extensions = fs.readdirSync(extensionsPath);
10
+ extensions.forEach((extension) => {
11
+ if (extension === 'api.js') {
12
+ const apiExtensions = require(`${extensionsPath}/${extension}`);
13
+
14
+ console.log('API extensions loaded');
15
+
16
+ Object.keys(apiExtensions).forEach((key) => {
17
+ const api = apiExtensions[key];
18
+ switch (api.method) {
19
+ case 'GET':
20
+ app.get(api.path, (req, res) => api.handler(req, res, db));
21
+ break;
22
+ case 'POST':
23
+ app.post(api.path, api.handler);
24
+ break;
25
+ case 'PUT':
26
+ app.put(api.path, api.handler);
27
+ break;
28
+ case 'DELETE':
29
+ app.delete(api.path, api.handler);
30
+ break;
31
+
32
+ default:
33
+ break;
34
+ }
35
+ console.log(' >', api.path);
36
+ });
37
+ console.log('\n');
38
+ }
39
+ });
40
+ } else {
41
+ console.log('No extensions directory provided');
42
+ }
43
+ };
44
+
45
+ module.exports = {
46
+ setupExtensions,
47
+ };
package/src/index.js CHANGED
@@ -14,9 +14,14 @@ const rootRoutes = require('./routes/index');
14
14
  const tablesRoutes = require('./routes/tables');
15
15
  const rowsRoutes = require('./routes/rows');
16
16
  const swaggerFile = require('./swagger/swagger.json');
17
+ const { setupExtensions } = require('./extensions');
17
18
 
18
19
  const app = express();
19
20
 
21
+ app.get('/health', (req, res) => {
22
+ res.send('OK');
23
+ });
24
+
20
25
  app.use(bodyParser.json());
21
26
 
22
27
  // Activate wal mode
@@ -63,4 +68,6 @@ app.use('/api', rootRoutes);
63
68
  app.use('/api/tables', tablesRoutes);
64
69
  app.use('/api/tables', rowsRoutes);
65
70
 
71
+ setupExtensions(app, db);
72
+
66
73
  module.exports = app;
@@ -1,13 +1,19 @@
1
1
  const validator = (schema) => (req, res, next) => {
2
- const data = { ...req.body, ...req.params, ...req.query };
2
+ const { body, params, query } = req;
3
+ const data = { body, params, query };
4
+
3
5
  const { value, error } = schema.validate(data);
4
6
 
5
7
  if (error) {
6
8
  res.status(400).json({
7
9
  message: error.message,
8
- error: error,
10
+ error: error.details,
9
11
  });
10
12
  } else {
13
+ req.body = value.body;
14
+ req.params = value.params;
15
+ req.query = value.query;
16
+
11
17
  next();
12
18
  }
13
19
  };
@@ -8,7 +8,11 @@ const router = express.Router();
8
8
 
9
9
  router.get('/', validator(schema.listTables), controllers.listTables);
10
10
  router.post('/', validator(schema.createTable), controllers.createTable);
11
- router.get('/:name', controllers.getTableSchema);
11
+ router.get(
12
+ '/:name',
13
+ validator(schema.getTableSchema),
14
+ controllers.getTableSchema
15
+ );
12
16
  router.delete('/:name', validator(schema.deleteTable), controllers.deleteTable);
13
17
 
14
18
  module.exports = router;
@@ -1,17 +1,21 @@
1
1
  const Joi = require('joi');
2
2
 
3
3
  const transaction = Joi.object({
4
- transaction: Joi.array()
5
- .items(
6
- Joi.object({
7
- statement: Joi.string().required(),
8
- values: Joi.object().required(),
9
- }),
10
- Joi.object({
11
- query: Joi.string().required(),
12
- })
13
- )
14
- .required(),
4
+ query: Joi.object().required(),
5
+ params: Joi.object().required(),
6
+ body: Joi.object({
7
+ transaction: Joi.array()
8
+ .items(
9
+ Joi.object({
10
+ statement: Joi.string().required(),
11
+ values: Joi.object().required(),
12
+ }),
13
+ Joi.object({
14
+ query: Joi.string().required(),
15
+ })
16
+ )
17
+ .required(),
18
+ }).required(),
15
19
  });
16
20
 
17
21
  module.exports = {
@@ -1,40 +1,91 @@
1
1
  const Joi = require('joi');
2
2
 
3
3
  const listTableRows = Joi.object({
4
- name: Joi.string().min(3).max(30).required(),
5
- _page: Joi.number().integer().min(1).default(1),
6
- _limit: Joi.number().integer().min(1).default(10),
7
- _search: Joi.string(),
8
- _ordering: Joi.string(),
9
- _schema: Joi.string(),
10
- _extend: Joi.string(),
11
- _filters: Joi.string(),
12
- }).unknown(true);
4
+ query: Joi.object({
5
+ _page: Joi.number().integer().min(1).default(1),
6
+ _limit: Joi.number().integer().min(1).default(10),
7
+ _search: Joi.string(),
8
+ _ordering: Joi.string().regex(/^[\w-]+$/),
9
+ _schema: Joi.string(),
10
+ _extend: Joi.string(),
11
+ _filters: Joi.string(),
12
+ }).required(),
13
+ params: Joi.object({
14
+ name: Joi.string(),
15
+ }).required(),
16
+ body: Joi.object().required(),
17
+ });
13
18
 
14
19
  const insertRowInTable = Joi.object({
15
- name: Joi.string().min(3).max(30).required(),
16
- fields: Joi.object().required(),
20
+ query: Joi.object().required(),
21
+ params: Joi.object({
22
+ name: Joi.string()
23
+ .regex(/^[\w-]+$/)
24
+ .min(3)
25
+ .max(30)
26
+ .required(),
27
+ }).required(),
28
+ body: Joi.object({
29
+ fields: Joi.object().required(),
30
+ }).required(),
17
31
  });
18
32
 
19
33
  const getRowInTableByPK = Joi.object({
20
- name: Joi.string().min(3).max(30).required(),
21
- pks: Joi.string().required(),
22
- _lookup_field: Joi.string().min(3).max(30),
23
- _schema: Joi.string(),
24
- _extend: Joi.string(),
34
+ query: Joi.object({
35
+ _lookup_field: Joi.string()
36
+ .regex(/^[\w-]+$/)
37
+ .min(3)
38
+ .max(30),
39
+ _schema: Joi.string(),
40
+ _extend: Joi.string(),
41
+ }).required(),
42
+ params: Joi.object({
43
+ name: Joi.string()
44
+ .regex(/^[\w-]+$/)
45
+ .min(3)
46
+ .max(30)
47
+ .required(),
48
+ pks: Joi.string().required(),
49
+ }).required(),
50
+ body: Joi.object().required(),
25
51
  });
26
52
 
27
53
  const updateRowInTableByPK = Joi.object({
28
- name: Joi.string().min(3).max(30).required(),
29
- pks: Joi.string().required(),
30
- fields: Joi.object().required(),
31
- _lookup_field: Joi.string().min(3).max(30),
54
+ query: Joi.object({
55
+ _lookup_field: Joi.string()
56
+ .regex(/^[\w-]+$/)
57
+ .min(3)
58
+ .max(30),
59
+ }).required(),
60
+ params: Joi.object({
61
+ name: Joi.string()
62
+ .regex(/^[\w-]+$/)
63
+ .min(3)
64
+ .max(30)
65
+ .required(),
66
+ pks: Joi.string().required(),
67
+ }).required(),
68
+ body: Joi.object({
69
+ fields: Joi.object().required(),
70
+ }).required(),
32
71
  });
33
72
 
34
73
  const deleteRowInTableByPK = Joi.object({
35
- name: Joi.string().min(3).max(30).required(),
36
- pks: Joi.string().required(),
37
- _lookup_field: Joi.string().min(3).max(30),
74
+ query: Joi.object({
75
+ _lookup_field: Joi.string()
76
+ .regex(/^[\w-]+$/)
77
+ .min(3)
78
+ .max(30),
79
+ }).required(),
80
+ params: Joi.object({
81
+ name: Joi.string()
82
+ .regex(/^[\w-]+$/)
83
+ .min(3)
84
+ .max(30)
85
+ .required(),
86
+ pks: Joi.string().required(),
87
+ }).required(),
88
+ body: Joi.object().required(),
38
89
  });
39
90
 
40
91
  module.exports = {
@@ -1,60 +1,105 @@
1
1
  const Joi = require('joi');
2
2
 
3
3
  const listTables = Joi.object({
4
- _search: Joi.string(),
5
- _ordering: Joi.string(),
6
- }).unknown(true);
4
+ query: Joi.object({
5
+ _search: Joi.string(),
6
+ _ordering: Joi.string(),
7
+ }).required(),
8
+ params: Joi.object().required(),
9
+ body: Joi.object().required(),
10
+ });
7
11
 
8
12
  const createTable = Joi.object({
9
- name: Joi.string().min(2).max(30).required(),
10
- autoAddCreatedAt: Joi.boolean().default(true),
11
- autoAddUpdatedAt: Joi.boolean().default(true),
12
- schema: Joi.array()
13
- .items(
14
- Joi.object({
15
- name: Joi.string().min(2).max(30).required(),
16
- // type one of sqlite3 types
17
- type: Joi.string()
18
- .valid(
19
- 'TEXT',
20
- 'NUMERIC',
21
- 'INTEGER',
22
- 'REAL',
23
- 'BLOB',
24
- 'BOOLEAN',
25
- 'DATE',
26
- 'DATETIME'
27
- )
28
- .insensitive()
29
- .required(),
30
- default: Joi.any(),
31
- notNull: Joi.boolean(),
32
- unique: Joi.boolean(),
33
- primaryKey: Joi.boolean(),
34
- foreignKey: Joi.object({
35
- table: Joi.string().min(2).max(30).required(),
36
- column: Joi.string().min(2).max(30).required(),
37
- onDelete: Joi.string()
38
- .valid('CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT')
39
- .insensitive()
40
- .default('CASCADE'),
41
- onUpdate: Joi.string()
42
- .valid('CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT')
13
+ query: Joi.object().required(),
14
+ params: Joi.object().required(),
15
+ body: Joi.object({
16
+ name: Joi.string()
17
+ .regex(/^[\w-]+$/)
18
+ .min(2)
19
+ .max(30)
20
+ .required(),
21
+ autoAddCreatedAt: Joi.boolean().default(true),
22
+ autoAddUpdatedAt: Joi.boolean().default(true),
23
+ schema: Joi.array()
24
+ .items(
25
+ Joi.object({
26
+ name: Joi.string()
27
+ .regex(/^[\w-]+$/)
28
+ .min(2)
29
+ .max(30)
30
+ .required(),
31
+ // type one of sqlite3 types
32
+ type: Joi.string()
33
+ .valid(
34
+ 'TEXT',
35
+ 'NUMERIC',
36
+ 'INTEGER',
37
+ 'REAL',
38
+ 'BLOB',
39
+ 'BOOLEAN',
40
+ 'DATE',
41
+ 'DATETIME'
42
+ )
43
43
  .insensitive()
44
- .default('RESTRICT'),
45
- }),
46
- index: Joi.boolean(),
47
- })
48
- )
49
- .required(),
44
+ .required(),
45
+ default: Joi.any(),
46
+ notNull: Joi.boolean(),
47
+ unique: Joi.boolean(),
48
+ primaryKey: Joi.boolean(),
49
+ foreignKey: Joi.object({
50
+ table: Joi.string()
51
+ .regex(/^[\w-]+$/)
52
+ .min(2)
53
+ .max(30)
54
+ .required(),
55
+ column: Joi.string()
56
+ .regex(/^[\w-]+$/)
57
+ .min(2)
58
+ .max(30)
59
+ .required(),
60
+ onDelete: Joi.string()
61
+ .valid('CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT')
62
+ .insensitive()
63
+ .default('CASCADE'),
64
+ onUpdate: Joi.string()
65
+ .valid('CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT')
66
+ .insensitive()
67
+ .default('RESTRICT'),
68
+ }),
69
+ index: Joi.boolean(),
70
+ })
71
+ )
72
+ .required(),
73
+ }),
74
+ });
75
+
76
+ const getTableSchema = Joi.object({
77
+ query: Joi.object().required(),
78
+ params: Joi.object({
79
+ name: Joi.string()
80
+ .regex(/^[\w-]+$/)
81
+ .min(3)
82
+ .max(30)
83
+ .required(),
84
+ }),
85
+ body: Joi.object().required(),
50
86
  });
51
87
 
52
88
  const deleteTable = Joi.object({
53
- name: Joi.string().min(3).max(30).required(),
89
+ query: Joi.object().required(),
90
+ params: Joi.object({
91
+ name: Joi.string()
92
+ .regex(/^[\w-]+$/)
93
+ .min(3)
94
+ .max(30)
95
+ .required(),
96
+ }),
97
+ body: Joi.object().required(),
54
98
  });
55
99
 
56
100
  module.exports = {
57
101
  listTables,
58
102
  createTable,
103
+ getTableSchema,
59
104
  deleteTable,
60
105
  };
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "swagger": "2.0",
3
3
  "info": {
4
- "version": "0.1.0",
4
+ "version": "0.2.0",
5
5
  "title": "Soul API",
6
- "description": "API Documentation for <b>Soul</b>, a simple REST and realtime server. "
6
+ "description": "API Documentation for <b>Soul</b>, a SQLite REST and realtime server. "
7
7
  },
8
8
  "host": "localhost:8000",
9
9
  "basePath": "/",
@@ -33,6 +33,17 @@
33
33
  "application/json"
34
34
  ],
35
35
  "paths": {
36
+ "/health": {
37
+ "get": {
38
+ "description": "",
39
+ "parameters": [],
40
+ "responses": {
41
+ "200": {
42
+ "description": "OK"
43
+ }
44
+ }
45
+ }
46
+ },
36
47
  "/api/": {
37
48
  "get": {
38
49
  "tags": [