@testerpaykit/api-client 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -292,14 +292,15 @@ declare class TesterPayKitApiClient implements IApiClient {
292
292
  }): Promise<RetestItem[]>;
293
293
  /**
294
294
  * POST /v1/testers/me/retests/{bugId}/verify
295
- * Mark a retest as verified (bug is fixed).
295
+ * Mark a retest as verified (bug is fixed). With stepVerdicts the API
296
+ * only verifies when every acceptance step passed.
296
297
  */
297
- verifyRetest(bugId: string): Promise<void>;
298
+ verifyRetest(bugId: string, stepVerdicts?: RetestStepVerdicts): Promise<void>;
298
299
  /**
299
300
  * POST /v1/testers/me/retests/{bugId}/reopen
300
301
  * Reopen a retest (bug is still present), optionally with a reason.
301
302
  */
302
- reopenRetest(bugId: string, reason?: string): Promise<void>;
303
+ reopenRetest(bugId: string, reason?: string, stepVerdicts?: RetestStepVerdicts): Promise<void>;
303
304
  /**
304
305
  * POST /v1/testers/me/bug-reports/voice-extract
305
306
  * Contract: wire.bug_reports.voiceExtractBugFields
@@ -481,6 +482,16 @@ interface TesterSessionResponse {
481
482
  tester_id?: string;
482
483
  started_at?: string;
483
484
  ended_at?: string | null;
485
+ /** Set when the API knows a newer SDK release than the one reported. */
486
+ sdkUpdate?: SdkUpdateInfo;
487
+ }
488
+ /** A newer TesterPayKit SDK is out (from the session-start response). */
489
+ interface SdkUpdateInfo {
490
+ package: string;
491
+ current: string;
492
+ latest: string;
493
+ /** Command to run in the app's folder. */
494
+ command: string;
484
495
  }
485
496
  type TesterSessionEndReason = 'completed' | 'lifecycle_flush' | 'timeout' | 'abandoned';
486
497
  interface EndTesterSessionInput {
@@ -661,7 +672,14 @@ interface RetestItem {
661
672
  createdAt: string;
662
673
  projectId: string;
663
674
  screenshotPath?: string | null;
675
+ /**
676
+ * Steps that prove the fix; the last one states the expected behaviour.
677
+ * Judge each and pass the verdicts to verifyRetest / reopenRetest.
678
+ */
679
+ acceptanceSteps?: string[];
664
680
  }
681
+ /** Verdict per acceptance step (1-based step number → passed). */
682
+ type RetestStepVerdicts = Record<number, boolean>;
665
683
  /** A task preset from GET /v1/tasks */
666
684
  interface TaskPreset {
667
685
  id: string;
@@ -687,4 +705,4 @@ interface TaskStep {
687
705
  }
688
706
 
689
707
  export { TesterPayKitApiClient };
690
- export type { AnonymousLoginResponse, ApiClientConfig, BugCategory, BugReportAttachmentInput, BugReportAttachmentResponse, BugReportPayload, BugReportResponse, BugReportType, BugSeverity, EarningsSummary, EndTesterSessionInput, EnrollmentResponse, FeedbackResponse, KnowledgeBaseAnswer, KnowledgeBaseCitation, KnowledgeFile, KnowledgeFileSummary, MyBugReportSummary, MyBugReportsResponse, NotificationsResult, PayoutRecord, RegisterDeviceInput, RetestItem, SessionBreadcrumbInput, SessionBreadcrumbsResponse, SessionEventInput, SessionEventsResponse, StartTesterSessionInput, SubmissionResponse, TaskListFilter, TaskListResponse, TaskPreset, TaskStep, TesterDeviceResponse, TesterPoints, TesterProfile, TesterSessionEndReason, TesterSessionResponse, TesterTask, TpkNotification };
708
+ export type { AnonymousLoginResponse, ApiClientConfig, BugCategory, BugReportAttachmentInput, BugReportAttachmentResponse, BugReportPayload, BugReportResponse, BugReportType, BugSeverity, EarningsSummary, EndTesterSessionInput, EnrollmentResponse, FeedbackResponse, KnowledgeBaseAnswer, KnowledgeBaseCitation, KnowledgeFile, KnowledgeFileSummary, MyBugReportSummary, MyBugReportsResponse, NotificationsResult, PayoutRecord, RegisterDeviceInput, RetestItem, RetestStepVerdicts, SdkUpdateInfo, SessionBreadcrumbInput, SessionBreadcrumbsResponse, SessionEventInput, SessionEventsResponse, StartTesterSessionInput, SubmissionResponse, TaskListFilter, TaskListResponse, TaskPreset, TaskStep, TesterDeviceResponse, TesterPoints, TesterProfile, TesterSessionEndReason, TesterSessionResponse, TesterTask, TpkNotification };
package/dist/index.d.ts CHANGED
@@ -292,14 +292,15 @@ declare class TesterPayKitApiClient implements IApiClient {
292
292
  }): Promise<RetestItem[]>;
293
293
  /**
294
294
  * POST /v1/testers/me/retests/{bugId}/verify
295
- * Mark a retest as verified (bug is fixed).
295
+ * Mark a retest as verified (bug is fixed). With stepVerdicts the API
296
+ * only verifies when every acceptance step passed.
296
297
  */
297
- verifyRetest(bugId: string): Promise<void>;
298
+ verifyRetest(bugId: string, stepVerdicts?: RetestStepVerdicts): Promise<void>;
298
299
  /**
299
300
  * POST /v1/testers/me/retests/{bugId}/reopen
300
301
  * Reopen a retest (bug is still present), optionally with a reason.
301
302
  */
302
- reopenRetest(bugId: string, reason?: string): Promise<void>;
303
+ reopenRetest(bugId: string, reason?: string, stepVerdicts?: RetestStepVerdicts): Promise<void>;
303
304
  /**
304
305
  * POST /v1/testers/me/bug-reports/voice-extract
305
306
  * Contract: wire.bug_reports.voiceExtractBugFields
@@ -481,6 +482,16 @@ interface TesterSessionResponse {
481
482
  tester_id?: string;
482
483
  started_at?: string;
483
484
  ended_at?: string | null;
485
+ /** Set when the API knows a newer SDK release than the one reported. */
486
+ sdkUpdate?: SdkUpdateInfo;
487
+ }
488
+ /** A newer TesterPayKit SDK is out (from the session-start response). */
489
+ interface SdkUpdateInfo {
490
+ package: string;
491
+ current: string;
492
+ latest: string;
493
+ /** Command to run in the app's folder. */
494
+ command: string;
484
495
  }
