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

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 +34 -41
  2. package/dist/cjs/types/ft-common/public.js +3 -18
  3. package/dist/cjs/types/ft-server/public.js +21 -13
  4. package/dist/fluidtopics.min.js +1 -1
  5. package/dist/mjs/index.d.ts +1 -2
  6. package/dist/mjs/index.js +38 -48
  7. package/dist/mjs/types/ft-common/public.d.ts +0 -12
  8. package/dist/mjs/types/ft-common/public.js +0 -13
  9. package/dist/mjs/types/ft-server/public.d.ts +17 -10
  10. package/dist/mjs/types/ft-server/public.js +17 -10
  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,13 +355,6 @@ 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
- }
365
358
  getTopic(mapId, topicContentId, v) {
366
359
  return this.get(this.endpoints.khub.maps.mapId(mapId).topics.contentId(topicContentId).info, v);
367
360
  }
@@ -444,7 +437,7 @@ class FluidTopicsApi {
444
437
  }
445
438
  rateTopic(mapId, tocId, type, value) {
446
439
  return this.post(this.endpoints.khub.maps.mapId(mapId).topics.tocId(tocId).rating, {
447
- type, value,
440
+ type, value
448
441
  });
449
442
  }
450
443
  unrateTopic(mapId, tocId) {
@@ -563,7 +556,7 @@ class FluidTopicsApi {
563
556
  "Content-Type": "application/json",
564
557
  },
565
558
  body: JSON.stringify({ profileId, parameters }),
566
- credentials: this.authorization == null ? "include" : undefined,
559
+ credentials: this.authorization == null ? "include" : undefined
567
560
  }));
568
561
  yield __await(handleError("POST", this.endpoints.ai.generate, response));
569
562
  const reader = new AIChunkReader_js_1.AIChunkReader(response.body.getReader());
@@ -578,7 +571,7 @@ class FluidTopicsApi {
578
571
  "Content-Type": "application/json",
579
572
  },
580
573
  body: JSON.stringify(input),
581
- credentials: this.authorization == null ? "include" : undefined,
574
+ credentials: this.authorization == null ? "include" : undefined
582
575
  }));
583
576
  yield __await(handleError("POST", this.endpoints.ai.chat, response));
584
577
  const reader = new AIChunkReader_js_1.AIChunkReader(response.body.getReader());
@@ -594,7 +587,7 @@ class FluidTopicsApi {
594
587
  "Content-Type": "application/json",
595
588
  },
596
589
  body: JSON.stringify(input),
597
- credentials: this.authorization == null ? "include" : undefined,
590
+ credentials: this.authorization == null ? "include" : undefined
598
591
  }));
599
592
  yield __await(handleError("POST", endpoint, response));
600
593
  const reader = new AIChunkReader_js_1.AIChunkReader(response.body.getReader());
@@ -680,7 +673,7 @@ class FluidTopicsApi {
680
673
  method: method,
681
674
  headers: Object.assign({}, (data != null ? { "Content-Type": "application/json" } : {})),
682
675
  body: data != null ? JSON.stringify(data) : undefined,
683
- credentials: this.authorization == null ? "include" : undefined,
676
+ credentials: this.authorization == null ? "include" : undefined
684
677
  })
685
678
  .then((r) => handleError(method, endpoint, r))
686
679
  .then(getBody);
@@ -688,7 +681,7 @@ class FluidTopicsApi {
688
681
  fetchRawData(endpoint, v) {
689
682
  return fetch(this.withVersion(endpoint, v), {
690
683
  headers: this.defaultHeaders,
691
- credentials: this.authorization == null ? "include" : undefined,
684
+ credentials: this.authorization == null ? "include" : undefined
692
685
  })
693
686
  .then((r) => handleError("GET", endpoint, r))
694
687
  .then(response => response.arrayBuffer());
@@ -722,7 +715,7 @@ class FluidTopicsApi {
722
715
  return {
723
716
  translationProfileId: translationSettings.profileId,
724
717
  translationDestinationLanguage: translationSettings.destinationLanguage,
725
- translationSourceLanguage: (_a = translationSettings.sourceLanguage) === null || _a === void 0 ? void 0 : _a.slice(0, 2),
718
+ translationSourceLanguage: (_a = translationSettings.sourceLanguage) === null || _a === void 0 ? void 0 : _a.slice(0, 2)
726
719
  };
727
720
  }
728
721
  }
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.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;
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;
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,13 +610,6 @@ 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;
620
613
  const isFtTopic = (o) => {
621
614
  return isObject(o)
622
615
  && ((Array.isArray(o.metadata)
@@ -917,14 +910,6 @@ const isFtTopicsRatingSummary = (o) => {
917
910
  && ((0, exports.isFtRatingType)(o.type));
918
911
  };
919
912
  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;
928
913
  const isFtMapResourceSummary = (o) => {
929
914
  return isObject(o)
930
915
  && (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.isFtTocNodeFiltered = 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.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,9 +360,6 @@ exports.isFtPageConfiguration = isFtPageConfiguration;
345
360
  const isFtPaginatedToc = (o) => {
346
361
  return isObject(o)
347
362
  && ((0, exports.isFtPaginationConfiguration)(o.configuration))
348
- && ((isObject(o.filteredTocNodes)
349
- && Object.keys(o.filteredTocNodes).every((k) => isString(k))
350
- && Object.values(o.filteredTocNodes).every((v) => (0, exports.isFtTocNodeFiltered)(v))))
351
363
  && ((Array.isArray(o.paginatedToc)
352
364
  && o.paginatedToc.every((v) => (0, exports.isFtPaginatedTocNode)(v))))
353
365
  && (isBoolean(o.translationError));
@@ -380,12 +392,6 @@ const isFtPaginationConfiguration = (o) => {
380
392
  && (isBoolean(o.splitCurrentPageToc));
381
393
  };
382
394
  exports.isFtPaginationConfiguration = isFtPaginationConfiguration;
383
- const isFtTocNodeFiltered = (o) => {
384
- return isObject(o)
385
- && (isString(o.tocId))
386
- && (o.closestParent == null || isString(o.closestParent));
387
- };
388
- exports.isFtTocNodeFiltered = isFtTocNodeFiltered;
389
395
  var FtTopicContentFormat;
390
396
  (function (FtTopicContentFormat) {
391
397
  FtTopicContentFormat["HTML"] = "HTML";
@@ -439,6 +445,7 @@ const isFtClusteredSemanticSearchRequest = (o) => {
439
445
  && (o.outputMetadata == null || (Array.isArray(o.outputMetadata)
440
446
  && o.outputMetadata.every((v) => isString(v))))
441
447
  && (isString(o.query))
448
+ && (o.stickyFiltersId == null || isString(o.stickyFiltersId))
442
449
  && (o.filters == null || (Array.isArray(o.filters)
443
450
  && o.filters.every((v) => (0, exports.isFtSemanticSearchFilter)(v))))
444
451
  && (o.nbResults == null || isNumber(o.nbResults));
@@ -501,6 +508,7 @@ const isFtSemanticSearchRequest = (o) => {
501
508
  && (o.outputMetadata == null || (Array.isArray(o.outputMetadata)
502
509
  && o.outputMetadata.every((v) => isString(v))))
503
510
  && (isString(o.query))
511
+ && (o.stickyFiltersId == null || isString(o.stickyFiltersId))
504
512
  && (o.filters == null || (Array.isArray(o.filters)
505
513
  && o.filters.every((v) => (0, exports.isFtSemanticSearchFilter)(v))))
506
514
  && (o.nbResults == null || isNumber(o.nbResults));