@flink-app/generic-auth-plugin 0.11.6 → 0.11.8

package/.flink/generatedHandlers.ts

@@ -1,4 +1,4 @@
-// Generated Thu Jan 30 2025 11:53:42 GMT+0100 (Central European Standard Time)
+// Generated Wed Feb 05 2025 08:57:29 GMT+0100 (Central European Standard Time)
 import { autoRegisteredHandlers, HttpMethod } from "@flink-app/flink";
 import * as UserCreate_0 from "../src/handlers/UserCreate";
 import * as UserLogin_0 from "../src/handlers/UserLogin";

package/.flink/generatedJobs.ts

@@ -1,4 +1,4 @@
-// Generated Thu Jan 30 2025 11:53:42 GMT+0100 (Central European Standard Time)
+// Generated Wed Feb 05 2025 08:57:29 GMT+0100 (Central European Standard Time)
 import { autoRegisteredJobs } from "@flink-app/flink";
 export const jobs = [];
 autoRegisteredJobs.push(...jobs);

package/.flink/generatedRepos.ts

@@ -1,4 +1,4 @@
-// Generated Thu Jan 30 2025 11:53:42 GMT+0100 (Central European Standard Time)
+// Generated Wed Feb 05 2025 08:57:29 GMT+0100 (Central European Standard Time)
   import { autoRegisteredRepos } from "@flink-app/flink";
   export const repos = [];
   autoRegisteredRepos.push(...repos);

package/.flink/schemas/schemas.json

@@ -327,7 +327,7 @@
       "properties": {},
       "definitions": {}
     },
-    "UserPushRegisterToken_7_ReqSchema": {
+    "UserPushRegisterToken_8_ReqSchema": {
       "$schema": "http://json-schema.org/draft-07/schema#",
       "type": "object",
       "additionalProperties": false,
@@ -353,7 +353,7 @@
       ],
       "definitions": {}
     },
