@memberjunction/livekit-room-core 0.0.1 → 5.42.0

package/dist/types.d.ts

@@ -0,0 +1,163 @@
+/**
+ * @fileoverview Framework-agnostic types for the LiveKit room core. These are the vocabulary the
+ * MJ-native realtime room UX binds to — deliberately free of any UI-framework or LiveKit SDK type in
+ * their *public* shape, so consumers (Angular, React, plain TS) program against a stable surface.
+ *
+ * The one intentional exception is {@link LiveKitParticipantView.Raw}, which carries the underlying
+ * livekit-client `Participant` so a UI layer can call `track.attach(element)` to render media — the SDK
+ * owns the DOM-attach mechanics and there is no value in re-implementing them.
+ *
+ * @module @memberjunction/livekit-room-core
+ */
+import type { Participant, RoomOptions, Track } from 'livekit-client';
+/**
+ * The connection lifecycle of a LiveKit room as the core normalizes it. Maps the livekit-client
+ * `ConnectionState` plus the pre-connect / post-disconnect edges into one stable union.
+ */
+export type LiveKitConnectionStatus = 'idle' | 'connecting' | 'connected' | 'reconnecting' | 'disconnected' | 'error';
+/** Why a room disconnected — normalized from the livekit-client `DisconnectReason`. */
+export type LiveKitDisconnectReason = 'client-initiated' | 'server-shutdown' | 'participant-removed' | 'room-deleted' | 'connection-lost' | 'duplicate-identity' | 'unknown';
+/** The role a participant holds in the room, derived from LiveKit participant metadata. */
+export type LiveKitParticipantRole = 'host' | 'agent' | 'participant';
+/** The kind of a media track, normalized from `Track.Kind`. */
+export type LiveKitTrackKind = 'audio' | 'video' | 'screen' | 'screen-audio' | 'unknown';
+/** A camera background effect (requires `@livekit/track-processors`). */
+export type LiveKitBackgroundEffect = {
+    Kind: 'none';
+} | {
+    Kind: 'blur';
+    Radius?: number;
+} | {
+    Kind: 'image';
+    ImageUrl: string;
+};
+/** End-to-end-encryption options. The host supplies the worker (bundler-specific) + a shared passphrase. */
+export interface LiveKitE2EEOptions {
+    /** The shared passphrase all participants derive the room key from. */
+    Passphrase: string;
+    /** The E2EE web worker (e.g. `new Worker(new URL('livekit-client/e2ee-worker', import.meta.url))`). */
+    Worker: Worker;
+}
+/**
+ * A normalized view of one room participant. This is what a UI grid renders — one tile per view.
+ * {@link Raw} is included so the UI can attach the participant's video/audio tracks to DOM elements.
+ */
+export interface LiveKitParticipantView {
+    /** Stable, application-assigned participant identity (the diarization / addressing key). */
+    Identity: string;
+    /** The participant's display name (`name`), when set; falls back to {@link Identity}. */
+    DisplayName: string;
+    /** Whether this is the local participant (the human running this client). */
+    IsLocal: boolean;
+    /** The participant's room role, derived from metadata (the agent bot reports as `'agent'`). */
+    Role: LiveKitParticipantRole;
+    /** Whether the participant is currently speaking (LiveKit voice-activity detection). */
+    IsSpeaking: boolean;
+    /** Smoothed audio level in 0..1 for meters, sourced from LiveKit's per-participant audio level. */
+    AudioLevel: number;
+    /** Whether the participant currently has a published, unmuted microphone track. */
+    HasAudio: boolean;
+    /** Whether the participant currently has a published, unmuted camera track. */
+    HasVideo: boolean;
+    /** Whether the participant is currently sharing their screen. */
+    IsScreenSharing: boolean;
+    /** Connection quality bucket as LiveKit reports it. */
+    ConnectionQuality: 'excellent' | 'good' | 'poor' | 'lost' | 'unknown';
+    /**
+     * The underlying livekit-client participant, exposed ONLY so a UI layer can attach media tracks
+     * (`view.Raw.getTrackPublication(...)?.track?.attach(el)`). Do not mutate it directly — drive the
+     * room through {@link import('./livekit-room-controller.js').LiveKitRoomController} instead.
+     */
+    Raw: Participant;
+}
+/** A message received on the LiveKit data channel (the room-native "chat" / app payload). */
+export interface LiveKitDataMessage {
+    /** The decoded text payload (UTF-8). For binary payloads use {@link Bytes}. */
+    Text: string;
+    /** The raw bytes as received (for non-text payloads). */
+    Bytes: Uint8Array;
+    /** The optional topic the message was published under. */
+    Topic?: string;
+    /** The sender's participant identity, when the message came from a remote participant. */
+    FromIdentity?: string;
+    /** The sender's display name, when known. */
+    FromDisplayName?: string;
+    /** Epoch-ms receive timestamp. */
+    ReceivedAt: number;
+}
+/** A normalized error surfaced by the room (connection failure, device error, publish failure). */
+export interface LiveKitRoomError {
+    /** A stable category for programmatic handling. */
+    Kind: 'connect' | 'device' | 'publish' | 'data' | 'disconnect' | 'unknown';
+    /** A human-readable message. */
+    Message: string;
+    /** The original error, when available. */
+    Cause?: unknown;
+}
+/** The current local-media toggle state (what the human is publishing). */
+export interface LiveKitLocalMediaState {
+    /** Whether the local microphone is enabled (publishing audio). */
+    MicrophoneEnabled: boolean;
+    /** Whether the local camera is enabled (publishing video). */
+    CameraEnabled: boolean;
+    /** Whether the local participant is sharing their screen. */
+    ScreenShareEnabled: boolean;
+}
+/** A media input/output device the user can pick (microphone, camera, speaker). */
+export interface LiveKitDevice {
+    /** The `deviceId` to pass to {@link import('./livekit-room-controller.js').LiveKitRoomController.SwitchDevice}. */
+    DeviceId: string;
+    /** The human-readable device label. */
+    Label: string;
+    /** The device kind. */
+    Kind: 'audioinput' | 'videoinput' | 'audiooutput';
+}
+/** Options for opening a room connection. */
+export interface LiveKitRoomConnectOptions {
+    /** Start with the microphone enabled (default: true). */
+    EnableMicrophone?: boolean;
+    /** Start with the camera enabled (default: false — voice-first). */
+    EnableCamera?: boolean;
+    /** The display name to publish as the local participant's `name`. */
+    DisplayName?: string;
+    /** Start with the Krisp noise filter enabled (LiveKit Cloud; requires `@livekit/krisp-noise-filter`). */
+    NoiseFilterEnabled?: boolean;
+    /** Start with a camera background effect (requires `@livekit/track-processors`). */
+    BackgroundEffect?: LiveKitBackgroundEffect;
+    /** Enable end-to-end encryption for this connection. */
+    E2EE?: LiveKitE2EEOptions;
+    /** Preferred microphone device id. */
+    MicrophoneDeviceId?: string;
+    /** Preferred camera device id. */
+    CameraDeviceId?: string;
+    /** Advanced livekit-client room options merged into the constructed `Room`. */
+    RoomOptions?: RoomOptions;
+}
+/** A snapshot of the whole room state, emitted whenever anything material changes. */
+export interface LiveKitRoomState {
+    /** The connection lifecycle status. */
+    Status: LiveKitConnectionStatus;
+    /** The room name once connected. */
+    RoomName?: string;
+    /** The local participant's view, once connected. */
+    Local?: LiveKitParticipantView;
+    /** All remote participants. */
+    Remote: LiveKitParticipantView[];
+    /** Identities currently flagged as active speakers, most-recent first. */
+    ActiveSpeakerIdentities: string[];
+    /** The local-media toggle state. */
+    LocalMedia: LiveKitLocalMediaState;
+    /** Whether browser autoplay policy is blocking remote audio (the UI should prompt to enable sound). */
+    AudioPlaybackBlocked: boolean;
+    /** Whether the Krisp noise filter is currently applied to the local microphone. */
+    NoiseFilterEnabled: boolean;
+    /** The active camera background effect. */
+    BackgroundEffect: LiveKitBackgroundEffect;
+    /** Whether end-to-end encryption is enabled for this connection. */
+    E2EEEnabled: boolean;
+    /** The reason for disconnect, once disconnected. */
+    DisconnectReason?: LiveKitDisconnectReason;
+}
+/** Maps a livekit-client `Track.Source` to a normalized {@link LiveKitTrackKind}. */
+export type LiveKitTrackSourceMapper = (source: Track.Source) => LiveKitTrackKind;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,cAAc,GAAG,OAAO,CAAC;AAEtH,uFAAuF;AACvF,MAAM,MAAM,uBAAuB,GAC/B,kBAAkB,GAClB,iBAAiB,GACjB,qBAAqB,GACrB,cAAc,GACd,iBAAiB,GACjB,oBAAoB,GACpB,SAAS,CAAC;AAEd,2FAA2F;AAC3F,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,OAAO,GAAG,aAAa,CAAC;AAEtE,+DAA+D;AAC/D,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,cAAc,GAAG,SAAS,CAAC;AAEzF,yEAAyE;AACzE,MAAM,MAAM,uBAAuB,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAEjI,4GAA4G;AAC5G,MAAM,WAAW,kBAAkB;IACjC,uEAAuE;IACvE,UAAU,EAAE,MAAM,CAAC;IACnB,uGAAuG;IACvG,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,4FAA4F;IAC5F,QAAQ,EAAE,MAAM,CAAC;IACjB,yFAAyF;IACzF,WAAW,EAAE,MAAM,CAAC;IACpB,6EAA6E;IAC7E,OAAO,EAAE,OAAO,CAAC;IACjB,+FAA+F;IAC/F,IAAI,EAAE,sBAAsB,CAAC;IAC7B,wFAAwF;IACxF,UAAU,EAAE,OAAO,CAAC;IACpB,mGAAmG;IACnG,UAAU,EAAE,MAAM,CAAC;IACnB,mFAAmF;IACnF,QAAQ,EAAE,OAAO,CAAC;IAClB,+EAA+E;IAC/E,QAAQ,EAAE,OAAO,CAAC;IAClB,iEAAiE;IACjE,eAAe,EAAE,OAAO,CAAC;IACzB,uDAAuD;IACvD,iBAAiB,EAAE,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACtE;;;;OAIG;IACH,GAAG,EAAE,WAAW,CAAC;CAClB;AAED,6FAA6F;AAC7F,MAAM,WAAW,kBAAkB;IACjC,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,yDAAyD;IACzD,KAAK,EAAE,UAAU,CAAC;IAClB,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0FAA0F;IAC1F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6CAA6C;IAC7C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kCAAkC;IAClC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,mGAAmG;AACnG,MAAM,WAAW,gBAAgB;IAC/B,mDAAmD;IACnD,IAAI,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,YAAY,GAAG,SAAS,CAAC;IAC3E,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,2EAA2E;AAC3E,MAAM,WAAW,sBAAsB;IACrC,kEAAkE;IAClE,iBAAiB,EAAE,OAAO,CAAC;IAC3B,8DAA8D;IAC9D,aAAa,EAAE,OAAO,CAAC;IACvB,6DAA6D;IAC7D,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,mFAAmF;AACnF,MAAM,WAAW,aAAa;IAC5B,gHAAgH;IAChH,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,IAAI,EAAE,YAAY,GAAG,YAAY,GAAG,aAAa,CAAC;CACnD;AAED,6CAA6C;AAC7C,MAAM,WAAW,yBAAyB;IACxC,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,oEAAoE;IACpE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qEAAqE;IACrE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yGAAyG;IACzG,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,oFAAoF;IACpF,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;IAC3C,wDAAwD;IACxD,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B,sCAAsC;IACtC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kCAAkC;IAClC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,sFAAsF;AACtF,MAAM,WAAW,gBAAgB;IAC/B,uCAAuC;IACvC,MAAM,EAAE,uBAAuB,CAAC;IAChC,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,+BAA+B;IAC/B,MAAM,EAAE,sBAAsB,EAAE,CAAC;IACjC,0EAA0E;IAC1E,uBAAuB,EAAE,MAAM,EAAE,CAAC;IAClC,oCAAoC;IACpC,UAAU,EAAE,sBAAsB,CAAC;IACnC,uGAAuG;IACvG,oBAAoB,EAAE,OAAO,CAAC;IAC9B,mFAAmF;IACnF,kBAAkB,EAAE,OAAO,CAAC;IAC5B,2CAA2C;IAC3C,gBAAgB,EAAE,uBAAuB,CAAC;IAC1C,oEAAoE;IACpE,WAAW,EAAE,OAAO,CAAC;IACrB,oDAAoD;IACpD,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;CAC5C;AAED,qFAAqF;AACrF,MAAM,MAAM,wBAAwB,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,KAAK,gBAAgB,CAAC"}

