@f3liz/rescript-autogen-openapi 0.1.7 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of @f3liz/rescript-autogen-openapi might be problematic. Click here for more details.

@@ -16,13 +16,27 @@ let applyConstraints = (base, min, max, toString) => {
16
16
  }
17
17
  }
18
18
 
19
- let rec generateSchemaWithContext = (~ctx: GenerationContext.t, ~depth=0, irType: SchemaIR.irType): string => {
19
+ // When extractedTypeMap is provided, complex inline types reference extracted schemas instead of regenerating
20
+ let rec generateSchemaWithContext = (~ctx: GenerationContext.t, ~depth=0, ~extractedTypeMap: option<array<GenerationContext.extractedType>>=?, irType: SchemaIR.irType): string => {
20
21
  // We keep a high depth limit just to prevent infinite recursion on circular schemas that escaped IRBuilder
21
22
  if depth > 100 {
22
23
  addWarning(ctx, DepthLimitReached({depth, path: ctx.path}))
23
24
  "S.json"
24
25
  } else {
25
- let recurse = nextIrType => generateSchemaWithContext(~ctx, ~depth=depth + 1, nextIrType)
26
+ let recurse = nextIrType => generateSchemaWithContext(~ctx, ~depth=depth + 1, ~extractedTypeMap?, nextIrType)
27
+
28
+ // Check if this irType was extracted — if so, reference the schema by name
29
+ let foundExtracted = switch extractedTypeMap {
30
+ | Some(extracted) =>
31
+ extracted->Array.find(({irType: extractedIr}: GenerationContext.extractedType) =>
32
+ SchemaIR.equals(extractedIr, irType)
33
+ )
34
+ | None => None
35
+ }
36
+
37
+ switch foundExtracted {
38
+ | Some({typeName}) => `${typeName}Schema`
39
+ | None =>
26
40
 
27
41
  switch irType {
28
42
  | String({constraints: c}) =>
@@ -43,7 +57,7 @@ let rec generateSchemaWithContext = (~ctx: GenerationContext.t, ~depth=0, irType
43
57
  if Array.length(properties) == 0 {
44
58
  switch additionalProperties {
45
59
  | Some(valueType) => `S.dict(${recurse(valueType)})`
46
- | None => "S.json"
60
+ | None => "S.dict(S.json)"
47
61
  }
48
62
  } else {
49
63
  let fields =
@@ -51,9 +65,18 @@ let rec generateSchemaWithContext = (~ctx: GenerationContext.t, ~depth=0, irType
51
65
  ->Array.map(((name, fieldType, isRequired)) => {
52
66
  let schemaCode = recurse(fieldType)
53
67
  let camelName = name->CodegenUtils.toCamelCase->CodegenUtils.escapeKeyword
54
- isRequired
55
- ? ` ${camelName}: s.field("${name}", ${schemaCode}),`
56
- : ` ${camelName}: s.fieldOr("${name}", S.nullableAsOption(${schemaCode}), None),`
68
+ let alreadyNullable = String.startsWith(schemaCode, "S.nullableAsOption(") || switch fieldType {
69
+ | Option(_) => true
70
+ | Union(types) => types->Array.some(t => switch t { | Null | Literal(NullLiteral) => true | _ => false })
71
+ | _ => false
72
+ }
73
+ if isRequired {
74
+ ` ${camelName}: s.field("${name}", ${schemaCode}),`
75
+ } else if alreadyNullable {
76
+ ` ${camelName}: s.fieldOr("${name}", ${schemaCode}, None),`
77
+ } else {
78
+ ` ${camelName}: s.fieldOr("${name}", S.nullableAsOption(${schemaCode}), None),`
79
+ }
57
80
  })
58
81
  ->Array.join("\n")
59
82
  `S.object(s => {\n${fields}\n })`
@@ -66,40 +89,116 @@ let rec generateSchemaWithContext = (~ctx: GenerationContext.t, ~depth=0, irType
66
89
  | NullLiteral => "S.literal(null)"
67
90
  }
68
91
  | Union(types) =>
69
- let (hasArray, hasNonArray, arrayItemType, nonArrayType) = types->Array.reduce(
70
- (false, false, None, None),
71
- ((hArr, hNonArr, arrItem, nonArr), t) =>
72
- switch t {
73
- | Array({items}) => (true, hNonArr, Some(items), nonArr)
74
- | _ => (hArr, true, arrItem, Some(t))
75
- },
92
+ // Separate Null from non-null members (handles OpenAPI 3.1 nullable via oneOf)
93
+ let nonNullTypes = types->Array.filter(t =>
94
+ switch t {
95
+ | Null | Literal(NullLiteral) => false
96
+ | _ => true
97
+ }
76
98
  )
77
- if (
78
- hasArray &&
79
- hasNonArray &&
80
- SchemaIR.equals(Option.getOr(arrayItemType, Unknown), Option.getOr(nonArrayType, Unknown))
81
- ) {
82
- `S.array(${recurse(Option.getOr(arrayItemType, Unknown))})`
83
- } else if (
84
- types->Array.every(t =>
85
- switch t {
86
- | Literal(StringLiteral(_)) => true
87
- | _ => false
88
- }
89
- ) &&
90
- Array.length(types) > 0 &&
91
- Array.length(types) <= 50
92
- ) {
93
- `S.union([${types->Array.map(recurse)->Array.join(", ")}])`
99
+ let hasNull = Array.length(nonNullTypes) < Array.length(types)
100
+
101
+ // If the union is just [T, null], treat as nullable
102
+ if hasNull && Array.length(nonNullTypes) == 1 {
103
+ `S.nullableAsOption(${recurse(nonNullTypes->Array.getUnsafe(0))})`
94
104
  } else {
95
- addWarning(
96
- ctx,
97
- ComplexUnionSimplified({
98
- location: ctx.path,
99
- types: types->Array.map(SchemaIR.toString)->Array.join(" | "),
100
- }),
105
+ let effectiveTypes = hasNull ? nonNullTypes : types
106
+
107
+ let (hasArray, hasNonArray, arrayItemType, nonArrayType) = effectiveTypes->Array.reduce(
108
+ (false, false, None, None),
109
+ ((hArr, hNonArr, arrItem, nonArr), t) =>
110
+ switch t {
111
+ | Array({items}) => (true, hNonArr, Some(items), nonArr)
112
+ | _ => (hArr, true, arrItem, Some(t))
113
+ },
101
114
  )
102
- "S.json"
115
+
116
+ let result = if (
117
+ hasArray &&
118
+ hasNonArray &&
119
+ Array.length(effectiveTypes) == 2 &&
120
+ SchemaIR.equals(Option.getOr(arrayItemType, Unknown), Option.getOr(nonArrayType, Unknown))
121
+ ) {
122
+ `S.array(${recurse(Option.getOr(arrayItemType, Unknown))})`
123
+ } else if (
124
+ effectiveTypes->Array.every(t =>
125
+ switch t {
126
+ | Literal(StringLiteral(_)) => true
127
+ | _ => false
128
+ }
129
+ ) &&
130
+ Array.length(effectiveTypes) > 0 &&
131
+ Array.length(effectiveTypes) <= 50
132
+ ) {
133
+ `S.union([${effectiveTypes->Array.map(recurse)->Array.join(", ")}])`
134
+ } else if Array.length(effectiveTypes) > 0 {
135
+ // Check if @unboxed variant is valid (same logic as type generator)
136
+ let canUnbox = {
137
+ let runtimeKinds: Dict.t<int> = Dict.make()
138
+ effectiveTypes->Array.forEach(t => {
139
+ let kind = switch t {
140
+ | Boolean | Literal(BooleanLiteral(_)) => "boolean"
141
+ | String(_) | Literal(StringLiteral(_)) => "string"
142
+ | Number(_) | Integer(_) | Literal(NumberLiteral(_)) => "number"
143
+ | Array(_) => "array"
144
+ | Object(_) | Reference(_) | Intersection(_) => "object"
145
+ | Null | Literal(NullLiteral) => "null"
146
+ | _ => "unknown"
147
+ }
148
+ let count = runtimeKinds->Dict.get(kind)->Option.getOr(0)
149
+ runtimeKinds->Dict.set(kind, count + 1)
150
+ })
151
+ Dict.valuesToArray(runtimeKinds)->Array.every(count => count <= 1)
152
+ }
153
+
154
+ if canUnbox {
155
+ // @unboxed variant with S.union + S.shape
156
+ let rawNames = effectiveTypes->Array.map(CodegenUtils.variantConstructorName)
157
+ let names = CodegenUtils.deduplicateNames(rawNames)
158
+
159
+ let branches = effectiveTypes->Array.mapWithIndex((memberType, i) => {
160
+ let constructorName = names->Array.getUnsafe(i)
161
+ switch memberType {
162
+ | Object({properties, additionalProperties}) =>
163
+ if Array.length(properties) == 0 {
164
+ switch additionalProperties {
165
+ | Some(valueType) => `S.dict(${recurse(valueType)})->S.shape(v => ${constructorName}(v))`
166
+ | None => `S.dict(S.json)->S.shape(v => ${constructorName}(v))`
167
+ }
168
+ } else {
169
+ let fields = properties->Array.map(((name, fieldType, isRequired)) => {
170
+ let schemaCode = recurse(fieldType)
171
+ let camelName = name->CodegenUtils.toCamelCase->CodegenUtils.escapeKeyword
172
+ let alreadyNullable = String.startsWith(schemaCode, "S.nullableAsOption(") || switch fieldType {
173
+ | Option(_) => true
174
+ | Union(unionTypes) => unionTypes->Array.some(t => switch t { | Null | Literal(NullLiteral) => true | _ => false })
175
+ | _ => false
176
+ }
177
+ if isRequired {
178
+ ` ${camelName}: s.field("${name}", ${schemaCode}),`
179
+ } else if alreadyNullable {
180
+ ` ${camelName}: s.fieldOr("${name}", ${schemaCode}, None),`
181
+ } else {
182
+ ` ${camelName}: s.fieldOr("${name}", S.nullableAsOption(${schemaCode}), None),`
183
+ }
184
+ })->Array.join("\n")
185
+ `S.object(s => ${constructorName}({\n${fields}\n }))`
186
+ }
187
+ | _ =>
188
+ let innerSchema = recurse(memberType)
189
+ `${innerSchema}->S.shape(v => ${constructorName}(v))`
190
+ }
191
+ })
192
+ `S.union([${branches->Array.join(", ")}])`
193
+ } else {
194
+ // Can't use @unboxed: pick last schema (matching type gen)
195
+ recurse(effectiveTypes->Array.getUnsafe(Array.length(effectiveTypes) - 1))
196
+ }
197
+ } else {
198
+ "S.json"
199
+ }
200
+
201
+ hasNull ? `S.nullableAsOption(${result})` : result
103
202
  }
104
203
  | Intersection(types) =>
105
204
  if types->Array.every(t =>
@@ -110,43 +209,110 @@ let rec generateSchemaWithContext = (~ctx: GenerationContext.t, ~depth=0, irType
110
209
  ) && Array.length(types) > 0 {
111
210
  recurse(types->Array.get(Array.length(types) - 1)->Option.getOr(Unknown))
112
211
  } else {
113
- addWarning(
114
- ctx,
115
- IntersectionNotFullySupported({location: ctx.path, note: "Complex intersection"}),
212
+ // Try to merge all Object types in the intersection
213
+ let (objectProps, nonObjectTypes) = types->Array.reduce(
214
+ ([], []),
215
+ ((props, nonObj), t) =>
216
+ switch t {
217
+ | Object({properties}) => (Array.concat(props, properties), nonObj)
218
+ | _ => (props, Array.concat(nonObj, [t]))
219
+ },
116
220
  )
117
- "S.json"
221
+ if Array.length(objectProps) > 0 && Array.length(nonObjectTypes) == 0 {
222
+ // All objects: merge properties into single S.object
223
+ let fields =
224
+ objectProps
225
+ ->Array.map(((name, fieldType, isRequired)) => {
226
+ let schemaCode = recurse(fieldType)
227
+ let camelName = name->CodegenUtils.toCamelCase->CodegenUtils.escapeKeyword
228
+ let alreadyNullable = String.startsWith(schemaCode, "S.nullableAsOption(") || switch fieldType {
229
+ | Option(_) => true
230
+ | Union(types) => types->Array.some(t => switch t { | Null | Literal(NullLiteral) => true | _ => false })
231
+ | _ => false
232
+ }
233
+ if isRequired {
234
+ ` ${camelName}: s.field("${name}", ${schemaCode}),`
235
+ } else if alreadyNullable {
236
+ ` ${camelName}: s.fieldOr("${name}", ${schemaCode}, None),`
237
+ } else {
238
+ ` ${camelName}: s.fieldOr("${name}", S.nullableAsOption(${schemaCode}), None),`
239
+ }
240
+ })
241
+ ->Array.join("\n")
242
+ `S.object(s => {\n${fields}\n })`
243
+ } else if Array.length(nonObjectTypes) > 0 && Array.length(objectProps) == 0 {
244
+ recurse(types->Array.get(Array.length(types) - 1)->Option.getOr(Unknown))
245
+ } else {
246
+ addWarning(
247
+ ctx,
248
+ IntersectionNotFullySupported({location: ctx.path, note: "Mixed object/non-object intersection"}),
249
+ )
250
+ let fields =
251
+ objectProps
252
+ ->Array.map(((name, fieldType, isRequired)) => {
253
+ let schemaCode = recurse(fieldType)
254
+ let camelName = name->CodegenUtils.toCamelCase->CodegenUtils.escapeKeyword
255
+ let alreadyNullable = String.startsWith(schemaCode, "S.nullableAsOption(") || switch fieldType {
256
+ | Option(_) => true
257
+ | Union(types) => types->Array.some(t => switch t { | Null | Literal(NullLiteral) => true | _ => false })
258
+ | _ => false
259
+ }
260
+ if isRequired {
261
+ ` ${camelName}: s.field("${name}", ${schemaCode}),`
262
+ } else if alreadyNullable {
263
+ ` ${camelName}: s.fieldOr("${name}", ${schemaCode}, None),`
264
+ } else {
265
+ ` ${camelName}: s.fieldOr("${name}", S.nullableAsOption(${schemaCode}), None),`
266
+ }
267
+ })
268
+ ->Array.join("\n")
269
+ `S.object(s => {\n${fields}\n })`
270
+ }
118
271
  }
119
272
  | Reference(ref) =>
120
- let schemaPath = switch ctx.availableSchemas {
121
- | Some(available) =>
122
- let name =
123
- ref
124
- ->String.split("/")
125
- ->Array.get(ref->String.split("/")->Array.length - 1)
126
- ->Option.getOr("")
127
- available->Array.includes(name)
128
- ? `${CodegenUtils.toPascalCase(name)}.schema`
129
- : `ComponentSchemas.${CodegenUtils.toPascalCase(name)}.schema`
130
- | None =>
131
- ReferenceResolver.refToSchemaPath(
132
- ~insideComponentSchemas=ctx.insideComponentSchemas,
133
- ~modulePrefix=ctx.modulePrefix,
134
- ref,
135
- )->Option.getOr("S.json")
273
+ // After IR normalization, ref may be just the schema name
274
+ let refName = if ref->String.includes("/") {
275
+ ref->String.split("/")->Array.get(ref->String.split("/")->Array.length - 1)->Option.getOr("")
276
+ } else {
277
+ ref
136
278
  }
137
- if schemaPath == "S.json" {
138
- addWarning(
139
- ctx,
140
- FallbackToJson({
141
- reason: `Unresolved ref: ${ref}`,
142
- context: {path: ctx.path, operation: "gen ref", schema: None},
143
- }),
144
- )
279
+
280
+ // Detect self-reference using selfRefName from context
281
+ let isSelfRef = switch ctx.selfRefName {
282
+ | Some(selfName) => refName == selfName
283
+ | None => false
284
+ }
285
+
286
+ if isSelfRef {
287
+ "schema" // Self-reference: use the recursive schema binding
288
+ } else {
289
+ let schemaPath = switch ctx.availableSchemas {
290
+ | Some(available) =>
291
+ available->Array.includes(refName)
292
+ ? `${CodegenUtils.toPascalCase(refName)}.schema`
293
+ : `ComponentSchemas.${CodegenUtils.toPascalCase(refName)}.schema`
294
+ | None =>
295
+ ReferenceResolver.refToSchemaPath(
296
+ ~insideComponentSchemas=ctx.insideComponentSchemas,
297
+ ~modulePrefix=ctx.modulePrefix,
298
+ ref,
299
+ )->Option.getOr("S.json")
300
+ }
301
+ if schemaPath == "S.json" {
302
+ addWarning(
303
+ ctx,
304
+ FallbackToJson({
305
+ reason: `Unresolved ref: ${ref}`,
306
+ context: {path: ctx.path, operation: "gen ref", schema: None},
307
+ }),
308
+ )
309
+ }
310
+ schemaPath
145
311
  }
146
- schemaPath
147
312
  | Option(inner) => `S.nullableAsOption(${recurse(inner)})`
148
313
  | Unknown => "S.json"
149
314
  }
315
+ } // end switch foundExtracted
150
316
  }
151
317
  }
152
318
 
@@ -167,6 +333,7 @@ let generateNamedSchema = (
167
333
  ~insideComponentSchemas=false,
168
334
  ~availableSchemas=?,
169
335
  ~modulePrefix="",
336
+ ~extractedTypes: array<GenerationContext.extractedType>=[],
170
337
  ) => {
171
338
  let ctx = GenerationContext.make(
172
339
  ~path=`schema.${namedSchema.name}`,
@@ -179,8 +346,28 @@ let generateNamedSchema = (
179
346
  | Some(d) => CodegenUtils.generateDocComment(~description=d, ())
180
347
  | None => ""
181
348
  }
349
+ let extractedTypeMap = if Array.length(extractedTypes) > 0 { Some(extractedTypes) } else { None }
350
+ let mainSchema = generateSchemaWithContext(~ctx, ~depth=0, ~extractedTypeMap?, namedSchema.type_)
351
+
352
+ // Generate schemas for extracted auxiliary types
353
+ // Exclude the type being generated from the map to avoid self-reference
354
+ let extractedDefs = extractedTypes->Array.map(({typeName, irType}: GenerationContext.extractedType) => {
355
+ let auxCtx = GenerationContext.make(
356
+ ~path=`schema.${typeName}`,
357
+ ~insideComponentSchemas,
358
+ ~availableSchemas?,
359
+ ~modulePrefix,
360
+ (),
361
+ )
362
+ let filteredMap = extractedTypes->Array.filter(({typeName: tn}: GenerationContext.extractedType) => tn != typeName)
363
+ let auxExtractedTypeMap = if Array.length(filteredMap) > 0 { Some(filteredMap) } else { None }
364
+ let auxSchema = generateSchemaWithContext(~ctx=auxCtx, ~depth=0, ~extractedTypeMap=?auxExtractedTypeMap, irType)
365
+ `let ${typeName}Schema = ${auxSchema}`
366
+ })
367
+
368
+ let allDefs = Array.concat(extractedDefs, [`${doc}let ${namedSchema.name}Schema = ${mainSchema}`])
182
369
  (
183
- `${doc}let ${namedSchema.name}Schema = ${generateSchemaWithContext(~ctx, ~depth=0, namedSchema.type_)}`,
370
+ allDefs->Array.join("\n\n"),
184
371
  ctx.warnings,
185
372
  )
186
373
  }