From 8a5143abc9dd3e0ac43652d76e94c27b4ced027e Mon Sep 17 00:00:00 2001 From: brunotot Date: Sat, 20 Apr 2024 12:25:09 +0000 Subject: [PATCH] deploy: 3a072efa45f7612e5b1237b1ab17563162eebee2 --- classes/backend.AuthController.html | 4 ++-- classes/backend.BackendAppConfig.html | 4 ++-- classes/backend.ErrorResponse.html | 6 +++--- classes/backend.InjectionDecoratorManager.html | 4 ++-- classes/backend.RouteDecoratorManager.html | 4 ++-- classes/backend.SwaggerManager.html | 4 ++-- classes/backend.UserController.html | 4 ++-- classes/backend.UserRepositoryImpl.html | 4 ++-- classes/backend.UserServiceImpl.html | 4 ++-- functions/backend.Autowired.html | 2 +- functions/backend.Controller.html | 2 +- functions/backend.DeleteMapping.html | 2 +- functions/backend.GetMapping.html | 2 +- functions/backend.HeadMapping.html | 2 +- functions/backend.Injectable.html | 2 +- functions/backend.OptionsMapping.html | 2 +- functions/backend.PatchMapping.html | 2 +- functions/backend.PostMapping.html | 2 +- functions/backend.PutMapping.html | 2 +- functions/backend.Route.html | 2 +- functions/backend.Transactional.html | 2 +- functions/backend.Use.html | 2 +- functions/backend.buildSwaggerBody.html | 2 +- functions/backend.convertZodToMongooseModel.html | 2 +- functions/backend.getInjectionClasses.html | 2 +- functions/backend.inject.html | 2 +- functions/backend.iocStartup.html | 2 +- functions/backend.mongoConnect.html | 2 +- functions/backend.registerRoutes.html | 2 +- functions/backend.registerSwagger.html | 2 +- functions/backend.startupLog.html | 2 +- functions/backend.withAugmentedResponse.html | 2 +- functions/backend.withCompression.html | 2 +- functions/backend.withCookieParser.html | 2 +- functions/backend.withCors.html | 2 +- functions/backend.withCredentials.html | 2 +- functions/backend.withHelmet.html | 2 +- functions/backend.withHpp.html | 2 +- functions/backend.withJsonParser.html | 2 +- functions/backend.withJwt.html | 2 +- functions/backend.withMorgan.html | 2 +- functions/backend.withRateLimit.html | 2 +- functions/backend.withUrlEncoded.html | 2 +- functions/backend.withUserRoles.html | 2 +- functions/backend.withValidatedBody.html | 2 +- ...ontend._Core._Components._Inputs.FuzzySearchDesktop.html | 2 +- ...frontend._Core._Components._Inputs.InputFuzzySearch.html | 2 +- ...end._Core._Components._Inputs.InputIconButtonSelect.html | 2 +- ...rontend._Core._Components._Inputs.InputLayoutToggle.html | 2 +- ...rontend._Core._Components._Inputs.InputLocaleSelect.html | 2 +- .../frontend._Core._Components._Inputs.InputRangeBasic.html | 2 +- ...frontend._Core._Components._Inputs.InputThemeToggle.html | 2 +- ...tend._Core._Components._Layout.HorizontalNavVariant.html | 2 +- functions/frontend._Core._Components._Layout.Layout.html | 2 +- ...rontend._Core._Components._Layout.SidebarNavVariant.html | 2 +- ...ntend._Core._Components._Navigation.ButtonHoverMenu.html | 2 +- .../frontend._Core._Components._Navigation.Sidebar.html | 2 +- .../frontend._Core._Components._Providers.AppProvider.html | 2 +- functions/frontend._Core._Components._Semantics.Footer.html | 2 +- functions/frontend._Core._Components._Semantics.Header.html | 2 +- functions/frontend._Core._Components._Semantics.Logo.html | 2 +- functions/frontend._Core._Signals.buildBaseThemeConfig.html | 2 +- functions/frontend._Pages.HomePage.html | 2 +- functions/frontend._Pages.LoginPage.html | 2 +- functions/frontend._Pages.RootErrorPage.html | 2 +- functions/frontend._Pages.Status404Page.html | 2 +- functions/frontend._Routes.isAnyRouteActive.html | 2 +- interfaces/backend.UserRepository.html | 4 ++-- interfaces/backend.UserService.html | 4 ++-- modules/frontend._Core._Components._Inputs.html | 2 +- modules/frontend._Core._Components._Layout.html | 2 +- modules/frontend._Core._Components._Navigation.html | 2 +- modules/frontend._Core._Components._Providers.html | 2 +- modules/frontend._Core._Components._Semantics.html | 2 +- modules/frontend._Core._Components.html | 2 +- modules/frontend._Core._Config.html | 2 +- modules/frontend._Core._Signals.html | 2 +- modules/frontend._Core.html | 2 +- modules/frontend._Pages.html | 2 +- modules/frontend._Routes.html | 2 +- types/backend.AllowedOrigin.html | 2 +- types/backend.ClassDecoratorSupplier.html | 2 +- types/backend.DatabaseConnectionParams.html | 2 +- types/backend.Entity.html | 2 +- types/backend.ErrorResponseContent.html | 2 +- types/backend.Exclude.html | 2 +- types/backend.ExpressRateLimitOptions.html | 2 +- types/backend.HttpStatusConverter.html | 2 +- types/backend.HttpStatusMain.html | 2 +- types/backend.HttpStatusNumeric.html | 2 +- types/backend.InferMongoId.html | 2 +- types/backend.InjectionMetaItem.html | 2 +- types/backend.Purify.html | 2 +- types/backend.RequestMappingProps.html | 2 +- types/backend.RequestRoute.html | 2 +- types/backend.RouteHandler.html | 2 +- types/backend.RouteMethod.html | 2 +- types/backend.RouteMiddleware.html | 2 +- types/backend.RouteMiddlewareHandler.html | 2 +- types/backend.RouteProps.html | 2 +- types/backend.RoutesMetaItem.html | 2 +- types/backend.StartupLogProps.html | 2 +- types/backend.SwaggerDefinition.html | 2 +- types/backend.SwaggerEntitySchema.html | 2 +- types/backend.SwaggerExternalDocs.html | 2 +- types/backend.SwaggerPath.html | 2 +- types/backend.SwaggerPaths.html | 2 +- types/backend.SwaggerRequestBody.html | 2 +- types/backend.SwaggerRequestContent.html | 2 +- types/backend.SwaggerRequestMapping.html | 2 +- types/backend.SwaggerResponse.html | 2 +- types/backend.SwaggerTag.html | 2 +- types/backend.User.html | 2 +- types/backend.Values.html | 2 +- ...end._Core._Components._Inputs.InputFuzzySearchProps.html | 2 +- ...Core._Components._Inputs.InputIconButtonSelectProps.html | 2 +- .../frontend._Core._Components._Inputs.InputRangeProps.html | 2 +- ...nd._Core._Components._Layout.HorizontalNavItemProps.html | 2 +- ..._Core._Components._Layout.HorizontalNavVariantProps.html | 2 +- types/frontend._Core._Components._Layout.LayoutVariant.html | 2 +- ...ntend._Core._Components._Layout.SidebarNavItemProps.html | 2 +- ...._Core._Components._Navigation.ButtonHoverMenuProps.html | 2 +- ...ontend._Core._Components._Navigation.OriginPosition.html | 2 +- ...ntend._Core._Components._Navigation.OriginPositionX.html | 2 +- ...ntend._Core._Components._Navigation.OriginPositionY.html | 2 +- ...frontend._Core._Components._Navigation.SidebarProps.html | 2 +- .../frontend._Core._Components._Semantics.FooterProps.html | 2 +- .../frontend._Core._Components._Semantics.HeaderProps.html | 2 +- types/frontend._Core._Components._Semantics.MuiSxProps.html | 2 +- types/frontend._Core._Config.I18nTranslateFn.html | 2 +- types/frontend._Core._Signals.Locale.html | 2 +- types/frontend._Core._Signals.MuiTheme.html | 2 +- types/frontend._Core._Signals.MuiThemeColors.html | 2 +- types/frontend._Core._Signals.MuiThemeConfig.html | 2 +- types/frontend._Core._Signals.User.html | 2 +- types/frontend._Routes.NavigationRoute.html | 2 +- types/frontend._Routes.NavigationRouteAnchor.html | 2 +- types/frontend._Routes.NavigationRouteAnchorSecure.html | 2 +- types/frontend._Routes.NavigationRouteChildren.html | 2 +- types/frontend._Routes.NavigationRouteMultiple.html | 2 +- types/frontend._Routes.NavigationRouteRender.html | 2 +- types/frontend._Routes.NavigationRouteSingle.html | 2 +- types/frontend._Routes.NavigationRoutes.html | 2 +- types/shared.Class.html | 2 +- types/shared.Role.html | 2 +- types/shared.TODO.html | 2 +- variables/backend.ErrorResponseContent-1.html | 2 +- variables/backend.GLOBAL_MIDDLEWARES.html | 2 +- variables/backend.MongoUser.html | 2 +- variables/backend.User-1.html | 2 +- variables/backend.VAR_ALLOWED_ORIGINS.html | 2 +- variables/backend.VAR_DATABASE_CONNECTION_PARAMS.html | 2 +- variables/backend.VAR_ZOD_ENVIRONMENT.html | 2 +- variables/backend._SwaggerManager.html | 2 +- variables/backend.logger.html | 2 +- variables/backend.stream.html | 2 +- variables/frontend._Core._Signals.sigLayout.html | 2 +- variables/frontend._Core._Signals.sigLocale.html | 2 +- variables/frontend._Core._Signals.sigSidebarOpen.html | 2 +- variables/frontend._Core._Signals.sigTheme.html | 2 +- variables/frontend._Core._Signals.sigUser.html | 2 +- variables/frontend._Routes.VAR_NAVIGATION_ROUTES.html | 2 +- variables/frontend._Routes.routes.html | 2 +- variables/shared.Role-1.html | 2 +- variables/shared.VAR_USER_ROLES.html | 2 +- 165 files changed, 177 insertions(+), 177 deletions(-) diff --git a/classes/backend.AuthController.html b/classes/backend.AuthController.html index b64eac74..a1381aab 100644 --- a/classes/backend.AuthController.html +++ b/classes/backend.AuthController.html @@ -157,12 +157,12 @@ --md-sys-color-surface-container-highest: #e5e1e6 } -

