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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8215d8808315c6f8fd3d1e630ce0e580a6a577c5b1c70a417347ee2dc334998
-  data.tar.gz: 9cda7eed3bea9cd2dadb446857d1fb4c133e0b35cbad491c7c1527d49d682d1a
+  metadata.gz: 7f320bbabd5ddca46562061c2824136049cdb2527db04dcc12a158faacf976ee
+  data.tar.gz: 0dd1e7ede3eb687061654c2a69be0e666558aaac109ad6965cb1d48b23f6e996
 SHA512:
-  metadata.gz: 83ce0b3291adbc9bff8e6328f7f7c2a7bd386fb46aae876282ed4f7ee88bb401148cd99720f38fdbbf31d5bf73df3e5a9167a0830a120409a38cd4a5f8e90f8d
-  data.tar.gz: 829447664b106704867d6c4345d677a6f252b2ffe730a4f54719ffa37b7998a6ec8385f7a22abf3ac57e2a5f8b2e0841b14fdc6ade33415adf80cb8fe76048b7
+  metadata.gz: dfe94127bf3d4b42b0846282b3a036a6c7eee1769bd3c06c4b522984ac8ee4556b220471e3da023340d9b60821624f839e629d7609d37d4d51c83b0076a90d46
+  data.tar.gz: 41e09f9b71898e73eeb2e8afc94f49aa909e37d8defc7f44454669471c9b925b130f3790e41338d1c23cfd5c2a71582a9e9a0ece77f1f0ba9250def19297950f

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [1.1.7] - 2025-11-02
+
+- Make CommandCastResultGenerator's interpretation of atom? match other generators
+
+## [1.1.6] - 2025-10-17
+
+- Dirty all queries on login/logout, not just GetCurrentUser
+- Remove no-longer needed /setup.ts file generation
+
 ## [1.1.5] - 2025-10-15
 
 - Implement castJsonResult

data/src/remote_generator/services/command_cast_result_generator.rb

@@ -5,12 +5,12 @@ module Foobara
     class Services
       class CommandCastResultGenerator < CommandResultGenerator
         class CastTree
-          attr_accessor :children, :declaration_to_cast, :past_first_model
+          attr_accessor :children, :declaration_to_cast, :initial
 
-          def initialize(children: nil, declaration_to_cast: nil, past_first_model: false)
+          def initialize(children: nil, declaration_to_cast: nil, initial: false)
             self.children = children
             self.declaration_to_cast = declaration_to_cast
-            self.past_first_model = past_first_model
+            self.initial = initial
           end
 
           def empty?
@@ -41,31 +41,30 @@ module Foobara
 
           nested_model_generators = []
 
-          generators = model_generators
-
-          generators.each do |generator|
-            _models_reachable_from_declaration(
-              generator.relevant_manifest
-            )&.each do |(model, past_first)|
-              generator_class = if atom?
-                                  if model.detached_entity? && past_first
-                                    Services::UnloadedEntityGenerator
-                                  else
-                                    Services::AtomModelGenerator
-                                  end
-                                elsif aggregate?
-                                  Services::AggregateModelGenerator
+          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)]
+          end
+
+          _models_reachable_from_declaration(result_type, initial: true)&.each do |model|
+            generator_class = if atom?
+                                if model.detached_entity?
+                                  Services::UnloadedEntityGenerator
                                 else
-                                  Services::ModelGenerator
+                                  Services::AtomModelGenerator
                                 end
+                              elsif aggregate?
+                                Services::AggregateModelGenerator
+                              else
+                                Services::ModelGenerator
+                              end
 
-              new_generator = generator_class.new(model)
+            new_generator = generator_class.new(model)
 
-              unless generators.any? do |g|
-                g.relevant_manifest == model && g.class == new_generator.class
-              end
-                nested_model_generators << new_generator
-              end
+            unless nested_model_generators.any? do |g|
+              g.relevant_manifest == model && g.class == new_generator.class
+            end
+              nested_model_generators << new_generator
             end
           end
 
@@ -81,7 +80,7 @@ module Foobara
         end
 
         def dependencies
