-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Expand file tree
/
Copy pathuseSearchInputWithTags.ts
More file actions
305 lines (260 loc) · 7.65 KB
/
useSearchInputWithTags.ts
File metadata and controls
305 lines (260 loc) · 7.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
import { useState } from "react";
import { useQueryParam, StringParam } from "use-query-params";
import { sortTagsByTotalUsage } from "./useFCOExploreSuggestions";
type tagTokenType = Record<"key" | "value", string>;
type tagTokenGroupsType = Record<string, string[]>;
type tagAggregationRecordType =
| Record<string, Record<string, unknown[]>>
| undefined;
type SuggestionModes = "KEY" | "VALUE";
interface filterInputInterface {
tagTokenGroups: tagTokenGroupsType;
searchTokens: string[];
}
interface TagSuggestionInstance {
suggestion: string;
description: string;
}
const generateEmptyStateSuggestions = (
tagsAggregationData: tagAggregationRecordType
) => {
if (tagsAggregationData) {
return sortTagsByTotalUsage(tagsAggregationData).map(
([tagKey, recordOfTagValues]) => {
const uniqueValues = Object.keys(recordOfTagValues).length;
const totalEntries = Object.values(recordOfTagValues).reduce(
(memo, current) => {
return memo + current.length;
},
0
);
return {
suggestion: tagKey,
description: `${uniqueValues} unique tag values. ${totalEntries} total entries.`,
};
}
);
} else {
return [];
}
};
const generateTagKeySuggestions = (
input: string,
tagsAggregationData: tagAggregationRecordType
) => {
if (tagsAggregationData) {
return Object.entries(tagsAggregationData)
.filter(([potentialTagKey, summary]) => {
return potentialTagKey.indexOf(input) >= 0;
})
.map(([potentialTagKey, summary]) => {
const tagValueVariants = Object.entries(summary);
return {
suggestion: potentialTagKey,
description: `${tagValueVariants.length} different tag values`,
};
});
} else {
return [];
}
};
const generateTagValueSuggestions = (
input: string,
tagsAggregationData: tagAggregationRecordType
) => {
if (tagsAggregationData) {
const [currentTagKey, currentTagValue] = input.split(":");
const entriesWithTagKey = tagsAggregationData[currentTagKey];
const summarizeCallback = (entry: unknown[]) => {
const potentialTagKey = entry[0] as string;
const summary = entry[1] as unknown[];
return {
suggestion: potentialTagKey,
description: `${summary.length} entries`,
};
};
if (entriesWithTagKey) {
if (currentTagValue && currentTagValue.length > 0) {
return Object.entries(entriesWithTagKey)
.filter(([potentialTagValue, entries]) => {
return (
potentialTagValue.indexOf(currentTagValue) >= 0 // &&
// potentialTagValue !== currentTagValue // Don't show exact matches, b/c that means we probably already selected it
);
})
.map(summarizeCallback);
} else {
return Object.entries(entriesWithTagKey).map(summarizeCallback);
}
} else {
return [];
}
} else {
return [];
}
};
function getAllSpacePositions(s: string) {
const indices: number[] = [];
while (
s.indexOf(" ", indices.length ? indices[indices.length - 1] + 1 : 0) !==
-1 &&
indices.length < 100
) {
const position = indices[indices.length - 1] || 0;
const index = s.indexOf(" ", position + 1);
indices.push(index);
}
return indices;
}
interface TagSplitterReturnInterface {
chunks: string[];
tokenInFocusIndex: number;
currentTag: string;
}
const parseTokenInput = (
cursorPosition: number | undefined,
tagsString: string
): TagSplitterReturnInterface => {
// Get where the spaces in the tagString, plus a start and end value
// e.g. "A:a B:b" would return
// [0, 3, 7]
const chunks = tagsString.split(" ");
const allSpacePositions = [0]
.concat(getAllSpacePositions(tagsString))
.concat(tagsString.length + 1);
let tokenInFocusIndex = 0;
if (cursorPosition) {
tokenInFocusIndex = allSpacePositions.findIndex((value, index) => {
return (
cursorPosition >= value &&
cursorPosition <= allSpacePositions[index + 1]
);
});
}
const currentTag = chunks[tokenInFocusIndex] || "";
return {
currentTag,
chunks,
tokenInFocusIndex,
};
};
const useSearchQuery = () => {
const [query, setQuery] = useQueryParam("q", StringParam);
const searchString = query || "";
const searchTokens = searchString.split(" ").filter((t) => t.length >= 3);
const setSearchString = (d: string) => {
setQuery(d);
};
return {
searchString,
searchTokens,
setSearchString,
};
};
const useTagsWithSuggestions = (
tagsAggregationData: tagAggregationRecordType
) => {
const [rawtagsString, setTagsStringParam] = useQueryParam(
"tags",
StringParam
);
const tagsString = rawtagsString || "";
// Spaces in the beginning of the string
// really messes with parseTokenInput(). Just prevent it.
const setTagsString = (s: string) => {
setTagsStringParam(s.trimStart());
};
const [cursorPosition, setCursor] = useState<number | undefined>(undefined);
const setCursorPosition = (position: number | undefined) => {
setCursor(position);
};
// Parse input into tokens, and detect which token
// we are focused on given the current cursor position
const { chunks, tokenInFocusIndex, currentTag } = parseTokenInput(
cursorPosition,
tagsString
);
const suggestionMode: SuggestionModes =
currentTag.indexOf(":") < 0 ? "KEY" : "VALUE";
let tagSuggestions: TagSuggestionInstance[] = [];
if (tagsAggregationData) {
if (currentTag.length > 0) {
if (suggestionMode === "KEY") {
tagSuggestions = generateTagKeySuggestions(
currentTag,
tagsAggregationData
);
} else {
tagSuggestions = generateTagValueSuggestions(
currentTag,
tagsAggregationData
);
}
} else {
// Current Tag is empty
tagSuggestions = generateEmptyStateSuggestions(tagsAggregationData);
}
}
// Helper method for accepting suggestions
const setSuggestionAtPositionInTagsString = (
suggestion: string,
position: number
) => {
const nextTagsTokens = chunks.slice(0);
nextTagsTokens[position] = suggestion;
setTagsString(nextTagsTokens.join(" "));
};
const acceptSuggestion = (suggestion: TagSuggestionInstance) => {
if (suggestionMode === "KEY") {
const newKeyText = suggestion.suggestion + ":";
setSuggestionAtPositionInTagsString(newKeyText, tokenInFocusIndex);
} else {
const [currentTagKey] = currentTag.split(":");
const newTagText = `${currentTagKey}:` + suggestion.suggestion;
setSuggestionAtPositionInTagsString(newTagText, tokenInFocusIndex);
}
};
const tagKeysSet = new Set<string>();
const tagTokens: tagTokenType[] = chunks
.filter((chunk: string) => {
return chunk.indexOf(":") > 0;
})
.map((chunk) => {
const parts = chunk.split(":");
tagKeysSet.add(parts[0]);
return {
key: parts[0],
value: parts[1],
};
});
const tagTokenGroups = tagTokens.reduce(
(memo: Record<string, string[]>, current) => {
if (memo[current.key]) {
memo[current.key].push(current.value);
} else {
memo[current.key] = [current.value];
}
return memo;
},
{}
);
return {
setCursorPosition,
currentTag,
tagsString,
setTagsString,
tagTokens,
tagTokenGroups,
tagKeysSet, // Used to determine which columns to add to search results,
suggestionMode,
tagSuggestions,
acceptSuggestion,
};
};
export { useTagsWithSuggestions, useSearchQuery };
export type {
filterInputInterface,
tagTokenGroupsType,
TagSuggestionInstance,
SuggestionModes,
};