@fluid-topics/public-api 1.0.86-alpha1 → 1.0.86

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.
@@ -21,7 +21,9 @@ export var FtMyLibraryColors;
21
21
  FtMyLibraryColors["orange"] = "orange";
22
22
  FtMyLibraryColors["yellow"] = "yellow";
23
23
  })(FtMyLibraryColors || (FtMyLibraryColors = {}));
24
- export const isFtMyLibraryColors = (o) => Object.keys(FtMyLibraryColors).includes(o);
24
+ export const isFtMyLibraryColors = (o) => {
25
+ return ["black", "green", "blue", "purple", "red", "orange", "yellow"].includes(o);
26
+ };
25
27
  // From: SourceType
26
28
  export var FtTopicOriginType;
27
29
  (function (FtTopicOriginType) {
@@ -29,7 +31,9 @@ export var FtTopicOriginType;
29
31
  FtTopicOriginType["PERSONAL"] = "PERSONAL";
30
32
  FtTopicOriginType["SHARED"] = "SHARED";
31
33
  })(FtTopicOriginType || (FtTopicOriginType = {}));
32
- export const isFtTopicOriginType = (o) => Object.keys(FtTopicOriginType).includes(o);
34
+ export const isFtTopicOriginType = (o) => {
35
+ return ["OFFICIAL", "PERSONAL", "SHARED"].includes(o);
36
+ };
33
37
  export const isFtAnalyticsEventDisplay = (o) => {
34
38
  return isObject(o)
35
39
  && (isNumber(o.width))
@@ -114,7 +118,9 @@ export var FtAnalyticsPublicationType;
114
118
  FtAnalyticsPublicationType["MAP_ATTACHMENT"] = "MAP_ATTACHMENT";
115
119
  FtAnalyticsPublicationType["RESOURCE"] = "RESOURCE";
116
120
  })(FtAnalyticsPublicationType || (FtAnalyticsPublicationType = {}));
117
- export const isFtAnalyticsPublicationType = (o) => Object.keys(FtAnalyticsPublicationType).includes(o);
121
+ export const isFtAnalyticsPublicationType = (o) => {
122
+ return ["STRUCTURED_DOCUMENT", "UNSTRUCTURED_DOCUMENT", "SHARED_PERSONAL_BOOK", "PERSONAL_BOOK", "MAP_ATTACHMENT", "RESOURCE"].includes(o);
123
+ };
118
124
  export const isFtAnalyticsSearchFacet = (o) => {
119
125
  return isObject(o)
120
126
  && (o.dateValue == null || isFtAnalyticsSearchDateFacetValue(o.dateValue))
@@ -133,7 +139,9 @@ export var FtAnalyticsSearchDateFacetValue;
133
139
  FtAnalyticsSearchDateFacetValue["LAST_QUARTER"] = "LAST_QUARTER";
134
140
  FtAnalyticsSearchDateFacetValue["LAST_YEAR"] = "LAST_YEAR";
135
141
  })(FtAnalyticsSearchDateFacetValue || (FtAnalyticsSearchDateFacetValue = {}));
136
- export const isFtAnalyticsSearchDateFacetValue = (o) => Object.keys(FtAnalyticsSearchDateFacetValue).includes(o);
142
+ export const isFtAnalyticsSearchDateFacetValue = (o) => {
143
+ return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR"].includes(o);
144
+ };
137
145
  // From: AnalyticsSearchFacetType
138
146
  export var FtAnalyticsSearchFacetType;
139
147
  (function (FtAnalyticsSearchFacetType) {
@@ -141,14 +149,15 @@ export var FtAnalyticsSearchFacetType;
141
149
  FtAnalyticsSearchFacetType["DATE"] = "DATE";
142
150
  FtAnalyticsSearchFacetType["RANGE"] = "RANGE";
143
151
  })(FtAnalyticsSearchFacetType || (FtAnalyticsSearchFacetType = {}));
