feat(shared): introduce autocomplete-shared package (#359)

francoischalifour · web-flow · commit af04ae1a53a8 · 2020-11-05T17:54:01.000+01:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -23,11 +23,13 @@ aliases:
     command: |
       set -exu
 
+      mkdir -p packages/autocomplete-shared/dist
       mkdir -p packages/autocomplete-core/dist
       mkdir -p packages/autocomplete-js/dist
       mkdir -p packages/autocomplete-plugin-recent-searches/dist
       mkdir -p packages/autocomplete-preset-algolia/dist
 
+      cp -R /tmp/workspace/packages/autocomplete-shared/dist packages/autocomplete-shared
       cp -R /tmp/workspace/packages/autocomplete-core/dist packages/autocomplete-core
       cp -R /tmp/workspace/packages/autocomplete-js/dist packages/autocomplete-js
       cp -R /tmp/workspace/packages/autocomplete-plugin-recent-searches/dist packages/autocomplete-plugin-recent-searches
@@ -61,11 +63,13 @@ jobs:
           command: |
             set -exu
 
+            mkdir -p /tmp/workspace/packages/autocomplete-shared/dist
             mkdir -p /tmp/workspace/packages/autocomplete-core/dist
             mkdir -p /tmp/workspace/packages/autocomplete-js/dist
             mkdir -p /tmp/workspace/packages/autocomplete-plugin-recent-searches/dist
             mkdir -p /tmp/workspace/packages/autocomplete-preset-algolia/dist
 
+            cp -R packages/autocomplete-shared/dist /tmp/workspace/packages/autocomplete-shared
             cp -R packages/autocomplete-core/dist /tmp/workspace/packages/autocomplete-core
             cp -R packages/autocomplete-js/dist /tmp/workspace/packages/autocomplete-js
             cp -R packages/autocomplete-plugin-recent-searches/dist /tmp/workspace/packages/autocomplete-plugin-recent-searches
diff --git a/babel.config.js b/babel.config.js
@@ -23,7 +23,6 @@ module.exports = (api) => {
       ],
     ],
     plugins: clean([
-      '@babel/plugin-transform-react-jsx',
       !isTest && [
         'inline-replace-variables',
         {
@@ -34,36 +33,6 @@ module.exports = (api) => {
         },
       ],
     ]),
-    overrides: [
-      {
-        test: 'packages/autocomplete-core',
-        plugins: clean([
-          !isTest && [
-            'inline-replace-variables',
-            {
-              __DEV__: {
-                type: 'node',
-                replacement: "process.env.NODE_ENV === 'development'",
-              },
-            },
-          ],
-        ]),
-      },
-      {
-        test: 'packages/autocomplete-preset-algolia',
-        plugins: clean([
-          !isTest && [
-            'inline-replace-variables',
-            {
-              __DEV__: {
-                type: 'node',
-                replacement: "process.env.NODE_ENV === 'development'",
-              },
-            },
-          ],
-        ]),
-      },
-    ],
   };
 };
 
diff --git a/bundlesize.config.json b/bundlesize.config.json
@@ -4,13 +4,17 @@
       "path": "packages/autocomplete-core/dist/umd/index.js",
       "maxSize": "4.5 kB"
     },
+    {
+      "path": "packages/autocomplete-js/dist/umd/index.js",
+      "maxSize": "8 kB"
+    },
     {
       "path": "packages/autocomplete-preset-algolia/dist/umd/index.js",
       "maxSize": "1.5 kB"
     },
     {
-      "path": "packages/autocomplete-js/dist/umd/index.js",
-      "maxSize": "8 kB"
+      "path": "packages/autocomplete-plugin-recent-searches/dist/umd/index.js",
+      "maxSize": "2.25 kB"
     }
   ]
 }
diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
-  "packages": ["packages/*"],
+  "packages": ["packages/*", "examples/*"],
   "version": "1.0.0-alpha.34",
   "npmClient": "yarn"
 }
