@zimbra/api-client 65.0.0 → 69.0.0

package/package.json

@@ -1,96 +1,94 @@
 {
-	"name": "@zimbra/api-client",
-	"amdName": "zmApiJsClient",
-	"version": "65.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",
-	"module": "dist/zm-api-js-client.esm.js",
-	"umd:main": "dist/zm-api-js-client.umd.js",
-	"types": "dist/index.d.ts",
-	"scripts": {
-		"generateSchemaTypes": "rimraf src/schema/generated-schema-types.ts && graphql-codegen",
-		"lint": "tslint --project .",
-		"lint:fix": "npm run lint -- --fix",
-		"test:unit": "BABEL_ENV=test mocha --require ./babelRegisterConfig.js test/**/*.js",
-		"test:watch": "npm run test:unit -- --watch",
-		"test:no-synacor-npm-refs": "node ./scripts/synacor-npm-refs.js",
-		"clean": "rimraf dist",
-		"build": "npm-run-all clean generateSchemaTypes rollup:* -p build:ts minify:* copySchema",
-		"build:ts": "tsc --emitDeclarationOnly --declaration --outDir \"dist\"",
-		"copySchema": "copyfiles -f src/schema/schema.graphql dist",
-		"rollup:cjs": "cross-var rollup -c rollup.config.js -m -f cjs -n $npm_package_amdName $npm_package_source -o $npm_package_main",
-		"rollup:umd": "cross-var rollup -c rollup.config.js -m -f umd -n $npm_package_amdName $npm_package_source -o $npm_package_umd_main",
-		"rollup:esm": "cross-var rollup -c rollup.config.js -m -f es --environment FORMAT:es -n $npm_package_amdName $npm_package_source -o $npm_package_module",
-		"linkedBuild": "npm run rollup:esm -- --watch",
-		"minify:cjs": "cross-var uglifyjs $npm_package_main -c pure_getters,pure_funcs=classCallCheck -m toplevel,reserved=['_createClass'] --keep-fnames -o $npm_package_main --source-map content=$npm_package_main.map,url=zm-api-js-client.js.map,filename=$npm_package_main.map",
-		"minify:umd": "cross-var uglifyjs $npm_package_umd_main -c pure_getters,pure_funcs=classCallCheck -m toplevel,reserved=['_createClass'] --keep-fnames -o $npm_package_umd_main --source-map content=$npm_package_umd_main.map,url=zm-api-js-client.umd.js.map,filename=$npm_package_umd_main.map",
-		"size": "echo \"Gzipped Size: $(gzip-size $npm_package_main | pretty-bytes)\"",
-		"prepublishOnly": "npm test && npm run build && git commit -am $npm_package_version && git tag $npm_package_version && git push && git push --tags",
-		"publish:beta": "npm publish --tag=beta",
-		"security:audit": "audit-ci --moderate --report-type summary --pass-enoaudit --skip-dev",
-		"prepare": "is-ci || husky install"
-	},
-	"keywords": [
-		"zimbra",
-		"api",
-		"graphql"
-	],
-	"repository": "Zimbra/zm-api-js-client",
-	"license": "BSD-3-Clause",
-	"tslintStaged": {
-		"tslintConfig": "tslint.json",
-		"include": [
-			"**/*.ts"
-		],
-		"exclude": []
-	},
-	"dependencies": {
-		"@apollo/client": "^3.2.1",
-		"dataloader": "^1.4.0",
-		"graphql": "^15.3.0",
-		"graphql-tools": "^7.0.4",
-		"lodash": "^4.17.21",
-		"mitt": "^2.1.0"
-	},
-	"devDependencies": {
-		"@babel/cli": "^7.12.1",
-		"@babel/core": "^7.12.3",
-		"@babel/plugin-proposal-class-properties": "^7.12.1",
-		"@babel/preset-env": "^7.12.1",
-		"@babel/preset-typescript": "^7.12.1",
-		"@babel/register": "^7.12.1",
-		"@graphql-codegen/cli": "^1.21.4",
-		"@graphql-codegen/typescript": "^1.22.0",
-		"@rollup/plugin-babel": "^5.2.1",
-		"@rollup/plugin-commonjs": "^15.1.0",
-		"@rollup/plugin-node-resolve": "^9.0.0",
-		"@rollup/plugin-typescript": "^6.0.0",
-		"@types/graphql": "^14.5.0",
-		"@types/lodash": "^4.14.162",
-		"@types/node": "^14.14.2",
-		"@types/whatwg-fetch": "^0.0.33",
-		"audit-ci": "^4.1.0",
-		"babel-plugin-lodash": "^3.3.4",
-		"chai": "^4.2.0",
-		"copyfiles": "^2.4.1",
-		"cross-var": "^1.1.0",
-		"file-matcher": "^1.3.0",
-		"husky": "^6.0.0",
-		"is-ci": "^3.0.0",
-		"mocha": "^8.3.2",
-		"npm-run-all": "^4.1.5",
-		"prettier": "^2.3.1",
-		"rimraf": "^3.0.2",
-		"rollup": "^2.32.1",
-		"rollup-plugin-graphql": "^0.1.0",
-		"rollup-plugin-local-resolve": "^1.0.7",
-		"tslib": "^2.0.3",
-		"tslint": "^5.20.1",
-		"tslint-config-prettier": "^1.18.0",
-		"tslint-plugin-prettier": "^2.3.0",
-		"tslint-staged": "^0.1.3",
-		"typescript": "^4.0.3",
-		"uglify-js": "^3.12.1"
-	}
+  "name": "@zimbra/api-client",
+  "amdName": "zmApiJsClient",
+  "version": "69.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",
+  "module": "dist/zm-api-js-client.esm.js",
+  "umd:main": "dist/zm-api-js-client.umd.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "generateSchemaTypes": "rimraf src/schema/generated-schema-types.ts && graphql-codegen",
+    "lint": "tslint --project .",
+    "lint:fix": "npm run lint -- --fix",
+    "test:unit": "BABEL_ENV=test mocha --require ./babelRegisterConfig.js test/**/*.js",
+    "test:watch": "npm run test:unit -- --watch",
+    "test:no-synacor-npm-refs": "node ./scripts/synacor-npm-refs.js",
+    "clean": "rimraf dist",
+    "build": "npm-run-all clean generateSchemaTypes rollup:* -p build:ts minify:* copySchema",
+    "build:ts": "tsc --emitDeclarationOnly --declaration --outDir \"dist\"",
+    "copySchema": "copyfiles -f src/schema/schema.graphql dist",
+    "rollup:cjs": "cross-var rollup -c rollup.config.js -m -f cjs -n $npm_package_amdName $npm_package_source -o $npm_package_main",
+    "rollup:umd": "cross-var rollup -c rollup.config.js -m -f umd -n $npm_package_amdName $npm_package_source -o $npm_package_umd_main",
+    "rollup:esm": "cross-var rollup -c rollup.config.js -m -f es --environment FORMAT:es -n $npm_package_amdName $npm_package_source -o $npm_package_module",
+    "linkedBuild": "npm run rollup:esm -- --watch",
+    "minify:cjs": "cross-var uglifyjs $npm_package_main -c pure_getters,pure_funcs=classCallCheck -m toplevel,reserved=['_createClass'] --keep-fnames -o $npm_package_main --source-map content=$npm_package_main.map,url=zm-api-js-client.js.map,filename=$npm_package_main.map",
+    "minify:umd": "cross-var uglifyjs $npm_package_umd_main -c pure_getters,pure_funcs=classCallCheck -m toplevel,reserved=['_createClass'] --keep-fnames -o $npm_package_umd_main --source-map content=$npm_package_umd_main.map,url=zm-api-js-client.umd.js.map,filename=$npm_package_umd_main.map",
+    "size": "echo \"Gzipped Size: $(gzip-size $npm_package_main | pretty-bytes)\"",
+    "prepublishOnly": "npm test && npm run build && git commit -am $npm_package_version && git tag $npm_package_version && git push && git push --tags",
+    "publish:beta": "npm publish --tag=beta",
+    "security:audit": "audit-ci --moderate --report-type summary --pass-enoaudit --skip-dev",
+    "prepare": "is-ci || husky install"
+  },
+  "keywords": [
+    "zimbra",
+    "api",
+    "graphql"
+  ],
+  "repository": "Zimbra/zm-api-js-client",
+  "license": "BSD-3-Clause",
+  "lint-staged": {
+    "**/*.ts": [
+      "tslint"
+    ]
+  },
+  "dependencies": {
+    "@apollo/client": "^3.4.16",
+    "dataloader": "^2.0.0",
+    "graphql": "^15.6.1",
+    "graphql-tools": "^8.2.0",
+    "lodash": "^4.17.21",
+    "mitt": "^3.0.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.15.7",
+    "@babel/core": "^7.15.8",
+    "@babel/plugin-proposal-class-properties": "^7.14.5",
+    "@babel/preset-env": "^7.15.8",
+    "@babel/preset-typescript": "^7.15.0",
+    "@babel/register": "^7.15.3",
+    "@graphql-codegen/cli": "^2.2.0",
+    "@graphql-codegen/typescript": "^2.2.2",
+    "@rollup/plugin-babel": "^5.3.0",
+    "@rollup/plugin-commonjs": "^21.0.0",
+    "@rollup/plugin-node-resolve": "^13.0.5",
+    "@rollup/plugin-typescript": "^8.2.5",
+    "@types/graphql": "^14.5.0",
+    "@types/lodash": "^4.14.175",
+    "@types/node": "^16.10.3",
+    "@types/whatwg-fetch": "^0.0.33",
+    "audit-ci": "^4.1.0",
+    "babel-plugin-lodash": "^3.3.4",
+    "chai": "^4.3.4",
+    "copyfiles": "^2.4.1",
+    "cross-var": "^1.1.0",
+    "file-matcher": "^1.3.0",
+    "husky": "^7.0.2",
+    "is-ci": "^3.0.0",
+    "lint-staged": "^11.2.0",
+    "mocha": "^9.1.2",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.4.1",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.58.0",
+    "rollup-plugin-graphql": "^0.1.0",
+    "rollup-plugin-local-resolve": "^1.0.7",
+    "tslib": "^2.3.1",
+    "tslint": "^5.20.1",
+    "tslint-config-prettier": "^1.18.0",
+    "tslint-plugin-prettier": "^2.3.0",
+    "typescript": "^4.4.3",
+    "uglify-js": "^3.14.2"
+  }
 }

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

