types_from_serializers 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3ceb7a2dea10b4bc18d98eb9d0425f6a77caf1f3f9be3ca104063651bb64461
-  data.tar.gz: 18d9ba2eccf240725e53ee2ffd56398a1baa0df1642379c5ff5a9efefbf9fac9
+  metadata.gz: 61ca195394efd6b1c37c31b81ff85f7ccbcba562e9cf7b76d7810dfc613e1aa6
+  data.tar.gz: 20ef589a30a448e668d1da4106ab565e768227e74f950c5d56bfbd2a83aa9a48
 SHA512:
-  metadata.gz: 7b5f49158e7e4b81ee3f2645177200e727868827e8a0a81500c1445729dabc693e19a45a593b9fd264341a66abc53ac1f76b138664958eda64a39d0950e61728
-  data.tar.gz: 9d0d6711c70947f4a11f66b59523048982f5ab05914b35269be018ad415f789c959cff9977c6bb8fe5f43f4e53e126b7934881544b059db1c6c583952db28b5e
+  metadata.gz: fec219f23757f68e03678195ac3f66f13d3d48897e30c3f4b141c12257eb394577c997ecc639110ac3fee8be57e90f915c94989e84116a9be76d9d1e5df47f52
+  data.tar.gz: 1956d02db12c7ea5eab5edff52dc48356f163f71a17ab08fc93e6dcae810d29df26ea7501ddc0e8ac609087981d2456e4b927bcdb01acfeff455adf4671b58b0

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# [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)
+
+
+### Features
+
+* map citext from PostgreSQL to string ([#7](https://github.com/ElMassimo/types_from_serializers/issues/7)) ([d8c6848](https://github.com/ElMassimo/types_from_serializers/commit/d8c6848b99b0f4ba3770871f491755c229a2c4b0))
+
+
+
 ## [2.0.1](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.0.0...types_from_serializers@2.0.1) (2023-04-03)
 
 

data/lib/types_from_serializers/generator.rb

@@ -94,6 +94,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 +141,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
 
@@ -269,7 +271,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 +296,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
@@ -380,12 +387,16 @@ module TypesFromSerializers
           integer: :number,
           string: :string,
           text: :string,
+          citext: :string,
         }.tap do |types|
           types.default = :unknown
         end,
 
         # Allows to transform keys, useful when converting objects client-side.
         transform_keys: nil,
+
+        # Allows scoping typescript definitions to a namespace
+        namespace: nil,
       )
     end
 
@@ -393,8 +404,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|
@@ -417,6 +428,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.
@@ -425,6 +440,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.1"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: types_from_serializers
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-03 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -72,20 +72,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -291,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.2.32
 signing_key:
 specification_version: 4
 summary: Generate TypeScript interfaces from your JSON serializers.