elasticgraph-schema_definition 0.19.3.1 → 1.0.0.rc1

data/lib/elastic_graph/schema_definition/schema_elements/field.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at
@@ -8,7 +8,6 @@
 
 require "delegate"
 require "elastic_graph/constants"
-require "elastic_graph/schema_artifacts/runtime_metadata/configured_graphql_resolver"
 require "elastic_graph/schema_definition/indexing/field"
 require "elastic_graph/schema_definition/indexing/field_reference"
 require "elastic_graph/schema_definition/mixins/has_directives"
@@ -53,6 +52,8 @@ module ElasticGraph
       #   @private
       # @!attribute [rw] grouped_by_customizations
       #   @private
+      # @!attribute [rw] highlights_customizations
+      #   @private
       # @!attribute [rw] sub_aggregations_customizations
       #   @private
       # @!attribute [rw] aggregated_values_customizations
@@ -69,6 +70,8 @@ module ElasticGraph
       #   @private
       # @!attribute [rw] groupable
       #   @private
+      # @!attribute [rw] highlightable
+      #   @private
       # @!attribute [rw] source
       #   @private
       # @!attribute [rw] runtime_field_script
@@ -83,15 +86,14 @@ module ElasticGraph
       #   @private
       # @!attribute [rw] as_input
       #   @private
-      # @!attribute [rw] legacy_grouping_schema
-      #   @private
       class Field < Struct.new(
         :name, :original_type, :parent_type, :original_type_for_derived_types, :schema_def_state, :accuracy_confidence,
-        :filter_customizations, :grouped_by_customizations, :sub_aggregations_customizations,
-        :aggregated_values_customizations, :sort_order_enum_value_customizations,
-        :args, :sortable, :filterable, :aggregatable, :groupable, :graphql_only, :source, :runtime_field_script, :relationship, :singular_name,
+        :filter_customizations, :grouped_by_customizations, :highlights_customizations, :sub_aggregations_customizations,
+        :aggregated_values_customizations, :sort_order_enum_value_customizations, :args,
+        :sortable, :filterable, :aggregatable, :groupable, :highlightable,
+        :graphql_only, :source, :runtime_field_script, :relationship, :singular_name,
         :computation_detail, :non_nullable_in_json_schema, :as_input,
-        :legacy_grouping_schema, :name_in_index, :resolver
+        :name_in_index, :resolver
       )
         include Mixins::HasDocumentation
         include Mixins::HasDirectives
@@ -103,8 +105,8 @@ module ElasticGraph
           name:, type:, parent_type:, schema_def_state:,
           accuracy_confidence: :high, name_in_index: name,
           type_for_derived_types: nil, graphql_only: nil, singular: nil,
-          sortable: nil, filterable: nil, aggregatable: nil, groupable: nil,
-          as_input: false, legacy_grouping_schema: false, resolver: nil
+          sortable: nil, filterable: nil, aggregatable: nil, groupable: nil, highlightable: nil,
+          as_input: false, resolver: nil
         )
           type_ref = schema_def_state.type_ref(type)
           super(
@@ -116,6 +118,7 @@ module ElasticGraph
             accuracy_confidence: accuracy_confidence,
             filter_customizations: [],
             grouped_by_customizations: [],
+            highlights_customizations: [],
             sub_aggregations_customizations: [],
             aggregated_values_customizations: [],
             sort_order_enum_value_customizations: [],
@@ -124,6 +127,7 @@ module ElasticGraph
             filterable: filterable,
             aggregatable: aggregatable,
             groupable: groupable,
+            highlightable: highlightable,
             graphql_only: graphql_only,
             source: nil,
             runtime_field_script: nil,
@@ -134,32 +138,17 @@ module ElasticGraph
             name_in_index: name_in_index,
             non_nullable_in_json_schema: false,
             as_input: as_input,
-            legacy_grouping_schema: legacy_grouping_schema,
             resolver: resolver
           )
 
