Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Answers -> Search #143

Merged
merged 5 commits into from
Jul 19, 2022
Merged

Answers -> Search #143

merged 5 commits into from
Jul 19, 2022

Conversation

ElemelonWind
Copy link
Contributor

@ElemelonWind ElemelonWind commented Jul 14, 2022

J=SLAP-2196
TEST=auto

* Update README.md

* README and package updates

* prelim renaming

* Deprecation tag and exports updates

* public deprecation message

* Deprecation fix

* Update index.ts

* Delete deprecation.test.tsx

* deprecated file

* fix lint issues

* more updates

* test fixes

* readme fix

* fix types exports
@ElemelonWind ElemelonWind changed the title Answers -> Search 1: Customer facing renaming (#141) Answers -> Search Jul 14, 2022
@coveralls
Copy link

coveralls commented Jul 14, 2022

Coverage Status

Coverage increased (+0.7%) to 79.612% when pulling ab0e404 on feature/answers-to-search into 0a34725 on develop.

* renamed answers-headless imports

* Automated update to THIRD-PARTY-NOTICES from github action's 3rd party notices check

* version update

* update license

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
@ElemelonWind ElemelonWind marked this pull request as ready for review July 15, 2022 19:51
@ElemelonWind ElemelonWind requested a review from a team as a code owner July 15, 2022 19:51
README.md Outdated

For users that want to use class components instead of functional components, you can use the `AnswersHeadlessContext` directly to dispatch actions and receive updates from state.
For users that want to use class components instead of functional components, you can use the `SearchHeadlessContext` directly to dispatch actions, and the `subscribeToStateUpdates` HOC to receive updates from state.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

subscribeToStateUpdates was recently deprecated, so it looks like some changes in develop were reverted. this feature branch may need to be rebased off of the latest develop

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
}

/**
* @deprecated useAnswersUtilities has been deprecated and repalced by useSearchUtilities
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "replaced"

export function useAnswersUtilities(): SearchUtilities { return useSearchUtilities(); }

/**
* @deprecated AnswersHeadlessProvider has been deprecated and replaced by SearfchHeadlessProvider
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "SearchHeadlessProvider"

@ElemelonWind ElemelonWind merged commit 0ac8701 into develop Jul 19, 2022
@ElemelonWind ElemelonWind deleted the feature/answers-to-search branch July 19, 2022 16:16
@ElemelonWind ElemelonWind mentioned this pull request Jul 19, 2022
ElemelonWind added a commit that referenced this pull request Jul 19, 2022
## Version 1.3.0
`@yext/answers-headless-react` is now `@yext/search-headless-react`!  This means that much of the `answers` terminology is now deprecated and have been replaced by new `search` terms.
### Changes
- The following identifiers were renamed in (#143):
  - `AnswersHeadlessContext` &rarr; `SearchHeadlessContext`
  - `AnswersActions` &rarr; `SearchActions`
  - `AnswersUtilities` &rarr; `SearchUtilities`
  - `useAnswersActions` &rarr; `useSearchActions`
  - `useAnswersState` &rarr; `useSearchState`
  - `useAnswersUtilities` &rarr; `useSearchUtilities`
  - `AnswersHeadlessProvider` &rarr; `SearchHeadlessProvider`
- Additionally, direct exports from what was previously `@yext/answers-headless` have been replaced by their `@yext/search-headless` counterparts:
   - `answersUtilities` &rarr; `searchUtilities`
   - `provideAnswersHeadless` &rarr; `provideHeadless`
   - `AnswersHeadless` &rarr; `SearchHeadless`
   - `AnswersConfig` &rarr; `SearchConfig`
   - `AnswersConfigWithToken` &rarr; `SearchConfigWithToken`
   - `AnswersConfigWithApiKey` &rarr; `SearchConfigWithApiKey`
   - `AnswersCore` &rarr; `SearchCore`
   - `AnswersError` &rarr; `SearchError`
   - `AnswersRequest` &rarr; `SearchRequest`
   - `BaseAnswersConfig` &rarr; `BaseSearchConfig`
- Finally, `subscribeToStateUpdates` was deprecated in (#142)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants