Invitation Code Verification Module

spezi-invitation-code/.eslintrc.js

@@ -0,0 +1,24 @@
+//
+// This source file is part of the PAWS application based on the Stanford Spezi Template Application project
+//
+// SPDX-FileCopyrightText: 2023 Stanford University
+//
+// SPDX-License-Identifier: MIT
+//
+
+module.exports = {
+  root: true,
+  env: {
+    es2020: true,
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "google",
+  ],
+  rules: {
+    "quotes": ["error", "double"],
+    "max-len": ["error", {"code": 150}],
+  },
+};
+

spezi-invitation-code/.gitignore

@@ -0,0 +1,75 @@
+#
+# This source file is part of the PAWS application based on the Stanford Spezi Template Application project
+#
+# SPDX-FileCopyrightText: 2023 Stanford University
+#
+# SPDX-License-Identifier: MIT
+#
+
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+firebase-debug.log*
+firebase-debug.*.log*
+
+# Firebase cache
+.firebase/
+
+# Firebase config
+
+# Uncomment this if you'd like others to create their own Firebase project.
+# For a team working on the same Firebase project(s), it is recommended to leave
+# it commented so all members can deploy to the same project(s) in .firebaserc.
+# .firebaserc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env

spezi-invitation-code/index.js

@@ -0,0 +1,72 @@
+//
+// This source file is part of the StudyApplication based on the Stanford Spezi Template Application project
+//
+// SPDX-FileCopyrightText: 2023 Stanford University
+//
+// SPDX-License-Identifier: MIT
+//
+
+const admin = require("firebase-admin");
+const {https} = require("firebase-functions/v2");
+const {FieldValue} = require("firebase-admin/firestore");
+
+class InvitationCodeVerifier {
+  constructor(firestore) {
+    this.firestore = firestore;
+  }
+
+  async verifyInvitationCode(invitationCode, userId) {
+    try {
+      const invitationCodeRef = this.firestore.doc(`invitationCodes/${invitationCode}`);
+      const invitationCodeDoc = await invitationCodeRef.get();
+
+      if (!invitationCodeDoc.exists || invitationCodeDoc.data().used) {
+        throw new https.HttpsError("not-found", "Invitation code not found or already used.");
+      }
+
+      const userStudyRef = this.firestore.doc(`users/${userId}`);
+      const userStudyDoc = await userStudyRef.get();
+
+      if (userStudyDoc.exists) {
+        throw new https.HttpsError("already-exists", "User is already enrolled in the study.");
+      }
+
+      await this.firestore.runTransaction(async (transaction) => {
+        transaction.set(userStudyRef, {
+          invitationCode: invitationCode,
+          dateOfEnrollment: FieldValue.serverTimestamp(),
+        });
+
+        transaction.update(invitationCodeRef, {
+          used: true,
+          usedBy: userId,
+        });
+      });
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  async validateUserInvitationCode(userId) {
+    try {
+      const invitationQuerySnapshot = await this.firestore.collection("invitationCodes")
+        .where("usedBy", "==", userId)
+        .limit(1)
+        .get();
+
+      if (invitationQuerySnapshot.empty) {
+        throw new https.HttpsError("not-found", `No valid invitation code found for user ${userId}.`);
+      }
+
+      const userDoc = await this.firestore.doc(`users/${userId}`).get();
+
+      if (!userDoc.exists || userDoc.data().invitationCode !== invitationQuerySnapshot.docs[0].id) {
+        throw new https.HttpsError("failed-precondition", "User document does not exist or contains incorrect invitation code.");
+      }
+    } catch (error) {
+      throw error;
+    }
+  }
+}
+
+module.exports = InvitationCodeVerifier;

spezi-invitation-code/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "spezi-invitation-code",
+  "version": "1.0.0",
+  "description": "Invitation code verifier for Spezi Firebase",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "MIT"
+}

spezi-invitation-code/package.json.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Stanford University
+
+SPDX-License-Identifier: MIT