@amritk/generate-validators 0.4.0 → 0.4.1

package/dist/index.js

@@ -675,6 +675,31 @@ var getUnbrandedType = (schema, options = {}) => {
     case "object":
       if (schema.properties) {
         const readonlyPrefix = options.readonly ? "readonly " : "";
+        const hasDescriptions = Object.values(schema.properties).some((p) => isSchemaObject2(p) && (typeof p.description === "string" || typeof p.$comment === "string"));
+        if (hasDescriptions) {
+          let properties2 = "";
+          let first2 = true;
+          for (const key in schema.properties) {
+            const propSchema = schema.properties[key];
+            const isRequired = schema.required?.includes(key) ?? false;
+            const optional = isRequired ? "" : "?";
+            const propType = getTypeScriptType(propSchema, options);
+            const inlineDescription = isSchemaObject2(propSchema) && typeof propSchema.description === "string" ? propSchema.description : isSchemaObject2(propSchema) && typeof propSchema.$comment === "string" ? propSchema.$comment : undefined;
+            if (!first2)
+              properties2 += `
+`;
+            first2 = false;
+            if (inlineDescription) {
+              properties2 += "  /** " + inlineDescription + ` */
+  ` + readonlyPrefix + safeKey(key) + optional + ": " + propType + ";";
+            } else {
+              properties2 += "  " + readonlyPrefix + safeKey(key) + optional + ": " + propType + ";";
+            }
+          }
+          return `{
+` + properties2 + `
+}`;
+        }
         let properties = "";
         let first = true;
         for (const key in schema.properties) {
@@ -716,8 +741,9 @@ var generateTypeDefinition = (schema, typeName, options = {}) => {
   if (!isObjectLikeSchema(schema)) {
     const tsType = getTypeScriptType(schema, options);
     let result = "";
-    if (isSchemaObject2(schema) && schema.$comment && typeof schema.$comment === "string") {
-      result += buildJsDocBlock(typeName, schema.$comment);
+    const topLevelComment = isSchemaObject2(schema) && typeof schema.description === "string" && schema.description || isSchemaObject2(schema) && typeof schema.$comment === "string" && schema.$comment || undefined;
+    if (topLevelComment) {
+      result += buildJsDocBlock(typeName, topLevelComment);
     }
     result += `export type ${typeName} = ${tsType};`;
     return result;
@@ -728,9 +754,10 @@ var generateTypeDefinition = (schema, typeName, options = {}) => {
     const conditionalThenRef = conditionalResult?.thenRef ?? null;
     let jsDocTitle;
     let jsDocDescription;
-    if (isSchemaObject2(schema) && schema.$comment && typeof schema.$comment === "string") {
+    const topLevelComment = isSchemaObject2(schema) && typeof schema.description === "string" && schema.description || isSchemaObject2(schema) && typeof schema.$comment === "string" && schema.$comment || undefined;
+    if (topLevelComment) {
       jsDocTitle = typeName;
-      jsDocDescription = schema.$comment;
+      jsDocDescription = topLevelComment;
     }
     const hasProperties2 = normalizedSchema.properties && Object.keys(normalizedSchema.properties).length > 0;
     const hasAdditionalProperties2 = normalizedSchema.additionalProperties && typeof normalizedSchema.additionalProperties === "object";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amritk/generate-validators",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Generate TypeScript validation functions from JSON Schemas.",
   "module": "./dist/index.js",
   "type": "module",
@@ -47,7 +47,7 @@
   },
   "dependencies": {
     "json-schema-typed": "^8.0.1",
-    "@amritk/helpers": "0.6.0"
+    "@amritk/helpers": "0.6.1"
   },
   "devDependencies": {
     "@scalar/openapi-parser": "^0.26.1"