elasticgraph-schema_definition 0.19.3.1 → 1.0.0.rc1

data/lib/elastic_graph/schema_definition/schema_elements/built_in_types.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
@@ -109,15 +109,9 @@ module ElasticGraph
       # ElasticGraph defines these enum types. Most of these are intended for usage as an _input_
       # argument, but they could be used as a return type in your schema if they meet your needs.
       #
-      # DateGroupingGranularity
-      # : Enumerates the supported granularities of a `Date`.
-      #
       # DateGroupingTruncationUnit
       # : Enumerates the supported truncation units of a `Date`.
       #
-      # DateTimeGroupingGranularity
-      # : Enumerates the supported granularities of a `DateTime`.
-      #
       # DateTimeGroupingTruncationUnit
       # : Enumerates the supported truncation units of a `DateTime`.
       #
@@ -152,20 +146,14 @@ module ElasticGraph
       # GeoLocation
       # : Geographic coordinates representing a location on the Earth's surface.
       #
-      # GeoTile
-      # : A tile in the Web Mercator XYZ grid. Its coordinates identify a cell, not a fixed ground distance.
-      #
-      # GeoTileBounds
-      # : The geographic bounds of a Web Mercator XYZ tile. Tiles do not cross the antimeridian.
-      #
-      # GeoTileCorners
-      # : The geographic locations of the four corners of a Web Mercator XYZ tile.
-      #
       # PageInfo
       # : Provides information about the specific fetched page. This implements the
       #   `PageInfo` specification from the [Relay GraphQL Cursor Connections
       #   Specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo).
       #
+      # SearchHighlight
+      # : Provides information about why a document matched a search via highlighted snippets.
+      #
       # @!attribute [rw] schema_def_api
       #   @private
       # @!attribute [rw] schema_def_state
@@ -189,7 +177,6 @@ module ElasticGraph
           register_custom_elastic_graph_scalars
           register_enum_types
           register_date_and_time_grouped_by_types
-          register_geo_grouped_by_types
           register_standard_elastic_graph_types
           register_standard_graphql_resolvers
         end
@@ -216,23 +203,6 @@ module ElasticGraph
         def register_standard_elastic_graph_types
           # This is a special filter on a `String` type, so we don't have a `Text` scalar to generate it from.
           schema_def_state.factory.build_standard_filter_input_types_for_index_leaf_type("String", name_prefix: "Text") do |t|
-            # We can't support filtering on `null` within a list, so make the field non-nullable when it's the
-            # `ListElementFilterInput` type. See scalar_type.rb for a larger comment explaining the rationale behind this.
-            equal_to_any_of_type = t.type_ref.list_element_filter_input? ? "[String!]" : "[String]"
-            t.field names.equal_to_any_of, equal_to_any_of_type do |f|
-              f.documentation ScalarType::EQUAL_TO_ANY_OF_DOC
-            end
-
-            t.field names.matches, "String" do |f|
-              f.documentation <<~EOS
-                Matches records where the field value matches the provided value using full text search.
-
-                When `null` is passed, matches all documents.
-              EOS
-
-              f.directive "deprecated", reason: "Use `#{names.matches_query}` instead."
-            end
-
             t.field names.matches_query, schema_def_state.type_ref("MatchesQuery").as_filter_input.name do |f|
               f.documentation <<~EOS
                 Matches records where the field value matches the provided query using full text search.
@@ -310,7 +280,71 @@ module ElasticGraph
               f.documentation "The input phrase to search for."
             end
 
