cas-typescript-sdk 1.0.22 → 1.0.24

package/lib/hybrid/types/aes-rsa-hybrid-initializer.d.ts

@@ -1,8 +1,13 @@
-import { RsaKeyPairResult } from "../../..";
+import { CASRSAKeyPairResult } from "../../..";
 export declare class AESRSAHybridInitializer {
     aesType: number;
     aesKey: Array<number>;
     aesNonce: Array<number>;
-    rsaKeyPair: RsaKeyPairResult;
+    rsaKeyPair: CASRSAKeyPairResult;
+    /**
+     * 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);
 }

package/lib/hybrid/types/aes-rsa-hybrid-initializer.js

@@ -8,6 +8,11 @@ class AESRSAHybridInitializer {
     aesKey;
     aesNonce;
     rsaKeyPair;
+    /**
+     * 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, rsaSize) {
         if (aesType !== 128 && aesType !== 256) {
             throw new Error("Need an appropriate AES size to generate a hybrid initalizer");

package/lib/index.d.ts

@@ -1,9 +1,8 @@
-import { Argon2Wrapper, BCryptWrapper, PasswordHasherFactory, PasswordHasherType, ScryptWrapper } from "./password-hashers/index";
-import { HasherFactory, HasherType, SHAWrapper } from "./hashers/index";
-import { X25519Wrapper } from "./key_exchange/index";
-import { AESWrapper } from "./symmetric/index";
-import { RsaKeyPairResult, RSAWrapper } from "./asymmetric/index";
-import { AesRsaHybridEncryptResult, AESRSAHybridInitializer, HybridEncryptionWrapper } from "./hybrid/index";
-import { DigitalSignatureFactory, DigitalSignatureSHA256Wrapper, DigitalSignatureSHA512Wrapper, DigitalSignatureType } from "./digital-signature";
-import { AsconWrapper } from "./sponges/index";
-export { AesRsaHybridEncryptResult, AESRSAHybridInitializer, AESWrapper, Argon2Wrapper, AsconWrapper, BCryptWrapper, DigitalSignatureFactory, DigitalSignatureSHA256Wrapper, DigitalSignatureSHA512Wrapper, DigitalSignatureType, HasherFactory, HasherType, HybridEncryptionWrapper, PasswordHasherFactory, PasswordHasherType, RsaKeyPairResult, RSAWrapper, ScryptWrapper, SHAWrapper, X25519Wrapper, };
+export * from "./password-hashers/index";
+export * from "./hashers/index";
+export * from "./key_exchange/index";
+export * from "./symmetric/index";
+export * from "./asymmetric/index";
+export * from "./hybrid/index";
+export * from "./digital-signature";
+export * from "./sponges/index";

package/lib/index.js

@@ -1,31 +1,24 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.X25519Wrapper = exports.SHAWrapper = exports.ScryptWrapper = exports.RSAWrapper = exports.RsaKeyPairResult = exports.PasswordHasherType = exports.PasswordHasherFactory = exports.HybridEncryptionWrapper = exports.HasherType = exports.HasherFactory = exports.DigitalSignatureType = exports.DigitalSignatureSHA512Wrapper = exports.DigitalSignatureSHA256Wrapper = exports.DigitalSignatureFactory = exports.BCryptWrapper = exports.AsconWrapper = exports.Argon2Wrapper = exports.AESWrapper = exports.AESRSAHybridInitializer = exports.AesRsaHybridEncryptResult = void 0;
-const index_1 = require("./password-hashers/index");
-Object.defineProperty(exports, "Argon2Wrapper", { enumerable: true, get: function () { return index_1.Argon2Wrapper; } });
-Object.defineProperty(exports, "BCryptWrapper", { enumerable: true, get: function () { return index_1.BCryptWrapper; } });
-Object.defineProperty(exports, "PasswordHasherFactory", { enumerable: true, get: function () { return index_1.PasswordHasherFactory; } });
-Object.defineProperty(exports, "PasswordHasherType", { enumerable: true, get: function () { return index_1.PasswordHasherType; } });
-Object.defineProperty(exports, "ScryptWrapper", { enumerable: true, get: function () { return index_1.ScryptWrapper; } });
-const index_2 = require("./hashers/index");
-Object.defineProperty(exports, "HasherFactory", { enumerable: true, get: function () { return index_2.HasherFactory; } });
-Object.defineProperty(exports, "HasherType", { enumerable: true, get: function () { return index_2.HasherType; } });
-Object.defineProperty(exports, "SHAWrapper", { enumerable: true, get: function () { return index_2.SHAWrapper; } });
-const index_3 = require("./key_exchange/index");
-Object.defineProperty(exports, "X25519Wrapper", { enumerable: true, get: function () { return index_3.X25519Wrapper; } });
-const index_4 = require("./symmetric/index");
-Object.defineProperty(exports, "AESWrapper", { enumerable: true, get: function () { return index_4.AESWrapper; } });
-const index_5 = require("./asymmetric/index");
-Object.defineProperty(exports, "RsaKeyPairResult", { enumerable: true, get: function () { return index_5.RsaKeyPairResult; } });
-Object.defineProperty(exports, "RSAWrapper", { enumerable: true, get: function () { return index_5.RSAWrapper; } });
-const index_6 = require("./hybrid/index");
-Object.defineProperty(exports, "AesRsaHybridEncryptResult", { enumerable: true, get: function () { return index_6.AesRsaHybridEncryptResult; } });
-Object.defineProperty(exports, "AESRSAHybridInitializer", { enumerable: true, get: function () { return index_6.AESRSAHybridInitializer; } });
-Object.defineProperty(exports, "HybridEncryptionWrapper", { enumerable: true, get: function () { return index_6.HybridEncryptionWrapper; } });
-const digital_signature_1 = require("./digital-signature");
-Object.defineProperty(exports, "DigitalSignatureFactory", { enumerable: true, get: function () { return digital_signature_1.DigitalSignatureFactory; } });
-Object.defineProperty(exports, "DigitalSignatureSHA256Wrapper", { enumerable: true, get: function () { return digital_signature_1.DigitalSignatureSHA256Wrapper; } });
-Object.defineProperty(exports, "DigitalSignatureSHA512Wrapper", { enumerable: true, get: function () { return digital_signature_1.DigitalSignatureSHA512Wrapper; } });
-Object.defineProperty(exports, "DigitalSignatureType", { enumerable: true, get: function () { return digital_signature_1.DigitalSignatureType; } });
-const index_7 = require("./sponges/index");
-Object.defineProperty(exports, "AsconWrapper", { enumerable: true, get: function () { return index_7.AsconWrapper; } });
+__exportStar(require("./password-hashers/index"), exports);
+__exportStar(require("./hashers/index"), exports);
+__exportStar(require("./key_exchange/index"), exports);
+__exportStar(require("./symmetric/index"), exports);
+__exportStar(require("./asymmetric/index"), exports);
+__exportStar(require("./hybrid/index"), exports);
+__exportStar(require("./digital-signature"), exports);
+__exportStar(require("./sponges/index"), exports);

package/lib/key_exchange/index.d.ts

@@ -1,2 +1,3 @@
+import { CASx25519SecretPublicKeyResult } from "../../index";
 import { X25519Wrapper } from "./x25519";
-export { X25519Wrapper };
+export { X25519Wrapper, CASx25519SecretPublicKeyResult };

package/lib/key_exchange/x25519.d.ts

@@ -1,5 +1,17 @@
-import { X25519SecretPublicKeyResult } from "../../index";
+import { CASx25519SecretPublicKeyResult } from "../../index";
 export declare class X25519Wrapper {
-    generateSecretAndPublicKey(): X25519SecretPublicKeyResult;
-    generateSharedSecret(secretKey: Array<number>, publicKey: Array<number>): number[];
+    /**
+     * Generates and secret and public key to be used to create a shared secret with Diffie Hellman.
+     * User should share their public key with the other user and take the other user's public key and they can generate a Shared Secret.
+     * @returns X25519SecretPublicKeyResult
+     */
+    generateSecretAndPublicKey(): CASx25519SecretPublicKeyResult;
+    /**
+     * User takes their secret key and the other user's public key to generate a shared secret.
+     * Can be used to derive an AES key over insecure channel.
+     * @param secretKey
+     * @param publicKey
+     * @returns Array<number>
+     */
+    generateSharedSecret(secretKey: Array<number>, publicKey: Array<number>): Array<number>;
 }

