@testerpaykit/api-client 1.4.0 → 1.6.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
@@ -1,5 +1,14 @@
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
+ /** Body of a "Send to Claude" note (see `sendLiveNote`). */
4
+ interface LiveNoteInput {
5
+ projectId: string;
6
+ text: string;
7
+ /** Screen snapshot without the screenshot (that goes separately). */
8
+ snapshot: Record<string, unknown>;
9
+ /** Base64 PNG/JPEG, no data-URI prefix. */
10
+ screenshotBase64?: string | null;
11
+ }
3
12
  interface ApiClientConfig {
4
13
  baseURL?: string;
5
14
  apiKey: string;
@@ -145,6 +154,17 @@ declare class TesterPayKitApiClient implements IApiClient {
145
154
  * POST /v1/testers/me/ai-sessions/claim — 204 → null.
146
155
  */
147
156
  claimRemoteAiSession(projectId: string): Promise<RemoteAiSession | null>;
157
+ /**
158
+ * Open a live link to the developer's Claude Code session: returns a
159
+ * one-time WebSocket URL (valid two minutes). Fetch a fresh one for
160
+ * every (re)connect. POST /v1/testers/me/live.
161
+ */
162
+ openLiveLink(projectId: string): Promise<string>;
163
+ /**
164
+ * "Send to Claude": one line plus what the screen showed. Works
165
+ * without an open live link. POST /v1/testers/me/live/notes → note id.
166
+ */
167
+ sendLiveNote(input: LiveNoteInput): Promise<string>;
148
168
  /**
149
169
  * Attach a file (screenshot, log, voice note) to an already-
150
170
  * submitted bug report. Hits POST /v1/testers/me/bug-reports/
@@ -319,6 +339,20 @@ declare class TesterPayKitApiClient implements IApiClient {
319
339
  projectId?: string;
320
340
  preClassification?: string;
321
341
  }): Promise<VoiceBugExtractResponse>;
342
+ /**
343
+ * POST /v1/testers/me/bug-reports/quick-draft
344
+ *
345
+ * One-tap report draft written by the server from a screenshot of the
346
+ * current screen. Same shape as voiceExtractBugFields with an empty
347
+ * transcript; preClassification is the type the action files under.
348
+ */
349
+ quickDraftBug(request: {
350
+ action: QuickActionKind;
351
+ screenshotBase64: string;
352
+ mimeType?: string;
353
+ screenName?: string;
354
+ language?: string;
355
+ }): Promise<VoiceBugExtractResponse>;
322
356
  }
323
357
  /**
324
358
  * Result from `askKnowledgeBase`.
@@ -705,4 +739,4 @@ interface TaskStep {
705
739
  }
706
740
 
707
741
  export { TesterPayKitApiClient };
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 };
742
+ export type { AnonymousLoginResponse, ApiClientConfig, BugCategory, BugReportAttachmentInput, BugReportAttachmentResponse, BugReportPayload, BugReportResponse, BugReportType, BugSeverity, EarningsSummary, EndTesterSessionInput, EnrollmentResponse, FeedbackResponse, KnowledgeBaseAnswer, KnowledgeBaseCitation, KnowledgeFile, KnowledgeFileSummary, LiveNoteInput, 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,5 +1,14 @@
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
+ /** Body of a "Send to Claude" note (see `sendLiveNote`). */
4
+ interface LiveNoteInput {
5
+ projectId: string;
6
+ text: string;
7
+ /** Screen snapshot without the screenshot (that goes separately). */
8
+ snapshot: Record<string, unknown>;
9
+ /** Base64 PNG/JPEG, no data-URI prefix. */
10
+ screenshotBase64?: string | null;
11
+ }
3
12
  interface ApiClientConfig {
4
13
  baseURL?: string;
5
14
  apiKey: string;
@@ -145,6 +154,17 @@ declare class TesterPayKitApiClient implements IApiClient {
145
154
  * POST /v1/testers/me/ai-sessions/claim — 204 → null.
146
155
  */
147
156
  claimRemoteAiSession(projectId: string): Promise<RemoteAiSession | null>;
157
+ /**
158
+ * Open a live link to the developer's Claude Code session: returns a
159
+ * one-time WebSocket URL (valid two minutes). Fetch a fresh one for
160
+ * every (re)connect. POST /v1/testers/me/live.
161
+ */
162
+ openLiveLink(projectId: string): Promise<string>;
163
+ /**
164
+ * "Send to Claude": one line plus what the screen showed. Works
165
+ * without an open live link. POST /v1/testers/me/live/notes → note id.
166
+ */
167
+ sendLiveNote(input: LiveNoteInput): Promise<string>;
148
168
  /**
149
169
  * Attach a file (screenshot, log, voice note) to an already-
150
170
  * submitted bug report. Hits POST /v1/testers/me/bug-reports/
@@ -319,6 +339,20 @@ declare class TesterPayKitApiClient implements IApiClient {
319
339
  projectId?: string;
320
340
  preClassification?: string;
321
341
  }): Promise<VoiceBugExtractResponse>;
342
+ /**
343
+ * POST /v1/testers/me/bug-reports/quick-draft
344
+ *
345
+ * One-tap report draft written by the server from a screenshot of the
346
+ * current screen. Same shape as voiceExtractBugFields with an empty
347
+ * transcript; preClassification is the type the action files under.
348
+ */
349
+ quickDraftBug(request: {
350
+ action: QuickActionKind;
351
+ screenshotBase64: string;
352
+ mimeType?: string;
353
+ screenName?: string;
354
+ language?: string;
355
+ }): Promise<VoiceBugExtractResponse>;
322
356
  }
323
357
  /**
324
358
  * Result from `askKnowledgeBase`.
@@ -705,4 +739,4 @@ interface TaskStep {
705
739
  }
706
740
 
707
741
  export { TesterPayKitApiClient };
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 };
742
+ export type { AnonymousLoginResponse, ApiClientConfig, BugCategory, BugReportAttachmentInput, BugReportAttachmentResponse, BugReportPayload, BugReportResponse, BugReportType, BugSeverity, EarningsSummary, EndTesterSessionInput, EnrollmentResponse, FeedbackResponse, KnowledgeBaseAnswer, KnowledgeBaseCitation, KnowledgeFile, KnowledgeFileSummary, LiveNoteInput, 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
@@ -258,6 +258,36 @@ var TesterPayKitApiClient = class {
258
258
  if (response.status === 204 || !response.data?.sessionId) return null;
259
259
  return response.data;
260
260
  }
261
+ /**
262
+ * Open a live link to the developer's Claude Code session: returns a
263
+ * one-time WebSocket URL (valid two minutes). Fetch a fresh one for
264
+ * every (re)connect. POST /v1/testers/me/live.
265
+ */
266
+ async openLiveLink(projectId) {
267
+ const response = await this.client.post(
268
+ "/v1/testers/me/live",
269
+ { project_id: projectId }
270
+ );
271
+ const wsUrl = response.data?.wsUrl;
272
+ if (!wsUrl) throw new Error("Live link: response carried no wsUrl");
273
+ return wsUrl;
274
+ }
275
+ /**
276
+ * "Send to Claude": one line plus what the screen showed. Works
277
+ * without an open live link. POST /v1/testers/me/live/notes → note id.
278
+ */
279
+ async sendLiveNote(input) {
280
+ const response = await this.client.post(
281
+ "/v1/testers/me/live/notes",
282
+ {
283
+ project_id: input.projectId,
284
+ text: input.text,
285
+ snapshot: input.snapshot,
286
+ ...input.screenshotBase64 ? { screenshot: input.screenshotBase64 } : {}
287
+ }
288
+ );
289
+ return response.data?.id;
290
+ }
261
291
  /**
262
292
  * Attach a file (screenshot, log, voice note) to an already-
263
293
  * submitted bug report. Hits POST /v1/testers/me/bug-reports/
@@ -591,6 +621,33 @@ var TesterPayKitApiClient = class {
591
621
  );
592
622
  return response.data;
593
623
  }
624
+ /**
625
+ * POST /v1/testers/me/bug-reports/quick-draft
626
+ *
627
+ * One-tap report draft written by the server from a screenshot of the
628
+ * current screen. Same shape as voiceExtractBugFields with an empty
629
+ * transcript; preClassification is the type the action files under.
630
+ */
631
+ async quickDraftBug(request) {
632
+ const response = await this.client.post(
633
+ "/v1/testers/me/bug-reports/quick-draft",
634
+ {
635
+ action: request.action,
636
+ screenshot_base64: request.screenshotBase64,
637
+ ...request.mimeType ? { mime_type: request.mimeType } : {},
638
+ ...request.screenName ? { screen_name: request.screenName } : {},
639
+ ...request.language ? { language: request.language } : {}
640
+ },
641
+ { timeout: 6e4 }
642
+ );
643
+ const { classification, ...draft } = response.data;
644
+ return {
645
+ ...draft,
646
+ transcript: "",
647
+ preClassification: classification,
648
+ sourceLanguage: request.language
649
+ };
650
+ }
594
651
  };
595
652
  function stepResults(verdicts) {
596
653
  return Object.entries(verdicts).map(([step, passed]) => ({ step: Number(step), passed }));
package/dist/index.mjs CHANGED
@@ -224,6 +224,36 @@ var TesterPayKitApiClient = class {
224
224
  if (response.status === 204 || !response.data?.sessionId) return null;
225
225
  return response.data;
226
226
  }
227
+ /**
228
+ * Open a live link to the developer's Claude Code session: returns a
229
+ * one-time WebSocket URL (valid two minutes). Fetch a fresh one for
230
+ * every (re)connect. POST /v1/testers/me/live.
231
+ */
232
+ async openLiveLink(projectId) {
233
+ const response = await this.client.post(
234
+ "/v1/testers/me/live",
235
+ { project_id: projectId }
236
+ );
237
+ const wsUrl = response.data?.wsUrl;
238
+ if (!wsUrl) throw new Error("Live link: response carried no wsUrl");
239
+ return wsUrl;
240
+ }
241
+ /**
242
+ * "Send to Claude": one line plus what the screen showed. Works
243
+ * without an open live link. POST /v1/testers/me/live/notes → note id.
244
+ */
245
+ async sendLiveNote(input) {
246
+ const response = await this.client.post(
247
+ "/v1/testers/me/live/notes",
248
+ {
249
+ project_id: input.projectId,
250
+ text: input.text,
251
+ snapshot: input.snapshot,
252
+ ...input.screenshotBase64 ? { screenshot: input.screenshotBase64 } : {}
253
+ }
254
+ );
255
+ return response.data?.id;
256
+ }
227
257
  /**
228
258
  * Attach a file (screenshot, log, voice note) to an already-
229
259
  * submitted bug report. Hits POST /v1/testers/me/bug-reports/
@@ -557,6 +587,33 @@ var TesterPayKitApiClient = class {
557
587
  );
558
588
  return response.data;
559
589
  }
590
+ /**
591
+ * POST /v1/testers/me/bug-reports/quick-draft
592
+ *
593
+ * One-tap report draft written by the server from a screenshot of the
594
+ * current screen. Same shape as voiceExtractBugFields with an empty
595
+ * transcript; preClassification is the type the action files under.
596
+ */
597
+ async quickDraftBug(request) {
598
+ const response = await this.client.post(
599
+ "/v1/testers/me/bug-reports/quick-draft",
600
+ {
601
+ action: request.action,
602
+ screenshot_base64: request.screenshotBase64,
603
+ ...request.mimeType ? { mime_type: request.mimeType } : {},
604
+ ...request.screenName ? { screen_name: request.screenName } : {},
605
+ ...request.language ? { language: request.language } : {}
606
+ },
607
+ { timeout: 6e4 }
608
+ );
609
+ const { classification, ...draft } = response.data;
610
+ return {
611
+ ...draft,
612
+ transcript: "",
613
+ preClassification: classification,
614
+ sourceLanguage: request.language
615
+ };
616
+ }
560
617
  };
561
618
  function stepResults(verdicts) {
562
619
  return Object.entries(verdicts).map(([step, passed]) => ({ step: Number(step), passed }));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@testerpaykit/api-client",
3
- "version": "1.4.0",
3
+ "version": "1.6.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.2.0"
17
+ "@testerpaykit/core": "1.3.0"
18
18
  },
19
19
  "devDependencies": {
20
20
  "@types/node": "^26.6.5",
@@ -6,9 +6,20 @@ import {
6
6
  WeeklySummary,
7
7
  TokenManager,
8
8
  VoiceBugExtractResponse,
9
+ QuickActionKind,
9
10
  RemoteAiSession,
10
11
  } from '@testerpaykit/core';
11
12
 
13
+ /** Body of a "Send to Claude" note (see `sendLiveNote`). */
14
+ export interface LiveNoteInput {
15
+ projectId: string;
16
+ text: string;
17
+ /** Screen snapshot without the screenshot (that goes separately). */
18
+ snapshot: Record<string, unknown>;
19
+ /** Base64 PNG/JPEG, no data-URI prefix. */
20
+ screenshotBase64?: string | null;
21
+ }
22
+
12
23
  export interface ApiClientConfig {
13
24
  baseURL?: string;
14
25
  apiKey: string;
@@ -319,6 +330,38 @@ export class TesterPayKitApiClient implements IApiClient {
319
330
  return response.data;
320
331
  }
321
332
 
333
+ /**
334
+ * Open a live link to the developer's Claude Code session: returns a
335
+ * one-time WebSocket URL (valid two minutes). Fetch a fresh one for
336
+ * every (re)connect. POST /v1/testers/me/live.
337
+ */
338
+ async openLiveLink(projectId: string): Promise<string> {
339
+ const response = await this.client.post<{ wsUrl: string }>(
340
+ '/v1/testers/me/live',
341
+ { project_id: projectId },
342
+ );
343
+ const wsUrl = response.data?.wsUrl;
344
+ if (!wsUrl) throw new Error('Live link: response carried no wsUrl');
345
+ return wsUrl;
346
+ }
347
+
348
+ /**
349
+ * "Send to Claude": one line plus what the screen showed. Works
350
+ * without an open live link. POST /v1/testers/me/live/notes → note id.
351
+ */
352
+ async sendLiveNote(input: LiveNoteInput): Promise<string> {
353
+ const response = await this.client.post<{ id: string }>(
354
+ '/v1/testers/me/live/notes',
355
+ {
356
+ project_id: input.projectId,
357
+ text: input.text,
358
+ snapshot: input.snapshot,
359
+ ...(input.screenshotBase64 ? { screenshot: input.screenshotBase64 } : {}),
360
+ },
361
+ );
362
+ return response.data?.id;
363
+ }
364
+
322
365
  /**
323
366
  * Attach a file (screenshot, log, voice note) to an already-
324
367
  * submitted bug report. Hits POST /v1/testers/me/bug-reports/
@@ -731,6 +774,42 @@ export class TesterPayKitApiClient implements IApiClient {
731
774
  );
732
775
  return response.data;
733
776
  }
777
+
778
+ /**
779
+ * POST /v1/testers/me/bug-reports/quick-draft
780
+ *
781
+ * One-tap report draft written by the server from a screenshot of the
782
+ * current screen. Same shape as voiceExtractBugFields with an empty
783
+ * transcript; preClassification is the type the action files under.
784
+ */
785
+ async quickDraftBug(request: {
786
+ action: QuickActionKind;
787
+ screenshotBase64: string;
788
+ mimeType?: string;
789
+ screenName?: string;
790
+ language?: string;
791
+ }): Promise<VoiceBugExtractResponse> {
792
+ const response = await this.client.post<
793
+ Omit<VoiceBugExtractResponse, 'transcript'> & { classification?: string }
794
+ >(
795
+ '/v1/testers/me/bug-reports/quick-draft',
796
+ {
797
+ action: request.action,
798
+ screenshot_base64: request.screenshotBase64,
799
+ ...(request.mimeType ? { mime_type: request.mimeType } : {}),
800
+ ...(request.screenName ? { screen_name: request.screenName } : {}),
801
+ ...(request.language ? { language: request.language } : {}),
802
+ },
803
+ { timeout: 60000 },
804
+ );
805
+ const { classification, ...draft } = response.data;
806
+ return {
807
+ ...draft,
808
+ transcript: '',
809
+ preClassification: classification,
810
+ sourceLanguage: request.language,
811
+ };
812
+ }
734
813
  }
735
814
 
736
815
  /**
@@ -182,6 +182,33 @@ describe('TesterPayKitApiClient', () => {
182
182
  });
183
183
  });
184
184
 
185
+ describe('live link', () => {
186
+ it('opens a live link and returns the one-time wsUrl', async () => {
187
+ mockAxiosInstance.post.mockResolvedValue({ data: { wsUrl: 'ws://x/v1/live/ws?t=1' } });
188
+ await expect(client.openLiveLink('p-1')).resolves.toBe('ws://x/v1/live/ws?t=1');
189
+ expect(mockAxiosInstance.post).toHaveBeenCalledWith('/v1/testers/me/live', { project_id: 'p-1' });
190
+ });
191
+
192
+ it('rejects when the server sends no wsUrl', async () => {
193
+ mockAxiosInstance.post.mockResolvedValue({ data: {} });
194
+ await expect(client.openLiveLink('p-1')).rejects.toThrow(/wsUrl/);
195
+ });
196
+
197
+ it('sends a note with snapshot and optional screenshot', async () => {
198
+ mockAxiosInstance.post.mockResolvedValue({ data: { id: 'n-1' } });
199
+ await expect(
200
+ client.sendLiveNote({ projectId: 'p-1', text: 'hi', snapshot: { screen: 'Home' }, screenshotBase64: 'AAA' }),
201
+ ).resolves.toBe('n-1');
202
+ expect(mockAxiosInstance.post).toHaveBeenCalledWith('/v1/testers/me/live/notes', {
203
+ project_id: 'p-1', text: 'hi', snapshot: { screen: 'Home' }, screenshot: 'AAA',
204
+ });
205
+ await client.sendLiveNote({ projectId: 'p-1', text: 'x', snapshot: {} });
206
+ expect(mockAxiosInstance.post).toHaveBeenLastCalledWith('/v1/testers/me/live/notes', {
207
+ project_id: 'p-1', text: 'x', snapshot: {},
208
+ });
209
+ });
210
+ });
211
+
185
212
  describe('tester sessions', () => {
186
213
  it('should start a tester session with server contract field names', async () => {
187
214
  const response = {