@privateaim/server-realtime-kit 0.7.0

package/dist/services/authup/utils.js

@@ -0,0 +1,53 @@
+"use strict";
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFakeTokenVerificationData = createFakeTokenVerificationData;
+exports.applyTokenVerificationData = applyTokenVerificationData;
+const kit_1 = require("@authup/kit");
+const core_kit_1 = require("@authup/core-kit");
+const kit_2 = require("@privateaim/kit");
+function generateAbilities() {
+    return Object.values(kit_2.PermissionID).map((name) => ({
+        name,
+    }));
+}
+function createFakeTokenVerificationData() {
+    return {
+        realm_id: 'd94b2f28-29e3-4ced-b8f1-6923a01dc1ee',
+        realm_name: core_kit_1.REALM_MASTER_NAME,
+        sub_kind: 'user',
+        sub: 'd94b2f28-29e3-4ced-b8f1-6923a01dc1ee',
+        sub_name: 'admin',
+        permissions: generateAbilities(),
+    };
+}
+function applyTokenVerificationData(socket, data, fakeAbilities) {
+    let abilities;
+    if (fakeAbilities) {
+        abilities = generateAbilities();
+    }
+    else {
+        abilities = data.permissions;
+    }
+    socket.data.realmId = data.realm_id;
+    socket.data.realmName = data.realm_name;
+    socket.data.abilities = new kit_1.Abilities(abilities);
+    switch (data.sub_kind) {
+        case kit_1.OAuth2SubKind.USER: {
+            socket.data.userId = data.sub;
+            socket.data.userName = data.sub_name;
+            break;
+        }
+        case kit_1.OAuth2SubKind.ROBOT: {
+            socket.data.robotId = data.sub;
+            socket.data.robotName = data.sub_name;
+            break;
+        }
+    }
+}
+//# sourceMappingURL=utils.js.map

package/dist/services/authup/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/services/authup/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAyBH,0EAWC;AAED,gEA4BC;AA/DD,qCAAuD;AACvD,+CAAqD;AAErD,yCAA+C;AAa/C,SAAS,iBAAiB;IACtB,OAAO,MAAM,CAAC,MAAM,CAAC,kBAAY,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC9C,IAAI;KACY,CAAA,CAAC,CAAC;AAC1B,CAAC;AAED,SAAgB,+BAA+B;IAC3C,OAAO;QACH,QAAQ,EAAE,sCAAsC;QAChD,UAAU,EAAE,4BAAiB;QAE7B,QAAQ,EAAE,MAAM;QAChB,GAAG,EAAE,sCAAsC;QAC3C,QAAQ,EAAE,OAAO;QAEjB,WAAW,EAAE,iBAAiB,EAAE;KACnC,CAAC;AACN,CAAC;AAED,SAAgB,0BAA0B,CACtC,MAAc,EACd,IAAkC,EAClC,aAAuB;IAEvB,IAAI,SAAoB,CAAC;IACzB,IAAI,aAAa,EAAE,CAAC;QAChB,SAAS,GAAG,iBAAiB,EAAE,CAAC;IACpC,CAAC;SAAM,CAAC;QACJ,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;IACpC,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;IACxC,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,eAAS,CAAC,SAAS,CAAC,CAAC;IAEjD,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;QACpB,KAAK,mBAAa,CAAC,IAAI,CAAC,CAAC,CAAC;YACtB,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC;YAC9B,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YACrC,MAAM;QACV,CAAC;QACD,KAAK,mBAAa,CAAC,KAAK,CAAC,CAAC,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;YACtC,MAAM;QACV,CAAC;IACL,CAAC;AACL,CAAC"}

package/dist/services/index.d.ts

@@ -0,0 +1,2 @@
+export * from './authup';
+//# sourceMappingURL=index.d.ts.map

package/dist/services/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AAOA,cAAc,UAAU,CAAC"}

package/dist/services/index.js