package/lib/key_exchange/x25519.js

@@ -3,9 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.X25519Wrapper = void 0;
 const index_1 = require("../../index");
 class X25519Wrapper {
+    /**
+     * Generates and secret and public key to be used to create a shared secret with Diffie Hellman.
+     * User should share their public key with the other user and take the other user's public key and they can generate a Shared Secret.
+     * @returns X25519SecretPublicKeyResult
+     */
     generateSecretAndPublicKey() {
         return (0, index_1.x25519GenerateSecretAndPublicKey)();
     }
+    /**
+     * User takes their secret key and the other user's public key to generate a shared secret.
+     * Can be used to derive an AES key over insecure channel.
+     * @param secretKey
+     * @param publicKey
+     * @returns Array<number>
+     */
     generateSharedSecret(secretKey, publicKey) {
         return (0, index_1.x25519DiffieHellman)(secretKey, publicKey);
     }

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

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

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

@@ -3,6 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Argon2Wrapper = void 0;
 const index_1 = require("./../../index");
 class Argon2Wrapper {
+    /**
+     * Verifies a password with Argon2 on the threadpool.
+     * @param hashedPassword
+     * @param passwordToCheck
+     * @returns boolean
+     */
     verifyThreadPool(hashedPassword, passwordToCheck) {
         if (!hashedPassword) {
             throw new Error("You must provide a password to verify with Argon2");
@@ -12,18 +18,34 @@ class Argon2Wrapper {
         }
         return (0, index_1.argon2VerifyThreadpool)(hashedPassword, passwordToCheck);
     }
+    /**
+     * Hashes a password with Argon2 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.argon2HashThreadPool)(password);
     }
+    /**
+     * Hashes a password with Argon2
+     * @param password
+     * @returns string
+     */
     hashPassword(password) {
         if (!password) {
             throw new Error("You must provide a password to hash with Argon2");
         }
         return (0, index_1.argon2Hash)(password);
     }
+    /**
+     * Verifies that a password is the same as the hashed password with Argon2.
+     * @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/bcrypt-wrapper.d.ts

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

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);
- * ```
- */
+import { CASAesKeyFromX25519SharedSecret } from "../../index";
 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>;
-    aes256KeyNonceX25519DiffieHellman(shared_secret: Array<number>): AesKeyFromX25519SharedSecret;
-    aes128KeyNonceX25519DiffieHellman(shared_secret: Array<number>): AesKeyFromX25519SharedSecret;
+    /**
+     * Derives an AES-256 key from a X25519 Diffie Hellman shared secret.
+     * @param shared_secret
+     * @returns
+     */
+    aes256KeyNonceX25519DiffieHellman(shared_secret: Array<number>): CASAesKeyFromX25519SharedSecret;
+    /**
+     * Derives an AES-128 key from a X25519 Diffie Hellman shared secret.
+     * @param shared_secret
+     * @returns
+     */
+    aes128KeyNonceX25519DiffieHellman(shared_secret: Array<number>): CASAesKeyFromX25519SharedSecret;
 }

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/lib/symmetric/index.d.ts

@@ -1,2 +1,3 @@
+import { CASAesKeyFromX25519SharedSecret } from "../../index";
 import { AESWrapper } from "./aes-wrapper";
-export { AESWrapper };
+export { AESWrapper, CASAesKeyFromX25519SharedSecret };

package/package.json

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