@flink-app/generic-auth-plugin 1.0.0 → 2.0.0-alpha.101

package/src/handlers/UserPasswordPut.ts

@@ -4,32 +4,25 @@ import { genericAuthContext } from "../genericAuthContext";
 import { UserPasswordChangeReq } from "../schemas/UserPasswordChangeReq";
 import { UserPasswordChangeRes } from "../schemas/UserPasswordChangeRes";
 
-const putUserPasswordHandler: Handler<
-  FlinkContext<genericAuthContext>,
-  UserPasswordChangeReq,
-  UserPasswordChangeRes
-> = async ({ ctx, req, origin }) => {
-  let pluginName = origin || "genericAuthPlugin";
-  let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
-  const resp = await ctx.plugins.genericAuthPlugin.changePassword(
-    repo,
-    <JwtAuthPlugin>ctx.auth,
-    req.user._id,
-    req.body.password,
-    ctx.plugins.genericAuthPlugin.createPasswordHashAndSaltMethod
-  );
+const putUserPasswordHandler: Handler<FlinkContext<genericAuthContext>, UserPasswordChangeReq, UserPasswordChangeRes> = async ({ ctx, req, origin }) => {
+    let pluginName = origin || "genericAuthPlugin";
+    let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
+    const resp = await ctx.plugins.genericAuthPlugin.changePassword(
+        repo,
+        <JwtAuthPlugin>ctx.auth,
+        req.user._id,
+        req.body.password,
+        ctx.plugins.genericAuthPlugin.createPasswordHashAndSaltMethod
+    );
 
-  switch (resp.status) {
-    case "failed":
-      return badRequest(
-        "Password could not be changed on this user",
-        resp.status
-      );
-    case "passwordError":
-      return badRequest("Invalid password", resp.status);
-  }
+    switch (resp.status) {
+        case "failed":
+            return badRequest("Password could not be changed on this user", resp.status);
+        case "passwordError":
+            return badRequest("Invalid password", resp.status);
+    }
 
-  return { data: resp, status: 200 };
+    return { data: resp, status: 200 };
 };
 
 export default putUserPasswordHandler;

package/src/handlers/UserPasswordResetComplete.ts

@@ -1,52 +1,43 @@
-import {
-  badRequest,
-  FlinkContext,
-  Handler,
-  internalServerError,
-  notFound,
-} from "@flink-app/flink";
+import { badRequest, FlinkContext, Handler, internalServerError, notFound } from "@flink-app/flink";
 import { JwtAuthPlugin } from "@flink-app/jwt-auth-plugin";
 import { genericAuthContext } from "../genericAuthContext";
 import { UserPasswordResetCompleteReq } from "../schemas/UserPasswordResetCompleteReq";
 import { UserPasswordResetCompleteRes } from "../schemas/UserPasswordResetCompleteRes";
 
-const postPasswordResetCompleteHandler: Handler<
-  FlinkContext<genericAuthContext>,
-  UserPasswordResetCompleteReq,
-  UserPasswordResetCompleteRes
-> = async ({ ctx, req, origin }) => {
-  let pluginName = origin || "genericAuthPlugin";
-  let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
+const postPasswordResetCompleteHandler: Handler<FlinkContext<genericAuthContext>, UserPasswordResetCompleteReq, UserPasswordResetCompleteRes> = async ({
+    ctx,
+    req,
+    origin,
+}) => {
+    let pluginName = origin || "genericAuthPlugin";
+    let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
 
-  if (ctx.plugins.genericAuthPlugin.passwordResetSettings == null) {
-    return internalServerError(
-      "Password reset settings is needed to use password-reset"
-    );
-  }
+    if (ctx.plugins.genericAuthPlugin.passwordResetSettings == null) {
+        return internalServerError("Password reset settings is needed to use password-reset");
+    }
 
-  const { jwtSecret /*, numberOfDigits, lifeTime*/ } =
-  (<any>ctx.plugins)[pluginName].passwordResetSettings.code;
+    const { jwtSecret /*, numberOfDigits, lifeTime*/ } = (<any>ctx.plugins)[pluginName].passwordResetSettings.code;
 
-  const resp = await ctx.plugins.genericAuthPlugin.passwordResetComplete(
-    repo,
-    <JwtAuthPlugin>ctx.auth,
-    jwtSecret,
-    req.body.passwordResetToken,
-    req.body.code,
-    req.body.password,
-    ctx.plugins.genericAuthPlugin.createPasswordHashAndSaltMethod,
-    ctx.plugins.genericAuthPlugin.passwordResetSettings.passwordResetReusableTokens
-  );
+    const resp = await ctx.plugins.genericAuthPlugin.passwordResetComplete(
+        repo,
+        <JwtAuthPlugin>ctx.auth,
+        jwtSecret,
+        req.body.passwordResetToken,
+        req.body.code,
+        req.body.password,
+        ctx.plugins.genericAuthPlugin.createPasswordHashAndSaltMethod,
+        ctx.plugins.genericAuthPlugin.passwordResetSettings.passwordResetReusableTokens
+    );
 
-  switch (resp.status) {
-    case "invalidCode":
-      return badRequest("Invalid validation code", resp.status);
-    case "passwordError":
-      return badRequest("Invalid password", resp.status);
-    case "userNotFound":
-      return notFound("User not found", resp.status);
-  }
-  return { data: resp, status: 200 };
+    switch (resp.status) {
+        case "invalidCode":
+            return badRequest("Invalid validation code", resp.status);
+        case "passwordError":
+            return badRequest("Invalid password", resp.status);
+        case "userNotFound":
+            return notFound("User not found", resp.status);
+    }
+    return { data: resp, status: 200 };
 };
 
 export default postPasswordResetCompleteHandler;

package/src/handlers/UserPasswordResetForm.ts

@@ -76,7 +76,7 @@ const script = `
     };
 `;
 
-const style =` * {
+const style = ` * {
       box-sizing: border-box;
       font-family: Arial, Helvetica, sans-serif;
     }
@@ -109,50 +109,46 @@ const style =` * {
 `;
 
 export async function handleUserPasswordResetForm(
-  _req: ExpressRequest,
-  res: ExpressResponse,
-  { templateFile, completeUrl }: { templateFile?: string; completeUrl: string }
+    _req: ExpressRequest,
+    res: ExpressResponse,
+    { templateFile, completeUrl }: { templateFile?: string; completeUrl: string }
 ) {
-  const tpl = await readTemplate(templateFile);
+    const tpl = await readTemplate(templateFile);
 
-  const html = Handlebars.compile(tpl)({
-    completeUrl,
-  });
+    const html = Handlebars.compile(tpl)({
+        completeUrl,
+    });
 
-  res.send(html);
+    res.send(html);
 }
 
 export async function resetPasswordFormScript(req: ExpressRequest, res: ExpressResponse, { completeUrl }: { completeUrl: string }) {
     res.header("Content-Type", "application/javascript");
-    const js = Handlebars.compile(script)({completeUrl});
+    const js = Handlebars.compile(script)({ completeUrl });
     res.send(js);
 }
 
 export async function resetPasswordFormCss(res: ExpressResponse) {
-  res.header("Content-Type", "text/css");
-  res.send(style);
+    res.header("Content-Type", "text/css");
+    res.send(style);
 }
 
 let cachedTemplate = "";
 
 async function readTemplate(templateFilename?: string) {
-  if (!cachedTemplate) {
-    if (templateFilename) {
-      try {
-        const buff = await fs.readFile(templateFilename);
-        cachedTemplate = buff.toString();
-      } catch (err) {
-        log.error(
-          "Failed reading template file for password reset",
-          templateFilename,
-          err
-        );
-        throw err;
-      }
-    } else {
-      cachedTemplate = defaultTemplate;
+    if (!cachedTemplate) {
+        if (templateFilename) {
+            try {
+                const buff = await fs.readFile(templateFilename);
+                cachedTemplate = buff.toString();
+            } catch (err) {
+                log.error("Failed reading template file for password reset", templateFilename, err);
+                throw err;
+            }
+        } else {
+            cachedTemplate = defaultTemplate;
+        }
     }
-  }
 
-  return cachedTemplate;
+    return cachedTemplate;
 }

package/src/handlers/UserPasswordResetStart.ts

@@ -1,4 +1,4 @@
-import { emailPluginContext } from "@flink-app/email-plugin";
+import { EmailPluginContext } from "@flink-app/email-plugin";
 import { FlinkContext, Handler, internalServerError } from "@flink-app/flink";
 import { JwtAuthPlugin } from "@flink-app/jwt-auth-plugin";
 import Handlebars from "handlebars";
@@ -7,7 +7,7 @@ import { UserPasswordResetStartReq } from "../schemas/UserPasswordResetStartReq"
 import { UserPasswordResetStartResPublic } from "../schemas/UserPasswordResetStartResPublic";
 
 const postPasswordResetStartHandler: Handler<
-    FlinkContext<genericAuthContext & emailPluginContext>,
+    FlinkContext<genericAuthContext & EmailPluginContext>,
     UserPasswordResetStartReq,
     UserPasswordResetStartResPublic
 > = async ({ ctx, req, origin }) => {
@@ -27,10 +27,18 @@ const postPasswordResetStartHandler: Handler<
 
     const { jwtSecret, numberOfDigits, lifeTime } = genericAuthPlugin.passwordResetSettings.code;
 
-    const resp = await genericAuthPlugin.passwordResetStart(repo, <JwtAuthPlugin>ctx.auth, jwtSecret, req.body.username, numberOfDigits, lifeTime, genericAuthPlugin.passwordResetSettings.passwordResetReusableTokens);
+    const resp = await genericAuthPlugin.passwordResetStart(
+        repo,
+        <JwtAuthPlugin>ctx.auth,
+        jwtSecret,
+        req.body.username,
+        numberOfDigits,
+        lifeTime,
+        genericAuthPlugin.passwordResetSettings.passwordResetReusableTokens
+    );
 
     if (resp.status != "success") {
-      return { data: { status: "success", passwordResetToken: resp.passwordResetToken } };
+        return { data: { status: "success", passwordResetToken: resp.passwordResetToken } };
     }
 
     const emailCtx = {
@@ -40,7 +48,7 @@ const postPasswordResetStartHandler: Handler<
         profile: resp.profile,
         template: req.body.template,
         additionalAuth: req.body.additionalAuth,
-        resetPasswordFormBaseUrl: genericAuthPlugin.passwordResetSettings.resetPasswordFormBaseUrl
+        resetPasswordFormBaseUrl: genericAuthPlugin.passwordResetSettings.resetPasswordFormBaseUrl,
     };
 
     let emailSettings = genericAuthPlugin.passwordResetSettings.email;

package/src/handlers/UserProfileGet.ts

@@ -2,22 +2,19 @@ import { FlinkContext, Handler, notFound } from "@flink-app/flink";
 import { genericAuthContext } from "../genericAuthContext";
 import { UserProfile } from "../schemas/UserProfile";
 
-const getProfileHandler: Handler<
-  FlinkContext<genericAuthContext>,
-  UserProfile
-> = async ({ ctx, req, origin }) => {
-  let pluginName = origin || "genericAuthPlugin";
-  let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
+const getProfileHandler: Handler<FlinkContext<genericAuthContext>, UserProfile> = async ({ ctx, req, origin }) => {
+    let pluginName = origin || "genericAuthPlugin";
+    let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
 
-  let userId = req.user._id;
-  let user = await repo.getById(userId);
-  if (user == null) {
-    return notFound();
-  }
+    let userId = req.user._id;
+    let user = await repo.getById(userId);
+    if (user == null) {
+        return notFound();
+    }
 
-  return {
-    data: user.profile,
-  };
+    return {
+        data: user.profile,
+    };
 };
 
 export default getProfileHandler;

package/src/handlers/UserProfilePut.ts

@@ -17,7 +17,7 @@ const putUserProfileHandler: Handler<FlinkContext<genericAuthContext>, UserProfi
         ...req.body,
     };
 
-    await repo.updateOne(userId, { profile: updatedProfile });
+    await repo.updateById(userId, { profile: updatedProfile });
 
     user = await repo.getById(userId);
 

package/src/handlers/UserPushRegisterToken.ts

@@ -36,7 +36,7 @@ const postUserPushRegisterTokenHandler: Handler<FlinkContext<genericAuthContext>
         user.pushNotificationTokens = user.pushNotificationTokens.filter((t) => t.deviceId === req.body.deviceId);
     }
 
-    await repo.updateOne(user._id, {
+    await repo.updateById(user._id, {
         pushNotificationTokens: user.pushNotificationTokens,
     });
 
@@ -60,7 +60,7 @@ const postUserPushRegisterTokenHandler: Handler<FlinkContext<genericAuthContext>
                     } claimed this device`
                 );
 
-                await repo.updateOne(other._id, {
+                await repo.updateById(other._id, {
                     pushNotificationTokens: other.pushNotificationTokens,
                 });
             } catch (e) {

package/src/handlers/UserPushRemoveToken.ts

@@ -4,29 +4,23 @@ import { PushNotificationToken } from "../schemas/PushNotificationToken";
 import { PushNotificatioNTokenRes } from "../schemas/PushNotificationTokenRes";
 import { User } from "../schemas/User";
 
-const postUserRemoveTokenHandler: Handler<
-  FlinkContext<genericAuthContext>,
-  PushNotificationToken,
-  PushNotificatioNTokenRes
-> = async ({ ctx, req, origin }) => {
-  let pluginName = origin || "genericAuthPlugin";
-  let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
+const postUserRemoveTokenHandler: 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);
+    const user = <User>await repo.getById(req.user._id);
 
-  if (user == null) {
-    return notFound("User not found");
-  }
+    if (user == null) {
+        return notFound("User not found");
+    }
 
-  user.pushNotificationTokens = user.pushNotificationTokens.filter(
-    (t) => t.deviceId != req.body.deviceId
-  );
+    user.pushNotificationTokens = user.pushNotificationTokens.filter((t) => t.deviceId != req.body.deviceId);
 
-  await repo.updateOne(user._id, {
-    pushNotificationTokens: user.pushNotificationTokens,
-  });
+    await repo.updateById(user._id, {
+        pushNotificationTokens: user.pushNotificationTokens,
+    });
 
-  return { data: { status: "success" } };
+    return { data: { status: "success" } };
 };
 
 export default postUserRemoveTokenHandler;

package/src/handlers/UserToken.ts

@@ -1,33 +1,22 @@
-import {
-  FlinkContext,
-  Handler,
-  internalServerError,
-  notFound,
-} from "@flink-app/flink";
+import { FlinkContext, Handler, internalServerError, notFound } from "@flink-app/flink";
 import { genericAuthContext } from "../genericAuthContext";
 import { UserTokenRes } from "../schemas/UserTokenRes";
 
-const getUserTokenHandler: Handler<
-  FlinkContext<genericAuthContext>,
-  UserTokenRes
-> = async ({ ctx, req, origin }) => {
-  let pluginName = origin || "genericAuthPlugin";
-  let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
+const getUserTokenHandler: Handler<FlinkContext<genericAuthContext>, UserTokenRes> = async ({ ctx, req, origin }) => {
+    let pluginName = origin || "genericAuthPlugin";
+    let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
 
-  const user = await repo.getById(req.user._id);
-  if (user == null) {
-    return notFound("User not found");
-  }
-  if (ctx.auth == null) {
-    return internalServerError();
-  }
+    const user = await repo.getById(req.user._id);
+    if (user == null) {
+        return notFound("User not found");
+    }
+    if (ctx.auth == null) {
+        return internalServerError();
+    }
 
-  const token = await ctx.auth.createToken(
-    { username: user.username.toLowerCase(), _id: user._id },
-    user.roles
-  );
+    const token = await ctx.auth.createToken({ username: user.username.toLowerCase(), _id: user._id }, user.roles);
 
-  return { data: { token: token } };
+    return { data: { token: token } };
 };
 
 export default getUserTokenHandler;

package/src/init.ts

@@ -1,4 +1,4 @@
-import { FlinkApp, HttpMethod, ExpressRequest, ExpressResponse } from "@flink-app/flink";
+import { FlinkApp, HttpMethod, ExpressRequest, ExpressResponse, loadPluginSchemas } from "@flink-app/flink";
 import * as userLoginHandler from "./handlers/UserLogin";
 import * as userLoginByTokenHandler from "./handlers/UserLoginByToken";
 import * as userCreateHandler from "./handlers/UserCreate";
@@ -21,6 +21,17 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
 
     if (options.baseUrl == null) options.baseUrl = "/user";
 
+    // Load plugin schemas and register them for $ref resolution
+    const pluginId = options.pluginId || "genericAuth";
+    const pluginSchemas = loadPluginSchemas("@flink-app/generic-auth-plugin");
+    const allSchemas = pluginSchemas.getAllSchemas(pluginId);
+    if (Object.keys(allSchemas).length > 0) {
+        app.registerSchemas(pluginId, allSchemas);
+    }
+
+    /** Helper to get prefixed handler schemas by file path */
+    const schemas = (filePath: string) => pluginSchemas.getHandlerSchemas(pluginId, filePath);
+
     if (options.enableRoutes) {
         if (options.enableUserLogin) {
             app.addHandler(userLoginHandler, {
@@ -28,6 +39,7 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
                 path: options.baseUrl + "/login",
                 docs: "Authenticates a user",
                 origin: options.pluginId,
+                ...schemas("src/handlers/UserLogin.ts"),
             });
         }
         if (options.sms) {
@@ -36,6 +48,7 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
                 path: options.baseUrl + "/login-by-token",
                 docs: "Authenticates a user by token",
                 origin: options.pluginId,
+                ...schemas("src/handlers/UserLoginByToken.ts"),
             });
         }
         if (options.enableUserCreation) {
@@ -44,6 +57,7 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
                 path: options.baseUrl + "/create",
                 docs: "Creates a new user",
                 origin: options.pluginId,
+                ...schemas("src/handlers/UserCreate.ts"),
             });
         }
 
@@ -53,6 +67,7 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
             docs: "Gets the user profile",
             permissions: "authenticated",
             origin: options.pluginId,
+            ...schemas("src/handlers/UserProfileGet.ts"),
         });
 
         app.addHandler(getUserTokenHandler, {
@@ -61,6 +76,7 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
             docs: "Gets a refreshed token for the user",
             permissions: "authenticated",
             origin: options.pluginId,
+            ...schemas("src/handlers/UserToken.ts"),
         });
 
         if (options.enableProfileUpdate) {
@@ -70,6 +86,7 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
                 docs: "Updates the user profile",
                 permissions: "authenticated",
                 origin: options.pluginId,
+                ...schemas("src/handlers/UserProfilePut.ts"),
             });
         }
 
@@ -80,6 +97,7 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
                 docs: "Updates the user password",
                 permissions: "authenticated",
                 origin: options.pluginId,
+                ...schemas("src/handlers/UserPasswordPut.ts"),
             });
         }
 
@@ -89,6 +107,7 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
                 path: options.baseUrl + "/password/reset",
                 docs: "Start the password reset process for a user",
                 origin: options.pluginId,
+                ...schemas("src/handlers/UserPasswordResetStart.ts"),
             });
 
             app.addHandler(postPasswordResetCompleteHandler, {
@@ -96,6 +115,7 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
                 path: options.baseUrl + "/password/reset/complete",
                 docs: "Completes a password reset for a user",
                 origin: options.pluginId,
+                ...schemas("src/handlers/UserPasswordResetComplete.ts"),
             });
 
             if (options.passwordResetSettings?.enablePasswordResetForm) {
@@ -122,6 +142,7 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
                 docs: "Register a push notification on current user",
                 permissions: "authenticated",
                 origin: options.pluginId,
+                ...schemas("src/handlers/UserPushRegisterToken.ts"),
             });
 
             app.addHandler(postUserRemoveTokenHandler, {
@@ -130,6 +151,7 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
                 docs: "Removes a push notification token from current user",
                 permissions: "authenticated",
                 origin: options.pluginId,
+                ...schemas("src/handlers/UserPushRemoveToken.ts"),
             });
         }
     }

package/tsconfig.json

@@ -3,7 +3,7 @@
         "target": "es5",
         "lib": ["esnext", "es2016"],
         "allowJs": true,
-        "skipLibCheck": false,
+        "skipLibCheck": true,
         "esModuleInterop": true,
         "allowSyntheticDefaultImports": true,
         "strict": true,

package/.flink/schemas/schemas.ts

@@ -1 +0,0 @@
-// Generated Sun Feb 01 2026 17:37:47 GMT+0100 (Central European Standard Time)