@zimbra/api-client 97.0.0 → 99.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zimbra/api-client",
   "amdName": "zmApiJsClient",
-  "version": "97.0.0",
+  "version": "99.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",
@@ -48,7 +48,7 @@
   },
   "dependencies": {
     "@apollo/client": "3.4.16",
-    "@graphql-tools/schema": "^10.0.3",
+    "@graphql-tools/schema": "^10.0.25",
     "dataloader": "^2.2.2",
     "graphql": "^16.9.0",
     "lodash": "^4.17.21",
@@ -56,15 +56,15 @@
   },
   "devDependencies": {
     "@babel/cli": "^7.17.10",
-    "@babel/core": "^7.18.2",
+    "@babel/core": "^7.28.0",
     "@babel/plugin-proposal-class-properties": "^7.17.12",
     "@babel/preset-env": "^7.18.2",
-    "@babel/preset-typescript": "^7.17.12",
+    "@babel/preset-typescript": "^7.27.1",
     "@babel/register": "^7.17.7",
-    "@graphql-codegen/cli": "^2.6.2",
-    "@graphql-codegen/typescript": "^4.0.1",
+    "@graphql-codegen/cli": "^5.0.7",
+    "@graphql-codegen/typescript": "^4.1.6",
     "@rollup/plugin-babel": "^6.0.4",
-    "@rollup/plugin-commonjs": "^22.0.0",
+    "@rollup/plugin-commonjs": "^28.0.5",
     "@rollup/plugin-graphql": "^1.1.0",
     "@rollup/plugin-node-resolve": "^13.3.0",
     "@rollup/plugin-typescript": "^11.1.5",
@@ -73,12 +73,12 @@
     "@types/node": "^20.10.4",
     "@types/whatwg-fetch": "^0.0.33",
     "babel-plugin-lodash": "^3.3.4",
-    "chai": "^4.3.7",
+    "chai": "^4.5.0",
     "copyfiles": "^2.4.1",
     "cross-var": "^1.1.0",
     "husky": "^9.1.7",
     "lint-staged": "15.2.8",
-    "mocha": "^10.2.0",
+    "mocha": "^10.8.2",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.6.2",
     "rimraf": "^5.0.1",

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

@@ -1,3 +1,4 @@
+import { FieldFunctionOptions } from '@apollo/client';
 import { defaultDataIdFromObject, InMemoryCache, InMemoryCacheConfig } from '@apollo/client/core';
 import get from 'lodash/get';
 import uniqWith from 'lodash/uniqWith';
@@ -58,6 +59,29 @@ function createPossibleTypes(possibleTypesFactory = Object) {
 	});
 }
 
