plugnmeet-protocol-js 1.4.1-0 → 1.4.1-3

package/dist/index.d.ts

@@ -812,6 +812,12 @@ export type NatsKvUserInfo = Message<"plugnmeet.NatsKvUserInfo"> & {
      * @generated from field: uint64 disconnected_at = 10 [jstype = JS_STRING];
      */
     disconnectedAt: string;
+    /**
+     * session client type; WEB when absent (backward compatible)
+     *
+     * @generated from field: plugnmeet.ClientType client_type = 11;
+     */
+    clientType: ClientType;
 };
 /**
  * Describes the message plugnmeet.NatsKvUserInfo.
@@ -904,6 +910,12 @@ export type MediaServerConnInfo = Message<"plugnmeet.MediaServerConnInfo"> & {
      * @generated from field: optional plugnmeet.TurnCredentials turn_credentials = 4;
      */
     turnCredentials?: TurnCredentials | undefined;
+    /**
+     * LiveKit JWT for the [userID]-native publish-only twin; only set when the session is HYBRID_WEB
+     *
+     * @generated from field: string native_token = 5;
+     */
+    nativeToken: string;
 };
 /**
  * Describes the message plugnmeet.MediaServerConnInfo.
@@ -1028,6 +1040,28 @@ export type ChatMessage = Message<"plugnmeet.ChatMessage"> & {
  * Use `create(ChatMessageSchema)` to create a new message.
  */
 export const ChatMessageSchema: GenMessage<ChatMessage>;
+/**
+ * ClientType identifies which client shell is joining.
+ * WEB = standard plugNmeet web client (default).
+ * HYBRID_WEB = web client running inside a native app's webview (hybrid mode:
+ * subscribe-only; media publishing is delegated to the native host app).
+ *
+ * @generated from enum plugnmeet.ClientType
+ */
+export enum ClientType {
+    /**
+     * @generated from enum value: WEB = 0;
+     */
+    WEB = 0,
+    /**
+     * @generated from enum value: HYBRID_WEB = 1;
+     */
+    HYBRID_WEB = 1
+}
+/**
+ * Describes the enum plugnmeet.ClientType.
+ */
+export const ClientTypeSchema: GenEnum<ClientType>;
 /**
  * @generated from enum plugnmeet.NatsMsgServerToClientEvents
  */
@@ -1287,6 +1321,12 @@ export type VerifyTokenRes = Message<"plugnmeet.VerifyTokenRes"> & {
      * @generated from field: optional bool is_cloud = 10;
      */
     isCloud?: boolean | undefined;
+    /**
+     * echoed from the token claims; web client enters hybrid UI when HYBRID_WEB
+     *
+     * @generated from field: plugnmeet.ClientType client_type = 11;
+     */
+    clientType: ClientType;
 };
 /**
  * Describes the message plugnmeet.VerifyTokenRes.
@@ -2510,11 +2550,15 @@ enum ParticipantInfo_KindDetail {
      */
     CONNECTOR_TWILIO = 3,
     /**
-     * NEXT_ID: 5
-     *
      * @generated from enum value: BRIDGE_RTSP = 4;
      */
-    BRIDGE_RTSP = 4
+    BRIDGE_RTSP = 4,
+    /**
+     * NEXT_ID: 6
+     *
+     * @generated from enum value: SIMULATION = 5;
+     */
+    SIMULATION = 5
 }
 /**
  * @generated from enum livekit.Encryption.Type
@@ -5308,6 +5352,12 @@ export type UserInfo = Message<"plugnmeet.UserInfo"> & {
      * @generated from field: plugnmeet.UserMetadata user_metadata = 5;
      */
     userMetadata?: UserMetadata | undefined;
+    /**
+     * default WEB; customer backend sets HYBRID_WEB for native-shell joins
+     *
+     * @generated from field: plugnmeet.ClientType client_type = 6;
+     */
+    clientType: ClientType;
 };
 /**
  * Describes the message plugnmeet.UserInfo.
@@ -5422,6 +5472,12 @@ export type PlugNmeetTokenClaims = Message<"plugnmeet.PlugNmeetTokenClaims"> & {
      * @generated from field: bool is_hidden = 5;
      */
     isHidden: boolean;
