@fluid-topics/public-api 1.0.86 → 1.0.88

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,9 +141,7 @@ 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))
@@ -206,9 +196,7 @@ export var FtAnalyticsEventName;
206
196
  FtAnalyticsEventName["USER__LOGOUT"] = "USER__LOGOUT";
207
197
  FtAnalyticsEventName["HEARTBEAT"] = "HEARTBEAT";
208
198
  })(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
- };
199
+ export const isFtAnalyticsEventName = (o) => Object.keys(FtAnalyticsEventName).includes(o);
212
200
  export const isFtCaseDeflectionEvent = (o) => {
213
201
  return isObject(o)
214
202
  && (o.searchQuery == null || isFtAnalyticsEventSearchQuery(o.searchQuery))
@@ -397,6 +385,7 @@ export const isFtMap = (o) => {
397
385
  && (o.originUrl == null || isString(o.originUrl))
398
386
  && (isString(o.fingerprint))
399
387
  && (isString(o.readerUrl))
388
+ && (o.untranslatedTitle == null || o.untranslatedTitle == null || isString(o.untranslatedTitle))
400
389
  && (o.khubVersion == null || isString(o.khubVersion))
401
390
  && (isString(o.id))
402
391
  && (o.lang == null || isString(o.lang));
@@ -417,6 +406,7 @@ export const isFtTocNode = (o) => {
417
406
  && o.children.every((v) => isFtTocNode(v))))
418
407
  && (o.origin == null || isFtTopicOrigin(o.origin))
419
408
  && (isString(o.contentId))
409
+ && (o.untranslatedTitle == null || o.untranslatedTitle == null || isString(o.untranslatedTitle))
420
410
  && (isString(o.title));
421
411
  };
422
412
  export const isFtTopic = (o) => {
@@ -469,8 +459,11 @@ export var FtTopicContentTarget;
469
459
  FtTopicContentTarget["PAGES"] = "PAGES";
470
460
  FtTopicContentTarget["DESIGNED_READER"] = "DESIGNED_READER";
471
461
  })(FtTopicContentTarget || (FtTopicContentTarget = {}));
472
- export const isFtTopicContentTarget = (o) => {
473
- return ["THIRD_PARTY", "OFF_THE_GRID", "CONTENT_PACKAGER", "PAGES", "DESIGNED_READER"].includes(o);
462
+ export const isFtTopicContentTarget = (o) => Object.keys(FtTopicContentTarget).includes(o);
463
+ export const isFtTranslationContent = (o) => {
464
+ return isObject(o)
465
+ && (isBoolean(o.isTranslationError))
466
+ && (isString(o.content));
474
467
  };
475
468
  // From: ExternalWebComponentContext
476
469
  export var FtExternalWebComponentContext;
@@ -483,9 +476,7 @@ export var FtExternalWebComponentContext;
483
476
  FtExternalWebComponentContext["SEARCH"] = "SEARCH";
484
477
  FtExternalWebComponentContext["SEARCH_RESULT"] = "SEARCH_RESULT";
485
478
  })(FtExternalWebComponentContext || (FtExternalWebComponentContext = {}));
486
- export const isFtExternalWebComponentContext = (o) => {
487
- return ["HOMEPAGE", "CUSTOM", "HEADER", "READER", "TOPIC_TEMPLATE", "SEARCH", "SEARCH_RESULT"].includes(o);
488
- };
479
+ export const isFtExternalWebComponentContext = (o) => Object.keys(FtExternalWebComponentContext).includes(o);
489
480
  export const isFtFeedbackCreation = (o) => {
490
481
  return isObject(o)
491
482
  && (o.from == null || isString(o.from))
@@ -498,9 +489,7 @@ export var FtMetadataHomeLayout;
498
489
  FtMetadataHomeLayout["CUSTOM"] = "CUSTOM";
499
490
  FtMetadataHomeLayout["DESIGNER"] = "DESIGNER";
500
491
  })(FtMetadataHomeLayout || (FtMetadataHomeLayout = {}));
501
- export const isFtMetadataHomeLayout = (o) => {
502
- return ["CLASSIC", "CUSTOM", "DESIGNER"].includes(o);
503
- };
492
+ export const isFtMetadataHomeLayout = (o) => Object.keys(FtMetadataHomeLayout).includes(o);
504
493
  export const isFtDefaultLocale = (o) => {
505
494
  return isObject(o)
506
495
  && (isString(o.lang))
@@ -552,9 +541,7 @@ export var FtFacetType;
552
541
  FtFacetType["OR"] = "OR";
553
542
  FtFacetType["MONOVALUED"] = "MONOVALUED";
554
543
  })(FtFacetType || (FtFacetType = {}));
