types_from_serializers 2.0.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2d8cc0fd6d5da180f0420fbabea0c24d428de7bec297658740d1ce9fbdbb551
-  data.tar.gz: 350a9692de1a188757db7b0efbd0be88fa8da038959070e8ff966a27f2d816bd
+  metadata.gz: 0e3961bc80ddc72831c77e7cf9ddf0959809a49a845f0d778d0c6ac50148cb87
+  data.tar.gz: e676ddfe4c4c51081075bd5bbb3a66990d8ea469dc60305a550175abe8c43c99
 SHA512:
-  metadata.gz: a3222cd4804c0cc431b8b300f21b3b0758035cbdd66872b259571e754ad5cba32716a4bb30662809e244a6e5684047172b26712b28bc58c1f192a7e7d6ac5544
-  data.tar.gz: 1de827c5f9b4981644b2954e5579eeebe2bea02a8a1463c9e57614555e034d4afa998bf2a14518080fced93d3faa2de943dbf9c1b12d9b7977f986086fe45097
+  metadata.gz: 01e286a9381c3d8f2e00c4085ba491ab4d4332ee3ac0ea2ebd109a7ff53ddb131b43d1c0839a09459884edc0536cd805d5303be2a80143a12998d6b5839dfc14
+  data.tar.gz: a3687e203f27c34a3243f1422588bd2c79362ef4b7f9c2432ec6ce53493c83c11782f784f8acb4a76d7a611fab6ca7e9422f63560c3053739e3b39c3258d91ed

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+# [2.2.0](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.1.0...types_from_serializers@2.2.0) (2024-08-23)
+
+
+### Bug Fixes
+
+* be more accurate regarding decimal serialization ([cd63653](https://github.com/ElMassimo/types_from_serializers/commit/cd636530a5710112a14746cc7d0e3f15016cd5e1))
+
+
+### Features
+
+* infer type from enums ([#20](https://github.com/ElMassimo/types_from_serializers/issues/20)) ([49dc61d](https://github.com/ElMassimo/types_from_serializers/commit/49dc61da2718256e9b5f5743b5a65c4746d64c2f))
+
+
+
+# [2.1.0](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.0.2...types_from_serializers@2.1.0) (2023-07-19)
+
+
+### Features
+
+* add `namespace` option to generate `.d.ts` files ([#9](https://github.com/ElMassimo/types_from_serializers/issues/9)) ([6f67b1a](https://github.com/ElMassimo/types_from_serializers/commit/6f67b1ad9283868e8e3325042645bceccc85b047))
+
+
+
 ## [2.0.2](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.0.1...types_from_serializers@2.0.2) (2023-04-05)
 
 

data/lib/types_from_serializers/generator.rb

@@ -38,15 +38,12 @@ module TypesFromSerializers
         TypesFromSerializers.config.name_from_serializer.call(name).gsub("::", "/")
       end
 
-      # Internal: The columns corresponding to the serializer model, if it's a
-      # record.
-      def model_columns
-        @model_columns ||= _serializer_model_name&.to_model.try(:columns_hash) || {}
-      end
-
       # Internal: The TypeScript properties of the serialzeir interface.
       def ts_properties
         @ts_properties ||= begin
+          model_class = _serializer_model_name&.to_model
+          model_columns = model_class.try(:columns_hash) || {}
+          model_enums = model_class.try(:defined_enums) || {}
           types_from = try(:_serializer_types_from)
 
           prepare_attributes(
@@ -64,7 +61,7 @@ module TypesFromSerializers
                   multi: options[:association] == :many,
                   column_name: options.fetch(:value_from),
                 ).tap do |property|
-                  property.infer_type_from(model_columns, types_from)
+                  property.infer_type_from(model_columns, model_enums, types_from)
                 end
               end
             }
@@ -94,6 +91,7 @@ module TypesFromSerializers
     :sql_to_typescript_type_mapping,
     :skip_serializer_if,
     :transform_keys,
+    :namespace,
     keyword_init: true,
   ) do
     def relative_custom_types_dir
@@ -140,10 +138,11 @@ module TypesFromSerializers
     end
 
     def as_typescript
-      <<~TS
+      indent = TypesFromSerializers.config.namespace ? 3 : 1
+      <<~TS.gsub(/\n$/, "")
         interface #{name} {
-          #{properties.index_by(&:name).values.map(&:as_typescript).join("\n  ")}
-        }
+        #{"  " * indent}#{properties.index_by(&:name).values.map(&:as_typescript).join("\n#{"  " * indent}")}
+        #{"  " * (indent - 1)}}
       TS
     end
 
@@ -188,9 +187,11 @@ module TypesFromSerializers
 
     # Internal: Infers the property's type by checking a corresponding SQL
     # column, or falling back to a TypeScript interface if provided.
-    def infer_type_from(columns_hash, ts_interface)
+    def infer_type_from(columns_hash, defined_enums, ts_interface)
       if type
         type
+      elsif (enum = defined_enums[column_name.to_s])
+        self.type = enum.keys.map(&:inspect).join(" | ")
       elsif (column = columns_hash[column_name.to_s])
         self.multi = true if column.try(:array)
         self.optional = true if column.null && !column.default
@@ -269,7 +270,12 @@ module TypesFromSerializers
     def generate(force: ENV["SERIALIZER_TYPES_FORCE"])
       @force_generation = force
       config.output_dir.rmtree if force && config.output_dir.exist?
-      generate_index_file
+
+      if config.namespace
+        load_serializers(all_serializer_files) if force
+      else
+        generate_index_file
+      end
 
       loaded_serializers.each do |serializer|
         generate_interface_for(serializer)
@@ -289,7 +295,7 @@ module TypesFromSerializers
     def generate_interface_for(serializer)
       interface = serializer.ts_interface
 
-      write_if_changed(filename: interface.filename, cache_key: interface.inspect) {
+      write_if_changed(filename: interface.filename, cache_key: interface.inspect, extension: config.namespace ? "d.ts" : "ts") {
         serializer_interface_content(interface)
       }
     end
@@ -376,7 +382,7 @@ module TypesFromSerializers
           boolean: :boolean,
           date: "string | Date",
           datetime: "string | Date",
-          decimal: :number,
+          decimal: "string | number",
           integer: :number,
           string: :string,
           text: :string,
@@ -387,6 +393,9 @@ module TypesFromSerializers
 
         # Allows to transform keys, useful when converting objects client-side.
         transform_keys: nil,
+
+        # Allows scoping typescript definitions to a namespace
+        namespace: nil,
       )
     end
 
@@ -394,8 +403,8 @@ module TypesFromSerializers
     # The cache strategy consists of a comment on the first line of the file.
     #
     # Yields to receive the rendered file content when it needs to.
-    def write_if_changed(filename:, cache_key:)
-      filename = config.output_dir.join("#{filename}.ts")
+    def write_if_changed(filename:, cache_key:, extension: "ts")
+      filename = config.output_dir.join("#{filename}.#{extension}")
       FileUtils.mkdir_p(filename.dirname)
       cache_key_comment = "// TypesFromSerializers CacheKey #{Digest::MD5.hexdigest(cache_key)}\n"
       File.open(filename, "a+") { |file|
@@ -418,6 +427,10 @@ module TypesFromSerializers
     end
 
     def serializer_interface_content(interface)
+      config.namespace ? declaration_interface_definition(interface) : standard_interface_definition(interface)
+    end
+
+    def standard_interface_definition(interface)
       <<~TS
         //
         // DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
@@ -426,6 +439,19 @@ module TypesFromSerializers
       TS
     end
 
+    def declaration_interface_definition(interface)
+      <<~TS
+        //
+        // DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
+        #{interface.used_imports.empty? ? "export {}\n" : interface.used_imports.join}
+        declare global {
+          namespace #{config.namespace} {
+            #{interface.as_typescript}
+          }
+        }
+      TS
+    end
+
     # Internal: Returns true if the cache key has changed since the last codegen.
     def stale?(file, cache_key_comment)
       @force_generation || file.gets != cache_key_comment

data/lib/types_from_serializers/version.rb

@@ -2,5 +2,5 @@
 
 module TypesFromSerializers
   # Public: This library adheres to semantic versioning.
-  VERSION = "2.0.2"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: types_from_serializers
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2024-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -277,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Generate TypeScript interfaces from your JSON serializers.