-          if name != name_in_index
-            if graphql_only
-              schema_def_state.after_user_definition_complete do
-                unless backing_indexing_field
-                  raise Errors::SchemaError,
-                    "GraphQL-only field `#{parent_type.name}.#{name}` has a `name_in_index` (#{name_in_index}) which does not reference an " \
-                    "existing indexing field. To proceed, remove `graphql_only: true` or update `name_in_index` to match an existing indexing field."
-                end
-              end
-            elsif name_in_index.include?(".")
-              raise Errors::SchemaError,
-                "#{self} has an invalid `name_in_index`: #{name_in_index.inspect}. " \
-                "Only `graphql_only: true` fields can have a `name_in_index` that references a child field."
-            end
+          if name != name_in_index && name_in_index.include?(".") && !graphql_only
+            raise Errors::SchemaError, "#{self} has an invalid `name_in_index`: #{name_in_index.inspect}. Only `graphql_only: true` fields can have a `name_in_index` that references a child field."
           end
 
           schema_def_state.register_user_defined_field(self)
           yield self if block_given?
         end
 
-        private :resolver=
-
         # @private
         @@initialize_param_names = instance_method(:initialize).parameters.map(&:last).to_set
 
@@ -191,6 +180,7 @@ module ElasticGraph
         # @return [void]
         # @see #customize_aggregated_values_field
         # @see #customize_grouped_by_field
+        # @see #customize_highlights_field
         # @see #customize_sort_order_enum_values
         # @see #customize_sub_aggregations_field
         # @see #on_each_generated_schema_element
@@ -223,6 +213,7 @@ module ElasticGraph
         # @return [void]
         # @see #customize_filter_field
         # @see #customize_grouped_by_field
+        # @see #customize_highlights_field
         # @see #customize_sort_order_enum_values
         # @see #customize_sub_aggregations_field
         # @see #on_each_generated_schema_element
@@ -255,6 +246,7 @@ module ElasticGraph
         # @return [void]
         # @see #customize_aggregated_values_field
         # @see #customize_filter_field
+        # @see #customize_highlights_field
         # @see #customize_sort_order_enum_values
         # @see #customize_sub_aggregations_field
         # @see #on_each_generated_schema_element
@@ -277,6 +269,39 @@ module ElasticGraph
           grouped_by_customizations << customization_block
         end
 
+        # @note For each field defined in your schema that is highlightable, a corresponding highlights field will be created on the
+        #   `*Highlights` type derived from the parent object type.
+        #
+        # Registers a customization callback that will be applied to the corresponding highlights field that will be generated for this
+        # field.
+        #
+        # @yield [Field] derived highlights field
+        # @return [void]
+        # @see #customize_aggregated_values_field
+        # @see #customize_filter_field
+        # @see #customize_grouped_by_field
+        # @see #customize_sort_order_enum_values
+        # @see #customize_sub_aggregations_field
+        # @see #on_each_generated_schema_element
+        #
+        # @example Mark `CampaignHighlights.organizationId` with `@deprecated`
+        #   ElasticGraph.define_schema do |schema|
+        #     schema.object_type "Campaign" do |t|
+        #       t.field "id", "ID"
+        #
+        #       t.field "organizationId", "ID" do |f|
+        #         f.customize_highlights_field do |gbf|
+        #           gbf.directive "deprecated"
+        #         end
+        #       end
+        #
+        #       t.index "campaigns"
+        #     end
+        #   end
+        def customize_highlights_field(&customization_block)
+          highlights_customizations << customization_block
+        end
+
         # @note For each field defined in your schema that is sub-aggregatable (e.g. list fields indexed using the `nested` mapping type),
         # a corresponding field will be created on the `*AggregationSubAggregations` type derived from the parent object type.
         #
@@ -288,6 +313,7 @@ module ElasticGraph
         # @see #customize_aggregated_values_field
         # @see #customize_filter_field
         # @see #customize_grouped_by_field
+        # @see #customize_highlights_field
         # @see #customize_sort_order_enum_values
         # @see #on_each_generated_schema_element
         #
@@ -329,6 +355,7 @@ module ElasticGraph
         # @see #customize_aggregated_values_field
         # @see #customize_filter_field
         # @see #customize_grouped_by_field
+        # @see #customize_highlights_field
         # @see #customize_sub_aggregations_field
         # @see #on_each_generated_schema_element
         #
