foobara-typescript-remote-command-generator 1.2.6 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e9da9e5402f377488227d8a3d9911e0b5aaecb17c377e7209668993fcac7580
-  data.tar.gz: 7910689c819504d3d902ee61b433f1b10765c67b75f24cfad052f55141a89c8f
+  metadata.gz: 63a56366d8d763f7a5945acb31f26942889b8801d87d473f1cf80670492984ea
+  data.tar.gz: f743ce22ffdf47ece2df4d68763a76c959072098fb50c2314da236c667cbc7e6
 SHA512:
-  metadata.gz: fd073a89e550986306bcf2ba57d2cb5c7bf7b13e0d3c244517e09223b9106000c429cec615e4f985359f6548c7aca8b3533e7bf0f4e53dd777228a4bb999367b
-  data.tar.gz: 36dd52e22fbaf4c2cc193fa67ac7a7de8126e75b950a4850e9c1d896bf7e814ba4eb8b4b4936879d8cf8d508e5584153ccedad726834e13a76c6a9a6d55f1e44
+  metadata.gz: 3296bab04a57c964281ee3e8b5e4b5db4f3cda345bfbbbf6c9667cbc1eba4cd2e75266a1be6d9cc38836d44b310355201f4590bec04fcf87a33f96e7e988c6fd
+  data.tar.gz: 18a1e5716e44579286b0251cbc9b30fc4814c5c7033578ff33d00b91a6640e7e20042acc0a93ded4ff2cc4d001c310f605a3eed448c839d7391b40dad0abf6ea

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.3.0] - 2026-02-26
+
+- Add auto-dirty queries feature
+
+## [1.2.7] - 2026-02-16
+
+- Make generated castJsonResult.ts files undefined-safe
+
 ## [1.2.6] - 2026-02-16
 
 - Make use of guaranteed_to_exist to avoid marking present delegates as optional

data/lib/foobara/typescript_remote_command_generator.rb

@@ -5,9 +5,4 @@ require "erb"
 require "json"
 require "open-uri"
 
-src = "#{__dir__}/../../src/"
-
-Foobara::Util.require_directory(src)
-
-module TypescriptRemoteCommandGenerator
-end
+Foobara::Util.require_directory("#{__dir__}/../../src/")

data/src/{remote_generator/generate_typescript.rb → generate_typescript.rb}

@@ -8,8 +8,11 @@ module Foobara
 
       possible_error MissingManifestError
 
-      inputs raw_manifest: :associative_array,
-             manifest_url: :string
+      inputs do
+        raw_manifest :associative_array
+        manifest_url :string
+        auto_dirty_queries :boolean, default: false
+      end
 
       def execute
         load_manifest_if_needed
@@ -38,11 +41,11 @@ module Foobara
       attr_accessor :command_manifest, :manifest_data
 
       def base_generator
-        Services::TypescriptFromManifestBaseGenerator
+        Generators::TypescriptFromManifestBaseGenerator
       end
 
       def templates_dir
-        "#{__dir__}/../../templates"
+        "#{__dir__}/../templates"
       end
 
       def load_manifest_if_needed
@@ -74,6 +77,12 @@ module Foobara
         end
       end
 
+      def generate_element
+        RemoteGenerator.auto_dirty_queries(auto_dirty_queries) do
+          super
+        end
+      end
+
       def add_root_manifest_to_set_of_elements_to_generate
         elements_to_generate << manifest
       end

data/src/{remote_generator/services → generators}/aggregate_entity_generator.rb

@@ -2,7 +2,7 @@ require_relative "loaded_entity_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class AggregateEntityGenerator < LoadedEntityGenerator
         class << self
           def new(relevant_manifest)
@@ -26,7 +26,7 @@ module Foobara
 
         def model_generators
           @model_generators ||= types_depended_on.select(&:model?).map do |model|
-            Services::AggregateModelGenerator.new(model)
+            AggregateModelGenerator.new(model)
           end
         end
 

