livekit-client 0.18.4-RC6 → 0.18.4-RC7

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 (8) hide show
  1. package/dist/livekit-client.esm.mjs +38 -15
  2. package/dist/livekit-client.esm.mjs.map +1 -1
  3. package/dist/livekit-client.umd.js +1 -1
  4. package/dist/livekit-client.umd.js.map +1 -1
  5. package/dist/proto/livekit_models.d.ts +7 -0
  6. package/dist/proto/livekit_rtc.d.ts +44 -0
  7. package/dist/room/participant/ParticipantTrackPermission.d.ts +8 -2
  8. package/package.json +1 -1
package/dist/proto/livekit_models.d.ts CHANGED
@@ -83,6 +83,11 @@ export interface ParticipantInfo {
83
83
  version: number;
84
84
  permission?: ParticipantPermission;
85
85
  region: string;
86
+ /**
87
+ * indicates the participant has an active publisher connection
88
+ * and can publish to the server
89
+ */
90
+ isPublisher: boolean;
86
91
  }
87
92
  export declare enum ParticipantInfo_State {
88
93
  /** JOINING - websocket' connected, but not offered yet */
@@ -360,6 +365,7 @@ export declare const ParticipantInfo: {
360
365
  recorder?: boolean | undefined;
361
366
  } | undefined;
362
367
  region?: string | undefined;
368
+ isPublisher?: boolean | undefined;
363
369
  } & {
364
370
  sid?: string | undefined;
365
371
  identity?: string | undefined;
@@ -477,6 +483,7 @@ export declare const ParticipantInfo: {
477
483
  recorder?: boolean | undefined;
478
484
  } & Record<Exclude<keyof I["permission"], keyof ParticipantPermission>, never>) | undefined;
479
485
  region?: string | undefined;
486
+ isPublisher?: boolean | undefined;
480
487
  } & Record<Exclude<keyof I, keyof ParticipantInfo>, never>>(object: I): ParticipantInfo;
481
488
  };
482
489
  export declare const TrackInfo: {
package/dist/proto/livekit_rtc.d.ts CHANGED
@@ -198,9 +198,11 @@ export interface SubscribedQualityUpdate {
198
198
  subscribedQualities: SubscribedQuality[];
199
199
  }
200
200
  export interface TrackPermission {
201
+ /** permission could be granted either by participant sid or identity */
201
202
  participantSid: string;
202
203
  allTracks: boolean;
203
204
  trackSids: string[];
205
+ participantIdentity: string;
204
206
  }
205
207
  export interface SubscriptionPermission {
206
208
  allParticipants: boolean;
@@ -305,6 +307,7 @@ export declare const SignalRequest: {
305
307
  participantSid?: string | undefined;
306
308
  allTracks?: boolean | undefined;
307
309
  trackSids?: string[] | undefined;
310
+ participantIdentity?: string | undefined;
308
311
  }[] | undefined;
309
312
  } | undefined;
310
313
  syncState?: {
@@ -520,6 +523,7 @@ export declare const SignalRequest: {
520
523
  participantSid?: string | undefined;
521
524
  allTracks?: boolean | undefined;
522
525
  trackSids?: string[] | undefined;
526
+ participantIdentity?: string | undefined;
523
527
  }[] | undefined;
524
528
  } & {
525
529
  allParticipants?: boolean | undefined;
@@ -527,18 +531,22 @@ export declare const SignalRequest: {
527
531
  participantSid?: string | undefined;
528
532
  allTracks?: boolean | undefined;
529
533
  trackSids?: string[] | undefined;
534
+ participantIdentity?: string | undefined;
530
535
  }[] & ({
531
536
  participantSid?: string | undefined;
532
537
  allTracks?: boolean | undefined;
533
538
  trackSids?: string[] | undefined;
539
+ participantIdentity?: string | undefined;
534
540
  } & {
535
541
  participantSid?: string | undefined;
536
542
  allTracks?: boolean | undefined;
537
543
  trackSids?: (string[] & string[] & Record<Exclude<keyof I["subscriptionPermission"]["trackPermissions"][number]["trackSids"], number | keyof string[]>, never>) | undefined;
544
+ participantIdentity?: string | undefined;
538
545
  } & Record<Exclude<keyof I["subscriptionPermission"]["trackPermissions"][number], keyof TrackPermission>, never>)[] & Record<Exclude<keyof I["subscriptionPermission"]["trackPermissions"], number | keyof {
539
546
  participantSid?: string | undefined;
540
547
  allTracks?: boolean | undefined;
541
548
  trackSids?: string[] | undefined;
549
+ participantIdentity?: string | undefined;
542
550
  }[]>, never>) | undefined;
543
551
  } & Record<Exclude<keyof I["subscriptionPermission"], keyof SubscriptionPermission>, never>) | undefined;