@@ -357,6 +384,8 @@ module ElasticGraph
         #   ask for values for the field in a response.
         # * A {Field} may be generated on the `*FilterInput` {InputType} derived from the parent {ObjectType} or {InterfaceType}. This is
         #   used by clients to specify how the query should filter.
+        # * A {Field} may be generated on the `*Highlights` {ObjectType} derived from the parent {ObjectType} or {InterfaceType}. This is
+        #   used by clients to request search highlights for a field.
         # * A {Field} may be generated on the `*AggregationGroupedBy` {ObjectType} derived from the parent {ObjectType} or {InterfaceType}.
         #   This is used by clients to specify how aggregations should be grouped.
         # * A {Field} may be generated on the `*AggregatedValues` {ObjectType} derived from the parent {ObjectType} or {InterfaceType}.
@@ -373,6 +402,7 @@ module ElasticGraph
         # @see #customize_aggregated_values_field
         # @see #customize_filter_field
         # @see #customize_grouped_by_field
+        # @see #customize_highlights_field
         # @see #customize_sort_order_enum_values
         # @see #customize_sub_aggregations_field
         #
@@ -381,15 +411,16 @@ module ElasticGraph
         #     schema.object_type "Transaction" do |t|
         #       t.field "id", "ID"
         #
-        #       t.field "amount", "Int" do |f|
+        #       t.field "currency", "String" do |f|
         #         f.on_each_generated_schema_element do |element|
-        #           # Adds a `@deprecated` directive to every GraphQL schema element generated for `amount`:
+        #           # Adds a `@deprecated` directive to every GraphQL schema element generated for `currency`:
         #           #
-        #           # - The `Transaction.amount` field.
-        #           # - The `TransactionFilterInput.amount` field.
-        #           # - The `TransactionAggregationGroupedBy.amount` field.
-        #           # - The `TransactionAggregatedValues.amount` field.
-        #           # - The `TransactionSortOrder.amount_ASC` and`TransactionSortOrder.amount_DESC` enum values.
+        #           # - The `Transaction.currency` field.
+        #           # - The `TransactionFilterInput.currency` field.
+        #           # - The `TransactionHighlights.currency` field.
+        #           # - The `TransactionAggregationGroupedBy.currency` field.
+        #           # - The `TransactionAggregatedValues.currency` field.
+        #           # - The `TransactionSortOrder.currency_ASC` and`TransactionSortOrder.currency_DESC` enum values.
         #           element.directive "deprecated"
         #         end
         #       end
@@ -402,6 +433,7 @@ module ElasticGraph
           customize_filter_field(&customization_block)
           customize_aggregated_values_field(&customization_block)
           customize_grouped_by_field(&customization_block)
+          customize_highlights_field(&customization_block)
           customize_sub_aggregations_field(&customization_block)
           customize_sort_order_enum_values(&customization_block)
         end
@@ -460,46 +492,6 @@ module ElasticGraph
           )
         end
 
-        # Configures the GraphQL resolver used to resolve this field. If not set, the resolver configured on the parent type
-        # via {Mixins::HasIndices#resolve_fields_with} will be used.
-        #
-        # @param resolver_name [Symbol] name of the GraphQL resolver
-        # @param config [Hash<Symbol, Object>] configuration parameters for the resolver
-        # @return [void]
-        # @see API#register_graphql_resolver
-        #
-        # @example Use a custom resolver for a custom `Query` field
-        #   # In `add_resolver.rb`:
-        #   class AddResolver
-        #     def initialize(elasticgraph_graphql:, config:)
-        #       @multiplier = config.fetch(:multiplier, 1)
-        #     end
-        #
-        #     def resolve(field:, object:, args:, context:)
-        #       sum = args.fetch("x") + args.fetch("y")
-        #       sum * @multiplier
-        #     end
-        #   end
-        #
-        #   # In `config/schema.rb`:
-        #   ElasticGraph.define_schema do |schema|
-        #     require(resolver_path = "add_resolver")
-        #     schema.register_graphql_resolver :add, AddResolver, defined_at: resolver_path
-        #
-        #     schema.on_root_query_type do |t|
-        #       t.field "add", "Int" do |f|
-        #         f.argument "x", "Int!"
-        #         f.argument "y", "Int!"
-        #
-        #         # Extra args (`multiplier: 2`, in this example) are passed to the resolver within `config`.
-        #         f.resolve_with :add, multiplier: 2
-        #       end
-        #     end
-        #   end
-        def resolve_with(resolver_name, **config)
-          self.resolver = resolver_name&.then { |name| SchemaArtifacts::RuntimeMetadata::ConfiguredGraphQLResolver.new(name, config) }
-        end
-
         # @private
         def runtime_script(script)
           self.runtime_field_script = script
