@randajan/koa-io-session 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present Jan Randa
+
+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/README.md

@@ -0,0 +1,52 @@
+# @randajan/koa-io-session
+
+[![NPM](https://img.shields.io/npm/v/@randajan/koa-io-session.svg)](https://www.npmjs.com/package/@randajan/koa-io-session) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+
+Simple bridge between `koa-session` and `socket.io`. Shares a unified session across HTTP and WebSocket using a session store.
+
+---
+
+## Install
+
+```bash
+npm i @randajan/koa-io-session
+```
+
+---
+
+## Quick use
+
+```js
+import Koa from "koa";
+import http from "http";
+import { Server } from "socket.io";
+import { attachSession } from "@randajan/koa-io-session";
+
+const app = new Koa();
+const server = http.createServer(app.callback());
+const io = new Server(server);
+
+attachSession(app, io, {
+  key: "koa:sess",
+  signed: true,
+  maxAge: 86400000
+});
+
+io.on("connection", socket => {
+  console.log("session ID:", socket.sessionId);
+  console.log("session data:", socket.session);
+});
+```
+
+---
+
+## Socket helpers
+
+- `socket.sessionId` → session ID from cookies
+- `socket.session` → session object from store
+
+---
+
+## License
+
+MIT © [randajan](https://github.com/randajan)

package/dist/cjs/index.cjs

@@ -0,0 +1,97 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.js
+var index_exports = {};
+__export(index_exports, {
+  attachSession: () => attachSession,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_crypto = __toESM(require("crypto"), 1);
+var import_koa_session = __toESM(require("koa-session"), 1);
+
+// src/SessionStore.js
+var import_props = require("@randajan/props");
+var SessionStore = class {
+  constructor() {
+    (0, import_props.solid)(this, "_recs", /* @__PURE__ */ new Map());
+  }
+  get(sid) {
+    const rec = this._recs.get(sid);
+    if (!rec) {
+      return;
+    }
+    if (Date.now() < rec.expiresAt) {
+      return rec.session;
+    }
+    this.destroy(sid);
+  }
+  set(sid, session2, maxAge) {
+    const expiresAt = Date.now() + maxAge;
+    this._recs.set(sid, { session: session2, expiresAt, maxAge });
+  }
+  destroy(sid) {
+    this._recs.delete(sid);
+  }
+};
+
+// src/index.js
+var import_props2 = require("@randajan/props");
+var uid = (len = 12) => import_crypto.default.randomBytes(len).toString("base64url").slice(0, len);
+var attachSession = (app, io, opt = {}) => {
+  if (!app.keys) {
+    app.keys = Array(6).fill().map(() => uid(12));
+  }
+  if (!opt.key) {
+    opt.key = uid(12);
+  }
+  if (!opt.store) {
+    opt.store = new SessionStore();
+  }
+  const { key, store } = opt;
+  const signed = "signed" in opt ? !!opt.signed : true;
+  delete opt.signed;
+  app.use((0, import_koa_session.default)(opt, app));
+  app.use(async (ctx, next) => {
+    ctx.session.active = true;
+    await next();
+  });
+  io.use(async (socket, next) => {
+    if (!socket.handshake.headers.cookie) {
+      return next(new Error("no cookie"));
+    }
+    const ctx = app.createContext(socket.request, socket.response);
+    const sid = ctx.cookies.get(key, { signed });
+    (0, import_props2.virtual)(socket, "sessionId", (_) => sid);
+    (0, import_props2.virtual)(socket, "session", (_) => store.get(sid));
+    await next();
+  });
+};
+var index_default = attachSession;
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/index.js", "../../src/SessionStore.js"],
+  "sourcesContent": ["import crypto from \"crypto\";\nimport session from \"koa-session\";\nimport { SessionStore } from \"./SessionStore\";\nimport { virtual } from \"@randajan/props\";\n\nconst uid = (len = 12) => crypto.randomBytes(len).toString(\"base64url\").slice(0, len);\n\nexport const attachSession = (app, io, opt = {}) => {\n    if (!app.keys) { app.keys = Array(6).fill().map(() => uid(12)); }\n\n    if (!opt.key) { opt.key = uid(12); }\n    if (!opt.store) { opt.store = new SessionStore(); }\n\n    const { key, store } = opt;\n\n    const signed = (\"signed\" in opt) ? !!opt.signed : true;\n    delete opt.signed;\n\n    app.use(session(opt, app));\n    app.use(async (ctx, next) => {\n        ctx.session.active = true; //idk why but without this it doesnt work :)\n        await next();\n    });\n    \n    io.use(async (socket, next) => {\n    \n        if (!socket.handshake.headers.cookie) { return next(new Error('no cookie')); }\n        \n        const ctx = app.createContext(socket.request, socket.response);\n        const sid = ctx.cookies.get(key, { signed });\n        \n        virtual(socket, \"sessionId\", _=>sid);\n        virtual(socket, \"session\", _=>store.get(sid));\n    \n        await next();\n    });\n};\n\n\n\nexport default attachSession;", "import { solid } from \"@randajan/props\";\r\n\r\n\r\nexport class SessionStore {\r\n    constructor() {\r\n        solid(this, \"_recs\", new Map());\r\n    }\r\n\r\n    get(sid) {\r\n        const rec = this._recs.get(sid);\r\n        if (!rec) { return; }\r\n        if (Date.now() < rec.expiresAt) { return rec.session; }\r\n        this.destroy(sid);\r\n    }\r\n\r\n    set(sid, session, maxAge) {\r\n        const expiresAt = Date.now() + maxAge;\r\n        this._recs.set(sid, { session, expiresAt, maxAge });\r\n    }\r\n\r\n    destroy(sid) {\r\n        this._recs.delete(sid);\r\n    }\r\n};"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAmB;AACnB,yBAAoB;;;ACDpB,mBAAsB;AAGf,IAAM,eAAN,MAAmB;AAAA,EACtB,cAAc;AACV,4BAAM,MAAM,SAAS,oBAAI,IAAI,CAAC;AAAA,EAClC;AAAA,EAEA,IAAI,KAAK;AACL,UAAM,MAAM,KAAK,MAAM,IAAI,GAAG;AAC9B,QAAI,CAAC,KAAK;AAAE;AAAA,IAAQ;AACpB,QAAI,KAAK,IAAI,IAAI,IAAI,WAAW;AAAE,aAAO,IAAI;AAAA,IAAS;AACtD,SAAK,QAAQ,GAAG;AAAA,EACpB;AAAA,EAEA,IAAI,KAAKA,UAAS,QAAQ;AACtB,UAAM,YAAY,KAAK,IAAI,IAAI;AAC/B,SAAK,MAAM,IAAI,KAAK,EAAE,SAAAA,UAAS,WAAW,OAAO,CAAC;AAAA,EACtD;AAAA,EAEA,QAAQ,KAAK;AACT,SAAK,MAAM,OAAO,GAAG;AAAA,EACzB;AACJ;;;ADpBA,IAAAC,gBAAwB;AAExB,IAAM,MAAM,CAAC,MAAM,OAAO,cAAAC,QAAO,YAAY,GAAG,EAAE,SAAS,WAAW,EAAE,MAAM,GAAG,GAAG;AAE7E,IAAM,gBAAgB,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM;AAChD,MAAI,CAAC,IAAI,MAAM;AAAE,QAAI,OAAO,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,MAAM,IAAI,EAAE,CAAC;AAAA,EAAG;AAEhE,MAAI,CAAC,IAAI,KAAK;AAAE,QAAI,MAAM,IAAI,EAAE;AAAA,EAAG;AACnC,MAAI,CAAC,IAAI,OAAO;AAAE,QAAI,QAAQ,IAAI,aAAa;AAAA,EAAG;AAElD,QAAM,EAAE,KAAK,MAAM,IAAI;AAEvB,QAAM,SAAU,YAAY,MAAO,CAAC,CAAC,IAAI,SAAS;AAClD,SAAO,IAAI;AAEX,MAAI,QAAI,mBAAAC,SAAQ,KAAK,GAAG,CAAC;AACzB,MAAI,IAAI,OAAO,KAAK,SAAS;AACzB,QAAI,QAAQ,SAAS;AACrB,UAAM,KAAK;AAAA,EACf,CAAC;AAED,KAAG,IAAI,OAAO,QAAQ,SAAS;AAE3B,QAAI,CAAC,OAAO,UAAU,QAAQ,QAAQ;AAAE,aAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAAA,IAAG;AAE7E,UAAM,MAAM,IAAI,cAAc,OAAO,SAAS,OAAO,QAAQ;AAC7D,UAAM,MAAM,IAAI,QAAQ,IAAI,KAAK,EAAE,OAAO,CAAC;AAE3C,+BAAQ,QAAQ,aAAa,OAAG,GAAG;AACnC,+BAAQ,QAAQ,WAAW,OAAG,MAAM,IAAI,GAAG,CAAC;AAE5C,UAAM,KAAK;AAAA,EACf,CAAC;AACL;AAIA,IAAO,gBAAQ;",
+  "names": ["session", "import_props", "crypto", "session"]
+}

package/dist/esm/index.mjs

@@ -0,0 +1,67 @@
+// src/index.js
+import crypto from "crypto";
+import session from "koa-session";
+
+// src/SessionStore.js
+import { solid } from "@randajan/props";
+var SessionStore = class {
+  constructor() {
+    solid(this, "_recs", /* @__PURE__ */ new Map());
+  }
+  get(sid) {
+    const rec = this._recs.get(sid);
+    if (!rec) {
+      return;
+    }
+    if (Date.now() < rec.expiresAt) {
+      return rec.session;
+    }
+    this.destroy(sid);
+  }
+  set(sid, session2, maxAge) {
+    const expiresAt = Date.now() + maxAge;
+    this._recs.set(sid, { session: session2, expiresAt, maxAge });
+  }
+  destroy(sid) {
+    this._recs.delete(sid);
+  }
+};
+
+// src/index.js
+import { virtual } from "@randajan/props";
+var uid = (len = 12) => crypto.randomBytes(len).toString("base64url").slice(0, len);
+var attachSession = (app, io, opt = {}) => {
+  if (!app.keys) {
+    app.keys = Array(6).fill().map(() => uid(12));
+  }
+  if (!opt.key) {
+    opt.key = uid(12);
+  }
+  if (!opt.store) {
+    opt.store = new SessionStore();
+  }
+  const { key, store } = opt;
+  const signed = "signed" in opt ? !!opt.signed : true;
+  delete opt.signed;
+  app.use(session(opt, app));
+  app.use(async (ctx, next) => {
+    ctx.session.active = true;
+    await next();
+  });
+  io.use(async (socket, next) => {
+    if (!socket.handshake.headers.cookie) {
+      return next(new Error("no cookie"));
+    }
+    const ctx = app.createContext(socket.request, socket.response);
+    const sid = ctx.cookies.get(key, { signed });
+    virtual(socket, "sessionId", (_) => sid);
+    virtual(socket, "session", (_) => store.get(sid));
+    await next();
+  });
+};
+var index_default = attachSession;
+export {
+  attachSession,
+  index_default as default
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/index.js", "../../src/SessionStore.js"],
+  "sourcesContent": ["import crypto from \"crypto\";\nimport session from \"koa-session\";\nimport { SessionStore } from \"./SessionStore\";\nimport { virtual } from \"@randajan/props\";\n\nconst uid = (len = 12) => crypto.randomBytes(len).toString(\"base64url\").slice(0, len);\n\nexport const attachSession = (app, io, opt = {}) => {\n    if (!app.keys) { app.keys = Array(6).fill().map(() => uid(12)); }\n\n    if (!opt.key) { opt.key = uid(12); }\n    if (!opt.store) { opt.store = new SessionStore(); }\n\n    const { key, store } = opt;\n\n    const signed = (\"signed\" in opt) ? !!opt.signed : true;\n    delete opt.signed;\n\n    app.use(session(opt, app));\n    app.use(async (ctx, next) => {\n        ctx.session.active = true; //idk why but without this it doesnt work :)\n        await next();\n    });\n    \n    io.use(async (socket, next) => {\n    \n        if (!socket.handshake.headers.cookie) { return next(new Error('no cookie')); }\n        \n        const ctx = app.createContext(socket.request, socket.response);\n        const sid = ctx.cookies.get(key, { signed });\n        \n        virtual(socket, \"sessionId\", _=>sid);\n        virtual(socket, \"session\", _=>store.get(sid));\n    \n        await next();\n    });\n};\n\n\n\nexport default attachSession;", "import { solid } from \"@randajan/props\";\r\n\r\n\r\nexport class SessionStore {\r\n    constructor() {\r\n        solid(this, \"_recs\", new Map());\r\n    }\r\n\r\n    get(sid) {\r\n        const rec = this._recs.get(sid);\r\n        if (!rec) { return; }\r\n        if (Date.now() < rec.expiresAt) { return rec.session; }\r\n        this.destroy(sid);\r\n    }\r\n\r\n    set(sid, session, maxAge) {\r\n        const expiresAt = Date.now() + maxAge;\r\n        this._recs.set(sid, { session, expiresAt, maxAge });\r\n    }\r\n\r\n    destroy(sid) {\r\n        this._recs.delete(sid);\r\n    }\r\n};"],
+  "mappings": ";AAAA,OAAO,YAAY;AACnB,OAAO,aAAa;;;ACDpB,SAAS,aAAa;AAGf,IAAM,eAAN,MAAmB;AAAA,EACtB,cAAc;AACV,UAAM,MAAM,SAAS,oBAAI,IAAI,CAAC;AAAA,EAClC;AAAA,EAEA,IAAI,KAAK;AACL,UAAM,MAAM,KAAK,MAAM,IAAI,GAAG;AAC9B,QAAI,CAAC,KAAK;AAAE;AAAA,IAAQ;AACpB,QAAI,KAAK,IAAI,IAAI,IAAI,WAAW;AAAE,aAAO,IAAI;AAAA,IAAS;AACtD,SAAK,QAAQ,GAAG;AAAA,EACpB;AAAA,EAEA,IAAI,KAAKA,UAAS,QAAQ;AACtB,UAAM,YAAY,KAAK,IAAI,IAAI;AAC/B,SAAK,MAAM,IAAI,KAAK,EAAE,SAAAA,UAAS,WAAW,OAAO,CAAC;AAAA,EACtD;AAAA,EAEA,QAAQ,KAAK;AACT,SAAK,MAAM,OAAO,GAAG;AAAA,EACzB;AACJ;;;ADpBA,SAAS,eAAe;AAExB,IAAM,MAAM,CAAC,MAAM,OAAO,OAAO,YAAY,GAAG,EAAE,SAAS,WAAW,EAAE,MAAM,GAAG,GAAG;AAE7E,IAAM,gBAAgB,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM;AAChD,MAAI,CAAC,IAAI,MAAM;AAAE,QAAI,OAAO,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,MAAM,IAAI,EAAE,CAAC;AAAA,EAAG;AAEhE,MAAI,CAAC,IAAI,KAAK;AAAE,QAAI,MAAM,IAAI,EAAE;AAAA,EAAG;AACnC,MAAI,CAAC,IAAI,OAAO;AAAE,QAAI,QAAQ,IAAI,aAAa;AAAA,EAAG;AAElD,QAAM,EAAE,KAAK,MAAM,IAAI;AAEvB,QAAM,SAAU,YAAY,MAAO,CAAC,CAAC,IAAI,SAAS;AAClD,SAAO,IAAI;AAEX,MAAI,IAAI,QAAQ,KAAK,GAAG,CAAC;AACzB,MAAI,IAAI,OAAO,KAAK,SAAS;AACzB,QAAI,QAAQ,SAAS;AACrB,UAAM,KAAK;AAAA,EACf,CAAC;AAED,KAAG,IAAI,OAAO,QAAQ,SAAS;AAE3B,QAAI,CAAC,OAAO,UAAU,QAAQ,QAAQ;AAAE,aAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAAA,IAAG;AAE7E,UAAM,MAAM,IAAI,cAAc,OAAO,SAAS,OAAO,QAAQ;AAC7D,UAAM,MAAM,IAAI,QAAQ,IAAI,KAAK,EAAE,OAAO,CAAC;AAE3C,YAAQ,QAAQ,aAAa,OAAG,GAAG;AACnC,YAAQ,QAAQ,WAAW,OAAG,MAAM,IAAI,GAAG,CAAC;AAE5C,UAAM,KAAK;AAAA,EACf,CAAC;AACL;AAIA,IAAO,gBAAQ;",
+  "names": ["session"]
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@randajan/koa-io-session",
+  "version": "0.0.3",
+  "description": "Simple bridge between koa-session and socket.io. Shares a unified session across HTTP and WebSocket using a common session store.",
+  "repository": "randajan/koa-io-session",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.mjs",
+      "require": "./dist/cjs/index.cjs"
+    }
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@randajan/simple-lib": "^3.2.0"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "koa",
+    "socket.io",
+    "session",
+    "koa-session",
+    "websocket",
+    "shared-session",
+    "middleware",
+    "bridge",
+    "auth",
+    "realtime"
+  ],
+  "homepage": "https://github.com/randajan/koa-io-session",
+  "bugs": {
+    "url": "https://github.com/randajan/koa-io-session/issues"
+  },
+  "author": {
+    "name": "Jan Randa",
+    "email": "jnranda@gmail.com",
+    "url": "https://www.linkedin.com/in/randajan/"
+  },
+  "dependencies": {
+    "@randajan/props": "^0.1.4",
+    "crypto": "^1.0.1",
+    "koa-session": "^7.0.2"
+  }
+}