identity-admin 1.28.26 → 1.28.27

package/README.md

@@ -1,148 +1,148 @@
-# 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 instance from Dashboard.
-- 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:
-
-- Create new instance from Dashboard.
-- 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.
-
-```Typescript
-const dashboard = new Dashboard({
-        resources: [ UserResource ],
-        cookiesConfiguration: {
-            cookiesSecret: "cokieieSecret",
-            cookieName: "connect.sid"
-        },
-        authenticate: async (credentials: AdminCredentials) => {
-            const user = await Admin.findOne({ email: credentials.email });
-            if (user) {
-                const matched = await bcrypt.compare(credentials.password, user.encryptedPassword);
-                if (matched) {
-                    return user;
-                }
-            }
-            return false;
-        }
-    })
-```
-
-```Typescript
-dashboard.build(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`
-
-```TypeScript
-@controller('/v1/actions', defaultHeaders)
-export default class ActionsController extends ActionController{
-
-  constructor(
-      @inject(TYPES.IResources) private resources: IResourceFile[]) {
-      super(resources);
-  }
-}
-```
-
-```TypeScript
-@controller('/v1/resources', defaultHeaders)
-export default class ResourcesController extends ResourceController{
-
-  constructor(
-      @inject(TYPES.IResources) private resources: IResourceFile[]) {
-      super(resources);
-  }
-}
-```
-
-```TypeScript
-@controller('/v1/contries', defaultHeaders)
-export default class CountryController extends DashboardController{
-
-  constructor(
-      @inject(TYPES.ICountryRepository) private countryRepository: CountryRepository,
-      @inject(TYPES.ICountryResource) private countryResource: IResourceFile  ) {
-
-      super(CountryResource, countryRepository);
-  }
-}
-```
-
-## 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)
-
-- CookieConfiguration
-
-```js
-{
-  cookiesSecret: string; // cookie secret to handle sessions
-  cookieName: string; // cookie name as appeared in browser
-}
-```
-
-## Plugins:
-- [Permissions](./docs/permissions.md)
-- [Admin Notification](./docs/adminNotifications.md)
+# 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 instance from Dashboard.
+- 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:
+
+- Create new instance from Dashboard.
+- 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.
+
+```Typescript
+const dashboard = new Dashboard({
+        resources: [ UserResource ],
+        cookiesConfiguration: {
+            cookiesSecret: "cokieieSecret",
+            cookieName: "connect.sid"
+        },
+        authenticate: async (credentials: AdminCredentials) => {
+            const user = await Admin.findOne({ email: credentials.email });
+            if (user) {
+                const matched = await bcrypt.compare(credentials.password, user.encryptedPassword);
+                if (matched) {
+                    return user;
+                }
+            }
+            return false;
+        }
+    })
+```
+
+```Typescript
+dashboard.build(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`
+
+```TypeScript
+@controller('/v1/actions', defaultHeaders)
+export default class ActionsController extends ActionController{
+
+  constructor(
+      @inject(TYPES.IResources) private resources: IResourceFile[]) {
+      super(resources);
+  }
+}
+```
+
+```TypeScript
+@controller('/v1/resources', defaultHeaders)
+export default class ResourcesController extends ResourceController{
+
+  constructor(
+      @inject(TYPES.IResources) private resources: IResourceFile[]) {
+      super(resources);
+  }
+}
+```
+
+```TypeScript
+@controller('/v1/contries', defaultHeaders)
+export default class CountryController extends DashboardController{
+
+  constructor(
+      @inject(TYPES.ICountryRepository) private countryRepository: CountryRepository,
+      @inject(TYPES.ICountryResource) private countryResource: IResourceFile  ) {
+
+      super(CountryResource, countryRepository);
+  }
+}
+```
+
+## 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)
+
+- CookieConfiguration
+
+```js
+{
+  cookiesSecret: string; // cookie secret to handle sessions
+  cookieName: string; // cookie name as appeared in browser
+}
+```
+
+## Plugins:
+- [Permissions](./docs/permissions.md)
+- [Admin Notification](./docs/adminNotifications.md)

