@aneoconsultingfr/armonik.api
Version:
gRPC API to interact with ArmoniK built for the web
106 lines (103 loc) • 5.28 kB
text/typescript
import _m0 from 'protobufjs/minimal.js';
declare const protobufPackage = "armonik.api.grpc.v1.auth";
/** Messages describing authentication and associated requests and responses. */
/** A user. */
interface User {
/** Username. If authentication is disabled, must be set to 'Anonymous' */
username: string;
/** Roles. If authentication is disabled, must return []. */
roles: string[];
/** Permissions. If authentication is disabled, must return every permissions. */
permissions: string[];
}
declare const User: {
encode(message: User, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): User;
fromJSON(object: any): User;
toJSON(message: User): unknown;
create<I extends {
username?: string | undefined;
roles?: string[] | undefined;
permissions?: string[] | undefined;
} & {
username?: string | undefined;
roles?: (string[] & string[] & { [K in Exclude<keyof I["roles"], keyof string[]>]: never; }) | undefined;
permissions?: (string[] & string[] & { [K_1 in Exclude<keyof I["permissions"], keyof string[]>]: never; }) | undefined;
} & { [K_2 in Exclude<keyof I, keyof User>]: never; }>(base?: I | undefined): User;
fromPartial<I_1 extends {
username?: string | undefined;
roles?: string[] | undefined;
permissions?: string[] | undefined;
} & {
username?: string | undefined;
roles?: (string[] & string[] & { [K_3 in Exclude<keyof I_1["roles"], keyof string[]>]: never; }) | undefined;
permissions?: (string[] & string[] & { [K_4 in Exclude<keyof I_1["permissions"], keyof string[]>]: never; }) | undefined;
} & { [K_5 in Exclude<keyof I_1, keyof User>]: never; }>(object: I_1): User;
};
/** Request to get current user informations. */
interface GetCurrentUserRequest {
}
declare const GetCurrentUserRequest: {
encode(_: GetCurrentUserRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetCurrentUserRequest;
fromJSON(_: any): GetCurrentUserRequest;
toJSON(_: GetCurrentUserRequest): unknown;
create<I extends {} & {} & { [K in Exclude<keyof I, never>]: never; }>(base?: I | undefined): GetCurrentUserRequest;
fromPartial<I_1 extends {} & {} & { [K_1 in Exclude<keyof I_1, never>]: never; }>(_: I_1): GetCurrentUserRequest;
};
/** Response to get current user informations. */
interface GetCurrentUserResponse {
/** Return current user. If auth failed, must throw a gRPC error. */
user: User | undefined;
}
declare const GetCurrentUserResponse: {
encode(message: GetCurrentUserResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetCurrentUserResponse;
fromJSON(object: any): GetCurrentUserResponse;
toJSON(message: GetCurrentUserResponse): unknown;
create<I extends {
user?: {
username?: string | undefined;
roles?: string[] | undefined;
permissions?: string[] | undefined;
} | undefined;
} & {
user?: ({
username?: string | undefined;
roles?: string[] | undefined;
permissions?: string[] | undefined;
} & {
username?: string | undefined;
roles?: (string[] & string[] & { [K in Exclude<keyof I["user"]["roles"], keyof string[]>]: never; }) | undefined;
permissions?: (string[] & string[] & { [K_1 in Exclude<keyof I["user"]["permissions"], keyof string[]>]: never; }) | undefined;
} & { [K_2 in Exclude<keyof I["user"], keyof User>]: never; }) | undefined;
} & { [K_3 in Exclude<keyof I, "user">]: never; }>(base?: I | undefined): GetCurrentUserResponse;
fromPartial<I_1 extends {
user?: {
username?: string | undefined;
roles?: string[] | undefined;
permissions?: string[] | undefined;
} | undefined;
} & {
user?: ({
username?: string | undefined;
roles?: string[] | undefined;
permissions?: string[] | undefined;
} & {
username?: string | undefined;
roles?: (string[] & string[] & { [K_4 in Exclude<keyof I_1["user"]["roles"], keyof string[]>]: never; }) | undefined;
permissions?: (string[] & string[] & { [K_5 in Exclude<keyof I_1["user"]["permissions"], keyof string[]>]: never; }) | undefined;
} & { [K_6 in Exclude<keyof I_1["user"], keyof User>]: never; }) | undefined;
} & { [K_7 in Exclude<keyof I_1, "user">]: never; }>(object: I_1): GetCurrentUserResponse;
};
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
[K in keyof T]?: DeepPartial<T[K]>;
} : Partial<T>;
type KeysOfUnion<T> = T extends T ? keyof T : never;
type Exact<P, I extends P> = P extends Builtin ? P : P & {
[K in keyof P]: Exact<P[K], I[K]>;
} & {
[K in Exclude<keyof I, KeysOfUnion<P>>]: never;
};
export { DeepPartial, Exact, GetCurrentUserRequest, GetCurrentUserResponse, User, protobufPackage };