@fluid-topics/public-api 1.0.141 → 1.0.142-alpha1

package/dist/mjs/index.js

@@ -34,7 +34,7 @@ async function handleError(method, endpoint, response) {
             endpoint,
             status: response.status,
             statusText: response.statusText,
-            body: await response.text()
+            body: await response.text(),
         };
         if (typeof wnd.dispatchEvent === "function") {
             wnd.dispatchEvent(new HttpErrorEvent(details));
@@ -57,9 +57,9 @@ export class FluidTopicsApi {
             stickyFilters: {
                 endpoint: "api/admin/sticky-filters",
                 id: (id) => ({
-                    endpoint: `api/admin/sticky-filters/${id}`
-                })
-            }
+                    endpoint: `api/admin/sticky-filters/${id}`,
+                }),
+            },
         },
         authentication: {
             login: `api/authentication/login`,
@@ -79,14 +79,14 @@ export class FluidTopicsApi {
                         attachmentId: (attachmentId) => ({
                             info: `api/khub/maps/${mapId}/attachments/${attachmentId}`,
                             content: `api/khub/maps/${mapId}/attachments/${attachmentId}/content`,
-                        })
+                        }),
                     },
                     resources: {
                         list: `api/khub/maps/${mapId}/resources`,
                         resourceId: (resourceId) => ({
                             info: `api/khub/maps/${mapId}/resources/${resourceId}`,
                             content: `api/khub/maps/${mapId}/resources/${resourceId}/content`,
-                        })
+                        }),
                     },
                     topics: {
                         contentId: (contentId) => ({
@@ -97,9 +97,9 @@ export class FluidTopicsApi {
                         tocId: (tocId) => ({
                             feedback: `api/khub/maps/${mapId}/topics/${tocId}/feedback`,
                             rating: `api/khub/maps/${mapId}/topics/${tocId}/rating`,
-                        })
+                        }),
                     },
-                })
+                }),
             },
             documents: {
                 documentId: (documentId) => ({
@@ -113,9 +113,9 @@ export class FluidTopicsApi {
                         attachmentId: (attachmentId) => ({
                             info: `api/khub/documents/${documentId}/attachments/${attachmentId}`,
                             content: `api/khub/documents/${documentId}/attachments/${attachmentId}/content`,
-                        })
+                        }),
                     },
-                })
+                }),
             },
             semantic: {
                 search: `api/khub/semantic/search`,
@@ -128,14 +128,14 @@ export class FluidTopicsApi {
         user: {
             locales: {
                 ui: `api/user/locales/ui`,
-            }
+            },
         },
         users: {
             userId: (userId) => ({
                 collections: {
                     collectionId: (collectionId) => ({
                         documents: `api/users/${userId}/collections/${collectionId}/documents`,
-                    })
+                    }),
                 },
                 searches: {
                     list: `api/users/${userId}/searches`,
@@ -143,11 +143,11 @@ export class FluidTopicsApi {
                     mySearchId: (mySearchId) => ({
                         delete: `api/users/${userId}/searches/${mySearchId}`,
                         update: `api/users/${userId}/searches/${mySearchId}`,
-                    })
+                    }),
                 },
                 bookmarks: {
                     list: `api/users/${userId}/bookmarks`,
-                }
+                },
             }),
         },
         stylesheets: {
@@ -181,8 +181,8 @@ export class FluidTopicsApi {
                 backups: `api/remote-portals/${remoteId}/backups`,
                 backup: (backupId) => ({
                     restore: `api/remote-portals/${remoteId}/backups/${backupId}/restore`,
-                })
-            })
+                }),
+            }),
         },
         locales: {
             ui: `api/locales/ui`,
@@ -193,14 +193,14 @@ export class FluidTopicsApi {
                 fluidTopics: {
                     contextName: (contextName) => ({
                         endpoint: `api/messages/${locale}/fluid-topics/${contextName}`,
-                    })
+                    }),
                 },
                 custom: {
                     contextName: (contextName) => ({
                         endpoint: `api/messages/${locale}/custom/${contextName}`,
-                    })
-                }
-            })
+                    }),
+                },
+            }),
         },
         ai: {
             generate: `api/ai/generate`,
@@ -210,30 +210,30 @@ export class FluidTopicsApi {
             translate: `api/ai/translate`,
             destinationLanguages: (profileId) => ({
                 endpoint: `api/ai/translate/${profileId}/languages`,
-            })
+            }),
         },
         assets: {
             highlightjs: `assets/scripts/highlightjs`,
             customCode: (subPath) => ({
                 endpoint: `portal/custom-code/${subPath}`,
-            })
+            }),
         },
         analytics: {
             events: "api/analytics/events",
         },
         stickyFilters: {
             id: (id) => ({
-                get: `api/sticky-filters/${id}`
+                get: `api/sticky-filters/${id}`,
             }),
             find: `api/sticky-filters/find`,
-            suggest: `api/sticky-filters/suggest`
-        }
+            suggest: `api/sticky-filters/suggest`,
+        },
     };
     get defaultHeaders() {
         return {
             ...this.authorization,
             ...this.searchLabel,
-            "Ft-Calling-App": this.ftCallingApp
+            "Ft-Calling-App": this.ftCallingApp,
         };
     }
     constructor(tenantBaseUrl, integrationIdentifier, overrideIdentifierIfOnTenant) {
@@ -267,7 +267,7 @@ export class FluidTopicsApi {
         let credentials = {
             login: login,
             password: password,
-            rememberMe: true
+            rememberMe: true,
         };
         return this.post(this.endpoints.authentication.login, credentials)
             .then(result => {
@@ -278,7 +278,7 @@ export class FluidTopicsApi {
     logout() {
         return this.fetch(this.endpoints.authentication.logout, {
             method: "POST",
-            credentials: this.authorization == null ? "include" : undefined
+            credentials: this.authorization == null ? "include" : undefined,
         })
             .then((response) => handleError("POST", this.endpoints.authentication.logout, response))
             .then(async (response) => {
@@ -313,6 +313,16 @@ export class FluidTopicsApi {
         const queryParams = { ...this.buildTranslationParameters(translationSettings), v };
         return this.get(this.buildUrlFromParams(endpoint, queryParams));
     }
+    getFilteredPages(mapId, translationSettings, metadataFilters) {
+        if (!metadataFilters || metadataFilters.length === 0) {
+            return this.getPages(mapId, undefined, translationSettings);
+        }
+        const tocRequest = {
+            metadataFilters: metadataFilters || [],
+            ...this.buildTranslationParameters(translationSettings),
+        };
+        return this.post(this.endpoints.khub.maps.mapId(mapId).pages, tocRequest);
+    }
     getTopic(mapId, topicContentId, v) {
         return this.get(this.endpoints.khub.maps.mapId(mapId).topics.contentId(topicContentId).info, v);
     }
@@ -395,7 +405,7 @@ export class FluidTopicsApi {
     }
     rateTopic(mapId, tocId, type, value) {
         return this.post(this.endpoints.khub.maps.mapId(mapId).topics.tocId(tocId).rating, {
-            type, value
+            type, value,
         });
     }
     unrateTopic(mapId, tocId) {
@@ -513,7 +523,7 @@ export class FluidTopicsApi {
                 "Content-Type": "application/json",
             },
             body: JSON.stringify({ profileId, parameters }),
-            credentials: this.authorization == null ? "include" : undefined
+            credentials: this.authorization == null ? "include" : undefined,
         });
         await handleError("POST", this.endpoints.ai.generate, response);
         const reader = new AIChunkReader(response.body.getReader());
@@ -526,7 +536,7 @@ export class FluidTopicsApi {
                 "Content-Type": "application/json",
             },
             body: JSON.stringify(input),
-            credentials: this.authorization == null ? "include" : undefined
+            credentials: this.authorization == null ? "include" : undefined,
         });
         await handleError("POST", this.endpoints.ai.chat, response);
         const reader = new AIChunkReader(response.body.getReader());
@@ -540,7 +550,7 @@ export class FluidTopicsApi {
                 "Content-Type": "application/json",
             },
             body: JSON.stringify(input),
-            credentials: this.authorization == null ? "include" : undefined
+            credentials: this.authorization == null ? "include" : undefined,
         });
         await handleError("POST", endpoint, response);
         const reader = new AIChunkReader(response.body.getReader());
@@ -590,8 +600,8 @@ export class FluidTopicsApi {
             ...(requestInit ?? {}),
             headers: {
                 ...this.defaultHeaders,
-                ...(requestInit?.headers ?? {})
-            }
+                ...(requestInit?.headers ?? {}),
+            },
         });
     }
     upload(method, endpoint, body, onProgress = () => undefined) {
@@ -627,10 +637,10 @@ export class FluidTopicsApi {
         return this.fetch(endpoint, {
             method: method,
             headers: {
-                ...(data != null ? { "Content-Type": "application/json" } : {})
+                ...(data != null ? { "Content-Type": "application/json" } : {}),
             },
             body: data != null ? JSON.stringify(data) : undefined,
-            credentials: this.authorization == null ? "include" : undefined
+            credentials: this.authorization == null ? "include" : undefined,
         })
             .then((r) => handleError(method, endpoint, r))
             .then(getBody);
@@ -638,7 +648,7 @@ export class FluidTopicsApi {
     fetchRawData(endpoint, v) {
         return fetch(this.withVersion(endpoint, v), {
             headers: this.defaultHeaders,
-            credentials: this.authorization == null ? "include" : undefined
+            credentials: this.authorization == null ? "include" : undefined,
         })
             .then((r) => handleError("GET", endpoint, r))
             .then(response => response.arrayBuffer());
@@ -671,7 +681,7 @@ export class FluidTopicsApi {
             return {
                 translationProfileId: translationSettings.profileId,
                 translationDestinationLanguage: translationSettings.destinationLanguage,
-                translationSourceLanguage: translationSettings.sourceLanguage?.slice(0, 2)
+                translationSourceLanguage: translationSettings.sourceLanguage?.slice(0, 2),
             };
         }
     }

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

@@ -512,6 +512,12 @@ export interface FtTocNode {
     title: string;
 }
 export declare const isFtTocNode: (o: any) => o is FtTocNode;
+export declare enum FtTocNodeFilteredReason {
+    METADATA_FILTER = "METADATA_FILTER",
+    ACCESS_RIGHTS_FILTER = "ACCESS_RIGHTS_FILTER"
+}
+export type FtTocNodeFilteredReasonKeys = keyof typeof FtTocNodeFilteredReason;
+export declare const isFtTocNodeFilteredReason: (o: any) => o is FtTocNodeFilteredReason;
 export interface FtTopic {
     metadata: Array<FtMetadata>;
     id: string;
@@ -760,6 +766,12 @@ export interface FtTopicsRatingSummary {
     type: FtRatingTypeKeys;
 }
 export declare const isFtTopicsRatingSummary: (o: any) => o is FtTopicsRatingSummary;
+export interface FtTocRequest {
+    translationProfileId?: string;
+    translationDestinationLanguage?: string;
+    metadataFilters: Array<FtMetadataFilter>;
+}
+export declare const isFtTocRequest: (o: any) => o is FtTocRequest;
 export interface FtMapResourceSummary {
     contentUrl: string;
     filename: string;

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

@@ -542,6 +542,12 @@ export const isFtTocNode = (o) => {
         && (o.untranslatedTitle == null || isString(o.untranslatedTitle))
         && (isString(o.title));
 };
+export var FtTocNodeFilteredReason;
+(function (FtTocNodeFilteredReason) {
+    FtTocNodeFilteredReason["METADATA_FILTER"] = "METADATA_FILTER";
+    FtTocNodeFilteredReason["ACCESS_RIGHTS_FILTER"] = "ACCESS_RIGHTS_FILTER";
+})(FtTocNodeFilteredReason || (FtTocNodeFilteredReason = {}));
+export const isFtTocNodeFilteredReason = (o) => Object.keys(FtTocNodeFilteredReason).includes(o);
 export const isFtTopic = (o) => {
     return isObject(o)
         && ((Array.isArray(o.metadata)
@@ -809,6 +815,13 @@ export const isFtTopicsRatingSummary = (o) => {
             && o.ratings.every((v) => isFtTopicRating(v))))
         && (isFtRatingType(o.type));
 };
+export const isFtTocRequest = (o) => {
+    return isObject(o)
+        && (o.translationProfileId == null || isString(o.translationProfileId))
+        && (o.translationDestinationLanguage == null || isString(o.translationDestinationLanguage))
+        && ((Array.isArray(o.metadataFilters)
+            && o.metadataFilters.every((v) => isFtMetadataFilter(v))));
+};
 export const isFtMapResourceSummary = (o) => {
     return isObject(o)
         && (isString(o.contentUrl))

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

@@ -1,4 +1,4 @@
-import { FtTocNode, FtTopicOrigin, FtWatermark, FtMetadata } from "../ft-common/public";
+import { FtTocNode, FtTopicOrigin, FtTocNodeFilteredReasonKeys, FtWatermark, FtMetadata } from "../ft-common/public";
 export interface FtRemotePortal {
     baseUrl: string;
     id: string;
@@ -51,8 +51,6 @@ export declare enum FtChatbotAdminRatingTag {
     INACCURATE = "INACCURATE",
     INCOMPLETE = "INCOMPLETE",
     OFF_TOPIC = "OFF_TOPIC",
-    IRRELEVANT_SOURCES = "IRRELEVANT_SOURCES",
-    SUMMARY = "SUMMARY",
     SEMANTIC_SEARCH = "SEMANTIC_SEARCH",
     CHATBOT_INSTRUCTIONS = "CHATBOT_INSTRUCTIONS",
     DOCUMENTATION = "DOCUMENTATION",
@@ -119,6 +117,7 @@ export interface FtAgentRagChatRequest {
     profileId: string;
     conversationId: unknown;
     query: string;
+    stickyFiltersId?: string;
     filters?: Array<FtSemanticSearchFilter>;
 }
 export declare const isFtAgentRagChatRequest: (o: any) => o is FtAgentRagChatRequest;
@@ -127,6 +126,7 @@ export interface FtAgentGenerateRequest {
     profileId: string;
     conversationId: unknown;
     query: string;
+    stickyFiltersId?: string;
     searchFilters?: Array<FtSemanticSearchFilter>;
 }
 export declare const isFtAgentGenerateRequest: (o: any) => o is FtAgentGenerateRequest;
@@ -147,6 +147,7 @@ export interface FtRagInput {
     query: string;
     messages?: Array<FtRagHistory>;
     responseFormat?: FtRagResponseFormatKeys;
+    stickyFiltersId?: string;
     filters?: Array<FtSemanticSearchFilter>;
 }
 export declare const isFtRagInput: (o: any) => o is FtRagInput;
@@ -182,6 +183,17 @@ export interface FtGenAIGenerationTraceOutput {
     response: string;
 }
 export declare const isFtGenAIGenerationTraceOutput: (o: any) => o is FtGenAIGenerationTraceOutput;
+export interface FtRagChatResponseDocumentModel {
+    title: string;
+    url: string;
+    content: string;
+}
+export declare const isFtRagChatResponseDocumentModel: (o: any) => o is FtRagChatResponseDocumentModel;
+export interface FtRagChatResponseModel {
+    answer: string;
+    documents?: Array<FtRagChatResponseDocumentModel>;
+}
+export declare const isFtRagChatResponseModel: (o: any) => o is FtRagChatResponseModel;
 export interface FtGenAIRagFetchTracesRequest {
     endDate?: string;
     conversationId?: string;
@@ -283,6 +295,7 @@ export interface FtPageConfiguration {
 export declare const isFtPageConfiguration: (o: any) => o is FtPageConfiguration;
 export interface FtPaginatedToc {
     configuration: FtPaginationConfiguration;
+    filteredTocNodes: Record<string, FtTocNodeFiltered>;
     paginatedToc: Array<FtPaginatedTocNode>;
     translationError: boolean;
 }
@@ -311,6 +324,12 @@ export interface FtPaginationConfiguration {
     splitCurrentPageToc: boolean;
 }
 export declare const isFtPaginationConfiguration: (o: any) => o is FtPaginationConfiguration;
+export interface FtTocNodeFiltered {
+    reason: FtTocNodeFilteredReasonKeys;
+    tocId: string;
+    closestParent?: string;
+}
+export declare const isFtTocNodeFiltered: (o: any) => o is FtTocNodeFiltered;
 export declare enum FtTopicContentFormat {
     HTML = "HTML",
     MARKDOWN = "MARKDOWN"
@@ -357,6 +376,7 @@ export interface FtClusteredSemanticSearchRequest {
     cluster?: FtClusteredSemanticSearchCluster;
     outputMetadata?: Array<string>;
     query: string;
+    stickyFiltersId?: string;
     filters?: Array<FtSemanticSearchFilter>;
     nbResults?: number;
 }
@@ -395,6 +415,7 @@ export declare const isFtSemanticSearchOrFilter: (o: any) => o is FtSemanticSear
 export interface FtSemanticSearchRequest {
     outputMetadata?: Array<string>;
     query: string;
+    stickyFiltersId?: string;
     filters?: Array<FtSemanticSearchFilter>;
     nbResults?: number;
 }

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

@@ -58,8 +58,6 @@ export var FtChatbotAdminRatingTag;
     FtChatbotAdminRatingTag["INACCURATE"] = "INACCURATE";
     FtChatbotAdminRatingTag["INCOMPLETE"] = "INCOMPLETE";
     FtChatbotAdminRatingTag["OFF_TOPIC"] = "OFF_TOPIC";
-    FtChatbotAdminRatingTag["IRRELEVANT_SOURCES"] = "IRRELEVANT_SOURCES";
-    FtChatbotAdminRatingTag["SUMMARY"] = "SUMMARY";
     FtChatbotAdminRatingTag["SEMANTIC_SEARCH"] = "SEMANTIC_SEARCH";
     FtChatbotAdminRatingTag["CHATBOT_INSTRUCTIONS"] = "CHATBOT_INSTRUCTIONS";
     FtChatbotAdminRatingTag["DOCUMENTATION"] = "DOCUMENTATION";
@@ -129,6 +127,7 @@ export const isFtAgentRagChatRequest = (o) => {
     return isObject(o)
         && (isString(o.profileId))
         && (isString(o.query))
+        && (o.stickyFiltersId == null || isString(o.stickyFiltersId))
         && (o.filters == null || (Array.isArray(o.filters)
             && o.filters.every((v) => isFtSemanticSearchFilter(v))));
 };
@@ -137,6 +136,7 @@ export const isFtAgentGenerateRequest = (o) => {
         && (o.stream == null || isBoolean(o.stream))
         && (isString(o.profileId))
         && (isString(o.query))
+        && (o.stickyFiltersId == null || isString(o.stickyFiltersId))
         && (o.searchFilters == null || (Array.isArray(o.searchFilters)
             && o.searchFilters.every((v) => isFtSemanticSearchFilter(v))));
 };
@@ -159,6 +159,7 @@ export const isFtRagInput = (o) => {
         && (o.messages == null || (Array.isArray(o.messages)
             && o.messages.every((v) => isFtRagHistory(v))))
         && (o.responseFormat == null || isFtRagResponseFormat(o.responseFormat))
+        && (o.stickyFiltersId == null || isString(o.stickyFiltersId))
         && (o.filters == null || (Array.isArray(o.filters)
             && o.filters.every((v) => isFtSemanticSearchFilter(v))));
 };
@@ -195,6 +196,18 @@ export const isFtGenAIGenerationTraceOutput = (o) => {
     return isObject(o)
         && (isString(o.response));
 };
+export const isFtRagChatResponseDocumentModel = (o) => {
+    return isObject(o)
+        && (isString(o.title))
+        && (isString(o.url))
+        && (isString(o.content));
+};
+export const isFtRagChatResponseModel = (o) => {
+    return isObject(o)
+        && (isString(o.answer))
+        && (o.documents == null || (Array.isArray(o.documents)
+            && o.documents.every((v) => isFtRagChatResponseDocumentModel(v))));
+};
 export const isFtGenAIRagFetchTracesRequest = (o) => {
     return isObject(o)
         && (o.endDate == null || isString(o.endDate))
@@ -300,6 +313,9 @@ export const isFtPageConfiguration = (o) => {
 export const isFtPaginatedToc = (o) => {
     return isObject(o)
         && (isFtPaginationConfiguration(o.configuration))
+        && ((isObject(o.filteredTocNodes)
+            && Object.keys(o.filteredTocNodes).every((k) => isString(k))
+            && Object.values(o.filteredTocNodes).every((v) => isFtTocNodeFiltered(v))))
         && ((Array.isArray(o.paginatedToc)
             && o.paginatedToc.every((v) => isFtPaginatedTocNode(v))))
         && (isBoolean(o.translationError));
@@ -328,6 +344,11 @@ export const isFtPaginationConfiguration = (o) => {
     return isObject(o)
         && (isBoolean(o.splitCurrentPageToc));
 };
+export const isFtTocNodeFiltered = (o) => {
+    return isObject(o)
+        && (isString(o.tocId))
+        && (o.closestParent == null || isString(o.closestParent));
+};
 export var FtTopicContentFormat;
 (function (FtTopicContentFormat) {
     FtTopicContentFormat["HTML"] = "HTML";
@@ -377,6 +398,7 @@ export const isFtClusteredSemanticSearchRequest = (o) => {
         && (o.outputMetadata == null || (Array.isArray(o.outputMetadata)
             && o.outputMetadata.every((v) => isString(v))))
         && (isString(o.query))
+        && (o.stickyFiltersId == null || isString(o.stickyFiltersId))
         && (o.filters == null || (Array.isArray(o.filters)
             && o.filters.every((v) => isFtSemanticSearchFilter(v))))
         && (o.nbResults == null || isNumber(o.nbResults));
@@ -431,6 +453,7 @@ export const isFtSemanticSearchRequest = (o) => {
         && (o.outputMetadata == null || (Array.isArray(o.outputMetadata)
             && o.outputMetadata.every((v) => isString(v))))
         && (isString(o.query))
+        && (o.stickyFiltersId == null || isString(o.stickyFiltersId))
         && (o.filters == null || (Array.isArray(o.filters)
             && o.filters.every((v) => isFtSemanticSearchFilter(v))))
         && (o.nbResults == null || isNumber(o.nbResults));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-topics/public-api",
-  "version": "1.0.141",
+  "version": "1.0.142-alpha1",
   "description": "Fluid Topics Public API",
   "author": "Fluid Topics dev team <opensource@antidot.net>",
   "license": "LGPL-3.0-only",
@@ -29,19 +29,19 @@
     "@rollup/plugin-typescript": "12.3.0",
     "@types/chai": "5.2.3",
     "@types/mocha": "10.0.10",
-    "@types/node": "25.9.5",
+    "@types/node": "25.9.8",
     "@web/test-runner": "1.0.0",
     "@web/test-runner-junit-reporter": "1.0.0",
     "@web/test-runner-playwright": "1.0.0",
     "chai": "6.2.2",
-    "mocha": "12.0.0",
+    "mocha": "12.0.2",
     "playwright": "1.63.0",
-    "rollup": "4.63.1",
+    "rollup": "4.63.3",
     "ts-node": "10.9.2",
     "tslib": "2.8.1",
     "tsx": "4.23.13",
     "typescript": "6.0.3",
-    "vite": "8.2.2"
+    "vite": "8.3.0"
   },
   "packageManager": "yarn@4.18.0"
 }