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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b6ba29a2e9cc4baa0b854c2af01f8f9765d784d731f71a27d664c09280050c2
-  data.tar.gz: 13e3647fdf41efa57db365b7b2ecb652691491cc720dc605548820e0883f0c60
+  metadata.gz: 63a56366d8d763f7a5945acb31f26942889b8801d87d473f1cf80670492984ea
+  data.tar.gz: f743ce22ffdf47ece2df4d68763a76c959072098fb50c2314da236c667cbc7e6
 SHA512:
-  metadata.gz: c6abab21d2187b784d2cf1887c9b5e7d48b11d440819e4215215f37f5ef9c4ea3df0dd6daa79be1a07733440915b26c62bf340ad16c78b4d93617557d834193b
-  data.tar.gz: 47ce45d8450081c5fc6029f7dc9df67c968103a7e40edda520d2a263452e014cfa54d3123f35ab346002d1bdf490c792ef8419b5cf917f09d47898254c9090f1
+  metadata.gz: 3296bab04a57c964281ee3e8b5e4b5db4f3cda345bfbbbf6c9667cbc1eba4cd2e75266a1be6d9cc38836d44b310355201f4590bec04fcf87a33f96e7e988c6fd
+  data.tar.gz: 18a1e5716e44579286b0251cbc9b30fc4814c5c7033578ff33d00b91a6640e7e20042acc0a93ded4ff2cc4d001c310f605a3eed448c839d7391b40dad0abf6ea

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.3.0] - 2026-02-26
+
+- Add auto-dirty queries feature
+
 ## [1.2.7] - 2026-02-16
 
 - Make generated castJsonResult.ts files undefined-safe

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)

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
 

data/src/generators/command_generator.rb

