@zimbra/api-client 88.0.0 → 90.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zimbra/api-client",
   "amdName": "zmApiJsClient",
-  "version": "88.0.0",
+  "version": "90.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",
@@ -17,6 +17,7 @@
     "clean": "rimraf dist",
     "build": "npm-run-all clean generateSchemaTypes rollup:* -p build:ts minify:* copySchema",
     "build:ts": "tsc --emitDeclarationOnly --declaration --outDir \"dist\"",
+    "build:analyze": "visualize=true npm run build",
     "copySchema": "copyfiles -f src/schema/schema.graphql dist",
     "rollup:cjs": "cross-var rollup -c rollup.config.js -m -f cjs -n $npm_package_amdName $npm_package_source -o $npm_package_main",
     "rollup:umd": "cross-var rollup -c rollup.config.js -m -f umd -n $npm_package_amdName $npm_package_source -o $npm_package_umd_main",
@@ -44,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",
@@ -58,15 +59,15 @@
     "@babel/preset-typescript": "^7.17.12",
     "@babel/register": "^7.17.7",
     "@graphql-codegen/cli": "^2.6.2",
-    "@graphql-codegen/typescript": "^2.4.11",
-    "@rollup/plugin-babel": "^5.3.1",
+    "@graphql-codegen/typescript": "^4.0.1",
+    "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^22.0.0",
-    "@rollup/plugin-node-resolve": "^13.3.0",
     "@rollup/plugin-graphql": "^1.1.0",
+    "@rollup/plugin-node-resolve": "^13.3.0",
     "@rollup/plugin-typescript": "^11.1.5",
     "@types/graphql": "^14.5.0",
     "@types/lodash": "^4.14.182",
-    "@types/node": "^17.0.35",
+    "@types/node": "^20.10.4",
     "@types/whatwg-fetch": "^0.0.33",
     "babel-plugin-lodash": "^3.3.4",
     "chai": "^4.3.7",
@@ -81,11 +82,12 @@
     "rimraf": "^5.0.1",
     "rollup": "^2.75.0",
     "rollup-plugin-local-resolve": "^1.0.7",
+    "rollup-plugin-visualizer": "^5.11.0",
     "tslib": "^2.5.0",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
     "tslint-plugin-prettier": "^2.3.0",
-    "typescript": "^4.7.2",
+    "typescript": "^5.3.3",
     "uglify-js": "^3.15.5"
   }
 }

package/rollup.config.js

@@ -4,23 +4,21 @@ import graphql from '@rollup/plugin-graphql';
 import localResolve from 'rollup-plugin-local-resolve';
 import nodeResolve from '@rollup/plugin-node-resolve';
 import commonjs from '@rollup/plugin-commonjs';
-import pkg from './package.json';
+import { visualizer } from 'rollup-plugin-visualizer';
 
-let FORMAT = process.env.FORMAT;
+const FORMAT = process.env.FORMAT;
 
-// graphql-tools currently has a rollup build failure, so always call it an external until they fix it
-// otherwise, make all npm production dependencies external, plus their subpath usages
-// throughout the codebase, which rollup doesn't automatically pick up on
-let external = FORMAT==='es' ?
-	Object.keys(pkg.dependencies)
-		.concat(
-			['castArray', 'get','isError', 'isObject', 'mapValues', 'reduce', 'omitBy', 'uniqBy', 'concat', 'uniqBy', 'differenceBy', 'forEach'].map(v => 'lodash/'+v),
-			['graphql']) :
-	[];
+const externalDeps = [
+	'@apollo/client',
+	'graphql',
+	'lodash',
+	'mitt'
+];
 
+const getExternalDeps = id => externalDeps.find(pkgName => id.includes('/node_modules/' + pkgName  + '/'));
 
 export default {
-	external,
+	...(FORMAT==='es' && { external: getExternalDeps }),
 	context: 'commonjsGlobal', // what should "this" be at the top level when it is used by another module
 	plugins: [
 		graphql(),
@@ -34,9 +32,10 @@ export default {
 			extensions: ['.ts'],
 			exclude: 'node_modules/**',
 			babelHelpers: 'bundled'
-		})
+		}),
+		...(process.env.visualize ? [visualizer({ open: true }) ] : [])
 	],
 	output: {
 		exports: FORMAT==='es' ? null : 'named'
-	},
+	}
 };

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,
@@ -333,30 +336,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 +767,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 +798,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 +851,8 @@ export class ZimbraBatchClient {
 
 	public enableTwoFactorAuth = ({
 		name,
+		email,
+		method,
 		password,
 		authToken,
 		twoFactorCode,
@@ -838,6 +865,16 @@ export class ZimbraBatchClient {
 				name: {
 					_content: name
 				},
+				...(email && {
+					email: {
+						_content: email
+					}
+				}),
+				...(method && {
+					method: {
+						_content: method
+					}
+				}),
 				...(password && {
 					password: {
 						_content: password
@@ -1044,6 +1081,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 +1502,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 +1918,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 +1978,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'
+});