@4players/odin-common 1.6.1 → 1.7.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 1.7.1
+
+- Update `TokenSubjectSchema` with additional subjects for gateway management apis
+
+## 1.7.0
+
+- Added `MinDBFS`
+- Renamed `MainNotificationsSchema` to `MainNotificationSchema`
+- Renamed `RoomNotificationsSchema` to `RoomNotificationSchema`
+
 ## 1.6.1
 
 - Re-added `msgpackEncode` and `msgpackDecode`

package/lib/cjs/plugin/api.js

@@ -1,2 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MinDBFS = void 0;
+exports.MinDBFS = -758.596;

package/lib/cjs/rpc/commands.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RoomCommandsRpc = exports.MainCommandsRpc = void 0;
-const z = require("zod");
+const zod_1 = require("zod");
 const serialization_1 = require("../schema/serialization");
 const room_1 = require("../schema/room");
 const peer_1 = require("../schema/peer");
@@ -9,72 +9,72 @@ const media_1 = require("../schema/media");
 const webrtc_1 = require("../schema/webrtc");
 exports.MainCommandsRpc = {
     JoinRoom: {
-        request: z.object({
-            token: z.string(),
+        request: zod_1.z.object({
+            token: zod_1.z.string(),
             room_id: room_1.RoomIdSchema,
             user_data: serialization_1.ByteArraySchema,
             position: peer_1.PeerPositionSchema,
         }),
-        response: z.object({
+        response: zod_1.z.object({
             peer_id: peer_1.PeerIdSchema,
-            stream_id: z.optional(z.number()),
-            token: z.optional(z.string()),
+            stream_id: zod_1.z.optional(zod_1.z.number()),
+            token: zod_1.z.optional(zod_1.z.string()),
         }),
     },
     WebRtcUpdate: {
         request: webrtc_1.WebRtcUpdateSchema,
-        response: z.null(),
+        response: zod_1.z.null(),
     },
     RequestReconnectToken: {
-        request: z.object({ peer_id: z.optional(peer_1.PeerIdSchema) }),
-        response: z.string(),
+        request: zod_1.z.object({ peer_id: zod_1.z.optional(peer_1.PeerIdSchema) }),
+        response: zod_1.z.string(),
     },
     Ping: {
-        request: z.object({}),
-        response: z.null(),
+        request: zod_1.z.object({}),
+        response: zod_1.z.null(),
     },
 };
 exports.RoomCommandsRpc = {
     UpdatePeer: {
-        request: z.object({ user_data: serialization_1.ByteArraySchema }),
-        response: z.null(),
+        request: zod_1.z.object({ user_data: serialization_1.ByteArraySchema }),
+        response: zod_1.z.null(),
     },
     StartMedia: {
-        request: z.object({
+        request: zod_1.z.object({
             media_id: media_1.MediaIdSchema,
             properties: media_1.MediaPropertiesSchema,
         }),
-        response: z.null(),
+        response: zod_1.z.null(),
     },
     StopMedia: {
-        request: z.object({
+        request: zod_1.z.object({
             media_id: media_1.MediaIdSchema,
         }),
-        response: z.null(),
+        response: zod_1.z.null(),
     },
     PauseMedia: {
-        request: z.object({
+        request: zod_1.z.object({
             media_id: media_1.MediaIdSchema,
         }),
-        response: z.null(),
+        response: zod_1.z.null(),
     },
     ResumeMedia: {
-        request: z.object({
+        request: zod_1.z.object({
             media_id: media_1.MediaIdSchema,
         }),
-        response: z.null(),
+        response: zod_1.z.null(),
     },
     SetPeerPosition: {
-        request: z.object({
+        request: zod_1.z.object({
             position: peer_1.PeerPositionSchema,
         }),
-        response: z.null(),
+        response: zod_1.z.null(),
     },
     SendMessage: {
-        request: z.object({
-            target_peer_ids: z.optional(z.array(peer_1.PeerIdSchema)),
+        request: zod_1.z.object({
+            target_peer_ids: zod_1.z.optional(zod_1.z.array(peer_1.PeerIdSchema)),
             message: serialization_1.ByteArraySchema,
         }),
-        response: z.null(),
+        response: zod_1.z.null(),
     },
 };

package/lib/cjs/rpc/notifications.js

@@ -1,19 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RoomNotificationsRpc = exports.RoomNotificationsSchema = exports.MainNotificationsRpc = exports.MainNotificationsSchema = void 0;
+exports.RoomNotificationsRpc = exports.RoomNotificationSchema = exports.MainNotificationsRpc = exports.MainNotificationSchema = void 0;
 const z = require("zod");
 const room_1 = require("../schema/room");
 const peer_1 = require("../schema/peer");
 const message_1 = require("../schema/message");
 const webrtc_1 = require("../schema/webrtc");
-exports.MainNotificationsSchema = z.object({
+exports.MainNotificationSchema = z.object({
     name: z.literal('WebRtcUpdate'),
     properties: webrtc_1.WebRtcUpdateSchema,
 });
 exports.MainNotificationsRpc = {
     WebRtcUpdate: webrtc_1.WebRtcUpdateSchema,
 };
-exports.RoomNotificationsSchema = z.union([
+exports.RoomNotificationSchema = z.union([
     z.object({
         name: z.literal('RoomStatusChanged'),
         properties: room_1.RoomStatusChangedSchema,

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/plugin/api.js

@@ -1 +1 @@
-export {};
+export const MinDBFS = -758.596;

package/lib/esm/rpc/commands.js

@@ -1,4 +1,4 @@
-import * as z from 'zod';
+import { z } from 'zod';
 import { ByteArraySchema } from '../schema/serialization';
 import { RoomIdSchema } from '../schema/room';
 import { PeerIdSchema, PeerPositionSchema } from '../schema/peer';

package/lib/esm/rpc/notifications.js

@@ -3,14 +3,14 @@ import { RoomStatusChangedSchema, RoomUpdatesSchema } from '../schema/room';
 import { PeerUpdateSchema } from '../schema/peer';
 import { MessageReceivedSchema } from '../schema/message';
 import { WebRtcUpdateSchema } from '../schema/webrtc';
-export const MainNotificationsSchema = z.object({
+export const MainNotificationSchema = z.object({
     name: z.literal('WebRtcUpdate'),
     properties: WebRtcUpdateSchema,
 });
 export const MainNotificationsRpc = {
     WebRtcUpdate: WebRtcUpdateSchema,
 };
-export const RoomNotificationsSchema = z.union([
+export const RoomNotificationSchema = z.union([
     z.object({
         name: z.literal('RoomStatusChanged'),
         properties: RoomStatusChangedSchema,

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

@@ -1,3 +1,4 @@
+export declare const MinDBFS = -758.596;
 export declare namespace Backend {
     type UID = string;
     type OnStatusChanged = (status: 'started' | 'stopped') => void;

package/lib/rpc/commands.d.ts

@@ -1,4 +1,5 @@
-import * as z from 'zod';
+import { z, infer } from 'zod';
+export type { infer as Infer };
 export type Commands = Record<string, {
     request: z.ZodTypeAny;
     response: z.ZodTypeAny;

package/lib/rpc/notifications.d.ts

@@ -1,6 +1,6 @@
 import * as z from 'zod';
 export type Notifications = Record<string, z.ZodTypeAny>;
-export declare const MainNotificationsSchema: z.ZodObject<{
+export declare const MainNotificationSchema: z.ZodObject<{
     name: z.ZodLiteral<"WebRtcUpdate">;
     properties: z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
         kind: z.ZodLiteral<"Sdp">;
@@ -75,6 +75,7 @@ export declare const MainNotificationsSchema: z.ZodObject<{
     };
     name: "WebRtcUpdate";
 }>;
+export type MainNotification = z.infer<typeof MainNotificationSchema>;
 export declare const MainNotificationsRpc: {
     WebRtcUpdate: z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
         kind: z.ZodLiteral<"Sdp">;
@@ -118,7 +119,7 @@ export declare const MainNotificationsRpc: {
     }>]>;
 };
 export type MainNotifications = typeof MainNotificationsRpc;
-export declare const RoomNotificationsSchema: z.ZodUnion<[z.ZodObject<{
+export declare const RoomNotificationSchema: z.ZodUnion<[z.ZodObject<{
     name: z.ZodLiteral<"RoomStatusChanged">;
     properties: z.ZodObject<{
         status: z.ZodEnum<["Joining", "Joined", "Closed"]>;
@@ -1098,6 +1099,7 @@ export declare const RoomNotificationsSchema: z.ZodUnion<[z.ZodObject<{
     };
     name: "MessageReceived";
 }>]>;
+export type RoomNotification = z.infer<typeof RoomNotificationSchema>;
 export declare const RoomNotificationsRpc: {
     RoomStatusChanged: z.ZodObject<{
         status: z.ZodEnum<["Joining", "Joined", "Closed"]>;

package/lib/schema/token.d.ts

@@ -1,14 +1,14 @@
 import { z } from 'zod';
-export declare const TokenSubjectSchema: z.ZodEnum<["connect"]>;
 export declare const TokenAudienceSchema: z.ZodEnum<["sfu", "gateway"]>;
+export declare const TokenSubjectSchema: z.ZodEnum<["connect", "roomclose", "roomupdate", "roombanclient", "roomsendmessage"]>;
 export declare const TokenClaimsSchema: z.ZodObject<{
     uid: z.ZodString;
     cid: z.ZodOptional<z.ZodString>;
     rid: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
     nsp: z.ZodOptional<z.ZodString>;
     adr: z.ZodOptional<z.ZodString>;
-    sub: z.ZodOptional<z.ZodUnion<[z.ZodEnum<["connect"]>, z.ZodArray<z.ZodEnum<["connect"]>, "many">]>>;
     aud: z.ZodOptional<z.ZodUnion<[z.ZodEnum<["sfu", "gateway"]>, z.ZodArray<z.ZodEnum<["sfu", "gateway"]>, "many">]>>;
+    sub: z.ZodOptional<z.ZodUnion<[z.ZodEnum<["connect", "roomclose", "roomupdate", "roombanclient", "roomsendmessage"]>, z.ZodArray<z.ZodEnum<["connect", "roomclose", "roomupdate", "roombanclient", "roomsendmessage"]>, "many">]>>;
     exp: z.ZodOptional<z.ZodNumber>;
     nbf: z.ZodOptional<z.ZodNumber>;
     ups: z.ZodOptional<z.ZodString>;
@@ -25,8 +25,8 @@ export declare const TokenClaimsSchema: z.ZodObject<{
     cid?: string | undefined;
     nsp?: string | undefined;
     adr?: string | undefined;
-    sub?: "connect" | "connect"[] | undefined;
     aud?: "sfu" | "gateway" | ("sfu" | "gateway")[] | undefined;
+    sub?: "connect" | "roomclose" | "roomupdate" | "roombanclient" | "roomsendmessage" | ("connect" | "roomclose" | "roomupdate" | "roombanclient" | "roomsendmessage")[] | undefined;
     exp?: number | undefined;
     nbf?: number | undefined;
     ups?: string | undefined;
@@ -39,8 +39,8 @@ export declare const TokenClaimsSchema: z.ZodObject<{
     cid?: string | undefined;
     nsp?: string | undefined;
     adr?: string | undefined;
-    sub?: "connect" | "connect"[] | undefined;
     aud?: "sfu" | "gateway" | ("sfu" | "gateway")[] | undefined;
+    sub?: "connect" | "roomclose" | "roomupdate" | "roombanclient" | "roomsendmessage" | ("connect" | "roomclose" | "roomupdate" | "roombanclient" | "roomsendmessage")[] | undefined;
     exp?: number | undefined;
     nbf?: number | undefined;
     ups?: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4players/odin-common",
-  "version": "1.6.1",
+  "version": "1.7.1",
   "description": "A collection of commonly used type definitions and utility functions across ODIN web projects",
   "author": "Josho Bleicker <josho.bleicker@4players.io> (https://www.4players.io)",
   "homepage": "https://www.4players.io",
@@ -32,8 +32,8 @@
   "devDependencies": {
     "@types/node": "~20.11.0",
     "@types/uuid": "~9.0.0",
-    "@typescript-eslint/eslint-plugin": "~7.1.0",
-    "@typescript-eslint/parser": "~7.1.0",
+    "@typescript-eslint/eslint-plugin": "~7.3.0",
+    "@typescript-eslint/parser": "~7.3.0",
     "eslint": "~8.57.0",
     "eslint-config-semistandard": "~17.0.0",
     "eslint-plugin-import": "~2.29.0",