@fluid-topics/public-api 1.0.74 → 1.0.75

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -46,9 +46,12 @@ var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _ar
46
46
  function reject(value) { resume("throw", value); }
47
47
  function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
48
48
  };
49
+ var __importDefault = (this && this.__importDefault) || function (mod) {
50
+ return (mod && mod.__esModule) ? mod : { "default": mod };
51
+ };
49
52
  Object.defineProperty(exports, "__esModule", { value: true });
50
53
  exports.FluidTopicsApi = exports.HttpErrorEvent = exports.HttpError = void 0;
51
- require("cross-fetch/polyfill");
54
+ const cross_fetch_1 = __importDefault(require("cross-fetch"));
52
55
  const GenAIChunkReader_1 = require("./helpers/GenAIChunkReader");
53
56
  const wnd = (typeof window === "undefined" ? globalThis : window);
54
57
  __exportStar(require("./types/ft-common/public"), exports);
@@ -416,7 +419,7 @@ class FluidTopicsApi {
416
419
  var _a;
417
420
  return __awaiter(this, void 0, void 0, function* () {
418
421
  const requestInit = init;
419
- return yield fetch(this.makeAbsolute(endpoint), Object.assign(Object.assign({}, (requestInit !== null && requestInit !== void 0 ? requestInit : {})), { headers: Object.assign(Object.assign({}, this.defaultHeaders), ((_a = requestInit === null || requestInit === void 0 ? void 0 : requestInit.headers) !== null && _a !== void 0 ? _a : {})) }));
422
+ return yield (0, cross_fetch_1.default)(this.makeAbsolute(endpoint), Object.assign(Object.assign({}, (requestInit !== null && requestInit !== void 0 ? requestInit : {})), { headers: Object.assign(Object.assign({}, this.defaultHeaders), ((_a = requestInit === null || requestInit === void 0 ? void 0 : requestInit.headers) !== null && _a !== void 0 ? _a : {})) }));
420
423
  });
421
424
  }
