@4players/odin-common 1.4.3 → 1.5.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.5.0
+
+- Added `generateUUID`
+- Added `validateUUID`
+- Added re-exports for WebSocket package types
+
 ## 1.4.3
 
 - Added union zod schemas for room event validation

package/lib/cjs/index.js

@@ -34,6 +34,7 @@ __exportStar(require("./utility/selector"), exports);
 __exportStar(require("./utility/sleep"), exports);
 __exportStar(require("./utility/strand"), exports);
 __exportStar(require("./utility/url"), exports);
+__exportStar(require("./utility/uuid"), exports);
 __exportStar(require("./utility/validation"), exports);
 __exportStar(require("./utility/websocket"), exports);
 __exportStar(require("./plugin/api"), exports);

package/lib/cjs/utility/uuid.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateUUID = exports.generateUUID = void 0;
+const uuid_1 = require("uuid");
+function generateUUID() {
+    return (0, uuid_1.v4)();
+}
+exports.generateUUID = generateUUID;
+function validateUUID(uuid) {
+    return (0, uuid_1.validate)(uuid);
+}
+exports.validateUUID = validateUUID;

package/lib/cjs/utility/websocket.js

@@ -9,8 +9,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.webSocketConnectOnce = exports.webSocketConnect = void 0;
+exports.webSocketConnectOnce = exports.webSocketConnect = exports.WebSocketClient = void 0;
 const ws_1 = require("ws");
