fix(types): widen types used as input

W3C spec allows single elements instead of arrays for some properties of credentials.

Author: mirceanis

src/__tests__/converters.test.ts

@@ -550,7 +550,7 @@ describe('presentation', () => {
         const result = normalizePresentation({
           verifiableCredential: { foo: 'bar' },
           vp: { verifiableCredential: [{ foo: 'baz' }] }
-        } as any)
+        })
         expect(result).toMatchObject({
           verifiableCredential: [{ foo: 'bar' }, { foo: 'baz' }]
         })
@@ -646,7 +646,7 @@ describe('presentation', () => {
       })
 
       it('merges type arrays for non-array types', () => {
-        const result = normalizePresentation({ type: 'foo', vp: { type: 'bar' } } as any)
+        const result = normalizePresentation({ type: 'foo', vp: { type: 'bar' } })
         expect(result).toMatchObject({ type: ['foo', 'bar'] })
         expect(result).not.toHaveProperty('vp')
       })
@@ -666,7 +666,7 @@ describe('presentation', () => {
       })
 
       it('merges @context arrays for non-array contexts', () => {
-        const result = normalizePresentation({ '@context': 'foo', context: 'bar', vp: { '@context': 'baz' } } as any)
+        const result = normalizePresentation({ '@context': 'foo', context: 'bar', vp: { '@context': 'baz' } })
         expect(result).toMatchObject({ '@context': ['bar', 'foo', 'baz'] })
         expect(result).not.toHaveProperty('vp')
         expect(result).not.toHaveProperty('context')
@@ -773,7 +773,7 @@ describe('presentation', () => {
         const result = transformPresentationInput({
           verifiableCredential: [{ id: 'foo' }],
           vp: { verifiableCredential: [{ foo: 'bar' }, 'header.payload.signature'] }
-        } as any)
+        })
         expect(result).toMatchObject({
           vp: { verifiableCredential: [{ id: 'foo' }, { foo: 'bar' }, 'header.payload.signature'] }
         })
@@ -784,7 +784,7 @@ describe('presentation', () => {
         const result = transformPresentationInput({
           verifiableCredential: { id: 'foo' },
           vp: { verifiableCredential: { foo: 'bar' } }
-        } as any)
+        })
         expect(result).toMatchObject({ vp: { verifiableCredential: [{ id: 'foo' }, { foo: 'bar' }] } })
         expect(result).not.toHaveProperty('verifiableCredential')
       })
@@ -793,7 +793,7 @@ describe('presentation', () => {
         const result = transformPresentationInput({
           verifiableCredential: { id: 'foo', proof: { jwt: 'header.payload1.signature' } },
           vp: { verifiableCredential: [{ foo: 'bar' }, 'header.payload2.signature'] }
-        } as any)
+        })
         expect(result).toMatchObject({
           vp: { verifiableCredential: ['header.payload1.signature', { foo: 'bar' }, 'header.payload2.signature'] }
         })
@@ -804,7 +804,7 @@ describe('presentation', () => {
         const result = transformPresentationInput({
           verifiableCredential: undefined,
           vp: { verifiableCredential: [null, { foo: 'bar' }, 'header.payload2.signature'] }
-        } as any)
+        })
         expect(result).toMatchObject({ vp: { verifiableCredential: [{ foo: 'bar' }, 'header.payload2.signature'] } })
         expect(result).not.toHaveProperty('verifiableCredential')
       })
@@ -823,7 +823,7 @@ describe('presentation', () => {
           context: 'AA',
           '@context': 'BB',
           vp: { '@context': ['CC'] }
-        } as any)
+        })
         expect(result).toMatchObject({ vp: { '@context': ['AA', 'BB', 'CC'] } })
         expect(result).not.toHaveProperty('context')
         expect(result).not.toHaveProperty('@context')
@@ -854,7 +854,7 @@ describe('presentation', () => {
       })
 
       it('merges type fields when not array types', () => {
-        const result = transformPresentationInput({ type: 'AA', vp: { type: ['BB'] } } as any)
+        const result = transformPresentationInput({ type: 'AA', vp: { type: ['BB'] } })
         expect(result).toMatchObject({ vp: { type: ['AA', 'BB'] } })
         expect(result).not.toHaveProperty('type')
       })

src/converters.ts