144
- export const isFtAnalyticsSearchFacetType = (o) => Object.keys(FtAnalyticsSearchFacetType).includes(o);
152
+ export const isFtAnalyticsSearchFacetType = (o) => {
153
+ return ["VALUE", "DATE", "RANGE"].includes(o);
154
+ };
145
155
  export const isFtAnalyticsEvent = (o) => {
146
156
  return isObject(o)
147
157
  && (isBoolean(o.offline))
148
158
  && (isString(o.appVersion))
149
159
  && (isString(o.appName))
150
- && (isFtAnalyticsEventName(o.name))
151
- && (isString(o.version));
160
+ && (isFtAnalyticsEventName(o.name));
152
161
  };
153
162
  // From: WsAnalyticsEventName
154
163
  export var FtAnalyticsEventName;
@@ -197,7 +206,9 @@ export var FtAnalyticsEventName;
197
206
  FtAnalyticsEventName["USER__LOGOUT"] = "USER__LOGOUT";
198
207
  FtAnalyticsEventName["HEARTBEAT"] = "HEARTBEAT";
199
208
  })(FtAnalyticsEventName || (FtAnalyticsEventName = {}));
200
- export const isFtAnalyticsEventName = (o) => Object.keys(FtAnalyticsEventName).includes(o);
209
+ export const isFtAnalyticsEventName = (o) => {
210
+ return ["BOOKMARK__CREATE", "BOOKMARK__DELETE", "CASE_DEFLECTION__START", "CASE_DEFLECTION__OPEN_TICKET", "CASE_DEFLECTION__RATE", "COLLECTION__CREATE", "COLLECTION__UPDATE", "COLLECTION__DELETE", "DOCUMENT__DISPLAY", "DOCUMENT__DOWNLOAD", "DOCUMENT__PRINT", "DOCUMENT__PROCESS", "DOCUMENT__RATE", "DOCUMENT__SEARCH", "DOCUMENT__START_DISPLAY", "DOCUMENT__UNRATE", "FEEDBACK__SEND", "GEN_AI__COMPLETED_QUERY", "GEN_AI__RATE", "GENAI_CASE_DEFLECTION__START", "GENAI_CASE_DEFLECTION__OPEN_TICKET", "KHUB__PROCESS", "KHUB__SEARCH", "LABELS__DOWNLOAD", "LINK__SHARE", "PAGE__DISPLAY", "PERSONAL_BOOK__CREATE", "PERSONAL_BOOK__DELETE", "PERSONAL_BOOK__UPDATE", "PERSONAL_TOPIC__CREATE", "PERSONAL_TOPIC__UPDATE", "PERSONAL_TOPIC__DELETE", "SAVED_SEARCH__CREATE", "SAVED_SEARCH__DELETE", "SAVED_SEARCH__UPDATE", "SEARCH_PAGE__SELECT", "TOPIC__DISPLAY", "TOPIC__RATE", "TOPIC__START_DISPLAY", "TOPIC__UNRATE", "USER__LOGIN", "USER__LOGOUT", "HEARTBEAT"].includes(o);
211
+ };
201
212
  export const isFtCaseDeflectionEvent = (o) => {
202
213
  return isObject(o)
203
214
  && (o.searchQuery == null || isFtAnalyticsEventSearchQuery(o.searchQuery))
@@ -458,7 +469,9 @@ export var FtTopicContentTarget;
458
469
  FtTopicContentTarget["PAGES"] = "PAGES";
459
470
  FtTopicContentTarget["DESIGNED_READER"] = "DESIGNED_READER";
460
471
  })(FtTopicContentTarget || (FtTopicContentTarget = {}));
461
- export const isFtTopicContentTarget = (o) => Object.keys(FtTopicContentTarget).includes(o);
472
+ export const isFtTopicContentTarget = (o) => {
473
+ return ["THIRD_PARTY", "OFF_THE_GRID", "CONTENT_PACKAGER", "PAGES", "DESIGNED_READER"].includes(o);
474
+ };
462
475
  // From: ExternalWebComponentContext
