@topgroup/diginext/dist/entities/Role.d.ts

A BUILD SERVER & CLI to deploy apps to any Kubernetes clusters.

/// <reference types="mongoose/types/aggregate" />
/// <reference types="mongoose/types/callback" />
/// <reference types="mongoose/types/collection" />
/// <reference types="mongoose/types/connection" />
/// <reference types="mongoose/types/cursor" />
/// <reference types="mongoose/types/document" />
/// <reference types="mongoose/types/error" />
/// <reference types="mongoose/types/expressions" />
/// <reference types="mongoose/types/helpers" />
/// <reference types="mongoose/types/middlewares" />
/// <reference types="mongoose/types/indexes" />
/// <reference types="mongoose/types/models" />
/// <reference types="mongoose/types/mongooseoptions" />
/// <reference types="mongoose/types/pipelinestage" />
/// <reference types="mongoose/types/populate" />
/// <reference types="mongoose/types/query" />
/// <reference types="mongoose/types/schemaoptions" />
/// <reference types="mongoose/types/schematypes" />
/// <reference types="mongoose/types/session" />
/// <reference types="mongoose/types/types" />
/// <reference types="mongoose/types/utility" />
/// <reference types="mongoose/types/validation" />
/// <reference types="mongoose/types/virtuals" />
/// <reference types="mongoose/types/inferschematype" />
import { Schema } from "mongoose";
import type { HiddenBodyKeys } from "../interfaces";
import { type IRoutePermission, type IRouteScope } from "../interfaces/IPermission";
import type { IBase } from "./Base";
export interface RoleRoute {
    /**
     * Route path
     * @example /api/v1/healthz
     */
    path: string;
    /**
     * @default ["full"]
     */
    permissions: IRoutePermission[];
    /**
     * (TBC)
     * @default all
     * @example all
     */
    scope?: IRouteScope[];
}
export interface IRole extends IBase {
    name: string;
    routes: RoleRoute[];
    maskedFields?: string[];
    /**
     * One of:
     * - undefined | "custom": custom role
     * - "admin"		: 	default super admin role
     * - "moderator"	: 	default moderator role
     * - "member"		: 	default member role
     * - "guest"		: 	default guest role
     */
    type?: string;
}
export type RoleDto = Omit<IRole, keyof HiddenBodyKeys>;
export declare const roleSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
    collection: string;
    timestamps: true;
}, {
    createdAt: NativeDate;
    updatedAt: NativeDate;
} & {
    public: boolean;
    active: boolean;
    createdAt: Date;
    updatedAt: Date;
    routes: import("mongoose").Types.DocumentArray<RoleRoute>;
    maskedFields: string[];
    workspace?: import("mongoose").Types.ObjectId;
    workspaceId?: import("mongoose").Types.ObjectId;
    name?: string;
    slug?: string;
    project?: import("mongoose").Types.ObjectId;
    projectId?: import("mongoose").Types.ObjectId;
    type?: string;
    owner?: import("mongoose").Types.ObjectId;
    metadata?: any;
    ownerSlug?: string;
    ownerId?: import("mongoose").Types.ObjectId;
    workspaceSlug?: string;
    updatedBy?: import("mongoose").Types.ObjectId;
    updatedById?: import("mongoose").Types.ObjectId;
    deletedBy?: import("mongoose").Types.ObjectId;
    deletedById?: import("mongoose").Types.ObjectId;
    deletedAt?: Date;
    migratedAt?: Date;
}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
    createdAt: NativeDate;
    updatedAt: NativeDate;
} & {
    public: boolean;
    active: boolean;
    createdAt: Date;
    updatedAt: Date;
    routes: import("mongoose").Types.DocumentArray<RoleRoute>;
    maskedFields: string[];
    workspace?: import("mongoose").Types.ObjectId;
    workspaceId?: import("mongoose").Types.ObjectId;
    name?: string;
    slug?: string;
    project?: import("mongoose").Types.ObjectId;
    projectId?: import("mongoose").Types.ObjectId;
    type?: string;
    owner?: import("mongoose").Types.ObjectId;
    metadata?: any;
    ownerSlug?: string;
    ownerId?: import("mongoose").Types.ObjectId;
    workspaceSlug?: string;
    updatedBy?: import("mongoose").Types.ObjectId;
    updatedById?: import("mongoose").Types.ObjectId;
    deletedBy?: import("mongoose").Types.ObjectId;
    deletedById?: import("mongoose").Types.ObjectId;
    deletedAt?: Date;
    migratedAt?: Date;
}>> & import("mongoose").FlatRecord<{
    createdAt: NativeDate;
    updatedAt: NativeDate;
} & {
    public: boolean;
    active: boolean;
    createdAt: Date;
    updatedAt: Date;
    routes: import("mongoose").Types.DocumentArray<RoleRoute>;
    maskedFields: string[];
    workspace?: import("mongoose").Types.ObjectId;
    workspaceId?: import("mongoose").Types.ObjectId;
    name?: string;
    slug?: string;
    project?: import("mongoose").Types.ObjectId;
    projectId?: import("mongoose").Types.ObjectId;
    type?: string;
    owner?: import("mongoose").Types.ObjectId;
    metadata?: any;
    ownerSlug?: string;
    ownerId?: import("mongoose").Types.ObjectId;
    workspaceSlug?: string;
    updatedBy?: import("mongoose").Types.ObjectId;
    updatedById?: import("mongoose").Types.ObjectId;
    deletedBy?: import("mongoose").Types.ObjectId;
    deletedById?: import("mongoose").Types.ObjectId;
    deletedAt?: Date;
    migratedAt?: Date;
}> & {
    _id: import("mongoose").Types.ObjectId;
}>;
export declare const RoleModel: import("mongoose").Model<{
    createdAt: NativeDate;
    updatedAt: NativeDate;
} & {
    public: boolean;
    active: boolean;
    createdAt: Date;
    updatedAt: Date;
    routes: import("mongoose").Types.DocumentArray<RoleRoute>;
    maskedFields: string[];
    workspace?: import("mongoose").Types.ObjectId;
    workspaceId?: import("mongoose").Types.ObjectId;
    name?: string;
    slug?: string;
    project?: import("mongoose").Types.ObjectId;
    projectId?: import("mongoose").Types.ObjectId;
    type?: string;
    owner?: import("mongoose").Types.ObjectId;
    metadata?: any;
    ownerSlug?: string;
    ownerId?: import("mongoose").Types.ObjectId;
    workspaceSlug?: string;
    updatedBy?: import("mongoose").Types.ObjectId;
    updatedById?: import("mongoose").Types.ObjectId;
    deletedBy?: import("mongoose").Types.ObjectId;
    deletedById?: import("mongoose").Types.ObjectId;
    deletedAt?: Date;
    migratedAt?: Date;
}, {}, {}, {}, import("mongoose").Document<unknown, {}, {
    createdAt: NativeDate;
    updatedAt: NativeDate;
} & {
    public: boolean;
    active: boolean;
    createdAt: Date;
    updatedAt: Date;
    routes: import("mongoose").Types.DocumentArray<RoleRoute>;
    maskedFields: string[];
    workspace?: import("mongoose").Types.ObjectId;
    workspaceId?: import("mongoose").Types.ObjectId;
    name?: string;
    slug?: string;
    project?: import("mongoose").Types.ObjectId;
    projectId?: import("mongoose").Types.ObjectId;
    type?: string;
    owner?: import("mongoose").Types.ObjectId;
    metadata?: any;
    ownerSlug?: string;
    ownerId?: import("mongoose").Types.ObjectId;
    workspaceSlug?: string;
    updatedBy?: import("mongoose").Types.ObjectId;
    updatedById?: import("mongoose").Types.ObjectId;
    deletedBy?: import("mongoose").Types.ObjectId;
    deletedById?: import("mongoose").Types.ObjectId;
    deletedAt?: Date;
    migratedAt?: Date;
}> & {
    createdAt: NativeDate;
    updatedAt: NativeDate;
} & {
    public: boolean;
    active: boolean;
    createdAt: Date;
    updatedAt: Date;
    routes: import("mongoose").Types.DocumentArray<RoleRoute>;
    maskedFields: string[];
    workspace?: import("mongoose").Types.ObjectId;
    workspaceId?: import("mongoose").Types.ObjectId;
    name?: string;
    slug?: string;
    project?: import("mongoose").Types.ObjectId;
    projectId?: import("mongoose").Types.ObjectId;
    type?: string;
    owner?: import("mongoose").Types.ObjectId;
    metadata?: any;
    ownerSlug?: string;
    ownerId?: import("mongoose").Types.ObjectId;
    workspaceSlug?: string;
    updatedBy?: import("mongoose").Types.ObjectId;
    updatedById?: import("mongoose").Types.ObjectId;
    deletedBy?: import("mongoose").Types.ObjectId;
    deletedById?: import("mongoose").Types.ObjectId;
    deletedAt?: Date;
    migratedAt?: Date;
} & {
    _id: import("mongoose").Types.ObjectId;
}, Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
    collection: string;
    timestamps: true;
}, {
    createdAt: NativeDate;
    updatedAt: NativeDate;
} & {
    public: boolean;
    active: boolean;
    createdAt: Date;
    updatedAt: Date;
    routes: import("mongoose").Types.DocumentArray<RoleRoute>;
    maskedFields: string[];
    workspace?: import("mongoose").Types.ObjectId;
    workspaceId?: import("mongoose").Types.ObjectId;
    name?: string;
    slug?: string;
    project?: import("mongoose").Types.ObjectId;
    projectId?: import("mongoose").Types.ObjectId;
    type?: string;
    owner?: import("mongoose").Types.ObjectId;
    metadata?: any;
    ownerSlug?: string;
    ownerId?: import("mongoose").Types.ObjectId;
    workspaceSlug?: string;
    updatedBy?: import("mongoose").Types.ObjectId;
    updatedById?: import("mongoose").Types.ObjectId;
    deletedBy?: import("mongoose").Types.ObjectId;
    deletedById?: import("mongoose").Types.ObjectId;
    deletedAt?: Date;
    migratedAt?: Date;
}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
    createdAt: NativeDate;
    updatedAt: NativeDate;
} & {
    public: boolean;
    active: boolean;
    createdAt: Date;
    updatedAt: Date;
    routes: import("mongoose").Types.DocumentArray<RoleRoute>;
    maskedFields: string[];
    workspace?: import("mongoose").Types.ObjectId;
    workspaceId?: import("mongoose").Types.ObjectId;
    name?: string;
    slug?: string;
    project?: import("mongoose").Types.ObjectId;
    projectId?: import("mongoose").Types.ObjectId;
    type?: string;
    owner?: import("mongoose").Types.ObjectId;
    metadata?: any;
    ownerSlug?: string;
    ownerId?: import("mongoose").Types.ObjectId;
    workspaceSlug?: string;
    updatedBy?: import("mongoose").Types.ObjectId;
    updatedById?: import("mongoose").Types.ObjectId;
    deletedBy?: import("mongoose").Types.ObjectId;
    deletedById?: import("mongoose").Types.ObjectId;
    deletedAt?: Date;
    migratedAt?: Date;
}>> & import("mongoose").FlatRecord<{
    createdAt: NativeDate;
    updatedAt: NativeDate;
} & {
    public: boolean;
    active: boolean;
    createdAt: Date;
    updatedAt: Date;
    routes: import("mongoose").Types.DocumentArray<RoleRoute>;
    maskedFields: string[];
    workspace?: import("mongoose").Types.ObjectId;
    workspaceId?: import("mongoose").Types.ObjectId;
    name?: string;
    slug?: string;
    project?: import("mongoose").Types.ObjectId;
    projectId?: import("mongoose").Types.ObjectId;
    type?: string;
    owner?: import("mongoose").Types.ObjectId;
    metadata?: any;
    ownerSlug?: string;
    ownerId?: import("mongoose").Types.ObjectId;
    workspaceSlug?: string;
    updatedBy?: import("mongoose").Types.ObjectId;
    updatedById?: import("mongoose").Types.ObjectId;
    deletedBy?: import("mongoose").Types.ObjectId;
    deletedById?: import("mongoose").Types.ObjectId;
    deletedAt?: Date;
    migratedAt?: Date;
}> & {
    _id: import("mongoose").Types.ObjectId;
}>>;
//# sourceMappingURL=Role.d.ts.map