[search-documents] Nest user-defined fields into a document property

[xirzec]

To prevent accidentally shadowing user-defined fields with server metadata, we should modify the following interfaces:

// existing interfaces
export type SearchResult<T> = {
    readonly score: number;
    readonly highlights?: {
        [propertyName: string]: string[];
    };
} & T;

export type SuggestResult<T> = {
    readonly text: string;
} & T;

to instead nest the user defined fields:

// desired interfaces
export type SearchResult<T> = {
    readonly score: number;
    readonly highlights?: {
        [propertyName: string]: string[];
    };
    document: T;
}

export type SuggestResult<T> = {
    readonly text: string;
    document: T;
};

In order to accomplish this in code, we will likely have to create a swagger transform to rewrite the server-metadata to map to names that can't conflict (e.g. underscore prefix, so @search.score becomes _score instead of score) and then writing a conversion function to massage the generated interface into the above public shape.

[sarangan12]

#9655

[sarangan12]

Code complete