544
552
  syncState?: ({
@@ -829,6 +837,7 @@ export declare const SignalResponse: {
829
837
  recorder?: boolean | undefined;
830
838
  } | undefined;
831
839
  region?: string | undefined;
840
+ isPublisher?: boolean | undefined;
832
841
  } | undefined;
833
842
  otherParticipants?: {
834
843
  sid?: string | undefined;
@@ -866,6 +875,7 @@ export declare const SignalResponse: {
866
875
  recorder?: boolean | undefined;
867
876
  } | undefined;
868
877
  region?: string | undefined;
878
+ isPublisher?: boolean | undefined;
869
879
  }[] | undefined;
870
880
  serverVersion?: string | undefined;
871
881
  iceServers?: {
@@ -935,6 +945,7 @@ export declare const SignalResponse: {
935
945
  recorder?: boolean | undefined;
936
946
  } | undefined;
937
947
  region?: string | undefined;
948
+ isPublisher?: boolean | undefined;
938
949
  }[] | undefined;
939
950
  } | undefined;
940
951
  trackPublished?: {
@@ -1074,6 +1085,7 @@ export declare const SignalResponse: {
1074
1085
  recorder?: boolean | undefined;
1075
1086
  } | undefined;
1076
1087
  region?: string | undefined;
1088
+ isPublisher?: boolean | undefined;
1077
1089
  } | undefined;
1078
1090
  otherParticipants?: {
1079
1091
  sid?: string | undefined;
@@ -1111,6 +1123,7 @@ export declare const SignalResponse: {
1111
1123
  recorder?: boolean | undefined;
1112
1124
  } | undefined;
1113
1125
  region?: string | undefined;
1126
+ isPublisher?: boolean | undefined;
1114
1127
  }[] | undefined;
1115
1128
  serverVersion?: string | undefined;
1116
1129
  iceServers?: {
@@ -1205,6 +1218,7 @@ export declare const SignalResponse: {
1205
1218
  recorder?: boolean | undefined;
1206
1219
  } | undefined;
1207
1220
  region?: string | undefined;
1221
+ isPublisher?: boolean | undefined;
1208
1222
  } & {
1209
1223
  sid?: string | undefined;
1210
1224
  identity?: string | undefined;
@@ -1322,6 +1336,7 @@ export declare const SignalResponse: {
1322
1336
  recorder?: boolean | undefined;
1323
1337
  } & Record<Exclude<keyof I["join"]["participant"]["permission"], keyof import("./livekit_models").ParticipantPermission>, never>) | undefined;
1324
1338
  region?: string | undefined;
1339
+ isPublisher?: boolean | undefined;
1325
1340
  } & Record<Exclude<keyof I["join"]["participant"], keyof ParticipantInfo>, never>) | undefined;
1326
1341
  otherParticipants?: ({
1327
1342
  sid?: string | undefined;
@@ -1359,6 +1374,7 @@ export declare const SignalResponse: {
1359
1374
  recorder?: boolean | undefined;
1360
1375
  } | undefined;
1361
1376
  region?: string | undefined;
1377
+ isPublisher?: boolean | undefined;
1362
1378
  }[] & ({
1363
1379
  sid?: string | undefined;
1364
1380
  identity?: string | undefined;
@@ -1395,6 +1411,7 @@ export declare const SignalResponse: {
1395
1411
  recorder?: boolean | undefined;
1396
1412
  } | undefined;
1397
1413
  region?: string | undefined;
1414
+ isPublisher?: boolean | undefined;
1398
1415
  } & {
1399
1416
  sid?: string | undefined;
1400
1417
  identity?: string | undefined;
@@ -1512,6 +1529,7 @@ export declare const SignalResponse: {
1512
1529
  recorder?: boolean | undefined;
1513
1530
  } & Record<Exclude<keyof I["join"]["otherParticipants"][number]["permission"], keyof import("./livekit_models").ParticipantPermission>, never>) | undefined;
1514
1531
  region?: string | undefined;
1532
+ isPublisher?: boolean | undefined;
1515
1533
  } & Record<Exclude<keyof I["join"]["otherParticipants"][number], keyof ParticipantInfo>, never>)[] & Record<Exclude<keyof I["join"]["otherParticipants"], number | keyof {
1516
1534
  sid?: string | undefined;
1517
1535
  identity?: string | undefined;
@@ -1548,6 +1566,7 @@ export declare const SignalResponse: {
1548
1566
  recorder?: boolean | undefined;
1549
1567
  } | undefined;
1550
1568
  region?: string | undefined;
1569
+ isPublisher?: boolean | undefined;
1551
1570
  }[]>, never>) | undefined;
