@fluid-topics/public-api 1.0.86 → 1.0.87

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