@algolia/algolia-custom-helpcenter-search 2.3.13 → 2.3.18

package/lib/src/answers.d.ts

@@ -18,7 +18,7 @@ export declare const customFindAnswers: ({ index, query, lang, searchParams, sou
     updated_at: number;
     position: number;
     title: string;
-    body_safe: string;
+    plain_body: string;
     outdated: boolean;
     promoted: boolean;
     vote_sum: number;
@@ -310,7 +310,7 @@ export declare const customFindAnswers: ({ index, query, lang, searchParams, sou
             readonly matchedWords: readonly string[];
             readonly fullyHighlighted?: boolean;
         };
-        body_safe?: {
+        plain_body?: {
             readonly value: string;
             readonly matchLevel: "none" | "full" | "partial";
             readonly matchedWords: readonly string[];
@@ -673,7 +673,7 @@ export declare const customFindAnswers: ({ index, query, lang, searchParams, sou
             readonly value: string;
             readonly matchLevel: "none" | "full" | "partial";
         };
-        body_safe: {
+        plain_body: {
             readonly value: string;
             readonly matchLevel: "none" | "full" | "partial";
         };

package/lib/src/autocomplete.d.ts

@@ -1,10 +1,3 @@
-/**
- * @typedef {Object} StartAutocompleteReturn
- * @property {Function} destroy
- *
- * @param {(HTMLElement|string)} container
- * @returns {StartAutocompleteReturn}
- */
 export declare const startAutocomplete: (container: HTMLElement) => {
     destroy: () => void;
 };

package/lib/src/constants.d.ts

@@ -11,3 +11,4 @@ export declare const PATHNAMES: {
     search: any;
     form: any;
 };
+export declare const INSIGHTS_KEY = "0acae364171326846d0a8a0930561663";

package/lib/src/templates.d.ts

@@ -6,7 +6,7 @@ export declare const bestHitTemplate: ({ item, titleAttribute, contentAttribute,
         sourceId: SourceId;
     };
     titleAttribute: string | string[];
-    contentAttribute: 'description' | 'content' | 'body_safe';
+    contentAttribute: 'description' | 'content' | 'plain_body';
     components: AutocompleteComponents;
 }) => JSX.Element;
 export declare const hitTemplate: (item: HitWithAnswer<FederatedHits> & {

package/lib/src/types.d.ts

@@ -61,7 +61,7 @@ declare const zendeskExampleHit: {
     updated_at: number;
     position: number;
     title: string;
-    body_safe: string;
+    plain_body: string;
     outdated: boolean;
     promoted: boolean;
     vote_sum: number;

package/lib/src/utils.d.ts

@@ -5,6 +5,7 @@ export declare const getElement: <TElement extends Element>(selector: string) =>
 export declare const debounced: <TParams>(params: TParams) => Promise<TParams>;
 export declare const getSortedHits: (SOURCES: Source[], query: string, genericAnswerParams?: Omit<FindAnswersOptions, 'attributesForPrediction'> & {
     EXPERIMENTAL_illuminate?: number;
+    clickAnalytics?: boolean;
 }) => Promise<{
     hits: Array<HitWithAnswer<FederatedHits> & {
         sourceId: SourceId;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/algolia-custom-helpcenter-search",
-  "version": "2.3.13",
+  "version": "2.3.18",
   "description": "Algolia's Zendesk Help Center search implementation",
   "repository": {
     "type": "git",
@@ -58,6 +58,7 @@
   },
   "dependencies": {
     "@algolia/autocomplete-js": "^1.2.2",
+    "@algolia/autocomplete-plugin-algolia-insights": "^1.8.1",
     "@algolia/autocomplete-preset-algolia": "^1.2.2",
     "@algolia/autocomplete-theme-classic": "^1.2.2",
     "@algolia/satellite": "^1.0.0-beta.109",
@@ -66,6 +67,7 @@
     "preact": "^10.5.14",
     "preact-render-to-string": "^5.1.19",
     "react-feather": "^2.0.9",
+    "search-insights": "^2.3.0",
     "throttle-debounce": "^3.0.1"
   },
   "scripts": {

package/CHANGELOG.md

@@ -1,292 +0,0 @@
-## [2.3.13](https://github.com/algolia/custom-zendesk-search/compare/v2.3.1...v2.3.13) (2022-11-23)
-
-
-
-## [2.3.12](https://github.com/algolia/custom-zendesk-search/compare/v2.3.1...v2.3.12) (2022-11-15)
-
-
-
-## [2.3.15](https://github.com/algolia/custom-zendesk-search/compare/v2.3.1...v2.3.15) (2022-11-10)
-
-
-
-## [2.3.14](https://github.com/algolia/custom-zendesk-search/compare/v2.3.1...v2.3.14) (2022-11-10)
-
-
-
-## [2.3.11](https://github.com/algolia/custom-zendesk-search/compare/v2.3.1...v2.3.11) (2022-10-07)
-
-
-
-## [2.3.10](https://github.com/algolia/custom-zendesk-search/compare/v2.3.1...v2.3.10) (2022-06-30)
-
-
-
-## [2.3.2](https://github.com/algolia/custom-zendesk-search/compare/v2.3.1...v2.3.2) (2022-06-30)
-
-
-
-## [2.3.9](https://github.com/algolia/custom-zendesk-search/compare/v2.3.1...v2.3.9) (2022-06-29)
-
-
-
-## [2.3.8](https://github.com/algolia/custom-zendesk-search/compare/v2.3.1...v2.3.8) (2022-06-28)
-
-
-
-## [2.3.4](https://github.com/algolia/custom-zendesk-search/compare/v2.3.1...v2.3.4) (2022-01-05)
-
-
-
-## [2.3.3](https://github.com/algolia/custom-zendesk-search/compare/v2.3.1...v2.3.3) (2021-12-07)
-
-
-
-## [2.3.2](https://github.com/algolia/custom-zendesk-search/compare/v2.3.1...v2.3.2) (2021-12-03)
-
-
-### Bug Fixes
-
-* **webpack5:** add style path to exports field in package.json ([f2d0c27](https://github.com/algolia/custom-zendesk-search/commit/f2d0c277b2c19f8e8a5560482e7a3701c5f018db))
-
-
-
-## [2.3.1](https://github.com/algolia/custom-zendesk-search/compare/v2.3.0...v2.3.1) (2021-10-27)
-
-
-
-# [2.3.0](https://github.com/algolia/custom-zendesk-search/compare/v2.1.0...v2.3.0) (2021-10-19)
-
-
-### Features
-
-* **answers:** replace content when extract attribute is the title ([b98551b](https://github.com/algolia/custom-zendesk-search/commit/b98551b232ba4e9eaef88909974417d391e4719f))
-
-
-
-# [2.2.0](https://github.com/algolia/custom-zendesk-search/compare/v2.1.0...v2.2.0) (2021-09-20)
-
-
-### Features
-
-* add title to answers attribute for prediction ([3da318e](https://github.com/algolia/custom-zendesk-search/commit/3da318e2516a9ac15ef4bbe5f9bd8dc43601169b))
-
-
-
-# [2.1.0](https://github.com/algolia/custom-zendesk-search/compare/v2.0.1...v2.1.0) (2021-09-02)
-
-
-### Features
-
-* add academy to placeholder ([9a82d64](https://github.com/algolia/custom-zendesk-search/commit/9a82d64f21a3a1a0aee6bdcf94b7b39da9cd5d20))
-* add intro phrase before ticket form results ([2fdf627](https://github.com/algolia/custom-zendesk-search/commit/2fdf6275654479463c403457f123f809934504e1))
-* change "discourse" labels to "community" ([eb22019](https://github.com/algolia/custom-zendesk-search/commit/eb220197a2c9e1bc764588c55db71e6dc506047e))
-* **sources:** academy content templating ([51520e4](https://github.com/algolia/custom-zendesk-search/commit/51520e42e42a83e841b81efb4c226637c8f0c704))
-* **sources:** add academy content ([e2b54b0](https://github.com/algolia/custom-zendesk-search/commit/e2b54b0f7a9284b0dceaaab0892a365a6ce62c6e))
-
-
-
-## [2.0.1](https://github.com/algolia/custom-zendesk-search/compare/v2.0.0...v2.0.1) (2021-09-01)
-
-
-### Bug Fixes
-
-* alias react to preact ([ac9910d](https://github.com/algolia/custom-zendesk-search/commit/ac9910dfc47daef3e167f9f470811597eabfb5e7))
-* use root vite config for demo build ([fd8f932](https://github.com/algolia/custom-zendesk-search/commit/fd8f932e29c9567350b0fdc34bbb7741e8fd3078))
-
-
-
-# [2.0.0](https://github.com/algolia/custom-zendesk-search/compare/v1.4.7...v2.0.0) (2021-08-25)
-
-
-### Features
-
-* switched from parcel to vite, types export, default umd export ([88f9494](https://github.com/algolia/custom-zendesk-search/commit/88f94948fdee5de2bee569fd575057cc31e463e1))
-
-
-### BREAKING CHANGES
-
-* adding lib in script tag is not sufficient anymore, now needs initialization with customSearch.default()
-
-
-
-# [2.0.0](https://github.com/algolia/custom-zendesk-search/compare/v1.4.7...v2.0.0) (2021-08-25)
-
-
-### Features
-
-* switched from parcel to vite, types export, default umd export ([88f9494](https://github.com/algolia/custom-zendesk-search/commit/88f94948fdee5de2bee569fd575057cc31e463e1))
-
-
-### BREAKING CHANGES
-
-* adding lib in script tag is not sufficient anymore, now needs initialization with customSearch.default()
-
-
-
-## [1.4.7](https://github.com/algolia/custom-zendesk-search/compare/v1.4.6...v1.4.7) (2021-08-24)
-
-
-
-## [1.4.6](https://github.com/algolia/custom-zendesk-search/compare/v1.4.5...v1.4.6) (2021-08-24)
-
-
-
-## [1.4.5](https://github.com/algolia/custom-zendesk-search/compare/v1.4.4...v1.4.5) (2021-08-24)
-
-
-
-## [1.4.4](https://github.com/algolia/custom-zendesk-search/compare/v1.4.3...v1.4.4) (2021-08-24)
-
-
-
-## [1.4.3](https://github.com/algolia/custom-zendesk-search/compare/v1.4.1...v1.4.3) (2021-08-24)
-
-
-
-## [1.4.2](https://github.com/algolia/custom-zendesk-search/compare/v1.4.1...v1.4.2) (2021-08-24)
-
-
-
-## [1.4.1](https://github.com/algolia/custom-zendesk-search/compare/v1.3.0...v1.4.1) (2021-08-23)
-
-
-### Bug Fixes
-
-* autocomplete test ([77c3edf](https://github.com/algolia/custom-zendesk-search/commit/77c3edff2c8d43993b47b2bc31524b7187df349c))
-* update tests ([d6d287f](https://github.com/algolia/custom-zendesk-search/commit/d6d287f216f1060fc4e6c87e64826e0208bf89ed))
-
-
-
-# [1.4.0](https://github.com/algolia/custom-zendesk-search/compare/v1.3.0...v1.4.0) (2021-08-23)
-
-
-### Features
-
-* add animated placeholder ([7a1abaa](https://github.com/algolia/custom-zendesk-search/commit/7a1abaaba8f80fe3c801cc47eef4507649bbf19d))
-
-
-
-# [1.3.0](https://github.com/algolia/custom-zendesk-search/compare/v1.2.2...v1.3.0) (2021-08-16)
-
-
-### Features
-
-* remove tailwind base and add back custom scoped only-needed base ([9c1a324](https://github.com/algolia/custom-zendesk-search/commit/9c1a32439bbd82c62a73194522902d97565d0b92))
-
-
-
-## [1.2.2](https://github.com/algolia/custom-zendesk-search/compare/v1.2.0...v1.2.2) (2021-08-12)
-
-
-
-## [1.2.1](https://github.com/algolia/custom-zendesk-search/compare/v1.2.0...v1.2.1) (2021-08-12)
-
-
-### Bug Fixes
-
-* **shipjs config:** push demo to master ([0996ce3](https://github.com/algolia/custom-zendesk-search/commit/0996ce33fd863803297dbba9f8a942e0008071d5))
-* **shipjs config:** require version ([20cd685](https://github.com/algolia/custom-zendesk-search/commit/20cd685dfeb1c955024afa1e4ad32749b57d7e22))
-
-
-
-# [1.2.0](https://github.com/algolia/custom-zendesk-search/compare/v1.1.1...v1.2.0) (2021-08-12)
-
-
-### Features
-
-* **responsive:** add cancel button to modal when going full screen ([6fd12a2](https://github.com/algolia/custom-zendesk-search/commit/6fd12a215a550554b6043e8590349cf850dd6df0))
-* **responsive:** autocomplete breakpoint ([02972b0](https://github.com/algolia/custom-zendesk-search/commit/02972b012e98a84fdcfbdfa50ada824a5a35d9fb))
-* **responsive:** switched to max Width to prevent overflow ([bf05052](https://github.com/algolia/custom-zendesk-search/commit/bf050523500cc976af2a614820b2704190785f2f))
-
-
-
-## [1.1.1](https://github.com/algolia/custom-zendesk-search/compare/v1.1.0...v1.1.1) (2021-08-09)
-
-
-### Bug Fixes
-
-* add padding to aa input ([ace4191](https://github.com/algolia/custom-zendesk-search/commit/ace4191ea457df3df9fdd47b7529ba53b154ff1c))
-
-
-
-# [1.1.0](https://github.com/algolia/custom-zendesk-search/compare/v1.0.1...v1.1.0) (2021-08-09)
-
-
-### Features
-
-* hide original suggestions list ([6c20524](https://github.com/algolia/custom-zendesk-search/commit/6c205245751d9e8b3fd3fa745f823c8200a7431d))
-
-
-
-## [1.0.1](https://github.com/algolia/custom-zendesk-search/compare/v1.0.0...v1.0.1) (2021-08-09)
-
-
-### Bug Fixes
-
-* request form pathname ([3e0463a](https://github.com/algolia/custom-zendesk-search/commit/3e0463a8248603bbdaf43ec178b5149e0bd2b7a6))
-
-
-
-# [1.0.0](https://github.com/algolia/custom-zendesk-search/compare/v0.1.3...v1.0.0) (2021-08-09)
-
-
-### Bug Fixes
-
-* groupBy util ([afdc4b7](https://github.com/algolia/custom-zendesk-search/commit/afdc4b794ff5e93a6aa8c4f9d85a911a2fc402ab))
-
-
-### Features
-
-* add instantsearch to request form ([82ded89](https://github.com/algolia/custom-zendesk-search/commit/82ded89e6b85b65e7a040ebac812fe3d68755eaa))
-* add keyboard indications ([e81e268](https://github.com/algolia/custom-zendesk-search/commit/e81e2689980322e687142843976eb92d8b5a446e))
-* add keyboard shortcut ([a1fc996](https://github.com/algolia/custom-zendesk-search/commit/a1fc996f38f98c73f2682901b5c157c386cd2526))
-* add see more ([9254268](https://github.com/algolia/custom-zendesk-search/commit/9254268db78be81bfd1a731c834fd430d55450bd))
-* add zendesk source ([664f69b](https://github.com/algolia/custom-zendesk-search/commit/664f69b667bd2061575f25587d4ffdb5ae861d8c))
-* additions to autocomplete and request form ([306dff9](https://github.com/algolia/custom-zendesk-search/commit/306dff92b0c71b01c81bd7d94a80e3a30cf2a956))
-* changed grouping algorithm to keep order ([d04a3fe](https://github.com/algolia/custom-zendesk-search/commit/d04a3fef68230cab77f0e1f61bbe2c0a5180cdbe))
-* instantsearch ([65cd138](https://github.com/algolia/custom-zendesk-search/commit/65cd138143ec1ec03b433b9933b73508e3480aa0))
-* removed debouncing on request form ([3dddddd](https://github.com/algolia/custom-zendesk-search/commit/3dddddd8a704537e7842e401564337168dfa2d12))
-* removed snippets from after first results ([28949e4](https://github.com/algolia/custom-zendesk-search/commit/28949e4a400ab2df755cf0a8dd8ea1a40c5d44ba))
-* see all link ([8f5c42b](https://github.com/algolia/custom-zendesk-search/commit/8f5c42b934ca44bbc0c0beaed930fd32c836425b))
-* try switch from IS to answers ([bfddbbf](https://github.com/algolia/custom-zendesk-search/commit/bfddbbfa21a1491707fc4da119afbd1d5c44e90b))
-
-
-
-## [0.1.3](https://github.com/algolia/custom-zendesk-search/compare/v0.1.1...v0.1.3) (2021-08-02)
-
-
-
-## [0.1.2](https://github.com/algolia/custom-zendesk-search/compare/v0.1.1...v0.1.2) (2021-07-30)
-
-
-
-## 0.1.1 (2021-07-30)
-
-
-### Bug Fixes
-
-* removed main property from package.json otherwise build fail ([946d82e](https://github.com/algolia/custom-zendesk-search/commit/946d82e5448b1f6c9421477ce0b9f6f8d8799bc9))
-
-
-
-# 0.1.0 (2021-07-30)
-
-
-### Bug Fixes
-
-* dependant of path only in production ([98aafc5](https://github.com/algolia/custom-zendesk-search/commit/98aafc57128a8e04d6e1b030a483a93a776d24d8))
-
-
-### Features
-
-* **autocomplete:** add basic results display ([31c16db](https://github.com/algolia/custom-zendesk-search/commit/31c16db30665abfb8e6d0b5ed4234f6dc5e16f46))
-* **autocomplete:** started implementation ([edcf632](https://github.com/algolia/custom-zendesk-search/commit/edcf632d19a16f2dd0eddfaf5e916ef3338a48a6))
-* **autocomplete:** templates v1 ([2fb8ec4](https://github.com/algolia/custom-zendesk-search/commit/2fb8ec4a46c08f8b5ef18dab5299221959b40bbf))
-* get ready for production ([c288c5a](https://github.com/algolia/custom-zendesk-search/commit/c288c5a3daa6d7bbe9ced543444917554b646b3c))
-* test 3 hits per type ([b453dd2](https://github.com/algolia/custom-zendesk-search/commit/b453dd273ba91f2e42db6b411f13aff879b23bb7))
-* test 5 most relevant answers on search ([68f8d77](https://github.com/algolia/custom-zendesk-search/commit/68f8d777aa1ea986302d9a1af8d73d1a95ecc603))
-* **ticket form:** add answers on ticket form request ([02ccb7c](https://github.com/algolia/custom-zendesk-search/commit/02ccb7c852d078e29b3a6a9249c9db6cb9539b31))
-
-
-