@fluid-topics/public-api 1.0.83-alpha → 1.0.85-alpha

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.
@@ -24,6 +24,169 @@ export declare enum FtTopicOriginType {
24
24
  }
25
25
  export type FtTopicOriginTypeKeys = keyof typeof FtTopicOriginType;
26
26
  export declare const isFtTopicOriginType: (o: any) => o is FtTopicOriginType;
27
+ export interface FtAnalyticsEventLocation {
28
+ type: string;
29
+ value: string;
30
+ }
31
+ export declare const isFtAnalyticsEventLocation: (o: any) => o is FtAnalyticsEventLocation;
32
+ export interface FtAnalyticsEventPublication {
33
+ metadata?: Array<FtMetadata>;
34
+ id: string;
35
+ mimeType?: string;
36
+ title?: string;
37
+ type?: FtAnalyticsPublicationTypeKeys;
38
+ parentId?: string;
39
+ }
40
+ export declare const isFtAnalyticsEventPublication: (o: any) => o is FtAnalyticsEventPublication;
41
+ export interface FtAnalyticsEventRating {
42
+ type: string;
43
+ value?: string;
44
+ }
45
+ export declare const isFtAnalyticsEventRating: (o: any) => o is FtAnalyticsEventRating;
46
+ export interface FtAnalyticsEventSearchQuery {
47
+ terms: string;
48
+ searchType?: string;
49
+ lastUpdate?: string;
50
+ facets?: Array<FtAnalyticsSearchFacet>;
51
+ }
52
+ export declare const isFtAnalyticsEventSearchQuery: (o: any) => o is FtAnalyticsEventSearchQuery;
53
+ export interface FtAnalyticsEventSearchResponse {
54
+ autocorrect?: boolean;
55
+ nbResults: number;
56
+ }
57
+ export declare const isFtAnalyticsEventSearchResponse: (o: any) => o is FtAnalyticsEventSearchResponse;
58
+ export interface FtAnalyticsEventSearchResult {
59
+ document: FtAnalyticsEventPublication;
60
+ rank: number;
61
+ topic?: FtAnalyticsEventTopic;
62
+ type: string;
63
+ }
64
+ export declare const isFtAnalyticsEventSearchResult: (o: any) => o is FtAnalyticsEventSearchResult;
65
+ export interface FtAnalyticsEventTopic {
66
+ mapTitle?: string;
67
+ metadata?: Array<FtMetadata>;
68
+ tocId: string;
69
+ mapId?: string;
70
+ title: string;
71
+ }
72
+ export declare const isFtAnalyticsEventTopic: (o: any) => o is FtAnalyticsEventTopic;
73
+ export declare enum FtAnalyticsPublicationType {
74
+ STRUCTURED_DOCUMENT = "STRUCTURED_DOCUMENT",
75
+ UNSTRUCTURED_DOCUMENT = "UNSTRUCTURED_DOCUMENT",
76
+ SHARED_PERSONAL_BOOK = "SHARED_PERSONAL_BOOK",
77
+ PERSONAL_BOOK = "PERSONAL_BOOK",
78
+ MAP_ATTACHMENT = "MAP_ATTACHMENT",
79
+ RESOURCE = "RESOURCE"
80
+ }
81
+ export type FtAnalyticsPublicationTypeKeys = keyof typeof FtAnalyticsPublicationType;
82
+ export declare const isFtAnalyticsPublicationType: (o: any) => o is FtAnalyticsPublicationType;
83
+ export interface FtAnalyticsSearchFacet {
84
+ dateValue?: FtAnalyticsSearchDateFacetValueKeys;
85
+ values?: Array<string>;
86
+ from?: string;
87
+ to?: string;
88
+ type?: FtAnalyticsSearchFacetTypeKeys;
89
+ key: string;
90
+ }
91
+ export declare const isFtAnalyticsSearchFacet: (o: any) => o is FtAnalyticsSearchFacet;
92
+ export declare enum FtAnalyticsSearchDateFacetValue {
93
+ LAST_WEEK = "LAST_WEEK",
94
+ LAST_MONTH = "LAST_MONTH",
95
+ LAST_QUARTER = "LAST_QUARTER",
96
+ LAST_YEAR = "LAST_YEAR"
97
+ }
98
+ export type FtAnalyticsSearchDateFacetValueKeys = keyof typeof FtAnalyticsSearchDateFacetValue;
99
+ export declare const isFtAnalyticsSearchDateFacetValue: (o: any) => o is FtAnalyticsSearchDateFacetValue;
100
+ export declare enum FtAnalyticsSearchFacetType {
101
+ VALUE = "VALUE",
102
+ DATE = "DATE",
103
+ RANGE = "RANGE"
104
+ }
105
+ export type FtAnalyticsSearchFacetTypeKeys = keyof typeof FtAnalyticsSearchFacetType;
106
+ export declare const isFtAnalyticsSearchFacetType: (o: any) => o is FtAnalyticsSearchFacetType;
107
+ export interface FtAnalyticsEvent {
108
+ offline: boolean;
109
+ appVersion: string;
110
+ appName: string;
111
+ name: FtAnalyticsEventNameKeys;
112
+ }
113
+ export declare const isFtAnalyticsEvent: (o: any) => o is FtAnalyticsEvent;
114
+ export declare enum FtAnalyticsEventName {
115
+ BOOKMARK__CREATE = "BOOKMARK__CREATE",
116
+ BOOKMARK__DELETE = "BOOKMARK__DELETE",
117
+ CASE_DEFLECTION__START = "CASE_DEFLECTION__START",
118
+ CASE_DEFLECTION__OPEN_TICKET = "CASE_DEFLECTION__OPEN_TICKET",
119
+ CASE_DEFLECTION__RATE = "CASE_DEFLECTION__RATE",
120
+ COLLECTION__CREATE = "COLLECTION__CREATE",
121
+ COLLECTION__UPDATE = "COLLECTION__UPDATE",
122
+ COLLECTION__DELETE = "COLLECTION__DELETE",
123
+ DOCUMENT__DISPLAY = "DOCUMENT__DISPLAY",
124
+ DOCUMENT__DOWNLOAD = "DOCUMENT__DOWNLOAD",
125
+ DOCUMENT__PRINT = "DOCUMENT__PRINT",
126
+ DOCUMENT__PROCESS = "DOCUMENT__PROCESS",
127
+ DOCUMENT__RATE = "DOCUMENT__RATE",
128
+ DOCUMENT__SEARCH = "DOCUMENT__SEARCH",
129
+ DOCUMENT__START_DISPLAY = "DOCUMENT__START_DISPLAY",
130
+ DOCUMENT__UNRATE = "DOCUMENT__UNRATE",
131
+ FEEDBACK__SEND = "FEEDBACK__SEND",
132
+ GEN_AI__COMPLETED_QUERY = "GEN_AI__COMPLETED_QUERY",
133
+ GEN_AI__RATE = "GEN_AI__RATE",
134
+ GENAI_CASE_DEFLECTION__START = "GENAI_CASE_DEFLECTION__START",
135
+ GENAI_CASE_DEFLECTION__OPEN_TICKET = "GENAI_CASE_DEFLECTION__OPEN_TICKET",
136
+ KHUB__PROCESS = "KHUB__PROCESS",
137
+ KHUB__SEARCH = "KHUB__SEARCH",
138
+ LABELS__DOWNLOAD = "LABELS__DOWNLOAD",
139
+ LINK__SHARE = "LINK__SHARE",
140
+ PAGE__DISPLAY = "PAGE__DISPLAY",
141
+ PERSONAL_BOOK__CREATE = "PERSONAL_BOOK__CREATE",
142
+ PERSONAL_BOOK__DELETE = "PERSONAL_BOOK__DELETE",
143
+ PERSONAL_BOOK__UPDATE = "PERSONAL_BOOK__UPDATE",
144
+ PERSONAL_TOPIC__CREATE = "PERSONAL_TOPIC__CREATE",
145
+ PERSONAL_TOPIC__UPDATE = "PERSONAL_TOPIC__UPDATE",
146
+ PERSONAL_TOPIC__DELETE = "PERSONAL_TOPIC__DELETE",
147
+ SAVED_SEARCH__CREATE = "SAVED_SEARCH__CREATE",
148
+ SAVED_SEARCH__DELETE = "SAVED_SEARCH__DELETE",
149
+ SAVED_SEARCH__UPDATE = "SAVED_SEARCH__UPDATE",
150
+ SEARCH_PAGE__SELECT = "SEARCH_PAGE__SELECT",
151
+ TOPIC__DISPLAY = "TOPIC__DISPLAY",
152
+ TOPIC__RATE = "TOPIC__RATE",
153
+ TOPIC__START_DISPLAY = "TOPIC__START_DISPLAY",
154
+ TOPIC__UNRATE = "TOPIC__UNRATE",
155
+ USER__LOGIN = "USER__LOGIN",
156
+ USER__LOGOUT = "USER__LOGOUT",
157
+ HEARTBEAT = "HEARTBEAT"
158
+ }
159
+ export type FtAnalyticsEventNameKeys = keyof typeof FtAnalyticsEventName;
160
+ export declare const isFtAnalyticsEventName: (o: any) => o is FtAnalyticsEventName;
161
+ export interface FtCaseDeflectionEvent extends FtAnalyticsEvent {
162
+ searchQuery?: FtAnalyticsEventSearchQuery;
163
+ context: string;
164
+ rating?: FtAnalyticsEventRating;
165
+ topic?: FtAnalyticsEventTopic;
166
+ }
167
+ export declare const isFtCaseDeflectionEvent: (o: any) => o is FtCaseDeflectionEvent;
168
+ export interface FtDocumentDownloadEvent extends FtAnalyticsEvent {
169
+ document: FtAnalyticsEventPublication;
170
+ location: FtAnalyticsEventLocation;
171
+ }
172
+ export declare const isFtDocumentDownloadEvent: (o: any) => o is FtDocumentDownloadEvent;
173
+ export interface FtGenAiCaseDeflectionEvent extends FtAnalyticsEvent {
174
+ generationId?: string;
175
+ searchQuery?: FtAnalyticsEventSearchQuery;
176
+ context: string;
177
+ }
178
+ export declare const isFtGenAiCaseDeflectionEvent: (o: any) => o is FtGenAiCaseDeflectionEvent;
179
+ export interface FtKhubSearchEvent extends FtAnalyticsEvent {
180
+ searchResponse: FtAnalyticsEventSearchResponse;
181
+ searchQuery: FtAnalyticsEventSearchQuery;
182
+ }
183
+ export declare const isFtKhubSearchEvent: (o: any) => o is FtKhubSearchEvent;
184
+ export interface FtSearchPageSelectEvent extends FtAnalyticsEvent {
185
+ searchResult: FtAnalyticsEventSearchResult;
186
+ externalLink?: string;
187
+ searchQuery: FtAnalyticsEventSearchQuery;
188
+ }
189
+ export declare const isFtSearchPageSelectEvent: (o: any) => o is FtSearchPageSelectEvent;
27
190
  export interface FtCredentials {
28
191
  password: string;
29
192
  newPassword?: string;
@@ -85,7 +248,6 @@ export interface FtMap {
85
248
  metadata: Array<FtMetadata>;
86
249
  watermark?: FtWatermark;
87
250
  openMode: FtOpenModeKeys;
88
- translatedTitle?: string;
89
251
  topicsApiEndpoint?: string;
90
252
  description?: string;
91
253
  attachmentsApiEndpoint?: string;
@@ -118,7 +280,6 @@ export interface FtTocNode {
118
280
  hasRating?: boolean;
119
281
  tocId: string;
120
282
  children: Array<FtTocNode>;
121
- translatedTitle?: string;
122
283
  origin?: FtTopicOrigin;
123
284
  contentId: string;
124
285
  title: string;
@@ -288,6 +449,12 @@ export interface FtMySearchRequest {
288
449
  contentLocale?: string;
289
450
  }
290
451
  export declare const isFtMySearchRequest: (o: any) => o is FtMySearchRequest;
452
+ export interface FtPrivacyPolicyConfiguration {
453
+ policyDescription: string;
454
+ agreementRequired: boolean;
455
+ userAgreementMessage: string;
456
+ }
457
+ export declare const isFtPrivacyPolicyConfiguration: (o: any) => o is FtPrivacyPolicyConfiguration;
291
458
  export declare enum FtRatingType {
292
459
  STARS = "STARS",
293
460
  LIKE = "LIKE",
@@ -669,6 +836,7 @@ export declare enum FtUserRole {
669
836
  RATING_USER = "RATING_USER",
670
837
  FEEDBACK_USER = "FEEDBACK_USER",
671
838
  GENERATIVE_AI_USER = "GENERATIVE_AI_USER",
839
+ GENERATIVE_AI_EXPORT_USER = "GENERATIVE_AI_EXPORT_USER",
672
840
  CONTENT_PUBLISHER = "CONTENT_PUBLISHER",
673
841
  KHUB_ADMIN = "KHUB_ADMIN",
674
842
  USERS_ADMIN = "USERS_ADMIN",
@@ -704,8 +872,10 @@ export declare const isFtSession: (o: any) => o is FtSession;
704
872
  export interface FtUserProfile {
705
873
  emailAddress?: string;
706
874
  displayName?: string;
875
+ otpValidated?: boolean;
707
876
  roles: Array<FtUserRoleKeys>;
708
877
  userId?: string;
878
+ privacyPolicyAgreementDate?: Date | string;
709
879
  tags: Array<string>;
710
880
  }
711
881
  export declare const isFtUserProfile: (o: any) => o is FtUserProfile;
@@ -21,9 +21,7 @@ export var FtMyLibraryColors;
21
21
  FtMyLibraryColors["orange"] = "orange";
22
22
  FtMyLibraryColors["yellow"] = "yellow";
23
23
  })(FtMyLibraryColors || (FtMyLibraryColors = {}));
24
- export const isFtMyLibraryColors = (o) => {
25
- return ["black", "green", "blue", "purple", "red", "orange", "yellow"].includes(o);
26
- };
24
+ export const isFtMyLibraryColors = (o) => Object.keys(FtMyLibraryColors).includes(o);
27
25
  // From: SourceType
28
26
  export var FtTopicOriginType;
29
27
  (function (FtTopicOriginType) {
@@ -31,8 +29,177 @@ export var FtTopicOriginType;
31
29
  FtTopicOriginType["PERSONAL"] = "PERSONAL";
32
30
  FtTopicOriginType["SHARED"] = "SHARED";
33
31
  })(FtTopicOriginType || (FtTopicOriginType = {}));
34
- export const isFtTopicOriginType = (o) => {
35
- return ["OFFICIAL", "PERSONAL", "SHARED"].includes(o);
32
+ export const isFtTopicOriginType = (o) => Object.keys(FtTopicOriginType).includes(o);
33
+ export const isFtAnalyticsEventLocation = (o) => {
34
+ return isObject(o)
35
+ && (isString(o.type))
36
+ && (isString(o.value));
37
+ };
38
+ export const isFtAnalyticsEventPublication = (o) => {
39
+ return isObject(o)
40
+ && (o.metadata == null || (Array.isArray(o.metadata)
41
+ && o.metadata.every((v) => isFtMetadata(v))))
42
+ && (isString(o.id))
43
+ && (o.mimeType == null || isString(o.mimeType))
44
+ && (o.title == null || isString(o.title))
45
+ && (o.type == null || isFtAnalyticsPublicationType(o.type))
46
+ && (o.parentId == null || isString(o.parentId));
47
+ };
48
+ export const isFtAnalyticsEventRating = (o) => {
49
+ return isObject(o)
50
+ && (isString(o.type))
51
+ && (o.value == null || isString(o.value));
52
+ };
53
+ export const isFtAnalyticsEventSearchQuery = (o) => {
54
+ return isObject(o)
55
+ && (isString(o.terms))
56
+ && (o.searchType == null || isString(o.searchType))
57
+ && (o.lastUpdate == null || isString(o.lastUpdate))
58
+ && (o.facets == null || (Array.isArray(o.facets)
59
+ && o.facets.every((v) => isFtAnalyticsSearchFacet(v))));
60
+ };
61
+ export const isFtAnalyticsEventSearchResponse = (o) => {
62
+ return isObject(o)
63
+ && (o.autocorrect == null || isBoolean(o.autocorrect))
64
+ && (isNumber(o.nbResults));
65
+ };
66
+ export const isFtAnalyticsEventSearchResult = (o) => {
67
+ return isObject(o)
68
+ && (isFtAnalyticsEventPublication(o.document))
69
+ && (isNumber(o.rank))
70
+ && (o.topic == null || isFtAnalyticsEventTopic(o.topic))
71
+ && (isString(o.type));
72
+ };
73
+ export const isFtAnalyticsEventTopic = (o) => {
74
+ return isObject(o)
75
+ && (o.mapTitle == null || isString(o.mapTitle))
76
+ && (o.metadata == null || (Array.isArray(o.metadata)
77
+ && o.metadata.every((v) => isFtMetadata(v))))
78
+ && (isString(o.tocId))
79
+ && (o.mapId == null || isString(o.mapId))
80
+ && (isString(o.title));
81
+ };
82
+ // From: AnalyticsPublicationType
83
+ export var FtAnalyticsPublicationType;
84
+ (function (FtAnalyticsPublicationType) {
85
+ FtAnalyticsPublicationType["STRUCTURED_DOCUMENT"] = "STRUCTURED_DOCUMENT";
86
+ FtAnalyticsPublicationType["UNSTRUCTURED_DOCUMENT"] = "UNSTRUCTURED_DOCUMENT";
87
+ FtAnalyticsPublicationType["SHARED_PERSONAL_BOOK"] = "SHARED_PERSONAL_BOOK";
88
+ FtAnalyticsPublicationType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
89
+ FtAnalyticsPublicationType["MAP_ATTACHMENT"] = "MAP_ATTACHMENT";
90
+ FtAnalyticsPublicationType["RESOURCE"] = "RESOURCE";
91
+ })(FtAnalyticsPublicationType || (FtAnalyticsPublicationType = {}));
92
+ export const isFtAnalyticsPublicationType = (o) => Object.keys(FtAnalyticsPublicationType).includes(o);
93
+ export const isFtAnalyticsSearchFacet = (o) => {
94
+ return isObject(o)
95
+ && (o.dateValue == null || isFtAnalyticsSearchDateFacetValue(o.dateValue))
96
+ && (o.values == null || (Array.isArray(o.values)
97
+ && o.values.every((v) => isString(v))))
98
+ && (o.from == null || isString(o.from))
99
+ && (o.to == null || isString(o.to))
100
+ && (o.type == null || isFtAnalyticsSearchFacetType(o.type))
101
+ && (isString(o.key));
102
+ };
103
+ // From: AnalyticsSearchDateFacetValue
104
+ export var FtAnalyticsSearchDateFacetValue;
105
+ (function (FtAnalyticsSearchDateFacetValue) {
106
+ FtAnalyticsSearchDateFacetValue["LAST_WEEK"] = "LAST_WEEK";
107
+ FtAnalyticsSearchDateFacetValue["LAST_MONTH"] = "LAST_MONTH";
108
+ FtAnalyticsSearchDateFacetValue["LAST_QUARTER"] = "LAST_QUARTER";
109
+ FtAnalyticsSearchDateFacetValue["LAST_YEAR"] = "LAST_YEAR";
110
+ })(FtAnalyticsSearchDateFacetValue || (FtAnalyticsSearchDateFacetValue = {}));
111
+ export const isFtAnalyticsSearchDateFacetValue = (o) => Object.keys(FtAnalyticsSearchDateFacetValue).includes(o);
112
+ // From: AnalyticsSearchFacetType
113
+ export var FtAnalyticsSearchFacetType;
114
+ (function (FtAnalyticsSearchFacetType) {
115
+ FtAnalyticsSearchFacetType["VALUE"] = "VALUE";
116
+ FtAnalyticsSearchFacetType["DATE"] = "DATE";
117
+ FtAnalyticsSearchFacetType["RANGE"] = "RANGE";
118
+ })(FtAnalyticsSearchFacetType || (FtAnalyticsSearchFacetType = {}));
119
+ export const isFtAnalyticsSearchFacetType = (o) => Object.keys(FtAnalyticsSearchFacetType).includes(o);
120
+ export const isFtAnalyticsEvent = (o) => {
121
+ return isObject(o)
122
+ && (isBoolean(o.offline))
123
+ && (isString(o.appVersion))
124
+ && (isString(o.appName))
125
+ && (isFtAnalyticsEventName(o.name));
126
+ };
127
+ // From: WsAnalyticsEventName
128
+ export var FtAnalyticsEventName;
129
+ (function (FtAnalyticsEventName) {
130
+ FtAnalyticsEventName["BOOKMARK__CREATE"] = "BOOKMARK__CREATE";
131
+ FtAnalyticsEventName["BOOKMARK__DELETE"] = "BOOKMARK__DELETE";
132
+ FtAnalyticsEventName["CASE_DEFLECTION__START"] = "CASE_DEFLECTION__START";
133
+ FtAnalyticsEventName["CASE_DEFLECTION__OPEN_TICKET"] = "CASE_DEFLECTION__OPEN_TICKET";
134
+ FtAnalyticsEventName["CASE_DEFLECTION__RATE"] = "CASE_DEFLECTION__RATE";
135
+ FtAnalyticsEventName["COLLECTION__CREATE"] = "COLLECTION__CREATE";
136
+ FtAnalyticsEventName["COLLECTION__UPDATE"] = "COLLECTION__UPDATE";
137
+ FtAnalyticsEventName["COLLECTION__DELETE"] = "COLLECTION__DELETE";
138
+ FtAnalyticsEventName["DOCUMENT__DISPLAY"] = "DOCUMENT__DISPLAY";
139
+ FtAnalyticsEventName["DOCUMENT__DOWNLOAD"] = "DOCUMENT__DOWNLOAD";
140
+ FtAnalyticsEventName["DOCUMENT__PRINT"] = "DOCUMENT__PRINT";
141
+ FtAnalyticsEventName["DOCUMENT__PROCESS"] = "DOCUMENT__PROCESS";
142
+ FtAnalyticsEventName["DOCUMENT__RATE"] = "DOCUMENT__RATE";
143
+ FtAnalyticsEventName["DOCUMENT__SEARCH"] = "DOCUMENT__SEARCH";
144
+ FtAnalyticsEventName["DOCUMENT__START_DISPLAY"] = "DOCUMENT__START_DISPLAY";
145
+ FtAnalyticsEventName["DOCUMENT__UNRATE"] = "DOCUMENT__UNRATE";
146
+ FtAnalyticsEventName["FEEDBACK__SEND"] = "FEEDBACK__SEND";
147
+ FtAnalyticsEventName["GEN_AI__COMPLETED_QUERY"] = "GEN_AI__COMPLETED_QUERY";
148
+ FtAnalyticsEventName["GEN_AI__RATE"] = "GEN_AI__RATE";
149
+ FtAnalyticsEventName["GENAI_CASE_DEFLECTION__START"] = "GENAI_CASE_DEFLECTION__START";
150
+ FtAnalyticsEventName["GENAI_CASE_DEFLECTION__OPEN_TICKET"] = "GENAI_CASE_DEFLECTION__OPEN_TICKET";
151
+ FtAnalyticsEventName["KHUB__PROCESS"] = "KHUB__PROCESS";
152
+ FtAnalyticsEventName["KHUB__SEARCH"] = "KHUB__SEARCH";
153
+ FtAnalyticsEventName["LABELS__DOWNLOAD"] = "LABELS__DOWNLOAD";
154
+ FtAnalyticsEventName["LINK__SHARE"] = "LINK__SHARE";
155
+ FtAnalyticsEventName["PAGE__DISPLAY"] = "PAGE__DISPLAY";
156
+ FtAnalyticsEventName["PERSONAL_BOOK__CREATE"] = "PERSONAL_BOOK__CREATE";
157
+ FtAnalyticsEventName["PERSONAL_BOOK__DELETE"] = "PERSONAL_BOOK__DELETE";
158
+ FtAnalyticsEventName["PERSONAL_BOOK__UPDATE"] = "PERSONAL_BOOK__UPDATE";
159
+ FtAnalyticsEventName["PERSONAL_TOPIC__CREATE"] = "PERSONAL_TOPIC__CREATE";
160
+ FtAnalyticsEventName["PERSONAL_TOPIC__UPDATE"] = "PERSONAL_TOPIC__UPDATE";
161
+ FtAnalyticsEventName["PERSONAL_TOPIC__DELETE"] = "PERSONAL_TOPIC__DELETE";
162
+ FtAnalyticsEventName["SAVED_SEARCH__CREATE"] = "SAVED_SEARCH__CREATE";
163
+ FtAnalyticsEventName["SAVED_SEARCH__DELETE"] = "SAVED_SEARCH__DELETE";
164
+ FtAnalyticsEventName["SAVED_SEARCH__UPDATE"] = "SAVED_SEARCH__UPDATE";
165
+ FtAnalyticsEventName["SEARCH_PAGE__SELECT"] = "SEARCH_PAGE__SELECT";
166
+ FtAnalyticsEventName["TOPIC__DISPLAY"] = "TOPIC__DISPLAY";
167
+ FtAnalyticsEventName["TOPIC__RATE"] = "TOPIC__RATE";
168
+ FtAnalyticsEventName["TOPIC__START_DISPLAY"] = "TOPIC__START_DISPLAY";
169
+ FtAnalyticsEventName["TOPIC__UNRATE"] = "TOPIC__UNRATE";
170
+ FtAnalyticsEventName["USER__LOGIN"] = "USER__LOGIN";
171
+ FtAnalyticsEventName["USER__LOGOUT"] = "USER__LOGOUT";
172
+ FtAnalyticsEventName["HEARTBEAT"] = "HEARTBEAT";
173
+ })(FtAnalyticsEventName || (FtAnalyticsEventName = {}));
174
+ export const isFtAnalyticsEventName = (o) => Object.keys(FtAnalyticsEventName).includes(o);
175
+ export const isFtCaseDeflectionEvent = (o) => {
176
+ return isObject(o)
177
+ && (o.searchQuery == null || isFtAnalyticsEventSearchQuery(o.searchQuery))
178
+ && (isString(o.context))
179
+ && (o.rating == null || isFtAnalyticsEventRating(o.rating))
180
+ && (o.topic == null || isFtAnalyticsEventTopic(o.topic));
181
+ };
182
+ export const isFtDocumentDownloadEvent = (o) => {
183
+ return isObject(o)
184
+ && (isFtAnalyticsEventPublication(o.document))
185
+ && (isFtAnalyticsEventLocation(o.location));
186
+ };
187
+ export const isFtGenAiCaseDeflectionEvent = (o) => {
188
+ return isObject(o)
189
+ && (o.generationId == null || isString(o.generationId))
190
+ && (o.searchQuery == null || isFtAnalyticsEventSearchQuery(o.searchQuery))
191
+ && (isString(o.context));
192
+ };
193
+ export const isFtKhubSearchEvent = (o) => {
194
+ return isObject(o)
195
+ && (isFtAnalyticsEventSearchResponse(o.searchResponse))
196
+ && (isFtAnalyticsEventSearchQuery(o.searchQuery));
197
+ };
198
+ export const isFtSearchPageSelectEvent = (o) => {
199
+ return isObject(o)
200
+ && (isFtAnalyticsEventSearchResult(o.searchResult))
201
+ && (o.externalLink == null || isString(o.externalLink))
202
+ && (isFtAnalyticsEventSearchQuery(o.searchQuery));
36
203
  };
37
204
  export const isFtCredentials = (o) => {
38
205
  return isObject(o)
@@ -102,7 +269,6 @@ export const isFtMap = (o) => {
102
269
  && o.metadata.every((v) => isFtMetadata(v))))
103
270
  && (o.watermark == null || isFtWatermark(o.watermark))
104
271
  && (isFtOpenMode(o.openMode))
105
- && (o.translatedTitle == null || o.translatedTitle == null || isString(o.translatedTitle))
106
272
  && (o.topicsApiEndpoint == null || isString(o.topicsApiEndpoint))
107
273
  && (o.description == null || isString(o.description))
108
274
  && (o.attachmentsApiEndpoint == null || isString(o.attachmentsApiEndpoint))
@@ -137,7 +303,6 @@ export const isFtTocNode = (o) => {
137
303
  && (isString(o.tocId))
138
304
  && ((Array.isArray(o.children)
139
305
  && o.children.every((v) => isFtTocNode(v))))
140
- && (o.translatedTitle == null || o.translatedTitle == null || isString(o.translatedTitle))
141
306
  && (o.origin == null || isFtTopicOrigin(o.origin))
142
307
  && (isString(o.contentId))
143
308
  && (isString(o.title));
@@ -192,9 +357,7 @@ export var FtTopicContentTarget;
192
357
  FtTopicContentTarget["PAGES"] = "PAGES";
193
358
  FtTopicContentTarget["DESIGNED_READER"] = "DESIGNED_READER";
194
359
  })(FtTopicContentTarget || (FtTopicContentTarget = {}));
195
- export const isFtTopicContentTarget = (o) => {
196
- return ["THIRD_PARTY", "OFF_THE_GRID", "CONTENT_PACKAGER", "PAGES", "DESIGNED_READER"].includes(o);
197
- };
360
+ export const isFtTopicContentTarget = (o) => Object.keys(FtTopicContentTarget).includes(o);
198
361
  // From: ExternalWebComponentContext
199
362
  export var FtExternalWebComponentContext;
200
363
  (function (FtExternalWebComponentContext) {
@@ -206,9 +369,7 @@ export var FtExternalWebComponentContext;
206
369
  FtExternalWebComponentContext["SEARCH"] = "SEARCH";
207
370
  FtExternalWebComponentContext["SEARCH_RESULT"] = "SEARCH_RESULT";
208
371
  })(FtExternalWebComponentContext || (FtExternalWebComponentContext = {}));
209
- export const isFtExternalWebComponentContext = (o) => {
210
- return ["HOMEPAGE", "CUSTOM", "HEADER", "READER", "TOPIC_TEMPLATE", "SEARCH", "SEARCH_RESULT"].includes(o);
211
- };
372
+ export const isFtExternalWebComponentContext = (o) => Object.keys(FtExternalWebComponentContext).includes(o);
212
373
  export const isFtFeedbackCreation = (o) => {
213
374
  return isObject(o)
214
375
  && (o.from == null || isString(o.from))
@@ -221,9 +382,7 @@ export var FtMetadataHomeLayout;
221
382
  FtMetadataHomeLayout["CUSTOM"] = "CUSTOM";
222
383
  FtMetadataHomeLayout["DESIGNER"] = "DESIGNER";
223
384
  })(FtMetadataHomeLayout || (FtMetadataHomeLayout = {}));
224
- export const isFtMetadataHomeLayout = (o) => {
225
- return ["CLASSIC", "CUSTOM", "DESIGNER"].includes(o);
226
- };
385
+ export const isFtMetadataHomeLayout = (o) => Object.keys(FtMetadataHomeLayout).includes(o);
227
386
  export const isFtDefaultLocale = (o) => {
228
387
  return isObject(o)
229
388
  && (isString(o.lang))
@@ -275,9 +434,7 @@ export var FtFacetType;
275
434
  FtFacetType["OR"] = "OR";
276
435
  FtFacetType["MONOVALUED"] = "MONOVALUED";
277
436
  })(FtFacetType || (FtFacetType = {}));
278
- export const isFtFacetType = (o) => {
279
- return ["AND", "OR", "MONOVALUED"].includes(o);
280
- };
437
+ export const isFtFacetType = (o) => Object.keys(FtFacetType).includes(o);
281
438
  export const isFtMetadata = (o) => {
282
439
  return isObject(o)
283
440
  && ((Array.isArray(o.values)
@@ -295,9 +452,7 @@ export var FtMetadataSortRule;
295
452
  FtMetadataSortRule["ALPHABET"] = "ALPHABET";
296
453
  FtMetadataSortRule["VERSION"] = "VERSION";
297
454
  })(FtMetadataSortRule || (FtMetadataSortRule = {}));
298
- export const isFtMetadataSortRule = (o) => {
299
- return ["NONE", "ALPHABET", "VERSION"].includes(o);
300
- };
455
+ export const isFtMetadataSortRule = (o) => Object.keys(FtMetadataSortRule).includes(o);
301
456
  export const isFtMetadataConfiguration = (o) => {
302
457
  return isObject(o)
303
458
  && ((Array.isArray(o.descriptors)
@@ -336,6 +491,12 @@ export const isFtMySearchRequest = (o) => {
336
491
  && o.metadataFilters.every((v) => isFtLabeledMetadataFilter(v))))
337
492
  && (o.contentLocale == null || isString(o.contentLocale));
338
493
  };
494
+ export const isFtPrivacyPolicyConfiguration = (o) => {
495
+ return isObject(o)
496
+ && (isString(o.policyDescription))
497
+ && (isBoolean(o.agreementRequired))
498
+ && (isString(o.userAgreementMessage));
499
+ };
339
500
  // From: RatingType
340
501
  export var FtRatingType;
341
502
  (function (FtRatingType) {
@@ -344,9 +505,7 @@ export var FtRatingType;
344
505
  FtRatingType["DICHOTOMOUS"] = "DICHOTOMOUS";
345
506
  FtRatingType["NO_RATING"] = "NO_RATING";
346
507
  })(FtRatingType || (FtRatingType = {}));
347
- export const isFtRatingType = (o) => {
348
- return ["STARS", "LIKE", "DICHOTOMOUS", "NO_RATING"].includes(o);
349
- };
508
+ export const isFtRatingType = (o) => Object.keys(FtRatingType).includes(o);
350
509
  export const isFtPublicationRating = (o) => {
351
510
  return isObject(o)
352
511
  && (isString(o.date))
@@ -410,9 +569,7 @@ export var FtPeriodFilterType;
410
569
  FtPeriodFilterType["LAST_YEAR"] = "LAST_YEAR";
411
570
  FtPeriodFilterType["CUSTOM"] = "CUSTOM";
412
571
  })(FtPeriodFilterType || (FtPeriodFilterType = {}));
413
- export const isFtPeriodFilterType = (o) => {
414
- return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR", "CUSTOM"].includes(o);
415
- };
572
+ export const isFtPeriodFilterType = (o) => Object.keys(FtPeriodFilterType).includes(o);
416
573
  export const isFtSearchPreset = (o) => {
417
574
  return isObject(o)
418
575
  && (isString(o.name))
@@ -427,18 +584,14 @@ export var FtSearchSortCriterionOrder;
427
584
  FtSearchSortCriterionOrder["ASC"] = "ASC";
428
585
  FtSearchSortCriterionOrder["DESC"] = "DESC";
429
586
  })(FtSearchSortCriterionOrder || (FtSearchSortCriterionOrder = {}));
430
- export const isFtSearchSortCriterionOrder = (o) => {
431
- return ["ASC", "DESC"].includes(o);
432
- };
587
+ export const isFtSearchSortCriterionOrder = (o) => Object.keys(FtSearchSortCriterionOrder).includes(o);
433
588
  // From: SearchSortCriterionType
434
589
  export var FtSearchSortCriterionType;
435
590
  (function (FtSearchSortCriterionType) {
436
591
  FtSearchSortCriterionType["ALPHA"] = "ALPHA";
437
592
  FtSearchSortCriterionType["NATURAL"] = "NATURAL";
438
593
  })(FtSearchSortCriterionType || (FtSearchSortCriterionType = {}));
439
- export const isFtSearchSortCriterionType = (o) => {
440
- return ["ALPHA", "NATURAL"].includes(o);
441
- };
594
+ export const isFtSearchSortCriterionType = (o) => Object.keys(FtSearchSortCriterionType).includes(o);
442
595
  // From: VirtualField
443
596
  export var FtVirtualField;
444
597
  (function (FtVirtualField) {
@@ -446,9 +599,7 @@ export var FtVirtualField;
446
599
  FtVirtualField["TITLE_ONLY"] = "TITLE_ONLY";
447
600
  FtVirtualField["NONE"] = "NONE";
448
601
  })(FtVirtualField || (FtVirtualField = {}));
449
- export const isFtVirtualField = (o) => {
450
- return ["EVERYWHERE", "TITLE_ONLY", "NONE"].includes(o);
451
- };
602
+ export const isFtVirtualField = (o) => Object.keys(FtVirtualField).includes(o);
452
603
  export const isFtSearchResultsPageInfo = (o) => {
453
604
  return isObject(o)
454
605
  && (isNumber(o.totalResultsCount))
@@ -463,18 +614,14 @@ export var FtEditorialType;
463
614
  FtEditorialType["BOOK"] = "BOOK";
464
615
  FtEditorialType["SHARED_BOOK"] = "SHARED_BOOK";
465
616
  })(FtEditorialType || (FtEditorialType = {}));
