@internxt/sdk 1.13.2 → 1.14.2

package/dist/index.d.ts

@@ -7,3 +7,4 @@ export * as Workspaces from './workspaces';
 export * from './meet';
 export * as Payments from './payments';
 export * from './misc';
+export * from './mail';

package/dist/index.js

@@ -47,3 +47,4 @@ exports.Workspaces = __importStar(require("./workspaces"));
 __exportStar(require("./meet"), exports);
 exports.Payments = __importStar(require("./payments"));
 __exportStar(require("./misc"), exports);
+__exportStar(require("./mail"), exports);

package/dist/mail/index.d.ts

@@ -0,0 +1,132 @@
+import { ApiSecurity, ApiUrl, AppDetails } from '../shared';
+import { EncryptedKeystore, KeystoreType, PrivateKeys, HybridEncryptedEmail, PwdProtectedEmail, EmailKeys, Email, UserWithPublicKeys } from 'internxt-crypto';
+export declare class Mail {
+    private readonly client;
+    private readonly appDetails;
+    private readonly apiSecurity;
+    private readonly apiUrl;
+    static client(apiUrl: ApiUrl, appDetails: AppDetails, apiSecurity: ApiSecurity): Mail;
+    private constructor();
+    /**
+     * Uploads encrypted keystore to the server
+     *
+     * @param encryptedKeystore - The encrypted keystore
+     * @returns Server response
+     */
+    uploadKeystoreToServer(encryptedKeystore: EncryptedKeystore): Promise<void>;
+    /**
+     * Creates recovery and encryption keystores and uploads them to the server
+     *
+     * @param userEmail - The email of the user
+     * @param baseKey - The secret key of the user
+     * @returns The recovery codes for opening recovery keystore
+     */
+    createAndUploadKeystores(userEmail: string, baseKey: Uint8Array): Promise<string>;
+    /**
+     * Requests encrypted keystore from the server
+     *
+     * @param userEmail - The email of the user
+     * @param keystoreType - The type of the keystore
+     * @returns The encrypted keystore
+     */
+    downloadKeystoreFromServer(userEmail: string, keystoreType: KeystoreType): Promise<EncryptedKeystore>;
+    /**
+     * Requests encrypted keystore from the server and opens it
+     *
+     * @param userEmail - The email of the user
+     * @param baseKey - The secret key of the user
+     * @returns The email keys of the user
+     */
+    getUserEmailKeys(userEmail: string, baseKey: Uint8Array): Promise<EmailKeys>;
+    /**
+     * Requests recovery keystore from the server and opens it
+     *
+     * @param userEmail - The email of the user
+     * @param recoveryCodes - The recovery codes of the user
+     * @returns The email keys of the user
+     */
+    recoverUserEmailKeys(userEmail: string, recoveryCodes: string): Promise<EmailKeys>;
+    /**
+     * Request user with corresponding public keys from the server
+     *
+     * @param userEmail - The email of the user
+     * @returns User with corresponding public keys
+     */
+    getUserWithPublicKeys(userEmail: string): Promise<UserWithPublicKeys>;
+    /**
+     * Request users with corresponding public keys from the server
+     *
+     * @param emails - The emails of the users
+     * @returns Users with corresponding public keys
+     */
+    getSeveralUsersWithPublicKeys(emails: string[]): Promise<UserWithPublicKeys[]>;
+    /**
+     * Sends the encrypted email to the server
+     *
+     * @param email - The encrypted email
+     * @returns Server response
+     */
+    sendEncryptedEmail(email: HybridEncryptedEmail): Promise<void>;
+    /**
+     * Encrypts email and sends it to the server
+     *
+     * @param email - The message to encrypt
+     * @param senderPrivateKeys - The private keys of the sender
+     * @param isSubjectEncrypted - Indicates if the subject field should be encrypted
+     * @returns Server response
+     */
+    encryptAndSendEmail(email: Email, senderPrivateKeys: PrivateKeys, isSubjectEncrypted?: boolean): Promise<void>;
+    /**
+     * Sends the encrypted emails for multiple recipients to the server
+     *
+     * @param emails - The encrypted emails
+     * @returns Server response
+     */
+    sendEncryptedEmailToMultipleRecipients(emails: HybridEncryptedEmail[]): Promise<void>;
+    /**
+     * Encrypts emails for multiple recipients and sends emails to the server
+     *
+     * @param email - The message to encrypt
+     * @param senderPrivateKeys - The private keys of the sender
+     * @param isSubjectEncrypted - Indicates if the subject field should be encrypted
+     * @returns Server response
+     */
+    encryptAndSendEmailToMultipleRecipients(email: Email, senderPrivateKeys: PrivateKeys, isSubjectEncrypted?: boolean): Promise<void>;
+    /**
+     * Sends the password-protected email to the server
+     *
+     * @param email - The password-protected email
+     * @returns Server response
+     */
+    sendPasswordProtectedEmail(email: PwdProtectedEmail): Promise<void>;
+    /**
+     * Creates the password-protected email and sends it to the server
+     *
+     * @param email - The email
+     * @param pwd - The password
+     * @param isSubjectEncrypted - Indicates if the subject field should be encrypted
+     * @returns Server response
+     */
+    passwordProtectAndSendEmail(email: Email, pwd: string, isSubjectEncrypted?: boolean): Promise<void>;
+    /**
+     * Opens the password-protected email
+     *
+     * @param email - The password-protected email
+     * @param pwd - The shared password
+     * @returns The decrypted email
+     */
+    openPasswordProtectedEmail(email: PwdProtectedEmail, pwd: string): Promise<Email>;
+    /**
+     * Decrypt the email
+     *
+     * @param email - The encrypted email
+     * @param recipientPrivateKeys - The private keys of the email recipient
+     * @returns The decrypted email
+     */
+    decryptEmail(email: HybridEncryptedEmail, recipientPrivateKeys: PrivateKeys): Promise<Email>;
+    /**
+     * Returns the needed headers for the module requests
+     * @private
+     */
+    private headers;
+}