@@ -0,0 +1,209 @@
+require_relative "typescript_from_manifest_base_generator"
+
+module Foobara
+  module RemoteGenerator
+    module Generators
+      class CommandGenerator < TypescriptFromManifestBaseGenerator
+        alias command_manifest relevant_manifest
+
+        def target_path
+          [*scoped_full_path, "index.ts"]
+        end
+
+        def template_path
+          "Command.ts.erb"
+        end
+
+        def domain_generator
+          @domain_generator ||= DomainGenerator.new(domain)
+        end
+
+        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&.manifest_path&.map(&:to_s) == manifest_path.map(&:to_s)
+          end.map do |error_manifest|
+            ErrorGenerator.new(error_manifest)
+          end
+        end
+
+        def dependencies
+          [
+            RemoteCommandGenerator.new(Manifest::RootManifest.new(root_manifest)),
+            *queries_that_are_dirtied_by_this_command.keys
+          ]
+        end
+
+        def will_define
+          ts_instance_path
+        end
+
+        def command_errors_index_generator
+          CommandErrorsIndexGenerator.new(command_manifest)
+        end
+
+        def base_class_path
+          "base/RemoteCommand"
+        end
+
+        def base_class_name
+          base_class_path.split("/").last
+        end
+
+        def result_json_requires_cast?
+          # What types require a cast?
+          # :date and :datetime, :model, custom type declaration (check #custom?)
+          result_type && type_requires_cast?(result_type)
+        end
+
+        def queries_that_are_dirtied_by_this_command
+          return {} if query? || !auto_dirty_queries?
+
+          return @queries_that_are_dirtied_by_this_command if defined?(@queries_that_are_dirtied_by_this_command)
+
+          command_result_type = result_type
+
+          paths_to_data = nil
+
+          if command_result_type
+            command_result_type = command_result_type.to_type if command_result_type.is_a?(Manifest::TypeDeclaration)
+
+            if command_result_type.detached_entity?
+              paths_to_data = { command_result_type => [:outcome, :result, command_result_type.primary_key_name] }
+            else
+              result_type_associations = Manifest::Model.associations(command_result_type)
+
+              unless result_type_associations.empty?
+                data_path, entity_type = result_type_associations.to_a.first
+                paths_to_data = { entity_type => [:outcome, :result, data_path, entity_type.primary_key_name] }
+              end
+            end
+          end
+
+          if paths_to_data.nil?
+            if inputs_type
+              inputs_associations = Manifest::Model.associations(inputs_type)
+
+              unless inputs_associations.empty?
+                data_path, entity_type = inputs_associations.to_a.first
+                paths_to_data = { entity_type => [:inputs, *data_path] }
+              end
+            end
+          end
+
+          dirties = {}
+
+          unless paths_to_data.nil?
+            all_queries = Manifest::RootManifest.new(root_manifest).queries.map do |query|
+              generator_for(query)
+            end
+
+            paths_to_data.each_pair do |entity_type, path|
+              all_queries.each do |query|
+                query_inputs_type = query.inputs_type
+
+                if query_inputs_type
+                  query_associations = Manifest::Model.associations(query_inputs_type)
+                  query_associations.each_pair do |query_association_path, query_entity_class|
+                    query_entity_class = query_entity_class.to_type if query_entity_class.is_a?(Manifest::TypeDeclaration)
+
+                    if query_entity_class == entity_type
+                      dirties[query] = [path, query_association_path]
+                    end
+                  end
+
+                  next if dirties.key?(query)
+                end
+
+                query_result_type = query.result_type
+                next unless query_result_type
+
+                if query_result_type.is_a?(Manifest::TypeDeclaration) && query_result_type.reference?
+                  query_result_type = query_result_type.to_type
+                end
+
+                if query_result_type == entity_type
+                  dirties[query] = true
+                else
+                  entity_classes = Manifest::Model.associations(query_result_type).values.uniq
+
+                  entity_classes.each do |query_entity_class|
+                    query_entity_class = query_entity_class.to_type if query_entity_class.is_a?(Manifest::TypeDeclaration)
+
+                    if query_entity_class == entity_type
+                      dirties[query] = true
+                      break
+                    end
+                  end
+                end
+              end
+            end
+          end
+
+          @queries_that_are_dirtied_by_this_command = dirties
+        end
+
+        def queries_dirtied_without_inputs
+          return @queries_dirtied_without_inputs if defined?(@queries_dirtied_without_inputs)
+
+          queries_dirtied = []
+
+          queries_that_are_dirtied_by_this_command.each_pair do |query, value|
+            if value == true
+              queries_dirtied << query
+            end
+          end
+
+          @queries_dirtied_without_inputs = queries_dirtied
+        end
+
+        def queries_dirtied_with_inputs
+          return @queries_dirtied_with_inputs if defined?(@queries_dirtied_with_inputs)
+
+          dirtied_queries = {}
+
+          queries_that_are_dirtied_by_this_command.each_pair do |query, value|
+            if value != true
+              dirtied_queries[query] = value
+            end
+          end
+
+          @queries_dirtied_with_inputs = dirtied_queries
+        end
+
+        private
+
+        def type_requires_cast?(type_declaration)
+          if type_declaration.is_a?(Manifest::Attributes)
+            return false unless type_declaration.has_attribute_declarations?
+            return false if type_declaration.attribute_declarations.empty?
+
+            type_declaration.attribute_declarations.values.any? do |attribute_declaration|
+              type_requires_cast?(attribute_declaration)
+            end
+          elsif type_declaration.is_a?(Manifest::Array)
+            element_type = type_declaration.element_type
+            element_type && type_requires_cast?(element_type)
+          else
+            return true if type_declaration.model?
+
+            type_symbol = type_declaration.type_symbol
+
+            if type_symbol == :date || type_symbol == :datetime
+              return true
+            end
+
+            if type_declaration.custom?
+              type_declaration = type_declaration.to_type if type_declaration.is_a?(Manifest::TypeDeclaration)
+              base_type = type_declaration.base_type
+              type_requires_cast?(base_type)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@ require_relative "typescript_from_manifest_base_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class CommandInputsGenerator < TypescriptFromManifestBaseGenerator
         alias command_manifest relevant_manifest
 

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

@@ -2,7 +2,7 @@ require_relative "manifest_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class CommandManifestGenerator < ManifestGenerator
         def target_path
           [*scoped_full_path, "manifest.json"]

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

@@ -2,7 +2,7 @@ require_relative "typescript_from_manifest_base_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class CommandResultGenerator < CommandGenerator
         alias command_manifest relevant_manifest
 

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

@@ -1,6 +1,6 @@
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class DependencyGroup
         class CollisionData
           attr_accessor :points
@@ -135,7 +135,7 @@ module Foobara
                 dep != other_dep && name == non_colliding_type_name(other_dep, points)
               end
 
-              if will_define&.include?(name)
+              if will_define&.include?(name) && dep != deps_are_for
                 collisions << deps_are_for
               end
 

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

@@ -2,7 +2,7 @@ require_relative "domain_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class DomainConfigGenerator < DomainGenerator
         def target_path
           [*super[0..-2], "config.ts"]

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

@@ -2,7 +2,7 @@ require_relative "typescript_from_manifest_base_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class DomainGenerator < TypescriptFromManifestBaseGenerator
         alias domain_manifest relevant_manifest