data/src/{remote_generator/services → generators}/aggregate_model_generator.rb

@@ -1,6 +1,6 @@
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class AggregateModelGenerator < ModelGenerator
         class << self
           def new(relevant_manifest)
@@ -27,9 +27,9 @@ module Foobara
         def model_generators
           @model_generators ||= types_depended_on.select(&:model?).map do |model|
             if model.detached_entity?
-              Services::AggregateEntityGenerator.new(model)
+              AggregateEntityGenerator.new(model)
             else
-              Services::AggregateModelGenerator.new(model)
+              AggregateModelGenerator.new(model)
             end
           end
         end

data/src/{remote_generator/services → generators}/atom_entity_generator.rb

@@ -1,6 +1,6 @@
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class AtomEntityGenerator < LoadedEntityGenerator
         class << self
           def new(relevant_manifest)
@@ -25,9 +25,9 @@ module Foobara
         def model_generators
           @model_generators ||= types_depended_on.select(&:model?).map do |model|
             if model.detached_entity?
-              Services::UnloadedEntityGenerator.new(model)
+              UnloadedEntityGenerator.new(model)
             else
-              Services::AtomModelGenerator.new(model)
+              AtomModelGenerator.new(model)
             end
           end
         end

data/src/{remote_generator/services → generators}/atom_model_generator.rb

@@ -1,6 +1,6 @@
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class AtomModelGenerator < ModelGenerator
         class << self
           def new(relevant_manifest)
@@ -27,9 +27,9 @@ module Foobara
         def model_generators
           @model_generators ||= types_depended_on.select(&:model?).map do |model|
             if model.detached_entity?
-              Services::UnloadedEntityGenerator.new(model)
+              UnloadedEntityGenerator.new(model)
             else
-              Services::AtomModelGenerator.new(model)
+              AtomModelGenerator.new(model)
             end
           end
         end

data/src/{remote_generator/services → generators}/auth/access_tokens_generator.rb

@@ -1,6 +1,6 @@
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       module Auth
         class AccessTokensGenerator < TypescriptFromManifestBaseGenerator
           def template_path

data/src/generators/auth/login_command_generator.rb

@@ -0,0 +1,29 @@
+module Foobara
+  module RemoteGenerator
+    module Generators
+      module Auth
+        class LoginCommandGenerator < TypescriptFromManifestBaseGenerator
+          def import_destructure
+            ts_instance_path.first
+          end
+
+          def ts_instance_path
+            ["LoginCommand"]
+          end
+
+          def ts_instance_full_path
+            ["Foobara", "Auth", "LoginCommand"]
+          end
+
+          def template_path
+            ["Foobara", "Auth", "LoginCommand.ts.erb"]
+          end
+
+          def dependencies
+            super + [AccessTokensGenerator.new(relevant_manifest)]
+          end
+        end
+      end
+    end
+  end
+end

data/src/{remote_generator/services → generators}/auth/login_generator.rb

@@ -1,6 +1,6 @@
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       module Auth
         class LoginGenerator < CommandGenerator
           def base_class_path
@@ -8,7 +8,9 @@ module Foobara
           end
 
           def dependencies
-            super + [LoginCommandGenerator.new(relevant_manifest)]
+            super.reject do |generator|
+              generator.is_a?(RemoteCommandGenerator)
+            end + [LoginCommandGenerator.new(relevant_manifest)]
           end
         end
       end

data/src/generators/auth/logout_command_generator.rb

@@ -0,0 +1,29 @@
+module Foobara
+  module RemoteGenerator
+    module Generators
+      module Auth
+        class LogoutCommandGenerator < TypescriptFromManifestBaseGenerator
+          def import_destructure
+            ts_instance_path.first
+          end
+
+          def ts_instance_path
+            ["LogoutCommand"]
+          end
+
+          def ts_instance_full_path
+            ["Foobara", "Auth", "LogoutCommand"]
+          end
+
+          def template_path
+            ["Foobara", "Auth", "LogoutCommand.ts.erb"]
+          end
+
+          def dependencies
+            super + [AccessTokensGenerator.new(relevant_manifest)]
+          end
+        end
+      end
+    end
+  end
+end

