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

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

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFtMapResource = exports.isFtTopicsRatingSummary = exports.isFtTopicRating = exports.isFtRatingSummary = exports.isFtRatingCreation = exports.isFtPublicationRatingSummary = exports.isFtPublicationRating = exports.isFtRatingType = exports.FtRatingType = exports.isFtMySearchRequest = 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.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.isFtTopicOriginType = exports.FtTopicOriginType = exports.isFtMyLibraryColors = exports.FtMyLibraryColors = exports.isFtHttpErrorDetails = void 0;
-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 = exports.isFtSearchPreferencesConfiguration = exports.isFtMetadataPreferenceConfiguration = void 0;
-exports.isFtWatermark = exports.isFtUserProfile = exports.isFtSession = exports.isFtSearchPreferences = exports.isFtAuthenticatedSession = exports.isFtAuthenticationIdentifier = exports.isFtUserRole = exports.FtUserRole = exports.isFtSuggestResults = exports.isFtSuggestResult = void 0;
+exports.isFtSearchLocale = exports.isFtDefaultLocales = exports.isFtDefaultLocale = exports.isFtMetadataHomeLayout = exports.FtMetadataHomeLayout = exports.isFtFeedbackCreation = exports.isFtExternalWebComponentContext = exports.FtExternalWebComponentContext = 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.isFtSearchPageSelectEvent = exports.isFtKhubSearchEvent = exports.isFtGenAiCaseDeflectionEvent = exports.isFtDocumentDownloadEvent = 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.isFtAnalyticsEventLocation = exports.isFtTopicOriginType = exports.FtTopicOriginType = exports.isFtMyLibraryColors = exports.FtMyLibraryColors = exports.isFtHttpErrorDetails = void 0;
+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 = exports.isFtTopicsRatingSummary = exports.isFtTopicRating = exports.isFtRatingSummary = exports.isFtRatingCreation = exports.isFtPublicationRatingSummary = exports.isFtPublicationRating = exports.isFtRatingType = exports.FtRatingType = exports.isFtPrivacyPolicyConfiguration = exports.isFtMySearchRequest = exports.isFtMySearch = exports.isFtMetadataDescriptor = exports.isFtMetadataConfiguration = exports.isFtMetadataSortRule = exports.FtMetadataSortRule = exports.isFtMetadata = exports.isFtFacetType = exports.FtFacetType = exports.isFtUiLocale = exports.isFtMessageContext = exports.isFtLocalesConfiguration = exports.isFtSearchLocales = void 0;
+exports.isFtWatermark = exports.isFtUserProfile = exports.isFtSession = exports.isFtSearchPreferences = exports.isFtAuthenticatedSession = exports.isFtAuthenticationIdentifier = exports.isFtUserRole = exports.FtUserRole = 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 = void 0;
 const isObject = (o) => typeof o === "object" && o != null;
 const isBoolean = (o) => typeof o === "boolean";
 const isNumber = (o) => typeof o === "number";
@@ -27,9 +27,7 @@ var FtMyLibraryColors;
     FtMyLibraryColors["orange"] = "orange";
     FtMyLibraryColors["yellow"] = "yellow";
 })(FtMyLibraryColors = exports.FtMyLibraryColors || (exports.FtMyLibraryColors = {}));
-const isFtMyLibraryColors = (o) => {
-    return ["black", "green", "blue", "purple", "red", "orange", "yellow"].includes(o);
-};
+const isFtMyLibraryColors = (o) => Object.keys(FtMyLibraryColors).includes(o);
 exports.isFtMyLibraryColors = isFtMyLibraryColors;
 // From: SourceType
 var FtTopicOriginType;
@@ -38,10 +36,197 @@ var FtTopicOriginType;
     FtTopicOriginType["PERSONAL"] = "PERSONAL";
     FtTopicOriginType["SHARED"] = "SHARED";
 })(FtTopicOriginType = exports.FtTopicOriginType || (exports.FtTopicOriginType = {}));
-const isFtTopicOriginType = (o) => {
-    return ["OFFICIAL", "PERSONAL", "SHARED"].includes(o);
-};
+const isFtTopicOriginType = (o) => Object.keys(FtTopicOriginType).includes(o);
 exports.isFtTopicOriginType = isFtTopicOriginType;
