@zimbra/api-client 78.0.0-beta → 80.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zimbra/api-client",
   "amdName": "zmApiJsClient",
-  "version": "78.0.0-beta",
+  "version": "80.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",
@@ -46,7 +46,7 @@
     "@apollo/client": "^3.4.16",
     "dataloader": "^2.1.0",
     "graphql": "^15.8.0",
-    "graphql-tools": "^8.2.8",
+    "graphql-tools": "^8.2.9",
     "lodash": "^4.17.21",
     "mitt": "^3.0.0"
   },
@@ -58,21 +58,21 @@
     "@babel/preset-typescript": "^7.16.7",
     "@babel/register": "^7.17.7",
     "@graphql-codegen/cli": "^2.6.2",
-    "@graphql-codegen/typescript": "^2.4.10",
+    "@graphql-codegen/typescript": "^2.4.11",
     "@rollup/plugin-babel": "^5.3.1",
     "@rollup/plugin-commonjs": "^22.0.0",
     "@rollup/plugin-node-resolve": "^13.3.0",
     "@rollup/plugin-typescript": "^8.3.2",
     "@types/graphql": "^14.5.0",
     "@types/lodash": "^4.14.182",
-    "@types/node": "^17.0.31",
+    "@types/node": "^17.0.32",
     "@types/whatwg-fetch": "^0.0.33",
     "audit-ci": "^6.2.0",
     "babel-plugin-lodash": "^3.3.4",
     "chai": "^4.3.6",
     "copyfiles": "^2.4.1",
     "cross-var": "^1.1.0",
-    "husky": "^8.0.0",
+    "husky": "^8.0.1",
     "is-ci": "^3.0.1",
     "lint-staged": "^12.4.1",
     "mocha": "^10.0.0",
@@ -87,6 +87,6 @@
     "tslint-config-prettier": "^1.18.0",
     "tslint-plugin-prettier": "^2.3.0",
     "typescript": "^4.6.4",
-    "uglify-js": "^3.15.4"
+    "uglify-js": "^3.15.5"
   }
 }

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

@@ -1,4 +1,4 @@
-import { ApolloLink, FetchResult, Observable, Operation } from '@apollo/client';
+import { ApolloLink, FetchResult, Observable, Operation } from '@apollo/client/core';
 import { BatchLink } from '@apollo/client/link/batch';
 import { graphql, print } from 'graphql';
 import events from 'mitt';

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

@@ -1,4 +1,11 @@
-import { ApolloLink, FetchResult, NextLink, Observable, Observer, Operation } from '@apollo/client';
+import {
+	ApolloLink,
+	FetchResult,
+	NextLink,
+	Observable,
+	Observer,
+	Operation
+} from '@apollo/client/core';
 
 import { SyncOfflineOperations } from '../sync-offline-operations';
 import { OfflineQueueLinkOptions, OperationEntry, StorageProvider } from './types';

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

@@ -1,5 +1,4 @@
-import { FetchResult, NextLink, Operation } from '@apollo/client';
-import { Observer } from '@apollo/client';
+import { FetchResult, NextLink, Observer, Operation } from '@apollo/client/core';
 
 export interface OfflineQueueLinkOptions {
 	isOpen?: boolean;

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

@@ -1,4 +1,4 @@
-import { Operation } from '@apollo/client';
+import { Operation } from '@apollo/client/core';
 import get from 'lodash/get';
 import { OfflineOperationEntry, OperationEntry } from './types';
 

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

@@ -1,4 +1,4 @@
-import { defaultDataIdFromObject, InMemoryCache, InMemoryCacheConfig } from '@apollo/client';
+import { defaultDataIdFromObject, InMemoryCache, InMemoryCacheConfig } from '@apollo/client/core';
 import get from 'lodash/get';
 
 const dataIdFromPath = (result: any, path: string) => {
@@ -43,6 +43,8 @@ const dataIdFromObject = (object: any) => {
 			return defaultDataIdFromObject(object);
 		case 'SMimeMessage':
 			return `${defaultDataIdFromObject(object)}:${object.isSecure}`;
+		case 'Document':
+			return `${defaultDataIdFromObject(object)}:${object.version}`;
 		default:
 			return defaultDataIdFromObject(object);
 	}

package/src/batch-client/index.ts

@@ -37,6 +37,7 @@ import {
 	GetRightsRequest,
 	HabGroup,
 	InviteReply,
+	ListDocumentRevisions,
 	MessageInfo,
 	SaveDocument,
 	SaveDocuments,
@@ -541,7 +542,7 @@ export class ZimbraBatchClient {
 			},
 			singleRequest: true,
 			namespace: Namespace.Account
-		}).then(res => normalize(ClientInfoResponse)(res));
+		}).then(res => normalize(ClientInfoResponse)(mapValuesDeep(res, coerceStringToBoolean)));
 
 	public contactAction = (options: ActionOptions) => this.action(ActionType.contact, options);
 