466
- export const isFtEditorialType = (o) => {
467
- return ["ARTICLE", "BOOK", "SHARED_BOOK"].includes(o);
468
- };
617
+ export const isFtEditorialType = (o) => Object.keys(FtEditorialType).includes(o);
469
618
  // From: WsOpenMode
470
619
  export var FtOpenMode;
471
620
  (function (FtOpenMode) {
472
621
  FtOpenMode["FLUIDTOPICS"] = "FLUIDTOPICS";
473
622
  FtOpenMode["EXTERNAL"] = "EXTERNAL";
474
623
  })(FtOpenMode || (FtOpenMode = {}));
475
- export const isFtOpenMode = (o) => {
476
- return ["FLUIDTOPICS", "EXTERNAL"].includes(o);
477
- };
624
+ export const isFtOpenMode = (o) => Object.keys(FtOpenMode).includes(o);
478
625
  export const isFtPageRequest = (o) => {
479
626
  return isObject(o)
480
627
  && (o.perPage == null || isNumber(o.perPage))
@@ -493,9 +640,7 @@ export var FtCollectionDocumentType;
493
640
  FtCollectionDocumentType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
494
641
  FtCollectionDocumentType["SHARED_BOOK"] = "SHARED_BOOK";
495
642
  })(FtCollectionDocumentType || (FtCollectionDocumentType = {}));
