@camunda8/sdk
Version:
[](https://www.npmjs.com/package/@camunda8/sdk)
38 lines (37 loc) • 1.72 kB
TypeScript
/**
* CamundaClientConfigTranslator
* ---------------------------------
* Translates Camunda 8 JS SDK configuration (constructor overrides + environment)
* into an EnvOverrides object suitable for hydrating the Orchestration Cluster API
* (OCA) client via its `hydrateConfig` function.
*
* Precedence (highest -> lowest) for each OCA config key:
* 1. Explicit OCA overrides passed into translator (ocaOverrides)
* 2. Matching OCA environment variable in `env` / process.env
* 3. Derived/mapped value from merged SDK configuration
* 4. OCA schema default (not emitted – left for OCA hydrator)
*
* Unsupported auth strategies (BEARER, COOKIE, others) throw.
* Empty string override / env values are treated as unset.
*/
export type EnvOverrides = Record<string, string | number | boolean>;
import { Camunda8ClientConfiguration } from './Configuration';
export interface CamundaClientTranslationOptions {
/** Partial explicit SDK configuration object passed by user */
sdkConfig?: Camunda8ClientConfiguration;
/** Explicit overrides for OCA keys to short‑circuit translation for those keys */
ocaOverrides?: EnvOverrides;
/** Environment source – defaults to process.env */
env?: Record<string, string | undefined>;
/** If true, return hydrated configuration instead of raw overrides */
hydrate?: boolean;
}
/**
* Translate merged SDK configuration into OCA EnvOverrides
*/
export declare function translateToOcaEnvOverrides(options: CamundaClientTranslationOptions): EnvOverrides;
/** Convenience wrapper returning hydrated configuration directly */
declare const _default: {
translateToOcaEnvOverrides: typeof translateToOcaEnvOverrides;
};
export default _default;