refactor: Updated Claim Interface (#226)

poetapp · Nov 9, 2018 · de1a4a3 · de1a4a3
1 parent b48ec47
commit de1a4a3
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/src/Interfaces.ts b/src/Interfaces.ts
@@ -9,12 +9,16 @@ export enum ClaimType {
   Work = 'Work',
 }
 
+export interface Claim {
+  readonly [key: string]: string | number | Claim | ReadonlyArray<number | string | Claim>
+}
+
 export interface BaseVerifiableClaim {
   readonly '@context': any
   readonly issuer: string
   readonly issuanceDate: string
   readonly type: ClaimType
-  readonly claim: object
+  readonly claim: Claim
 }
 export interface VerifiableClaim extends BaseVerifiableClaim {
   readonly id: string

diff --git a/src/VerifiableClaim.ts b/src/VerifiableClaim.ts
@@ -9,6 +9,7 @@ import {
   CreateVerifiableClaimConfig,
   DefaultClaimContext,
   VerifiableClaim,
+  Claim,
 } from './Interfaces'
 
 const canonizeClaim = async (document: BaseVerifiableClaim): Promise<string> => {
@@ -40,7 +41,7 @@ export const configureCreateVerifiableClaim = ({
   issuer,
   type = ClaimType.Work,
   context = {},
-}: CreateVerifiableClaimConfig) => async (claim: object): Promise<VerifiableClaim> => {
+}: CreateVerifiableClaimConfig) => async (claim: Claim): Promise<VerifiableClaim> => {
   const verifiableClaim = {
     '@context': { ...DefaultClaimContext, ...claimTypeDefaults[type], ...context },
     type,

diff --git a/tests/unit/shared.ts b/tests/unit/shared.ts
@@ -10,6 +10,7 @@ import {
   Identity,
   SignedVerifiableClaim,
   SigningAlgorithm,
+  Claim,
   Work,
 } from '../../src/Interfaces'
 import { getVerifiableClaimSigner } from '../../src/VerifiableClaimSigner'
@@ -20,7 +21,7 @@ export const claimSigner = getVerifiableClaimSigner()
 export const getErrorMessage = (err: Error): string => err.message
 
 export const makeClaim = (
-  claim: object,
+  claim: Claim,
   type: ClaimType = ClaimType.Work,
   context: ClaimContext = DefaultClaimContext,
 ): BaseVerifiableClaim => {
@@ -106,7 +107,7 @@ export const MyIdentity: Identity = {
   },
 }
 
-export const TheRavenClaim: object = {
+export const TheRavenClaim: Claim = {
   name: 'The Raven',
   author: 'Edgar Allan Poe',
   tags: 'poem',