@splitsoftware/splitio-commons 2.0.0-rc.3 → 2.0.0-rc.5

package/cjs/sync/polling/updaters/segmentChangesUpdater.js

@@ -9,10 +9,10 @@ var constants_2 = require("../../../logger/constants");
  *  - updates `segmentsCache`
  *  - uses `segmentsEventEmitter` to emit events related to segments data updates
  *
- * @param log logger instance
- * @param segmentChangesFetcher fetcher of `/segmentChanges`
- * @param segments segments storage, with sync or async methods
- * @param readiness optional readiness manager. Not required for synchronizer or producer mode.
+ * @param log - logger instance
+ * @param segmentChangesFetcher - fetcher of `/segmentChanges`
+ * @param segments - segments storage, with sync or async methods
+ * @param readiness - optional readiness manager. Not required for synchronizer or producer mode.
  */
 function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segments, readiness) {
     var readyOnAlreadyExistentState = true;
@@ -38,11 +38,11 @@ function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segments, read
      * Thus, a false result doesn't imply that SDK_SEGMENTS_ARRIVED was not emitted.
      * Returned promise will not be rejected.
      *
-     * @param {boolean | undefined} fetchOnlyNew if true, only fetch the segments that not exists, i.e., which `changeNumber` is equal to -1.
+     * @param fetchOnlyNew - if true, only fetch the segments that not exists, i.e., which `changeNumber` is equal to -1.
      * This param is used by SplitUpdateWorker on server-side SDK, to fetch new registered segments on SPLIT_UPDATE notifications.
-     * @param {string | undefined} segmentName segment name to fetch. By passing `undefined` it fetches the list of segments registered at the storage
-     * @param {boolean | undefined} noCache true to revalidate data to fetch on a SEGMENT_UPDATE notifications.
-     * @param {number | undefined} till till target for the provided segmentName, for CDN bypass.
+     * @param segmentName - segment name to fetch. By passing `undefined` it fetches the list of segments registered at the storage
+     * @param noCache - true to revalidate data to fetch on a SEGMENT_UPDATE notifications.
+     * @param till - till target for the provided segmentName, for CDN bypass.
      */
     return function segmentChangesUpdater(fetchOnlyNew, segmentName, noCache, till) {
         log.debug(constants_2.LOG_PREFIX_SYNC_SEGMENTS + "Started segments update");

package/cjs/sync/polling/updaters/splitChangesUpdater.js

@@ -38,8 +38,8 @@ exports.parseSegments = parseSegments;
  * If there are defined filters and one feature flag doesn't match with them, its status is changed to 'ARCHIVE' to avoid storing it
  * If there are set filter defined, names filter is ignored
  *
- * @param featureFlag feature flag to be evaluated
- * @param filters splitFiltersValidation bySet | byName
+ * @param featureFlag - feature flag to be evaluated
+ * @param filters - splitFiltersValidation bySet | byName
  */
 function matchFilters(featureFlag, filters) {
     var _a = filters.groupedFilters, setsFilter = _a.bySet, namesFilter = _a.byName, prefixFilter = _a.byPrefix;
@@ -82,13 +82,13 @@ exports.computeSplitsMutation = computeSplitsMutation;
  *  - updates `splitsCache`
  *  - uses `splitsEventEmitter` to emit events related to split data updates
  *
- * @param log  Logger instance
- * @param splitChangesFetcher  Fetcher of `/splitChanges`
- * @param splits  Splits storage, with sync or async methods
- * @param segments  Segments storage, with sync or async methods
- * @param splitsEventEmitter  Optional readiness manager. Not required for synchronizer or producer mode.
- * @param requestTimeoutBeforeReady  How long the updater will wait for the request to timeout. Default 0, i.e., never timeout.
- * @param retriesOnFailureBeforeReady  How many retries on `/splitChanges` we the updater do in case of failure or timeout. Default 0, i.e., no retries.
+ * @param log -  Logger instance
+ * @param splitChangesFetcher -  Fetcher of `/splitChanges`
+ * @param splits -  Splits storage, with sync or async methods
+ * @param segments -  Segments storage, with sync or async methods
+ * @param splitsEventEmitter -  Optional readiness manager. Not required for synchronizer or producer mode.
+ * @param requestTimeoutBeforeReady -  How long the updater will wait for the request to timeout. Default 0, i.e., never timeout.
+ * @param retriesOnFailureBeforeReady -  How many retries on `/splitChanges` we the updater do in case of failure or timeout. Default 0, i.e., no retries.
  */
 function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, segments, splitFiltersValidation, splitsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, isClientSide) {
     if (requestTimeoutBeforeReady === void 0) { requestTimeoutBeforeReady = 0; }
@@ -115,13 +115,13 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, segments,
      * SplitChanges updater returns a promise that resolves with a `false` boolean value if it fails to fetch splits or synchronize them with the storage.
      * Returned promise will not be rejected.
      *
-     * @param {boolean | undefined} noCache true to revalidate data to fetch
-     * @param {boolean | undefined} till query param to bypass CDN requests
+     * @param noCache - true to revalidate data to fetch
+     * @param till - query param to bypass CDN requests
      */
     return function splitChangesUpdater(noCache, till, splitUpdateNotification) {
         /**
-         * @param {number} since current changeNumber at splitsCache
-         * @param {number} retry current number of retry attempts
+         * @param since - current changeNumber at splitsCache
+         * @param retry - current number of retry attempts
          */
         function _splitChangesUpdater(since, retry) {
             if (retry === void 0) { retry = 0; }

package/cjs/sync/streaming/AuthClient/index.js

@@ -8,12 +8,12 @@ var murmur3_1 = require("../../../utils/murmur3/murmur3");
 /**
  * Factory of authentication function.
  *
- * @param fetchAuth `SplitAPI.fetchAuth` endpoint
+ * @param fetchAuth - `SplitAPI.fetchAuth` endpoint
  */
 function authenticateFactory(fetchAuth) {
     /**
      * Run authentication requests to Auth Server, and returns a promise that resolves with the decoded JTW token.
-     * @param {string[] | undefined} userKeys set of user Keys to track membership updates. It is undefined for server-side API.
+     * @param userKeys - set of user Keys to track membership updates. It is undefined for server-side API.
      */
     return function authenticate(userKeys) {
         return fetchAuth(userKeys)

package/cjs/sync/streaming/SSEClient/index.js

@@ -9,8 +9,8 @@ var CONTROL_CHANNEL_REGEX = /^control_/;
 /**
  * Build metadata headers for SSE connection.
  *
- * @param {ISettings} settings Validated settings.
- * @returns {Record<string, string>} Headers object
+ * @param settings - Validated settings.
+ * @returns Headers object
  */
 function buildSSEHeaders(settings) {
     var headers = {
@@ -32,8 +32,8 @@ var SSEClient = /** @class */ (function () {
     /**
      * SSEClient constructor.
      *
-     * @param settings Validated settings.
-     * @param platform object containing environment-specific dependencies
+     * @param settings - Validated settings.
+     * @param platform - object containing environment-specific dependencies
      * @throws 'EventSource API is not available.' if EventSource is not available.
      */
     function SSEClient(settings, _a) {
@@ -51,9 +51,6 @@ var SSEClient = /** @class */ (function () {
     };
     /**
      * Open the connection with a given authToken
-     *
-     * @param {IAuthTokenPushEnabled} authToken
-     * @throws {TypeError} Will throw an error if `authToken` is undefined
      */
     SSEClient.prototype.open = function (authToken) {
         var _a;

package/cjs/sync/streaming/SSEHandler/NotificationKeeper.js

@@ -8,7 +8,7 @@ var STREAMING_EVENT_TYPES = [constants_1.OCCUPANCY_PRI, constants_1.OCCUPANCY_SE
 /**
  * Factory of notification keeper, which process OCCUPANCY and CONTROL notifications and emits the corresponding push events.
  *
- * @param pushEmitter emitter for events related to streaming support
+ * @param pushEmitter - emitter for events related to streaming support
  */
 // @TODO update logic to handle OCCUPANCY for any region and rename according to new spec (e.g.: PUSH_SUBSYSTEM_UP --> PUSH_SUBSYSTEM_UP)
 function notificationKeeperFactory(pushEmitter, telemetryTracker) {

package/cjs/sync/streaming/SSEHandler/NotificationParser.js

@@ -8,8 +8,9 @@ var lang_1 = require("../../../utils/lang");
  * HTTP errors handled by Ably (e.g., 400 due to invalid token, 401 due to expired token, 500) have the `data` property.
  * Other network and HTTP errors do not have this property.
  *
- * @param {Object} error
- * @throws {SyntaxError} if `error.data` is an invalid JSON string
+ * @param error - The error event to parse
+ * @returns parsed notification error
+ * @throws SyntaxError if `error.data` is an invalid JSON string
  */
 function errorParser(error) {
     // @ts-ignore
@@ -22,10 +23,10 @@ exports.errorParser = errorParser;
  * Parses the `data` JSON string of a given SSE message notifications.
  * Also assigns the type OCCUPANCY, if it corresponds, so that all supported messages (e.g., SPLIT_UPDATE, CONTROL) have a type.
  *
- * @param message
+ * @param message - The message event to parse
  * @returns parsed notification message or undefined if the given event data is falsy (e.g, '' or undefined).
  * For example, the EventSource implementation of React-Native for iOS emits a message event with empty data for Ably keepalive comments.
- * @throws {SyntaxError} if `message.data` or `JSON.parse(message.data).data` are invalid JSON strings
+ * @throws SyntaxError if `message.data` or `JSON.parse(message.data).data` are invalid JSON strings
  */
 function messageParser(message) {
     if (!message.data)

package/cjs/sync/streaming/SSEHandler/index.js

@@ -9,8 +9,8 @@ var constants_3 = require("../../../utils/constants");
 /**
  * Factory for SSEHandler, which processes SSEClient messages and emits the corresponding push events.
  *
- * @param log factory logger
- * @param pushEmitter emitter for events related to streaming support
+ * @param log - factory logger
+ * @param pushEmitter - emitter for events related to streaming support
  */
 function SSEHandlerFactory(log, pushEmitter, telemetryTracker) {
     var notificationKeeper = (0, NotificationKeeper_1.notificationKeeperFactory)(pushEmitter, telemetryTracker);

package/cjs/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.js

@@ -79,9 +79,9 @@ function MySegmentsUpdateWorker(log, storage, mySegmentsSyncTask, telemetryTrack
             /**
              * Invoked by NotificationProcessor on MY_(LARGE)_SEGMENTS_UPDATE notifications
              *
-             * @param changeNumber change number of the notification
-             * @param segmentsData data for KeyList or SegmentRemoval instant updates
-             * @param delay optional time to wait for BoundedFetchRequest or BoundedFetchRequest updates
+             * @param changeNumber - change number of the notification
+             * @param segmentsData - data for KeyList or SegmentRemoval instant updates
+             * @param delay - optional time to wait for BoundedFetchRequest or BoundedFetchRequest updates
              */
             put: function (mySegmentsData, payload, delay) {
                 var type = mySegmentsData.type, cn = mySegmentsData.cn;

package/cjs/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.js

@@ -75,8 +75,8 @@ function SegmentsUpdateWorker(log, segmentsSyncTask, segmentsCache) {
         /**
          * Invoked by NotificationProcessor on SEGMENT_UPDATE event
          *
-         * @param {number} changeNumber change number of the SEGMENT_UPDATE notification
-         * @param {string} segmentName segment name of the SEGMENT_UPDATE notification
+         * @param changeNumber - change number of the SEGMENT_UPDATE notification
+         * @param segmentName - segment name of the SEGMENT_UPDATE notification
          */
         put: function (_a) {
             var changeNumber = _a.changeNumber, segmentName = _a.segmentName;

package/cjs/sync/streaming/UpdateWorkers/SplitsUpdateWorker.js

@@ -62,7 +62,7 @@ function SplitsUpdateWorker(log, splitsCache, splitsSyncTask, splitsEventEmitter
     /**
      * Invoked by NotificationProcessor on SPLIT_UPDATE event
      *
-     * @param {number} changeNumber change number of the SPLIT_UPDATE notification
+     * @param changeNumber - change number of the SPLIT_UPDATE notification
      */
     function put(_a, _payload) {
         var changeNumber = _a.changeNumber, pcn = _a.pcn;
@@ -85,9 +85,9 @@ function SplitsUpdateWorker(log, splitsCache, splitsSyncTask, splitsEventEmitter
         /**
          * Invoked by NotificationProcessor on SPLIT_KILL event
          *
-         * @param {number} changeNumber change number of the SPLIT_UPDATE notification
-         * @param {string} splitName name of split to kill
-         * @param {string} defaultTreatment default treatment value
+         * @param changeNumber - change number of the SPLIT_UPDATE notification
+         * @param splitName - name of split to kill
+         * @param defaultTreatment - default treatment value
          */
         killSplit: function (_a) {
             var changeNumber = _a.changeNumber, splitName = _a.splitName, defaultTreatment = _a.defaultTreatment;

package/cjs/sync/streaming/parseUtils.js

@@ -16,9 +16,9 @@ function StringToUint8Array(myString) {
 /**
  * Decode and decompress 'data' with 'compression' algorithm
  *
- * @param {string} data
- * @param {number} compression 1 GZIP, 2 ZLIB
- * @returns {Uint8Array}
+ * @param data - base64 encoded string
+ * @param compression - 1 GZIP, 2 ZLIB
+ * @returns
  * @throws if data string cannot be decoded, decompressed or the provided compression value is invalid (not 1 or 2)
  */
 function decompress(data, compression) {
@@ -35,10 +35,10 @@ function decompress(data, compression) {
 /**
  * Decode, decompress and parse the provided 'data' into a KeyList object
  *
- * @param {string} data
- * @param {number} compression
- * @param {boolean} avoidPrecisionLoss true as default, set it as false if dont need to avoid precission loss
- * @returns {{a?: string[], r?: string[] }}
+ * @param data - base64 encoded string
+ * @param compression - 1 GZIP, 2 ZLIB
+ * @param avoidPrecisionLoss - true as default, set it as false if dont need to avoid precission loss
+ * @returns keyList
  * @throws if data string cannot be decoded, decompressed or parsed
  */
 function parseKeyList(data, compression, avoidPrecisionLoss) {
@@ -54,9 +54,9 @@ exports.parseKeyList = parseKeyList;
 /**
  * Decode, decompress and parse the provided 'data' into a Bitmap object
  *
- * @param {string} data
- * @param {number} compression
- * @returns {Uint8Array}
+ * @param data - base64 encoded string
+ * @param compression - 1 GZIP, 2 ZLIB
+ * @returns Bitmap
  * @throws if data string cannot be decoded or decompressed
  */
 function parseBitmap(data, compression) {
@@ -66,9 +66,9 @@ exports.parseBitmap = parseBitmap;
 /**
  * Check if the 'bitmap' bit at 'hash64hex' position is 1
  *
- * @param {Uint8Array} bitmap
- * @param {string} hash64hex 16-chars string, representing a number in hexa
- * @returns {boolean}
+ * @param bitmap - Uint8Array bitmap
+ * @param hash64hex - 16-chars string, representing a number in hexa
+ * @returns whether the provided 'hash64hex' index is set in the bitmap
  */
 function isInBitmap(bitmap, hash64hex) {
     // using the lowest 32 bits as index, to avoid losing precision when converting to number

package/cjs/sync/syncManagerOnline.js

@@ -10,9 +10,9 @@ var constants_3 = require("../utils/constants");
  * Online SyncManager factory.
  * Can be used for server-side API, and client-side API with or without multiple clients.
  *
- * @param pollingManagerFactory allows to specialize the SyncManager for server-side or client-side API by passing
+ * @param pollingManagerFactory - allows to specialize the SyncManager for server-side or client-side API by passing
  * `pollingManagerSSFactory` or `pollingManagerCSFactory` respectively.
- * @param pushManagerFactory optional to build a SyncManager with or without streaming support
+ * @param pushManagerFactory - optional to build a SyncManager with or without streaming support
  */
 function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
     /**

package/cjs/sync/syncTask.js

@@ -6,10 +6,10 @@ var constants_1 = require("../logger/constants");
  * Creates an object that handles the periodic execution of a given task via "start" and "stop" methods.
  * The task can be also executed by calling the "execute" method. Multiple calls run sequentially to avoid race conditions (e.g., submitters executed on SDK destroy or full queue, while periodic execution is pending).
  *
- * @param log  Logger instance.
- * @param task  Task to execute that returns a promise that NEVER REJECTS. Otherwise, periodic execution can result in Unhandled Promise Rejections.
- * @param period  Period in milliseconds to execute the task.
- * @param taskName  Optional task name for logging.
+ * @param log -  Logger instance.
+ * @param task -  Task to execute that returns a promise that NEVER REJECTS. Otherwise, periodic execution can result in Unhandled Promise Rejections.
+ * @param period -  Period in milliseconds to execute the task.
+ * @param taskName -  Optional task name for logging.
  * @returns A sync task that wraps the given task.
  */
 function syncTaskFactory(log, task, period, taskName) {

package/cjs/trackers/eventTracker.js

@@ -9,8 +9,8 @@ var mode_1 = require("../utils/settingsValidation/mode");
 /**
  * Event tracker stores events in cache and pass them to the integrations manager if provided.
  *
- * @param eventsCache cache to save events
- * @param integrationsManager optional event handler used for integrations
+ * @param eventsCache - cache to save events
+ * @param integrationsManager - optional event handler used for integrations
  */
 function eventTrackerFactory(settings, eventsCache, whenInit, integrationsManager, telemetryCache) {
     var log = settings.log, mode = settings.mode;

package/cjs/trackers/impressionsTracker.js

@@ -8,11 +8,11 @@ var constants_2 = require("../utils/constants");
 /**
  * Impressions tracker stores impressions in cache and pass them to the listener and integrations manager if provided.
  *
- * @param impressionsCache cache to save impressions
- * @param metadata runtime metadata (ip, hostname and version)
- * @param impressionListener optional impression listener
- * @param integrationsManager optional integrations manager
- * @param strategy strategy for impressions tracking.
+ * @param impressionsCache - cache to save impressions
+ * @param metadata - runtime metadata (ip, hostname and version)
+ * @param impressionListener - optional impression listener
+ * @param integrationsManager - optional integrations manager
+ * @param strategy - strategy for impressions tracking.
  */
 function impressionsTrackerFactory(settings, impressionsCache, strategy, whenInit, integrationsManager, telemetryCache) {
     var log = settings.log, impressionListener = settings.impressionListener, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname, version = settings.version;

package/cjs/trackers/strategy/strategyDebug.js

@@ -4,7 +4,7 @@ exports.strategyDebugFactory = void 0;
 /**
  * Debug strategy for impressions tracker. Wraps impressions to store and adds previousTime if it corresponds
  *
- * @param impressionsObserver impression observer. Previous time (pt property) is included in impression instances
+ * @param impressionsObserver - impression observer. Previous time (pt property) is included in impression instances
  * @returns IStrategyResult
  */
 function strategyDebugFactory(impressionsObserver) {

package/cjs/trackers/strategy/strategyNone.js

@@ -4,8 +4,8 @@ exports.strategyNoneFactory = void 0;
 /**
  * None strategy for impressions tracker.
  *
- * @param impressionsCounter cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
- * @param uniqueKeysTracker unique keys tracker in charge of tracking the unique keys per split.
+ * @param impressionsCounter - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
+ * @param uniqueKeysTracker - unique keys tracker in charge of tracking the unique keys per split.
  * @returns IStrategyResult
  */
 function strategyNoneFactory(impressionsCounter, uniqueKeysTracker) {

package/cjs/trackers/strategy/strategyOptimized.js

@@ -5,8 +5,8 @@ var time_1 = require("../../utils/time");
 /**
  * Optimized strategy for impressions tracker. Wraps impressions to store and adds previousTime if it corresponds
  *
- * @param impressionsObserver impression observer. previous time (pt property) is included in impression instances
- * @param impressionsCounter cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
+ * @param impressionsObserver - impression observer. previous time (pt property) is included in impression instances
+ * @param impressionsCounter - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
  * @returns IStrategyResult
  */
 function strategyOptimizedFactory(impressionsObserver, impressionsCounter) {

package/cjs/trackers/uniqueKeysTracker.js

@@ -12,9 +12,9 @@ var noopFilterAdapter = {
  * Unique Keys Tracker will be in charge of checking if the MTK was already sent to the BE in the last period
  * or schedule to be sent; if not it will be added in an internal cache and sent in the next post.
  *
- * @param log Logger instance
- * @param uniqueKeysCache cache to save unique keys
- * @param filterAdapter filter adapter
+ * @param log - Logger instance
+ * @param uniqueKeysCache - cache to save unique keys
+ * @param filterAdapter - filter adapter
  */
 function uniqueKeysTrackerFactory(log, uniqueKeysCache, filterAdapter) {
     if (filterAdapter === void 0) { filterAdapter = noopFilterAdapter; }

package/cjs/utils/Backoff.js

@@ -4,10 +4,6 @@ exports.Backoff = void 0;
 var Backoff = /** @class */ (function () {
     /**
      * Schedule function calls with exponential backoff
-     *
-     * @param {function} cb
-     * @param {number} baseMillis
-     * @param {number} maxMillis
      */
     function Backoff(cb, baseMillis, maxMillis) {
         this.baseMillis = Backoff.__TEST__BASE_MILLIS || baseMillis || Backoff.DEFAULT_BASE_MILLIS;

package/cjs/utils/Semver.js

@@ -73,7 +73,7 @@ var Semver = /** @class */ (function () {
     /**
      * Precedence comparision between 2 Semver objects.
      *
-     * @return `0` if `this === toCompare`, `-1` if `this < toCompare`, and `1` if `this > toCompare`
+     * @returns `0` if `this === toCompare`, `-1` if `this < toCompare`, and `1` if `this > toCompare`
      */
     Semver.prototype.compare = function (toCompare) {
         if (this.version === toCompare.version)

package/cjs/utils/base64/index.js

@@ -23,7 +23,7 @@ var chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
 /**
  * Decode a given string value in Base64 format
  *
- * @param {string} input value to decode
+ * @param input - value to decode
  */
 function decodeFromBase64(input) {
     var str = (String(input)).replace(/[=]+$/, ''); // #31: ExtendScript bad parse of /=
@@ -49,7 +49,7 @@ exports.decodeFromBase64 = decodeFromBase64;
 /**
  * Encode a given string value to Base64 format.
  *
- * @param {string} input value to encode
+ * @param input - value to encode
  */
 function encodeToBase64(input) {
     var str = String(input);

package/cjs/utils/decompress/index.js

@@ -407,8 +407,8 @@ exports.algorithms = (function iifeDecompress() {
     return {
         /**
          * Expands GZIP data
-         * @param data The data to decompress
-         * @param out Where to write the data. GZIP already encodes the output size, so providing this doesn't save memory.
+         * @param data - The data to decompress
+         * @param out - Where to write the data. GZIP already encodes the output size, so providing this doesn't save memory.
          * @returns The decompressed version of the data
          */
         gunzipSync: function (data, out) {
@@ -416,8 +416,8 @@ exports.algorithms = (function iifeDecompress() {
         },
         /**
          * Expands Zlib data
-         * @param data The data to decompress
-         * @param out Where to write the data. Saves memory if you know the decompressed size and provide an output buffer of that length.
+         * @param data - The data to decompress
+         * @param out - Where to write the data. Saves memory if you know the decompressed size and provide an output buffer of that length.
          * @returns The decompressed version of the data
          */
         unzlibSync: function (data, out) {

package/cjs/utils/lang/binarySearch.js

@@ -4,8 +4,8 @@ exports.binarySearch = void 0;
 /**
  * Searches the index of the specified `value` inside an ordered array of `items` using the binary search algorithm.
  *
- * @param items the array to be searched
- * @param value the value to be searched for
+ * @param items - the array to be searched
+ * @param value - the value to be searched for
  * @returns integer number between 0 and `items.length`. This value is the index of the search value,
  * if it is contained in the array, or the index at which the value should be inserted to keep the array ordered.
  */

package/cjs/utils/murmur3/murmur3_128.js

@@ -211,7 +211,7 @@ function hash128x64(key, seed) {
 /**
  * x64 version of Murmur3 for 128bits.
  *
- * @param {string} str
+ * @param str - The string to hash.
  */
 function hash128(str, seed) {
     return hash128x64((0, common_1.UTF16ToUTF8)(str), seed >>> 0);

package/cjs/utils/murmur3/murmur3_128_x86.js

@@ -146,7 +146,7 @@ function hash128x86(key, seed) {
  * x86 version of Murmur3 for 128bits.
  * Used by hashImpression128 because in JS it is more efficient than the x64 version, no matter the underlying OS/CPU arch.
  *
- * @param {string} str
+ * @param str - The string to hash.
  */
 function hash128(str, seed) {
     return hash128x86((0, common_1.UTF16ToUTF8)(str), seed >>> 0);

package/cjs/utils/murmur3/murmur3_64.js

@@ -24,7 +24,7 @@ function hex2dec(s) {
 /**
  * Gets the higher 64 bits of the x64 version of Murmur3 for 128bits, as decimal and hexadecimal number strings.
  * Used for MySegments channel V2 notifications.
- * @param {string} str
+ * @param str - The string to hash
  */
 function hash64(str) {
     var hex = (0, murmur3_128_1.hash128)(str).slice(0, 16);

package/cjs/utils/murmur3/utfx.js

@@ -11,10 +11,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.stringDestination = exports.stringSource = exports.encodeUTF16toUTF8 = void 0;
 /**
  * Encodes UTF8 code points to UTF8 bytes.
- * @param {(!function():number|null) | number} src Code points source, either as a function returning the next code point
+ * @param src - Code points source, either as a function returning the next code point
  *  respectively `null` if there are no more code points left or a single numeric code point.
- * @param {!function(number)} dst Bytes destination as a function successively called with the next byte
- * @expose
+ * @param dst - Bytes destination as a function successively called with the next byte
  */
 function encodeUTF8(src, dst) {
     var cp = null;
@@ -34,11 +33,10 @@ function encodeUTF8(src, dst) {
 }
 /**
  * Converts UTF16 characters to UTF8 code points.
- * @param {!function():number|null} src Characters source as a function returning the next char code respectively
+ * @param src - Characters source as a function returning the next char code respectively
  *  `null` if there are no more characters left.
- * @param {!function(number)} dst Code points destination as a function successively called with each converted code
+ * @param dst - Code points destination as a function successively called with each converted code
  *  point.
- * @expose
  */
 function UTF16toUTF8(src, dst) {
     var c1, c2 = null;
@@ -62,10 +60,9 @@ function UTF16toUTF8(src, dst) {
 }
 /**
  * Converts and encodes UTF16 characters to UTF8 bytes.
- * @param {!function():number|null} src Characters source as a function returning the next char code respectively `null`
+ * @param src - Characters source as a function returning the next char code respectively `null`
  *  if there are no more characters left.
- * @param {!function(number)} dst Bytes destination as a function successively called with the next byte.
- * @expose
+ * @param dst - Bytes destination as a function successively called with the next byte.
  */
 function encodeUTF16toUTF8(src, dst) {
     UTF16toUTF8(src, function (cp) {
@@ -75,17 +72,14 @@ function encodeUTF16toUTF8(src, dst) {
 exports.encodeUTF16toUTF8 = encodeUTF16toUTF8;
 /**
  * String.fromCharCode reference for compile time renaming.
- * @type {!function(...[number]):string}
- * @inner
  */
 var stringFromCharCode = String.fromCharCode;
 /**
  * Creates a source function for a string.
- * @param {string} s String to read from
- * @returns {!function():number|null} Source function returning the next char code respectively `null` if there are
+ * @param s - String to read from
+ * @returns Source function returning the next char code respectively `null` if there are
  *  no more characters left.
- * @throws {TypeError} If the argument is invalid
- * @expose
+ * @throws If the argument is invalid
  */
 function stringSource(s) {
     if (typeof s !== 'string')
@@ -98,9 +92,8 @@ function stringSource(s) {
 exports.stringSource = stringSource;
 /**
  * Creates a destination function for a string.
- * @returns {function(number=):undefined|string} Destination function successively called with the next char code.
+ * @returns Destination function successively called with the next char code.
  *  Returns the final string when called without arguments.
- * @expose
  */
 function stringDestination() {
     var cs = [], ps = [];

package/cjs/utils/promise/wrapper.js

@@ -14,8 +14,8 @@ exports.promiseWrapper = void 0;
  *  - If the wrapped promise is rejected when using native async/await syntax, the `defaultOnRejected` handler is invoked
  * and neither the catch block nor the remaining try block are executed.
  *
- * @param customPromise promise to wrap
- * @param defaultOnRejected default onRejected function
+ * @param customPromise - promise to wrap
+ * @param defaultOnRejected - default onRejected function
  * @returns a promise that doesn't need to be handled for rejection (except when using async/await syntax) and
  * includes a method named `hasOnFulfilled` that returns true if the promise has attached an onFulfilled handler.
  */

package/cjs/utils/settingsValidation/index.js

@@ -83,8 +83,8 @@ function fromSecondsToMillis(n) {
  * Validates the given config and use it to build a settings object.
  * NOTE: it doesn't validate the SDK Key. Call `validateApiKey` or `validateAndTrackApiKey` for that after settings validation.
  *
- * @param config user defined configuration
- * @param validationParams defaults and fields validators used to validate and creates a settings object from a given config
+ * @param config - user defined configuration
+ * @param validationParams - defaults and fields validators used to validate and creates a settings object from a given config
  */
 function settingsValidation(config, validationParams) {
     var defaults = validationParams.defaults, runtime = validationParams.runtime, storage = validationParams.storage, integrations = validationParams.integrations, logger = validationParams.logger, consent = validationParams.consent, flagSpec = validationParams.flagSpec;

package/cjs/utils/settingsValidation/integrations/common.js

@@ -5,11 +5,11 @@ var constants_1 = require("../../../logger/constants");
 /**
  * This function validates `settings.integrations` object
  *
- * @param {any} settings config object provided by the user to initialize the sdk
- * @param {function} integrationValidator filter used to remove invalid integration items
- * @param {string} extraWarning optional string used to better describe why an item might be invalid
+ * @param settings - config object provided by the user to initialize the sdk
+ * @param integrationValidator - filter used to remove invalid integration items
+ * @param extraWarning - optional string used to better describe why an item might be invalid
  *
- * @returns {Array} array of valid integration items. The array might be empty if `settings` object does not have valid integrations.
+ * @returns array of valid integration items. The array might be empty if `settings` object does not have valid integrations.
  */
 function validateIntegrations(settings, integrationValidator, extraWarning) {
     var integrations = settings.integrations, log = settings.log;

package/cjs/utils/settingsValidation/integrations/configurable.js

@@ -6,10 +6,10 @@ var lang_1 = require("../../lang");
 /**
  * This function validates `settings.integrations` object that consists of a list of configuration items, used by the isomorphic JS SDK.
  *
- * @param {any} settings config object provided by the user to initialize the sdk
- * @param {Array<string>} validIntegrationTypes list of integration types to filter from `settings.integrations`
+ * @param settings - config object provided by the user to initialize the sdk
+ * @param validIntegrationTypes - list of integration types to filter from `settings.integrations`
  *
- * @returns {Array} array of valid integration items. The array might be empty if `settings` object does not have valid integrations.
+ * @returns array of valid integration items. The array might be empty if `settings` object does not have valid integrations.
  */
 function validateConfigurableIntegrations(settings, validIntegrationTypes) {
     if (validIntegrationTypes === void 0) { validIntegrationTypes = []; }