foobara-typescript-remote-command-generator 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f783af32070cfcdc33c70d34c1b755a66a0a6bb3df7b7e8697345bdc1d148f7
-  data.tar.gz: fdcfa71700d34b3c42163b586fc2f8cb1c90f420bef3fb76f7a8a5a8d29e6423
+  metadata.gz: 267ff33f2580961f0aae6027f8b986587950b26e5866297af2d2a461e3b8e954
+  data.tar.gz: e61dedc94508e92667d75d3b9bb35d2eab25b9d4a9485ad2a40e571417744039
 SHA512:
-  metadata.gz: b5b5d35cc80f88622f2a4ea321574a7af55e9c61ec7bde32d42761a9d9511af07ced97894f4905962bb1803c1871d9a8ab4c9c83722df5caefffe7342b90e474
-  data.tar.gz: 6d0a1fcb787dc719a330bd58953d42e387f931b35a2eb3d6168ab0d0dfbdec166a1f2215339ea7046b3edfc00473365cdca75e6846408014ed96a3f04d6ef3d8
+  metadata.gz: 4de3ce62b189e7696e63a10940325ec2a6bf1fed29a13b1c0b3087fb9ac30e8be82c16cf5102bf31d2ae945b5abdec888dbf0a4093d582d5ca2d2634a955054b
+  data.tar.gz: 2ff54bbac0ad37b6b29814f07226260ab732e02c73f25df1e9ed7b2950439ceeaf3aaff70d93ebc599672256eefdc057dbc710168715e1ca370132d645047529

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [1.2.2] - 2026-01-24
+
+- Add support for an app model named Model, which collide's with Foobara's Model
+- Fixes a bug when the superclass we import collides with dependencies
+- Fixes a bug where a dependency collides with something we're generating
+
+## [1.2.1] - 2025-12-19
+
+- Handle some .foobara_delegate and #path 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

data/src/remote_generator/services/aggregate_entity_generator.rb

@@ -30,22 +30,28 @@ module Foobara
           end
         end
 
+        def dependencies
+          [*super, superclass_generator]
+        end
+
+        def collision_winners
+          superclass_generator
+        end
+
+        def superclass_generator
+          @superclass_generator ||= LoadedEntityGenerator.new(relevant_manifest)
+        end
+
         def attributes_type_ts_type
           aggregate_attributes_ts_type
         end
 
         def ts_instance_path
-          *prefix, name = scoped_path
-          [*prefix, "#{name}Aggregate"]
-        end
-
-        def ts_instance_full_path
-          *prefix, name = scoped_full_path
-          [*prefix, "#{name}Aggregate"]
+          [*model_prefix, generated_type]
         end
 
-        def import_destructure
-          "{ #{scoped_short_name}Aggregate }"
+        def generated_type
+          "#{scoped_short_name}Aggregate"
         end
       end
     end

data/src/remote_generator/services/aggregate_model_generator.rb

@@ -38,9 +38,12 @@ module Foobara
           aggregate_attributes_ts_type
         end
 
-        def ts_instance_full_path
-          *prefix, name = scoped_full_path
-          [*prefix, "#{name}Aggregate"]
+        def ts_instance_path
+          [*model_prefix, generated_type]
+        end
+
+        def generated_type
+          "#{scoped_short_name}Aggregate"
         end
       end
     end

data/src/remote_generator/services/atom_entity_generator.rb

@@ -33,17 +33,11 @@ module Foobara
         end
 
         def ts_instance_path
-          *prefix, name = scoped_path
-          [*prefix, "#{name}Atom"]
+          [*model_prefix, generated_type]
         end
 
-        def ts_instance_full_path
-          *prefix, name = scoped_full_path
-          [*prefix, "#{name}Atom"]
-        end
-
-        def import_destructure
-          "{ #{scoped_short_name}Atom }"
+        def generated_type
+          "#{scoped_short_name}Atom"
         end
       end
     end

