cobrili-client 1.0.1 → 1.0.3
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.
- package/README.md +168 -52
- package/dist/index.browser.js +109 -75
- package/dist/index.browser.js.map +1 -1
- package/dist/index.d.mts +330 -23
- package/dist/index.d.ts +330 -23
- package/dist/index.js +109 -75
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +109 -75
- package/dist/index.mjs.map +1 -1
- package/package.json +5 -2
package/dist/index.mjs
CHANGED
|
@@ -187,13 +187,13 @@ var API_METHODS = {
|
|
|
187
187
|
},
|
|
188
188
|
historyForward: {
|
|
189
189
|
requestFields: [field("steps", "int", {})],
|
|
190
|
-
responseFields: [field("historyEntry", "object", { objectType: "HistoryEntry", xmlTag: "HistoryEntry", varname: "
|
|
190
|
+
responseFields: [field("historyEntry", "object", { objectType: "HistoryEntry", xmlTag: "HistoryEntry", varname: "entry" })],
|
|
191
191
|
category: "History",
|
|
192
192
|
description: "Go forward in history"
|
|
193
193
|
},
|
|
194
194
|
historyBack: {
|
|
195
195
|
requestFields: [field("steps", "int", {})],
|
|
196
|
-
responseFields: [field("historyEntry", "object", { objectType: "HistoryEntry", xmlTag: "HistoryEntry", varname: "
|
|
196
|
+
responseFields: [field("historyEntry", "object", { objectType: "HistoryEntry", xmlTag: "HistoryEntry", varname: "entry" })],
|
|
197
197
|
category: "History",
|
|
198
198
|
description: "Go back in history"
|
|
199
199
|
},
|
|
@@ -202,7 +202,7 @@ var API_METHODS = {
|
|
|
202
202
|
// ==========================================================================
|
|
203
203
|
addBookmark: {
|
|
204
204
|
requestFields: [field("topicID", "double", {}), field("navigationID", "double", {}), field("bookmarkTitle", "string", {})],
|
|
205
|
-
responseFields: [field("bookmarkEntry", "object", { objectType: "BookmarkEntry", xmlTag: "BookmarkEntry", varname: "
|
|
205
|
+
responseFields: [field("bookmarkEntry", "object", { objectType: "BookmarkEntry", xmlTag: "BookmarkEntry", varname: "entry" })],
|
|
206
206
|
category: "Bookmarks",
|
|
207
207
|
description: "Add a bookmark"
|
|
208
208
|
},
|
|
@@ -272,7 +272,7 @@ var API_METHODS = {
|
|
|
272
272
|
},
|
|
273
273
|
getCurrentGUILanguage: {
|
|
274
274
|
requestFields: [field("not_used", "boolean", {})],
|
|
275
|
-
responseFields: [field("guiLanguage", "string")],
|
|
275
|
+
responseFields: [field("guiLanguage", "string", { xmlTag: "currentGUILanguage" })],
|
|
276
276
|
category: "GUI Language",
|
|
277
277
|
description: "Get current GUI language"
|
|
278
278
|
},
|
|
@@ -290,7 +290,7 @@ var API_METHODS = {
|
|
|
290
290
|
// ==========================================================================
|
|
291
291
|
getCobriliLinkForTopicId: {
|
|
292
292
|
requestFields: [field("topicID", "double", {})],
|
|
293
|
-
responseFields: [field("cobriliLink", "string")],
|
|
293
|
+
responseFields: [field("cobriliLink", "string", { xmlTag: "linkText" })],
|
|
294
294
|
category: "Cobrili Links",
|
|
295
295
|
description: "Generate a Cobrili link for a topic"
|
|
296
296
|
},
|
|
@@ -299,13 +299,24 @@ var API_METHODS = {
|
|
|
299
299
|
// ==========================================================================
|
|
300
300
|
getConfigurationData: {
|
|
301
301
|
requestFields: [field("not_used", "boolean", {})],
|
|
302
|
-
responseFields: [
|
|
302
|
+
responseFields: [
|
|
303
|
+
field("commonConfig", "object", { xmlTag: "common_config", varname: "common_config" }),
|
|
304
|
+
field("mainConfig", "object", { xmlTag: "main_config", varname: "main_config" }),
|
|
305
|
+
field("metaKeyForLanguage", "string", { optional: true }),
|
|
306
|
+
field("defaultGuiLanguage", "string", { optional: true }),
|
|
307
|
+
field("searchFacetKeys", "stringArray", { optional: true })
|
|
308
|
+
],
|
|
303
309
|
category: "Configuration",
|
|
304
310
|
description: "Get configuration data"
|
|
305
311
|
},
|
|
306
312
|
getCurrentCobriliVersion: {
|
|
307
313
|
requestFields: [field("not_used", "boolean", {})],
|
|
308
|
-
responseFields: [
|
|
314
|
+
responseFields: [
|
|
315
|
+
field("version", "string", { xmlTag: "currentVersionNumber" }),
|
|
316
|
+
field("versionInDatabase", "string", { xmlTag: "currentVersionNumber_in_database" }),
|
|
317
|
+
field("customMasterHelpsetVersion", "string", { xmlTag: "customMasterHelpsetVersion" }),
|
|
318
|
+
field("buildDate", "string", { optional: true })
|
|
319
|
+
],
|
|
309
320
|
category: "Configuration",
|
|
310
321
|
description: "Get current Cobrili version"
|
|
311
322
|
},
|
|
@@ -319,7 +330,7 @@ var API_METHODS = {
|
|
|
319
330
|
field("overwriteExistingHelpset", "boolean", {}),
|
|
320
331
|
field("uri_to_webapp_for_refresh_cache_after_helpset_import", "string", { optional: true })
|
|
321
332
|
],
|
|
322
|
-
responseFields: [field("success", "boolean"), field("helpsetID", "double"), field("message", "string")],
|
|
333
|
+
responseFields: [field("success", "boolean"), field("helpsetID", "double", { optional: true }), field("message", "string", { xmlTag: "errorMessages", optional: true })],
|
|
323
334
|
category: "Helpset Import/Export/Management",
|
|
324
335
|
description: "Import a helpset from a ZIP file"
|
|
325
336
|
},
|
|
@@ -343,13 +354,19 @@ var API_METHODS = {
|
|
|
343
354
|
field("defaultGuiLanguage", "string", {}),
|
|
344
355
|
field("databaseSettings", "object", { optional: true, objectType: "DatabaseSettings", varname: "databaseSettings" })
|
|
345
356
|
],
|
|
346
|
-
responseFields: [field("masterHelpSetID", "double"), field("isNew", "boolean")],
|
|
357
|
+
responseFields: [field("success", "boolean", { xmlTag: "success", optional: true }), field("masterHelpSetID", "double", { optional: true }), field("isNew", "boolean", { optional: true })],
|
|
347
358
|
category: "Helpset Import/Export/Management",
|
|
348
359
|
description: "Create a new master helpset or return existing"
|
|
349
360
|
},
|
|
350
361
|
deleteHelpset: {
|
|
351
|
-
requestFields: [field("helpsetID", "double", {})],
|
|
352
|
-
responseFields: [
|
|
362
|
+
requestFields: [field("helpsetID", "double", { xmlTag: "helpsetId" })],
|
|
363
|
+
responseFields: [
|
|
364
|
+
field("success", "boolean", { optional: true }),
|
|
365
|
+
field("deleted_helpsetUniqueIdentifier", "string", { optional: true }),
|
|
366
|
+
field("deleted_helpsetID", "double", { optional: true }),
|
|
367
|
+
field("deleted_topicIDs", "array", { itemType: "double", keytype: "vector", optional: true, xmlTag: "deleted_topicIDs" }),
|
|
368
|
+
field("deleted_navigationIDs", "array", { itemType: "double", keytype: "vector", optional: true, xmlTag: "deleted_navigationIDs" })
|
|
369
|
+
],
|
|
353
370
|
category: "Helpset Import/Export/Management",
|
|
354
371
|
description: "Delete a helpset"
|
|
355
372
|
},
|
|
@@ -372,13 +389,13 @@ var API_METHODS = {
|
|
|
372
389
|
field("overwriteExistingHelpset", "boolean", {}),
|
|
373
390
|
field("uri_to_webapp_for_refresh_cache_after_helpset_import", "string", { optional: true })
|
|
374
391
|
],
|
|
375
|
-
responseFields: [field("success", "boolean"), field("importedCount", "int")],
|
|
392
|
+
responseFields: [field("success", "boolean"), field("importedCount", "int", { optional: true }), field("errorMessages", "string", { xmlTag: "errorMessages", optional: true })],
|
|
376
393
|
category: "Helpset Import/Export/Management",
|
|
377
394
|
description: "Import multiple helpsets from a folder"
|
|
378
395
|
},
|
|
379
396
|
checkMasterHelpsetID: {
|
|
380
397
|
requestFields: [field("masterHelpSetApplicationIdentifier", "string", {})],
|
|
381
|
-
responseFields: [field("isValid", "boolean"), field("masterHelpsetID", "double")],
|
|
398
|
+
responseFields: [field("isValid", "boolean", { xmlTag: "isExistingMasterHelpset" }), field("masterHelpsetID", "double")],
|
|
382
399
|
category: "Helpset Import/Export/Management",
|
|
383
400
|
description: "Check if master helpset ID is valid"
|
|
384
401
|
},
|
|
@@ -417,7 +434,11 @@ var API_METHODS = {
|
|
|
417
434
|
// ==========================================================================
|
|
418
435
|
getSearchData: {
|
|
419
436
|
requestFields: [field("searchID", "double", {})],
|
|
420
|
-
responseFields: [
|
|
437
|
+
responseFields: [
|
|
438
|
+
field("numberOfResults", "int", { xmlTag: "numberOfHits" }),
|
|
439
|
+
field("searchRequest", "object", { optional: true, objectType: "StartSearchRequest", xmlTag: "StartSearchRequest", varname: "searchRequest" }),
|
|
440
|
+
field("searchProposals", "array", { optional: true, itemObjectType: "SearchProposalResult", xmlTag: "searchProposals" })
|
|
441
|
+
],
|
|
421
442
|
category: "Search Extended",
|
|
422
443
|
description: "Get search parameters for a search ID"
|
|
423
444
|
},
|
|
@@ -440,13 +461,13 @@ var API_METHODS = {
|
|
|
440
461
|
},
|
|
441
462
|
getUsedLuceneQueryAsString: {
|
|
442
463
|
requestFields: [field("searchID", "double", {})],
|
|
443
|
-
responseFields: [field("luceneQuery", "string")],
|
|
464
|
+
responseFields: [field("luceneQuery", "string", { xmlTag: "queryString" })],
|
|
444
465
|
category: "Search Extended",
|
|
445
466
|
description: "Get Lucene query as string"
|
|
446
467
|
},
|
|
447
468
|
getMetaKeysWhichBehaveAsSearchFacets: {
|
|
448
469
|
requestFields: [field("not_used", "boolean", {})],
|
|
449
|
-
responseFields: [field("facetKeys", "stringArray")],
|
|
470
|
+
responseFields: [field("facetKeys", "stringArray", { xmlTag: "metaKeys" })],
|
|
450
471
|
category: "Search Extended",
|
|
451
472
|
description: "Get metadata keys that behave as search facets"
|
|
452
473
|
},
|
|
@@ -494,7 +515,7 @@ var API_METHODS = {
|
|
|
494
515
|
},
|
|
495
516
|
getAllChangesInNumberOfSearchResultsForFacets: {
|
|
496
517
|
requestFields: [field("searchID", "double", {}), field("facets", "array", { itemObjectType: "FacetInputData", varname: "facets" })],
|
|
497
|
-
responseFields: [field("facetResults", "array", { itemObjectType: "FacetChange", varname: "facetResults" })],
|
|
518
|
+
responseFields: [field("searchID", "double", { xmlTag: "searchID" }), field("facetResults", "array", { itemObjectType: "FacetChange", varname: "facetResults" })],
|
|
498
519
|
category: "Search Extended",
|
|
499
520
|
description: "Get all facet changes for search"
|
|
500
521
|
},
|
|
@@ -511,7 +532,7 @@ var API_METHODS = {
|
|
|
511
532
|
description: "Start search for a given language"
|
|
512
533
|
},
|
|
513
534
|
getExecutedSearches: {
|
|
514
|
-
requestFields: [field("dateStart", "double", {}), field("dateEnd", "double", {})],
|
|
535
|
+
requestFields: [field("dateStart", "double", { xmlTag: "date_start" }), field("dateEnd", "double", { xmlTag: "date_end" })],
|
|
515
536
|
responseFields: [field("searches", "array", { itemObjectType: "ExecutedSearch" })],
|
|
516
537
|
category: "Search Extended",
|
|
517
538
|
description: "Get executed searches in date range"
|
|
@@ -526,7 +547,7 @@ var API_METHODS = {
|
|
|
526
547
|
field("searchLanguage", "string", { optional: true }),
|
|
527
548
|
field("searchBelowTheseTopics", "array", { itemType: "double", varname: "searchBelowTheseTopics" })
|
|
528
549
|
],
|
|
529
|
-
responseFields: [field("searchID", "double"), field("numberOfResults", "int")],
|
|
550
|
+
responseFields: [field("searchID", "double"), field("numberOfResults", "int", { xmlTag: "numberOfHits" })],
|
|
530
551
|
category: "Search Extended",
|
|
531
552
|
description: "Start extended search with topic types"
|
|
532
553
|
},
|
|
@@ -554,7 +575,7 @@ var API_METHODS = {
|
|
|
554
575
|
startSearchWithSearchProposals: {
|
|
555
576
|
requestFields: [field("data", "object", { objectType: "StartExtendedSearchRequest", xmlTag: "StartExtendedSearchRequest", varname: "data" })],
|
|
556
577
|
responseFields: [
|
|
557
|
-
field("data", "object", { objectType: "StartExtendedSearchResponse", xmlTag: "StartExtendedSearchResponse", varname: "
|
|
578
|
+
field("data", "object", { objectType: "StartExtendedSearchResponse", xmlTag: "StartExtendedSearchResponse", varname: "result" }),
|
|
558
579
|
field("propsals", "array", { itemObjectType: "SearchProposalResult" })
|
|
559
580
|
],
|
|
560
581
|
category: "Search Extended",
|
|
@@ -562,7 +583,7 @@ var API_METHODS = {
|
|
|
562
583
|
},
|
|
563
584
|
getSearchSettings: {
|
|
564
585
|
requestFields: [field("not_used", "boolean", {})],
|
|
565
|
-
responseFields: [field("
|
|
586
|
+
responseFields: [field("settings", "object", { objectType: "SearchSettings", xmlTag: "SearchSettings", varname: "settings" })],
|
|
566
587
|
category: "Search Extended",
|
|
567
588
|
description: "Get search settings"
|
|
568
589
|
},
|
|
@@ -587,7 +608,7 @@ var API_METHODS = {
|
|
|
587
608
|
// ==========================================================================
|
|
588
609
|
updateCurrentHistoryEntry: {
|
|
589
610
|
requestFields: [field("scrollPosition", "int", {}), field("hitRangeBegin", "int", {}), field("hitRangeEnd", "int", {})],
|
|
590
|
-
responseFields: [field("success", "boolean")],
|
|
611
|
+
responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
|
|
591
612
|
category: "History Extended",
|
|
592
613
|
description: "Update current history entry scroll position"
|
|
593
614
|
},
|
|
@@ -622,7 +643,7 @@ var API_METHODS = {
|
|
|
622
643
|
method: "GetHistoryListExtended",
|
|
623
644
|
requestType: "GetHistoryListRequest",
|
|
624
645
|
requestFields: [field("not_used_at_the_moment", "boolean", {})],
|
|
625
|
-
responseFields: [field("entries", "array", { itemObjectType: "HistoryEntryExtended" }), field("currentPosition", "int")],
|
|
646
|
+
responseFields: [field("entries", "array", { itemObjectType: "HistoryEntryExtended" }), field("currentPosition", "int", { xmlTag: "historyStackPointer" })],
|
|
626
647
|
category: "History Extended",
|
|
627
648
|
description: "Get extended history list"
|
|
628
649
|
},
|
|
@@ -631,10 +652,10 @@ var API_METHODS = {
|
|
|
631
652
|
field("scrollPosition", "int", {}),
|
|
632
653
|
field("hitRangeBegin", "int", {}),
|
|
633
654
|
field("hitRangeEnd", "int", {}),
|
|
634
|
-
field("hitRangeBeginVideo", "int", {}),
|
|
635
|
-
field("hitRangeEndVideo", "int", {})
|
|
655
|
+
field("hitRangeBeginVideo", "int", { xmlTag: "hitRangeBegin_Video" }),
|
|
656
|
+
field("hitRangeEndVideo", "int", { xmlTag: "hitRangeEnd_Video" })
|
|
636
657
|
],
|
|
637
|
-
responseFields: [field("success", "boolean")],
|
|
658
|
+
responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
|
|
638
659
|
category: "History Extended",
|
|
639
660
|
description: "Update extended history entry"
|
|
640
661
|
},
|
|
@@ -643,12 +664,12 @@ var API_METHODS = {
|
|
|
643
664
|
// ==========================================================================
|
|
644
665
|
getAllowedMetaKeysForMasterhelpset: {
|
|
645
666
|
requestFields: [field("masterHelpSetApplicationIdentifier", "string", {})],
|
|
646
|
-
responseFields: [field("
|
|
667
|
+
responseFields: [field("allowedMetaKeys", "map", { varkeytype: "AlpTString", vartype: "bool", xmlTag: "allowedMetaKeys" })],
|
|
647
668
|
category: "Metadata Extended",
|
|
648
669
|
description: "Get allowed metadata keys for master helpset"
|
|
649
670
|
},
|
|
650
671
|
getPossibleMetaValuesByMetaKeyID: {
|
|
651
|
-
method: "
|
|
672
|
+
method: "GetPossibleMetaValuesByMetaKeyID",
|
|
652
673
|
requestType: "GetPossibleMetaValuesByMetaKeyIdRequest",
|
|
653
674
|
requestFields: [field("metaKeyId", "double", {})],
|
|
654
675
|
responseFields: [field("metaKeyId", "double"), field("values", "stringArray")],
|
|
@@ -668,7 +689,7 @@ var API_METHODS = {
|
|
|
668
689
|
field("localizeMetaValues", "boolean", {}),
|
|
669
690
|
field("sortMetaValues", "boolean", {})
|
|
670
691
|
],
|
|
671
|
-
responseFields: [field("
|
|
692
|
+
responseFields: [field("values", "stringArray", { optional: true }), field("sortedAndLocalizedEntries", "array", { itemObjectType: "LocalizedEntry", optional: true })],
|
|
672
693
|
category: "Metadata Extended",
|
|
673
694
|
description: "Get filtered metadata values"
|
|
674
695
|
},
|
|
@@ -692,7 +713,7 @@ var API_METHODS = {
|
|
|
692
713
|
},
|
|
693
714
|
getStartUpMetaValues: {
|
|
694
715
|
requestFields: [field("metaKey", "string", {})],
|
|
695
|
-
responseFields: [field("metaData", "
|
|
716
|
+
responseFields: [field("metaData", "stringArray", { xmlTag: "metaValues" })],
|
|
696
717
|
category: "Metadata Extended",
|
|
697
718
|
description: "Get startup meta values"
|
|
698
719
|
},
|
|
@@ -713,7 +734,7 @@ var API_METHODS = {
|
|
|
713
734
|
description: "Get navigation with metadata"
|
|
714
735
|
},
|
|
715
736
|
getBreadCrumbWithMetaData: {
|
|
716
|
-
method: "
|
|
737
|
+
method: "GetBreadCrumbWithMetaData",
|
|
717
738
|
requestType: "GetBreadcrumbWithMetaDataRequest",
|
|
718
739
|
requestFields: [
|
|
719
740
|
field("navigationID", "double", {}),
|
|
@@ -784,7 +805,7 @@ var API_METHODS = {
|
|
|
784
805
|
description: "Get navigation with metadata for language"
|
|
785
806
|
},
|
|
786
807
|
getBreadCrumbWithMetaDataForGivenLanguage: {
|
|
787
|
-
method: "
|
|
808
|
+
method: "GetBreadCrumbWithMetaData_ForGivenLanguage",
|
|
788
809
|
requestType: "GetBreadcrumbWithMetaData_ForGivenLanguageRequest",
|
|
789
810
|
requestFields: [
|
|
790
811
|
field("navigationID", "double", {}),
|
|
@@ -797,16 +818,16 @@ var API_METHODS = {
|
|
|
797
818
|
description: "Get breadcrumb with metadata for language"
|
|
798
819
|
},
|
|
799
820
|
getMetaValuesForFacets: {
|
|
800
|
-
requestFields: [field("facetName", "string", {})],
|
|
801
|
-
responseFields: [field("values", "stringArray")],
|
|
821
|
+
requestFields: [field("facetName", "string", { xmlTag: "facetname" })],
|
|
822
|
+
responseFields: [field("values", "stringArray"), field("sortedAndLocalizedEntries", "array", { itemObjectType: "LocalizedEntry", optional: true })],
|
|
802
823
|
category: "Metadata Extended",
|
|
803
824
|
description: "Get metadata values for facets"
|
|
804
825
|
},
|
|
805
826
|
getMetaValuesForFacetsForGivenLanguage: {
|
|
806
827
|
method: "GetMetaValuesForFacets_ForGivenLanguage",
|
|
807
828
|
requestType: "GetMetaValuesForFacets_ForGivenLanguageRequest",
|
|
808
|
-
requestFields: [field("facetName", "string", {}), field("givenLanguage", "string", {})],
|
|
809
|
-
responseFields: [field("values", "stringArray")],
|
|
829
|
+
requestFields: [field("facetName", "string", { xmlTag: "facetname" }), field("givenLanguage", "string", {})],
|
|
830
|
+
responseFields: [field("values", "stringArray"), field("sortedAndLocalizedEntries", "array", { itemObjectType: "LocalizedEntry", optional: true })],
|
|
810
831
|
category: "Metadata Extended",
|
|
811
832
|
description: "Get metadata values for facets for language"
|
|
812
833
|
},
|
|
@@ -823,13 +844,13 @@ var API_METHODS = {
|
|
|
823
844
|
field("customerType", "string", { keytype: "CustomerDefinitionEnum" }),
|
|
824
845
|
field("criteria", "stringArray", { varname: "criteria", keytype: "vector" })
|
|
825
846
|
],
|
|
826
|
-
responseFields: [field("
|
|
847
|
+
responseFields: [field("metaData", "map", { varkeytype: "AlpTString", vartype: "MetaValuesList", xmlTag: "metaData" })],
|
|
827
848
|
category: "Metadata Extended",
|
|
828
849
|
description: "Get metadata definitions for customer criteria"
|
|
829
850
|
},
|
|
830
851
|
setCurrentMetaDataSetForSession: {
|
|
831
852
|
requestFields: [field("metaData", "array", { itemObjectType: "MetaValuePair", keytype: "vector" })],
|
|
832
|
-
responseFields: [field("success", "boolean")],
|
|
853
|
+
responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
|
|
833
854
|
category: "Metadata Extended",
|
|
834
855
|
description: "Set current metadata set for session"
|
|
835
856
|
},
|
|
@@ -841,13 +862,13 @@ var API_METHODS = {
|
|
|
841
862
|
},
|
|
842
863
|
addToCurrentMetaDataSetForSession: {
|
|
843
864
|
requestFields: [field("metaKey", "string", {}), field("metaValue", "string", {})],
|
|
844
|
-
responseFields: [field("success", "boolean")],
|
|
865
|
+
responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
|
|
845
866
|
category: "Metadata Extended",
|
|
846
867
|
description: "Add to current metadata set for session"
|
|
847
868
|
},
|
|
848
869
|
removeFromCurrentMetaDataSetForSession: {
|
|
849
870
|
requestFields: [field("metaKey", "string", {}), field("metaValue", "string", {})],
|
|
850
|
-
responseFields: [field("success", "boolean")],
|
|
871
|
+
responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
|
|
851
872
|
category: "Metadata Extended",
|
|
852
873
|
description: "Remove from current metadata set for session"
|
|
853
874
|
},
|
|
@@ -894,7 +915,7 @@ var API_METHODS = {
|
|
|
894
915
|
field("validFromTimestamp", "double", { optional: true }),
|
|
895
916
|
field("validToTimestamp", "double", { optional: true })
|
|
896
917
|
],
|
|
897
|
-
responseFields: [field("user", "object", { objectType: "UserData", xmlTag: "UserData", varname: "
|
|
918
|
+
responseFields: [field("user", "object", { objectType: "UserData", xmlTag: "UserData", varname: "createdUser" })],
|
|
898
919
|
category: "User Management",
|
|
899
920
|
description: "Create a new user"
|
|
900
921
|
},
|
|
@@ -909,13 +930,13 @@ var API_METHODS = {
|
|
|
909
930
|
},
|
|
910
931
|
deleteUser: {
|
|
911
932
|
requestFields: [field("userID", "double", {})],
|
|
912
|
-
responseFields: [field("success", "boolean")],
|
|
933
|
+
responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
|
|
913
934
|
category: "User Management",
|
|
914
935
|
description: "Delete a user"
|
|
915
936
|
},
|
|
916
937
|
modifyUser: {
|
|
917
938
|
requestFields: [field("user", "object", { objectType: "UserInfo" })],
|
|
918
|
-
responseFields: [field("success", "boolean")],
|
|
939
|
+
responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
|
|
919
940
|
category: "User Management",
|
|
920
941
|
description: "Modify a user"
|
|
921
942
|
},
|
|
@@ -940,7 +961,7 @@ var API_METHODS = {
|
|
|
940
961
|
},
|
|
941
962
|
activateSelfRegisteredUser: {
|
|
942
963
|
requestFields: [field("userName", "string", {}), field("activationToken", "string", {})],
|
|
943
|
-
responseFields: [field("success", "boolean")],
|
|
964
|
+
responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
|
|
944
965
|
category: "User Management",
|
|
945
966
|
description: "Activate a self-registered user"
|
|
946
967
|
},
|
|
@@ -972,7 +993,7 @@ var API_METHODS = {
|
|
|
972
993
|
},
|
|
973
994
|
performActionAfterOpenIDAuthentification: {
|
|
974
995
|
requestFields: [field("data", "string", {})],
|
|
975
|
-
responseFields: [field("success", "boolean"), field("userID", "double")],
|
|
996
|
+
responseFields: [field("success", "boolean", { xmlTag: "not_used" }), field("userID", "double", { optional: true })],
|
|
976
997
|
category: "User Management",
|
|
977
998
|
description: "Perform action after OpenID auth"
|
|
978
999
|
},
|
|
@@ -993,13 +1014,13 @@ var API_METHODS = {
|
|
|
993
1014
|
},
|
|
994
1015
|
modifyGroup: {
|
|
995
1016
|
requestFields: [field("groupData", "object", { objectType: "GroupData" })],
|
|
996
|
-
responseFields: [field("success", "boolean")],
|
|
1017
|
+
responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
|
|
997
1018
|
category: "Group/Rights Management",
|
|
998
1019
|
description: "Modify a group"
|
|
999
1020
|
},
|
|
1000
1021
|
deleteGroup: {
|
|
1001
1022
|
requestFields: [field("groupID", "double", {})],
|
|
1002
|
-
responseFields: [field("success", "boolean")],
|
|
1023
|
+
responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
|
|
1003
1024
|
category: "Group/Rights Management",
|
|
1004
1025
|
description: "Delete a group"
|
|
1005
1026
|
},
|
|
@@ -1009,19 +1030,19 @@ var API_METHODS = {
|
|
|
1009
1030
|
field("rightsType", "string", {}),
|
|
1010
1031
|
field("updateData", "array", { itemObjectType: "MetaValueForGroupRightEntry", keytype: "vector" })
|
|
1011
1032
|
],
|
|
1012
|
-
responseFields: [field("success", "boolean")],
|
|
1033
|
+
responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
|
|
1013
1034
|
category: "Group/Rights Management",
|
|
1014
1035
|
description: "Update group rights"
|
|
1015
1036
|
},
|
|
1016
1037
|
getGroupRights: {
|
|
1017
1038
|
requestFields: [field("groupID", "double", {}), field("rightsType", "string", {})],
|
|
1018
|
-
responseFields: [field("rights", "
|
|
1039
|
+
responseFields: [field("rights", "array", { itemObjectType: "MetaValueForGroupRightEntry", keytype: "vector", xmlTag: "metadata_based_rights", varname: "metadata_based_rights" })],
|
|
1019
1040
|
category: "Group/Rights Management",
|
|
1020
1041
|
description: "Get group rights"
|
|
1021
1042
|
},
|
|
1022
1043
|
precompileFacetsBasedOnGroupRights: {
|
|
1023
|
-
requestFields: [field("callOptimizeImportData", "boolean", {})],
|
|
1024
|
-
responseFields: [field("success", "boolean")],
|
|
1044
|
+
requestFields: [field("callOptimizeImportData", "boolean", { xmlTag: "notUsed" })],
|
|
1045
|
+
responseFields: [field("success", "boolean", { xmlTag: "result" })],
|
|
1025
1046
|
category: "Group/Rights Management",
|
|
1026
1047
|
description: "Precompile facets based on group rights"
|
|
1027
1048
|
},
|
|
@@ -1057,13 +1078,13 @@ var API_METHODS = {
|
|
|
1057
1078
|
// ==========================================================================
|
|
1058
1079
|
isValidGUILanguage: {
|
|
1059
1080
|
requestFields: [field("lanCode", "string", {})],
|
|
1060
|
-
responseFields: [field("isValid", "boolean")],
|
|
1081
|
+
responseFields: [field("isValid", "boolean"), field("fallbackLanCode", "string", { optional: true })],
|
|
1061
1082
|
category: "GUI/Language Extended",
|
|
1062
1083
|
description: "Check if GUI language is valid"
|
|
1063
1084
|
},
|
|
1064
1085
|
getGUILanguageFromDatabase: {
|
|
1065
1086
|
requestFields: [field("not_used", "boolean", {})],
|
|
1066
|
-
responseFields: [field("guiLanguage", "string")],
|
|
1087
|
+
responseFields: [field("guiLanguage", "string", { xmlTag: "currentGUILanguage" })],
|
|
1067
1088
|
category: "GUI/Language Extended",
|
|
1068
1089
|
description: "Get GUI language from database"
|
|
1069
1090
|
},
|
|
@@ -1080,7 +1101,12 @@ var API_METHODS = {
|
|
|
1080
1101
|
// ==========================================================================
|
|
1081
1102
|
getAdditionalInfoAboutHelpset: {
|
|
1082
1103
|
requestFields: [field("helpsetID", "double", {})],
|
|
1083
|
-
responseFields: [
|
|
1104
|
+
responseFields: [
|
|
1105
|
+
field("lastModifiedByUser", "double"),
|
|
1106
|
+
field("lastModifiedDate", "string"),
|
|
1107
|
+
field("importedFromFile", "string"),
|
|
1108
|
+
field("helpsetDirectory", "string")
|
|
1109
|
+
],
|
|
1084
1110
|
category: "Topic/Navigation Extended",
|
|
1085
1111
|
description: "Get additional helpset info"
|
|
1086
1112
|
},
|
|
@@ -1098,17 +1124,17 @@ var API_METHODS = {
|
|
|
1098
1124
|
},
|
|
1099
1125
|
getProtocolHandlerPrefix: {
|
|
1100
1126
|
requestFields: [field("not_used", "boolean", {})],
|
|
1101
|
-
responseFields: [field("prefix", "string")],
|
|
1127
|
+
responseFields: [field("prefix", "string", { xmlTag: "protocolHandlerPrefix" })],
|
|
1102
1128
|
description: "Get protocol handler prefix"
|
|
1103
1129
|
},
|
|
1104
1130
|
getHomeTopicExternalId: {
|
|
1105
1131
|
requestFields: [field("helpsetExternalID", "string", {})],
|
|
1106
|
-
responseFields: [field("externalId", "string")],
|
|
1132
|
+
responseFields: [field("externalId", "string", { xmlTag: "homeTopicExternalID" })],
|
|
1107
1133
|
description: "Get home topic external ID"
|
|
1108
1134
|
},
|
|
1109
1135
|
getHelpsetInfosForExternalID: {
|
|
1110
1136
|
requestFields: [field("externalHelpsetID", "string", {})],
|
|
1111
|
-
responseFields: [field("helpsets", "array", { itemObjectType: "HelpsetInfo" })],
|
|
1137
|
+
responseFields: [field("helpsets", "array", { itemObjectType: "HelpsetInfo", xmlTag: "helpsetInfos" })],
|
|
1112
1138
|
description: "Get helpset infos by external ID"
|
|
1113
1139
|
},
|
|
1114
1140
|
getCurrentActiveTopicID: {
|
|
@@ -1120,7 +1146,7 @@ var API_METHODS = {
|
|
|
1120
1146
|
method: "GetExternalIdForTopic_IgnoreContainerHelpsets",
|
|
1121
1147
|
requestType: "GetExternalIdForTopic_IgnoreContainerHelpsetsRequest",
|
|
1122
1148
|
requestFields: [field("topicID", "double", {})],
|
|
1123
|
-
responseFields: [field("externalId", "string"), field("externalHelpsetId", "string")],
|
|
1149
|
+
responseFields: [field("externalId", "string", { xmlTag: "externalIdForTopic" }), field("externalHelpsetId", "string", { xmlTag: "externalIdForHelpset" }), field("metaDataForHelpset", "stringMap", { optional: true })],
|
|
1124
1150
|
description: "Get external ID ignoring container helpsets"
|
|
1125
1151
|
},
|
|
1126
1152
|
getChildTopics: {
|
|
@@ -1157,12 +1183,15 @@ var API_METHODS = {
|
|
|
1157
1183
|
},
|
|
1158
1184
|
isTopicVisible: {
|
|
1159
1185
|
requestFields: [field("topicID", "double", {})],
|
|
1160
|
-
responseFields: [
|
|
1186
|
+
responseFields: [
|
|
1187
|
+
field("IsVisible_because_HasAccessRights_ForThisTopic", "boolean"),
|
|
1188
|
+
field("IsVisible_because_SessionMetadataMatch_ForThisTopic", "boolean")
|
|
1189
|
+
],
|
|
1161
1190
|
description: "Check if topic is visible"
|
|
1162
1191
|
},
|
|
1163
1192
|
getAllPossibleTopicsForExternalTopicID: {
|
|
1164
1193
|
requestFields: [field("externalTopicID", "string", {}), field("metaData", "stringMap", {})],
|
|
1165
|
-
responseFields: [field("topics", "array", { itemObjectType: "TopicInfo" })],
|
|
1194
|
+
responseFields: [field("topics", "array", { itemObjectType: "TopicInfo", xmlTag: "result" })],
|
|
1166
1195
|
description: "Get all possible topics for external ID"
|
|
1167
1196
|
},
|
|
1168
1197
|
getRDFRelatedTopics: {
|
|
@@ -1191,7 +1220,7 @@ var API_METHODS = {
|
|
|
1191
1220
|
},
|
|
1192
1221
|
getSynonymList: {
|
|
1193
1222
|
requestFields: [field("language", "string", {})],
|
|
1194
|
-
responseFields: [field("synonyms", "array", { itemObjectType: "SynonymEntry" })],
|
|
1223
|
+
responseFields: [field("synonyms", "array", { itemObjectType: "SynonymEntry", xmlTag: "synonymEntries" })],
|
|
1195
1224
|
description: "Get synonym list"
|
|
1196
1225
|
},
|
|
1197
1226
|
// ==========================================================================
|
|
@@ -1212,7 +1241,7 @@ var API_METHODS = {
|
|
|
1212
1241
|
// ==========================================================================
|
|
1213
1242
|
getLastCobriliErrorCode: {
|
|
1214
1243
|
requestFields: [field("not_used", "boolean", {})],
|
|
1215
|
-
responseFields: [field("errorCode", "string")],
|
|
1244
|
+
responseFields: [field("errorCode", "string", { xmlTag: "lastCobriliErrorCode" })],
|
|
1216
1245
|
description: "Get last Cobrili error code"
|
|
1217
1246
|
},
|
|
1218
1247
|
getErrorLinkForErrorCode: {
|
|
@@ -1222,7 +1251,7 @@ var API_METHODS = {
|
|
|
1222
1251
|
},
|
|
1223
1252
|
canApplicationDisplayData: {
|
|
1224
1253
|
requestFields: [field("not_used", "boolean", {})],
|
|
1225
|
-
responseFields: [field("canDisplay", "boolean")],
|
|
1254
|
+
responseFields: [field("canDisplay", "boolean", { xmlTag: "not_used" })],
|
|
1226
1255
|
description: "Check if application can display data"
|
|
1227
1256
|
},
|
|
1228
1257
|
makeDatabaseUpdate: {
|
|
@@ -1236,20 +1265,20 @@ var API_METHODS = {
|
|
|
1236
1265
|
},
|
|
1237
1266
|
clearStaticCaches: {
|
|
1238
1267
|
requestFields: [field("not_used", "boolean", {})],
|
|
1239
|
-
responseFields: [field("success", "boolean")],
|
|
1268
|
+
responseFields: [field("success", "boolean", { xmlTag: "operationSucceeded" })],
|
|
1240
1269
|
description: "Clear static caches"
|
|
1241
1270
|
},
|
|
1242
1271
|
refreshStaticCaches: {
|
|
1243
1272
|
requestFields: [
|
|
1244
1273
|
field("secretToken", "string", {}),
|
|
1245
1274
|
field("uniqueHelpsetIdentifier", "string", {}),
|
|
1246
|
-
field("deletedHelpsetID", "double", {}),
|
|
1275
|
+
field("deletedHelpsetID", "double", { xmlTag: "deleted_helpsetID" }),
|
|
1247
1276
|
field("deletedHelpsetExternalID", "string", {}),
|
|
1248
1277
|
field("deletedHelpsetLanguage", "string", {}),
|
|
1249
|
-
field("deletedTopicIDs", "array", { itemType: "double", keytype: "vector" }),
|
|
1250
|
-
field("deletedNavigationIDs", "array", { itemType: "double", keytype: "vector" })
|
|
1278
|
+
field("deletedTopicIDs", "array", { itemType: "double", keytype: "vector", xmlTag: "deleted_topicIDs" }),
|
|
1279
|
+
field("deletedNavigationIDs", "array", { itemType: "double", keytype: "vector", xmlTag: "deleted_navigationIDs" })
|
|
1251
1280
|
],
|
|
1252
|
-
responseFields: [field("success", "boolean")],
|
|
1281
|
+
responseFields: [field("success", "boolean", { xmlTag: "result" })],
|
|
1253
1282
|
description: "Refresh static caches"
|
|
1254
1283
|
},
|
|
1255
1284
|
exportDataForTest: {
|
|
@@ -2263,7 +2292,6 @@ var CobriliClient = class {
|
|
|
2263
2292
|
this.initialized = false;
|
|
2264
2293
|
this.initPromise = null;
|
|
2265
2294
|
this.config = { ...DEFAULT_CONFIG, ...config };
|
|
2266
|
-
this.init();
|
|
2267
2295
|
return new Proxy(this, {
|
|
2268
2296
|
get: (target, prop) => {
|
|
2269
2297
|
if (prop in target) {
|
|
@@ -2342,13 +2370,19 @@ var CobriliClient = class {
|
|
|
2342
2370
|
this.initialized = true;
|
|
2343
2371
|
return initData;
|
|
2344
2372
|
}
|
|
2345
|
-
|
|
2373
|
+
/**
|
|
2374
|
+
* Check if the client has been initialized.
|
|
2375
|
+
*/
|
|
2376
|
+
isInitialized() {
|
|
2377
|
+
return this.initialized;
|
|
2378
|
+
}
|
|
2379
|
+
assertInitialized() {
|
|
2346
2380
|
if (!this.initialized) {
|
|
2347
|
-
|
|
2381
|
+
throw new Error("CobriliClient not initialized. Call init() before making API calls.");
|
|
2348
2382
|
}
|
|
2349
2383
|
}
|
|
2350
2384
|
async call(methodName, params) {
|
|
2351
|
-
|
|
2385
|
+
this.assertInitialized();
|
|
2352
2386
|
const methodDef = API_METHODS[methodName];
|
|
2353
2387
|
if (!methodDef) {
|
|
2354
2388
|
return {
|
|
@@ -2367,7 +2401,7 @@ var CobriliClient = class {
|
|
|
2367
2401
|
methodName: apiMethod,
|
|
2368
2402
|
requestData: xmlRequest
|
|
2369
2403
|
});
|
|
2370
|
-
const response = await this.sendHttpRequest(
|
|
2404
|
+
const response = await this.sendHttpRequest(jsonPayload);
|
|
2371
2405
|
try {
|
|
2372
2406
|
const xmlNode = parseXml(response);
|
|
2373
2407
|
if (isExceptionResponse(xmlNode)) {
|
|
@@ -2401,11 +2435,11 @@ var CobriliClient = class {
|
|
|
2401
2435
|
};
|
|
2402
2436
|
}
|
|
2403
2437
|
}
|
|
2404
|
-
async sendHttpRequest(
|
|
2438
|
+
async sendHttpRequest(body) {
|
|
2405
2439
|
const controller = new AbortController();
|
|
2406
2440
|
const timeoutId = setTimeout(() => controller.abort(), this.config.timeout);
|
|
2407
2441
|
try {
|
|
2408
|
-
const response = await fetch(`${this.config.baseUrl}${this.config.endpoint}
|
|
2442
|
+
const response = await fetch(`${this.config.baseUrl}${this.config.endpoint}`, {
|
|
2409
2443
|
method: "POST",
|
|
2410
2444
|
headers: {
|
|
2411
2445
|
"Content-Type": "application/json",
|