485
496
  type TesterSessionEndReason = 'completed' | 'lifecycle_flush' | 'timeout' | 'abandoned';
486
497
  interface EndTesterSessionInput {
@@ -661,7 +672,14 @@ interface RetestItem {
661
672
  createdAt: string;
662
673
  projectId: string;
663
674
  screenshotPath?: string | null;
675
+ /**
676
+ * Steps that prove the fix; the last one states the expected behaviour.
677
+ * Judge each and pass the verdicts to verifyRetest / reopenRetest.
678
+ */
679
+ acceptanceSteps?: string[];
664
680
  }
681
+ /** Verdict per acceptance step (1-based step number → passed). */
682
+ type RetestStepVerdicts = Record<number, boolean>;
665
683
  /** A task preset from GET /v1/tasks */
666
684
  interface TaskPreset {
667
685
  id: string;
@@ -687,4 +705,4 @@ interface TaskStep {
687
705
  }
688
706
 
689
707
  export { TesterPayKitApiClient };
690
- export type { AnonymousLoginResponse, ApiClientConfig, BugCategory, BugReportAttachmentInput, BugReportAttachmentResponse, BugReportPayload, BugReportResponse, BugReportType, BugSeverity, EarningsSummary, EndTesterSessionInput, EnrollmentResponse, FeedbackResponse, KnowledgeBaseAnswer, KnowledgeBaseCitation, KnowledgeFile, KnowledgeFileSummary, MyBugReportSummary, MyBugReportsResponse, NotificationsResult, PayoutRecord, RegisterDeviceInput, RetestItem, SessionBreadcrumbInput, SessionBreadcrumbsResponse, SessionEventInput, SessionEventsResponse, StartTesterSessionInput, SubmissionResponse, TaskListFilter, TaskListResponse, TaskPreset, TaskStep, TesterDeviceResponse, TesterPoints, TesterProfile, TesterSessionEndReason, TesterSessionResponse, TesterTask, TpkNotification };
708
+ export type { AnonymousLoginResponse, ApiClientConfig, BugCategory, BugReportAttachmentInput, BugReportAttachmentResponse, BugReportPayload, BugReportResponse, BugReportType, BugSeverity, EarningsSummary, EndTesterSessionInput, EnrollmentResponse, FeedbackResponse, KnowledgeBaseAnswer, KnowledgeBaseCitation, KnowledgeFile, KnowledgeFileSummary, MyBugReportSummary, MyBugReportsResponse, NotificationsResult, PayoutRecord, RegisterDeviceInput, RetestItem, RetestStepVerdicts, SdkUpdateInfo, SessionBreadcrumbInput, SessionBreadcrumbsResponse, SessionEventInput, SessionEventsResponse, StartTesterSessionInput, SubmissionResponse, TaskListFilter, TaskListResponse, TaskPreset, TaskStep, TesterDeviceResponse, TesterPoints, TesterProfile, TesterSessionEndReason, TesterSessionResponse, TesterTask, TpkNotification };
package/dist/index.js CHANGED
@@ -285,7 +285,10 @@ var TesterPayKitApiClient = class {
285
285
  ...input.deviceId && { device_id: input.deviceId }
286
286
  };
287
287
  const response = await this.client.post("/v1/testers/sessions", body);
288
- return response.data.session;
288
+ return {
289
+ ...response.data.session,
290
+ ...response.data.sdk_update && { sdkUpdate: response.data.sdk_update }
291
+ };
289
292
  }
290
293
  /** End a server-side tester session with optional counters. */
291
294
  async endTesterSession(input) {
@@ -540,22 +543,26 @@ var TesterPayKitApiClient = class {
540
543
  "/v1/testers/me/retests",
541
544
  { params }
542
545
  );
543
- return response.data;
546
+ return response.data.retests;
544
547
  }
545
548
  /**
546
549
  * POST /v1/testers/me/retests/{bugId}/verify
547
- * Mark a retest as verified (bug is fixed).
550
+ * Mark a retest as verified (bug is fixed). With stepVerdicts the API
551
+ * only verifies when every acceptance step passed.
548
552
  */
549
- async verifyRetest(bugId) {
550
- await this.client.post(`/v1/testers/me/retests/${bugId}/verify`);
553
+ async verifyRetest(bugId, stepVerdicts) {
554
+ await this.client.post(`/v1/testers/me/retests/${bugId}/verify`, {
555
+ ...stepVerdicts ? { step_results: stepResults(stepVerdicts) } : {}
556
+ });
551
557
  }
552
558
  /**
553
559
  * POST /v1/testers/me/retests/{bugId}/reopen
554
560
  * Reopen a retest (bug is still present), optionally with a reason.
555
561
  */
556
- async reopenRetest(bugId, reason) {
562
+ async reopenRetest(bugId, reason, stepVerdicts) {
557
563
  await this.client.post(`/v1/testers/me/retests/${bugId}/reopen`, {
558
- ...reason ? { reason } : {}
564
+ ...reason ? { reason } : {},
565
+ ...stepVerdicts ? { step_results: stepResults(stepVerdicts) } : {}
559
566
  });
560
567
  }
561
568
  /**
@@ -585,6 +592,9 @@ var TesterPayKitApiClient = class {
585
592
  return response.data;
586
593
  }
587
594
  };
595
+ function stepResults(verdicts) {
596
+ return Object.entries(verdicts).map(([step, passed]) => ({ step: Number(step), passed }));
597
+ }
588
598
  function formatTimestamp(timestamp) {
589
599
  return timestamp instanceof Date ? timestamp.toISOString() : timestamp;
590
600
  }
package/dist/index.mjs CHANGED
@@ -251,7 +251,10 @@ var TesterPayKitApiClient = class {
251
251
  ...input.deviceId && { device_id: input.deviceId }
252
252
  };
253
253
  const response = await this.client.post("/v1/testers/sessions", body);
254
- return response.data.session;
254
+ return {
255
+ ...response.data.session,
256
+ ...response.data.sdk_update && { sdkUpdate: response.data.sdk_update }
257
+ };
255
258
  }
256
259
  /** End a server-side tester session with optional counters. */
257
260
  async endTesterSession(input) {
@@ -506,22 +509,26 @@ var TesterPayKitApiClient = class {
506
509
  "/v1/testers/me/retests",
507
510
  { params }
508
511
  );
509
- return response.data;
512
+ return response.data.retests;
510
513
  }
511
514
  /**
512
515
  * POST /v1/testers/me/retests/{bugId}/verify
513
- * Mark a retest as verified (bug is fixed).
516
+ * Mark a retest as verified (bug is fixed). With stepVerdicts the API
517
+ * only verifies when every acceptance step passed.
514
518
  */
515
- async verifyRetest(bugId) {
516
- await this.client.post(`/v1/testers/me/retests/${bugId}/verify`);
519
+ async verifyRetest(bugId, stepVerdicts) {
520
+ await this.client.post(`/v1/testers/me/retests/${bugId}/verify`, {
521
+ ...stepVerdicts ? { step_results: stepResults(stepVerdicts) } : {}
522
+ });
517
523
  }
518
524
  /**
519
525
  * POST /v1/testers/me/retests/{bugId}/reopen
520
526
  * Reopen a retest (bug is still present), optionally with a reason.
521
527
  */
522
- async reopenRetest(bugId, reason) {
528
+ async reopenRetest(bugId, reason, stepVerdicts) {
523
529
  await this.client.post(`/v1/testers/me/retests/${bugId}/reopen`, {
524
- ...reason ? { reason } : {}
530
+ ...reason ? { reason } : {},
531
+ ...stepVerdicts ? { step_results: stepResults(stepVerdicts) } : {}
525
532
  });
526
533
  }
527
534
  /**
@@ -551,6 +558,9 @@ var TesterPayKitApiClient = class {
551
558
  return response.data;
552
559
  }
553
560
  };
561
+ function stepResults(verdicts) {
562
+ return Object.entries(verdicts).map(([step, passed]) => ({ step: Number(step), passed }));
563
+ }
554
564
  function formatTimestamp(timestamp) {
555
565
  return timestamp instanceof Date ? timestamp.toISOString() : timestamp;
556
566
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@testerpaykit/api-client",
3
- "version": "1.3.0",
3
+ "version": "1.4.0",
4
4
  "description": "API client for TesterPayKit backend",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
@@ -14,7 +14,7 @@
14
14
  },
15
15
  "dependencies": {
16
16
  "axios": "^1.20.0",
17
- "@testerpaykit/core": "1.1.0"
17
+ "@testerpaykit/core": "1.2.0"
18
18
  },
19
19
  "devDependencies": {
20
20
  "@types/node": "^26.6.5",
@@ -353,8 +353,12 @@ export class TesterPayKitApiClient implements IApiClient {
353
353
  };
354
354
  const response = await this.client.post<{
355
355
  session: TesterSessionResponse;
356
+ sdk_update?: SdkUpdateInfo;
356
357
  }>('/v1/testers/sessions', body);
357
- return response.data.session;
358
+ return {
359
+ ...response.data.session,
360
+ ...(response.data.sdk_update && { sdkUpdate: response.data.sdk_update }),
361
+ };
358
362
  }
359
363
 
360
364
  /** End a server-side tester session with optional counters. */
@@ -661,28 +665,36 @@ export class TesterPayKitApiClient implements IApiClient {
661
665
  * List bug reports assigned to this tester for re-verification.
662
666
  */
663
667
  async getMyRetests(params?: { status?: string }): Promise<RetestItem[]> {
664
- const response = await this.client.get<RetestItem[]>(
668
+ const response = await this.client.get<{ retests: RetestItem[] }>(
665
669
  '/v1/testers/me/retests',
666
670
  { params },
667
671
  );
668
- return response.data;
672
+ return response.data.retests;
669
673
  }
670
674
 
671
675
  /**
672
676
  * POST /v1/testers/me/retests/{bugId}/verify
673
- * Mark a retest as verified (bug is fixed).
677
+ * Mark a retest as verified (bug is fixed). With stepVerdicts the API
678
+ * only verifies when every acceptance step passed.
674
679
  */
675
- async verifyRetest(bugId: string): Promise<void> {
676
- await this.client.post(`/v1/testers/me/retests/${bugId}/verify`);
680
+ async verifyRetest(bugId: string, stepVerdicts?: RetestStepVerdicts): Promise<void> {
681
+ await this.client.post(`/v1/testers/me/retests/${bugId}/verify`, {
682
+ ...(stepVerdicts ? { step_results: stepResults(stepVerdicts) } : {}),
683
+ });
677
684
  }
678
685
 
679
686
  /**
680
687
  * POST /v1/testers/me/retests/{bugId}/reopen
681
688
  * Reopen a retest (bug is still present), optionally with a reason.
682
689
  */
683
- async reopenRetest(bugId: string, reason?: string): Promise<void> {
690
+ async reopenRetest(
691
+ bugId: string,
692
+ reason?: string,
693
+ stepVerdicts?: RetestStepVerdicts,
694
+ ): Promise<void> {
684
695
  await this.client.post(`/v1/testers/me/retests/${bugId}/reopen`, {
685
696
  ...(reason ? { reason } : {}),
697
+ ...(stepVerdicts ? { step_results: stepResults(stepVerdicts) } : {}),
686
698
  });
687
699
  }
688
700
 
@@ -921,6 +933,17 @@ export interface TesterSessionResponse {
921
933
  tester_id?: string;
922
934
  started_at?: string;
923
935
  ended_at?: string | null;
936
+ /** Set when the API knows a newer SDK release than the one reported. */
937
+ sdkUpdate?: SdkUpdateInfo;
938
+ }
939
+
940
+ /** A newer TesterPayKit SDK is out (from the session-start response). */
941
+ export interface SdkUpdateInfo {
942
+ package: string;
943
+ current: string;
944
+ latest: string;
945
+ /** Command to run in the app's folder. */
946
+ command: string;
924
947
  }
925
948
 
926
949
  export type TesterSessionEndReason =
@@ -1109,6 +1132,10 @@ export interface FeedbackResponse {
1109
1132
  message?: string;
1110
1133
  }
1111
1134
 
1135
+ function stepResults(verdicts: RetestStepVerdicts): { step: number; passed: boolean }[] {
1136
+ return Object.entries(verdicts).map(([step, passed]) => ({ step: Number(step), passed }));
1137
+ }
1138
+
1112
1139
  /** A single retest item from GET /v1/testers/me/retests */
1113
1140
  export interface RetestItem {
1114
1141
  id: string;
@@ -1125,8 +1152,16 @@ export interface RetestItem {
1125
1152
  createdAt: string;
1126
1153
  projectId: string;
1127
1154
  screenshotPath?: string | null;
1155
+ /**
1156
+ * Steps that prove the fix; the last one states the expected behaviour.
1157
+ * Judge each and pass the verdicts to verifyRetest / reopenRetest.
1158
+ */
1159
+ acceptanceSteps?: string[];
1128
1160
  }
1129
1161
 
1162
+ /** Verdict per acceptance step (1-based step number → passed). */
1163
+ export type RetestStepVerdicts = Record<number, boolean>;
1164
+
1130
1165
  /** A task preset from GET /v1/tasks */
1131
1166
  export interface TaskPreset {
1132
1167
  id: string;
@@ -372,6 +372,39 @@ describe('TesterPayKitApiClient', () => {
372
372
  });
373
373
  });
374
374
 
375
+ describe('retests', () => {
376
+ it('unwraps the retest list from the response envelope', async () => {
377
+ const retests = [{ id: 'b1', title: 'Crash', status: 'fixed', createdAt: 'x', projectId: 'p' }];
378
+ mockAxiosInstance.get.mockResolvedValue({ data: { retests, total: 1 } });
379
+
380
+ const result = await client.getMyRetests();
381
+
382
+ expect(mockAxiosInstance.get).toHaveBeenCalledWith('/v1/testers/me/retests', { params: undefined });
383
+ expect(result).toEqual(retests);
384
+ });
385
+
386
+ it('sends acceptance step verdicts as step_results', async () => {
387
+ mockAxiosInstance.post.mockResolvedValue({ data: {} });
388
+
389
+ await client.verifyRetest('b1', { 1: true, 2: true });
390
+ await client.reopenRetest('b1', 'still broken', { 1: true, 2: false });
391
+
392
+ expect(mockAxiosInstance.post).toHaveBeenCalledWith('/v1/testers/me/retests/b1/verify', {
393
+ step_results: [
394
+ { step: 1, passed: true },
395
+ { step: 2, passed: true },
396
+ ],
397
+ });
398
+ expect(mockAxiosInstance.post).toHaveBeenCalledWith('/v1/testers/me/retests/b1/reopen', {
399
+ reason: 'still broken',
400
+ step_results: [
401
+ { step: 1, passed: true },
402
+ { step: 2, passed: false },
403
+ ],
404
+ });
405
+ });
406
+ });
407
+
375
408
  describe('setAccessToken', () => {
376
409
  it('should set access token', () => {
377
410
  client.setAccessToken('manual-token');