TypeScript implementation (@nlighten/json-transform) [WIP]

.github/workflows/javascript-json-transform-test.yml

@@ -0,0 +1,33 @@
+name: JavaScript json-transform Test
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - javascript/json-transform/**
+
+# cancel previous tests if new commit is pushed to PR branch
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: npm
+          cache-dependency-path: ./javascript/json-transform/package-lock.json
+
+      - name: Install dependencies
+        working-directory: ./javascript/json-transform
+        run: npm ci
+
+      - name: Run tests
+        working-directory: ./javascript/json-transform
+        run: npm test

README.md

@@ -4,7 +4,8 @@
 
 ## Packages
 
-|Language|Name|Description|License|Status|
-|---|---|---|---|---|
-|Java|[co.nlighten.json-transform](./java/json-transform)|Java library for transforming JSON objects|Apache License 2.0|![Maven Central Version](https://img.shields.io/maven-central/v/co.nlighten/json-transform)|
-|JavaScript|[@nlighten/json-transform-core](./javascript/json-transform-core)|Core types and utilities for handling JSON transformers|MIT|![npm](https://img.shields.io/npm/v/@nlighten/json-transform-core)|
+| Language   |Name| Description                                             |License|Status|
+|------------|---|---------------------------------------------------------|---|---|
+| Java       |[co.nlighten.json-transform](./java/json-transform)| Java library for transforming JSON objects              |Apache License 2.0|![Maven Central Version](https://img.shields.io/maven-central/v/co.nlighten/json-transform)|
+| JavaScript |[@nlighten/json-transform](./javascript/json-transform)| JSON transformers JavaScript implementation|MIT|![npm](https://img.shields.io/npm/v/@nlighten/json-transform)|
+| JavaScript |[@nlighten/json-transform-core](./javascript/json-transform-core)| Core types and utilities for handling JSON transformers |MIT|![npm](https://img.shields.io/npm/v/@nlighten/json-transform-core)|

docs/docs/functions/numberformat.md

@@ -14,16 +14,16 @@ Formats a number
 ### Returns
 `string`
 ### Arguments
-| Argument        | Type      | Values                                                             | Required / Default Value | Description                                                                            |
-|-----------------|-----------|--------------------------------------------------------------------|-------------------------------|----------------------------------------------------------------------------------------|
-| `type`          | `Enum`    | `NUMBER`/`DECIMAL`/`CURRENCY`/`PERCENT`/`INTEGER`/`COMPACT`/`BASE` | Yes                           | Type of output format                                                                  |
-| `locale`        | `Enum`    | A language tag (e.g. `en-US`)                                      | `en-US`                       | Locale to use (language and country specific formatting; set by Java)                  |
-| `compact_style` | `Enum`    | `SHORT`/`LONG`                                                     | `SHORT`                       | Effective when `type == COMPACT`, choose which type of compact                         |
-| `pattern`       | `String`  | `DecimalFormat` pattern                                            | `#0.00`                       | See [tutorial](https://docs.oracle.com/javase/tutorial/i18n/format/decimalFormat.html) |
-| `grouping`      | `String`  | Single character string                                            | `,`                           | A custom character to be used for grouping                                             |
-| `decimal`       | `String`  | Single character string                                            | `.`                           | A custom character to be used for decimal point                                        |
-| `radix`         | `Integer` |                                                                    | `10`                          | Radix to be used for formatting input                                                  |
-| `currency`      | `String`  | [ISO-4217 currency code](https://www.iso.org/iso-4217-currency-codes.html)                                         | Yes (when `type == CURRENCY`) | Currency to use in format                                                  |
+| Argument        | Type      | Values                                                                     | Required / Default Value | Description                                                                            |
+|-----------------|-----------|----------------------------------------------------------------------------|-------------------------------|----------------------------------------------------------------------------------------|
+| `type`          | `Enum`    | `NUMBER`/`DECIMAL`/`CURRENCY`/`PERCENT`/`INTEGER`/`COMPACT`/`BASE`         | Yes                           | Type of output format                                                                  |
+| `locale`        | `Enum`    | A language tag (e.g. `en-US`)                                              | `en-US`                       | Locale to use (language and country specific formatting; set by Java)                  |
+| `compact_style` | `Enum`    | `SHORT`/`LONG`                                                             | `SHORT`                       | Effective when `type == COMPACT`, choose which type of compact                         |
+| `pattern`       | `String`  | `DecimalFormat` pattern                                                    | `#0.00`                       | See [tutorial](https://docs.oracle.com/javase/tutorial/i18n/format/decimalFormat.html) |
+| `grouping`      | `String`  | Single character string                                                    | `,`                           | A custom character to be used for grouping                                             |
+| `decimal`       | `String`  | Single character string                                                    | `.`                           | A custom character to be used for decimal point                                        |
+| `radix`         | `Integer` |                                                                            | `10`                          | Radix to be used for formatting input                                                  |
+| `currency`      | `String`  | [ISO-4217 currency code](https://www.iso.org/iso-4217-currency-codes.html) | Yes (when `type == CURRENCY`) | Currency to use in format                                                              |
 
 
 ## Examples

docs/docs/functions/yaml.md

@@ -2,6 +2,10 @@
 
 Converts an object to YAML format
 
+:::info
+Structure of output may very depending on platform.
+:::
+
 ### Usage
 ```transformers
 { 

java.test-server.Dockerfile

@@ -0,0 +1,15 @@
+FROM gradle:8.4-jdk17 as build
+ARG PORT=10000
+WORKDIR /
+COPY java/json-transform java/json-transform
+COPY java/playground/src java/playground/src
+COPY java/playground/build.gradle java/playground
+COPY settings.gradle .
+
+WORKDIR /java/playground
+RUN gradle task bootJar
+
+FROM eclipse-temurin:17-jdk-jammy as app
+COPY --from=build /java/playground/build/libs/playground-1.0.0.jar .
+EXPOSE $PORT
+CMD ["java", "-jar", "./playground-1.0.0.jar"]

java/json-transform/build.gradle

@@ -9,7 +9,7 @@ plugins {
 }
 
 group 'co.nlighten'
-version = '0.5.0'
+version = '0.5.1'
 
 ext {
     gsonVersion = "2.10.1"

java/json-transform/src/main/java/co/nlighten/jsontransform/functions/TransformerFunctionAnd.java

@@ -1,22 +1,13 @@
 package co.nlighten.jsontransform.functions;
 
 import co.nlighten.jsontransform.adapters.JsonAdapter;
-import co.nlighten.jsontransform.functions.common.ArgType;
 import co.nlighten.jsontransform.functions.common.FunctionContext;
 import co.nlighten.jsontransform.functions.common.TransformerFunction;
-import co.nlighten.jsontransform.functions.annotations.Aliases;
-import co.nlighten.jsontransform.functions.annotations.Documentation;
-import co.nlighten.jsontransform.functions.annotations.InputType;
-import co.nlighten.jsontransform.functions.annotations.OutputType;
 
 /*
  * For tests
  * @see TransformerFunctionAndTest
  */
