foobara-typescript-remote-command-generator 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88862a0a23e8083e35cb4532b39dacd37ddc676106ef0256f4d44078b5e46e60
-  data.tar.gz: e40985f3adf7022efdf3cf85e655092909b35b9037c05edcd0f98106a6923d26
+  metadata.gz: '0778047e7295db9856a2f2c5907aa62e320857f514a29b68bd9eaf9a5f0c9df4'
+  data.tar.gz: 2a2e997115c42c315725afe2632c73359819a642d48f311d8efb14fee53798d9
 SHA512:
-  metadata.gz: e0ed06bab827629f9d05ddc065ff8ccc63a640f1cfa29cd3d2007a0e2aeab3db78505a4459feae8fccf0764b3817ce2cee9dffd58c4c05baa158e68949d4e1bf
-  data.tar.gz: c41a5cc46c96afa5cf537caba003925c880e861363060fd1859e6b95cd7a7bb747a435dc183c9c90bf52c976d7fd26741e40adc99b662f1d93390158a46f4713
+  metadata.gz: cdc5356fa30759987e1d854a7aab83aa9ad0bb7dd3194aa2d8156cf9871990e2d2904bd6bd3a2f2fb487e7125fe81d6677180f85726b7887300451bb71a97b74
+  data.tar.gz: 1bb61a8659f0816ffa2ebbd42065b2e3f34471820012a5c5528081229d83be1e857155c4a5655457890b5c30d622340e4b68b9b8e26b6f71734f3315c62aa0c5

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [unreleased] - 2024-08-2x
+
+- Add type generators to command result generator
+- Add type generators to domain generator
+
+## [0.0.2] - 2024-08-21
+
+- Add a TypeGenerator for custom non-model types
+
 ## [0.0.1] - 2024-06-17
 
 - Add Apache-2.0 license

data/src/remote_generator/services/command_inputs_generator.rb

@@ -14,18 +14,14 @@ module Foobara
           "Command/Inputs.ts.erb"
         end
 
-        def model_generators
-          @model_generators ||= inputs_types_depended_on.select(&:model?).uniq.map do |model|
-            if model.entity?
-              Services::EntityGenerator.new(model)
-            else
-              Services::ModelGenerator.new(model)
-            end
+        def type_generators
+          @type_generators ||= inputs_types_depended_on.reject(&:builtin?).uniq.map do |type|
+            TypeGenerator.new(type)
           end
         end
 
         def dependencies
-          model_generators
+          type_generators
         end
       end
     end

data/src/remote_generator/services/command_result_generator.rb

@@ -53,6 +53,22 @@ module Foobara
           end
         end
 
+        def type_generators
+          @type_generators ||= begin
+            type = result_type
+            type = type.to_type if result_type.is_a?(Manifest::TypeDeclaration)
+
+            if !type.builtin? && !type.model?
+              # TODO: Test this!!
+              # :nocov:
+              [TypeGenerator.new(type)]
+              # :nocov:
+            else
+              []
+            end
+          end
+        end
+
         def atom?
           serializers&.any? { |s| s == "Foobara::CommandConnectors::Serializers::AtomicSerializer" }
         end
@@ -72,7 +88,7 @@ module Foobara
         end
 
         def dependencies
-          model_generators
+          model_generators + type_generators
         end
       end
     end

data/src/remote_generator/services/domain_generator.rb

@@ -34,6 +34,18 @@ module Foobara
           end
         end
 
+        def type_generators
+          @type_generators ||= begin
+            # TODO: create a Manifest::Domain#custom_types
+            only_custom_types = domain_manifest.types.reject(&:model?)
+            only_custom_types.reject!(&:builtin?)
+
+            only_custom_types.map do |type|
+              TypeGenerator.new(type)
+            end
+          end
+        end
+
         def model_generators
           @model_generators ||= begin
             only_models = domain_manifest.models.reject(&:entity?)
@@ -45,7 +57,7 @@ module Foobara
         end
 
         def dependencies
-          [*command_generators, *model_generators, *entity_generators, *organization]
+          [*command_generators, *model_generators, *entity_generators, *type_generators, *organization]
         end
 
         def domain_name

data/src/remote_generator/services/error_generator.rb

@@ -50,6 +50,7 @@ module Foobara
         end
 
         def dependencies
