fix: enhance endpoint options with authenticated and no-auth variants

Author: NoOne7135

adminforth/servers/express.ts

@@ -5,7 +5,16 @@ import { Express } from 'express';
 import type { AnySchemaObject } from 'ajv';
 import { apiReference } from '@scalar/express-api-reference';
 import fetch from 'node-fetch';
-import { AdminUserAuthorizeFunction, IAdminForth, IAdminForthEndpointOptions, IAdminForthExpressRouteSchema, IExpressHttpServer, HttpExtra } from '../types/Back.js';
+import {
+  AdminUserAuthorizeFunction,
+  IAdminForth,
+  IAdminForthAuthenticatedEndpointOptions,
+  IAdminForthEndpointOptions,
+  IAdminForthExpressRouteSchema,
+  IAdminForthNoAuthEndpointOptions,
+  IExpressHttpServer,
+  HttpExtra,
+} from '../types/Back.js';
 import { WebSocketServer } from 'ws';
 import { WebSocketClient } from './common.js';
 import { AdminUser } from '../types/Common.js';
@@ -547,6 +556,8 @@ class ExpressServer implements IExpressHttpServer {
     }));
   }
 
+  endpoint(options: IAdminForthAuthenticatedEndpointOptions): void;
+  endpoint(options: IAdminForthNoAuthEndpointOptions): void;
   endpoint(options: IAdminForthEndpointOptions) {
     const {
       method='GET',

adminforth/types/Back.ts

@@ -54,19 +54,35 @@ export interface IAdminForthEndpointHandlerInput {
   tr: ITranslateFunction;
 }
 
-export interface IAdminForthEndpointOptions {
+export interface IAdminForthAuthenticatedEndpointHandlerInput extends IAdminForthEndpointHandlerInput {
+  adminUser: AdminUser;
+}
+
+export interface IAdminForthEndpointOptionsBase {
   method: string,
-  noAuth?: boolean,
   path: string,
   description?: string,
   request_schema?: AnySchemaObject,
   response_schema?: AnySchemaObject,
   responce_schema?: AnySchemaObject,
   meta?: Record<string, unknown>,
   target?: 'json' | 'upload',
+}
+
+export interface IAdminForthAuthenticatedEndpointOptions extends IAdminForthEndpointOptionsBase {
+  noAuth?: false,
+  handler: (input: IAdminForthAuthenticatedEndpointHandlerInput) => void | Promise<any>,
+}
+
+export interface IAdminForthNoAuthEndpointOptions extends IAdminForthEndpointOptionsBase {
+  noAuth: true,
   handler: (input: IAdminForthEndpointHandlerInput) => void | Promise<any>,
 }
 
+export type IAdminForthEndpointOptions =
+  | IAdminForthAuthenticatedEndpointOptions
+  | IAdminForthNoAuthEndpointOptions;
+
 export type AdminForthExpressSchemaInput = AnySchemaObject | ZodType;
 
 export interface IAdminForthExpressRouteSchema {
@@ -143,7 +159,8 @@ export interface IHttpServer {
    * 
    * @param options : Object with method, path and handler properties.
    */
-  endpoint(options: IAdminForthEndpointOptions): void;
+  endpoint(options: IAdminForthAuthenticatedEndpointOptions): void;
+  endpoint(options: IAdminForthNoAuthEndpointOptions): void;
 
 }