@scarn/sdk 0.8.8 → 0.8.10

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.
@@ -23,27 +23,27 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
23
23
  reason: "initial" | "retry" | "continuation";
24
24
  projectId: string;
25
25
  workItemId: string;
26
- taskExecutionConfigId: string | unknown;
27
- name: string | unknown;
26
+ taskExecutionConfigId: string | null;
27
+ name: string | null;
28
28
  kind: "agent" | "code";
29
- previousTaskRunId: string | unknown;
30
- baseBranch: string | unknown;
31
- heartbeatSeconds: number | unknown;
29
+ previousTaskRunId: string | null;
30
+ baseBranch: string | null;
31
+ heartbeatSeconds: number | null;
32
32
  status: "pending" | "queued" | "running" | "succeeded" | "failed" | "timeout" | "abandoned" | "cancelled" | "skipped" | "yielded";
33
- inputJson: unknown;
34
- claimedBy: string | unknown;
35
- claimedAt: string | unknown;
36
- lastHeartbeatAt: string | unknown;
37
- leaseExpiresAt: string | unknown;
38
- executionTimeoutSeconds: number | unknown;
39
- executionDeadlineAt: string | unknown;
40
- startedAt: string | unknown;
41
- completedAt: string | unknown;
42
- resultJson: unknown;
43
- errorJson: unknown;
44
- workBranch: string | unknown;
45
- createdFromBranch: string | unknown;
46
- sessionRestored: boolean | unknown;
33
+ inputJson: unknown | null;
34
+ claimedBy: string | null;
35
+ claimedAt: string | null;
36
+ lastHeartbeatAt: string | null;
37
+ leaseExpiresAt: string | null;
38
+ executionTimeoutSeconds: number | null;
39
+ executionDeadlineAt: string | null;
40
+ startedAt: string | null;
41
+ completedAt: string | null;
42
+ resultJson: unknown | null;
43
+ errorJson: unknown | null;
44
+ workBranch: string | null;
45
+ createdFromBranch: string | null;
46
+ sessionRestored: boolean | null;
47
47
  createdAt: string;
48
48
  updatedAt: string;
49
49
  };
@@ -60,34 +60,34 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
60
60
  reason: "initial" | "retry" | "continuation";
61
61
  projectId: string;
62
62
  workItemId: string;
63
- taskExecutionConfigId: string | unknown;
64
- name: string | unknown;
63
+ taskExecutionConfigId: string | null;
64
+ name: string | null;
65
65
  kind: "agent" | "code";
66
- previousTaskRunId: string | unknown;
67
- baseBranch: string | unknown;
68
- heartbeatSeconds: number | unknown;
66
+ previousTaskRunId: string | null;
67
+ baseBranch: string | null;
68
+ heartbeatSeconds: number | null;
69
69
  status: "pending" | "queued" | "running" | "succeeded" | "failed" | "timeout" | "abandoned" | "cancelled" | "skipped" | "yielded";
70
- inputJson: unknown;
71
- claimedBy: string | unknown;
72
- claimedAt: string | unknown;
73
- lastHeartbeatAt: string | unknown;
74
- leaseExpiresAt: string | unknown;
75
- executionTimeoutSeconds: number | unknown;
76
- executionDeadlineAt: string | unknown;
77
- startedAt: string | unknown;
78
- completedAt: string | unknown;
79
- resultJson: unknown;
80
- errorJson: unknown;
81
- workBranch: string | unknown;
82
- createdFromBranch: string | unknown;
83
- sessionRestored: boolean | unknown;
70
+ inputJson: unknown | null;
71
+ claimedBy: string | null;
72
+ claimedAt: string | null;
73
+ lastHeartbeatAt: string | null;
74
+ leaseExpiresAt: string | null;
75
+ executionTimeoutSeconds: number | null;
76
+ executionDeadlineAt: string | null;
77
+ startedAt: string | null;
78
+ completedAt: string | null;
79
+ resultJson: unknown | null;
80
+ errorJson: unknown | null;
81
+ workBranch: string | null;
82
+ createdFromBranch: string | null;
83
+ sessionRestored: boolean | null;
84
84
  createdAt: string;
85
85
  updatedAt: string;
86
86
  }>;
87
87
  /** Not unwrapped: callers read `error.status` (e.g. a 402 read quota). */
