@stryke/hash 0.12.52 → 0.13.0

package/dist/node.d.cts

@@ -0,0 +1,172 @@
+import { GlobOptions } from "glob";
+
+//#region src/digest.d.ts
+type AlgorithmIdentifier = "SHA-256" | "SHA-384" | "SHA-512";
+/**
+ * Creates a new hash object for the specified algorithm.
+ *
+ * @param algorithm - The algorithm to use for the hash.
+ * @returns A new hash object.
+ */
+declare function createHasher(algorithm: AlgorithmIdentifier): Hasher;
+/**
+ * Creates a new hash object for the specified algorithm.
+ *
+ * @remarks
+ * This function uses the Web Crypto API to create a hash of the input data.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest
+ *
+ * @param data - The data to hash.
+ * @param algorithm - The algorithm to use for the hash.
+ * @returns A hash string representation of the `data` parameter.
+ */
+declare function digest(data: string | Uint8Array, algorithm?: AlgorithmIdentifier): Promise<string>;
+/**
+ * Alias for {@link digest}.
+ */
+declare const hash: typeof digest;
+/**
+ * Hash a string or Uint8Array using SHA-256 and return the result as a base64url-encoded string.
+ *
+ * @param data - The data to hash.
+ * @returns A hash string representation of the `data` parameter.
+ */
+declare const sha256: (data: string | Uint8Array) => Promise<string>;
+/**
+ * Hash a string or Uint8Array using SHA-384 and return the result as a base64url-encoded string.
+ *
+ * @param data - The data to hash.
+ * @returns A hash string representation of the `data` parameter.
+ */
+declare const sha384: (data: string | Uint8Array) => Promise<string>;
+/**
+ * Hash a string or Uint8Array using SHA-512 and return the result as a base64url-encoded string.
+ *
+ * @param data - The data to hash.
+ * @returns A hash string representation of the `data` parameter.
+ */
+declare const sha512: (data: string | Uint8Array) => Promise<string>;
+declare class Hasher {
+  #private;
+  constructor(algorithm: AlgorithmIdentifier);
+  update(data: Uint8Array): void;
+  digest(): Promise<Uint8Array>;
+}
+//#endregion
+//#region src/etag.d.ts
+/**
+ * FNV-1a Hash implementation
+ *
+ * Ported from https://github.com/tjwebb/fnv-plus/blob/master/index.js
+ *
+ * @remarks
+ * Simplified, optimized and add modified for 52 bit, which provides a larger hash space
+ * and still making use of Javascript's 53-bit integer space.
+ */
+declare const fnv1a52: (str: string) => number;
+/**
+ * Generates an ETag for the given payload.
+ *
+ * @param payload - The payload to generate an ETag for.
+ * @param weak - Whether to generate a weak ETag.
+ * @returns The generated ETag.
+ */
+declare const generateETag: (payload: string, weak?: boolean) => string;
+//#endregion
+//#region src/hash-content.d.ts
+/**
+ * Hash the content of a PDU (Protocol Data Unit) by removing the `signatures` and `unsigned` fields, then hashing the remaining content using SHA-256 and encoding it as a base64url string. This function is useful for generating a consistent hash of the PDU content that can be used for integrity verification or caching purposes, while ignoring any fields that may change due to signatures or unsigned data.
+ *
+ * @param content - The PDU content to hash, represented as a record of string keys and unknown values.
+ * @returns A promise that resolves to a base64url-encoded string representing the hash of the PDU content.
+ */
+declare function hashContent(content: Record<string, unknown>): Promise<string>;
+/**
+ * Verify the hash of a PDU (Protocol Data Unit) content by hashing the content using the {@link hashContent} function and comparing it to an expected hash value. This function is useful for validating the integrity of the PDU content by ensuring that the computed hash matches the expected hash, which can be used to detect any tampering or corruption of the content.
+ *
+ * @param content - The PDU content to verify, represented as a record of string keys and unknown values.
+ * @param expectedHash - The expected hash value to compare against, represented as a string.
+ * @returns A promise that resolves to a boolean indicating whether the computed hash of the content matches the expected hash value (true if they match, false otherwise).
+ */
+declare function verifyContent(content: Record<string, unknown>, expectedHash: string): Promise<boolean>;
+//#endregion
+//#region ../fs/src/list-files.d.ts
+type ListOptions = GlobOptions;
+//#endregion
+//#region src/murmurhash.d.ts
+interface HashOptions {
+  /**
+   * The maximum length of the hash
+   *
+   * @defaultValue 32
+   */
+  maxLength?: number;
+}
+/**
+ * Use a [MurmurHash3](https://en.wikipedia.org/wiki/MurmurHash) based algorithm to hash any JS value into a string.
+ *
+ * @see https://github.com/ohash/ohash
+ * @see https://en.wikipedia.org/wiki/MurmurHash
+ *
+ * @param content - The value to hash
+ * @param  options - Hashing options
+ * @returns A hashed string value
+ */
+declare function murmurhash(content: any, options?: HashOptions): string;
+//#endregion
+//#region src/hash-files.d.ts
+/**
+ * Hash a list of file paths into a string based on the file content
+ *
+ * @param files - The list of file paths to hash
+ * @param  options - Hashing options
+ * @returns A hashed string value
+ */
+declare function hashFiles(files: string[], options?: HashOptions): Promise<string>;
+/**
+ * Hash a folder path into a string based on the file content
+ *
+ * @param directoryPath - The folder path to hash
+ * @param  options - Hashing options. By default, the `node_modules`, `.git`, `.nx`, `.cache`, and `tmp` folders is ignored.
+ * @returns A hashed string value
+ */
+declare function hashDirectory(directoryPath: string, options?: HashOptions & ListOptions): Promise<string>;
+//#endregion
+//#region src/md5.d.ts
+/**
+ * Generate an MD5 hash of the provided content.
+ *
+ * @param content - The content to hash.
+ * @param length - The length of the hash to return.
+ * @returns The generated MD5 hash.
+ */
+declare function md5(content: string, length?: number): string;
+//#endregion
+//#region src/pbkdf2.d.ts
+/**
+ * Hash a password using PBKDF2 (Web Crypto compatible alternative to Argon2) with SHA-256, 100,000 iterations, and a random salt. The resulting hash is formatted as: `$pbkdf2-sha256$iterations$salt$hash`.
+ *
+ * @remarks
+ * This function uses the Web Crypto API to perform password hashing. It generates a random salt for each password, and uses PBKDF2 with SHA-256 and 100,000 iterations to derive a secure hash. The output is a string that includes the algorithm, iteration count, salt, and hash, which can be stored in a database for later verification using the {@link verifyPassword} function.
+ *
+ * @param password - The password to hash.
+ * @returns A promise that resolves to the hashed password string.
+ */
+declare function hashPassword(password: string): Promise<string>;
+/**
+ * Verify a password against a stored hash in the format produced by {@link hashPassword}.
+ *
+ * @param password - The password to verify.
+ * @param storedHash - The stored hash to verify against.
+ * @returns A promise that resolves to true if the password is correct, false otherwise.
+ */
+declare function verifyPassword(password: string, storedHash: string): Promise<boolean>;
+//#endregion
+//#region src/xx-hash.d.ts
+declare const xxHash32: (s: string) => number;
+declare const xxHash64: (s: string) => bigint;
+declare const xxHash128: (s: string) => bigint;
+//#endregion
+export { AlgorithmIdentifier, HashOptions, Hasher, createHasher, digest, fnv1a52, generateETag, hash, hashContent, hashDirectory, hashFiles, hashPassword, md5, murmurhash, sha256, sha384, sha512, verifyContent, verifyPassword, xxHash128, xxHash32, xxHash64 };
+//# sourceMappingURL=node.d.cts.map

