@fluid-topics/public-api 1.0.75 → 1.0.76

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

@@ -1,146 +0,0 @@
-"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.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";
-const isString = (o) => typeof o === "string";
-// From: ConfigurationHistoryEntryStatus
-var FtConfigurationHistoryEntryStatus;
-(function (FtConfigurationHistoryEntryStatus) {
-    FtConfigurationHistoryEntryStatus["VALID"] = "VALID";
-    FtConfigurationHistoryEntryStatus["INVALID"] = "INVALID";
-})(FtConfigurationHistoryEntryStatus = exports.FtConfigurationHistoryEntryStatus || (exports.FtConfigurationHistoryEntryStatus = {}));
-const isFtConfigurationHistoryEntryStatus = (o) => {
-    return ["VALID", "INVALID"].includes(o);
-};
-exports.isFtConfigurationHistoryEntryStatus = isFtConfigurationHistoryEntryStatus;
-const isFtReaderConfiguration = (o) => {
-    return isObject(o)
-        && ((0, exports.isFtReaderFeedbackConfiguration)(o.feedback))
-        && (isNumber(o.loadAfterLastVisibleTopic))
-        && (isString(o.relativeTopicPivotMetadata))
-        && (isNumber(o.loadBeforeFirstVisibleTopic))
-        && (isString(o.relativePivotMetadata));
-};
-exports.isFtReaderConfiguration = isFtReaderConfiguration;
-const isFtReaderFeedbackConfiguration = (o) => {
-    return isObject(o)
-        && (isBoolean(o.mailsSentByFluidTopics))
-        && (isBoolean(o.mailsSentByFluidTopicsForUnauthenticatedUsers))
-        && ((Array.isArray(o.recipients)
-            && o.recipients.every((v) => isString(v))))
-        && ((Array.isArray(o.bodyMetadataIds)
-            && o.bodyMetadataIds.every((v) => isString(v))))
-        && ((Array.isArray(o.subjectMetadataIds)
-            && o.subjectMetadataIds.every((v) => isString(v))));
-};
-exports.isFtReaderFeedbackConfiguration = isFtReaderFeedbackConfiguration;
-const isFtGenAIRating = (o) => {
-    return isObject(o)
-        && (isNumber(o.rating))
-        && (isString(o.comment))
-        && (isString(o.queryId));
-};
-exports.isFtGenAIRating = isFtGenAIRating;
-const isFtGenAIGenerateInput = (o) => {
-    return isObject(o)
-        && (isString(o.profileId))
-        && (o.parameters == null || (isObject(o.parameters)
-            && Object.keys(o.parameters).every((k) => isString(k))
-            && Object.values(o.parameters).every((v) => isString(v))));
-};
-exports.isFtGenAIGenerateInput = isFtGenAIGenerateInput;
-const isFtRagHistory = (o) => {
-    return isObject(o)
-        && (isString(o.role))
-        && (isString(o.content));
-};
-exports.isFtRagHistory = isFtRagHistory;
-const isFtRagInput = (o) => {
-    return isObject(o)
-        && (isString(o.profileId))
-        && (o.conversationId == null || isString(o.conversationId))
-        && (isString(o.query))
-        && (o.messages == null || (Array.isArray(o.messages)
-            && o.messages.every((v) => (0, exports.isFtRagHistory)(v))))
-        && (o.filters == null || (Array.isArray(o.filters)
-            && o.filters.every((v) => (0, exports.isFtSemanticSearchFilter)(v))));
-};
-exports.isFtRagInput = isFtRagInput;
-const isFtMapAttachment = (o) => {
-    return isObject(o)
-        && (isString(o.file))
-        && (o.size == null || isNumber(o.size))
-        && (isBoolean(o.externalLink))
-        && (isString(o.name))
-        && (isString(o.id))
-        && (o.mimeType == null || isString(o.mimeType))
-        && (o.viewerUrl == null || isString(o.viewerUrl));
-};
-exports.isFtMapAttachment = isFtMapAttachment;
-const isFtPageConfiguration = (o) => {
-    return isObject(o)
-        && (o.parentsVisibility == null || (Array.isArray(o.parentsVisibility)
-            && o.parentsVisibility.every((v) => isBoolean(v))))
-        && (isBoolean(o.isVisible));
-};
-exports.isFtPageConfiguration = isFtPageConfiguration;
-const isFtPaginatedToc = (o) => {
-    return isObject(o)
-        && ((0, exports.isFtPaginationConfiguration)(o.configuration))
-        && ((Array.isArray(o.paginatedToc)
-            && o.paginatedToc.every((v) => (0, exports.isFtPaginatedTocNode)(v))));
-};
-exports.isFtPaginatedToc = isFtPaginatedToc;
-const isFtPaginatedTocNode = (o) => {
-    return isObject(o)
-        && (o.prettyUrl == null || isString(o.prettyUrl))
-        && (o.hasRating == null || isBoolean(o.hasRating))
-        && (o.pageToc == null || (Array.isArray(o.pageToc)))
-        && (o.tocId == null || isString(o.tocId))
-        && ((Array.isArray(o.children)
-            && o.children.every((v) => (0, exports.isFtPaginatedTocNode)(v))))
-        && (o.pageConfiguration == null || (0, exports.isFtPageConfiguration)(o.pageConfiguration))
-        && (o.contentId == null || isString(o.contentId))
-        && (o.title == null || isString(o.title));
-};
-exports.isFtPaginatedTocNode = isFtPaginatedTocNode;
-const isFtPaginationConfiguration = (o) => {
-    return isObject(o)
-        && (isBoolean(o.splitCurrentPageToc));
-};
-exports.isFtPaginationConfiguration = isFtPaginationConfiguration;
-const isFtClusteredSemanticSearchReply = (o) => {
-    return isObject(o)
-        && ((Array.isArray(o.documents)
-            && o.documents.every((v) => (0, exports.isFtSemanticSearchResponseItem)(v))))
-        && ((Array.isArray(o.clusterId)
-            && o.clusterId.every((v) => isString(v))));
-};
-exports.isFtClusteredSemanticSearchReply = isFtClusteredSemanticSearchReply;
-const isFtSemanticSearchResponseItem = (o) => {
-    return isObject(o)
-        && ((isObject(o.metadata)
-            && Object.keys(o.metadata).every((k) => isString(k))
-            && Object.values(o.metadata).every((v) => (Array.isArray(v)
-                && v.every((v) => isString(v))))))
-        && (isString(o.excerpt))
-        && (isNumber(o.relevance));
-};
-exports.isFtSemanticSearchResponseItem = isFtSemanticSearchResponseItem;
-const isFtSemanticSearchFilter = (o) => {
-    return isObject(o)
-        && ((Array.isArray(o.values)
-            && o.values.every((v) => isString(v))))
-        && (isString(o.key));
-};
-exports.isFtSemanticSearchFilter = isFtSemanticSearchFilter;
-const isFtSemanticSearchRequest = (o) => {
-    return isObject(o)
-        && (isString(o.query))
-        && (o.filters == null || (Array.isArray(o.filters)
-            && o.filters.every((v) => (0, exports.isFtSemanticSearchFilter)(v))))
-        && (o.nbResults == null || isNumber(o.nbResults));
-};
-exports.isFtSemanticSearchRequest = isFtSemanticSearchRequest;

