foobara-typescript-remote-command-generator 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16a68cb56fbf77e520f577b5ef5d0b6c677d6461fb69ce242906d608b6412e3f
-  data.tar.gz: 35dcccf09cff04cad00c02423b77ebecdebc3643080cc9e534bae8e957dd273c
+  metadata.gz: 3ea5e21e87c906d2b3605a56ef2a49245d7eb47266909cd6763c3272872e3ce3
+  data.tar.gz: 02fb6e36dce4acd76a517f42c6950617a80350bd570708321877daf7d523005e
 SHA512:
-  metadata.gz: 952c659c1ace30fbbd24f980c8382db56f95757ac5a802b25ed19e5c6faf276dd1647f6fe999cb3afc49c3bb35b90003e95765ad2363f1ce160846cd9d3100d3
-  data.tar.gz: 78c60b378c18f6786c9d6cd29db44d7c693c45c433977deedeaec79694ccb4f640f092159349758be3d1094d04c83f379e6caaea4c3e3bd4c9d5e820e4929fcc
+  metadata.gz: c73ce6914c21030225dc6b29a27c49e9e0828e6dcb4c6e0ff96c66c63a50b989480dd66bbb67d5f982c84934057cd5ee6024893a1cf36125f82a3aa9f997f7eb
+  data.tar.gz: 75a7d0058162533cce17ec2a3b8693bbd19c2f9f30f7cb43dbd960dfdf19aa5c6cb83dceb15c6e5882c80e9a7adc4ff995cc5233a2e79ea69c31402d2c156a69

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [1.5.1] - 2026-08-22
+
+- Allow setting the env expression to either import.meta.env or process.env with --env-expression
+
+## [1.5.0] - 2026-08-06
+
+- Only generate RequiresAuthCommand when its imports will exist
+- Only call dirtyQueries when it is defined
+
 ## [1.4.0] - 2026-03-19
 
 - Make things work with Vite instead of CRA

data/src/generate_typescript.rb

@@ -1,6 +1,8 @@
 require "net/http"
 require "uri"
 
+require_relative "remote_generator"
+
 module Foobara
   module RemoteGenerator
     class GenerateTypescript < Foobara::Generators::Generate
@@ -12,29 +14,46 @@ module Foobara
         raw_manifest :associative_array
         manifest_url :string
         auto_dirty_queries :boolean, default: false
+        no_foobara_auth :boolean,
+                        default: false,
+                        description: "Never generate Foobara::Auth's RequiresAuthCommand, even if the " \
+                                     "manifest contains that domain. For apps that import it from elsewhere."
+        env_expression :env_expression, default: "import.meta.env"
       end
 
       def execute
-        load_manifest_if_needed
+        apply_remote_generator_config do
+          load_manifest_if_needed
 
-        include_non_templated_files
+          include_non_templated_files
 
-        add_root_manifest_to_set_of_elements_to_generate
-        # TODO: allow specifying subset of commands
-        add_all_commands_to_set_of_elements_to_generate
+          add_root_manifest_to_set_of_elements_to_generate
+          # TODO: allow specifying subset of commands
+          add_all_commands_to_set_of_elements_to_generate
 
-        each_element_to_generate do
-          generate_element
+          each_element_to_generate do
+            generate_element
+          end
         end
 
         paths_to_source_code
       end
 
+      def apply_remote_generator_config
+        RemoteGenerator.no_foobara_auth(no_foobara_auth) do
+          RemoteGenerator.auto_dirty_queries(auto_dirty_queries) do
+            RemoteGenerator.with_env_expression(env_expression) do
+              yield
+            end
+          end
+        end
+      end
+
       def validate
         if raw_manifest.nil? && manifest_url.nil?
-          # :nocov:
+          # simplecov:disable
           add_runtime_error(MissingManifestError.new(message: "Either raw_manifest or manifest_url must be given"))
-          # :nocov:
+          # simplecov:enable
         end
       end
 
@@ -52,7 +71,7 @@ module Foobara
         self.manifest_data = if raw_manifest
                                raw_manifest
                                # TODO: introduce VCR to test the following elsif block
-                               # :nocov:
+                               # simplecov:disable
                              elsif manifest_url
                                url = URI.parse(manifest_url)
                                response = Net::HTTP.get_response(url)
@@ -65,7 +84,7 @@ module Foobara
                                                end
 
                                JSON.parse(manifest_json)
-                               # :nocov:
+                               # simplecov:enable
                              end
       end
 
@@ -77,12 +96,6 @@ 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/generators/command_cast_result_generator.rb

@@ -117,14 +117,14 @@ module Foobara
                 result << "})"
               elsif child_cast_tree.is_a?(::Hash)
                 # TODO: either test this code path or delete it
-                # :nocov:
+                # simplecov:disable
                 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}")