-          @dependencies ||= model_generators + nested_model_generators
+          nested_model_generators
         end
 
         def cast_json_result_function
@@ -92,7 +91,7 @@ module Foobara
 
         # TODO: need to make use of initial?
         def cast_json_result_function_body(
-          cast_tree = _construct_cast_tree(result_type),
+          cast_tree = _construct_cast_tree(result_type, initial: true),
           parent: "json",
           property: nil,
           value: parent
@@ -189,8 +188,9 @@ module Foobara
           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.past_first_model)
+            ts_model_name = model_to_ts_model_name(type,
+                                                   association_depth:,
+                                                   initial: cast_tree.initial)
 
             "#{lvalue} = new #{ts_model_name}(#{value})"
           else
@@ -200,7 +200,7 @@ module Foobara
           end
         end
 
-        def _construct_cast_tree(type_declaration, past_first_model: false)
+        def _construct_cast_tree(type_declaration, initial: false)
           if type_declaration.is_a?(Manifest::Attributes)
             return unless type_declaration.has_attribute_declarations?
             return if type_declaration.attribute_declarations.empty?
@@ -209,39 +209,39 @@ module Foobara
 
             type_declaration.attribute_declarations.each_pair do |attribute_name, attribute_declaration|
               if type_requires_cast?(attribute_declaration)
-                path_tree[attribute_name] = _construct_cast_tree(attribute_declaration, past_first_model:)
+                path_tree[attribute_name] = _construct_cast_tree(attribute_declaration)
               end
             end
 
             unless path_tree.empty?
-              CastTree.new(children: path_tree, past_first_model:)
+              CastTree.new(children: path_tree, initial:)
             end
           elsif type_declaration.is_a?(Manifest::Array)
             element_type = type_declaration.element_type
 
             if element_type && type_requires_cast?(element_type)
-              CastTree.new(children: { "#": _construct_cast_tree(element_type, past_first_model:) })
+              CastTree.new(initial:, children: { "#": _construct_cast_tree(element_type) })
             end
           elsif type_declaration.type.to_sym == :date || type_declaration.type.to_sym == :datetime
-            CastTree.new(declaration_to_cast: type_declaration, past_first_model:)
+            CastTree.new(declaration_to_cast: type_declaration, initial:)
           elsif type_declaration.model?
             type_declaration = type_declaration.to_type
 
             children = if type_declaration.detached_entity? && atom?
                          nil
                        else
-                         _construct_cast_tree(type_declaration.attributes_type, past_first_model: true)
+                         _construct_cast_tree(type_declaration.attributes_type)
                        end
 
-            CastTree.new(children:, declaration_to_cast: type_declaration, past_first_model:)
+            CastTree.new(children:, declaration_to_cast: type_declaration, initial:)
             # TODO: either test this code path or raise or delete it
             # :nocov:
           elsif type_declaration.custom?
             if type_requires_cast?(type_declaration.base_type.to_type_declaration)
-              tree = _construct_cast_tree(type_declaration.base_type.to_type_declaration, past_first_model:)
+              tree = _construct_cast_tree(type_declaration.base_type.to_type_declaration)
 
               if tree && !tree.empty?
-                CastTree.new(children: tree, past_first_model:)
+                CastTree.new(children: tree, initial:)
               end
             end
           end
@@ -249,7 +249,7 @@ module Foobara
         end
 
         # TODO: Feels like similar complicated logic is popping up in many places? How to find/converge such logic
-        def _models_reachable_from_declaration(type_declaration, past_first_model: false)
+        def _models_reachable_from_declaration(type_declaration, initial: false)
           if type_declaration.is_a?(Manifest::Attributes)
             return unless type_declaration.has_attribute_declarations?
             return if type_declaration.attribute_declarations.empty?
@@ -258,13 +258,14 @@ module Foobara
 
             type_declaration.attribute_declarations.each_value do |attribute_declaration|
               if type_requires_cast?(attribute_declaration)
-                models ||= Set.new
-
-                _models_reachable_from_declaration(
-                  attribute_declaration,
-                  past_first_model:
-                )&.each do |pair|
-                  models << pair
+                additional = _models_reachable_from_declaration(attribute_declaration)
+
+                if additional
+                  if models
+                    models |= additional
+                  else
+                    models = additional
+                  end
                 end
               end
             end