555
- export const isFtFacetType = (o) => {
556
- return ["AND", "OR", "MONOVALUED"].includes(o);
557
- };
544
+ export const isFtFacetType = (o) => Object.keys(FtFacetType).includes(o);
558
545
  export const isFtMetadata = (o) => {
559
546
  return isObject(o)
560
547
  && ((Array.isArray(o.values)
@@ -572,9 +559,7 @@ export var FtMetadataSortRule;
572
559
  FtMetadataSortRule["ALPHABET"] = "ALPHABET";
573
560
  FtMetadataSortRule["VERSION"] = "VERSION";
574
561
  })(FtMetadataSortRule || (FtMetadataSortRule = {}));
575
- export const isFtMetadataSortRule = (o) => {
576
- return ["NONE", "ALPHABET", "VERSION"].includes(o);
577
- };
562
+ export const isFtMetadataSortRule = (o) => Object.keys(FtMetadataSortRule).includes(o);
578
563
  export const isFtMetadataConfiguration = (o) => {
579
564
  return isObject(o)
580
565
  && ((Array.isArray(o.descriptors)
@@ -613,6 +598,12 @@ export const isFtMySearchRequest = (o) => {
613
598
  && o.metadataFilters.every((v) => isFtLabeledMetadataFilter(v))))
614
599
  && (o.contentLocale == null || isString(o.contentLocale));
615
600
  };
601
+ export const isFtPrivacyPolicyConfiguration = (o) => {
602
+ return isObject(o)
603
+ && (isString(o.policyDescription))
604
+ && (isBoolean(o.agreementRequired))
605
+ && (isString(o.userAgreementMessage));
606
+ };
616
607
  // From: RatingType
617
608
  export var FtRatingType;
618
609
  (function (FtRatingType) {
@@ -621,9 +612,7 @@ export var FtRatingType;
621
612
  FtRatingType["DICHOTOMOUS"] = "DICHOTOMOUS";
622
613
  FtRatingType["NO_RATING"] = "NO_RATING";
623
614
  })(FtRatingType || (FtRatingType = {}));
624
- export const isFtRatingType = (o) => {
625
- return ["STARS", "LIKE", "DICHOTOMOUS", "NO_RATING"].includes(o);
626
- };
615
+ export const isFtRatingType = (o) => Object.keys(FtRatingType).includes(o);
627
616
  export const isFtPublicationRating = (o) => {
628
617
  return isObject(o)
629
618
  && (isString(o.date))
@@ -687,9 +676,7 @@ export var FtPeriodFilterType;
687
676
  FtPeriodFilterType["LAST_YEAR"] = "LAST_YEAR";
688
677
  FtPeriodFilterType["CUSTOM"] = "CUSTOM";
689
678
  })(FtPeriodFilterType || (FtPeriodFilterType = {}));
690
- export const isFtPeriodFilterType = (o) => {
691
- return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR", "CUSTOM"].includes(o);
692
- };
679
+ export const isFtPeriodFilterType = (o) => Object.keys(FtPeriodFilterType).includes(o);
693
680
  export const isFtSearchPreset = (o) => {
694
681
  return isObject(o)
695
682
  && (isString(o.name))
@@ -704,18 +691,14 @@ export var FtSearchSortCriterionOrder;
704
691
  FtSearchSortCriterionOrder["ASC"] = "ASC";
705
692
  FtSearchSortCriterionOrder["DESC"] = "DESC";
706
693
  })(FtSearchSortCriterionOrder || (FtSearchSortCriterionOrder = {}));
707
- export const isFtSearchSortCriterionOrder = (o) => {
708
- return ["ASC", "DESC"].includes(o);
709
- };
694
+ export const isFtSearchSortCriterionOrder = (o) => Object.keys(FtSearchSortCriterionOrder).includes(o);
710
695
  // From: SearchSortCriterionType
711
696
  export var FtSearchSortCriterionType;
