@fluid-topics/public-api 1.0.98 → 1.0.100-alpha

package/dist/cjs/index.js

@@ -193,6 +193,7 @@ class FluidTopicsApi {
             configuration: {
                 reader: `api/configuration/reader`,
                 metadata: `api/configuration/metadata`,
+                search: `api/configuration/search`
             },
             locales: {
                 ui: `api/locales/ui`,
@@ -223,6 +224,9 @@ class FluidTopicsApi {
             },
             assets: {
                 highlightjs: `assets/scripts/highlightjs`,
+                customCode: (subPath) => ({
+                    endpoint: `portal/custom-code/${subPath}`,
+                })
             },
             analytics: {
                 events: "api/analytics/events",
@@ -276,6 +280,9 @@ class FluidTopicsApi {
     getReaderConfiguration() {
         return this.get(this.endpoints.configuration.reader);
     }
+    getSearchConfiguration() {
+        return this.get(this.endpoints.configuration.search);
+    }
     getMap(mapId, translationSettings, v) {
         const endpoint = this.endpoints.khub.maps.mapId(mapId).info;
         const queryParams = Object.assign(Object.assign({}, this.buildTranslationParameters(translationSettings)), { v });

package/dist/cjs/types/ft-common/public.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
-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;
-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;
-exports.isFtWatermark = exports.isFtUserProfile = exports.isFtSession = exports.isFtSearchPreferences = exports.isFtAuthenticatedSession = exports.isFtAuthenticationIdentifier = exports.isFtUserRole = exports.FtUserRole = void 0;
+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;
+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;
+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;
+exports.isFtSearchSortOption = exports.isFtSearchConfiguration = exports.isFtLocalizableLabel = 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 = exports.isFtLocalizableLabelType = exports.FtLocalizableLabelType = void 0;
 const isObject = (o) => typeof o === "object" && o != null;
 const isBoolean = (o) => typeof o === "boolean";
 const isNumber = (o) => typeof o === "number";
@@ -46,11 +46,39 @@ var FtAnalyticsDocumentType;
     FtAnalyticsDocumentType["UNSTRUCTURED_DOCUMENT"] = "UNSTRUCTURED_DOCUMENT";
     FtAnalyticsDocumentType["SHARED_PERSONAL_BOOK"] = "SHARED_PERSONAL_BOOK";
     FtAnalyticsDocumentType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
-    FtAnalyticsDocumentType["MAP_ATTACHMENT"] = "MAP_ATTACHMENT";
+    FtAnalyticsDocumentType["ATTACHMENT"] = "ATTACHMENT";
     FtAnalyticsDocumentType["RESOURCE"] = "RESOURCE";
 })(FtAnalyticsDocumentType = exports.FtAnalyticsDocumentType || (exports.FtAnalyticsDocumentType = {}));
 const isFtAnalyticsDocumentType = (o) => Object.keys(FtAnalyticsDocumentType).includes(o);
 exports.isFtAnalyticsDocumentType = isFtAnalyticsDocumentType;
+const isFtAnalyticsEventAIProfile = (o) => {
+    return isObject(o)
+        && (o.chatbotDetails == null || (0, exports.isFtAnalyticsEventAIProfileChatbotDetails)(o.chatbotDetails))
+        && (o.translationDetails == null || (0, exports.isFtAnalyticsEventAIProfileTranslationDetails)(o.translationDetails))
+        && (o.completionDetails == null || (0, exports.isFtAnalyticsEventAIProfileCompletionDetails)(o.completionDetails))
+        && (isString(o.name))
+        && (isString(o.id))
+        && (isString(o.type));
+};
+exports.isFtAnalyticsEventAIProfile = isFtAnalyticsEventAIProfile;
+const isFtAnalyticsEventAIProfileChatbotDetails = (o) => {
+    return isObject(o)
+        && (isString(o.provider))
+        && (o.model == null || isString(o.model));
+};
+exports.isFtAnalyticsEventAIProfileChatbotDetails = isFtAnalyticsEventAIProfileChatbotDetails;
+const isFtAnalyticsEventAIProfileCompletionDetails = (o) => {
+    return isObject(o)
+        && (isString(o.provider))
+        && (o.model == null || isString(o.model));
+};
+exports.isFtAnalyticsEventAIProfileCompletionDetails = isFtAnalyticsEventAIProfileCompletionDetails;
+const isFtAnalyticsEventAIProfileTranslationDetails = (o) => {
+    return isObject(o)
+        && (isString(o.provider))
+        && (o.engine == null || isString(o.engine));
+};
+exports.isFtAnalyticsEventAIProfileTranslationDetails = isFtAnalyticsEventAIProfileTranslationDetails;
 const isFtAnalyticsEventDisplay = (o) => {
     return isObject(o)
         && (isNumber(o.width))
@@ -68,34 +96,11 @@ const isFtAnalyticsEventDocument = (o) => {
         && (o.parentId == null || isString(o.parentId));
 };
 exports.isFtAnalyticsEventDocument = isFtAnalyticsEventDocument;
-const isFtAnalyticsEventGenAIProfile = (o) => {
-    return isObject(o)
-        && (o.chatbotDetails == null || (0, exports.isFtAnalyticsEventGenAIProfileChatbotDetails)(o.chatbotDetails))
-        && (o.translationDetails == null || (0, exports.isFtAnalyticsEventGenAIProfileTranslationDetails)(o.translationDetails))
-        && (o.completionDetails == null || (0, exports.isFtAnalyticsEventGenAIProfileCompletionDetails)(o.completionDetails))
-        && (isString(o.name))
-        && (isString(o.id))
-        && (isString(o.type));
-};
-exports.isFtAnalyticsEventGenAIProfile = isFtAnalyticsEventGenAIProfile;
-const isFtAnalyticsEventGenAIProfileChatbotDetails = (o) => {
-    return isObject(o)
-        && (isString(o.provider))
-        && (o.model == null || isString(o.model));
-};
-exports.isFtAnalyticsEventGenAIProfileChatbotDetails = isFtAnalyticsEventGenAIProfileChatbotDetails;
-const isFtAnalyticsEventGenAIProfileCompletionDetails = (o) => {
-    return isObject(o)
-        && (isString(o.provider))
-        && (o.model == null || isString(o.model));
-};
-exports.isFtAnalyticsEventGenAIProfileCompletionDetails = isFtAnalyticsEventGenAIProfileCompletionDetails;
-const isFtAnalyticsEventGenAIProfileTranslationDetails = (o) => {
+const isFtAnalyticsEventDocumentSearchQuery = (o) => {
     return isObject(o)
-        && (isString(o.provider))
-        && (o.engine == null || isString(o.engine));
+        && (isString(o.terms));
 };
-exports.isFtAnalyticsEventGenAIProfileTranslationDetails = isFtAnalyticsEventGenAIProfileTranslationDetails;
+exports.isFtAnalyticsEventDocumentSearchQuery = isFtAnalyticsEventDocumentSearchQuery;
 const isFtAnalyticsEventLocation = (o) => {
     return isObject(o)
         && (isString(o.type))
@@ -146,7 +151,7 @@ const isFtAnalyticsEventSearchQuery = (o) => {
 exports.isFtAnalyticsEventSearchQuery = isFtAnalyticsEventSearchQuery;
 const isFtAnalyticsEventSearchResponse = (o) => {
     return isObject(o)
-        && (o.autocorrect == null || isBoolean(o.autocorrect))
+        && (isBoolean(o.autocorrect))
         && (isNumber(o.nbResults));
 };
 exports.isFtAnalyticsEventSearchResponse = isFtAnalyticsEventSearchResponse;
@@ -175,7 +180,7 @@ var FtAnalyticsPublicationType;
     FtAnalyticsPublicationType["UNSTRUCTURED_DOCUMENT"] = "UNSTRUCTURED_DOCUMENT";
     FtAnalyticsPublicationType["SHARED_PERSONAL_BOOK"] = "SHARED_PERSONAL_BOOK";
     FtAnalyticsPublicationType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
-    FtAnalyticsPublicationType["MAP_ATTACHMENT"] = "MAP_ATTACHMENT";
+    FtAnalyticsPublicationType["ATTACHMENT"] = "ATTACHMENT";
     FtAnalyticsPublicationType["RESOURCE"] = "RESOURCE";
 })(FtAnalyticsPublicationType = exports.FtAnalyticsPublicationType || (exports.FtAnalyticsPublicationType = {}));
 const isFtAnalyticsPublicationType = (o) => Object.keys(FtAnalyticsPublicationType).includes(o);
@@ -210,10 +215,36 @@ var FtAnalyticsSearchFacetType;
 })(FtAnalyticsSearchFacetType = exports.FtAnalyticsSearchFacetType || (exports.FtAnalyticsSearchFacetType = {}));
 const isFtAnalyticsSearchFacetType = (o) => Object.keys(FtAnalyticsSearchFacetType).includes(o);
 exports.isFtAnalyticsSearchFacetType = isFtAnalyticsSearchFacetType;
+const isFtAiCaseDeflectionEvent = (o) => {
+    return isObject(o)
+        && (o.generationId == null || isString(o.generationId))
+        && (o.searchQuery == null || (0, exports.isFtAnalyticsEventSearchQuery)(o.searchQuery))
+        && (isString(o.context));
+};
+exports.isFtAiCaseDeflectionEvent = isFtAiCaseDeflectionEvent;
+const isFtAiCompletedQueryEvent = (o) => {
+    return isObject(o)
+        && (isString(o.result))
+        && ((0, exports.isFtAnalyticsEventAIProfile)(o.profile))
+        && (isNumber(o.durationMs))
+        && (o.parameters == null || (isObject(o.parameters)
+            && Object.keys(o.parameters).every((k) => isString(k))
+            && Object.values(o.parameters).every((v) => isString(v))))
+        && (isString(o.queryId));
+};
+exports.isFtAiCompletedQueryEvent = isFtAiCompletedQueryEvent;
+const isFtAiRateEvent = (o) => {
+    return isObject(o)
+        && ((0, exports.isFtAnalyticsEventRating)(o.rating))
+        && (isString(o.comment))
+        && (isString(o.queryId));
+};
+exports.isFtAiRateEvent = isFtAiRateEvent;
 const isFtAnalyticsEvent = (o) => {
     return isObject(o)
         && (isBoolean(o.offline))
         && (isString(o.appVersion))
+        && (o.internal == null || isBoolean(o.internal))
         && (isString(o.appName))
         && ((0, exports.isFtAnalyticsEventName)(o.name));
 };
@@ -229,6 +260,7 @@ var FtAnalyticsEventName;
     FtAnalyticsEventName["COLLECTION__CREATE"] = "COLLECTION__CREATE";
     FtAnalyticsEventName["COLLECTION__UPDATE"] = "COLLECTION__UPDATE";
     FtAnalyticsEventName["COLLECTION__DELETE"] = "COLLECTION__DELETE";
+    FtAnalyticsEventName["CUSTOM_EVENT__TRIGGER"] = "CUSTOM_EVENT__TRIGGER";
     FtAnalyticsEventName["DOCUMENT__DISPLAY"] = "DOCUMENT__DISPLAY";
     FtAnalyticsEventName["DOCUMENT__DOWNLOAD"] = "DOCUMENT__DOWNLOAD";
     FtAnalyticsEventName["DOCUMENT__PRINT"] = "DOCUMENT__PRINT";
@@ -238,10 +270,10 @@ var FtAnalyticsEventName;
     FtAnalyticsEventName["DOCUMENT__START_DISPLAY"] = "DOCUMENT__START_DISPLAY";
     FtAnalyticsEventName["DOCUMENT__UNRATE"] = "DOCUMENT__UNRATE";
     FtAnalyticsEventName["FEEDBACK__SEND"] = "FEEDBACK__SEND";
-    FtAnalyticsEventName["GEN_AI__COMPLETED_QUERY"] = "GEN_AI__COMPLETED_QUERY";
-    FtAnalyticsEventName["GEN_AI__RATE"] = "GEN_AI__RATE";
-    FtAnalyticsEventName["GENAI_CASE_DEFLECTION__START"] = "GENAI_CASE_DEFLECTION__START";
-    FtAnalyticsEventName["GENAI_CASE_DEFLECTION__OPEN_TICKET"] = "GENAI_CASE_DEFLECTION__OPEN_TICKET";
+    FtAnalyticsEventName["AI__COMPLETED_QUERY"] = "AI__COMPLETED_QUERY";
+    FtAnalyticsEventName["AI__RATE"] = "AI__RATE";
+    FtAnalyticsEventName["AI_CASE_DEFLECTION__START"] = "AI_CASE_DEFLECTION__START";
+    FtAnalyticsEventName["AI_CASE_DEFLECTION__OPEN_TICKET"] = "AI_CASE_DEFLECTION__OPEN_TICKET";
     FtAnalyticsEventName["KHUB__PROCESS"] = "KHUB__PROCESS";
     FtAnalyticsEventName["KHUB__SEARCH"] = "KHUB__SEARCH";
     FtAnalyticsEventName["LABELS__DOWNLOAD"] = "LABELS__DOWNLOAD";
@@ -276,6 +308,13 @@ const isFtCaseDeflectionEvent = (o) => {
         && (o.topic == null || (0, exports.isFtAnalyticsEventTopic)(o.topic));
 };
 exports.isFtCaseDeflectionEvent = isFtCaseDeflectionEvent;
+const isFtCustomTriggerEvent = (o) => {
+    return isObject(o)
+        && (o.componentId == null || isString(o.componentId))
+        && (isString(o.eventName))
+        && ((0, exports.isFtAnalyticsEventPage)(o.page));
+};
+exports.isFtCustomTriggerEvent = isFtCustomTriggerEvent;
 const isFtDocumentDisplayEvent = (o) => {
     return isObject(o)
         && (o.publication == null || (0, exports.isFtAnalyticsEventPublication)(o.publication))
@@ -301,7 +340,7 @@ const isFtDocumentSearchEvent = (o) => {
         && ((0, exports.isFtAnalyticsEventSearchResponse)(o.searchResponse))
         && (o.publication == null || (0, exports.isFtAnalyticsEventPublication)(o.publication))
         && (o.document == null || (0, exports.isFtAnalyticsEventDocument)(o.document))
-        && ((0, exports.isFtAnalyticsEventSearchQuery)(o.searchQuery));
+        && ((0, exports.isFtAnalyticsEventDocumentSearchQuery)(o.searchQuery));
 };
 exports.isFtDocumentSearchEvent = isFtDocumentSearchEvent;
 const isFtDocumentStartDisplayEvent = (o) => {
@@ -320,20 +359,6 @@ const isFtFeedbackSendEvent = (o) => {
         && (isBoolean(o.loggedIn));
 };
 exports.isFtFeedbackSendEvent = isFtFeedbackSendEvent;
-const isFtGenAiCaseDeflectionEvent = (o) => {
-    return isObject(o)
-        && (o.generationId == null || isString(o.generationId))
-        && (o.searchQuery == null || (0, exports.isFtAnalyticsEventSearchQuery)(o.searchQuery))
-        && (isString(o.context));
-};
-exports.isFtGenAiCaseDeflectionEvent = isFtGenAiCaseDeflectionEvent;
-const isFtGenAiRateEvent = (o) => {
-    return isObject(o)
-        && ((0, exports.isFtAnalyticsEventRating)(o.rating))
-        && (isString(o.comment))
-        && (isString(o.queryId));
-};
-exports.isFtGenAiRateEvent = isFtGenAiRateEvent;
 const isFtKhubSearchEvent = (o) => {
     return isObject(o)
         && ((0, exports.isFtAnalyticsEventSearchResponse)(o.searchResponse))
@@ -466,28 +491,29 @@ const isFtMap = (o) => {
         && (o.prettyUrl == null || isString(o.prettyUrl))
         && ((Array.isArray(o.metadata)
             && o.metadata.every((v) => (0, exports.isFtMetadata)(v))))
-        && (o.watermark == null || (0, exports.isFtWatermark)(o.watermark))
-        && ((0, exports.isFtOpenMode)(o.openMode))
         && (o.topicsApiEndpoint == null || isString(o.topicsApiEndpoint))
         && (o.description == null || isString(o.description))
-        && (o.attachmentsApiEndpoint == null || isString(o.attachmentsApiEndpoint))
         && ((0, exports.isFtEditorialType)(o.editorialType))
         && (isString(o.baseId))
         && (isString(o.clusterId))
         && (isString(o.title))
-        && (isString(o.lastPublication))
-        && (isBoolean(o.pbkConfidential))
         && (isString(o.lastEdition))
         && (isString(o.originId))
         && (o.rightsApiEndpoint == null || isString(o.rightsApiEndpoint))
-        && ((0, exports.isFtMapStyles)(o.contentStyles))
-        && (o.originUrl == null || isString(o.originUrl))
         && (isString(o.fingerprint))
         && (isString(o.readerUrl))
-        && (o.untranslatedTitle == null || o.untranslatedTitle == null || isString(o.untranslatedTitle))
+        && (o.untranslatedTitle == null || isString(o.untranslatedTitle))
         && (o.khubVersion == null || isString(o.khubVersion))
         && (isString(o.id))
-        && (o.lang == null || isString(o.lang));
+        && (o.lang == null || isString(o.lang))
+        && (o.watermark == null || (0, exports.isFtWatermark)(o.watermark))
+        && ((0, exports.isFtOpenMode)(o.openMode))
+        && (o.attachmentsApiEndpoint == null || isString(o.attachmentsApiEndpoint))
+        && (isString(o.lastPublication))
+        && (isBoolean(o.pbkConfidential))
+        && ((0, exports.isFtMapStyles)(o.contentStyles))
+        && (o.originUrl == null || isString(o.originUrl))
+        && (isBoolean(o.translationError));
 };
 exports.isFtMap = isFtMap;
 const isFtMapStyles = (o) => {
@@ -507,7 +533,7 @@ const isFtTocNode = (o) => {
             && o.children.every((v) => (0, exports.isFtTocNode)(v))))
         && (o.origin == null || (0, exports.isFtTopicOrigin)(o.origin))
         && (isString(o.contentId))
-        && (o.untranslatedTitle == null || o.untranslatedTitle == null || isString(o.untranslatedTitle))
+        && (o.untranslatedTitle == null || isString(o.untranslatedTitle))
         && (isString(o.title));
 };
 exports.isFtTocNode = isFtTocNode;
@@ -539,18 +565,18 @@ const isFtUnstructuredDocument = (o) => {
         && (isString(o.openMode))
         && (o.description == null || isString(o.description))
         && (isString(o.mimeType))
-        && (o.baseId == null || isString(o.baseId))
+        && (isString(o.baseId))
         && (o.clusterId == null || isString(o.clusterId))
         && (isString(o.contentApiEndpoint))
         && (isString(o.title))
-        && (o.lastPublication == null || isString(o.lastPublication))
+        && (isString(o.lastPublication))
         && (isString(o.viewerUrl))
         && (isString(o.lastEdition))
         && (isString(o.filename))
         && (o.originId == null || isString(o.originId))
         && (isString(o.rightsApiEndpoint))
         && (o.originUrl == null || isString(o.originUrl))
-        && (o.khubVersion == null || isString(o.khubVersion))
+        && (isString(o.khubVersion))
         && (isString(o.id))
         && (o.lang == null || isString(o.lang));
 };
@@ -718,12 +744,13 @@ const isFtMySearchCreation = (o) => {
 exports.isFtMySearchCreation = isFtMySearchCreation;
 const isFtMySearchRequest = (o) => {
     return isObject(o)
-        && (o.periodFilter == null || o.periodFilter == null || (0, exports.isFtPeriodFilter)(o.periodFilter))
+        && (o.periodFilter == null || (0, exports.isFtPeriodFilter)(o.periodFilter))
+        && (o.sortId == null || isString(o.sortId))
         && (isString(o.query))
         && (o.scope == null || (0, exports.isFtSearchScope)(o.scope))
         && (o.filters == null || (Array.isArray(o.filters)
             && o.filters.every((v) => (0, exports.isFtLegacyLabeledMetadataFilter)(v))))
-        && ((Array.isArray(o.sort)
+        && (o.sort == null || (Array.isArray(o.sort)
             && o.sort.every((v) => (0, exports.isFtSearchSortCriterion)(v))))
         && (o.virtualField == null || (0, exports.isFtVirtualField)(o.virtualField))
         && (o.metadataFilters == null || (Array.isArray(o.metadataFilters)
@@ -999,18 +1026,19 @@ const isFtSearchPrior = (o) => {
 exports.isFtSearchPrior = isFtSearchPrior;
 const isFtSearchRequest = (o) => {
     return isObject(o)
-        && (o.periodFilter == null || o.periodFilter == null || (0, exports.isFtPeriodFilter)(o.periodFilter))
+        && (o.periodFilter == null || (0, exports.isFtPeriodFilter)(o.periodFilter))
         && (isString(o.query))
         && ((0, exports.isFtPageRequest)(o.paging))
         && (o.filters == null || (Array.isArray(o.filters)
             && o.filters.every((v) => (0, exports.isFtLegacyMetadataFilter)(v))))
-        && ((Array.isArray(o.sort)
+        && (o.sort == null || (Array.isArray(o.sort)
             && o.sort.every((v) => (0, exports.isFtSearchSortCriterion)(v))))
         && (o.virtualField == null || (0, exports.isFtVirtualField)(o.virtualField))
         && ((Array.isArray(o.metadataFilters)
             && o.metadataFilters.every((v) => (0, exports.isFtMetadataFilter)(v))))
         && ((Array.isArray(o.facets)
             && o.facets.every((v) => (0, exports.isFtSearchFacetConf)(v))))
+        && (o.sortId == null || isString(o.sortId))
         && (o.scope == null || (0, exports.isFtSearchScope)(o.scope))
         && (o.uiLocale == null || isString(o.uiLocale))
         && (o.contentLocale == null || isString(o.contentLocale))
@@ -1041,11 +1069,11 @@ const isFtSearchResultUnstructuredDocument = (o) => {
     return isObject(o)
         && ((Array.isArray(o.metadata)
             && o.metadata.every((v) => (0, exports.isFtMetadata)(v))))
-        && ((0, exports.isFtOpenMode)(o.openMode))
+        && (o.openMode == null || (0, exports.isFtOpenMode)(o.openMode))
         && (isString(o.documentUrl))
         && (isString(o.mimeType))
         && (isString(o.title))
-        && (o.lastPublicationDate == null || isString(o.lastPublicationDate))
+        && (isString(o.lastPublicationDate))
         && (isString(o.viewerUrl))
         && (isString(o.contentUrl))
         && (isString(o.filename))
@@ -1063,7 +1091,7 @@ const isFtSearchResultMap = (o) => {
         && (o.openMode == null || (0, exports.isFtOpenMode)(o.openMode))
         && ((0, exports.isFtEditorialType)(o.editorialType))
         && (isString(o.title))
-        && (o.lastPublicationDate == null || isString(o.lastPublicationDate))
+        && (isString(o.lastPublicationDate))
         && (isString(o.htmlTitle))
         && (o.originUrl == null || isString(o.originUrl))
         && (isString(o.mapUrl))
@@ -1077,7 +1105,7 @@ const isFtSearchResultTopic = (o) => {
     return isObject(o)
         && ((Array.isArray(o.metadata)
             && o.metadata.every((v) => (0, exports.isFtMetadata)(v))))
-        && ((0, exports.isFtOpenMode)(o.openMode))
+        && (o.openMode == null || (0, exports.isFtOpenMode)(o.openMode))
         && (isString(o.contentId))
         && ((Array.isArray(o.resources)
             && o.resources.every((v) => (0, exports.isFtTopicResource)(v))))
@@ -1172,9 +1200,19 @@ const isFtTopicResource = (o) => {
         && (isString(o.viewerUrl));
 };
 exports.isFtTopicResource = isFtTopicResource;
+// From: LocalizableLabelType
+var FtLocalizableLabelType;
+(function (FtLocalizableLabelType) {
+    FtLocalizableLabelType["PLAIN_TEXT"] = "PLAIN_TEXT";
+    FtLocalizableLabelType["LOCALIZED_OFFICIAL"] = "LOCALIZED_OFFICIAL";
+    FtLocalizableLabelType["LOCALIZED_CUSTOM"] = "LOCALIZED_CUSTOM";
+})(FtLocalizableLabelType = exports.FtLocalizableLabelType || (exports.FtLocalizableLabelType = {}));
+const isFtLocalizableLabelType = (o) => Object.keys(FtLocalizableLabelType).includes(o);
+exports.isFtLocalizableLabelType = isFtLocalizableLabelType;
 const isFtSuggestRequest = (o) => {
     return isObject(o)
         && (isString(o.input))
+        && (o.sortId == null || isString(o.sortId))
         && (o.scope == null || (0, exports.isFtSearchScope)(o.scope))
         && ((Array.isArray(o.sort)
             && o.sort.every((v) => (0, exports.isFtSearchSortCriterion)(v))))
@@ -1226,6 +1264,16 @@ var FtUserRole;
 })(FtUserRole = exports.FtUserRole || (exports.FtUserRole = {}));
 const isFtUserRole = (o) => Object.keys(FtUserRole).includes(o);
 exports.isFtUserRole = isFtUserRole;
+// From: UserAssetType
+var FtUserAssetType;
+(function (FtUserAssetType) {
+    FtUserAssetType["SEARCHES"] = "SEARCHES";
+    FtUserAssetType["BOOKMARKS"] = "BOOKMARKS";
+    FtUserAssetType["BOOKS"] = "BOOKS";
+    FtUserAssetType["COLLECTIONS"] = "COLLECTIONS";
+})(FtUserAssetType = exports.FtUserAssetType || (exports.FtUserAssetType = {}));
+const isFtUserAssetType = (o) => Object.keys(FtUserAssetType).includes(o);
+exports.isFtUserAssetType = isFtUserAssetType;
 const isFtAuthenticationIdentifier = (o) => {
     return isObject(o)
         && (isString(o.identifier))
@@ -1268,6 +1316,12 @@ const isFtUserProfile = (o) => {
             && o.tags.every((v) => isString(v))));
 };
 exports.isFtUserProfile = isFtUserProfile;
+const isFtUserAssetCount = (o) => {
+    return isObject(o)
+        && (isNumber(o.count))
+        && ((0, exports.isFtUserAssetType)(o.userAssetType));
+};
+exports.isFtUserAssetCount = isFtUserAssetCount;
 const isFtWatermark = (o) => {
     return isObject(o)
         && (isString(o.color))
@@ -1276,3 +1330,25 @@ const isFtWatermark = (o) => {
         && (isNumber(o.opacity));
 };
 exports.isFtWatermark = isFtWatermark;
+const isFtLocalizableLabel = (o) => {
+    return isObject(o)
+        && (isString(o.context))
+        && (isString(o.text))
+        && ((0, exports.isFtLocalizableLabelType)(o.type))
+        && (isString(o.key));
+};
+exports.isFtLocalizableLabel = isFtLocalizableLabel;
+const isFtSearchConfiguration = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.sortOptions)
+            && o.sortOptions.every((v) => (0, exports.isFtSearchSortOption)(v))));
+};
+exports.isFtSearchConfiguration = isFtSearchConfiguration;
+const isFtSearchSortOption = (o) => {
+    return isObject(o)
+        && (isString(o.id))
+        && ((0, exports.isFtLocalizableLabel)(o.label))
+        && ((Array.isArray(o.sortCriteria)
+            && o.sortCriteria.every((v) => (0, exports.isFtSearchSortCriterion)(v))));
+};
+exports.isFtSearchSortOption = isFtSearchSortOption;

package/dist/cjs/types/ft-server/public.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+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;
 const isObject = (o) => typeof o === "object" && o != null;
 const isBoolean = (o) => typeof o === "boolean";
 const isNumber = (o) => typeof o === "number";
@@ -75,6 +75,92 @@ const isFtRagInput = (o) => {
             && o.filters.every((v) => (0, exports.isFtSemanticSearchFilter)(v))));
 };
 exports.isFtRagInput = isFtRagInput;
+const isFtGenAIGenerationFetchTracesRequest = (o) => {
+    return isObject(o)
+        && (o.endDate == null || isString(o.endDate))
+        && (o.nbResults == null || isNumber(o.nbResults))
+        && (o.userId == null || isString(o.userId))
+        && (o.startDate == null || isString(o.startDate));
+};
+exports.isFtGenAIGenerationFetchTracesRequest = isFtGenAIGenerationFetchTracesRequest;
+const isFtGenAIFetchGenerationTracesResult = (o) => {
+    return isObject(o)
+        && (o.endDate == null || isString(o.endDate))
+        && (isNumber(o.nbResults))
+        && ((Array.isArray(o.results)
+            && o.results.every((v) => (0, exports.isFtGenAIGenerationTrace)(v))))
+        && (o.startDate == null || isString(o.startDate));
+};
+exports.isFtGenAIFetchGenerationTracesResult = isFtGenAIFetchGenerationTracesResult;
+const isFtGenAIGenerationTrace = (o) => {
+    return isObject(o)
+        && ((0, exports.isFtGenAIGenerationTraceOutput)(o.output))
+        && ((0, exports.isFtGenAIGenerationTraceInput)(o.input))
+        && (o.profileId == null || isString(o.profileId))
+        && (isString(o.id))
+        && (o.sessionId == null || isString(o.sessionId))
+        && (o.userId == null || isString(o.userId))
+        && (isString(o.timestamp));
+};
+exports.isFtGenAIGenerationTrace = isFtGenAIGenerationTrace;
+const isFtGenAIGenerationTraceInput = (o) => {
+    return isObject(o)
+        && (isString(o.query));
+};
+exports.isFtGenAIGenerationTraceInput = isFtGenAIGenerationTraceInput;
+const isFtGenAIGenerationTraceOutput = (o) => {
+    return isObject(o)
+        && (isString(o.response));
+};
+exports.isFtGenAIGenerationTraceOutput = isFtGenAIGenerationTraceOutput;
+const isFtGenAIRagFetchTracesRequest = (o) => {
+    return isObject(o)
+        && (o.endDate == null || isString(o.endDate))
+        && (o.nbResults == null || isNumber(o.nbResults))
+        && (o.userId == null || isString(o.userId))
+        && (o.startDate == null || isString(o.startDate));
+};
+exports.isFtGenAIRagFetchTracesRequest = isFtGenAIRagFetchTracesRequest;
+const isFtGenAIFetchRagTracesResult = (o) => {
+    return isObject(o)
+        && (o.endDate == null || isString(o.endDate))
+        && (isNumber(o.nbResults))
+        && ((Array.isArray(o.results)
+            && o.results.every((v) => (0, exports.isFtGenAIRagTrace)(v))))
+        && (o.startDate == null || isString(o.startDate));
+};
+exports.isFtGenAIFetchRagTracesResult = isFtGenAIFetchRagTracesResult;
+const isFtGenAIRagTrace = (o) => {
+    return isObject(o)
+        && ((0, exports.isFtGenAIRagTraceOutput)(o.output))
+        && ((0, exports.isFtGenAIRagTraceInput)(o.input))
+        && (o.conversationId == null || isString(o.conversationId))
+        && (o.profileId == null || isString(o.profileId))
+        && (isString(o.id))
+        && (o.sessionId == null || isString(o.sessionId))
+        && (o.userId == null || isString(o.userId))
+        && (isString(o.timestamp));
+};
+exports.isFtGenAIRagTrace = isFtGenAIRagTrace;
+const isFtGenAIRagTraceHistoryItem = (o) => {
+    return isObject(o)
+        && (isString(o.role))
+        && (isString(o.content));
+};
+exports.isFtGenAIRagTraceHistoryItem = isFtGenAIRagTraceHistoryItem;
+const isFtGenAIRagTraceInput = (o) => {
+    return isObject(o)
+        && (isString(o.userInstructions))
+        && (isString(o.query))
+        && ((Array.isArray(o.history)
+            && o.history.every((v) => (0, exports.isFtGenAIRagTraceHistoryItem)(v))));
+};
+exports.isFtGenAIRagTraceInput = isFtGenAIRagTraceInput;
+const isFtGenAIRagTraceOutput = (o) => {
+    return isObject(o)
+        && (isString(o.response));
+};
+exports.isFtGenAIRagTraceOutput = isFtGenAIRagTraceOutput;
 var TranslationFormat;
 (function (TranslationFormat) {
     TranslationFormat["TEXT"] = "TEXT";