Merge pull request #303 from devforth/AdminForth/758

feat: add  ITranslateFunction,  IAdminUserExpressRequest and ITransla…

Author: yaroslav8765

adminforth/documentation/docs/tutorial/03-Customization/06-customPages.md

@@ -306,11 +306,14 @@ Open `index.ts` file and add the following code *BEFORE* `admin.express.serve(`
 
 ```ts title="/index.ts"
 
+import type { IAdminUserExpressRequest } from 'adminforth';
+import express from 'express';
+
 ....
 
 app.get(`${ADMIN_BASE_URL}/api/dashboard/`,
   admin.express.authorize(
-    async (req:any, res:any) => {
+    async (req:IAdminUserExpressRequest, res: express.Response) => {
       const days = req.body.days || 7;
       const apartsByDays = admin.resource('aparts').dataConnector.client.prepare(
         `SELECT 

adminforth/documentation/docs/tutorial/03-Customization/08-pageInjections.md

@@ -98,9 +98,14 @@ Now create file `ApartsPie.vue` in the `custom` folder of your project:
 Also we have to add an Api to get percentages:
 
 ```ts title="./index.ts"
+import type { IAdminUserExpressRequest } from 'adminforth';
+import express from 'express';
+
+....
+
   app.get(`${ADMIN_BASE_URL}/api/aparts-by-room-percentages/`,
     admin.express.authorize(
-      async (req, res) => {
+      async (req: IAdminUserExpressRequest, res: express.Response) => {
         const roomPercentages = await admin.resource('aparts').dataConnector.client.prepare(
           `SELECT 
             number_of_rooms, 

adminforth/documentation/docs/tutorial/07-Plugins/01-AuditLog.md

@@ -160,10 +160,14 @@ Audit log is able to catch only standard actions like `create`, `update`, `delet
 If you have a custom, self coded actions in your API, you can log them by calling `logCustomAction` method of `AuditLogPlugin` instance:
 
 ```ts title="./resources/index.ts"
+import type { IAdminUserExpressRequest, ITranslateExpressRequest } from 'adminforth';
+import express from 'express';
+
+....
 
 app.get(`${ADMIN_BASE_URL}/api/dashboard/`,
   admin.express.authorize(
-    async (req, res) => {
+    async (req: IAdminUserExpressRequest, res: express.Response) => {
 
       admin.getPluginByClassName<AuditLogPlugin>('AuditLogPlugin').logCustomAction({
         resourceId: 'aparts',

adminforth/documentation/docs/tutorial/07-Plugins/10-i18n.md

@@ -425,10 +425,15 @@ onMounted(async () => {
 And on the backend side you can use tr function to translate the string:
 
 ```ts title="./index.ts"
+import type { IAdminUserExpressRequest, ITranslateExpressRequest } from 'adminforth';
+import express from 'express';
+
+....
+
   app.get(`${ADMIN_BASE_URL}/api/greeting`, 
     admin.express.authorize(
       admin.express.translatable(
-        async (req, res) => {
+        async (req: IAdminUserExpressRequest & ITranslateExpressRequest, res: express.Response) => {
           res.json({
             text: await req.tr('Welcome, {name}', 'customApis', { name: req.adminUser.username }),
           });

adminforth/types/Back.ts

@@ -1,4 +1,4 @@
-import type { Express } from 'express';
+import type { Express, Request } from 'express';
 import type { Writable } from 'stream';
 
 import { ActionCheckSource, AdminForthFilterOperators, AdminForthSortDirections, AllowedActionsEnum, 
@@ -105,6 +105,23 @@ export interface IExpressHttpServer extends IHttpServer {
   authorize(callable: Function): void;
 }
 
+export interface ITranslateFunction {
+  (
+    msg: string,
+    category: string,
+    params: any,
+    pluralizationNumber?: number
+  ): Promise<string>;
+}
+
+// Omit <Request, 'param'> is used to remove 'param' method from Request type for correct docs generation
+export interface IAdminUserExpressRequest extends Omit<Request, 'param'> {
+  adminUser: AdminUser;
+}
+
+export interface ITranslateExpressRequest extends Omit<Request, 'param'> {
+  tr: ITranslateFunction;
+}
 
 export interface IAdminForthSingleFilter {
   field?: string;

dev-demo/index.ts

@@ -1,7 +1,7 @@
 import betterSqlite3 from 'better-sqlite3';
 import express from 'express';
 import AdminForth, { AdminUser, Filters } from '../adminforth/index.js';
-
+import type { IAdminUserExpressRequest, ITranslateExpressRequest } from 'adminforth';
 import clicksResource from './resources/clicks.js';
 import apartmentsResource from './resources/apartments.js';
 import apartmentBuyersResource from './resources/apartment_buyers.js';
@@ -901,7 +901,7 @@ const port = process.env.PORT || 3000;
 app.get(
   '/api/testtest/', 
   admin.express.authorize(
-    async (req: express.Request, res: express.Response, next: express.NextFunction) => { 
+    async (req: IAdminUserExpressRequest, res: express.Response, next: express.NextFunction) => { 
         res.json({ ok: true, data: [1,2,3], adminUser: req.adminUser });
     }
   )
@@ -910,7 +910,7 @@ app.get(
 app.get(`${ADMIN_BASE_URL}/api/dashboard/`,
   admin.express.authorize(
     admin.express.translatable(
-      async (req: any, res: express.Response) => {
+      async (req: IAdminUserExpressRequest & ITranslateExpressRequest, res: express.Response) => {
         const days = req.body.days || 7;
         const apartsByDays = await admin.resource('aparts').dataConnector.client.prepare( 
           `SELECT 
@@ -1010,7 +1010,7 @@ app.get(`${ADMIN_BASE_URL}/api/dashboard/`,
 
 app.get(`${ADMIN_BASE_URL}/api/aparts-by-room-percentages/`,
   admin.express.authorize(
-    async (req, res) => {
+    async (req: IAdminUserExpressRequest, res: express.Response) => {
       const roomPercentages = await admin.resource('aparts').dataConnector.client.prepare(
         `SELECT 
           number_of_rooms,