Skip to content

fix: Move OptimizelyOptions interface to shared_types #629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 21, 2020
Merged

fix: Move OptimizelyOptions interface to shared_types #629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
315c72a
Move OptimizelyOptions to shared_types
yavorona Nov 20, 2020
1e2b651
Update changelog
yavorona Nov 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/optimizely-sdk/CHANGELOG.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
- Refactored TypeScript type definitions to have `OptimizelyOptions` imported from `shared_types` to provide isolation from internal modules ([#629](https://github.com/optimizely/javascript-sdk/pull/629))

## [4.4.2] - November 19, 2020

Expand Down
2 changes: 1 addition & 1 deletion packages/optimizely-sdk/lib/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ declare module '@optimizely/optimizely-sdk' {

export type SDKOptions = import ('./shared_types').SDKOptions;

export type OptimizelyOptions = import ('./optimizely').OptimizelyOptions;
export type OptimizelyOptions = import ('./shared_types').OptimizelyOptions;

export type UserProfileService = import('./shared_types').UserProfileService;

Expand Down
26 changes: 2 additions & 24 deletions packages/optimizely-sdk/lib/optimizely/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ import {
EventDispatcher,
OnReadyResult,
UserProfileService,
DatafileOptions,
Variation,
FeatureFlag,
FeatureVariable
FeatureVariable,
OptimizelyOptions
} from '../shared_types';
import { createProjectConfigManager, ProjectConfigManager } from '../core/project_config/project_config_manager';
import { createNotificationCenter, NotificationCenter } from '../core/notification_center';
Expand Down Expand Up @@ -55,28 +55,6 @@ const MODULE_NAME = 'OPTIMIZELY';

const DEFAULT_ONREADY_TIMEOUT = 30000;

/**
* options required to create optimizely object
*/
export interface OptimizelyOptions {
UNSTABLE_conditionEvaluators?: unknown;
clientEngine: string;
clientVersion?: string;
datafile?: string;
datafileOptions?: DatafileOptions;
errorHandler: ErrorHandler;
eventBatchSize?: number;
eventDispatcher: EventDispatcher;
eventFlushInterval?: number;
eventMaxQueueSize?: number;
isValidInstance: boolean;
// TODO[OASIS-6649]: Don't use object type
// eslint-disable-next-line @typescript-eslint/ban-types
jsonSchemaValidator?: object;
logger: LogHandler;
sdkKey?: string;
userProfileService?: UserProfileService | null;
}

// TODO: Make feature_key, user_id, variable_key, experiment_key, event_key camelCase
export type InputKey = 'feature_key' | 'user_id' | 'variable_key' | 'experiment_key' | 'event_key' | 'variation_id';
Expand Down
23 changes: 23 additions & 0 deletions packages/optimizely-sdk/lib/shared_types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,29 @@ export type ObjectWithUnknownProperties = {
[key: string]: unknown;
}

/**
* options required to create optimizely object
*/
export interface OptimizelyOptions {
UNSTABLE_conditionEvaluators?: unknown;
clientEngine: string;
clientVersion?: string;
datafile?: string;
datafileOptions?: DatafileOptions;
errorHandler: ErrorHandler;
eventBatchSize?: number;
eventDispatcher: EventDispatcher;
eventFlushInterval?: number;
eventMaxQueueSize?: number;
isValidInstance: boolean;
// TODO[OASIS-6649]: Don't use object type
// eslint-disable-next-line @typescript-eslint/ban-types
jsonSchemaValidator?: object;
logger: LogHandler;
sdkKey?: string;
userProfileService?: UserProfileService | null;
}

/**
* Optimizely Config Entities
*/
Expand Down