@open-xchange/soap-client 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [0.1.2] - 2026-04-21
+
+### Added
+
+- `convertUserToSharedAccount` to convert an existing user to a shared account
+
 ## [0.1.0] - 2026-03-15
 
 ### Changed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/soap-client",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "SOAP client for OX App Suite",
   "main": "index.js",
   "type": "module",
@@ -21,7 +21,7 @@
   "license": "AGPL-3.0-or-later",
   "dependencies": {
     "commander": "^14.0.3",
-    "p-retry": "^7.1.1",
+    "p-retry": "^8.0.0",
     "soap": "^1.8.0"
   },
   "devDependencies": {

package/services/sharedAccount.js

@@ -42,28 +42,47 @@ export async function create (context, sharedAccountData) {
   })
 }
 
+/**
+ * Converts an existing user to a shared account using the OX Shared Account Service
+ *
+ * @param {Object} context - The context of the user to be converted
+ * @param {number} userId - ID of the user to be converted
+ * @param {string} password - The password for the new shared account
+ * @returns {Promise<void>}
+ * @throws {Error} If the conversion fails
+ */
+export async function convertUserToSharedAccount (context, userId, password) {
+  return (await getClient()).convertUserToSharedAccountAsync({
+    ctx: { id: context.id },
+    user: { id: userId },
+    password,
+    auth: context.auth
+  })
+}
+
 /**
  * Add users and groups with specified permissions and capabilities to an existing shared account using the OX Shared Account Service.
  *
  * @param {Object} context - The context of the users and groups
  * @param {Object} sharedAccountContext - The context of the shared account
- * @param {Object} sharedAccountData - The shared account
- * @param {Object} mailConfig - The mail configuration (permissionLevel, grantedCapability, deniedCapability)
- * @param {Object} calendarConfig - The calendar configuration (permissionLevel, grantedCapability, deniedCapability)
- * @param {Object[]} users - The users to be added to the shared account
- * @param {Object[]} groups - The groups to be added to the shared account
+ * @param {number} sharedAccountId - ID of the shared account
+ * @param {Object} permissions - The users, groups, capabilities, and module-specific permissions.
  * @returns {Promise<Object>} The shared account object
  * @throws {Error} If the creation of the shared account permissions fails
  */
-export async function createSharedAccountPermissions (context, sharedAccountContext, sharedAccountData, mailConfig, calendarConfig, users = [], groups = []) {
+export async function createSharedAccountPermissions (context, sharedAccountContext, sharedAccountId, permissions) {
   return (await getClient()).createSharedAccountPermissionsAsync({
     ctx: { id: context.id },
-    groups,
-    users: users.map(user => { return { id: user.userdata.id } }),
-    mailConfig,
-    calendarConfig,
     sharedAccountCtx: { id: sharedAccountContext.id },
-    sharedAccount: { id: sharedAccountData.id },
+    sharedAccount: { id: sharedAccountId },
+    groups: permissions.groups ?? [],
+    users: permissions.users?.map(user => ({ id: user.userdata.id })) ?? [],
+    capabilities: {
+      grantedCapability: permissions.capabilities?.grantedCapability ?? [],
+      deniedCapability: permissions.capabilities?.deniedCapability ?? [],
+    },
+    mailConfig: permissions.mailConfig,
+    calendarConfig: permissions.calendarConfig,
     auth: context.admin
   })
 }
@@ -87,13 +106,13 @@ export async function list (context, pattern = '*') {
  * Get all data of a specified shared account in the specified context
  *
  * @param {*} context - The context where the shared account exists
- * @param {*} sharedAccountData - The requested shared account
+ * @param {number} sharedAccountId - ID of the requested shared account
  * @returns {Promise<Object>} The shared account object
  */
-export async function getData (context, sharedAccountData) {
+export async function getData (context, sharedAccountId) {
   return (await getClient()).getDataAsync({
     ctx: { id: context.id },
-    sharedAccount: { id: sharedAccountData.id },
+    sharedAccount: { id: sharedAccountId },
     auth: context.admin
   })
 }
@@ -102,13 +121,13 @@ export async function getData (context, sharedAccountData) {
  * Remove a specified shared account in the specified context
  *
  * @param {*} context - The context object where the account will be removed
- * @param {*} sharedAccountData - The shared account to be removed
+ * @param {number} sharedAccountId - ID of the shared account to be removed
  * @returns {Promise<void>}
  */
-export async function remove (context, sharedAccountData) {
+export async function remove (context, sharedAccountId) {
   return (await getClient()).deleteAsync({
     ctx: { id: context.id },
-    sharedAccount: { id: sharedAccountData.id },
+    sharedAccount: { id: sharedAccountId },
     auth: context.admin
   })
 }