+    /**
+     * copied from UserInfo at join-token generation
+     *
+     * @generated from field: plugnmeet.ClientType client_type = 6;
+     */
+    clientType: ClientType;
 };
 /**
  * Describes the message plugnmeet.PlugNmeetTokenClaims.
@@ -6572,6 +6628,325 @@ export type LtiCustomDesign = Message<"plugnmeet.LtiCustomDesign"> & {
  * Use `create(LtiCustomDesignSchema)` to create a new message.
  */
 export const LtiCustomDesignSchema: GenMessage<LtiCustomDesign>;
+/**
+ * Describes the file plugnmeet_native_bridge.proto.
+ */
+export const file_plugnmeet_native_bridge: GenFile;
+/**
+ * Wire format for communication between the webview and the native host.
+ * Messages are encoded as proto3 JSON (not binary).
+ *
+ * @generated from message plugnmeet.NativeBridgeMsg
+ */
+export type NativeBridgeMsg = Message<"plugnmeet.NativeBridgeMsg"> & {
+    /**
+     * @generated from field: plugnmeet.NativeBridgeActions action = 1;
+     */
+    action: NativeBridgeActions;
+    /**
+     * @generated from oneof plugnmeet.NativeBridgeMsg.payload
+     */
+    payload: {
+        /**
+         * @generated from field: plugnmeet.NativeBridgeInitializePublisher initialize_native_publisher = 2;
+         */
+        value: NativeBridgeInitializePublisher;
+        case: "initializeNativePublisher";
+    } | {
+        /**
+         * @generated from field: plugnmeet.NativeBridgeMediaSource media_source = 3;
+         */
+        value: NativeBridgeMediaSource;
+        case: "mediaSource";
+    } | {
+        /**
+         * @generated from field: plugnmeet.NativeBridgeHeartbeat heartbeat = 4;
+         */
+        value: NativeBridgeHeartbeat;
+        case: "heartbeat";
+    } | {
+        /**
+         * @generated from field: plugnmeet.NativeBridgeMediaStatus media_status = 5;
+         */
+        value: NativeBridgeMediaStatus;
+        case: "mediaStatus";
+    } | {
+        /**
+         * @generated from field: plugnmeet.NativeBridgeTrackState track_state = 6;
+         */
+        value: NativeBridgeTrackState;
+        case: "trackState";
+    } | {
+        /**
+         * @generated from field: plugnmeet.NativeBridgeMediaMuted media_muted = 7;
+         */
+        value: NativeBridgeMediaMuted;
+        case: "mediaMuted";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message plugnmeet.NativeBridgeMsg.
+ * Use `create(NativeBridgeMsgSchema)` to create a new message.
+ */
+export const NativeBridgeMsgSchema: GenMessage<NativeBridgeMsg>;
+/**
+ * @generated from message plugnmeet.NativeBridgeInitializePublisher
+ */
+export type NativeBridgeInitializePublisher = Message<"plugnmeet.NativeBridgeInitializePublisher"> & {
+    /**
+     * @generated from field: string livekit_url = 1;
+     */
+    livekitUrl: string;
+    /**
+     * @generated from field: string token = 2;
+     */
+    token: string;
+    /**
+     * @generated from field: string native_user_id = 3;
+     */
+    nativeUserId: string;
+    /**
+     * @generated from field: optional plugnmeet.NativeBridgeE2EE e2ee = 4;
+     */
+    e2ee?: NativeBridgeE2EE | undefined;
+};
+/**
+ * Describes the message plugnmeet.NativeBridgeInitializePublisher.
+ * Use `create(NativeBridgeInitializePublisherSchema)` to create a new message.
+ */
+export const NativeBridgeInitializePublisherSchema: GenMessage<NativeBridgeInitializePublisher>;
+/**
+ * @generated from message plugnmeet.NativeBridgeE2EE
+ */
+export type NativeBridgeE2EE = Message<"plugnmeet.NativeBridgeE2EE"> & {
+    /**
+     * @generated from field: bool enabled = 1;
+     */
+    enabled: boolean;
+    /**
+     * @generated from field: optional string key = 2;
+     */
+    key?: string | undefined;
+};
+/**
+ * Describes the message plugnmeet.NativeBridgeE2EE.
+ * Use `create(NativeBridgeE2EESchema)` to create a new message.
+ */
+export const NativeBridgeE2EESchema: GenMessage<NativeBridgeE2EE>;
+/**
+ * Used for PUBLISH/UNPUBLISH/MUTE/UNMUTE actions (web -> native).
+ *
+ * @generated from message plugnmeet.NativeBridgeMediaSource
+ */
+export type NativeBridgeMediaSource = Message<"plugnmeet.NativeBridgeMediaSource"> & {
+    /**
+     * @generated from field: plugnmeet.NativeMediaSource source = 1;
+     */
+    source: NativeMediaSource;
+};
+/**
+ * Describes the message plugnmeet.NativeBridgeMediaSource.
+ * Use `create(NativeBridgeMediaSourceSchema)` to create a new message.
+ */
+export const NativeBridgeMediaSourceSchema: GenMessage<NativeBridgeMediaSource>;
+/**
+ * Unix milliseconds.
+ *
+ * @generated from message plugnmeet.NativeBridgeHeartbeat
+ */
+export type NativeBridgeHeartbeat = Message<"plugnmeet.NativeBridgeHeartbeat"> & {
+    /**
+     * @generated from field: int64 ts = 1 [jstype = JS_STRING];
+     */
+    ts: string;
+};
+/**
+ * Describes the message plugnmeet.NativeBridgeHeartbeat.
+ * Use `create(NativeBridgeHeartbeatSchema)` to create a new message.
+ */
+export const NativeBridgeHeartbeatSchema: GenMessage<NativeBridgeHeartbeat>;
+/**
+ * Native -> web: action confirmation or error report.
+ *
+ * @generated from message plugnmeet.NativeBridgeMediaStatus
+ */
+export type NativeBridgeMediaStatus = Message<"plugnmeet.NativeBridgeMediaStatus"> & {
+    /**
+     * @generated from field: plugnmeet.NativeMediaSource source = 1;
+     */
+    source: NativeMediaSource;
+    /**
+     * @generated from field: optional string device_id = 2;
+     */
+    deviceId?: string | undefined;
+    /**
+     * @generated from field: optional string error = 3;
+     */
+    error?: string | undefined;
+};
+/**
+ * Describes the message plugnmeet.NativeBridgeMediaStatus.
+ * Use `create(NativeBridgeMediaStatusSchema)` to create a new message.
+ */
+export const NativeBridgeMediaStatusSchema: GenMessage<NativeBridgeMediaStatus>;
+/**
+ * Native -> web: track published/unpublished notification.
+ *
+ * @generated from message plugnmeet.NativeBridgeTrackState
+ */
+export type NativeBridgeTrackState = Message<"plugnmeet.NativeBridgeTrackState"> & {
+    /**
+     * @generated from field: string user_id = 1;
+     */
+    userId: string;
+    /**
+     * @generated from field: plugnmeet.NativeTrackKind kind = 2;
+     */
+    kind: NativeTrackKind;
+    /**
+     * @generated from field: plugnmeet.NativeMediaSource source = 3;
+     */
+    source: NativeMediaSource;
+};
+/**
+ * Describes the message plugnmeet.NativeBridgeTrackState.
+ * Use `create(NativeBridgeTrackStateSchema)` to create a new message.
+ */
+export const NativeBridgeTrackStateSchema: GenMessage<NativeBridgeTrackState>;
+/**
+ * Native -> web: mute state confirmation.
+ *
+ * @generated from message plugnmeet.NativeBridgeMediaMuted
+ */
+export type NativeBridgeMediaMuted = Message<"plugnmeet.NativeBridgeMediaMuted"> & {
+    /**
+     * @generated from field: plugnmeet.NativeMediaSource source = 1;
+     */
+    source: NativeMediaSource;
+    /**
+     * @generated from field: bool muted = 2;
+     */
+    muted: boolean;
+};
+/**
+ * Describes the message plugnmeet.NativeBridgeMediaMuted.
+ * Use `create(NativeBridgeMediaMutedSchema)` to create a new message.
+ */
+export const NativeBridgeMediaMutedSchema: GenMessage<NativeBridgeMediaMuted>;
+/**
+ * @generated from enum plugnmeet.NativeBridgeActions
+ */
+export enum NativeBridgeActions {
+    /**
+     * @generated from enum value: NATIVE_BRIDGE_ACTION_UNSPECIFIED = 0;
+     */
+    NATIVE_BRIDGE_ACTION_UNSPECIFIED = 0,
+    /**
+     * web app -> native host
+     *
+     * @generated from enum value: INITIALIZE_NATIVE_PUBLISHER = 1;
+     */
+    INITIALIZE_NATIVE_PUBLISHER = 1,
+    /**
+     * @generated from enum value: PUBLISH_NATIVE_MEDIA = 2;
+     */
+    PUBLISH_NATIVE_MEDIA = 2,
+    /**
+     * @generated from enum value: UNPUBLISH_NATIVE_MEDIA = 3;
+     */
+    UNPUBLISH_NATIVE_MEDIA = 3,
+    /**
+     * @generated from enum value: MUTE_NATIVE_MEDIA = 4;
+     */
+    MUTE_NATIVE_MEDIA = 4,
+    /**
+     * @generated from enum value: UNMUTE_NATIVE_MEDIA = 5;
+     */
+    UNMUTE_NATIVE_MEDIA = 5,
+    /**
+     * @generated from enum value: TEARDOWN_NATIVE_PUBLISHER = 6;
+     */
+    TEARDOWN_NATIVE_PUBLISHER = 6,
+    /**
+     * @generated from enum value: NATIVE_HEARTBEAT_PING = 7;
+     */
+    NATIVE_HEARTBEAT_PING = 7,
+    /**
+     * native host -> web app
+     *
+     * @generated from enum value: NATIVE_MEDIA_STATUS = 20;
+     */
+    NATIVE_MEDIA_STATUS = 20,
+    /**
+     * @generated from enum value: NATIVE_TRACK_PUBLISHED = 21;
+     */
+    NATIVE_TRACK_PUBLISHED = 21,
+    /**
+     * @generated from enum value: NATIVE_TRACK_UNPUBLISHED = 22;
+     */
+    NATIVE_TRACK_UNPUBLISHED = 22,
+    /**
+     * @generated from enum value: NATIVE_MEDIA_MUTED = 23;
+     */
+    NATIVE_MEDIA_MUTED = 23,
+    /**
+     * @generated from enum value: NATIVE_HEARTBEAT_PONG = 24;
+     */
+    NATIVE_HEARTBEAT_PONG = 24
+}
+/**
+ * Describes the enum plugnmeet.NativeBridgeActions.
+ */
+export const NativeBridgeActionsSchema: GenEnum<NativeBridgeActions>;
+/**
+ * @generated from enum plugnmeet.NativeMediaSource
+ */
+export enum NativeMediaSource {
+    /**
+     * @generated from enum value: NATIVE_MEDIA_SOURCE_UNSPECIFIED = 0;
+     */
+    NATIVE_MEDIA_SOURCE_UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: MIC = 1;
+     */
+    MIC = 1,
+    /**
+     * @generated from enum value: WEBCAM = 2;
+     */
+    WEBCAM = 2,
+    /**
+     * @generated from enum value: SCREENSHARE = 3;
+     */
+    SCREENSHARE = 3
+}
+/**
+ * Describes the enum plugnmeet.NativeMediaSource.
+ */
+export const NativeMediaSourceSchema: GenEnum<NativeMediaSource>;
+/**
+ * @generated from enum plugnmeet.NativeTrackKind
+ */
+export enum NativeTrackKind {
+    /**
+     * @generated from enum value: NATIVE_TRACK_KIND_UNSPECIFIED = 0;
+     */
+    NATIVE_TRACK_KIND_UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: AUDIO = 1;
+     */
+    AUDIO = 1,
+    /**
+     * @generated from enum value: VIDEO = 2;
+     */
+    VIDEO = 2
+}
+/**
+ * Describes the enum plugnmeet.NativeTrackKind.
+ */
+export const NativeTrackKindSchema: GenEnum<NativeTrackKind>;
 /**
  * Describes the file plugnmeet_polls.proto.
  */