@@ -274,24 +275,23 @@ module Foobara
             element_type = type_declaration.element_type
 
             if element_type && type_requires_cast?(element_type)
-              _models_reachable_from_declaration(element_type, past_first_model:)
+              _models_reachable_from_declaration(element_type)
             end
           elsif type_declaration.model?
             if type_declaration.is_a?(Manifest::TypeDeclaration)
               type_declaration = type_declaration.to_type
             end
 
-            models = Set[[type_declaration, past_first_model]]
+            models = Set[type_declaration]
 
             if atom? && type_declaration.detached_entity?
               return models
             end
 
-            _models_reachable_from_declaration(
-              type_declaration.attributes_type,
-              past_first_model: true
-            )&.each do |pair|
-              models << pair
+            additional = _models_reachable_from_declaration(type_declaration.attributes_type)
+
+            if additional
+              models |= additional
             end
 
             models
@@ -299,10 +299,7 @@ module Foobara
             # TODO: either test this code path or raise or delete it
             # :nocov:
             if type_requires_cast?(type_declaration.base_type.to_type_declaration)
-              _models_reachable_from_declaration(
-                type_declaration.base_type.to_type_declaration,
-                past_first_model:
-              )
+              _models_reachable_from_declaration(type_declaration.base_type.to_type_declaration)
             end
             # :nocov:
           end

data/src/remote_generator/services/typescript_from_manifest_base_generator.rb

@@ -36,10 +36,7 @@ module Foobara
                                   when "Foobara::Auth::Logout"
                                     Services::Auth::LogoutGenerator
                                   when /\bGetCurrentUser$/
-                                    [
-                                      Services::Auth::RequiresAuthGenerator,
-                                      Services::Auth::SetupGenerator
-                                    ]
+                                    Services::Auth::RequiresAuthGenerator
                                   else
                                     if manifest.requires_authentication?
                                       Services::Auth::RequiresAuthGenerator
@@ -383,12 +380,7 @@ module Foobara
 
         def path_to_root
           path = super
-
-          if path.empty?
-            "./"
-          else
-            path
-          end
+          path.empty? ? "./" : path
         end
       end
     end

data/src/remote_generator/write_typescript_to_disk.rb

@@ -59,7 +59,6 @@ module Foobara
 
       def run_post_generation_tasks
         eslint_fix
-        warn_about_adding_setup_to_index
       end
 
       def eslint_fix
@@ -74,24 +73,6 @@ module Foobara
           end
         end
       end
-
-      def warn_about_adding_setup_to_index
-        if paths_to_source_code.key?("setup.ts")
-          index_tsx_path = "#{output_directory}/../index.tsx"
-
-          if File.exist?(index_tsx_path)
-            unless File.read(index_tsx_path) =~ /import.*domains\/setup/
-              warn "WARNING: you should add the following to src/index.tsx:\n\n" \
-                   "import './domains/setup'"
-            end
-          else
-            # :nocov:
-            warn "WARNING: Make sure you add the following somewhere:\n\n" \
-                 "import './domains/setup'"
-            # :nocov:
-          end
-        end
-      end
     end
   end
 end

data/templates/Foobara/Auth/utils/accessTokens.ts.erb

@@ -1,31 +1,25 @@
 import type Query from '../../../base/Query'
 import type RemoteCommand from '../../../base/RemoteCommand'
+import { forEachQuery } from '../../../base/QueryCache'
 
