cas-typescript-sdk 1.0.22 → 1.0.23

package/lib/password-hashers/bcrypt-wrapper.js

@@ -3,24 +3,46 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BCryptWrapper = void 0;
 const index_1 = require("./../../index");
 class BCryptWrapper {
+    /**
+     * Verifies a password with BCrypt on the threadpool.
+     * @param hashedPassword
+     * @param passwordToCheck
+     * @returns boolean
+     */
     verifyThreadPool(hashedPassword, passwordToCheck) {
         if (!hashedPassword || !passwordToCheck) {
             throw new Error("You must provide a hashed password and a plaintext password to verify with Argon2");
         }
         return (0, index_1.bcryptVerifyThreadpool)(hashedPassword, passwordToCheck);
     }
+    /**
+     * Hashes a password with BCrypt on the threadpool.
+     * @param password
+     * @returns string
+     */
     hashPasswordThreadPool(password) {
         if (!password) {
             throw new Error("You must provide a password to hash with Argon2");
         }
         return (0, index_1.bcryptHashThreadpool)(password);
     }
+    /**
+     * Hashes a password with BCrypt
+     * @param password
+     * @returns string
+     */
     hashPassword(password) {
         if (!password) {
             throw new Error("You must provide a password to hash with Argon2");
         }
         return (0, index_1.bcryptHash)(password);
     }
+    /**
+     * Verifies that a password is the same as the hashed password with BCrypt.
+     * @param hashedPassword
+     * @param passwordToVerify
+     * @returns boolean
+     */
     verify(hashedPassword, passwordToVerify) {
         if (!hashedPassword || !passwordToVerify) {
             throw new Error("You must provide a hashed password and a plaintext password to verify with Argon2");

package/lib/password-hashers/password-hasher-factory.d.ts

@@ -1,4 +1,9 @@
 import { PasswordHasherType } from "./password-hasher-type";
 export declare class PasswordHasherFactory {
+    /**
+     * Returns the appropriate hasher type based upon the type passed in.
+     * @param type
+     * @returns
+     */
     static getHasher(type: PasswordHasherType): any;
 }

package/lib/password-hashers/password-hasher-factory.js

@@ -6,6 +6,11 @@ const bcrypt_wrapper_1 = require("./bcrypt-wrapper");
 const password_hasher_type_1 = require("./password-hasher-type");
 const scrypt_wrapper_1 = require("./scrypt-wrapper");
 class PasswordHasherFactory {
+    /**
+     * Returns the appropriate hasher type based upon the type passed in.
+     * @param type
+     * @returns
+     */
     static getHasher(type) {
         // Argon2 by default
         let hasher = new argon2_wrapper_1.Argon2Wrapper();

package/lib/password-hashers/scrypt-wrapper.d.ts

@@ -1,7 +1,29 @@
 import { IPasswordHasherBase } from "./password-hasher-base";
 export declare class ScryptWrapper implements IPasswordHasherBase {
+    /**
+     * Verifies a password with SCrypt on the threadpool.
+     * @param hashedPassword
+     * @param passwordToCheck
+     * @returns boolean
+     */
     verifyThreadPool(hashedPassword: string, passwordToCheck: string): boolean;
+    /**
+     * Hashes a password with SCrypt on the threadpool.
+     * @param password
+     * @returns string
+     */
     hashPasswordThreadPool(password: string): string;
+    /**
+     * Hashes a password with SCrypt
+     * @param password
+     * @returns string
+     */
     hashPassword(password: string): string;
+    /**
+     * Verifies that a password is the same as the hashed password with SCrypt.
+     * @param hashedPassword
+     * @param passwordToVerify
+     * @returns boolean
+     */
     verify(hashedPassword: string, passwordToVerify: string): boolean;
 }

package/lib/password-hashers/scrypt-wrapper.js

@@ -3,24 +3,46 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ScryptWrapper = void 0;
 const index_1 = require("../../index");
 class ScryptWrapper {
+    /**
+     * Verifies a password with SCrypt on the threadpool.
+     * @param hashedPassword
+     * @param passwordToCheck
+     * @returns boolean
+     */
     verifyThreadPool(hashedPassword, passwordToCheck) {
         if (!hashedPassword || !passwordToCheck) {
             throw new Error("You must provide a hashed password and a plaintext password to verify with Scrypt");
         }
         return (0, index_1.scryptVerifyThreadpool)(hashedPassword, passwordToCheck);
     }
+    /**
+     * Hashes a password with SCrypt on the threadpool.
+     * @param password
+     * @returns string
+     */
     hashPasswordThreadPool(password) {
         if (!password) {
             throw new Error("You must provide a password to hash with Scrypt");
         }
         return (0, index_1.scryptHashThreadpool)(password);
     }
+    /**
+     * Hashes a password with SCrypt
+     * @param password
+     * @returns string
+     */
     hashPassword(password) {
         if (!password) {
             throw new Error("You must provide a password to hash with Scrypt");
         }
         return (0, index_1.scryptHash)(password);
     }
+    /**
+     * Verifies that a password is the same as the hashed password with SCrypt.
+     * @param hashedPassword
+     * @param passwordToVerify
+     * @returns boolean
+     */
     verify(hashedPassword, passwordToVerify) {
         if (!hashedPassword || !passwordToVerify) {
             throw new Error("You must provide a hashed password and a plaintext password to verify with Scrypt");

package/lib/sponges/ascon-wrapper.d.ts

@@ -1,6 +1,28 @@
 export declare class AsconWrapper {
+    /**
+     * Generates an Ascon 128 key
+     * @returns Array<number>
+     */
     ascon128Key(): Array<number>;
+    /**
+     * Generates and Ascon 128 nonce.
+     * @returns Array<number>
+     */
     ascon128Nonce(): Array<number>;
+    /**
+     * Encrypts with Ascon 128 using the key and nonce generated from ascon128Key() and ascon128Nonce() respectively.
+     * @param key
+     * @param nonce
+     * @param plaintext
+     * @returns
+     */
     ascon128Encrypt(key: Array<number>, nonce: Array<number>, plaintext: Array<number>): Array<number>;
+    /**
+    * Decrypts with Ascon 128 using the key and nonce generated from ascon128Key() and ascon128Nonce() respectively.
+    * @param key
+    * @param nonce
+    * @param ciphertext
+    * @returns Array<number>
+    */
     ascon128Decrypt(key: Array<number>, nonce: Array<number>, ciphertext: Array<number>): Array<number>;
 }

package/lib/sponges/ascon-wrapper.js

@@ -3,12 +3,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AsconWrapper = void 0;
 const index_1 = require("../../index");
 class AsconWrapper {
+    /**
+     * Generates an Ascon 128 key
+     * @returns Array<number>
+     */
     ascon128Key() {
         return (0, index_1.ascon128KeyGenerate)();
     }
+    /**
+     * Generates and Ascon 128 nonce.
+     * @returns Array<number>
+     */
     ascon128Nonce() {
         return (0, index_1.ascon128NonceGenerate)();
     }
+    /**
+     * Encrypts with Ascon 128 using the key and nonce generated from ascon128Key() and ascon128Nonce() respectively.
+     * @param key
+     * @param nonce
+     * @param plaintext
+     * @returns
+     */
     ascon128Encrypt(key, nonce, plaintext) {
         if (!key || key.length === 0) {
             throw new Error("Key is required");
@@ -21,6 +36,13 @@ class AsconWrapper {
         }
         return (0, index_1.ascon128Encrypt)(key, nonce, plaintext);
     }
+    /**
+    * Decrypts with Ascon 128 using the key and nonce generated from ascon128Key() and ascon128Nonce() respectively.
+    * @param key
+    * @param nonce
+    * @param ciphertext
+    * @returns Array<number>
+    */
     ascon128Decrypt(key, nonce, ciphertext) {
         if (!key || key.length === 0) {
             throw new Error("Key is required");

package/lib/symmetric/aes-wrapper.d.ts

@@ -1,16 +1,4 @@
 import { AesKeyFromX25519SharedSecret } from "../../index";
-/**
- * @description A wrapper class that contains methods to construct keys, nonces, and methods to encrypt and decrypt with AES-128-GCM and AES-256-GCM
- *
- * @example
- * ```ts
- * const nonce = aesWrapper.generateAESNonce();
-const key = aesWrapper.aes128Key();
-const textEncoder = new TextEncoder();
-const array = Array.from(textEncoder.encode("Hello World"));
-const encrypted = aesWrapper.aes128Encrypt(key, nonce, array);
- * ```
- */
 export declare class AESWrapper {
     /**
      * @description Generates a 128 bit AES key
@@ -22,11 +10,53 @@ export declare class AESWrapper {
      * @returns returns a 256 bit AES key
      */
     aes256Key(): Array<number>;
+    /**
+     * Generates an 96 bit AES nonce
+     * @returns Array<number>
+     */
     generateAESNonce(): Array<number>;
+    /**
+     * Encrypts with AES 128.
+     * @param aesKey
+     * @param nonce
+     * @param plaintext
+     * @returns Array<number>
+     */
     aes128Encrypt(aesKey: Array<number>, nonce: Array<number>, plaintext: Array<number>): Array<number>;
+    /**
+     * Decrypts with AES 128
+     * @param aesKey
+     * @param nonce
+     * @param ciphertext
+     * @returns Array<number>
+     */
     aes128Decrypt(aesKey: Array<number>, nonce: Array<number>, ciphertext: Array<number>): Array<number>;
+    /**
+     * Encrypts with AES-256
+     * @param aesKey
+     * @param nonce
+     * @param plaintext
+     * @returns
+     */
     aes256Encrypt(aesKey: Array<number>, nonce: Array<number>, plaintext: Array<number>): Array<number>;
+    /**
+     * Decrypts with AES 256
+     * @param aesKey
+     * @param nonce
+     * @param ciphertext
+     * @returns
+     */
     aes256Decrypt(aesKey: Array<number>, nonce: Array<number>, ciphertext: Array<number>): Array<number>;
+    /**
+     * Derives an AES-256 key from a X25519 Diffie Hellman shared secret.
+     * @param shared_secret
+     * @returns
+     */
     aes256KeyNonceX25519DiffieHellman(shared_secret: Array<number>): AesKeyFromX25519SharedSecret;
+    /**
+     * Derives an AES-128 key from a X25519 Diffie Hellman shared secret.
+     * @param shared_secret
+     * @returns
+     */
     aes128KeyNonceX25519DiffieHellman(shared_secret: Array<number>): AesKeyFromX25519SharedSecret;
 }

package/lib/symmetric/aes-wrapper.js

@@ -2,18 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AESWrapper = void 0;
 const index_1 = require("../../index");
-/**
- * @description A wrapper class that contains methods to construct keys, nonces, and methods to encrypt and decrypt with AES-128-GCM and AES-256-GCM
- *
- * @example
- * ```ts
- * const nonce = aesWrapper.generateAESNonce();
-const key = aesWrapper.aes128Key();
-const textEncoder = new TextEncoder();
-const array = Array.from(textEncoder.encode("Hello World"));
-const encrypted = aesWrapper.aes128Encrypt(key, nonce, array);
- * ```
- */
 class AESWrapper {
     /**
      * @description Generates a 128 bit AES key
@@ -29,24 +17,66 @@ class AESWrapper {
     aes256Key() {
         return (0, index_1.aes256Key)();
     }
+    /**
+     * Generates an 96 bit AES nonce
+     * @returns Array<number>
+     */
     generateAESNonce() {
         return (0, index_1.aesNonce)();
     }
+    /**
+     * Encrypts with AES 128.
+     * @param aesKey
+     * @param nonce
+     * @param plaintext
+     * @returns Array<number>
+     */
     aes128Encrypt(aesKey, nonce, plaintext) {
         return (0, index_1.aes128Encrypt)(aesKey, nonce, plaintext);
     }
+    /**
+     * Decrypts with AES 128
+     * @param aesKey
+     * @param nonce
+     * @param ciphertext
+     * @returns Array<number>
+     */
     aes128Decrypt(aesKey, nonce, ciphertext) {
         return (0, index_1.aes128Decrypt)(aesKey, nonce, ciphertext);
     }
+    /**
+     * Encrypts with AES-256
+     * @param aesKey
+     * @param nonce
+     * @param plaintext
+     * @returns
+     */
     aes256Encrypt(aesKey, nonce, plaintext) {
         return (0, index_1.aes256Encrypt)(aesKey, nonce, plaintext);
     }
+    /**
+     * Decrypts with AES 256
+     * @param aesKey
+     * @param nonce
+     * @param ciphertext
+     * @returns
+     */
     aes256Decrypt(aesKey, nonce, ciphertext) {
         return (0, index_1.aes256Decrypt)(aesKey, nonce, ciphertext);
     }
+    /**
+     * Derives an AES-256 key from a X25519 Diffie Hellman shared secret.
+     * @param shared_secret
+     * @returns
+     */
     aes256KeyNonceX25519DiffieHellman(shared_secret) {
         return (0, index_1.aes256KeyFromX25519SharedSecret)(shared_secret);
     }
+    /**
+     * Derives an AES-128 key from a X25519 Diffie Hellman shared secret.
+     * @param shared_secret
+     * @returns
+     */
     aes128KeyNonceX25519DiffieHellman(shared_secret) {
         return (0, index_1.aes128KeyFromX25519SharedSecret)(shared_secret);
     }

package/package.json

@@ -1,7 +1,7 @@
 
 {
   "name": "cas-typescript-sdk",
-  "version": "1.0.22",
+  "version": "1.0.23",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/src-ts/asymmetric/RSAWrapper.ts

@@ -1,6 +1,12 @@
 import { decryptCiphertextRsa, encryptPlaintextRsa, generateRsaKeys, RsaKeyPairResult, signRsa, verifyRsa } from "../../index";
 
 export class RSAWrapper {
+
+  /**
+   * Generates an RSA key pair based of parameter sent in 1024, 2048, and 4096 are supported.
+   * @param keySize 
+   * @returns RsaKeyPairResult
+   */
   public generateKeys(keySize: number): RsaKeyPairResult {
     if (keySize !== 1024 && keySize !== 2048 && keySize !== 4096) {
         throw new Error("You must provide an appropriate key size to generate RSA keys");
@@ -8,6 +14,13 @@ export class RSAWrapper {
     return generateRsaKeys(keySize);
   }
 
+  /**
+   * Encrypts a plaintext byte array with a RSA public key
+   * @param publicKey 
+   * @param plaintext 
+   * @returns Array<number>
+   */
+
   public encrypt(publicKey: string, plaintext: Array<number>): Array<number> {
     if (!publicKey) {
       throw new Error("You must provide a public key to encrypt with RSA");
@@ -18,6 +31,13 @@ export class RSAWrapper {
     return encryptPlaintextRsa(publicKey, plaintext);
   }
 
+  /**
+   * Decrypts a ciphertext with an RSA private key.
+   * @param privateKey 
+   * @param ciphertext 
+   * @returns Array<number>
+   */
+
   public decrypt(privateKey: string, ciphertext: Array<number>): Array<number> {
     if (!privateKey) {
       throw new Error("You must provide a private key to encrypt with RSA");
@@ -28,16 +48,29 @@ export class RSAWrapper {
     return decryptCiphertextRsa(privateKey, ciphertext);
   }
 
-  public sign(privateKey: string, hash: Array<number>): Array<number> {
+  /**
+   * Signs a byte array with an RSA private key for verification.
+   * @param privateKey 
+   * @param hash 
+   * @returns Array<number>
+   */
+  public sign(privateKey: string, dataToSign: Array<number>): Array<number> {
     if (!privateKey) {
       throw new Error("You must provide a private key to sign with RSA");
     }
-    if (!hash || hash.length === 0) {
+    if (!dataToSign || dataToSign.length === 0) {
       throw new Error("You must provide an allocated hash to sign with RSA");
     }
-    return signRsa(privateKey, hash);
+    return signRsa(privateKey, dataToSign);
   }
 
+  /**
+   * Verifies signed data by the corresponding private key with an RSA public key.
+   * @param publicKey 
+   * @param hash 
+   * @param signature 
+   * @returns boolean
+   */
   public verify(publicKey: string, hash: Array<number>, signature: Array<number>): boolean {
     if (!publicKey) {
       throw new Error("You must provide a public key to verify with RSA");

package/src-ts/digital-signature/digital-siganture-sha-512.ts

@@ -3,13 +3,25 @@ import { IDigitalSignature } from "./digital-signature-base";
 
 export class DigitalSignatureSHA512Wrapper implements IDigitalSignature {
 
+    /**
+     * Creates an ED25519 siganture from an array of bytes with SHA3-512.
+     * @param dataToSign 
+     * @returns SHAED25519DalekDigitalSignatureResult
+     */
     createED25519(dataToSign: number[]): SHAED25519DalekDigitalSignatureResult {
         if (dataToSign?.length === 0) {
             throw new Error("Must provide allocated data to sign");
         }
         return sha512Ed25519DigitalSignature(dataToSign);
     }
-    
+
+    /**
+     * Verifies an ED25519 signature with the public key generated from running createED25519() with SHA3-512
+     * @param publicKey 
+     * @param dataToVerify 
+     * @param signature 
+     * @returns boolean
+     */
     verifyED25519(publicKey: number[], dataToVerify: number[], signature: number[]): boolean {
         if (!publicKey) {
             throw new Error("You must provide a public key for verify with ED25519");
@@ -23,6 +35,12 @@ export class DigitalSignatureSHA512Wrapper implements IDigitalSignature {
         return sha512Ed25519DigitalSignatureVerify(publicKey, dataToVerify, signature);
     }
 
+    /**
+     * Generates and RSA digital signature with SHA3-512
+     * @param rsa_key_size 
+     * @param data_to_sign 
+     * @returns RsaDigitalSignatureResult
+     */
     createRsa(rsa_key_size: number, data_to_sign: number[]): RsaDigitalSignatureResult {
         if (rsa_key_size !== 1024 && rsa_key_size !== 2048 && rsa_key_size !== 4096) {
             throw new Error("You need to provide an appropriate RSA key size.");
@@ -33,6 +51,13 @@ export class DigitalSignatureSHA512Wrapper implements IDigitalSignature {
         return sha512RsaDigitalSignature(rsa_key_size, data_to_sign);
     }
     
+    /**
+     * Verifies a digital signature created with the RSA public key.
+     * @param public_key 
+     * @param data_to_verify 
+     * @param signature 
+     * @returns boolean
+     */
     verifyRSa(public_key: string, data_to_verify: number[], signature: number[]): boolean {
         if (!public_key) {
             throw new Error("Must provide a public key");

package/src-ts/digital-signature/digital-signature-factory.ts

@@ -7,6 +7,12 @@ export enum DigitalSignatureType {
 }
 
 export class DigitalSignatureFactory {
+
+    /**
+     * Get the appropriate digital signature wrapper based upon the type passed in.
+     * @param type 
+     * @returns 
+     */
     public static get(type: DigitalSignatureType) {
         let ds = new DigitalSignatureSHA512Wrapper();
         switch (type) {

package/src-ts/digital-signature/digital-signaturte-sha-256.ts

@@ -3,6 +3,11 @@ import { IDigitalSignature } from "./digital-signature-base";
 
 export class DigitalSignatureSHA256Wrapper implements IDigitalSignature {
     
+    /**
+     * Creates an ED25519 siganture from an array of bytes with SHA3-512.
+     * @param dataToSign 
+     * @returns SHAED25519DalekDigitalSignatureResult
+     */
     createED25519(dataToSign: number[]): Shaed25519DalekDigitalSignatureResult {
         if (dataToSign?.length === 0) {
             throw new Error("Must provide allocated data to sign");
@@ -10,6 +15,13 @@ export class DigitalSignatureSHA256Wrapper implements IDigitalSignature {
         return sha256Ed25519DigitalSignature(dataToSign);
     }
 
+    /**
+     * Verifies an ED25519 signature with the public key generated from running createED25519() with SHA3-512
+     * @param publicKey 
+     * @param dataToVerify 
+     * @param signature 
+     * @returns boolean
+     */
     verifyED25519(publicKey: number[], dataToVerify: number[], signature: number[]): boolean {
         if (!publicKey) {
             throw new Error("You must provide a public key for verify with ED25519");
@@ -23,6 +35,12 @@ export class DigitalSignatureSHA256Wrapper implements IDigitalSignature {
         return sha256Ed25519DigitalSignatureVerify(publicKey, dataToVerify, signature);
     }
 
+    /**
+     * Generates and RSA digital signature with SHA3-512
+     * @param rsa_key_size 
+     * @param data_to_sign 
+     * @returns RsaDigitalSignatureResult
+     */
     createRsa(rsa_key_size: number, data_to_sign: number[]): RsaDigitalSignatureResult {
         if (rsa_key_size !== 1024 && rsa_key_size !== 2048 && rsa_key_size !== 4096) {
             throw new Error("You need to provide an appropriate RSA key size.");
@@ -33,6 +51,13 @@ export class DigitalSignatureSHA256Wrapper implements IDigitalSignature {
         return sha256RsaDigitalSignature(rsa_key_size, data_to_sign);
     }
     
+    /**
+     * Verifies a digital signature created with the RSA public key.
+     * @param public_key 
+     * @param data_to_verify 
+     * @param signature 
+     * @returns boolean
+     */
     verifyRSa(public_key: string, data_to_verify: number[], signature: number[]): boolean {
         if (!public_key) {
             throw new Error("Must provide a public key");

package/src-ts/hashers/hasher-factory.ts

@@ -2,6 +2,11 @@ import { HasherType } from "./hasher-type";
 import { SHAWrapper } from "./sha-wrapper";
 
 export class HasherFactory {
+    /**
+     * Get the appropriate hasher wrapper based upon the type based in.
+     * @param type 
+     * @returns 
+     */
     getHasher(type: HasherType): any {
         let result: SHAWrapper = new SHAWrapper();
         switch(type) {

package/src-ts/hashers/sha-wrapper.ts

@@ -2,6 +2,11 @@ import { sha256, sha256Verify, sha512, sha512Verify } from "../../index";
 import { IHasherBase } from "./hasher-base";
 
 export class SHAWrapper implements IHasherBase {
+    /**
+     * Hashes a byte array with SHA3-512.
+     * @param dataToHash 
+     * @returns number[]
+     */
     hash512(dataToHash: number[]): number[] {
         if (!dataToHash || dataToHash.length === 0) {
             throw new Error("You must provide an allocated array of data");
@@ -9,6 +14,12 @@ export class SHAWrapper implements IHasherBase {
         return sha512(dataToHash);
     }
 
+    /**
+     * Verifies unsigned data against an SHA3-512 hash.
+     * @param dataToHash 
+     * @param dataToVerify 
+     * @returns boolean
+     */
     verify512(dataToHash: number[], dataToVerify: number[]): boolean {
         if (!dataToHash || dataToHash.length === 0) {
             throw new Error("You must provide an allocated array of data");
@@ -19,6 +30,11 @@ export class SHAWrapper implements IHasherBase {
         return sha512Verify(dataToHash, dataToVerify);
     }
 
+    /**
+     * Hashes a byte array with SHA3-256.
+     * @param dataToHash 
+     * @returns number[]
+     */
     hash256(dataToHash: number[]): number[] {
         if (!dataToHash || dataToHash.length === 0) {
             throw new Error("You must provide an allocated array of data");
@@ -26,6 +42,12 @@ export class SHAWrapper implements IHasherBase {
         return sha256(dataToHash);
     }
 
+    /**
+     * Verifies unsigned data against an SHA3-256 hash.
+     * @param dataToHash 
+     * @param dataToVerify 
+     * @returns boolean
+     */
     verify256(dataToHash: number[], dataToVerify: number[]): boolean {
         if (!dataToHash || dataToHash.length === 0) {
             throw new Error("You must provide an allocated array of data");

package/src-ts/hybrid/hybrid-encryption-wrapper.ts

@@ -12,6 +12,12 @@ export class HybridEncryptionWrapper {
     this.rsaWrapper = new RSAWrapper();
   }
 
+  /**
+   * Encrypts data with RSA/AES hybrid encryption. The data is encrypted with AES-GCM and the AES key is encrypted with the RSA public key.
+   * @param dataToEncrypt 
+   * @param initalizer 
+   * @returns AesRsaHybridEncryptResult
+   */
   public encrypt(
     dataToEncrypt: Array<number>,
     initalizer: AESRSAHybridInitializer,
@@ -40,6 +46,12 @@ export class HybridEncryptionWrapper {
     return result;
   }
 
+  /**
+   * Decrypts data with RSA/AES hybrid encryption. The RSA private key decrypts the AES key and then the data is decrypted with AES-GCM.
+   * @param dataToEncrypt 
+   * @param initalizer 
+   * @returns AesRsaHybridEncryptResult
+   */
   public decrypt(
     privateKey: string,
     encryptResult: AesRsaHybridEncryptResult,

package/src-ts/hybrid/types/aes-rsa-hybrid-initializer.ts

@@ -8,6 +8,11 @@ export class AESRSAHybridInitializer {
     public aesNonce: Array<number>;
     public rsaKeyPair: RsaKeyPairResult;
 
+    /**
+     * Constructs an initalizer to use with Hybrid Encryption wrapper. Generates your RSA key pair, AES nonce, and AES key based on the parameters passed in.
+     * @param aesType 
+     * @param rsaSize 
+     */
     constructor(aesType: number, rsaSize: number) {
         if (aesType !== 128 && aesType !== 256) {
             throw new Error("Need an appropriate AES size to generate a hybrid initalizer");