-
Notifications
You must be signed in to change notification settings - Fork 46
/
ImmutablePropTypes.js
287 lines (255 loc) · 10.6 KB
/
ImmutablePropTypes.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
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
/**
* This is a straight rip-off of the React.js ReactPropTypes.js proptype validators,
* modified to make it possible to validate Immutable.js data.
* ImmutableTypes.listOf is patterned after React.PropTypes.arrayOf, but for Immutable.List
* ImmutableTypes.shape is based on React.PropTypes.shape, but for any Immutable.Iterable
*/
var Immutable = require('immutable');
var ANONYMOUS = '<<anonymous>>';
var ImmutablePropTypes;
if (process.env.NODE_ENV !== 'production') {
ImmutablePropTypes = {
listOf: createListOfTypeChecker,
mapOf: createMapOfTypeChecker,
orderedMapOf: createOrderedMapOfTypeChecker,
setOf: createSetOfTypeChecker,
orderedSetOf: createOrderedSetOfTypeChecker,
stackOf: createStackOfTypeChecker,
iterableOf: createIterableOfTypeChecker,
recordOf: createRecordOfTypeChecker,
shape: createShapeChecker,
contains: createShapeChecker,
mapContains: createMapContainsChecker,
// Primitive Types
list: createImmutableTypeChecker('List', Immutable.List.isList),
map: createImmutableTypeChecker('Map', Immutable.Map.isMap),
orderedMap: createImmutableTypeChecker('OrderedMap', Immutable.OrderedMap.isOrderedMap),
set: createImmutableTypeChecker('Set', Immutable.Set.isSet),
orderedSet: createImmutableTypeChecker('OrderedSet', Immutable.OrderedSet.isOrderedSet),
stack: createImmutableTypeChecker('Stack', Immutable.Stack.isStack),
seq: createImmutableTypeChecker('Seq', Immutable.Seq.isSeq),
record: createImmutableTypeChecker('Record', function(isRecord) { return isRecord instanceof Immutable.Record; }),
iterable: createImmutableTypeChecker('Iterable', Immutable.Iterable.isIterable)
};
} else {
var productionTypeChecker = function() {
invariant(
false,
'ImmutablePropTypes type checking code is stripped in production.'
);
};
productionTypeChecker.isRequired = productionTypeChecker;
var getProductionTypeChecker = function () { return productionTypeChecker };
ImmutablePropTypes = {
listOf: getProductionTypeChecker,
mapOf: getProductionTypeChecker,
orderedMapOf: getProductionTypeChecker,
setOf: getProductionTypeChecker,
orderedSetOf: getProductionTypeChecker,
stackOf: getProductionTypeChecker,
iterableOf: getProductionTypeChecker,
recordOf: getProductionTypeChecker,
shape: getProductionTypeChecker,
contains: getProductionTypeChecker,
mapContains: getProductionTypeChecker,
// Primitive Types
list: productionTypeChecker,
map: productionTypeChecker,
orderedMap: productionTypeChecker,
set: productionTypeChecker,
orderedSet: productionTypeChecker,
stack: productionTypeChecker,
seq: productionTypeChecker,
record: productionTypeChecker,
iterable: productionTypeChecker
};
}
ImmutablePropTypes.iterable.indexed = createIterableSubclassTypeChecker('Indexed', Immutable.Iterable.isIndexed);
ImmutablePropTypes.iterable.keyed = createIterableSubclassTypeChecker('Keyed', Immutable.Iterable.isKeyed);
function getPropType(propValue) {
var propType = typeof propValue;
if (Array.isArray(propValue)) {
return 'array';
}
if (propValue instanceof RegExp) {
// Old webkits (at least until Android 4.0) return 'function' rather than
// 'object' for typeof a RegExp. We'll normalize this here so that /bla/
// passes PropTypes.object.
return 'object';
}
if (propValue instanceof Immutable.Iterable) {
return 'Immutable.' + propValue.toSource().split(' ')[0];
}
return propType;
}
function createChainableTypeChecker(validate) {
function checkType(isRequired, props, propName, componentName, location, propFullName, ...rest) {
propFullName = propFullName || propName;
componentName = componentName || ANONYMOUS;
if (props[propName] == null) {
var locationName = location;
if (isRequired) {
return new Error(
`Required ${locationName} \`${propFullName}\` was not specified in ` +
`\`${componentName}\`.`
);
}
} else {
return validate(props, propName, componentName, location, propFullName, ...rest);
}
}
var chainedCheckType = checkType.bind(null, false);
chainedCheckType.isRequired = checkType.bind(null, true);
return chainedCheckType;
}
function createImmutableTypeChecker(immutableClassName, immutableClassTypeValidator) {
function validate(props, propName, componentName, location, propFullName) {
var propValue = props[propName];
if(!immutableClassTypeValidator(propValue)) {
var propType = getPropType(propValue);
return new Error(
`Invalid ${location} \`${propFullName}\` of type \`${propType}\` ` +
`supplied to \`${componentName}\`, expected \`${immutableClassName}\`.`
);
}
return null;
}
return createChainableTypeChecker(validate);
}
function createIterableSubclassTypeChecker(subclassName, validator) {
return createImmutableTypeChecker(`Iterable.${subclassName}`, (propValue) =>
Immutable.Iterable.isIterable(propValue) && validator(propValue)
);
}
function createIterableTypeChecker(typeChecker, immutableClassName, immutableClassTypeValidator) {
function validate(props, propName, componentName, location, propFullName, ...rest) {
var propValue = props[propName];
if (!immutableClassTypeValidator(propValue)) {
var locationName = location;
var propType = getPropType(propValue);
return new Error(
`Invalid ${locationName} \`${propFullName}\` of type ` +
`\`${propType}\` supplied to \`${componentName}\`, expected an Immutable.js ${immutableClassName}.`
);
}
if (typeof typeChecker !== 'function') {
return new Error(
`Invalid typeChecker supplied to \`${componentName}\` ` +
`for propType \`${propFullName}\`, expected a function.`
);
}
var propValues = propValue.toArray();
for (var i = 0, len = propValues.length; i < len; i++) {
var error = typeChecker(propValues, i, componentName, location, `${propFullName}[${i}]`, ...rest);
if (error instanceof Error) {
return error;
}
}
}
return createChainableTypeChecker(validate);
}
function createKeysTypeChecker(typeChecker) {
function validate(props, propName, componentName, location, propFullName, ...rest) {
var propValue = props[propName];
if (typeof typeChecker !== 'function') {
return new Error(
`Invalid keysTypeChecker (optional second argument) supplied to \`${componentName}\` ` +
`for propType \`${propFullName}\`, expected a function.`
);
}
var keys = propValue.keySeq().toArray();
for (var i = 0, len = keys.length; i < len; i++) {
var error = typeChecker(keys, i, componentName, location, `${propFullName} -> key(${keys[i]})`, ...rest);
if (error instanceof Error) {
return error;
}
}
}
return createChainableTypeChecker(validate);
}
function createListOfTypeChecker(typeChecker) {
return createIterableTypeChecker(typeChecker, 'List', Immutable.List.isList);
}
function createMapOfTypeCheckerFactory(valuesTypeChecker, keysTypeChecker, immutableClassName, immutableClassTypeValidator) {
function validate(...args) {
return createIterableTypeChecker(valuesTypeChecker, immutableClassName, immutableClassTypeValidator)(...args)
|| keysTypeChecker && createKeysTypeChecker(keysTypeChecker)(...args)
}
return createChainableTypeChecker(validate);
}
function createMapOfTypeChecker(valuesTypeChecker, keysTypeChecker) {
return createMapOfTypeCheckerFactory(valuesTypeChecker, keysTypeChecker, 'Map', Immutable.Map.isMap);
}
function createOrderedMapOfTypeChecker(valuesTypeChecker, keysTypeChecker) {
return createMapOfTypeCheckerFactory(valuesTypeChecker, keysTypeChecker, 'OrderedMap', Immutable.OrderedMap.isOrderedMap);
}
function createSetOfTypeChecker(typeChecker) {
return createIterableTypeChecker(typeChecker, 'Set', Immutable.Set.isSet);
}
function createOrderedSetOfTypeChecker(typeChecker) {
return createIterableTypeChecker(typeChecker, 'OrderedSet', Immutable.OrderedSet.isOrderedSet);
}
function createStackOfTypeChecker(typeChecker) {
return createIterableTypeChecker(typeChecker, 'Stack', Immutable.Stack.isStack);
}
function createIterableOfTypeChecker(typeChecker) {
return createIterableTypeChecker(typeChecker, 'Iterable', Immutable.Iterable.isIterable);
}
function createRecordOfTypeChecker(recordKeys) {
function validate(props, propName, componentName, location, propFullName, ...rest) {
var propValue = props[propName];
if (!(propValue instanceof Immutable.Record)) {
var propType = getPropType(propValue);
var locationName = location;
return new Error(
`Invalid ${locationName} \`${propFullName}\` of type \`${propType}\` ` +
`supplied to \`${componentName}\`, expected an Immutable.js Record.`
);
}
for (var key in recordKeys) {
var checker = recordKeys[key];
if (!checker) {
continue;
}
var mutablePropValue = propValue.toObject();
var error = checker(mutablePropValue, key, componentName, location, `${propFullName}.${key}`, ...rest);
if (error) {
return error;
}
}
}
return createChainableTypeChecker(validate);
}
// there is some irony in the fact that shapeTypes is a standard hash and not an immutable collection
function createShapeTypeChecker(shapeTypes, immutableClassName = 'Iterable', immutableClassTypeValidator = Immutable.Iterable.isIterable) {
function validate(props, propName, componentName, location, propFullName, ...rest) {
var propValue = props[propName];
if (!immutableClassTypeValidator(propValue)) {
var propType = getPropType(propValue);
var locationName = location;
return new Error(
`Invalid ${locationName} \`${propFullName}\` of type \`${propType}\` ` +
`supplied to \`${componentName}\`, expected an Immutable.js ${immutableClassName}.`
);
}
var mutablePropValue = propValue.toObject();
for (var key in shapeTypes) {
var checker = shapeTypes[key];
if (!checker) {
continue;
}
var error = checker(mutablePropValue, key, componentName, location, `${propFullName}.${key}`, ...rest);
if (error) {
return error;
}
}
}
return createChainableTypeChecker(validate);
}
function createShapeChecker(shapeTypes) {
return createShapeTypeChecker(shapeTypes);
}
function createMapContainsChecker(shapeTypes) {
return createShapeTypeChecker(shapeTypes, 'Map', Immutable.Map.isMap);
}
module.exports = ImmutablePropTypes;