-                # :nocov:
+                # simplecov:enable
               elsif child_cast_tree.is_a?(CastTree)
                 result << cast_json_result_function_body(child_cast_tree.children,
                                                          parent: "#{parent}?.#{path_part}")
@@ -135,15 +135,15 @@ module Foobara
                                               property:,
                                               value: "#{parent}?.#{path_part}")
               else
-                # :nocov:
+                # simplecov:disable
                 raise "Not sure how to handle a #{cast_tree.class}: #{cast_tree}"
-                # :nocov:
+                # simplecov:enable
               end
             end
           else
-            # :nocov:
+            # simplecov:disable
             raise "Not sure how to handle a #{cast_tree.class}: #{cast_tree}"
-            # :nocov:
+            # simplecov:enable
           end
 
           result.compact.join("\n")
@@ -151,9 +151,9 @@ module Foobara
 
         def _ts_cast_expression(cast_tree, value:, parent: nil, property: nil)
           unless cast_tree.is_a?(CastTree)
-            # :nocov:
+            # simplecov:disable
             raise "Expected a CastTree but got a #{cast_tree.class}: #{cast_tree}"
-            # :nocov:
+            # simplecov:enable
           end
 
           type_declaration = cast_tree.declaration_to_cast
@@ -170,9 +170,9 @@ module Foobara
                      end
                    else
                      # TODO: either test this path or raise
-                     # :nocov:
+                     # simplecov:disable
                      value
-                     # :nocov:
+                     # simplecov:enable
                    end
 
           type = if type_declaration.is_a?(Manifest::TypeDeclaration)
@@ -198,9 +198,9 @@ module Foobara
 
                           "#{lvalue} = new #{ts_model_name}(#{present_value})"
                         else
-                          # :nocov:
+                          # simplecov:disable
                           raise "Not sure how to cast type #{type} to a Typescript expression"
-                          # :nocov:
+                          # simplecov:enable
                         end
 
           expression += "\n}"
@@ -243,7 +243,7 @@ module Foobara
 
             CastTree.new(children:, declaration_to_cast: type_declaration, initial:)
             # TODO: either test this code path or raise or delete it
-            # :nocov:
+            # simplecov:disable
           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)
@@ -253,7 +253,7 @@ module Foobara
               end
             end
           end
-          # :nocov:
+          # simplecov:enable
         end
 
         # TODO: Feels like similar complicated logic is popping up in many places? How to find/converge such logic
@@ -305,11 +305,11 @@ module Foobara
             models
           elsif type_declaration.custom?
             # TODO: either test this code path or raise or delete it
-            # :nocov:
+            # simplecov:disable
             if type_requires_cast?(type_declaration.base_type.to_type_declaration)
               _models_reachable_from_declaration(type_declaration.base_type.to_type_declaration)
             end
-            # :nocov:
+            # simplecov:enable
           end
         end
       end

data/src/generators/command_result_generator.rb

@@ -86,9 +86,9 @@ module Foobara
 
             if type && !type.builtin? && !type.model?
               # TODO: Test this!!
-              # :nocov:
+              # simplecov:disable
               [TypeGenerator.new(type)]
-              # :nocov:
+              # simplecov:enable
             else
               []
             end

data/src/generators/dependency_group.rb

@@ -27,9 +27,9 @@ module Foobara
 
           collision_data[key].tap do |cd|
             unless cd
-              # :nocov:
+              # simplecov:disable
               raise "Dependency #{dep} is not part of this dependency group"
-              # :nocov:
+              # simplecov:enable
             end
           end
         end
@@ -74,9 +74,9 @@ module Foobara
           points = collision_data_for(dep).points
 
           unless points
-            # :nocov:
+            # simplecov:disable
             raise "Dependency #{dep} has no collision data"
-            # :nocov:
+            # simplecov:enable
           end
 
           points

data/src/generators/error_generator.rb

@@ -17,9 +17,9 @@ module Foobara
                    when TypeGenerator
                      [*p.target_dir, p.type_short_name, "errors"]
                    when nil
-                     # :nocov:
+                     # simplecov:disable
                      raise "Expected #{error_name} to have a parent but it did not"
-                   # :nocov:
+                   # simplecov:enable
                    else
                      p.target_dir
                    end

data/src/generators/type_generator.rb

@@ -83,16 +83,16 @@ module Foobara
                      value_to_ts_value(enum_item)
                    end.join(" | ")
                  else
-                   # :nocov:
+                   # simplecov:disable
                    raise "Haven't implemented other types yet"
-                   # :nocov:
+                   # simplecov:enable
                  end
 
           if declaration_data["allow_nil"]
             # TODO: add a custom type to the fixture manifest that includes allows_nil
-            # :nocov:
+            # simplecov:disable
             guts += " | undefined"