Class AuthController

Constructors

constructor +

Class AuthController

Constructors

Properties

Methods

Constructors

Properties

userRepository: UserRepository

Methods

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<Response<any, Record<string, any>>>

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<undefined | Response<any, Record<string, any>>>

-

Class BackendAppConfig

Constructors

constructor +

Class BackendAppConfig

Constructors

Properties

allowedOrigins: readonly ["http://127.0.0.1:5500", "http://localhost:3000", "http://localhost:5173"] = VAR_ALLOWED_ORIGINS
databaseConnectionParams: DatabaseConnectionParams
env: {
    ACCESS_TOKEN_SECRET: string;
    CREDENTIALS: string;
    DB_DATABASE: string;
    DB_HOST: string;
    DB_PORT: string;
    LOG_DIR: string;
    LOG_FORMAT: string;
    NODE_ENV: string;
    ORIGIN: string;
    PACKAGE_JSON_VERSION: string;
    PORT: string;
    REFRESH_TOKEN_SECRET: string;
} = VAR_ZOD_ENVIRONMENT

Type declaration

  • ACCESS_TOKEN_SECRET: string
  • CREDENTIALS: string
  • DB_DATABASE: string
  • DB_HOST: string
  • DB_PORT: string
  • LOG_DIR: string
  • LOG_FORMAT: string
  • NODE_ENV: string
  • ORIGIN: string
  • PACKAGE_JSON_VERSION: string
  • PORT: string
  • REFRESH_TOKEN_SECRET: string
userRoles: ["ADMIN", "USER"] = VAR_USER_ROLES

Accessors

-

Class ErrorResponse

Hierarchy

  • Error
    • ErrorResponse

Constructors

constructor +

Class ErrorResponse

Hierarchy

  • Error
    • ErrorResponse

Constructors

Properties

content: {
    details?: string;
    errorCode: string;
    message: string;
    metadata?: Record<string, unknown>;
    path: string;
    status: number;
    timestamp: string;
}

Type declaration

  • Optional details?: string
  • errorCode: string
  • message: string
  • Optional metadata?: Record<string, unknown>
  • path: string
  • status: number
  • timestamp: string
message: string
name: string
stack: undefined | string
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

Properties

content: {
    details?: string;
    errorCode: string;
    message: string;
    metadata?: Record<string, unknown>;
    path: string;
    status: number;
    timestamp: string;
}

Type declaration

  • Optional details?: string
  • errorCode: string
  • message: string
  • Optional metadata?: Record<string, unknown>
  • path: string
  • status: number
  • timestamp: string
message: string
name: string
stack: undefined | string
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • status: HttpStatusNumeric
    • details: string
    • metadata: Record<string, unknown> = {}

    Returns {
        details?: string;
        errorCode: string;
        message: string;
        metadata?: Record<string, unknown>;
        path: string;
        status: number;
        timestamp: string;
    }

    • Optional details?: string
    • errorCode: string
    • message: string
    • Optional metadata?: Record<string, unknown>
    • path: string
    • status: number
    • timestamp: string
  • Create .stack property on a target object

    +
stackTraceLimit: number

Methods

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • status: HttpStatusNumeric
    • details: string
    • metadata: Record<string, unknown> = {}

    Returns {
        details?: string;
        errorCode: string;
        message: string;
        metadata?: Record<string, unknown>;
        path: string;
        status: number;
        timestamp: string;
    }

    • Optional details?: string
    • errorCode: string
    • message: string
    • Optional metadata?: Record<string, unknown>
    • path: string
    • status: number
    • timestamp: string
  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

-

Class InjectionDecoratorManager

Hierarchy

Constructors

constructor +

Class InjectionDecoratorManager

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

#private: any

Accessors

  • get value(): Value
  • Returns Value

Methods

-

Class RouteDecoratorManager

Hierarchy

Constructors

constructor +

Class RouteDecoratorManager

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

#private: any

Accessors

  • get value(): Value
  • Returns Value

Methods

-

Class SwaggerManager

Constructors

constructor +

Class SwaggerManager

Constructors

Properties

#controllerClasses: Class[]
#definition: SwaggerDefinition

Accessors

Methods

-

Class UserController

Constructors

constructor +

Class UserController

Constructors

Properties

Methods

Constructors

Properties

userService: UserService

Methods

-

Class UserRepositoryImpl

Implements

Constructors

constructor +

Class UserRepositoryImpl

Implements

Constructors

Methods

Constructors

Methods

  • Parameters

    • user: {
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }
      • email: string
      • password: string
      • refreshToken: string[]
      • roles: ("ADMIN" | "USER")[]
      • username: string

    Returns Promise<Entity<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>>

  • Parameters

    • filters: undefined | FilterQuery<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }>

    Returns Promise<null | Entity<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>>

  • Parameters

    • user: {
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }
      • email: string
      • password: string
      • refreshToken: string[]
      • roles: ("ADMIN" | "USER")[]
      • username: string

    Returns Promise<Entity<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>>

