@litert/typeguard 1.1.0 → 1.3.0

package/src/lib/Modifiers.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
+ * Copyright 2022 Angus Fenying <fenying@litert.org>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/src/lib/index.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
+ * Copyright 2022 Angus Fenying <fenying@litert.org>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/src/lib/langs/JavaScript.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
+ * Copyright 2022 Angus Fenying <fenying@litert.org>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -192,7 +192,7 @@ implements C.ILanguageBuilder {
         regExp: string
     ): string {
 
-        let m = /^\/(.+)\/([a-z]*)$/i.exec(regExp);
+        const m = /^\/(.+)\/([a-z]*)$/i.exec(regExp);
 
         if (m) {
 
@@ -289,12 +289,14 @@ implements C.ILanguageBuilder {
     }
 
     public forEach(
-        an: string,
-        it: string,
+        arrVar: string,
+        elVar: string,
+        iterVar: string,
         body: string
     ): string {
 
-        return `for (const ${it} of ${an}) {
+        return `for (let ${elVar} = 0; ${elVar} < ${arrVar}.length; ${elVar}++) {
+            const ${iterVar} = ${arrVar}[${elVar}];
             ${body}
         }`;
     }
@@ -424,6 +426,57 @@ implements C.ILanguageBuilder {
             args.join(', ')
         })`;
     }
+
+    public escape(str: string): string {
+
+        return str.replace(/(['"])/g, '\\$1').replace(/\n/g, '\\n').replace(/\r/g, '\\r');
+    }
+
+    public stringTemplateVar(varExpr: string): string {
+
+        return `"\${${varExpr}.replace(/(['"])/g, '\\\\$1').replace(/\\n/g, '\\\\n').replace(/\\r/g, '\\\\r')}"`;
+    }
+
+    public numberTemplateVar(varExpr: string): string {
+
+        return `\${${varExpr}}`;
+    }
+
+    public addTrace(
+        vTrace: string,
+        vTraceStack: string,
+        path: string,
+        negative: boolean = false
+    ): string {
+
+        if (negative) {
+
+            return `(${vTrace}.push(\`\${${vTraceStack}}${path}\`), true)`;
+        }
+
+        return `(${vTrace}.push(\`\${${vTraceStack}}${path}\`), false)`;
+    }
+
+    public add(a: string | number, b: string | number): string {
+
+        return `${a} + ${b}`;
+    }
+
+    public orAddTrace(
+        expr: string,
+        vTrace: string,
+        vTraceStack: string,
+        path: string,
+        negative: boolean = false
+    ): string {
+
+        if (negative) {
+
+            return `((${expr}) && (${vTrace}.push(\`\${${vTraceStack}}${path}\`), true))`;
+        }
+
+        return `((${expr}) || (${vTrace}.push(\`\${${vTraceStack}}${path}\`), false))`;
+    }
 }
 
 /**

package/src/test/00-all.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
+ * Copyright 2022 Angus Fenying <fenying@litert.org>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/src/test/01-elemental-types.ts

@@ -1,5 +1,6 @@
+/* eslint-disable @typescript-eslint/no-loss-of-precision */
 /**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
+ * Copyright 2022 Angus Fenying <fenying@litert.org>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/src/test/02-array-and-list.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
+ * Copyright 2022 Angus Fenying <fenying@litert.org>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -158,38 +158,38 @@ const testItems: ITestSuite = {
             'a->[]': 'string'
         }, [
             assertItem([], false),
-            assertItem({'a': []}, true),
-            assertItem({'a': [1]}, false),
-            assertItem({'a': ['1']}, true)
+            assertItem({ 'a': [] }, true),
+            assertItem({ 'a': [1] }, false),
+            assertItem({ 'a': ['1'] }, true)
         ]),
         addRule({
             'a->[3]': 'string'
         }, [
             assertItem([], false),
-            assertItem({'a': []}, false),
-            assertItem({'a': [1, 1, 2]}, false),
-            assertItem({'a': ['1', 'f', 'c']}, true),
-            assertItem({'a': ['1', 'f', 'c', 'c']}, false)
+            assertItem({ 'a': [] }, false),
+            assertItem({ 'a': [1, 1, 2] }, false),
+            assertItem({ 'a': ['1', 'f', 'c'] }, true),
+            assertItem({ 'a': ['1', 'f', 'c', 'c'] }, false)
         ]),
         addRule({
             'a->[3,]': 'string'
         }, [
             assertItem([], false),
-            assertItem({'a': []}, false),
-            assertItem({'a': [1, 1, 2]}, false),
-            assertItem({'a': ['1', 'f', 'c']}, true),
-            assertItem({'a': ['1', 'f', 'c', 'c']}, true)
+            assertItem({ 'a': [] }, false),
+            assertItem({ 'a': [1, 1, 2] }, false),
+            assertItem({ 'a': ['1', 'f', 'c'] }, true),
+            assertItem({ 'a': ['1', 'f', 'c', 'c'] }, true)
         ]),
         addRule({
             'a->[3,5]': 'string'
         }, [
             assertItem([], false),
-            assertItem({'a': []}, false),
-            assertItem({'a': [1, 1, 2]}, false),
-            assertItem({'a': ['1', 'f', 'c']}, true),
-            assertItem({'a': ['1', 'f', 'c', 'c']}, true),
-            assertItem({'a': ['1', 'f', 'c', 'c', '5']}, true),
-            assertItem({'a': ['1', 'f', 'c', 'c', '5', 'c']}, false)
+            assertItem({ 'a': [] }, false),
+            assertItem({ 'a': [1, 1, 2] }, false),
+            assertItem({ 'a': ['1', 'f', 'c'] }, true),
+            assertItem({ 'a': ['1', 'f', 'c', 'c'] }, true),
+            assertItem({ 'a': ['1', 'f', 'c', 'c', '5'] }, true),
+            assertItem({ 'a': ['1', 'f', 'c', 'c', '5', 'c'] }, false)
         ])
     ],
 };

package/src/test/03-tuple.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
+ * Copyright 2022 Angus Fenying <fenying@litert.org>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/src/test/04-from-string.ts

@@ -1,5 +1,6 @@
+/* eslint-disable @typescript-eslint/no-loss-of-precision */
 /**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
+ * Copyright 2022 Angus Fenying <fenying@litert.org>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/src/test/05-string-asserts.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
+ * Copyright 2022 Angus Fenying <fenying@litert.org>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/src/test/06-structure.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
+ * Copyright 2022 Angus Fenying <fenying@litert.org>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,7 +32,7 @@ const testItems: ITestSuite = {
                 },
                 {
                     inputName: 'Object with one property',
-                    inputValue: {'a': 123},
+                    inputValue: { 'a': 123 },
                     expect: true
                 },
                 {
@@ -56,7 +56,7 @@ const testItems: ITestSuite = {
                 },
                 {
                     inputName: 'Object with one property',
-                    inputValue: {'a': 123},
+                    inputValue: { 'a': 123 },
                     expect: true
                 },
                 {
@@ -80,12 +80,12 @@ const testItems: ITestSuite = {
                 },
                 {
                     inputName: 'Object with one property',
-                    inputValue: {'a': 123},
+                    inputValue: { 'a': 123 },
                     expect: true
                 },
                 {
                     inputName: 'Object with one mismatch-type property',
-                    inputValue: {'a': '123'},
+                    inputValue: { 'a': '123' },
                     expect: false
                 },
                 {
@@ -109,22 +109,22 @@ const testItems: ITestSuite = {
                 },
                 {
                     inputName: 'Object with one property',
-                    inputValue: {'a': 123},
+                    inputValue: { 'a': 123 },
                     expect: false
                 },
                 {
                     inputName: 'Object with mismatch-typed nest property',
-                    inputValue: {'a': 123, 'b': { 'c': 1232131 }},
+                    inputValue: { 'a': 123, 'b': { 'c': 1232131 } },
                     expect: false
                 },
                 {
                     inputName: 'Object with one mismatch-typed property',
-                    inputValue: {'a': '123', 'b': { 'c': 'ffff'} },
+                    inputValue: { 'a': '123', 'b': { 'c': 'ffff' } },
                     expect: false
                 },
                 {
                     inputName: 'Object with all corrected',
-                    inputValue: {'a': 123, 'b': { 'c': 'ffff'} },
+                    inputValue: { 'a': 123, 'b': { 'c': 'ffff' } },
                     expect: true
                 }
             ]
@@ -142,17 +142,17 @@ const testItems: ITestSuite = {
                 },
                 {
                     inputName: 'Object with one property',
-                    inputValue: {'a': 123},
+                    inputValue: { 'a': 123 },
                     expect: true
                 },
                 {
                     inputName: 'Object with one mismatch-typed property',
-                    inputValue: {'a': '123' },
+                    inputValue: { 'a': '123' },
                     expect: false
                 },
                 {
                     inputName: 'Object with 2 properties',
-                    inputValue: {'a': 123, 'b': { 'c': 'ffff'} },
+                    inputValue: { 'a': 123, 'b': { 'c': 'ffff' } },
                     expect: false
                 }
             ]
@@ -168,22 +168,22 @@ const testItems: ITestSuite = {
             'items': [
                 {
                     inputName: 'Object with one property',
-                    inputValue: {'a': 123},
+                    inputValue: { 'a': 123 },
                     expect: false
                 },
                 {
                     inputName: 'Object with wrong type in nest',
-                    inputValue: {'a': 123, 'b': { 'c': 'ffff'} },
+                    inputValue: { 'a': 123, 'b': { 'c': 'ffff' } },
                     expect: false
                 },
                 {
                     inputName: 'Object with all correct',
-                    inputValue: {'a': 123, 'b': { 'c': 123 } },
+                    inputValue: { 'a': 123, 'b': { 'c': 123 } },
                     expect: true
                 },
                 {
                     inputName: 'Object with one more in nested',
-                    inputValue: {'a': 123, 'b': { 'c': 123, 'd': '1213131' } },
+                    inputValue: { 'a': 123, 'b': { 'c': 123, 'd': '1213131' } },
                     expect: true
                 }
             ]
@@ -199,22 +199,22 @@ const testItems: ITestSuite = {
             'items': [
                 {
                     inputName: 'Object with one property',
-                    inputValue: {'a': 123},
+                    inputValue: { 'a': 123 },
                     expect: false
                 },
                 {
                     inputName: 'Object with wrong type in nest',
-                    inputValue: {'a': 123, 'b': { 'c': 'ffff'} },
+                    inputValue: { 'a': 123, 'b': { 'c': 'ffff' } },
                     expect: false
                 },
                 {
                     inputName: 'Object with all correct',
-                    inputValue: {'a': 123, 'b': { 'c': 123 } },
+                    inputValue: { 'a': 123, 'b': { 'c': 123 } },
                     expect: true
                 },
                 {
                     inputName: 'Object with one more in nested',
-                    inputValue: {'a': 123, 'b': { 'c': 123, 'd': '1213131' } },
+                    inputValue: { 'a': 123, 'b': { 'c': 123, 'd': '1213131' } },
                     expect: false
                 }
             ]
@@ -230,17 +230,17 @@ const testItems: ITestSuite = {
             'items': [
                 {
                     inputName: 'Object with all correct',
-                    inputValue: {'a': 123, 'b': { 'c': 123 } },
+                    inputValue: { 'a': 123, 'b': { 'c': 123 } },
                     expect: true
                 },
                 {
                     inputName: 'Object with string incorrect-value',
-                    inputValue: {'a': 123, 'b': { 'c': '123d' } },
+                    inputValue: { 'a': 123, 'b': { 'c': '123d' } },
                     expect: false
                 },
                 {
                     inputName: 'Object with string value',
-                    inputValue: {'a': '123312312', 'b': { 'c': '123' } },
+                    inputValue: { 'a': '123312312', 'b': { 'c': '123' } },
                     expect: true
                 }
             ]
@@ -256,17 +256,17 @@ const testItems: ITestSuite = {
             'items': [
                 {
                     inputName: 'Object with all correct',
-                    inputValue: {'a': 123, 'b': { 'c': 123 } },
+                    inputValue: { 'a': 123, 'b': { 'c': 123 } },
                     expect: true
                 },
                 {
                     inputName: 'Object with string incorrect-value',
-                    inputValue: {'a': 123, 'b': { 'c': '123d' } },
+                    inputValue: { 'a': 123, 'b': { 'c': '123d' } },
                     expect: false
                 },
                 {
                     inputName: 'Object with string value',
-                    inputValue: {'a': '123312312', 'b': { 'c': '123' } },
+                    inputValue: { 'a': '123312312', 'b': { 'c': '123' } },
                     expect: true
                 }
             ]

package/src/test/07-modifiers.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
+ * Copyright 2022 Angus Fenying <fenying@litert.org>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ const testItems: ITestSuite = {
 
         {
             'name': '$.string',
-            'rule': ['$.string', 'uint32', {'a': 'uint32'}],
+            'rule': ['$.string', 'uint32', { 'a': 'uint32' }],
             'items': [
                 {
                     inputName: JSON.stringify('123'),
@@ -31,13 +31,13 @@ const testItems: ITestSuite = {
                     expect: true
                 },
                 {
-                    inputName: JSON.stringify({'a': 123}),
-                    inputValue: {'a': 123},
+                    inputName: JSON.stringify({ 'a': 123 }),
+                    inputValue: { 'a': 123 },
                     expect: true
                 },
                 {
-                    inputName: JSON.stringify({'a': 123}),
-                    inputValue: {'a': 123},
+                    inputName: JSON.stringify({ 'a': 123 }),
+                    inputValue: { 'a': 123 },
                     expect: true
                 },
                 ...defaultItemss({
@@ -66,8 +66,8 @@ const testItems: ITestSuite = {
             }],
             'items': [
                 {
-                    inputName: JSON.stringify([{'a': 'x'}, {'a': 'c', 'b': 'x'}]),
-                    inputValue: [{'a': 'x'}, {'a': 'c', 'b': 'x'}],
+                    inputName: JSON.stringify([{ 'a': 'x' }, { 'a': 'c', 'b': 'x' }]),
+                    inputValue: [{ 'a': 'x' }, { 'a': 'c', 'b': 'x' }],
                     expect: true
                 }
             ]
@@ -83,8 +83,8 @@ const testItems: ITestSuite = {
             }],
             'items': [
                 {
-                    inputName: JSON.stringify({'a': {'b': 'c', 'd': 'ccc'}}),
-                    inputValue: {'a': {'b': 'c', 'd': 'ccc'}},
+                    inputName: JSON.stringify({ 'a': { 'b': 'c', 'd': 'ccc' } }),
+                    inputValue: { 'a': { 'b': 'c', 'd': 'ccc' } },
                     expect: true
                 }
             ]
@@ -139,6 +139,67 @@ const testItems: ITestSuite = {
                 ...defaultItemss({}, false)
             ]
         },
+        {
+            'name': 'Pre-defined IPv4 Address Checker',
+            'rule': '@ipv4_address',
+            'items': [
+                {
+                    inputName: 'String: 1.1.1.1',
+                    inputValue: '1.1.1.1',
+                    expect: true
+                },
+                {
+                    inputName: 'String: 255.255.255.255',
+                    inputValue: '255.255.255.255',
+                    expect: true
+                },
+                {
+                    inputName: 'String: 0.0.0.0',
+                    inputValue: '0.0.0.0',
+                    expect: true
+                },
+                {
+                    inputName: 'String: 2552.1.1.1',
+                    inputValue: '2552.1.1.1',
+                    expect: false
+                },
+                {
+                    inputName: 'String: 256.1.1.1',
+                    inputValue: '256.1.1.1',
+                    expect: false
+                },
+                {
+                    inputName: 'String: .1.1.1',
+                    inputValue: '.1.1.1',
+                    expect: false
+                },
+                {
+                    inputName: 'object {a: 213, b: 321}',
+                    inputValue: {
+                        'a': 213,
+                        'b': 321
+                    },
+                    expect: false
+                },
+                {
+                    inputName: 'object {a: 213, b: "321"}',
+                    inputValue: {
+                        'a': 213,
+                        'b': '321'
+                    },
+                    expect: false
+                },
+                {
+                    inputName: 'object {a: 213, b: "321"}',
+                    inputValue: {
+                        'a': 213,
+                        'b': 777
+                    },
+                    expect: false
+                },
+                ...defaultItemss({}, false)
+            ]
+        },
         {
             'name': '$.type with unsupported characters in type name',
             'rule': {

package/src/test/08-map-and-dict.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
+ * Copyright 2022 Angus Fenying <fenying@litert.org>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,22 +33,22 @@ const testItems: ITestSuite = {
             'items': [
                 {
                     inputName: 'all string object',
-                    inputValue: {'a': '123312312', 'b': 'ccc' },
+                    inputValue: { 'a': '123312312', 'b': 'ccc' },
                     expect: true
                 },
                 {
                     inputName: 'all uint32 object',
-                    inputValue: {'a': 123312312, 'b': 0xCCC },
+                    inputValue: { 'a': 123312312, 'b': 0xCCC },
                     expect: true
                 },
                 {
                     inputName: 'all uint32 & string object',
-                    inputValue: {'a': 123312312, 'b': 0xCCC },
+                    inputValue: { 'a': 123312312, 'b': 0xCCC },
                     expect: true
                 },
                 {
                     inputName: 'all uint32 & boolean object',
-                    inputValue: {'a': 123312312, 'b': false },
+                    inputValue: { 'a': 123312312, 'b': false },
                     expect: false
                 },
                 ...defaultItemss({
@@ -67,15 +67,15 @@ const testItems: ITestSuite = {
             },
             'items': [
                 assertItem(
-                    {'a': '123312312', 'b': 123.3, c: 1232 },
+                    { 'a': '123312312', 'b': 123.3, c: 1232 },
                     true
                 ),
                 assertItem(
-                    {'a': '123312312', 'b': 'ccc' },
+                    { 'a': '123312312', 'b': 'ccc' },
                     false
                 ),
                 assertItem(
-                    {'a': 123312312, 'b': 123.3 },
+                    { 'a': 123312312, 'b': 123.3 },
                     false
                 ),
             ]
@@ -91,56 +91,56 @@ const testItems: ITestSuite = {
             },
             'items': [
                 assertItem(
-                    {'a': '123312312', 'b': 'ccc' },
+                    { 'a': '123312312', 'b': 'ccc' },
                     false
                 ),
                 assertItem(
-                    {'a': 123312312, 'b': 123.3 },
+                    { 'a': 123312312, 'b': 123.3 },
                     false
                 ),
                 assertItem(
-                    {'a': '123312312', 'b': {d: 123.3, c: 1232} },
+                    { 'a': '123312312', 'b': { d: 123.3, c: 1232 } },
                     true
                 ),
                 assertItem(
-                    {'a': '123312312', 'b': { d: 123.3, c: '1232' } },
+                    { 'a': '123312312', 'b': { d: 123.3, c: '1232' } },
                     false
                 ),
             ]
         },
         addRule(['$.dict', ['a', 'b'], 'string'], [
             assertItem(
-                {'a': '123312312', 'b': 'ccc' },
+                { 'a': '123312312', 'b': 'ccc' },
                 true
             ),
             assertItem(
-                {'a': '123312312', 'b': 'ccc', 'c': 123 },
+                { 'a': '123312312', 'b': 'ccc', 'c': 123 },
                 true
             ),
             assertItem(
-                {'a': '123312312' },
+                { 'a': '123312312' },
                 false
             ),
             assertItem(
-                {'a': '123312312', 'c': 'ddd' },
+                { 'a': '123312312', 'c': 'ddd' },
                 false
             ),
             assertItem(
-                {'a': '123312312', 'b': 123.3 },
+                { 'a': '123312312', 'b': 123.3 },
                 false
             )
         ]),
         addRule(['$.strict', '$.dict', ['a', 'b'], 'string'], [
             assertItem(
-                {'a': '123312312', 'b': 'ccc' },
+                { 'a': '123312312', 'b': 'ccc' },
                 true
             ),
             assertItem(
-                {'a': '123312312', 'b': 'ccc', 'c': 123 },
+                { 'a': '123312312', 'b': 'ccc', 'c': 123 },
                 false
             ),
             assertItem(
-                {'a': '123312312' },
+                { 'a': '123312312' },
                 false
             ),
         ])