422
425
  upload(method, endpoint, body, onProgress = () => undefined) {
@@ -454,7 +457,7 @@ class FluidTopicsApi {
454
457
  .then(getBody);
455
458
  }
456
459
  fetchRawData(endpoint, v) {
457
- return fetch(this.withVersion(endpoint, v), {
460
+ return (0, cross_fetch_1.default)(this.withVersion(endpoint, v), {
458
461
  headers: this.defaultHeaders,
459
462
  credentials: this.authorization == null ? "include" : undefined
460
463
  })
@@ -1,8 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.FtPeriodFilterType = exports.isFtSearchPreferencesConfiguration = exports.isFtMetadataPreferenceConfiguration = exports.isFtMapResource = exports.isFtTopicsRatingSummary = exports.isFtTopicRating = exports.isFtRatingSummary = exports.isFtRatingCreation = exports.isFtPublicationRatingSummary = exports.isFtPublicationRating = exports.isFtRatingType = exports.FtRatingType = exports.isFtMySearchRequest = exports.isFtMySearch = exports.isFtMetadataDescriptor = exports.isFtMetadataConfiguration = exports.isFtMetadataSortRule = exports.FtMetadataSortRule = exports.isFtMetadata = exports.isFtFacetType = exports.FtFacetType = exports.isFtUiLocale = exports.isFtMessageContext = exports.isFtSearchLocales = exports.isFtSearchLocale = exports.isFtMetadataHomeLayout = exports.FtMetadataHomeLayout = exports.isFtFeedbackCreation = exports.isFtExternalWebComponentContext = exports.FtExternalWebComponentContext = exports.isFtTopicContentTarget = exports.FtTopicContentTarget = exports.isFtUnstructuredDocument = exports.isFtTopicOrigin = exports.isFtTopic = exports.isFtTocNode = exports.isFtMapStyles = exports.isFtMap = exports.isFtCollectionDocument = exports.isFtBookmark = exports.isFtPersonalBookTopicLinkCreation = exports.isFtPersonalBookNodeCreation = exports.isFtPersonalBookMetadataUpdate = exports.isFtPersonalBookCreation = exports.isFtCredentials = exports.isFtTopicOriginType = exports.FtTopicOriginType = exports.isFtMyLibraryColors = exports.FtMyLibraryColors = exports.isFtHttpErrorDetails = void 0;
4
- exports.FtUserRole = exports.isFtSuggestResults = exports.isFtSuggestResult = exports.isFtSuggestRequest = exports.isFtTopicResource = exports.isFtSpellcheck = exports.isFtSearchSortCriterion = exports.isFtSearchFacetEntry = exports.isFtSearchFacetConf = exports.isFtSearchFacet = exports.isFtValueFilter = exports.isFtSearchScope = exports.FtSearchScope = exports.isFtSearchResultType = exports.FtSearchResultType = exports.isFtSearchResultTopic = exports.isFtSearchResultMap = exports.isFtSearchResultUnstructuredDocument = exports.isFtSearchResultClusterEntry = exports.isFtSearchResultCluster = exports.isFtSearchRequest = exports.isFtSearchPrior = exports.isFtRangeFilter = exports.isFtPeriod = exports.isFtMetadataFilter = exports.isFtPeriodFilter = exports.isFtLegacyMetadataFilter = exports.isFtLegacyLabeledMetadataFilter = exports.isFtLabeledMetadataFilter = exports.isFtSearchResults = exports.isFtDateFilterType = exports.FtDateFilterType = exports.isFtDateFilter = exports.isFtCollectionDocumentType = exports.FtCollectionDocumentType = exports.isFtPublicClusterSortCriterion = exports.isFtPageRequest = exports.isFtOpenMode = exports.FtOpenMode = exports.isFtEditorialType = exports.FtEditorialType = exports.isFtSearchResultsPageInfo = exports.isFtVirtualField = exports.FtVirtualField = exports.isFtSearchSortCriterionType = exports.FtSearchSortCriterionType = exports.isFtSearchSortCriterionOrder = exports.FtSearchSortCriterionOrder = exports.isFtSearchPreset = exports.isFtPeriodFilterType = void 0;
5
- exports.isFtWatermark = exports.isFtUserProfile = exports.isFtSession = exports.isFtSearchPreferences = exports.isFtAuthenticatedSession = exports.isFtAuthenticationIdentifier = exports.isFtUserRole = void 0;
4
+ exports.isFtWatermark = exports.isFtUserProfile = exports.isFtSession = exports.isFtSearchPreferences = exports.isFtAuthenticatedSession = exports.isFtAuthenticationIdentifier = exports.isFtUserRole = exports.FtUserRole = exports.isFtSuggestResults = exports.isFtSuggestResult = exports.isFtSuggestRequest = exports.isFtTopicResource = exports.isFtSpellcheck = exports.isFtSearchSortCriterion = exports.isFtSearchFacetEntry = exports.isFtSearchFacetConf = exports.isFtSearchFacet = exports.isFtSearchScope = exports.FtSearchScope = exports.isFtSearchResultType = exports.FtSearchResultType = exports.isFtSearchResultTopic = exports.isFtSearchResultMap = exports.isFtSearchResultUnstructuredDocument = exports.isFtSearchResultClusterEntry = exports.isFtSearchResultCluster = exports.isFtSearchRequest = exports.isFtSearchPrior = exports.isFtPeriodFilter = exports.isFtPeriod = exports.isFtLabeledSearchFilter = exports.isFtSearchResults = exports.isFtCollectionDocumentType = exports.FtCollectionDocumentType = exports.isFtPublicClusterSortCriterion = exports.isFtPageRequest = exports.isFtOpenMode = exports.FtOpenMode = exports.isFtEditorialType = exports.FtEditorialType = exports.isFtSearchResultsPageInfo = exports.isFtVirtualField = exports.FtVirtualField = exports.isFtSearchSortCriterionType = exports.FtSearchSortCriterionType = exports.isFtSearchSortCriterionOrder = exports.FtSearchSortCriterionOrder = exports.isFtSearchPreset = exports.isFtSearchFilter = exports.isFtPeriodFilterType = void 0;
6
5
  const isObject = (o) => typeof o === "object" && o != null;
7
6
  const isBoolean = (o) => typeof o === "boolean";
8
7
  const isNumber = (o) => typeof o === "number";
@@ -338,16 +337,14 @@ const isFtMySearch = (o) => {
338
337
  exports.isFtMySearch = isFtMySearch;
339
338
  const isFtMySearchRequest = (o) => {
340
339
  return isObject(o)
341
- && (o.periodFilter == null || o.periodFilter == null || (0, exports.isFtPeriodFilter)(o.periodFilter))
340
+ && (o.periodFilter == null || (0, exports.isFtPeriodFilter)(o.periodFilter))
342
341
  && (isString(o.query))
343
342
  && (o.scope == null || (0, exports.isFtSearchScope)(o.scope))
344
- && (o.filters == null || (Array.isArray(o.filters)
345
- && o.filters.every((v) => (0, exports.isFtLegacyLabeledMetadataFilter)(v))))
343
+ && ((Array.isArray(o.filters)
344
+ && o.filters.every((v) => (0, exports.isFtLabeledSearchFilter)(v))))
346
345
  && ((Array.isArray(o.sort)
347
346
  && o.sort.every((v) => (0, exports.isFtSearchSortCriterion)(v))))
348
347
  && (o.virtualField == null || (0, exports.isFtVirtualField)(o.virtualField))
349
- && (o.metadataFilters == null || (Array.isArray(o.metadataFilters)
350
- && o.metadataFilters.every((v) => (0, exports.isFtLabeledMetadataFilter)(v))))
351
348
  && (o.contentLocale == null || isString(o.contentLocale));
352
349
  };
353
350
  exports.isFtMySearchRequest = isFtMySearchRequest;
@@ -439,13 +436,21 @@ const isFtPeriodFilterType = (o) => {
439
436
  return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR", "CUSTOM"].includes(o);
440
437
  };
441
438
  exports.isFtPeriodFilterType = isFtPeriodFilterType;
439
+ const isFtSearchFilter = (o) => {
440
+ return isObject(o)
441
+ && (isBoolean(o.negative))
442
+ && ((Array.isArray(o.values)
443
+ && o.values.every((v) => isString(v))))
444
+ && (isString(o.key));
445
+ };
446
+ exports.isFtSearchFilter = isFtSearchFilter;
442
447
  const isFtSearchPreset = (o) => {
443
448
  return isObject(o)
444
449
  && (isString(o.name))
450
+ && ((Array.isArray(o.filters)
451
+ && o.filters.every((v) => (0, exports.isFtSearchFilter)(v))))
445
452
  && (isNumber(o.priority))
446
- && (o.contentLocale == null || isString(o.contentLocale))
447
- && ((Array.isArray(o.metadataFilters)
448
- && o.metadataFilters.every((v) => (0, exports.isFtMetadataFilter)(v))));
453
+ && (o.contentLocale == null || isString(o.contentLocale));
449
454
  };
450
455
  exports.isFtSearchPreset = isFtSearchPreset;
451
456
  // From: SearchSortCriterionOrder
@@ -532,23 +537,6 @@ const isFtCollectionDocumentType = (o) => {
532
537
  return ["MAP", "DOCUMENT", "TOPIC", "PERSONAL_BOOK", "SHARED_BOOK"].includes(o);
533
538
  };
534
539
  exports.isFtCollectionDocumentType = isFtCollectionDocumentType;
535
- const isFtDateFilter = (o) => {
536
- return isObject(o)
537
- && ((0, exports.isFtDateFilterType)(o.type));
538
- };
539
- exports.isFtDateFilter = isFtDateFilter;
540
- // From: WsPublicDateFilterType
541
- var FtDateFilterType;
542
- (function (FtDateFilterType) {
543
- FtDateFilterType["LAST_WEEK"] = "LAST_WEEK";
544
- FtDateFilterType["LAST_MONTH"] = "LAST_MONTH";
545
- FtDateFilterType["LAST_QUARTER"] = "LAST_QUARTER";
546
- FtDateFilterType["LAST_YEAR"] = "LAST_YEAR";
547
- })(FtDateFilterType = exports.FtDateFilterType || (exports.FtDateFilterType = {}));
548
- const isFtDateFilterType = (o) => {
549
- return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR"].includes(o);
550
- };
551
- exports.isFtDateFilterType = isFtDateFilterType;
552
540
  const isFtSearchResults = (o) => {
553
541
  return isObject(o)
554
542
  && (o.spellcheck == null || (0, exports.isFtSpellcheck)(o.spellcheck))
@@ -559,16 +547,7 @@ const isFtSearchResults = (o) => {
559
547
  && o.facets.every((v) => (0, exports.isFtSearchFacet)(v))));
560
548
  };
561
549
  exports.isFtSearchResults = isFtSearchResults;
562
- const isFtLabeledMetadataFilter = (o) => {
563
- return isObject(o)
564
- && (o.valueFilter == null || (0, exports.isFtValueFilter)(o.valueFilter))
565
- && (o.rangeFilter == null || (0, exports.isFtRangeFilter)(o.rangeFilter))
566
- && (isString(o.label))
567
- && (isString(o.key))
568
- && (o.dateFilter == null || (0, exports.isFtDateFilter)(o.dateFilter));
569
- };
570
- exports.isFtLabeledMetadataFilter = isFtLabeledMetadataFilter;
571
- const isFtLegacyLabeledMetadataFilter = (o) => {
550
+ const isFtLabeledSearchFilter = (o) => {
572
551
  return isObject(o)
573
552
  && (isBoolean(o.negative))
574
553
  && ((Array.isArray(o.values)
@@ -576,15 +555,13 @@ const isFtLegacyLabeledMetadataFilter = (o) => {
576
555
  && (isString(o.label))
577
556
  && (isString(o.key));
578
557
  };
579
- exports.isFtLegacyLabeledMetadataFilter = isFtLegacyLabeledMetadataFilter;
580
- const isFtLegacyMetadataFilter = (o) => {
558
+ exports.isFtLabeledSearchFilter = isFtLabeledSearchFilter;
559
+ const isFtPeriod = (o) => {
581
560
  return isObject(o)
582
- && (isBoolean(o.negative))
583
- && ((Array.isArray(o.values)
584
- && o.values.every((v) => isString(v))))
585
- && (isString(o.key));
561
+ && (isString(o.from))
562
+ && (isString(o.to));
586
563
  };
587
- exports.isFtLegacyMetadataFilter = isFtLegacyMetadataFilter;
564
+ exports.isFtPeriod = isFtPeriod;
588
565
  const isFtPeriodFilter = (o) => {
589
566
  return isObject(o)
590
567
  && (o.period == null || (0, exports.isFtPeriod)(o.period))
@@ -592,26 +569,6 @@ const isFtPeriodFilter = (o) => {
592
569
  && (o.key == null || isString(o.key));
593
570
  };
594
571
  exports.isFtPeriodFilter = isFtPeriodFilter;
595
- const isFtMetadataFilter = (o) => {
596
- return isObject(o)
597
- && (o.valueFilter == null || (0, exports.isFtValueFilter)(o.valueFilter))
598
- && (o.rangeFilter == null || (0, exports.isFtRangeFilter)(o.rangeFilter))
599
- && (isString(o.key))
600
- && (o.dateFilter == null || (0, exports.isFtDateFilter)(o.dateFilter));
601
- };
602
- exports.isFtMetadataFilter = isFtMetadataFilter;
603
- const isFtPeriod = (o) => {
604
- return isObject(o)
605
- && (isString(o.from))
606
- && (isString(o.to));
607
- };
608
- exports.isFtPeriod = isFtPeriod;
609
- const isFtRangeFilter = (o) => {
610
- return isObject(o)
611
- && (isString(o.from))
612
- && (isString(o.to));
613
- };
614
- exports.isFtRangeFilter = isFtRangeFilter;
615
572
  const isFtSearchPrior = (o) => {
616
573
  return isObject(o)
617
574
  && (isNumber(o.weight))
@@ -621,16 +578,14 @@ const isFtSearchPrior = (o) => {
621
578
  exports.isFtSearchPrior = isFtSearchPrior;
622
579
  const isFtSearchRequest = (o) => {
623
580
  return isObject(o)
624
- && (o.periodFilter == null || o.periodFilter == null || (0, exports.isFtPeriodFilter)(o.periodFilter))
581
+ && (o.periodFilter == null || (0, exports.isFtPeriodFilter)(o.periodFilter))
625
582
  && (isString(o.query))
626
583
  && ((0, exports.isFtPageRequest)(o.paging))
627
- && (o.filters == null || (Array.isArray(o.filters)
628
- && o.filters.every((v) => (0, exports.isFtLegacyMetadataFilter)(v))))
584
+ && ((Array.isArray(o.filters)
585
+ && o.filters.every((v) => (0, exports.isFtSearchFilter)(v))))
629
586
  && ((Array.isArray(o.sort)
630
587
  && o.sort.every((v) => (0, exports.isFtSearchSortCriterion)(v))))
631
588
  && (o.virtualField == null || (0, exports.isFtVirtualField)(o.virtualField))
632
- && ((Array.isArray(o.metadataFilters)
633
- && o.metadataFilters.every((v) => (0, exports.isFtMetadataFilter)(v))))
634
589
  && ((Array.isArray(o.facets)
635
590
  && o.facets.every((v) => (0, exports.isFtSearchFacetConf)(v))))
636
591
  && (o.scope == null || (0, exports.isFtSearchScope)(o.scope))
@@ -740,13 +695,6 @@ const isFtSearchScope = (o) => {
740
695
  return ["DEFAULT", "DOCUMENTS", "ALL_TOPICS"].includes(o);
741
696
  };
742
697
  exports.isFtSearchScope = isFtSearchScope;
743
- const isFtValueFilter = (o) => {
744
- return isObject(o)
745
- && (isBoolean(o.negative))
746
- && ((Array.isArray(o.values)
747
- && o.values.every((v) => isString(v))));
748
- };
749
- exports.isFtValueFilter = isFtValueFilter;
750
698
  const isFtSearchFacet = (o) => {
751
699
  return isObject(o)
752
700
  && (isBoolean(o.hierarchical))
@@ -801,12 +749,12 @@ const isFtSuggestRequest = (o) => {
801
749
  return isObject(o)
802
750
  && (isString(o.input))
803
751
  && (o.scope == null || (0, exports.isFtSearchScope)(o.scope))
752
+ && ((Array.isArray(o.filters)
753
+ && o.filters.every((v) => (0, exports.isFtSearchFilter)(v))))
804
754
  && ((Array.isArray(o.sort)
805
755
  && o.sort.every((v) => (0, exports.isFtSearchSortCriterion)(v))))
806
756
  && (o.maxCount == null || isNumber(o.maxCount))
807
- && (o.contentLocale == null || isString(o.contentLocale))
808
- && ((Array.isArray(o.metadataFilters)
809
- && o.metadataFilters.every((v) => (0, exports.isFtMetadataFilter)(v))));
757
+ && (o.contentLocale == null || isString(o.contentLocale));
810
758
  };
811
759
  exports.isFtSuggestRequest = isFtSuggestRequest;
812
760
  const isFtSuggestResult = (o) => {
@@ -866,10 +814,8 @@ const isFtAuthenticatedSession = (o) => {
866
814
  exports.isFtAuthenticatedSession = isFtAuthenticatedSession;
867
815
  const isFtSearchPreferences = (o) => {
868
816
  return isObject(o)
869
- && (o.defaultFilters == null || (Array.isArray(o.defaultFilters)
870
- && o.defaultFilters.every((v) => (0, exports.isFtLegacyMetadataFilter)(v))))
871
- && ((Array.isArray(o.defaultMetadataFilters)
872
- && o.defaultMetadataFilters.every((v) => (0, exports.isFtMetadataFilter)(v))));
817
+ && ((Array.isArray(o.defaultFilters)
818
+ && o.defaultFilters.every((v) => (0, exports.isFtSearchFilter)(v))));
873
819
  };
874
820
  exports.isFtSearchPreferences = isFtSearchPreferences;
875
821
  const isFtSession = (o) => {
@@ -1,4 +1,3 @@
1
- import "cross-fetch/polyfill";
2
1
  import { FtAuthenticatedSession, FtBookmark, FtCollectionDocument, FtHttpErrorDetails, FtMap, FtMapResource, FtMessageContext, FtMetadataConfiguration, FtMySearch, FtRatingSummary, FtRatingType, FtRatingTypeKeys, FtSearchLocales, FtSearchRequest, FtSearchResults, FtSession, FtSuggestRequest, FtSuggestResults, FtTocNode, FtTopic, FtTopicContentTarget, FtTopicContentTargetKeys, FtUiLocale, FtUnstructuredDocument } from "./types/ft-common/public";
3
2
  import { FtClusteredSemanticSearchReply, FtGenAIRating, FtMapAttachment, FtPaginatedToc, FtRagInput, FtReaderConfiguration, FtSemanticSearchRequest, FtSemanticSearchResponseItem } from "./types/ft-server/public";
4
3
  import { GenAIChunk } from "./helpers/GenAIChunkReader";
@@ -1,4 +1,4 @@
1
- import "cross-fetch/polyfill";
1
+ import fetch from "cross-fetch";
2
2
  import { GenAIChunkReader } from "./helpers/GenAIChunkReader";
3
3
  const wnd = (typeof window === "undefined" ? globalThis : window);
4
4
  export * from "./types/ft-common/public";
@@ -262,10 +262,9 @@ export interface FtMySearchRequest {
262
262
  periodFilter?: FtPeriodFilter;
263
263
  query: string;
264
264
  scope?: FtSearchScopeKeys;
265
- filters?: Array<FtLegacyLabeledMetadataFilter>;
265
+ filters: Array<FtLabeledSearchFilter>;
266
266
  sort: Array<FtSearchSortCriterion>;
267
267
  virtualField?: FtVirtualFieldKeys;
268
- metadataFilters?: Array<FtLabeledMetadataFilter>;
269
268
  contentLocale?: string;
270
269
  }
271
270
  export declare const isFtMySearchRequest: (o: any) => o is FtMySearchRequest;
@@ -335,11 +334,17 @@ export declare enum FtPeriodFilterType {
335
334
  }
336
335
  export type FtPeriodFilterTypeKeys = keyof typeof FtPeriodFilterType;
337
336
  export declare const isFtPeriodFilterType: (o: any) => o is FtPeriodFilterType;
337
+ export interface FtSearchFilter {
338
+ negative: boolean;
339
+ values: Array<string>;
340
+ key: string;
341
+ }
342
+ export declare const isFtSearchFilter: (o: any) => o is FtSearchFilter;
338
343
  export interface FtSearchPreset {
339
344
  name: string;
345
+ filters: Array<FtSearchFilter>;
340
346
  priority: number;
341
347
  contentLocale?: string;
342
- metadataFilters: Array<FtMetadataFilter>;
343
348
  }
344
349
  export declare const isFtSearchPreset: (o: any) => o is FtSearchPreset;
345
350
  export declare enum FtSearchSortCriterionOrder {
@@ -399,18 +404,6 @@ export declare enum FtCollectionDocumentType {
399
404
  }
400
405
  export type FtCollectionDocumentTypeKeys = keyof typeof FtCollectionDocumentType;
401
406
  export declare const isFtCollectionDocumentType: (o: any) => o is FtCollectionDocumentType;
402
- export interface FtDateFilter {
403
- type: FtDateFilterTypeKeys;
404
- }
405
- export declare const isFtDateFilter: (o: any) => o is FtDateFilter;
406
- export declare enum FtDateFilterType {
407
- LAST_WEEK = "LAST_WEEK",
408
- LAST_MONTH = "LAST_MONTH",
409
- LAST_QUARTER = "LAST_QUARTER",
410
- LAST_YEAR = "LAST_YEAR"
411
- }
412
- export type FtDateFilterTypeKeys = keyof typeof FtDateFilterType;
413
- export declare const isFtDateFilterType: (o: any) => o is FtDateFilterType;
414
407
  export interface FtSearchResults {
415
408
  spellcheck?: FtSpellcheck;
416
409
  paging: FtSearchResultsPageInfo;
@@ -418,50 +411,24 @@ export interface FtSearchResults {
418
411
  facets: Array<FtSearchFacet>;
419
412
  }
420
413
  export declare const isFtSearchResults: (o: any) => o is FtSearchResults;
421
- export interface FtLabeledMetadataFilter {
422
- valueFilter?: FtValueFilter;
423
- rangeFilter?: FtRangeFilter;
424
- label: string;
425
- key: string;
426
- dateFilter?: FtDateFilter;
427
- }
428
- export declare const isFtLabeledMetadataFilter: (o: any) => o is FtLabeledMetadataFilter;
429
- export interface FtLegacyLabeledMetadataFilter {
414
+ export interface FtLabeledSearchFilter {
430
415
  negative: boolean;
431
416
  values: Array<string>;
432
417
  label: string;
433
418
  key: string;
434
419
  }
435
- export declare const isFtLegacyLabeledMetadataFilter: (o: any) => o is FtLegacyLabeledMetadataFilter;
436
- export interface FtLegacyMetadataFilter {
437
- negative: boolean;
438
- values: Array<string>;
439
- key: string;
420
+ export declare const isFtLabeledSearchFilter: (o: any) => o is FtLabeledSearchFilter;
421
+ export interface FtPeriod {
422
+ from: string;
423
+ to: string;
440
424
  }
441
- export declare const isFtLegacyMetadataFilter: (o: any) => o is FtLegacyMetadataFilter;
425
+ export declare const isFtPeriod: (o: any) => o is FtPeriod;
442
426
  export interface FtPeriodFilter {
443
427
  period?: FtPeriod;
444
428
  periodType: FtPeriodFilterTypeKeys;
445
429
  key?: string;
446
430
  }
447
431
  export declare const isFtPeriodFilter: (o: any) => o is FtPeriodFilter;
448
- export interface FtMetadataFilter {
449
- valueFilter?: FtValueFilter;
450
- rangeFilter?: FtRangeFilter;
451
- key: string;
452
- dateFilter?: FtDateFilter;
453
- }
454
- export declare const isFtMetadataFilter: (o: any) => o is FtMetadataFilter;
455
- export interface FtPeriod {
456
- from: string;
457
- to: string;
458
- }
459
- export declare const isFtPeriod: (o: any) => o is FtPeriod;
460
- export interface FtRangeFilter {
461
- from: string;
462
- to: string;
463
- }
464
- export declare const isFtRangeFilter: (o: any) => o is FtRangeFilter;
465
432
  export interface FtSearchPrior {
466
433
  weight: number;
467
434
  value: string;
@@ -472,10 +439,9 @@ export interface FtSearchRequest {
472
439
  periodFilter?: FtPeriodFilter;
473
440
  query: string;
474
441
  paging: FtPageRequest;
475
- filters?: Array<FtLegacyMetadataFilter>;
442
+ filters: Array<FtSearchFilter>;
476
443
  sort: Array<FtSearchSortCriterion>;
477
444
  virtualField?: FtVirtualFieldKeys;
478
- metadataFilters: Array<FtMetadataFilter>;
479
445
  facets: Array<FtSearchFacetConf>;
480
446
  scope?: FtSearchScopeKeys;
481
447
  lastModified?: any;
@@ -566,11 +532,6 @@ export declare enum FtSearchScope {
566
532
  }
567
533
  export type FtSearchScopeKeys = keyof typeof FtSearchScope;
568
534
  export declare const isFtSearchScope: (o: any) => o is FtSearchScope;
569
- export interface FtValueFilter {
570
- negative: boolean;
571
- values: Array<string>;
572
- }
573
- export declare const isFtValueFilter: (o: any) => o is FtValueFilter;
574
535
  export interface FtSearchFacet {
575
536
  hierarchical: boolean;
576
537
  label: string;
@@ -616,10 +577,10 @@ export declare const isFtTopicResource: (o: any) => o is FtTopicResource;
616
577
  export interface FtSuggestRequest {
617
578
  input: string;
618
579
  scope?: FtSearchScopeKeys;
580
+ filters: Array<FtSearchFilter>;
619
581
  sort: Array<FtSearchSortCriterion>;
620
582
  maxCount?: number;
621
583
  contentLocale?: string;
622
- metadataFilters: Array<FtMetadataFilter>;
623
584
  }
624
585
  export declare const isFtSuggestRequest: (o: any) => o is FtSuggestRequest;
625
586
  export interface FtSuggestResult {
@@ -669,8 +630,7 @@ export interface FtAuthenticatedSession {
669
630
  }
670
631
  export declare const isFtAuthenticatedSession: (o: any) => o is FtAuthenticatedSession;
671
632
  export interface FtSearchPreferences {
672
- defaultFilters?: Array<FtLegacyMetadataFilter>;
673
- defaultMetadataFilters: Array<FtMetadataFilter>;
633
+ defaultFilters: Array<FtSearchFilter>;
674
634
  }
675
635
  export declare const isFtSearchPreferences: (o: any) => o is FtSearchPreferences;
676
636
  export interface FtSession {
@@ -303,16 +303,14 @@ export const isFtMySearch = (o) => {
303
303
  };
304
304
  export const isFtMySearchRequest = (o) => {
305
305
  return isObject(o)
306
- && (o.periodFilter == null || o.periodFilter == null || isFtPeriodFilter(o.periodFilter))
306
+ && (o.periodFilter == null || isFtPeriodFilter(o.periodFilter))
307
307
  && (isString(o.query))
308
308
  && (o.scope == null || isFtSearchScope(o.scope))
309
- && (o.filters == null || (Array.isArray(o.filters)
310
- && o.filters.every((v) => isFtLegacyLabeledMetadataFilter(v))))
309
+ && ((Array.isArray(o.filters)
310
+ && o.filters.every((v) => isFtLabeledSearchFilter(v))))
311
311
  && ((Array.isArray(o.sort)
312
312
  && o.sort.every((v) => isFtSearchSortCriterion(v))))
313
313
  && (o.virtualField == null || isFtVirtualField(o.virtualField))
314
- && (o.metadataFilters == null || (Array.isArray(o.metadataFilters)
315
- && o.metadataFilters.every((v) => isFtLabeledMetadataFilter(v))))
316
314
  && (o.contentLocale == null || isString(o.contentLocale));
317
315
  };
318
316
  // From: RatingType
@@ -392,13 +390,20 @@ export var FtPeriodFilterType;
392
390
  export const isFtPeriodFilterType = (o) => {
393
391
  return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR", "CUSTOM"].includes(o);
394
392
  };
393
+ export const isFtSearchFilter = (o) => {
394
+ return isObject(o)
395
+ && (isBoolean(o.negative))
396
+ && ((Array.isArray(o.values)
397
+ && o.values.every((v) => isString(v))))
398
+ && (isString(o.key));
399
+ };
395
400
  export const isFtSearchPreset = (o) => {
396
401
  return isObject(o)
397
402
  && (isString(o.name))
403
+ && ((Array.isArray(o.filters)
404
+ && o.filters.every((v) => isFtSearchFilter(v))))
398
405
  && (isNumber(o.priority))
399
- && (o.contentLocale == null || isString(o.contentLocale))
400
- && ((Array.isArray(o.metadataFilters)
401
- && o.metadataFilters.every((v) => isFtMetadataFilter(v))));
406
+ && (o.contentLocale == null || isString(o.contentLocale));
402
407
  };
403
408
  // From: SearchSortCriterionOrder
404
409
  export var FtSearchSortCriterionOrder;
@@ -475,21 +480,6 @@ export var FtCollectionDocumentType;
475
480
  export const isFtCollectionDocumentType = (o) => {
476
481
  return ["MAP", "DOCUMENT", "TOPIC", "PERSONAL_BOOK", "SHARED_BOOK"].includes(o);
477
482
  };
478
- export const isFtDateFilter = (o) => {
479
- return isObject(o)
480
- && (isFtDateFilterType(o.type));
481
- };
482
- // From: WsPublicDateFilterType
483
- export var FtDateFilterType;
484
- (function (FtDateFilterType) {
485
- FtDateFilterType["LAST_WEEK"] = "LAST_WEEK";
486
- FtDateFilterType["LAST_MONTH"] = "LAST_MONTH";
487
- FtDateFilterType["LAST_QUARTER"] = "LAST_QUARTER";
488
- FtDateFilterType["LAST_YEAR"] = "LAST_YEAR";
489
- })(FtDateFilterType || (FtDateFilterType = {}));
490
- export const isFtDateFilterType = (o) => {
491
- return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR"].includes(o);
492
- };
493
483
  export const isFtSearchResults = (o) => {
494
484
  return isObject(o)
495
485
  && (o.spellcheck == null || isFtSpellcheck(o.spellcheck))
@@ -499,15 +489,7 @@ export const isFtSearchResults = (o) => {
499
489
  && ((Array.isArray(o.facets)
500
490
  && o.facets.every((v) => isFtSearchFacet(v))));
501
491
  };
502
- export const isFtLabeledMetadataFilter = (o) => {
503
- return isObject(o)
504
- && (o.valueFilter == null || isFtValueFilter(o.valueFilter))
505
- && (o.rangeFilter == null || isFtRangeFilter(o.rangeFilter))
506
- && (isString(o.label))
507
- && (isString(o.key))
508
- && (o.dateFilter == null || isFtDateFilter(o.dateFilter));
509
- };
510
- export const isFtLegacyLabeledMetadataFilter = (o) => {
492
+ export const isFtLabeledSearchFilter = (o) => {
511
493
  return isObject(o)
512
494
  && (isBoolean(o.negative))
513
495
  && ((Array.isArray(o.values)
@@ -515,12 +497,10 @@ export const isFtLegacyLabeledMetadataFilter = (o) => {
515
497
  && (isString(o.label))
516
498
  && (isString(o.key));
517
499
  };
518
- export const isFtLegacyMetadataFilter = (o) => {
500
+ export const isFtPeriod = (o) => {
519
501
  return isObject(o)
520
- && (isBoolean(o.negative))
521
- && ((Array.isArray(o.values)
522
- && o.values.every((v) => isString(v))))
523
- && (isString(o.key));
502
+ && (isString(o.from))
503
+ && (isString(o.to));
524
504
  };
525
505
  export const isFtPeriodFilter = (o) => {
526
506
  return isObject(o)
@@ -528,23 +508,6 @@ export const isFtPeriodFilter = (o) => {
528
508
  && (isFtPeriodFilterType(o.periodType))
529
509
  && (o.key == null || isString(o.key));
530
510
  };
531
- export const isFtMetadataFilter = (o) => {
532
- return isObject(o)
533
- && (o.valueFilter == null || isFtValueFilter(o.valueFilter))
534
- && (o.rangeFilter == null || isFtRangeFilter(o.rangeFilter))
535
- && (isString(o.key))
536
- && (o.dateFilter == null || isFtDateFilter(o.dateFilter));
537
- };
538
- export const isFtPeriod = (o) => {
539
- return isObject(o)
540
- && (isString(o.from))
541
- && (isString(o.to));
542
- };
543
- export const isFtRangeFilter = (o) => {
544
- return isObject(o)
545
- && (isString(o.from))
546
- && (isString(o.to));
547
- };
548
511
  export const isFtSearchPrior = (o) => {
549
512
  return isObject(o)
550
513
  && (isNumber(o.weight))
@@ -553,16 +516,14 @@ export const isFtSearchPrior = (o) => {
553
516
  };
554
517
  export const isFtSearchRequest = (o) => {
555
518
  return isObject(o)
556
- && (o.periodFilter == null || o.periodFilter == null || isFtPeriodFilter(o.periodFilter))
519
+ && (o.periodFilter == null || isFtPeriodFilter(o.periodFilter))
557
520
  && (isString(o.query))
558
521
  && (isFtPageRequest(o.paging))
559
- && (o.filters == null || (Array.isArray(o.filters)
560
- && o.filters.every((v) => isFtLegacyMetadataFilter(v))))
522
+ && ((Array.isArray(o.filters)
523
+ && o.filters.every((v) => isFtSearchFilter(v))))
561
524
  && ((Array.isArray(o.sort)
562
525
  && o.sort.every((v) => isFtSearchSortCriterion(v))))
563
526
  && (o.virtualField == null || isFtVirtualField(o.virtualField))
564
- && ((Array.isArray(o.metadataFilters)
565
- && o.metadataFilters.every((v) => isFtMetadataFilter(v))))
566
527
  && ((Array.isArray(o.facets)
567
528
  && o.facets.every((v) => isFtSearchFacetConf(v))))
568
529
  && (o.scope == null || isFtSearchScope(o.scope))
@@ -664,12 +625,6 @@ export var FtSearchScope;
664
625
  export const isFtSearchScope = (o) => {
665
626
  return ["DEFAULT", "DOCUMENTS", "ALL_TOPICS"].includes(o);
666
627
  };
667
- export const isFtValueFilter = (o) => {
668
- return isObject(o)
669
- && (isBoolean(o.negative))
670
- && ((Array.isArray(o.values)
671
- && o.values.every((v) => isString(v))));
672
- };
673
628
  export const isFtSearchFacet = (o) => {
674
629
  return isObject(o)
675
630
  && (isBoolean(o.hierarchical))
@@ -718,12 +673,12 @@ export const isFtSuggestRequest = (o) => {
718
673
  return isObject(o)
719
674
  && (isString(o.input))
720
675
  && (o.scope == null || isFtSearchScope(o.scope))
676
+ && ((Array.isArray(o.filters)
677
+ && o.filters.every((v) => isFtSearchFilter(v))))
721
678
  && ((Array.isArray(o.sort)
722
679
  && o.sort.every((v) => isFtSearchSortCriterion(v))))
723
680
  && (o.maxCount == null || isNumber(o.maxCount))
724
- && (o.contentLocale == null || isString(o.contentLocale))
725
- && ((Array.isArray(o.metadataFilters)
726
- && o.metadataFilters.every((v) => isFtMetadataFilter(v))));
681
+ && (o.contentLocale == null || isString(o.contentLocale));
727
682
  };
728
683
  export const isFtSuggestResult = (o) => {
729
684
  return isObject(o)
@@ -777,10 +732,8 @@ export const isFtAuthenticatedSession = (o) => {
777
732
  };
778
733
  export const isFtSearchPreferences = (o) => {
779
734
  return isObject(o)
780
- && (o.defaultFilters == null || (Array.isArray(o.defaultFilters)
781
- && o.defaultFilters.every((v) => isFtLegacyMetadataFilter(v))))
782
- && ((Array.isArray(o.defaultMetadataFilters)
783
- && o.defaultMetadataFilters.every((v) => isFtMetadataFilter(v))));
735
+ && ((Array.isArray(o.defaultFilters)
736
+ && o.defaultFilters.every((v) => isFtSearchFilter(v))));
784
737
  };
785
738
  export const isFtSession = (o) => {
786
739
  return isObject(o)