-

Class UserServiceImpl

Implements

Constructors

constructor +

Class UserServiceImpl

Implements

Constructors

Properties

Methods

Constructors

Properties

userRepository: UserRepository

Methods

  • Parameters

    • user: {
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }
      • email: string
      • password: string
      • refreshToken: string[]
      • roles: ("ADMIN" | "USER")[]
      • username: string

    Returns Promise<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>

  • Returns Promise<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }[]>

Function Autowired

-

Function Controller

Function Controller

-

Function DeleteMapping

Function DeleteMapping

-

Function GetMapping

Function GetMapping

-

Function HeadMapping

Function HeadMapping

-

Function Injectable

Function Injectable

-

Function OptionsMapping

Function OptionsMapping

-

Function PatchMapping

Function PatchMapping

-

Function PostMapping

Function PostMapping

-

Function PutMapping

Function PutMapping

-

Function Route

Function Route

-

Function Transactional

Function Transactional

-

Function Use

Function Use

-

Function buildSwaggerBody

  • Parameters

    • schema: any

    Returns {
        content: {
            application/json: {
                schema: SchemaObject;
            };
        };
    }

    • content: {
          application/json: {
              schema: SchemaObject;
          };
      }
      • application/json: {
            schema: SchemaObject;
        }
        • schema: SchemaObject

Function buildSwaggerBody

  • Parameters

    • schema: any

    Returns {
        content: {
            application/json: {
                schema: SchemaObject;
            };
        };
    }

    • content: {
          application/json: {
              schema: SchemaObject;
          };
      }
      • application/json: {
            schema: SchemaObject;
        }
        • schema: SchemaObject
-

Function convertZodToMongooseModel

Function convertZodToMongooseModel

-

Function getInjectionClasses

Function getInjectionClasses

-

Function inject

Function inject

-

Function iocStartup

Function iocStartup

-

Function mongoConnect

Function mongoConnect

-

Function registerRoutes

Function registerRoutes

-

Function registerSwagger

Function registerSwagger

-

Function startupLog

Function startupLog

-

Function withAugmentedResponse

Function withAugmentedResponse

-

Function withCompression

Function withCompression

-

Function withCookieParser

Function withCookieParser

-

Function withCors

Function withCors

-

Function withCredentials

Function withCredentials

-

Function withHelmet

Function withHelmet

-

Function withHpp

Function withHpp

-

Function withJsonParser

Function withJsonParser

-

Function withJwt

Function withJwt

-

Function withMorgan

Function withMorgan

-

Function withRateLimit

Function withRateLimit

-

Function withUrlEncoded

Function withUrlEncoded

-

Function withUserRoles

Function withUserRoles

-

Function withValidatedBody

Function withValidatedBody

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

Interface UserRepository

interface UserRepository {
    create: ((user) => Promise<Entity<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>>);
    findAll: (() => Promise<Entity<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>[]>);
    findOne: ((filters) => Promise<null | Entity<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>>);
    save: ((user) => Promise<Entity<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>>);
}

Implemented by

Properties

create +

Interface UserRepository

interface UserRepository {
    create: ((user) => Promise<Entity<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>>);
    findAll: (() => Promise<Entity<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>[]>);
    findOne: ((filters) => Promise<null | Entity<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>>);
    save: ((user) => Promise<Entity<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>>);
}

Implemented by

Properties

create: ((user) => Promise<Entity<{
    email: string;
    password: string;
    refreshToken: string[];
    roles: ("ADMIN" | "USER")[];
    username: string;
}>>)

Type declaration

    • (user): Promise<Entity<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }>>
    • Parameters

      • user: {
            email: string;
            password: string;
            refreshToken: string[];
            roles: ("ADMIN" | "USER")[];
            username: string;
        }
        • email: string
        • password: string
        • refreshToken: string[]
        • roles: ("ADMIN" | "USER")[]
        • username: string

      Returns Promise<Entity<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }>>

findAll: (() => Promise<Entity<{
    email: string;
    password: string;
    refreshToken: string[];
    roles: ("ADMIN" | "USER")[];
    username: string;
}>[]>)

Type declaration

    • (): Promise<Entity<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }>[]>
    • Returns Promise<Entity<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }>[]>

findOne: ((filters) => Promise<null | Entity<{
    email: string;
    password: string;
    refreshToken: string[];
    roles: ("ADMIN" | "USER")[];
    username: string;
}>>)

Type declaration

    • (filters): Promise<null | Entity<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }>>
    • Parameters

      • filters: undefined | FilterQuery<{
            email: string;
            password: string;
            refreshToken: string[];
            roles: ("ADMIN" | "USER")[];
            username: string;
        }>

      Returns Promise<null | Entity<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }>>

save: ((user) => Promise<Entity<{
    email: string;
    password: string;
    refreshToken: string[];
    roles: ("ADMIN" | "USER")[];
    username: string;
}>>)

Type declaration

    • (user): Promise<Entity<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }>>
    • Parameters

      • user: {
            email: string;
            password: string;
            refreshToken: string[];
            roles: ("ADMIN" | "USER")[];
            username: string;
        }
        • email: string
        • password: string
        • refreshToken: string[]
        • roles: ("ADMIN" | "USER")[]
        • username: string

      Returns Promise<Entity<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }>>

-

Interface UserService

interface UserService {
    create: ((user) => Promise<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>);
    findAll: (() => Promise<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }[]>);
}

Implemented by

Properties

create +

Interface UserService

interface UserService {
    create: ((user) => Promise<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }>);
    findAll: (() => Promise<{
        email: string;
        password: string;
        refreshToken: string[];
        roles: ("ADMIN" | "USER")[];
        username: string;
    }[]>);
}

Implemented by

Properties

Properties

create: ((user) => Promise<{
    email: string;
    password: string;
    refreshToken: string[];
    roles: ("ADMIN" | "USER")[];
    username: string;
}>)

Type declaration

    • (user): Promise<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }>
    • Parameters

      • user: {
            email: string;
            password: string;
            refreshToken: string[];
            roles: ("ADMIN" | "USER")[];
            username: string;
        }
        • email: string
        • password: string
        • refreshToken: string[]
        • roles: ("ADMIN" | "USER")[]
        • username: string

      Returns Promise<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }>

findAll: (() => Promise<{
    email: string;
    password: string;
    refreshToken: string[];
    roles: ("ADMIN" | "USER")[];
    username: string;
}[]>)

Type declaration

    • (): Promise<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }[]>
    • Returns Promise<{
          email: string;
          password: string;
          refreshToken: string[];
          roles: ("ADMIN" | "USER")[];
          username: string;
      }[]>

-

Index

Type Aliases

InputFuzzySearchProps +

Index

Type Aliases

Functions

FuzzySearchDesktop diff --git a/modules/frontend._Core._Components._Layout.html b/modules/frontend._Core._Components._Layout.html index 2bc08ab7..9b4c58ec 100644 --- a/modules/frontend._Core._Components._Layout.html +++ b/modules/frontend._Core._Components._Layout.html @@ -157,7 +157,7 @@ --md-sys-color-surface-container-highest: #e5e1e6 } -

Index

Type Aliases

HorizontalNavItemProps +

Index

Type Aliases

