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

package/dist/mjs/types/ft-common/public.d.ts

@@ -29,11 +29,35 @@ export declare enum FtAnalyticsDocumentType {
     UNSTRUCTURED_DOCUMENT = "UNSTRUCTURED_DOCUMENT",
     SHARED_PERSONAL_BOOK = "SHARED_PERSONAL_BOOK",
     PERSONAL_BOOK = "PERSONAL_BOOK",
-    MAP_ATTACHMENT = "MAP_ATTACHMENT",
+    ATTACHMENT = "ATTACHMENT",
     RESOURCE = "RESOURCE"
 }
 export type FtAnalyticsDocumentTypeKeys = keyof typeof FtAnalyticsDocumentType;
 export declare const isFtAnalyticsDocumentType: (o: any) => o is FtAnalyticsDocumentType;
+export interface FtAnalyticsEventAIProfile {
+    chatbotDetails?: FtAnalyticsEventAIProfileChatbotDetails;
+    translationDetails?: FtAnalyticsEventAIProfileTranslationDetails;
+    completionDetails?: FtAnalyticsEventAIProfileCompletionDetails;
+    name: string;
+    id: string;
+    type: string;
+}
+export declare const isFtAnalyticsEventAIProfile: (o: any) => o is FtAnalyticsEventAIProfile;
+export interface FtAnalyticsEventAIProfileChatbotDetails {
+    provider: string;
+    model?: string;
+}
+export declare const isFtAnalyticsEventAIProfileChatbotDetails: (o: any) => o is FtAnalyticsEventAIProfileChatbotDetails;
+export interface FtAnalyticsEventAIProfileCompletionDetails {
+    provider: string;
+    model?: string;
+}
+export declare const isFtAnalyticsEventAIProfileCompletionDetails: (o: any) => o is FtAnalyticsEventAIProfileCompletionDetails;
+export interface FtAnalyticsEventAIProfileTranslationDetails {
+    provider: string;
+    engine?: string;
+}
+export declare const isFtAnalyticsEventAIProfileTranslationDetails: (o: any) => o is FtAnalyticsEventAIProfileTranslationDetails;
 export interface FtAnalyticsEventDisplay {
     width: number;
     height: number;
@@ -48,30 +72,10 @@ export interface FtAnalyticsEventDocument {
     parentId?: string;
 }
 export declare const isFtAnalyticsEventDocument: (o: any) => o is FtAnalyticsEventDocument;
-export interface FtAnalyticsEventGenAIProfile {
-    chatbotDetails?: FtAnalyticsEventGenAIProfileChatbotDetails;
-    translationDetails?: FtAnalyticsEventGenAIProfileTranslationDetails;
-    completionDetails?: FtAnalyticsEventGenAIProfileCompletionDetails;
-    name: string;
-    id: string;
-    type: string;
-}
-export declare const isFtAnalyticsEventGenAIProfile: (o: any) => o is FtAnalyticsEventGenAIProfile;
-export interface FtAnalyticsEventGenAIProfileChatbotDetails {
-    provider: string;
-    model?: string;
-}
-export declare const isFtAnalyticsEventGenAIProfileChatbotDetails: (o: any) => o is FtAnalyticsEventGenAIProfileChatbotDetails;
-export interface FtAnalyticsEventGenAIProfileCompletionDetails {
-    provider: string;
-    model?: string;
-}
-export declare const isFtAnalyticsEventGenAIProfileCompletionDetails: (o: any) => o is FtAnalyticsEventGenAIProfileCompletionDetails;
-export interface FtAnalyticsEventGenAIProfileTranslationDetails {
-    provider: string;
-    engine?: string;
+export interface FtAnalyticsEventDocumentSearchQuery {
+    terms: string;
 }
-export declare const isFtAnalyticsEventGenAIProfileTranslationDetails: (o: any) => o is FtAnalyticsEventGenAIProfileTranslationDetails;
+export declare const isFtAnalyticsEventDocumentSearchQuery: (o: any) => o is FtAnalyticsEventDocumentSearchQuery;
 export interface FtAnalyticsEventLocation {
     type: string;
     value: string;
@@ -113,7 +117,7 @@ export interface FtAnalyticsEventSearchQuery {
 }
 export declare const isFtAnalyticsEventSearchQuery: (o: any) => o is FtAnalyticsEventSearchQuery;
 export interface FtAnalyticsEventSearchResponse {
-    autocorrect?: boolean;
+    autocorrect: boolean;
     nbResults: number;
 }
 export declare const isFtAnalyticsEventSearchResponse: (o: any) => o is FtAnalyticsEventSearchResponse;
@@ -137,7 +141,7 @@ export declare enum FtAnalyticsPublicationType {
     UNSTRUCTURED_DOCUMENT = "UNSTRUCTURED_DOCUMENT",
     SHARED_PERSONAL_BOOK = "SHARED_PERSONAL_BOOK",
     PERSONAL_BOOK = "PERSONAL_BOOK",
-    MAP_ATTACHMENT = "MAP_ATTACHMENT",
+    ATTACHMENT = "ATTACHMENT",
     RESOURCE = "RESOURCE"
 }
 export type FtAnalyticsPublicationTypeKeys = keyof typeof FtAnalyticsPublicationType;
@@ -166,9 +170,30 @@ export declare enum FtAnalyticsSearchFacetType {
 }
 export type FtAnalyticsSearchFacetTypeKeys = keyof typeof FtAnalyticsSearchFacetType;
 export declare const isFtAnalyticsSearchFacetType: (o: any) => o is FtAnalyticsSearchFacetType;
+export interface FtAiCaseDeflectionEvent extends FtAnalyticsEvent {
+    generationId?: string;
+    searchQuery?: FtAnalyticsEventSearchQuery;
+    context: string;
+}
+export declare const isFtAiCaseDeflectionEvent: (o: any) => o is FtAiCaseDeflectionEvent;
+export interface FtAiCompletedQueryEvent extends FtAnalyticsEvent {
+    result: string;
+    profile: FtAnalyticsEventAIProfile;
+    durationMs: number;
+    parameters?: Record<string, string>;
+    queryId: string;
+}
+export declare const isFtAiCompletedQueryEvent: (o: any) => o is FtAiCompletedQueryEvent;
+export interface FtAiRateEvent extends FtAnalyticsEvent {
+    rating: FtAnalyticsEventRating;
+    comment: string;
+    queryId: string;
+}
+export declare const isFtAiRateEvent: (o: any) => o is FtAiRateEvent;
 export interface FtAnalyticsEvent {
     offline: boolean;
     appVersion: string;
+    internal?: boolean;
     appName: string;
     name: FtAnalyticsEventNameKeys;
 }
@@ -182,6 +207,7 @@ export declare enum FtAnalyticsEventName {
     COLLECTION__CREATE = "COLLECTION__CREATE",
     COLLECTION__UPDATE = "COLLECTION__UPDATE",
     COLLECTION__DELETE = "COLLECTION__DELETE",
+    CUSTOM_EVENT__TRIGGER = "CUSTOM_EVENT__TRIGGER",
     DOCUMENT__DISPLAY = "DOCUMENT__DISPLAY",
     DOCUMENT__DOWNLOAD = "DOCUMENT__DOWNLOAD",
     DOCUMENT__PRINT = "DOCUMENT__PRINT",
@@ -191,10 +217,10 @@ export declare enum FtAnalyticsEventName {
     DOCUMENT__START_DISPLAY = "DOCUMENT__START_DISPLAY",
     DOCUMENT__UNRATE = "DOCUMENT__UNRATE",
     FEEDBACK__SEND = "FEEDBACK__SEND",
-    GEN_AI__COMPLETED_QUERY = "GEN_AI__COMPLETED_QUERY",
-    GEN_AI__RATE = "GEN_AI__RATE",
-    GENAI_CASE_DEFLECTION__START = "GENAI_CASE_DEFLECTION__START",
-    GENAI_CASE_DEFLECTION__OPEN_TICKET = "GENAI_CASE_DEFLECTION__OPEN_TICKET",
+    AI__COMPLETED_QUERY = "AI__COMPLETED_QUERY",
+    AI__RATE = "AI__RATE",
+    AI_CASE_DEFLECTION__START = "AI_CASE_DEFLECTION__START",
+    AI_CASE_DEFLECTION__OPEN_TICKET = "AI_CASE_DEFLECTION__OPEN_TICKET",
     KHUB__PROCESS = "KHUB__PROCESS",
     KHUB__SEARCH = "KHUB__SEARCH",
     LABELS__DOWNLOAD = "LABELS__DOWNLOAD",
@@ -228,6 +254,12 @@ export interface FtCaseDeflectionEvent extends FtAnalyticsEvent {
     topic?: FtAnalyticsEventTopic;
 }
 export declare const isFtCaseDeflectionEvent: (o: any) => o is FtCaseDeflectionEvent;
+export interface FtCustomTriggerEvent extends FtAnalyticsEvent {
+    componentId?: string;
+    eventName: string;
+    page: FtAnalyticsEventPage;
+}
+export declare const isFtCustomTriggerEvent: (o: any) => o is FtCustomTriggerEvent;
 export interface FtDocumentDisplayEvent extends FtAnalyticsEvent {
     /** @deprecated */ publication?: FtAnalyticsEventPublication;
     document?: FtAnalyticsEventDocument;
@@ -249,7 +281,7 @@ export interface FtDocumentSearchEvent extends FtAnalyticsEvent {
     searchResponse: FtAnalyticsEventSearchResponse;
     /** @deprecated */ publication?: FtAnalyticsEventPublication;
     document?: FtAnalyticsEventDocument;
-    searchQuery: FtAnalyticsEventSearchQuery;
+    searchQuery: FtAnalyticsEventDocumentSearchQuery;
 }
 export declare const isFtDocumentSearchEvent: (o: any) => o is FtDocumentSearchEvent;
 export interface FtDocumentStartDisplayEvent extends FtAnalyticsEvent {
@@ -265,18 +297,6 @@ export interface FtFeedbackSendEvent extends FtAnalyticsEvent {
     loggedIn: boolean;
 }
 export declare const isFtFeedbackSendEvent: (o: any) => o is FtFeedbackSendEvent;
-export interface FtGenAiCaseDeflectionEvent extends FtAnalyticsEvent {
-    generationId?: string;
-    searchQuery?: FtAnalyticsEventSearchQuery;
-    context: string;
-}
-export declare const isFtGenAiCaseDeflectionEvent: (o: any) => o is FtGenAiCaseDeflectionEvent;
-export interface FtGenAiRateEvent extends FtAnalyticsEvent {
-    rating: FtAnalyticsEventRating;
-    comment: string;
-    queryId: string;
-}
-export declare const isFtGenAiRateEvent: (o: any) => o is FtGenAiRateEvent;
 export interface FtKhubSearchEvent extends FtAnalyticsEvent {
     searchResponse: FtAnalyticsEventSearchResponse;
     searchQuery: FtAnalyticsEventSearchQuery;
@@ -384,28 +404,29 @@ export declare const isFtCollectionDocument: (o: any) => o is FtCollectionDocume
 export interface FtMap {
     prettyUrl?: string;
     metadata: Array<FtMetadata>;
-    watermark?: FtWatermark;
-    openMode: FtOpenModeKeys;
     topicsApiEndpoint?: string;
     description?: string;
-    attachmentsApiEndpoint?: string;
     editorialType: FtEditorialTypeKeys;
     baseId: string;
     clusterId: string;
     title: string;
-    lastPublication: string;
-    pbkConfidential: boolean;
     lastEdition: string;
     originId: string;
     rightsApiEndpoint?: string;
-    contentStyles: FtMapStyles;
-    originUrl?: string;
     fingerprint: string;
     readerUrl: string;
     untranslatedTitle?: string;
     khubVersion?: string;
     id: string;
     lang?: string;
+    watermark?: FtWatermark;
+    openMode: FtOpenModeKeys;
+    attachmentsApiEndpoint?: string;
+    lastPublication: string;
+    pbkConfidential: boolean;
+    contentStyles: FtMapStyles;
+    originUrl?: string;
+    translationError: boolean;
 }
 export declare const isFtMap: (o: any) => o is FtMap;
 export interface FtMapStyles {
@@ -447,18 +468,18 @@ export interface FtUnstructuredDocument {
     openMode: string;
     description?: string;
     mimeType: string;
-    baseId?: string;
+    baseId: string;
     clusterId?: string;
     contentApiEndpoint: string;
     title: string;
-    lastPublication?: string;
+    lastPublication: string;
     viewerUrl: string;
     lastEdition: string;
     filename: string;
     originId?: string;
     rightsApiEndpoint: string;
     originUrl?: string;
-    khubVersion?: string;
+    khubVersion: string;
     id: string;
     lang?: string;
 }
@@ -593,10 +614,11 @@ export interface FtMySearchCreation {
 export declare const isFtMySearchCreation: (o: any) => o is FtMySearchCreation;
 export interface FtMySearchRequest {
     /** @deprecated */ periodFilter?: FtPeriodFilter;
+    sortId?: string;
     query: string;
     scope?: FtSearchScopeKeys;
     /** @deprecated */ filters?: Array<FtLegacyLabeledMetadataFilter>;
-    sort: Array<FtSearchSortCriterion>;
+    sort?: Array<FtSearchSortCriterion>;
     virtualField?: FtVirtualFieldKeys;
     metadataFilters?: Array<FtLabeledMetadataFilter>;
     contentLocale?: string;
@@ -820,10 +842,11 @@ export interface FtSearchRequest {
     query: string;
     paging: FtPageRequest;
     /** @deprecated */ filters?: Array<FtLegacyMetadataFilter>;
-    sort: Array<FtSearchSortCriterion>;
+    /** @deprecated */ sort?: Array<FtSearchSortCriterion>;
     virtualField?: FtVirtualFieldKeys;
     metadataFilters: Array<FtMetadataFilter>;
     facets: Array<FtSearchFacetConf>;
+    sortId?: string;
     scope?: FtSearchScopeKeys;
     /** @deprecated */ lastModified?: any;
     uiLocale?: string;
@@ -847,12 +870,12 @@ export interface FtSearchResultClusterEntry {
 export declare const isFtSearchResultClusterEntry: (o: any) => o is FtSearchResultClusterEntry;
 export interface FtSearchResultUnstructuredDocument {
     metadata: Array<FtMetadata>;
-    openMode: FtOpenModeKeys;
+    openMode?: FtOpenModeKeys;
     documentUrl: string;
     mimeType: string;
     source: any;
     title: string;
-    lastPublicationDate?: string;
+    lastPublicationDate: string;
     viewerUrl: string;
     contentUrl: string;
     filename: string;
@@ -869,7 +892,7 @@ export interface FtSearchResultMap {
     editorialType: FtEditorialTypeKeys;
     source?: any;
     title: string;
-    lastPublicationDate?: string;
+    lastPublicationDate: string;
     htmlTitle: string;
     originUrl?: string;
     mapUrl: string;
@@ -881,7 +904,7 @@ export interface FtSearchResultMap {
 export declare const isFtSearchResultMap: (o: any) => o is FtSearchResultMap;
 export interface FtSearchResultTopic {
     metadata: Array<FtMetadata>;
-    openMode: FtOpenModeKeys;
+    openMode?: FtOpenModeKeys;
     contentId: string;
     resources: Array<FtTopicResource>;
     source?: any;
@@ -961,8 +984,16 @@ export interface FtTopicResource {
     viewerUrl: string;
 }
 export declare const isFtTopicResource: (o: any) => o is FtTopicResource;
+export declare enum FtLocalizableLabelType {
+    PLAIN_TEXT = "PLAIN_TEXT",
+    LOCALIZED_OFFICIAL = "LOCALIZED_OFFICIAL",
+    LOCALIZED_CUSTOM = "LOCALIZED_CUSTOM"
+}
+export type FtLocalizableLabelTypeKeys = keyof typeof FtLocalizableLabelType;
+export declare const isFtLocalizableLabelType: (o: any) => o is FtLocalizableLabelType;
 export interface FtSuggestRequest {
     input: string;
+    sortId?: string;
     scope?: FtSearchScopeKeys;
     sort: Array<FtSearchSortCriterion>;
     maxCount?: number;
@@ -1059,3 +1090,20 @@ export interface FtWatermark {
     opacity: number;
 }
 export declare const isFtWatermark: (o: any) => o is FtWatermark;
+export interface FtLocalizableLabel {
+    context: string;
+    text: string;
+    type: FtLocalizableLabelTypeKeys;
+    key: string;
+}
+export declare const isFtLocalizableLabel: (o: any) => o is FtLocalizableLabel;
+export interface FtSearchConfiguration {
+    sortOptions: Array<FtSearchSortOption>;
+}
+export declare const isFtSearchConfiguration: (o: any) => o is FtSearchConfiguration;
+export interface FtSearchSortOption {
+    id: string;
+    label: FtLocalizableLabel;
+    sortCriteria: Array<FtSearchSortCriterion>;
+}
+export declare const isFtSearchSortOption: (o: any) => o is FtSearchSortOption;