data/src/remote_generator/services/atom_model_generator.rb

@@ -34,9 +34,12 @@ module Foobara
           end
         end
 
-        def ts_instance_full_path
-          *prefix, name = scoped_full_path
-          [*prefix, "#{name}Atom"]
+        def ts_instance_path
+          [*model_prefix, generated_type]
+        end
+
+        def generated_type
+          "#{scoped_short_name}Atom"
         end
       end
     end

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/dependency_group.rb

@@ -10,11 +10,14 @@ module Foobara
           end
         end
 
-        attr_accessor :dependencies, :name
+        attr_accessor :dependencies, :name, :will_define, :deps_are_for, :winners
 
-        def initialize(dependencies, name:)
+        def initialize(dependencies, name:, deps_are_for:, will_define:, winners: nil)
+          self.deps_are_for = deps_are_for
+          self.will_define = will_define
           self.name = name
           self.dependencies = dependencies.to_set
+          self.winners = [*winners] if winners
 
           find_collisions
         end
@@ -57,18 +60,17 @@ module Foobara
         def non_colliding_root(dep)
           root = dep
           points = points_for(dep)
-          points_climbed = 0
+          points_climbed = dep.ts_instance_path.size
 
           until points_climbed >= points
-            # TODO: can't use scoped_path because sometimes we want UnloadedUser instead of User. How to fix??
-            points_climbed += dep.scoped_path.size
+            points_climbed += dep.ts_instance_path.size
             root = root.parent
           end
 
           root
         end
 
-        def points_for(dep)
+        def raw_points_for(dep)
           points = collision_data_for(dep).points
 
           unless points
@@ -80,6 +82,14 @@ module Foobara
           points
         end
 
+        def points_for(dep)
+          if winners&.include?(dep)
+            0
+          else
+            raw_points_for(dep)
+          end
+        end
+
         def non_colliding_type_name(dep, points = points_for(dep))
           non_colliding_type_path(dep, points).join(".")
         end
@@ -89,16 +99,31 @@ module Foobara
         end
 
         def non_colliding_type_path(dep, points = points_for(dep))
-          start_at = dep.ts_type_full_path.size - points - 1
-          path = dep.ts_type_full_path[start_at..] || []
+          if points == 0
+            path = dep.ts_instance_path
+            return path.size == 1 ? path : [path.last]
+          end
+
+          path = dep.ts_instance_path
+          paths = [path]
+          points_climbed = path.size
 
-          path.map(&:to_s)
+          until points_climbed >= points
+            dep = dep.parent
+            break unless dep
+
+            path = dep.ts_instance_path
+            paths.unshift(path)
+            points_climbed += path.size
+          end
+
+          paths.flatten
         end
 
         private
 
         def find_collisions
-          dependencies.each do |dep|
+          [deps_are_for, *dependencies].each do |dep|
             collision_data = CollisionData.new
 
             points = 0
@@ -110,6 +135,10 @@ module Foobara
                 dep != other_dep && name == non_colliding_type_name(other_dep, points)
               end
 
+              if will_define&.include?(name)
+                collisions << deps_are_for
+              end
+
               if collisions.empty?
                 collision_data.points = points
                 set_collision_data_for(dep, collision_data)

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/entity_generator.rb

@@ -14,6 +14,10 @@ module Foobara
           ["Entity", "Ambiguous.ts.erb"]
         end
 
+        def ts_instance_path
+          [*model_prefix, scoped_short_name]
+        end
+
         def entity_name(...)
           model_name(...)
         end
@@ -41,6 +45,14 @@ module Foobara
         def association_property_paths_ts
           associations.keys.map { |k| DataPath.parse(k).path.map(&:to_s) }.inspect
         end
+
+        def will_define
+          [generated_type]
+        end
+
+        def generated_type
+          entity_short_name
+        end
       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