463
476
  export var FtExternalWebComponentContext;
464
477
  (function (FtExternalWebComponentContext) {
@@ -470,7 +483,9 @@ export var FtExternalWebComponentContext;
470
483
  FtExternalWebComponentContext["SEARCH"] = "SEARCH";
471
484
  FtExternalWebComponentContext["SEARCH_RESULT"] = "SEARCH_RESULT";
472
485
  })(FtExternalWebComponentContext || (FtExternalWebComponentContext = {}));
473
- export const isFtExternalWebComponentContext = (o) => Object.keys(FtExternalWebComponentContext).includes(o);
486
+ export const isFtExternalWebComponentContext = (o) => {
487
+ return ["HOMEPAGE", "CUSTOM", "HEADER", "READER", "TOPIC_TEMPLATE", "SEARCH", "SEARCH_RESULT"].includes(o);
488
+ };
474
489
  export const isFtFeedbackCreation = (o) => {
475
490
  return isObject(o)
476
491
  && (o.from == null || isString(o.from))
@@ -483,7 +498,9 @@ export var FtMetadataHomeLayout;
483
498
  FtMetadataHomeLayout["CUSTOM"] = "CUSTOM";
484
499
  FtMetadataHomeLayout["DESIGNER"] = "DESIGNER";
485
500
  })(FtMetadataHomeLayout || (FtMetadataHomeLayout = {}));
486
- export const isFtMetadataHomeLayout = (o) => Object.keys(FtMetadataHomeLayout).includes(o);
501
+ export const isFtMetadataHomeLayout = (o) => {
502
+ return ["CLASSIC", "CUSTOM", "DESIGNER"].includes(o);
503
+ };
487
504
  export const isFtDefaultLocale = (o) => {
488
505
  return isObject(o)
489
506
  && (isString(o.lang))
@@ -535,7 +552,9 @@ export var FtFacetType;
535
552
  FtFacetType["OR"] = "OR";
536
553
  FtFacetType["MONOVALUED"] = "MONOVALUED";
537
554
  })(FtFacetType || (FtFacetType = {}));
538
- export const isFtFacetType = (o) => Object.keys(FtFacetType).includes(o);
555
+ export const isFtFacetType = (o) => {
556
+ return ["AND", "OR", "MONOVALUED"].includes(o);
557
+ };
539
558
  export const isFtMetadata = (o) => {
540
559
  return isObject(o)
541
560
  && ((Array.isArray(o.values)
@@ -553,7 +572,9 @@ export var FtMetadataSortRule;
553
572
  FtMetadataSortRule["ALPHABET"] = "ALPHABET";
554
573
  FtMetadataSortRule["VERSION"] = "VERSION";
555
574
  })(FtMetadataSortRule || (FtMetadataSortRule = {}));
556
- export const isFtMetadataSortRule = (o) => Object.keys(FtMetadataSortRule).includes(o);
575
+ export const isFtMetadataSortRule = (o) => {
576
+ return ["NONE", "ALPHABET", "VERSION"].includes(o);
577
+ };
557
578
  export const isFtMetadataConfiguration = (o) => {
558
579
  return isObject(o)
559
580
  && ((Array.isArray(o.descriptors)
@@ -592,12 +613,6 @@ export const isFtMySearchRequest = (o) => {
592
613
  && o.metadataFilters.every((v) => isFtLabeledMetadataFilter(v))))
593
614
  && (o.contentLocale == null || isString(o.contentLocale));
594
615
  };
595
- export const isFtPrivacyPolicyConfiguration = (o) => {
596
- return isObject(o)
597
- && (isString(o.policyDescription))
598
- && (isBoolean(o.agreementRequired))
599
- && (isString(o.userAgreementMessage));
600
- };
601
616
  // From: RatingType
602
617
  export var FtRatingType;
603
618
  (function (FtRatingType) {
@@ -606,7 +621,9 @@ export var FtRatingType;
606
621
  FtRatingType["DICHOTOMOUS"] = "DICHOTOMOUS";
607
622
  FtRatingType["NO_RATING"] = "NO_RATING";
608
623
  })(FtRatingType || (FtRatingType = {}));
609
- export const isFtRatingType = (o) => Object.keys(FtRatingType).includes(o);
624
+ export const isFtRatingType = (o) => {
625
+ return ["STARS", "LIKE", "DICHOTOMOUS", "NO_RATING"].includes(o);
626
+ };
610
627
  export const isFtPublicationRating = (o) => {
611
628
  return isObject(o)
612
629
  && (isString(o.date))
@@ -670,7 +687,9 @@ export var FtPeriodFilterType;
670
687
  FtPeriodFilterType["LAST_YEAR"] = "LAST_YEAR";
671
688
  FtPeriodFilterType["CUSTOM"] = "CUSTOM";
672
689
  })(FtPeriodFilterType || (FtPeriodFilterType = {}));
673
- export const isFtPeriodFilterType = (o) => Object.keys(FtPeriodFilterType).includes(o);
690
+ export const isFtPeriodFilterType = (o) => {
691
+ return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR", "CUSTOM"].includes(o);
692
+ };
674
693
  export const isFtSearchPreset = (o) => {
675
694
  return isObject(o)
676
695
  && (isString(o.name))
@@ -685,14 +704,18 @@ export var FtSearchSortCriterionOrder;
685
704
  FtSearchSortCriterionOrder["ASC"] = "ASC";
686
705
  FtSearchSortCriterionOrder["DESC"] = "DESC";
687
706
  })(FtSearchSortCriterionOrder || (FtSearchSortCriterionOrder = {}));