package/build/mjs/helpers/GenAIChunkReader.d.ts

@@ -1,19 +0,0 @@
-export interface GenAIChunk {
-    id?: string;
-    message?: string;
-    error?: {
-        code: number;
-        name: string;
-        message: string;
-    };
-}
-export declare class GenAIChunkReader {
-    private readonly reader;
-    private decoder;
-    private partialChunk;
-    constructor(reader: ReadableStreamDefaultReader<Uint8Array>);
-    read(): AsyncGenerator<GenAIChunk>;
-    private readRemainingChunks;
-    private readChunksFromValue;
-    private parseLine;
-}

package/build/mjs/helpers/GenAIChunkReader.js

@@ -1,37 +0,0 @@
-export class GenAIChunkReader {
-    reader;
-    decoder = new TextDecoder();
-    partialChunk = "";
-    constructor(reader) {
-        this.reader = reader;
-    }
-    async *read() {
-        while (true) {
-            const { done, value } = await this.reader.read();
-            if (done) {
-                yield* this.readRemainingChunks();
-                return;
-            }
-            else {
-                yield* this.readChunksFromValue(value);
-            }
-        }
-    }
-    *readRemainingChunks() {
-        yield* this.parseLine(this.partialChunk);
-    }
-    *readChunksFromValue(value) {
-        const text = this.partialChunk + this.decoder.decode(value);
-        const lines = text.split("\n");
-        this.partialChunk = lines.pop();
-        for (let line of lines) {
-            yield* this.parseLine(line);
-        }
-    }
-    *parseLine(line) {
-        const [type, content] = line.split(/:(.*)/);
-        if (type == "data" && content.length > 0) {
-            yield JSON.parse(content);
-        }
-    }
-}