88
88
  getTaskLogArchive: ({ taskRunId }: TaskRunRef) => Promise<({
89
89
  data: {
90
- url: string | unknown;
90
+ url: string | null;
91
91
  sizeBytes: number;
92
92
  };
93
93
  error: undefined;
@@ -288,9 +288,9 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
288
288
  claimToken: string;
289
289
  }) => Promise<{
290
290
  projectId: string;
291
- projectPath: string | unknown;
291
+ projectPath: string | null;
292
292
  gitUrl: string;
293
- baseWorkBranch: string | unknown;
293
+ baseWorkBranch: string | null;
294
294
  projectOpencodeConfig: {
295
295
  relativePath: string;
296
296
  present: boolean;
@@ -298,13 +298,13 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
298
298
  name: string;
299
299
  description: string;
300
300
  run: string;
301
- cwd: string | unknown;
301
+ cwd: string | null;
302
302
  }>;
303
303
  services: Array<{
304
304
  name: string;
305
305
  description: string;
306
306
  run: string;
307
- cwd: string | unknown;
307
+ cwd: string | null;
308
308
  dependsOn: Array<string>;
309
309
  expose: {
310
310
  targetPort: number;
@@ -318,84 +318,86 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
318
318
  kind: "agent" | "code";
319
319
  key: string;
320
320
  name: string;
321
- inputJson: unknown;
322
- executionTimeoutSeconds: number | unknown;
323
- prompt: string | unknown;
321
+ inputJson: unknown | null;
322
+ executionTimeoutSeconds: number | null;
323
+ prompt: string | null;
324
324
  entrypointJson: {
325
325
  sourceFile: string;
326
- } | unknown;
326
+ } | null;
327
327
  resultSchemaJson: {
328
328
  [key: string]: unknown;
329
- } | unknown;
330
- turnsRemaining: number | unknown;
329
+ } | null;
330
+ turnsRemaining: number | null;
331
331
  workItemId: string;
332
332
  grants: Array<{
333
- resource: string;
334
- action: string;
333
+ resource: "workItem";
334
+ action: "read";
335
335
  scope: "self" | "children" | "project";
336
336
  } | {
337
- resource: string;
338
- action: string;
337
+ resource: "workItem";
338
+ action: "update";
339
339
  scope: "self" | "children";
340
340
  } | {
341
- resource: string;
342
- action: string;
341
+ resource: "workItem";
342
+ action: "comment";
343
343
  scope: "self" | "children";
344
344
  } | {
345
- resource: string;
346
- action: string;
345
+ resource: "workItem";
346
+ action: "label";
347
347
  scope: "self" | "children";
348
348
  labels: Array<string>;
349
349
  } | {
350
- resource: string;
351
- action: string;
350
+ resource: "workItem";
351
+ action: "block";
352
352
  scope: "self" | "children";
353
353
  } | {
354
- resource: string;
355
- action: string;
354
+ resource: "workItem";
355
+ action: "close";
356
356
  scope: "self" | "children";
357
357
  } | {
358
- resource: string;
359
- action: string;
360
- scope: string;
358
+ resource: "workItem";
359
+ action: "create";
360
+ scope: "children";
361
361
  labels: Array<string>;
362
362
  }>;
363
363
  };
364
364
  runtime: {
365
365
  executionMode: "workspace" | "no_workspace";
366
- devcontainerConfigPath: string | unknown;
367
- managedRuntime: "bun1" | "node24" | unknown;
366
+ devcontainerConfigPath: string | null;
367
+ managedRuntime: "bun1" | "node24" | null;
368
368
  repo: {
369
- mode: string;
369
+ mode: "none";
370
370
  } | {
371
- mode: string;
371
+ mode: "readOnly";
372
+ gitCredentials: "auto" | "none";
372
373
  } | {
373
- mode: string;
374
- message: string | unknown;
374
+ mode: "readWrite";
375
+ message: string | null;
375
376
  onPushFailure: "fail" | "warn";
377
+ gitCredentials: "auto" | "none";
376
378
  };
377
379
  envJson: Array<{
378
380
  name: string;
379
- source: string;
381
+ source: "value";
380
382
  value: string;
381
383
  secret: boolean;
382
384
  applies: "agent" | "setup" | "both";
383
385
  } | {
384
386
  name: string;
385
- source: string;
387
+ source: "inherit";
386
388
  from: string;
387
389
  secret: boolean;
388
390
  optional: boolean;
389
391
  default?: string;
390
392
  mcp?: string;
391
393
  applies: "agent" | "setup" | "both";
392
- }> | unknown;
394
+ }> | null;
393
395
  healthChecksJson: Array<{
394
396
  name?: string;
395
397
  severity: "required" | "warn";
396
398
  timeoutSeconds: number;
397
399
  serialGroup?: string;
398
- kind: string;
400
+ kind: "tool";
399
401
  tool: string;
400
402
  mcp?: string;
401
403
  args?: {
@@ -406,13 +408,13 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
406
408
  severity: "required" | "warn";
407
409
  timeoutSeconds: number;
408
410
  serialGroup?: string;
409
- kind: string;
411
+ kind: "cli";
410
412
  command: Array<string>;
411
413
  expectExitCode: number;
412
- }> | unknown;
414
+ }> | null;
413
415
  opencodeMcpJson: {
414
416
  [key: string]: {
415
- type: string;
417
+ type: "local";
416
418
  command: Array<string>;
417
419
  cwd?: string;
418
420
  environment?: {
@@ -427,7 +429,7 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
427
429
  };
428
430
  protocol?: "legacy" | "auto" | "2026-07-28";
429
431
  } | {
430
- type: string;
432
+ type: "remote";
431
433
  url: string;
432
434
  headers?: {
433
435
  [key: string]: string;
@@ -439,7 +441,7 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
439
441
  callback_port?: number;
440
442
  redirect_uri?: string;
441
443
  auth_server_metadata_url?: string;
442
- } | boolean;
444
+ } | false;
443
445
  disabled?: boolean;
444
446
  codemode?: boolean;
445
447
  timeout?: {
@@ -449,7 +451,7 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
449
451
  };
450
452
  protocol?: "legacy" | "auto" | "2026-07-28";
451
453
  } | {
452
- type: string;
454
+ type: "ref";
453
455
  name?: string;
454
456
  disabled?: boolean;
455
457
  codemode?: boolean;
@@ -460,7 +462,7 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
460
462
  };
