Fix types

Author: shortcuts

examples/recently-viewed-items/app.tsx

@@ -10,7 +10,7 @@ import { h, Fragment } from 'preact';
 import '@algolia/autocomplete-theme-classic';
 
 import { createLocalStorageRecentlyViewedItems } from './recentlyViewedItemsPlugin';
-import { ProductItem, ProductHit } from './types/ProductHit';
+import { ProductHit } from './types';
 
 const appId = 'latency';
 const apiKey = '6be0576ff61c053d5f9a3225e2a90f76';
@@ -21,7 +21,7 @@ const recentlyViewedItems = createLocalStorageRecentlyViewedItems({
   limit: 5,
 });
 
-autocomplete({
+autocomplete<ProductHit>({
   container: '#autocomplete',
   placeholder: 'Search',
   openOnFocus: true,
@@ -35,7 +35,7 @@ autocomplete({
       {
         sourceId: 'products',
         getItems() {
-          return getAlgoliaHits<ProductItem>({
+          return getAlgoliaHits<ProductHit>({
             searchClient,
             queries: [
               {
@@ -55,6 +55,8 @@ autocomplete({
             id: item.objectID,
             label: item.name,
             image: item.image,
+            url: item.url,
+            _highlightResult: item._highlightResult,
           });
         },
         templates: {

examples/recently-viewed-items/package.json

@@ -6,7 +6,7 @@
   "license": "MIT",
   "main": "index.html",
   "scripts": {
-    "build": "parcel build index.html",
+    "build": "parcel build index.html --dist-dir ./dist",
     "start": "parcel index.html"
   },
   "dependencies": {
@@ -18,6 +18,8 @@
     "preact": "10.5.13"
   },
   "devDependencies": {
+    "@algolia/autocomplete-core": "1.0.0-alpha.45",
+    "@algolia/autocomplete-shared": "1.0.0-alpha.45",
     "parcel": "2.0.0-beta.2"
   },
   "keywords": [

examples/recently-viewed-items/recentlyViewedItemsPlugin.tsx

@@ -1,36 +1,47 @@
 /** @jsx h */
-import { AutocompletePlugin } from '@algolia/autocomplete-js';
+import {
+  AutocompletePlugin,
+  AutocompleteSource,
+  AutocompleteState,
+} from '@algolia/autocomplete-js';
 import {
   createLocalStorageRecentSearchesPlugin,
   search,
+  SearchParams,
 } from '@algolia/autocomplete-plugin-recent-searches';
+import { MaybePromise } from '@algolia/autocomplete-shared';
 import { h, Fragment } from 'preact';
 
-type RecentlyViewedItem = {
+import { Highlighted } from './types';
+
+type RecentlyViewedRecord = {
   id: string;
   label: string;
+  url: string;
   image: string;
-  _highlightResult: {
-    label: {
-      value: string;
-    };
-  };
 };
 
-type CreateLocalStorageRecentlyViewedItemsParams<TItem> = {
+type CreateLocalStorageRecentlyViewedItemsParams<
+  TItem extends RecentlyViewedRecord
+> = {
   key: string;
   limit?: number;
-  search?(params: any): any[];
+  search?(params: SearchParams<TItem>): Array<Highlighted<TItem>>;
+  transformSource?(params: {
+    source: AutocompleteSource<TItem>;
+    state: AutocompleteState<TItem>;
+    onRemove(id: string): void;
+  }): AutocompleteSource<TItem>;
 };
 
-type RecentlyViewedItemsPluginData<TItem> = {
+type RecentlyViewedItemsPluginData<TItem extends RecentlyViewedRecord> = {
   addItem(item: TItem): void;
   removeItem(id: string): void;
-  getAll(query?: string): any[];
+  getAll(query?: string): MaybePromise<Array<Highlighted<TItem>>>;
 };
 
 export function createLocalStorageRecentlyViewedItems<
-  TItem extends RecentlyViewedItem
+  TItem extends RecentlyViewedRecord
 >(
   params: CreateLocalStorageRecentlyViewedItemsParams<TItem>
 ): AutocompletePlugin<TItem, RecentlyViewedItemsPluginData<TItem>> {
@@ -39,7 +50,7 @@ export function createLocalStorageRecentlyViewedItems<
     onSubmit,
     subscribe,
     ...plugin
-  } = createLocalStorageRecentSearchesPlugin({
+  } = createLocalStorageRecentSearchesPlugin<TItem>({
     ...params,
     search(params) {
       if (params.query) {

examples/recently-viewed-items/types/Highlighted.ts

@@ -0,0 +1,7 @@
+export type Highlighted<TItem> = TItem & {
+  _highlightResult: {
+    label: {
+      value: string;
+    };
+  };
+};

examples/recently-viewed-items/types/ProductHit.ts

@@ -3,6 +3,7 @@ import { Hit } from '@algolia/client-search';
 export type ProductItem = {
   name: string;
   image: string;
+  url: string;
   description: string;
 };
 

examples/recently-viewed-items/types/index.ts

@@ -0,0 +1,2 @@
+export * from './Highlighted';
+export * from './ProductHit';