@fluid-topics/public-api 1.0.98 → 1.0.100

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/dist/cjs/index.js +3 -0
  2. package/dist/cjs/types/ft-common/public.js +113 -71
  3. package/dist/cjs/types/ft-server/public.js +87 -1
  4. package/dist/fluidtopics.min.js +1 -1
  5. package/dist/mjs/index.d.ts +3 -0
  6. package/dist/mjs/index.js +3 -0
  7. package/dist/mjs/types/ft-common/public.d.ts +91 -57
  8. package/dist/mjs/types/ft-common/public.js +98 -61
  9. package/dist/mjs/types/ft-server/public.d.ts +72 -0
  10. package/dist/mjs/types/ft-server/public.js +75 -0
  11. package/package.json +2 -2
  12. package/yarn.lock +4 -4
  13. package/dist/cjs/helpers/GenAIChunkReader.js +0 -66
  14. package/dist/mjs/helpers/GenAIChunkReader.d.ts +0 -19
  15. package/dist/mjs/helpers/GenAIChunkReader.js +0 -37
package/dist/cjs/index.js CHANGED
@@ -223,6 +223,9 @@ class FluidTopicsApi {
223
223
  },
224
224
  assets: {
225
225
  highlightjs: `assets/scripts/highlightjs`,
226
+ customCode: (subPath) => ({
227
+ endpoint: `portal/custom-code/${subPath}`,
228
+ })
226
229
  },
