@litert/typeguard 1.3.0 → 1.4.0

package/src/test/07-modifiers.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2022 Angus Fenying <fenying@litert.org>
+ * Copyright 2023 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.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { createTestDefinition, defaultItemss, ITestSuite } from './abstracts';
+import { createTestDefinition, defaultItems, ITestSuite } from './abstracts';
 
 const testItems: ITestSuite = {
 
@@ -26,21 +26,21 @@ const testItems: ITestSuite = {
             'rule': ['$.string', 'uint32', { 'a': 'uint32' }],
             'items': [
                 {
-                    inputName: JSON.stringify('123'),
-                    inputValue: '123',
+                    title: JSON.stringify('123'),
+                    value: '123',
                     expect: true
                 },
                 {
-                    inputName: JSON.stringify({ 'a': 123 }),
-                    inputValue: { 'a': 123 },
+                    title: JSON.stringify({ 'a': 123 }),
+                    value: { 'a': 123 },
                     expect: true
                 },
                 {
-                    inputName: JSON.stringify({ 'a': 123 }),
-                    inputValue: { 'a': 123 },
+                    title: JSON.stringify({ 'a': 123 }),
+                    value: { 'a': 123 },
                     expect: true
                 },
-                ...defaultItemss({
+                ...defaultItems({
                     'number 1': true,
                     'number 0': true
                 })
@@ -51,8 +51,8 @@ const testItems: ITestSuite = {
             'rule': ['$.and', ['$.string', 'uint32'], 'uint32'],
             'items': [
                 {
-                    inputName: JSON.stringify('123'),
-                    inputValue: '123',
+                    title: JSON.stringify('123'),
+                    value: '123',
                     expect: false
                 }
             ]
@@ -66,8 +66,8 @@ const testItems: ITestSuite = {
             }],
             'items': [
                 {
-                    inputName: JSON.stringify([{ 'a': 'x' }, { 'a': 'c', 'b': 'x' }]),
-                    inputValue: [{ 'a': 'x' }, { 'a': 'c', 'b': 'x' }],
+                    title: JSON.stringify([{ 'a': 'x' }, { 'a': 'c', 'b': 'x' }]),
+                    value: [{ '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' } },
+                    title: JSON.stringify({ 'a': { 'b': 'c', 'd': 'ccc' } }),
+                    value: { 'a': { 'b': 'c', 'd': 'ccc' } },
                     expect: true
                 }
             ]
@@ -94,11 +94,11 @@ const testItems: ITestSuite = {
             'rule': ['$.not', 'string', 0],
             'items': [
                 {
-                    inputName: 'string \'abc\'',
-                    inputValue: 'abc',
+                    title: 'string \'abc\'',
+                    value: 'abc',
                     expect: false
                 },
-                ...defaultItemss({
+                ...defaultItems({
                     'string \'hello\'': false,
                     'empty string': false,
                     'number 0': false
@@ -106,98 +106,230 @@ const testItems: ITestSuite = {
             ]
         },
         {
-            'name': '$.type ',
+            'name': '$.type with complex name',
             'rule': {
                 'a': ['$.type', 'test:a.b-c', 'int'],
                 'b': '@test:a.b-c',
             },
             'items': [
                 {
-                    inputName: 'object {a: 213, b: 321}',
-                    inputValue: {
+                    title: 'object {a: 213, b: 321}',
+                    value: {
                         'a': 213,
                         'b': 321
                     },
                     expect: true
                 },
                 {
-                    inputName: 'object {a: 213, b: "321"}',
-                    inputValue: {
+                    title: 'object {a: 213, b: "321"}',
+                    value: {
                         'a': 213,
                         'b': '321'
                     },
                     expect: false
                 },
                 {
-                    inputName: 'object {a: 213, b: "321"}',
-                    inputValue: {
+                    title: 'object {a: 213, b: "321"}',
+                    value: {
                         'a': 213,
                         'b': 777
                     },
                     expect: true
                 },
-                ...defaultItemss({}, false)
+                ...defaultItems({}, false)
             ]
         },
         {
-            'name': 'Pre-defined IPv4 Address Checker',
+            'name': '$.type pre-defined IPv4 Address Checker',
             'rule': '@ipv4_address',
             'items': [
                 {
-                    inputName: 'String: 1.1.1.1',
-                    inputValue: '1.1.1.1',
+                    title: 'String: 1.1.1.1',
+                    value: '1.1.1.1',
                     expect: true
                 },
                 {
-                    inputName: 'String: 255.255.255.255',
-                    inputValue: '255.255.255.255',
+                    title: 'String: 255.255.255.255',
+                    value: '255.255.255.255',
                     expect: true
                 },
                 {
-                    inputName: 'String: 0.0.0.0',
-                    inputValue: '0.0.0.0',
+                    title: 'String: 0.0.0.0',
+                    value: '0.0.0.0',
                     expect: true
                 },
                 {
-                    inputName: 'String: 2552.1.1.1',
-                    inputValue: '2552.1.1.1',
+                    title: 'String: 2552.1.1.1',
+                    value: '2552.1.1.1',
                     expect: false
                 },
                 {
-                    inputName: 'String: 256.1.1.1',
-                    inputValue: '256.1.1.1',
+                    title: 'String: 256.1.1.1',
+                    value: '256.1.1.1',
                     expect: false
                 },
                 {
-                    inputName: 'String: .1.1.1',
-                    inputValue: '.1.1.1',
+                    title: 'String: .1.1.1',
+                    value: '.1.1.1',
                     expect: false
                 },
                 {
-                    inputName: 'object {a: 213, b: 321}',
-                    inputValue: {
+                    title: 'object {a: 213, b: 321}',
+                    value: {
                         'a': 213,
                         'b': 321
                     },
                     expect: false
                 },
                 {
-                    inputName: 'object {a: 213, b: "321"}',
-                    inputValue: {
+                    title: 'object {a: 213, b: "321"}',
+                    value: {
                         'a': 213,
                         'b': '321'
                     },
                     expect: false
                 },
                 {
-                    inputName: 'object {a: 213, b: "321"}',
-                    inputValue: {
+                    title: 'object {a: 213, b: "321"}',
+                    value: {
                         'a': 213,
                         'b': 777
                     },
                     expect: false
                 },
-                ...defaultItemss({}, false)
+                ...defaultItems({}, false)
+            ]
+        },
+        {
+            'name': '$.type pre-defined type "trim_string" without args',
+            'rule': '@trim_string',
+            'items': [
+                {
+                    title: 'String " aaa"',
+                    value: ' aaa',
+                    expect: true
+                },
+                ...defaultItems({
+                    'string \'hello\'': true,
+                    'empty string': true,
+                }, false)
+            ]
+        },
+        {
+            'name': '$.type pre-defined type "trim_string" with full args (2, 5)',
+            'rule': '@trim_string(2, 5)',
+            'items': [
+                {
+                    title: 'String " aaa"',
+                    value: ' aaa',
+                    expect: true
+                },
+                {
+                    title: 'String " ffff"',
+                    value: ' ffff',
+                    expect: true
+                },
+                {
+                    title: 'String " aa "',
+                    value: ' aa ',
+                    expect: true
+                },
+                {
+                    title: 'String " a "',
+                    value: ' a ',
+                    expect: false
+                },
+                {
+                    title: 'String " aaaaaaa "',
+                    value: ' aaaaaaa ',
+                    expect: false
+                },
+                ...defaultItems({
+                    'string \'hello\'': true,
+                    'empty string': false,
+                }, false)
+            ]
+        },
+        {
+            'name': '$.type pre-defined type "enum" with args (1, 2, 3, "dddd", true, false, null, -2, 0x1111, "ss\\"", \'ff\', \'ff\\\'\')',
+            'rule': '@enum(1, 2, 3,     "dddd", true, false, null, -2, 0x1111, "ss\\"", \'ff\', \'ff\\\'\')',
+            'items': [
+                {
+                    title: 'Integer 2',
+                    value: 2,
+                    expect: true
+                },
+                {
+                    title: 'Integer 0x1111',
+                    value: 0x1111,
+                    expect: true
+                },
+                {
+                    title: 'Integer -2',
+                    value: -2,
+                    expect: true
+                },
+                {
+                    title: 'String "dddd"',
+                    value: 'dddd',
+                    expect: true
+                },
+                {
+                    title: 'String "ss\\""',
+                    value: 'ss"',
+                    expect: true
+                },
+                {
+                    title: 'String "ff"',
+                    value: 'ff',
+                    expect: true
+                },
+                {
+                    title: 'String "ff\'"',
+                    value: 'ff\'',
+                    expect: true
+                },
+                ...defaultItems({
+                    'number 1': true,
+                    'true': true,
+                    'false': true,
+                    'null': true,
+                }, false)
+            ]
+        },
+        {
+            'name': '$.type pre-defined type "trim_string" with args (2)',
+            'rule': '@trim_string(2)',
+            'items': [
+                {
+                    title: 'String " aaa"',
+                    value: ' aaa',
+                    expect: true
+                },
+                {
+                    title: 'String " ffff"',
+                    value: ' ffff',
+                    expect: true
+                },
+                {
+                    title: 'String " aa "',
+                    value: ' aa ',
+                    expect: true
+                },
+                {
+                    title: 'String " a "',
+                    value: ' a ',
+                    expect: false
+                },
+                {
+                    title: 'String " aaaaaaa "',
+                    value: ' aaaaaaa ',
+                    expect: true
+                },
+                ...defaultItems({
+                    'string \'hello\'': true,
+                    'empty string': false,
+                }, false)
             ]
         },
         {
@@ -208,8 +340,125 @@ const testItems: ITestSuite = {
             },
             'items': [
                 {
-                    inputName: 'invalid format',
-                    inputValue: '',
+                    title: 'invalid format',
+                    value: '',
+                    expect: 'throw'
+                }
+            ]
+        },
+        {
+            'name': '$.enum',
+            'rule': ['$.enum', '==123', '=123', 'int', 3333333, null, true],
+            'items': [
+                {
+                    title: 'string "==123"',
+                    value: '==123',
+                    expect: true
+                },
+                {
+                    title: 'string "123"',
+                    value: '123',
+                    expect: false
+                },
+                {
+                    title: 'string "=123"',
+                    value: '=123',
+                    expect: true
+                },
+                {
+                    title: 'string "int"',
+                    value: 'int',
+                    expect: true
+                },
+                {
+                    title: 'string "uint"',
+                    value: 'uint',
+                    expect: false
+                },
+                {
+                    title: 'integer 3333333',
+                    value: 3333333,
+                    expect: true
+                },
+                ...defaultItems({
+                    'null': true,
+                    'true': true
+                }, false)
+            ]
+        },
+        {
+            'name': '$.enum with empty candidate list',
+            'rule': ['$.enum'],
+            'items': [
+                {
+                    title: 'invalid empty candidate list',
+                    value: '',
+                    expect: 'throw'
+                }
+            ]
+        },
+        {
+            'name': '$.enum with object candidate',
+            'rule': ['$.enum', {}],
+            'items': [
+                {
+                    title: 'object as candidate',
+                    value: '',
+                    expect: 'throw'
+                }
+            ]
+        },
+        {
+            'name': '$.enum with array candidate',
+            'rule': ['$.enum', []],
+            'items': [
+                {
+                    title: 'array as candidate',
+                    value: '',
+                    expect: 'throw'
+                }
+            ]
+        },
+        {
+            'name': '$.enum with undefined candidate',
+            'rule': ['$.enum', undefined],
+            'items': [
+                {
+                    title: 'undefined as candidate',
+                    value: '',
+                    expect: 'throw'
+                }
+            ]
+        },
+        {
+            'name': '$.enum with function candidate',
+            'rule': ['$.enum', () => true],
+            'items': [
+                {
+                    title: 'function as candidate',
+                    value: '',
+                    expect: 'throw'
+                }
+            ]
+        },
+        {
+            'name': '$.enum with bigint candidate',
+            'rule': ['$.enum', BigInt(123)],
+            'items': [
+                {
+                    title: 'bigint as candidate',
+                    value: '',
+                    expect: 'throw'
+                }
+            ]
+        },
+        {
+            'name': '$.enum with symbol candidate',
+            'rule': ['$.enum', Symbol('123')],
+            'items': [
+                {
+                    title: 'symbol as candidate',
+                    value: '',
                     expect: 'throw'
                 }
             ]

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

@@ -1,5 +1,5 @@
 /**
- * Copyright 2022 Angus Fenying <fenying@litert.org>
+ * Copyright 2023 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.
@@ -16,7 +16,7 @@
 
 import {
     createTestDefinition,
-    defaultItemss,
+    defaultItems,
     ITestSuite,
     assertItem,
     addRule
@@ -32,26 +32,26 @@ const testItems: ITestSuite = {
             'rule': ['$.map', 'string', 'uint32'],
             'items': [
                 {
-                    inputName: 'all string object',
-                    inputValue: { 'a': '123312312', 'b': 'ccc' },
+                    title: 'all string object',
+                    value: { 'a': '123312312', 'b': 'ccc' },
                     expect: true
                 },
                 {
-                    inputName: 'all uint32 object',
-                    inputValue: { 'a': 123312312, 'b': 0xCCC },
+                    title: 'all uint32 object',
+                    value: { 'a': 123312312, 'b': 0xCCC },
                     expect: true
                 },
                 {
-                    inputName: 'all uint32 & string object',
-                    inputValue: { 'a': 123312312, 'b': 0xCCC },
+                    title: 'all uint32 & string object',
+                    value: { 'a': 123312312, 'b': 0xCCC },
                     expect: true
                 },
                 {
-                    inputName: 'all uint32 & boolean object',
-                    inputValue: { 'a': 123312312, 'b': false },
+                    title: 'all uint32 & boolean object',
+                    value: { 'a': 123312312, 'b': false },
                     expect: false
                 },
-                ...defaultItemss({
+                ...defaultItems({
                     'object': true
                 })
             ]

package/src/test/09-exceptions.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2022 Angus Fenying <fenying@litert.org>
+ * Copyright 2023 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.
@@ -29,13 +29,13 @@ const testItems: ITestSuite = {
             'rule': { 'test?': 'any' },
             'items': [
                 {
-                    inputName: 'When test === \'ffff\'',
-                    inputValue: { 'test': 'ffff' },
+                    title: 'When test === \'ffff\'',
+                    value: { 'test': 'ffff' },
                     expect: true
                 },
                 {
-                    inputName: 'When test is omitted',
-                    inputValue: {},
+                    title: 'When test is omitted',
+                    value: {},
                     expect: true
                 }
             ]
@@ -45,18 +45,18 @@ const testItems: ITestSuite = {
             'rule': { 'test': 'int8' },
             'items': [
                 {
-                    inputName: 'When test === 123',
-                    inputValue: { 'test': 123 },
+                    title: 'When test === 123',
+                    value: { 'test': 123 },
                     expect: true
                 },
                 {
-                    inputName: 'When test === 1234',
-                    inputValue: { 'test': 1234 },
+                    title: 'When test === 1234',
+                    value: { 'test': 1234 },
                     expect: false
                 },
                 {
-                    inputName: 'When test is omitted',
-                    inputValue: {},
+                    title: 'When test is omitted',
+                    value: {},
                     expect: false
                 }
             ]