apiwork 0.6.1 → 0.7.0

data/lib/apiwork/export/type_script.rb

@@ -7,13 +7,10 @@ module Apiwork
       output :string
       file_extension '.ts'
 
-      option :builders, default: false, type: :boolean
       option :version, default: '5', enum: %w[4 5], type: :string
 
       def generate
-        output = TypeScriptMapper.map(self, surface)
-        output += "\n\n#{BuilderMapper.map(self, surface)}" if options[:builders]
-        output
+        TypeScriptMapper.map(self, surface)
       end
 
       private

data/lib/apiwork/export/type_script_mapper.rb

@@ -28,7 +28,7 @@ module Apiwork
         properties = type.shape.sort_by { |name, _param| name.to_s }.map do |name, param|
           key = @export.transform_key(name)
           ts_type = map_field(param)
-          optional_marker = param.optional? ? '?' : ''
+          optional_marker = optional_in_output?(param) ? '?' : ''
 
           prop_jsdoc = jsdoc(description: param.description, example: param.concrete? ? param.example : nil)
           if prop_jsdoc
@@ -85,7 +85,7 @@ module Apiwork
         properties = query_params.sort_by { |name, _param| name.to_s }.map do |param_name, param|
           key = @export.transform_key(param_name)
           ts_type = map_field(param)
-          optional_marker = param.optional? ? '?' : ''
+          optional_marker = optional_in_output?(param) ? '?' : ''
           "  #{key}#{optional_marker}: #{ts_type};"
         end.join("\n")
 
@@ -96,7 +96,7 @@ module Apiwork
         properties = body_params.sort_by { |name, _param| name.to_s }.map do |param_name, param|
           key = @export.transform_key(param_name)
           ts_type = map_field(param)
-          optional_marker = param.optional? ? '?' : ''
+          optional_marker = optional_in_output?(param) ? '?' : ''
           "  #{key}#{optional_marker}: #{ts_type};"
         end.join("\n")
 
@@ -186,7 +186,7 @@ module Apiwork
         properties = param.shape.sort_by { |name, _field| name.to_s }.map do |name, field|
           key = @export.transform_key(name)
           ts_type = map_field(field)
-          optional_marker = partial || field.optional? ? '?' : ''
+          optional_marker = partial || optional_in_output?(field) ? '?' : ''
           "#{key}#{optional_marker}: #{ts_type}"
         end.join('; ')
 
@@ -252,6 +252,14 @@ module Apiwork
         'unknown'
       end
 
+      def optional_in_output?(param)
+        return false unless param.optional?
+        return false if param.respond_to?(:default) && param.default?
+        return false if param.nullable?
+
+        true
+      end
+
       def type_reference(symbol)
         pascal_case(symbol)
       end

data/lib/apiwork/export/zod.rb

@@ -7,7 +7,6 @@ module Apiwork
       output :string
       file_extension '.ts'
 
-      option :builders, default: false, type: :boolean
       option :version, default: '4', enum: %w[4], type: :string
 
       def generate
@@ -27,14 +26,6 @@ module Apiwork
           parts << ''
         end
 
-        if options[:builders]
-          builder_output = BuilderMapper.map(self, surface)
-          if builder_output.present?
-            parts << builder_output
-            parts << ''
-          end
-        end
-
         parts.join("\n")
       end
 

data/lib/apiwork/export/zod_mapper.rb

@@ -458,10 +458,31 @@ module Apiwork
 
       def apply_modifiers(type, param, force_optional: nil)
         type += '.nullable()' if param.nullable?
+
+        has_default = param.respond_to?(:default) && param.default?
         optional = force_optional.nil? ? param.optional? : force_optional
-        type += '.optional()' if optional
+
+        if has_default
+          type += ".default(#{serialize_default(param.default)})"
+        elsif optional
+          type += '.optional()'
+        end
+
         type
       end
+
+      def serialize_default(value)
+        case value
+        when String then "'#{value.gsub("'", "\\\\'")}'"
+        when Integer, Float then value.to_s
+        when BigDecimal then value.to_s('F')
+        when TrueClass, FalseClass then value.to_s
+        when Array then '[]'
+        when Hash then '{}'
+        when NilClass then 'null'
+        else value.to_s
+        end
+      end
     end
   end
 end