-@Aliases("and")
-@Documentation("Evaluates to `true` if all values provided will evaluate to `true` (using the [Truthy logic]).")
-@InputType(value = ArgType.Array, description = "Values to check")
-@OutputType(ArgType.Boolean)
 public class TransformerFunctionAnd<JE, JA extends Iterable<JE>, JO extends JE> extends TransformerFunction<JE, JA, JO> {
     public TransformerFunctionAnd(JsonAdapter<JE, JA, JO> adapter) {
         super(adapter);

java/json-transform/src/main/java/co/nlighten/jsontransform/functions/TransformerFunctionAt.java

@@ -4,18 +4,13 @@
 import co.nlighten.jsontransform.functions.common.ArgType;
 import co.nlighten.jsontransform.functions.common.FunctionContext;
 import co.nlighten.jsontransform.functions.common.TransformerFunction;
-import co.nlighten.jsontransform.functions.annotations.*;
+import co.nlighten.jsontransform.functions.annotations.ArgumentType;
 
 /*
  * For tests
  * @see TransformerFunctionAtTest
  */
-@Aliases("at")
-@Documentation("Retrieves an element from a specific position inside an input array")
-@InputType(value = ArgType.Array, description = "Array to fetch from")
-@ArgumentType(value = "index", type = ArgType.Integer, position = 0, required = true, defaultIsNull = true,
-              description = "Index of element to fetch (negative values will be fetch from the end)")
-@OutputType(value = ArgType.Any, description = "Element at index, or null if undefined")
+@ArgumentType(value = "index", type = ArgType.Integer, position = 0, defaultIsNull = true)
 public class TransformerFunctionAt<JE, JA extends Iterable<JE>, JO extends JE> extends TransformerFunction<JE, JA, JO> {
     public TransformerFunctionAt(JsonAdapter<JE, JA, JO> adapter) {
         super(adapter);

java/json-transform/src/main/java/co/nlighten/jsontransform/functions/TransformerFunctionAvg.java

@@ -5,23 +5,14 @@
 import co.nlighten.jsontransform.functions.common.FunctionContext;
 import co.nlighten.jsontransform.functions.common.FunctionHelpers;
 import co.nlighten.jsontransform.functions.common.TransformerFunction;
-import co.nlighten.jsontransform.functions.annotations.*;
+import co.nlighten.jsontransform.functions.annotations.ArgumentType;
 
 import java.math.BigDecimal;
 import java.util.Objects;
 import java.util.concurrent.atomic.AtomicInteger;
 
-@Aliases("avg")
-@Documentation("Returns the average of all values in the array")
-@InputType(ArgType.Array)
-
-@ArgumentType(value = "default", type = ArgType.BigDecimal, position = 0, defaultBigDecimal = 0,
-              description = "The default value to use for empty values")
-@ArgumentType(value = "by", type = ArgType.Transformer, position = 1,
-              defaultString = "##current",
-              description = "A transformer to extract a property to sum by (using ##current to refer to the current item)")
-
-@OutputType(ArgType.BigDecimal)
+@ArgumentType(value = "default", type = ArgType.BigDecimal, position = 0, defaultBigDecimal = 0)
+@ArgumentType(value = "by", type = ArgType.Transformer, position = 1, defaultString = "##current")
 public class TransformerFunctionAvg<JE, JA extends Iterable<JE>, JO extends JE> extends TransformerFunction<JE, JA, JO> {
 
     public TransformerFunctionAvg(JsonAdapter<JE, JA, JO> adapter) {

java/json-transform/src/main/java/co/nlighten/jsontransform/functions/TransformerFunctionBase64.java

@@ -4,29 +4,22 @@
 import co.nlighten.jsontransform.functions.common.ArgType;
 import co.nlighten.jsontransform.functions.common.FunctionContext;
 import co.nlighten.jsontransform.functions.common.TransformerFunction;
-import co.nlighten.jsontransform.functions.annotations.*;
+import co.nlighten.jsontransform.functions.annotations.ArgumentType;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.UnsupportedEncodingException;
+import java.nio.charset.StandardCharsets;
 import java.util.Base64;
 
 /*
  * For tests
  * @see TransformerFunctionBase64Test
  */
-@Aliases("base64")
-@Documentation("Encode to or decode from base64")
-@InputType(ArgType.String)
-@ArgumentType(value = "action", type = ArgType.Enum, position = 0, defaultEnum = "ENCODE",
-              description = "Whether to encode or decode input")
-@ArgumentType(value = "rfc", type = ArgType.Enum, position = 1, defaultEnum = "BASIC",
-              description = "Which alphabet to use (BASIC = \"The Base64 Alphabet\" from RFC-2045, URL = \"URL and Filename safe Base64 Alphabet\" from RFC-4648, MIME = Same as BASIC but in lines with no more than 76 characters each)")
-@ArgumentType(value = "without_padding", type = ArgType.Boolean, position = 2, defaultBoolean = false,
-              description = "Don't add padding at the end of the output (The character `=`)")
-@ArgumentType(value = "charset", type = ArgType.Enum, position = 3, defaultEnum = "UTF-8",
-              description = "Character set to use before encoding or when decoding to string")
-@OutputType(ArgType.String)
+@ArgumentType(value = "action", type = ArgType.Enum, position = 0, defaultEnum = "ENCODE")
+@ArgumentType(value = "rfc", type = ArgType.Enum, position = 1, defaultEnum = "BASIC")
+@ArgumentType(value = "without_padding", type = ArgType.Boolean, position = 2, defaultBoolean = false)
+@ArgumentType(value = "charset", type = ArgType.Enum, position = 3, defaultEnum = "UTF-8")
 public class TransformerFunctionBase64<JE, JA extends Iterable<JE>, JO extends JE> extends TransformerFunction<JE, JA, JO> {
 
     static final Logger log = LoggerFactory.getLogger(TransformerFunctionBase64.class);
@@ -55,7 +48,7 @@ public Object apply(FunctionContext<JE, JA, JO> context) {
                 if (withoutPadding) {
                     encoder = encoder.withoutPadding();
                 }
-                result = encoder.encodeToString(str.getBytes(charset));
+                result = new String(encoder.encode(str.getBytes(charset)), StandardCharsets.US_ASCII);
 
             } else {
                 var decoder = rfc.charAt(0) == 'M' ? Base64.getMimeDecoder() :

java/json-transform/src/main/java/co/nlighten/jsontransform/functions/TransformerFunctionBoolean.java

@@ -3,26 +3,14 @@
 import co.nlighten.jsontransform.adapters.JsonAdapter;
 import co.nlighten.jsontransform.functions.common.ArgType;
 import co.nlighten.jsontransform.functions.common.FunctionContext;
-import co.nlighten.jsontransform.functions.common.FunctionHelpers;
 import co.nlighten.jsontransform.functions.common.TransformerFunction;
-import co.nlighten.jsontransform.functions.annotations.*;
+import co.nlighten.jsontransform.functions.annotations.ArgumentType;
 
 /*
  * For tests
  * @see TransformerFunctionBooleanTest
  */
-@Aliases("boolean")
-@Documentation(value = "Evaluates input to boolean using the [Truthy logic]",
-               notes = """
-Strings evaluation depends on `style` argument:
-- By default, value must be `"true"` for `true`.
-- Unless `style` is set to `JS`, then any non-empty value is `true`. Arrays and objects of size 0 returns `false`.
-""")
-@InputType(ArgType.Any)
-@ArgumentType(value = "style", type = ArgType.Enum, position = 0, defaultEnum = "JAVA",
-              enumValues = { "JAVA", "JS" },
-              description = "Style of considering truthy values (JS only relates to string handling; not objects and arrays)")
-@OutputType(ArgType.Boolean)
+@ArgumentType(value = "style", type = ArgType.Enum, position = 0, defaultEnum = "JAVA")
 public class TransformerFunctionBoolean<JE, JA extends Iterable<JE>, JO extends JE> extends TransformerFunction<JE, JA, JO> {
     public TransformerFunctionBoolean(JsonAdapter<JE, JA, JO> adapter) {
         super(adapter);

java/json-transform/src/main/java/co/nlighten/jsontransform/functions/TransformerFunctionCoalesce.java

@@ -1,22 +1,13 @@
 package co.nlighten.jsontransform.functions;
 
 import co.nlighten.jsontransform.adapters.JsonAdapter;
-import co.nlighten.jsontransform.functions.common.ArgType;
 import co.nlighten.jsontransform.functions.common.FunctionContext;
 import co.nlighten.jsontransform.functions.common.TransformerFunction;
-import co.nlighten.jsontransform.functions.annotations.Aliases;
-import co.nlighten.jsontransform.functions.annotations.Documentation;
-import co.nlighten.jsontransform.functions.annotations.InputType;
-import co.nlighten.jsontransform.functions.annotations.OutputType;
 
 /*
  * For tests
  * @see TransformerFunctionCoalesceTest
  */
-@Aliases({"coalesce", "first"})
-@Documentation("Returns the first non-null value")
-@InputType(ArgType.Array)
-@OutputType(value = ArgType.Any, description = "Same as first non-null value")
 public class TransformerFunctionCoalesce<JE, JA extends Iterable<JE>, JO extends JE> extends TransformerFunction<JE, JA, JO> {
 
     public TransformerFunctionCoalesce(JsonAdapter<JE, JA, JO> adapter) {

java/json-transform/src/main/java/co/nlighten/jsontransform/functions/TransformerFunctionConcat.java

@@ -1,25 +1,16 @@
 package co.nlighten.jsontransform.functions;
 
 import co.nlighten.jsontransform.adapters.JsonAdapter;
-import co.nlighten.jsontransform.functions.common.ArgType;
 import co.nlighten.jsontransform.functions.common.FunctionContext;
 import co.nlighten.jsontransform.functions.common.TransformerFunction;
 import co.nlighten.jsontransform.JsonElementStreamer;
-import co.nlighten.jsontransform.functions.annotations.Aliases;
-import co.nlighten.jsontransform.functions.annotations.Documentation;
-import co.nlighten.jsontransform.functions.annotations.InputType;
-import co.nlighten.jsontransform.functions.annotations.OutputType;
 
 import java.util.stream.Stream;
 
 /*
  * For tests
  * @see TransformerFunctionConcatTest
  */
-@Aliases("concat")
-@Documentation("Concatenates primary value array with elements or other arrays of elements")
-@InputType(ArgType.Array)
-@OutputType(ArgType.Array)
 public class TransformerFunctionConcat<JE, JA extends Iterable<JE>, JO extends JE> extends TransformerFunction<JE, JA, JO> {
     public TransformerFunctionConcat(JsonAdapter<JE, JA, JO> adapter) {
         super(adapter);

java/json-transform/src/main/java/co/nlighten/jsontransform/functions/TransformerFunctionContains.java

@@ -4,18 +4,13 @@
 import co.nlighten.jsontransform.functions.common.ArgType;
 import co.nlighten.jsontransform.functions.common.FunctionContext;
 import co.nlighten.jsontransform.functions.common.TransformerFunction;
-import co.nlighten.jsontransform.functions.annotations.*;
+import co.nlighten.jsontransform.functions.annotations.ArgumentType;
 
 /*
  * For tests
  * @see TransformerFunctionContainsTest
  */
-@Aliases("contains")
-@Documentation("Checks whether an array contains a certain value")
-@InputType(ArgType.Array)
-@ArgumentType(value = "that", type = ArgType.Any, position = 0, defaultIsNull = true,
-              description = "The value to look for")
-@OutputType(ArgType.Boolean)
+@ArgumentType(value = "that", type = ArgType.Any, position = 0, defaultIsNull = true)
 public class TransformerFunctionContains<JE, JA extends Iterable<JE>, JO extends JE> extends TransformerFunction<JE, JA, JO> {
     public TransformerFunctionContains(JsonAdapter<JE, JA, JO> adapter) {
         super(adapter);