typelizer 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b353423e2bc10fd89e3d944692c04b41b69f6b75567821060b5b9e84b5009a0
-  data.tar.gz: 6abb793e276d1a6627284ac7e3e5a37888e9d48850f0f74c3475ee5034c06d11
+  metadata.gz: 57cc88a8063ebe9f00e0558f3dbd59aca579b5e191bdce38d3f8ca9b0451acee
+  data.tar.gz: 32cb1941e3ece707061fd7f2b1e6287710a0f9e2e8f8fc4d56b7f39fe444a7f6
 SHA512:
-  metadata.gz: 92ebe7361f52e8644576b8eabffcf0602f24369e9f6a9bc82837550b123440438befef9fb0d730c8c96cab63e111858aa05088b65aa46ab2a1c6b2c58868fcff
-  data.tar.gz: 9ee89e0e1761257e51a97ba4666c3cecc4c02581f1726117f67f5328be510b4fd05653f46effad3d33fb119dcee01c9734160be3b2893d3cf566a2d5079c05f5
+  metadata.gz: a9fb264406d6ea58bc1b7cc7e875bef11e08cf8f758786f0f63e4d110db5b0e39832615167068baea973a5cf5236f76cac537ce1cfd3f21abd3def162a33edd2
+  data.tar.gz: 74a8a3552d25fff6c5dee5837d42dc6f257d097944874ade9aee247d432ff7d85303ebb9a6e60ae000bb8634c2a47e4be2e52dc5f4b08d49bd06963473a19b43

data/CHANGELOG.md

@@ -7,6 +7,42 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.6.0] - 2026-01-14
+
+### Added
+
+- New `imports_sort_order` configuration option for consistent import ordering in generated TypeScript interfaces. ([@jonmarkgo])
+
+  ```ruby
+  Typelizer.configure do |config|
+    # Sort imports alphabetically
+    config.imports_sort_order = :alphabetical
+  end
+  ```
+
+  Available options:
+  - `:none` (default) - preserve original order
+  - `:alphabetical` - sort imports A-Z (case-insensitive)
+  - `Proc` - custom sorting logic
+
+### Changed
+
+- Rails enum attributes now generate named types (e.g., `PostCategory`) in a separate `Enums.ts` file instead of inline unions. ([@skryukov])
+
+### Fixed
+
+- Fix `index.ts` not being regenerated when traits are added or removed. ([@skryukov])
+
+## [0.5.6] - 2026-01-12
+
+### Added
+
+- Type inference for serialized fields. `serialize :skills, type: Array` generates `Array<unknown>`, `serialize :settings, type: Hash` generates `Record<string, unknown>`. ([@skryukov])
+
+### Fixed
+
+- Alba: respect `key:` option for associations defined in traits. ([@skryukov])
+
 ## [0.5.5] - 2025-12-24
 
 ### Added
@@ -299,6 +335,7 @@ and this project adheres to [Semantic Versioning].
 
 [@davidrunger]: https://github.com/davidrunger
 [@Envek]: https://github.com/Envek
+[@jonmarkgo]: https://github.com/jonmarkgo
 [@hkamberovic]: https://github.com/hkamberovic
 [@kristinemcbride]: https://github.com/kristinemcbride
 [@nkriege]: https://github.com/nkriege
@@ -310,7 +347,9 @@ and this project adheres to [Semantic Versioning].
 [@prog-supdex]: https://github.com/prog-supdex
 [@ventsislaf]: https://github.com/ventsislaf
 
-[Unreleased]: https://github.com/skryukov/typelizer/compare/v0.5.5...HEAD
+[Unreleased]: https://github.com/skryukov/typelizer/compare/v0.6.0...HEAD
+[0.6.0]: https://github.com/skryukov/typelizer/compare/v0.5.6...v0.6.0
+[0.5.6]: https://github.com/skryukov/typelizer/compare/v0.5.5...v0.5.6
 [0.5.5]: https://github.com/skryukov/typelizer/compare/v0.5.4...v0.5.5
 [0.5.4]: https://github.com/skryukov/typelizer/compare/v0.5.3...v0.5.4
 [0.5.3]: https://github.com/skryukov/typelizer/compare/v0.5.2...v0.5.3

data/README.md

@@ -493,6 +493,12 @@ Typelizer.configure do |config|
   # Proc - custom sorting function receiving array of Property objects
   config.properties_sort_order = :none
 
+  # Strategy for ordering imports in generated TypeScript interfaces
+  # :none - preserve original order (default)
+  # :alphabetical - sort imports A-Z (case-insensitive)
+  # Proc - custom sorting function receiving array of import strings
+  config.imports_sort_order = :none
+
   # Plugin for model type inference (default: ModelPlugins::Auto)
   config.model_plugin = Typelizer::ModelPlugins::Auto
 

