Auto-createIndex for TTL. Updated JSDoc, added a quick demo with more…

README.md

@@ -1,3 +1,5 @@
 # @iwsio/mongodb-express-session
 
+[![@iwsio/mongodb-express-session: PUSH to main](https://github.com/iwsllc/mongodb-express-session/actions/workflows/mongodb-session-push-main.yaml/badge.svg)](https://github.com/iwsllc/mongodb-express-session/actions/workflows/mongodb-session-push-main.yaml)
+
 [@iwsio/mongodb-express-session README](./package/README.md)

demo/.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

demo/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+	"extends": [
+		"../eslint-node.json"
+	]
+}

demo/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "demo",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "start": "DEBUG=demo:* node ./dist/bin/web.mjs",
+    "prebuild": "tsc --build --clean tsconfig.build.json && rimraf ./dist",
+    "build": "tsc --build tsconfig.build.json"
+  },
+  "files": [
+    "./dist"
+  ],
+  "dependencies": {
+    "debug": "~2.6.9",
+    "express": "~4.16.1",
+    "express-session": "^1.17.3",
+    "http-errors": "~1.6.3",
+    "morgan": "~1.9.1",
+    "nanoid": "^5.0.3"
+  },
+  "devDependencies": {
+    "@types/express-session": "^1.17.10",
+    "@types/node": "^20.9.2",
+    "@typescript-eslint/eslint-plugin": "^6.11.0",
+    "@typescript-eslint/parser": "^6.11.0",
+    "eslint": "^8.54.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "express-session": "^1.17.3",
+    "mongodb": "^6.3.0",
+    "tslib": "^2.6.2",
+    "typescript": "^5.2.2"
+  }
+}

demo/src/app.mts

@@ -0,0 +1,49 @@
+import createError from 'http-errors'
+import express from 'express'
+import logger from 'morgan'
+import session from 'express-session'
+import { MongoSessionStore } from '@iwsio/mongodb-express-session'
+import { nanoid } from 'nanoid'
+
+export const app = express()
+
+const mongoStore = new MongoSessionStore({
+	uri: 'mongodb://localhost:27017/express_sessions'
+})
+
+app.use(logger('dev'))
+
+app.use(session({
+	secret: 'keyboard cat',
+	resave: false,
+	store: mongoStore,
+	saveUninitialized: false,
+	rolling: true,
+	cookie: { httpOnly: true, maxAge: 1000 * 60 * 60 * 24 * 7, sameSite: 'strict' },
+	name: 'connect.sid'
+}))
+
+app.use((req, _res, next) => {
+	if (req.session.something) {
+		console.log('existing something: ', req.session.something)
+		return next()
+	}
+	req.session.something = nanoid()
+	console.log('new something: ', req.session.something)
+	next()
+})
+
+app.get('/', (_req, res) => {
+	res.status(200).send('OK')
+})
+
+// catch 404 and forward to error handler
+app.use(function(req, res, next) {
+	next(createError(404))
+})
+
+// error handler
+app.use(function(err, _req, res, _next) {
+	res.status(err.status || 500)
+	res.send(err.message)
+})

demo/src/bin/web.mts

@@ -0,0 +1,86 @@
+/* eslint-disable no-process-exit */
+import debugInit from 'debug'
+import { createServer } from 'http'
+import { app } from '../app.mjs'
+
+const debug = debugInit('demo:server')
+/**
+ * Get port from environment and store in Express.
+ */
+
+const port = normalizePort(process.env.PORT || '3000')
+app.set('port', port)
+
+/**
+ * Create HTTP server.
+ */
+
+const server = createServer(app)
+
+/**
+ * Listen on provided port, on all network interfaces.
+ */
+
+server.listen(port)
+server.on('error', onError)
+server.on('listening', onListening)
+
+/**
+ * Normalize a port into a number, string, or false.
+ */
+
+function normalizePort(val) {
+	const port = parseInt(val, 10)
+
+	if (isNaN(port)) {
+		// named pipe
+		return val
+	}
+
+	if (port >= 0) {
+		// port number
+		return port
+	}
+
+	return false
+}
+
+/**
+ * Event listener for HTTP server "error" event.
+ */
+
+function onError(error) {
+	if (error.syscall !== 'listen') {
+		throw error
+	}
+
+	const bind = typeof port === 'string'
+		? 'Pipe ' + port
+		: 'Port ' + port
+
+	// handle specific listen errors with friendly messages
+	switch (error.code) {
+		case 'EACCES':
+			console.error(bind + ' requires elevated privileges')
+			process.exit(1)
+			break
+		case 'EADDRINUSE':
+			console.error(bind + ' is already in use')
+			process.exit(1)
+			break
+		default:
+			throw error
+	}
+}
+
+/**
+ * Event listener for HTTP server "listening" event.
+ */
+
+function onListening() {
+	const addr = server.address()
+	const bind = typeof addr === 'string'
+		? 'pipe ' + addr
+		: 'port ' + addr!.port
+	debug('Listening on ' + bind)
+}

demo/src/global.d.mts

@@ -0,0 +1,7 @@
+declare module 'express-session' {
+	interface SessionData {
+		something?: string
+	}
+}
+
+export {}

demo/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+	"extends": "./tsconfig",
+	"compilerOptions": {
+		"sourceMap": false,
+		"declarationMap": false
+	},
+	"exclude": ["node_modules", "**/*.test.*", "**/__tests__/*", "**/__mocks__/*"],
+	"references": [
+		{ "path": "../package/tsconfig.build.json" }
+	]
+}

demo/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../tsconfig-base.json",
+	"compilerOptions": {
+    "outDir": "./dist",
+		"rootDir": "./src",
+		"noImplicitAny": false
+	},
+	"include": ["src/**/*"],
+	"references": [
+		{ "path": "../package/tsconfig.build.json" }
+	]
+}

docker-compose.yml

@@ -0,0 +1,9 @@
+version: "3.4"
+services:
+  mongo:
+    image: mongo:7
+    restart: always
+    ports:
+      - "27017:27017"
+    # volumes:
+    #   - ../data/mongo:/data/db