@splitsoftware/splitio-browserjs 1.0.0-rc.1 → 1.0.0-rc.2

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.
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.defaults = void 0;
4
4
  var index_1 = require("@splitsoftware/splitio-commons/cjs/logger/index");
5
5
  var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
6
- var packageVersion = '1.0.0-rc.1';
6
+ var packageVersion = '1.0.0-rc.2';
7
7
  /**
8
8
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
9
9
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.
@@ -12,8 +12,8 @@ var platform = { getFetch: getFetch_1.getFetch, getEventSource: getEventSource_1
12
12
  /**
13
13
  * SplitFactory with pluggable modules for Browser.
14
14
  *
15
- * @param config configuration object used to instantiate the SDK
16
- * @param __updateModules optional function that lets redefine internal SDK modules. Use with
15
+ * @param config - configuration object used to instantiate the SDK
16
+ * @param __updateModules - optional function that lets redefine internal SDK modules. Use with
17
17
  * caution since, unlike `config`, this param is not validated neither considered part of the public API.
18
18
  * @throws Will throw an error if the provided config is invalid.
19
19
  */
@@ -1,6 +1,6 @@
1
1
  import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/esm/logger/index';
2
2
  import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/esm/utils/constants';
3
- var packageVersion = '1.0.0-rc.1';
3
+ var packageVersion = '1.0.0-rc.2';
4
4
  /**
5
5
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
6
6
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.
@@ -9,8 +9,8 @@ var platform = { getFetch: getFetch, getEventSource: getEventSource, EventEmitte
9
9
  /**
10
10
  * SplitFactory with pluggable modules for Browser.
11
11
  *
12
- * @param config configuration object used to instantiate the SDK
13
- * @param __updateModules optional function that lets redefine internal SDK modules. Use with
12
+ * @param config - configuration object used to instantiate the SDK
13
+ * @param __updateModules - optional function that lets redefine internal SDK modules. Use with
14
14
  * caution since, unlike `config`, this param is not validated neither considered part of the public API.
15
15
  * @throws Will throw an error if the provided config is invalid.
16
16
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@splitsoftware/splitio-browserjs",
3
- "version": "1.0.0-rc.1",
3
+ "version": "1.0.0-rc.2",
4
4
  "description": "Split SDK for JavaScript on Browser",
5
5
  "main": "cjs/index.js",
6
6
  "module": "esm/index.js",
@@ -58,7 +58,7 @@
58
58
  "bugs": "https://github.com/splitio/javascript-browser-client/issues",
59
59
  "homepage": "https://github.com/splitio/javascript-browser-client#readme",
60
60
  "dependencies": {
61
- "@splitsoftware/splitio-commons": "2.0.0-rc.4",
61
+ "@splitsoftware/splitio-commons": "2.0.0-rc.5",
62
62
  "tslib": "^2.3.1"
63
63
  },
64
64
  "devDependencies": {
@@ -73,6 +73,7 @@
73
73
  "eslint": "^8.48.0",
74
74
  "eslint-plugin-compat": "^4.2.0",
75
75
  "eslint-plugin-import": "^2.25.4",
76
+ "eslint-plugin-tsdoc": "^0.3.0",
76
77
  "fetch-mock": "^11.1.3",
77
78
  "jest": "^27.2.3",
78
79
  "karma": "^6.4.1",
@@ -25,7 +25,7 @@ export function getModules(settings: ISettings, platform: IPlatform): ISdkFactor
25
25
 
26
26
  platform,
27
27
 
28
- storageFactory: settings.storage,
28
+ storageFactory: settings.storage as ISdkFactoryParams['storageFactory'],
29
29
 
30
30
  splitApiFactory,
31
31
 
@@ -1,8 +1,8 @@
1
+ import type SplitIO from '@splitsoftware/splitio-commons/types/splitio';
1
2
  import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/src/logger/index';
2
- import { ConsentStatus, LogLevel } from '@splitsoftware/splitio-commons/src/types';
3
3
  import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/src/utils/constants';
4
4
 
5
- const packageVersion = '1.0.0-rc.1';
5
+ const packageVersion = '1.0.0-rc.2';
6
6
 
7
7
  /**
8
8
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
@@ -10,7 +10,7 @@ const packageVersion = '1.0.0-rc.1';
10
10
  * Other acceptable values are 'on', 'enable' and 'enabled', which are equivalent to 'DEBUG'.
11
11
  * Any other string value is equivalent to disable ('NONE').
12
12
  */
13
- let initialLogLevel: LogLevel | undefined;
13
+ let initialLogLevel: SplitIO.LogLevel | undefined;
14
14
 
15
15
  const LS_KEY = 'splitio_debug';
16
16
 
@@ -34,7 +34,7 @@ export const defaults = {
34
34
  },
35
35
 
36
36
  // Consent is considered granted by default
37
- userConsent: CONSENT_GRANTED as ConsentStatus,
37
+ userConsent: CONSENT_GRANTED as SplitIO.ConsentStatus,
38
38
 
39
39
  // Instance version.
40
40
  version: `browserjs-${packageVersion}`,
@@ -1,3 +1,4 @@
1
+ import type SplitIO from '@splitsoftware/splitio-commons/types/splitio';
1
2
  import { settingsFactory } from './settings';
2
3
  import { getModules } from './platform/getModules';
3
4
  import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory/index';
@@ -6,15 +7,14 @@ import { getFetch } from './platform/getFetch';
6
7
  import { getEventSource } from './platform/getEventSource';
7
8
  import { EventEmitter } from '@splitsoftware/splitio-commons/src/utils/MinEvents';
8
9
  import { now } from '@splitsoftware/splitio-commons/src/utils/timeTracker/now/browser';
9
- import SplitIO from '@splitsoftware/splitio-commons/types/splitio';
10
10
 
11
11
  const platform = { getFetch, getEventSource, EventEmitter, now };
12
12
 
13
13
  /**
14
14
  * SplitFactory with pluggable modules for Browser.
15
15
  *
16
- * @param config configuration object used to instantiate the SDK
17
- * @param __updateModules optional function that lets redefine internal SDK modules. Use with
16
+ * @param config - configuration object used to instantiate the SDK
17
+ * @param __updateModules - optional function that lets redefine internal SDK modules. Use with
18
18
  * caution since, unlike `config`, this param is not validated neither considered part of the public API.
19
19
  * @throws Will throw an error if the provided config is invalid.
20
20
  */