@zimbra/api-client 102.0.0 → 102.0.1-PREAPPS-9707.9e46b27.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zimbra/api-client",
   "amdName": "zmApiJsClient",
-  "version": "102.0.0",
+  "version": "102.0.1-PREAPPS-9707.9e46b27.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,
@@ -2121,6 +2123,18 @@ 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)
+			}))
+		}));
+
 	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

@@ -853,6 +853,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']>;
@@ -2598,6 +2604,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'
@@ -3659,6 +3671,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>;
@@ -3730,6 +3743,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

@@ -3530,6 +3530,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)
@@ -3723,6 +3733,11 @@ type Query {
 	taskFolders: [Folder]
 
 	getTag: [Tag]
+
+	checkSpelling(
+		text: String!
+		ignore: [String]
+	): CheckSpellingResponse
 }
 
 type Mutation {

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: {