@fluid-topics/public-api 1.0.87 → 1.0.88

package/dist/mjs/index.js

@@ -83,6 +83,7 @@ export class FluidTopicsApi {
                         contentId: (contentId) => ({
                             info: `api/khub/maps/${mapId}/topics/${contentId}`,
                             content: `api/khub/maps/${mapId}/topics/${contentId}/content`,
+                            translation: `api/khub/maps/${mapId}/topics/${contentId}/content/translation`,
                         }),
                         tocId: (tocId) => ({
                             feedback: `api/khub/maps/${mapId}/topics/${tocId}/feedback`,
@@ -158,12 +159,15 @@ export class FluidTopicsApi {
             sendFeedback: `api/ai/rate`,
             chat: `/api/ai/rag/chat`,
             translate: `api/ai/translate`,
+            destinationLanguages: (profileId) => ({
+                endpoint: `api/ai/translate/${profileId}/languages`
+            })
         },
         assets: {
             highlightjs: `assets/scripts/highlightjs`,
         },
         analytics: {
-            events: 'api/analytics/events'
+            events: "api/analytics/events"
         }
     };
     get defaultHeaders() {
@@ -222,14 +226,18 @@ export class FluidTopicsApi {
     getReaderConfiguration() {
         return this.get(this.endpoints.configuration.reader);
     }
-    getMap(mapId, v) {
-        return this.get(this.endpoints.khub.maps.mapId(mapId).info, v);
+    getMap(mapId, translationSettings, v) {
+        const endpoint = this.endpoints.khub.maps.mapId(mapId).info;
+        const queryParams = { ...this.buildTranslationParameters(translationSettings), v };
+        return this.get(this.buildUrlFromParams(endpoint, queryParams));
     }
     getTableOfContent(mapId, v) {
         return this.get(this.endpoints.khub.maps.mapId(mapId).toc, v);
     }
-    getPages(mapId, v) {
-        return this.get(this.endpoints.khub.maps.mapId(mapId).pages, v);
+    getPages(mapId, v, translationSettings) {
+        const endpoint = this.endpoints.khub.maps.mapId(mapId).pages;
+        const queryParams = { ...this.buildTranslationParameters(translationSettings), v };
+        return this.get(this.buildUrlFromParams(endpoint, queryParams));
     }
     getTopic(mapId, topicContentId, v) {
         return this.get(this.endpoints.khub.maps.mapId(mapId).topics.contentId(topicContentId).info, v);
@@ -237,6 +245,11 @@ export class FluidTopicsApi {
     getTopicHTMLContent(mapId, topicContentId, target, v) {
         return this.get(this.endpoints.khub.maps.mapId(mapId).topics.contentId(topicContentId).content + (target ? "?target=" + target : ""), v);
     }
+    getTranslatedTopicHTMLContent(mapId, topicContentId, target, v, translationSettings) {
+        const endpoint = this.endpoints.khub.maps.mapId(mapId).topics.contentId(topicContentId).translation;
+        const queryParams = { ...this.buildTranslationParameters(translationSettings), target, v };
+        return this.get(this.buildUrlFromParams(endpoint, queryParams));
+    }
     getMapAttachments(mapId, v) {
         return this.get(this.endpoints.khub.maps.mapId(mapId).attachments.list, v);
     }
@@ -367,6 +380,11 @@ export class FluidTopicsApi {
     translate(input) {
         return this.post(this.endpoints.ai.translate, input);
     }
+    getDestinationLanguages(profileId, sourceLanguage) {
+        const endpoint = this.endpoints.ai.destinationLanguages(profileId).endpoint;
+        const queryParams = { sourceLanguage };
+        return this.get(this.buildUrlFromParams(endpoint, queryParams));
+    }
     sendFeedback(rating) {
         return this.post(this.endpoints.ai.sendFeedback, rating);
     }
@@ -456,5 +474,25 @@ export class FluidTopicsApi {
         url.searchParams.append("Ft-Calling-App", this.ftCallingApp);
         return url.toString();
     }
+    buildUrlFromParams(baseEndpoint, params) {
+        const url = new URL(this.makeAbsolute(baseEndpoint));
+        if (params) {
+            Object.entries(params).forEach(([key, value]) => {
+                if (value) {
+                    url.searchParams.append(key, value);
+                }
+            });
+        }
+        return url.toString();
+    }
+    buildTranslationParameters(translationSettings) {
+        if (translationSettings) {
+            return {
+                translationProfileId: translationSettings.profileId,
+                translationDestinationLanguage: translationSettings.destinationLanguage,
+                translationSourceLanguage: translationSettings.sourceLanguage?.slice(0, 2)
+            };
+        }
+    }
 }
 export default FluidTopicsApi;

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

@@ -134,7 +134,6 @@ export interface FtAnalyticsEvent {
     appVersion: string;
     appName: string;
     name: FtAnalyticsEventNameKeys;
-    version: string;
 }
 export declare const isFtAnalyticsEvent: (o: any) => o is FtAnalyticsEvent;
 export declare enum FtAnalyticsEventName {
@@ -359,6 +358,7 @@ export interface FtMap {
     originUrl?: string;
     fingerprint: string;
     readerUrl: string;
+    untranslatedTitle?: string;
     khubVersion?: string;
     id: string;
     lang?: string;
@@ -377,6 +377,7 @@ export interface FtTocNode {
     children: Array<FtTocNode>;
     origin?: FtTopicOrigin;
     contentId: string;
+    untranslatedTitle?: string;
     title: string;
 }
 export declare const isFtTocNode: (o: any) => o is FtTocNode;
@@ -427,6 +428,11 @@ export declare enum FtTopicContentTarget {
 }
 export type FtTopicContentTargetKeys = keyof typeof FtTopicContentTarget;
 export declare const isFtTopicContentTarget: (o: any) => o is FtTopicContentTarget;
+export interface FtTranslationContent {
+    isTranslationError: boolean;
+    content: string;
+}
+export declare const isFtTranslationContent: (o: any) => o is FtTranslationContent;
 export declare enum FtExternalWebComponentContext {
     HOMEPAGE = "HOMEPAGE",
     CUSTOM = "CUSTOM",

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

@@ -147,8 +147,7 @@ export const isFtAnalyticsEvent = (o) => {
         && (isBoolean(o.offline))
         && (isString(o.appVersion))
         && (isString(o.appName))
-        && (isFtAnalyticsEventName(o.name))
-        && (isString(o.version));
+        && (isFtAnalyticsEventName(o.name));
 };
 // From: WsAnalyticsEventName
 export var FtAnalyticsEventName;
@@ -386,6 +385,7 @@ export const isFtMap = (o) => {
         && (o.originUrl == null || isString(o.originUrl))
         && (isString(o.fingerprint))
         && (isString(o.readerUrl))
+        && (o.untranslatedTitle == null || o.untranslatedTitle == null || isString(o.untranslatedTitle))
         && (o.khubVersion == null || isString(o.khubVersion))
         && (isString(o.id))
         && (o.lang == null || isString(o.lang));
@@ -406,6 +406,7 @@ export const isFtTocNode = (o) => {
             && o.children.every((v) => isFtTocNode(v))))
         && (o.origin == null || isFtTopicOrigin(o.origin))
         && (isString(o.contentId))
+        && (o.untranslatedTitle == null || o.untranslatedTitle == null || isString(o.untranslatedTitle))
         && (isString(o.title));
 };
 export const isFtTopic = (o) => {
@@ -459,6 +460,11 @@ export var FtTopicContentTarget;
     FtTopicContentTarget["DESIGNED_READER"] = "DESIGNED_READER";
 })(FtTopicContentTarget || (FtTopicContentTarget = {}));
 export const isFtTopicContentTarget = (o) => Object.keys(FtTopicContentTarget).includes(o);
+export const isFtTranslationContent = (o) => {
+    return isObject(o)
+        && (isBoolean(o.isTranslationError))
+        && (isString(o.content));
+};
 // From: ExternalWebComponentContext
 export var FtExternalWebComponentContext;
 (function (FtExternalWebComponentContext) {

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

@@ -50,14 +50,27 @@ export declare enum TranslationFormat {
 }
 export type TranslationFormatKeys = keyof typeof TranslationFormat;
 export declare const isTranslationFormat: (o: any) => o is TranslationFormat;
-export interface FtTranslationInput {
+export interface FtTranslationLanguagesResponse {
+    items: Array<FtTranslationLocale>;
+}
+export declare const isFtTranslationLanguagesResponse: (o: any) => o is FtTranslationLanguagesResponse;
+export interface FtTranslationRequest {
     profileId: string;
     format?: TranslationFormatKeys;
     destinationLanguage: string;
-    content: string;
+    content: Array<string>;
     sourceLanguage?: string;
 }
-export declare const isFtTranslationInput: (o: any) => o is FtTranslationInput;
+export declare const isFtTranslationRequest: (o: any) => o is FtTranslationRequest;
+export interface FtTranslationResponse {
+    items: Array<string>;
+}
+export declare const isFtTranslationResponse: (o: any) => o is FtTranslationResponse;
+export interface FtTranslationLocale {
+    code: string;
+    label: string;
+}
+export declare const isFtTranslationLocale: (o: any) => o is FtTranslationLocale;
 export interface FtMapAttachment {
     file: string;
     size?: number;
@@ -76,6 +89,7 @@ export declare const isFtPageConfiguration: (o: any) => o is FtPageConfiguration
 export interface FtPaginatedToc {
     configuration: FtPaginationConfiguration;
     paginatedToc: Array<FtPaginatedTocNode>;
+    translationError: boolean;
 }
 export declare const isFtPaginatedToc: (o: any) => o is FtPaginatedToc;
 export interface FtPaginatedTocNode {
@@ -87,9 +101,15 @@ export interface FtPaginatedTocNode {
     pageConfiguration?: FtPageConfiguration;
     origin?: any;
     contentId?: string;
+    untranslatedTitle?: string;
     title?: string;
 }
 export declare const isFtPaginatedTocNode: (o: any) => o is FtPaginatedTocNode;
+export interface FtPaginatedTocNodeWithTranslationFailure {
+    paginatedToc: FtPaginatedTocNode;
+    translationError: boolean;
+}
+export declare const isFtPaginatedTocNodeWithTranslationFailure: (o: any) => o is FtPaginatedTocNodeWithTranslationFailure;
 export interface FtPaginationConfiguration {
     splitCurrentPageToc: boolean;
 }

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

@@ -62,14 +62,30 @@ export var TranslationFormat;
     TranslationFormat["HTML"] = "HTML";
 })(TranslationFormat || (TranslationFormat = {}));
 export const isTranslationFormat = (o) => Object.keys(TranslationFormat).includes(o);
-export const isFtTranslationInput = (o) => {
+export const isFtTranslationLanguagesResponse = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.items)
+            && o.items.every((v) => isFtTranslationLocale(v))));
+};
+export const isFtTranslationRequest = (o) => {
     return isObject(o)
         && (isString(o.profileId))
         && (o.format == null || isTranslationFormat(o.format))
         && (isString(o.destinationLanguage))
-        && (isString(o.content))
+        && ((Array.isArray(o.content)
+            && o.content.every((v) => isString(v))))
         && (o.sourceLanguage == null || isString(o.sourceLanguage));
 };
+export const isFtTranslationResponse = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.items)
+            && o.items.every((v) => isString(v))));
+};
+export const isFtTranslationLocale = (o) => {
+    return isObject(o)
+        && (isString(o.code))
+        && (isString(o.label));
+};
 export const isFtMapAttachment = (o) => {
     return isObject(o)
         && (isString(o.file))
@@ -90,7 +106,8 @@ export const isFtPaginatedToc = (o) => {
     return isObject(o)
         && (isFtPaginationConfiguration(o.configuration))
         && ((Array.isArray(o.paginatedToc)
-            && o.paginatedToc.every((v) => isFtPaginatedTocNode(v))));
+            && o.paginatedToc.every((v) => isFtPaginatedTocNode(v))))
+        && (isBoolean(o.translationError));
 };
 export const isFtPaginatedTocNode = (o) => {
     return isObject(o)
@@ -102,8 +119,14 @@ export const isFtPaginatedTocNode = (o) => {
             && o.children.every((v) => isFtPaginatedTocNode(v))))
         && (o.pageConfiguration == null || isFtPageConfiguration(o.pageConfiguration))
         && (o.contentId == null || isString(o.contentId))
+        && (o.untranslatedTitle == null || isString(o.untranslatedTitle))
         && (o.title == null || isString(o.title));
 };
+export const isFtPaginatedTocNodeWithTranslationFailure = (o) => {
+    return isObject(o)
+        && (isFtPaginatedTocNode(o.paginatedToc))
+        && (isBoolean(o.translationError));
+};
 export const isFtPaginationConfiguration = (o) => {
     return isObject(o)
         && (isBoolean(o.splitCurrentPageToc));

package/package.json

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