@arrirpc/codegen-dart 0.58.0 → 0.58.1

package/dist/index.cjs

@@ -167,6 +167,25 @@ function getDartClassName(schema, context) {
     context.modelPrefix
   );
 }
+function getCodeComments(metadata, leading) {
+  if (!metadata?.description && !metadata?.isDeprecated)
+    return "";
+  if (!metadata.description && metadata.isDeprecated) {
+    return `${leading ?? ""}@deprecated
+`;
+  }
+  const descriptionString = metadata.description?.split("\n").map((line) => `${leading ?? ""}/// ${line}`).join("\n");
+  if (descriptionString && metadata.isDeprecated) {
+    return `${descriptionString}
+${leading ?? ""}@deprecated
+`;
+  }
+  if (descriptionString) {
+    return `${descriptionString}
+`;
+  }
+  return "";
+}
 
 function dartAnyFromSchema(schema, context) {
   const typeName = `dynamic`;
@@ -305,7 +324,12 @@ function dartClassFromSchema(schema, context) {
     });
     const propName = validDartIdentifier(key);
     propNames.push(propName);
-    fieldParts.push(`  final ${typeResult.typeName} ${propName};`);
+    fieldParts.push(
+      `${getCodeComments(
+        innerSchema.metadata,
+        "  "
+      )}  final ${typeResult.typeName} ${propName};`
+    );
     constructorParts.push(`    required this.${propName},`);
     defaultParts.push(`      ${propName}: ${typeResult.defaultValue},`);
     fromJsonParts.push(
@@ -348,7 +372,9 @@ function dartClassFromSchema(schema, context) {
     });
     const propName = validDartIdentifier(key);
     propNames.push(propName);
