@stryke/crypto 0.5.43 → 0.6.0

package/dist/node.d.cts

@@ -0,0 +1,117 @@
+import { BinaryLike, KeyObject } from "node:crypto";
+
+//#region src/base-64.d.ts
+
+/**
+ * Encodes a Uint8Array into a Base64 encoded Uint8Array.
+ *
+ * @credit https://github.com/hi-ogawa/js-utils
+ *
+ * @param input - The input Uint8Array or string to encode.
+ * @returns The Base64 encoded Uint8Array.
+ */
+declare function encodeBase64(input: Uint8Array | string): string;
+/**
+ * Decodes a Base64 encoded Uint8Array into a Uint8Array.
+ *
+ * @credit https://github.com/hi-ogawa/js-utils
+ *
+ * @param input - The Base64 encoded Uint8Array or string to decode.
+ * @returns The decoded Uint8Array.
+ */
+declare function decodeBase64(input: Uint8Array | string): Uint8Array;
+/**
+ * Converts a Base64 encoded string to a [Base64url](https://datatracker.ietf.org/doc/html/rfc7515#appendix-C) encoded string.
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc7515#appendix-C
+ *
+ * @param base64 - The Base64 encoded string to convert.
+ * @returns The Base64url encoded string.
+ */
+declare function base64UrlEncode(base64: Uint8Array): string;
+/**
+ * Converts a [Base64url](https://datatracker.ietf.org/doc/html/rfc7515#appendix-C) encoded string to a Base64 encoded string.
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc7515#appendix-C
+ *
+ * @param base64url - The Base64url encoded string to convert.
+ * @returns The Base64 encoded string.
+ */
+declare function base64UrlDecode(base64url: string): Uint8Array;
+//#endregion
+//#region src/encryption.node.d.ts
+/**
+ * Creates and returns a new key object containing a secret key for symmetric encryption or \`Hmac\`.
+ *
+ * @param key - The key to use when creating the \`KeyObject\`.
+ * @returns The new \`KeyObject\`.
+ */
+declare function createKey(key: NodeJS.ArrayBufferView): KeyObject;
+/**
+ * Creates and returns a new key object containing a secret key for symmetric encryption or \`Hmac\`.
+ *
+ * @param key - The key to use. If \`key\` is a \`Buffer\`, \`TypedArray\`, or \`DataView\`, the \`encoding\` argument is ignored.
+ * @param encoding - The \`encoding\` of the \`key\` string. Must be one of \`'utf8'\`, \`'utf16le'\`, \`'latin1'\`, or \`'base64'\`. Default is \`'utf8'\`.
+ * @returns The new \`KeyObject\`.
+ */
+declare function createKey(key: string, encoding: BufferEncoding): KeyObject;
+/**
+ * Symmetrically encrypts data using the [ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) cipher.
+ *
+ * @see https://en.wikipedia.org/wiki/ChaCha20-Poly1305
+ *
+ * @param secret - The secret key used for encryption.
+ * @param plaintext - The data to encrypt.
+ * @returns The encrypted data.
+ */
+declare function encrypt(secret: BinaryLike, plaintext: string): string;
+/**
+ * Symmetrically decrypts data using the [ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) cipher.
+ *
+ * @see https://en.wikipedia.org/wiki/ChaCha20-Poly1305
+ *
+ * @param secret - The secret key used for decryption.
+ * @param encrypted - The encrypted data to decrypt.
+ * @returns The decrypted data.
+ */
+declare function decrypt(secret: BinaryLike, encrypted: string): string;
+//#endregion
+//#region src/hex.d.ts
+/**
+ * Encodes a Uint8Array into a hexadecimal string.
+ *
+ * @param input - The input Uint8Array.
+ * @returns The hexadecimal string.
+ */
+declare function encodeHex(input: Uint8Array): string;
+/**
+ * Encodes a Uint8Array into an uppercase hexadecimal string.
+ *
+ * @param input - The input Uint8Array.
+ * @returns The uppercase hexadecimal string.
+ */
+declare function decodeHex(input: string): Uint8Array;
+//#endregion
+//#region src/random.d.ts
+/**
+ * Generate a random byte array of the specified length using the Web Crypto API.
+ *
+ * @param length - The length of the random byte array to generate (default is 32 bytes)
+ * @returns A Uint8Array containing random bytes of the specified length
+ */
+declare function generateRandomBytes(length?: number): Uint8Array;
+/**
+ * Generate a random string of the specified length using characters A-Z, a-z, and 0-9 for CSRF tokens, etc.
+ *
+ * @remarks
+ * This function uses the Web Crypto API's `crypto.getRandomValues` to generate secure random bytes,
+ * and then maps those bytes to characters in the specified character set. It uses rejection sampling
+ * to ensure a uniform distribution of characters without modulo bias.
+ *
+ * @param length - The length of the random string to generate (default is 32 characters)
+ * @returns A random string of the specified length
+ */
+declare function generateRandomString(length?: number): string;
+//#endregion
+export { base64UrlDecode, base64UrlEncode, createKey, decodeBase64, decodeHex, decrypt, encodeBase64, encodeHex, encrypt, generateRandomBytes, generateRandomString };
+//# sourceMappingURL=node.d.cts.map