HorizontalNavItemProps HorizontalNavVariantProps LayoutVariant SidebarNavItemProps diff --git a/modules/frontend._Core._Components._Navigation.html b/modules/frontend._Core._Components._Navigation.html index 8dbd8467..c05e80bb 100644 --- a/modules/frontend._Core._Components._Navigation.html +++ b/modules/frontend._Core._Components._Navigation.html @@ -157,7 +157,7 @@ --md-sys-color-surface-container-highest: #e5e1e6 } -

Index

Type Aliases

ButtonHoverMenuProps +

Index

Type Aliases

ButtonHoverMenuProps OriginPosition OriginPositionX OriginPositionY diff --git a/modules/frontend._Core._Components._Providers.html b/modules/frontend._Core._Components._Providers.html index ed72d4f5..7dbe3bdd 100644 --- a/modules/frontend._Core._Components._Providers.html +++ b/modules/frontend._Core._Components._Providers.html @@ -157,7 +157,7 @@ --md-sys-color-surface-container-highest: #e5e1e6 } -

Index

Functions

AppProvider +
-

Index

Type Aliases

FooterProps +

Index

Type Aliases

Functions

Footer diff --git a/modules/frontend._Core._Components.html b/modules/frontend._Core._Components.html index e0df9449..39d5e205 100644 --- a/modules/frontend._Core._Components.html +++ b/modules/frontend._Core._Components.html @@ -157,7 +157,7 @@ --md-sys-color-surface-container-highest: #e5e1e6 } -

Index

Namespaces

$Inputs +

Index

Namespaces

$Inputs $Layout $Navigation $Providers diff --git a/modules/frontend._Core._Config.html b/modules/frontend._Core._Config.html index 91295a72..26aa75be 100644 --- a/modules/frontend._Core._Config.html +++ b/modules/frontend._Core._Config.html @@ -157,7 +157,7 @@ --md-sys-color-surface-container-highest: #e5e1e6 } -

Index

Type Aliases

I18nTranslateFn +
-

Index

Type Aliases

Locale +

Index

Type Aliases

Locale MuiTheme MuiThemeColors MuiThemeConfig diff --git a/modules/frontend._Core.html b/modules/frontend._Core.html index 6ee16359..7565c2c4 100644 --- a/modules/frontend._Core.html +++ b/modules/frontend._Core.html @@ -157,7 +157,7 @@ --md-sys-color-surface-container-highest: #e5e1e6 } -

Namespace $Core

Index

Namespaces

$Components +
-

Namespace $Pages

Index

Functions

HomePage +

Namespace $Pages

Index

Functions

HomePage LoginPage RootErrorPage Status404Page diff --git a/modules/frontend._Routes.html b/modules/frontend._Routes.html index b7482a12..3e8458c3 100644 --- a/modules/frontend._Routes.html +++ b/modules/frontend._Routes.html @@ -157,7 +157,7 @@ --md-sys-color-surface-container-highest: #e5e1e6 } -

Namespace $Routes

Index

Type Aliases

NavigationRoute +

Namespace $Routes

Index

Type Aliases

NavigationRoute NavigationRouteAnchor NavigationRouteAnchorSecure NavigationRouteChildren diff --git a/types/backend.AllowedOrigin.html b/types/backend.AllowedOrigin.html index ca15e772..5b32792a 100644 --- a/types/backend.AllowedOrigin.html +++ b/types/backend.AllowedOrigin.html @@ -157,7 +157,7 @@ --md-sys-color-surface-container-highest: #e5e1e6 } -
-

Type alias ClassDecoratorSupplier

ClassDecoratorSupplier: ((context, constructor) => void)

Type declaration

    • (context, constructor): void
    • Parameters

      • context: DecoratorContext
      • constructor: Class

      Returns void

Type alias ClassDecoratorSupplier

ClassDecoratorSupplier: ((context, constructor) => void)

Type declaration

    • (context, constructor): void
    • Parameters

      • context: DecoratorContext
      • constructor: Class

      Returns void

-

Type alias DatabaseConnectionParams

DatabaseConnectionParams: {
    dbHost: string;
    dbName: string;
    dbPort: string;
} & Omit<ConnectOptions, "dbName">

Type declaration

  • dbHost: string
  • dbName: string
  • dbPort: string

Type alias DatabaseConnectionParams

DatabaseConnectionParams: {
    dbHost: string;
    dbName: string;
    dbPort: string;
} & Omit<ConnectOptions, "dbName">

Type declaration

  • dbHost: string
  • dbName: string
  • dbPort: string
-

Type alias Entity<T>

Entity<T>: Document<InferMongoId<T>, TODO, T> & T

Type Parameters

  • T

Type alias Entity<T>

Entity<T>: Document<InferMongoId<T>, TODO, T> & T

Type Parameters

  • T
-

Type alias Exclude<TParent, TExclude>

Exclude<TParent, TExclude>: Pick<TParent, Values<{
    [Prop in keyof TParent]: [TParent[Prop]] extends [TExclude]
        ? never
        : Prop
}>>

A type that excludes properties with values of type TExclude from TParent.

Type Parameters

  • TParent

    The parent type.

  • TExclude

    The type to exclude from TParent.

    -
-

Type alias ExpressRateLimitOptions

ExpressRateLimitOptions: Partial<Options>

Type alias ExpressRateLimitOptions

ExpressRateLimitOptions: Partial<Options>
-

Type alias HttpStatusConverter<T>

HttpStatusConverter<T>: {
    [K in keyof T]: T[K] extends number
        ? T[K]
        : never
}

Type Parameters

  • T

Type alias HttpStatusConverter<T>

HttpStatusConverter<T>: {
    [K in keyof T]: T[K] extends number
        ? T[K]
        : never
}

Type Parameters

  • T
-

Type alias HttpStatusMain

HttpStatusMain: Purify<HttpStatusConverter<typeof HttpStatus>>

Type alias HttpStatusMain

HttpStatusMain: Purify<HttpStatusConverter<typeof HttpStatus>>
-
-

Type alias InferMongoId<T>

InferMongoId<T>: "_id" extends keyof T
    ? T["_id"]
    : TODO

Type Parameters

  • T

Type alias InferMongoId<T>

InferMongoId<T>: "_id" extends keyof T
    ? T["_id"]
    : TODO

Type Parameters

  • T
-

Type alias InjectionMetaItem

InjectionMetaItem: {
    dependencies: string[];
    name: string;
}

Type declaration

  • dependencies: string[]
  • name: string

Type alias InjectionMetaItem

InjectionMetaItem: {
    dependencies: string[];
    name: string;
}

Type declaration

  • dependencies: string[]
  • name: string

Type alias Purify<T>

Purify<T>: Exclude<T, never>

A type that removes properties with values of type never from T.

Type Parameters

  • T

    The type to purify.

    -
-

Type alias RequestMappingProps

RequestMappingProps: {
    method: RouteMethod;
    middlewares: RouteMiddleware[];
    name: string;
    path: string;
}

Type declaration

Type alias RequestMappingProps

RequestMappingProps: {
    method: RouteMethod;
    middlewares: RouteMiddleware[];
    name: string;
    path: string;
}

Type declaration

-

Type alias RequestRoute

RequestRoute: RequestMappingProps & {
    handler: RouteHandler;
    swagger?: SwaggerPath;
}

Type declaration

Type alias RequestRoute

RequestRoute: RequestMappingProps & {
    handler: RouteHandler;
    swagger?: SwaggerPath;
}

Type declaration

-

Type alias RouteHandler

RouteHandler: ((req, res) => Promise<void | Response>)

Type declaration

    • (req, res): Promise<void | Response>
    • Parameters

      • req: Request
      • res: Response

      Returns Promise<void | Response>

Type alias RouteHandler

RouteHandler: ((req, res) => Promise<void | Response>)

