@naturalcycles/nodejs-lib 12.77.1 → 12.78.0

package/dist/security/crypto.util.d.ts

@@ -1,24 +1,24 @@
 /// <reference types="node" />
-import { StringMap } from '@naturalcycles/js-lib';
+import { Base64String, StringMap } from '@naturalcycles/js-lib';
 /**
  * Using aes-256-cbc
  */
-export declare function encryptRandomIVBuffer(input: Buffer, secretKeyBase64: string): Buffer;
+export declare function encryptRandomIVBuffer(input: Buffer, secretKeyBase64: Base64String): Buffer;
 /**
  * Using aes-256-cbc
  */
-export declare function decryptRandomIVBuffer(input: Buffer, secretKeyBase64: string): Buffer;
+export declare function decryptRandomIVBuffer(input: Buffer, secretKeyBase64: Base64String): Buffer;
 /**
  * Decrypts all object values.
  * Returns object with decrypted values.
  */
-export declare function decryptObject(obj: StringMap, secretKey: string): StringMap;
-export declare function encryptObject(obj: StringMap, secretKey: string): StringMap;
+export declare function decryptObject(obj: StringMap<Base64String>, secretKey: string): StringMap;
+export declare function encryptObject(obj: StringMap, secretKey: string): StringMap<Base64String>;
 /**
  * Using aes-256-cbc
  */
-export declare function decryptString(str: string, secretKey: string): string;
+export declare function decryptString(str: Base64String, secretKey: string): string;
 /**
  * Using aes-256-cbc
  */
-export declare function encryptString(str: string, secretKey: string): string;
+export declare function encryptString(str: string, secretKey: string): Base64String;

package/dist/security/hash.util.d.ts

@@ -1,20 +1,15 @@
 /// <reference types="node" />
+import { Base64String } from '@naturalcycles/js-lib';
 export declare function md5(s: string | Buffer): string;
-export declare function md5AsBase64(s: string | Buffer): string;
+export declare function md5AsBase64(s: string | Buffer): Base64String;
 export declare function md5AsBuffer(s: string | Buffer): Buffer;
 export declare function sha256(s: string | Buffer): string;
-export declare function sha256AsBase64(s: string | Buffer): string;
+export declare function sha256AsBase64(s: string | Buffer): Base64String;
 export declare function sha256AsBuffer(s: string | Buffer): Buffer;
 export declare function hash(s: string | Buffer, algorithm: string): string;
 export declare function hashAsBuffer(s: string | Buffer, algorithm: string): Buffer;
-export declare function base64(s: string | Buffer): string;
-export declare function base64ToString(strBase64: string): string;
+export declare function base64(s: string | Buffer): Base64String;
+export declare function base64ToString(strBase64: Base64String): string;
 export declare function base64ToBuffer(strBase64: string): Buffer;
-/**
- * @deprecated use `base64`
- */
-export declare function stringToBase64(s: string): string;
-/**
- * @deprecated use `base64`
- */
-export declare function bufferToBase64(b: Buffer): string;
+export declare function stringToBase64(s: string): Base64String;
+export declare function bufferToBase64(b: Buffer): Base64String;

package/dist/security/hash.util.js