+function isReference(obj: any): obj is { __ref: string } {
+	return obj && typeof obj === 'object' && '__ref' in obj;
+}
+
+function resolvedRefrenceAddress(
+	address: EmailAddress[],
+	readField: FieldFunctionOptions['readField']
+) {
+	return (address || []).map(item => {
+		if (isReference(item)) {
+			return {
+				__typename: readField('__typename', item),
+				address: readField('address', item),
+				type: readField('type', item),
+				isGroup: readField('isGroup', item),
+				name: readField('name', item),
+				displayName: readField('displayName', item)
+			};
+		}
+		return item;
+	});
+}
+
 const typePolicies = {
 	Query: {
 		fields: {
@@ -95,11 +119,17 @@ const typePolicies = {
 	MessageInfo: {
 		fields: {
 			emailAddresses: {
-				merge(existing: EmailAddress[], incoming: EmailAddress[]) {
-					return uniqWith(
-						[...(existing || []), ...(incoming || [])],
-						(a, b) => a.address === b.address && a.type === b.type
-					);
+				merge(
+					existing: EmailAddress[] = [],
+					incoming: EmailAddress[] = [],
+					{ readField }: FieldFunctionOptions
+				) {
+					const resolvedExisting = resolvedRefrenceAddress(existing, readField);
+					const resolvedIncoming = resolvedRefrenceAddress(incoming, readField);
+					const combined = [...(resolvedIncoming || []), ...(resolvedExisting || [])];
+					// Prefer entries where isGroup is not null
+					combined.sort((a, b) => Number(b.isGroup != null) - Number(a.isGroup != null));
+					return uniqWith(combined, (a, b) => a.address === b.address && a.type === b.type);
 				}
 			}
 		}

package/src/batch-client/index.ts

@@ -59,6 +59,7 @@ import {
 } from '../request';
 import { JsonRequestOptions, Namespace, RequestBody, RequestOptions } from '../request/types';
 import {
+	ActionOpResponse,
 	AddMsgInput,
 	CalendarItemInput,
 	CounterAppointmentInput,
@@ -384,7 +385,7 @@ export class ZimbraBatchClient {
 		});
 
 	public action = (type: ActionType, options: ActionOptions) => {
-		const { ids, id, ...rest } = options;
+		const { ids, id, isBatchOperation, ...rest } = options;
 
 		return this.jsonRequest({
 			name: type,
@@ -394,7 +395,7 @@ export class ZimbraBatchClient {
 					...denormalize(ActionOptionsEntity)(rest)
 				}
 			},
-			singleRequest: true
+			singleRequest: !isBatchOperation
 		}).then(Boolean);
 	};
 
@@ -569,11 +570,21 @@ export class ZimbraBatchClient {
 		}
 	};
 
-	public checkCalendar = ({ id, value }: FolderActionCheckCalendarInput) =>
-		this.action(ActionType.folder, {
-			id,
-			op: value ? 'check' : '!check'
+	public checkCalendar = ({
+		id,
+		value
+	}: FolderActionCheckCalendarInput): Promise<ActionOpResponse> => {
+		return this.jsonRequest({
+			name: ActionType.folder,
+			body: {
+				action: {
+					id,
+					op: value ? 'check' : '!check'
+				}
+			},
+			singleRequest: true
 		});
+	};
 
 	public clientInfo = ({ by, domain }: any) =>
 		this.jsonRequest({

package/src/batch-client/types.ts

@@ -264,6 +264,7 @@ export interface ActionOptions {
 	folderId?: string;
 	id?: string;
 	ids?: Array<string>;
+	isBatchOperation?: boolean;
 	isLocal?: boolean;
 	name?: string;
 	op: string;

package/src/normalize/entities.ts

@@ -87,12 +87,14 @@ const CalendarItemAttendees = new Entity({
 	ptst: 'participationStatus',
 	a: 'address',
 	d: 'name',
-	cutype: 'calendarUserType'
+	cutype: 'calendarUserType',
+	isGroup: 'isGroup'
 });
 
 const CalendarItemReply = new Entity({
 	ptst: 'participationStatus',
-	at: 'address'
+	at: 'address',
+	isGroup: 'isGroup'
 });
 
 const CalendarItemOrganizer = new Entity({

package/src/schema/generated-schema-types.ts

@@ -82,6 +82,8 @@ export type AccountInfo = {
 export type AccountInfoAttrs = {
   __typename?: 'AccountInfoAttrs';
   displayName?: Maybe<Scalars['String']['output']>;
+  zimbraAttachmentsBlocked?: Maybe<Scalars['Boolean']['output']>;
+  zimbraAttachmentsViewInHtmlOnly?: Maybe<Scalars['Boolean']['output']>;
   zimbraBlockEmailSendFromImapPop?: Maybe<Scalars['Boolean']['output']>;
   zimbraBrandingFolderName?: Maybe<Scalars['String']['output']>;
   zimbraDataSourceMaxNumEntries?: Maybe<Scalars['Int']['output']>;
@@ -123,6 +125,7 @@ export type AccountInfoAttrs = {
   zimbraFeatureMailSendLaterEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraFeatureManageZimlets?: Maybe<Scalars['Boolean']['output']>;
   zimbraFeatureMobileSyncEnabled?: Maybe<Scalars['Boolean']['output']>;
+  zimbraFeatureOptionsEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraFeatureOutOfOfficeReplyEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraFeaturePop3DataSourceEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraFeaturePowerPasteEnabled?: Maybe<Scalars['Boolean']['output']>;
@@ -169,6 +172,7 @@ export type AccountInfoAttrs = {
   zimbraPasswordMinNumericChars?: Maybe<Scalars['Int']['output']>;
   zimbraPasswordMinPunctuationChars?: Maybe<Scalars['Int']['output']>;
   zimbraPasswordMinUpperCaseChars?: Maybe<Scalars['Int']['output']>;
+  zimbraPop3Enabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraPublicSharingEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraSignupAffiliate?: Maybe<Scalars['String']['output']>;
   zimbraSignupRecoveryEmail?: Maybe<Scalars['String']['output']>;
@@ -612,6 +616,7 @@ export type CalendarItemAttendee = {
   __typename?: 'CalendarItemAttendee';
   address?: Maybe<Scalars['String']['output']>;
   calendarUserType?: Maybe<Scalars['String']['output']>;
+  isGroup?: Maybe<Scalars['Boolean']['output']>;
   name?: Maybe<Scalars['String']['output']>;
   participationStatus?: Maybe<ParticipationStatus>;
   role?: Maybe<ParticipationRole>;
@@ -708,6 +713,7 @@ export type CalendarItemInviteComponentCounterInput = {
   percentComplete?: InputMaybe<Scalars['String']['input']>;
   priority?: InputMaybe<Scalars['String']['input']>;
   recurrence?: InputMaybe<CalendarItemRecurrenceInput>;
+  seq?: InputMaybe<Scalars['Int']['input']>;
   start: CalendarItemDateTimeInput;
   status?: InputMaybe<InviteCompletionStatus>;
   uid?: InputMaybe<Scalars['String']['input']>;
@@ -829,6 +835,7 @@ export type CalendarItemRecurrenceRuleInput = {
 export type CalendarItemReply = {
   __typename?: 'CalendarItemReply';
   address?: Maybe<Scalars['String']['output']>;
+  isGroup?: Maybe<Scalars['Boolean']['output']>;
   participationStatus?: Maybe<ParticipationStatus>;
 };
 
@@ -2194,6 +2201,7 @@ export type Instance = {
 
 export type InstanceDate = {
   date?: InputMaybe<Scalars['String']['input']>;
+  timezone?: InputMaybe<Scalars['String']['input']>;
 };
 
 export type IntervalRule = {
@@ -2656,7 +2664,7 @@ export type Mutation = {
   cancelTask?: Maybe<Scalars['Boolean']['output']>;
   changeFolderColor?: Maybe<Scalars['Boolean']['output']>;
   changePassword?: Maybe<AuthResponse>;
-  checkCalendar?: Maybe<Scalars['Boolean']['output']>;
+  checkCalendar?: Maybe<ActionOpResponse>;
   contactAction?: Maybe<ActionOpResponse>;
   conversationAction?: Maybe<Scalars['Boolean']['output']>;
   counterAppointment?: Maybe<Scalars['Boolean']['output']>;
@@ -2756,6 +2764,7 @@ export type MutationActionArgs = {
   folderId?: InputMaybe<Scalars['ID']['input']>;
   id?: InputMaybe<Scalars['ID']['input']>;
   ids?: InputMaybe<Array<Scalars['ID']['input']>>;
+  isBatchOperation?: InputMaybe<Scalars['Boolean']['input']>;
   isLocal?: InputMaybe<Scalars['Boolean']['input']>;
   name?: InputMaybe<Scalars['String']['input']>;
   op: Scalars['String']['input'];
@@ -2833,6 +2842,7 @@ export type MutationContactActionArgs = {
   folderId?: InputMaybe<Scalars['ID']['input']>;
   id?: InputMaybe<Scalars['ID']['input']>;
   ids?: InputMaybe<Array<Scalars['ID']['input']>>;
+  isBatchOperation?: InputMaybe<Scalars['Boolean']['input']>;
   op: Scalars['String']['input'];
   tagNames?: InputMaybe<Scalars['String']['input']>;
 };
@@ -3021,6 +3031,7 @@ export type MutationItemActionArgs = {
   folderId?: InputMaybe<Scalars['ID']['input']>;
   id?: InputMaybe<Scalars['ID']['input']>;
   ids?: InputMaybe<Array<InputMaybe<Scalars['ID']['input']>>>;
+  isBatchOperation?: InputMaybe<Scalars['Boolean']['input']>;
   name?: InputMaybe<Scalars['String']['input']>;
   op: Scalars['String']['input'];
   tagNames?: InputMaybe<Scalars['String']['input']>;
@@ -3411,6 +3422,13 @@ export type PolicyInput = {
   policy?: InputMaybe<Array<InputMaybe<PolicyAttrsInput>>>;
 };
 
+export enum Pop3DeleteOption {
+  Delete = 'delete',
+  Keep = 'keep',
+  Read = 'read',
+  Trash = 'trash'
+}
+
 export enum PrefCalendarInitialView {
   Day = 'day',
   List = 'list',
@@ -3475,6 +3493,7 @@ export type Preferences = {
   zimbraPrefHtmlEditorDefaultFontColor?: Maybe<Scalars['String']['output']>;
   zimbraPrefHtmlEditorDefaultFontFamily?: Maybe<Scalars['String']['output']>;
   zimbraPrefHtmlEditorDefaultFontSize?: Maybe<Scalars['String']['output']>;
+  zimbraPrefImapEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraPrefLocale?: Maybe<Scalars['String']['output']>;
   zimbraPrefMailDeliveryStatusNotification?: Maybe<Scalars['Boolean']['output']>;
   zimbraPrefMailForwardingAddress?: Maybe<Scalars['String']['output']>;
@@ -3497,6 +3516,10 @@ export type Preferences = {
   zimbraPrefOutOfOfficeUntilDate?: Maybe<Scalars['String']['output']>;
   zimbraPrefPasswordRecoveryAddress?: Maybe<Scalars['String']['output']>;
   zimbraPrefPasswordRecoveryAddressStatus?: Maybe<PasswordRecoveryAddressStatus>;
+  zimbraPrefPop3DeleteOption?: Maybe<Pop3DeleteOption>;
+  zimbraPrefPop3DownloadSince?: Maybe<Scalars['String']['output']>;
+  zimbraPrefPop3Enabled?: Maybe<Scalars['Boolean']['output']>;
+  zimbraPrefPop3IncludeSpam?: Maybe<Scalars['Boolean']['output']>;
   zimbraPrefPowerPasteEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraPrefPrimaryTwoFactorAuthMethod?: Maybe<Scalars['String']['output']>;
   zimbraPrefReadingPaneEnabled?: Maybe<Scalars['Boolean']['output']>;
@@ -3541,6 +3564,7 @@ export type PreferencesInput = {
   zimbraPrefHtmlEditorDefaultFontColor?: InputMaybe<Scalars['String']['input']>;
   zimbraPrefHtmlEditorDefaultFontFamily?: InputMaybe<Scalars['String']['input']>;
   zimbraPrefHtmlEditorDefaultFontSize?: InputMaybe<Scalars['String']['input']>;
+  zimbraPrefImapEnabled?: InputMaybe<Scalars['Boolean']['input']>;
   zimbraPrefLocale?: InputMaybe<Scalars['String']['input']>;
   zimbraPrefMailDeliveryStatusNotification?: InputMaybe<Scalars['Boolean']['input']>;
   zimbraPrefMailForwardingAddress?: InputMaybe<Scalars['String']['input']>;
@@ -3561,6 +3585,10 @@ export type PreferencesInput = {
   zimbraPrefOutOfOfficeStatusAlertOnLogin?: InputMaybe<Scalars['Boolean']['input']>;
   zimbraPrefOutOfOfficeSuppressExternalReply?: InputMaybe<Scalars['Boolean']['input']>;
   zimbraPrefOutOfOfficeUntilDate?: InputMaybe<Scalars['String']['input']>;
+  zimbraPrefPop3DeleteOption?: InputMaybe<Pop3DeleteOption>;
+  zimbraPrefPop3DownloadSince?: InputMaybe<Scalars['String']['input']>;
+  zimbraPrefPop3Enabled?: InputMaybe<Scalars['Boolean']['input']>;
+  zimbraPrefPop3IncludeSpam?: InputMaybe<Scalars['Boolean']['input']>;
   zimbraPrefPowerPasteEnabled?: InputMaybe<Scalars['Boolean']['input']>;
   zimbraPrefPrimaryTwoFactorAuthMethod?: InputMaybe<Scalars['String']['input']>;
   zimbraPrefReadingPaneEnabled?: InputMaybe<Scalars['Boolean']['input']>;
@@ -4233,6 +4261,7 @@ export type SearchResponse = {
 
 export enum SearchType {
   Appointment = 'appointment',
+  Briefcase = 'briefcase',
   Contact = 'contact',
   Conversation = 'conversation',
   Document = 'document',

package/src/schema/schema.graphql

@@ -203,6 +203,7 @@ enum SearchType {
 	wiki
 	document
 	unknown
+	briefcase
 }
 
 enum ContactType {
@@ -322,6 +323,13 @@ enum PrefClientType {
 	standard
 }
 
+enum Pop3DeleteOption {
+	keep
+	read
+	trash
+	delete
+}
+
 enum Mode {
 	text
 	html
@@ -1454,6 +1462,8 @@ type AccountZimletConfigInfo {
 
 type AccountInfoAttrs {
 	displayName: String
+	zimbraAttachmentsBlocked: Boolean
+	zimbraAttachmentsViewInHtmlOnly: Boolean
 	zimbraBrandingFolderName: String
 	zimbraDataSourceMaxNumEntries: Int
 	zimbraDomainTrialConvertAtExpiration: Boolean
@@ -1549,6 +1559,8 @@ type AccountInfoAttrs {
 	zimbraFeatureAdvancedChatEnabled: Boolean
 	zimbraMailIdleSessionTimeout: String
 	zimbraFeatureDeliveryStatusNotificationEnabled: Boolean
+	zimbraPop3Enabled: Boolean
+	zimbraFeatureOptionsEnabled: Boolean
 }
 
 type AccountCos {
@@ -1700,6 +1712,11 @@ type Preferences {
 	zimbraPrefDisplayTimeInMailList: Boolean
 	zimbraPrefPrimaryTwoFactorAuthMethod: String
 	zimbraPrefMailDeliveryStatusNotification: Boolean
+	zimbraPrefImapEnabled: Boolean
+	zimbraPrefPop3Enabled: Boolean
+	zimbraPrefPop3DownloadSince: String
+	zimbraPrefPop3IncludeSpam: Boolean
+	zimbraPrefPop3DeleteOption: Pop3DeleteOption
 }
 
 type GetAppointmentResponse {
@@ -2427,7 +2444,8 @@ input CalendarItemInviteComponentCounterInput {
 	status: InviteCompletionStatus
 	noBlob: Boolean
 	description: [CalendarItemInviteComponentDescriptionInput]
-	draft: Boolean
+	draft: Boolean,
+	seq: Int
 }
 
 type CalendarItemAttendee {
@@ -2437,11 +2455,13 @@ type CalendarItemAttendee {
 	address: String
 	name: String
 	calendarUserType: String
+	isGroup: Boolean
 }
 
 type CalendarItemReply {
 	participationStatus: ParticipationStatus
 	address: String
+	isGroup: Boolean
 }
 
 input CalendarItemAttendeesInput {
@@ -2777,6 +2797,11 @@ input PreferencesInput {
 	zimbraPrefPrimaryTwoFactorAuthMethod: String
 	zimbraPrefDeleteInviteOnReply: Boolean
 	zimbraPrefMailDeliveryStatusNotification: Boolean
+	zimbraPrefImapEnabled: Boolean
+	zimbraPrefPop3Enabled: Boolean
+	zimbraPrefPop3DownloadSince: String
+	zimbraPrefPop3IncludeSpam: Boolean
+	zimbraPrefPop3DeleteOption: Pop3DeleteOption
 }
 
 input ModifyIdentityInput {
@@ -3150,7 +3175,8 @@ input NameIdInput {
 	name: String
 }
 input InstanceDate {
-	date: String
+	date: String,
+	timezone: String
 }
 input DeleteAppointmentInput {
 	instanceDate: InstanceDate
@@ -3691,6 +3717,7 @@ type Mutation {
 		tagNames: String
 		name: String
 		isLocal: Boolean
+		isBatchOperation: Boolean
 		recursive: Boolean
 		destFolderLocal: Boolean
 	): Boolean
@@ -3715,13 +3742,14 @@ type Mutation {
 		content: String
 		contentType: String
 	): ProfileImageChangeResponse
-	checkCalendar(id: ID!, value: Boolean!): Boolean
+	checkCalendar(id: ID!, value: Boolean!): ActionOpResponse
 	contactAction(
 		id: ID
 		ids: [ID!]
 		folderId: ID
 		op: String!
 		tagNames: String
+		isBatchOperation: Boolean
 	): ActionOpResponse
 	conversationAction(ids: [ID!]!, op: String!): Boolean
 	counterAppointment(
@@ -3784,6 +3812,7 @@ type Mutation {
 		op: String!
 		tagNames: String
 		name: String
+		isBatchOperation: Boolean
 	): Boolean
 	importExternalAccount(externalAccount: ExternalAccountImportInput!): Boolean
 	logout: Boolean

package/src/schema/schema.ts

@@ -2,6 +2,7 @@ import { makeExecutableSchema } from '@graphql-tools/schema';
 import mapValues from 'lodash/mapValues';
 
 import {
+	ActionOpResponse,
 	AddMsgInput,
 	CalendarItemInput,
 	CounterAppointmentInput,
@@ -281,7 +282,7 @@ export function createZimbraSchema(options: ZimbraSchemaOptions): {
 					client.createMountpoint(variables as CreateMountpointInput),
 				deleteAppointment: (_, { appointment }) =>
 					client.deleteAppointment(appointment as DeleteAppointmentInput),
-				checkCalendar: (_, variables) =>
+				checkCalendar: (_, variables): Promise<ActionOpResponse> =>
 					client.checkCalendar(variables as FolderActionCheckCalendarInput),
 				counterAppointment: (_, { counterAppointmentInvite }) =>
 					client.counterAppointment(counterAppointmentInvite as CounterAppointmentInput),