@midwayjs/session 3.0.0-beta.9

package/README.md

@@ -0,0 +1,112 @@
+# @midwayjs/session
+
+Session component for @midwayjs/koa and @midwayjs/faas
+
+
+## Install
+
+```bash
+$ npm i @midwayjs/session --save
+$ npm i @types/koa-session --save-dev
+```
+
+
+## Usage
+
+@midwayjs/koa has enabled this component by default, @midwayjs/faas needs to be manually enabled.
+
+```bash
+// src/configuration.ts
+
+import { join } from 'path';
+import * as faas from '@midwayjs/faas';
+import * as session from '@midwayjs/session';
+
+@Configuration({
+  imports: [
+    faas,
+    session,
+  ],
+  // ...
+})
+export class ContainerLifeCycle implements ILifeCycle {}
+
+```
+
+## Config
+
+You can configure session in your `config.*.ts`.
+
+default value.
+
+```ts
+export const session = {
+  maxAge: 24 * 3600 * 1000, // ms
+  key: 'mw.sess',
+  httpOnly: true,
+  encrypt: true,
+  // sameSite: null,
+  logValue: true,
+};
+```
+
+you can use all config from koa-session.
+
+## Custom Session Store
+
+Write a session store class first, extends abstract `SessionStore` class.
+
+```ts
+import { SessionStore } from '@midwayjs/session';
+
+@Provide()
+@Scope(ScopeEnum.Singleton)
+export class MemorySessionStore extends SessionStore {
+  sessions = {};
+  async get(key) {
+    return this.sessions[key];
+  }
+
+  async set(key, value) {
+    this.sessions[key] = value;
+  }
+
+  async destroy(key) {
+    this.sessions[key] = undefined;
+  }
+}
+```
+
+add custom sessionStore to session component.
+
+```ts
+import { MemorySessionStore } from './store';
+import * as session from '@midwayjs/session';
+
+@Configuration({
+  imports: [
+    koa,
+    session,
+  ],
+  //...
+})
+export class AutoConfiguration {
+  @Inject()
+  memoryStore: MemorySessionStore;
+
+  @Inject()
+  sessionStoreManager: session.SessionStoreManager;
+
+  async onReady() {
+    this.sessionStoreManager.setSessionStore(this.memoryStore);
+  }
+}
+```
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/midwayjs/midway/issues/).
+
+## License
+
+MIT

package/dist/config/config.default.d.ts

@@ -0,0 +1,7 @@
+export declare const session: {
+    maxAge: number;
+    key: string;
+    httpOnly: boolean;
+    logValue: boolean;
+};
+//# sourceMappingURL=config.default.d.ts.map

package/dist/config/config.default.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.session = void 0;
+exports.session = {
+    maxAge: 24 * 3600 * 1000,
+    key: 'MW_SESS',
+    httpOnly: true,
+    // sameSite: null,
+    logValue: true,
+};
+//# sourceMappingURL=config.default.js.map

package/dist/configuration.d.ts

@@ -0,0 +1,8 @@
+import { MidwayApplicationManager } from '@midwayjs/core';
+export declare class SessionConfiguration {
+    applicationManager: MidwayApplicationManager;
+    logger: any;
+    sessionConfig: any;
+    onReady(): Promise<void>;
+}
+//# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -0,0 +1,59 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionConfiguration = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const DefaultConfig = require("./config/config.default");
+const session_1 = require("./middleware/session");
+const core_1 = require("@midwayjs/core");
+let SessionConfiguration = class SessionConfiguration {
+    async onReady() {
+        this.applicationManager.getApplications(['koa', 'faas']).forEach(app => {
+            if (app.on) {
+                // listen on session's events
+                app.on('session:missed', ({ ctx, key }) => {
+                    this.logger.warn('[session][missed] key(%s)', key);
+                });
+                app.on('session:expired', ({ ctx, key, value }) => {
+                    this.logger.warn('[session][expired] key(%s) value(%j)', key, this.sessionConfig.logValue ? value : '');
+                });
+                app.on('session:invalid', ({ ctx, key, value }) => {
+                    this.logger.warn('[session][invalid] key(%s) value(%j)', key, this.sessionConfig.logValue ? value : '');
+                });
+            }
+            app.useMiddleware(session_1.SessionMiddleware);
+        });
+    }
+};
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayApplicationManager)
+], SessionConfiguration.prototype, "applicationManager", void 0);
+__decorate([
+    (0, decorator_1.Logger)('coreLogger'),
+    __metadata("design:type", Object)
+], SessionConfiguration.prototype, "logger", void 0);
+__decorate([
+    (0, decorator_1.Config)('session'),
+    __metadata("design:type", Object)
+], SessionConfiguration.prototype, "sessionConfig", void 0);
+SessionConfiguration = __decorate([
+    (0, decorator_1.Configuration)({
+        namespace: 'session',
+        importConfigs: [
+            {
+                default: DefaultConfig,
+            },
+        ],
+    })
+], SessionConfiguration);
+exports.SessionConfiguration = SessionConfiguration;
+//# sourceMappingURL=configuration.js.map

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { SessionConfiguration as Configuration } from './configuration';
+export * from './middleware/session';
+export * from './store';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 });
+exports.Configuration = void 0;
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.SessionConfiguration; } });
+__exportStar(require("./middleware/session"), exports);
+__exportStar(require("./store"), exports);
+//# sourceMappingURL=index.js.map