package/dist/node.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.cts","names":[],"sources":["../src/digest.ts","../src/etag.ts","../src/hash-content.ts","../../fs/src/list-files.ts","../src/murmurhash.ts","../src/hash-files.ts","../src/md5.ts","../src/pbkdf2.ts","../src/xx-hash.ts"],"sourcesContent":[],"mappings":";;;KAoBY,mBAAA;;;AAAZ;AAQA;AAgBA;;AAEa,iBAlBG,YAAA,CAkBH,SAAA,EAlB2B,mBAkB3B,CAAA,EAlBiD,MAkBjD;;;AAiBb;AAQA;AASA;AASA;AAGA;;;;;;iBAhDsB,MAAA,gBACL,wBACJ,sBACV;;;ACpBH;AA2Ca,cDPA,ICWZ,EAAA,ODXgB,MCWhB;;;;AC/CD;AAkBA;;cF0Ba,wBAA+B,eAAU;;AG9CtD;;;;ACLA;AAmBgB,cJyCH,MIzCa,EAAyB,CAAA,IAAA,EAAA,MAAW,GJyClB,UIzCkB,EAAA,GJyCR,OIzCQ,CAAA,MAAA,CAAA;;;;ACR9D;AAqBA;;AAEyB,cLmCZ,MKnCY,EAAA,CAAA,IAAA,EAAA,MAAA,GLmCmB,UKnCnB,EAAA,GLmC6B,OKnC7B,CAAA,MAAA,CAAA;AACtB,cLqCU,MAAA,CKrCV;EAAO,CAAA,OAAA;yBL0Ce;eAIV;YAIG,QAAQ;AM9E1B;;;;;;ANPA;AAQA;AAgBA;;;;AAGU,cCpBG,ODoBH,EAAA,CAAA,GAAA,EAAA,MAAA,EAAA,GAAA,MAAA;AAgBV;AAQA;AASA;AASA;AAGA;;;AAa0B,cCnCb,YDmCa,EAAA,CAAA,OAAA,EAAA,MAAA,EAAA,IAAA,CAAA,EAAA,OAAA,EAAA,GAAA,MAAA;;;;;;AArF1B;AAQA;AAgBA;AACiB,iBElBK,WAAA,CFkBL,OAAA,EEjBN,MFiBM,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,EEhBd,OFgBc,CAAA,MAAA,CAAA;;;;AAkBjB;AAQA;AASA;AASA;AAGa,iBE/CS,aAAA,CF+CH,OAAA,EE9CR,MF8CQ,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,YAAA,EAAA,MAAA,CAAA,EE5ChB,OF4CgB,CAAA,OAAA,CAAA;;;KGnEP,WAAA,GAAc;;;UCLT,WAAA;;;AJAjB;AAQA;AAgBA;EACiB,SAAA,CAAA,EAAA,MAAA;;;;AAkBjB;AAQA;AASA;AASA;AAGA;;;;AAakB,iBIlEF,UAAA,CJkEE,OAAA,EAAA,GAAA,EAAA,OAAA,CAAA,EIlEiC,WJkEjC,CAAA,EAAA,MAAA;;;;AArFlB;AAQA;AAgBA;;;;AAGU,iBKhBY,SAAA,CLgBZ,KAAA,EAAA,MAAA,EAAA,EAAA,OAAA,CAAA,EKdE,WLcF,CAAA,EKbP,OLaO,CAAA,MAAA,CAAA;AAgBV;AAQA;AASA;AASA;AAGA;;;AAa0B,iBKrDJ,aAAA,CLqDI,aAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EKnDf,WLmDe,GKnDD,WLmDC,CAAA,EKlDvB,OLkDuB,CAAA,MAAA,CAAA;;;;;;AArF1B;AAQA;AAgBA;;AAEa,iBMnBG,GAAA,CNmBH,OAAA,EAAA,MAAA,EAAA,MAAA,CAAA,EAAA,MAAA,CAAA,EAAA,MAAA;;;;;;AA1Bb;AAQA;AAgBA;;;;AAGU,iBOpBY,YAAA,CPoBZ,QAAA,EAAA,MAAA,CAAA,EOpB4C,OPoB5C,CAAA,MAAA,CAAA;AAgBV;AAQA;AASA;AASA;AAGA;;;AAa0B,iBOzCJ,cAAA,CPyCI,QAAA,EAAA,MAAA,EAAA,UAAA,EAAA,MAAA,CAAA,EOtCvB,OPsCuB,CAAA,OAAA,CAAA;;;cQrEb;cACA;cACA"}

