CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.3.0 - 2025-02-28

Added

• Support transform keys. (@patvice, @skryukov)

  Typelizer now respects transform_keys/key_transform configurations for all plugins.

• Support typing method def in Alba. (@patvice)

  The typelize helper now can be used before a method definition:

  class UserResource < ApplicationResource
    attributes :id, :name, :email, :chars_in_name
  
    typelize :number
    def chars_in_name(obj)
      obj.name.chars.count
    end
  end

• Support for deprecated attributes. (@Envek)

  They will be marked as deprecated using JSDoc @deprecated tag in TypeScript interface comments.

  In ActiveModel::Serializer attributes deprecated option is recognized.

  For other serializers, you can use deprecated option of typelize method.

Fixed

• Ignore nil values on fingerprint calculation. (@Envek)

0.2.0 - 2024-11-26

Added

• Add support for enum attributes declared using ActiveRecord::Enum or explicitly in serializers (@Envek)
• Add support for comments in generated TypeScript interfaces (@Envek)
• Add TypeScript verbatim module syntax support through verbatim_module_syntax config option (@patvice)
• Add typelizer:generate:refresh command to clean output directory and regenerate all interfaces (@patvice)
• Allow disabling Typelizer in Rails development with DISABLE_TYPELIZER environment variable to true (@okuramasafumi)
• Allow to get interfaces without generating TypeScript files (@Envek)

Fixed

• Do not override Typelizer.dirs in the railtie initializer (@patvice)
• Do not raise on empty nested serializers (@skryukov)
• Attribute options merging in inherited serializers (@Envek)
• Allow recursive type definition (@okuramasafumi)

0.1.5 - 2024-10-07

Fixed

• Fix the duplicated import with multiple same association (@okuramasafumi)

0.1.4 - 2024-10-04

Added

• PORO model plugin (@okuramasafumi)
• Auto model plugin (@skryukov)

0.1.3 - 2024-09-27

Added

• Support inline associations (@okuramasafumi, @skryukov)

  Example of Alba serializer with inline associations (note the helper Typelizer::DSL, see Alba's docs for more details):

  class FooSerializer
    include Alba::Resource
    helper Typelizer::DSL
  
    many :bars do
      typelize_from Bar
  
      attributes :id, :name
    end
  end

0.1.2 - 2024-09-05

Fixed

• Prevent Alba's meta nil raising an error (@okuramasafumi)

0.1.1 - 2024-08-26

Fixed

• Failing method inspection (@skryukov, @davidrunger)

0.1.0 - 2024-08-02

• Initial release (@skryukov)