chore(escape-highlight): fix circular dependency (#4618)

shortcuts · web-flow · commit 08dd7ce6ba1a · 2021-01-14T09:18:20.000+01:00
* fix circular dependency

* Move `escape-highlight` file to `utils` folder
diff --git a/src/components/Hits/__tests__/Hits-test.js b/src/components/Hits/__tests__/Hits-test.js
@@ -3,7 +3,7 @@
 import { h } from 'preact';
 import { shallow, mount } from 'enzyme';
 import { highlight } from '../../../helpers';
-import { TAG_REPLACEMENT } from '../../../lib/escape-highlight';
+import { TAG_REPLACEMENT } from '../../../lib/utils';
 import Template from '../../Template/Template';
 import Hits from '../Hits';
 
diff --git a/src/connectors/autocomplete/__tests__/connectAutocomplete-test.ts b/src/connectors/autocomplete/__tests__/connectAutocomplete-test.ts
@@ -10,7 +10,7 @@ import {
 import { createSearchClient } from '../../../../test/mock/createSearchClient';
 import { createSingleSearchResponse } from '../../../../test/mock/createAPIResponse';
 import connectAutocomplete from '../connectAutocomplete';
-import { TAG_PLACEHOLDER } from '../../../lib/escape-highlight';
+import { TAG_PLACEHOLDER } from '../../../lib/utils';
 import { SearchClient } from '../../../types';
 
 describe('connectAutocomplete', () => {
diff --git a/src/connectors/autocomplete/connectAutocomplete.ts b/src/connectors/autocomplete/connectAutocomplete.ts
@@ -1,6 +1,7 @@
 import { SearchResults } from 'algoliasearch-helper';
-import escapeHits, { TAG_PLACEHOLDER } from '../../lib/escape-highlight';
 import {
+  escapeHits,
+  TAG_PLACEHOLDER,
   checkRendering,
   createDocumentationMessageGenerator,
   createSendEventForHits,
diff --git a/src/connectors/hits/__tests__/connectHits-test.ts b/src/connectors/hits/__tests__/connectHits-test.ts
@@ -2,7 +2,7 @@ import algoliasearchHelper, {
   SearchParameters,
   SearchResults,
 } from 'algoliasearch-helper';
-import { TAG_PLACEHOLDER } from '../../../lib/escape-highlight';
+import { TAG_PLACEHOLDER } from '../../../lib/utils';
 import connectHits from '../connectHits';
 import {
   createInitOptions,
diff --git a/src/connectors/hits/connectHits.ts b/src/connectors/hits/connectHits.ts
@@ -1,5 +1,6 @@
-import escapeHits, { TAG_PLACEHOLDER } from '../../lib/escape-highlight';
 import {
+  escapeHits,
+  TAG_PLACEHOLDER,
   checkRendering,
   createDocumentationMessageGenerator,
   addAbsolutePosition,
diff --git a/src/connectors/infinite-hits/__tests__/connectInfiniteHits-test.ts b/src/connectors/infinite-hits/__tests__/connectInfiniteHits-test.ts
@@ -9,7 +9,7 @@ import {
   createRenderOptions,
 } from '../../../../test/mock/createWidget';
 import { createSingleSearchResponse } from '../../../../test/mock/createAPIResponse';
-import { TAG_PLACEHOLDER } from '../../../lib/escape-highlight';
+import { TAG_PLACEHOLDER } from '../../../lib/utils';
 import connectInfiniteHits from '../connectInfiniteHits';
 import { createSearchClient } from '../../../../test/mock/createSearchClient';
 
diff --git a/src/connectors/infinite-hits/connectInfiniteHits.ts b/src/connectors/infinite-hits/connectInfiniteHits.ts
@@ -1,10 +1,11 @@
-import escapeHits, { TAG_PLACEHOLDER } from '../../lib/escape-highlight';
 import {
   AlgoliaSearchHelper as Helper,
   SearchParameters,
 } from 'algoliasearch-helper';
 import { Hits, Connector, TransformItems, Hit } from '../../types';
 import {
+  escapeHits,
+  TAG_PLACEHOLDER,
   checkRendering,
   createDocumentationMessageGenerator,
   isEqual,
diff --git a/src/connectors/refinement-list/__tests__/connectRefinementList-test.js b/src/connectors/refinement-list/__tests__/connectRefinementList-test.js
@@ -2,7 +2,7 @@ import jsHelper, {
   SearchResults,
   SearchParameters,
 } from 'algoliasearch-helper';
-import { TAG_PLACEHOLDER } from '../../../lib/escape-highlight';
+import { TAG_PLACEHOLDER } from '../../../lib/utils';
 import connectRefinementList from '../connectRefinementList';
 import { createInstantSearch } from '../../../../test/mock/createInstantSearch';
 import {
diff --git a/src/connectors/refinement-list/connectRefinementList.js b/src/connectors/refinement-list/connectRefinementList.js
@@ -1,14 +1,12 @@
 import {
+  escapeFacets,
+  TAG_PLACEHOLDER,
+  TAG_REPLACEMENT,
   checkRendering,
   createDocumentationMessageGenerator,
   createSendEventForFacet,
   noop,
 } from '../../lib/utils';
-import {
-  escapeFacets,
-  TAG_PLACEHOLDER,
-  TAG_REPLACEMENT,
-} from '../../lib/escape-highlight';
 
 const withUsage = createDocumentationMessageGenerator({
   name: 'refinement-list',
diff --git a/src/helpers/highlight.ts b/src/helpers/highlight.ts
@@ -1,7 +1,6 @@
 import { Hit } from '../types';
-import { getPropertyByPath } from '../lib/utils';
-import { TAG_REPLACEMENT } from '../lib/escape-highlight';
 import { component } from '../lib/suit';
+import { getPropertyByPath, TAG_REPLACEMENT } from '../lib/utils';
 
 export type HighlightOptions = {
   // @MAJOR string should no longer be allowed to be a path, only array can be a path
diff --git a/src/helpers/reverseHighlight.ts b/src/helpers/reverseHighlight.ts
@@ -1,11 +1,11 @@
 import { Hit } from '../types';
 import {
+  TAG_REPLACEMENT,
   getPropertyByPath,
   getHighlightedParts,
   reverseHighlightedParts,
   concatHighlightedParts,
 } from '../lib/utils';
-import { TAG_REPLACEMENT } from '../lib/escape-highlight';
 import { component } from '../lib/suit';
 
 export type ReverseHighlightOptions = {
diff --git a/src/helpers/reverseSnippet.ts b/src/helpers/reverseSnippet.ts
@@ -1,11 +1,11 @@
 import { Hit } from '../types';
 import {
+  TAG_REPLACEMENT,
   getPropertyByPath,
   getHighlightedParts,
   reverseHighlightedParts,
   concatHighlightedParts,
 } from '../lib/utils';
-import { TAG_REPLACEMENT } from '../lib/escape-highlight';
 import { component } from '../lib/suit';
 
 export type ReverseSnippetOptions = {
diff --git a/src/helpers/snippet.ts b/src/helpers/snippet.ts
@@ -1,7 +1,6 @@
 import { Hit } from '../types';
-import { getPropertyByPath } from '../lib/utils';
-import { TAG_REPLACEMENT } from '../lib/escape-highlight';
 import { component } from '../lib/suit';
+import { TAG_REPLACEMENT, getPropertyByPath } from '../lib/utils';
 
 export type SnippetOptions = {
   // @MAJOR string should no longer be allowed to be a path, only array can be a path
diff --git a/src/lib/utils/__tests__/escape-highlight-test.js b/src/lib/utils/__tests__/escape-highlight-test.js
@@ -1,4 +1,4 @@
-import escapeHits from '../escape-highlight';
+import { escapeHits } from '../escape-highlight';
 
 describe('escapeHits()', () => {
   it('should escape highlightProperty simple text value', () => {
diff --git a/src/lib/utils/concatHighlightedParts.ts b/src/lib/utils/concatHighlightedParts.ts
@@ -1,5 +1,5 @@
 import { HighlightedParts } from '../../types';
-import { TAG_REPLACEMENT } from '../escape-highlight';
+import { TAG_REPLACEMENT } from './escape-highlight';
 
 export default function concatHighlightedParts(parts: HighlightedParts[]) {
   const { highlightPreTag, highlightPostTag } = TAG_REPLACEMENT;
diff --git a/src/lib/utils/escape-highlight.ts b/src/lib/utils/escape-highlight.ts
@@ -1,5 +1,6 @@
-import { Hit, FacetHit, EscapedHits } from '../types';
-import { isPlainObject, escape } from '../lib/utils';
+import escape from './escape';
+import isPlainObject from './isPlainObject';
+import { Hit, FacetHit, EscapedHits } from '../../types';
 
 export const TAG_PLACEHOLDER = {
   highlightPreTag: '__ais-highlight__',
@@ -44,9 +45,7 @@ function recursiveEscape(input: any): any {
   };
 }
 
-export default function escapeHits<THit extends Hit>(
-  hits: THit[]
-): EscapedHits<THit> {
+export function escapeHits<THit extends Hit>(hits: THit[]): EscapedHits<THit> {
   if ((hits as any).__escaped === undefined) {
     // We don't override the value on hit because it will mutate the raw results
     // instead we make a shallow copy and we assign the escaped values on it.
diff --git a/src/lib/utils/getHighlightedParts.ts b/src/lib/utils/getHighlightedParts.ts
@@ -1,4 +1,4 @@
-import { TAG_REPLACEMENT } from '../../lib/escape-highlight';
+import { TAG_REPLACEMENT } from './escape-highlight';
 
 export default function getHighlightedParts(highlightedValue: string) {
   const { highlightPostTag, highlightPreTag } = TAG_REPLACEMENT;
diff --git a/src/lib/utils/index.ts b/src/lib/utils/index.ts
@@ -31,6 +31,12 @@ export { default as mergeSearchParameters } from './mergeSearchParameters';
 export { default as resolveSearchParameters } from './resolveSearchParameters';
 export { default as toArray } from './toArray';
 export { warning, deprecate } from './logger';
+export {
+  escapeHits,
+  TAG_PLACEHOLDER,
+  TAG_REPLACEMENT,
+  escapeFacets,
+} from './escape-highlight';
 export {
   createDocumentationLink,
   createDocumentationMessageGenerator,
