@sequencemedia/crypto 1.2.36 → 1.2.38

package/crypto.d.mts

@@ -1,5 +1,5 @@
 declare module '@sequencemedia/crypto' {
-  export function hashKey(secret: string): string
-  export function encrypt(buffer: Buffer, secret: string, bytes?: number, algorithm?: string): Buffer
-  export function decrypt(buffer: Buffer, secret: string, bytes?: number, algorithm?: string): Buffer
+  export function hashKey (secret: string): string
+  export function encrypt (buffer: Buffer, secret: string, bytes?: number, algorithm?: string): Buffer
+  export function decrypt (buffer: Buffer, secret: string, bytes?: number, algorithm?: string): Buffer
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sequencemedia/crypto",
-  "version": "1.2.36",
+  "version": "1.2.38",
   "keywords": [
     "crypto",
     "node",
@@ -25,8 +25,13 @@
     "url": "git@github.com:sequencemedia/crypto.git"
   },
   "scripts": {
-    "lint": "eslint . --ext .mjs,.cjs",
-    "lint:fix": "npm run lint -- --fix",
+    "lint": "npm run lint:js && npm run lint:ts",
+    "lint:js": "eslint . --ext .mjs,.cjs",
+    "lint:ts": "eslint . --ext .mts,.cts",
+    "lint:fix": "npm run lint:js:fix && npm run lint:ts:fix",
+    "lint:js:fix": "npm run lint:js -- --fix",
+    "lint:ts:fix": "npm run lint:ts -- --fix",
+    "types": "tsc src/**/*.mjs --declaration --allowJs --emitDeclarationOnly",
     "prepare": "husky install"
   },
   "devDependencies": {
@@ -36,10 +41,14 @@
     "@babel/preset-env": "^7.22.10",
     "@sequencemedia/hooks": "^1.0.446",
     "@types/node": "^20.4.10",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
     "core-js": "^3.32.0",
     "eslint": "^8.47.0",
     "eslint-config-standard": "^17.1.0",
-    "husky": "^8.0.3"
+    "eslint-config-standard-with-typescript": "^37.0.0",
+    "husky": "^8.0.3",
+    "typescript": "^5.1.6"
   },
   "exports": {
     ".": "./src/index.mjs"

package/src/index.d.mts

@@ -0,0 +1,21 @@
+/**
+ * @param {string} secret
+ * @returns {string}
+ */
+export function hashKey (secret: string): string
+/**
+ * @param {Buffer} buffer
+ * @param {string} secret
+ * @param {number} [bytes]
+ * @param {string} [algorithm]
+ * @returns {Buffer}
+ */
+export function encrypt (buffer: Buffer, secret: string, bytes?: number, algorithm?: string): Buffer
+/**
+ * @param {Buffer} buffer
+ * @param {string} secret
+ * @param {number} [bytes]
+ * @param {string} [algorithm]
+ * @returns {Buffer}
+ */
+export function decrypt (buffer: Buffer, secret: string, bytes?: number, algorithm?: string): Buffer

package/src/index.mjs

@@ -1,17 +1,35 @@
 import crypto from 'crypto'
 
+/**
+ * @param {string} secret
+ * @returns {string}
+ */
 export function hashKey (secret) {
   if (!secret) throw new Error('A secret is required')
 
   return crypto.createHash('sha256').update(secret).digest('base64').substring(0, 32)
 }
 
+/**
+ * @param {Buffer} buffer
+ * @param {string} secret
+ * @param {number} [bytes]
+ * @param {string} [algorithm]
+ * @returns {Buffer}
+ */
 export function encrypt (buffer, secret, bytes = 16, algorithm = 'aes-256-ctr') {
   const iv = crypto.randomBytes(bytes)
   const cipher = crypto.createCipheriv(algorithm, hashKey(secret), iv)
   return Buffer.concat([iv, cipher.update(buffer), cipher.final()])
 }
 
+/**
+ * @param {Buffer} buffer
+ * @param {string} secret
+ * @param {number} [bytes]
+ * @param {string} [algorithm]
+ * @returns {Buffer}
+ */
 export function decrypt (buffer, secret, bytes = 16, algorithm = 'aes-256-ctr') {
   const iv = buffer.slice(0, bytes)
   const decipher = crypto.createDecipheriv(algorithm, hashKey(secret), iv)

package/src/shell/decrypt.d.mts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {}

package/src/shell/encrypt.d.mts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {}

package/tsconfig.json

@@ -1,5 +1,10 @@
 {
   "compilerOptions": {
-    "module": "nodenext"
+    "module": "nodenext",
+    "allowJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "declarationMap": true,
+    "strictNullChecks": true
   }
 }