@4players/odin-common 2.4.1 → 2.4.3

package/lib/cjs/index.js

@@ -36,4 +36,5 @@ __exportStar(require("./utility/strand"), exports);
 __exportStar(require("./utility/url"), exports);
 __exportStar(require("./utility/uuid"), exports);
 __exportStar(require("./utility/validation"), exports);
+__exportStar(require("./utility/log"), exports);
 __exportStar(require("./plugin/api"), exports);

package/lib/cjs/rpc/commands.js

@@ -8,6 +8,12 @@ const peer_1 = require("../schema/peer");
 const media_1 = require("../schema/media");
 const webrtc_1 = require("../schema/webrtc");
 exports.MainCommandsRpc = {
+    Hello: {
+        request: zod_1.z.object({
+            stream: zod_1.z.literal('main'),
+        }),
+        response: zod_1.z.null(),
+    },
     JoinRoom: {
         request: zod_1.z.object({
             token: zod_1.z.string(),
@@ -35,6 +41,16 @@ exports.MainCommandsRpc = {
     },
 };
 exports.RoomCommandsRpc = {
+    Hello: {
+        request: zod_1.z.object({
+            stream: zod_1.z.literal('room'),
+            token: zod_1.z.string(),
+            room_id: zod_1.z.string(),
+            user_data: serialization_1.ByteArraySchema,
+            position: peer_1.PeerPositionSchema,
+        }),
+        response: zod_1.z.null(),
+    },
     UpdatePeer: {
         request: zod_1.z.object({ user_data: serialization_1.ByteArraySchema }),
         response: zod_1.z.null(),

package/lib/cjs/utility/log.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.log = exports.OdinError = void 0;
+class OdinError extends Error {
+    constructor(message = '', options) {
+        super(message);
+        this.message = message;
+        this.name = 'OdinError';
+        const date = new Date();
+        const hours = date.getHours();
+        const minutes = date.getMinutes();
+        const seconds = date.getSeconds();
+        if (options === null || options === void 0 ? void 0 : options.project) {
+            this.message = `ODIN ${options === null || options === void 0 ? void 0 : options.project} | ${options === null || options === void 0 ? void 0 : options.kind}`;
+        }
+        this.message += ` at ${options === null || options === void 0 ? void 0 : options.project} ${hours}:${minutes}:${seconds}\n`;
+        this.message += `${message}\n`;
+    }
+}
+exports.OdinError = OdinError;
+function log(message, options, filters = { projects: [], kind: [] }) {
+    for (const projectName of filters.projects) {
+        if (options.project === projectName) {
+            for (const kindName of filters.kind) {
+                if (options.kind === kindName) {
+                    let logMessage = '';
+                    const date = new Date();
+                    const hours = date.getHours();
+                    const minutes = date.getMinutes();
+                    const seconds = date.getSeconds();
+                    if (options === null || options === void 0 ? void 0 : options.project) {
+                        logMessage = `ODIN ${options === null || options === void 0 ? void 0 : options.project} | ${options === null || options === void 0 ? void 0 : options.kind}`;
+                    }
+                    logMessage += ` at ${options === null || options === void 0 ? void 0 : options.project} ${hours}:${minutes}:${seconds}\n`;
+                    logMessage += `${message}\n`;
+                    if (options.logType) {
+                        console[options.logType](logMessage);
+                    }
+                    else {
+                        console.log(logMessage);
+                    }
+                }
+            }
+        }
+    }
+}
+exports.log = log;

package/lib/cjs/utility/result.js

@@ -2,14 +2,15 @@
 /* eslint-disable no-redeclare */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.unwrap = exports.failure = exports.success = exports.fail = exports.assert = void 0;
+const log_1 = require("./log");
 function assert(condition, message) {
     if (!condition) {
         fail(message);
     }
 }
 exports.assert = assert;
-function fail(message) {
-    throw new Error(message);
+function fail(message, options) {
+    throw new log_1.OdinError(message, options);
 }
 exports.fail = fail;
 function success(value) {

package/lib/esm/index.js

@@ -20,4 +20,5 @@ export * from './utility/strand';
 export * from './utility/url';
 export * from './utility/uuid';
 export * from './utility/validation';
+export * from './utility/log';
 export * from './plugin/api';

package/lib/esm/rpc/commands.js

@@ -5,6 +5,12 @@ import { PeerIdSchema, PeerPositionSchema } from '../schema/peer';
 import { MediaIdSchema, MediaPropertiesSchema } from '../schema/media';
 import { WebRtcUpdateSchema } from '../schema/webrtc';
 export const MainCommandsRpc = {
+    Hello: {
+        request: z.object({
+            stream: z.literal('main'),
+        }),
+        response: z.null(),
+    },
     JoinRoom: {
         request: z.object({
             token: z.string(),
@@ -32,6 +38,16 @@ export const MainCommandsRpc = {
     },
 };
 export const RoomCommandsRpc = {
+    Hello: {
+        request: z.object({
+            stream: z.literal('room'),
+            token: z.string(),
+            room_id: z.string(),
+            user_data: ByteArraySchema,
+            position: PeerPositionSchema,
+        }),
+        response: z.null(),
+    },
     UpdatePeer: {
         request: z.object({ user_data: ByteArraySchema }),
         response: z.null(),

package/lib/esm/utility/log.js

@@ -0,0 +1,42 @@
+export class OdinError extends Error {
+    constructor(message = '', options) {
+        super(message);
+        this.message = message;
+        this.name = 'OdinError';
+        const date = new Date();
+        const hours = date.getHours();
+        const minutes = date.getMinutes();
+        const seconds = date.getSeconds();
+        if (options === null || options === void 0 ? void 0 : options.project) {
+            this.message = `ODIN ${options === null || options === void 0 ? void 0 : options.project} | ${options === null || options === void 0 ? void 0 : options.kind}`;
+        }
+        this.message += ` at ${options === null || options === void 0 ? void 0 : options.project} ${hours}:${minutes}:${seconds}\n`;
+        this.message += `${message}\n`;
+    }
+}
+export function log(message, options, filters = { projects: [], kind: [] }) {
+    for (const projectName of filters.projects) {
+        if (options.project === projectName) {
+            for (const kindName of filters.kind) {
+                if (options.kind === kindName) {
+                    let logMessage = '';
+                    const date = new Date();
+                    const hours = date.getHours();
+                    const minutes = date.getMinutes();
+                    const seconds = date.getSeconds();
+                    if (options === null || options === void 0 ? void 0 : options.project) {
+                        logMessage = `ODIN ${options === null || options === void 0 ? void 0 : options.project} | ${options === null || options === void 0 ? void 0 : options.kind}`;
+                    }
+                    logMessage += ` at ${options === null || options === void 0 ? void 0 : options.project} ${hours}:${minutes}:${seconds}\n`;
+                    logMessage += `${message}\n`;
+                    if (options.logType) {
+                        console[options.logType](logMessage);
+                    }
+                    else {
+                        console.log(logMessage);
+                    }
+                }
+            }
+        }
+    }
+}

package/lib/esm/utility/result.js

@@ -1,11 +1,12 @@
 /* eslint-disable no-redeclare */
+import { OdinError } from './log';
 export function assert(condition, message) {
     if (!condition) {
         fail(message);
     }
 }
-export function fail(message) {
-    throw new Error(message);
+export function fail(message, options) {
+    throw new OdinError(message, options);
 }
 export function success(value) {
     return { type: 'Success', value };

package/lib/index.d.ts

@@ -20,4 +20,5 @@ export * from './utility/strand';
 export * from './utility/url';
 export * from './utility/uuid';
 export * from './utility/validation';
+export * from './utility/log';
 export * from './plugin/api';

package/lib/rpc/commands.d.ts

@@ -5,6 +5,16 @@ export type Commands = Record<string, {
     response: z.ZodTypeAny;
 }>;
 export declare const MainCommandsRpc: {
+    Hello: {
+        request: z.ZodObject<{
+            stream: z.ZodLiteral<"main">;
+        }, "strip", z.ZodTypeAny, {
+            stream: "main";
+        }, {
+            stream: "main";
+        }>;
+        response: z.ZodNull;
+    };
     JoinRoom: {
         request: z.ZodObject<{
             token: z.ZodString;
@@ -96,6 +106,28 @@ export declare const MainCommandsRpc: {
 };
 export type MainCommands = typeof MainCommandsRpc;
 export declare const RoomCommandsRpc: {
+    Hello: {
+        request: z.ZodObject<{
+            stream: z.ZodLiteral<"room">;
+            token: z.ZodString;
+            room_id: z.ZodString;
+            user_data: z.ZodType<Uint8Array, z.ZodTypeDef, Uint8Array>;
+            position: z.ZodUnion<[z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>, z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>]>;
+        }, "strip", z.ZodTypeAny, {
+            user_data: Uint8Array;
+            stream: "room";
+            token: string;
+            room_id: string;
+            position: [number, number, number] | [number, number];
+        }, {
+            user_data: Uint8Array;
+            stream: "room";
+            token: string;
+            room_id: string;
+            position: [number, number, number] | [number, number];
+        }>;
+        response: z.ZodNull;
+    };
     UpdatePeer: {
         request: z.ZodObject<{
             user_data: z.ZodType<Uint8Array, z.ZodTypeDef, Uint8Array>;

package/lib/utility/log.d.ts

@@ -0,0 +1,14 @@
+export type LogOptions = {
+    kind: string;
+    project: string;
+    logType?: 'debug' | 'info' | 'warn' | 'error';
+};
+export declare class OdinError extends Error {
+    message: string;
+    readonly name = "OdinError";
+    constructor(message?: string, options?: LogOptions);
+}
+export declare function log(message: string, options: LogOptions, filters?: {
+    projects: string[];
+    kind: string[];
+}): void;

package/lib/utility/result.d.ts

@@ -1,5 +1,6 @@
+import { LogOptions } from './log';
 export declare function assert(condition: unknown, message: string): asserts condition;
-export declare function fail(message: string): never;
+export declare function fail(message: string, options?: LogOptions): never;
 export type Failure = {
     type: 'Failure';
     reason: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4players/odin-common",
-  "version": "2.4.1",
+  "version": "2.4.3",
   "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",