@fluid-topics/public-api 1.0.141 → 1.0.142-alpha1

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.
Files changed (11) hide show
  1. package/dist/cjs/index.js +41 -34
  2. package/dist/cjs/types/ft-common/public.js +18 -3
  3. package/dist/cjs/types/ft-server/public.js +30 -4
  4. package/dist/fluidtopics.min.js +1 -1
  5. package/dist/mjs/index.d.ts +2 -1
  6. package/dist/mjs/index.js +48 -38
  7. package/dist/mjs/types/ft-common/public.d.ts +12 -0
  8. package/dist/mjs/types/ft-common/public.js +13 -0
  9. package/dist/mjs/types/ft-server/public.d.ts +24 -3
  10. package/dist/mjs/types/ft-server/public.js +25 -2
  11. package/package.json +5 -5
package/dist/cjs/index.js CHANGED
@@ -83,7 +83,7 @@ function handleError(method, endpoint, response) {
83
83
  endpoint,
84
84
  status: response.status,
85
85
  statusText: response.statusText,
86
- body: yield response.text()
86
+ body: yield response.text(),
87
87
  };
88
88
  if (typeof wnd.dispatchEvent === "function") {
89
89
  wnd.dispatchEvent(new HttpErrorEvent(details));
@@ -107,9 +107,9 @@ class FluidTopicsApi {
107
107
  stickyFilters: {
108
108
  endpoint: "api/admin/sticky-filters",
109
109
  id: (id) => ({
110
- endpoint: `api/admin/sticky-filters/${id}`
111
- })
112
- }
110
+ endpoint: `api/admin/sticky-filters/${id}`,
111
+ }),
112
+ },
113
113
  },
114
114
  authentication: {
115
115
  login: `api/authentication/login`,
@@ -129,14 +129,14 @@ class FluidTopicsApi {
129
129
  attachmentId: (attachmentId) => ({
130
130
  info: `api/khub/maps/${mapId}/attachments/${attachmentId}`,
131
131
  content: `api/khub/maps/${mapId}/attachments/${attachmentId}/content`,
132
- })
132
+ }),
133
133
  },
134
134
  resources: {
135
135
  list: `api/khub/maps/${mapId}/resources`,
136
136
  resourceId: (resourceId) => ({
137
137
  info: `api/khub/maps/${mapId}/resources/${resourceId}`,
138
138
  content: `api/khub/maps/${mapId}/resources/${resourceId}/content`,
139
- })
139
+ }),
140
140
  },
141
141
  topics: {
142
142
  contentId: (contentId) => ({
@@ -147,9 +147,9 @@ class FluidTopicsApi {
147
147
  tocId: (tocId) => ({
148
148
  feedback: `api/khub/maps/${mapId}/topics/${tocId}/feedback`,
149
149
  rating: `api/khub/maps/${mapId}/topics/${tocId}/rating`,
150
- })
150
+ }),
151
151
  },
152
- })
152
+ }),
153
153
  },
154
154
  documents: {
155
155
  documentId: (documentId) => ({
@@ -163,9 +163,9 @@ class FluidTopicsApi {
163
163
  attachmentId: (attachmentId) => ({
164
164
  info: `api/khub/documents/${documentId}/attachments/${attachmentId}`,
165
165
  content: `api/khub/documents/${documentId}/attachments/${attachmentId}/content`,
166
- })
166
+ }),
167
167
  },
168
- })
168
+ }),
169
169
  },
170
170
  semantic: {
171
171
  search: `api/khub/semantic/search`,
@@ -178,14 +178,14 @@ class FluidTopicsApi {
178
178
  user: {
179
179
  locales: {
180
180
  ui: `api/user/locales/ui`,
181
- }
181
+ },
182
182
  },
183
183
  users: {
184
184
  userId: (userId) => ({
185
185
  collections: {
186
186
  collectionId: (collectionId) => ({
187
187
  documents: `api/users/${userId}/collections/${collectionId}/documents`,
188
- })
188
+ }),
189
189
  },
190
190
  searches: {
191
191
  list: `api/users/${userId}/searches`,
@@ -193,11 +193,11 @@ class FluidTopicsApi {
193
193
  mySearchId: (mySearchId) => ({
194
194
  delete: `api/users/${userId}/searches/${mySearchId}`,
195
195
  update: `api/users/${userId}/searches/${mySearchId}`,
196
- })
196
+ }),
197
197
  },
198
198
  bookmarks: {
199
199
  list: `api/users/${userId}/bookmarks`,
200
- }
200
+ },
201
201
  }),
202
202
  },
203
203
  stylesheets: {
@@ -231,8 +231,8 @@ class FluidTopicsApi {
231
231
  backups: `api/remote-portals/${remoteId}/backups`,
232
232
  backup: (backupId) => ({
233
233
  restore: `api/remote-portals/${remoteId}/backups/${backupId}/restore`,
234
- })
235
- })
234
+ }),
235
+ }),
236
236
  },