-            # any_of/all_of/not don't really make sense on this filter because it doesn't make
+            # any_of/all_of/not don't really make sense on this filter because it doesn't make sense
+            # to apply an OR operator or negation to the fields of this type since they are all an
+            # indivisible part of a single filter operation on a specific field. So we remove them
+            # here.
+            remove_any_of_and_all_of_and_not_filter_operators_on(t)
+          end
+
+          register_filter "StringContains" do |t|
+            t.documentation <<~EOS
+              Input type used to specify parameters for the `#{names.contains}` string filtering operator.
+
+              When `null` is passed, matches all documents.
+            EOS
+
+            t.field names.any_substring_of, "[String!]" do |f|
+              f.documentation <<~EOS
+                Matches records where the field value contains one or more of the provided substrings.
+
+                When `null` is passed, matches all documents. When an empty list is passed,
+                this part of the filter matches no documents.
+              EOS
+            end
+
+            t.field names.all_substrings_of, "[String!]" do |f|
+              f.documentation <<~EOS
+                Matches records where the field value contains all of the provided substrings.
+
+                When `null` is passed or an empty list is passed, matches all documents.
+              EOS
+            end
+
+            t.field names.ignore_case, "Boolean!" do |f|
+              f.default false
+              f.documentation "Determines if the substring matching is case-sensitive (the default) or case-insensitive."
+            end
+
+            # any_of/all_of/not don't really make sense on this filter because it doesn't make sense
+            # to apply an OR operator or negation to the fields of this type since they are all an
+            # indivisible part of a single filter operation on a specific field. So we remove them
+            # here.
+            remove_any_of_and_all_of_and_not_filter_operators_on(t)
+          end
+
+          register_filter "StringStartsWith" do |t|
+            t.documentation <<~EOS
+              Input type used to specify parameters for the `#{names.starts_with}` string filtering operator.
+
+              When `null` is passed, matches all documents.
+            EOS
+
+            t.field names.any_prefix_of, "[String!]" do |f|
+              f.documentation <<~EOS
+                Matches records where the field value starts with one or more of the provided prefixes.
+
+                When `null` is passed, matches all documents. When an empty list is passed,
+                this part of the filter matches no documents.
+              EOS
+            end
+
+            t.field names.ignore_case, "Boolean!" do |f|
+              f.default false
+              f.documentation "Determines if the prefix matching is case-sensitive (the default) or case-insensitive."
+            end
+
+            # any_of/all_of/not don't really make sense on this filter because it doesn't make sense
             # to apply an OR operator or negation to the fields of this type since they are all an
             # indivisible part of a single filter operation on a specific field. So we remove them
             # here.
@@ -404,7 +438,7 @@ module ElasticGraph
           # to go from non-null to null, but is not a breaking change to make it non-null
           # in the future.
           register_framework_object_type "PageInfo" do |t|
-            t.resolve_fields_with :object_without_lookahead
+            t.default_graphql_resolver = :object_without_lookahead
 
             t.documentation <<~EOS
               Provides information about the specific fetched page. This implements the `PageInfo`
@@ -435,6 +469,23 @@ module ElasticGraph
             end
           end
 
+          register_framework_object_type "SearchHighlight" do |t|
+            t.default_graphql_resolver = :object_without_lookahead
+
+            t.documentation "Provides information about why a document matched a search via highlighted snippets."
+
+            t.field names.path, "[String!]!" do |f|
+              f.documentation <<~EOS
+                Path to a leaf field containing one or more search highlight snippets. The returned list will contain a path segment for
+                each object layer of the schema, from the document root.
+              EOS
+            end
+
+            t.field names.snippets, "[String!]!" do |f|
+              f.documentation "List of snippets containing search highlights from field values at this `path`."
+            end
+          end
+
           schema_def_api.factory.new_input_type("DateTimeGroupingOffsetInput") do |t|
             t.documentation <<~EOS
               Input type offered when grouping on `DateTime` fields, representing the amount of offset
@@ -522,7 +573,7 @@ module ElasticGraph
 
           register_framework_object_type "AggregationCountDetail" do |t|
             t.documentation "Provides detail about an aggregation `#{names.count}`."
-            t.resolve_fields_with :object_without_lookahead
+            t.default_graphql_resolver = :object_without_lookahead
 
             t.field names.approximate_value, "JsonSafeLong!", graphql_only: true do |f|
               f.documentation <<~EOS
@@ -629,6 +680,24 @@ module ElasticGraph
           schema_def_api.scalar_type "String" do |t|
             t.mapping type: "keyword"
             t.json_schema type: "string"
+
+            t.customize_filter_input_type do |fit|
+              fit.field names.contains, schema_def_state.type_ref("StringContains").as_filter_input.name do |f|
+                f.documentation <<~EOS
+                  Matches documents using substring filtering.
+
+                  When `null` is passed, matches all documents.
+                EOS
+              end
+
+              fit.field names.starts_with, schema_def_state.type_ref("StringStartsWith").as_filter_input.name do |f|
+                f.documentation <<~EOS
+                  Matches documents using prefix filtering.
+
+                  When `null` is passed, matches all documents.
+                EOS
+              end
+            end
           end
         end
 
@@ -963,38 +1032,6 @@ module ElasticGraph
           # elasticgraph-graphql/spec/acceptance/elasticgraph_graphql_spec.rb
           es_first_day_of_week = "Monday"
 