227
230
  analytics: {
228
231
  events: "api/analytics/events",
package/dist/cjs/types/ft-common/public.js CHANGED
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.isFtCredentials = exports.isFtTopicStartDisplayEvent = exports.isFtTopicDisplayEvent = exports.isFtSearchResultOpenContextMenuEvent = exports.isFtSearchPageSelectEvent = exports.isFtPageDisplayEvent = exports.isFtLinkShareEvent = exports.isFtLabelsDownloadEvent = exports.isFtKhubSearchEvent = exports.isFtGenAiRateEvent = exports.isFtGenAiCaseDeflectionEvent = exports.isFtFeedbackSendEvent = exports.isFtDocumentStartDisplayEvent = exports.isFtDocumentSearchEvent = exports.isFtDocumentPrintEvent = exports.isFtDocumentDownloadEvent = exports.isFtDocumentDisplayEvent = exports.isFtCaseDeflectionEvent = exports.isFtAnalyticsEventName = exports.FtAnalyticsEventName = exports.isFtAnalyticsEvent = exports.isFtAnalyticsSearchFacetType = exports.FtAnalyticsSearchFacetType = exports.isFtAnalyticsSearchDateFacetValue = exports.FtAnalyticsSearchDateFacetValue = exports.isFtAnalyticsSearchFacet = exports.isFtAnalyticsPublicationType = exports.FtAnalyticsPublicationType = exports.isFtAnalyticsEventTopic = exports.isFtAnalyticsEventSearchResult = exports.isFtAnalyticsEventSearchResponse = exports.isFtAnalyticsEventSearchQuery = exports.isFtAnalyticsEventRating = exports.isFtAnalyticsEventPublication = exports.isFtAnalyticsEventPage = exports.isFtAnalyticsEventOrigin = exports.isFtAnalyticsEventLocation = exports.isFtAnalyticsEventGenAIProfileTranslationDetails = exports.isFtAnalyticsEventGenAIProfileCompletionDetails = exports.isFtAnalyticsEventGenAIProfileChatbotDetails = exports.isFtAnalyticsEventGenAIProfile = exports.isFtAnalyticsEventDocument = exports.isFtAnalyticsEventDisplay = exports.isFtAnalyticsDocumentType = exports.FtAnalyticsDocumentType = exports.isFtTopicOriginType = exports.FtTopicOriginType = exports.isFtMyLibraryColors = exports.FtMyLibraryColors = exports.isFtHttpErrorDetails = void 0;
4
- exports.isFtSearchPreferencesConfiguration = exports.isFtMetadataPreferenceConfiguration = exports.isFtMapResource = exports.isFtTopicsRatingSummary = exports.isFtTopicRating = exports.isFtRatingSummary = exports.isFtRatingCreation = exports.isFtPublicationRatingSummary = exports.isFtPublicationRating = exports.isFtRatingType = exports.FtRatingType = exports.isFtPrivacyPolicyConfiguration = exports.isFtMySearchUpdate = exports.isFtMySearchRequest = exports.isFtMySearchCreation = exports.isFtMySearch = exports.isFtMetadataDescriptor = exports.isFtMetadataConfiguration = exports.isFtMetadataSortRule = exports.FtMetadataSortRule = exports.isFtMetadata = exports.isFtFacetType = exports.FtFacetType = exports.isFtUiLocale = exports.isFtMessageContext = exports.isFtLocalesConfiguration = exports.isFtSearchLocales = exports.isFtSearchLocale = exports.isFtDefaultLocales = exports.isFtDefaultLocale = exports.isFtMetadataHomeLayout = exports.FtMetadataHomeLayout = exports.isFtFeedbackCreation = exports.isFtExternalWebComponentContext = exports.FtExternalWebComponentContext = exports.isFtTranslationContent = exports.isFtTopicContentTarget = exports.FtTopicContentTarget = exports.isFtUnstructuredDocument = exports.isFtTopicOrigin = exports.isFtTopic = exports.isFtTocNode = exports.isFtMapStyles = exports.isFtMap = exports.isFtCollectionDocument = exports.isFtBookmark = exports.isFtPersonalBookTopicLinkCreation = exports.isFtPersonalBookNodeCreation = exports.isFtPersonalBookMetadataUpdate = exports.isFtPersonalBookCreation = void 0;
5
- exports.isFtSuggestResults = exports.isFtSuggestResult = exports.isFtSuggestRequest = exports.isFtTopicResource = exports.isFtSpellcheck = exports.isFtSearchSortCriterion = exports.isFtSearchFacetEntry = exports.isFtSearchFacetConf = exports.isFtSearchFacet = exports.isFtValueFilter = exports.isFtSearchScope = exports.FtSearchScope = exports.isFtSearchResultType = exports.FtSearchResultType = exports.isFtSearchResultTopic = exports.isFtSearchResultMap = exports.isFtSearchResultUnstructuredDocument = exports.isFtSearchResultClusterEntry = exports.isFtSearchResultCluster = exports.isFtSearchRequest = exports.isFtSearchPrior = exports.isFtRangeFilter = exports.isFtPeriod = exports.isFtMetadataFilter = exports.isFtPeriodFilter = exports.isFtLegacyMetadataFilter = exports.isFtLegacyLabeledMetadataFilter = exports.isFtLabeledMetadataFilter = exports.isFtSearchResults = exports.isFtDateFilterType = exports.FtDateFilterType = exports.isFtDateFilter = exports.isFtCollectionDocumentType = exports.FtCollectionDocumentType = exports.isFtPublicClusterSortCriterion = exports.isFtPageRequest = exports.isFtOpenMode = exports.FtOpenMode = exports.isFtEditorialType = exports.FtEditorialType = exports.isFtSearchResultsPageInfo = exports.isFtVirtualField = exports.FtVirtualField = exports.isFtSearchSortCriterionType = exports.FtSearchSortCriterionType = exports.isFtSearchSortCriterionOrder = exports.FtSearchSortCriterionOrder = exports.isFtSearchPreset = exports.isFtPeriodFilterType = exports.FtPeriodFilterType = void 0;
6
- exports.isFtWatermark = exports.isFtUserProfile = exports.isFtSession = exports.isFtSearchPreferences = exports.isFtAuthenticatedSession = exports.isFtAuthenticationIdentifier = exports.isFtUserRole = exports.FtUserRole = void 0;
3
+ exports.isFtSearchResultOpenContextMenuEvent = exports.isFtSearchPageSelectEvent = exports.isFtPageDisplayEvent = exports.isFtLinkShareEvent = exports.isFtLabelsDownloadEvent = exports.isFtKhubSearchEvent = exports.isFtFeedbackSendEvent = exports.isFtDocumentStartDisplayEvent = exports.isFtDocumentSearchEvent = exports.isFtDocumentPrintEvent = exports.isFtDocumentDownloadEvent = exports.isFtDocumentDisplayEvent = exports.isFtCustomTriggerEvent = exports.isFtCaseDeflectionEvent = exports.isFtAnalyticsEventName = exports.FtAnalyticsEventName = exports.isFtAnalyticsEvent = exports.isFtAiRateEvent = exports.isFtAiCompletedQueryEvent = exports.isFtAiCaseDeflectionEvent = exports.isFtAnalyticsSearchFacetType = exports.FtAnalyticsSearchFacetType = exports.isFtAnalyticsSearchDateFacetValue = exports.FtAnalyticsSearchDateFacetValue = exports.isFtAnalyticsSearchFacet = exports.isFtAnalyticsPublicationType = exports.FtAnalyticsPublicationType = exports.isFtAnalyticsEventTopic = exports.isFtAnalyticsEventSearchResult = exports.isFtAnalyticsEventSearchResponse = exports.isFtAnalyticsEventSearchQuery = exports.isFtAnalyticsEventRating = exports.isFtAnalyticsEventPublication = exports.isFtAnalyticsEventPage = exports.isFtAnalyticsEventOrigin = exports.isFtAnalyticsEventLocation = exports.isFtAnalyticsEventDocumentSearchQuery = exports.isFtAnalyticsEventDocument = exports.isFtAnalyticsEventDisplay = exports.isFtAnalyticsEventAIProfileTranslationDetails = exports.isFtAnalyticsEventAIProfileCompletionDetails = exports.isFtAnalyticsEventAIProfileChatbotDetails = exports.isFtAnalyticsEventAIProfile = exports.isFtAnalyticsDocumentType = exports.FtAnalyticsDocumentType = exports.isFtTopicOriginType = exports.FtTopicOriginType = exports.isFtMyLibraryColors = exports.FtMyLibraryColors = exports.isFtHttpErrorDetails = void 0;
4
+ exports.isFtTopicsRatingSummary = exports.isFtTopicRating = exports.isFtRatingSummary = exports.isFtRatingCreation = exports.isFtPublicationRatingSummary = exports.isFtPublicationRating = exports.isFtRatingType = exports.FtRatingType = exports.isFtPrivacyPolicyConfiguration = exports.isFtMySearchUpdate = exports.isFtMySearchRequest = exports.isFtMySearchCreation = exports.isFtMySearch = exports.isFtMetadataDescriptor = exports.isFtMetadataConfiguration = exports.isFtMetadataSortRule = exports.FtMetadataSortRule = exports.isFtMetadata = exports.isFtFacetType = exports.FtFacetType = exports.isFtUiLocale = exports.isFtMessageContext = exports.isFtLocalesConfiguration = exports.isFtSearchLocales = exports.isFtSearchLocale = exports.isFtDefaultLocales = exports.isFtDefaultLocale = exports.isFtMetadataHomeLayout = exports.FtMetadataHomeLayout = exports.isFtFeedbackCreation = exports.isFtExternalWebComponentContext = exports.FtExternalWebComponentContext = exports.isFtTranslationContent = exports.isFtTopicContentTarget = exports.FtTopicContentTarget = exports.isFtUnstructuredDocument = exports.isFtTopicOrigin = exports.isFtTopic = exports.isFtTocNode = exports.isFtMapStyles = exports.isFtMap = exports.isFtCollectionDocument = exports.isFtBookmark = exports.isFtPersonalBookTopicLinkCreation = exports.isFtPersonalBookNodeCreation = exports.isFtPersonalBookMetadataUpdate = exports.isFtPersonalBookCreation = exports.isFtCredentials = exports.isFtTopicStartDisplayEvent = exports.isFtTopicDisplayEvent = void 0;
5
+ exports.isFtTopicResource = exports.isFtSpellcheck = exports.isFtSearchSortCriterion = exports.isFtSearchFacetEntry = exports.isFtSearchFacetConf = exports.isFtSearchFacet = exports.isFtValueFilter = exports.isFtSearchScope = exports.FtSearchScope = exports.isFtSearchResultType = exports.FtSearchResultType = exports.isFtSearchResultTopic = exports.isFtSearchResultMap = exports.isFtSearchResultUnstructuredDocument = exports.isFtSearchResultClusterEntry = exports.isFtSearchResultCluster = exports.isFtSearchRequest = exports.isFtSearchPrior = exports.isFtRangeFilter = exports.isFtPeriod = exports.isFtMetadataFilter = exports.isFtPeriodFilter = exports.isFtLegacyMetadataFilter = exports.isFtLegacyLabeledMetadataFilter = exports.isFtLabeledMetadataFilter = exports.isFtSearchResults = exports.isFtDateFilterType = exports.FtDateFilterType = exports.isFtDateFilter = exports.isFtCollectionDocumentType = exports.FtCollectionDocumentType = exports.isFtPublicClusterSortCriterion = exports.isFtPageRequest = exports.isFtOpenMode = exports.FtOpenMode = exports.isFtEditorialType = exports.FtEditorialType = exports.isFtSearchResultsPageInfo = exports.isFtVirtualField = exports.FtVirtualField = exports.isFtSearchSortCriterionType = exports.FtSearchSortCriterionType = exports.isFtSearchSortCriterionOrder = exports.FtSearchSortCriterionOrder = exports.isFtSearchPreset = exports.isFtPeriodFilterType = exports.FtPeriodFilterType = exports.isFtSearchPreferencesConfiguration = exports.isFtMetadataPreferenceConfiguration = exports.isFtMapResource = void 0;
6
+ exports.isFtWatermark = exports.isFtUserAssetCount = exports.isFtUserProfile = exports.isFtSession = exports.isFtSearchPreferences = exports.isFtAuthenticatedSession = exports.isFtAuthenticationIdentifier = exports.isFtUserAssetType = exports.FtUserAssetType = exports.isFtUserRole = exports.FtUserRole = exports.isFtSuggestResults = exports.isFtSuggestResult = exports.isFtSuggestRequest = void 0;
7
7
  const isObject = (o) => typeof o === "object" && o != null;
8
8
  const isBoolean = (o) => typeof o === "boolean";
9
9
  const isNumber = (o) => typeof o === "number";
@@ -46,11 +46,39 @@ var FtAnalyticsDocumentType;
46
46
  FtAnalyticsDocumentType["UNSTRUCTURED_DOCUMENT"] = "UNSTRUCTURED_DOCUMENT";
47
47
  FtAnalyticsDocumentType["SHARED_PERSONAL_BOOK"] = "SHARED_PERSONAL_BOOK";
48
48
  FtAnalyticsDocumentType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
49
- FtAnalyticsDocumentType["MAP_ATTACHMENT"] = "MAP_ATTACHMENT";
49
+ FtAnalyticsDocumentType["ATTACHMENT"] = "ATTACHMENT";
50
50
  FtAnalyticsDocumentType["RESOURCE"] = "RESOURCE";
51
51
  })(FtAnalyticsDocumentType = exports.FtAnalyticsDocumentType || (exports.FtAnalyticsDocumentType = {}));