237
237
  locales: {
238
238
  ui: `api/locales/ui`,
@@ -243,14 +243,14 @@ class FluidTopicsApi {
243
243
  fluidTopics: {
244
244
  contextName: (contextName) => ({
245
245
  endpoint: `api/messages/${locale}/fluid-topics/${contextName}`,
246
- })
246
+ }),
247
247
  },
248
248
  custom: {
249
249
  contextName: (contextName) => ({
250
250
  endpoint: `api/messages/${locale}/custom/${contextName}`,
251
- })
252
- }
253
- })
251
+ }),
252
+ },
253
+ }),
254
254
  },
255
255
  ai: {
256
256
  generate: `api/ai/generate`,
@@ -260,24 +260,24 @@ class FluidTopicsApi {
260
260
  translate: `api/ai/translate`,
261
261
  destinationLanguages: (profileId) => ({
262
262
  endpoint: `api/ai/translate/${profileId}/languages`,
263
- })
263
+ }),
264
264
  },
265
265
  assets: {
266
266
  highlightjs: `assets/scripts/highlightjs`,
267
267
  customCode: (subPath) => ({
268
268
  endpoint: `portal/custom-code/${subPath}`,
269
- })
269
+ }),
270
270
  },
271
271
  analytics: {
272
272
  events: "api/analytics/events",
273
273
  },
274
274
  stickyFilters: {
275
275
  id: (id) => ({
276
- get: `api/sticky-filters/${id}`
276
+ get: `api/sticky-filters/${id}`,
277
277
  }),
278
278
  find: `api/sticky-filters/find`,
279
- suggest: `api/sticky-filters/suggest`
280
- }
279
+ suggest: `api/sticky-filters/suggest`,
280
+ },
281
281
  };
282
282
  //@ts-ignore
283
283
  tenantBaseUrl = ((_b = (_a = tenantBaseUrl !== null && tenantBaseUrl !== void 0 ? tenantBaseUrl : wnd.fluidTopicsBaseUrl) !== null && _a !== void 0 ? _a : wnd.__gwt_ft_moduleBase) !== null && _b !== void 0 ? _b : "").trim();
@@ -309,7 +309,7 @@ class FluidTopicsApi {
309
309
  let credentials = {
310
310
  login: login,
311
311
  password: password,
312
- rememberMe: true
312
+ rememberMe: true,
313
313
  };
314
314
  return this.post(this.endpoints.authentication.login, credentials)
315
315
  .then(result => {
@@ -320,7 +320,7 @@ class FluidTopicsApi {
320
320
  logout() {
321
321
  return this.fetch(this.endpoints.authentication.logout, {
322
322
  method: "POST",
323
- credentials: this.authorization == null ? "include" : undefined
323
+ credentials: this.authorization == null ? "include" : undefined,
324
324
  })
325
325
  .then((response) => handleError("POST", this.endpoints.authentication.logout, response))
326
326
  .then((response) => __awaiter(this, void 0, void 0, function* () {
@@ -355,6 +355,13 @@ class FluidTopicsApi {
355
355
  const queryParams = Object.assign(Object.assign({}, this.buildTranslationParameters(translationSettings)), { v });
356
356
  return this.get(this.buildUrlFromParams(endpoint, queryParams));
357
357
  }
358
+ getFilteredPages(mapId, translationSettings, metadataFilters) {
359
+ if (!metadataFilters || metadataFilters.length === 0) {
360
+ return this.getPages(mapId, undefined, translationSettings);
361
+ }
362
+ const tocRequest = Object.assign({ metadataFilters: metadataFilters || [] }, this.buildTranslationParameters(translationSettings));
363
+ return this.post(this.endpoints.khub.maps.mapId(mapId).pages, tocRequest);
364
+ }
358
365
  getTopic(mapId, topicContentId, v) {
359
366
  return this.get(this.endpoints.khub.maps.mapId(mapId).topics.contentId(topicContentId).info, v);
360
367
  }
@@ -437,7 +444,7 @@ class FluidTopicsApi {
437
444
  }
438
445
  rateTopic(mapId, tocId, type, value) {
439
446
  return this.post(this.endpoints.khub.maps.mapId(mapId).topics.tocId(tocId).rating, {
440
- type, value
447
+ type, value,
441
448
  });
442
449
  }
443
450
  unrateTopic(mapId, tocId) {
@@ -556,7 +563,7 @@ class FluidTopicsApi {
556
563
  "Content-Type": "application/json",
557
564
  },
558
565
  body: JSON.stringify({ profileId, parameters }),
559
- credentials: this.authorization == null ? "include" : undefined
566
+ credentials: this.authorization == null ? "include" : undefined,
560
567
  }));
561
568
  yield __await(handleError("POST", this.endpoints.ai.generate, response));
562
569
  const reader = new AIChunkReader_js_1.AIChunkReader(response.body.getReader());
@@ -571,7 +578,7 @@ class FluidTopicsApi {
571
578
  "Content-Type": "application/json",
572
579
  },
573
580
  body: JSON.stringify(input),
574
- credentials: this.authorization == null ? "include" : undefined
581
+ credentials: this.authorization == null ? "include" : undefined,
575
582
  }));
576
583
  yield __await(handleError("POST", this.endpoints.ai.chat, response));
577
584
  const reader = new AIChunkReader_js_1.AIChunkReader(response.body.getReader());
@@ -587,7 +594,7 @@ class FluidTopicsApi {
587
594
  "Content-Type": "application/json",
588
595
  },
589
596
  body: JSON.stringify(input),
590
- credentials: this.authorization == null ? "include" : undefined
597
+ credentials: this.authorization == null ? "include" : undefined,
591
598
  }));