@@ -682,8 +683,7 @@ export class ZimbraBatchClient {
 		this.jsonRequest({
 			name: 'CreateSignature',
 			namespace: Namespace.Account,
-			body: denormalize(CreateSignatureRequest)(options),
-			singleRequest: true
+			body: denormalize(CreateSignatureRequest)(options)
 		});
 
 	public createTag = (tag: CreateTagInput) =>
@@ -850,6 +850,41 @@ export class ZimbraBatchClient {
 			singleRequest: true
 		});
 
+	public endSessionBeaconRequest = (options: JsonRequestOptions) => {
+		const body = {
+			Body: {
+				EndSessionRequest: {
+					_jsns: Namespace.Account
+				}
+			},
+			Header: {
+				context: {
+					_jsns: Namespace.All,
+					csrfToken: this.csrfToken,
+					account: {
+						by: 'name',
+						_content: options.accountName
+					},
+					session: {
+						id: this.sessionId,
+						_content: this.sessionId
+					},
+					userAgent: this.userAgent
+				}
+			}
+		};
+
+		try {
+			const blob = new Blob([JSON.stringify(body)]);
+			if (navigator) {
+				// In zimbra desktop client navigator is null
+				navigator.sendBeacon(`${this.origin}/service/soap`, blob);
+			}
+		} catch (e) {
+			throw new Error('Error on endSessionBeaconRequest request' + e);
+		}
+	};
+
 	public folderAction = (options: ActionOptions) => this.action(ActionType.folder, options);
 
 	public forwardAppointment = (body: ForwardAppointmentInput) =>
@@ -1318,6 +1353,33 @@ export class ZimbraBatchClient {
 		// If account name is present that means we will not be able to batch requests
 		this[options.singleRequest ? 'dataLoader' : 'batchDataLoader'].load(options);
 
+	public listDocumentRevisions = ({ id, version, count }: any) =>
+		this.jsonRequest({
+			name: 'ListDocumentRevisions',
+			namespace: Namespace.Mail,
+			body: {
+				doc: {
+					id,
+					ver: version,
+					count
+				}
+			}
+		}).then(response => {
+			const data = normalize(ListDocumentRevisions)(response);
+			const versionIds = data.documents.map((doc: any) => doc.version);
+			const maxVersion = Math.max(...versionIds);
+			const latestDocumentVersion = data.documents.find((doc: any) => doc.version === maxVersion);
+			const versionDocuments = data.documents.map((versionDoc: any) => ({
+				...versionDoc,
+				name: latestDocumentVersion.name
+			}));
+
+			return {
+				...latestDocumentVersion,
+				docs: versionDocuments
+			};
+		});
+
 	public login = ({
 		username,
 		password,
@@ -1525,6 +1587,20 @@ export class ZimbraBatchClient {
 			fetchOptions
 		}).then(resp => resp);
 
+	public purgeRevision = ({ id, ver, includeOlderRevisions }: any) =>
+		this.jsonRequest({
+			name: 'PurgeRevision',
+			namespace: Namespace.Mail,
+			body: {
+				revision: {
+					id,
+					ver,
+					includeOlderRevisions
+				}
+			},
+			singleRequest: true
+		}).then(Boolean);
+
 	public quarantineDeviceSync = (deviceId: String) =>
 		this.jsonRequest({
 			name: 'QuarantineDevice',
@@ -1594,7 +1670,7 @@ export class ZimbraBatchClient {
 				cancelResetPassword
 			},
 			singleRequest: true
-		});
+		}).then(res => mapValuesDeep(res, coerceStringToBoolean));
 
 	public resolve = (path: string) => `${this.origin}${path}`;
 

package/src/normalize/entities.ts

@@ -524,6 +524,10 @@ export const Document = new Entity({
 	f: 'flags'
 });
 