@@ -0,0 +1,24 @@
+"use strict";
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./authup"), exports);
+//# sourceMappingURL=index.js.map

package/dist/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;AAEH,2CAAyB"}

package/dist/types.d.ts

@@ -0,0 +1,25 @@
+import type { Realm, Robot, User } from '@authup/core-kit';
+import type { Abilities } from '@authup/kit';
+import type { Namespace as _Namespace, Server as _Server, Socket as _Socket } from 'socket.io';
+export type SocketData = {
+    abilities?: Abilities;
+    realmId?: Realm['id'];
+    realmName?: Realm['name'];
+    userId?: User['id'];
+    userName?: User['name'];
+    robotId?: Robot['id'];
+    robotName?: Robot['name'];
+    namespaceId?: string;
+    roomSubscriptions: Record<string, number>;
+};
+export interface EventsMap {
+    [p: string]: any;
+}
+export interface DefaultEventsMap {
+    [p: string]: (...args: any[]) => void;
+}
+export type Server<ListenEvents extends EventsMap = DefaultEventsMap, EmitEvents extends EventsMap = ListenEvents, ServerSideEvents extends EventsMap = DefaultEventsMap, Data extends SocketData = SocketData> = _Server<ListenEvents, EmitEvents, ServerSideEvents, Data>;
+export type Socket<ListenEvents extends EventsMap = DefaultEventsMap, EmitEvents extends EventsMap = ListenEvents, ServerSideEvents extends EventsMap = DefaultEventsMap, Data extends SocketData = SocketData> = _Socket<ListenEvents, EmitEvents, ServerSideEvents, Data>;
+export type Namespace<ListenEvents extends EventsMap = DefaultEventsMap, EmitEvents extends EventsMap = ListenEvents, ServerSideEvents extends EventsMap = DefaultEventsMap, Data extends SocketData = SocketData> = _Namespace<ListenEvents, EmitEvents, ServerSideEvents, Data>;
+export type Middleware<ListenEvents extends EventsMap = DefaultEventsMap, EmitEvents extends EventsMap = ListenEvents, ServerSideEvents extends EventsMap = DefaultEventsMap, Data extends SocketData = SocketData> = (socket: Socket<ListenEvents, EmitEvents, ServerSideEvents, Data>, next: (err?: Error) => void) => void | Promise<void>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EACR,SAAS,IAAI,UAAU,EACvB,MAAM,IAAI,OAAO,EACjB,MAAM,IAAI,OAAO,EACpB,MAAM,WAAW,CAAC;AAEnB,MAAM,MAAM,UAAU,GAAG;IACrB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,OAAO,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACtB,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B,MAAM,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,QAAQ,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAExB,OAAO,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACtB,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC7C,CAAC;AAEF,MAAM,WAAW,SAAS;IACtB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC7B,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;CACxC;AAED,MAAM,MAAM,MAAM,CACd,YAAY,SAAS,SAAS,GAAG,gBAAgB,EACjD,UAAU,SAAS,SAAS,GAAG,YAAY,EAC3C,gBAAgB,SAAS,SAAS,GAAG,gBAAgB,EACrD,IAAI,SAAS,UAAU,GAAG,UAAU,IACpC,OAAO,CAAC,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;AAE9D,MAAM,MAAM,MAAM,CACd,YAAY,SAAS,SAAS,GAAG,gBAAgB,EACjD,UAAU,SAAS,SAAS,GAAG,YAAY,EAC3C,gBAAgB,SAAS,SAAS,GAAG,gBAAgB,EACrD,IAAI,SAAS,UAAU,GAAG,UAAU,IACpC,OAAO,CAAC,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;AAE9D,MAAM,MAAM,SAAS,CACjB,YAAY,SAAS,SAAS,GAAG,gBAAgB,EACjD,UAAU,SAAS,SAAS,GAAG,YAAY,EAC3C,gBAAgB,SAAS,SAAS,GAAG,gBAAgB,EACrD,IAAI,SAAS,UAAU,GAAG,UAAU,IACpC,UAAU,CAAC,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;AAEjE,MAAM,MAAM,UAAU,CAClB,YAAY,SAAS,SAAS,GAAG,gBAAgB,EACjD,UAAU,SAAS,SAAS,GAAG,YAAY,EAC3C,gBAAgB,SAAS,SAAS,GAAG,gBAAgB,EACrD,IAAI,SAAS,UAAU,GAAG,UAAU,IACpC,CACA,MAAM,EAAE,MAAM,CAAC,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAChE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,KAC1B,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/dist/types.js

