@fraym/auth 0.1.0 → 0.2.0

package/README.md

@@ -95,6 +95,68 @@ await managementClient.upsertRole("TENANT_ID", "ROLE_ID", [
 await managementClient.deleteRole("TENANT_ID", "ROLE_ID");
 ```
 
+## Create a user
+
+When creating a user and not providing a `password`, the create function will return a `setInitialPasswordToken`. This string can be used to authorize the initial password change of a user. Use it within the graphql api to change the passwort of a user.
+
+Required parameters:
+
+```typescript
+const { id, setInitialPasswordToken } = await managementClient.createUser("TENANT_ID", "E-MAIL", [
+    "ROLE_ID",
+]);
+```
+
+With all optional parameters:
+
+```typescript
+const isActive = true;
+const blockedUntil = new Date();
+const {id, setInitialPasswordToken} = await managementClient.createUser("TENANT_ID", "E-MAIL", ["ROLE_ID"]. "LOGIN_NAME", "DISPLAY_NAME", "PASSWORD", isActive, blockedUntil);
+```
+
+`LOGIN_NAME`: A name used for login instead of the email address.
+`DISPLAY_NAME`: A name to display in the applications.
+`PASSWORD`: Set the initial password of the user or leave empty if you want the user to set it.
+`isActive`: Activate or deactivate a user.
+`blockedUntil`: Block a user until a specific date.
+
+## Update a user
+
+When updating a user and not providing a `password`, the password will stay the same. Otherwise it will be changed to the given password.
+
+Required parameters:
+
+```typescript
+await managementClient.updateUser("TENANT_ID", "USER_ID", "E-MAIL", ["ROLE_ID"]);
+```
+
+With all optional parameters:
+
+```typescript
+const isActive = true;
+const blockedUntil = new Date();
+await managementClient.createUser("TENANT_ID", "USER_ID", "E-MAIL", ["ROLE_ID"]. "LOGIN_NAME", "DISPLAY_NAME", "PASSWORD", isActive, blockedUntil);
+```
+
+`LOGIN_NAME`: A name used for login instead of the email address.
+`DISPLAY_NAME`: A name to display in the applications.
+`PASSWORD`: Use this to reset the password of a user.
+`isActive`: Activate or deactivate a user.
+`blockedUntil`: Block a user until a specific date.
+
+## Delete a user
+
+```typescript
+await managementClient.deleteUser("TENANT_ID", "USER_ID");
+```
+
+## Get all users
+
+```typescript
+const users = await managementClient.getUsers("TENANT_ID");
+```
+
 ### Gracefully close the clients
 
 You won't lose any data if you don't. Use it for your peace of mind.

package/dist/management/client.d.ts

@@ -1,5 +1,7 @@
 import { ClientConfig } from "../config/config";
+import { CreateUserResponse } from "./createUser";
 import { Role } from "./getRoles";
+import { User } from "./getUsers";
 import { UpsertRoleScope } from "./upsertRole";
 export interface ManagementClient {
     createScope: (name: string, clientId?: string) => Promise<void>;
@@ -8,6 +10,10 @@ export interface ManagementClient {
     upsertRole: (tenantId: string, id: string, allowedScopes: UpsertRoleScope[]) => Promise<void>;
     deleteRole: (tenantId: string, id: string) => Promise<void>;
     getRoles: (tenantId: string) => Promise<Role[]>;
+    createUser: (tenantId: string, email: string, assignedRoleIds: string[], login?: string, displayName?: string, password?: string, active?: boolean, blockedUntil?: Date) => Promise<CreateUserResponse>;
+    updateUser: (tenantId: string, id: string, email: string, assignedRoleIds: string[], login?: string, displayName?: string, password?: string, active?: boolean, blockedUntil?: Date) => Promise<void>;
+    deleteUser: (tenantId: string, id: string) => Promise<void>;
+    getUsers: (tenantId: string) => Promise<User[]>;
     close: () => Promise<void>;
 }
 export declare const newManagementClient: (config?: ClientConfig) => Promise<ManagementClient>;

package/dist/management/client.js

@@ -5,10 +5,14 @@ const auth_proto_1 = require("@fraym/auth-proto");
 const grpc_js_1 = require("@grpc/grpc-js");
 const config_1 = require("../config/config");
 const createScope_1 = require("./createScope");
+const createUser_1 = require("./createUser");
 const deleteRole_1 = require("./deleteRole");
 const deleteScope_1 = require("./deleteScope");
+const deleteUser_1 = require("./deleteUser");
 const getRoles_1 = require("./getRoles");
 const getScopes_1 = require("./getScopes");
+const getUsers_1 = require("./getUsers");
+const updateUser_1 = require("./updateUser");
 const upsertRole_1 = require("./upsertRole");
 const newManagementClient = async (config) => {
     config = (0, config_1.useConfigDefaults)(config);
@@ -35,6 +39,18 @@ const newManagementClient = async (config) => {
     const getRoles = async (tenantId) => {
         return await (0, getRoles_1.getAllRoles)(tenantId, serviceClient);
     };
+    const createUser = async (tenantId, email, assignedRoleIds, login = "", displayName = "", password = "", active = false, blockedUntil = new Date(0)) => {
+        return await (0, createUser_1.createNewUser)(tenantId, login, email, displayName, password, assignedRoleIds, active, blockedUntil, serviceClient);
+    };
+    const updateUser = async (tenantId, id, email, assignedRoleIds, login = "", displayName = "", password = "", active = false, blockedUntil = new Date(0)) => {
+        return await (0, updateUser_1.updateExistingUser)(tenantId, id, login, email, displayName, password, assignedRoleIds, active, blockedUntil, serviceClient);
+    };
+    const deleteUser = async (tenantId, id) => {
+        return await (0, deleteUser_1.deleteExistingUser)(tenantId, id, serviceClient);
+    };
+    const getUsers = async (tenantId) => {
+        return await (0, getUsers_1.getAllUsers)(tenantId, serviceClient);
+    };
     const close = async () => {
         serviceClient.close();
     };
@@ -45,6 +61,10 @@ const newManagementClient = async (config) => {
         upsertRole,
         deleteRole,
         getRoles,
+        createUser,
+        updateUser,
+        deleteUser,
+        getUsers,
         close,
     };
 };

package/dist/management/createUser.d.ts

@@ -0,0 +1,6 @@
+import { ManagementServiceClient } from "@fraym/auth-proto";
+export interface CreateUserResponse {
+    id: string;
+    setInitialPasswordToken: string;
+}
+export declare const createNewUser: (tenantId: string, login: string, email: string, displayName: string, password: string, assignedRoleIds: string[], active: boolean, blockedUntil: Date, serviceClient: ManagementServiceClient) => Promise<CreateUserResponse>;

package/dist/management/createUser.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNewUser = void 0;
+const createNewUser = async (tenantId, login, email, displayName, password, assignedRoleIds, active, blockedUntil, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.createUser({
+            tenantId,
+            login,
+            email,
+            displayName,
+            password,
+            active,
+            assignedRoleIds,
+            blockedUntil: blockedUntil.getTime(),
+        }, (error, response) => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve({
+                id: response.id,
+                setInitialPasswordToken: response.setInitialPasswordToken,
+            });
+        });
+    });
+};
+exports.createNewUser = createNewUser;

package/dist/management/deleteUser.d.ts

@@ -0,0 +1,2 @@
+import { ManagementServiceClient } from "@fraym/auth-proto";
+export declare const deleteExistingUser: (tenantId: string, id: string, serviceClient: ManagementServiceClient) => Promise<void>;

package/dist/management/deleteUser.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteExistingUser = void 0;
+const deleteExistingUser = async (tenantId, id, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.deleteUser({
+            tenantId,
+            id,
+        }, error => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve();
+        });
+    });
+};
+exports.deleteExistingUser = deleteExistingUser;

package/dist/management/getUsers.d.ts

@@ -0,0 +1,13 @@
+import { ManagementServiceClient } from "@fraym/auth-proto";
+export interface User {
+    id: string;
+    login: string;
+    email: string;
+    displayName: string;
+    assignedRoleIds: string[];
+    active: boolean;
+    failedAttempts: number;
+    lastAttempt: number;
+    blockedUntil: number;
+}
+export declare const getAllUsers: (tenantId: string, serviceClient: ManagementServiceClient) => Promise<User[]>;

package/dist/management/getUsers.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllUsers = void 0;
+const getAllUsers = async (tenantId, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.getUsers({
+            tenantId,
+        }, (error, response) => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve(response.users);
+        });
+    });
+};
+exports.getAllUsers = getAllUsers;

package/dist/management/updateUser.d.ts

@@ -0,0 +1,2 @@
+import { ManagementServiceClient } from "@fraym/auth-proto";
+export declare const updateExistingUser: (tenantId: string, id: string, login: string, email: string, displayName: string, password: string, assignedRoleIds: string[], active: boolean, blockedUntil: Date, serviceClient: ManagementServiceClient) => Promise<void>;

package/dist/management/updateUser.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateExistingUser = void 0;
+const updateExistingUser = async (tenantId, id, login, email, displayName, password, assignedRoleIds, active, blockedUntil, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.updateUser({
+            tenantId,
+            id,
+            login,
+            email,
+            displayName,
+            password,
+            active,
+            assignedRoleIds,
+            blockedUntil: blockedUntil.getTime(),
+        }, error => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve();
+        });
+    });
+};
+exports.updateExistingUser = updateExistingUser;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fraym/auth",
-    "version": "0.1.0",
+    "version": "0.2.0",
     "license": "UNLICENSED",
     "homepage": "https://github.com/fraym/auth-nodejs",
     "repository": {
@@ -27,7 +27,7 @@
         "auth": "dist/cmd/auth.js"
     },
     "dependencies": {
-        "@fraym/auth-proto": "^0.4.0",
+        "@fraym/auth-proto": "^0.5.1",
         "@graphql-tools/graphql-file-loader": "^7.5.11",
         "@graphql-tools/load": "^7.8.6",
         "@grpc/grpc-js": "1.7.2",