@open-xchange/soap-client 0.0.10 → 0.0.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/soap-client",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "description": "SOAP client for OX App Suite",
   "main": "index.js",
   "type": "module",

package/services/common/context.js

@@ -20,14 +20,18 @@
 
 import { createClientAsync, logSoapError } from '../../soap.js'
 
-const OXContextService = createClientAsync('OXContextService')
+let OXContextService
+function getClient () {
+  if (!OXContextService) OXContextService = createClientAsync('OXContextService')
+  return OXContextService
+}
 
 /**
  * This function retrieves the default context from the OXContextService.
  * @returns {Promise<Object>} The first result from the listAsync method call.
  */
 export async function getDefault () {
-  return (await OXContextService).listAsync({ search_pattern: 'defaultcontext' })[0]
+  return (await getClient()).listAsync({ search_pattern: 'defaultcontext' })[0]
 }
 
 /**
@@ -36,7 +40,7 @@ export async function getDefault () {
  * @param {number} id The ID of the context to remove.
  */
 export async function remove (id) {
-  return (await OXContextService).deleteAsync({ ctx: { id } })
+  return (await getClient()).deleteAsync({ ctx: { id } })
 }
 
 /**
@@ -59,7 +63,7 @@ export async function remove (id) {
  * @returns {Promise<Object>} The created context.
  */
 export async function create (ctx = {}, adminUser = {}, accessCombinationName = 'all') {
-  return (await OXContextService)
+  return (await getClient())
     .createAsync({
       ctx,
       admin_user: Object.assign({
@@ -91,7 +95,7 @@ export async function create (ctx = {}, adminUser = {}, accessCombinationName =
 // eslint-disable-next-line camelcase
 export async function changeModuleAccessByName (id, access_combination_name) {
   // eslint-disable-next-line camelcase
-  return (await OXContextService).changeModuleAccessByNameAsync({ ctx: { id }, access_combination_name })
+  return (await getClient()).changeModuleAccessByNameAsync({ ctx: { id }, access_combination_name })
 }
 
 /**
@@ -105,7 +109,7 @@ export async function changeCapabilities (id, capsToAdd, capsToRemove) {
   const data = {}
   if (capsToAdd) data.capsToAdd = capsToAdd
   if (capsToRemove) data.capsToRemove = capsToRemove
-  return (await OXContextService).changeCapabilitiesAsync({ ctx: { id }, ...data })
+  return (await getClient()).changeCapabilitiesAsync({ ctx: { id }, ...data })
 }
 
 /**
@@ -114,7 +118,7 @@ export async function changeCapabilities (id, capsToAdd, capsToRemove) {
  * @returns {Promise<Object>} The module access of the specified context.
  */
 export async function getModuleAccess (id) {
-  return (await OXContextService).getModuleAccessAsync({ ctx: { id } })
+  return (await getClient()).getModuleAccessAsync({ ctx: { id } })
 }
 /**
  * This function changes the module access of the specified context.
@@ -124,7 +128,7 @@ export async function getModuleAccess (id) {
  */
 export async function changeModuleAccess (id, moduleAccess) {
   const currentAccess = await getModuleAccess(id)
-  return (await OXContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...moduleAccess } })
+  return (await getClient()).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...moduleAccess } })
 }
 
 /**
@@ -135,7 +139,7 @@ export async function changeModuleAccess (id, moduleAccess) {
  * @returns {Promise<Array<Object>>} The list of contexts that match the search pattern.
  */
 export async function list (searchPattern, { excludeDisabled } = { excludeDisabled: true }) {
-  return (await OXContextService).listAsync({ search_pattern: searchPattern, exclude_disabled: excludeDisabled }).catch(e => {
+  return (await getClient()).listAsync({ search_pattern: searchPattern, exclude_disabled: excludeDisabled }).catch(e => {
     logSoapError(e)
     return []
   })
@@ -147,7 +151,7 @@ export async function list (searchPattern, { excludeDisabled } = { excludeDisabl
  * @returns {Promise<Object>} The context with the specified ID.
  */
 export async function get (id) {
-  return (await OXContextService).getDataAsync({ ctx: { id } })
+  return (await getClient()).getDataAsync({ ctx: { id } })
 }
 
 /**
@@ -156,5 +160,5 @@ export async function get (id) {
  * @returns {Promise<void>}
  */
 export async function change (ctx) {
-  return (await OXContextService).changeAsync({ ctx })
+  return (await getClient()).changeAsync({ ctx })
 }

package/services/common/index.js

@@ -2,10 +2,12 @@ import * as contextService from './context.js'
 import * as userService from './user.js'
 import { getFilestorageId } from './util.js'
 import * as secondaryAccountService from '../secondaryAccount.js'
+import * as sharedAccountService from '../sharedAccount.js'
 
 export {
   contextService,
   userService,
   secondaryAccountService,
+  sharedAccountService,
   getFilestorageId
 }

package/services/common/user.js

@@ -20,7 +20,11 @@
 
 import { createClientAsync, logSoapError } from '../../soap.js'
 
-const OXUserService = createClientAsync('OXUserService')
+let OXUserService
+function getClient () {
+  if (!OXUserService) OXUserService = createClientAsync('OXUserService')
+  return OXUserService
+}
 
 /**
  * This function removes the user with the specified context and user ID.
@@ -29,7 +33,7 @@ const OXUserService = createClientAsync('OXUserService')
  * @returns {Promise<Boolean>} Returns true if it could remove the user and false if it could not
  */
 export async function remove (context, userId) {
-  return (await OXUserService).deleteAsync({
+  return (await getClient()).deleteAsync({
     ctx: { id: context.id },
     user: { id: userId },
     auth: context.admin
@@ -43,7 +47,7 @@ export async function remove (context, userId) {
  * @returns {Promise<Object>} The created user.
  */
 export async function create (context, usrdata) {
-  return (await OXUserService).createAsync({
+  return (await getClient()).createAsync({
     ctx: { id: context.id },
     usrdata,
     auth: context.admin
@@ -57,7 +61,7 @@ export async function create (context, usrdata) {
  * @returns {Promise<void>}
  */
 export async function change (context, usrdata) {
-  return (await OXUserService).changeAsync({
+  return (await getClient()).changeAsync({
     ctx: { id: context.id },
     usrdata,
     auth: context.admin
@@ -65,7 +69,7 @@ export async function change (context, usrdata) {
 }
 
 export async function changeByModuleAccess (context, userId, currentAccess, moduleAccess) {
-  return (await OXUserService).changeByModuleAccessAsync({
+  return (await getClient()).changeByModuleAccessAsync({
     ctx: { id: context.id },
     moduleAccess: Object.assign({}, currentAccess, moduleAccess),
     user: { id: userId },
@@ -74,7 +78,7 @@ export async function changeByModuleAccess (context, userId, currentAccess, modu
 }
 
 export async function changeByModuleAccessName (context, userId, accessCombinationName) {
-  return (await OXUserService).changeByModuleAccessNameAsync({
+  return (await getClient()).changeByModuleAccessNameAsync({
     ctx: { id: context.id },
     access_combination_name: accessCombinationName,
     user: { id: userId },
@@ -83,7 +87,7 @@ export async function changeByModuleAccessName (context, userId, accessCombinati
 }
 
 export async function getModuleAccess (context, userId) {
-  return (await OXUserService).getModuleAccessAsync({
+  return (await getClient()).getModuleAccessAsync({
     ctx: { id: context.id },
     user: { id: userId },
     auth: context.admin
@@ -100,11 +104,11 @@ export async function changeCapabilities (context, userId, capsToAdd, capsToRemo
   }
   if (capsToAdd) data.capsToAdd = capsToAdd
   if (capsToRemove) data.capsToRemove = capsToRemove
-  return (await OXUserService).changeCapabilitiesAsync(data)
+  return (await getClient()).changeCapabilitiesAsync(data)
 }
 
 export async function exists (context, userId) {
-  return (await OXUserService).existsAsync({
+  return (await getClient()).existsAsync({
     ctx: { id: context.id },
     user: { id: userId },
     auth: context.admin
@@ -112,7 +116,7 @@ export async function exists (context, userId) {
 }
 
 export async function list (context, searchPattern, includeGuests = false) {
-  return (await OXUserService).listAsync({
+  return (await getClient()).listAsync({
     ctx: { id: context.id },
     search_pattern: searchPattern,
     include_guests: includeGuests,
@@ -121,7 +125,7 @@ export async function list (context, searchPattern, includeGuests = false) {
 }
 
 export async function listAll (context, includeGuests = false, excludeUsers = []) {
-  return (await OXUserService).listAsync({
+  return (await getClient()).listAsync({
     ctx: { id: context.id },
     include_guests: includeGuests,
     exclude_users: excludeUsers,

package/services/reseller/oxaas.js

@@ -20,12 +20,16 @@
 
 import { createClientAsync } from '../../soap.js'
 
-const OXaaSService = createClientAsync('OXaaSService').then(client => client)
+let OXaaSService
+function getClient () {
+  if (!OXaaSService) OXaaSService = createClientAsync('OXaaSService')
+  return OXaaSService
+}
 
 export async function setMailQuota (data) {
-  return (await OXaaSService).setMailQuotaAsync(data)
+  return (await getClient()).setMailQuotaAsync(data)
 }
 
 export async function createSharedDomain (data) {
-  return (await OXaaSService).createSharedDomain(data)
+  return (await getClient()).createSharedDomain(data)
 }

package/services/reseller/resellerContext.js

@@ -20,36 +20,40 @@
 
 import { createClientAsync, logSoapError } from '../../soap.js'
 
-const OXResellerContextService = createClientAsync('OXResellerContextService')
+let OXResellerContextService
+function getClient () {
+  if (!OXResellerContextService) OXResellerContextService = createClientAsync('OXResellerContextService')
+  return OXResellerContextService
+}
 
 export async function create (data) {
-  return (await OXResellerContextService).createAsync(data)
+  return (await getClient()).createAsync(data)
 }
 
 export async function remove (contextId) {
-  return (await OXResellerContextService).deleteAsync({
+  return (await getClient()).deleteAsync({
     ctx: { id: contextId }
   }).catch(logSoapError)
 }
 
 export async function change (ctx) {
-  return (await OXResellerContextService).changeAsync({ ctx })
+  return (await getClient()).changeAsync({ ctx })
 }
 
 export async function get (id) {
-  return (await OXResellerContextService).getDataAsync({ ctx: { id } })
+  return (await getClient()).getDataAsync({ ctx: { id } })
 }
 
 export async function getModuleAccess (id) {
-  return (await OXResellerContextService).getModuleAccessAsync({ ctx: id })
+  return (await getClient()).getModuleAccessAsync({ ctx: id })
 }
 
 export async function changeModuleAccess (id, access) {
   const currentAccess = await getModuleAccess(id)
 
-  return (await OXResellerContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...access } })
+  return (await getClient()).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...access } })
 }
 
 export async function listAll (data) {
-  return (await OXResellerContextService).listAllAsync(data)
+  return (await getClient()).listAllAsync(data)
 }

package/services/reseller/resellerUser.js

@@ -20,10 +20,14 @@
 
 import { createClientAsync, logSoapError } from '../../soap.js'
 
-const OXResellerUserService = createClientAsync('OXResellerUserService').then(client => client)
+let OXResellerUserService
+function getClient () {
+  if (!OXResellerUserService) OXResellerUserService = createClientAsync('OXResellerUserService')
+  return OXResellerUserService
+}
 
 export async function remove (contextId, userId) {
-  return (await OXResellerUserService).deleteAsync({
+  return (await getClient()).deleteAsync({
     ctx: { id: contextId },
     user: { id: userId }
   }).catch(logSoapError)
@@ -36,7 +40,7 @@ export async function remove (contextId, userId) {
  * @returns {Promise<void>}
  */
 export async function change (context, usrdata) {
-  return (await OXResellerUserService).changeAsync({
+  return (await getClient()).changeAsync({
     ctx: { id: context.id },
     usrdata,
     auth: { login: context.admin.name, password: context.admin.password }
@@ -44,11 +48,11 @@ export async function change (context, usrdata) {
 }
 
 export async function get (data) {
-  return (await OXResellerUserService).getDataAsync(data)
+  return (await getClient()).getDataAsync(data)
 }
 
 export async function getModuleAccess (context, userId) {
-  return (await OXResellerUserService).getModuleAccessAsync({
+  return (await getClient()).getModuleAccessAsync({
     ctx: { id: context.id },
     user: { id: userId },
     auth: { login: context.admin.name, password: context.admin.password }
@@ -58,7 +62,7 @@ export async function getModuleAccess (context, userId) {
 }
 
 export async function changeByModuleAccess (context, userId, currentAccess, moduleAccess) {
-  return (await OXResellerUserService).changeByModuleAccessAsync({
+  return (await getClient()).changeByModuleAccessAsync({
     ctx: { id: context.id },
     moduleAccess: Object.assign({}, currentAccess, moduleAccess),
     user: { id: userId },
@@ -67,7 +71,7 @@ export async function changeByModuleAccess (context, userId, currentAccess, modu
 }
 
 export async function changeByModuleAccessName (context, userId, accessCombinationName) {
-  return (await OXResellerUserService).changeByModuleAccessNameAsync({
+  return (await getClient()).changeByModuleAccessNameAsync({
     ctx: { id: context.id },
     access_combination_name: accessCombinationName,
     user: { id: userId },
@@ -76,7 +80,7 @@ export async function changeByModuleAccessName (context, userId, accessCombinati
 }
 
 export async function createByModuleAccessName (context, usrdata) {
-  return (await OXResellerUserService).createByModuleAccessNameAsync({
+  return (await getClient()).createByModuleAccessNameAsync({
     ctx: { id: context.id },
     usrdata,
     access_combination_name: 'all',
@@ -85,5 +89,5 @@ export async function createByModuleAccessName (context, usrdata) {
 }
 
 export async function listAll (data) {
-  return await (await OXResellerUserService).listAllAsync(data)
+  return await (await getClient()).listAllAsync(data)
 }

package/services/secondaryAccount.js

@@ -1,6 +1,10 @@
 import { createClientAsync } from '../soap.js'
 
-const OXSecondaryAccountService = createClientAsync('OXSecondaryAccountService')
+let OXSecondaryAccountService
+function getClient () {
+  if (!OXSecondaryAccountService) OXSecondaryAccountService = createClientAsync('OXSecondaryAccountService')
+  return OXSecondaryAccountService
+}
 
 /**
  * Creates a secondary account using the OX Secondary Account Service
@@ -13,7 +17,7 @@ const OXSecondaryAccountService = createClientAsync('OXSecondaryAccountService')
  * @throws {Error} If the account creation fails
  */
 export async function create (accountData, context, users = [], groups = []) {
-  return (await OXSecondaryAccountService).createAsync({
+  return (await getClient()).createAsync({
     accountDataOnCreate: accountData,
     context: { id: context.id },
     users: users || [],
@@ -22,13 +26,13 @@ export async function create (accountData, context, users = [], groups = []) {
 }
 
 export async function list (context) {
-  return (await OXSecondaryAccountService).listAsync({
+  return (await getClient()).listAsync({
     context: { id: context.id },
     auth: context.admin
   })
 }
 export async function remove (primaryAddress, context, users, groups) {
-  return (await OXSecondaryAccountService).deleteAsync({
+  return (await getClient()).deleteAsync({
     primaryAddress,
     context: { id: context.id },
     users,
@@ -37,7 +41,7 @@ export async function remove (primaryAddress, context, users, groups) {
 }
 
 export async function update (primaryAddress, accountData, context, users, groups) {
-  return (await OXSecondaryAccountService).updateAsync({
+  return (await getClient()).updateAsync({
     primaryAddress,
     accountDataUpdate: accountData,
     context: { id: context.id },

package/services/sharedAccount.js

@@ -0,0 +1,114 @@
+/**
+ * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
+ *
+ * Any use of the work other than as authorized under this license or copyright law is prohibited.
+ */
+
+import { createClientAsync } from '../soap.js'
+
+let OXSharedAccountService
+function getClient () {
+  if (!OXSharedAccountService) OXSharedAccountService = createClientAsync('OXSharedAccountService')
+  return OXSharedAccountService
+}
+
+/**
+ * Creates a shared account using the OX Shared Account Service
+ *
+ * @param {Object} context - The context object where the account will be created
+ * @param {Object} sharedAccountData - The data for the shared account to be created
+ * @returns {Promise<Object>} The created shared account object
+ * @throws {Error} If the shared account creation fails
+ */
+export async function create (context, sharedAccountData) {
+  return (await getClient()).createAsync({
+    ctx: { id: context.id },
+    sharedAccountData,  // display_name, given_name, imapServer, language, mailenabled, name, sur_name, primaryEmail, email1, smtpServer, timezone, password
+    auth: context.admin
+  })
+}
+
+/**
+ * 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
+ * @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 = []) {
+  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 },
+    auth: context.admin
+  })
+}
+
+/**
+ * List all shared accounts in the specified context
+ *
+ * @param {Object} context - The context object whose shared account will be listed
+ * @param {*} pattern - An optional search pattern for the contexts
+ * @returns {Promise<Object[]>} The list of shared account objects
+ */
+export async function list (context, pattern = '*') {
+  return (await getClient()).listAsync({
+    ctx: { id: context.id },
+    search_pattern: pattern,
+    auth: context.admin
+  })
+}
+
+/**
+ * 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
+ * @returns {Promise<Object>} The shared account object
+ */
+export async function getData (context, sharedAccountData) {
+  return (await getClient()).getDataAsync({
+    ctx: { id: context.id },
+    sharedAccount: { id: sharedAccountData.id },
+    auth: context.admin
+  })
+}
+
+/**
+ * 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
+ * @returns {Promise<void>}
+ */
+export async function remove (context, sharedAccountData) {
+  return (await getClient()).deleteAsync({
+    ctx: { id: context.id },
+    sharedAccount: { id: sharedAccountData.id },
+    auth: context.admin
+  })
+}