712
697
  (function (FtSearchSortCriterionType) {
713
698
  FtSearchSortCriterionType["ALPHA"] = "ALPHA";
714
699
  FtSearchSortCriterionType["NATURAL"] = "NATURAL";
715
700
  })(FtSearchSortCriterionType || (FtSearchSortCriterionType = {}));
716
- export const isFtSearchSortCriterionType = (o) => {
717
- return ["ALPHA", "NATURAL"].includes(o);
718
- };
701
+ export const isFtSearchSortCriterionType = (o) => Object.keys(FtSearchSortCriterionType).includes(o);
719
702
  // From: VirtualField
720
703
  export var FtVirtualField;
721
704
  (function (FtVirtualField) {
@@ -723,9 +706,7 @@ export var FtVirtualField;
723
706
  FtVirtualField["TITLE_ONLY"] = "TITLE_ONLY";
724
707
  FtVirtualField["NONE"] = "NONE";
725
708
  })(FtVirtualField || (FtVirtualField = {}));
726
- export const isFtVirtualField = (o) => {
727
- return ["EVERYWHERE", "TITLE_ONLY", "NONE"].includes(o);
728
- };
709
+ export const isFtVirtualField = (o) => Object.keys(FtVirtualField).includes(o);
729
710
  export const isFtSearchResultsPageInfo = (o) => {
730
711
  return isObject(o)
731
712
  && (isNumber(o.totalResultsCount))
@@ -740,18 +721,14 @@ export var FtEditorialType;
740
721
  FtEditorialType["BOOK"] = "BOOK";
741
722
  FtEditorialType["SHARED_BOOK"] = "SHARED_BOOK";
742
723
  })(FtEditorialType || (FtEditorialType = {}));
743
- export const isFtEditorialType = (o) => {
744
- return ["ARTICLE", "BOOK", "SHARED_BOOK"].includes(o);
745
- };
724
+ export const isFtEditorialType = (o) => Object.keys(FtEditorialType).includes(o);
746
725
  // From: WsOpenMode
747
726
  export var FtOpenMode;
748
727
  (function (FtOpenMode) {
749
728
  FtOpenMode["FLUIDTOPICS"] = "FLUIDTOPICS";
750
729
  FtOpenMode["EXTERNAL"] = "EXTERNAL";
751
730
  })(FtOpenMode || (FtOpenMode = {}));
752
- export const isFtOpenMode = (o) => {
753
- return ["FLUIDTOPICS", "EXTERNAL"].includes(o);
754
- };
731
+ export const isFtOpenMode = (o) => Object.keys(FtOpenMode).includes(o);
755
732
  export const isFtPageRequest = (o) => {
756
733
  return isObject(o)
757
734
  && (o.perPage == null || isNumber(o.perPage))
@@ -770,9 +747,7 @@ export var FtCollectionDocumentType;
770
747
  FtCollectionDocumentType["PERSONAL_BOOK"] = "PERSONAL_BOOK";
771
748
  FtCollectionDocumentType["SHARED_BOOK"] = "SHARED_BOOK";
772
749
  })(FtCollectionDocumentType || (FtCollectionDocumentType = {}));
773
- export const isFtCollectionDocumentType = (o) => {
774
- return ["MAP", "DOCUMENT", "TOPIC", "PERSONAL_BOOK", "SHARED_BOOK"].includes(o);
775
- };
750
+ export const isFtCollectionDocumentType = (o) => Object.keys(FtCollectionDocumentType).includes(o);
776
751
  export const isFtDateFilter = (o) => {
777
752
  return isObject(o)
778
753
  && (isFtDateFilterType(o.type));
@@ -785,9 +760,7 @@ export var FtDateFilterType;
785
760
  FtDateFilterType["LAST_QUARTER"] = "LAST_QUARTER";
786
761
  FtDateFilterType["LAST_YEAR"] = "LAST_YEAR";
787
762
  })(FtDateFilterType || (FtDateFilterType = {}));
788
- export const isFtDateFilterType = (o) => {
789
- return ["LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR"].includes(o);
790
- };
763
+ export const isFtDateFilterType = (o) => Object.keys(FtDateFilterType).includes(o);
791
764
  export const isFtSearchResults = (o) => {
792
765
  return isObject(o)
793
766
  && (o.spellcheck == null || isFtSpellcheck(o.spellcheck))
@@ -949,9 +922,7 @@ export var FtSearchResultType;
949
922
  FtSearchResultType["DOCUMENT"] = "DOCUMENT";
950
923
  FtSearchResultType["TOPIC"] = "TOPIC";
951
924
  })(FtSearchResultType || (FtSearchResultType = {}));