package/build/mjs/index.d.ts

@@ -1,190 +0,0 @@
-import { FtAuthenticatedSession, FtBookmark, FtCollectionDocument, FtHttpErrorDetails, FtMap, FtMapResource, FtMessageContext, FtMetadataConfiguration, FtMySearch, FtRatingSummary, FtRatingType, FtRatingTypeKeys, FtSearchLocales, FtSearchRequest, FtSearchResults, FtSession, FtSuggestRequest, FtSuggestResults, FtTocNode, FtTopic, FtTopicContentTarget, FtTopicContentTargetKeys, FtUiLocale, FtUnstructuredDocument } from "./types/ft-common/public";
-import { FtClusteredSemanticSearchReply, FtGenAIRating, FtMapAttachment, FtPaginatedToc, FtRagInput, FtReaderConfiguration, FtSemanticSearchRequest, FtSemanticSearchResponseItem } from "./types/ft-server/public";
-import { GenAIChunk } from "./helpers/GenAIChunkReader";
-export * from "./types/ft-common/public";
-export * from "./types/ft-server/public";
-export * from "./roles/roles";
-export * from "./preferences/unauthenticated-preferences";
-export declare class HttpError extends Error {
-    readonly method: string;
-    readonly endpoint: string;
-    readonly status: number;
-    readonly statusText: string;
-    readonly body: string;
-    constructor(method: string, endpoint: string, status: number, statusText: string, body: string);
-}
-export declare class HttpErrorEvent extends CustomEvent<FtHttpErrorDetails> {
-    constructor(e: FtHttpErrorDetails);
-}
-export declare class FluidTopicsApi {
-    readonly tenantBaseUrl: string;
-    readonly tenantBaseUrlNoTrailingSlash: string;
-    private readonly ftCallingApp;
-    private authorization?;
-    private searchLabel?;
-    readonly endpoints: {
-        authentication: {
-            login: string;
-            logout: string;
-            currentSession: string;
-        };
-        khub: {
-            maps: {
-                mapId: (mapId: string) => {
-                    info: string;
-                    toc: string;
-                    pages: string;
-                    feedback: string;
-                    rating: string;
-                    attachments: {
-                        list: string;
-                        attachmentId: (attachmentId: string) => {
-                            content: string;
-                        };
-                    };
-                    resources: {
-                        list: string;
-                        resourceId: (resourceId: string) => {
-                            content: string;
-                        };
-                    };
-                    topics: {
-                        contentId: (contentId: string) => {
-                            info: string;
-                            content: string;
-                        };
-                        tocId: (tocId: string) => {
-                            feedback: string;
-                            rating: string;
-                        };
-                    };
-                };
-            };
-            documents: {
-                documentId: (documentId: string) => {
-                    info: string;
-                    content: string;
-                    text: string;
-                    feedback: string;
-                    rating: string;
-                };
-            };
-            semantic: {
-                search: string;
-                clusteredSearch: string;
-            };
-            suggest: string;
-            clusteredSearch: string;
-            locales: string;
-        };
-        users: {
-            userId: (userId: string) => {
-                collections: {
-                    collectionId: (collectionId: string) => {
-                        documents: string;
-                    };
-                };
-                searches: {
-                    list: string;
-                };
-                bookmarks: {
-                    list: string;
-                };
-            };
-        };
-        stylesheets: {
-            fonts: string;
-            theme: string;
-            content: {
-                title: string;
-                topic: string;
-            };
-        };
-        configuration: {
-            reader: string;
-            metadata: string;
-        };
-        locales: {
-            ui: string;
-        };
-        messages: {
-            locale: (locale: string) => {
-                fluidTopics: {
-                    contextName: (contextName: string) => {
-                        endpoint: string;
-                    };
-                };
-                custom: {
-                    contextName: (contextName: string) => {
-                        endpoint: string;
-                    };
-                };
-            };
-        };
-        ai: {
-            generate: string;
-            sendFeedback: string;
-            chat: string;
-        };
-    };
-    private get defaultHeaders();
-    constructor(tenantBaseUrl: string, integrationIdentifier: string, overrideIdentifierIfOnTenant?: boolean);
-    setApiKey(apiKey: string): void;
-    setCredentials(login: string, password: string): void;
-    clearAuthentication(): void;
-    setSearchLabel(searchLabel: string): void;
-    clearSearchLabel(): void;
-    login(login: string, password: string): Promise<FtAuthenticatedSession>;
-    logout(): Promise<void>;
-    getCurrentSession(): Promise<FtSession>;
-    getReaderConfiguration(): Promise<FtReaderConfiguration>;
-    getMap(mapId: string, v?: string): Promise<FtMap>;
-    getTableOfContent(mapId: string, v?: string): Promise<Array<FtTocNode>>;
-    getPages(mapId: string, v?: string): Promise<FtPaginatedToc>;
-    getTopic(mapId: string, topicContentId: string, v?: string): Promise<FtTopic>;
-    getTopicHTMLContent(mapId: string, topicContentId: string, target?: FtTopicContentTarget | FtTopicContentTargetKeys, v?: string): Promise<string>;
-    getMapAttachments(mapId: string, v?: string): Promise<Array<FtMapAttachment>>;
-    getMapAttachmentContent(mapId: string, attachmentId: string, v?: string): Promise<ArrayBuffer>;
-    getMapResources(mapId: string, v?: string): Promise<Array<FtMapResource>>;
-    getMapResourceContent(mapId: string, resourceId: string, v?: string): Promise<ArrayBuffer>;
-    getUnstructuredDocument(documentId: string, v?: string): Promise<FtUnstructuredDocument>;
-    getUnstructuredDocumentContent(documentId: string, v?: string): Promise<ArrayBuffer>;
-    getUnstructuredDocumentTextContent(documentId: string, v?: string): Promise<string>;
-    getCollectionDocuments(userId: string, collectionId: string): Promise<Array<FtCollectionDocument>>;
-    getSuggestions(request: FtSuggestRequest): Promise<FtSuggestResults>;
-    search(request: FtSearchRequest): Promise<FtSearchResults>;
-    getAvailableSearchLocales(): Promise<FtSearchLocales>;
-    getAvailableUiLocales(): Promise<Array<FtUiLocale>>;
-    getMetadataConfiguration(): Promise<FtMetadataConfiguration>;
-    getMapRating(mapId: string): Promise<FtRatingSummary>;
-    rateMap(mapId: string, type: FtRatingType | FtRatingTypeKeys, value: number): Promise<void>;
-    unrateMap(mapId: string): Promise<void>;
-    sendMapFeedback(mapId: string, message: string, from?: string): Promise<void>;
-    rateTopic(mapId: string, tocId: string, type: FtRatingType | FtRatingTypeKeys, value: number): Promise<void>;
-    unrateTopic(mapId: string, tocId: string): Promise<void>;
-    sendTopicFeedback(mapId: string, tocId: string, message: string, from?: string): Promise<void>;
-    getDocumentRating(docId: string): Promise<FtRatingSummary>;
-    rateDocument(docId: string, type: FtRatingType | FtRatingTypeKeys, value: number): Promise<void>;
-    unrateDocument(docId: string): Promise<void>;
-    sendDocumentFeedback(docId: string, message: string, from?: string): Promise<void>;
-    semanticSearch(request: FtSemanticSearchRequest): Promise<FtSemanticSearchResponseItem[]>;
-    clusteredSemanticSearch(request: FtSemanticSearchRequest): Promise<FtClusteredSemanticSearchReply>;
-    getFluidTopicsMessageContext(locale: string, name: string): Promise<FtMessageContext>;
-    getCustomMessageContext(locale: string, name: string): Promise<FtMessageContext>;
-    listMySearches(userId: string): Promise<FtMySearch[]>;
-    listMyBookmarks(userId: string): Promise<FtBookmark[]>;
-    generate(profileId: string, parameters?: Record<string, string>): AsyncGenerator<GenAIChunk>;
-    chat(input: FtRagInput): AsyncGenerator<GenAIChunk>;
-    sendFeedback(rating: FtGenAIRating): Promise<unknown>;
-    get<T>(endpoint: string, v?: string): Promise<T>;
-    post<T>(endpoint: string, data?: any): Promise<T>;
-    put<T>(endpoint: string, data?: any): Promise<T>;
-    delete<T>(endpoint: string): Promise<T>;
-    makeAbsolute(endpoint: string): string;
-    fetch<FetchRequestInit, FetchResponse>(endpoint: string, init?: FetchRequestInit): Promise<FetchResponse>;
-    upload<T>(method: string, endpoint: string, body: any, onProgress?: (e: any) => void): Promise<T>;
-    private makeRequest;
-    private fetchRawData;
-    withVersion(endpoint: string, v: string | undefined): string;
-}
-export default FluidTopicsApi;