package/dist/node.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.cts","names":[],"sources":["../src/base-64.ts","../src/encryption.node.ts","../src/hex.ts","../src/random.ts"],"sourcesContent":[],"mappings":";;;;;;;AAoEA;AAmDA;AAkFA;AAeA;;iBApJgB,YAAA,QAAoB;;ACvBpC;AASA;AA2BA;AA4CA;;;;AC3EgB,iBFqEA,YAAA,CErEiB,KAAU,EFqEP,UErEO,GAAA,MAAA,CAAA,EFqEe,UErEf;AAe3C;;;;ACzCA;AAeA;;;iBHkKgB,eAAA,SAAwB;;;;;;;;;iBAexB,eAAA,qBAAoC;;;;;AApJpD;AAmDA;AAkFA;AAeA;iBC3KgB,SAAA,MAAe,MAAA,CAAO,kBAAkB;;;AAAxD;AASA;AA2BA;AA4CA;;iBAvEgB,SAAA,wBAAiC,iBAAiB;;ACJlE;AAeA;;;;ACzCA;AAeA;;iBF0CgB,OAAA,SAAgB;;;;;;;;;;iBA4ChB,OAAA,SAAgB;;;;;;ADzDhC;AAmDA;AAkFA;AAegB,iBEtKA,SAAA,CFsKoC,KAAA,EEtKnB,UFsK6B,CAAA,EAAA,MAAA;;;;AC3K9D;AASA;AA2BA;AA4CgB,iBC5DA,SAAA,CD4DgB,KAAU,EAAA,MAAA,CAAA,EC5DA,UD4DA;;;;;;ADzD1C;AAmDA;AAkFA;AAegB,iBGhMA,mBAAA,CHgM8C,MAAA,CAAA,EAAA,MAAA,CAAA,EGhMJ,UHgMI;;;;AC3K9D;AASA;AA2BA;AA4CA;;;;AC3EA;AAegB,iBC1BA,oBAAA,CD0BoC,MAAA,CAAA,EAAA,MAAA,CAAA,EAAA,MAAA"}

package/dist/node.d.mts