+const isFtAnalyticsEventLocation = (o) => {
+    return isObject(o)
+        && (isString(o.type))
+        && (isString(o.value));
+};
+exports.isFtAnalyticsEventLocation = isFtAnalyticsEventLocation;
+const isFtAnalyticsEventPublication = (o) => {
+    return isObject(o)
+        && (o.metadata == null || (Array.isArray(o.metadata)
+            && o.metadata.every((v) => (0, exports.isFtMetadata)(v))))
+        && (isString(o.id))
+        && (o.mimeType == null || isString(o.mimeType))
+        && (o.title == null || isString(o.title))
+        && (o.type == null || (0, exports.isFtAnalyticsPublicationType)(o.type))
+        && (o.parentId == null || isString(o.parentId));
+};
+exports.isFtAnalyticsEventPublication = isFtAnalyticsEventPublication;
+const isFtAnalyticsEventRating = (o) => {
+    return isObject(o)
+        && (isString(o.type))
+        && (o.value == null || isString(o.value));
+};
+exports.isFtAnalyticsEventRating = isFtAnalyticsEventRating;
+const isFtAnalyticsEventSearchQuery = (o) => {
+    return isObject(o)
+        && (isString(o.terms))
+        && (o.searchType == null || isString(o.searchType))
+        && (o.lastUpdate == null || isString(o.lastUpdate))
+        && (o.facets == null || (Array.isArray(o.facets)
+            && o.facets.every((v) => (0, exports.isFtAnalyticsSearchFacet)(v))));
+};
+exports.isFtAnalyticsEventSearchQuery = isFtAnalyticsEventSearchQuery;
+const isFtAnalyticsEventSearchResponse = (o) => {
+    return isObject(o)
+        && (o.autocorrect == null || isBoolean(o.autocorrect))
+        && (isNumber(o.nbResults));
+};
+exports.isFtAnalyticsEventSearchResponse = isFtAnalyticsEventSearchResponse;
+const isFtAnalyticsEventSearchResult = (o) => {
+    return isObject(o)
+        && ((0, exports.isFtAnalyticsEventPublication)(o.document))
+        && (isNumber(o.rank))
+        && (o.topic == null || (0, exports.isFtAnalyticsEventTopic)(o.topic))
+        && (isString(o.type));
+};
+exports.isFtAnalyticsEventSearchResult = isFtAnalyticsEventSearchResult;
+const isFtAnalyticsEventTopic = (o) => {
+    return isObject(o)
+        && (o.mapTitle == null || isString(o.mapTitle))
+        && (o.metadata == null || (Array.isArray(o.metadata)
+            && o.metadata.every((v) => (0, exports.isFtMetadata)(v))))
+        && (isString(o.tocId))
+        && (o.mapId == null || isString(o.mapId))
+        && (isString(o.title));
+};
+exports.isFtAnalyticsEventTopic = isFtAnalyticsEventTopic;
+// From: AnalyticsPublicationType
+var FtAnalyticsPublicationType;
+(function (FtAnalyticsPublicationType) {
+    FtAnalyticsPublicationType["STRUCTURED_DOCUMENT"] = "STRUCTURED_DOCUMENT";
+    FtAnalyticsPublicationType["UNSTRUCTURED_DOCUMENT"] = "UNSTRUCTURED_DOCUMENT";
+    FtAnalyticsPublicationType["SHARED_PERSONAL_BOOK"] = "SHARED_PERSONAL_BOOK";
+    FtAnalyticsPublicationType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
+    FtAnalyticsPublicationType["MAP_ATTACHMENT"] = "MAP_ATTACHMENT";
+    FtAnalyticsPublicationType["RESOURCE"] = "RESOURCE";
+})(FtAnalyticsPublicationType = exports.FtAnalyticsPublicationType || (exports.FtAnalyticsPublicationType = {}));
+const isFtAnalyticsPublicationType = (o) => Object.keys(FtAnalyticsPublicationType).includes(o);
+exports.isFtAnalyticsPublicationType = isFtAnalyticsPublicationType;
+const isFtAnalyticsSearchFacet = (o) => {
+    return isObject(o)
+        && (o.dateValue == null || (0, exports.isFtAnalyticsSearchDateFacetValue)(o.dateValue))
+        && (o.values == null || (Array.isArray(o.values)
+            && o.values.every((v) => isString(v))))
+        && (o.from == null || isString(o.from))
+        && (o.to == null || isString(o.to))
+        && (o.type == null || (0, exports.isFtAnalyticsSearchFacetType)(o.type))
+        && (isString(o.key));
+};
+exports.isFtAnalyticsSearchFacet = isFtAnalyticsSearchFacet;
+// From: AnalyticsSearchDateFacetValue
+var FtAnalyticsSearchDateFacetValue;
+(function (FtAnalyticsSearchDateFacetValue) {
+    FtAnalyticsSearchDateFacetValue["LAST_WEEK"] = "LAST_WEEK";
+    FtAnalyticsSearchDateFacetValue["LAST_MONTH"] = "LAST_MONTH";
+    FtAnalyticsSearchDateFacetValue["LAST_QUARTER"] = "LAST_QUARTER";
+    FtAnalyticsSearchDateFacetValue["LAST_YEAR"] = "LAST_YEAR";
+})(FtAnalyticsSearchDateFacetValue = exports.FtAnalyticsSearchDateFacetValue || (exports.FtAnalyticsSearchDateFacetValue = {}));
+const isFtAnalyticsSearchDateFacetValue = (o) => Object.keys(FtAnalyticsSearchDateFacetValue).includes(o);
+exports.isFtAnalyticsSearchDateFacetValue = isFtAnalyticsSearchDateFacetValue;
+// From: AnalyticsSearchFacetType
+var FtAnalyticsSearchFacetType;
+(function (FtAnalyticsSearchFacetType) {
+    FtAnalyticsSearchFacetType["VALUE"] = "VALUE";
+    FtAnalyticsSearchFacetType["DATE"] = "DATE";
+    FtAnalyticsSearchFacetType["RANGE"] = "RANGE";
+})(FtAnalyticsSearchFacetType = exports.FtAnalyticsSearchFacetType || (exports.FtAnalyticsSearchFacetType = {}));
+const isFtAnalyticsSearchFacetType = (o) => Object.keys(FtAnalyticsSearchFacetType).includes(o);
+exports.isFtAnalyticsSearchFacetType = isFtAnalyticsSearchFacetType;
+const isFtAnalyticsEvent = (o) => {
+    return isObject(o)
+        && (isBoolean(o.offline))
+        && (isString(o.appVersion))
+        && (isString(o.appName))
+        && ((0, exports.isFtAnalyticsEventName)(o.name));
+};
+exports.isFtAnalyticsEvent = isFtAnalyticsEvent;
+// From: WsAnalyticsEventName
+var FtAnalyticsEventName;
+(function (FtAnalyticsEventName) {
+    FtAnalyticsEventName["BOOKMARK__CREATE"] = "BOOKMARK__CREATE";
+    FtAnalyticsEventName["BOOKMARK__DELETE"] = "BOOKMARK__DELETE";
+    FtAnalyticsEventName["CASE_DEFLECTION__START"] = "CASE_DEFLECTION__START";
+    FtAnalyticsEventName["CASE_DEFLECTION__OPEN_TICKET"] = "CASE_DEFLECTION__OPEN_TICKET";
+    FtAnalyticsEventName["CASE_DEFLECTION__RATE"] = "CASE_DEFLECTION__RATE";
+    FtAnalyticsEventName["COLLECTION__CREATE"] = "COLLECTION__CREATE";
+    FtAnalyticsEventName["COLLECTION__UPDATE"] = "COLLECTION__UPDATE";
+    FtAnalyticsEventName["COLLECTION__DELETE"] = "COLLECTION__DELETE";
+    FtAnalyticsEventName["DOCUMENT__DISPLAY"] = "DOCUMENT__DISPLAY";
+    FtAnalyticsEventName["DOCUMENT__DOWNLOAD"] = "DOCUMENT__DOWNLOAD";
+    FtAnalyticsEventName["DOCUMENT__PRINT"] = "DOCUMENT__PRINT";
+    FtAnalyticsEventName["DOCUMENT__PROCESS"] = "DOCUMENT__PROCESS";
+    FtAnalyticsEventName["DOCUMENT__RATE"] = "DOCUMENT__RATE";
+    FtAnalyticsEventName["DOCUMENT__SEARCH"] = "DOCUMENT__SEARCH";
+    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["KHUB__PROCESS"] = "KHUB__PROCESS";
+    FtAnalyticsEventName["KHUB__SEARCH"] = "KHUB__SEARCH";
+    FtAnalyticsEventName["LABELS__DOWNLOAD"] = "LABELS__DOWNLOAD";
+    FtAnalyticsEventName["LINK__SHARE"] = "LINK__SHARE";
+    FtAnalyticsEventName["PAGE__DISPLAY"] = "PAGE__DISPLAY";
+    FtAnalyticsEventName["PERSONAL_BOOK__CREATE"] = "PERSONAL_BOOK__CREATE";
+    FtAnalyticsEventName["PERSONAL_BOOK__DELETE"] = "PERSONAL_BOOK__DELETE";
+    FtAnalyticsEventName["PERSONAL_BOOK__UPDATE"] = "PERSONAL_BOOK__UPDATE";
+    FtAnalyticsEventName["PERSONAL_TOPIC__CREATE"] = "PERSONAL_TOPIC__CREATE";
+    FtAnalyticsEventName["PERSONAL_TOPIC__UPDATE"] = "PERSONAL_TOPIC__UPDATE";
+    FtAnalyticsEventName["PERSONAL_TOPIC__DELETE"] = "PERSONAL_TOPIC__DELETE";
+    FtAnalyticsEventName["SAVED_SEARCH__CREATE"] = "SAVED_SEARCH__CREATE";
+    FtAnalyticsEventName["SAVED_SEARCH__DELETE"] = "SAVED_SEARCH__DELETE";
+    FtAnalyticsEventName["SAVED_SEARCH__UPDATE"] = "SAVED_SEARCH__UPDATE";
+    FtAnalyticsEventName["SEARCH_PAGE__SELECT"] = "SEARCH_PAGE__SELECT";
+    FtAnalyticsEventName["TOPIC__DISPLAY"] = "TOPIC__DISPLAY";
+    FtAnalyticsEventName["TOPIC__RATE"] = "TOPIC__RATE";
+    FtAnalyticsEventName["TOPIC__START_DISPLAY"] = "TOPIC__START_DISPLAY";
+    FtAnalyticsEventName["TOPIC__UNRATE"] = "TOPIC__UNRATE";
+    FtAnalyticsEventName["USER__LOGIN"] = "USER__LOGIN";
+    FtAnalyticsEventName["USER__LOGOUT"] = "USER__LOGOUT";
+    FtAnalyticsEventName["HEARTBEAT"] = "HEARTBEAT";
+})(FtAnalyticsEventName = exports.FtAnalyticsEventName || (exports.FtAnalyticsEventName = {}));
+const isFtAnalyticsEventName = (o) => Object.keys(FtAnalyticsEventName).includes(o);
+exports.isFtAnalyticsEventName = isFtAnalyticsEventName;
+const isFtCaseDeflectionEvent = (o) => {
+    return isObject(o)
+        && (o.searchQuery == null || (0, exports.isFtAnalyticsEventSearchQuery)(o.searchQuery))
+        && (isString(o.context))
+        && (o.rating == null || (0, exports.isFtAnalyticsEventRating)(o.rating))
+        && (o.topic == null || (0, exports.isFtAnalyticsEventTopic)(o.topic));
+};
+exports.isFtCaseDeflectionEvent = isFtCaseDeflectionEvent;
+const isFtDocumentDownloadEvent = (o) => {
+    return isObject(o)
+        && ((0, exports.isFtAnalyticsEventPublication)(o.document))
+        && ((0, exports.isFtAnalyticsEventLocation)(o.location));
+};
+exports.isFtDocumentDownloadEvent = isFtDocumentDownloadEvent;
+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 isFtKhubSearchEvent = (o) => {
+    return isObject(o)
+        && ((0, exports.isFtAnalyticsEventSearchResponse)(o.searchResponse))
+        && ((0, exports.isFtAnalyticsEventSearchQuery)(o.searchQuery));
+};
+exports.isFtKhubSearchEvent = isFtKhubSearchEvent;
+const isFtSearchPageSelectEvent = (o) => {
+    return isObject(o)
+        && ((0, exports.isFtAnalyticsEventSearchResult)(o.searchResult))
+        && (o.externalLink == null || isString(o.externalLink))
+        && ((0, exports.isFtAnalyticsEventSearchQuery)(o.searchQuery));
+};
+exports.isFtSearchPageSelectEvent = isFtSearchPageSelectEvent;
 const isFtCredentials = (o) => {
     return isObject(o)
         && (isString(o.password))
@@ -117,7 +302,6 @@ const isFtMap = (o) => {
             && o.metadata.every((v) => (0, exports.isFtMetadata)(v))))
         && (o.watermark == null || (0, exports.isFtWatermark)(o.watermark))
         && ((0, exports.isFtOpenMode)(o.openMode))