461
463
  protocol?: "legacy" | "auto" | "2026-07-28";
462
464
  };
463
- } | unknown;
465
+ } | null;
464
466
  };
465
467
  agentPrompt: {
466
468
  sessionTitle: string;
@@ -472,12 +474,12 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
472
474
  status: "pending" | "queued" | "running" | "succeeded" | "failed" | "timeout" | "abandoned" | "cancelled" | "skipped" | "yielded";
473
475
  transcriptRelativePath: string;
474
476
  findingsRelativePath: string;
475
- findingsJson: unknown;
476
- } | unknown;
477
+ findingsJson: unknown | null;
478
+ } | null;
477
479
  restoreSession: {
478
480
  downloadUrl: string;
479
481
  message: string;
480
- } | unknown;
482
+ } | null;
481
483
  }>;
482
484
  readTaskRunWorkItem: ({ taskRunId, ...body }: TaskRunRef & {
483
485
  claimToken: string;
@@ -486,37 +488,51 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
486
488
  id: string;
487
489
  title: string;
488
490
  labels: Array<string>;
489
- description: string | unknown;
491
+ description: string | null;
490
492
  descriptionVersion: number;
491
493
  fields: {
492
494
  [key: string]: unknown;
493
495
  };
494
496
  platform: "jira" | "github" | "bitbucket" | "linear" | "scarn" | "custom";
495
497
  platformKey: string;
496
- parentWorkItemId: string | unknown;
498
+ parentWorkItemId: string | null;
497
499
  state: "open" | "closed";
498
- closeReason: "completed" | "out_of_scope" | "superseded" | unknown;
499
- resolution: string | unknown;
500
+ closeReason: "completed" | "out_of_scope" | "superseded" | null;
501
+ resolution: string | null;
500
502
  blockers: Array<{
501
503
  id: string;
502
504
  title: string;
503
505
  state: "open" | "closed";
504
506
  labels: Array<string>;
505
- closeReason: "completed" | "out_of_scope" | "superseded" | unknown;
506
- resolution: string | unknown;
507
+ closeReason: "completed" | "out_of_scope" | "superseded" | null;
508
+ resolution: string | null;
507
509
  blockedBy: Array<string>;
508
- latestTaskStatus: "waiting_for_concurrency_slot" | "waiting_for_work" | "queued" | "running" | "waiting_for_person" | "succeeded" | "failed" | "cancelled" | unknown;
510
+ latestTaskStatus: "waiting_for_concurrency_slot" | "waiting_for_work" | "queued" | "running" | "waiting_for_person" | "succeeded" | "failed" | "cancelled" | null;
509
511
  }>;
510
512
  children: Array<{
511
513
  id: string;
512
514
  title: string;
513
515
  state: "open" | "closed";
514
516
  labels: Array<string>;
515
- closeReason: "completed" | "out_of_scope" | "superseded" | unknown;
516
- resolution: string | unknown;
517
+ closeReason: "completed" | "out_of_scope" | "superseded" | null;
518
+ resolution: string | null;
517
519
  blockedBy: Array<string>;
518
- latestTaskStatus: "waiting_for_concurrency_slot" | "waiting_for_work" | "queued" | "running" | "waiting_for_person" | "succeeded" | "failed" | "cancelled" | unknown;
520
+ latestTaskStatus: "waiting_for_concurrency_slot" | "waiting_for_work" | "queued" | "running" | "waiting_for_person" | "succeeded" | "failed" | "cancelled" | null;
519
521
  }>;
522
+ comments: {
523
+ items: Array<{
524
+ id: string;
525
+ parentCommentId: string | null;
526
+ body: string;
527
+ authorKind: "user" | "agent";
528
+ authorName: string;
529
+ isPinned: boolean;
530
+ createdAt: string;
531
+ updatedAt: string;
532
+ }>;
533
+ totalCount: number;
534
+ nextCursor: string | null;
535
+ };
520
536
  }>;
521
537
  completeTaskRun: ({ taskRunId, ...body }: TaskRunRef & Omit<CompletionBody, "status">) => Promise<void>;
522
538
  failTaskRun: ({ taskRunId, ...body }: TaskRunRef & Omit<CompletionBody, "status" | "workBranch" | "createdFromBranch">) => Promise<void>;
@@ -542,19 +558,112 @@ declare const buildTaskPlaneClient: (taskRuns: TaskRuns) => {
542
558
  taskRunId: string;
543
559
  projectId: string;
544
560
  relativeStorePath: string;
545
- storeRef: string | unknown;
546
- objectKey: string | unknown;
547
- sizeBytes: number | unknown;
548
- contentType: string | unknown;
561
+ storeRef: string | null;
562
+ objectKey: string | null;
563
+ sizeBytes: number | null;
564
+ contentType: string | null;
549
565
  kind: "generic" | "playwright-trace" | "video" | "image";
550
566
  createdAt: string;
551
567
  }[]>;
568
+ /** Not unwrapped: callers read `response.status` (404 = push unavailable). */
569
+ issueWorkSignalToken: ({ projectId, workerId, }: {
570
+ projectId: string;
571
+ workerId?: string | undefined;
572
+ }) => Promise<({
573
+ data: {
574
+ url: string;
575
+ token: string;
576
+ expiresAt: string;
577
+ };
578
+ error: undefined;
579
+ } | {
580
+ data: undefined;
581
+ error: {
582
+ type: string;
583
+ title: string;
584
+ status: number;
585
+ detail?: string;
586
+ instance?: string;
587
+ code?: string;
588
+ errors?: Array<{
589
+ path: string;
590
+ message: string;
591
+ summary?: string;
592
+ }>;
593
+ meta?: {
594
+ [key: string]: unknown;
595
+ };
596
+ } | {
597
+ type: string;
598
+ title: string;
599
+ status: number;
600
+ detail?: string;
601
+ instance?: string;
602
+ code?: string;
603
+ errors?: Array<{
604
+ path: string;
605
+ message: string;
606
+ summary?: string;
607
+ }>;
608
+ meta?: {
609
+ [key: string]: unknown;
610
+ };
611
+ } | {
612
+ type: string;
613
+ title: string;
614
+ status: number;
615
+ detail?: string;
616
+ instance?: string;
617
+ code?: string;
618
+ errors?: Array<{
619
+ path: string;
620
+ message: string;
621
+ summary?: string;
622
+ }>;
623
+ meta?: {
624
+ [key: string]: unknown;
625
+ };
626
+ } | {
627
+ type: string;
628
+ title: string;
629
+ status: number;
630
+ detail?: string;
631
+ instance?: string;
632
+ code?: string;
633
+ errors?: Array<{
634
+ path: string;
635
+ message: string;
636
+ summary?: string;
637
+ }>;
638
+ meta?: {
639
+ [key: string]: unknown;
640
+ };
641
+ } | {
642
+ type: string;
643
+ title: string;
644
+ status: number;
645
+ detail?: string;
646
+ instance?: string;
647
+ code?: string;
648
+ errors?: Array<{
649
+ path: string;
650
+ message: string;
651
+ summary?: string;
652
+ }>;
653
+ meta?: {
654
+ [key: string]: unknown;
655
+ };
656
+ };
657
+ }) & {
658
+ request: Request;
659
+ response: Response;
660
+ }>;
552
661
  getArtifactDownloadUrl: ({ taskRunId, artifactId, }: TaskRunRef & {
553
662
  artifactId: string;
554
663
  }) => Promise<{
555
- url: string | unknown;
664
+ url: string | null;
556
665
  sizeBytes: number;
557
- contentType: string | unknown;
666
+ contentType: string | null;
558
667
  relativeStorePath: string;
559
668
  }>;
560
669
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package.json",
3
3
  "name": "@scarn/sdk",
4
- "version": "0.8.8",
4
+ "version": "0.8.10",
5
5
  "type": "module",
6
6
  "exports": {
7
7
  ".": {