+export const ListDocumentRevisions = new Entity({
+	doc: ['documents', Document]
+});
+
 export const MessagePartInputForDocuments = new Entity({
 	id: 'messageId',
 	part: 'attachmentPart'
@@ -535,7 +539,8 @@ export const SaveDocument = new Entity({
 	ver: 'version', //same item may have different versions (i.e same names) will need to implement ListDocumentRevisionsRequest
 	ct: 'contentType',
 	descEnabled: 'descriptionEnabled',
-	m: ['messageData', MessagePartInputForDocuments]
+	m: ['messageData', MessagePartInputForDocuments],
+	doc: ['document', Document]
 });
 
 export const SearchResponse = new Entity({

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

@@ -127,7 +127,9 @@ export type AccountInfoAttrs = {
   zimbraMailAttachmentMaxSize?: Maybe<Scalars['Float']>;
   zimbraMailBlacklistMaxNumEntries?: Maybe<Scalars['Int']>;
   zimbraMailQuota?: Maybe<Scalars['String']>;
+  zimbraMailSignatureMaxLength?: Maybe<Scalars['Float']>;
   zimbraMtaMaxMessageSize?: Maybe<Scalars['Float']>;
+  zimbraPasswordAllowUsername?: Maybe<Scalars['Boolean']>;
   zimbraPasswordAllowedChars?: Maybe<Scalars['String']>;
   zimbraPasswordAllowedPunctuationChars?: Maybe<Scalars['String']>;
   zimbraPasswordBlockCommonEnabled?: Maybe<Scalars['Boolean']>;
@@ -793,6 +795,7 @@ export type ClientInfoAttributes = {
   zimbraFeatureResetPasswordStatus?: Maybe<ResetPasswordStatus>;
   zimbraWebClientLoginURL?: Maybe<Scalars['String']>;
   zimbraWebClientLogoutURL?: Maybe<Scalars['String']>;
+  zimbraWebClientSkipLogoff?: Maybe<Scalars['Boolean']>;
 };
 
 export type ClientInfoType = {
@@ -1270,6 +1273,7 @@ export type Document = {
   contentType?: Maybe<Scalars['String']>;
   date?: Maybe<Scalars['Float']>;
   descriptionEnabled?: Maybe<Scalars['Boolean']>;
+  docs?: Maybe<Array<Maybe<Document>>>;
   flags?: Maybe<Scalars['String']>;
   folderId?: Maybe<Scalars['ID']>;
   folderUuid?: Maybe<Scalars['String']>;
@@ -2451,6 +2455,7 @@ export type Mutation = {
   prefOutOfOfficeFromDate?: Maybe<Scalars['String']>;
   prefOutOfOfficeReply?: Maybe<Scalars['String']>;
   prefOutOfOfficeUntilDate?: Maybe<Scalars['String']>;
+  purgeRevision?: Maybe<Scalars['Boolean']>;
   quarantineDeviceSync?: Maybe<Device>;
   recoverAccount?: Maybe<RecoverAccount>;
   remoteWipeSync?: Maybe<Device>;
@@ -2873,6 +2878,13 @@ export type MutationPrefOutOfOfficeUntilDateArgs = {
 };
 
 
+export type MutationPurgeRevisionArgs = {
+  id: Scalars['ID'];
+  includeOlderRevisions?: InputMaybe<Scalars['Int']>;
+  ver: Scalars['Int'];
+};
+
+
 export type MutationQuarantineDeviceSyncArgs = {
   deviceId?: InputMaybe<Scalars['String']>;
 };
@@ -3272,6 +3284,12 @@ export type PropertiesInput = {
   zimlet: Scalars['String'];
 };
 
+export type PurgetRevisionInput = {
+  id: Scalars['ID'];
+  includeOlderRevisions?: InputMaybe<Scalars['Int']>;
+  ver: Scalars['Int'];
+};
+
 export type Query = {
   __typename?: 'Query';
   accountInfo?: Maybe<AccountInfo>;
@@ -3316,6 +3334,7 @@ export type Query = {
   getTrustedDevices?: Maybe<GetTrustedDevicesResponse>;
   getWhiteBlackList?: Maybe<WhiteBlackList>;
   getWorkingHours?: Maybe<Array<Maybe<WorkingHours>>>;
+  listDocumentRevisions?: Maybe<Document>;
   noop?: Maybe<NoOpResponse>;
   recoverAccount?: Maybe<RecoverAccount>;
   relatedContacts?: Maybe<Array<Maybe<RelatedContact>>>;
@@ -3528,6 +3547,13 @@ export type QueryGetWorkingHoursArgs = {
 };
 
 
+export type QueryListDocumentRevisionsArgs = {
+  count: Scalars['Int'];
+  id: Scalars['ID'];
+  version: Scalars['Int'];
+};
+
+
 export type QueryNoopArgs = {
   limitToOneBlocked?: InputMaybe<Scalars['Int']>;
   wait?: InputMaybe<Scalars['Int']>;
@@ -3769,6 +3795,7 @@ export type SaveDocumentInput = {
   action?: InputMaybe<SaveDocumentAction>;
   contentType?: InputMaybe<Scalars['String']>;
   descriptionEnabled?: InputMaybe<Scalars['Boolean']>;
+  document?: InputMaybe<SaveDocumentInput>;
   folderId?: InputMaybe<Scalars['ID']>;
   id?: InputMaybe<Scalars['ID']>;
   messageData?: InputMaybe<Array<InputMaybe<MessagePartForDocument>>>;

package/src/schema/schema.graphql

@@ -485,6 +485,7 @@ interface MailItem {
 type ClientInfoAttributes {
 	zimbraWebClientLoginURL: String
 	zimbraWebClientLogoutURL: String
+	zimbraWebClientSkipLogoff: Boolean
 	zimbraFeatureResetPasswordStatus: ResetPasswordStatus
 }
 
@@ -1309,6 +1310,7 @@ type AccountInfoAttrs {
 	zimbraFeatureMobileSyncEnabled: Boolean
 	zimbraFeatureRelatedContactsEnabled: Boolean
 	zimbraFeatureMailForwardingInFiltersEnabled: Boolean
+	zimbraPasswordAllowUsername: Boolean
 	zimbraPasswordBlockCommonEnabled: Boolean
 	zimbraPasswordMinAlphaChars: Int
 	zimbraPasswordMinNumericChars: Int
@@ -1352,6 +1354,7 @@ type AccountInfoAttrs {
 	zimbraMailAttachmentMaxSize: Float
 	zimbraMtaMaxMessageSize: Float
 	zimbraMailAlias: [String]
+	zimbraMailSignatureMaxLength: Float
 	zimbraFeatureTaggingEnabled: Boolean
 	zimbraIdentityMaxNumEntries: Int
 	zimbraFeatureIdentitiesEnabled: Boolean
@@ -1551,6 +1554,7 @@ type Document {
 	revisedCreationDate: Float #cd
 	lockOwnerId: ID #loid
 	flags: String #f
+	docs: [Document]
 }
 
 type SearchResponse {
@@ -2451,6 +2455,12 @@ input InviteReplyInput {
 	exceptId: InstanceDate
 }
 
+input PurgetRevisionInput {
+	id: ID! 
+	ver: Int!
+	includeOlderRevisions: Int
+}
+
 input PropertiesInput {
 	zimlet: String!
 	name: String!
@@ -2971,6 +2981,7 @@ input SaveDocumentInput {
 	descriptionEnabled: Boolean #descEnabled
 	action: SaveDocumentAction
 	type: SaveDocumentType
+	document: SaveDocumentInput
 }
 
 type SaveDocument {
@@ -3187,6 +3198,7 @@ type Query {
 	downloadMessage(id: ID!, isSecure: Boolean, isLocal: Boolean): SMimeMessage
 	downloadAttachment(id: ID!, part: ID!): Attachment
 	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]
 	getContact(
@@ -3490,6 +3502,7 @@ type Mutation {
 	modifyTask(task: CalendarItemInput!): Boolean
 	modifyWhiteBlackList(whiteBlackList: WhiteBlackListInput!): Boolean
 	moveTask(inviteId: ID!, destFolderId: ID!): String
+	purgeRevision(id: ID!, ver: Int!, includeOlderRevisions: Int): Boolean
 	prefEnableOutOfOfficeAlertOnLogin(value: Boolean!): Boolean
 	prefEnableOutOfOfficeReply(value: Boolean!): Boolean
 	prefOutOfOfficeFromDate(value: String!): String

package/src/schema/schema.ts

@@ -29,6 +29,7 @@ import {
 	NameIdInput,
 	PreferencesInput,
 	PropertiesInput,
+	PurgetRevisionInput,
 	RevokeRightsInput,
 	SaveSMimeCertInputUpload,
 	SearchFolderInput,
@@ -108,6 +109,7 @@ export function createZimbraSchema(options: ZimbraSchemaOptions): {
 				discoverRights: (_, variables) => client.discoverRights(variables as DiscoverRightOptions),
 				downloadAttachment: (_, variables) => client.downloadAttachment(variables),
 				downloadDocument: (_, variables) => client.downloadDocument(variables),
+				listDocumentRevisions: (_, variables) => client.listDocumentRevisions(variables),
 				downloadMessage: (_, variables, context = {}) => {
 					const { local } = context;
 
@@ -320,6 +322,7 @@ export function createZimbraSchema(options: ZimbraSchemaOptions): {
 					client.deleteExternalAccount(variables as ExternalAccountDeleteInput),
 				importExternalAccount: (_, { externalAccount }) =>
 					client.importExternalAccount(externalAccount as ExternalAccountImportInput),
+				purgeRevision: (_, variables) => client.purgeRevision(variables as PurgetRevisionInput),
 				prefEnableOutOfOfficeAlertOnLogin: (_, { value }) =>
 					client
 						.modifyPrefs({

package/src/schema/session-handler.ts

@@ -1,4 +1,4 @@
-import { gql } from '@apollo/client';
+import { gql } from '@apollo/client/core';
 import get from 'lodash/get';
 import { ZimbraInMemoryCache } from '../apollo/zimbra-in-memory-cache';
 import { ZimbraSessionOptions } from './types';