1552
1571
  serverVersion?: string | undefined;
1553
1572
  iceServers?: ({
@@ -1650,6 +1669,7 @@ export declare const SignalResponse: {
1650
1669
  recorder?: boolean | undefined;
1651
1670
  } | undefined;
1652
1671
  region?: string | undefined;
1672
+ isPublisher?: boolean | undefined;
1653
1673
  }[] | undefined;
1654
1674
  } & {
1655
1675
  participants?: ({
@@ -1688,6 +1708,7 @@ export declare const SignalResponse: {
1688
1708
  recorder?: boolean | undefined;
1689
1709
  } | undefined;
1690
1710
  region?: string | undefined;
1711
+ isPublisher?: boolean | undefined;
1691
1712
  }[] & ({
1692
1713
  sid?: string | undefined;
1693
1714
  identity?: string | undefined;
@@ -1724,6 +1745,7 @@ export declare const SignalResponse: {
1724
1745
  recorder?: boolean | undefined;
1725
1746
  } | undefined;
1726
1747
  region?: string | undefined;
1748
+ isPublisher?: boolean | undefined;
1727
1749
  } & {
1728
1750
  sid?: string | undefined;
1729
1751
  identity?: string | undefined;
@@ -1841,6 +1863,7 @@ export declare const SignalResponse: {
1841
1863
  recorder?: boolean | undefined;
1842
1864
  } & Record<Exclude<keyof I["update"]["participants"][number]["permission"], keyof import("./livekit_models").ParticipantPermission>, never>) | undefined;
1843
1865
  region?: string | undefined;
1866
+ isPublisher?: boolean | undefined;
1844
1867
  } & Record<Exclude<keyof I["update"]["participants"][number], keyof ParticipantInfo>, never>)[] & Record<Exclude<keyof I["update"]["participants"], number | keyof {
1845
1868
  sid?: string | undefined;
1846
1869
  identity?: string | undefined;
@@ -1877,6 +1900,7 @@ export declare const SignalResponse: {
1877
1900
  recorder?: boolean | undefined;
1878
1901
  } | undefined;
1879
1902
  region?: string | undefined;
1903
+ isPublisher?: boolean | undefined;
1880
1904
  }[]>, never>) | undefined;
1881
1905
  } & Record<Exclude<keyof I["update"], "participants">, never>) | undefined;
1882
1906
  trackPublished?: ({
@@ -2283,6 +2307,7 @@ export declare const JoinResponse: {
2283
2307
  recorder?: boolean | undefined;
2284
2308
  } | undefined;
2285
2309
  region?: string | undefined;
2310
+ isPublisher?: boolean | undefined;
2286
2311
  } | undefined;
2287
2312
  otherParticipants?: {
2288
2313
  sid?: string | undefined;
@@ -2320,6 +2345,7 @@ export declare const JoinResponse: {
2320
2345
  recorder?: boolean | undefined;
2321
2346
  } | undefined;
2322
2347
  region?: string | undefined;
2348
+ isPublisher?: boolean | undefined;
2323
2349
  }[] | undefined;
2324
2350
  serverVersion?: string | undefined;
2325
2351
  iceServers?: {
@@ -2414,6 +2440,7 @@ export declare const JoinResponse: {
2414
2440
  recorder?: boolean | undefined;
2415
2441
  } | undefined;
2416
2442
  region?: string | undefined;
2443
+ isPublisher?: boolean | undefined;
2417
2444
  } & {
2418
2445
  sid?: string | undefined;
2419
2446
  identity?: string | undefined;
@@ -2531,6 +2558,7 @@ export declare const JoinResponse: {
2531
2558
  recorder?: boolean | undefined;
2532
2559
  } & Record<Exclude<keyof I["participant"]["permission"], keyof import("./livekit_models").ParticipantPermission>, never>) | undefined;
2533
2560
  region?: string | undefined;
2561
+ isPublisher?: boolean | undefined;
2534
2562
  } & Record<Exclude<keyof I["participant"], keyof ParticipantInfo>, never>) | undefined;
