Modify the returned data structure

The new type "CheckResult" now contains information about how the data was fetched

Author: axelrindle

packages/api/src/index.ts

@@ -89,7 +89,15 @@ export interface ReleaseDescriptor {
     url: string
 }
 
-export type CallbackFunction = (error?: Error|string, update?: ReleaseDescriptor | TagDescriptor) => void
+export interface CheckResult {
+    src: 'rest'|'graphql'
+    type: 'releases'|'tags'
+    update: ReleaseDescriptor | TagDescriptor | undefined
+}
+
+export type CheckFunction = (options: CheckOptions) => Promise<CheckResult>
+
+export type CallbackFunction = (error?: Error|string, update?: CheckResult) => void
 
 export type RestHandlerFunction = (res: IncomingMessage) => void
 

packages/core/src/check.ts

@@ -1,6 +1,6 @@
+import { CheckFunction, CheckOptions, CheckResult } from '@github-version-checker/api'
 import graphql from './query/graphql'
 import rest from './query/rest'
-import { CheckOptions, ReleaseDescriptor, TagDescriptor } from '@github-version-checker/api'
 
 /**
  * Checks whether a new version is available. Depending on whether a token is given, the
@@ -9,7 +9,7 @@ import { CheckOptions, ReleaseDescriptor, TagDescriptor } from '@github-version-
  *
  * @param options The options for the version check.
  */
