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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f320bbabd5ddca46562061c2824136049cdb2527db04dcc12a158faacf976ee
-  data.tar.gz: 0dd1e7ede3eb687061654c2a69be0e666558aaac109ad6965cb1d48b23f6e996
+  metadata.gz: acd95f1d6e58abba0e5c2498107a8a66d304fe3d79e96247c404c6a7fd55cb46
+  data.tar.gz: fdf0f9918b4c74941322ed5fdf3c750deaf47a1db6a4255475e3c980ec9f0862
 SHA512:
-  metadata.gz: dfe94127bf3d4b42b0846282b3a036a6c7eee1769bd3c06c4b522984ac8ee4556b220471e3da023340d9b60821624f839e629d7609d37d4d51c83b0076a90d46
-  data.tar.gz: 41e09f9b71898e73eeb2e8afc94f49aa909e37d8defc7f44454669471c9b925b130f3790e41338d1c23cfd5c2a71582a9e9a0ece77f1f0ba9250def19297950f
+  metadata.gz: 021b3c0a4c20daa2ba07a563b62aa2cf714e3108cab6d7441f875bbcd2cdee45e68eb5be99c17c0760993e245f065d7f40578c5997b5d0c35a251e590200f8dd
+  data.tar.gz: 27b3915c5fea3ef8770c26d16aff9ff4309cd3f031e4fd4a6bfd61f6fd81191defd7dad6e54e311a37825ade623ae4402b3c946ed1cbc5f99e97a0de9bd18173

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [1.2.1] - 2025-12-19
+
+- Handle some foobara_delegate deprecation warnings
+
+## [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/command_generator.rb

@@ -18,11 +18,13 @@ module Foobara
           @domain_generator ||= Services::DomainGenerator.new(domain)
         end
 
-        foobara_delegate :organization_generator, :domain_name, :organization_name, to: :domain_generator
+        def organization_generator = domain_generator.organization_generator
+        def domain_name = domain_generator.domain_name
+        def organization_name = domain_generator.organization_name
 
         def errors_in_this_namespace
           @errors_in_this_namespace ||= possible_errors.values.map(&:error).uniq.sort_by(&:error_name).select do |error|
-            error.parent&.path&.map(&:to_s) == path.map(&:to_s)
+            error.parent&.manifest_path&.map(&:to_s) == manifest_path.map(&:to_s)
           end.map do |error_manifest|
             Services::ErrorGenerator.new(error_manifest)
           end

data/src/remote_generator/services/domain_generator.rb

@@ -70,7 +70,7 @@ module Foobara
           @organization_generator ||= OrganizationGenerator.new(domain_manifest.organization)
         end
 
-        foobara_delegate :organization_name, to: :organization_generator
+        def organization_name = organization_generator.organization_name
       end
     end
   end

data/src/remote_generator/services/error_generator.rb

@@ -41,7 +41,9 @@ module Foobara
         end
 
         def context_type_declaration
-          @context_type_declaration ||= Manifest::TypeDeclaration.new(root_manifest, [*path, :context_type_declaration])
+          @context_type_declaration ||= Manifest::TypeDeclaration.new(
+            root_manifest, [*manifest_path, :context_type_declaration]
+          )
         end
 
         def context_ts_type

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

@@ -153,9 +153,8 @@ module Foobara
           ts_instance_full_path
         end
 
-        foobara_delegate :organization_name,
-                         :domain_name,
-                         to: :relevant_manifest
+        def organization_name = relevant_manifest.organization_name
+        def domain_name = relevant_manifest.domain_name
 
         def import_path
           if import_path_array.size == 1
@@ -194,14 +193,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 +217,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 +247,8 @@ module Foobara
                             association_depth:,
                             dependency_group:,
                             initial: false,
-                            model_and_entity_free:
+                            model_and_entity_free:,
+                            is_output:
                           )
                           "#{ts_type}[]"
                         else
@@ -275,7 +282,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 +319,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")
@@ -370,12 +393,15 @@ module Foobara
           dependency_group.non_colliding_type(generator)
         end
 
+        # Files generator checks that the relevant_manifest is the same but this is faster
         def ==(other)
-          self.class == other.class && path == other.path && root_manifest == other.root_manifest
+          self.class == other.class &&
+            manifest_path == other.manifest_path &&
+            root_manifest == other.root_manifest
         end
 
         def hash
-          path.hash
+          manifest_path.hash
         end
 
         def path_to_root

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.1
 platform: ruby
 authors:
 - Miles Georgi