internxt-crypto 0.0.8-alpha → 0.0.10-alpha

package/dist/email-search.d.mts

@@ -0,0 +1,228 @@
+import { IDBPDatabase, DBSchema } from 'idb';
+import { StoredEmail, Email, MailCache, EmailSearchResult } from './types.mjs';
+import { Index } from 'flexsearch';
+
+type MailDB = IDBPDatabase<EncryptedSearchDB>;
+interface EncryptedSearchDB extends DBSchema {
+    email: {
+        key: string;
+        value: StoredEmail;
+        indexes: {
+            byTime: number[];
+        };
+    };
+}
+/**
+ * Opens IndexedDB database for the given user
+ *
+ * @param userID - The user ID
+ * @returns The database
+ */
+declare const openDatabase: (userID: string) => Promise<MailDB>;
+/**
+ * Closes the IndexedDB database
+ *
+ * @param esDB - The database
+ */
+declare const closeDatabase: (esDB: MailDB) => void;
+/**
+ * Deletes IndexedDB database for the given user
+ *
+ * @param userID - The user ID
+ * @returns The database
+ */
+declare const deleteDatabase: (userID: string) => Promise<void>;
+/**
+ * Derives database encryption key for the given user
+ *
+ * @param userID - The user ID
+ * @returns The symmetric CryptoKey for protecting database
+ */
+declare const deriveIndexKey: (baseKey: Uint8Array) => Promise<CryptoKey>;
+/**
+ * Encrypts the given email and stores it in the IndexedDB database
+ *
+ * @param newEmailToStore - The email for storing
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @param esDB - The database
+ */
+declare const encryptAndStoreEmail: (newEmailToStore: Email, indexKey: CryptoKey, esDB: MailDB) => Promise<void>;
+/**
+ * Encrypts the given set of emails and stores it in the IndexedDB database
+ *
+ * @param newEmailsToStore - The set of emails for storing
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @param esDB - The database
+ */
+declare const encryptAndStoreManyEmail: (newEmailsToStore: Email[], indexKey: CryptoKey, esDB: MailDB) => Promise<void>;
+/**
+ * Fetches the email from the database and decrypts it
+ *
+ * @param emailID - The email identifier
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @param encryptedEmail - The encrypted email
+ * @returns The decrypted email
+ */
+declare const getAndDecryptEmail: (emailID: string, indexKey: CryptoKey, esDB: MailDB) => Promise<Email>;
+/**
+ * Fetches all email from the database and decrypts them
+ *
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @param esDB - The database
+ * @returns The decrypted emails
+ */
+declare const getAndDecryptAllEmails: (indexKey: CryptoKey, esDB: MailDB) => Promise<Email[]>;
+/**
+ * Deletes the email from the database
+ *
+ * @param emailID - The email identifier
+ * @param esDB - The database
+ */
+declare const deleteEmail: (emailID: string, esDB: MailDB) => Promise<void>;
+/**
+ * Returns the number of stored email
+ *
+ * @param esDB - The database
+ * @returns The number of stored emails
+ */
+declare const getEmailCount: (esDB: MailDB) => Promise<number>;
+/**
+ * Removes the given number of oldests emails from the database
+ *
+ * @param emailsToDelete - The number of emails to delete
+ * @param esDB - The database
+ */
+declare const deleteOldestEmails: (emailsToDelete: number, esDB: MailDB) => Promise<void>;
+/**
+ * Enforces the maximum email number in the database
+ *
+ * @param esDB - The database
+ * @param max - The maximum allowed number of emails
+ */
+declare const enforceMaxEmailNumber: (esDB: MailDB, max: number) => Promise<void>;
+/**
+ * Fetches all emails from the database, decrypts them and sortes the results based on the creation time (newest first)
+ *
+ * @param esDB - The database
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @returns The number of stored emails
+ */
+declare const getAllEmailsSortedNewestFirst: (esDB: MailDB, indexKey: CryptoKey) => Promise<Email[]>;
+/**
+ * Fetches all emails from the database, decrypts them and sortes the results based on the creation time (oldest first)
+ *
+ * @param esDB - The database
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @returns The number of stored emails
+ */
+declare const getAllEmailsSortedOldestFirst: (esDB: MailDB, indexKey: CryptoKey) => Promise<Email[]>;
+/**
+ * Fetches a batch of emails from the database, decrypts them and sortes the results based on the creation time (newest first)
+ *
+ * @param esDB - The database
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @param batchSize - The size of the batch
+ * @param startCursor - The starting point (optional). If not given, starts from the beginning
+ * @returns The number of stored emails
+ */
+declare const getEmailBatch: (esDB: MailDB, indexKey: CryptoKey, batchSize: number, startCursor?: IDBValidKey) => Promise<{
+    emails: Email[];
+    nextCursor?: IDBValidKey;
+}>;
+
+/**
+ * Fetches all emails from the database in batches and cahces them
+ *
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @param esCache - The cache to add emails too
+ * @param esDB - The database
+ */
+declare const createCacheFromDB: (indexKey: CryptoKey, esDB: MailDB) => Promise<MailCache<Email>>;
+/**
+ * Gets an email from the cache
+ *
+ * @param emailID - The email identifier
+ * @param esCache - The email cache
+ * @returns The found email or throws an error
+ */
+declare const getEmailFromCache: (emailID: string, esCache: MailCache<Email>) => Promise<Email>;
+/**
+ * Removes the email from cache
+ *
+ * @param emailID - The email identifier
+ * @param esCache - The email cache
+ */
+declare const deleteEmailFromCache: (emailID: string, esCache: MailCache<Email>) => Promise<void>;
+/**
+ * Adds emails to the cache
+ *
+ * @param emails - The emails to add
+ * @param esCache - The email cache
+ * @returns TRUE if all emails were added sucessfully, or FALSE and error reason.
+ */
+declare function addEmailsToCache(emails: Email[], esCache: MailCache<Email>): {
+    success: boolean;
+    reason?: string;
+};
+/**
+ * Adds email to the cache
+ *
+ * @param email - The email to add
+ * @param esCache - The email cache
+ * @returns TRUE if the email was added sucessfully, or FALSE and error reason.
+ */
+declare const addEmailToCache: (email: Email, esCache: MailCache<Email>) => {
+    success: boolean;
+    reason?: string;
+};
+
+interface EmailSearchIndex {
+    subjectIndex: Index;
+    bodyIndex: Index;
+    fromIndex: Index;
+    toIndex: Index;
+    isReady: boolean;
+}
+/**
+ * Adds the given email to the email search index
+ *
+ * @param email - The email to add
+ * @param searchIndex - The email search index
+ */
+declare const addEmailToSearchIndex: (email: Email, searchIndex: EmailSearchIndex) => void;
+/**
+ * Removes the email from the email search index
+ *
+ * @param emailID - The email identifier
+ * @param searchIndex - The email search index
+ */
+declare const removeEmailFromSearchIndex: (emailID: string, searchIndex: EmailSearchIndex) => void;
+/**
+ * Buils the email search index from the email cache
+ *
+ * @param esCache - The email cache
+ * @returns  The email search index
+ */
+declare const buildSearchIndexFromCache: (esCache: MailCache<Email>) => Promise<EmailSearchIndex>;
+interface SearchOptions {
+    fields?: ('subject' | 'body' | 'from' | 'to')[];
+    limit?: number;
+    boost?: {
+        subject?: number;
+        body?: number;
+        from?: number;
+        to?: number;
+    };
+}
+/**
+ * Searches in teh
+ *
+ * @param query - The string to search for
+ * @param esCache - The email cache
+ * @param searchIndex - The email search index
+ * @param opetions - The optional search limitations
+ * @returns The result of the email search (emails ans their corresponding result weights)
+ */
+declare const searchEmails: (query: string, esCache: MailCache<Email>, searchIndex: EmailSearchIndex, options?: SearchOptions) => Promise<EmailSearchResult[]>;
+
+export { type EmailSearchIndex, type EncryptedSearchDB, type MailDB, type SearchOptions, addEmailToCache, addEmailToSearchIndex, addEmailsToCache, buildSearchIndexFromCache, closeDatabase, createCacheFromDB, deleteDatabase, deleteEmail, deleteEmailFromCache, deleteOldestEmails, deriveIndexKey, encryptAndStoreEmail, encryptAndStoreManyEmail, enforceMaxEmailNumber, getAllEmailsSortedNewestFirst, getAllEmailsSortedOldestFirst, getAndDecryptAllEmails, getAndDecryptEmail, getEmailBatch, getEmailCount, getEmailFromCache, openDatabase, removeEmailFromSearchIndex, searchEmails };