+Object.defineProperty(exports, "WebSocketClient", { enumerable: true, get: function () { return ws_1.WebSocket; } });
 const result_1 = require("./result");
 const sleep_1 = require("./sleep");
 function webSocketConnect(url, connectIntervals, clientOptions, onFailure) {

package/lib/esm/index.js

@@ -18,6 +18,7 @@ export * from './utility/selector';
 export * from './utility/sleep';
 export * from './utility/strand';
 export * from './utility/url';
+export * from './utility/uuid';
 export * from './utility/validation';
 export * from './utility/websocket';
 export * from './plugin/api';

package/lib/esm/utility/uuid.js

@@ -0,0 +1,7 @@
+import { v4, validate } from 'uuid';
+export function generateUUID() {
+    return v4();
+}
+export function validateUUID(uuid) {
+    return validate(uuid);
+}

package/lib/esm/utility/websocket.js

@@ -7,9 +7,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { WebSocket } from 'ws';
+import { WebSocket as WebSocketClient, } from 'ws';
 import { failure, success } from './result';
 import { sleep } from './sleep';
+export { WebSocketClient, };
 export function webSocketConnect(url, connectIntervals, clientOptions, onFailure) {
     return __awaiter(this, void 0, void 0, function* () {
         const start = performance.now();
@@ -42,7 +43,7 @@ export function webSocketConnectOnce(url, clientOptions) {
     return __awaiter(this, void 0, void 0, function* () {
         let webSocket;
         try {
-            webSocket = new WebSocket(url, clientOptions);
+            webSocket = new WebSocketClient(url, clientOptions);
         }
         catch (reason) {
             return failure(`unable to create websocket; ${reason}`);

package/lib/index.d.ts

@@ -18,6 +18,7 @@ export * from './utility/selector';
 export * from './utility/sleep';
 export * from './utility/strand';
 export * from './utility/url';
+export * from './utility/uuid';
 export * from './utility/validation';
 export * from './utility/websocket';
 export * from './plugin/api';

package/lib/utility/rpc.d.ts

@@ -1,9 +1,10 @@
+/// <reference types="ws" />
 import * as z from 'zod';
-import { WebSocket } from 'ws';
 import { MessagePackRpc } from '../schema/serialization';
 import { Accept, Result } from './result';
 import { Commands } from '../rpc/commands';
 import { Notifications } from '../rpc/notifications';
+import { WebSocketClient } from './websocket';
 export declare function msgpackEncode(value: unknown): ArrayBuffer;
 export declare function msgpackDecode(buffer: ArrayBuffer): unknown;
 export interface RpcMessage {
@@ -15,7 +16,7 @@ export interface RpcRequest {
     timeoutId: ReturnType<typeof setTimeout> | undefined;
 }
 export declare class RpcConnection {
-    readonly webSocket: WebSocket;
+    readonly webSocket: WebSocketClient;
     private readonly _SendQueue;
     private readonly _RecvQueue;
     private readonly _Requests;
@@ -23,7 +24,7 @@ export declare class RpcConnection {
     private _NextId;
     get closed(): boolean;
     get closeSignal(): AbortSignal;
-    constructor(webSocket: WebSocket);
+    constructor(webSocket: WebSocketClient);
     request(name: string, properties: unknown): Promise<Result<unknown> | 'closed'>;
     request(name: string, properties: unknown, timeout: number): Promise<Result<unknown> | 'closed' | 'timeout'>;
     notify(name: string, properties: unknown): void;
@@ -47,7 +48,7 @@ export type RealizedEvents<E extends Notifications> = {
 export declare class TypedRpcConnection<C extends Commands, E extends Notifications> extends RpcConnection {
     readonly _Commands: C;
     readonly _Events: E;
-    constructor(webSocket: WebSocket, _Commands: C, _Events: E);
+    constructor(webSocket: WebSocketClient, _Commands: C, _Events: E);
     request<Name extends Extract<keyof C, string>>(name: Name, properties: z.infer<C[Name]['request']>): Promise<Result<z.infer<C[Name]['response']>> | 'closed'>;
     request<Name extends Extract<keyof C, string>>(name: Name, properties: z.infer<C[Name]['request']>, timeout: number): Promise<Result<z.infer<C[Name]['response']>> | 'closed' | 'timeout'>;
     notify<Name extends Extract<keyof C, string>>(name: Name, properties: z.infer<C[Name]['request']>): void;

package/lib/utility/uuid.d.ts

@@ -0,0 +1,2 @@
+export declare function generateUUID(): string;
+export declare function validateUUID(uuid: string): boolean;

package/lib/utility/websocket.d.ts

@@ -1,7 +1,8 @@
-import { ClientOptions, WebSocket } from 'ws';
+import { WebSocket as WebSocketClient, ClientOptions as WebSocketClientOptions, CloseEvent as WebSocketCloseEvent, ErrorEvent as WebSocketErrorEvent, MessageEvent as WebSocketMessageEvent, EventListenerOptions as WebSocketEventListenerOptions, Event as WebSocketEvent } from 'ws';
 import { Result } from './result';
-export declare function webSocketConnect(url: URL, connectIntervals: number[], clientOptions?: ClientOptions, onFailure?: (failures: number, cancel: () => void) => void): Promise<{
-    connect: () => Promise<Result<WebSocket>>;
+export { WebSocketClient, WebSocketClientOptions, WebSocketCloseEvent, WebSocketErrorEvent, WebSocketMessageEvent, WebSocketEventListenerOptions, WebSocketEvent, };
+export declare function webSocketConnect(url: URL, connectIntervals: number[], clientOptions?: WebSocketClientOptions, onFailure?: (failures: number, cancel: () => void) => void): Promise<{
+    connect: () => Promise<Result<WebSocketClient>>;
     cancel: () => void;
 }>;
-export declare function webSocketConnectOnce(url: URL, clientOptions?: ClientOptions): Promise<Result<WebSocket>>;
+export declare function webSocketConnectOnce(url: URL, clientOptions?: WebSocketClientOptions): Promise<Result<WebSocketClient>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4players/odin-common",
-  "version": "1.4.3",
+  "version": "1.5.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",
@@ -24,19 +24,18 @@
     "lint": "eslint . --ext .ts",
     "test": "testyts"
   },
-  "engines": {
-    "node": ">=14"
-  },
   "dependencies": {
     "@msgpack/msgpack": "~3.0.0-beta2",
-    "@types/ws": "~8.5.0",
+    "uuid": "~9.0.0",
     "ws": "~8.16.0",
     "zod": "~3.22.0"
   },
   "devDependencies": {
     "@types/node": "~20.11.0",
-    "@typescript-eslint/eslint-plugin": "~7.0.0",
-    "@typescript-eslint/parser": "~7.0.0",
+    "@types/uuid": "~9.0.0",
+    "@types/ws": "~8.5.0",
+    "@typescript-eslint/eslint-plugin": "~7.1.0",
+    "@typescript-eslint/parser": "~7.1.0",
     "eslint": "~8.57.0",
     "eslint-config-semistandard": "~17.0.0",
     "eslint-plugin-import": "~2.29.0",