@flink-app/generic-auth-plugin 0.11.5 → 0.11.7

package/.flink/generatedHandlers.ts

@@ -1,4 +1,4 @@
-// Generated Thu Jan 09 2025 19:44:02 GMT+0100 (Central European Standard Time)
+// Generated Tue Feb 04 2025 11:59:42 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 09 2025 19:44:02 GMT+0100 (Central European Standard Time)
+// Generated Tue Feb 04 2025 11:59:43 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 09 2025 19:44:02 GMT+0100 (Central European Standard Time)
+// Generated Tue Feb 04 2025 11:59:42 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,
@@ -337,6 +337,14 @@
         },
         "token": {
           "type": "string"
+        },
+        "platform": {
+          "type": "string",
+          "enum": [
+            "ios",
+            "android",
+            "web"
+          ]
         }
       },
       "required": [
@@ -345,7 +353,7 @@
       ],
       "definitions": {}
     },
-    "UserPushRegisterToken_7_ResSchema": {
+    "UserPushRegisterToken_8_ResSchema": {
       "$schema": "http://json-schema.org/draft-07/schema#",
       "type": "object",
       "additionalProperties": false,
@@ -373,6 +381,14 @@
         },
         "token": {
           "type": "string"
+        },
+        "platform": {
+          "type": "string",
+          "enum": [
+            "ios",
+            "android",
+            "web"
+          ]
         }
       },
       "required": [

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 09 2025 19:44:03 GMT+0100 (Central European Standard Time)
+// Generated Tue Feb 04 2025 11:59:43 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 09 2025 19:44:02 GMT+0100 (Central European Standard Time)
+// Generated Tue Feb 04 2025 11:59:43 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 09 2025 19:44:02 GMT+0100 (Central European Standard Time)
+// Generated Tue Feb 04 2025 11:59:42 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 09 2025 19:44:02 GMT+0100 (Central European Standard Time)
+// Generated Tue Feb 04 2025 11:59:43 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 09 2025 19:44:02 GMT+0100 (Central European Standard Time)
+// Generated Tue Feb 04 2025 11:59:42 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,
@@ -337,6 +337,14 @@
                 },
                 "token": {
                     "type": "string"
+                },
+                "platform": {
+                    "type": "string",
+                    "enum": [
+                        "ios",
+                        "android",
+                        "web"
+                    ]
                 }
             },
             "required": [
@@ -345,7 +353,7 @@
             ],
             "definitions": {}
         },
-        "UserPushRegisterToken_7_ResSchema": {
+        "UserPushRegisterToken_8_ResSchema": {
             "$schema": "http://json-schema.org/draft-07/schema#",
             "type": "object",
             "additionalProperties": false,
@@ -373,6 +381,14 @@
                 },
                 "token": {
                     "type": "string"
+                },
+                "platform": {
+                    "type": "string",
+                    "enum": [
+                        "ios",
+                        "android",
+                        "web"
+                    ]
                 }
             },
             "required": [

package/dist/.flink/start.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// Generated Thu Jan 09 2025 19:44:02 GMT+0100 (Central European Standard Time)
+// Generated Tue Feb 04 2025 11:59:43 GMT+0100 (Central European Standard Time)
 require("./generatedHandlers");
 require("./generatedRepos");
 require("./generatedJobs");

package/dist/src/genericAuthPluginOptions.d.ts

@@ -27,6 +27,14 @@ 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;
 }
 export interface GenericAuthsmsOptions {
     smsClient: smsClient;

package/dist/src/handlers/UserPushRegisterToken.js

@@ -41,12 +41,14 @@ 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;
+        var pluginName, pluginOptions, repo, deregisterOtherDevices, user, exToken, otherRegistrations, _i, otherRegistrations_1, other, e_1;
         return __generator(this, function (_b) {
             switch (_b.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;
                     return [4 /*yield*/, repo.getById(req.user._id)];
                 case 1:
                     user = _b.sent();
@@ -65,11 +67,40 @@ var postUserPushRegisterTokenHandler = function (_a) {
                         })];
                 case 2:
                     _b.sent();
-                    return [2 /*return*/, { data: { status: "success" } }];
+                    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 = _b.sent();
+                    _i = 0, otherRegistrations_1 = otherRegistrations;
+                    _b.label = 4;
+                case 4:
+                    if (!(_i < otherRegistrations_1.length)) return [3 /*break*/, 9];
+                    other = otherRegistrations_1[_i];
+                    _b.label = 5;
+                case 5:
+                    _b.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:
+                    _b.sent();
+                    return [3 /*break*/, 8];
+                case 7:
+                    e_1 = _b.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" } }];
             }
         });
     });
 };
 exports.default = postUserPushRegisterTokenHandler;
 exports.__assumedHttpMethod = "", exports.__file = "UserPushRegisterToken.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "deviceId": { "type": "string" }, "token": { "type": "string" } }, "required": ["deviceId", "token"], "definitions": {} }, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string", "enum": ["success", "failed"] } }, "required": ["status"], "definitions": {} } };
