session-flash 1.0.0 → 1.0.2

package/.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - 18
+  - 20
+  - 22

package/lib/index.d.ts

@@ -0,0 +1,18 @@
+
+declare namespace Express {
+    export interface Request {
+        flash(): { [key: string]: string[] };
+        flash(message: string): string[];
+        flash(type: string, message: string[] | string): number;
+        flash(type: string, format: string, ...args: any[]): number;
+    }
+}
+
+declare module "session-flash" {
+    import express = require("express");
+    interface IConnectFlashOptions {
+        unsafe?: boolean | undefined;
+    }
+    function e(options?: IConnectFlashOptions): express.RequestHandler;
+    export = e;
+}

package/lib/index.js

@@ -1,56 +1,66 @@
-'use strict';
-
-const { format } = require('node:util');
-
-module.exports = function flash(options = {}) {
-  const safe = options.unsafe === undefined ? true : !options.unsafe;
-
-  return function flashMiddleware(req, res, next) {
-    if (req.flash && safe) return next();
-
-    Object.defineProperty(req, 'flash', {
-      configurable: true,
-      enumerable: false,
-      writable: false,
-      value: flashHandler.bind(req)
-    });
-
-    next();
-  };
-};
-
-function flashHandler(type, msg) {
-  if (!this.session) {
-    throw new Error(
-      'req.flash() requires session middleware (express-session)'
-    );
-  }
-
-  const store = (this.session.flash ??= Object.create(null));
-
-  // ADD message(s)
-  if (type && arguments.length > 1) {
-    if (arguments.length > 2) {
-      msg = format(...Array.prototype.slice.call(arguments, 1));
-    }
-
-    if (Array.isArray(msg)) {
-      store[type] = store[type] || [];
-      store[type].push(...msg);
-      return store[type].length;
-    }
-
-    return (store[type] = store[type] || []).push(msg);
-  }
-
-  // GET messages of a type
-  if (type) {
-    const messages = store[type] || [];
-    delete store[type];
-    return messages;
-  }
-
-  // GET all messages
-  this.session.flash = Object.create(null);
-  return store;
-}
+/**
+ * Simple session flash middleware
+ * Requires express-session to be set up first
+ */
+
+module.exports = function sessionFlash(options) {
+    options = options || {};
+    const unsafe = options.unsafe === true;
+
+    return function (req, res, next) {
+        if (!req.session) {
+            throw new Error("session-flash requires express-session");
+        }
+
+        if (!req.session.flash) {
+            req.session.flash = {};
+        }
+
+        /**
+         * flash()
+         * flash(type)
+         * flash(type, message)
+         * flash(type, format, ...args)
+         */
+        req.flash = function (type, message) {
+            // flash() → return all messages
+            if (arguments.length === 0) {
+                const flash = req.session.flash;
+                req.session.flash = {};
+                return flash;
+            }
+
+            // flash(type) → return messages for type
+            if (arguments.length === 1) {
+                const messages = req.session.flash[type] || [];
+                delete req.session.flash[type];
+                return messages;
+            }
+
+            // flash(type, message | format, ...args)
+            let msg;
+
+            if (typeof message === "string" && arguments.length > 2) {
+                // format string with args
+                const args = Array.prototype.slice.call(arguments, 2);
+                msg = message.replace(/%s/g, () => args.shift());
+            } else {
+                msg = message;
+            }
+
+            if (!Array.isArray(req.session.flash[type])) {
+                req.session.flash[type] = [];
+            }
+
+            if (Array.isArray(msg)) {
+                req.session.flash[type].push.apply(req.session.flash[type], msg);
+                return msg.length;
+            } else {
+                req.session.flash[type].push(msg);
+                return 1;
+            }
+        };
+
+        next();
+    };
+};

package/package.json

@@ -1,18 +1,34 @@
 {
   "name": "session-flash",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Flash message middleware for express.",
-  "keywords": ["session-flash", "express", "flash", "messages"],
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    "require": "./lib/index.js"
+  },
+  "keywords": [
+    "session-flash",
+    "express",
+    "flash",
+    "messages"
+  ],
   "author": {
     "name": "Andrew Khabweri",
     "email": "andrewkhabweri@gmail.com"
   },
   "license": "MIT",
-  "main": "./lib/index.js",
-  "dependencies": {
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "typescript": "^5.9.3",
+    "vows": "0.8.x"
+  },
+  "scripts": {
+    "test": "NODE_PATH=lib node_modules/.bin/vows test/*-test.js",
+    "build": "tsc && echo 'Build complete'"
   },
   "engines": {
     "node": ">= 18"
   }
-
 }

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": false,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+
+    "rootDir": ".",
+    "outDir": ".",
+
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "target": "ES2020",
+    "module": "CommonJS",
+
+    "types": ["node"],
+    "skipLibCheck": true
+  },
+  "include": [
+    "lib/index.js"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}