swrlab/node-utils

🗂 This module contains several frequently used packages and scripts for easier access and maintenance

SWR Audio Lab

Principles

Learn about our Engineering and Project Principles in PRINCIPLES.md.

OpenAPI Documentation

You can find the OpenAPI documentation in /openapi.

More from the Audio Lab

• Our NodeJS tools: @swrlab/node-utils / on npm @swrlab/utils
• Public repositories on GitHub: swrlab/repositories
• Public packages on npm: npmjs.com/org/swrlab

More Documents

They can all be found in /docs.

• ACCOUNT LINKING - Handling account linking for ARD login
• AUTHENTICATION - Handling the Radiohub token auth
• STREAMING - How to handle radio stream requests and interaction

Public Key

You can find our public key for lab [at] swr.de on keys.openpgp.org.

node-utils's Issues

Please provide TypeScript definition

It would be nice to have TypeScript definitions for the functions provided in packages.

Publish Package on NPM

Currently this package is published as node-storage-wrapper which should get a deprecation note.
The new version - which is currently only available as link-dependency with beta-flag - should be published on NPM as @swrlab/utils or @swrlab/node-utils.

Update or replace Node-CRC

Some thoughts about updating node-crc to v2 like in swrlab/ard-eventhub#284

• the update would require every project using this dependency to install rustup toolchain which is fine for local development but questionable regarding deployments and docker-files...

The idea came up to replace the library as its only usage is node-utils/utils/ard/createHashedId.js
A not too oudated library is https://github.com/akiver/crc64-ecma, but its not generating the same result:

Result with node-crc: INPUT:SWR --> OUTPUT (CRC64-ECMA182): baa7e9a52223a090

const crc = require('node-crc')
module.exports = (input) => { return crc.crc64(Buffer.from(input, 'utf-8')).toString('hex') }

Result with crc64-ecma: INPUT:SWR --> OUTPUT (CRC64-ECMA182): 7fdca8944f20b7a0

const { crc64 } = require('crc64-ecma')
module.exports = (input) => { return crc64(input).toString(16) }

License not a valid SPDX expression

yarn shows
warning package.json: License should be a valid SPDX license expression

Maybe change from Hippocratic-2.0 to Hippocratic-2.1? -> https://spdx.org/licenses/
Nevertheless it doesn't remove the warning...

As it's also not listed in EUPL-Matrix: swrlab/ard-eventhub#258 (comment) maybe chose a different license???

Add crypto package wrapper

From #466 (comment)

frytg commented on Nov 16, 2022
also include internal crypto package wrapper for hmac, signing, jws

Improvements for v1.1.2

Ticket to collect new helpers for v1.1.2

Add reduceArrayToObjectCount

From: #466 (comment)

Using Reduce to Count the Array in Javascript

function reduceArrayToObjectCount(array) {
	return array.reduce((obj, name) => {
		// eslint-disable-next-line no-plusplus
		obj[name] = obj[name] ? ++obj[name] : 1
		return obj
	}, {})
}

Add 'safe-to-test' flag

Like already used in ard-eventhub, useful on public repos to avoid abuse of PRs.

Improvements for next release

Some ideas for improvements in next release:

• migrate radioCategories from app-analytics-board
• migrate regionCodes from app-analytics-board

Update install command in Readme

Instead of yarn install @swrlab/utils it should be yarn add @swrlab/utils right?

Check publishing to npm via Github Actions

https://github.blog/2023-04-19-introducing-npm-package-provenance/

Refactor Storage-wrapper

To conform our current package structure following suggestions:

• move function files from packages/storage-wrapper to utils/storage
• rename packages/storage-wrapper to storage
• adapt export scheme from packages/index.js to other packages
  • instead of exporting class with this.function, export object with functions

License link in README is broken

https://github.com/swrlab/node-utils#license links to .md instead of .txt