496
- export const isFtCollectionDocumentType = (o) => {
497
- return ["MAP", "DOCUMENT", "TOPIC", "PERSONAL_BOOK", "SHARED_BOOK"].includes(o);
498
- };
643
+ export const isFtCollectionDocumentType = (o) => Object.keys(FtCollectionDocumentType).includes(o);
499
644
  export const isFtDateFilter = (o) => {
500
645
  return isObject(o)
501
646
  && (isFtDateFilterType(o.type));
@@ -508,9 +653,7 @@ export var FtDateFilterType;
508
653
  FtDateFilterType["LAST_QUARTER"] = "LAST_QUARTER";
509
654
  FtDateFilterType["LAST_YEAR"] = "LAST_YEAR";
510
655
  })(FtDateFilterType || (FtDateFilterType = {}));
511
- export const isFtDateFilterType = (o) => {
512
- return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR"].includes(o);
513
- };
656
+ export const isFtDateFilterType = (o) => Object.keys(FtDateFilterType).includes(o);
514
657
  export const isFtSearchResults = (o) => {
515
658
  return isObject(o)
516
659
  && (o.spellcheck == null || isFtSpellcheck(o.spellcheck))
@@ -672,9 +815,7 @@ export var FtSearchResultType;
672
815
  FtSearchResultType["DOCUMENT"] = "DOCUMENT";
673
816
  FtSearchResultType["TOPIC"] = "TOPIC";
674
817
  })(FtSearchResultType || (FtSearchResultType = {}));
