@zimbra/api-client 89.0.0 → 91.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zimbra/api-client",
   "amdName": "zmApiJsClient",
-  "version": "89.0.0",
+  "version": "91.0.0",
   "description": "Zimbra JS API Client and GraphQL client for making requests against the Zimbra SOAP API.",
   "main": "dist/zm-api-js-client.js",
   "source": "index.ts",
@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "@apollo/client": "3.4.16",
-    "@graphql-tools/schema": "^9.0.17",
+    "@graphql-tools/schema": "^10.0.3",
     "dataloader": "^2.2.2",
     "graphql": "^15.8.0",
     "lodash": "^4.17.21",

package/src/apollo/types.ts

@@ -5,3 +5,12 @@ export interface LocalBatchLinkOptions extends BatchLink.Options {
 	context?: any;
 	schema: GraphQLSchema;
 }
+
+export interface EmailAddress {
+	__typename?: 'EmailAddress';
+	address?: string;
+	displayName?: string;
+	isGroup?: boolean | null;
+	name?: string;
+	type?: string;
+}

package/src/apollo/zimbra-in-memory-cache.ts

@@ -1,5 +1,8 @@
 import { defaultDataIdFromObject, InMemoryCache, InMemoryCacheConfig } from '@apollo/client/core';
 import get from 'lodash/get';