@@ -35,7 +35,7 @@ function hashAsBuffer(s, algorithm) {
 }
 exports.hashAsBuffer = hashAsBuffer;
 function base64(s) {
-    return (Buffer.isBuffer(s) ? s : Buffer.from(s, 'utf8')).toString('base64');
+    return (typeof s === 'string' ? Buffer.from(s) : s).toString('base64');
 }
 exports.base64 = base64;
 function base64ToString(strBase64) {
@@ -46,16 +46,10 @@ function base64ToBuffer(strBase64) {
     return Buffer.from(strBase64, 'base64');
 }
 exports.base64ToBuffer = base64ToBuffer;
-/**
- * @deprecated use `base64`
- */
 function stringToBase64(s) {
     return Buffer.from(s, 'utf8').toString('base64');
 }
 exports.stringToBase64 = stringToBase64;
-/**
- * @deprecated use `base64`
- */
 function bufferToBase64(b) {
     return b.toString('base64');
 }

package/dist/security/secret.util.d.ts

@@ -1,4 +1,4 @@
-import { StringMap } from '@naturalcycles/js-lib';
+import { Base64String, StringMap } from '@naturalcycles/js-lib';
 /**
  * Loads plaintext secrets from process.env, removes them, stores locally.
  * Make sure to call this function early on server startup, so secrets are removed from process.env
@@ -18,12 +18,12 @@ export declare function removeSecretsFromEnv(): void;
  * Whole file is encrypted.
  * For "json-values encrypted" style - use `loadSecretsFromEncryptedJsonFileValues`
  */
-export declare function loadSecretsFromEncryptedJsonFile(filePath: string, secretEncryptionKey?: string): void;
+export declare function loadSecretsFromEncryptedJsonFile(filePath: string, secretEncryptionKey?: Base64String): void;
 /**
  * Whole file is NOT encrypted, but instead individual json values ARE encrypted..
  * For whole-file encryption - use `loadSecretsFromEncryptedJsonFile`
  */
-export declare function loadSecretsFromEncryptedJsonFileValues(filePath: string, secretEncryptionKey?: string): void;
+export declare function loadSecretsFromEncryptedJsonFileValues(filePath: string, secretEncryptionKey?: Base64String): void;
 /**
  * json secrets are always base64'd
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "12.77.1",
+  "version": "12.78.0",
   "scripts": {
     "prepare": "husky install",
     "docs-serve": "vuepress dev docs",

package/src/security/crypto.util.ts

@@ -1,5 +1,5 @@
 import * as crypto from 'node:crypto'
-import { _stringMapEntries, StringMap } from '@naturalcycles/js-lib'
+import { _stringMapEntries, Base64String, StringMap } from '@naturalcycles/js-lib'
 import { md5 } from './hash.util'
 
 const algorithm = 'aes-256-cbc'
@@ -7,7 +7,7 @@ const algorithm = 'aes-256-cbc'
 /**
  * Using aes-256-cbc
  */
-export function encryptRandomIVBuffer(input: Buffer, secretKeyBase64: string): Buffer {
+export function encryptRandomIVBuffer(input: Buffer, secretKeyBase64: Base64String): Buffer {
   // md5 to match aes-256 key length of 32 bytes
   const key = md5(Buffer.from(secretKeyBase64, 'base64'))
 
@@ -21,7 +21,7 @@ export function encryptRandomIVBuffer(input: Buffer, secretKeyBase64: string): B
 /**
  * Using aes-256-cbc
  */
-export function decryptRandomIVBuffer(input: Buffer, secretKeyBase64: string): Buffer {
+export function decryptRandomIVBuffer(input: Buffer, secretKeyBase64: Base64String): Buffer {
   // md5 to match aes-256 key length of 32 bytes
   const key = md5(Buffer.from(secretKeyBase64, 'base64'))
 
@@ -38,7 +38,7 @@ export function decryptRandomIVBuffer(input: Buffer, secretKeyBase64: string): B
  * Decrypts all object values.
  * Returns object with decrypted values.
  */
-export function decryptObject(obj: StringMap, secretKey: string): StringMap {
+export function decryptObject(obj: StringMap<Base64String>, secretKey: string): StringMap {
   const { key, iv } = getCryptoParams(secretKey)
 
   const r: StringMap = {}
@@ -49,7 +49,7 @@ export function decryptObject(obj: StringMap, secretKey: string): StringMap {
   return r
 }
 
-export function encryptObject(obj: StringMap, secretKey: string): StringMap {
+export function encryptObject(obj: StringMap, secretKey: string): StringMap<Base64String> {
   const { key, iv } = getCryptoParams(secretKey)
 
   const r: StringMap = {}
@@ -63,7 +63,7 @@ export function encryptObject(obj: StringMap, secretKey: string): StringMap {
 /**
  * Using aes-256-cbc
  */
-export function decryptString(str: string, secretKey: string): string {
+export function decryptString(str: Base64String, secretKey: string): string {
   const { key, iv } = getCryptoParams(secretKey)
   const decipher = crypto.createDecipheriv(algorithm, key, iv)
   return decipher.update(str, 'base64', 'utf8') + decipher.final('utf8')
@@ -72,7 +72,7 @@ export function decryptString(str: string, secretKey: string): string {
 /**
  * Using aes-256-cbc
  */
-export function encryptString(str: string, secretKey: string): string {
+export function encryptString(str: string, secretKey: string): Base64String {
   const { key, iv } = getCryptoParams(secretKey)
   const cipher = crypto.createCipheriv(algorithm, key, iv)
   return cipher.update(str, 'utf8', 'base64') + cipher.final('base64')

package/src/security/hash.util.ts

@@ -1,10 +1,11 @@
 import * as crypto from 'node:crypto'
+import { Base64String } from '@naturalcycles/js-lib'
 
 export function md5(s: string | Buffer): string {
   return hash(s, 'md5')
 }
 
-export function md5AsBase64(s: string | Buffer): string {
+export function md5AsBase64(s: string | Buffer): Base64String {
   return hashAsBuffer(s, 'md5').toString('base64')
 }
 
@@ -16,7 +17,7 @@ export function sha256(s: string | Buffer): string {
   return hash(s, 'sha256')
 }
 
-export function sha256AsBase64(s: string | Buffer): string {
+export function sha256AsBase64(s: string | Buffer): Base64String {
   return hashAsBuffer(s, 'sha256').toString('base64')
 }
 
@@ -32,11 +33,11 @@ export function hashAsBuffer(s: string | Buffer, algorithm: string): Buffer {
   return crypto.createHash(algorithm).update(s).digest()
 }
 
-export function base64(s: string | Buffer): string {
-  return (Buffer.isBuffer(s) ? s : Buffer.from(s, 'utf8')).toString('base64')
+export function base64(s: string | Buffer): Base64String {
+  return (typeof s === 'string' ? Buffer.from(s) : s).toString('base64')
 }
 
-export function base64ToString(strBase64: string): string {
+export function base64ToString(strBase64: Base64String): string {
   return Buffer.from(strBase64, 'base64').toString('utf8')
 }
 
@@ -44,16 +45,10 @@ export function base64ToBuffer(strBase64: string): Buffer {
   return Buffer.from(strBase64, 'base64')
 }
 
-/**
- * @deprecated use `base64`
- */
-export function stringToBase64(s: string): string {
+export function stringToBase64(s: string): Base64String {
   return Buffer.from(s, 'utf8').toString('base64')
 }
 
-/**
- * @deprecated use `base64`
- */
-export function bufferToBase64(b: Buffer): string {
+export function bufferToBase64(b: Buffer): Base64String {
   return b.toString('base64')
 }

package/src/security/secret.util.ts

@@ -1,5 +1,5 @@
 import * as fs from 'node:fs'
-import { _assert, StringMap } from '@naturalcycles/js-lib'
+import { _assert, Base64String, StringMap } from '@naturalcycles/js-lib'
 import { base64ToString } from '..'
 import { decryptObject, decryptRandomIVBuffer } from './crypto.util'
 
@@ -53,7 +53,7 @@ export function removeSecretsFromEnv(): void {
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export function loadSecretsFromEncryptedJsonFile(
   filePath: string,
-  secretEncryptionKey?: string,
+  secretEncryptionKey?: Base64String,
 ): void {
   _assert(
     fs.existsSync(filePath),
@@ -86,7 +86,7 @@ export function loadSecretsFromEncryptedJsonFile(
  */
 export function loadSecretsFromEncryptedJsonFileValues(
   filePath: string,
-  secretEncryptionKey?: string,
+  secretEncryptionKey?: Base64String,
 ): void {
   _assert(
     fs.existsSync(filePath),