fix: optional quoted attributes

Author: mattkhan

jsonapi-resources-anchor.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 3.1"
   s.add_dependency("jsonapi-resources", "~> 0.1")
-  s.add_dependency("rails", ">= 7.0")
+  s.add_dependency("rails", "~> 7.0")
   s.add_development_dependency("rspec-rails", "~> 7.0")
   s.add_development_dependency("yard")
   s.add_development_dependency("yard-activesupport-concern")

lib/anchor/type_script/serializer.rb

@@ -49,7 +49,7 @@ def serialize_object(type, depth)
       def safe_name(property)
         name = property.name
         if name.match?(/[^a-zA-Z0-9_]/)
-          "\"#{name}\""
+          "\"#{name}\"" + (property.optional ? "?" : "")
         else
           name.to_s + (property.optional ? "?" : "")
         end

spec/example/app/resources/exhaustive_resource.rb

@@ -2,6 +2,7 @@ class ExhaustiveResource < ApplicationResource
   class AssertedObject < Types::Object
     property :a, Types::Literal.new("a")
     property "b-dash", Types::Literal.new(1)
+    property "optional-dash", Types::Literal.new(1), optional: true
     property :c, Types::Maybe.new(Types::String)
     property :d_optional, Types::Maybe.new(Types::String), optional: true
   end

spec/example/test/files/all_fields_false_schema.ts