package/dist/middleware/session.d.ts

@@ -0,0 +1,9 @@
+import { IMiddleware } from '@midwayjs/core';
+import { SessionStoreManager } from '../store';
+export declare class SessionMiddleware implements IMiddleware<any, any> {
+    sessionConfig: any;
+    logger: any;
+    sessionStoreManager: SessionStoreManager;
+    resolve(app: any): any;
+}
+//# sourceMappingURL=session.d.ts.map

package/dist/middleware/session.js

@@ -0,0 +1,44 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionMiddleware = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const koaSession = require("koa-session");
+const store_1 = require("../store");
+let SessionMiddleware = class SessionMiddleware {
+    resolve(app) {
+        if (!this.sessionConfig.httpOnly) {
+            this.logger.warn('[midway-session]: please set `config.session.httpOnly` to true. It is very dangerous if session can read by client JavaScript.');
+        }
+        const store = this.sessionStoreManager.getSessionStore();
+        if (store) {
+            this.sessionConfig.store = store;
+        }
+        return koaSession(this.sessionConfig, app);
+    }
+};
+__decorate([
+    (0, decorator_1.Config)('session'),
+    __metadata("design:type", Object)
+], SessionMiddleware.prototype, "sessionConfig", void 0);
+__decorate([
+    (0, decorator_1.Logger)(),
+    __metadata("design:type", Object)
+], SessionMiddleware.prototype, "logger", void 0);
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", store_1.SessionStoreManager)
+], SessionMiddleware.prototype, "sessionStoreManager", void 0);
+SessionMiddleware = __decorate([
+    (0, decorator_1.Middleware)()
+], SessionMiddleware);
+exports.SessionMiddleware = SessionMiddleware;
+//# sourceMappingURL=session.js.map

package/dist/store.d.ts

@@ -0,0 +1,11 @@
+export declare abstract class SessionStore {
+    abstract get(key: string): any;
+    abstract set(key: string, value: string, maxAge: number): any;
+    abstract destroy(key: any): any;
+}
+export declare class SessionStoreManager {
+    private sessionStore;
+    setSessionStore(sessionStore: any): void;
+    getSessionStore(): SessionStore;
+}
+//# sourceMappingURL=store.d.ts.map

package/dist/store.js

@@ -0,0 +1,27 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionStoreManager = exports.SessionStore = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+class SessionStore {
+}
+exports.SessionStore = SessionStore;
+let SessionStoreManager = class SessionStoreManager {
+    setSessionStore(sessionStore) {
+        this.sessionStore = sessionStore;
+    }
+    getSessionStore() {
+        return this.sessionStore;
+    }
+};
+SessionStoreManager = __decorate([
+    (0, decorator_1.Provide)(),
+    (0, decorator_1.Scope)(decorator_1.ScopeEnum.Singleton)
+], SessionStoreManager);
+exports.SessionStoreManager = SessionStoreManager;
+//# sourceMappingURL=store.js.map

package/index.d.ts

@@ -0,0 +1,8 @@
+import { opts } from 'koa-session';
+export * from './dist/index';
+
+declare module '@midwayjs/core/dist/interface' {
+  interface MidwayConfig {
+    session: Partial<opts>;
+  }
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@midwayjs/session",
+  "description": "midway session component for koa and faas",
+  "version": "3.0.0-beta.9",
+  "main": "dist/index",
+  "typings": "index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "index.d.ts"
+  ],
+  "devDependencies": {
+    "@midwayjs/core": "^3.0.0-beta.9",
+    "@midwayjs/decorator": "^3.0.0-beta.9",
+    "@midwayjs/mock": "^3.0.0-beta.9",
+    "@types/koa-session": "^5.10.4"
+  },
+  "dependencies": {
+    "koa-session": "^6.2.0"
+  },
+  "keywords": [
+    "midway",
+    "web",
+    "koa",
+    "faas",
+    "session"
+  ],
+  "author": "czy88840616 <czy88840616@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --coverage --forceExit",
+    "ci": "npm run test",
+    "lint": "mwts check"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/midwayjs/midway.git"
+  }
+}