livekit-client 2.18.0 → 2.18.2

package/src/utils/serializer.ts

@@ -0,0 +1,72 @@
+const SerializerSymbol = Symbol.for('lk.serializer');
+
+/**
+ * A bidirectional data format descriptor for message payloads.
+ *
+ * - `parse(raw)` decodes an incoming wire string into `Input` (used by handlers)
+ * - `serialize(val)` encodes an `Output` value to a wire string (used by handlers)
+ *
+ * For symmetric serializers (`serializers.raw`), `Input === Output === string`.
+ * For `serializers.json`, both default to `any` so each handler can annotate its own types.
+ * Use `serializers.custom` to supply your own `parse`/`serialize` pair.
+ *
+ * @beta
+ */
+export type Serializer<Input, Output> = {
+  symbol: typeof SerializerSymbol;
+  parse: (raw: string) => Input;
+  serialize: (val: Output) => string;
+};
+
+export function isSerializer(v: unknown): v is Serializer<any, any> {
+  return typeof v === 'object' && v !== null && 'symbol' in v && v.symbol === SerializerSymbol;
+}
+
+export type SerializerInput<S> = S extends Serializer<infer Input, any> ? Input : any;
+export type SerializerOutput<S> = S extends Serializer<any, infer Output> ? Output : any;
+
+/** @internal */
+function base<Input = any, Output = any>(
+  params: Omit<Serializer<Input, Output>, 'symbol'>,
+): Serializer<Input, Output> {
+  return { ...params, symbol: SerializerSymbol };
+}
+
+/**
+ * JSON serializer — `JSON.parse` on the way in, `JSON.stringify` on the way out.
+ * Defaults to `any` so individual handlers can annotate their own payload types.
+ */
+function json<Input = any, Output = any>(): Serializer<Input, Output> {
+  return base({
+    parse: (rawString: string) => JSON.parse(rawString) as Input,
+    serialize: (val: unknown) => JSON.stringify(val),
+  });
+}
+
+/** Raw string serializer — passes payloads through as plain strings with no encoding. */
+function raw() {
+  return base({
+    parse: (rawString: string) => rawString,
+    serialize: (val: string) => val,
+  });
+}
+
+/** Custom serializer - allows custom defined parse and serialize functions */
+function custom<Input = any, Output = any>(
+  params: Omit<Serializer<Input, Output>, 'symbol'>,
+): Serializer<Input, Output> {
+  return base(params);
+}
+
+/**
+ * Serializer helpers for message payload encoding.
+ *
+ * @example
+ * ```ts
+ * const a = serializers.raw(); // Serializer<string, string>
+ * const b = serializer.json<{ foo: string }, { bar: string }>(); // Serializer<{ foo: string }, { bar: string }>
+ * ```
+ *
+ * @beta
+ */
+export const serializers = { json, raw, custom };

package/dist/src/room/data-track/e2ee.d.ts

@@ -1,12 +0,0 @@
-export type EncryptedPayload = {
-    payload: Uint8Array;
-    iv: Uint8Array;
-    keyIndex: number;
-};
-export type EncryptionProvider = {
-    encrypt(payload: Uint8Array): EncryptedPayload;
-};
-export type DecryptionProvider = {
-    decrypt(payload: EncryptedPayload, senderIdentity: string): Uint8Array;
-};
-//# sourceMappingURL=e2ee.d.ts.map

package/dist/src/room/data-track/e2ee.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"e2ee.d.ts","sourceRoot":"","sources":["../../../../src/room/data-track/e2ee.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,UAAU,CAAC;IACpB,EAAE,EAAE,UAAU,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAE/B,OAAO,CAAC,OAAO,EAAE,UAAU,GAAG,gBAAgB,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAE/B,OAAO,CAAC,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,GAAG,UAAU,CAAC;CACxE,CAAC"}

package/dist/ts4.2/room/data-track/e2ee.d.ts

@@ -1,12 +0,0 @@
-export type EncryptedPayload = {
-    payload: Uint8Array;
-    iv: Uint8Array;
-    keyIndex: number;
-};
-export type EncryptionProvider = {
-    encrypt(payload: Uint8Array): EncryptedPayload;
-};
-export type DecryptionProvider = {
-    decrypt(payload: EncryptedPayload, senderIdentity: string): Uint8Array;
-};
-//# sourceMappingURL=e2ee.d.ts.map

package/src/room/data-track/e2ee.ts

@@ -1,15 +0,0 @@
-export type EncryptedPayload = {
-  payload: Uint8Array;
-  iv: Uint8Array; // NOTE: should be 12 bytes long
-  keyIndex: number;
-};
-
-export type EncryptionProvider = {
-  // FIXME: add in explicit `Throws<..., EncryptionError>`?
-  encrypt(payload: Uint8Array): EncryptedPayload;
-};
-
-export type DecryptionProvider = {
-  // FIXME: add in explicit `Throws<..., DecryptionError>`?
-  decrypt(payload: EncryptedPayload, senderIdentity: string): Uint8Array;
-};