@@ -0,0 +1,9 @@
+"use strict";
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/package.json

@@ -0,0 +1,36 @@
+{
+    "name": "@privateaim/server-realtime-kit",
+    "version": "0.7.0",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "author": {
+        "name": "Peter Placzek",
+        "email": "contact@tada5hi.net",
+        "url": "https://tada5hi.net"
+    },
+    "license": "Apache-2.0",
+    "description": "This package contains the realtime application which connects the API with socket based clients.",
+    "dependencies": {
+        "@authup/kit": "^1.0.0-beta.18",
+        "@authup/core-kit": "^1.0.0-beta.18",
+        "@authup/core-realtime-kit": "^1.0.0-beta.18",
+        "@authup/server-core-plugin-kit": "^1.0.0-beta.18",
+        "@authup/server-core-plugin-socket-io": "^1.0.0-beta.18",
+        "@privateaim/kit": "^0.7.0",
+        "@privateaim/server-kit": "^0.7.0",
+        "@ebec/http": "^2.3.0"
+    },
+    "devDependencies": {
+        "redis-extension": "^1.5.0",
+        "socket.io": "^4.7.5"
+    },
+    "peerDependencies": {
+        "redis-extension": "^1.5.0",
+        "socket.io": "^4.7.5"
+    },
+    "scripts": {
+        "dev": "ts-node src/index.ts",
+        "build": "rimraf dist && tsc -p tsconfig.build.json",
+        "start": "node dist/index.js"
+    }
+}

package/src/helpers/index.ts

@@ -0,0 +1,8 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export * from './room-subscriptions';

package/src/helpers/room-subscriptions.ts

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import type { Socket } from '../types';
+
+export function subscribeSocketRoom(
+    socket: Socket,
+    roomName: string,
+) {
+    if (!socket.data.roomSubscriptions) {
+        socket.data.roomSubscriptions = {};
+    }
+
+    if (!socket.data.roomSubscriptions[roomName]) {
+        socket.data.roomSubscriptions[roomName] = 0;
+    }
+
+    socket.data.roomSubscriptions[roomName]++;
+
+    socket.join(roomName);
+}
+
+export function unsubscribeSocketRoom(
+    socket: Socket,
+    roomName: string,
+) {
+    if (!socket.data.roomSubscriptions) {
+        return;
+    }
+
+    if (socket.data.roomSubscriptions[roomName]) {
+        if (socket.data.roomSubscriptions[roomName] > 1) {
+            socket.data.roomSubscriptions[roomName]--;
+        } else {
+            delete socket.data.roomSubscriptions[roomName];
+        }
+    }
+
+    if (!socket.data.roomSubscriptions[roomName]) {
+        socket.leave(roomName);
+    }
+}

package/src/index.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export * from './helpers';
+export * from './middlewares';
+export * from './services';
+export * from './types';

package/src/middlewares/force-logged-in.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2021-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { UnauthorizedError } from '@ebec/http';
+import type { Namespace, Server } from '../types';
+
+export function mountForceLoggedInMiddleware(input: Namespace | Server) {
+    input.use((socket, next) => {
+        if (socket.data.userId || socket.data.robotId) {
+            next();
+            return;
+        }
+
+        next(new UnauthorizedError());
+    });
+}

package/src/middlewares/index.ts

