session-flash 1.0.6 → 1.0.8

package/.travis.yml

@@ -1,5 +1,6 @@
-language: node_js
-node_js:
-  - 18
-  - 20
-  - 22
+language: "node_js"
+node_js:
+  - 0.4
+  - 0.6
+  - 0.8
+ 

package/lib/flash.js

@@ -0,0 +1,87 @@
+/**
+ * Module dependencies.
+ */
+const { format } = require('util');
+
+/**
+ * Expose `flash()` function on requests.
+ *
+ * @return {Function}
+ * @api public
+ */
+module.exports = function flash(options) {
+  options = options || {};
+  const safe = options.unsafe === undefined ? true : !options.unsafe;
+
+  return function(req, res, next) {
+    if (req.flash && safe) return next();
+    req.flash = _flash;
+    next();
+  };
+};
+
+/**
+ * Queue flash `msg` of the given `type`.
+ *
+ * Examples:
+ *
+ *      req.flash('info', 'email sent');
+ *      req.flash('error', 'email delivery failed');
+ *      req.flash('info', 'email re-sent');
+ *      // => 2
+ *
+ *      req.flash('info');
+ *      // => ['email sent', 'email re-sent']
+ *
+ *      req.flash('info');
+ *      // => []
+ *
+ *      req.flash();
+ *      // => { error: ['email delivery failed'], info: [] }
+ *
+ * Formatting:
+ *
+ * Flash notifications support formatting:
+ *
+ *     req.flash('info', 'email has been sent to %s.', userName);
+ *
+ * Uses `util.format()`.
+ *
+ * @param {String} type
+ * @param {String|Array} msg
+ * @return {Array|Object|Number}
+ * @api public
+ */
+function _flash(type, msg) {
+  if (!this.session) throw new Error('req.flash() requires sessions');
+
+  const msgs = this.session.flash = this.session.flash || {};
+
+  if (type && msg !== undefined) {
+    // Format message if multiple arguments
+    if (arguments.length > 2) {
+      const args = Array.from(arguments).slice(1);
+      msg = format(...args);
+    }
+
+    // Handle array of messages
+    if (Array.isArray(msg)) {
+      msgs[type] = msgs[type] || [];
+      msg.forEach(val => msgs[type].push(val));
+      return msgs[type].length;
+    }
+
+    // Handle single message
+    msgs[type] = msgs[type] || [];
+    return msgs[type].push(msg);
+
+  } else if (type) {
+    const arr = msgs[type] || [];
+    delete msgs[type];
+    return arr;
+
+  } else {
+    this.session.flash = {};
+    return msgs;
+  }
+}

package/lib/index.js

@@ -0,0 +1,4 @@
+/**
+ * Expose middleware.
+ */
+exports = module.exports = require('./flash');

package/package.json

@@ -1,35 +1,23 @@
 {
   "name": "session-flash",
-  "version": "1.0.6",
-  "description": "Flash message middleware for express.",
-  "main": "./lib/index.cjs",
-  "module": "./lib/index.mjs",
-  "types": "./lib/index.d.ts",
-  "exports": {
-    "require": "./lib/index.cjs",
-    "import": "./lib/index.mjs",
-    "types": "./lib/index.d.ts"
-  },
-  "keywords": [
-    "session-flash",
-    "express",
-    "flash",
-    "messages"
-  ],
+  "version": "1.0.8",
+  "description": "Flash message middleware for Session.",
+  "keywords": ["session", "express", "flash", "messages"],
   "author": {
     "name": "Andrew Khabweri",
     "email": "andrewkhabweri@gmail.com"
   },
-  "license": "MIT",
-  "dependencies": {},
+  "licenses": [ {
+    "type": "MIT"
+  } ],
+  "main": "./lib/index.js",
+  "dependencies": {
+  },
   "devDependencies": {
-    "vows": "^0.8.3"
+    "vows": "0.8.x"
   },
   "scripts": {
-    "test": "NODE_PATH=lib node_modules/.bin/vows test/*-test.js",
-    "build": "tsc && echo 'Build complete'"
+    "test": "NODE_PATH=lib node_modules/.bin/vows test/*-test.js"
   },
-  "engines": {
-    "node": ">= 18"
-  }
+  "engines": { "node": ">= 0.8.0" }
 }