-            # :nocov:
+            # simplecov:enable
           end
 
           guts

data/src/generators/typescript_from_manifest_base_generator.rb

@@ -25,6 +25,25 @@ module Foobara
     module Generators
       class TypescriptFromManifestBaseGenerator < Foobara::FilesGenerator
         class << self
+          def requires_auth_command_generatable?(manifest)
+            return false if RemoteGenerator.no_foobara_auth?
+
+            root = manifest.root_manifest
+            commands = root[:command] || root["command"] || {}
+            names = commands.keys.to_set(&:to_s)
+
+            names.include?("Foobara::Auth::RefreshLogin") &&
+              names.intersect?(["Foobara::Auth::Login", "Foobara::Auth::Logout"].to_set)
+          end
+
+          def requires_auth_generator_for(manifest)
+            if requires_auth_command_generatable?(manifest)
+              Auth::RequiresAuthGenerator
+            else
+              CommandGenerator
+            end
+          end
+
           def manifest_to_generator_classes(manifest)
             case manifest
             when Manifest::Command
@@ -36,10 +55,10 @@ module Foobara
                                   when "Foobara::Auth::Logout"
                                     Auth::LogoutGenerator
                                   when /\bGetCurrentUser$/
-                                    Auth::RequiresAuthGenerator
+                                    requires_auth_generator_for(manifest)
                                   else
                                     if manifest.requires_authentication?
-                                      Auth::RequiresAuthGenerator
+                                      requires_auth_generator_for(manifest)
                                     else
                                       CommandGenerator
                                     end
@@ -87,9 +106,9 @@ module Foobara
             when Manifest::Type
               TypeGenerator
             else
-              # :nocov:
+              # simplecov:disable
               raise "Not sure how build a generator for a #{manifest}"
-              # :nocov:
+              # simplecov:enable
             end
           end
         end
@@ -98,9 +117,9 @@ module Foobara
           if none_given || relevant_manifest.is_a?(Manifest::BaseManifest)
             super
           else
-            # :nocov:
+            # simplecov:disable
             raise ArgumentError, "Expected a Foobara::Manifest, got #{relevant_manifest.class}"
-            # :nocov:
+            # simplecov:enable
           end
         end
 
@@ -136,10 +155,10 @@ module Foobara
           return @dependency_roots if defined?(@dependency_roots)
 
           unless dependency_group
-            # :nocov:
+            # simplecov:disable
             raise "This generator was created without a " \
                   "dependency_group and therefore cannot call #{__method__}"
-            # :nocov:
+            # simplecov:enable
           end
 
           @dependency_roots = dependency_group.non_colliding_dependency_roots.sort_by(&:scoped_full_name)
@@ -201,9 +220,9 @@ module Foobara
           when ::Symbol
             value.to_s.inspect
           else
-            # :nocov:
+            # simplecov:disable
             raise "Not sure how to represent #{value} in typescript. Maybe implement it."
-            # :nocov:
+            # simplecov:enable
           end
         end
 
@@ -241,18 +260,18 @@ module Foobara
 
                             if name
                               # TODO: test this code path or delete it
-                              # :nocov:
+                              # simplecov:disable
                               return is_empty ? "undefined" : "interface #{name} #{ts_type}"
-                              # :nocov:
+                              # simplecov:enable
                             else
                               is_empty ? "undefined" : ts_type
                             end
                           else
                             # TODO: test this path with an :attributes type (not extended from :attributes but
                             # the built-in type itself directly)
-                            # :nocov:
+                            # simplecov:disable
                             ts_type
-                            # :nocov:
+                            # simplecov:enable
                           end
                         elsif type_declaration.is_a?(Manifest::Array)
                           # TODO: which association_depth do we pass here?
@@ -328,9 +347,9 @@ module Foobara
             # TODO: Add description as a comment?
             name ? "type #{name} = #{type_string}" : type_string
           else
-            # :nocov:
+            # simplecov:disable
             raise "Not sure how to convert #{type_declaration} to a TS type"
-            # :nocov:
+            # simplecov:enable
           end
         end
 
@@ -378,9 +397,9 @@ module Foobara
           else
             # TODO: test this path with an :attributes type (not extended from :attributes but
             # the built-in type itself directly)
-            # :nocov:
+            # simplecov:disable
             "Record<string, any>"
-            # :nocov:
+            # simplecov:enable
           end
         end
 
@@ -399,9 +418,9 @@ module Foobara
                             when AssociationDepth::AGGREGATE
                               AggregateModelGenerator
                             else
-                              # :nocov:
+                              # simplecov:disable
                               raise "Bad association_depth: #{association_depth}"
-                              # :nocov:
+                              # simplecov:enable
                             end
 
           generator = generator_class.new(model)
