@4players/odin-common 1.7.0 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.7.1
+
+- Update `TokenSubjectSchema` with additional subjects for gateway management apis
+
 ## 1.7.0
 
 - Added `MinDBFS`

package/lib/cjs/schema/media.js

@@ -6,11 +6,13 @@ exports.MediaIdSchema = z.number();
 exports.MediaAudioPropertiesSchema = z.object({
     kind: z.optional(z.literal('audio')),
     uid: z.optional(z.string()),
+    customType: z.optional(z.string()),
 });
 exports.MediaVideoPropertiesSchema = z.object({
     kind: z.optional(z.literal('video')),
     codec: z.optional(z.string()),
     uid: z.optional(z.string()),
+    customType: z.optional(z.string()),
 });
 exports.MediaPropertiesSchema = z.union([
     exports.MediaAudioPropertiesSchema,

package/lib/cjs/schema/token.js

@@ -1,17 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.oneOrMany = exports.TokenClaimsSchema = exports.TokenAudienceSchema = exports.TokenSubjectSchema = void 0;
+exports.oneOrMany = exports.TokenClaimsSchema = exports.TokenSubjectSchema = exports.TokenAudienceSchema = void 0;
 const zod_1 = require("zod");
-exports.TokenSubjectSchema = zod_1.z.enum(['connect']);
 exports.TokenAudienceSchema = zod_1.z.enum(['sfu', 'gateway']);
+exports.TokenSubjectSchema = zod_1.z.enum([
+    'connect',
+    'roomclose',
+    'roomupdate',
+    'roombanclient',
+    'roomsendmessage',
+]);
 exports.TokenClaimsSchema = zod_1.z.object({
     uid: zod_1.z.string(),
     cid: zod_1.z.optional(zod_1.z.string()),
     rid: oneOrMany(zod_1.z.string()),
     nsp: zod_1.z.optional(zod_1.z.string()),
     adr: zod_1.z.optional(zod_1.z.string()),
-    sub: zod_1.z.optional(oneOrMany(exports.TokenSubjectSchema)),
     aud: zod_1.z.optional(oneOrMany(exports.TokenAudienceSchema)),
+    sub: zod_1.z.optional(oneOrMany(exports.TokenSubjectSchema)),
     exp: zod_1.z.optional(zod_1.z.number()),
     nbf: zod_1.z.optional(zod_1.z.number()),
     ups: zod_1.z.optional(zod_1.z.string()),

package/lib/esm/schema/media.js

@@ -3,11 +3,13 @@ export const MediaIdSchema = z.number();
 export const MediaAudioPropertiesSchema = z.object({
     kind: z.optional(z.literal('audio')),
     uid: z.optional(z.string()),
+    customType: z.optional(z.string()),
 });
 export const MediaVideoPropertiesSchema = z.object({
     kind: z.optional(z.literal('video')),
     codec: z.optional(z.string()),
     uid: z.optional(z.string()),
+    customType: z.optional(z.string()),
 });
 export const MediaPropertiesSchema = z.union([
     MediaAudioPropertiesSchema,

package/lib/esm/schema/token.js

@@ -1,14 +1,20 @@
 import { z } from 'zod';
-export const TokenSubjectSchema = z.enum(['connect']);
 export const TokenAudienceSchema = z.enum(['sfu', 'gateway']);
+export const TokenSubjectSchema = z.enum([
+    'connect',
+    'roomclose',
+    'roomupdate',
+    'roombanclient',
+    'roomsendmessage',
+]);
 export const TokenClaimsSchema = z.object({
     uid: z.string(),
     cid: z.optional(z.string()),
     rid: oneOrMany(z.string()),
     nsp: z.optional(z.string()),
     adr: z.optional(z.string()),
-    sub: z.optional(oneOrMany(TokenSubjectSchema)),
     aud: z.optional(oneOrMany(TokenAudienceSchema)),
+    sub: z.optional(oneOrMany(TokenSubjectSchema)),
     exp: z.optional(z.number()),
     nbf: z.optional(z.number()),
     ups: z.optional(z.string()),

package/lib/plugin/api.d.ts

@@ -9,6 +9,8 @@ export declare namespace Backend {
         joinRoom(parameters: JoinRoomParameters): Room;
         createAudioPlayback(parameters: CreateAudioPlaybackParameters): Promise<AudioPlayback>;
         createAudioCapture(parameters: CreateAudioCaptureParameters): Promise<AudioCapture>;
+        createVideoCapture(ms: MediaStream, customType?: string): Promise<VideoCapture>;
+        createVideoPlayback(parameters: CreateVideoPlaybackParameters): Promise<VideoPlayback>;
         enumerateDevices(): Promise<Array<Device>>;
         setOutputVolume(volume: Volume): void;
         setOutputDevice(device: DeviceParameters): Promise<void>;
@@ -37,11 +39,12 @@ export declare namespace Backend {
     }
     interface Room {
         request(method: string, properties: unknown): Promise<unknown>;
-        link(media: Media): void;
+        link(media: Media): Promise<void>;
         unlink(media: Media): void;
         close(): void;
     }
     interface Media {
+        readonly customType?: string;
         close(): void;
     }
     interface AudioMedia extends Media {
@@ -52,6 +55,11 @@ export declare namespace Backend {
     interface CreateAudioPlaybackParameters {
         readonly uid: UID;
         readonly volume?: Volume;
+        readonly customType?: string;
+    }
+    interface CreateVideoPlaybackParameters {
+        readonly uid: UID;
+        readonly customType?: string;
     }
     interface AudioPlayback extends AudioMedia {
         readonly uid: UID;
@@ -68,6 +76,14 @@ export declare namespace Backend {
         setApm(config: ApmConfig): void;
         setDevice(device: DeviceParameters): void;
     }
+    interface VideoCapture extends Media {
+        mediaStream?: MediaStream;
+        setDevice(ms: MediaStream): Promise<void>;
+    }
+    interface VideoPlayback extends Media {
+        readonly mediaStream?: MediaStream;
+        readonly uid: UID;
+    }
     type Volume = number | 'muted';
     interface VadConfig {
         voiceActivity?: SensitivityRange;

package/lib/rpc/commands.d.ts

@@ -112,57 +112,71 @@ export declare const RoomCommandsRpc: {
             properties: z.ZodUnion<[z.ZodObject<{
                 kind: z.ZodOptional<z.ZodLiteral<"audio">>;
                 uid: z.ZodOptional<z.ZodString>;
+                customType: z.ZodOptional<z.ZodString>;
             }, "strip", z.ZodTypeAny, {
                 kind?: "audio" | undefined;
                 uid?: string | undefined;
+                customType?: string | undefined;
             }, {
                 kind?: "audio" | undefined;
                 uid?: string | undefined;
+                customType?: string | undefined;
             }>, z.ZodObject<{
                 kind: z.ZodOptional<z.ZodLiteral<"video">>;
                 codec: z.ZodOptional<z.ZodString>;
                 uid: z.ZodOptional<z.ZodString>;
+                customType: z.ZodOptional<z.ZodString>;
             }, "strip", z.ZodTypeAny, {
                 kind?: "video" | undefined;
                 codec?: string | undefined;
                 uid?: string | undefined;
+                customType?: string | undefined;
             }, {
                 kind?: "video" | undefined;
                 codec?: string | undefined;
                 uid?: string | undefined;
+                customType?: string | undefined;
             }>]>;
         }, "strip", z.ZodTypeAny, {
             properties: ({
                 kind?: "audio" | undefined;
                 uid?: string | undefined;
+                customType?: string | undefined;
             } | {
                 kind?: "video" | undefined;
                 codec?: string | undefined;
                 uid?: string | undefined;
+                customType?: string | undefined;
             }) & ({
                 kind?: "audio" | undefined;
                 uid?: string | undefined;
+                customType?: string | undefined;
             } | {
                 kind?: "video" | undefined;
                 codec?: string | undefined;
                 uid?: string | undefined;
+                customType?: string | undefined;
             } | undefined);
             media_id: number;
         }, {
             properties: ({
                 kind?: "audio" | undefined;
                 uid?: string | undefined;
+                customType?: string | undefined;
             } | {
                 kind?: "video" | undefined;
                 codec?: string | undefined;
                 uid?: string | undefined;
+                customType?: string | undefined;
             }) & ({
                 kind?: "audio" | undefined;
                 uid?: string | undefined;
+                customType?: string | undefined;
             } | {
                 kind?: "video" | undefined;
                 codec?: string | undefined;
                 uid?: string | undefined;
+                customType?: string | undefined;
             } | undefined);
             media_id: number;
         }>;