Type declaration

    • (req, res): Promise<void | Response>
    • Parameters

      • req: Request
      • res: Response

      Returns Promise<void | Response>

-

Type alias RouteMethod

RouteMethod: "get" | "post" | "put" | "delete" | "patch" | "options" | "head"

Type alias RouteMethod

RouteMethod: "get" | "post" | "put" | "delete" | "patch" | "options" | "head"
-

Type alias RouteMiddleware

RouteMiddleware: ((req, res, next) => void)

Type declaration

    • (req, res, next): void
    • Parameters

      • req: Request
      • res: Response
      • next: NextFunction

      Returns void

Type alias RouteMiddleware

RouteMiddleware: ((req, res, next) => void)

Type declaration

    • (req, res, next): void
    • Parameters

      • req: Request
      • res: Response
      • next: NextFunction

      Returns void

-

Type alias RouteMiddlewareHandler

RouteMiddlewareHandler: ((req, res, next) => void)

Type declaration

    • (req, res, next): void
    • Parameters

      • req: Request
      • res: Response
      • next: NextFunction

      Returns void

Type alias RouteMiddlewareHandler

RouteMiddlewareHandler: ((req, res, next) => void)

Type declaration

    • (req, res, next): void
    • Parameters

      • req: Request
      • res: Response
      • next: NextFunction

      Returns void

-

Type alias RouteProps

RouteProps: Omit<RequestMappingProps, "name" | "middlewares"> & {
    swagger?: SwaggerPath;
}

Type declaration

Type alias RouteProps

RouteProps: Omit<RequestMappingProps, "name" | "middlewares"> & {
    swagger?: SwaggerPath;
}

Type declaration

-

Type alias RoutesMetaItem

RoutesMetaItem: {
    basePath: string;
    routes: RequestRoute[];
}

Type declaration

Type alias RoutesMetaItem

RoutesMetaItem: {
    basePath: string;
    routes: RequestRoute[];
}

Type declaration

-

Type alias StartupLogProps

StartupLogProps: {
    data: Record<string, string>;
    kvSeparator?: string;
    padding?: number;
    title: string;
}

Type declaration

  • data: Record<string, string>
  • Optional kvSeparator?: string
  • Optional padding?: number
  • title: string

Type alias StartupLogProps

StartupLogProps: {
    data: Record<string, string>;
    kvSeparator?: string;
    padding?: number;
    title: string;
}

Type declaration

  • data: Record<string, string>
  • Optional kvSeparator?: string
  • Optional padding?: number
  • title: string
-

Type alias SwaggerDefinition

SwaggerDefinition: swaggerJsdoc.SwaggerDefinition & {
    paths: SwaggerPaths;
    tags: SwaggerTag[];
}

Type declaration

Type alias SwaggerDefinition

SwaggerDefinition: swaggerJsdoc.SwaggerDefinition & {
    paths: SwaggerPaths;
    tags: SwaggerTag[];
}

Type declaration

-

Type alias SwaggerEntitySchema

SwaggerEntitySchema: TODO

Type alias SwaggerEntitySchema

SwaggerEntitySchema: TODO
-

Type alias SwaggerExternalDocs

SwaggerExternalDocs: {
    description: string;
    url: string;
}

Type declaration

  • description: string
  • url: string

Type alias SwaggerExternalDocs

SwaggerExternalDocs: {
    description: string;
    url: string;
}

Type declaration

  • description: string
  • url: string
-

Type alias SwaggerPath

SwaggerPath: {
    description?: string;
    operationId?: string;
    requestBody?: SwaggerRequestBody;
    responses?: SwaggerResponse;
    summary?: string;
    tags?: string[];
}

Type declaration

  • Optional description?: string
  • Optional operationId?: string
  • Optional requestBody?: SwaggerRequestBody
  • Optional responses?: SwaggerResponse
  • Optional summary?: string
  • Optional tags?: string[]

Type alias SwaggerPath

SwaggerPath: {
    description?: string;
    operationId?: string;
    requestBody?: SwaggerRequestBody;
    responses?: SwaggerResponse;
    summary?: string;
    tags?: string[];
}

Type declaration

  • Optional description?: string
  • Optional operationId?: string
  • Optional requestBody?: SwaggerRequestBody
  • Optional responses?: SwaggerResponse
  • Optional summary?: string
  • Optional tags?: string[]
-

Type alias SwaggerPaths

SwaggerPaths: Record<string, Partial<Record<SwaggerRequestMapping, SwaggerPath>>>

Type alias SwaggerPaths

SwaggerPaths: Record<string, Partial<Record<SwaggerRequestMapping, SwaggerPath>>>
-

Type alias SwaggerRequestBody

SwaggerRequestBody: {
    content?: SwaggerRequestContent;
    description?: string;
    required?: boolean;
}

Type declaration

Type alias SwaggerRequestBody

SwaggerRequestBody: {
    content?: SwaggerRequestContent;
    description?: string;
    required?: boolean;
}

Type declaration

-

Type alias SwaggerRequestContent

SwaggerRequestContent: Record<string, {
    schema: SwaggerEntitySchema;
}>

Type declaration

Type alias SwaggerRequestContent

SwaggerRequestContent: Record<string, {
    schema: SwaggerEntitySchema;
}>

Type declaration

-

Type alias SwaggerRequestMapping

SwaggerRequestMapping: "put" | "get" | "post" | "delete" | "patch" | "options" | "head"

Type alias SwaggerRequestMapping

SwaggerRequestMapping: "put" | "get" | "post" | "delete" | "patch" | "options" | "head"
-

Type alias SwaggerResponse

SwaggerResponse: Partial<Record<HttpStatusNumeric | "default", {
    content?: SwaggerRequestContent;
    description?: string;
}>>

Type alias SwaggerResponse

SwaggerResponse: Partial<Record<HttpStatusNumeric | "default", {
    content?: SwaggerRequestContent;
    description?: string;
}>>
-

Type alias SwaggerTag

SwaggerTag: {
    description?: string;
    externalDocs?: SwaggerExternalDocs;
    name: string;
}

Type declaration

Type alias SwaggerTag

SwaggerTag: {
    description?: string;
    externalDocs?: SwaggerExternalDocs;
    name: string;
}

Type declaration

-

Type alias Values<T>

Values<T>: T[keyof T]

A type that extracts the values from the properties of an object type T.

Type Parameters

  • T

    An object type.

    -
-
InputFuzzySearchProps: {
    placeholder?: string;
}

Type declaration

  • Optional placeholder?: string
InputFuzzySearchProps: {
    placeholder?: string;
}

Type declaration

  • Optional placeholder?: string
-

Type alias InputIconButtonSelectProps<Item, Value>

InputIconButtonSelectProps<Item, Value>: {
    items: Item[];
    mapToKey: ((item) => string | number);
    mapToValue: ((item) => Value);
    onChange: ((value) => void);
    renderButton: ((item) => React.ReactNode);
    renderEmpty: (() => React.ReactNode);
    renderOption: ((item) => React.ReactNode);
    size?: "small" | "medium" | "large";
    tooltip?: string;
    value: Value;
}

Type Parameters

  • Item = unknown
  • Value = Item

Type declaration

  • items: Item[]
  • mapToKey: ((item) => string | number)
      • (item): string | number
      • Parameters

        Returns string | number

  • mapToValue: ((item) => Value)
  • onChange: ((value) => void)
      • (value): void
      • Parameters

        Returns void

  • renderButton: ((item) => React.ReactNode)
      • (item): React.ReactNode
      • Parameters

        Returns React.ReactNode

  • renderEmpty: (() => React.ReactNode)
      • (): React.ReactNode
      • Returns React.ReactNode

  • renderOption: ((item) => React.ReactNode)
      • (item): React.ReactNode
      • Parameters

        Returns React.ReactNode

  • Optional size?: "small" | "medium" | "large"
  • Optional tooltip?: string
  • value: Value

