@arrirpc/codegen-kotlin 0.67.0 → 0.68.0

package/README.md

@@ -30,8 +30,8 @@ export default defineConfig({
 
 The generated code relies on the following dependencies:
 
--   [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization)
--   [ktor client](https://ktor.io/docs/client-dependencies.html)
+- [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization)
+- [ktor client](https://ktor.io/docs/client-dependencies.html)
 
 ## Using the Generated Code
 
@@ -72,6 +72,15 @@ val service = MyClientUsersService(
     )
 ```
 
+#### Client / Service Options
+
+| Name               | Type                                   | Description                                                      |
+| ------------------ | -------------------------------------- | ---------------------------------------------------------------- |
+| httpClient         | `HttpClient`                           | An instance of ktor HttpClient                                   |
+| baseUrl            | `String`                               | The base URL of the API server                                   |
+| headers            | `(() -> MutableMap<String, String>?)?` | A function that returns a map of http headers                    |
+| onError (Optional) | `((err: Exception) -> Unit)`           | A hook that fires whenever any exception is thrown by the client |
+
 ### Calling Procedures
 
 #### Standard HTTP Procedures
@@ -149,19 +158,19 @@ All generated models will be data classes. They will have access to the followin
 
 **Methods**:
 
--   `toJson(): String`
--   `toUrlQueryParams(): String`
+- `toJson(): String`
+- `toUrlQueryParams(): String`
 
 **Factory Methods**:
 
--   `new()`
--   `fromJson(input: String)`
--   `fromJsonElement(input: JsonElement, instancePath: String)`
+- `new()`
+- `fromJson(input: String)`
+- `fromJsonElement(input: JsonElement, instancePath: String)`
 
 **Other Notes**
 
--   All Enums will have a `serialValue` property.
--   Discriminator schemas are converted to sealed classes
+- All Enums will have a `serialValue` property.
+- Discriminator schemas are converted to sealed classes
 
 ## Development
 

package/dist/index.cjs

@@ -1163,6 +1163,7 @@ function kotlinHttpRpcFromSchema(schema, context) {
                 bufferCapacity = bufferCapacity,
                 onOpen = onOpen,
                 onClose = onClose,
+                onError = onError,
                 onRequestError = onRequestError,
                 onResponseError = onResponseError,
                 onData = { str ->
@@ -1181,18 +1182,23 @@ function kotlinHttpRpcFromSchema(schema, context) {
             )
         }`;
   return `${codeComment}suspend fun ${name}(${params ? `params: ${params}` : ""}): ${response ?? "Unit"} {
-        val response = __prepareRequest(
-            client = httpClient,
-            url = "$baseUrl${schema.path}",
-            method = HttpMethod.${codegenUtils.pascalCase(schema.method, { normalize: true })},
-            params = ${params ? "params" : null},
-            headers = headers?.invoke(),
-        ).execute()
-        ${response ? headingCheck : ""}
-        if (response.status.value in 200..299) {
-            return ${response ? `${response}.fromJson(response.bodyAsText())` : ""}
+        try {
+            val response = __prepareRequest(
+                client = httpClient,
+                url = "$baseUrl${schema.path}",
+                method = HttpMethod.${codegenUtils.pascalCase(schema.method, { normalize: true })},
+                params = ${params ? "params" : null},
+                headers = headers?.invoke(),
+            ).execute()
+            ${response ? headingCheck : ""}
+            if (response.status.value in 200..299) {
+                return ${response ? `${response}.fromJson(response.bodyAsText())` : ""}
+            }
+            throw ${context.clientName}Error.fromJson(response.bodyAsText())    
+        } catch (e: Exception) {
+            onError(e)
+            throw e
         }
-        throw ${context.clientName}Error.fromJson(response.bodyAsText())
     }`;
 }
 function kotlinWsRpcFromSchema(_schema, _context) {
@@ -1214,6 +1220,7 @@ function kotlinServiceFromSchema(schema, context) {
                 httpClient = httpClient,
                 baseUrl = baseUrl,
                 headers = headers,
+                onError = onError,
             )`);
       if (subService.content) {
         subServiceParts.push(subService.content);
@@ -1237,6 +1244,7 @@ function kotlinServiceFromSchema(schema, context) {
     private val httpClient: HttpClient,
     private val baseUrl: String,
     private val headers: headersFn,
+    private val onError: ((err: Exception) -> Unit) = {},
 ) {
     ${procedureParts.join("\n\n    ")}
 }
@@ -1334,6 +1342,7 @@ function kotlinClientFromAppDefinition(def, options) {
                 httpClient = httpClient,
                 baseUrl = baseUrl,
                 headers = headers,
+                onError = onError,
             )`);
       if (subService.content) {
         subServiceParts.push(subService.content);
@@ -1365,6 +1374,7 @@ class ${clientName}(
     private val httpClient: HttpClient,
     private val baseUrl: String,
     private val headers: headersFn,
+    private val onError: ((err: Exception) -> Unit) = {},
 ) {
     ${procedureParts.join("\n\n    ")}
 }
@@ -1734,8 +1744,9 @@ private suspend fun __handleSseRequest(
     onOpen: ((response: HttpResponse) -> Unit) = {},
     onClose: (() -> Unit) = {},
     onData: ((data: String) -> Unit) = {},
-    onRequestError: ((error: Exception) -> Unit) = {},
-    onResponseError: ((error: ${clientName}Error) -> Unit) = {},
+    onError: ((err: Exception) -> Unit) = {},
+    onRequestError: ((err: Exception) -> Unit) = {},
+    onResponseError: ((err: ${clientName}Error) -> Unit) = {},
     bufferCapacity: Int,
 ) {
     val finalHeaders = headers?.invoke() ?: mutableMapOf()
@@ -1770,18 +1781,18 @@ private suspend fun __handleSseRequest(
             if (httpResponse.status.value !in 200..299) {
                 try {
                     if (httpResponse.headers["Content-Type"] == "application/json") {
-                        onResponseError(
-                            ${clientName}Error.fromJson(httpResponse.bodyAsText())
-                        )
+                        val err = ${clientName}Error.fromJson(httpResponse.bodyAsText()) 
+                        onError(err)
+                        onResponseError(err)
                     } else {
-                        onResponseError(
-                            ${clientName}Error(
-                                code = httpResponse.status.value,
-                                errorMessage = httpResponse.status.description,
-                                data = JsonPrimitive(httpResponse.bodyAsText()),
-                                stack = null,
-                            )
+                        val err = ${clientName}Error(
+                            code = httpResponse.status.value,
+                            errorMessage = httpResponse.status.description,
+                            data = JsonPrimitive(httpResponse.bodyAsText()),
+                            stack = null,
                         )
+                        onError(err)
+                        onResponseError(err)
                     }
                 } catch (e: CancellationException) {
                     onClose()
@@ -1801,19 +1812,21 @@ private suspend fun __handleSseRequest(
                     onOpen = onOpen,
                     onClose = onClose,
                     onData = onData,
+                    onError = onError,
+                    onRequestError = onRequestError,
                     onResponseError = onResponseError,
                 )
             }
             if (httpResponse.headers["Content-Type"] != "text/event-stream") {
                 try {
-                    onResponseError(
-                        ${clientName}Error(
-                            code = 0,
-                            errorMessage = "Expected server to return Content-Type \\"text/event-stream\\". Got \\"\${httpResponse.headers["Content-Type"]}\\"",
-                            data = JsonPrimitive(httpResponse.bodyAsText()),
-                            stack = null,
-                        )
+                    val err = ${clientName}Error(
+                        code = 0,
+                        errorMessage = "Expected server to return Content-Type \\"text/event-stream\\". Got \\"\${httpResponse.headers["Content-Type"]}\\"",
+                        data = JsonPrimitive(httpResponse.bodyAsText()),
+                        stack = null,
                     )
+                    onError(err)
+                    onResponseError(err)
                 } catch (e: CancellationException) {
                     httpResponse.cancel()
                     return@execute
@@ -1831,6 +1844,8 @@ private suspend fun __handleSseRequest(
                     onOpen = onOpen,
                     onClose = onClose,
                     onData = onData,
+                    onError = onError,
+                    onRequestError = onRequestError,
                     onResponseError = onResponseError,
                 )
             }
@@ -1882,10 +1897,13 @@ private suspend fun __handleSseRequest(
                 onOpen = onOpen,
                 onClose = onClose,
                 onData = onData,
+                onError = onError,
+                onRequestError = onRequestError,
                 onResponseError = onResponseError,
             )
         }
     } catch (e: java.net.ConnectException) {
+        onError(e)
         onRequestError(e)
         return __handleSseRequest(
             httpClient = httpClient,
@@ -1900,9 +1918,12 @@ private suspend fun __handleSseRequest(
             onOpen = onOpen,
             onClose = onClose,
             onData = onData,
+            onError = onError,
+            onRequestError = onRequestError,
             onResponseError = onResponseError,
         )
     } catch (e: Exception) {
+        onError(e)
         onRequestError(e)
         return __handleSseRequest(
             httpClient = httpClient,
@@ -1917,6 +1938,8 @@ private suspend fun __handleSseRequest(
             onOpen = onOpen,
             onClose = onClose,
             onData = onData,
+            onError = onError,
+            onRequestError = onRequestError,
             onResponseError = onResponseError,
         )
     }

package/dist/index.mjs

@@ -1157,6 +1157,7 @@ function kotlinHttpRpcFromSchema(schema, context) {
                 bufferCapacity = bufferCapacity,
                 onOpen = onOpen,
                 onClose = onClose,
+                onError = onError,
                 onRequestError = onRequestError,
                 onResponseError = onResponseError,
                 onData = { str ->
@@ -1175,18 +1176,23 @@ function kotlinHttpRpcFromSchema(schema, context) {
             )
         }`;
   return `${codeComment}suspend fun ${name}(${params ? `params: ${params}` : ""}): ${response ?? "Unit"} {
-        val response = __prepareRequest(
-            client = httpClient,
-            url = "$baseUrl${schema.path}",
-            method = HttpMethod.${pascalCase(schema.method, { normalize: true })},
-            params = ${params ? "params" : null},
-            headers = headers?.invoke(),
-        ).execute()
-        ${response ? headingCheck : ""}
-        if (response.status.value in 200..299) {
-            return ${response ? `${response}.fromJson(response.bodyAsText())` : ""}
+        try {
+            val response = __prepareRequest(
+                client = httpClient,
+                url = "$baseUrl${schema.path}",
+                method = HttpMethod.${pascalCase(schema.method, { normalize: true })},
+                params = ${params ? "params" : null},
+                headers = headers?.invoke(),
+            ).execute()
+            ${response ? headingCheck : ""}
+            if (response.status.value in 200..299) {
+                return ${response ? `${response}.fromJson(response.bodyAsText())` : ""}
+            }
+            throw ${context.clientName}Error.fromJson(response.bodyAsText())    
+        } catch (e: Exception) {
+            onError(e)
+            throw e
         }
-        throw ${context.clientName}Error.fromJson(response.bodyAsText())
     }`;
 }
 function kotlinWsRpcFromSchema(_schema, _context) {
@@ -1208,6 +1214,7 @@ function kotlinServiceFromSchema(schema, context) {
                 httpClient = httpClient,
                 baseUrl = baseUrl,
                 headers = headers,
+                onError = onError,
             )`);
       if (subService.content) {
         subServiceParts.push(subService.content);
@@ -1231,6 +1238,7 @@ function kotlinServiceFromSchema(schema, context) {
     private val httpClient: HttpClient,
     private val baseUrl: String,
     private val headers: headersFn,
+    private val onError: ((err: Exception) -> Unit) = {},
 ) {
     ${procedureParts.join("\n\n    ")}
 }
@@ -1328,6 +1336,7 @@ function kotlinClientFromAppDefinition(def, options) {
                 httpClient = httpClient,
                 baseUrl = baseUrl,
                 headers = headers,
+                onError = onError,
             )`);
       if (subService.content) {
         subServiceParts.push(subService.content);
@@ -1359,6 +1368,7 @@ class ${clientName}(
     private val httpClient: HttpClient,
     private val baseUrl: String,
     private val headers: headersFn,
+    private val onError: ((err: Exception) -> Unit) = {},
 ) {
     ${procedureParts.join("\n\n    ")}
 }
@@ -1728,8 +1738,9 @@ private suspend fun __handleSseRequest(
     onOpen: ((response: HttpResponse) -> Unit) = {},
     onClose: (() -> Unit) = {},
     onData: ((data: String) -> Unit) = {},
-    onRequestError: ((error: Exception) -> Unit) = {},
-    onResponseError: ((error: ${clientName}Error) -> Unit) = {},
+    onError: ((err: Exception) -> Unit) = {},
+    onRequestError: ((err: Exception) -> Unit) = {},
+    onResponseError: ((err: ${clientName}Error) -> Unit) = {},
     bufferCapacity: Int,
 ) {
     val finalHeaders = headers?.invoke() ?: mutableMapOf()
@@ -1764,18 +1775,18 @@ private suspend fun __handleSseRequest(
             if (httpResponse.status.value !in 200..299) {
                 try {
                     if (httpResponse.headers["Content-Type"] == "application/json") {
-                        onResponseError(
-                            ${clientName}Error.fromJson(httpResponse.bodyAsText())
-                        )
+                        val err = ${clientName}Error.fromJson(httpResponse.bodyAsText()) 
+                        onError(err)
+                        onResponseError(err)
                     } else {
-                        onResponseError(
-                            ${clientName}Error(
-                                code = httpResponse.status.value,
-                                errorMessage = httpResponse.status.description,
-                                data = JsonPrimitive(httpResponse.bodyAsText()),
-                                stack = null,
-                            )
+                        val err = ${clientName}Error(
+                            code = httpResponse.status.value,
+                            errorMessage = httpResponse.status.description,
+                            data = JsonPrimitive(httpResponse.bodyAsText()),
+                            stack = null,
                         )
+                        onError(err)
+                        onResponseError(err)
                     }
                 } catch (e: CancellationException) {
                     onClose()
@@ -1795,19 +1806,21 @@ private suspend fun __handleSseRequest(
                     onOpen = onOpen,
                     onClose = onClose,
                     onData = onData,
+                    onError = onError,
+                    onRequestError = onRequestError,
                     onResponseError = onResponseError,
                 )
             }
             if (httpResponse.headers["Content-Type"] != "text/event-stream") {
                 try {
-                    onResponseError(
-                        ${clientName}Error(
-                            code = 0,
-                            errorMessage = "Expected server to return Content-Type \\"text/event-stream\\". Got \\"\${httpResponse.headers["Content-Type"]}\\"",
-                            data = JsonPrimitive(httpResponse.bodyAsText()),
-                            stack = null,
-                        )
+                    val err = ${clientName}Error(
+                        code = 0,
+                        errorMessage = "Expected server to return Content-Type \\"text/event-stream\\". Got \\"\${httpResponse.headers["Content-Type"]}\\"",
+                        data = JsonPrimitive(httpResponse.bodyAsText()),
+                        stack = null,
                     )
+                    onError(err)
+                    onResponseError(err)
                 } catch (e: CancellationException) {
                     httpResponse.cancel()
                     return@execute
@@ -1825,6 +1838,8 @@ private suspend fun __handleSseRequest(
                     onOpen = onOpen,
                     onClose = onClose,
                     onData = onData,
+                    onError = onError,
+                    onRequestError = onRequestError,
                     onResponseError = onResponseError,
                 )
             }
@@ -1876,10 +1891,13 @@ private suspend fun __handleSseRequest(
                 onOpen = onOpen,
                 onClose = onClose,
                 onData = onData,
+                onError = onError,
+                onRequestError = onRequestError,
                 onResponseError = onResponseError,
             )
         }
     } catch (e: java.net.ConnectException) {
+        onError(e)
         onRequestError(e)
         return __handleSseRequest(
             httpClient = httpClient,
@@ -1894,9 +1912,12 @@ private suspend fun __handleSseRequest(
             onOpen = onOpen,
             onClose = onClose,
             onData = onData,
+            onError = onError,
+            onRequestError = onRequestError,
             onResponseError = onResponseError,
         )
     } catch (e: Exception) {
+        onError(e)
         onRequestError(e)
         return __handleSseRequest(
             httpClient = httpClient,
@@ -1911,6 +1932,8 @@ private suspend fun __handleSseRequest(
             onOpen = onOpen,
             onClose = onClose,
             onData = onData,
+            onError = onError,
+            onRequestError = onRequestError,
             onResponseError = onResponseError,
         )
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrirpc/codegen-kotlin",
-  "version": "0.67.0",
+  "version": "0.68.0",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -22,6 +22,6 @@
     "dist"
   ],
   "dependencies": {
-    "@arrirpc/codegen-utils": "0.67.0"
+    "@arrirpc/codegen-utils": "0.68.0"
   }
 }