-          # TODO: Drop support for legacy grouping schema
-          schema_def_api.enum_type "DateGroupingGranularity" do |t|
-            t.documentation <<~EOS
-              Enumerates the supported granularities of a `Date`.
-            EOS
-
-            t.value "YEAR" do |v|
-              v.documentation "The year a `Date` falls in."
-              v.update_runtime_metadata datastore_value: "year"
-            end
-
-            t.value "QUARTER" do |v|
-              v.documentation "The quarter a `Date` falls in."
-              v.update_runtime_metadata datastore_value: "quarter"
-            end
-
-            t.value "MONTH" do |v|
-              v.documentation "The month a `Date` falls in."
-              v.update_runtime_metadata datastore_value: "month"
-            end
-
-            t.value "WEEK" do |v|
-              v.documentation "The week, beginning on #{es_first_day_of_week}, a `Date` falls in."
-              v.update_runtime_metadata datastore_value: "week"
-            end
-
-            t.value "DAY" do |v|
-              v.documentation "The exact day of a `Date`."
-              v.update_runtime_metadata datastore_value: "day"
-            end
-          end
-
           schema_def_api.enum_type "DateGroupingTruncationUnit" do |t|
             t.documentation <<~EOS
               Enumerates the supported truncation units of a `Date`.
@@ -1026,53 +1063,6 @@ module ElasticGraph
             end
           end
 
-          # TODO: Drop support for legacy grouping schema
-          schema_def_api.enum_type "DateTimeGroupingGranularity" do |t|
-            t.documentation <<~EOS
-              Enumerates the supported granularities of a `DateTime`.
-            EOS
-
-            t.value "YEAR" do |v|
-              v.documentation "The year a `DateTime` falls in."
-              v.update_runtime_metadata datastore_value: "year"
-            end
-
-            t.value "QUARTER" do |v|
-              v.documentation "The quarter a `DateTime` falls in."
-              v.update_runtime_metadata datastore_value: "quarter"
-            end
-
-            t.value "MONTH" do |v|
-              v.documentation "The month a `DateTime` falls in."
-              v.update_runtime_metadata datastore_value: "month"
-            end
-
-            t.value "WEEK" do |v|
-              v.documentation "The week, beginning on #{es_first_day_of_week}, a `DateTime` falls in."
-              v.update_runtime_metadata datastore_value: "week"
-            end
-
-            t.value "DAY" do |v|
-              v.documentation "The day a `DateTime` falls in."
-              v.update_runtime_metadata datastore_value: "day"
-            end
-
-            t.value "HOUR" do |v|
-              v.documentation "The hour a `DateTime` falls in."
-              v.update_runtime_metadata datastore_value: "hour"
-            end
-
-            t.value "MINUTE" do |v|
-              v.documentation "The minute a `DateTime` falls in."
-              v.update_runtime_metadata datastore_value: "minute"
-            end
-
-            t.value "SECOND" do |v|
-              v.documentation "The second a `DateTime` falls in."
-              v.update_runtime_metadata datastore_value: "second"
-            end
-          end
-
           schema_def_api.enum_type "DateTimeGroupingTruncationUnit" do |t|
             t.documentation <<~EOS
               Enumerates the supported truncation units of a `DateTime`.
@@ -1304,7 +1294,7 @@ module ElasticGraph
           date = schema_def_state.type_ref("Date")
           register_framework_object_type date.as_grouped_by.name do |t|
             t.documentation "Allows for grouping `Date` values based on the desired return type."
-            t.resolve_fields_with :object_with_lookahead
+            t.default_graphql_resolver = :object_with_lookahead
             t.override_runtime_metadata(elasticgraph_category: :date_grouped_by_object)
 
             t.field names.as_date, "Date", graphql_only: true do |f|
@@ -1322,7 +1312,7 @@ module ElasticGraph
           date_time = schema_def_state.type_ref("DateTime")
           register_framework_object_type date_time.as_grouped_by.name do |t|
             t.documentation "Allows for grouping `DateTime` values based on the desired return type."
-            t.resolve_fields_with :object_with_lookahead
+            t.default_graphql_resolver = :object_with_lookahead
             t.override_runtime_metadata(elasticgraph_category: :date_grouped_by_object)
 
             t.field names.as_date_time, "DateTime", graphql_only: true do |f|
@@ -1379,105 +1369,7 @@ module ElasticGraph
           end
         end
 
