@splitsoftware/splitio-commons 1.6.2-rc.0 → 1.6.2-rc.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/sdkFactory/index.js +1 -0
- package/cjs/services/splitApi.js +1 -0
- package/cjs/utils/key/index.js +1 -1
- package/cjs/utils/settingsValidation/index.js +1 -0
- package/esm/sdkFactory/index.js +1 -0
- package/esm/services/splitApi.js +1 -0
- package/esm/utils/key/index.js +1 -1
- package/esm/utils/settingsValidation/index.js +1 -0
- package/package.json +2 -2
- package/src/consent/sdkUserConsent.ts +4 -3
- package/src/dtos/types.ts +0 -8
- package/src/evaluator/Engine.ts +3 -3
- package/src/evaluator/combiners/and.ts +1 -1
- package/src/evaluator/combiners/ifelseif.ts +3 -3
- package/src/evaluator/condition/engineUtils.ts +1 -1
- package/src/evaluator/condition/index.ts +6 -6
- package/src/evaluator/index.ts +10 -10
- package/src/evaluator/matchers/all.ts +1 -1
- package/src/evaluator/matchers/between.ts +1 -1
- package/src/evaluator/matchers/boolean.ts +1 -1
- package/src/evaluator/matchers/cont_all.ts +1 -1
- package/src/evaluator/matchers/cont_any.ts +1 -1
- package/src/evaluator/matchers/cont_str.ts +1 -1
- package/src/evaluator/matchers/dependency.ts +1 -1
- package/src/evaluator/matchers/eq.ts +1 -1
- package/src/evaluator/matchers/eq_set.ts +1 -1
- package/src/evaluator/matchers/ew.ts +1 -1
- package/src/evaluator/matchers/gte.ts +1 -1
- package/src/evaluator/matchers/index.ts +1 -1
- package/src/evaluator/matchers/lte.ts +1 -1
- package/src/evaluator/matchers/part_of.ts +1 -1
- package/src/evaluator/matchers/segment.ts +1 -1
- package/src/evaluator/matchers/string.ts +1 -1
- package/src/evaluator/matchers/sw.ts +1 -1
- package/src/evaluator/matchers/whitelist.ts +1 -1
- package/src/evaluator/parser/index.ts +3 -3
- package/src/evaluator/types.ts +6 -6
- package/src/evaluator/value/index.ts +4 -4
- package/src/evaluator/value/sanitize.ts +4 -4
- package/src/integrations/ga/GaToSplit.ts +6 -6
- package/src/integrations/ga/SplitToGa.ts +10 -10
- package/src/integrations/ga/types.ts +4 -4
- package/src/integrations/pluggable.ts +3 -3
- package/src/integrations/types.ts +2 -2
- package/src/logger/index.ts +3 -3
- package/src/logger/sdkLogger.ts +1 -2
- package/src/logger/types.ts +0 -16
- package/src/readiness/sdkReadinessManager.ts +1 -1
- package/src/readiness/types.ts +2 -9
- package/src/sdkClient/client.ts +13 -13
- package/src/sdkClient/clientAttributesDecoration.ts +9 -9
- package/src/sdkClient/clientCS.ts +3 -4
- package/src/sdkClient/clientInputValidation.ts +15 -15
- package/src/sdkClient/sdkClient.ts +2 -2
- package/src/sdkClient/sdkClientMethod.ts +2 -2
- package/src/sdkClient/sdkClientMethodCS.ts +9 -9
- package/src/sdkClient/sdkClientMethodCSWithTT.ts +9 -9
- package/src/sdkFactory/index.ts +3 -2
- package/src/sdkFactory/types.ts +4 -4
- package/src/sdkManager/index.ts +5 -5
- package/src/services/splitApi.ts +1 -0
- package/src/storages/dataLoader.ts +2 -2
- package/src/storages/inLocalStorage/MySegmentsCacheInLocal.ts +1 -1
- package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +2 -2
- package/src/storages/inLocalStorage/index.ts +3 -2
- package/src/storages/inMemory/EventsCacheInMemory.ts +4 -4
- package/src/storages/inRedis/EventsCacheInRedis.ts +4 -4
- package/src/storages/inRedis/ImpressionsCacheInRedis.ts +1 -1
- package/src/storages/inRedis/RedisAdapter.ts +1 -1
- package/src/storages/inRedis/SegmentsCacheInRedis.ts +1 -1
- package/src/storages/inRedis/SplitsCacheInRedis.ts +1 -1
- package/src/storages/inRedis/TelemetryCacheInRedis.ts +1 -1
- package/src/storages/inRedis/index.ts +3 -2
- package/src/storages/pluggable/EventsCachePluggable.ts +4 -4
- package/src/storages/pluggable/ImpressionsCachePluggable.ts +1 -1
- package/src/storages/pluggable/SegmentsCachePluggable.ts +1 -1
- package/src/storages/pluggable/SplitsCachePluggable.ts +1 -1
- package/src/storages/pluggable/TelemetryCachePluggable.ts +1 -1
- package/src/storages/pluggable/index.ts +3 -3
- package/src/storages/pluggable/wrapperAdapter.ts +1 -1
- package/src/storages/types.ts +42 -18
- package/src/sync/offline/LocalhostFromObject.ts +4 -4
- package/src/sync/offline/splitsParser/splitsParserFromSettings.ts +8 -8
- package/src/sync/polling/updaters/mySegmentsUpdater.ts +1 -1
- package/src/sync/polling/updaters/segmentChangesUpdater.ts +1 -1
- package/src/sync/polling/updaters/splitChangesUpdater.ts +1 -1
- package/src/sync/streaming/SSEHandler/index.ts +1 -1
- package/src/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.ts +1 -1
- package/src/sync/streaming/UpdateWorkers/SplitsUpdateWorker.ts +1 -1
- package/src/sync/submitters/submitter.ts +1 -1
- package/src/sync/submitters/types.ts +2 -2
- package/src/sync/syncTask.ts +1 -1
- package/src/trackers/eventTracker.ts +3 -3
- package/src/trackers/impressionsTracker.ts +3 -3
- package/src/trackers/types.ts +4 -4
- package/src/{splitio.d.ts → types.d.ts} +826 -782
- package/src/utils/constants/index.ts +1 -1
- package/src/utils/inputValidation/apiKey.ts +1 -1
- package/src/utils/inputValidation/attribute.ts +1 -1
- package/src/utils/inputValidation/attributes.ts +3 -3
- package/src/utils/inputValidation/event.ts +1 -1
- package/src/utils/inputValidation/eventProperties.ts +3 -3
- package/src/utils/inputValidation/eventValue.ts +1 -1
- package/src/utils/inputValidation/isOperational.ts +1 -1
- package/src/utils/inputValidation/key.ts +3 -3
- package/src/utils/inputValidation/preloadedData.ts +3 -3
- package/src/utils/inputValidation/split.ts +1 -1
- package/src/utils/inputValidation/splitExistance.ts +1 -1
- package/src/utils/inputValidation/splits.ts +1 -1
- package/src/utils/inputValidation/trafficType.ts +1 -1
- package/src/utils/inputValidation/trafficTypeExistance.ts +1 -1
- package/src/utils/key/index.ts +9 -9
- package/src/utils/settingsValidation/consent.ts +1 -2
- package/src/utils/settingsValidation/impressionsMode.ts +3 -3
- package/src/utils/settingsValidation/index.ts +1 -0
- package/src/utils/settingsValidation/integrations/common.ts +1 -1
- package/src/utils/settingsValidation/integrations/configurable.ts +1 -1
- package/src/utils/settingsValidation/integrations/pluggable.ts +1 -2
- package/src/utils/settingsValidation/localhost/builtin.ts +1 -2
- package/src/utils/settingsValidation/localhost/pluggable.ts +1 -2
- package/src/utils/settingsValidation/logger/builtinLogger.ts +1 -2
- package/src/utils/settingsValidation/logger/pluggableLogger.ts +1 -2
- package/src/utils/settingsValidation/splitFilters.ts +7 -9
- package/src/utils/settingsValidation/storage/storageCS.ts +1 -2
- package/types/consent/sdkUserConsent.d.ts +2 -9
- package/types/dtos/types.d.ts +0 -6
- package/types/evaluator/Engine.d.ts +3 -3
- package/types/evaluator/combiners/and.d.ts +1 -1
- package/types/evaluator/combiners/ifelseif.d.ts +1 -1
- package/types/evaluator/condition/engineUtils.d.ts +1 -1
- package/types/evaluator/condition/index.d.ts +1 -1
- package/types/evaluator/index.d.ts +4 -4
- package/types/evaluator/matchers/all.d.ts +1 -1
- package/types/evaluator/matchers/between.d.ts +1 -1
- package/types/evaluator/matchers/boolean.d.ts +1 -1
- package/types/evaluator/matchers/cont_all.d.ts +1 -1
- package/types/evaluator/matchers/cont_any.d.ts +1 -1
- package/types/evaluator/matchers/cont_str.d.ts +1 -1
- package/types/evaluator/matchers/dependency.d.ts +1 -1
- package/types/evaluator/matchers/eq.d.ts +1 -1
- package/types/evaluator/matchers/eq_set.d.ts +1 -1
- package/types/evaluator/matchers/ew.d.ts +1 -1
- package/types/evaluator/matchers/gte.d.ts +1 -1
- package/types/evaluator/matchers/index.d.ts +1 -1
- package/types/evaluator/matchers/lte.d.ts +1 -1
- package/types/evaluator/matchers/part_of.d.ts +1 -1
- package/types/evaluator/matchers/segment.d.ts +1 -1
- package/types/evaluator/matchers/string.d.ts +1 -1
- package/types/evaluator/matchers/sw.d.ts +1 -1
- package/types/evaluator/matchers/whitelist.d.ts +1 -1
- package/types/evaluator/parser/index.d.ts +1 -1
- package/types/evaluator/types.d.ts +6 -6
- package/types/evaluator/value/index.d.ts +3 -3
- package/types/evaluator/value/sanitize.d.ts +3 -3
- package/types/integrations/ga/GaToSplit.d.ts +4 -4
- package/types/integrations/ga/SplitToGa.d.ts +4 -4
- package/types/integrations/ga/types.d.ts +4 -4
- package/types/integrations/types.d.ts +2 -2
- package/types/logger/browser/{debugLogger.d.ts → DebugLogger.d.ts} +0 -0
- package/types/logger/browser/{errorLogger.d.ts → ErrorLogger.d.ts} +0 -0
- package/types/logger/browser/{infoLogger.d.ts → InfoLogger.d.ts} +0 -0
- package/types/logger/browser/{warnLogger.d.ts → WarnLogger.d.ts} +0 -0
- package/types/logger/index.d.ts +3 -5
- package/types/logger/sdkLogger.d.ts +1 -2
- package/types/logger/types.d.ts +0 -11
- package/types/readiness/sdkReadinessManager.d.ts +1 -1
- package/types/readiness/types.d.ts +2 -8
- package/types/sdkClient/client.d.ts +2 -2
- package/types/sdkClient/clientAttributesDecoration.d.ts +8 -8
- package/types/sdkClient/clientCS.d.ts +2 -3
- package/types/sdkClient/clientInputValidation.d.ts +2 -2
- package/types/sdkClient/sdkClient.d.ts +2 -2
- package/types/sdkClient/sdkClientMethod.d.ts +2 -2
- package/types/sdkClient/sdkClientMethodCS.d.ts +2 -2
- package/types/sdkClient/sdkClientMethodCSWithTT.d.ts +2 -2
- package/types/sdkFactory/index.d.ts +2 -2
- package/types/sdkFactory/types.d.ts +6 -6
- package/types/sdkManager/index.d.ts +3 -3
- package/types/storages/dataLoader.d.ts +2 -2
- package/types/storages/inLocalStorage/MySegmentsCacheInLocal.d.ts +1 -1
- package/types/storages/inLocalStorage/SplitsCacheInLocal.d.ts +1 -2
- package/types/storages/inLocalStorage/index.d.ts +2 -2
- package/types/storages/inMemory/EventsCacheInMemory.d.ts +3 -3
- package/types/storages/inMemory/InMemoryStorage.d.ts +1 -1
- package/types/storages/inMemory/InMemoryStorageCS.d.ts +1 -1
- package/types/storages/inRedis/EventsCacheInRedis.d.ts +3 -3
- package/types/storages/inRedis/ImpressionsCacheInRedis.d.ts +1 -1
- package/types/storages/inRedis/RedisAdapter.d.ts +1 -1
- package/types/storages/inRedis/SegmentsCacheInRedis.d.ts +1 -1
- package/types/storages/inRedis/SplitsCacheInRedis.d.ts +1 -1
- package/types/storages/inRedis/TelemetryCacheInRedis.d.ts +1 -1
- package/types/storages/inRedis/index.d.ts +2 -2
- package/types/storages/pluggable/EventsCachePluggable.d.ts +3 -3
- package/types/storages/pluggable/ImpressionsCachePluggable.d.ts +1 -1
- package/types/storages/pluggable/SegmentsCachePluggable.d.ts +1 -1
- package/types/storages/pluggable/SplitsCachePluggable.d.ts +1 -1
- package/types/storages/pluggable/TelemetryCachePluggable.d.ts +1 -1
- package/types/storages/pluggable/index.d.ts +3 -2
- package/types/storages/pluggable/wrapperAdapter.d.ts +1 -1
- package/types/storages/types.d.ts +42 -16
- package/types/sync/offline/LocalhostFromObject.d.ts +2 -2
- package/types/sync/polling/updaters/mySegmentsUpdater.d.ts +1 -1
- package/types/sync/polling/updaters/segmentChangesUpdater.d.ts +1 -1
- package/types/sync/polling/updaters/splitChangesUpdater.d.ts +1 -1
- package/types/sync/streaming/SSEHandler/index.d.ts +1 -1
- package/types/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.d.ts +1 -1
- package/types/sync/streaming/UpdateWorkers/SplitsUpdateWorker.d.ts +1 -1
- package/types/sync/submitters/submitter.d.ts +1 -1
- package/types/sync/submitters/types.d.ts +2 -2
- package/types/sync/syncTask.d.ts +1 -1
- package/types/trackers/types.d.ts +4 -4
- package/types/utils/constants/index.d.ts +1 -1
- package/types/utils/inputValidation/apiKey.d.ts +1 -1
- package/types/utils/inputValidation/attribute.d.ts +1 -1
- package/types/utils/inputValidation/attributes.d.ts +3 -3
- package/types/utils/inputValidation/event.d.ts +1 -1
- package/types/utils/inputValidation/eventProperties.d.ts +3 -3
- package/types/utils/inputValidation/eventValue.d.ts +1 -1
- package/types/utils/inputValidation/isOperational.d.ts +1 -1
- package/types/utils/inputValidation/key.d.ts +3 -3
- package/types/utils/inputValidation/preloadedData.d.ts +3 -3
- package/types/utils/inputValidation/split.d.ts +1 -1
- package/types/utils/inputValidation/splitExistance.d.ts +1 -1
- package/types/utils/inputValidation/splits.d.ts +1 -1
- package/types/utils/inputValidation/trafficType.d.ts +1 -1
- package/types/utils/inputValidation/trafficTypeExistance.d.ts +1 -1
- package/types/utils/key/index.d.ts +4 -4
- package/types/utils/settingsValidation/consent.d.ts +1 -2
- package/types/utils/settingsValidation/impressionsMode.d.ts +3 -3
- package/types/utils/settingsValidation/integrations/common.d.ts +1 -1
- package/types/utils/settingsValidation/integrations/configurable.d.ts +1 -1
- package/types/utils/settingsValidation/integrations/pluggable.d.ts +1 -2
- package/types/utils/settingsValidation/localhost/builtin.d.ts +1 -2
- package/types/utils/settingsValidation/localhost/pluggable.d.ts +1 -2
- package/types/utils/settingsValidation/logger/builtinLogger.d.ts +1 -1
- package/types/utils/settingsValidation/logger/pluggableLogger.d.ts +1 -1
- package/types/utils/settingsValidation/splitFilters.d.ts +1 -2
- package/types/utils/settingsValidation/storage/storageCS.d.ts +2 -3
- package/cjs/types.js +0 -2
- package/esm/types.js +0 -1
- package/src/types.ts +0 -1263
- package/types/integrations/ga/GaToSplitPlugin.d.ts +0 -3
- package/types/integrations/ga/SplitToGaPlugin.d.ts +0 -4
- package/types/integrations/ga/autoRequire.d.ts +0 -4
- package/types/logger/codes.d.ts +0 -2
- package/types/logger/codesConstants.d.ts +0 -117
- package/types/logger/codesConstantsBrowser.d.ts +0 -2
- package/types/logger/codesConstantsNode.d.ts +0 -14
- package/types/logger/codesDebug.d.ts +0 -1
- package/types/logger/codesDebugBrowser.d.ts +0 -1
- package/types/logger/codesDebugNode.d.ts +0 -1
- package/types/logger/codesError.d.ts +0 -1
- package/types/logger/codesErrorNode.d.ts +0 -1
- package/types/logger/codesInfo.d.ts +0 -1
- package/types/logger/codesWarn.d.ts +0 -1
- package/types/logger/codesWarnNode.d.ts +0 -1
- package/types/logger/debugLogger.d.ts +0 -2
- package/types/logger/errorLogger.d.ts +0 -2
- package/types/logger/infoLogger.d.ts +0 -2
- package/types/logger/messages/debugBrowser.d.ts +0 -1
- package/types/logger/messages/debugNode.d.ts +0 -1
- package/types/logger/messages/errorNode.d.ts +0 -1
- package/types/logger/messages/warnNode.d.ts +0 -1
- package/types/logger/noopLogger.d.ts +0 -2
- package/types/logger/warnLogger.d.ts +0 -2
- package/types/sdkClient/types.d.ts +0 -18
- package/types/sdkFactory/userConsentProps.d.ts +0 -6
- package/types/sdkManager/sdkManagerMethod.d.ts +0 -6
- package/types/storages/getRegisteredSegments.d.ts +0 -10
- package/types/storages/inMemory/CountsCacheInMemory.d.ts +0 -20
- package/types/storages/inMemory/LatenciesCacheInMemory.d.ts +0 -20
- package/types/storages/inMemory/index.d.ts +0 -10
- package/types/storages/inRedis/CountsCacheInRedis.d.ts +0 -9
- package/types/storages/inRedis/LatenciesCacheInRedis.d.ts +0 -9
- package/types/storages/parseSegments.d.ts +0 -6
- package/types/sync/offline/LocalhostFromFile.d.ts +0 -2
- package/types/sync/offline/splitsParser/splitsParserFromFile.d.ts +0 -2
- package/types/sync/polling/syncTasks/splitsSyncTask.copy.d.ts +0 -35
- package/types/sync/polling/syncTasks/splitsSyncTask.morelikeoriginal.d.ts +0 -35
- package/types/sync/streaming/AuthClient/indexV1.d.ts +0 -12
- package/types/sync/streaming/AuthClient/indexV2.d.ts +0 -8
- package/types/sync/streaming/pushManagerCS.d.ts +0 -1
- package/types/sync/streaming/pushManagerNoUsers.d.ts +0 -13
- package/types/sync/streaming/pushManagerSS.d.ts +0 -1
- package/types/sync/submitters/eventsSyncTask.d.ts +0 -8
- package/types/sync/submitters/impressionCountsSyncTask.d.ts +0 -13
- package/types/sync/submitters/impressionsSyncTask.d.ts +0 -14
- package/types/sync/submitters/metricsSyncTask.d.ts +0 -12
- package/types/sync/submitters/submitterSyncTask.d.ts +0 -10
- package/types/sync/submitters/telemetrySyncTask.d.ts +0 -0
- package/types/sync/submitters/uniqueKeysSubmitter.d.ts +0 -13
- package/types/sync/syncManagerFromFile.d.ts +0 -2
- package/types/sync/syncManagerFromObject.d.ts +0 -2
- package/types/sync/syncManagerOffline.d.ts +0 -9
- package/types/sync/syncTaskComposite.d.ts +0 -5
- package/types/trackers/strategy/strategyDebug.d.ts +0 -9
- package/types/trackers/strategy/strategyNone.d.ts +0 -10
- package/types/trackers/strategy/strategyOptimized.d.ts +0 -11
- package/types/trackers/telemetryRecorder.d.ts +0 -0
- package/types/trackers/uniqueKeysTracker.d.ts +0 -13
- package/types/types.d.ts +0 -1261
- package/types/utils/EventEmitter.d.ts +0 -4
- package/types/utils/consent.d.ts +0 -2
- package/types/utils/lang/errors.d.ts +0 -10
- package/types/utils/murmur3/commons.d.ts +0 -12
- package/types/utils/settingsValidation/buildMetadata.d.ts +0 -3
- package/types/utils/settingsValidation/localhost/index.d.ts +0 -9
- package/types/utils/settingsValidation/logger.d.ts +0 -11
- package/types/utils/settingsValidation/runtime/browser.d.ts +0 -2
- package/types/utils/settingsValidation/runtime/node.d.ts +0 -2
- package/types/utils/settingsValidation/userConsent.d.ts +0 -5
- package/types/utils/timeTracker/index.d.ts +0 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
/* eslint-disable no-undef */
|
|
2
2
|
import { uniq } from '../../utils/lang';
|
|
3
3
|
import { SPLIT_IMPRESSION, SPLIT_EVENT } from '../../utils/constants';
|
|
4
|
-
import {
|
|
4
|
+
import { IntegrationData, ImpressionData, EventData } from '../../types';
|
|
5
5
|
import { IIntegration } from '../types';
|
|
6
6
|
import { SplitToGoogleAnalyticsOptions } from './types';
|
|
7
|
-
import { ILogger } from '../../
|
|
7
|
+
import { ILogger } from '../../types';
|
|
8
8
|
|
|
9
9
|
const logPrefix = 'split-to-ga: ';
|
|
10
10
|
const noGaWarning = '`ga` command queue not found.';
|
|
@@ -16,29 +16,29 @@ export class SplitToGa implements IIntegration {
|
|
|
16
16
|
static defaultTrackerNames = [''];
|
|
17
17
|
|
|
18
18
|
private trackerNames: string[];
|
|
19
|
-
private filter?: (data:
|
|
20
|
-
private mapper?: (data:
|
|
19
|
+
private filter?: (data: IntegrationData) => boolean;
|
|
20
|
+
private mapper?: (data: IntegrationData, defaultMapping: UniversalAnalytics.FieldsObject) => UniversalAnalytics.FieldsObject;
|
|
21
21
|
private impressions: boolean | undefined;
|
|
22
22
|
private events: boolean | undefined;
|
|
23
23
|
private log: ILogger;
|
|
24
24
|
|
|
25
25
|
// Default mapper function.
|
|
26
|
-
static defaultMapper({ type, payload }:
|
|
26
|
+
static defaultMapper({ type, payload }: IntegrationData): UniversalAnalytics.FieldsObject {
|
|
27
27
|
switch (type) {
|
|
28
28
|
case SPLIT_IMPRESSION:
|
|
29
29
|
return {
|
|
30
30
|
hitType: 'event',
|
|
31
31
|
eventCategory: 'split-impression',
|
|
32
|
-
eventAction: 'Evaluate ' + (payload as
|
|
33
|
-
eventLabel: 'Treatment: ' + (payload as
|
|
32
|
+
eventAction: 'Evaluate ' + (payload as ImpressionData).impression.feature,
|
|
33
|
+
eventLabel: 'Treatment: ' + (payload as ImpressionData).impression.treatment + '. Targeting rule: ' + (payload as ImpressionData).impression.label + '.',
|
|
34
34
|
nonInteraction: true,
|
|
35
35
|
};
|
|
36
36
|
case SPLIT_EVENT:
|
|
37
37
|
return {
|
|
38
38
|
hitType: 'event',
|
|
39
39
|
eventCategory: 'split-event',
|
|
40
|
-
eventAction: (payload as
|
|
41
|
-
eventValue: (payload as
|
|
40
|
+
eventAction: (payload as EventData).eventTypeId,
|
|
41
|
+
eventValue: (payload as EventData).value,
|
|
42
42
|
nonInteraction: true,
|
|
43
43
|
};
|
|
44
44
|
}
|
|
@@ -93,7 +93,7 @@ export class SplitToGa implements IIntegration {
|
|
|
93
93
|
if (typeof SplitToGa.getGa() !== 'function') log.warn(logPrefix + `${noGaWarning} No hits will be sent until it is available.`);
|
|
94
94
|
}
|
|
95
95
|
|
|
96
|
-
queue(data:
|
|
96
|
+
queue(data: IntegrationData) {
|
|
97
97
|
// access ga command queue via `getGa` method, accounting for the possibility that
|
|
98
98
|
// the global `ga` reference was not yet mutated by analytics.js.
|
|
99
99
|
const ga = SplitToGa.getGa();
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { IntegrationData, EventData } from '../../types';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* A pair of user key and it's trafficType, required for tracking valid Split events.
|
|
@@ -41,7 +41,7 @@ export interface GoogleAnalyticsToSplitOptions {
|
|
|
41
41
|
* return defaultMapping;
|
|
42
42
|
* }`
|
|
43
43
|
*/
|
|
44
|
-
mapper?: (model: UniversalAnalytics.Model, defaultMapping:
|
|
44
|
+
mapper?: (model: UniversalAnalytics.Model, defaultMapping: EventData) => EventData,
|
|
45
45
|
/**
|
|
46
46
|
* Optional prefix for EventTypeId, to prevent any kind of data collision between events.
|
|
47
47
|
* @property {string} prefix
|
|
@@ -97,7 +97,7 @@ export interface SplitToGoogleAnalyticsOptions {
|
|
|
97
97
|
* For example, the following filter allows to track only impressions, equivalent to setting events to false:
|
|
98
98
|
* `(data) => data.type === 'IMPRESSION'`
|
|
99
99
|
*/
|
|
100
|
-
filter?: (data:
|
|
100
|
+
filter?: (data: IntegrationData) => boolean,
|
|
101
101
|
/**
|
|
102
102
|
* Optional function useful when you need to modify the GA hit before sending it.
|
|
103
103
|
* This function is invoked with two arguments:
|
|
@@ -128,7 +128,7 @@ export interface SplitToGoogleAnalyticsOptions {
|
|
|
128
128
|
* nonInteraction: true,
|
|
129
129
|
* }`
|
|
130
130
|
*/
|
|
131
|
-
mapper?: (data:
|
|
131
|
+
mapper?: (data: IntegrationData, defaultMapping: UniversalAnalytics.FieldsObject) => UniversalAnalytics.FieldsObject,
|
|
132
132
|
/**
|
|
133
133
|
* List of tracker names to send the hit. An empty string represents the default tracker.
|
|
134
134
|
* If not provided, hits are only sent to default tracker.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { SPLIT_IMPRESSION, SPLIT_EVENT } from '../utils/constants';
|
|
2
|
-
import {
|
|
2
|
+
import { ImpressionData, EventData } from '../types';
|
|
3
3
|
import { IIntegration, IIntegrationManager, IIntegrationFactoryParams } from './types';
|
|
4
4
|
|
|
5
5
|
/**
|
|
@@ -29,10 +29,10 @@ export function pluggableIntegrationsManagerFactory(
|
|
|
29
29
|
|
|
30
30
|
// Exception safe methods: each integration module is responsable for handling errors
|
|
31
31
|
return {
|
|
32
|
-
handleImpression(impressionData:
|
|
32
|
+
handleImpression(impressionData: ImpressionData) {
|
|
33
33
|
listeners.forEach(listener => listener.queue({ type: SPLIT_IMPRESSION, payload: impressionData }));
|
|
34
34
|
},
|
|
35
|
-
handleEvent(eventData:
|
|
35
|
+
handleEvent(eventData: EventData) {
|
|
36
36
|
listeners.forEach(listener => listener.queue({ type: SPLIT_EVENT, payload: eventData }));
|
|
37
37
|
}
|
|
38
38
|
};
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { IEventsCacheBase } from '../storages/types';
|
|
2
2
|
import { IEventsHandler, IImpressionsHandler } from '../trackers/types';
|
|
3
|
-
import { ISettings,
|
|
3
|
+
import { ISettings, IntegrationData } from '../types';
|
|
4
4
|
|
|
5
5
|
export interface IIntegration {
|
|
6
|
-
queue(data:
|
|
6
|
+
queue(data: IntegrationData): void
|
|
7
7
|
}
|
|
8
8
|
|
|
9
9
|
export type IIntegrationManager = IEventsHandler & IImpressionsHandler;
|
package/src/logger/index.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { objectAssign } from '../utils/lang/objectAssign';
|
|
2
|
-
import { ILoggerOptions
|
|
2
|
+
import { ILoggerOptions } from './types';
|
|
3
3
|
import { find } from '../utils/lang';
|
|
4
|
-
import { LogLevel } from '../types';
|
|
4
|
+
import { LogLevel, ILogger, ILoggerAPI } from '../types';
|
|
5
5
|
import { IMap, _Map } from '../utils/lang/maps';
|
|
6
6
|
|
|
7
|
-
export const LogLevels:
|
|
7
|
+
export const LogLevels: ILoggerAPI['LogLevel'] = {
|
|
8
8
|
DEBUG: 'DEBUG',
|
|
9
9
|
INFO: 'INFO',
|
|
10
10
|
WARN: 'WARN',
|
package/src/logger/sdkLogger.ts
CHANGED
package/src/logger/types.ts
CHANGED
|
@@ -5,19 +5,3 @@ export interface ILoggerOptions {
|
|
|
5
5
|
logLevel?: LogLevel,
|
|
6
6
|
showLevel?: boolean, // @TODO remove this param eventually since it is not being set `false` anymore
|
|
7
7
|
}
|
|
8
|
-
|
|
9
|
-
export interface ILogger {
|
|
10
|
-
setLogLevel(logLevel: LogLevel): void
|
|
11
|
-
|
|
12
|
-
debug(msg: any): void
|
|
13
|
-
debug(msg: string | number, args?: any[]): void
|
|
14
|
-
|
|
15
|
-
info(msg: any): void
|
|
16
|
-
info(msg: string | number, args?: any[]): void
|
|
17
|
-
|
|
18
|
-
warn(msg: any): void
|
|
19
|
-
warn(msg: string | number, args?: any[]): void
|
|
20
|
-
|
|
21
|
-
error(msg: any): void
|
|
22
|
-
error(msg: string | number, args?: any[]): void
|
|
23
|
-
}
|
|
@@ -4,7 +4,7 @@ import { readinessManagerFactory } from './readinessManager';
|
|
|
4
4
|
import { ISdkReadinessManager } from './types';
|
|
5
5
|
import { IEventEmitter } from '../types';
|
|
6
6
|
import { SDK_READY, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE } from './constants';
|
|
7
|
-
import { ILogger } from '../
|
|
7
|
+
import { ILogger } from '../types';
|
|
8
8
|
import { ERROR_CLIENT_LISTENER, CLIENT_READY_FROM_CACHE, CLIENT_READY, CLIENT_NO_LISTENER } from '../logger/constants';
|
|
9
9
|
|
|
10
10
|
const NEW_LISTENER_EVENT = 'newListener';
|
package/src/readiness/types.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IEventEmitter, IStatusInterface } from '../types';
|
|
1
|
+
import { IEventEmitter, IStatusInterface, Event } from '../types';
|
|
2
2
|
|
|
3
3
|
/** Splits data emitter */
|
|
4
4
|
|
|
@@ -28,15 +28,8 @@ export interface ISegmentsEventEmitter extends IEventEmitter {
|
|
|
28
28
|
|
|
29
29
|
/** Readiness emitter */
|
|
30
30
|
|
|
31
|
-
export type SDK_READY_TIMED_OUT = 'init::timeout'
|
|
32
|
-
export type SDK_READY = 'init::ready'
|
|
33
|
-
export type SDK_READY_FROM_CACHE = 'init::cache-ready'
|
|
34
|
-
export type SDK_UPDATE = 'state::update'
|
|
35
|
-
export type SDK_DESTROY = 'state::destroy'
|
|
36
|
-
export type IReadinessEvent = SDK_READY_TIMED_OUT | SDK_READY | SDK_READY_FROM_CACHE | SDK_UPDATE | SDK_DESTROY
|
|
37
|
-
|
|
38
31
|
export interface IReadinessEventEmitter extends IEventEmitter {
|
|
39
|
-
emit(event:
|
|
32
|
+
emit(event: Event, ...args: any[]): boolean
|
|
40
33
|
}
|
|
41
34
|
|
|
42
35
|
/** Readiness manager */
|
package/src/sdkClient/client.ts
CHANGED
|
@@ -6,18 +6,18 @@ import { validateTrafficTypeExistance } from '../utils/inputValidation/trafficTy
|
|
|
6
6
|
import { SDK_NOT_READY } from '../utils/labels';
|
|
7
7
|
import { CONTROL, TREATMENT, TREATMENTS, TREATMENT_WITH_CONFIG, TREATMENTS_WITH_CONFIG, TRACK } from '../utils/constants';
|
|
8
8
|
import { IEvaluationResult } from '../evaluator/types';
|
|
9
|
-
import {
|
|
9
|
+
import { SplitKey, Attributes,ImpressionDTO, Treatment, TreatmentWithConfig, Properties, EventData, IClientSS, IAsyncClientSS } from '../types';
|
|
10
10
|
import { IMPRESSION, IMPRESSION_QUEUEING } from '../logger/constants';
|
|
11
11
|
import { ISdkFactoryContext } from '../sdkFactory/types';
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
14
|
* Creator of base client with getTreatments and track methods.
|
|
15
15
|
*/
|
|
16
|
-
export function clientFactory(params: ISdkFactoryContext):
|
|
16
|
+
export function clientFactory(params: ISdkFactoryContext): IClientSS | IAsyncClientSS {
|
|
17
17
|
const { sdkReadinessManager: { readinessManager }, storage, settings, impressionsTracker, eventTracker, telemetryTracker } = params;
|
|
18
18
|
const { log, mode } = settings;
|
|
19
19
|
|
|
20
|
-
function getTreatment(key:
|
|
20
|
+
function getTreatment(key: SplitKey, splitName: string, attributes: Attributes | undefined, withConfig = false) {
|
|
21
21
|
const stopTelemetryTracker = telemetryTracker.trackEval(withConfig ? TREATMENT_WITH_CONFIG : TREATMENT);
|
|
22
22
|
|
|
23
23
|
const wrapUp = (evaluationResult: IEvaluationResult) => {
|
|
@@ -34,16 +34,16 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
|
|
|
34
34
|
return thenable(evaluation) ? evaluation.then((res) => wrapUp(res)) : wrapUp(evaluation);
|
|
35
35
|
}
|
|
36
36
|
|
|
37
|
-
function getTreatmentWithConfig(key:
|
|
37
|
+
function getTreatmentWithConfig(key: SplitKey, splitName: string, attributes: Attributes | undefined) {
|
|
38
38
|
return getTreatment(key, splitName, attributes, true);
|
|
39
39
|
}
|
|
40
40
|
|
|
41
|
-
function getTreatments(key:
|
|
41
|
+
function getTreatments(key: SplitKey, splitNames: string[], attributes: Attributes | undefined, withConfig = false) {
|
|
42
42
|
const stopTelemetryTracker = telemetryTracker.trackEval(withConfig ? TREATMENTS_WITH_CONFIG : TREATMENTS);
|
|
43
43
|
|
|
44
44
|
const wrapUp = (evaluationResults: Record<string, IEvaluationResult>) => {
|
|
45
45
|
const queue: ImpressionDTO[] = [];
|
|
46
|
-
const treatments: Record<string,
|
|
46
|
+
const treatments: Record<string, Treatment | TreatmentWithConfig> = {};
|
|
47
47
|
Object.keys(evaluationResults).forEach(splitName => {
|
|
48
48
|
treatments[splitName] = processEvaluation(evaluationResults[splitName], splitName, key, attributes, withConfig, `getTreatments${withConfig ? 'withConfig' : ''}`, queue);
|
|
49
49
|
});
|
|
@@ -58,7 +58,7 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
|
|
|
58
58
|
return thenable(evaluations) ? evaluations.then((res) => wrapUp(res)) : wrapUp(evaluations);
|
|
59
59
|
}
|
|
60
60
|
|
|
61
|
-
function getTreatmentsWithConfig(key:
|
|
61
|
+
function getTreatmentsWithConfig(key: SplitKey, splitNames: string[], attributes: Attributes | undefined) {
|
|
62
62
|
return getTreatments(key, splitNames, attributes, true);
|
|
63
63
|
}
|
|
64
64
|
|
|
@@ -66,12 +66,12 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
|
|
|
66
66
|
function processEvaluation(
|
|
67
67
|
evaluation: IEvaluationResult,
|
|
68
68
|
splitName: string,
|
|
69
|
-
key:
|
|
70
|
-
attributes:
|
|
69
|
+
key: SplitKey,
|
|
70
|
+
attributes: Attributes | undefined,
|
|
71
71
|
withConfig: boolean,
|
|
72
72
|
invokingMethodName: string,
|
|
73
73
|
queue: ImpressionDTO[]
|
|
74
|
-
):
|
|
74
|
+
): Treatment | TreatmentWithConfig {
|
|
75
75
|
const isSdkReady = readinessManager.isReady() || readinessManager.isReadyFromCache();
|
|
76
76
|
const matchingKey = getMatching(key);
|
|
77
77
|
const bucketingKey = getBucketing(key);
|
|
@@ -107,12 +107,12 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
|
|
|
107
107
|
return treatment;
|
|
108
108
|
}
|
|
109
109
|
|
|
110
|
-
function track(key:
|
|
110
|
+
function track(key: SplitKey, trafficTypeName: string, eventTypeId: string, value?: number, properties?: Properties, size = 1024) {
|
|
111
111
|
const stopTelemetryTracker = telemetryTracker.trackEval(TRACK);
|
|
112
112
|
|
|
113
113
|
const matchingKey = getMatching(key);
|
|
114
114
|
const timestamp = Date.now();
|
|
115
|
-
const eventData:
|
|
115
|
+
const eventData: EventData = {
|
|
116
116
|
eventTypeId,
|
|
117
117
|
trafficTypeName,
|
|
118
118
|
value,
|
|
@@ -144,5 +144,5 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
|
|
|
144
144
|
getTreatmentsWithConfig,
|
|
145
145
|
track,
|
|
146
146
|
isClientSide: false
|
|
147
|
-
} as
|
|
147
|
+
} as any;
|
|
148
148
|
}
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import { AttributesCacheInMemory } from '../storages/inMemory/AttributesCacheInMemory';
|
|
2
2
|
import { validateAttributesDeep } from '../utils/inputValidation/attributes';
|
|
3
|
-
import {
|
|
4
|
-
import { ILogger } from '../
|
|
3
|
+
import { Attributes, IAsyncClientSS, IClientSS, Properties, SplitKey } from '../types';
|
|
4
|
+
import { ILogger } from '../types';
|
|
5
5
|
import { objectAssign } from '../utils/lang/objectAssign';
|
|
6
6
|
|
|
7
7
|
/**
|
|
8
8
|
* Add in memory attributes storage methods and combine them with any attribute received from the getTreatment/s call
|
|
9
9
|
*/
|
|
10
|
-
export function clientAttributesDecoration
|
|
10
|
+
export function clientAttributesDecoration(log: ILogger, client: IClientSS | IAsyncClientSS) {
|
|
11
11
|
|
|
12
12
|
const attributeStorage = new AttributesCacheInMemory();
|
|
13
13
|
|
|
@@ -18,27 +18,27 @@ export function clientAttributesDecoration<TClient extends SplitIO.IClient | Spl
|
|
|
18
18
|
const clientGetTreatmentsWithConfig = client.getTreatmentsWithConfig;
|
|
19
19
|
const clientTrack = client.track;
|
|
20
20
|
|
|
21
|
-
function getTreatment(maybeKey:
|
|
21
|
+
function getTreatment(maybeKey: SplitKey, maybeSplit: string, maybeAttributes?: Attributes) {
|
|
22
22
|
return clientGetTreatment(maybeKey, maybeSplit, combineAttributes(maybeAttributes));
|
|
23
23
|
}
|
|
24
24
|
|
|
25
|
-
function getTreatmentWithConfig(maybeKey:
|
|
25
|
+
function getTreatmentWithConfig(maybeKey: SplitKey, maybeSplit: string, maybeAttributes?: Attributes) {
|
|
26
26
|
return clientGetTreatmentWithConfig(maybeKey, maybeSplit, combineAttributes(maybeAttributes));
|
|
27
27
|
}
|
|
28
28
|
|
|
29
|
-
function getTreatments(maybeKey:
|
|
29
|
+
function getTreatments(maybeKey: SplitKey, maybeSplits: string[], maybeAttributes?: Attributes) {
|
|
30
30
|
return clientGetTreatments(maybeKey, maybeSplits, combineAttributes(maybeAttributes));
|
|
31
31
|
}
|
|
32
32
|
|
|
33
|
-
function getTreatmentsWithConfig(maybeKey:
|
|
33
|
+
function getTreatmentsWithConfig(maybeKey: SplitKey, maybeSplits: string[], maybeAttributes?: Attributes) {
|
|
34
34
|
return clientGetTreatmentsWithConfig(maybeKey, maybeSplits, combineAttributes(maybeAttributes));
|
|
35
35
|
}
|
|
36
36
|
|
|
37
|
-
function track(maybeKey:
|
|
37
|
+
function track(maybeKey: SplitKey, maybeTT: string, maybeEvent: string, maybeEventValue?: number, maybeProperties?: Properties) {
|
|
38
38
|
return clientTrack(maybeKey, maybeTT, maybeEvent, maybeEventValue, maybeProperties);
|
|
39
39
|
}
|
|
40
40
|
|
|
41
|
-
function combineAttributes(maybeAttributes:
|
|
41
|
+
function combineAttributes(maybeAttributes: Attributes | undefined): Attributes | undefined{
|
|
42
42
|
const storedAttributes = attributeStorage.getAll();
|
|
43
43
|
if (Object.keys(storedAttributes).length > 0) {
|
|
44
44
|
return objectAssign({}, storedAttributes, maybeAttributes);
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { objectAssign } from '../utils/lang/objectAssign';
|
|
2
|
-
import { ILogger } from '../
|
|
3
|
-
import { SplitIO } from '../types';
|
|
2
|
+
import { IClientSS, IClientWithKeyLegacy, ILogger, SplitKey } from '../types';
|
|
4
3
|
import { clientAttributesDecoration } from './clientAttributesDecoration';
|
|
5
4
|
|
|
6
5
|
|
|
@@ -11,7 +10,7 @@ import { clientAttributesDecoration } from './clientAttributesDecoration';
|
|
|
11
10
|
* @param key validated split key
|
|
12
11
|
* @param trafficType validated traffic type
|
|
13
12
|
*/
|
|
14
|
-
export function clientCSDecorator(log: ILogger, client:
|
|
13
|
+
export function clientCSDecorator(log: ILogger, client: IClientSS, key: SplitKey, trafficType?: string): IClientWithKeyLegacy {
|
|
15
14
|
|
|
16
15
|
let clientCS = clientAttributesDecoration(log, client);
|
|
17
16
|
|
|
@@ -26,5 +25,5 @@ export function clientCSDecorator(log: ILogger, client: SplitIO.IClient, key: Sp
|
|
|
26
25
|
track: trafficType ? clientCS.track.bind(clientCS, key, trafficType) : clientCS.track.bind(clientCS, key),
|
|
27
26
|
|
|
28
27
|
isClientSide: true
|
|
29
|
-
}) as
|
|
28
|
+
}) as any;
|
|
30
29
|
}
|
|
@@ -15,14 +15,14 @@ import { startsWith } from '../utils/lang';
|
|
|
15
15
|
import { CONTROL, CONTROL_WITH_CONFIG } from '../utils/constants';
|
|
16
16
|
import { IReadinessManager } from '../readiness/types';
|
|
17
17
|
import { MaybeThenable } from '../dtos/types';
|
|
18
|
-
import { ISettings,
|
|
18
|
+
import { ISettings, SplitKey, Treatments, TreatmentsWithConfig, Properties, Attributes, IClientSS, IAsyncClientSS } from '../types';
|
|
19
19
|
import { isStorageSync } from '../trackers/impressionObserver/utils';
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
22
|
* Decorator that validates the input before actually executing the client methods.
|
|
23
23
|
* We should "guard" the client here, while not polluting the "real" implementation of those methods.
|
|
24
24
|
*/
|
|
25
|
-
export function clientInputValidationDecorator
|
|
25
|
+
export function clientInputValidationDecorator(settings: ISettings, client: IClientSS | IAsyncClientSS, readinessManager: IReadinessManager): IClientSS | IAsyncClientSS {
|
|
26
26
|
|
|
27
27
|
const log = settings.log;
|
|
28
28
|
const isSync = isStorageSync(settings);
|
|
@@ -30,7 +30,7 @@ export function clientInputValidationDecorator<TClient extends SplitIO.IClient |
|
|
|
30
30
|
/**
|
|
31
31
|
* Avoid repeating this validations code
|
|
32
32
|
*/
|
|
33
|
-
function validateEvaluationParams(maybeKey:
|
|
33
|
+
function validateEvaluationParams(maybeKey: SplitKey, maybeSplitOrSplits: string | string[], maybeAttributes: Attributes | undefined, methodName: string) {
|
|
34
34
|
const multi = startsWith(methodName, 'getTreatments');
|
|
35
35
|
const key = validateKey(log, maybeKey, methodName);
|
|
36
36
|
const splitOrSplits = multi ? validateSplits(log, maybeSplitOrSplits, methodName) : validateSplit(log, maybeSplitOrSplits, methodName);
|
|
@@ -53,53 +53,53 @@ export function clientInputValidationDecorator<TClient extends SplitIO.IClient |
|
|
|
53
53
|
return isSync ? value : Promise.resolve(value);
|
|
54
54
|
}
|
|
55
55
|
|
|
56
|
-
function getTreatment(maybeKey:
|
|
56
|
+
function getTreatment(maybeKey: SplitKey, maybeSplit: string, maybeAttributes?: Attributes) {
|
|
57
57
|
const params = validateEvaluationParams(maybeKey, maybeSplit, maybeAttributes, 'getTreatment');
|
|
58
58
|
|
|
59
59
|
if (params.valid) {
|
|
60
|
-
return client.getTreatment(params.key as
|
|
60
|
+
return client.getTreatment(params.key as SplitKey, params.splitOrSplits as string, params.attributes as Attributes | undefined);
|
|
61
61
|
} else {
|
|
62
62
|
return wrapResult(CONTROL);
|
|
63
63
|
}
|
|
64
64
|
}
|
|
65
65
|
|
|
66
|
-
function getTreatmentWithConfig(maybeKey:
|
|
66
|
+
function getTreatmentWithConfig(maybeKey: SplitKey, maybeSplit: string, maybeAttributes?: Attributes) {
|
|
67
67
|
const params = validateEvaluationParams(maybeKey, maybeSplit, maybeAttributes, 'getTreatmentWithConfig');
|
|
68
68
|
|
|
69
69
|
if (params.valid) {
|
|
70
|
-
return client.getTreatmentWithConfig(params.key as
|
|
70
|
+
return client.getTreatmentWithConfig(params.key as SplitKey, params.splitOrSplits as string, params.attributes as Attributes | undefined);
|
|
71
71
|
} else {
|
|
72
72
|
return wrapResult(objectAssign({}, CONTROL_WITH_CONFIG));
|
|
73
73
|
}
|
|
74
74
|
}
|
|
75
75
|
|
|
76
|
-
function getTreatments(maybeKey:
|
|
76
|
+
function getTreatments(maybeKey: SplitKey, maybeSplits: string[], maybeAttributes?: Attributes) {
|
|
77
77
|
const params = validateEvaluationParams(maybeKey, maybeSplits, maybeAttributes, 'getTreatments');
|
|
78
78
|
|
|
79
79
|
if (params.valid) {
|
|
80
|
-
return client.getTreatments(params.key as
|
|
80
|
+
return client.getTreatments(params.key as SplitKey, params.splitOrSplits as string[], params.attributes as Attributes | undefined);
|
|
81
81
|
} else {
|
|
82
|
-
const res:
|
|
82
|
+
const res: Treatments = {};
|
|
83
83
|
if (params.splitOrSplits) (params.splitOrSplits as string[]).forEach((split: string) => res[split] = CONTROL);
|
|
84
84
|
|
|
85
85
|
return wrapResult(res);
|
|
86
86
|
}
|
|
87
87
|
}
|
|
88
88
|
|
|
89
|
-
function getTreatmentsWithConfig(maybeKey:
|
|
89
|
+
function getTreatmentsWithConfig(maybeKey: SplitKey, maybeSplits: string[], maybeAttributes?: Attributes) {
|
|
90
90
|
const params = validateEvaluationParams(maybeKey, maybeSplits, maybeAttributes, 'getTreatmentsWithConfig');
|
|
91
91
|
|
|
92
92
|
if (params.valid) {
|
|
93
|
-
return client.getTreatmentsWithConfig(params.key as
|
|
93
|
+
return client.getTreatmentsWithConfig(params.key as SplitKey, params.splitOrSplits as string[], params.attributes as Attributes | undefined);
|
|
94
94
|
} else {
|
|
95
|
-
const res:
|
|
95
|
+
const res: TreatmentsWithConfig = {};
|
|
96
96
|
if (params.splitOrSplits) (params.splitOrSplits as string[]).forEach(split => res[split] = objectAssign({}, CONTROL_WITH_CONFIG));
|
|
97
97
|
|
|
98
98
|
return wrapResult(res);
|
|
99
99
|
}
|
|
100
100
|
}
|
|
101
101
|
|
|
102
|
-
function track(maybeKey:
|
|
102
|
+
function track(maybeKey: SplitKey, maybeTT: string, maybeEvent: string, maybeEventValue?: number, maybeProperties?: Properties) {
|
|
103
103
|
const key = validateKey(log, maybeKey, 'track');
|
|
104
104
|
const tt = validateTrafficType(log, maybeTT, 'track');
|
|
105
105
|
const event = validateEvent(log, maybeEvent, 'track');
|
|
@@ -120,5 +120,5 @@ export function clientInputValidationDecorator<TClient extends SplitIO.IClient |
|
|
|
120
120
|
getTreatments,
|
|
121
121
|
getTreatmentsWithConfig,
|
|
122
122
|
track
|
|
123
|
-
} as
|
|
123
|
+
} as IClientSS | IAsyncClientSS;
|
|
124
124
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { objectAssign } from '../utils/lang/objectAssign';
|
|
2
|
-
import {
|
|
2
|
+
import { IBasicClient, IStatusInterface } from '../types';
|
|
3
3
|
import { releaseApiKey } from '../utils/inputValidation/apiKey';
|
|
4
4
|
import { clientFactory } from './client';
|
|
5
5
|
import { clientInputValidationDecorator } from './clientInputValidation';
|
|
@@ -8,7 +8,7 @@ import { ISdkFactoryContext } from '../sdkFactory/types';
|
|
|
8
8
|
/**
|
|
9
9
|
* Creates an Sdk client, i.e., a base client with status and destroy interface
|
|
10
10
|
*/
|
|
11
|
-
export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: boolean):
|
|
11
|
+
export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: boolean): IBasicClient {
|
|
12
12
|
const { sdkReadinessManager, syncManager, storage, signalListener, settings, telemetryTracker } = params;
|
|
13
13
|
|
|
14
14
|
return objectAssign(
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { IBasicClient } from '../types';
|
|
2
2
|
import { sdkClientFactory } from './sdkClient';
|
|
3
3
|
import { RETRIEVE_CLIENT_DEFAULT } from '../logger/constants';
|
|
4
4
|
import { ISdkFactoryContext } from '../sdkFactory/types';
|
|
@@ -6,7 +6,7 @@ import { ISdkFactoryContext } from '../sdkFactory/types';
|
|
|
6
6
|
/**
|
|
7
7
|
* Factory of client method for server-side SDKs (ISDK and IAsyncSDK)
|
|
8
8
|
*/
|
|
9
|
-
export function sdkClientMethodFactory(params: ISdkFactoryContext): () =>
|
|
9
|
+
export function sdkClientMethodFactory(params: ISdkFactoryContext): () => IBasicClient {
|
|
10
10
|
const log = params.settings.log;
|
|
11
11
|
const clientInstance = sdkClientFactory(params);
|
|
12
12
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { clientCSDecorator } from './clientCS';
|
|
2
|
-
import {
|
|
2
|
+
import { IClientSS, IClientWithKey, SplitKey } from '../types';
|
|
3
3
|
import { validateKey } from '../utils/inputValidation/key';
|
|
4
4
|
import { getMatching, keyParser } from '../utils/key';
|
|
5
5
|
import { sdkClientFactory } from './sdkClient';
|
|
@@ -9,7 +9,7 @@ import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING }
|
|
|
9
9
|
import { SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
|
|
10
10
|
import { ISdkFactoryContext } from '../sdkFactory/types';
|
|
11
11
|
|
|
12
|
-
function buildInstanceId(key:
|
|
12
|
+
function buildInstanceId(key: SplitKey) {
|
|
13
13
|
// @ts-ignore
|
|
14
14
|
return `${key.matchingKey ? key.matchingKey : key}-${key.bucketingKey ? key.bucketingKey : key}-`;
|
|
15
15
|
}
|
|
@@ -20,23 +20,23 @@ const method = 'Client instantiation';
|
|
|
20
20
|
* Factory of client method for the client-side API variant where TT is ignored and thus
|
|
21
21
|
* clients don't have a binded TT for the track method.
|
|
22
22
|
*/
|
|
23
|
-
export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?:
|
|
23
|
+
export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitKey) => IClientWithKey {
|
|
24
24
|
const { storage, syncManager, sdkReadinessManager, settings: { core: { key }, startup: { readyTimeout }, log } } = params;
|
|
25
25
|
|
|
26
26
|
const mainClientInstance = clientCSDecorator(
|
|
27
27
|
log,
|
|
28
|
-
sdkClientFactory(params) as
|
|
29
|
-
key
|
|
28
|
+
sdkClientFactory(params) as IClientSS,
|
|
29
|
+
key!
|
|
30
30
|
);
|
|
31
31
|
|
|
32
|
-
const parsedDefaultKey = keyParser(key);
|
|
32
|
+
const parsedDefaultKey = keyParser(key!);
|
|
33
33
|
const defaultInstanceId = buildInstanceId(parsedDefaultKey);
|
|
34
34
|
|
|
35
35
|
// Cache instances created per factory.
|
|
36
|
-
const clientInstances: Record<string,
|
|
36
|
+
const clientInstances: Record<string, IClientWithKey> = {};
|
|
37
37
|
clientInstances[defaultInstanceId] = mainClientInstance;
|
|
38
38
|
|
|
39
|
-
return function client(key?:
|
|
39
|
+
return function client(key?: SplitKey) {
|
|
40
40
|
if (key === undefined) {
|
|
41
41
|
log.debug(RETRIEVE_CLIENT_DEFAULT);
|
|
42
42
|
return mainClientInstance;
|
|
@@ -76,7 +76,7 @@ export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: Spl
|
|
|
76
76
|
storage: sharedStorage || storage,
|
|
77
77
|
syncManager: sharedSyncManager,
|
|
78
78
|
signalListener: undefined, // only the main client "destroy" method stops the signal listener
|
|
79
|
-
}), true) as
|
|
79
|
+
}), true) as IClientSS,
|
|
80
80
|
validKey
|
|
81
81
|
);
|
|
82
82
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { clientCSDecorator } from './clientCS';
|
|
2
|
-
import {
|
|
2
|
+
import { IClientSS, IClientWithKeyLegacy, SplitKey } from '../types';
|
|
3
3
|
import { validateKey } from '../utils/inputValidation/key';
|
|
4
4
|
import { validateTrafficType } from '../utils/inputValidation/trafficType';
|
|
5
5
|
import { getMatching, keyParser } from '../utils/key';
|
|
@@ -10,7 +10,7 @@ import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING }
|
|
|
10
10
|
import { SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
|
|
11
11
|
import { ISdkFactoryContext } from '../sdkFactory/types';
|
|
12
12
|
|
|
13
|
-
function buildInstanceId(key:
|
|
13
|
+
function buildInstanceId(key: SplitKey, trafficType?: string) {
|
|
14
14
|
// @ts-ignore
|
|
15
15
|
return `${key.matchingKey ? key.matchingKey : key}-${key.bucketingKey ? key.bucketingKey : key}-${trafficType !== undefined ? trafficType : ''}`;
|
|
16
16
|
}
|
|
@@ -22,24 +22,24 @@ const method = 'Client instantiation';
|
|
|
22
22
|
* where clients can have a binded TT for the track method, which is provided via the settings
|
|
23
23
|
* (default client) or the client method (shared clients).
|
|
24
24
|
*/
|
|
25
|
-
export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?:
|
|
25
|
+
export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitKey, trafficType?: string) => IClientWithKeyLegacy {
|
|
26
26
|
const { storage, syncManager, sdkReadinessManager, settings: { core: { key, trafficType }, startup: { readyTimeout }, log } } = params;
|
|
27
27
|
|
|
28
28
|
const mainClientInstance = clientCSDecorator(
|
|
29
29
|
log,
|
|
30
|
-
sdkClientFactory(params) as
|
|
31
|
-
key
|
|
30
|
+
sdkClientFactory(params) as IClientSS,
|
|
31
|
+
key!,
|
|
32
32
|
trafficType
|
|
33
33
|
);
|
|
34
34
|
|
|
35
|
-
const parsedDefaultKey = keyParser(key);
|
|
35
|
+
const parsedDefaultKey = keyParser(key!);
|
|
36
36
|
const defaultInstanceId = buildInstanceId(parsedDefaultKey, trafficType);
|
|
37
37
|
|
|
38
38
|
// Cache instances created per factory.
|
|
39
|
-
const clientInstances: Record<string,
|
|
39
|
+
const clientInstances: Record<string, IClientWithKeyLegacy> = {};
|
|
40
40
|
clientInstances[defaultInstanceId] = mainClientInstance;
|
|
41
41
|
|
|
42
|
-
return function client(key?:
|
|
42
|
+
return function client(key?: SplitKey, trafficType?: string) {
|
|
43
43
|
if (key === undefined) {
|
|
44
44
|
log.debug(RETRIEVE_CLIENT_DEFAULT);
|
|
45
45
|
return mainClientInstance;
|
|
@@ -86,7 +86,7 @@ export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: Spl
|
|
|
86
86
|
storage: sharedStorage || storage,
|
|
87
87
|
syncManager: sharedSyncManager,
|
|
88
88
|
signalListener: undefined, // only the main client "destroy" method stops the signal listener
|
|
89
|
-
}), true) as
|
|
89
|
+
}), true) as IClientSS,
|
|
90
90
|
validKey,
|
|
91
91
|
validTrafficType
|
|
92
92
|
);
|
package/src/sdkFactory/index.ts
CHANGED
|
@@ -4,7 +4,7 @@ import { impressionsTrackerFactory } from '../trackers/impressionsTracker';
|
|
|
4
4
|
import { eventTrackerFactory } from '../trackers/eventTracker';
|
|
5
5
|
import { telemetryTrackerFactory } from '../trackers/telemetryTracker';
|
|
6
6
|
import { IStorageFactoryParams } from '../storages/types';
|
|
7
|
-
import {
|
|
7
|
+
import { IBasicSDK } from '../types';
|
|
8
8
|
import { getMatching } from '../utils/key';
|
|
9
9
|
import { shouldBeOptimized } from '../trackers/impressionObserver/utils';
|
|
10
10
|
import { validateAndTrackApiKey } from '../utils/inputValidation/apiKey';
|
|
@@ -17,7 +17,7 @@ import { objectAssign } from '../utils/lang/objectAssign';
|
|
|
17
17
|
/**
|
|
18
18
|
* Modular SDK factory
|
|
19
19
|
*/
|
|
20
|
-
export function sdkFactory(params: ISdkFactoryParams):
|
|
20
|
+
export function sdkFactory(params: ISdkFactoryParams): IBasicSDK<any, any> {
|
|
21
21
|
|
|
22
22
|
const { settings, platform, storageFactory, splitApiFactory, extraProps,
|
|
23
23
|
syncManagerFactory, SignalListener, impressionsObserverFactory,
|
|
@@ -41,6 +41,7 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO.
|
|
|
41
41
|
|
|
42
42
|
// ATM, only used by InLocalStorage
|
|
43
43
|
matchingKey: getMatching(settings.core.key),
|
|
44
|
+
// @ts-ignore
|
|
44
45
|
splitFiltersValidation: settings.sync.__splitFiltersValidation,
|
|
45
46
|
|
|
46
47
|
// ATM, only used by PluggableStorage
|