952
- export const isFtSearchResultType = (o) => {
953
- return ["MAP", "DOCUMENT", "TOPIC"].includes(o);
954
- };
925
+ export const isFtSearchResultType = (o) => Object.keys(FtSearchResultType).includes(o);
955
926
  // From: WsPublicSearchScope
956
927
  export var FtSearchScope;
957
928
  (function (FtSearchScope) {
@@ -960,9 +931,7 @@ export var FtSearchScope;
960
931
  FtSearchScope["ALL_TOPICS"] = "ALL_TOPICS";
961
932
  FtSearchScope["TOPICS_AND_UNSTRUCTURED_DOCUMENTS"] = "TOPICS_AND_UNSTRUCTURED_DOCUMENTS";
962
933
  })(FtSearchScope || (FtSearchScope = {}));
963
- export const isFtSearchScope = (o) => {
964
- return ["DEFAULT", "DOCUMENTS", "ALL_TOPICS", "TOPICS_AND_UNSTRUCTURED_DOCUMENTS"].includes(o);
965
- };
934
+ export const isFtSearchScope = (o) => Object.keys(FtSearchScope).includes(o);
966
935
  export const isFtValueFilter = (o) => {
967
936
  return isObject(o)
968
937
  && (isBoolean(o.negative))
@@ -1062,9 +1031,7 @@ export var FtUserRole;
1062
1031
  FtUserRole["ADMIN"] = "ADMIN";
1063
1032
  FtUserRole["DEVELOPER"] = "DEVELOPER";
1064
1033
  })(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
- };
1034
+ export const isFtUserRole = (o) => Object.keys(FtUserRole).includes(o);
1068
1035
  export const isFtAuthenticationIdentifier = (o) => {
1069
1036
  return isObject(o)
1070
1037
  && (isString(o.identifier))
@@ -1094,9 +1061,11 @@ export const isFtUserProfile = (o) => {
1094
1061
  return isObject(o)
1095
1062
  && (o.emailAddress == null || isString(o.emailAddress))
1096
1063
  && (o.displayName == null || isString(o.displayName))
1064
+ && (o.otpValidated == null || isBoolean(o.otpValidated))
1097
1065
  && ((Array.isArray(o.roles)
1098
1066
  && o.roles.every((v) => isFtUserRole(v))))
1099
1067
  && (o.userId == null || isString(o.userId))
1068
+ && (o.privacyPolicyAgreementDate == null || isString(o.privacyPolicyAgreementDate))
1100
1069
  && ((Array.isArray(o.tags)
1101
1070
  && o.tags.every((v) => isString(v))));
1102
1071
  };
@@ -50,14 +50,27 @@ export declare enum TranslationFormat {
50
50
  }
51
51
  export type TranslationFormatKeys = keyof typeof TranslationFormat;
52
52
  export declare const isTranslationFormat: (o: any) => o is TranslationFormat;
53
- export interface FtTranslationInput {
53
+ export interface FtTranslationLanguagesResponse {
54
+ items: Array<FtTranslationLocale>;
55
+ }
56
+ export declare const isFtTranslationLanguagesResponse: (o: any) => o is FtTranslationLanguagesResponse;
57
+ export interface FtTranslationRequest {
54
58
  profileId: string;
55
59
  format?: TranslationFormatKeys;
56
60
  destinationLanguage: string;
57
- content: string;
61
+ content: Array<string>;
58
62
  sourceLanguage?: string;
59
63
  }
60
- export declare const isFtTranslationInput: (o: any) => o is FtTranslationInput;
64
+ export declare const isFtTranslationRequest: (o: any) => o is FtTranslationRequest;
65
+ export interface FtTranslationResponse {
66
+ items: Array<string>;
67
+ }
68
+ export declare const isFtTranslationResponse: (o: any) => o is FtTranslationResponse;
69
+ export interface FtTranslationLocale {
70
+ code: string;
71
+ label: string;
72
+ }
73
+ export declare const isFtTranslationLocale: (o: any) => o is FtTranslationLocale;
61
74
  export interface FtMapAttachment {
62
75
  file: string;
63
76
  size?: number;
@@ -76,6 +89,7 @@ export declare const isFtPageConfiguration: (o: any) => o is FtPageConfiguration
76
89
  export interface FtPaginatedToc {
77
90
  configuration: FtPaginationConfiguration;
78
91
  paginatedToc: Array<FtPaginatedTocNode>;
92
+ translationError: boolean;
79
93
  }
80
94
  export declare const isFtPaginatedToc: (o: any) => o is FtPaginatedToc;
81
95
  export interface FtPaginatedTocNode {
@@ -87,9 +101,15 @@ export interface FtPaginatedTocNode {
87
101
  pageConfiguration?: FtPageConfiguration;
88
102
  origin?: any;
89
103
  contentId?: string;
104
+ untranslatedTitle?: string;
90
105
  title?: string;
91
106
  }
92
107
  export declare const isFtPaginatedTocNode: (o: any) => o is FtPaginatedTocNode;
108
+ export interface FtPaginatedTocNodeWithTranslationFailure {
109
+ paginatedToc: FtPaginatedTocNode;
110
+ translationError: boolean;
111
+ }
112
+ export declare const isFtPaginatedTocNodeWithTranslationFailure: (o: any) => o is FtPaginatedTocNodeWithTranslationFailure;
93
113
  export interface FtPaginationConfiguration {
94
114
  splitCurrentPageToc: boolean;
95
115
  }
@@ -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,17 +61,31 @@ 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);
64
+ export const isTranslationFormat = (o) => Object.keys(TranslationFormat).includes(o);
65
+ export const isFtTranslationLanguagesResponse = (o) => {
66
+ return isObject(o)
67
+ && ((Array.isArray(o.items)
68
+ && o.items.every((v) => isFtTranslationLocale(v))));
68
69
  };
69
- export const isFtTranslationInput = (o) => {
70
+ export const isFtTranslationRequest = (o) => {
70
71
  return isObject(o)
71
72
  && (isString(o.profileId))
72
73
  && (o.format == null || isTranslationFormat(o.format))
73
74
  && (isString(o.destinationLanguage))
74
- && (isString(o.content))
75
+ && ((Array.isArray(o.content)
76
+ && o.content.every((v) => isString(v))))
75
77
  && (o.sourceLanguage == null || isString(o.sourceLanguage));
76
78
  };
79
+ export const isFtTranslationResponse = (o) => {
80
+ return isObject(o)
81
+ && ((Array.isArray(o.items)
82
+ && o.items.every((v) => isString(v))));
83
+ };
84
+ export const isFtTranslationLocale = (o) => {
85
+ return isObject(o)
86
+ && (isString(o.code))
87
+ && (isString(o.label));
88
+ };
77
89
  export const isFtMapAttachment = (o) => {
78
90
  return isObject(o)
79
91
  && (isString(o.file))
@@ -94,7 +106,8 @@ export const isFtPaginatedToc = (o) => {
94
106
  return isObject(o)
95
107
  && (isFtPaginationConfiguration(o.configuration))
96
108
  && ((Array.isArray(o.paginatedToc)
97
- && o.paginatedToc.every((v) => isFtPaginatedTocNode(v))));
109
+ && o.paginatedToc.every((v) => isFtPaginatedTocNode(v))))
110
+ && (isBoolean(o.translationError));
98
111
  };
99
112
  export const isFtPaginatedTocNode = (o) => {
100
113
  return isObject(o)
@@ -106,8 +119,14 @@ export const isFtPaginatedTocNode = (o) => {
106
119
  && o.children.every((v) => isFtPaginatedTocNode(v))))
107
120
  && (o.pageConfiguration == null || isFtPageConfiguration(o.pageConfiguration))
108
121
  && (o.contentId == null || isString(o.contentId))
122
+ && (o.untranslatedTitle == null || isString(o.untranslatedTitle))
109
123
  && (o.title == null || isString(o.title));
110
124
  };
125
+ export const isFtPaginatedTocNodeWithTranslationFailure = (o) => {
126
+ return isObject(o)
127
+ && (isFtPaginatedTocNode(o.paginatedToc))
128
+ && (isBoolean(o.translationError));
129
+ };
111
130
  export const isFtPaginationConfiguration = (o) => {
112
131
  return isObject(o)
113
132
  && (isBoolean(o.splitCurrentPageToc));
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.88",
4
4
  "description": "Fluid Topics Public API",
5
5
  "author": "Fluid Topics dev team <opensource@antidot.net>",
6
6
  "license": "LGPL-3.0-only",