@fluid-topics/public-api 1.0.13 → 1.0.16

package/dist/cjs/index.js

@@ -47,10 +47,15 @@ function getBody(response) {
     return response.headers.get("Content-Type") === "application/json" ? response.json() : response.text();
 }
 class FluidTopicsApi {
-    constructor(tenantBaseUrl, integrationIdentifier) {
+    constructor(tenantBaseUrl, integrationIdentifier, overrideIdentifierIfOnTenant) {
         this.authorization = {};
         this.tenantBaseUrl = tenantBaseUrl.trim().replace(/\/$/, "");
-        this.ftCallingApp = `ft-public-api/${integrationIdentifier}`;
+        if (overrideIdentifierIfOnTenant && typeof window !== "undefined" && window.location.href.startsWith(tenantBaseUrl)) {
+            this.ftCallingApp = integrationIdentifier;
+        }
+        else {
+            this.ftCallingApp = `ft-public-api/${integrationIdentifier}`;
+        }
     }
     get defaultHeaders() {
         return Object.assign(Object.assign({}, this.authorization), { "Ft-Calling-App": this.ftCallingApp });
@@ -116,6 +121,15 @@ class FluidTopicsApi {
     getCollectionDocuments(userId, collectionId) {
         return this.get(`/api/users/${userId}/collections/${collectionId}/documents`);
     }
+    getSuggestions(request) {
+        return this.post("/api/khub/suggest", request);
+    }
+    search(request) {
+        return this.post("/api/khub/clustered-search", request);
+    }
+    getAvailableSearchLocales() {
+        return this.get("/api/khub/locales");
+    }
     get(endpoint) {
         return this.makeRequest("GET", endpoint);
     }
@@ -138,6 +152,25 @@ class FluidTopicsApi {
             return yield fetch(this.tenantBaseUrl + endpoint, Object.assign(Object.assign({}, (requestInit !== null && requestInit !== void 0 ? requestInit : {})), { headers: Object.assign(Object.assign({}, this.defaultHeaders), ((_a = requestInit === null || requestInit === void 0 ? void 0 : requestInit.headers) !== null && _a !== void 0 ? _a : {})) }));
         });
     }
+    upload(method, endpoint, body, onProgress = () => { }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                let xhr = new XMLHttpRequest();
+                xhr.onload = () => {
+                    if (xhr.status >= 200 && xhr.status < 300) {
+                        let data = xhr.getResponseHeader("Content-Type") === "application/json" ? JSON.parse(xhr.responseText) : xhr.responseText;
+                        resolve(data);
+                    }
+                    else {
+                        reject(new HttpError(xhr.status, xhr.statusText, xhr.responseText));
+                    }
+                };
+                xhr.upload.onprogress = (e) => onProgress(e);
+                xhr.open(method, this.tenantBaseUrl + endpoint, true);
+                xhr.send(body);
+            });
+        });
+    }
     makeRequest(method, endpoint, data) {
         return this.fetch(endpoint, {
             method: method,

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFtAuthenticationIdentifier = exports.isFtSearchResultType = exports.FtSearchResultType = exports.isFtOpenMode = exports.FtOpenMode = exports.isFtEditorialType = exports.FtEditorialType = exports.isFtMapResource = exports.isFtMetadata = exports.isFtTopicContentTarget = exports.FtTopicContentTarget = exports.isFtUnstructuredDocument = exports.isFtTopic = exports.isFtTocNode = exports.isFtMap = exports.isFtCollectionDocument = exports.isFtCredentials = void 0;
+exports.isFtAuthenticationIdentifier = exports.isFtSuggestResults = exports.isFtSuggestResult = exports.isFtSuggestRequest = exports.isFtTopicResource = exports.isFtSpellcheck = exports.isFtSearchSortCriterion = exports.isFtSearchFacetEntry = exports.isFtSearchFacetConf = exports.isFtSearchFacet = exports.isFtSearchResultType = exports.FtSearchResultType = exports.isFtSearchResultTopic = exports.isFtSearchResultMap = exports.isFtSearchResultUnstructuredDocument = exports.isFtSearchResultClusterEntry = exports.isFtSearchResultCluster = exports.isFtSearchRequest = exports.isFtSearchResults = exports.isFtCollectionDocumentType = exports.FtCollectionDocumentType = exports.isFtPageRequest = exports.isFtOpenMode = exports.FtOpenMode = exports.isFtEditorialType = exports.FtEditorialType = exports.isFtSearchResultsPageInfo = exports.isFtSearchPreset = exports.isFtSearchFilter = exports.isFtMapResource = exports.isFtMetadata = exports.isFtSearchLocales = exports.isFtSearchLocale = exports.isFtTopicContentTarget = exports.FtTopicContentTarget = exports.isFtUnstructuredDocument = exports.isFtTopic = exports.isFtTocNode = exports.isFtMap = exports.isFtCollectionDocument = exports.isFtCredentials = void 0;
 const isObject = (o) => typeof o === "object" && o != null;
 const isBoolean = (o) => typeof o === "boolean";
 const isNumber = (o) => typeof o === "number";
@@ -20,7 +20,7 @@ const isFtCollectionDocument = (o) => {
         && (o.portalUrl == null || isString(o.portalUrl))
         && (isString(o.id))
         && (isString(o.title))
-        && ((0, exports.isFtSearchResultType)(o.type));
+        && ((0, exports.isFtCollectionDocumentType)(o.type));
 };
 exports.isFtCollectionDocument = isFtCollectionDocument;
 const isFtMap = (o) => {
@@ -99,6 +99,19 @@ const isFtTopicContentTarget = (o) => {
     return ["THIRD_PARTY", "OFF_THE_GRID"].includes(o);
 };
 exports.isFtTopicContentTarget = isFtTopicContentTarget;
+const isFtSearchLocale = (o) => {
+    return isObject(o)
+        && (isNumber(o.count))
+        && (isString(o.label))
+        && (o.lang == null || isString(o.lang));
+};
+exports.isFtSearchLocale = isFtSearchLocale;
+const isFtSearchLocales = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.contentLocales)
+            && o.contentLocales.every((v) => (0, exports.isFtSearchLocale)(v))));
+};
+exports.isFtSearchLocales = isFtSearchLocales;
 const isFtMetadata = (o) => {
     return isObject(o)
         && ((Array.isArray(o.values)
@@ -115,6 +128,30 @@ const isFtMapResource = (o) => {
         && (isString(o.mimeType));
 };
 exports.isFtMapResource = isFtMapResource;
+const isFtSearchFilter = (o) => {
+    return isObject(o)
+        && (isBoolean(o.negative))
+        && ((Array.isArray(o.values)
+            && o.values.every((v) => isString(v))))
+        && (isString(o.key));
+};
+exports.isFtSearchFilter = isFtSearchFilter;
+const isFtSearchPreset = (o) => {
+    return isObject(o)
+        && (isString(o.name))
+        && ((Array.isArray(o.filters)
+            && o.filters.every((v) => (0, exports.isFtSearchFilter)(v))))
+        && (o.contentLocale == null || isString(o.contentLocale));
+};
+exports.isFtSearchPreset = isFtSearchPreset;
+const isFtSearchResultsPageInfo = (o) => {
+    return isObject(o)
+        && (isNumber(o.totalResultsCount))
+        && (isBoolean(o.lastPage))
+        && (isNumber(o.currentPage))
+        && (isNumber(o.totalClustersCount));
+};
+exports.isFtSearchResultsPageInfo = isFtSearchResultsPageInfo;
 // From: WsEditorialType
 var FtEditorialType;
 (function (FtEditorialType) {
@@ -135,6 +172,123 @@ const isFtOpenMode = (o) => {
     return ["FLUIDTOPICS", "EXTERNAL"].includes(o);
 };
 exports.isFtOpenMode = isFtOpenMode;
+const isFtPageRequest = (o) => {
+    return isObject(o)
+        && (o.perPage == null || isNumber(o.perPage))
+        && (isNumber(o.page));
+};
+exports.isFtPageRequest = isFtPageRequest;
+// From: WsPublicCollectionDocumentType
+var FtCollectionDocumentType;
+(function (FtCollectionDocumentType) {
+    FtCollectionDocumentType["MAP"] = "MAP";
+    FtCollectionDocumentType["DOCUMENT"] = "DOCUMENT";
+    FtCollectionDocumentType["TOPIC"] = "TOPIC";
+    FtCollectionDocumentType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
+    FtCollectionDocumentType["SHARED_BOOK"] = "SHARED_BOOK";
+})(FtCollectionDocumentType = exports.FtCollectionDocumentType || (exports.FtCollectionDocumentType = {}));
+const isFtCollectionDocumentType = (o) => {
+    return ["MAP", "DOCUMENT", "TOPIC", "PERSONAL_BOOK", "SHARED_BOOK"].includes(o);
+};
+exports.isFtCollectionDocumentType = isFtCollectionDocumentType;
+const isFtSearchResults = (o) => {
+    return isObject(o)
+        && (o.spellcheck == null || (0, exports.isFtSpellcheck)(o.spellcheck))
+        && ((0, exports.isFtSearchResultsPageInfo)(o.paging))
+        && ((Array.isArray(o.results)
+            && o.results.every((v) => (0, exports.isFtSearchResultCluster)(v))))
+        && ((Array.isArray(o.facets)
+            && o.facets.every((v) => (0, exports.isFtSearchFacet)(v))));
+};
+exports.isFtSearchResults = isFtSearchResults;
+const isFtSearchRequest = (o) => {
+    return isObject(o)
+        && (isString(o.query))
+        && ((0, exports.isFtPageRequest)(o.paging))
+        && ((Array.isArray(o.filters)
+            && o.filters.every((v) => (0, exports.isFtSearchFilter)(v))))
+        && ((Array.isArray(o.sort)
+            && o.sort.every((v) => (0, exports.isFtSearchSortCriterion)(v))))
+        && (o.uiLocale == null || isString(o.uiLocale))
+        && (o.contentLocale == null || isString(o.contentLocale))
+        && ((Array.isArray(o.facets)
+            && o.facets.every((v) => (0, exports.isFtSearchFacetConf)(v))));
+};
+exports.isFtSearchRequest = isFtSearchRequest;
+const isFtSearchResultCluster = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.entries)
+            && o.entries.every((v) => (0, exports.isFtSearchResultClusterEntry)(v))))
+        && (o.metadataVariableAxis == null || isString(o.metadataVariableAxis));
+};
+exports.isFtSearchResultCluster = isFtSearchResultCluster;
+const isFtSearchResultClusterEntry = (o) => {
+    return isObject(o)
+        && (o.document == null || (0, exports.isFtSearchResultUnstructuredDocument)(o.document))
+        && (o.topic == null || (0, exports.isFtSearchResultTopic)(o.topic))
+        && ((0, exports.isFtSearchResultType)(o.type))
+        && (o.map == null || (0, exports.isFtSearchResultMap)(o.map));
+};
+exports.isFtSearchResultClusterEntry = isFtSearchResultClusterEntry;
+const isFtSearchResultUnstructuredDocument = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.metadata)
+            && o.metadata.every((v) => (0, exports.isFtMetadata)(v))))
+        && ((0, exports.isFtOpenMode)(o.openMode))
+        && (isString(o.documentUrl))
+        && (isString(o.mimeType))
+        && (isString(o.title))
+        && (o.lastPublicationDate == null || isString(o.lastPublicationDate))
+        && (isString(o.viewerUrl))
+        && (isString(o.contentUrl))
+        && (isString(o.filename))
+        && (isString(o.htmlTitle))
+        && (o.originUrl == null || isString(o.originUrl))
+        && (isString(o.documentId))
+        && (isString(o.lastEditionDate))
+        && (isString(o.htmlExcerpt));
+};
+exports.isFtSearchResultUnstructuredDocument = isFtSearchResultUnstructuredDocument;
+const isFtSearchResultMap = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.metadata)
+            && o.metadata.every((v) => (0, exports.isFtMetadata)(v))))
+        && ((0, exports.isFtOpenMode)(o.openMode))
+        && ((0, exports.isFtEditorialType)(o.editorialType))
+        && (isString(o.title))
+        && (o.lastPublicationDate == null || isString(o.lastPublicationDate))
+        && (isString(o.htmlTitle))
+        && (o.originUrl == null || isString(o.originUrl))
+        && (isString(o.mapUrl))
+        && (isString(o.readerUrl))
+        && (isString(o.mapId))
+        && (o.lastEditionDate == null || isString(o.lastEditionDate))
+        && (isString(o.htmlExcerpt));
+};
+exports.isFtSearchResultMap = isFtSearchResultMap;
+const isFtSearchResultTopic = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.metadata)
+            && o.metadata.every((v) => (0, exports.isFtMetadata)(v))))
+        && ((0, exports.isFtOpenMode)(o.openMode))
+        && (isString(o.contentId))
+        && ((Array.isArray(o.resources)
+            && o.resources.every((v) => (0, exports.isFtTopicResource)(v))))
+        && (isString(o.title))
+        && (isString(o.mapTitle))
+        && (isString(o.topicUrl))
+        && (isString(o.contentUrl))
+        && (isString(o.htmlTitle))
+        && ((Array.isArray(o.breadcrumb)
+            && o.breadcrumb.every((v) => isString(v))))
+        && (isString(o.tocId))
+        && (o.originUrl == null || isString(o.originUrl))
+        && (isString(o.readerUrl))
+        && (isString(o.mapId))
+        && (o.lastEditionDate == null || isString(o.lastEditionDate))
+        && (isString(o.htmlExcerpt));
+};
+exports.isFtSearchResultTopic = isFtSearchResultTopic;
 // From: WsPublicSearchResultType
 var FtSearchResultType;
 (function (FtSearchResultType) {
@@ -146,6 +300,80 @@ const isFtSearchResultType = (o) => {
     return ["MAP", "DOCUMENT", "TOPIC"].includes(o);
 };
 exports.isFtSearchResultType = isFtSearchResultType;
+const isFtSearchFacet = (o) => {
+    return isObject(o)
+        && (isBoolean(o.hierarchical))
+        && (isString(o.label))
+        && (isBoolean(o.multiSelectionable))
+        && (isString(o.key))
+        && ((Array.isArray(o.rootNodes)
+            && o.rootNodes.every((v) => (0, exports.isFtSearchFacetEntry)(v))));
+};
+exports.isFtSearchFacet = isFtSearchFacet;
+const isFtSearchFacetConf = (o) => {
+    return isObject(o)
+        && (o.maxDepth == null || isNumber(o.maxDepth))
+        && (isString(o.id));
+};
+exports.isFtSearchFacetConf = isFtSearchFacetConf;
+const isFtSearchFacetEntry = (o) => {
+    return isObject(o)
+        && (isNumber(o.totalResultsCount))
+        && (isBoolean(o.descendantSelected))
+        && ((Array.isArray(o.childNodes)
+            && o.childNodes.every((v) => (0, exports.isFtSearchFacetEntry)(v))))
+        && (isString(o.label))
+        && (isString(o.value))
+        && (isBoolean(o.selected));
+};
+exports.isFtSearchFacetEntry = isFtSearchFacetEntry;
+const isFtSearchSortCriterion = (o) => {
+    return isObject(o)
+        && (isString(o.key));
+};
+exports.isFtSearchSortCriterion = isFtSearchSortCriterion;
+const isFtSpellcheck = (o) => {
+    return isObject(o)
+        && (isString(o.suggestedQuery))
+        && (isString(o.htmlSuggestedQuery));
+};
+exports.isFtSpellcheck = isFtSpellcheck;
+const isFtTopicResource = (o) => {
+    return isObject(o)
+        && (isString(o.filename))
+        && (isString(o.resourceUrl))
+        && (isString(o.id))
+        && (isString(o.mimeType))
+        && (isString(o.resourceContentUrl))
+        && (isString(o.viewerUrl));
+};
+exports.isFtTopicResource = isFtTopicResource;
+const isFtSuggestRequest = (o) => {
+    return isObject(o)
+        && (isString(o.input))
+        && ((Array.isArray(o.filters)
+            && o.filters.every((v) => (0, exports.isFtSearchFilter)(v))))
+        && ((Array.isArray(o.sort)
+            && o.sort.every((v) => (0, exports.isFtSearchSortCriterion)(v))))
+        && (o.maxCount == null || isNumber(o.maxCount))
+        && (o.contentLocale == null || isString(o.contentLocale));
+};
+exports.isFtSuggestRequest = isFtSuggestRequest;
+const isFtSuggestResult = (o) => {
+    return isObject(o)
+        && (o.filenameExtension == null || isString(o.filenameExtension))
+        && (o.editorialType == null || (0, exports.isFtEditorialType)(o.editorialType))
+        && (o.mimeType == null || isString(o.mimeType))
+        && ((0, exports.isFtSearchResultType)(o.type))
+        && (isString(o.value));
+};
+exports.isFtSuggestResult = isFtSuggestResult;
+const isFtSuggestResults = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.suggestions)
+            && o.suggestions.every((v) => (0, exports.isFtSuggestResult)(v))));
+};
+exports.isFtSuggestResults = isFtSuggestResults;
 const isFtAuthenticationIdentifier = (o) => {
     return isObject(o)
         && (isString(o.identifier))

package/dist/fluidtopics.min.js

@@ -1 +1 @@
-!function(t,e){"object"==typeof exports&&"undefined"!=typeof module?e(exports):"function"==typeof define&&define.amd?define(["exports"],e):e((t="undefined"!=typeof globalThis?globalThis:t||self).fluidtopics={})}(this,(function(t){"use strict";var e="undefined"!=typeof globalThis?globalThis:"undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n={exports:{}},i={exports:{}};!function(t,e){var n=function(){if("undefined"!=typeof self)return self;if("undefined"!=typeof window)return window;if(void 0!==n)return n;throw new Error("unable to locate global object")}();t.exports=e=n.fetch,n.fetch&&(e.default=n.fetch.bind(n)),e.Headers=n.Headers,e.Request=n.Request,e.Response=n.Response}(i,i.exports),function(t,e){const n=i.exports,r=n.default||n,s=function(t,e){return/^\/\//.test(t)&&(t="https:"+t),r.call(this,t,e)};s.ponyfill=!0,t.exports=e=s,e.fetch=s,e.Headers=n.Headers,e.Request=n.Request,e.Response=n.Response,e.default=s}(n,n.exports);const r=n.exports,s=r.fetch.bind({});s.polyfill=!0,e.fetch||(e.fetch=s,e.Response=r.Response,e.Headers=r.Headers,e.Request=r.Request);const a=t=>"object"==typeof t&&null!=t,o=t=>"boolean"==typeof t,l=t=>"string"==typeof t,u=t=>a(t)&&l(t.tocId)&&Array.isArray(t.children)&&t.children.every((t=>u(t)))&&l(t.contentId)&&l(t.title);var p;t.FtTopicContentTarget=void 0,(p=t.FtTopicContentTarget||(t.FtTopicContentTarget={})).THIRD_PARTY="THIRD_PARTY",p.OFF_THE_GRID="OFF_THE_GRID";const d=t=>a(t)&&Array.isArray(t.values)&&t.values.every((t=>l(t)))&&l(t.label)&&l(t.key);var c;t.FtEditorialType=void 0,(c=t.FtEditorialType||(t.FtEditorialType={})).ARTICLE="ARTICLE",c.BOOK="BOOK";const h=t=>["ARTICLE","BOOK"].includes(t);var f;t.FtOpenMode=void 0,(f=t.FtOpenMode||(t.FtOpenMode={})).FLUIDTOPICS="FLUIDTOPICS",f.EXTERNAL="EXTERNAL";const y=t=>["FLUIDTOPICS","EXTERNAL"].includes(t);var T;t.FtSearchResultType=void 0,(T=t.FtSearchResultType||(t.FtSearchResultType={})).MAP="MAP",T.DOCUMENT="DOCUMENT",T.TOPIC="TOPIC";const g=t=>["MAP","DOCUMENT","TOPIC"].includes(t),m=t=>"object"==typeof t&&null!=t,b=t=>"string"==typeof t,A=t=>m(t)&&(null==t.emailAddress||b(t.emailAddress))&&(null==t.displayName||b(t.displayName))&&Array.isArray(t.roles)&&b(t.userId);class R extends Error{status;statusText;body;constructor(t,e,n){super(`${t} - ${e}: ${n}`),this.status=t,this.statusText=e,this.body=n}}async function F(t){if(!t.ok)throw new R(t.status,t.statusText,await t.text());return t}function E(t){return"application/json"===t.headers.get("Content-Type")?t.json():t.text()}class C{tenantBaseUrl;ftCallingApp;authorization={};get defaultHeaders(){return{...this.authorization,"Ft-Calling-App":this.ftCallingApp}}constructor(t,e){this.tenantBaseUrl=t.trim().replace(/\/$/,""),this.ftCallingApp=`ft-public-api/${e}`}setApiKey(t){this.authorization={Authorization:"Bearer "+t}}setCredentials(t,e){var n;this.authorization={Authorization:"Basic "+(n=`${t}:${e}`,"undefined"!=typeof Buffer?Buffer.from(n).toString("base64"):btoa(n))}}clearAuthentication(){this.authorization={}}login(t,e){let n={login:t,password:e,rememberMe:!0};return this.post("/api/authentication/login",n).then((n=>(this.setCredentials(t,e),n)))}logout(){return this.post("/api/authentication/logout").then((()=>this.clearAuthentication()))}getMap(t){return this.get(`/api/khub/maps/${t}`)}getTableOfContent(t){return this.get(`/api/khub/maps/${t}/toc`)}getTopic(t,e){return this.get(`/api/khub/maps/${t}/topics/${e}`)}getTopicHTMLContent(t,e,n){return this.get(`/api/khub/maps/${t}/topics/${e}/content${n?"?target="+n:""}`)}getMapAttachments(t){return this.get(`/api/khub/maps/${t}/attachments`)}getMapAttachmentContent(t,e){return this.fetchRawData(`/api/khub/maps/${t}/attachments/${e}/content`)}getMapResources(t){return this.get(`/api/khub/maps/${t}/resources`)}getMapResourceContent(t,e){return this.fetchRawData(`/api/khub/maps/${t}/resources/${e}/content`)}getUnstructuredDocument(t){return this.get(`/api/khub/documents/${t}`)}getUnstructuredDocumentContent(t){return this.fetchRawData(`/api/khub/documents/${t}/content`)}getUnstructuredDocumentTextContent(t){return this.get(`/api/khub/documents/${t}/content/text`)}getCollectionDocuments(t,e){return this.get(`/api/users/${t}/collections/${e}/documents`)}get(t){return this.makeRequest("GET",t)}post(t,e){return this.makeRequest("POST",t,e)}put(t,e){return this.makeRequest("PUT",t,e)}delete(t){return this.makeRequest("DELETE",t)}async fetch(t,e){const n=e;return t.startsWith("/")||(t="/"+t),await fetch(this.tenantBaseUrl+t,{...n??{},headers:{...this.defaultHeaders,...n?.headers??{}}})}makeRequest(t,e,n){return this.fetch(e,{method:t,headers:{...null!=n?{"Content-Type":"application/json"}:{}},body:null!=n?JSON.stringify(n):void 0}).then(F).then(E)}fetchRawData(t){return fetch(this.tenantBaseUrl+t,{headers:this.defaultHeaders}).then(F).then((t=>t.arrayBuffer()))}}t.FluidTopicsApi=C,t.HttpError=R,t.default=C,t.isFtAuthenticatedSession=t=>m(t)&&A(t.profile),t.isFtAuthenticationIdentifier=t=>a(t)&&l(t.identifier)&&l(t.realm),t.isFtCollectionDocument=t=>a(t)&&o(t.deleted)&&(null==t.apiUrl||l(t.apiUrl))&&(null==t.portalUrl||l(t.portalUrl))&&l(t.id)&&l(t.title)&&g(t.type),t.isFtCredentials=t=>a(t)&&l(t.password)&&(null==t.newPassword||l(t.newPassword))&&o(t.rememberMe)&&l(t.login),t.isFtEditorialType=h,t.isFtMap=t=>a(t)&&(null==t.prettyUrl||l(t.prettyUrl))&&Array.isArray(t.metadata)&&t.metadata.every((t=>d(t)))&&y(t.openMode)&&l(t.topicsApiEndpoint)&&(null==t.description||l(t.description))&&l(t.attachmentsApiEndpoint)&&h(t.editorialType)&&l(t.baseId)&&l(t.clusterId)&&l(t.title)&&l(t.lastPublication)&&l(t.lastEdition)&&l(t.originId)&&l(t.rightsApiEndpoint)&&(null==t.originUrl||l(t.originUrl))&&l(t.readerUrl)&&(null==t.khubVersion||l(t.khubVersion))&&l(t.id)&&(null==t.lang||l(t.lang)),t.isFtMapAttachment=t=>m(t)&&b(t.file)&&(null==t.size||(t=>"number"==typeof t)(t.size))&&(t=>"boolean"==typeof t)(t.externalLink)&&b(t.name)&&b(t.id)&&(null==t.mimeType||b(t.mimeType))&&(null==t.viewerUrl||b(t.viewerUrl)),t.isFtMapResource=t=>a(t)&&l(t.contentUrl)&&l(t.filename)&&l(t.id)&&l(t.mimeType),t.isFtMetadata=d,t.isFtOpenMode=y,t.isFtSearchResultType=g,t.isFtTocNode=u,t.isFtTopic=t=>a(t)&&Array.isArray(t.metadata)&&t.metadata.every((t=>d(t)))&&l(t.id)&&l(t.contentApiEndpoint)&&l(t.title),t.isFtTopicContentTarget=t=>["THIRD_PARTY","OFF_THE_GRID"].includes(t),t.isFtUnstructuredDocument=t=>a(t)&&(null==t.prettyUrl||l(t.prettyUrl))&&Array.isArray(t.metadata)&&t.metadata.every((t=>d(t)))&&l(t.openMode)&&(null==t.description||l(t.description))&&l(t.mimeType)&&(null==t.baseId||l(t.baseId))&&(null==t.clusterId||l(t.clusterId))&&l(t.contentApiEndpoint)&&l(t.title)&&(null==t.lastPublication||l(t.lastPublication))&&l(t.viewerUrl)&&l(t.lastEdition)&&l(t.filename)&&(null==t.originId||l(t.originId))&&l(t.rightsApiEndpoint)&&(null==t.originUrl||l(t.originUrl))&&(null==t.khubVersion||l(t.khubVersion))&&l(t.id)&&(null==t.lang||l(t.lang)),t.isFtUserProfile=A}));
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).fluidtopics={})}(this,(function(e){"use strict";var t="undefined"!=typeof globalThis?globalThis:"undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},r={exports:{}},i={exports:{}};!function(e,t){var r=function(){if("undefined"!=typeof self)return self;if("undefined"!=typeof window)return window;if(void 0!==r)return r;throw new Error("unable to locate global object")}();e.exports=t=r.fetch,r.fetch&&(t.default=r.fetch.bind(r)),t.Headers=r.Headers,t.Request=r.Request,t.Response=r.Response}(i,i.exports),function(e,t){const r=i.exports,a=r.default||r,n=function(e,t){return/^\/\//.test(e)&&(e="https:"+e),a.call(this,e,t)};n.ponyfill=!0,e.exports=t=n,t.fetch=n,t.Headers=r.Headers,t.Request=r.Request,t.Response=r.Response,t.default=n}(r,r.exports);const a=r.exports,n=a.fetch.bind({});n.polyfill=!0,t.fetch||(t.fetch=n,t.Response=a.Response,t.Headers=a.Headers,t.Request=a.Request);const s=e=>"object"==typeof e&&null!=e,l=e=>"boolean"==typeof e,o=e=>"number"==typeof e,u=e=>"string"==typeof e,c=e=>s(e)&&u(e.tocId)&&Array.isArray(e.children)&&e.children.every((e=>c(e)))&&u(e.contentId)&&u(e.title);var p;e.FtTopicContentTarget=void 0,(p=e.FtTopicContentTarget||(e.FtTopicContentTarget={})).THIRD_PARTY="THIRD_PARTY",p.OFF_THE_GRID="OFF_THE_GRID";const d=e=>s(e)&&o(e.count)&&u(e.label)&&(null==e.lang||u(e.lang)),h=e=>s(e)&&Array.isArray(e.values)&&e.values.every((e=>u(e)))&&u(e.label)&&u(e.key),y=e=>s(e)&&l(e.negative)&&Array.isArray(e.values)&&e.values.every((e=>u(e)))&&u(e.key),f=e=>s(e)&&o(e.totalResultsCount)&&l(e.lastPage)&&o(e.currentPage)&&o(e.totalClustersCount);var m;e.FtEditorialType=void 0,(m=e.FtEditorialType||(e.FtEditorialType={})).ARTICLE="ARTICLE",m.BOOK="BOOK";const g=e=>["ARTICLE","BOOK"].includes(e);var A;e.FtOpenMode=void 0,(A=e.FtOpenMode||(e.FtOpenMode={})).FLUIDTOPICS="FLUIDTOPICS",A.EXTERNAL="EXTERNAL";const T=e=>["FLUIDTOPICS","EXTERNAL"].includes(e),F=e=>s(e)&&(null==e.perPage||o(e.perPage))&&o(e.page);var b;e.FtCollectionDocumentType=void 0,(b=e.FtCollectionDocumentType||(e.FtCollectionDocumentType={})).MAP="MAP",b.DOCUMENT="DOCUMENT",b.TOPIC="TOPIC",b.PERSONAL_BOOK="PERSONAL_BOOK",b.SHARED_BOOK="SHARED_BOOK";const R=e=>["MAP","DOCUMENT","TOPIC","PERSONAL_BOOK","SHARED_BOOK"].includes(e),C=e=>s(e)&&Array.isArray(e.entries)&&e.entries.every((e=>E(e)))&&(null==e.metadataVariableAxis||u(e.metadataVariableAxis)),E=e=>s(e)&&(null==e.document||U(e.document))&&(null==e.topic||O(e.topic))&&S(e.type)&&(null==e.map||v(e.map)),U=e=>s(e)&&Array.isArray(e.metadata)&&e.metadata.every((e=>h(e)))&&T(e.openMode)&&u(e.documentUrl)&&u(e.mimeType)&&u(e.title)&&(null==e.lastPublicationDate||u(e.lastPublicationDate))&&u(e.viewerUrl)&&u(e.contentUrl)&&u(e.filename)&&u(e.htmlTitle)&&(null==e.originUrl||u(e.originUrl))&&u(e.documentId)&&u(e.lastEditionDate)&&u(e.htmlExcerpt),v=e=>s(e)&&Array.isArray(e.metadata)&&e.metadata.every((e=>h(e)))&&T(e.openMode)&&g(e.editorialType)&&u(e.title)&&(null==e.lastPublicationDate||u(e.lastPublicationDate))&&u(e.htmlTitle)&&(null==e.originUrl||u(e.originUrl))&&u(e.mapUrl)&&u(e.readerUrl)&&u(e.mapId)&&(null==e.lastEditionDate||u(e.lastEditionDate))&&u(e.htmlExcerpt),O=e=>s(e)&&Array.isArray(e.metadata)&&e.metadata.every((e=>h(e)))&&T(e.openMode)&&u(e.contentId)&&Array.isArray(e.resources)&&e.resources.every((e=>k(e)))&&u(e.title)&&u(e.mapTitle)&&u(e.topicUrl)&&u(e.contentUrl)&&u(e.htmlTitle)&&Array.isArray(e.breadcrumb)&&e.breadcrumb.every((e=>u(e)))&&u(e.tocId)&&(null==e.originUrl||u(e.originUrl))&&u(e.readerUrl)&&u(e.mapId)&&(null==e.lastEditionDate||u(e.lastEditionDate))&&u(e.htmlExcerpt);var D;e.FtSearchResultType=void 0,(D=e.FtSearchResultType||(e.FtSearchResultType={})).MAP="MAP",D.DOCUMENT="DOCUMENT",D.TOPIC="TOPIC";const S=e=>["MAP","DOCUMENT","TOPIC"].includes(e),P=e=>s(e)&&l(e.hierarchical)&&u(e.label)&&l(e.multiSelectionable)&&u(e.key)&&Array.isArray(e.rootNodes)&&e.rootNodes.every((e=>w(e))),I=e=>s(e)&&(null==e.maxDepth||o(e.maxDepth))&&u(e.id),w=e=>s(e)&&o(e.totalResultsCount)&&l(e.descendantSelected)&&Array.isArray(e.childNodes)&&e.childNodes.every((e=>w(e)))&&u(e.label)&&u(e.value)&&l(e.selected),x=e=>s(e)&&u(e.key),M=e=>s(e)&&u(e.suggestedQuery)&&u(e.htmlSuggestedQuery),k=e=>s(e)&&u(e.filename)&&u(e.resourceUrl)&&u(e.id)&&u(e.mimeType)&&u(e.resourceContentUrl)&&u(e.viewerUrl),L=e=>s(e)&&(null==e.filenameExtension||u(e.filenameExtension))&&(null==e.editorialType||g(e.editorialType))&&(null==e.mimeType||u(e.mimeType))&&S(e.type)&&u(e.value),$=e=>"object"==typeof e&&null!=e,H=e=>"string"==typeof e,N=e=>$(e)&&(null==e.emailAddress||H(e.emailAddress))&&(null==e.displayName||H(e.displayName))&&Array.isArray(e.roles)&&H(e.userId);class B extends Error{status;statusText;body;constructor(e,t,r){super(`${e} - ${t}: ${r}`),this.status=e,this.statusText=t,this.body=r}}async function q(e){if(!e.ok)throw new B(e.status,e.statusText,await e.text());return e}function _(e){return"application/json"===e.headers.get("Content-Type")?e.json():e.text()}class K{tenantBaseUrl;ftCallingApp;authorization={};get defaultHeaders(){return{...this.authorization,"Ft-Calling-App":this.ftCallingApp}}constructor(e,t,r){this.tenantBaseUrl=e.trim().replace(/\/$/,""),r&&"undefined"!=typeof window&&window.location.href.startsWith(e)?this.ftCallingApp=t:this.ftCallingApp=`ft-public-api/${t}`}setApiKey(e){this.authorization={Authorization:"Bearer "+e}}setCredentials(e,t){var r;this.authorization={Authorization:"Basic "+(r=`${e}:${t}`,"undefined"!=typeof Buffer?Buffer.from(r).toString("base64"):btoa(r))}}clearAuthentication(){this.authorization={}}login(e,t){let r={login:e,password:t,rememberMe:!0};return this.post("/api/authentication/login",r).then((r=>(this.setCredentials(e,t),r)))}logout(){return this.post("/api/authentication/logout").then((()=>this.clearAuthentication()))}getMap(e){return this.get(`/api/khub/maps/${e}`)}getTableOfContent(e){return this.get(`/api/khub/maps/${e}/toc`)}getTopic(e,t){return this.get(`/api/khub/maps/${e}/topics/${t}`)}getTopicHTMLContent(e,t,r){return this.get(`/api/khub/maps/${e}/topics/${t}/content${r?"?target="+r:""}`)}getMapAttachments(e){return this.get(`/api/khub/maps/${e}/attachments`)}getMapAttachmentContent(e,t){return this.fetchRawData(`/api/khub/maps/${e}/attachments/${t}/content`)}getMapResources(e){return this.get(`/api/khub/maps/${e}/resources`)}getMapResourceContent(e,t){return this.fetchRawData(`/api/khub/maps/${e}/resources/${t}/content`)}getUnstructuredDocument(e){return this.get(`/api/khub/documents/${e}`)}getUnstructuredDocumentContent(e){return this.fetchRawData(`/api/khub/documents/${e}/content`)}getUnstructuredDocumentTextContent(e){return this.get(`/api/khub/documents/${e}/content/text`)}getCollectionDocuments(e,t){return this.get(`/api/users/${e}/collections/${t}/documents`)}getSuggestions(e){return this.post("/api/khub/suggest",e)}search(e){return this.post("/api/khub/clustered-search",e)}getAvailableSearchLocales(){return this.get("/api/khub/locales")}get(e){return this.makeRequest("GET",e)}post(e,t){return this.makeRequest("POST",e,t)}put(e,t){return this.makeRequest("PUT",e,t)}delete(e){return this.makeRequest("DELETE",e)}async fetch(e,t){const r=t;return e.startsWith("/")||(e="/"+e),await fetch(this.tenantBaseUrl+e,{...r??{},headers:{...this.defaultHeaders,...r?.headers??{}}})}async upload(e,t,r,i=(()=>{})){return new Promise(((a,n)=>{let s=new XMLHttpRequest;s.onload=()=>{if(s.status>=200&&s.status<300){let e="application/json"===s.getResponseHeader("Content-Type")?JSON.parse(s.responseText):s.responseText;a(e)}else n(new B(s.status,s.statusText,s.responseText))},s.upload.onprogress=e=>i(e),s.open(e,this.tenantBaseUrl+t,!0),s.send(r)}))}makeRequest(e,t,r){return this.fetch(t,{method:e,headers:{...null!=r?{"Content-Type":"application/json"}:{}},body:null!=r?JSON.stringify(r):void 0}).then(q).then(_)}fetchRawData(e){return fetch(this.tenantBaseUrl+e,{headers:this.defaultHeaders}).then(q).then((e=>e.arrayBuffer()))}}e.FluidTopicsApi=K,e.HttpError=B,e.default=K,e.isFtAuthenticatedSession=e=>$(e)&&N(e.profile),e.isFtAuthenticationIdentifier=e=>s(e)&&u(e.identifier)&&u(e.realm),e.isFtCollectionDocument=e=>s(e)&&l(e.deleted)&&(null==e.apiUrl||u(e.apiUrl))&&(null==e.portalUrl||u(e.portalUrl))&&u(e.id)&&u(e.title)&&R(e.type),e.isFtCollectionDocumentType=R,e.isFtCredentials=e=>s(e)&&u(e.password)&&(null==e.newPassword||u(e.newPassword))&&l(e.rememberMe)&&u(e.login),e.isFtEditorialType=g,e.isFtMap=e=>s(e)&&(null==e.prettyUrl||u(e.prettyUrl))&&Array.isArray(e.metadata)&&e.metadata.every((e=>h(e)))&&T(e.openMode)&&u(e.topicsApiEndpoint)&&(null==e.description||u(e.description))&&u(e.attachmentsApiEndpoint)&&g(e.editorialType)&&u(e.baseId)&&u(e.clusterId)&&u(e.title)&&u(e.lastPublication)&&u(e.lastEdition)&&u(e.originId)&&u(e.rightsApiEndpoint)&&(null==e.originUrl||u(e.originUrl))&&u(e.readerUrl)&&(null==e.khubVersion||u(e.khubVersion))&&u(e.id)&&(null==e.lang||u(e.lang)),e.isFtMapAttachment=e=>$(e)&&H(e.file)&&(null==e.size||(e=>"number"==typeof e)(e.size))&&(e=>"boolean"==typeof e)(e.externalLink)&&H(e.name)&&H(e.id)&&(null==e.mimeType||H(e.mimeType))&&(null==e.viewerUrl||H(e.viewerUrl)),e.isFtMapResource=e=>s(e)&&u(e.contentUrl)&&u(e.filename)&&u(e.id)&&u(e.mimeType),e.isFtMetadata=h,e.isFtOpenMode=T,e.isFtPageRequest=F,e.isFtSearchFacet=P,e.isFtSearchFacetConf=I,e.isFtSearchFacetEntry=w,e.isFtSearchFilter=y,e.isFtSearchLocale=d,e.isFtSearchLocales=e=>s(e)&&Array.isArray(e.contentLocales)&&e.contentLocales.every((e=>d(e))),e.isFtSearchPreset=e=>s(e)&&u(e.name)&&Array.isArray(e.filters)&&e.filters.every((e=>y(e)))&&(null==e.contentLocale||u(e.contentLocale)),e.isFtSearchRequest=e=>s(e)&&u(e.query)&&F(e.paging)&&Array.isArray(e.filters)&&e.filters.every((e=>y(e)))&&Array.isArray(e.sort)&&e.sort.every((e=>x(e)))&&(null==e.uiLocale||u(e.uiLocale))&&(null==e.contentLocale||u(e.contentLocale))&&Array.isArray(e.facets)&&e.facets.every((e=>I(e))),e.isFtSearchResultCluster=C,e.isFtSearchResultClusterEntry=E,e.isFtSearchResultMap=v,e.isFtSearchResultTopic=O,e.isFtSearchResultType=S,e.isFtSearchResultUnstructuredDocument=U,e.isFtSearchResults=e=>s(e)&&(null==e.spellcheck||M(e.spellcheck))&&f(e.paging)&&Array.isArray(e.results)&&e.results.every((e=>C(e)))&&Array.isArray(e.facets)&&e.facets.every((e=>P(e))),e.isFtSearchResultsPageInfo=f,e.isFtSearchSortCriterion=x,e.isFtSpellcheck=M,e.isFtSuggestRequest=e=>s(e)&&u(e.input)&&Array.isArray(e.filters)&&e.filters.every((e=>y(e)))&&Array.isArray(e.sort)&&e.sort.every((e=>x(e)))&&(null==e.maxCount||o(e.maxCount))&&(null==e.contentLocale||u(e.contentLocale)),e.isFtSuggestResult=L,e.isFtSuggestResults=e=>s(e)&&Array.isArray(e.suggestions)&&e.suggestions.every((e=>L(e))),e.isFtTocNode=c,e.isFtTopic=e=>s(e)&&Array.isArray(e.metadata)&&e.metadata.every((e=>h(e)))&&u(e.id)&&u(e.contentApiEndpoint)&&u(e.title),e.isFtTopicContentTarget=e=>["THIRD_PARTY","OFF_THE_GRID"].includes(e),e.isFtTopicResource=k,e.isFtUnstructuredDocument=e=>s(e)&&(null==e.prettyUrl||u(e.prettyUrl))&&Array.isArray(e.metadata)&&e.metadata.every((e=>h(e)))&&u(e.openMode)&&(null==e.description||u(e.description))&&u(e.mimeType)&&(null==e.baseId||u(e.baseId))&&(null==e.clusterId||u(e.clusterId))&&u(e.contentApiEndpoint)&&u(e.title)&&(null==e.lastPublication||u(e.lastPublication))&&u(e.viewerUrl)&&u(e.lastEdition)&&u(e.filename)&&(null==e.originId||u(e.originId))&&u(e.rightsApiEndpoint)&&(null==e.originUrl||u(e.originUrl))&&(null==e.khubVersion||u(e.khubVersion))&&u(e.id)&&(null==e.lang||u(e.lang)),e.isFtUserProfile=N}));

package/dist/mjs/index.d.ts

@@ -1,5 +1,5 @@
 import "cross-fetch/polyfill";
-import { FtCollectionDocument, FtMap, FtMapResource, FtTocNode, FtTopic, FtTopicContentTarget, FtUnstructuredDocument } from "./types/ft-common/public";
+import { FtCollectionDocument, FtMap, FtMapResource, FtSearchLocales, FtSearchRequest, FtSearchResults, FtSuggestRequest, FtSuggestResults, FtTocNode, FtTopic, FtTopicContentTarget, FtUnstructuredDocument } from "./types/ft-common/public";
 import { FtAuthenticatedSession, FtMapAttachment } from "./types/ft-server/public";
 export * from "./types/ft-common/public";
 export * from "./types/ft-server/public";
@@ -14,7 +14,7 @@ export declare class FluidTopicsApi {
     private readonly ftCallingApp;
     private authorization;
     private get defaultHeaders();
-    constructor(tenantBaseUrl: string, integrationIdentifier: string);
+    constructor(tenantBaseUrl: string, integrationIdentifier: string, overrideIdentifierIfOnTenant?: boolean);
     setApiKey(apiKey: string): void;
     setCredentials(login: string, password: string): void;
     clearAuthentication(): void;
@@ -32,11 +32,15 @@ export declare class FluidTopicsApi {
     getUnstructuredDocumentContent(documentId: string): Promise<ArrayBuffer>;
     getUnstructuredDocumentTextContent(documentId: string): Promise<string>;
     getCollectionDocuments(userId: string, collectionId: string): Promise<Array<FtCollectionDocument>>;
+    getSuggestions(request: FtSuggestRequest): Promise<FtSuggestResults>;
+    search(request: FtSearchRequest): Promise<FtSearchResults>;
+    getAvailableSearchLocales(): Promise<FtSearchLocales>;
     get<T>(endpoint: 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>;
     fetch<FetchRequestInit, FetchResponse>(endpoint: string, init?: FetchRequestInit): Promise<FetchResponse>;
+    upload<T>(method: string, endpoint: string, body: Document | XMLHttpRequestBodyInit, onProgress?: (e: ProgressEvent) => void): Promise<T>;
     private makeRequest;
     private fetchRawData;
 }

package/dist/mjs/index.js

@@ -34,9 +34,14 @@ export class FluidTopicsApi {
             "Ft-Calling-App": this.ftCallingApp
         };
     }
-    constructor(tenantBaseUrl, integrationIdentifier) {
+    constructor(tenantBaseUrl, integrationIdentifier, overrideIdentifierIfOnTenant) {
         this.tenantBaseUrl = tenantBaseUrl.trim().replace(/\/$/, "");
-        this.ftCallingApp = `ft-public-api/${integrationIdentifier}`;
+        if (overrideIdentifierIfOnTenant && typeof window !== "undefined" && window.location.href.startsWith(tenantBaseUrl)) {
+            this.ftCallingApp = integrationIdentifier;
+        }
+        else {
+            this.ftCallingApp = `ft-public-api/${integrationIdentifier}`;
+        }
     }
     setApiKey(apiKey) {
         this.authorization = { "Authorization": "Bearer " + apiKey };
@@ -99,6 +104,15 @@ export class FluidTopicsApi {
     getCollectionDocuments(userId, collectionId) {
         return this.get(`/api/users/${userId}/collections/${collectionId}/documents`);
     }
+    getSuggestions(request) {
+        return this.post("/api/khub/suggest", request);
+    }
+    search(request) {
+        return this.post("/api/khub/clustered-search", request);
+    }
+    getAvailableSearchLocales() {
+        return this.get("/api/khub/locales");
+    }
     get(endpoint) {
         return this.makeRequest("GET", endpoint);
     }
@@ -124,6 +138,23 @@ export class FluidTopicsApi {
             }
         });
     }
+    async upload(method, endpoint, body, onProgress = () => { }) {
+        return new Promise((resolve, reject) => {
+            let xhr = new XMLHttpRequest();
+            xhr.onload = () => {
+                if (xhr.status >= 200 && xhr.status < 300) {
+                    let data = xhr.getResponseHeader("Content-Type") === "application/json" ? JSON.parse(xhr.responseText) : xhr.responseText;
+                    resolve(data);
+                }
+                else {
+                    reject(new HttpError(xhr.status, xhr.statusText, xhr.responseText));
+                }
+            };
+            xhr.upload.onprogress = (e) => onProgress(e);
+            xhr.open(method, this.tenantBaseUrl + endpoint, true);
+            xhr.send(body);
+        });
+    }
     makeRequest(method, endpoint, data) {
         return this.fetch(endpoint, {
             method: method,

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

@@ -11,7 +11,7 @@ export interface FtCollectionDocument {
     portalUrl?: string;
     id: string;
     title: string;
-    type: FtSearchResultType;
+    type: FtCollectionDocumentType;
 }
 export declare const isFtCollectionDocument: (o: any) => o is FtCollectionDocument;
 export interface FtMap {
@@ -77,6 +77,16 @@ export declare enum FtTopicContentTarget {
     OFF_THE_GRID = "OFF_THE_GRID"
 }
 export declare const isFtTopicContentTarget: (o: any) => o is FtTopicContentTarget;
+export interface FtSearchLocale {
+    count: number;
+    label: string;
+    lang?: string;
+}
+export declare const isFtSearchLocale: (o: any) => o is FtSearchLocale;
+export interface FtSearchLocales {
+    contentLocales: Array<FtSearchLocale>;
+}
+export declare const isFtSearchLocales: (o: any) => o is FtSearchLocales;
 export interface FtMetadata {
     values: Array<string>;
     label: string;
@@ -90,6 +100,25 @@ export interface FtMapResource {
     mimeType: string;
 }
 export declare const isFtMapResource: (o: any) => o is FtMapResource;
+export interface FtSearchFilter {
+    negative: boolean;
+    values: Array<string>;
+    key: string;
+}
+export declare const isFtSearchFilter: (o: any) => o is FtSearchFilter;
+export interface FtSearchPreset {
+    name: string;
+    filters: Array<FtSearchFilter>;
+    contentLocale?: string;
+}
+export declare const isFtSearchPreset: (o: any) => o is FtSearchPreset;
+export interface FtSearchResultsPageInfo {
+    totalResultsCount: number;
+    lastPage: boolean;
+    currentPage: number;
+    totalClustersCount: number;
+}
+export declare const isFtSearchResultsPageInfo: (o: any) => o is FtSearchResultsPageInfo;
 export declare enum FtEditorialType {
     ARTICLE = "ARTICLE",
     BOOK = "BOOK"
@@ -100,12 +129,170 @@ export declare enum FtOpenMode {
     EXTERNAL = "EXTERNAL"
 }
 export declare const isFtOpenMode: (o: any) => o is FtOpenMode;
+export interface FtPageRequest {
+    perPage?: number;
+    page: number;
+}
+export declare const isFtPageRequest: (o: any) => o is FtPageRequest;
+export declare enum FtCollectionDocumentType {
+    MAP = "MAP",
+    DOCUMENT = "DOCUMENT",
+    TOPIC = "TOPIC",
+    PERSONAL_BOOK = "PERSONAL_BOOK",
+    SHARED_BOOK = "SHARED_BOOK"
+}
+export declare const isFtCollectionDocumentType: (o: any) => o is FtCollectionDocumentType;
+export interface FtSearchResults {
+    spellcheck?: FtSpellcheck;
+    paging: FtSearchResultsPageInfo;
+    results: Array<FtSearchResultCluster>;
+    facets: Array<FtSearchFacet>;
+}
+export declare const isFtSearchResults: (o: any) => o is FtSearchResults;
+export interface FtSearchRequest {
+    query: string;
+    paging: FtPageRequest;
+    filters: Array<FtSearchFilter>;
+    sort: Array<FtSearchSortCriterion>;
+    uiLocale?: string;
+    contentLocale?: string;
+    facets: Array<FtSearchFacetConf>;
+}
+export declare const isFtSearchRequest: (o: any) => o is FtSearchRequest;
+export interface FtSearchResultCluster {
+    entries: Array<FtSearchResultClusterEntry>;
+    metadataVariableAxis?: string;
+}
+export declare const isFtSearchResultCluster: (o: any) => o is FtSearchResultCluster;
+export interface FtSearchResultClusterEntry {
+    document?: FtSearchResultUnstructuredDocument;
+    topic?: FtSearchResultTopic;
+    type: FtSearchResultType;
+    map?: FtSearchResultMap;
+}
+export declare const isFtSearchResultClusterEntry: (o: any) => o is FtSearchResultClusterEntry;
+export interface FtSearchResultUnstructuredDocument {
+    metadata: Array<FtMetadata>;
+    openMode: FtOpenMode;
+    documentUrl: string;
+    mimeType: string;
+    source: any;
+    title: string;
+    lastPublicationDate?: string;
+    viewerUrl: string;
+    contentUrl: string;
+    filename: string;
+    htmlTitle: string;
+    originUrl?: string;
+    documentId: string;
+    lastEditionDate: string;
+    htmlExcerpt: string;
+}
+export declare const isFtSearchResultUnstructuredDocument: (o: any) => o is FtSearchResultUnstructuredDocument;
+export interface FtSearchResultMap {
+    metadata: Array<FtMetadata>;
+    openMode: FtOpenMode;
+    editorialType: FtEditorialType;
+    source?: any;
+    title: string;
+    lastPublicationDate?: string;
+    htmlTitle: string;
+    originUrl?: string;
+    mapUrl: string;
+    readerUrl: string;
+    mapId: string;
+    lastEditionDate?: string;
+    htmlExcerpt: string;
+}
+export declare const isFtSearchResultMap: (o: any) => o is FtSearchResultMap;
+export interface FtSearchResultTopic {
+    metadata: Array<FtMetadata>;
+    openMode: FtOpenMode;
+    contentId: string;
+    resources: Array<FtTopicResource>;
+    source?: any;
+    title: string;
+    mapTitle: string;
+    topicUrl: string;
+    contentUrl: string;
+    htmlTitle: string;
+    breadcrumb: Array<string>;
+    tocId: string;
+    originUrl?: string;
+    readerUrl: string;
+    mapId: string;
+    lastEditionDate?: string;
+    htmlExcerpt: string;
+}
+export declare const isFtSearchResultTopic: (o: any) => o is FtSearchResultTopic;
 export declare enum FtSearchResultType {
     MAP = "MAP",
     DOCUMENT = "DOCUMENT",
     TOPIC = "TOPIC"
 }
 export declare const isFtSearchResultType: (o: any) => o is FtSearchResultType;
+export interface FtSearchFacet {
+    hierarchical: boolean;
+    label: string;
+    multiSelectionable: boolean;
+    key: string;
+    rootNodes: Array<FtSearchFacetEntry>;
+}
+export declare const isFtSearchFacet: (o: any) => o is FtSearchFacet;
+export interface FtSearchFacetConf {
+    maxDepth?: number;
+    id: string;
+}
+export declare const isFtSearchFacetConf: (o: any) => o is FtSearchFacetConf;
+export interface FtSearchFacetEntry {
+    totalResultsCount: number;
+    descendantSelected: boolean;
+    childNodes: Array<FtSearchFacetEntry>;
+    label: string;
+    value: string;
+    selected: boolean;
+}
+export declare const isFtSearchFacetEntry: (o: any) => o is FtSearchFacetEntry;
+export interface FtSearchSortCriterion {
+    type: any;
+    key: string;
+    order: any;
+}
+export declare const isFtSearchSortCriterion: (o: any) => o is FtSearchSortCriterion;
+export interface FtSpellcheck {
+    suggestedQuery: string;
+    htmlSuggestedQuery: string;
+}
+export declare const isFtSpellcheck: (o: any) => o is FtSpellcheck;
+export interface FtTopicResource {
+    filename: string;
+    resourceUrl: string;
+    id: string;
+    mimeType: string;
+    resourceContentUrl: string;
+    viewerUrl: string;
+}
+export declare const isFtTopicResource: (o: any) => o is FtTopicResource;
+export interface FtSuggestRequest {
+    input: string;
+    filters: Array<FtSearchFilter>;
+    sort: Array<FtSearchSortCriterion>;
+    maxCount?: number;
+    contentLocale?: string;
+}
+export declare const isFtSuggestRequest: (o: any) => o is FtSuggestRequest;
+export interface FtSuggestResult {
+    filenameExtension?: string;
+    editorialType?: FtEditorialType;
+    mimeType?: string;
+    type: FtSearchResultType;
+    value: string;
+}
+export declare const isFtSuggestResult: (o: any) => o is FtSuggestResult;
+export interface FtSuggestResults {
+    suggestions: Array<FtSuggestResult>;
+}
+export declare const isFtSuggestResults: (o: any) => o is FtSuggestResults;
 export interface FtAuthenticationIdentifier {
     identifier: string;
     realm: string;

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

@@ -16,7 +16,7 @@ export const isFtCollectionDocument = (o) => {
         && (o.portalUrl == null || isString(o.portalUrl))
         && (isString(o.id))
         && (isString(o.title))
-        && (isFtSearchResultType(o.type));
+        && (isFtCollectionDocumentType(o.type));
 };
 export const isFtMap = (o) => {
     return isObject(o)
@@ -89,6 +89,17 @@ export var FtTopicContentTarget;
 export const isFtTopicContentTarget = (o) => {
     return ["THIRD_PARTY", "OFF_THE_GRID"].includes(o);
 };
+export const isFtSearchLocale = (o) => {
+    return isObject(o)
+        && (isNumber(o.count))
+        && (isString(o.label))
+        && (o.lang == null || isString(o.lang));
+};
+export const isFtSearchLocales = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.contentLocales)
+            && o.contentLocales.every((v) => isFtSearchLocale(v))));
+};
 export const isFtMetadata = (o) => {
     return isObject(o)
         && ((Array.isArray(o.values)
@@ -103,6 +114,27 @@ export const isFtMapResource = (o) => {
         && (isString(o.id))
         && (isString(o.mimeType));
 };
+export const isFtSearchFilter = (o) => {
+    return isObject(o)
+        && (isBoolean(o.negative))
+        && ((Array.isArray(o.values)
+            && o.values.every((v) => isString(v))))
+        && (isString(o.key));
+};
+export const isFtSearchPreset = (o) => {
+    return isObject(o)
+        && (isString(o.name))
+        && ((Array.isArray(o.filters)
+            && o.filters.every((v) => isFtSearchFilter(v))))
+        && (o.contentLocale == null || isString(o.contentLocale));
+};
+export const isFtSearchResultsPageInfo = (o) => {
+    return isObject(o)
+        && (isNumber(o.totalResultsCount))
+        && (isBoolean(o.lastPage))
+        && (isNumber(o.currentPage))
+        && (isNumber(o.totalClustersCount));
+};
 // From: WsEditorialType
 export var FtEditorialType;
 (function (FtEditorialType) {
@@ -121,6 +153,114 @@ export var FtOpenMode;
 export const isFtOpenMode = (o) => {
     return ["FLUIDTOPICS", "EXTERNAL"].includes(o);
 };
+export const isFtPageRequest = (o) => {
+    return isObject(o)
+        && (o.perPage == null || isNumber(o.perPage))
+        && (isNumber(o.page));
+};
+// From: WsPublicCollectionDocumentType
+export var FtCollectionDocumentType;
+(function (FtCollectionDocumentType) {
+    FtCollectionDocumentType["MAP"] = "MAP";
+    FtCollectionDocumentType["DOCUMENT"] = "DOCUMENT";
+    FtCollectionDocumentType["TOPIC"] = "TOPIC";
+    FtCollectionDocumentType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
+    FtCollectionDocumentType["SHARED_BOOK"] = "SHARED_BOOK";
+})(FtCollectionDocumentType || (FtCollectionDocumentType = {}));
+export const isFtCollectionDocumentType = (o) => {
+    return ["MAP", "DOCUMENT", "TOPIC", "PERSONAL_BOOK", "SHARED_BOOK"].includes(o);
+};
+export const isFtSearchResults = (o) => {
+    return isObject(o)
+        && (o.spellcheck == null || isFtSpellcheck(o.spellcheck))
+        && (isFtSearchResultsPageInfo(o.paging))
+        && ((Array.isArray(o.results)
+            && o.results.every((v) => isFtSearchResultCluster(v))))
+        && ((Array.isArray(o.facets)
+            && o.facets.every((v) => isFtSearchFacet(v))));
+};
+export const isFtSearchRequest = (o) => {
+    return isObject(o)
+        && (isString(o.query))
+        && (isFtPageRequest(o.paging))
+        && ((Array.isArray(o.filters)
+            && o.filters.every((v) => isFtSearchFilter(v))))
+        && ((Array.isArray(o.sort)
+            && o.sort.every((v) => isFtSearchSortCriterion(v))))
+        && (o.uiLocale == null || isString(o.uiLocale))
+        && (o.contentLocale == null || isString(o.contentLocale))
+        && ((Array.isArray(o.facets)
+            && o.facets.every((v) => isFtSearchFacetConf(v))));
+};
+export const isFtSearchResultCluster = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.entries)
+            && o.entries.every((v) => isFtSearchResultClusterEntry(v))))
+        && (o.metadataVariableAxis == null || isString(o.metadataVariableAxis));
+};
+export const isFtSearchResultClusterEntry = (o) => {
+    return isObject(o)
+        && (o.document == null || isFtSearchResultUnstructuredDocument(o.document))
+        && (o.topic == null || isFtSearchResultTopic(o.topic))
+        && (isFtSearchResultType(o.type))
+        && (o.map == null || isFtSearchResultMap(o.map));
+};
+export const isFtSearchResultUnstructuredDocument = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.metadata)
+            && o.metadata.every((v) => isFtMetadata(v))))
+        && (isFtOpenMode(o.openMode))
+        && (isString(o.documentUrl))
+        && (isString(o.mimeType))
+        && (isString(o.title))
+        && (o.lastPublicationDate == null || isString(o.lastPublicationDate))
+        && (isString(o.viewerUrl))
+        && (isString(o.contentUrl))
+        && (isString(o.filename))
+        && (isString(o.htmlTitle))
+        && (o.originUrl == null || isString(o.originUrl))
+        && (isString(o.documentId))
+        && (isString(o.lastEditionDate))
+        && (isString(o.htmlExcerpt));
+};
+export const isFtSearchResultMap = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.metadata)
+            && o.metadata.every((v) => isFtMetadata(v))))
+        && (isFtOpenMode(o.openMode))
+        && (isFtEditorialType(o.editorialType))
+        && (isString(o.title))
+        && (o.lastPublicationDate == null || isString(o.lastPublicationDate))
+        && (isString(o.htmlTitle))
+        && (o.originUrl == null || isString(o.originUrl))
+        && (isString(o.mapUrl))
+        && (isString(o.readerUrl))
+        && (isString(o.mapId))
+        && (o.lastEditionDate == null || isString(o.lastEditionDate))
+        && (isString(o.htmlExcerpt));
+};
+export const isFtSearchResultTopic = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.metadata)
+            && o.metadata.every((v) => isFtMetadata(v))))
+        && (isFtOpenMode(o.openMode))
+        && (isString(o.contentId))
+        && ((Array.isArray(o.resources)
+            && o.resources.every((v) => isFtTopicResource(v))))
+        && (isString(o.title))
+        && (isString(o.mapTitle))
+        && (isString(o.topicUrl))
+        && (isString(o.contentUrl))
+        && (isString(o.htmlTitle))
+        && ((Array.isArray(o.breadcrumb)
+            && o.breadcrumb.every((v) => isString(v))))
+        && (isString(o.tocId))
+        && (o.originUrl == null || isString(o.originUrl))
+        && (isString(o.readerUrl))
+        && (isString(o.mapId))
+        && (o.lastEditionDate == null || isString(o.lastEditionDate))
+        && (isString(o.htmlExcerpt));
+};
 // From: WsPublicSearchResultType
 export var FtSearchResultType;
 (function (FtSearchResultType) {
@@ -131,6 +271,71 @@ export var FtSearchResultType;
 export const isFtSearchResultType = (o) => {
     return ["MAP", "DOCUMENT", "TOPIC"].includes(o);
 };
+export const isFtSearchFacet = (o) => {
+    return isObject(o)
+        && (isBoolean(o.hierarchical))
+        && (isString(o.label))
+        && (isBoolean(o.multiSelectionable))
+        && (isString(o.key))
+        && ((Array.isArray(o.rootNodes)
+            && o.rootNodes.every((v) => isFtSearchFacetEntry(v))));
+};
+export const isFtSearchFacetConf = (o) => {
+    return isObject(o)
+        && (o.maxDepth == null || isNumber(o.maxDepth))
+        && (isString(o.id));
+};
+export const isFtSearchFacetEntry = (o) => {
+    return isObject(o)
+        && (isNumber(o.totalResultsCount))
+        && (isBoolean(o.descendantSelected))
+        && ((Array.isArray(o.childNodes)
+            && o.childNodes.every((v) => isFtSearchFacetEntry(v))))
+        && (isString(o.label))
+        && (isString(o.value))
+        && (isBoolean(o.selected));
+};
+export const isFtSearchSortCriterion = (o) => {
+    return isObject(o)
+        && (isString(o.key));
+};
+export const isFtSpellcheck = (o) => {
+    return isObject(o)
+        && (isString(o.suggestedQuery))
+        && (isString(o.htmlSuggestedQuery));
+};
+export const isFtTopicResource = (o) => {
+    return isObject(o)
+        && (isString(o.filename))
+        && (isString(o.resourceUrl))
+        && (isString(o.id))
+        && (isString(o.mimeType))
+        && (isString(o.resourceContentUrl))
+        && (isString(o.viewerUrl));
+};
+export const isFtSuggestRequest = (o) => {
+    return isObject(o)
+        && (isString(o.input))
+        && ((Array.isArray(o.filters)
+            && o.filters.every((v) => isFtSearchFilter(v))))
+        && ((Array.isArray(o.sort)
+            && o.sort.every((v) => isFtSearchSortCriterion(v))))
+        && (o.maxCount == null || isNumber(o.maxCount))
+        && (o.contentLocale == null || isString(o.contentLocale));
+};
+export const isFtSuggestResult = (o) => {
+    return isObject(o)
+        && (o.filenameExtension == null || isString(o.filenameExtension))
+        && (o.editorialType == null || isFtEditorialType(o.editorialType))
+        && (o.mimeType == null || isString(o.mimeType))
+        && (isFtSearchResultType(o.type))
+        && (isString(o.value));
+};
+export const isFtSuggestResults = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.suggestions)
+            && o.suggestions.every((v) => isFtSuggestResult(v))));
+};
 export const isFtAuthenticationIdentifier = (o) => {
     return isObject(o)
         && (isString(o.identifier))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-topics/public-api",
-  "version": "1.0.13",
+  "version": "1.0.16",
   "description": "Fluid Topics Public API",
   "author": "Fluid Topics dev team <opensource@antidot.net>",
   "license": "LGPLv3",