Type alias InputIconButtonSelectProps<Item, Value>

InputIconButtonSelectProps<Item, Value>: {
    items: Item[];
    mapToKey: ((item) => string | number);
    mapToValue: ((item) => Value);
    onChange: ((value) => void);
    renderButton: ((item) => React.ReactNode);
    renderEmpty: (() => React.ReactNode);
    renderOption: ((item) => React.ReactNode);
    size?: "small" | "medium" | "large";
    tooltip?: string;
    value: Value;
}

Type Parameters

  • Item = unknown
  • Value = Item

Type declaration

  • items: Item[]
  • mapToKey: ((item) => string | number)
      • (item): string | number
      • Parameters

        Returns string | number

  • mapToValue: ((item) => Value)
  • onChange: ((value) => void)
      • (value): void
      • Parameters

        Returns void

  • renderButton: ((item) => React.ReactNode)
      • (item): React.ReactNode
      • Parameters

        Returns React.ReactNode

  • renderEmpty: (() => React.ReactNode)
      • (): React.ReactNode
      • Returns React.ReactNode

  • renderOption: ((item) => React.ReactNode)
      • (item): React.ReactNode
      • Parameters

        Returns React.ReactNode

  • Optional size?: "small" | "medium" | "large"
  • Optional tooltip?: string
  • value: Value
-
InputRangeProps: {
    label: string;
    max?: number;
    min?: number;
    onChange: ((value) => void);
    step?: number;
    unit?: string;
    value: number;
}

Type declaration

  • label: string
  • Optional max?: number
  • Optional min?: number
  • onChange: ((value) => void)
      • (value): void
      • Parameters

        • value: number

        Returns void

  • Optional step?: number
  • Optional unit?: string
  • value: number
InputRangeProps: {
    label: string;
    max?: number;
    min?: number;
    onChange: ((value) => void);
    step?: number;
    unit?: string;
    value: number;
}

Type declaration

  • label: string
  • Optional max?: number
  • Optional min?: number
  • onChange: ((value) => void)
      • (value): void
      • Parameters

        • value: number

        Returns void

  • Optional step?: number
  • Optional unit?: string
  • value: number
-
HorizontalNavItemProps: {
    dropdownPosition?: OriginPosition;
    item: NavigationRoute;
}

Type declaration

HorizontalNavItemProps: {
    dropdownPosition?: OriginPosition;
    item: NavigationRoute;
}

Type declaration

-
HorizontalNavVariantProps: {
    backgroundColor?: string;
    hidden?: boolean;
    maxWidth?: false | Breakpoint;
}

Type declaration

  • Optional backgroundColor?: string
  • Optional hidden?: boolean
  • Optional maxWidth?: false | Breakpoint
HorizontalNavVariantProps: {
    backgroundColor?: string;
    hidden?: boolean;
    maxWidth?: false | Breakpoint;
}

Type declaration

  • Optional backgroundColor?: string
  • Optional hidden?: boolean
  • Optional maxWidth?: false | Breakpoint
-
LayoutVariant: "HorizontalLayout" | "SidebarLayout"
LayoutVariant: "HorizontalLayout" | "SidebarLayout"
-
SidebarNavItemProps: {
    indent?: number;
    item: NavigationRoute;
}

Type declaration

SidebarNavItemProps: {
    indent?: number;
    item: NavigationRoute;
}

Type declaration

-
ButtonHoverMenuProps: {
    children: ReactNode;
    fixedAnchorWidth?: boolean;
    position?: OriginPosition;
    renderButton: ((hoverProps, popupState) => ReactNode);
    temporary?: boolean;
}

Type declaration

  • children: ReactNode
  • Optional fixedAnchorWidth?: boolean
  • Optional position?: OriginPosition
  • renderButton: ((hoverProps, popupState) => ReactNode)
      • (hoverProps, popupState): ReactNode
      • Parameters

        • hoverProps: ReturnType<typeof bindHover>
        • popupState: PopupStateProps

        Returns ReactNode

  • Optional temporary?: boolean
ButtonHoverMenuProps: {
    children: ReactNode;
    fixedAnchorWidth?: boolean;
    position?: OriginPosition;
    renderButton: ((hoverProps, popupState) => ReactNode);
    temporary?: boolean;
}

Type declaration

  • children: ReactNode
  • Optional fixedAnchorWidth?: boolean
  • Optional position?: OriginPosition
  • renderButton: ((hoverProps, popupState) => ReactNode)
      • (hoverProps, popupState): ReactNode
      • Parameters

        • hoverProps: ReturnType<typeof bindHover>
        • popupState: PopupStateProps

        Returns ReactNode

  • Optional temporary?: boolean
-
OriginPosition: {
    anchorX: OriginPositionX;
    anchorY: OriginPositionY;
    transformX: OriginPositionX;
    transformY: OriginPositionY;
}

Type declaration

OriginPosition: {
    anchorX: OriginPositionX;
    anchorY: OriginPositionY;
    transformX: OriginPositionX;
    transformY: OriginPositionY;
}

Type declaration

-
-
-
SidebarProps: {
    children: ReactNode;
    hidden?: boolean;
    onClose: (() => void);
    onOpen: (() => void);
    open: boolean;
    width?: number;
}

Type declaration

  • children: ReactNode
  • Optional hidden?: boolean
  • onClose: (() => void)
      • (): void
      • Returns void

  • onOpen: (() => void)
      • (): void
      • Returns void

  • open: boolean
  • Optional width?: number
SidebarProps: {
    children: ReactNode;
    hidden?: boolean;
    onClose: (() => void);
    onOpen: (() => void);
    open: boolean;
    width?: number;
}

Type declaration

  • children: ReactNode
  • Optional hidden?: boolean
  • onClose: (() => void)
      • (): void
      • Returns void

  • onOpen: (() => void)
      • (): void
      • Returns void

  • open: boolean
  • Optional width?: number
-
FooterProps: {
    backgroundColor?: string;
    maxWidth?: false | Breakpoint;
    sx?: MuiSxProps;
}

Type declaration

  • Optional backgroundColor?: string
  • Optional maxWidth?: false | Breakpoint
  • Optional sx?: MuiSxProps
FooterProps: {
    backgroundColor?: string;
    maxWidth?: false | Breakpoint;
    sx?: MuiSxProps;
}

Type declaration

  • Optional backgroundColor?: string
  • Optional maxWidth?: false | Breakpoint
  • Optional sx?: MuiSxProps
-
HeaderProps: {
    backgroundColor?: string;
    borderBottom?: boolean;
    maxWidth?: false | Breakpoint;
    sx?: MuiSxProps;
}

Type declaration

  • Optional backgroundColor?: string
  • Optional borderBottom?: boolean
  • Optional maxWidth?: false | Breakpoint
  • Optional sx?: MuiSxProps
HeaderProps: {
    backgroundColor?: string;
    borderBottom?: boolean;
    maxWidth?: false | Breakpoint;
    sx?: MuiSxProps;
}

Type declaration

  • Optional backgroundColor?: string
  • Optional borderBottom?: boolean
  • Optional maxWidth?: false | Breakpoint
  • Optional sx?: MuiSxProps