2535
2563
  otherParticipants?: ({
2536
2564
  sid?: string | undefined;
@@ -2568,6 +2596,7 @@ export declare const JoinResponse: {
2568
2596
  recorder?: boolean | undefined;
2569
2597
  } | undefined;
2570
2598
  region?: string | undefined;
2599
+ isPublisher?: boolean | undefined;
2571
2600
  }[] & ({
2572
2601
  sid?: string | undefined;
2573
2602
  identity?: string | undefined;
@@ -2604,6 +2633,7 @@ export declare const JoinResponse: {
2604
2633
  recorder?: boolean | undefined;
2605
2634
  } | undefined;
2606
2635
  region?: string | undefined;
2636
+ isPublisher?: boolean | undefined;
2607
2637
  } & {
2608
2638
  sid?: string | undefined;
2609
2639
  identity?: string | undefined;
@@ -2721,6 +2751,7 @@ export declare const JoinResponse: {
2721
2751
  recorder?: boolean | undefined;
2722
2752
  } & Record<Exclude<keyof I["otherParticipants"][number]["permission"], keyof import("./livekit_models").ParticipantPermission>, never>) | undefined;
2723
2753
  region?: string | undefined;
2754
+ isPublisher?: boolean | undefined;
2724
2755
  } & Record<Exclude<keyof I["otherParticipants"][number], keyof ParticipantInfo>, never>)[] & Record<Exclude<keyof I["otherParticipants"], number | keyof {
2725
2756
  sid?: string | undefined;
2726
2757
  identity?: string | undefined;
@@ -2757,6 +2788,7 @@ export declare const JoinResponse: {
2757
2788
  recorder?: boolean | undefined;
2758
2789
  } | undefined;
2759
2790
  region?: string | undefined;
2791
+ isPublisher?: boolean | undefined;
2760
2792
  }[]>, never>) | undefined;
2761
2793
  serverVersion?: string | undefined;
2762
2794
  iceServers?: ({
@@ -2956,6 +2988,7 @@ export declare const ParticipantUpdate: {
2956
2988
  recorder?: boolean | undefined;
2957
2989
  } | undefined;
2958
2990
  region?: string | undefined;
2991
+ isPublisher?: boolean | undefined;
2959
2992
  }[] | undefined;
2960
2993
  } & {
2961
2994
  participants?: ({
@@ -2994,6 +3027,7 @@ export declare const ParticipantUpdate: {
2994
3027
  recorder?: boolean | undefined;
2995
3028
  } | undefined;
2996
3029
  region?: string | undefined;
3030
+ isPublisher?: boolean | undefined;
2997
3031
  }[] & ({
2998
3032
  sid?: string | undefined;
2999
3033
  identity?: string | undefined;
@@ -3030,6 +3064,7 @@ export declare const ParticipantUpdate: {
3030
3064
  recorder?: boolean | undefined;
3031
3065
  } | undefined;
3032
3066
  region?: string | undefined;
3067
+ isPublisher?: boolean | undefined;
3033
3068
  } & {
3034
3069
  sid?: string | undefined;
3035
3070
  identity?: string | undefined;
@@ -3147,6 +3182,7 @@ export declare const ParticipantUpdate: {
3147
3182
  recorder?: boolean | undefined;
3148
3183
  } & Record<Exclude<keyof I["participants"][number]["permission"], keyof import("./livekit_models").ParticipantPermission>, never>) | undefined;
3149
3184
  region?: string | undefined;
3185
+ isPublisher?: boolean | undefined;
3150
3186
  } & Record<Exclude<keyof I["participants"][number], keyof ParticipantInfo>, never>)[] & Record<Exclude<keyof I["participants"], number | keyof {
3151
3187
  sid?: string | undefined;
3152
3188
  identity?: string | undefined;
@@ -3183,6 +3219,7 @@ export declare const ParticipantUpdate: {
3183
3219
  recorder?: boolean | undefined;
3184
3220
  } | undefined;
3185
3221
  region?: string | undefined;
3222
+ isPublisher?: boolean | undefined;
3186
3223
  }[]>, never>) | undefined;