52
52
  const isFtAnalyticsDocumentType = (o) => Object.keys(FtAnalyticsDocumentType).includes(o);
53
53
  exports.isFtAnalyticsDocumentType = isFtAnalyticsDocumentType;
54
+ const isFtAnalyticsEventAIProfile = (o) => {
55
+ return isObject(o)
56
+ && (o.chatbotDetails == null || (0, exports.isFtAnalyticsEventAIProfileChatbotDetails)(o.chatbotDetails))
57
+ && (o.translationDetails == null || (0, exports.isFtAnalyticsEventAIProfileTranslationDetails)(o.translationDetails))
58
+ && (o.completionDetails == null || (0, exports.isFtAnalyticsEventAIProfileCompletionDetails)(o.completionDetails))
59
+ && (isString(o.name))
60
+ && (isString(o.id))
61
+ && (isString(o.type));
62
+ };
63
+ exports.isFtAnalyticsEventAIProfile = isFtAnalyticsEventAIProfile;
64
+ const isFtAnalyticsEventAIProfileChatbotDetails = (o) => {
65
+ return isObject(o)
66
+ && (isString(o.provider))
67
+ && (o.model == null || isString(o.model));
68
+ };
69
+ exports.isFtAnalyticsEventAIProfileChatbotDetails = isFtAnalyticsEventAIProfileChatbotDetails;
70
+ const isFtAnalyticsEventAIProfileCompletionDetails = (o) => {
71
+ return isObject(o)
72
+ && (isString(o.provider))
73
+ && (o.model == null || isString(o.model));
74
+ };
75
+ exports.isFtAnalyticsEventAIProfileCompletionDetails = isFtAnalyticsEventAIProfileCompletionDetails;
76
+ const isFtAnalyticsEventAIProfileTranslationDetails = (o) => {
77
+ return isObject(o)
78
+ && (isString(o.provider))
79
+ && (o.engine == null || isString(o.engine));
80
+ };
81
+ exports.isFtAnalyticsEventAIProfileTranslationDetails = isFtAnalyticsEventAIProfileTranslationDetails;
54
82
  const isFtAnalyticsEventDisplay = (o) => {
55
83
  return isObject(o)
56
84
  && (isNumber(o.width))
@@ -68,34 +96,11 @@ const isFtAnalyticsEventDocument = (o) => {
68
96
  && (o.parentId == null || isString(o.parentId));
69
97
  };
70
98
  exports.isFtAnalyticsEventDocument = isFtAnalyticsEventDocument;
71
- const isFtAnalyticsEventGenAIProfile = (o) => {
72
- return isObject(o)
73
- && (o.chatbotDetails == null || (0, exports.isFtAnalyticsEventGenAIProfileChatbotDetails)(o.chatbotDetails))
74
- && (o.translationDetails == null || (0, exports.isFtAnalyticsEventGenAIProfileTranslationDetails)(o.translationDetails))
75
- && (o.completionDetails == null || (0, exports.isFtAnalyticsEventGenAIProfileCompletionDetails)(o.completionDetails))
76
- && (isString(o.name))
77
- && (isString(o.id))
78
- && (isString(o.type));
79
- };
80
- exports.isFtAnalyticsEventGenAIProfile = isFtAnalyticsEventGenAIProfile;
81
- const isFtAnalyticsEventGenAIProfileChatbotDetails = (o) => {
82
- return isObject(o)
83
- && (isString(o.provider))
84
- && (o.model == null || isString(o.model));
85
- };
86
- exports.isFtAnalyticsEventGenAIProfileChatbotDetails = isFtAnalyticsEventGenAIProfileChatbotDetails;
87
- const isFtAnalyticsEventGenAIProfileCompletionDetails = (o) => {
99
+ const isFtAnalyticsEventDocumentSearchQuery = (o) => {
88
100
  return isObject(o)
89
- && (isString(o.provider))
90
- && (o.model == null || isString(o.model));
91
- };
92
- exports.isFtAnalyticsEventGenAIProfileCompletionDetails = isFtAnalyticsEventGenAIProfileCompletionDetails;
93
- const isFtAnalyticsEventGenAIProfileTranslationDetails = (o) => {
94
- return isObject(o)
95
- && (isString(o.provider))
96
- && (o.engine == null || isString(o.engine));
101
+ && (isString(o.terms));
97
102
  };
98
- exports.isFtAnalyticsEventGenAIProfileTranslationDetails = isFtAnalyticsEventGenAIProfileTranslationDetails;
103
+ exports.isFtAnalyticsEventDocumentSearchQuery = isFtAnalyticsEventDocumentSearchQuery;
99
104
  const isFtAnalyticsEventLocation = (o) => {
100
105
  return isObject(o)
101
106
  && (isString(o.type))
@@ -146,7 +151,7 @@ const isFtAnalyticsEventSearchQuery = (o) => {
146
151
  exports.isFtAnalyticsEventSearchQuery = isFtAnalyticsEventSearchQuery;
147
152
  const isFtAnalyticsEventSearchResponse = (o) => {
148
153
  return isObject(o)
149
- && (o.autocorrect == null || isBoolean(o.autocorrect))
154
+ && (isBoolean(o.autocorrect))
150
155
  && (isNumber(o.nbResults));
151
156
  };
152
157
  exports.isFtAnalyticsEventSearchResponse = isFtAnalyticsEventSearchResponse;
@@ -175,7 +180,7 @@ var FtAnalyticsPublicationType;
175
180
  FtAnalyticsPublicationType["UNSTRUCTURED_DOCUMENT"] = "UNSTRUCTURED_DOCUMENT";
176
181
  FtAnalyticsPublicationType["SHARED_PERSONAL_BOOK"] = "SHARED_PERSONAL_BOOK";
177
182
  FtAnalyticsPublicationType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
178
- FtAnalyticsPublicationType["MAP_ATTACHMENT"] = "MAP_ATTACHMENT";
183
+ FtAnalyticsPublicationType["ATTACHMENT"] = "ATTACHMENT";
179
184
  FtAnalyticsPublicationType["RESOURCE"] = "RESOURCE";
180
185
  })(FtAnalyticsPublicationType = exports.FtAnalyticsPublicationType || (exports.FtAnalyticsPublicationType = {}));
181
186
  const isFtAnalyticsPublicationType = (o) => Object.keys(FtAnalyticsPublicationType).includes(o);
@@ -210,10 +215,36 @@ var FtAnalyticsSearchFacetType;
210
215
  })(FtAnalyticsSearchFacetType = exports.FtAnalyticsSearchFacetType || (exports.FtAnalyticsSearchFacetType = {}));
