@fluid-topics/public-api 1.0.85-alpha → 1.0.86
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.
- package/.npmignore +14 -0
- package/dist/cjs/index.js +0 -8
- package/dist/cjs/roles/roles.js +1 -15
- package/dist/cjs/types/ft-common/public.js +188 -35
- package/dist/cjs/types/ft-server/public.js +7 -3
- package/dist/fluidtopics.min.js +1 -1
- package/dist/mjs/index.d.ts +0 -2
- package/dist/mjs/index.js +0 -8
- package/dist/mjs/roles/roles.d.ts +1 -5
- package/dist/mjs/roles/roles.js +0 -12
- package/dist/mjs/types/ft-common/public.d.ts +94 -8
- package/dist/mjs/types/ft-common/public.js +169 -31
- package/dist/mjs/types/ft-server/public.d.ts +1 -1
- package/dist/mjs/types/ft-server/public.js +7 -3
- package/package.json +1 -1
- package/yarn.lock +4323 -0
- package/.yarnrc +0 -1
|
@@ -21,7 +21,9 @@ export var FtMyLibraryColors;
|
|
|
21
21
|
FtMyLibraryColors["orange"] = "orange";
|
|
22
22
|
FtMyLibraryColors["yellow"] = "yellow";
|
|
23
23
|
})(FtMyLibraryColors || (FtMyLibraryColors = {}));
|
|
24
|
-
export const isFtMyLibraryColors = (o) =>
|
|
24
|
+
export const isFtMyLibraryColors = (o) => {
|
|
25
|
+
return ["black", "green", "blue", "purple", "red", "orange", "yellow"].includes(o);
|
|
26
|
+
};
|
|
25
27
|
// From: SourceType
|
|
26
28
|
export var FtTopicOriginType;
|
|
27
29
|
(function (FtTopicOriginType) {
|
|
@@ -29,12 +31,39 @@ export var FtTopicOriginType;
|
|
|
29
31
|
FtTopicOriginType["PERSONAL"] = "PERSONAL";
|
|
30
32
|
FtTopicOriginType["SHARED"] = "SHARED";
|
|
31
33
|
})(FtTopicOriginType || (FtTopicOriginType = {}));
|
|
32
|
-
export const isFtTopicOriginType = (o) =>
|
|
34
|
+
export const isFtTopicOriginType = (o) => {
|
|
35
|
+
return ["OFFICIAL", "PERSONAL", "SHARED"].includes(o);
|
|
36
|
+
};
|
|
37
|
+
export const isFtAnalyticsEventDisplay = (o) => {
|
|
38
|
+
return isObject(o)
|
|
39
|
+
&& (isNumber(o.width))
|
|
40
|
+
&& (isNumber(o.height));
|
|
41
|
+
};
|
|
42
|
+
export const isFtAnalyticsEventGenAIProfile = (o) => {
|
|
43
|
+
return isObject(o)
|
|
44
|
+
&& (o.customPrompt == null || isString(o.customPrompt))
|
|
45
|
+
&& (isString(o.name))
|
|
46
|
+
&& (isString(o.id));
|
|
47
|
+
};
|
|
33
48
|
export const isFtAnalyticsEventLocation = (o) => {
|
|
34
49
|
return isObject(o)
|
|
35
50
|
&& (isString(o.type))
|
|
36
51
|
&& (isString(o.value));
|
|
37
52
|
};
|
|
53
|
+
export const isFtAnalyticsEventOrigin = (o) => {
|
|
54
|
+
return isObject(o)
|
|
55
|
+
&& (isString(o.pageType))
|
|
56
|
+
&& (isString(o.type))
|
|
57
|
+
&& (isString(o.url));
|
|
58
|
+
};
|
|
59
|
+
export const isFtAnalyticsEventPage = (o) => {
|
|
60
|
+
return isObject(o)
|
|
61
|
+
&& (isString(o.name))
|
|
62
|
+
&& (o.language == null || isString(o.language))
|
|
63
|
+
&& (isString(o.id))
|
|
64
|
+
&& (isString(o.type))
|
|
65
|
+
&& (isString(o.url));
|
|
66
|
+
};
|
|
38
67
|
export const isFtAnalyticsEventPublication = (o) => {
|
|
39
68
|
return isObject(o)
|
|
40
69
|
&& (o.metadata == null || (Array.isArray(o.metadata)
|
|
@@ -89,7 +118,9 @@ export var FtAnalyticsPublicationType;
|
|
|
89
118
|
FtAnalyticsPublicationType["MAP_ATTACHMENT"] = "MAP_ATTACHMENT";
|
|
90
119
|
FtAnalyticsPublicationType["RESOURCE"] = "RESOURCE";
|
|
91
120
|
})(FtAnalyticsPublicationType || (FtAnalyticsPublicationType = {}));
|
|
92
|
-
export const isFtAnalyticsPublicationType = (o) =>
|
|
121
|
+
export const isFtAnalyticsPublicationType = (o) => {
|
|
122
|
+
return ["STRUCTURED_DOCUMENT", "UNSTRUCTURED_DOCUMENT", "SHARED_PERSONAL_BOOK", "PERSONAL_BOOK", "MAP_ATTACHMENT", "RESOURCE"].includes(o);
|
|
123
|
+
};
|
|
93
124
|
export const isFtAnalyticsSearchFacet = (o) => {
|
|
94
125
|
return isObject(o)
|
|
95
126
|
&& (o.dateValue == null || isFtAnalyticsSearchDateFacetValue(o.dateValue))
|
|
@@ -108,7 +139,9 @@ export var FtAnalyticsSearchDateFacetValue;
|
|
|
108
139
|
FtAnalyticsSearchDateFacetValue["LAST_QUARTER"] = "LAST_QUARTER";
|
|
109
140
|
FtAnalyticsSearchDateFacetValue["LAST_YEAR"] = "LAST_YEAR";
|
|
110
141
|
})(FtAnalyticsSearchDateFacetValue || (FtAnalyticsSearchDateFacetValue = {}));
|
|
111
|
-
export const isFtAnalyticsSearchDateFacetValue = (o) =>
|
|
142
|
+
export const isFtAnalyticsSearchDateFacetValue = (o) => {
|
|
143
|
+
return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR"].includes(o);
|
|
144
|
+
};
|
|
112
145
|
// From: AnalyticsSearchFacetType
|
|
113
146
|
export var FtAnalyticsSearchFacetType;
|
|
114
147
|
(function (FtAnalyticsSearchFacetType) {
|
|
@@ -116,7 +149,9 @@ export var FtAnalyticsSearchFacetType;
|
|
|
116
149
|
FtAnalyticsSearchFacetType["DATE"] = "DATE";
|
|
117
150
|
FtAnalyticsSearchFacetType["RANGE"] = "RANGE";
|
|
118
151
|
})(FtAnalyticsSearchFacetType || (FtAnalyticsSearchFacetType = {}));
|
|
119
|
-
export const isFtAnalyticsSearchFacetType = (o) =>
|
|
152
|
+
export const isFtAnalyticsSearchFacetType = (o) => {
|
|
153
|
+
return ["VALUE", "DATE", "RANGE"].includes(o);
|
|
154
|
+
};
|
|
120
155
|
export const isFtAnalyticsEvent = (o) => {
|
|
121
156
|
return isObject(o)
|
|
122
157
|
&& (isBoolean(o.offline))
|
|
@@ -171,7 +206,9 @@ export var FtAnalyticsEventName;
|
|
|
171
206
|
FtAnalyticsEventName["USER__LOGOUT"] = "USER__LOGOUT";
|
|
172
207
|
FtAnalyticsEventName["HEARTBEAT"] = "HEARTBEAT";
|
|
173
208
|
})(FtAnalyticsEventName || (FtAnalyticsEventName = {}));
|
|
174
|
-
export const isFtAnalyticsEventName = (o) =>
|
|
209
|
+
export const isFtAnalyticsEventName = (o) => {
|
|
210
|
+
return ["BOOKMARK__CREATE", "BOOKMARK__DELETE", "CASE_DEFLECTION__START", "CASE_DEFLECTION__OPEN_TICKET", "CASE_DEFLECTION__RATE", "COLLECTION__CREATE", "COLLECTION__UPDATE", "COLLECTION__DELETE", "DOCUMENT__DISPLAY", "DOCUMENT__DOWNLOAD", "DOCUMENT__PRINT", "DOCUMENT__PROCESS", "DOCUMENT__RATE", "DOCUMENT__SEARCH", "DOCUMENT__START_DISPLAY", "DOCUMENT__UNRATE", "FEEDBACK__SEND", "GEN_AI__COMPLETED_QUERY", "GEN_AI__RATE", "GENAI_CASE_DEFLECTION__START", "GENAI_CASE_DEFLECTION__OPEN_TICKET", "KHUB__PROCESS", "KHUB__SEARCH", "LABELS__DOWNLOAD", "LINK__SHARE", "PAGE__DISPLAY", "PERSONAL_BOOK__CREATE", "PERSONAL_BOOK__DELETE", "PERSONAL_BOOK__UPDATE", "PERSONAL_TOPIC__CREATE", "PERSONAL_TOPIC__UPDATE", "PERSONAL_TOPIC__DELETE", "SAVED_SEARCH__CREATE", "SAVED_SEARCH__DELETE", "SAVED_SEARCH__UPDATE", "SEARCH_PAGE__SELECT", "TOPIC__DISPLAY", "TOPIC__RATE", "TOPIC__START_DISPLAY", "TOPIC__UNRATE", "USER__LOGIN", "USER__LOGOUT", "HEARTBEAT"].includes(o);
|
|
211
|
+
};
|
|
175
212
|
export const isFtCaseDeflectionEvent = (o) => {
|
|
176
213
|
return isObject(o)
|
|
177
214
|
&& (o.searchQuery == null || isFtAnalyticsEventSearchQuery(o.searchQuery))
|
|
@@ -179,28 +216,103 @@ export const isFtCaseDeflectionEvent = (o) => {
|
|
|
179
216
|
&& (o.rating == null || isFtAnalyticsEventRating(o.rating))
|
|
180
217
|
&& (o.topic == null || isFtAnalyticsEventTopic(o.topic));
|
|
181
218
|
};
|
|
219
|
+
export const isFtDocumentDisplayEvent = (o) => {
|
|
220
|
+
return isObject(o)
|
|
221
|
+
&& (isFtAnalyticsEventPublication(o.publication))
|
|
222
|
+
&& (isNumber(o.viewDurationMs))
|
|
223
|
+
&& (isFtAnalyticsEventLocation(o.location));
|
|
224
|
+
};
|
|
182
225
|
export const isFtDocumentDownloadEvent = (o) => {
|
|
183
226
|
return isObject(o)
|
|
184
227
|
&& (isFtAnalyticsEventPublication(o.document))
|
|
185
228
|
&& (isFtAnalyticsEventLocation(o.location));
|
|
186
229
|
};
|
|
230
|
+
export const isFtDocumentPrintEvent = (o) => {
|
|
231
|
+
return isObject(o)
|
|
232
|
+
&& (isFtAnalyticsEventPublication(o.publication));
|
|
233
|
+
};
|
|
234
|
+
export const isFtDocumentSearchEvent = (o) => {
|
|
235
|
+
return isObject(o)
|
|
236
|
+
&& (isFtAnalyticsEventSearchResponse(o.searchResponse))
|
|
237
|
+
&& (isFtAnalyticsEventPublication(o.publication))
|
|
238
|
+
&& (isFtAnalyticsEventSearchQuery(o.searchQuery));
|
|
239
|
+
};
|
|
240
|
+
export const isFtDocumentStartDisplayEvent = (o) => {
|
|
241
|
+
return isObject(o)
|
|
242
|
+
&& (isFtAnalyticsEventPublication(o.publication))
|
|
243
|
+
&& (isFtAnalyticsEventLocation(o.location));
|
|
244
|
+
};
|
|
245
|
+
export const isFtFeedbackSendEvent = (o) => {
|
|
246
|
+
return isObject(o)
|
|
247
|
+
&& ((Array.isArray(o.breadcrumb)
|
|
248
|
+
&& o.breadcrumb.every((v) => isFtAnalyticsEventTopic(v))))
|
|
249
|
+
&& (isFtAnalyticsEventPublication(o.publication))
|
|
250
|
+
&& (isBoolean(o.loggedIn));
|
|
251
|
+
};
|
|
187
252
|
export const isFtGenAiCaseDeflectionEvent = (o) => {
|
|
188
253
|
return isObject(o)
|
|
189
254
|
&& (o.generationId == null || isString(o.generationId))
|
|
190
255
|
&& (o.searchQuery == null || isFtAnalyticsEventSearchQuery(o.searchQuery))
|
|
191
256
|
&& (isString(o.context));
|
|
192
257
|
};
|
|
258
|
+
export const isFtGenAiCompletedQueryEvent = (o) => {
|
|
259
|
+
return isObject(o)
|
|
260
|
+
&& (isString(o.result))
|
|
261
|
+
&& (isFtAnalyticsEventGenAIProfile(o.profile))
|
|
262
|
+
&& (isNumber(o.durationMs))
|
|
263
|
+
&& (o.parameters == null || (isObject(o.parameters)
|
|
264
|
+
&& Object.keys(o.parameters).every((k) => isString(k))
|
|
265
|
+
&& Object.values(o.parameters).every((v) => isString(v))))
|
|
266
|
+
&& (isString(o.queryId));
|
|
267
|
+
};
|
|
268
|
+
export const isFtGenAiRateEvent = (o) => {
|
|
269
|
+
return isObject(o)
|
|
270
|
+
&& (isFtAnalyticsEventRating(o.rating))
|
|
271
|
+
&& (isString(o.comment))
|
|
272
|
+
&& (isString(o.queryId));
|
|
273
|
+
};
|
|
193
274
|
export const isFtKhubSearchEvent = (o) => {
|
|
194
275
|
return isObject(o)
|
|
195
276
|
&& (isFtAnalyticsEventSearchResponse(o.searchResponse))
|
|
196
277
|
&& (isFtAnalyticsEventSearchQuery(o.searchQuery));
|
|
197
278
|
};
|
|
279
|
+
export const isFtLabelsDownloadEvent = (o) => {
|
|
280
|
+
return isObject(o)
|
|
281
|
+
&& (isString(o.locale));
|
|
282
|
+
};
|
|
283
|
+
export const isFtLinkShareEvent = (o) => {
|
|
284
|
+
return isObject(o)
|
|
285
|
+
&& ((Array.isArray(o.breadcrumb)
|
|
286
|
+
&& o.breadcrumb.every((v) => isFtAnalyticsEventTopic(v))))
|
|
287
|
+
&& (isFtAnalyticsEventPublication(o.publication));
|
|
288
|
+
};
|
|
289
|
+
export const isFtPageDisplayEvent = (o) => {
|
|
290
|
+
return isObject(o)
|
|
291
|
+
&& (isFtAnalyticsEventOrigin(o.origin))
|
|
292
|
+
&& (isFtAnalyticsEventDisplay(o.display))
|
|
293
|
+
&& (isFtAnalyticsEventPage(o.page));
|
|
294
|
+
};
|
|
198
295
|
export const isFtSearchPageSelectEvent = (o) => {
|
|
199
296
|
return isObject(o)
|
|
200
297
|
&& (isFtAnalyticsEventSearchResult(o.searchResult))
|
|
201
298
|
&& (o.externalLink == null || isString(o.externalLink))
|
|
202
299
|
&& (isFtAnalyticsEventSearchQuery(o.searchQuery));
|
|
203
300
|
};
|
|
301
|
+
export const isFtTopicDisplayEvent = (o) => {
|
|
302
|
+
return isObject(o)
|
|
303
|
+
&& ((Array.isArray(o.breadcrumb)
|
|
304
|
+
&& o.breadcrumb.every((v) => isFtAnalyticsEventTopic(v))))
|
|
305
|
+
&& (isFtAnalyticsEventPublication(o.publication))
|
|
306
|
+
&& (isNumber(o.viewDurationMs))
|
|
307
|
+
&& (isFtAnalyticsEventLocation(o.location));
|
|
308
|
+
};
|
|
309
|
+
export const isFtTopicStartDisplayEvent = (o) => {
|
|
310
|
+
return isObject(o)
|
|
311
|
+
&& ((Array.isArray(o.breadcrumb)
|
|
312
|
+
&& o.breadcrumb.every((v) => isFtAnalyticsEventTopic(v))))
|
|
313
|
+
&& (isFtAnalyticsEventPublication(o.publication))
|
|
314
|
+
&& (isFtAnalyticsEventLocation(o.location));
|
|
315
|
+
};
|
|
204
316
|
export const isFtCredentials = (o) => {
|
|
205
317
|
return isObject(o)
|
|
206
318
|
&& (isString(o.password))
|
|
@@ -357,7 +469,9 @@ export var FtTopicContentTarget;
|
|
|
357
469
|
FtTopicContentTarget["PAGES"] = "PAGES";
|
|
358
470
|
FtTopicContentTarget["DESIGNED_READER"] = "DESIGNED_READER";
|
|
359
471
|
})(FtTopicContentTarget || (FtTopicContentTarget = {}));
|
|
360
|
-
export const isFtTopicContentTarget = (o) =>
|
|
472
|
+
export const isFtTopicContentTarget = (o) => {
|
|
473
|
+
return ["THIRD_PARTY", "OFF_THE_GRID", "CONTENT_PACKAGER", "PAGES", "DESIGNED_READER"].includes(o);
|
|
474
|
+
};
|
|
361
475
|
// From: ExternalWebComponentContext
|
|
362
476
|
export var FtExternalWebComponentContext;
|
|
363
477
|
(function (FtExternalWebComponentContext) {
|
|
@@ -369,7 +483,9 @@ export var FtExternalWebComponentContext;
|
|
|
369
483
|
FtExternalWebComponentContext["SEARCH"] = "SEARCH";
|
|
370
484
|
FtExternalWebComponentContext["SEARCH_RESULT"] = "SEARCH_RESULT";
|
|
371
485
|
})(FtExternalWebComponentContext || (FtExternalWebComponentContext = {}));
|
|
372
|
-
export const isFtExternalWebComponentContext = (o) =>
|
|
486
|
+
export const isFtExternalWebComponentContext = (o) => {
|
|
487
|
+
return ["HOMEPAGE", "CUSTOM", "HEADER", "READER", "TOPIC_TEMPLATE", "SEARCH", "SEARCH_RESULT"].includes(o);
|
|
488
|
+
};
|
|
373
489
|
export const isFtFeedbackCreation = (o) => {
|
|
374
490
|
return isObject(o)
|
|
375
491
|
&& (o.from == null || isString(o.from))
|
|
@@ -382,7 +498,9 @@ export var FtMetadataHomeLayout;
|
|
|
382
498
|
FtMetadataHomeLayout["CUSTOM"] = "CUSTOM";
|
|
383
499
|
FtMetadataHomeLayout["DESIGNER"] = "DESIGNER";
|
|
384
500
|
})(FtMetadataHomeLayout || (FtMetadataHomeLayout = {}));
|
|
385
|
-
export const isFtMetadataHomeLayout = (o) =>
|
|
501
|
+
export const isFtMetadataHomeLayout = (o) => {
|
|
502
|
+
return ["CLASSIC", "CUSTOM", "DESIGNER"].includes(o);
|
|
503
|
+
};
|
|
386
504
|
export const isFtDefaultLocale = (o) => {
|
|
387
505
|
return isObject(o)
|
|
388
506
|
&& (isString(o.lang))
|
|
@@ -434,7 +552,9 @@ export var FtFacetType;
|
|
|
434
552
|
FtFacetType["OR"] = "OR";
|
|
435
553
|
FtFacetType["MONOVALUED"] = "MONOVALUED";
|
|
436
554
|
})(FtFacetType || (FtFacetType = {}));
|
|
437
|
-
export const isFtFacetType = (o) =>
|
|
555
|
+
export const isFtFacetType = (o) => {
|
|
556
|
+
return ["AND", "OR", "MONOVALUED"].includes(o);
|
|
557
|
+
};
|
|
438
558
|
export const isFtMetadata = (o) => {
|
|
439
559
|
return isObject(o)
|
|
440
560
|
&& ((Array.isArray(o.values)
|
|
@@ -452,7 +572,9 @@ export var FtMetadataSortRule;
|
|
|
452
572
|
FtMetadataSortRule["ALPHABET"] = "ALPHABET";
|
|
453
573
|
FtMetadataSortRule["VERSION"] = "VERSION";
|
|
454
574
|
})(FtMetadataSortRule || (FtMetadataSortRule = {}));
|
|
455
|
-
export const isFtMetadataSortRule = (o) =>
|
|
575
|
+
export const isFtMetadataSortRule = (o) => {
|
|
576
|
+
return ["NONE", "ALPHABET", "VERSION"].includes(o);
|
|
577
|
+
};
|
|
456
578
|
export const isFtMetadataConfiguration = (o) => {
|
|
457
579
|
return isObject(o)
|
|
458
580
|
&& ((Array.isArray(o.descriptors)
|
|
@@ -491,12 +613,6 @@ export const isFtMySearchRequest = (o) => {
|
|
|
491
613
|
&& o.metadataFilters.every((v) => isFtLabeledMetadataFilter(v))))
|
|
492
614
|
&& (o.contentLocale == null || isString(o.contentLocale));
|
|
493
615
|
};
|
|
494
|
-
export const isFtPrivacyPolicyConfiguration = (o) => {
|
|
495
|
-
return isObject(o)
|
|
496
|
-
&& (isString(o.policyDescription))
|
|
497
|
-
&& (isBoolean(o.agreementRequired))
|
|
498
|
-
&& (isString(o.userAgreementMessage));
|
|
499
|
-
};
|
|
500
616
|
// From: RatingType
|
|
501
617
|
export var FtRatingType;
|
|
502
618
|
(function (FtRatingType) {
|
|
@@ -505,7 +621,9 @@ export var FtRatingType;
|
|
|
505
621
|
FtRatingType["DICHOTOMOUS"] = "DICHOTOMOUS";
|
|
506
622
|
FtRatingType["NO_RATING"] = "NO_RATING";
|
|
507
623
|
})(FtRatingType || (FtRatingType = {}));
|
|
508
|
-
export const isFtRatingType = (o) =>
|
|
624
|
+
export const isFtRatingType = (o) => {
|
|
625
|
+
return ["STARS", "LIKE", "DICHOTOMOUS", "NO_RATING"].includes(o);
|
|
626
|
+
};
|
|
509
627
|
export const isFtPublicationRating = (o) => {
|
|
510
628
|
return isObject(o)
|
|
511
629
|
&& (isString(o.date))
|
|
@@ -569,7 +687,9 @@ export var FtPeriodFilterType;
|
|
|
569
687
|
FtPeriodFilterType["LAST_YEAR"] = "LAST_YEAR";
|
|
570
688
|
FtPeriodFilterType["CUSTOM"] = "CUSTOM";
|
|
571
689
|
})(FtPeriodFilterType || (FtPeriodFilterType = {}));
|
|
572
|
-
export const isFtPeriodFilterType = (o) =>
|
|
690
|
+
export const isFtPeriodFilterType = (o) => {
|
|
691
|
+
return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR", "CUSTOM"].includes(o);
|
|
692
|
+
};
|
|
573
693
|
export const isFtSearchPreset = (o) => {
|
|
574
694
|
return isObject(o)
|
|
575
695
|
&& (isString(o.name))
|
|
@@ -584,14 +704,18 @@ export var FtSearchSortCriterionOrder;
|
|
|
584
704
|
FtSearchSortCriterionOrder["ASC"] = "ASC";
|
|
585
705
|
FtSearchSortCriterionOrder["DESC"] = "DESC";
|
|
586
706
|
})(FtSearchSortCriterionOrder || (FtSearchSortCriterionOrder = {}));
|
|
587
|
-
export const isFtSearchSortCriterionOrder = (o) =>
|
|
707
|
+
export const isFtSearchSortCriterionOrder = (o) => {
|
|
708
|
+
return ["ASC", "DESC"].includes(o);
|
|
709
|
+
};
|
|
588
710
|
// From: SearchSortCriterionType
|
|
589
711
|
export var FtSearchSortCriterionType;
|
|
590
712
|
(function (FtSearchSortCriterionType) {
|
|
591
713
|
FtSearchSortCriterionType["ALPHA"] = "ALPHA";
|
|
592
714
|
FtSearchSortCriterionType["NATURAL"] = "NATURAL";
|
|
593
715
|
})(FtSearchSortCriterionType || (FtSearchSortCriterionType = {}));
|
|
594
|
-
export const isFtSearchSortCriterionType = (o) =>
|
|
716
|
+
export const isFtSearchSortCriterionType = (o) => {
|
|
717
|
+
return ["ALPHA", "NATURAL"].includes(o);
|
|
718
|
+
};
|
|
595
719
|
// From: VirtualField
|
|
596
720
|
export var FtVirtualField;
|
|
597
721
|
(function (FtVirtualField) {
|
|
@@ -599,7 +723,9 @@ export var FtVirtualField;
|
|
|
599
723
|
FtVirtualField["TITLE_ONLY"] = "TITLE_ONLY";
|
|
600
724
|
FtVirtualField["NONE"] = "NONE";
|
|
601
725
|
})(FtVirtualField || (FtVirtualField = {}));
|
|
602
|
-
export const isFtVirtualField = (o) =>
|
|
726
|
+
export const isFtVirtualField = (o) => {
|
|
727
|
+
return ["EVERYWHERE", "TITLE_ONLY", "NONE"].includes(o);
|
|
728
|
+
};
|
|
603
729
|
export const isFtSearchResultsPageInfo = (o) => {
|
|
604
730
|
return isObject(o)
|
|
605
731
|
&& (isNumber(o.totalResultsCount))
|
|
@@ -614,14 +740,18 @@ export var FtEditorialType;
|
|
|
614
740
|
FtEditorialType["BOOK"] = "BOOK";
|
|
615
741
|
FtEditorialType["SHARED_BOOK"] = "SHARED_BOOK";
|
|
616
742
|
})(FtEditorialType || (FtEditorialType = {}));
|
|
617
|
-
export const isFtEditorialType = (o) =>
|
|
743
|
+
export const isFtEditorialType = (o) => {
|
|
744
|
+
return ["ARTICLE", "BOOK", "SHARED_BOOK"].includes(o);
|
|
745
|
+
};
|
|
618
746
|
// From: WsOpenMode
|
|
619
747
|
export var FtOpenMode;
|
|
620
748
|
(function (FtOpenMode) {
|
|
621
749
|
FtOpenMode["FLUIDTOPICS"] = "FLUIDTOPICS";
|
|
622
750
|
FtOpenMode["EXTERNAL"] = "EXTERNAL";
|
|
623
751
|
})(FtOpenMode || (FtOpenMode = {}));
|
|
624
|
-
export const isFtOpenMode = (o) =>
|
|
752
|
+
export const isFtOpenMode = (o) => {
|
|
753
|
+
return ["FLUIDTOPICS", "EXTERNAL"].includes(o);
|
|
754
|
+
};
|
|
625
755
|
export const isFtPageRequest = (o) => {
|
|
626
756
|
return isObject(o)
|
|
627
757
|
&& (o.perPage == null || isNumber(o.perPage))
|
|
@@ -640,7 +770,9 @@ export var FtCollectionDocumentType;
|
|
|
640
770
|
FtCollectionDocumentType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
|
|
641
771
|
FtCollectionDocumentType["SHARED_BOOK"] = "SHARED_BOOK";
|
|
642
772
|
})(FtCollectionDocumentType || (FtCollectionDocumentType = {}));
|
|
643
|
-
export const isFtCollectionDocumentType = (o) =>
|
|
773
|
+
export const isFtCollectionDocumentType = (o) => {
|
|
774
|
+
return ["MAP", "DOCUMENT", "TOPIC", "PERSONAL_BOOK", "SHARED_BOOK"].includes(o);
|
|
775
|
+
};
|
|
644
776
|
export const isFtDateFilter = (o) => {
|
|
645
777
|
return isObject(o)
|
|
646
778
|
&& (isFtDateFilterType(o.type));
|
|
@@ -653,7 +785,9 @@ export var FtDateFilterType;
|
|
|
653
785
|
FtDateFilterType["LAST_QUARTER"] = "LAST_QUARTER";
|
|
654
786
|
FtDateFilterType["LAST_YEAR"] = "LAST_YEAR";
|
|
655
787
|
})(FtDateFilterType || (FtDateFilterType = {}));
|
|
656
|
-
export const isFtDateFilterType = (o) =>
|
|
788
|
+
export const isFtDateFilterType = (o) => {
|
|
789
|
+
return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR"].includes(o);
|
|
790
|
+
};
|
|
657
791
|
export const isFtSearchResults = (o) => {
|
|
658
792
|
return isObject(o)
|
|
659
793
|
&& (o.spellcheck == null || isFtSpellcheck(o.spellcheck))
|
|
@@ -815,7 +949,9 @@ export var FtSearchResultType;
|
|
|
815
949
|
FtSearchResultType["DOCUMENT"] = "DOCUMENT";
|
|
816
950
|
FtSearchResultType["TOPIC"] = "TOPIC";
|
|
817
951
|
})(FtSearchResultType || (FtSearchResultType = {}));
|
|
818
|
-
export const isFtSearchResultType = (o) =>
|
|
952
|
+
export const isFtSearchResultType = (o) => {
|
|
953
|
+
return ["MAP", "DOCUMENT", "TOPIC"].includes(o);
|
|
954
|
+
};
|
|
819
955
|
// From: WsPublicSearchScope
|
|
820
956
|
export var FtSearchScope;
|
|
821
957
|
(function (FtSearchScope) {
|
|
@@ -824,7 +960,9 @@ export var FtSearchScope;
|
|
|
824
960
|
FtSearchScope["ALL_TOPICS"] = "ALL_TOPICS";
|
|
825
961
|
FtSearchScope["TOPICS_AND_UNSTRUCTURED_DOCUMENTS"] = "TOPICS_AND_UNSTRUCTURED_DOCUMENTS";
|
|
826
962
|
})(FtSearchScope || (FtSearchScope = {}));
|
|
827
|
-
export const isFtSearchScope = (o) =>
|
|
963
|
+
export const isFtSearchScope = (o) => {
|
|
964
|
+
return ["DEFAULT", "DOCUMENTS", "ALL_TOPICS", "TOPICS_AND_UNSTRUCTURED_DOCUMENTS"].includes(o);
|
|
965
|
+
};
|
|
828
966
|
export const isFtValueFilter = (o) => {
|
|
829
967
|
return isObject(o)
|
|
830
968
|
&& (isBoolean(o.negative))
|
|
@@ -924,7 +1062,9 @@ export var FtUserRole;
|
|
|
924
1062
|
FtUserRole["ADMIN"] = "ADMIN";
|
|
925
1063
|
FtUserRole["DEVELOPER"] = "DEVELOPER";
|
|
926
1064
|
})(FtUserRole || (FtUserRole = {}));
|
|
927
|
-
export const isFtUserRole = (o) =>
|
|
1065
|
+
export const isFtUserRole = (o) => {
|
|
1066
|
+
return ["PERSONAL_BOOK_USER", "PERSONAL_BOOK_SHARE_USER", "HTML_EXPORT_USER", "PDF_EXPORT_USER", "SAVED_SEARCH_USER", "COLLECTION_USER", "OFFLINE_USER", "ANALYTICS_USER", "BETA_USER", "DEBUG_USER", "PRINT_USER", "RATING_USER", "FEEDBACK_USER", "GENERATIVE_AI_USER", "GENERATIVE_AI_EXPORT_USER", "CONTENT_PUBLISHER", "KHUB_ADMIN", "USERS_ADMIN", "PORTAL_ADMIN", "ADMIN", "DEVELOPER"].includes(o);
|
|
1067
|
+
};
|
|
928
1068
|
export const isFtAuthenticationIdentifier = (o) => {
|
|
929
1069
|
return isObject(o)
|
|
930
1070
|
&& (isString(o.identifier))
|
|
@@ -954,11 +1094,9 @@ export const isFtUserProfile = (o) => {
|
|
|
954
1094
|
return isObject(o)
|
|
955
1095
|
&& (o.emailAddress == null || isString(o.emailAddress))
|
|
956
1096
|
&& (o.displayName == null || isString(o.displayName))
|
|
957
|
-
&& (o.otpValidated == null || isBoolean(o.otpValidated))
|
|
958
1097
|
&& ((Array.isArray(o.roles)
|
|
959
1098
|
&& o.roles.every((v) => isFtUserRole(v))))
|
|
960
1099
|
&& (o.userId == null || isString(o.userId))
|
|
961
|
-
&& (o.privacyPolicyAgreementDate == null || isString(o.privacyPolicyAgreementDate))
|
|
962
1100
|
&& ((Array.isArray(o.tags)
|
|
963
1101
|
&& o.tags.every((v) => isString(v))));
|
|
964
1102
|
};
|
|
@@ -106,7 +106,7 @@ export interface FtSemanticSearchResponseItem {
|
|
|
106
106
|
}
|
|
107
107
|
export declare const isFtSemanticSearchResponseItem: (o: any) => o is FtSemanticSearchResponseItem;
|
|
108
108
|
export interface FtSemanticSearchFilter {
|
|
109
|
-
values
|
|
109
|
+
values?: Array<string>;
|
|
110
110
|
hierarchicalValues?: Array<Array<string>>;
|
|
111
111
|
key: string;
|
|
112
112
|
}
|
|
@@ -8,7 +8,9 @@ export var FtConfigurationHistoryEntryStatus;
|
|
|
8
8
|
FtConfigurationHistoryEntryStatus["VALID"] = "VALID";
|
|
9
9
|
FtConfigurationHistoryEntryStatus["INVALID"] = "INVALID";
|
|
10
10
|
})(FtConfigurationHistoryEntryStatus || (FtConfigurationHistoryEntryStatus = {}));
|
|
11
|
-
export const isFtConfigurationHistoryEntryStatus = (o) =>
|
|
11
|
+
export const isFtConfigurationHistoryEntryStatus = (o) => {
|
|
12
|
+
return ["VALID", "INVALID"].includes(o);
|
|
13
|
+
};
|
|
12
14
|
export const isFtReaderConfiguration = (o) => {
|
|
13
15
|
return isObject(o)
|
|
14
16
|
&& (isFtReaderFeedbackConfiguration(o.feedback))
|
|
@@ -61,7 +63,9 @@ export var TranslationFormat;
|
|
|
61
63
|
TranslationFormat["TEXT"] = "TEXT";
|
|
62
64
|
TranslationFormat["HTML"] = "HTML";
|
|
63
65
|
})(TranslationFormat || (TranslationFormat = {}));
|
|
64
|
-
export const isTranslationFormat = (o) =>
|
|
66
|
+
export const isTranslationFormat = (o) => {
|
|
67
|
+
return ["TEXT", "HTML"].includes(o);
|
|
68
|
+
};
|
|
65
69
|
export const isFtTranslationInput = (o) => {
|
|
66
70
|
return isObject(o)
|
|
67
71
|
&& (isString(o.profileId))
|
|
@@ -126,7 +130,7 @@ export const isFtSemanticSearchResponseItem = (o) => {
|
|
|
126
130
|
};
|
|
127
131
|
export const isFtSemanticSearchFilter = (o) => {
|
|
128
132
|
return isObject(o)
|
|
129
|
-
&& ((Array.isArray(o.values)
|
|
133
|
+
&& (o.values == null || (Array.isArray(o.values)
|
|
130
134
|
&& o.values.every((v) => isString(v))))
|
|
131
135
|
&& (o.hierarchicalValues == null || (Array.isArray(o.hierarchicalValues)
|
|
132
136
|
&& o.hierarchicalValues.every((v) => (Array.isArray(v)
|