-
-
I18nTranslateFn: TFunction<"translation", undefined>
I18nTranslateFn: TFunction<"translation", undefined>
-
-
MuiTheme: Omit<Theme, "palette" | "applyStyles"> & CssVarsTheme
MuiTheme: Omit<Theme, "palette" | "applyStyles"> & CssVarsTheme
-
MuiThemeColors: {
    error: string;
    info: string;
    primary: string;
    secondary: string;
    success: string;
    warning: string;
}

Type declaration

  • error: string
  • info: string
  • primary: string
  • secondary: string
  • success: string
  • warning: string
MuiThemeColors: {
    error: string;
    info: string;
    primary: string;
    secondary: string;
    success: string;
    warning: string;
}

Type declaration

  • error: string
  • info: string
  • primary: string
  • secondary: string
  • success: string
  • warning: string
-
MuiThemeConfig: {
    colors: MuiThemeColors;
}

Type declaration

MuiThemeConfig: {
    colors: MuiThemeColors;
}

Type declaration

-
User: {
    id: number;
    roles: Role[];
}

Type declaration

  • id: number
  • roles: Role[]
User: {
    id: number;
    roles: Role[];
}

Type declaration

  • id: number
  • roles: Role[]
-
-

Type alias NavigationRouteAnchor

NavigationRouteAnchor: {
    hidden?: boolean;
    path: string;
    secure?: NavigationRouteAnchorSecure;
} & RouteObject

Type declaration

Type alias NavigationRouteAnchor

NavigationRouteAnchor: {
    hidden?: boolean;
    path: string;
    secure?: NavigationRouteAnchorSecure;
} & RouteObject

Type declaration

-

Type alias NavigationRouteAnchorSecure

NavigationRouteAnchorSecure: Role[] | ((user) => boolean | Role[])

Type declaration

Type alias NavigationRouteAnchorSecure

NavigationRouteAnchorSecure: Role[] | ((user) => boolean | Role[])

Type declaration

-

Type alias NavigationRouteChildren

NavigationRouteChildren: {
    children: NavigationRoute[];
}

Type declaration

Type alias NavigationRouteChildren

NavigationRouteChildren: {
    children: NavigationRoute[];
}

Type declaration

-

Type alias NavigationRouteMultiple

NavigationRouteMultiple: NavigationRouteRender & NavigationRouteChildren & {
    variant: "group" | "menu";
}

Type declaration

  • variant: "group" | "menu"

Type alias NavigationRouteMultiple

NavigationRouteMultiple: NavigationRouteRender & NavigationRouteChildren & {
    variant: "group" | "menu";
}

Type declaration

  • variant: "group" | "menu"
-

Type alias NavigationRouteRender

NavigationRouteRender: {
    icon?: ReactNode;
    label: ((translator) => string);
}

Type declaration

  • Optional icon?: ReactNode
  • label: ((translator) => string)

Type alias NavigationRouteRender

NavigationRouteRender: {
    icon?: ReactNode;
    label: ((translator) => string);
}

Type declaration

  • Optional icon?: ReactNode
  • label: ((translator) => string)
-

Type alias NavigationRouteSingle

NavigationRouteSingle: NavigationRouteRender & NavigationRouteAnchor & {
    variant?: "single";
}

Type declaration

  • Optional variant?: "single"

Type alias NavigationRouteSingle

NavigationRouteSingle: NavigationRouteRender & NavigationRouteAnchor & {
    variant?: "single";
}

Type declaration

  • Optional variant?: "single"
-
-

Type alias Class<T>

Class<T>: (new (...args) => T)

Type Parameters

Type declaration

    • new (...args): T
    • Parameters

      • Rest ...args: TODO[]

      Returns T

Type alias Class<T>

Class<T>: (new (...args) => T)

Type Parameters

Type declaration

    • new (...args): T
    • Parameters

      • Rest ...args: TODO[]

      Returns T

-

Type alias Role

Role: z.infer<typeof Role>

Type alias Role

Role: z.infer<typeof Role>
-

Type alias TODO

TODO: any

Type alias TODO

TODO: any
-

Variable ErrorResponseContentConst

ErrorResponseContent: ZodObject<{
    details: ZodOptional<ZodString>;
    errorCode: ZodString;
    message: ZodString;
    metadata: ZodOptional<ZodDefault<ZodRecord<ZodString, ZodUnknown>>>;
    path: ZodString;
    status: ZodNumber;
    timestamp: ZodString;
}, "strip", ZodTypeAny, {
    details?: string;
    errorCode: string;
    message: string;
    metadata?: Record<string, unknown>;
    path: string;
    status: number;
    timestamp: string;
}, {
    details?: string;
    errorCode: string;
    message: string;
    metadata?: Record<string, unknown>;
    path: string;
    status: number;
    timestamp: string;
}> = ...

Type declaration

  • details: ZodOptional<ZodString>
  • errorCode: ZodString
  • message: ZodString
  • metadata: ZodOptional<ZodDefault<ZodRecord<ZodString, ZodUnknown>>>
  • path: ZodString
  • status: ZodNumber
  • timestamp: ZodString

Type declaration

  • Optional details?: string
  • errorCode: string
  • message: string
  • Optional metadata?: Record<string, unknown>
  • path: string
  • status: number
  • timestamp: string

Type declaration

  • Optional details?: string
  • errorCode: string
  • message: string
  • Optional metadata?: Record<string, unknown>
  • path: string
  • status: number
  • timestamp: string

Variable ErrorResponseContentConst

ErrorResponseContent: ZodObject<{
    details: ZodOptional<ZodString>;
    errorCode: ZodString;
    message: ZodString;
    metadata: ZodOptional<ZodDefault<ZodRecord<ZodString, ZodUnknown>>>;
    path: ZodString;
    status: ZodNumber;
    timestamp: ZodString;
}, "strip", ZodTypeAny, {
    details?: string;
    errorCode: string;
    message: string;
    metadata?: Record<string, unknown>;
    path: string;
    status: number;
    timestamp: string;
}, {
    details?: string;
    errorCode: string;
    message: string;
    metadata?: Record<string, unknown>;
    path: string;
    status: number;
    timestamp: string;
}> = ...

Type declaration

  • details: ZodOptional<ZodString>
  • errorCode: ZodString
  • message: ZodString
  • metadata: ZodOptional<ZodDefault<ZodRecord<ZodString, ZodUnknown>>>
  • path: ZodString
  • status: ZodNumber
  • timestamp: ZodString

Type declaration

  • Optional details?: string
  • errorCode: string
  • message: string
  • Optional metadata?: Record<string, unknown>
  • path: string
  • status: number
  • timestamp: string

Type declaration

  • Optional details?: string
  • errorCode: string
  • message: string
  • Optional metadata?: Record<string, unknown>
  • path: string
  • status: number
  • timestamp: string
-

Variable GLOBAL_MIDDLEWARESConst

GLOBAL_MIDDLEWARES: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[] = ...

Variable GLOBAL_MIDDLEWARESConst

GLOBAL_MIDDLEWARES: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[] = ...
-

Variable MongoUserConst

MongoUser: Model<{
    email: string;
    password: string;
    refreshToken: string[];
    roles: ("ADMIN" | "USER")[];
    username: string;
}, {}, {}, {}, Document<unknown, {}, {
    email: string;
    password: string;
    refreshToken: string[];
    roles: ("ADMIN" | "USER")[];
    username: string;
}> & {
    email: string;
    password: string;
    refreshToken: string[];
    roles: ("ADMIN" | "USER")[];
    username: string;
} & {
    _id: ObjectId;
}, any> = ...

Type declaration

  • email: string
  • password: string
  • refreshToken: string[]
  • roles: ("ADMIN" | "USER")[]
  • username: string

