feat(core): pass scoped API to lifecycle hooks

[francoischalifour]

Description

This forwards the setters and the refresh APIs to all the lifecycle hooks, including onStateChange and the plugin's subscribe function.

It allows for a more powerful plugins integration, required for Autocomplete Tags for example.

Example

function createTagPlugin<TItem extends {}>({
  getTagLabel,
  onTag,
}: CreateTagPluginProps<TItem>): AutocompletePlugin<TItem> {
  const tags = [];

  return {
    subscribe({ onSelect, refresh, setQuery }) {
      onSelect((params) => {
        tags.push(getTagLabel(params));
        setQuery("");
        refresh();
        onTag(params);
      });
    },
    onStateChange({ refresh }) {
      render(
        <ul className="aa-InputTagList">
          {tags.map((tag, index) => (
            <li key={index} className="aa-InputTagItem">
              <AutocompleteTag
                label={tag}
                onRemove={() => {
                  tags.splice(tags.indexOf(tag), 1);
                  refresh();
                }}
              />
            </li>
          ))}
        </ul>,
        tagContainer
      );
    }
  };
}

[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 47ebb11:

Sandbox	Source
@algolia/js-example	Configuration
@algolia/react-renderer-example	Configuration

[shortcuts]

As it's checking that it's last called with status: idle, is this test needed?

[francoischalifour]

I didn't change this test logic but you've got a point. This assertion is required but it should probably use .not.toHaveBeenCalledWith. I'll take care of that in another commit.