package/lib/index.cjs

@@ -1,65 +0,0 @@
-'use strict';
-
-const { format } = require('util');
-
-/**
- * Expose `flash()` function on requests.
- *
- * @param {Object} options
- * @return {Function}
- * @api public
- */
-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();
-    req.flash = _flash;
-    next();
-  };
-};
-
-/**
- * Queue or retrieve flash messages.
- *
- * @param {String} type
- * @param {String|Array} msg
- * @return {Array|Object|Number}
- * @api public
- */
-function _flash(type, msg) {
-  if (!this.session) {
-    throw new Error('req.flash() requires sessions');
-  }
-
-  const flashStore = (this.session.flash ||= {});
-
-  // SET
-  if (type && msg !== undefined) {
-    // Support util.format
-    if (arguments.length > 2) {
-      msg = format.apply(null, Array.prototype.slice.call(arguments, 1));
-    }
-
-    // Support array of messages
-    if (Array.isArray(msg)) {
-      msg.forEach(val => {
-        (flashStore[type] ||= []).push(val);
-      });
-      return flashStore[type].length;
-    }
-
-    return (flashStore[type] ||= []).push(msg);
-  }
-
-  // GET by type
-  if (type) {
-    const messages = flashStore[type] || [];
-    delete flashStore[type];
-    return messages;
-  }
-
-  // GET all
-  this.session.flash = {};
-  return flashStore;
-}

package/lib/index.d.ts

@@ -1,25 +0,0 @@
-import type { RequestHandler } from "express";
-import "express-serve-static-core";
-
-/* Express Request augmentation */
-declare module "express-serve-static-core" {
-  interface Request {
-    flash(): { [key: string]: string[] };
-    flash(type: string): string[];
-    flash(type: string, message: string | string[]): number;
-    flash(type: string, format: string, ...args: unknown[]): number;
-  }
-}
-
-/* session-flash module declaration */
-declare module "session-flash" {
-  interface SessionFlashOptions {
-    unsafe?: boolean;
-  }
-
-  function sessionFlash(
-    options?: SessionFlashOptions
-  ): RequestHandler;
-
-  export = sessionFlash;
-}

package/lib/index.mjs

@@ -1,65 +0,0 @@
-'use strict';
-
-import { format } from 'util';
-
-/**
- * Expose `flash()` function on requests.
- *
- * @param {Object} options
- * @return {Function}
- * @api public
- */
-export default function flash(options = {}) {
-  const safe = options.unsafe === undefined ? true : !options.unsafe;
-
-  return function flashMiddleware(req, res, next) {
-    if (req.flash && safe) return next();
-    req.flash = _flash;
-    next();
-  };
-};
-
-/**
- * Queue or retrieve flash messages.
- *
- * @param {String} type
- * @param {String|Array} msg
- * @return {Array|Object|Number}
- * @api public
- */
-function _flash(type, msg) {
-  if (!this.session) {
-    throw new Error('req.flash() requires sessions');
-  }
-
-  const flashStore = (this.session.flash ||= {});
-
-  // SET
-  if (type && msg !== undefined) {
-    // Support util.format
-    if (arguments.length > 2) {
-      msg = format.apply(null, Array.prototype.slice.call(arguments, 1));
-    }
-
-    // Support array of messages
-    if (Array.isArray(msg)) {
-      msg.forEach(val => {
-        (flashStore[type] ||= []).push(val);
-      });
-      return flashStore[type].length;
-    }
-
-    return (flashStore[type] ||= []).push(msg);
-  }
-
-  // GET by type
-  if (type) {
-    const messages = flashStore[type] || [];
-    delete flashStore[type];
-    return messages;
-  }
-
-  // GET all
-  this.session.flash = {};
-  return flashStore;
-}