package/dist/types.js

@@ -0,0 +1,13 @@
+/**
+ * @fileoverview Framework-agnostic types for the LiveKit room core. These are the vocabulary the
+ * MJ-native realtime room UX binds to — deliberately free of any UI-framework or LiveKit SDK type in
+ * their *public* shape, so consumers (Angular, React, plain TS) program against a stable surface.
+ *
+ * The one intentional exception is {@link LiveKitParticipantView.Raw}, which carries the underlying
+ * livekit-client `Participant` so a UI layer can call `track.attach(element)` to render media — the SDK
+ * owns the DOM-attach mechanics and there is no value in re-implementing them.
+ *
+ * @module @memberjunction/livekit-room-core
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG"}

package/package.json

@@ -1,10 +1,33 @@
 {
   "name": "@memberjunction/livekit-room-core",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @memberjunction/livekit-room-core",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+  "type": "module",
+  "version": "5.42.0",
+  "description": "MemberJunction: Framework-agnostic LiveKit room client core. Pure TypeScript wrapper around livekit-client that manages a single room connection — participants, tracks, active speakers, audio levels, device control, and data-channel messages — and surfaces it as observable state. Zero UI dependencies; consumable from any framework (Angular, React, Vue) or plain TS. The MJ-native realtime room UX foundation.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "build": "tsc && tsc-alias -f",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "author": "MemberJunction.com",
+  "license": "ISC",
+  "dependencies": {
+    "@livekit/krisp-noise-filter": "^0.4.3",
+    "@livekit/track-processors": "^0.7.2",
+    "@memberjunction/global": "5.42.0",
+    "livekit-client": "^2.7.4",
+    "rxjs": "^7.8.2"
+  },
+  "devDependencies": {
+    "@types/node": "24.10.11",
+    "typescript": "^5.9.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MemberJunction/MJ"
+  }
 }