@prairielearn/flash 1.0.0

package/README.md

@@ -0,0 +1,55 @@
+# `@prairielearn/flash`
+
+Adds support for flash messages to Express applications.
+
+## Usage
+
+`req.session` must exist; [`express-session`](https://www.npmjs.com/package/express-session) is the most common way to use sessions in Express.
+
+```ts
+import express from 'express';
+import session from 'express-session';
+import { flashMiddleware } from '@prairielearn/flash';
+
+const app = express();
+
+app.use(
+  session({
+    // See https://www.npmjs.com/package/express-session for more information
+    // about configuring the session middleware.
+    secret: 'secret',
+    resave: false,
+    saveUninitialized: true,
+  })
+);
+app.use(flashMiddleware());
+```
+
+Now, you can use the `flash()` function exported by `@prairielearn/flash` to read/write flash messages.
+
+```ts
+import { flash } from '@prairielearn/flash';
+
+app.get('/set-flash', (req, res) => {
+  flash('notice', 'Your preferences have been updated.');
+  flash('success', 'Course created successfully.');
+  flash('warning', 'Syncing completed with 5 warnings.');
+  flash('error', 'Group must have fewer than 10 members.');
+
+  res.redirect('/display-flash');
+});
+
+app.get('/display-flash', (req, res) => {
+  const messages = flash();
+  res.json(messages);
+});
+```
+
+The `flash()` function has three behaviors:
+
+- `flash(type: string, message: string)`: Set a message with the given type.
+- `flash(type: string): FlashMessage[]`: Get all messages with the given type.
+- `flash(types: string[]): FlashMessage[]`: Get all messages with any of the given types.
+- `flash(): FlashMessage[]`: Get all messages.
+
+Once a message is read, it is immediately removed from the persisted list of messages. A message is _only_ removed once it is read; it will be persisted indefinitely if it iw not.

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import { Request, Response, NextFunction } from 'express';
+export type FlashMessageType = 'notice' | 'success' | 'warning' | 'error';
+export interface FlashMessage {
+    type: FlashMessageType;
+    message: string;
+}
+export declare function flashMiddleware(): (req: Request, _res: Response, next: NextFunction) => void;
+export declare function flash(): FlashMessage[];
+export declare function flash(type: FlashMessageType): FlashMessage[];
+export declare function flash(type: FlashMessageType[]): FlashMessage[];
+export declare function flash(type: FlashMessageType, message: string): void;

package/dist/index.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.flash = exports.flashMiddleware = void 0;
+const node_async_hooks_1 = require("node:async_hooks");
+const als = new node_async_hooks_1.AsyncLocalStorage();
+function flashMiddleware() {
+    return (req, _res, next) => {
+        const flashStorage = makeFlashStorage(req);
+        als.run(flashStorage, () => next());
+    };
+}
+exports.flashMiddleware = flashMiddleware;
+function flash(type, message) {
+    const flashStorage = als.getStore();
+    if (!flashStorage) {
+        throw new Error('flash() must be called within a request');
+    }
+    if (Array.isArray(type)) {
+        const messages = type.flatMap((type) => flashStorage.get(type));
+        type.forEach((t) => flashStorage.clear(t));
+        return messages;
+    }
+    if (type != null && message != null) {
+        flashStorage.add(type, message);
+        return;
+    }
+    if (type != null) {
+        const message = flashStorage.get(type);
+        flashStorage.clear(type);
+        return message;
+    }
+    const messages = flashStorage.getAll();
+    flashStorage.clearAll();
+    return messages;
+}
+exports.flash = flash;
+function makeFlashStorage(req) {
+    if (!req.session) {
+        throw new Error('@prairielearn/flash requires session support');
+    }
+    const session = req.session;
+    return {
+        add(type, message) {
+            session.flash ??= [];
+            session.flash.push({ type, message });
+        },
+        get(type) {
+            const messages = session.flash ?? [];
+            return messages.filter((message) => message.type === type);
+        },
+        getAll() {
+            return session.flash ?? [];
+        },
+        clear(type) {
+            session.flash = session.flash?.filter((message) => message.type !== type) ?? [];
+        },
+        clearAll() {
+            session.flash = [];
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uDAAqD;AAGrD,MAAM,GAAG,GAAG,IAAI,oCAAiB,EAAgB,CAAC;AASlD,SAAgB,eAAe;IAC7B,OAAO,CAAC,GAAY,EAAE,IAAc,EAAE,IAAkB,EAAE,EAAE;QAC1D,MAAM,YAAY,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;QAC3C,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;IACtC,CAAC,CAAC;AACJ,CAAC;AALD,0CAKC;AAMD,SAAgB,KAAK,CAAC,IAA4C,EAAE,OAAgB;IAClF,MAAM,YAAY,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;IACpC,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;KAC5D;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,OAAO,QAAQ,CAAC;KACjB;IAED,IAAI,IAAI,IAAI,IAAI,IAAI,OAAO,IAAI,IAAI,EAAE;QACnC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAChC,OAAO;KACR;IAED,IAAI,IAAI,IAAI,IAAI,EAAE;QAChB,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzB,OAAO,OAAO,CAAC;KAChB;IAED,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;IACvC,YAAY,CAAC,QAAQ,EAAE,CAAC;IACxB,OAAO,QAAQ,CAAC;AAClB,CAAC;AA1BD,sBA0BC;AAUD,SAAS,gBAAgB,CAAC,GAAY;IACpC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;KACjE;IAED,MAAM,OAAO,GAAG,GAAG,CAAC,OAAc,CAAC;IAEnC,OAAO;QACL,GAAG,CAAC,IAAsB,EAAE,OAAe;YACzC,OAAO,CAAC,KAAK,KAAK,EAAE,CAAC;YACrB,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QACxC,CAAC;QACD,GAAG,CAAC,IAAsB;YACxB,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;YACrC,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAqB,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAC3E,CAAC;QACD,MAAM;YACJ,OAAO,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;QAC7B,CAAC;QACD,KAAK,CAAC,IAAsB;YAC1B,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAqB,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;QAChG,CAAC;QACD,QAAQ;YACN,OAAO,CAAC,KAAK,GAAG,EAAE,CAAC;QACrB,CAAC;KACqB,CAAC;AAC3B,CAAC"}

package/dist/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.test.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const index_1 = require("./index");
+describe('flash', () => {
+    it('throws an error if no session present', () => {
+        chai_1.assert.throw(() => {
+            (0, index_1.flashMiddleware)()({}, {}, () => { });
+        });
+    });
+    it('throws an error when middleware is not used', () => {
+        chai_1.assert.throw(() => {
+            (0, index_1.flash)('notice', 'Hello world');
+        });
+    });
+    it('adds a flash', () => {
+        const req = {
+            session: {},
+        };
+        const res = {};
+        (0, index_1.flashMiddleware)()(req, res, () => {
+            (0, index_1.flash)('notice', 'hello world');
+            chai_1.assert.sameDeepMembers((0, index_1.flash)(), [{ type: 'notice', message: 'hello world' }]);
+        });
+    });
+    it('stores multiples flashes with the same type', () => {
+        const req = {
+            session: {},
+        };
+        const res = {};
+        (0, index_1.flashMiddleware)()(req, res, () => {
+            (0, index_1.flash)('notice', 'hello world');
+            (0, index_1.flash)('notice', 'goodbye world');
+            chai_1.assert.sameDeepMembers((0, index_1.flash)(), [
+                { type: 'notice', message: 'hello world' },
+                { type: 'notice', message: 'goodbye world' },
+            ]);
+        });
+    });
+    it('returns flash message for a given type', () => {
+        const req = {
+            session: {},
+        };
+        const res = {};
+        (0, index_1.flashMiddleware)()(req, res, () => {
+            (0, index_1.flash)('notice', 'hello world');
+            (0, index_1.flash)('error', 'goodbye world');
+            chai_1.assert.sameDeepMembers((0, index_1.flash)('notice'), [{ type: 'notice', message: 'hello world' }]);
+            chai_1.assert.sameDeepMembers((0, index_1.flash)('error'), [{ type: 'error', message: 'goodbye world' }]);
+        });
+    });
+    it('returns all flashes', () => {
+        const req = {
+            session: {},
+        };
+        const res = {};
+        (0, index_1.flashMiddleware)()(req, res, () => {
+            (0, index_1.flash)('notice', 'hello world');
+            (0, index_1.flash)('error', 'goodbye world');
+            chai_1.assert.sameDeepMembers((0, index_1.flash)(), [
+                { type: 'notice', message: 'hello world' },
+                { type: 'error', message: 'goodbye world' },
+            ]);
+        });
+    });
+    it('clears flash after it has been read', () => {
+        const req = {
+            session: {},
+        };
+        const res = {};
+        (0, index_1.flashMiddleware)()(req, res, () => {
+            (0, index_1.flash)('notice', 'hello world');
+            (0, index_1.flash)('error', 'goodbye world');
+            chai_1.assert.sameDeepMembers((0, index_1.flash)('notice'), [{ type: 'notice', message: 'hello world' }]);
+            chai_1.assert.sameDeepMembers((0, index_1.flash)('error'), [{ type: 'error', message: 'goodbye world' }]);
+            chai_1.assert.deepEqual((0, index_1.flash)('notice'), []);
+            chai_1.assert.deepEqual((0, index_1.flash)('error'), []);
+            chai_1.assert.isEmpty((0, index_1.flash)());
+        });
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAE9B,mCAAiD;AAEjD,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,aAAM,CAAC,KAAK,CAAC,GAAG,EAAE;YAChB,IAAA,uBAAe,GAAE,CAAC,EAAS,EAAE,EAAS,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,aAAM,CAAC,KAAK,CAAC,GAAG,EAAE;YAChB,IAAA,aAAK,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;QACtB,MAAM,GAAG,GAAG;YACV,OAAO,EAAE,EAAE;SACL,CAAC;QACT,MAAM,GAAG,GAAG,EAAS,CAAC;QAEtB,IAAA,uBAAe,GAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;YAC/B,IAAA,aAAK,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;YAE/B,aAAM,CAAC,eAAe,CAAC,IAAA,aAAK,GAAE,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,GAAG,GAAG;YACV,OAAO,EAAE,EAAE;SACL,CAAC;QACT,MAAM,GAAG,GAAG,EAAS,CAAC;QAEtB,IAAA,uBAAe,GAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;YAC/B,IAAA,aAAK,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;YAC/B,IAAA,aAAK,EAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;YAEjC,aAAM,CAAC,eAAe,CAAC,IAAA,aAAK,GAAE,EAAE;gBAC9B,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE;gBAC1C,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,EAAE;aAC7C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,GAAG,GAAG;YACV,OAAO,EAAE,EAAE;SACL,CAAC;QACT,MAAM,GAAG,GAAG,EAAS,CAAC;QAEtB,IAAA,uBAAe,GAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;YAC/B,IAAA,aAAK,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;YAC/B,IAAA,aAAK,EAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YAEhC,aAAM,CAAC,eAAe,CAAC,IAAA,aAAK,EAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;YACtF,aAAM,CAAC,eAAe,CAAC,IAAA,aAAK,EAAC,OAAO,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC7B,MAAM,GAAG,GAAG;YACV,OAAO,EAAE,EAAE;SACL,CAAC;QACT,MAAM,GAAG,GAAG,EAAS,CAAC;QAEtB,IAAA,uBAAe,GAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;YAC/B,IAAA,aAAK,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;YAC/B,IAAA,aAAK,EAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YAEhC,aAAM,CAAC,eAAe,CAAC,IAAA,aAAK,GAAE,EAAE;gBAC9B,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE;gBAC1C,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE;aAC5C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,GAAG,GAAG;YACV,OAAO,EAAE,EAAE;SACL,CAAC;QACT,MAAM,GAAG,GAAG,EAAS,CAAC;QAEtB,IAAA,uBAAe,GAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;YAC/B,IAAA,aAAK,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;YAC/B,IAAA,aAAK,EAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YAEhC,aAAM,CAAC,eAAe,CAAC,IAAA,aAAK,EAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;YACtF,aAAM,CAAC,eAAe,CAAC,IAAA,aAAK,EAAC,OAAO,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC;YAEtF,aAAM,CAAC,SAAS,CAAC,IAAA,aAAK,EAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;YACtC,aAAM,CAAC,SAAS,CAAC,IAAA,aAAK,EAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YACrC,aAAM,CAAC,OAAO,CAAC,IAAA,aAAK,GAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@prairielearn/flash",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/PrairieLearn/PrairieLearn.git",
+    "directory": "packages/flash"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch --preserveWatchOutput",
+    "test": "mocha --no-config --require ts-node/register src/index.test.ts"
+  },
+  "devDependencies": {
+    "@prairielearn/tsconfig": "^0.0.0",
+    "@types/express": "^4.17.17",
+    "@types/express-session": "^1.17.7",
+    "@types/node": "^18.16.16",
+    "mocha": "^10.2.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.3"
+  }
+}

package/src/express-session.d.ts

@@ -0,0 +1,7 @@
+import 'express-session';
+
+declare module 'express-session' {
+  interface SessionData {
+    flash?: Record<string, string>;
+  }
+}

package/src/index.test.ts

@@ -0,0 +1,98 @@
+import { assert } from 'chai';
+
+import { flashMiddleware, flash } from './index';
+
+describe('flash', () => {
+  it('throws an error if no session present', () => {
+    assert.throw(() => {
+      flashMiddleware()({} as any, {} as any, () => {});
+    });
+  });
+
+  it('throws an error when middleware is not used', () => {
+    assert.throw(() => {
+      flash('notice', 'Hello world');
+    });
+  });
+
+  it('adds a flash', () => {
+    const req = {
+      session: {},
+    } as any;
+    const res = {} as any;
+
+    flashMiddleware()(req, res, () => {
+      flash('notice', 'hello world');
+
+      assert.sameDeepMembers(flash(), [{ type: 'notice', message: 'hello world' }]);
+    });
+  });
+
+  it('stores multiples flashes with the same type', () => {
+    const req = {
+      session: {},
+    } as any;
+    const res = {} as any;
+
+    flashMiddleware()(req, res, () => {
+      flash('notice', 'hello world');
+      flash('notice', 'goodbye world');
+
+      assert.sameDeepMembers(flash(), [
+        { type: 'notice', message: 'hello world' },
+        { type: 'notice', message: 'goodbye world' },
+      ]);
+    });
+  });
+
+  it('returns flash message for a given type', () => {
+    const req = {
+      session: {},
+    } as any;
+    const res = {} as any;
+
+    flashMiddleware()(req, res, () => {
+      flash('notice', 'hello world');
+      flash('error', 'goodbye world');
+
+      assert.sameDeepMembers(flash('notice'), [{ type: 'notice', message: 'hello world' }]);
+      assert.sameDeepMembers(flash('error'), [{ type: 'error', message: 'goodbye world' }]);
+    });
+  });
+
+  it('returns all flashes', () => {
+    const req = {
+      session: {},
+    } as any;
+    const res = {} as any;
+
+    flashMiddleware()(req, res, () => {
+      flash('notice', 'hello world');
+      flash('error', 'goodbye world');
+
+      assert.sameDeepMembers(flash(), [
+        { type: 'notice', message: 'hello world' },
+        { type: 'error', message: 'goodbye world' },
+      ]);
+    });
+  });
+
+  it('clears flash after it has been read', () => {
+    const req = {
+      session: {},
+    } as any;
+    const res = {} as any;
+
+    flashMiddleware()(req, res, () => {
+      flash('notice', 'hello world');
+      flash('error', 'goodbye world');
+
+      assert.sameDeepMembers(flash('notice'), [{ type: 'notice', message: 'hello world' }]);
+      assert.sameDeepMembers(flash('error'), [{ type: 'error', message: 'goodbye world' }]);
+
+      assert.deepEqual(flash('notice'), []);
+      assert.deepEqual(flash('error'), []);
+      assert.isEmpty(flash());
+    });
+  });
+});

package/src/index.ts

@@ -0,0 +1,86 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { Request, Response, NextFunction } from 'express';
+
+const als = new AsyncLocalStorage<FlashStorage>();
+
+export type FlashMessageType = 'notice' | 'success' | 'warning' | 'error';
+
+export interface FlashMessage {
+  type: FlashMessageType;
+  message: string;
+}
+
+export function flashMiddleware() {
+  return (req: Request, _res: Response, next: NextFunction) => {
+    const flashStorage = makeFlashStorage(req);
+    als.run(flashStorage, () => next());
+  };
+}
+
+export function flash(): FlashMessage[];
+export function flash(type: FlashMessageType): FlashMessage[];
+export function flash(type: FlashMessageType[]): FlashMessage[];
+export function flash(type: FlashMessageType, message: string): void;
+export function flash(type?: FlashMessageType | FlashMessageType[], message?: string) {
+  const flashStorage = als.getStore();
+  if (!flashStorage) {
+    throw new Error('flash() must be called within a request');
+  }
+
+  if (Array.isArray(type)) {
+    const messages = type.flatMap((type) => flashStorage.get(type));
+    type.forEach((t) => flashStorage.clear(t));
+    return messages;
+  }
+
+  if (type != null && message != null) {
+    flashStorage.add(type, message);
+    return;
+  }
+
+  if (type != null) {
+    const message = flashStorage.get(type);
+    flashStorage.clear(type);
+    return message;
+  }
+
+  const messages = flashStorage.getAll();
+  flashStorage.clearAll();
+  return messages;
+}
+
+interface FlashStorage {
+  add(type: FlashMessageType, message: string): void;
+  get(type: FlashMessageType): FlashMessage[] | null;
+  getAll(): FlashMessage[];
+  clear(type: FlashMessageType): void;
+  clearAll(): void;
+}
+
+function makeFlashStorage(req: Request): FlashStorage {
+  if (!req.session) {
+    throw new Error('@prairielearn/flash requires session support');
+  }
+
+  const session = req.session as any;
+
+  return {
+    add(type: FlashMessageType, message: string) {
+      session.flash ??= [];
+      session.flash.push({ type, message });
+    },
+    get(type: FlashMessageType) {
+      const messages = session.flash ?? [];
+      return messages.filter((message: FlashMessage) => message.type === type);
+    },
+    getAll() {
+      return session.flash ?? [];
+    },
+    clear(type: FlashMessageType) {
+      session.flash = session.flash?.filter((message: FlashMessage) => message.type !== type) ?? [];
+    },
+    clearAll() {
+      session.flash = [];
+    },
+  } satisfies FlashStorage;
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@prairielearn/tsconfig/tsconfig.package.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "types": ["mocha", "node", "express-session"],
+  }
+}