@litert/typeguard 1.0.1 → 1.3.0-dev.0

package/src/lib/BuiltInTypes.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 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.
@@ -14,72 +14,72 @@
  * limitations under the License.
  */
 
-export const STRING = "string";
+export const STRING = 'string';
 
-export const ASCII_STRING = "ascii_string";
+export const ASCII_STRING = 'ascii_string';
 
-export const HEX_STRING = "hex_string";
+export const HEX_STRING = 'hex_string';
 
-export const LATIN_STRING = "latin_string";
+export const LATIN_STRING = 'latin_string';
 
-export const NUMERIC = "numeric";
+export const NUMERIC = 'numeric';
 
-export const SAFE_INT = "safe_int";
+export const SAFE_INT = 'safe_int';
 
-export const INT = "int";
+export const INT = 'int';
 
-export const INT8 = "int8";
+export const INT8 = 'int8';
 
-export const INT16 = "int16";
+export const INT16 = 'int16';
 
-export const INT32 = "int32";
+export const INT32 = 'int32';
 
-export const INT64 = "int64";
+export const INT64 = 'int64';
 
-export const SAFE_UINT = "safe_uint";
+export const SAFE_UINT = 'safe_uint';
 
-export const UINT = "uint";
+export const UINT = 'uint';
 
-export const UINT8 = "uint8";
+export const UINT8 = 'uint8';
 
-export const UINT16 = "uint16";
+export const UINT16 = 'uint16';
 
-export const UINT32 = "uint32";
+export const UINT32 = 'uint32';
 
-export const UINT64 = "uint64";
+export const UINT64 = 'uint64';
 
-export const BOOLEAN = "boolean";
+export const BOOLEAN = 'boolean';
 
-export const ARRAY = "array";
+export const ARRAY = 'array';
 
-export const ANY = "any";
+export const ANY = 'any';
 
-export const STRUCT = "struct";
+export const STRUCT = 'struct';
 
-export const NULL = "null";
+export const NULL = 'null';
 
-export const UNDEFINED = "undefined";
+export const UNDEFINED = 'undefined';
 
-export const VOID = "void";
+export const VOID = 'void';
 
-export const FALSE = "false";
+export const FALSE = 'false';
 
-export const TRUE = "true";
+export const TRUE = 'true';
 
-export const FALSE_VALUE = "false_value";
+export const FALSE_VALUE = 'false_value';
 
-export const TRUE_VALUE = "true_value";
+export const TRUE_VALUE = 'true_value';
 
-export const OPTIONAL = "optional";
+export const OPTIONAL = 'optional';
 
-export const REQUIRED = "required";
+export const REQUIRED = 'required';
 
-export const DECIMAL = "decimal";
+export const DECIMAL = 'decimal';
 
-export const NUMBER = "number";
+export const NUMBER = 'number';
 
-export const FLOAT = "float";
+export const FLOAT = 'float';
 
-export const UDECIMAL = "udecimal";
+export const UDECIMAL = 'udecimal';
 
-export const UFLOAT = "ufloat";
+export const UFLOAT = 'ufloat';

package/src/lib/Common.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 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.
@@ -14,19 +14,26 @@
  * limitations under the License.
  */
 
-export type TypeChecker<T> = (v: unknown) => v is T;
+export type ITypeChecker<T> = (v: unknown, errorTraces?: string[]) => v is T;
+
+/**
+ * @deprecated Use `ITypeChecker` instead.
+ */
+export type TypeChecker<T> = ITypeChecker<T>;
 
 export interface ICompileOutputArgument {
 
     /**
      * The name of argument.
      */
-    "name": string;
+    'name': string;
 
     /**
      * The type of argument.
      */
-    "type": string;
+    'type': string;
+
+    'initial': string;
 }
 
 export interface ICompileResult {
@@ -34,22 +41,22 @@ export interface ICompileResult {
     /**
      * The arguments of checker.
      */
-    "arguments": ICompileOutputArgument[];
+    'arguments': ICompileOutputArgument[];
 
     /**
      * The variable name of pre-defined type checkers.
      */
-    "typeSlotName": string;
+    'typeSlotName': string;
 
     /**
      * The source code of checker.
      */
-    "source": string;
+    'source': string;
 
     /**
      * The predefined types used by this type.
      */
-    "referredTypes": string[];
+    'referredTypes': string[];
 }
 
 export interface ICompileOptions {
@@ -57,12 +64,19 @@ export interface ICompileOptions {
     /**
      * The rules to be compiled.
      */
-    "rule": any;
+    'rule': any;
 
     /**
      * Give this type a name, so it could be used as a pre-defined type.
      */
-    "name"?: string;
+    'name'?: string;
+
+    /**
+     * Enable adding failed asserts tracing info to the second argument.
+     *
+     * @default false
+     */
+    'traceErrors'?: boolean;
 }
 
 export interface ILanguageBuilder {
@@ -83,6 +97,25 @@ export interface ILanguageBuilder {
      */
     caseIf(cond: string[], expr: string): string;
 
+    orAddTrace(
+        expr: string,
+        vTrace: string,
+        vTraceStack: string,
+        path: string,
+    ): string;
+
+    addTrace(
+        vTrace: string,
+        vTraceStack: string,
+        path: string,
+    ): string;
+
+    stringTemplateVar(varExpr: string): string;
+
+    numberTemplateVar(varExpr: string): string;
+
+    escape(str: string): string;
+
     caseDefault(expr: string): string;
 
     array(v: any[]): string;
@@ -281,6 +314,7 @@ export interface ILanguageBuilder {
 
     forEach(
         arrayName: string,
+        elName: string,
         itemName: string,
         forBody: string
     ): string;
@@ -308,6 +342,11 @@ export interface ILanguageBuilder {
         index: string | number
     ): string;
 
+    add(
+        expr1: string | number,
+        expr2: string | number,
+    ): string;
+
     arraySlice(
         arrayName: string,
         start: string | number,