data/lib/typelizer/config.rb

@@ -24,6 +24,7 @@ module Typelizer
     :serializer_model_mapper,
     :properties_transformer,
     :properties_sort_order,
+    :imports_sort_order,
     :model_plugin,
     :serializer_plugin,
     :plugin_configs,
@@ -79,6 +80,7 @@ module Typelizer
         types_global: DEFAULT_TYPES_GLOBAL,
         properties_transformer: nil,
         properties_sort_order: :none,
+        imports_sort_order: :none,
         verbatim_module_syntax: false
       }
     end

data/lib/typelizer/import_sorter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Typelizer
+  module ImportSorter
+    def self.sort(imports, sort_order)
+      case sort_order
+      when :none, nil
+        imports
+      when :alphabetical
+        imports.sort_by { |i| i.to_s.downcase }
+      when Proc
+        result = sort_order.call(imports)
+        result.is_a?(Array) ? result : imports
+      else
+        imports
+      end
+    rescue => e
+      Typelizer.logger.warn("ImportSorter error: #{e.message}, preserving original order")
+      imports
+    end
+  end
+end

data/lib/typelizer/interface.rb

@@ -58,6 +58,15 @@ module Typelizer
       @trait_interfaces ||= serializer_plugin.trait_interfaces
     end
 
+    def enum_types
+      @enum_types ||= begin
+        all_properties = properties + trait_interfaces.flat_map(&:properties)
+        all_properties
+          .select(&:enum_definition)
+          .uniq(&:enum_type_name)
+      end
+    end
+
     def properties
       @properties ||= begin
         props = serializer_plugin.properties
@@ -119,7 +128,11 @@ module Typelizer
           prop.with_traits.map { |t| "#{prop.type.name}#{t.to_s.camelize}Trait" }
         end
 
-        (custom_type_imports + serializer_types + trait_imports + Array(parent_interface&.name)).uniq - [self_type_name, name]
+        # Collect enum type names from properties
+        enum_imports = all_properties.filter_map(&:enum_type_name)
+
+        result = (custom_type_imports + serializer_types + trait_imports + enum_imports + Array(parent_interface&.name)).uniq - [self_type_name, name]
+        ImportSorter.sort(result, config.imports_sort_order)
       end
     end
 

data/lib/typelizer/model_plugins/active_record.rb

@@ -28,6 +28,8 @@ module Typelizer
         return unless model_class&.defined_enums&.key?(prop.column_name.to_s)
 
         prop.enum = model_class.defined_enums[prop.column_name.to_s].keys
+        prop.enum_type_name = "#{model_class.name.demodulize}#{prop.column_name.to_s.camelize}"
+        prop.enum
       end
 
       private
@@ -104,6 +106,10 @@ module Typelizer
         attribute_type_obj = model_class.attribute_types.fetch(prop.column_name.to_s, nil)
         return nil unless attribute_type_obj
 
+        if attribute_type_obj.instance_of?(::ActiveRecord::Type::Serialized)
+          return infer_types_for_serialized(prop, attribute_type_obj)
+        end
+
         if attribute_type_obj.respond_to?(:subtype)
           prop.type = @config.type_mapping[attribute_type_obj.subtype.type]
           prop.multi = true
@@ -113,6 +119,23 @@ module Typelizer
 
         prop
       end
+
+      def infer_types_for_serialized(prop, type_obj)
+        object_class = type_obj.coder.try(:object_class) ||
+          type_obj.try(:object_class)
+
+        case object_class&.to_s
+        when "Array"
+          prop.type = :unknown
+          prop.multi = true
+        when "Hash"
+          prop.type = "Record<string, unknown>"
+        else
+          prop.type = :unknown
+        end
+
+        prop
+      end
     end
   end
 end

data/lib/typelizer/property.rb

@@ -1,7 +1,7 @@
 module Typelizer
   Property = Struct.new(
     :name, :type, :optional, :nullable,
-    :multi, :column_name, :comment, :enum, :deprecated,
+    :multi, :column_name, :comment, :enum, :enum_type_name, :deprecated,
     :with_traits,
     keyword_init: true
   ) do
@@ -39,10 +39,16 @@ module Typelizer
       end << ">"
     end
 
+    def enum_definition
+      return unless enum && enum_type_name
+
+      "type #{enum_type_name} = #{enum.map { |v| v.to_s.inspect }.join(" | ")}"
+    end
+
     private
 
     def type_name
-      return enum.map { |v| v.to_s.inspect }.join(" | ") if enum
+      return enum_type_name if enum_type_name
 
       type.respond_to?(:name) ? type.name : type || "unknown"
     end

data/lib/typelizer/serializer_plugins/alba/trait_attribute_collector.rb

@@ -54,17 +54,19 @@ module Typelizer
       end
 
       # Simple struct to hold association info from traits