@@ -609,14 +601,13 @@ module ElasticGraph
           # instead.
           return false if parent_type.indexed? && name == "id"
 
-          return false if relationship || type_disallows_grouping?
+          return false if relationship || type.fully_unwrapped.as_object_type&.does_not_support?(&:groupable?)
 
           # We don't support grouping an entire list of values, but we do support grouping on individual values in a list.
           # However, we only do so when a `singular_name` has been provided (so that we know what to call the grouped_by field).
           # The semantics are a little odd (since one document can be duplicated in multiple grouping buckets) so we're ok
           # with not offering it by default--the user has to opt-in by telling us what to call the field in its singular form.
-          # Types with their own `GroupedBy` type are grouped as individual values, like scalars.
-          return list_field_groupable_by_single_values? if type.list? && (type.fully_unwrapped.leaf? || original_type.fully_unwrapped.grouped_by_type_defined?)
+          return list_field_groupable_by_single_values? if type.list? && type.fully_unwrapped.leaf?
 
           # Nested fields will be supported through specific nested aggregation support, and do not
           # work as expected when grouping on the root document type.
@@ -660,6 +651,17 @@ module ElasticGraph
           nested? || type_for_derived_types.fully_unwrapped.as_object_type&.supports?(&:sub_aggregatable?)
         end
 
+        # @private
+        HIGHLIGHTABLE_MAPPING_TYPES = %w[keyword text match_only_text]
+
+        def highlightable?
+          return highlightable unless highlightable.nil?
+          return false if relationship
+          return true if HIGHLIGHTABLE_MAPPING_TYPES.include?(mapping_type)
+
+          type_for_derived_types.fully_unwrapped.as_object_type&.supports?(&:highlightable?)
+        end
+
         # Defines an argument on the field.
         #
         # @note ElasticGraph takes care of defining arguments for all the query features it supports, so there is generally no need to use
@@ -725,19 +727,33 @@ module ElasticGraph
           parent_type.field field_name, grouped_by_field_type_name, name_in_index: name_in_index, graphql_only: true do |f|
             add_grouped_by_field_documentation(f)
 
-            define_legacy_timestamp_grouping_arguments_if_needed(f) if legacy_grouping_schema
-
             grouped_by_customizations.each { |block| block.call(f) }
           end
         end
 
-        # Returns the GraphQL type used for this field's grouped value.
+        # @private
+        def define_highlights_field(parent_type)
+          return unless highlightable?
+
+          unwrapped_type = type_for_derived_types.fully_unwrapped
+          type_name =
+            if unwrapped_type.leaf?
+              "[String!]!"
+            else
+              unwrapped_type.as_highlights.name
+            end
+
+          parent_type.field name, type_name, name_in_index: name_in_index, graphql_only: true do |f|
+            f.documentation derived_documentation("Search highlights for the `#{name}`, providing snippets of the matching text")
+            highlights_customizations.each { |block| block.call(f) }
+          end
+        end
+
         # @private
         def grouped_by_field_type_name
           unwrapped_type = type_for_derived_types.fully_unwrapped
-          original_unwrapped_type = original_type_for_derived_types.fully_unwrapped
-          if original_unwrapped_type.grouped_by_type_defined? && !legacy_grouping_schema
-            original_unwrapped_type.as_grouped_by.name
+          if unwrapped_type.scalar_type_needing_grouped_by_object?
+            unwrapped_type.with_reverted_override.as_grouped_by.name
           elsif unwrapped_type.leaf?
             unwrapped_type.name
           else
@@ -757,7 +773,7 @@ module ElasticGraph
               "The `#{name}` field value for this group",
               list_field_grouped_by_doc_note("the selected subfields of `#{name}`")
             )