data/src/{remote_generator/services → generators}/auth/logout_generator.rb

@@ -1,6 +1,6 @@
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       module Auth
         class LogoutGenerator < CommandGenerator
           def base_class_path
@@ -8,7 +8,9 @@ module Foobara
           end
 
           def dependencies
-            super + [LogoutCommandGenerator.new(relevant_manifest)]
+            super.reject do |generator|
+              generator.is_a?(RemoteCommandGenerator)
+            end + [LogoutCommandGenerator.new(relevant_manifest)]
           end
         end
       end

data/src/{remote_generator/services → generators}/auth/refresh_login_generator.rb

@@ -2,7 +2,7 @@ require_relative "../command_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       module Auth
         class RefreshLoginGenerator < CommandGenerator
           def base_class_path
@@ -10,7 +10,9 @@ module Foobara
           end
 
           def dependencies
-            super + [LoginCommandGenerator.new(relevant_manifest)]
+            super.reject do |generator|
+              generator.is_a?(RemoteCommandGenerator)
+            end + [LoginCommandGenerator.new(relevant_manifest)]
           end
         end
       end

data/src/generators/auth/requires_auth_command_generator.rb

@@ -0,0 +1,27 @@
+require_relative "../typescript_from_manifest_base_generator"
+
+module Foobara
+  module RemoteGenerator
+    module Generators
+      module Auth
+        class RequiresAuthCommandGenerator < TypescriptFromManifestBaseGenerator
+          def import_destructure
+            ts_instance_path.first
+          end
+
+          def ts_instance_path
+            ["RequiresAuthCommand"]
+          end
+
+          def ts_instance_full_path
+            ["Foobara", "Auth", "RequiresAuthCommand"]
+          end
+
+          def template_path
+            ["Foobara", "Auth", "RequiresAuthCommand.ts.erb"]
+          end
+        end
+      end
+    end
+  end
+end

data/src/{remote_generator/services → generators}/auth/requires_auth_generator.rb

@@ -2,7 +2,7 @@ require_relative "../command_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       module Auth
         class RequiresAuthGenerator < CommandGenerator
           def base_class_path
@@ -10,7 +10,9 @@ module Foobara
           end
 
           def dependencies
-            super + [RequiresAuthCommandGenerator.new(relevant_manifest)]
+            super.reject do |generator|
+              generator.is_a?(RemoteCommandGenerator)
+            end + [RequiresAuthCommandGenerator.new(relevant_manifest)]
           end
         end
       end

data/src/{remote_generator/services → generators}/command_cast_result_generator.rb

@@ -2,7 +2,7 @@ require_relative "command_result_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class CommandCastResultGenerator < CommandResultGenerator
         class CastTree
           attr_accessor :children, :declaration_to_cast, :initial
@@ -43,20 +43,20 @@ module Foobara
 
           if result_type.detached_entity? && atom?
             declaration = result_type.is_a?(Manifest::TypeDeclaration) ? result_type.to_type : result_type
-            return @nested_model_generators = Set[Services::AtomEntityGenerator.new(declaration)]
+            return @nested_model_generators = Set[AtomEntityGenerator.new(declaration)]
           end
 
           _models_reachable_from_declaration(result_type, initial: true)&.each do |model|
             generator_class = if atom?
                                 if model.detached_entity?
-                                  Services::UnloadedEntityGenerator
+                                  UnloadedEntityGenerator
                                 else
-                                  Services::AtomModelGenerator
+                                  AtomModelGenerator
                                 end
                               elsif aggregate?
-                                Services::AggregateModelGenerator
+                                AggregateModelGenerator
                               else
-                                Services::ModelGenerator
+                                ModelGenerator
                               end
 
             new_generator = generator_class.new(model)