@@ -56,16 +58,6 @@ module Foobara
         def dependencies
           @dependencies ||= types_depended_on.select { |type| type.detached_entity? || type.custom? || type.model? }
         end
-
-        def ts_type_full_path
-          if parent.is_a?(CommandGenerator)
-            p = super.dup
-            p[-2] += "Errors"
-            p
-          else
-            super
-          end
-        end
       end
     end
   end

data/src/remote_generator/services/loaded_entity_generator.rb

@@ -13,17 +13,11 @@ module Foobara
         end
 
         def ts_instance_path
-          *prefix, name = super
-          [*prefix, "Loaded#{name}"]
+          [*model_prefix, generated_type]
         end
 
-        def ts_instance_full_path
-          *prefix, name = super
-          [*prefix, "Loaded#{name}"]
-        end
-
-        def import_destructure
-          "{ Loaded#{scoped_short_name} }"
+        def generated_type
+          "Loaded#{scoped_short_name}"
         end
       end
     end

data/src/remote_generator/services/model_generator.rb

@@ -23,6 +23,10 @@ module Foobara
           [*domain.scoped_full_path, "Types", *model_prefix, model_short_name, "#{model_short_name}.ts"]
         end
 
+        def ts_instance_path
+          [*model_prefix, scoped_short_name]
+        end
+
         def model_short_name
           type_short_name
         end
@@ -42,6 +46,14 @@ module Foobara
         def model_name_downcase
           type_name_downcase
         end
+
+        def generated_type
+          model_short_name
+        end
+
+        def import_destructure
+          "{ #{generated_type} }"
+        end
       end
     end
   end

data/src/remote_generator/services/typescript_from_manifest_base_generator.rb

@@ -120,10 +120,18 @@ module Foobara
               generator_for(dependency)
             end
 
-            DependencyGroup.new(generators, name: scoped_full_path.join("."))
+            DependencyGroup.new(generators,
+                                deps_are_for: self,
+                                name: scoped_full_path.join("."),
+                                will_define:,
+                                winners: collision_winners)
           end
         end
 
+        def will_define
+          nil
+        end
+
         def dependency_roots
           return @dependency_roots if defined?(@dependency_roots)
 
@@ -137,6 +145,8 @@ module Foobara
           @dependency_roots = dependency_group.non_colliding_dependency_roots.sort_by(&:scoped_full_name)
         end
 
+        def collision_winners = nil
+
         def ts_instance_path
           scoped_path
         end
@@ -146,16 +156,11 @@ module Foobara
         end
 
         def ts_instance_full_path