+exports.__schemas = { reqSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "deviceId": { "type": "string" }, "token": { "type": "string" }, "platform": { "type": "string", "enum": ["ios", "android", "web"] } }, "required": ["deviceId", "token"], "definitions": {} }, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string", "enum": ["success", "failed"] } }, "required": ["status"], "definitions": {} } };

package/dist/src/handlers/UserPushRemoveToken.js

@@ -66,4 +66,4 @@ var postUserRemoveTokenHandler = function (_a) {
 };
 exports.default = postUserRemoveTokenHandler;
 exports.__assumedHttpMethod = "", exports.__file = "UserPushRemoveToken.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "deviceId": { "type": "string" }, "token": { "type": "string" } }, "required": ["deviceId", "token"], "definitions": {} }, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string", "enum": ["success", "failed"] } }, "required": ["status"], "definitions": {} } };
+exports.__schemas = { reqSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "deviceId": { "type": "string" }, "token": { "type": "string" }, "platform": { "type": "string", "enum": ["ios", "android", "web"] } }, "required": ["deviceId", "token"], "definitions": {} }, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string", "enum": ["success", "failed"] } }, "required": ["status"], "definitions": {} } };

package/dist/src/schemas/PushNotificationToken.d.ts

@@ -1,4 +1,5 @@
 export interface PushNotificationToken {
     deviceId: string;
     token: string;
+    platform?: "ios" | "android" | "web";
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/generic-auth-plugin",
-  "version": "0.11.5",
+  "version": "0.11.7",
   "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": "3e4488748859fc5f1de798dea4ea2611f9694221"
+  "gitHead": "8df87dd973d5d16d21967ac8269c952a0577446e"
 }

package/src/genericAuthPluginOptions.ts

@@ -22,8 +22,16 @@ 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;
 }
 
 export interface GenericAuthsmsOptions {

package/src/handlers/UserPushRegisterToken.ts

@@ -3,35 +3,55 @@ 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 user = <User>await repo.getById(req.user._id);
-
-  if (user == null) {
-    return notFound("User not found");
-  }
-
-  var exToken = user.pushNotificationTokens.find(
-    (t) => t.deviceId == req.body.deviceId
-  );
-  if (exToken != null) {
-    exToken.token = req.body.token;
-  } else {
-    user.pushNotificationTokens.push(req.body);
-  }
-
-  await repo.updateOne(user._id, {
-    pushNotificationTokens: user.pushNotificationTokens,
-  });
-
-  return { data: { status: "success" } };
+const postUserPushRegisterTokenHandler: Handler<FlinkContext<genericAuthContext>, PushNotificationToken, PushNotificatioNTokenRes> = async ({
+    ctx,
+    req,
+    origin,
+}) => {
+    const pluginName = origin || "genericAuthPlugin";
+    const pluginOptions: GenericAuthPluginOptions = (ctx.plugins as any)[pluginName];
+    const repo = ctx.repos[pluginOptions.repoName];
+    const deregisterOtherDevices = pluginOptions.deregisterOtherDevices || false;
+
+    const user = <User>await repo.getById(req.user._id);
+
+    if (user == null) {
+        return notFound("User not found");
+    }
+
+    let exToken = user.pushNotificationTokens.find((t) => t.deviceId == req.body.deviceId);
+
+    if (exToken != null) {
+        exToken.token = req.body.token;
+    } else {
+        user.pushNotificationTokens.push(req.body);
+    }
+
+    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" } };
 };
 
 export default postUserPushRegisterTokenHandler;

package/src/schemas/PushNotificationToken.ts

@@ -1,4 +1,5 @@
-export interface PushNotificationToken{
-    deviceId : string;
-    token : string;
-}
+export interface PushNotificationToken {
+    deviceId: string;
+    token: string;
+    platform?: "ios" | "android" | "web";
+}

package/src/schemas/UserTokenRes.ts

@@ -1,3 +1,3 @@
-export interface UserTokenRes{
-    token : string
-}
+export interface UserTokenRes {
+    token: string;
+}