688
- export const isFtSearchSortCriterionOrder = (o) => Object.keys(FtSearchSortCriterionOrder).includes(o);
707
+ export const isFtSearchSortCriterionOrder = (o) => {
708
+ return ["ASC", "DESC"].includes(o);
709
+ };
689
710
  // From: SearchSortCriterionType
690
711
  export var FtSearchSortCriterionType;
691
712
  (function (FtSearchSortCriterionType) {
692
713
  FtSearchSortCriterionType["ALPHA"] = "ALPHA";
693
714
  FtSearchSortCriterionType["NATURAL"] = "NATURAL";
694
715
  })(FtSearchSortCriterionType || (FtSearchSortCriterionType = {}));
695
- export const isFtSearchSortCriterionType = (o) => Object.keys(FtSearchSortCriterionType).includes(o);
716
+ export const isFtSearchSortCriterionType = (o) => {
717
+ return ["ALPHA", "NATURAL"].includes(o);
718
+ };
696
719
  // From: VirtualField
697
720
  export var FtVirtualField;
698
721
  (function (FtVirtualField) {
@@ -700,7 +723,9 @@ export var FtVirtualField;
700
723
  FtVirtualField["TITLE_ONLY"] = "TITLE_ONLY";
701
724
  FtVirtualField["NONE"] = "NONE";
702
725
  })(FtVirtualField || (FtVirtualField = {}));
703
- export const isFtVirtualField = (o) => Object.keys(FtVirtualField).includes(o);
726
+ export const isFtVirtualField = (o) => {
727
+ return ["EVERYWHERE", "TITLE_ONLY", "NONE"].includes(o);
728
+ };
704
729
  export const isFtSearchResultsPageInfo = (o) => {
705
730
  return isObject(o)
706
731
  && (isNumber(o.totalResultsCount))
@@ -715,14 +740,18 @@ export var FtEditorialType;
715
740
  FtEditorialType["BOOK"] = "BOOK";
716
741
  FtEditorialType["SHARED_BOOK"] = "SHARED_BOOK";
717
742
  })(FtEditorialType || (FtEditorialType = {}));
718
- export const isFtEditorialType = (o) => Object.keys(FtEditorialType).includes(o);
743
+ export const isFtEditorialType = (o) => {
744
+ return ["ARTICLE", "BOOK", "SHARED_BOOK"].includes(o);
745
+ };
719
746
  // From: WsOpenMode
