@sequencemedia/pbkdf2 1.0.406 → 1.1.1

package/config/compare.mjs

@@ -1,17 +1,26 @@
-import argsMap from '#utils/args-map'
+import argsMap from './args-map.mjs'
 
+/**
+ *  @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/eslint.config.mjs

@@ -1,10 +1,33 @@
-import merge from '@sequencemedia/eslint-config-standard/merge'
 import globals from 'globals'
+import jsdoc from 'eslint-plugin-jsdoc'
+import standard from '@sequencemedia/eslint-config-standard/merge'
+import typescript from '@sequencemedia/eslint-config-typescript/merge'
 
-export default (
-  merge({
+export default [
+  jsdoc.configs['flat/recommended'],
+  {
+    languageOptions: {
+      globals: {
+        ArrayBufferLike: 'readonly'
+      }
+    }
+  },
+  ...standard({
+    files: [
+      '**/*.{mjs,cjs,mts,cts}'
+    ],
+    ignores: [
+      'test'
+    ],
+    languageOptions: {
+      globals: {
+        ...globals.node
+      }
+    }
+  }),
+  ...typescript({
     files: [
-      '**/*.{cjs,mjs}'
+      '**/*.{mts,cts}'
     ],
     ignores: [
       'test'
@@ -14,17 +37,25 @@ export default (
         ...globals.node
       }
     }
+  }),
+  ...standard({
+    files: [
+      'test/**/*.{mjs,cjs,mts,cts}'
+    ],
+    languageOptions: {
+      globals: {
+        ...globals.mocha
+      }
+    }
+  }),
+  ...typescript({
+    files: [
+      'test/**/*.{mts,cts}'
+    ],
+    languageOptions: {
+      globals: {
+        ...globals.mocha
+      }
+    }
   })
-    .concat(
-      merge({
-        files: [
-          'test/**/*.{cjs,mjs}'
-        ],
-        languageOptions: {
-          globals: {
-            ...globals.mocha
-          }
-        }
-      })
-    )
-)
+]

package/jsconfig.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sequencemedia/pbkdf2",
-  "version": "1.0.406",
+  "version": "1.1.1",
   "keywords": [
     "pbkdf2",
     "crypto",
@@ -10,9 +10,9 @@
     "ecmascript",
     "typescript"
   ],
-  "main": "./index.mjs",
+  "main": "./src/index.mjs",
   "type": "module",
-  "types": "./index.d.mts",
+  "types": "./src/index.d.mts",
   "author": {
     "name": "Jonathan Perry for Sequence Media Limited",
     "email": "sequencemedia@sequencemedia.net",
@@ -37,20 +37,24 @@
     "yargs-parser": "^21.1.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.26.9",
-    "@babel/preset-env": "^7.26.9",
     "@sequencemedia/eslint-config-standard": "^0.2.35",
+    "@sequencemedia/eslint-config-typescript": "^0.1.50",
+    "@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",
+    "eslint-plugin-jsdoc": "^50.6.3",
     "globals": "^16.0.0",
     "husky": "^9.1.7",
     "mocha": "^11.1.0"
   },
   "imports": {
     "#config/*": "./config/*.mjs",
-    "#utils/*": "./utils/*.mjs"
+    "#pbkdf2/*": "./src/*.mjs",
+    "#pbkdf2": "./src/index.mjs",
+    "#pbkdf2/common": "./src/common/index.mjs"
   }
 }

package/scripts/compare.mjs

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import argsMap from '#utils/args-map'
+import argsMap from '#config/args-map'
 import compare from '#utils/compare'
 import {
   fromBase64ToBuffer

package/scripts/hash.mjs

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import argsMap from '#utils/args-map'
+import argsMap from '#config/args-map'
 import {
   fromBase64ToBuffer,
   fromBufferToBase64

package/scripts/salt.mjs

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import argsMap from '#utils/args-map'
+import argsMap from '#config/args-map'
 import {
   fromBufferToBase64
 } from '#utils/common'

package/src/common/index.d.mts

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

package/{utils/common.mjs → src/common/index.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/src/compare.d.mts

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

package/src/compare.mjs

@@ -0,0 +1,39 @@
+/**
+ *  @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'
+
+/**
+ * @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/src/hash.d.mts

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

package/{utils → src}/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/src/index.d.mts

@@ -0,0 +1,22 @@
+import type {
+  BinaryLike
+} from 'node:crypto'
+
+export interface CompareParams {
+  salt: BinaryLike
+  hash: Buffer
+  iterations?: number
+  keylen?: number
+  digest?: string
+}
+
+export interface 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/src/index.mjs

@@ -0,0 +1,3 @@
+export { default as compare } from './compare.mjs'
+export { default as hash } from './hash.mjs'
+export { default as salt } from './salt.mjs'

package/src/salt.d.mts

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

package/{utils → src}/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/test/{utils → src}/common.spec.mjs

@@ -1,12 +1,13 @@
 import {
   expect
 } from 'chai'
+
 import {
   fromBase64ToBuffer,
   fromBufferToBase64
-} from '#utils/common'
+} from '#pbkdf2/common'
 
-describe('`#utils/common`', () => {
+describe('`#pbkdf2/common`', () => {
   describe('fromBase64ToBuffer', () => it('is a function', () => expect(fromBase64ToBuffer).to.be.a('function')))
 
   describe('fromBufferToBase64', () => it('is a function', () => expect(fromBufferToBase64).to.be.a('function')))

package/test/{utils → src}/compare.spec.mjs

@@ -1,9 +1,9 @@
 import {
   expect
 } from 'chai'
-import compare from '#utils/compare'
+import compare from '#pbkdf2/compare'
 
-describe('`#utils/compare`', () => {
+describe('`#pbkdf2/compare`', () => {
   describe('compare', () => it('is a function', () => expect(compare).to.be.a('function')))
 
   describe('compare()', () => {

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/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
-  }
-}

package/index.d.mts

@@ -1,5 +0,0 @@
-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>
-}

package/index.mjs

@@ -1,9 +0,0 @@
-import compare from '#utils/compare'
-import hash from '#utils/hash'
-import salt from '#utils/salt'
-
-export {
-  compare,
-  hash,
-  salt
-}

package/utils/compare.mjs

@@ -1,23 +0,0 @@
-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))
- *   })
- * }
- */
-
-export default async function compare (password, {
-  hash: alpha,
-  ...params
-} = {}) {
-  const omega = await hash(password, params)
-
-  return timingSafeEqual(alpha, omega)
-}