@@ -0,0 +1,8 @@
+/*
+ * Copyright (c) 2022-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export * from './force-logged-in';

package/src/services/authup/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export * from './middleware';
+export * from './types';

package/src/services/authup/middleware.ts

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import type { TokenCreatorOptions } from '@authup/core-http-kit';
+import type { TokenVerifierRedisCacheOptions } from '@authup/server-core-plugin-kit';
+import { createMiddleware } from '@authup/server-core-plugin-socket-io';
+import type {
+    Middleware, Namespace, Server, Socket,
+} from '../../types';
+import type { AuthupMiddlewareRegistrationOptions } from './types';
+import { applyTokenVerificationData, createFakeTokenVerificationData } from './utils';
+
+export function createAuthupMiddleware(
+    options: AuthupMiddlewareRegistrationOptions,
+) : Middleware {
+    let baseURL : string | undefined;
+    if (options.baseURL) {
+        baseURL = options.baseURL;
+    } else if (options.client) {
+        baseURL = options.client.getBaseURL();
+    }
+
+    if (!baseURL) {
+        const data = createFakeTokenVerificationData();
+
+        return (socket, next) => {
+            applyTokenVerificationData(socket, data, options.fakeAbilities);
+            next();
+        };
+    }
+
+    let tokenCreator : TokenCreatorOptions;
+    if (options.vault) {
+        tokenCreator = {
+            type: 'robotInVault',
+            name: 'system',
+            vault: options.vault,
+            baseURL,
+        };
+    } else {
+        tokenCreator = {
+            type: 'user',
+            name: 'admin',
+            password: 'start123',
+            baseURL,
+        };
+    }
+
+    let tokenCache : TokenVerifierRedisCacheOptions | undefined;
+    if (options.redis) {
+        tokenCache = {
+            type: 'redis',
+            client: options.redis,
+        };
+    }
+
+    return createMiddleware({
+        tokenVerifier: {
+            baseURL,
+            creator: tokenCreator,
+            cache: tokenCache,
+        },
+        tokenVerifierHandler: (
+            socket: Socket,
+            data,
+        ) => applyTokenVerificationData(socket, data, options.fakeAbilities),
+    });
+}
+
+export function mountAuthupMiddleware(
+    nsp: Namespace | Server,
+    options: AuthupMiddlewareRegistrationOptions,
+) {
+    const middleware = createAuthupMiddleware(options);
+    nsp.use(middleware);
+}

package/src/services/authup/types.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import type { VaultClient } from '@hapic/vault';
+import type { Client as RedisClient } from 'redis-extension';
+import type { Client as AuthupClient } from '@authup/core-http-kit';
+
+export type AuthupMiddlewareRegistrationOptions = {
+    baseURL?: string,
+    client?: AuthupClient,
+    vault?: VaultClient | string,
+    redis?: RedisClient | string,
+    fakeAbilities?: boolean
+};

package/src/services/authup/utils.ts

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import type { Ability } from '@authup/kit';
+import { Abilities, OAuth2SubKind } from '@authup/kit';
+import { REALM_MASTER_NAME } from '@authup/core-kit';
+import type { TokenVerificationData } from '@authup/server-core-plugin-kit';
+import { PermissionID } from '@privateaim/kit';
+import type { Socket } from '../../types';
+
+type TokenVerificationDataMinimal = Pick<
+TokenVerificationData,
+'permissions' |
+'realm_id' |
+'realm_name' |
+'sub' |
+'sub_kind' |
+'sub_name'
+>;
+
+function generateAbilities(): Ability[] {
+    return Object.values(PermissionID).map((name) => ({
+        name,
+    } satisfies Ability));
+}
+
+export function createFakeTokenVerificationData(): TokenVerificationDataMinimal {
+    return {
+        realm_id: 'd94b2f28-29e3-4ced-b8f1-6923a01dc1ee',
+        realm_name: REALM_MASTER_NAME,
+
+        sub_kind: 'user',
+        sub: 'd94b2f28-29e3-4ced-b8f1-6923a01dc1ee',
+        sub_name: 'admin',
+
+        permissions: generateAbilities(),
+    };
+}
+
+export function applyTokenVerificationData(
+    socket: Socket,
+    data: TokenVerificationDataMinimal,
+    fakeAbilities?: boolean,
+) {
+    let abilities: Ability[];
+    if (fakeAbilities) {
+        abilities = generateAbilities();
+    } else {
+        abilities = data.permissions;
+    }
+
+    socket.data.realmId = data.realm_id;
+    socket.data.realmName = data.realm_name;
+    socket.data.abilities = new Abilities(abilities);
+
+    switch (data.sub_kind) {
+        case OAuth2SubKind.USER: {
+            socket.data.userId = data.sub;
+            socket.data.userName = data.sub_name;
+            break;
+        }
+        case OAuth2SubKind.ROBOT: {
+            socket.data.robotId = data.sub;
+            socket.data.robotName = data.sub_name;
+            break;
+        }
+    }
+}

package/src/services/index.ts

@@ -0,0 +1,8 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export * from './authup';

package/src/types.ts

@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import type { Realm, Robot, User } from '@authup/core-kit';
+import type { Abilities } from '@authup/kit';
+import type {
+    Namespace as _Namespace,
+    Server as _Server,
+    Socket as _Socket,
+} from 'socket.io';
+
+export type SocketData = {
+    abilities?: Abilities,
+
+    realmId?: Realm['id'],
+    realmName?: Realm['name'],
+
+    userId?: User['id'],
+    userName?: User['name'],
+
+    robotId?: Robot['id'],
+    robotName?: Robot['name'],
+
+    namespaceId?: string,
+    roomSubscriptions: Record<string, number>,
+};
+
+export interface EventsMap {
+    [p: string]: any
+}
+
+export interface DefaultEventsMap {
+    [p: string]: (...args: any[]) => void
+}
+
+export type Server<
+    ListenEvents extends EventsMap = DefaultEventsMap,
+    EmitEvents extends EventsMap = ListenEvents,
+    ServerSideEvents extends EventsMap = DefaultEventsMap,
+    Data extends SocketData = SocketData,
+> = _Server<ListenEvents, EmitEvents, ServerSideEvents, Data>;
+
+export type Socket<
+    ListenEvents extends EventsMap = DefaultEventsMap,
+    EmitEvents extends EventsMap = ListenEvents,
+    ServerSideEvents extends EventsMap = DefaultEventsMap,
+    Data extends SocketData = SocketData,
+> = _Socket<ListenEvents, EmitEvents, ServerSideEvents, Data>;
+
+export type Namespace<
+    ListenEvents extends EventsMap = DefaultEventsMap,
+    EmitEvents extends EventsMap = ListenEvents,
+    ServerSideEvents extends EventsMap = DefaultEventsMap,
+    Data extends SocketData = SocketData,
+> = _Namespace<ListenEvents, EmitEvents, ServerSideEvents, Data>;
+
+export type Middleware<
+    ListenEvents extends EventsMap = DefaultEventsMap,
+    EmitEvents extends EventsMap = ListenEvents,
+    ServerSideEvents extends EventsMap = DefaultEventsMap,
+    Data extends SocketData = SocketData,
+> = (
+    socket: Socket<ListenEvents, EmitEvents, ServerSideEvents, Data>,
+    next: (err?: Error) => void
+) => void | Promise<void>;

package/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+    "extends": "../../tsconfig.build.json",
+
+    "compilerOptions": {
+        "outDir": "./dist"
+    },
+
+    "include": [
+        "src/**/*.ts"
+    ]
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "extends": "../../tsconfig.json",
+    "compilerOptions": {
+        "paths": {
+            "@privateaim/kit": [
+                "./packages/kit/src"
+            ],
+            "@privateaim/server-kit": [
+                "./packages/server-kit/src"
+            ]
+        }
+    }
+}