package/dist/mail/index.js

@@ -0,0 +1,379 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Mail = void 0;
+var headers_1 = require("../shared/headers");
+var client_1 = require("../shared/http/client");
+var internxt_crypto_1 = require("internxt-crypto");
+var Mail = /** @class */ (function () {
+    function Mail(apiUrl, appDetails, apiSecurity) {
+        this.client = client_1.HttpClient.create(apiUrl, apiSecurity.unauthorizedCallback);
+        this.appDetails = appDetails;
+        this.apiSecurity = apiSecurity;
+        this.apiUrl = apiUrl;
+    }
+    Mail.client = function (apiUrl, appDetails, apiSecurity) {
+        return new Mail(apiUrl, appDetails, apiSecurity);
+    };
+    /**
+     * Uploads encrypted keystore to the server
+     *
+     * @param encryptedKeystore - The encrypted keystore
+     * @returns Server response
+     */
+    Mail.prototype.uploadKeystoreToServer = function (encryptedKeystore) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.client.post("".concat(this.apiUrl, "/keystore"), { encryptedKeystore: encryptedKeystore }, this.headers())];
+            });
+        });
+    };
+    /**
+     * Creates recovery and encryption keystores and uploads them to the server
+     *
+     * @param userEmail - The email of the user
+     * @param baseKey - The secret key of the user
+     * @returns The recovery codes for opening recovery keystore
+     */
+    Mail.prototype.createAndUploadKeystores = function (userEmail, baseKey) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, encryptionKeystore, recoveryKeystore, recoveryCodes;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, (0, internxt_crypto_1.createEncryptionAndRecoveryKeystores)(userEmail, baseKey)];
+                    case 1:
+                        _a = _b.sent(), encryptionKeystore = _a.encryptionKeystore, recoveryKeystore = _a.recoveryKeystore, recoveryCodes = _a.recoveryCodes;
+                        return [4 /*yield*/, Promise.all([this.uploadKeystoreToServer(encryptionKeystore), this.uploadKeystoreToServer(recoveryKeystore)])];
+                    case 2:
+                        _b.sent();
+                        return [2 /*return*/, recoveryCodes];
+                }
+            });
+        });
+    };
+    /**
+     * Requests encrypted keystore from the server
+     *
+     * @param userEmail - The email of the user
+     * @param keystoreType - The type of the keystore
+     * @returns The encrypted keystore
+     */
+    Mail.prototype.downloadKeystoreFromServer = function (userEmail, keystoreType) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.client.getWithParams("".concat(this.apiUrl, "/user/keystore"), { userEmail: userEmail, keystoreType: keystoreType }, this.headers())];
+            });
+        });
+    };
+    /**
+     * Requests encrypted keystore from the server and opens it
+     *
+     * @param userEmail - The email of the user
+     * @param baseKey - The secret key of the user
+     * @returns The email keys of the user
+     */
+    Mail.prototype.getUserEmailKeys = function (userEmail, baseKey) {
+        return __awaiter(this, void 0, void 0, function () {
+            var keystore;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.downloadKeystoreFromServer(userEmail, internxt_crypto_1.KeystoreType.ENCRYPTION)];
+                    case 1:
+                        keystore = _a.sent();
+                        return [2 /*return*/, (0, internxt_crypto_1.openEncryptionKeystore)(keystore, baseKey)];
+                }
+            });
+        });
+    };
+    /**
+     * Requests recovery keystore from the server and opens it
+     *
+     * @param userEmail - The email of the user
+     * @param recoveryCodes - The recovery codes of the user
+     * @returns The email keys of the user
+     */
+    Mail.prototype.recoverUserEmailKeys = function (userEmail, recoveryCodes) {
+        return __awaiter(this, void 0, void 0, function () {
+            var keystore;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.downloadKeystoreFromServer(userEmail, internxt_crypto_1.KeystoreType.RECOVERY)];
+                    case 1:
+                        keystore = _a.sent();
+                        return [2 /*return*/, (0, internxt_crypto_1.openRecoveryKeystore)(recoveryCodes, keystore)];
+                }
+            });
+        });
+    };
+    /**
+     * Request user with corresponding public keys from the server
+     *
+     * @param userEmail - The email of the user
+     * @returns User with corresponding public keys
+     */
+    Mail.prototype.getUserWithPublicKeys = function (userEmail) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response, singleResponse, publicKeys, result;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.client.post("".concat(this.apiUrl, "/users/public-keys"), { emails: [userEmail] }, this.headers())];
+                    case 1:
+                        response = _a.sent();
+                        if (!response[0])
+                            throw new Error("No public keys found for ".concat(userEmail));
+                        singleResponse = response[0];
+                        return [4 /*yield*/, (0, internxt_crypto_1.base64ToPublicKey)(singleResponse.publicKeys)];
+                    case 2:
+                        publicKeys = _a.sent();
+                        result = __assign(__assign({}, singleResponse.user), { publicKeys: publicKeys });
+                        return [2 /*return*/, result];
+                }
+            });
+        });
+    };
+    /**
+     * Request users with corresponding public keys from the server
+     *
+     * @param emails - The emails of the users
+     * @returns Users with corresponding public keys
+     */
+    Mail.prototype.getSeveralUsersWithPublicKeys = function (emails) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response, result;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.client.post("".concat(this.apiUrl, "/users/public-keys"), { emails: emails }, this.headers())];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, Promise.all(response.map(function (item) { return __awaiter(_this, void 0, void 0, function () {
+                                var publicKeys;
+                                return __generator(this, function (_a) {
+                                    switch (_a.label) {
+                                        case 0: return [4 /*yield*/, (0, internxt_crypto_1.base64ToPublicKey)(item.publicKeys)];
+                                        case 1:
+                                            publicKeys = _a.sent();
+                                            return [2 /*return*/, __assign(__assign({}, item.user), { publicKeys: publicKeys })];
+                                    }
+                                });
+                            }); }))];
+                    case 2:
+                        result = _a.sent();
+                        return [2 /*return*/, result];
+                }
+            });
+        });
+    };
+    /**
+     * Sends the encrypted email to the server
+     *
+     * @param email - The encrypted email
+     * @returns Server response
+     */
+    Mail.prototype.sendEncryptedEmail = function (email) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.client.post("".concat(this.apiUrl, "/emails"), { emails: [email] }, this.headers())];
+            });
+        });
+    };
+    /**
+     * Encrypts email and sends it to the server
+     *
+     * @param email - The message to encrypt
+     * @param senderPrivateKeys - The private keys of the sender
+     * @param isSubjectEncrypted - Indicates if the subject field should be encrypted
+     * @returns Server response
+     */
+    Mail.prototype.encryptAndSendEmail = function (email_1, senderPrivateKeys_1) {
+        return __awaiter(this, arguments, void 0, function (email, senderPrivateKeys, isSubjectEncrypted) {
+            var recipient, encEmail;
+            if (isSubjectEncrypted === void 0) { isSubjectEncrypted = false; }
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getUserWithPublicKeys(email.params.recipient.email)];
+                    case 1:
+                        recipient = _a.sent();
+                        return [4 /*yield*/, (0, internxt_crypto_1.encryptEmailHybrid)(email, recipient, senderPrivateKeys, isSubjectEncrypted)];
+                    case 2:
+                        encEmail = _a.sent();
+                        return [2 /*return*/, this.sendEncryptedEmail(encEmail)];
+                }
+            });
+        });
+    };
+    /**
+     * Sends the encrypted emails for multiple recipients to the server
+     *
+     * @param emails - The encrypted emails
+     * @returns Server response
+     */
+    Mail.prototype.sendEncryptedEmailToMultipleRecipients = function (emails) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.client.post("".concat(this.apiUrl, "/emails"), { emails: emails }, this.headers())];
+            });
+        });
+    };
+    /**
+     * Encrypts emails for multiple recipients and sends emails to the server
+     *
+     * @param email - The message to encrypt
+     * @param senderPrivateKeys - The private keys of the sender
+     * @param isSubjectEncrypted - Indicates if the subject field should be encrypted
+     * @returns Server response
+     */
+    Mail.prototype.encryptAndSendEmailToMultipleRecipients = function (email_1, senderPrivateKeys_1) {
+        return __awaiter(this, arguments, void 0, function (email, senderPrivateKeys, isSubjectEncrypted) {
+            var recipientEmails, recipients, encEmails;
+            if (isSubjectEncrypted === void 0) { isSubjectEncrypted = false; }
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        recipientEmails = email.params.recipients
+                            ? email.params.recipients.map(function (user) { return user.email; })
+                            : [email.params.recipient.email];
+                        return [4 /*yield*/, this.getSeveralUsersWithPublicKeys(recipientEmails)];
+                    case 1:
+                        recipients = _a.sent();
+                        return [4 /*yield*/, (0, internxt_crypto_1.encryptEmailHybridForMultipleRecipients)(email, recipients, senderPrivateKeys, isSubjectEncrypted)];
+                    case 2:
+                        encEmails = _a.sent();
+                        return [2 /*return*/, this.sendEncryptedEmailToMultipleRecipients(encEmails)];
+                }
+            });
+        });
+    };
+    /**
+     * Sends the password-protected email to the server
+     *
+     * @param email - The password-protected email
+     * @returns Server response
+     */
+    Mail.prototype.sendPasswordProtectedEmail = function (email) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.client.post("".concat(this.apiUrl, "/emails"), { email: email }, this.headers())];
+            });
+        });
+    };
+    /**
+     * Creates the password-protected email and sends it to the server
+     *
+     * @param email - The email
+     * @param pwd - The password
+     * @param isSubjectEncrypted - Indicates if the subject field should be encrypted
+     * @returns Server response
+     */
+    Mail.prototype.passwordProtectAndSendEmail = function (email_1, pwd_1) {
+        return __awaiter(this, arguments, void 0, function (email, pwd, isSubjectEncrypted) {
+            var encEmail;
+            if (isSubjectEncrypted === void 0) { isSubjectEncrypted = false; }
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, internxt_crypto_1.createPwdProtectedEmail)(email, pwd, isSubjectEncrypted)];
+                    case 1:
+                        encEmail = _a.sent();
+                        return [2 /*return*/, this.sendPasswordProtectedEmail(encEmail)];
+                }
+            });
+        });
+    };
+    /**
+     * Opens the password-protected email
+     *
+     * @param email - The password-protected email
+     * @param pwd - The shared password
+     * @returns The decrypted email
+     */
+    Mail.prototype.openPasswordProtectedEmail = function (email, pwd) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, (0, internxt_crypto_1.decryptPwdProtectedEmail)(email, pwd)];
+            });
+        });
+    };
+    /**
+     * Decrypt the email
+     *
+     * @param email - The encrypted email
+     * @param recipientPrivateKeys - The private keys of the email recipient
+     * @returns The decrypted email
+     */
+    Mail.prototype.decryptEmail = function (email, recipientPrivateKeys) {
+        return __awaiter(this, void 0, void 0, function () {
+            var senderEmail, sender;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        senderEmail = email.params.sender.email;
+                        return [4 /*yield*/, this.getUserWithPublicKeys(senderEmail)];
+                    case 1:
+                        sender = _a.sent();
+                        return [2 /*return*/, (0, internxt_crypto_1.decryptEmailHybrid)(email, sender.publicKeys, recipientPrivateKeys)];
+                }
+            });
+        });
+    };
+    /**
+     * Returns the needed headers for the module requests
+     * @private
+     */
+    Mail.prototype.headers = function () {
+        return (0, headers_1.headersWithToken)({
+            clientName: this.appDetails.clientName,
+            clientVersion: this.appDetails.clientVersion,
+            token: this.apiSecurity.token,
+            desktopToken: this.appDetails.desktopHeader,
+            customHeaders: this.appDetails.customHeaders,
+        });
+    };
+    return Mail;
+}());
+exports.Mail = Mail;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@internxt/sdk",
   "author": "Internxt <hello@internxt.com>",
-  "version": "1.13.2",
+  "version": "1.14.2",
   "description": "An sdk for interacting with Internxt's services",
   "repository": {
     "type": "git",
@@ -44,7 +44,9 @@
   },
   "dependencies": {
     "axios": "1.13.5",
-    "uuid": "13.0.0"
+    "uuid": "13.0.0",
+    "internxt-crypto": "0.0.13"
+  
   },
   "lint-staged": {
     "*.{js,jsx,tsx,ts}": [