-        && (o.translatedTitle == null || o.translatedTitle == null || isString(o.translatedTitle))
         && (o.topicsApiEndpoint == null || isString(o.topicsApiEndpoint))
         && (o.description == null || isString(o.description))
         && (o.attachmentsApiEndpoint == null || isString(o.attachmentsApiEndpoint))
@@ -154,7 +338,6 @@ const isFtTocNode = (o) => {
         && (isString(o.tocId))
         && ((Array.isArray(o.children)
             && o.children.every((v) => (0, exports.isFtTocNode)(v))))
-        && (o.translatedTitle == null || o.translatedTitle == null || isString(o.translatedTitle))
         && (o.origin == null || (0, exports.isFtTopicOrigin)(o.origin))
         && (isString(o.contentId))
         && (isString(o.title));
@@ -213,9 +396,7 @@ var FtTopicContentTarget;
     FtTopicContentTarget["PAGES"] = "PAGES";
     FtTopicContentTarget["DESIGNED_READER"] = "DESIGNED_READER";
 })(FtTopicContentTarget = exports.FtTopicContentTarget || (exports.FtTopicContentTarget = {}));
-const isFtTopicContentTarget = (o) => {
-    return ["THIRD_PARTY", "OFF_THE_GRID", "CONTENT_PACKAGER", "PAGES", "DESIGNED_READER"].includes(o);
-};
+const isFtTopicContentTarget = (o) => Object.keys(FtTopicContentTarget).includes(o);
 exports.isFtTopicContentTarget = isFtTopicContentTarget;
 // From: ExternalWebComponentContext
 var FtExternalWebComponentContext;