-        # Registers the geographic grouping operation and its tile, bounds, and corner output types.
-        def register_geo_grouped_by_types
-          register_framework_object_type schema_def_state.type_ref("GeoLocation").as_grouped_by.name do |t|
-            t.documentation "Offers geographic grouping representations for a location."
-            t.resolve_fields_with :object_with_lookahead
-            t.override_runtime_metadata(elasticgraph_category: :geo_location_grouped_by_object)
-
-            t.field names.as_geo_tile, "GeoTile", graphql_only: true do |f|
-              f.resolve_with :as_geo_tile
-
-              f.documentation <<~EOS
-                Groups locations into Web Mercator [XYZ tiles](https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames). Missing locations produce a `null` tile.
-                Points beyond ±85.0511° latitude are grouped into the northernmost or southernmost row,
-                so a point can be outside the bounds of the tile it is grouped into.
-                Boundary points are assigned to the tile to the east or south, subject to datastore coordinate encoding.
-              EOS
-
-              f.argument names.zoom_level, "Int!" do |a|
-                a.documentation <<~EOS
-                  The Web Mercator zoom level, from #{GEO_TILE_ZOOM_LEVELS.min} through #{GEO_TILE_ZOOM_LEVELS.max}.
-                  At zoom level z, the map has 2^z rows and 2^z columns. Increasing the zoom level by 1
-                  doubles both, producing four times as many tiles.
-                EOS
-                a.default 7
-              end
-            end
-          end
-
-          register_framework_object_type "GeoTile" do |t|
-            t.documentation "A tile in the Web Mercator XYZ grid. Its coordinates identify a cell, not a fixed ground distance."
-            t.resolve_fields_with :object_without_lookahead
-
-            t.field names.zoom_level, "Int!", graphql_only: true do |f|
-              f.documentation "The zoom level of the tile, from #{GEO_TILE_ZOOM_LEVELS.min} through #{GEO_TILE_ZOOM_LEVELS.max}."
-            end
-
-            {names.x => "west to east", names.y => "north to south"}.each do |name, direction|
-              t.field name, "Int!", graphql_only: true do |f|
-                f.documentation "The zero-based tile coordinate, counted #{direction}, from 0 through 2^zoomLevel - 1."
-              end
-            end
-
-            t.field names.map_center_point, "GeoLocation!", graphql_only: true do |f|
-              f.documentation <<~EOS
-                The center of the tile as drawn on a Web Mercator map, not the average record location or the midpoint
-                of the tile's latitude bounds. These differ noticeably only at low zoom levels: for tile 1/0/0,
-                the map center point is at about 66.51° latitude, but the bounds midpoint is at about 42.53°.
-              EOS
-            end
-
-            t.field names.bounds, "GeoTileBounds!", graphql_only: true do |f|
-              f.documentation "The geographic bounds of the tile. Web Mercator excludes the poles and stops at approximately ±85.0511°."
-            end
-
-            t.field names.corners, "GeoTileCorners!", graphql_only: true do |f|
-              f.documentation "The four corners of the tile, calculated from its geographic bounds."
-            end
-          end
-
-          register_framework_object_type "GeoTileBounds" do |t|
-            t.resolve_fields_with :object_without_lookahead
-            t.documentation "The geographic bounds of a Web Mercator XYZ tile. Tiles do not cross the antimeridian."
-
-            {
-              names.north => "latitude of the northern",
-              names.south => "latitude of the southern",
-              names.east => "longitude of the eastern",
-              names.west => "longitude of the western"
-            }.each do |name, description|
-              t.field name, "Float!", graphql_only: true do |f|
-                f.documentation "The #{description} boundary of the tile."
-              end
-            end
-          end
-
-          register_framework_object_type "GeoTileCorners" do |t|
-            t.resolve_fields_with :object_without_lookahead
-            t.documentation "The geographic locations of the four corners of a Web Mercator XYZ tile."
-
-            {
-              names.northwest => "northwest",
-              names.northeast => "northeast",
-              names.southwest => "southwest",
-              names.southeast => "southeast"
-            }.each do |name, description|
-              t.field name, "GeoLocation!", graphql_only: true do |f|
-                f.documentation "The #{description} corner of the tile."
-              end
-            end
-          end
-        end
-
         def register_standard_graphql_resolvers
-          require(require_path = "elastic_graph/graphql/aggregation/resolvers/as_geo_tile")
-          schema_def_api.register_graphql_resolver :as_geo_tile,
-            GraphQL::Aggregation::Resolvers::AsGeoTile,
-            defined_at: require_path,
-            built_in: true
-
           require(require_path = "elastic_graph/graphql/resolvers/get_record_field_value")
           schema_def_api.register_graphql_resolver :get_record_field_value,
             GraphQL::Resolvers::GetRecordFieldValue,

data/lib/elastic_graph/schema_definition/schema_elements/deprecated_element.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/directive.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/enum_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/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/enum_value_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

data/lib/elastic_graph/schema_definition/schema_elements/enums_for_indexed_types.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