+          # Why don't we need models and custom types?
           types_depended_on.select(&:entity?)
         end
 

data/src/remote_generator/services/model_generator.rb

@@ -1,9 +1,10 @@
 require_relative "typescript_from_manifest_base_generator"
+require_relative "type_generator"
 
 module Foobara
   module RemoteGenerator
     class Services
-      class ModelGenerator < TypescriptFromManifestBaseGenerator
+      class ModelGenerator < TypeGenerator
         class << self
           def new(relevant_manifest)
             return super unless self == ModelGenerator
@@ -26,57 +27,12 @@ module Foobara
           ["Model", "Model.ts.erb"]
         end
 
-        def scoped_full_path(points = nil)
-          full_path = model_manifest.scoped_full_path
-
-          if points
-            start_at = full_path.size - points - 1
-            full_path[start_at..]
-          else
-            full_path
-          end
-        end
-
         def model_name(points = nil)
-          if points
-            scoped_full_path(points).join(".")
-          else
-            scoped_path.join(".")
-          end
-        end
-
-        # Do models have associations??
-        def model_generators
-          types_depended_on.select(&:model?).map do |model|
-            Services::ModelGenerator.new(model)
-          end
-        end
-
-        def dependencies
-          model_generators
+          type_name(points)
         end
 
         def model_name_downcase
-          model_name[0].downcase + model_name[1..]
-        end
-
-        def attributes_type_ts_type
-          association_depth = AssociationDepth::AMBIGUOUS
-          foobara_type_to_ts_type(attributes_type, association_depth:, dependency_group:)
-        end
-
-        def atom_attributes_ts_type
-          association_depth = AssociationDepth::ATOM
-          foobara_type_to_ts_type(attributes_type, association_depth:, dependency_group:)
-        end
-
-        def aggregate_attributes_ts_type
-          association_depth = AssociationDepth::AGGREGATE
-          foobara_type_to_ts_type(attributes_type, association_depth:, dependency_group:)
-        end
-
-        def attribute_names
-          attributes_type.attribute_names
+          type_name_downcase
         end
       end
     end

data/src/remote_generator/services/type_generator.rb

@@ -0,0 +1,112 @@
+require_relative "typescript_from_manifest_base_generator"
+
+module Foobara
+  module RemoteGenerator
+    class Services
+      class TypeGenerator < TypescriptFromManifestBaseGenerator
+        class << self
+          def new(relevant_manifest)
+            return super unless self == TypeGenerator
+
+            if relevant_manifest.entity?
+              EntityGenerator.new(relevant_manifest)
+            elsif relevant_manifest.model?
+              ModelGenerator.new(relevant_manifest)
+            else
+              super
+            end
+          end
+        end
+
+        alias type_manifest relevant_manifest
+
+        def target_path
+          [*domain.scoped_full_path, "types", "#{type_name}.ts"]
+        end
+
+        def template_path
+          ["Type", "Type.ts.erb"]
+        end
+
+        def scoped_full_path(points = nil)
+          full_path = type_manifest.scoped_full_path
+
+          if points
+            start_at = full_path.size - points - 1
+            full_path[start_at..]
+          else
+            full_path
+          end
+        end
+
+        def type_name(points = nil)
+          if points
+            scoped_full_path(points).join(".")
+          else
+            scoped_path.join(".")
+          end
+        end
+
+        def type_guts
+          guts = if declaration_data.key?("one_of")
+                   declaration_data["one_of"].map do |enum_item|
+                     value_to_ts_value(enum_item)
+                   end.join(" | ")
+                 else
+                   # :nocov:
+                   raise "Haven't implemented other types yet"
+                   # :nocov:
+                 end
+
+          if declaration_data["allows_nil"]
+            # TODO: add a custom type to the fixture manifest that includes allows_nil
+            # :nocov:
+            guts += " | undefined"
+            # :nocov:
+          end
+
+          guts
+        end
+
+        def model_generators
+          @model_generators ||= types_depended_on.select(&:model?).map do |model|
+            Services::ModelGenerator.new(model)
+          end
+        end
+
+        def custom_type_generators
+          @custom_type_generators ||= types_depended_on.reject(&:builtin?).reject(&:model?).map do |type|
+            Services::TypeGenerator.new(type)
+          end
+        end
+
+        def dependencies
+          custom_type_generators + model_generators
+        end
+
+        def type_name_downcase
+          type_name[0].downcase + type_name[1..]
+        end
+
+        def attributes_type_ts_type
+          association_depth = AssociationDepth::AMBIGUOUS
+          foobara_type_to_ts_type(attributes_type, association_depth:, dependency_group:)
+        end
+
+        def atom_attributes_ts_type
+          association_depth = AssociationDepth::ATOM
+          foobara_type_to_ts_type(attributes_type, association_depth:, dependency_group:)
+        end
+
+        def aggregate_attributes_ts_type
+          association_depth = AssociationDepth::AGGREGATE
+          foobara_type_to_ts_type(attributes_type, association_depth:, dependency_group:)
+        end
+
+        def attribute_names
+          attributes_type.attribute_names
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/typescript_from_manifest_base_generator.rb

