@microsoft/useragent-sdk/src/hubSession/responses/HubCommitQueryResponse.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 ProtectedCommit from '../ProtectedCommit';
import IHubCommitQueryResponse from './IHubCommitQueryResponse';

/**
 * Represents the response to a `HubCommitQueryRequest`.
 */
export default class HubCommitQueryResponse {

  constructor(private response: IHubCommitQueryResponse) {
    if (response['@type'] !== 'CommitQueryResponse') {
      throw new Error('Unexpected response type; expected CommitQueryResponse');
    }
  }

  /**
   * Returns the set of commits returned by the Hub.
   */
  public getCommits() {
    return this.response.commits.map((commit) => {
      return new ProtectedCommit(commit);
    });
  }

  /**
   * Indicates whether additional pages of results are available.
   */
  public hasSkipToken() {
    return !!this.response.skip_token;
  }

  /**
   * Retrieves a token which can be used to fetch subsequent result pages.
   */
  public getSkipToken() {
    return this.response.skip_token;
  }

}