@fluid-topics/public-api 1.0.46 → 1.0.48

package/dist/mjs/index.d.ts

@@ -122,18 +122,18 @@ export declare class FluidTopicsApi {
     logout(): Promise<void>;
     getCurrentSession(): Promise<FtSession>;
     getReaderConfiguration(): Promise<FtReaderConfiguration>;
-    getMap(mapId: string): Promise<FtMap>;
-    getTableOfContent(mapId: string): Promise<Array<FtTocNode>>;
-    getPages(mapId: string): Promise<FtPaginatedToc>;
-    getTopic(mapId: string, topicContentId: string): Promise<FtTopic>;
-    getTopicHTMLContent(mapId: string, topicContentId: string, target?: FtTopicContentTarget | FtTopicContentTargetKeys): Promise<string>;
-    getMapAttachments(mapId: string): Promise<Array<FtMapAttachment>>;
-    getMapAttachmentContent(mapId: string, attachmentId: string): Promise<ArrayBuffer>;
-    getMapResources(mapId: string): Promise<Array<FtMapResource>>;
-    getMapResourceContent(mapId: string, resourceId: string): Promise<ArrayBuffer>;
-    getUnstructuredDocument(documentId: string): Promise<FtUnstructuredDocument>;
-    getUnstructuredDocumentContent(documentId: string): Promise<ArrayBuffer>;
-    getUnstructuredDocumentTextContent(documentId: string): Promise<string>;
+    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>;
@@ -154,7 +154,7 @@ export declare class FluidTopicsApi {
     getCustomMessageContext(locale: string, name: string): Promise<FtMessageContext>;
     listMySearches(userId: string): Promise<FtMySearch[]>;
     listMyBookmarks(userId: string): Promise<FtBookmark[]>;
-    get<T>(endpoint: string): Promise<T>;
+    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>;
@@ -163,5 +163,6 @@ export declare class FluidTopicsApi {
     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;

package/dist/mjs/index.js

@@ -182,41 +182,41 @@ export class FluidTopicsApi {
     getReaderConfiguration() {
         return this.get(this.endpoints.configuration.reader);
     }
-    getMap(mapId) {
-        return this.get(this.endpoints.khub.maps.mapId(mapId).info);
+    getMap(mapId, v) {
+        return this.get(this.endpoints.khub.maps.mapId(mapId).info, v);
     }
-    getTableOfContent(mapId) {
-        return this.get(this.endpoints.khub.maps.mapId(mapId).toc);
+    getTableOfContent(mapId, v) {
+        return this.get(this.endpoints.khub.maps.mapId(mapId).toc, v);
     }
-    getPages(mapId) {
-        return this.get(this.endpoints.khub.maps.mapId(mapId).pages);
+    getPages(mapId, v) {
+        return this.get(this.endpoints.khub.maps.mapId(mapId).pages, v);
     }
-    getTopic(mapId, topicContentId) {
-        return this.get(this.endpoints.khub.maps.mapId(mapId).topics.contentId(topicContentId).info);
+    getTopic(mapId, topicContentId, v) {
+        return this.get(this.endpoints.khub.maps.mapId(mapId).topics.contentId(topicContentId).info, v);
     }
-    getTopicHTMLContent(mapId, topicContentId, target) {
-        return this.get(this.endpoints.khub.maps.mapId(mapId).topics.contentId(topicContentId).content + (target ? "?target=" + target : ""));
+    getTopicHTMLContent(mapId, topicContentId, target, v) {
+        return this.get(this.endpoints.khub.maps.mapId(mapId).topics.contentId(topicContentId).content + (target ? "?target=" + target : ""), v);
     }
-    getMapAttachments(mapId) {
-        return this.get(this.endpoints.khub.maps.mapId(mapId).attachments.list);
+    getMapAttachments(mapId, v) {
+        return this.get(this.endpoints.khub.maps.mapId(mapId).attachments.list, v);
     }
-    getMapAttachmentContent(mapId, attachmentId) {
-        return this.fetchRawData(this.endpoints.khub.maps.mapId(mapId).attachments.attachmentId(attachmentId).content);
+    getMapAttachmentContent(mapId, attachmentId, v) {
+        return this.fetchRawData(this.endpoints.khub.maps.mapId(mapId).attachments.attachmentId(attachmentId).content, v);
     }
-    getMapResources(mapId) {
-        return this.get(this.endpoints.khub.maps.mapId(mapId).resources.list);
+    getMapResources(mapId, v) {
+        return this.get(this.endpoints.khub.maps.mapId(mapId).resources.list, v);
     }
-    getMapResourceContent(mapId, resourceId) {
-        return this.fetchRawData(this.endpoints.khub.maps.mapId(mapId).resources.resourceId(resourceId).content);
+    getMapResourceContent(mapId, resourceId, v) {
+        return this.fetchRawData(this.endpoints.khub.maps.mapId(mapId).resources.resourceId(resourceId).content, v);
     }
-    getUnstructuredDocument(documentId) {
-        return this.get(this.endpoints.khub.documents.documentId(documentId).info);
+    getUnstructuredDocument(documentId, v) {
+        return this.get(this.endpoints.khub.documents.documentId(documentId).info, v);
     }
-    getUnstructuredDocumentContent(documentId) {
-        return this.fetchRawData(this.endpoints.khub.documents.documentId(documentId).content);
+    getUnstructuredDocumentContent(documentId, v) {
+        return this.fetchRawData(this.endpoints.khub.documents.documentId(documentId).content, v);
     }
-    getUnstructuredDocumentTextContent(documentId) {
-        return this.get(this.endpoints.khub.documents.documentId(documentId).text);
+    getUnstructuredDocumentTextContent(documentId, v) {
+        return this.get(this.endpoints.khub.documents.documentId(documentId).text, v);
     }
     getCollectionDocuments(userId, collectionId) {
         return this.get(this.endpoints.users.userId(userId).collections.collectionId(collectionId).documents);
@@ -280,8 +280,8 @@ export class FluidTopicsApi {
     listMyBookmarks(userId) {
         return this.get(this.endpoints.users.userId(userId).bookmarks.list);
     }
-    get(endpoint) {
-        return this.makeRequest("GET", endpoint);
+    get(endpoint, v) {
+        return this.makeRequest("GET", this.withVersion(endpoint, v));
     }
     post(endpoint, data) {
         return this.makeRequest("POST", endpoint, data);
@@ -293,7 +293,7 @@ export class FluidTopicsApi {
         return this.makeRequest("DELETE", endpoint);
     }
     makeAbsolute(endpoint) {
-        return this.tenantBaseUrl + endpoint.replace(/^\//, "");
+        return endpoint.startsWith(this.tenantBaseUrl) ? endpoint : (this.tenantBaseUrl + endpoint.replace(/^\//, ""));
     }
     async fetch(endpoint, init) {
         const requestInit = init;
@@ -339,13 +339,20 @@ export class FluidTopicsApi {
             .then(handleError)
             .then(getBody);
     }
-    fetchRawData(endpoint) {
-        return fetch(this.makeAbsolute(endpoint), {
+    fetchRawData(endpoint, v) {
+        return fetch(this.withVersion(endpoint, v), {
             headers: this.defaultHeaders,
             credentials: this.authorization == null ? "include" : undefined
         })
             .then(handleError)
             .then(response => response.arrayBuffer());
     }
+    withVersion(endpoint, v) {
+        let url = new URL(this.makeAbsolute(endpoint));
+        if (v) {
+            url.searchParams.append("v", v);
+        }
+        return url.toString();
+    }
 }
 export default FluidTopicsApi;

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

@@ -206,8 +206,10 @@ export declare const isFtMySearch: (o: any) => o is FtMySearch;
 export interface FtMySearchRequest {
     periodFilter?: FtPeriodFilter;
     query: string;
+    scope?: FtSearchScopeKeys | FtSearchScope;
     filters: Array<FtLabeledSearchFilter>;
     sort: Array<FtSearchSortCriterion>;
+    virtualField?: FtVirtualFieldKeys | FtVirtualField;
     contentLocale?: string;
 }
 export declare const isFtMySearchRequest: (o: any) => o is FtMySearchRequest;
@@ -311,6 +313,13 @@ export declare enum FtSearchSortCriterionType {
 }
 export type FtSearchSortCriterionTypeKeys = keyof typeof FtSearchSortCriterionType;
 export declare const isFtSearchSortCriterionType: (o: any) => o is FtSearchSortCriterionType;
+export declare enum FtVirtualField {
+    EVERYWHERE = "EVERYWHERE",
+    TITLE_ONLY = "TITLE_ONLY",
+    NONE = "NONE"
+}
+export type FtVirtualFieldKeys = keyof typeof FtVirtualField;
+export declare const isFtVirtualField: (o: any) => o is FtVirtualField;
 export interface FtSearchResultsPageInfo {
     totalResultsCount: number;
     isLastPage: boolean;
@@ -368,11 +377,13 @@ export declare const isFtSearchPrior: (o: any) => o is FtSearchPrior;
 export interface FtSearchRequest {
     periodFilter?: FtPeriodFilter;
     query: string;
+    scope?: FtSearchScopeKeys | FtSearchScope;
     paging: FtPageRequest;
     filters: Array<FtSearchFilter>;
     sort: Array<FtSearchSortCriterion>;
     lastModified?: any;
     uiLocale?: string;
+    virtualField?: FtVirtualFieldKeys | FtVirtualField;
     contentLocale?: string;
     priors?: Array<FtSearchPrior>;
     facets: Array<FtSearchFacetConf>;
@@ -451,6 +462,12 @@ export declare enum FtSearchResultType {
 }
 export type FtSearchResultTypeKeys = keyof typeof FtSearchResultType;
 export declare const isFtSearchResultType: (o: any) => o is FtSearchResultType;
+export declare enum FtSearchScope {
+    DEFAULT = "DEFAULT",
+    DOCUMENTS = "DOCUMENTS"
+}
+export type FtSearchScopeKeys = keyof typeof FtSearchScope;
+export declare const isFtSearchScope: (o: any) => o is FtSearchScope;
 export interface FtSearchFacet {
     hierarchical: boolean;
     label: string;

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

@@ -237,10 +237,12 @@ export const isFtMySearchRequest = (o) => {
     return isObject(o)
         && (o.periodFilter == null || isFtPeriodFilter(o.periodFilter))
         && (isString(o.query))
+        && (o.scope == null || isFtSearchScope(o.scope))
         && ((Array.isArray(o.filters)
             && o.filters.every((v) => isFtLabeledSearchFilter(v))))
         && ((Array.isArray(o.sort)
             && o.sort.every((v) => isFtSearchSortCriterion(v))))
+        && (o.virtualField == null || isFtVirtualField(o.virtualField))
         && (o.contentLocale == null || isString(o.contentLocale));
 };
 // From: RatingType
@@ -362,6 +364,16 @@ export var FtSearchSortCriterionType;
 export const isFtSearchSortCriterionType = (o) => {
     return ["ALPHA", "NATURAL"].includes(o);
 };
+// From: VirtualField
+export var FtVirtualField;
+(function (FtVirtualField) {
+    FtVirtualField["EVERYWHERE"] = "EVERYWHERE";
+    FtVirtualField["TITLE_ONLY"] = "TITLE_ONLY";
+    FtVirtualField["NONE"] = "NONE";
+})(FtVirtualField || (FtVirtualField = {}));
+export const isFtVirtualField = (o) => {
+    return ["EVERYWHERE", "TITLE_ONLY", "NONE"].includes(o);
+};
 export const isFtSearchResultsPageInfo = (o) => {
     return isObject(o)
         && (isNumber(o.totalResultsCount))
@@ -432,12 +444,14 @@ export const isFtSearchRequest = (o) => {
     return isObject(o)
         && (o.periodFilter == null || isFtPeriodFilter(o.periodFilter))
         && (isString(o.query))
+        && (o.scope == null || isFtSearchScope(o.scope))
         && (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.virtualField == null || isFtVirtualField(o.virtualField))
         && (o.contentLocale == null || isString(o.contentLocale))
         && (o.priors == null || (Array.isArray(o.priors)
             && o.priors.every((v) => isFtSearchPrior(v))))
@@ -523,6 +537,15 @@ export var FtSearchResultType;
 export const isFtSearchResultType = (o) => {
     return ["MAP", "DOCUMENT", "TOPIC"].includes(o);
 };
+// From: WsPublicSearchScope
+export var FtSearchScope;
+(function (FtSearchScope) {
+    FtSearchScope["DEFAULT"] = "DEFAULT";
+    FtSearchScope["DOCUMENTS"] = "DOCUMENTS";
+})(FtSearchScope || (FtSearchScope = {}));
+export const isFtSearchScope = (o) => {
+    return ["DEFAULT", "DOCUMENTS"].includes(o);
+};
 export const isFtSearchFacet = (o) => {
     return isObject(o)
         && (isBoolean(o.hierarchical))

package/package.json

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