package/lib/Dashboard.d.ts

@@ -1,14 +1,14 @@
-import { Application } from "express";
-import i18n from "i18n";
-import DashboardConfig from "./types/DashbordConfig";
-export default class Dashboard {
-    private dashBoardConfig;
-    private DEFAULT_ROOT_PATH;
-    constructor(dashBoardConfig: DashboardConfig);
-    build(app: Application): void;
-    private configureLocalization;
-    private buildRouter;
-    private configureAuthentication;
-    private configureSession;
-    static configurBaseLocalization(options: i18n.ConfigurationOptions, locale: string): void;
-}
+import { Application } from "express";
+import i18n from "i18n";
+import DashboardConfig from "./types/DashbordConfig";
+export default class Dashboard {
+    private dashBoardConfig;
+    private DEFAULT_ROOT_PATH;
+    constructor(dashBoardConfig: DashboardConfig);
+    build(app: Application): void;
+    private configureLocalization;
+    private buildRouter;
+    private configureAuthentication;
+    private configureSession;
+    static configurBaseLocalization(options: i18n.ConfigurationOptions, locale: string): void;
+}

package/lib/Dashboard.js

@@ -1,95 +1,95 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const express_1 = __importDefault(require("express"));
-const DashboardController_1 = __importDefault(require("./controllers/DashboardController"));
-const router_1 = __importStar(require("./router"));
-const i18n_1 = __importDefault(require("i18n"));
-const ResourceController_1 = __importDefault(require("./controllers/ResourceController"));
-const path_1 = __importDefault(require("path"));
-const ActionController_1 = __importDefault(require("./controllers/ActionController"));
-var session = require('express-session');
-var cookieParser = require('cookie-parser');
-class Dashboard {
-    constructor(dashBoardConfig) {
-        this.dashBoardConfig = dashBoardConfig;
-        this.DEFAULT_ROOT_PATH = "/dashboard";
-    }
-    build(app) {
-        this.configureLocalization();
-        app.use(i18n_1.default.init);
-        app.use((req, res, next) => {
-            req.setLocale(req.headers['accept-language'] ? req.headers['accept-language'] : 'en');
-            i18n_1.default.setLocale(req.headers['accept-language'] ? req.headers['accept-language'] : 'en');
-            next();
-        });
-        this.configureAuthentication(app);
-        this.buildRouter(app);
-    }
-    configureLocalization() {
-        var _a;
-        i18n_1.default.configure((_a = this.dashBoardConfig.localesOptions) !== null && _a !== void 0 ? _a : {
-            locales: ["en", "ar"],
-            directory: __dirname + '/locales',
-        });
-    }
-    buildRouter(app) {
-        var _a;
-        const dashboardController = new DashboardController_1.default(undefined, undefined, this.dashBoardConfig.resources);
-        const resourceController = new ResourceController_1.default(this.dashBoardConfig.resources, this.dashBoardConfig.configurations);
-        const actionController = new ActionController_1.default(this.dashBoardConfig.resources);
-        const appPath = path_1.default.normalize(path_1.default.join(__dirname, '/view'));
-        const router = (0, router_1.default)(dashboardController, resourceController, actionController, this.dashBoardConfig.authenticate);
-        app.use(express_1.default.static(appPath));
-        (0, router_1.createViewRoute)(router, appPath);
-        app.use((_a = this.dashBoardConfig.rootPath) !== null && _a !== void 0 ? _a : this.DEFAULT_ROOT_PATH, router);
-    }
-    configureAuthentication(app) {
-        if (!this.dashBoardConfig.authenticate || !this.dashBoardConfig.cookiesConfiguration) {
-            return;
-        }
-        app.use(cookieParser());
-        this.configureSession(app, this.dashBoardConfig.cookiesConfiguration);
-    }
-    configureSession(app, cookiesConfiguration) {
-        var _a;
-        const rootPath = (_a = this.dashBoardConfig.rootPath) !== null && _a !== void 0 ? _a : this.DEFAULT_ROOT_PATH;
-        app.use(`${rootPath}`, session({
-            secret: cookiesConfiguration.cookiesSecret,
-            resave: false,
-            saveUninitialized: false,
-            name: cookiesConfiguration.cookieName,
-            cookie: { path: `${rootPath}`, httpOnly: true }
-        }));
-    }
-    static configurBaseLocalization(options, locale) {
-        i18n_1.default.configure(options);
-        i18n_1.default.setLocale(locale);
-    }
-}
-exports.default = Dashboard;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const express_1 = __importDefault(require("express"));
+const DashboardController_1 = __importDefault(require("./controllers/DashboardController"));
+const router_1 = __importStar(require("./router"));
+const i18n_1 = __importDefault(require("i18n"));
+const ResourceController_1 = __importDefault(require("./controllers/ResourceController"));
+const path_1 = __importDefault(require("path"));
+const ActionController_1 = __importDefault(require("./controllers/ActionController"));
+var session = require('express-session');
+var cookieParser = require('cookie-parser');
+class Dashboard {
+    constructor(dashBoardConfig) {
+        this.dashBoardConfig = dashBoardConfig;
+        this.DEFAULT_ROOT_PATH = "/dashboard";
+    }
+    build(app) {
+        this.configureLocalization();
+        app.use(i18n_1.default.init);
+        app.use((req, res, next) => {
+            req.setLocale(req.headers['accept-language'] ? req.headers['accept-language'] : 'en');
+            i18n_1.default.setLocale(req.headers['accept-language'] ? req.headers['accept-language'] : 'en');
+            next();
+        });
+        this.configureAuthentication(app);
+        this.buildRouter(app);
+    }
+    configureLocalization() {
+        var _a;
+        i18n_1.default.configure((_a = this.dashBoardConfig.localesOptions) !== null && _a !== void 0 ? _a : {
+            locales: ["en", "ar"],
+            directory: __dirname + '/locales',
+        });
+    }
+    buildRouter(app) {
+        var _a;
+        const dashboardController = new DashboardController_1.default(undefined, undefined, this.dashBoardConfig.resources);
+        const resourceController = new ResourceController_1.default(this.dashBoardConfig.resources, this.dashBoardConfig.configurations);
+        const actionController = new ActionController_1.default(this.dashBoardConfig.resources);
+        const appPath = path_1.default.normalize(path_1.default.join(__dirname, '/view'));
+        const router = (0, router_1.default)(dashboardController, resourceController, actionController, this.dashBoardConfig.authenticate);
+        app.use(express_1.default.static(appPath));
+        (0, router_1.createViewRoute)(router, appPath);
+        app.use((_a = this.dashBoardConfig.rootPath) !== null && _a !== void 0 ? _a : this.DEFAULT_ROOT_PATH, router);
+    }
+    configureAuthentication(app) {
+        if (!this.dashBoardConfig.authenticate || !this.dashBoardConfig.cookiesConfiguration) {
+            return;
+        }
+        app.use(cookieParser());
+        this.configureSession(app, this.dashBoardConfig.cookiesConfiguration);
+    }
+    configureSession(app, cookiesConfiguration) {
+        var _a;
+        const rootPath = (_a = this.dashBoardConfig.rootPath) !== null && _a !== void 0 ? _a : this.DEFAULT_ROOT_PATH;
+        app.use(`${rootPath}`, session({
+            secret: cookiesConfiguration.cookiesSecret,
+            resave: false,
+            saveUninitialized: false,
+            name: cookiesConfiguration.cookieName,
+            cookie: { path: `${rootPath}`, httpOnly: true }
+        }));
+    }
+    static configurBaseLocalization(options, locale) {
+        i18n_1.default.configure(options);
+        i18n_1.default.setLocale(locale);
+    }
+}
+exports.default = Dashboard;

