@joyu/egg-session-mongo 2.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alibaba Group Holding Limited and other contributors.
+
+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,76 @@
+# egg-session-mongo
+
+[![NPM version][npm-image]][npm-url]
+[![build status][travis-image]][travis-url]
+[![Test coverage][codecov-image]][codecov-url]
+[![David deps][david-image]][david-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+
+[npm-image]: https://img.shields.io/npm/v/egg-session-mongo.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/egg-session-mongo
+[travis-image]: https://img.shields.io/travis/Mitscherlich/egg-session-mongo.svg?style=flat-square
+[travis-url]: https://travis-ci.org/Mitscherlich/egg-session-mongo
+[codecov-image]: https://img.shields.io/codecov/c/github/Mitscherlich/egg-session-mongo.svg?style=flat-square
+[codecov-url]: https://codecov.io/github/Mitscherlich/egg-session-mongo?branch=master
+[david-image]: https://img.shields.io/david/Mitscherlich/egg-session-mongo.svg?style=flat-square
+[david-url]: https://david-dm.org/Mitscherlich/egg-session-mongo
+[snyk-image]: https://snyk.io/test/npm/egg-session-mongo/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/egg-session-mongo
+[download-image]: https://img.shields.io/npm/dm/egg-session-mongo.svg?style=flat-square
+[download-url]: https://npmjs.org/package/egg-session-mongo
+
+A session extension for store session in MongoDB.
+
+see Chinese version: [中文](README.zh_CN.md)
+
+## Install
+
+```bash
+$ npm i egg-session-mongo --save
+```
+
+## Usage
+
+```js
+// {app_root}/config/plugin.js
+exports.sessionMongo = {
+  enable: true,
+  package: 'egg-session-mongo',
+};
+```
+
+or you can overwrite you `MongoStore` options in `app.js`.
+
+```js
+// {app_root}/app.js
+module.exports = app => {
+  const MongoStore = require('egg-session-mongo')(app);
+
+  app.beforeStart(async () => {
+    app.sessionStore = new MongStore(/* options */);
+  });
+};
+```
+
+see [app.js](app.js) for more detail.
+
+## Configuration
+
+```js
+// {app_root}/config/config.default.js
+exports.sessionMongo = {
+  url: 'mongodb://127.0.0.1/test'
+};
+```
+
+see [config/config.example.js](config/config.example.js) for more detail.
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/eggjs/egg/issues).
+or open an issue just at this repo's [issue](https://github.com/Mitscherlich/egg-session-mongo/issues) for more timely reply
+
+## License
+
+[MIT](LICENSE)

package/README.zh_CN.md

