@fluid-topics/public-api 1.0.13 → 1.0.14

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,19 @@ 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 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 +123,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,20 @@ 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 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 +146,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 +264,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))