-      TraitAssociation = Struct.new(:name, :resource, :with_traits, :multi, keyword_init: true)
+      TraitAssociation = Struct.new(:name, :resource, :with_traits, :multi, :key, keyword_init: true)
 
       # Support association methods that might be used in traits
       def one(name, **options, &block)
         resource = options[:resource] || options[:serializer]
         with_traits = options[:with_traits]
-        @collected_attributes[name] = TraitAssociation.new(
+        key = options[:key] || name
+        @collected_attributes[key] = TraitAssociation.new(
           name: name,
           resource: resource,
           with_traits: with_traits,
-          multi: false
+          multi: false,
+          key: key
         )
       end
 
@@ -74,11 +76,13 @@ module Typelizer
       def many(name, **options, &block)
         resource = options[:resource] || options[:serializer]
         with_traits = options[:with_traits]
-        @collected_attributes[name] = TraitAssociation.new(
+        key = options[:key] || name
+        @collected_attributes[key] = TraitAssociation.new(
           name: name,
           resource: resource,
           with_traits: with_traits,
-          multi: true
+          multi: true,
+          key: key
         )
       end
 

data/lib/typelizer/templates/enums.ts.erb

@@ -0,0 +1,3 @@
+<%- enums.each do |property| -%>
+export <%= property.enum_definition %>;
+<%- end -%>

data/lib/typelizer/templates/index.ts.erb

@@ -1,3 +1,6 @@
+<%- if enums.any? -%>
+export type { <%= enums.map(&:enum_type_name).join(", ") %> } from './Enums'
+<%- end -%>
 <%- interfaces.each do |interface| -%>
 <%- if interface.config.verbatim_module_syntax -%>
 export type { <%= interface.name %><%= ", " + interface.trait_interfaces.map(&:name).join(", ") if interface.trait_interfaces.any? %> } from <%= interface.quote('./' + interface.filename) %>

data/lib/typelizer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Typelizer
-  VERSION = "0.5.5"
+  VERSION = "0.6.0"
 end

data/lib/typelizer/writer.rb

@@ -22,7 +22,10 @@ module Typelizer
       begin
         written_files.concat(valid_interfaces.map { |interface| write_interface(interface) })
 
-        written_files << write_index(valid_interfaces)
+        enums = collect_enums(valid_interfaces)
+        written_files << write_enums(enums) if enums.any?
+
+        written_files << write_index(valid_interfaces, enums: enums)
 
         cleanup_stale_files(written_files) unless force
 
@@ -49,9 +52,23 @@ module Typelizer
       File.delete(*stale_files) unless stale_files.empty?
     end
 
-    def write_index(interfaces)
-      write_file("index.ts", interfaces.map(&:filename).join) do
-        render_template("index.ts.erb", interfaces: interfaces)
+    def collect_enums(interfaces)
+      interfaces
+        .flat_map(&:enum_types)
+        .uniq(&:enum_type_name)
+        .sort_by(&:enum_type_name)
+    end
+
+    def write_enums(enums)
+      write_file("Enums.ts", enums.map(&:fingerprint).join) do
+        render_template("enums.ts.erb", enums: enums)
+      end
+    end
+
+    def write_index(interfaces, enums: [])
+      fingerprint = interfaces.map(&:fingerprint).join + enums.map(&:fingerprint).join
+      write_file("index.ts", fingerprint) do
+        render_template("index.ts.erb", interfaces: interfaces, enums: enums)
       end
     end
 

data/lib/typelizer.rb

@@ -12,6 +12,7 @@ require_relative "typelizer/serializer_config_layer"
 require_relative "typelizer/contexts/writer_context"
 require_relative "typelizer/contexts/scan_context"
 require_relative "typelizer/property_sorter"
+require_relative "typelizer/import_sorter"
 require_relative "typelizer/interface"
 require_relative "typelizer/renderer"
 require_relative "typelizer/writer"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typelizer
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Svyatoslav Kryukov
@@ -54,6 +54,7 @@ files:
 - lib/typelizer/contexts/writer_context.rb
 - lib/typelizer/dsl.rb
 - lib/typelizer/generator.rb
+- lib/typelizer/import_sorter.rb
 - lib/typelizer/interface.rb
 - lib/typelizer/listen.rb
 - lib/typelizer/model_plugins/active_record.rb
@@ -73,6 +74,7 @@ files:
 - lib/typelizer/serializer_plugins/oj_serializers.rb
 - lib/typelizer/serializer_plugins/panko.rb
 - lib/typelizer/templates/comment.ts.erb
+- lib/typelizer/templates/enums.ts.erb
 - lib/typelizer/templates/fingerprint.ts.erb
 - lib/typelizer/templates/index.ts.erb
 - lib/typelizer/templates/inheritance.ts.erb