@@ -228,9 +409,7 @@ var FtExternalWebComponentContext;
     FtExternalWebComponentContext["SEARCH"] = "SEARCH";
     FtExternalWebComponentContext["SEARCH_RESULT"] = "SEARCH_RESULT";
 })(FtExternalWebComponentContext = exports.FtExternalWebComponentContext || (exports.FtExternalWebComponentContext = {}));
-const isFtExternalWebComponentContext = (o) => {
-    return ["HOMEPAGE", "CUSTOM", "HEADER", "READER", "TOPIC_TEMPLATE", "SEARCH", "SEARCH_RESULT"].includes(o);
-};
+const isFtExternalWebComponentContext = (o) => Object.keys(FtExternalWebComponentContext).includes(o);
 exports.isFtExternalWebComponentContext = isFtExternalWebComponentContext;
 const isFtFeedbackCreation = (o) => {
     return isObject(o)
@@ -245,9 +424,7 @@ var FtMetadataHomeLayout;
     FtMetadataHomeLayout["CUSTOM"] = "CUSTOM";
     FtMetadataHomeLayout["DESIGNER"] = "DESIGNER";
 })(FtMetadataHomeLayout = exports.FtMetadataHomeLayout || (exports.FtMetadataHomeLayout = {}));
-const isFtMetadataHomeLayout = (o) => {
-    return ["CLASSIC", "CUSTOM", "DESIGNER"].includes(o);
-};
+const isFtMetadataHomeLayout = (o) => Object.keys(FtMetadataHomeLayout).includes(o);
 exports.isFtMetadataHomeLayout = isFtMetadataHomeLayout;
 const isFtDefaultLocale = (o) => {
     return isObject(o)
@@ -307,9 +484,7 @@ var FtFacetType;
     FtFacetType["OR"] = "OR";
     FtFacetType["MONOVALUED"] = "MONOVALUED";
 })(FtFacetType = exports.FtFacetType || (exports.FtFacetType = {}));
