@fluid-topics/public-api 1.0.114 → 1.0.116

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

@@ -1,3 +1,4 @@
+import { FtTocNode, FtTopicOrigin, FtWatermark, FtMetadata } from "../ft-common/public";
 export declare enum FtConfigurationHistoryEntryStatus {
     VALID = "VALID",
     INVALID = "INVALID"
@@ -20,6 +21,42 @@ export interface FtReaderFeedbackConfiguration {
     subjectMetadataIds: Array<string>;
 }
 export declare const isFtReaderFeedbackConfiguration: (o: any) => o is FtReaderFeedbackConfiguration;
+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",
+    OTHER = "OTHER"
+}
+export type FtChatbotAdminRatingTagKeys = keyof typeof FtChatbotAdminRatingTag;
+export declare const isFtChatbotAdminRatingTag: (o: any) => o is FtChatbotAdminRatingTag;
+export declare enum FtChatbotUserRatingTag {
+    INACCURATE = "INACCURATE",
+    INCOMPLETE = "INCOMPLETE",
+    OFF_TOPIC = "OFF_TOPIC",
+    IRRELEVANT_SOURCES = "IRRELEVANT_SOURCES",
+    SLOW = "SLOW",
+    OTHER = "OTHER"
+}
+export type FtChatbotUserRatingTagKeys = keyof typeof FtChatbotUserRatingTag;
+export declare const isFtChatbotUserRatingTag: (o: any) => o is FtChatbotUserRatingTag;
+export interface FtGenAIChatbotAdminRating {
+    profileId: string;
+    comment?: string;
+    value: number;
+    tags?: Array<FtChatbotAdminRatingTagKeys>;
+}
+export declare const isFtGenAIChatbotAdminRating: (o: any) => o is FtGenAIChatbotAdminRating;
+export interface FtGenAIChatbotUserRating {
+    profileId: string;
+    comment?: string;
+    value: number;
+    tags?: Array<FtChatbotUserRatingTagKeys>;
+}
+export declare const isFtGenAIChatbotUserRating: (o: any) => o is FtGenAIChatbotUserRating;
 export interface FtGenAIRating {
     rating: number;
     comment: string;
@@ -130,7 +167,7 @@ export declare enum RagTraceMessageType {
 }
 export type RagTraceMessageTypeKeys = keyof typeof RagTraceMessageType;
 export declare const isRagTraceMessageType: (o: any) => o is RagTraceMessageType;
-export interface FtGenAIRagTraceAssistantMessage extends FtGenAIRagTraceDetailHistoryItem {
+export interface FtGenAIRagTraceAssistantMessage/* WsGenAIRagTraceAssistantMessage */  extends FtGenAIRagTraceDetailHistoryItem {
     chatbotInstructions: string;
     role: RagTraceMessageTypeKeys;
     semsearch: FtGenAIRagTraceSemsearch;
@@ -157,7 +194,7 @@ export interface FtGenAIRagTraceSemsearch {
     results: Array<FtSemanticSearchResponseItem>;
 }
 export declare const isFtGenAIRagTraceSemsearch: (o: any) => o is FtGenAIRagTraceSemsearch;
-export interface FtGenAIRagTraceUserMessage extends FtGenAIRagTraceDetailHistoryItem {
+export interface FtGenAIRagTraceUserMessage/* WsGenAIRagTraceUserMessage */  extends FtGenAIRagTraceDetailHistoryItem {
     role: RagTraceMessageTypeKeys;
     content: string;
     timestamp: string;
@@ -196,11 +233,22 @@ export interface FtMapAttachment {
     externalLink: boolean;
     name: string;
     id: string;
-    mimeType?: string;
-    viewerUrl?: string;
+    mimeType: string;
+    viewerUrl: string;
+    target: any;
+}
+export interface FtDocumentAttachment {
+    file: string;
+    size?: number;
+    externalLink: boolean;
+    name: string;
+    id: string;
+    mimeType: string;
+    viewerUrl: string;
     target: any;
 }
 export declare const isFtMapAttachment: (o: any) => o is FtMapAttachment;
+export declare const isFtDocumentAttachment: (o: any) => o is FtDocumentAttachment;
 export interface FtPageConfiguration {
     parentsVisibility?: Array<boolean>;
     isVisible: boolean;
@@ -215,11 +263,11 @@ export declare const isFtPaginatedToc: (o: any) => o is FtPaginatedToc;
 export interface FtPaginatedTocNode {
     prettyUrl?: string;
     hasRating?: boolean;
-    pageToc?: Array<any>;
+    pageToc?: Array<FtTocNode>;
     tocId?: string;
     children: Array<FtPaginatedTocNode>;
     pageConfiguration?: FtPageConfiguration;
-    origin?: any;
+    origin?: FtTopicOrigin;
     contentId?: string;
     untranslatedTitle?: string;
     title?: string;
@@ -263,24 +311,24 @@ export interface FtSemanticSearchResponseItem {
     relevance: number;
 }
 export declare const isFtSemanticSearchResponseItem: (o: any) => o is FtSemanticSearchResponseItem;
-export interface FtSemanticSearchAndFilter extends FtSemanticSearchFilter {
+export interface FtSemanticSearchAndFilter/* WsSemanticSearchAndFilter */  extends FtSemanticSearchFilter {
     and: Array<FtSemanticSearchFilter>;
 }
 export declare const isFtSemanticSearchAndFilter: (o: any) => o is FtSemanticSearchAndFilter;
 export interface FtSemanticSearchFilter {
 }
 export declare const isFtSemanticSearchFilter: (o: any) => o is FtSemanticSearchFilter;
-export interface FtSemanticSearchKeyValueFilter extends FtSemanticSearchFilter {
+export interface FtSemanticSearchKeyValueFilter/* WsSemanticSearchKeyValueFilter */  extends FtSemanticSearchFilter {
     values: Array<string>;
     hierarchicalValues: Array<Array<string>>;
     key: string;
 }
 export declare const isFtSemanticSearchKeyValueFilter: (o: any) => o is FtSemanticSearchKeyValueFilter;
-export interface FtSemanticSearchNotFilter extends FtSemanticSearchFilter {
+export interface FtSemanticSearchNotFilter/* WsSemanticSearchNotFilter */  extends FtSemanticSearchFilter {
     not: FtSemanticSearchFilter;
 }
 export declare const isFtSemanticSearchNotFilter: (o: any) => o is FtSemanticSearchNotFilter;
-export interface FtSemanticSearchOrFilter extends FtSemanticSearchFilter {
+export interface FtSemanticSearchOrFilter/* WsSemanticSearchOrFilter */  extends FtSemanticSearchFilter {
     or: Array<FtSemanticSearchFilter>;
 }
 export declare const isFtSemanticSearchOrFilter: (o: any) => o is FtSemanticSearchOrFilter;
@@ -291,3 +339,46 @@ export interface FtSemanticSearchRequest {
     nbResults?: number;
 }
 export declare const isFtSemanticSearchRequest: (o: any) => o is FtSemanticSearchRequest;
+export interface FtAssetDescriptor {
+    contentUrl: string;
+    filename: string;
+    watermark?: FtWatermark;
+    size: number;
+    displayName: string;
+    portalUrl: string;
+    fingerprint: string;
+    viewableInCurrentBrowser: boolean;
+    holder: FtAssetHolder;
+    id: string;
+    mimeType: string;
+}
+export interface FtMapResource {
+    contentUrl: string;
+    filename: string;
+    watermark?: FtWatermark;
+    size: number;
+    displayName: string;
+    portalUrl: string;
+    fingerprint: string;
+    viewableInCurrentBrowser: boolean;
+    holder: FtAssetHolder;
+    id: string;
+    mimeType: string;
+}
+export declare const isFtAssetDescriptor: (o: any) => o is FtAssetDescriptor;
+export declare const isFtMapResource: (o: any) => o is FtMapResource;
+export interface FtAssetHolder {
+    metadata: Array<FtMetadata>;
+    portalUrl: string;
+    id: string;
+    type: FtAssetHolderTypeKeys;
+    lang: string;
+    title: string;
+}
+export declare const isFtAssetHolder: (o: any) => o is FtAssetHolder;
+export declare enum FtAssetHolderType {
+    MAP = "MAP",
+    UNSTRUCTURED_DOCUMENT = "UNSTRUCTURED_DOCUMENT"
+}
+export type FtAssetHolderTypeKeys = keyof typeof FtAssetHolderType;
+export declare const isFtAssetHolderType: (o: any) => o is FtAssetHolderType;

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

@@ -2,7 +2,6 @@ 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
 export var FtConfigurationHistoryEntryStatus;
 (function (FtConfigurationHistoryEntryStatus) {
     FtConfigurationHistoryEntryStatus["VALID"] = "VALID";
@@ -28,6 +27,44 @@ export const isFtReaderFeedbackConfiguration = (o) => {
         && ((Array.isArray(o.subjectMetadataIds)
             && o.subjectMetadataIds.every((v) => isString(v))));
 };
+export var FtChatbotAdminRatingTag;
+(function (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["OTHER"] = "OTHER";
+})(FtChatbotAdminRatingTag || (FtChatbotAdminRatingTag = {}));
+export const isFtChatbotAdminRatingTag = (o) => Object.keys(FtChatbotAdminRatingTag).includes(o);
+export var FtChatbotUserRatingTag;
+(function (FtChatbotUserRatingTag) {
+    FtChatbotUserRatingTag["INACCURATE"] = "INACCURATE";
+    FtChatbotUserRatingTag["INCOMPLETE"] = "INCOMPLETE";
+    FtChatbotUserRatingTag["OFF_TOPIC"] = "OFF_TOPIC";
+    FtChatbotUserRatingTag["IRRELEVANT_SOURCES"] = "IRRELEVANT_SOURCES";
+    FtChatbotUserRatingTag["SLOW"] = "SLOW";
+    FtChatbotUserRatingTag["OTHER"] = "OTHER";
+})(FtChatbotUserRatingTag || (FtChatbotUserRatingTag = {}));
+export const isFtChatbotUserRatingTag = (o) => Object.keys(FtChatbotUserRatingTag).includes(o);
+export const isFtGenAIChatbotAdminRating = (o) => {
+    return isObject(o)
+        && (isString(o.profileId))
+        && (o.comment == null || isString(o.comment))
+        && (isNumber(o.value))
+        && (o.tags == null || (Array.isArray(o.tags)
+            && o.tags.every((v) => isFtChatbotAdminRatingTag(v))));
+};
+export const isFtGenAIChatbotUserRating = (o) => {
+    return isObject(o)
+        && (isString(o.profileId))
+        && (o.comment == null || isString(o.comment))
+        && (isNumber(o.value))
+        && (o.tags == null || (Array.isArray(o.tags)
+            && o.tags.every((v) => isFtChatbotUserRatingTag(v))));
+};
 export const isFtGenAIRating = (o) => {
     return isObject(o)
         && (isNumber(o.rating))
@@ -41,7 +78,6 @@ export const isFtGenAIGenerateInput = (o) => {
             && Object.keys(o.parameters).every((k) => isString(k))
             && Object.values(o.parameters).every((v) => isString(v))));
 };
-// From: RagResponseFormat
 export var FtRagResponseFormat;
 (function (FtRagResponseFormat) {
     FtRagResponseFormat["JSON"] = "JSON";
@@ -219,8 +255,18 @@ export const isFtMapAttachment = (o) => {
         && (isBoolean(o.externalLink))
         && (isString(o.name))
         && (isString(o.id))
-        && (o.mimeType == null || isString(o.mimeType))
-        && (o.viewerUrl == null || isString(o.viewerUrl));
+        && (isString(o.mimeType))
+        && (isString(o.viewerUrl));
+};
+export const isFtDocumentAttachment = (o) => {
+    return isObject(o)
+        && (isString(o.file))
+        && (o.size == null || isNumber(o.size))
+        && (isBoolean(o.externalLink))
+        && (isString(o.name))
+        && (isString(o.id))
+        && (isString(o.mimeType))
+        && (isString(o.viewerUrl));
 };
 export const isFtPageConfiguration = (o) => {
     return isObject(o)
@@ -257,7 +303,6 @@ export const isFtPaginationConfiguration = (o) => {
     return isObject(o)
         && (isBoolean(o.splitCurrentPageToc));
 };
-// From: WsTopicContentFormat
 export var FtTopicContentFormat;
 (function (FtTopicContentFormat) {
     FtTopicContentFormat["HTML"] = "HTML";
@@ -329,3 +374,44 @@ export const isFtSemanticSearchRequest = (o) => {
             && o.filters.every((v) => isFtSemanticSearchFilter(v))))
         && (o.nbResults == null || isNumber(o.nbResults));
 };
+export const isFtAssetDescriptor = (o) => {
+    return isObject(o)
+        && (isString(o.contentUrl))
+        && (isString(o.filename))
+        && (isNumber(o.size))
+        && (isString(o.displayName))
+        && (isString(o.portalUrl))
+        && (isString(o.fingerprint))
+        && (isBoolean(o.viewableInCurrentBrowser))
+        && (isFtAssetHolder(o.holder))
+        && (isString(o.id))
+        && (isString(o.mimeType));
+};
+export const isFtMapResource = (o) => {
+    return isObject(o)
+        && (isString(o.contentUrl))
+        && (isString(o.filename))
+        && (isNumber(o.size))
+        && (isString(o.displayName))
+        && (isString(o.portalUrl))
+        && (isString(o.fingerprint))
+        && (isBoolean(o.viewableInCurrentBrowser))
+        && (isFtAssetHolder(o.holder))
+        && (isString(o.id))
+        && (isString(o.mimeType));
+};
+export const isFtAssetHolder = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.metadata)))
+        && (isString(o.portalUrl))
+        && (isString(o.id))
+        && (isFtAssetHolderType(o.type))
+        && (isString(o.lang))
+        && (isString(o.title));
+};
+export var FtAssetHolderType;
+(function (FtAssetHolderType) {
+    FtAssetHolderType["MAP"] = "MAP";
+    FtAssetHolderType["UNSTRUCTURED_DOCUMENT"] = "UNSTRUCTURED_DOCUMENT";
+})(FtAssetHolderType || (FtAssetHolderType = {}));
+export const isFtAssetHolderType = (o) => Object.keys(FtAssetHolderType).includes(o);

package/package.json

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