-          elsif original_type_for_derived_types.fully_unwrapped.grouped_by_type_defined? && !legacy_grouping_schema
+          elsif type_for_derived_types.fully_unwrapped.scalar_type_needing_grouped_by_object?
             derived_documentation("Offers the different grouping options for the `#{name}` value within this group")
           else
             derived_documentation("The `#{name}` field value for this group")
@@ -989,29 +1005,13 @@ module ElasticGraph
           )
         end
 
-        # The alternate field that is backing this field in the datastore index. Will only be non-`nil` for `graphql_only` fields.
-        # @return [Field, nil] the field backing this field in the index
-        #
-        # @private
+        private
+
         def backing_indexing_field
           return nil unless graphql_only
-
-          type = parent_type
-          field = nil
-
-          name_in_index.split(".").each do |path_part|
-            if (field = type&.indexing_fields_by_name_in_index&.fetch(path_part, nil))
-              type = field.type.fully_unwrapped.as_object_type
-            else
-              return nil
-            end
-          end
-
-          field
+          parent_type.indexing_fields_by_name_in_index[name_in_index]
         end
 
-        private
-
         def args_sdl(joiner:, after_opening_paren: "", &arg_selector)
           selected_args = args.values.select(&arg_selector)
           args_sdl = selected_args.map(&:to_sdl).flat_map { |s| s.split("\n") }.join(joiner)
@@ -1019,50 +1019,11 @@ module ElasticGraph
           "(#{after_opening_paren}#{args_sdl})"
         end
 
-        # Identifies types that disallow grouping, except for types that define their own `GroupedBy` type.
-        def type_disallows_grouping?
-          !original_type.fully_unwrapped.grouped_by_type_defined? && !!type.fully_unwrapped.as_object_type&.does_not_support?(&:groupable?)
-        end
-
         # Indicates if the field uses the `text` mapping type.
         def text?
           mapping_type == "text"
         end
 
-        def define_legacy_timestamp_grouping_arguments_if_needed(grouping_field)
-          case type.fully_unwrapped.name
-          when "Date"
-            grouping_field.argument schema_def_state.schema_elements.granularity, "DateGroupingGranularity!" do |a|
-              a.documentation "Determines the grouping granularity for this field."
-            end
-
-            grouping_field.argument schema_def_state.schema_elements.offset_days, "Int" do |a|
-              a.documentation <<~EOS
-                Number of days (positive or negative) to shift the `Date` boundaries of each date grouping bucket.
-
-                For example, when grouping by `YEAR`, this can be used to align the buckets with fiscal or school years instead of calendar years.
-              EOS
-            end
-          when "DateTime"
-            grouping_field.argument schema_def_state.schema_elements.granularity, "DateTimeGroupingGranularity!" do |a|
-              a.documentation "Determines the grouping granularity for this field."
-            end
-
-            grouping_field.argument schema_def_state.schema_elements.time_zone, "TimeZone" do |a|
-              a.documentation "The time zone to use when determining which grouping a `DateTime` value falls in."
-              a.default "UTC"
-            end
-
-            grouping_field.argument schema_def_state.schema_elements.offset, "DateTimeGroupingOffsetInput" do |a|
-              a.documentation <<~EOS
-                Amount of offset (positive or negative) to shift the `DateTime` boundaries of each grouping bucket.
-
-                For example, when grouping by `WEEK`, you can shift by 24 hours to change what day-of-week weeks are considered to start on.
-              EOS
-            end
-          end
-        end
-
         def list_field_grouped_by_doc_note(individual_value_selection_description)
           <<~EOS.strip
             Note: `#{name}` is a collection field, but selecting this field will group on individual values of #{individual_value_selection_description}.

data/lib/elastic_graph/schema_definition/schema_elements/field_path.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at

data/lib/elastic_graph/schema_definition/schema_elements/field_source.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at

data/lib/elastic_graph/schema_definition/schema_elements/graphql_sdl_enumerator.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at

data/lib/elastic_graph/schema_definition/schema_elements/input_field.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at

data/lib/elastic_graph/schema_definition/schema_elements/input_type.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at

data/lib/elastic_graph/schema_definition/schema_elements/interface_type.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at

