@team-supercharge/oasg 19.0.0 → 19.0.1

package/README.md

@@ -1195,6 +1195,26 @@ Validations from OpenAPI spec:
 | apiKey              | Api key of nuget source (If not specified, provide the CI_JOB_TOKEN)           | N        | -       |
 | generatorCustomArgs | Custom arguments of the generator (--global-property, --additional-properties) | N        | -       |
 
+> **Nullable object/enum references.** A property spec'd nullable as a
+> reference to a named schema — `nullable: true` alongside a `$ref` (OpenAPI
+> 3.0, typically via an `allOf` wrapper) or `oneOf: [$ref, {type: 'null'}]`
+> (OpenAPI 3.1) — now generates a nullable C# type (`Category?`), matching the
+> TypeScript targets' `Category | null`, regardless of whether the property is
+> `required`: `required` only governs presence of the key, never nullness of
+> the value. Previously only *optional, non-nullable* references got a `?`;
+> nullable references (required or not) silently generated a non-nullable
+> type, forcing consumers to suppress with `null!` and losing the compiler's
+> null-reference warnings at the point of use.
+>
+> Nullable **containers** (arrays, maps) are unaffected by this change and
+> still generate a non-nullable collection type.
+>
+> This applies to the `dotnet`, `dotnet-webapi` and
+> `dotnet-webapi-system-text-json` targets. `dotnet-system-text-json`
+> (`generichost`) already handled this correctly. To opt out entirely, disable
+> nullable reference types via `generatorCustomArgs`:
+> `--additional-properties=nullableReferenceTypes=false`.
+
 #### `dotnet-system-text-json`
 
 An AOT-oriented C# **client library**. Unlike `dotnet` (which uses the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "19.0.0",
+  "version": "19.0.1",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",

package/targets/dotnet/templates/model.mustache