-const isFtFacetType = (o) => {
-    return ["AND", "OR", "MONOVALUED"].includes(o);
-};
+const isFtFacetType = (o) => Object.keys(FtFacetType).includes(o);
 exports.isFtFacetType = isFtFacetType;
 const isFtMetadata = (o) => {
     return isObject(o)
@@ -329,9 +504,7 @@ var FtMetadataSortRule;
     FtMetadataSortRule["ALPHABET"] = "ALPHABET";
     FtMetadataSortRule["VERSION"] = "VERSION";
 })(FtMetadataSortRule = exports.FtMetadataSortRule || (exports.FtMetadataSortRule = {}));
-const isFtMetadataSortRule = (o) => {
-    return ["NONE", "ALPHABET", "VERSION"].includes(o);
-};
+const isFtMetadataSortRule = (o) => Object.keys(FtMetadataSortRule).includes(o);
 exports.isFtMetadataSortRule = isFtMetadataSortRule;
 const isFtMetadataConfiguration = (o) => {
     return isObject(o)
@@ -375,6 +548,13 @@ const isFtMySearchRequest = (o) => {
         && (o.contentLocale == null || isString(o.contentLocale));
 };
 exports.isFtMySearchRequest = isFtMySearchRequest;
+const isFtPrivacyPolicyConfiguration = (o) => {
+    return isObject(o)
+        && (isString(o.policyDescription))
+        && (isBoolean(o.agreementRequired))
+        && (isString(o.userAgreementMessage));
+};
+exports.isFtPrivacyPolicyConfiguration = isFtPrivacyPolicyConfiguration;
 // From: RatingType
 var FtRatingType;
 (function (FtRatingType) {
@@ -383,9 +563,7 @@ var FtRatingType;
     FtRatingType["DICHOTOMOUS"] = "DICHOTOMOUS";
     FtRatingType["NO_RATING"] = "NO_RATING";
 })(FtRatingType = exports.FtRatingType || (exports.FtRatingType = {}));
-const isFtRatingType = (o) => {
-    return ["STARS", "LIKE", "DICHOTOMOUS", "NO_RATING"].includes(o);
-};
+const isFtRatingType = (o) => Object.keys(FtRatingType).includes(o);
 exports.isFtRatingType = isFtRatingType;
 const isFtPublicationRating = (o) => {
     return isObject(o)
@@ -459,9 +637,7 @@ var FtPeriodFilterType;
     FtPeriodFilterType["LAST_YEAR"] = "LAST_YEAR";
     FtPeriodFilterType["CUSTOM"] = "CUSTOM";
 })(FtPeriodFilterType = exports.FtPeriodFilterType || (exports.FtPeriodFilterType = {}));
