@autofleet/sheilta 1.0.2-aaron-test → 1.0.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/lib/formatter/index.d.ts +4 -16
- package/lib/formatter/index.js +9 -65
- package/lib/formatter/index.test.js +9 -185
- package/lib/middleware/index.d.ts +1 -3
- package/lib/middleware/index.js +9 -40
- package/lib/operators/index.d.ts +3 -1
- package/lib/operators/index.js +3 -8
- package/lib/utils.d.ts +1 -11
- package/lib/utils.js +2 -27
- package/lib/validations/index.d.ts +2 -5
- package/lib/validations/index.js +20 -74
- package/lib/validations/index.test.js +22 -141
- package/package.json +7 -8
package/lib/formatter/index.d.ts
CHANGED
|
@@ -1,18 +1,6 @@
|
|
|
1
1
|
declare type OrderItem = string | [string, string];
|
|
2
2
|
declare type SequelizeOrder = string | OrderItem[];
|
|
3
|
-
declare const
|
|
4
|
-
order
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
include?: any[];
|
|
8
|
-
query?: {};
|
|
9
|
-
attributes?: any;
|
|
10
|
-
searchTerm?: any;
|
|
11
|
-
}, model?: any) => {
|
|
12
|
-
query: {};
|
|
13
|
-
order: SequelizeOrder[];
|
|
14
|
-
page: any;
|
|
15
|
-
perPage: any;
|
|
16
|
-
include: any;
|
|
17
|
-
};
|
|
18
|
-
export default formatPayload;
|
|
3
|
+
export declare const formatOrder: ({ order, }: {
|
|
4
|
+
order?: any[];
|
|
5
|
+
}) => SequelizeOrder[];
|
|
6
|
+
export {};
|
package/lib/formatter/index.js
CHANGED
|
@@ -1,70 +1,14 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
|
|
3
|
+
exports.formatOrder = void 0;
|
|
7
4
|
const utils_1 = require("../utils");
|
|
8
5
|
const DESCENDING_KEY = 'DESC';
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
: o, associationModels);
|
|
16
|
-
if (isOrderAssociation) {
|
|
17
|
-
formattedOrder.push(utils_1.extractAssociatedAttributeNameFromOrder(o));
|
|
18
|
-
}
|
|
19
|
-
if (isOrderDescOrder) {
|
|
20
|
-
formattedOrder.push(DESCENDING_KEY);
|
|
21
|
-
}
|
|
22
|
-
return formattedOrder;
|
|
23
|
-
}));
|
|
24
|
-
const formatPage = page => page || utils_1.PAGE_DEFAULT;
|
|
25
|
-
const formatPerPage = perPage => perPage || utils_1.PER_PAGE_DEFAULT;
|
|
26
|
-
const formatInclude = (include, associationsMap = {}) => {
|
|
27
|
-
let formattedInclude = include.map(i => (Object.assign(Object.assign({}, i), { association: associationsMap[i.association || i.model], required: i.required !== 'false' })));
|
|
28
|
-
formattedInclude = formattedInclude.map(i => lodash_1.default.omit(i, ['model']));
|
|
29
|
-
return formattedInclude;
|
|
30
|
-
};
|
|
31
|
-
const formatQuery = (query, associationModels) => Object.keys(query).reduce((acc, queryItemKey) => (Object.assign(Object.assign({}, acc), { [utils_1.isAttributeByAssociation(queryItemKey, associationModels)
|
|
32
|
-
? utils_1.wrapAttributeWithOperator(queryItemKey) : queryItemKey]: query[queryItemKey] })), {});
|
|
33
|
-
const formatSearchTerm = (searchTerm, attributesToSend, rawAttributes) => ({
|
|
34
|
-
$and: searchTerm.split(' ').map(term => ({
|
|
35
|
-
$or: attributesToSend.filter(attrKey => rawAttributes[attrKey].type.key === 'STRING').map(attr => ({
|
|
36
|
-
[attr]: {
|
|
37
|
-
$iLike: `%${term}%`,
|
|
38
|
-
},
|
|
39
|
-
})),
|
|
40
|
-
})),
|
|
41
|
-
});
|
|
42
|
-
const formatPayload = ({ order, page = utils_1.PAGE_DEFAULT, perPage = utils_1.PER_PAGE_DEFAULT, include = [], query = {}, attributes = null, searchTerm = null, }, model) => {
|
|
43
|
-
const associationModels = Object.keys((model === null || model === void 0 ? void 0 : model.associations) || {});
|
|
44
|
-
const formattedOrder = formatOrder({
|
|
45
|
-
order,
|
|
46
|
-
associationModels,
|
|
47
|
-
});
|
|
48
|
-
const formattedInclude = formatInclude(include, model === null || model === void 0 ? void 0 : model.associations);
|
|
49
|
-
const formattedPage = formatPage(page);
|
|
50
|
-
const formattedPerPage = formatPerPage(perPage);
|
|
51
|
-
let formattedQuery = formatQuery(query, associationModels);
|
|
52
|
-
if (searchTerm) {
|
|
53
|
-
const attributesToSend = (attributes === null || attributes === void 0 ? void 0 : attributes.length) ? attributes : Object.keys(model.rawAttributes);
|
|
54
|
-
const queryWithSearchTerm = formatSearchTerm(searchTerm, attributesToSend, model.rawAttributes);
|
|
55
|
-
formattedQuery = lodash_1.default.isEmpty(formattedQuery) ? queryWithSearchTerm : {
|
|
56
|
-
$and: [
|
|
57
|
-
formattedQuery,
|
|
58
|
-
queryWithSearchTerm,
|
|
59
|
-
],
|
|
60
|
-
};
|
|
6
|
+
exports.formatOrder = ({ order = [], }) => order.map((o) => {
|
|
7
|
+
const isOrderDescOrder = utils_1.isOrderDesc(o);
|
|
8
|
+
let column = o;
|
|
9
|
+
if (isOrderDescOrder) {
|
|
10
|
+
column = utils_1.extractAttributeNameFromOrder(o);
|
|
11
|
+
return [column, DESCENDING_KEY];
|
|
61
12
|
}
|
|
62
|
-
return
|
|
63
|
-
|
|
64
|
-
order: formattedOrder,
|
|
65
|
-
page: formattedPage,
|
|
66
|
-
perPage: formattedPerPage,
|
|
67
|
-
include: formattedInclude,
|
|
68
|
-
};
|
|
69
|
-
};
|
|
70
|
-
exports.default = formatPayload;
|
|
13
|
+
return [column];
|
|
14
|
+
});
|
|
@@ -1,193 +1,17 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
const _1 =
|
|
3
|
+
const _1 = require(".");
|
|
7
4
|
describe('formatting test', () => {
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
order: [],
|
|
12
|
-
query: {
|
|
13
|
-
'json.field': {
|
|
14
|
-
$gt: 4,
|
|
15
|
-
},
|
|
16
|
-
},
|
|
17
|
-
}, {
|
|
18
|
-
rawAttributes: {
|
|
19
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', json: '',
|
|
20
|
-
},
|
|
21
|
-
});
|
|
22
|
-
expect(JSON.stringify(query)).toBe(JSON.stringify({ 'json.field': { $gt: 4 } }));
|
|
23
|
-
});
|
|
24
|
-
it('query included model field', () => {
|
|
25
|
-
const { query } = _1.default({
|
|
26
|
-
order: [],
|
|
27
|
-
query: {
|
|
28
|
-
'status.field': {
|
|
29
|
-
$gt: 4,
|
|
30
|
-
},
|
|
31
|
-
},
|
|
32
|
-
}, {
|
|
33
|
-
rawAttributes: {
|
|
34
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
|
|
35
|
-
},
|
|
36
|
-
associations: {
|
|
37
|
-
status: {},
|
|
38
|
-
},
|
|
39
|
-
});
|
|
40
|
-
expect(JSON.stringify(query)).toBe(JSON.stringify({ '$status.field$': { $gt: 4 } }));
|
|
41
|
-
});
|
|
42
|
-
it('query with searchTerm', () => {
|
|
43
|
-
const searchTerm = 'aviv';
|
|
44
|
-
const { query } = _1.default({
|
|
45
|
-
order: [],
|
|
46
|
-
query: {
|
|
47
|
-
'json.field': {
|
|
48
|
-
$gt: 4,
|
|
49
|
-
},
|
|
50
|
-
},
|
|
51
|
-
searchTerm,
|
|
52
|
-
}, {
|
|
53
|
-
rawAttributes: {
|
|
54
|
-
startTime: {
|
|
55
|
-
type: {
|
|
56
|
-
key: 'STRING',
|
|
57
|
-
},
|
|
58
|
-
},
|
|
59
|
-
endTime: {
|
|
60
|
-
type: {
|
|
61
|
-
key: 'NUMBER',
|
|
62
|
-
},
|
|
63
|
-
},
|
|
64
|
-
},
|
|
65
|
-
});
|
|
66
|
-
expect(JSON.stringify(query)).toBe(JSON.stringify({
|
|
67
|
-
$and: [{ 'json.field': { $gt: 4 } }, {
|
|
68
|
-
$and: [{
|
|
69
|
-
$or: [
|
|
70
|
-
{
|
|
71
|
-
startTime: {
|
|
72
|
-
$iLike: `%${searchTerm}%`,
|
|
73
|
-
},
|
|
74
|
-
},
|
|
75
|
-
],
|
|
76
|
-
}],
|
|
77
|
-
}],
|
|
78
|
-
}));
|
|
79
|
-
});
|
|
80
|
-
it('query with searchTerm with spaces', () => {
|
|
81
|
-
const searchTerm = 'aviv good guy';
|
|
82
|
-
const splitSearch = searchTerm.split(' ');
|
|
83
|
-
const { query } = _1.default({
|
|
84
|
-
order: [],
|
|
85
|
-
query: {
|
|
86
|
-
'json.field': {
|
|
87
|
-
$gt: 4,
|
|
88
|
-
},
|
|
89
|
-
},
|
|
90
|
-
searchTerm,
|
|
91
|
-
}, {
|
|
92
|
-
rawAttributes: {
|
|
93
|
-
startTime: {
|
|
94
|
-
type: {
|
|
95
|
-
key: 'STRING',
|
|
96
|
-
},
|
|
97
|
-
},
|
|
98
|
-
endTime: {
|
|
99
|
-
type: {
|
|
100
|
-
key: 'NUMBER',
|
|
101
|
-
},
|
|
102
|
-
},
|
|
103
|
-
},
|
|
104
|
-
});
|
|
105
|
-
expect(JSON.stringify(query)).toBe(JSON.stringify({
|
|
106
|
-
$and: [{ 'json.field': { $gt: 4 } }, {
|
|
107
|
-
$and: [{
|
|
108
|
-
$or: [
|
|
109
|
-
{
|
|
110
|
-
startTime: {
|
|
111
|
-
$iLike: `%${splitSearch[0]}%`,
|
|
112
|
-
},
|
|
113
|
-
}
|
|
114
|
-
],
|
|
115
|
-
}, {
|
|
116
|
-
$or: [{
|
|
117
|
-
startTime: {
|
|
118
|
-
$iLike: `%${splitSearch[1]}%`,
|
|
119
|
-
},
|
|
120
|
-
}],
|
|
121
|
-
},
|
|
122
|
-
{
|
|
123
|
-
$or: [{
|
|
124
|
-
startTime: {
|
|
125
|
-
$iLike: `%${splitSearch[2]}%`,
|
|
126
|
-
},
|
|
127
|
-
}],
|
|
128
|
-
}],
|
|
129
|
-
}],
|
|
130
|
-
}));
|
|
5
|
+
it('check order formatting', () => {
|
|
6
|
+
const payload = _1.formatOrder({
|
|
7
|
+
order: ['startTime', '-endTime'],
|
|
131
8
|
});
|
|
9
|
+
expect(JSON.stringify(payload)).toBe(JSON.stringify([['startTime'], ['endTime', 'DESC']]));
|
|
132
10
|
});
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
order: ['startTime', '-endTime'],
|
|
137
|
-
});
|
|
138
|
-
expect(JSON.stringify(order)).toBe(JSON.stringify([['startTime'], ['endTime', 'DESC']]));
|
|
139
|
-
});
|
|
140
|
-
it('simple check asc', () => {
|
|
141
|
-
const { order } = _1.default({
|
|
142
|
-
order: ['startTime', 'endTime'],
|
|
143
|
-
});
|
|
144
|
-
expect(JSON.stringify(order)).toBe(JSON.stringify([['startTime'], ['endTime']]));
|
|
145
|
-
});
|
|
146
|
-
it('by included model', () => {
|
|
147
|
-
const { order } = _1.default({
|
|
148
|
-
order: ['status.name'],
|
|
149
|
-
}, {
|
|
150
|
-
rawAttributes: {
|
|
151
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
|
|
152
|
-
},
|
|
153
|
-
associations: {
|
|
154
|
-
status: {},
|
|
155
|
-
},
|
|
156
|
-
});
|
|
157
|
-
expect(JSON.stringify(order)).toBe(JSON.stringify([['status', 'name']]));
|
|
158
|
-
});
|
|
159
|
-
it('by included model descending', () => {
|
|
160
|
-
const { order } = _1.default({
|
|
161
|
-
order: ['-status.name'],
|
|
162
|
-
}, {
|
|
163
|
-
rawAttributes: {
|
|
164
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
|
|
165
|
-
},
|
|
166
|
-
associations: {
|
|
167
|
-
status: {},
|
|
168
|
-
},
|
|
169
|
-
});
|
|
170
|
-
expect(JSON.stringify(order)).toBe(JSON.stringify([['status', 'name', 'DESC']]));
|
|
171
|
-
});
|
|
172
|
-
it('by json field', () => {
|
|
173
|
-
const { order } = _1.default({
|
|
174
|
-
order: ['status.name'],
|
|
175
|
-
}, {
|
|
176
|
-
rawAttributes: {
|
|
177
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', json: '',
|
|
178
|
-
},
|
|
179
|
-
});
|
|
180
|
-
expect(JSON.stringify(order)).toBe(JSON.stringify([['status.name']]));
|
|
181
|
-
});
|
|
182
|
-
it('by json field descending', () => {
|
|
183
|
-
const { order } = _1.default({
|
|
184
|
-
order: ['-status.name'],
|
|
185
|
-
}, {
|
|
186
|
-
rawAttributes: {
|
|
187
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', json: '',
|
|
188
|
-
},
|
|
189
|
-
});
|
|
190
|
-
expect(JSON.stringify(order)).toBe(JSON.stringify([['status.name', 'DESC']]));
|
|
11
|
+
it('check order formatting', () => {
|
|
12
|
+
const payload = _1.formatOrder({
|
|
13
|
+
order: ['startTime', 'endTime'],
|
|
191
14
|
});
|
|
15
|
+
expect(JSON.stringify(payload)).toBe(JSON.stringify([['startTime'], ['endTime']]));
|
|
192
16
|
});
|
|
193
17
|
});
|
|
@@ -1,4 +1,2 @@
|
|
|
1
|
-
export declare const newQueryValidationMiddleware: (inner?: string) => (model: any) => (req: any, res: any, next: any) => Promise<any>;
|
|
2
|
-
export declare const newQueryFormatMiddleware: (inner?: string) => (model: any) => (req: any, res: any, next: any) => Promise<any>;
|
|
3
1
|
export declare const queryValidationMiddleware: (model: any) => (req: any, res: any, next: any) => Promise<any>;
|
|
4
|
-
export declare const queryFormatMiddleware: (
|
|
2
|
+
export declare const queryFormatMiddleware: () => (req: any, res: any, next: any) => Promise<any>;
|
package/lib/middleware/index.js
CHANGED
|
@@ -8,37 +8,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
8
8
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
9
|
});
|
|
10
10
|
};
|
|
11
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
12
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
13
|
-
};
|
|
14
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
-
exports.queryFormatMiddleware = exports.queryValidationMiddleware =
|
|
12
|
+
exports.queryFormatMiddleware = exports.queryValidationMiddleware = void 0;
|
|
16
13
|
const errors_1 = require("@autofleet/errors");
|
|
17
|
-
const
|
|
18
|
-
const formatter_1 = __importDefault(require("../formatter"));
|
|
14
|
+
const formatter_1 = require("../formatter");
|
|
19
15
|
const validations_1 = require("../validations");
|
|
20
|
-
|
|
21
|
-
query
|
|
22
|
-
attributes: joi_1.array().items(joi_1.string()),
|
|
23
|
-
order: joi_1.array().items(joi_1.string()),
|
|
24
|
-
page: joi_1.number(),
|
|
25
|
-
perPage: joi_1.number(),
|
|
26
|
-
include: joi_1.array().items(joi_1.any()),
|
|
27
|
-
});
|
|
28
|
-
exports.newQueryValidationMiddleware = (inner = 'body') => model => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
|
|
29
|
-
const { query, attributes, order, page, perPage, include, } = req[inner];
|
|
16
|
+
exports.queryValidationMiddleware = model => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
|
|
17
|
+
const { query, attributes, order, } = req.body;
|
|
30
18
|
try {
|
|
31
|
-
const result = querySchema.validate(req[inner]);
|
|
32
|
-
if (result.error) {
|
|
33
|
-
throw new errors_1.BadRequest([result.error], null);
|
|
34
|
-
}
|
|
35
19
|
validations_1.validatePayload({
|
|
36
20
|
query,
|
|
37
21
|
attributes,
|
|
38
22
|
order,
|
|
39
|
-
page,
|
|
40
|
-
perPage,
|
|
41
|
-
include,
|
|
42
23
|
}, model);
|
|
43
24
|
return next();
|
|
44
25
|
}
|
|
@@ -54,23 +35,11 @@ exports.newQueryValidationMiddleware = (inner = 'body') => model => (req, res, n
|
|
|
54
35
|
});
|
|
55
36
|
}
|
|
56
37
|
});
|
|
57
|
-
exports.
|
|
58
|
-
const { order,
|
|
59
|
-
const
|
|
60
|
-
query,
|
|
38
|
+
exports.queryFormatMiddleware = () => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
|
|
39
|
+
const { order, } = req.body;
|
|
40
|
+
const formattedOrder = formatter_1.formatOrder({
|
|
61
41
|
order,
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
include,
|
|
65
|
-
attributes,
|
|
66
|
-
searchTerm,
|
|
67
|
-
}, model);
|
|
68
|
-
req[inner].query = formattedQuery;
|
|
69
|
-
req[inner].order = formattedOrder;
|
|
70
|
-
req[inner].page = formattedPage;
|
|
71
|
-
req[inner].perPage = formattedPerPage;
|
|
72
|
-
req[inner].include = formattedInclude;
|
|
42
|
+
});
|
|
43
|
+
req.body.order = formattedOrder;
|
|
73
44
|
return next();
|
|
74
45
|
});
|
|
75
|
-
exports.queryValidationMiddleware = exports.newQueryValidationMiddleware();
|
|
76
|
-
exports.queryFormatMiddleware = exports.newQueryFormatMiddleware();
|
package/lib/operators/index.d.ts
CHANGED
package/lib/operators/index.js
CHANGED
|
@@ -13,20 +13,15 @@ exports.OPERATORS = [
|
|
|
13
13
|
'notIn',
|
|
14
14
|
'is',
|
|
15
15
|
'like',
|
|
16
|
-
'iLike',
|
|
17
16
|
'notLike',
|
|
18
17
|
'between',
|
|
19
18
|
'and',
|
|
20
19
|
'or',
|
|
21
|
-
'overlap',
|
|
22
|
-
'contains',
|
|
23
20
|
];
|
|
24
21
|
exports.OPERATOR_PREFIX = '$';
|
|
25
22
|
exports.formatOperators = (Sequelize) => {
|
|
26
23
|
const { Op } = Sequelize;
|
|
27
|
-
return exports.OPERATORS.
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
return map;
|
|
31
|
-
}, {});
|
|
24
|
+
return exports.OPERATORS.map(o => ({
|
|
25
|
+
[`${exports.OPERATOR_PREFIX + o}`]: Op[o],
|
|
26
|
+
}));
|
|
32
27
|
};
|
package/lib/utils.d.ts
CHANGED
|
@@ -1,13 +1,3 @@
|
|
|
1
1
|
export declare const ORDER_PREFIX = "-";
|
|
2
|
-
export declare const
|
|
3
|
-
export declare const PER_PAGE_DEFAULT = 20;
|
|
4
|
-
export declare const PAGE_DEFAULT = 1;
|
|
5
|
-
export declare const PER_PAGE_MAX_LIMIT = 100;
|
|
6
|
-
export declare const PER_PAGE_MIN_LIMIT = 1;
|
|
7
|
-
export declare const PAGE_MIN = 1;
|
|
8
|
-
export declare const wrapAttributeWithOperator: (attribute: any) => string;
|
|
9
|
-
export declare const isAttributeByAssociation: (attributeName: any, associatedModels: any) => boolean;
|
|
10
|
-
export declare const extractAttributeNameFromOrder: (order: any, associationModels: any) => string;
|
|
2
|
+
export declare const extractAttributeNameFromOrder: (order: any) => string;
|
|
11
3
|
export declare const isOrderDesc: (order: any) => boolean;
|
|
12
|
-
export declare const throwBadRequestError: (message: string) => never;
|
|
13
|
-
export declare const extractAssociatedAttributeNameFromOrder: (order: any) => string;
|
package/lib/utils.js
CHANGED
|
@@ -1,31 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
const errors_1 = require("@autofleet/errors");
|
|
5
|
-
const operators_1 = require("./operators");
|
|
3
|
+
exports.isOrderDesc = exports.extractAttributeNameFromOrder = exports.ORDER_PREFIX = void 0;
|
|
6
4
|
exports.ORDER_PREFIX = '-';
|
|
7
|
-
exports.
|
|
8
|
-
exports.PER_PAGE_DEFAULT = 20;
|
|
9
|
-
exports.PAGE_DEFAULT = 1;
|
|
10
|
-
exports.PER_PAGE_MAX_LIMIT = 100;
|
|
11
|
-
exports.PER_PAGE_MIN_LIMIT = 1;
|
|
12
|
-
exports.PAGE_MIN = 1;
|
|
13
|
-
exports.wrapAttributeWithOperator = attribute => `${operators_1.OPERATOR_PREFIX}${attribute}${operators_1.OPERATOR_PREFIX}`;
|
|
14
|
-
exports.isAttributeByAssociation = (attributeName, associatedModels) => attributeName.includes(exports.ASSOCIATION_PREFIX)
|
|
15
|
-
&& associatedModels.includes(attributeName.split(exports.ASSOCIATION_PREFIX)[0]);
|
|
16
|
-
exports.extractAttributeNameFromOrder = (order, associationModels) => {
|
|
17
|
-
let formattedOrder = order;
|
|
18
|
-
if (order.includes(exports.ORDER_PREFIX)) {
|
|
19
|
-
// eslint-disable-next-line prefer-destructuring
|
|
20
|
-
formattedOrder = formattedOrder.split(exports.ORDER_PREFIX)[1];
|
|
21
|
-
}
|
|
22
|
-
if (exports.isAttributeByAssociation(formattedOrder, associationModels)) {
|
|
23
|
-
[formattedOrder] = formattedOrder.split(exports.ASSOCIATION_PREFIX);
|
|
24
|
-
}
|
|
25
|
-
return formattedOrder;
|
|
26
|
-
};
|
|
5
|
+
exports.extractAttributeNameFromOrder = (order) => order.split(exports.ORDER_PREFIX)[1];
|
|
27
6
|
exports.isOrderDesc = (order) => order.includes(exports.ORDER_PREFIX);
|
|
28
|
-
exports.throwBadRequestError = (message) => {
|
|
29
|
-
throw new errors_1.BadRequest([{ message }], null);
|
|
30
|
-
};
|
|
31
|
-
exports.extractAssociatedAttributeNameFromOrder = (order) => order.split(exports.ASSOCIATION_PREFIX)[1];
|
|
@@ -1,8 +1,5 @@
|
|
|
1
|
-
export declare const validatePayload: ({ query, order, attributes,
|
|
1
|
+
export declare const validatePayload: ({ query, order, attributes, }: {
|
|
2
2
|
query?: {};
|
|
3
3
|
order?: any[];
|
|
4
4
|
attributes?: any[];
|
|
5
|
-
|
|
6
|
-
page?: number;
|
|
7
|
-
perPage?: number;
|
|
8
|
-
}, model?: any) => boolean;
|
|
5
|
+
}, model: any) => boolean;
|
package/lib/validations/index.js
CHANGED
|
@@ -4,100 +4,56 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.validatePayload = void 0;
|
|
7
|
+
const errors_1 = require("@autofleet/errors");
|
|
7
8
|
const lodash_1 = __importDefault(require("lodash"));
|
|
8
9
|
const utils_1 = require("../utils");
|
|
9
10
|
const operators_1 = require("../operators");
|
|
10
11
|
const validateOperator = (operator) => operators_1.OPERATORS.includes(operator.split(operators_1.OPERATOR_PREFIX)[1]);
|
|
11
|
-
const validateQueryAttribute = (attribute, modelAttributes
|
|
12
|
-
|
|
13
|
-
? attribute.split(utils_1.ASSOCIATION_PREFIX)[0] : attribute);
|
|
14
|
-
const validateSingleOrder = (currentOrder, rawAttributes, associationModels) => {
|
|
12
|
+
const validateQueryAttribute = (attribute, modelAttributes) => modelAttributes.includes(attribute);
|
|
13
|
+
const validateSingleOrder = (currentOrder, rawAttributes) => {
|
|
15
14
|
const isOrderDescOrder = utils_1.isOrderDesc(currentOrder);
|
|
16
15
|
if (isOrderDescOrder && currentOrder[0] !== utils_1.ORDER_PREFIX) {
|
|
17
|
-
|
|
16
|
+
throw new errors_1.BadRequest(`${utils_1.ORDER_PREFIX} must be only at the beginning of the word`, null);
|
|
18
17
|
}
|
|
19
|
-
const
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
[formattedOrderString] = formattedOrderString.split(utils_1.ASSOCIATION_PREFIX);
|
|
25
|
-
}
|
|
26
|
-
if (!(rawAttributes.includes(formattedOrderString) || isOrderAssociation)) {
|
|
27
|
-
utils_1.throwBadRequestError(`${currentOrder} is invalid`);
|
|
18
|
+
const formattedOrderString = isOrderDescOrder ?
|
|
19
|
+
utils_1.extractAttributeNameFromOrder(currentOrder) :
|
|
20
|
+
currentOrder;
|
|
21
|
+
if (!rawAttributes.includes(formattedOrderString)) {
|
|
22
|
+
throw new errors_1.BadRequest(`${currentOrder} is invalid`, null);
|
|
28
23
|
}
|
|
29
24
|
};
|
|
30
25
|
const validateSingleAttribute = (currentAttribute, rawAttributes) => {
|
|
31
26
|
if (!rawAttributes.includes(currentAttribute)) {
|
|
32
|
-
|
|
27
|
+
throw new errors_1.BadRequest(`${currentAttribute} is invalid`, null);
|
|
33
28
|
}
|
|
34
29
|
};
|
|
35
|
-
const validateOrderAttributes = (order, rawAttributes
|
|
36
|
-
order.map(o => validateSingleOrder(o, rawAttributes
|
|
30
|
+
const validateOrderAttributes = (order, rawAttributes) => {
|
|
31
|
+
order.map(o => validateSingleOrder(o, rawAttributes));
|
|
37
32
|
};
|
|
38
33
|
const validateAttributes = (attributes, rawAttributes) => {
|
|
39
34
|
attributes.map(a => validateSingleAttribute(a, rawAttributes));
|
|
40
35
|
};
|
|
41
|
-
const validateQueryPayload = (query, rawAttributes
|
|
36
|
+
const validateQueryPayload = (query, rawAttributes) => {
|
|
42
37
|
// eslint-disable-next-line array-callback-return
|
|
43
38
|
Object.keys(query).map((key) => {
|
|
44
39
|
const value = query[key];
|
|
45
40
|
if (lodash_1.default.isArray(value)) {
|
|
46
41
|
if (lodash_1.default.isObject(value[0])) {
|
|
47
|
-
value.map(v => validateQueryPayload(v, rawAttributes
|
|
42
|
+
value.map(v => validateQueryPayload(v, rawAttributes));
|
|
48
43
|
}
|
|
49
44
|
}
|
|
50
|
-
else if (validateOperator(key)
|
|
51
|
-
|| validateQueryAttribute(key, rawAttributes, associationModels)) {
|
|
45
|
+
else if (validateOperator(key) || validateQueryAttribute(key, rawAttributes)) {
|
|
52
46
|
if (lodash_1.default.isObject(value)) {
|
|
53
47
|
validateQueryPayload(value, rawAttributes);
|
|
54
48
|
}
|
|
55
49
|
}
|
|
56
50
|
else {
|
|
57
|
-
|
|
51
|
+
throw new errors_1.BadRequest(`invalid key: ${key}`, null);
|
|
58
52
|
}
|
|
59
53
|
});
|
|
60
54
|
};
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
utils_1.throwBadRequestError('Page must be greater than 0');
|
|
64
|
-
}
|
|
65
|
-
if (perPage > utils_1.PER_PAGE_MAX_LIMIT || perPage < utils_1.PER_PAGE_MIN_LIMIT) {
|
|
66
|
-
utils_1.throwBadRequestError(`PerPage must be between ${utils_1.PER_PAGE_MIN_LIMIT} to ${utils_1.PER_PAGE_MAX_LIMIT}`);
|
|
67
|
-
}
|
|
68
|
-
};
|
|
69
|
-
const validateIncludePayload = (include, associations) => {
|
|
70
|
-
try {
|
|
71
|
-
const associationsKeys = Object.keys(associations);
|
|
72
|
-
include.forEach((i) => {
|
|
73
|
-
var _a;
|
|
74
|
-
validateQueryAttribute(i.model, associationsKeys);
|
|
75
|
-
const target = (_a = associations[i.model]) === null || _a === void 0 ? void 0 : _a.target;
|
|
76
|
-
if (!target) {
|
|
77
|
-
utils_1.throwBadRequestError('model not found in associations');
|
|
78
|
-
}
|
|
79
|
-
const { rawAttributes } = target;
|
|
80
|
-
if (include.where) {
|
|
81
|
-
validateQueryPayload(i.where, rawAttributes);
|
|
82
|
-
}
|
|
83
|
-
if (include.order) {
|
|
84
|
-
validateOrderAttributes(i.order, rawAttributes);
|
|
85
|
-
}
|
|
86
|
-
if (include.attributes) {
|
|
87
|
-
validateAttributes(i.attributes, rawAttributes);
|
|
88
|
-
}
|
|
89
|
-
if (!lodash_1.default.isNil(include.required) && !lodash_1.default.isBoolean(include.required)) {
|
|
90
|
-
utils_1.throwBadRequestError('include.required must be a boolean');
|
|
91
|
-
}
|
|
92
|
-
});
|
|
93
|
-
}
|
|
94
|
-
catch (e) {
|
|
95
|
-
utils_1.throwBadRequestError('there was a problem with the include payload');
|
|
96
|
-
}
|
|
97
|
-
};
|
|
98
|
-
exports.validatePayload = ({ query = {}, order = [], attributes = [], include = [], page = utils_1.PAGE_DEFAULT, perPage = utils_1.PER_PAGE_DEFAULT, }, model) => {
|
|
99
|
-
const rawAttributes = Object.keys(model.rawAttributes);
|
|
100
|
-
const associationModels = Object.keys((model === null || model === void 0 ? void 0 : model.associations) || {});
|
|
55
|
+
exports.validatePayload = ({ query = {}, order = [], attributes = [], }, model) => {
|
|
56
|
+
const { rawAttributes } = model;
|
|
101
57
|
if (!attributes || attributes.length === 0) {
|
|
102
58
|
// eslint-disable-next-line no-param-reassign
|
|
103
59
|
attributes = rawAttributes;
|
|
@@ -105,17 +61,7 @@ exports.validatePayload = ({ query = {}, order = [], attributes = [], include =
|
|
|
105
61
|
else {
|
|
106
62
|
validateAttributes(attributes, rawAttributes);
|
|
107
63
|
}
|
|
108
|
-
validateOrderAttributes(order, rawAttributes
|
|
109
|
-
validateQueryPayload(query, rawAttributes
|
|
110
|
-
if (include.length && typeof include === 'object') {
|
|
111
|
-
validateIncludePayload(include, model === null || model === void 0 ? void 0 : model.associations);
|
|
112
|
-
}
|
|
113
|
-
else if (include && typeof include !== 'object') {
|
|
114
|
-
utils_1.throwBadRequestError('include must be an array');
|
|
115
|
-
}
|
|
116
|
-
validatePagination({
|
|
117
|
-
page,
|
|
118
|
-
perPage,
|
|
119
|
-
});
|
|
64
|
+
validateOrderAttributes(order, rawAttributes);
|
|
65
|
+
validateQueryPayload(query, rawAttributes);
|
|
120
66
|
return true;
|
|
121
67
|
};
|
|
@@ -38,147 +38,28 @@ const query = {
|
|
|
38
38
|
};
|
|
39
39
|
const order = ['startTime', '-endTime'];
|
|
40
40
|
describe('validations test', () => {
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
rawAttributes: {
|
|
45
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
|
|
46
|
-
},
|
|
47
|
-
});
|
|
48
|
-
expect(payload).toBe(true);
|
|
49
|
-
});
|
|
50
|
-
it('check query by json property field', () => {
|
|
51
|
-
const payload = _1.validatePayload({
|
|
52
|
-
query: {
|
|
53
|
-
'jsonField.exampleField': {
|
|
54
|
-
$eq: 'a',
|
|
55
|
-
},
|
|
56
|
-
},
|
|
57
|
-
}, {
|
|
58
|
-
rawAttributes: {
|
|
59
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', jsonField: {},
|
|
60
|
-
},
|
|
61
|
-
});
|
|
62
|
-
expect(payload).toBe(true);
|
|
63
|
-
});
|
|
64
|
-
it('check query by included model field', () => {
|
|
65
|
-
const payload = _1.validatePayload({
|
|
66
|
-
query: {
|
|
67
|
-
'status.name': {
|
|
68
|
-
$eq: 'a',
|
|
69
|
-
},
|
|
70
|
-
},
|
|
71
|
-
}, {
|
|
72
|
-
rawAttributes: {
|
|
73
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
|
|
74
|
-
},
|
|
75
|
-
associations: {
|
|
76
|
-
status: {},
|
|
77
|
-
},
|
|
78
|
-
});
|
|
79
|
-
expect(payload).toBe(true);
|
|
80
|
-
});
|
|
81
|
-
it('check query by non existent field', () => {
|
|
82
|
-
try {
|
|
83
|
-
_1.validatePayload({
|
|
84
|
-
query: {
|
|
85
|
-
nonExistent: {
|
|
86
|
-
$eq: 'a',
|
|
87
|
-
},
|
|
88
|
-
},
|
|
89
|
-
}, {
|
|
90
|
-
rawAttributes: {
|
|
91
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
|
|
92
|
-
},
|
|
93
|
-
});
|
|
94
|
-
}
|
|
95
|
-
catch (error) {
|
|
96
|
-
expect(error.statusCode).toBe(400);
|
|
97
|
-
}
|
|
98
|
-
});
|
|
41
|
+
it('check query validation', () => {
|
|
42
|
+
const payload = _1.validatePayload({ query }, { rawAttributes: ['startTime', 'endTime', 'currencySymbol', 'currencyCode', 'startStationId'] });
|
|
43
|
+
expect(payload).toBe(true);
|
|
99
44
|
});
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
});
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
}
|
|
120
|
-
});
|
|
121
|
-
it('prefix in the wrong place', () => {
|
|
122
|
-
try {
|
|
123
|
-
_1.validatePayload({ order: ['startTime-', 'currencySymbol'] }, {
|
|
124
|
-
rawAttributes: {
|
|
125
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
|
|
126
|
-
},
|
|
127
|
-
});
|
|
128
|
-
}
|
|
129
|
-
catch (error) {
|
|
130
|
-
expect(error.statusCode).toBe(400);
|
|
131
|
-
}
|
|
132
|
-
});
|
|
133
|
-
it('order by included model', () => {
|
|
134
|
-
const payload = _1.validatePayload({ order: ['status.title'] }, {
|
|
135
|
-
rawAttributes: {
|
|
136
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
|
|
137
|
-
},
|
|
138
|
-
associations: {
|
|
139
|
-
status: {},
|
|
140
|
-
},
|
|
141
|
-
});
|
|
142
|
-
expect(payload).toBe(true);
|
|
143
|
-
});
|
|
144
|
-
it('order by included model descending', () => {
|
|
145
|
-
const payload = _1.validatePayload({ order: ['-status.title'] }, {
|
|
146
|
-
rawAttributes: {
|
|
147
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
|
|
148
|
-
},
|
|
149
|
-
associations: {
|
|
150
|
-
status: {},
|
|
151
|
-
},
|
|
152
|
-
});
|
|
153
|
-
expect(payload).toBe(true);
|
|
154
|
-
});
|
|
155
|
-
it('order by json field', () => {
|
|
156
|
-
const payload = _1.validatePayload({ order: ['status.title'] }, {
|
|
157
|
-
rawAttributes: {
|
|
158
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', status: '',
|
|
159
|
-
},
|
|
160
|
-
});
|
|
161
|
-
expect(payload).toBe(true);
|
|
162
|
-
});
|
|
163
|
-
it('order by json field desc', () => {
|
|
164
|
-
const payload = _1.validatePayload({ order: ['-status.title'] }, {
|
|
165
|
-
rawAttributes: {
|
|
166
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', status: '',
|
|
167
|
-
},
|
|
168
|
-
});
|
|
169
|
-
expect(payload).toBe(true);
|
|
170
|
-
});
|
|
171
|
-
it('try order by json field that doesnt exist', () => {
|
|
172
|
-
try {
|
|
173
|
-
_1.validatePayload({ order: ['-stas.title'] }, {
|
|
174
|
-
rawAttributes: {
|
|
175
|
-
startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', status: '',
|
|
176
|
-
},
|
|
177
|
-
});
|
|
178
|
-
}
|
|
179
|
-
catch (error) {
|
|
180
|
-
expect(error.statusCode).toBe(400);
|
|
181
|
-
}
|
|
182
|
-
});
|
|
45
|
+
it('check order validation', () => {
|
|
46
|
+
const payload = _1.validatePayload({ order }, { rawAttributes: ['startTime', 'endTime', 'currencySymbol', 'currencyCode', 'startStationId'] });
|
|
47
|
+
expect(payload).toBe(true);
|
|
48
|
+
});
|
|
49
|
+
it('check order validation - order does not exist', () => {
|
|
50
|
+
try {
|
|
51
|
+
_1.validatePayload({ order: ['aviv'] }, { rawAttributes: ['startTime', 'endTime', 'currencySymbol', 'currencyCode', 'startStationId'] });
|
|
52
|
+
}
|
|
53
|
+
catch (error) {
|
|
54
|
+
expect(error.statusCode).toBe(400);
|
|
55
|
+
}
|
|
56
|
+
});
|
|
57
|
+
it('check order validation - prefix in the wrong place', () => {
|
|
58
|
+
try {
|
|
59
|
+
_1.validatePayload({ order: ['startTime-', 'currencySymbol'] }, { rawAttributes: ['startTime', 'endTime', 'currencySymbol', 'currencyCode', 'startStationId'] });
|
|
60
|
+
}
|
|
61
|
+
catch (error) {
|
|
62
|
+
expect(error.statusCode).toBe(400);
|
|
63
|
+
}
|
|
183
64
|
});
|
|
184
65
|
});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@autofleet/sheilta",
|
|
3
|
-
"version": "1.0.2
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "manage cache",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -29,20 +29,19 @@
|
|
|
29
29
|
"dependencies": {
|
|
30
30
|
"@autofleet/errors": "^1.0.10",
|
|
31
31
|
"@types/node": "^14.14.20",
|
|
32
|
-
"joi": "^17.9.2",
|
|
33
32
|
"lodash": "^4.17.21"
|
|
34
33
|
},
|
|
35
34
|
"devDependencies": {
|
|
36
|
-
"
|
|
37
|
-
"@typescript-eslint/eslint-plugin": "^2.34.0",
|
|
38
|
-
"@typescript-eslint/parser": "^2.23.0",
|
|
35
|
+
"typescript": "^3.9.5",
|
|
39
36
|
"eslint": "^6.8.0",
|
|
40
37
|
"eslint-config-airbnb": "^16.1.0",
|
|
41
38
|
"eslint-plugin-import": "^2.20.1",
|
|
42
|
-
"
|
|
39
|
+
"@typescript-eslint/eslint-plugin": "^2.34.0",
|
|
40
|
+
"@typescript-eslint/parser": "^2.23.0",
|
|
41
|
+
"typescript-eslint": "0.0.1-alpha.0",
|
|
43
42
|
"ts-jest": "^25.0.0",
|
|
44
|
-
"
|
|
45
|
-
"
|
|
43
|
+
"jest": "^25.1.0",
|
|
44
|
+
"@types/jest": "^24.9.0"
|
|
46
45
|
},
|
|
47
46
|
"files": [
|
|
48
47
|
"lib/**/*"
|