[Elm] Add support for petstore spec

.github/workflows/samples-elm.yaml

@@ -0,0 +1,32 @@
+name: Samples Elm
+
+on:
+  push:
+    paths:
+      - samples/client/petstore/elm/**
+  pull_request:
+    paths:
+      - samples/client/petstore/elm/**
+jobs:
+  build:
+    name: Build Elm clients
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        sample:
+          # clients
+          - samples/client/petstore/elm
+    steps:
+      - uses: actions/checkout@v3
+      - uses: jorelali/setup-elm@v5
+        with:
+          elm-version: 0.19.1
+      - name: Build
+        working-directory: ${{ matrix.sample }}
+        # Try to compile all .elm files
+        # This fails if:
+        # An .elm file couldn't be compiled
+        # No .elm files were found
+        # No elm.json file could be found in the root of the working directory
+        run: elm make $(find . -name *.elm) --output=/dev/null

bin/configs/elm-petstore.yaml

@@ -0,0 +1,4 @@
+generatorName: elm
+outputDir: samples/client/petstore/elm
+inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
+templateDir: modules/openapi-generator/src/main/resources/elm

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ElmClientCodegen.java

@@ -147,7 +147,7 @@ public ElmClientCodegen() {
         typeMapping.put("DateTime", "Posix");
         typeMapping.put("password", "String");
         typeMapping.put("ByteArray", "String");
-        typeMapping.put("file", "String");
+        typeMapping.put("file", "File");
         typeMapping.put("binary", "String");
         typeMapping.put("UUID", "Uuid");
         typeMapping.put("URI", "String");
@@ -383,8 +383,12 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap operations, L
                 anyOperationParam(ops, param -> (param.isDate || param.isDateTime) || itemsIncludesType(param.items, p -> p.isDate || p.isDateTime));
         final boolean includeUuid = anyOperationResponse(ops, response -> response.isUuid) ||
                 anyOperationParam(ops, param -> param.isUuid || itemsIncludesType(param.items, p -> p.isUuid));
+        final boolean includeFile = anyOperationResponse(ops, response -> response.isFile) ||
+            anyOperationParam(ops, param -> param.isFile || itemsIncludesType(param.items, p -> p.isFile));
+
         operations.put("includeTime", includeTime);
         operations.put("includeUuid", includeUuid);
+        operations.put("includeFile", includeFile);
 
         return operations;
     }
@@ -473,7 +477,7 @@ public String getTypeDeclaration(Schema p) {
     private static class RemoveWhitespaceLambda implements Mustache.Lambda {
         @Override
         public void execute(final Template.Fragment fragment, final Writer writer) throws IOException {
-            writer.write(fragment.execute().replaceAll("\\s+", ""));
+            writer.write(fragment.execute().replaceAll("\\s+", " ").trim());
         }
     }
 

modules/openapi-generator/src/main/resources/elm/Api.mustache

@@ -35,15 +35,15 @@ type Request a =
         }
 
 
-request : String -> String -> List ( String, String ) -> List (String, Maybe String) -> List (String, Maybe String) -> Maybe Json.Encode.Value -> Json.Decode.Decoder a -> Request a
+request : String -> String -> List ( String, String ) -> List (String, Maybe String) -> List (String, Maybe String) -> Maybe Http.Body -> Json.Decode.Decoder a -> Request a
 request method path pathParams queryParams headerParams body decoder =
     Request
         { method = method
         , headers = headers headerParams
         , basePath = "{{basePath}}"
         , pathParams = interpolatePath path pathParams
         , queryParams = queries queryParams
-        , body = Maybe.withDefault Http.emptyBody (Maybe.map Http.jsonBody body)
+        , body = Maybe.withDefault Http.emptyBody body
         , decoder = decoder
         , timeout = Nothing
         , tracker = Nothing

modules/openapi-generator/src/main/resources/elm/elm.mustache

@@ -9,6 +9,7 @@
             "danyx23/elm-uuid": "2.1.2",
             "elm/browser": "1.0.1",
             "elm/core": "1.0.2",
+            "elm/file": "1.0.1",
             "elm/html": "1.0.0",
             "elm/http": "2.0.0",
             "elm/json": "1.1.2",
@@ -18,7 +19,6 @@
         },
         "indirect": {
             "elm/bytes": "1.0.5",
-            "elm/file": "1.0.1",
             "elm/parser": "1.1.0",
             "elm/random": "1.0.0",
             "elm/regex": "1.0.0",

modules/openapi-generator/src/main/resources/elm/fieldDecoder.mustache

@@ -2,7 +2,8 @@
 {{#isDateTime}}Api.Time.dateTimeDecoder{{/isDateTime}}
 {{#isDate}}Api.Time.dateDecoder{{/isDate}}
 {{#isByteArray}}Json.Decode.string{{/isByteArray}}
-{{#isBinary}}Json.Decode.string{{/isBinary}}
+{{#isBinary}}{{^isFile}}Json.Decode.string{{/isFile}}{{/isBinary}}
+{{#isFile}}File.decoder{{/isFile}}
 {{#isString}}{{^isEnum}}{{^isUuid}}Json.Decode.string{{/isUuid}}{{/isEnum}}{{/isString}}
 {{#isInteger}}Json.Decode.int{{/isInteger}}
 {{#isLong}}Json.Decode.int{{/isLong}}

modules/openapi-generator/src/main/resources/elm/formParamEncoder.mustache

@@ -0,0 +1 @@
+{{^required}}Maybe.map ({{/required}}{{#required}}Just <| {{/required}}{{^isFile}}Http.stringPart {{/isFile}}{{#isFile}}Http.filePart {{/isFile}}"{{paramName}}"{{#isBoolean}}(\val -> if val then "true" else "false"){{/isBoolean}}{{#isDateTime}}Api.Time.dateTimeToString{{/isDateTime}}{{#isDate}}Api.Time.dateToString{{/isDate}}{{#isInteger}}String.fromInt{{/isInteger}}{{#isLong}}String.fromInt{{/isLong}}{{#isNumber}}String.fromFloat{{/isNumber}}{{#isFloat}}String.fromFloat{{/isFloat}}{{#isDouble}}String.fromFloat{{/isDouble}}{{#allowableValues}}Api.Data.stringFrom{{#datatypeWithEnum}}{{datatypeWithEnum}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{dataType}}{{/datatypeWithEnum}}{{/allowableValues}}{{#isUuid}}Uuid.toString{{/isUuid}}{{^required}}){{/required}} {{paramName}}

modules/openapi-generator/src/main/resources/elm/model.mustache

@@ -3,7 +3,8 @@
 module Api.Data exposing
 {{#models}}{{#model}}    {{#-first}}( {{/-first}}{{^-first}}, {{/-first}}{{classname}}{{#discriminator}}(..){{/discriminator}}{{^discriminator}}{{#oneOf}}{{#-first}}(..){{/-first}}{{/oneOf}}{{/discriminator}}{{#isEnum}}(..), {{#lambda.camelcase}}{{classname}}{{/lambda.camelcase}}Variants{{/isEnum}}{{^isEnum}}{{#vars}}{{#isCircularReference}}, {{classname}}{{nameInCamelCase}}(..){{/isCircularReference}}{{#isEnum}}, {{classname}}{{nameInCamelCase}}(..), {{#lambda.camelcase}}{{classname}}{{nameInCamelCase}}{{/lambda.camelcase}}Variants{{/isEnum}}{{/vars}}{{/isEnum}}
 {{/model}}{{/models}}{{#models}}{{#model}}    , {{#lambda.camelcase}}encode{{classname}}{{/lambda.camelcase}}
-{{/model}}{{/models}}{{#models}}{{#model}}    , {{#lambda.camelcase}}{{classname}}{{/lambda.camelcase}}Decoder
+{{/model}}{{/models}}{{#models}}{{#model}}{{#isEnum}}    , stringFrom{{^paramName}}{{classname}}{{/paramName}}{{enumName}}
+{{/isEnum}}{{/model}}{{/models}}{{#models}}{{#model}}    , {{#lambda.camelcase}}{{classname}}{{/lambda.camelcase}}Decoder
 {{/model}}{{/models}}    )
 
 import Api{{#includeTime}}

modules/openapi-generator/src/main/resources/elm/operation.mustache

@@ -5,13 +5,14 @@ module Api.Request.{{classname}} exposing
 {{/operation}}{{/operations}}    )
 
 import Api
-import Api.Data{{#includeTime}}
+import Api.Data exposing (..){{#includeTime}}
 import Api.Time exposing (Posix){{/includeTime}}
 import Dict
 import Http
 import Json.Decode
 import Json.Encode{{#includeUuid}}
-import Uuid exposing (Uuid){{/includeUuid}}
+import Uuid exposing (Uuid){{/includeUuid}}{{#includeFile}}
+import File exposing (File){{/includeFile}}
 {{#operations}}
 {{#operation}}
 {{#allParams}}
@@ -26,22 +27,47 @@ import Uuid exposing (Uuid){{/includeUuid}}
 {{/allParams}}
 {{/operation}}
 {{/operations}}
-{{#operations}}{{#operation}}
-
+{{#operations}}
+{{#operation}}
 
 {{#notes}}
 {-| {{{notes}}}
 -}
 {{/notes}}
-{{operationId}} : {{#allParams}}{{^required}}Maybe {{/required}}{{#isArray}}List {{/isArray}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{#isModel}}Api.Data.{{/isModel}}{{dataType}}{{/datatypeWithEnum}} -> {{/allParams}}{{#authMethods}}{{#isBasicBearer}}String -> {{/isBasicBearer}}{{/authMethods}}Api.Request {{^responses}}(){{/responses}}{{#responses}}{{#is2xx}}{{^dataType}}(){{/dataType}}{{#isMap}}(Dict.Dict String {{/isMap}}{{#isArray}}(List {{#items}}{{#isModel}}Api.Data.{{/isModel}}{{/items}}{{/isArray}}{{^isArray}}{{^primitiveType}}{{^isUuid}}Api.Data.{{/isUuid}}{{/primitiveType}}{{/isArray}}{{dataType}}{{#isArray}}){{/isArray}}{{#isMap}}){{/isMap}}{{/is2xx}}{{/responses}}
+{{#lambda.removeWhitespace}}
+{{operationId}} : {{#allParams}}{{>operationParameter}} -> {{/allParams}}
+    {{#authMethods}}{{#isBasicBearer}}String -> {{/isBasicBearer}}{{/authMethods}}Api.Request
+    {{#responses}} {{!-- This iterates through all different responses, some might not be 200 }}
+        {{#-first}} {{!-- We have no way to handle multiple return types today so we just handle the first }}
+            {{#is2xx}}
+                {{^dataType}}(){{/dataType}}
+                {{#isMap}}(Dict.Dict String {{/isMap}}
+                {{#isArray}}(List {{#items}}{{#isModel}}Api.Data.{{/isModel}}{{/items}}{{/isArray}}{{^isArray}}{{^primitiveType}}{{^isUuid}}{{^isFile}}Api.Data.{{/isFile}}{{/isUuid}}{{/primitiveType}}{{/isArray}}{{dataType}}{{#isArray}}){{/isArray}}{{#isMap}}){{/isMap}}
+            {{/is2xx}}
+            {{^is2xx}}(){{/is2xx}}
+        {{/-first}}
+    {{/responses}}
+{{/lambda.removeWhitespace}}
+
 {{operationId}}{{#allParams}} {{>paramName}}{{/allParams}}{{#authMethods}}{{#isBasicBearer}} auth_token{{/isBasicBearer}}{{/authMethods}} =
     Api.request
         "{{httpMethod}}"
         "{{path}}"
         [{{#pathParams}} ( "{{paramName}}", {{>paramToString}} {{>paramName}} ){{#-last}} {{/-last}}{{^-last}},{{/-last}}{{/pathParams}}]
         [{{#queryParams}} ( "{{baseName}}", {{#required}}Just <| {{/required}}{{^required}}Maybe.map {{/required}}{{>paramToString}} {{>paramName}} ){{#-last}} {{/-last}}{{^-last}},{{/-last}}{{/queryParams}}]
         [{{#headerParams}} ( "{{baseName}}", {{#required}}Just <| {{/required}}{{^required}}Maybe.map {{/required}}{{>paramToString}} {{>paramName}} ){{#-last}} {{/-last}}{{^-last}},{{/-last}}{{/headerParams}}]
-        {{#bodyParam}}({{#required}}Just ({{/required}}{{^required}}Maybe.map {{/required}}{{#isModel}}Api.Data.{{/isModel}}{{>recordFieldValueEncoder}} {{>paramName}}{{#required}}){{/required}}){{/bodyParam}}{{^bodyParam}}Nothing{{/bodyParam}}
-        {{^responses}}(Json.Decode.succeed ()){{/responses}}{{#responses}}{{#is2xx}}{{^dataType}}(Json.Decode.succeed ()){{/dataType}}{{#dataType}}{{>recordFieldValueDecoder}}{{/dataType}}{{/is2xx}}{{/responses}}{{#authMethods}}{{#isBasicBearer}}
-        |> Api.withBearerToken auth_token{{/isBasicBearer}}{{/authMethods}}
-{{/operation}}{{/operations}}
+        {{#bodyParam}}
+        (Maybe.map Http.jsonBody ({{#required}}Just ({{/required}}{{^required}}Maybe.map {{/required}}{{#isModel}}Api.Data.{{/isModel}}{{>recordFieldValueEncoder}} {{>paramName}}{{#required}}){{/required}}))
+        {{/bodyParam}}
+        {{#formParams.0}}
+        (Just <| Http.multipartBody <| List.filterMap identity [ {{#formParams}}{{>formParamEncoder}}{{^-last}}, {{/-last}}{{/formParams}} ])
+        {{/formParams.0}}
+        {{^bodyParam}}
+        {{^formParams}}
+        Nothing
+        {{/formParams}}
+        {{/bodyParam}}
+        {{#responses}}{{#-first}}{{#is2xx}}{{^dataType}}(Json.Decode.succeed ()){{/dataType}}{{#dataType}}{{>recordFieldValueDecoder}}{{/dataType}}{{/is2xx}}{{^is2xx}}(Json.Decode.succeed ()){{/is2xx}}{{/-first}}{{/responses}}{{^responses}}(Json.Decode.succeed ()){{/responses}}
+{{#authMethods}}{{#isBasicBearer}}        |> Api.withBearerToken auth_token{{/isBasicBearer}}{{/authMethods}}
+{{/operation}}
+{{/operations}}

modules/openapi-generator/src/main/resources/elm/operationParameter.mustache

@@ -0,0 +1 @@
+{{^required}}Maybe {{/required}}{{#isArray}}{{^required}}({{/required}}List {{/isArray}}{{#isModel}}Api.Data.{{/isModel}}{{#items.isModel}}Api.Data.{{/items.isModel}}{{#isAnyType}}Api.Data.{{/isAnyType}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{dataType}}{{/datatypeWithEnum}}{{#isArray}}{{^required}}){{/required}}{{/isArray}}

modules/openapi-generator/src/main/resources/elm/paramToString.mustache

@@ -1 +1,22 @@
-{{#isArray}}String.join "," << List.map {{#items}}{{>paramToString}}{{/items}}{{/isArray}}{{^isArray}}{{^isEnum}}{{^isUuid}}{{#isString}}identity{{/isString}}{{#isBinary}}identity{{/isBinary}}{{#isByteArray}}identity{{/isByteArray}}{{/isUuid}}{{/isEnum}}{{#isBoolean}}(\val -> if val then "true" else "false"){{/isBoolean}}{{#isDateTime}}Api.Time.dateTimeToString{{/isDateTime}}{{#isDate}}Api.Time.dateToString{{/isDate}}{{#isInteger}}String.fromInt{{/isInteger}}{{#isLong}}String.fromInt{{/isLong}}{{#isNumber}}String.fromFloat{{/isNumber}}{{#isFloat}}String.fromFloat{{/isFloat}}{{#isDouble}}String.fromFloat{{/isDouble}}{{#isEnum}}stringFrom{{^paramName}}Api.Data.{{classname}}{{/paramName}}{{enumName}}{{/isEnum}}{{#isUuid}}Uuid.toString{{/isUuid}}{{/isArray}}
+{{#lambda.removeWhitespace}}
+{{#isArray}}(String.join "," << List.map {{#isEnum}}stringFrom{{#datatypeWithEnum}}{{datatypeWithEnum}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{dataType}}{{/datatypeWithEnum}}{{/isEnum}}{{^isEnum}} {{#items}}{{>paramToString}}{{/items}}{{/isEnum}}){{/isArray}}
+{{^isArray}}
+{{^isEnum}}
+{{^isUuid}}
+{{#isString}}identity{{/isString}}
+{{#isBinary}}identity{{/isBinary}}
+{{#isByteArray}}identity{{/isByteArray}}
+{{/isUuid}}
+{{/isEnum}}
+{{#isBoolean}}(\val -> if val then "true" else "false"){{/isBoolean}}
+{{#isDateTime}}Api.Time.dateTimeToString{{/isDateTime}}
+{{#isDate}}Api.Time.dateToString{{/isDate}}
+{{#isInteger}}String.fromInt{{/isInteger}}
+{{#isLong}}String.fromInt{{/isLong}}
+{{#isNumber}}String.fromFloat{{/isNumber}}
+{{#isFloat}}String.fromFloat{{/isFloat}}
+{{#isDouble}}String.fromFloat{{/isDouble}}
+{{#allowableValues}}{{^isEnum}}Api.Data.{{/isEnum}}stringFrom{{#datatypeWithEnum}}{{datatypeWithEnum}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{dataType}}{{/datatypeWithEnum}}{{/allowableValues}}
+{{#isUuid}}Uuid.toString{{/isUuid}}
+{{/isArray}}
+{{/lambda.removeWhitespace}}

modules/openapi-generator/src/main/resources/elm/recordField.mustache

@@ -1 +1,9 @@
-{{#isNullable}}Maybe {{#isContainer}}({{/isContainer}}{{/isNullable}}{{^isNullable}}{{^required}}Maybe {{#isContainer}}({{/isContainer}}{{/required}}{{/isNullable}}{{#isArray}}List {{/isArray}}{{#isMap}}Dict.Dict String {{/isMap}}{{#isEnum}}{{classname}}{{enumName}}{{/isEnum}}{{^isEnum}}{{#items}}({{>recordField}}){{/items}}{{^isContainer}}{{dataType}}{{/isContainer}}{{/isEnum}}{{#isContainer}}{{#isNullable}}){{/isNullable}}{{^isNullable}}{{^required}}){{/required}}{{/isNullable}}{{/isContainer}}
+{{#lambda.removeWhitespace}}
+{{#isNullable}}Maybe {{#isContainer}}({{/isContainer}}{{/isNullable}}
+{{^isNullable}}{{^required}}Maybe {{#isContainer}}({{/isContainer}}{{/required}}{{/isNullable}}
+{{#isArray}}List {{/isArray}}
+{{#isMap}}Dict.Dict String {{/isMap}}
+{{#isEnum}}{{classname}}{{enumName}}{{/isEnum}}
+{{^isEnum}}{{#items}}{{#isContainer}}({{/isContainer}}{{>recordField}}{{#isContainer}}){{/isContainer}}{{/items}}{{^isContainer}}{{dataType}}{{/isContainer}}{{/isEnum}}
+{{#isContainer}}{{#isNullable}}){{/isNullable}}{{^isNullable}}{{^required}}){{/required}}{{/isNullable}}{{/isContainer}}
+{{/lambda.removeWhitespace}}

modules/openapi-generator/src/main/resources/elm/recordFieldEncoder.mustache

@@ -1 +1 @@
-{{#required}}encode{{/required}}{{^required}}maybeEncode{{/required}}{{#isNullable}}Nullable{{/isNullable}} "{{baseName}}" {{>recordFieldValueEncoder}} {{#isCircularReference}}<| unwrap{{classname}}{{nameInCamelCase}} {{/isCircularReference}}model.{{name}}
+{{#required}}encode{{/required}}{{^required}}maybeEncode{{/required}}{{#isNullable}}Nullable{{/isNullable}} "{{baseName}}" {{#isContainer}}({{/isContainer}}{{>recordFieldValueEncoder}}{{#isContainer}}){{/isContainer}} {{#isCircularReference}}<| unwrap{{classname}}{{nameInCamelCase}} {{/isCircularReference}}model.{{name}}

modules/openapi-generator/src/main/resources/elm/recordFieldValueEncoder.mustache

@@ -1 +1 @@
-{{#isContainer}}({{#isArray}}Json.Encode.list{{/isArray}}{{#isMap}}Json.Encode.dict identity{{/isMap}} {{#items}}{{>recordFieldValueEncoder}}{{/items}}{{/isContainer}}{{^isContainer}}{{>fieldEncoder}}{{/isContainer}}{{#isContainer}}){{/isContainer}}
+{{#isContainer}}{{#isArray}}Json.Encode.list{{/isArray}}{{#isMap}}Json.Encode.dict identity{{/isMap}} {{#items}}{{#isContainer}}({{/isContainer}}{{>recordFieldValueEncoder}}{{#isContainer}}){{/isContainer}}{{/items}}{{/isContainer}}{{^isContainer}}{{>fieldEncoder}}{{/isContainer}}

samples/client/petstore/elm/.openapi-generator/FILES

@@ -0,0 +1,9 @@
+.gitignore
+README.md
+elm.json
+src/Api.elm
+src/Api/Data.elm
+src/Api/Request/Pet.elm
+src/Api/Request/Store.elm
+src/Api/Request/User.elm
+src/Api/Time.elm

samples/client/petstore/elm/.openapi-generator/VERSION

@@ -0,0 +1 @@
+6.6.0-SNAPSHOT

samples/client/petstore/elm/elm-compile-test

@@ -0,0 +1,14 @@
+#!/bin/bash -e
+# elm make all elm files under src
+
+for ELM in `find src -name "*.elm"`
+do
+    echo "Compiling $ELM"
+    elm make $ELM --output /dev/null
+    rc=$?
+    if [[ $rc != 0 ]]
+    then
+        echo "ERROR!! FAILED TO COMPILE $ELM"
+        exit $rc;
+    fi
+done

samples/openapi3/client/petstore/elm/elm.json → samples/client/petstore/elm/elm.json

@@ -3,13 +3,13 @@
     "source-directories": [
         "src"
     ],
-    "elm-version": "0.19.0",
+    "elm-version": "0.19.1",
     "dependencies": {
         "direct": {
-            "NoRedInk/elm-json-decode-pipeline": "1.0.0",
             "danyx23/elm-uuid": "2.1.2",
             "elm/browser": "1.0.1",
             "elm/core": "1.0.2",
+            "elm/file": "1.0.1",
             "elm/html": "1.0.0",
             "elm/http": "2.0.0",
             "elm/json": "1.1.2",
@@ -19,7 +19,6 @@
         },
         "indirect": {
             "elm/bytes": "1.0.5",
-            "elm/file": "1.0.1",
             "elm/parser": "1.1.0",
             "elm/random": "1.0.0",
             "elm/regex": "1.0.0",