592
599
  yield __await(handleError("POST", endpoint, response));
593
600
  const reader = new AIChunkReader_js_1.AIChunkReader(response.body.getReader());
@@ -673,7 +680,7 @@ class FluidTopicsApi {
673
680
  method: method,
674
681
  headers: Object.assign({}, (data != null ? { "Content-Type": "application/json" } : {})),
675
682
  body: data != null ? JSON.stringify(data) : undefined,
676
- credentials: this.authorization == null ? "include" : undefined
683
+ credentials: this.authorization == null ? "include" : undefined,
677
684
  })
678
685
  .then((r) => handleError(method, endpoint, r))
679
686
  .then(getBody);
@@ -681,7 +688,7 @@ class FluidTopicsApi {
681
688
  fetchRawData(endpoint, v) {
682
689
  return fetch(this.withVersion(endpoint, v), {
683
690
  headers: this.defaultHeaders,
684
- credentials: this.authorization == null ? "include" : undefined
691
+ credentials: this.authorization == null ? "include" : undefined,
685
692
  })
686
693
  .then((r) => handleError("GET", endpoint, r))
687
694
  .then(response => response.arrayBuffer());
@@ -715,7 +722,7 @@ class FluidTopicsApi {
715
722
  return {
716
723
  translationProfileId: translationSettings.profileId,
717
724
  translationDestinationLanguage: translationSettings.destinationLanguage,
718
- translationSourceLanguage: (_a = translationSettings.sourceLanguage) === null || _a === void 0 ? void 0 : _a.slice(0, 2)
725
+ translationSourceLanguage: (_a = translationSettings.sourceLanguage) === null || _a === void 0 ? void 0 : _a.slice(0, 2),
719
726
  };
720
727
  }
721
728
  }
package/dist/cjs/types/ft-common/public.js CHANGED
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.isFtKhubSearchEvent = exports.isFtFeedbackSendEvent = exports.isFtDocumentStartDisplayEvent = exports.isFtDocumentSearchEvent = exports.isFtDocumentPrintEvent = exports.isFtDocumentOnDemandTranslateEvent = exports.isFtDocumentDownloadEvent = exports.isFtCustomTriggerEvent = exports.isFtCaseDeflectionEvent = exports.isFtAnalyticsEventName = exports.FtAnalyticsEventName = exports.isFtAnalyticsEvent = exports.isFtAiRateEvent = exports.isFtAiCompletedQueryEvent = exports.isFtAiCaseDeflectionEvent = exports.isFtAnalyticsTranslationOrigin = exports.FtAnalyticsTranslationOrigin = exports.isFtAnalyticsSearchFacetType = exports.FtAnalyticsSearchFacetType = exports.isFtAnalyticsSearchDateFacetValue = exports.FtAnalyticsSearchDateFacetValue = exports.isFtAnalyticsSearchFacet = exports.isFtAnalyticsPublicationType = exports.FtAnalyticsPublicationType = exports.isFtAnalyticsEventTopic = exports.isFtAnalyticsEventSearchResult = exports.isFtAnalyticsEventSearchResponse = exports.isFtAnalyticsEventSearchQuery = exports.isFtAnalyticsEventRating = exports.isFtAnalyticsEventPage = exports.isFtAnalyticsEventOrigin = exports.isFtAnalyticsEventLocation = exports.isFtAnalyticsEventLanguage = exports.isFtAnalyticsEventDocumentSearchQuery = exports.isFtAnalyticsEventDocument = exports.isFtAnalyticsEventDisplay = exports.isFtAnalyticsEventAIProfileTranslationDetails = exports.isFtAnalyticsEventAIProfileGenericAgentDetails = exports.isFtAnalyticsEventAIProfileCompletionDetails = exports.isFtAnalyticsEventAIProfileChatbotDetails = exports.isFtAnalyticsEventAIProfileCaseDeflectionDetails = exports.isFtAnalyticsEventAIProfileAgenticChatbotDetails = exports.isFtAnalyticsEventAIProfile = exports.isFtAnalyticsDocumentType = exports.FtAnalyticsDocumentType = exports.isFtTopicOriginType = exports.FtTopicOriginType = exports.isFtMyLibraryColors = exports.FtMyLibraryColors = exports.isFtHttpErrorDetails = void 0;
4
- exports.isFtMySearchRequest = exports.isFtMySearchCreation = exports.isFtMySearch = exports.isFtMetadataDescriptor = exports.isFtMetadataConfiguration = exports.isFtMetadataSortRule = exports.FtMetadataSortRule = exports.isFtMetadata = exports.isFtFacetType = exports.FtFacetType = exports.isFtUserAssetLabel = exports.isFtUiLocale = exports.isFtMessageContext = exports.isFtLocalesConfiguration = exports.isFtSearchLocales = exports.isFtSearchLocale = exports.isFtDefaultLocales = exports.isFtDefaultLocale = exports.isFtMetadataHomeLayout = exports.FtMetadataHomeLayout = exports.isFtFeedbackCreation = exports.isFtExternalWebComponentContext = exports.FtExternalWebComponentContext = exports.isFtTranslationContent = exports.isFtTopicContentTarget = exports.FtTopicContentTarget = exports.isFtUnstructuredDocument = exports.isFtTopicOrigin = exports.isFtTopic = exports.isFtTocNode = exports.isFtMapStyles = exports.isFtMap = exports.isFtCollectionDocument = exports.isFtCollection = exports.isFtBookmark = exports.isFtPersonalBookTopicLinkCreation = exports.isFtPersonalBookPreview = exports.isFtPersonalBookNodeCreation = exports.isFtPersonalBookMetadataUpdate = exports.isFtPersonalBookCreation = exports.isTopicTypeCreation = exports.TopicTypeCreation = exports.isFtCredentials = exports.isFtTopicStartDisplayEvent = exports.isFtTopicAiTranslateEvent = exports.isFtSearchResultOpenContextMenuEvent = exports.isFtSearchPageSelectEvent = exports.isFtPageDisplayEvent = exports.isFtLinkShareEvent = exports.isFtLabelsDownloadEvent = void 0;
5
- exports.isFtSearchResultUnstructuredDocument = exports.isFtSearchResultClusterEntry = exports.isFtSearchResultCluster = exports.isFtSearchResultAnnouncement = 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.isFtSearchKeywordMatch = exports.FtSearchKeywordMatch = exports.isFtPeriodFilterType = exports.FtPeriodFilterType = exports.isFtSearchPreferencesConfiguration = exports.isFtMetadataPreferenceConfiguration = exports.isFtMapResourceSummary = exports.isFtTopicsRatingSummary = exports.isFtTopicRating = exports.isFtRatingSummary = exports.isFtRatingCreation = exports.isFtPublicationRatingSummary = exports.isFtPublicationRating = exports.isFtRatingType = exports.FtRatingType = exports.isFtPrivacyPolicyConfiguration = exports.isFtMySearchUpdate = void 0;
6
- exports.isFtSearchSortOption = exports.isFtSearchConfiguration = exports.isFtLocalizableLabel = exports.isFtWatermark = exports.isFtUserAssetCount = exports.isFtSessionStatus = exports.FtSessionStatus = exports.isFtUserProfile = exports.isFtSession = exports.isFtSearchPreferences = exports.isFtAuthenticatedSession = exports.isFtAuthenticationIdentifier = exports.isFtUserAssetType = exports.FtUserAssetType = exports.isFtUserRole = exports.FtUserRole = exports.isFtSuggestResults = exports.isFtSuggestResult = exports.isFtSuggestRequest = exports.isFtLocalizableLabelType = exports.FtLocalizableLabelType = 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.isFtSearchResultHtmlPackagePage = exports.isFtSearchResultHtmlPackage = void 0;
4
+ exports.isFtMySearch = exports.isFtMetadataDescriptor = exports.isFtMetadataConfiguration = exports.isFtMetadataSortRule = exports.FtMetadataSortRule = exports.isFtMetadata = exports.isFtFacetType = exports.FtFacetType = exports.isFtUserAssetLabel = exports.isFtUiLocale = exports.isFtMessageContext = exports.isFtLocalesConfiguration = exports.isFtSearchLocales = exports.isFtSearchLocale = exports.isFtDefaultLocales = exports.isFtDefaultLocale = exports.isFtMetadataHomeLayout = exports.FtMetadataHomeLayout = exports.isFtFeedbackCreation = exports.isFtExternalWebComponentContext = exports.FtExternalWebComponentContext = exports.isFtTranslationContent = exports.isFtTopicContentTarget = exports.FtTopicContentTarget = exports.isFtUnstructuredDocument = exports.isFtTopicOrigin = exports.isFtTopic = exports.isFtTocNodeFilteredReason = exports.FtTocNodeFilteredReason = exports.isFtTocNode = exports.isFtMapStyles = exports.isFtMap = exports.isFtCollectionDocument = exports.isFtCollection = exports.isFtBookmark = exports.isFtPersonalBookTopicLinkCreation = exports.isFtPersonalBookPreview = exports.isFtPersonalBookNodeCreation = exports.isFtPersonalBookMetadataUpdate = exports.isFtPersonalBookCreation = exports.isTopicTypeCreation = exports.TopicTypeCreation = exports.isFtCredentials = exports.isFtTopicStartDisplayEvent = exports.isFtTopicAiTranslateEvent = exports.isFtSearchResultOpenContextMenuEvent = exports.isFtSearchPageSelectEvent = exports.isFtPageDisplayEvent = exports.isFtLinkShareEvent = exports.isFtLabelsDownloadEvent = void 0;
5
+ exports.isFtSearchResultAnnouncement = 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.isFtSearchKeywordMatch = exports.FtSearchKeywordMatch = exports.isFtPeriodFilterType = exports.FtPeriodFilterType = exports.isFtSearchPreferencesConfiguration = exports.isFtMetadataPreferenceConfiguration = exports.isFtMapResourceSummary = exports.isFtTocRequest = exports.isFtTopicsRatingSummary = exports.isFtTopicRating = exports.isFtRatingSummary = exports.isFtRatingCreation = exports.isFtPublicationRatingSummary = exports.isFtPublicationRating = exports.isFtRatingType = exports.FtRatingType = exports.isFtPrivacyPolicyConfiguration = exports.isFtMySearchUpdate = exports.isFtMySearchRequest = exports.isFtMySearchCreation = void 0;
6
+ exports.isFtSearchSortOption = exports.isFtSearchConfiguration = exports.isFtLocalizableLabel = exports.isFtWatermark = exports.isFtUserAssetCount = exports.isFtSessionStatus = exports.FtSessionStatus = exports.isFtUserProfile = exports.isFtSession = exports.isFtSearchPreferences = exports.isFtAuthenticatedSession = exports.isFtAuthenticationIdentifier = exports.isFtUserAssetType = exports.FtUserAssetType = exports.isFtUserRole = exports.FtUserRole = exports.isFtSuggestResults = exports.isFtSuggestResult = exports.isFtSuggestRequest = exports.isFtLocalizableLabelType = exports.FtLocalizableLabelType = 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.isFtSearchResultHtmlPackagePage = exports.isFtSearchResultHtmlPackage = exports.isFtSearchResultUnstructuredDocument = exports.isFtSearchResultClusterEntry = exports.isFtSearchResultCluster = void 0;
7
7
  const isObject = (o) => typeof o === "object" && o != null;
8
8
  const isBoolean = (o) => typeof o === "boolean";
9
9
  const isNumber = (o) => typeof o === "number";
@@ -610,6 +610,13 @@ const isFtTocNode = (o) => {
610
610
  && (isString(o.title));
611
611
  };
612
612
  exports.isFtTocNode = isFtTocNode;
613
+ var FtTocNodeFilteredReason;
614
+ (function (FtTocNodeFilteredReason) {
615
+ FtTocNodeFilteredReason["METADATA_FILTER"] = "METADATA_FILTER";
616
+ FtTocNodeFilteredReason["ACCESS_RIGHTS_FILTER"] = "ACCESS_RIGHTS_FILTER";
617
+ })(FtTocNodeFilteredReason || (exports.FtTocNodeFilteredReason = FtTocNodeFilteredReason = {}));
618
+ const isFtTocNodeFilteredReason = (o) => Object.keys(FtTocNodeFilteredReason).includes(o);
619
+ exports.isFtTocNodeFilteredReason = isFtTocNodeFilteredReason;
613
620
  const isFtTopic = (o) => {
614
621
  return isObject(o)
615
622
  && ((Array.isArray(o.metadata)
@@ -910,6 +917,14 @@ const isFtTopicsRatingSummary = (o) => {
910
917
  && ((0, exports.isFtRatingType)(o.type));
911
918
  };
912
919
  exports.isFtTopicsRatingSummary = isFtTopicsRatingSummary;
920
+ const isFtTocRequest = (o) => {
921
+ return isObject(o)
922
+ && (o.translationProfileId == null || isString(o.translationProfileId))
923
+ && (o.translationDestinationLanguage == null || isString(o.translationDestinationLanguage))
924
+ && ((Array.isArray(o.metadataFilters)
925
+ && o.metadataFilters.every((v) => (0, exports.isFtMetadataFilter)(v))));
926
+ };
927
+ exports.isFtTocRequest = isFtTocRequest;
913
928
  const isFtMapResourceSummary = (o) => {
914
929
  return isObject(o)
915
930
  && (isString(o.contentUrl))
package/dist/cjs/types/ft-server/public.js CHANGED
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.isFtPaginatedToc = exports.isFtPageConfiguration = exports.isFtDocumentAttachment = exports.isFtMapAttachment = exports.isFtBackups = exports.isFtBackupRestoreStatusType = exports.FtBackupRestoreStatusType = exports.isFtBackupRestoreOrder = exports.isFtBackupCreation = exports.isFtBackup = exports.isFtTranslationLocale = exports.isFtTranslationResponse = exports.isFtTranslationRequest = exports.isFtTranslationLanguagesResponse = exports.isTranslationFormat = exports.TranslationFormat = exports.isFtGenAIFetchRagTracesResult = exports.isFtGenAIRagFetchTracesRequest = exports.isFtGenAIGenerationTraceOutput = exports.isFtGenAIGenerationTraceInput = exports.isFtGenAIGenerationTrace = exports.isFtGenAIFetchGenerationTracesResult = exports.isFtGenAIGenerationFetchTracesRequest = exports.isFtRagInput = exports.isFtRagHistory = exports.isFtRagResponseFormat = exports.FtRagResponseFormat = exports.isFtAgentGenerateRequest = exports.isFtAgentRagChatRequest = exports.isFtAgentResponseFormat = exports.FtAgentResponseFormat = exports.isFtAgentRagChatResponseSource = exports.isFtAgentRagChatResponseFormat = exports.isFtGenAIGenerateInput = exports.isFtGenAIRating = exports.isFtGenAIChatbotUserRating = exports.isFtGenAIChatbotAdminRating = exports.isFtChatbotUserRatingTag = exports.FtChatbotUserRatingTag = exports.isFtChatbotAdminRatingTag = exports.FtChatbotAdminRatingTag = exports.isFtReaderFeedbackConfiguration = exports.isFtReaderConfiguration = exports.isFtViewerConfiguration = exports.isFtConfigurationHistoryEntryStatus = exports.FtConfigurationHistoryEntryStatus = exports.isFtRemotePortalStatusType = exports.FtRemotePortalStatusType = exports.isFtRemotePortalStatus = exports.isFtRemotePortal = void 0;
4
- exports.isFtAssetHolderType = exports.FtAssetHolderType = exports.isFtAssetHolder = exports.isFtMapResource = exports.isFtAssetDescriptor = exports.isFtUserUiLocaleUpdateRequest = exports.isFtPublicUserReaderPaginationUpdate = exports.isFtPublicUserReaderPaginationSummary = exports.isFtUserLocaleSummary = exports.isFtStickyFiltersUpdate = exports.isFtStickyFiltersSummary = exports.isFtStickyFiltersLocalizedData = exports.isFtStickyFiltersCreation = exports.isFtStickyFilters = exports.isFtStickyFilterOr = exports.isFtStickyFilterNot = exports.isFtStickyFilterKeyValue = exports.isFtStickyFilterAnd = exports.isFtStickyFilter = exports.isFtSemanticSearchRequest = exports.isFtSemanticSearchOrFilter = exports.isFtSemanticSearchNotFilter = exports.isFtSemanticSearchKeyValueFilter = exports.isFtSemanticSearchFilter = exports.isFtSemanticSearchAndFilter = exports.isFtSemanticSearchResponseItem = exports.isFtClusteredSemanticSearchReply = exports.isFtClusteredSemanticSearchRequest = exports.isFtClusteredSemanticSearchCluster = exports.isFtSubsetType = exports.FtSubsetType = exports.isFtBackupRestoreRequest = exports.isFtTopicContentFormat = exports.FtTopicContentFormat = exports.isFtPaginationConfiguration = exports.isFtPaginatedTocNodeWithTranslationFailure = exports.isFtPaginatedTocNode = void 0;
3
+ exports.isFtDocumentAttachment = exports.isFtMapAttachment = exports.isFtBackups = exports.isFtBackupRestoreStatusType = exports.FtBackupRestoreStatusType = exports.isFtBackupRestoreOrder = exports.isFtBackupCreation = exports.isFtBackup = exports.isFtTranslationLocale = exports.isFtTranslationResponse = exports.isFtTranslationRequest = exports.isFtTranslationLanguagesResponse = exports.isTranslationFormat = exports.TranslationFormat = exports.isFtGenAIFetchRagTracesResult = exports.isFtGenAIRagFetchTracesRequest = exports.isFtRagChatResponseModel = exports.isFtRagChatResponseDocumentModel = exports.isFtGenAIGenerationTraceOutput = exports.isFtGenAIGenerationTraceInput = exports.isFtGenAIGenerationTrace = exports.isFtGenAIFetchGenerationTracesResult = exports.isFtGenAIGenerationFetchTracesRequest = exports.isFtRagInput = exports.isFtRagHistory = exports.isFtRagResponseFormat = exports.FtRagResponseFormat = exports.isFtAgentGenerateRequest = exports.isFtAgentRagChatRequest = exports.isFtAgentResponseFormat = exports.FtAgentResponseFormat = exports.isFtAgentRagChatResponseSource = exports.isFtAgentRagChatResponseFormat = exports.isFtGenAIGenerateInput = exports.isFtGenAIRating = exports.isFtGenAIChatbotUserRating = exports.isFtGenAIChatbotAdminRating = exports.isFtChatbotUserRatingTag = exports.FtChatbotUserRatingTag = exports.isFtChatbotAdminRatingTag = exports.FtChatbotAdminRatingTag = exports.isFtReaderFeedbackConfiguration = exports.isFtReaderConfiguration = exports.isFtViewerConfiguration = exports.isFtConfigurationHistoryEntryStatus = exports.FtConfigurationHistoryEntryStatus = exports.isFtRemotePortalStatusType = exports.FtRemotePortalStatusType = exports.isFtRemotePortalStatus = exports.isFtRemotePortal = void 0;
4
+ exports.isFtAssetHolderType = exports.FtAssetHolderType = exports.isFtAssetHolder = exports.isFtMapResource = exports.isFtAssetDescriptor = exports.isFtUserUiLocaleUpdateRequest = exports.isFtPublicUserReaderPaginationUpdate = exports.isFtPublicUserReaderPaginationSummary = exports.isFtUserLocaleSummary = exports.isFtStickyFiltersUpdate = exports.isFtStickyFiltersSummary = exports.isFtStickyFiltersLocalizedData = exports.isFtStickyFiltersCreation = exports.isFtStickyFilters = exports.isFtStickyFilterOr = exports.isFtStickyFilterNot = exports.isFtStickyFilterKeyValue = exports.isFtStickyFilterAnd = exports.isFtStickyFilter = exports.isFtSemanticSearchRequest = exports.isFtSemanticSearchOrFilter = exports.isFtSemanticSearchNotFilter = exports.isFtSemanticSearchKeyValueFilter = exports.isFtSemanticSearchFilter = exports.isFtSemanticSearchAndFilter = exports.isFtSemanticSearchResponseItem = exports.isFtClusteredSemanticSearchReply = exports.isFtClusteredSemanticSearchRequest = exports.isFtClusteredSemanticSearchCluster = exports.isFtSubsetType = exports.FtSubsetType = exports.isFtBackupRestoreRequest = exports.isFtTopicContentFormat = exports.FtTopicContentFormat = exports.isFtTocNodeFiltered = exports.isFtPaginationConfiguration = exports.isFtPaginatedTocNodeWithTranslationFailure = exports.isFtPaginatedTocNode = exports.isFtPaginatedToc = exports.isFtPageConfiguration = void 0;
5
5
  const isObject = (o) => typeof o === "object" && o != null;
6
6
  const isBoolean = (o) => typeof o === "boolean";
7
7
  const isNumber = (o) => typeof o === "number";
@@ -69,8 +69,6 @@ var FtChatbotAdminRatingTag;
69
69
  FtChatbotAdminRatingTag["INACCURATE"] = "INACCURATE";
70
70
  FtChatbotAdminRatingTag["INCOMPLETE"] = "INCOMPLETE";
71
71
  FtChatbotAdminRatingTag["OFF_TOPIC"] = "OFF_TOPIC";
72
- FtChatbotAdminRatingTag["IRRELEVANT_SOURCES"] = "IRRELEVANT_SOURCES";
73
- FtChatbotAdminRatingTag["SUMMARY"] = "SUMMARY";
74
72
  FtChatbotAdminRatingTag["SEMANTIC_SEARCH"] = "SEMANTIC_SEARCH";
75
73
  FtChatbotAdminRatingTag["CHATBOT_INSTRUCTIONS"] = "CHATBOT_INSTRUCTIONS";
76
74
  FtChatbotAdminRatingTag["DOCUMENTATION"] = "DOCUMENTATION";
@@ -149,6 +147,7 @@ const isFtAgentRagChatRequest = (o) => {
149
147
  return isObject(o)
150
148
  && (isString(o.profileId))
151
149
  && (isString(o.query))
150
+ && (o.stickyFiltersId == null || isString(o.stickyFiltersId))
152
151
  && (o.filters == null || (Array.isArray(o.filters)
153
152
  && o.filters.every((v) => (0, exports.isFtSemanticSearchFilter)(v))));
154
153
  };
@@ -158,6 +157,7 @@ const isFtAgentGenerateRequest = (o) => {
158
157
  && (o.stream == null || isBoolean(o.stream))
159
158
  && (isString(o.profileId))
160
159
  && (isString(o.query))
160
+ && (o.stickyFiltersId == null || isString(o.stickyFiltersId))
161
161
  && (o.searchFilters == null || (Array.isArray(o.searchFilters)
162
162
  && o.searchFilters.every((v) => (0, exports.isFtSemanticSearchFilter)(v))));
163
163
  };
@@ -183,6 +183,7 @@ const isFtRagInput = (o) => {
183
183
  && (o.messages == null || (Array.isArray(o.messages)
184
184
  && o.messages.every((v) => (0, exports.isFtRagHistory)(v))))
185
185
  && (o.responseFormat == null || (0, exports.isFtRagResponseFormat)(o.responseFormat))
186
+ && (o.stickyFiltersId == null || isString(o.stickyFiltersId))
186
187
  && (o.filters == null || (Array.isArray(o.filters)
187
188
  && o.filters.every((v) => (0, exports.isFtSemanticSearchFilter)(v))));
188
189
  };
@@ -225,6 +226,20 @@ const isFtGenAIGenerationTraceOutput = (o) => {
225
226
  && (isString(o.response));
226
227
  };
227
228
  exports.isFtGenAIGenerationTraceOutput = isFtGenAIGenerationTraceOutput;
229
+ const isFtRagChatResponseDocumentModel = (o) => {
230
+ return isObject(o)
231
+ && (isString(o.title))
232
+ && (isString(o.url))
233
+ && (isString(o.content));
234
+ };
235
+ exports.isFtRagChatResponseDocumentModel = isFtRagChatResponseDocumentModel;
236
+ const isFtRagChatResponseModel = (o) => {
237
+ return isObject(o)
238
+ && (isString(o.answer))
239
+ && (o.documents == null || (Array.isArray(o.documents)
240
+ && o.documents.every((v) => (0, exports.isFtRagChatResponseDocumentModel)(v))));
241
+ };
242
+ exports.isFtRagChatResponseModel = isFtRagChatResponseModel;
228
243
  const isFtGenAIRagFetchTracesRequest = (o) => {
229
244
  return isObject(o)
230
245
  && (o.endDate == null || isString(o.endDate))
@@ -345,6 +360,9 @@ exports.isFtPageConfiguration = isFtPageConfiguration;
345
360
  const isFtPaginatedToc = (o) => {
346
361
  return isObject(o)
347
362
  && ((0, exports.isFtPaginationConfiguration)(o.configuration))
363
+ && ((isObject(o.filteredTocNodes)
364
+ && Object.keys(o.filteredTocNodes).every((k) => isString(k))
365
+ && Object.values(o.filteredTocNodes).every((v) => (0, exports.isFtTocNodeFiltered)(v))))
348
366
  && ((Array.isArray(o.paginatedToc)
349
367
  && o.paginatedToc.every((v) => (0, exports.isFtPaginatedTocNode)(v))))
350
368
  && (isBoolean(o.translationError));
@@ -377,6 +395,12 @@ const isFtPaginationConfiguration = (o) => {
377
395
  && (isBoolean(o.splitCurrentPageToc));
378
396
  };
379
397
  exports.isFtPaginationConfiguration = isFtPaginationConfiguration;
398
+ const isFtTocNodeFiltered = (o) => {
399
+ return isObject(o)
400
+ && (isString(o.tocId))
401
+ && (o.closestParent == null || isString(o.closestParent));
402
+ };
403
+ exports.isFtTocNodeFiltered = isFtTocNodeFiltered;
380
404
  var FtTopicContentFormat;
381
405
  (function (FtTopicContentFormat) {
382
406
  FtTopicContentFormat["HTML"] = "HTML";
@@ -430,6 +454,7 @@ const isFtClusteredSemanticSearchRequest = (o) => {
430
454
  && (o.outputMetadata == null || (Array.isArray(o.outputMetadata)
431
455
  && o.outputMetadata.every((v) => isString(v))))
432
456
  && (isString(o.query))
457
+ && (o.stickyFiltersId == null || isString(o.stickyFiltersId))
433
458
  && (o.filters == null || (Array.isArray(o.filters)
434
459
  && o.filters.every((v) => (0, exports.isFtSemanticSearchFilter)(v))))
435
460
  && (o.nbResults == null || isNumber(o.nbResults));
@@ -492,6 +517,7 @@ const isFtSemanticSearchRequest = (o) => {
492
517
  && (o.outputMetadata == null || (Array.isArray(o.outputMetadata)
493
518
  && o.outputMetadata.every((v) => isString(v))))
494
519
  && (isString(o.query))
520
+ && (o.stickyFiltersId == null || isString(o.stickyFiltersId))
495
521
  && (o.filters == null || (Array.isArray(o.filters)
496
522
  && o.filters.every((v) => (0, exports.isFtSemanticSearchFilter)(v))))
497
523
  && (o.nbResults == null || isNumber(o.nbResults));