foobara-typescript-remote-command-generator 0.0.24 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46c714c0eb18fde6fcf73ce38aaa8b3f561bf5801f63eb080ac134cb92a46cb4
-  data.tar.gz: 249bf1a42385f4eee8c35400c92681c558dcb4ff088c7c8a1619809d2477e9b2
+  metadata.gz: 2b714e6eec1090af9247514d151a2e72e4a9577d17c3adbde2e15964ae1bd18c
+  data.tar.gz: a200de6d84262582fe8a2e79df98c04142e6a01fe1932e11341082d6d49d3c06
 SHA512:
-  metadata.gz: 9784818a6ac63aab255b0e186fe0ff826cf355e5ebb753255abf2e2b6ea13c64b1836aa6e9e4f510f7948ed4eb2eccf2f6bac766e575c6c2ea2249785ac82778
-  data.tar.gz: 271b4bbf8db8affb1c1e782428d3ae0282d526598027995593c12b0c141300a4d4e9097e9d7b19cf5adeece2fef31447ad62336ac641c15be935c25a98c6dbb1
+  metadata.gz: 9c2eb881fe792592c5ed08cff88cf9b20d797fdb4ca08fbae5e416a9243a7d4d3d5505d1b744148d48d3fd64a629d3d7922c07262b393d14e2bfa8e6d74ac787
+  data.tar.gz: edc6d812189f61711f968f8d317dd79ef44e1ad51db573e059f0cdc5777c1da35b2693fc19b586c2b8bfe5309ab3fb030847a3ad130d3abeff8f814c9cbbbf60

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [1.0.0] - 2025-07-31
+
+- Create never types for Error/PossibleErrors when command cannot error
+- Support built-in non-extended attributes type
+
 ## [0.0.24] - 2025-05-14
 
 - Fix bugs with setup.ts

data/src/remote_generator/services/command_errors_generator.rb

@@ -15,6 +15,10 @@ module Foobara
           "Command/Errors.ts.erb"
         end
 
+        def has_possible_errors?
+          error_generators.any?
+        end
+
         def error_generators
           @error_generators ||= possible_errors.values.map(&:error).sort_by(&:error_name).uniq.map do |error|
             Services::ErrorGenerator.new(error)
@@ -22,6 +26,8 @@ module Foobara
         end
 
         def error_type_union
+          return "never" unless has_possible_errors?
+
           error_generators.map do |error_generator|
             dependency_group.non_colliding_type(error_generator)
           end.join(" |\n  ")

data/src/remote_generator/services/typescript_from_manifest_base_generator.rb

@@ -216,15 +216,23 @@ module Foobara
                             model_and_entity_free:
                           )
 
-                          is_empty = type_declaration.attribute_declarations.empty?
+                          if type_declaration.has_attribute_declarations?
+                            is_empty = type_declaration.attribute_declarations.empty?
 
-                          if name
-                            # TODO: test this code path or delete it
+                            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
+                          else
+                            # TODO: test this path with an :attributes type (not extended from :attributes but
+                            # the built-in type itself directly)
                             # :nocov:
-                            return is_empty ? "undefined" : "interface #{name} #{ts_type}"
+                            ts_type
                             # :nocov:
-                          else
-                            is_empty ? "undefined" : ts_type
                           end
                         elsif type_declaration.is_a?(Manifest::Array)
                           # TODO: which association_depth do we pass here?
@@ -287,7 +295,8 @@ module Foobara
               type_string = "#{type_string} | null"
             end
 
-            name ? "#{name} = #{type_string}" : type_string
+            # TODO: Add description as a comment?
+            name ? "type #{name} = #{type_string}" : type_string
           else
             # :nocov:
             raise "Not sure how to convert #{type_declaration} to a TS type"
@@ -301,8 +310,12 @@ module Foobara
           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)}: #{
+          # TODO: if we don't actually have attribute_declarations because we
+          # are trying to express attributes of any type, then we want Record<string, any>
+          # or something.
+          if attributes.has_attribute_declarations?
+            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:,
@@ -311,9 +324,16 @@ module Foobara
                 model_and_entity_free:
               )
             }"
-          end.join("\n")
+            end.join("\n")
 
-          "{\n#{guts}\n}"
+            "{\n#{guts}\n}"
+          else
+            # TODO: test this path with an :attributes type (not extended from :attributes but
+            # the built-in type itself directly)
+            # :nocov:
+            "Record<string, any>"
+            # :nocov:
+          end
         end
 
         def model_to_ts_model_name(model, association_depth: AssociationDepth::AMBIGUOUS, initial: true)

data/templates/Command/Errors.ts.erb

@@ -2,10 +2,14 @@
 import <%= dependency_root.import_destructure %> from "<%= path_to_root %><%= dependency_root.import_path %>"
 <% end %>
 
+<% if has_possible_errors? %>
 export interface PossibleErrors {
 <% possible_errors.keys.sort.each do |key| %>
   "<%= key %>": <%= foobara_type_to_ts_type(possible_errors[key].error, dependency_group:) %>,
 <% end  %>
 }
+<% else %>
+export type PossibleErrors = Record<never, never>
+<% end %>
 
 export type Error = <%= error_type_union %>

metadata

@@ -1,28 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: foobara-typescript-remote-command-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.24
+  version: 1.0.0
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara-files-generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 2.0.0
 email:
 - azimux@gmail.com
 executables: []
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Generates remote commands for Typescript from a foobara manifest
 test_files: []