foobara-typescript-remote-command-generator 0.0.16 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f71e4e6218587eee34596a8ce72c35e41e17da8ae5a4740f2a847c5a91a01494
-  data.tar.gz: ea0628600beba45ad19318a586bb870ecfbebf967d53858c7ae1eb39ece3689e
+  metadata.gz: e1dd99a53687e32719ab1a6319b82b07cb180740b42083d7ae2201b9bdc900b8
+  data.tar.gz: b8258124ee94a323e03b278b29b3c89d137d68cc86e819c23c7f575a12442989
 SHA512:
-  metadata.gz: 8511b40e771e3c6c7f46d073fbae7d71f6c2df95947bc6d4c5bf6be11c6e7c6858b39a9a5d603691ee2cfa769329fde3416787ed1567bc27cd78dc1532408465
-  data.tar.gz: 1df40a88ab89a6e6ee83dd250a6965054069b1e958e7c0919a12b794273b3379e72c13ee585c980c2e4dd06f467cd459f66747440f656d529c5c971e8625f055
+  metadata.gz: 34d492c9189a229145a184607896e6154260a0ea5a924a59f4b0ce0434d7cf21dc984580c573ab75a85c9d69f045df21c22b40890f8ba9ef91198862fe3a3554
+  data.tar.gz: bd54735d7293ea6a57519d22bdc44ce48f26afbac98e688124bb896864230dc5df0824b7eae11b3919741aa8ff7c3a75a31cf19728d76e3dd9aa47367dd8d96e

data/CHANGELOG.md

@@ -1,6 +1,15 @@
+## [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
 
-- Add a bunch of special-case support for Foobara::Auth domain  convenience
+- Add a bunch of special-case support for Foobara::Auth domain convenience
 
 ## [0.0.15] - 2025-03-30
 

data/src/remote_generator/services/command_inputs_generator.rb

@@ -14,8 +14,18 @@ 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
+          inputs_types_depended_on.reject { |type| type.model? || type.entity? }.reject(&:builtin?).uniq
+        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,12 +204,20 @@ 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?
 
                           if name
+                            # TODO: test this code path or delete it
+                            # :nocov:
                             return is_empty ? "undefined" : "interface #{name} #{ts_type}"
+                            # :nocov:
                           else
                             is_empty ? "undefined" : ts_type
                           end
@@ -218,7 +227,8 @@ module Foobara
                             type_declaration.element_type,
                             association_depth:,
                             dependency_group:,
-                            initial: false
+                            initial: false,
+                            model_and_entity_free:
                           )
                           "#{ts_type}[]"
                         else
@@ -238,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.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
@@ -262,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,4 +2,6 @@
   import <%= dependency_root.import_destructure %> from "<%= path_to_root %><%= dependency_root.import_path %>"
 <% end %>
 
-export default <%= foobara_type_to_ts_type(inputs_type, name: "Inputs", 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,28 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foobara-typescript-remote-command-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: foobara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.88
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.88
 - !ruby/object:Gem::Dependency
   name: foobara-files-generator
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Generates remote commands for Typescript from a foobara manifest
 test_files: []