Better type DiffResult

`DiffResponse` is the response of the Bump.sh workspace API,
we should not mix it with the doc_name.

Hence the new type `DiffResult`, extension of the `DiffResponse`
with the optional `doc_name` field.

Thus, `DiffResponse` is not exported anymore to the outside (ie the GitHub action).

While here, clarify parameter name `result` to `apiResponse` in `waitResult`
function, as it can be either a `DiffResponse` or a `VersionResponse`.

Author: Polo2

src/api/models.ts

@@ -66,7 +66,6 @@ export interface DiffRequest {
 export interface DiffResponse {
   breaking?: boolean
   details?: DiffItem[]
-  doc_name?: string
   html?: string
   id: string
   markdown?: string

src/core/diff.ts

@@ -7,6 +7,10 @@ import {BumpApi} from '../api/index.js'
 import {DiffRequest, DiffResponse, VersionRequest, VersionResponse, WithDiff} from '../api/models.js'
 import {API} from '../definition.js'
 
+export interface DiffResult extends DiffResponse {
+  doc_name?: string
+}
+
 export class Diff {
   // 120 seconds = 2 minutes
   static readonly TIMEOUT = 120
@@ -108,7 +112,7 @@ export class Diff {
     return debug(`bump-cli:core:diff`)(formatter, ...args)
   }
 
-  extractDiff(versionWithDiff: VersionResponse & WithDiff): DiffResponse {
+  extractDiff(versionWithDiff: VersionResponse & WithDiff): DiffResult {
     // TODO: return a real diff_id in the GET /version API
     return {
       breaking: versionWithDiff.diff_breaking,
@@ -145,7 +149,7 @@ export class Diff {
     expires?: string | undefined,
     overlays1?: string[] | undefined,
     overlays2?: string[] | undefined,
-  ): Promise<DiffResponse | undefined> {
+  ): Promise<DiffResult | undefined> {
     if (!this._config) this._config = await Config.load(resolve(import.meta.dirname, './../../'))
 
     let diffVersion: DiffResponse | VersionResponse | undefined
@@ -183,13 +187,14 @@ export class Diff {
   }
 
   async waitResult(
-    result: DiffResponse | VersionResponse,
+    apiResponse: DiffResponse | VersionResponse,
     token: string | undefined,
     opts: {format: string; timeout: number},
-  ): Promise<DiffResponse> {
-    const pollingResponse = await (this.isVersion(result) && token
-      ? this.bumpClient.getVersion(result.id, token)
-      : this.bumpClient.getDiff(result.id, opts.format))
+  ): Promise<DiffResult> {
+    let diffResult: DiffResult = {id: apiResponse.id}
+    const pollingResponse = await (this.isVersion(apiResponse) && token
+      ? this.bumpClient.getVersion(apiResponse.id, token)
+      : this.bumpClient.getDiff(apiResponse.id, opts.format))
 
     if (opts.timeout <= 0) {
       throw new CLIError(
@@ -199,30 +204,28 @@ export class Diff {
 
     switch (pollingResponse.status) {
       case 200: {
-        let diff: DiffResponse | (VersionResponse & WithDiff) = pollingResponse.data
+        const diff: DiffResponse | (VersionResponse & WithDiff) = pollingResponse.data
 
-        if (this.isVersionWithDiff(diff)) {
-          diff = this.extractDiff(diff)
-        }
+        diffResult = this.isVersionWithDiff(diff) ? this.extractDiff(diff) : diff
 
         this.d('Received diff:')
-        this.d(diff)
-        return diff
+        this.d(diffResult)
+        return diffResult
         break
       }
 
       case 202: {
         this.d('Waiting 1 sec before next poll')
         await this.pollingDelay()
-        return this.waitResult(result, token, {
+        return this.waitResult(apiResponse, token, {
           format: opts.format,
           timeout: opts.timeout - 1,
         })
         break
       }
     }
 
-    return {} as DiffResponse
+    return diffResult
   }
 
   private async delay(ms: number): Promise<void> {

src/index.ts

@@ -10,7 +10,7 @@ export const COMMANDS = {
   preview: Preview,
 }
 
-export {DiffResponse, PreviewResponse, VersionResponse, WithDiff} from './api/models.js'
+export {PreviewResponse, VersionResponse, WithDiff} from './api/models.js'
 
 export {default as Deploy} from './commands/deploy.js'
 export {default as Preview} from './commands/preview.js'