Merge pull request #53 from auth0-lab/allow-control-over-default-cbor-encode-decode-options

feat: allow optional customization of cbor encode/decode options (author: @warren-gallagher)

Author: jfromaniello

__tests__/cbor.tests.ts

@@ -1,6 +1,6 @@
 import { hex } from 'buffer-tag';
 
-import { cborDecode, cborEncode, DataItem } from '../src/cbor';
+import { cborDecode, cborEncode, DataItem, getCborEncodeDecodeOptions, setCborEncodeDecodeOptions } from '../src/cbor';
 
 describe('cbor', () => {
   it('should properly decode a nested map', () => {
@@ -16,6 +16,18 @@ describe('cbor', () => {
     const decoded = cborDecode(encoded);
     const reEncode = cborEncode(decoded);
     expect(reEncode.toString('hex')).toBe(encoded.toString('hex'));
+    expect(encoded[3].toString(16)).toBe('b9'); // Large Map
+  });
+
+  it('should properly encoded and decoded maps using variableMapSize=true', () => {
+    const options = getCborEncodeDecodeOptions();
+    options.variableMapSize = true;
+    setCborEncodeDecodeOptions(options);
+    const encoded = cborEncode(DataItem.fromData({ foo: 'baz' }));
+    const decoded = cborDecode(encoded);
+    const reEncode = cborEncode(decoded);
+    expect(reEncode.toString('hex')).toBe(encoded.toString('hex'));
+    expect(encoded[3].toString(16)).toBe('a1'); // Map with one item
   });
 
   it('should properly encoded and decoded with arrays', () => {

src/cbor/index.ts

@@ -33,7 +33,7 @@ export class DateOnly extends Date {
   }
 }
 
-const encoderDefaults: Options = {
+let encoderDefaults: Options = {
   tagUint8Array: false,
   useRecords: false,
   mapsAsObjects: false,
@@ -59,6 +59,14 @@ addExtension({
   decode: (isoStringDate: any): Object => new DateOnly(isoStringDate),
 });
 
+export const getCborEncodeDecodeOptions = () : Options => {
+  return encoderDefaults;
+};
+
+export const setCborEncodeDecodeOptions = (options: Options) : void => {
+  encoderDefaults = options;
+};
+
 export const cborDecode = (
   input: Buffer | Uint8Array,
   options: Options = encoderDefaults,

src/index.ts

@@ -9,3 +9,4 @@ export { DeviceSignedDocument } from './mdoc/model/DeviceSignedDocument';
 export { DeviceResponse } from './mdoc/model/DeviceResponse';
 export { MDLError, MDLParseError } from './mdoc/errors';
 export { VerificationAssessmentId } from './mdoc/checkCallback';
+export { getCborEncodeDecodeOptions, setCborEncodeDecodeOptions } from './cbor';