@zimbra/api-client 90.0.0 → 92.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zimbra/api-client",
   "amdName": "zmApiJsClient",
-  "version": "90.0.0",
+  "version": "92.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",
@@ -37,6 +37,9 @@
     "graphql"
   ],
   "repository": "Zimbra/zm-api-js-client",
+  "engines": {
+    "node": ">=18.12.0"
+  },
   "license": "BSD-3-Clause",
   "lint-staged": {
     "**/*.ts": [
@@ -47,7 +50,7 @@
     "@apollo/client": "3.4.16",
     "@graphql-tools/schema": "^10.0.3",
     "dataloader": "^2.2.2",
-    "graphql": "^15.8.0",
+    "graphql": "^16.9.0",
     "lodash": "^4.17.21",
     "mitt": "^3.0.0"
   },
@@ -75,7 +78,7 @@
     "cross-var": "^1.1.0",
     "husky": "^8.0.3",
     "is-ci": "^3.0.1",
-    "lint-staged": "13.2.3",
+    "lint-staged": "15.2.8",
     "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.6.2",

package/src/apollo/local-batch-link.ts

@@ -24,17 +24,17 @@ export class LocalBatchLink extends ApolloLink {
 				let emittedResponse = false;
 				Promise.all(
 					operations.map((operation: Operation) => {
-						const query = print(operation.query);
 						const { operationName, variables = {} } = operation;
+						const params = {
+							schema: this.schema,
+							source: print(operation.query),
+							rootValue: null,
+							contextValue: operation.getContext() || options.context || {},
+							variableValues: variables,
+							operationName: operationName
+						};
 
-						return graphql(
-							this.schema,
-							query,
-							null,
-							operation.getContext() || options.context || {},
-							variables,
-							operationName
-						);
+						return graphql(params);
 					})
 				)
 					.then((results: FetchResult[]) => {

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

@@ -103,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';
@@ -171,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);
@@ -948,13 +952,14 @@ export class ZimbraBatchClient {
 			singleRequest: true
 		}).then(Boolean);
 
-	public freeBusy = ({ start, end, names }: FreeBusyOptions) =>
+	public freeBusy = ({ start, end, names, excludeUid }: FreeBusyOptions) =>
 		this.jsonRequest({
 			name: 'GetFreeBusy',
 			body: {
 				s: start,
 				e: end,
-				name: names.join(',')
+				name: names.join(','),
+				...(excludeUid && { excludeUid })
 			}
 		}).then(res => normalize(FreeBusy)(res.usr));
 

package/src/batch-client/types.ts

@@ -75,6 +75,7 @@ export interface ZimbraClientOptions {
 
 export interface FreeBusyOptions {
 	end: number;
+	excludeUid: string;
 	names: Array<string>;
 	start: number;
 }

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

@@ -124,6 +124,7 @@ export type AccountInfoAttrs = {
   zimbraFeatureRelatedContactsEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraFeatureResetPasswordStatus?: Maybe<ResetPasswordStatus>;
   zimbraFeatureRetentionPolicyEnabled?: Maybe<Scalars['Boolean']['output']>;
+  zimbraFeatureSharedFolderMobileSyncEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraFeatureSharingEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraFeatureTaggingEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraFeatureTasksEnabled?: Maybe<Scalars['Boolean']['output']>;
@@ -837,8 +838,11 @@ export type CancelRuleInfo = {
 
 export type ClientInfoAttributes = {
   __typename?: 'ClientInfoAttributes';
+  zimbraClassicWebClientDisabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraFeatureResetPasswordStatus?: Maybe<ResetPasswordStatus>;
   zimbraHelpModernURL?: Maybe<Scalars['String']['output']>;
+  zimbraSkinLogoAppBanner?: Maybe<Scalars['String']['output']>;
+  zimbraSkinLogoLoginBanner?: Maybe<Scalars['String']['output']>;
   zimbraWebClientLoginURL?: Maybe<Scalars['String']['output']>;
   zimbraWebClientLogoutURL?: Maybe<Scalars['String']['output']>;
   zimbraWebClientSkipLogoff?: Maybe<Scalars['Boolean']['output']>;
@@ -1089,6 +1093,7 @@ export enum ContactType {
 
 export type Conversation = MailItem & {
   __typename?: 'Conversation';
+  _attrs?: Maybe<Array<Maybe<CustomHeader>>>;
   changeDate?: Maybe<Scalars['Float']['output']>;
   conversationId?: Maybe<Scalars['ID']['output']>;
   date?: Maybe<Scalars['Float']['output']>;
@@ -1185,6 +1190,12 @@ export type Cursor = {
   sortVal?: InputMaybe<Scalars['String']['input']>;
 };
 
+export type CustomHeader = {
+  __typename?: 'CustomHeader';
+  key?: Maybe<Scalars['String']['output']>;
+  value?: Maybe<Scalars['String']['output']>;
+};
+
 export type CustomMetadata = {
   __typename?: 'CustomMetadata';
   meta?: Maybe<Array<Maybe<CustomMetadataMeta>>>;
@@ -2043,6 +2054,11 @@ export type HeaderConditionInput = {
   valueComparison?: InputMaybe<Scalars['String']['input']>;
 };
 
+export type HeaderInput = {
+  _content?: InputMaybe<Scalars['String']['input']>;
+  name?: InputMaybe<Scalars['String']['input']>;
+};
+
 export type Hit = {
   __typename?: 'Hit';
   id?: Maybe<Scalars['String']['output']>;
@@ -2433,6 +2449,7 @@ export type MessageAttributes = {
 
 export type MessageInfo = MailItem & {
   __typename?: 'MessageInfo';
+  _attrs?: Maybe<Array<Maybe<CustomHeader>>>;
   attachments?: Maybe<Array<Maybe<MimePart>>>;
   attributes?: Maybe<MessageAttributes>;
   autoSendTime?: Maybe<Scalars['Float']['output']>;
@@ -2575,6 +2592,7 @@ export type ModifyZimletPrefsResponse = {
 
 export type MsgWithGroupInfo = MailItem & {
   __typename?: 'MsgWithGroupInfo';
+  _attrs?: Maybe<Array<Maybe<CustomHeader>>>;
   autoSendTime?: Maybe<Scalars['Float']['output']>;
   changeDate?: Maybe<Scalars['Float']['output']>;
   cif?: Maybe<Scalars['String']['output']>;
@@ -3491,6 +3509,7 @@ export type PreferencesInput = {
   zimbraPrefComposeFormat?: InputMaybe<Mode>;
   zimbraPrefDefaultCalendarId?: InputMaybe<Scalars['ID']['input']>;
   zimbraPrefDelegatedSendSaveTarget?: InputMaybe<PrefDelegatedSendSaveTarget>;
+  zimbraPrefDeleteInviteOnReply?: InputMaybe<Scalars['Boolean']['input']>;
   zimbraPrefDisplayExternalImages?: InputMaybe<Scalars['Boolean']['input']>;
   zimbraPrefDisplayTimeInMailList?: InputMaybe<Scalars['Boolean']['input']>;
   zimbraPrefExternalSendersType?: InputMaybe<ExternalSendersType>;
@@ -3670,6 +3689,7 @@ export type QueryDownloadMessageArgs = {
 
 export type QueryFreeBusyArgs = {
   end?: InputMaybe<Scalars['Float']['input']>;
+  excludeUid?: InputMaybe<Scalars['String']['input']>;
   names: Array<Scalars['String']['input']>;
   start?: InputMaybe<Scalars['Float']['input']>;
 };
@@ -3866,6 +3886,7 @@ export type QuerySearchArgs = {
   cursor?: InputMaybe<Cursor>;
   fetch?: InputMaybe<Scalars['String']['input']>;
   fullConversation?: InputMaybe<Scalars['Boolean']['input']>;
+  header?: InputMaybe<Array<InputMaybe<MailItemHeaderInput>>>;
   inDumpster?: InputMaybe<Scalars['Boolean']['input']>;
   limit?: InputMaybe<Scalars['Int']['input']>;
   memberOf?: InputMaybe<Scalars['Boolean']['input']>;
@@ -4187,6 +4208,7 @@ export enum SearchType {
   Document = 'document',
   Message = 'message',
   Task = 'task',
+  Unknown = 'unknown',
   Wiki = 'wiki'
 }
 
@@ -4205,6 +4227,7 @@ export type SendMessageInput = {
   entityId?: InputMaybe<Scalars['String']['input']>;
   flags?: InputMaybe<Scalars['String']['input']>;
   folderId?: InputMaybe<Scalars['ID']['input']>;
+  header?: InputMaybe<Array<InputMaybe<HeaderInput>>>;
   id?: InputMaybe<Scalars['ID']['input']>;
   inReplyTo?: InputMaybe<Scalars['String']['input']>;
   inlineAttachments?: InputMaybe<Array<InputMaybe<MimePartInput>>>;
@@ -4248,6 +4271,7 @@ export enum SetRecoveryAccountOp {
 
 export type ShareInfo = {
   __typename?: 'ShareInfo';
+  activeSyncDisabled?: Maybe<Scalars['Boolean']['output']>;
   folderId: Scalars['ID']['output'];
   folderPath?: Maybe<Scalars['String']['output']>;
   folderUuid?: Maybe<Scalars['String']['output']>;

package/src/schema/schema.graphql

@@ -202,6 +202,7 @@ enum SearchType {
 	task
 	wiki
 	document
+	unknown
 }
 
 enum ContactType {
@@ -510,6 +511,9 @@ type ClientInfoAttributes {
 	zimbraWebClientSkipLogoff: Boolean
 	zimbraFeatureResetPasswordStatus: ResetPasswordStatus
 	zimbraHelpModernURL: String
+	zimbraClassicWebClientDisabled: Boolean
+	zimbraSkinLogoLoginBanner: String
+	zimbraSkinLogoAppBanner: String
 }
 
 type ClientInfoType {
@@ -560,6 +564,7 @@ type MessageInfo implements MailItem {
 	local: Boolean
 	part: String
 	meta: [CustomMetadataMeta]
+	_attrs: [CustomHeader]
 }
 
 type Conversation implements MailItem {
@@ -588,6 +593,7 @@ type Conversation implements MailItem {
 	subscribe: [DLSubscribe] # dlSub
 	replyType: String #rt
 	meta: [CustomMetadataMeta]
+	_attrs: [CustomHeader]
 }
 
 type MsgWithGroupInfo implements MailItem {
@@ -604,6 +610,7 @@ type MsgWithGroupInfo implements MailItem {
 	folderId: ID # l
 	subject: String # su
 	emailAddresses: [EmailAddress]
+	_attrs: [CustomHeader]
 	excerpt: String # fr
 	conversationId: ID # cid
 	flags: String # f
@@ -1478,6 +1485,7 @@ type AccountInfoAttrs {
 	zimbraFeatureFiltersEnabled: Boolean
 	zimbraFeatureReadReceiptsEnabled: Boolean
 	zimbraFeatureSharingEnabled: Boolean
+	zimbraFeatureSharedFolderMobileSyncEnabled: Boolean
 	zimbraFeatureManageZimlets: Boolean
 	zimbraFeatureTwoFactorAuthAvailable: Boolean
 	zimbraFeatureTwoFactorAuthRequired: Boolean
@@ -1782,6 +1790,11 @@ type SaveDraftResponse {
 	message: [MessageInfo]
 }
 
+type CustomHeader {
+	key: String
+	value: String
+}
+
 type CustomMetadataAttrs {
 	key: String
 	value: String
@@ -2072,6 +2085,7 @@ type ShareInfo {
 	rights: String
 	view: FolderView
 	mid: ID
+	activeSyncDisabled: Boolean
 }
 
 type MailboxMetadataAttrs {
@@ -2305,6 +2319,12 @@ input SendMessageInput {
 	emailAddresses: [MailItemEmailAddressInput] #e
 	attachments: [AttachmentInput] #attach
 	inlineAttachments: [MimePartInput] #attach
+	header: [HeaderInput] #header
+}
+
+input HeaderInput {
+	name: String #name
+	_content: String #value
 }
 
 input SaveSMimeCertInputUpload {
@@ -2727,6 +2747,7 @@ input PreferencesInput {
 	zimbraPrefPowerPasteEnabled: Boolean
 	zimbraPrefDisplayTimeInMailList: Boolean
 	zimbraPrefPrimaryTwoFactorAuthMethod: String
+	zimbraPrefDeleteInviteOnReply: Boolean
 }
 
 input ModifyIdentityInput {
@@ -3455,7 +3476,7 @@ type Query {
 	downloadDocument(id: ID!, url: String!): Attachment
 	listDocumentRevisions(id: ID!, version: Int!, count: Int!): Document
 	discoverRights(right: [DiscoverRightInput!]!): DiscoverRights
-	freeBusy(names: [String!]!, start: Float, end: Float): [FreeBusy]
+	freeBusy(names: [String!]!, start: Float, end: Float, excludeUid: String): [FreeBusy]
 	getContact(
 		id: ID
 		ids: [ID!]
@@ -3594,7 +3615,8 @@ type Query {
 		sortBy: SortBy
 		types: SearchType
 		resultMode: String
-		inDumpster: Boolean
+		inDumpster: Boolean,
+		header: [MailItemHeaderInput]
 	): SearchResponse
 
 	searchCalendarResources(

package/src/utils/normalize-attrs-custommetadata.ts

@@ -29,3 +29,12 @@ export function normalizeCustomMetaDataAttrs(data: any) {
 		_attrs: attrs
 	};
 }
+
+export function normalizeHeaderAttrs(data: any) {
+	let attrs: any = [];
+
+	Object.keys(data).forEach(
+		key => typeof data[key] === 'string' && attrs.push({ key, value: data[key] })
+	);
+	return attrs;
+}