osury 0.3.0 → 0.5.0

package/README.md

@@ -11,6 +11,7 @@ Generate ReScript types with [Sury](https://github.com/DZakh/sury) schemas from
 - Automatic deduplication of identical union structures
 - Generates `module S = Sury` alias (required by sury-ppx)
 - Generates `Dict.gen.tsx` shim for TypeScript interop
+- Proper JSON `null` support via `@s.nullable option<T>` PPX attribute
 
 ## Installation
 
@@ -23,12 +24,12 @@ npm install -D osury
 ### CLI
 
 ```bash
-# Generate to default ./Generated.res + ./Dict.gen.tsx
+# Generate to default ./Generated.res + shims
 npx osury openapi.json
 
 # Generate to specific directory
 npx osury openapi.json src/API.res
-# Creates: src/API.res + src/Dict.gen.tsx
+# Creates: src/API.res, src/Dict.gen.tsx
 
 # With explicit output flag
 npx osury generate openapi.json -o src/Schema.res
@@ -78,7 +79,7 @@ type user = {
 }
 ```
 
-Also generates `Dict.gen.tsx`:
+Also generates `Dict.gen.tsx` shim for TypeScript:
 ```typescript
 export type t<T> = { [key: string]: T };
 ```
@@ -111,7 +112,7 @@ For the generated code to compile, your project needs:
 | `array` | `array<T>` |
 | `object` | `{ field: T }` |
 | `$ref` | type reference |
-| `anyOf` (nullable) | `option<T>` |
+| `anyOf` (nullable) | `@s.nullable option<T>` |
 | `anyOf` (union) | variant type |
 | `oneOf` (tagged) | poly variant |
 | `additionalProperties` | `Dict.t<T>` |

package/bin/osury.mjs

@@ -87,7 +87,7 @@ function generate(inputPath, outputPath) {
     fs.writeFileSync(dictShimPath, Codegen.generateDictShim());
 
     console.log(`Generated ${result._0.length} types to ${outputPath}`);
-    console.log(`Generated Dict shim to ${dictShimPath}`);
+    console.log(`Generated shim: ${dictShimPath}`);
   } else {
     console.error("Parse errors:");
     result._0.forEach((err) => {

package/package.json

@@ -2,7 +2,7 @@
   "name": "osury",
   "type": "module",
   "description": "Generate ReScript types with Sury schemas from OpenAPI specifications",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "license": "MIT",
   "bin": {
     "osury": "./bin/osury.mjs"

package/src/Codegen.res.mjs

@@ -95,6 +95,7 @@ function generateType(schema) {
   } else {
     switch (schema._tag) {
       case "Optional" :
+      case "Nullable" :
         return `option<` + generateType(schema._0) + `>`;
       case "Object" :
         return generateRecord(schema._0);
@@ -116,10 +117,23 @@ function generateType(schema) {
 }
 
 function isOptionalType(schema) {
+  if (typeof schema !== "object") {
+    return false;
+  }
+  switch (schema._tag) {
+    case "Optional" :
+    case "Nullable" :
+      return true;
+    default:
+      return false;
+  }
+}
+
+function isNullableType(schema) {
   if (typeof schema !== "object") {
     return false;
   } else {
-    return schema._tag === "Optional";
+    return schema._tag === "Nullable";
   }
 }
 
@@ -130,11 +144,10 @@ function generateRecord(fields) {
   let fieldStrs = fields.map(field => {
     let typeStr = generateType(field.type);
     let optionalType = field.required || isOptionalType(field.type) ? typeStr : `option<` + typeStr + `>`;
-    if (reservedKeywords.includes(field.name)) {
-      return `@as("` + field.name + `") ` + field.name + `_: ` + optionalType;
-    } else {
-      return field.name + `: ` + optionalType;
-    }
+    let nullableAttr = isNullableType(field.type) ? "@s.nullable " : "";
+    let asAttr = reservedKeywords.includes(field.name) ? `@as("` + field.name + `") ` : "";
+    let fieldName = reservedKeywords.includes(field.name) ? field.name + `_` : field.name;
+    return nullableAttr + asAttr + fieldName + `: ` + optionalType;
   });
   return `{\n  ` + fieldStrs.join(",\n  ") + `\n}`;
 }
@@ -174,6 +187,8 @@ function getTagForType(t) {
     switch (t._tag) {
       case "Optional" :
         return `Option` + getTagForType(t._0);
+      case "Nullable" :
+        return `Null` + getTagForType(t._0);
       case "Object" :
         return "Object";
       case "Array" :
@@ -213,6 +228,7 @@ function hasUnion(_schema) {
       case "PolyVariant" :
         return schema._0.some(c => hasUnion(c.payload));
       case "Optional" :
+      case "Nullable" :
       case "Array" :
       case "Dict" :
         _schema = schema._0;
@@ -271,6 +287,7 @@ function extractUnionsFromType(_schema) {
       case "Object" :
         return schema._0.flatMap(field => extractUnionsFromType(field.type));
       case "Optional" :
+      case "Nullable" :
       case "Array" :
       case "Dict" :
         _schema = schema._0;
@@ -307,6 +324,11 @@ function replaceUnionInType(schema) {
         _tag: "Optional",
         _0: replaceUnionInType(schema._0)
       };
+    case "Nullable" :
+      return {
+        _tag: "Nullable",
+        _0: replaceUnionInType(schema._0)
+      };
     case "Object" :
       let newFields = schema._0.map(field => {
         let newType = replaceUnionInType(field.type);
@@ -377,6 +399,7 @@ function getDependencies(_schema) {
       case "PolyVariant" :
         return schema._0.flatMap(c => getDependencies(c.payload));
       case "Optional" :
+      case "Nullable" :
       case "Array" :
       case "Dict" :
         _schema = schema._0;
@@ -563,6 +586,7 @@ export {
   lcFirst,
   generateType,
   isOptionalType,
+  isNullableType,
   generateRecord,
   generatePolyVariant,
   ucFirst,

package/src/Schema.gen.tsx

@@ -18,6 +18,7 @@ export type schemaType =
   | "Boolean"
   | "Null"
   | { _tag: "Optional"; _0: schemaType }
+  | { _tag: "Nullable"; _0: schemaType }
   | { _tag: "Object"; _0: field[] }
   | { _tag: "Array"; _0: schemaType }
   | { _tag: "Ref"; _0: string }

package/src/Schema.res.mjs

@@ -216,7 +216,7 @@ function parseAnyOf(items) {
         return {
           TAG: "Ok",
           _0: {
-            _tag: "Optional",
+            _tag: "Nullable",
             _0: innerType._0
           }
         };
@@ -294,7 +294,7 @@ function parseAnyOf(items) {
   return {
     TAG: "Ok",
     _0: {
-      _tag: "Optional",
+      _tag: "Nullable",
       _0: {
         _tag: "Union",
         _0: types$1