@@ -127,7 +127,7 @@ export class OfflineQueueLink extends ApolloLink {
 	// Returns a Promise that resolves after all operations are processed
 	// regardless of success.
 	retry = () =>
-		new Promise(resolve => {
+		new Promise<void>(resolve => {
 			let outstandingReqs = this.operationQueue.length;
 			if (!outstandingReqs) {
 				return resolve();

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

@@ -20,6 +20,9 @@ const dataIdFromObject = (object: any) => {
 			// `zwc:implicit`.
 			return dataIdFromPath(object, 'meta.0.section');
 		case 'Folder':
+			if (object.local && object.local !== null) {
+				return `${defaultDataIdFromObject(object)}:local`;
+			}
 			if (object.id === '1') {
 				// Cache the root folder based on both ID and UUID from server
 				return `${object.__typename}:${object.id}:${object.uuid}`;
@@ -52,6 +55,39 @@ const typePolicies = {
 				merge: true
 			}
 		}
+	},
+	Contact: {
+		fields: {
+			attributes: {
+				merge: true
+			}
+		}
+	},
+	Conversation: {
+		fields: {
+			messages: {
+				// @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
+			},
+			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
+			}
+		}
+	},
+	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
+			}
+		}
 	}
 };
 

package/src/batch-client/index.ts

@@ -280,6 +280,7 @@ export class ZimbraBatchClient {
 	private authToken?: string;
 	private batchDataLoader: DataLoader<RequestOptions, RequestBody>;
 	private csrfToken?: string;
+	private customFetch: any;
 	private dataLoader: DataLoader<RequestOptions, RequestBody>;
 	private jwtToken?: string;
 	private sessionHandler?: SessionHandler;
@@ -294,6 +295,7 @@ export class ZimbraBatchClient {
 		this.origin = options.zimbraOrigin !== undefined ? options.zimbraOrigin : DEFAULT_HOSTNAME;
 		this.soapPathname = options.soapPathname || DEFAULT_SOAP_PATHNAME;
 		this.localStoreClient = options.localStoreClient;
+		this.customFetch = options.customFetch;
 
 		this.notifier = new Notifier();
 
@@ -308,8 +310,8 @@ export class ZimbraBatchClient {
 			cache: false
 		});
 
-		if (options.customFetch) {
-			setCustomFetch(options.customFetch);
+		if (this.customFetch) {
+			setCustomFetch(this.customFetch);
 		}
 	}
 
@@ -433,6 +435,9 @@ export class ZimbraBatchClient {
 			return ids ? ids.split(',') : [];
 		});
 
+	// For offline Drafts
+	public attach = (files: any, message: any) => this.localStoreClient.attach({ files, message });
+
 	public autoComplete = (options: AutoCompleteOptions) =>
 		this.jsonRequest({
 			name: 'AutoComplete',
@@ -1301,7 +1306,7 @@ export class ZimbraBatchClient {
 		password,
 		recoveryCode,
 		tokenType,
-		persistAuthTokenCookie = true,
+		persistAuthTokenCookie,
 		twoFactorCode,
 		deviceTrusted,
 		csrfTokenSecured
@@ -1758,20 +1763,23 @@ export class ZimbraBatchClient {
 		const filename = 'message.eml';
 		const contentType = 'message/rfc822';
 
-		return fetch(`${this.origin}/service/upload?fmt=raw`, {
+		return (this.customFetch || fetch)(`${this.origin}/service/upload?fmt=raw`, {
 			method: 'POST',
 			body: message,
 			headers: {
 				'Content-Disposition': `${contentDisposition}; filename="${filename}"`,
 				'Content-Type': contentType,
+				...(this.authToken && {
+					Cookie: `ZM_AUTH_TOKEN=${this.authToken}`
+				}),
 				...(this.csrfToken && {
 					'X-Zimbra-Csrf-Token': this.csrfToken
 				})
 			},
 			credentials: 'include'
-		}).then(response => {
+		}).then((response: any) => {
 			if (response.ok) {
-				return response.text().then(result => {
+				return response.text().then((result: any) => {
 					if (!result) {
 						return null;
 					}
@@ -1792,7 +1800,7 @@ export class ZimbraBatchClient {
 		});
 	};
 
-	private batchDataHandler = (requests: Array<RequestOptions>) =>
+	private batchDataHandler = (requests: ReadonlyArray<RequestOptions>) =>
 		batchJsonRequest({
 			requests,
 			...this.getAdditionalRequestOptions()
@@ -1829,7 +1837,7 @@ export class ZimbraBatchClient {
 		}
 	};
 
-	private dataHandler = (requests: Array<JsonRequestOptions>) =>
+	private dataHandler = (requests: ReadonlyArray<JsonRequestOptions>) =>
 		jsonRequest({
 			...requests[0],
 			// check if login request then don't add csrfToken

package/src/batch-client/types.ts

@@ -193,6 +193,7 @@ export interface SearchOptions {
 	fullConversation?: boolean;
 	inDumpster?: boolean;
 	limit?: number;
+	name?: string;
 	needExp?: boolean;
 	needIsMember?: NeedIsMemberType;
 	needIsOwner?: boolean;
@@ -202,7 +203,6 @@ export interface SearchOptions {
 	sortBy?: SortBy;
 	type?: GalSearchType;
 	types?: SearchType;
-	name?: string;
 }
 
 export interface SearchCalendarResourcesCondition {

package/src/request/index.ts

@@ -54,7 +54,7 @@ function _responseParseHandler(response: Response): Promise<ParsedResponse> {
 			return response;
 		});
 	} catch (e) {
-		(response as ParsedResponse).parseError = e;
+		(response as ParsedResponse).parseError = <any>e;
 		return Promise.resolve(response);
 	}
 }
@@ -97,7 +97,7 @@ function faultError(response: ParsedResponse, faults: any) {
  * Create one key per SOAP command name, with a value
  * containing an array of the requests for that command.
  */
-function batchBody(requests: Array<RequestOptions>) {
+function batchBody(requests: ReadonlyArray<RequestOptions>) {
 	return reduce(
 		requests,
 		(body: { [key: string]: any }, request) => {

package/src/request/types.ts

@@ -39,7 +39,7 @@ export interface RequestOptions {
 export interface JsonRequestOptions extends BaseRequestOptions, RequestOptions {}
 
 export interface BatchRequestOptions extends BaseRequestOptions {
-	requests: Array<RequestOptions>;
+	requests: ReadonlyArray<RequestOptions>;
 }
 
 export interface RequestResponse {