@fluid-topics/public-api 1.0.100 → 1.0.102

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

@@ -505,7 +505,8 @@ export declare enum FtExternalWebComponentContext {
     READER = "READER",
     TOPIC_TEMPLATE = "TOPIC_TEMPLATE",
     SEARCH = "SEARCH",
-    SEARCH_RESULT = "SEARCH_RESULT"
+    SEARCH_RESULT = "SEARCH_RESULT",
+    SEARCH_ANNOUNCEMENT = "SEARCH_ANNOUNCEMENT"
 }
 export type FtExternalWebComponentContextKeys = keyof typeof FtExternalWebComponentContext;
 export declare const isFtExternalWebComponentContext: (o: any) => o is FtExternalWebComponentContext;
@@ -614,10 +615,11 @@ export interface FtMySearchCreation {
 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;
@@ -783,6 +785,7 @@ export interface FtSearchResults {
     spellcheck?: FtSpellcheck;
     paging: FtSearchResultsPageInfo;
     results: Array<FtSearchResultCluster>;
+    announcements?: Array<FtSearchResultAnnouncement>;
     facets: Array<FtSearchFacet>;
 }
 export declare const isFtSearchResults: (o: any) => o is FtSearchResults;
@@ -841,10 +844,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;
@@ -853,6 +857,12 @@ export interface FtSearchRequest {
     clusterSortCriterions?: Array<FtPublicClusterSortCriterion>;
 }
 export declare const isFtSearchRequest: (o: any) => o is FtSearchRequest;
+export interface FtSearchResultAnnouncement {
+    link: string;
+    text: string;
+    title: string;
+}
+export declare const isFtSearchResultAnnouncement: (o: any) => o is FtSearchResultAnnouncement;
 export interface FtSearchResultCluster {
     entries: Array<FtSearchResultClusterEntry>;
     metadataVariableAxis?: string;
@@ -982,8 +992,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;
@@ -1021,6 +1039,7 @@ export declare enum FtUserRole {
     GENERATIVE_AI_USER = "GENERATIVE_AI_USER",
     GENERATIVE_AI_EXPORT_USER = "GENERATIVE_AI_EXPORT_USER",
     CONTENT_PUBLISHER = "CONTENT_PUBLISHER",
+    ANNOUNCEMENT_ADMIN = "ANNOUNCEMENT_ADMIN",
     KHUB_ADMIN = "KHUB_ADMIN",
     USERS_ADMIN = "USERS_ADMIN",
     PORTAL_ADMIN = "PORTAL_ADMIN",
@@ -1080,3 +1099,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

@@ -542,6 +542,7 @@ export var FtExternalWebComponentContext;
     FtExternalWebComponentContext["TOPIC_TEMPLATE"] = "TOPIC_TEMPLATE";
     FtExternalWebComponentContext["SEARCH"] = "SEARCH";
     FtExternalWebComponentContext["SEARCH_RESULT"] = "SEARCH_RESULT";
+    FtExternalWebComponentContext["SEARCH_ANNOUNCEMENT"] = "SEARCH_ANNOUNCEMENT";
 })(FtExternalWebComponentContext || (FtExternalWebComponentContext = {}));
 export const isFtExternalWebComponentContext = (o) => Object.keys(FtExternalWebComponentContext).includes(o);
 export const isFtFeedbackCreation = (o) => {
@@ -662,11 +663,12 @@ export const isFtMySearchCreation = (o) => {
 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)
@@ -850,6 +852,8 @@ export const isFtSearchResults = (o) => {
         && (isFtSearchResultsPageInfo(o.paging))
         && ((Array.isArray(o.results)
             && o.results.every((v) => isFtSearchResultCluster(v))))
+        && (o.announcements == null || (Array.isArray(o.announcements)
+            && o.announcements.every((v) => isFtSearchResultAnnouncement(v))))
         && ((Array.isArray(o.facets)
             && o.facets.every((v) => isFtSearchFacet(v))));
 };
@@ -912,13 +916,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))
@@ -927,6 +932,12 @@ export const isFtSearchRequest = (o) => {
         && (o.clusterSortCriterions == null || (Array.isArray(o.clusterSortCriterions)
             && o.clusterSortCriterions.every((v) => isFtPublicClusterSortCriterion(v))));
 };
+export const isFtSearchResultAnnouncement = (o) => {
+    return isObject(o)
+        && (isString(o.link))
+        && (isString(o.text))
+        && (isString(o.title));
+};
 export const isFtSearchResultCluster = (o) => {
     return isObject(o)
         && ((Array.isArray(o.entries)
@@ -1065,9 +1076,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))))
@@ -1109,6 +1129,7 @@ export var FtUserRole;
     FtUserRole["GENERATIVE_AI_USER"] = "GENERATIVE_AI_USER";
     FtUserRole["GENERATIVE_AI_EXPORT_USER"] = "GENERATIVE_AI_EXPORT_USER";
     FtUserRole["CONTENT_PUBLISHER"] = "CONTENT_PUBLISHER";
+    FtUserRole["ANNOUNCEMENT_ADMIN"] = "ANNOUNCEMENT_ADMIN";
     FtUserRole["KHUB_ADMIN"] = "KHUB_ADMIN";
     FtUserRole["USERS_ADMIN"] = "USERS_ADMIN";
     FtUserRole["PORTAL_ADMIN"] = "PORTAL_ADMIN";
@@ -1173,3 +1194,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.100",
+  "version": "1.0.102",
   "description": "Fluid Topics Public API",
   "author": "Fluid Topics dev team <opensource@antidot.net>",
   "license": "LGPL-3.0-only",

package/.npmignore

@@ -1,14 +0,0 @@
-.gradle
-.editorconfig
-build
-build.gradle.kts
-node_modules
-test
-test-browser
-packages
-src
-tsconfig.*
-rollup.config.js
-INTERNAL_README.md
-vite-plugin.mjs
-web-test-runner.config.mjs

package/.yarnrc

@@ -1 +0,0 @@
---frozen-lockfile false