typelizer 0.5.4 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0528e1e626a19920401677115cc49d13d3c2a730b8f332e285dcdaada8699a62'
-  data.tar.gz: 171dde8c90cc46ee6eb5cf434f2c7cd83f15098a233e9e2a5dbb2b5f36ba470c
+  metadata.gz: f1c1d02eab4c7f1ea170ecd4b855fa37952273faa3223333cd6f6f2020dad397
+  data.tar.gz: 519c348552314735af8c1ba5072a8cd7cbb492b822d0bf5564b95b965f42ff12
 SHA512:
-  metadata.gz: b3785036afe6f23d5f5f830271081d20f99810e3582d853b28bd34e5558e20609615b929a870c6ef518b75389b48c6e092a8043d8c24510ad1a01b9d82449021
-  data.tar.gz: c0bde62a2756d3b67cba8bf8fa061f898d2837bae191f80fa6960c1fe08c654044807c0c8157cffa6c45edee632716f7c105a54cae4b5f87d3ece6b546c7cda1
+  metadata.gz: e5d72c98f8ac58bba2a48673ec3f54e86e6aba2d25168312433d5288461aef7c1fd5d0d65aa2137759f03831c432aee5d9a2f5fc626068d302d295749d1f9ca7
+  data.tar.gz: 4134b806f9f788a32920dfb6ae8980b66083c7b22b897be3f3d005915fd5e444712fe12535a409c47c6d5cee4158f91696c11df7692f2ced26361bc169cd91d3

data/CHANGELOG.md

@@ -7,6 +7,47 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [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
+
+- New `properties_sort_order` configuration option for consistent property ordering in generated TypeScript interfaces. ([@skryukov])
+
+  ```ruby
+  Typelizer.configure do |config|
+    # Sort properties alphabetically with 'id' first
+    config.properties_sort_order = :id_first_alphabetical
+  end
+  ```
+
+  Available options:
+  - `:none` (default) - preserve serializer definition order
+  - `:alphabetical` - sort properties A-Z (case-insensitive)
+  - `:id_first_alphabetical` - place `id` first, then sort remaining A-Z
+  - `Proc` - custom sorting logic
+
+  ```ruby
+  # Custom sorting example
+  config.properties_sort_order = ->(props) {
+    priority = %w[id uuid type]
+    props.sort_by { |p| [priority.index(p.name) || 999, p.name] }
+  }
+  ```
+
+### Fixed
+
+- Fix self-import issue when using custom `typelize` types for self-referential associations in namespaced serializers. ([@skryukov])
+
 ## [0.5.4] - 2025-12-08
 
 ### Added
@@ -279,7 +320,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.4...HEAD
+[Unreleased]: https://github.com/skryukov/typelizer/compare/v0.5.6...HEAD
+[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
 [0.5.2]: https://github.com/skryukov/typelizer/compare/v0.5.1...v0.5.2

data/README.md

@@ -486,6 +486,13 @@ Typelizer.configure do |config|
   # Custom transformation for generated properties
   config.properties_transformer = ->(properties) { ... }
 
+  # Strategy for ordering properties in generated TypeScript interfaces
+  # :none - preserve serializer definition order (default)
+  # :alphabetical - sort properties A-Z (case-insensitive)
+  # :id_first_alphabetical - place 'id' first, then sort remaining A-Z
+  # Proc - custom sorting function receiving array of Property objects
+  config.properties_sort_order = :none
+
   # Plugin for model type inference (default: ModelPlugins::Auto)
   config.model_plugin = Typelizer::ModelPlugins::Auto
 

data/lib/typelizer/config.rb

@@ -23,6 +23,7 @@ module Typelizer
     :serializer_name_mapper,
     :serializer_model_mapper,
     :properties_transformer,
+    :properties_sort_order,
     :model_plugin,
     :serializer_plugin,
     :plugin_configs,
@@ -77,6 +78,7 @@ module Typelizer
         types_import_path: "@/types",
         types_global: DEFAULT_TYPES_GLOBAL,
         properties_transformer: nil,
+        properties_sort_order: :none,
         verbatim_module_syntax: false
       }
     end

data/lib/typelizer/interface.rb

@@ -48,7 +48,7 @@ module Typelizer
         props = serializer_plugin.meta_fields || []
         props = infer_types(props, :_typelizer_meta_attributes)
         props = config.properties_transformer.call(props) if config.properties_transformer
-        props
+        PropertySorter.sort(props, config.properties_sort_order)
       end
     end
 
@@ -63,7 +63,7 @@ module Typelizer
         props = serializer_plugin.properties
         props = infer_types(props)
         props = config.properties_transformer.call(props) if config.properties_transformer
-        props
+        PropertySorter.sort(props, config.properties_sort_order)
       end
     end
 
@@ -119,7 +119,7 @@ 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 - Array(self_type_name)
+        (custom_type_imports + serializer_types + trait_imports + Array(parent_interface&.name)).uniq - [self_type_name, name]
       end
     end
 

data/lib/typelizer/model_plugins/active_record.rb

@@ -104,6 +104,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 +117,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_sorter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Typelizer
+  module PropertySorter
+    def self.sort(props, sort_order)
+      case sort_order
+      when :none, nil
+        props
+      when :alphabetical
+        props.sort_by { |p| p.name.to_s.downcase }
+      when :id_first_alphabetical
+        props.sort_by { |p| [(p.name.to_s.downcase == "id") ? 0 : 1, p.name.to_s.downcase] }
+      when Proc
+        result = sort_order.call(props)
+        result.is_a?(Array) ? result : props
+      else
+        props
+      end
+    rescue => e
+      Typelizer.logger.warn("PropertySorter error: #{e.message}, preserving original order")
+      props
+    end
+  end
+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/serializer_plugins/alba/trait_interface.rb

@@ -24,7 +24,8 @@ module Typelizer
       def properties
         @properties ||= begin
           props, typelizes = plugin.trait_properties(trait_name)
-          infer_types(props, typelizes)
+          props = infer_types(props, typelizes)
+          PropertySorter.sort(props, config.properties_sort_order)
         end
       end
 

data/lib/typelizer/version.rb

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

data/lib/typelizer.rb

@@ -11,6 +11,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/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.4
+  version: 0.5.6
 platform: ruby
 authors:
 - Svyatoslav Kryukov
@@ -60,6 +60,7 @@ files:
 - lib/typelizer/model_plugins/auto.rb
 - lib/typelizer/model_plugins/poro.rb
 - lib/typelizer/property.rb
+- lib/typelizer/property_sorter.rb
 - lib/typelizer/railtie.rb
 - lib/typelizer/renderer.rb
 - lib/typelizer/serializer_config_layer.rb
@@ -104,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.0
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A TypeScript type generator for Ruby serializers.
 test_files: []