@skalfa/skalfa-socket 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/bun.lock ADDED
@@ -0,0 +1,119 @@
1
+ {
2
+ "lockfileVersion": 1,
3
+ "workspaces": {
4
+ "": {
5
+ "name": "@skalfa/skalfa-socket",
6
+ "dependencies": {
7
+ "@skalfa/skalfa-api-core": "file:../skalfa-api-core",
8
+ "socket.io": "^4.7.5",
9
+ },
10
+ "devDependencies": {
11
+ "@types/node": "^26.0.0",
12
+ "typescript": "^6.0.3",
13
+ },
14
+ },
15
+ },
16
+ "packages": {
17
+ "@borewit/text-codec": ["@borewit/text-codec@0.2.2", "", {}, "sha512-DDaRehssg1aNrH4+2hnj1B7vnUGEjU6OIlyRdkMd0aUdIUvKXrJfXsy8LVtXAy7DRvYVluWbMspsRhz2lcW0mQ=="],
18
+
19
+ "@sinclair/typebox": ["@sinclair/typebox@0.34.49", "", {}, "sha512-brySQQs7Jtn0joV8Xh9ZV/hZb9Ozb0pmazDIASBkYKCjXrXU3mpcFahmK/z4YDhGkQvP9mWJbVyahdtU5wQA+A=="],
20
+
21
+ "@skalfa/skalfa-api-core": ["@skalfa/skalfa-api-core@file:../skalfa-api-core", { "dependencies": { "@skalfa/skalfa-orm": "file:../skalfa-orm", "bcrypt": "^6.0.0", "commander": "^12.1.0", "dotenv": "^17.2.2", "elysia": "latest", "nodemailer": "^7.0.9", "validator": "^13.15.15" }, "devDependencies": { "@types/bcrypt": "^6.0.0", "@types/node": "^26.0.0", "@types/nodemailer": "^7.0.2", "@types/validator": "^13.15.3", "bun-types": "latest", "typescript": "^6.0.3" } }],
22
+
23
+ "@socket.io/component-emitter": ["@socket.io/component-emitter@3.1.2", "", {}, "sha512-9BCxFwvbGg/RsZK9tjXd8s4UcwR0MWeFQ1XEKIQVVvAGJyINdrqKMcTRyLoK8Rse1GjzLV9cwjWV1olXRWEXVA=="],
24
+
25
+ "@tokenizer/inflate": ["@tokenizer/inflate@0.4.1", "", { "dependencies": { "debug": "^4.4.3", "token-types": "^6.1.1" } }, "sha512-2mAv+8pkG6GIZiF1kNg1jAjh27IDxEPKwdGul3snfztFerfPGI1LjDezZp3i7BElXompqEtPmoPx6c2wgtWsOA=="],
26
+
27
+ "@tokenizer/token": ["@tokenizer/token@0.3.0", "", {}, "sha512-OvjF+z51L3ov0OyAU0duzsYuvO01PH7x4t6DJx+guahgTnBHkhJdG7soQeTSFLWN3efnHyibZ4Z8l2EuWwJN3A=="],
28
+
29
+ "@types/bcrypt": ["@types/bcrypt@6.0.0", "", { "dependencies": { "@types/node": "*" } }, "sha512-/oJGukuH3D2+D+3H4JWLaAsJ/ji86dhRidzZ/Od7H/i8g+aCmvkeCc6Ni/f9uxGLSQVCRZkX2/lqEFG2BvWtlQ=="],
30
+
31
+ "@types/cors": ["@types/cors@2.8.19", "", { "dependencies": { "@types/node": "*" } }, "sha512-mFNylyeyqN93lfe/9CSxOGREz8cpzAhH+E93xJ4xWQf62V8sQ/24reV2nyzUWM6H6Xji+GGHpkbLe7pVoUEskg=="],
32
+
33
+ "@types/node": ["@types/node@26.0.0", "", { "dependencies": { "undici-types": "~8.3.0" } }, "sha512-vf2YFi1iY9lHGwNJMs01biZFbKJkrZR1T6/MlzjhJLPdntOHLhTrDSnSVcdtvjihi4VQNlrFRIxLsDBlQpAipA=="],
34
+
35
+ "@types/nodemailer": ["@types/nodemailer@7.0.12", "", { "dependencies": { "@types/node": "*" } }, "sha512-80vKwiIsVSyFA1rRovH59jNPLBOuc6dRZIHEu40gXTkBkZnQv8vog1xSGEb9j5q/tdMAs5ivvDR2pLTU0hGHXA=="],
36
+
37
+ "@types/validator": ["@types/validator@13.15.10", "", {}, "sha512-T8L6i7wCuyoK8A/ZeLYt1+q0ty3Zb9+qbSSvrIVitzT3YjZqkTZ40IbRsPanlB4h1QB3JVL1SYCdR6ngtFYcuA=="],
38
+
39
+ "@types/ws": ["@types/ws@8.18.1", "", { "dependencies": { "@types/node": "*" } }, "sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg=="],
40
+
41
+ "accepts": ["accepts@1.3.8", "", { "dependencies": { "mime-types": "~2.1.34", "negotiator": "0.6.3" } }, "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw=="],
42
+
43
+ "base64id": ["base64id@2.0.0", "", {}, "sha512-lGe34o6EHj9y3Kts9R4ZYs/Gr+6N7MCaMlIFA3F1R2O5/m7K06AxfSeO5530PEERE6/WyEg3lsuyw4GHlPZHog=="],
44
+
45
+ "bcrypt": ["bcrypt@6.0.0", "", { "dependencies": { "node-addon-api": "^8.3.0", "node-gyp-build": "^4.8.4" } }, "sha512-cU8v/EGSrnH+HnxV2z0J7/blxH8gq7Xh2JFT6Aroax7UohdmiJJlxApMxtKfuI7z68NvvVcmR78k2LbT6efhRg=="],
46
+
47
+ "bun-types": ["bun-types@1.3.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-4N0ig0fEomHt5R0KCFWjovxow98rIoRwKolrYdCcknNwMekCXRnWEUvgu5soYV8QXtVsrUD8B95MBOZGPvr6KQ=="],
48
+
49
+ "commander": ["commander@12.1.0", "", {}, "sha512-Vw8qHK3bZM9y/P10u3Vib8o/DdkvA2OtPtZvD871QKjy74Wj1WSKFILMPRPSdUSx5RFK1arlJzEtA4PkFgnbuA=="],
50
+
51
+ "cookie": ["cookie@1.1.1", "", {}, "sha512-ei8Aos7ja0weRpFzJnEA9UHJ/7XQmqglbRwnf2ATjcB9Wq874VKH9kfjjirM6UhU2/E5fFYadylyhFldcqSidQ=="],
52
+
53
+ "cors": ["cors@2.8.6", "", { "dependencies": { "object-assign": "^4", "vary": "^1" } }, "sha512-tJtZBBHA6vjIAaF6EnIaq6laBBP9aq/Y3ouVJjEfoHbRBcHBAHYcMh/w8LDrk2PvIMMq8gmopa5D4V8RmbrxGw=="],
54
+
55
+ "debug": ["debug@4.4.3", "", { "dependencies": { "ms": "^2.1.3" } }, "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA=="],
56
+
57
+ "dotenv": ["dotenv@17.4.2", "", {}, "sha512-nI4U3TottKAcAD9LLud4Cb7b2QztQMUEfHbvhTH09bqXTxnSie8WnjPALV/WMCrJZ6UV/qHJ6L03OqO3LcdYZw=="],
58
+
59
+ "elysia": ["elysia@1.4.29", "", { "dependencies": { "cookie": "^1.1.1", "exact-mirror": "^0.2.7", "fast-decode-uri-component": "^1.0.1", "memoirist": "^0.4.0" }, "peerDependencies": { "@sinclair/typebox": ">= 0.34.0 < 1", "@types/bun": ">= 1.2.0", "file-type": ">= 20.0.0", "openapi-types": ">= 12.0.0", "typescript": ">= 5.0.0" }, "optionalPeers": ["@types/bun", "typescript"] }, "sha512-GwMRGGwSdjfPt+w3LA0fqTuYJtS8uVRJicvoar98/HrO5qdFKDc9CwjIb6Kja+v39lkY+58hr2JvdR9jQzlUuA=="],
60
+
61
+ "engine.io": ["engine.io@6.6.9", "", { "dependencies": { "@types/cors": "^2.8.12", "@types/node": ">=10.0.0", "@types/ws": "^8.5.12", "accepts": "~1.3.4", "base64id": "2.0.0", "cookie": "~0.7.2", "cors": "~2.8.5", "debug": "~4.4.1", "engine.io-parser": "~5.2.1", "ws": "~8.21.0" } }, "sha512-clKkw4C7nJ22mGgoVcCg6V/W/TxdNyIOTr89k2ONZu81qqkddPFDF0LXcbAwhzPD8DjkiRCjzuiO6Y+fkpD4vg=="],
62
+
63
+ "engine.io-parser": ["engine.io-parser@5.2.3", "", {}, "sha512-HqD3yTBfnBxIrbnM1DoD6Pcq8NECnh8d4As1Qgh0z5Gg3jRRIqijury0CL3ghu/edArpUYiYqQiDUQBIs4np3Q=="],
64
+
65
+ "exact-mirror": ["exact-mirror@0.2.7", "", { "peerDependencies": { "@sinclair/typebox": "^0.34.15" }, "optionalPeers": ["@sinclair/typebox"] }, "sha512-+MeEmDcLA4o/vjK2zujgk+1VTxPR4hdp23qLqkWfStbECtAq9gmsvQa3LW6z/0GXZyHJobrCnmy1cdeE7BjsYg=="],
66
+
67
+ "fast-decode-uri-component": ["fast-decode-uri-component@1.0.1", "", {}, "sha512-WKgKWg5eUxvRZGwW8FvfbaH7AXSh2cL+3j5fMGzUMCxWBJ3dV3a7Wz8y2f/uQ0e3B6WmodD3oS54jTQ9HVTIIg=="],
68
+
69
+ "file-type": ["file-type@22.0.1", "", { "dependencies": { "@tokenizer/inflate": "^0.4.1", "strtok3": "^10.3.5", "token-types": "^6.1.2", "uint8array-extras": "^1.5.0" } }, "sha512-ww5Mhre0EE+jmBvOXTmXAbEMuZE7uX4a3+oRCQFNj8w++g3ev913N6tXQz0XTXbueQ5TWQfm6BdaViEHHn8bhA=="],
70
+
71
+ "ieee754": ["ieee754@1.2.1", "", {}, "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA=="],
72
+
73
+ "memoirist": ["memoirist@0.4.0", "", {}, "sha512-zxTgA0mSYELa66DimuNQDvyLq36AwDlTuVRbnQtB+VuTcKWm5Qc4z3WkSpgsFWHNhexqkIooqpv4hdcqrX5Nmg=="],
74
+
75
+ "mime-db": ["mime-db@1.52.0", "", {}, "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg=="],
76
+
77
+ "mime-types": ["mime-types@2.1.35", "", { "dependencies": { "mime-db": "1.52.0" } }, "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw=="],
78
+
79
+ "ms": ["ms@2.1.3", "", {}, "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="],
80
+
81
+ "negotiator": ["negotiator@0.6.3", "", {}, "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg=="],
82
+
83
+ "node-addon-api": ["node-addon-api@8.8.0", "", {}, "sha512-c5Ko1fZJIJmzhFIkhRN76WTq+fC6tWnGy9CXA0fA+XygsWZmEwG8vmbkNqxMyoaa0Tin4djul49NzdVcJJcjeA=="],
84
+
85
+ "node-gyp-build": ["node-gyp-build@4.8.4", "", { "bin": { "node-gyp-build": "bin.js", "node-gyp-build-optional": "optional.js", "node-gyp-build-test": "build-test.js" } }, "sha512-LA4ZjwlnUblHVgq0oBF3Jl/6h/Nvs5fzBLwdEF4nuxnFdsfajde4WfxtJr3CaiH+F6ewcIB/q4jQ4UzPyid+CQ=="],
86
+
87
+ "nodemailer": ["nodemailer@7.0.13", "", {}, "sha512-PNDFSJdP+KFgdsG3ZzMXCgquO7I6McjY2vlqILjtJd0hy8wEvtugS9xKRF2NWlPNGxvLCXlTNIae4serI7dinw=="],
88
+
89
+ "object-assign": ["object-assign@4.1.1", "", {}, "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg=="],
90
+
91
+ "openapi-types": ["openapi-types@12.1.3", "", {}, "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw=="],
92
+
93
+ "socket.io": ["socket.io@4.8.3", "", { "dependencies": { "accepts": "~1.3.4", "base64id": "~2.0.0", "cors": "~2.8.5", "debug": "~4.4.1", "engine.io": "~6.6.0", "socket.io-adapter": "~2.5.2", "socket.io-parser": "~4.2.4" } }, "sha512-2Dd78bqzzjE6KPkD5fHZmDAKRNe3J15q+YHDrIsy9WEkqttc7GY+kT9OBLSMaPbQaEd0x1BjcmtMtXkfpc+T5A=="],
94
+
95
+ "socket.io-adapter": ["socket.io-adapter@2.5.8", "", { "dependencies": { "debug": "~4.4.1", "ws": "~8.21.0" } }, "sha512-6Oy52pbg+kvdCVvjcN+FnY7BvxZ7cIHNScbvztT/It5d0vbwoJoVZmF2gjJmnV0/4WlXRfG15zc45ySk9Ah8bw=="],
96
+
97
+ "socket.io-parser": ["socket.io-parser@4.2.6", "", { "dependencies": { "@socket.io/component-emitter": "~3.1.0", "debug": "~4.4.1" } }, "sha512-asJqbVBDsBCJx0pTqw3WfesSY0iRX+2xzWEWzrpcH7L6fLzrhyF8WPI8UaeM4YCuDfpwA/cgsdugMsmtz8EJeg=="],
98
+
99
+ "strtok3": ["strtok3@10.3.5", "", { "dependencies": { "@tokenizer/token": "^0.3.0" } }, "sha512-ki4hZQfh5rX0QDLLkOCj+h+CVNkqmp/CMf8v8kZpkNVK6jGQooMytqzLZYUVYIZcFZ6yDB70EfD8POcFXiF5oA=="],
100
+
101
+ "token-types": ["token-types@6.1.2", "", { "dependencies": { "@borewit/text-codec": "^0.2.1", "@tokenizer/token": "^0.3.0", "ieee754": "^1.2.1" } }, "sha512-dRXchy+C0IgK8WPC6xvCHFRIWYUbqqdEIKPaKo/AcTUNzwLTK6AH7RjdLWsEZcAN/TBdtfUw3PYEgPr5VPr6ww=="],
102
+
103
+ "typescript": ["typescript@6.0.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw=="],
104
+
105
+ "uint8array-extras": ["uint8array-extras@1.5.0", "", {}, "sha512-rvKSBiC5zqCCiDZ9kAOszZcDvdAHwwIKJG33Ykj43OKcWsnmcBRL09YTU4nOeHZ8Y2a7l1MgTd08SBe9A8Qj6A=="],
106
+
107
+ "undici-types": ["undici-types@8.3.0", "", {}, "sha512-j375ScV60dom+YkPFIfTLcOiPxkN/buHz5GobjLhixFuANaNs3C9l4GmrWqejgXWJ7BbJcFYpTEUkS1Ge8bpZQ=="],
108
+
109
+ "validator": ["validator@13.15.35", "", {}, "sha512-TQ5pAGhd5whStmqWvYF4OjQROlmv9SMFVt37qoCBdqRffuuklWYQlCNnEs2ZaIBD1kZRNnikiZOS1eqgkar0iw=="],
110
+
111
+ "vary": ["vary@1.1.2", "", {}, "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg=="],
112
+
113
+ "ws": ["ws@8.21.0", "", { "peerDependencies": { "bufferutil": "^4.0.1", "utf-8-validate": ">=5.0.2" }, "optionalPeers": ["bufferutil", "utf-8-validate"] }, "sha512-Vsp28b7DRcimFQvrqu2Wek3z1iYxDCWqHYB8Qsnk/S4RfaCQzPGPyBNuVjJV3cd6UiKtUtp6sNM77gWvzcCH+g=="],
114
+
115
+ "@skalfa/skalfa-api-core/@skalfa/skalfa-orm": ["@skalfa/skalfa-orm@file:..\\skalfa-orm", {}],
116
+
117
+ "engine.io/cookie": ["cookie@0.7.2", "", {}, "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w=="],
118
+ }
119
+ }
@@ -0,0 +1,26 @@
1
+ import { Server, Socket } from "socket.io";
2
+ type Handler = (client: Socket, data: any) => void;
3
+ export declare class EventRegistry {
4
+ private events;
5
+ private authEvents;
6
+ on(event: string, handler: Handler): void;
7
+ auth(): {
8
+ on: (event: string, handler: Handler) => void;
9
+ };
10
+ bind(client: Socket): void;
11
+ }
12
+ export declare const socket: {
13
+ start(port: number): Server<import("socket.io").DefaultEventsMap, import("socket.io").DefaultEventsMap, import("socket.io").DefaultEventsMap, any>;
14
+ event: EventRegistry;
15
+ emit(event: string, payload?: any): void;
16
+ send(client: Socket, event: string, payload?: any): void;
17
+ join(client: Socket, room: string): void;
18
+ leave(client: Socket, room: string): void;
19
+ room(room: string): {
20
+ emit(event: string, payload?: any): void;
21
+ };
22
+ of(namespace: string): import("socket.io").Namespace<import("socket.io").DefaultEventsMap, import("socket.io").DefaultEventsMap, import("socket.io").DefaultEventsMap, any> | null;
23
+ disconnect(client: Socket, reason?: string): void;
24
+ shutdown(): void;
25
+ };
26
+ export {};
package/dist/index.js ADDED
@@ -0,0 +1,166 @@
1
+ import os from 'os';
2
+ import { Server } from "socket.io";
3
+ import { auth, logger } from "@skalfa/skalfa-api-core";
4
+ let io = null;
5
+ // ===============================
6
+ // ## socket: event register handler
7
+ // ===============================
8
+ export class EventRegistry {
9
+ constructor() {
10
+ this.events = new Map();
11
+ this.authEvents = new Map();
12
+ }
13
+ on(event, handler) {
14
+ if (!this.events.has(event)) {
15
+ this.events.set(event, []);
16
+ }
17
+ this.events.get(event).push(handler);
18
+ }
19
+ auth() {
20
+ return {
21
+ on: (event, handler) => {
22
+ if (!this.authEvents.has(event)) {
23
+ this.authEvents.set(event, []);
24
+ }
25
+ this.authEvents.get(event).push(handler);
26
+ },
27
+ };
28
+ }
29
+ bind(client) {
30
+ this.events.forEach((handlers, eventName) => {
31
+ client.on(eventName, (data) => {
32
+ handlers.forEach((handler) => handler(client, data));
33
+ });
34
+ });
35
+ this.authEvents.forEach((handlers, eventName) => {
36
+ client.on(eventName, async (data) => {
37
+ const token = data?.accessToken;
38
+ const session = await auth.verifyAccessToken(token);
39
+ if (!session) {
40
+ client.emit("error", {
41
+ event: eventName,
42
+ message: "UNAUTHORIZED_USER",
43
+ });
44
+ return;
45
+ }
46
+ client.data.user = { id: session.user.id, token: session.token };
47
+ handlers.forEach((handler) => handler(client, data));
48
+ });
49
+ });
50
+ }
51
+ }
52
+ export const socket = {
53
+ // ===============================
54
+ // ## socket: start server
55
+ // ===============================
56
+ start(port) {
57
+ if (io)
58
+ return io;
59
+ io = new Server(port, {
60
+ cors: {
61
+ origin: process.env.SOCKET_CORS_ORIGINS || "*",
62
+ credentials: true,
63
+ },
64
+ transports: ["websocket"],
65
+ });
66
+ io.use(async (client, next) => {
67
+ try {
68
+ const accessKey = client.handshake.auth?.accessKey || client.handshake.headers["x-api-key"];
69
+ if (process.env.SOCKET_KEY) {
70
+ if (accessKey !== process.env.SOCKET_APP_KEY) {
71
+ return next(new Error("INVALID_SOCKET_KEY"));
72
+ }
73
+ ;
74
+ }
75
+ next();
76
+ }
77
+ catch {
78
+ next(new Error("AUTH_ERROR"));
79
+ }
80
+ });
81
+ io.on("connection", (client) => {
82
+ logger.socket(`client connected: ${client.id}`);
83
+ socket.event.bind(client);
84
+ client.on("disconnect", (reason) => {
85
+ logger.socket(`client disconnected: ${client.id, reason}`);
86
+ });
87
+ });
88
+ function getLocalIP() {
89
+ const interfaces = os.networkInterfaces();
90
+ for (const name of Object.keys(interfaces)) {
91
+ for (const net of interfaces[name] || []) {
92
+ if (net.family === 'IPv4' && !net.internal)
93
+ return net.address;
94
+ }
95
+ }
96
+ }
97
+ setTimeout(() => logger.start(`WS Server running on \n [LOCAL] http://localhost:${port} \n [NETWORK] http://${getLocalIP()}:${port}!`), 300);
98
+ return io;
99
+ },
100
+ // ===============================
101
+ // ## socket: event register
102
+ // ===============================
103
+ event: new EventRegistry(),
104
+ // ===============================
105
+ // ## socket: emit
106
+ // ===============================
107
+ emit(event, payload) {
108
+ io?.emit(event, payload);
109
+ },
110
+ // ===============================
111
+ // ## socket: emit specific client
112
+ // ===============================
113
+ send(client, event, payload) {
114
+ client.emit(event, payload);
115
+ },
116
+ // ===============================
117
+ // ## socket: join room
118
+ // ===============================
119
+ join(client, room) {
120
+ client.join(room);
121
+ },
122
+ // ===============================
123
+ // ## socket: leave
124
+ // ===============================
125
+ leave(client, room) {
126
+ client.leave(room);
127
+ },
128
+ // ===============================
129
+ // ## socket: disconnect
130
+ // ===============================
131
+ room(room) {
132
+ return {
133
+ emit(event, payload) {
134
+ io?.to(room).emit(event, payload);
135
+ },
136
+ };
137
+ },
138
+ // ===============================
139
+ // ## socket: namespace
140
+ // ===============================
141
+ of(namespace) {
142
+ if (!io)
143
+ return null;
144
+ return io.of(namespace);
145
+ },
146
+ // ===============================
147
+ // ## socket: disconnect
148
+ // ===============================
149
+ disconnect(client, reason) {
150
+ if (reason) {
151
+ client.emit("force-disconnect", { reason });
152
+ }
153
+ client.disconnect(true);
154
+ },
155
+ // ===============================
156
+ // ## socket: shutdown server
157
+ // ===============================
158
+ shutdown() {
159
+ if (!io)
160
+ return;
161
+ io.close();
162
+ io = null;
163
+ logger.socket("WS shutdown complete");
164
+ },
165
+ };
166
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,EAAE,MAAM,EAAU,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAEvD,IAAI,EAAE,GAAkB,IAAI,CAAC;AAI7B,kCAAkC;AAClC,oCAAoC;AACpC,kCAAkC;AAClC,MAAM,OAAO,aAAa;IAA1B;QACU,WAAM,GAAG,IAAI,GAAG,EAAqB,CAAC;QACtC,eAAU,GAAG,IAAI,GAAG,EAAqB,CAAC;IAgDpD,CAAC;IA9CC,EAAE,CAAC,KAAa,EAAE,OAAgB;QAChC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,IAAI;QACF,OAAO;YACL,EAAE,EAAE,CAAC,KAAa,EAAE,OAAgB,EAAE,EAAE;gBACtC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBAChC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBACjC,CAAC;gBACD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5C,CAAC;SACF,CAAC;IACJ,CAAC;IAGD,IAAI,CAAC,MAAc;QACjB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE;YAC1C,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC5B,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;YACvD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE;YAC9C,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBAClC,MAAM,KAAK,GAAG,IAAI,EAAE,WAAW,CAAC;gBAEhC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;gBAEpD,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE;wBACnB,KAAK,EAAE,SAAS;wBAChB,OAAO,EAAE,mBAAmB;qBAC7B,CAAC,CAAC;oBACH,OAAO;gBACT,CAAC;gBAED,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,EAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAC,CAAC;gBAE/D,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;YACvD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,kCAAkC;IAClC,0BAA0B;IAC1B,kCAAkC;IAClC,KAAK,CAAC,IAAY;QAChB,IAAI,EAAE;YAAE,OAAO,EAAE,CAAC;QAElB,EAAE,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE;YACpB,IAAI,EAAE;gBACJ,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,GAAG;gBAC9C,WAAW,EAAE,IAAI;aAClB;YACD,UAAU,EAAE,CAAC,WAAW,CAAC;SAC1B,CAAC,CAAC;QAEH,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YAC5B,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBAE5F,IAAG,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;oBAC1B,IAAI,SAAS,KAAK,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;wBAC7C,OAAO,IAAI,CAAC,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC;oBAC/C,CAAC;oBAAA,CAAC;gBACJ,CAAC;gBAED,IAAI,EAAE,CAAC;YACT,CAAC;YAAC,MAAM,CAAC;gBACP,IAAI,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;YAChC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAc,EAAE,EAAE;YACrC,MAAM,CAAC,MAAM,CAAC,qBAAqB,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;YAEhD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE1B,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;gBACjC,MAAM,CAAC,MAAM,CAAC,wBAAwB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YAC7D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,SAAS,UAAU;YACjB,MAAM,UAAU,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAA;YACzC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC3C,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;oBACzC,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ;wBAAE,OAAO,GAAG,CAAC,OAAO,CAAA;gBAChE,CAAC;YACH,CAAC;QACH,CAAC;QAED,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,8DAA8D,IAAI,gCAAgC,UAAU,EAAE,IAAI,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;QAC/J,OAAO,EAAE,CAAC;IACZ,CAAC;IAGD,kCAAkC;IAClC,4BAA4B;IAC5B,kCAAkC;IAClC,KAAK,EAAE,IAAI,aAAa,EAAE;IAG1B,kCAAkC;IAClC,kBAAkB;IAClB,kCAAkC;IAClC,IAAI,CAAC,KAAa,EAAE,OAAa;QAC/B,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC3B,CAAC;IAGD,kCAAkC;IAClC,kCAAkC;IAClC,kCAAkC;IAClC,IAAI,CAAC,MAAc,EAAE,KAAa,EAAE,OAAa;QAC/C,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9B,CAAC;IAGD,kCAAkC;IAClC,uBAAuB;IACvB,kCAAkC;IAClC,IAAI,CAAC,MAAc,EAAE,IAAY;QAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAGD,kCAAkC;IAClC,mBAAmB;IACnB,kCAAkC;IAClC,KAAK,CAAC,MAAc,EAAE,IAAY;QAChC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,kCAAkC;IAClC,wBAAwB;IACxB,kCAAkC;IAClC,IAAI,CAAC,IAAY;QACf,OAAO;YACL,IAAI,CAAC,KAAa,EAAE,OAAa;gBAC/B,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACpC,CAAC;SACF,CAAC;IACJ,CAAC;IAGD,kCAAkC;IAClC,uBAAuB;IACvB,kCAAkC;IAClC,EAAE,CAAC,SAAiB;QAClB,IAAI,CAAC,EAAE;YAAE,OAAO,IAAI,CAAC;QACrB,OAAO,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;IAC1B,CAAC;IAGD,kCAAkC;IAClC,wBAAwB;IACxB,kCAAkC;IAClC,UAAU,CAAC,MAAc,EAAE,MAAe;QACxC,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAGD,kCAAkC;IAClC,6BAA6B;IAC7B,kCAAkC;IAClC,QAAQ;QACN,IAAI,CAAC,EAAE;YAAE,OAAO;QAChB,EAAE,CAAC,KAAK,EAAE,CAAC;QACX,EAAE,GAAG,IAAI,CAAC;QACV,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;IACxC,CAAC;CACF,CAAC"}
package/package.json ADDED
@@ -0,0 +1,27 @@
1
+ {
2
+ "name": "@skalfa/skalfa-socket",
3
+ "version": "1.0.0",
4
+ "description": "Socket.io utility package for Skalfa API framework.",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "scripts": {
8
+ "build": "tsc --ignoreDeprecations 6.0"
9
+ },
10
+ "keywords": [
11
+ "aluna",
12
+ "socket",
13
+ "socket.io",
14
+ "websocket",
15
+ "skalfa"
16
+ ],
17
+ "author": "",
18
+ "license": "UNLICENSED",
19
+ "dependencies": {
20
+ "socket.io": "^4.7.5",
21
+ "@skalfa/skalfa-api-core": "file:../skalfa-api-core"
22
+ },
23
+ "devDependencies": {
24
+ "@types/node": "^26.0.0",
25
+ "typescript": "^6.0.3"
26
+ }
27
+ }
package/src/index.ts ADDED
@@ -0,0 +1,197 @@
1
+ import os from 'os'
2
+ import { Server, Socket } from "socket.io";
3
+ import { auth, logger } from "@skalfa/skalfa-api-core";
4
+
5
+ let io: Server | null = null;
6
+
7
+ type Handler = (client: Socket, data: any) => void;
8
+
9
+ // ===============================
10
+ // ## socket: event register handler
11
+ // ===============================
12
+ export class EventRegistry {
13
+ private events = new Map<string, Handler[]>();
14
+ private authEvents = new Map<string, Handler[]>();
15
+
16
+ on(event: string, handler: Handler) {
17
+ if (!this.events.has(event)) {
18
+ this.events.set(event, []);
19
+ }
20
+ this.events.get(event)!.push(handler);
21
+ }
22
+
23
+ auth() {
24
+ return {
25
+ on: (event: string, handler: Handler) => {
26
+ if (!this.authEvents.has(event)) {
27
+ this.authEvents.set(event, []);
28
+ }
29
+ this.authEvents.get(event)!.push(handler);
30
+ },
31
+ };
32
+ }
33
+
34
+
35
+ bind(client: Socket) {
36
+ this.events.forEach((handlers, eventName) => {
37
+ client.on(eventName, (data) => {
38
+ handlers.forEach((handler) => handler(client, data));
39
+ });
40
+ });
41
+
42
+ this.authEvents.forEach((handlers, eventName) => {
43
+ client.on(eventName, async (data) => {
44
+ const token = data?.accessToken;
45
+
46
+ const session = await auth.verifyAccessToken(token);
47
+
48
+ if (!session) {
49
+ client.emit("error", {
50
+ event: eventName,
51
+ message: "UNAUTHORIZED_USER",
52
+ });
53
+ return;
54
+ }
55
+
56
+ client.data.user = {id: session.user.id, token: session.token};
57
+
58
+ handlers.forEach((handler) => handler(client, data));
59
+ });
60
+ });
61
+ }
62
+ }
63
+
64
+ export const socket = {
65
+ // ===============================
66
+ // ## socket: start server
67
+ // ===============================
68
+ start(port: number) {
69
+ if (io) return io;
70
+
71
+ io = new Server(port, {
72
+ cors: {
73
+ origin: process.env.SOCKET_CORS_ORIGINS || "*",
74
+ credentials: true,
75
+ },
76
+ transports: ["websocket"],
77
+ });
78
+
79
+ io.use(async (client, next) => {
80
+ try {
81
+ const accessKey = client.handshake.auth?.accessKey || client.handshake.headers["x-api-key"];
82
+
83
+ if(process.env.SOCKET_KEY) {
84
+ if (accessKey !== process.env.SOCKET_APP_KEY) {
85
+ return next(new Error("INVALID_SOCKET_KEY"));
86
+ };
87
+ }
88
+
89
+ next();
90
+ } catch {
91
+ next(new Error("AUTH_ERROR"));
92
+ }
93
+ });
94
+
95
+ io.on("connection", (client: Socket) => {
96
+ logger.socket(`client connected: ${client.id}`);
97
+
98
+ socket.event.bind(client);
99
+
100
+ client.on("disconnect", (reason) => {
101
+ logger.socket(`client disconnected: ${client.id, reason}`);
102
+ });
103
+ });
104
+
105
+ function getLocalIP() {
106
+ const interfaces = os.networkInterfaces()
107
+ for (const name of Object.keys(interfaces)) {
108
+ for (const net of interfaces[name] || []) {
109
+ if (net.family === 'IPv4' && !net.internal) return net.address
110
+ }
111
+ }
112
+ }
113
+
114
+ setTimeout(() => logger.start(`WS Server running on \n [LOCAL] http://localhost:${port} \n [NETWORK] http://${getLocalIP()}:${port}!`), 300);
115
+ return io;
116
+ },
117
+
118
+
119
+ // ===============================
120
+ // ## socket: event register
121
+ // ===============================
122
+ event: new EventRegistry(),
123
+
124
+
125
+ // ===============================
126
+ // ## socket: emit
127
+ // ===============================
128
+ emit(event: string, payload?: any) {
129
+ io?.emit(event, payload);
130
+ },
131
+
132
+
133
+ // ===============================
134
+ // ## socket: emit specific client
135
+ // ===============================
136
+ send(client: Socket, event: string, payload?: any) {
137
+ client.emit(event, payload);
138
+ },
139
+
140
+
141
+ // ===============================
142
+ // ## socket: join room
143
+ // ===============================
144
+ join(client: Socket, room: string) {
145
+ client.join(room);
146
+ },
147
+
148
+
149
+ // ===============================
150
+ // ## socket: leave
151
+ // ===============================
152
+ leave(client: Socket, room: string) {
153
+ client.leave(room);
154
+ },
155
+
156
+ // ===============================
157
+ // ## socket: disconnect
158
+ // ===============================
159
+ room(room: string) {
160
+ return {
161
+ emit(event: string, payload?: any) {
162
+ io?.to(room).emit(event, payload);
163
+ },
164
+ };
165
+ },
166
+
167
+
168
+ // ===============================
169
+ // ## socket: namespace
170
+ // ===============================
171
+ of(namespace: string) {
172
+ if (!io) return null;
173
+ return io.of(namespace);
174
+ },
175
+
176
+
177
+ // ===============================
178
+ // ## socket: disconnect
179
+ // ===============================
180
+ disconnect(client: Socket, reason?: string) {
181
+ if (reason) {
182
+ client.emit("force-disconnect", { reason });
183
+ }
184
+ client.disconnect(true);
185
+ },
186
+
187
+
188
+ // ===============================
189
+ // ## socket: shutdown server
190
+ // ===============================
191
+ shutdown() {
192
+ if (!io) return;
193
+ io.close();
194
+ io = null;
195
+ logger.socket("WS shutdown complete");
196
+ },
197
+ };
package/tsconfig.json ADDED
@@ -0,0 +1,19 @@
1
+ {
2
+ "compilerOptions": {
3
+ "ignoreDeprecations": "5.0",
4
+ "target": "ES2021",
5
+ "module": "ES2022",
6
+ "moduleResolution": "node",
7
+ "declaration": true,
8
+ "sourceMap": true,
9
+ "outDir": "./dist",
10
+ "rootDir": "./src",
11
+ "strict": true,
12
+ "esModuleInterop": true,
13
+ "skipLibCheck": true,
14
+ "forceConsistentCasingInFileNames": true,
15
+ "baseUrl": ".",
16
+ "types": ["node"]
17
+ },
18
+ "include": ["src/**/*"]
19
+ }