@sequencemedia/pbkdf2 1.1.0 → 1.1.2

package/config/compare.mjs

@@ -1,4 +1,4 @@
-import argsMap from '#utils/args-map'
+import argsMap from './args-map.mjs'
 
 /**
  *  @type {number}

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sequencemedia/pbkdf2",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "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": {
-    "@sequencemedia/eslint-config-standard": "^0.2.35",
+    "@sequencemedia/eslint-config-standard": "^0.2.36",
+    "@sequencemedia/eslint-config-typescript": "^0.1.51",
     "@types/chai": "^5.0.1",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.13.5",
+    "@types/node": "^22.13.8",
     "@types/yargs-parser": "^21.0.3",
     "chai": "^5.2.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/{utils → src}/compare.d.mts

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

package/{utils → src}/compare.mjs

@@ -1,6 +1,5 @@
 /**
  *  @typedef {import('node:crypto').BinaryLike} BinaryLike
- *
  *  @typedef {{
  *    salt: BinaryLike,
  *    hash: Buffer,
@@ -8,13 +7,12 @@
  *    keylen?: number,
  *    digest?: string
  *  }} CompareParams
- *
  *  @typedef {{
  *    salt: BinaryLike,
  *    iterations?: number,
  *    keylen?: number,
  *    digest?: string
- * }} HashParams
+ *  }} HashParams
  */
 
 import {

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

@@ -5,7 +5,7 @@
  *    iterations?: number,
  *    keylen?: number,
  *    digest?: string
- * }} HashParams
+ *  }} HashParams
  */
 
 import {

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

@@ -5,9 +5,9 @@ import {
 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/index.d.mts

@@ -1,22 +0,0 @@
-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/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/hash.d.mts

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