-let getCurrentUserQuery: Query<RemoteCommand<any, any, any>> | undefined
-
-export function setGetCurrentUserQuery (query: Query<RemoteCommand<any, any, any>>): void {
-  getCurrentUserQuery = query
-}
-
-function setCurrentUserDirty () {
-  console.log('setCurrentUserDirty')
-  if (getCurrentUserQuery != null) {
-    getCurrentUserQuery.setDirty()
-  }
+function dirtyAllQueries () {
+  forEachQuery((query: Query<RemoteCommand<any, any, any>>) => {
+    query.setDirty()
+  })
 }
 
 const accessTokens = new Map<string, string>()
 
 const logout = (urlBase: string): void => {
   accessTokens.delete(urlBase)
-  setCurrentUserDirty()
+  dirtyAllQueries()
 }
 let handleLogout: (baseUrl: string) => void = logout
 
 const tokenForUrl = (baseUrl: string): string | undefined => accessTokens.get(baseUrl)
 const handleLogin: (baseUrl: string, accessToken: string) => void = (baseUrl, accessToken) => {
   accessTokens.set(baseUrl, accessToken)
-  setCurrentUserDirty()
+  dirtyAllQueries()
 }
 
 if (typeof BroadcastChannel !== 'undefined') {

data/templates/base/QueryCache.ts

@@ -33,6 +33,10 @@ export function getQuery<CommandT extends RemoteCommand<any, any, any>> (
   return query
 }
 
+export function forEachQuery (callback: (query: Query<RemoteCommand<any, any, any>>) => void): void {
+  queryCache.forEach(callback)
+}
+
 function toKey<CommandT extends RemoteCommand<any, any, any>> (
   CommandClass: RemoteCommandConstructor<CommandT>,
   inputs: InputsOf<CommandT> | undefined

data/templates/hooks/useQuery.ts

@@ -57,19 +57,23 @@ export default function useQuery<CommandT extends RemoteCommand<any, any, any>>
     queryRef.current = query
   }
 
+  const [queryState, setQueryState] = useState<QueryState<CommandT>>(
+    queryToQueryState<CommandT>(query)
+  )
+
   useEffect(() => {
-    const unsubscribe = query?.onChange(() => {
-      if (query != null) { // just here to satisfy type checker
+    if (query == null) {
+      return undefined
+    }
+
+    const removeListener = query.onChange(() => {
+      if (query != null) { // Just here to satisfy type check
         setQueryState(queryToQueryState<CommandT>(query))
       }
     })
 
-    return unsubscribe
+    return removeListener
   }, [query])
 
-  const [queryState, setQueryState] = useState<QueryState<CommandT>>(
-    queryToQueryState<CommandT>(query)
-  )
-
   return queryState
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara-typescript-remote-command-generator
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.7
 platform: ruby
 authors:
 - Miles Georgi
@@ -70,7 +70,6 @@ files:
 - src/remote_generator/services/auth/refresh_login_generator.rb
 - src/remote_generator/services/auth/requires_auth_command_generator.rb
 - src/remote_generator/services/auth/requires_auth_generator.rb
-- src/remote_generator/services/auth/setup_generator.rb
 - src/remote_generator/services/command_cast_result_generator.rb
 - src/remote_generator/services/command_errors_generator.rb
 - src/remote_generator/services/command_errors_index_generator.rb
@@ -136,7 +135,6 @@ files:
 - templates/base/RemoteCommand.ts
 - templates/base/RemoteCommandTypes.ts
 - templates/hooks/useQuery.ts
-- templates/setup.ts.erb
 homepage: https://github.com/foobara/typescript-remote-command-generator
 licenses:
 - Apache-2.0

data/src/remote_generator/services/auth/setup_generator.rb

@@ -1,25 +0,0 @@
-module Foobara
-  module RemoteGenerator
-    class Services
-      module Auth
-        class SetupGenerator < CommandGenerator
-          def template_path
-            "setup.ts.erb"
-          end
-
-          def target_path
-            ["setup.ts"]
-          end
-
-          def command_generator
-            generator_for(command_manifest)
-          end
-
-          def dependencies
-            [command_generator]
-          end
-        end
-      end
-    end
-  end
-end

data/templates/setup.ts.erb

@@ -1,6 +0,0 @@
-import { getQuery } from './base/QueryCache'
-import { setGetCurrentUserQuery } from './Foobara/Auth/utils/accessTokens'
-
-import <%= command_generator.import_destructure %> from "<%= path_to_root %><%= command_generator.import_path %>"
-
-setGetCurrentUserQuery(getQuery(<%= dependency_group.non_colliding_type(command_generator) %>, undefined))