No typings on search body, other than Record<string, any>

[paul-uz]

Is there a way to get better typings on the body of a search result for example?

  search<
    TResponse = Record<string, any>,
    TRequestBody extends RequestBody = Record<string, any>,
    TContext = Context
  >(
    params?: RequestParams.Search<TRequestBody>,
    options?: TransportRequestOptions
  ): TransportRequestPromise<ApiResponse<TResponse, TContext>>;

I see there is SearchResponse for Msearch, but not Search

[nhtruong]

@paul-uz which version of the client are you using? We're testing Version 3.0.0 with beta-8 already out that have all request and response types.

[paul-uz]

Just using the latest stable release, set as ^2.13.0 in our package file. When will V3 be released officially?

[nhtruong]

The current beta version is going to be very close to the final version. We're trying to get more people to test the beta before releasing it. We're aiming to release by year end.

[paul-uz]

I just installed beta-8, and whilst i can click through and find the new type ie

export type Search_Response = ApiResponse & {
  body: Search_ResponseBody;
}

body is just showing as any in my IDE, VSCode :/

[paul-uz]

VSCode intellisense gives me this typing

const response: {
    body: any;
    statusCode: number | null;
    headers: Record<string, any> | null;
    warnings: string[] | null;
    meta: {
        context: unknown;
        name: string | symbol;
        request: {
            params: TransportRequestParams;
            options: TransportRequestOptions;
            id: any;
        };
        connection: Connection;
        attempts: number;
        aborted: boolean;
        sniff?: {
            hosts: any[];
            reason: string;
        } | undefined;
    };
    body: ResponseBody;
}

body is deifned twice somehow

[nhtruong]

The typing in this comment is coming from the 2.x version. Make sure that the 2.x package has been removed from your env.

[paul-uz]

The typing in this comment is coming from the 2.x version. Make sure that the 2.x package has been removed from your env.

I simply installed the beta over the top via NPM.

I'll try removing node_modules and reinstalling.

[paul-uz]

@nhtruong did a full removal of node_modules and package-lock, installed the latest beta, typings still broken, still two instances of body in the types

[paul-uz]

Code from 3.0.0-beta.8

export type Search_Response = ApiResponse & {
  body: Search_ResponseBody;
}

export interface ApiResponse {
  body: any;
  statusCode: number | null;
  headers: Record<string, any> | null;
  warnings: string[] | null;
  meta: {
    context: unknown;
    name: string | symbol;
    request: {
      params: TransportRequestParams;
      options: TransportRequestOptions;
      id: any;
    };
    connection: Connection;
    attempts: number;
    aborted: boolean;
    sniff?: {
      hosts: any[];
      reason: string;
    };
  };
}

[paul-uz]

Beta 7

export interface Search_Response extends ApiResponse {
  body: Search_ResponseBody;
}

there's the bug ;)

[nhtruong]

That's super odd. I'll look into it. Thanks for the finding.

[paul-uz]

That's super odd. I'll look into it. Thanks for the finding.

Yea looks like the change to a type union broke it. Happy to PR to revert if there is a workflow for contributions to V3?

[paul-uz]

PR open, please let me know if I;'ve done it correctly.

[nhtruong]

Thanks @paul-uz The fix is gonna be a bit more involved than that because that file was generated from the spec. I'm going to update the generator.

[paul-uz]

I'll leave it in your capable hands haha.

[nhtruong]

@paul-uz beta-9 is out with the fix.
If you find any more issues with it, please dont hesitate to let us know.