data/lib/apiwork/export.rb

@@ -71,6 +71,7 @@ module Apiwork
       end
 
       def register_defaults!
+        register(Apiwork)
         register(OpenAPI)
         register(TypeScript)
         register(Zod)

data/lib/apiwork/introspection/api/resource.rb

@@ -23,6 +23,14 @@ module Apiwork
           @dump = dump
         end
 
+        # @api public
+        # The scope for this resource.
+        #
+        # @return [String, nil]
+        def scope
+          @dump[:scope]
+        end
+
         # @api public
         # The identifier for this resource.
         #
@@ -75,6 +83,7 @@ module Apiwork
             parent_identifiers: parent_identifiers,
             path: path,
             resources: resources.transform_values(&:to_h),
+            scope: scope,
           }
         end
       end

data/lib/apiwork/introspection/dump/param.rb

@@ -33,10 +33,9 @@ module Apiwork
 
           reference = resolve_type_reference(options[:type])
 
-          {
+          result = {
             reference:,
             as: options[:as],
-            default: options[:default],
             deprecated: options[:deprecated] == true,
             description: resolve_attribute_description(options),
             discriminator: nil,
@@ -55,14 +54,15 @@ module Apiwork
             value: options[:type] == :literal ? options[:value] : nil,
             variants: [],
           }
+          result[:default] = options[:default] if options.key?(:default)
+          result
         end
 
         def build_union_param(options)
           union_dump = build_union(options[:union])
 
-          {
+          result = {
             as: options[:as],
-            default: options[:default],
             deprecated: options[:deprecated] == true,
             description: resolve_attribute_description(options),
             discriminator: union_dump[:discriminator],
@@ -82,15 +82,16 @@ module Apiwork
             value: nil,
             variants: union_dump[:variants],
           }
+          result[:default] = options[:default] if options.key?(:default)
+          result
         end
 
         def build_custom_type_param(options)
           custom_type_name = options[:custom_type]
           custom_type_name = qualified_name(custom_type_name, @contract_param) if @contract_param.contract_class.resolve_custom_type(custom_type_name)
 
-          {
+          result = {
             as: options[:as],
-            default: options[:default],
             deprecated: options[:deprecated] == true,
             description: resolve_attribute_description(options),
             discriminator: nil,
@@ -110,6 +111,8 @@ module Apiwork
             value: nil,
             variants: [],
           }
+          result[:default] = options[:default] if options.key?(:default)
+          result
         end
 
         def resolve_type_reference(type_value)
@@ -163,7 +166,6 @@ module Apiwork
           result = {
             reference:,
             as: nil,
-            default: nil,
             deprecated: false,
             description: nil,
             discriminator: nil,
@@ -205,7 +207,6 @@ module Apiwork
           {
             reference:,
             as: nil,
-            default: nil,
             deprecated: false,
             description: nil,
             discriminator: nil,
@@ -312,7 +313,6 @@ module Apiwork
 
           result = {
             as: nil,
-            default: nil,
             deprecated: false,
             description: nil,
             discriminator: union ? of.discriminator : nil,
@@ -343,7 +343,6 @@ module Apiwork
         def build_api_variant(variant)
           {
             as: nil,
-            default: nil,
             deprecated: false,
             description: nil,
             discriminator: nil,

data/lib/apiwork/introspection/dump/resource.rb

@@ -19,13 +19,15 @@ module Apiwork
           )
 
           resource_path = build_resource_path(formatted_segment)
+          contract_class = resolve_contract_class
 
           {
-            actions: build_actions(resolve_contract_class, resource_path),
+            actions: build_actions(contract_class, resource_path),
             identifier: @resource.name.to_s,
             parent_identifiers: @parent_identifiers,
             path: resource_path,
             resources: build_nested_resources(resource_path),
+            scope: contract_class&.scope_prefix&.to_s,
           }
         end
 

data/lib/apiwork/introspection/dump/type.rb

@@ -39,8 +39,11 @@ module Apiwork
         end
 
         def build_type(qualified_name, type_definition)
+          scope = resolve_scope(type_definition.scope)
+
           if type_definition.union?
             {
+              scope:,
               deprecated: type_definition.deprecated?,
               description: resolve_type_description(qualified_name, type_definition),
               discriminator: type_definition.discriminator,
@@ -52,6 +55,7 @@ module Apiwork
             }
           else
             {
+              scope:,
               deprecated: type_definition.deprecated?,
               description: resolve_type_description(qualified_name, type_definition),
               discriminator: nil,
@@ -110,10 +114,9 @@ module Apiwork
                         resolve_type_reference(options[:type], scope)
                       end
 
-          {
+          result = {
             reference:,
             as: options[:as],
-            default: options[:default],
             deprecated: options[:deprecated] == true,
             description: resolve_param_description(name, options, scope),
             discriminator: nil,
@@ -132,6 +135,8 @@ module Apiwork
             value: options[:type] == :literal ? options[:value] : nil,
             variants: build_nested_variants(options[:shape]),
           }
+          result[:default] = options[:default] if options.key?(:default)
+          result
         end
 
         def build_variant(variant, scope)
@@ -141,7 +146,6 @@ module Apiwork
           {
             reference:,
             as: nil,
-            default: nil,
             deprecated: false,
             description: nil,
             discriminator: nil,
@@ -217,7 +221,6 @@ module Apiwork
 
           result = {
             as: nil,
-            default: nil,
             deprecated: false,
             description: nil,
             discriminator: union ? of.discriminator : nil,
@@ -260,12 +263,20 @@ module Apiwork
             deprecated: enum_definition.deprecated?,
             description: resolve_enum_description(qualified_name, enum_definition),
             example: enum_definition.example,
+            scope: resolve_scope(enum_definition.scope),
             values: enum_definition.values || [],
           }
         end
 
         private
 
+        def resolve_scope(scope)
+          return nil unless scope
+          return nil unless scope.respond_to?(:scope_prefix)
+
+          scope.scope_prefix.to_s
+        end
+
         def resolve_param_description(name, options, scope)
           return options[:description] if options[:description]
           return nil unless scope

data/lib/apiwork/introspection/enum.rb

@@ -38,6 +38,14 @@ module Apiwork
         @dump[:example]
       end
 
+      # @api public
+      # The scope for this enum.
+      #
+      # @return [String, nil]
+      def scope
+        @dump[:scope]
+      end
+
       # @api public
       # Whether this enum is deprecated.
       #
@@ -55,6 +63,7 @@ module Apiwork
           deprecated: deprecated?,
           description: description,
           example: example,
+          scope: scope,
           values: values,
         }
       end

data/lib/apiwork/introspection/param/array.rb

@@ -23,6 +23,9 @@ module Apiwork
         # @api public
         # The default for this param.
         #
+        # Returns `nil` for both "no default" and "default is explicitly `nil`".
+        # Use {#default?} to distinguish these cases.
+        #
         # @return [Object, nil]
         def default
           @dump[:default]

data/lib/apiwork/introspection/param/base.rb

@@ -48,6 +48,17 @@ module Apiwork
           @dump[:description]
         end
 
+        # @api public
+        # Whether this param has a default value.
+        #
+        # Use this to distinguish "no default" from "default is explicitly `nil`".
+        # The {#default} accessor returns `nil` in both cases.
+        #
+        # @return [Boolean]
+        def default?
+          @dump.key?(:default)
+        end
+
         # @api public
         # The tag for this param.
         #

data/lib/apiwork/introspection/param/binary.rb

@@ -23,6 +23,9 @@ module Apiwork
         # @api public
         # The default for this param.
         #
+        # Returns `nil` for both "no default" and "default is explicitly `nil`".
+        # Use {#default?} to distinguish these cases.
+        #
         # @return [Object, nil]
         def default
           @dump[:default]

data/lib/apiwork/introspection/param/boolean.rb

@@ -23,6 +23,9 @@ module Apiwork
         # @api public
         # The default for this param.
         #
+        # Returns `nil` for both "no default" and "default is explicitly `nil`".
+        # Use {#default?} to distinguish these cases.
+        #
         # @return [Object, nil]
         def default
           @dump[:default]

data/lib/apiwork/introspection/param/date.rb

@@ -23,6 +23,9 @@ module Apiwork
         # @api public
         # The default for this param.
         #
+        # Returns `nil` for both "no default" and "default is explicitly `nil`".
+        # Use {#default?} to distinguish these cases.
+        #
         # @return [Object, nil]
         def default
           @dump[:default]

data/lib/apiwork/introspection/param/date_time.rb

@@ -23,6 +23,9 @@ module Apiwork
         # @api public
         # The default for this param.
         #
+        # Returns `nil` for both "no default" and "default is explicitly `nil`".
+        # Use {#default?} to distinguish these cases.
+        #
         # @return [Object, nil]
         def default
           @dump[:default]

data/lib/apiwork/introspection/param/decimal.rb

@@ -27,6 +27,9 @@ module Apiwork
         # @api public
         # The default for this param.
         #
+        # Returns `nil` for both "no default" and "default is explicitly `nil`".
+        # Use {#default?} to distinguish these cases.
+        #
         # @return [Object, nil]
         def default
           @dump[:default]

data/lib/apiwork/introspection/param/integer.rb

@@ -28,6 +28,9 @@ module Apiwork
         # @api public
         # The default for this param.
         #
+        # Returns `nil` for both "no default" and "default is explicitly `nil`".
+        # Use {#default?} to distinguish these cases.
+        #
         # @return [Object, nil]
         def default
           @dump[:default]

data/lib/apiwork/introspection/param/number.rb

@@ -27,6 +27,9 @@ module Apiwork
         # @api public
         # The default for this param.
         #
+        # Returns `nil` for both "no default" and "default is explicitly `nil`".
+        # Use {#default?} to distinguish these cases.
+        #
         # @return [Object, nil]
         def default
           @dump[:default]

data/lib/apiwork/introspection/param/record.rb

@@ -17,6 +17,9 @@ module Apiwork
         # @api public
         # The default for this param.
         #
+        # Returns `nil` for both "no default" and "default is explicitly `nil`".
+        # Use {#default?} to distinguish these cases.
+        #
         # @return [Object, nil]
         def default
           @dump[:default]

data/lib/apiwork/introspection/param/string.rb

@@ -27,6 +27,9 @@ module Apiwork
         # @api public
         # The default for this param.
         #
+        # Returns `nil` for both "no default" and "default is explicitly `nil`".
+        # Use {#default?} to distinguish these cases.
+        #
         # @return [Object, nil]
         def default
           @dump[:default]

data/lib/apiwork/introspection/param/time.rb

@@ -23,6 +23,9 @@ module Apiwork
         # @api public
         # The default for this param.
         #
+        # Returns `nil` for both "no default" and "default is explicitly `nil`".
+        # Use {#default?} to distinguish these cases.
+        #
         # @return [Object, nil]
         def default
           @dump[:default]

data/lib/apiwork/introspection/param/uuid.rb

@@ -23,6 +23,9 @@ module Apiwork
         # @api public
         # The default for this param.
         #
+        # Returns `nil` for both "no default" and "default is explicitly `nil`".
+        # Use {#default?} to distinguish these cases.
+        #
         # @return [Object, nil]
         def default
           @dump[:default]

data/lib/apiwork/introspection/type.rb

@@ -100,6 +100,14 @@ module Apiwork
         @dump[:example]
       end
 
+      # @api public
+      # The scope for this type.
+      #
+      # @return [String, nil]
+      def scope
+        @dump[:scope]
+      end
+
       # @api public
       # Whether this type is deprecated.
       #
@@ -119,6 +127,7 @@ module Apiwork
           discriminator: discriminator,
           example: example,
           extends: extends,
+          scope: scope,
           shape: shape.transform_values(&:to_h),
           type: type,
           variants: variants.map(&:to_h),

data/lib/apiwork/issue.rb

@@ -56,7 +56,7 @@ module Apiwork
         code: code,
         detail: detail,
         meta: meta,
-        path: path.map(&:to_s),
+        path: path.map { |segment| segment.is_a?(Integer) ? segment : segment.to_s },
         pointer: pointer,
       }
     end