| 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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328 |
1
1
54
54
55
54
1
1
54
47
7
7
47
47
47
1
379
379
59
320
72
248
7
241
1
373
373
55
373
373
106
185
185
373
1
379
379
379
1
324
324
324
324
324
188
136
1
1
1
1
1
| "use strict";
var _ = require("lodash"),
Types = require("./Types"),
Type = require("../Type"),
Safe = require("../Safe"),
Assert = require("../Assert");
/**
*
* Default conversion between the value and a SchemaDefinition.
* This converts a primitive value to a SchemaDefinition with defaults
* value.
*
* @type {Object}
*
*/
var Defaults = {
array: function(value){
Eif(!Type.isArray(value)){
return;
}
// no default value and its required!
value = new SchemaDefinition({
schema: value,
required: true
});
return value;
},
object: function(value){
if(!Type.isObject(value)){
return;
}
// no default value and its required!
value = new SchemaDefinition({
schema: value,
required: true
});
return value;
},
string: function(value){
if(!Type.isString(value)){
return;
}
// no default value and its required!
value = new SchemaDefinition({
schema: "",
required: true
});
return value;
},
number: function(value){
Iif(!Type.isNumber(value)){
return;
}
// no default value and its required!
value = new SchemaDefinition({
schema: 0,
required: true
});
return value;
},
boolean: function(value){
if(!Type.isBoolean(value)){
return;
}
// no default value and its required!
value = new SchemaDefinition({
schema: Boolean(value),
required: true
});
return value;
},
function: function(value){
if(!Type.isFunction(value)){
return;
}
// no default value and its required!
value = new SchemaDefinition({
schema: function(){},
required: true
});
return value;
},
};
/**
*
* Normalize the schema value in order to avoid storing unnecessary
* data and keep the values consistent across usages.
*
* @param {String} value
* @return {*}
*
*/
var normalizeSchemaValue = function(value){
value = Safe.value(value);
if(Type.isString(value)){
return "";
}
if(Type.isNumber(value)){
return 0;
}
if(Type.isBoolean(value)){
return true;
}
return value;
};
/**
*
* Compile the given schema definition or compatible
* structure.
*
* @param {*} schema
* @param {Object} options
*
* @return {SchemaDefinition}
*
*/
var compile = function(schema, options){
/// extensibility point - prepare the value before the
/// compilation
schema = options.prepare(schema);
/// apply the defaults and create the SchemaDefinition if an object
/// has been provided
if(!Type.instanceOf(schema, Types.SchemaDefinition)){
schema = Defaults.object(schema) || Defaults.array(schema) ||
Defaults.string(schema) || Defaults.number(schema) ||
Defaults.boolean(schema) || Defaults.function(schema);
}
/// convert the schema
var isArray = Type.isArray(schema.schema),
isObject = Type.isObject(schema.schema);
/// iterate over the structure in order to compile the schema
if(isArray || isObject){
_.each(schema.schema, function(val, index){
var innerSchema = compile(val, options);
schema.schema[index] = innerSchema;
});
}
return schema;
};
/**
*
* A SchemaDefinition class. Contains all the rules that should be applied when
* evaluating it against a value.
*
* @param {Object} options
*
*/
var SchemaDefinition = function(options){
options = Safe.object(options);
/**
*
* SchemaDefinition module API
*
* @type {Object}
*
*/
var self = {
/**
*
* The type of schema
*
* @type {SchemaDefinition}
*
*/
schema: normalizeSchemaValue(options.schema),
/**
*
* Flag that enables strict convertion.
*
* @type {Boolean}
*
*/
strict: Safe.boolean(options.strict, false),
/**
*
* Any flag. This means that any value is accepted.
*
* @type {Boolean}
*
*/
any: Safe.boolean(options.any, false),
/**
*
* The default value of the schema
*
* @type {*}
*/
default: options.default,
/**
*
* IsRequired flag
*
* @type {Boolean}
*
*/
required: Safe.boolean(options.required, true),
/**
*
* Repeatable flag. This means, e.g. if the schema is an array the inner schema can
* be repeatable by elements.
*
* @type {Boolean}
*/
repeatable: Safe.boolean(options.repeatable),
/**
*
* The validation functions to apply to this Schema node. Each validation function is
* represented by: { name: 'fn', args: '' }
*
* @type {Array}
*
*/
validations: Safe.array(options.validations),
};
return new Types.SchemaDefinition(self);
};
/**
*
* @class
* A SchemaDefinition compiled class. This represents a fully compiled
* instance of all inner structures that represents a Schema.
*
* A full iteration over the entire schema structure will be performed.
*
* @param {Object} options The SchemaDefinition data
* @param {Object} cOptions The compilation options
*
*/
var CompiledSchemaDefinition = function(options, cOptions){
/// normalize the given compilation options
cOptions = Safe.object(cOptions);
cOptions.compile = Safe.boolean(cOptions.compile, true);
cOptions.prepare = Safe.function(cOptions.prepare, function(v){ return v; });
/* jshint -W064 */
var schema = SchemaDefinition(options);
/// traverse the schema structure compiling its inner elements
if(cOptions.compile){
return compile(schema, cOptions);
}
return schema;
};
/// include type checking Mixin
require("./Mixins/SchemaType")
.call(Types.SchemaDefinition.prototype);
/// include clone Mixin functionality
require("./Mixins/SchemaClone")
.apply(Types.SchemaDefinition.prototype, [ CompiledSchemaDefinition ]);
/// include execution Mixin functionality
require("./Mixins/SchemaExecution")
.call(Types.SchemaDefinition.prototype);
/// include serialization functionality
require("./Mixins/SchemaSerialization")
.call(Types.SchemaDefinition.prototype);
module.exports = CompiledSchemaDefinition;
|