@fluid-topics/public-api 1.0.75 → 1.0.76
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 +13 -0
- package/dist/cjs/types/ft-common/public.js +83 -29
- package/dist/fluidtopics.min.js +1 -1
- package/dist/mjs/types/ft-common/public.d.ts +57 -17
- package/dist/mjs/types/ft-common/public.js +72 -25
- package/package.json +1 -1
- package/yarn.lock +4146 -0
- package/.yarnrc +0 -1
- package/build/cjs/helpers/GenAIChunkReader.js +0 -66
- package/build/cjs/index.js +0 -476
- package/build/cjs/preferences/unauthenticated-preferences.js +0 -67
- package/build/cjs/roles/roles.js +0 -31
- package/build/cjs/types/ft-common/public.js +0 -848
- package/build/cjs/types/ft-server/public.js +0 -146
- package/build/mjs/helpers/GenAIChunkReader.d.ts +0 -19
- package/build/mjs/helpers/GenAIChunkReader.js +0 -37
- package/build/mjs/index.d.ts +0 -190
- package/build/mjs/index.js +0 -432
- package/build/mjs/preferences/unauthenticated-preferences.d.ts +0 -9
- package/build/mjs/preferences/unauthenticated-preferences.js +0 -61
- package/build/mjs/roles/roles.d.ts +0 -2
- package/build/mjs/roles/roles.js +0 -25
- package/build/mjs/types/ft-common/public.d.ts +0 -657
- package/build/mjs/types/ft-common/public.js +0 -762
- package/build/mjs/types/ft-server/public.d.ts +0 -104
- package/build/mjs/types/ft-server/public.js +0 -127
- package/build/rollup/fluidtopics.min.js +0 -1
- package/build/test-results/public-api.xml +0 -18
- package/build/test-results/web-components.xml +0 -12
- package/packages/cjs/package.json +0 -3
- package/packages/mjs/package.json +0 -3
- package/test-browser/helpers/GenAIChunkReader.test.ts +0 -54
- package/vite-plugin.mjs +0 -95
- package/web-test-runner.config.mjs +0 -58
|
@@ -1,657 +0,0 @@
|
|
|
1
|
-
export interface FtHttpErrorDetails {
|
|
2
|
-
endpoint: string;
|
|
3
|
-
method: string;
|
|
4
|
-
statusText: string;
|
|
5
|
-
body: string;
|
|
6
|
-
status: number;
|
|
7
|
-
}
|
|
8
|
-
export declare const isFtHttpErrorDetails: (o: any) => o is FtHttpErrorDetails;
|
|
9
|
-
export declare enum FtMyLibraryColors {
|
|
10
|
-
black = "black",
|
|
11
|
-
green = "green",
|
|
12
|
-
blue = "blue",
|
|
13
|
-
purple = "purple",
|
|
14
|
-
red = "red",
|
|
15
|
-
orange = "orange",
|
|
16
|
-
yellow = "yellow"
|
|
17
|
-
}
|
|
18
|
-
export type FtMyLibraryColorsKeys = keyof typeof FtMyLibraryColors;
|
|
19
|
-
export declare const isFtMyLibraryColors: (o: any) => o is FtMyLibraryColors;
|
|
20
|
-
export declare enum FtTopicOriginType {
|
|
21
|
-
OFFICIAL = "OFFICIAL",
|
|
22
|
-
PERSONAL = "PERSONAL",
|
|
23
|
-
SHARED = "SHARED"
|
|
24
|
-
}
|
|
25
|
-
export type FtTopicOriginTypeKeys = keyof typeof FtTopicOriginType;
|
|
26
|
-
export declare const isFtTopicOriginType: (o: any) => o is FtTopicOriginType;
|
|
27
|
-
export interface FtCredentials {
|
|
28
|
-
password: string;
|
|
29
|
-
newPassword?: string;
|
|
30
|
-
rememberMe: boolean;
|
|
31
|
-
login: string;
|
|
32
|
-
}
|
|
33
|
-
export declare const isFtCredentials: (o: any) => o is FtCredentials;
|
|
34
|
-
export interface FtPersonalBookCreation {
|
|
35
|
-
metadata: Array<FtPersonalBookMetadataUpdate>;
|
|
36
|
-
nodes: Array<FtPersonalBookNodeCreation>;
|
|
37
|
-
description: string;
|
|
38
|
-
title: string;
|
|
39
|
-
}
|
|
40
|
-
export declare const isFtPersonalBookCreation: (o: any) => o is FtPersonalBookCreation;
|
|
41
|
-
export interface FtPersonalBookMetadataUpdate {
|
|
42
|
-
values: Array<Array<string>>;
|
|
43
|
-
key: string;
|
|
44
|
-
}
|
|
45
|
-
export declare const isFtPersonalBookMetadataUpdate: (o: any) => o is FtPersonalBookMetadataUpdate;
|
|
46
|
-
export interface FtPersonalBookNodeCreation {
|
|
47
|
-
notes: string;
|
|
48
|
-
children: Array<FtPersonalBookNodeCreation>;
|
|
49
|
-
topicLink?: FtPersonalBookTopicLinkCreation;
|
|
50
|
-
title: string;
|
|
51
|
-
htmlContent?: string;
|
|
52
|
-
}
|
|
53
|
-
export declare const isFtPersonalBookNodeCreation: (o: any) => o is FtPersonalBookNodeCreation;
|
|
54
|
-
export interface FtPersonalBookTopicLinkCreation {
|
|
55
|
-
tocId: string;
|
|
56
|
-
contentId: string;
|
|
57
|
-
mapId: string;
|
|
58
|
-
type: any;
|
|
59
|
-
}
|
|
60
|
-
export declare const isFtPersonalBookTopicLinkCreation: (o: any) => o is FtPersonalBookTopicLinkCreation;
|
|
61
|
-
export interface FtBookmark {
|
|
62
|
-
mapTitle: string;
|
|
63
|
-
color: FtMyLibraryColorsKeys;
|
|
64
|
-
breadcrumb: Array<string>;
|
|
65
|
-
tocId: string;
|
|
66
|
-
lastUpdate: Date | string;
|
|
67
|
-
readerUrl: string;
|
|
68
|
-
mapId: string;
|
|
69
|
-
id: string;
|
|
70
|
-
title: string;
|
|
71
|
-
creationDate: Date | string;
|
|
72
|
-
}
|
|
73
|
-
export declare const isFtBookmark: (o: any) => o is FtBookmark;
|
|
74
|
-
export interface FtCollectionDocument {
|
|
75
|
-
deleted: boolean;
|
|
76
|
-
apiUrl?: string;
|
|
77
|
-
portalUrl?: string;
|
|
78
|
-
id: string;
|
|
79
|
-
title: string;
|
|
80
|
-
type: FtCollectionDocumentTypeKeys;
|
|
81
|
-
}
|
|
82
|
-
export declare const isFtCollectionDocument: (o: any) => o is FtCollectionDocument;
|
|
83
|
-
export interface FtMap {
|
|
84
|
-
prettyUrl?: string;
|
|
85
|
-
metadata: Array<FtMetadata>;
|
|
86
|
-
watermark?: FtWatermark;
|
|
87
|
-
openMode: FtOpenModeKeys;
|
|
88
|
-
topicsApiEndpoint?: string;
|
|
89
|
-
description?: string;
|
|
90
|
-
attachmentsApiEndpoint?: string;
|
|
91
|
-
editorialType: FtEditorialTypeKeys;
|
|
92
|
-
baseId: string;
|
|
93
|
-
clusterId: string;
|
|
94
|
-
title: string;
|
|
95
|
-
lastPublication: string;
|
|
96
|
-
pbkConfidential: boolean;
|
|
97
|
-
lastEdition: string;
|
|
98
|
-
originId: string;
|
|
99
|
-
rightsApiEndpoint?: string;
|
|
100
|
-
contentStyles: FtMapStyles;
|
|
101
|
-
originUrl?: string;
|
|
102
|
-
fingerprint: string;
|
|
103
|
-
readerUrl: string;
|
|
104
|
-
khubVersion?: string;
|
|
105
|
-
id: string;
|
|
106
|
-
lang?: string;
|
|
107
|
-
}
|
|
108
|
-
export declare const isFtMap: (o: any) => o is FtMap;
|
|
109
|
-
export interface FtMapStyles {
|
|
110
|
-
topicStylesheetUrl: string;
|
|
111
|
-
titleStylesheetUrl: string;
|
|
112
|
-
customCssClasses: Array<string>;
|
|
113
|
-
}
|
|
114
|
-
export declare const isFtMapStyles: (o: any) => o is FtMapStyles;
|
|
115
|
-
export interface FtTocNode {
|
|
116
|
-
prettyUrl?: string;
|
|
117
|
-
hasRating?: boolean;
|
|
118
|
-
tocId: string;
|
|
119
|
-
children: Array<FtTocNode>;
|
|
120
|
-
origin?: FtTopicOrigin;
|
|
121
|
-
contentId: string;
|
|
122
|
-
title: string;
|
|
123
|
-
}
|
|
124
|
-
export declare const isFtTocNode: (o: any) => o is FtTocNode;
|
|
125
|
-
export interface FtTopic {
|
|
126
|
-
metadata: Array<FtMetadata>;
|
|
127
|
-
id: string;
|
|
128
|
-
contentApiEndpoint: string;
|
|
129
|
-
title: string;
|
|
130
|
-
}
|
|
131
|
-
export declare const isFtTopic: (o: any) => o is FtTopic;
|
|
132
|
-
export interface FtTopicOrigin {
|
|
133
|
-
mapTitle: string;
|
|
134
|
-
breadcrumb: Array<string>;
|
|
135
|
-
tocId: string;
|
|
136
|
-
contentId: string;
|
|
137
|
-
mapId: string;
|
|
138
|
-
type: FtTopicOriginTypeKeys;
|
|
139
|
-
}
|
|
140
|
-
export declare const isFtTopicOrigin: (o: any) => o is FtTopicOrigin;
|
|
141
|
-
export interface FtUnstructuredDocument {
|
|
142
|
-
prettyUrl?: string;
|
|
143
|
-
metadata: Array<FtMetadata>;
|
|
144
|
-
openMode: string;
|
|
145
|
-
description?: string;
|
|
146
|
-
mimeType: string;
|
|
147
|
-
baseId?: string;
|
|
148
|
-
clusterId?: string;
|
|
149
|
-
contentApiEndpoint: string;
|
|
150
|
-
title: string;
|
|
151
|
-
lastPublication?: string;
|
|
152
|
-
viewerUrl: string;
|
|
153
|
-
lastEdition: string;
|
|
154
|
-
filename: string;
|
|
155
|
-
originId?: string;
|
|
156
|
-
rightsApiEndpoint: string;
|
|
157
|
-
originUrl?: string;
|
|
158
|
-
khubVersion?: string;
|
|
159
|
-
id: string;
|
|
160
|
-
lang?: string;
|
|
161
|
-
}
|
|
162
|
-
export declare const isFtUnstructuredDocument: (o: any) => o is FtUnstructuredDocument;
|
|
163
|
-
export declare enum FtTopicContentTarget {
|
|
164
|
-
THIRD_PARTY = "THIRD_PARTY",
|
|
165
|
-
OFF_THE_GRID = "OFF_THE_GRID",
|
|
166
|
-
CONTENT_PACKAGER = "CONTENT_PACKAGER",
|
|
167
|
-
PAGES = "PAGES",
|
|
168
|
-
DESIGNED_READER = "DESIGNED_READER"
|
|
169
|
-
}
|
|
170
|
-
export type FtTopicContentTargetKeys = keyof typeof FtTopicContentTarget;
|
|
171
|
-
export declare const isFtTopicContentTarget: (o: any) => o is FtTopicContentTarget;
|
|
172
|
-
export declare enum FtExternalWebComponentContext {
|
|
173
|
-
HOMEPAGE = "HOMEPAGE",
|
|
174
|
-
CUSTOM = "CUSTOM",
|
|
175
|
-
HEADER = "HEADER",
|
|
176
|
-
READER = "READER",
|
|
177
|
-
TOPIC_TEMPLATE = "TOPIC_TEMPLATE",
|
|
178
|
-
SEARCH = "SEARCH",
|
|
179
|
-
SEARCH_RESULT = "SEARCH_RESULT"
|
|
180
|
-
}
|
|
181
|
-
export type FtExternalWebComponentContextKeys = keyof typeof FtExternalWebComponentContext;
|
|
182
|
-
export declare const isFtExternalWebComponentContext: (o: any) => o is FtExternalWebComponentContext;
|
|
183
|
-
export interface FtFeedbackCreation {
|
|
184
|
-
from?: string;
|
|
185
|
-
message: string;
|
|
186
|
-
}
|
|
187
|
-
export declare const isFtFeedbackCreation: (o: any) => o is FtFeedbackCreation;
|
|
188
|
-
export declare enum FtMetadataHomeLayout {
|
|
189
|
-
CLASSIC = "CLASSIC",
|
|
190
|
-
CUSTOM = "CUSTOM",
|
|
191
|
-
DESIGNER = "DESIGNER"
|
|
192
|
-
}
|
|
193
|
-
export type FtMetadataHomeLayoutKeys = keyof typeof FtMetadataHomeLayout;
|
|
194
|
-
export declare const isFtMetadataHomeLayout: (o: any) => o is FtMetadataHomeLayout;
|
|
195
|
-
export interface FtSearchLocale {
|
|
196
|
-
count: number;
|
|
197
|
-
label: string;
|
|
198
|
-
lang?: string;
|
|
199
|
-
}
|
|
200
|
-
export declare const isFtSearchLocale: (o: any) => o is FtSearchLocale;
|
|
201
|
-
export interface FtSearchLocales {
|
|
202
|
-
contentLocales: Array<FtSearchLocale>;
|
|
203
|
-
}
|
|
204
|
-
export declare const isFtSearchLocales: (o: any) => o is FtSearchLocales;
|
|
205
|
-
export interface FtMessageContext {
|
|
206
|
-
name: string;
|
|
207
|
-
messages: Record<string, string>;
|
|
208
|
-
locale: string;
|
|
209
|
-
}
|
|
210
|
-
export declare const isFtMessageContext: (o: any) => o is FtMessageContext;
|
|
211
|
-
export interface FtUiLocale {
|
|
212
|
-
displayName: string;
|
|
213
|
-
languageTag: string;
|
|
214
|
-
translated: boolean;
|
|
215
|
-
}
|
|
216
|
-
export declare const isFtUiLocale: (o: any) => o is FtUiLocale;
|
|
217
|
-
export declare enum FtFacetType {
|
|
218
|
-
AND = "AND",
|
|
219
|
-
OR = "OR",
|
|
220
|
-
MONOVALUED = "MONOVALUED"
|
|
221
|
-
}
|
|
222
|
-
export type FtFacetTypeKeys = keyof typeof FtFacetType;
|
|
223
|
-
export declare const isFtFacetType: (o: any) => o is FtFacetType;
|
|
224
|
-
export interface FtMetadata {
|
|
225
|
-
values: Array<string>;
|
|
226
|
-
hierarchicalValues?: Array<Array<string>>;
|
|
227
|
-
label: string;
|
|
228
|
-
key: string;
|
|
229
|
-
}
|
|
230
|
-
export declare const isFtMetadata: (o: any) => o is FtMetadata;
|
|
231
|
-
export declare enum FtMetadataSortRule {
|
|
232
|
-
NONE = "NONE",
|
|
233
|
-
ALPHABET = "ALPHABET",
|
|
234
|
-
VERSION = "VERSION"
|
|
235
|
-
}
|
|
236
|
-
export type FtMetadataSortRuleKeys = keyof typeof FtMetadataSortRule;
|
|
237
|
-
export declare const isFtMetadataSortRule: (o: any) => o is FtMetadataSortRule;
|
|
238
|
-
export interface FtMetadataConfiguration {
|
|
239
|
-
descriptors: Array<FtMetadataDescriptor>;
|
|
240
|
-
}
|
|
241
|
-
export declare const isFtMetadataConfiguration: (o: any) => o is FtMetadataConfiguration;
|
|
242
|
-
export interface FtMetadataDescriptor {
|
|
243
|
-
date: boolean;
|
|
244
|
-
sortRule: FtMetadataSortRuleKeys;
|
|
245
|
-
label: string;
|
|
246
|
-
reverseSort: boolean;
|
|
247
|
-
key: string;
|
|
248
|
-
}
|
|
249
|
-
export declare const isFtMetadataDescriptor: (o: any) => o is FtMetadataDescriptor;
|
|
250
|
-
export interface FtMySearch {
|
|
251
|
-
searchRequest: FtMySearchRequest;
|
|
252
|
-
color: FtMyLibraryColorsKeys;
|
|
253
|
-
alert: boolean;
|
|
254
|
-
description: string;
|
|
255
|
-
id: string;
|
|
256
|
-
ownerId: string;
|
|
257
|
-
title: string;
|
|
258
|
-
creationDate: Date | string;
|
|
259
|
-
}
|
|
260
|
-
export declare const isFtMySearch: (o: any) => o is FtMySearch;
|
|
261
|
-
export interface FtMySearchRequest {
|
|
262
|
-
periodFilter?: FtPeriodFilter;
|
|
263
|
-
query: string;
|
|
264
|
-
scope?: FtSearchScopeKeys;
|
|
265
|
-
filters: Array<FtLabeledSearchFilter>;
|
|
266
|
-
sort: Array<FtSearchSortCriterion>;
|
|
267
|
-
virtualField?: FtVirtualFieldKeys;
|
|
268
|
-
contentLocale?: string;
|
|
269
|
-
}
|
|
270
|
-
export declare const isFtMySearchRequest: (o: any) => o is FtMySearchRequest;
|
|
271
|
-
export declare enum FtRatingType {
|
|
272
|
-
STARS = "STARS",
|
|
273
|
-
LIKE = "LIKE",
|
|
274
|
-
DICHOTOMOUS = "DICHOTOMOUS",
|
|
275
|
-
NO_RATING = "NO_RATING"
|
|
276
|
-
}
|
|
277
|
-
export type FtRatingTypeKeys = keyof typeof FtRatingType;
|
|
278
|
-
export declare const isFtRatingType: (o: any) => o is FtRatingType;
|
|
279
|
-
export interface FtPublicationRating {
|
|
280
|
-
date: Date | string;
|
|
281
|
-
type: FtRatingTypeKeys;
|
|
282
|
-
value: number;
|
|
283
|
-
}
|
|
284
|
-
export declare const isFtPublicationRating: (o: any) => o is FtPublicationRating;
|
|
285
|
-
export interface FtPublicationRatingSummary {
|
|
286
|
-
rating?: FtPublicationRating;
|
|
287
|
-
type: FtRatingTypeKeys;
|
|
288
|
-
}
|
|
289
|
-
export declare const isFtPublicationRatingSummary: (o: any) => o is FtPublicationRatingSummary;
|
|
290
|
-
export interface FtRatingCreation {
|
|
291
|
-
type: FtRatingTypeKeys;
|
|
292
|
-
value: number;
|
|
293
|
-
}
|
|
294
|
-
export declare const isFtRatingCreation: (o: any) => o is FtRatingCreation;
|
|
295
|
-
export interface FtRatingSummary {
|
|
296
|
-
topics?: FtTopicsRatingSummary;
|
|
297
|
-
publication: FtPublicationRatingSummary;
|
|
298
|
-
}
|
|
299
|
-
export declare const isFtRatingSummary: (o: any) => o is FtRatingSummary;
|
|
300
|
-
export interface FtTopicRating {
|
|
301
|
-
date: Date | string;
|
|
302
|
-
tocId: string;
|
|
303
|
-
type: FtRatingTypeKeys;
|
|
304
|
-
value: number;
|
|
305
|
-
}
|
|
306
|
-
export declare const isFtTopicRating: (o: any) => o is FtTopicRating;
|
|
307
|
-
export interface FtTopicsRatingSummary {
|
|
308
|
-
ratings: Array<FtTopicRating>;
|
|
309
|
-
type: FtRatingTypeKeys;
|
|
310
|
-
}
|
|
311
|
-
export declare const isFtTopicsRatingSummary: (o: any) => o is FtTopicsRatingSummary;
|
|
312
|
-
export interface FtMapResource {
|
|
313
|
-
contentUrl: string;
|
|
314
|
-
filename: string;
|
|
315
|
-
id: string;
|
|
316
|
-
mimeType: string;
|
|
317
|
-
}
|
|
318
|
-
export declare const isFtMapResource: (o: any) => o is FtMapResource;
|
|
319
|
-
export interface FtMetadataPreferenceConfiguration {
|
|
320
|
-
filter: Array<string>;
|
|
321
|
-
prior: Array<string>;
|
|
322
|
-
}
|
|
323
|
-
export declare const isFtMetadataPreferenceConfiguration: (o: any) => o is FtMetadataPreferenceConfiguration;
|
|
324
|
-
export interface FtSearchPreferencesConfiguration {
|
|
325
|
-
metadata: Record<string, FtMetadataPreferenceConfiguration>;
|
|
326
|
-
}
|
|
327
|
-
export declare const isFtSearchPreferencesConfiguration: (o: any) => o is FtSearchPreferencesConfiguration;
|
|
328
|
-
export declare enum FtPeriodFilterType {
|
|
329
|
-
LAST_WEEK = "LAST_WEEK",
|
|
330
|
-
LAST_MONTH = "LAST_MONTH",
|
|
331
|
-
LAST_QUARTER = "LAST_QUARTER",
|
|
332
|
-
LAST_YEAR = "LAST_YEAR",
|
|
333
|
-
CUSTOM = "CUSTOM"
|
|
334
|
-
}
|
|
335
|
-
export type FtPeriodFilterTypeKeys = keyof typeof FtPeriodFilterType;
|
|
336
|
-
export declare const isFtPeriodFilterType: (o: any) => o is FtPeriodFilterType;
|
|
337
|
-
export interface FtSearchFilter {
|
|
338
|
-
negative: boolean;
|
|
339
|
-
values: Array<string>;
|
|
340
|
-
key: string;
|
|
341
|
-
}
|
|
342
|
-
export declare const isFtSearchFilter: (o: any) => o is FtSearchFilter;
|
|
343
|
-
export interface FtSearchPreset {
|
|
344
|
-
name: string;
|
|
345
|
-
filters: Array<FtSearchFilter>;
|
|
346
|
-
priority: number;
|
|
347
|
-
contentLocale?: string;
|
|
348
|
-
}
|
|
349
|
-
export declare const isFtSearchPreset: (o: any) => o is FtSearchPreset;
|
|
350
|
-
export declare enum FtSearchSortCriterionOrder {
|
|
351
|
-
ASC = "ASC",
|
|
352
|
-
DESC = "DESC"
|
|
353
|
-
}
|
|
354
|
-
export type FtSearchSortCriterionOrderKeys = keyof typeof FtSearchSortCriterionOrder;
|
|
355
|
-
export declare const isFtSearchSortCriterionOrder: (o: any) => o is FtSearchSortCriterionOrder;
|
|
356
|
-
export declare enum FtSearchSortCriterionType {
|
|
357
|
-
ALPHA = "ALPHA",
|
|
358
|
-
NATURAL = "NATURAL"
|
|
359
|
-
}
|
|
360
|
-
export type FtSearchSortCriterionTypeKeys = keyof typeof FtSearchSortCriterionType;
|
|
361
|
-
export declare const isFtSearchSortCriterionType: (o: any) => o is FtSearchSortCriterionType;
|
|
362
|
-
export declare enum FtVirtualField {
|
|
363
|
-
EVERYWHERE = "EVERYWHERE",
|
|
364
|
-
TITLE_ONLY = "TITLE_ONLY",
|
|
365
|
-
NONE = "NONE"
|
|
366
|
-
}
|
|
367
|
-
export type FtVirtualFieldKeys = keyof typeof FtVirtualField;
|
|
368
|
-
export declare const isFtVirtualField: (o: any) => o is FtVirtualField;
|
|
369
|
-
export interface FtSearchResultsPageInfo {
|
|
370
|
-
totalResultsCount: number;
|
|
371
|
-
isLastPage: boolean;
|
|
372
|
-
currentPage: number;
|
|
373
|
-
totalClustersCount: number;
|
|
374
|
-
}
|
|
375
|
-
export declare const isFtSearchResultsPageInfo: (o: any) => o is FtSearchResultsPageInfo;
|
|
376
|
-
export declare enum FtEditorialType {
|
|
377
|
-
ARTICLE = "ARTICLE",
|
|
378
|
-
BOOK = "BOOK",
|
|
379
|
-
SHARED_BOOK = "SHARED_BOOK"
|
|
380
|
-
}
|
|
381
|
-
export type FtEditorialTypeKeys = keyof typeof FtEditorialType;
|
|
382
|
-
export declare const isFtEditorialType: (o: any) => o is FtEditorialType;
|
|
383
|
-
export declare enum FtOpenMode {
|
|
384
|
-
FLUIDTOPICS = "FLUIDTOPICS",
|
|
385
|
-
EXTERNAL = "EXTERNAL"
|
|
386
|
-
}
|
|
387
|
-
export type FtOpenModeKeys = keyof typeof FtOpenMode;
|
|
388
|
-
export declare const isFtOpenMode: (o: any) => o is FtOpenMode;
|
|
389
|
-
export interface FtPageRequest {
|
|
390
|
-
perPage?: number;
|
|
391
|
-
page: number;
|
|
392
|
-
}
|
|
393
|
-
export declare const isFtPageRequest: (o: any) => o is FtPageRequest;
|
|
394
|
-
export interface FtPublicClusterSortCriterion {
|
|
395
|
-
key: string;
|
|
396
|
-
}
|
|
397
|
-
export declare const isFtPublicClusterSortCriterion: (o: any) => o is FtPublicClusterSortCriterion;
|
|
398
|
-
export declare enum FtCollectionDocumentType {
|
|
399
|
-
MAP = "MAP",
|
|
400
|
-
DOCUMENT = "DOCUMENT",
|
|
401
|
-
TOPIC = "TOPIC",
|
|
402
|
-
PERSONAL_BOOK = "PERSONAL_BOOK",
|
|
403
|
-
SHARED_BOOK = "SHARED_BOOK"
|
|
404
|
-
}
|
|
405
|
-
export type FtCollectionDocumentTypeKeys = keyof typeof FtCollectionDocumentType;
|
|
406
|
-
export declare const isFtCollectionDocumentType: (o: any) => o is FtCollectionDocumentType;
|
|
407
|
-
export interface FtSearchResults {
|
|
408
|
-
spellcheck?: FtSpellcheck;
|
|
409
|
-
paging: FtSearchResultsPageInfo;
|
|
410
|
-
results: Array<FtSearchResultCluster>;
|
|
411
|
-
facets: Array<FtSearchFacet>;
|
|
412
|
-
}
|
|
413
|
-
export declare const isFtSearchResults: (o: any) => o is FtSearchResults;
|
|
414
|
-
export interface FtLabeledSearchFilter {
|
|
415
|
-
negative: boolean;
|
|
416
|
-
values: Array<string>;
|
|
417
|
-
label: string;
|
|
418
|
-
key: string;
|
|
419
|
-
}
|
|
420
|
-
export declare const isFtLabeledSearchFilter: (o: any) => o is FtLabeledSearchFilter;
|
|
421
|
-
export interface FtPeriod {
|
|
422
|
-
from: string;
|
|
423
|
-
to: string;
|
|
424
|
-
}
|
|
425
|
-
export declare const isFtPeriod: (o: any) => o is FtPeriod;
|
|
426
|
-
export interface FtPeriodFilter {
|
|
427
|
-
period?: FtPeriod;
|
|
428
|
-
periodType: FtPeriodFilterTypeKeys;
|
|
429
|
-
key?: string;
|
|
430
|
-
}
|
|
431
|
-
export declare const isFtPeriodFilter: (o: any) => o is FtPeriodFilter;
|
|
432
|
-
export interface FtSearchPrior {
|
|
433
|
-
weight: number;
|
|
434
|
-
value: string;
|
|
435
|
-
key: string;
|
|
436
|
-
}
|
|
437
|
-
export declare const isFtSearchPrior: (o: any) => o is FtSearchPrior;
|
|
438
|
-
export interface FtSearchRequest {
|
|
439
|
-
periodFilter?: FtPeriodFilter;
|
|
440
|
-
query: string;
|
|
441
|
-
paging: FtPageRequest;
|
|
442
|
-
filters: Array<FtSearchFilter>;
|
|
443
|
-
sort: Array<FtSearchSortCriterion>;
|
|
444
|
-
virtualField?: FtVirtualFieldKeys;
|
|
445
|
-
facets: Array<FtSearchFacetConf>;
|
|
446
|
-
scope?: FtSearchScopeKeys;
|
|
447
|
-
lastModified?: any;
|
|
448
|
-
uiLocale?: string;
|
|
449
|
-
contentLocale?: string;
|
|
450
|
-
priors?: Array<FtSearchPrior>;
|
|
451
|
-
clusterSortCriterions?: Array<FtPublicClusterSortCriterion>;
|
|
452
|
-
}
|
|
453
|
-
export declare const isFtSearchRequest: (o: any) => o is FtSearchRequest;
|
|
454
|
-
export interface FtSearchResultCluster {
|
|
455
|
-
entries: Array<FtSearchResultClusterEntry>;
|
|
456
|
-
metadataVariableAxis?: string;
|
|
457
|
-
}
|
|
458
|
-
export declare const isFtSearchResultCluster: (o: any) => o is FtSearchResultCluster;
|
|
459
|
-
export interface FtSearchResultClusterEntry {
|
|
460
|
-
missingTerms: Array<string>;
|
|
461
|
-
document?: FtSearchResultUnstructuredDocument;
|
|
462
|
-
topic?: FtSearchResultTopic;
|
|
463
|
-
type: FtSearchResultTypeKeys;
|
|
464
|
-
map?: FtSearchResultMap;
|
|
465
|
-
}
|
|
466
|
-
export declare const isFtSearchResultClusterEntry: (o: any) => o is FtSearchResultClusterEntry;
|
|
467
|
-
export interface FtSearchResultUnstructuredDocument {
|
|
468
|
-
metadata: Array<FtMetadata>;
|
|
469
|
-
openMode: FtOpenModeKeys;
|
|
470
|
-
documentUrl: string;
|
|
471
|
-
mimeType: string;
|
|
472
|
-
source: any;
|
|
473
|
-
title: string;
|
|
474
|
-
lastPublicationDate?: string;
|
|
475
|
-
viewerUrl: string;
|
|
476
|
-
contentUrl: string;
|
|
477
|
-
filename: string;
|
|
478
|
-
htmlTitle: string;
|
|
479
|
-
originUrl?: string;
|
|
480
|
-
documentId: string;
|
|
481
|
-
lastEditionDate: string;
|
|
482
|
-
htmlExcerpt: string;
|
|
483
|
-
}
|
|
484
|
-
export declare const isFtSearchResultUnstructuredDocument: (o: any) => o is FtSearchResultUnstructuredDocument;
|
|
485
|
-
export interface FtSearchResultMap {
|
|
486
|
-
metadata: Array<FtMetadata>;
|
|
487
|
-
openMode?: FtOpenModeKeys;
|
|
488
|
-
editorialType: FtEditorialTypeKeys;
|
|
489
|
-
source?: any;
|
|
490
|
-
title: string;
|
|
491
|
-
lastPublicationDate?: string;
|
|
492
|
-
htmlTitle: string;
|
|
493
|
-
originUrl?: string;
|
|
494
|
-
mapUrl: string;
|
|
495
|
-
readerUrl: string;
|
|
496
|
-
mapId: string;
|
|
497
|
-
lastEditionDate?: string;
|
|
498
|
-
htmlExcerpt: string;
|
|
499
|
-
}
|
|
500
|
-
export declare const isFtSearchResultMap: (o: any) => o is FtSearchResultMap;
|
|
501
|
-
export interface FtSearchResultTopic {
|
|
502
|
-
metadata: Array<FtMetadata>;
|
|
503
|
-
openMode: FtOpenModeKeys;
|
|
504
|
-
contentId: string;
|
|
505
|
-
resources: Array<FtTopicResource>;
|
|
506
|
-
source?: any;
|
|
507
|
-
title: string;
|
|
508
|
-
mapTitle: string;
|
|
509
|
-
topicUrl: string;
|
|
510
|
-
contentUrl: string;
|
|
511
|
-
htmlTitle: string;
|
|
512
|
-
breadcrumb: Array<string>;
|
|
513
|
-
tocId: string;
|
|
514
|
-
originUrl?: string;
|
|
515
|
-
readerUrl: string;
|
|
516
|
-
mapId: string;
|
|
517
|
-
lastEditionDate?: string;
|
|
518
|
-
htmlExcerpt: string;
|
|
519
|
-
}
|
|
520
|
-
export declare const isFtSearchResultTopic: (o: any) => o is FtSearchResultTopic;
|
|
521
|
-
export declare enum FtSearchResultType {
|
|
522
|
-
MAP = "MAP",
|
|
523
|
-
DOCUMENT = "DOCUMENT",
|
|
524
|
-
TOPIC = "TOPIC"
|
|
525
|
-
}
|
|
526
|
-
export type FtSearchResultTypeKeys = keyof typeof FtSearchResultType;
|
|
527
|
-
export declare const isFtSearchResultType: (o: any) => o is FtSearchResultType;
|
|
528
|
-
export declare enum FtSearchScope {
|
|
529
|
-
DEFAULT = "DEFAULT",
|
|
530
|
-
DOCUMENTS = "DOCUMENTS",
|
|
531
|
-
ALL_TOPICS = "ALL_TOPICS"
|
|
532
|
-
}
|
|
533
|
-
export type FtSearchScopeKeys = keyof typeof FtSearchScope;
|
|
534
|
-
export declare const isFtSearchScope: (o: any) => o is FtSearchScope;
|
|
535
|
-
export interface FtSearchFacet {
|
|
536
|
-
hierarchical: boolean;
|
|
537
|
-
label: string;
|
|
538
|
-
multiSelectionable: boolean;
|
|
539
|
-
key: string;
|
|
540
|
-
rootNodes: Array<FtSearchFacetEntry>;
|
|
541
|
-
}
|
|
542
|
-
export declare const isFtSearchFacet: (o: any) => o is FtSearchFacet;
|
|
543
|
-
export interface FtSearchFacetConf {
|
|
544
|
-
maxDepth?: number;
|
|
545
|
-
id: string;
|
|
546
|
-
}
|
|
547
|
-
export declare const isFtSearchFacetConf: (o: any) => o is FtSearchFacetConf;
|
|
548
|
-
export interface FtSearchFacetEntry {
|
|
549
|
-
totalResultsCount: number;
|
|
550
|
-
descendantSelected: boolean;
|
|
551
|
-
childNodes: Array<FtSearchFacetEntry>;
|
|
552
|
-
label: string;
|
|
553
|
-
value: string;
|
|
554
|
-
selected: boolean;
|
|
555
|
-
}
|
|
556
|
-
export declare const isFtSearchFacetEntry: (o: any) => o is FtSearchFacetEntry;
|
|
557
|
-
export interface FtSearchSortCriterion {
|
|
558
|
-
type: FtSearchSortCriterionTypeKeys;
|
|
559
|
-
key: string;
|
|
560
|
-
order: FtSearchSortCriterionOrderKeys;
|
|
561
|
-
}
|
|
562
|
-
export declare const isFtSearchSortCriterion: (o: any) => o is FtSearchSortCriterion;
|
|
563
|
-
export interface FtSpellcheck {
|
|
564
|
-
suggestedQuery: string;
|
|
565
|
-
htmlSuggestedQuery: string;
|
|
566
|
-
}
|
|
567
|
-
export declare const isFtSpellcheck: (o: any) => o is FtSpellcheck;
|
|
568
|
-
export interface FtTopicResource {
|
|
569
|
-
filename: string;
|
|
570
|
-
resourceUrl: string;
|
|
571
|
-
id: string;
|
|
572
|
-
mimeType: string;
|
|
573
|
-
resourceContentUrl: string;
|
|
574
|
-
viewerUrl: string;
|
|
575
|
-
}
|
|
576
|
-
export declare const isFtTopicResource: (o: any) => o is FtTopicResource;
|
|
577
|
-
export interface FtSuggestRequest {
|
|
578
|
-
input: string;
|
|
579
|
-
scope?: FtSearchScopeKeys;
|
|
580
|
-
filters: Array<FtSearchFilter>;
|
|
581
|
-
sort: Array<FtSearchSortCriterion>;
|
|
582
|
-
maxCount?: number;
|
|
583
|
-
contentLocale?: string;
|
|
584
|
-
}
|
|
585
|
-
export declare const isFtSuggestRequest: (o: any) => o is FtSuggestRequest;
|
|
586
|
-
export interface FtSuggestResult {
|
|
587
|
-
filenameExtension?: string;
|
|
588
|
-
editorialType?: FtEditorialTypeKeys;
|
|
589
|
-
mimeType?: string;
|
|
590
|
-
type: FtSearchResultTypeKeys;
|
|
591
|
-
value: string;
|
|
592
|
-
}
|
|
593
|
-
export declare const isFtSuggestResult: (o: any) => o is FtSuggestResult;
|
|
594
|
-
export interface FtSuggestResults {
|
|
595
|
-
suggestions: Array<FtSuggestResult>;
|
|
596
|
-
}
|
|
597
|
-
export declare const isFtSuggestResults: (o: any) => o is FtSuggestResults;
|
|
598
|
-
export declare enum FtUserRole {
|
|
599
|
-
PERSONAL_BOOK_USER = "PERSONAL_BOOK_USER",
|
|
600
|
-
PERSONAL_BOOK_SHARE_USER = "PERSONAL_BOOK_SHARE_USER",
|
|
601
|
-
HTML_EXPORT_USER = "HTML_EXPORT_USER",
|
|
602
|
-
PDF_EXPORT_USER = "PDF_EXPORT_USER",
|
|
603
|
-
SAVED_SEARCH_USER = "SAVED_SEARCH_USER",
|
|
604
|
-
COLLECTION_USER = "COLLECTION_USER",
|
|
605
|
-
OFFLINE_USER = "OFFLINE_USER",
|
|
606
|
-
ANALYTICS_USER = "ANALYTICS_USER",
|
|
607
|
-
BETA_USER = "BETA_USER",
|
|
608
|
-
DEBUG_USER = "DEBUG_USER",
|
|
609
|
-
PRINT_USER = "PRINT_USER",
|
|
610
|
-
RATING_USER = "RATING_USER",
|
|
611
|
-
FEEDBACK_USER = "FEEDBACK_USER",
|
|
612
|
-
GENERATIVE_AI_USER = "GENERATIVE_AI_USER",
|
|
613
|
-
CONTENT_PUBLISHER = "CONTENT_PUBLISHER",
|
|
614
|
-
KHUB_ADMIN = "KHUB_ADMIN",
|
|
615
|
-
USERS_ADMIN = "USERS_ADMIN",
|
|
616
|
-
PORTAL_ADMIN = "PORTAL_ADMIN",
|
|
617
|
-
ADMIN = "ADMIN",
|
|
618
|
-
DEVELOPER = "DEVELOPER"
|
|
619
|
-
}
|
|
620
|
-
export type FtUserRoleKeys = keyof typeof FtUserRole;
|
|
621
|
-
export declare const isFtUserRole: (o: any) => o is FtUserRole;
|
|
622
|
-
export interface FtAuthenticationIdentifier {
|
|
623
|
-
identifier: string;
|
|
624
|
-
realm: string;
|
|
625
|
-
}
|
|
626
|
-
export declare const isFtAuthenticationIdentifier: (o: any) => o is FtAuthenticationIdentifier;
|
|
627
|
-
export interface FtAuthenticatedSession {
|
|
628
|
-
authenticationIdentifier: FtAuthenticationIdentifier;
|
|
629
|
-
profile: FtUserProfile;
|
|
630
|
-
}
|
|
631
|
-
export declare const isFtAuthenticatedSession: (o: any) => o is FtAuthenticatedSession;
|
|
632
|
-
export interface FtSearchPreferences {
|
|
633
|
-
defaultFilters: Array<FtSearchFilter>;
|
|
634
|
-
}
|
|
635
|
-
export declare const isFtSearchPreferences: (o: any) => o is FtSearchPreferences;
|
|
636
|
-
export interface FtSession {
|
|
637
|
-
authenticationIdentifier?: FtAuthenticationIdentifier;
|
|
638
|
-
idleTimeoutInMillis: number;
|
|
639
|
-
profile: FtUserProfile;
|
|
640
|
-
sessionAuthenticated: boolean;
|
|
641
|
-
searchPreferences: FtSearchPreferences;
|
|
642
|
-
}
|
|
643
|
-
export declare const isFtSession: (o: any) => o is FtSession;
|
|
644
|
-
export interface FtUserProfile {
|
|
645
|
-
emailAddress?: string;
|
|
646
|
-
displayName?: string;
|
|
647
|
-
roles: Array<FtUserRoleKeys>;
|
|
648
|
-
userId?: string;
|
|
649
|
-
tags: Array<string>;
|
|
650
|
-
}
|
|
651
|
-
export declare const isFtUserProfile: (o: any) => o is FtUserProfile;
|
|
652
|
-
export interface FtWatermark {
|
|
653
|
-
color: string;
|
|
654
|
-
text: Array<string>;
|
|
655
|
-
opacity: number;
|
|
656
|
-
}
|
|
657
|
-
export declare const isFtWatermark: (o: any) => o is FtWatermark;
|