Registry↗Dashboard↗

Configuration

Configuration and credential loading. Resolves credentials from explicit params, environment variables, and stored files with priority chain.

6 methods

config.loadConfig()

Load full SDK configuration. Resolves credentials via priority chain: explicit params > env vars > stored credentials.

ParametersLoadConfigOptions

apiKeyoptionalstring

API key (highest priority).

emailoptionalstringemail

Email for session auth.

passwordoptionalstring

Password for session auth.

sessionTokenoptionalstring

Pre-existing session token.

baseUrloptionalstringuri

API base URL.

authBaseUrloptionalstringuri

Auth API base URL.

profileoptionalstring

Credential profile name.

Default: default
debugoptionalboolean

Enable debug logging.

timeoutoptionalnumber

Request timeout in ms.

retriesoptionalnumber

Max retry attempts.

Return Fields

baseUrlrequiredstring

Resolved API base URL.

authBaseUrloptionalstring

Auth API base URL.

credentialsrequiredCredentials

Resolved credentials.

debugrequiredboolean

Whether debug mode is enabled.

timeoutoptionalnumber

Request timeout in ms.

retriesoptionalnumber

Max retry attempts.

Throws if no base URL is configured.
loadConfig(options?: LoadConfigOptions): SdkConfig
typescript
import { HttpClient } from '@uluops/sdk-core';

const client = new HttpClient({
  apiKey: 'ulr_your-api-key',
});

const result = await config.loadConfig();

console.log(result.baseUrl);
Response Type
// SdkConfig
{
  baseUrl: string;
  authBaseUrl?: string;
  credentials: Credentials;
  debug: boolean;
  timeout?: number;
  retries?: number;
}

config.loadCredentials()

Load credentials using priority chain: explicit params > environment variables > stored file (~/.uluops/credentials.json).

ParametersLoadCredentialsOptions

apiKeyoptionalstring

API key.

emailoptionalstringemail

Email.

passwordoptionalstring

Password.

sessionTokenoptionalstring

Session token.

profileoptionalstring

Profile name from credentials file.

Default: default
loadCredentials(options?: LoadCredentialsOptions): Credentials
typescript
import { HttpClient } from '@uluops/sdk-core';

const client = new HttpClient({
  apiKey: 'ulr_your-api-key',
});

const result = await config.loadCredentials();
Response Type
Credentials

config.loadEnvFiles()

Load environment variables from .env files. Priority: local .env > global ~/.uluops/.env. Called automatically by loadConfig and loadCredentials.

loadEnvFiles(): void
typescript
import { HttpClient } from '@uluops/sdk-core';

const client = new HttpClient({
  apiKey: 'ulr_your-api-key',
});

const result = await config.loadEnvFiles();
Response Type
void

config.loadStoredCredentials()

Load stored credentials from ~/.uluops/credentials.json. Validates session token expiration.

Parameters

profileoptionalstring

Profile name.

Default: default
loadStoredCredentials(profile?: string): Partial<Credentials> | null
typescript
import { HttpClient } from '@uluops/sdk-core';

const client = new HttpClient({
  apiKey: 'ulr_your-api-key',
});

const result = await config.loadStoredCredentials();
Response Type
Partial<Credentials> | null

config.validateCredentials()

Validate that required credentials are present. Throws ValidationError if no credentials found.

Parameters

credentialsrequiredCredentials

Credentials object to validate.

Throws ValidationError if no credentials present.
validateCredentials(credentials: Credentials): void
typescript
import { HttpClient } from '@uluops/sdk-core';

const client = new HttpClient({
  apiKey: 'ulr_your-api-key',
});

const result = await config.validateCredentials('example-value');
Response Type
void

config.isApiKey()

Check if a string looks like an API key (starts with 'ulr_' prefix).

Parameters

valuerequiredstring

String to check.

isApiKey(value: string): boolean
typescript
import { HttpClient } from '@uluops/sdk-core';

const client = new HttpClient({
  apiKey: 'ulr_your-api-key',
});

const result = await config.isApiKey('example-value');
Response Type
boolean