@@ -0,0 +1,117 @@
+import { BinaryLike, KeyObject } from "node:crypto";
+
+//#region src/base-64.d.ts
+
+/**
+ * Encodes a Uint8Array into a Base64 encoded Uint8Array.
+ *
+ * @credit https://github.com/hi-ogawa/js-utils
+ *
+ * @param input - The input Uint8Array or string to encode.
+ * @returns The Base64 encoded Uint8Array.
+ */
+declare function encodeBase64(input: Uint8Array | string): string;
+/**
+ * Decodes a Base64 encoded Uint8Array into a Uint8Array.
+ *
+ * @credit https://github.com/hi-ogawa/js-utils
+ *
+ * @param input - The Base64 encoded Uint8Array or string to decode.
+ * @returns The decoded Uint8Array.
+ */
+declare function decodeBase64(input: Uint8Array | string): Uint8Array;
+/**
+ * Converts a Base64 encoded string to a [Base64url](https://datatracker.ietf.org/doc/html/rfc7515#appendix-C) encoded string.
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc7515#appendix-C
+ *
+ * @param base64 - The Base64 encoded string to convert.
+ * @returns The Base64url encoded string.
+ */
+declare function base64UrlEncode(base64: Uint8Array): string;
+/**
+ * Converts a [Base64url](https://datatracker.ietf.org/doc/html/rfc7515#appendix-C) encoded string to a Base64 encoded string.
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc7515#appendix-C
+ *
+ * @param base64url - The Base64url encoded string to convert.
+ * @returns The Base64 encoded string.
+ */
+declare function base64UrlDecode(base64url: string): Uint8Array;
+//#endregion
+//#region src/encryption.node.d.ts
+/**
+ * Creates and returns a new key object containing a secret key for symmetric encryption or \`Hmac\`.
+ *
+ * @param key - The key to use when creating the \`KeyObject\`.
+ * @returns The new \`KeyObject\`.
+ */
+declare function createKey(key: NodeJS.ArrayBufferView): KeyObject;
+/**
+ * Creates and returns a new key object containing a secret key for symmetric encryption or \`Hmac\`.
+ *
+ * @param key - The key to use. If \`key\` is a \`Buffer\`, \`TypedArray\`, or \`DataView\`, the \`encoding\` argument is ignored.
+ * @param encoding - The \`encoding\` of the \`key\` string. Must be one of \`'utf8'\`, \`'utf16le'\`, \`'latin1'\`, or \`'base64'\`. Default is \`'utf8'\`.
+ * @returns The new \`KeyObject\`.
+ */
+declare function createKey(key: string, encoding: BufferEncoding): KeyObject;
+/**
+ * Symmetrically encrypts data using the [ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) cipher.
+ *
+ * @see https://en.wikipedia.org/wiki/ChaCha20-Poly1305
+ *
+ * @param secret - The secret key used for encryption.
+ * @param plaintext - The data to encrypt.
+ * @returns The encrypted data.
+ */
+declare function encrypt(secret: BinaryLike, plaintext: string): string;
+/**
+ * Symmetrically decrypts data using the [ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) cipher.
+ *
+ * @see https://en.wikipedia.org/wiki/ChaCha20-Poly1305
+ *
+ * @param secret - The secret key used for decryption.
+ * @param encrypted - The encrypted data to decrypt.
+ * @returns The decrypted data.
+ */
+declare function decrypt(secret: BinaryLike, encrypted: string): string;
+//#endregion
+//#region src/hex.d.ts
+/**
+ * Encodes a Uint8Array into a hexadecimal string.
+ *
+ * @param input - The input Uint8Array.
+ * @returns The hexadecimal string.
+ */
+declare function encodeHex(input: Uint8Array): string;
+/**
+ * Encodes a Uint8Array into an uppercase hexadecimal string.
+ *
+ * @param input - The input Uint8Array.
+ * @returns The uppercase hexadecimal string.
+ */
+declare function decodeHex(input: string): Uint8Array;
+//#endregion
+//#region src/random.d.ts
+/**
+ * Generate a random byte array of the specified length using the Web Crypto API.
+ *
+ * @param length - The length of the random byte array to generate (default is 32 bytes)
+ * @returns A Uint8Array containing random bytes of the specified length
+ */
+declare function generateRandomBytes(length?: number): Uint8Array;
+/**
+ * Generate a random string of the specified length using characters A-Z, a-z, and 0-9 for CSRF tokens, etc.
+ *
+ * @remarks
+ * This function uses the Web Crypto API's `crypto.getRandomValues` to generate secure random bytes,
+ * and then maps those bytes to characters in the specified character set. It uses rejection sampling
+ * to ensure a uniform distribution of characters without modulo bias.
+ *
+ * @param length - The length of the random string to generate (default is 32 characters)
+ * @returns A random string of the specified length
+ */
+declare function generateRandomString(length?: number): string;
+//#endregion
+export { base64UrlDecode, base64UrlEncode, createKey, decodeBase64, decodeHex, decrypt, encodeBase64, encodeHex, encrypt, generateRandomBytes, generateRandomString };
+//# sourceMappingURL=node.d.mts.map

package/dist/node.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.mts","names":[],"sources":["../src/base-64.ts","../src/encryption.node.ts","../src/hex.ts","../src/random.ts"],"sourcesContent":[],"mappings":";;;;;;;AAoEA;AAmDA;AAkFA;AAeA;;iBApJgB,YAAA,QAAoB;;ACvBpC;AASA;AA2BA;AA4CA;;;;AC3EgB,iBFqEA,YAAA,CErEiB,KAAU,EFqEP,UErEO,GAAA,MAAA,CAAA,EFqEe,UErEf;AAe3C;;;;ACzCA;AAeA;;;iBHkKgB,eAAA,SAAwB;;;;;;;;;iBAexB,eAAA,qBAAoC;;;;;AApJpD;AAmDA;AAkFA;AAeA;iBC3KgB,SAAA,MAAe,MAAA,CAAO,kBAAkB;;;AAAxD;AASA;AA2BA;AA4CA;;iBAvEgB,SAAA,wBAAiC,iBAAiB;;ACJlE;AAeA;;;;ACzCA;AAeA;;iBF0CgB,OAAA,SAAgB;;;;;;;;;;iBA4ChB,OAAA,SAAgB;;;;;;ADzDhC;AAmDA;AAkFA;AAegB,iBEtKA,SAAA,CFsKoC,KAAA,EEtKnB,UFsK6B,CAAA,EAAA,MAAA;;;;AC3K9D;AASA;AA2BA;AA4CgB,iBC5DA,SAAA,CD4DgB,KAAU,EAAA,MAAA,CAAA,EC5DA,UD4DA;;;;;;ADzD1C;AAmDA;AAkFA;AAegB,iBGhMA,mBAAA,CHgM8C,MAAA,CAAA,EAAA,MAAA,CAAA,EGhMJ,UHgMI;;;;AC3K9D;AASA;AA2BA;AA4CA;;;;AC3EA;AAegB,iBC1BA,oBAAA,CD0BoC,MAAA,CAAA,EAAA,MAAA,CAAA,EAAA,MAAA"}