-    fieldParts.push(`  final ${typeResult.typeName} ${propName};`);
+    fieldParts.push(
+      `${getCodeComments(innerSchema.metadata, "  ")}  final ${typeResult.typeName} ${propName};`
+    );
     constructorParts.push(`    this.${propName},`);
     fromJsonParts.push(
       `    final ${propName} = ${typeResult.fromJson(`_input_["${key}"]`, key)};`
@@ -376,7 +402,7 @@ function dartClassFromSchema(schema, context) {
     String get ${validDartIdentifier(context.discriminatorKey)} => "${context.discriminatorValue}";
 `;
   }
-  result.content = `class ${finalClassName} implements ${context.discriminatorParentId ?? "ArriModel"} {
+  result.content = `${getCodeComments(schema.metadata)}class ${finalClassName} implements ${context.discriminatorParentId ?? "ArriModel"} {
 ${fieldParts.join("\n")}
   const ${finalClassName}({
 ${constructorParts.join("\n")}
@@ -803,6 +829,10 @@ function dartRpcFromSchema(schema, context) {
 }
 function dartHttpRpcFromSchema(schema, context) {
   const functionName = getFunctionName(context.instancePath);
+  const metadata = {
+    description: schema.description,
+    isDeprecated: schema.isDeprecated
+  };
   let responseType = "void";
   let paramsType = "";
   if (schema.response) {
@@ -812,7 +842,7 @@ function dartHttpRpcFromSchema(schema, context) {
     paramsType = `${context.modelPrefix}${validDartClassName(schema.params, context.modelPrefix)}`;
   }
   if (schema.isEventStream) {
-    return `EventSource<${responseType}> ${functionName}(
+    return `${getCodeComments(metadata)}EventSource<${responseType}> ${functionName}(
             ${paramsType ? `${paramsType} params, ` : ""} {
             void Function(${responseType} data, EventSource<${responseType}> connection)? onMessage,
             void Function(http.StreamedResponse response, EventSource<${responseType}> connection)? onOpen,
@@ -840,7 +870,7 @@ function dartHttpRpcFromSchema(schema, context) {
             );
         }`;
   }
-  return `Future<${responseType}> ${functionName}(${paramsType ? `${paramsType} params` : ""}) async {
+  return `${getCodeComments(metadata)}Future<${responseType}> ${functionName}(${paramsType ? `${paramsType} params` : ""}) async {
         return parsedArriRequest(
             "$_baseUrl${schema.path}",
             method: HttpMethod.${schema.method.toLowerCase()},
@@ -857,6 +887,10 @@ function getFunctionName(instancePath) {
   return parts.pop() ?? "";
 }
 function dartWsRpcFromSchema(schema, context) {
+  const metadata = {
+    description: schema.description,
+    isDeprecated: schema.isDeprecated
+  };
   const functionName = getFunctionName(context.instancePath);
   let responseType;
   let paramsType;
@@ -866,7 +900,7 @@ function dartWsRpcFromSchema(schema, context) {
   if (schema.params) {
     paramsType = `${context.modelPrefix}${validDartClassName(schema.params, context.modelPrefix)}`;
   }
-  return `Future<ArriWebsocketController<${responseType ?? "void"}, ${paramsType ?? "void"}>> ${functionName}() {
+  return `${getCodeComments(metadata)}Future<ArriWebsocketController<${responseType ?? "void"}, ${paramsType ?? "void"}>> ${functionName}() {
         return arriWebsocketRequest(
             "$_baseUrl${schema.path}",
             headers: _headers,

package/dist/index.mjs

@@ -160,6 +160,25 @@ function getDartClassName(schema, context) {
     context.modelPrefix
   );
 }
+function getCodeComments(metadata, leading) {
+  if (!metadata?.description && !metadata?.isDeprecated)
+    return "";
+  if (!metadata.description && metadata.isDeprecated) {
+    return `${leading ?? ""}@deprecated
+`;
+  }
+  const descriptionString = metadata.description?.split("\n").map((line) => `${leading ?? ""}/// ${line}`).join("\n");
+  if (descriptionString && metadata.isDeprecated) {
+    return `${descriptionString}
+${leading ?? ""}@deprecated
+`;
+  }
+  if (descriptionString) {
+    return `${descriptionString}
+`;
+  }
+  return "";
+}
 
 function dartAnyFromSchema(schema, context) {
   const typeName = `dynamic`;
@@ -298,7 +317,12 @@ function dartClassFromSchema(schema, context) {
     });
     const propName = validDartIdentifier(key);
     propNames.push(propName);
-    fieldParts.push(`  final ${typeResult.typeName} ${propName};`);
+    fieldParts.push(
+      `${getCodeComments(
+        innerSchema.metadata,
+        "  "
+      )}  final ${typeResult.typeName} ${propName};`
+    );
     constructorParts.push(`    required this.${propName},`);
     defaultParts.push(`      ${propName}: ${typeResult.defaultValue},`);
     fromJsonParts.push(
@@ -341,7 +365,9 @@ function dartClassFromSchema(schema, context) {
     });
     const propName = validDartIdentifier(key);
     propNames.push(propName);
-    fieldParts.push(`  final ${typeResult.typeName} ${propName};`);
+    fieldParts.push(
+      `${getCodeComments(innerSchema.metadata, "  ")}  final ${typeResult.typeName} ${propName};`
+    );
     constructorParts.push(`    this.${propName},`);
     fromJsonParts.push(
       `    final ${propName} = ${typeResult.fromJson(`_input_["${key}"]`, key)};`
@@ -369,7 +395,7 @@ function dartClassFromSchema(schema, context) {
     String get ${validDartIdentifier(context.discriminatorKey)} => "${context.discriminatorValue}";
 `;
   }
-  result.content = `class ${finalClassName} implements ${context.discriminatorParentId ?? "ArriModel"} {
+  result.content = `${getCodeComments(schema.metadata)}class ${finalClassName} implements ${context.discriminatorParentId ?? "ArriModel"} {
 ${fieldParts.join("\n")}
   const ${finalClassName}({
 ${constructorParts.join("\n")}
@@ -796,6 +822,10 @@ function dartRpcFromSchema(schema, context) {
 }
 function dartHttpRpcFromSchema(schema, context) {
   const functionName = getFunctionName(context.instancePath);
+  const metadata = {
+    description: schema.description,
+    isDeprecated: schema.isDeprecated
+  };
   let responseType = "void";
   let paramsType = "";
   if (schema.response) {
@@ -805,7 +835,7 @@ function dartHttpRpcFromSchema(schema, context) {
     paramsType = `${context.modelPrefix}${validDartClassName(schema.params, context.modelPrefix)}`;
   }
   if (schema.isEventStream) {
-    return `EventSource<${responseType}> ${functionName}(
+    return `${getCodeComments(metadata)}EventSource<${responseType}> ${functionName}(
             ${paramsType ? `${paramsType} params, ` : ""} {
             void Function(${responseType} data, EventSource<${responseType}> connection)? onMessage,
             void Function(http.StreamedResponse response, EventSource<${responseType}> connection)? onOpen,
@@ -833,7 +863,7 @@ function dartHttpRpcFromSchema(schema, context) {
             );
         }`;
   }
-  return `Future<${responseType}> ${functionName}(${paramsType ? `${paramsType} params` : ""}) async {
+  return `${getCodeComments(metadata)}Future<${responseType}> ${functionName}(${paramsType ? `${paramsType} params` : ""}) async {
         return parsedArriRequest(
             "$_baseUrl${schema.path}",
             method: HttpMethod.${schema.method.toLowerCase()},
@@ -850,6 +880,10 @@ function getFunctionName(instancePath) {
   return parts.pop() ?? "";
 }
 function dartWsRpcFromSchema(schema, context) {
+  const metadata = {
+    description: schema.description,
+    isDeprecated: schema.isDeprecated
+  };
   const functionName = getFunctionName(context.instancePath);
   let responseType;
   let paramsType;
@@ -859,7 +893,7 @@ function dartWsRpcFromSchema(schema, context) {
   if (schema.params) {
     paramsType = `${context.modelPrefix}${validDartClassName(schema.params, context.modelPrefix)}`;
   }
-  return `Future<ArriWebsocketController<${responseType ?? "void"}, ${paramsType ?? "void"}>> ${functionName}() {
+  return `${getCodeComments(metadata)}Future<ArriWebsocketController<${responseType ?? "void"}, ${paramsType ?? "void"}>> ${functionName}() {
         return arriWebsocketRequest(
             "$_baseUrl${schema.path}",
             headers: _headers,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrirpc/codegen-dart",
-  "version": "0.58.0",
+  "version": "0.58.1",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -23,7 +23,7 @@
   ],
   "dependencies": {
     "pathe": "^1.1.2",
-    "@arrirpc/codegen-utils": "0.58.0",
-    "@arrirpc/schema": "0.58.0"
+    "@arrirpc/codegen-utils": "0.58.1",
+    "@arrirpc/schema": "0.58.1"
   }
 }