soul-cli 0.2.0 → 0.2.2
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.
- package/Chinook_Sqlite.sqlite +0 -0
- package/Chinook_Sqlite.sqlite-shm +0 -0
- package/Chinook_Sqlite.sqlite-wal +0 -0
- package/_extensions/api.js +3 -53
- package/package.json +12 -12
- package/src/cli.js +6 -0
- package/src/config/index.js +5 -1
- package/src/controllers/tables.js +8 -5
- package/src/middlewares/validation.js +8 -2
- package/src/routes/tables.js +5 -1
- package/src/schemas/index.js +15 -11
- package/src/schemas/rows.js +74 -23
- package/src/schemas/tables.js +89 -44
- package/src/swagger/swagger.json +1 -1
package/Chinook_Sqlite.sqlite
CHANGED
|
Binary file
|
|
Binary file
|
|
Binary file
|
package/_extensions/api.js
CHANGED
|
@@ -2,62 +2,12 @@ const hello = {
|
|
|
2
2
|
method: 'GET',
|
|
3
3
|
path: '/api/hello-soul',
|
|
4
4
|
handler: (req, res, db) => {
|
|
5
|
-
res.status(200).json({
|
|
6
|
-
|
|
5
|
+
res.status(200).json({
|
|
6
|
+
message: 'Hello Soul!'
|
|
7
7
|
});
|
|
8
8
|
},
|
|
9
9
|
};
|
|
10
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
11
|
module.exports = {
|
|
59
12
|
hello,
|
|
60
|
-
|
|
61
|
-
greetings,
|
|
62
|
-
searchTables,
|
|
63
|
-
};
|
|
13
|
+
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "soul-cli",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "A SQLite REST and Realtime server",
|
|
5
5
|
"main": "src/server.js",
|
|
6
6
|
"bin": {
|
|
@@ -24,25 +24,25 @@
|
|
|
24
24
|
},
|
|
25
25
|
"homepage": "https://github.com/thevahidal/soul#readme",
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"better-sqlite3": "^
|
|
28
|
-
"body-parser": "^1.20.
|
|
27
|
+
"better-sqlite3": "^8.1.0",
|
|
28
|
+
"body-parser": "^1.20.2",
|
|
29
29
|
"cors": "^2.8.5",
|
|
30
30
|
"dotenv": "^16.0.3",
|
|
31
|
-
"express": "^4.18.
|
|
32
|
-
"express-rate-limit": "^6.
|
|
31
|
+
"express": "^4.18.2",
|
|
32
|
+
"express-rate-limit": "^6.7.0",
|
|
33
33
|
"express-winston": "^4.2.0",
|
|
34
|
-
"joi": "^17.
|
|
35
|
-
"swagger-ui-express": "^4.
|
|
34
|
+
"joi": "^17.8.3",
|
|
35
|
+
"swagger-ui-express": "^4.6.1",
|
|
36
36
|
"winston": "^3.8.2",
|
|
37
|
-
"ws": "^8.
|
|
38
|
-
"yargs": "^17.
|
|
37
|
+
"ws": "^8.12.1",
|
|
38
|
+
"yargs": "^17.7.1"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"cross-env": "^7.0.3",
|
|
42
|
-
"jest": "^29.
|
|
42
|
+
"jest": "^29.4.3",
|
|
43
43
|
"nodemon": "^2.0.20",
|
|
44
|
-
"supertest": "^6.3.
|
|
45
|
-
"swagger-autogen": "^2.
|
|
44
|
+
"supertest": "^6.3.3",
|
|
45
|
+
"swagger-autogen": "^2.23.1"
|
|
46
46
|
},
|
|
47
47
|
"jest": {
|
|
48
48
|
"testEnvironment": "node",
|
package/src/cli.js
CHANGED
|
@@ -27,6 +27,12 @@ if (process.env.NO_CLI !== 'true') {
|
|
|
27
27
|
type: 'boolean',
|
|
28
28
|
demandOption: false,
|
|
29
29
|
})
|
|
30
|
+
.option('c', {
|
|
31
|
+
alias: 'cors',
|
|
32
|
+
describe: 'CORS whitelist origins',
|
|
33
|
+
type: 'string',
|
|
34
|
+
demandOption: false,
|
|
35
|
+
})
|
|
30
36
|
.option('V', {
|
|
31
37
|
alias: 'verbose',
|
|
32
38
|
describe: 'Enable verbose logging',
|
package/src/config/index.js
CHANGED
|
@@ -45,6 +45,10 @@ if (argv.database) {
|
|
|
45
45
|
env.DB = argv.database;
|
|
46
46
|
}
|
|
47
47
|
|
|
48
|
+
if (argv.cors) {
|
|
49
|
+
env.CORS_ORIGIN_WHITELIST = argv.cors;
|
|
50
|
+
}
|
|
51
|
+
|
|
48
52
|
if (argv['rate-limit-enabled']) {
|
|
49
53
|
env.RATE_LIMIT_ENABLED = argv['rate-limit-enabled'];
|
|
50
54
|
}
|
|
@@ -71,7 +75,7 @@ module.exports = {
|
|
|
71
75
|
filename: argv.database || envVars.DB || ':memory:',
|
|
72
76
|
},
|
|
73
77
|
cors: {
|
|
74
|
-
origin: envVars.CORS_ORIGIN_WHITELIST.split(','),
|
|
78
|
+
origin: argv.cors.split(',') || envVars.CORS_ORIGIN_WHITELIST.split(','),
|
|
75
79
|
},
|
|
76
80
|
rateLimit: {
|
|
77
81
|
enabled: argv['rate-limit-enabled'] || envVars.RATE_LIMIT_ENABLED,
|
|
@@ -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
|
|
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 $
|
|
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,
|
|
@@ -1,13 +1,19 @@
|
|
|
1
1
|
const validator = (schema) => (req, res, next) => {
|
|
2
|
-
const
|
|
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
|
};
|
package/src/routes/tables.js
CHANGED
|
@@ -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(
|
|
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;
|
package/src/schemas/index.js
CHANGED
|
@@ -1,17 +1,21 @@
|
|
|
1
1
|
const Joi = require('joi');
|
|
2
2
|
|
|
3
3
|
const transaction = Joi.object({
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
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 = {
|
package/src/schemas/rows.js
CHANGED
|
@@ -1,40 +1,91 @@
|
|
|
1
1
|
const Joi = require('joi');
|
|
2
2
|
|
|
3
3
|
const listTableRows = Joi.object({
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
}).
|
|
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
|
-
|
|
16
|
-
|
|
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
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
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
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
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
|
-
|
|
36
|
-
|
|
37
|
-
|
|
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 = {
|
package/src/schemas/tables.js
CHANGED
|
@@ -1,60 +1,105 @@
|
|
|
1
1
|
const Joi = require('joi');
|
|
2
2
|
|
|
3
3
|
const listTables = Joi.object({
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
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
|
-
|
|
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
|
-
.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
|
-
.
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
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
|
-
|
|
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
|
};
|