fix: names

Author: SSbit01

README.md

@@ -40,7 +40,7 @@ Returns a `Promise<CryptoKey>` containing a SHA-256 hash used to encrypt and dec
 
 A `TypeError` may be thrown if there are problems with the string key.
 
-### `encryptSymmetricallyText`
+### `encryptTextSymmetrically`
 
 Encrypts a value with a symmetric `CryptoKey` previously generated. It takes four parameters:
 
@@ -53,7 +53,7 @@ Returns a `Promise<string>` containing the encrypted value.
 
 A `DOMException` may be thrown if the key is invalid or if the operation failed (e.g., AES-GCM plaintext longer than 2^39−256 bytes).
 
-### `decryptSymmetricallyText`
+### `decryptTextSymmetrically`
 
 Decrypts a value with a symmetric `CryptoKey` previously generated. It takes three parameters:
 
@@ -79,8 +79,8 @@ This is a simple demonstration; production uses should utilize key rotation, amo
 ```typescript
 import {
   createSymmetricKeyWithText,
-  encryptSymmetricallyText,
-  decryptSymmetricallyText
+  encryptTextSymmetrically,
+  decryptTextSymmetrically
 } from "singlecrypt-text";
 
 import { getMessageEncryptionKey } from "./lib/crypto/key";
@@ -92,14 +92,14 @@ const messageCryptoKey = await createSymmetricKeyWithText(
 
 
 export async function encryptMessageId(value: string) {
-  return await encryptSymmetricallyText(
+  return await encryptTextSymmetrically(
     value,
     messageCryptoKey
   );
 }
 
 export async function decryptMessageId(value: string) {
-  return await decryptSymmetricallyText(
+  return await decryptTextSymmetrically(
     value,
     messageCryptoKey
   );
@@ -111,8 +111,8 @@ Or you can reuse `TextEncoder` and `TextDecoder` instances for slightly better p
 ```typescript
 import {
   createSymmetricKeyWithText,
-  encryptSymmetricallyText,
-  decryptSymmetricallyText
+  encryptTextSymmetrically,
+  decryptTextSymmetrically
 } from "singlecrypt-text";
 
 import { getMessageEncryptionKey } from "./lib/crypto/key";
@@ -127,15 +127,15 @@ const messageCryptoKey = await createSymmetricKeyWithText(
 
 
 export async function encryptMessageId(value: string) {
-  return await encryptSymmetricallyText(
+  return await encryptTextSymmetrically(
     value,
     messageCryptoKey,
     textEncoder
   );
 }
 
 export async function decryptMessageId(value: string) {
-  return await decryptSymmetricallyText(
+  return await decryptTextSymmetrically(
     value,
     messageCryptoKey,
     textDecoder

index.d.ts

@@ -20,7 +20,7 @@ export function createSymmetricKeyWithText(data: string, textEncoder?: TextEncod
  * - The provided key is not valid.
  * - The operation failed (e.g., AES-GCM plaintext longer than 2^39−256 bytes).
  */
-export function encryptSymmetricallyText(value: string, key: CryptoKey, textEncoder?: TextEncoder, urlSafe?: boolean): Promise<string>;
+export function encryptTextSymmetrically(value: string, key: CryptoKey, textEncoder?: TextEncoder, urlSafe?: boolean): Promise<string>;
 /**
  * Decrypts a value with a `CryptoKey` previously generated with `createSymmetricKeyWithText`.
  *
@@ -35,4 +35,4 @@ export function encryptSymmetricallyText(value: string, key: CryptoKey, textEnco
  * - The provided key is not valid.
  * - The operation failed.
  */
-export function decryptSymmetricallyText(value: string, key: CryptoKey, textDecoder?: TextDecoder, urlSafe?: boolean): Promise<string>;
+export function decryptTextSymmetrically(value: string, key: CryptoKey, textDecoder?: TextDecoder, urlSafe?: boolean): Promise<string>;

index.js

@@ -53,7 +53,7 @@ export async function createSymmetricKeyWithText(
  * - The provided key is not valid.
  * - The operation failed (e.g., AES-GCM plaintext longer than 2^39−256 bytes).
  */
-export async function encryptSymmetricallyText(
+export async function encryptTextSymmetrically(
   value,
   key,
   textEncoder = new TextEncoder(),
@@ -92,7 +92,7 @@ export async function encryptSymmetricallyText(
  * - The provided key is not valid.
  * - The operation failed.
  */
-export async function decryptSymmetricallyText(
+export async function decryptTextSymmetrically(
   value,
   key,
   textDecoder = new TextDecoder(),

index.test.ts

@@ -1,5 +1,5 @@
 import { expect, test } from "bun:test"
-import { createSymmetricKeyWithText, encryptSymmetricallyText, decryptSymmetricallyText } from "."
+import { createSymmetricKeyWithText, encryptTextSymmetrically, decryptTextSymmetrically } from "."
 
 
 function randomString(length = 32) {
@@ -16,15 +16,15 @@ test("Generate a random symmetric CryptoKey", async() => {
 
 test("Encrypt a random value", async() => {
   const key = await createSymmetricKeyWithText(randomString())
-  expect(await encryptSymmetricallyText(randomString(), key)).toBeString()
+  expect(await encryptTextSymmetrically(randomString(), key)).toBeString()
 })
 
 
 test("Decrypt a random value", async() => {
   const symCryptoKey = await createSymmetricKeyWithText(randomString())
   const randomValue = randomString()
-  const encrypted = await encryptSymmetricallyText(randomValue, symCryptoKey)
-  const decrypted = await decryptSymmetricallyText(encrypted, symCryptoKey)
+  const encrypted = await encryptTextSymmetrically(randomValue, symCryptoKey)
+  const decrypted = await decryptTextSymmetrically(encrypted, symCryptoKey)
   expect(randomValue === decrypted).toBeTrue()
 })
 
@@ -34,15 +34,15 @@ test("Decrypt a random value with two different CryptoKey objects", async() => {
   const symCryptoKey = await createSymmetricKeyWithText(randomKeyString)
   const symCryptoKey2 = await createSymmetricKeyWithText(randomKeyString)
   const randomValue = randomString()
-  const encrypted = await encryptSymmetricallyText(randomValue, symCryptoKey)
-  const decrypted = await decryptSymmetricallyText(encrypted, symCryptoKey2)
+  const encrypted = await encryptTextSymmetrically(randomValue, symCryptoKey)
+  const decrypted = await decryptTextSymmetrically(encrypted, symCryptoKey2)
   expect(randomValue === decrypted).toBeTrue()
 })
 
 test("Check if encrypting and decrypting with different CryptoKey objects returns an error", async() => {
   const symCryptoKey = await createSymmetricKeyWithText(randomString())
   const symCryptoKey2 = await createSymmetricKeyWithText(randomString())
   const randomValue = randomString()
-  const encrypted = await encryptSymmetricallyText(randomValue, symCryptoKey)
-  expect(async() => await decryptSymmetricallyText(encrypted, symCryptoKey2)).toThrowError()
+  const encrypted = await encryptTextSymmetrically(randomValue, symCryptoKey)
+  expect(async() => await decryptTextSymmetrically(encrypted, symCryptoKey2)).toThrowError()
 })