@@ -318,7 +318,7 @@ function normalizeJwtPresentation(input: JWT): Verifiable<W3CPresentation> {
  * @param input either a JWT or JWT payload, or a VerifiablePresentation
  */
 export function normalizePresentation(
-  input: Partial<PresentationPayload> | Partial<JwtPresentationPayload> | JWT
+  input: Partial<PresentationPayload> | DeepPartial<JwtPresentationPayload> | JWT
 ): Verifiable<W3CPresentation> {
   if (typeof input === 'string') {
     if (JWT_FORMAT.test(input)) {
@@ -349,7 +349,7 @@ export function normalizePresentation(
  * @param input either a JWT payload or a CredentialPayloadInput
  */
 export function transformPresentationInput(
-  input: Partial<PresentationPayload> | Partial<JwtPresentationPayload>
+  input: Partial<PresentationPayload> | DeepPartial<JwtPresentationPayload>
 ): JwtPresentationPayload {
   const result: Partial<JwtPresentationPayload> = { vp: { ...input.vp }, ...input }
 

src/index.ts

@@ -27,6 +27,8 @@ import {
 
 export {
   Issuer,
+  CredentialPayload,
+  PresentationPayload,
   JwtCredentialPayload,
   JwtPresentationPayload,
   VerifiableCredential,
@@ -112,9 +114,8 @@ export function validateCredentialPayload(payload: CredentialPayload): void {
   validators.validateContext(payload['@context'])
   validators.validateVcType(payload.type)
   validators.validateCredentialSubject(payload.credentialSubject)
-  if (payload.issuanceDate) validators.validateTimestamp(Math.floor(new Date(payload.issuanceDate).valueOf() / 1000))
-  if (payload.expirationDate)
-    validators.validateTimestamp(Math.floor(new Date(payload.expirationDate).valueOf() / 1000))
+  if (payload.issuanceDate) validators.validateTimestamp(payload.issuanceDate)
+  if (payload.expirationDate) validators.validateTimestamp(payload.expirationDate)
 }
 
 export function validateJwtPresentationPayload(payload: JwtPresentationPayload): void {

src/types.ts

@@ -46,9 +46,9 @@ export type DateType = string | Date
  * used as input when creating Verifiable Credentials
  */
 interface FixedCredentialPayload {
-  '@context': string[]
+  '@context': string | string[]
   id?: string
-  type: string[]
+  type: string | string[]
   issuer: IssuerType
   issuanceDate: DateType
   expirationDate?: DateType
@@ -65,6 +65,8 @@ export type CredentialPayload = Extensible<FixedCredentialPayload>
  * This is meant to reflect unambiguous types for the properties in `CredentialPayload`
  */
 interface NarrowCredentialDefinitions {
+  '@context': string[]
+  type: string[]
   issuer: Exclude<IssuerType, string>
   issuanceDate: string
   expirationDate?: string
@@ -92,19 +94,22 @@ export type W3CCredential = Extensible<Replace<FixedCredentialPayload, NarrowCre
  * used as input when creating Verifiable Presentations
  */
 export interface FixedPresentationPayload {
-  '@context': string[]
-  type: string[]
+  '@context': string | string[]
+  type: string | string[]
   id?: string
   verifiableCredential: VerifiableCredential[]
   holder: string
-  verifier?: string[]
+  verifier?: string | string[]
   issuanceDate?: string
   expirationDate?: string
 }
 
 export type PresentationPayload = Extensible<FixedPresentationPayload>
 
 interface NarrowPresentationDefinitions {
+  '@context': string[]
+  type: string[]
+  verifier: string[]
   verifiableCredential: Verifiable<W3CCredential>[]
 }
 

src/validators.ts

@@ -1,8 +1,12 @@
-import { DID_FORMAT, DEFAULT_CONTEXT, DEFAULT_VC_TYPE, DEFAULT_VP_TYPE, JWT_FORMAT } from './constants'
-import { JwtCredentialSubject } from './types'
+import { DEFAULT_CONTEXT, DEFAULT_VC_TYPE, DEFAULT_VP_TYPE, JWT_FORMAT } from './constants'
+import { JwtCredentialSubject, DateType } from './types'
 import { VerifiableCredential } from 'src'
 import { asArray } from './converters'
 
+function isDateObject(input: any) {
+  return input && Object.prototype.toString.call(input) === '[object Date]' && !isNaN(input)
+}
+
 export function validateJwtFormat(value: VerifiableCredential): void {
   if (typeof value === 'string' && !value.match(JWT_FORMAT)) {
     throw new TypeError(`"${value}" is not a valid JWT format`)
@@ -16,14 +20,14 @@ export function validateJwtFormat(value: VerifiableCredential): void {
 // 10 digits max is 9999999999 -> 11/20/2286 @ 5:46pm (UTC)
 // 11 digits max is 99999999999 -> 11/16/5138 @ 9:46am (UTC)
 // 12 digits max is 999999999999 -> 09/27/33658 @ 1:46am (UTC)
-export function validateTimestamp(value: number | string): void {
+export function validateTimestamp(value: number | DateType): void {
   if (typeof value === 'number') {
     if (!(Number.isInteger(value) && value < 100000000000)) {
       throw new TypeError(`"${value}" is not a unix timestamp in seconds`)
     }
   } else if (typeof value === 'string') {
-    validateTimestamp(new Date(value).valueOf() / 1000)
-  } else {
+    validateTimestamp(Math.floor(new Date(value).valueOf() / 1000))
+  } else if (!isDateObject(value)) {
     throw new TypeError(`"${value}" is not a valid time`)
   }
 }