Changes for release 2.0.0

.gitignore

@@ -15,4 +15,10 @@ python-examples/logs.txt
 
 doc/code-gen/.idea
 doc/code-gen/.gradle
-doc/code-gen/build
+doc/code-gen/build
+*/.gradle
+*/gradle/wrapper
+*/gradle/wrapper/*
+*/node_modules
+typescript-examples/package-lock.json
+typescript-examples/package.json

doc/code-gen/BUILDME.md

@@ -18,7 +18,7 @@ If you need to regenerate a single client for a given language:
 3. The code will generate in a `build` dir. Navigate to the `build` dir.
 4. From the `build` dir, copy the generated code files and any other files required to build the project to the
    corresponding "examples" folder.
-    1. See [next steps](#tasks-to-regenerate-code--copy-files) for details based on your language generated
+   1. See [next steps](#tasks-to-regenerate-code--copy-files) for details based on your language generated
 
 **[Back to top](#evsrestapi-regenerate-client-sdks)**
 
@@ -31,7 +31,7 @@ If you need to rebuild all the clients for all languages, typically after a big
 3. All generated projects will be in a `build` folder. Navigate to the `build` folder to see the generated code
 4. From the `build` folder, copy the generated code files and additional files needs to build/compile the project to the
    corresponding `-examples` folder.
-    1. See [next steps](#tasks-to-regenerate-code--copy-files) for details
+   1. See [next steps](#tasks-to-regenerate-code--copy-files) for details
 
 **[Back to top](#evsrestapi-regenerate-client-sdks)**
 
@@ -46,10 +46,10 @@ corresponding `-examples` directory
 1. To generate the client code for java, run `./gradlew buildJavaSdk`
 2. Find the generated client in `build/java`
 3. Copy the new files generated from the `src/main` folder to the `java-examples/src/main` folder.
-    1. 🚫🚫 **DO NOT**  replace `ApiClient.java`
-        1. `java-examples` uses `src/main/resources/url.properties` to set the basePath url in `ApiClient.java`.
-            1. The url should be updated in the `url.properties` file only.
-    2. 🚫🚫 **DO NOT** replace tests. Update tests to demo the new api calls or fix failing tests.
+   1. 🚫🚫 **DO NOT** replace `ApiClient.java`
+      1. `java-examples` uses `src/main/resources/url.properties` to set the basePath url in `ApiClient.java`.
+         1. The url should be updated in the `url.properties` file only.
+   2. 🚫🚫 **DO NOT** replace tests. Update tests to demo the new api calls or fix failing tests.
 4. Verify the gradle files match between what was generated vs what exists in `java-examples`. Update as needed, but
    **don't** override.
 5. Verify the project builds and the tests run successfully before pushing changes
@@ -59,29 +59,60 @@ corresponding `-examples` directory
 1. To generate the client code for python, run `./gradlew buildPythonSdk`
 2. Find the generated client in `build/python`
 3. Copy the new files generated from the `build/python/python-examples/` folder to the `python-examples` folder.
-    1. 🚫🚫 **DO NOT** replace `api_client.py`,
-        1. `python-examples` uses `config.ini` to set the basePath url in `api_client.py`. The url should be updated in
-           the `config.ini` files only. Compare the generated `api_client.py` with the already existing one to determine
-           if anything is missing. Add sections as needed.
-    2. 🚫🚫 **DO NOT** replace `requirements.txt`, or `test-requirements.txt`.
-        1. We have additional requirements added that aren't part of the generated requirements files. Compare the
-           generated `requirements.txt` and `test-requirements.txt` to the existing ones and add new reqs as needed
+   1. 🚫🚫 **DO NOT** replace `api_client.py`,
+      1. `python-examples` uses `config.ini` to set the basePath url in `api_client.py`. The url should be updated in
+         the `config.ini` files only. Compare the generated `api_client.py` with the already existing one to determine
+         if anything is missing. Add sections as needed.
+   2. 🚫🚫 **DO NOT** replace `requirements.txt`, or `test-requirements.txt`.
+      1. We have additional requirements added that aren't part of the generated requirements files. Compare the
+         generated `requirements.txt` and `test-requirements.txt` to the existing ones and add new reqs as needed
 4. ⚠️⚠️ Update imports for `api.__init__.py` and `models.__init__.py` to add `evs.` as a prefix in the `from` statement. The generated
    code doesn't include the root package in the imports in these files which will cause the tests to fail.
 5. 🚫🚫 **DO NOT** replace tests. Update tests to demo the new api calls or fix failing tests.
 6. Verify the tests run successfully in the IDE and the terminal before pushing changes.
 
 **[Back to top](#evsrestapi-regenerate-client-sdks)**
 
+### Go client
+
+1. To generate the client code for Go, run `./gradlew buildGoSdk`
+2. Find the generated client in `build/go`
+3. Copy the new files generated from the `build/go/` folder to the `go-examples` folder. Only copy files that have a .go suffix (e.g. client.go).
+   1. The `test` directory will contain some boilerplate test skeletons for the generated APIs. We won't be using those. Add any new API tests (or new API test files) to the already existing test files in the `go-examples` directory.
+   2. Files related to configuration and bootstrapping such as `client.go` and `configuration.go` work out of the box and don't need to be copied over again.
+      1. `configuration.go` contains the different test environments that are currently supported, as well as a method for switching between them. See the baseUrls struct in [configuration.go](../../go-examples/configuration.go#L90) for the currently supported test environments and their corresponding URLs. Change the url key [a few lines down](../../go-examples/configuration.go#L99) in `url := baseUrls['production']` to select what environment you wish to run the tests in.
+      2. If you'd like to add new environments, simply add a new entry to the baseUrls struct to register it.
+4. Install necessary imports as per the Installation section in the README (which resides in `go-examples` [here](../../go-examples/README.md#installation)).
+5. 🚫🚫 **DO NOT** replace tests. Update tests to demo the new api calls or fix failing tests. The same applies to the `go-examples` README documentation. Avoid replacing api documentation in favor of adding new api calls in the same format (which is likely available in the auto-generated README).
+6. Verify the tests run successfully in the IDE and the terminal before pushing changes.
+   1. To run the go tests, see the [test running](../../go-examples/README.md#test-running) section of the `go-examples` README.
+
+**[Back to top](#evsrestapi-regenerate-client-sdks)**
+
+### Typescript client
+
+1. To generate the client code for Typescript, run `./gradlew buildTypescriptSdk`
+2. Find the generated client in `build/typescript`
+3. Copy the new api files generated from the `build/typescript/api` folder to the `typescript-examples/api` folder. Only copy files from this directory, as the rest are helper functions and configuration/utility code that won't need to change as the API does.
+   1. `typescript-examples/config.json` contains the different test environments that are currently supported, as well as a method for switching between them. See the baseUrls struct in [config.json](../../typescript-examples/config.json#L2) for the currently supported test environments and their corresponding URLs. Change the currentEnvironment key [a few lines down](../../typescript-examples/config.json#L8) to select what environment you wish to run the tests in.
+   2. If you'd like to add new environments, simply add a new entry to the baseUrls struct to register it.
+4. Install necessary imports as per the Installation section in the README (which resides in `typescript-examples` [here](../../typescript-examples/README.md#extra-library-installation)).
+5. 🚫🚫 **DO NOT** replace tests. Update tests to demo the new api calls or fix failing tests. The same applies to the `typescript-examples` README documentation. Avoid replacing api documentation in favor of adding new api calls in the same format (which is likely available in the auto-generated README).
+6. Verify the tests run successfully in the IDE and the terminal before pushing changes.
+   1. To run the typescript tests, see the [test running](../../typescript-examples/README.md#test-running) section of the `typescript-examples` README.
+
+**[Back to top](#evsrestapi-regenerate-client-sdks)**
+
 ## Resources
 
-* https://github.com/int128/gradle-swagger-generator-plugin?tab=readme-ov-file#introduction
-* https://stackoverflow.com/questions/66137846/how-to-use-the-open-api-3-gradle-plugin
+- <https://github.com/int128/gradle-swagger-generator-plugin?tab=readme-ov-file#introduction>
+- <https://stackoverflow.com/questions/66137846/how-to-use-the-open-api-3-gradle-plugin>
 
 ## Current Contributors
 
 - [Brian Carlsen](https://github.com/bcarlsenca)
 - [Alicia Garcia](https://github.com/gaaliciA1990)
+- [Peter Van Ausdeln](https://github.com/peter-va)
 - [Other Contributors](https://github.com/NCIEVS/evsrestapi-client-SDK/graphs/contributors)
 
 **[Back to top](#evsrestapi-regenerate-client-sdks)**

doc/code-gen/build.gradle

@@ -72,14 +72,43 @@ tasks.register('buildPythonSdk', GenerateTask) {
     dependsOn tasks.named('clearBuildDir')
 }
 
+tasks.register('buildTypescriptSdk', GenerateTask) {
+    generatorName.set("typescript")
+    remoteInputSpec.set(inputURL)
+    outputDir.set("$buildDir/typescript")
+    modelPackage.set("models")
+    configOptions.set([
+        "npmName": "evs",
+        "npmVersion": "1.0.0",
+        "supportsES6": "true",
+        "hideGenerationTimestamp": "false",
+        // if there are unknown properties present, ignore them
+        "additionalProperties": "true"
+    ])
+    dependsOn tasks.named('clearBuildDir')
+}
+
+tasks.register('buildGoSdk', GenerateTask) {
+    generatorName.set("go")
+    remoteInputSpec.set(inputURL)
+    outputDir.set("$buildDir/go")
+    configOptions.set([
+        "packageName": "evs",
+        "hideGenerationTimestamp": "false",
+        // Enable handling unknown properties
+        "additionalProperties": "true"
+    ])
+    dependsOn tasks.named('clearBuildDir')
+}
+
 /** Runs all code-gen tasks for each language to generate the clients */
 tasks.register("buildClients") {
     dependsOn("buildJavaSdk",
                 "buildPythonSdk",
-//            "buildGoSdk",
+            "buildGoSdk",
 //            "buildKotlinSdk",
 //            "buildBashSdk",
-//            "buildTypescriptSdk"
+           "buildTypescriptSdk"
     )
     doLast {
         println 'All client sdk generated. They can be found in the code-gen/build folder.'
@@ -91,8 +120,8 @@ compileJava.dependsOn tasks.named("buildJavaSdk")
 build.dependsOn('buildClients')
 publishToMavenLocal.dependsOn = ["buildJavaSdk`",
                                  "buildPythonSdk",
-//                                 "buildGoSdk",
+                                 "buildGoSdk",
+                                 "buildTypescriptSdk",
 //                                 "buildKotlinSdk",
 //                                 "buildBashSdk",
-//                                 "buildTypescriptSdk"
 ]