@aperture-browser/live-session 0.0.0-init.0 → 0.0.0-nightly.82.2e4f6368108f

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.
Files changed (3) hide show
  1. package/README.md +2 -0
  2. package/dist/index.d.ts +125 -27
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -7,3 +7,5 @@ The framework-agnostic client for [Aperture](https://github.com/tarik02/aperture
7
7
  - helpers that map DOM keyboard and pointer events to browser input messages, and viewport math.
8
8
 
9
9
  For a ready-made UI, see [`@aperture-browser/session-react`](https://www.npmjs.com/package/@aperture-browser/session-react). Requires `effect` 4.
10
+
11
+ Documentation: https://aperture-browser-docs.pages.dev/docs/packages/live-session
package/dist/index.d.ts CHANGED
@@ -188,21 +188,39 @@ declare const Snapshot: Schema.Struct<{
188
188
  readonly leaseMode: Schema.optionalKey<Schema.Literals<readonly ["implicit", "explicit"]>>;
189
189
  readonly recovering: Schema.optionalKey<Schema.Boolean>;
190
190
  }>>, never>;
191
- readonly recordings: Schema.withDecodingDefaultKey<Schema.$Array<Schema.Struct<{
191
+ readonly recordings: Schema.withDecodingDefaultKey<Schema.$Array<Schema.decodeTo<Schema.Struct<{
192
+ readonly relativePath: Schema.String;
192
193
  readonly recordingId: Schema.String;
193
194
  readonly mode: Schema.Literals<readonly ["tab", "viewer"]>;
194
195
  readonly targetId: Schema.String;
195
196
  readonly captureGeneration: Schema.Number;
196
197
  readonly status: Schema.Literals<readonly ["starting", "running", "stopped", "failed"]>;
197
198
  readonly stopReason: Schema.optionalKey<Schema.String>;
198
- readonly path: Schema.String;
199
+ readonly sandboxPath: Schema.optionalKey<Schema.String>;
200
+ readonly path: Schema.optionalKey<Schema.String>;
199
201
  readonly startedAt: Schema.String;
200
202
  readonly stoppedAt: Schema.optionalKey<Schema.String>;
201
203
  readonly sizeBytes: Schema.optionalKey<Schema.Number>;
202
204
  readonly fps: Schema.Number;
203
205
  readonly bitrateKbps: Schema.Number;
204
206
  readonly codec: Schema.String;
205
- }>>, never>;
207
+ }>, Schema.Struct<{
208
+ readonly relativePath: Schema.optionalKey<Schema.String>;
209
+ readonly recordingId: Schema.String;
210
+ readonly mode: Schema.Literals<readonly ["tab", "viewer"]>;
211
+ readonly targetId: Schema.String;
212
+ readonly captureGeneration: Schema.Number;
213
+ readonly status: Schema.Literals<readonly ["starting", "running", "stopped", "failed"]>;
214
+ readonly stopReason: Schema.optionalKey<Schema.String>;
215
+ readonly sandboxPath: Schema.optionalKey<Schema.String>;
216
+ readonly path: Schema.optionalKey<Schema.String>;
217
+ readonly startedAt: Schema.String;
218
+ readonly stoppedAt: Schema.optionalKey<Schema.String>;
219
+ readonly sizeBytes: Schema.optionalKey<Schema.Number>;
220
+ readonly fps: Schema.Number;
221
+ readonly bitrateKbps: Schema.Number;
222
+ readonly codec: Schema.String;
223
+ }>, never, never>>, never>;
206
224
  readonly presentation: Schema.Struct<{
207
225
  readonly quality: Schema.optionalKey<Schema.Struct<{
208
226
  readonly profile: Schema.String;
@@ -227,21 +245,39 @@ declare const CommandResult: Schema.Struct<{
227
245
  readonly code: Schema.optionalKey<Schema.String>;
228
246
  readonly message: Schema.optionalKey<Schema.String>;
229
247
  readonly targetId: Schema.optionalKey<Schema.String>;
230
- readonly recording: Schema.optionalKey<Schema.Struct<{
248
+ readonly recording: Schema.optionalKey<Schema.decodeTo<Schema.Struct<{
249
+ readonly relativePath: Schema.String;
231
250
  readonly recordingId: Schema.String;
232
251
  readonly mode: Schema.Literals<readonly ["tab", "viewer"]>;
233
252
  readonly targetId: Schema.String;
234
253
  readonly captureGeneration: Schema.Number;
235
254
  readonly status: Schema.Literals<readonly ["starting", "running", "stopped", "failed"]>;
236
255
  readonly stopReason: Schema.optionalKey<Schema.String>;
237
- readonly path: Schema.String;
256
+ readonly sandboxPath: Schema.optionalKey<Schema.String>;
257
+ readonly path: Schema.optionalKey<Schema.String>;
238
258
  readonly startedAt: Schema.String;
239
259
  readonly stoppedAt: Schema.optionalKey<Schema.String>;
240
260
  readonly sizeBytes: Schema.optionalKey<Schema.Number>;
241
261
  readonly fps: Schema.Number;
242
262
  readonly bitrateKbps: Schema.Number;
243
263
  readonly codec: Schema.String;
244
- }>>;
264
+ }>, Schema.Struct<{
265
+ readonly relativePath: Schema.optionalKey<Schema.String>;
266
+ readonly recordingId: Schema.String;
267
+ readonly mode: Schema.Literals<readonly ["tab", "viewer"]>;
268
+ readonly targetId: Schema.String;
269
+ readonly captureGeneration: Schema.Number;
270
+ readonly status: Schema.Literals<readonly ["starting", "running", "stopped", "failed"]>;
271
+ readonly stopReason: Schema.optionalKey<Schema.String>;
272
+ readonly sandboxPath: Schema.optionalKey<Schema.String>;
273
+ readonly path: Schema.optionalKey<Schema.String>;
274
+ readonly startedAt: Schema.String;
275
+ readonly stoppedAt: Schema.optionalKey<Schema.String>;
276
+ readonly sizeBytes: Schema.optionalKey<Schema.Number>;
277
+ readonly fps: Schema.Number;
278
+ readonly bitrateKbps: Schema.Number;
279
+ readonly codec: Schema.String;
280
+ }>, never, never>>;
245
281
  readonly presentation: Schema.optionalKey<Schema.Struct<{
246
282
  readonly quality: Schema.optionalKey<Schema.Struct<{
247
283
  readonly profile: Schema.String;
@@ -295,21 +331,39 @@ declare const LiveSessionServerMessage: Schema.Union<readonly [Schema.Struct<{
295
331
  readonly leaseMode: Schema.optionalKey<Schema.Literals<readonly ["implicit", "explicit"]>>;
296
332
  readonly recovering: Schema.optionalKey<Schema.Boolean>;
297
333
  }>>, never>;
298
- readonly recordings: Schema.withDecodingDefaultKey<Schema.$Array<Schema.Struct<{
334
+ readonly recordings: Schema.withDecodingDefaultKey<Schema.$Array<Schema.decodeTo<Schema.Struct<{
335
+ readonly relativePath: Schema.String;
299
336
  readonly recordingId: Schema.String;
300
337
  readonly mode: Schema.Literals<readonly ["tab", "viewer"]>;
301
338
  readonly targetId: Schema.String;
302
339
  readonly captureGeneration: Schema.Number;
303
340
  readonly status: Schema.Literals<readonly ["starting", "running", "stopped", "failed"]>;
304
341
  readonly stopReason: Schema.optionalKey<Schema.String>;
305
- readonly path: Schema.String;
342
+ readonly sandboxPath: Schema.optionalKey<Schema.String>;
343
+ readonly path: Schema.optionalKey<Schema.String>;
306
344
  readonly startedAt: Schema.String;
307
345
  readonly stoppedAt: Schema.optionalKey<Schema.String>;
308
346
  readonly sizeBytes: Schema.optionalKey<Schema.Number>;
309
347
  readonly fps: Schema.Number;
310
348
  readonly bitrateKbps: Schema.Number;
311
349
  readonly codec: Schema.String;
312
- }>>, never>;
350
+ }>, Schema.Struct<{
351
+ readonly relativePath: Schema.optionalKey<Schema.String>;
352
+ readonly recordingId: Schema.String;
353
+ readonly mode: Schema.Literals<readonly ["tab", "viewer"]>;
354
+ readonly targetId: Schema.String;
355
+ readonly captureGeneration: Schema.Number;
356
+ readonly status: Schema.Literals<readonly ["starting", "running", "stopped", "failed"]>;
357
+ readonly stopReason: Schema.optionalKey<Schema.String>;
358
+ readonly sandboxPath: Schema.optionalKey<Schema.String>;
359
+ readonly path: Schema.optionalKey<Schema.String>;
360
+ readonly startedAt: Schema.String;
361
+ readonly stoppedAt: Schema.optionalKey<Schema.String>;
362
+ readonly sizeBytes: Schema.optionalKey<Schema.Number>;
363
+ readonly fps: Schema.Number;
364
+ readonly bitrateKbps: Schema.Number;
365
+ readonly codec: Schema.String;
366
+ }>, never, never>>, never>;
313
367
  readonly presentation: Schema.Struct<{
314
368
  readonly quality: Schema.optionalKey<Schema.Struct<{
315
369
  readonly profile: Schema.String;
@@ -386,21 +440,39 @@ declare const LiveSessionServerMessage: Schema.Union<readonly [Schema.Struct<{
386
440
  }>>, never>;
387
441
  }>, Schema.Struct<{
388
442
  readonly type: Schema.Literal<"recordings.state">;
389
- readonly recordings: Schema.withDecodingDefaultKey<Schema.$Array<Schema.Struct<{
443
+ readonly recordings: Schema.withDecodingDefaultKey<Schema.$Array<Schema.decodeTo<Schema.Struct<{
444
+ readonly relativePath: Schema.String;
390
445
  readonly recordingId: Schema.String;
391
446
  readonly mode: Schema.Literals<readonly ["tab", "viewer"]>;
392
447
  readonly targetId: Schema.String;
393
448
  readonly captureGeneration: Schema.Number;
394
449
  readonly status: Schema.Literals<readonly ["starting", "running", "stopped", "failed"]>;
395
450
  readonly stopReason: Schema.optionalKey<Schema.String>;
396
- readonly path: Schema.String;
451
+ readonly sandboxPath: Schema.optionalKey<Schema.String>;
452
+ readonly path: Schema.optionalKey<Schema.String>;
397
453
  readonly startedAt: Schema.String;
398
454
  readonly stoppedAt: Schema.optionalKey<Schema.String>;
399
455
  readonly sizeBytes: Schema.optionalKey<Schema.Number>;
400
456
  readonly fps: Schema.Number;
401
457
  readonly bitrateKbps: Schema.Number;
402
458
  readonly codec: Schema.String;
403
- }>>, never>;
459
+ }>, Schema.Struct<{
460
+ readonly relativePath: Schema.optionalKey<Schema.String>;
461
+ readonly recordingId: Schema.String;
462
+ readonly mode: Schema.Literals<readonly ["tab", "viewer"]>;
463
+ readonly targetId: Schema.String;
464
+ readonly captureGeneration: Schema.Number;
465
+ readonly status: Schema.Literals<readonly ["starting", "running", "stopped", "failed"]>;
466
+ readonly stopReason: Schema.optionalKey<Schema.String>;
467
+ readonly sandboxPath: Schema.optionalKey<Schema.String>;
468
+ readonly path: Schema.optionalKey<Schema.String>;
469
+ readonly startedAt: Schema.String;
470
+ readonly stoppedAt: Schema.optionalKey<Schema.String>;
471
+ readonly sizeBytes: Schema.optionalKey<Schema.Number>;
472
+ readonly fps: Schema.Number;
473
+ readonly bitrateKbps: Schema.Number;
474
+ readonly codec: Schema.String;
475
+ }>, never, never>>, never>;
404
476
  }>, Schema.Struct<{
405
477
  readonly type: Schema.Literal<"presentation.state">;
406
478
  readonly presentation: Schema.Struct<{
@@ -430,21 +502,39 @@ declare const LiveSessionServerMessage: Schema.Union<readonly [Schema.Struct<{
430
502
  readonly code: Schema.optionalKey<Schema.String>;
431
503
  readonly message: Schema.optionalKey<Schema.String>;
432
504
  readonly targetId: Schema.optionalKey<Schema.String>;
433
- readonly recording: Schema.optionalKey<Schema.Struct<{
505
+ readonly recording: Schema.optionalKey<Schema.decodeTo<Schema.Struct<{
506
+ readonly relativePath: Schema.String;
434
507
  readonly recordingId: Schema.String;
435
508
  readonly mode: Schema.Literals<readonly ["tab", "viewer"]>;
436
509
  readonly targetId: Schema.String;
437
510
  readonly captureGeneration: Schema.Number;
438
511
  readonly status: Schema.Literals<readonly ["starting", "running", "stopped", "failed"]>;
439
512
  readonly stopReason: Schema.optionalKey<Schema.String>;
440
- readonly path: Schema.String;
513
+ readonly sandboxPath: Schema.optionalKey<Schema.String>;
514
+ readonly path: Schema.optionalKey<Schema.String>;
441
515
  readonly startedAt: Schema.String;
442
516
  readonly stoppedAt: Schema.optionalKey<Schema.String>;
443
517
  readonly sizeBytes: Schema.optionalKey<Schema.Number>;
444
518
  readonly fps: Schema.Number;
445
519
  readonly bitrateKbps: Schema.Number;
446
520
  readonly codec: Schema.String;
447
- }>>;
521
+ }>, Schema.Struct<{
522
+ readonly relativePath: Schema.optionalKey<Schema.String>;
523
+ readonly recordingId: Schema.String;
524
+ readonly mode: Schema.Literals<readonly ["tab", "viewer"]>;
525
+ readonly targetId: Schema.String;
526
+ readonly captureGeneration: Schema.Number;
527
+ readonly status: Schema.Literals<readonly ["starting", "running", "stopped", "failed"]>;
528
+ readonly stopReason: Schema.optionalKey<Schema.String>;
529
+ readonly sandboxPath: Schema.optionalKey<Schema.String>;
530
+ readonly path: Schema.optionalKey<Schema.String>;
531
+ readonly startedAt: Schema.String;
532
+ readonly stoppedAt: Schema.optionalKey<Schema.String>;
533
+ readonly sizeBytes: Schema.optionalKey<Schema.Number>;
534
+ readonly fps: Schema.Number;
535
+ readonly bitrateKbps: Schema.Number;
536
+ readonly codec: Schema.String;
537
+ }>, never, never>>;
448
538
  readonly presentation: Schema.optionalKey<Schema.Struct<{
449
539
  readonly quality: Schema.optionalKey<Schema.Struct<{
450
540
  readonly profile: Schema.String;
@@ -472,16 +562,18 @@ declare const decodeServerMessage: (input: unknown, options?: import("effect/Sch
472
562
  readonly targetId?: string | undefined;
473
563
  readonly recording?: {
474
564
  readonly targetId: string;
475
- readonly mode: "tab" | "viewer";
476
- readonly status: "starting" | "running" | "stopped" | "failed";
565
+ readonly relativePath: string;
477
566
  readonly recordingId: string;
567
+ readonly mode: "tab" | "viewer";
478
568
  readonly captureGeneration: number;
479
- readonly path: string;
569
+ readonly status: "starting" | "running" | "stopped" | "failed";
480
570
  readonly startedAt: string;
481
571
  readonly fps: number;
482
572
  readonly bitrateKbps: number;
483
573
  readonly codec: string;
484
574
  readonly stopReason?: string | undefined;
575
+ readonly sandboxPath?: string | undefined;
576
+ readonly path?: string | undefined;
485
577
  readonly stoppedAt?: string | undefined;
486
578
  readonly sizeBytes?: number | undefined;
487
579
  } | undefined;
@@ -551,16 +643,18 @@ declare const decodeServerMessage: (input: unknown, options?: import("effect/Sch
551
643
  readonly clientId: string;
552
644
  readonly recordings: readonly {
553
645
  readonly targetId: string;
554
- readonly mode: "tab" | "viewer";
555
- readonly status: "starting" | "running" | "stopped" | "failed";
646
+ readonly relativePath: string;
556
647
  readonly recordingId: string;
648
+ readonly mode: "tab" | "viewer";
557
649
  readonly captureGeneration: number;
558
- readonly path: string;
650
+ readonly status: "starting" | "running" | "stopped" | "failed";
559
651
  readonly startedAt: string;
560
652
  readonly fps: number;
561
653
  readonly bitrateKbps: number;
562
654
  readonly codec: string;
563
655
  readonly stopReason?: string | undefined;
656
+ readonly sandboxPath?: string | undefined;
657
+ readonly path?: string | undefined;
564
658
  readonly stoppedAt?: string | undefined;
565
659
  readonly sizeBytes?: number | undefined;
566
660
  }[];
@@ -630,16 +724,18 @@ declare const decodeServerMessage: (input: unknown, options?: import("effect/Sch
630
724
  readonly type: "recordings.state";
631
725
  readonly recordings: readonly {
632
726
  readonly targetId: string;
633
- readonly mode: "tab" | "viewer";
634
- readonly status: "starting" | "running" | "stopped" | "failed";
727
+ readonly relativePath: string;
635
728
  readonly recordingId: string;
729
+ readonly mode: "tab" | "viewer";
636
730
  readonly captureGeneration: number;
637
- readonly path: string;
731
+ readonly status: "starting" | "running" | "stopped" | "failed";
638
732
  readonly startedAt: string;
639
733
  readonly fps: number;
640
734
  readonly bitrateKbps: number;
641
735
  readonly codec: string;
642
736
  readonly stopReason?: string | undefined;
737
+ readonly sandboxPath?: string | undefined;
738
+ readonly path?: string | undefined;
643
739
  readonly stoppedAt?: string | undefined;
644
740
  readonly sizeBytes?: number | undefined;
645
741
  }[];
@@ -771,16 +867,18 @@ declare const make: (options: LiveSessionConnectionOptions) => Effect.Effect<{
771
867
  readonly targetId?: string | undefined;
772
868
  readonly recording?: {
773
869
  readonly targetId: string;
774
- readonly mode: "tab" | "viewer";
775
- readonly status: "starting" | "running" | "stopped" | "failed";
870
+ readonly relativePath: string;
776
871
  readonly recordingId: string;
872
+ readonly mode: "tab" | "viewer";
777
873
  readonly captureGeneration: number;
778
- readonly path: string;
874
+ readonly status: "starting" | "running" | "stopped" | "failed";
779
875
  readonly startedAt: string;
780
876
  readonly fps: number;
781
877
  readonly bitrateKbps: number;
782
878
  readonly codec: string;
783
879
  readonly stopReason?: string | undefined;
880
+ readonly sandboxPath?: string | undefined;
881
+ readonly path?: string | undefined;
784
882
  readonly stoppedAt?: string | undefined;
785
883
  readonly sizeBytes?: number | undefined;
786
884
  } | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aperture-browser/live-session",
3
- "version": "0.0.0-init.0",
3
+ "version": "0.0.0-nightly.82.2e4f6368108f",
4
4
  "description": "Framework-agnostic client for Aperture live sessions: the session protocol, WebRTC and WebSocket transports, and browser input mapping.",
5
5
  "homepage": "https://github.com/tarik02/aperture#readme",
6
6
  "bugs": "https://github.com/tarik02/aperture/issues",
@@ -25,7 +25,7 @@
25
25
  "access": "public"
26
26
  },
27
27
  "dependencies": {
28
- "@aperture-browser/api-client": "0.0.0-init.0"
28
+ "@aperture-browser/api-client": "0.0.0-nightly.82.2e4f6368108f"
29
29
  },
30
30
  "devDependencies": {
31
31
  "effect": "4.0.0-rc.117",