211
216
  const isFtAnalyticsSearchFacetType = (o) => Object.keys(FtAnalyticsSearchFacetType).includes(o);
212
217
  exports.isFtAnalyticsSearchFacetType = isFtAnalyticsSearchFacetType;
218
+ const isFtAiCaseDeflectionEvent = (o) => {
219
+ return isObject(o)
220
+ && (o.generationId == null || isString(o.generationId))
221
+ && (o.searchQuery == null || (0, exports.isFtAnalyticsEventSearchQuery)(o.searchQuery))
222
+ && (isString(o.context));
223
+ };
224
+ exports.isFtAiCaseDeflectionEvent = isFtAiCaseDeflectionEvent;
225
+ const isFtAiCompletedQueryEvent = (o) => {
226
+ return isObject(o)
227
+ && (isString(o.result))
228
+ && ((0, exports.isFtAnalyticsEventAIProfile)(o.profile))
229
+ && (isNumber(o.durationMs))
230
+ && (o.parameters == null || (isObject(o.parameters)
231
+ && Object.keys(o.parameters).every((k) => isString(k))
232
+ && Object.values(o.parameters).every((v) => isString(v))))
233
+ && (isString(o.queryId));
234
+ };
235
+ exports.isFtAiCompletedQueryEvent = isFtAiCompletedQueryEvent;
236
+ const isFtAiRateEvent = (o) => {
237
+ return isObject(o)
238
+ && ((0, exports.isFtAnalyticsEventRating)(o.rating))
239
+ && (isString(o.comment))
240
+ && (isString(o.queryId));
241
+ };
242
+ exports.isFtAiRateEvent = isFtAiRateEvent;
213
243
  const isFtAnalyticsEvent = (o) => {
214
244
  return isObject(o)
215
245
  && (isBoolean(o.offline))
216
246
  && (isString(o.appVersion))
247
+ && (o.internal == null || isBoolean(o.internal))
217
248
  && (isString(o.appName))
218
249
  && ((0, exports.isFtAnalyticsEventName)(o.name));
219
250
  };
@@ -229,6 +260,7 @@ var FtAnalyticsEventName;
229
260
  FtAnalyticsEventName["COLLECTION__CREATE"] = "COLLECTION__CREATE";
