@flink-app/generic-auth-plugin 0.3.0 → 0.3.3

package/src/handlers/UserCreate.ts

@@ -1,68 +1,56 @@
-import {
-  badRequest,
-  conflict,
-  FlinkContext,
-  Handler,
-  internalServerError,
-} from "@flink-app/flink";
+import { badRequest, conflict, FlinkContext, Handler, internalServerError } from "@flink-app/flink";
 import { JwtAuthPlugin } from "@flink-app/jwt-auth-plugin";
 import { genericAuthContext } from "../genericAuthContext";
 import { UserCreateReq } from "../schemas/UserCreateReq";
 import { UserCreateRes } from "../schemas/UserCreateRes";
 
-const userCreateHandler: Handler<
-  FlinkContext<genericAuthContext>,
-  UserCreateReq,
-  UserCreateRes
-> = async ({ ctx, req, origin }) => {
-  let { password, username, authentificationMethod, profile } = req.body;
-  if (authentificationMethod == null) {
-    authentificationMethod = "password";
-  }
-  if (authentificationMethod == "password" && password == null) {
-    return internalServerError(
-      "When using password as authentification method password must be supplied"
-    );
-  }
-  if (password == null) {
-    password = "";
-  }
-  let roles: string[] = [];
-  if (profile == null) profile = {};
+const userCreateHandler: Handler<FlinkContext<genericAuthContext>, UserCreateReq, UserCreateRes> = async ({ ctx, req, origin }) => {
+    let { password, username, authentificationMethod, profile } = req.body;
+    if (authentificationMethod == null) {
+        authentificationMethod = "password";
+    }
+    if (authentificationMethod == "password" && password == null) {
+        return internalServerError("When using password as authentification method password must be supplied");
+    }
+    if (password == null) {
+        password = "";
+    }
+    let roles: string[] = [];
+    if (profile == null) profile = {};
 
-  let pluginName = origin || "genericAuthPlugin";
-  let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
+    let pluginName = origin || "genericAuthPlugin";
+    let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
 
-  var re = <RegExp>(<any>ctx.plugins)[pluginName].usernameFormat;
+    var re = <RegExp>(<any>ctx.plugins)[pluginName].usernameFormat;
 
-  if (!re.test(username)) {
-    return badRequest("Username does not meet requirements", "usernameError");
-  }
+    if (!re.test(username)) {
+        return badRequest("Username does not meet requirements", "usernameError");
+    }
 
-  const createUserResponse = await ctx.plugins.genericAuthPlugin.createUser(
-    repo,
-    <JwtAuthPlugin>ctx.auth,
-    username,
-    password,
-    authentificationMethod,
-    roles,
-    profile,
-    ctx.plugins.genericAuthPlugin.createPasswordHashAndSaltMethod
-  );
-  if (createUserResponse.status != "success") {
-    switch (createUserResponse.status) {
-      case "error":
-        return internalServerError("Unknown error", createUserResponse.status);
-      case "passwordError":
-        return badRequest("Invalid password", createUserResponse.status);
-      case "userExists":
-        return conflict("User already exists", createUserResponse.status);
+    const createUserResponse = await ctx.plugins.genericAuthPlugin.createUser(
+        repo,
+        <JwtAuthPlugin>ctx.auth,
+        username,
+        password,
+        authentificationMethod,
+        roles,
+        profile,
+        ctx.plugins.genericAuthPlugin.createPasswordHashAndSaltMethod
+    );
+    if (createUserResponse.status != "success") {
+        switch (createUserResponse.status) {
+            case "error":
+                return internalServerError("Unknown error", createUserResponse.status);
+            case "passwordError":
+                return badRequest("Invalid password", createUserResponse.status);
+            case "userExists":
+                return conflict("User already exists", createUserResponse.status);
+        }
     }
-  }
-  return {
-    data: createUserResponse,
-    status: 200,
-  };
+    return {
+        data: createUserResponse,
+        status: 200,
+    };
 };
 
 export default userCreateHandler;

package/src/handlers/UserProfilePut.ts

@@ -16,8 +16,14 @@ const putUserProfileHandler: Handler<
     return notFound();
   }
 
-  user.profile = req.body;
-  await repo.updateOne(userId, { profile: req.body });
+
+  const updatedProfile = {
+    ...user.profile,
+    ...req.body,
+}
+
+
+  await repo.updateOne(userId, { profile: updatedProfile });
 
   user = await repo.getById(userId);
 

package/src/management.ts

@@ -1,7 +1,4 @@
-import {
-  ManagementApiModule,
-  ManagementApiType,
-} from "@flink-app/management-api-plugin";
+import { ManagementApiModule, ManagementApiType } from "@flink-app/management-api-plugin";
 import { HttpMethod } from "@flink-app/flink";
 import * as userCreateHandler from "./handlers/UserCreate";
 import * as GetManagementUser from "./handlers/Management/GetUser";
@@ -11,145 +8,164 @@ import * as PutManagementUserProfileByUserid from "./handlers/Management/PutUser
 import * as PutManagementUserUsernameByUserid from "./handlers/Management/PutUserUsernameByUserid";
 import * as PutManagementUserRolesByUserid from "./handlers/Management/PutUserRolesByUserid";
 import * as DeleteManagementUserByUserid from "./handlers/Management/DeleteUserByUserid";
+import * as GetUserViewByUserid from "./handlers/Management/GetUserViewByUserid";
 
 import * as PutUserProfileByUseridAppend from "./handlers/Management/PutUserProfileByUseridAppend";
 import * as GetSchema from "./handlers/Management/GetSchema";
+import { User } from ".";
+import { GetManagementUserViewByUseridRes } from "./schemas/Management/GetUserViewByUseridRes";
 
 export interface GetManagementModuleConfig {
-  pluginId?: string;
-  profileSchema?: any;
-  ui: boolean;
-  uiSettings?: {
-    title: string;
-    enableUserDelete?: boolean;
-    enableUserCreate?: boolean;
-    enableUserEdit?: boolean;
-  };
+    pluginId?: string;
+    profileSchema?: any;
+    ui: boolean;
+    userView?: {
+        getData(user: User): GetManagementUserViewByUseridRes;
+    };
+    uiSettings?: {
+        title: string;
+        enableUserDelete?: boolean;
+        enableUserCreate?: boolean;
+        enableUserEdit?: boolean;
+        enableUserView?: boolean;
+    };
 }
 
-export const GetManagementModule = (
-  config: GetManagementModuleConfig
-): ManagementApiModule => {
-  if (config.pluginId == null) config.pluginId = "genericAuthPlugin";
-
-  let endpoints: ManagementApiModule["endpoints"] = [];
-  endpoints.push({
-    routeProps: {
-      path: "",
-      method: HttpMethod.post,
-      origin: config.pluginId,
-    },
-    handler: userCreateHandler,
-  });
-
-  endpoints.push({
-    routeProps: {
-      path: "",
-      method: HttpMethod.get,
-      origin: config.pluginId,
-    },
-    handler: GetManagementUser,
-  });
-
-  endpoints.push({
-    routeProps: {
-      path: "/profile/schema",
-      method: HttpMethod.get,
-      origin: config.pluginId || "genericAuthPlugin",
-    },
-    handler: GetSchema,
-  });
-
-  endpoints.push({
-    routeProps: {
-      path: "/:userid",
-      method: HttpMethod.get,
-      origin: config.pluginId,
-    },
-
-    handler: GetManagementUserByUserid,
-  });
-
-  endpoints.push({
-    routeProps: {
-      path: "/:userid",
-      method: HttpMethod.delete,
-      origin: config.pluginId,
-    },
-    handler: DeleteManagementUserByUserid,
-  });
-
-  endpoints.push({
-    routeProps: {
-      path: "/password/:userid",
-      method: HttpMethod.put,
-      origin: config.pluginId,
-    },
-    handler: PutManagementUserPasswordByUserid,
-  });
-
-  endpoints.push({
-    routeProps: {
-      path: "/username/:userid",
-      method: HttpMethod.put,
-      origin: config.pluginId,
-    },
-    handler: PutManagementUserUsernameByUserid,
-  });
-
-  endpoints.push({
-    routeProps: {
-      path: "/profile/:userid",
-      method: HttpMethod.put,
-      origin: config.pluginId,
-    },
-    handler: PutManagementUserProfileByUserid,
-  });
-
-  endpoints.push({
-    routeProps: {
-      path: "/profile/:userid/append",
-      method: HttpMethod.put,
-      origin: config.pluginId,
-    },
-    handler: PutUserProfileByUseridAppend,
-  });
-
-  endpoints.push({
-    routeProps: {
-      path: "/roles/:userid",
-      method: HttpMethod.put,
-      origin: config.pluginId,
-    },
-    handler: PutManagementUserRolesByUserid,
-  });
-
-  let features: string[] = [];
-
-  if (config.uiSettings?.enableUserDelete == true) {
-    features.push("delete");
-  }
-  if (config.uiSettings?.enableUserCreate == true) {
-    features.push("create");
-  }
-  if (config.uiSettings?.enableUserEdit == true) {
-    features.push("edit");
-  }
-
-  let module: ManagementApiModule = {
-    id: config.pluginId || "user",
-    uiSettings: {
-      title: config.uiSettings?.title || "Users",
-      icon: "",
-      features,
-    },
-    ui: config.ui,
-    type: ManagementApiType.user,
-    endpoints: endpoints,
-    data : {
-      profileSchema : config.profileSchema
+export const GetManagementModule = (config: GetManagementModuleConfig): ManagementApiModule => {
+    if (config.pluginId == null) config.pluginId = "genericAuthPlugin";
+
+    let endpoints: ManagementApiModule["endpoints"] = [];
+    endpoints.push({
+        routeProps: {
+            path: "",
+            method: HttpMethod.post,
+            origin: config.pluginId,
+        },
+        handler: userCreateHandler,
+    });
+
+    endpoints.push({
+        routeProps: {
+            path: "",
+            method: HttpMethod.get,
+            origin: config.pluginId,
+        },
+        handler: GetManagementUser,
+    });
+
+    endpoints.push({
+        routeProps: {
+            path: "/profile/schema",
+            method: HttpMethod.get,
+            origin: config.pluginId || "genericAuthPlugin",
+        },
+        handler: GetSchema,
+    });
+
+    endpoints.push({
+        routeProps: {
+            path: "/:userid",
+            method: HttpMethod.get,
+            origin: config.pluginId,
+        },
+
+        handler: GetManagementUserByUserid,
+    });
+
+    endpoints.push({
+        routeProps: {
+            path: "/:userid/view",
+            method: HttpMethod.get,
+            origin: config.pluginId,
+        },
+
+        handler: GetUserViewByUserid,
+    });
+
+    endpoints.push({
+        routeProps: {
+            path: "/:userid",
+            method: HttpMethod.delete,
+            origin: config.pluginId,
+        },
+        handler: DeleteManagementUserByUserid,
+    });
+
+    endpoints.push({
+        routeProps: {
+            path: "/password/:userid",
+            method: HttpMethod.put,
+            origin: config.pluginId,
+        },
+        handler: PutManagementUserPasswordByUserid,
+    });
+
+    endpoints.push({
+        routeProps: {
+            path: "/username/:userid",
+            method: HttpMethod.put,
+            origin: config.pluginId,
+        },
+        handler: PutManagementUserUsernameByUserid,
+    });
+
+    endpoints.push({
+        routeProps: {
+            path: "/profile/:userid",
+            method: HttpMethod.put,
+            origin: config.pluginId,
+        },
+        handler: PutManagementUserProfileByUserid,
+    });
+
+    endpoints.push({
+        routeProps: {
+            path: "/profile/:userid/append",
+            method: HttpMethod.put,
+            origin: config.pluginId,
+        },
+        handler: PutUserProfileByUseridAppend,
+    });
+
+    endpoints.push({
+        routeProps: {
+            path: "/roles/:userid",
+            method: HttpMethod.put,
+            origin: config.pluginId,
+        },
+        handler: PutManagementUserRolesByUserid,
+    });
+
+    let features: string[] = [];
+
+    if (config.uiSettings?.enableUserDelete == true) {
+        features.push("delete");
+    }
+    if (config.uiSettings?.enableUserCreate == true) {
+        features.push("create");
+    }
+    if (config.uiSettings?.enableUserEdit == true) {
+        features.push("edit");
+    }
+    if (config.uiSettings?.enableUserView == true) {
+        features.push("view");
     }
-  };
 
-  return module;
+    let module: ManagementApiModule = {
+        id: config.pluginId || "user",
+        uiSettings: {
+            title: config.uiSettings?.title || "Users",
+            icon: "",
+            features,
+        },
+        ui: config.ui,
+        type: ManagementApiType.user,
+        endpoints: endpoints,
+        data: {
+            profileSchema: config.profileSchema,
+            userViewGetData: config.userView?.getData,
+        },
+    };
+
+    return module;
 };

package/src/schemas/Management/GetUserViewByUseridReq.ts

@@ -0,0 +1,3 @@
+export interface GetManagementUserViewByUseridReq{
+
+}

package/src/schemas/Management/GetUserViewByUseridRes.ts

@@ -0,0 +1,4 @@
+export interface GetManagementUserViewByUseridRes {
+    buttons: { text: string; url: string }[];
+    data: { [key: string]: string };
+}