720
747
  export var FtOpenMode;
721
748
  (function (FtOpenMode) {
722
749
  FtOpenMode["FLUIDTOPICS"] = "FLUIDTOPICS";
723
750
  FtOpenMode["EXTERNAL"] = "EXTERNAL";
724
751
  })(FtOpenMode || (FtOpenMode = {}));
725
- export const isFtOpenMode = (o) => Object.keys(FtOpenMode).includes(o);
752
+ export const isFtOpenMode = (o) => {
753
+ return ["FLUIDTOPICS", "EXTERNAL"].includes(o);
754
+ };
726
755
  export const isFtPageRequest = (o) => {
727
756
  return isObject(o)
728
757
  && (o.perPage == null || isNumber(o.perPage))
@@ -741,7 +770,9 @@ export var FtCollectionDocumentType;
741
770
  FtCollectionDocumentType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
742
771
  FtCollectionDocumentType["SHARED_BOOK"] = "SHARED_BOOK";
743
772
  })(FtCollectionDocumentType || (FtCollectionDocumentType = {}));
744
- export const isFtCollectionDocumentType = (o) => Object.keys(FtCollectionDocumentType).includes(o);
773
+ export const isFtCollectionDocumentType = (o) => {
774
+ return ["MAP", "DOCUMENT", "TOPIC", "PERSONAL_BOOK", "SHARED_BOOK"].includes(o);
775
+ };
745
776
  export const isFtDateFilter = (o) => {
746
777
  return isObject(o)
747
778
  && (isFtDateFilterType(o.type));
@@ -754,7 +785,9 @@ export var FtDateFilterType;
754
785
  FtDateFilterType["LAST_QUARTER"] = "LAST_QUARTER";
755
786
  FtDateFilterType["LAST_YEAR"] = "LAST_YEAR";
756
787
  })(FtDateFilterType || (FtDateFilterType = {}));
757
- export const isFtDateFilterType = (o) => Object.keys(FtDateFilterType).includes(o);
788
+ export const isFtDateFilterType = (o) => {
789
+ return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR"].includes(o);
790
+ };
758
791
  export const isFtSearchResults = (o) => {
759
792
  return isObject(o)
760
793
  && (o.spellcheck == null || isFtSpellcheck(o.spellcheck))
@@ -916,7 +949,9 @@ export var FtSearchResultType;
916
949
  FtSearchResultType["DOCUMENT"] = "DOCUMENT";
917
950
  FtSearchResultType["TOPIC"] = "TOPIC";
918
951
  })(FtSearchResultType || (FtSearchResultType = {}));
919
- export const isFtSearchResultType = (o) => Object.keys(FtSearchResultType).includes(o);
952
+ export const isFtSearchResultType = (o) => {
953
+ return ["MAP", "DOCUMENT", "TOPIC"].includes(o);
954
+ };
920
955
  // From: WsPublicSearchScope
921
956
  export var FtSearchScope;
922
957
  (function (FtSearchScope) {
@@ -925,7 +960,9 @@ export var FtSearchScope;
925
960
  FtSearchScope["ALL_TOPICS"] = "ALL_TOPICS";
926
961
  FtSearchScope["TOPICS_AND_UNSTRUCTURED_DOCUMENTS"] = "TOPICS_AND_UNSTRUCTURED_DOCUMENTS";
927
962
  })(FtSearchScope || (FtSearchScope = {}));
928
- export const isFtSearchScope = (o) => Object.keys(FtSearchScope).includes(o);
963
+ export const isFtSearchScope = (o) => {
964
+ return ["DEFAULT", "DOCUMENTS", "ALL_TOPICS", "TOPICS_AND_UNSTRUCTURED_DOCUMENTS"].includes(o);
965
+ };
929
966
  export const isFtValueFilter = (o) => {
930
967
  return isObject(o)
931
968
  && (isBoolean(o.negative))
@@ -1025,7 +1062,9 @@ export var FtUserRole;
1025
1062
  FtUserRole["ADMIN"] = "ADMIN";
1026
1063
  FtUserRole["DEVELOPER"] = "DEVELOPER";
1027
1064
  })(FtUserRole || (FtUserRole = {}));