@@ -116,24 +116,24 @@ module Foobara
                                                          value: "element")
                 result << "})"
               elsif child_cast_tree.is_a?(::Hash)
-                # TODO: either test this codepath or delete it
+                # TODO: either test this code path or delete it
                 # :nocov:
                 property = path_part =~ /\A\d+\z/ ? path_part.to_i : "\"#{path_part}\""
 
                 result << cast_json_result_function_body(child_cast_tree,
                                                          parent:,
                                                          property:,
-                                                         value: "#{parent}.#{path_part}")
+                                                         value: "#{parent}?.#{path_part}")
                 # :nocov:
               elsif child_cast_tree.is_a?(CastTree)
                 result << cast_json_result_function_body(child_cast_tree.children,
-                                                         parent: "#{parent}.#{path_part}")
+                                                         parent: "#{parent}?.#{path_part}")
 
                 property = path_part =~ /\A\d+\z/ ? path_part.to_i : "\"#{path_part}\""
                 result << _ts_cast_expression(child_cast_tree,
                                               parent:,
                                               property:,
-                                              value: "#{parent}.#{path_part}")
+                                              value: "#{parent}?.#{path_part}")
               else
                 # :nocov:
                 raise "Not sure how to handle a #{cast_tree.class}: #{cast_tree}"
@@ -164,9 +164,9 @@ module Foobara
                      if property.nil?
                        parent
                      elsif property =~ /\A"(.*)"\z/
-                       "#{parent}.#{$1}"
+                       "#{parent}?.#{$1}"
                      else
-                       "#{parent}[#{property}]"
+                       "#{parent}?.[#{property}]"
                      end
                    else
                      # TODO: either test this path or raise
@@ -183,21 +183,29 @@ module Foobara
 
           type_symbol = type.type_symbol
 
-          value ||= lvalue
+          value ||= lvalue.dup
+          lvalue = lvalue.gsub("?.[", "[").gsub("?.", ".")
+          present_value = value.gsub("?.[", "[").gsub("?.", ".")
 
-          if type_symbol == :date || type_symbol == :datetime
-            "#{lvalue} = new Date(#{value})"
-          elsif type.model?
-            ts_model_name = model_to_ts_model_name(type,
-                                                   association_depth:,
-                                                   initial: cast_tree.initial)
+          expression = "if (#{value} !== undefined) {\n"
 
-            "#{lvalue} = new #{ts_model_name}(#{value})"
-          else
-            # :nocov:
-            raise "Not sure how to cast type #{type} to a Typescript expression"
-            # :nocov:
-          end
+          expression += if type_symbol == :date || type_symbol == :datetime
+                          "#{lvalue} = new Date(#{present_value})"
+                        elsif type.model?
+                          ts_model_name = model_to_ts_model_name(type,
+                                                                 association_depth:,
+                                                                 initial: cast_tree.initial)
+
+                          "#{lvalue} = new #{ts_model_name}(#{present_value})"
+                        else
+                          # :nocov:
+                          raise "Not sure how to cast type #{type} to a Typescript expression"
+                          # :nocov:
+                        end
+
+          expression += "\n}"
+
+          expression
         end
 
         def _construct_cast_tree(type_declaration, initial: false)

data/src/{remote_generator/services → generators}/command_errors_generator.rb

@@ -3,7 +3,7 @@ require_relative "command_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class CommandErrorsGenerator < CommandGenerator
         alias command_manifest relevant_manifest
 
@@ -21,7 +21,7 @@ module Foobara
 
         def error_generators
           @error_generators ||= possible_errors.values.map(&:error).sort_by(&:error_name).uniq.map do |error|
-            Services::ErrorGenerator.new(error)
+            ErrorGenerator.new(error)
           end
         end
 

data/src/{remote_generator/services → generators}/command_errors_index_generator.rb

@@ -2,7 +2,7 @@ require_relative "command_errors_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class CommandErrorsIndexGenerator < CommandErrorsGenerator
         alias command_manifest relevant_manifest