n4s 2.2.0-rc.1 → 4.0.0-dev-e266d9

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.
Files changed (83) hide show
  1. package/CHANGELOG.md +129 -0
  2. package/LICENSE +1 -2
  3. package/README.md +10 -4
  4. package/compose/package.json +7 -0
  5. package/compounds/package.json +7 -0
  6. package/dist/cjs/compose.development.js +139 -0
  7. package/dist/cjs/compose.js +7 -0
  8. package/dist/cjs/compose.production.js +1 -0
  9. package/dist/cjs/compounds.development.js +132 -0
  10. package/dist/cjs/compounds.js +7 -0
  11. package/dist/cjs/compounds.production.js +1 -0
  12. package/dist/cjs/n4s.development.js +602 -0
  13. package/dist/cjs/n4s.js +7 -0
  14. package/dist/cjs/n4s.production.js +1 -0
  15. package/dist/cjs/package.json +1 -0
  16. package/dist/cjs/schema.development.js +144 -0
  17. package/dist/cjs/schema.js +7 -0
  18. package/dist/cjs/schema.production.js +1 -0
  19. package/dist/es/compose.development.js +137 -0
  20. package/dist/es/compose.production.js +1 -0
  21. package/dist/es/compounds.development.js +130 -0
  22. package/dist/es/compounds.production.js +1 -0
  23. package/dist/es/n4s.development.js +597 -0
  24. package/dist/es/n4s.production.js +1 -0
  25. package/dist/es/package.json +1 -0
  26. package/dist/es/schema.development.js +140 -0
  27. package/dist/es/schema.production.js +1 -0
  28. package/dist/umd/compose.development.js +143 -0
  29. package/dist/umd/compose.production.js +1 -0
  30. package/dist/umd/compounds.development.js +136 -0
  31. package/dist/umd/compounds.production.js +1 -0
  32. package/dist/umd/n4s.development.js +606 -0
  33. package/dist/umd/n4s.production.js +1 -0
  34. package/dist/umd/schema.development.js +148 -0
  35. package/dist/umd/schema.production.js +1 -0
  36. package/docs/README.md +10 -4
  37. package/docs/_sidebar.md +2 -2
  38. package/docs/external.md +27 -0
  39. package/docs/rules.md +74 -0
  40. package/package.json +126 -67
  41. package/schema/package.json +7 -0
  42. package/tsconfig.json +8 -0
  43. package/types/compose.d.ts +134 -0
  44. package/types/compounds.d.ts +146 -0
  45. package/types/n4s.d.ts +167 -0
  46. package/types/schema.d.ts +151 -0
  47. package/config/rollup/enforce.js +0 -13
  48. package/config/rollup/enforceExtended.js +0 -10
  49. package/config/rollup/ensure.js +0 -10
  50. package/config/rollup/rollup.config.js +0 -5
  51. package/docs/business_rules.md +0 -80
  52. package/docs/custom.md +0 -54
  53. package/docs/ensure.md +0 -40
  54. package/enforceExtended.cjs.development.js +0 -1949
  55. package/enforceExtended.cjs.production.js +0 -1949
  56. package/enforceExtended.cjs.production.min.js +0 -1
  57. package/enforceExtended.umd.development.js +0 -1955
  58. package/enforceExtended.umd.production.js +0 -1972
  59. package/enforceExtended.umd.production.min.js +0 -1
  60. package/ensure.cjs.development.js +0 -418
  61. package/ensure.cjs.production.js +0 -418
  62. package/ensure.cjs.production.min.js +0 -1
  63. package/ensure.umd.development.js +0 -424
  64. package/ensure.umd.production.js +0 -444
  65. package/ensure.umd.production.min.js +0 -1
  66. package/esm/enforceExtended.mjs.development.js +0 -1947
  67. package/esm/enforceExtended.mjs.production.js +0 -1947
  68. package/esm/enforceExtended.mjs.production.min.js +0 -1
  69. package/esm/ensure.mjs.development.js +0 -416
  70. package/esm/ensure.mjs.production.js +0 -416
  71. package/esm/ensure.mjs.production.min.js +0 -1
  72. package/esm/n4s.mjs.development.js +0 -394
  73. package/esm/n4s.mjs.production.js +0 -394
  74. package/esm/n4s.mjs.production.min.js +0 -1
  75. package/esm/package.json +0 -1
  76. package/jest.config.js +0 -3
  77. package/n4s.cjs.development.js +0 -396
  78. package/n4s.cjs.production.js +0 -396
  79. package/n4s.cjs.production.min.js +0 -1
  80. package/n4s.umd.development.js +0 -402
  81. package/n4s.umd.index.js +0 -7
  82. package/n4s.umd.production.js +0 -419
  83. package/n4s.umd.production.min.js +0 -1
