Skip to content

Commit d448fd8

Browse files
Update type definitions
1 parent 3b7b01a commit d448fd8

3 files changed

Lines changed: 55 additions & 45 deletions

File tree

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@splitsoftware/splitio-commons",
3-
"version": "3.0.0-rc.6",
3+
"version": "3.0.0-rc.7",
44
"description": "Split JavaScript SDK common components",
55
"main": "cjs/index.js",
66
"module": "esm/index.js",

types/splitio.d.ts

Lines changed: 52 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ interface ISharedSettings {
2626
* List of feature flag filters. These filters are used to fetch a subset of the feature flag definitions in your environment, in order to reduce the delay of the SDK to be ready.
2727
*
2828
* NOTES:
29-
* - This configuration is only meaningful when the SDK is working in `"standalone"` mode.
29+
* - This configuration is only meaningful when the SDK is working in `'standalone'` mode.
3030
* - If `bySet` filter is provided, `byName` and `byPrefix` filters are ignored.
3131
* - If both `byName` and `byPrefix` filters are provided, the intersection of the two groups of feature flags is fetched.
3232
*
@@ -2311,64 +2311,73 @@ declare namespace SplitIO {
23112311
*/
23122312
interface ConfigsClientSettings {
23132313
/**
2314-
* Your SDK key.
2314+
* SDK key used to authenticate with Harness services.
23152315
*
23162316
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/management-and-administration/account-settings/api-keys/}
23172317
*/
23182318
sdkKey: string;
23192319
/**
2320-
* Polling rate for configs and segments refresh, in seconds. Minimum value: 5.
2321-
*
2322-
* @defaultValue `60`
2323-
*/
2324-
pollingRate?: number;
2325-
/**
2326-
* Push rate for events and impressions, in seconds. Minimum value: 60.
2327-
*
2328-
* @defaultValue `60`
2329-
*/
2330-
pushRate?: number;
2331-
/**
2332-
* Maximum queue size for events and impressions. When the queue reaches this size, a flush is triggered. Minimum value: 1000.
2333-
*
2334-
* @defaultValue `10000`
2335-
*/
2336-
queueSize?: number;
2337-
/**
2338-
* Logging level.
2339-
*
2340-
* @defaultValue `'NONE'`
2341-
*/
2342-
logLevel?: LogLevel;
2343-
/**
2344-
* Time in seconds before emitting the `SDK_READY_TIMED_OUT` event.
2345-
* A value of `-1` disables the timeout and thus the event is never emitted.
2346-
*
2347-
* @defaultValue `10`
2320+
* Log level for SDK logging.
2321+
* - `'none'`: No logging
2322+
* - `'error'`: Log errors only
2323+
* - `'warn'`: Log warnings and errors
2324+
* - `'info'`: Log info, warnings, and errors
2325+
* - `'debug'`: Log debug info and above
2326+
* @defaultValue `'none'`
23482327
*/
2349-
readyTimeout?: number;
2328+
logLevel?: 'none' | 'error' | 'warn' | 'info' | 'debug';
23502329
/**
2351-
* Custom endpoints to replace the default ones used by the SDK.
2330+
* Synchronization configuration.
23522331
*/
2353-
urls?: {
2332+
sync?: {
23542333
/**
2355-
* String property to override the base URL where the SDK will get JWT authentication credentials.
2334+
* Polling rate for configs and segments refresh, in seconds. Minimum value: 5.
23562335
*
2357-
* @defaultValue `'https://auth.split.io'`
2336+
* @defaultValue `60`
23582337
*/
2359-
auth?: string;
2338+
pollingRate?: number;
23602339
/**
2361-
* String property to override the base URL where the SDK will get rollout plan related data, like configs and segments definitions.
2340+
* Push rate for events and impressions, in seconds. Minimum value: 60.
23622341
*
2363-
* @defaultValue `'https://configs.split.io'`
2342+
* @defaultValue `60`
23642343
*/
2365-
configs?: string;
2344+
pushRate?: number;
23662345
/**
2367-
* String property to override the base URL where the SDK will post event-related information like impressions.
2346+
* Maximum queue size for events and impressions. When the queue reaches this size, a flush is triggered. Minimum value: 1000.
2347+
*
2348+
* @defaultValue `10000`
2349+
*/
2350+
queueSize?: number;
2351+
/**
2352+
* Time in seconds before emitting the `SDK_READY_TIMED_OUT` event.
2353+
* A value of `-1` disables the timeout and thus the event is never emitted.
23682354
*
2369-
* @defaultValue `'https://events.split.io'`
2355+
* @defaultValue `10`
23702356
*/
2371-
events?: string;
2357+
readyTimeout?: number;
2358+
/**
2359+
* Base URLs used by the SDK for different services.
2360+
*/
2361+
serviceEndpoints?: {
2362+
/**
2363+
* String property to override the base URL where the SDK will get JWT authentication credentials.
2364+
*
2365+
* @defaultValue `'https://auth.split.io'`
2366+
*/
2367+
auth?: string;
2368+
/**
2369+
* String property to override the base URL where the SDK will get rollout plan related data, like configs and segments definitions.
2370+
*
2371+
* @defaultValue `'https://configs.split.io'`
2372+
*/
2373+
configs?: string;
2374+
/**
2375+
* String property to override the base URL where the SDK will post event-related information like impressions.
2376+
*
2377+
* @defaultValue `'https://events.split.io'`
2378+
*/
2379+
events?: string;
2380+
};
23722381
};
23732382
/**
23742383
* Fallback configuration objects returned by the `client.getConfig` method when the SDK is not ready or the provided config name is not found.
@@ -2385,6 +2394,7 @@ declare namespace SplitIO {
23852394
* You can use it, for example, for certificate pinning or setting a network proxy:
23862395
*
23872396
* ```
2397+
* const { ConfigsClient } = require('@splitsoftware/splitio-configs');
23882398
* const { HttpsProxyAgent } = require('https-proxy-agent');
23892399
*
23902400
* const proxyAgent = new HttpsProxyAgent(process.env.HTTPS_PROXY || 'http://10.10.1.10:1080');

0 commit comments

Comments
 (0)