Updated Claim Interface

[jwicks31]

PR Process - PR Review Checklist

Release

Semantic release is enabled for this repository. Make sure you follow the right commit message convention.

We're using semantic-release's default — Angular Commit Message Conventions.

Description of Changes

• Updated interface for Claims

Resolves #227

[krobi64]

PR Review Checklist

• [na] Tested changes manually
• Checked accidental architectural/style changes
• Reviewed entire diff
• Unit tests
• [na] Documentation
• [na] Filenames and locations

PR Reviewer Comments

There are a number of places where you have to update this for unit tests to pass. You should see this in Travis.

[krobi64]

This might also need to be an array of items.

[krobi64]

Which may mean the key can be a number?

[lautarodragan]

I think to support the array we'd do

[key: string]: string | number | StringToRecursiveObject | ReadonlyArray<string | number | StringToRecursiveObject >

Can the array be of any of those types @krobi64?

[jwicks31]

Are you saying that the claim itself can be an array?

[krobi64]

No, I'm saying one of the attributes inside the claim may be an array.

[jwicks31]

Ok then I think @lautarodragan option should work, assuming that the array can be of numbers, strings, and/or objects?

[lautarodragan]

Not the claim, but attributes inside it could (is that it @krobi64?).

I guess something like this would be a valid claim:

{
    name: 'A Study in Scarlet',
    author: 'Arthur Conan Doyle',
    tags: ['detective', 'novel', 'detective'],
    dateCreated: '1886-01-01T00:00:00.000Z',
    datePublished: '1887-01-01T00:00:00.000Z',
    stuff: [ { something: true, somethingElse: 42 } ],
    nestedStuff: [ { reallyComplex: { someNestedProp: 42 } } ],
  },

[lautarodragan]

A simpler alternative would be

export interface StringToRecursiveObject {
  readonly [key: string]: number | string | unknown // maybe add array here too
}

That would allow programmatic access to first-level children of claim as strings or numbers, but no other level, nor mutation.

[lautarodragan]

LGTM

Changes were made to fix unit tests + handle Array