identity-admin 1.26.13 → 1.26.14

package/README.md

@@ -1,35 +1,42 @@
 # Identity Admin Dashboard
+
 [![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/joemccann/dillinger)
 
 ## How to install
+
 ```bash
 npm i identity-admin
 ```
+
 ## Features
+
 - Creating Dashboard with minimal Ui for mongoose models.
 - Provide DashboardController for custom routing and middlewares.
 - Provide multiple dashboard instances with diffrent routes.
 
+## Create new `unAuthenticated` Dashboard:
 
-
-## Create new ```unAuthenticated``` Dashboard:
 - Create new instance from Dashboard.
-- Provide Resources array of 
-resources file.
-- Build the instance after mongoose setup by passing app instance to the build function.  
+- Provide Resources array of
+  resources file.
+- Build the instance after mongoose setup by passing app instance to the build function.
+
 ```Typescript
 const dashboard: Dashboard = new Dashboard({ resources:[ <Resource: IResourceFile> ]);
 ```
+
 ```Typescript
 dashboard.build(app);
 ```
-## To create new ```Authenticated``` Dashboard:
+
+## To create new `Authenticated` Dashboard:
+
 - Create new instance from Dashboard.
-- Provide Resources array of 
-resources file.
+- Provide Resources array of
+  resources file.
 - Provide authenticate function which take AdminCredentials as parameter and return a promise of boolean or user data.
 - Provide cookiesConfiguration (cookie name and cookie secret).
-- Build the instance after mongoose setup by passing app instance to the build function.  
+- Build the instance after mongoose setup by passing app instance to the build function.
 
 ```Typescript
 const dashboard = new Dashboard({
@@ -50,21 +57,25 @@ const dashboard = new Dashboard({
         }
     })
 ```
+
 ```Typescript
 dashboard.build(app);
 ```
-## To create new ```CustomRoutes``` Dashboard:
-``` This method require to implement your own view and new react app ```
+
+## To create new `CustomRoutes` Dashboard:
+
+`This method require to implement your own view and new react app`
+
 - Create new controller class with invirsify-express-utils notaitions and extend ActionController.
 - Create new controller class with invirsify-express-utils notaitions and extend ResourceController.
 - Create new controller class with invirsify-express-utils notaitions and extend DashboardController.
 - Provide resource file and repository in super constructor.
-- ``` Following class will create new route /v1/contries ***Now you can pass any auth middlewares you want```
+- ` Following class will create new route /v1/contries ***Now you can pass any auth middlewares you want`
 
 ```TypeScript
 @controller('/v1/actions', defaultHeaders)
 export default class ActionsController extends ActionController{
-  
+
   constructor(
       @inject(TYPES.IResources) private resources: IResourceFile[]) {
       super(resources);
@@ -75,7 +86,7 @@ export default class ActionsController extends ActionController{
 ```TypeScript
 @controller('/v1/resources', defaultHeaders)
 export default class ResourcesController extends ResourceController{
-  
+
   constructor(
       @inject(TYPES.IResources) private resources: IResourceFile[]) {
       super(resources);
@@ -86,7 +97,7 @@ export default class ResourcesController extends ResourceController{
 ```TypeScript
 @controller('/v1/contries', defaultHeaders)
 export default class CountryController extends DashboardController{
-  
+
   constructor(
       @inject(TYPES.ICountryRepository) private countryRepository: CountryRepository,
       @inject(TYPES.ICountryResource) private countryResource: IResourceFile  ) {
@@ -97,28 +108,34 @@ export default class CountryController extends DashboardController{
 ```
 
 ## Documentaion:
+
 ```Typescript
     Dashboard(dashBoardConfig: DashboardConfig);
     build(app: Application): void;
 ```
 
 #### Dashboard:
+
 Dashboard constructor to create new instance from idntity-admin.
-  - dashBoardConfig:
-  ```js
-  {
-    resources: IResourceFile[]; // Array of resources files.
-    rootPath?: string; // optional root path default to  /dashboard
-    localesOptions?: i18n.ConfigurationOptions; // locales options for custom dashboard
-    cookiesConfiguration: CookieConfiguration; // cookies configuration in case of authenticated dashboard
-    authenticate?: AuthenticateMiddleWare; // authenticate function used to login the admin.
-  }
-  ```
-- IResourceFile 
-``` For resource file example check```
-[IResourceFile](src/types/IResourceFile.ts)
+
+- dashBoardConfig:
+
+```js
+{
+  resources: IResourceFile[]; // Array of resources files.
+  rootPath?: string; // optional root path default to  /dashboard
+  localesOptions?: i18n.ConfigurationOptions; // locales options for custom dashboard
+  cookiesConfiguration: CookieConfiguration; // cookies configuration in case of authenticated dashboard
+  authenticate?: AuthenticateMiddleWare; // authenticate function used to login the admin.
+}
+```
+
+- IResourceFile
+  ` For resource file example check`
+  [IResourceFile](src/types/IResourceFile.ts)
 
 - CookieConfiguration
+
 ```js
 {
   cookiesSecret: string; // cookie secret to handle sessions
@@ -127,9 +144,12 @@ Dashboard constructor to create new instance from idntity-admin.
 ```
 
 ## Admin Notifications:
-``` To add admin notifications in your project you should add the following ```
+
+`To add admin notifications in your project you should add the following`
+
 - Enable the admin notifications in the configuration file of the dashboard.
-> Configuration.ts
+  > Configuration.ts
+
 ```Typescript
 import { IConfiguartionFile } from "identity-admin/lib/types/IConfigurationFile";
 
@@ -139,19 +159,24 @@ export const configuration: IConfiguartionFile = {
     adminNotifications: true // enable admin notifications
 }
 ```
+
 - Add these lines for the admin notification repository in the inversify container.
-> RepositoryTypes.ts
+  > RepositoryTypes.ts
+
 ```Typescript
 IAdminNotificationRepository: Symbol.for('IAdminNotificationRepository')
 
 ```
+
 > RepositoryInversify.ts
+
 ```Typescript
 container.bind<IAdminNotificationRepository>(TYPES.IAdminNotificationRepository).to(AdminNotificationRepository);
 
 ```
-- Create new dashboard controller for the admin notifications.
-> AdminNotificationController.ts
+
+- Create new dashboard controller for the admin notifications CRUD operations and another controller for the notifications services.
+  > AdminNotificationController.ts
 
 ```TypeScript
 import { controller } from "inversify-express-utils";
@@ -180,14 +205,35 @@ export default class DashboardAdminNotificationController extends DashboardContr
 
 ```
 
-- Import this controller in the index file of the controllers folder.
-> index.ts
+> DashboardNotifications.ts
+
+```TypeScript
+import { defaultHeaders, isSessionAuth } from "@pbb/middlewares/isAuth";
+import { controller } from "inversify-express-utils";
+
+import NotificationController from "identity-admin/lib/controllers/AdminNotificationController";
+
+@controller("/v1/admin/notifications", isSessionAuth, defaultHeaders) // You can change the base route as your need.
+export default class DashboardNotificationController extends NotificationController {
+  constructor() {
+    super();
+  }
+}
+
+
+```
+
+- Import these 2 controllers in the index file of the controllers folder.
+  > index.ts
+
 ```Typescript
 import './AdminNotificationController'
+import './DashboardNotifications';
 ```
 
 - Add the resource file of the admin notifications in your index file of the resources folder.
-> index.ts
+  > index.ts
+
 ```Typescript
 // other imports
 import AdminNotificationsResource from 'identity-admin/lib/resources/AdminNotificationsResource'
@@ -203,7 +249,8 @@ const resources: IResourceFile[] = [
 ```
 
 #### Add new notification:
-``` To add a new notification just call the AdminNotificationCreation class as below ```
+
+`To add a new notification just call the AdminNotificationCreation class as below`
 
 ```Typescript
 
@@ -222,4 +269,4 @@ const record = await AdminNotificationCreation.insert({
 
 - In case you choose **NotificationNavigationType.LIST** then you should provide a model name to be navigated to
 - In case you choose **NotificationNavigationType.SHOW** then you should provide a model name to be navigated to and the relatedId of the record to be shown
-- In case you choose **NotificationNavigationType.EXTERNAL_LINK** then you should provide the external link
+- In case you choose **NotificationNavigationType.EXTERNAL_LINK** then you should provide the external link

package/lib/controllers/AdminNotificationController.d.ts

@@ -1,7 +1,8 @@
 import { Response } from 'express';
 import { IRequest } from '../middlewares/isAuth';
-export default class AdminNotificationController {
+export default class DashboardNotificationController {
     constructor();
     index(req: IRequest, res: Response): Promise<Response<any, Record<string, any>>>;
-    update(req: IRequest, res: Response): Promise<void>;
+    markOneRead(req: IRequest, res: Response): Promise<void>;
+    markAllRead(req: IRequest, res: Response): Promise<void>;
 }

package/lib/controllers/AdminNotificationController.js

@@ -24,18 +24,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const inversify_express_utils_1 = require("inversify-express-utils");
 const ResponseUtils_1 = __importDefault(require("../utils/ResponseUtils"));
 const inversify_1 = require("inversify");
-let AdminNotificationController = class AdminNotificationController {
+const AdminNotificationFetcher_1 = require("../helpers/AdminNotifications/AdminNotificationFetcher");
+const AdminNotification_1 = __importDefault(require("../models/adminNotification/AdminNotification"));
+let DashboardNotificationController = class DashboardNotificationController {
     constructor() { }
     index(req, res) {
         return __awaiter(this, void 0, void 0, function* () {
-            // var notifications: IDashboardNotifications[] = await this.dashboardNotificationsService.getNotifications();
-            // notifications.sort(compare);
-            return ResponseUtils_1.default.send(res, 200, 'OK', []);
+            const notifications = yield AdminNotificationFetcher_1.AdminNotificationFetcher.fetchNotifications();
+            return ResponseUtils_1.default.send(res, 200, 'OK', notifications);
         });
     }
-    update(req, res) {
+    markOneRead(req, res) {
         return __awaiter(this, void 0, void 0, function* () {
-            //const adminNotifications = await AdminNotification.updateMany({ isRead: false }, { $set: { isRead: true } });
+            const { id } = req.params;
+            yield AdminNotification_1.default.updateOne({ _id: id }, { isRead: true });
+            return ResponseUtils_1.default.ok(res, {});
+        });
+    }
+    markAllRead(req, res) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield AdminNotification_1.default.updateMany({ isRead: false }, { $set: { isRead: true } });
             return ResponseUtils_1.default.ok(res, {});
         });
     }
@@ -44,13 +52,18 @@ __decorate([
     (0, inversify_express_utils_1.httpGet)('/'),
     __param(0, (0, inversify_express_utils_1.request)()),
     __param(1, (0, inversify_express_utils_1.response)())
-], AdminNotificationController.prototype, "index", null);
+], DashboardNotificationController.prototype, "index", null);
+__decorate([
+    (0, inversify_express_utils_1.httpPost)('/markAsRead/:id'),
+    __param(0, (0, inversify_express_utils_1.request)()),
+    __param(1, (0, inversify_express_utils_1.response)())
+], DashboardNotificationController.prototype, "markOneRead", null);
 __decorate([
     (0, inversify_express_utils_1.httpPost)('/markAllAsRead'),
     __param(0, (0, inversify_express_utils_1.request)()),
     __param(1, (0, inversify_express_utils_1.response)())
-], AdminNotificationController.prototype, "update", null);
-AdminNotificationController = __decorate([
+], DashboardNotificationController.prototype, "markAllRead", null);
+DashboardNotificationController = __decorate([
     (0, inversify_1.injectable)()
-], AdminNotificationController);
-exports.default = AdminNotificationController;
+], DashboardNotificationController);
+exports.default = DashboardNotificationController;

package/lib/helpers/AdminNotifications/AdminNotificationFetcher.d.ts

@@ -0,0 +1,51 @@
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose" />
+/// <reference types="passport-local-mongoose" />
+/// <reference types="mongoose" />
+import { AdminNotificationNavigationType, AdminNotificationTypePriority } from '../../models/adminNotification/IAdminNotification';
+export interface IMappedAdminNotification {
+    id: string;
+    text: string;
+    createdAt: Date;
+    clickable: boolean;
+    redirectUrl?: string;
+    redirectUrlType: AdminNotificationNavigationType;
+    isRead: boolean;
+    priority: AdminNotificationTypePriority;
+    type?: string;
+}
+export declare class AdminNotificationFetcher {
+    static fetchNotifications(): Promise<{
+        id: import("mongoose").Types.ObjectId;
+        text: string;
+        createdAt: Date;
+        clickable: boolean;
+        redirectUrl: String | undefined;
+        redirectUrlType: AdminNotificationNavigationType | undefined;
+        isRead: boolean | undefined;
+        priority: AdminNotificationTypePriority | undefined;
+        type: string | undefined;
+    }[]>;
+}

package/lib/helpers/AdminNotifications/AdminNotificationFetcher.js

@@ -0,0 +1,39 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminNotificationFetcher = void 0;
+const AdminNotification_1 = __importDefault(require("../../models/adminNotification/AdminNotification"));
+const IAdminNotification_1 = require("../../models/adminNotification/IAdminNotification");
+class AdminNotificationFetcher {
+    static fetchNotifications() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const notifications = yield AdminNotification_1.default.find({ isRead: false }).sort({ createdAt: -1 });
+            const mappedNotifications = notifications.map((notification) => {
+                return {
+                    id: notification._id,
+                    text: notification.title,
+                    createdAt: notification.createdAt,
+                    clickable: notification.redirectUrlType === IAdminNotification_1.AdminNotificationNavigationType.NONE ? false : true,
+                    redirectUrl: notification.redirectUrl,
+                    redirectUrlType: notification.redirectUrlType,
+                    isRead: notification.isRead,
+                    priority: notification.priority,
+                    type: notification.type,
+                };
+            });
+            return mappedNotifications;
+        });
+    }
+}
+exports.AdminNotificationFetcher = AdminNotificationFetcher;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "identity-admin",
-  "version": "1.26.13",
+  "version": "1.26.14",
   "description": "",
   "main": "lib/Dashboard.js",
   "types": "lib/Dashbord.d.ts",