@ysk-kit/realtime 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 YSK Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/from-env.d.ts

@@ -0,0 +1,5 @@
+import type { IRealtimePort } from './port';
+export declare const createRealtimeFromEnv: (env: {
+    REDIS_URL?: string | undefined;
+}) => IRealtimePort;
+//# sourceMappingURL=from-env.d.ts.map

package/dist/from-env.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"from-env.d.ts","sourceRoot":"","sources":["../src/from-env.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAG5C,eAAO,MAAM,qBAAqB,GAAI,KAAK;IAAE,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,KAAG,aAG/E,CAAC"}

package/dist/from-env.js

@@ -0,0 +1,8 @@
+import { createMemoryRealtime } from './memory';
+import { createRedisRealtimeEmitter } from './redis-emitter';
+export const createRealtimeFromEnv = (env) => {
+    if (env.REDIS_URL)
+        return createRedisRealtimeEmitter(env.REDIS_URL);
+    return createMemoryRealtime();
+};
+//# sourceMappingURL=from-env.js.map

package/dist/from-env.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"from-env.js","sourceRoot":"","sources":["../src/from-env.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAEhD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,GAAuC,EAAiB,EAAE;IAC9F,IAAI,GAAG,CAAC,SAAS;QAAE,OAAO,0BAA0B,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACpE,OAAO,oBAAoB,EAAE,CAAC;AAChC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { createRealtimeFromEnv } from './from-env';
+export { createMemoryRealtime, type MemoryRealtime } from './memory';
+export type { IRealtimePort } from './port';
+export { SOCKET_IO_REDIS_KEY } from './port';
+export { createRedisRealtimeEmitter, type RedisPublishClient } from './redis-emitter';
+export { type AttachSocketIoOpts, attachSocketIoRealtime } from './socket-io';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,KAAK,cAAc,EAAE,MAAM,UAAU,CAAC;AACrE,YAAY,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EAAE,0BAA0B,EAAE,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACtF,OAAO,EAAE,KAAK,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+export { createRealtimeFromEnv } from './from-env';
+export { createMemoryRealtime } from './memory';
+export { SOCKET_IO_REDIS_KEY } from './port';
+export { createRedisRealtimeEmitter } from './redis-emitter';
+export { attachSocketIoRealtime } from './socket-io';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAuB,MAAM,UAAU,CAAC;AAErE,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EAAE,0BAA0B,EAA2B,MAAM,iBAAiB,CAAC;AACtF,OAAO,EAA2B,sBAAsB,EAAE,MAAM,aAAa,CAAC"}

package/dist/memory.d.ts

@@ -0,0 +1,10 @@
+import type { IRealtimePort } from './port';
+export type MemoryRealtime = IRealtimePort & {
+    events: Array<{
+        userId: string;
+        event: string;
+        payload: unknown;
+    }>;
+};
+export declare const createMemoryRealtime: () => MemoryRealtime;
+//# sourceMappingURL=memory.d.ts.map

package/dist/memory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../src/memory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAE5C,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG;IAC3C,MAAM,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CACpE,CAAC;AAEF,eAAO,MAAM,oBAAoB,QAAO,cASvC,CAAC"}

package/dist/memory.js

@@ -0,0 +1,11 @@
+export const createMemoryRealtime = () => {
+    const events = [];
+    return {
+        events,
+        async emitToUser(userId, event, payload) {
+            events.push({ userId, event, payload });
+        },
+        async close() { },
+    };
+};
+//# sourceMappingURL=memory.js.map

package/dist/memory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.js","sourceRoot":"","sources":["../src/memory.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAmB,EAAE;IACvD,MAAM,MAAM,GAA6B,EAAE,CAAC;IAC5C,OAAO;QACL,MAAM;QACN,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO;YACrC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1C,CAAC;QACD,KAAK,CAAC,KAAK,KAAI,CAAC;KACjB,CAAC;AACJ,CAAC,CAAC"}

package/dist/port.d.ts

@@ -0,0 +1,6 @@
+export interface IRealtimePort {
+    emitToUser(userId: string, event: string, payload: unknown): Promise<void>;
+    close(): Promise<void>;
+}
+export declare const SOCKET_IO_REDIS_KEY = "ysk-socket.io";
+//# sourceMappingURL=port.d.ts.map

package/dist/port.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"port.d.ts","sourceRoot":"","sources":["../src/port.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3E,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,eAAO,MAAM,mBAAmB,kBAAkB,CAAC"}

package/dist/port.js

@@ -0,0 +1,2 @@
+export const SOCKET_IO_REDIS_KEY = 'ysk-socket.io';
+//# sourceMappingURL=port.js.map

package/dist/port.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"port.js","sourceRoot":"","sources":["../src/port.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC"}

package/dist/redis-emitter.d.ts

@@ -0,0 +1,7 @@
+import { type IRealtimePort } from './port';
+export type RedisPublishClient = {
+    publish(channel: string, message: string | Buffer): unknown;
+    quit?: () => Promise<unknown>;
+};
+export declare const createRedisRealtimeEmitter: (input: string | RedisPublishClient) => IRealtimePort;
+//# sourceMappingURL=redis-emitter.d.ts.map

package/dist/redis-emitter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-emitter.d.ts","sourceRoot":"","sources":["../src/redis-emitter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,QAAQ,CAAC;AAEjE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAC5D,IAAI,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;CAC/B,CAAC;AAEF,eAAO,MAAM,0BAA0B,GAAI,OAAO,MAAM,GAAG,kBAAkB,KAAG,aAc/E,CAAC"}

package/dist/redis-emitter.js

@@ -0,0 +1,20 @@
+import { Emitter } from '@socket.io/redis-emitter';
+import Redis from 'ioredis';
+import { SOCKET_IO_REDIS_KEY } from './port';
+export const createRedisRealtimeEmitter = (input) => {
+    const owned = typeof input === 'string';
+    const redis = owned
+        ? new Redis(input, { maxRetriesPerRequest: null })
+        : input;
+    const emitter = new Emitter(redis, { key: SOCKET_IO_REDIS_KEY });
+    return {
+        async emitToUser(userId, event, payload) {
+            emitter.to(`user:${userId}`).emit(event, payload);
+        },
+        async close() {
+            if (owned && redis.quit)
+                await redis.quit();
+        },
+    };
+};
+//# sourceMappingURL=redis-emitter.js.map

package/dist/redis-emitter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-emitter.js","sourceRoot":"","sources":["../src/redis-emitter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,EAAsB,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAOjE,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,KAAkC,EAAiB,EAAE;IAC9F,MAAM,KAAK,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC;IACxC,MAAM,KAAK,GAAuB,KAAK;QACrC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;QAClD,CAAC,CAAC,KAAK,CAAC;IACV,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,mBAAmB,EAAE,CAAC,CAAC;IACjE,OAAO;QACL,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO;YACrC,OAAO,CAAC,EAAE,CAAC,QAAQ,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACpD,CAAC;QACD,KAAK,CAAC,KAAK;YACT,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI;gBAAE,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QAC9C,CAAC;KACF,CAAC;AACJ,CAAC,CAAC"}

package/dist/socket-io.d.ts

@@ -0,0 +1,9 @@
+import type { Server as HttpServer } from 'node:http';
+import { type IRealtimePort } from './port';
+export type AttachSocketIoOpts = {
+    jwtSecret: string;
+    corsOrigins: string[];
+    redisUrl?: string;
+};
+export declare const attachSocketIoRealtime: (httpServer: HttpServer, opts: AttachSocketIoOpts) => IRealtimePort;
+//# sourceMappingURL=socket-io.d.ts.map

package/dist/socket-io.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socket-io.d.ts","sourceRoot":"","sources":["../src/socket-io.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,WAAW,CAAC;AAKtD,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,QAAQ,CAAC;AAEjE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,eAAO,MAAM,sBAAsB,GACjC,YAAY,UAAU,EACtB,MAAM,kBAAkB,KACvB,aAuCF,CAAC"}

package/dist/socket-io.js

@@ -0,0 +1,47 @@
+import { createAdapter } from '@socket.io/redis-adapter';
+import { verifyAccessToken } from '@ysk-kit/auth';
+import Redis from 'ioredis';
+import { Server } from 'socket.io';
+import { SOCKET_IO_REDIS_KEY } from './port';
+export const attachSocketIoRealtime = (httpServer, opts) => {
+    const io = new Server(httpServer, {
+        cors: { origin: opts.corsOrigins, credentials: true },
+    });
+    let pub;
+    let sub;
+    if (opts.redisUrl) {
+        pub = new Redis(opts.redisUrl, { maxRetriesPerRequest: null });
+        sub = pub.duplicate();
+        io.adapter(createAdapter(pub, sub, { key: SOCKET_IO_REDIS_KEY }));
+    }
+    io.use(async (socket, next) => {
+        const token = socket.handshake.auth?.token;
+        if (typeof token !== 'string') {
+            next(new Error('unauthorized'));
+            return;
+        }
+        try {
+            const claims = await verifyAccessToken(token, opts.jwtSecret);
+            socket.data.userId = claims.sub;
+            next();
+        }
+        catch {
+            next(new Error('unauthorized'));
+        }
+    });
+    io.on('connection', (socket) => {
+        const userId = socket.data.userId;
+        void socket.join(`user:${userId}`);
+    });
+    return {
+        async emitToUser(userId, event, payload) {
+            io.to(`user:${userId}`).emit(event, payload);
+        },
+        async close() {
+            await io.close();
+            await pub?.quit();
+            await sub?.quit();
+        },
+    };
+};
+//# sourceMappingURL=socket-io.js.map

package/dist/socket-io.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"socket-io.js","sourceRoot":"","sources":["../src/socket-io.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAsB,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAQjE,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,UAAsB,EACtB,IAAwB,EACT,EAAE;IACjB,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,UAAU,EAAE;QAChC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE;KACtD,CAAC,CAAC;IACH,IAAI,GAAsB,CAAC;IAC3B,IAAI,GAAsB,CAAC;IAC3B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,GAAG,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/D,GAAG,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;QACtB,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC;QAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;YAChC,OAAO;QACT,CAAC;QACD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9D,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC;YAChC,IAAI,EAAE,CAAC;QACT,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;QAClC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAgB,CAAC;QAC5C,KAAK,MAAM,CAAC,IAAI,CAAC,QAAQ,MAAM,EAAE,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IACH,OAAO;QACL,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO;YACrC,EAAE,CAAC,EAAE,CAAC,QAAQ,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC/C,CAAC;QACD,KAAK,CAAC,KAAK;YACT,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,GAAG,EAAE,IAAI,EAAE,CAAC;YAClB,MAAM,GAAG,EAAE,IAAI,EAAE,CAAC;QACpB,CAAC;KACF,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@ysk-kit/realtime",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@socket.io/redis-adapter": "^8.3.0",
+    "@socket.io/redis-emitter": "^5.1.0",
+    "@ysk-kit/auth": "1.0.0",
+    "ioredis": "^6.0.0",
+    "socket.io": "^4.8.1"
+  },
+  "devDependencies": {
+    "@types/node": "^24.5.2",
+    "typescript": "^6.0.3",
+    "vitest": "^5.0.2"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test": "vitest run --passWithNoTests",
+    "build": "tsc -p tsconfig.build.json"
+  }
+}