@sequencemedia/pbkdf2 1.0.405 → 1.1.0

package/config/compare.mjs

@@ -1,17 +1,26 @@
 import argsMap from '#utils/args-map'
 
+/**
+ *  @type {number}
+ */
 export const ITERATIONS = (
   argsMap.has('ITERATIONS')
     ? argsMap.get('ITERATIONS')
     : 10
 )
 
+/**
+ *  @type {number}
+ */
 export const KEYLEN = (
   argsMap.has('KEYLEN')
     ? argsMap.get('KEYLEN')
     : 64
 )
 
+/**
+ *  @type {string}
+ */
 export const DIGEST = (
   argsMap.has('DIGEST')
     ? argsMap.get('DIGEST')

package/index.d.mts

@@ -1,5 +1,22 @@
-declare module '@sequencemedia/pbkdf2' {
-  export function compare(password: string, params: { salt: string, hash: Buffer, iteration?: number, keylen?: number, digest?: string }): Promise<boolean>
-  export function hash (password: string, params: { salt: string, iteration?: number, keylen?: number, digest?: string }): Promise<Buffer>
-  export function salt (size: number): Promise<Buffer>
+import type {
+  BinaryLike
+} from 'node:crypto'
+
+export type CompareParams = {
+  salt: BinaryLike,
+  hash: Buffer,
+  iterations?: number,
+  keylen?: number,
+  digest?: string
 }
+
+export type HashParams = {
+  salt: BinaryLike,
+  iterations?: number,
+  keylen?: number,
+  digest?: string
+}
+
+export function compare(password: BinaryLike, params: CompareParams): Promise<boolean>
+export function hash (password: BinaryLike, params: HashParams): Promise<Buffer>
+export function salt (size: number): Promise<Buffer>

package/jsconfig.json

@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "baseUrl": "."
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sequencemedia/pbkdf2",
-  "version": "1.0.405",
+  "version": "1.1.0",
   "keywords": [
     "pbkdf2",
     "crypto",
@@ -37,12 +37,12 @@
     "yargs-parser": "^21.1.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.26.9",
-    "@babel/preset-env": "^7.26.9",
-    "@sequencemedia/eslint-config-standard": "^0.2.34",
+    "@sequencemedia/eslint-config-standard": "^0.2.35",
+    "@types/chai": "^5.0.1",
+    "@types/mocha": "^10.0.10",
     "@types/node": "^22.13.5",
+    "@types/yargs-parser": "^21.0.3",
     "chai": "^5.2.0",
-    "core-js": "^3.40.0",
     "cross-env": "^7.0.3",
     "eslint": "^9.21.0",
     "globals": "^16.0.0",

package/test/utils/common.spec.mjs

@@ -1,6 +1,7 @@
 import {
   expect
 } from 'chai'
+
 import {
   fromBase64ToBuffer,
   fromBufferToBase64

package/tsconfig.json

@@ -1,7 +1,12 @@
 {
   "compilerOptions": {
-    "types": [
-      "node"
-    ]
+    "module": "NodeNext",
+    "target": "ESNext",
+    "allowJs": true,
+    "checkJs": true,
+    "noEmit": true,
+    "strict": true,
+    "isolatedModules": true,
+    "baseUrl": "."
   }
 }

package/utils/common.d.mts

@@ -0,0 +1,3 @@
+export function fromBase64ToBuffer (string: string): Buffer
+
+export function fromBufferToBase64 (buffer: Buffer): string

package/utils/common.mjs

@@ -1,7 +1,15 @@
+/**
+ * @param {string} string
+ * @returns {Buffer}
+ */
 export function fromBase64ToBuffer (string) {
   return Buffer.from(string, 'base64')
 }
 
+/**
+ * @param {Buffer} buffer
+ * @returns {string}
+ */
 export function fromBufferToBase64 (buffer) {
   return buffer.toString('base64')
 }

package/utils/compare.d.mts

@@ -0,0 +1,13 @@
+import type {
+  BinaryLike
+} from 'node:crypto'
+
+type CompareParams = {
+      salt: BinaryLike,
+     hash: Buffer,
+     iterations?: number,
+     keylen?: number,
+     digest?: string
+   }
+
+export default function compare (password: BinaryLike, params: CompareParams): Promise<boolean>

package/utils/compare.mjs

@@ -1,22 +1,40 @@
+/**
+ *  @typedef {import('node:crypto').BinaryLike} BinaryLike
+ *
+ *  @typedef {{
+ *    salt: BinaryLike,
+ *    hash: Buffer,
+ *    iterations?: number,
+ *    keylen?: number,
+ *    digest?: string
+ *  }} CompareParams
+ *
+ *  @typedef {{
+ *    salt: BinaryLike,
+ *    iterations?: number,
+ *    keylen?: number,
+ *    digest?: string
+ * }} HashParams
+ */
+
 import {
   timingSafeEqual
 } from 'node:crypto'
+
 import hash from './hash.mjs'
 
 /**
- * function compare (password, salt, h, complete = () => {}) {
- *   hash(password, salt, (e, v) => {
- *     if (e) return complete(e)
- *
- *     complete(null, timingSafeEqual(h, v))
- *   })
- * }
+ * @param {BinaryLike} password
+ * @param {CompareParams} params
+ * @returns {Promise<boolean>}
  */
-
 export default async function compare (password, {
   hash: alpha,
   ...params
-} = {}) {
+}) {
+  /**
+   *  @type {Buffer<ArrayBufferLike>}
+   */
   const omega = await hash(password, params)
 
   return timingSafeEqual(alpha, omega)

package/utils/hash.d.mts

@@ -0,0 +1,11 @@
+
+import type {BinaryLike} from 'node:crypto'
+
+type HashParams = {
+      salt: BinaryLike,
+      iterations?: number,
+      keylen?: number,
+      digest?: string
+   }
+
+export default function hash (password: BinaryLike, params: HashParams): Promise<Buffer>

package/utils/hash.mjs

@@ -1,6 +1,17 @@
+/**
+ *  @typedef {import('node:crypto').BinaryLike} BinaryLike
+ *  @typedef {{
+ *    salt: BinaryLike,
+ *    iterations?: number,
+ *    keylen?: number,
+ *    digest?: string
+ * }} HashParams
+ */
+
 import {
   pbkdf2
 } from 'node:crypto'
+
 import {
   ITERATIONS,
   KEYLEN,
@@ -8,17 +19,16 @@ import {
 } from '#config/compare'
 
 /**
- * function hash (password, salt, complete = () => {}) {
- *   pbkdf2(password, salt, ITERATIONS, KEYLEN, DIGEST, complete)
- * }
+ * @param {BinaryLike} password
+ * @param {HashParams} params
+ * @returns {Promise<Buffer>}
  */
-
 export default function hash (password, {
   salt,
   iterations = ITERATIONS,
   keylen = KEYLEN,
   digest = DIGEST
-} = {}) {
+}) {
   return (
     new Promise((resolve, reject) => {
       pbkdf2(password, salt, iterations, keylen, digest, (e, buffer) => {

package/utils/salt.d.mts

@@ -0,0 +1 @@
+export default function salt (size: number): Promise<Buffer>

package/utils/salt.mjs

@@ -3,11 +3,9 @@ import {
 } from 'node:crypto'
 
 /**
- * function salt (size, complete = () => {}) {
- *   randomBytes(size, complete)
- * }
+ * @param {number} size
+ * @returns {Promise<Buffer>}
  */
-
 export default function salt (size) {
   return (
     new Promise((resolve, reject) => {

package/babel.config.cjs

@@ -1,32 +0,0 @@
-const {
-  env: {
-    NODE_ENV = 'development'
-  }
-} = process
-
-function env () {
-  return (
-    NODE_ENV === 'production'
-  )
-}
-
-const presets = [
-  [
-    '@babel/env',
-    {
-      targets: {
-        node: 'current'
-      },
-      useBuiltIns: 'usage',
-      corejs: 3
-    }
-  ]
-]
-
-module.exports = (api) => {
-  if (api) api.cache.using(env)
-
-  return {
-    presets
-  }
-}