feat: expose raw request content under _rawContent

[e-krebs]

Summary

In order to access some composition-related data (when getRankingInfo is requested), we need to access the root content of the API response, not just results (cf. last example on this doc).

Result

exposing the root content of the API response (excluding results that is already exposed) through a _rawContent non-documented & non-typed property on search results.

it can therefor be accessed like this:

const { results: { _rawContent } } = useInstantSearch();

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 9bb93f4:

Sandbox	Source
example-instantsearch-getting-started	Configuration
example-react-instantsearch-getting-started	Configuration
example-react-instantsearch-next-app-dir-example	Configuration
example-react-instantsearch-next-routing-example	Configuration
example-vue-instantsearch-getting-started	Configuration

[Haroenv]

looks like it's "lucky" that we only override _state, not recreate a whole results object in places like

instantsearch/packages/instantsearch.js/src/widgets/index/index.ts

Line 303 in 6f2dc2f

derivedHelper.lastResults._state = helper!.state;

Maybe in server side rendering it could not be applied?

instantsearch/packages/instantsearch-core/src/widgets/index-widget.ts

Line 624 in 0bb5fcb

helper!.lastResults = results;

and

instantsearch/packages/instantsearch-core/src/widgets/index-widget.ts

Lines 569 to 579 in 0bb5fcb

	if (indexInitialResults?.results) {
	// We restore the shape of the results provided to the instance to respect
	// the helper's structure.
	const results = new algoliasearchHelper.SearchResults(
	new algoliasearchHelper.SearchParameters(indexInitialResults.state),
	indexInitialResults.results
	);
	derivedHelper.lastResults = results;
	helper.lastResults = results;
	}

[e-krebs]

@Haroenv the instantsearch-core package you're referencing above doesn't appear to exist on master 🤔

[Haroenv]

sorry was on the next branch, but this code exists in master too in InstantSearch.js

[e-krebs]

sorry was on the next branch, but this code exists in master too in InstantSearch.js

I did update my implementation 🙂

[e-krebs]

@Haroenv should I account for _rawContent here?

instantsearch/packages/instantsearch.js/src/widgets/index/index.ts

Lines 693 to 705 in e598230

	derivedHelper.on('result', ({ results }) => {
	// The index does not render the results it schedules a new render
	// to let all the other indices emit their own results. It allows us to
	// run the render process in one pass.
	instantSearchInstance.scheduleRender();
	// the derived helper is the one which actually searches, but the helper
	// which is exposed e.g. via instance.helper, doesn't search, and thus
	// does not have access to lastResults, which it used to in pre-federated
	// search behavior.
	helper!.lastResults = results;
	lastValidSearchParameters = results?._state;
	});

to do it properly here I'll have to add it to the types, though :

      derivedHelper.on('result', ({ results, _rawContent }) => {
        // The index does not render the results it schedules a new render
        // to let all the other indices emit their own results. It allows us to
        // run the render process in one pass.
        instantSearchInstance.scheduleRender();

        // the derived helper is the one which actually searches, but the helper
        // which is exposed e.g. via instance.helper, doesn't search, and thus
        // does not have access to lastResults, which it used to in pre-federated
        // search behavior.
        helper!.lastResults = results;
        helper!.lastResults._rawContent = _rawContent;
        lastValidSearchParameters = results?._state;
      });

[Haroenv]

No, that part is just copying the results so already works without changes.

[Haroenv]

we know this isn't permeated through the whole life cycle, but because of the limited use case, let's land it like this first. Thanks!