sorbet-typescript 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20b6b038eabc0014a293fcd994c56e1413d217613fa86c0df40157dc3e4399a2
-  data.tar.gz: 331239897ffb2f29a4b52dd09987d1fecdbbb298f9cfd8a42dc7898e0034889c
+  metadata.gz: a1cf81a39a35ccac245e89223b1058cdac4fd86ffce3b41170ee4bea5a322d54
+  data.tar.gz: 026eccb4bfe1701578c88ed1ecbcc54d79a11e32071bba40f64746fa834443cf
 SHA512:
-  metadata.gz: 28d320cb930debcab937be85c99d676743469c3a223a6d9b3e1ae50d89b14e123a7d81f698126cde66f978d0147fddaadf43422da9d5e941fe1c31e52d6b46be
-  data.tar.gz: b7656d8962f845ed7ff48afa5a507416dfd0accdac1f8a6ff641a2561b58056fb85db80471cf78244e62a3bbc2df7511246bd1adb5189ebc0137df512b990cbf
+  metadata.gz: afcc21912da9832d4c91cd0662418ad08dfb983eea44c617b4b34dc0051e00b73968e052da4be3d0576761953d095d4aa68b678ea0ab590c53b61a19e4be94d7
+  data.tar.gz: 5a874c2be4a84432ab1718b2eef3405f2dc26af1a4517c30aca61acbb7b8d96e9532a5b6294dd47f794b5bf9c8a111dbef0c8c8bef79ebe0ad4afa2b646ee796

data/CHANGELOG.md

@@ -2,4 +2,10 @@
 
 ## [Unreleased]
 
+## [0.1.1] - 2025-09-28
+
+- Export default enum metadata for struct fields.
+
+## [0.1.0] - 2025-09-27
+
 - Initial development release.

data/README.md

@@ -52,6 +52,16 @@ outputs:
 
 Run it with `bundle exec sorbet-typescript export --config sorbet_typescript.yml`. Any CLI options override the config file.
 
+#### What gets generated?
+
+Each output captures the same Sorbet definitions in a format that is convenient for different consumers:
+
+- **Enums JSON (`enums_json`)** – map of fully qualified enum names to metadata with the original name, the simple (namespace-free) name, and an ordered list of values (`name`, `serialized`).
+- **Structs JSON (`structs_json`)** – map of fully qualified struct names to field metadata. Every field entry describes its Sorbet type (`type`, `enum_name`, `struct_name`, etc.), optionality, and—when the Sorbet definition provides defaults—the serialized enum default (`default_enum_*` keys) or literal default (`default`).
+- **TypeScript file (`typescript_file`)** – ambient definitions that mirror the Sorbet types: literal unions for enums and interfaces for structs. Enum-backed fields become unions of the serialized values so the TS compiler enforces the same constraints as Sorbet.
+
+These files share the same structure whether you call the CLI or the Ruby API, making it easy to feed the JSON into documentation generators, schemas, or client SDKs.
+
 ### Ruby API
 
 If you want to script the export yourself, use the `Exporter` directly:

data/lib/sorbet/typescript/exporter.rb

@@ -263,6 +263,7 @@ module Sorbet::Typescript
       type_object = prop_info[:type_object] || prop_info[:type]
       info = analyse_type_object(type_object)
       info = augment_enum_metadata(info)
+      info = augment_default_metadata(info, prop_info)
       info[:optional] = prop_info[:_tnilable] || prop_info[:fully_optional] || false
       info
     end
@@ -483,6 +484,40 @@ module Sorbet::Typescript
       info
     end
 
+    sig do
+      params(info: T::Hash[Symbol, T.untyped], prop_info: T::Hash[Symbol, T.untyped])
+        .returns(T::Hash[Symbol, T.untyped])
+    end
+    def augment_default_metadata(info, prop_info)
+      default = default_from_prop(prop_info)
+      return info unless default
+
+      if default.is_a?(T::Enum)
+        info[:default_enum_name] = default.class.name
+        info[:default_enum_value] = enum_constant_name(default)
+        info[:default_enum_serialized] = default.serialize
+      elsif default.is_a?(String) || default.is_a?(Symbol) || default.is_a?(Numeric) || default == true || default == false
+        info[:default] = default
+      end
+
+      info
+    end
+
+    sig { params(prop_info: T::Hash[Symbol, T.untyped]).returns(T.untyped) }
+    def default_from_prop(prop_info)
+      return nil if prop_info[:factory]
+
+      default = prop_info[:default]
+      default = nil if default.is_a?(Proc)
+
+      if default.nil?
+        applier = prop_info[:_t_props_private_apply_default]
+        default = applier.default if applier&.respond_to?(:default)
+      end
+
+      default
+    end
+
     sig { params(info: T::Hash[Symbol, T.untyped]).returns(T::Array[T::Hash[Symbol, T.untyped]]) }
     def enum_value_details_for(info)
       details = info[:enum_value_details]

data/lib/sorbet/typescript/version.rb

@@ -4,5 +4,5 @@
 class Sorbet; end unless defined?(Sorbet)
 
 module Sorbet::Typescript
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-typescript
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - DocSpring