@@ -66,6 +66,8 @@ module Foobara
               Services::ProcessorClassGenerator
             when Manifest::RootManifest
               Services::RootManifestGenerator
+            when Manifest::Type
+              Services::TypeGenerator
             else
               # :nocov:
               raise "Not sure how build a generator for a #{manifest}"
@@ -224,6 +226,10 @@ module Foobara
                           else
                             if type_declaration.model?
                               model_to_ts_model_name(type_declaration, association_depth:, initial:)
+                            elsif can_convert_type_declaration_to_ts_type?(type_declaration)
+                              type = type_declaration.to_type
+
+                              custom_type_to_ts_type_name(type)
                             end
                           end
                         end
@@ -245,6 +251,22 @@ module Foobara
           end
         end
 
+        def can_convert_type_declaration_to_ts_type?(type_declaration)
+          type = type_declaration.to_type
+
+          return false if BuiltinTypes.builtin_reference?(type.reference)
+
+          allowed_keys = %w[type one_of allows_nil]
+
+          declaration_data = type.declaration_data
+
+          bad_keys = declaration_data.keys - allowed_keys
+
+          return false unless bad_keys.empty?
+
+          BuiltinTypes.builtin_reference?(declaration_data["type"])
+        end
+
         def attributes_to_ts_type(attributes, dependency_group:, association_depth: AssociationDepth::AMBIGUOUS)
           guts = attributes.attribute_declarations.map do |attribute_name, attribute_declaration|
             "  #{attribute_name}#{"?" unless attributes.required?(attribute_name)}: #{
@@ -280,6 +302,13 @@ module Foobara
           dependency_group.non_colliding_type(generator)
         end
 
+        def custom_type_to_ts_type_name(type)
+          type = type.to_type if type.is_a?(Manifest::TypeDeclaration)
+          generator = TypeGenerator.new(type)
+
+          dependency_group.non_colliding_type(generator)
+        end
+
         def ==(other)
           self.class == other.class && path == other.path && root_manifest == other.root_manifest
         end

data/templates/Type/Type.ts.erb

@@ -0,0 +1,5 @@
+<% dependency_roots.each do |dependency_root| %>
+import { <%= dependency_root.ts_instance_name %> } from "<%= path_to_root %><%= dependency_root.import_path %>"
+<% end %>
+
+export type <%= type_name %> = <%= type_guts %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foobara-typescript-remote-command-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Miles Georgi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - azimux@gmail.com
 executables: []
@@ -82,6 +82,7 @@ files:
 - src/remote_generator/services/organization_manifest_generator.rb
 - src/remote_generator/services/processor_class_generator.rb
 - src/remote_generator/services/root_manifest_generator.rb
+- src/remote_generator/services/type_generator.rb
 - src/remote_generator/services/typescript_from_manifest_base_generator.rb
 - src/remote_generator/services/unloaded_entity_generator.rb
 - src/remote_generator/write_typescript_to_disk.rb
@@ -105,6 +106,7 @@ files:
 - templates/ModelVariants.ts.erb
 - templates/Organization.ts.erb
 - templates/Organization/config.ts.erb
+- templates/Type/Type.ts.erb
 - templates/base/DataPath.ts
 - templates/base/Entity.ts
 - templates/base/Error.ts
@@ -120,7 +122,7 @@ metadata:
   source_code_uri: https://github.com/foobara/typescript-remote-command-generator
   changelog_uri: https://github.com/foobara/typescript-remote-command-generator/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Generates remote commands for Typescript from a foobara manifest
 test_files: []