package/dist/node.d.mts

@@ -0,0 +1,172 @@
+import { GlobOptions } from "glob";
+
+//#region src/digest.d.ts
+type AlgorithmIdentifier = "SHA-256" | "SHA-384" | "SHA-512";
+/**
+ * Creates a new hash object for the specified algorithm.
+ *
+ * @param algorithm - The algorithm to use for the hash.
+ * @returns A new hash object.
+ */
+declare function createHasher(algorithm: AlgorithmIdentifier): Hasher;
+/**
+ * Creates a new hash object for the specified algorithm.
+ *
+ * @remarks
+ * This function uses the Web Crypto API to create a hash of the input data.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest
+ *
+ * @param data - The data to hash.
+ * @param algorithm - The algorithm to use for the hash.
+ * @returns A hash string representation of the `data` parameter.
+ */
+declare function digest(data: string | Uint8Array, algorithm?: AlgorithmIdentifier): Promise<string>;
+/**
+ * Alias for {@link digest}.
+ */
+declare const hash: typeof digest;
+/**
+ * Hash a string or Uint8Array using SHA-256 and return the result as a base64url-encoded string.
+ *
+ * @param data - The data to hash.
+ * @returns A hash string representation of the `data` parameter.
+ */
+declare const sha256: (data: string | Uint8Array) => Promise<string>;
+/**
+ * Hash a string or Uint8Array using SHA-384 and return the result as a base64url-encoded string.
+ *
+ * @param data - The data to hash.
+ * @returns A hash string representation of the `data` parameter.
+ */
+declare const sha384: (data: string | Uint8Array) => Promise<string>;
+/**
+ * Hash a string or Uint8Array using SHA-512 and return the result as a base64url-encoded string.
+ *
+ * @param data - The data to hash.
+ * @returns A hash string representation of the `data` parameter.
+ */
+declare const sha512: (data: string | Uint8Array) => Promise<string>;
+declare class Hasher {
+  #private;
+  constructor(algorithm: AlgorithmIdentifier);
+  update(data: Uint8Array): void;
+  digest(): Promise<Uint8Array>;
+}
+//#endregion
+//#region src/etag.d.ts
+/**
+ * FNV-1a Hash implementation
+ *
+ * Ported from https://github.com/tjwebb/fnv-plus/blob/master/index.js
+ *
+ * @remarks
+ * Simplified, optimized and add modified for 52 bit, which provides a larger hash space
+ * and still making use of Javascript's 53-bit integer space.
+ */
+declare const fnv1a52: (str: string) => number;
+/**
+ * Generates an ETag for the given payload.
+ *
+ * @param payload - The payload to generate an ETag for.
+ * @param weak - Whether to generate a weak ETag.
+ * @returns The generated ETag.
+ */
+declare const generateETag: (payload: string, weak?: boolean) => string;
+//#endregion
+//#region src/hash-content.d.ts
+/**
+ * Hash the content of a PDU (Protocol Data Unit) by removing the `signatures` and `unsigned` fields, then hashing the remaining content using SHA-256 and encoding it as a base64url string. This function is useful for generating a consistent hash of the PDU content that can be used for integrity verification or caching purposes, while ignoring any fields that may change due to signatures or unsigned data.
+ *
+ * @param content - The PDU content to hash, represented as a record of string keys and unknown values.
+ * @returns A promise that resolves to a base64url-encoded string representing the hash of the PDU content.
+ */
+declare function hashContent(content: Record<string, unknown>): Promise<string>;
+/**
+ * Verify the hash of a PDU (Protocol Data Unit) content by hashing the content using the {@link hashContent} function and comparing it to an expected hash value. This function is useful for validating the integrity of the PDU content by ensuring that the computed hash matches the expected hash, which can be used to detect any tampering or corruption of the content.
+ *
+ * @param content - The PDU content to verify, represented as a record of string keys and unknown values.
+ * @param expectedHash - The expected hash value to compare against, represented as a string.
+ * @returns A promise that resolves to a boolean indicating whether the computed hash of the content matches the expected hash value (true if they match, false otherwise).
+ */
+declare function verifyContent(content: Record<string, unknown>, expectedHash: string): Promise<boolean>;
+//#endregion
+//#region ../fs/src/list-files.d.ts
+type ListOptions = GlobOptions;
+//#endregion
+//#region src/murmurhash.d.ts
+interface HashOptions {
+  /**
+   * The maximum length of the hash
+   *
+   * @defaultValue 32
+   */
+  maxLength?: number;
+}
+/**
+ * Use a [MurmurHash3](https://en.wikipedia.org/wiki/MurmurHash) based algorithm to hash any JS value into a string.
+ *
+ * @see https://github.com/ohash/ohash
+ * @see https://en.wikipedia.org/wiki/MurmurHash
+ *
+ * @param content - The value to hash
+ * @param  options - Hashing options
+ * @returns A hashed string value
+ */
+declare function murmurhash(content: any, options?: HashOptions): string;
+//#endregion
+//#region src/hash-files.d.ts
+/**
+ * Hash a list of file paths into a string based on the file content
+ *
+ * @param files - The list of file paths to hash
+ * @param  options - Hashing options
+ * @returns A hashed string value
+ */
+declare function hashFiles(files: string[], options?: HashOptions): Promise<string>;
+/**
+ * Hash a folder path into a string based on the file content
+ *
+ * @param directoryPath - The folder path to hash
+ * @param  options - Hashing options. By default, the `node_modules`, `.git`, `.nx`, `.cache`, and `tmp` folders is ignored.
+ * @returns A hashed string value
+ */
+declare function hashDirectory(directoryPath: string, options?: HashOptions & ListOptions): Promise<string>;
+//#endregion
+//#region src/md5.d.ts
+/**
+ * Generate an MD5 hash of the provided content.
+ *
+ * @param content - The content to hash.
+ * @param length - The length of the hash to return.
+ * @returns The generated MD5 hash.
+ */
+declare function md5(content: string, length?: number): string;
+//#endregion
+//#region src/pbkdf2.d.ts
+/**
+ * Hash a password using PBKDF2 (Web Crypto compatible alternative to Argon2) with SHA-256, 100,000 iterations, and a random salt. The resulting hash is formatted as: `$pbkdf2-sha256$iterations$salt$hash`.
+ *
+ * @remarks
+ * This function uses the Web Crypto API to perform password hashing. It generates a random salt for each password, and uses PBKDF2 with SHA-256 and 100,000 iterations to derive a secure hash. The output is a string that includes the algorithm, iteration count, salt, and hash, which can be stored in a database for later verification using the {@link verifyPassword} function.
+ *
+ * @param password - The password to hash.
+ * @returns A promise that resolves to the hashed password string.
+ */
+declare function hashPassword(password: string): Promise<string>;
+/**
+ * Verify a password against a stored hash in the format produced by {@link hashPassword}.
+ *
+ * @param password - The password to verify.
+ * @param storedHash - The stored hash to verify against.
+ * @returns A promise that resolves to true if the password is correct, false otherwise.
+ */
+declare function verifyPassword(password: string, storedHash: string): Promise<boolean>;
+//#endregion
+//#region src/xx-hash.d.ts
+declare const xxHash32: (s: string) => number;
+declare const xxHash64: (s: string) => bigint;
+declare const xxHash128: (s: string) => bigint;
+//#endregion
+export { AlgorithmIdentifier, HashOptions, Hasher, createHasher, digest, fnv1a52, generateETag, hash, hashContent, hashDirectory, hashFiles, hashPassword, md5, murmurhash, sha256, sha384, sha512, verifyContent, verifyPassword, xxHash128, xxHash32, xxHash64 };
+//# sourceMappingURL=node.d.mts.map

