cobrili-client 1.0.1 → 1.0.2

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 CHANGED
@@ -78,9 +78,7 @@ console.log(Object.keys(API_METHODS));
78
78
  - `getHomeTopicId({ helpsetID })` - Get home topic
79
79
  - `loadActiveHelpset({ helpsetID })` - Load a helpset
80
80
 
81
- ## License
82
-
83
- MIT
81
+ ### Bookmarks
84
82
  - `historyBack(steps?)` / `historyForward(steps?)` - Navigate history
85
83
  - `getBookmarkList()` - Get bookmarks
86
84
  - `addBookmark(topicID, navigationID, title)` - Add bookmark
@@ -110,8 +108,30 @@ interface ApiResponse<T> {
110
108
  ## Development
111
109
 
112
110
  ```bash
111
+ # Install dependencies
113
112
  npm install
113
+
114
+ # Build the package
115
+ npm run build
116
+
117
+ # Watch mode for development
118
+ npm run dev
119
+
120
+ # Run tests
121
+ npm run test
122
+
123
+ # Type check
124
+ npm run type-check
125
+
126
+ # Lint
127
+ npm run lint
128
+ ```
129
+
130
+ ## Publishing
131
+
132
+ ```bash
114
133
  npm run build
134
+ npm publish
115
135
  ```
116
136
 
117
137
  ## License
@@ -222,13 +222,13 @@ var CobriliAdapter = (() => {
222
222
  },
223
223
  historyForward: {
224
224
  requestFields: [field("steps", "int", {})],
225
- responseFields: [field("historyEntry", "object", { objectType: "HistoryEntry", xmlTag: "HistoryEntry", varname: "historyEntry" })],
225
+ responseFields: [field("historyEntry", "object", { objectType: "HistoryEntry", xmlTag: "HistoryEntry", varname: "entry" })],
226
226
  category: "History",
227
227
  description: "Go forward in history"
228
228
  },
229
229
  historyBack: {
230
230
  requestFields: [field("steps", "int", {})],
231
- responseFields: [field("historyEntry", "object", { objectType: "HistoryEntry", xmlTag: "HistoryEntry", varname: "historyEntry" })],
231
+ responseFields: [field("historyEntry", "object", { objectType: "HistoryEntry", xmlTag: "HistoryEntry", varname: "entry" })],
232
232
  category: "History",
233
233
  description: "Go back in history"
234
234
  },
@@ -237,7 +237,7 @@ var CobriliAdapter = (() => {
237
237
  // ==========================================================================
238
238
  addBookmark: {
239
239
  requestFields: [field("topicID", "double", {}), field("navigationID", "double", {}), field("bookmarkTitle", "string", {})],
240
- responseFields: [field("bookmarkEntry", "object", { objectType: "BookmarkEntry", xmlTag: "BookmarkEntry", varname: "bookmarkEntry" })],
240
+ responseFields: [field("bookmarkEntry", "object", { objectType: "BookmarkEntry", xmlTag: "BookmarkEntry", varname: "entry" })],
241
241
  category: "Bookmarks",
242
242
  description: "Add a bookmark"
243
243
  },
@@ -307,7 +307,7 @@ var CobriliAdapter = (() => {
307
307
  },
308
308
  getCurrentGUILanguage: {
309
309
  requestFields: [field("not_used", "boolean", {})],
310
- responseFields: [field("guiLanguage", "string")],
310
+ responseFields: [field("guiLanguage", "string", { xmlTag: "currentGUILanguage" })],
311
311
  category: "GUI Language",
312
312
  description: "Get current GUI language"
313
313
  },
@@ -325,7 +325,7 @@ var CobriliAdapter = (() => {
325
325
  // ==========================================================================
326
326
  getCobriliLinkForTopicId: {
327
327
  requestFields: [field("topicID", "double", {})],
328
- responseFields: [field("cobriliLink", "string")],
328
+ responseFields: [field("cobriliLink", "string", { xmlTag: "linkText" })],
329
329
  category: "Cobrili Links",
330
330
  description: "Generate a Cobrili link for a topic"
331
331
  },
@@ -334,13 +334,24 @@ var CobriliAdapter = (() => {
334
334
  // ==========================================================================
335
335
  getConfigurationData: {
336
336
  requestFields: [field("not_used", "boolean", {})],
337
- responseFields: [field("metaKeyForLanguage", "string"), field("defaultGuiLanguage", "string"), field("searchFacetKeys", "stringArray")],
337
+ responseFields: [
338
+ field("commonConfig", "object", { xmlTag: "common_config", varname: "common_config" }),
339
+ field("mainConfig", "object", { xmlTag: "main_config", varname: "main_config" }),
340
+ field("metaKeyForLanguage", "string", { optional: true }),
341
+ field("defaultGuiLanguage", "string", { optional: true }),
342
+ field("searchFacetKeys", "stringArray", { optional: true })
343
+ ],
338
344
  category: "Configuration",
339
345
  description: "Get configuration data"
340
346
  },
341
347
  getCurrentCobriliVersion: {
342
348
  requestFields: [field("not_used", "boolean", {})],
343
- responseFields: [field("version", "string"), field("buildDate", "string")],
349
+ responseFields: [
350
+ field("version", "string", { xmlTag: "currentVersionNumber" }),
351
+ field("versionInDatabase", "string", { xmlTag: "currentVersionNumber_in_database" }),
352
+ field("customMasterHelpsetVersion", "string", { xmlTag: "customMasterHelpsetVersion" }),
353
+ field("buildDate", "string", { optional: true })
354
+ ],
344
355
  category: "Configuration",
345
356
  description: "Get current Cobrili version"
346
357
  },
@@ -354,7 +365,7 @@ var CobriliAdapter = (() => {
354
365
  field("overwriteExistingHelpset", "boolean", {}),
355
366
  field("uri_to_webapp_for_refresh_cache_after_helpset_import", "string", { optional: true })
356
367
  ],
357
- responseFields: [field("success", "boolean"), field("helpsetID", "double"), field("message", "string")],
368
+ responseFields: [field("success", "boolean"), field("helpsetID", "double", { optional: true }), field("message", "string", { xmlTag: "errorMessages", optional: true })],
358
369
  category: "Helpset Import/Export/Management",
359
370
  description: "Import a helpset from a ZIP file"
360
371
  },
@@ -378,13 +389,19 @@ var CobriliAdapter = (() => {
378
389
  field("defaultGuiLanguage", "string", {}),
379
390
  field("databaseSettings", "object", { optional: true, objectType: "DatabaseSettings", varname: "databaseSettings" })
380
391
  ],
381
- responseFields: [field("masterHelpSetID", "double"), field("isNew", "boolean")],
392
+ responseFields: [field("success", "boolean", { xmlTag: "success", optional: true }), field("masterHelpSetID", "double", { optional: true }), field("isNew", "boolean", { optional: true })],
382
393
  category: "Helpset Import/Export/Management",
383
394
  description: "Create a new master helpset or return existing"
384
395
  },
385
396
  deleteHelpset: {
386
- requestFields: [field("helpsetID", "double", {})],
387
- responseFields: [field("success", "boolean")],
397
+ requestFields: [field("helpsetID", "double", { xmlTag: "helpsetId" })],
398
+ responseFields: [
399
+ field("success", "boolean", { optional: true }),
400
+ field("deleted_helpsetUniqueIdentifier", "string", { optional: true }),
401
+ field("deleted_helpsetID", "double", { optional: true }),
402
+ field("deleted_topicIDs", "array", { itemType: "double", keytype: "vector", optional: true, xmlTag: "deleted_topicIDs" }),
403
+ field("deleted_navigationIDs", "array", { itemType: "double", keytype: "vector", optional: true, xmlTag: "deleted_navigationIDs" })
404
+ ],
388
405
  category: "Helpset Import/Export/Management",
389
406
  description: "Delete a helpset"
390
407
  },
@@ -407,13 +424,13 @@ var CobriliAdapter = (() => {
407
424
  field("overwriteExistingHelpset", "boolean", {}),
408
425
  field("uri_to_webapp_for_refresh_cache_after_helpset_import", "string", { optional: true })
409
426
  ],
410
- responseFields: [field("success", "boolean"), field("importedCount", "int")],
427
+ responseFields: [field("success", "boolean"), field("importedCount", "int", { optional: true }), field("errorMessages", "string", { xmlTag: "errorMessages", optional: true })],
411
428
  category: "Helpset Import/Export/Management",
412
429
  description: "Import multiple helpsets from a folder"
413
430
  },
414
431
  checkMasterHelpsetID: {
415
432
  requestFields: [field("masterHelpSetApplicationIdentifier", "string", {})],
416
- responseFields: [field("isValid", "boolean"), field("masterHelpsetID", "double")],
433
+ responseFields: [field("isValid", "boolean", { xmlTag: "isExistingMasterHelpset" }), field("masterHelpsetID", "double")],
417
434
  category: "Helpset Import/Export/Management",
418
435
  description: "Check if master helpset ID is valid"
419
436
  },
@@ -452,7 +469,11 @@ var CobriliAdapter = (() => {
452
469
  // ==========================================================================
453
470
  getSearchData: {
454
471
  requestFields: [field("searchID", "double", {})],
455
- responseFields: [field("searchString", "string"), field("searchParameters", "object", { objectType: "SearchQueryParameters" }), field("numberOfResults", "int")],
472
+ responseFields: [
473
+ field("numberOfResults", "int", { xmlTag: "numberOfHits" }),
474
+ field("searchRequest", "object", { optional: true, objectType: "StartSearchRequest", xmlTag: "StartSearchRequest", varname: "searchRequest" }),
475
+ field("searchProposals", "array", { optional: true, itemObjectType: "SearchProposalResult", xmlTag: "searchProposals" })
476
+ ],
456
477
  category: "Search Extended",
457
478
  description: "Get search parameters for a search ID"
458
479
  },
@@ -475,13 +496,13 @@ var CobriliAdapter = (() => {
475
496
  },
476
497
  getUsedLuceneQueryAsString: {
477
498
  requestFields: [field("searchID", "double", {})],
478
- responseFields: [field("luceneQuery", "string")],
499
+ responseFields: [field("luceneQuery", "string", { xmlTag: "queryString" })],
479
500
  category: "Search Extended",
480
501
  description: "Get Lucene query as string"
481
502
  },
482
503
  getMetaKeysWhichBehaveAsSearchFacets: {
483
504
  requestFields: [field("not_used", "boolean", {})],
484
- responseFields: [field("facetKeys", "stringArray")],
505
+ responseFields: [field("facetKeys", "stringArray", { xmlTag: "metaKeys" })],
485
506
  category: "Search Extended",
486
507
  description: "Get metadata keys that behave as search facets"
487
508
  },
@@ -529,7 +550,7 @@ var CobriliAdapter = (() => {
529
550
  },
530
551
  getAllChangesInNumberOfSearchResultsForFacets: {
531
552
  requestFields: [field("searchID", "double", {}), field("facets", "array", { itemObjectType: "FacetInputData", varname: "facets" })],
532
- responseFields: [field("facetResults", "array", { itemObjectType: "FacetChange", varname: "facetResults" })],
553
+ responseFields: [field("searchID", "double", { xmlTag: "searchID" }), field("facetResults", "array", { itemObjectType: "FacetChange", varname: "facetResults" })],
533
554
  category: "Search Extended",
534
555
  description: "Get all facet changes for search"
535
556
  },
@@ -546,7 +567,7 @@ var CobriliAdapter = (() => {
546
567
  description: "Start search for a given language"
547
568
  },
548
569
  getExecutedSearches: {
549
- requestFields: [field("dateStart", "double", {}), field("dateEnd", "double", {})],
570
+ requestFields: [field("dateStart", "double", { xmlTag: "date_start" }), field("dateEnd", "double", { xmlTag: "date_end" })],
550
571
  responseFields: [field("searches", "array", { itemObjectType: "ExecutedSearch" })],
551
572
  category: "Search Extended",
552
573
  description: "Get executed searches in date range"
@@ -561,7 +582,7 @@ var CobriliAdapter = (() => {
561
582
  field("searchLanguage", "string", { optional: true }),
562
583
  field("searchBelowTheseTopics", "array", { itemType: "double", varname: "searchBelowTheseTopics" })
563
584
  ],
564
- responseFields: [field("searchID", "double"), field("numberOfResults", "int")],
585
+ responseFields: [field("searchID", "double"), field("numberOfResults", "int", { xmlTag: "numberOfHits" })],
565
586
  category: "Search Extended",
566
587
  description: "Start extended search with topic types"
567
588
  },
@@ -589,7 +610,7 @@ var CobriliAdapter = (() => {
589
610
  startSearchWithSearchProposals: {
590
611
  requestFields: [field("data", "object", { objectType: "StartExtendedSearchRequest", xmlTag: "StartExtendedSearchRequest", varname: "data" })],
591
612
  responseFields: [
592
- field("data", "object", { objectType: "StartExtendedSearchResponse", xmlTag: "StartExtendedSearchResponse", varname: "data" }),
613
+ field("data", "object", { objectType: "StartExtendedSearchResponse", xmlTag: "StartExtendedSearchResponse", varname: "result" }),
593
614
  field("propsals", "array", { itemObjectType: "SearchProposalResult" })
594
615
  ],
595
616
  category: "Search Extended",
@@ -597,7 +618,7 @@ var CobriliAdapter = (() => {
597
618
  },
598
619
  getSearchSettings: {
599
620
  requestFields: [field("not_used", "boolean", {})],
600
- responseFields: [field("SearchSettings", "object")],
621
+ responseFields: [field("settings", "object", { objectType: "SearchSettings", xmlTag: "SearchSettings", varname: "settings" })],
601
622
  category: "Search Extended",
602
623
  description: "Get search settings"
603
624
  },
@@ -622,7 +643,7 @@ var CobriliAdapter = (() => {
622
643
  // ==========================================================================
623
644
  updateCurrentHistoryEntry: {
624
645
  requestFields: [field("scrollPosition", "int", {}), field("hitRangeBegin", "int", {}), field("hitRangeEnd", "int", {})],
625
- responseFields: [field("success", "boolean")],
646
+ responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
626
647
  category: "History Extended",
627
648
  description: "Update current history entry scroll position"
628
649
  },
@@ -657,7 +678,7 @@ var CobriliAdapter = (() => {
657
678
  method: "GetHistoryListExtended",
658
679
  requestType: "GetHistoryListRequest",
659
680
  requestFields: [field("not_used_at_the_moment", "boolean", {})],
660
- responseFields: [field("entries", "array", { itemObjectType: "HistoryEntryExtended" }), field("currentPosition", "int")],
681
+ responseFields: [field("entries", "array", { itemObjectType: "HistoryEntryExtended" }), field("currentPosition", "int", { xmlTag: "historyStackPointer" })],
661
682
  category: "History Extended",
662
683
  description: "Get extended history list"
663
684
  },
@@ -666,10 +687,10 @@ var CobriliAdapter = (() => {
666
687
  field("scrollPosition", "int", {}),
667
688
  field("hitRangeBegin", "int", {}),
668
689
  field("hitRangeEnd", "int", {}),
669
- field("hitRangeBeginVideo", "int", {}),
670
- field("hitRangeEndVideo", "int", {})
690
+ field("hitRangeBeginVideo", "int", { xmlTag: "hitRangeBegin_Video" }),
691
+ field("hitRangeEndVideo", "int", { xmlTag: "hitRangeEnd_Video" })
671
692
  ],
672
- responseFields: [field("success", "boolean")],
693
+ responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
673
694
  category: "History Extended",
674
695
  description: "Update extended history entry"
675
696
  },
@@ -678,12 +699,12 @@ var CobriliAdapter = (() => {
678
699
  // ==========================================================================
679
700
  getAllowedMetaKeysForMasterhelpset: {
680
701
  requestFields: [field("masterHelpSetApplicationIdentifier", "string", {})],
681
- responseFields: [field("metaKeys", "array", { itemObjectType: "MetaKeyDefinition" })],
702
+ responseFields: [field("allowedMetaKeys", "map", { varkeytype: "AlpTString", vartype: "bool", xmlTag: "allowedMetaKeys" })],
682
703
  category: "Metadata Extended",
683
704
  description: "Get allowed metadata keys for master helpset"
684
705
  },
685
706
  getPossibleMetaValuesByMetaKeyID: {
686
- method: "GetPossibleMetaValuesByMetaKeyId",
707
+ method: "GetPossibleMetaValuesByMetaKeyID",
687
708
  requestType: "GetPossibleMetaValuesByMetaKeyIdRequest",
688
709
  requestFields: [field("metaKeyId", "double", {})],
689
710
  responseFields: [field("metaKeyId", "double"), field("values", "stringArray")],
@@ -703,7 +724,7 @@ var CobriliAdapter = (() => {
703
724
  field("localizeMetaValues", "boolean", {}),
704
725
  field("sortMetaValues", "boolean", {})
705
726
  ],
706
- responseFields: [field("entries", "array", { itemObjectType: "LocalizedEntry" })],
727
+ responseFields: [field("values", "stringArray", { optional: true }), field("sortedAndLocalizedEntries", "array", { itemObjectType: "LocalizedEntry", optional: true })],
707
728
  category: "Metadata Extended",
708
729
  description: "Get filtered metadata values"
709
730
  },
@@ -727,7 +748,7 @@ var CobriliAdapter = (() => {
727
748
  },
728
749
  getStartUpMetaValues: {
729
750
  requestFields: [field("metaKey", "string", {})],
730
- responseFields: [field("metaData", "object")],
751
+ responseFields: [field("metaData", "stringArray", { xmlTag: "metaValues" })],
731
752
  category: "Metadata Extended",
732
753
  description: "Get startup meta values"
733
754
  },
@@ -748,7 +769,7 @@ var CobriliAdapter = (() => {
748
769
  description: "Get navigation with metadata"
749
770
  },
750
771
  getBreadCrumbWithMetaData: {
751
- method: "GetBreadcrumbWithMetaData",
772
+ method: "GetBreadCrumbWithMetaData",
752
773
  requestType: "GetBreadcrumbWithMetaDataRequest",
753
774
  requestFields: [
754
775
  field("navigationID", "double", {}),
@@ -819,7 +840,7 @@ var CobriliAdapter = (() => {
819
840
  description: "Get navigation with metadata for language"
820
841
  },
821
842
  getBreadCrumbWithMetaDataForGivenLanguage: {
822
- method: "GetBreadcrumbWithMetaData_ForGivenLanguage",
843
+ method: "GetBreadCrumbWithMetaData_ForGivenLanguage",
823
844
  requestType: "GetBreadcrumbWithMetaData_ForGivenLanguageRequest",
824
845
  requestFields: [
825
846
  field("navigationID", "double", {}),
@@ -832,16 +853,16 @@ var CobriliAdapter = (() => {
832
853
  description: "Get breadcrumb with metadata for language"
833
854
  },
834
855
  getMetaValuesForFacets: {
835
- requestFields: [field("facetName", "string", {})],
836
- responseFields: [field("values", "stringArray")],
856
+ requestFields: [field("facetName", "string", { xmlTag: "facetname" })],
857
+ responseFields: [field("values", "stringArray"), field("sortedAndLocalizedEntries", "array", { itemObjectType: "LocalizedEntry", optional: true })],
837
858
  category: "Metadata Extended",
838
859
  description: "Get metadata values for facets"
839
860
  },
840
861
  getMetaValuesForFacetsForGivenLanguage: {
841
862
  method: "GetMetaValuesForFacets_ForGivenLanguage",
842
863
  requestType: "GetMetaValuesForFacets_ForGivenLanguageRequest",
843
- requestFields: [field("facetName", "string", {}), field("givenLanguage", "string", {})],
844
- responseFields: [field("values", "stringArray")],
864
+ requestFields: [field("facetName", "string", { xmlTag: "facetname" }), field("givenLanguage", "string", {})],
865
+ responseFields: [field("values", "stringArray"), field("sortedAndLocalizedEntries", "array", { itemObjectType: "LocalizedEntry", optional: true })],
845
866
  category: "Metadata Extended",
846
867
  description: "Get metadata values for facets for language"
847
868
  },
@@ -858,13 +879,13 @@ var CobriliAdapter = (() => {
858
879
  field("customerType", "string", { keytype: "CustomerDefinitionEnum" }),
859
880
  field("criteria", "stringArray", { varname: "criteria", keytype: "vector" })
860
881
  ],
861
- responseFields: [field("definitions", "array", { itemObjectType: "MetaDataDefinition" })],
882
+ responseFields: [field("metaData", "map", { varkeytype: "AlpTString", vartype: "MetaValuesList", xmlTag: "metaData" })],
862
883
  category: "Metadata Extended",
863
884
  description: "Get metadata definitions for customer criteria"
864
885
  },
865
886
  setCurrentMetaDataSetForSession: {
866
887
  requestFields: [field("metaData", "array", { itemObjectType: "MetaValuePair", keytype: "vector" })],
867
- responseFields: [field("success", "boolean")],
888
+ responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
868
889
  category: "Metadata Extended",
869
890
  description: "Set current metadata set for session"
870
891
  },
@@ -876,13 +897,13 @@ var CobriliAdapter = (() => {
876
897
  },
877
898
  addToCurrentMetaDataSetForSession: {
878
899
  requestFields: [field("metaKey", "string", {}), field("metaValue", "string", {})],
879
- responseFields: [field("success", "boolean")],
900
+ responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
880
901
  category: "Metadata Extended",
881
902
  description: "Add to current metadata set for session"
882
903
  },
883
904
  removeFromCurrentMetaDataSetForSession: {
884
905
  requestFields: [field("metaKey", "string", {}), field("metaValue", "string", {})],
885
- responseFields: [field("success", "boolean")],
906
+ responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
886
907
  category: "Metadata Extended",
887
908
  description: "Remove from current metadata set for session"
888
909
  },
@@ -929,7 +950,7 @@ var CobriliAdapter = (() => {
929
950
  field("validFromTimestamp", "double", { optional: true }),
930
951
  field("validToTimestamp", "double", { optional: true })
931
952
  ],
932
- responseFields: [field("user", "object", { objectType: "UserData", xmlTag: "UserData", varname: "user" })],
953
+ responseFields: [field("user", "object", { objectType: "UserData", xmlTag: "UserData", varname: "createdUser" })],
933
954
  category: "User Management",
934
955
  description: "Create a new user"
935
956
  },
@@ -944,13 +965,13 @@ var CobriliAdapter = (() => {
944
965
  },
945
966
  deleteUser: {
946
967
  requestFields: [field("userID", "double", {})],
947
- responseFields: [field("success", "boolean")],
968
+ responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
948
969
  category: "User Management",
949
970
  description: "Delete a user"
950
971
  },
951
972
  modifyUser: {
952
973
  requestFields: [field("user", "object", { objectType: "UserInfo" })],
953
- responseFields: [field("success", "boolean")],
974
+ responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
954
975
  category: "User Management",
955
976
  description: "Modify a user"
956
977
  },
@@ -975,7 +996,7 @@ var CobriliAdapter = (() => {
975
996
  },
976
997
  activateSelfRegisteredUser: {
977
998
  requestFields: [field("userName", "string", {}), field("activationToken", "string", {})],
978
- responseFields: [field("success", "boolean")],
999
+ responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
979
1000
  category: "User Management",
980
1001
  description: "Activate a self-registered user"
981
1002
  },
@@ -1007,7 +1028,7 @@ var CobriliAdapter = (() => {
1007
1028
  },
1008
1029
  performActionAfterOpenIDAuthentification: {
1009
1030
  requestFields: [field("data", "string", {})],
1010
- responseFields: [field("success", "boolean"), field("userID", "double")],
1031
+ responseFields: [field("success", "boolean", { xmlTag: "not_used" }), field("userID", "double", { optional: true })],
1011
1032
  category: "User Management",
1012
1033
  description: "Perform action after OpenID auth"
1013
1034
  },
@@ -1028,13 +1049,13 @@ var CobriliAdapter = (() => {
1028
1049
  },
1029
1050
  modifyGroup: {
1030
1051
  requestFields: [field("groupData", "object", { objectType: "GroupData" })],
1031
- responseFields: [field("success", "boolean")],
1052
+ responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
1032
1053
  category: "Group/Rights Management",
1033
1054
  description: "Modify a group"
1034
1055
  },
1035
1056
  deleteGroup: {
1036
1057
  requestFields: [field("groupID", "double", {})],
1037
- responseFields: [field("success", "boolean")],
1058
+ responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
1038
1059
  category: "Group/Rights Management",
1039
1060
  description: "Delete a group"
1040
1061
  },
@@ -1044,19 +1065,19 @@ var CobriliAdapter = (() => {
1044
1065
  field("rightsType", "string", {}),
1045
1066
  field("updateData", "array", { itemObjectType: "MetaValueForGroupRightEntry", keytype: "vector" })
1046
1067
  ],
1047
- responseFields: [field("success", "boolean")],
1068
+ responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
1048
1069
  category: "Group/Rights Management",
1049
1070
  description: "Update group rights"
1050
1071
  },
1051
1072
  getGroupRights: {
1052
1073
  requestFields: [field("groupID", "double", {}), field("rightsType", "string", {})],
1053
- responseFields: [field("rights", "object")],
1074
+ responseFields: [field("rights", "array", { itemObjectType: "MetaValueForGroupRightEntry", keytype: "vector", xmlTag: "metadata_based_rights", varname: "metadata_based_rights" })],
1054
1075
  category: "Group/Rights Management",
1055
1076
  description: "Get group rights"
1056
1077
  },
1057
1078
  precompileFacetsBasedOnGroupRights: {
1058
- requestFields: [field("callOptimizeImportData", "boolean", {})],
1059
- responseFields: [field("success", "boolean")],
1079
+ requestFields: [field("callOptimizeImportData", "boolean", { xmlTag: "notUsed" })],
1080
+ responseFields: [field("success", "boolean", { xmlTag: "result" })],
1060
1081
  category: "Group/Rights Management",
1061
1082
  description: "Precompile facets based on group rights"
1062
1083
  },
@@ -1092,13 +1113,13 @@ var CobriliAdapter = (() => {
1092
1113
  // ==========================================================================
1093
1114
  isValidGUILanguage: {
1094
1115
  requestFields: [field("lanCode", "string", {})],
1095
- responseFields: [field("isValid", "boolean")],
1116
+ responseFields: [field("isValid", "boolean"), field("fallbackLanCode", "string", { optional: true })],
1096
1117
  category: "GUI/Language Extended",
1097
1118
  description: "Check if GUI language is valid"
1098
1119
  },
1099
1120
  getGUILanguageFromDatabase: {
1100
1121
  requestFields: [field("not_used", "boolean", {})],
1101
- responseFields: [field("guiLanguage", "string")],
1122
+ responseFields: [field("guiLanguage", "string", { xmlTag: "currentGUILanguage" })],
1102
1123
  category: "GUI/Language Extended",
1103
1124
  description: "Get GUI language from database"
1104
1125
  },
@@ -1115,7 +1136,12 @@ var CobriliAdapter = (() => {
1115
1136
  // ==========================================================================
1116
1137
  getAdditionalInfoAboutHelpset: {
1117
1138
  requestFields: [field("helpsetID", "double", {})],
1118
- responseFields: [field("info", "object")],
1139
+ responseFields: [
1140
+ field("lastModifiedByUser", "double"),
1141
+ field("lastModifiedDate", "string"),
1142
+ field("importedFromFile", "string"),
1143
+ field("helpsetDirectory", "string")
1144
+ ],
1119
1145
  category: "Topic/Navigation Extended",
1120
1146
  description: "Get additional helpset info"
1121
1147
  },
@@ -1133,17 +1159,17 @@ var CobriliAdapter = (() => {
1133
1159
  },
1134
1160
  getProtocolHandlerPrefix: {
1135
1161
  requestFields: [field("not_used", "boolean", {})],
1136
- responseFields: [field("prefix", "string")],
1162
+ responseFields: [field("prefix", "string", { xmlTag: "protocolHandlerPrefix" })],
1137
1163
  description: "Get protocol handler prefix"
1138
1164
  },
1139
1165
  getHomeTopicExternalId: {
1140
1166
  requestFields: [field("helpsetExternalID", "string", {})],
1141
- responseFields: [field("externalId", "string")],
1167
+ responseFields: [field("externalId", "string", { xmlTag: "homeTopicExternalID" })],
1142
1168
  description: "Get home topic external ID"
1143
1169
  },
1144
1170
  getHelpsetInfosForExternalID: {
1145
1171
  requestFields: [field("externalHelpsetID", "string", {})],
1146
- responseFields: [field("helpsets", "array", { itemObjectType: "HelpsetInfo" })],
1172
+ responseFields: [field("helpsets", "array", { itemObjectType: "HelpsetInfo", xmlTag: "helpsetInfos" })],
1147
1173
  description: "Get helpset infos by external ID"
1148
1174
  },
1149
1175
  getCurrentActiveTopicID: {
@@ -1155,7 +1181,7 @@ var CobriliAdapter = (() => {
1155
1181
  method: "GetExternalIdForTopic_IgnoreContainerHelpsets",
1156
1182
  requestType: "GetExternalIdForTopic_IgnoreContainerHelpsetsRequest",
1157
1183
  requestFields: [field("topicID", "double", {})],
1158
- responseFields: [field("externalId", "string"), field("externalHelpsetId", "string")],
1184
+ responseFields: [field("externalId", "string", { xmlTag: "externalIdForTopic" }), field("externalHelpsetId", "string", { xmlTag: "externalIdForHelpset" }), field("metaDataForHelpset", "stringMap", { optional: true })],
1159
1185
  description: "Get external ID ignoring container helpsets"
1160
1186
  },
1161
1187
  getChildTopics: {
@@ -1192,12 +1218,15 @@ var CobriliAdapter = (() => {
1192
1218
  },
1193
1219
  isTopicVisible: {
1194
1220
  requestFields: [field("topicID", "double", {})],
1195
- responseFields: [field("isVisible", "boolean")],
1221
+ responseFields: [
1222
+ field("IsVisible_because_HasAccessRights_ForThisTopic", "boolean"),
1223
+ field("IsVisible_because_SessionMetadataMatch_ForThisTopic", "boolean")
1224
+ ],
1196
1225
  description: "Check if topic is visible"
1197
1226
  },
1198
1227
  getAllPossibleTopicsForExternalTopicID: {
1199
1228
  requestFields: [field("externalTopicID", "string", {}), field("metaData", "stringMap", {})],
1200
- responseFields: [field("topics", "array", { itemObjectType: "TopicInfo" })],
1229
+ responseFields: [field("topics", "array", { itemObjectType: "TopicInfo", xmlTag: "result" })],
1201
1230
  description: "Get all possible topics for external ID"
1202
1231
  },
1203
1232
  getRDFRelatedTopics: {
@@ -1226,7 +1255,7 @@ var CobriliAdapter = (() => {
1226
1255
  },
1227
1256
  getSynonymList: {
1228
1257
  requestFields: [field("language", "string", {})],
1229
- responseFields: [field("synonyms", "array", { itemObjectType: "SynonymEntry" })],
1258
+ responseFields: [field("synonyms", "array", { itemObjectType: "SynonymEntry", xmlTag: "synonymEntries" })],
1230
1259
  description: "Get synonym list"
1231
1260
  },
1232
1261
  // ==========================================================================
@@ -1247,7 +1276,7 @@ var CobriliAdapter = (() => {
1247
1276
  // ==========================================================================
1248
1277
  getLastCobriliErrorCode: {
1249
1278
  requestFields: [field("not_used", "boolean", {})],
1250
- responseFields: [field("errorCode", "string")],
1279
+ responseFields: [field("errorCode", "string", { xmlTag: "lastCobriliErrorCode" })],
1251
1280
  description: "Get last Cobrili error code"
1252
1281
  },
1253
1282
  getErrorLinkForErrorCode: {
@@ -1257,7 +1286,7 @@ var CobriliAdapter = (() => {
1257
1286
  },
1258
1287
  canApplicationDisplayData: {
1259
1288
  requestFields: [field("not_used", "boolean", {})],
1260
- responseFields: [field("canDisplay", "boolean")],
1289
+ responseFields: [field("canDisplay", "boolean", { xmlTag: "not_used" })],
1261
1290
  description: "Check if application can display data"
1262
1291
  },
1263
1292
  makeDatabaseUpdate: {
@@ -1271,20 +1300,20 @@ var CobriliAdapter = (() => {
1271
1300
  },
1272
1301
  clearStaticCaches: {
1273
1302
  requestFields: [field("not_used", "boolean", {})],
1274
- responseFields: [field("success", "boolean")],
1303
+ responseFields: [field("success", "boolean", { xmlTag: "operationSucceeded" })],
1275
1304
  description: "Clear static caches"
1276
1305
  },
1277
1306
  refreshStaticCaches: {
1278
1307
  requestFields: [
1279
1308
  field("secretToken", "string", {}),
1280
1309
  field("uniqueHelpsetIdentifier", "string", {}),
1281
- field("deletedHelpsetID", "double", {}),
1310
+ field("deletedHelpsetID", "double", { xmlTag: "deleted_helpsetID" }),
1282
1311
  field("deletedHelpsetExternalID", "string", {}),
1283
1312
  field("deletedHelpsetLanguage", "string", {}),
1284
- field("deletedTopicIDs", "array", { itemType: "double", keytype: "vector" }),
1285
- field("deletedNavigationIDs", "array", { itemType: "double", keytype: "vector" })
1313
+ field("deletedTopicIDs", "array", { itemType: "double", keytype: "vector", xmlTag: "deleted_topicIDs" }),
1314
+ field("deletedNavigationIDs", "array", { itemType: "double", keytype: "vector", xmlTag: "deleted_navigationIDs" })
1286
1315
  ],
1287
- responseFields: [field("success", "boolean")],
1316
+ responseFields: [field("success", "boolean", { xmlTag: "result" })],
1288
1317
  description: "Refresh static caches"
1289
1318
  },
1290
1319
  exportDataForTest: {
@@ -2298,7 +2327,6 @@ var CobriliAdapter = (() => {
2298
2327
  this.initialized = false;
2299
2328
  this.initPromise = null;
2300
2329
  this.config = { ...DEFAULT_CONFIG, ...config };
2301
- this.init();
2302
2330
  return new Proxy(this, {
2303
2331
  get: (target, prop) => {
2304
2332
  if (prop in target) {
@@ -2377,13 +2405,19 @@ var CobriliAdapter = (() => {
2377
2405
  this.initialized = true;
2378
2406
  return initData;
2379
2407
  }
2380
- async ensureInitialized() {
2408
+ /**
2409
+ * Check if the client has been initialized.
2410
+ */
2411
+ isInitialized() {
2412
+ return this.initialized;
2413
+ }
2414
+ assertInitialized() {
2381
2415
  if (!this.initialized) {
2382
- await this.init();
2416
+ throw new Error("CobriliClient not initialized. Call init() before making API calls.");
2383
2417
  }
2384
2418
  }
2385
2419
  async call(methodName, params) {
2386
- await this.ensureInitialized();
2420
+ this.assertInitialized();
2387
2421
  const methodDef = API_METHODS[methodName];
2388
2422
  if (!methodDef) {
2389
2423
  return {
@@ -2402,7 +2436,7 @@ var CobriliAdapter = (() => {
2402
2436
  methodName: apiMethod,
2403
2437
  requestData: xmlRequest
2404
2438
  });
2405
- const response = await this.sendHttpRequest(apiMethod, jsonPayload);
2439
+ const response = await this.sendHttpRequest(jsonPayload);
2406
2440
  try {
2407
2441
  const xmlNode = parseXml(response);
2408
2442
  if (isExceptionResponse(xmlNode)) {
@@ -2436,11 +2470,11 @@ var CobriliAdapter = (() => {
2436
2470
  };
2437
2471
  }
2438
2472
  }
2439
- async sendHttpRequest(method, body) {
2473
+ async sendHttpRequest(body) {
2440
2474
  const controller = new AbortController();
2441
2475
  const timeoutId = setTimeout(() => controller.abort(), this.config.timeout);
2442
2476
  try {
2443
- const response = await fetch(`${this.config.baseUrl}${this.config.endpoint}?method=${method}`, {
2477
+ const response = await fetch(`${this.config.baseUrl}${this.config.endpoint}`, {
2444
2478
  method: "POST",
2445
2479
  headers: {
2446
2480
  "Content-Type": "application/json",