@fluid-topics/public-api 1.0.76-alpha → 1.0.76

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

@@ -262,9 +262,10 @@ export interface FtMySearchRequest {
     periodFilter?: FtPeriodFilter;
     query: string;
     scope?: FtSearchScopeKeys;
-    filters: Array<FtLabeledSearchFilter>;
+    filters?: Array<FtLegacyLabeledMetadataFilter>;
     sort: Array<FtSearchSortCriterion>;
     virtualField?: FtVirtualFieldKeys;
+    metadataFilters?: Array<FtLabeledMetadataFilter>;
     contentLocale?: string;
 }
 export declare const isFtMySearchRequest: (o: any) => o is FtMySearchRequest;
@@ -334,17 +335,11 @@ export declare enum FtPeriodFilterType {
 }
 export type FtPeriodFilterTypeKeys = keyof typeof FtPeriodFilterType;
 export declare const isFtPeriodFilterType: (o: any) => o is FtPeriodFilterType;
-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>;
     priority: number;
     contentLocale?: string;
+    metadataFilters: Array<FtMetadataFilter>;
 }
 export declare const isFtSearchPreset: (o: any) => o is FtSearchPreset;
 export declare enum FtSearchSortCriterionOrder {
@@ -404,6 +399,18 @@ export declare enum FtCollectionDocumentType {
 }
 export type FtCollectionDocumentTypeKeys = keyof typeof FtCollectionDocumentType;
 export declare const isFtCollectionDocumentType: (o: any) => o is FtCollectionDocumentType;
+export interface FtDateFilter {
+    type: FtDateFilterTypeKeys;
+}
+export declare const isFtDateFilter: (o: any) => o is FtDateFilter;
+export declare enum FtDateFilterType {
+    LAST_WEEK = "LAST_WEEK",
+    LAST_MONTH = "LAST_MONTH",
+    LAST_QUARTER = "LAST_QUARTER",
+    LAST_YEAR = "LAST_YEAR"
+}
+export type FtDateFilterTypeKeys = keyof typeof FtDateFilterType;
+export declare const isFtDateFilterType: (o: any) => o is FtDateFilterType;
 export interface FtSearchResults {
     spellcheck?: FtSpellcheck;
     paging: FtSearchResultsPageInfo;
@@ -411,24 +418,50 @@ export interface FtSearchResults {
     facets: Array<FtSearchFacet>;
 }
 export declare const isFtSearchResults: (o: any) => o is FtSearchResults;
-export interface FtLabeledSearchFilter {
+export interface FtLabeledMetadataFilter {
+    valueFilter?: FtValueFilter;
+    rangeFilter?: FtRangeFilter;
+    label: string;
+    key: string;
+    dateFilter?: FtDateFilter;
+}
+export declare const isFtLabeledMetadataFilter: (o: any) => o is FtLabeledMetadataFilter;
+export interface FtLegacyLabeledMetadataFilter {
     negative: boolean;
     values: Array<string>;
     label: string;
     key: string;
 }
-export declare const isFtLabeledSearchFilter: (o: any) => o is FtLabeledSearchFilter;
-export interface FtPeriod {
-    from: string;
-    to: string;
+export declare const isFtLegacyLabeledMetadataFilter: (o: any) => o is FtLegacyLabeledMetadataFilter;
+export interface FtLegacyMetadataFilter {
+    negative: boolean;
+    values: Array<string>;
+    key: string;
 }
-export declare const isFtPeriod: (o: any) => o is FtPeriod;
+export declare const isFtLegacyMetadataFilter: (o: any) => o is FtLegacyMetadataFilter;
 export interface FtPeriodFilter {
     period?: FtPeriod;
     periodType: FtPeriodFilterTypeKeys;
     key?: string;
 }
 export declare const isFtPeriodFilter: (o: any) => o is FtPeriodFilter;
+export interface FtMetadataFilter {
+    valueFilter?: FtValueFilter;
+    rangeFilter?: FtRangeFilter;
+    key: string;
+    dateFilter?: FtDateFilter;
+}
+export declare const isFtMetadataFilter: (o: any) => o is FtMetadataFilter;
+export interface FtPeriod {
+    from: string;
+    to: string;
+}
+export declare const isFtPeriod: (o: any) => o is FtPeriod;
+export interface FtRangeFilter {
+    from: string;
+    to: string;
+}
+export declare const isFtRangeFilter: (o: any) => o is FtRangeFilter;
 export interface FtSearchPrior {
     weight: number;
     value: string;
@@ -439,9 +472,10 @@ export interface FtSearchRequest {
     periodFilter?: FtPeriodFilter;
     query: string;
     paging: FtPageRequest;
-    filters: Array<FtSearchFilter>;
+    filters?: Array<FtLegacyMetadataFilter>;
     sort: Array<FtSearchSortCriterion>;
     virtualField?: FtVirtualFieldKeys;
+    metadataFilters: Array<FtMetadataFilter>;
     facets: Array<FtSearchFacetConf>;
     scope?: FtSearchScopeKeys;
     lastModified?: any;
@@ -532,6 +566,11 @@ export declare enum FtSearchScope {
 }
 export type FtSearchScopeKeys = keyof typeof FtSearchScope;
 export declare const isFtSearchScope: (o: any) => o is FtSearchScope;
+export interface FtValueFilter {
+    negative: boolean;
+    values: Array<string>;
+}
+export declare const isFtValueFilter: (o: any) => o is FtValueFilter;
 export interface FtSearchFacet {
     hierarchical: boolean;
     label: string;
@@ -577,10 +616,10 @@ export declare const isFtTopicResource: (o: any) => o is FtTopicResource;
 export interface FtSuggestRequest {
     input: string;
     scope?: FtSearchScopeKeys;
-    filters: Array<FtSearchFilter>;
     sort: Array<FtSearchSortCriterion>;
     maxCount?: number;
     contentLocale?: string;
+    metadataFilters: Array<FtMetadataFilter>;
 }
 export declare const isFtSuggestRequest: (o: any) => o is FtSuggestRequest;
 export interface FtSuggestResult {
@@ -630,7 +669,8 @@ export interface FtAuthenticatedSession {
 }
 export declare const isFtAuthenticatedSession: (o: any) => o is FtAuthenticatedSession;
 export interface FtSearchPreferences {
-    defaultFilters: Array<FtSearchFilter>;
+    defaultFilters?: Array<FtLegacyMetadataFilter>;
+    defaultMetadataFilters: Array<FtMetadataFilter>;
 }
 export declare const isFtSearchPreferences: (o: any) => o is FtSearchPreferences;
 export interface FtSession {

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

@@ -303,14 +303,16 @@ export const isFtMySearch = (o) => {
 };
 export const isFtMySearchRequest = (o) => {
     return isObject(o)
-        && (o.periodFilter == null || isFtPeriodFilter(o.periodFilter))
+        && (o.periodFilter == null || 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))))
+        && (o.filters == null || (Array.isArray(o.filters)
+            && o.filters.every((v) => isFtLegacyLabeledMetadataFilter(v))))
         && ((Array.isArray(o.sort)
             && o.sort.every((v) => isFtSearchSortCriterion(v))))
         && (o.virtualField == null || isFtVirtualField(o.virtualField))
+        && (o.metadataFilters == null || (Array.isArray(o.metadataFilters)
+            && o.metadataFilters.every((v) => isFtLabeledMetadataFilter(v))))
         && (o.contentLocale == null || isString(o.contentLocale));
 };
 // From: RatingType
@@ -390,20 +392,13 @@ export var FtPeriodFilterType;
 export const isFtPeriodFilterType = (o) => {
     return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR", "CUSTOM"].includes(o);
 };
-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))))
         && (isNumber(o.priority))
-        && (o.contentLocale == null || isString(o.contentLocale));
+        && (o.contentLocale == null || isString(o.contentLocale))
+        && ((Array.isArray(o.metadataFilters)
+            && o.metadataFilters.every((v) => isFtMetadataFilter(v))));
 };
 // From: SearchSortCriterionOrder
 export var FtSearchSortCriterionOrder;
@@ -480,6 +475,21 @@ export var FtCollectionDocumentType;
 export const isFtCollectionDocumentType = (o) => {
     return ["MAP", "DOCUMENT", "TOPIC", "PERSONAL_BOOK", "SHARED_BOOK"].includes(o);
 };
+export const isFtDateFilter = (o) => {
+    return isObject(o)
+        && (isFtDateFilterType(o.type));
+};
+// From: WsPublicDateFilterType
+export var FtDateFilterType;
+(function (FtDateFilterType) {
+    FtDateFilterType["LAST_WEEK"] = "LAST_WEEK";
+    FtDateFilterType["LAST_MONTH"] = "LAST_MONTH";
+    FtDateFilterType["LAST_QUARTER"] = "LAST_QUARTER";
+    FtDateFilterType["LAST_YEAR"] = "LAST_YEAR";
+})(FtDateFilterType || (FtDateFilterType = {}));
+export const isFtDateFilterType = (o) => {
+    return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR"].includes(o);
+};
 export const isFtSearchResults = (o) => {
     return isObject(o)
         && (o.spellcheck == null || isFtSpellcheck(o.spellcheck))
@@ -489,7 +499,15 @@ export const isFtSearchResults = (o) => {
         && ((Array.isArray(o.facets)
             && o.facets.every((v) => isFtSearchFacet(v))));
 };
-export const isFtLabeledSearchFilter = (o) => {
+export const isFtLabeledMetadataFilter = (o) => {
+    return isObject(o)
+        && (o.valueFilter == null || isFtValueFilter(o.valueFilter))
+        && (o.rangeFilter == null || isFtRangeFilter(o.rangeFilter))
+        && (isString(o.label))
+        && (isString(o.key))
+        && (o.dateFilter == null || isFtDateFilter(o.dateFilter));
+};
+export const isFtLegacyLabeledMetadataFilter = (o) => {
     return isObject(o)
         && (isBoolean(o.negative))
         && ((Array.isArray(o.values)
@@ -497,10 +515,12 @@ export const isFtLabeledSearchFilter = (o) => {
         && (isString(o.label))
         && (isString(o.key));
 };
-export const isFtPeriod = (o) => {
+export const isFtLegacyMetadataFilter = (o) => {
     return isObject(o)
-        && (isString(o.from))
-        && (isString(o.to));
+        && (isBoolean(o.negative))
+        && ((Array.isArray(o.values)
+            && o.values.every((v) => isString(v))))
+        && (isString(o.key));
 };
 export const isFtPeriodFilter = (o) => {
     return isObject(o)
@@ -508,6 +528,23 @@ export const isFtPeriodFilter = (o) => {
         && (isFtPeriodFilterType(o.periodType))
         && (o.key == null || isString(o.key));
 };
+export const isFtMetadataFilter = (o) => {
+    return isObject(o)
+        && (o.valueFilter == null || isFtValueFilter(o.valueFilter))
+        && (o.rangeFilter == null || isFtRangeFilter(o.rangeFilter))
+        && (isString(o.key))
+        && (o.dateFilter == null || isFtDateFilter(o.dateFilter));
+};
+export const isFtPeriod = (o) => {
+    return isObject(o)
+        && (isString(o.from))
+        && (isString(o.to));
+};
+export const isFtRangeFilter = (o) => {
+    return isObject(o)
+        && (isString(o.from))
+        && (isString(o.to));
+};
 export const isFtSearchPrior = (o) => {
     return isObject(o)
         && (isNumber(o.weight))
@@ -516,14 +553,16 @@ export const isFtSearchPrior = (o) => {
 };
 export const isFtSearchRequest = (o) => {
     return isObject(o)
-        && (o.periodFilter == null || isFtPeriodFilter(o.periodFilter))
+        && (o.periodFilter == null || o.periodFilter == null || isFtPeriodFilter(o.periodFilter))
         && (isString(o.query))
         && (isFtPageRequest(o.paging))
-        && ((Array.isArray(o.filters)
-            && o.filters.every((v) => isFtSearchFilter(v))))
+        && (o.filters == null || (Array.isArray(o.filters)
+            && o.filters.every((v) => isFtLegacyMetadataFilter(v))))
         && ((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.scope == null || isFtSearchScope(o.scope))
@@ -625,6 +664,12 @@ export var FtSearchScope;
 export const isFtSearchScope = (o) => {
     return ["DEFAULT", "DOCUMENTS", "ALL_TOPICS"].includes(o);
 };
+export const isFtValueFilter = (o) => {
+    return isObject(o)
+        && (isBoolean(o.negative))
+        && ((Array.isArray(o.values)
+            && o.values.every((v) => isString(v))));
+};
 export const isFtSearchFacet = (o) => {
     return isObject(o)
         && (isBoolean(o.hierarchical))
@@ -673,12 +718,12 @@ export const isFtSuggestRequest = (o) => {
     return isObject(o)
         && (isString(o.input))
         && (o.scope == null || isFtSearchScope(o.scope))
-        && ((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));
+        && (o.contentLocale == null || isString(o.contentLocale))
+        && ((Array.isArray(o.metadataFilters)
+            && o.metadataFilters.every((v) => isFtMetadataFilter(v))));
 };
 export const isFtSuggestResult = (o) => {
     return isObject(o)
@@ -732,8 +777,10 @@ export const isFtAuthenticatedSession = (o) => {
 };
 export const isFtSearchPreferences = (o) => {
     return isObject(o)
-        && ((Array.isArray(o.defaultFilters)
-            && o.defaultFilters.every((v) => isFtSearchFilter(v))));
+        && (o.defaultFilters == null || (Array.isArray(o.defaultFilters)
+            && o.defaultFilters.every((v) => isFtLegacyMetadataFilter(v))))
+        && ((Array.isArray(o.defaultMetadataFilters)
+            && o.defaultMetadataFilters.every((v) => isFtMetadataFilter(v))));
 };
 export const isFtSession = (o) => {
     return isObject(o)

package/package.json

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