@splitsoftware/splitio-browserjs 0.3.1-rc.0 → 0.4.0

package/CHANGES.txt

@@ -1,7 +1,11 @@
+0.4.0 (January 19, 2022)
+ - Added support to SDK clients on browser to optionally bind attributes to the client, keeping these loaded within the SDK along with the user ID, for easier usage when requesting flag.
+ - Updated some transitive dependencies for vulnerability fixes.
+
 0.3.0 (January 11, 2022)
  - Added support for the SDK to run in "consumer" and "partial consumer" modes, with a pluggable implementation of it's internal storage,
   enabling customers to implement this caching with any storage technology of choice and connect it to the SDK instance to be used instead of
-  its in-memory storage (Read more in our docs here: https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#advanced-consumer-mode).
+  its in-memory storage (Read more in our docs here: https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#sharing-state-with-a-pluggable-storage).
  - Updated @splitsoftware/splitio-commons dependency to version 1.1.0, which includes:
       - Updated multiple modules due to general polishing and improvements, including the replacement of default exports with named exports,
       to avoid runtime errors with some particular configurations of Webpack projects.

package/cjs/settings/defaults.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaults = void 0;
 var index_1 = require("@splitsoftware/splitio-commons/cjs/logger/index");
-var packageVersion = '0.3.1-rc.0';
+var packageVersion = '0.4.0';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.

package/esm/settings/defaults.js

@@ -1,5 +1,5 @@
 import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/esm/logger/index';
-var packageVersion = '0.3.1-rc.0';
+var packageVersion = '0.4.0';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.3.1-rc.0",
+  "version": "0.4.0",
   "description": "Split SDK for Javascript on Browser",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -61,7 +61,7 @@
   "bugs": "https://github.com/splitio/javascript-browser-client/issues",
   "homepage": "https://github.com/splitio/javascript-browser-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.1.1-rc.0",
+    "@splitsoftware/splitio-commons": "^1.2.0",
     "@types/google.analytics": "0.0.40"
   },
   "devDependencies": {

package/src/settings/defaults.ts

@@ -1,7 +1,7 @@
 import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/src/logger/index';
 import { LogLevel } from '@splitsoftware/splitio-commons/src/types';
 
-const packageVersion = '0.3.1-rc.0';
+const packageVersion = '0.4.0';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.

package/types/full/index.d.ts

@@ -28,7 +28,7 @@ declare module JsSdk {
   /**
    * Pluggable storage to use the SDK in consumer mode.
    *
-   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#advanced-consumer-mode}
+   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#sharing-state-with-a-pluggable-storage}
    */
    export function PluggableStorage(options: SplitIO.PluggableStorageOptions): SplitIO.StorageAsyncFactory;
 

package/types/index.d.ts

@@ -28,7 +28,7 @@ declare module JsSdk {
   /**
    * Pluggable storage to use the SDK in consumer mode.
    *
-   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#advanced-consumer-mode}
+   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#sharing-state-with-a-pluggable-storage}
    */
   export function PluggableStorage(options: SplitIO.PluggableStorageOptions): SplitIO.StorageAsyncFactory;
 

package/types/splitio.d.ts

@@ -342,12 +342,17 @@ declare namespace SplitIO {
   type Event = 'init::timeout' | 'init::ready' | 'init::cache-ready' | 'state::update';
   /**
    * Split attributes should be on object with values of type string or number (dates should be sent as millis since epoch).
-   * @typedef {Object.<number, string, boolean, string[], number[]>} Attributes
+   * @typedef {Object.<AttributeType>} Attributes
    * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#attribute-syntax}
    */
   type Attributes = {
-    [attributeName: string]: string | number | boolean | Array<string | number>
+    [attributeName: string]: AttributeType
   };
+  /**
+   * Type of an attribute value
+   * @typedef {string | number | boolean | Array<string | number>} AttributeType
+   */
+  type AttributeType = string | number | boolean | Array<string | number>;
   /**
    * Split properties should be an object with values of type string, number, boolean or null. Size limit of ~31kb.
    * @typedef {Object.<number, string, boolean, null>} Attributes
@@ -918,7 +923,7 @@ declare namespace SplitIO {
     /**
      * The SDK mode. When using `PluggableStorage` as storage, the possible values are "consumer" and "consumer_partial".
      *
-     * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#advanced-consumer-mode}
+     * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#sharing-state-with-a-pluggable-storage}
      *
      * @property {'consumer' | 'consumer_partial'} mode
      */
@@ -1200,44 +1205,46 @@ declare namespace SplitIO {
      */
     track(trafficType: string, eventType: string, value?: number, properties?: Properties): boolean,
     /**
-     * Add an attribute to client's in memory attributes storage
-     * @function setAttribute
+     * Add an attribute to client's in memory attributes storage.
+     *
      * @param {string} attributeName Attrinute name
-     * @param {string, number, boolean, list} attributeValue Attribute value
-     * @returns {boolean} true if the attribute was stored and false otherways
+     * @param {AttributeType} attributeValue Attribute value
+     * @returns {boolean} true if the attribute was stored and false otherwise
      */
-    setAttribute(attributeName: string, attributeValue: Object): boolean,
+    setAttribute(attributeName: string, attributeValue: AttributeType): boolean,
     /**
-     * Returns the attribute with the given key
-     * @function getAttribute
+     * Returns the attribute with the given key.
+     *
      * @param {string} attributeName Attribute name
-     * @returns {Object} Attribute with the given key
+     * @returns {AttributeType} Attribute with the given key
      */
-    getAttribute(attributeName: string): Object,
+    getAttribute(attributeName: string): AttributeType,
     /**
-     * Add to client's in memory attributes storage the attributes in 'attributes'
-     * @function setAttributes
-     * @param {Object} attributes Object with attributes to store
-     * @returns true if attributes were stored an false otherways
+     * Removes from client's in memory attributes storage the attribute with the given key.
+     *
+     * @param {string} attributeName
+     * @returns {boolean} true if attribute was removed and false otherwise
      */
-    setAttributes(attributes: Record<string, Object>): boolean,
+    removeAttribute(attributeName: string): boolean,
     /**
-     * Return all the attributes stored in client's in memory attributes storage
-     * @function getAttributes
-     * @returns {Object} returns all the stored attributes
+     * Add to client's in memory attributes storage the attributes in 'attributes'.
+     *
+     * @param {Attributes} attributes Object with attributes to store
+     * @returns true if attributes were stored an false otherwise
      */
-    getAttributes(): Record<string, Object>,
+    setAttributes(attributes: Attributes): boolean,
     /**
-     * Removes from client's in memory attributes storage the attribute with the given key
-     * @function removeAttribute
-     * @param {string} attributeName 
-     * @returns {boolean} true if attribute was removed and false otherways
+     * Return all the attributes stored in client's in memory attributes storage.
+     *
+     * @returns {Attributes} returns all the stored attributes
      */
-    removeAttribute(attributeName: string): boolean,
+    getAttributes(): Attributes,
     /**
-     * Remove all the stored attributes in the client's in memory attribute storage
+     * Remove all the stored attributes in the client's in memory attribute storage.
+     *
+     * @returns {boolean} true if all attribute were removed and false otherwise
      */
-    clearAttributes(): any
+    clearAttributes(): boolean
   }
   /**
    * This represents the interface for the Client instance with asynchronous storage for client-side SDK, where each client has associated a key.
@@ -1287,6 +1294,47 @@ declare namespace SplitIO {
      * @returns {boolean} A promise that resolves to a boolean indicating if the event was added to the queue successfully or not.
      */
     track(trafficType: string, eventType: string, value?: number, properties?: Properties): Promise<boolean>,
+    /**
+     * Add an attribute to client's in memory attributes storage.
+     *
+     * @param {string} attributeName Attrinute name
+     * @param {AttributeType} attributeValue Attribute value
+     * @returns {boolean} true if the attribute was stored and false otherwise
+     */
+    setAttribute(attributeName: string, attributeValue: AttributeType): boolean,
+    /**
+     * Returns the attribute with the given key.
+     *
+     * @param {string} attributeName Attribute name
+     * @returns {AttributeType} Attribute with the given key
+     */
+    getAttribute(attributeName: string): AttributeType,
+    /**
+     * Removes from client's in memory attributes storage the attribute with the given key.
+     *
+     * @param {string} attributeName
+     * @returns {boolean} true if attribute was removed and false otherwise
+     */
+    removeAttribute(attributeName: string): boolean,
+    /**
+     * Add to client's in memory attributes storage the attributes in 'attributes'.
+     *
+     * @param {Attributes} attributes Object with attributes to store
+     * @returns true if attributes were stored an false otherwise
+     */
+    setAttributes(attributes: Attributes): boolean,
+    /**
+     * Return all the attributes stored in client's in memory attributes storage.
+     *
+     * @returns {Attributes} returns all the stored attributes
+     */
+    getAttributes(): Attributes,
+    /**
+     * Remove all the stored attributes in the client's in memory attribute storage.
+     *
+     * @returns {boolean} true if all attribute were removed and false otherwise
+     */
+    clearAttributes(): boolean
   }
   /**
    * Representation of a manager instance with synchronous storage of the SDK.