@fluid-topics/public-api 1.0.101 → 1.0.103

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

@@ -357,6 +357,7 @@ export interface FtPersonalBookCreation {
     nodes: Array<FtPersonalBookNodeCreation>;
     description: string;
     title: string;
+    labels: Array<string>;
 }
 export declare const isFtPersonalBookCreation: (o: any) => o is FtPersonalBookCreation;
 export interface FtPersonalBookMetadataUpdate {
@@ -381,7 +382,7 @@ export interface FtPersonalBookTopicLinkCreation {
 export declare const isFtPersonalBookTopicLinkCreation: (o: any) => o is FtPersonalBookTopicLinkCreation;
 export interface FtBookmark {
     mapTitle: string;
-    color: FtMyLibraryColorsKeys;
+    /** @deprecated */ color?: FtMyLibraryColorsKeys;
     breadcrumb: Array<string>;
     tocId: string;
     lastUpdate: Date | string;
@@ -390,6 +391,7 @@ export interface FtBookmark {
     id: string;
     title: string;
     creationDate: Date | string;
+    labels: Array<string>;
 }
 export declare const isFtBookmark: (o: any) => o is FtBookmark;
 export interface FtCollectionDocument {
@@ -561,6 +563,10 @@ export interface FtUiLocale {
     translated: boolean;
 }
 export declare const isFtUiLocale: (o: any) => o is FtUiLocale;
+export interface FtUserAssetLabel {
+    title: string;
+}
+export declare const isFtUserAssetLabel: (o: any) => o is FtUserAssetLabel;
 export declare enum FtFacetType {
     AND = "AND",
     OR = "OR",
@@ -596,29 +602,31 @@ export interface FtMetadataDescriptor {
 export declare const isFtMetadataDescriptor: (o: any) => o is FtMetadataDescriptor;
 export interface FtMySearch {
     searchRequest: FtMySearchRequest;
-    color: FtMyLibraryColorsKeys;
+    /** @deprecated */ color?: FtMyLibraryColorsKeys;
     alert: boolean;
     description: string;
     id: string;
     ownerId: string;
     title: string;
     creationDate: Date | string;
+    labels: Array<string>;
 }
 export declare const isFtMySearch: (o: any) => o is FtMySearch;
 export interface FtMySearchCreation {
     searchRequest: FtMySearchRequest;
-    color: FtMyLibraryColorsKeys;
     alert: boolean;
     description: string;
     title: string;
+    labels: Array<string>;
 }
 export declare const isFtMySearchCreation: (o: any) => o is FtMySearchCreation;
 export interface FtMySearchRequest {
     /** @deprecated */ periodFilter?: FtPeriodFilter;
+    sortId?: string;
     query: string;
     scope?: FtSearchScopeKeys;
     /** @deprecated */ filters?: Array<FtLegacyLabeledMetadataFilter>;
-    sort: Array<FtSearchSortCriterion>;
+    sort?: Array<FtSearchSortCriterion>;
     virtualField?: FtVirtualFieldKeys;
     metadataFilters?: Array<FtLabeledMetadataFilter>;
     contentLocale?: string;
@@ -626,10 +634,10 @@ export interface FtMySearchRequest {
 export declare const isFtMySearchRequest: (o: any) => o is FtMySearchRequest;
 export interface FtMySearchUpdate {
     searchRequest?: FtMySearchRequest;
-    color?: FtMyLibraryColorsKeys;
     alert?: boolean;
     description?: string;
     title?: string;
+    labels?: Array<string>;
 }
 export declare const isFtMySearchUpdate: (o: any) => o is FtMySearchUpdate;
 export interface FtPrivacyPolicyConfiguration {
@@ -740,7 +748,8 @@ export declare const isFtSearchResultsPageInfo: (o: any) => o is FtSearchResults
 export declare enum FtEditorialType {
     ARTICLE = "ARTICLE",
     BOOK = "BOOK",
-    SHARED_BOOK = "SHARED_BOOK"
+    SHARED_BOOK = "SHARED_BOOK",
+    HTMLPACKAGE = "HTMLPACKAGE"
 }
 export type FtEditorialTypeKeys = keyof typeof FtEditorialType;
 export declare const isFtEditorialType: (o: any) => o is FtEditorialType;
@@ -843,10 +852,11 @@ export interface FtSearchRequest {
     query: string;
     paging: FtPageRequest;
     /** @deprecated */ filters?: Array<FtLegacyMetadataFilter>;
-    sort: Array<FtSearchSortCriterion>;
+    /** @deprecated */ sort?: Array<FtSearchSortCriterion>;
     virtualField?: FtVirtualFieldKeys;
     metadataFilters: Array<FtMetadataFilter>;
     facets: Array<FtSearchFacetConf>;
+    sortId?: string;
     scope?: FtSearchScopeKeys;
     /** @deprecated */ lastModified?: any;
     uiLocale?: string;
@@ -990,8 +1000,16 @@ export interface FtTopicResource {
     viewerUrl: string;
 }
 export declare const isFtTopicResource: (o: any) => o is FtTopicResource;
+export declare enum FtLocalizableLabelType {
+    PLAIN_TEXT = "PLAIN_TEXT",
+    LOCALIZED_OFFICIAL = "LOCALIZED_OFFICIAL",
+    LOCALIZED_CUSTOM = "LOCALIZED_CUSTOM"
+}
+export type FtLocalizableLabelTypeKeys = keyof typeof FtLocalizableLabelType;
+export declare const isFtLocalizableLabelType: (o: any) => o is FtLocalizableLabelType;
 export interface FtSuggestRequest {
     input: string;
+    sortId?: string;
     scope?: FtSearchScopeKeys;
     sort: Array<FtSearchSortCriterion>;
     maxCount?: number;
@@ -1089,3 +1107,20 @@ export interface FtWatermark {
     opacity: number;
 }
 export declare const isFtWatermark: (o: any) => o is FtWatermark;
+export interface FtLocalizableLabel {
+    context: string;
+    text: string;
+    type: FtLocalizableLabelTypeKeys;
+    key: string;
+}
+export declare const isFtLocalizableLabel: (o: any) => o is FtLocalizableLabel;
+export interface FtSearchConfiguration {
+    sortOptions: Array<FtSearchSortOption>;
+}
+export declare const isFtSearchConfiguration: (o: any) => o is FtSearchConfiguration;
+export interface FtSearchSortOption {
+    id: string;
+    label: FtLocalizableLabel;
+    sortCriteria: Array<FtSearchSortCriterion>;
+}
+export declare const isFtSearchSortOption: (o: any) => o is FtSearchSortOption;

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

@@ -381,7 +381,9 @@ export const isFtPersonalBookCreation = (o) => {
         && ((Array.isArray(o.nodes)
             && o.nodes.every((v) => isFtPersonalBookNodeCreation(v))))
         && (isString(o.description))
-        && (isString(o.title));
+        && (isString(o.title))
+        && ((Array.isArray(o.labels)
+            && o.labels.every((v) => isString(v))));
 };
 export const isFtPersonalBookMetadataUpdate = (o) => {
     return isObject(o)
@@ -408,7 +410,7 @@ export const isFtPersonalBookTopicLinkCreation = (o) => {
 export const isFtBookmark = (o) => {
     return isObject(o)
         && (isString(o.mapTitle))
-        && (isFtMyLibraryColors(o.color))
+        && (o.color == null || isFtMyLibraryColors(o.color))
         && ((Array.isArray(o.breadcrumb)
             && o.breadcrumb.every((v) => isString(v))))
         && (isString(o.tocId))
@@ -417,7 +419,9 @@ export const isFtBookmark = (o) => {
         && (isString(o.mapId))
         && (isString(o.id))
         && (isString(o.title))
-        && (isString(o.creationDate));
+        && (isString(o.creationDate))
+        && ((Array.isArray(o.labels)
+            && o.labels.every((v) => isString(v))));
 };
 export const isFtCollectionDocument = (o) => {
     return isObject(o)
@@ -602,6 +606,10 @@ export const isFtUiLocale = (o) => {
         && (isString(o.languageTag))
         && (isBoolean(o.translated));
 };
+export const isFtUserAssetLabel = (o) => {
+    return isObject(o)
+        && (isString(o.title));
+};
 // From: WsFacetType
 export var FtFacetType;
 (function (FtFacetType) {
@@ -644,30 +652,34 @@ export const isFtMetadataDescriptor = (o) => {
 export const isFtMySearch = (o) => {
     return isObject(o)
         && (isFtMySearchRequest(o.searchRequest))
-        && (isFtMyLibraryColors(o.color))
+        && (o.color == null || isFtMyLibraryColors(o.color))
         && (isBoolean(o.alert))
         && (isString(o.description))
         && (isString(o.id))
         && (isString(o.ownerId))
         && (isString(o.title))
-        && (isString(o.creationDate));
+        && (isString(o.creationDate))
+        && ((Array.isArray(o.labels)
+            && o.labels.every((v) => isString(v))));
 };
 export const isFtMySearchCreation = (o) => {
     return isObject(o)
         && (isFtMySearchRequest(o.searchRequest))
-        && (isFtMyLibraryColors(o.color))
         && (isBoolean(o.alert))
         && (isString(o.description))
-        && (isString(o.title));
+        && (isString(o.title))
+        && ((Array.isArray(o.labels)
+            && o.labels.every((v) => isString(v))));
 };
 export const isFtMySearchRequest = (o) => {
     return isObject(o)
         && (o.periodFilter == null || isFtPeriodFilter(o.periodFilter))
+        && (o.sortId == null || isString(o.sortId))
         && (isString(o.query))
         && (o.scope == null || isFtSearchScope(o.scope))
         && (o.filters == null || (Array.isArray(o.filters)
             && o.filters.every((v) => isFtLegacyLabeledMetadataFilter(v))))
-        && ((Array.isArray(o.sort)
+        && (o.sort == null || (Array.isArray(o.sort)
             && o.sort.every((v) => isFtSearchSortCriterion(v))))
         && (o.virtualField == null || isFtVirtualField(o.virtualField))
         && (o.metadataFilters == null || (Array.isArray(o.metadataFilters)
@@ -677,10 +689,11 @@ export const isFtMySearchRequest = (o) => {
 export const isFtMySearchUpdate = (o) => {
     return isObject(o)
         && (o.searchRequest == null || isFtMySearchRequest(o.searchRequest))
-        && (o.color == null || isFtMyLibraryColors(o.color))
         && (o.alert == null || isBoolean(o.alert))
         && (o.description == null || isString(o.description))
-        && (o.title == null || isString(o.title));
+        && (o.title == null || isString(o.title))
+        && (o.labels == null || (Array.isArray(o.labels)
+            && o.labels.every((v) => isString(v))));
 };
 export const isFtPrivacyPolicyConfiguration = (o) => {
     return isObject(o)
@@ -804,6 +817,7 @@ export var FtEditorialType;
     FtEditorialType["ARTICLE"] = "ARTICLE";
     FtEditorialType["BOOK"] = "BOOK";
     FtEditorialType["SHARED_BOOK"] = "SHARED_BOOK";
+    FtEditorialType["HTMLPACKAGE"] = "HTMLPACKAGE";
 })(FtEditorialType || (FtEditorialType = {}));
 export const isFtEditorialType = (o) => Object.keys(FtEditorialType).includes(o);
 // From: WsOpenMode
@@ -915,13 +929,14 @@ export const isFtSearchRequest = (o) => {
         && (isFtPageRequest(o.paging))
         && (o.filters == null || (Array.isArray(o.filters)
             && o.filters.every((v) => isFtLegacyMetadataFilter(v))))
-        && ((Array.isArray(o.sort)
+        && (o.sort == null || (Array.isArray(o.sort)
             && o.sort.every((v) => isFtSearchSortCriterion(v))))
         && (o.virtualField == null || isFtVirtualField(o.virtualField))
         && ((Array.isArray(o.metadataFilters)
             && o.metadataFilters.every((v) => isFtMetadataFilter(v))))
         && ((Array.isArray(o.facets)
             && o.facets.every((v) => isFtSearchFacetConf(v))))
+        && (o.sortId == null || isString(o.sortId))
         && (o.scope == null || isFtSearchScope(o.scope))
         && (o.uiLocale == null || isString(o.uiLocale))
         && (o.contentLocale == null || isString(o.contentLocale))
@@ -1074,9 +1089,18 @@ export const isFtTopicResource = (o) => {
         && (isString(o.resourceContentUrl))
         && (isString(o.viewerUrl));
 };
+// From: LocalizableLabelType
+export var FtLocalizableLabelType;
+(function (FtLocalizableLabelType) {
+    FtLocalizableLabelType["PLAIN_TEXT"] = "PLAIN_TEXT";
+    FtLocalizableLabelType["LOCALIZED_OFFICIAL"] = "LOCALIZED_OFFICIAL";
+    FtLocalizableLabelType["LOCALIZED_CUSTOM"] = "LOCALIZED_CUSTOM";
+})(FtLocalizableLabelType || (FtLocalizableLabelType = {}));
+export const isFtLocalizableLabelType = (o) => Object.keys(FtLocalizableLabelType).includes(o);
 export const isFtSuggestRequest = (o) => {
     return isObject(o)
         && (isString(o.input))
+        && (o.sortId == null || isString(o.sortId))
         && (o.scope == null || isFtSearchScope(o.scope))
         && ((Array.isArray(o.sort)
             && o.sort.every((v) => isFtSearchSortCriterion(v))))
@@ -1183,3 +1207,22 @@ export const isFtWatermark = (o) => {
             && o.text.every((v) => isString(v))))
         && (isNumber(o.opacity));
 };
+export const isFtLocalizableLabel = (o) => {
+    return isObject(o)
+        && (isString(o.context))
+        && (isString(o.text))
+        && (isFtLocalizableLabelType(o.type))
+        && (isString(o.key));
+};
+export const isFtSearchConfiguration = (o) => {
+    return isObject(o)
+        && ((Array.isArray(o.sortOptions)
+            && o.sortOptions.every((v) => isFtSearchSortOption(v))));
+};
+export const isFtSearchSortOption = (o) => {
+    return isObject(o)
+        && (isString(o.id))
+        && (isFtLocalizableLabel(o.label))
+        && ((Array.isArray(o.sortCriteria)
+            && o.sortCriteria.every((v) => isFtSearchSortCriterion(v))));
+};

package/package.json

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