@microsoft/useragent-sdk/tests/hubSession/responses/HubObjectQueryResponse.spec.ts

SDK for building decentralized identity wallets and enterprise agents.

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import { IObjectMetadata } from '@decentralized-identity/hub-common-js';
import HubObjectQueryResponse from '../../../src/hubSession/responses/HubObjectQueryResponse';

const objects: IObjectMetadata[] = [{
  interface: 'Collections',
  context: 'schema.org',
  type: 'MusicPlaylist',
  id: 'abc',
  created_by: 'did:test:example.id',
  created_at: '2019-01-01',
  sub: 'did:test:example.id',
  commit_strategy: 'basic',
}];

describe('HubObjectQueryResponse', () => {

  let response: HubObjectQueryResponse;
  
  beforeAll(() => {
    response = new HubObjectQueryResponse({
      '@context': 'https://schema.identity.foundation/0.1',
      '@type': 'ObjectQueryResponse',
      objects,
      skip_token: 'abc',
    });
  });

  describe('constructor', () => {
    it('should throw on an invalid response type', async () => {
      try {
        const r = new HubObjectQueryResponse(<any> {
          '@type': 'WrongType',
        });
        fail(`Constructor was expected to throw: '${r}'`);
      } catch (e) {
        // Expected
      }
    });
  });

  describe('getObjects()', () => {
    it('should return the matching objects', async () => {
      const returnedObjects = await response.getObjects();
      expect(returnedObjects).toEqual(objects);
    });

    it('should return an array even if none was in the response', async () => {
      const response = new HubObjectQueryResponse(<any> {
        '@context': 'https://schema.identity.foundation/0.1',
        '@type': 'ObjectQueryResponse',
        objects: null,
      });
      expect(Array.isArray(response.getObjects())).toEqual(true);
    });
  });

  describe('hasSkipToken()', () => {
    it('should indicate whether a skip token was returned', async () => {
      expect(response.hasSkipToken()).toEqual(true);
    });
  });

  describe('getSkipToken()', () => {
    it('should return the skip token', async () => {
      expect(response.getSkipToken()).toEqual('abc');
    });
  });

});