@zimbra/api-client 103.0.1-master.e2fc2e1.0 → 103.0.1-master.f5b7ef4.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zimbra/api-client",
   "amdName": "zmApiJsClient",
-  "version": "103.0.1-master.e2fc2e1.0",
+  "version": "103.0.1-master.f5b7ef4.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",

package/src/batch-client/index.ts

@@ -125,6 +125,7 @@ import {
 	AutoCompleteGALOptions,
 	AutoCompleteOptions,
 	ChangePasswordOptions,
+	CheckSpellingOptions,
 	CreateFolderOptions,
 	CreateSearchFolderOptions,
 	DiscoverRightOptions,
@@ -141,6 +142,7 @@ import {
 	GetMessageOptions,
 	GetSMimePublicCertsOptions,
 	LoginOptions,
+	Misspelled,
 	ModifyProfileImageOptions,
 	NoOpOptions,
 	RecoverAccountOptions,
@@ -2123,6 +2125,29 @@ export class ZimbraBatchClient {
 		});
 	};
 
+	public checkSpelling = ({ text, ignore }: CheckSpellingOptions) =>
+		this.jsonRequest({
+			name: 'CheckSpelling',
+			body: { _content: text, ignore: ignore?.join(',') }
+		}).then(response => ({
+			available: response.available,
+			misspelled: (response.misspelled || []).map((m: Misspelled) => ({
+				word: m.word,
+				suggestions: (m.suggestions || '').split(',').filter(Boolean)
+			}))
+		}));
+
+	public addToSpellCheckDictionary = (word: string) => {
+		return this.jsonRequest({
+			name: 'ModifyPrefs',
+			namespace: Namespace.Account,
+			body: {
+				_attrs: { '+zimbraPrefSpellIgnoreWord': word }
+			},
+			singleRequest: true
+		}).then(Boolean);
+	};
+
 	private batchDataHandler = (requests: ReadonlyArray<RequestOptions>) =>
 		batchJsonRequest({
 			requests,

package/src/batch-client/types.ts

@@ -378,3 +378,13 @@ export interface DiscoverRightInput {
 export interface DiscoverRightOptions {
 	right: Array<DiscoverRightInput>;
 }
+
+export interface CheckSpellingOptions {
+	text: string;
+	ignore?: Array<string>;
+}
+
+export interface Misspelled {
+	word: string;
+	suggestions: string;
+}

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

@@ -66,6 +66,7 @@ export type AccountInfo = {
   cos?: Maybe<AccountCos>;
   habRoots?: Maybe<HabRoots>;
   id: Scalars['ID']['output'];
+  isSpellCheckAvailable?: Maybe<Scalars['Boolean']['output']>;
   license?: Maybe<License>;
   name?: Maybe<Scalars['String']['output']>;
   pasteitcleanedEnabled?: Maybe<Scalars['Boolean']['output']>;
@@ -854,6 +855,12 @@ export type CancelRuleInfo = {
   tz?: Maybe<Scalars['String']['output']>;
 };
 
+export type CheckSpellingResponse = {
+  __typename?: 'CheckSpellingResponse';
+  available?: Maybe<Scalars['Boolean']['output']>;
+  misspelled?: Maybe<Array<Maybe<Misspelling>>>;
+};
+
 export type ClientInfoAttributes = {
   __typename?: 'ClientInfoAttributes';
   zimbraClassicWebClientDisabled?: Maybe<Scalars['Boolean']['output']>;
@@ -2599,6 +2606,12 @@ export type MimePartInput = {
   url?: InputMaybe<Scalars['String']['input']>;
 };
 
+export type Misspelling = {
+  __typename?: 'Misspelling';
+  suggestions?: Maybe<Array<Maybe<Scalars['String']['output']>>>;
+  word?: Maybe<Scalars['String']['output']>;
+};
+
 export enum Mode {
   Html = 'html',
   Text = 'text'
@@ -2668,6 +2681,7 @@ export type Mutation = {
   action?: Maybe<Scalars['Boolean']['output']>;
   addExternalAccount?: Maybe<Scalars['ID']['output']>;
   addMessage?: Maybe<MessageInfo>;
+  addToSpellCheckDictionary?: Maybe<Scalars['Boolean']['output']>;
   allowDeviceSync?: Maybe<Device>;
   applyFilterRules?: Maybe<Array<Maybe<Scalars['String']['output']>>>;
   blockDeviceSync?: Maybe<Device>;
@@ -2798,6 +2812,11 @@ export type MutationAddMessageArgs = {
 };
 
 
+export type MutationAddToSpellCheckDictionaryArgs = {
+  word: Scalars['String']['input'];
+};
+
+
 export type MutationAllowDeviceSyncArgs = {
   deviceId?: InputMaybe<Scalars['String']['input']>;
 };
@@ -3523,6 +3542,7 @@ export type Preferences = {
   zimbraPrefMailSendReadReceipts?: Maybe<PrefMailSendReadReceipts>;
   zimbraPrefMailToasterEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraPrefMailTrustedSenderList?: Maybe<Array<Maybe<Scalars['String']['output']>>>;
+  zimbraPrefMandatorySpellCheckEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraPrefMarkMsgRead?: Maybe<Scalars['Int']['output']>;
   zimbraPrefMessageViewHtmlPreferred?: Maybe<Scalars['Boolean']['output']>;
   zimbraPrefOutOfOfficeExternalReply?: Maybe<Scalars['String']['output']>;
@@ -3549,6 +3569,7 @@ export type Preferences = {
   zimbraPrefShowFragments?: Maybe<Scalars['Boolean']['output']>;
   zimbraPrefSlackCalendarReminderEnabled?: Maybe<Scalars['Boolean']['output']>;
   zimbraPrefSortOrder?: Maybe<Scalars['String']['output']>;
+  zimbraPrefSpellDictionary?: Maybe<Scalars['String']['output']>;
   zimbraPrefTagTreeOpen?: Maybe<Scalars['Boolean']['output']>;
   zimbraPrefTimeZoneId?: Maybe<Scalars['String']['output']>;
   zimbraPrefUseTimeZoneListInCalendar?: Maybe<Scalars['Boolean']['output']>;
@@ -3596,6 +3617,7 @@ export type PreferencesInput = {
   zimbraPrefMailSendReadReceipts?: InputMaybe<PrefMailSendReadReceipts>;
   zimbraPrefMailToasterEnabled?: InputMaybe<Scalars['Boolean']['input']>;
   zimbraPrefMailTrustedSenderList?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
+  zimbraPrefMandatorySpellCheckEnabled?: InputMaybe<Scalars['Boolean']['input']>;
   zimbraPrefMarkMsgRead?: InputMaybe<Scalars['Int']['input']>;
   zimbraPrefMessageViewHtmlPreferred?: InputMaybe<Scalars['Boolean']['input']>;
   zimbraPrefOutOfOfficeExternalReply?: InputMaybe<Scalars['String']['input']>;
@@ -3660,6 +3682,7 @@ export type Query = {
   accountInfo?: Maybe<AccountInfo>;
   autoComplete?: Maybe<AutoCompleteResponse>;
   autoCompleteGAL?: Maybe<AutoCompleteGalResponse>;
+  checkSpelling?: Maybe<CheckSpellingResponse>;
   clientInfo?: Maybe<ClientInfoType>;
   discoverRights?: Maybe<DiscoverRights>;
   downloadAttachment?: Maybe<Attachment>;
@@ -3731,6 +3754,12 @@ export type QueryAutoCompleteGalArgs = {
 };
 
 
+export type QueryCheckSpellingArgs = {
+  ignore?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
+  text: Scalars['String']['input'];
+};
+
+
 export type QueryClientInfoArgs = {
   by?: InputMaybe<Scalars['String']['input']>;
   domain?: InputMaybe<Scalars['String']['input']>;

package/src/schema/schema.graphql

@@ -1399,6 +1399,7 @@ type AccountInfo {
 	cos: AccountCos
 	pasteitcleanedEnabled: Boolean
 	adminDelegated: Boolean
+	isSpellCheckAvailable: Boolean
 }
 
 type OnlyEmailAddress {
@@ -1670,6 +1671,8 @@ type Preferences {
 	zimbraPrefComposeDirection: String
 	zimbraPrefComposeFormat: Mode
 	zimbraPrefForwardReplyInOriginalFormat: Boolean
+	zimbraPrefMandatorySpellCheckEnabled: Boolean
+	zimbraPrefSpellDictionary: String
 	zimbraPrefHtmlEditorDefaultFontColor: String
 	zimbraPrefHtmlEditorDefaultFontFamily: String
 	zimbraPrefHtmlEditorDefaultFontSize: String
@@ -2764,6 +2767,7 @@ input PreferencesInput {
 	zimbraPrefComposeDirection: String
 	zimbraPrefComposeFormat: Mode
 	zimbraPrefForwardReplyInOriginalFormat: Boolean
+	zimbraPrefMandatorySpellCheckEnabled: Boolean
 	zimbraPrefExternalSendersType: ExternalSendersType
 	zimbraPrefHtmlEditorDefaultFontColor: String
 	zimbraPrefHtmlEditorDefaultFontFamily: String
@@ -3531,6 +3535,16 @@ input DiscoverRightInput {
 	_content: String
 }
 
+type Misspelling {
+	word: String
+	suggestions: [String]
+}
+
+type CheckSpellingResponse {
+	available: Boolean
+	misspelled: [Misspelling]
+}
+
 # Zimbra GraphQL Queries
 # - [[SOAP API Reference]](https://files.zimbra.com/docs/soap_api/8.7.11/api-reference/index.html)
 # - [[SOAP Documentation]](https://github.com/Zimbra/zm-mailbox/blob/develop/store/docs/soap.txt)
@@ -3724,6 +3738,11 @@ type Query {
 	taskFolders: [Folder]
 
 	getTag: [Tag]
+
+	checkSpelling(
+		text: String!
+		ignore: [String]
+	): CheckSpellingResponse
 }
 
 type Mutation {
@@ -3937,6 +3956,7 @@ type Mutation {
 	subscribeDistributionList(op: String!, by: String, dl: String!): String
 	distributionListAction(dlActions: DistributionListActionInput!): Boolean
 	bounceMessage(message: RedirectMessgeInput): Boolean
+	addToSpellCheckDictionary(word: String!): Boolean
 }
 
 schema {

package/src/schema/schema.ts

@@ -57,6 +57,7 @@ import {
 	AutoCompleteGALOptions,
 	AutoCompleteOptions,
 	ChangePasswordOptions,
+	CheckSpellingOptions,
 	ClientInfoInput,
 	CreateFolderOptions,
 	CreateSearchFolderOptions,
@@ -212,7 +213,8 @@ export function createZimbraSchema(options: ZimbraSchemaOptions): {
 				taskFolders: client.taskFolders,
 				getWhiteBlackList: client.getWhiteBlackList,
 				getAppSpecificPasswords: client.getAppSpecificPasswords,
-				getTag: client.getTag
+				getTag: client.getTag,
+				checkSpelling: (_, variables) => client.checkSpelling(variables as CheckSpellingOptions)
 			},
 			//resolveType is necessary to differentiate for any Union or Interfaces
 			MailItem: {
@@ -457,7 +459,8 @@ export function createZimbraSchema(options: ZimbraSchemaOptions): {
 				subscribeDistributionList: (_, { op, by, dl }) =>
 					client.subscribeDistributionList(op, by, dl),
 				distributionListAction: (_, { dlActions }) =>
-					client.distributionListAction(dlActions as DistributionListActionInput)
+					client.distributionListAction(dlActions as DistributionListActionInput),
+				addToSpellCheckDictionary: (_, { word }) => client.addToSpellCheckDictionary(word)
 			}
 		}
 	});