package/dist/node.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.mts","names":[],"sources":["../src/digest.ts","../src/etag.ts","../src/hash-content.ts","../../fs/src/list-files.ts","../src/murmurhash.ts","../src/hash-files.ts","../src/md5.ts","../src/pbkdf2.ts","../src/xx-hash.ts"],"sourcesContent":[],"mappings":";;;KAoBY,mBAAA;;;AAAZ;AAQA;AAgBA;;AAEa,iBAlBG,YAAA,CAkBH,SAAA,EAlB2B,mBAkB3B,CAAA,EAlBiD,MAkBjD;;;AAiBb;AAQA;AASA;AASA;AAGA;;;;;;iBAhDsB,MAAA,gBACL,wBACJ,sBACV;;;ACpBH;AA2Ca,cDPA,ICWZ,EAAA,ODXgB,MCWhB;;;;AC/CD;AAkBA;;cF0Ba,wBAA+B,eAAU;;AG9CtD;;;;ACLA;AAmBgB,cJyCH,MIzCa,EAAyB,CAAA,IAAA,EAAA,MAAW,GJyClB,UIzCkB,EAAA,GJyCR,OIzCQ,CAAA,MAAA,CAAA;;;;ACR9D;AAqBA;;AAEyB,cLmCZ,MKnCY,EAAA,CAAA,IAAA,EAAA,MAAA,GLmCmB,UKnCnB,EAAA,GLmC6B,OKnC7B,CAAA,MAAA,CAAA;AACtB,cLqCU,MAAA,CKrCV;EAAO,CAAA,OAAA;yBL0Ce;eAIV;YAIG,QAAQ;AM9E1B;;;;;;ANPA;AAQA;AAgBA;;;;AAGU,cCpBG,ODoBH,EAAA,CAAA,GAAA,EAAA,MAAA,EAAA,GAAA,MAAA;AAgBV;AAQA;AASA;AASA;AAGA;;;AAa0B,cCnCb,YDmCa,EAAA,CAAA,OAAA,EAAA,MAAA,EAAA,IAAA,CAAA,EAAA,OAAA,EAAA,GAAA,MAAA;;;;;;AArF1B;AAQA;AAgBA;AACiB,iBElBK,WAAA,CFkBL,OAAA,EEjBN,MFiBM,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,EEhBd,OFgBc,CAAA,MAAA,CAAA;;;;AAkBjB;AAQA;AASA;AASA;AAGa,iBE/CS,aAAA,CF+CH,OAAA,EE9CR,MF8CQ,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,YAAA,EAAA,MAAA,CAAA,EE5ChB,OF4CgB,CAAA,OAAA,CAAA;;;KGnEP,WAAA,GAAc;;;UCLT,WAAA;;;AJAjB;AAQA;AAgBA;EACiB,SAAA,CAAA,EAAA,MAAA;;;;AAkBjB;AAQA;AASA;AASA;AAGA;;;;AAakB,iBIlEF,UAAA,CJkEE,OAAA,EAAA,GAAA,EAAA,OAAA,CAAA,EIlEiC,WJkEjC,CAAA,EAAA,MAAA;;;;AArFlB;AAQA;AAgBA;;;;AAGU,iBKhBY,SAAA,CLgBZ,KAAA,EAAA,MAAA,EAAA,EAAA,OAAA,CAAA,EKdE,WLcF,CAAA,EKbP,OLaO,CAAA,MAAA,CAAA;AAgBV;AAQA;AASA;AASA;AAGA;;;AAa0B,iBKrDJ,aAAA,CLqDI,aAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EKnDf,WLmDe,GKnDD,WLmDC,CAAA,EKlDvB,OLkDuB,CAAA,MAAA,CAAA;;;;;;AArF1B;AAQA;AAgBA;;AAEa,iBMnBG,GAAA,CNmBH,OAAA,EAAA,MAAA,EAAA,MAAA,CAAA,EAAA,MAAA,CAAA,EAAA,MAAA;;;;;;AA1Bb;AAQA;AAgBA;;;;AAGU,iBOpBY,YAAA,CPoBZ,QAAA,EAAA,MAAA,CAAA,EOpB4C,OPoB5C,CAAA,MAAA,CAAA;AAgBV;AAQA;AASA;AASA;AAGA;;;AAa0B,iBOzCJ,cAAA,CPyCI,QAAA,EAAA,MAAA,EAAA,UAAA,EAAA,MAAA,CAAA,EOtCvB,OPsCuB,CAAA,OAAA,CAAA;;;cQrEb;cACA;cACA"}