-    "UserPushRegisterToken_7_ResSchema": {
+    "UserPushRegisterToken_8_ResSchema": {
       "$schema": "http://json-schema.org/draft-07/schema#",
       "type": "object",
       "additionalProperties": false,

package/.flink/schemas/schemas.ts

@@ -29,7 +29,7 @@ import { PutManagementUserRolesByUseridRes } from "../../src/schemas/Management/
 import { PutManagementUserUsernameByUseridReq } from "../../src/schemas/Management/PutUserUsernameByUseridReq";
 import { PutManagementUserUsernameByUseridRes } from "../../src/schemas/Management/PutUserUsernameByUseridRes";
 
-// Generated Thu Jan 30 2025 11:53:43 GMT+0100 (Central European Standard Time)
+// Generated Wed Feb 05 2025 08:57:30 GMT+0100 (Central European Standard Time)
 export interface UserCreate_7_ReqSchema extends UserCreateReq {}
 
 export interface UserCreate_7_ResSchema extends UserCreateRes {}
@@ -60,9 +60,9 @@ export interface UserProfilePut_5_ReqSchema extends UserProfile {}
 
 export interface UserProfilePut_5_ResSchema extends UserProfile {}
 
-export interface UserPushRegisterToken_7_ReqSchema extends PushNotificationToken {}
+export interface UserPushRegisterToken_8_ReqSchema extends PushNotificationToken {}
 
-export interface UserPushRegisterToken_7_ResSchema extends PushNotificatioNTokenRes {}
+export interface UserPushRegisterToken_8_ResSchema extends PushNotificatioNTokenRes {}
 
 export interface UserPushRemoveToken_7_ReqSchema extends PushNotificationToken {}
 

package/.flink/start.ts

@@ -1,4 +1,4 @@
-// Generated Thu Jan 30 2025 11:53:42 GMT+0100 (Central European Standard Time)
+// Generated Wed Feb 05 2025 08:57:29 GMT+0100 (Central European Standard Time)
 import "./generatedHandlers";
 import "./generatedRepos";
 import "./generatedJobs";

package/dist/.flink/generatedHandlers.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handlers = void 0;
-// Generated Thu Jan 30 2025 11:53:42 GMT+0100 (Central European Standard Time)
+// Generated Wed Feb 05 2025 08:57:29 GMT+0100 (Central European Standard Time)
 var flink_1 = require("@flink-app/flink");
 exports.handlers = [];
 flink_1.autoRegisteredHandlers.push.apply(flink_1.autoRegisteredHandlers, exports.handlers);

package/dist/.flink/generatedJobs.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.jobs = void 0;
-// Generated Thu Jan 30 2025 11:53:42 GMT+0100 (Central European Standard Time)
+// Generated Wed Feb 05 2025 08:57:29 GMT+0100 (Central European Standard Time)
 var flink_1 = require("@flink-app/flink");
 exports.jobs = [];
 flink_1.autoRegisteredJobs.push.apply(flink_1.autoRegisteredJobs, exports.jobs);

package/dist/.flink/generatedRepos.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.repos = void 0;
-// Generated Thu Jan 30 2025 11:53:42 GMT+0100 (Central European Standard Time)
+// Generated Wed Feb 05 2025 08:57:29 GMT+0100 (Central European Standard Time)
 var flink_1 = require("@flink-app/flink");
 exports.repos = [];
 flink_1.autoRegisteredRepos.push.apply(flink_1.autoRegisteredRepos, exports.repos);

package/dist/.flink/schemas/schemas.d.ts

@@ -58,9 +58,9 @@ export interface UserProfilePut_5_ReqSchema extends UserProfile {
 }
 export interface UserProfilePut_5_ResSchema extends UserProfile {
 }
-export interface UserPushRegisterToken_7_ReqSchema extends PushNotificationToken {
+export interface UserPushRegisterToken_8_ReqSchema extends PushNotificationToken {
 }
-export interface UserPushRegisterToken_7_ResSchema extends PushNotificatioNTokenRes {
+export interface UserPushRegisterToken_8_ResSchema extends PushNotificatioNTokenRes {
 }
 export interface UserPushRemoveToken_7_ReqSchema extends PushNotificationToken {
 }

package/dist/.flink/schemas/schemas.json

@@ -327,7 +327,7 @@
             "properties": {},
             "definitions": {}
         },
-        "UserPushRegisterToken_7_ReqSchema": {
+        "UserPushRegisterToken_8_ReqSchema": {
             "$schema": "http://json-schema.org/draft-07/schema#",
             "type": "object",
             "additionalProperties": false,
@@ -353,7 +353,7 @@
             ],
             "definitions": {}
         },
-        "UserPushRegisterToken_7_ResSchema": {
+        "UserPushRegisterToken_8_ResSchema": {
             "$schema": "http://json-schema.org/draft-07/schema#",
             "type": "object",
             "additionalProperties": false,

package/dist/.flink/start.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// Generated Thu Jan 30 2025 11:53:42 GMT+0100 (Central European Standard Time)
+// Generated Wed Feb 05 2025 08:57:29 GMT+0100 (Central European Standard Time)
 require("./generatedHandlers");
 require("./generatedRepos");
 require("./generatedJobs");

package/dist/src/genericAuthPluginOptions.d.ts

@@ -27,6 +27,19 @@ export interface GenericAuthPluginOptions {
     onSuccessfulLogin?: {
         (user: User): Promise<void>;
     };
+    /**
+     * If true, when a new device is registered, all other devices identified by `deviceId`
+     * will be deregistered to avoid duplicate notifications.
+     *
+     * Also as safety measure, any usage of the same firebase token on other users will be
+     * deregistered.
+     */
+    deregisterOtherDevices?: boolean;
+    /**
+     * If true, multiple devices can be registered with the same `deviceId`.
+     * Default is `true`.
+     */
+    allowMultipleDevices?: boolean;
 }
 export interface GenericAuthsmsOptions {
     smsClient: smsClient;

package/dist/src/handlers/UserPushRegisterToken.js

@@ -41,15 +41,19 @@ var flink_1 = require("@flink-app/flink");
 var postUserPushRegisterTokenHandler = function (_a) {
     var ctx = _a.ctx, req = _a.req, origin = _a.origin;
     return __awaiter(void 0, void 0, void 0, function () {
-        var pluginName, repo, user, exToken;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
+        var pluginName, pluginOptions, repo, deregisterOtherDevices, allowMultipleDevices, user, exToken, otherRegistrations, _i, otherRegistrations_1, other, e_1;
+        var _b;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
                 case 0:
                     pluginName = origin || "genericAuthPlugin";
-                    repo = ctx.repos[ctx.plugins[pluginName].repoName];
+                    pluginOptions = ctx.plugins[pluginName];
+                    repo = ctx.repos[pluginOptions.repoName];
+                    deregisterOtherDevices = pluginOptions.deregisterOtherDevices || false;
+                    allowMultipleDevices = (_b = pluginOptions.allowMultipleDevices) !== null && _b !== void 0 ? _b : true;
                     return [4 /*yield*/, repo.getById(req.user._id)];
                 case 1:
-                    user = _b.sent();
+                    user = _c.sent();
                     if (user == null) {
                         return [2 /*return*/, flink_1.notFound("User not found")];
                     }
@@ -60,12 +64,45 @@ var postUserPushRegisterTokenHandler = function (_a) {
                     else {
                         user.pushNotificationTokens.push(req.body);
                     }
+                    if (!allowMultipleDevices) {
+                        // Filter out all other devices except the newly registered one
+                        user.pushNotificationTokens = user.pushNotificationTokens.filter(function (t) { return t.deviceId === req.body.deviceId; });
+                    }
                     return [4 /*yield*/, repo.updateOne(user._id, {
                             pushNotificationTokens: user.pushNotificationTokens,
                         })];
                 case 2:
-                    _b.sent();
-                    return [2 /*return*/, { data: { status: "success" } }];
+                    _c.sent();
+                    if (!deregisterOtherDevices) return [3 /*break*/, 9];
+                    return [4 /*yield*/, repo.findAll({
+                            $or: [{ "pushNotificationTokens.deviceId": req.body.deviceId }, { "pushNotificationTokens.token": req.body.token }],
+                            _id: { $ne: user._id },
+                        })];
+                case 3:
+                    otherRegistrations = _c.sent();
+                    _i = 0, otherRegistrations_1 = otherRegistrations;
+                    _c.label = 4;
+                case 4:
+                    if (!(_i < otherRegistrations_1.length)) return [3 /*break*/, 9];
+                    other = otherRegistrations_1[_i];
+                    _c.label = 5;
+                case 5:
+                    _c.trys.push([5, 7, , 8]);
+                    other.pushNotificationTokens = other.pushNotificationTokens.filter(function (t) { return t.deviceId !== req.body.deviceId && t.token !== req.body.token; });
+                    return [4 /*yield*/, repo.updateOne(other._id, {
+                            pushNotificationTokens: other.pushNotificationTokens,
+                        })];
+                case 6:
+                    _c.sent();
+                    return [3 /*break*/, 8];
+                case 7:
+                    e_1 = _c.sent();
+                    console.error("Error deregistering other devices", e_1);
+                    return [3 /*break*/, 8];
+                case 8:
+                    _i++;
+                    return [3 /*break*/, 4];
+                case 9: return [2 /*return*/, { data: { status: "success" } }];
             }
         });
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/generic-auth-plugin",
-  "version": "0.11.6",
+  "version": "0.11.8",
   "description": "Flink plugin that provides a generic user authentification solution.",
   "scripts": {
     "test": "echo \"Error: no test specified\"",
@@ -30,5 +30,5 @@
     "ts-node": "^9.1.1",
     "typescript": "^4.2.4"
   },
-  "gitHead": "dba26157e6a41c9186a3ff87b821a1e9ea5dfa22"
+  "gitHead": "da8c8ba96bdae7b1abea1f4d3d8f8969f2da3894"
 }

package/src/genericAuthPluginOptions.ts

@@ -22,8 +22,22 @@ export interface GenericAuthPluginOptions {
     usernameFormat?: RegExp;
     sms?: GenericAuthsmsOptions;
     onSuccessfulLogin?: {
-        (user:User): Promise<void>
+        (user: User): Promise<void>;
     };
+    /**
+     * If true, when a new device is registered, all other devices identified by `deviceId`
+     * will be deregistered to avoid duplicate notifications.
+     *
+     * Also as safety measure, any usage of the same firebase token on other users will be
+     * deregistered.
+     */
+    deregisterOtherDevices?: boolean;
+
+    /**
+     * If true, multiple devices can be registered with the same `deviceId`.
+     * Default is `true`.
+     */
+    allowMultipleDevices?: boolean;
 }
 
 export interface GenericAuthsmsOptions {

package/src/handlers/UserPushRegisterToken.ts

@@ -3,14 +3,18 @@ import { genericAuthContext } from "../genericAuthContext";
 import { PushNotificationToken } from "../schemas/PushNotificationToken";
 import { PushNotificatioNTokenRes } from "../schemas/PushNotificationTokenRes";
 import { User } from "../schemas/User";
+import { GenericAuthPluginOptions } from "../genericAuthPluginOptions";
 
 const postUserPushRegisterTokenHandler: Handler<FlinkContext<genericAuthContext>, PushNotificationToken, PushNotificatioNTokenRes> = async ({
     ctx,
     req,
     origin,
 }) => {
-    let pluginName = origin || "genericAuthPlugin";
-    let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
+    const pluginName = origin || "genericAuthPlugin";
+    const pluginOptions: GenericAuthPluginOptions = (ctx.plugins as any)[pluginName];
+    const repo = ctx.repos[pluginOptions.repoName];
+    const deregisterOtherDevices = pluginOptions.deregisterOtherDevices || false;
+    const allowMultipleDevices = pluginOptions.allowMultipleDevices ?? true;
 
     const user = <User>await repo.getById(req.user._id);
 
@@ -26,10 +30,33 @@ const postUserPushRegisterTokenHandler: Handler<FlinkContext<genericAuthContext>
         user.pushNotificationTokens.push(req.body);
     }
 
+    if (!allowMultipleDevices) {
+        // Filter out all other devices except the newly registered one
+        user.pushNotificationTokens = user.pushNotificationTokens.filter((t) => t.deviceId === req.body.deviceId);
+    }
+
     await repo.updateOne(user._id, {
         pushNotificationTokens: user.pushNotificationTokens,
     });
 
+    if (deregisterOtherDevices) {
+        const otherRegistrations = <User[]>await repo.findAll({
+            $or: [{ "pushNotificationTokens.deviceId": req.body.deviceId }, { "pushNotificationTokens.token": req.body.token }],
+            _id: { $ne: user._id },
+        });
+
+        for (let other of otherRegistrations) {
+            try {
+                other.pushNotificationTokens = other.pushNotificationTokens.filter((t) => t.deviceId !== req.body.deviceId && t.token !== req.body.token);
+                await repo.updateOne(other._id, {
+                    pushNotificationTokens: other.pushNotificationTokens,
+                });
+            } catch (e) {
+                console.error("Error deregistering other devices", e);
+            }
+        }
+    }
+
     return { data: { status: "success" } };
 };