cobrili-client 1.0.13 → 1.0.14

package/README.md

@@ -181,7 +181,20 @@ if (result.error) {
 
 ## API Methods
 
-The client provides 130+ auto-generated API methods. Use `API_METHODS` to explore all available methods:
+The client provides **163 auto-generated API methods**. See [API_COMPLETE_REFERENCE.md](./docs/API_COMPLETE_REFERENCE.md) for the full list.
+
+### Key Method Categories
+
+| Category | Examples |
+|----------|----------|
+| **Session** | `init()`, `login()`, `logout()` |
+| **Helpsets** | `switchMasterHelpSet()`, `getAllHelpsets()`, `loadActiveHelpset()` |
+| **Navigation** | `getNavigation()`, `getBreadCrumb()`, `navigateToTopic()` |
+| **Content** | `getContent()`, `getTopicInfo()`, `getTopicForExternalId()` |
+| **Metadata** | `getPossibleMetaValues()`, `setCurrentMetaDataSetForSession()` |
+| **Search** | `startSearch()`, `getSearchResults()`, `getSuggestionsForSearchInput()` |
+| **Bookmarks** | `addBookmark()`, `deleteBookmark()`, `getBookmarkList()` |
+| **Users** | `createUser()`, `modifyUser()`, `getAllUsers()` |
 
 ```typescript
 import { API_METHODS } from 'cobrili-client'
@@ -190,100 +203,6 @@ import { API_METHODS } from 'cobrili-client'
 console.log(Object.keys(API_METHODS))
 ```
 
-### Session & Authentication
-
-- `init()` - Initialize session (required first)
-- `isInitialized()` - Check if session is active
-- `login({ loginUser })` - Login with credentials
-- `logout({})` - Logout
-- `getLoggedInUserInfo({})` - Get current user info
-- `changePassword({ oldPassword, newPassword })` - Change password
-
-### Master Helpset
-
-- `switchMasterHelpSet({ masterHelpSetApplicationIdentifier, initActiveHelpset })` - Activate master
-- `getAllHelpsets({ masterHelpSetApplicationIdentifier, withMetadata })` - Get all helpsets
-- `getHelpsetInfosExtended({ masterHelpSetApplicationIdentifier, withMetadata, metaData })` - Get helpsets with filtering
-- `getAllowedMetaKeysForMasterhelpset({ masterHelpSetApplicationIdentifier })` - Get metadata keys
-- `checkMasterHelpsetID({ masterHelpSetID })` - Validate master helpset ID
-
-### Helpset
-
-- `loadActiveHelpset({ helpsetID })` - Load a helpset
-- `getHelpsetInfoForActiveHelpset({})` - Get active helpset info
-- `getHomeTopicId({ helpsetID })` - Get home topic ID
-- `getHomeTopicExternalId({ helpsetID })` - Get home topic external ID
-- `getHelpsetInfoForTopic({ topicID })` - Get helpset info for a topic
-- `isValidHelpsetID({ helpsetID })` - Validate helpset ID
-
-### Navigation
-
-- `getNavigationWithMetaData({ currentNavigationID, wantedMetaKeys, useHelpsetMetadataFallback })` - Get navigation tree with metadata
-- `getNavigation({ currentNavigationID })` - Get navigation tree
-- `navigateToTopic({ topicID, navigationID })` - Navigate to topic
-- `getBreadCrumb({ navigationID })` - Get breadcrumb path
-- `getBreadCrumbWithMetaData({ navigationID, wantedMetaKeys })` - Get breadcrumb with metadata
-- `getRawNavigationEntriesForHelpset({ helpsetID })` - Get raw navigation entries
-
-### Content
-
-- `getContent({ topicID })` - Get topic content (base64-encoded HTML)
-- `getTopicForExternalId({ externalIdForTopic, externalIdForHelpset })` - Find topic by external ID
-- `getMetaValuesForTopics({ externalTopicIDs, wantedMetaKeys })` - Get metadata for topics
-- `getTopicInfo({ topicID })` - Get topic information
-- `getTitleForTopic({ topicID })` - Get topic title
-- `isValidTopicID({ topicID })` - Validate topic ID
-- `isTopicVisible({ topicID })` - Check topic visibility
-- `getChildTopics({ topicID })` - Get child topics
-- `getRelatedTopics({ topicID })` - Get related topics
-- `getExternalIdForTopic({ topicID })` - Get external ID for topic
-
-### Metadata
-
-- `getPossibleMetaValues({ metaKey })` - Get possible values for a meta key
-- `getMetaValueForTopic({ metaKey, topicID })` - Get meta value for topic
-- `getAllMetaValuesForTopic({ topicID, wantedMetaKeys })` - Get all metadata for topic
-- `getUsedMetaValues({ metaKey })` - Get used meta values
-- `setCurrentMetaDataSetForSession({ metaData })` - Set session metadata filter
-- `getCurrentMetaDataSetForSession({})` - Get current session metadata
-- `addToCurrentMetaDataSetForSession({ metaDataToAdd })` - Add to session metadata
-- `removeFromCurrentMetaDataSetForSession({ metaDataToRemove })` - Remove from session metadata
-
-### Search
-
-- `startSearch({ searchString })` - Start a search
-- `startExtendedSearch({ searchRequest })` - Start search with advanced options
-- `getSearchResults({ searchID })` - Get search results
-- `getSearchResultsExtended({ searchID, sortCriteria })` - Get sorted search results
-- `getSuggestionsForSearchInput({ searchString })` - Get search suggestions
-- `getSearchSettings({})` - Get search configuration
-
-### History & Bookmarks
-
-- `historyBack({ steps })` / `historyForward({ steps })` - Navigate history
-- `getHistoryList({})` - Get history list
-- `getBookmarkList({})` - Get bookmarks
-- `addBookmark({ topicID, navigationID, title })` - Add bookmark
-- `deleteBookmark({ bookmarkID })` - Delete bookmark
-- `isInBookmarks({ topicID })` - Check if topic is bookmarked
-
-### User Management
-
-- `createUser({ user, groupIDs })` - Create user
-- `modifyUser({ user })` - Modify user
-- `deleteUser({ userID })` - Delete user
-- `getAllUsers({})` - Get all users
-- `createGroup({ group })` - Create group
-- `getAllGroups({})` - Get all groups
-
-### System
-
-- `getCurrentCobriliVersion({})` - Get version
-- `getConfigurationData({})` - Get configuration
-- `clearStaticCaches({})` - Clear caches
-- `refreshStaticCaches({})` - Refresh caches
-- `getResourceStrings({ resourceKeys })` - Get localization strings
-
 ## CommonJS
 
 ```javascript
@@ -293,6 +212,13 @@ const client = createCobriliClient({ baseUrl: 'https://your-server.com' })
 await client.init()
 ```
 
+## Documentation
+
+For detailed documentation, see the [docs](./docs/) folder:
+
+- **[COBRILI_CONCEPTS.md](./docs/COBRILI_CONCEPTS.md)** - Core concepts (MasterHelpset, Helpset, Topic, Navigation, Metadata), typical workflows, and architecture overview
+- **[API_COMPLETE_REFERENCE.md](./docs/API_COMPLETE_REFERENCE.md)** - Complete API reference with all 163 methods, parameters, and XML definitions
+
 ## Links
 
 - [Cobrili™ Product Page](https://acolada.de/produkte/cobrili-2/) - Acolada GmbH

package/dist/index.browser.js

@@ -231,6 +231,22 @@ var CobriliAdapter = (() => {
       category: "Helpsets",
       description: "Get all helpsets for a master helpset"
     },
+    getAllHelpsets_WithoutCheckingAccessRights: {
+      method: "GetAllHelpsets_WithoutCheckingAccessRights",
+      requestType: "GetAllHelpsetsRequest",
+      requestFields: [
+        field("masterHelpSetApplicationIdentifier", "string", {}),
+        field("withMetadata", "boolean", { xmlTag: "with_metadata" })
+      ],
+      responseFields: [
+        field("helpsetInfos", "array", {
+          itemObjectType: "HelpsetInfo",
+          xmlTag: "helpsetInfos"
+        })
+      ],
+      category: "Helpsets",
+      description: "Get all helpsets for a master helpset without checking access rights"
+    },
     getHelpsetInfoForTopic: {
       requestFields: [field("topicID", "double", {})],
       responseFields: [field("helpsetInfo", "object", { objectType: "HelpsetInfo" })],
@@ -966,7 +982,7 @@ var CobriliAdapter = (() => {
         field("pageType", "string", {}),
         field("searchHistoryEntry", "object", {
           optional: true,
-          objectType: "SearchHistoryEntry"
+          objectType: "SearchHistoryEntryExtended"
         })
       ],
       responseFields: [field("success", "boolean")],
@@ -1309,10 +1325,13 @@ var CobriliAdapter = (() => {
       description: "Add to current metadata set for session"
     },
     removeFromCurrentMetaDataSetForSession: {
-      requestFields: [field("metaKey", "string", {}), field("metaValue", "string", {})],
+      requestFields: [
+        field("metaKey", "string", {}),
+        field("metaValue", "string", { optional: true })
+      ],
       responseFields: [field("success", "boolean", { xmlTag: "not_used" })],
       category: "Metadata Extended",
-      description: "Remove from current metadata set for session"
+      description: "Remove from current metadata set for session. If metaValue is not provided, the entire metaKey is removed."
     },
     getMetaKeysWhichAreConfiguredForContentFiltering: {
       requestFields: [field("not_used", "boolean", {})],
@@ -1739,7 +1758,13 @@ var CobriliAdapter = (() => {
     },
     getRawNavigationEntriesForHelpset: {
       requestFields: [field("helpsetID", "double", {})],
-      responseFields: [field("entries", "array", { itemObjectType: "RawNavigationEntry" })],
+      responseFields: [
+        field("entries", "array", {
+          itemObjectType: "RawNavigationEntry",
+          xmlTag: "NavigationEntry",
+          varname: "entries"
+        })
+      ],
       description: "Get raw navigation entries for helpset"
     },
     getDatabaseIDsForCobriliLink: {
@@ -2173,9 +2198,24 @@ var CobriliAdapter = (() => {
     RawNavigationEntry: [
       field("navigationID", "double", {}),
       field("topicID", "double", {}),
-      field("parentNavigationID", "double", {}),
+      field("helpsetID", "double", {}),
       field("title", "string", {}),
-      field("sortOrder", "int", {})
+      field("hasChildren", "boolean", {}),
+      field("isPlaceHolderForContainedHelpset", "boolean", {}),
+      field("isMetaDataDrivenNavigationEntry", "boolean", {}),
+      field("children", "object", {
+        objectType: "RawNavigationEntryList",
+        xmlTag: "NavigationEntryList",
+        varname: "children",
+        optional: true
+      })
+    ],
+    RawNavigationEntryList: [
+      field("entries", "array", {
+        itemObjectType: "RawNavigationEntry",
+        xmlTag: "NavigationEntry",
+        varname: "entries"
+      })
     ],
     ChildTopicBasedOnMetadata: [
       field("topicID", "double", {}),
@@ -2226,10 +2266,7 @@ var CobriliAdapter = (() => {
       field("navigationID", "double", {}),
       field("title", "string", {})
     ],
-    SearchQueryMetaData: [
-      field("metaKey", "string", {}),
-      field("metaValue", "string", {})
-    ],
+    SearchQueryMetaData: [field("metaKey", "string", {}), field("metaValue", "string", {})],
     SearchQueryParameters: [
       field("metaData", "array", { itemObjectType: "SearchQueryMetaData", optional: true })
     ],
@@ -2237,6 +2274,20 @@ var CobriliAdapter = (() => {
       field("searchID", "double", {}),
       field("hitRangeBegin", "int", {}),
       field("hitRangeEnd", "int", {})
+    ],
+    SearchHistoryEntryExtended: [
+      field("searchID", "double", {}),
+      field("hitRangeBegin", "int", {}),
+      field("hitRangeEnd", "int", {}),
+      field("searchID_Video", "double", {}),
+      field("hitRangeBegin_Video", "int", {}),
+      field("hitRangeEnd_Video", "int", {}),
+      field("showVideoTopics", "boolean", {}),
+      field("showStandardTopics", "boolean", {}),
+      field("possible_SearchRestrictions", "array", {
+        itemObjectType: "PossibleSearchRestrictionEntry",
+        optional: true
+      })
     ]
   };