foobara-typescript-remote-command-generator 1.1.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f320bbabd5ddca46562061c2824136049cdb2527db04dcc12a158faacf976ee
-  data.tar.gz: 0dd1e7ede3eb687061654c2a69be0e666558aaac109ad6965cb1d48b23f6e996
+  metadata.gz: 9f783af32070cfcdc33c70d34c1b755a66a0a6bb3df7b7e8697345bdc1d148f7
+  data.tar.gz: fdcfa71700d34b3c42163b586fc2f8cb1c90f420bef3fb76f7a8a5a8d29e6423
 SHA512:
-  metadata.gz: dfe94127bf3d4b42b0846282b3a036a6c7eee1769bd3c06c4b522984ac8ee4556b220471e3da023340d9b60821624f839e629d7609d37d4d51c83b0076a90d46
-  data.tar.gz: 41e09f9b71898e73eeb2e8afc94f49aa909e37d8defc7f44454669471c9b925b130f3790e41338d1c23cfd5c2a71582a9e9a0ece77f1f0ba9250def19297950f
+  metadata.gz: b5b5d35cc80f88622f2a4ea321574a7af55e9c61ec7bde32d42761a9d9511af07ced97894f4905962bb1803c1871d9a8ab4c9c83722df5caefffe7342b90e474
+  data.tar.gz: 6d0a1fcb787dc719a330bd58953d42e387f931b35a2eb3d6168ab0d0dfbdec166a1f2215339ea7046b3edfc00473365cdca75e6846408014ed96a3f04d6ef3d8

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [1.2.0] - 2025-11-06
+
+- If an attribute isn't required but has a default, it will have a non-required create
+  interface but a required read interface. This updates the types to reflect that for
+  convenience to avoid pointless null checks.
+
 ## [1.1.7] - 2025-11-02
 
 - Make CommandCastResultGenerator's interpretation of atom? match other generators

data/src/remote_generator/services/type_generator.rb

@@ -120,17 +120,29 @@ module Foobara
 
         def attributes_type_ts_type
           association_depth = AssociationDepth::AMBIGUOUS
-          foobara_type_to_ts_type(attributes_type, association_depth:, dependency_group:)
+          foobara_type_to_ts_type(attributes_type,
+                                  association_depth:,
+                                  dependency_group:,
+                                  is_output: true,
+                                  parent: relevant_manifest)
         end
 
         def atom_attributes_ts_type
           association_depth = AssociationDepth::ATOM
-          foobara_type_to_ts_type(attributes_type, association_depth:, dependency_group:)
+          foobara_type_to_ts_type(attributes_type,
+                                  association_depth:,
+                                  dependency_group:,
+                                  is_output: true,
+                                  parent: relevant_manifest)
         end
 
         def aggregate_attributes_ts_type
           association_depth = AssociationDepth::AGGREGATE
-          foobara_type_to_ts_type(attributes_type, association_depth:, dependency_group:)
+          foobara_type_to_ts_type(attributes_type,
+                                  association_depth:,
+                                  dependency_group:,
+                                  is_output: true,
+                                  parent: relevant_manifest)
         end
 
         def attribute_names

data/src/remote_generator/services/typescript_from_manifest_base_generator.rb

@@ -194,14 +194,19 @@ module Foobara
           end
         end
 
-        # TODO: relocate this to a more reusable place
+        # is_output means the value came from elsewhere and is fully formed.
+        # This is helpful for specifying what is expected to be present. If this is provided,
+        # then things like attribute properties that have defaults will be considered
+        # required and present.
         def foobara_type_to_ts_type(
           type_declaration,
           dependency_group: self.dependency_group,
           name: nil,
           association_depth: AssociationDepth::AMBIGUOUS,
           initial: true,
-          model_and_entity_free: false
+          model_and_entity_free: false,
+          is_output: false,
+          parent: nil
         )
           if type_declaration.is_a?(Manifest::Error)
             error_generator = generator_for(type_declaration)
@@ -213,7 +218,9 @@ module Foobara
                             type_declaration,
                             association_depth:,
                             dependency_group:,
-                            model_and_entity_free:
+                            model_and_entity_free:,
+                            is_output:,
+                            parent:
                           )
 
                           if type_declaration.has_attribute_declarations?
@@ -241,7 +248,8 @@ module Foobara
                             association_depth:,
                             dependency_group:,
                             initial: false,
-                            model_and_entity_free:
+                            model_and_entity_free:,
+                            is_output:
                           )
                           "#{ts_type}[]"
                         else
@@ -275,7 +283,9 @@ module Foobara
                                   association_depth:,
                                   dependency_group:,
                                   initial:,
-                                  model_and_entity_free:
+                                  model_and_entity_free:,
+                                  is_output:,
+                                  parent: model_type
                                 )
                               else
                                 model_to_ts_model_name(type_declaration, association_depth:, initial:)
@@ -310,20 +320,34 @@ module Foobara
           attributes,
           dependency_group:,
           association_depth: AssociationDepth::AMBIGUOUS,
-          model_and_entity_free: false
+          model_and_entity_free: false,
+          is_output: false,
+          parent: nil
         )
           # TODO: if we don't actually have attribute_declarations because we
           # are trying to express attributes of any type, then we want Record<string, any>
           # or something.
           if attributes.has_attribute_declarations?
             guts = attributes.attribute_declarations.map do |attribute_name, attribute_declaration|
-              "  #{attribute_name}#{"?" unless attributes.required?(attribute_name)}: #{
+              is_required = attributes.required?(attribute_name)
+
+              if !is_required && is_output
+                default = attributes.default_for(attribute_name)
+
+                if default || default == false ||
+                   (parent&.detached_entity? && attribute_name == parent.primary_key_name.to_sym)
+                  is_required = true
+                end
+              end
+
+              "  #{attribute_name}#{"?" unless is_required}: #{
               foobara_type_to_ts_type(
                 attribute_declaration,
                 dependency_group:,
                 association_depth:,
                 initial: false,
-                model_and_entity_free:
+                model_and_entity_free:,
+                is_output:
               )
             }"
             end.join("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara-typescript-remote-command-generator
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.2.0
 platform: ruby
 authors:
 - Miles Georgi