Type declaration

    Type declaration

      Type declaration

        Variable MongoUserConst

        MongoUser: Model<{
            email: string;
            password: string;
            refreshToken: string[];
            roles: ("ADMIN" | "USER")[];
            username: string;
        }, {}, {}, {}, Document<unknown, {}, {
            email: string;
            password: string;
            refreshToken: string[];
            roles: ("ADMIN" | "USER")[];
            username: string;
        }> & {
            email: string;
            password: string;
            refreshToken: string[];
            roles: ("ADMIN" | "USER")[];
            username: string;
        } & {
            _id: ObjectId;
        }, any> = ...

        Type declaration

        • email: string
        • password: string
        • refreshToken: string[]
        • roles: ("ADMIN" | "USER")[]
        • username: string

        Type declaration

          Type declaration

            Type declaration

              -

              Variable UserConst

              User: ZodObject<{
                  email: ZodString;
                  password: ZodString;
                  refreshToken: ZodArray<ZodString, "many">;
                  roles: ZodArray<ZodEnum<["ADMIN", "USER"]>, "many">;
                  username: ZodString;
              }, "strip", ZodTypeAny, {
                  email: string;
                  password: string;
                  refreshToken: string[];
                  roles: ("ADMIN" | "USER")[];
                  username: string;
              }, {
                  email: string;
                  password: string;
                  refreshToken: string[];
                  roles: ("ADMIN" | "USER")[];
                  username: string;
              }> = ...

              Type declaration

              • email: ZodString
              • password: ZodString
              • refreshToken: ZodArray<ZodString, "many">
              • roles: ZodArray<ZodEnum<["ADMIN", "USER"]>, "many">
              • username: ZodString

              Type declaration

              • email: string
              • password: string
              • refreshToken: string[]
              • roles: ("ADMIN" | "USER")[]
              • username: string

              Type declaration

              • email: string
              • password: string
              • refreshToken: string[]
              • roles: ("ADMIN" | "USER")[]
              • username: string

              Variable UserConst

              User: ZodObject<{
                  email: ZodString;
                  password: ZodString;
                  refreshToken: ZodArray<ZodString, "many">;
                  roles: ZodArray<ZodEnum<["ADMIN", "USER"]>, "many">;
                  username: ZodString;
              }, "strip", ZodTypeAny, {
                  email: string;
                  password: string;
                  refreshToken: string[];
                  roles: ("ADMIN" | "USER")[];
                  username: string;
              }, {
                  email: string;
                  password: string;
                  refreshToken: string[];
                  roles: ("ADMIN" | "USER")[];
                  username: string;
              }> = ...

              Type declaration

              • email: ZodString
              • password: ZodString
              • refreshToken: ZodArray<ZodString, "many">
              • roles: ZodArray<ZodEnum<["ADMIN", "USER"]>, "many">
              • username: ZodString

              Type declaration

              • email: string
              • password: string
              • refreshToken: string[]
              • roles: ("ADMIN" | "USER")[]
              • username: string

              Type declaration

              • email: string
              • password: string
              • refreshToken: string[]
              • roles: ("ADMIN" | "USER")[]
              • username: string
              -

              Variable VAR_ALLOWED_ORIGINSConst

              VAR_ALLOWED_ORIGINS: readonly ["http://127.0.0.1:5500", "http://localhost:3000", "http://localhost:5173"] = ...

              Variable VAR_ALLOWED_ORIGINSConst

              VAR_ALLOWED_ORIGINS: readonly ["http://127.0.0.1:5500", "http://localhost:3000", "http://localhost:5173"] = ...
              -

              Variable VAR_DATABASE_CONNECTION_PARAMSConst

              VAR_DATABASE_CONNECTION_PARAMS: DatabaseConnectionParams = ...

              Variable VAR_DATABASE_CONNECTION_PARAMSConst

              VAR_DATABASE_CONNECTION_PARAMS: DatabaseConnectionParams = ...
              -

              Variable VAR_ZOD_ENVIRONMENTConst

              VAR_ZOD_ENVIRONMENT: {
                  ACCESS_TOKEN_SECRET: string;
                  CREDENTIALS: string;
                  DB_DATABASE: string;
                  DB_HOST: string;
                  DB_PORT: string;
                  LOG_DIR: string;
                  LOG_FORMAT: string;
                  NODE_ENV: string;
                  ORIGIN: string;
                  PACKAGE_JSON_VERSION: string;
                  PORT: string;
                  REFRESH_TOKEN_SECRET: string;
              } = ...

              Type declaration

              • ACCESS_TOKEN_SECRET: string
              • CREDENTIALS: string
              • DB_DATABASE: string
              • DB_HOST: string
              • DB_PORT: string
              • LOG_DIR: string
              • LOG_FORMAT: string
              • NODE_ENV: string
              • ORIGIN: string
              • PACKAGE_JSON_VERSION: string
              • PORT: string
              • REFRESH_TOKEN_SECRET: string

              Variable VAR_ZOD_ENVIRONMENTConst

              VAR_ZOD_ENVIRONMENT: {
                  ACCESS_TOKEN_SECRET: string;
                  CREDENTIALS: string;
                  DB_DATABASE: string;
                  DB_HOST: string;
                  DB_PORT: string;
                  LOG_DIR: string;
                  LOG_FORMAT: string;
                  NODE_ENV: string;
                  ORIGIN: string;
                  PACKAGE_JSON_VERSION: string;
                  PORT: string;
                  REFRESH_TOKEN_SECRET: string;
              } = ...

              Type declaration

              • ACCESS_TOKEN_SECRET: string
              • CREDENTIALS: string
              • DB_DATABASE: string
              • DB_HOST: string
              • DB_PORT: string
              • LOG_DIR: string
              • LOG_FORMAT: string
              • NODE_ENV: string
              • ORIGIN: string
              • PACKAGE_JSON_VERSION: string
              • PORT: string
              • REFRESH_TOKEN_SECRET: string
              -

              Variable $SwaggerManagerConst

              $SwaggerManager: SwaggerManager = ...

              Variable $SwaggerManagerConst

              $SwaggerManager: SwaggerManager = ...
              -

              Variable loggerConst

              logger: Logger = ...

              Variable loggerConst

              logger: Logger = ...
              -

              Variable streamConst

              stream: {
                  write: ((message) => void);
              } = ...

              Type declaration

              • write: ((message) => void)
                  • (message): void
                  • Parameters

                    • message: string

                    Returns void

              Variable streamConst

              stream: {
                  write: ((message) => void);
              } = ...

              Type declaration

              • write: ((message) => void)
                  • (message): void
                  • Parameters

                    • message: string

                    Returns void

              -
              -
              -

              Variable sigSidebarOpenConst

              sigSidebarOpen: Signal<boolean> = ...

              Variable sigSidebarOpenConst

              sigSidebarOpen: Signal<boolean> = ...
              -
              -
              -

              Variable VAR_NAVIGATION_ROUTESConst

              VAR_NAVIGATION_ROUTES: NavigationRoutes = ...

              Variable VAR_NAVIGATION_ROUTESConst

              VAR_NAVIGATION_ROUTES: NavigationRoutes = ...
              -

              Variable routesConst

              routes: RouteObject[] = ...

              Variable routesConst

              routes: RouteObject[] = ...
              -

              Variable RoleConst

              Role: ZodEnum<["ADMIN", "USER"]> = ...

              Variable RoleConst

              Role: ZodEnum<["ADMIN", "USER"]> = ...
              -

              Variable VAR_USER_ROLESConst

              VAR_USER_ROLES: ["ADMIN", "USER"] = Role.options

              Variable VAR_USER_ROLESConst

              VAR_USER_ROLES: ["ADMIN", "USER"] = Role.options