FormioAuthService

@tsed/formio

Usage

import { FormioAuthService } from "@tsed/formio";

See /packages/third-parties/formio/src/types/services/FormioAuthService.ts.

Overview

class FormioAuthService {
    formio: FormioService;
    hooks: FormioHooksService;
    db: FormioDatabase;
    get currentUser(): (arg1: Req, arg2: import("@tsed/platform-http").Res) => Promise<unknown>;
    get getToken(): (payload: FormioPayloadToken) => string | boolean;
    get tempToken(): (req: Req, res: import("@tsed/platform-http").Res) => void;
    get logout(): (req: Req, res: import("@tsed/platform-http").Res, next: TsED.NextFunction) => void;
    setCurrentUser<User = any>(user: WithID<FormioSubmission<User>>, token: FormioPayloadToken, ctx: PlatformContext): this;
    generatePayloadToken<User = any>(user: WithID<FormioSubmission<User>>, ctx: PlatformContext): Promise<{
        user: WithID<FormioSubmission<User>>;
        token: FormioPayloadToken;
    }>;
    generateSession<User = any>(user: WithID<FormioSubmission<User>>, ctx: PlatformContext): Promise<void>;
    getRoles(req?: Req): Promise<(import("mongoose").FlattenMaps<import("@tsed/mongoose").MongooseMergedDocument<import("mongoose").Document<unknown, any, any> & import("../domain/FormioModels.js").FormioRole & import("@tsed/mongoose").MongooseDocumentMethods<import("../domain/FormioModels.js").FormioRole>>> & Required<{
        _id: string;
    }>)[]>;
    updateUserRole(_id: string | any, role: string, req?: Req): Promise<import("mongoose").Document<unknown, {}, import("@tsed/mongoose").MongooseMergedDocument<import("mongoose").Document<unknown, any, any> & FormioSubmission<any> & import("@tsed/mongoose").MongooseDocumentMethods<FormioSubmission<any>>>> & import("@tsed/mongoose").MongooseMergedDocument<import("mongoose").Document<unknown, any, any> & FormioSubmission<any> & import("@tsed/mongoose").MongooseDocumentMethods<FormioSubmission<any>>> & Required<{
        _id: string;
    }> & {
        __v?: number | undefined;
    }>;
    createUser<User = any>(user: Partial<FormioSubmission<User>>): Promise<import("@tsed/mongoose").MongooseMergedDocument<import("mongoose").Document<unknown, any, any> & FormioSubmission<any> & import("@tsed/mongoose").MongooseDocumentMethods<FormioSubmission<any>>> & Required<{
        _id: string;
    }>>;
    updateUser<User = any>(user: WithID<FormioSubmission<User>>): Promise<WithID<FormioSubmission<User>>>;
}

formio

formio: FormioService;

hooks

hooks: FormioHooksService;

db

db: FormioDatabase;

get currentUser

get currentUser(): (arg1: Req, arg2: import("@tsed/platform-http").Res) => Promise<unknown>;

get getToken

get getToken(): (payload: FormioPayloadToken) => string | boolean;

get tempToken

get tempToken(): (req: Req, res: import("@tsed/platform-http").Res) => void;

get logout

get logout(): (req: Req, res: import("@tsed/platform-http").Res, next: TsED.NextFunction) => void;

setCurrentUser

setCurrentUser<User = any>(user: WithID<FormioSubmission<User>>, token: FormioPayloadToken, ctx: PlatformContext): this;

generatePayloadToken

generatePayloadToken<User = any>(user: WithID<FormioSubmission<User>>, ctx: PlatformContext): Promise<{
     user: WithID<FormioSubmission<User>>;
     token: FormioPayloadToken;
 }>;

Generate the payload token for the session

generateSession

generateSession<User = any>(user: WithID<FormioSubmission<User>>, ctx: PlatformContext): Promise<void>;

Generate session from the given authenticated user.

getRoles

getRoles(req?: Req): Promise<(import("mongoose").FlattenMaps<import("@tsed/mongoose").MongooseMergedDocument<import("mongoose").Document<unknown, any, any> & import("../domain/FormioModels.js").FormioRole & import("@tsed/mongoose").MongooseDocumentMethods<import("../domain/FormioModels.js").FormioRole>>> & Required<{
     _id: string;
 }>)[]>;

Retrieve roles

updateUserRole

updateUserRole(_id: string | any, role: string, req?: Req): Promise<import("mongoose").Document<unknown, {}, import("@tsed/mongoose").MongooseMergedDocument<import("mongoose").Document<unknown, any, any> & FormioSubmission<any> & import("@tsed/mongoose").MongooseDocumentMethods<FormioSubmission<any>>>> & import("@tsed/mongoose").MongooseMergedDocument<import("mongoose").Document<unknown, any, any> & FormioSubmission<any> & import("@tsed/mongoose").MongooseDocumentMethods<FormioSubmission<any>>> & Required<{
     _id: string;
 }> & {
     __v?: number | undefined;
 }>;

Update the role of the current user submission

createUser

createUser<User = any>(user: Partial<FormioSubmission<User>>): Promise<import("@tsed/mongoose").MongooseMergedDocument<import("mongoose").Document<unknown, any, any> & FormioSubmission<any> & import("@tsed/mongoose").MongooseDocumentMethods<FormioSubmission<any>>> & Required<{
     _id: string;
 }>>;

Create a user submission in formio

updateUser

updateUser<User = any>(user: WithID<FormioSubmission<User>>): Promise<WithID<FormioSubmission<User>>>;

Update user submission in formio