feat: toString, toArray, & toNumber functions

Author: dreamorosi

packages/jmespath/src/Parser.ts

@@ -176,7 +176,7 @@ class Parser {
           lexPosition: 0,
           tokenValue: token.value,
           tokenType: token.type,
-          reason: 'Quoted identifier cannot be used as a function name',
+          reason: 'quoted identifiers cannot be used as a function name',
         });
       }
 
@@ -247,7 +247,6 @@ class Parser {
         lexPosition: token.start,
         tokenValue: token.value,
         tokenType: token.type,
-        reason: 'invalid token',
       });
     }
   }
@@ -354,7 +353,6 @@ class Parser {
         lexPosition: token.start,
         tokenValue: token.value,
         tokenType: token.type,
-        reason: 'invalid token',
       });
     }
   }
@@ -402,7 +400,6 @@ class Parser {
             lexPosition: token.start,
             tokenValue: token.value,
             tokenType: token.type,
-            reason: 'syntax error',
           });
         }
         this.#advance();
@@ -419,7 +416,6 @@ class Parser {
           lexPosition: token.start,
           tokenValue: token.value,
           tokenType: token.type,
-          reason: 'syntax error',
         });
       }
       currentToken = this.#currentToken();
@@ -531,7 +527,6 @@ class Parser {
         lexPosition: token.start,
         tokenValue: token.value,
         tokenType: token.type,
-        reason: 'syntax error',
       });
     }
 
@@ -568,17 +563,10 @@ class Parser {
       return this.#parseMultiSelectHash();
     } else {
       const token = this.#lookaheadToken(0);
-      const allowed = [
-        'quoted_identifier',
-        'unquoted_identifier',
-        'lbracket',
-        'lbrace',
-      ];
       throw new ParseError({
         lexPosition: token.start,
         tokenValue: token.value,
         tokenType: token.type,
-        reason: `Expecting one of: ${allowed.join(', ')}, got: ${token.type}`,
       });
     }
   }
@@ -605,7 +593,6 @@ class Parser {
           lexPosition: token.start,
           tokenValue: token.value,
           tokenType: token.type,
-          reason: `Expecting: ${tokenType}, got: ${token.type}`,
         });
       }
     }
@@ -631,7 +618,6 @@ class Parser {
           lexPosition: token.start,
           tokenValue: token.value,
           tokenType: token.type,
-          reason: `Expecting: ${tokenTypes}, got: ${token.type}`,
         });
       }
     }

packages/jmespath/src/errors.ts

@@ -94,8 +94,9 @@ class ParseError extends JMESPathError {
     this.reason = options.reason;
 
     // Set the message to include the lexer position and token info.
-    const issue =
-      this.tokenType === 'eof'
+    const issue = this.reason
+      ? this.reason
+      : this.tokenType === 'eof'
         ? 'found unexpected end of expression (EOF)'
         : `found unexpected token "${this.tokenValue}" (${this.tokenType})`;
     this.message = `${this.message}: parse error at column ${this.lexPosition}, ${issue}`;

packages/jmespath/src/functions/Functions.ts

@@ -244,6 +244,9 @@ class Functions {
    * @param args The items to convert to an array
    * @returns The items as an array
    */
+  @Functions.signature({
+    argumentsSpecs: [['any']],
+  })
   public funcToArray(
     arg: JSONArray | Array<JSONValue>
   ): Array<JSONValue> | JSONArray {
@@ -261,6 +264,9 @@ class Functions {
    * @param arg The value to convert to a number
    * @returns The value as a number or null if the value cannot be converted to a number
    */
+  @Functions.signature({
+    argumentsSpecs: [['any']],
+  })
   public funcToNumber(arg: JSONValue): number | null {
     if (typeof arg === 'number') {
       return arg;
@@ -282,6 +288,9 @@ class Functions {
    * @param arg The value to convert to a string
    * @returns The value as a string
    */
+  @Functions.signature({
+    argumentsSpecs: [['any']],
+  })
   public funcToString(arg: JSONValue): string {
     return typeof arg === 'string' ? arg : JSON.stringify(arg);
   }
@@ -292,18 +301,21 @@ class Functions {
    * @param arg The value to check the type of
    * @returns The type of the value
    */
-  public funcType(arg: Array<unknown>): string {
-    if (Array.isArray(arg[0])) {
+  @Functions.signature({
+    argumentsSpecs: [['any']],
+  })
+  public funcType(arg: JSONValue): string {
+    if (Array.isArray(arg)) {
       return 'array';
-    } else if (isRecord(arg[0])) {
+    } else if (isRecord(arg)) {
       return 'object';
-    } else if (typeof arg[0] === 'string') {
+    } else if (typeof arg === 'string') {
       return 'string';
-    } else if (typeof arg[0] === 'number') {
+    } else if (typeof arg === 'number') {
       return 'number';
-    } else if (typeof arg[0] === 'boolean') {
+    } else if (typeof arg === 'boolean') {
       return 'boolean';
-    } else if (Object.is(arg[0], null)) {
+    } else if (Object.is(arg, null)) {
       return 'null';
     } else {
       return 'unknown';

packages/jmespath/tests/unit/functions.test.ts

@@ -1301,7 +1301,7 @@ describe('Functions tests', () => {
     expect(() => search(expression, data)).toThrow(error);
   }); */
 
-  /* it.each([
+  it.each([
     {
       expression: `to_array('foo')`,
       expected: ['foo'],
@@ -1352,9 +1352,9 @@ describe('Functions tests', () => {
 
     // Assess
     expect(result).toStrictEqual(expected);
-  }); */
+  });
 
-  /* it.each([
+  it.each([
     {
       expression: `to_string('foo')`,
       expected: 'foo',
@@ -1397,8 +1397,9 @@ describe('Functions tests', () => {
 
     // Assess
     expect(result).toStrictEqual(expected);
-  }); */
-  /* it.each([
+  });
+
+  it.each([
     {
       expression: `to_number('1.0')`,
       expected: 1.0,
@@ -1461,22 +1462,24 @@ describe('Functions tests', () => {
 
     // Assess
     expect(result).toStrictEqual(expected);
-  }); */
-  /* it.each([
+  });
+
+  it.each([
     {
       expression: '"to_string"(`1.0`)',
-      error: 'Quoted identifier not allowed for function names.',
+      error:
+        'Invalid jmespath expression: parse error at column 0, quoted identifiers cannot be used as a function name in expression: "to_string"(`1.0`)',
     },
   ])('to_number() function errors', ({ expression, error }) => {
-    // TODO: see if we can assert the error type as well in to_number() errors tests
     // Prepare
     const data = {
       type: 'object',
     };
 
     // Act & Assess
     expect(() => search(expression, data)).toThrow(error);
-  }); */
+  });
+
   /* it.each([
     {
       expression: 'not_null(unknown_key, str)',