@@ -0,0 +1,66 @@
+# egg-session-mongo
+
+[![NPM version][npm-image]][npm-url]
+[![build status][travis-image]][travis-url]
+[![Test coverage][codecov-image]][codecov-url]
+[![David deps][david-image]][david-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+
+[npm-image]: https://img.shields.io/npm/v/egg-session-mongo.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/egg-session-mongo
+[travis-image]: https://img.shields.io/travis/Mitscherlich/egg-session-mongo.svg?style=flat-square
+[travis-url]: https://travis-ci.org/Mitscherlich/egg-session-mongo
+[codecov-image]: https://img.shields.io/codecov/c/github/Mitscherlich/egg-session-mongo.svg?style=flat-square
+[codecov-url]: https://codecov.io/github/Mitscherlich/egg-session-mongo?branch=master
+[david-image]: https://img.shields.io/david/Mitscherlich/egg-session-mongo.svg?style=flat-square
+[david-url]: https://david-dm.org/Mitscherlich/egg-session-mongo
+[snyk-image]: https://snyk.io/test/npm/egg-session-mongo/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/egg-session-mongo
+[download-image]: https://img.shields.io/npm/dm/egg-session-mongo.svg?style=flat-square
+[download-url]: https://npmjs.org/package/egg-session-mongo
+
+基于 [`connect-mongo`](https://github.com/jdesboeufs/connect-mongo) 的 [`egg-session`](https://github.com/eggjs/egg-session) 外部存储插件，将 `session` 存储在 `MongoDB` 中。支持 `connect-mongo` 所有配置。
+
+## 依赖说明
+
+### 依赖的 egg 版本
+
+egg-session-mongo 版本 | egg 1.x
+--- | ---
+1.x | 😁
+0.x | ❌
+
+## 开启插件
+
+```js
+// {app_root}/config/plugin.js
+exports.sessionMongo = {
+  enable: true,
+  package: 'egg-session-mongo',
+};
+```
+
+## 使用场景
+
+支持在 `egg.js` 中扩展插件 `egg-session`，将 session 数据存储在外部 `MongoDB` 数据库中。基于 `connect-mongo` 开发，兼容其所有的配置选项，基于 `native-node-mongo` 原生模块链接 `MongoDB` 链接数据库，可以复用已有的 `mongoose` 或 `mongodb` 数据库连接。
+
+## 详细配置
+
+请到 [config/config.default.js](config/config.default.js) 查看详细配置项说明。
+
+## 单元测试
+
+```bash
+$ git clone --depth 1 https://github.com/Mitscherlich/egg-session-mongo && cd egg-session-mongo
+$ npm i --save
+$ npm run test
+```
+
+## 提问交流
+
+请到 [egg issues](https://github.com/eggjs/egg/issues) 异步交流。
+
+## License
+
+[MIT](LICENSE)

package/app.js

@@ -0,0 +1,10 @@
+'use strict';
+
+module.exports = app => {
+  const MongoStore = require('koa2-session-mongo');
+  const options = app.config.sessionMongo;
+
+  app.beforeStart(async () => {
+    app.sessionStore = new MongoStore(options);
+  });
+};

package/config/config.default.js

@@ -0,0 +1,7 @@
+'use strict';
+
+/**
+ * egg-session-mongo default config
+ */
+exports.sessionMongo = {
+};

package/config/config.example.js

@@ -0,0 +1,18 @@
+'use strict';
+
+/**
+ * egg-session-mongo default config
+ * @member Config#sessionMongo
+ * @property {string}         [url='mongodb://127.0.0.1/test']  - MongoDB server url
+ * @property {string|Object}  [db='test']                       - `String` for a new connection or a exist mongoClient will be reuse if is an object
+ * @property {string}         [collection='sessions']           - Session store collection name
+ * @property {Object}         [mongooseConnection]              - Re-use existing or upcoming mongoose connection
+ * @property {number}         [ttl=1209600]                     - Session expire time
+ */
+exports.sessionMongo = {
+  url: 'mongodb://127.0.0.1',
+  db: 'test',
+  collection: 'sessions',
+  mongooseConnection: null, // uncomment this to re-use existing or upcoming mongoose connection
+  ttl: 14 * 24 * 60 * 60,   // = 14 days. Default
+};

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@joyu/egg-session-mongo",
+  "version": "2.0.3",
+  "description": "MongoDB store for egg session. based on `connect-mongo`.",
+  "main": "index.js",
+  "eggPlugin": {
+    "name": "sessionMongo"
+  },
+  "keywords": [
+    "egg",
+    "eggPlugin",
+    "egg-plugin",
+    "session",
+    "mongo",
+    "MongoDB"
+  ],
+  "dependencies": {
+    "koa2-session-mongo": "^0.1.0",
+    "mongodb": "^7.0.0"
+  },
+  "devDependencies": {
+    "autod": "3.1.2",
+    "autod-egg": "1.1.0",
+    "egg": "3.30.1",
+    "egg-bin": "6.13.0",
+    "egg-ci": "2.2.0",
+    "egg-mock": "5.15.1",
+    "eslint": "9.32.0",
+    "eslint-config-egg": "14.1.0",
+    "mongoose": "8.13.0",
+    "mz-modules": "2.1.0",
+    "supertest": "7.1.0",
+    "webstorm-disable-index": "1.2.0"
+  },
+  "engines": {
+    "node": ">=8.0.0"
+  },
+  "scripts": {
+    "test": "npm run lint -- --fix && egg-bin pkgfiles && npm run test-local",
+    "test-local": "egg-bin test",
+    "cov": "egg-bin cov",
+    "lint": "eslint .",
+    "ci": "egg-bin pkgfiles --check && npm run lint && npm run cov",
+    "pkgfiles": "egg-bin pkgfiles",
+    "autod": "autod"
+  },
+  "files": [
+    "config",
+    "app.js"
+  ],
+  "ci": {
+    "version": "8, 9"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "repository": "https://github.com/joyutech/egg-session-mongo",
+  "bugs": "https://github.com/joyutech/egg-session-mongo/issues",
+  "homepage": "https://github.com/joyutech/egg-session-mongo#readme",
+  "author": "Joyu Team",
+  "license": "MIT"
+}