@@ -49,12 +49,14 @@ export type Exhaustive = {
   assertedObject: {
     a: "a";
     "b-dash": 1;
+    "optional-dash"?: 1;
     c: Maybe<string>;
     d_optional?: Maybe<string>;
   };
   assertedMaybeObject: Maybe<{
     a: "a";
     "b-dash": 1;
+    "optional-dash"?: 1;
     c: Maybe<string>;
     d_optional?: Maybe<string>;
   }>;

spec/example/test/files/json_schema.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft-07/schema","title":"Schema","type":"object","properties":{"comment":{"$ref":"#/$defs/Comment"},"user":{"$ref":"#/$defs/User"},"post":{"$ref":"#/$defs/Post"},"exhaustive":{"$ref":"#/$defs/Exhaustive"}},"required":["comment","user","post","exhaustive"],"additionalProperties":false,"$defs":{"Comment":{"type":"object","properties":{"id":{"type":"number"},"type":{"enum":["comments"]},"text":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"relationships":{"type":"object","properties":{"user":{"$ref":"#/$defs/User"},"deletedBy":{"$ref":"#/$defs/User"},"commentable":{"oneOf":[{"$ref":"#/$defs/Post"}]}},"required":["user"],"additionalProperties":false}},"required":["id","type","text","createdAt","updatedAt","relationships"],"additionalProperties":false},"User":{"type":"object","properties":{"id":{"type":"number"},"type":{"enum":["users"]},"name":{"type":"string"},"role":{"enum":[{"value":"admin"},{"value":"content_creator"},{"value":"external"},{"value":"guest"},{"value":"system"}]},"relationships":{"type":"object","properties":{"comments":{"type":"array","items":{"$ref":"#/$defs/Comment"}},"posts":{"type":"array","items":{"$ref":"#/$defs/Post"}}},"required":["comments","posts"],"additionalProperties":false}},"required":["id","type","name","role","relationships"],"additionalProperties":false},"Post":{"type":"object","properties":{"id":{"type":"number"},"type":{"enum":["posts"]},"description":{"type":"string"},"relationships":{"type":"object","properties":{"user":{"$ref":"#/$defs/User"},"comments":{"type":"array","items":{"$ref":"#/$defs/Comment"}},"participants":{"type":"array","items":{"$ref":"#/$defs/User"}}},"required":["user","comments","participants"],"additionalProperties":false}},"required":["id","type","description","relationships"],"additionalProperties":false},"Exhaustive":{"type":"object","properties":{"id":{"type":"number"},"type":{"enum":["exhaustives"]},"assertedString":{"type":"string"},"assertedNumber":{"type":"number"},"assertedBoolean":{"type":"boolean"},"assertedNull":{"type":"null"},"assertedUnknown":{},"assertedObject":{"type":"object","properties":{"a":{"enum":["a"]},"b-dash":{"enum":[1]},"c":{"oneOf":[{"type":"string"},{"type":"null"}]},"d_optional":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["a","b-dash","c"],"additionalProperties":false},"assertedMaybeObject":{"oneOf":[{"type":"object","properties":{"a":{"enum":["a"]},"b-dash":{"enum":[1]},"c":{"oneOf":[{"type":"string"},{"type":"null"}]},"d_optional":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["a","b-dash","c"],"additionalProperties":false},{"type":"null"}]},"assertedArrayRecord":{"type":"array","items":{"type":"object","additionalProperties":"true"}},"assertedUnion":{"oneOf":[{"type":"object","properties":{"str":{"type":"string"},"union":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"null"}]},{"enum":[false]},{"type":"boolean"},{},{"type":"number"},{"type":"number"},{"type":"number"},{"type":"array","items":{"type":"number"}},{},{"enum":[2]},{"enum":["union woo"]}]},"array":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]}},"intersection":{},"next":{"type":"object","properties":{"i":{"type":"number"},"f":{"type":"number"}},"required":["i"],"additionalProperties":false}},"required":["str","union","array","intersection","next"],"additionalProperties":false},{"enum":["union"]}]},"assertedUnionArray":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"number"}]}},"withDescription":{"type":"string"},"inferredUnknown":{},"uuid":{"type":"string"},"string":{"type":"string"},"maybeString":{"type":"string"},"text":{"type":"string"},"integer":{"type":"number"},"float":{"type":"number"},"decimal":{"type":"string"},"datetime":{"type":"string"},"timestamp":{"type":"string"},"time":{"type":"string"},"date":{"type":"string"},"boolean":{"type":"boolean"},"arrayString":{"type":"array","items":{"type":"string"}},"maybeArrayString":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"json":{"type":"object","additionalProperties":"true"},"jsonb":{"type":"object","additionalProperties":"true"},"daterange":{},"enum":{"oneOf":[{"enum":["sample"]},{"enum":["enum"]},{"enum":["value"]}]},"virtualUpcasedString":{"oneOf":[{"type":"string"},{"type":"null"}]},"loljk":{"enum":["never"]},"delegatedMaybeString":{"type":"string"},"modelOverridden":{"enum":["model_overridden"]},"resourceOverridden":{"enum":["resource_overridden"]},"withComment":{"oneOf":[{"type":"string"},{"type":"null"}]},"withParsedComment":{"oneOf":[{"type":"string"},{"type":"null"}]},"defaultedBoolean":{"type":"boolean"},"defaultedAt":{"type":"string"}},"required":["id","type","assertedString","assertedNumber","assertedBoolean","assertedNull","assertedUnknown","assertedObject","assertedMaybeObject","assertedArrayRecord","assertedUnion","assertedUnionArray","withDescription","inferredUnknown","uuid","string","maybeString","text","integer","float","decimal","datetime","timestamp","time","date","boolean","arrayString","maybeArrayString","json","jsonb","daterange","enum","virtualUpcasedString","loljk","delegatedMaybeString","modelOverridden","resourceOverridden","withComment","withParsedComment","defaultedBoolean","defaultedAt"],"additionalProperties":false}}}
+{"$schema":"https://json-schema.org/draft-07/schema","title":"Schema","type":"object","properties":{"comment":{"$ref":"#/$defs/Comment"},"user":{"$ref":"#/$defs/User"},"post":{"$ref":"#/$defs/Post"},"exhaustive":{"$ref":"#/$defs/Exhaustive"}},"required":["comment","user","post","exhaustive"],"additionalProperties":false,"$defs":{"Comment":{"type":"object","properties":{"id":{"type":"number"},"type":{"enum":["comments"]},"text":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"relationships":{"type":"object","properties":{"user":{"$ref":"#/$defs/User"},"deletedBy":{"$ref":"#/$defs/User"},"commentable":{"oneOf":[{"$ref":"#/$defs/Post"}]}},"required":["user"],"additionalProperties":false}},"required":["id","type","text","createdAt","updatedAt","relationships"],"additionalProperties":false},"User":{"type":"object","properties":{"id":{"type":"number"},"type":{"enum":["users"]},"name":{"type":"string"},"role":{"enum":[{"value":"admin"},{"value":"content_creator"},{"value":"external"},{"value":"guest"},{"value":"system"}]},"relationships":{"type":"object","properties":{"comments":{"type":"array","items":{"$ref":"#/$defs/Comment"}},"posts":{"type":"array","items":{"$ref":"#/$defs/Post"}}},"required":["comments","posts"],"additionalProperties":false}},"required":["id","type","name","role","relationships"],"additionalProperties":false},"Post":{"type":"object","properties":{"id":{"type":"number"},"type":{"enum":["posts"]},"description":{"type":"string"},"relationships":{"type":"object","properties":{"user":{"$ref":"#/$defs/User"},"comments":{"type":"array","items":{"$ref":"#/$defs/Comment"}},"participants":{"type":"array","items":{"$ref":"#/$defs/User"}}},"required":["user","comments","participants"],"additionalProperties":false}},"required":["id","type","description","relationships"],"additionalProperties":false},"Exhaustive":{"type":"object","properties":{"id":{"type":"number"},"type":{"enum":["exhaustives"]},"assertedString":{"type":"string"},"assertedNumber":{"type":"number"},"assertedBoolean":{"type":"boolean"},"assertedNull":{"type":"null"},"assertedUnknown":{},"assertedObject":{"type":"object","properties":{"a":{"enum":["a"]},"b-dash":{"enum":[1]},"optional-dash":{"enum":[1]},"c":{"oneOf":[{"type":"string"},{"type":"null"}]},"d_optional":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["a","b-dash","c"],"additionalProperties":false},"assertedMaybeObject":{"oneOf":[{"type":"object","properties":{"a":{"enum":["a"]},"b-dash":{"enum":[1]},"optional-dash":{"enum":[1]},"c":{"oneOf":[{"type":"string"},{"type":"null"}]},"d_optional":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["a","b-dash","c"],"additionalProperties":false},{"type":"null"}]},"assertedArrayRecord":{"type":"array","items":{"type":"object","additionalProperties":"true"}},"assertedUnion":{"oneOf":[{"type":"object","properties":{"str":{"type":"string"},"union":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"null"}]},{"enum":[false]},{"type":"boolean"},{},{"type":"number"},{"type":"number"},{"type":"number"},{"type":"array","items":{"type":"number"}},{},{"enum":[2]},{"enum":["union woo"]}]},"array":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]}},"intersection":{},"next":{"type":"object","properties":{"i":{"type":"number"},"f":{"type":"number"}},"required":["i"],"additionalProperties":false}},"required":["str","union","array","intersection","next"],"additionalProperties":false},{"enum":["union"]}]},"assertedUnionArray":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"number"}]}},"withDescription":{"type":"string"},"inferredUnknown":{},"uuid":{"type":"string"},"string":{"type":"string"},"maybeString":{"type":"string"},"text":{"type":"string"},"integer":{"type":"number"},"float":{"type":"number"},"decimal":{"type":"string"},"datetime":{"type":"string"},"timestamp":{"type":"string"},"time":{"type":"string"},"date":{"type":"string"},"boolean":{"type":"boolean"},"arrayString":{"type":"array","items":{"type":"string"}},"maybeArrayString":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"json":{"type":"object","additionalProperties":"true"},"jsonb":{"type":"object","additionalProperties":"true"},"daterange":{},"enum":{"oneOf":[{"enum":["sample"]},{"enum":["enum"]},{"enum":["value"]}]},"virtualUpcasedString":{"oneOf":[{"type":"string"},{"type":"null"}]},"loljk":{"enum":["never"]},"delegatedMaybeString":{"type":"string"},"modelOverridden":{"enum":["model_overridden"]},"resourceOverridden":{"enum":["resource_overridden"]},"withComment":{"oneOf":[{"type":"string"},{"type":"null"}]},"withParsedComment":{"oneOf":[{"type":"string"},{"type":"null"}]},"defaultedBoolean":{"type":"boolean"},"defaultedAt":{"type":"string"}},"required":["id","type","assertedString","assertedNumber","assertedBoolean","assertedNull","assertedUnknown","assertedObject","assertedMaybeObject","assertedArrayRecord","assertedUnion","assertedUnionArray","withDescription","inferredUnknown","uuid","string","maybeString","text","integer","float","decimal","datetime","timestamp","time","date","boolean","arrayString","maybeArrayString","json","jsonb","daterange","enum","virtualUpcasedString","loljk","delegatedMaybeString","modelOverridden","resourceOverridden","withComment","withParsedComment","defaultedBoolean","defaultedAt"],"additionalProperties":false}}}

