@testerpaykit/api-client 1.3.0 → 1.5.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 +37 -5
- package/dist/index.d.ts +37 -5
- package/dist/index.js +44 -7
- package/dist/index.mjs +44 -7
- package/package.json +2 -2
- package/src/TesterPayKitApiClient.ts +79 -7
- package/tests/TesterPayKitApiClient.test.ts +33 -0
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { TokenManager, IApiClient, LoginRequest, LoginResponse, WeeklySummary, RemoteAiSession, VoiceBugExtractResponse } from '@testerpaykit/core';
|
|
1
|
+
import { TokenManager, IApiClient, LoginRequest, LoginResponse, WeeklySummary, RemoteAiSession, VoiceBugExtractResponse, QuickActionKind } from '@testerpaykit/core';
|
|
2
2
|
|
|
3
3
|
interface ApiClientConfig {
|
|
4
4
|
baseURL?: string;
|
|
@@ -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
|
|
@@ -318,6 +319,20 @@ declare class TesterPayKitApiClient implements IApiClient {
|
|
|
318
319
|
projectId?: string;
|
|
319
320
|
preClassification?: string;
|
|
320
321
|
}): Promise<VoiceBugExtractResponse>;
|
|
322
|
+
/**
|
|
323
|
+
* POST /v1/testers/me/bug-reports/quick-draft
|
|
324
|
+
*
|
|
325
|
+
* One-tap report draft written by the server from a screenshot of the
|
|
326
|
+
* current screen. Same shape as voiceExtractBugFields with an empty
|
|
327
|
+
* transcript; preClassification is the type the action files under.
|
|
328
|
+
*/
|
|
329
|
+
quickDraftBug(request: {
|
|
330
|
+
action: QuickActionKind;
|
|
331
|
+
screenshotBase64: string;
|
|
332
|
+
mimeType?: string;
|
|
333
|
+
screenName?: string;
|
|
334
|
+
language?: string;
|
|
335
|
+
}): Promise<VoiceBugExtractResponse>;
|
|
321
336
|
}
|
|
322
337
|
/**
|
|
323
338
|
* Result from `askKnowledgeBase`.
|
|
@@ -481,6 +496,16 @@ interface TesterSessionResponse {
|
|
|
481
496
|
tester_id?: string;
|
|
482
497
|
started_at?: string;
|
|
483
498
|
ended_at?: string | null;
|
|
499
|
+
/** Set when the API knows a newer SDK release than the one reported. */
|
|
500
|
+
sdkUpdate?: SdkUpdateInfo;
|
|
501
|
+
}
|
|
502
|
+
/** A newer TesterPayKit SDK is out (from the session-start response). */
|
|
503
|
+
interface SdkUpdateInfo {
|
|
504
|
+
package: string;
|
|
505
|
+
current: string;
|
|
506
|
+
latest: string;
|
|
507
|
+
/** Command to run in the app's folder. */
|
|
508
|
+
command: string;
|
|
484
509
|
}
|
|
485
510
|
type TesterSessionEndReason = 'completed' | 'lifecycle_flush' | 'timeout' | 'abandoned';
|
|
486
511
|
interface EndTesterSessionInput {
|
|
@@ -661,7 +686,14 @@ interface RetestItem {
|
|
|
661
686
|
createdAt: string;
|
|
662
687
|
projectId: string;
|
|
663
688
|
screenshotPath?: string | null;
|
|
689
|
+
/**
|
|
690
|
+
* Steps that prove the fix; the last one states the expected behaviour.
|
|
691
|
+
* Judge each and pass the verdicts to verifyRetest / reopenRetest.
|
|
692
|
+
*/
|
|
693
|
+
acceptanceSteps?: string[];
|
|
664
694
|
}
|
|
695
|
+
/** Verdict per acceptance step (1-based step number → passed). */
|
|
696
|
+
type RetestStepVerdicts = Record<number, boolean>;
|
|
665
697
|
/** A task preset from GET /v1/tasks */
|
|
666
698
|
interface TaskPreset {
|
|
667
699
|
id: string;
|
|
@@ -687,4 +719,4 @@ interface TaskStep {
|
|
|
687
719
|
}
|
|
688
720
|
|
|
689
721
|
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 };
|
|
722
|
+
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
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { TokenManager, IApiClient, LoginRequest, LoginResponse, WeeklySummary, RemoteAiSession, VoiceBugExtractResponse } from '@testerpaykit/core';
|
|
1
|
+
import { TokenManager, IApiClient, LoginRequest, LoginResponse, WeeklySummary, RemoteAiSession, VoiceBugExtractResponse, QuickActionKind } from '@testerpaykit/core';
|
|
2
2
|
|
|
3
3
|
interface ApiClientConfig {
|
|
4
4
|
baseURL?: string;
|
|
@@ -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
|
|
@@ -318,6 +319,20 @@ declare class TesterPayKitApiClient implements IApiClient {
|
|
|
318
319
|
projectId?: string;
|
|
319
320
|
preClassification?: string;
|
|
320
321
|
}): Promise<VoiceBugExtractResponse>;
|
|
322
|
+
/**
|
|
323
|
+
* POST /v1/testers/me/bug-reports/quick-draft
|
|
324
|
+
*
|
|
325
|
+
* One-tap report draft written by the server from a screenshot of the
|
|
326
|
+
* current screen. Same shape as voiceExtractBugFields with an empty
|
|
327
|
+
* transcript; preClassification is the type the action files under.
|
|
328
|
+
*/
|
|
329
|
+
quickDraftBug(request: {
|
|
330
|
+
action: QuickActionKind;
|
|
331
|
+
screenshotBase64: string;
|
|
332
|
+
mimeType?: string;
|
|
333
|
+
screenName?: string;
|
|
334
|
+
language?: string;
|
|
335
|
+
}): Promise<VoiceBugExtractResponse>;
|
|
321
336
|
}
|
|
322
337
|
/**
|
|
323
338
|
* Result from `askKnowledgeBase`.
|
|
@@ -481,6 +496,16 @@ interface TesterSessionResponse {
|
|
|
481
496
|
tester_id?: string;
|
|
482
497
|
started_at?: string;
|
|
483
498
|
ended_at?: string | null;
|
|
499
|
+
/** Set when the API knows a newer SDK release than the one reported. */
|
|
500
|
+
sdkUpdate?: SdkUpdateInfo;
|
|
501
|
+
}
|
|
502
|
+
/** A newer TesterPayKit SDK is out (from the session-start response). */
|
|
503
|
+
interface SdkUpdateInfo {
|
|
504
|
+
package: string;
|
|
505
|
+
current: string;
|
|
506
|
+
latest: string;
|
|
507
|
+
/** Command to run in the app's folder. */
|
|
508
|
+
command: string;
|
|
484
509
|
}
|
|
485
510
|
type TesterSessionEndReason = 'completed' | 'lifecycle_flush' | 'timeout' | 'abandoned';
|
|
486
511
|
interface EndTesterSessionInput {
|
|
@@ -661,7 +686,14 @@ interface RetestItem {
|
|
|
661
686
|
createdAt: string;
|
|
662
687
|
projectId: string;
|
|
663
688
|
screenshotPath?: string | null;
|
|
689
|
+
/**
|
|
690
|
+
* Steps that prove the fix; the last one states the expected behaviour.
|
|
691
|
+
* Judge each and pass the verdicts to verifyRetest / reopenRetest.
|
|
692
|
+
*/
|
|
693
|
+
acceptanceSteps?: string[];
|
|
664
694
|
}
|
|
695
|
+
/** Verdict per acceptance step (1-based step number → passed). */
|
|
696
|
+
type RetestStepVerdicts = Record<number, boolean>;
|
|
665
697
|
/** A task preset from GET /v1/tasks */
|
|
666
698
|
interface TaskPreset {
|
|
667
699
|
id: string;
|
|
@@ -687,4 +719,4 @@ interface TaskStep {
|
|
|
687
719
|
}
|
|
688
720
|
|
|
689
721
|
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 };
|
|
722
|
+
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
|
|
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
|
/**
|
|
@@ -584,7 +591,37 @@ var TesterPayKitApiClient = class {
|
|
|
584
591
|
);
|
|
585
592
|
return response.data;
|
|
586
593
|
}
|
|
594
|
+
/**
|
|
595
|
+
* POST /v1/testers/me/bug-reports/quick-draft
|
|
596
|
+
*
|
|
597
|
+
* One-tap report draft written by the server from a screenshot of the
|
|
598
|
+
* current screen. Same shape as voiceExtractBugFields with an empty
|
|
599
|
+
* transcript; preClassification is the type the action files under.
|
|
600
|
+
*/
|
|
601
|
+
async quickDraftBug(request) {
|
|
602
|
+
const response = await this.client.post(
|
|
603
|
+
"/v1/testers/me/bug-reports/quick-draft",
|
|
604
|
+
{
|
|
605
|
+
action: request.action,
|
|
606
|
+
screenshot_base64: request.screenshotBase64,
|
|
607
|
+
...request.mimeType ? { mime_type: request.mimeType } : {},
|
|
608
|
+
...request.screenName ? { screen_name: request.screenName } : {},
|
|
609
|
+
...request.language ? { language: request.language } : {}
|
|
610
|
+
},
|
|
611
|
+
{ timeout: 6e4 }
|
|
612
|
+
);
|
|
613
|
+
const { classification, ...draft } = response.data;
|
|
614
|
+
return {
|
|
615
|
+
...draft,
|
|
616
|
+
transcript: "",
|
|
617
|
+
preClassification: classification,
|
|
618
|
+
sourceLanguage: request.language
|
|
619
|
+
};
|
|
620
|
+
}
|
|
587
621
|
};
|
|
622
|
+
function stepResults(verdicts) {
|
|
623
|
+
return Object.entries(verdicts).map(([step, passed]) => ({ step: Number(step), passed }));
|
|
624
|
+
}
|
|
588
625
|
function formatTimestamp(timestamp) {
|
|
589
626
|
return timestamp instanceof Date ? timestamp.toISOString() : timestamp;
|
|
590
627
|
}
|
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
|
|
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
|
/**
|
|
@@ -550,7 +557,37 @@ var TesterPayKitApiClient = class {
|
|
|
550
557
|
);
|
|
551
558
|
return response.data;
|
|
552
559
|
}
|
|
560
|
+
/**
|
|
561
|
+
* POST /v1/testers/me/bug-reports/quick-draft
|
|
562
|
+
*
|
|
563
|
+
* One-tap report draft written by the server from a screenshot of the
|
|
564
|
+
* current screen. Same shape as voiceExtractBugFields with an empty
|
|
565
|
+
* transcript; preClassification is the type the action files under.
|
|
566
|
+
*/
|
|
567
|
+
async quickDraftBug(request) {
|
|
568
|
+
const response = await this.client.post(
|
|
569
|
+
"/v1/testers/me/bug-reports/quick-draft",
|
|
570
|
+
{
|
|
571
|
+
action: request.action,
|
|
572
|
+
screenshot_base64: request.screenshotBase64,
|
|
573
|
+
...request.mimeType ? { mime_type: request.mimeType } : {},
|
|
574
|
+
...request.screenName ? { screen_name: request.screenName } : {},
|
|
575
|
+
...request.language ? { language: request.language } : {}
|
|
576
|
+
},
|
|
577
|
+
{ timeout: 6e4 }
|
|
578
|
+
);
|
|
579
|
+
const { classification, ...draft } = response.data;
|
|
580
|
+
return {
|
|
581
|
+
...draft,
|
|
582
|
+
transcript: "",
|
|
583
|
+
preClassification: classification,
|
|
584
|
+
sourceLanguage: request.language
|
|
585
|
+
};
|
|
586
|
+
}
|
|
553
587
|
};
|
|
588
|
+
function stepResults(verdicts) {
|
|
589
|
+
return Object.entries(verdicts).map(([step, passed]) => ({ step: Number(step), passed }));
|
|
590
|
+
}
|
|
554
591
|
function formatTimestamp(timestamp) {
|
|
555
592
|
return timestamp instanceof Date ? timestamp.toISOString() : timestamp;
|
|
556
593
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@testerpaykit/api-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.5.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.
|
|
17
|
+
"@testerpaykit/core": "1.3.0"
|
|
18
18
|
},
|
|
19
19
|
"devDependencies": {
|
|
20
20
|
"@types/node": "^26.6.5",
|
|
@@ -6,6 +6,7 @@ import {
|
|
|
6
6
|
WeeklySummary,
|
|
7
7
|
TokenManager,
|
|
8
8
|
VoiceBugExtractResponse,
|
|
9
|
+
QuickActionKind,
|
|
9
10
|
RemoteAiSession,
|
|
10
11
|
} from '@testerpaykit/core';
|
|
11
12
|
|
|
@@ -353,8 +354,12 @@ export class TesterPayKitApiClient implements IApiClient {
|
|
|
353
354
|
};
|
|
354
355
|
const response = await this.client.post<{
|
|
355
356
|
session: TesterSessionResponse;
|
|
357
|
+
sdk_update?: SdkUpdateInfo;
|
|
356
358
|
}>('/v1/testers/sessions', body);
|
|
357
|
-
return
|
|
359
|
+
return {
|
|
360
|
+
...response.data.session,
|
|
361
|
+
...(response.data.sdk_update && { sdkUpdate: response.data.sdk_update }),
|
|
362
|
+
};
|
|
358
363
|
}
|
|
359
364
|
|
|
360
365
|
/** End a server-side tester session with optional counters. */
|
|
@@ -661,28 +666,36 @@ export class TesterPayKitApiClient implements IApiClient {
|
|
|
661
666
|
* List bug reports assigned to this tester for re-verification.
|
|
662
667
|
*/
|
|
663
668
|
async getMyRetests(params?: { status?: string }): Promise<RetestItem[]> {
|
|
664
|
-
const response = await this.client.get<RetestItem[]>(
|
|
669
|
+
const response = await this.client.get<{ retests: RetestItem[] }>(
|
|
665
670
|
'/v1/testers/me/retests',
|
|
666
671
|
{ params },
|
|
667
672
|
);
|
|
668
|
-
return response.data;
|
|
673
|
+
return response.data.retests;
|
|
669
674
|
}
|
|
670
675
|
|
|
671
676
|
/**
|
|
672
677
|
* POST /v1/testers/me/retests/{bugId}/verify
|
|
673
|
-
* Mark a retest as verified (bug is fixed).
|
|
678
|
+
* Mark a retest as verified (bug is fixed). With stepVerdicts the API
|
|
679
|
+
* only verifies when every acceptance step passed.
|
|
674
680
|
*/
|
|
675
|
-
async verifyRetest(bugId: string): Promise<void> {
|
|
676
|
-
await this.client.post(`/v1/testers/me/retests/${bugId}/verify
|
|
681
|
+
async verifyRetest(bugId: string, stepVerdicts?: RetestStepVerdicts): Promise<void> {
|
|
682
|
+
await this.client.post(`/v1/testers/me/retests/${bugId}/verify`, {
|
|
683
|
+
...(stepVerdicts ? { step_results: stepResults(stepVerdicts) } : {}),
|
|
684
|
+
});
|
|
677
685
|
}
|
|
678
686
|
|
|
679
687
|
/**
|
|
680
688
|
* POST /v1/testers/me/retests/{bugId}/reopen
|
|
681
689
|
* Reopen a retest (bug is still present), optionally with a reason.
|
|
682
690
|
*/
|
|
683
|
-
async reopenRetest(
|
|
691
|
+
async reopenRetest(
|
|
692
|
+
bugId: string,
|
|
693
|
+
reason?: string,
|
|
694
|
+
stepVerdicts?: RetestStepVerdicts,
|
|
695
|
+
): Promise<void> {
|
|
684
696
|
await this.client.post(`/v1/testers/me/retests/${bugId}/reopen`, {
|
|
685
697
|
...(reason ? { reason } : {}),
|
|
698
|
+
...(stepVerdicts ? { step_results: stepResults(stepVerdicts) } : {}),
|
|
686
699
|
});
|
|
687
700
|
}
|
|
688
701
|
|
|
@@ -719,6 +732,42 @@ export class TesterPayKitApiClient implements IApiClient {
|
|
|
719
732
|
);
|
|
720
733
|
return response.data;
|
|
721
734
|
}
|
|
735
|
+
|
|
736
|
+
/**
|
|
737
|
+
* POST /v1/testers/me/bug-reports/quick-draft
|
|
738
|
+
*
|
|
739
|
+
* One-tap report draft written by the server from a screenshot of the
|
|
740
|
+
* current screen. Same shape as voiceExtractBugFields with an empty
|
|
741
|
+
* transcript; preClassification is the type the action files under.
|
|
742
|
+
*/
|
|
743
|
+
async quickDraftBug(request: {
|
|
744
|
+
action: QuickActionKind;
|
|
745
|
+
screenshotBase64: string;
|
|
746
|
+
mimeType?: string;
|
|
747
|
+
screenName?: string;
|
|
748
|
+
language?: string;
|
|
749
|
+
}): Promise<VoiceBugExtractResponse> {
|
|
750
|
+
const response = await this.client.post<
|
|
751
|
+
Omit<VoiceBugExtractResponse, 'transcript'> & { classification?: string }
|
|
752
|
+
>(
|
|
753
|
+
'/v1/testers/me/bug-reports/quick-draft',
|
|
754
|
+
{
|
|
755
|
+
action: request.action,
|
|
756
|
+
screenshot_base64: request.screenshotBase64,
|
|
757
|
+
...(request.mimeType ? { mime_type: request.mimeType } : {}),
|
|
758
|
+
...(request.screenName ? { screen_name: request.screenName } : {}),
|
|
759
|
+
...(request.language ? { language: request.language } : {}),
|
|
760
|
+
},
|
|
761
|
+
{ timeout: 60000 },
|
|
762
|
+
);
|
|
763
|
+
const { classification, ...draft } = response.data;
|
|
764
|
+
return {
|
|
765
|
+
...draft,
|
|
766
|
+
transcript: '',
|
|
767
|
+
preClassification: classification,
|
|
768
|
+
sourceLanguage: request.language,
|
|
769
|
+
};
|
|
770
|
+
}
|
|
722
771
|
}
|
|
723
772
|
|
|
724
773
|
/**
|
|
@@ -921,6 +970,17 @@ export interface TesterSessionResponse {
|
|
|
921
970
|
tester_id?: string;
|
|
922
971
|
started_at?: string;
|
|
923
972
|
ended_at?: string | null;
|
|
973
|
+
/** Set when the API knows a newer SDK release than the one reported. */
|
|
974
|
+
sdkUpdate?: SdkUpdateInfo;
|
|
975
|
+
}
|
|
976
|
+
|
|
977
|
+
/** A newer TesterPayKit SDK is out (from the session-start response). */
|
|
978
|
+
export interface SdkUpdateInfo {
|
|
979
|
+
package: string;
|
|
980
|
+
current: string;
|
|
981
|
+
latest: string;
|
|
982
|
+
/** Command to run in the app's folder. */
|
|
983
|
+
command: string;
|
|
924
984
|
}
|
|
925
985
|
|
|
926
986
|
export type TesterSessionEndReason =
|
|
@@ -1109,6 +1169,10 @@ export interface FeedbackResponse {
|
|
|
1109
1169
|
message?: string;
|
|
1110
1170
|
}
|
|
1111
1171
|
|
|
1172
|
+
function stepResults(verdicts: RetestStepVerdicts): { step: number; passed: boolean }[] {
|
|
1173
|
+
return Object.entries(verdicts).map(([step, passed]) => ({ step: Number(step), passed }));
|
|
1174
|
+
}
|
|
1175
|
+
|
|
1112
1176
|
/** A single retest item from GET /v1/testers/me/retests */
|
|
1113
1177
|
export interface RetestItem {
|
|
1114
1178
|
id: string;
|
|
@@ -1125,8 +1189,16 @@ export interface RetestItem {
|
|
|
1125
1189
|
createdAt: string;
|
|
1126
1190
|
projectId: string;
|
|
1127
1191
|
screenshotPath?: string | null;
|
|
1192
|
+
/**
|
|
1193
|
+
* Steps that prove the fix; the last one states the expected behaviour.
|
|
1194
|
+
* Judge each and pass the verdicts to verifyRetest / reopenRetest.
|
|
1195
|
+
*/
|
|
1196
|
+
acceptanceSteps?: string[];
|
|
1128
1197
|
}
|
|
1129
1198
|
|
|
1199
|
+
/** Verdict per acceptance step (1-based step number → passed). */
|
|
1200
|
+
export type RetestStepVerdicts = Record<number, boolean>;
|
|
1201
|
+
|
|
1130
1202
|
/** A task preset from GET /v1/tasks */
|
|
1131
1203
|
export interface TaskPreset {
|
|
1132
1204
|
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');
|