package/lib/container/helpers/HelperInversify.d.ts

@@ -1,6 +1,6 @@
-import { Container } from 'inversify';
-import { IResourceFile } from '../../types/IResourceFile';
-export default class HelperInversify {
-    static register(container: Container): void;
-    static registerResources(container: Container, resources: IResourceFile[]): void;
-}
+import { Container } from 'inversify';
+import { IResourceFile } from '../../types/IResourceFile';
+export default class HelperInversify {
+    static register(container: Container): void;
+    static registerResources(container: Container, resources: IResourceFile[]): void;
+}

package/lib/container/helpers/HelperInversify.js

@@ -1,10 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class HelperInversify {
-    static register(container) {
-        // container.bind<IResourceFile[]>(TYPES.Resources).toConstantValue([]);
-    }
-    static registerResources(container, resources) {
-    }
-}
-exports.default = HelperInversify;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class HelperInversify {
+    static register(container) {
+        // container.bind<IResourceFile[]>(TYPES.Resources).toConstantValue([]);
+    }
+    static registerResources(container, resources) {
+    }
+}
+exports.default = HelperInversify;

package/lib/container/helpers/HelperTypes.d.ts

@@ -1,5 +1,5 @@
-declare const HelperTypes: {
-    Resources: symbol;
-    RootPath: symbol;
-};
-export default HelperTypes;
+declare const HelperTypes: {
+    Resources: symbol;
+    RootPath: symbol;
+};
+export default HelperTypes;

