@fluid-topics/public-api 1.0.108 → 1.0.110-alpha

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

@@ -234,6 +234,7 @@ export declare enum FtAnalyticsEventName {
     SAVED_SEARCH__UPDATE = "SAVED_SEARCH__UPDATE",
     SEARCH_PAGE__SELECT = "SEARCH_PAGE__SELECT",
     SEARCH_RESULT__OPEN_BROWSER_CONTEXT_MENU = "SEARCH_RESULT__OPEN_BROWSER_CONTEXT_MENU",
+    TOPIC__AI_TRANSLATE = "TOPIC__AI_TRANSLATE",
     TOPIC__DISPLAY = "TOPIC__DISPLAY",
     TOPIC__RATE = "TOPIC__RATE",
     TOPIC__START_DISPLAY = "TOPIC__START_DISPLAY",
@@ -510,7 +511,8 @@ export declare enum FtExternalWebComponentContext {
     TOPIC_TEMPLATE = "TOPIC_TEMPLATE",
     SEARCH = "SEARCH",
     SEARCH_RESULT = "SEARCH_RESULT",
-    SEARCH_ANNOUNCEMENT = "SEARCH_ANNOUNCEMENT"
+    SEARCH_ANNOUNCEMENT = "SEARCH_ANNOUNCEMENT",
+    LINK_PREVIEW = "LINK_PREVIEW"
 }
 export type FtExternalWebComponentContextKeys = keyof typeof FtExternalWebComponentContext;
 export declare const isFtExternalWebComponentContext: (o: any) => o is FtExternalWebComponentContext;
@@ -624,6 +626,7 @@ export interface FtMySearchCreation {
 export declare const isFtMySearchCreation: (o: any) => o is FtMySearchCreation;
 export interface FtMySearchRequest {
     /** @deprecated */ periodFilter?: FtPeriodFilter;
+    keywordMatch?: FtSearchKeywordMatchKeys;
     sortId?: string;
     query: string;
     scope?: FtSearchScopeKeys;
@@ -714,6 +717,12 @@ export declare enum FtPeriodFilterType {
 }
 export type FtPeriodFilterTypeKeys = keyof typeof FtPeriodFilterType;
 export declare const isFtPeriodFilterType: (o: any) => o is FtPeriodFilterType;
+export declare enum FtSearchKeywordMatch {
+    OPTIONAL = "OPTIONAL",
+    MANDATORY = "MANDATORY"
+}
+export type FtSearchKeywordMatchKeys = keyof typeof FtSearchKeywordMatch;
+export declare const isFtSearchKeywordMatch: (o: any) => o is FtSearchKeywordMatch;
 export interface FtSearchPreset {
     name: string;
     priority: number;
@@ -775,7 +784,8 @@ export declare enum FtCollectionDocumentType {
     DOCUMENT = "DOCUMENT",
     TOPIC = "TOPIC",
     PERSONAL_BOOK = "PERSONAL_BOOK",
-    SHARED_BOOK = "SHARED_BOOK"
+    SHARED_BOOK = "SHARED_BOOK",
+    HTML_PACKAGE = "HTML_PACKAGE"
 }
 export type FtCollectionDocumentTypeKeys = keyof typeof FtCollectionDocumentType;
 export declare const isFtCollectionDocumentType: (o: any) => o is FtCollectionDocumentType;
@@ -851,6 +861,7 @@ export interface FtSearchPrior {
 export declare const isFtSearchPrior: (o: any) => o is FtSearchPrior;
 export interface FtSearchRequest {
     /** @deprecated */ periodFilter?: FtPeriodFilter;
+    keywordMatch?: FtSearchKeywordMatchKeys;
     query: string;
     paging: FtPageRequest;
     /** @deprecated */ filters?: Array<FtLegacyMetadataFilter>;
@@ -879,9 +890,11 @@ export interface FtSearchResultCluster {
 }
 export declare const isFtSearchResultCluster: (o: any) => o is FtSearchResultCluster;
 export interface FtSearchResultClusterEntry {
+    htmlPackage?: FtSearchResultHtmlPackage;
     missingTerms: Array<string>;
     document?: FtSearchResultUnstructuredDocument;
     topic?: FtSearchResultTopic;
+    htmlPackagePage?: FtSearchResultHtmlPackagePage;
     type: FtSearchResultTypeKeys;
     map?: FtSearchResultMap;
 }
@@ -904,6 +917,35 @@ export interface FtSearchResultUnstructuredDocument {
     htmlExcerpt: string;
 }
 export declare const isFtSearchResultUnstructuredDocument: (o: any) => o is FtSearchResultUnstructuredDocument;
+export interface FtSearchResultHtmlPackage {
+    metadata: Array<FtMetadata>;
+    htmlTitle: string;
+    openMode: FtOpenModeKeys;
+    originUrl?: string;
+    packageId: string;
+    source: any;
+    viewerUrl: string;
+    title: string;
+    lastEditionDate: string;
+    lastPublicationDate: string;
+    htmlExcerpt: string;
+}
+export declare const isFtSearchResultHtmlPackage: (o: any) => o is FtSearchResultHtmlPackage;
+export interface FtSearchResultHtmlPackagePage {
+    metadata: Array<FtMetadata>;
+    htmlTitle: string;
+    openMode: FtOpenModeKeys;
+    originUrl?: string;
+    packageId: string;
+    contentId: string;
+    source: any;
+    viewerUrl: string;
+    title: string;
+    lastEditionDate: string;
+    packageTitle: string;
+    htmlExcerpt: string;
+}
+export declare const isFtSearchResultHtmlPackagePage: (o: any) => o is FtSearchResultHtmlPackagePage;
 export interface FtSearchResultMap {
     metadata: Array<FtMetadata>;
     openMode?: FtOpenModeKeys;
@@ -943,7 +985,9 @@ export declare const isFtSearchResultTopic: (o: any) => o is FtSearchResultTopic
 export declare enum FtSearchResultType {
     MAP = "MAP",
     DOCUMENT = "DOCUMENT",
-    TOPIC = "TOPIC"
+    TOPIC = "TOPIC",
+    HTML_PACKAGE = "HTML_PACKAGE",
+    HTML_PACKAGE_PAGE = "HTML_PACKAGE_PAGE"
 }
 export type FtSearchResultTypeKeys = keyof typeof FtSearchResultType;
 export declare const isFtSearchResultType: (o: any) => o is FtSearchResultType;
@@ -1011,6 +1055,7 @@ export type FtLocalizableLabelTypeKeys = keyof typeof FtLocalizableLabelType;
 export declare const isFtLocalizableLabelType: (o: any) => o is FtLocalizableLabelType;
 export interface FtSuggestRequest {
     input: string;
+    keywordMatch?: FtSearchKeywordMatchKeys;
     sortId?: string;
     scope?: FtSearchScopeKeys;
     sort: Array<FtSearchSortCriterion>;

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

@@ -253,6 +253,7 @@ export var FtAnalyticsEventName;
     FtAnalyticsEventName["SAVED_SEARCH__UPDATE"] = "SAVED_SEARCH__UPDATE";
     FtAnalyticsEventName["SEARCH_PAGE__SELECT"] = "SEARCH_PAGE__SELECT";
     FtAnalyticsEventName["SEARCH_RESULT__OPEN_BROWSER_CONTEXT_MENU"] = "SEARCH_RESULT__OPEN_BROWSER_CONTEXT_MENU";
+    FtAnalyticsEventName["TOPIC__AI_TRANSLATE"] = "TOPIC__AI_TRANSLATE";
     FtAnalyticsEventName["TOPIC__DISPLAY"] = "TOPIC__DISPLAY";
     FtAnalyticsEventName["TOPIC__RATE"] = "TOPIC__RATE";
     FtAnalyticsEventName["TOPIC__START_DISPLAY"] = "TOPIC__START_DISPLAY";
@@ -550,6 +551,7 @@ export var FtExternalWebComponentContext;
     FtExternalWebComponentContext["SEARCH"] = "SEARCH";
     FtExternalWebComponentContext["SEARCH_RESULT"] = "SEARCH_RESULT";
     FtExternalWebComponentContext["SEARCH_ANNOUNCEMENT"] = "SEARCH_ANNOUNCEMENT";
+    FtExternalWebComponentContext["LINK_PREVIEW"] = "LINK_PREVIEW";
 })(FtExternalWebComponentContext || (FtExternalWebComponentContext = {}));
 export const isFtExternalWebComponentContext = (o) => Object.keys(FtExternalWebComponentContext).includes(o);
 export const isFtFeedbackCreation = (o) => {
@@ -677,6 +679,7 @@ export const isFtMySearchCreation = (o) => {
 export const isFtMySearchRequest = (o) => {
     return isObject(o)
         && (o.periodFilter == null || isFtPeriodFilter(o.periodFilter))
+        && (o.keywordMatch == null || isFtSearchKeywordMatch(o.keywordMatch))
         && (o.sortId == null || isString(o.sortId))
         && (isString(o.query))
         && (o.scope == null || isFtSearchScope(o.scope))
@@ -777,6 +780,13 @@ export var FtPeriodFilterType;
     FtPeriodFilterType["CUSTOM"] = "CUSTOM";
 })(FtPeriodFilterType || (FtPeriodFilterType = {}));
 export const isFtPeriodFilterType = (o) => Object.keys(FtPeriodFilterType).includes(o);
+// From: SearchKeywordMatch
+export var FtSearchKeywordMatch;
+(function (FtSearchKeywordMatch) {
+    FtSearchKeywordMatch["OPTIONAL"] = "OPTIONAL";
+    FtSearchKeywordMatch["MANDATORY"] = "MANDATORY";
+})(FtSearchKeywordMatch || (FtSearchKeywordMatch = {}));
+export const isFtSearchKeywordMatch = (o) => Object.keys(FtSearchKeywordMatch).includes(o);
 export const isFtSearchPreset = (o) => {
     return isObject(o)
         && (isString(o.name))
@@ -847,6 +857,7 @@ export var FtCollectionDocumentType;
     FtCollectionDocumentType["TOPIC"] = "TOPIC";
     FtCollectionDocumentType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
     FtCollectionDocumentType["SHARED_BOOK"] = "SHARED_BOOK";
+    FtCollectionDocumentType["HTML_PACKAGE"] = "HTML_PACKAGE";
 })(FtCollectionDocumentType || (FtCollectionDocumentType = {}));
 export const isFtCollectionDocumentType = (o) => Object.keys(FtCollectionDocumentType).includes(o);
 export const isFtDateFilter = (o) => {
@@ -928,6 +939,7 @@ export const isFtSearchPrior = (o) => {
 export const isFtSearchRequest = (o) => {
     return isObject(o)
         && (o.periodFilter == null || isFtPeriodFilter(o.periodFilter))
+        && (o.keywordMatch == null || isFtSearchKeywordMatch(o.keywordMatch))
         && (isString(o.query))
         && (isFtPageRequest(o.paging))
         && (o.filters == null || (Array.isArray(o.filters)
@@ -962,10 +974,12 @@ export const isFtSearchResultCluster = (o) => {
 };
 export const isFtSearchResultClusterEntry = (o) => {
     return isObject(o)
+        && (o.htmlPackage == null || isFtSearchResultHtmlPackage(o.htmlPackage))
         && ((Array.isArray(o.missingTerms)
             && o.missingTerms.every((v) => isString(v))))
         && (o.document == null || isFtSearchResultUnstructuredDocument(o.document))
         && (o.topic == null || isFtSearchResultTopic(o.topic))
+        && (o.htmlPackagePage == null || isFtSearchResultHtmlPackagePage(o.htmlPackagePage))
         && (isFtSearchResultType(o.type))
         && (o.map == null || isFtSearchResultMap(o.map));
 };
@@ -987,6 +1001,35 @@ export const isFtSearchResultUnstructuredDocument = (o) => {
         && (isString(o.lastEditionDate))
         && (isString(o.htmlExcerpt));
 };
+export const isFtSearchResultHtmlPackage = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.metadata)
+            && o.metadata.every((v) => isFtMetadata(v))))
+        && (isString(o.htmlTitle))
+        && (isFtOpenMode(o.openMode))
+        && (o.originUrl == null || isString(o.originUrl))
+        && (isString(o.packageId))
+        && (isString(o.viewerUrl))
+        && (isString(o.title))
+        && (isString(o.lastEditionDate))
+        && (isString(o.lastPublicationDate))
+        && (isString(o.htmlExcerpt));
+};
+export const isFtSearchResultHtmlPackagePage = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.metadata)
+            && o.metadata.every((v) => isFtMetadata(v))))
+        && (isString(o.htmlTitle))
+        && (isFtOpenMode(o.openMode))
+        && (o.originUrl == null || isString(o.originUrl))
+        && (isString(o.packageId))
+        && (isString(o.contentId))
+        && (isString(o.viewerUrl))
+        && (isString(o.title))
+        && (isString(o.lastEditionDate))
+        && (isString(o.packageTitle))
+        && (isString(o.htmlExcerpt));
+};
 export const isFtSearchResultMap = (o) => {
     return isObject(o)
         && ((Array.isArray(o.metadata)
@@ -1031,6 +1074,8 @@ export var FtSearchResultType;
     FtSearchResultType["MAP"] = "MAP";
     FtSearchResultType["DOCUMENT"] = "DOCUMENT";
     FtSearchResultType["TOPIC"] = "TOPIC";
+    FtSearchResultType["HTML_PACKAGE"] = "HTML_PACKAGE";
+    FtSearchResultType["HTML_PACKAGE_PAGE"] = "HTML_PACKAGE_PAGE";
 })(FtSearchResultType || (FtSearchResultType = {}));
 export const isFtSearchResultType = (o) => Object.keys(FtSearchResultType).includes(o);
 // From: WsPublicSearchScope
@@ -1103,6 +1148,7 @@ export const isFtLocalizableLabelType = (o) => Object.keys(FtLocalizableLabelTyp
 export const isFtSuggestRequest = (o) => {
     return isObject(o)
         && (isString(o.input))
+        && (o.keywordMatch == null || isFtSearchKeywordMatch(o.keywordMatch))
         && (o.sortId == null || isString(o.sortId))
         && (o.scope == null || isFtSearchScope(o.scope))
         && ((Array.isArray(o.sort)

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

@@ -85,6 +85,7 @@ export interface FtGenAIGenerationTraceOutput {
 export declare const isFtGenAIGenerationTraceOutput: (o: any) => o is FtGenAIGenerationTraceOutput;
 export interface FtGenAIRagFetchTracesRequest {
     endDate?: string;
+    conversationId?: string;
     nbResults?: number;
     userId?: string;
     startDate?: string;

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

@@ -100,6 +100,7 @@ export const isFtGenAIGenerationTraceOutput = (o) => {
 export const isFtGenAIRagFetchTracesRequest = (o) => {
     return isObject(o)
         && (o.endDate == null || isString(o.endDate))
+        && (o.conversationId == null || isString(o.conversationId))
         && (o.nbResults == null || isNumber(o.nbResults))
         && (o.userId == null || isString(o.userId))
         && (o.startDate == null || isString(o.startDate));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-topics/public-api",
-  "version": "1.0.108",
+  "version": "1.0.110-alpha",
   "description": "Fluid Topics Public API",
   "author": "Fluid Topics dev team <opensource@antidot.net>",
   "license": "LGPL-3.0-only",