@arrirpc/codegen-kotlin 0.58.0 → 0.59.0

package/dist/index.cjs

@@ -102,6 +102,29 @@ function instanceDepth(context) {
 function isNullable(schema, context) {
   return schema.nullable === true || context.isOptional === true;
 }
+function getCodeComment(metadata, prefix, valueField) {
+  if (!metadata?.description && !metadata?.isDeprecated)
+    return "";
+  const descriptionPart = metadata.description?.split("\n").map((line) => `${prefix ?? ""}* ${line}`).join("\n");
+  const finalDescription = metadata.description ? `${prefix ?? ""}/**
+${descriptionPart}${prefix ?? ""}
+*/` : "";
+  const deprecationMessage = `@Deprecated(message = "This ${valueField ?? "item"} was marked as deprecated by the server")`;
+  if (metadata.description && metadata.isDeprecated) {
+    return `${finalDescription}
+${deprecationMessage}
+`;
+  }
+  if (metadata.isDeprecated) {
+    return `${deprecationMessage}
+`;
+  }
+  if (metadata.description) {
+    return `${finalDescription}
+`;
+  }
+  return "";
+}
 
 function kotlinAnyFromSchema(schema, context) {
   const nullable = isNullable(schema, context);
@@ -237,7 +260,6 @@ function kotlinObjectFromSchema(schema, context) {
                         ${input}!!,
                         "$instancePath/${key}",
                     )
-                    
                     else -> null
                 }`;
       }
@@ -302,7 +324,7 @@ function kotlinObjectFromSchema(schema, context) {
       subContent.push(type.content);
     }
     fieldParts.push(
-      `    val ${kotlinKey}: ${type.typeName}${type.isNullable ? "?" : ""},`
+      `${getCodeComment(prop.metadata, "    ", "field")}    val ${kotlinKey}: ${type.typeName}${type.isNullable ? "?" : ""},`
     );
     if (i === 0 && !context.discriminatorKey) {
       toJsonParts.push(`output += "\\"${key}\\":"`);
@@ -339,7 +361,9 @@ function kotlinObjectFromSchema(schema, context) {
     const addCommaPart = isFirst ? "" : `
         if (hasProperties) output += ","
 `;
-    fieldParts.push(`    val ${kotlinKey}: ${type.typeName}? = null,`);
+    fieldParts.push(
+      `${getCodeComment(schema.optionalProperties[key].metadata, "    ", "field")}    val ${kotlinKey}: ${type.typeName}? = null,`
+    );
     if (hasKnownKeys) {
       toJsonParts.push(`if (${kotlinKey} != null) {
                 output += ",\\"${key}\\":"
@@ -367,7 +391,7 @@ ${isLast ? "" : "    hasProperties = true"}
     override val ${kotlinIdentifier(context.discriminatorKey)} get() = "${context.discriminatorValue}"
 `;
   }
-  const content = `data class ${className}(
+  const content = `${getCodeComment(schema.metadata, "", "class")}data class ${className}(
 ${fieldParts.join("\n")}
 ) : ${implementedClass} {${discriminatorField}
     override fun toJson(): String {
@@ -471,7 +495,8 @@ function kotlinDiscriminatorFromSchema(schema, context) {
   if (context.existingTypeIds.includes(className)) {
     return result;
   }
-  const content = `sealed interface ${className} : ${context.clientName}Model {
+  const codeComment = getCodeComment(schema.metadata, "", "class");
+  const content = `${codeComment}sealed interface ${className} : ${context.clientName}Model {
     val ${kotlinDiscriminatorKey}: String
 
     companion object Factory : ${context.clientName}ModelFactory<${className}> {
@@ -1106,8 +1131,16 @@ function kotlinHttpRpcFromSchema(schema, context) {
   const name = getProcedureName(context);
   const params = schema.params ? kotlinClassName(`${context.modelPrefix}_${schema.params}`) : void 0;
   const response = schema.response ? kotlinClassName(`${context.modelPrefix}_${schema.response}`) : void 0;
+  const codeComment = getCodeComment(
+    {
+      description: schema.description,
+      isDeprecated: schema.isDeprecated
+    },
+    "",
+    "method"
+  );
   if (schema.isEventStream) {
-    return `fun ${name}(
+    return `${codeComment}fun ${name}(
             scope: CoroutineScope,
             ${params ? `params: ${params},` : ""}
             lastEventId: String? = null,
@@ -1151,7 +1184,7 @@ function kotlinHttpRpcFromSchema(schema, context) {
                 stack = null,
             )
         }`;
-  return `suspend fun ${name}(${params ? `params: ${params}` : ""}): ${response ?? "Unit"} {
+  return `${codeComment}suspend fun ${name}(${params ? `params: ${params}` : ""}): ${response ?? "Unit"} {
         val response = __prepareRequest(
             client = httpClient,
             url = "$baseUrl${schema.path}",

package/dist/index.mjs

@@ -96,6 +96,29 @@ function instanceDepth(context) {
 function isNullable(schema, context) {
   return schema.nullable === true || context.isOptional === true;
 }
+function getCodeComment(metadata, prefix, valueField) {
+  if (!metadata?.description && !metadata?.isDeprecated)
+    return "";
+  const descriptionPart = metadata.description?.split("\n").map((line) => `${prefix ?? ""}* ${line}`).join("\n");
+  const finalDescription = metadata.description ? `${prefix ?? ""}/**
+${descriptionPart}${prefix ?? ""}
+*/` : "";
+  const deprecationMessage = `@Deprecated(message = "This ${valueField ?? "item"} was marked as deprecated by the server")`;
+  if (metadata.description && metadata.isDeprecated) {
+    return `${finalDescription}
+${deprecationMessage}
+`;
+  }
+  if (metadata.isDeprecated) {
+    return `${deprecationMessage}
+`;
+  }
+  if (metadata.description) {
+    return `${finalDescription}
+`;
+  }
+  return "";
+}
 
 function kotlinAnyFromSchema(schema, context) {
   const nullable = isNullable(schema, context);
@@ -231,7 +254,6 @@ function kotlinObjectFromSchema(schema, context) {
                         ${input}!!,
                         "$instancePath/${key}",
                     )
-                    
                     else -> null
                 }`;
       }
@@ -296,7 +318,7 @@ function kotlinObjectFromSchema(schema, context) {
       subContent.push(type.content);
     }
     fieldParts.push(
-      `    val ${kotlinKey}: ${type.typeName}${type.isNullable ? "?" : ""},`
+      `${getCodeComment(prop.metadata, "    ", "field")}    val ${kotlinKey}: ${type.typeName}${type.isNullable ? "?" : ""},`
     );
     if (i === 0 && !context.discriminatorKey) {
       toJsonParts.push(`output += "\\"${key}\\":"`);
@@ -333,7 +355,9 @@ function kotlinObjectFromSchema(schema, context) {
     const addCommaPart = isFirst ? "" : `
         if (hasProperties) output += ","
 `;
-    fieldParts.push(`    val ${kotlinKey}: ${type.typeName}? = null,`);
+    fieldParts.push(
+      `${getCodeComment(schema.optionalProperties[key].metadata, "    ", "field")}    val ${kotlinKey}: ${type.typeName}? = null,`
+    );
     if (hasKnownKeys) {
       toJsonParts.push(`if (${kotlinKey} != null) {
                 output += ",\\"${key}\\":"
@@ -361,7 +385,7 @@ ${isLast ? "" : "    hasProperties = true"}
     override val ${kotlinIdentifier(context.discriminatorKey)} get() = "${context.discriminatorValue}"
 `;
   }
-  const content = `data class ${className}(
+  const content = `${getCodeComment(schema.metadata, "", "class")}data class ${className}(
 ${fieldParts.join("\n")}
 ) : ${implementedClass} {${discriminatorField}
     override fun toJson(): String {
@@ -465,7 +489,8 @@ function kotlinDiscriminatorFromSchema(schema, context) {
   if (context.existingTypeIds.includes(className)) {
     return result;
   }
-  const content = `sealed interface ${className} : ${context.clientName}Model {
+  const codeComment = getCodeComment(schema.metadata, "", "class");
+  const content = `${codeComment}sealed interface ${className} : ${context.clientName}Model {
     val ${kotlinDiscriminatorKey}: String
 
     companion object Factory : ${context.clientName}ModelFactory<${className}> {
@@ -1100,8 +1125,16 @@ function kotlinHttpRpcFromSchema(schema, context) {
   const name = getProcedureName(context);
   const params = schema.params ? kotlinClassName(`${context.modelPrefix}_${schema.params}`) : void 0;
   const response = schema.response ? kotlinClassName(`${context.modelPrefix}_${schema.response}`) : void 0;
+  const codeComment = getCodeComment(
+    {
+      description: schema.description,
+      isDeprecated: schema.isDeprecated
+    },
+    "",
+    "method"
+  );
   if (schema.isEventStream) {
-    return `fun ${name}(
+    return `${codeComment}fun ${name}(
             scope: CoroutineScope,
             ${params ? `params: ${params},` : ""}
             lastEventId: String? = null,
@@ -1145,7 +1178,7 @@ function kotlinHttpRpcFromSchema(schema, context) {
                 stack = null,
             )
         }`;
-  return `suspend fun ${name}(${params ? `params: ${params}` : ""}): ${response ?? "Unit"} {
+  return `${codeComment}suspend fun ${name}(${params ? `params: ${params}` : ""}): ${response ?? "Unit"} {
         val response = __prepareRequest(
             client = httpClient,
             url = "$baseUrl${schema.path}",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrirpc/codegen-kotlin",
-  "version": "0.58.0",
+  "version": "0.59.0",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -22,8 +22,8 @@
     "dist"
   ],
   "dependencies": {
-    "@arrirpc/codegen-utils": "0.58.0",
-    "@arrirpc/schema": "0.58.0",
-    "json-schema-to-jtd": "0.58.0"
+    "@arrirpc/codegen-utils": "0.59.0",
+    "@arrirpc/schema": "0.59.0",
+    "json-schema-to-jtd": "0.59.0"
   }
 }