foobara-typescript-remote-command-generator 0.0.17 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0edeec83ef5a6e8fdd8f4b0bf8352c0791a593386aec53f70724d3437b7b3b13
-  data.tar.gz: c80f2d935699af9c03f0af3e0db70e9f411299d8017790cd78ae865fe21573eb
+  metadata.gz: 2cc51a16bfdbedc2c4d5a9f37d387c88a40bffe9b6c53354eb92a0c72d08b8a6
+  data.tar.gz: 51ad94eefd521eae56c332c6893c15dc5773e6536d0f009561f1f8670ac35d08
 SHA512:
-  metadata.gz: acb79c060d229a21d77a0962f72e6ce30adadd7a513ab061725d3fde6a60a414bf0fd5b917d48df58ecaf0012290d6021886ddcf3a11913f9ed798bff2018d63
-  data.tar.gz: caea17f1356db403b37e29bc6edeefea58107e94b57f3d4bc19987ae9c1b112e506f3248c1468cbb07746947604f0a95a68368380d2633e9e835b00d2dba3d96
+  metadata.gz: f932745cf47d642490dc4ec1d45c76e89a80d0600e72dd5b3e45a87d58f8b242c0d7683679982588f8d6685f6c28486a8786722217e1f6c664debba9fd4fc0f7
+  data.tar.gz: 563901c212a0c14ff26b7b24b5aa50b2a518b4c63358bf50927b8806c7197503deda60e391d14c20255b3402da26955e4a7e5292c03db211d59152e187310baf

data/CHANGELOG.md

@@ -1,6 +1,15 @@
+## [0.0.19] - 2025-04-25
+
+- Fix bugs causing issues with generating command inputs for entities or custom types
+
+## [0.0.18] - 2025-04-15
+
+- Don't make use of Model/Entity in input types
+- Add toJSON methods to Model and Entity for proper serialization when building inputs
+
 ## [0.0.17] - 2025-04-08
 
-- 
+- Handle undefined/empty inputs in Inputs.ts.erb
 
 ## [0.0.16] - 2025-03-31
 

data/src/remote_generator/services/command_inputs_generator.rb

@@ -14,8 +14,34 @@ module Foobara
           "Command/Inputs.ts.erb"
         end
 
+        # TODO: we should break the various TypeScript WhateverAttributesType and
+        # WhateverPrimaryKeyType into separate generators with separate templates so
+        # we can use those types instead of constructing new types from the attributes/primary keys
+        # of models/entities.
+        # Instead, for now, we will just translate input types to not have entities/models
+        # by converting models to their attributes and entities to their primary keys.
+        def model_and_entity_free_types_depended_on(types_to_consider = inputs_types_depended_on)
+          types = []
+
+          types_to_consider.each do |type|
+            if type.is_a?(Manifest::TypeDeclaration)
+              type = type.to_type
+            end
+
+            if type.detached_entity?
+              types += model_and_entity_free_types_depended_on([type.primary_key_type])
+            elsif type.model?
+              types += model_and_entity_free_types_depended_on(type.types_depended_on)
+            elsif !type.builtin?
+              types << type
+            end
+          end
+
+          types
+        end
+
         def type_generators
-          @type_generators ||= inputs_types_depended_on.reject(&:builtin?).uniq.map do |type|
+          @type_generators ||= model_and_entity_free_types_depended_on.uniq.map do |type|
             TypeGenerator.new(type)
           end
         end

data/src/remote_generator/services/command_result_generator.rb

@@ -29,7 +29,7 @@ module Foobara
                               elsif aggregate?
                                 AggregateEntityGenerator
                               else
-                                EntityGenerator
+                                TypeGenerator
                               end
 
             entity = if type.entity?
@@ -45,7 +45,7 @@ module Foobara
                               elsif aggregate?
                                 AggregateModelGenerator
                               else
-                                ModelGenerator
+                                TypeGenerator
                               end
 
             [generator_class.new(type.to_model)]

data/src/remote_generator/services/typescript_from_manifest_base_generator.rb

@@ -195,7 +195,8 @@ module Foobara
           dependency_group: self.dependency_group,
           name: nil,
           association_depth: AssociationDepth::AMBIGUOUS,
