@bluvo/sdk-ts/generated/auth/auth.ts

Bluvo SDK for TypeScript

import { RequestContext } from "../http/http";

/**
 * Interface authentication schemes.
 */
export interface SecurityAuthentication {
    /*
     * @return returns the name of the security authentication as specified in OAI
     */
    getName(): string;

    /**
     * Applies the authentication scheme to the request context
     *
     * @params context the request context which should use this authentication scheme
     */
    applySecurityAuthentication(context: RequestContext): void | Promise<void>;
}

export interface TokenProvider {
  getToken(): Promise<string> | string;
}

/**
 * Applies apiKey authentication to the request context.
 */
export class BluvoOrgIdAuthentication implements SecurityAuthentication {
    /**
     * Configures this api key authentication with the necessary properties
     *
     * @param apiKey: The api key to be used for every request
     */
    public constructor(private apiKey: string) {}

    public getName(): string {
        return "bluvoOrgId";
    }

    public applySecurityAuthentication(context: RequestContext) {
        context.setHeaderParam("x-bluvo-org-id", this.apiKey);
    }
}

/**
 * Applies apiKey authentication to the request context.
 */
export class BluvoProjectIdAuthentication implements SecurityAuthentication {
    /**
     * Configures this api key authentication with the necessary properties
     *
     * @param apiKey: The api key to be used for every request
     */
    public constructor(private apiKey: string) {}

    public getName(): string {
        return "bluvoProjectId";
    }

    public applySecurityAuthentication(context: RequestContext) {
        context.setHeaderParam("x-bluvo-project-id", this.apiKey);
    }
}

/**
 * Applies apiKey authentication to the request context.
 */
export class BluvoApiKeyAuthentication implements SecurityAuthentication {
    /**
     * Configures this api key authentication with the necessary properties
     *
     * @param apiKey: The api key to be used for every request
     */
    public constructor(private apiKey: string) {}

    public getName(): string {
        return "bluvoApiKey";
    }

    public applySecurityAuthentication(context: RequestContext) {
        context.setHeaderParam("x-bluvo-api-key", this.apiKey);
    }
}

/**
 * Applies apiKey authentication to the request context.
 */
export class BluvoWalletIdAuthentication implements SecurityAuthentication {
    /**
     * Configures this api key authentication with the necessary properties
     *
     * @param apiKey: The api key to be used for every request
     */
    public constructor(private apiKey: string) {}

    public getName(): string {
        return "bluvoWalletId";
    }

    public applySecurityAuthentication(context: RequestContext) {
        context.setHeaderParam("x-bluvo-wallet-id", this.apiKey);
    }
}


export type AuthMethods = {
    "default"?: SecurityAuthentication,
    "bluvoOrgId"?: SecurityAuthentication,
    "bluvoProjectId"?: SecurityAuthentication,
    "bluvoApiKey"?: SecurityAuthentication,
    "bluvoWalletId"?: SecurityAuthentication
}

export type ApiKeyConfiguration = string;
export type HttpBasicConfiguration = { "username": string, "password": string };
export type HttpBearerConfiguration = { tokenProvider: TokenProvider };
export type OAuth2Configuration = { accessToken: string };
export type HttpSignatureConfiguration = unknown; // TODO: Implement

export type AuthMethodsConfiguration = {
    "default"?: SecurityAuthentication,
    "bluvoOrgId"?: ApiKeyConfiguration,
    "bluvoProjectId"?: ApiKeyConfiguration,
    "bluvoApiKey"?: ApiKeyConfiguration,
    "bluvoWalletId"?: ApiKeyConfiguration
}

/**
 * Creates the authentication methods from a swagger description.
 *
 */
export function configureAuthMethods(config: AuthMethodsConfiguration | undefined): AuthMethods {
    let authMethods: AuthMethods = {}

    if (!config) {
        return authMethods;
    }
    authMethods["default"] = config["default"]

    if (config["bluvoOrgId"]) {
        authMethods["bluvoOrgId"] = new BluvoOrgIdAuthentication(
            config["bluvoOrgId"]
        );
    }

    if (config["bluvoProjectId"]) {
        authMethods["bluvoProjectId"] = new BluvoProjectIdAuthentication(
            config["bluvoProjectId"]
        );
    }

    if (config["bluvoApiKey"]) {
        authMethods["bluvoApiKey"] = new BluvoApiKeyAuthentication(
            config["bluvoApiKey"]
        );
    }

    if (config["bluvoWalletId"]) {
        authMethods["bluvoWalletId"] = new BluvoWalletIdAuthentication(
            config["bluvoWalletId"]
        );
    }

    return authMethods;
}