@flink-app/generic-auth-plugin 0.2.0-beta.8 → 0.3.2

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 };
+}

package/src/schemas/UserPasswordResetCompleteReq.ts

@@ -1,5 +1,5 @@
-export interface UserPasswordResetCompleteReq{
-    passwordResetToken : string;
-    code : string,
-    password : string
-}
+export interface UserPasswordResetCompleteReq {
+  passwordResetToken: string;
+  code: string;
+  password: string;
+}

package/src/schemas/UserPasswordResetSettings.ts

@@ -1,12 +1,14 @@
-export interface UserPasswordResetSettings{
-    email : {
-        from_address : string,
-        subject : string, 
-        html : string,
-    },
-    code : {
-        numberOfDigits : number,
-        lifeTime : string,
-        jwtSecret : string
-    }
-}
+export interface UserPasswordResetSettings {
+  email: {
+    from_address: string;
+    subject: string;
+    html: string;
+  };
+  code: {
+    numberOfDigits: number;
+    lifeTime: string;
+    jwtSecret: string;
+  };
+  enablePasswordResetForm?: boolean;
+  passwordResetForm?: string;
+}

package/src/schemas/UserPasswordResetStartRes.ts

@@ -1,8 +1,8 @@
 import { UserProfile } from "./UserProfile";
 
 export interface UserPasswordResetStartRes {
-    status : "success" | "userNotFound",
-    passwordResetToken? : string,
-    code? : string,
-    profile? : UserProfile
-}
+  status: "success" | "userNotFound";
+  passwordResetToken?: string;
+  code?: string;
+  profile?: UserProfile;
+}