-export default async function check(options: CheckOptions): Promise<ReleaseDescriptor|TagDescriptor|undefined> {
+const check: CheckFunction = async function(options: CheckOptions): Promise<CheckResult> {
     if (options === null || options === undefined) {
         throw new Error('options object must not be null or undefined!')
     }
@@ -32,12 +32,10 @@ export default async function check(options: CheckOptions): Promise<ReleaseDescr
     // decide what to do
     // when we have a token supplied, we will call the GraphQL API
     if (options.token) {
-        if (options.excludePrereleases) {
-            throw new Error('excludePrereleases option currently unsupported when specifying a token.')
-        }
-
         return await graphql(options)
     } else {
         return await rest(options)
     }
 }
+
+export default check

packages/core/src/index.ts

@@ -1,5 +1,5 @@
+import { CallbackFunction, CheckOptions, CheckResult } from '@github-version-checker/api'
 import check from './check'
-import { CallbackFunction, CheckOptions, ReleaseDescriptor, TagDescriptor } from '@github-version-checker/api'
 
 /**
  * The exported checking function.
@@ -11,7 +11,7 @@ import { CallbackFunction, CheckOptions, ReleaseDescriptor, TagDescriptor } from
 export default function versionCheck(
     options: CheckOptions,
     callback?: CallbackFunction
-): undefined|Promise<ReleaseDescriptor|TagDescriptor|undefined> {
+): undefined | Promise<CheckResult> {
     if (callback) {
         check(options)
             .then(update => callback(undefined, update))

packages/core/src/query/graphql.ts

@@ -1,7 +1,7 @@
 import { Octokit } from '@octokit/core'
 import type { GraphQlQueryResponseData } from '@octokit/graphql';
 import { gt } from 'semver'
-import { CheckOptions, ReleaseDescriptor, TagDescriptor } from '@github-version-checker/api'
+import { CheckFunction, CheckOptions, CheckResult } from '@github-version-checker/api'
 import { releases, tags } from '../util/graphql'
 
 /**
@@ -12,7 +12,7 @@ import { releases, tags } from '../util/graphql'
  *
  * @param options The options for the version check.
  */
-export default async function graphql(options: CheckOptions): Promise<ReleaseDescriptor|TagDescriptor|undefined> {
+const graphql: CheckFunction = async function(options: CheckOptions): Promise<CheckResult> {
     const theQuery = options.fetchTags ? tags : releases
 
     const octokit = new Octokit({
@@ -31,35 +31,44 @@ export default async function graphql(options: CheckOptions): Promise<ReleaseDes
         return repository
     }
 
+    const result: CheckResult = {
+        src: 'graphql',
+        type: options.fetchTags ? 'tags' : 'releases',
+        update: undefined
+    }
+
     let cursor: string|undefined = undefined
-    const found = false
+    let found = false
     while (! found) {
         const repository: any = await fetch(cursor)
         const entries: any[] = options.fetchTags ? repository.refs.nodes : repository.releases.nodes
 
         if (entries.length == 0) {
-            return undefined
+            return result
         }
 
-        const skip = (! options.fetchTags && entries[0].isDraft) || (options.excludePrereleases && entries[0].isPrerelease)
-        if (skip) {
+        const skip = entries[0].isDraft || (options.excludePrereleases && entries[0].isPrerelease)
+        if (! options.fetchTags && skip) {
             if (repository.releases.pageInfo.hasNextPage) {
                 cursor = repository.releases.pageInfo.endCursor
                 continue
             } else {
-                return undefined
+                return result
             }
         }
 
         // Retrieve newer version name
         const newer = entries[0]
-        const fetchedVersion = options.fetchTags ? newer.name : newer.tagName
+        const fetchedVersion = options.fetchTags ? newer.name : newer.tag.name
         if (gt(fetchedVersion, options.currentVersion)) {
-            return newer
+            result.update = newer
+            found = true
         } else {
-            return undefined
+            return result
         }
     }
 
-    return undefined
+    return result
 }
+
+export default graphql

packages/core/src/query/rest.ts

@@ -1,7 +1,8 @@
 import { Octokit } from '@octokit/core'
-import { CheckOptions, ReleaseDescriptor, TagDescriptor } from '@github-version-checker/api'
+import { CheckFunction, CheckOptions, CheckResult, RestResponseTag } from '@github-version-checker/api'
 import { compareReleases, compareTags } from '../util/comparator'
 import { release, tag } from '../util/scheme-mapper'
+import semver from 'semver'
 
 /**
  * Executes an API call on the Github Rest API (v3) that should return the latest version.
@@ -11,7 +12,7 @@ import { release, tag } from '../util/scheme-mapper'
  *
  * @param options The options for the version check.
 */
-export default async function rest(options: CheckOptions): Promise<ReleaseDescriptor|TagDescriptor|undefined> {
+const rest: CheckFunction = async function(options: CheckOptions): Promise<CheckResult> {
     // build url
     let apiUrl = '/repos/{owner}/{repo}'
     if (options.fetchTags) {
@@ -36,9 +37,15 @@ export default async function rest(options: CheckOptions): Promise<ReleaseDescri
         }
     })
 
+    const result: CheckResult = {
+        src: 'rest',
+        type: options.fetchTags ? 'tags' : 'releases',
+        update: undefined
+    }
+
     // 404 error occurs, when no releases are found
     if (response.status === 404) {
-        return undefined
+        return result
     }
 
     // status codes other than 200 are treated as an error
@@ -47,9 +54,13 @@ export default async function rest(options: CheckOptions): Promise<ReleaseDescri
     }
 
     if (options.fetchTags) {
-        return tag(compareTags(options, response.data))
+        result.update = tag(compareTags(options, response.data))
     }
     else {
-        return release(compareReleases(options, response.data))
+        result.update = release(compareReleases(options, response.data))
     }
+
+    return result
 }
+
+export default rest

packages/core/test/test-comparator.ts

@@ -1,5 +1,5 @@
 import test from 'ava'
-import { CheckOptions, RestResponseRelease, RestResponseTag } from '../src/types'
+import { CheckOptions, RestResponseRelease, RestResponseTag } from '@github-version-checker/api'
 import { compareReleases, compareTags } from '../src/util/comparator'
 
 const options: CheckOptions = {

packages/core/test/test-promise-handling.ts

@@ -7,7 +7,7 @@ const tester = options => {
 
     test(`one parameter and correct options returns without errors (${counter})`, t => {
         t.notThrows(() => {
-            versionCheck(options).then(update => {
+            versionCheck(options).then(({update}) => {
                 t.truthy(update)
                 t.is(update.name, 'axelrindle/github-version-checker')
             })

packages/core/test/test-tags.ts

@@ -2,14 +2,15 @@ import test from 'ava'
 import versionCheck from '../src/index'
 
 test('fetching tags returns a more lightweight schema', async t => {
-    const update = await versionCheck({
+    const { type, update } = await versionCheck({
         token: false,
         owner: 'axelrindle',
         repo: 'github-version-checker',
         currentVersion: '0.0.1',
         fetchTags: true
     })
 
+    t.is(type, 'tags')
     t.truthy(update)
     t.is(Object.keys(update).length, 1)
     t.is(Object.keys(update)[0], 'name')