230
261
  FtAnalyticsEventName["COLLECTION__UPDATE"] = "COLLECTION__UPDATE";
231
262
  FtAnalyticsEventName["COLLECTION__DELETE"] = "COLLECTION__DELETE";
263
+ FtAnalyticsEventName["CUSTOM_EVENT__TRIGGER"] = "CUSTOM_EVENT__TRIGGER";
232
264
  FtAnalyticsEventName["DOCUMENT__DISPLAY"] = "DOCUMENT__DISPLAY";
233
265
  FtAnalyticsEventName["DOCUMENT__DOWNLOAD"] = "DOCUMENT__DOWNLOAD";
234
266
  FtAnalyticsEventName["DOCUMENT__PRINT"] = "DOCUMENT__PRINT";
@@ -238,10 +270,10 @@ var FtAnalyticsEventName;
238
270
  FtAnalyticsEventName["DOCUMENT__START_DISPLAY"] = "DOCUMENT__START_DISPLAY";
239
271
  FtAnalyticsEventName["DOCUMENT__UNRATE"] = "DOCUMENT__UNRATE";
240
272
  FtAnalyticsEventName["FEEDBACK__SEND"] = "FEEDBACK__SEND";
241
- FtAnalyticsEventName["GEN_AI__COMPLETED_QUERY"] = "GEN_AI__COMPLETED_QUERY";
242
- FtAnalyticsEventName["GEN_AI__RATE"] = "GEN_AI__RATE";
243
- FtAnalyticsEventName["GENAI_CASE_DEFLECTION__START"] = "GENAI_CASE_DEFLECTION__START";
244
- FtAnalyticsEventName["GENAI_CASE_DEFLECTION__OPEN_TICKET"] = "GENAI_CASE_DEFLECTION__OPEN_TICKET";
273
+ FtAnalyticsEventName["AI__COMPLETED_QUERY"] = "AI__COMPLETED_QUERY";
274
+ FtAnalyticsEventName["AI__RATE"] = "AI__RATE";
275
+ FtAnalyticsEventName["AI_CASE_DEFLECTION__START"] = "AI_CASE_DEFLECTION__START";
276
+ FtAnalyticsEventName["AI_CASE_DEFLECTION__OPEN_TICKET"] = "AI_CASE_DEFLECTION__OPEN_TICKET";
245
277
  FtAnalyticsEventName["KHUB__PROCESS"] = "KHUB__PROCESS";
246
278
  FtAnalyticsEventName["KHUB__SEARCH"] = "KHUB__SEARCH";
247
279
  FtAnalyticsEventName["LABELS__DOWNLOAD"] = "LABELS__DOWNLOAD";
@@ -276,6 +308,13 @@ const isFtCaseDeflectionEvent = (o) => {
276
308
  && (o.topic == null || (0, exports.isFtAnalyticsEventTopic)(o.topic));
277
309
  };
278
310
  exports.isFtCaseDeflectionEvent = isFtCaseDeflectionEvent;