3187
3224
  } & Record<Exclude<keyof I, "participants">, never>>(object: I): ParticipantUpdate;
3188
3225
  };
@@ -3539,10 +3576,12 @@ export declare const TrackPermission: {
3539
3576
  participantSid?: string | undefined;
3540
3577
  allTracks?: boolean | undefined;
3541
3578
  trackSids?: string[] | undefined;
3579
+ participantIdentity?: string | undefined;
3542
3580
  } & {
3543
3581
  participantSid?: string | undefined;
3544
3582
  allTracks?: boolean | undefined;
3545
3583
  trackSids?: (string[] & string[] & Record<Exclude<keyof I["trackSids"], number | keyof string[]>, never>) | undefined;
3584
+ participantIdentity?: string | undefined;
3546
3585
  } & Record<Exclude<keyof I, keyof TrackPermission>, never>>(object: I): TrackPermission;
3547
3586
  };
3548
3587
  export declare const SubscriptionPermission: {
@@ -3556,6 +3595,7 @@ export declare const SubscriptionPermission: {
3556
3595
  participantSid?: string | undefined;
3557
3596
  allTracks?: boolean | undefined;
3558
3597
  trackSids?: string[] | undefined;
3598
+ participantIdentity?: string | undefined;
3559
3599
  }[] | undefined;
3560
3600
  } & {
3561
3601
  allParticipants?: boolean | undefined;
@@ -3563,18 +3603,22 @@ export declare const SubscriptionPermission: {
3563
3603
  participantSid?: string | undefined;
3564
3604
  allTracks?: boolean | undefined;
3565
3605
  trackSids?: string[] | undefined;
3606
+ participantIdentity?: string | undefined;
3566
3607
  }[] & ({
3567
3608
  participantSid?: string | undefined;
3568
3609
  allTracks?: boolean | undefined;
3569
3610
  trackSids?: string[] | undefined;
3611
+ participantIdentity?: string | undefined;
3570
3612
  } & {
3571
3613
  participantSid?: string | undefined;
3572
3614
  allTracks?: boolean | undefined;
3573
3615
  trackSids?: (string[] & string[] & Record<Exclude<keyof I["trackPermissions"][number]["trackSids"], number | keyof string[]>, never>) | undefined;
3616
+ participantIdentity?: string | undefined;
3574
3617
  } & Record<Exclude<keyof I["trackPermissions"][number], keyof TrackPermission>, never>)[] & Record<Exclude<keyof I["trackPermissions"], number | keyof {
3575
3618
  participantSid?: string | undefined;
3576
3619
  allTracks?: boolean | undefined;
3577
3620
  trackSids?: string[] | undefined;
3621
+ participantIdentity?: string | undefined;
3578
3622
  }[]>, never>) | undefined;
3579
3623
  } & Record<Exclude<keyof I, keyof SubscriptionPermission>, never>>(object: I): SubscriptionPermission;
3580
3624
  };
package/dist/room/participant/ParticipantTrackPermission.d.ts CHANGED
@@ -1,9 +1,15 @@
1
1
  import { TrackPermission } from '../../proto/livekit_rtc';
2
2
  export interface ParticipantTrackPermission {
3
3
  /**
4
- * The participant id this permission applies to.
4
+ * The participant identity this permission applies to.
5
+ * You can either provide this or `participantSid`
5
6
  */
6
- participantSid: string;
7
+ participantIdentity?: string;
8
+ /**
9
+ * The participant server id this permission applies to.
10
+ * You can either provide this or `participantIdentity`
11
+ */
12
+ participantSid?: string;
7
13
  /**
8
14
  * Grant permission to all all tracks. Takes precedence over allowedTrackSids.
9
15
  * false if unset.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "livekit-client",
3
- "version": "0.18.4-RC6",
3
+ "version": "0.18.4-RC7",
4
4
  "description": "JavaScript/TypeScript client SDK for LiveKit",
5
5
  "main": "./dist/livekit-client.umd.js",
6
6
  "unpkg": "./dist/livekit-client.umd.js",