diff --git a/package.json b/package.json
@@ -25,7 +25,6 @@
   },
   "devDependencies": {
     "@babel/cli": "7.11.5",
-    "@babel/plugin-transform-react-jsx": "7.10.4",
     "@babel/preset-env": "7.11.5",
     "@babel/preset-typescript": "7.10.4",
     "@rollup/plugin-json": "4.1.0",
diff --git a/packages/autocomplete-core/global.d.ts b/packages/autocomplete-core/global.d.ts
diff --git a/packages/autocomplete-core/package.json b/packages/autocomplete-core/package.json
@@ -29,5 +29,8 @@
     "on:change": "concurrently \"yarn build:esm\" \"yarn build:types\"",
     "prepare": "yarn build:esm && yarn build:types",
     "watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\""
+  },
+  "dependencies": {
+    "@algolia/autocomplete-shared": "1.0.0-alpha.34"
   }
 }
diff --git a/packages/autocomplete-core/src/types/api.ts b/packages/autocomplete-core/src/types/api.ts
@@ -1,8 +1,9 @@
+import { MaybePromise } from '@algolia/autocomplete-shared';
+
 import { AutocompleteAccessibilityGetters } from './getters';
 import { AutocompletePlugin } from './plugins';
 import { AutocompleteSetters } from './setters';
 import { AutocompleteState } from './state';
-import { MaybePromise } from './wrappers';
 
 export interface AutocompleteApi<
   TItem,
diff --git a/packages/autocomplete-js/package.json b/packages/autocomplete-js/package.json
@@ -31,8 +31,9 @@
     "watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\""
   },
   "dependencies": {
-    "@algolia/autocomplete-core": "^1.0.0-alpha.34",
-    "@algolia/autocomplete-preset-algolia": "^1.0.0-alpha.34"
+    "@algolia/autocomplete-core": "1.0.0-alpha.34",
+    "@algolia/autocomplete-preset-algolia": "1.0.0-alpha.34",
+    "@algolia/autocomplete-shared": "1.0.0-alpha.34"
   },
   "devDependencies": {
     "@algolia/client-search": "4.5.1"
diff --git a/packages/autocomplete-js/src/types/index.ts b/packages/autocomplete-js/src/types/index.ts
@@ -6,6 +6,7 @@ import {
   AutocompleteOptions as AutocompleteCoreOptions,
   AutocompleteSource as AutocompleteCoreSource,
 } from '@algolia/autocomplete-core';
+import { MaybePromise } from '@algolia/autocomplete-shared';
 
 type Template<TParams> = (params: TParams) => string | void;
 
@@ -49,12 +50,9 @@ export type InternalAutocompleteSource<TItem> = InternalAutocompleteCoreSource<
 > &
   SourceTemplates<TItem>;
 
-// @TODO: reuse MaybePromise from autocomplete-core when we find a way to share the type
 type GetSources<TItem> = (
   params: GetSourcesParams<TItem>
-) =>
-  | Array<AutocompleteCoreSource<TItem>>
-  | Promise<Array<AutocompleteCoreSource<TItem>>>;
+) => MaybePromise<Array<AutocompleteCoreSource<TItem>>>;
 
 export interface AutocompleteOptions<TItem>
   extends AutocompleteCoreOptions<TItem> {
diff --git a/packages/autocomplete-plugin-recent-searches/package.json b/packages/autocomplete-plugin-recent-searches/package.json
@@ -30,12 +30,9 @@
     "prepare": "yarn run build:esm",
     "watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\""
   },
-  "devDependencies": {
-    "@algolia/autocomplete-core": "^1.0.0-alpha.34",
-    "@algolia/autocomplete-js": "^1.0.0-alpha.34"
-  },
-  "peerDependencies": {
-    "@algolia/autocomplete-core": "^1.0.0-alpha.34",
-    "@algolia/autocomplete-js": "^1.0.0-alpha.34"
+  "dependencies": {
+    "@algolia/autocomplete-core": "1.0.0-alpha.34",
+    "@algolia/autocomplete-js": "1.0.0-alpha.34",
+    "@algolia/autocomplete-shared": "1.0.0-alpha.34"
   }
 }
diff --git a/packages/autocomplete-plugin-recent-searches/src/createRecentSearchesPlugin.ts b/packages/autocomplete-plugin-recent-searches/src/createRecentSearchesPlugin.ts
@@ -1,12 +1,13 @@
 import { AutocompletePlugin } from '@algolia/autocomplete-core';
 import { SourceTemplates } from '@algolia/autocomplete-js';