-const isFtPeriodFilterType = (o) => {
-    return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR", "CUSTOM"].includes(o);
-};
+const isFtPeriodFilterType = (o) => Object.keys(FtPeriodFilterType).includes(o);
 exports.isFtPeriodFilterType = isFtPeriodFilterType;
 const isFtSearchPreset = (o) => {
     return isObject(o)
@@ -478,9 +654,7 @@ var FtSearchSortCriterionOrder;
     FtSearchSortCriterionOrder["ASC"] = "ASC";
     FtSearchSortCriterionOrder["DESC"] = "DESC";
 })(FtSearchSortCriterionOrder = exports.FtSearchSortCriterionOrder || (exports.FtSearchSortCriterionOrder = {}));
-const isFtSearchSortCriterionOrder = (o) => {
-    return ["ASC", "DESC"].includes(o);
-};
+const isFtSearchSortCriterionOrder = (o) => Object.keys(FtSearchSortCriterionOrder).includes(o);
 exports.isFtSearchSortCriterionOrder = isFtSearchSortCriterionOrder;
 // From: SearchSortCriterionType
 var FtSearchSortCriterionType;
@@ -488,9 +662,7 @@ var FtSearchSortCriterionType;
     FtSearchSortCriterionType["ALPHA"] = "ALPHA";
     FtSearchSortCriterionType["NATURAL"] = "NATURAL";
 })(FtSearchSortCriterionType = exports.FtSearchSortCriterionType || (exports.FtSearchSortCriterionType = {}));
-const isFtSearchSortCriterionType = (o) => {
-    return ["ALPHA", "NATURAL"].includes(o);
-};
+const isFtSearchSortCriterionType = (o) => Object.keys(FtSearchSortCriterionType).includes(o);
 exports.isFtSearchSortCriterionType = isFtSearchSortCriterionType;
 // From: VirtualField
 var FtVirtualField;
@@ -499,9 +671,7 @@ var FtVirtualField;
     FtVirtualField["TITLE_ONLY"] = "TITLE_ONLY";
     FtVirtualField["NONE"] = "NONE";
 })(FtVirtualField = exports.FtVirtualField || (exports.FtVirtualField = {}));
-const isFtVirtualField = (o) => {
-    return ["EVERYWHERE", "TITLE_ONLY", "NONE"].includes(o);
-};
+const isFtVirtualField = (o) => Object.keys(FtVirtualField).includes(o);
 exports.isFtVirtualField = isFtVirtualField;
 const isFtSearchResultsPageInfo = (o) => {
     return isObject(o)
@@ -518,9 +688,7 @@ var FtEditorialType;
     FtEditorialType["BOOK"] = "BOOK";
     FtEditorialType["SHARED_BOOK"] = "SHARED_BOOK";
 })(FtEditorialType = exports.FtEditorialType || (exports.FtEditorialType = {}));
-const isFtEditorialType = (o) => {
-    return ["ARTICLE", "BOOK", "SHARED_BOOK"].includes(o);
-};
+const isFtEditorialType = (o) => Object.keys(FtEditorialType).includes(o);
 exports.isFtEditorialType = isFtEditorialType;
 // From: WsOpenMode
 var FtOpenMode;
@@ -528,9 +696,7 @@ var FtOpenMode;
     FtOpenMode["FLUIDTOPICS"] = "FLUIDTOPICS";
     FtOpenMode["EXTERNAL"] = "EXTERNAL";
 })(FtOpenMode = exports.FtOpenMode || (exports.FtOpenMode = {}));
-const isFtOpenMode = (o) => {
-    return ["FLUIDTOPICS", "EXTERNAL"].includes(o);
-};
+const isFtOpenMode = (o) => Object.keys(FtOpenMode).includes(o);
 exports.isFtOpenMode = isFtOpenMode;
 const isFtPageRequest = (o) => {
     return isObject(o)
@@ -552,9 +718,7 @@ var FtCollectionDocumentType;
     FtCollectionDocumentType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
     FtCollectionDocumentType["SHARED_BOOK"] = "SHARED_BOOK";
 })(FtCollectionDocumentType = exports.FtCollectionDocumentType || (exports.FtCollectionDocumentType = {}));
