@algolia/algolia-custom-helpcenter-search 2.3.21 → 2.3.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/lib/index.es.js +4 -4
  2. package/lib/index.umd.js +2 -2
  3. package/lib/src/answers.d.ts +11 -105
  4. package/lib/src/types.d.ts +2 -17
  5. package/package.json +1 -1
package/lib/src/answers.d.ts CHANGED
@@ -8,7 +8,7 @@ interface FindAnswersParams {
8
8
  searchParams?: SearchOptions;
9
9
  sourceId: SourceId;
10
10
  }
11
- export declare const customFindAnswers: ({ index, query, lang, searchParams, sourceId, }: FindAnswersParams) => Promise<import("./types").DocHit & import("./types").DiscourseHit & {
11
+ export declare const customFindAnswers: ({ index, query, lang, searchParams, sourceId, }: FindAnswersParams) => Promise<import("./types").DocHit & {
12
12
  locale: {
13
13
  locale: string;
14
14
  name: string;
@@ -215,68 +215,6 @@ export declare const customFindAnswers: ({ index, query, lang, searchParams, sou
215
215
  readonly matchedWords: readonly string[];
216
216
  readonly fullyHighlighted?: boolean;
217
217
  };
218
- post_number?: {
219
- readonly value: string;
220
- readonly matchLevel: "none" | "full" | "partial";
221
- readonly matchedWords: readonly string[];
222
- readonly fullyHighlighted?: boolean;
223
- };
224
- image_url?: {
225
- readonly value: string;
226
- readonly matchLevel: "none" | "full" | "partial";
227
- readonly matchedWords: readonly string[];
228
- readonly fullyHighlighted?: boolean;
229
- };
230
- content?: {
231
- readonly value: string;
232
- readonly matchLevel: "none" | "full" | "partial";
233
- readonly matchedWords: readonly string[];
234
- readonly fullyHighlighted?: boolean;
235
- };
236
- topic?: {
237
- id?: {
238
- readonly value: string;
239
- readonly matchLevel: "none" | "full" | "partial";
240
- readonly matchedWords: readonly string[];
241
- readonly fullyHighlighted?: boolean;
242
- };
243
- url?: {
244
- readonly value: string;
245
- readonly matchLevel: "none" | "full" | "partial";
246
- readonly matchedWords: readonly string[];
247
- readonly fullyHighlighted?: boolean;
248
- };
249
- title?: {
250
- readonly value: string;
251
- readonly matchLevel: "none" | "full" | "partial";
252
- readonly matchedWords: readonly string[];
253
- readonly fullyHighlighted?: boolean;
254
- };
255
- views?: {
256
- readonly value: string;
257
- readonly matchLevel: "none" | "full" | "partial";
258
- readonly matchedWords: readonly string[];
259
- readonly fullyHighlighted?: boolean;
260
- };
261
- slug?: {
262
- readonly value: string;
263
- readonly matchLevel: "none" | "full" | "partial";
264
- readonly matchedWords: readonly string[];
265
- readonly fullyHighlighted?: boolean;
266
- };
267
- like_count?: {
268
- readonly value: string;
269
- readonly matchLevel: "none" | "full" | "partial";
270
- readonly matchedWords: readonly string[];
271
- readonly fullyHighlighted?: boolean;
272
- };
273
- tags?: {
274
- readonly value: string;
275
- readonly matchLevel: "none" | "full" | "partial";
276
- readonly matchedWords: readonly string[];
277
- readonly fullyHighlighted?: boolean;
278
- }[];
279
- };
280
218
  locale?: {
281
219
  locale?: {
282
220
  readonly value: string;
@@ -400,6 +338,12 @@ export declare const customFindAnswers: ({ index, query, lang, searchParams, sou
400
338
  readonly matchedWords: readonly string[];
401
339
  readonly fullyHighlighted?: boolean;
402
340
  };
341
+ content?: {
342
+ readonly value: string;
343
+ readonly matchLevel: "none" | "full" | "partial";
344
+ readonly matchedWords: readonly string[];
345
+ readonly fullyHighlighted?: boolean;
346
+ };
403
347
  course_id?: {
404
348
  readonly value: string;
405
349
  readonly matchLevel: "none" | "full" | "partial";
@@ -608,48 +552,6 @@ export declare const customFindAnswers: ({ index, query, lang, searchParams, sou
608
552
  readonly value: string;
609
553
  readonly matchLevel: "none" | "full" | "partial";
610
554
  };
611
- post_number: {
612
- readonly value: string;
613
- readonly matchLevel: "none" | "full" | "partial";
614
- };
615
- image_url: {
616
- readonly value: string;
617
- readonly matchLevel: "none" | "full" | "partial";
618
- };
619
- content: {
620
- readonly value: string;
621
- readonly matchLevel: "none" | "full" | "partial";
622
- };
623
- topic: {
624
- id: {
625
- readonly value: string;
626
- readonly matchLevel: "none" | "full" | "partial";
627
- };
628
- url: {
629
- readonly value: string;
630
- readonly matchLevel: "none" | "full" | "partial";
631
- };
632
- title: {
633
- readonly value: string;
634
- readonly matchLevel: "none" | "full" | "partial";
635
- };
636
- views: {
637
- readonly value: string;
638
- readonly matchLevel: "none" | "full" | "partial";
639
- };
640
- slug: {
641
- readonly value: string;
642
- readonly matchLevel: "none" | "full" | "partial";
643
- };
644
- like_count: {
645
- readonly value: string;
646
- readonly matchLevel: "none" | "full" | "partial";
647
- };
648
- tags: {
649
- readonly value: string;
650
- readonly matchLevel: "none" | "full" | "partial";
651
- }[];
652
- };
653
555
  locale: {
654
556
  locale: {
655
557
  readonly value: string;
@@ -735,6 +637,10 @@ export declare const customFindAnswers: ({ index, query, lang, searchParams, sou
735
637
  readonly value: string;
736
638
  readonly matchLevel: "none" | "full" | "partial";
737
639
  };
640
+ content: {
641
+ readonly value: string;
642
+ readonly matchLevel: "none" | "full" | "partial";
643
+ };
738
644
  course_id: {
739
645
  readonly value: string;
740
646
  readonly matchLevel: "none" | "full" | "partial";
package/lib/src/types.d.ts CHANGED
@@ -36,21 +36,6 @@ export declare type DocHit = {
36
36
  category: string;
37
37
  objectID: string;
38
38
  };
39
- export declare type DiscourseHit = {
40
- url: string;
41
- post_number: number;
42
- image_url: string;
43
- content: string;
44
- topic: {
45
- id: number;
46
- url: string;
47
- title: string;
48
- views: number;
49
- slug: string;
50
- like_count: number;
51
- tags: string[];
52
- };
53
- };
54
39
  declare const zendeskExampleHit: {
55
40
  locale: {
56
41
  locale: string;
@@ -106,8 +91,8 @@ export declare type AcademyHit = {
106
91
  _tags: string[];
107
92
  objectID: string;
108
93
  };
109
- export declare type FederatedHits = DocHit & DiscourseHit & ZendeskHit & AcademyHit;
110
- export declare type SourceId = 'documentation' | 'community' | 'help center' | 'academy';
94
+ export declare type FederatedHits = DocHit & ZendeskHit & AcademyHit;
95
+ export declare type SourceId = 'documentation' | 'help center' | 'academy';
111
96
  export interface Source {
112
97
  sourceId: SourceId;
113
98
  indexName: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@algolia/algolia-custom-helpcenter-search",
3
- "version": "2.3.21",
3
+ "version": "2.3.22",
4
4
  "description": "Algolia's Zendesk Help Center search implementation",
5
5
  "repository": {
6
6
  "type": "git",