-          scoped_full_path
-        end
-
-        def ts_type_full_path
-          ts_instance_full_path
+          [*parent&.scoped_full_path, *ts_instance_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
@@ -394,12 +399,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

data/src/remote_generator/services/unloaded_entity_generator.rb

@@ -10,13 +10,12 @@ module Foobara
           ["Entity", "Unloaded.ts.erb"]
         end
 
-        def ts_instance_full_path
-          *prefix, name = super
-          [*prefix, "Unloaded#{name}"]
+        def ts_instance_path
+          [*model_prefix, generated_type]
         end
 
-        def import_destructure
-          "{ Unloaded#{scoped_short_name} }"
+        def generated_type
+          "Unloaded#{scoped_short_name}"
         end
       end
     end

data/src/remote_generator/write_typescript_to_disk.rb

@@ -3,30 +3,20 @@ require_relative "generate_typescript"
 module Foobara
   module RemoteGenerator
     class WriteTypescriptToDisk < Generators::WriteGeneratedFilesToDisk
-      class << self
-        def generator_key
-          "typescript-remote-commands"
-        end
-      end
-
-      # TODO: shouldn't have to qualify DataError like this
-      class MissingManifestError < Value::DataError
-        class << self
-          def context_type_declaration
-            {}
-          end
-        end
-      end
-
-      possible_error MissingManifestError
+      def self.generator_key = "typescript-remote-commands"
 
       inputs do
         raw_manifest :associative_array, :allow_nil
         manifest_url :string, :allow_nil
         # TODO: should be able to delete this and inherit it
+        project_directory :string, :allow_nil, "This lets you specify a directory to run the linter or npm run build in"
         output_directory :string, default: "src/domains"
+        fail_if_does_not_pass_linter :boolean, default: false
       end
 
+      possible_error :missing_manifest
+      possible_error :failed_to_lint, context: -> { stdout :string, :required; stderr :string, :required }
+
       depends_on GenerateTypescript
 
       def execute
@@ -40,13 +30,16 @@ module Foobara
       end
 
       def validate
+        # TODO: kind of strange that we have to use a runtime error here. Maybe if input errors
+        # supported the concept of multiple inputs this would be cleaner?
         if raw_manifest.nil? && manifest_url.nil?
-          add_input_error(
-            MissingManifestError.new(
-              message: "Must provide either raw_manifest or manifest_url",
-              context: {}
-            )
-          )
+          # TODO: we should support a sugar like:
+          # add_runtime_error(
+          #   :missing_manifest,
+          #   "Must provide either raw_manifest or manifest_url",
+          #   some_context_item: "blah"
+          # )
+          add_runtime_error(symbol: :missing_manifest, message: "Must provide either raw_manifest or manifest_url")
         end
       end
 
@@ -58,21 +51,33 @@ module Foobara
       end
 
       def run_post_generation_tasks
-        eslint_fix
+        Dir.chdir(project_directory || output_directory) do
+          eslint_fix
+        end
       end
 
       def eslint_fix
         cmd = "npx eslint 'src/**/*.{js,jsx,ts,tsx}' --fix"
 
-        Open3.popen3(cmd) do |_stdin, _stdout, stderr, wait_thr|
+        Open3.popen3(cmd) do |_stdin, stdout, stderr, wait_thr|
           exit_status = wait_thr.value
+
           unless exit_status.success?
             # :nocov:
-            warn "WARNING: could not #{cmd}\n#{stderr.read}"
+            out = stdout.read
+            err = stderr.read
+
+            if fail_if_does_not_pass_linter?
+              add_runtime_error :failed_to_lint, stdout: out, stderr: err
+            else
+              warn "WARNING: could not #{cmd}\n#{out}\n#{err}"
+            end
             # :nocov:
           end
         end
       end
+
+      def fail_if_does_not_pass_linter? = fail_if_does_not_pass_linter
     end
   end
 end

data/templates/Entity/Aggregate.ts.erb

@@ -1,7 +1,7 @@
 import {
   <%= entity_short_name %>AttributesType
 } from "./Ambiguous"
-import { Loaded<%= entity_short_name %> } from "./Loaded"
+
 <% dependency_roots.each do |dependency_root| %>
 import <%= dependency_root.import_destructure %> from "<%= path_to_root %><%= dependency_root.import_path %>"
 <% end %>

data/templates/Model/Model.ts.erb

@@ -1,4 +1,4 @@
-import { Model } from "<%= path_to_root %>base/Model"
+import { Model as FoobaraModel } from "<%= path_to_root %>base/Model"
 <% dependency_roots.each do |dependency_root| %>
 import <%= dependency_root.import_destructure %> from "<%= path_to_root %><%= dependency_root.import_path %>"
 <% end %>
@@ -7,7 +7,7 @@ export interface <%= model_short_name %>AttributesType <%= attributes_type_ts_ty
 
 export class <%= model_short_name %><
   AttributesType extends <%= model_short_name %>AttributesType = <%= model_short_name %>AttributesType
-> extends Model<AttributesType> {
+> extends FoobaraModel<AttributesType> {
   static readonly modelName: string = "<%= model_short_name %>"
 
   <% attribute_names.each do |attribute_name| %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara-typescript-remote-command-generator
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Miles Georgi