@camunda8/sdk
Version:
[](https://www.npmjs.com/package/@camunda8/sdk)
143 lines (142 loc) • 8.66 kB
TypeScript
import { BeforeRequestHook } from 'got';
import { Logger } from '../c8/lib/C8Logger';
declare const getMainEnv: () => {
CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS: number;
CAMUNDA_CUSTOM_USER_AGENT_STRING: string | undefined;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_LOG_LEVEL: string;
ZEEBE_GRPC_ADDRESS: string;
ZEEBE_REST_ADDRESS: string;
ZEEBE_ADDRESS: string | undefined;
ZEEBE_CLIENT_ID: string | undefined;
ZEEBE_CLIENT_SECRET: string | undefined;
CAMUNDA_OAUTH_URL: string | undefined;
CAMUNDA_OAUTH_TOKEN: string | undefined;
CAMUNDA_TOKEN_SCOPE: string | undefined;
CAMUNDA_TENANT_ID: string | undefined;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string | undefined;
ZEEBE_TOKEN_AUDIENCE: string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: string | undefined;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_TOKEN_CACHE_DIR: string | undefined;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: string | undefined;
CAMUNDA_CUSTOM_ROOT_CERT_STRING: string | undefined;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: string | undefined;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: string | undefined;
CAMUNDA_OPERATE_BASE_URL: string | undefined;
CAMUNDA_OPTIMIZE_BASE_URL: string | undefined;
CAMUNDA_TASKLIST_BASE_URL: string | undefined;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_CONSOLE_BASE_URL: string | undefined;
CAMUNDA_CONSOLE_CLIENT_ID: string | undefined;
CAMUNDA_CONSOLE_CLIENT_SECRET: string | undefined;
CAMUNDA_BASIC_AUTH_USERNAME: string | undefined;
CAMUNDA_BASIC_AUTH_PASSWORD: string | undefined;
CAMUNDA_AUTH_STRATEGY: string;
};
declare const getZeebeEnv: () => {
ZEEBE_INSECURE_CONNECTION: boolean;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: number | undefined;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
type CamundaEnvironmentVariables = ReturnType<typeof getMainEnv> & ReturnType<typeof getZeebeEnv>;
export type CamundaEnvironmentVariable = keyof CamundaEnvironmentVariables;
export declare const CamundaEnvironmentVariableDictionary: ("CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS" | "CAMUNDA_CUSTOM_USER_AGENT_STRING" | "CAMUNDA_OAUTH_DISABLED" | "CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS" | "CAMUNDA_LOG_LEVEL" | "ZEEBE_GRPC_ADDRESS" | "ZEEBE_REST_ADDRESS" | "ZEEBE_ADDRESS" | "ZEEBE_CLIENT_ID" | "ZEEBE_CLIENT_SECRET" | "CAMUNDA_OAUTH_URL" | "CAMUNDA_OAUTH_TOKEN" | "CAMUNDA_TOKEN_SCOPE" | "CAMUNDA_TENANT_ID" | "CAMUNDA_ZEEBE_OAUTH_AUDIENCE" | "ZEEBE_TOKEN_AUDIENCE" | "CAMUNDA_OPERATE_OAUTH_AUDIENCE" | "CAMUNDA_TASKLIST_OAUTH_AUDIENCE" | "CAMUNDA_MODELER_OAUTH_AUDIENCE" | "CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE" | "CAMUNDA_CONSOLE_OAUTH_AUDIENCE" | "CAMUNDA_TOKEN_CACHE_DIR" | "CAMUNDA_TOKEN_DISK_CACHE_DISABLE" | "CAMUNDA_SECURE_CONNECTION" | "CAMUNDA_CUSTOM_ROOT_CERT_PATH" | "CAMUNDA_CUSTOM_ROOT_CERT_STRING" | "CAMUNDA_CUSTOM_CERT_CHAIN_PATH" | "CAMUNDA_CUSTOM_PRIVATE_KEY_PATH" | "CAMUNDA_OPERATE_BASE_URL" | "CAMUNDA_OPTIMIZE_BASE_URL" | "CAMUNDA_TASKLIST_BASE_URL" | "CAMUNDA_MODELER_BASE_URL" | "CAMUNDA_CONSOLE_BASE_URL" | "CAMUNDA_CONSOLE_CLIENT_ID" | "CAMUNDA_CONSOLE_CLIENT_SECRET" | "CAMUNDA_BASIC_AUTH_USERNAME" | "CAMUNDA_BASIC_AUTH_PASSWORD" | "CAMUNDA_AUTH_STRATEGY" | "ZEEBE_INSECURE_CONNECTION" | "ZEEBE_CLIENT_LOG_LEVEL" | "ZEEBE_GRPC_CLIENT_EAGER_CONNECT" | "ZEEBE_GRPC_CLIENT_RETRY" | "ZEEBE_GRPC_CLIENT_MAX_RETRIES" | "ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS" | "ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS" | "ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS" | "GRPC_KEEPALIVE_TIME_MS" | "GRPC_KEEPALIVE_TIMEOUT_MS" | "GRPC_INITIAL_RECONNECT_BACKOFF_MS" | "GRPC_MAX_RECONNECT_BACKOFF_MS" | "GRPC_MIN_RECONNECT_BACKOFF_MS" | "GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS" | "GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS" | "GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS" | "GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA" | "ZEEBE_CLIENT_LOG_TYPE" | "ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS" | "ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS")[];
export declare class CamundaEnvironmentConfigurator {
static ENV: () => {
zeebeGrpcSettings: {
ZEEBE_INSECURE_CONNECTION: boolean;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: number | undefined;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS: number;
CAMUNDA_CUSTOM_USER_AGENT_STRING: string | undefined;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_LOG_LEVEL: string;
ZEEBE_GRPC_ADDRESS: string;
ZEEBE_REST_ADDRESS: string;
ZEEBE_ADDRESS: string | undefined;
ZEEBE_CLIENT_ID: string | undefined;
ZEEBE_CLIENT_SECRET: string | undefined;
CAMUNDA_OAUTH_URL: string | undefined;
CAMUNDA_OAUTH_TOKEN: string | undefined;
CAMUNDA_TOKEN_SCOPE: string | undefined;
CAMUNDA_TENANT_ID: string | undefined;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string | undefined;
ZEEBE_TOKEN_AUDIENCE: string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: string | undefined;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_TOKEN_CACHE_DIR: string | undefined;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: string | undefined;
CAMUNDA_CUSTOM_ROOT_CERT_STRING: string | undefined;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: string | undefined;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: string | undefined;
CAMUNDA_OPERATE_BASE_URL: string | undefined;
CAMUNDA_OPTIMIZE_BASE_URL: string | undefined;
CAMUNDA_TASKLIST_BASE_URL: string | undefined;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_CONSOLE_BASE_URL: string | undefined;
CAMUNDA_CONSOLE_CLIENT_ID: string | undefined;
CAMUNDA_CONSOLE_CLIENT_SECRET: string | undefined;
CAMUNDA_BASIC_AUTH_USERNAME: string | undefined;
CAMUNDA_BASIC_AUTH_PASSWORD: string | undefined;
CAMUNDA_AUTH_STRATEGY: string;
};
static mergeConfigWithEnvironment: (config: DeepPartial<CamundaPlatform8Configuration>) => CamundaPlatform8Configuration;
}
export type CamundaPlatform8Configuration = ReturnType<typeof CamundaEnvironmentConfigurator.ENV> & {
middleware?: BeforeRequestHook[];
};
export type DeepPartial<T> = {
[K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
};
export type Camunda8ClientConfiguration = DeepPartial<CamundaPlatform8Configuration> & {
logger?: Logger;
};
export {};