+import isEqual from 'lodash/isEqual';
+import uniqWith from 'lodash/uniqWith';
+import { EmailAddress } from './types';
 
 const dataIdFromPath = (result: any, path: string) => {
 	if (result.__typename) {
@@ -93,10 +96,9 @@ const typePolicies = {
 	MessageInfo: {
 		fields: {
 			emailAddresses: {
-				// @TODO ideally we should write proper merge function here,
-				// but as our app is already handling at caller level
-				// we are just overwriting cache data here
-				merge: false
+				merge(existing: EmailAddress[], incoming: EmailAddress[]) {
+					return uniqWith([...(existing || []), ...(incoming || [])], isEqual);
+				}
 			}
 		}
 	}

package/src/batch-client/index.ts

@@ -22,6 +22,7 @@ import {
 	CreateMountpointRequest,
 	CreateSignatureRequest,
 	DiscoverRightsResponse,
+	DLActionEntity,
 	DlGroupMember,
 	DocumentActionData,
 	Filter,
@@ -67,6 +68,7 @@ import {
 	CreateTagInput,
 	DeleteAppointmentInput,
 	DeleteIdentityInput,
+	DistributionListActionInput,
 	EnableTwoFactorAuthInput,
 	ExternalAccountAddInput,
 	ExternalAccountImportInput,
@@ -87,6 +89,7 @@ import {
 	SaveSMimeCertInputUpload,
 	SearchFolderInput,
 	SendMessageInput,
+	SendTwoFactorAuthCodeInput,
 	ShareNotificationInput,
 	SignatureInput,
 	WhiteBlackListInput,
@@ -100,6 +103,7 @@ import {
 import { mapValuesDeep } from '../utils/map-values-deep';
 import {
 	normalizeCustomMetaDataAttrs,
+	normalizeHeaderAttrs,
 	setCustomMetaDataBody
 } from '../utils/normalize-attrs-custommetadata';
 import { normalizeEmailAddresses } from '../utils/normalize-email-addresses';
@@ -168,6 +172,9 @@ function normalizeMessage(
 			return entry;
 		});
 	}
+	if (message?._attrs) {
+		message._attrs = normalizeHeaderAttrs(message._attrs);
+	}
 
 	let normalizedMessage = normalize(MessageInfo)(message);
 	normalizedMessage = normalizedMessage && mapValuesDeep(normalizedMessage, coerceStringToBoolean);
@@ -333,30 +340,37 @@ export class ZimbraBatchClient {
 			body: {
 				sections: 'mbox,attrs,zimlets,props'
 			}
-		}).then(res => ({
-			...res,
-			attrs: {
-				...mapValuesDeep(res.attrs._attrs, coerceStringToBoolean),
-				zimbraMailAlias: [].concat(get(res, 'attrs._attrs.zimbraMailAlias', []))
-			},
-			...(get(res, 'license.attr') && {
-				license: {
-					status: res.license.status,
-					attr: mapValuesDeep(res.license.attr, coerceStringToBoolean)
-				}
-			}),
-			zimlets: {
-				zimlet:
-					get(res, 'zimlets.zimlet') &&
-					get(res, 'zimlets.zimlet').map(({ zimlet, zimletContext, zimletConfig }: any) => ({
+		}).then(res => {
+			const {
+				zimbraMailAlias,
+				zimbraTwoFactorAuthMethodAllowed,
+				zimbraTwoFactorAuthMethodEnabled
+			} = res?.attrs?._attrs || {};
+			return {
+				...res,
+				attrs: {
+					...mapValuesDeep(res?.attrs?._attrs, coerceStringToBoolean),
+					zimbraMailAlias: [].concat(zimbraMailAlias || []),
+					zimbraTwoFactorAuthMethodAllowed: [].concat(zimbraTwoFactorAuthMethodAllowed || []),
+					zimbraTwoFactorAuthMethodEnabled: [].concat(zimbraTwoFactorAuthMethodEnabled || [])
+				},
+				...(res?.license?.attr && {
+					license: {
+						status: res.license.status,
+						attr: mapValuesDeep(res.license.attr, coerceStringToBoolean)
+					}
+				}),
+				zimlets: {
+					zimlet: res?.zimlets?.zimlet?.map(({ zimlet, zimletContext, zimletConfig }: any) => ({
 						zimlet,
 						zimletContext,
 						...(zimletConfig && {
 							zimletConfig: normalize(ZimletConfigEntity)(zimletConfig)
 						})
 					}))
-			}
-		}));
+				}
+			};
+		});
 
 	public accountOnlyRemoteWipeSync = (deviceId: String) =>
 		this.jsonRequest({
@@ -757,10 +771,15 @@ export class ZimbraBatchClient {
 			singleRequest: true
 		}).then(Boolean);
 
-	public disableTwoFactorAuth = () =>
+	public disableTwoFactorAuth = (method: string) =>
 		this.jsonRequest({
 			name: 'DisableTwoFactorAuth',
 			namespace: Namespace.Account,
+			body: {
+				method: {
+					_content: method
+				}
+			},
 			singleRequest: true
 		}).then(Boolean);
 
@@ -783,6 +802,16 @@ export class ZimbraBatchClient {
 			singleRequest: true
 		}).then(Boolean);
 
+	public distributionListAction = ({ action, dl }: DistributionListActionInput) =>
+		this.jsonRequest({
+			name: 'DistributionListAction',
+			body: {
+				action: denormalize(DLActionEntity)(action),
+				dl
+			},
+			namespace: Namespace.Account
+		}).then(Boolean);
+
 	public documentAction = (options: ActionOptions) =>
 		this.documentActionResponse(ActionType.document, options);
 
@@ -826,6 +855,8 @@ export class ZimbraBatchClient {
 
 	public enableTwoFactorAuth = ({
 		name,
+		email,
+		method,
 		password,
 		authToken,
 		twoFactorCode,
@@ -838,6 +869,16 @@ export class ZimbraBatchClient {
 				name: {
 					_content: name
 				},
+				...(email && {
+					email: {
+						_content: email
+					}
+				}),
+				...(method && {
+					method: {
+						_content: method
+					}
+				}),
 				...(password && {
 					password: {
 						_content: password
@@ -1044,6 +1085,20 @@ export class ZimbraBatchClient {
 			namespace: Namespace.Sync
 		}).then(res => get(res, 'device') || []);
 
+	public getDistributionList = (dl: String, needOwners: Boolean, needRights: String, by: String) =>
+		this.jsonRequest({
+			name: 'GetDistributionList',
+			body: {
+				dl: {
+					by,
+					_content: dl
+				},
+				needOwners,
+				needRights
+			},
+			namespace: Namespace.Account
+		});
+
 	public getDistributionListMembers = (limit: String, offset: String, dl: String) =>
 		this.jsonRequest({
 			name: 'GetDistributionListMembers',
@@ -1451,7 +1506,19 @@ export class ZimbraBatchClient {
 				...(deviceTrusted && { deviceTrusted })
 			},
 			namespace: Namespace.Account
-		}).then(res => mapValuesDeep(res, coerceStringToBoolean));
+		}).then(res => {
+			const zimbraTwoFactorAuthMethodAllowed = (
+				res?.zimbraTwoFactorAuthMethodAllowed?.method || []
+			).map((m: any) => m._content);
+			const zimbraTwoFactorAuthMethodEnabled = (
+				res?.zimbraTwoFactorAuthMethodEnabled?.method || []
+			).map((m: any) => m._content);
+			return {
+				...mapValuesDeep(res, coerceStringToBoolean),
+				...(zimbraTwoFactorAuthMethodAllowed && { zimbraTwoFactorAuthMethodAllowed }),
+				...(zimbraTwoFactorAuthMethodEnabled && { zimbraTwoFactorAuthMethodEnabled })
+			};
+		});
 
 	public logout = () =>
 		this.jsonRequest({
@@ -1855,6 +1922,22 @@ export class ZimbraBatchClient {
 			singleRequest: true
 		}).then(Boolean);
 
+	public sendTwoFactorAuthCode = ({ action, authToken }: SendTwoFactorAuthCodeInput) => {
+		return this.jsonRequest({
+			name: 'SendTwoFactorAuthCode',
+			namespace: Namespace.Account,
+			body: {
+				action: {
+					_content: action
+				},
+				authToken: {
+					_content: authToken
+				}
+			},
+			singleRequest: true
+		});
+	};
+
 	public setCsrfToken = (csrfToken: string) => {
 		this.csrfToken = csrfToken;
 	};
@@ -1899,6 +1982,19 @@ export class ZimbraBatchClient {
 			singleRequest: true
 		}).then(Boolean);
 
+	public subscribeDistributionList = (op: String, by: String, dl: String) =>
+		this.jsonRequest({
+			name: 'SubscribeDistributionList',
+			body: {
+				dl: {
+					by,
+					_content: dl
+				},
+				op
+			},
+			namespace: Namespace.Account
+		}).then(res => res.status || '');
+
 	public taskFolders = () =>
 		this.jsonRequest({
 			name: 'GetFolder',

package/src/normalize/entities.ts

@@ -243,6 +243,7 @@ const commonMailItemFields = {
 	inv: ['invitations', InviteInfo],
 	mp: ['mimeParts', MimePart],
 	shr: 'share',
+	dlSubs: 'subscribe',
 	su: 'subject',
 	origid: 'origId',
 	attach: ['attachments', AttachmentsInfo],
@@ -775,3 +776,14 @@ export const ActionData = new Entity({
 export const DocumentActionData = new Entity({
 	action: ['action', ActionData]
 });
+
+export const DLActionAttrEntity = new Entity({
+	n: 'attributeName',
+	_content: 'content'
+});
+
+export const DLActionEntity = new Entity({
+	op: 'operation',
+	a: ['attributes', DLActionAttrEntity],
+	dlm: 'distributionListMembers'
+});