675
- export const isFtSearchResultType = (o) => {
676
- return ["MAP", "DOCUMENT", "TOPIC"].includes(o);
677
- };
818
+ export const isFtSearchResultType = (o) => Object.keys(FtSearchResultType).includes(o);
678
819
  // From: WsPublicSearchScope
679
820
  export var FtSearchScope;
680
821
  (function (FtSearchScope) {
@@ -683,9 +824,7 @@ export var FtSearchScope;
683
824
  FtSearchScope["ALL_TOPICS"] = "ALL_TOPICS";
684
825
  FtSearchScope["TOPICS_AND_UNSTRUCTURED_DOCUMENTS"] = "TOPICS_AND_UNSTRUCTURED_DOCUMENTS";
685
826
  })(FtSearchScope || (FtSearchScope = {}));
686
- export const isFtSearchScope = (o) => {
687
- return ["DEFAULT", "DOCUMENTS", "ALL_TOPICS", "TOPICS_AND_UNSTRUCTURED_DOCUMENTS"].includes(o);
688
- };
827
+ export const isFtSearchScope = (o) => Object.keys(FtSearchScope).includes(o);
689
828
  export const isFtValueFilter = (o) => {
690
829
  return isObject(o)
691
830
  && (isBoolean(o.negative))
@@ -777,6 +916,7 @@ export var FtUserRole;
777
916
  FtUserRole["RATING_USER"] = "RATING_USER";
778
917
  FtUserRole["FEEDBACK_USER"] = "FEEDBACK_USER";
779
918
  FtUserRole["GENERATIVE_AI_USER"] = "GENERATIVE_AI_USER";
919
+ FtUserRole["GENERATIVE_AI_EXPORT_USER"] = "GENERATIVE_AI_EXPORT_USER";
780
920
  FtUserRole["CONTENT_PUBLISHER"] = "CONTENT_PUBLISHER";
781
921
  FtUserRole["KHUB_ADMIN"] = "KHUB_ADMIN";
782
922
  FtUserRole["USERS_ADMIN"] = "USERS_ADMIN";
@@ -784,9 +924,7 @@ export var FtUserRole;
784
924
  FtUserRole["ADMIN"] = "ADMIN";
785
925
  FtUserRole["DEVELOPER"] = "DEVELOPER";
786
926
  })(FtUserRole || (FtUserRole = {}));