data/lib/elastic_graph/schema_definition/schema_elements/list_counts_state.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at

data/lib/elastic_graph/schema_definition/schema_elements/object_type.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at

data/lib/elastic_graph/schema_definition/schema_elements/relationship.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at

data/lib/elastic_graph/schema_definition/schema_elements/scalar_type.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at
@@ -39,7 +39,16 @@ module ElasticGraph
       #   @private
       # @!attribute [rw] aggregated_values_customizations
       #   @private
-      class ScalarType < Struct.new(:schema_def_state, :type_ref, :mapping_type, :runtime_metadata, :aggregated_values_customizations)
+      # @!attribute [rw] filter_input_customizations
+      #   @private
+      class ScalarType < Struct.new(
+        :schema_def_state,
+        :type_ref,
+        :mapping_type,
+        :runtime_metadata,
+        :aggregated_values_customizations,
+        :filter_input_customizations
+      )
         # `Struct.new` provides the following methods:
         # @dynamic type_ref, runtime_metadata
         prepend Mixins::VerifiesGraphQLName
@@ -157,6 +166,13 @@ module ElasticGraph
           self.aggregated_values_customizations = block
         end
 
+        # Registers a block which will be used to customize the derived `*FilterInput` object type.
+        #
+        # @private
+        def customize_filter_input_type(&block)
+          self.filter_input_customizations = block
+        end
+
         # @private
         def aggregated_values_type
           if aggregated_values_customizations
@@ -284,6 +300,8 @@ module ElasticGraph
                 f.documentation LTE_DOC
               end
             end
+
+            filter_input_customizations&.call(t)
           end
         end
 

data/lib/elastic_graph/schema_definition/schema_elements/sort_order_enum_value.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at

data/lib/elastic_graph/schema_definition/schema_elements/sub_aggregation_path.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at

data/lib/elastic_graph/schema_definition/schema_elements/type_namer.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at
@@ -147,6 +147,7 @@ module ElasticGraph
           FieldsListFilterInput: "%{base}FieldsListFilterInput",
           FilterInput: "%{base}FilterInput",
           GroupedBy: "%{base}GroupedBy",
+          Highlights: "%{base}Highlights",
           InputEnum: "%{base}Input",
           ListElementFilterInput: "%{base}ListElementFilterInput",
           ListFilterInput: "%{base}ListFilterInput",

data/lib/elastic_graph/schema_definition/schema_elements/type_reference.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2026 Block, Inc.
+# Copyright 2024 - 2025 Block, Inc.
 #
 # Use of this source code is governed by an MIT-style
 # license that can be found in the LICENSE file or at
@@ -153,15 +153,12 @@ module ElasticGraph
             .sub(/[\]!]+\z/, "") # strip `]` and `!` characters from the end: https://rubular.com/r/pC8C0i7EpvHDbf
         end
 
-        # Indicates if this type opts into specialized grouping by defining its own `[type]GroupedBy` type.
-        # Use the original type name, before overrides, since an overridden name may identify another type.
-        # Only call this after the user definition is complete, when all grouping types are known.
-        def grouped_by_type_defined?
-          unless schema_def_state.user_definition_complete
-            raise Errors::SchemaError, "Cannot call `grouped_by_type_defined?` until the schema definition is complete."
-          end
-
-          schema_def_state.types_by_name.key?(as_grouped_by.name)
+        # Generally speaking, scalar types have `grouped_by` fields which are scalars of the same types,
+        # and object types have `grouped_by` fields which are special `[object_type]GroupedBy` types.
+        #
+        # ...except for some special cases (Date and DateTime), which this predicate detects.
+        def scalar_type_needing_grouped_by_object?
+          %w[Date DateTime].include?(type_namer.revert_override_for(name))
         end
 
         # Returns a new `TypeReference` with any type name overrides reverted (to provide the "original" type name).
@@ -290,6 +287,7 @@ module ElasticGraph
         # @dynamic as_edge
         # @dynamic as_fields_list_filter_input
         # @dynamic as_filter_input
+        # @dynamic as_highlights
         # @dynamic as_input_enum
         # @dynamic as_list_element_filter_input, list_element_filter_input?
         # @dynamic as_list_filter_input, list_filter_input?