spec/example/test/files/multifile/Exhaustive.ts

@@ -14,12 +14,14 @@ type Model = {
   assertedObject: {
     a: "a";
     "b-dash": 1;
+    "optional-dash"?: 1;
     c: Maybe<string>;
     d_optional?: Maybe<string>;
   };
   assertedMaybeObject: Maybe<{
     a: "a";
     "b-dash": 1;
+    "optional-dash"?: 1;
     c: Maybe<string>;
     d_optional?: Maybe<string>;
   }>;

spec/example/test/files/multifile/hash.json

@@ -1 +1 @@
-{"shared.ts":"e42275c1453e00f368131821b3e4de915d6c5c789a8fc5c72967ddf8c31ad77b","Comment.ts":"fec6ae5197b65afe3fed510a393b7819e288f33366bc34aca1622833c5030ba6","User.ts":"ce80524eb520622e37af4aa9a2b35e49a50cb80bf4ea9921e818631e8a541738","Post.ts":"74d50a09806ff7496c168f2b9b4d6cea64111f42f38effa12464e5ad933c1303","Exhaustive.ts":"90b8a564e9a34ff49ff1bb02d8d3d6bb4f4eb1d518284eeddfaabd364daf70c8"}
+{"shared.ts":"e42275c1453e00f368131821b3e4de915d6c5c789a8fc5c72967ddf8c31ad77b","Comment.ts":"fec6ae5197b65afe3fed510a393b7819e288f33366bc34aca1622833c5030ba6","User.ts":"ce80524eb520622e37af4aa9a2b35e49a50cb80bf4ea9921e818631e8a541738","Post.ts":"74d50a09806ff7496c168f2b9b4d6cea64111f42f38effa12464e5ad933c1303","Exhaustive.ts":"bdd0ae0dc91474dc8fd52a8a7144a38df63e6d80d92bf8d801c7bb6cfe15fb0a"}

spec/example/test/files/schema.ts

@@ -56,12 +56,14 @@ export type Exhaustive = {
   assertedObject: {
     a: "a";
     "b-dash": 1;
+    "optional-dash"?: 1;
     c: Maybe<string>;
     d_optional?: Maybe<string>;
   };
   assertedMaybeObject: Maybe<{
     a: "a";
     "b-dash": 1;
+    "optional-dash"?: 1;
     c: Maybe<string>;
     d_optional?: Maybe<string>;
   }>;

spec/example/test/files/test_schema.ts

@@ -53,12 +53,14 @@ export type Exhaustive = {
   assertedObject: {
     a: "a";
     "b-dash": 1;
+    "optional-dash"?: 1;
     c: Maybe<string>;
     d_optional?: Maybe<string>;
   };
   assertedMaybeObject: Maybe<{
     a: "a";
     "b-dash": 1;
+    "optional-dash"?: 1;
     c: Maybe<string>;
     d_optional?: Maybe<string>;
   }>;