package/dist/email-search.d.ts

@@ -0,0 +1,228 @@
+import { IDBPDatabase, DBSchema } from 'idb';
+import { StoredEmail, Email, MailCache, EmailSearchResult } from './types.js';
+import { Index } from 'flexsearch';
+
+type MailDB = IDBPDatabase<EncryptedSearchDB>;
+interface EncryptedSearchDB extends DBSchema {
+    email: {
+        key: string;
+        value: StoredEmail;
+        indexes: {
+            byTime: number[];
+        };
+    };
+}
+/**
+ * Opens IndexedDB database for the given user
+ *
+ * @param userID - The user ID
+ * @returns The database
+ */
+declare const openDatabase: (userID: string) => Promise<MailDB>;
+/**
+ * Closes the IndexedDB database
+ *
+ * @param esDB - The database
+ */
+declare const closeDatabase: (esDB: MailDB) => void;
+/**
+ * Deletes IndexedDB database for the given user
+ *
+ * @param userID - The user ID
+ * @returns The database
+ */
+declare const deleteDatabase: (userID: string) => Promise<void>;
+/**
+ * Derives database encryption key for the given user
+ *
+ * @param userID - The user ID
+ * @returns The symmetric CryptoKey for protecting database
+ */
+declare const deriveIndexKey: (baseKey: Uint8Array) => Promise<CryptoKey>;
+/**
+ * Encrypts the given email and stores it in the IndexedDB database
+ *
+ * @param newEmailToStore - The email for storing
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @param esDB - The database
+ */
+declare const encryptAndStoreEmail: (newEmailToStore: Email, indexKey: CryptoKey, esDB: MailDB) => Promise<void>;
+/**
+ * Encrypts the given set of emails and stores it in the IndexedDB database
+ *
+ * @param newEmailsToStore - The set of emails for storing
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @param esDB - The database
+ */
+declare const encryptAndStoreManyEmail: (newEmailsToStore: Email[], indexKey: CryptoKey, esDB: MailDB) => Promise<void>;
+/**
+ * Fetches the email from the database and decrypts it
+ *
+ * @param emailID - The email identifier
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @param encryptedEmail - The encrypted email
+ * @returns The decrypted email
+ */
+declare const getAndDecryptEmail: (emailID: string, indexKey: CryptoKey, esDB: MailDB) => Promise<Email>;
+/**
+ * Fetches all email from the database and decrypts them
+ *
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @param esDB - The database
+ * @returns The decrypted emails
+ */
+declare const getAndDecryptAllEmails: (indexKey: CryptoKey, esDB: MailDB) => Promise<Email[]>;
+/**
+ * Deletes the email from the database
+ *
+ * @param emailID - The email identifier
+ * @param esDB - The database
+ */
+declare const deleteEmail: (emailID: string, esDB: MailDB) => Promise<void>;
+/**
+ * Returns the number of stored email
+ *
+ * @param esDB - The database
+ * @returns The number of stored emails
+ */
+declare const getEmailCount: (esDB: MailDB) => Promise<number>;
+/**
+ * Removes the given number of oldests emails from the database
+ *
+ * @param emailsToDelete - The number of emails to delete
+ * @param esDB - The database
+ */
+declare const deleteOldestEmails: (emailsToDelete: number, esDB: MailDB) => Promise<void>;
+/**
+ * Enforces the maximum email number in the database
+ *
+ * @param esDB - The database
+ * @param max - The maximum allowed number of emails
+ */
+declare const enforceMaxEmailNumber: (esDB: MailDB, max: number) => Promise<void>;
+/**
+ * Fetches all emails from the database, decrypts them and sortes the results based on the creation time (newest first)
+ *
+ * @param esDB - The database
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @returns The number of stored emails
+ */
+declare const getAllEmailsSortedNewestFirst: (esDB: MailDB, indexKey: CryptoKey) => Promise<Email[]>;
+/**
+ * Fetches all emails from the database, decrypts them and sortes the results based on the creation time (oldest first)
+ *
+ * @param esDB - The database
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @returns The number of stored emails
+ */
+declare const getAllEmailsSortedOldestFirst: (esDB: MailDB, indexKey: CryptoKey) => Promise<Email[]>;
+/**
+ * Fetches a batch of emails from the database, decrypts them and sortes the results based on the creation time (newest first)
+ *
+ * @param esDB - The database
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @param batchSize - The size of the batch
+ * @param startCursor - The starting point (optional). If not given, starts from the beginning
+ * @returns The number of stored emails
+ */
+declare const getEmailBatch: (esDB: MailDB, indexKey: CryptoKey, batchSize: number, startCursor?: IDBValidKey) => Promise<{
+    emails: Email[];
+    nextCursor?: IDBValidKey;
+}>;
+
+/**
+ * Fetches all emails from the database in batches and cahces them
+ *
+ * @param indexKey - The symmetric CryptoKey key for protecting database
+ * @param esCache - The cache to add emails too
+ * @param esDB - The database
+ */
+declare const createCacheFromDB: (indexKey: CryptoKey, esDB: MailDB) => Promise<MailCache<Email>>;
+/**
+ * Gets an email from the cache
+ *
+ * @param emailID - The email identifier
+ * @param esCache - The email cache
+ * @returns The found email or throws an error
+ */
+declare const getEmailFromCache: (emailID: string, esCache: MailCache<Email>) => Promise<Email>;
+/**
+ * Removes the email from cache
+ *
+ * @param emailID - The email identifier
+ * @param esCache - The email cache
+ */
+declare const deleteEmailFromCache: (emailID: string, esCache: MailCache<Email>) => Promise<void>;
+/**
+ * Adds emails to the cache
+ *
+ * @param emails - The emails to add
+ * @param esCache - The email cache
+ * @returns TRUE if all emails were added sucessfully, or FALSE and error reason.
+ */
+declare function addEmailsToCache(emails: Email[], esCache: MailCache<Email>): {
+    success: boolean;
+    reason?: string;
+};
+/**
+ * Adds email to the cache
+ *
+ * @param email - The email to add
+ * @param esCache - The email cache
+ * @returns TRUE if the email was added sucessfully, or FALSE and error reason.
+ */
+declare const addEmailToCache: (email: Email, esCache: MailCache<Email>) => {
+    success: boolean;
+    reason?: string;
+};
+
+interface EmailSearchIndex {
+    subjectIndex: Index;
+    bodyIndex: Index;
+    fromIndex: Index;
+    toIndex: Index;
+    isReady: boolean;
+}
+/**
+ * Adds the given email to the email search index
+ *
+ * @param email - The email to add
+ * @param searchIndex - The email search index
+ */
+declare const addEmailToSearchIndex: (email: Email, searchIndex: EmailSearchIndex) => void;
+/**
+ * Removes the email from the email search index
+ *
+ * @param emailID - The email identifier
+ * @param searchIndex - The email search index
+ */
+declare const removeEmailFromSearchIndex: (emailID: string, searchIndex: EmailSearchIndex) => void;
+/**
+ * Buils the email search index from the email cache
+ *
+ * @param esCache - The email cache
+ * @returns  The email search index
+ */
+declare const buildSearchIndexFromCache: (esCache: MailCache<Email>) => Promise<EmailSearchIndex>;
+interface SearchOptions {
+    fields?: ('subject' | 'body' | 'from' | 'to')[];
+    limit?: number;
+    boost?: {
+        subject?: number;
+        body?: number;
+        from?: number;
+        to?: number;
+    };
+}
+/**
+ * Searches in teh
+ *
+ * @param query - The string to search for
+ * @param esCache - The email cache
+ * @param searchIndex - The email search index
+ * @param opetions - The optional search limitations
+ * @returns The result of the email search (emails ans their corresponding result weights)
+ */
+declare const searchEmails: (query: string, esCache: MailCache<Email>, searchIndex: EmailSearchIndex, options?: SearchOptions) => Promise<EmailSearchResult[]>;
+
+export { type EmailSearchIndex, type EncryptedSearchDB, type MailDB, type SearchOptions, addEmailToCache, addEmailToSearchIndex, addEmailsToCache, buildSearchIndexFromCache, closeDatabase, createCacheFromDB, deleteDatabase, deleteEmail, deleteEmailFromCache, deleteOldestEmails, deriveIndexKey, encryptAndStoreEmail, encryptAndStoreManyEmail, enforceMaxEmailNumber, getAllEmailsSortedNewestFirst, getAllEmailsSortedOldestFirst, getAndDecryptAllEmails, getAndDecryptEmail, getEmailBatch, getEmailCount, getEmailFromCache, openDatabase, removeEmailFromSearchIndex, searchEmails };