@gemeentenijmegen/utils

Nijmegen Utils

A library of utilities used by the municipality of Nijmegen.

Available utilities:

• BSN validator
• AWS utilities

BSN

A convenience class wrapping a BSN-number. It validates them on creation, ensuring that further use of the BSN is safe. Useage:

const { Bsn } = require('@gemeentenijmegen/utils');

try {
    const myBsn = new Bsn('999996708');
    doSomethingWith(myBsn.bsn);
} catch (err) {
    console.error('The BSN wasn't valid');
}

AWS

A utility with two methods getParameter(name: string) and getSecret(arn: string) for fetching parameters and secret strings from the parameter store or secret manager. Both functions return a promise.

const { AWS } = require('@gemeentenijmegen/utils');
const param = await AWS.getParameter('/cdk/path/to/ssm/param/');
const secret = await AWS.getSecret('/cdk/path/to/secrets/manager/secret');

Storage

A way to interact with storage. For now only an 'S3' implementation S3Storage is available, for working with S3, and S3 compatible API's. It adds methods for storing, copying (between buckets, regions) retrieving and generating presigned URL's.

import 'S3Storage' from '@gemeentenijmegen/utils';
const storage = new S3Storage('bucketname');
storage.store('somekey', 'somevalue');
storage.get('somekey');`
storage.copy('sourcebucket', 'sourcekey', 'destinationbucket', 'destinationkey');