+import { MaybePromise, warn } from '@algolia/autocomplete-shared';
 
 import { createStore, RecentSearchesStorage } from './createStore';
 import {
   getTemplates as defaultGetTemplates,
   GetTemplatesParams,
 } from './getTemplates';
-import { MaybePromise, RecentSearchesItem } from './types';
+import { RecentSearchesItem } from './types';
 
 type Ref<TType> = {
   current: TType;
@@ -91,9 +92,7 @@ export function createRecentSearchesPlugin<TItem extends RecentSearchesItem>({
         // we cannot provide the facet filters in time when this function is called
         // because we need to resolve the promise before getting the value.
         if (!Array.isArray(lastItemsRef.current)) {
-          // @TODO: use the `warn` function from `autocomplete-core`
-          // eslint-disable-next-line no-console
-          console.warn(
+          warn(
             'The `getAlgoliaQuerySuggestionsFacetFilters` function is not supported with storages that return promises in `getAll`.'
           );
           return [];
@@ -106,9 +105,7 @@ export function createRecentSearchesPlugin<TItem extends RecentSearchesItem>({
         // we cannot provide the number of hits per page in time when this function
         // is called because we need to resolve the promise before getting the value.
         if (!Array.isArray(lastItemsRef.current)) {
-          // @TODO: use the `warn` function from `autocomplete-core`
-          // eslint-disable-next-line no-console
-          console.warn(
+          warn(
             'The `getAlgoliaQuerySuggestionsHitsPerPage` function is not supported with storages that return promises in `getAll`.'
           );
           return hitsPerPage;
diff --git a/packages/autocomplete-plugin-recent-searches/src/createStore.ts b/packages/autocomplete-plugin-recent-searches/src/createStore.ts
@@ -1,4 +1,5 @@
-import { MaybePromise } from './types';
+import { MaybePromise } from '@algolia/autocomplete-shared';
+
 import { RecentSearchesItem } from './types/RecentSearchesItem';
 
 export type RecentSearchesStore<TItem extends RecentSearchesItem> = {
diff --git a/packages/autocomplete-plugin-recent-searches/src/types/MaybePromise.ts b/packages/autocomplete-plugin-recent-searches/src/types/MaybePromise.ts
diff --git a/packages/autocomplete-plugin-recent-searches/src/types/index.ts b/packages/autocomplete-plugin-recent-searches/src/types/index.ts
@@ -1,2 +1 @@
-export * from './MaybePromise';
 export * from './RecentSearchesItem';
diff --git a/packages/autocomplete-preset-algolia/global.d.ts b/packages/autocomplete-preset-algolia/global.d.ts
diff --git a/packages/autocomplete-preset-algolia/package.json b/packages/autocomplete-preset-algolia/package.json
@@ -31,7 +31,14 @@
     "watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\""
   },
   "dependencies": {
+    "@algolia/autocomplete-shared": "1.0.0-alpha.34"
+  },
+  "devDependencies": {
     "@algolia/client-search": "4.5.1",
     "algoliasearch": "4.5.1"
+  },
+  "peerDependencies": {
+    "@algolia/client-search": "^4.5.1",
+    "algoliasearch": "^4.5.1"
   }
 }
diff --git a/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitHighlight.test.ts b/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitHighlight.test.ts
@@ -1,4 +1,5 @@
-import { warnCache } from '../../utils';
+import { warnCache } from '@algolia/autocomplete-shared';
+
 import { parseAlgoliaHitHighlight } from '../parseAlgoliaHitHighlight';
 
 describe('parseAlgoliaHitHighlight', () => {
diff --git a/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitReverseHighlight.test.ts b/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitReverseHighlight.test.ts
@@ -1,4 +1,5 @@
-import { warnCache } from '../../utils';
+import { warnCache } from '@algolia/autocomplete-shared';
+
 import { parseAlgoliaHitReverseHighlight } from '../parseAlgoliaHitReverseHighlight';
 
 describe('parseAlgoliaHitReverseHighlight', () => {
diff --git a/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitReverseSnippet.test.ts b/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitReverseSnippet.test.ts
@@ -1,4 +1,5 @@
-import { warnCache } from '../../utils';
+import { warnCache } from '@algolia/autocomplete-shared';
+
 import { parseAlgoliaHitReverseSnippet } from '../parseAlgoliaHitReverseSnippet';
 
 describe('parseAlgoliaHitReverseSnippet', () => {
diff --git a/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitSnippet.test.ts b/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitSnippet.test.ts
@@ -1,4 +1,5 @@
-import { warnCache } from '../../utils';
+import { warnCache } from '@algolia/autocomplete-shared';
+
 import { parseAlgoliaHitSnippet } from '../parseAlgoliaHitSnippet';
 
 describe('parseAlgoliaHitSnippet', () => {
diff --git a/packages/autocomplete-preset-algolia/src/highlight/parseAlgoliaHitHighlight.ts b/packages/autocomplete-preset-algolia/src/highlight/parseAlgoliaHitHighlight.ts
@@ -1,7 +1,6 @@
+import { warn } from '@algolia/autocomplete-shared';
 import { Hit } from '@algolia/client-search';
 
-import { warn } from '../utils';
-
 import { getAttributeValueByPath } from './getAttributeValueByPath';
 import { ParseAlgoliaHitParams } from './ParseAlgoliaHitParams';
 import { parseAttribute } from './parseAttribute';
diff --git a/packages/autocomplete-preset-algolia/src/highlight/parseAlgoliaHitSnippet.ts b/packages/autocomplete-preset-algolia/src/highlight/parseAlgoliaHitSnippet.ts
@@ -1,7 +1,6 @@
+import { warn } from '@algolia/autocomplete-shared';
 import { Hit } from '@algolia/client-search';
 
-import { warn } from '../utils';
-
 import { getAttributeValueByPath } from './getAttributeValueByPath';
 import { ParseAlgoliaHitParams } from './ParseAlgoliaHitParams';
 import { parseAttribute } from './parseAttribute';
diff --git a/packages/autocomplete-preset-algolia/src/utils/index.ts b/packages/autocomplete-preset-algolia/src/utils/index.ts
diff --git a/packages/autocomplete-shared/package.json b/packages/autocomplete-shared/package.json
@@ -0,0 +1,29 @@
+{
+  "name": "@algolia/autocomplete-shared",
+  "description": "Shared utils for Autocomplete packages.",
+  "version": "1.0.0-alpha.34",
+  "license": "MIT",
+  "homepage": "https://github.com/algolia/autocomplete.js",
+  "repository": "algolia/autocomplete.js",
+  "author": {
+    "name": "Algolia, Inc.",
+    "url": "https://www.algolia.com"
+  },
+  "source": "src/index.ts",
+  "types": "dist/esm/index.d.ts",
+  "module": "dist/esm/index.js",
+  "main": "dist/esm/index.js",
+  "sideEffects": false,
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build:clean": "rm -rf ./dist",
+    "build:esm": "babel src --root-mode upward --extensions '.ts,.tsx' --out-dir dist/esm --ignore '**/*/__tests__/'",
+    "build:types": "tsc -p ./tsconfig.declaration.json --outDir ./dist/esm",
+    "build": "yarn build:clean && yarn build:esm && yarn build:types",
+    "on:change": "concurrently \"yarn build:esm\" \"yarn build:types\"",
+    "prepare": "yarn build:esm && yarn build:types",
+    "watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\""
+  }
+}
diff --git a/packages/autocomplete-shared/src/MaybePromise.ts b/packages/autocomplete-shared/src/MaybePromise.ts
diff --git a/packages/autocomplete-shared/src/__tests__/warn.test.ts b/packages/autocomplete-shared/src/__tests__/warn.test.ts
diff --git a/packages/autocomplete-shared/src/index.ts b/packages/autocomplete-shared/src/index.ts
@@ -0,0 +1,2 @@
+export * from './warn';
+export * from './MaybePromise';
diff --git a/packages/autocomplete-shared/src/warn.ts b/packages/autocomplete-shared/src/warn.ts
diff --git a/packages/autocomplete-shared/tsconfig.declaration.json b/packages/autocomplete-shared/tsconfig.declaration.json
@@ -0,0 +1,3 @@
+{
+  "extends": "../../tsconfig.declaration"
+}
diff --git a/ship.config.js b/ship.config.js
@@ -4,16 +4,18 @@ const fs = require('fs');
 const path = require('path');
 
 const packages = [
+  'packages/autocomplete-shared',
   'packages/autocomplete-core',
-  'packages/autocomplete-preset-algolia',
   'packages/autocomplete-js',
+  'packages/autocomplete-preset-algolia',
   'packages/autocomplete-plugin-recent-searches',
 ];
 
 module.exports = {
   monorepo: {
     mainVersionFile: 'lerna.json',
-    packagesToBump: packages,
+    // We rely on Lerna to bump our dependencies.
+    packagesToBump: [],
     packagesToPublish: packages,
   },
   publishCommand({ tag }) {
@@ -26,19 +28,11 @@ module.exports = {
 
     // Update package dependencies
     exec(
-      `yarn workspace @algolia/autocomplete-js add "@algolia/autocomplete-core@^${version}" "@algolia/autocomplete-preset-algolia@^${version}"`
-    );
-    exec(
-      `yarn workspace @algolia/autocomplete-plugin-recent-searches add --peer "@algolia/autocomplete-core@^${version}" "@algolia/autocomplete-js@^${version}"`
-    );
-    exec(
-      `yarn workspace @algolia/autocomplete-plugin-recent-searches add --dev "@algolia/autocomplete-core@^${version}" "@algolia/autocomplete-js@^${version}"`
-    );
-    exec(
-      `yarn workspace @algolia/js-example add "@algolia/autocomplete-js@${version}" "@algolia/autocomplete-plugin-recent-searches@${version}"`
+      `yarn lerna version ${version} --exact --no-git-tag-version --no-push --yes`
     );
 
-    updatePackagesVersion({
+    // Update version files
+    updatePackagesVersionFile({
       version,
       files: [
         path.resolve(dir, 'packages', 'autocomplete-core', 'src', 'version.ts'),
@@ -53,7 +47,7 @@ module.exports = {
     });
   },
   // Skip preparation if it contains only `chore` commits
-  shouldPrepare: ({ releaseType, commitNumbersPerType }) => {
+  shouldPrepare({ releaseType, commitNumbersPerType }) {
     const { fix = 0 } = commitNumbersPerType;
 
     if (releaseType === 'patch' && fix === 0) {
@@ -64,7 +58,7 @@ module.exports = {
   },
 };
 
-function updatePackagesVersion({ version, files }) {
+function updatePackagesVersionFile({ version, files }) {
   for (const file of files) {
     fs.writeFileSync(file, `export const version = '${version}';\n`);
   }
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,17 @@`
`4`	`4`	`"path": "packages/autocomplete-core/dist/umd/index.js",`
`5`	`5`	`"maxSize": "4.5 kB"`
`6`	`6`	`},`
	`7`	`+ {`
	`8`	`+ "path": "packages/autocomplete-js/dist/umd/index.js",`
	`9`	`+ "maxSize": "8 kB"`
	`10`	`+ },`
`7`	`11`	`{`
`8`	`12`	`"path": "packages/autocomplete-preset-algolia/dist/umd/index.js",`
`9`	`13`	`"maxSize": "1.5 kB"`
`10`	`14`	`},`
`11`	`15`	`{`
`12`		`- "path": "packages/autocomplete-js/dist/umd/index.js",`
`13`		`- "maxSize": "8 kB"`
	`16`	`+ "path": "packages/autocomplete-plugin-recent-searches/dist/umd/index.js",`
	`17`	`+ "maxSize": "2.25 kB"`
`14`	`18`	`}`
`15`	`19`	`]`
`16`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "packages": ["packages/*"],`
	`2`	`+ "packages": ["packages/", "examples/"],`
`3`	`3`	`"version": "1.0.0-alpha.34",`
`4`	`4`	`"npmClient": "yarn"`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,5 +29,8 @@`
`29`	`29`	`"on:change": "concurrently \"yarn build:esm\" \"yarn build:types\"",`
`30`	`30`	`"prepare": "yarn build:esm && yarn build:types",`
`31`	`31`	`"watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\""`
	`32`	`+ },`
	`33`	`+ "dependencies": {`
	`34`	`+ "@algolia/autocomplete-shared": "1.0.0-alpha.34"`
`32`	`35`	`}`
`33`	`36`	`}`