@@ -1,424 +0,0 @@
1
- (function (global, factory) {
2
- typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
3
- typeof define === 'function' && define.amd ? define(factory) :
4
- (global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.ensure = factory());
5
- }(this, (function () { 'use strict';
6
-
7
- function _extends() {
8
- _extends = Object.assign || function (target) {
9
- for (var i = 1; i < arguments.length; i++) {
10
- var source = arguments[i];
11
-
12
- for (var key in source) {
13
- if (Object.prototype.hasOwnProperty.call(source, key)) {
14
- target[key] = source[key];
15
- }
16
- }
17
- }
18
-
19
- return target;
20
- };
21
-
22
- return _extends.apply(this, arguments);
23
- }
24
-
25
- function throwError(message) {
26
- throw new Error(`[${"ensure"}]: ${message}`);
27
- }
28
-
29
- const isRule = (rulesObject, name) => {
30
- const ruleExists = Object.prototype.hasOwnProperty.call(rulesObject, name) && typeof rulesObject[name] === 'function';
31
-
32
- if (!ruleExists) {
33
- throwError(`Rule "${name}" was not found in rules object. Make sure you typed it correctly.`);
34
- }
35
-
36
- return ruleExists;
37
- };
38
-
39
- const GLOBAL_OBJECT = Function('return this')();
40
-
41
- const proxySupported = () => typeof GLOBAL_OBJECT.Proxy === 'function';
42
-
43
- function bindNot(fn) {
44
- return function () {
45
- return !fn.apply(this, arguments);
46
- };
47
- }
48
-
49
- function endsWith(value, arg1) {
50
- return typeof value === 'string' && typeof arg1 === 'string' && value.endsWith(arg1);
51
- }
52
- const doesNotEndWith = bindNot(endsWith);
53
-
54
- function equals(value, arg1) {
55
- return value === arg1;
56
- }
57
- const notEquals = bindNot(equals);
58
-
59
- function isNumeric(value) {
60
- const result = !isNaN(parseFloat(value)) && !isNaN(Number(value)) && isFinite(value);
61
- return Boolean(result);
62
- }
63
- const isNotNumeric = bindNot(isNumeric);
64
-
65
- function greaterThan(value, arg1) {
66
- return isNumeric(value) && isNumeric(arg1) && Number(value) > Number(arg1);
67
- }
68
-
69
- function greaterThanOrEquals(value, arg1) {
70
- return isNumeric(value) && isNumeric(arg1) && Number(value) >= Number(arg1);
71
- }
72
-
73
- function inside(value, arg1) {
74
- if (Array.isArray(arg1) && ['string', 'number', 'boolean'].indexOf(typeof value) !== -1) {
75
- return arg1.indexOf(value) !== -1;
76
- } // both value and arg1 are strings
77
-
78
-
79
- if (typeof arg1 === 'string' && typeof value === 'string') {
80
- return arg1.indexOf(value) !== -1;
81
- }
82
-
83
- return false;
84
- }
85
- const notInside = bindNot(inside);
86
-
87
- function isArray(value) {
88
- return Boolean(Array.isArray(value));
89
- }
90
- const isNotArray = bindNot(isArray);
91
-
92
- function lessThanOrEquals(value, arg1) {
93
- return isNumeric(value) && isNumeric(arg1) && Number(value) <= Number(arg1);
94
- }
95
-
96
- function isBetween(value, min, max) {
97
- return greaterThanOrEquals(value, min) && lessThanOrEquals(value, max);
98
- }
99
- const isNotBetween = bindNot(isBetween);
100
-
101
- function isEmpty(value) {
102
- if (!value) {
103
- return true;
104
- } else if (isNumeric(value)) {
105
- return value === 0;
106
- } else if (Object.prototype.hasOwnProperty.call(value, 'length')) {
107
- return value.length === 0;
108
- } else if (typeof value === 'object') {
109
- return Object.keys(value).length === 0;
110
- } else {
111
- return true;
112
- }
113
- }
114
- const isNotEmpty = bindNot(isEmpty);
115
-
116
- /**
117
- * Validates that a given value is an even number
118
- * @param {Number|String} value Value to be validated
119
- * @return {Boolean}
120
- */
121
-
122
- const isEven = value => {
123
- if (!isNumeric(value)) {
124
- return false;
125
- }
126
-
127
- return value % 2 === 0;
128
- };
129
-
130
- function isNaN$1(value) {
131
- return Number.isNaN(value);
132
- }
133
- const isNotNaN = bindNot(isNaN$1);
134
-
135
- function isNegative(value) {
136
- if (isNumeric(value)) {
137
- return Number(value) < 0;
138
- }
139
-
140
- return false;
141
- }
142
- const isPositive = bindNot(isNegative);
143
-
144
- function isNull(value) {
145
- return value === null;
146
- }
147
- const isNotNull = bindNot(isNull);
148
-
149
- function isNumber(value) {
150
- return Boolean(typeof value === 'number');
151
- }
152
- const isNotNumber = bindNot(isNumber);
153
-
154
- /**
155
- * Validates that a given value is an odd number
156
- * @param {Number|String} value Value to be validated
157
- * @return {Boolean}
158
- */
159
-
160
- const isOdd = value => {
161
- if (!isNumeric(value)) {
162
- return false;
163
- }
164
-
165
- return value % 2 !== 0;
166
- };
167
-
168
- function isString(value) {
169
- return Boolean(typeof value === 'string');
170
- }
171
- const isNotString = bindNot(isString);
172
-
173
- function isTruthy(value) {
174
- return !!value;
175
- }
176
- const isFalsy = bindNot(isTruthy);
177
-
178
- function isUndefined(value) {
179
- return value === undefined;
180
- }
181
- const isNotUndefined = bindNot(isUndefined);
182
-
183
- function lengthEquals(value, arg1) {
184
- return value.length === arg1;
185
- }
186
- const lengthNotEquals = bindNot(lengthEquals);
187
-
188
- function lessThan(value, arg1) {
189
- return isNumeric(value) && isNumeric(arg1) && Number(value) < Number(arg1);
190
- }
191
-
192
- function longerThan(value, arg1) {
193
- return value.length > arg1;
194
- }
195
-
196
- function longerThanOrEquals(value, arg1) {
197
- return value.length >= arg1;
198
- }
199
-
200
- function matches(value, regex) {
201
- if (regex instanceof RegExp) {
202
- return regex.test(value);
203
- } else if (typeof regex === 'string') {
204
- return new RegExp(regex).test(value);
205
- } else {
206
- return false;
207
- }
208
- }
209
- const notMatches = bindNot(matches);
210
-
211
- function numberEquals(value, arg1) {
212
- return isNumeric(value) && isNumeric(arg1) && Number(value) === Number(arg1);
213
- }
214
- const numberNotEquals = bindNot(numberEquals);
215
-
216
- function shorterThan(value, arg1) {
217
- return value.length < arg1;
218
- }
219
-
220
- function shorterThanOrEquals(value, arg1) {
221
- return value.length <= arg1;
222
- }
223
-
224
- function startsWith(value, arg1) {
225
- return typeof value === 'string' && typeof arg1 === 'string' && value.startsWith(arg1);
226
- }
227
- const doesNotStartWith = bindNot(startsWith);
228
-
229
- var rules = {
230
- doesNotEndWith,
231
- doesNotStartWith,
232
- endsWith,
233
- equals,
234
- greaterThan,
235
- greaterThanOrEquals,
236
- gt: greaterThan,
237
- gte: greaterThanOrEquals,
238
- inside,
239
- isArray,
240
- isBetween,
241
- isEmpty,
242
- isEven,
243
- isFalsy,
244
- isNaN: isNaN$1,
245
- isNegative,
246
- isNotArray,
247
- isNotBetween,
248
- isNotEmpty,
249
- isNotNaN,
250
- isNotNull,
251
- isNotNumber,
252
- isNotNumeric,
253
- isNotString,
254
- isNotUndefined,
255
- isNull,
256
- isNumber,
257
- isNumeric,
258
- isOdd,
259
- isPositive,
260
- isString,
261
- isTruthy,
262
- isUndefined,
263
- lengthEquals,
264
- lengthNotEquals,
265
- lessThan,
266
- lessThanOrEquals,
267
- longerThan,
268
- longerThanOrEquals,
269
- lt: lessThan,
270
- lte: lessThanOrEquals,
271
- matches,
272
- notEquals,
273
- notInside,
274
- notMatches,
275
- numberEquals,
276
- numberNotEquals,
277
- shorterThan,
278
- shorterThanOrEquals,
279
- startsWith
280
- };
281
-
282
- function validateResult(result, rule) {
283
- if (typeof result !== 'boolean' && (!result || typeof result.pass !== 'boolean')) {
284
- throwError(`${rule.name} wrong return value for the rule please check that the return is valid`);
285
- }
286
- } // for easier testing and mocking
287
-
288
- function getDefaultResult(value, rule) {
289
- return {
290
- message: formatResultMessage(rule, `invalid ${typeof value} value`)
291
- };
292
- }
293
- function formatResultMessage(rule, msg) {
294
- return `[${"ensure"}]/${rule.name} ${msg}`;
295
- }
296
- /**
297
- * Transform the result of a rule into a standard format
298
- * @param {string} interfaceName to be used in the messages
299
- * @param {*} result of the rule
300
- * @param {Object} options
301
- * @param {function} options.rule
302
- * @param {*} options.value
303
- * @returns {Object} result
304
- * @returns {string} result.message
305
- * @returns {boolean} result.pass indicates if the test passes or not
306
- */
307
-
308
- function transformResult(result, {
309
- rule,
310
- value
311
- }) {
312
- const defaultResult = getDefaultResult(value, rule);
313
- validateResult(result, rule);
314
-
315
- if (typeof result === 'boolean') {
316
- return _extends({}, defaultResult, {
317
- pass: result
318
- });
319
- } else {
320
- const formattedResult = {
321
- pass: result.pass
322
- };
323
-
324
- if (result.message) {
325
- formattedResult.message = formatResultMessage(rule, typeof result.message === 'function' ? result.message() : result.message);
326
- }
327
-
328
- return _extends({}, defaultResult, formattedResult);
329
- }
330
- }
331
-
332
- /**
333
- * Run a single rule against ensured value (e.g. `isNumber()`)
334
- * @param {Function} rule - rule to run
335
- * @param {Any} value
336
- * @param {Array} args list of arguments sent from consumer
337
- * @return {Boolean}
338
- */
339
-
340
- function runner(rule, value, ...args) {
341
- try {
342
- const result = rule(value, ...args);
343
- return transformResult(result, {
344
- rule,
345
- value
346
- }).pass;
347
- } catch (err) {
348
- return false;
349
- }
350
- }
351
-
352
- /**
353
- * Accepts list of registered rules and returns a test function
354
- * That runs against them to return a boolean
355
- *
356
- * @param {Array} registeredRules
357
- * @return {Function} test function
358
- */
359
-
360
- const createTestFn = registeredRules => value => registeredRules.every(({
361
- name,
362
- args
363
- }) => runner(rulesObject[name], value, ...args));
364
-
365
- let ensure, rulesList;
366
-
367
- const rulesObject = _extends({}, rules);
368
-
369
- if (proxySupported()) {
370
- ensure = () => {
371
- const registeredRules = [];
372
- const proxy = new Proxy(rulesObject, {
373
- get: (rules, ruleName) => {
374
- if (ruleName === 'test') {
375
- return createTestFn(registeredRules);
376
- }
377
-
378
- if (!isRule(rulesObject, ruleName)) {
379
- return;
380
- }
381
-
382
- return (...args) => {
383
- registeredRules.push({
384
- name: ruleName,
385
- args
386
- });
387
- return proxy;
388
- };
389
- }
390
- });
391
- return proxy;
392
- };
393
- }
394
-
395
- rulesList = Object.keys(rulesObject);
396
-
397
- ensure = () => {
398
- const registeredRules = [];
399
- return rulesList.reduce((allRules, ruleName) => Object.assign(allRules, _extends({}, isRule(rulesObject, ruleName) && {
400
- [ruleName]: (...args) => {
401
- registeredRules.push({
402
- name: ruleName,
403
- args
404
- });
405
- return allRules;
406
- }
407
- })), {
408
- test: createTestFn(registeredRules)
409
- });
410
- };
411
-
412
- ensure.extend = customRules => {
413
- Object.assign(rulesObject, customRules);
414
-
415
- if (proxySupported()) {
416
- rulesList = Object.keys(rulesObject);
417
- }
418
- };
419
-
420
- var ensure$1 = ensure;
421
-
422
- return ensure$1;
423
-
424
- })));