@zimbra/api-client 99.0.0 → 100.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zimbra/api-client",
   "amdName": "zmApiJsClient",
-  "version": "99.0.0",
+  "version": "100.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",
@@ -47,11 +47,11 @@
     ]
   },
   "dependencies": {
-    "@apollo/client": "3.4.16",
+    "@apollo/client": "^3.14.0",
     "@graphql-tools/schema": "^10.0.25",
     "dataloader": "^2.2.2",
+    "es-toolkit": "^1.39.10",
     "graphql": "^16.9.0",
-    "lodash": "^4.17.21",
     "mitt": "^3.0.0"
   },
   "devDependencies": {

package/rollup.config.js

@@ -11,7 +11,7 @@ const FORMAT = process.env.FORMAT;
 const externalDeps = [
 	'@apollo/client',
 	'graphql',
-	'lodash',
+	'es-toolkit',
 	'mitt'
 ];
 

package/src/apollo/offline-queue-link/util.ts

@@ -1,9 +1,8 @@
 import { Operation } from '@apollo/client/core';
-import get from 'lodash/get';
 import { OfflineOperationEntry, OperationEntry } from './types';
 
 export function hasSensitiveVariables(operation: Operation) {
-	return !!get(operation, 'variables.password');
+	return !!operation?.variables?.password;
 }
 
 export function isMutationOperation({ query }: Operation) {

package/src/apollo/zimbra-error-link.ts

@@ -1,5 +1,4 @@
 import { ErrorLink } from '@apollo/client/link/error';
-import get from 'lodash/get';
 
 class ZimbraErrorLink extends ErrorLink {
 	handlers: any[] = [];
@@ -7,8 +6,10 @@ class ZimbraErrorLink extends ErrorLink {
 	constructor() {
 		super(({ graphQLErrors, networkError }) => {
 			graphQLErrors &&
-				graphQLErrors.map(({ message, originalError, ...rest }) => {
-					let errorCode = get(originalError, 'faults.0.Detail.Error.Code', '');
+				graphQLErrors.map((error: any) => {
+					const { message, ...rest } = error;
+					const originalError = error.originalError;
+					const errorCode = (originalError as any)?.faults?.[0]?.Detail?.Error?.Code || '';
 
 					this.executeHandlers({
 						errorCode,

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

@@ -1,12 +1,12 @@
 import { FieldFunctionOptions } from '@apollo/client';
 import { defaultDataIdFromObject, InMemoryCache, InMemoryCacheConfig } from '@apollo/client/core';
-import get from 'lodash/get';
-import uniqWith from 'lodash/uniqWith';
+import { uniqWith } from 'es-toolkit';
+import { getValueByPath } from '../utils/map-values-deep';
 import { EmailAddress } from './types';
 
 const dataIdFromPath = (result: any, path: string) => {
 	if (result.__typename) {
-		const id = get(result, path);
+		const id = getValueByPath(result, path);
 		return id ? `${result.__typename}:${id}` : defaultDataIdFromObject(result);
 	}
 };

package/src/batch-client/index.ts

@@ -1,8 +1,5 @@
 import DataLoader from 'dataloader';
-import castArray from 'lodash/castArray';
-import get from 'lodash/get';
-import isError from 'lodash/isError';
-import mapValues from 'lodash/mapValues';
+import { mapValues } from 'es-toolkit';
 import { denormalize, normalize } from '../normalize';
 import {
 	AccountRights,
@@ -35,6 +32,7 @@ import {
 	GetDocumentShareURLEntity,
 	GetDocumentShareURLResponseEntity,
 	GetFolderRequest as GetFolderRequestEntity,
+	GetItem,
 	GetRightsRequest,
 	HabGroup,
 	InviteReply,
@@ -75,6 +73,7 @@ import {
 	ExternalAccountImportInput,
 	ExternalAccountTestInput,
 	FilterInput,
+	FilterMatchCondition,
 	FolderActionChangeColorInput,
 	FolderActionCheckCalendarInput,
 	FolderView,
@@ -186,7 +185,7 @@ function normalizeMessage(
 }
 
 const hasUnreadDescendent = (folder: any): any => {
-	const unreadDescendent = get(folder, 'unreadDescendent');
+	const unreadDescendent = folder?.unreadDescendent;
 
 	if (
 		folder[
@@ -199,7 +198,7 @@ const hasUnreadDescendent = (folder: any): any => {
 		return true;
 	}
 
-	const folderArray = get(folder, 'folders') || [];
+	const folderArray = folder?.folders || [];
 	for (let i = 0, len = folderArray.length; i < len; i++) {
 		return hasUnreadDescendent(folderArray[i]);
 	}
@@ -209,7 +208,7 @@ const hasUnreadDescendent = (folder: any): any => {
 
 const updateGroupName = (habGroup: any) => ({
 	...habGroup,
-	name: get(habGroup, 'attributes.displayName')
+	name: habGroup?.attributes?.displayName
 });
 
 const updateGroupNameRecur = (habGroups: any) =>
@@ -220,8 +219,8 @@ const updateGroupNameRecur = (habGroups: any) =>
 	});
 
 const setUnreadDescendentFlag = (folder: any) => {
-	const folderArray = get(folder, 'folders') || [];
-	const view = get(folder, 'view');
+	const folderArray = folder?.folders || [];
+	const view = folder?.view;
 
 	// setting this flag only in message view has we dont want to show unread count in
 	// other views
@@ -406,7 +405,7 @@ export class ZimbraBatchClient {
 				[<string>accountType]: mapValuesDeep(accountInfo, coerceBooleanToString)
 			},
 			singleRequest: true
-		}).then(res => get(res, `${accountType}.0.id`));
+		}).then(res => res?.[<string>accountType]?.[0]?.id);
 
 	public addMessage = (message: AddMsgInput) => {
 		const { folderId, content, meta } = message;
@@ -457,7 +456,7 @@ export class ZimbraBatchClient {
 				}
 			}
 		}).then(res => {
-			const ids = get(res, 'm[0].ids');
+			const ids = res?.m?.[0]?.ids;
 			return ids ? ids.split(',') : [];
 		});
 
@@ -532,8 +531,7 @@ export class ZimbraBatchClient {
 		password,
 		username,
 		dryRun = false,
-		authToken,
-		csrfToken
+		authToken
 	}: ChangePasswordOptions) => {
 		if (authToken) {
 			return this.jsonRequest({
@@ -547,8 +545,7 @@ export class ZimbraBatchClient {
 					oldPassword: password,
 					password: loginNewPassword,
 					dryRun,
-					authToken: { _content: authToken },
-					csrfToken: { _content: csrfToken }
+					authToken: { _content: authToken }
 				},
 				singleRequest: true
 			});
@@ -676,13 +673,11 @@ export class ZimbraBatchClient {
 				identity: {
 					...rest,
 					_attrs: {
-						...mapValues(attrs, coerceBooleanToString),
+						...mapValues(attrs || {}, coerceBooleanToString),
 						zimbraPrefWhenSentToAddresses: convertStringAndArrayValues(
-							get(attrs, 'zimbraPrefWhenSentToAddresses')
+							attrs?.zimbraPrefWhenSentToAddresses
 						),
-						zimbraPrefWhenInFolderIds: convertStringAndArrayValues(
-							get(attrs, 'zimbraPrefWhenInFolderIds')
-						)
+						zimbraPrefWhenInFolderIds: convertStringAndArrayValues(attrs?.zimbraPrefWhenInFolderIds)
 					}
 				}
 			},
@@ -692,7 +687,7 @@ export class ZimbraBatchClient {
 			const {
 				_attrs: { zimbraPrefWhenSentToAddresses, zimbraPrefWhenInFolderIds, ...restAttr },
 				...restIdentityProps
-			} = get(mappedResult, 'identity.0');
+			} = mappedResult?.identity?.[0];
 
 			return {
 				...mappedResult,
@@ -942,7 +937,6 @@ export class ZimbraBatchClient {
 			Header: {
 				context: {
 					_jsns: Namespace.All,
-					csrfToken: this.csrfToken,
 					account: {
 						by: 'name',
 						_content: options.accountName
@@ -1074,7 +1068,7 @@ export class ZimbraBatchClient {
 		this.jsonRequest({
 			name: 'GetConv',
 			body: {
-				c: mapValues(options, coerceBooleanToInt)
+				c: mapValues(options || {}, coerceBooleanToInt)
 			}
 		}).then(res => {
 			const conversation = this.normalizeConversation(res.c[0]);
@@ -1115,7 +1109,7 @@ export class ZimbraBatchClient {
 		this.jsonRequest({
 			name: 'GetDeviceStatus',
 			namespace: Namespace.Sync
-		}).then(res => get(res, 'device') || []);
+		}).then(res => res?.device || []);
 
 	public getDistributionList = (dl: String, needOwners: Boolean, needRights: String, by: String) =>
 		this.jsonRequest({
@@ -1166,7 +1160,24 @@ export class ZimbraBatchClient {
 	public getFilterRules = () =>
 		this.jsonRequest({
 			name: 'GetFilterRules'
-		}).then(res => normalize(Filter)(get(res, 'filterRules.0.filterRule') || []));
+		}).then(res => {
+			const filterRules = res?.filterRules?.[0]?.filterRule || [];
+
+			// Set default condition to anyof in case of null or undefined :: Classic UI approach
+			for (let i = 0; i < filterRules.length; i++) {
+				const rule = filterRules[i];
+				if (rule?.filterTests && Array.isArray(rule.filterTests)) {
+					for (let j = 0; j < rule.filterTests.length; j++) {
+						const test = rule?.filterTests[j];
+						if (test?.condition === null || test?.condition === undefined) {
+							test.condition = FilterMatchCondition.Anyof;
+						}
+					}
+				}
+			}
+
+			return normalize(Filter)(filterRules);
+		});
 
 	public getFolder = (options: GetFolderOptions) => {
 		return this.jsonRequest({
@@ -1174,7 +1185,7 @@ export class ZimbraBatchClient {
 			body: denormalize(GetFolderRequestEntity)(options)
 		}).then(res => {
 			const foldersResponse = normalize(Folder)(res);
-			const folders = get(foldersResponse, 'folders.0', {});
+			const folders = foldersResponse?.folders?.[0] || {};
 
 			if (folders.folders) {
 				folders.folders = folders.folders.map(setUnreadDescendentFlag);
@@ -1239,7 +1250,7 @@ export class ZimbraBatchClient {
 			},
 			namespace: Namespace.Account
 		}).then(res => {
-			const habGroups = get(res, 'ou.0');
+			const habGroups = res?.ou?.[0] || {};
 			return {
 				...habGroups,
 				habGroups: [...updateGroupNameRecur(habGroups.habGroup)]
@@ -1281,6 +1292,22 @@ export class ZimbraBatchClient {
 			name: 'GetImportStatus'
 		});
 
+	public getItem = ({ id }: any) =>
+		this.jsonRequest({
+			name: 'GetItem',
+			namespace: Namespace.Mail,
+			body: {
+				item: {
+					id
+				}
+			}
+		}).then(response => {
+			const data = normalize(GetItem)(response);
+			return {
+				docs: data.documents
+			};
+		});
+
 	public getMailboxMetadata = ({ section }: GetMailboxMetadataOptions) =>
 		this.jsonRequest({
 			name: 'GetMailboxMetadata',
@@ -1346,7 +1373,12 @@ export class ZimbraBatchClient {
 
 			for (const pref in prefs) {
 				if (CASTING_PREFS.indexOf(pref) !== -1) {
-					prefs[pref] = typeof prefs[pref] === 'string' ? castArray(prefs[pref]) : prefs[pref];
+					prefs[pref] =
+						typeof prefs[pref] === 'string'
+							? prefs[pref] !== undefined
+								? [prefs[pref]]
+								: []
+							: prefs[pref];
 				}
 			}
 			return prefs;
@@ -1607,13 +1639,11 @@ export class ZimbraBatchClient {
 				identity: {
 					...rest,
 					_attrs: {
-						...mapValues(attrs, coerceBooleanToString),
+						...mapValues(attrs || {}, coerceBooleanToString),
 						zimbraPrefWhenSentToAddresses: convertStringAndArrayValues(
-							get(attrs, 'zimbraPrefWhenSentToAddresses')
+							attrs?.zimbraPrefWhenSentToAddresses
 						),
-						zimbraPrefWhenInFolderIds: convertStringAndArrayValues(
-							get(attrs, 'zimbraPrefWhenInFolderIds')
-						)
+						zimbraPrefWhenInFolderIds: convertStringAndArrayValues(attrs?.zimbraPrefWhenInFolderIds)
 					}
 				}
 			},
@@ -2037,7 +2067,7 @@ export class ZimbraBatchClient {
 				[<string>accountType]: mapValuesDeep(accountInfo, coerceBooleanToString)
 			},
 			singleRequest: true
-		}).then(res => mapValuesDeep(get(res, `${accountType}.0`), coerceStringToBoolean));
+		}).then(res => mapValuesDeep(res?.[<string>accountType]?.[0], coerceStringToBoolean));
 
 	public uploadMessage = (message: string): any => {
 		const contentDisposition = 'attachment';
@@ -2086,9 +2116,9 @@ export class ZimbraBatchClient {
 			requests,
 			...this.getAdditionalRequestOptions()
 		}).then(response => {
-			const sessionId = get(response, 'header.context.session.id');
-			const notifications = get(response, 'header.context.notify.0');
-			const refresh = get(response, 'header.context.refresh');
+			const sessionId = response?.header?.context?.session?.id;
+			const notifications = response?.header?.context?.notify?.[0];
+			const refresh = response?.header?.context?.refresh;
 
 			this.checkAndUpdateSessionId(sessionId);
 
@@ -2106,7 +2136,7 @@ export class ZimbraBatchClient {
 				if (DEBUG) {
 					console.log(`[Batch Client Request] ${requests[i].name}`, requests[i].body, r);
 				}
-				return isError(r) ? r : r.body;
+				return r instanceof Error ? r : r.body;
 			});
 		});
 
@@ -2124,9 +2154,9 @@ export class ZimbraBatchClient {
 			// check if login request then don't add csrfToken
 			...this.getAdditionalRequestOptions(requests[0].name !== 'Auth')
 		}).then(response => {
-			const sessionId = get(response, 'header.context.session.id');
-			const notifications = get(response, 'header.context.notify.0');
-			const refresh = get(response, 'header.context.refresh');
+			const sessionId = response?.header?.context?.session?.id;
+			const notifications = response?.header?.context?.notify?.[0];
+			const refresh = response?.header?.context?.refresh;
 
 			this.checkAndUpdateSessionId(sessionId);
 
@@ -2140,7 +2170,7 @@ export class ZimbraBatchClient {
 				}
 			}
 
-			return isError(response) ? [response] : [response.body];
+			return response instanceof Error ? [response] : [response.body];
 		});
 
 	private download = ({ isSecure, url }: any) =>

package/src/batch-client/types.ts

@@ -178,6 +178,7 @@ export interface AppointmentOptions {
 }
 
 export interface SaveDocumentInput {
+	content: string;
 	ct: string;
 	descEnabled: Boolean;
 	id: string;
@@ -234,7 +235,6 @@ export interface ShareInfoOptions {
 
 export interface ChangePasswordOptions {
 	authToken: string;
-	csrfToken: string;
 	dryRun: boolean;
 	loginNewPassword: string;
 	password: string;

package/src/normalize/entities.ts

@@ -533,6 +533,10 @@ export const ListDocumentRevisions = new Entity({
 	doc: ['documents', Document]
 });
 
+export const GetItem = new Entity({
+	doc: ['documents', Document]
+});
+
 export const MessagePartInputForDocuments = new Entity({
 	id: 'messageId',
 	part: 'attachmentPart'
@@ -545,7 +549,8 @@ export const SaveDocument = new Entity({
 	ct: 'contentType',
 	descEnabled: 'descriptionEnabled',
 	m: ['messageData', MessagePartInputForDocuments],
-	doc: ['document', Document]
+	doc: ['document', Document],
+	content: 'content'
 });
 
 export const SearchResponse = new Entity({

package/src/normalize/index.ts

@@ -1,5 +1,3 @@
-import reduce from 'lodash/reduce';
-
 import { EntityMapping, EntityMappingValue, NormalizedKey } from './types';
 
 function normalizeKey(key: string, schema: Entity, inverse: Boolean = false): NormalizedKey {
@@ -19,25 +17,28 @@ function normalizeKey(key: string, schema: Entity, inverse: Boolean = false): No
 	return { key };
 }
 
-function _normalize(data: {}, schema: Entity, inverse: Boolean = false) {
-	return reduce(
-		data,
-		(result: { [key: string]: any }, v, k) => {
-			const { key, nestedSchema } = normalizeKey(k, schema, inverse);
-			const type = typeof v;
-			if (Array.isArray(v)) {
-				result[key] = (v as Array<any>).map(i =>
-					nestedSchema ? _normalize(i, nestedSchema, inverse) : i
-				);
-			} else if (type === 'object' && v !== null) {
-				result[key] = nestedSchema ? _normalize(v, nestedSchema, inverse) : v;
-			} else {
-				result[key] = v;
-			}
-			return result;
-		},
-		{}
-	);
+function _normalize(data: {}, schema: Entity, inverse: boolean = false) {
+	const result: { [key: string]: any } = {};
+
+	for (const k in data) {
+		if (!Object.prototype.hasOwnProperty.call(data, k)) {
+			continue;
+		}
+
+		const v = (data as any)[k];
+		const { key, nestedSchema } = normalizeKey(k, schema, inverse);
+		const type = typeof v;
+
+		if (Array.isArray(v)) {
+			result[key] = v.map(i => (nestedSchema ? _normalize(i, nestedSchema, inverse) : i));
+		} else if (type === 'object' && v !== null) {
+			result[key] = nestedSchema ? _normalize(v, nestedSchema, inverse) : v;
+		} else {
+			result[key] = v;
+		}
+	}
+
+	return result;
 }
 
 /**
@@ -74,24 +75,26 @@ export class Entity {
 		this.inverseMapping = this.initInverseMapping(this.mapping);
 	}
 
-	initInverseMapping(mapping: EntityMapping, accumulator = {}) {
-		return reduce(
-			mapping,
-			(result: EntityMapping, v: any, k) => {
-				if (Array.isArray(v)) {
-					result[v[0]] = [k, v[1]];
-				} else if (typeof v === 'object' && !(v instanceof Entity)) {
-					result[k] = this.initInverseMapping(v) as EntityMappingValue;
-				} else if (typeof v === 'string') {
-					result[v] = k;
-				} else {
-					result[k] = v;
-				}
-
-				return result;
-			},
-			accumulator
-		);
+	initInverseMapping(mapping: EntityMapping, accumulator: EntityMapping = {}): EntityMapping {
+		for (const k in mapping) {
+			if (!Object.prototype.hasOwnProperty.call(mapping, k)) {
+				continue;
+			}
+
+			const v: any = mapping[k];
+
+			if (Array.isArray(v)) {
+				accumulator[v[0]] = [k, v[1]];
+			} else if (typeof v === 'object' && !(v instanceof Entity)) {
+				accumulator[k] = this.initInverseMapping(v) as EntityMappingValue;
+			} else if (typeof v === 'string') {
+				accumulator[v] = k;
+			} else {
+				accumulator[k] = v;
+			}
+		}
+
+		return accumulator;
 	}
 
 	public inverseKey(k: string) {

package/src/request/index.ts

@@ -1,5 +1,3 @@
-import get from 'lodash/get';
-import reduce from 'lodash/reduce';
 import {
 	BatchRequestOptions,
 	BatchRequestResponse,
@@ -39,7 +37,7 @@ function parseJSON(response: Response): Promise<ParsedResponse> {
 		// for the rest of the cases (as of now only 500 error), parse and return the error response so that it can
 		// be handled properly by the caller
 		return parseErrorJSON(response).then(parsedResponse => {
-			const fault = get(parsedResponse.parsed, 'Body.Fault');
+			const fault = parsedResponse?.parsed?.Body?.Fault;
 			throw faultError(parsedResponse, [fault]);
 		});
 	}
@@ -71,7 +69,7 @@ function networkError(response: ParsedResponse) {
 
 	(error as NetworkError).message = message;
 	(error as NetworkError).response = response;
-	(error as NetworkError).parseError = response.parseError;
+	(error as NetworkError).parseError = response?.parseError;
 
 	return error as NetworkError;
 }
@@ -80,7 +78,7 @@ function faultReasonText(faults: any = []): string {
 	if (!Array.isArray(faults)) faults = [faults];
 
 	return faults
-		.map((f: any) => get(f, 'Reason.Text'))
+		.map((f: any) => f?.Reason?.Text)
 		.filter(Boolean)
 		.join(', ');
 }
@@ -88,7 +86,7 @@ function faultReasonText(faults: any = []): string {
 function faultError(response: ParsedResponse, faults: any) {
 	const error = new Error(`Fault error: ${faults ? faultReasonText(faults) : 'Unknown Error'}`);
 	(error as SingleBatchRequestError).response = response;
-	(error as SingleBatchRequestError).parseError = response.parseError;
+	(error as SingleBatchRequestError).parseError = response?.parseError;
 	(error as SingleBatchRequestError).faults = faults;
 	return error as SingleBatchRequestError;
 }
@@ -98,20 +96,20 @@ function faultError(response: ParsedResponse, faults: any) {
  * containing an array of the requests for that command.
  */
 function batchBody(requests: ReadonlyArray<RequestOptions>) {
-	return reduce(
-		requests,
-		(body: { [key: string]: any }, request) => {
-			const key = `${request.name}Request`;
-			const value = soapCommandBody(request);
-			if (body[key]) {
-				body[key].push(value);
-			} else {
-				body[key] = [value];
-			}
-			return body;
-		},
-		{}
-	);
+	const body: { [key: string]: any } = {};
+
+	for (const request of requests) {
+		const key = `${request.name}Request`;
+		const value = soapCommandBody(request);
+
+		if (body[key]) {
+			body[key].push(value);
+		} else {
+			body[key] = [value];
+		}
+	}
+
+	return body;
 }
 
 /**
@@ -127,34 +125,26 @@ function batchResponse(requests: any, response: RequestResponse) {
 	// For each request type, track which responses have been
 	// pulled out of the batch request body by incrementing
 	// indexes.
-	let indexes: { [key: string]: number } = {};
+	const indexes: { [key: string]: number } = {};
+	const responses: Array<SingleBatchRequestResponse | SingleBatchRequestError> = [];
+
+	for (const request of requests) {
+		const batchResponses = batchBody[`${request.name}Response`];
+		const index = indexes[request.name] || 0;
+		const singleResponse = batchResponses?.[index];
+
+		if (singleResponse) {
+			responses.push({ body: singleResponse });
+		} else {
+			responses.push(faultError(request.originalResponse, batchBody.Fault));
+		}
+
+		indexes[request.name] = index + 1;
+	}
 
 	return {
 		...res,
-		requests: reduce(
-			requests,
-			(responses: Array<SingleBatchRequestResponse | SingleBatchRequestError>, request) => {
-				const batchResponses = batchBody[`${request.name}Response`];
-				const index = indexes[request.name];
-				const response: any = batchResponses && batchResponses[index || 0];
-				if (response) {
-					responses.push({
-						body: response
-					});
-				} else {
-					responses.push(faultError(res.originalResponse, batchBody.Fault));
-				}
-
-				if (index) {
-					indexes[request.name] += 1;
-				} else {
-					indexes[request.name] = 1;
-				}
-
-				return responses;
-			},
-			[]
-		)
+		requests: responses
 	};
 }
 
@@ -232,8 +222,6 @@ export function jsonRequest(requestOptions: JsonRequestOptions): Promise<Request
 
 	if (requestOptions.csrfToken) {
 		options.headers['X-Zimbra-Csrf-Token'] = requestOptions.csrfToken;
-
-		header.context.csrfToken = requestOptions.csrfToken;
 	}
 
 	// Allow to set Auth Token in Cookie in case `ZimbraBatchClient` is used on non-web platforms, like nodejs
@@ -267,7 +255,7 @@ export function jsonRequest(requestOptions: JsonRequestOptions): Promise<Request
 	})
 		.then(parseJSON)
 		.then((response: any) => {
-			const globalFault = get(response.parsed, 'Body.Fault');
+			const globalFault = response?.parsed?.Body?.Fault;
 
 			if (globalFault) {
 				throw faultError(response, globalFault);

package/src/request/types.ts

@@ -95,7 +95,6 @@ export interface SOAPHeader {
 		authTokenControl?: {
 			voidOnExpired: boolean;
 		};
-		csrfToken?: string;
 		jwtToken?: {
 			_content: string;
 		};