@@ -0,0 +1,165 @@
+{{>partial_header}}
+using System;
+using System.Linq;
+using System.Text;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.ComponentModel.DataAnnotations;
+using System.Runtime.Serialization;
+using Newtonsoft.Json;
+using {{packageName}}.Converters;
+{{#models}}
+{{#model}}
+{{/model}}
+{{/models}}
+
+{{#models}}
+{{#model}}
+namespace {{modelPackage}}
+{ {{#isEnum}}{{>enumClass}}{{/isEnum}}{{^isEnum}}
+    /// <summary>
+    /// {{description}}
+    /// </summary>
+    [DataContract]
+    public {{#modelClassModifier}}{{.}} {{/modelClassModifier}}class {{classname}} : {{#parent}}{{{.}}}, {{/parent}}IEquatable<{{classname}}>
+    {
+        {{#vars}}
+        {{#items.isEnum}}
+        {{#items}}
+        {{^complexType}}
+{{>enumClass}}
+        {{/complexType}}
+        {{/items}}
+        {{/items.isEnum}}
+        {{^items.isEnum}}
+        {{#isEnum}}
+        {{^complexType}}
+{{>enumClass}}
+        {{/complexType}}
+        {{/isEnum}}
+        {{/items.isEnum}}
+        /// <summary>
+        /// {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}}
+        /// </summary>{{#description}}
+        /// <value>{{.}}</value>{{/description}}{{#required}}
+        [Required]{{/required}}{{#pattern}}
+        [RegularExpression("{{{.}}}")]{{/pattern}}{{#minLength}}{{#maxLength}}
+        [StringLength({{maxLength}}, MinimumLength={{minLength}})]{{/maxLength}}{{/minLength}}{{#minLength}}{{^maxLength}}
+        [MinLength({{minLength}})]{{/maxLength}}{{/minLength}}{{^minLength}}{{#maxLength}}
+        [MaxLength({{.}})]{{/maxLength}}{{/minLength}}{{#minimum}}{{#maximum}}
+        [Range({{minimum}}, {{maximum}})]{{/maximum}}{{/minimum}}
+        [DataMember(Name="{{baseName}}", EmitDefaultValue={{#isNullable}}true{{/isNullable}}{{^isNullable}}false{{/isNullable}})]
+        {{#isEnum}}
+        public {{{datatypeWithEnum}}}{{#isNullable}}?{{/isNullable}} {{name}} { get; set; }{{#defaultValue}} = {{{.}}};{{/defaultValue}}
+        {{/isEnum}}
+        {{^isEnum}}
+        {{! this generator never appends a question mark to dataType for a nullable object/model
+            ref (only for primitives in its hardcoded nullable-type list), so the isModel-guarded
+            branch below adds it back. isModel is never set for a primitive, so this cannot
+            produce a double question mark. Nullable containers are intentionally left non-null
+            (out of scope), matching the other .NET targets in this repo. }}
+        public {{{dataType}}}{{#nullableReferenceTypes}}{{#isNullable}}{{#isModel}}?{{/isModel}}{{/isNullable}}{{/nullableReferenceTypes}} {{name}} { get; {{#isReadOnly}}private {{/isReadOnly}}set; }{{#defaultValue}} = {{{.}}};{{/defaultValue}}
+        {{/isEnum}}
+        {{^-last}}
+
+        {{/-last}}
+        {{/vars}}
+
+        /// <summary>
+        /// Returns the string presentation of the object
+        /// </summary>
+        /// <returns>String presentation of the object</returns>
+        public override string ToString()
+        {
+            var sb = new StringBuilder();
+            sb.Append("class {{classname}} {\n");
+            {{#vars}}
+            sb.Append("  {{name}}: ").Append({{name}}).Append("\n");
+            {{/vars}}
+            sb.Append("}\n");
+            return sb.ToString();
+        }
+
+        /// <summary>
+        /// Returns the JSON string presentation of the object
+        /// </summary>
+        /// <returns>JSON string presentation of the object</returns>
+        public {{#parent}}{{^isMap}}{{^isArray}}new {{/isArray}}{{/isMap}}{{/parent}}string ToJson()
+        {
+            return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented);
+        }
+
+        /// <summary>
+        /// Returns true if objects are equal
+        /// </summary>
+        /// <param name="obj">Object to be compared</param>
+        /// <returns>Boolean</returns>
+        public override bool Equals(object obj)
+        {
+            if (obj is null) return false;
+            if (ReferenceEquals(this, obj)) return true;
+            return obj.GetType() == GetType() && Equals(({{classname}})obj);
+        }
+
+        /// <summary>
+        /// Returns true if {{classname}} instances are equal
+        /// </summary>
+        /// <param name="other">Instance of {{classname}} to be compared</param>
+        /// <returns>Boolean</returns>
+        public bool Equals({{classname}} other)
+        {
+            if (other is null) return false;
+            if (ReferenceEquals(this, other)) return true;
+
+            return {{#vars}}{{^isContainer}}
+                (
+                    {{name}} == other.{{name}} ||
+                    {{^vendorExtensions.x-is-value-type}}{{name}} != null &&{{/vendorExtensions.x-is-value-type}}
+                    {{name}}.Equals(other.{{name}})
+                ){{^-last}} && {{/-last}}{{/isContainer}}{{#isContainer}}
+                (
+                    {{name}} == other.{{name}} ||
+                    {{^vendorExtensions.x-is-value-type}}{{name}} != null &&
+                    other.{{name}} != null &&
+                    {{/vendorExtensions.x-is-value-type}}{{name}}.SequenceEqual(other.{{name}})
+                ){{^-last}} && {{/-last}}{{/isContainer}}{{/vars}}{{^vars}}false{{/vars}};
+        }
+
+        /// <summary>
+        /// Gets the hash code
+        /// </summary>
+        /// <returns>Hash code</returns>
+        public override int GetHashCode()
+        {
+            unchecked // Overflow is fine, just wrap
+            {
+                var hashCode = 41;
+                // Suitable nullity checks etc, of course :)
+                {{#vars}}
+                    {{^vendorExtensions.x-is-value-type}}if ({{name}} != null){{/vendorExtensions.x-is-value-type}}
+                    hashCode = hashCode * 59 + {{name}}.GetHashCode();
+                {{/vars}}
+                return hashCode;
+            }
+        }
+
+        #region Operators
+        #pragma warning disable 1591
+
+        public static bool operator ==({{classname}} left, {{classname}} right)
+        {
+            return Equals(left, right);
+        }
+
+        public static bool operator !=({{classname}} left, {{classname}} right)
+        {
+            return !Equals(left, right);
+        }
+
+        #pragma warning restore 1591
+        #endregion Operators
+    }
+{{/isEnum}}
+{{/model}}
+{{/models}}
+}

package/targets/dotnet-webapi/templates/model.mustache

@@ -79,7 +79,12 @@ namespace {{modelPackage}}
         public {{{datatypeWithEnum}}}{{#isNullable}}{{^required}}?{{/required}}{{/isNullable}} {{name}} { get; set; }{{#defaultValue}} = {{{.}}};{{/defaultValue}}
         {{/isEnum}}
         {{^isEnum}}
-        public {{{dataType}}}{{#nullableReferenceTypes}}{{^isContainer}}{{^required}}{{^isNullable}}?{{/isNullable}}{{/required}}{{/isContainer}}{{/nullableReferenceTypes}} {{name}} { get; set; }{{#defaultValue}} = {{{.}}};{{/defaultValue}}
+        {{! nullable object/model refs get no question mark from the generator's dataType, unlike
+            primitives whose dataType already carries one -- so the isModel-guarded branch below
+            adds it back for those. isModel is only set for refs to named schemas, never for a
+            primitive whose dataType is already nullable, so this cannot produce a double question
+            mark. Nullable containers are intentionally left non-nullable (out of scope). }}
+        public {{{dataType}}}{{#nullableReferenceTypes}}{{^isContainer}}{{^required}}{{^isNullable}}?{{/isNullable}}{{/required}}{{#isNullable}}{{#isModel}}?{{/isModel}}{{/isNullable}}{{/isContainer}}{{/nullableReferenceTypes}} {{name}} { get; set; }{{#defaultValue}} = {{{.}}};{{/defaultValue}}
         {{/isEnum}}
         {{^-last}}
 

package/targets/dotnet-webapi-system-text-json/templates/model.mustache

@@ -79,7 +79,12 @@ namespace {{modelPackage}}
         public {{{datatypeWithEnum}}}{{#isNullable}}{{^required}}?{{/required}}{{/isNullable}} {{name}} { get; set; }{{#defaultValue}} = {{{.}}};{{/defaultValue}}
         {{/isEnum}}
         {{^isEnum}}
-        public {{{dataType}}}{{#nullableReferenceTypes}}{{^isContainer}}{{^required}}{{^isNullable}}?{{/isNullable}}{{/required}}{{/isContainer}}{{/nullableReferenceTypes}} {{name}} { get; set; }{{#defaultValue}} = {{{.}}};{{/defaultValue}}
+        {{! nullable object/model refs get no question mark from the generator's dataType, unlike
+            primitives whose dataType already carries one -- so the isModel-guarded branch below
+            adds it back for those. isModel is only set for refs to named schemas, never for a
+            primitive whose dataType is already nullable, so this cannot produce a double question
+            mark. Nullable containers are intentionally left non-nullable (out of scope). }}
+        public {{{dataType}}}{{#nullableReferenceTypes}}{{^isContainer}}{{^required}}{{^isNullable}}?{{/isNullable}}{{/required}}{{#isNullable}}{{#isModel}}?{{/isModel}}{{/isNullable}}{{/isContainer}}{{/nullableReferenceTypes}} {{name}} { get; set; }{{#defaultValue}} = {{{.}}};{{/defaultValue}}
         {{/isEnum}}
         {{^-last}}