311
+ const isFtCustomTriggerEvent = (o) => {
312
+ return isObject(o)
313
+ && (o.componentId == null || isString(o.componentId))
314
+ && (isString(o.eventName))
315
+ && ((0, exports.isFtAnalyticsEventPage)(o.page));
316
+ };
317
+ exports.isFtCustomTriggerEvent = isFtCustomTriggerEvent;
279
318
  const isFtDocumentDisplayEvent = (o) => {
280
319
  return isObject(o)
281
320
  && (o.publication == null || (0, exports.isFtAnalyticsEventPublication)(o.publication))
@@ -301,7 +340,7 @@ const isFtDocumentSearchEvent = (o) => {
301
340
  && ((0, exports.isFtAnalyticsEventSearchResponse)(o.searchResponse))
302
341
  && (o.publication == null || (0, exports.isFtAnalyticsEventPublication)(o.publication))
303
342
  && (o.document == null || (0, exports.isFtAnalyticsEventDocument)(o.document))
304
- && ((0, exports.isFtAnalyticsEventSearchQuery)(o.searchQuery));
343
+ && ((0, exports.isFtAnalyticsEventDocumentSearchQuery)(o.searchQuery));
305
344
  };
306
345
  exports.isFtDocumentSearchEvent = isFtDocumentSearchEvent;
307
346
  const isFtDocumentStartDisplayEvent = (o) => {
@@ -320,20 +359,6 @@ const isFtFeedbackSendEvent = (o) => {
320
359
  && (isBoolean(o.loggedIn));
321
360
  };
322
361
  exports.isFtFeedbackSendEvent = isFtFeedbackSendEvent;
323
- const isFtGenAiCaseDeflectionEvent = (o) => {
324
- return isObject(o)
325
- && (o.generationId == null || isString(o.generationId))
326
- && (o.searchQuery == null || (0, exports.isFtAnalyticsEventSearchQuery)(o.searchQuery))
327
- && (isString(o.context));
328
- };
329
- exports.isFtGenAiCaseDeflectionEvent = isFtGenAiCaseDeflectionEvent;
330
- const isFtGenAiRateEvent = (o) => {
331
- return isObject(o)
332
- && ((0, exports.isFtAnalyticsEventRating)(o.rating))
333
- && (isString(o.comment))
334
- && (isString(o.queryId));
335
- };
336
- exports.isFtGenAiRateEvent = isFtGenAiRateEvent;
337
362
  const isFtKhubSearchEvent = (o) => {
338
363
  return isObject(o)
339
364
  && ((0, exports.isFtAnalyticsEventSearchResponse)(o.searchResponse))
@@ -466,28 +491,29 @@ const isFtMap = (o) => {
466
491
  && (o.prettyUrl == null || isString(o.prettyUrl))
467
492
  && ((Array.isArray(o.metadata)
468
493
  && o.metadata.every((v) => (0, exports.isFtMetadata)(v))))
469
- && (o.watermark == null || (0, exports.isFtWatermark)(o.watermark))
470
- && ((0, exports.isFtOpenMode)(o.openMode))
471
494
  && (o.topicsApiEndpoint == null || isString(o.topicsApiEndpoint))
472
495
  && (o.description == null || isString(o.description))
473
- && (o.attachmentsApiEndpoint == null || isString(o.attachmentsApiEndpoint))
474
496
  && ((0, exports.isFtEditorialType)(o.editorialType))
475
497
  && (isString(o.baseId))
476
498
  && (isString(o.clusterId))
477
499
  && (isString(o.title))
478
- && (isString(o.lastPublication))
479
- && (isBoolean(o.pbkConfidential))
480
500
  && (isString(o.lastEdition))
481
501
  && (isString(o.originId))
482
502
  && (o.rightsApiEndpoint == null || isString(o.rightsApiEndpoint))
483
- && ((0, exports.isFtMapStyles)(o.contentStyles))
484
- && (o.originUrl == null || isString(o.originUrl))
485
503
  && (isString(o.fingerprint))
486
504
  && (isString(o.readerUrl))
487
- && (o.untranslatedTitle == null || o.untranslatedTitle == null || isString(o.untranslatedTitle))
505
+ && (o.untranslatedTitle == null || isString(o.untranslatedTitle))
488
506
  && (o.khubVersion == null || isString(o.khubVersion))
489
507
  && (isString(o.id))
490
- && (o.lang == null || isString(o.lang));
508
+ && (o.lang == null || isString(o.lang))
509
+ && (o.watermark == null || (0, exports.isFtWatermark)(o.watermark))
510
+ && ((0, exports.isFtOpenMode)(o.openMode))
511
+ && (o.attachmentsApiEndpoint == null || isString(o.attachmentsApiEndpoint))
512
+ && (isString(o.lastPublication))
513
+ && (isBoolean(o.pbkConfidential))
514
+ && ((0, exports.isFtMapStyles)(o.contentStyles))
515
+ && (o.originUrl == null || isString(o.originUrl))
516
+ && (isBoolean(o.translationError));
491
517
  };
492
518
  exports.isFtMap = isFtMap;
493
519
  const isFtMapStyles = (o) => {
@@ -507,7 +533,7 @@ const isFtTocNode = (o) => {
507
533
  && o.children.every((v) => (0, exports.isFtTocNode)(v))))
508
534
  && (o.origin == null || (0, exports.isFtTopicOrigin)(o.origin))
509
535
  && (isString(o.contentId))
510
- && (o.untranslatedTitle == null || o.untranslatedTitle == null || isString(o.untranslatedTitle))
536
+ && (o.untranslatedTitle == null || isString(o.untranslatedTitle))
511
537
  && (isString(o.title));
512
538
  };
513
539
  exports.isFtTocNode = isFtTocNode;
@@ -539,18 +565,18 @@ const isFtUnstructuredDocument = (o) => {
539
565
  && (isString(o.openMode))
540
566
  && (o.description == null || isString(o.description))
541
567
  && (isString(o.mimeType))
542
- && (o.baseId == null || isString(o.baseId))
568
+ && (isString(o.baseId))
543
569
  && (o.clusterId == null || isString(o.clusterId))
544
570
  && (isString(o.contentApiEndpoint))
545
571
  && (isString(o.title))
546
- && (o.lastPublication == null || isString(o.lastPublication))
572
+ && (isString(o.lastPublication))
547
573
  && (isString(o.viewerUrl))
548
574
  && (isString(o.lastEdition))
549
575
  && (isString(o.filename))
550
576
  && (o.originId == null || isString(o.originId))
551
577
  && (isString(o.rightsApiEndpoint))
552
578
  && (o.originUrl == null || isString(o.originUrl))
553
- && (o.khubVersion == null || isString(o.khubVersion))
579
+ && (isString(o.khubVersion))
554
580
  && (isString(o.id))
555
581
  && (o.lang == null || isString(o.lang));
556
582
  };
@@ -718,7 +744,7 @@ const isFtMySearchCreation = (o) => {
718
744
  exports.isFtMySearchCreation = isFtMySearchCreation;
719
745
  const isFtMySearchRequest = (o) => {
720
746
  return isObject(o)
721
- && (o.periodFilter == null || o.periodFilter == null || (0, exports.isFtPeriodFilter)(o.periodFilter))
747
+ && (o.periodFilter == null || (0, exports.isFtPeriodFilter)(o.periodFilter))
722
748
  && (isString(o.query))
723
749
  && (o.scope == null || (0, exports.isFtSearchScope)(o.scope))
724
750
  && (o.filters == null || (Array.isArray(o.filters)
@@ -999,7 +1025,7 @@ const isFtSearchPrior = (o) => {
999
1025
  exports.isFtSearchPrior = isFtSearchPrior;
1000
1026
  const isFtSearchRequest = (o) => {
1001
1027
  return isObject(o)
1002
- && (o.periodFilter == null || o.periodFilter == null || (0, exports.isFtPeriodFilter)(o.periodFilter))
1028
+ && (o.periodFilter == null || (0, exports.isFtPeriodFilter)(o.periodFilter))
1003
1029
  && (isString(o.query))
1004
1030
  && ((0, exports.isFtPageRequest)(o.paging))
1005
1031
  && (o.filters == null || (Array.isArray(o.filters)
@@ -1041,11 +1067,11 @@ const isFtSearchResultUnstructuredDocument = (o) => {
1041
1067
  return isObject(o)
1042
1068
  && ((Array.isArray(o.metadata)
1043
1069
  && o.metadata.every((v) => (0, exports.isFtMetadata)(v))))
1044
- && ((0, exports.isFtOpenMode)(o.openMode))
1070
+ && (o.openMode == null || (0, exports.isFtOpenMode)(o.openMode))
1045
1071
  && (isString(o.documentUrl))
1046
1072
  && (isString(o.mimeType))
1047
1073
  && (isString(o.title))
1048
- && (o.lastPublicationDate == null || isString(o.lastPublicationDate))
1074
+ && (isString(o.lastPublicationDate))
1049
1075
  && (isString(o.viewerUrl))
1050
1076
  && (isString(o.contentUrl))
1051
1077
  && (isString(o.filename))
@@ -1063,7 +1089,7 @@ const isFtSearchResultMap = (o) => {
1063
1089
  && (o.openMode == null || (0, exports.isFtOpenMode)(o.openMode))
1064
1090
  && ((0, exports.isFtEditorialType)(o.editorialType))
1065
1091
  && (isString(o.title))
1066
- && (o.lastPublicationDate == null || isString(o.lastPublicationDate))
1092
+ && (isString(o.lastPublicationDate))
1067
1093
  && (isString(o.htmlTitle))
1068
1094
  && (o.originUrl == null || isString(o.originUrl))
1069
1095
  && (isString(o.mapUrl))
@@ -1077,7 +1103,7 @@ const isFtSearchResultTopic = (o) => {
1077
1103
  return isObject(o)
1078
1104
  && ((Array.isArray(o.metadata)
1079
1105
  && o.metadata.every((v) => (0, exports.isFtMetadata)(v))))
1080
- && ((0, exports.isFtOpenMode)(o.openMode))
1106
+ && (o.openMode == null || (0, exports.isFtOpenMode)(o.openMode))
1081
1107
  && (isString(o.contentId))
1082
1108
  && ((Array.isArray(o.resources)
1083
1109
  && o.resources.every((v) => (0, exports.isFtTopicResource)(v))))
@@ -1226,6 +1252,16 @@ var FtUserRole;
1226
1252
  })(FtUserRole = exports.FtUserRole || (exports.FtUserRole = {}));
1227
1253
  const isFtUserRole = (o) => Object.keys(FtUserRole).includes(o);
1228
1254
  exports.isFtUserRole = isFtUserRole;
1255
+ // From: UserAssetType
1256
+ var FtUserAssetType;
1257
+ (function (FtUserAssetType) {
1258
+ FtUserAssetType["SEARCHES"] = "SEARCHES";
1259
+ FtUserAssetType["BOOKMARKS"] = "BOOKMARKS";
1260
+ FtUserAssetType["BOOKS"] = "BOOKS";
1261
+ FtUserAssetType["COLLECTIONS"] = "COLLECTIONS";
1262
+ })(FtUserAssetType = exports.FtUserAssetType || (exports.FtUserAssetType = {}));
1263
+ const isFtUserAssetType = (o) => Object.keys(FtUserAssetType).includes(o);
1264
+ exports.isFtUserAssetType = isFtUserAssetType;
1229
1265
  const isFtAuthenticationIdentifier = (o) => {
1230
1266
  return isObject(o)
1231
1267
  && (isString(o.identifier))
@@ -1268,6 +1304,12 @@ const isFtUserProfile = (o) => {
1268
1304
  && o.tags.every((v) => isString(v))));
1269
1305
  };
1270
1306
  exports.isFtUserProfile = isFtUserProfile;
1307
+ const isFtUserAssetCount = (o) => {
1308
+ return isObject(o)
1309
+ && (isNumber(o.count))
1310
+ && ((0, exports.isFtUserAssetType)(o.userAssetType));
1311
+ };
1312
+ exports.isFtUserAssetCount = isFtUserAssetCount;
1271
1313
  const isFtWatermark = (o) => {
1272
1314
  return isObject(o)
1273
1315
  && (isString(o.color))
package/dist/cjs/types/ft-server/public.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.isFtSemanticSearchRequest = exports.isFtSemanticSearchOrFilter = exports.isFtSemanticSearchNotFilter = exports.isFtSemanticSearchKeyValueFilter = exports.isFtSemanticSearchFilter = exports.isFtSemanticSearchAndFilter = exports.isFtSemanticSearchResponseItem = exports.isFtClusteredSemanticSearchReply = exports.isFtPaginationConfiguration = exports.isFtPaginatedTocNodeWithTranslationFailure = exports.isFtPaginatedTocNode = exports.isFtPaginatedToc = exports.isFtPageConfiguration = exports.isFtMapAttachment = exports.isFtTranslationLocale = exports.isFtTranslationResponse = exports.isFtTranslationRequest = exports.isFtTranslationLanguagesResponse = exports.isTranslationFormat = exports.TranslationFormat = exports.isFtRagInput = exports.isFtRagHistory = exports.isFtRagResponseFormat = exports.FtRagResponseFormat = exports.isFtGenAIGenerateInput = exports.isFtGenAIRating = exports.isFtReaderFeedbackConfiguration = exports.isFtReaderConfiguration = exports.isFtConfigurationHistoryEntryStatus = exports.FtConfigurationHistoryEntryStatus = void 0;
3
+ exports.isFtSemanticSearchRequest = exports.isFtSemanticSearchOrFilter = exports.isFtSemanticSearchNotFilter = exports.isFtSemanticSearchKeyValueFilter = exports.isFtSemanticSearchFilter = exports.isFtSemanticSearchAndFilter = exports.isFtSemanticSearchResponseItem = exports.isFtClusteredSemanticSearchReply = exports.isFtPaginationConfiguration = exports.isFtPaginatedTocNodeWithTranslationFailure = exports.isFtPaginatedTocNode = exports.isFtPaginatedToc = exports.isFtPageConfiguration = exports.isFtMapAttachment = exports.isFtTranslationLocale = exports.isFtTranslationResponse = exports.isFtTranslationRequest = exports.isFtTranslationLanguagesResponse = exports.isTranslationFormat = exports.TranslationFormat = exports.isFtGenAIRagTraceOutput = exports.isFtGenAIRagTraceInput = exports.isFtGenAIRagTraceHistoryItem = exports.isFtGenAIRagTrace = exports.isFtGenAIFetchRagTracesResult = exports.isFtGenAIRagFetchTracesRequest = exports.isFtGenAIGenerationTraceOutput = exports.isFtGenAIGenerationTraceInput = exports.isFtGenAIGenerationTrace = exports.isFtGenAIFetchGenerationTracesResult = exports.isFtGenAIGenerationFetchTracesRequest = exports.isFtRagInput = exports.isFtRagHistory = exports.isFtRagResponseFormat = exports.FtRagResponseFormat = exports.isFtGenAIGenerateInput = exports.isFtGenAIRating = exports.isFtReaderFeedbackConfiguration = exports.isFtReaderConfiguration = exports.isFtConfigurationHistoryEntryStatus = exports.FtConfigurationHistoryEntryStatus = void 0;
4
4
  const isObject = (o) => typeof o === "object" && o != null;
5
5
  const isBoolean = (o) => typeof o === "boolean";
6
6
  const isNumber = (o) => typeof o === "number";
@@ -75,6 +75,92 @@ const isFtRagInput = (o) => {
75
75
  && o.filters.every((v) => (0, exports.isFtSemanticSearchFilter)(v))));
76
76
  };
77
77
  exports.isFtRagInput = isFtRagInput;
78
+ const isFtGenAIGenerationFetchTracesRequest = (o) => {
79
+ return isObject(o)
80
+ && (o.endDate == null || isString(o.endDate))
81
+ && (o.nbResults == null || isNumber(o.nbResults))
82
+ && (o.userId == null || isString(o.userId))
83
+ && (o.startDate == null || isString(o.startDate));
84
+ };
85
+ exports.isFtGenAIGenerationFetchTracesRequest = isFtGenAIGenerationFetchTracesRequest;
86
+ const isFtGenAIFetchGenerationTracesResult = (o) => {
87
+ return isObject(o)
88
+ && (o.endDate == null || isString(o.endDate))
89
+ && (isNumber(o.nbResults))
90
+ && ((Array.isArray(o.results)
91
+ && o.results.every((v) => (0, exports.isFtGenAIGenerationTrace)(v))))
92
+ && (o.startDate == null || isString(o.startDate));
93
+ };
94
+ exports.isFtGenAIFetchGenerationTracesResult = isFtGenAIFetchGenerationTracesResult;
95
+ const isFtGenAIGenerationTrace = (o) => {
96
+ return isObject(o)
97
+ && ((0, exports.isFtGenAIGenerationTraceOutput)(o.output))
98
+ && ((0, exports.isFtGenAIGenerationTraceInput)(o.input))
99
+ && (o.profileId == null || isString(o.profileId))
100
+ && (isString(o.id))
101
+ && (o.sessionId == null || isString(o.sessionId))
102
+ && (o.userId == null || isString(o.userId))
103
+ && (isString(o.timestamp));
104
+ };
105
+ exports.isFtGenAIGenerationTrace = isFtGenAIGenerationTrace;
106
+ const isFtGenAIGenerationTraceInput = (o) => {
107
+ return isObject(o)
108
+ && (isString(o.query));
109
+ };
110
+ exports.isFtGenAIGenerationTraceInput = isFtGenAIGenerationTraceInput;
111
+ const isFtGenAIGenerationTraceOutput = (o) => {
112
+ return isObject(o)
113
+ && (isString(o.response));
114
+ };
115
+ exports.isFtGenAIGenerationTraceOutput = isFtGenAIGenerationTraceOutput;
116
+ const isFtGenAIRagFetchTracesRequest = (o) => {
117
+ return isObject(o)
118
+ && (o.endDate == null || isString(o.endDate))
119
+ && (o.nbResults == null || isNumber(o.nbResults))
120
+ && (o.userId == null || isString(o.userId))
121
+ && (o.startDate == null || isString(o.startDate));
122
+ };
123
+ exports.isFtGenAIRagFetchTracesRequest = isFtGenAIRagFetchTracesRequest;
124
+ const isFtGenAIFetchRagTracesResult = (o) => {
125
+ return isObject(o)
126
+ && (o.endDate == null || isString(o.endDate))
127
+ && (isNumber(o.nbResults))
128
+ && ((Array.isArray(o.results)
129
+ && o.results.every((v) => (0, exports.isFtGenAIRagTrace)(v))))
130
+ && (o.startDate == null || isString(o.startDate));
131
+ };
132
+ exports.isFtGenAIFetchRagTracesResult = isFtGenAIFetchRagTracesResult;
133
+ const isFtGenAIRagTrace = (o) => {
134
+ return isObject(o)
135
+ && ((0, exports.isFtGenAIRagTraceOutput)(o.output))
136
+ && ((0, exports.isFtGenAIRagTraceInput)(o.input))
137
+ && (o.conversationId == null || isString(o.conversationId))
138
+ && (o.profileId == null || isString(o.profileId))
139
+ && (isString(o.id))
140
+ && (o.sessionId == null || isString(o.sessionId))
141
+ && (o.userId == null || isString(o.userId))
142
+ && (isString(o.timestamp));
143
+ };
144
+ exports.isFtGenAIRagTrace = isFtGenAIRagTrace;
145
+ const isFtGenAIRagTraceHistoryItem = (o) => {
146
+ return isObject(o)
147
+ && (isString(o.role))
148
+ && (isString(o.content));
149
+ };
150
+ exports.isFtGenAIRagTraceHistoryItem = isFtGenAIRagTraceHistoryItem;
151
+ const isFtGenAIRagTraceInput = (o) => {
152
+ return isObject(o)
153
+ && (isString(o.userInstructions))
154
+ && (isString(o.query))
155
+ && ((Array.isArray(o.history)
156
+ && o.history.every((v) => (0, exports.isFtGenAIRagTraceHistoryItem)(v))));
157
+ };
158
+ exports.isFtGenAIRagTraceInput = isFtGenAIRagTraceInput;
159
+ const isFtGenAIRagTraceOutput = (o) => {
160
+ return isObject(o)
161
+ && (isString(o.response));
162
+ };
163
+ exports.isFtGenAIRagTraceOutput = isFtGenAIRagTraceOutput;
78
164
  var TranslationFormat;
79
165
  (function (TranslationFormat) {
80
166
  TranslationFormat["TEXT"] = "TEXT";