-const isFtCollectionDocumentType = (o) => {
-    return ["MAP", "DOCUMENT", "TOPIC", "PERSONAL_BOOK", "SHARED_BOOK"].includes(o);
-};
+const isFtCollectionDocumentType = (o) => Object.keys(FtCollectionDocumentType).includes(o);
 exports.isFtCollectionDocumentType = isFtCollectionDocumentType;
 const isFtDateFilter = (o) => {
     return isObject(o)
@@ -569,9 +733,7 @@ var FtDateFilterType;
     FtDateFilterType["LAST_QUARTER"] = "LAST_QUARTER";
     FtDateFilterType["LAST_YEAR"] = "LAST_YEAR";
 })(FtDateFilterType = exports.FtDateFilterType || (exports.FtDateFilterType = {}));
-const isFtDateFilterType = (o) => {
-    return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR"].includes(o);
-};
+const isFtDateFilterType = (o) => Object.keys(FtDateFilterType).includes(o);
 exports.isFtDateFilterType = isFtDateFilterType;
 const isFtSearchResults = (o) => {
     return isObject(o)
@@ -749,9 +911,7 @@ var FtSearchResultType;
     FtSearchResultType["DOCUMENT"] = "DOCUMENT";
     FtSearchResultType["TOPIC"] = "TOPIC";
 })(FtSearchResultType = exports.FtSearchResultType || (exports.FtSearchResultType = {}));
-const isFtSearchResultType = (o) => {
-    return ["MAP", "DOCUMENT", "TOPIC"].includes(o);
-};
+const isFtSearchResultType = (o) => Object.keys(FtSearchResultType).includes(o);
 exports.isFtSearchResultType = isFtSearchResultType;
 // From: WsPublicSearchScope
 var FtSearchScope;
@@ -761,9 +921,7 @@ var FtSearchScope;
     FtSearchScope["ALL_TOPICS"] = "ALL_TOPICS";
     FtSearchScope["TOPICS_AND_UNSTRUCTURED_DOCUMENTS"] = "TOPICS_AND_UNSTRUCTURED_DOCUMENTS";
 })(FtSearchScope = exports.FtSearchScope || (exports.FtSearchScope = {}));
-const isFtSearchScope = (o) => {
-    return ["DEFAULT", "DOCUMENTS", "ALL_TOPICS", "TOPICS_AND_UNSTRUCTURED_DOCUMENTS"].includes(o);
-};
+const isFtSearchScope = (o) => Object.keys(FtSearchScope).includes(o);
 exports.isFtSearchScope = isFtSearchScope;
 const isFtValueFilter = (o) => {
     return isObject(o)
@@ -866,6 +1024,7 @@ var FtUserRole;
     FtUserRole["RATING_USER"] = "RATING_USER";
     FtUserRole["FEEDBACK_USER"] = "FEEDBACK_USER";
     FtUserRole["GENERATIVE_AI_USER"] = "GENERATIVE_AI_USER";
+    FtUserRole["GENERATIVE_AI_EXPORT_USER"] = "GENERATIVE_AI_EXPORT_USER";
     FtUserRole["CONTENT_PUBLISHER"] = "CONTENT_PUBLISHER";
     FtUserRole["KHUB_ADMIN"] = "KHUB_ADMIN";
     FtUserRole["USERS_ADMIN"] = "USERS_ADMIN";
@@ -873,9 +1032,7 @@ var FtUserRole;
     FtUserRole["ADMIN"] = "ADMIN";
     FtUserRole["DEVELOPER"] = "DEVELOPER";
 })(FtUserRole = exports.FtUserRole || (exports.FtUserRole = {}));