1028
- export const isFtUserRole = (o) => Object.keys(FtUserRole).includes(o);
1065
+ export const isFtUserRole = (o) => {
1066
+ return ["PERSONAL_BOOK_USER", "PERSONAL_BOOK_SHARE_USER", "HTML_EXPORT_USER", "PDF_EXPORT_USER", "SAVED_SEARCH_USER", "COLLECTION_USER", "OFFLINE_USER", "ANALYTICS_USER", "BETA_USER", "DEBUG_USER", "PRINT_USER", "RATING_USER", "FEEDBACK_USER", "GENERATIVE_AI_USER", "GENERATIVE_AI_EXPORT_USER", "CONTENT_PUBLISHER", "KHUB_ADMIN", "USERS_ADMIN", "PORTAL_ADMIN", "ADMIN", "DEVELOPER"].includes(o);
1067
+ };
1029
1068
  export const isFtAuthenticationIdentifier = (o) => {
1030
1069
  return isObject(o)
1031
1070
  && (isString(o.identifier))
@@ -1055,11 +1094,9 @@ export const isFtUserProfile = (o) => {
1055
1094
  return isObject(o)
1056
1095
  && (o.emailAddress == null || isString(o.emailAddress))
1057
1096
  && (o.displayName == null || isString(o.displayName))
1058
- && (o.otpValidated == null || isBoolean(o.otpValidated))
1059
1097
  && ((Array.isArray(o.roles)
1060
1098
  && o.roles.every((v) => isFtUserRole(v))))
1061
1099
  && (o.userId == null || isString(o.userId))
1062
- && (o.privacyPolicyAgreementDate == null || isString(o.privacyPolicyAgreementDate))
1063
1100
  && ((Array.isArray(o.tags)
1064
1101
  && o.tags.every((v) => isString(v))));
1065
1102
  };
@@ -8,7 +8,9 @@ export var FtConfigurationHistoryEntryStatus;
8
8
  FtConfigurationHistoryEntryStatus["VALID"] = "VALID";
9
9
  FtConfigurationHistoryEntryStatus["INVALID"] = "INVALID";
10
10
  })(FtConfigurationHistoryEntryStatus || (FtConfigurationHistoryEntryStatus = {}));
11
- export const isFtConfigurationHistoryEntryStatus = (o) => Object.keys(FtConfigurationHistoryEntryStatus).includes(o);
11
+ export const isFtConfigurationHistoryEntryStatus = (o) => {
12
+ return ["VALID", "INVALID"].includes(o);
13
+ };
12
14
  export const isFtReaderConfiguration = (o) => {
13
15
  return isObject(o)
14
16
  && (isFtReaderFeedbackConfiguration(o.feedback))
@@ -61,7 +63,9 @@ export var TranslationFormat;
61
63
  TranslationFormat["TEXT"] = "TEXT";
62
64
  TranslationFormat["HTML"] = "HTML";
63
65
  })(TranslationFormat || (TranslationFormat = {}));
64
- export const isTranslationFormat = (o) => Object.keys(TranslationFormat).includes(o);
66
+ export const isTranslationFormat = (o) => {
67
+ return ["TEXT", "HTML"].includes(o);
68
+ };
65
69
  export const isFtTranslationInput = (o) => {
66
70
  return isObject(o)
67
71
  && (isString(o.profileId))
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluid-topics/public-api",
3
- "version": "1.0.86-alpha1",
3
+ "version": "1.0.86",
4
4
  "description": "Fluid Topics Public API",
5
5
  "author": "Fluid Topics dev team <opensource@antidot.net>",
6
6
  "license": "LGPL-3.0-only",