[BUG] TS error when using _geo_distance in sort

[j0k3r]

What is the bug?

TS doesn't allow the field with geo data to be added in the _geo_distance of the sort object when performing a search.

How can one reproduce the bug?

Re-using the example from the doc: https://opensearch.org/docs/latest/search-plugins/searching-data/sort/#sorting-by-geo-distance

import { Client, type API } from '@opensearch-project/opensearch';

const client = new Client({ node: 'http://localhost:9200' });

const searchRequest: API.Search_Request = {
  "sort": [
    {
      "_geo_distance": {
        "point": [59, -54],
        "order": "asc",
        "distance_type": "arc"
      }
    }
  ],
  "query": {
    "match_all": {}
  }
};
const searchResponseBody = (await client.search(searchRequest)).body; 

TS will raise:

error TS2322: Type '{ point: number[]; order: "asc"; distance_type: "arc"; }' is not assignable to type 'FieldSort'.
  Object literal may only specify known properties, and 'point' does not exist in type '{ format?: string | undefined; missing?: FieldValue; mode?: SortMode | undefined; nested?: NestedSortValue | undefined; numeric_type?: FieldSortNumericType | undefined; order?: SortOrder | undefined; unmapped_type?: FieldType | undefined; }'.

What is the expected behavior?

The _geo_distance should access the point field (like it was before 3.0.0, but maybe because it wasn't properly typed)

What is your host/environment?

MacOS, Node 22.

Do you have any additional context?

GeoDistanceSort type doesn't allow any additional key:

opensearch-js/api/_types/_common.d.ts

Lines 233 to 239 in dada26a

	export type GeoDistanceSort = {
	distance_type?: GeoDistanceType;
	ignore_unmapped?: boolean;
	mode?: SortMode;
	order?: SortOrder;
	unit?: DistanceUnit;
	}

[nhtruong]

This looks a bug in the API generator since the JSON Schema of GeoDistanceSort on the spec is:

      type: object
      properties:
        mode:
          $ref: '#/components/schemas/SortMode'
        distance_type:
          $ref: '#/components/schemas/GeoDistanceType'
        ignore_unmapped:
          type: boolean
        order:
          $ref: '#/components/schemas/SortOrder'
        unit:
          $ref: '#/components/schemas/DistanceUnit'

Note that additionalProperties is not specified and should be understood as true.

Thanks for reporting this issue. I'll take a look at it and prepare a hotfix this week.

[nhtruong]

This is actually a bug on the spec that has been resolved.

Rerunning the API Code gen and preparing for the next minor version release with changes from the spec that will resolve this.

[nhtruong]

3.2.0 has been released with the fix from the spec.

[j0k3r]

@nhtruong Thanks!