typelizer 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0528e1e626a19920401677115cc49d13d3c2a730b8f332e285dcdaada8699a62'
-  data.tar.gz: 171dde8c90cc46ee6eb5cf434f2c7cd83f15098a233e9e2a5dbb2b5f36ba470c
+  metadata.gz: 7b353423e2bc10fd89e3d944692c04b41b69f6b75567821060b5b9e84b5009a0
+  data.tar.gz: 6abb793e276d1a6627284ac7e3e5a37888e9d48850f0f74c3475ee5034c06d11
 SHA512:
-  metadata.gz: b3785036afe6f23d5f5f830271081d20f99810e3582d853b28bd34e5558e20609615b929a870c6ef518b75389b48c6e092a8043d8c24510ad1a01b9d82449021
-  data.tar.gz: c0bde62a2756d3b67cba8bf8fa061f898d2837bae191f80fa6960c1fe08c654044807c0c8157cffa6c45edee632716f7c105a54cae4b5f87d3ece6b546c7cda1
+  metadata.gz: 92ebe7361f52e8644576b8eabffcf0602f24369e9f6a9bc82837550b123440438befef9fb0d730c8c96cab63e111858aa05088b65aa46ab2a1c6b2c58868fcff
+  data.tar.gz: 9ee89e0e1761257e51a97ba4666c3cecc4c02581f1726117f67f5328be510b4fd05653f46effad3d33fb119dcee01c9734160be3b2893d3cf566a2d5079c05f5

data/CHANGELOG.md

@@ -7,6 +7,37 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [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 +310,8 @@ 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.5...HEAD
+[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/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_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.5"
 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.5
 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: []