-const isFtUserRole = (o) => {
-    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);
-};
+const isFtUserRole = (o) => Object.keys(FtUserRole).includes(o);
 exports.isFtUserRole = isFtUserRole;
 const isFtAuthenticationIdentifier = (o) => {
     return isObject(o)
@@ -910,9 +1067,11 @@ const isFtUserProfile = (o) => {
     return isObject(o)
         && (o.emailAddress == null || isString(o.emailAddress))
         && (o.displayName == null || isString(o.displayName))
+        && (o.otpValidated == null || isBoolean(o.otpValidated))
         && ((Array.isArray(o.roles)
             && o.roles.every((v) => (0, exports.isFtUserRole)(v))))
         && (o.userId == null || isString(o.userId))
+        && (o.privacyPolicyAgreementDate == null || isString(o.privacyPolicyAgreementDate))
         && ((Array.isArray(o.tags)
             && o.tags.every((v) => isString(v))));
 };

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFtSemanticSearchRequest = exports.isFtSemanticSearchFilter = exports.isFtSemanticSearchResponseItem = exports.isFtClusteredSemanticSearchReply = exports.isFtPaginationConfiguration = exports.isFtPaginatedTocNode = exports.isFtPaginatedToc = exports.isFtPageConfiguration = exports.isFtMapAttachment = exports.isFtTranslationLanguagesResponse = exports.isFtTranslationSettingsInput = exports.isFtTranslationLanguagesInput = exports.isFtTranslationInput = exports.isTranslationFormat = exports.TranslationFormat = exports.isFtRagInput = exports.isFtRagHistory = exports.isFtGenAIGenerateInput = exports.isFtGenAIRating = exports.isFtReaderFeedbackConfiguration = exports.isFtReaderConfiguration = exports.isFtConfigurationHistoryEntryStatus = exports.FtConfigurationHistoryEntryStatus = void 0;
+exports.isFtSemanticSearchRequest = exports.isFtSemanticSearchFilter = exports.isFtSemanticSearchResponseItem = exports.isFtClusteredSemanticSearchReply = exports.isFtPaginationConfiguration = exports.isFtPaginatedTocNode = exports.isFtPaginatedToc = exports.isFtPageConfiguration = exports.isFtMapAttachment = exports.isFtTranslationInput = exports.isTranslationFormat = exports.TranslationFormat = exports.isFtRagInput = exports.isFtRagHistory = 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";
@@ -11,9 +11,7 @@ var FtConfigurationHistoryEntryStatus;
     FtConfigurationHistoryEntryStatus["VALID"] = "VALID";
     FtConfigurationHistoryEntryStatus["INVALID"] = "INVALID";
 })(FtConfigurationHistoryEntryStatus = exports.FtConfigurationHistoryEntryStatus || (exports.FtConfigurationHistoryEntryStatus = {}));
-const isFtConfigurationHistoryEntryStatus = (o) => {
-    return ["VALID", "INVALID"].includes(o);
-};
+const isFtConfigurationHistoryEntryStatus = (o) => Object.keys(FtConfigurationHistoryEntryStatus).includes(o);
 exports.isFtConfigurationHistoryEntryStatus = isFtConfigurationHistoryEntryStatus;
 const isFtReaderConfiguration = (o) => {
     return isObject(o)
@@ -73,9 +71,7 @@ var TranslationFormat;
     TranslationFormat["TEXT"] = "TEXT";
     TranslationFormat["HTML"] = "HTML";
 })(TranslationFormat = exports.TranslationFormat || (exports.TranslationFormat = {}));
-const isTranslationFormat = (o) => {
-    return ["TEXT", "HTML"].includes(o);
-};
+const isTranslationFormat = (o) => Object.keys(TranslationFormat).includes(o);
 exports.isTranslationFormat = isTranslationFormat;
 const isFtTranslationInput = (o) => {
     return isObject(o)
@@ -86,25 +82,6 @@ const isFtTranslationInput = (o) => {
         && (o.sourceLanguage == null || isString(o.sourceLanguage));
 };
 exports.isFtTranslationInput = isFtTranslationInput;
-const isFtTranslationLanguagesInput = (o) => {
-    return isObject(o)
-        && (isString(o.profileId))
-        && (o.sourceLanguage == null || isString(o.sourceLanguage));
-};
-exports.isFtTranslationLanguagesInput = isFtTranslationLanguagesInput;
-const isFtTranslationSettingsInput = (o) => {
-    return isObject(o)
-        && (isString(o.profileId))
-        && (isString(o.destinationLanguage))
-        && (o.sourceLanguage == null || isString(o.sourceLanguage));
-};
-exports.isFtTranslationSettingsInput = isFtTranslationSettingsInput;
-const isFtTranslationLanguagesResponse = (o) => {
-    return isObject(o)
-        && (isString(o.code))
-        && (isString(o.label));
-};
-exports.isFtTranslationLanguagesResponse = isFtTranslationLanguagesResponse;
 const isFtMapAttachment = (o) => {
     return isObject(o)
         && (isString(o.file))
@@ -138,7 +115,6 @@ const isFtPaginatedTocNode = (o) => {
         && (o.tocId == null || isString(o.tocId))
         && ((Array.isArray(o.children)
             && o.children.every((v) => (0, exports.isFtPaginatedTocNode)(v))))
-        && (o.translatedTitle == null || isString(o.translatedTitle))
         && (o.pageConfiguration == null || (0, exports.isFtPageConfiguration)(o.pageConfiguration))
         && (o.contentId == null || isString(o.contentId))
         && (o.title == null || isString(o.title));
@@ -171,6 +147,9 @@ const isFtSemanticSearchFilter = (o) => {
     return isObject(o)
         && ((Array.isArray(o.values)
             && o.values.every((v) => isString(v))))
+        && (o.hierarchicalValues == null || (Array.isArray(o.hierarchicalValues)
+            && o.hierarchicalValues.every((v) => (Array.isArray(v)
+                && v.every((v) => isString(v))))))
         && (isString(o.key));
 };
 exports.isFtSemanticSearchFilter = isFtSemanticSearchFilter;