fix(types): update Service interface to match latest DID spec (#136)

fixes #135

BREAKING CHANGE: the `ServiceEndpoint` type has been renamed to `Service` and a new type `ServiceEndpoint` was created to fit the [DID spec](https://www.w3.org/TR/did-core/#services)

Author: nickreynolds

src/__tests__/resolver.test.ts

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { Resolver, parse } from '../resolver'
+import { Resolver, parse, DIDResolutionResult } from '../resolver'
 
 describe('resolver', () => {
   describe('parse()', () => {
@@ -161,7 +161,7 @@ describe('resolver', () => {
     beforeAll(() => {
       mockmethod = jest.fn().mockReturnValue(mockReturn)
       resolver = new Resolver({
-        example: async (did: string) => ({
+        example: async (did: string): Promise<DIDResolutionResult> => ({
           didResolutionMetadata: { contentType: 'application/did+ld+json' },
           didDocument: {
             '@context': 'https://w3id.org/did/v1',
@@ -213,6 +213,114 @@ describe('resolver', () => {
         didDocumentMetadata: {},
       })
     })
+    
+    it('resolves did document with service', async () => {
+      const altResolver = new Resolver({
+        example: async (did: string): Promise<DIDResolutionResult> => ({
+          didResolutionMetadata: { contentType: 'application/did+ld+json' },
+          didDocument: {
+            '@context': 'https://w3id.org/did/v1',
+            id: did,
+            verificationMethod: [
+              {
+                id: 'owner',
+                controller: '1234',
+                type: 'xyz',
+              },
+            ],
+            service: [
+              {
+                id: `service-${did}`,
+                type: 'Service',
+                serviceEndpoint: 'https://example.com/',
+              }
+            ],
+          },
+          didDocumentMetadata: {},
+        }),
+        mock: mockmethod,
+      })
+
+      await expect(altResolver.resolve('did:example:123456789')).resolves.toEqual({
+        didResolutionMetadata: { contentType: 'application/did+ld+json' },
+        didDocument: {
+          '@context': 'https://w3id.org/did/v1',
+          id: 'did:example:123456789',
+          verificationMethod: [
+            {
+              id: 'owner',
+              controller: '1234',
+              type: 'xyz',
+            },
+          ],
+          service: [
+            {
+              id: 'service-did:example:123456789',
+              type: 'Service',
+              serviceEndpoint: 'https://example.com/',
+            }
+          ],
+        },
+        didDocumentMetadata: {},
+      })
+    })
+
+    it('resolves did document with expanded service', async () => {
+      const altResolver = new Resolver({
+        example: async (did: string): Promise<DIDResolutionResult> => ({
+          didResolutionMetadata: { contentType: 'application/did+ld+json' },
+          didDocument: {
+            '@context': 'https://w3id.org/did/v1',
+            id: did,
+            verificationMethod: [
+              {
+                id: 'owner',
+                controller: '1234',
+                type: 'xyz',
+              },
+            ],
+            service: [
+              {
+                id: `service-${did}`,
+                type: 'Service',
+                serviceEndpoint: {
+                  uri: 'yep',
+                  accept: ['xyz']
+                },
+              }
+            ],
+          },
+          didDocumentMetadata: {},
+        }),
+        mock: mockmethod,
+      })
+
+      await expect(altResolver.resolve('did:example:123456789')).resolves.toEqual({
+        didResolutionMetadata: { contentType: 'application/did+ld+json' },
+        didDocument: {
+          '@context': 'https://w3id.org/did/v1',
+          id: 'did:example:123456789',
+          verificationMethod: [
+            {
+              id: 'owner',
+              controller: '1234',
+              type: 'xyz',
+            },
+          ],
+          service: [
+            {
+              id: 'service-did:example:123456789',
+              type: 'Service',
+              serviceEndpoint: {
+                uri: 'yep',
+                accept: ['xyz']
+              },
+            }
+          ],
+        },
+        didDocumentMetadata: {},
+      })
+    })
 
     it('resolves did document with legacy resolver', async () => {
       const resolverWithLegacy = new Resolver(

src/resolver.ts

@@ -55,7 +55,7 @@ export type DIDDocument = {
   alsoKnownAs?: string[]
   controller?: string | string[]
   verificationMethod?: VerificationMethod[]
-  service?: ServiceEndpoint[]
+  service?: Service[]
   /**
    * @deprecated
    */
@@ -64,13 +64,15 @@ export type DIDDocument = {
   [x in KeyCapabilitySection]?: (string | VerificationMethod)[]
 }
 
-export interface ServiceEndpoint {
+export interface Service {
   id: string
   type: string
-  serviceEndpoint: string
-  description?: string
+  serviceEndpoint: ServiceEndpoint | ServiceEndpoint[]
+  [x: string]: any
 }
 
+export type ServiceEndpoint = string | Record<string, any>
+
 /**
  * Encapsulates a JSON web key type that includes only the public properties that
  * can be used in DID documents.