-          initial: true
+          initial: true,
+          model_and_entity_free: false
         )
           if type_declaration.is_a?(Manifest::Error)
             error_generator = generator_for(type_declaration)
@@ -203,7 +204,12 @@ module Foobara
           end
 
           type_string = if type_declaration.is_a?(Manifest::Attributes)
-                          ts_type = attributes_to_ts_type(type_declaration, association_depth:, dependency_group:)
+                          ts_type = attributes_to_ts_type(
+                            type_declaration,
+                            association_depth:,
+                            dependency_group:,
+                            model_and_entity_free:
+                          )
 
                           is_empty = type_declaration.attribute_declarations.empty?
 
@@ -221,7 +227,8 @@ module Foobara
                             type_declaration.element_type,
                             association_depth:,
                             dependency_group:,
-                            initial: false
+                            initial: false,
+                            model_and_entity_free:
                           )
                           "#{ts_type}[]"
                         else
@@ -241,7 +248,25 @@ module Foobara
                             "Date"
                           else
                             if type_declaration.model?
-                              model_to_ts_model_name(type_declaration, association_depth:, initial:)
+                              if model_and_entity_free
+                                model_type = type_declaration.to_type
+
+                                translated_type = if type_declaration.detached_entity?
+                                                    model_type.primary_key_type
+                                                  else
+                                                    model_type.attributes_type
+                                                  end
+
+                                foobara_type_to_ts_type(
+                                  translated_type,
+                                  association_depth:,
+                                  dependency_group:,
+                                  initial:,
+                                  model_and_entity_free:
+                                )
+                              else
+                                model_to_ts_model_name(type_declaration, association_depth:, initial:)
+                              end
                             elsif type_declaration.custom?
                               custom_type_to_ts_type_name(type_declaration)
                             end
@@ -265,10 +290,21 @@ module Foobara
           end
         end
 
-        def attributes_to_ts_type(attributes, dependency_group:, association_depth: AssociationDepth::AMBIGUOUS)
+        def attributes_to_ts_type(
+          attributes,
+          dependency_group:,
+          association_depth: AssociationDepth::AMBIGUOUS,
+          model_and_entity_free: false
+        )
           guts = attributes.attribute_declarations.map do |attribute_name, attribute_declaration|
             "  #{attribute_name}#{"?" unless attributes.required?(attribute_name)}: #{
-              foobara_type_to_ts_type(attribute_declaration, dependency_group:, association_depth:, initial: false)
+              foobara_type_to_ts_type(
+                attribute_declaration,
+                dependency_group:,
+                association_depth:,
+                initial: false,
+                model_and_entity_free:
+              )
             }"
           end.join("\n")
 

data/templates/Command/Inputs.ts.erb

@@ -2,6 +2,6 @@
   import <%= dependency_root.import_destructure %> from "<%= path_to_root %><%= dependency_root.import_path %>"
 <% end %>
 
-type Inputs = <%= foobara_type_to_ts_type(inputs_type, dependency_group:) %>
+type Inputs = <%= foobara_type_to_ts_type(inputs_type, dependency_group:, model_and_entity_free: true) %>
 
 export default Inputs

data/templates/Entity/Ambiguous.ts.erb

@@ -26,5 +26,4 @@ export class <%= entity_short_name %><
     return this.readAttribute("<%= attribute_name %>")
   }
   <% end %>
-
 }

data/templates/base/Entity.ts

@@ -84,4 +84,8 @@ export abstract class Entity<PrimaryKeyType extends EntityPrimaryKeyType, Attrib
 
     return this._attributes
   }
+
+  override toJSON (): unknown {
+    return this.primaryKey
+  }
 }

data/templates/base/Model.ts

@@ -21,4 +21,8 @@ export abstract class Model<AttributesType> {
   readAttribute<T extends keyof this["_attributes"]>(attributeName: T): this["_attributes"][T] {
     return (this.attributes as unknown as this["_attributes"])[attributeName]
   }
+
+  toJSON (): unknown {
+    return this._attributes
+  }
 }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara-typescript-remote-command-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.19
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-04-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara-files-generator
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Generates remote commands for Typescript from a foobara manifest
 test_files: []