@@ -435,6 +454,8 @@ module Foobara
         def auto_dirty_queries?
           RemoteGenerator.auto_dirty_queries?
         end
+
+        def env_expression = RemoteGenerator.env_expression
       end
     end
   end

data/src/remote_generator.rb

@@ -2,6 +2,8 @@ module Foobara
   module RemoteGenerator
     foobara_domain!
 
+    foobara_register_type(:env_expression, :string, one_of: ["import.meta.env", "process.env"])
+
     class << self
       def auto_dirty_queries(auto_dirty_queries)
         if auto_dirty_queries == @auto_dirty_queries
@@ -21,6 +23,33 @@ module Foobara
       def auto_dirty_queries?
         @auto_dirty_queries
       end
+
+      def no_foobara_auth(no_foobara_auth)
+        old = @no_foobara_auth
+        begin
+          @no_foobara_auth = no_foobara_auth
+          yield
+        ensure
+          @no_foobara_auth = old
+        end
+      end
+
+      def no_foobara_auth?
+        @no_foobara_auth
+      end
+
+      def with_env_expression(env_expression)
+        old = @env_expression
+
+        begin
+          @env_expression = env_expression
+          yield
+        ensure
+          @env_expression = old
+        end
+      end
+
+      attr_reader :env_expression
     end
   end
 end

data/src/write_typescript_to_disk.rb

@@ -15,6 +15,11 @@ module Foobara
         output_directory :string, default: "src/domains"
         fail_if_does_not_pass_linter :boolean, default: false
         auto_dirty_queries :boolean, default: false
+        no_foobara_auth :boolean,
+                        default: false,
+                        description: "Never generate Foobara::Auth's RequiresAuthCommand, even if the " \
+                                     "manifest contains that domain. For apps that import it from elsewhere."
+        env_expression :env_expression, default: "import.meta.env"
       end
 
       possible_error :missing_manifest
@@ -50,17 +55,13 @@ module Foobara
         # TODO: we need a way to allow values to be nil in type declarations
         inputs = raw_manifest ? { raw_manifest: } : { manifest_url: }
 
-        if auto_dirty_queries?
-          inputs[:auto_dirty_queries] = auto_dirty_queries
-        end
+        inputs[:auto_dirty_queries] = auto_dirty_queries
+        inputs[:no_foobara_auth] = no_foobara_auth
+        inputs[:env_expression] = env_expression
 
         self.paths_to_source_code = run_subcommand!(GenerateTypescript, inputs)
       end
 
-      def auto_dirty_queries?
-        auto_dirty_queries
-      end
-
       def run_post_generation_tasks
         Dir.chdir(project_directory || output_directory) do
           eslint_fix
@@ -74,7 +75,7 @@ module Foobara
           exit_status = wait_thr.value
 
           unless exit_status.success?
-            # :nocov:
+            # simplecov:disable
             out = stdout.read
             err = stderr.read
 
@@ -83,7 +84,7 @@ module Foobara
             else
               warn "WARNING: could not #{cmd}\n#{out}\n#{err}"
             end
-            # :nocov:
+            # simplecov:enable
           end
         end
       end

data/templates/Domain/config.ts.erb

@@ -1,4 +1,4 @@
-let _urlBase = import.meta.env.REACT_APP_FOOBARA_GLOBAL_URL_BASE
+let _urlBase = <%= env_expression %>.REACT_APP_FOOBARA_GLOBAL_URL_BASE
 
 const config = {
   get urlBase(): string {

data/templates/Organization/config.ts.erb

@@ -1,4 +1,4 @@
-let _urlBase = import.meta.env.REACT_APP_FOOBARA_GLOBAL_URL_BASE
+let _urlBase = <%= env_expression %>.REACT_APP_FOOBARA_GLOBAL_URL_BASE
 
 const config = {
   get urlBase(): string {

data/templates/base/RemoteCommand.ts.erb

@@ -15,7 +15,7 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
     let base = this._urlBase
 
     if (base == null) {
-      base = import.meta.env.REACT_APP_FOOBARA_GLOBAL_URL_BASE
+      base = <%= env_expression %>.REACT_APP_FOOBARA_GLOBAL_URL_BASE
     }
 
     if (base == null) {
@@ -121,7 +121,9 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
 
       this.outcome = new SuccessfulOutcome<Result, CommandError>(result)
       this.commandState = 'succeeded'
+<% if auto_dirty_queries? %>
       this.dirtyQueries()
+<% end %>
     } else if (response.status === 422 || response.status === 401 || response.status === 403) {
       this.commandState = 'errored'
       this.outcome = new ErrorOutcome<Result, CommandError>(body)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara-typescript-remote-command-generator
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Miles Georgi
@@ -153,13 +153,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 3.4.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Generates remote commands for Typescript from a foobara manifest
 test_files: []