787
- export const isFtUserRole = (o) => {
788
- 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", "CONTENT_PUBLISHER", "KHUB_ADMIN", "USERS_ADMIN", "PORTAL_ADMIN", "ADMIN", "DEVELOPER"].includes(o);
789
- };
927
+ export const isFtUserRole = (o) => Object.keys(FtUserRole).includes(o);
790
928
  export const isFtAuthenticationIdentifier = (o) => {
791
929
  return isObject(o)
792
930
  && (isString(o.identifier))
@@ -816,9 +954,11 @@ export const isFtUserProfile = (o) => {
816
954
  return isObject(o)
817
955
  && (o.emailAddress == null || isString(o.emailAddress))
818
956
  && (o.displayName == null || isString(o.displayName))
957
+ && (o.otpValidated == null || isBoolean(o.otpValidated))
819
958
  && ((Array.isArray(o.roles)
820
959
  && o.roles.every((v) => isFtUserRole(v))))
821
960
  && (o.userId == null || isString(o.userId))
961
+ && (o.privacyPolicyAgreementDate == null || isString(o.privacyPolicyAgreementDate))
822
962
  && ((Array.isArray(o.tags)
823
963
  && o.tags.every((v) => isString(v))));
824
964
  };
@@ -58,22 +58,6 @@ export interface FtTranslationInput {
58
58
  sourceLanguage?: string;
59
59
  }
60
60
  export declare const isFtTranslationInput: (o: any) => o is FtTranslationInput;
61
- export interface FtTranslationLanguagesInput {
62
- profileId: string;
63
- sourceLanguage?: string;
64
- }
65
- export declare const isFtTranslationLanguagesInput: (o: any) => o is FtTranslationLanguagesInput;
66
- export interface FtTranslationSettingsInput {
67
- profileId: string;
68
- destinationLanguage: string;
69
- sourceLanguage?: string;
70
- }
71
- export declare const isFtTranslationSettingsInput: (o: any) => o is FtTranslationSettingsInput;
72
- export interface FtTranslationLanguagesResponse {
73
- code: string;
74
- label: string;
75
- }
76
- export declare const isFtTranslationLanguagesResponse: (o: any) => o is FtTranslationLanguagesResponse;
77
61
  export interface FtMapAttachment {
78
62
  file: string;
79
63
  size?: number;
@@ -100,7 +84,6 @@ export interface FtPaginatedTocNode {
100
84
  pageToc?: Array<any>;
101
85
  tocId?: string;
102
86
  children: Array<FtPaginatedTocNode>;
103
- translatedTitle?: string;
104
87
  pageConfiguration?: FtPageConfiguration;
105
88
  origin?: any;
106
89
  contentId?: string;
@@ -124,6 +107,7 @@ export interface FtSemanticSearchResponseItem {
124
107
  export declare const isFtSemanticSearchResponseItem: (o: any) => o is FtSemanticSearchResponseItem;
125
108
  export interface FtSemanticSearchFilter {
126
109
  values: Array<string>;
110
+ hierarchicalValues?: Array<Array<string>>;
127
111
  key: string;
128
112
  }
129
113
  export declare const isFtSemanticSearchFilter: (o: any) => o is FtSemanticSearchFilter;