package/lib/container/helpers/HelperTypes.js

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const HelperTypes = {
-    Resources: Symbol.for("Resources"),
-    RootPath: Symbol.for("rootPath")
-};
-exports.default = HelperTypes;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const HelperTypes = {
+    Resources: Symbol.for("Resources"),
+    RootPath: Symbol.for("rootPath")
+};
+exports.default = HelperTypes;

package/lib/container/index.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/container/index.js

@@ -1,14 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// let weapons = new ContainerModule(
-//   (
-//       bind: interfaces.Bind,
-//       unbind: interfaces.Unbind,
-//       isBound: interfaces.IsBound,
-//       rebind: interfaces.Rebind
-//   ) => {
-//       bind<Katana>("Katana").to(Katana);
-//       bind<Shuriken>("Shuriken").to(Shuriken);
-//   }
-// );
-// export default container;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// let weapons = new ContainerModule(
+//   (
+//       bind: interfaces.Bind,
+//       unbind: interfaces.Unbind,
+//       isBound: interfaces.IsBound,
+//       rebind: interfaces.Rebind
+//   ) => {
+//       bind<Katana>("Katana").to(Katana);
+//       bind<Shuriken>("Shuriken").to(Shuriken);
+//   }
+// );
+// export default container;

package/lib/container/repositories/RepositoryInversify.d.ts

@@ -1,4 +1,4 @@
-import { Container } from 'inversify';
-export default class RepositoryInversify {
-    static register(container: Container): void;
-}
+import { Container } from 'inversify';
+export default class RepositoryInversify {
+    static register(container: Container): void;
+}

package/lib/container/repositories/RepositoryInversify.js

@@ -1,13 +1,13 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const RequestLogRepository_1 = __importDefault(require("../../repositories/RequestLogRepository"));
-const types_1 = __importDefault(require("../types"));
-class RepositoryInversify {
-    static register(container) {
-        container.bind(types_1.default.IRequestLogRepository).to(RequestLogRepository_1.default);
-    }
-}
-exports.default = RepositoryInversify;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const RequestLogRepository_1 = __importDefault(require("../../repositories/RequestLogRepository"));
+const types_1 = __importDefault(require("../types"));
+class RepositoryInversify {
+    static register(container) {
+        container.bind(types_1.default.IRequestLogRepository).to(RequestLogRepository_1.default);
+    }
+}
+exports.default = RepositoryInversify;